[mirror_ubuntu-eoan-kernel.git] / Documentation / media / uapi / v4l / pixfmt-reserved.rst

.. -*- coding: utf-8; mode: rst -*-

.. _pixfmt-reserved:

***************************
Reserved Format Identifiers
***************************

These formats are not defined by this specification, they are just
listed for reference and to avoid naming conflicts. If you want to
register your own format, send an e-mail to the linux-media mailing list
`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__
for inclusion in the ``videodev2.h`` file. If you want to share your
format with other developers add a link to your documentation and send a
copy to the linux-media mailing list for inclusion in this section. If
you think your format should be listed in a standard format section
please make a proposal on the linux-media mailing list.


.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|

.. _reserved-formats:

.. flat-table:: Reserved Image Formats
    :header-rows:  1
    :stub-columns: 0
    :widths:       3 1 4

    * - Identifier
      - Code
      - Details
    * .. _V4L2-PIX-FMT-DV:

      - ``V4L2_PIX_FMT_DV``
      - 'dvsd'
      - unknown
    * .. _V4L2-PIX-FMT-ET61X251:

      - ``V4L2_PIX_FMT_ET61X251``
      - 'E625'
      - Compressed format of the ET61X251 driver.
    * .. _V4L2-PIX-FMT-HI240:

      - ``V4L2_PIX_FMT_HI240``
      - 'HI24'
      - 8 bit RGB format used by the BTTV driver.
    * .. _V4L2-PIX-FMT-HM12:

      - ``V4L2_PIX_FMT_HM12``
      - 'HM12'
      - YUV 4:2:0 format used by the IVTV driver,
	`http://www.ivtvdriver.org/ <http://www.ivtvdriver.org/>`__

	The format is documented in the kernel sources in the file
	``Documentation/media/v4l-drivers/cx2341x.rst``
    * .. _V4L2-PIX-FMT-CPIA1:

      - ``V4L2_PIX_FMT_CPIA1``
      - 'CPIA'
      - YUV format used by the gspca cpia1 driver.
    * .. _V4L2-PIX-FMT-JPGL:

      - ``V4L2_PIX_FMT_JPGL``
      - 'JPGL'
      - JPEG-Light format (Pegasus Lossless JPEG) used in Divio webcams NW
	80x.
    * .. _V4L2-PIX-FMT-SPCA501:

      - ``V4L2_PIX_FMT_SPCA501``
      - 'S501'
      - YUYV per line used by the gspca driver.
    * .. _V4L2-PIX-FMT-SPCA505:

      - ``V4L2_PIX_FMT_SPCA505``
      - 'S505'
      - YYUV per line used by the gspca driver.
    * .. _V4L2-PIX-FMT-SPCA508:

      - ``V4L2_PIX_FMT_SPCA508``
      - 'S508'
      - YUVY per line used by the gspca driver.
    * .. _V4L2-PIX-FMT-SPCA561:

      - ``V4L2_PIX_FMT_SPCA561``
      - 'S561'
      - Compressed GBRG Bayer format used by the gspca driver.
    * .. _V4L2-PIX-FMT-PAC207:

      - ``V4L2_PIX_FMT_PAC207``
      - 'P207'
      - Compressed BGGR Bayer format used by the gspca driver.
    * .. _V4L2-PIX-FMT-MR97310A:

      - ``V4L2_PIX_FMT_MR97310A``
      - 'M310'
      - Compressed BGGR Bayer format used by the gspca driver.
    * .. _V4L2-PIX-FMT-JL2005BCD:

      - ``V4L2_PIX_FMT_JL2005BCD``
      - 'JL20'
      - JPEG compressed RGGB Bayer format used by the gspca driver.
    * .. _V4L2-PIX-FMT-OV511:

      - ``V4L2_PIX_FMT_OV511``
      - 'O511'
      - OV511 JPEG format used by the gspca driver.
    * .. _V4L2-PIX-FMT-OV518:

      - ``V4L2_PIX_FMT_OV518``
      - 'O518'
      - OV518 JPEG format used by the gspca driver.
    * .. _V4L2-PIX-FMT-PJPG:

      - ``V4L2_PIX_FMT_PJPG``
      - 'PJPG'
      - Pixart 73xx JPEG format used by the gspca driver.
    * .. _V4L2-PIX-FMT-SE401:

      - ``V4L2_PIX_FMT_SE401``
      - 'S401'
      - Compressed RGB format used by the gspca se401 driver
    * .. _V4L2-PIX-FMT-SQ905C:

      - ``V4L2_PIX_FMT_SQ905C``
      - '905C'
      - Compressed RGGB bayer format used by the gspca driver.
    * .. _V4L2-PIX-FMT-MJPEG:

      - ``V4L2_PIX_FMT_MJPEG``
      - 'MJPG'
      - Compressed format used by the Zoran driver
    * .. _V4L2-PIX-FMT-PWC1:

      - ``V4L2_PIX_FMT_PWC1``
      - 'PWC1'
      - Compressed format of the PWC driver.
    * .. _V4L2-PIX-FMT-PWC2:

      - ``V4L2_PIX_FMT_PWC2``
      - 'PWC2'
      - Compressed format of the PWC driver.
    * .. _V4L2-PIX-FMT-SN9C10X:

      - ``V4L2_PIX_FMT_SN9C10X``
      - 'S910'
      - Compressed format of the SN9C102 driver.
    * .. _V4L2-PIX-FMT-SN9C20X-I420:

      - ``V4L2_PIX_FMT_SN9C20X_I420``
      - 'S920'
      - YUV 4:2:0 format of the gspca sn9c20x driver.
    * .. _V4L2-PIX-FMT-SN9C2028:

      - ``V4L2_PIX_FMT_SN9C2028``
      - 'SONX'
      - Compressed GBRG bayer format of the gspca sn9c2028 driver.
    * .. _V4L2-PIX-FMT-STV0680:

      - ``V4L2_PIX_FMT_STV0680``
      - 'S680'
      - Bayer format of the gspca stv0680 driver.
    * .. _V4L2-PIX-FMT-WNVA:

      - ``V4L2_PIX_FMT_WNVA``
      - 'WNVA'
      - Used by the Winnov Videum driver,
	`http://www.thedirks.org/winnov/ <http://www.thedirks.org/winnov/>`__
    * .. _V4L2-PIX-FMT-TM6000:

      - ``V4L2_PIX_FMT_TM6000``
      - 'TM60'
      - Used by Trident tm6000
    * .. _V4L2-PIX-FMT-CIT-YYVYUY:

      - ``V4L2_PIX_FMT_CIT_YYVYUY``
      - 'CITV'
      - Used by xirlink CIT, found at IBM webcams.

	Uses one line of Y then 1 line of VYUY
    * .. _V4L2-PIX-FMT-KONICA420:

      - ``V4L2_PIX_FMT_KONICA420``
      - 'KONI'
      - Used by Konica webcams.

	YUV420 planar in blocks of 256 pixels.
    * .. _V4L2-PIX-FMT-YYUV:

      - ``V4L2_PIX_FMT_YYUV``
      - 'YYUV'
      - unknown
    * .. _V4L2-PIX-FMT-Y4:

      - ``V4L2_PIX_FMT_Y4``
      - 'Y04 '
      - Old 4-bit greyscale format. Only the most significant 4 bits of
	each byte are used, the other bits are set to 0.
    * .. _V4L2-PIX-FMT-Y6:

      - ``V4L2_PIX_FMT_Y6``
      - 'Y06 '
      - Old 6-bit greyscale format. Only the most significant 6 bits of
	each byte are used, the other bits are set to 0.
    * .. _V4L2-PIX-FMT-S5C-UYVY-JPG:

      - ``V4L2_PIX_FMT_S5C_UYVY_JPG``
      - 'S5CI'
      - Two-planar format used by Samsung S5C73MX cameras. The first plane
	contains interleaved JPEG and UYVY image data, followed by meta
	data in form of an array of offsets to the UYVY data blocks. The
	actual pointer array follows immediately the interleaved JPEG/UYVY
	data, the number of entries in this array equals the height of the
	UYVY image. Each entry is a 4-byte unsigned integer in big endian
	order and it's an offset to a single pixel line of the UYVY image.
	The first plane can start either with JPEG or UYVY data chunk. The
	size of a single UYVY block equals the UYVY image's width
	multiplied by 2. The size of a JPEG chunk depends on the image and
	can vary with each line.

	The second plane, at an offset of 4084 bytes, contains a 4-byte
	offset to the pointer array in the first plane. This offset is
	followed by a 4-byte value indicating size of the pointer array.
	All numbers in the second plane are also in big endian order.
	Remaining data in the second plane is undefined. The information
	in the second plane allows to easily find location of the pointer
	array, which can be different for each frame. The size of the
	pointer array is constant for given UYVY image height.

	In order to extract UYVY and JPEG frames an application can
	initially set a data pointer to the start of first plane and then
	add an offset from the first entry of the pointers table. Such a
	pointer indicates start of an UYVY image pixel line. Whole UYVY
	line can be copied to a separate buffer. These steps should be
	repeated for each line, i.e. the number of entries in the pointer
	array. Anything what's in between the UYVY lines is JPEG data and
	should be concatenated to form the JPEG stream.
    * .. _V4L2-PIX-FMT-MT21C:

      - ``V4L2_PIX_FMT_MT21C``
      - 'MT21'
      - Compressed two-planar YVU420 format used by Mediatek MT8173.
	The compression is lossless.
	It is an opaque intermediate format and the MDP hardware must be
	used to convert ``V4L2_PIX_FMT_MT21C`` to ``V4L2_PIX_FMT_NV12M``,
	``V4L2_PIX_FMT_YUV420M`` or ``V4L2_PIX_FMT_YVU420``.


.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|

.. _format-flags:

.. flat-table:: Format Flags
    :header-rows:  0
    :stub-columns: 0
    :widths:       3 1 4

    * - ``V4L2_PIX_FMT_FLAG_PREMUL_ALPHA``
      - 0x00000001
      - The color values are premultiplied by the alpha channel value. For
	example, if a light blue pixel with 50% transparency was described
	by RGBA values (128, 192, 255, 128), the same pixel described with
	premultiplied colors would be described by RGBA values (64, 96,
	128, 128)
Commit	Line	Data
5377d91f MH	1	.. -- coding: utf-8; mode: rst --
	2
	3	.. _pixfmt-reserved:
	4
	5	***************************
	6	Reserved Format Identifiers
	7	***************************
	8
	9	These formats are not defined by this specification, they are just
	10	listed for reference and to avoid naming conflicts. If you want to
	11	register your own format, send an e-mail to the linux-media mailing list
	12	`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__
	13	for inclusion in the ``videodev2.h`` file. If you want to share your
	14	format with other developers add a link to your documentation and send a
	15	copy to the linux-media mailing list for inclusion in this section. If
	16	you think your format should be listed in a standard format section
	17	please make a proposal on the linux-media mailing list.
	18
	19
5bd4bb78 MCC	20	.. tabularcolumns:: \|p{6.6cm}\|p{2.2cm}\|p{8.7cm}\|
5bd4bb78 MCC	21
fa92b04d MCC	22	.. _reserved-formats:
fa92b04d MCC	23
5377d91f MH	24	.. flat-table:: Reserved Image Formats
	25	:header-rows: 1
	26	:stub-columns: 0
	27	:widths: 3 1 4
	28
c2b66caf LP	29	* - Identifier
	30	- Code
	31	- Details
	32	* .. _V4L2-PIX-FMT-DV:
	33
	34	- ``V4L2_PIX_FMT_DV``
	35	- 'dvsd'
	36	- unknown
	37	* .. _V4L2-PIX-FMT-ET61X251:
	38
	39	- ``V4L2_PIX_FMT_ET61X251``
	40	- 'E625'
	41	- Compressed format of the ET61X251 driver.
	42	* .. _V4L2-PIX-FMT-HI240:
	43
	44	- ``V4L2_PIX_FMT_HI240``
	45	- 'HI24'
	46	- 8 bit RGB format used by the BTTV driver.
	47	* .. _V4L2-PIX-FMT-HM12:
	48
	49	- ``V4L2_PIX_FMT_HM12``
	50	- 'HM12'
	51	- YUV 4:2:0 format used by the IVTV driver,
	52	`http://www.ivtvdriver.org/ <http://www.ivtvdriver.org/>`__
	53
	54	The format is documented in the kernel sources in the file
a405ed85	55	``Documentation/media/v4l-drivers/cx2341x.rst``
c2b66caf LP	56	* .. _V4L2-PIX-FMT-CPIA1:
	57
	58	- ``V4L2_PIX_FMT_CPIA1``
	59	- 'CPIA'
	60	- YUV format used by the gspca cpia1 driver.
	61	* .. _V4L2-PIX-FMT-JPGL:
	62
	63	- ``V4L2_PIX_FMT_JPGL``
	64	- 'JPGL'
	65	- JPEG-Light format (Pegasus Lossless JPEG) used in Divio webcams NW
	66	80x.
	67	* .. _V4L2-PIX-FMT-SPCA501:
	68
	69	- ``V4L2_PIX_FMT_SPCA501``
	70	- 'S501'
	71	- YUYV per line used by the gspca driver.
	72	* .. _V4L2-PIX-FMT-SPCA505:
	73
	74	- ``V4L2_PIX_FMT_SPCA505``
	75	- 'S505'
	76	- YYUV per line used by the gspca driver.
	77	* .. _V4L2-PIX-FMT-SPCA508:
	78
	79	- ``V4L2_PIX_FMT_SPCA508``
	80	- 'S508'
	81	- YUVY per line used by the gspca driver.
	82	* .. _V4L2-PIX-FMT-SPCA561:
	83
	84	- ``V4L2_PIX_FMT_SPCA561``
	85	- 'S561'
	86	- Compressed GBRG Bayer format used by the gspca driver.
	87	* .. _V4L2-PIX-FMT-PAC207:
	88
	89	- ``V4L2_PIX_FMT_PAC207``
	90	- 'P207'
	91	- Compressed BGGR Bayer format used by the gspca driver.
	92	* .. _V4L2-PIX-FMT-MR97310A:
	93
	94	- ``V4L2_PIX_FMT_MR97310A``
	95	- 'M310'
	96	- Compressed BGGR Bayer format used by the gspca driver.
	97	* .. _V4L2-PIX-FMT-JL2005BCD:
	98
	99	- ``V4L2_PIX_FMT_JL2005BCD``
	100	- 'JL20'
	101	- JPEG compressed RGGB Bayer format used by the gspca driver.
	102	* .. _V4L2-PIX-FMT-OV511:
	103
	104	- ``V4L2_PIX_FMT_OV511``
	105	- 'O511'
	106	- OV511 JPEG format used by the gspca driver.
	107	* .. _V4L2-PIX-FMT-OV518:
	108
	109	- ``V4L2_PIX_FMT_OV518``
	110	- 'O518'
	111	- OV518 JPEG format used by the gspca driver.
	112	* .. _V4L2-PIX-FMT-PJPG:
	113
	114	- ``V4L2_PIX_FMT_PJPG``
	115	- 'PJPG'
	116	- Pixart 73xx JPEG format used by the gspca driver.
	117	* .. _V4L2-PIX-FMT-SE401:
	118
	119	- ``V4L2_PIX_FMT_SE401``
120	- 'S401'
121	- Compressed RGB format used by the gspca se401 driver
122	* .. _V4L2-PIX-FMT-SQ905C:
123
124	- ``V4L2_PIX_FMT_SQ905C``
125	- '905C'
126	- Compressed RGGB bayer format used by the gspca driver.
127	* .. _V4L2-PIX-FMT-MJPEG:
128
129	- ``V4L2_PIX_FMT_MJPEG``
130	- 'MJPG'
131	- Compressed format used by the Zoran driver
132	* .. _V4L2-PIX-FMT-PWC1:
133
134	- ``V4L2_PIX_FMT_PWC1``
135	- 'PWC1'
136	- Compressed format of the PWC driver.
137	* .. _V4L2-PIX-FMT-PWC2:
138
139	- ``V4L2_PIX_FMT_PWC2``
140	- 'PWC2'
141	- Compressed format of the PWC driver.
142	* .. _V4L2-PIX-FMT-SN9C10X:
143
144	- ``V4L2_PIX_FMT_SN9C10X``
145	- 'S910'
146	- Compressed format of the SN9C102 driver.
147	* .. _V4L2-PIX-FMT-SN9C20X-I420:
148
149	- ``V4L2_PIX_FMT_SN9C20X_I420``
150	- 'S920'
151	- YUV 4:2:0 format of the gspca sn9c20x driver.
152	* .. _V4L2-PIX-FMT-SN9C2028:
153
154	- ``V4L2_PIX_FMT_SN9C2028``
155	- 'SONX'
156	- Compressed GBRG bayer format of the gspca sn9c2028 driver.
157	* .. _V4L2-PIX-FMT-STV0680:
158
159	- ``V4L2_PIX_FMT_STV0680``
160	- 'S680'
161	- Bayer format of the gspca stv0680 driver.
162	* .. _V4L2-PIX-FMT-WNVA:
163
164	- ``V4L2_PIX_FMT_WNVA``
165	- 'WNVA'
166	- Used by the Winnov Videum driver,
167	`http://www.thedirks.org/winnov/ <http://www.thedirks.org/winnov/>`__
168	* .. _V4L2-PIX-FMT-TM6000:
169
170	- ``V4L2_PIX_FMT_TM6000``
171	- 'TM60'
172	- Used by Trident tm6000
173	* .. _V4L2-PIX-FMT-CIT-YYVYUY:
174
175	- ``V4L2_PIX_FMT_CIT_YYVYUY``
176	- 'CITV'
177	- Used by xirlink CIT, found at IBM webcams.
178
179	Uses one line of Y then 1 line of VYUY
180	* .. _V4L2-PIX-FMT-KONICA420:
181
182	- ``V4L2_PIX_FMT_KONICA420``
183	- 'KONI'
184	- Used by Konica webcams.
185
186	YUV420 planar in blocks of 256 pixels.
187	* .. _V4L2-PIX-FMT-YYUV:
188
189	- ``V4L2_PIX_FMT_YYUV``
190	- 'YYUV'
191	- unknown
192	* .. _V4L2-PIX-FMT-Y4:
193
194	- ``V4L2_PIX_FMT_Y4``
195	- 'Y04 '
196	- Old 4-bit greyscale format. Only the most significant 4 bits of
197	each byte are used, the other bits are set to 0.
198	* .. _V4L2-PIX-FMT-Y6:
199
200	- ``V4L2_PIX_FMT_Y6``
201	- 'Y06 '
202	- Old 6-bit greyscale format. Only the most significant 6 bits of
203	each byte are used, the other bits are set to 0.
204	* .. _V4L2-PIX-FMT-S5C-UYVY-JPG:
205
206	- ``V4L2_PIX_FMT_S5C_UYVY_JPG``
207	- 'S5CI'
208	- Two-planar format used by Samsung S5C73MX cameras. The first plane
209	contains interleaved JPEG and UYVY image data, followed by meta
210	data in form of an array of offsets to the UYVY data blocks. The
211	actual pointer array follows immediately the interleaved JPEG/UYVY
212	data, the number of entries in this array equals the height of the
213	UYVY image. Each entry is a 4-byte unsigned integer in big endian
214	order and it's an offset to a single pixel line of the UYVY image.
215	The first plane can start either with JPEG or UYVY data chunk. The
216	size of a single UYVY block equals the UYVY image's width
217	multiplied by 2. The size of a JPEG chunk depends on the image and
218	can vary with each line.
219
220	The second plane, at an offset of 4084 bytes, contains a 4-byte
221	offset to the pointer array in the first plane. This offset is
222	followed by a 4-byte value indicating size of the pointer array.
223	All numbers in the second plane are also in big endian order.
224	Remaining data in the second plane is undefined. The information
225	in the second plane allows to easily find location of the pointer
226	array, which can be different for each frame. The size of the
227	pointer array is constant for given UYVY image height.
228
229	In order to extract UYVY and JPEG frames an application can
230	initially set a data pointer to the start of first plane and then
231	add an offset from the first entry of the pointers table. Such a
232	pointer indicates start of an UYVY image pixel line. Whole UYVY
233	line can be copied to a separate buffer. These steps should be
234	repeated for each line, i.e. the number of entries in the pointer
235	array. Anything what's in between the UYVY lines is JPEG data and
236	should be concatenated to form the JPEG stream.
a38b7ce9 TL	237	* .. _V4L2-PIX-FMT-MT21C:
	238
	239	- ``V4L2_PIX_FMT_MT21C``
a0345caf	240	- 'MT21'
a38b7ce9	241	- Compressed two-planar YVU420 format used by Mediatek MT8173.
a0345caf HV	242	The compression is lossless.
	243	It is an opaque intermediate format and the MDP hardware must be
	244	used to convert ``V4L2_PIX_FMT_MT21C`` to ``V4L2_PIX_FMT_NV12M``,
	245	``V4L2_PIX_FMT_YUV420M`` or ``V4L2_PIX_FMT_YVU420``.
5377d91f MH	246
5377d91f MH	247
5bd4bb78 MCC	248	.. tabularcolumns:: \|p{6.6cm}\|p{2.2cm}\|p{8.7cm}\|
5bd4bb78 MCC	249
fa92b04d MCC	250	.. _format-flags:
fa92b04d MCC	251
5377d91f MH	252	.. flat-table:: Format Flags
	253	:header-rows: 0
	254	:stub-columns: 0
	255	:widths: 3 1 4
	256
c2b66caf LP	257	* - ``V4L2_PIX_FMT_FLAG_PREMUL_ALPHA``
	258	- 0x00000001
	259	- The color values are premultiplied by the alpha channel value. For
	260	example, if a light blue pixel with 50% transparency was described
	261	by RGBA values (128, 192, 255, 128), the same pixel described with
	262	premultiplied colors would be described by RGBA values (64, 96,
	263	128, 128)