[FFmpeg-devel] [PATCH] doc: add libvpx encoder section

[James Zern]

Documents the mapping from FFmpeg options to libvpx.
---
 doc/encoders.texi |  113 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 113 insertions(+), 0 deletions(-)

This might be a bit terse and I'm not sure about some of the
formatting in the table, so suggestions welcome.
-------------- next part --------------
diff --git a/doc/encoders.texi b/doc/encoders.texi
index f21f8ff..7913ffe 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -420,6 +420,119 @@ Selected by Encoder (default)
 A description of some of the currently available video encoders
 follows.
 
+ at section libvpx
+
+VP8 format supported through libvpx.
+
+Requires the presence of the libvpx headers and library during configuration.
+You need to explicitly configure the build with @code{--enable-libvpx}.
+
+ at subsection Options
+
+Mapping from FFmpeg to libvpx options with conversion notes in parentheses.
+
+ at table @option
+
+ at item threads
+g_threads
+
+ at item profile
+g_profile
+
+ at item vb
+rc_target_bitrate
+
+ at item g
+kf_max_dist
+
+ at item keyint_min
+kf_min_dist
+
+ at item qmin
+rc_min_quantizer
+
+ at item qmax
+rc_max_quantizer
+
+ at item bufsize, vb
+rc_buf_sz
+ at code{(bufsize * 1000 / vb)}
+
+rc_buf_optimal_sz
+ at code{(bufsize * 1000 / vb * 5 / 6)}
+
+ at item rc_init_occupancy, vb
+rc_buf_initial_sz
+ at code{(rc_init_occupancy * 1000 / vb)}
+
+ at item rc_buffer_aggressivity
+rc_undershoot_pct
+
+ at item skip_threshold
+rc_dropframe_thresh
+
+ at item qcomp
+rc_2pass_vbr_bias_pct
+
+ at item maxrate, vb
+rc_2pass_vbr_maxsection_pct
+ at code{(maxrate * 100 / vb)}
+
+ at item minrate, vb
+rc_2pass_vbr_minsection_pct
+ at code{(minrate * 100 / vb)}
+
+ at item minrate, maxrate, vb
+ at code{VPX_CBR}
+ at code{(minrate == maxrate == vb)}
+
+ at item crf
+ at code{VPX_CQ}, @code{VP8E_SET_CQ_LEVEL}
+
+ at item quality
+ at table @option
+ at item @var{best}
+ at code{VPX_DL_BEST_QUALITY}
+ at item @var{good}
+ at code{VPX_DL_GOOD_QUALITY}
+ at item @var{realtime}
+ at code{VPX_DL_REALTIME}
+ at end table
+
+ at item speed
+ at code{VP8E_SET_CPUUSED}
+
+ at item nr
+ at code{VP8E_SET_NOISE_SENSITIVITY}
+
+ at item mb_threshold
+ at code{VP8E_SET_STATIC_THRESHOLD}
+
+ at item slices
+ at code{VP8E_SET_TOKEN_PARTITIONS}
+
+ at item Alternate reference frame related
+ at table @option
+ at item vp8flags altref
+ at code{VP8E_SET_ENABLEAUTOALTREF}
+ at item @var{arnr_max_frames}
+ at code{VP8E_SET_ARNR_MAXFRAMES}
+ at item @var{arnr_type}
+ at code{VP8E_SET_ARNR_TYPE}
+ at item @var{arnr_strength}
+ at code{VP8E_SET_ARNR_STRENGTH}
+ at item @var{rc_lookahead}
+g_lag_in_frames
+ at end table
+
+ at item vp8flags error_resilient
+g_error_resilient
+
+ at end table
+
+For more information about libvpx see:
+ at url{http://www.webmproject.org/}
+
 @section libx264
 
 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 format supported through
-- 
1.7.3.1