X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=doc%2Ffftools-common-opts.texi;h=8ffc3299ce3b651de94f0c3df14fb23696fd5b54;hb=e3a70c7c5ff589ff6ce70fa0a29dc220f95dff17;hp=c362a170fb81e4c83f88ca493136ecce662f4cfd;hpb=3011ecdeb72af7e07f75e701061fb18f0745fd10;p=ffmpeg diff --git a/doc/fftools-common-opts.texi b/doc/fftools-common-opts.texi index c362a170fb8..8ffc3299ce3 100644 --- a/doc/fftools-common-opts.texi +++ b/doc/fftools-common-opts.texi @@ -87,5 +87,49 @@ terminal, colors are used to mark errors and warnings. Log coloring can be disabled setting the environment variable @env{FFMPEG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting the environment variable @env{FFMPEG_FORCE_COLOR}. +The use of the environment variable @env{NO_COLOR} is deprecated and +will be dropped in a following Libav version. @end table + +@section AVOptions + +These options are provided directly by the libavformat, libavdevice and +libavcodec libraries. To see the list of available AVOptions, use the +@option{-help} option. They are separated into two categories: +@table @option +@item generic +These options can be set for any container, codec or device. Generic options are +listed under AVFormatContext options for containers/devices and under +AVCodecContext options for codecs. +@item private +These options are specific to the given container, device or codec. Private +options are listed under their corresponding containers/devices/codecs. +@end table + +For example to write an ID3v2.3 header instead of a default ID3v2.4 to +an MP3 file, use the @option{id3v2_version} private option of the MP3 +muxer: +@example +ffmpeg -i input.flac -id3v2_version 3 out.mp3 +@end example + +You can precisely specify which stream(s) should the codec AVOption apply to by +appending a stream specifier of the form +@option{[:@var{stream_type}][:@var{stream_index}]} to the option name. +@var{stream_type} is 'v' for video, 'a' for audio and 's' for subtitle streams. +@var{stream_index} is a global stream index when @var{stream_type} isn't +given, otherwise it counts streams of the given type only. As always, the index +is zero-based. For example +@example +-foo -- applies to all applicable streams +-foo:v -- applies to all video streams +-foo:a:2 -- applies to the third audio stream +-foo:0 -- applies to the first stream +@end example + +Note -nooption syntax cannot be used for boolean AVOptions, use -option +0/-option 1. + +Note2 old undocumented way of specifying per-stream AVOptions by prepending +v/a/s to the options name is now obsolete and will be removed soon.