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