avtools-common-opts.texi 4.9 KB

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