[FFmpeg-devel] [PATCH v2 2/2] doc/ffmpeg: update the documentation about vaapi device creation

[Stefano Sabatini]

On date Friday 2024-01-05 10:33:52 +0800, Xiang, Haihao wrote:
> From: Haihao Xiang <haihao.xiang at intel.com>
> 
> Signed-off-by: Haihao Xiang <haihao.xiang at intel.com>
> ---
>  doc/ffmpeg.texi | 23 +++++++++++++++++++++++
>  1 file changed, 23 insertions(+)
> 
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index f095f402bd..8fb165c5df 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -1385,6 +1385,29 @@ If not specified, it will attempt to open the default X11 display (@emph{$DISPLA
>  and then the first DRM render node (@emph{/dev/dri/renderD128}), or the default
>  DirectX adapter on Windows.
>  
> +The following options are recognized:
> + at table @option
> + at item kernel_driver
> +When @var{device} is not specified, use this option to specify the name of the kernel

> +driver associated with the desired device. This option is only available when
> + at emph{libdrm} works on Linux.

Optional: might be good to specify a method to verify this condition.

> + at end table
> +
> +Examples:
> + at table @emph
> + at item -init_hw_device vaapi
> +Create a vaapi device on the default device

missing final dot here and below

> +
> + at item -init_hw_device vaapi:/dev/dri/renderD129
> +Create a vaapi device on DRM render node /dev/dri/renderD129
> +
> + at item -init_hw_device vaapi:1
> +Create a vaapi device on DirectX adapter 1
> +
> + at item -init_hw_device vaapi:,kernel_driver=i915
> +Create a vaapi device on a device associated with kernel driver @samp{i915}
> + at end table
> +

Looks good otherwise (but again, since hwaccels are probably
independent from ffmpeg they should be probably moved to a dedicated
manual).