1 .. SPDX-License-Identifier: GFDL-1.1-no-invari !! 1 .. Permission is granted to copy, distribute and/or modify this
>> 2 .. document under the terms of the GNU Free Documentation License,
>> 3 .. Version 1.1 or any later version published by the Free Software
>> 4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
>> 5 .. and no Back-Cover Texts. A copy of the license is included at
>> 6 .. Documentation/userspace-api/media/fdl-appendix.rst.
>> 7 ..
>> 8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
2 9
3 .. _pixfmt-reserved: 10 .. _pixfmt-reserved:
4 11
5 *************************** 12 ***************************
6 Reserved Format Identifiers 13 Reserved Format Identifiers
7 *************************** 14 ***************************
8 15
9 These formats are not defined by this specific 16 These formats are not defined by this specification, they are just
10 listed for reference and to avoid naming confl 17 listed for reference and to avoid naming conflicts. If you want to
11 register your own format, send an e-mail to th 18 register your own format, send an e-mail to the linux-media mailing list
12 `https://linuxtv.org/lists.php <https://linuxt 19 `https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__
13 for inclusion in the ``videodev2.h`` file. If 20 for inclusion in the ``videodev2.h`` file. If you want to share your
14 format with other developers add a link to you 21 format with other developers add a link to your documentation and send a
15 copy to the linux-media mailing list for inclu 22 copy to the linux-media mailing list for inclusion in this section. If
16 you think your format should be listed in a st 23 you think your format should be listed in a standard format section
17 please make a proposal on the linux-media mail 24 please make a proposal on the linux-media mailing list.
18 25
19 26
20 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.5cm !! 27 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
21 <<
22 .. raw:: latex <<
23 <<
24 \small <<
25 28
26 .. _reserved-formats: 29 .. _reserved-formats:
27 30
28 .. flat-table:: Reserved Image Formats 31 .. flat-table:: Reserved Image Formats
29 :header-rows: 1 32 :header-rows: 1
30 :stub-columns: 0 33 :stub-columns: 0
31 :widths: 3 1 4 34 :widths: 3 1 4
32 35
33 * - Identifier 36 * - Identifier
34 - Code 37 - Code
35 - Details 38 - Details
36 * .. _V4L2-PIX-FMT-DV: 39 * .. _V4L2-PIX-FMT-DV:
37 40
38 - ``V4L2_PIX_FMT_DV`` 41 - ``V4L2_PIX_FMT_DV``
39 - 'dvsd' 42 - 'dvsd'
40 - unknown 43 - unknown
41 * .. _V4L2-PIX-FMT-ET61X251: 44 * .. _V4L2-PIX-FMT-ET61X251:
42 45
43 - ``V4L2_PIX_FMT_ET61X251`` 46 - ``V4L2_PIX_FMT_ET61X251``
44 - 'E625' 47 - 'E625'
45 - Compressed format of the ET61X251 driv 48 - Compressed format of the ET61X251 driver.
46 * .. _V4L2-PIX-FMT-HI240: 49 * .. _V4L2-PIX-FMT-HI240:
47 50
48 - ``V4L2_PIX_FMT_HI240`` 51 - ``V4L2_PIX_FMT_HI240``
49 - 'HI24' 52 - 'HI24'
50 - 8 bit RGB format used by the BTTV driv 53 - 8 bit RGB format used by the BTTV driver.
>> 54 * .. _V4L2-PIX-FMT-HM12:
>> 55
>> 56 - ``V4L2_PIX_FMT_HM12``
>> 57 - 'HM12'
>> 58 - YUV 4:2:0 format used by the IVTV driver.
>> 59
>> 60 The format is documented in the kernel sources in the file
>> 61 ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst``
51 * .. _V4L2-PIX-FMT-CPIA1: 62 * .. _V4L2-PIX-FMT-CPIA1:
52 63
53 - ``V4L2_PIX_FMT_CPIA1`` 64 - ``V4L2_PIX_FMT_CPIA1``
54 - 'CPIA' 65 - 'CPIA'
55 - YUV format used by the gspca cpia1 dri 66 - YUV format used by the gspca cpia1 driver.
56 * .. _V4L2-PIX-FMT-JPGL: 67 * .. _V4L2-PIX-FMT-JPGL:
57 68
58 - ``V4L2_PIX_FMT_JPGL`` 69 - ``V4L2_PIX_FMT_JPGL``
59 - 'JPGL' 70 - 'JPGL'
60 - JPEG-Light format (Pegasus Lossless JP 71 - JPEG-Light format (Pegasus Lossless JPEG) used in Divio webcams NW
61 80x. 72 80x.
62 * .. _V4L2-PIX-FMT-SPCA501: 73 * .. _V4L2-PIX-FMT-SPCA501:
63 74
64 - ``V4L2_PIX_FMT_SPCA501`` 75 - ``V4L2_PIX_FMT_SPCA501``
65 - 'S501' 76 - 'S501'
66 - YUYV per line used by the gspca driver 77 - YUYV per line used by the gspca driver.
67 * .. _V4L2-PIX-FMT-SPCA505: 78 * .. _V4L2-PIX-FMT-SPCA505:
68 79
69 - ``V4L2_PIX_FMT_SPCA505`` 80 - ``V4L2_PIX_FMT_SPCA505``
70 - 'S505' 81 - 'S505'
71 - YYUV per line used by the gspca driver 82 - YYUV per line used by the gspca driver.
72 * .. _V4L2-PIX-FMT-SPCA508: 83 * .. _V4L2-PIX-FMT-SPCA508:
73 84
74 - ``V4L2_PIX_FMT_SPCA508`` 85 - ``V4L2_PIX_FMT_SPCA508``
75 - 'S508' 86 - 'S508'
76 - YUVY per line used by the gspca driver 87 - YUVY per line used by the gspca driver.
77 * .. _V4L2-PIX-FMT-SPCA561: 88 * .. _V4L2-PIX-FMT-SPCA561:
78 89
79 - ``V4L2_PIX_FMT_SPCA561`` 90 - ``V4L2_PIX_FMT_SPCA561``
80 - 'S561' 91 - 'S561'
81 - Compressed GBRG Bayer format used by t 92 - Compressed GBRG Bayer format used by the gspca driver.
82 * .. _V4L2-PIX-FMT-PAC207: 93 * .. _V4L2-PIX-FMT-PAC207:
83 94
84 - ``V4L2_PIX_FMT_PAC207`` 95 - ``V4L2_PIX_FMT_PAC207``
85 - 'P207' 96 - 'P207'
86 - Compressed BGGR Bayer format used by t 97 - Compressed BGGR Bayer format used by the gspca driver.
87 * .. _V4L2-PIX-FMT-MR97310A: 98 * .. _V4L2-PIX-FMT-MR97310A:
88 99
89 - ``V4L2_PIX_FMT_MR97310A`` 100 - ``V4L2_PIX_FMT_MR97310A``
90 - 'M310' 101 - 'M310'
91 - Compressed BGGR Bayer format used by t 102 - Compressed BGGR Bayer format used by the gspca driver.
92 * .. _V4L2-PIX-FMT-JL2005BCD: 103 * .. _V4L2-PIX-FMT-JL2005BCD:
93 104
94 - ``V4L2_PIX_FMT_JL2005BCD`` 105 - ``V4L2_PIX_FMT_JL2005BCD``
95 - 'JL20' 106 - 'JL20'
96 - JPEG compressed RGGB Bayer format used 107 - JPEG compressed RGGB Bayer format used by the gspca driver.
97 * .. _V4L2-PIX-FMT-OV511: 108 * .. _V4L2-PIX-FMT-OV511:
98 109
99 - ``V4L2_PIX_FMT_OV511`` 110 - ``V4L2_PIX_FMT_OV511``
100 - 'O511' 111 - 'O511'
101 - OV511 JPEG format used by the gspca dr 112 - OV511 JPEG format used by the gspca driver.
102 * .. _V4L2-PIX-FMT-OV518: 113 * .. _V4L2-PIX-FMT-OV518:
103 114
104 - ``V4L2_PIX_FMT_OV518`` 115 - ``V4L2_PIX_FMT_OV518``
105 - 'O518' 116 - 'O518'
106 - OV518 JPEG format used by the gspca dr 117 - OV518 JPEG format used by the gspca driver.
107 * .. _V4L2-PIX-FMT-PJPG: 118 * .. _V4L2-PIX-FMT-PJPG:
108 119
109 - ``V4L2_PIX_FMT_PJPG`` 120 - ``V4L2_PIX_FMT_PJPG``
110 - 'PJPG' 121 - 'PJPG'
111 - Pixart 73xx JPEG format used by the gs 122 - Pixart 73xx JPEG format used by the gspca driver.
112 * .. _V4L2-PIX-FMT-SE401: 123 * .. _V4L2-PIX-FMT-SE401:
113 124
114 - ``V4L2_PIX_FMT_SE401`` 125 - ``V4L2_PIX_FMT_SE401``
115 - 'S401' 126 - 'S401'
116 - Compressed RGB format used by the gspc 127 - Compressed RGB format used by the gspca se401 driver
117 * .. _V4L2-PIX-FMT-SQ905C: 128 * .. _V4L2-PIX-FMT-SQ905C:
118 129
119 - ``V4L2_PIX_FMT_SQ905C`` 130 - ``V4L2_PIX_FMT_SQ905C``
120 - '905C' 131 - '905C'
121 - Compressed RGGB bayer format used by t 132 - Compressed RGGB bayer format used by the gspca driver.
122 * .. _V4L2-PIX-FMT-MJPEG: 133 * .. _V4L2-PIX-FMT-MJPEG:
123 134
124 - ``V4L2_PIX_FMT_MJPEG`` 135 - ``V4L2_PIX_FMT_MJPEG``
125 - 'MJPG' 136 - 'MJPG'
126 - Compressed format used by the Zoran dr 137 - Compressed format used by the Zoran driver
127 * .. _V4L2-PIX-FMT-PWC1: 138 * .. _V4L2-PIX-FMT-PWC1:
128 139
129 - ``V4L2_PIX_FMT_PWC1`` 140 - ``V4L2_PIX_FMT_PWC1``
130 - 'PWC1' 141 - 'PWC1'
131 - Compressed format of the PWC driver. 142 - Compressed format of the PWC driver.
132 * .. _V4L2-PIX-FMT-PWC2: 143 * .. _V4L2-PIX-FMT-PWC2:
133 144
134 - ``V4L2_PIX_FMT_PWC2`` 145 - ``V4L2_PIX_FMT_PWC2``
135 - 'PWC2' 146 - 'PWC2'
136 - Compressed format of the PWC driver. 147 - Compressed format of the PWC driver.
137 * .. _V4L2-PIX-FMT-SN9C10X: 148 * .. _V4L2-PIX-FMT-SN9C10X:
138 149
139 - ``V4L2_PIX_FMT_SN9C10X`` 150 - ``V4L2_PIX_FMT_SN9C10X``
140 - 'S910' 151 - 'S910'
141 - Compressed format of the SN9C102 drive 152 - Compressed format of the SN9C102 driver.
142 * .. _V4L2-PIX-FMT-SN9C20X-I420: 153 * .. _V4L2-PIX-FMT-SN9C20X-I420:
143 154
144 - ``V4L2_PIX_FMT_SN9C20X_I420`` 155 - ``V4L2_PIX_FMT_SN9C20X_I420``
145 - 'S920' 156 - 'S920'
146 - YUV 4:2:0 format of the gspca sn9c20x 157 - YUV 4:2:0 format of the gspca sn9c20x driver.
147 * .. _V4L2-PIX-FMT-SN9C2028: 158 * .. _V4L2-PIX-FMT-SN9C2028:
148 159
149 - ``V4L2_PIX_FMT_SN9C2028`` 160 - ``V4L2_PIX_FMT_SN9C2028``
150 - 'SONX' 161 - 'SONX'
151 - Compressed GBRG bayer format of the gs 162 - Compressed GBRG bayer format of the gspca sn9c2028 driver.
152 * .. _V4L2-PIX-FMT-STV0680: 163 * .. _V4L2-PIX-FMT-STV0680:
153 164
154 - ``V4L2_PIX_FMT_STV0680`` 165 - ``V4L2_PIX_FMT_STV0680``
155 - 'S680' 166 - 'S680'
156 - Bayer format of the gspca stv0680 driv 167 - Bayer format of the gspca stv0680 driver.
157 * .. _V4L2-PIX-FMT-WNVA: 168 * .. _V4L2-PIX-FMT-WNVA:
158 169
159 - ``V4L2_PIX_FMT_WNVA`` 170 - ``V4L2_PIX_FMT_WNVA``
160 - 'WNVA' 171 - 'WNVA'
161 - Used by the Winnov Videum driver, 172 - Used by the Winnov Videum driver,
162 `http://www.thedirks.org/winnov/ <http 173 `http://www.thedirks.org/winnov/ <http://www.thedirks.org/winnov/>`__
163 * .. _V4L2-PIX-FMT-TM6000: 174 * .. _V4L2-PIX-FMT-TM6000:
164 175
165 - ``V4L2_PIX_FMT_TM6000`` 176 - ``V4L2_PIX_FMT_TM6000``
166 - 'TM60' 177 - 'TM60'
167 - Used by Trident tm6000 178 - Used by Trident tm6000
168 * .. _V4L2-PIX-FMT-CIT-YYVYUY: 179 * .. _V4L2-PIX-FMT-CIT-YYVYUY:
169 180
170 - ``V4L2_PIX_FMT_CIT_YYVYUY`` 181 - ``V4L2_PIX_FMT_CIT_YYVYUY``
171 - 'CITV' 182 - 'CITV'
172 - Used by xirlink CIT, found at IBM webc 183 - Used by xirlink CIT, found at IBM webcams.
173 184
174 Uses one line of Y then 1 line of VYUY 185 Uses one line of Y then 1 line of VYUY
175 * .. _V4L2-PIX-FMT-KONICA420: 186 * .. _V4L2-PIX-FMT-KONICA420:
176 187
177 - ``V4L2_PIX_FMT_KONICA420`` 188 - ``V4L2_PIX_FMT_KONICA420``
178 - 'KONI' 189 - 'KONI'
179 - Used by Konica webcams. 190 - Used by Konica webcams.
180 191
181 YUV420 planar in blocks of 256 pixels. 192 YUV420 planar in blocks of 256 pixels.
182 * .. _V4L2-PIX-FMT-YYUV: 193 * .. _V4L2-PIX-FMT-YYUV:
183 194
184 - ``V4L2_PIX_FMT_YYUV`` 195 - ``V4L2_PIX_FMT_YYUV``
185 - 'YYUV' 196 - 'YYUV'
186 - unknown 197 - unknown
187 * .. _V4L2-PIX-FMT-Y4: 198 * .. _V4L2-PIX-FMT-Y4:
188 199
189 - ``V4L2_PIX_FMT_Y4`` 200 - ``V4L2_PIX_FMT_Y4``
190 - 'Y04 ' 201 - 'Y04 '
191 - Old 4-bit greyscale format. Only the m 202 - Old 4-bit greyscale format. Only the most significant 4 bits of
192 each byte are used, the other bits are 203 each byte are used, the other bits are set to 0.
193 * .. _V4L2-PIX-FMT-Y6: 204 * .. _V4L2-PIX-FMT-Y6:
194 205
195 - ``V4L2_PIX_FMT_Y6`` 206 - ``V4L2_PIX_FMT_Y6``
196 - 'Y06 ' 207 - 'Y06 '
197 - Old 6-bit greyscale format. Only the m 208 - Old 6-bit greyscale format. Only the most significant 6 bits of
198 each byte are used, the other bits are 209 each byte are used, the other bits are set to 0.
199 * .. _V4L2-PIX-FMT-S5C-UYVY-JPG: 210 * .. _V4L2-PIX-FMT-S5C-UYVY-JPG:
200 211
201 - ``V4L2_PIX_FMT_S5C_UYVY_JPG`` 212 - ``V4L2_PIX_FMT_S5C_UYVY_JPG``
202 - 'S5CI' 213 - 'S5CI'
203 - Two-planar format used by Samsung S5C7 214 - Two-planar format used by Samsung S5C73MX cameras. The first plane
204 contains interleaved JPEG and UYVY ima 215 contains interleaved JPEG and UYVY image data, followed by meta
205 data in form of an array of offsets to 216 data in form of an array of offsets to the UYVY data blocks. The
206 actual pointer array follows immediate 217 actual pointer array follows immediately the interleaved JPEG/UYVY
207 data, the number of entries in this ar 218 data, the number of entries in this array equals the height of the
208 UYVY image. Each entry is a 4-byte uns 219 UYVY image. Each entry is a 4-byte unsigned integer in big endian
209 order and it's an offset to a single p 220 order and it's an offset to a single pixel line of the UYVY image.
210 The first plane can start either with 221 The first plane can start either with JPEG or UYVY data chunk. The
211 size of a single UYVY block equals the 222 size of a single UYVY block equals the UYVY image's width
212 multiplied by 2. The size of a JPEG ch 223 multiplied by 2. The size of a JPEG chunk depends on the image and
213 can vary with each line. 224 can vary with each line.
214 225
215 The second plane, at an offset of 4084 226 The second plane, at an offset of 4084 bytes, contains a 4-byte
216 offset to the pointer array in the fir 227 offset to the pointer array in the first plane. This offset is
217 followed by a 4-byte value indicating 228 followed by a 4-byte value indicating size of the pointer array.
218 All numbers in the second plane are al 229 All numbers in the second plane are also in big endian order.
219 Remaining data in the second plane is 230 Remaining data in the second plane is undefined. The information
220 in the second plane allows to easily f 231 in the second plane allows to easily find location of the pointer
221 array, which can be different for each 232 array, which can be different for each frame. The size of the
222 pointer array is constant for given UY 233 pointer array is constant for given UYVY image height.
223 234
224 In order to extract UYVY and JPEG fram 235 In order to extract UYVY and JPEG frames an application can
225 initially set a data pointer to the st 236 initially set a data pointer to the start of first plane and then
226 add an offset from the first entry of 237 add an offset from the first entry of the pointers table. Such a
227 pointer indicates start of an UYVY ima 238 pointer indicates start of an UYVY image pixel line. Whole UYVY
228 line can be copied to a separate buffe 239 line can be copied to a separate buffer. These steps should be
229 repeated for each line, i.e. the numbe 240 repeated for each line, i.e. the number of entries in the pointer
230 array. Anything what's in between the 241 array. Anything what's in between the UYVY lines is JPEG data and
231 should be concatenated to form the JPE 242 should be concatenated to form the JPEG stream.
232 * .. _V4L2-PIX-FMT-MT21C: 243 * .. _V4L2-PIX-FMT-MT21C:
233 244
234 - ``V4L2_PIX_FMT_MT21C`` 245 - ``V4L2_PIX_FMT_MT21C``
235 - 'MT21' 246 - 'MT21'
236 - Compressed two-planar YVU420 format us !! 247 - Compressed two-planar YVU420 format used by Mediatek MT8173.
237 MT8195 and more. The compression is lo !! 248 The compression is lossless.
238 similitude with ``V4L2_PIX_FMT_MM21`` !! 249 It is an opaque intermediate format and the MDP hardware must be
239 It remains an opaque intermediate form <<
240 used to convert ``V4L2_PIX_FMT_MT21C`` 250 used to convert ``V4L2_PIX_FMT_MT21C`` to ``V4L2_PIX_FMT_NV12M``,
241 ``V4L2_PIX_FMT_YUV420M`` or ``V4L2_PIX 251 ``V4L2_PIX_FMT_YUV420M`` or ``V4L2_PIX_FMT_YVU420``.
242 * .. _V4L2-PIX-FMT-QC08C: !! 252 * .. _V4L2-PIX-FMT-SUNXI-TILED-NV12:
>> 253
>> 254 - ``V4L2_PIX_FMT_SUNXI_TILED_NV12``
>> 255 - 'ST12'
>> 256 - Two-planar NV12-based format used by the video engine found on Allwinner
>> 257 (codenamed sunxi) platforms, with 32x32 tiles for the luminance plane
>> 258 and 32x64 tiles for the chrominance plane. The data in each tile is
>> 259 stored in linear order, within the tile bounds. Each tile follows the
>> 260 previous one linearly in memory (from left to right, top to bottom).
>> 261
>> 262 The associated buffer dimensions are aligned to match an integer number
>> 263 of tiles, resulting in 32-aligned resolutions for the luminance plane
>> 264 and 16-aligned resolutions for the chrominance plane (with 2x2
>> 265 subsampling).
243 266
244 - ``V4L2_PIX_FMT_QC08C`` !! 267 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
245 - 'QC08C' !! 268
246 - Compressed Macro-tile 8-Bit YUV420 for !! 269 .. _format-flags:
247 It is an opaque intermediate format. T !! 270
248 and it is used by various multimedia h !! 271 .. flat-table:: Format Flags
249 controllers, ISP and video accelerator !! 272 :header-rows: 0
250 It contains four planes for progressiv !! 273 :stub-columns: 0
251 interlaced video. !! 274 :widths: 3 1 4
252 * .. _V4L2-PIX-FMT-QC10C: <<
253 <<
254 - ``V4L2_PIX_FMT_QC10C`` <<
255 - 'QC10C' <<
256 - Compressed Macro-tile 10-Bit YUV420 fo <<
257 It is an opaque intermediate format. T <<
258 and it is used by various multimedia h <<
259 controllers, ISP and video accelerator <<
260 It contains four planes for progressiv <<
261 * .. _V4L2-PIX-FMT-AJPG: <<
262 <<
263 - ``V4L2_PIX_FMT_AJPG`` <<
264 - 'AJPG' <<
265 - ASPEED JPEG format used by the aspeed- <<
266 which is generally adapted for remote <<
267 On each frame compression, I will comp <<
268 one to decide which macroblock's data <<
269 macroblocks will be compressed. <<
270 <<
271 The implementation is based on AST2600 <<
272 is not publicly available. Or you can <<
273 – ASPEED mode compression of SDK_Use <<
274 `github <https://github.com/AspeedTech <<
275 <<
276 Decoder's implementation can be found <<
277 `aspeed_codec <https://github.com/Aspe <<
278 * .. _V4L2-PIX-FMT-HEXTILE: <<
279 <<
280 - ``V4L2_PIX_FMT_HEXTILE`` <<
281 - 'HXTL' <<
282 - Compressed format used by Nuvoton NPCM <<
283 defined in Remote Framebuffer Protocol <<
284 Encoding). <<
285 .. raw:: latex <<
286 275
287 \normalsize !! 276 * - ``V4L2_PIX_FMT_FLAG_PREMUL_ALPHA``
>> 277 - 0x00000001
>> 278 - The color values are premultiplied by the alpha channel value. For
>> 279 example, if a light blue pixel with 50% transparency was described
>> 280 by RGBA values (128, 192, 255, 128), the same pixel described with
>> 281 premultiplied colors would be described by RGBA values (64, 96,
>> 282 128, 128)
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.