Documentation/media/uapi/v4l/pixfmt-003.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 ******************************
   4 Multi-planar format structures
   5 ******************************
   6
   7 The :ref:`struct v4l2_plane_pix_format <v4l2-plane-pix-format>` structures define size
   8 and layout for each of the planes in a multi-planar format. The
   9 :ref:`struct v4l2_pix_format_mplane <v4l2-pix-format-mplane>` structure contains
  10 information common to all planes (such as image width and height) and an
  11 array of :ref:`struct v4l2_plane_pix_format <v4l2-plane-pix-format>` structures,
  12 describing all planes of that format.
  13
  14
  15 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  16
  17 .. _v4l2-plane-pix-format:
  18
  19 .. flat-table:: struct v4l2_plane_pix_format
  20     :header-rows:  0
  21     :stub-columns: 0
  22     :widths:       1 1 2
  23
  24
  25     -  .. row 1
  26
  27        -  __u32
  28
  29        -  ``sizeimage``
  30
  31        -  Maximum size in bytes required for image data in this plane.
  32
  33     -  .. row 2
  34
  35        -  __u32
  36
  37        -  ``bytesperline``
  38
  39        -  Distance in bytes between the leftmost pixels in two adjacent
  40           lines. See struct :ref:`v4l2_pix_format <v4l2-pix-format>`.
  41
  42     -  .. row 3
  43
  44        -  __u16
  45
  46        -  ``reserved[6]``
  47
  48        -  Reserved for future extensions. Should be zeroed by drivers and
  49           applications.
  50
  51
  52 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  53
  54 .. _v4l2-pix-format-mplane:
  55
  56 .. flat-table:: struct v4l2_pix_format_mplane
  57     :header-rows:  0
  58     :stub-columns: 0
  59     :widths:       1 1 2
  60
  61
  62     -  .. row 1
  63
  64        -  __u32
  65
  66        -  ``width``
  67
  68        -  Image width in pixels. See struct
  69           :ref:`v4l2_pix_format <v4l2-pix-format>`.
  70
  71     -  .. row 2
  72
  73        -  __u32
  74
  75        -  ``height``
  76
  77        -  Image height in pixels. See struct
  78           :ref:`v4l2_pix_format <v4l2-pix-format>`.
  79
  80     -  .. row 3
  81
  82        -  __u32
  83
  84        -  ``pixelformat``
  85
  86        -  The pixel format. Both single- and multi-planar four character
  87           codes can be used.
  88
  89     -  .. row 4
  90
  91        -  enum :ref:`v4l2_field <v4l2-field>`
  92
  93        -  ``field``
  94
  95        -  See struct :ref:`v4l2_pix_format <v4l2-pix-format>`.
  96
  97     -  .. row 5
  98
  99        -  enum :ref:`v4l2_colorspace <v4l2-colorspace>`
 100
 101        -  ``colorspace``
 102
 103        -  See struct :ref:`v4l2_pix_format <v4l2-pix-format>`.
 104
 105     -  .. row 6
 106
 107        -  struct :ref:`v4l2_plane_pix_format <v4l2-plane-pix-format>`
 108
 109        -  ``plane_fmt[VIDEO_MAX_PLANES]``
 110
 111        -  An array of structures describing format of each plane this pixel
 112           format consists of. The number of valid entries in this array has
 113           to be put in the ``num_planes`` field.
 114
 115     -  .. row 7
 116
 117        -  __u8
 118
 119        -  ``num_planes``
 120
 121        -  Number of planes (i.e. separate memory buffers) for this format
 122           and the number of valid entries in the ``plane_fmt`` array.
 123
 124     -  .. row 8
 125
 126        -  __u8
 127
 128        -  ``flags``
 129
 130        -  Flags set by the application or driver, see :ref:`format-flags`.
 131
 132     -  .. row 9
 133
 134        -  enum :ref:`v4l2_ycbcr_encoding <v4l2-ycbcr-encoding>`
 135
 136        -  ``ycbcr_enc``
 137
 138        -  This information supplements the ``colorspace`` and must be set by
 139           the driver for capture streams and by the application for output
 140           streams, see :ref:`colorspaces`.
 141
 142     -  .. row 10
 143
 144        -  enum :ref:`v4l2_quantization <v4l2-quantization>`
 145
 146        -  ``quantization``
 147
 148        -  This information supplements the ``colorspace`` and must be set by
 149           the driver for capture streams and by the application for output
 150           streams, see :ref:`colorspaces`.
 151
 152     -  .. row 11
 153
 154        -  enum :ref:`v4l2_xfer_func <v4l2-xfer-func>`
 155
 156        -  ``xfer_func``
 157
 158        -  This information supplements the ``colorspace`` and must be set by
 159           the driver for capture streams and by the application for output
 160           streams, see :ref:`colorspaces`.
 161
 162     -  .. row 12
 163
 164        -  __u8
 165
 166        -  ``reserved[7]``
 167
 168        -  Reserved for future extensions. Should be zeroed by drivers and
 169           applications.