media/v4l/pixfmt-v4l2.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
4 Single-planar format structure
13 .. flat-table:: struct v4l2_pix_format
14     :header-rows:  0
15     :stub-columns: 0
18     * - __u32
19       - ``width``
20       - Image width in pixels.
21     * - __u32
22       - ``height``
23       - Image height in pixels. If ``field`` is one of ``V4L2_FIELD_TOP``,
25 	refers to the number of lines in the field, otherwise it refers to
26 	the number of lines in the frame (which is twice the field height
28     * - :cspan:`2` Applications set these fields to request an image
29 	size, drivers return the closest possible values. In case of
32 	to a multiple of the scale factor of any smaller planes. For
34 	``height`` must be multiples of two.
41 	For compressed formats on the CAPTURE side of a stateful mem2mem
45     * - __u32
46       - ``pixelformat``
47       - The pixel format or type of compression, set by the application.
49 	:ref:`four character code <v4l2-fourcc>`. V4L2 defines standard
50 	RGB formats in :ref:`pixfmt-rgb`, YUV formats in
51 	:ref:`yuv-formats`, and reserved codes in
52 	:ref:`reserved-formats`
53     * - __u32
54       - ``field``
55       - Field order, from enum :c:type:`v4l2_field`.
60 	For more details on fields see :ref:`field-order`.
61     * - __u32
62       - ``bytesperline``
63       - Distance in bytes between the leftmost pixels in two adjacent
65     * - :cspan:`2`
68 	padding bytes at the end of each line. Drivers however may ignore
76 	after the last line of an image cross a system page boundary.
78 	Output devices ignore the contents of padding bytes.
83 	planes of a YUV 4:2:0 image have half as many padding bytes
85 	must return a ``bytesperline`` value rounded up to a multiple of
90     * - __u32
91       - ``sizeimage``
92       - Size in bytes of the buffer to hold a complete image, set by the
94 	the image consists of variable length compressed data this is the
95 	number of bytes required by the codec to support the worst-case
107     * - __u32
108       - ``colorspace``
109       - Image colorspace, from enum :c:type:`v4l2_colorspace`.
116 	conversion, it will return another supported colorspace.
117 	The driver indicates that colorspace conversion is supported by setting
119 	:c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
120     * - __u32
121       - ``priv``
122       - This field indicates whether the remaining fields of the
138 	fields and zero the unused bytes of the
146     * - __u32
147       - ``flags``
148       - Flags set by the application or driver, see :ref:`format-flags`.
149     * - union {
150       - (anonymous)
151     * - __u32
152       - ``ycbcr_enc``
153       - Y'CbCr encoding, from enum :c:type:`v4l2_ycbcr_encoding`.
160 	conversion, it will return another supported encoding.
162 	ycbcr_enc conversion is supported by setting the flag
164 	:c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
165     * - __u32
166       - ``hsv_enc``
167       - HSV encoding, from enum :c:type:`v4l2_hsv_encoding`.
174 	conversion, it will return another supported encoding.
175 	This field is ignored for non-HSV pixelformats. The driver indicates
176 	that hsv_enc conversion is supported by setting the flag
178 	:c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
179     * - }
180       -
181     * - __u32
182       - ``quantization``
183       - Quantization range, from enum :c:type:`v4l2_quantization`.
190 	conversion, it will return another supported quantization.
191 	The driver indicates that quantization conversion is supported by setting
193 	:c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
194     * - __u32
195       - ``xfer_func``
196       - Transfer function, from enum :c:type:`v4l2_xfer_func`.
203 	conversion, it will return another supported transfer function.
204 	The driver indicates that xfer_func conversion is supported by setting
206 	:c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
210 .. _format-flags:
212 .. flat-table:: Format Flags
213     :header-rows:  0
214     :stub-columns: 0
217     * - ``V4L2_PIX_FMT_FLAG_PREMUL_ALPHA``
218       - 0x00000001
219       - The color values are premultiplied by the alpha channel value. For
224     * .. _`v4l2-pix-fmt-flag-set-csc`:
226       - ``V4L2_PIX_FMT_FLAG_SET_CSC``
227       - 0x00000002
228       - Set by the application. It is only used for capture and is
230 	colorspace conversion from the received colorspace to the requested
240 	pixel format, see :ref:`fmtdesc-flags`.