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