avtools-common-opts.texi 5.0 KB

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