1 /* SPDX-License-Identifier: ((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) */
3 * Video for Linux Two header file
5 * Copyright (C) 1999-2012 the contributors
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.
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.
17 * Alternatively you can redistribute this file under the terms of the
18 * BSD license as stated below:
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
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
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
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.
45 * Header file for v4l or V4L2 drivers and applications
47 * All kernel-specific stuff were moved to media/v4l2-dev.h, so
48 * no #if __KERNEL tests are allowed here
50 * See https://linuxtv.org for more info
57 #ifndef _UAPI__LINUX_VIDEODEV2_H
58 #define _UAPI__LINUX_VIDEODEV2_H
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>
70 * Common stuff for both V4L1 and V4L2
71 * Moved from videodev.h
73 #define VIDEO_MAX_FRAME 32
74 #define VIDEO_MAX_PLANES 8
77 * M I S C E L L A N E O U S
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) | (1 << 31))
89 V4L2_FIELD_ANY = 0, /* driver can choose from none,
90 top, bottom, interlaced
91 depending on whatever it thinks
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
102 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
103 first and the top field is
105 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
106 first and the bottom field is
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)
135 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
136 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
137 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
138 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
139 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
140 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
141 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
142 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
143 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
144 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
145 V4L2_BUF_TYPE_SDR_CAPTURE = 11,
146 V4L2_BUF_TYPE_SDR_OUTPUT = 12,
147 V4L2_BUF_TYPE_META_CAPTURE = 13,
148 /* Deprecated, do not use */
149 V4L2_BUF_TYPE_PRIVATE = 0x80,
152 #define V4L2_TYPE_IS_MULTIPLANAR(type) \
153 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
154 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
156 #define V4L2_TYPE_IS_OUTPUT(type) \
157 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
158 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
159 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
160 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
161 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
162 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT \
163 || (type) == V4L2_BUF_TYPE_SDR_OUTPUT)
165 enum v4l2_tuner_type {
166 V4L2_TUNER_RADIO = 1,
167 V4L2_TUNER_ANALOG_TV = 2,
168 V4L2_TUNER_DIGITAL_TV = 3,
173 /* Deprecated, do not use */
174 #define V4L2_TUNER_ADC V4L2_TUNER_SDR
177 V4L2_MEMORY_MMAP = 1,
178 V4L2_MEMORY_USERPTR = 2,
179 V4L2_MEMORY_OVERLAY = 3,
180 V4L2_MEMORY_DMABUF = 4,
183 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
184 enum v4l2_colorspace {
186 * Default colorspace, i.e. let the driver figure it out.
187 * Can only be used with video capture.
189 V4L2_COLORSPACE_DEFAULT = 0,
191 /* SMPTE 170M: used for broadcast NTSC/PAL SDTV */
192 V4L2_COLORSPACE_SMPTE170M = 1,
194 /* Obsolete pre-1998 SMPTE 240M HDTV standard, superseded by Rec 709 */
195 V4L2_COLORSPACE_SMPTE240M = 2,
197 /* Rec.709: used for HDTV */
198 V4L2_COLORSPACE_REC709 = 3,
201 * Deprecated, do not use. No driver will ever return this. This was
202 * based on a misunderstanding of the bt878 datasheet.
204 V4L2_COLORSPACE_BT878 = 4,
207 * NTSC 1953 colorspace. This only makes sense when dealing with
208 * really, really old NTSC recordings. Superseded by SMPTE 170M.
210 V4L2_COLORSPACE_470_SYSTEM_M = 5,
213 * EBU Tech 3213 PAL/SECAM colorspace. This only makes sense when
214 * dealing with really old PAL/SECAM recordings. Superseded by
217 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
220 * Effectively shorthand for V4L2_COLORSPACE_SRGB, V4L2_YCBCR_ENC_601
221 * and V4L2_QUANTIZATION_FULL_RANGE. To be used for (Motion-)JPEG.
223 V4L2_COLORSPACE_JPEG = 7,
225 /* For RGB colorspaces such as produces by most webcams. */
226 V4L2_COLORSPACE_SRGB = 8,
228 /* AdobeRGB colorspace */
229 V4L2_COLORSPACE_ADOBERGB = 9,
231 /* BT.2020 colorspace, used for UHDTV. */
232 V4L2_COLORSPACE_BT2020 = 10,
234 /* Raw colorspace: for RAW unprocessed images */
235 V4L2_COLORSPACE_RAW = 11,
237 /* DCI-P3 colorspace, used by cinema projectors */
238 V4L2_COLORSPACE_DCI_P3 = 12,
242 * Determine how COLORSPACE_DEFAULT should map to a proper colorspace.
243 * This depends on whether this is a SDTV image (use SMPTE 170M), an
244 * HDTV image (use Rec. 709), or something else (use sRGB).
246 #define V4L2_MAP_COLORSPACE_DEFAULT(is_sdtv, is_hdtv) \
247 ((is_sdtv) ? V4L2_COLORSPACE_SMPTE170M : \
248 ((is_hdtv) ? V4L2_COLORSPACE_REC709 : V4L2_COLORSPACE_SRGB))
250 enum v4l2_xfer_func {
252 * Mapping of V4L2_XFER_FUNC_DEFAULT to actual transfer functions
253 * for the various colorspaces:
255 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
256 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_REC709 and
257 * V4L2_COLORSPACE_BT2020: V4L2_XFER_FUNC_709
259 * V4L2_COLORSPACE_SRGB, V4L2_COLORSPACE_JPEG: V4L2_XFER_FUNC_SRGB
261 * V4L2_COLORSPACE_ADOBERGB: V4L2_XFER_FUNC_ADOBERGB
263 * V4L2_COLORSPACE_SMPTE240M: V4L2_XFER_FUNC_SMPTE240M
265 * V4L2_COLORSPACE_RAW: V4L2_XFER_FUNC_NONE
267 * V4L2_COLORSPACE_DCI_P3: V4L2_XFER_FUNC_DCI_P3
269 V4L2_XFER_FUNC_DEFAULT = 0,
270 V4L2_XFER_FUNC_709 = 1,
271 V4L2_XFER_FUNC_SRGB = 2,
272 V4L2_XFER_FUNC_ADOBERGB = 3,
273 V4L2_XFER_FUNC_SMPTE240M = 4,
274 V4L2_XFER_FUNC_NONE = 5,
275 V4L2_XFER_FUNC_DCI_P3 = 6,
276 V4L2_XFER_FUNC_SMPTE2084 = 7,
280 * Determine how XFER_FUNC_DEFAULT should map to a proper transfer function.
281 * This depends on the colorspace.
283 #define V4L2_MAP_XFER_FUNC_DEFAULT(colsp) \
284 ((colsp) == V4L2_COLORSPACE_ADOBERGB ? V4L2_XFER_FUNC_ADOBERGB : \
285 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_XFER_FUNC_SMPTE240M : \
286 ((colsp) == V4L2_COLORSPACE_DCI_P3 ? V4L2_XFER_FUNC_DCI_P3 : \
287 ((colsp) == V4L2_COLORSPACE_RAW ? V4L2_XFER_FUNC_NONE : \
288 ((colsp) == V4L2_COLORSPACE_SRGB || (colsp) == V4L2_COLORSPACE_JPEG ? \
289 V4L2_XFER_FUNC_SRGB : V4L2_XFER_FUNC_709)))))
291 enum v4l2_ycbcr_encoding {
293 * Mapping of V4L2_YCBCR_ENC_DEFAULT to actual encodings for the
294 * various colorspaces:
296 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
297 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_SRGB,
298 * V4L2_COLORSPACE_ADOBERGB and V4L2_COLORSPACE_JPEG: V4L2_YCBCR_ENC_601
300 * V4L2_COLORSPACE_REC709 and V4L2_COLORSPACE_DCI_P3: V4L2_YCBCR_ENC_709
302 * V4L2_COLORSPACE_BT2020: V4L2_YCBCR_ENC_BT2020
304 * V4L2_COLORSPACE_SMPTE240M: V4L2_YCBCR_ENC_SMPTE240M
306 V4L2_YCBCR_ENC_DEFAULT = 0,
308 /* ITU-R 601 -- SDTV */
309 V4L2_YCBCR_ENC_601 = 1,
311 /* Rec. 709 -- HDTV */
312 V4L2_YCBCR_ENC_709 = 2,
314 /* ITU-R 601/EN 61966-2-4 Extended Gamut -- SDTV */
315 V4L2_YCBCR_ENC_XV601 = 3,
317 /* Rec. 709/EN 61966-2-4 Extended Gamut -- HDTV */
318 V4L2_YCBCR_ENC_XV709 = 4,
322 * sYCC (Y'CbCr encoding of sRGB), identical to ENC_601. It was added
323 * originally due to a misunderstanding of the sYCC standard. It should
324 * not be used, instead use V4L2_YCBCR_ENC_601.
326 V4L2_YCBCR_ENC_SYCC = 5,
329 /* BT.2020 Non-constant Luminance Y'CbCr */
330 V4L2_YCBCR_ENC_BT2020 = 6,
332 /* BT.2020 Constant Luminance Y'CbcCrc */
333 V4L2_YCBCR_ENC_BT2020_CONST_LUM = 7,
335 /* SMPTE 240M -- Obsolete HDTV */
336 V4L2_YCBCR_ENC_SMPTE240M = 8,
340 * enum v4l2_hsv_encoding values should not collide with the ones from
341 * enum v4l2_ycbcr_encoding.
343 enum v4l2_hsv_encoding {
345 /* Hue mapped to 0 - 179 */
346 V4L2_HSV_ENC_180 = 128,
348 /* Hue mapped to 0-255 */
349 V4L2_HSV_ENC_256 = 129,
353 * Determine how YCBCR_ENC_DEFAULT should map to a proper Y'CbCr encoding.
354 * This depends on the colorspace.
356 #define V4L2_MAP_YCBCR_ENC_DEFAULT(colsp) \
357 (((colsp) == V4L2_COLORSPACE_REC709 || \
358 (colsp) == V4L2_COLORSPACE_DCI_P3) ? V4L2_YCBCR_ENC_709 : \
359 ((colsp) == V4L2_COLORSPACE_BT2020 ? V4L2_YCBCR_ENC_BT2020 : \
360 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_YCBCR_ENC_SMPTE240M : \
361 V4L2_YCBCR_ENC_601)))
363 enum v4l2_quantization {
365 * The default for R'G'B' quantization is always full range, except
366 * for the BT2020 colorspace. For Y'CbCr the quantization is always
367 * limited range, except for COLORSPACE_JPEG: this is full range.
369 V4L2_QUANTIZATION_DEFAULT = 0,
370 V4L2_QUANTIZATION_FULL_RANGE = 1,
371 V4L2_QUANTIZATION_LIM_RANGE = 2,
375 * Determine how QUANTIZATION_DEFAULT should map to a proper quantization.
376 * This depends on whether the image is RGB or not, the colorspace and the
379 #define V4L2_MAP_QUANTIZATION_DEFAULT(is_rgb_or_hsv, colsp, ycbcr_enc) \
380 (((is_rgb_or_hsv) && (colsp) == V4L2_COLORSPACE_BT2020) ? \
381 V4L2_QUANTIZATION_LIM_RANGE : \
382 (((is_rgb_or_hsv) || (colsp) == V4L2_COLORSPACE_JPEG) ? \
383 V4L2_QUANTIZATION_FULL_RANGE : V4L2_QUANTIZATION_LIM_RANGE))
386 V4L2_PRIORITY_UNSET = 0, /* not initialized */
387 V4L2_PRIORITY_BACKGROUND = 1,
388 V4L2_PRIORITY_INTERACTIVE = 2,
389 V4L2_PRIORITY_RECORD = 3,
390 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
406 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
408 * @driver: name of the driver module (e.g. "bttv")
409 * @card: name of the card (e.g. "Hauppauge WinTV")
410 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
411 * @version: KERNEL_VERSION
412 * @capabilities: capabilities of the physical device as a whole
413 * @device_caps: capabilities accessed via this particular device (node)
414 * @reserved: reserved fields for future extensions
416 struct v4l2_capability {
426 /* Values for 'capabilities' field */
427 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
428 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
429 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
430 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
431 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
432 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
433 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
434 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
435 #define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
436 #define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
437 #define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
439 /* Is a video capture device that supports multiplanar formats */
440 #define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
441 /* Is a video output device that supports multiplanar formats */
442 #define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
443 /* Is a video mem-to-mem device that supports multiplanar formats */
444 #define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
445 /* Is a video mem-to-mem device */
446 #define V4L2_CAP_VIDEO_M2M 0x00008000
448 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
449 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
450 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
451 #define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
453 #define V4L2_CAP_SDR_CAPTURE 0x00100000 /* Is a SDR capture device */
454 #define V4L2_CAP_EXT_PIX_FORMAT 0x00200000 /* Supports the extended pixel format */
455 #define V4L2_CAP_SDR_OUTPUT 0x00400000 /* Is a SDR output device */
456 #define V4L2_CAP_META_CAPTURE 0x00800000 /* Is a metadata capture device */
458 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
459 #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
460 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
462 #define V4L2_CAP_TOUCH 0x10000000 /* Is a touch device */
464 #define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
467 * V I D E O I M A G E F O R M A T
469 struct v4l2_pix_format {
473 __u32 field; /* enum v4l2_field */
474 __u32 bytesperline; /* for padding, zero if unused */
476 __u32 colorspace; /* enum v4l2_colorspace */
477 __u32 priv; /* private data, depends on pixelformat */
478 __u32 flags; /* format flags (V4L2_PIX_FMT_FLAG_*) */
480 /* enum v4l2_ycbcr_encoding */
482 /* enum v4l2_hsv_encoding */
485 __u32 quantization; /* enum v4l2_quantization */
486 __u32 xfer_func; /* enum v4l2_xfer_func */
489 /* Pixel format FOURCC depth Description */
492 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
493 #define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
494 #define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16 aaaarrrr ggggbbbb */
495 #define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16 xxxxrrrr ggggbbbb */
496 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
497 #define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16 ARGB-1-5-5-5 */
498 #define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16 XRGB-1-5-5-5 */
499 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
500 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
501 #define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16 ARGB-5-5-5 BE */
502 #define V4L2_PIX_FMT_XRGB555X v4l2_fourcc_be('X', 'R', '1', '5') /* 16 XRGB-5-5-5 BE */
503 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
504 #define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
505 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
506 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
507 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
508 #define V4L2_PIX_FMT_ABGR32 v4l2_fourcc('A', 'R', '2', '4') /* 32 BGRA-8-8-8-8 */
509 #define V4L2_PIX_FMT_XBGR32 v4l2_fourcc('X', 'R', '2', '4') /* 32 BGRX-8-8-8-8 */
510 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
511 #define V4L2_PIX_FMT_ARGB32 v4l2_fourcc('B', 'A', '2', '4') /* 32 ARGB-8-8-8-8 */
512 #define V4L2_PIX_FMT_XRGB32 v4l2_fourcc('B', 'X', '2', '4') /* 32 XRGB-8-8-8-8 */
515 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
516 #define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
517 #define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
518 #define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
519 #define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
520 #define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
521 #define V4L2_PIX_FMT_Y16_BE v4l2_fourcc_be('Y', '1', '6', ' ') /* 16 Greyscale BE */
523 /* Grey bit-packed formats */
524 #define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
526 /* Palette formats */
527 #define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
529 /* Chrominance formats */
530 #define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
532 /* Luminance+Chrominance formats */
533 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
534 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
535 #define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
536 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
537 #define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
538 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
539 #define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
540 #define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
541 #define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
542 #define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
543 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
544 #define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
545 #define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
547 /* two planes -- one Y, one Cr + Cb interleaved */
548 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
549 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
550 #define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
551 #define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
552 #define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
553 #define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
555 /* two non contiguous planes - one Y, one Cr + Cb interleaved */
556 #define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
557 #define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
558 #define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
559 #define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
560 #define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
561 #define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 macroblocks */
563 /* three planes - Y Cb, Cr */
564 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
565 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
566 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 12 YVU411 planar */
567 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
568 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
569 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
571 /* three non contiguous planes - Y, Cb, Cr */
572 #define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
573 #define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
574 #define V4L2_PIX_FMT_YUV422M v4l2_fourcc('Y', 'M', '1', '6') /* 16 YUV422 planar */
575 #define V4L2_PIX_FMT_YVU422M v4l2_fourcc('Y', 'M', '6', '1') /* 16 YVU422 planar */
576 #define V4L2_PIX_FMT_YUV444M v4l2_fourcc('Y', 'M', '2', '4') /* 24 YUV444 planar */
577 #define V4L2_PIX_FMT_YVU444M v4l2_fourcc('Y', 'M', '4', '2') /* 24 YVU444 planar */
579 /* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
580 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
581 #define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
582 #define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
583 #define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
584 #define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
585 #define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
586 #define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
587 #define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
588 /* 10bit raw bayer packed, 5 bytes for every 4 pixels */
589 #define V4L2_PIX_FMT_SBGGR10P v4l2_fourcc('p', 'B', 'A', 'A')
590 #define V4L2_PIX_FMT_SGBRG10P v4l2_fourcc('p', 'G', 'A', 'A')
591 #define V4L2_PIX_FMT_SGRBG10P v4l2_fourcc('p', 'g', 'A', 'A')
592 #define V4L2_PIX_FMT_SRGGB10P v4l2_fourcc('p', 'R', 'A', 'A')
593 /* 10bit raw bayer a-law compressed to 8 bits */
594 #define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
595 #define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
596 #define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
597 #define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
598 /* 10bit raw bayer DPCM compressed to 8 bits */
599 #define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
600 #define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
601 #define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
602 #define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
603 #define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
604 #define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
605 #define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
606 #define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
607 /* 12bit raw bayer packed, 6 bytes for every 4 pixels */
608 #define V4L2_PIX_FMT_SBGGR12P v4l2_fourcc('p', 'B', 'C', 'C')
609 #define V4L2_PIX_FMT_SGBRG12P v4l2_fourcc('p', 'G', 'C', 'C')
610 #define V4L2_PIX_FMT_SGRBG12P v4l2_fourcc('p', 'g', 'C', 'C')
611 #define V4L2_PIX_FMT_SRGGB12P v4l2_fourcc('p', 'R', 'C', 'C')
612 #define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
613 #define V4L2_PIX_FMT_SGBRG16 v4l2_fourcc('G', 'B', '1', '6') /* 16 GBGB.. RGRG.. */
614 #define V4L2_PIX_FMT_SGRBG16 v4l2_fourcc('G', 'R', '1', '6') /* 16 GRGR.. BGBG.. */
615 #define V4L2_PIX_FMT_SRGGB16 v4l2_fourcc('R', 'G', '1', '6') /* 16 RGRG.. GBGB.. */
618 #define V4L2_PIX_FMT_HSV24 v4l2_fourcc('H', 'S', 'V', '3')
619 #define V4L2_PIX_FMT_HSV32 v4l2_fourcc('H', 'S', 'V', '4')
621 /* compressed formats */
622 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
623 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
624 #define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
625 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
626 #define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
627 #define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
628 #define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
629 #define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
630 #define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
631 #define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
632 #define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
633 #define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
634 #define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
635 #define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
636 #define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
637 #define V4L2_PIX_FMT_VP9 v4l2_fourcc('V', 'P', '9', '0') /* VP9 */
638 #define V4L2_PIX_FMT_HEVC v4l2_fourcc('H', 'E', 'V', 'C') /* HEVC aka H.265 */
640 /* Vendor-specific formats */
641 #define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
642 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
643 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
644 #define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
645 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
646 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
647 #define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
648 #define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
649 #define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
650 #define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
651 #define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
652 #define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
653 #define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
654 #define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
655 #define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
656 #define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
657 #define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
658 #define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
659 #define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
660 #define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
661 #define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
662 #define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
663 #define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
664 #define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
665 #define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
666 #define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
667 #define V4L2_PIX_FMT_Y8I v4l2_fourcc('Y', '8', 'I', ' ') /* Greyscale 8-bit L/R interleaved */
668 #define V4L2_PIX_FMT_Y12I v4l2_fourcc('Y', '1', '2', 'I') /* Greyscale 12-bit L/R interleaved */
669 #define V4L2_PIX_FMT_Z16 v4l2_fourcc('Z', '1', '6', ' ') /* Depth data 16-bit */
670 #define V4L2_PIX_FMT_MT21C v4l2_fourcc('M', 'T', '2', '1') /* Mediatek compressed block mode */
671 #define V4L2_PIX_FMT_INZI v4l2_fourcc('I', 'N', 'Z', 'I') /* Intel Planar Greyscale 10-bit and Depth 16-bit */
673 /* 10bit raw bayer packed, 32 bytes for every 25 pixels, last LSB 6 bits unused */
674 #define V4L2_PIX_FMT_IPU3_SBGGR10 v4l2_fourcc('i', 'p', '3', 'b') /* IPU3 packed 10-bit BGGR bayer */
675 #define V4L2_PIX_FMT_IPU3_SGBRG10 v4l2_fourcc('i', 'p', '3', 'g') /* IPU3 packed 10-bit GBRG bayer */
676 #define V4L2_PIX_FMT_IPU3_SGRBG10 v4l2_fourcc('i', 'p', '3', 'G') /* IPU3 packed 10-bit GRBG bayer */
677 #define V4L2_PIX_FMT_IPU3_SRGGB10 v4l2_fourcc('i', 'p', '3', 'r') /* IPU3 packed 10-bit RGGB bayer */
679 /* SDR formats - used only for Software Defined Radio devices */
680 #define V4L2_SDR_FMT_CU8 v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
681 #define V4L2_SDR_FMT_CU16LE v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
682 #define V4L2_SDR_FMT_CS8 v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
683 #define V4L2_SDR_FMT_CS14LE v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
684 #define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
685 #define V4L2_SDR_FMT_PCU16BE v4l2_fourcc('P', 'C', '1', '6') /* planar complex u16be */
686 #define V4L2_SDR_FMT_PCU18BE v4l2_fourcc('P', 'C', '1', '8') /* planar complex u18be */
687 #define V4L2_SDR_FMT_PCU20BE v4l2_fourcc('P', 'C', '2', '0') /* planar complex u20be */
689 /* Touch formats - used for Touch devices */
690 #define V4L2_TCH_FMT_DELTA_TD16 v4l2_fourcc('T', 'D', '1', '6') /* 16-bit signed deltas */
691 #define V4L2_TCH_FMT_DELTA_TD08 v4l2_fourcc('T', 'D', '0', '8') /* 8-bit signed deltas */
692 #define V4L2_TCH_FMT_TU16 v4l2_fourcc('T', 'U', '1', '6') /* 16-bit unsigned touch data */
693 #define V4L2_TCH_FMT_TU08 v4l2_fourcc('T', 'U', '0', '8') /* 8-bit unsigned touch data */
695 /* Meta-data formats */
696 #define V4L2_META_FMT_VSP1_HGO v4l2_fourcc('V', 'S', 'P', 'H') /* R-Car VSP1 1-D Histogram */
697 #define V4L2_META_FMT_VSP1_HGT v4l2_fourcc('V', 'S', 'P', 'T') /* R-Car VSP1 2-D Histogram */
698 #define V4L2_META_FMT_UVC v4l2_fourcc('U', 'V', 'C', 'H') /* UVC Payload Header metadata */
700 /* priv field value to indicates that subsequent fields are valid. */
701 #define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
704 #define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
707 * F O R M A T E N U M E R A T I O N
709 struct v4l2_fmtdesc {
710 __u32 index; /* Format number */
711 __u32 type; /* enum v4l2_buf_type */
713 __u8 description[32]; /* Description string */
714 __u32 pixelformat; /* Format fourcc */
718 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
719 #define V4L2_FMT_FLAG_EMULATED 0x0002
721 /* Frame Size and frame rate enumeration */
723 * F R A M E S I Z E E N U M E R A T I O N
725 enum v4l2_frmsizetypes {
726 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
727 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
728 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
731 struct v4l2_frmsize_discrete {
732 __u32 width; /* Frame width [pixel] */
733 __u32 height; /* Frame height [pixel] */
736 struct v4l2_frmsize_stepwise {
737 __u32 min_width; /* Minimum frame width [pixel] */
738 __u32 max_width; /* Maximum frame width [pixel] */
739 __u32 step_width; /* Frame width step size [pixel] */
740 __u32 min_height; /* Minimum frame height [pixel] */
741 __u32 max_height; /* Maximum frame height [pixel] */
742 __u32 step_height; /* Frame height step size [pixel] */
745 struct v4l2_frmsizeenum {
746 __u32 index; /* Frame size number */
747 __u32 pixel_format; /* Pixel format */
748 __u32 type; /* Frame size type the device supports. */
750 union { /* Frame size */
751 struct v4l2_frmsize_discrete discrete;
752 struct v4l2_frmsize_stepwise stepwise;
755 __u32 reserved[2]; /* Reserved space for future use */
759 * F R A M E R A T E E N U M E R A T I O N
761 enum v4l2_frmivaltypes {
762 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
763 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
764 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
767 struct v4l2_frmival_stepwise {
768 struct v4l2_fract min; /* Minimum frame interval [s] */
769 struct v4l2_fract max; /* Maximum frame interval [s] */
770 struct v4l2_fract step; /* Frame interval step size [s] */
773 struct v4l2_frmivalenum {
774 __u32 index; /* Frame format index */
775 __u32 pixel_format; /* Pixel format */
776 __u32 width; /* Frame width */
777 __u32 height; /* Frame height */
778 __u32 type; /* Frame interval type the device supports. */
780 union { /* Frame interval */
781 struct v4l2_fract discrete;
782 struct v4l2_frmival_stepwise stepwise;
785 __u32 reserved[2]; /* Reserved space for future use */
791 struct v4l2_timecode {
802 #define V4L2_TC_TYPE_24FPS 1
803 #define V4L2_TC_TYPE_25FPS 2
804 #define V4L2_TC_TYPE_30FPS 3
805 #define V4L2_TC_TYPE_50FPS 4
806 #define V4L2_TC_TYPE_60FPS 5
809 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
810 #define V4L2_TC_FLAG_COLORFRAME 0x0002
811 #define V4L2_TC_USERBITS_field 0x000C
812 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
813 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
814 /* The above is based on SMPTE timecodes */
816 struct v4l2_jpegcompression {
819 int APPn; /* Number of APP segment to be written,
821 int APP_len; /* Length of data in JPEG APPn segment */
822 char APP_data[60]; /* Data in the JPEG APPn segment. */
824 int COM_len; /* Length of data in JPEG COM segment */
825 char COM_data[60]; /* Data in JPEG COM segment */
827 __u32 jpeg_markers; /* Which markers should go into the JPEG
828 * output. Unless you exactly know what
829 * you do, leave them untouched.
830 * Including less markers will make the
831 * resulting code smaller, but there will
832 * be fewer applications which can read it.
833 * The presence of the APP and COM marker
834 * is influenced by APP_len and COM_len
835 * ONLY, not by this property! */
837 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
838 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
839 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
840 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
841 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
846 * M E M O R Y - M A P P I N G B U F F E R S
848 struct v4l2_requestbuffers {
850 __u32 type; /* enum v4l2_buf_type */
851 __u32 memory; /* enum v4l2_memory */
856 * struct v4l2_plane - plane info for multi-planar buffers
857 * @bytesused: number of bytes occupied by data in the plane (payload)
858 * @length: size of this plane (NOT the payload) in bytes
859 * @mem_offset: when memory in the associated struct v4l2_buffer is
860 * V4L2_MEMORY_MMAP, equals the offset from the start of
861 * the device memory for this plane (or is a "cookie" that
862 * should be passed to mmap() called on the video node)
863 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
864 * pointing to this plane
865 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
866 * descriptor associated with this plane
867 * @data_offset: offset in the plane to the start of data; usually 0,
868 * unless there is a header in front of the data
870 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
871 * with two planes can have one plane for Y, and another for interleaved CbCr
872 * components. Each plane can reside in a separate memory buffer, or even in
873 * a completely separate memory node (e.g. in embedded devices).
880 unsigned long userptr;
888 * struct v4l2_buffer - video buffer info
889 * @index: id number of the buffer
890 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
891 * multiplanar buffers);
892 * @bytesused: number of bytes occupied by data in the buffer (payload);
893 * unused (set to 0) for multiplanar buffers
894 * @flags: buffer informational flags
895 * @field: enum v4l2_field; field order of the image in the buffer
896 * @timestamp: frame timestamp
897 * @timecode: frame timecode
898 * @sequence: sequence count of this frame
899 * @memory: enum v4l2_memory; the method, in which the actual video data is
901 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
902 * offset from the start of the device memory for this plane,
903 * (or a "cookie" that should be passed to mmap() as offset)
904 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
905 * a userspace pointer pointing to this buffer
906 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
907 * a userspace file descriptor associated with this buffer
908 * @planes: for multiplanar buffers; userspace pointer to the array of plane
909 * info structs for this buffer
910 * @length: size in bytes of the buffer (NOT its payload) for single-plane
911 * buffers (when type != *_MPLANE); number of elements in the
912 * planes array for multi-plane buffers
914 * Contains data exchanged by application and driver using one of the Streaming
923 struct timeval timestamp;
924 struct v4l2_timecode timecode;
927 /* memory location */
931 unsigned long userptr;
932 struct v4l2_plane *planes;
940 /* Flags for 'flags' field */
941 /* Buffer is mapped (flag) */
942 #define V4L2_BUF_FLAG_MAPPED 0x00000001
943 /* Buffer is queued for processing */
944 #define V4L2_BUF_FLAG_QUEUED 0x00000002
945 /* Buffer is ready */
946 #define V4L2_BUF_FLAG_DONE 0x00000004
947 /* Image is a keyframe (I-frame) */
948 #define V4L2_BUF_FLAG_KEYFRAME 0x00000008
949 /* Image is a P-frame */
950 #define V4L2_BUF_FLAG_PFRAME 0x00000010
951 /* Image is a B-frame */
952 #define V4L2_BUF_FLAG_BFRAME 0x00000020
953 /* Buffer is ready, but the data contained within is corrupted. */
954 #define V4L2_BUF_FLAG_ERROR 0x00000040
955 /* timecode field is valid */
956 #define V4L2_BUF_FLAG_TIMECODE 0x00000100
957 /* Buffer is prepared for queuing */
958 #define V4L2_BUF_FLAG_PREPARED 0x00000400
959 /* Cache handling flags */
960 #define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
961 #define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
963 #define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
964 #define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
965 #define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
966 #define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
967 /* Timestamp sources. */
968 #define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
969 #define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
970 #define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
971 /* mem2mem encoder/decoder */
972 #define V4L2_BUF_FLAG_LAST 0x00100000
975 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
977 * @index: id number of the buffer
978 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
979 * multiplanar buffers);
980 * @plane: index of the plane to be exported, 0 for single plane queues
981 * @flags: flags for newly created file, currently only O_CLOEXEC is
982 * supported, refer to manual of open syscall for more details
983 * @fd: file descriptor associated with DMABUF (set by driver)
985 * Contains data used for exporting a video buffer as DMABUF file descriptor.
986 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
987 * (identical to the cookie used to mmap() the buffer to userspace). All
988 * reserved fields must be set to zero. The field reserved0 is expected to
989 * become a structure 'type' allowing an alternative layout of the structure
990 * content. Therefore this field should not be used for any other extensions.
992 struct v4l2_exportbuffer {
993 __u32 type; /* enum v4l2_buf_type */
1002 * O V E R L A Y P R E V I E W
1004 struct v4l2_framebuffer {
1007 /* FIXME: in theory we should pass something like PCI device + memory
1008 * region + offset instead of some physical address */
1014 __u32 field; /* enum v4l2_field */
1015 __u32 bytesperline; /* for padding, zero if unused */
1017 __u32 colorspace; /* enum v4l2_colorspace */
1018 __u32 priv; /* reserved field, set to 0 */
1021 /* Flags for the 'capability' field. Read only */
1022 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
1023 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
1024 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
1025 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
1026 #define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
1027 #define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
1028 #define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
1029 #define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
1030 /* Flags for the 'flags' field. */
1031 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
1032 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
1033 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
1034 #define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
1035 #define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
1036 #define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
1037 #define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
1041 struct v4l2_clip __user *next;
1044 struct v4l2_window {
1046 __u32 field; /* enum v4l2_field */
1048 struct v4l2_clip __user *clips;
1050 void __user *bitmap;
1055 * C A P T U R E P A R A M E T E R S
1057 struct v4l2_captureparm {
1058 __u32 capability; /* Supported modes */
1059 __u32 capturemode; /* Current mode */
1060 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1061 __u32 extendedmode; /* Driver-specific extensions */
1062 __u32 readbuffers; /* # of buffers for read */
1066 /* Flags for 'capability' and 'capturemode' fields */
1067 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
1068 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
1070 struct v4l2_outputparm {
1071 __u32 capability; /* Supported modes */
1072 __u32 outputmode; /* Current mode */
1073 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1074 __u32 extendedmode; /* Driver-specific extensions */
1075 __u32 writebuffers; /* # of buffers for write */
1080 * I N P U T I M A G E C R O P P I N G
1082 struct v4l2_cropcap {
1083 __u32 type; /* enum v4l2_buf_type */
1084 struct v4l2_rect bounds;
1085 struct v4l2_rect defrect;
1086 struct v4l2_fract pixelaspect;
1090 __u32 type; /* enum v4l2_buf_type */
1095 * struct v4l2_selection - selection info
1096 * @type: buffer type (do not use *_MPLANE types)
1097 * @target: Selection target, used to choose one of possible rectangles;
1098 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
1099 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1100 * @r: coordinates of selection window
1101 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
1103 * Hardware may use multiple helper windows to process a video stream.
1104 * The structure is used to exchange this selection areas between
1105 * an application and a driver.
1107 struct v4l2_selection {
1117 * A N A L O G V I D E O S T A N D A R D
1120 typedef __u64 v4l2_std_id;
1122 /* one bit for each */
1123 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
1124 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
1125 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
1126 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
1127 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
1128 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
1129 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
1130 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
1132 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
1133 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
1134 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
1135 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
1137 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
1138 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
1139 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
1140 #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
1142 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
1143 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
1144 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
1145 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
1146 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
1147 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
1148 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
1149 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
1152 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
1153 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
1156 Although std_id is 64 bits, there is an issue on PPC32 architecture that
1157 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
1158 this value to 32 bits.
1159 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1160 it should work fine. However, if needed to add more than two standards,
1161 v4l2-common.c should be fixed.
1165 * Some macros to merge video standards in order to make live easier for the
1166 * drivers and V4L2 applications
1170 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1173 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
1174 V4L2_STD_NTSC_M_JP |\
1177 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
1180 /* All Secam Standards */
1181 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
1184 V4L2_STD_SECAM_DK |\
1188 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
1191 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
1195 * "Common" PAL - This macro is there to be compatible with the old
1196 * V4L1 concept of "PAL": /BGDKHI.
1197 * Several PAL standards are missing here: /M, /N and /Nc
1199 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
1203 /* Chroma "agnostic" standards */
1204 #define V4L2_STD_B (V4L2_STD_PAL_B |\
1207 #define V4L2_STD_G (V4L2_STD_PAL_G |\
1209 #define V4L2_STD_H (V4L2_STD_PAL_H |\
1211 #define V4L2_STD_L (V4L2_STD_SECAM_L |\
1213 #define V4L2_STD_GH (V4L2_STD_G |\
1215 #define V4L2_STD_DK (V4L2_STD_PAL_DK |\
1217 #define V4L2_STD_BG (V4L2_STD_B |\
1219 #define V4L2_STD_MN (V4L2_STD_PAL_M |\
1224 /* Standards where MTS/BTSC stereo could be found */
1225 #define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
1230 /* Standards for Countries with 60Hz Line frequency */
1231 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
1235 /* Standards for Countries with 50Hz Line frequency */
1236 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
1241 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1242 V4L2_STD_ATSC_16_VSB)
1243 /* Macros with none and all analog standards */
1244 #define V4L2_STD_UNKNOWN 0
1245 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
1248 struct v4l2_standard {
1252 struct v4l2_fract frameperiod; /* Frames, not fields */
1258 * D V B T T I M I N G S
1261 /** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1262 * @width: total width of the active video in pixels
1263 * @height: total height of the active video in lines
1264 * @interlaced: Interlaced or progressive
1265 * @polarities: Positive or negative polarities
1266 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1267 * @hfrontporch:Horizontal front porch in pixels
1268 * @hsync: Horizontal Sync length in pixels
1269 * @hbackporch: Horizontal back porch in pixels
1270 * @vfrontporch:Vertical front porch in lines
1271 * @vsync: Vertical Sync length in lines
1272 * @vbackporch: Vertical back porch in lines
1273 * @il_vfrontporch:Vertical front porch for the even field
1274 * (aka field 2) of interlaced field formats
1275 * @il_vsync: Vertical Sync length for the even field
1276 * (aka field 2) of interlaced field formats
1277 * @il_vbackporch:Vertical back porch for the even field
1278 * (aka field 2) of interlaced field formats
1279 * @standards: Standards the timing belongs to
1281 * @picture_aspect: The picture aspect ratio (hor/vert).
1282 * @cea861_vic: VIC code as per the CEA-861 standard.
1283 * @hdmi_vic: VIC code as per the HDMI standard.
1284 * @reserved: Reserved fields, must be zeroed.
1286 * A note regarding vertical interlaced timings: height refers to the total
1287 * height of the active video frame (= two fields). The blanking timings refer
1288 * to the blanking of each field. So the height of the total frame is
1289 * calculated as follows:
1291 * tot_height = height + vfrontporch + vsync + vbackporch +
1292 * il_vfrontporch + il_vsync + il_vbackporch
1294 * The active height of each field is height / 2.
1296 struct v4l2_bt_timings {
1308 __u32 il_vfrontporch;
1310 __u32 il_vbackporch;
1313 struct v4l2_fract picture_aspect;
1317 } __attribute__ ((packed));
1319 /* Interlaced or progressive format */
1320 #define V4L2_DV_PROGRESSIVE 0
1321 #define V4L2_DV_INTERLACED 1
1323 /* Polarities. If bit is not set, it is assumed to be negative polarity */
1324 #define V4L2_DV_VSYNC_POS_POL 0x00000001
1325 #define V4L2_DV_HSYNC_POS_POL 0x00000002
1327 /* Timings standards */
1328 #define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1329 #define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1330 #define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1331 #define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
1332 #define V4L2_DV_BT_STD_SDI (1 << 4) /* SDI Timings */
1337 * CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1338 * GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1339 * intervals are reduced, allowing a higher resolution over the same
1340 * bandwidth. This is a read-only flag.
1342 #define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1344 * CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1345 * of six. These formats can be optionally played at 1 / 1.001 speed.
1346 * This is a read-only flag.
1348 #define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1350 * CEA-861 specific: only valid for video transmitters, the flag is cleared
1352 * If the framerate of the format is a multiple of six, then the pixelclock
1353 * used to set up the transmitter is divided by 1.001 to make it compatible
1354 * with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1355 * 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1356 * such frequencies, then the flag will also be cleared.
1358 #define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1360 * Specific to interlaced formats: if set, then field 1 is really one half-line
1361 * longer and field 2 is really one half-line shorter, so each field has
1362 * exactly the same number of half-lines. Whether half-lines can be detected
1363 * or used depends on the hardware.
1365 #define V4L2_DV_FL_HALF_LINE (1 << 3)
1367 * If set, then this is a Consumer Electronics (CE) video format. Such formats
1368 * differ from other formats (commonly called IT formats) in that if RGB
1369 * encoding is used then by default the RGB values use limited range (i.e.
1370 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
1371 * except for the 640x480 format are CE formats.
1373 #define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
1374 /* Some formats like SMPTE-125M have an interlaced signal with a odd
1375 * total height. For these formats, if this flag is set, the first
1376 * field has the extra line. If not, it is the second field.
1378 #define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE (1 << 5)
1380 * If set, then the picture_aspect field is valid. Otherwise assume that the
1381 * pixels are square, so the picture aspect ratio is the same as the width to
1384 #define V4L2_DV_FL_HAS_PICTURE_ASPECT (1 << 6)
1386 * If set, then the cea861_vic field is valid and contains the Video
1387 * Identification Code as per the CEA-861 standard.
1389 #define V4L2_DV_FL_HAS_CEA861_VIC (1 << 7)
1391 * If set, then the hdmi_vic field is valid and contains the Video
1392 * Identification Code as per the HDMI standard (HDMI Vendor Specific
1395 #define V4L2_DV_FL_HAS_HDMI_VIC (1 << 8)
1397 /* A few useful defines to calculate the total blanking and frame sizes */
1398 #define V4L2_DV_BT_BLANKING_WIDTH(bt) \
1399 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
1400 #define V4L2_DV_BT_FRAME_WIDTH(bt) \
1401 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
1402 #define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
1403 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1404 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
1405 #define V4L2_DV_BT_FRAME_HEIGHT(bt) \
1406 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
1408 /** struct v4l2_dv_timings - DV timings
1409 * @type: the type of the timings
1410 * @bt: BT656/1120 timings
1412 struct v4l2_dv_timings {
1415 struct v4l2_bt_timings bt;
1418 } __attribute__ ((packed));
1420 /* Values for the type field */
1421 #define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1424 /** struct v4l2_enum_dv_timings - DV timings enumeration
1425 * @index: enumeration index
1426 * @pad: the pad number for which to enumerate timings (used with
1427 * v4l-subdev nodes only)
1428 * @reserved: must be zeroed
1429 * @timings: the timings for the given index
1431 struct v4l2_enum_dv_timings {
1435 struct v4l2_dv_timings timings;
1438 /** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1439 * @min_width: width in pixels
1440 * @max_width: width in pixels
1441 * @min_height: height in lines
1442 * @max_height: height in lines
1443 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1444 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1445 * @standards: Supported standards
1446 * @capabilities: Supported capabilities
1447 * @reserved: Must be zeroed
1449 struct v4l2_bt_timings_cap {
1454 __u64 min_pixelclock;
1455 __u64 max_pixelclock;
1459 } __attribute__ ((packed));
1461 /* Supports interlaced formats */
1462 #define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1463 /* Supports progressive formats */
1464 #define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1465 /* Supports CVT/GTF reduced blanking */
1466 #define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1467 /* Supports custom formats */
1468 #define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1470 /** struct v4l2_dv_timings_cap - DV timings capabilities
1471 * @type: the type of the timings (same as in struct v4l2_dv_timings)
1472 * @pad: the pad number for which to query capabilities (used with
1473 * v4l-subdev nodes only)
1474 * @bt: the BT656/1120 timings capabilities
1476 struct v4l2_dv_timings_cap {
1481 struct v4l2_bt_timings_cap bt;
1488 * V I D E O I N P U T S
1491 __u32 index; /* Which input */
1492 __u8 name[32]; /* Label */
1493 __u32 type; /* Type of input */
1494 __u32 audioset; /* Associated audios (bitfield) */
1495 __u32 tuner; /* enum v4l2_tuner_type */
1502 /* Values for the 'type' field */
1503 #define V4L2_INPUT_TYPE_TUNER 1
1504 #define V4L2_INPUT_TYPE_CAMERA 2
1505 #define V4L2_INPUT_TYPE_TOUCH 3
1507 /* field 'status' - general */
1508 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1509 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
1510 #define V4L2_IN_ST_NO_COLOR 0x00000004
1512 /* field 'status' - sensor orientation */
1513 /* If sensor is mounted upside down set both bits */
1514 #define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1515 #define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1517 /* field 'status' - analog */
1518 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1519 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1520 #define V4L2_IN_ST_NO_V_LOCK 0x00000400 /* No vertical sync lock */
1521 #define V4L2_IN_ST_NO_STD_LOCK 0x00000800 /* No standard format lock */
1523 /* field 'status' - digital */
1524 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1525 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1526 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1528 /* field 'status' - VCR and set-top box */
1529 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1530 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1531 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1533 /* capabilities flags */
1534 #define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1535 #define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1536 #define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
1537 #define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1540 * V I D E O O U T P U T S
1542 struct v4l2_output {
1543 __u32 index; /* Which output */
1544 __u8 name[32]; /* Label */
1545 __u32 type; /* Type of output */
1546 __u32 audioset; /* Associated audios (bitfield) */
1547 __u32 modulator; /* Associated modulator */
1552 /* Values for the 'type' field */
1553 #define V4L2_OUTPUT_TYPE_MODULATOR 1
1554 #define V4L2_OUTPUT_TYPE_ANALOG 2
1555 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1557 /* capabilities flags */
1558 #define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1559 #define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1560 #define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
1561 #define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1566 struct v4l2_control {
1571 struct v4l2_ext_control {
1578 char __user *string;
1580 __u16 __user *p_u16;
1581 __u32 __user *p_u32;
1584 } __attribute__ ((packed));
1586 struct v4l2_ext_controls {
1596 struct v4l2_ext_control *controls;
1599 #define V4L2_CTRL_ID_MASK (0x0fffffff)
1601 #define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1603 #define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
1604 #define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1605 #define V4L2_CTRL_MAX_DIMS (4)
1606 #define V4L2_CTRL_WHICH_CUR_VAL 0
1607 #define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
1609 enum v4l2_ctrl_type {
1610 V4L2_CTRL_TYPE_INTEGER = 1,
1611 V4L2_CTRL_TYPE_BOOLEAN = 2,
1612 V4L2_CTRL_TYPE_MENU = 3,
1613 V4L2_CTRL_TYPE_BUTTON = 4,
1614 V4L2_CTRL_TYPE_INTEGER64 = 5,
1615 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1616 V4L2_CTRL_TYPE_STRING = 7,
1617 V4L2_CTRL_TYPE_BITMASK = 8,
1618 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1620 /* Compound types are >= 0x0100 */
1621 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
1622 V4L2_CTRL_TYPE_U8 = 0x0100,
1623 V4L2_CTRL_TYPE_U16 = 0x0101,
1624 V4L2_CTRL_TYPE_U32 = 0x0102,
1627 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1628 struct v4l2_queryctrl {
1630 __u32 type; /* enum v4l2_ctrl_type */
1631 __u8 name[32]; /* Whatever */
1632 __s32 minimum; /* Note signedness */
1635 __s32 default_value;
1640 /* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1641 struct v4l2_query_ext_ctrl {
1648 __s64 default_value;
1653 __u32 dims[V4L2_CTRL_MAX_DIMS];
1657 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1658 struct v4l2_querymenu {
1662 __u8 name[32]; /* Whatever */
1666 } __attribute__ ((packed));
1669 #define V4L2_CTRL_FLAG_DISABLED 0x0001
1670 #define V4L2_CTRL_FLAG_GRABBED 0x0002
1671 #define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1672 #define V4L2_CTRL_FLAG_UPDATE 0x0008
1673 #define V4L2_CTRL_FLAG_INACTIVE 0x0010
1674 #define V4L2_CTRL_FLAG_SLIDER 0x0020
1675 #define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1676 #define V4L2_CTRL_FLAG_VOLATILE 0x0080
1677 #define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
1678 #define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
1679 #define V4L2_CTRL_FLAG_MODIFY_LAYOUT 0x0400
1681 /* Query flags, to be ORed with the control ID */
1682 #define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1683 #define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
1685 /* User-class control IDs defined by V4L2 */
1686 #define V4L2_CID_MAX_CTRLS 1024
1687 /* IDs reserved for driver specific controls */
1688 #define V4L2_CID_PRIVATE_BASE 0x08000000
1697 __u32 type; /* enum v4l2_tuner_type */
1708 struct v4l2_modulator {
1715 __u32 type; /* enum v4l2_tuner_type */
1719 /* Flags for the 'capability' field */
1720 #define V4L2_TUNER_CAP_LOW 0x0001
1721 #define V4L2_TUNER_CAP_NORM 0x0002
1722 #define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1723 #define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1724 #define V4L2_TUNER_CAP_STEREO 0x0010
1725 #define V4L2_TUNER_CAP_LANG2 0x0020
1726 #define V4L2_TUNER_CAP_SAP 0x0020
1727 #define V4L2_TUNER_CAP_LANG1 0x0040
1728 #define V4L2_TUNER_CAP_RDS 0x0080
1729 #define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1730 #define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1731 #define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1732 #define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
1733 #define V4L2_TUNER_CAP_1HZ 0x1000
1735 /* Flags for the 'rxsubchans' field */
1736 #define V4L2_TUNER_SUB_MONO 0x0001
1737 #define V4L2_TUNER_SUB_STEREO 0x0002
1738 #define V4L2_TUNER_SUB_LANG2 0x0004
1739 #define V4L2_TUNER_SUB_SAP 0x0004
1740 #define V4L2_TUNER_SUB_LANG1 0x0008
1741 #define V4L2_TUNER_SUB_RDS 0x0010
1743 /* Values for the 'audmode' field */
1744 #define V4L2_TUNER_MODE_MONO 0x0000
1745 #define V4L2_TUNER_MODE_STEREO 0x0001
1746 #define V4L2_TUNER_MODE_LANG2 0x0002
1747 #define V4L2_TUNER_MODE_SAP 0x0002
1748 #define V4L2_TUNER_MODE_LANG1 0x0003
1749 #define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1751 struct v4l2_frequency {
1753 __u32 type; /* enum v4l2_tuner_type */
1758 #define V4L2_BAND_MODULATION_VSB (1 << 1)
1759 #define V4L2_BAND_MODULATION_FM (1 << 2)
1760 #define V4L2_BAND_MODULATION_AM (1 << 3)
1762 struct v4l2_frequency_band {
1764 __u32 type; /* enum v4l2_tuner_type */
1773 struct v4l2_hw_freq_seek {
1775 __u32 type; /* enum v4l2_tuner_type */
1788 struct v4l2_rds_data {
1792 } __attribute__ ((packed));
1794 #define V4L2_RDS_BLOCK_MSK 0x7
1795 #define V4L2_RDS_BLOCK_A 0
1796 #define V4L2_RDS_BLOCK_B 1
1797 #define V4L2_RDS_BLOCK_C 2
1798 #define V4L2_RDS_BLOCK_D 3
1799 #define V4L2_RDS_BLOCK_C_ALT 4
1800 #define V4L2_RDS_BLOCK_INVALID 7
1802 #define V4L2_RDS_BLOCK_CORRECTED 0x40
1803 #define V4L2_RDS_BLOCK_ERROR 0x80
1816 /* Flags for the 'capability' field */
1817 #define V4L2_AUDCAP_STEREO 0x00001
1818 #define V4L2_AUDCAP_AVL 0x00002
1820 /* Flags for the 'mode' field */
1821 #define V4L2_AUDMODE_AVL 0x00001
1823 struct v4l2_audioout {
1832 * M P E G S E R V I C E S
1835 #define V4L2_ENC_IDX_FRAME_I (0)
1836 #define V4L2_ENC_IDX_FRAME_P (1)
1837 #define V4L2_ENC_IDX_FRAME_B (2)
1838 #define V4L2_ENC_IDX_FRAME_MASK (0xf)
1840 struct v4l2_enc_idx_entry {
1848 #define V4L2_ENC_IDX_ENTRIES (64)
1849 struct v4l2_enc_idx {
1853 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1857 #define V4L2_ENC_CMD_START (0)
1858 #define V4L2_ENC_CMD_STOP (1)
1859 #define V4L2_ENC_CMD_PAUSE (2)
1860 #define V4L2_ENC_CMD_RESUME (3)
1862 /* Flags for V4L2_ENC_CMD_STOP */
1863 #define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1865 struct v4l2_encoder_cmd {
1875 /* Decoder commands */
1876 #define V4L2_DEC_CMD_START (0)
1877 #define V4L2_DEC_CMD_STOP (1)
1878 #define V4L2_DEC_CMD_PAUSE (2)
1879 #define V4L2_DEC_CMD_RESUME (3)
1881 /* Flags for V4L2_DEC_CMD_START */
1882 #define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1884 /* Flags for V4L2_DEC_CMD_PAUSE */
1885 #define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
1887 /* Flags for V4L2_DEC_CMD_STOP */
1888 #define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
1889 #define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
1891 /* Play format requirements (returned by the driver): */
1893 /* The decoder has no special format requirements */
1894 #define V4L2_DEC_START_FMT_NONE (0)
1895 /* The decoder requires full GOPs */
1896 #define V4L2_DEC_START_FMT_GOP (1)
1898 /* The structure must be zeroed before use by the application
1899 This ensures it can be extended safely in the future. */
1900 struct v4l2_decoder_cmd {
1909 /* 0 or 1000 specifies normal speed,
1910 1 specifies forward single stepping,
1911 -1 specifies backward single stepping,
1912 >1: playback at speed/1000 of the normal speed,
1913 <-1: reverse playback at (-speed/1000) of the normal speed. */
1927 * D A T A S E R V I C E S ( V B I )
1929 * Data services API by Michael Schimek
1933 struct v4l2_vbi_format {
1934 __u32 sampling_rate; /* in 1 Hz */
1936 __u32 samples_per_line;
1937 __u32 sample_format; /* V4L2_PIX_FMT_* */
1940 __u32 flags; /* V4L2_VBI_* */
1941 __u32 reserved[2]; /* must be zero */
1945 #define V4L2_VBI_UNSYNC (1 << 0)
1946 #define V4L2_VBI_INTERLACED (1 << 1)
1948 /* ITU-R start lines for each field */
1949 #define V4L2_VBI_ITU_525_F1_START (1)
1950 #define V4L2_VBI_ITU_525_F2_START (264)
1951 #define V4L2_VBI_ITU_625_F1_START (1)
1952 #define V4L2_VBI_ITU_625_F2_START (314)
1956 * This implements is a proposal V4L2 API to allow SLICED VBI
1957 * required for some hardware encoders. It should change without
1958 * notice in the definitive implementation.
1961 struct v4l2_sliced_vbi_format {
1963 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1964 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1965 (equals frame lines 313-336 for 625 line video
1966 standards, 263-286 for 525 line standards) */
1967 __u16 service_lines[2][24];
1969 __u32 reserved[2]; /* must be zero */
1972 /* Teletext World System Teletext
1973 (WST), defined on ITU-R BT.653-2 */
1974 #define V4L2_SLICED_TELETEXT_B (0x0001)
1975 /* Video Program System, defined on ETS 300 231*/
1976 #define V4L2_SLICED_VPS (0x0400)
1977 /* Closed Caption, defined on EIA-608 */
1978 #define V4L2_SLICED_CAPTION_525 (0x1000)
1979 /* Wide Screen System, defined on ITU-R BT1119.1 */
1980 #define V4L2_SLICED_WSS_625 (0x4000)
1982 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1983 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
1985 struct v4l2_sliced_vbi_cap {
1987 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1988 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1989 (equals frame lines 313-336 for 625 line video
1990 standards, 263-286 for 525 line standards) */
1991 __u16 service_lines[2][24];
1992 __u32 type; /* enum v4l2_buf_type */
1993 __u32 reserved[3]; /* must be 0 */
1996 struct v4l2_sliced_vbi_data {
1998 __u32 field; /* 0: first field, 1: second field */
1999 __u32 line; /* 1-23 */
2000 __u32 reserved; /* must be 0 */
2005 * Sliced VBI data inserted into MPEG Streams
2009 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
2011 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
2012 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
2015 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
2016 * definitions are not included here. See the MPEG-2 specifications for details
2021 #define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
2022 #define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
2023 #define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
2024 #define V4L2_MPEG_VBI_IVTV_VPS (7)
2026 struct v4l2_mpeg_vbi_itv0_line {
2027 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
2028 __u8 data[42]; /* Sliced VBI data for the line */
2029 } __attribute__ ((packed));
2031 struct v4l2_mpeg_vbi_itv0 {
2032 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
2033 struct v4l2_mpeg_vbi_itv0_line line[35];
2034 } __attribute__ ((packed));
2036 struct v4l2_mpeg_vbi_ITV0 {
2037 struct v4l2_mpeg_vbi_itv0_line line[36];
2038 } __attribute__ ((packed));
2040 #define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
2041 #define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
2043 struct v4l2_mpeg_vbi_fmt_ivtv {
2046 struct v4l2_mpeg_vbi_itv0 itv0;
2047 struct v4l2_mpeg_vbi_ITV0 ITV0;
2049 } __attribute__ ((packed));
2052 * A G G R E G A T E S T R U C T U R E S
2056 * struct v4l2_plane_pix_format - additional, per-plane format definition
2057 * @sizeimage: maximum size in bytes required for data, for which
2058 * this plane will be used
2059 * @bytesperline: distance in bytes between the leftmost pixels in two
2062 struct v4l2_plane_pix_format {
2066 } __attribute__ ((packed));
2069 * struct v4l2_pix_format_mplane - multiplanar format definition
2070 * @width: image width in pixels
2071 * @height: image height in pixels
2072 * @pixelformat: little endian four character code (fourcc)
2073 * @field: enum v4l2_field; field order (for interlaced video)
2074 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
2075 * @plane_fmt: per-plane information
2076 * @num_planes: number of planes for this format
2077 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
2078 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
2079 * @quantization: enum v4l2_quantization, colorspace quantization
2080 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
2082 struct v4l2_pix_format_mplane {
2089 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
2099 } __attribute__ ((packed));
2102 * struct v4l2_sdr_format - SDR format definition
2103 * @pixelformat: little endian four character code (fourcc)
2104 * @buffersize: maximum size in bytes required for data
2106 struct v4l2_sdr_format {
2110 } __attribute__ ((packed));
2113 * struct v4l2_meta_format - metadata format definition
2114 * @dataformat: little endian four character code (fourcc)
2115 * @buffersize: maximum size in bytes required for data
2117 struct v4l2_meta_format {
2120 } __attribute__ ((packed));
2123 * struct v4l2_format - stream data format
2124 * @type: enum v4l2_buf_type; type of the data stream
2125 * @pix: definition of an image format
2126 * @pix_mp: definition of a multiplanar image format
2127 * @win: definition of an overlaid image
2128 * @vbi: raw VBI capture or output parameters
2129 * @sliced: sliced VBI capture or output parameters
2130 * @raw_data: placeholder for future extensions and custom formats
2132 struct v4l2_format {
2135 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2136 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2137 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2138 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
2139 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
2140 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
2141 struct v4l2_meta_format meta; /* V4L2_BUF_TYPE_META_CAPTURE */
2142 __u8 raw_data[200]; /* user-defined */
2146 /* Stream type-dependent parameters
2148 struct v4l2_streamparm {
2149 __u32 type; /* enum v4l2_buf_type */
2151 struct v4l2_captureparm capture;
2152 struct v4l2_outputparm output;
2153 __u8 raw_data[200]; /* user-defined */
2161 #define V4L2_EVENT_ALL 0
2162 #define V4L2_EVENT_VSYNC 1
2163 #define V4L2_EVENT_EOS 2
2164 #define V4L2_EVENT_CTRL 3
2165 #define V4L2_EVENT_FRAME_SYNC 4
2166 #define V4L2_EVENT_SOURCE_CHANGE 5
2167 #define V4L2_EVENT_MOTION_DET 6
2168 #define V4L2_EVENT_PRIVATE_START 0x08000000
2170 /* Payload for V4L2_EVENT_VSYNC */
2171 struct v4l2_event_vsync {
2172 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2174 } __attribute__ ((packed));
2176 /* Payload for V4L2_EVENT_CTRL */
2177 #define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
2178 #define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
2179 #define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
2181 struct v4l2_event_ctrl {
2192 __s32 default_value;
2195 struct v4l2_event_frame_sync {
2196 __u32 frame_sequence;
2199 #define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
2201 struct v4l2_event_src_change {
2205 #define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2208 * struct v4l2_event_motion_det - motion detection event
2209 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2210 * frame_sequence field is valid.
2211 * @frame_sequence: the frame sequence number associated with this event.
2212 * @region_mask: which regions detected motion.
2214 struct v4l2_event_motion_det {
2216 __u32 frame_sequence;
2223 struct v4l2_event_vsync vsync;
2224 struct v4l2_event_ctrl ctrl;
2225 struct v4l2_event_frame_sync frame_sync;
2226 struct v4l2_event_src_change src_change;
2227 struct v4l2_event_motion_det motion_det;
2232 struct timespec timestamp;
2237 #define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
2238 #define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
2240 struct v4l2_event_subscription {
2248 * A D V A N C E D D E B U G G I N G
2250 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2251 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2254 /* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2256 #define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
2257 #define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
2259 /* The following four defines are no longer in use */
2260 #define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2261 #define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
2262 #define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
2263 #define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
2265 struct v4l2_dbg_match {
2266 __u32 type; /* Match type */
2267 union { /* Match this chip, meaning determined by type */
2271 } __attribute__ ((packed));
2273 struct v4l2_dbg_register {
2274 struct v4l2_dbg_match match;
2275 __u32 size; /* register size in bytes */
2278 } __attribute__ ((packed));
2280 #define V4L2_CHIP_FL_READABLE (1 << 0)
2281 #define V4L2_CHIP_FL_WRITABLE (1 << 1)
2283 /* VIDIOC_DBG_G_CHIP_INFO */
2284 struct v4l2_dbg_chip_info {
2285 struct v4l2_dbg_match match;
2289 } __attribute__ ((packed));
2292 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2293 * @index: on return, index of the first created buffer
2294 * @count: entry: number of requested buffers,
2295 * return: number of created buffers
2296 * @memory: enum v4l2_memory; buffer memory type
2297 * @format: frame format, for which buffers are requested
2298 * @reserved: future extensions
2300 struct v4l2_create_buffers {
2304 struct v4l2_format format;
2309 * 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
2312 #define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
2313 #define VIDIOC_RESERVED _IO('V', 1)
2314 #define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
2315 #define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
2316 #define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
2317 #define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
2318 #define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
2319 #define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
2320 #define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
2321 #define VIDIOC_OVERLAY _IOW('V', 14, int)
2322 #define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
2323 #define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
2324 #define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
2325 #define VIDIOC_STREAMON _IOW('V', 18, int)
2326 #define VIDIOC_STREAMOFF _IOW('V', 19, int)
2327 #define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
2328 #define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
2329 #define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
2330 #define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
2331 #define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
2332 #define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2333 #define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2334 #define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2335 #define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2336 #define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2337 #define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2338 #define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2339 #define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2340 #define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2341 #define VIDIOC_G_INPUT _IOR('V', 38, int)
2342 #define VIDIOC_S_INPUT _IOWR('V', 39, int)
2343 #define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2344 #define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
2345 #define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2346 #define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2347 #define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2348 #define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2349 #define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2350 #define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2351 #define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2352 #define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2353 #define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2354 #define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2355 #define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2356 #define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2357 #define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2358 #define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2359 #define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2360 #define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2361 #define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2362 #define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2363 #define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
2364 #define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
2365 #define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2366 #define VIDIOC_LOG_STATUS _IO('V', 70)
2367 #define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2368 #define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2369 #define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
2370 #define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2371 #define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2372 #define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2373 #define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2374 #define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
2377 * Experimental, meant for debugging, testing and internal use.
2378 * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2379 * You must be root to use these ioctls. Never use these in applications!
2381 #define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2382 #define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2384 #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
2385 #define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2386 #define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2387 #define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2388 #define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2389 #define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2390 #define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2391 #define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
2392 #define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2393 #define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
2394 #define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2395 #define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
2396 #define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2397 #define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2398 #define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
2399 #define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2402 * Experimental, meant for debugging, testing and internal use.
2403 * Never use this in applications!
2405 #define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
2407 #define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2409 /* Reminder: when adding new ioctls please add support for them to
2410 drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
2412 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2414 #endif /* _UAPI__LINUX_VIDEODEV2_H */
projects / linux.git / blob