cmdutils: extend -h to allow printing codec details.
[libav.git] / doc / avtools-common-opts.texi
CommitLineData
25e25617
SS
1All the numerical options, if not specified otherwise, accept in input
2a string representing a number, which may contain one of the
3International System number postfixes, for example 'K', 'M', 'G'.
4If 'i' is appended after the postfix, powers of 2 are used instead of
5powers of 10. The 'B' postfix multiplies the value for 8, and can be
6appended after another postfix or used alone. This allows using for
7example 'KB', 'MiB', 'G' and 'B' as postfix.
8
92d71714
SS
9Options which do not take arguments are boolean options, and set the
10corresponding value to true. They can be set to false by prefixing
11with "no" the option name, for example using "-nofoo" in the
da9cea77 12command line will set to false the boolean option with name "foo".
92d71714 13
a7b5e841 14@anchor{Stream specifiers}
99442bfe
AK
15@section Stream specifiers
16Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
17are used to precisely specify which stream(s) does a given option belong to.
18
19A stream specifier is a string generally appended to the option name and
20separated 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
22would select the ac3 codec for the second audio stream.
23
24A stream specifier can match several stream, the option is then applied to all
25of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio
26streams.
27
28An empty stream specifier matches all streams, for example @code{-codec copy}
29or @code{-codec: copy} would copy all the streams without reencoding.
30
31Possible forms of stream specifiers are:
32@table @option
33@item @var{stream_index}
34Matches the stream with this index. E.g. @code{-threads:1 4} would set the
35thread count for the second stream to 4.
36@item @var{stream_type}[:@var{stream_index}]
3ccd1580
AK
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
39matches stream number @var{stream_index} of this type. Otherwise matches all
40streams of this type.
a5f05e52 41@item p:@var{program_id}[:@var{stream_index}]
99442bfe
AK
42If @var{stream_index} is given, then matches stream number @var{stream_index} in
43program with id @var{program_id}. Otherwise matches all streams in this program.
44@end table
8b9da8b5
SS
45@section Generic options
46
b3dd2010 47These options are shared amongst the av* tools.
8b9da8b5
SS
48
49@table @option
50
5f6cb6eb
SS
51@item -L
52Show license.
53
a3ad68d3
AK
54@item -h, -?, -help, --help [@var{arg}]
55Show help. An optional parameter may be specified to print help about a specific
56item.
57
58Possible values of @var{arg} are:
59@table @option
60@item decoder=@var{decoder_name}
61Print detailed information about the decoder named @var{decoder_name}. Use the
62@option{-decoders} option to get a list of all decoders.
63
64@item encoder=@var{encoder_name}
65Print detailed information about the encoder named @var{encoder_name}. Use the
66@option{-encoders} option to get a list of all encoders.
67@end table
5f6cb6eb
SS
68
69@item -version
70Show version.
71
72@item -formats
73Show available formats.
74
75The fields preceding the format names have the following meanings:
76@table @samp
77@item D
78Decoding available
79@item E
80Encoding available
81@end table
82
83@item -codecs
7c101949 84Show all codecs known to libavcodec.
5f6cb6eb 85
7c101949
AK
86Note that the term 'codec' is used throughout this documentation as a shortcut
87for what is more correctly called a media bitstream format.
88
89@item -decoders
90Show available decoders.
91
92@item -encoders
93Show all available encoders.
5f6cb6eb
SS
94
95@item -bsfs
96Show available bitstream filters.
97
98@item -protocols
99Show available protocols.
100
101@item -filters
102Show available libavfilter filters.
103
3f7bb426
SS
104@item -pix_fmts
105Show available pixel formats.
106
05bffc12
AK
107@item -sample_fmts
108Show available sample formats.
109
8124d8ad 110@item -loglevel @var{loglevel} | -v @var{loglevel}
5f6cb6eb
SS
111Set the logging level used by the library.
112@var{loglevel} is a number or a string containing one of the following values:
113@table @samp
114@item quiet
115@item panic
116@item fatal
117@item error
118@item warning
119@item info
120@item verbose
121@item debug
122@end table
123
1e27c477
SS
124By default the program logs to stderr, if coloring is supported by the
125terminal, colors are used to mark errors and warnings. Log coloring
3011ecde 126can be disabled setting the environment variable
1466a518
DB
127@env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
128the environment variable @env{AV_LOG_FORCE_COLOR}.
c3d07c17 129The use of the environment variable @env{NO_COLOR} is deprecated and
f8a45fa1 130will be dropped in a following Libav version.
1e27c477 131
8b9da8b5 132@end table
22b203ba
AK
133
134@section AVOptions
135
e0e65ddb
AK
136These options are provided directly by the libavformat, libavdevice and
137libavcodec libraries. To see the list of available AVOptions, use the
22b203ba
AK
138@option{-help} option. They are separated into two categories:
139@table @option
140@item generic
d5837d7f
LB
141These options can be set for any container, codec or device. Generic options
142are listed under AVFormatContext options for containers/devices and under
e0e65ddb 143AVCodecContext options for codecs.
22b203ba 144@item private
e0e65ddb
AK
145These options are specific to the given container, device or codec. Private
146options are listed under their corresponding containers/devices/codecs.
22b203ba
AK
147@end table
148
149For example to write an ID3v2.3 header instead of a default ID3v2.4 to
150an MP3 file, use the @option{id3v2_version} private option of the MP3
151muxer:
152@example
d5837d7f 153avconv -i input.flac -id3v2_version 3 out.mp3
22b203ba
AK
154@end example
155
99442bfe
AK
156All codec AVOptions are obviously per-stream, so the chapter on stream
157specifiers applies to them
d4863fc1 158
d5837d7f
LB
159Note @option{-nooption} syntax cannot be used for boolean AVOptions,
160use @option{-option 0}/@option{-option 1}.
d4863fc1
AK
161
162Note2 old undocumented way of specifying per-stream AVOptions by prepending
163v/a/s to the options name is now obsolete and will be removed soon.
0d0b81f9
AK
164
165@include avoptions_codec.texi
166@include avoptions_format.texi