1 .. -*- coding: utf-8; mode: rst -*-
3 ******************************
4 Multi-planar format structures
5 ******************************
7 The struct :c:type:`v4l2_plane_pix_format` structures define size
8 and layout for each of the planes in a multi-planar format. The
9 struct :c:type:`v4l2_pix_format_mplane` structure contains
10 information common to all planes (such as image width and height) and an
11 array of struct :c:type:`v4l2_plane_pix_format` structures,
12 describing all planes of that format.
15 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
17 .. c:type:: v4l2_plane_pix_format
19 .. flat-table:: struct v4l2_plane_pix_format
31 - Maximum size in bytes required for image data in this plane.
39 - Distance in bytes between the leftmost pixels in two adjacent
40 lines. See struct :c:type:`v4l2_pix_format`.
48 - Reserved for future extensions. Should be zeroed by drivers and
52 .. tabularcolumns:: |p{4.4cm}|p{5.6cm}|p{7.5cm}|
54 .. c:type:: v4l2_pix_format_mplane
56 .. flat-table:: struct v4l2_pix_format_mplane
68 - Image width in pixels. See struct
69 :c:type:`v4l2_pix_format`.
77 - Image height in pixels. See struct
78 :c:type:`v4l2_pix_format`.
86 - The pixel format. Both single- and multi-planar four character
91 - enum :c:type:`v4l2_field`
95 - See struct :c:type:`v4l2_pix_format`.
99 - enum :c:type:`v4l2_colorspace`
103 - See struct :c:type:`v4l2_pix_format`.
107 - struct :c:type:`v4l2_plane_pix_format`
109 - ``plane_fmt[VIDEO_MAX_PLANES]``
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.
121 - Number of planes (i.e. separate memory buffers) for this format
122 and the number of valid entries in the ``plane_fmt`` array.
130 - Flags set by the application or driver, see :ref:`format-flags`.
134 - enum :c:type:`v4l2_ycbcr_encoding`
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`.
144 - enum :c:type:`v4l2_quantization`
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`.
154 - enum :c:type:`v4l2_xfer_func`
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`.
168 - Reserved for future extensions. Should be zeroed by drivers and