diff mbox series

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

Message ID 20240105023352.3959874-2-haihao.xiang@intel.com
State New
Headers show
Series [FFmpeg-devel,v2,1/2] doc/ffmpeg: update the documentation about qsv device creation | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 fail Make failed
andriy/make_x86 fail Make failed

Commit Message

Xiang, Haihao Jan. 5, 2024, 2:33 a.m. UTC
From: Haihao Xiang <haihao.xiang@intel.com>

Signed-off-by: Haihao Xiang <haihao.xiang@intel.com>
---
 doc/ffmpeg.texi | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

Comments

Stefano Sabatini Jan. 6, 2024, 10:54 a.m. UTC | #1
On date Friday 2024-01-05 10:33:52 +0800, Xiang, Haihao wrote:
> From: Haihao Xiang <haihao.xiang@intel.com>
> 
> Signed-off-by: Haihao Xiang <haihao.xiang@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:
> +@table @option
> +@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
> +@emph{libdrm} works on Linux.

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

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

missing final dot here and below

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

Looks good otherwise (but again, since hwaccels are probably
independent from ffmpeg they should be probably moved to a dedicated
manual).
Xiang, Haihao Jan. 16, 2024, 5:34 a.m. UTC | #2
On Sa, 2024-01-06 at 11:54 +0100, Stefano Sabatini wrote:
> On date Friday 2024-01-05 10:33:52 +0800, Xiang, Haihao wrote:
> > From: Haihao Xiang <haihao.xiang@intel.com>
> > 
> > Signed-off-by: Haihao Xiang <haihao.xiang@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:
> > +@table @option
> > +@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
> > +@emph{libdrm} works on Linux.
> 
> Optional: might be good to specify a method to verify this condition.
> 
> > +@end table
> > +
> > +Examples:
> > +@table @emph
> > +@item -init_hw_device vaapi
> > +Create a vaapi device on the default device
> 
> missing final dot here and below
> 
> > +
> > +@item -init_hw_device vaapi:/dev/dri/renderD129
> > +Create a vaapi device on DRM render node /dev/dri/renderD129
> > +
> > +@item -init_hw_device vaapi:1
> > +Create a vaapi device on DirectX adapter 1
> > +
> > +@item -init_hw_device vaapi:,kernel_driver=i915
> > +Create a vaapi device on a device associated with kernel driver @samp{i915}
> > +@end table
> > +
> 
> Looks good otherwise (but again, since hwaccels are probably
> independent from ffmpeg they should be probably moved to a dedicated
> manual).
> 

Thanks for your comment, I updated this patch in v3
https://ffmpeg.org/pipermail/ffmpeg-devel/2024-January/319689.html 

BRs
Haihao
diff mbox series

Patch

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:
+@table @option
+@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
+@emph{libdrm} works on Linux.
+@end table
+
+Examples:
+@table @emph
+@item -init_hw_device vaapi
+Create a vaapi device on the default device
+
+@item -init_hw_device vaapi:/dev/dri/renderD129
+Create a vaapi device on DRM render node /dev/dri/renderD129
+
+@item -init_hw_device vaapi:1
+Create a vaapi device on DirectX adapter 1
+
+@item -init_hw_device vaapi:,kernel_driver=i915
+Create a vaapi device on a device associated with kernel driver @samp{i915}
+@end table
+
 @item vdpau
 @var{device} is an X11 display name.
 If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY}).