avtools: add -v as alias for -loglevel
[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
12commandline will set to false the boolean option with name "foo".
13
99442bfe
AK
14@section Stream specifiers
15Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
16are used to precisely specify which stream(s) does a given option belong to.
17
18A stream specifier is a string generally appended to the option name and
19separated from it by a colon. E.g. @code{-codec:a:1 ac3} option contains
20@code{a:1} stream specifer, which matches the second audio stream. Therefore it
21would select the ac3 codec for the second audio stream.
22
23A stream specifier can match several stream, the option is then applied to all
24of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio
25streams.
26
27An empty stream specifier matches all streams, for example @code{-codec copy}
28or @code{-codec: copy} would copy all the streams without reencoding.
29
30Possible forms of stream specifiers are:
31@table @option
32@item @var{stream_index}
33Matches the stream with this index. E.g. @code{-threads:1 4} would set the
34thread count for the second stream to 4.
35@item @var{stream_type}[:@var{stream_index}]
3ccd1580
AK
36@var{stream_type} is one of: 'v' for video, 'a' for audio, 's' for subtitle,
37'd' for data and 't' for attachments. If @var{stream_index} is given, then
38matches stream number @var{stream_index} of this type. Otherwise matches all
39streams of this type.
99442bfe
AK
40@item @var{program_id}[:@var{stream_index}]
41If @var{stream_index} is given, then matches stream number @var{stream_index} in
42program with id @var{program_id}. Otherwise matches all streams in this program.
43@end table
8b9da8b5
SS
44@section Generic options
45
b3dd2010 46These options are shared amongst the av* tools.
8b9da8b5
SS
47
48@table @option
49
5f6cb6eb
SS
50@item -L
51Show license.
52
53@item -h, -?, -help, --help
54Show help.
55
56@item -version
57Show version.
58
59@item -formats
60Show available formats.
61
62The fields preceding the format names have the following meanings:
63@table @samp
64@item D
65Decoding available
66@item E
67Encoding available
68@end table
69
70@item -codecs
71Show available codecs.
72
73The fields preceding the codec names have the following meanings:
74@table @samp
75@item D
76Decoding available
77@item E
78Encoding available
79@item V/A/S
80Video/audio/subtitle codec
81@item S
82Codec supports slices
83@item D
84Codec supports direct rendering
85@item T
86Codec can handle input truncated at random locations instead of only at frame boundaries
87@end table
88
89@item -bsfs
90Show available bitstream filters.
91
92@item -protocols
93Show available protocols.
94
95@item -filters
96Show available libavfilter filters.
97
3f7bb426
SS
98@item -pix_fmts
99Show available pixel formats.
100
05bffc12
AK
101@item -sample_fmts
102Show available sample formats.
103
8124d8ad 104@item -loglevel @var{loglevel} | -v @var{loglevel}
5f6cb6eb
SS
105Set the logging level used by the library.
106@var{loglevel} is a number or a string containing one of the following values:
107@table @samp
108@item quiet
109@item panic
110@item fatal
111@item error
112@item warning
113@item info
114@item verbose
115@item debug
116@end table
117
1e27c477
SS
118By default the program logs to stderr, if coloring is supported by the
119terminal, colors are used to mark errors and warnings. Log coloring
3011ecde
SS
120can be disabled setting the environment variable
121@env{FFMPEG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
122the environment variable @env{FFMPEG_FORCE_COLOR}.
c3d07c17 123The use of the environment variable @env{NO_COLOR} is deprecated and
f8a45fa1 124will be dropped in a following Libav version.
1e27c477 125
8b9da8b5 126@end table
22b203ba
AK
127
128@section AVOptions
129
e0e65ddb
AK
130These options are provided directly by the libavformat, libavdevice and
131libavcodec libraries. To see the list of available AVOptions, use the
22b203ba
AK
132@option{-help} option. They are separated into two categories:
133@table @option
134@item generic
e0e65ddb
AK
135These options can be set for any container, codec or device. Generic options are
136listed under AVFormatContext options for containers/devices and under
137AVCodecContext options for codecs.
22b203ba 138@item private
e0e65ddb
AK
139These options are specific to the given container, device or codec. Private
140options are listed under their corresponding containers/devices/codecs.
22b203ba
AK
141@end table
142
143For example to write an ID3v2.3 header instead of a default ID3v2.4 to
144an MP3 file, use the @option{id3v2_version} private option of the MP3
145muxer:
146@example
147ffmpeg -i input.flac -id3v2_version 3 out.mp3
148@end example
149
99442bfe
AK
150All codec AVOptions are obviously per-stream, so the chapter on stream
151specifiers applies to them
d4863fc1 152
22b203ba
AK
153Note -nooption syntax cannot be used for boolean AVOptions, use -option
1540/-option 1.
d4863fc1
AK
155
156Note2 old undocumented way of specifying per-stream AVOptions by prepending
157v/a/s to the options name is now obsolete and will be removed soon.