Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 53b5d574 authored by Pawel Osciak's avatar Pawel Osciak Committed by Mauro Carvalho Chehab
Browse files

[media] Add multi-planar API documentation 



Add DocBook documentation for the new multi-planar API extensions to the
Video for Linux 2 API DocBook.

Signed-off-by: default avatarPawel Osciak <pawel@osciak.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent c4c0a78d

Documentation/DocBook/media-entities.tmpl

+4 −0
Original line number Original line Diff line number Diff line
@@ -129,6 +129,7 @@ 
<!ENTITY v4l2-audioout "struct&nbsp;<link linkend='v4l2-audioout'>v4l2_audioout</link>">

<!ENTITY v4l2-audioout "struct&nbsp;<link linkend='v4l2-audioout'>v4l2_audioout</link>">

<!ENTITY v4l2-bt-timings "struct&nbsp;<link linkend='v4l2-bt-timings'>v4l2_bt_timings</link>">

<!ENTITY v4l2-bt-timings "struct&nbsp;<link linkend='v4l2-bt-timings'>v4l2_bt_timings</link>">

<!ENTITY v4l2-buffer "struct&nbsp;<link linkend='v4l2-buffer'>v4l2_buffer</link>">

<!ENTITY v4l2-buffer "struct&nbsp;<link linkend='v4l2-buffer'>v4l2_buffer</link>">

<!ENTITY v4l2-plane "struct&nbsp;<link linkend='v4l2-plane'>v4l2_plane</link>">

<!ENTITY v4l2-capability "struct&nbsp;<link linkend='v4l2-capability'>v4l2_capability</link>">

<!ENTITY v4l2-capability "struct&nbsp;<link linkend='v4l2-capability'>v4l2_capability</link>">

<!ENTITY v4l2-captureparm "struct&nbsp;<link linkend='v4l2-captureparm'>v4l2_captureparm</link>">

<!ENTITY v4l2-captureparm "struct&nbsp;<link linkend='v4l2-captureparm'>v4l2_captureparm</link>">

<!ENTITY v4l2-clip "struct&nbsp;<link linkend='v4l2-clip'>v4l2_clip</link>">

<!ENTITY v4l2-clip "struct&nbsp;<link linkend='v4l2-clip'>v4l2_clip</link>">
@@ -167,6 +168,8 @@ 
<!ENTITY v4l2-output "struct&nbsp;<link linkend='v4l2-output'>v4l2_output</link>">

<!ENTITY v4l2-output "struct&nbsp;<link linkend='v4l2-output'>v4l2_output</link>">

<!ENTITY v4l2-outputparm "struct&nbsp;<link linkend='v4l2-outputparm'>v4l2_outputparm</link>">

<!ENTITY v4l2-outputparm "struct&nbsp;<link linkend='v4l2-outputparm'>v4l2_outputparm</link>">

<!ENTITY v4l2-pix-format "struct&nbsp;<link linkend='v4l2-pix-format'>v4l2_pix_format</link>">

<!ENTITY v4l2-pix-format "struct&nbsp;<link linkend='v4l2-pix-format'>v4l2_pix_format</link>">

<!ENTITY v4l2-pix-format-mplane "struct&nbsp;<link linkend='v4l2-pix-format-mplane'>v4l2_pix_format_mplane</link>">

<!ENTITY v4l2-plane-pix-format "struct&nbsp;<link linkend='v4l2-plane-pix-format'>v4l2_plane_pix_format</link>">

<!ENTITY v4l2-queryctrl "struct&nbsp;<link linkend='v4l2-queryctrl'>v4l2_queryctrl</link>">

<!ENTITY v4l2-queryctrl "struct&nbsp;<link linkend='v4l2-queryctrl'>v4l2_queryctrl</link>">

<!ENTITY v4l2-querymenu "struct&nbsp;<link linkend='v4l2-querymenu'>v4l2_querymenu</link>">

<!ENTITY v4l2-querymenu "struct&nbsp;<link linkend='v4l2-querymenu'>v4l2_querymenu</link>">

<!ENTITY v4l2-rect "struct&nbsp;<link linkend='v4l2-rect'>v4l2_rect</link>">

<!ENTITY v4l2-rect "struct&nbsp;<link linkend='v4l2-rect'>v4l2_rect</link>">
@@ -202,6 +205,7 @@ 
<!-- Subsections -->

<!-- Subsections -->

<!ENTITY sub-biblio SYSTEM "v4l/biblio.xml">

<!ENTITY sub-biblio SYSTEM "v4l/biblio.xml">

<!ENTITY sub-common SYSTEM "v4l/common.xml">

<!ENTITY sub-common SYSTEM "v4l/common.xml">

<!ENTITY sub-planar-apis SYSTEM "v4l/planar-apis.xml">

<!ENTITY sub-compat SYSTEM "v4l/compat.xml">

<!ENTITY sub-compat SYSTEM "v4l/compat.xml">

<!ENTITY sub-controls SYSTEM "v4l/controls.xml">

<!ENTITY sub-controls SYSTEM "v4l/controls.xml">

<!ENTITY sub-dev-capture SYSTEM "v4l/dev-capture.xml">

<!ENTITY sub-dev-capture SYSTEM "v4l/dev-capture.xml">

Documentation/DocBook/v4l/common.xml

+2 −0
Original line number Original line Diff line number Diff line
@@ -846,6 +846,8 @@ conversion routine or library for integration into applications.</para> 
    </section>

    </section>

  </section>

  </section>





  &sub-planar-apis;



  <section id="crop">

  <section id="crop">

    <title>Image Cropping, Insertion and Scaling</title>

    <title>Image Cropping, Insertion and Scaling</title>

Documentation/DocBook/v4l/compat.xml

+11 −0
Original line number Original line Diff line number Diff line
@@ -2353,6 +2353,17 @@ that used it. It was originally scheduled for removal in 2.6.35. 
	</listitem>

	</listitem>

      </orderedlist>

      </orderedlist>

    </section>

    </section>

    <section>

      <title>V4L2 in Linux 2.6.38</title>

      <orderedlist>

        <listitem>

          <para>Multi-planar API added. Does not affect the compatibility of

          current drivers and applications. See

          <link linkend="planar-apis">multi-planar API</link>

          for details.</para>

        </listitem>

      </orderedlist>

    </section>





    <section id="other">

    <section id="other">

      <title>Relation of V4L2 to other Linux multimedia APIs</title>

      <title>Relation of V4L2 to other Linux multimedia APIs</title>

Documentation/DocBook/v4l/dev-capture.xml

+8 −5
Original line number Original line Diff line number Diff line
@@ -18,7 +18,8 @@ files are used for video output devices.</para> 
    <title>Querying Capabilities</title>

    <title>Querying Capabilities</title>





    <para>Devices supporting the video capture interface set the

    <para>Devices supporting the video capture interface set the

<constant>V4L2_CAP_VIDEO_CAPTURE</constant> flag in the

<constant>V4L2_CAP_VIDEO_CAPTURE</constant> or

<constant>V4L2_CAP_VIDEO_CAPTURE_MPLANE</constant> flag in the

<structfield>capabilities</structfield> field of &v4l2-capability;

<structfield>capabilities</structfield> field of &v4l2-capability;

returned by the &VIDIOC-QUERYCAP; ioctl. As secondary device functions

returned by the &VIDIOC-QUERYCAP; ioctl. As secondary device functions

they may also support the <link linkend="overlay">video overlay</link>

they may also support the <link linkend="overlay">video overlay</link>
@@ -64,9 +65,11 @@ linkend="crop" />.</para> 




    <para>To query the current image format applications set the

    <para>To query the current image format applications set the

<structfield>type</structfield> field of a &v4l2-format; to

<structfield>type</structfield> field of a &v4l2-format; to

<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant> and call the

<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant> or

<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant> and call the

&VIDIOC-G-FMT; ioctl with a pointer to this structure. Drivers fill

&VIDIOC-G-FMT; ioctl with a pointer to this structure. Drivers fill

the &v4l2-pix-format; <structfield>pix</structfield> member of the

the &v4l2-pix-format; <structfield>pix</structfield> or the

&v4l2-pix-format-mplane; <structfield>pix_mp</structfield> member of the

<structfield>fmt</structfield> union.</para>

<structfield>fmt</structfield> union.</para>





    <para>To request different parameters applications set the

    <para>To request different parameters applications set the
@@ -84,8 +87,8 @@ adjust the parameters and finally return the actual parameters as 
without disabling I/O or possibly time consuming hardware

without disabling I/O or possibly time consuming hardware

preparations.</para>

preparations.</para>





    <para>The contents of &v4l2-pix-format; are discussed in <xref

    <para>The contents of &v4l2-pix-format; and &v4l2-pix-format-mplane;

linkend="pixfmt" />. See also the specification of the

are discussed in <xref linkend="pixfmt" />. See also the specification of the

<constant>VIDIOC_G_FMT</constant>, <constant>VIDIOC_S_FMT</constant>

<constant>VIDIOC_G_FMT</constant>, <constant>VIDIOC_S_FMT</constant>

and <constant>VIDIOC_TRY_FMT</constant> ioctls for details. Video

and <constant>VIDIOC_TRY_FMT</constant> ioctls for details. Video

capture devices must implement both the

capture devices must implement both the

Documentation/DocBook/v4l/dev-output.xml

+8 −5
Original line number Original line Diff line number Diff line
@@ -17,7 +17,8 @@ files are used for video capture devices.</para> 
    <title>Querying Capabilities</title>

    <title>Querying Capabilities</title>





    <para>Devices supporting the video output interface set the

    <para>Devices supporting the video output interface set the

<constant>V4L2_CAP_VIDEO_OUTPUT</constant> flag in the

<constant>V4L2_CAP_VIDEO_OUTPUT</constant> or

<constant>V4L2_CAP_VIDEO_OUTPUT_MPLANE</constant> flag in the

<structfield>capabilities</structfield> field of &v4l2-capability;

<structfield>capabilities</structfield> field of &v4l2-capability;

returned by the &VIDIOC-QUERYCAP; ioctl. As secondary device functions

returned by the &VIDIOC-QUERYCAP; ioctl. As secondary device functions

they may also support the <link linkend="raw-vbi">raw VBI

they may also support the <link linkend="raw-vbi">raw VBI
@@ -60,9 +61,11 @@ linkend="crop" />.</para> 




    <para>To query the current image format applications set the

    <para>To query the current image format applications set the

<structfield>type</structfield> field of a &v4l2-format; to

<structfield>type</structfield> field of a &v4l2-format; to

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> and call the

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> or

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant> and call the

&VIDIOC-G-FMT; ioctl with a pointer to this structure. Drivers fill

&VIDIOC-G-FMT; ioctl with a pointer to this structure. Drivers fill

the &v4l2-pix-format; <structfield>pix</structfield> member of the

the &v4l2-pix-format; <structfield>pix</structfield> or the

&v4l2-pix-format-mplane; <structfield>pix_mp</structfield> member of the

<structfield>fmt</structfield> union.</para>

<structfield>fmt</structfield> union.</para>





    <para>To request different parameters applications set the

    <para>To request different parameters applications set the
@@ -80,8 +83,8 @@ adjust the parameters and finally return the actual parameters as 
without disabling I/O or possibly time consuming hardware

without disabling I/O or possibly time consuming hardware

preparations.</para>

preparations.</para>





    <para>The contents of &v4l2-pix-format; are discussed in <xref

    <para>The contents of &v4l2-pix-format; and &v4l2-pix-format-mplane;

linkend="pixfmt" />. See also the specification of the

are discussed in <xref linkend="pixfmt" />. See also the specification of the

<constant>VIDIOC_G_FMT</constant>, <constant>VIDIOC_S_FMT</constant>

<constant>VIDIOC_G_FMT</constant>, <constant>VIDIOC_S_FMT</constant>

and <constant>VIDIOC_TRY_FMT</constant> ioctls for details. Video

and <constant>VIDIOC_TRY_FMT</constant> ioctls for details. Video

output devices must implement both the

output devices must implement both the