cosmetics: Fix spelling mistakes
[ffmpeg.git] / doc / avtools-common-opts.texi
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 SI unit prefixes, for example 'K', 'M', 'G'.
4 If 'i' is appended after the prefix, binary prefixes are used,
5 which are based on powers of 1024 instead of powers of 1000.
6 The 'B' postfix multiplies the value by 8, and can be
7 appended after a unit prefix or used alone. This allows using for
8 example 'KB', 'MiB', 'G' and 'B' as number postfix.
9
10 Options which do not take arguments are boolean options, and set the
11 corresponding value to true. They can be set to false by prefixing
12 with "no" the option name, for example using "-nofoo" in the
13 command line will set to false the boolean option with name "foo".
14
15 @anchor{Stream specifiers}
16 @section Stream specifiers
17 Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
18 are used to precisely specify which stream(s) does a given option belong to.
19
20 A stream specifier is a string generally appended to the option name and
21 separated from it by a colon. E.g. @code{-codec:a:1 ac3} option contains
22 @code{a:1} stream specifier, which matches the second audio stream. Therefore it
23 would select the ac3 codec for the second audio stream.
24
25 A stream specifier can match several stream, the option is then applied to all
26 of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio
27 streams.
28
29 An empty stream specifier matches all streams, for example @code{-codec copy}
30 or @code{-codec: copy} would copy all the streams without reencoding.
31
32 Possible forms of stream specifiers are:
33 @table @option
34 @item @var{stream_index}
35 Matches the stream with this index. E.g. @code{-threads:1 4} would set the
36 thread count for the second stream to 4.
37 @item @var{stream_type}[:@var{stream_index}]
38 @var{stream_type} is one of: 'v' for video, 'a' for audio, 's' for subtitle,
39 'd' for data and 't' for attachments. If @var{stream_index} is given, then
40 matches stream number @var{stream_index} of this type. Otherwise matches all
41 streams of this type.
42 @item p:@var{program_id}[:@var{stream_index}]
43 If @var{stream_index} is given, then matches stream number @var{stream_index} in
44 program with id @var{program_id}. Otherwise matches all streams in this program.
45 @item i:@var{stream_id}
46 Match the stream by stream id (e.g. PID in MPEG-TS container).
47 @item m:@var{key}[:@var{value}]
48 Matches streams with the metadata tag @var{key} having the specified value. If
49 @var{value} is not given, matches streams that contain the given tag with any
50 value.
51 @item u
52 Matches streams with usable configuration, the codec must be defined and the
53 essential information such as video dimension or audio sample rate must be present.
54
55 Note that in @command{avconv}, matching by metadata will only work properly for
56 input files.
57 @end table
58 @section Generic options
59
60 These options are shared amongst the av* tools.
61
62 @table @option
63
64 @item -L
65 Show license.
66
67 @item -h, -?, -help, --help [@var{arg}]
68 Show help. An optional parameter may be specified to print help about a specific
69 item.
70
71 Possible values of @var{arg} are:
72 @table @option
73 @item decoder=@var{decoder_name}
74 Print detailed information about the decoder named @var{decoder_name}. Use the
75 @option{-decoders} option to get a list of all decoders.
76
77 @item encoder=@var{encoder_name}
78 Print detailed information about the encoder named @var{encoder_name}. Use the
79 @option{-encoders} option to get a list of all encoders.
80
81 @item demuxer=@var{demuxer_name}
82 Print detailed information about the demuxer named @var{demuxer_name}. Use the
83 @option{-formats} option to get a list of all demuxers and muxers.
84
85 @item muxer=@var{muxer_name}
86 Print detailed information about the muxer named @var{muxer_name}. Use the
87 @option{-formats} option to get a list of all muxers and demuxers.
88
89 @item filter=@var{filter_name}
90 Print detailed information about the filter name @var{filter_name}. Use the
91 @option{-filters} option to get a list of all filters.
92
93 @end table
94
95 @item -version
96 Show version.
97
98 @item -formats
99 Show available formats.
100
101 The fields preceding the format names have the following meanings:
102 @table @samp
103 @item D
104 Decoding available
105 @item E
106 Encoding available
107 @end table
108
109 @item -codecs
110 Show all codecs known to libavcodec.
111
112 Note that the term 'codec' is used throughout this documentation as a shortcut
113 for what is more correctly called a media bitstream format.
114
115 @item -decoders
116 Show available decoders.
117
118 @item -encoders
119 Show all available encoders.
120
121 @item -bsfs
122 Show available bitstream filters.
123
124 @item -protocols
125 Show available protocols.
126
127 @item -filters
128 Show available libavfilter filters.
129
130 @item -pix_fmts
131 Show available pixel formats.
132
133 @item -sample_fmts
134 Show available sample formats.
135
136 @item -loglevel @var{loglevel} | -v @var{loglevel}
137 Set the logging level used by the library.
138 @var{loglevel} is a number or a string containing one of the following values:
139 @table @samp
140 @item quiet
141 @item panic
142 @item fatal
143 @item error
144 @item warning
145 @item info
146 @item verbose
147 @item debug
148 @item trace
149 @end table
150
151 By default the program logs to stderr, if coloring is supported by the
152 terminal, colors are used to mark errors and warnings. Log coloring
153 can be disabled setting the environment variable
154 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
155 the environment variable @env{AV_LOG_FORCE_COLOR}.
156 The use of the environment variable @env{NO_COLOR} is deprecated and
157 will be dropped in a following Libav version.
158
159 @item -cpuflags mask (@emph{global})
160 Set a mask that's applied to autodetected CPU flags. This option is intended
161 for testing. Do not use it unless you know what you're doing.
162
163 @end table
164
165 @section AVOptions
166
167 These options are provided directly by the libavformat, libavdevice and
168 libavcodec libraries. To see the list of available AVOptions, use the
169 @option{-help} option. They are separated into two categories:
170 @table @option
171 @item generic
172 These options can be set for any container, codec or device. Generic options
173 are listed under AVFormatContext options for containers/devices and under
174 AVCodecContext options for codecs.
175 @item private
176 These options are specific to the given container, device or codec. Private
177 options are listed under their corresponding containers/devices/codecs.
178 @end table
179
180 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
181 an MP3 file, use the @option{id3v2_version} private option of the MP3
182 muxer:
183 @example
184 avconv -i input.flac -id3v2_version 3 out.mp3
185 @end example
186
187 All codec AVOptions are obviously per-stream, so the chapter on stream
188 specifiers applies to them
189
190 Note @option{-nooption} syntax cannot be used for boolean AVOptions,
191 use @option{-option 0}/@option{-option 1}.
192
193 Note2 old undocumented way of specifying per-stream AVOptions by prepending
194 v/a/s to the options name is now obsolete and will be removed soon.
195
196 @include avoptions_codec.texi
197 @include avoptions_format.texi