[FFmpeg-devel] [V3 3/4] doc/codecs: document the -hwaccel_flags option.

[Mark Thompson]

On 09/10/17 08:50, Jun Zhao wrote:
> 
> From 2c5609811a1bad27fed802c674c9fb095edbb59b Mon Sep 17 00:00:00 2001
> From: Jun Zhao <jun.zhao at intel.com>
> Date: Mon, 9 Oct 2017 02:41:37 -0400
> Subject: [V3 3/4] doc/codecs: document the -hwaccel_flags option.
> 
> Signed-off-by: Jun Zhao <jun.zhao at intel.com>
> ---
>  doc/codecs.texi | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/doc/codecs.texi b/doc/codecs.texi
> index 40f64fe4c8..2d23a11b7f 100644
> --- a/doc/codecs.texi
> +++ b/doc/codecs.texi
> @@ -1279,6 +1279,20 @@ ffprobe -dump_separator "
>  Maximum number of pixels per image. This value can be used to avoid out of
>  memory failures due to large images.
>  
> + at item  -hwaccel_flags  @var{flags} (@emph{decoding,video})
> +Possible values:
> + at table @samp
> + at item ignore_level
> +ignore level even if the codec level used is unknown or higher than the maximum
> +supported level reported by the hardware driver
> + at item allow_high_depth
> +allow to output YUV pixel formats with a different chroma sampling than 4:2:0
> +and/or other than 8 bits per component
> + at item allow_profile_mismatch
> +attempt to decode anyway if HW accelerated decoder's supported profiles do not
> +exactly match the stream
> + at end table

These should be whole sentences like the rest of the file, rather than just the summary fragments from the options.

A specific example for the allow-profile-mismatch case would be nice, too.  (Unlike the other two it's not very obvious what the use of it is.)

> +
>  @item apply_cropping @var{bool} (@emph{decoding,video})
>  Enable cropping if cropping parameters are multiples of the required
>  alignment for the left and top parameters. If the alignment is not met the
> -- 
> 2.11.0
>