[FFmpeg-devel] [PATCH 2/3] doc/encoders: add wavpackenc doc

Timothy Gu timothygu99 at gmail.com
Sun Dec 1 00:39:56 CET 2013


Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 doc/encoders.texi | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 62 insertions(+), 1 deletion(-)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index cebce25..11f8738 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1144,6 +1144,7 @@ transient response is a higher bitrate.
 
 @end table
 
+ at anchor{libwavpack}
 @section libwavpack
 
 A wrapper providing WavPack encoding through libwavpack.
@@ -1151,7 +1152,7 @@ A wrapper providing WavPack encoding through libwavpack.
 Only lossless mode using 32-bit integer samples is supported currently.
 
 Note that a libavcodec-native encoder for the WavPack codec exists so users can
-encode audios with this codec without using this encoder.
+encode audios with this codec without using this encoder. See @ref{wavpack}.
 
 Requires the presence of the libwavpack headers and library during
 configuration. You need to explicitly configure the build with
@@ -1186,6 +1187,66 @@ Same as @samp{3}, but with extra processing enabled.
 @end table
 @end table
 
+ at anchor{wavpackenc}
+ at section wavpack
+
+WavPack lossless audio encoder.
+
+This is a libavcodec-native WavPack encoder. There is also an encoder based on
+libwavpack, but there is virtually no reason to use that encoder.
+
+See also @ref{libwavpack}.
+
+ at subsection Options
+
+The equivalent options for @command{wavpack} command line utility are listed in
+parentheses.
+
+ at subsubsection Shared options
+
+The following shared options are effective for this encoder. Only special notes
+about this particular encoder. For the general meaning of the options, see
+ at ref{codec-options,,the Codec Options chapter}.
+
+ at table @option
+ at item frame_size (@emph{--blocksize})
+For this encoder, the range for this option is between 128 and 131072. Default
+is automatically decided based on sample rate and number of channel.
+
+ at item compression_level (@emph{-f}, @emph{-h}, @emph{-hh}, and @emph{-x})
+This option's syntax is consistent as @ref{libwavpack}'s.
+ at end table
+
+ at subsubsection Private options
+
+The following options are private to this encoder:
+
+ at table @option
+ at item joint_stereo (@emph{-j})
+Set whether to enable joint stereo. Valid values are:
+
+ at table @samp
+ at item on (@emph{1})
+Force mid/side audio encoding.
+ at item off (@emph{0})
+Force left/right audio encoding.
+ at item auto
+Let the encoder decide automatically.
+ at end table
+
+ at item optimize_mono
+Set whether to enable optimization for mono. This option is only effective for
+non-mono streams. Available values:
+
+ at table @samp
+ at item on
+enabled
+ at item off
+disabled
+ at end table
+
+ at end table
+
 @c man end AUDIO ENCODERS
 
 @chapter Video Encoders
-- 
1.8.3.2



More information about the ffmpeg-devel mailing list