[FFmpeg-cvslog] doc/encoders: document the QSV option mappings

[Anton Khirnov]

ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Sun Nov  8 15:24:42 2015 +0100| [8a9de5c52401aa1e87bdb147524831c640d1ec53] | committer: Anton Khirnov

doc/encoders: document the QSV option mappings

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

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

diff --git a/doc/encoders.texi b/doc/encoders.texi
index 3b6f7df..315c901 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -834,4 +834,92 @@ by commas (,). See kvazaar documentation for a list of options.
 
 @end table
 
+ at section QSV encoders
+
+The family of Intel QuickSync Video encoders (MPEG-2, H.264 and HEVC)
+
+The ratecontrol method is selected as follows:
+
+ at itemize @bullet
+ at item
+When @option{global_quality} is specified, a quality-based mode is used.
+Specifically this means either
+ at itemize @minus
+ at item
+ at var{CQP} - constant quantizer scale, when the @option{qscale} codec flag is
+also set (the @option{-qscale} avconv option).
+
+ at item
+ at var{LA_ICQ} - intelligent constant quality with lookahead, when the
+ at option{la_depth} option is also set.
+
+ at item
+ at var{ICQ} -- intelligent constant quality otherwise.
+ at end itemize
+
+ at item
+Otherwise, a bitrate-based mode is used. For all of those, you should specify at
+least the desired average bitrate with the @option{b} option.
+ at itemize @minus
+ at item
+ at var{LA} - VBR with lookahead, when the @option{la_depth} option is specified.
+
+ at item
+ at var{VCM} - video conferencing mode, when the @option{vcm} option is set.
+
+ at item
+ at var{CBR} - constant bitrate, when @option{maxrate} is specified and equal to
+the average bitrate.
+
+ at item
+ at var{VBR} - variable bitrate, when @option{maxrate} is specified, but is higher
+than the average bitrate.
+
+ at item
+ at var{AVBR} - average VBR mode, when @option{maxrate} is not specified. This mode
+is further configured by the @option{avbr_accuracy} and
+ at option{avbr_convergence} options.
+ at end itemize
+ at end itemize
+
+Note that depending on your system, a different mode than the one you specified
+may be selected by the encoder. Set the verbosity level to @var{verbose} or
+higher to see the actual settings used by the QSV runtime.
+
+Additional libavcodec global options are mapped to MSDK options as follows:
+
+ at itemize
+ at item
+ at option{g/gop_size} -> @option{GopPicSize}
+
+ at item
+ at option{bf/max_b_frames}+1 -> @option{GopRefDist}
+
+ at item
+ at option{rc_init_occupancy/rc_initial_buffer_occupancy} ->
+ at option{InitialDelayInKB}
+
+ at item
+ at option{slices} -> @option{NumSlice}
+
+ at item
+ at option{refs} -> @option{NumRefFrame}
+
+ at item
+ at option{b_strategy/b_frame_strategy} -> @option{BRefType}
+
+ at item
+ at option{cgop/CLOSED_GOP} codec flag -> @option{GopOptFlag}
+
+ at item
+For the @var{CQP} mode, the @option{i_qfactor/i_qoffset} and
+ at option{b_qfactor/b_qoffset} set the difference between @var{QPP} and @var{QPI},
+and @var{QPP} and @var{QPB} respectively.
+
+ at item
+Setting the @option{coder} option to the value @var{vlc} will make the H.264
+encoder use CAVLC instead of CABAC.
+
+ at end itemize
+
 @c man end VIDEO ENCODERS