X-Git-Url: https://git.openpandora.org/cgi-bin/gitweb.cgi?p=pandora-kernel.git;a=blobdiff_plain;f=Documentation%2FDocBook%2Fv4l%2Fpixfmt.xml;h=c6fdcbbd1b41dc7adbffc0011ac34a291b503509;hp=cfffc88d7383f4dc14b409f03e13964859af4c61;hb=9f34217c846a96dea03f4418e2f27423658d3542;hpb=e11d57ca0b6dada29007ce3ad3db6c84034a768f
diff --git a/Documentation/DocBook/v4l/pixfmt.xml b/Documentation/DocBook/v4l/pixfmt.xml
index cfffc88d7383..c6fdcbbd1b41 100644
--- a/Documentation/DocBook/v4l/pixfmt.xml
+++ b/Documentation/DocBook/v4l/pixfmt.xml
@@ -2,12 +2,16 @@
The V4L2 API was primarily designed for devices exchanging
image data with applications. The
-v4l2_pix_format structure defines the format
-and layout of an image in memory. Image formats are negotiated with
-the &VIDIOC-S-FMT; ioctl. (The explanations here focus on video
+v4l2_pix_format and v4l2_pix_format_mplane
+ structures define the format and layout of an image in memory.
+The former is used with the single-planar API, while the latter is used with the
+multi-planar version (see ). Image formats are
+negotiated with the &VIDIOC-S-FMT; ioctl. (The explanations here focus on video
capturing and output, for overlay frame buffer formats see also
&VIDIOC-G-FBUF;.)
+
+ Single-planar format structure
struct <structname>v4l2_pix_format</structname>
@@ -106,6 +110,98 @@ set this field to zero.
+
+
+
+ Multi-planar format structures
+ The v4l2_plane_pix_format structures define
+ size and layout for each of the planes in a multi-planar format.
+ The v4l2_pix_format_mplane structure contains
+ information common to all planes (such as image width and height) and
+ an array of v4l2_plane_pix_format structures,
+ describing all planes of that format.
+
+ struct <structname>vl42_plane_pix_format</structname>
+
+ &cs-str;
+
+
+ __u32
+ sizeimage
+ Maximum size in bytes required for image data in this plane.
+
+
+
+ __u16
+ bytesperline
+ Distance in bytes between the leftmost pixels in two adjacent
+ lines.
+
+
+ __u16
+ reserved[7]
+ Reserved for future extensions. Should be zeroed by the
+ application.
+
+
+
+
+
+ struct <structname>v4l2_pix_format_mplane</structname>
+
+ &cs-str;
+
+
+ __u32
+ width
+ Image width in pixels.
+
+
+ __u32
+ height
+ Image height in pixels.
+
+
+ __u32
+ pixelformat
+ The pixel format. Both single- and multi-planar four character
+codes can be used.
+
+
+ &v4l2-field;
+ field
+ See &v4l2-pix-format;.
+
+
+ &v4l2-colorspace;
+ colorspace
+ See &v4l2-pix-format;.
+
+
+ &v4l2-plane-pix-format;
+ plane_fmt[VIDEO_MAX_PLANES]
+ An array of structures describing format of each plane this
+ pixel format consists of. The number of valid entries in this array
+ has to be put in the num_planes
+ field.
+
+
+ __u8
+ num_planes
+ Number of planes (i.e. separate memory buffers) for this format
+ and the number of valid entries in the
+ plane_fmt array.
+
+
+ __u8
+ reserved[11]
+ Reserved for future extensions. Should be zeroed by the
+ application.
+
+
+
+
+Standard Image Formats
@@ -142,11 +238,19 @@ leftmost pixel of the second row from the top, and so on. The last row
has just as many pad bytes after it as the other rows.
In V4L2 each format has an identifier which looks like
-PIX_FMT_XXX, defined in the videodev2.h
-header file. These identifiers
-represent four character codes
+PIX_FMT_XXX, defined in the videodev.h header file. These identifiers
+represent four character (FourCC) codes
which are also listed below, however they are not the same as those
used in the Windows world.
+
+ For some formats, data is stored in separate, discontiguous
+memory buffers. Those formats are identified by a separate set of FourCC codes
+and are referred to as "multi-planar formats". For example, a YUV422 frame is
+normally stored in one memory buffer, but it can also be placed in two or three
+separate buffers, with Y component in one buffer and CbCr components in another
+in the 2-planar version or with each component in its own buffer in the
+3-planar case. Those sub-buffers are referred to as "planes".
@@ -599,10 +703,13 @@ information.
&sub-vyuy;
&sub-y41p;
&sub-yuv420;
+ &sub-yuv420m;
&sub-yuv410;
&sub-yuv422p;
&sub-yuv411p;
&sub-nv12;
+ &sub-nv12m;
+ &sub-nv12mt;
&sub-nv16;