[FFmpeg-devel] [PATCH] doc/encoders: Add libtwolame doc

[Timothy Gu]

---
 doc/encoders.texi | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index a2c5eb0..acbdcd7 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -441,6 +441,85 @@ Enables the the encoder to use (on a frame by frame basis) either L/R
 stereo or mid/side stereo.
 @end multitable
 
+ at section libtwolame
+
+TwoLAME MP2 encoder wrapper
+
+Requires the presence of the libtwolame headers and library during
+configuration. You need to explicitly configure the build with
+ at code{--enable-libtwolame}.
+
+ at subsection Options Mapping
+
+The following public options are supported by the libtwolame
+wrapper. The FFmpeg options are in parantheses, while the TwoLAME
+options are under the FFmpeg options.
+
+ at table @option
+ at item b
+b
+
+FFmpeg @code{b} option is expressed in bits/s, twolame @code{bitrate} 
+in kilobits/s.
+
+ at item q
+V
+
+Quality setting for experimental VBR support. Maximum value range is 
+-50 to 50 but useful rage is -10 to 10.
+
+ at end table
+
+The following private options are supported by the libtwolame
+wrapper.
+
+ at table @option
+ at item mode
+mode
+
+MPEG mode. Available options:
+
+ at table @samp
+ at item auto
+Choose mode automatically based on the input
+ at item stereo
+Stereo
+ at item joint_stereo
+Joint stereo
+ at item dual_channel
+Dual channel
+ at item mono
+Mono
+ at end table
+
+ at item psymodel
+psyc-mode
+
+Psychoacoustic model. Valid argument: -1 to 4. The higher the
+value, the better the quality.
+
+ at item energy_levels
+energy
+
+Enable energy levels extensions.
+
+ at item error_protection
+protect
+
+Enable CRC error protection.
+
+ at item copyright
+copyright
+
+Set MPEG audio copyright flag.
+
+ at item original
+original
+
+Set MPEG audio original flag.
+
+ at end table
+
 @c man end AUDIO ENCODERS
 
 @chapter Video Encoders
-- 
1.8.1.2