diff options
Diffstat (limited to 'doc/avtools-common-opts.texi')
| -rw-r--r-- | doc/avtools-common-opts.texi | 164 |
1 files changed, 129 insertions, 35 deletions
diff --git a/doc/avtools-common-opts.texi b/doc/avtools-common-opts.texi index afd2cc3876..4b52b58637 100644 --- a/doc/avtools-common-opts.texi +++ b/doc/avtools-common-opts.texi @@ -1,32 +1,33 @@ -All the numerical options, if not specified otherwise, accept in input -a string representing a number, which may contain one of the -SI unit prefixes, for example 'K', 'M', 'G'. -If 'i' is appended after the prefix, binary prefixes are used, -which are based on powers of 1024 instead of powers of 1000. -The 'B' postfix multiplies the value by 8, and can be -appended after a unit prefix or used alone. This allows using for -example 'KB', 'MiB', 'G' and 'B' as number postfix. +All the numerical options, if not specified otherwise, accept a string +representing a number as input, which may be followed by one of the SI +unit prefixes, for example: 'K', 'M', or 'G'. + +If 'i' is appended to the SI unit prefix, the complete prefix will be +interpreted as a unit prefix for binary multiplies, which are based on +powers of 1024 instead of powers of 1000. Appending 'B' to the SI unit +prefix multiplies the value by 8. This allows using, for example: +'KB', 'MiB', 'G' and 'B' as number suffixes. Options which do not take arguments are boolean options, and set the corresponding value to true. They can be set to false by prefixing -with "no" the option name, for example using "-nofoo" in the -command line will set to false the boolean option with name "foo". +the option name with "no". For example using "-nofoo" +will set the boolean option with name "foo" to false. @anchor{Stream specifiers} @section Stream specifiers Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers -are used to precisely specify which stream(s) does a given option belong to. +are used to precisely specify which stream(s) a given option belongs to. A stream specifier is a string generally appended to the option name and -separated from it by a colon. E.g. @code{-codec:a:1 ac3} option contains -@code{a:1} stream specifer, which matches the second audio stream. Therefore it +separated from it by a colon. E.g. @code{-codec:a:1 ac3} contains the +@code{a:1} stream specifier, which matches the second audio stream. Therefore, it would select the ac3 codec for the second audio stream. -A stream specifier can match several stream, the option is then applied to all +A stream specifier can match several streams, so that the option is applied to all of them. E.g. the stream specifier in @code{-b:a 128k} matches all audio streams. -An empty stream specifier matches all streams, for example @code{-codec copy} +An empty stream specifier matches all streams. For example, @code{-codec copy} or @code{-codec: copy} would copy all the streams without reencoding. Possible forms of stream specifiers are: @@ -35,17 +36,21 @@ Possible forms of stream specifiers are: Matches the stream with this index. E.g. @code{-threads:1 4} would set the thread count for the second stream to 4. @item @var{stream_type}[:@var{stream_index}] -@var{stream_type} is one of: 'v' for video, 'a' for audio, 's' for subtitle, -'d' for data and 't' for attachments. If @var{stream_index} is given, then -matches stream number @var{stream_index} of this type. Otherwise matches all +@var{stream_type} is one of following: 'v' for video, 'a' for audio, 's' for subtitle, +'d' for data, and 't' for attachments. If @var{stream_index} is given, then it matches +stream number @var{stream_index} of this type. Otherwise, it matches all streams of this type. @item p:@var{program_id}[:@var{stream_index}] -If @var{stream_index} is given, then matches stream number @var{stream_index} in -program with id @var{program_id}. Otherwise matches all streams in this program. +If @var{stream_index} is given, then it matches the stream with number @var{stream_index} +in the program with the id @var{program_id}. Otherwise, it matches all streams in the +program. +@item #@var{stream_id} +Matches the stream by a format-specific ID. @end table + @section Generic options -These options are shared amongst the av* tools. +These options are shared amongst the ff* tools. @table @option @@ -82,14 +87,6 @@ Show version. @item -formats Show available formats. -The fields preceding the format names have the following meanings: -@table @samp -@item D -Decoding available -@item E -Encoding available -@end table - @item -codecs Show all codecs known to libavcodec. @@ -117,18 +114,39 @@ Show available pixel formats. @item -sample_fmts Show available sample formats. -@item -loglevel @var{loglevel} | -v @var{loglevel} +@item -layouts +Show channel names and standard channel layouts. + +@item -loglevel [repeat+]@var{loglevel} | -v [repeat+]@var{loglevel} Set the logging level used by the library. +Adding "repeat+" indicates that repeated log output should not be compressed +to the first line and the "Last message repeated n times" line will be +omitted. "repeat" can also be used alone. +If "repeat" is used alone, and with no prior loglevel set, the default +loglevel will be used. If multiple loglevel parameters are given, using +'repeat' will not change the loglevel. @var{loglevel} is a number or a string containing one of the following values: @table @samp @item quiet +Show nothing at all; be silent. @item panic +Only show fatal errors which could lead the process to crash, such as +and assert failure. This is not currently used for anything. @item fatal +Only show fatal errors. These are errors after which the process absolutely +cannot continue after. @item error +Show all errors, including ones which can be recovered from. @item warning +Show all warnings and errors. Any message related to possibly +incorrect or unexpected events will be shown. @item info +Show informative messages during processing. This is in addition to +warnings and errors. This is the default value. @item verbose +Same as @code{info}, except more verbose. @item debug +Show everything, including debugging information. @end table By default the program logs to stderr, if coloring is supported by the @@ -137,7 +155,86 @@ can be disabled setting the environment variable @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting the environment variable @env{AV_LOG_FORCE_COLOR}. The use of the environment variable @env{NO_COLOR} is deprecated and -will be dropped in a following Libav version. +will be dropped in a following FFmpeg version. + +@item -report +Dump full command line and console output to a file named +@code{@var{program}-@var{YYYYMMDD}-@var{HHMMSS}.log} in the current +directory. +This file can be useful for bug reports. +It also implies @code{-loglevel verbose}. + +Setting the environment variable @code{FFREPORT} to any value has the +same effect. If the value is a ':'-separated key=value sequence, these +options will affect the report; options values must be escaped if they +contain special characters or the options delimiter ':' (see the +``Quoting and escaping'' section in the ffmpeg-utils manual). The +following option is recognized: +@table @option +@item file +set the file name to use for the report; @code{%p} is expanded to the name +of the program, @code{%t} is expanded to a timestamp, @code{%%} is expanded +to a plain @code{%} +@end table + +Errors in parsing the environment variable are not fatal, and will not +appear in the report. + +@item -cpuflags flags (@emph{global}) +Allows setting and clearing cpu flags. This option is intended +for testing. Do not use it unless you know what you're doing. +@example +ffmpeg -cpuflags -sse+mmx ... +ffmpeg -cpuflags mmx ... +ffmpeg -cpuflags 0 ... +@end example +Possible flags for this option are: +@table @samp +@item x86 +@table @samp +@item mmx +@item mmxext +@item sse +@item sse2 +@item sse2slow +@item sse3 +@item sse3slow +@item ssse3 +@item atom +@item sse4.1 +@item sse4.2 +@item avx +@item xop +@item fma4 +@item 3dnow +@item 3dnowext +@item cmov +@end table +@item ARM +@table @samp +@item armv5te +@item armv6 +@item armv6t2 +@item vfp +@item vfpv3 +@item neon +@end table +@item PowerPC +@table @samp +@item altivec +@end table +@item Specific Processors +@table @samp +@item pentium2 +@item pentium3 +@item pentium4 +@item k6 +@item k62 +@item athlon +@item athlonxp +@item k8 +@end table +@end table @end table @@ -160,7 +257,7 @@ 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 -avconv -i input.flac -id3v2_version 3 out.mp3 +ffmpeg -i input.flac -id3v2_version 3 out.mp3 @end example All codec AVOptions are obviously per-stream, so the chapter on stream @@ -171,6 +268,3 @@ use @option{-option 0}/@option{-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. - -@include avoptions_codec.texi -@include avoptions_format.texi |