cmdutils: refactor -codecs option.
[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 all codecs known to libavcodec.
73
74 Note that the term 'codec' is used throughout this documentation as a shortcut
75 for what is more correctly called a media bitstream format.
76
77 @item -decoders
78 Show available decoders.
79
80 @item -encoders
81 Show all available encoders.
82
83 @item -bsfs
84 Show available bitstream filters.
85
86 @item -protocols
87 Show available protocols.
88
89 @item -filters
90 Show available libavfilter filters.
91
92 @item -pix_fmts
93 Show available pixel formats.
94
95 @item -sample_fmts
96 Show available sample formats.
97
98 @item -loglevel @var{loglevel} | -v @var{loglevel}
99 Set the logging level used by the library.
100 @var{loglevel} is a number or a string containing one of the following values:
101 @table @samp
102 @item quiet
103 @item panic
104 @item fatal
105 @item error
106 @item warning
107 @item info
108 @item verbose
109 @item debug
110 @end table
111
112 By default the program logs to stderr, if coloring is supported by the
113 terminal, colors are used to mark errors and warnings. Log coloring
114 can be disabled setting the environment variable
115 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
116 the environment variable @env{AV_LOG_FORCE_COLOR}.
117 The use of the environment variable @env{NO_COLOR} is deprecated and
118 will be dropped in a following Libav version.
119
120 @end table
121
122 @section AVOptions
123
124 These options are provided directly by the libavformat, libavdevice and
125 libavcodec libraries. To see the list of available AVOptions, use the
126 @option{-help} option. They are separated into two categories:
127 @table @option
128 @item generic
129 These options can be set for any container, codec or device. Generic options
130 are listed under AVFormatContext options for containers/devices and under
131 AVCodecContext options for codecs.
132 @item private
133 These options are specific to the given container, device or codec. Private
134 options are listed under their corresponding containers/devices/codecs.
135 @end table
136
137 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
138 an MP3 file, use the @option{id3v2_version} private option of the MP3
139 muxer:
140 @example
141 avconv -i input.flac -id3v2_version 3 out.mp3
142 @end example
143
144 All codec AVOptions are obviously per-stream, so the chapter on stream
145 specifiers applies to them
146
147 Note @option{-nooption} syntax cannot be used for boolean AVOptions,
148 use @option{-option 0}/@option{-option 1}.
149
150 Note2 old undocumented way of specifying per-stream AVOptions by prepending
151 v/a/s to the options name is now obsolete and will be removed soon.
152
153 @include avoptions_codec.texi
154 @include avoptions_format.texi