lavf: drop the zero-sized packets hack
[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 @end table
48 @section Generic options
49
50 These options are shared amongst the av* tools.
51
52 @table @option
53
54 @item -L
55 Show license.
56
57 @item -h, -?, -help, --help [@var{arg}]
58 Show help. An optional parameter may be specified to print help about a specific
59 item.
60
61 Possible values of @var{arg} are:
62 @table @option
63 @item decoder=@var{decoder_name}
64 Print detailed information about the decoder named @var{decoder_name}. Use the
65 @option{-decoders} option to get a list of all decoders.
66
67 @item encoder=@var{encoder_name}
68 Print detailed information about the encoder named @var{encoder_name}. Use the
69 @option{-encoders} option to get a list of all encoders.
70
71 @item demuxer=@var{demuxer_name}
72 Print detailed information about the demuxer named @var{demuxer_name}. Use the
73 @option{-formats} option to get a list of all demuxers and muxers.
74
75 @item muxer=@var{muxer_name}
76 Print detailed information about the muxer named @var{muxer_name}. Use the
77 @option{-formats} option to get a list of all muxers and demuxers.
78
79 @item filter=@var{filter_name}
80 Print detailed information about the filter name @var{filter_name}. Use the
81 @option{-filters} option to get a list of all filters.
82
83 @end table
84
85 @item -version
86 Show version.
87
88 @item -formats
89 Show available formats.
90
91 The fields preceding the format names have the following meanings:
92 @table @samp
93 @item D
94 Decoding available
95 @item E
96 Encoding available
97 @end table
98
99 @item -codecs
100 Show all codecs known to libavcodec.
101
102 Note that the term 'codec' is used throughout this documentation as a shortcut
103 for what is more correctly called a media bitstream format.
104
105 @item -decoders
106 Show available decoders.
107
108 @item -encoders
109 Show all available encoders.
110
111 @item -bsfs
112 Show available bitstream filters.
113
114 @item -protocols
115 Show available protocols.
116
117 @item -filters
118 Show available libavfilter filters.
119
120 @item -pix_fmts
121 Show available pixel formats.
122
123 @item -sample_fmts
124 Show available sample formats.
125
126 @item -loglevel @var{loglevel} | -v @var{loglevel}
127 Set the logging level used by the library.
128 @var{loglevel} is a number or a string containing one of the following values:
129 @table @samp
130 @item quiet
131 @item panic
132 @item fatal
133 @item error
134 @item warning
135 @item info
136 @item verbose
137 @item debug
138 @end table
139
140 By default the program logs to stderr, if coloring is supported by the
141 terminal, colors are used to mark errors and warnings. Log coloring
142 can be disabled setting the environment variable
143 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
144 the environment variable @env{AV_LOG_FORCE_COLOR}.
145 The use of the environment variable @env{NO_COLOR} is deprecated and
146 will be dropped in a following Libav version.
147
148 @item -cpuflags mask (@emph{global})
149 Set a mask that's applied to autodetected CPU flags. This option is intended
150 for testing. Do not use it unless you know what you're doing.
151
152 @end table
153
154 @section AVOptions
155
156 These options are provided directly by the libavformat, libavdevice and
157 libavcodec libraries. To see the list of available AVOptions, use the
158 @option{-help} option. They are separated into two categories:
159 @table @option
160 @item generic
161 These options can be set for any container, codec or device. Generic options
162 are listed under AVFormatContext options for containers/devices and under
163 AVCodecContext options for codecs.
164 @item private
165 These options are specific to the given container, device or codec. Private
166 options are listed under their corresponding containers/devices/codecs.
167 @end table
168
169 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
170 an MP3 file, use the @option{id3v2_version} private option of the MP3
171 muxer:
172 @example
173 avconv -i input.flac -id3v2_version 3 out.mp3
174 @end example
175
176 All codec AVOptions are obviously per-stream, so the chapter on stream
177 specifiers applies to them
178
179 Note @option{-nooption} syntax cannot be used for boolean AVOptions,
180 use @option{-option 0}/@option{-option 1}.
181
182 Note2 old undocumented way of specifying per-stream AVOptions by prepending
183 v/a/s to the options name is now obsolete and will be removed soon.
184
185 @include avoptions_codec.texi
186 @include avoptions_format.texi