cmdutils: add -colors 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 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 -colors
132 Show recognized color names.
133
134 @item -loglevel [repeat+]@var{loglevel} | -v [repeat+]@var{loglevel}
135 Set the logging level used by the library.
136 Adding "repeat+" indicates that repeated log output should not be compressed
137 to the first line and the "Last message repeated n times" line will be
138 omitted. "repeat" can also be used alone.
139 If "repeat" is used alone, and with no prior loglevel set, the default
140 loglevel will be used. If multiple loglevel parameters are given, using
141 'repeat' will not change the loglevel.
142 @var{loglevel} is a number or a string containing one of the following values:
143 @table @samp
144 @item quiet
145 Show nothing at all; be silent.
146 @item panic
147 Only show fatal errors which could lead the process to crash, such as
148 and assert failure. This is not currently used for anything.
149 @item fatal
150 Only show fatal errors. These are errors after which the process absolutely
151 cannot continue after.
152 @item error
153 Show all errors, including ones which can be recovered from.
154 @item warning
155 Show all warnings and errors. Any message related to possibly
156 incorrect or unexpected events will be shown.
157 @item info
158 Show informative messages during processing. This is in addition to
159 warnings and errors. This is the default value.
160 @item verbose
161 Same as @code{info}, except more verbose.
162 @item debug
163 Show everything, including debugging information.
164 @end table
165
166 By default the program logs to stderr, if coloring is supported by the
167 terminal, colors are used to mark errors and warnings. Log coloring
168 can be disabled setting the environment variable
169 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
170 the environment variable @env{AV_LOG_FORCE_COLOR}.
171 The use of the environment variable @env{NO_COLOR} is deprecated and
172 will be dropped in a following FFmpeg version.
173
174 @item -report
175 Dump full command line and console output to a file named
176 @code{@var{program}-@var{YYYYMMDD}-@var{HHMMSS}.log} in the current
177 directory.
178 This file can be useful for bug reports.
179 It also implies @code{-loglevel verbose}.
180
181 Setting the environment variable @code{FFREPORT} to any value has the
182 same effect. If the value is a ':'-separated key=value sequence, these
183 options will affect the report; options values must be escaped if they
184 contain special characters or the options delimiter ':' (see the
185 ``Quoting and escaping'' section in the ffmpeg-utils manual). The
186 following option is recognized:
187 @table @option
188 @item file
189 set the file name to use for the report; @code{%p} is expanded to the name
190 of the program, @code{%t} is expanded to a timestamp, @code{%%} is expanded
191 to a plain @code{%}
192 @end table
193
194 Errors in parsing the environment variable are not fatal, and will not
195 appear in the report.
196
197 @item -cpuflags flags (@emph{global})
198 Allows setting and clearing cpu flags. This option is intended
199 for testing. Do not use it unless you know what you're doing.
200 @example
201 ffmpeg -cpuflags -sse+mmx ...
202 ffmpeg -cpuflags mmx ...
203 ffmpeg -cpuflags 0 ...
204 @end example
205 Possible flags for this option are:
206 @table @samp
207 @item x86
208 @table @samp
209 @item mmx
210 @item mmxext
211 @item sse
212 @item sse2
213 @item sse2slow
214 @item sse3
215 @item sse3slow
216 @item ssse3
217 @item atom
218 @item sse4.1
219 @item sse4.2
220 @item avx
221 @item xop
222 @item fma4
223 @item 3dnow
224 @item 3dnowext
225 @item cmov
226 @end table
227 @item ARM
228 @table @samp
229 @item armv5te
230 @item armv6
231 @item armv6t2
232 @item vfp
233 @item vfpv3
234 @item neon
235 @end table
236 @item PowerPC
237 @table @samp
238 @item altivec
239 @end table
240 @item Specific Processors
241 @table @samp
242 @item pentium2
243 @item pentium3
244 @item pentium4
245 @item k6
246 @item k62
247 @item athlon
248 @item athlonxp
249 @item k8
250 @end table
251 @end table
252
253 @item -opencl_options options (@emph{global})
254 Set OpenCL environment options. This option is only available when
255 FFmpeg has been compiled with @code{--enable-opencl}.
256
257 @var{options} must be a list of @var{key}=@var{value} option pairs
258 separated by ':'. See the ``OpenCL Options'' section in the
259 ffmpeg-utils manual for the list of supported options.
260 @end table
261
262 @section AVOptions
263
264 These options are provided directly by the libavformat, libavdevice and
265 libavcodec libraries. To see the list of available AVOptions, use the
266 @option{-help} option. They are separated into two categories:
267 @table @option
268 @item generic
269 These options can be set for any container, codec or device. Generic options
270 are listed under AVFormatContext options for containers/devices and under
271 AVCodecContext options for codecs.
272 @item private
273 These options are specific to the given container, device or codec. Private
274 options are listed under their corresponding containers/devices/codecs.
275 @end table
276
277 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
278 an MP3 file, use the @option{id3v2_version} private option of the MP3
279 muxer:
280 @example
281 ffmpeg -i input.flac -id3v2_version 3 out.mp3
282 @end example
283
284 All codec AVOptions are per-stream, and thus a stream specifier
285 should be attached to them.
286
287 Note: the @option{-nooption} syntax cannot be used for boolean
288 AVOptions, use @option{-option 0}/@option{-option 1}.
289
290 Note: the old undocumented way of specifying per-stream AVOptions by
291 prepending v/a/s to the options name is now obsolete and will be
292 removed soon.