avconv: move audio_sample_fmt to options context.
[libav.git] / doc / fftools-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.
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 commandline will set to false the boolean option with name "foo".
14 @section Generic options
16 These options are shared amongst the ff* tools.
18 @table @option
20 @item -L
21 Show license.
23 @item -h, -?, -help, --help
24 Show help.
26 @item -version
27 Show version.
29 @item -formats
30 Show available formats.
32 The fields preceding the format names have the following meanings:
33 @table @samp
34 @item D
35 Decoding available
36 @item E
37 Encoding available
38 @end table
40 @item -codecs
41 Show available codecs.
43 The fields preceding the codec names have the following meanings:
44 @table @samp
45 @item D
46 Decoding available
47 @item E
48 Encoding available
49 @item V/A/S
50 Video/audio/subtitle codec
51 @item S
52 Codec supports slices
53 @item D
54 Codec supports direct rendering
55 @item T
56 Codec can handle input truncated at random locations instead of only at frame boundaries
57 @end table
59 @item -bsfs
60 Show available bitstream filters.
62 @item -protocols
63 Show available protocols.
65 @item -filters
66 Show available libavfilter filters.
68 @item -pix_fmts
69 Show available pixel formats.
71 @item -sample_fmts
72 Show available sample formats.
74 @item -loglevel @var{loglevel}
75 Set the logging level used by the library.
76 @var{loglevel} is a number or a string containing one of the following values:
77 @table @samp
78 @item quiet
79 @item panic
80 @item fatal
81 @item error
82 @item warning
83 @item info
84 @item verbose
85 @item debug
86 @end table
88 By default the program logs to stderr, if coloring is supported by the
89 terminal, colors are used to mark errors and warnings. Log coloring
90 can be disabled setting the environment variable
91 @env{FFMPEG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
92 the environment variable @env{FFMPEG_FORCE_COLOR}.
93 The use of the environment variable @env{NO_COLOR} is deprecated and
94 will be dropped in a following Libav version.
96 @end table
98 @section AVOptions
100 These options are provided directly by the libavformat, libavdevice and
101 libavcodec libraries. To see the list of available AVOptions, use the
102 @option{-help} option. They are separated into two categories:
103 @table @option
104 @item generic
105 These options can be set for any container, codec or device. Generic options are
106 listed under AVFormatContext options for containers/devices and under
107 AVCodecContext options for codecs.
108 @item private
109 These options are specific to the given container, device or codec. Private
110 options are listed under their corresponding containers/devices/codecs.
111 @end table
113 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
114 an MP3 file, use the @option{id3v2_version} private option of the MP3
115 muxer:
116 @example
117 ffmpeg -i input.flac -id3v2_version 3 out.mp3
118 @end example
120 You can precisely specify which stream(s) should the codec AVOption apply to by
121 appending a stream specifier of the form
122 @option{[:@var{stream_type}][:@var{stream_index}]} to the option name.
123 @var{stream_type} is 'v' for video, 'a' for audio and 's' for subtitle streams.
124 @var{stream_index} is a global stream index when @var{stream_type} isn't
125 given, otherwise it counts streams of the given type only. As always, the index
126 is zero-based. For example
127 @example
128 -foo -- applies to all applicable streams
129 -foo:v -- applies to all video streams
130 -foo:a:2 -- applies to the third audio stream
131 -foo:0 -- applies to the first stream
132 @end example
134 Note -nooption syntax cannot be used for boolean AVOptions, use -option
135 0/-option 1.
137 Note2 old undocumented way of specifying per-stream AVOptions by prepending
138 v/a/s to the options name is now obsolete and will be removed soon.