doc/fftools-common-opts: document -help long and full output
[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 multiplies, 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}
48 Matches the stream by a format-specific ID.
49 @end table
50
51 @section Generic options
52
53 These options are shared amongst the ff* tools.
54
55 @table @option
56
57 @item -L
58 Show license.
59
60 @item -h, -?, -help, --help [@var{arg}]
61 Show help. An optional parameter may be specified to print help about a specific
62 item. If no argument is specified, only basic (non advanced) tool
63 options are shown.
64
65 Possible values of @var{arg} are:
66 @table @option
67 @item long
68 Print advanced tool options in addition to the basic tool options.
69
70 @item full
71 Print complete list of options, including shared and private options
72 for encoders, decoders, demuxers, muxers, filters, etc.
73
74 @item decoder=@var{decoder_name}
75 Print detailed information about the decoder named @var{decoder_name}. Use the
76 @option{-decoders} option to get a list of all decoders.
77
78 @item encoder=@var{encoder_name}
79 Print detailed information about the encoder named @var{encoder_name}. Use the
80 @option{-encoders} option to get a list of all encoders.
81
82 @item demuxer=@var{demuxer_name}
83 Print detailed information about the demuxer named @var{demuxer_name}. Use the
84 @option{-formats} option to get a list of all demuxers and muxers.
85
86 @item muxer=@var{muxer_name}
87 Print detailed information about the muxer named @var{muxer_name}. Use the
88 @option{-formats} option to get a list of all muxers and demuxers.
89
90 @item filter=@var{filter_name}
91 Print detailed information about the filter name @var{filter_name}. Use the
92 @option{-filters} option to get a list of all filters.
93 @end table
94
95 @item -version
96 Show version.
97
98 @item -formats
99 Show available formats.
100
101 @item -codecs
102 Show all codecs known to libavcodec.
103
104 Note that the term 'codec' is used throughout this documentation as a shortcut
105 for what is more correctly called a media bitstream format.
106
107 @item -decoders
108 Show available decoders.
109
110 @item -encoders
111 Show all available encoders.
112
113 @item -bsfs
114 Show available bitstream filters.
115
116 @item -protocols
117 Show available protocols.
118
119 @item -filters
120 Show available libavfilter filters.
121
122 @item -pix_fmts
123 Show available pixel formats.
124
125 @item -sample_fmts
126 Show available sample formats.
127
128 @item -layouts
129 Show channel names and standard channel layouts.
130
131 @item -loglevel [repeat+]@var{loglevel} | -v [repeat+]@var{loglevel}
132 Set the logging level used by the library.
133 Adding "repeat+" indicates that repeated log output should not be compressed
134 to the first line and the "Last message repeated n times" line will be
135 omitted. "repeat" can also be used alone.
136 If "repeat" is used alone, and with no prior loglevel set, the default
137 loglevel will be used. If multiple loglevel parameters are given, using
138 'repeat' will not change the loglevel.
139 @var{loglevel} is a number or a string containing one of the following values:
140 @table @samp
141 @item quiet
142 Show nothing at all; be silent.
143 @item panic
144 Only show fatal errors which could lead the process to crash, such as
145 and assert failure. This is not currently used for anything.
146 @item fatal
147 Only show fatal errors. These are errors after which the process absolutely
148 cannot continue after.
149 @item error
150 Show all errors, including ones which can be recovered from.
151 @item warning
152 Show all warnings and errors. Any message related to possibly
153 incorrect or unexpected events will be shown.
154 @item info
155 Show informative messages during processing. This is in addition to
156 warnings and errors. This is the default value.
157 @item verbose
158 Same as @code{info}, except more verbose.
159 @item debug
160 Show everything, including debugging information.
161 @end table
162
163 By default the program logs to stderr, if coloring is supported by the
164 terminal, colors are used to mark errors and warnings. Log coloring
165 can be disabled setting the environment variable
166 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
167 the environment variable @env{AV_LOG_FORCE_COLOR}.
168 The use of the environment variable @env{NO_COLOR} is deprecated and
169 will be dropped in a following FFmpeg version.
170
171 @item -report
172 Dump full command line and console output to a file named
173 @code{@var{program}-@var{YYYYMMDD}-@var{HHMMSS}.log} in the current
174 directory.
175 This file can be useful for bug reports.
176 It also implies @code{-loglevel verbose}.
177
178 Setting the environment variable @code{FFREPORT} to any value has the
179 same effect. If the value is a ':'-separated key=value sequence, these
180 options will affect the report; options values must be escaped if they
181 contain special characters or the options delimiter ':' (see the
182 ``Quoting and escaping'' section in the ffmpeg-utils manual). The
183 following option is recognized:
184 @table @option
185 @item file
186 set the file name to use for the report; @code{%p} is expanded to the name
187 of the program, @code{%t} is expanded to a timestamp, @code{%%} is expanded
188 to a plain @code{%}
189 @end table
190
191 Errors in parsing the environment variable are not fatal, and will not
192 appear in the report.
193
194 @item -cpuflags flags (@emph{global})
195 Allows setting and clearing cpu flags. This option is intended
196 for testing. Do not use it unless you know what you're doing.
197 @example
198 ffmpeg -cpuflags -sse+mmx ...
199 ffmpeg -cpuflags mmx ...
200 ffmpeg -cpuflags 0 ...
201 @end example
202 Possible flags for this option are:
203 @table @samp
204 @item x86
205 @table @samp
206 @item mmx
207 @item mmxext
208 @item sse
209 @item sse2
210 @item sse2slow
211 @item sse3
212 @item sse3slow
213 @item ssse3
214 @item atom
215 @item sse4.1
216 @item sse4.2
217 @item avx
218 @item xop
219 @item fma4
220 @item 3dnow
221 @item 3dnowext
222 @item cmov
223 @end table
224 @item ARM
225 @table @samp
226 @item armv5te
227 @item armv6
228 @item armv6t2
229 @item vfp
230 @item vfpv3
231 @item neon
232 @end table
233 @item PowerPC
234 @table @samp
235 @item altivec
236 @end table
237 @item Specific Processors
238 @table @samp
239 @item pentium2
240 @item pentium3
241 @item pentium4
242 @item k6
243 @item k62
244 @item athlon
245 @item athlonxp
246 @item k8
247 @end table
248 @end table
249
250 @item -opencl_options options (@emph{global})
251 Set OpenCL environment options. This option is only available when
252 FFmpeg has been compiled with @code{--enable-opencl}.
253
254 @var{options} must be a list of @var{key}=@var{value} option pairs
255 separated by ':'. See the ``OpenCL Options'' section in the
256 ffmpeg-utils manual for the list of supported options.
257 @end table
258
259 @section AVOptions
260
261 These options are provided directly by the libavformat, libavdevice and
262 libavcodec libraries. To see the list of available AVOptions, use the
263 @option{-help} option. They are separated into two categories:
264 @table @option
265 @item generic
266 These options can be set for any container, codec or device. Generic options
267 are listed under AVFormatContext options for containers/devices and under
268 AVCodecContext options for codecs.
269 @item private
270 These options are specific to the given container, device or codec. Private
271 options are listed under their corresponding containers/devices/codecs.
272 @end table
273
274 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
275 an MP3 file, use the @option{id3v2_version} private option of the MP3
276 muxer:
277 @example
278 ffmpeg -i input.flac -id3v2_version 3 out.mp3
279 @end example
280
281 All codec AVOptions are obviously per-stream, so the chapter on stream
282 specifiers applies to them
283
284 Note @option{-nooption} syntax cannot be used for boolean AVOptions,
285 use @option{-option 0}/@option{-option 1}.
286
287 Note2 old undocumented way of specifying per-stream AVOptions by prepending
288 v/a/s to the options name is now obsolete and will be removed soon.