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