Commit 3c828ff8 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

[media] DocBook media: fix VIDIOC_CROPCAP type description 



The type field of VIDIOC_CROPCAP does not allow the MPLANE variants, just
as all the other crop/selection related ioctls.

Fix the description of CROPCAP and G_CROP and make the text describing
this consistent for all selection ioctls.

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 82bdb26a

Documentation/DocBook/media/v4l/vidioc-cropcap.xml

+6 −3
Original line number Diff line number Diff line
@@ -59,6 +59,11 @@ constant except when switching the video standard. Remember this 
switch can occur implicit when switching the video input or

output.</para>



<para>Do not use the multiplanar buffer types.  Use <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>

instead of <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant>

and use <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> instead of

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant>.</para>



    <para>This ioctl must be implemented for video capture or output devices that

support cropping and/or scaling and/or have non-square pixels, and for overlay devices.</para>
@@ -73,9 +78,7 @@ support cropping and/or scaling and/or have non-square pixels, and for overlay d 
	    <entry>Type of the data stream, set by the application.

Only these types are valid here:

<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>,

<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant>,

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant>,

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant> and

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> and

<constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>. See <xref linkend="v4l2-buf-type" />.</entry>

	  </row>

	  <row>

Documentation/DocBook/media/v4l/vidioc-g-crop.xml

+5 −0
Original line number Diff line number Diff line
@@ -70,6 +70,11 @@ structure or returns the &EINVAL; if cropping is not supported.</para> 
<constant>VIDIOC_S_CROP</constant> ioctl with a pointer to this

structure.</para>



<para>Do not use the multiplanar buffer types.  Use <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>

instead of <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant>

and use <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> instead of

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant>.</para>



    <para>The driver first adjusts the requested dimensions against

hardware limits, &ie; the bounds given by the capture/output window,

and it rounds to the closest possible values of horizontal and

Documentation/DocBook/media/v4l/vidioc-g-selection.xml

+2 −2
Original line number Diff line number Diff line
@@ -60,8 +60,8 @@ 


<para>To query the cropping (composing) rectangle set &v4l2-selection;

<structfield> type </structfield> field to the respective buffer type.

Do not use multiplanar buffers.  Use <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>

instead of <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant>.  Use

Do not use the multiplanar buffer types.  Use <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>

instead of <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant> and use

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> instead of

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant>.  The next step is

setting the value of &v4l2-selection; <structfield>target</structfield> field

CRA Git | Maintained and supported by SUSTech CRA and CCSE