Browse code

doc: cosmetics, rename fftools-common-opts to avtools-....

Anton Khirnov authored on 2011/09/03 05:17:38
Showing 7 changed files
... ...
@@ -82,7 +82,7 @@ described.
82 82
 @chapter Options
83 83
 @c man begin OPTIONS
84 84
 
85
-@include fftools-common-opts.texi
85
+@include avtools-common-opts.texi
86 86
 
87 87
 @section Main options
88 88
 
... ...
@@ -28,7 +28,7 @@ various Libav APIs.
28 28
 @chapter Options
29 29
 @c man begin OPTIONS
30 30
 
31
-@include fftools-common-opts.texi
31
+@include avtools-common-opts.texi
32 32
 
33 33
 @section Main options
34 34
 
... ...
@@ -60,7 +60,7 @@ are prefixed by the string "TAG:".
60 60
 @chapter Options
61 61
 @c man begin OPTIONS
62 62
 
63
-@include fftools-common-opts.texi
63
+@include avtools-common-opts.texi
64 64
 
65 65
 @section Main options
66 66
 
... ...
@@ -240,7 +240,7 @@ For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
240 240
 @chapter Options
241 241
 @c man begin OPTIONS
242 242
 
243
-@include fftools-common-opts.texi
243
+@include avtools-common-opts.texi
244 244
 
245 245
 @section Main options
246 246
 
247 247
new file mode 100644
... ...
@@ -0,0 +1,138 @@
0
+All the numerical options, if not specified otherwise, accept in input
1
+a string representing a number, which may contain one of the
2
+International System number postfixes, for example 'K', 'M', 'G'.
3
+If 'i' is appended after the postfix, powers of 2 are used instead of
4
+powers of 10. The 'B' postfix multiplies the value for 8, and can be
5
+appended after another postfix or used alone. This allows using for
6
+example 'KB', 'MiB', 'G' and 'B' as postfix.
7
+
8
+Options which do not take arguments are boolean options, and set the
9
+corresponding value to true. They can be set to false by prefixing
10
+with "no" the option name, for example using "-nofoo" in the
11
+commandline will set to false the boolean option with name "foo".
12
+
13
+@section Generic options
14
+
15
+These options are shared amongst the av* tools.
16
+
17
+@table @option
18
+
19
+@item -L
20
+Show license.
21
+
22
+@item -h, -?, -help, --help
23
+Show help.
24
+
25
+@item -version
26
+Show version.
27
+
28
+@item -formats
29
+Show available formats.
30
+
31
+The fields preceding the format names have the following meanings:
32
+@table @samp
33
+@item D
34
+Decoding available
35
+@item E
36
+Encoding available
37
+@end table
38
+
39
+@item -codecs
40
+Show available codecs.
41
+
42
+The fields preceding the codec names have the following meanings:
43
+@table @samp
44
+@item D
45
+Decoding available
46
+@item E
47
+Encoding available
48
+@item V/A/S
49
+Video/audio/subtitle codec
50
+@item S
51
+Codec supports slices
52
+@item D
53
+Codec supports direct rendering
54
+@item T
55
+Codec can handle input truncated at random locations instead of only at frame boundaries
56
+@end table
57
+
58
+@item -bsfs
59
+Show available bitstream filters.
60
+
61
+@item -protocols
62
+Show available protocols.
63
+
64
+@item -filters
65
+Show available libavfilter filters.
66
+
67
+@item -pix_fmts
68
+Show available pixel formats.
69
+
70
+@item -sample_fmts
71
+Show available sample formats.
72
+
73
+@item -loglevel @var{loglevel}
74
+Set the logging level used by the library.
75
+@var{loglevel} is a number or a string containing one of the following values:
76
+@table @samp
77
+@item quiet
78
+@item panic
79
+@item fatal
80
+@item error
81
+@item warning
82
+@item info
83
+@item verbose
84
+@item debug
85
+@end table
86
+
87
+By default the program logs to stderr, if coloring is supported by the
88
+terminal, colors are used to mark errors and warnings. Log coloring
89
+can be disabled setting the environment variable
90
+@env{FFMPEG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
91
+the environment variable @env{FFMPEG_FORCE_COLOR}.
92
+The use of the environment variable @env{NO_COLOR} is deprecated and
93
+will be dropped in a following Libav version.
94
+
95
+@end table
96
+
97
+@section AVOptions
98
+
99
+These options are provided directly by the libavformat, libavdevice and
100
+libavcodec libraries. To see the list of available AVOptions, use the
101
+@option{-help} option. They are separated into two categories:
102
+@table @option
103
+@item generic
104
+These options can be set for any container, codec or device. Generic options are
105
+listed under AVFormatContext options for containers/devices and under
106
+AVCodecContext options for codecs.
107
+@item private
108
+These options are specific to the given container, device or codec. Private
109
+options are listed under their corresponding containers/devices/codecs.
110
+@end table
111
+
112
+For example to write an ID3v2.3 header instead of a default ID3v2.4 to
113
+an MP3 file, use the @option{id3v2_version} private option of the MP3
114
+muxer:
115
+@example
116
+ffmpeg -i input.flac -id3v2_version 3 out.mp3
117
+@end example
118
+
119
+You can precisely specify which stream(s) should the codec AVOption apply to by
120
+appending a stream specifier of the form
121
+@option{[:@var{stream_type}][:@var{stream_index}]} to the option name.
122
+@var{stream_type} is 'v' for video, 'a' for audio and 's' for subtitle streams.
123
+@var{stream_index} is a global stream index when @var{stream_type} isn't
124
+given, otherwise it counts streams of the given type only. As always, the index
125
+is zero-based. For example
126
+@example
127
+-foo -- applies to all applicable streams
128
+-foo:v -- applies to all video streams
129
+-foo:a:2 -- applies to the third audio stream
130
+-foo:0 -- applies to the first stream
131
+@end example
132
+
133
+Note -nooption syntax cannot be used for boolean AVOptions, use -option
134
+0/-option 1.
135
+
136
+Note2 old undocumented way of specifying per-stream AVOptions by prepending
137
+v/a/s to the options name is now obsolete and will be removed soon.
... ...
@@ -68,7 +68,7 @@ specified for the inputs.
68 68
 @chapter Options
69 69
 @c man begin OPTIONS
70 70
 
71
-@include fftools-common-opts.texi
71
+@include avtools-common-opts.texi
72 72
 
73 73
 @section Main options
74 74
 
75 75
deleted file mode 100644
... ...
@@ -1,138 +0,0 @@
1
-All the numerical options, if not specified otherwise, accept in input
2
-a string representing a number, which may contain one of the
3
-International System number postfixes, for example 'K', 'M', 'G'.
4
-If 'i' is appended after the postfix, powers of 2 are used instead of
5
-powers of 10. The 'B' postfix multiplies the value for 8, and can be
6
-appended after another postfix or used alone. This allows using for
7
-example 'KB', 'MiB', 'G' and 'B' as postfix.
8
-
9
-Options which do not take arguments are boolean options, and set the
10
-corresponding value to true. They can be set to false by prefixing
11
-with "no" the option name, for example using "-nofoo" in the
12
-commandline will set to false the boolean option with name "foo".
13
-
14
-@section Generic options
15
-
16
-These options are shared amongst the ff* tools.
17
-
18
-@table @option
19
-
20
-@item -L
21
-Show license.
22
-
23
-@item -h, -?, -help, --help
24
-Show help.
25
-
26
-@item -version
27
-Show version.
28
-
29
-@item -formats
30
-Show available formats.
31
-
32
-The fields preceding the format names have the following meanings:
33
-@table @samp
34
-@item D
35
-Decoding available
36
-@item E
37
-Encoding available
38
-@end table
39
-
40
-@item -codecs
41
-Show available codecs.
42
-
43
-The fields preceding the codec names have the following meanings:
44
-@table @samp
45
-@item D
46
-Decoding available
47
-@item E
48
-Encoding available
49
-@item V/A/S
50
-Video/audio/subtitle codec
51
-@item S
52
-Codec supports slices
53
-@item D
54
-Codec supports direct rendering
55
-@item T
56
-Codec can handle input truncated at random locations instead of only at frame boundaries
57
-@end table
58
-
59
-@item -bsfs
60
-Show available bitstream filters.
61
-
62
-@item -protocols
63
-Show available protocols.
64
-
65
-@item -filters
66
-Show available libavfilter filters.
67
-
68
-@item -pix_fmts
69
-Show available pixel formats.
70
-
71
-@item -sample_fmts
72
-Show available sample formats.
73
-
74
-@item -loglevel @var{loglevel}
75
-Set the logging level used by the library.
76
-@var{loglevel} is a number or a string containing one of the following values:
77
-@table @samp
78
-@item quiet
79
-@item panic
80
-@item fatal
81
-@item error
82
-@item warning
83
-@item info
84
-@item verbose
85
-@item debug
86
-@end table
87
-
88
-By default the program logs to stderr, if coloring is supported by the
89
-terminal, colors are used to mark errors and warnings. Log coloring
90
-can be disabled setting the environment variable
91
-@env{FFMPEG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
92
-the environment variable @env{FFMPEG_FORCE_COLOR}.
93
-The use of the environment variable @env{NO_COLOR} is deprecated and
94
-will be dropped in a following Libav version.
95
-
96
-@end table
97
-
98
-@section AVOptions
99
-
100
-These options are provided directly by the libavformat, libavdevice and
101
-libavcodec libraries. To see the list of available AVOptions, use the
102
-@option{-help} option. They are separated into two categories:
103
-@table @option
104
-@item generic
105
-These options can be set for any container, codec or device. Generic options are
106
-listed under AVFormatContext options for containers/devices and under
107
-AVCodecContext options for codecs.
108
-@item private
109
-These options are specific to the given container, device or codec. Private
110
-options are listed under their corresponding containers/devices/codecs.
111
-@end table
112
-
113
-For example to write an ID3v2.3 header instead of a default ID3v2.4 to
114
-an MP3 file, use the @option{id3v2_version} private option of the MP3
115
-muxer:
116
-@example
117
-ffmpeg -i input.flac -id3v2_version 3 out.mp3
118
-@end example
119
-
120
-You can precisely specify which stream(s) should the codec AVOption apply to by
121
-appending a stream specifier of the form
122
-@option{[:@var{stream_type}][:@var{stream_index}]} to the option name.
123
-@var{stream_type} is 'v' for video, 'a' for audio and 's' for subtitle streams.
124
-@var{stream_index} is a global stream index when @var{stream_type} isn't
125
-given, otherwise it counts streams of the given type only. As always, the index
126
-is zero-based. For example
127
-@example
128
--foo -- applies to all applicable streams
129
--foo:v -- applies to all video streams
130
--foo:a:2 -- applies to the third audio stream
131
--foo:0 -- applies to the first stream
132
-@end example
133
-
134
-Note -nooption syntax cannot be used for boolean AVOptions, use -option
135
-0/-option 1.
136
-
137
-Note2 old undocumented way of specifying per-stream AVOptions by prepending
138
-v/a/s to the options name is now obsolete and will be removed soon.