git.sesse.net Git - ffmpeg/blob - 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 specifier, 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 streams, 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 @item #@var{stream_id}
  45 Matches the stream by format-specific ID.
  46 @end table
  47
  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
  58 Show help.
  59
  60 @item -version
  61 Show version.
  62
  63 @item -formats
  64 Show available formats.
  65
  66 The fields preceding the format names have the following meanings:
  67 @table @samp
  68 @item D
  69 Decoding available
  70 @item E
  71 Encoding available
  72 @end table
  73
  74 @item -codecs
  75 Show available codecs.
  76
  77 The fields preceding the codec names have the following meanings:
  78 @table @samp
  79 @item D
  80 Decoding available
  81 @item E
  82 Encoding available
  83 @item V/A/S
  84 Video/audio/subtitle codec
  85 @item S
  86 Codec supports slices
  87 @item D
  88 Codec supports direct rendering
  89 @item T
  90 Codec can handle input truncated at random locations instead of only at frame boundaries
  91 @end table
  92
  93 @item -bsfs
  94 Show available bitstream filters.
  95
  96 @item -protocols
  97 Show available protocols.
  98
  99 @item -filters
 100 Show available libavfilter filters.
 101
 102 @item -pix_fmts
 103 Show available pixel formats.
 104
 105 @item -sample_fmts
 106 Show available sample formats.
 107
 108 @item -loglevel @var{loglevel} | -v @var{loglevel}
 109 Set the logging level used by the library.
 110 @var{loglevel} is a number or a string containing one of the following values:
 111 @table @samp
 112 @item quiet
 113 @item panic
 114 @item fatal
 115 @item error
 116 @item warning
 117 @item info
 118 @item verbose
 119 @item debug
 120 @end table
 121
 122 By default the program logs to stderr, if coloring is supported by the
 123 terminal, colors are used to mark errors and warnings. Log coloring
 124 can be disabled setting the environment variable
 125 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
 126 the environment variable @env{AV_LOG_FORCE_COLOR}.
 127 The use of the environment variable @env{NO_COLOR} is deprecated and
 128 will be dropped in a following FFmpeg version.
 129
 130 @item -report
 131 Dump full command line and console output to a file named
 132 @code{@var{program}-@var{YYYYMMDD}-@var{HHMMSS}.log} in the current
 133 directory.
 134 This file can be useful for bug reports.
 135 It also implies @code{-loglevel verbose}.
 136
 137 Note: setting the environment variable @code{FFREPORT} to any value has the
 138 same effect.
 139
 140 @item -cpuflags flags (@emph{global})
 141 Allows setting and clearing cpu flags. This option is intended
 142 for testing. Do not use it unless you know what you're doing.
 143 @example
 144 ffmpeg -cpuflags -sse+mmx ...
 145 ffmpeg -cpuflags mmx ...
 146 ffmpeg -cpuflags 0 ...
 147 @end example
 148
 149 @end table
 150
 151 @section AVOptions
 152
 153 These options are provided directly by the libavformat, libavdevice and
 154 libavcodec libraries. To see the list of available AVOptions, use the
 155 @option{-help} option. They are separated into two categories:
 156 @table @option
 157 @item generic
 158 These options can be set for any container, codec or device. Generic options
 159 are listed under AVFormatContext options for containers/devices and under
 160 AVCodecContext options for codecs.
 161 @item private
 162 These options are specific to the given container, device or codec. Private
 163 options are listed under their corresponding containers/devices/codecs.
 164 @end table
 165
 166 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
 167 an MP3 file, use the @option{id3v2_version} private option of the MP3
 168 muxer:
 169 @example
 170 ffmpeg -i input.flac -id3v2_version 3 out.mp3
 171 @end example
 172
 173 All codec AVOptions are obviously per-stream, so the chapter on stream
 174 specifiers applies to them
 175
 176 Note @option{-nooption} syntax cannot be used for boolean AVOptions,
 177 use @option{-option 0}/@option{-option 1}.
 178
 179 Note2 old undocumented way of specifying per-stream AVOptions by prepending
 180 v/a/s to the options name is now obsolete and will be removed soon.
 181
 182 @include avoptions_codec.texi
 183 @include avoptions_format.texi