diff options
| author | Luca Ceresoli <luca@lucaceresoli.net> | 2018-05-14 07:27:24 -0400 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2018-05-25 15:23:15 -0400 |
| commit | 579d76deb1b106af5987670389604381c31116eb (patch) | |
| tree | da27b2d060303b49a12c3ea2bcb827e60554265b /Documentation/media/uapi/v4l/crop.rst | |
| parent | e81ff408c17ee5cee0a30e05f7d5c2d3a103bd24 (diff) | |
| download | linux-0-day-579d76deb1b106af5987670389604381c31116eb.tar.gz linux-0-day-579d76deb1b106af5987670389604381c31116eb.tar.xz | |
media: docs: clarify relationship between crop and selection APIs
Having two somewhat similar and largely overlapping APIs is confusing,
especially since the older one appears in the docs before the newer
and most featureful counterpart.
Clarify all of this in several ways:
- swap the two sections
- give a name to the two APIs in the section names
- add a note at the beginning of the CROP API section
- update note about VIDIOC_CROPCAP
Also remove a note that is incorrect (correct wording is in
vidioc-cropcap.rst).
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Diffstat (limited to 'Documentation/media/uapi/v4l/crop.rst')
| -rw-r--r-- | Documentation/media/uapi/v4l/crop.rst | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/Documentation/media/uapi/v4l/crop.rst b/Documentation/media/uapi/v4l/crop.rst index 182565b9ace49..45e8a895a3202 100644 --- a/Documentation/media/uapi/v4l/crop.rst +++ b/Documentation/media/uapi/v4l/crop.rst @@ -2,9 +2,18 @@ .. _crop: -************************************* -Image Cropping, Insertion and Scaling -************************************* +***************************************************** +Image Cropping, Insertion and Scaling -- the CROP API +***************************************************** + +.. note:: + + The CROP API is mostly superseded by the newer :ref:`SELECTION API + <selection-api>`. The new API should be preferred in most cases, + with the exception of pixel aspect ratio detection, which is + implemented by :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` and has no + equivalent in the SELECTION API. See :ref:`selection-vs-crop` for a + comparison of the two APIs. Some video capture devices can sample a subsection of the picture and shrink or enlarge it to an image of arbitrary size. We call these @@ -42,10 +51,9 @@ where applicable) will be fixed in this case. .. note:: - All capture and output devices must support the - :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl such that applications - can determine if scaling takes place. - + All capture and output devices that support the CROP or SELECTION + API will also support the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` + ioctl. Cropping Structures =================== |