124 lines · plain
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later2 3******************************4Multi-planar format structures5******************************6 7The struct :c:type:`v4l2_plane_pix_format` structures define size8and layout for each of the planes in a multi-planar format. The9struct :c:type:`v4l2_pix_format_mplane` structure contains10information common to all planes (such as image width and height) and an11array of struct :c:type:`v4l2_plane_pix_format` structures,12describing all planes of that format.13 14 15 16.. tabularcolumns:: |p{1.4cm}|p{4.0cm}|p{11.9cm}|17 18.. c:type:: v4l2_plane_pix_format19 20.. flat-table:: struct v4l2_plane_pix_format21 :header-rows: 022 :stub-columns: 023 :widths: 1 1 224 25 * - __u3226 - ``sizeimage``27 - Maximum size in bytes required for image data in this plane,28 set by the driver. When the image consists of variable length29 compressed data this is the number of bytes required by the30 codec to support the worst-case compression scenario.31 32 The driver will set the value for uncompressed images.33 34 Clients are allowed to set the sizeimage field for variable length35 compressed data flagged with ``V4L2_FMT_FLAG_COMPRESSED`` at36 :ref:`VIDIOC_ENUM_FMT`, but the driver may ignore it and set the37 value itself, or it may modify the provided value based on38 alignment requirements or minimum/maximum size requirements.39 If the client wants to leave this to the driver, then it should40 set sizeimage to 0.41 * - __u3242 - ``bytesperline``43 - Distance in bytes between the leftmost pixels in two adjacent44 lines. See struct :c:type:`v4l2_pix_format`.45 * - __u1646 - ``reserved[6]``47 - Reserved for future extensions. Should be zeroed by drivers and48 applications.49 50 51.. raw:: latex52 53 \small54 55.. tabularcolumns:: |p{4.4cm}|p{5.6cm}|p{7.3cm}|56 57.. c:type:: v4l2_pix_format_mplane58 59.. flat-table:: struct v4l2_pix_format_mplane60 :header-rows: 061 :stub-columns: 062 :widths: 1 1 263 64 * - __u3265 - ``width``66 - Image width in pixels. See struct67 :c:type:`v4l2_pix_format`.68 * - __u3269 - ``height``70 - Image height in pixels. See struct71 :c:type:`v4l2_pix_format`.72 * - __u3273 - ``pixelformat``74 - The pixel format. Both single- and multi-planar four character75 codes can be used.76 * - __u3277 - ``field``78 - Field order, from enum :c:type:`v4l2_field`.79 See struct :c:type:`v4l2_pix_format`.80 * - __u3281 - ``colorspace``82 - Colorspace encoding, from enum :c:type:`v4l2_colorspace`.83 See struct :c:type:`v4l2_pix_format`.84 * - struct :c:type:`v4l2_plane_pix_format`85 - ``plane_fmt[VIDEO_MAX_PLANES]``86 - An array of structures describing format of each plane this pixel87 format consists of. The number of valid entries in this array has88 to be put in the ``num_planes`` field.89 * - __u890 - ``num_planes``91 - Number of planes (i.e. separate memory buffers) for this format92 and the number of valid entries in the ``plane_fmt`` array.93 * - __u894 - ``flags``95 - Flags set by the application or driver, see :ref:`format-flags`.96 * - union {97 - (anonymous)98 * - __u899 - ``ycbcr_enc``100 - Y'CbCr encoding, from enum :c:type:`v4l2_ycbcr_encoding`.101 See struct :c:type:`v4l2_pix_format`.102 * - __u8103 - ``hsv_enc``104 - HSV encoding, from enum :c:type:`v4l2_hsv_encoding`.105 See struct :c:type:`v4l2_pix_format`.106 * - }107 -108 * - __u8109 - ``quantization``110 - Quantization range, from enum :c:type:`v4l2_quantization`.111 See struct :c:type:`v4l2_pix_format`.112 * - __u8113 - ``xfer_func``114 - Transfer function, from enum :c:type:`v4l2_xfer_func`.115 See struct :c:type:`v4l2_pix_format`.116 * - __u8117 - ``reserved[7]``118 - Reserved for future extensions. Should be zeroed by drivers and119 applications.120 121.. raw:: latex122 123 \normalsize124