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 commandline will set to false the boolean option with name "foo".
  13
  14 @section Stream specifiers
  15 Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
  16 are used to precisely specify which stream(s) does a given option belong to.
  17
  18 A stream specifier is a string generally appended to the option name and
  19 separated from it by a colon. E.g. @code{-codec:a:1 ac3} option contains
  20 @code{a:1} stream specifer, which matches the second audio stream. Therefore it
  21 would select the ac3 codec for the second audio stream.
  22
  23 A stream specifier can match several stream, the option is then applied to all
  24 of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio
  25 streams.
  26
  27 An empty stream specifier matches all streams, for example @code{-codec copy}
  28 or @code{-codec: copy} would copy all the streams without reencoding.
  29
  30 Possible forms of stream specifiers are:
  31 @table @option
  32 @item @var{stream_index}
  33 Matches the stream with this index. E.g. @code{-threads:1 4} would set the
  34 thread count for the second stream to 4.
  35 @item @var{stream_type}[:@var{stream_index}]
  36 @var{stream_type} is one of: 'v' for video, 'a' for audio, 's' for subtitle and
  37 'd' for data. If @var{stream_index} is given, then matches stream number
  38 @var{stream_index} of this type. Otherwise matches all streams of this type.
  39 @item @var{program_id}[:@var{stream_index}]
  40 If @var{stream_index} is given, then matches stream number @var{stream_index} in
  41 program with id @var{program_id}. Otherwise matches all streams in this program.
  42 @end table
  43 @section Generic options
  44
  45 These options are shared amongst the av* tools.
  46
  47 @table @option
  48
  49 @item -L
  50 Show license.
  51
  52 @item -h, -?, -help, --help
  53 Show help.
  54
  55 @item -version
  56 Show version.
  57
  58 @item -formats
  59 Show available formats.
  60
  61 The fields preceding the format names have the following meanings:
  62 @table @samp
  63 @item D
  64 Decoding available
  65 @item E
  66 Encoding available
  67 @end table
  68
  69 @item -codecs
  70 Show available codecs.
  71
  72 The fields preceding the codec names have the following meanings:
  73 @table @samp
  74 @item D
  75 Decoding available
  76 @item E
  77 Encoding available
  78 @item V/A/S
  79 Video/audio/subtitle codec
  80 @item S
  81 Codec supports slices
  82 @item D
  83 Codec supports direct rendering
  84 @item T
  85 Codec can handle input truncated at random locations instead of only at frame boundaries
  86 @end table
  87
  88 @item -bsfs
  89 Show available bitstream filters.
  90
  91 @item -protocols
  92 Show available protocols.
  93
  94 @item -filters
  95 Show available libavfilter filters.
  96
  97 @item -pix_fmts
  98 Show available pixel formats.
  99
 100 @item -sample_fmts
 101 Show available sample formats.
 102
 103 @item -loglevel @var{loglevel}
 104 Set the logging level used by the library.
 105 @var{loglevel} is a number or a string containing one of the following values:
 106 @table @samp
 107 @item quiet
 108 @item panic
 109 @item fatal
 110 @item error
 111 @item warning
 112 @item info
 113 @item verbose
 114 @item debug
 115 @end table
 116
 117 By default the program logs to stderr, if coloring is supported by the
 118 terminal, colors are used to mark errors and warnings. Log coloring
 119 can be disabled setting the environment variable
 120 @env{FFMPEG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
 121 the environment variable @env{FFMPEG_FORCE_COLOR}.
 122 The use of the environment variable @env{NO_COLOR} is deprecated and
 123 will be dropped in a following FFmpeg version.
 124
 125 @end table
 126
 127 @section AVOptions
 128
 129 These options are provided directly by the libavformat, libavdevice and
 130 libavcodec libraries. To see the list of available AVOptions, use the
 131 @option{-help} option. They are separated into two categories:
 132 @table @option
 133 @item generic
 134 These options can be set for any container, codec or device. Generic options are
 135 listed under AVFormatContext options for containers/devices and under
 136 AVCodecContext options for codecs.
 137 @item private
 138 These options are specific to the given container, device or codec. Private
 139 options are listed under their corresponding containers/devices/codecs.
 140 @end table
 141
 142 For example to write an ID3v2.3 header instead of a default ID3v2.4 to
 143 an MP3 file, use the @option{id3v2_version} private option of the MP3
 144 muxer:
 145 @example
 146 ffmpeg -i input.flac -id3v2_version 3 out.mp3
 147 @end example
 148
 149 All codec AVOptions are obviously per-stream, so the chapter on stream
 150 specifiers applies to them
 151
 152 Note -nooption syntax cannot be used for boolean AVOptions, use -option
 153 0/-option 1.
 154
 155 Note2 old undocumented way of specifying per-stream AVOptions by prepending
 156 v/a/s to the options name is now obsolete and will be removed soon.