Debian Codegraph @

Documentation/userspace-api/media/v4l/pixfmt-reserved.rst

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