doc/fftools-common-opts: wording fixes missing from the previous commit.
[ffmpeg.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.
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 commandline will set to false the boolean option with name "foo".
13
14 @section Generic options
15
16 These options are shared amongst the ff* tools.
17
18 @table @option
19
20 @item -L
21 Show license.
22
23 @item -h, -?, -help, --help
24 Show help.
25
26 @item -version
27 Show version.
28
29 @item -formats
30 Show available formats.
31
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
39
40 @item -codecs
41 Show available codecs.
42
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
58
59 @item -bsfs
60 Show available bitstream filters.
61
62 @item -protocols
63 Show available protocols.
64
65 @item -filters
66 Show available libavfilter filters.
67
68 @item -pix_fmts
69 Show available pixel formats.
70
71 @item -loglevel @var{loglevel}
72 Set the logging level used by the library.
73 @var{loglevel} is a number or a string containing one of the following values:
74 @table @samp
75 @item quiet
76 @item panic
77 @item fatal
78 @item error
79 @item warning
80 @item info
81 @item verbose
82 @item debug
83 @end table
84
85 By default the program logs to stderr, if coloring is supported by the
86 terminal, colors are used to mark errors and warnings. Log coloring
87 can be disabled setting the environment variable
88 @env{FFMPEG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
89 the environment variable @env{FFMPEG_FORCE_COLOR}.
90 The use of the environment variable @env{NO_COLOR} is deprecated and
91 will be dropped in a following Libav version.
92
93 @end table
94
95 @section AVOptions
96
97 These options are provided directly by the libavformat, libavdevice and
98 libavcodec libraries. To see the list of available AVOptions, use the
99 @option{-help} option. They are separated into two categories:
100 @table @option
101 @item generic
102 These options can be set for any container, codec or device. Generic options are
103 listed under AVFormatContext options for containers/devices and under
104 AVCodecContext options for codecs.
105 @item private
106 These options are specific to the given container, device or codec. Private
107 options are listed under their corresponding containers/devices/codecs.
108 @end table
109
110 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
111 an MP3 file, use the @option{id3v2_version} private option of the MP3
112 muxer:
113 @example
114 ffmpeg -i input.flac -id3v2_version 3 out.mp3
115 @end example
116
117 Note -nooption syntax cannot be used for boolean AVOptions, use -option
118 0/-option 1.