2 * Video for Linux Two header file
4 * Copyright (C) 1999-2012 the contributors
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * Alternatively you can redistribute this file under the terms of the
17 * BSD license as stated below:
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in
26 * the documentation and/or other materials provided with the
28 * 3. The names of its contributors may not be used to endorse or promote
29 * products derived from this software without specific prior written
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
38 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
39 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
40 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
41 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
42 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 * Header file for v4l or V4L2 drivers and applications
46 * All kernel-specific stuff were moved to media/v4l2-dev.h, so
47 * no #if __KERNEL tests are allowed here
49 * See https://linuxtv.org for more info
51 * Author: Bill Dirks <bill@thedirks.org>
53 * Hans Verkuil <hverkuil@xs4all.nl>
56 #ifndef _UAPI__LINUX_VIDEODEV2_H
57 #define _UAPI__LINUX_VIDEODEV2_H
60 #include <sys/ioctl.h>
62 #include "ext/types-compat.h"
63 #include "ext/v4l2-common.h"
64 #include "ext/v4l2-controls.h"
67 * Common stuff for both V4L1 and V4L2
68 * Moved from videodev.h
70 #define VIDEO_MAX_FRAME 32
71 #define VIDEO_MAX_PLANES 8
74 * M I S C E L L A N E O U S
77 /* Four-character-code (FOURCC) */
78 #define v4l2_fourcc(a, b, c, d)\
79 ((__u32)(a) | ((__u32)(b) << 8) | ((__u32)(c) << 16) | ((__u32)(d) << 24))
80 #define v4l2_fourcc_be(a, b, c, d) (v4l2_fourcc(a, b, c, d) | (1 << 31))
86 V4L2_FIELD_ANY = 0, /* driver can choose from none,
87 top, bottom, interlaced
88 depending on whatever it thinks
90 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
91 V4L2_FIELD_TOP = 2, /* top field only */
92 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
93 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
94 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
95 buffer, top-bottom order */
96 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
97 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
99 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
100 first and the top field is
102 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
103 first and the bottom field is
106 #define V4L2_FIELD_HAS_TOP(field) \
107 ((field) == V4L2_FIELD_TOP ||\
108 (field) == V4L2_FIELD_INTERLACED ||\
109 (field) == V4L2_FIELD_INTERLACED_TB ||\
110 (field) == V4L2_FIELD_INTERLACED_BT ||\
111 (field) == V4L2_FIELD_SEQ_TB ||\
112 (field) == V4L2_FIELD_SEQ_BT)
113 #define V4L2_FIELD_HAS_BOTTOM(field) \
114 ((field) == V4L2_FIELD_BOTTOM ||\
115 (field) == V4L2_FIELD_INTERLACED ||\
116 (field) == V4L2_FIELD_INTERLACED_TB ||\
117 (field) == V4L2_FIELD_INTERLACED_BT ||\
118 (field) == V4L2_FIELD_SEQ_TB ||\
119 (field) == V4L2_FIELD_SEQ_BT)
120 #define V4L2_FIELD_HAS_BOTH(field) \
121 ((field) == V4L2_FIELD_INTERLACED ||\
122 (field) == V4L2_FIELD_INTERLACED_TB ||\
123 (field) == V4L2_FIELD_INTERLACED_BT ||\
124 (field) == V4L2_FIELD_SEQ_TB ||\
125 (field) == V4L2_FIELD_SEQ_BT)
126 #define V4L2_FIELD_HAS_T_OR_B(field) \
127 ((field) == V4L2_FIELD_BOTTOM ||\
128 (field) == V4L2_FIELD_TOP ||\
129 (field) == V4L2_FIELD_ALTERNATE)
132 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
133 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
134 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
135 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
136 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
137 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
138 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
139 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
140 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
141 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
142 V4L2_BUF_TYPE_SDR_CAPTURE = 11,
143 V4L2_BUF_TYPE_SDR_OUTPUT = 12,
144 V4L2_BUF_TYPE_META_CAPTURE = 13,
145 /* Deprecated, do not use */
146 V4L2_BUF_TYPE_PRIVATE = 0x80,
149 #define V4L2_TYPE_IS_MULTIPLANAR(type) \
150 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
151 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
153 #define V4L2_TYPE_IS_OUTPUT(type) \
154 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
155 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
156 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
157 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
158 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
159 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT \
160 || (type) == V4L2_BUF_TYPE_SDR_OUTPUT)
162 enum v4l2_tuner_type {
163 V4L2_TUNER_RADIO = 1,
164 V4L2_TUNER_ANALOG_TV = 2,
165 V4L2_TUNER_DIGITAL_TV = 3,
170 /* Deprecated, do not use */
171 #define V4L2_TUNER_ADC V4L2_TUNER_SDR
174 V4L2_MEMORY_MMAP = 1,
175 V4L2_MEMORY_USERPTR = 2,
176 V4L2_MEMORY_OVERLAY = 3,
177 V4L2_MEMORY_DMABUF = 4,
180 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
181 enum v4l2_colorspace {
183 * Default colorspace, i.e. let the driver figure it out.
184 * Can only be used with video capture.
186 V4L2_COLORSPACE_DEFAULT = 0,
188 /* SMPTE 170M: used for broadcast NTSC/PAL SDTV */
189 V4L2_COLORSPACE_SMPTE170M = 1,
191 /* Obsolete pre-1998 SMPTE 240M HDTV standard, superseded by Rec 709 */
192 V4L2_COLORSPACE_SMPTE240M = 2,
194 /* Rec.709: used for HDTV */
195 V4L2_COLORSPACE_REC709 = 3,
198 * Deprecated, do not use. No driver will ever return this. This was
199 * based on a misunderstanding of the bt878 datasheet.
201 V4L2_COLORSPACE_BT878 = 4,
204 * NTSC 1953 colorspace. This only makes sense when dealing with
205 * really, really old NTSC recordings. Superseded by SMPTE 170M.
207 V4L2_COLORSPACE_470_SYSTEM_M = 5,
210 * EBU Tech 3213 PAL/SECAM colorspace. This only makes sense when
211 * dealing with really old PAL/SECAM recordings. Superseded by
214 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
217 * Effectively shorthand for V4L2_COLORSPACE_SRGB, V4L2_YCBCR_ENC_601
218 * and V4L2_QUANTIZATION_FULL_RANGE. To be used for (Motion-)JPEG.
220 V4L2_COLORSPACE_JPEG = 7,
222 /* For RGB colorspaces such as produces by most webcams. */
223 V4L2_COLORSPACE_SRGB = 8,
225 /* AdobeRGB colorspace */
226 V4L2_COLORSPACE_ADOBERGB = 9,
228 /* BT.2020 colorspace, used for UHDTV. */
229 V4L2_COLORSPACE_BT2020 = 10,
231 /* Raw colorspace: for RAW unprocessed images */
232 V4L2_COLORSPACE_RAW = 11,
234 /* DCI-P3 colorspace, used by cinema projectors */
235 V4L2_COLORSPACE_DCI_P3 = 12,
239 * Determine how COLORSPACE_DEFAULT should map to a proper colorspace.
240 * This depends on whether this is a SDTV image (use SMPTE 170M), an
241 * HDTV image (use Rec. 709), or something else (use sRGB).
243 #define V4L2_MAP_COLORSPACE_DEFAULT(is_sdtv, is_hdtv) \
244 ((is_sdtv) ? V4L2_COLORSPACE_SMPTE170M : \
245 ((is_hdtv) ? V4L2_COLORSPACE_REC709 : V4L2_COLORSPACE_SRGB))
247 enum v4l2_xfer_func {
249 * Mapping of V4L2_XFER_FUNC_DEFAULT to actual transfer functions
250 * for the various colorspaces:
252 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
253 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_REC709 and
254 * V4L2_COLORSPACE_BT2020: V4L2_XFER_FUNC_709
256 * V4L2_COLORSPACE_SRGB, V4L2_COLORSPACE_JPEG: V4L2_XFER_FUNC_SRGB
258 * V4L2_COLORSPACE_ADOBERGB: V4L2_XFER_FUNC_ADOBERGB
260 * V4L2_COLORSPACE_SMPTE240M: V4L2_XFER_FUNC_SMPTE240M
262 * V4L2_COLORSPACE_RAW: V4L2_XFER_FUNC_NONE
264 * V4L2_COLORSPACE_DCI_P3: V4L2_XFER_FUNC_DCI_P3
266 V4L2_XFER_FUNC_DEFAULT = 0,
267 V4L2_XFER_FUNC_709 = 1,
268 V4L2_XFER_FUNC_SRGB = 2,
269 V4L2_XFER_FUNC_ADOBERGB = 3,
270 V4L2_XFER_FUNC_SMPTE240M = 4,
271 V4L2_XFER_FUNC_NONE = 5,
272 V4L2_XFER_FUNC_DCI_P3 = 6,
273 V4L2_XFER_FUNC_SMPTE2084 = 7,
277 * Determine how XFER_FUNC_DEFAULT should map to a proper transfer function.
278 * This depends on the colorspace.
280 #define V4L2_MAP_XFER_FUNC_DEFAULT(colsp) \
281 ((colsp) == V4L2_COLORSPACE_ADOBERGB ? V4L2_XFER_FUNC_ADOBERGB : \
282 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_XFER_FUNC_SMPTE240M : \
283 ((colsp) == V4L2_COLORSPACE_DCI_P3 ? V4L2_XFER_FUNC_DCI_P3 : \
284 ((colsp) == V4L2_COLORSPACE_RAW ? V4L2_XFER_FUNC_NONE : \
285 ((colsp) == V4L2_COLORSPACE_SRGB || (colsp) == V4L2_COLORSPACE_JPEG ? \
286 V4L2_XFER_FUNC_SRGB : V4L2_XFER_FUNC_709)))))
288 enum v4l2_ycbcr_encoding {
290 * Mapping of V4L2_YCBCR_ENC_DEFAULT to actual encodings for the
291 * various colorspaces:
293 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
294 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_SRGB,
295 * V4L2_COLORSPACE_ADOBERGB and V4L2_COLORSPACE_JPEG: V4L2_YCBCR_ENC_601
297 * V4L2_COLORSPACE_REC709 and V4L2_COLORSPACE_DCI_P3: V4L2_YCBCR_ENC_709
299 * V4L2_COLORSPACE_BT2020: V4L2_YCBCR_ENC_BT2020
301 * V4L2_COLORSPACE_SMPTE240M: V4L2_YCBCR_ENC_SMPTE240M
303 V4L2_YCBCR_ENC_DEFAULT = 0,
305 /* ITU-R 601 -- SDTV */
306 V4L2_YCBCR_ENC_601 = 1,
308 /* Rec. 709 -- HDTV */
309 V4L2_YCBCR_ENC_709 = 2,
311 /* ITU-R 601/EN 61966-2-4 Extended Gamut -- SDTV */
312 V4L2_YCBCR_ENC_XV601 = 3,
314 /* Rec. 709/EN 61966-2-4 Extended Gamut -- HDTV */
315 V4L2_YCBCR_ENC_XV709 = 4,
319 * sYCC (Y'CbCr encoding of sRGB), identical to ENC_601. It was added
320 * originally due to a misunderstanding of the sYCC standard. It should
321 * not be used, instead use V4L2_YCBCR_ENC_601.
323 V4L2_YCBCR_ENC_SYCC = 5,
326 /* BT.2020 Non-constant Luminance Y'CbCr */
327 V4L2_YCBCR_ENC_BT2020 = 6,
329 /* BT.2020 Constant Luminance Y'CbcCrc */
330 V4L2_YCBCR_ENC_BT2020_CONST_LUM = 7,
332 /* SMPTE 240M -- Obsolete HDTV */
333 V4L2_YCBCR_ENC_SMPTE240M = 8,
337 * enum v4l2_hsv_encoding values should not collide with the ones from
338 * enum v4l2_ycbcr_encoding.
340 enum v4l2_hsv_encoding {
342 /* Hue mapped to 0 - 179 */
343 V4L2_HSV_ENC_180 = 128,
345 /* Hue mapped to 0-255 */
346 V4L2_HSV_ENC_256 = 129,
350 * Determine how YCBCR_ENC_DEFAULT should map to a proper Y'CbCr encoding.
351 * This depends on the colorspace.
353 #define V4L2_MAP_YCBCR_ENC_DEFAULT(colsp) \
354 (((colsp) == V4L2_COLORSPACE_REC709 || \
355 (colsp) == V4L2_COLORSPACE_DCI_P3) ? V4L2_YCBCR_ENC_709 : \
356 ((colsp) == V4L2_COLORSPACE_BT2020 ? V4L2_YCBCR_ENC_BT2020 : \
357 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_YCBCR_ENC_SMPTE240M : \
358 V4L2_YCBCR_ENC_601)))
360 enum v4l2_quantization {
362 * The default for R'G'B' quantization is always full range, except
363 * for the BT2020 colorspace. For Y'CbCr the quantization is always
364 * limited range, except for COLORSPACE_JPEG: this is full range.
366 V4L2_QUANTIZATION_DEFAULT = 0,
367 V4L2_QUANTIZATION_FULL_RANGE = 1,
368 V4L2_QUANTIZATION_LIM_RANGE = 2,
372 * Determine how QUANTIZATION_DEFAULT should map to a proper quantization.
373 * This depends on whether the image is RGB or not, the colorspace and the
376 #define V4L2_MAP_QUANTIZATION_DEFAULT(is_rgb_or_hsv, colsp, ycbcr_enc) \
377 (((is_rgb_or_hsv) && (colsp) == V4L2_COLORSPACE_BT2020) ? \
378 V4L2_QUANTIZATION_LIM_RANGE : \
379 (((is_rgb_or_hsv) || (colsp) == V4L2_COLORSPACE_JPEG) ? \
380 V4L2_QUANTIZATION_FULL_RANGE : V4L2_QUANTIZATION_LIM_RANGE))
383 V4L2_PRIORITY_UNSET = 0, /* not initialized */
384 V4L2_PRIORITY_BACKGROUND = 1,
385 V4L2_PRIORITY_INTERACTIVE = 2,
386 V4L2_PRIORITY_RECORD = 3,
387 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
403 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
405 * @driver: name of the driver module (e.g. "bttv")
406 * @card: name of the card (e.g. "Hauppauge WinTV")
407 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
408 * @version: KERNEL_VERSION
409 * @capabilities: capabilities of the physical device as a whole
410 * @device_caps: capabilities accessed via this particular device (node)
411 * @reserved: reserved fields for future extensions
413 struct v4l2_capability {
423 /* Values for 'capabilities' field */
424 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
425 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
426 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
427 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
428 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
429 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
430 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
431 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
432 #define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
433 #define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
434 #define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
436 /* Is a video capture device that supports multiplanar formats */
437 #define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
438 /* Is a video output device that supports multiplanar formats */
439 #define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
440 /* Is a video mem-to-mem device that supports multiplanar formats */
441 #define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
442 /* Is a video mem-to-mem device */
443 #define V4L2_CAP_VIDEO_M2M 0x00008000
445 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
446 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
447 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
448 #define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
450 #define V4L2_CAP_SDR_CAPTURE 0x00100000 /* Is a SDR capture device */
451 #define V4L2_CAP_EXT_PIX_FORMAT 0x00200000 /* Supports the extended pixel format */
452 #define V4L2_CAP_SDR_OUTPUT 0x00400000 /* Is a SDR output device */
453 #define V4L2_CAP_META_CAPTURE 0x00800000 /* Is a metadata capture device */
455 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
456 #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
457 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
459 #define V4L2_CAP_TOUCH 0x10000000 /* Is a touch device */
461 #define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
464 * V I D E O I M A G E F O R M A T
466 struct v4l2_pix_format {
470 __u32 field; /* enum v4l2_field */
471 __u32 bytesperline; /* for padding, zero if unused */
473 __u32 colorspace; /* enum v4l2_colorspace */
474 __u32 priv; /* private data, depends on pixelformat */
475 __u32 flags; /* format flags (V4L2_PIX_FMT_FLAG_*) */
477 /* enum v4l2_ycbcr_encoding */
479 /* enum v4l2_hsv_encoding */
482 __u32 quantization; /* enum v4l2_quantization */
483 __u32 xfer_func; /* enum v4l2_xfer_func */
486 /* Pixel format FOURCC depth Description */
489 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
490 #define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
491 #define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16 aaaarrrr ggggbbbb */
492 #define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16 xxxxrrrr ggggbbbb */
493 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
494 #define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16 ARGB-1-5-5-5 */
495 #define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16 XRGB-1-5-5-5 */
496 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
497 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
498 #define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16 ARGB-5-5-5 BE */
499 #define V4L2_PIX_FMT_XRGB555X v4l2_fourcc_be('X', 'R', '1', '5') /* 16 XRGB-5-5-5 BE */
500 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
501 #define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
502 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
503 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
504 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
505 #define V4L2_PIX_FMT_ABGR32 v4l2_fourcc('A', 'R', '2', '4') /* 32 BGRA-8-8-8-8 */
506 #define V4L2_PIX_FMT_XBGR32 v4l2_fourcc('X', 'R', '2', '4') /* 32 BGRX-8-8-8-8 */
507 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
508 #define V4L2_PIX_FMT_ARGB32 v4l2_fourcc('B', 'A', '2', '4') /* 32 ARGB-8-8-8-8 */
509 #define V4L2_PIX_FMT_XRGB32 v4l2_fourcc('B', 'X', '2', '4') /* 32 XRGB-8-8-8-8 */
512 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
513 #define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
514 #define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
515 #define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
516 #define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
517 #define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
518 #define V4L2_PIX_FMT_Y16_BE v4l2_fourcc_be('Y', '1', '6', ' ') /* 16 Greyscale BE */
520 /* Grey bit-packed formats */
521 #define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
523 /* Palette formats */
524 #define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
526 /* Chrominance formats */
527 #define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
529 /* Luminance+Chrominance formats */
530 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
531 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
532 #define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
533 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
534 #define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
535 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
536 #define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
537 #define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
538 #define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
539 #define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
540 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
541 #define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
542 #define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
544 /* two planes -- one Y, one Cr + Cb interleaved */
545 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
546 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
547 #define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
548 #define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
549 #define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
550 #define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
552 /* two non contiguous planes - one Y, one Cr + Cb interleaved */
553 #define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
554 #define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
555 #define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
556 #define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
557 #define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
558 #define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 macroblocks */
560 /* three planes - Y Cb, Cr */
561 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
562 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
563 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 12 YVU411 planar */
564 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
565 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
566 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
568 /* three non contiguous planes - Y, Cb, Cr */
569 #define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
570 #define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
571 #define V4L2_PIX_FMT_YUV422M v4l2_fourcc('Y', 'M', '1', '6') /* 16 YUV422 planar */
572 #define V4L2_PIX_FMT_YVU422M v4l2_fourcc('Y', 'M', '6', '1') /* 16 YVU422 planar */
573 #define V4L2_PIX_FMT_YUV444M v4l2_fourcc('Y', 'M', '2', '4') /* 24 YUV444 planar */
574 #define V4L2_PIX_FMT_YVU444M v4l2_fourcc('Y', 'M', '4', '2') /* 24 YVU444 planar */
576 /* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
577 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
578 #define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
579 #define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
580 #define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
581 #define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
582 #define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
583 #define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
584 #define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
585 /* 10bit raw bayer packed, 5 bytes for every 4 pixels */
586 #define V4L2_PIX_FMT_SBGGR10P v4l2_fourcc('p', 'B', 'A', 'A')
587 #define V4L2_PIX_FMT_SGBRG10P v4l2_fourcc('p', 'G', 'A', 'A')
588 #define V4L2_PIX_FMT_SGRBG10P v4l2_fourcc('p', 'g', 'A', 'A')
589 #define V4L2_PIX_FMT_SRGGB10P v4l2_fourcc('p', 'R', 'A', 'A')
590 /* 10bit raw bayer a-law compressed to 8 bits */
591 #define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
592 #define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
593 #define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
594 #define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
595 /* 10bit raw bayer DPCM compressed to 8 bits */
596 #define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
597 #define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
598 #define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
599 #define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
600 #define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
601 #define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
602 #define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
603 #define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
604 #define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
605 #define V4L2_PIX_FMT_SGBRG16 v4l2_fourcc('G', 'B', '1', '6') /* 16 GBGB.. RGRG.. */
606 #define V4L2_PIX_FMT_SGRBG16 v4l2_fourcc('G', 'R', '1', '6') /* 16 GRGR.. BGBG.. */
607 #define V4L2_PIX_FMT_SRGGB16 v4l2_fourcc('R', 'G', '1', '6') /* 16 RGRG.. GBGB.. */
610 #define V4L2_PIX_FMT_HSV24 v4l2_fourcc('H', 'S', 'V', '3')
611 #define V4L2_PIX_FMT_HSV32 v4l2_fourcc('H', 'S', 'V', '4')
613 /* compressed formats */
614 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
615 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
616 #define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
617 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
618 #define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
619 #define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
620 #define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
621 #define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
622 #define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
623 #define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
624 #define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
625 #define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
626 #define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
627 #define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
628 #define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
629 #define V4L2_PIX_FMT_VP9 v4l2_fourcc('V', 'P', '9', '0') /* VP9 */
631 /* Vendor-specific formats */
632 #define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
633 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
634 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
635 #define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
636 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
637 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
638 #define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
639 #define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
640 #define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
641 #define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
642 #define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
643 #define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
644 #define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
645 #define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
646 #define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
647 #define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
648 #define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
649 #define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
650 #define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
651 #define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
652 #define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
653 #define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
654 #define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
655 #define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
656 #define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
657 #define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
658 #define V4L2_PIX_FMT_Y8I v4l2_fourcc('Y', '8', 'I', ' ') /* Greyscale 8-bit L/R interleaved */
659 #define V4L2_PIX_FMT_Y12I v4l2_fourcc('Y', '1', '2', 'I') /* Greyscale 12-bit L/R interleaved */
660 #define V4L2_PIX_FMT_Z16 v4l2_fourcc('Z', '1', '6', ' ') /* Depth data 16-bit */
661 #define V4L2_PIX_FMT_MT21C v4l2_fourcc('M', 'T', '2', '1') /* Mediatek compressed block mode */
662 #define V4L2_PIX_FMT_INZI v4l2_fourcc('I', 'N', 'Z', 'I') /* Intel Planar Greyscale 10-bit and Depth 16-bit */
664 /* SDR formats - used only for Software Defined Radio devices */
665 #define V4L2_SDR_FMT_CU8 v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
666 #define V4L2_SDR_FMT_CU16LE v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
667 #define V4L2_SDR_FMT_CS8 v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
668 #define V4L2_SDR_FMT_CS14LE v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
669 #define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
670 #define V4L2_SDR_FMT_PCU16BE v4l2_fourcc('P', 'C', '1', '6') /* planar complex u16be */
671 #define V4L2_SDR_FMT_PCU18BE v4l2_fourcc('P', 'C', '1', '8') /* planar complex u18be */
672 #define V4L2_SDR_FMT_PCU20BE v4l2_fourcc('P', 'C', '2', '0') /* planar complex u20be */
674 /* Touch formats - used for Touch devices */
675 #define V4L2_TCH_FMT_DELTA_TD16 v4l2_fourcc('T', 'D', '1', '6') /* 16-bit signed deltas */
676 #define V4L2_TCH_FMT_DELTA_TD08 v4l2_fourcc('T', 'D', '0', '8') /* 8-bit signed deltas */
677 #define V4L2_TCH_FMT_TU16 v4l2_fourcc('T', 'U', '1', '6') /* 16-bit unsigned touch data */
678 #define V4L2_TCH_FMT_TU08 v4l2_fourcc('T', 'U', '0', '8') /* 8-bit unsigned touch data */
680 /* Meta-data formats */
681 #define V4L2_META_FMT_VSP1_HGO v4l2_fourcc('V', 'S', 'P', 'H') /* R-Car VSP1 1-D Histogram */
682 #define V4L2_META_FMT_VSP1_HGT v4l2_fourcc('V', 'S', 'P', 'T') /* R-Car VSP1 2-D Histogram */
684 /* priv field value to indicates that subsequent fields are valid. */
685 #define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
688 #define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
691 * F O R M A T E N U M E R A T I O N
693 struct v4l2_fmtdesc {
694 __u32 index; /* Format number */
695 __u32 type; /* enum v4l2_buf_type */
697 __u8 description[32]; /* Description string */
698 __u32 pixelformat; /* Format fourcc */
702 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
703 #define V4L2_FMT_FLAG_EMULATED 0x0002
705 /* Frame Size and frame rate enumeration */
707 * F R A M E S I Z E E N U M E R A T I O N
709 enum v4l2_frmsizetypes {
710 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
711 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
712 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
715 struct v4l2_frmsize_discrete {
716 __u32 width; /* Frame width [pixel] */
717 __u32 height; /* Frame height [pixel] */
720 struct v4l2_frmsize_stepwise {
721 __u32 min_width; /* Minimum frame width [pixel] */
722 __u32 max_width; /* Maximum frame width [pixel] */
723 __u32 step_width; /* Frame width step size [pixel] */
724 __u32 min_height; /* Minimum frame height [pixel] */
725 __u32 max_height; /* Maximum frame height [pixel] */
726 __u32 step_height; /* Frame height step size [pixel] */
729 struct v4l2_frmsizeenum {
730 __u32 index; /* Frame size number */
731 __u32 pixel_format; /* Pixel format */
732 __u32 type; /* Frame size type the device supports. */
734 union { /* Frame size */
735 struct v4l2_frmsize_discrete discrete;
736 struct v4l2_frmsize_stepwise stepwise;
739 __u32 reserved[2]; /* Reserved space for future use */
743 * F R A M E R A T E E N U M E R A T I O N
745 enum v4l2_frmivaltypes {
746 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
747 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
748 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
751 struct v4l2_frmival_stepwise {
752 struct v4l2_fract min; /* Minimum frame interval [s] */
753 struct v4l2_fract max; /* Maximum frame interval [s] */
754 struct v4l2_fract step; /* Frame interval step size [s] */
757 struct v4l2_frmivalenum {
758 __u32 index; /* Frame format index */
759 __u32 pixel_format; /* Pixel format */
760 __u32 width; /* Frame width */
761 __u32 height; /* Frame height */
762 __u32 type; /* Frame interval type the device supports. */
764 union { /* Frame interval */
765 struct v4l2_fract discrete;
766 struct v4l2_frmival_stepwise stepwise;
769 __u32 reserved[2]; /* Reserved space for future use */
775 struct v4l2_timecode {
786 #define V4L2_TC_TYPE_24FPS 1
787 #define V4L2_TC_TYPE_25FPS 2
788 #define V4L2_TC_TYPE_30FPS 3
789 #define V4L2_TC_TYPE_50FPS 4
790 #define V4L2_TC_TYPE_60FPS 5
793 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
794 #define V4L2_TC_FLAG_COLORFRAME 0x0002
795 #define V4L2_TC_USERBITS_field 0x000C
796 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
797 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
798 /* The above is based on SMPTE timecodes */
800 struct v4l2_jpegcompression {
803 int APPn; /* Number of APP segment to be written,
805 int APP_len; /* Length of data in JPEG APPn segment */
806 char APP_data[60]; /* Data in the JPEG APPn segment. */
808 int COM_len; /* Length of data in JPEG COM segment */
809 char COM_data[60]; /* Data in JPEG COM segment */
811 __u32 jpeg_markers; /* Which markers should go into the JPEG
812 * output. Unless you exactly know what
813 * you do, leave them untouched.
814 * Including less markers will make the
815 * resulting code smaller, but there will
816 * be fewer applications which can read it.
817 * The presence of the APP and COM marker
818 * is influenced by APP_len and COM_len
819 * ONLY, not by this property! */
821 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
822 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
823 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
824 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
825 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
830 * M E M O R Y - M A P P I N G B U F F E R S
832 struct v4l2_requestbuffers {
834 __u32 type; /* enum v4l2_buf_type */
835 __u32 memory; /* enum v4l2_memory */
840 * struct v4l2_plane - plane info for multi-planar buffers
841 * @bytesused: number of bytes occupied by data in the plane (payload)
842 * @length: size of this plane (NOT the payload) in bytes
843 * @mem_offset: when memory in the associated struct v4l2_buffer is
844 * V4L2_MEMORY_MMAP, equals the offset from the start of
845 * the device memory for this plane (or is a "cookie" that
846 * should be passed to mmap() called on the video node)
847 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
848 * pointing to this plane
849 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
850 * descriptor associated with this plane
851 * @data_offset: offset in the plane to the start of data; usually 0,
852 * unless there is a header in front of the data
854 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
855 * with two planes can have one plane for Y, and another for interleaved CbCr
856 * components. Each plane can reside in a separate memory buffer, or even in
857 * a completely separate memory node (e.g. in embedded devices).
864 unsigned long userptr;
872 * struct v4l2_buffer - video buffer info
873 * @index: id number of the buffer
874 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
875 * multiplanar buffers);
876 * @bytesused: number of bytes occupied by data in the buffer (payload);
877 * unused (set to 0) for multiplanar buffers
878 * @flags: buffer informational flags
879 * @field: enum v4l2_field; field order of the image in the buffer
880 * @timestamp: frame timestamp
881 * @timecode: frame timecode
882 * @sequence: sequence count of this frame
883 * @memory: enum v4l2_memory; the method, in which the actual video data is
885 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
886 * offset from the start of the device memory for this plane,
887 * (or a "cookie" that should be passed to mmap() as offset)
888 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
889 * a userspace pointer pointing to this buffer
890 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
891 * a userspace file descriptor associated with this buffer
892 * @planes: for multiplanar buffers; userspace pointer to the array of plane
893 * info structs for this buffer
894 * @length: size in bytes of the buffer (NOT its payload) for single-plane
895 * buffers (when type != *_MPLANE); number of elements in the
896 * planes array for multi-plane buffers
898 * Contains data exchanged by application and driver using one of the Streaming
907 struct timeval timestamp;
908 struct v4l2_timecode timecode;
911 /* memory location */
915 unsigned long userptr;
916 struct v4l2_plane *planes;
924 /* Flags for 'flags' field */
925 /* Buffer is mapped (flag) */
926 #define V4L2_BUF_FLAG_MAPPED 0x00000001
927 /* Buffer is queued for processing */
928 #define V4L2_BUF_FLAG_QUEUED 0x00000002
929 /* Buffer is ready */
930 #define V4L2_BUF_FLAG_DONE 0x00000004
931 /* Image is a keyframe (I-frame) */
932 #define V4L2_BUF_FLAG_KEYFRAME 0x00000008
933 /* Image is a P-frame */
934 #define V4L2_BUF_FLAG_PFRAME 0x00000010
935 /* Image is a B-frame */
936 #define V4L2_BUF_FLAG_BFRAME 0x00000020
937 /* Buffer is ready, but the data contained within is corrupted. */
938 #define V4L2_BUF_FLAG_ERROR 0x00000040
939 /* timecode field is valid */
940 #define V4L2_BUF_FLAG_TIMECODE 0x00000100
941 /* Buffer is prepared for queuing */
942 #define V4L2_BUF_FLAG_PREPARED 0x00000400
943 /* Cache handling flags */
944 #define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
945 #define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
947 #define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
948 #define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
949 #define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
950 #define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
951 /* Timestamp sources. */
952 #define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
953 #define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
954 #define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
955 /* mem2mem encoder/decoder */
956 #define V4L2_BUF_FLAG_LAST 0x00100000
959 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
961 * @index: id number of the buffer
962 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
963 * multiplanar buffers);
964 * @plane: index of the plane to be exported, 0 for single plane queues
965 * @flags: flags for newly created file, currently only O_CLOEXEC is
966 * supported, refer to manual of open syscall for more details
967 * @fd: file descriptor associated with DMABUF (set by driver)
969 * Contains data used for exporting a video buffer as DMABUF file descriptor.
970 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
971 * (identical to the cookie used to mmap() the buffer to userspace). All
972 * reserved fields must be set to zero. The field reserved0 is expected to
973 * become a structure 'type' allowing an alternative layout of the structure
974 * content. Therefore this field should not be used for any other extensions.
976 struct v4l2_exportbuffer {
977 __u32 type; /* enum v4l2_buf_type */
986 * O V E R L A Y P R E V I E W
988 struct v4l2_framebuffer {
991 /* FIXME: in theory we should pass something like PCI device + memory
992 * region + offset instead of some physical address */
998 __u32 field; /* enum v4l2_field */
999 __u32 bytesperline; /* for padding, zero if unused */
1001 __u32 colorspace; /* enum v4l2_colorspace */
1002 __u32 priv; /* reserved field, set to 0 */
1005 /* Flags for the 'capability' field. Read only */
1006 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
1007 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
1008 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
1009 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
1010 #define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
1011 #define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
1012 #define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
1013 #define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
1014 /* Flags for the 'flags' field. */
1015 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
1016 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
1017 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
1018 #define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
1019 #define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
1020 #define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
1021 #define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
1025 struct v4l2_clip __user *next;
1028 struct v4l2_window {
1030 __u32 field; /* enum v4l2_field */
1032 struct v4l2_clip __user *clips;
1034 void __user *bitmap;
1039 * C A P T U R E P A R A M E T E R S
1041 struct v4l2_captureparm {
1042 __u32 capability; /* Supported modes */
1043 __u32 capturemode; /* Current mode */
1044 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1045 __u32 extendedmode; /* Driver-specific extensions */
1046 __u32 readbuffers; /* # of buffers for read */
1050 /* Flags for 'capability' and 'capturemode' fields */
1051 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
1052 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
1054 struct v4l2_outputparm {
1055 __u32 capability; /* Supported modes */
1056 __u32 outputmode; /* Current mode */
1057 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1058 __u32 extendedmode; /* Driver-specific extensions */
1059 __u32 writebuffers; /* # of buffers for write */
1064 * I N P U T I M A G E C R O P P I N G
1066 struct v4l2_cropcap {
1067 __u32 type; /* enum v4l2_buf_type */
1068 struct v4l2_rect bounds;
1069 struct v4l2_rect defrect;
1070 struct v4l2_fract pixelaspect;
1074 __u32 type; /* enum v4l2_buf_type */
1079 * struct v4l2_selection - selection info
1080 * @type: buffer type (do not use *_MPLANE types)
1081 * @target: Selection target, used to choose one of possible rectangles;
1082 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
1083 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1084 * @r: coordinates of selection window
1085 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
1087 * Hardware may use multiple helper windows to process a video stream.
1088 * The structure is used to exchange this selection areas between
1089 * an application and a driver.
1091 struct v4l2_selection {
1101 * A N A L O G V I D E O S T A N D A R D
1104 typedef __u64 v4l2_std_id;
1106 /* one bit for each */
1107 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
1108 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
1109 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
1110 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
1111 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
1112 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
1113 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
1114 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
1116 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
1117 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
1118 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
1119 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
1121 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
1122 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
1123 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
1124 #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
1126 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
1127 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
1128 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
1129 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
1130 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
1131 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
1132 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
1133 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
1136 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
1137 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
1140 Although std_id is 64 bits, there is an issue on PPC32 architecture that
1141 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
1142 this value to 32 bits.
1143 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1144 it should work fine. However, if needed to add more than two standards,
1145 v4l2-common.c should be fixed.
1149 * Some macros to merge video standards in order to make live easier for the
1150 * drivers and V4L2 applications
1154 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1157 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
1158 V4L2_STD_NTSC_M_JP |\
1161 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
1164 /* All Secam Standards */
1165 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
1168 V4L2_STD_SECAM_DK |\
1172 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
1175 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
1179 * "Common" PAL - This macro is there to be compatible with the old
1180 * V4L1 concept of "PAL": /BGDKHI.
1181 * Several PAL standards are missing here: /M, /N and /Nc
1183 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
1187 /* Chroma "agnostic" standards */
1188 #define V4L2_STD_B (V4L2_STD_PAL_B |\
1191 #define V4L2_STD_G (V4L2_STD_PAL_G |\
1193 #define V4L2_STD_H (V4L2_STD_PAL_H |\
1195 #define V4L2_STD_L (V4L2_STD_SECAM_L |\
1197 #define V4L2_STD_GH (V4L2_STD_G |\
1199 #define V4L2_STD_DK (V4L2_STD_PAL_DK |\
1201 #define V4L2_STD_BG (V4L2_STD_B |\
1203 #define V4L2_STD_MN (V4L2_STD_PAL_M |\
1208 /* Standards where MTS/BTSC stereo could be found */
1209 #define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
1214 /* Standards for Countries with 60Hz Line frequency */
1215 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
1219 /* Standards for Countries with 50Hz Line frequency */
1220 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
1225 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1226 V4L2_STD_ATSC_16_VSB)
1227 /* Macros with none and all analog standards */
1228 #define V4L2_STD_UNKNOWN 0
1229 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
1232 struct v4l2_standard {
1236 struct v4l2_fract frameperiod; /* Frames, not fields */
1242 * D V B T T I M I N G S
1245 /** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1246 * @width: total width of the active video in pixels
1247 * @height: total height of the active video in lines
1248 * @interlaced: Interlaced or progressive
1249 * @polarities: Positive or negative polarities
1250 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1251 * @hfrontporch:Horizontal front porch in pixels
1252 * @hsync: Horizontal Sync length in pixels
1253 * @hbackporch: Horizontal back porch in pixels
1254 * @vfrontporch:Vertical front porch in lines
1255 * @vsync: Vertical Sync length in lines
1256 * @vbackporch: Vertical back porch in lines
1257 * @il_vfrontporch:Vertical front porch for the even field
1258 * (aka field 2) of interlaced field formats
1259 * @il_vsync: Vertical Sync length for the even field
1260 * (aka field 2) of interlaced field formats
1261 * @il_vbackporch:Vertical back porch for the even field
1262 * (aka field 2) of interlaced field formats
1263 * @standards: Standards the timing belongs to
1265 * @picture_aspect: The picture aspect ratio (hor/vert).
1266 * @cea861_vic: VIC code as per the CEA-861 standard.
1267 * @hdmi_vic: VIC code as per the HDMI standard.
1268 * @reserved: Reserved fields, must be zeroed.
1270 * A note regarding vertical interlaced timings: height refers to the total
1271 * height of the active video frame (= two fields). The blanking timings refer
1272 * to the blanking of each field. So the height of the total frame is
1273 * calculated as follows:
1275 * tot_height = height + vfrontporch + vsync + vbackporch +
1276 * il_vfrontporch + il_vsync + il_vbackporch
1278 * The active height of each field is height / 2.
1280 struct v4l2_bt_timings {
1292 __u32 il_vfrontporch;
1294 __u32 il_vbackporch;
1297 struct v4l2_fract picture_aspect;
1301 } __attribute__ ((packed));
1303 /* Interlaced or progressive format */
1304 #define V4L2_DV_PROGRESSIVE 0
1305 #define V4L2_DV_INTERLACED 1
1307 /* Polarities. If bit is not set, it is assumed to be negative polarity */
1308 #define V4L2_DV_VSYNC_POS_POL 0x00000001
1309 #define V4L2_DV_HSYNC_POS_POL 0x00000002
1311 /* Timings standards */
1312 #define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1313 #define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1314 #define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1315 #define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
1316 #define V4L2_DV_BT_STD_SDI (1 << 4) /* SDI Timings */
1321 * CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1322 * GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1323 * intervals are reduced, allowing a higher resolution over the same
1324 * bandwidth. This is a read-only flag.
1326 #define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1328 * CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1329 * of six. These formats can be optionally played at 1 / 1.001 speed.
1330 * This is a read-only flag.
1332 #define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1334 * CEA-861 specific: only valid for video transmitters, the flag is cleared
1336 * If the framerate of the format is a multiple of six, then the pixelclock
1337 * used to set up the transmitter is divided by 1.001 to make it compatible
1338 * with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1339 * 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1340 * such frequencies, then the flag will also be cleared.
1342 #define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1344 * Specific to interlaced formats: if set, then field 1 is really one half-line
1345 * longer and field 2 is really one half-line shorter, so each field has
1346 * exactly the same number of half-lines. Whether half-lines can be detected
1347 * or used depends on the hardware.
1349 #define V4L2_DV_FL_HALF_LINE (1 << 3)
1351 * If set, then this is a Consumer Electronics (CE) video format. Such formats
1352 * differ from other formats (commonly called IT formats) in that if RGB
1353 * encoding is used then by default the RGB values use limited range (i.e.
1354 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
1355 * except for the 640x480 format are CE formats.
1357 #define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
1358 /* Some formats like SMPTE-125M have an interlaced signal with a odd
1359 * total height. For these formats, if this flag is set, the first
1360 * field has the extra line. If not, it is the second field.
1362 #define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE (1 << 5)
1364 * If set, then the picture_aspect field is valid. Otherwise assume that the
1365 * pixels are square, so the picture aspect ratio is the same as the width to
1368 #define V4L2_DV_FL_HAS_PICTURE_ASPECT (1 << 6)
1370 * If set, then the cea861_vic field is valid and contains the Video
1371 * Identification Code as per the CEA-861 standard.
1373 #define V4L2_DV_FL_HAS_CEA861_VIC (1 << 7)
1375 * If set, then the hdmi_vic field is valid and contains the Video
1376 * Identification Code as per the HDMI standard (HDMI Vendor Specific
1379 #define V4L2_DV_FL_HAS_HDMI_VIC (1 << 8)
1381 /* A few useful defines to calculate the total blanking and frame sizes */
1382 #define V4L2_DV_BT_BLANKING_WIDTH(bt) \
1383 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
1384 #define V4L2_DV_BT_FRAME_WIDTH(bt) \
1385 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
1386 #define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
1387 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1388 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
1389 #define V4L2_DV_BT_FRAME_HEIGHT(bt) \
1390 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
1392 /** struct v4l2_dv_timings - DV timings
1393 * @type: the type of the timings
1394 * @bt: BT656/1120 timings
1396 struct v4l2_dv_timings {
1399 struct v4l2_bt_timings bt;
1402 } __attribute__ ((packed));
1404 /* Values for the type field */
1405 #define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1408 /** struct v4l2_enum_dv_timings - DV timings enumeration
1409 * @index: enumeration index
1410 * @pad: the pad number for which to enumerate timings (used with
1411 * v4l-subdev nodes only)
1412 * @reserved: must be zeroed
1413 * @timings: the timings for the given index
1415 struct v4l2_enum_dv_timings {
1419 struct v4l2_dv_timings timings;
1422 /** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1423 * @min_width: width in pixels
1424 * @max_width: width in pixels
1425 * @min_height: height in lines
1426 * @max_height: height in lines
1427 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1428 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1429 * @standards: Supported standards
1430 * @capabilities: Supported capabilities
1431 * @reserved: Must be zeroed
1433 struct v4l2_bt_timings_cap {
1438 __u64 min_pixelclock;
1439 __u64 max_pixelclock;
1443 } __attribute__ ((packed));
1445 /* Supports interlaced formats */
1446 #define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1447 /* Supports progressive formats */
1448 #define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1449 /* Supports CVT/GTF reduced blanking */
1450 #define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1451 /* Supports custom formats */
1452 #define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1454 /** struct v4l2_dv_timings_cap - DV timings capabilities
1455 * @type: the type of the timings (same as in struct v4l2_dv_timings)
1456 * @pad: the pad number for which to query capabilities (used with
1457 * v4l-subdev nodes only)
1458 * @bt: the BT656/1120 timings capabilities
1460 struct v4l2_dv_timings_cap {
1465 struct v4l2_bt_timings_cap bt;
1472 * V I D E O I N P U T S
1475 __u32 index; /* Which input */
1476 __u8 name[32]; /* Label */
1477 __u32 type; /* Type of input */
1478 __u32 audioset; /* Associated audios (bitfield) */
1479 __u32 tuner; /* enum v4l2_tuner_type */
1486 /* Values for the 'type' field */
1487 #define V4L2_INPUT_TYPE_TUNER 1
1488 #define V4L2_INPUT_TYPE_CAMERA 2
1489 #define V4L2_INPUT_TYPE_TOUCH 3
1491 /* field 'status' - general */
1492 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1493 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
1494 #define V4L2_IN_ST_NO_COLOR 0x00000004
1496 /* field 'status' - sensor orientation */
1497 /* If sensor is mounted upside down set both bits */
1498 #define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1499 #define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1501 /* field 'status' - analog */
1502 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1503 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1504 #define V4L2_IN_ST_NO_V_LOCK 0x00000400 /* No vertical sync lock */
1505 #define V4L2_IN_ST_NO_STD_LOCK 0x00000800 /* No standard format lock */
1507 /* field 'status' - digital */
1508 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1509 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1510 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1512 /* field 'status' - VCR and set-top box */
1513 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1514 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1515 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1517 /* capabilities flags */
1518 #define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1519 #define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1520 #define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
1521 #define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1524 * V I D E O O U T P U T S
1526 struct v4l2_output {
1527 __u32 index; /* Which output */
1528 __u8 name[32]; /* Label */
1529 __u32 type; /* Type of output */
1530 __u32 audioset; /* Associated audios (bitfield) */
1531 __u32 modulator; /* Associated modulator */
1536 /* Values for the 'type' field */
1537 #define V4L2_OUTPUT_TYPE_MODULATOR 1
1538 #define V4L2_OUTPUT_TYPE_ANALOG 2
1539 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1541 /* capabilities flags */
1542 #define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1543 #define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1544 #define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
1545 #define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1550 struct v4l2_control {
1555 struct v4l2_ext_control {
1562 char __user *string;
1564 __u16 __user *p_u16;
1565 __u32 __user *p_u32;
1568 } __attribute__ ((packed));
1570 struct v4l2_ext_controls {
1580 struct v4l2_ext_control *controls;
1583 #define V4L2_CTRL_ID_MASK (0x0fffffff)
1585 #define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1587 #define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
1588 #define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1589 #define V4L2_CTRL_MAX_DIMS (4)
1590 #define V4L2_CTRL_WHICH_CUR_VAL 0
1591 #define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
1593 enum v4l2_ctrl_type {
1594 V4L2_CTRL_TYPE_INTEGER = 1,
1595 V4L2_CTRL_TYPE_BOOLEAN = 2,
1596 V4L2_CTRL_TYPE_MENU = 3,
1597 V4L2_CTRL_TYPE_BUTTON = 4,
1598 V4L2_CTRL_TYPE_INTEGER64 = 5,
1599 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1600 V4L2_CTRL_TYPE_STRING = 7,
1601 V4L2_CTRL_TYPE_BITMASK = 8,
1602 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1604 /* Compound types are >= 0x0100 */
1605 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
1606 V4L2_CTRL_TYPE_U8 = 0x0100,
1607 V4L2_CTRL_TYPE_U16 = 0x0101,
1608 V4L2_CTRL_TYPE_U32 = 0x0102,
1611 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1612 struct v4l2_queryctrl {
1614 __u32 type; /* enum v4l2_ctrl_type */
1615 __u8 name[32]; /* Whatever */
1616 __s32 minimum; /* Note signedness */
1619 __s32 default_value;
1624 /* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1625 struct v4l2_query_ext_ctrl {
1632 __s64 default_value;
1637 __u32 dims[V4L2_CTRL_MAX_DIMS];
1641 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1642 struct v4l2_querymenu {
1646 __u8 name[32]; /* Whatever */
1650 } __attribute__ ((packed));
1653 #define V4L2_CTRL_FLAG_DISABLED 0x0001
1654 #define V4L2_CTRL_FLAG_GRABBED 0x0002
1655 #define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1656 #define V4L2_CTRL_FLAG_UPDATE 0x0008
1657 #define V4L2_CTRL_FLAG_INACTIVE 0x0010
1658 #define V4L2_CTRL_FLAG_SLIDER 0x0020
1659 #define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1660 #define V4L2_CTRL_FLAG_VOLATILE 0x0080
1661 #define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
1662 #define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
1663 #define V4L2_CTRL_FLAG_MODIFY_LAYOUT 0x0400
1665 /* Query flags, to be ORed with the control ID */
1666 #define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1667 #define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
1669 /* User-class control IDs defined by V4L2 */
1670 #define V4L2_CID_MAX_CTRLS 1024
1671 /* IDs reserved for driver specific controls */
1672 #define V4L2_CID_PRIVATE_BASE 0x08000000
1681 __u32 type; /* enum v4l2_tuner_type */
1692 struct v4l2_modulator {
1699 __u32 type; /* enum v4l2_tuner_type */
1703 /* Flags for the 'capability' field */
1704 #define V4L2_TUNER_CAP_LOW 0x0001
1705 #define V4L2_TUNER_CAP_NORM 0x0002
1706 #define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1707 #define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1708 #define V4L2_TUNER_CAP_STEREO 0x0010
1709 #define V4L2_TUNER_CAP_LANG2 0x0020
1710 #define V4L2_TUNER_CAP_SAP 0x0020
1711 #define V4L2_TUNER_CAP_LANG1 0x0040
1712 #define V4L2_TUNER_CAP_RDS 0x0080
1713 #define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1714 #define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1715 #define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1716 #define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
1717 #define V4L2_TUNER_CAP_1HZ 0x1000
1719 /* Flags for the 'rxsubchans' field */
1720 #define V4L2_TUNER_SUB_MONO 0x0001
1721 #define V4L2_TUNER_SUB_STEREO 0x0002
1722 #define V4L2_TUNER_SUB_LANG2 0x0004
1723 #define V4L2_TUNER_SUB_SAP 0x0004
1724 #define V4L2_TUNER_SUB_LANG1 0x0008
1725 #define V4L2_TUNER_SUB_RDS 0x0010
1727 /* Values for the 'audmode' field */
1728 #define V4L2_TUNER_MODE_MONO 0x0000
1729 #define V4L2_TUNER_MODE_STEREO 0x0001
1730 #define V4L2_TUNER_MODE_LANG2 0x0002
1731 #define V4L2_TUNER_MODE_SAP 0x0002
1732 #define V4L2_TUNER_MODE_LANG1 0x0003
1733 #define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1735 struct v4l2_frequency {
1737 __u32 type; /* enum v4l2_tuner_type */
1742 #define V4L2_BAND_MODULATION_VSB (1 << 1)
1743 #define V4L2_BAND_MODULATION_FM (1 << 2)
1744 #define V4L2_BAND_MODULATION_AM (1 << 3)
1746 struct v4l2_frequency_band {
1748 __u32 type; /* enum v4l2_tuner_type */
1757 struct v4l2_hw_freq_seek {
1759 __u32 type; /* enum v4l2_tuner_type */
1772 struct v4l2_rds_data {
1776 } __attribute__ ((packed));
1778 #define V4L2_RDS_BLOCK_MSK 0x7
1779 #define V4L2_RDS_BLOCK_A 0
1780 #define V4L2_RDS_BLOCK_B 1
1781 #define V4L2_RDS_BLOCK_C 2
1782 #define V4L2_RDS_BLOCK_D 3
1783 #define V4L2_RDS_BLOCK_C_ALT 4
1784 #define V4L2_RDS_BLOCK_INVALID 7
1786 #define V4L2_RDS_BLOCK_CORRECTED 0x40
1787 #define V4L2_RDS_BLOCK_ERROR 0x80
1800 /* Flags for the 'capability' field */
1801 #define V4L2_AUDCAP_STEREO 0x00001
1802 #define V4L2_AUDCAP_AVL 0x00002
1804 /* Flags for the 'mode' field */
1805 #define V4L2_AUDMODE_AVL 0x00001
1807 struct v4l2_audioout {
1816 * M P E G S E R V I C E S
1819 #define V4L2_ENC_IDX_FRAME_I (0)
1820 #define V4L2_ENC_IDX_FRAME_P (1)
1821 #define V4L2_ENC_IDX_FRAME_B (2)
1822 #define V4L2_ENC_IDX_FRAME_MASK (0xf)
1824 struct v4l2_enc_idx_entry {
1832 #define V4L2_ENC_IDX_ENTRIES (64)
1833 struct v4l2_enc_idx {
1837 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1841 #define V4L2_ENC_CMD_START (0)
1842 #define V4L2_ENC_CMD_STOP (1)
1843 #define V4L2_ENC_CMD_PAUSE (2)
1844 #define V4L2_ENC_CMD_RESUME (3)
1846 /* Flags for V4L2_ENC_CMD_STOP */
1847 #define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1849 struct v4l2_encoder_cmd {
1859 /* Decoder commands */
1860 #define V4L2_DEC_CMD_START (0)
1861 #define V4L2_DEC_CMD_STOP (1)
1862 #define V4L2_DEC_CMD_PAUSE (2)
1863 #define V4L2_DEC_CMD_RESUME (3)
1865 /* Flags for V4L2_DEC_CMD_START */
1866 #define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1868 /* Flags for V4L2_DEC_CMD_PAUSE */
1869 #define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
1871 /* Flags for V4L2_DEC_CMD_STOP */
1872 #define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
1873 #define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
1875 /* Play format requirements (returned by the driver): */
1877 /* The decoder has no special format requirements */
1878 #define V4L2_DEC_START_FMT_NONE (0)
1879 /* The decoder requires full GOPs */
1880 #define V4L2_DEC_START_FMT_GOP (1)
1882 /* The structure must be zeroed before use by the application
1883 This ensures it can be extended safely in the future. */
1884 struct v4l2_decoder_cmd {
1893 /* 0 or 1000 specifies normal speed,
1894 1 specifies forward single stepping,
1895 -1 specifies backward single stepping,
1896 >1: playback at speed/1000 of the normal speed,
1897 <-1: reverse playback at (-speed/1000) of the normal speed. */
1911 * D A T A S E R V I C E S ( V B I )
1913 * Data services API by Michael Schimek
1917 struct v4l2_vbi_format {
1918 __u32 sampling_rate; /* in 1 Hz */
1920 __u32 samples_per_line;
1921 __u32 sample_format; /* V4L2_PIX_FMT_* */
1924 __u32 flags; /* V4L2_VBI_* */
1925 __u32 reserved[2]; /* must be zero */
1929 #define V4L2_VBI_UNSYNC (1 << 0)
1930 #define V4L2_VBI_INTERLACED (1 << 1)
1932 /* ITU-R start lines for each field */
1933 #define V4L2_VBI_ITU_525_F1_START (1)
1934 #define V4L2_VBI_ITU_525_F2_START (264)
1935 #define V4L2_VBI_ITU_625_F1_START (1)
1936 #define V4L2_VBI_ITU_625_F2_START (314)
1940 * This implements is a proposal V4L2 API to allow SLICED VBI
1941 * required for some hardware encoders. It should change without
1942 * notice in the definitive implementation.
1945 struct v4l2_sliced_vbi_format {
1947 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1948 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1949 (equals frame lines 313-336 for 625 line video
1950 standards, 263-286 for 525 line standards) */
1951 __u16 service_lines[2][24];
1953 __u32 reserved[2]; /* must be zero */
1956 /* Teletext World System Teletext
1957 (WST), defined on ITU-R BT.653-2 */
1958 #define V4L2_SLICED_TELETEXT_B (0x0001)
1959 /* Video Program System, defined on ETS 300 231*/
1960 #define V4L2_SLICED_VPS (0x0400)
1961 /* Closed Caption, defined on EIA-608 */
1962 #define V4L2_SLICED_CAPTION_525 (0x1000)
1963 /* Wide Screen System, defined on ITU-R BT1119.1 */
1964 #define V4L2_SLICED_WSS_625 (0x4000)
1966 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1967 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
1969 struct v4l2_sliced_vbi_cap {
1971 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1972 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1973 (equals frame lines 313-336 for 625 line video
1974 standards, 263-286 for 525 line standards) */
1975 __u16 service_lines[2][24];
1976 __u32 type; /* enum v4l2_buf_type */
1977 __u32 reserved[3]; /* must be 0 */
1980 struct v4l2_sliced_vbi_data {
1982 __u32 field; /* 0: first field, 1: second field */
1983 __u32 line; /* 1-23 */
1984 __u32 reserved; /* must be 0 */
1989 * Sliced VBI data inserted into MPEG Streams
1993 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1995 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1996 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1999 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
2000 * definitions are not included here. See the MPEG-2 specifications for details
2005 #define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
2006 #define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
2007 #define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
2008 #define V4L2_MPEG_VBI_IVTV_VPS (7)
2010 struct v4l2_mpeg_vbi_itv0_line {
2011 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
2012 __u8 data[42]; /* Sliced VBI data for the line */
2013 } __attribute__ ((packed));
2015 struct v4l2_mpeg_vbi_itv0 {
2016 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
2017 struct v4l2_mpeg_vbi_itv0_line line[35];
2018 } __attribute__ ((packed));
2020 struct v4l2_mpeg_vbi_ITV0 {
2021 struct v4l2_mpeg_vbi_itv0_line line[36];
2022 } __attribute__ ((packed));
2024 #define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
2025 #define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
2027 struct v4l2_mpeg_vbi_fmt_ivtv {
2030 struct v4l2_mpeg_vbi_itv0 itv0;
2031 struct v4l2_mpeg_vbi_ITV0 ITV0;
2033 } __attribute__ ((packed));
2036 * A G G R E G A T E S T R U C T U R E S
2040 * struct v4l2_plane_pix_format - additional, per-plane format definition
2041 * @sizeimage: maximum size in bytes required for data, for which
2042 * this plane will be used
2043 * @bytesperline: distance in bytes between the leftmost pixels in two
2046 struct v4l2_plane_pix_format {
2050 } __attribute__ ((packed));
2053 * struct v4l2_pix_format_mplane - multiplanar format definition
2054 * @width: image width in pixels
2055 * @height: image height in pixels
2056 * @pixelformat: little endian four character code (fourcc)
2057 * @field: enum v4l2_field; field order (for interlaced video)
2058 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
2059 * @plane_fmt: per-plane information
2060 * @num_planes: number of planes for this format
2061 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
2062 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
2063 * @quantization: enum v4l2_quantization, colorspace quantization
2064 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
2066 struct v4l2_pix_format_mplane {
2073 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
2083 } __attribute__ ((packed));
2086 * struct v4l2_sdr_format - SDR format definition
2087 * @pixelformat: little endian four character code (fourcc)
2088 * @buffersize: maximum size in bytes required for data
2090 struct v4l2_sdr_format {
2094 } __attribute__ ((packed));
2097 * struct v4l2_meta_format - metadata format definition
2098 * @dataformat: little endian four character code (fourcc)
2099 * @buffersize: maximum size in bytes required for data
2101 struct v4l2_meta_format {
2104 } __attribute__ ((packed));
2107 * struct v4l2_format - stream data format
2108 * @type: enum v4l2_buf_type; type of the data stream
2109 * @pix: definition of an image format
2110 * @pix_mp: definition of a multiplanar image format
2111 * @win: definition of an overlaid image
2112 * @vbi: raw VBI capture or output parameters
2113 * @sliced: sliced VBI capture or output parameters
2114 * @raw_data: placeholder for future extensions and custom formats
2116 struct v4l2_format {
2119 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2120 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2121 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2122 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
2123 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
2124 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
2125 struct v4l2_meta_format meta; /* V4L2_BUF_TYPE_META_CAPTURE */
2126 __u8 raw_data[200]; /* user-defined */
2130 /* Stream type-dependent parameters
2132 struct v4l2_streamparm {
2133 __u32 type; /* enum v4l2_buf_type */
2135 struct v4l2_captureparm capture;
2136 struct v4l2_outputparm output;
2137 __u8 raw_data[200]; /* user-defined */
2145 #define V4L2_EVENT_ALL 0
2146 #define V4L2_EVENT_VSYNC 1
2147 #define V4L2_EVENT_EOS 2
2148 #define V4L2_EVENT_CTRL 3
2149 #define V4L2_EVENT_FRAME_SYNC 4
2150 #define V4L2_EVENT_SOURCE_CHANGE 5
2151 #define V4L2_EVENT_MOTION_DET 6
2152 #define V4L2_EVENT_PRIVATE_START 0x08000000
2154 /* Payload for V4L2_EVENT_VSYNC */
2155 struct v4l2_event_vsync {
2156 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2158 } __attribute__ ((packed));
2160 /* Payload for V4L2_EVENT_CTRL */
2161 #define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
2162 #define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
2163 #define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
2165 struct v4l2_event_ctrl {
2176 __s32 default_value;
2179 struct v4l2_event_frame_sync {
2180 __u32 frame_sequence;
2183 #define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
2185 struct v4l2_event_src_change {
2189 #define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2192 * struct v4l2_event_motion_det - motion detection event
2193 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2194 * frame_sequence field is valid.
2195 * @frame_sequence: the frame sequence number associated with this event.
2196 * @region_mask: which regions detected motion.
2198 struct v4l2_event_motion_det {
2200 __u32 frame_sequence;
2207 struct v4l2_event_vsync vsync;
2208 struct v4l2_event_ctrl ctrl;
2209 struct v4l2_event_frame_sync frame_sync;
2210 struct v4l2_event_src_change src_change;
2211 struct v4l2_event_motion_det motion_det;
2216 struct timespec timestamp;
2221 #define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
2222 #define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
2224 struct v4l2_event_subscription {
2232 * A D V A N C E D D E B U G G I N G
2234 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2235 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2238 /* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2240 #define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
2241 #define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
2243 /* The following four defines are no longer in use */
2244 #define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2245 #define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
2246 #define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
2247 #define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
2249 struct v4l2_dbg_match {
2250 __u32 type; /* Match type */
2251 union { /* Match this chip, meaning determined by type */
2255 } __attribute__ ((packed));
2257 struct v4l2_dbg_register {
2258 struct v4l2_dbg_match match;
2259 __u32 size; /* register size in bytes */
2262 } __attribute__ ((packed));
2264 #define V4L2_CHIP_FL_READABLE (1 << 0)
2265 #define V4L2_CHIP_FL_WRITABLE (1 << 1)
2267 /* VIDIOC_DBG_G_CHIP_INFO */
2268 struct v4l2_dbg_chip_info {
2269 struct v4l2_dbg_match match;
2273 } __attribute__ ((packed));
2276 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2277 * @index: on return, index of the first created buffer
2278 * @count: entry: number of requested buffers,
2279 * return: number of created buffers
2280 * @memory: enum v4l2_memory; buffer memory type
2281 * @format: frame format, for which buffers are requested
2282 * @reserved: future extensions
2284 struct v4l2_create_buffers {
2288 struct v4l2_format format;
2293 * 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
2296 #define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
2297 #define VIDIOC_RESERVED _IO('V', 1)
2298 #define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
2299 #define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
2300 #define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
2301 #define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
2302 #define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
2303 #define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
2304 #define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
2305 #define VIDIOC_OVERLAY _IOW('V', 14, int)
2306 #define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
2307 #define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
2308 #define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
2309 #define VIDIOC_STREAMON _IOW('V', 18, int)
2310 #define VIDIOC_STREAMOFF _IOW('V', 19, int)
2311 #define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
2312 #define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
2313 #define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
2314 #define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
2315 #define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
2316 #define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2317 #define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2318 #define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2319 #define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2320 #define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2321 #define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2322 #define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2323 #define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2324 #define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2325 #define VIDIOC_G_INPUT _IOR('V', 38, int)
2326 #define VIDIOC_S_INPUT _IOWR('V', 39, int)
2327 #define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2328 #define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
2329 #define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2330 #define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2331 #define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2332 #define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2333 #define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2334 #define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2335 #define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2336 #define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2337 #define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2338 #define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2339 #define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2340 #define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2341 #define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2342 #define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2343 #define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2344 #define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2345 #define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2346 #define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2347 #define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
2348 #define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
2349 #define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2350 #define VIDIOC_LOG_STATUS _IO('V', 70)
2351 #define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2352 #define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2353 #define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
2354 #define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2355 #define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2356 #define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2357 #define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2358 #define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
2361 * Experimental, meant for debugging, testing and internal use.
2362 * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2363 * You must be root to use these ioctls. Never use these in applications!
2365 #define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2366 #define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2368 #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
2369 #define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2370 #define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2371 #define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2372 #define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2373 #define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2374 #define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2375 #define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
2376 #define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2377 #define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
2378 #define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2379 #define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
2380 #define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2381 #define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2382 #define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
2383 #define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2386 * Experimental, meant for debugging, testing and internal use.
2387 * Never use this in applications!
2389 #define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
2391 #define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2393 /* Reminder: when adding new ioctls please add support for them to
2394 drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
2396 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2398 #endif /* _UAPI__LINUX_VIDEODEV2_H */
projects / platform / upstream / gst-plugins-good.git / blob