Merge remote-tracking branch 'qatar/master'
[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 International System number postfixes, for example 'K', 'M', 'G'.
4 If 'i' is appended after the postfix, powers of 2 are used instead of
5 powers of 10. The 'B' postfix multiplies the value for 8, and can be
6 appended after another postfix or used alone. This allows using for
7 example 'KB', 'MiB', 'G' and 'B' as postfix.
8
9 Options which do not take arguments are boolean options, and set the
10 corresponding value to true. They can be set to false by prefixing
11 with "no" the option name, for example using "-nofoo" in the
12 command line will set to false the boolean option with name "foo".
13
14 @anchor{Stream specifiers}
15 @section Stream specifiers
16 Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
17 are used to precisely specify which stream(s) does a given option belong to.
18
19 A stream specifier is a string generally appended to the option name and
20 separated from it by a colon. E.g. @code{-codec:a:1 ac3} option contains
21 @code{a:1} stream specifer, which matches the second audio stream. Therefore it
22 would select the ac3 codec for the second audio stream.
23
24 A stream specifier can match several stream, the option is then applied to all
25 of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio
26 streams.
27
28 An empty stream specifier matches all streams, for example @code{-codec copy}
29 or @code{-codec: copy} would copy all the streams without reencoding.
30
31 Possible forms of stream specifiers are:
32 @table @option
33 @item @var{stream_index}
34 Matches the stream with this index. E.g. @code{-threads:1 4} would set the
35 thread count for the second stream to 4.
36 @item @var{stream_type}[:@var{stream_index}]
37 @var{stream_type} is one of: 'v' for video, 'a' for audio, 's' for subtitle,
38 'd' for data and 't' for attachments. If @var{stream_index} is given, then
39 matches stream number @var{stream_index} of this type. Otherwise matches all
40 streams of this type.
41 @item p:@var{program_id}[:@var{stream_index}]
42 If @var{stream_index} is given, then matches stream number @var{stream_index} in
43 program with id @var{program_id}. Otherwise matches all streams in this program.
44 @end table
45 @section Generic options
46
47 These options are shared amongst the av* tools.
48
49 @table @option
50
51 @item -L
52 Show license.
53
54 @item -h, -?, -help, --help
55 Show help.
56
57 @item -version
58 Show version.
59
60 @item -formats
61 Show available formats.
62
63 The fields preceding the format names have the following meanings:
64 @table @samp
65 @item D
66 Decoding available
67 @item E
68 Encoding available
69 @end table
70
71 @item -codecs
72 Show available codecs.
73
74 The fields preceding the codec names have the following meanings:
75 @table @samp
76 @item D
77 Decoding available
78 @item E
79 Encoding available
80 @item V/A/S
81 Video/audio/subtitle codec
82 @item S
83 Codec supports slices
84 @item D
85 Codec supports direct rendering
86 @item T
87 Codec can handle input truncated at random locations instead of only at frame boundaries
88 @end table
89
90 @item -bsfs
91 Show available bitstream filters.
92
93 @item -protocols
94 Show available protocols.
95
96 @item -filters
97 Show available libavfilter filters.
98
99 @item -pix_fmts
100 Show available pixel formats.
101
102 @item -sample_fmts
103 Show available sample formats.
104
105 @item -loglevel @var{loglevel} | -v @var{loglevel}
106 Set the logging level used by the library.
107 @var{loglevel} is a number or a string containing one of the following values:
108 @table @samp
109 @item quiet
110 @item panic
111 @item fatal
112 @item error
113 @item warning
114 @item info
115 @item verbose
116 @item debug
117 @end table
118
119 By default the program logs to stderr, if coloring is supported by the
120 terminal, colors are used to mark errors and warnings. Log coloring
121 can be disabled setting the environment variable
122 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
123 the environment variable @env{AV_LOG_FORCE_COLOR}.
124 The use of the environment variable @env{NO_COLOR} is deprecated and
125 will be dropped in a following FFmpeg version.
126
127 @item -report
128 Dump full command line and console output to a file named
129 @code{@var{program}-@var{YYYYMMDD}-@var{HHMMSS}.log} in the current
130 directory.
131 This file can be useful for bug reports.
132 It also implies @code{-loglevel verbose}.
133
134 Note: setting the environment variable @code{FFREPORT} to any value has the
135 same effect.
136
137 @item -cpuflags flags (@emph{global})
138 Allows setting and clearing cpu flags. This option is intended
139 for testing. Do not use it unless you know what you're doing.
140
141 @end table
142
143 @section AVOptions
144
145 These options are provided directly by the libavformat, libavdevice and
146 libavcodec libraries. To see the list of available AVOptions, use the
147 @option{-help} option. They are separated into two categories:
148 @table @option
149 @item generic
150 These options can be set for any container, codec or device. Generic options
151 are listed under AVFormatContext options for containers/devices and under
152 AVCodecContext options for codecs.
153 @item private
154 These options are specific to the given container, device or codec. Private
155 options are listed under their corresponding containers/devices/codecs.
156 @end table
157
158 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
159 an MP3 file, use the @option{id3v2_version} private option of the MP3
160 muxer:
161 @example
162 ffmpeg -i input.flac -id3v2_version 3 out.mp3
163 @end example
164
165 All codec AVOptions are obviously per-stream, so the chapter on stream
166 specifiers applies to them
167
168 Note @option{-nooption} syntax cannot be used for boolean AVOptions,
169 use @option{-option 0}/@option{-option 1}.
170
171 Note2 old undocumented way of specifying per-stream AVOptions by prepending
172 v/a/s to the options name is now obsolete and will be removed soon.