8468ecaad1a3895ecd2dd998e983b9c14716e22f
[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 SI unit prefixes, for example 'K', 'M', 'G'.
4 If 'i' is appended after the prefix, binary prefixes are used,
5 which are based on powers of 1024 instead of powers of 1000.
6 The 'B' postfix multiplies the value by 8, and can be
7 appended after a unit prefix or used alone. This allows using for
8 example 'KB', 'MiB', 'G' and 'B' as number postfix.
9
10 Options which do not take arguments are boolean options, and set the
11 corresponding value to true. They can be set to false by prefixing
12 with "no" the option name, for example using "-nofoo" in the
13 command line will set to false the boolean option with name "foo".
14
15 @anchor{Stream specifiers}
16 @section Stream specifiers
17 Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
18 are used to precisely specify which stream(s) does a given option belong to.
19
20 A stream specifier is a string generally appended to the option name and
21 separated from it by a colon. E.g. @code{-codec:a:1 ac3} option contains
22 @code{a:1} stream specifer, which matches the second audio stream. Therefore it
23 would select the ac3 codec for the second audio stream.
24
25 A stream specifier can match several stream, the option is then applied to all
26 of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio
27 streams.
28
29 An empty stream specifier matches all streams, for example @code{-codec copy}
30 or @code{-codec: copy} would copy all the streams without reencoding.
31
32 Possible forms of stream specifiers are:
33 @table @option
34 @item @var{stream_index}
35 Matches the stream with this index. E.g. @code{-threads:1 4} would set the
36 thread count for the second stream to 4.
37 @item @var{stream_type}[:@var{stream_index}]
38 @var{stream_type} is one of: 'v' for video, 'a' for audio, 's' for subtitle,
39 'd' for data and 't' for attachments. If @var{stream_index} is given, then
40 matches stream number @var{stream_index} of this type. Otherwise matches all
41 streams of this type.
42 @item p:@var{program_id}[:@var{stream_index}]
43 If @var{stream_index} is given, then matches stream number @var{stream_index} in
44 program with id @var{program_id}. Otherwise matches all streams in this program.
45 @item i:@var{stream_id}
46 Match the stream by stream id (e.g. PID in MPEG-TS container).
47 @item m:@var{key}[:@var{value}]
48 Matches streams with the metadata tag @var{key} having the specified value. If
49 @var{value} is not given, matches streams that contain the given tag with any
50 value.
51
52 Note that in @command{avconv}, matching by metadata will only work properly for
53 input files.
54 @end table
55 @section Generic options
56
57 These options are shared amongst the av* tools.
58
59 @table @option
60
61 @item -L
62 Show license.
63
64 @item -h, -?, -help, --help [@var{arg}]
65 Show help. An optional parameter may be specified to print help about a specific
66 item.
67
68 Possible values of @var{arg} are:
69 @table @option
70 @item decoder=@var{decoder_name}
71 Print detailed information about the decoder named @var{decoder_name}. Use the
72 @option{-decoders} option to get a list of all decoders.
73
74 @item encoder=@var{encoder_name}
75 Print detailed information about the encoder named @var{encoder_name}. Use the
76 @option{-encoders} option to get a list of all encoders.
77
78 @item demuxer=@var{demuxer_name}
79 Print detailed information about the demuxer named @var{demuxer_name}. Use the
80 @option{-formats} option to get a list of all demuxers and muxers.
81
82 @item muxer=@var{muxer_name}
83 Print detailed information about the muxer named @var{muxer_name}. Use the
84 @option{-formats} option to get a list of all muxers and demuxers.
85
86 @item filter=@var{filter_name}
87 Print detailed information about the filter name @var{filter_name}. Use the
88 @option{-filters} option to get a list of all filters.
89
90 @end table
91
92 @item -version
93 Show version.
94
95 @item -formats
96 Show available formats.
97
98 The fields preceding the format names have the following meanings:
99 @table @samp
100 @item D
101 Decoding available
102 @item E
103 Encoding available
104 @end table
105
106 @item -codecs
107 Show all codecs known to libavcodec.
108
109 Note that the term 'codec' is used throughout this documentation as a shortcut
110 for what is more correctly called a media bitstream format.
111
112 @item -decoders
113 Show available decoders.
114
115 @item -encoders
116 Show all available encoders.
117
118 @item -bsfs
119 Show available bitstream filters.
120
121 @item -protocols
122 Show available protocols.
123
124 @item -filters
125 Show available libavfilter filters.
126
127 @item -pix_fmts
128 Show available pixel formats.
129
130 @item -sample_fmts
131 Show available sample formats.
132
133 @item -loglevel @var{loglevel} | -v @var{loglevel}
134 Set the logging level used by the library.
135 @var{loglevel} is a number or a string containing one of the following values:
136 @table @samp
137 @item quiet
138 @item panic
139 @item fatal
140 @item error
141 @item warning
142 @item info
143 @item verbose
144 @item debug
145 @end table
146
147 By default the program logs to stderr, if coloring is supported by the
148 terminal, colors are used to mark errors and warnings. Log coloring
149 can be disabled setting the environment variable
150 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
151 the environment variable @env{AV_LOG_FORCE_COLOR}.
152 The use of the environment variable @env{NO_COLOR} is deprecated and
153 will be dropped in a following Libav version.
154
155 @item -cpuflags mask (@emph{global})
156 Set a mask that's applied to autodetected CPU flags. This option is intended
157 for testing. Do not use it unless you know what you're doing.
158
159 @end table
160
161 @section AVOptions
162
163 These options are provided directly by the libavformat, libavdevice and
164 libavcodec libraries. To see the list of available AVOptions, use the
165 @option{-help} option. They are separated into two categories:
166 @table @option
167 @item generic
168 These options can be set for any container, codec or device. Generic options
169 are listed under AVFormatContext options for containers/devices and under
170 AVCodecContext options for codecs.
171 @item private
172 These options are specific to the given container, device or codec. Private
173 options are listed under their corresponding containers/devices/codecs.
174 @end table
175
176 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
177 an MP3 file, use the @option{id3v2_version} private option of the MP3
178 muxer:
179 @example
180 avconv -i input.flac -id3v2_version 3 out.mp3
181 @end example
182
183 All codec AVOptions are obviously per-stream, so the chapter on stream
184 specifiers applies to them
185
186 Note @option{-nooption} syntax cannot be used for boolean AVOptions,
187 use @option{-option 0}/@option{-option 1}.
188
189 Note2 old undocumented way of specifying per-stream AVOptions by prepending
190 v/a/s to the options name is now obsolete and will be removed soon.
191
192 @include avoptions_codec.texi
193 @include avoptions_format.texi