~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/userspace-api/media/v4l/selection-api-vs-crop-api.rst

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
  2 
  3 .. _selection-vs-crop:
  4 
  5 ********************************
  6 Comparison with old cropping API
  7 ********************************
  8 
  9 The selection API was introduced to cope with deficiencies of the
 10 older :ref:`CROP API <crop>`, that was designed to control simple
 11 capture devices. Later the cropping API was adopted by video output
 12 drivers. The ioctls are used to select a part of the display were the
 13 video signal is inserted. It should be considered as an API abuse
 14 because the described operation is actually the composing. The
 15 selection API makes a clear distinction between composing and cropping
 16 operations by setting the appropriate targets.
 17 
 18 The CROP API lacks any support for composing to and cropping from an
 19 image inside a memory buffer. The application could configure a
 20 capture device to fill only a part of an image by abusing V4L2
 21 API. Cropping a smaller image from a larger one is achieved by setting
 22 the field ``bytesperline`` at struct :c:type:`v4l2_pix_format`.
 23 Introducing an image offsets could be done by modifying field
 24 ``m_userptr`` at struct :c:type:`v4l2_buffer` before calling
 25 :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`. Those operations should be avoided
 26 because they are not portable (endianness), and do not work for
 27 macroblock and Bayer formats and mmap buffers.
 28 
 29 The selection API deals with configuration of buffer
 30 cropping/composing in a clear, intuitive and portable way. Next, with
 31 the selection API the concepts of the padded target and constraints
 32 flags are introduced. Finally, struct :c:type:`v4l2_crop` and struct
 33 :c:type:`v4l2_cropcap` have no reserved fields. Therefore there is no
 34 way to extend their functionality. The new struct
 35 :c:type:`v4l2_selection` provides a lot of place for future
 36 extensions.
 37 
 38 Driver developers are encouraged to implement only selection API. The
 39 former cropping API would be simulated using the new one.

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php