1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>Multi-planar format structures</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="LINUX MEDIA INFRASTRUCTURE API"><link rel="up" href="pixfmt.html" title="Chapter 2. Image Formats"><link rel="prev" href="pixfmt.html" title="Chapter 2. Image Formats"><link rel="next" href="ch02s03.html" title="Standard Image Formats"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Multi-planar format structures</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="pixfmt.html">Prev</a> </td><th width="60%" align="center">Chapter 2. Image Formats</th><td width="20%" align="right"> <a accesskey="n" href="ch02s03.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1100421764"></a>Multi-planar format structures</h2></div></div></div><p>The <span class="structname">v4l2_plane_pix_format</span> structures define 2 size and layout for each of the planes in a multi-planar format. 3 The <span class="structname">v4l2_pix_format_mplane</span> structure contains 4 information common to all planes (such as image width and height) and 5 an array of <span class="structname">v4l2_plane_pix_format</span> structures, 6 describing all planes of that format.</p><div class="table"><a name="v4l2-plane-pix-format"></a><p class="title"><b>Table 2.2. struct <span class="structname">v4l2_plane_pix_format</span></b></p><div class="table-contents"><table summary="struct v4l2_plane_pix_format" width="100%" border="0"><colgroup><col class="c1"><col class="c2"><col class="c3"></colgroup><tbody valign="top"><tr><td valign="top">__u32</td><td valign="top"><em class="structfield"><code>sizeimage</code></em></td><td valign="top">Maximum size in bytes required for image data in this plane. 7 </td></tr><tr><td valign="top">__u32</td><td valign="top"><em class="structfield"><code>bytesperline</code></em></td><td valign="top">Distance in bytes between the leftmost pixels in two adjacent 8 lines. See struct <a class="link" href="pixfmt.html#v4l2-pix-format" title="Table 2.1. struct v4l2_pix_format">v4l2_pix_format</a>.</td></tr><tr><td valign="top">__u16</td><td valign="top"><em class="structfield"><code>reserved[6]</code></em></td><td valign="top">Reserved for future extensions. Should be zeroed by the 9 application.</td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="v4l2-pix-format-mplane"></a><p class="title"><b>Table 2.3. struct <span class="structname">v4l2_pix_format_mplane</span></b></p><div class="table-contents"><table summary="struct v4l2_pix_format_mplane" width="100%" border="0"><colgroup><col class="c1"><col class="c2"><col class="c3"></colgroup><tbody valign="top"><tr><td valign="top">__u32</td><td valign="top"><em class="structfield"><code>width</code></em></td><td valign="top">Image width in pixels. See struct <a class="link" href="pixfmt.html#v4l2-pix-format" title="Table 2.1. struct v4l2_pix_format">v4l2_pix_format</a>.</td></tr><tr><td valign="top">__u32</td><td valign="top"><em class="structfield"><code>height</code></em></td><td valign="top">Image height in pixels. See struct <a class="link" href="pixfmt.html#v4l2-pix-format" title="Table 2.1. struct v4l2_pix_format">v4l2_pix_format</a>.</td></tr><tr><td valign="top">__u32</td><td valign="top"><em class="structfield"><code>pixelformat</code></em></td><td valign="top">The pixel format. Both single- and multi-planar four character 10codes can be used.</td></tr><tr><td valign="top">enum <a class="link" href="field-order.html#v4l2-field" title="Table 3.9. enum v4l2_field">v4l2_field</a></td><td valign="top"><em class="structfield"><code>field</code></em></td><td valign="top">See struct <a class="link" href="pixfmt.html#v4l2-pix-format" title="Table 2.1. struct v4l2_pix_format">v4l2_pix_format</a>.</td></tr><tr><td valign="top">enum <a class="link" href="ch02s05.html#v4l2-colorspace" title="Table 2.4. V4L2 Colorspaces">v4l2_colorspace</a></td><td valign="top"><em class="structfield"><code>colorspace</code></em></td><td valign="top">See struct <a class="link" href="pixfmt.html#v4l2-pix-format" title="Table 2.1. struct v4l2_pix_format">v4l2_pix_format</a>.</td></tr><tr><td valign="top">struct <a class="link" href="ch02s02.html#v4l2-plane-pix-format" title="Table 2.2. struct v4l2_plane_pix_format">v4l2_plane_pix_format</a></td><td valign="top"><em class="structfield"><code>plane_fmt[VIDEO_MAX_PLANES]</code></em></td><td valign="top">An array of structures describing format of each plane this 11 pixel format consists of. The number of valid entries in this array 12 has to be put in the <em class="structfield"><code>num_planes</code></em> 13 field.</td></tr><tr><td valign="top">__u8</td><td valign="top"><em class="structfield"><code>num_planes</code></em></td><td valign="top">Number of planes (i.e. separate memory buffers) for this format 14 and the number of valid entries in the 15 <em class="structfield"><code>plane_fmt</code></em> array.</td></tr><tr><td valign="top">__u8</td><td valign="top"><em class="structfield"><code>flags</code></em></td><td valign="top">Flags set by the application or driver, see <a class="xref" href="pixfmt-reserved.html#format-flags" title="Table 2.21. Format Flags">Table 2.21, “Format Flags”</a>.</td></tr><tr><td valign="top">enum <a class="link" href="ch02s05.html#v4l2-ycbcr-encoding" title="Table 2.5. V4L2 Y'CbCr Encodings">v4l2_ycbcr_encoding</a></td><td valign="top"><em class="structfield"><code>ycbcr_enc</code></em></td><td valign="top">This information supplements the 16<em class="structfield"><code>colorspace</code></em> and must be set by the driver for 17capture streams and by the application for output streams, 18see <a class="xref" href="colorspaces.html" title="Colorspaces">the section called “Colorspaces”</a>.</td></tr><tr><td valign="top">enum <a class="link" href="ch02s05.html#v4l2-quantization" title="Table 2.6. V4L2 Quantization Methods">v4l2_quantization</a></td><td valign="top"><em class="structfield"><code>quantization</code></em></td><td valign="top">This information supplements the 19<em class="structfield"><code>colorspace</code></em> and must be set by the driver for 20capture streams and by the application for output streams, 21see <a class="xref" href="colorspaces.html" title="Colorspaces">the section called “Colorspaces”</a>.</td></tr><tr><td valign="top">__u8</td><td valign="top"><em class="structfield"><code>reserved[8]</code></em></td><td valign="top">Reserved for future extensions. Should be zeroed by the 22 application.</td></tr></tbody></table></div></div><br class="table-break"></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="pixfmt.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pixfmt.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. Image Formats </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Standard Image Formats</td></tr></table></div></body></html> 23