avtools-common-opts.texi 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  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. Options which do not take arguments are boolean options, and set the
  9. corresponding value to true. They can be set to false by prefixing
  10. with "no" the option name, for example using "-nofoo" in the
  11. command line will set to false the boolean option with name "foo".
  12. @anchor{Stream specifiers}
  13. @section Stream specifiers
  14. Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
  15. are used to precisely specify which stream(s) does a given option belong to.
  16. A stream specifier is a string generally appended to the option name and
  17. separated from it by a colon. E.g. @code{-codec:a:1 ac3} option contains
  18. @code{a:1} stream specifier, which matches the second audio stream. Therefore it
  19. would select the ac3 codec for the second audio stream.
  20. A stream specifier can match several streams, the option is then applied to all
  21. of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio
  22. streams.
  23. An empty stream specifier matches all streams, for example @code{-codec copy}
  24. or @code{-codec: copy} would copy all the streams without reencoding.
  25. Possible forms of stream specifiers are:
  26. @table @option
  27. @item @var{stream_index}
  28. Matches the stream with this index. E.g. @code{-threads:1 4} would set the
  29. thread count for the second stream to 4.
  30. @item @var{stream_type}[:@var{stream_index}]
  31. @var{stream_type} is one of: 'v' for video, 'a' for audio, 's' for subtitle,
  32. 'd' for data and 't' for attachments. If @var{stream_index} is given, then
  33. matches stream number @var{stream_index} of this type. Otherwise matches all
  34. streams of this type.
  35. @item p:@var{program_id}[:@var{stream_index}]
  36. If @var{stream_index} is given, then matches stream number @var{stream_index} in
  37. program with id @var{program_id}. Otherwise matches all streams in this program.
  38. @item #@var{stream_id}
  39. Matches the stream by format-specific ID.
  40. @end table
  41. @section Generic options
  42. These options are shared amongst the av* tools.
  43. @table @option
  44. @item -L
  45. Show license.
  46. @item -h, -?, -help, --help [@var{arg}]
  47. Show help. An optional parameter may be specified to print help about a specific
  48. item.
  49. Possible values of @var{arg} are:
  50. @table @option
  51. @item decoder=@var{decoder_name}
  52. Print detailed information about the decoder named @var{decoder_name}. Use the
  53. @option{-decoders} option to get a list of all decoders.
  54. @item encoder=@var{encoder_name}
  55. Print detailed information about the encoder named @var{encoder_name}. Use the
  56. @option{-encoders} option to get a list of all encoders.
  57. @item demuxer=@var{demuxer_name}
  58. Print detailed information about the demuxer named @var{demuxer_name}. Use the
  59. @option{-formats} option to get a list of all demuxers and muxers.
  60. @item muxer=@var{muxer_name}
  61. Print detailed information about the muxer named @var{muxer_name}. Use the
  62. @option{-formats} option to get a list of all muxers and demuxers.
  63. @end table
  64. @item -version
  65. Show version.
  66. @item -formats
  67. Show available formats.
  68. The fields preceding the format names have the following meanings:
  69. @table @samp
  70. @item D
  71. Decoding available
  72. @item E
  73. Encoding available
  74. @end table
  75. @item -codecs
  76. Show all codecs known to libavcodec.
  77. Note that the term 'codec' is used throughout this documentation as a shortcut
  78. for what is more correctly called a media bitstream format.
  79. @item -decoders
  80. Show available decoders.
  81. @item -encoders
  82. Show all available encoders.
  83. @item -bsfs
  84. Show available bitstream filters.
  85. @item -protocols
  86. Show available protocols.
  87. @item -filters
  88. Show available libavfilter filters.
  89. @item -pix_fmts
  90. Show available pixel formats.
  91. @item -sample_fmts
  92. Show available sample formats.
  93. @item -layouts
  94. Show channel names and standard channel layouts.
  95. @item -loglevel @var{loglevel} | -v @var{loglevel}
  96. Set the logging level used by the library.
  97. @var{loglevel} is a number or a string containing one of the following values:
  98. @table @samp
  99. @item quiet
  100. @item panic
  101. @item fatal
  102. @item error
  103. @item warning
  104. @item info
  105. @item verbose
  106. @item debug
  107. @end table
  108. By default the program logs to stderr, if coloring is supported by the
  109. terminal, colors are used to mark errors and warnings. Log coloring
  110. can be disabled setting the environment variable
  111. @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
  112. the environment variable @env{AV_LOG_FORCE_COLOR}.
  113. The use of the environment variable @env{NO_COLOR} is deprecated and
  114. will be dropped in a following FFmpeg version.
  115. @item -report
  116. Dump full command line and console output to a file named
  117. @code{@var{program}-@var{YYYYMMDD}-@var{HHMMSS}.log} in the current
  118. directory.
  119. This file can be useful for bug reports.
  120. It also implies @code{-loglevel verbose}.
  121. Note: setting the environment variable @code{FFREPORT} to any value has the
  122. same effect.
  123. @item -cpuflags flags (@emph{global})
  124. Allows setting and clearing cpu flags. This option is intended
  125. for testing. Do not use it unless you know what you're doing.
  126. @example
  127. ffmpeg -cpuflags -sse+mmx ...
  128. ffmpeg -cpuflags mmx ...
  129. ffmpeg -cpuflags 0 ...
  130. @end example
  131. @end table
  132. @section AVOptions
  133. These options are provided directly by the libavformat, libavdevice and
  134. libavcodec libraries. To see the list of available AVOptions, use the
  135. @option{-help} option. They are separated into two categories:
  136. @table @option
  137. @item generic
  138. These options can be set for any container, codec or device. Generic options
  139. are listed under AVFormatContext options for containers/devices and under
  140. AVCodecContext options for codecs.
  141. @item private
  142. These options are specific to the given container, device or codec. Private
  143. options are listed under their corresponding containers/devices/codecs.
  144. @end table
  145. For example to write an ID3v2.3 header instead of a default ID3v2.4 to
  146. an MP3 file, use the @option{id3v2_version} private option of the MP3
  147. muxer:
  148. @example
  149. ffmpeg -i input.flac -id3v2_version 3 out.mp3
  150. @end example
  151. All codec AVOptions are obviously per-stream, so the chapter on stream
  152. specifiers applies to them
  153. Note @option{-nooption} syntax cannot be used for boolean AVOptions,
  154. use @option{-option 0}/@option{-option 1}.
  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.
  157. @include avoptions_codec.texi
  158. @include avoptions_format.texi