[FFmpeg-cvslog] doc/encoders: sort list into alphabetical order

Lou Logan git at videolan.org
Fri Nov 11 01:49:16 EET 2016


ffmpeg | branch: master | Lou Logan <lou at lrcd.com> | Thu Nov 10 14:41:37 2016 -0900| [872b35890395878ca927e226965117482429fceb] | committer: Lou Logan

doc/encoders: sort list into alphabetical order

Signed-off-by: Lou Logan <lou at lrcd.com>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=872b35890395878ca927e226965117482429fceb
---

 doc/encoders.texi | 337 +++++++++++++++++++++++++++---------------------------
 1 file changed, 168 insertions(+), 169 deletions(-)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index c0597d8..cbb8d8e 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -870,6 +870,90 @@ default value is 0 (disabled).
 
 @end table
 
+ at section libopus
+
+libopus Opus Interactive Audio Codec encoder wrapper.
+
+Requires the presence of the libopus headers and library during
+configuration. You need to explicitly configure the build with
+ at code{--enable-libopus}.
+
+ at subsection Option Mapping
+
+Most libopus options are modelled after the @command{opusenc} utility from
+opus-tools. The following is an option mapping chart describing options
+supported by the libopus wrapper, and their @command{opusenc}-equivalent
+in parentheses.
+
+ at table @option
+
+ at item b (@emph{bitrate})
+Set the bit rate in bits/s.  FFmpeg's @option{b} option is
+expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
+kilobits/s.
+
+ at item vbr (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
+Set VBR mode. The FFmpeg @option{vbr} option has the following
+valid arguments, with the @command{opusenc} equivalent options
+in parentheses:
+
+ at table @samp
+ at item off (@emph{hard-cbr})
+Use constant bit rate encoding.
+
+ at item on (@emph{vbr})
+Use variable bit rate encoding (the default).
+
+ at item constrained (@emph{cvbr})
+Use constrained variable bit rate encoding.
+ at end table
+
+ at item compression_level (@emph{comp})
+Set encoding algorithm complexity. Valid options are integers in
+the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
+gives the highest quality but slowest encoding. The default is 10.
+
+ at item frame_duration (@emph{framesize})
+Set maximum frame size, or duration of a frame in milliseconds. The
+argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
+frame sizes achieve lower latency but less quality at a given bitrate.
+Sizes greater than 20ms are only interesting at fairly low bitrates.
+The default is 20ms.
+
+ at item packet_loss (@emph{expect-loss})
+Set expected packet loss percentage. The default is 0.
+
+ at item application (N.A.)
+Set intended application type. Valid options are listed below:
+
+ at table @samp
+ at item voip
+Favor improved speech intelligibility.
+ at item audio
+Favor faithfulness to the input (the default).
+ at item lowdelay
+Restrict to only the lowest delay modes.
+ at end table
+
+ at item cutoff (N.A.)
+Set cutoff bandwidth in Hz. The argument must be exactly one of the
+following: 4000, 6000, 8000, 12000, or 20000, corresponding to
+narrowband, mediumband, wideband, super wideband, and fullband
+respectively. The default is 0 (cutoff disabled).
+
+ at item mapping_family (@emph{mapping_family})
+Set channel mapping family to be used by the encoder. The default value of -1
+uses mapping family 0 for mono and stereo inputs, and mapping family 1
+otherwise. The default also disables the surround masking and LFE bandwidth
+optimzations in libopus, and requires that the input contains 8 channels or
+fewer.
+
+Other values include 0 for mono and stereo, 1 for surround sound with masking
+and LFE bandwidth optimizations, and 255 for independent streams with an
+unspecified channel layout.
+
+ at end table
+
 @anchor{libshine}
 @section libshine
 
@@ -1009,90 +1093,6 @@ default value is 0 (disabled).
 
 @end table
 
- at section libopus
-
-libopus Opus Interactive Audio Codec encoder wrapper.
-
-Requires the presence of the libopus headers and library during
-configuration. You need to explicitly configure the build with
- at code{--enable-libopus}.
-
- at subsection Option Mapping
-
-Most libopus options are modelled after the @command{opusenc} utility from
-opus-tools. The following is an option mapping chart describing options
-supported by the libopus wrapper, and their @command{opusenc}-equivalent
-in parentheses.
-
- at table @option
-
- at item b (@emph{bitrate})
-Set the bit rate in bits/s.  FFmpeg's @option{b} option is
-expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
-kilobits/s.
-
- at item vbr (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
-Set VBR mode. The FFmpeg @option{vbr} option has the following
-valid arguments, with the @command{opusenc} equivalent options
-in parentheses:
-
- at table @samp
- at item off (@emph{hard-cbr})
-Use constant bit rate encoding.
-
- at item on (@emph{vbr})
-Use variable bit rate encoding (the default).
-
- at item constrained (@emph{cvbr})
-Use constrained variable bit rate encoding.
- at end table
-
- at item compression_level (@emph{comp})
-Set encoding algorithm complexity. Valid options are integers in
-the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
-gives the highest quality but slowest encoding. The default is 10.
-
- at item frame_duration (@emph{framesize})
-Set maximum frame size, or duration of a frame in milliseconds. The
-argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
-frame sizes achieve lower latency but less quality at a given bitrate.
-Sizes greater than 20ms are only interesting at fairly low bitrates.
-The default is 20ms.
-
- at item packet_loss (@emph{expect-loss})
-Set expected packet loss percentage. The default is 0.
-
- at item application (N.A.)
-Set intended application type. Valid options are listed below:
-
- at table @samp
- at item voip
-Favor improved speech intelligibility.
- at item audio
-Favor faithfulness to the input (the default).
- at item lowdelay
-Restrict to only the lowest delay modes.
- at end table
-
- at item cutoff (N.A.)
-Set cutoff bandwidth in Hz. The argument must be exactly one of the
-following: 4000, 6000, 8000, 12000, or 20000, corresponding to
-narrowband, mediumband, wideband, super wideband, and fullband
-respectively. The default is 0 (cutoff disabled).
-
- at item mapping_family (@emph{mapping_family})
-Set channel mapping family to be used by the encoder. The default value of -1
-uses mapping family 0 for mono and stereo inputs, and mapping family 1
-otherwise. The default also disables the surround masking and LFE bandwidth
-optimzations in libopus, and requires that the input contains 8 channels or
-fewer.
-
-Other values include 0 for mono and stereo, 1 for surround sound with masking
-and LFE bandwidth optimizations, and 255 for independent streams with an
-unspecified channel layout.
-
- at end table
-
 @section libvorbis
 
 libvorbis encoder wrapper.
@@ -1261,6 +1261,81 @@ disabled
 A description of some of the currently available video encoders
 follows.
 
+ at section Hap
+
+Vidvox Hap video encoder.
+
+ at subsection Options
+
+ at table @option
+ at item format @var{integer}
+Specifies the Hap format to encode.
+
+ at table @option
+ at item hap
+ at item hap_alpha
+ at item hap_q
+ at end table
+
+Default value is @option{hap}.
+
+ at item chunks @var{integer}
+Specifies the number of chunks to split frames into, between 1 and 64. This
+permits multithreaded decoding of large frames, potentially at the cost of
+data-rate. The encoder may modify this value to divide frames evenly.
+
+Default value is @var{1}.
+
+ at item compressor @var{integer}
+Specifies the second-stage compressor to use. If set to @option{none},
+ at option{chunks} will be limited to 1, as chunked uncompressed frames offer no
+benefit.
+
+ at table @option
+ at item none
+ at item snappy
+ at end table
+
+Default value is @option{snappy}.
+
+ at end table
+
+ at section jpeg2000
+
+The native jpeg 2000 encoder is lossy by default, the @code{-q:v}
+option can be used to set the encoding quality. Lossless encoding
+can be selected with @code{-pred 1}.
+
+ at subsection Options
+
+ at table @option
+ at item format
+Can be set to either @code{j2k} or @code{jp2} (the default) that
+makes it possible to store non-rgb pix_fmts.
+
+ at end table
+
+ at section libkvazaar
+
+Kvazaar H.265/HEVC encoder.
+
+Requires the presence of the libkvazaar headers and library during
+configuration. You need to explicitly configure the build with
+ at option{--enable-libkvazaar}.
+
+ at subsection Options
+
+ at table @option
+
+ at item b
+Set target video bitrate in bit/s and enable rate control.
+
+ at item kvazaar-params
+Set kvazaar parameters as a list of @var{name}=@var{value} pairs separated
+by commas (,). See kvazaar documentation for a list of options.
+
+ at end table
+
 @section libopenh264
 
 Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper.
@@ -1327,30 +1402,6 @@ Set maximum NAL size in bytes.
 Allow skipping frames to hit the target bitrate if set to 1.
 @end table
 
- at section jpeg2000
-
-The native jpeg 2000 encoder is lossy by default, the @code{-q:v}
-option can be used to set the encoding quality. Lossless encoding
-can be selected with @code{-pred 1}.
-
- at subsection Options
-
- at table @option
- at item format
-Can be set to either @code{j2k} or @code{jp2} (the default) that
-makes it possible to store non-rgb pix_fmts.
-
- at end table
-
- at section snow
-
- at subsection Options
-
- at table @option
- at item iterative_dia_size
-dia size for the iterative motion estimation
- at end table
-
 @section libtheora
 
 libtheora Theora encoder wrapper.
@@ -1584,7 +1635,6 @@ colorspaces:
 For more information about libvpx see:
 @url{http://www.webmproject.org/}
 
-
 @section libwebp
 
 libwebp WebP Image encoder wrapper
@@ -2327,27 +2377,6 @@ Setting a higher @option{bits_per_mb} limit will improve the speed.
 For the fastest encoding speed set the @option{qscale} parameter (4 is the
 recommended value) and do not set a size constraint.
 
- at section libkvazaar
-
-Kvazaar H.265/HEVC encoder.
-
-Requires the presence of the libkvazaar headers and library during
-configuration. You need to explicitly configure the build with
- at option{--enable-libkvazaar}.
-
- at subsection Options
-
- at table @option
-
- at item b
-Set target video bitrate in bit/s and enable rate control.
-
- at item kvazaar-params
-Set kvazaar parameters as a list of @var{name}=@var{value} pairs separated
-by commas (,). See kvazaar documentation for a list of options.
-
- at end table
-
 @section QSV encoders
 
 The family of Intel QuickSync Video encoders (MPEG-2, H.264 and HEVC)
@@ -2436,6 +2465,15 @@ encoder use CAVLC instead of CABAC.
 
 @end itemize
 
+ at section snow
+
+ at subsection Options
+
+ at table @option
+ at item iterative_dia_size
+dia size for the iterative motion estimation
+ at end table
+
 @section vc2
 
 SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at
@@ -2501,45 +2539,6 @@ Reduces detail but attempts to preserve color at extremely low bitrates.
 
 @end table
 
- at section Hap
-
-Vidvox Hap video encoder.
-
- at subsection Options
-
- at table @option
- at item format @var{integer}
-Specifies the Hap format to encode.
-
- at table @option
- at item hap
- at item hap_alpha
- at item hap_q
- at end table
-
-Default value is @option{hap}.
-
- at item chunks @var{integer}
-Specifies the number of chunks to split frames into, between 1 and 64. This
-permits multithreaded decoding of large frames, potentially at the cost of
-data-rate. The encoder may modify this value to divide frames evenly.
-
-Default value is @var{1}.
-
- at item compressor @var{integer}
-Specifies the second-stage compressor to use. If set to @option{none},
- at option{chunks} will be limited to 1, as chunked uncompressed frames offer no
-benefit.
-
- at table @option
- at item none
- at item snappy
- at end table
-
-Default value is @option{snappy}.
-
- at end table
-
 @c man end VIDEO ENCODERS
 
 @chapter Subtitles Encoders



More information about the ffmpeg-cvslog mailing list