[FFmpeg-devel] [PATCH V3 2/2] doc: Add libsvt_hevc encoder docs

[Gyan Doshi]

You'll need to rebase as I just rearranged entries (and style, a bit) in 
doc/general

On 07-12-2018 05:26 PM, Jun Zhao wrote:
> Signed-off-by: Jun Zhao <jun.zhao at intel.com>
> Signed-off-by: Huang, Zhengxu <zhengxu.huang at intel.com>
> Signed-off-by: hassene <hassene.tmar at intel.com>
> ---
>   doc/encoders.texi |   98 +++++++++++++++++++++++++++++++++++++++++++++++++++++
>   doc/general.texi  |    8 ++++
>   2 files changed, 106 insertions(+), 0 deletions(-)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 4db7764..33efbef 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1566,6 +1566,104 @@ Set maximum NAL size in bytes.
>   Allow skipping frames to hit the target bitrate if set to 1.
>   @end table
>   
> + at section libsvt_hevc

> +Intel Scalable Video Technology HEVC encoder wrapper.
> +
> +This encoder requires the presence of the headers and
> +library during configuration. You need to explicitly configure the
> +build with @code{--enable-libsvt}. The library is detected using
> + at command{pkg-config}.
> +
> +For more information about the library see
> + at url{https://github.com/intel/SVT-HEVC.git}.
> +
> + at subsection Options
> +
> +The following FFmpeg global options affect the configurations of the
> +libsvt_hevc encoder.


All of the below appear to be private options declared in the wrapper.


> +
> + at table @option
> + at item vui
> +Enables or disables the vui structure in the HEVC elementary
> +bitstream. 0 = Off, 1 = On
> +
> + at item hielevel
> +Set hierarchical levels. Can assume one of the following possible values:
> +
> + at table @samp
> + at item flat
> +none hierarchy level
> + at item 2level
> +2-level hierarchy
> + at item 3level
> +3-level hierarchy
> + at item 4level
> +4-level hierarchy
> + at end table
> +
> + at item la_depth
> +Set look-ahead depth, depending on bit rate control mode @option{rc}, When
> +bit rate control mode is set to vbr it's best to set this parameter to be
> +equal to the Intra period value (such is the default set by the encoder),
> +when cqp is chosen, then a look ahead is recommended.
> +
> + at item intra_ref_type
> +Set intra refesh type. Can assume one of the following possible values:
> +
> + at table @samp
> + at item cra
> +open group of pictures
> + at item idr
> +closed group of pictures
> + at end table
> +
> + at item preset
> +A preset defining the quality vs density tradeoff point that the
> +encoding is to be performed at.(e.g. 0 is the highest quality mode,
> +12 is the highest density mode).
> +
> + at item profile (@emph{profile})
> +Set profile restrictions. Can assume one of the following possible values:
> +
> + at table @samp
> + at item main
> +main profile
> + at item main10
> +main10 profile
> + at end table
> +
> + at item rc
> +Set bit rate control mode. Can assume one of the following possible values:
> +
> + at table @samp
> + at item cqp
> +cqp mode
> + at item vbr
> +vbr mode
> + at end table
> +
> + at item qp
> +Initial quantization parameter for the intra pictures used when
> + at option{rc} is cqp mode.
> +
> + at item sc_detection
> +Enables or disables the scene change detection algorithm.
> +
> + at item tune
> +Set quality mode. Can assume one of the following possible values:
> +
> + at table @samp
> + at item sq
> +subjective quality mode
> + at item oq
> +objective quality mode
> + at end table
> +
> + at item bl_mode
> +Enables or disables Random Access Prediction.
> + at end table
> +
>   @section libtheora
>   
>   libtheora Theora encoder wrapper.
> diff --git a/doc/general.texi b/doc/general.texi
> index d883240..a071bfd 100644
> --- a/doc/general.texi
> +++ b/doc/general.texi
> @@ -196,6 +196,14 @@ constrained baseline profile and CABAC.) Using it is mostly useful for
>   testing and for taking advantage of Cisco's patent portfolio license
>   (@url{http://www.openh264.org/BINARY_LICENSE.txt}).
>   
> + at section SVT-HEVC


SVT-HEVC --> Intel SVT-HEVC


> +
> +FFmpeg can make use of the SVT-HEVC library for HEVC encoding.
> +
> +Go to @url{https://github.com/intel/SVT-HEVC.git} and follow the instructions
> +for installing the library. Then pass @code{--enable-libsvt} to configure to
> +enable it.
> +
>   @section x264
>   
>   FFmpeg can make use of the x264 library for H.264 encoding.


Gyan