1 /* SPDX-License-Identifier: ((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) */
2 /*
3 * Video for Linux Two header file
4 *
5 * Copyright (C) 1999-2012 the contributors
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * Alternatively you can redistribute this file under the terms of the
18 * BSD license as stated below:
19 *
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
22 * are met:
23 * 1. Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * 2. Redistributions in binary form must reproduce the above copyright
26 * notice, this list of conditions and the following disclaimer in
27 * the documentation and/or other materials provided with the
28 * distribution.
29 * 3. The names of its contributors may not be used to endorse or promote
30 * products derived from this software without specific prior written
31 * permission.
32 *
33 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
34 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
36 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
37 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
39 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
40 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
41 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
42 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
43 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 *
45 * Header file for v4l or V4L2 drivers and applications
46 * with public API.
47 * All kernel-specific stuff were moved to media/v4l2-dev.h, so
48 * no #if __KERNEL tests are allowed here
49 *
50 * See https://linuxtv.org for more info
51 *
52 * Author: Bill Dirks <bill@thedirks.org>
53 * Justin Schoeman
54 * Hans Verkuil <hverkuil@xs4all.nl>
55 * et al.
56 */
57 #ifndef __LINUX_VIDEODEV2_H
58 #define __LINUX_VIDEODEV2_H
59
60 #include <sys/time.h>
61
62 #include <sys/ioctl.h>
63 #include <linux/types.h>
64 #include <linux/v4l2-common.h>
65 #include <linux/v4l2-controls.h>
66
67 /*
68 * Common stuff for both V4L1 and V4L2
69 * Moved from videodev.h
70 */
71 #define VIDEO_MAX_FRAME 32
72 #define VIDEO_MAX_PLANES 8
73
74 /*
75 * M I S C E L L A N E O U S
76 */
77
78 /* Four-character-code (FOURCC) */
79 #define v4l2_fourcc(a, b, c, d)\
80 ((uint32_t)(a) | ((uint32_t)(b) << 8) | ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
81 #define v4l2_fourcc_be(a, b, c, d) (v4l2_fourcc(a, b, c, d) | (1U << 31))
82
83 /*
84 * E N U M S
85 */
86 enum v4l2_field {
87 V4L2_FIELD_ANY = 0, /* driver can choose from none,
88 top, bottom, interlaced
89 depending on whatever it thinks
90 is approximate ... */
91 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
92 V4L2_FIELD_TOP = 2, /* top field only */
93 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
94 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
95 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
96 buffer, top-bottom order */
97 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
98 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
99 separate buffers */
100 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
101 first and the top field is
102 transmitted first */
103 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
104 first and the bottom field is
105 transmitted first */
106 };
107 #define V4L2_FIELD_HAS_TOP(field) \
108 ((field) == V4L2_FIELD_TOP ||\
109 (field) == V4L2_FIELD_INTERLACED ||\
110 (field) == V4L2_FIELD_INTERLACED_TB ||\
111 (field) == V4L2_FIELD_INTERLACED_BT ||\
112 (field) == V4L2_FIELD_SEQ_TB ||\
113 (field) == V4L2_FIELD_SEQ_BT)
114 #define V4L2_FIELD_HAS_BOTTOM(field) \
115 ((field) == V4L2_FIELD_BOTTOM ||\
116 (field) == V4L2_FIELD_INTERLACED ||\
117 (field) == V4L2_FIELD_INTERLACED_TB ||\
118 (field) == V4L2_FIELD_INTERLACED_BT ||\
119 (field) == V4L2_FIELD_SEQ_TB ||\
120 (field) == V4L2_FIELD_SEQ_BT)
121 #define V4L2_FIELD_HAS_BOTH(field) \
122 ((field) == V4L2_FIELD_INTERLACED ||\
123 (field) == V4L2_FIELD_INTERLACED_TB ||\
124 (field) == V4L2_FIELD_INTERLACED_BT ||\
125 (field) == V4L2_FIELD_SEQ_TB ||\
126 (field) == V4L2_FIELD_SEQ_BT)
127 #define V4L2_FIELD_HAS_T_OR_B(field) \
128 ((field) == V4L2_FIELD_BOTTOM ||\
129 (field) == V4L2_FIELD_TOP ||\
130 (field) == V4L2_FIELD_ALTERNATE)
131 #define V4L2_FIELD_IS_INTERLACED(field) \
132 ((field) == V4L2_FIELD_INTERLACED ||\
133 (field) == V4L2_FIELD_INTERLACED_TB ||\
134 (field) == V4L2_FIELD_INTERLACED_BT)
135 #define V4L2_FIELD_IS_SEQUENTIAL(field) \
136 ((field) == V4L2_FIELD_SEQ_TB ||\
137 (field) == V4L2_FIELD_SEQ_BT)
138
139 enum v4l2_buf_type {
140 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
141 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
142 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
143 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
144 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
145 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
146 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
147 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
148 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
149 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
150 V4L2_BUF_TYPE_SDR_CAPTURE = 11,
151 V4L2_BUF_TYPE_SDR_OUTPUT = 12,
152 V4L2_BUF_TYPE_META_CAPTURE = 13,
153 V4L2_BUF_TYPE_META_OUTPUT = 14,
154 /* Deprecated, do not use */
155 V4L2_BUF_TYPE_PRIVATE = 0x80,
156 };
157
158 #define V4L2_TYPE_IS_MULTIPLANAR(type) \
159 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
160 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
161
162 #define V4L2_TYPE_IS_OUTPUT(type) \
163 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
164 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
165 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
166 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
167 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
168 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT \
169 || (type) == V4L2_BUF_TYPE_SDR_OUTPUT \
170 || (type) == V4L2_BUF_TYPE_META_OUTPUT)
171
172 enum v4l2_tuner_type {
173 V4L2_TUNER_RADIO = 1,
174 V4L2_TUNER_ANALOG_TV = 2,
175 V4L2_TUNER_DIGITAL_TV = 3,
176 V4L2_TUNER_SDR = 4,
177 V4L2_TUNER_RF = 5,
178 };
179
180 /* Deprecated, do not use */
181 #define V4L2_TUNER_ADC V4L2_TUNER_SDR
182
183 enum v4l2_memory {
184 V4L2_MEMORY_MMAP = 1,
185 V4L2_MEMORY_USERPTR = 2,
186 V4L2_MEMORY_OVERLAY = 3,
187 V4L2_MEMORY_DMABUF = 4,
188 };
189
190 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
191 enum v4l2_colorspace {
192 /*
193 * Default colorspace, i.e. let the driver figure it out.
194 * Can only be used with video capture.
195 */
196 V4L2_COLORSPACE_DEFAULT = 0,
197
198 /* SMPTE 170M: used for broadcast NTSC/PAL SDTV */
199 V4L2_COLORSPACE_SMPTE170M = 1,
200
201 /* Obsolete pre-1998 SMPTE 240M HDTV standard, superseded by Rec 709 */
202 V4L2_COLORSPACE_SMPTE240M = 2,
203
204 /* Rec.709: used for HDTV */
205 V4L2_COLORSPACE_REC709 = 3,
206
207 /*
208 * Deprecated, do not use. No driver will ever return this. This was
209 * based on a misunderstanding of the bt878 datasheet.
210 */
211 V4L2_COLORSPACE_BT878 = 4,
212
213 /*
214 * NTSC 1953 colorspace. This only makes sense when dealing with
215 * really, really old NTSC recordings. Superseded by SMPTE 170M.
216 */
217 V4L2_COLORSPACE_470_SYSTEM_M = 5,
218
219 /*
220 * EBU Tech 3213 PAL/SECAM colorspace. This only makes sense when
221 * dealing with really old PAL/SECAM recordings. Superseded by
222 * SMPTE 170M.
223 */
224 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
225
226 /*
227 * Effectively shorthand for V4L2_COLORSPACE_SRGB, V4L2_YCBCR_ENC_601
228 * and V4L2_QUANTIZATION_FULL_RANGE. To be used for (Motion-)JPEG.
229 */
230 V4L2_COLORSPACE_JPEG = 7,
231
232 /* For RGB colorspaces such as produces by most webcams. */
233 V4L2_COLORSPACE_SRGB = 8,
234
235 /* opRGB colorspace */
236 V4L2_COLORSPACE_OPRGB = 9,
237
238 /* BT.2020 colorspace, used for UHDTV. */
239 V4L2_COLORSPACE_BT2020 = 10,
240
241 /* Raw colorspace: for RAW unprocessed images */
242 V4L2_COLORSPACE_RAW = 11,
243
244 /* DCI-P3 colorspace, used by cinema projectors */
245 V4L2_COLORSPACE_DCI_P3 = 12,
246 };
247
248 /*
249 * Determine how COLORSPACE_DEFAULT should map to a proper colorspace.
250 * This depends on whether this is a SDTV image (use SMPTE 170M), an
251 * HDTV image (use Rec. 709), or something else (use sRGB).
252 */
253 #define V4L2_MAP_COLORSPACE_DEFAULT(is_sdtv, is_hdtv) \
254 ((is_sdtv) ? V4L2_COLORSPACE_SMPTE170M : \
255 ((is_hdtv) ? V4L2_COLORSPACE_REC709 : V4L2_COLORSPACE_SRGB))
256
257 enum v4l2_xfer_func {
258 /*
259 * Mapping of V4L2_XFER_FUNC_DEFAULT to actual transfer functions
260 * for the various colorspaces:
261 *
262 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
263 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_REC709 and
264 * V4L2_COLORSPACE_BT2020: V4L2_XFER_FUNC_709
265 *
266 * V4L2_COLORSPACE_SRGB, V4L2_COLORSPACE_JPEG: V4L2_XFER_FUNC_SRGB
267 *
268 * V4L2_COLORSPACE_OPRGB: V4L2_XFER_FUNC_OPRGB
269 *
270 * V4L2_COLORSPACE_SMPTE240M: V4L2_XFER_FUNC_SMPTE240M
271 *
272 * V4L2_COLORSPACE_RAW: V4L2_XFER_FUNC_NONE
273 *
274 * V4L2_COLORSPACE_DCI_P3: V4L2_XFER_FUNC_DCI_P3
275 */
276 V4L2_XFER_FUNC_DEFAULT = 0,
277 V4L2_XFER_FUNC_709 = 1,
278 V4L2_XFER_FUNC_SRGB = 2,
279 V4L2_XFER_FUNC_OPRGB = 3,
280 V4L2_XFER_FUNC_SMPTE240M = 4,
281 V4L2_XFER_FUNC_NONE = 5,
282 V4L2_XFER_FUNC_DCI_P3 = 6,
283 V4L2_XFER_FUNC_SMPTE2084 = 7,
284 };
285
286 /*
287 * Determine how XFER_FUNC_DEFAULT should map to a proper transfer function.
288 * This depends on the colorspace.
289 */
290 #define V4L2_MAP_XFER_FUNC_DEFAULT(colsp) \
291 ((colsp) == V4L2_COLORSPACE_OPRGB ? V4L2_XFER_FUNC_OPRGB : \
292 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_XFER_FUNC_SMPTE240M : \
293 ((colsp) == V4L2_COLORSPACE_DCI_P3 ? V4L2_XFER_FUNC_DCI_P3 : \
294 ((colsp) == V4L2_COLORSPACE_RAW ? V4L2_XFER_FUNC_NONE : \
295 ((colsp) == V4L2_COLORSPACE_SRGB || (colsp) == V4L2_COLORSPACE_JPEG ? \
296 V4L2_XFER_FUNC_SRGB : V4L2_XFER_FUNC_709)))))
297
298 enum v4l2_ycbcr_encoding {
299 /*
300 * Mapping of V4L2_YCBCR_ENC_DEFAULT to actual encodings for the
301 * various colorspaces:
302 *
303 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
304 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_SRGB,
305 * V4L2_COLORSPACE_OPRGB and V4L2_COLORSPACE_JPEG: V4L2_YCBCR_ENC_601
306 *
307 * V4L2_COLORSPACE_REC709 and V4L2_COLORSPACE_DCI_P3: V4L2_YCBCR_ENC_709
308 *
309 * V4L2_COLORSPACE_BT2020: V4L2_YCBCR_ENC_BT2020
310 *
311 * V4L2_COLORSPACE_SMPTE240M: V4L2_YCBCR_ENC_SMPTE240M
312 */
313 V4L2_YCBCR_ENC_DEFAULT = 0,
314
315 /* ITU-R 601 -- SDTV */
316 V4L2_YCBCR_ENC_601 = 1,
317
318 /* Rec. 709 -- HDTV */
319 V4L2_YCBCR_ENC_709 = 2,
320
321 /* ITU-R 601/EN 61966-2-4 Extended Gamut -- SDTV */
322 V4L2_YCBCR_ENC_XV601 = 3,
323
324 /* Rec. 709/EN 61966-2-4 Extended Gamut -- HDTV */
325 V4L2_YCBCR_ENC_XV709 = 4,
326
327 /*
328 * sYCC (Y'CbCr encoding of sRGB), identical to ENC_601. It was added
329 * originally due to a misunderstanding of the sYCC standard. It should
330 * not be used, instead use V4L2_YCBCR_ENC_601.
331 */
332 V4L2_YCBCR_ENC_SYCC = 5,
333
334 /* BT.2020 Non-constant Luminance Y'CbCr */
335 V4L2_YCBCR_ENC_BT2020 = 6,
336
337 /* BT.2020 Constant Luminance Y'CbcCrc */
338 V4L2_YCBCR_ENC_BT2020_CONST_LUM = 7,
339
340 /* SMPTE 240M -- Obsolete HDTV */
341 V4L2_YCBCR_ENC_SMPTE240M = 8,
342 };
343
344 /*
345 * enum v4l2_hsv_encoding values should not collide with the ones from
346 * enum v4l2_ycbcr_encoding.
347 */
348 enum v4l2_hsv_encoding {
349
350 /* Hue mapped to 0 - 179 */
351 V4L2_HSV_ENC_180 = 128,
352
353 /* Hue mapped to 0-255 */
354 V4L2_HSV_ENC_256 = 129,
355 };
356
357 /*
358 * Determine how YCBCR_ENC_DEFAULT should map to a proper Y'CbCr encoding.
359 * This depends on the colorspace.
360 */
361 #define V4L2_MAP_YCBCR_ENC_DEFAULT(colsp) \
362 (((colsp) == V4L2_COLORSPACE_REC709 || \
363 (colsp) == V4L2_COLORSPACE_DCI_P3) ? V4L2_YCBCR_ENC_709 : \
364 ((colsp) == V4L2_COLORSPACE_BT2020 ? V4L2_YCBCR_ENC_BT2020 : \
365 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_YCBCR_ENC_SMPTE240M : \
366 V4L2_YCBCR_ENC_601)))
367
368 enum v4l2_quantization {
369 /*
370 * The default for R'G'B' quantization is always full range, except
371 * for the BT2020 colorspace. For Y'CbCr the quantization is always
372 * limited range, except for COLORSPACE_JPEG: this is full range.
373 */
374 V4L2_QUANTIZATION_DEFAULT = 0,
375 V4L2_QUANTIZATION_FULL_RANGE = 1,
376 V4L2_QUANTIZATION_LIM_RANGE = 2,
377 };
378
379 /*
380 * Determine how QUANTIZATION_DEFAULT should map to a proper quantization.
381 * This depends on whether the image is RGB or not, the colorspace and the
382 * Y'CbCr encoding.
383 */
384 #define V4L2_MAP_QUANTIZATION_DEFAULT(is_rgb_or_hsv, colsp, ycbcr_enc) \
385 (((is_rgb_or_hsv) && (colsp) == V4L2_COLORSPACE_BT2020) ? \
386 V4L2_QUANTIZATION_LIM_RANGE : \
387 (((is_rgb_or_hsv) || (colsp) == V4L2_COLORSPACE_JPEG) ? \
388 V4L2_QUANTIZATION_FULL_RANGE : V4L2_QUANTIZATION_LIM_RANGE))
389
390 /*
391 * Deprecated names for opRGB colorspace (IEC 61966-2-5)
392 *
393 * WARNING: Please don't use these deprecated defines in your code, as
394 * there is a chance we have to remove them in the future.
395 */
396 #define V4L2_COLORSPACE_ADOBERGB V4L2_COLORSPACE_OPRGB
397 #define V4L2_XFER_FUNC_ADOBERGB V4L2_XFER_FUNC_OPRGB
398
399 enum v4l2_priority {
400 V4L2_PRIORITY_UNSET = 0, /* not initialized */
401 V4L2_PRIORITY_BACKGROUND = 1,
402 V4L2_PRIORITY_INTERACTIVE = 2,
403 V4L2_PRIORITY_RECORD = 3,
404 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
405 };
406
407 struct v4l2_rect {
408 int32_t left;
409 int32_t top;
410 uint32_t width;
411 uint32_t height;
412 };
413
414 struct v4l2_fract {
415 uint32_t numerator;
416 uint32_t denominator;
417 };
418
419 struct v4l2_area {
420 uint32_t width;
421 uint32_t height;
422 };
423
424 /**
425 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
426 *
427 * @driver: name of the driver module (e.g. "bttv")
428 * @card: name of the card (e.g. "Hauppauge WinTV")
429 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
430 * @version: KERNEL_VERSION
431 * @capabilities: capabilities of the physical device as a whole
432 * @device_caps: capabilities accessed via this particular device (node)
433 * @reserved: reserved fields for future extensions
434 */
435 struct v4l2_capability {
436 uint8_t driver[16];
437 uint8_t card[32];
438 uint8_t bus_info[32];
439 uint32_t version;
440 uint32_t capabilities;
441 uint32_t device_caps;
442 uint32_t reserved[3];
443 };
444
445 /* Values for 'capabilities' field */
446 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
447 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
448 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
449 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
450 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
451 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
452 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
453 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
454 #define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
455 #define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
456 #define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
457
458 /* Is a video capture device that supports multiplanar formats */
459 #define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
460 /* Is a video output device that supports multiplanar formats */
461 #define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
462 /* Is a video mem-to-mem device that supports multiplanar formats */
463 #define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
464 /* Is a video mem-to-mem device */
465 #define V4L2_CAP_VIDEO_M2M 0x00008000
466
467 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
468 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
469 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
470 #define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
471
472 #define V4L2_CAP_SDR_CAPTURE 0x00100000 /* Is a SDR capture device */
473 #define V4L2_CAP_EXT_PIX_FORMAT 0x00200000 /* Supports the extended pixel format */
474 #define V4L2_CAP_SDR_OUTPUT 0x00400000 /* Is a SDR output device */
475 #define V4L2_CAP_META_CAPTURE 0x00800000 /* Is a metadata capture device */
476
477 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
478 #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
479 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
480 #define V4L2_CAP_META_OUTPUT 0x08000000 /* Is a metadata output device */
481
482 #define V4L2_CAP_TOUCH 0x10000000 /* Is a touch device */
483
484 #define V4L2_CAP_IO_MC 0x20000000 /* Is input/output controlled by the media controller */
485
486 #define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
487
488 /*
489 * V I D E O I M A G E F O R M A T
490 */
491 struct v4l2_pix_format {
492 uint32_t width;
493 uint32_t height;
494 uint32_t pixelformat;
495 uint32_t field; /* enum v4l2_field */
496 uint32_t bytesperline; /* for padding, zero if unused */
497 uint32_t sizeimage;
498 uint32_t colorspace; /* enum v4l2_colorspace */
499 uint32_t priv; /* private data, depends on pixelformat */
500 uint32_t flags; /* format flags (V4L2_PIX_FMT_FLAG_*) */
501 union {
502 /* enum v4l2_ycbcr_encoding */
503 uint32_t ycbcr_enc;
504 /* enum v4l2_hsv_encoding */
505 uint32_t hsv_enc;
506 };
507 uint32_t quantization; /* enum v4l2_quantization */
508 uint32_t xfer_func; /* enum v4l2_xfer_func */
509 };
510
511 /* Pixel format FOURCC depth Description */
512
513 /* RGB formats */
514 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
515 #define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
516 #define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16 aaaarrrr ggggbbbb */
517 #define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16 xxxxrrrr ggggbbbb */
518 #define V4L2_PIX_FMT_RGBA444 v4l2_fourcc('R', 'A', '1', '2') /* 16 rrrrgggg bbbbaaaa */
519 #define V4L2_PIX_FMT_RGBX444 v4l2_fourcc('R', 'X', '1', '2') /* 16 rrrrgggg bbbbxxxx */
520 #define V4L2_PIX_FMT_ABGR444 v4l2_fourcc('A', 'B', '1', '2') /* 16 aaaabbbb ggggrrrr */
521 #define V4L2_PIX_FMT_XBGR444 v4l2_fourcc('X', 'B', '1', '2') /* 16 xxxxbbbb ggggrrrr */
522
523 /*
524 * Originally this had 'BA12' as fourcc, but this clashed with the older
525 * V4L2_PIX_FMT_SGRBG12 which inexplicably used that same fourcc.
526 * So use 'GA12' instead for V4L2_PIX_FMT_BGRA444.
527 */
528 #define V4L2_PIX_FMT_BGRA444 v4l2_fourcc('G', 'A', '1', '2') /* 16 bbbbgggg rrrraaaa */
529 #define V4L2_PIX_FMT_BGRX444 v4l2_fourcc('B', 'X', '1', '2') /* 16 bbbbgggg rrrrxxxx */
530 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
531 #define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16 ARGB-1-5-5-5 */
532 #define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16 XRGB-1-5-5-5 */
533 #define V4L2_PIX_FMT_RGBA555 v4l2_fourcc('R', 'A', '1', '5') /* 16 RGBA-5-5-5-1 */
534 #define V4L2_PIX_FMT_RGBX555 v4l2_fourcc('R', 'X', '1', '5') /* 16 RGBX-5-5-5-1 */
535 #define V4L2_PIX_FMT_ABGR555 v4l2_fourcc('A', 'B', '1', '5') /* 16 ABGR-1-5-5-5 */
536 #define V4L2_PIX_FMT_XBGR555 v4l2_fourcc('X', 'B', '1', '5') /* 16 XBGR-1-5-5-5 */
537 #define V4L2_PIX_FMT_BGRA555 v4l2_fourcc('B', 'A', '1', '5') /* 16 BGRA-5-5-5-1 */
538 #define V4L2_PIX_FMT_BGRX555 v4l2_fourcc('B', 'X', '1', '5') /* 16 BGRX-5-5-5-1 */
539 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
540 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
541 #define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16 ARGB-5-5-5 BE */
542 #define V4L2_PIX_FMT_XRGB555X v4l2_fourcc_be('X', 'R', '1', '5') /* 16 XRGB-5-5-5 BE */
543 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
544 #define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
545 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
546 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
547 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
548 #define V4L2_PIX_FMT_ABGR32 v4l2_fourcc('A', 'R', '2', '4') /* 32 BGRA-8-8-8-8 */
549 #define V4L2_PIX_FMT_XBGR32 v4l2_fourcc('X', 'R', '2', '4') /* 32 BGRX-8-8-8-8 */
550 #define V4L2_PIX_FMT_BGRA32 v4l2_fourcc('R', 'A', '2', '4') /* 32 ABGR-8-8-8-8 */
551 #define V4L2_PIX_FMT_BGRX32 v4l2_fourcc('R', 'X', '2', '4') /* 32 XBGR-8-8-8-8 */
552 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
553 #define V4L2_PIX_FMT_RGBA32 v4l2_fourcc('A', 'B', '2', '4') /* 32 RGBA-8-8-8-8 */
554 #define V4L2_PIX_FMT_RGBX32 v4l2_fourcc('X', 'B', '2', '4') /* 32 RGBX-8-8-8-8 */
555 #define V4L2_PIX_FMT_ARGB32 v4l2_fourcc('B', 'A', '2', '4') /* 32 ARGB-8-8-8-8 */
556 #define V4L2_PIX_FMT_XRGB32 v4l2_fourcc('B', 'X', '2', '4') /* 32 XRGB-8-8-8-8 */
557
558 /* Grey formats */
559 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
560 #define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
561 #define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
562 #define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
563 #define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
564 #define V4L2_PIX_FMT_Y14 v4l2_fourcc('Y', '1', '4', ' ') /* 14 Greyscale */
565 #define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
566 #define V4L2_PIX_FMT_Y16_BE v4l2_fourcc_be('Y', '1', '6', ' ') /* 16 Greyscale BE */
567
568 /* Grey bit-packed formats */
569 #define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
570 #define V4L2_PIX_FMT_Y10P v4l2_fourcc('Y', '1', '0', 'P') /* 10 Greyscale, MIPI RAW10 packed */
571
572 /* Palette formats */
573 #define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
574
575 /* Chrominance formats */
576 #define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
577
578 /* Luminance+Chrominance formats */
579 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
580 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
581 #define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
582 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
583 #define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
584 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
585 #define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
586 #define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
587 #define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
588 #define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
589 #define V4L2_PIX_FMT_AYUV32 v4l2_fourcc('A', 'Y', 'U', 'V') /* 32 AYUV-8-8-8-8 */
590 #define V4L2_PIX_FMT_XYUV32 v4l2_fourcc('X', 'Y', 'U', 'V') /* 32 XYUV-8-8-8-8 */
591 #define V4L2_PIX_FMT_VUYA32 v4l2_fourcc('V', 'U', 'Y', 'A') /* 32 VUYA-8-8-8-8 */
592 #define V4L2_PIX_FMT_VUYX32 v4l2_fourcc('V', 'U', 'Y', 'X') /* 32 VUYX-8-8-8-8 */
593 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
594 #define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
595 #define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
596
597 /* two planes -- one Y, one Cr + Cb interleaved */
598 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
599 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
600 #define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
601 #define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
602 #define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
603 #define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
604
605 /* two non contiguous planes - one Y, one Cr + Cb interleaved */
606 #define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
607 #define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
608 #define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
609 #define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
610 #define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
611 #define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 macroblocks */
612
613 /* three planes - Y Cb, Cr */
614 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
615 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
616 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 12 YVU411 planar */
617 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
618 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
619 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
620
621 /* three non contiguous planes - Y, Cb, Cr */
622 #define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
623 #define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
624 #define V4L2_PIX_FMT_YUV422M v4l2_fourcc('Y', 'M', '1', '6') /* 16 YUV422 planar */
625 #define V4L2_PIX_FMT_YVU422M v4l2_fourcc('Y', 'M', '6', '1') /* 16 YVU422 planar */
626 #define V4L2_PIX_FMT_YUV444M v4l2_fourcc('Y', 'M', '2', '4') /* 24 YUV444 planar */
627 #define V4L2_PIX_FMT_YVU444M v4l2_fourcc('Y', 'M', '4', '2') /* 24 YVU444 planar */
628
629 /* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
630 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
631 #define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
632 #define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
633 #define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
634 #define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
635 #define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
636 #define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
637 #define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
638 /* 10bit raw bayer packed, 5 bytes for every 4 pixels */
639 #define V4L2_PIX_FMT_SBGGR10P v4l2_fourcc('p', 'B', 'A', 'A')
640 #define V4L2_PIX_FMT_SGBRG10P v4l2_fourcc('p', 'G', 'A', 'A')
641 #define V4L2_PIX_FMT_SGRBG10P v4l2_fourcc('p', 'g', 'A', 'A')
642 #define V4L2_PIX_FMT_SRGGB10P v4l2_fourcc('p', 'R', 'A', 'A')
643 /* 10bit raw bayer a-law compressed to 8 bits */
644 #define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
645 #define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
646 #define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
647 #define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
648 /* 10bit raw bayer DPCM compressed to 8 bits */
649 #define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
650 #define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
651 #define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
652 #define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
653 #define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
654 #define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
655 #define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
656 #define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
657 /* 12bit raw bayer packed, 6 bytes for every 4 pixels */
658 #define V4L2_PIX_FMT_SBGGR12P v4l2_fourcc('p', 'B', 'C', 'C')
659 #define V4L2_PIX_FMT_SGBRG12P v4l2_fourcc('p', 'G', 'C', 'C')
660 #define V4L2_PIX_FMT_SGRBG12P v4l2_fourcc('p', 'g', 'C', 'C')
661 #define V4L2_PIX_FMT_SRGGB12P v4l2_fourcc('p', 'R', 'C', 'C')
662 #define V4L2_PIX_FMT_SBGGR14 v4l2_fourcc('B', 'G', '1', '4') /* 14 BGBG.. GRGR.. */
663 #define V4L2_PIX_FMT_SGBRG14 v4l2_fourcc('G', 'B', '1', '4') /* 14 GBGB.. RGRG.. */
664 #define V4L2_PIX_FMT_SGRBG14 v4l2_fourcc('G', 'R', '1', '4') /* 14 GRGR.. BGBG.. */
665 #define V4L2_PIX_FMT_SRGGB14 v4l2_fourcc('R', 'G', '1', '4') /* 14 RGRG.. GBGB.. */
666 /* 14bit raw bayer packed, 7 bytes for every 4 pixels */
667 #define V4L2_PIX_FMT_SBGGR14P v4l2_fourcc('p', 'B', 'E', 'E')
668 #define V4L2_PIX_FMT_SGBRG14P v4l2_fourcc('p', 'G', 'E', 'E')
669 #define V4L2_PIX_FMT_SGRBG14P v4l2_fourcc('p', 'g', 'E', 'E')
670 #define V4L2_PIX_FMT_SRGGB14P v4l2_fourcc('p', 'R', 'E', 'E')
671 #define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
672 #define V4L2_PIX_FMT_SGBRG16 v4l2_fourcc('G', 'B', '1', '6') /* 16 GBGB.. RGRG.. */
673 #define V4L2_PIX_FMT_SGRBG16 v4l2_fourcc('G', 'R', '1', '6') /* 16 GRGR.. BGBG.. */
674 #define V4L2_PIX_FMT_SRGGB16 v4l2_fourcc('R', 'G', '1', '6') /* 16 RGRG.. GBGB.. */
675
676 /* HSV formats */
677 #define V4L2_PIX_FMT_HSV24 v4l2_fourcc('H', 'S', 'V', '3')
678 #define V4L2_PIX_FMT_HSV32 v4l2_fourcc('H', 'S', 'V', '4')
679
680 /* compressed formats */
681 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
682 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
683 #define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
684 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
685 #define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
686 #define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
687 #define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
688 #define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
689 #define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
690 #define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
691 #define V4L2_PIX_FMT_MPEG2_SLICE v4l2_fourcc('M', 'G', '2', 'S') /* MPEG-2 parsed slice data */
692 #define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
693 #define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
694 #define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
695 #define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
696 #define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
697 #define V4L2_PIX_FMT_VP9 v4l2_fourcc('V', 'P', '9', '0') /* VP9 */
698 #define V4L2_PIX_FMT_HEVC v4l2_fourcc('H', 'E', 'V', 'C') /* HEVC aka H.265 */
699 #define V4L2_PIX_FMT_FWHT v4l2_fourcc('F', 'W', 'H', 'T') /* Fast Walsh Hadamard Transform (vicodec) */
700 #define V4L2_PIX_FMT_FWHT_STATELESS v4l2_fourcc('S', 'F', 'W', 'H') /* Stateless FWHT (vicodec) */
701
702 /* Vendor-specific formats */
703 #define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
704 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
705 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
706 #define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
707 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
708 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
709 #define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
710 #define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
711 #define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
712 #define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
713 #define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
714 #define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
715 #define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
716 #define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
717 #define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
718 #define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
719 #define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
720 #define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
721 #define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
722 #define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
723 #define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
724 #define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
725 #define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
726 #define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
727 #define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
728 #define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
729 #define V4L2_PIX_FMT_Y8I v4l2_fourcc('Y', '8', 'I', ' ') /* Greyscale 8-bit L/R interleaved */
730 #define V4L2_PIX_FMT_Y12I v4l2_fourcc('Y', '1', '2', 'I') /* Greyscale 12-bit L/R interleaved */
731 #define V4L2_PIX_FMT_Z16 v4l2_fourcc('Z', '1', '6', ' ') /* Depth data 16-bit */
732 #define V4L2_PIX_FMT_MT21C v4l2_fourcc('M', 'T', '2', '1') /* Mediatek compressed block mode */
733 #define V4L2_PIX_FMT_INZI v4l2_fourcc('I', 'N', 'Z', 'I') /* Intel Planar Greyscale 10-bit and Depth 16-bit */
734 #define V4L2_PIX_FMT_SUNXI_TILED_NV12 v4l2_fourcc('S', 'T', '1', '2') /* Sunxi Tiled NV12 Format */
735 #define V4L2_PIX_FMT_CNF4 v4l2_fourcc('C', 'N', 'F', '4') /* Intel 4-bit packed depth confidence information */
736
737 /* 10bit raw bayer packed, 32 bytes for every 25 pixels, last LSB 6 bits unused */
738 #define V4L2_PIX_FMT_IPU3_SBGGR10 v4l2_fourcc('i', 'p', '3', 'b') /* IPU3 packed 10-bit BGGR bayer */
739 #define V4L2_PIX_FMT_IPU3_SGBRG10 v4l2_fourcc('i', 'p', '3', 'g') /* IPU3 packed 10-bit GBRG bayer */
740 #define V4L2_PIX_FMT_IPU3_SGRBG10 v4l2_fourcc('i', 'p', '3', 'G') /* IPU3 packed 10-bit GRBG bayer */
741 #define V4L2_PIX_FMT_IPU3_SRGGB10 v4l2_fourcc('i', 'p', '3', 'r') /* IPU3 packed 10-bit RGGB bayer */
742
743 /* SDR formats - used only for Software Defined Radio devices */
744 #define V4L2_SDR_FMT_CU8 v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
745 #define V4L2_SDR_FMT_CU16LE v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
746 #define V4L2_SDR_FMT_CS8 v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
747 #define V4L2_SDR_FMT_CS14LE v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
748 #define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
749 #define V4L2_SDR_FMT_PCU16BE v4l2_fourcc('P', 'C', '1', '6') /* planar complex u16be */
750 #define V4L2_SDR_FMT_PCU18BE v4l2_fourcc('P', 'C', '1', '8') /* planar complex u18be */
751 #define V4L2_SDR_FMT_PCU20BE v4l2_fourcc('P', 'C', '2', '0') /* planar complex u20be */
752
753 /* Touch formats - used for Touch devices */
754 #define V4L2_TCH_FMT_DELTA_TD16 v4l2_fourcc('T', 'D', '1', '6') /* 16-bit signed deltas */
755 #define V4L2_TCH_FMT_DELTA_TD08 v4l2_fourcc('T', 'D', '0', '8') /* 8-bit signed deltas */
756 #define V4L2_TCH_FMT_TU16 v4l2_fourcc('T', 'U', '1', '6') /* 16-bit unsigned touch data */
757 #define V4L2_TCH_FMT_TU08 v4l2_fourcc('T', 'U', '0', '8') /* 8-bit unsigned touch data */
758
759 /* Meta-data formats */
760 #define V4L2_META_FMT_VSP1_HGO v4l2_fourcc('V', 'S', 'P', 'H') /* R-Car VSP1 1-D Histogram */
761 #define V4L2_META_FMT_VSP1_HGT v4l2_fourcc('V', 'S', 'P', 'T') /* R-Car VSP1 2-D Histogram */
762 #define V4L2_META_FMT_UVC v4l2_fourcc('U', 'V', 'C', 'H') /* UVC Payload Header metadata */
763 #define V4L2_META_FMT_D4XX v4l2_fourcc('D', '4', 'X', 'X') /* D4XX Payload Header metadata */
764 #define V4L2_META_FMT_VIVID v4l2_fourcc('V', 'I', 'V', 'D') /* Vivid Metadata */
765
766 /* priv field value to indicates that subsequent fields are valid. */
767 #define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
768
769 /* Flags */
770 #define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
771
772 /*
773 * F O R M A T E N U M E R A T I O N
774 */
775 struct v4l2_fmtdesc {
776 uint32_t index; /* Format number */
777 uint32_t type; /* enum v4l2_buf_type */
778 uint32_t flags;
779 uint8_t description[32]; /* Description string */
780 uint32_t pixelformat; /* Format fourcc */
781 uint32_t mbus_code; /* Media bus code */
782 uint32_t reserved[3];
783 };
784
785 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
786 #define V4L2_FMT_FLAG_EMULATED 0x0002
787 #define V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM 0x0004
788 #define V4L2_FMT_FLAG_DYN_RESOLUTION 0x0008
789
790 /* Frame Size and frame rate enumeration */
791 /*
792 * F R A M E S I Z E E N U M E R A T I O N
793 */
794 enum v4l2_frmsizetypes {
795 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
796 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
797 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
798 };
799
800 struct v4l2_frmsize_discrete {
801 uint32_t width; /* Frame width [pixel] */
802 uint32_t height; /* Frame height [pixel] */
803 };
804
805 struct v4l2_frmsize_stepwise {
806 uint32_t min_width; /* Minimum frame width [pixel] */
807 uint32_t max_width; /* Maximum frame width [pixel] */
808 uint32_t step_width; /* Frame width step size [pixel] */
809 uint32_t min_height; /* Minimum frame height [pixel] */
810 uint32_t max_height; /* Maximum frame height [pixel] */
811 uint32_t step_height; /* Frame height step size [pixel] */
812 };
813
814 struct v4l2_frmsizeenum {
815 uint32_t index; /* Frame size number */
816 uint32_t pixel_format; /* Pixel format */
817 uint32_t type; /* Frame size type the device supports. */
818
819 union { /* Frame size */
820 struct v4l2_frmsize_discrete discrete;
821 struct v4l2_frmsize_stepwise stepwise;
822 };
823
824 uint32_t reserved[2]; /* Reserved space for future use */
825 };
826
827 /*
828 * F R A M E R A T E E N U M E R A T I O N
829 */
830 enum v4l2_frmivaltypes {
831 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
832 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
833 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
834 };
835
836 struct v4l2_frmival_stepwise {
837 struct v4l2_fract min; /* Minimum frame interval [s] */
838 struct v4l2_fract max; /* Maximum frame interval [s] */
839 struct v4l2_fract step; /* Frame interval step size [s] */
840 };
841
842 struct v4l2_frmivalenum {
843 uint32_t index; /* Frame format index */
844 uint32_t pixel_format; /* Pixel format */
845 uint32_t width; /* Frame width */
846 uint32_t height; /* Frame height */
847 uint32_t type; /* Frame interval type the device supports. */
848
849 union { /* Frame interval */
850 struct v4l2_fract discrete;
851 struct v4l2_frmival_stepwise stepwise;
852 };
853
854 uint32_t reserved[2]; /* Reserved space for future use */
855 };
856
857 /*
858 * T I M E C O D E
859 */
860 struct v4l2_timecode {
861 uint32_t type;
862 uint32_t flags;
863 uint8_t frames;
864 uint8_t seconds;
865 uint8_t minutes;
866 uint8_t hours;
867 uint8_t userbits[4];
868 };
869
870 /* Type */
871 #define V4L2_TC_TYPE_24FPS 1
872 #define V4L2_TC_TYPE_25FPS 2
873 #define V4L2_TC_TYPE_30FPS 3
874 #define V4L2_TC_TYPE_50FPS 4
875 #define V4L2_TC_TYPE_60FPS 5
876
877 /* Flags */
878 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
879 #define V4L2_TC_FLAG_COLORFRAME 0x0002
880 #define V4L2_TC_USERBITS_field 0x000C
881 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
882 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
883 /* The above is based on SMPTE timecodes */
884
885 struct v4l2_jpegcompression {
886 int quality;
887
888 int APPn; /* Number of APP segment to be written,
889 * must be 0..15 */
890 int APP_len; /* Length of data in JPEG APPn segment */
891 char APP_data[60]; /* Data in the JPEG APPn segment. */
892
893 int COM_len; /* Length of data in JPEG COM segment */
894 char COM_data[60]; /* Data in JPEG COM segment */
895
896 uint32_t jpeg_markers; /* Which markers should go into the JPEG
897 * output. Unless you exactly know what
898 * you do, leave them untouched.
899 * Including less markers will make the
900 * resulting code smaller, but there will
901 * be fewer applications which can read it.
902 * The presence of the APP and COM marker
903 * is influenced by APP_len and COM_len
904 * ONLY, not by this property! */
905
906 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
907 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
908 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
909 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
910 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
911 * always use APP0 */
912 };
913
914 /*
915 * M E M O R Y - M A P P I N G B U F F E R S
916 */
917
918
919 struct v4l2_requestbuffers {
920 uint32_t count;
921 uint32_t type; /* enum v4l2_buf_type */
922 uint32_t memory; /* enum v4l2_memory */
923 uint32_t capabilities;
924 uint32_t reserved[1];
925 };
926
927 /* capabilities for struct v4l2_requestbuffers and v4l2_create_buffers */
928 #define V4L2_BUF_CAP_SUPPORTS_MMAP (1 << 0)
929 #define V4L2_BUF_CAP_SUPPORTS_USERPTR (1 << 1)
930 #define V4L2_BUF_CAP_SUPPORTS_DMABUF (1 << 2)
931 #define V4L2_BUF_CAP_SUPPORTS_REQUESTS (1 << 3)
932 #define V4L2_BUF_CAP_SUPPORTS_ORPHANED_BUFS (1 << 4)
933 #define V4L2_BUF_CAP_SUPPORTS_M2M_HOLD_CAPTURE_BUF (1 << 5)
934
935 /**
936 * struct v4l2_plane - plane info for multi-planar buffers
937 * @bytesused: number of bytes occupied by data in the plane (payload)
938 * @length: size of this plane (NOT the payload) in bytes
939 * @mem_offset: when memory in the associated struct v4l2_buffer is
940 * V4L2_MEMORY_MMAP, equals the offset from the start of
941 * the device memory for this plane (or is a "cookie" that
942 * should be passed to mmap() called on the video node)
943 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
944 * pointing to this plane
945 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
946 * descriptor associated with this plane
947 * @data_offset: offset in the plane to the start of data; usually 0,
948 * unless there is a header in front of the data
949 *
950 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
951 * with two planes can have one plane for Y, and another for interleaved CbCr
952 * components. Each plane can reside in a separate memory buffer, or even in
953 * a completely separate memory node (e.g. in embedded devices).
954 */
955 struct v4l2_plane {
956 uint32_t bytesused;
957 uint32_t length;
958 union {
959 uint32_t mem_offset;
960 unsigned long userptr;
961 int32_t fd;
962 } m;
963 uint32_t data_offset;
964 uint32_t reserved[11];
965 };
966
967 /**
968 * struct v4l2_buffer - video buffer info
969 * @index: id number of the buffer
970 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
971 * multiplanar buffers);
972 * @bytesused: number of bytes occupied by data in the buffer (payload);
973 * unused (set to 0) for multiplanar buffers
974 * @flags: buffer informational flags
975 * @field: enum v4l2_field; field order of the image in the buffer
976 * @timestamp: frame timestamp
977 * @timecode: frame timecode
978 * @sequence: sequence count of this frame
979 * @memory: enum v4l2_memory; the method, in which the actual video data is
980 * passed
981 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
982 * offset from the start of the device memory for this plane,
983 * (or a "cookie" that should be passed to mmap() as offset)
984 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
985 * a userspace pointer pointing to this buffer
986 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
987 * a userspace file descriptor associated with this buffer
988 * @planes: for multiplanar buffers; userspace pointer to the array of plane
989 * info structs for this buffer
990 * @length: size in bytes of the buffer (NOT its payload) for single-plane
991 * buffers (when type != *_MPLANE); number of elements in the
992 * planes array for multi-plane buffers
993 * @request_fd: fd of the request that this buffer should use
994 *
995 * Contains data exchanged by application and driver using one of the Streaming
996 * I/O methods.
997 */
998 struct v4l2_buffer {
999 uint32_t index;
1000 uint32_t type;
1001 uint32_t bytesused;
1002 uint32_t flags;
1003 uint32_t field;
1004 struct timeval timestamp;
1005 struct v4l2_timecode timecode;
1006 uint32_t sequence;
1007
1008 /* memory location */
1009 uint32_t memory;
1010 union {
1011 uint32_t offset;
1012 unsigned long userptr;
1013 struct v4l2_plane *planes;
1014 int32_t fd;
1015 } m;
1016 uint32_t length;
1017 uint32_t reserved2;
1018 union {
1019 int32_t request_fd;
1020 uint32_t reserved;
1021 };
1022 };
1023
1024 /**
1025 * v4l2_timeval_to_ns - Convert timeval to nanoseconds
1026 * @ts: pointer to the timeval variable to be converted
1027 *
1028 * Returns the scalar nanosecond representation of the timeval
1029 * parameter.
1030 */
v4l2_timeval_to_ns(const struct timeval * tv)1031 static inline uint64_t v4l2_timeval_to_ns(const struct timeval *tv)
1032 {
1033 return (uint64_t)tv->tv_sec * 1000000000ULL + tv->tv_usec * 1000;
1034 }
1035
1036 /* Flags for 'flags' field */
1037 /* Buffer is mapped (flag) */
1038 #define V4L2_BUF_FLAG_MAPPED 0x00000001
1039 /* Buffer is queued for processing */
1040 #define V4L2_BUF_FLAG_QUEUED 0x00000002
1041 /* Buffer is ready */
1042 #define V4L2_BUF_FLAG_DONE 0x00000004
1043 /* Image is a keyframe (I-frame) */
1044 #define V4L2_BUF_FLAG_KEYFRAME 0x00000008
1045 /* Image is a P-frame */
1046 #define V4L2_BUF_FLAG_PFRAME 0x00000010
1047 /* Image is a B-frame */
1048 #define V4L2_BUF_FLAG_BFRAME 0x00000020
1049 /* Buffer is ready, but the data contained within is corrupted. */
1050 #define V4L2_BUF_FLAG_ERROR 0x00000040
1051 /* Buffer is added to an unqueued request */
1052 #define V4L2_BUF_FLAG_IN_REQUEST 0x00000080
1053 /* timecode field is valid */
1054 #define V4L2_BUF_FLAG_TIMECODE 0x00000100
1055 /* Don't return the capture buffer until OUTPUT timestamp changes */
1056 #define V4L2_BUF_FLAG_M2M_HOLD_CAPTURE_BUF 0x00000200
1057 /* Buffer is prepared for queuing */
1058 #define V4L2_BUF_FLAG_PREPARED 0x00000400
1059 /* Cache handling flags */
1060 #define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
1061 #define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
1062 /* Timestamp type */
1063 #define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
1064 #define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
1065 #define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
1066 #define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
1067 /* Timestamp sources. */
1068 #define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
1069 #define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
1070 #define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
1071 /* mem2mem encoder/decoder */
1072 #define V4L2_BUF_FLAG_LAST 0x00100000
1073 /* request_fd is valid */
1074 #define V4L2_BUF_FLAG_REQUEST_FD 0x00800000
1075
1076 /**
1077 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
1078 *
1079 * @index: id number of the buffer
1080 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
1081 * multiplanar buffers);
1082 * @plane: index of the plane to be exported, 0 for single plane queues
1083 * @flags: flags for newly created file, currently only O_CLOEXEC is
1084 * supported, refer to manual of open syscall for more details
1085 * @fd: file descriptor associated with DMABUF (set by driver)
1086 *
1087 * Contains data used for exporting a video buffer as DMABUF file descriptor.
1088 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
1089 * (identical to the cookie used to mmap() the buffer to userspace). All
1090 * reserved fields must be set to zero. The field reserved0 is expected to
1091 * become a structure 'type' allowing an alternative layout of the structure
1092 * content. Therefore this field should not be used for any other extensions.
1093 */
1094 struct v4l2_exportbuffer {
1095 uint32_t type; /* enum v4l2_buf_type */
1096 uint32_t index;
1097 uint32_t plane;
1098 uint32_t flags;
1099 int32_t fd;
1100 uint32_t reserved[11];
1101 };
1102
1103 /*
1104 * O V E R L A Y P R E V I E W
1105 */
1106 struct v4l2_framebuffer {
1107 uint32_t capability;
1108 uint32_t flags;
1109 /* FIXME: in theory we should pass something like PCI device + memory
1110 * region + offset instead of some physical address */
1111 void *base;
1112 struct {
1113 uint32_t width;
1114 uint32_t height;
1115 uint32_t pixelformat;
1116 uint32_t field; /* enum v4l2_field */
1117 uint32_t bytesperline; /* for padding, zero if unused */
1118 uint32_t sizeimage;
1119 uint32_t colorspace; /* enum v4l2_colorspace */
1120 uint32_t priv; /* reserved field, set to 0 */
1121 } fmt;
1122 };
1123 /* Flags for the 'capability' field. Read only */
1124 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
1125 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
1126 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
1127 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
1128 #define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
1129 #define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
1130 #define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
1131 #define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
1132 /* Flags for the 'flags' field. */
1133 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
1134 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
1135 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
1136 #define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
1137 #define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
1138 #define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
1139 #define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
1140
1141 struct v4l2_clip {
1142 struct v4l2_rect c;
1143 struct v4l2_clip *next;
1144 };
1145
1146 struct v4l2_window {
1147 struct v4l2_rect w;
1148 uint32_t field; /* enum v4l2_field */
1149 uint32_t chromakey;
1150 struct v4l2_clip *clips;
1151 uint32_t clipcount;
1152 void *bitmap;
1153 uint8_t global_alpha;
1154 };
1155
1156 /*
1157 * C A P T U R E P A R A M E T E R S
1158 */
1159 struct v4l2_captureparm {
1160 uint32_t capability; /* Supported modes */
1161 uint32_t capturemode; /* Current mode */
1162 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1163 uint32_t extendedmode; /* Driver-specific extensions */
1164 uint32_t readbuffers; /* # of buffers for read */
1165 uint32_t reserved[4];
1166 };
1167
1168 /* Flags for 'capability' and 'capturemode' fields */
1169 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
1170 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
1171
1172 struct v4l2_outputparm {
1173 uint32_t capability; /* Supported modes */
1174 uint32_t outputmode; /* Current mode */
1175 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1176 uint32_t extendedmode; /* Driver-specific extensions */
1177 uint32_t writebuffers; /* # of buffers for write */
1178 uint32_t reserved[4];
1179 };
1180
1181 /*
1182 * I N P U T I M A G E C R O P P I N G
1183 */
1184 struct v4l2_cropcap {
1185 uint32_t type; /* enum v4l2_buf_type */
1186 struct v4l2_rect bounds;
1187 struct v4l2_rect defrect;
1188 struct v4l2_fract pixelaspect;
1189 };
1190
1191 struct v4l2_crop {
1192 uint32_t type; /* enum v4l2_buf_type */
1193 struct v4l2_rect c;
1194 };
1195
1196 /**
1197 * struct v4l2_selection - selection info
1198 * @type: buffer type (do not use *_MPLANE types)
1199 * @target: Selection target, used to choose one of possible rectangles;
1200 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
1201 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1202 * @r: coordinates of selection window
1203 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
1204 *
1205 * Hardware may use multiple helper windows to process a video stream.
1206 * The structure is used to exchange this selection areas between
1207 * an application and a driver.
1208 */
1209 struct v4l2_selection {
1210 uint32_t type;
1211 uint32_t target;
1212 uint32_t flags;
1213 struct v4l2_rect r;
1214 uint32_t reserved[9];
1215 };
1216
1217
1218 /*
1219 * A N A L O G V I D E O S T A N D A R D
1220 */
1221
1222 typedef uint64_t v4l2_std_id;
1223
1224 /*
1225 * Attention: Keep the V4L2_STD_* bit definitions in sync with
1226 * include/dt-bindings/display/sdtv-standards.h SDTV_STD_* bit definitions.
1227 */
1228 /* one bit for each */
1229 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
1230 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
1231 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
1232 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
1233 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
1234 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
1235 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
1236 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
1237
1238 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
1239 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
1240 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
1241 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
1242
1243 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
1244 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
1245 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
1246 #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
1247
1248 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
1249 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
1250 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
1251 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
1252 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
1253 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
1254 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
1255 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
1256
1257 /* ATSC/HDTV */
1258 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
1259 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
1260
1261 /* FIXME:
1262 Although std_id is 64 bits, there is an issue on PPC32 architecture that
1263 makes switch(uint64_t) to break. So, there's a hack on v4l2-common.c rounding
1264 this value to 32 bits.
1265 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1266 it should work fine. However, if needed to add more than two standards,
1267 v4l2-common.c should be fixed.
1268 */
1269
1270 /*
1271 * Some macros to merge video standards in order to make live easier for the
1272 * drivers and V4L2 applications
1273 */
1274
1275 /*
1276 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1277 * Missing here.
1278 */
1279 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
1280 V4L2_STD_NTSC_M_JP |\
1281 V4L2_STD_NTSC_M_KR)
1282 /* Secam macros */
1283 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
1284 V4L2_STD_SECAM_K |\
1285 V4L2_STD_SECAM_K1)
1286 /* All Secam Standards */
1287 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
1288 V4L2_STD_SECAM_G |\
1289 V4L2_STD_SECAM_H |\
1290 V4L2_STD_SECAM_DK |\
1291 V4L2_STD_SECAM_L |\
1292 V4L2_STD_SECAM_LC)
1293 /* PAL macros */
1294 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
1295 V4L2_STD_PAL_B1 |\
1296 V4L2_STD_PAL_G)
1297 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
1298 V4L2_STD_PAL_D1 |\
1299 V4L2_STD_PAL_K)
1300 /*
1301 * "Common" PAL - This macro is there to be compatible with the old
1302 * V4L1 concept of "PAL": /BGDKHI.
1303 * Several PAL standards are missing here: /M, /N and /Nc
1304 */
1305 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
1306 V4L2_STD_PAL_DK |\
1307 V4L2_STD_PAL_H |\
1308 V4L2_STD_PAL_I)
1309 /* Chroma "agnostic" standards */
1310 #define V4L2_STD_B (V4L2_STD_PAL_B |\
1311 V4L2_STD_PAL_B1 |\
1312 V4L2_STD_SECAM_B)
1313 #define V4L2_STD_G (V4L2_STD_PAL_G |\
1314 V4L2_STD_SECAM_G)
1315 #define V4L2_STD_H (V4L2_STD_PAL_H |\
1316 V4L2_STD_SECAM_H)
1317 #define V4L2_STD_L (V4L2_STD_SECAM_L |\
1318 V4L2_STD_SECAM_LC)
1319 #define V4L2_STD_GH (V4L2_STD_G |\
1320 V4L2_STD_H)
1321 #define V4L2_STD_DK (V4L2_STD_PAL_DK |\
1322 V4L2_STD_SECAM_DK)
1323 #define V4L2_STD_BG (V4L2_STD_B |\
1324 V4L2_STD_G)
1325 #define V4L2_STD_MN (V4L2_STD_PAL_M |\
1326 V4L2_STD_PAL_N |\
1327 V4L2_STD_PAL_Nc |\
1328 V4L2_STD_NTSC)
1329
1330 /* Standards where MTS/BTSC stereo could be found */
1331 #define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
1332 V4L2_STD_PAL_M |\
1333 V4L2_STD_PAL_N |\
1334 V4L2_STD_PAL_Nc)
1335
1336 /* Standards for Countries with 60Hz Line frequency */
1337 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
1338 V4L2_STD_PAL_60 |\
1339 V4L2_STD_NTSC |\
1340 V4L2_STD_NTSC_443)
1341 /* Standards for Countries with 50Hz Line frequency */
1342 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
1343 V4L2_STD_PAL_N |\
1344 V4L2_STD_PAL_Nc |\
1345 V4L2_STD_SECAM)
1346
1347 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1348 V4L2_STD_ATSC_16_VSB)
1349 /* Macros with none and all analog standards */
1350 #define V4L2_STD_UNKNOWN 0
1351 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
1352 V4L2_STD_625_50)
1353
1354 struct v4l2_standard {
1355 uint32_t index;
1356 v4l2_std_id id;
1357 uint8_t name[24];
1358 struct v4l2_fract frameperiod; /* Frames, not fields */
1359 uint32_t framelines;
1360 uint32_t reserved[4];
1361 };
1362
1363 /*
1364 * D V B T T I M I N G S
1365 */
1366
1367 /** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1368 * @width: total width of the active video in pixels
1369 * @height: total height of the active video in lines
1370 * @interlaced: Interlaced or progressive
1371 * @polarities: Positive or negative polarities
1372 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1373 * @hfrontporch:Horizontal front porch in pixels
1374 * @hsync: Horizontal Sync length in pixels
1375 * @hbackporch: Horizontal back porch in pixels
1376 * @vfrontporch:Vertical front porch in lines
1377 * @vsync: Vertical Sync length in lines
1378 * @vbackporch: Vertical back porch in lines
1379 * @il_vfrontporch:Vertical front porch for the even field
1380 * (aka field 2) of interlaced field formats
1381 * @il_vsync: Vertical Sync length for the even field
1382 * (aka field 2) of interlaced field formats
1383 * @il_vbackporch:Vertical back porch for the even field
1384 * (aka field 2) of interlaced field formats
1385 * @standards: Standards the timing belongs to
1386 * @flags: Flags
1387 * @picture_aspect: The picture aspect ratio (hor/vert).
1388 * @cea861_vic: VIC code as per the CEA-861 standard.
1389 * @hdmi_vic: VIC code as per the HDMI standard.
1390 * @reserved: Reserved fields, must be zeroed.
1391 *
1392 * A note regarding vertical interlaced timings: height refers to the total
1393 * height of the active video frame (= two fields). The blanking timings refer
1394 * to the blanking of each field. So the height of the total frame is
1395 * calculated as follows:
1396 *
1397 * tot_height = height + vfrontporch + vsync + vbackporch +
1398 * il_vfrontporch + il_vsync + il_vbackporch
1399 *
1400 * The active height of each field is height / 2.
1401 */
1402 struct v4l2_bt_timings {
1403 uint32_t width;
1404 uint32_t height;
1405 uint32_t interlaced;
1406 uint32_t polarities;
1407 uint64_t pixelclock;
1408 uint32_t hfrontporch;
1409 uint32_t hsync;
1410 uint32_t hbackporch;
1411 uint32_t vfrontporch;
1412 uint32_t vsync;
1413 uint32_t vbackporch;
1414 uint32_t il_vfrontporch;
1415 uint32_t il_vsync;
1416 uint32_t il_vbackporch;
1417 uint32_t standards;
1418 uint32_t flags;
1419 struct v4l2_fract picture_aspect;
1420 uint8_t cea861_vic;
1421 uint8_t hdmi_vic;
1422 uint8_t reserved[46];
1423 } __attribute__ ((packed));
1424
1425 /* Interlaced or progressive format */
1426 #define V4L2_DV_PROGRESSIVE 0
1427 #define V4L2_DV_INTERLACED 1
1428
1429 /* Polarities. If bit is not set, it is assumed to be negative polarity */
1430 #define V4L2_DV_VSYNC_POS_POL 0x00000001
1431 #define V4L2_DV_HSYNC_POS_POL 0x00000002
1432
1433 /* Timings standards */
1434 #define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1435 #define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1436 #define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1437 #define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
1438 #define V4L2_DV_BT_STD_SDI (1 << 4) /* SDI Timings */
1439
1440 /* Flags */
1441
1442 /*
1443 * CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1444 * GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1445 * intervals are reduced, allowing a higher resolution over the same
1446 * bandwidth. This is a read-only flag.
1447 */
1448 #define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1449 /*
1450 * CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1451 * of six. These formats can be optionally played at 1 / 1.001 speed.
1452 * This is a read-only flag.
1453 */
1454 #define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1455 /*
1456 * CEA-861 specific: only valid for video transmitters, the flag is cleared
1457 * by receivers.
1458 * If the framerate of the format is a multiple of six, then the pixelclock
1459 * used to set up the transmitter is divided by 1.001 to make it compatible
1460 * with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1461 * 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1462 * such frequencies, then the flag will also be cleared.
1463 */
1464 #define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1465 /*
1466 * Specific to interlaced formats: if set, then field 1 is really one half-line
1467 * longer and field 2 is really one half-line shorter, so each field has
1468 * exactly the same number of half-lines. Whether half-lines can be detected
1469 * or used depends on the hardware.
1470 */
1471 #define V4L2_DV_FL_HALF_LINE (1 << 3)
1472 /*
1473 * If set, then this is a Consumer Electronics (CE) video format. Such formats
1474 * differ from other formats (commonly called IT formats) in that if RGB
1475 * encoding is used then by default the RGB values use limited range (i.e.
1476 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
1477 * except for the 640x480 format are CE formats.
1478 */
1479 #define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
1480 /* Some formats like SMPTE-125M have an interlaced signal with a odd
1481 * total height. For these formats, if this flag is set, the first
1482 * field has the extra line. If not, it is the second field.
1483 */
1484 #define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE (1 << 5)
1485 /*
1486 * If set, then the picture_aspect field is valid. Otherwise assume that the
1487 * pixels are square, so the picture aspect ratio is the same as the width to
1488 * height ratio.
1489 */
1490 #define V4L2_DV_FL_HAS_PICTURE_ASPECT (1 << 6)
1491 /*
1492 * If set, then the cea861_vic field is valid and contains the Video
1493 * Identification Code as per the CEA-861 standard.
1494 */
1495 #define V4L2_DV_FL_HAS_CEA861_VIC (1 << 7)
1496 /*
1497 * If set, then the hdmi_vic field is valid and contains the Video
1498 * Identification Code as per the HDMI standard (HDMI Vendor Specific
1499 * InfoFrame).
1500 */
1501 #define V4L2_DV_FL_HAS_HDMI_VIC (1 << 8)
1502 /*
1503 * CEA-861 specific: only valid for video receivers.
1504 * If set, then HW can detect the difference between regular FPS and
1505 * 1000/1001 FPS. Note: This flag is only valid for HDMI VIC codes with
1506 * the V4L2_DV_FL_CAN_REDUCE_FPS flag set.
1507 */
1508 #define V4L2_DV_FL_CAN_DETECT_REDUCED_FPS (1 << 9)
1509
1510 /* A few useful defines to calculate the total blanking and frame sizes */
1511 #define V4L2_DV_BT_BLANKING_WIDTH(bt) \
1512 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
1513 #define V4L2_DV_BT_FRAME_WIDTH(bt) \
1514 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
1515 #define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
1516 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1517 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
1518 #define V4L2_DV_BT_FRAME_HEIGHT(bt) \
1519 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
1520
1521 /** struct v4l2_dv_timings - DV timings
1522 * @type: the type of the timings
1523 * @bt: BT656/1120 timings
1524 */
1525 struct v4l2_dv_timings {
1526 uint32_t type;
1527 union {
1528 struct v4l2_bt_timings bt;
1529 uint32_t reserved[32];
1530 };
1531 } __attribute__ ((packed));
1532
1533 /* Values for the type field */
1534 #define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1535
1536
1537 /** struct v4l2_enum_dv_timings - DV timings enumeration
1538 * @index: enumeration index
1539 * @pad: the pad number for which to enumerate timings (used with
1540 * v4l-subdev nodes only)
1541 * @reserved: must be zeroed
1542 * @timings: the timings for the given index
1543 */
1544 struct v4l2_enum_dv_timings {
1545 uint32_t index;
1546 uint32_t pad;
1547 uint32_t reserved[2];
1548 struct v4l2_dv_timings timings;
1549 };
1550
1551 /** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1552 * @min_width: width in pixels
1553 * @max_width: width in pixels
1554 * @min_height: height in lines
1555 * @max_height: height in lines
1556 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1557 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1558 * @standards: Supported standards
1559 * @capabilities: Supported capabilities
1560 * @reserved: Must be zeroed
1561 */
1562 struct v4l2_bt_timings_cap {
1563 uint32_t min_width;
1564 uint32_t max_width;
1565 uint32_t min_height;
1566 uint32_t max_height;
1567 uint64_t min_pixelclock;
1568 uint64_t max_pixelclock;
1569 uint32_t standards;
1570 uint32_t capabilities;
1571 uint32_t reserved[16];
1572 } __attribute__ ((packed));
1573
1574 /* Supports interlaced formats */
1575 #define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1576 /* Supports progressive formats */
1577 #define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1578 /* Supports CVT/GTF reduced blanking */
1579 #define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1580 /* Supports custom formats */
1581 #define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1582
1583 /** struct v4l2_dv_timings_cap - DV timings capabilities
1584 * @type: the type of the timings (same as in struct v4l2_dv_timings)
1585 * @pad: the pad number for which to query capabilities (used with
1586 * v4l-subdev nodes only)
1587 * @bt: the BT656/1120 timings capabilities
1588 */
1589 struct v4l2_dv_timings_cap {
1590 uint32_t type;
1591 uint32_t pad;
1592 uint32_t reserved[2];
1593 union {
1594 struct v4l2_bt_timings_cap bt;
1595 uint32_t raw_data[32];
1596 };
1597 };
1598
1599
1600 /*
1601 * V I D E O I N P U T S
1602 */
1603 struct v4l2_input {
1604 uint32_t index; /* Which input */
1605 uint8_t name[32]; /* Label */
1606 uint32_t type; /* Type of input */
1607 uint32_t audioset; /* Associated audios (bitfield) */
1608 uint32_t tuner; /* enum v4l2_tuner_type */
1609 v4l2_std_id std;
1610 uint32_t status;
1611 uint32_t capabilities;
1612 uint32_t reserved[3];
1613 };
1614
1615 /* Values for the 'type' field */
1616 #define V4L2_INPUT_TYPE_TUNER 1
1617 #define V4L2_INPUT_TYPE_CAMERA 2
1618 #define V4L2_INPUT_TYPE_TOUCH 3
1619
1620 /* field 'status' - general */
1621 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1622 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
1623 #define V4L2_IN_ST_NO_COLOR 0x00000004
1624
1625 /* field 'status' - sensor orientation */
1626 /* If sensor is mounted upside down set both bits */
1627 #define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1628 #define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1629
1630 /* field 'status' - analog */
1631 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1632 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1633 #define V4L2_IN_ST_NO_V_LOCK 0x00000400 /* No vertical sync lock */
1634 #define V4L2_IN_ST_NO_STD_LOCK 0x00000800 /* No standard format lock */
1635
1636 /* field 'status' - digital */
1637 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1638 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1639 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1640
1641 /* field 'status' - VCR and set-top box */
1642 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1643 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1644 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1645
1646 /* capabilities flags */
1647 #define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1648 #define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1649 #define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
1650 #define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1651
1652 /*
1653 * V I D E O O U T P U T S
1654 */
1655 struct v4l2_output {
1656 uint32_t index; /* Which output */
1657 uint8_t name[32]; /* Label */
1658 uint32_t type; /* Type of output */
1659 uint32_t audioset; /* Associated audios (bitfield) */
1660 uint32_t modulator; /* Associated modulator */
1661 v4l2_std_id std;
1662 uint32_t capabilities;
1663 uint32_t reserved[3];
1664 };
1665 /* Values for the 'type' field */
1666 #define V4L2_OUTPUT_TYPE_MODULATOR 1
1667 #define V4L2_OUTPUT_TYPE_ANALOG 2
1668 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1669
1670 /* capabilities flags */
1671 #define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1672 #define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1673 #define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
1674 #define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1675
1676 /*
1677 * C O N T R O L S
1678 */
1679 struct v4l2_control {
1680 uint32_t id;
1681 int32_t value;
1682 };
1683
1684 struct v4l2_ext_control {
1685 uint32_t id;
1686 uint32_t size;
1687 uint32_t reserved2[1];
1688 union {
1689 int32_t value;
1690 int64_t value64;
1691 char *string;
1692 uint8_t *p_u8;
1693 uint16_t *p_u16;
1694 uint32_t *p_u32;
1695 struct v4l2_area *p_area;
1696 void *ptr;
1697 };
1698 } __attribute__ ((packed));
1699
1700 struct v4l2_ext_controls {
1701 union {
1702 uint32_t ctrl_class;
1703 uint32_t which;
1704 };
1705 uint32_t count;
1706 uint32_t error_idx;
1707 int32_t request_fd;
1708 uint32_t reserved[1];
1709 struct v4l2_ext_control *controls;
1710 };
1711
1712 #define V4L2_CTRL_ID_MASK (0x0fffffff)
1713 #define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1714 #define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
1715 #define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1716 #define V4L2_CTRL_MAX_DIMS (4)
1717 #define V4L2_CTRL_WHICH_CUR_VAL 0
1718 #define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
1719 #define V4L2_CTRL_WHICH_REQUEST_VAL 0x0f010000
1720
1721 enum v4l2_ctrl_type {
1722 V4L2_CTRL_TYPE_INTEGER = 1,
1723 V4L2_CTRL_TYPE_BOOLEAN = 2,
1724 V4L2_CTRL_TYPE_MENU = 3,
1725 V4L2_CTRL_TYPE_BUTTON = 4,
1726 V4L2_CTRL_TYPE_INTEGER64 = 5,
1727 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1728 V4L2_CTRL_TYPE_STRING = 7,
1729 V4L2_CTRL_TYPE_BITMASK = 8,
1730 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1731
1732 /* Compound types are >= 0x0100 */
1733 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
1734 V4L2_CTRL_TYPE_U8 = 0x0100,
1735 V4L2_CTRL_TYPE_U16 = 0x0101,
1736 V4L2_CTRL_TYPE_U32 = 0x0102,
1737 V4L2_CTRL_TYPE_AREA = 0x0106,
1738 };
1739
1740 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1741 struct v4l2_queryctrl {
1742 uint32_t id;
1743 uint32_t type; /* enum v4l2_ctrl_type */
1744 uint8_t name[32]; /* Whatever */
1745 int32_t minimum; /* Note signedness */
1746 int32_t maximum;
1747 int32_t step;
1748 int32_t default_value;
1749 uint32_t flags;
1750 uint32_t reserved[2];
1751 };
1752
1753 /* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1754 struct v4l2_query_ext_ctrl {
1755 uint32_t id;
1756 uint32_t type;
1757 char name[32];
1758 int64_t minimum;
1759 int64_t maximum;
1760 uint64_t step;
1761 int64_t default_value;
1762 uint32_t flags;
1763 uint32_t elem_size;
1764 uint32_t elems;
1765 uint32_t nr_of_dims;
1766 uint32_t dims[V4L2_CTRL_MAX_DIMS];
1767 uint32_t reserved[32];
1768 };
1769
1770 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1771 struct v4l2_querymenu {
1772 uint32_t id;
1773 uint32_t index;
1774 union {
1775 uint8_t name[32]; /* Whatever */
1776 int64_t value;
1777 };
1778 uint32_t reserved;
1779 } __attribute__ ((packed));
1780
1781 /* Control flags */
1782 #define V4L2_CTRL_FLAG_DISABLED 0x0001
1783 #define V4L2_CTRL_FLAG_GRABBED 0x0002
1784 #define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1785 #define V4L2_CTRL_FLAG_UPDATE 0x0008
1786 #define V4L2_CTRL_FLAG_INACTIVE 0x0010
1787 #define V4L2_CTRL_FLAG_SLIDER 0x0020
1788 #define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1789 #define V4L2_CTRL_FLAG_VOLATILE 0x0080
1790 #define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
1791 #define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
1792 #define V4L2_CTRL_FLAG_MODIFY_LAYOUT 0x0400
1793
1794 /* Query flags, to be ORed with the control ID */
1795 #define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1796 #define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
1797
1798 /* User-class control IDs defined by V4L2 */
1799 #define V4L2_CID_MAX_CTRLS 1024
1800 /* IDs reserved for driver specific controls */
1801 #define V4L2_CID_PRIVATE_BASE 0x08000000
1802
1803
1804 /*
1805 * T U N I N G
1806 */
1807 struct v4l2_tuner {
1808 uint32_t index;
1809 uint8_t name[32];
1810 uint32_t type; /* enum v4l2_tuner_type */
1811 uint32_t capability;
1812 uint32_t rangelow;
1813 uint32_t rangehigh;
1814 uint32_t rxsubchans;
1815 uint32_t audmode;
1816 int32_t signal;
1817 int32_t afc;
1818 uint32_t reserved[4];
1819 };
1820
1821 struct v4l2_modulator {
1822 uint32_t index;
1823 uint8_t name[32];
1824 uint32_t capability;
1825 uint32_t rangelow;
1826 uint32_t rangehigh;
1827 uint32_t txsubchans;
1828 uint32_t type; /* enum v4l2_tuner_type */
1829 uint32_t reserved[3];
1830 };
1831
1832 /* Flags for the 'capability' field */
1833 #define V4L2_TUNER_CAP_LOW 0x0001
1834 #define V4L2_TUNER_CAP_NORM 0x0002
1835 #define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1836 #define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1837 #define V4L2_TUNER_CAP_STEREO 0x0010
1838 #define V4L2_TUNER_CAP_LANG2 0x0020
1839 #define V4L2_TUNER_CAP_SAP 0x0020
1840 #define V4L2_TUNER_CAP_LANG1 0x0040
1841 #define V4L2_TUNER_CAP_RDS 0x0080
1842 #define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1843 #define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1844 #define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1845 #define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
1846 #define V4L2_TUNER_CAP_1HZ 0x1000
1847
1848 /* Flags for the 'rxsubchans' field */
1849 #define V4L2_TUNER_SUB_MONO 0x0001
1850 #define V4L2_TUNER_SUB_STEREO 0x0002
1851 #define V4L2_TUNER_SUB_LANG2 0x0004
1852 #define V4L2_TUNER_SUB_SAP 0x0004
1853 #define V4L2_TUNER_SUB_LANG1 0x0008
1854 #define V4L2_TUNER_SUB_RDS 0x0010
1855
1856 /* Values for the 'audmode' field */
1857 #define V4L2_TUNER_MODE_MONO 0x0000
1858 #define V4L2_TUNER_MODE_STEREO 0x0001
1859 #define V4L2_TUNER_MODE_LANG2 0x0002
1860 #define V4L2_TUNER_MODE_SAP 0x0002
1861 #define V4L2_TUNER_MODE_LANG1 0x0003
1862 #define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1863
1864 struct v4l2_frequency {
1865 uint32_t tuner;
1866 uint32_t type; /* enum v4l2_tuner_type */
1867 uint32_t frequency;
1868 uint32_t reserved[8];
1869 };
1870
1871 #define V4L2_BAND_MODULATION_VSB (1 << 1)
1872 #define V4L2_BAND_MODULATION_FM (1 << 2)
1873 #define V4L2_BAND_MODULATION_AM (1 << 3)
1874
1875 struct v4l2_frequency_band {
1876 uint32_t tuner;
1877 uint32_t type; /* enum v4l2_tuner_type */
1878 uint32_t index;
1879 uint32_t capability;
1880 uint32_t rangelow;
1881 uint32_t rangehigh;
1882 uint32_t modulation;
1883 uint32_t reserved[9];
1884 };
1885
1886 struct v4l2_hw_freq_seek {
1887 uint32_t tuner;
1888 uint32_t type; /* enum v4l2_tuner_type */
1889 uint32_t seek_upward;
1890 uint32_t wrap_around;
1891 uint32_t spacing;
1892 uint32_t rangelow;
1893 uint32_t rangehigh;
1894 uint32_t reserved[5];
1895 };
1896
1897 /*
1898 * R D S
1899 */
1900
1901 struct v4l2_rds_data {
1902 uint8_t lsb;
1903 uint8_t msb;
1904 uint8_t block;
1905 } __attribute__ ((packed));
1906
1907 #define V4L2_RDS_BLOCK_MSK 0x7
1908 #define V4L2_RDS_BLOCK_A 0
1909 #define V4L2_RDS_BLOCK_B 1
1910 #define V4L2_RDS_BLOCK_C 2
1911 #define V4L2_RDS_BLOCK_D 3
1912 #define V4L2_RDS_BLOCK_C_ALT 4
1913 #define V4L2_RDS_BLOCK_INVALID 7
1914
1915 #define V4L2_RDS_BLOCK_CORRECTED 0x40
1916 #define V4L2_RDS_BLOCK_ERROR 0x80
1917
1918 /*
1919 * A U D I O
1920 */
1921 struct v4l2_audio {
1922 uint32_t index;
1923 uint8_t name[32];
1924 uint32_t capability;
1925 uint32_t mode;
1926 uint32_t reserved[2];
1927 };
1928
1929 /* Flags for the 'capability' field */
1930 #define V4L2_AUDCAP_STEREO 0x00001
1931 #define V4L2_AUDCAP_AVL 0x00002
1932
1933 /* Flags for the 'mode' field */
1934 #define V4L2_AUDMODE_AVL 0x00001
1935
1936 struct v4l2_audioout {
1937 uint32_t index;
1938 uint8_t name[32];
1939 uint32_t capability;
1940 uint32_t mode;
1941 uint32_t reserved[2];
1942 };
1943
1944 /*
1945 * M P E G S E R V I C E S
1946 */
1947 #if 1
1948 #define V4L2_ENC_IDX_FRAME_I (0)
1949 #define V4L2_ENC_IDX_FRAME_P (1)
1950 #define V4L2_ENC_IDX_FRAME_B (2)
1951 #define V4L2_ENC_IDX_FRAME_MASK (0xf)
1952
1953 struct v4l2_enc_idx_entry {
1954 uint64_t offset;
1955 uint64_t pts;
1956 uint32_t length;
1957 uint32_t flags;
1958 uint32_t reserved[2];
1959 };
1960
1961 #define V4L2_ENC_IDX_ENTRIES (64)
1962 struct v4l2_enc_idx {
1963 uint32_t entries;
1964 uint32_t entries_cap;
1965 uint32_t reserved[4];
1966 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1967 };
1968
1969
1970 #define V4L2_ENC_CMD_START (0)
1971 #define V4L2_ENC_CMD_STOP (1)
1972 #define V4L2_ENC_CMD_PAUSE (2)
1973 #define V4L2_ENC_CMD_RESUME (3)
1974
1975 /* Flags for V4L2_ENC_CMD_STOP */
1976 #define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1977
1978 struct v4l2_encoder_cmd {
1979 uint32_t cmd;
1980 uint32_t flags;
1981 union {
1982 struct {
1983 uint32_t data[8];
1984 } raw;
1985 };
1986 };
1987
1988 /* Decoder commands */
1989 #define V4L2_DEC_CMD_START (0)
1990 #define V4L2_DEC_CMD_STOP (1)
1991 #define V4L2_DEC_CMD_PAUSE (2)
1992 #define V4L2_DEC_CMD_RESUME (3)
1993 #define V4L2_DEC_CMD_FLUSH (4)
1994
1995 /* Flags for V4L2_DEC_CMD_START */
1996 #define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1997
1998 /* Flags for V4L2_DEC_CMD_PAUSE */
1999 #define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
2000
2001 /* Flags for V4L2_DEC_CMD_STOP */
2002 #define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
2003 #define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
2004
2005 /* Play format requirements (returned by the driver): */
2006
2007 /* The decoder has no special format requirements */
2008 #define V4L2_DEC_START_FMT_NONE (0)
2009 /* The decoder requires full GOPs */
2010 #define V4L2_DEC_START_FMT_GOP (1)
2011
2012 /* The structure must be zeroed before use by the application
2013 This ensures it can be extended safely in the future. */
2014 struct v4l2_decoder_cmd {
2015 uint32_t cmd;
2016 uint32_t flags;
2017 union {
2018 struct {
2019 uint64_t pts;
2020 } stop;
2021
2022 struct {
2023 /* 0 or 1000 specifies normal speed,
2024 1 specifies forward single stepping,
2025 -1 specifies backward single stepping,
2026 >1: playback at speed/1000 of the normal speed,
2027 <-1: reverse playback at (-speed/1000) of the normal speed. */
2028 int32_t speed;
2029 uint32_t format;
2030 } start;
2031
2032 struct {
2033 uint32_t data[16];
2034 } raw;
2035 };
2036 };
2037 #endif
2038
2039
2040 /*
2041 * D A T A S E R V I C E S ( V B I )
2042 *
2043 * Data services API by Michael Schimek
2044 */
2045
2046 /* Raw VBI */
2047 struct v4l2_vbi_format {
2048 uint32_t sampling_rate; /* in 1 Hz */
2049 uint32_t offset;
2050 uint32_t samples_per_line;
2051 uint32_t sample_format; /* V4L2_PIX_FMT_* */
2052 int32_t start[2];
2053 uint32_t count[2];
2054 uint32_t flags; /* V4L2_VBI_* */
2055 uint32_t reserved[2]; /* must be zero */
2056 };
2057
2058 /* VBI flags */
2059 #define V4L2_VBI_UNSYNC (1 << 0)
2060 #define V4L2_VBI_INTERLACED (1 << 1)
2061
2062 /* ITU-R start lines for each field */
2063 #define V4L2_VBI_ITU_525_F1_START (1)
2064 #define V4L2_VBI_ITU_525_F2_START (264)
2065 #define V4L2_VBI_ITU_625_F1_START (1)
2066 #define V4L2_VBI_ITU_625_F2_START (314)
2067
2068 /* Sliced VBI
2069 *
2070 * This implements is a proposal V4L2 API to allow SLICED VBI
2071 * required for some hardware encoders. It should change without
2072 * notice in the definitive implementation.
2073 */
2074
2075 struct v4l2_sliced_vbi_format {
2076 uint16_t service_set;
2077 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
2078 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
2079 (equals frame lines 313-336 for 625 line video
2080 standards, 263-286 for 525 line standards) */
2081 uint16_t service_lines[2][24];
2082 uint32_t io_size;
2083 uint32_t reserved[2]; /* must be zero */
2084 };
2085
2086 /* Teletext World System Teletext
2087 (WST), defined on ITU-R BT.653-2 */
2088 #define V4L2_SLICED_TELETEXT_B (0x0001)
2089 /* Video Program System, defined on ETS 300 231*/
2090 #define V4L2_SLICED_VPS (0x0400)
2091 /* Closed Caption, defined on EIA-608 */
2092 #define V4L2_SLICED_CAPTION_525 (0x1000)
2093 /* Wide Screen System, defined on ITU-R BT1119.1 */
2094 #define V4L2_SLICED_WSS_625 (0x4000)
2095
2096 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
2097 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
2098
2099 struct v4l2_sliced_vbi_cap {
2100 uint16_t service_set;
2101 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
2102 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
2103 (equals frame lines 313-336 for 625 line video
2104 standards, 263-286 for 525 line standards) */
2105 uint16_t service_lines[2][24];
2106 uint32_t type; /* enum v4l2_buf_type */
2107 uint32_t reserved[3]; /* must be 0 */
2108 };
2109
2110 struct v4l2_sliced_vbi_data {
2111 uint32_t id;
2112 uint32_t field; /* 0: first field, 1: second field */
2113 uint32_t line; /* 1-23 */
2114 uint32_t reserved; /* must be 0 */
2115 uint8_t data[48];
2116 };
2117
2118 /*
2119 * Sliced VBI data inserted into MPEG Streams
2120 */
2121
2122 /*
2123 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
2124 *
2125 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
2126 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
2127 * data
2128 *
2129 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
2130 * definitions are not included here. See the MPEG-2 specifications for details
2131 * on these headers.
2132 */
2133
2134 /* Line type IDs */
2135 #define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
2136 #define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
2137 #define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
2138 #define V4L2_MPEG_VBI_IVTV_VPS (7)
2139
2140 struct v4l2_mpeg_vbi_itv0_line {
2141 uint8_t id; /* One of V4L2_MPEG_VBI_IVTV_* above */
2142 uint8_t data[42]; /* Sliced VBI data for the line */
2143 } __attribute__ ((packed));
2144
2145 struct v4l2_mpeg_vbi_itv0 {
2146 uint32_t linemask[2]; /* Bitmasks of VBI service lines present */
2147 struct v4l2_mpeg_vbi_itv0_line line[35];
2148 } __attribute__ ((packed));
2149
2150 struct v4l2_mpeg_vbi_ITV0 {
2151 struct v4l2_mpeg_vbi_itv0_line line[36];
2152 } __attribute__ ((packed));
2153
2154 #define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
2155 #define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
2156
2157 struct v4l2_mpeg_vbi_fmt_ivtv {
2158 uint8_t magic[4];
2159 union {
2160 struct v4l2_mpeg_vbi_itv0 itv0;
2161 struct v4l2_mpeg_vbi_ITV0 ITV0;
2162 };
2163 } __attribute__ ((packed));
2164
2165 /*
2166 * A G G R E G A T E S T R U C T U R E S
2167 */
2168
2169 /**
2170 * struct v4l2_plane_pix_format - additional, per-plane format definition
2171 * @sizeimage: maximum size in bytes required for data, for which
2172 * this plane will be used
2173 * @bytesperline: distance in bytes between the leftmost pixels in two
2174 * adjacent lines
2175 */
2176 struct v4l2_plane_pix_format {
2177 uint32_t sizeimage;
2178 uint32_t bytesperline;
2179 uint16_t reserved[6];
2180 } __attribute__ ((packed));
2181
2182 /**
2183 * struct v4l2_pix_format_mplane - multiplanar format definition
2184 * @width: image width in pixels
2185 * @height: image height in pixels
2186 * @pixelformat: little endian four character code (fourcc)
2187 * @field: enum v4l2_field; field order (for interlaced video)
2188 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
2189 * @plane_fmt: per-plane information
2190 * @num_planes: number of planes for this format
2191 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
2192 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
2193 * @quantization: enum v4l2_quantization, colorspace quantization
2194 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
2195 */
2196 struct v4l2_pix_format_mplane {
2197 uint32_t width;
2198 uint32_t height;
2199 uint32_t pixelformat;
2200 uint32_t field;
2201 uint32_t colorspace;
2202
2203 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
2204 uint8_t num_planes;
2205 uint8_t flags;
2206 union {
2207 uint8_t ycbcr_enc;
2208 uint8_t hsv_enc;
2209 };
2210 uint8_t quantization;
2211 uint8_t xfer_func;
2212 uint8_t reserved[7];
2213 } __attribute__ ((packed));
2214
2215 /**
2216 * struct v4l2_sdr_format - SDR format definition
2217 * @pixelformat: little endian four character code (fourcc)
2218 * @buffersize: maximum size in bytes required for data
2219 */
2220 struct v4l2_sdr_format {
2221 uint32_t pixelformat;
2222 uint32_t buffersize;
2223 uint8_t reserved[24];
2224 } __attribute__ ((packed));
2225
2226 /**
2227 * struct v4l2_meta_format - metadata format definition
2228 * @dataformat: little endian four character code (fourcc)
2229 * @buffersize: maximum size in bytes required for data
2230 */
2231 struct v4l2_meta_format {
2232 uint32_t dataformat;
2233 uint32_t buffersize;
2234 } __attribute__ ((packed));
2235
2236 /**
2237 * struct v4l2_format - stream data format
2238 * @type: enum v4l2_buf_type; type of the data stream
2239 * @pix: definition of an image format
2240 * @pix_mp: definition of a multiplanar image format
2241 * @win: definition of an overlaid image
2242 * @vbi: raw VBI capture or output parameters
2243 * @sliced: sliced VBI capture or output parameters
2244 * @raw_data: placeholder for future extensions and custom formats
2245 */
2246 struct v4l2_format {
2247 uint32_t type;
2248 union {
2249 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2250 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2251 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2252 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
2253 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
2254 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
2255 struct v4l2_meta_format meta; /* V4L2_BUF_TYPE_META_CAPTURE */
2256 uint8_t raw_data[200]; /* user-defined */
2257 } fmt;
2258 };
2259
2260 /* Stream type-dependent parameters
2261 */
2262 struct v4l2_streamparm {
2263 uint32_t type; /* enum v4l2_buf_type */
2264 union {
2265 struct v4l2_captureparm capture;
2266 struct v4l2_outputparm output;
2267 uint8_t raw_data[200]; /* user-defined */
2268 } parm;
2269 };
2270
2271 /*
2272 * E V E N T S
2273 */
2274
2275 #define V4L2_EVENT_ALL 0
2276 #define V4L2_EVENT_VSYNC 1
2277 #define V4L2_EVENT_EOS 2
2278 #define V4L2_EVENT_CTRL 3
2279 #define V4L2_EVENT_FRAME_SYNC 4
2280 #define V4L2_EVENT_SOURCE_CHANGE 5
2281 #define V4L2_EVENT_MOTION_DET 6
2282 #define V4L2_EVENT_PRIVATE_START 0x08000000
2283
2284 /* Payload for V4L2_EVENT_VSYNC */
2285 struct v4l2_event_vsync {
2286 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2287 uint8_t field;
2288 } __attribute__ ((packed));
2289
2290 /* Payload for V4L2_EVENT_CTRL */
2291 #define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
2292 #define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
2293 #define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
2294
2295 struct v4l2_event_ctrl {
2296 uint32_t changes;
2297 uint32_t type;
2298 union {
2299 int32_t value;
2300 int64_t value64;
2301 };
2302 uint32_t flags;
2303 int32_t minimum;
2304 int32_t maximum;
2305 int32_t step;
2306 int32_t default_value;
2307 };
2308
2309 struct v4l2_event_frame_sync {
2310 uint32_t frame_sequence;
2311 };
2312
2313 #define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
2314
2315 struct v4l2_event_src_change {
2316 uint32_t changes;
2317 };
2318
2319 #define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2320
2321 /**
2322 * struct v4l2_event_motion_det - motion detection event
2323 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2324 * frame_sequence field is valid.
2325 * @frame_sequence: the frame sequence number associated with this event.
2326 * @region_mask: which regions detected motion.
2327 */
2328 struct v4l2_event_motion_det {
2329 uint32_t flags;
2330 uint32_t frame_sequence;
2331 uint32_t region_mask;
2332 };
2333
2334 struct v4l2_event {
2335 uint32_t type;
2336 union {
2337 struct v4l2_event_vsync vsync;
2338 struct v4l2_event_ctrl ctrl;
2339 struct v4l2_event_frame_sync frame_sync;
2340 struct v4l2_event_src_change src_change;
2341 struct v4l2_event_motion_det motion_det;
2342 uint8_t data[64];
2343 } u;
2344 uint32_t pending;
2345 uint32_t sequence;
2346 struct timespec timestamp;
2347 uint32_t id;
2348 uint32_t reserved[8];
2349 };
2350
2351 #define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
2352 #define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
2353
2354 struct v4l2_event_subscription {
2355 uint32_t type;
2356 uint32_t id;
2357 uint32_t flags;
2358 uint32_t reserved[5];
2359 };
2360
2361 /*
2362 * A D V A N C E D D E B U G G I N G
2363 *
2364 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2365 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2366 */
2367
2368 /* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2369
2370 #define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
2371 #define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
2372
2373 /* The following four defines are no longer in use */
2374 #define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2375 #define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
2376 #define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
2377 #define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
2378
2379 struct v4l2_dbg_match {
2380 uint32_t type; /* Match type */
2381 union { /* Match this chip, meaning determined by type */
2382 uint32_t addr;
2383 char name[32];
2384 };
2385 } __attribute__ ((packed));
2386
2387 struct v4l2_dbg_register {
2388 struct v4l2_dbg_match match;
2389 uint32_t size; /* register size in bytes */
2390 uint64_t reg;
2391 uint64_t val;
2392 } __attribute__ ((packed));
2393
2394 #define V4L2_CHIP_FL_READABLE (1 << 0)
2395 #define V4L2_CHIP_FL_WRITABLE (1 << 1)
2396
2397 /* VIDIOC_DBG_G_CHIP_INFO */
2398 struct v4l2_dbg_chip_info {
2399 struct v4l2_dbg_match match;
2400 char name[32];
2401 uint32_t flags;
2402 uint32_t reserved[32];
2403 } __attribute__ ((packed));
2404
2405 /**
2406 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2407 * @index: on return, index of the first created buffer
2408 * @count: entry: number of requested buffers,
2409 * return: number of created buffers
2410 * @memory: enum v4l2_memory; buffer memory type
2411 * @format: frame format, for which buffers are requested
2412 * @capabilities: capabilities of this buffer type.
2413 * @reserved: future extensions
2414 */
2415 struct v4l2_create_buffers {
2416 uint32_t index;
2417 uint32_t count;
2418 uint32_t memory;
2419 struct v4l2_format format;
2420 uint32_t capabilities;
2421 uint32_t reserved[7];
2422 };
2423
2424 /*
2425 * I O C T L C O D E S F O R V I D E O D E V I C E S
2426 *
2427 */
2428 #define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
2429 #define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
2430 #define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
2431 #define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
2432 #define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
2433 #define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
2434 #define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
2435 #define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
2436 #define VIDIOC_OVERLAY _IOW('V', 14, int)
2437 #define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
2438 #define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
2439 #define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
2440 #define VIDIOC_STREAMON _IOW('V', 18, int)
2441 #define VIDIOC_STREAMOFF _IOW('V', 19, int)
2442 #define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
2443 #define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
2444 #define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
2445 #define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
2446 #define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
2447 #define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2448 #define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2449 #define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2450 #define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2451 #define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2452 #define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2453 #define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2454 #define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2455 #define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2456 #define VIDIOC_G_INPUT _IOR('V', 38, int)
2457 #define VIDIOC_S_INPUT _IOWR('V', 39, int)
2458 #define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2459 #define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
2460 #define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2461 #define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2462 #define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2463 #define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2464 #define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2465 #define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2466 #define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2467 #define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2468 #define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2469 #define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2470 #define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2471 #define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2472 #define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2473 #define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2474 #define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2475 #define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2476 #define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2477 #define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2478 #define VIDIOC_G_PRIORITY _IOR('V', 67, uint32_t) /* enum v4l2_priority */
2479 #define VIDIOC_S_PRIORITY _IOW('V', 68, uint32_t) /* enum v4l2_priority */
2480 #define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2481 #define VIDIOC_LOG_STATUS _IO('V', 70)
2482 #define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2483 #define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2484 #define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
2485 #define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2486 #define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2487 #define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2488 #define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2489 #define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
2490
2491 /*
2492 * Experimental, meant for debugging, testing and internal use.
2493 * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2494 * You must be root to use these ioctls. Never use these in applications!
2495 */
2496 #define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2497 #define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2498
2499 #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
2500 #define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2501 #define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2502 #define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2503 #define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2504 #define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2505 #define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2506 #define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
2507 #define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2508 #define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
2509 #define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2510 #define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
2511 #define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2512 #define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2513 #define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
2514 #define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2515
2516 /*
2517 * Experimental, meant for debugging, testing and internal use.
2518 * Never use this in applications!
2519 */
2520 #define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
2521
2522 #define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2523
2524 /* Reminder: when adding new ioctls please add support for them to
2525 drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
2526
2527 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2528
2529 #endif /* __LINUX_VIDEODEV2_H */
2530