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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_G_CROP:
   4
   5 **********************************
   6 ioctl VIDIOC_G_CROP, VIDIOC_S_CROP
   7 **********************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_G_CROP - VIDIOC_S_CROP - Get or set the current cropping rectangle
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_G_CROP, struct v4l2_crop *argp )
  19     :name: VIDIOC_G_CROP
  20
  21 .. c:function:: int ioctl( int fd, VIDIOC_S_CROP, const struct v4l2_crop *argp )
  22     :name: VIDIOC_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 To query the cropping rectangle size and position applications set the
  38 ``type`` field of a struct :c:type:`v4l2_crop` structure to the
  39 respective buffer (stream) type and call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` ioctl
  40 with a pointer to this structure. The driver fills the rest of the
  41 structure or returns the ``EINVAL`` error code if cropping is not supported.
  42
  43 To change the cropping rectangle applications initialize the ``type``
  44 and struct :c:type:`v4l2_rect` substructure named ``c`` of a
  45 v4l2_crop structure and call the :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctl with a pointer
  46 to this structure.
  47
  48 Do not use the multiplanar buffer types. Use
  49 ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` instead of
  50 ``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE`` and use
  51 ``V4L2_BUF_TYPE_VIDEO_OUTPUT`` instead of
  52 ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``.
  53
  54 The driver first adjusts the requested dimensions against hardware
  55 limits, i. e. the bounds given by the capture/output window, and it
  56 rounds to the closest possible values of horizontal and vertical offset,
  57 width and height. In particular the driver must round the vertical
  58 offset of the cropping rectangle to frame lines modulo two, such that
  59 the field order cannot be confused.
  60
  61 Second the driver adjusts the image size (the opposite rectangle of the
  62 scaling process, source or target depending on the data direction) to
  63 the closest size possible while maintaining the current horizontal and
  64 vertical scaling factor.
  65
  66 Finally the driver programs the hardware with the actual cropping and
  67 image parameters. :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` is a write-only ioctl, it does not
  68 return the actual parameters. To query them applications must call
  69 :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and :ref:`VIDIOC_G_FMT`. When the
  70 parameters are unsuitable the application may modify the cropping or
  71 image parameters and repeat the cycle until satisfactory parameters have
  72 been negotiated.
  73
  74 When cropping is not supported then no parameters are changed and
  75 :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` returns the ``EINVAL`` error code.
  76
  77
  78 .. c:type:: v4l2_crop
  79
  80 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  81
  82 .. flat-table:: struct v4l2_crop
  83     :header-rows:  0
  84     :stub-columns: 0
  85     :widths:       1 1 2
  86
  87     * - __u32
  88       - ``type``
  89       - Type of the data stream, set by the application. Only these types
  90         are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
  91         ``V4L2_BUF_TYPE_VIDEO_OUTPUT`` and
  92         ``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
  93     * - struct :c:type:`v4l2_rect`
  94       - ``c``
  95       - Cropping rectangle. The same co-ordinate system as for struct
  96         :c:type:`v4l2_cropcap` ``bounds`` is used.
  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 ENODATA
 107     Cropping is not supported for this input or output.