Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_SUBDEV_G_CROP:
   4
   5 ************************************************
   6 ioctl VIDIOC_SUBDEV_G_CROP, VIDIOC_SUBDEV_S_CROP
   7 ************************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_SUBDEV_G_CROP - VIDIOC_SUBDEV_S_CROP - Get or set the crop rectangle on a subdev pad
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_SUBDEV_G_CROP, struct v4l2_subdev_crop *argp )
  19     :name: VIDIOC_SUBDEV_G_CROP
  20
  21 .. c:function:: int ioctl( int fd, VIDIOC_SUBDEV_S_CROP, const struct v4l2_subdev_crop *argp )
  22     :name: VIDIOC_SUBDEV_S_CROP
  23
  24
  25 Arguments
  26 =========
  27
  28 ``fd``
  29     File descriptor returned by :ref:`open() <func-open>`.
  30
  31 ``argp``
  32
  33
  34 Description
  35 ===========
  36
  37 .. note::
  38
  39     This is an :ref:`obsolete` interface and may be removed
  40     in the future. It is superseded by
  41     :ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`.
  42
  43 To retrieve the current crop rectangle applications set the ``pad``
  44 field of a struct :c:type:`v4l2_subdev_crop` to the
  45 desired pad number as reported by the media API and the ``which`` field
  46 to ``V4L2_SUBDEV_FORMAT_ACTIVE``. They then call the
  47 ``VIDIOC_SUBDEV_G_CROP`` ioctl with a pointer to this structure. The
  48 driver fills the members of the ``rect`` field or returns ``EINVAL`` error
  49 code if the input arguments are invalid, or if cropping is not supported
  50 on the given pad.
  51
  52 To change the current crop rectangle applications set both the ``pad``
  53 and ``which`` fields and all members of the ``rect`` field. They then
  54 call the ``VIDIOC_SUBDEV_S_CROP`` ioctl with a pointer to this
  55 structure. The driver verifies the requested crop rectangle, adjusts it
  56 based on the hardware capabilities and configures the device. Upon
  57 return the struct :c:type:`v4l2_subdev_crop`
  58 contains the current format as would be returned by a
  59 ``VIDIOC_SUBDEV_G_CROP`` call.
  60
  61 Applications can query the device capabilities by setting the ``which``
  62 to ``V4L2_SUBDEV_FORMAT_TRY``. When set, 'try' crop rectangles are not
  63 applied to the device by the driver, but are mangled exactly as active
  64 crop rectangles and stored in the sub-device file handle. Two
  65 applications querying the same sub-device would thus not interact with
  66 each other.
  67
  68 Drivers must not return an error solely because the requested crop
  69 rectangle doesn't match the device capabilities. They must instead
  70 modify the rectangle to match what the hardware can provide. The
  71 modified format should be as close as possible to the original request.
  72
  73
  74 .. c:type:: v4l2_subdev_crop
  75
  76 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  77
  78 .. flat-table:: struct v4l2_subdev_crop
  79     :header-rows:  0
  80     :stub-columns: 0
  81     :widths:       1 1 2
  82
  83     * - __u32
  84       - ``pad``
  85       - Pad number as reported by the media framework.
  86     * - __u32
  87       - ``which``
  88       - Crop rectangle to get or set, from enum
  89         :ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
  90     * - struct :c:type:`v4l2_rect`
  91       - ``rect``
  92       - Crop rectangle boundaries, in pixels.
  93     * - __u32
  94       - ``reserved``\ [8]
  95       - Reserved for future extensions. Applications and drivers must set
  96         the array to zero.
  97
  98
  99 Return Value
 100 ============
 101
 102 On success 0 is returned, on error -1 and the ``errno`` variable is set
 103 appropriately. The generic error codes are described at the
 104 :ref:`Generic Error Codes <gen-errors>` chapter.
 105
 106 EBUSY
 107     The crop rectangle can't be changed because the pad is currently
 108     busy. This can be caused, for instance, by an active video stream on
 109     the pad. The ioctl must not be retried without performing another
 110     action to fix the problem first. Only returned by
 111     ``VIDIOC_SUBDEV_S_CROP``
 112
 113 EINVAL
 114     The struct :c:type:`v4l2_subdev_crop` ``pad``
 115     references a non-existing pad, the ``which`` field references a
 116     non-existing format, or cropping is not supported on the given
 117     subdev pad.