doc/fftools-common-opts: document -devices option
[ffmpeg.git] / doc / fftools-common-opts.texi
1 All the numerical options, if not specified otherwise, accept a string
2 representing a number as input, which may be followed by one of the SI
3 unit prefixes, for example: 'K', 'M', or 'G'.
4
5 If 'i' is appended to the SI unit prefix, the complete prefix will be
6 interpreted as a unit prefix for binary multiples, which are based on
7 powers of 1024 instead of powers of 1000. Appending 'B' to the SI unit
8 prefix multiplies the value by 8. This allows using, for example:
9 'KB', 'MiB', 'G' and 'B' as number suffixes.
10
11 Options which do not take arguments are boolean options, and set the
12 corresponding value to true. They can be set to false by prefixing
13 the option name with "no". For example using "-nofoo"
14 will set the boolean option with name "foo" to false.
15
16 @anchor{Stream specifiers}
17 @section Stream specifiers
18 Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
19 are used to precisely specify which stream(s) a given option belongs to.
20
21 A stream specifier is a string generally appended to the option name and
22 separated from it by a colon. E.g. @code{-codec:a:1 ac3} contains the
23 @code{a:1} stream specifier, which matches the second audio stream. Therefore, it
24 would select the ac3 codec for the second audio stream.
25
26 A stream specifier can match several streams, so that the option is applied to all
27 of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio
28 streams.
29
30 An empty stream specifier matches all streams. For example, @code{-codec copy}
31 or @code{-codec: copy} would copy all the streams without reencoding.
32
33 Possible forms of stream specifiers are:
34 @table @option
35 @item @var{stream_index}
36 Matches the stream with this index. E.g. @code{-threads:1 4} would set the
37 thread count for the second stream to 4.
38 @item @var{stream_type}[:@var{stream_index}]
39 @var{stream_type} is one of following: 'v' for video, 'a' for audio, 's' for subtitle,
40 'd' for data, and 't' for attachments. If @var{stream_index} is given, then it matches
41 stream number @var{stream_index} of this type. Otherwise, it matches all
42 streams of this type.
43 @item p:@var{program_id}[:@var{stream_index}]
44 If @var{stream_index} is given, then it matches the stream with number @var{stream_index}
45 in the program with the id @var{program_id}. Otherwise, it matches all streams in the
46 program.
47 @item #@var{stream_id} or i:@var{stream_id}
48 Match the stream by stream id (e.g. PID in MPEG-TS container).
49 @item m:@var{key}[:@var{value}]
50 Matches streams with the metadata tag @var{key} having the specified value. If
51 @var{value} is not given, matches streams that contain the given tag with any
52 value.
53
54 Note that in @command{ffmpeg}, matching by metadata will only work properly for
55 input files.
56 @end table
57
58 @section Generic options
59
60 These options are shared amongst the ff* 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. If no argument is specified, only basic (non advanced) tool
70 options are shown.
71
72 Possible values of @var{arg} are:
73 @table @option
74 @item long
75 Print advanced tool options in addition to the basic tool options.
76
77 @item full
78 Print complete list of options, including shared and private options
79 for encoders, decoders, demuxers, muxers, filters, etc.
80
81 @item decoder=@var{decoder_name}
82 Print detailed information about the decoder named @var{decoder_name}. Use the
83 @option{-decoders} option to get a list of all decoders.
84
85 @item encoder=@var{encoder_name}
86 Print detailed information about the encoder named @var{encoder_name}. Use the
87 @option{-encoders} option to get a list of all encoders.
88
89 @item demuxer=@var{demuxer_name}
90 Print detailed information about the demuxer named @var{demuxer_name}. Use the
91 @option{-formats} option to get a list of all demuxers and muxers.
92
93 @item muxer=@var{muxer_name}
94 Print detailed information about the muxer named @var{muxer_name}. Use the
95 @option{-formats} option to get a list of all muxers and demuxers.
96
97 @item filter=@var{filter_name}
98 Print detailed information about the filter name @var{filter_name}. Use the
99 @option{-filters} option to get a list of all filters.
100 @end table
101
102 @item -version
103 Show version.
104
105 @item -formats
106 Show available formats (including devices).
107
108 @item -devices
109 Show available devices.
110
111 @item -codecs
112 Show all codecs known to libavcodec.
113
114 Note that the term 'codec' is used throughout this documentation as a shortcut
115 for what is more correctly called a media bitstream format.
116
117 @item -decoders
118 Show available decoders.
119
120 @item -encoders
121 Show all available encoders.
122
123 @item -bsfs
124 Show available bitstream filters.
125
126 @item -protocols
127 Show available protocols.
128
129 @item -filters
130 Show available libavfilter filters.
131
132 @item -pix_fmts
133 Show available pixel formats.
134
135 @item -sample_fmts
136 Show available sample formats.
137
138 @item -layouts
139 Show channel names and standard channel layouts.
140
141 @item -colors
142 Show recognized color names.
143
144 @item -loglevel [repeat+]@var{loglevel} | -v [repeat+]@var{loglevel}
145 Set the logging level used by the library.
146 Adding "repeat+" indicates that repeated log output should not be compressed
147 to the first line and the "Last message repeated n times" line will be
148 omitted. "repeat" can also be used alone.
149 If "repeat" is used alone, and with no prior loglevel set, the default
150 loglevel will be used. If multiple loglevel parameters are given, using
151 'repeat' will not change the loglevel.
152 @var{loglevel} is a number or a string containing one of the following values:
153 @table @samp
154 @item quiet
155 Show nothing at all; be silent.
156 @item panic
157 Only show fatal errors which could lead the process to crash, such as
158 and assert failure. This is not currently used for anything.
159 @item fatal
160 Only show fatal errors. These are errors after which the process absolutely
161 cannot continue after.
162 @item error
163 Show all errors, including ones which can be recovered from.
164 @item warning
165 Show all warnings and errors. Any message related to possibly
166 incorrect or unexpected events will be shown.
167 @item info
168 Show informative messages during processing. This is in addition to
169 warnings and errors. This is the default value.
170 @item verbose
171 Same as @code{info}, except more verbose.
172 @item debug
173 Show everything, including debugging information.
174 @end table
175
176 By default the program logs to stderr, if coloring is supported by the
177 terminal, colors are used to mark errors and warnings. Log coloring
178 can be disabled setting the environment variable
179 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
180 the environment variable @env{AV_LOG_FORCE_COLOR}.
181 The use of the environment variable @env{NO_COLOR} is deprecated and
182 will be dropped in a following FFmpeg version.
183
184 @item -report
185 Dump full command line and console output to a file named
186 @code{@var{program}-@var{YYYYMMDD}-@var{HHMMSS}.log} in the current
187 directory.
188 This file can be useful for bug reports.
189 It also implies @code{-loglevel verbose}.
190
191 Setting the environment variable @code{FFREPORT} to any value has the
192 same effect. If the value is a ':'-separated key=value sequence, these
193 options will affect the report; options values must be escaped if they
194 contain special characters or the options delimiter ':' (see the
195 ``Quoting and escaping'' section in the ffmpeg-utils manual). The
196 following option is recognized:
197 @table @option
198 @item file
199 set the file name to use for the report; @code{%p} is expanded to the name
200 of the program, @code{%t} is expanded to a timestamp, @code{%%} is expanded
201 to a plain @code{%}
202 @item level
203 set the log level
204 @end table
205
206 Errors in parsing the environment variable are not fatal, and will not
207 appear in the report.
208
209 @item -hide_banner
210 Suppress printing banner.
211
212 All FFmpeg tools will normally show a copyright notice, build options
213 and library versions. This option can be used to suppress printing
214 this information.
215
216 @item -cpuflags flags (@emph{global})
217 Allows setting and clearing cpu flags. This option is intended
218 for testing. Do not use it unless you know what you're doing.
219 @example
220 ffmpeg -cpuflags -sse+mmx ...
221 ffmpeg -cpuflags mmx ...
222 ffmpeg -cpuflags 0 ...
223 @end example
224 Possible flags for this option are:
225 @table @samp
226 @item x86
227 @table @samp
228 @item mmx
229 @item mmxext
230 @item sse
231 @item sse2
232 @item sse2slow
233 @item sse3
234 @item sse3slow
235 @item ssse3
236 @item atom
237 @item sse4.1
238 @item sse4.2
239 @item avx
240 @item xop
241 @item fma4
242 @item 3dnow
243 @item 3dnowext
244 @item cmov
245 @end table
246 @item ARM
247 @table @samp
248 @item armv5te
249 @item armv6
250 @item armv6t2
251 @item vfp
252 @item vfpv3
253 @item neon
254 @end table
255 @item PowerPC
256 @table @samp
257 @item altivec
258 @end table
259 @item Specific Processors
260 @table @samp
261 @item pentium2
262 @item pentium3
263 @item pentium4
264 @item k6
265 @item k62
266 @item athlon
267 @item athlonxp
268 @item k8
269 @end table
270 @end table
271
272 @item -opencl_bench
273 Benchmark all available OpenCL devices and show the results. This option
274 is only available when FFmpeg has been compiled with @code{--enable-opencl}.
275
276 @item -opencl_options options (@emph{global})
277 Set OpenCL environment options. This option is only available when
278 FFmpeg has been compiled with @code{--enable-opencl}.
279
280 @var{options} must be a list of @var{key}=@var{value} option pairs
281 separated by ':'. See the ``OpenCL Options'' section in the
282 ffmpeg-utils manual for the list of supported options.
283 @end table
284
285 @section AVOptions
286
287 These options are provided directly by the libavformat, libavdevice and
288 libavcodec libraries. To see the list of available AVOptions, use the
289 @option{-help} option. They are separated into two categories:
290 @table @option
291 @item generic
292 These options can be set for any container, codec or device. Generic options
293 are listed under AVFormatContext options for containers/devices and under
294 AVCodecContext options for codecs.
295 @item private
296 These options are specific to the given container, device or codec. Private
297 options are listed under their corresponding containers/devices/codecs.
298 @end table
299
300 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
301 an MP3 file, use the @option{id3v2_version} private option of the MP3
302 muxer:
303 @example
304 ffmpeg -i input.flac -id3v2_version 3 out.mp3
305 @end example
306
307 All codec AVOptions are per-stream, and thus a stream specifier
308 should be attached to them.
309
310 Note: the @option{-nooption} syntax cannot be used for boolean
311 AVOptions, use @option{-option 0}/@option{-option 1}.
312
313 Note: the old undocumented way of specifying per-stream AVOptions by
314 prepending v/a/s to the options name is now obsolete and will be
315 removed soon.