doc: update loglevel option documentation
[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' or 'V' for video, 'a' for audio, 's'
40 for subtitle, 'd' for data, and 't' for attachments. 'v' matches all video
41 streams, 'V' only matches video streams which are not attached pictures, video
42 thumbnails or cover arts.  If @var{stream_index} is given, then it matches
43 stream number @var{stream_index} of this type. Otherwise, it matches all
44 streams of this type.
45 @item p:@var{program_id}[:@var{stream_index}]
46 If @var{stream_index} is given, then it matches the stream with number @var{stream_index}
47 in the program with the id @var{program_id}. Otherwise, it matches all streams in the
48 program.
49 @item #@var{stream_id} or i:@var{stream_id}
50 Match the stream by stream id (e.g. PID in MPEG-TS container).
51 @item m:@var{key}[:@var{value}]
52 Matches streams with the metadata tag @var{key} having the specified value. If
53 @var{value} is not given, matches streams that contain the given tag with any
54 value.
55 @item u
56 Matches streams with usable configuration, the codec must be defined and the
57 essential information such as video dimension or audio sample rate must be present.
58
59 Note that in @command{ffmpeg}, matching by metadata will only work properly for
60 input files.
61 @end table
62
63 @section Generic options
64
65 These options are shared amongst the ff* tools.
66
67 @table @option
68
69 @item -L
70 Show license.
71
72 @item -h, -?, -help, --help [@var{arg}]
73 Show help. An optional parameter may be specified to print help about a specific
74 item. If no argument is specified, only basic (non advanced) tool
75 options are shown.
76
77 Possible values of @var{arg} are:
78 @table @option
79 @item long
80 Print advanced tool options in addition to the basic tool options.
81
82 @item full
83 Print complete list of options, including shared and private options
84 for encoders, decoders, demuxers, muxers, filters, etc.
85
86 @item decoder=@var{decoder_name}
87 Print detailed information about the decoder named @var{decoder_name}. Use the
88 @option{-decoders} option to get a list of all decoders.
89
90 @item encoder=@var{encoder_name}
91 Print detailed information about the encoder named @var{encoder_name}. Use the
92 @option{-encoders} option to get a list of all encoders.
93
94 @item demuxer=@var{demuxer_name}
95 Print detailed information about the demuxer named @var{demuxer_name}. Use the
96 @option{-formats} option to get a list of all demuxers and muxers.
97
98 @item muxer=@var{muxer_name}
99 Print detailed information about the muxer named @var{muxer_name}. Use the
100 @option{-formats} option to get a list of all muxers and demuxers.
101
102 @item filter=@var{filter_name}
103 Print detailed information about the filter name @var{filter_name}. Use the
104 @option{-filters} option to get a list of all filters.
105 @end table
106
107 @item -version
108 Show version.
109
110 @item -formats
111 Show available formats (including devices).
112
113 @item -demuxers
114 Show available demuxers.
115
116 @item -muxers
117 Show available muxers.
118
119 @item -devices
120 Show available devices.
121
122 @item -codecs
123 Show all codecs known to libavcodec.
124
125 Note that the term 'codec' is used throughout this documentation as a shortcut
126 for what is more correctly called a media bitstream format.
127
128 @item -decoders
129 Show available decoders.
130
131 @item -encoders
132 Show all available encoders.
133
134 @item -bsfs
135 Show available bitstream filters.
136
137 @item -protocols
138 Show available protocols.
139
140 @item -filters
141 Show available libavfilter filters.
142
143 @item -pix_fmts
144 Show available pixel formats.
145
146 @item -sample_fmts
147 Show available sample formats.
148
149 @item -layouts
150 Show channel names and standard channel layouts.
151
152 @item -colors
153 Show recognized color names.
154
155 @item -sources @var{device}[,@var{opt1}=@var{val1}[,@var{opt2}=@var{val2}]...]
156 Show autodetected sources of the input device.
157 Some devices may provide system-dependent source names that cannot be autodetected.
158 The returned list cannot be assumed to be always complete.
159 @example
160 ffmpeg -sources pulse,server=192.168.0.4
161 @end example
162
163 @item -sinks @var{device}[,@var{opt1}=@var{val1}[,@var{opt2}=@var{val2}]...]
164 Show autodetected sinks of the output device.
165 Some devices may provide system-dependent sink names that cannot be autodetected.
166 The returned list cannot be assumed to be always complete.
167 @example
168 ffmpeg -sinks pulse,server=192.168.0.4
169 @end example
170
171 @item -loglevel [@var{flags}+]@var{loglevel} | -v [@var{flags}+]@var{loglevel}
172 Set logging level and flags used by the library.
173
174 The optional @var{flags} prefix can consist of the following values:
175 @table @samp
176 @item repeat
177 Indicates that repeated log output should not be compressed to the first line
178 and the "Last message repeated n times" line will be omitted.
179 @item level
180 Indicates that log output should add a @code{[level]} prefix to each message
181 line. This can be used as an alternative to log coloring, e.g. when dumping the
182 log to file.
183 @end table
184 Flags can also be used alone by adding a '+'/'-' prefix to set/reset a single
185 flag without affecting other @var{flags} or changing @var{loglevel}. When
186 setting both @var{flags} and @var{loglevel}, a '+' separator is expected
187 between the last @var{flags} value and before @var{loglevel}.
188
189 @var{loglevel} is a string or a number containing one of the following values:
190 @table @samp
191 @item quiet, -8
192 Show nothing at all; be silent.
193 @item panic, 0
194 Only show fatal errors which could lead the process to crash, such as
195 an assertion failure. This is not currently used for anything.
196 @item fatal, 8
197 Only show fatal errors. These are errors after which the process absolutely
198 cannot continue.
199 @item error, 16
200 Show all errors, including ones which can be recovered from.
201 @item warning, 24
202 Show all warnings and errors. Any message related to possibly
203 incorrect or unexpected events will be shown.
204 @item info, 32
205 Show informative messages during processing. This is in addition to
206 warnings and errors. This is the default value.
207 @item verbose, 40
208 Same as @code{info}, except more verbose.
209 @item debug, 48
210 Show everything, including debugging information.
211 @item trace, 56
212 @end table
213
214 For example to enable repeated log output, add the @code{level} prefix, and set
215 @var{loglevel} to @code{verbose}:
216 @example
217 ffmpeg -loglevel repeat+level+verbose -i input output
218 @end example
219 Another example that enables repeated log output without affecting current
220 state of @code{level} prefix flag or @var{loglevel}:
221 @example
222 ffmpeg [...] -loglevel +repeat
223 @end example
224
225 By default the program logs to stderr. If coloring is supported by the
226 terminal, colors are used to mark errors and warnings. Log coloring
227 can be disabled setting the environment variable
228 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
229 the environment variable @env{AV_LOG_FORCE_COLOR}.
230 The use of the environment variable @env{NO_COLOR} is deprecated and
231 will be dropped in a future FFmpeg version.
232
233 @item -report
234 Dump full command line and console output to a file named
235 @code{@var{program}-@var{YYYYMMDD}-@var{HHMMSS}.log} in the current
236 directory.
237 This file can be useful for bug reports.
238 It also implies @code{-loglevel verbose}.
239
240 Setting the environment variable @env{FFREPORT} to any value has the
241 same effect. If the value is a ':'-separated key=value sequence, these
242 options will affect the report; option values must be escaped if they
243 contain special characters or the options delimiter ':' (see the
244 ``Quoting and escaping'' section in the ffmpeg-utils manual).
245
246 The following options are recognized:
247 @table @option
248 @item file
249 set the file name to use for the report; @code{%p} is expanded to the name
250 of the program, @code{%t} is expanded to a timestamp, @code{%%} is expanded
251 to a plain @code{%}
252 @item level
253 set the log verbosity level using a numerical value (see @code{-loglevel}).
254 @end table
255
256 For example, to output a report to a file named @file{ffreport.log}
257 using a log level of @code{32} (alias for log level @code{info}):
258
259 @example
260 FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
261 @end example
262
263 Errors in parsing the environment variable are not fatal, and will not
264 appear in the report.
265
266 @item -hide_banner
267 Suppress printing banner.
268
269 All FFmpeg tools will normally show a copyright notice, build options
270 and library versions. This option can be used to suppress printing
271 this information.
272
273 @item -cpuflags flags (@emph{global})
274 Allows setting and clearing cpu flags. This option is intended
275 for testing. Do not use it unless you know what you're doing.
276 @example
277 ffmpeg -cpuflags -sse+mmx ...
278 ffmpeg -cpuflags mmx ...
279 ffmpeg -cpuflags 0 ...
280 @end example
281 Possible flags for this option are:
282 @table @samp
283 @item x86
284 @table @samp
285 @item mmx
286 @item mmxext
287 @item sse
288 @item sse2
289 @item sse2slow
290 @item sse3
291 @item sse3slow
292 @item ssse3
293 @item atom
294 @item sse4.1
295 @item sse4.2
296 @item avx
297 @item avx2
298 @item xop
299 @item fma3
300 @item fma4
301 @item 3dnow
302 @item 3dnowext
303 @item bmi1
304 @item bmi2
305 @item cmov
306 @end table
307 @item ARM
308 @table @samp
309 @item armv5te
310 @item armv6
311 @item armv6t2
312 @item vfp
313 @item vfpv3
314 @item neon
315 @item setend
316 @end table
317 @item AArch64
318 @table @samp
319 @item armv8
320 @item vfp
321 @item neon
322 @end table
323 @item PowerPC
324 @table @samp
325 @item altivec
326 @end table
327 @item Specific Processors
328 @table @samp
329 @item pentium2
330 @item pentium3
331 @item pentium4
332 @item k6
333 @item k62
334 @item athlon
335 @item athlonxp
336 @item k8
337 @end table
338 @end table
339 @end table
340
341 @section AVOptions
342
343 These options are provided directly by the libavformat, libavdevice and
344 libavcodec libraries. To see the list of available AVOptions, use the
345 @option{-help} option. They are separated into two categories:
346 @table @option
347 @item generic
348 These options can be set for any container, codec or device. Generic options
349 are listed under AVFormatContext options for containers/devices and under
350 AVCodecContext options for codecs.
351 @item private
352 These options are specific to the given container, device or codec. Private
353 options are listed under their corresponding containers/devices/codecs.
354 @end table
355
356 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
357 an MP3 file, use the @option{id3v2_version} private option of the MP3
358 muxer:
359 @example
360 ffmpeg -i input.flac -id3v2_version 3 out.mp3
361 @end example
362
363 All codec AVOptions are per-stream, and thus a stream specifier
364 should be attached to them.
365
366 Note: the @option{-nooption} syntax cannot be used for boolean
367 AVOptions, use @option{-option 0}/@option{-option 1}.
368
369 Note: the old undocumented way of specifying per-stream AVOptions by
370 prepending v/a/s to the options name is now obsolete and will be
371 removed soon.