[FFmpeg-cvslog] doc/encoders: reformat libwavpack documentation

Timothy Gu git at videolan.org
Sun Dec 29 13:12:12 CET 2013

ffmpeg | branch: master | Timothy Gu <timothygu99 at gmail.com> | Tue Dec 17 21:11:06 2013 -0800| [eb38e684b4d53a7ee7c5d9176fc6cdf16d0d44e7] | committer: Stefano Sabatini

doc/encoders: reformat libwavpack documentation

Signed-off-by: Timothy Gu <timothygu99 at gmail.com>

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

 doc/encoders.texi |   41 +++++++++++++++++++++++++++++------------
 1 file changed, 29 insertions(+), 12 deletions(-)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index ea5b3e4..31af6d4 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1149,29 +1149,46 @@ transient response is a higher bitrate.
 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:
+Requires the presence of the libwavpack headers and library during
+configuration. You need to explicitly configure the build with
+ at code{--enable-libwavpack}.
+Note that a libavcodec-native encoder for the WavPack codec exists so users can
+encode audios with this codec without using this encoder.
+ at subsection Options
+ at command{wavpack} command line utility's corresponding options are listed in
+parentheses, if any.
 @table @option
+ at item frame_size (@emph{--blocksize})
+Default is 32768.
- at item 0
-Fast mode - corresponding to the wavpack @option{-f} option.
+ at item compression_level
+Set speed vs. compression tradeoff. Acceptable arguments are listed below:
+ at table @samp
+ at item 0 (@emph{-f})
+Fast mode.
 @item 1
 Normal (default) settings.
- at item 2
-High quality - corresponding to the wavpack @option{-h} option.
+ at item 2 (@emph{-h})
+High quality.
- at item 3
-Very high quality - corresponding to the wavpack @option{-hh} option.
+ at item 3 (@emph{-hh})
+Very high quality.
+ at item 4-8 (@emph{-hh -x}@var{EXTRAPROC})
+Same as @samp{3}, but with extra processing enabled.
- at item 4-8
-Same as 3, but with extra processing enabled - corresponding to the wavpack
- at option{-x} option. I.e. 4 is the same as @option{-x2} and 8 is the same as
- at option{-x6}.
+ at samp{4} is the same as @option{-x2} and @samp{8} is the same as @option{-x6}.
 @end table
+ at end table
 @c man end AUDIO ENCODERS

More information about the ffmpeg-cvslog mailing list