Commit 8aeec38f authored by Laurent Pinchart's avatar Laurent Pinchart Committed by Mauro Carvalho Chehab
Browse files

[media] v4l: Merge the YUV and YVU 4:2:0 tri-planar non-contiguous formats docs 



The two formats are very similar, having two separate pages to describe
them is overkill.

Signed-off-by: default avatarLaurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Acked-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 417b5523

Documentation/DocBook/media/v4l/pixfmt-yuv420m.xml

+17 −9
Original line number Diff line number Diff line 
    <refentry id="V4L2-PIX-FMT-YUV420M">

    <refentry>

      <refmeta>

	<refentrytitle>V4L2_PIX_FMT_YUV420M ('YM12')</refentrytitle>

	<refentrytitle>V4L2_PIX_FMT_YUV420M ('YM12'), V4L2_PIX_FMT_YVU420M ('YM21')</refentrytitle>

	&manvol;

      </refmeta>

      <refnamediv>

	<refname> <constant>V4L2_PIX_FMT_YUV420M</constant></refname>

	<refpurpose>Variation of <constant>V4L2_PIX_FMT_YUV420</constant>

	  with planes non contiguous in memory. </refpurpose>

	<refname id="V4L2-PIX-FMT-YUV420M"><constant>V4L2_PIX_FMT_YUV420M</constant></refname>

	<refname id="V4L2-PIX-FMT-YVU420M"><constant>V4L2_PIX_FMT_YVU420M</constant></refname>

	<refpurpose>Variation of <constant>V4L2_PIX_FMT_YUV420</constant> and

	  <constant>V4L2_PIX_FMT_YVU420</constant> with planes non contiguous

	  in memory.</refpurpose>

      </refnamediv>



      <refsect1>

	<title>Description</title>



	<para>This is a multi-planar format, as opposed to a packed format.

The three components are separated into three sub- images or planes.

The three components are separated into three sub-images or planes.</para>



The Y plane is first. The Y plane has one byte per pixel. The Cb data

	<para>The Y plane is first. The Y plane has one byte per pixel.

For <constant>V4L2_PIX_FMT_YUV420M</constant> the Cb data

constitutes the second plane which is half the width and half

the height of the Y plane (and of the image). Each Cb belongs to four

pixels, a two-by-two square of the image. For example,
@@ -24,12 +27,17 @@ Y'<subscript>01</subscript>, Y'<subscript>10</subscript>, and 
Y'<subscript>11</subscript>. The Cr data, just like the Cb plane, is

in the third plane.</para>



	<para><constant>V4L2_PIX_FMT_YVU420M</constant> is the same except

the Cr data is stored in the second plane and the Cb data in the third plane.

</para>



	<para>If the Y plane has pad bytes after each row, then the Cb

and Cr planes have half as many pad bytes after their rows. In other

words, two Cx rows (including padding) is exactly as long as one Y row

(including padding).</para>



	<para><constant>V4L2_PIX_FMT_YUV420M</constant> is intended to be

	<para><constant>V4L2_PIX_FMT_YUV420M</constant> and

<constant>V4L2_PIX_FMT_YVU420M</constant> are intended to be

used only in drivers and applications that support the multi-planar API,

described in <xref linkend="planar-apis"/>. </para>

Documentation/DocBook/media/v4l/pixfmt-yvu420m.xml

deleted100644 → 0
+0 −154
Original line number Diff line number Diff line 
    <refentry id="V4L2-PIX-FMT-YVU420M">

      <refmeta>

	<refentrytitle>V4L2_PIX_FMT_YVU420M ('YM21')</refentrytitle>

	&manvol;

      </refmeta>

      <refnamediv>

	<refname> <constant>V4L2_PIX_FMT_YVU420M</constant></refname>

	<refpurpose>Variation of <constant>V4L2_PIX_FMT_YVU420</constant>

	  with planes non contiguous in memory. </refpurpose>

      </refnamediv>



      <refsect1>

	<title>Description</title>



	<para>This is a multi-planar format, as opposed to a packed format.

The three components are separated into three sub-images or planes.



The Y plane is first. The Y plane has one byte per pixel. The Cr data

constitutes the second plane which is half the width and half

the height of the Y plane (and of the image). Each Cr belongs to four

pixels, a two-by-two square of the image. For example,

Cr<subscript>0</subscript> belongs to Y'<subscript>00</subscript>,

Y'<subscript>01</subscript>, Y'<subscript>10</subscript>, and

Y'<subscript>11</subscript>. The Cb data, just like the Cr plane, constitutes

the third plane. </para>



	<para>If the Y plane has pad bytes after each row, then the Cr

and Cb planes have half as many pad bytes after their rows. In other

words, two Cx rows (including padding) is exactly as long as one Y row

(including padding).</para>



	<para><constant>V4L2_PIX_FMT_YVU420M</constant> is intended to be

used only in drivers and applications that support the multi-planar API,

described in <xref linkend="planar-apis"/>. </para>



	<example>

	  <title><constant>V4L2_PIX_FMT_YVU420M</constant> 4 &times; 4

pixel image</title>



	  <formalpara>

	    <title>Byte Order.</title>

	    <para>Each cell is one byte.

		<informaltable frame="none">

		<tgroup cols="5" align="center">

		  <colspec align="left" colwidth="2*" />

		  <tbody valign="top">

		    <row>

		      <entry>start0&nbsp;+&nbsp;0:</entry>

		      <entry>Y'<subscript>00</subscript></entry>

		      <entry>Y'<subscript>01</subscript></entry>

		      <entry>Y'<subscript>02</subscript></entry>

		      <entry>Y'<subscript>03</subscript></entry>

		    </row>

		    <row>

		      <entry>start0&nbsp;+&nbsp;4:</entry>

		      <entry>Y'<subscript>10</subscript></entry>

		      <entry>Y'<subscript>11</subscript></entry>

		      <entry>Y'<subscript>12</subscript></entry>

		      <entry>Y'<subscript>13</subscript></entry>

		    </row>

		    <row>

		      <entry>start0&nbsp;+&nbsp;8:</entry>

		      <entry>Y'<subscript>20</subscript></entry>

		      <entry>Y'<subscript>21</subscript></entry>

		      <entry>Y'<subscript>22</subscript></entry>

		      <entry>Y'<subscript>23</subscript></entry>

		    </row>

		    <row>

		      <entry>start0&nbsp;+&nbsp;12:</entry>

		      <entry>Y'<subscript>30</subscript></entry>

		      <entry>Y'<subscript>31</subscript></entry>

		      <entry>Y'<subscript>32</subscript></entry>

		      <entry>Y'<subscript>33</subscript></entry>

		    </row>

		    <row><entry></entry></row>

		    <row>

		      <entry>start1&nbsp;+&nbsp;0:</entry>

		      <entry>Cr<subscript>00</subscript></entry>

		      <entry>Cr<subscript>01</subscript></entry>

		    </row>

		    <row>

		      <entry>start1&nbsp;+&nbsp;2:</entry>

		      <entry>Cr<subscript>10</subscript></entry>

		      <entry>Cr<subscript>11</subscript></entry>

		    </row>

		    <row><entry></entry></row>

		    <row>

		      <entry>start2&nbsp;+&nbsp;0:</entry>

		      <entry>Cb<subscript>00</subscript></entry>

		      <entry>Cb<subscript>01</subscript></entry>

		    </row>

		    <row>

		      <entry>start2&nbsp;+&nbsp;2:</entry>

		      <entry>Cb<subscript>10</subscript></entry>

		      <entry>Cb<subscript>11</subscript></entry>

		    </row>

		  </tbody>

		</tgroup>

		</informaltable>

	      </para>

	  </formalpara>



	  <formalpara>

	    <title>Color Sample Location.</title>

	    <para>

		<informaltable frame="none">

		<tgroup cols="7" align="center">

		  <tbody valign="top">

		    <row>

		      <entry></entry>

		      <entry>0</entry><entry></entry><entry>1</entry><entry></entry>

		      <entry>2</entry><entry></entry><entry>3</entry>

		    </row>

		    <row>

		      <entry>0</entry>

		      <entry>Y</entry><entry></entry><entry>Y</entry><entry></entry>

		      <entry>Y</entry><entry></entry><entry>Y</entry>

		    </row>

		    <row>

		      <entry></entry>

		      <entry></entry><entry>C</entry><entry></entry><entry></entry>

		      <entry></entry><entry>C</entry><entry></entry>

		    </row>

		    <row>

		      <entry>1</entry>

		      <entry>Y</entry><entry></entry><entry>Y</entry><entry></entry>

		      <entry>Y</entry><entry></entry><entry>Y</entry>

		    </row>

		    <row>

		      <entry></entry>

		    </row>

		    <row>

		      <entry>2</entry>

		      <entry>Y</entry><entry></entry><entry>Y</entry><entry></entry>

		      <entry>Y</entry><entry></entry><entry>Y</entry>

		    </row>

		    <row>

		      <entry></entry>

		      <entry></entry><entry>C</entry><entry></entry><entry></entry>

		      <entry></entry><entry>C</entry><entry></entry>

		    </row>

		    <row>

		      <entry>3</entry>

		      <entry>Y</entry><entry></entry><entry>Y</entry><entry></entry>

		      <entry>Y</entry><entry></entry><entry>Y</entry>

		    </row>

		  </tbody>

		</tgroup>

		</informaltable>

	      </para>

	  </formalpara>

	</example>

      </refsect1>

    </refentry>

Documentation/DocBook/media/v4l/pixfmt.xml

+0 −1
Original line number Diff line number Diff line
@@ -1628,7 +1628,6 @@ information.</para> 
    &sub-y41p;

    &sub-yuv420;

    &sub-yuv420m;

    &sub-yvu420m;

    &sub-yuv410;

    &sub-yuv422p;

    &sub-yuv411p;

CRA Git | Maintained and supported by SUSTech CRA and CCSE