doc/encoders: alphabetically list the encoders
authorTimothy Gu <timothygu99@gmail.com>
Fri, 28 Jun 2013 01:50:54 +0000 (18:50 -0700)
committerStefano Sabatini <stefasab@gmail.com>
Fri, 28 Jun 2013 11:07:15 +0000 (13:07 +0200)
Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
doc/encoders.texi

index 1a72346..7da6376 100644 (file)
@@ -441,6 +441,43 @@ Enables the encoder to use (on a frame by frame basis) either L/R
 stereo or mid/side stereo.
 @end multitable
 
+@section libopencore-amrnb
+
+OpenCORE Adaptive Multi-Rate Narrowband encoder.
+
+Requires the presence of the libopencore-amrnb headers and library during
+configuration. You need to explicitly configure the build with
+@code{--enable-libopencore-amrnb --enable-version3}.
+
+This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
+but you can override it by setting @option{strict} to @samp{unofficial} or
+lower.
+
+@subsection Options
+
+@table @option
+
+@item b
+Set bitrate in bits per second. Only the following bitrates are supported,
+otherwise libavcodec will round to the nearest valid bitrate.
+
+@table @option
+@item 4750
+@item 5150
+@item 5900
+@item 6700
+@item 7400
+@item 7950
+@item 10200
+@item 12200
+@end table
+
+@item dtx
+Allow discontinuous transmission (generate comfort noise) when set to 1. The
+default value is 0 (disabled).
+
+@end table
+
 @section libtwolame
 
 TwoLAME MP2 encoder wrapper.
@@ -525,35 +562,6 @@ Bitrate.
 
 @end table
 
-@section libwavpack
-
-A wrapper providing WavPack encoding through libwavpack.
-
-Only lossless mode using 32-bit integer samples is supported currently.
-The @option{compression_level} option can be used to control speed vs.
-compression tradeoff, with the values mapped to libwavpack as follows:
-
-@table @option
-
-@item 0
-Fast mode - corresponding to the wavpack @option{-f} option.
-
-@item 1
-Normal (default) settings.
-
-@item 2
-High quality - corresponding to the wavpack @option{-h} option.
-
-@item 3
-Very high quality - corresponding to the wavpack @option{-hh} option.
-
-@item 4-8
-Same as 3, but with extra processing enabled - corresponding to the wavpack
-@option{-x} option. I.e. 4 is the same as @option{-x2} and 8 is the same as
-@option{-x6}.
-
-@end table
-
 @section libvo-amrwbenc
 
 VisualOn Adaptive Multi-Rate Wideband encoder.
@@ -592,40 +600,32 @@ default value is 0 (disabled).
 
 @end table
 
-@section libopencore-amrnb
+@section libwavpack
 
-OpenCORE Adaptive Multi-Rate Narrowband encoder.
+A wrapper providing WavPack encoding through libwavpack.
 
-Requires the presence of the libopencore-amrnb headers and library during
-configuration. You need to explicitly configure the build with
-@code{--enable-libopencore-amrnb --enable-version3}.
+Only lossless mode using 32-bit integer samples is supported currently.
+The @option{compression_level} option can be used to control speed vs.
+compression tradeoff, with the values mapped to libwavpack as follows:
 
-This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
-but you can override it by setting @option{strict} to @samp{unofficial} or
-lower.
+@table @option
 
-@subsection Options
+@item 0
+Fast mode - corresponding to the wavpack @option{-f} option.
 
-@table @option
+@item 1
+Normal (default) settings.
 
-@item b
-Set bitrate in bits per second. Only the following bitrates are supported,
-otherwise libavcodec will round to the nearest valid bitrate.
+@item 2
+High quality - corresponding to the wavpack @option{-h} option.
 
-@table @option
-@item 4750
-@item 5150
-@item 5900
-@item 6700
-@item 7400
-@item 7950
-@item 10200
-@item 12200
-@end table
+@item 3
+Very high quality - corresponding to the wavpack @option{-hh} option.
 
-@item dtx
-Allow discontinuous transmission (generate comfort noise) when set to 1. The
-default value is 0 (disabled).
+@item 4-8
+Same as 3, but with extra processing enabled - corresponding to the wavpack
+@option{-x} option. I.e. 4 is the same as @option{-x2} and 8 is the same as
+@option{-x6}.
 
 @end table