blob: 09cf3a32faf41dd34bf5b4ef5ea79e5164fe1c2f [file] [log] [blame]
David Howells607ca462012-10-13 10:46:48 +01001/*
2 * Video for Linux Two header file
3 *
4 * Copyright (C) 1999-2012 the contributors
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * Alternatively you can redistribute this file under the terms of the
17 * BSD license as stated below:
18 *
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
21 * are met:
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in
26 * the documentation and/or other materials provided with the
27 * distribution.
28 * 3. The names of its contributors may not be used to endorse or promote
29 * products derived from this software without specific prior written
30 * permission.
31 *
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
38 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
39 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
40 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
41 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
42 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 *
44 * Header file for v4l or V4L2 drivers and applications
45 * with public API.
46 * All kernel-specific stuff were moved to media/v4l2-dev.h, so
47 * no #if __KERNEL tests are allowed here
48 *
Mauro Carvalho Chehab991ce922015-12-04 10:38:59 -020049 * See https://linuxtv.org for more info
David Howells607ca462012-10-13 10:46:48 +010050 *
51 * Author: Bill Dirks <bill@thedirks.org>
52 * Justin Schoeman
53 * Hans Verkuil <hverkuil@xs4all.nl>
54 * et al.
55 */
56#ifndef _UAPI__LINUX_VIDEODEV2_H
57#define _UAPI__LINUX_VIDEODEV2_H
58
59#ifndef __KERNEL__
60#include <sys/time.h>
61#endif
62#include <linux/compiler.h>
63#include <linux/ioctl.h>
64#include <linux/types.h>
65#include <linux/v4l2-common.h>
66#include <linux/v4l2-controls.h>
67
68/*
69 * Common stuff for both V4L1 and V4L2
70 * Moved from videodev.h
71 */
72#define VIDEO_MAX_FRAME 32
73#define VIDEO_MAX_PLANES 8
74
David Howells607ca462012-10-13 10:46:48 +010075/*
76 * M I S C E L L A N E O U S
77 */
78
79/* Four-character-code (FOURCC) */
80#define v4l2_fourcc(a, b, c, d)\
81 ((__u32)(a) | ((__u32)(b) << 8) | ((__u32)(c) << 16) | ((__u32)(d) << 24))
Laurent Pinchartfcc0d3d2014-07-21 17:06:33 -030082#define v4l2_fourcc_be(a, b, c, d) (v4l2_fourcc(a, b, c, d) | (1 << 31))
David Howells607ca462012-10-13 10:46:48 +010083
84/*
85 * E N U M S
86 */
87enum v4l2_field {
88 V4L2_FIELD_ANY = 0, /* driver can choose from none,
89 top, bottom, interlaced
90 depending on whatever it thinks
91 is approximate ... */
92 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
93 V4L2_FIELD_TOP = 2, /* top field only */
94 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
95 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
96 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
97 buffer, top-bottom order */
98 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
99 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
100 separate buffers */
101 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
102 first and the top field is
103 transmitted first */
104 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
105 first and the bottom field is
106 transmitted first */
107};
108#define V4L2_FIELD_HAS_TOP(field) \
109 ((field) == V4L2_FIELD_TOP ||\
110 (field) == V4L2_FIELD_INTERLACED ||\
111 (field) == V4L2_FIELD_INTERLACED_TB ||\
112 (field) == V4L2_FIELD_INTERLACED_BT ||\
113 (field) == V4L2_FIELD_SEQ_TB ||\
114 (field) == V4L2_FIELD_SEQ_BT)
115#define V4L2_FIELD_HAS_BOTTOM(field) \
116 ((field) == V4L2_FIELD_BOTTOM ||\
117 (field) == V4L2_FIELD_INTERLACED ||\
118 (field) == V4L2_FIELD_INTERLACED_TB ||\
119 (field) == V4L2_FIELD_INTERLACED_BT ||\
120 (field) == V4L2_FIELD_SEQ_TB ||\
121 (field) == V4L2_FIELD_SEQ_BT)
122#define V4L2_FIELD_HAS_BOTH(field) \
123 ((field) == V4L2_FIELD_INTERLACED ||\
124 (field) == V4L2_FIELD_INTERLACED_TB ||\
125 (field) == V4L2_FIELD_INTERLACED_BT ||\
126 (field) == V4L2_FIELD_SEQ_TB ||\
127 (field) == V4L2_FIELD_SEQ_BT)
Hans Verkuile34c4db2014-02-26 18:22:05 -0300128#define V4L2_FIELD_HAS_T_OR_B(field) \
129 ((field) == V4L2_FIELD_BOTTOM ||\
130 (field) == V4L2_FIELD_TOP ||\
131 (field) == V4L2_FIELD_ALTERNATE)
David Howells607ca462012-10-13 10:46:48 +0100132
133enum v4l2_buf_type {
134 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
135 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
136 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
137 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
138 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
139 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
140 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
David Howells607ca462012-10-13 10:46:48 +0100141 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
David Howells607ca462012-10-13 10:46:48 +0100142 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
143 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
Antti Palosaari6f3073b2013-12-12 13:34:30 -0300144 V4L2_BUF_TYPE_SDR_CAPTURE = 11,
Antti Palosaari9effc722015-10-10 13:51:00 -0300145 V4L2_BUF_TYPE_SDR_OUTPUT = 12,
Laurent Pinchartfb9ffa62016-04-12 19:40:46 -0300146 V4L2_BUF_TYPE_META_CAPTURE = 13,
David Howells607ca462012-10-13 10:46:48 +0100147 /* Deprecated, do not use */
148 V4L2_BUF_TYPE_PRIVATE = 0x80,
149};
150
151#define V4L2_TYPE_IS_MULTIPLANAR(type) \
152 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
153 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
154
155#define V4L2_TYPE_IS_OUTPUT(type) \
156 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
157 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
158 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
159 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
160 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
Antti Palosaari9effc722015-10-10 13:51:00 -0300161 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT \
162 || (type) == V4L2_BUF_TYPE_SDR_OUTPUT)
David Howells607ca462012-10-13 10:46:48 +0100163
164enum v4l2_tuner_type {
165 V4L2_TUNER_RADIO = 1,
166 V4L2_TUNER_ANALOG_TV = 2,
167 V4L2_TUNER_DIGITAL_TV = 3,
Antti Palosaarif3c3ece2015-10-10 13:50:57 -0300168 V4L2_TUNER_SDR = 4,
Antti Palosaari84099a22013-12-11 20:24:02 -0300169 V4L2_TUNER_RF = 5,
David Howells607ca462012-10-13 10:46:48 +0100170};
171
Antti Palosaarif3c3ece2015-10-10 13:50:57 -0300172/* Deprecated, do not use */
173#define V4L2_TUNER_ADC V4L2_TUNER_SDR
174
David Howells607ca462012-10-13 10:46:48 +0100175enum v4l2_memory {
176 V4L2_MEMORY_MMAP = 1,
177 V4L2_MEMORY_USERPTR = 2,
178 V4L2_MEMORY_OVERLAY = 3,
Sumit Semwal051c7782012-06-14 10:37:35 -0300179 V4L2_MEMORY_DMABUF = 4,
David Howells607ca462012-10-13 10:46:48 +0100180};
181
182/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
183enum v4l2_colorspace {
Hans Verkuile01dfc02015-05-15 09:29:05 -0300184 /*
185 * Default colorspace, i.e. let the driver figure it out.
186 * Can only be used with video capture.
187 */
188 V4L2_COLORSPACE_DEFAULT = 0,
189
Hans Verkuild5735d62014-11-17 09:06:42 -0300190 /* SMPTE 170M: used for broadcast NTSC/PAL SDTV */
David Howells607ca462012-10-13 10:46:48 +0100191 V4L2_COLORSPACE_SMPTE170M = 1,
192
Hans Verkuild5735d62014-11-17 09:06:42 -0300193 /* Obsolete pre-1998 SMPTE 240M HDTV standard, superseded by Rec 709 */
David Howells607ca462012-10-13 10:46:48 +0100194 V4L2_COLORSPACE_SMPTE240M = 2,
195
Hans Verkuild5735d62014-11-17 09:06:42 -0300196 /* Rec.709: used for HDTV */
David Howells607ca462012-10-13 10:46:48 +0100197 V4L2_COLORSPACE_REC709 = 3,
198
Hans Verkuild5735d62014-11-17 09:06:42 -0300199 /*
200 * Deprecated, do not use. No driver will ever return this. This was
201 * based on a misunderstanding of the bt878 datasheet.
202 */
David Howells607ca462012-10-13 10:46:48 +0100203 V4L2_COLORSPACE_BT878 = 4,
204
Hans Verkuild5735d62014-11-17 09:06:42 -0300205 /*
206 * NTSC 1953 colorspace. This only makes sense when dealing with
207 * really, really old NTSC recordings. Superseded by SMPTE 170M.
208 */
David Howells607ca462012-10-13 10:46:48 +0100209 V4L2_COLORSPACE_470_SYSTEM_M = 5,
Hans Verkuild5735d62014-11-17 09:06:42 -0300210
211 /*
212 * EBU Tech 3213 PAL/SECAM colorspace. This only makes sense when
213 * dealing with really old PAL/SECAM recordings. Superseded by
214 * SMPTE 170M.
215 */
David Howells607ca462012-10-13 10:46:48 +0100216 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
217
Hans Verkuild5735d62014-11-17 09:06:42 -0300218 /*
219 * Effectively shorthand for V4L2_COLORSPACE_SRGB, V4L2_YCBCR_ENC_601
220 * and V4L2_QUANTIZATION_FULL_RANGE. To be used for (Motion-)JPEG.
David Howells607ca462012-10-13 10:46:48 +0100221 */
222 V4L2_COLORSPACE_JPEG = 7,
223
Hans Verkuild5735d62014-11-17 09:06:42 -0300224 /* For RGB colorspaces such as produces by most webcams. */
David Howells607ca462012-10-13 10:46:48 +0100225 V4L2_COLORSPACE_SRGB = 8,
Hans Verkuild5735d62014-11-17 09:06:42 -0300226
227 /* AdobeRGB colorspace */
228 V4L2_COLORSPACE_ADOBERGB = 9,
229
230 /* BT.2020 colorspace, used for UHDTV. */
231 V4L2_COLORSPACE_BT2020 = 10,
Hans Verkuiladdad102015-05-15 09:29:07 -0300232
233 /* Raw colorspace: for RAW unprocessed images */
234 V4L2_COLORSPACE_RAW = 11,
Hans Verkuil529a79602015-09-13 13:41:29 -0300235
236 /* DCI-P3 colorspace, used by cinema projectors */
237 V4L2_COLORSPACE_DCI_P3 = 12,
Hans Verkuild5735d62014-11-17 09:06:42 -0300238};
239
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300240/*
241 * Determine how COLORSPACE_DEFAULT should map to a proper colorspace.
242 * This depends on whether this is a SDTV image (use SMPTE 170M), an
243 * HDTV image (use Rec. 709), or something else (use sRGB).
244 */
245#define V4L2_MAP_COLORSPACE_DEFAULT(is_sdtv, is_hdtv) \
246 ((is_sdtv) ? V4L2_COLORSPACE_SMPTE170M : \
247 ((is_hdtv) ? V4L2_COLORSPACE_REC709 : V4L2_COLORSPACE_SRGB))
248
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300249enum v4l2_xfer_func {
250 /*
251 * Mapping of V4L2_XFER_FUNC_DEFAULT to actual transfer functions
252 * for the various colorspaces:
253 *
254 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
255 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_REC709 and
256 * V4L2_COLORSPACE_BT2020: V4L2_XFER_FUNC_709
257 *
258 * V4L2_COLORSPACE_SRGB, V4L2_COLORSPACE_JPEG: V4L2_XFER_FUNC_SRGB
259 *
260 * V4L2_COLORSPACE_ADOBERGB: V4L2_XFER_FUNC_ADOBERGB
261 *
262 * V4L2_COLORSPACE_SMPTE240M: V4L2_XFER_FUNC_SMPTE240M
263 *
264 * V4L2_COLORSPACE_RAW: V4L2_XFER_FUNC_NONE
Hans Verkuil529a79602015-09-13 13:41:29 -0300265 *
266 * V4L2_COLORSPACE_DCI_P3: V4L2_XFER_FUNC_DCI_P3
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300267 */
268 V4L2_XFER_FUNC_DEFAULT = 0,
269 V4L2_XFER_FUNC_709 = 1,
270 V4L2_XFER_FUNC_SRGB = 2,
271 V4L2_XFER_FUNC_ADOBERGB = 3,
272 V4L2_XFER_FUNC_SMPTE240M = 4,
273 V4L2_XFER_FUNC_NONE = 5,
Hans Verkuil529a79602015-09-13 13:41:29 -0300274 V4L2_XFER_FUNC_DCI_P3 = 6,
Hans Verkuil2bdd2802015-09-13 16:15:18 -0300275 V4L2_XFER_FUNC_SMPTE2084 = 7,
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300276};
277
278/*
279 * Determine how XFER_FUNC_DEFAULT should map to a proper transfer function.
280 * This depends on the colorspace.
281 */
282#define V4L2_MAP_XFER_FUNC_DEFAULT(colsp) \
Hans Verkuilf8d55562015-06-15 10:52:40 -0300283 ((colsp) == V4L2_COLORSPACE_ADOBERGB ? V4L2_XFER_FUNC_ADOBERGB : \
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300284 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_XFER_FUNC_SMPTE240M : \
Hans Verkuil529a79602015-09-13 13:41:29 -0300285 ((colsp) == V4L2_COLORSPACE_DCI_P3 ? V4L2_XFER_FUNC_DCI_P3 : \
286 ((colsp) == V4L2_COLORSPACE_RAW ? V4L2_XFER_FUNC_NONE : \
287 ((colsp) == V4L2_COLORSPACE_SRGB || (colsp) == V4L2_COLORSPACE_JPEG ? \
288 V4L2_XFER_FUNC_SRGB : V4L2_XFER_FUNC_709)))))
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300289
Hans Verkuild5735d62014-11-17 09:06:42 -0300290enum v4l2_ycbcr_encoding {
291 /*
292 * Mapping of V4L2_YCBCR_ENC_DEFAULT to actual encodings for the
293 * various colorspaces:
294 *
295 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
Hans Verkuiladca8c82016-08-04 06:01:48 -0300296 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_SRGB,
297 * V4L2_COLORSPACE_ADOBERGB and V4L2_COLORSPACE_JPEG: V4L2_YCBCR_ENC_601
Hans Verkuild5735d62014-11-17 09:06:42 -0300298 *
Hans Verkuil529a79602015-09-13 13:41:29 -0300299 * V4L2_COLORSPACE_REC709 and V4L2_COLORSPACE_DCI_P3: V4L2_YCBCR_ENC_709
Hans Verkuild5735d62014-11-17 09:06:42 -0300300 *
Hans Verkuild5735d62014-11-17 09:06:42 -0300301 * V4L2_COLORSPACE_BT2020: V4L2_YCBCR_ENC_BT2020
302 *
303 * V4L2_COLORSPACE_SMPTE240M: V4L2_YCBCR_ENC_SMPTE240M
304 */
305 V4L2_YCBCR_ENC_DEFAULT = 0,
306
307 /* ITU-R 601 -- SDTV */
308 V4L2_YCBCR_ENC_601 = 1,
309
310 /* Rec. 709 -- HDTV */
311 V4L2_YCBCR_ENC_709 = 2,
312
313 /* ITU-R 601/EN 61966-2-4 Extended Gamut -- SDTV */
314 V4L2_YCBCR_ENC_XV601 = 3,
315
316 /* Rec. 709/EN 61966-2-4 Extended Gamut -- HDTV */
317 V4L2_YCBCR_ENC_XV709 = 4,
318
Hans Verkuiladca8c82016-08-04 06:01:48 -0300319#ifndef __KERNEL__
320 /*
321 * sYCC (Y'CbCr encoding of sRGB), identical to ENC_601. It was added
322 * originally due to a misunderstanding of the sYCC standard. It should
323 * not be used, instead use V4L2_YCBCR_ENC_601.
324 */
Hans Verkuild5735d62014-11-17 09:06:42 -0300325 V4L2_YCBCR_ENC_SYCC = 5,
Hans Verkuiladca8c82016-08-04 06:01:48 -0300326#endif
Hans Verkuild5735d62014-11-17 09:06:42 -0300327
328 /* BT.2020 Non-constant Luminance Y'CbCr */
329 V4L2_YCBCR_ENC_BT2020 = 6,
330
331 /* BT.2020 Constant Luminance Y'CbcCrc */
332 V4L2_YCBCR_ENC_BT2020_CONST_LUM = 7,
333
334 /* SMPTE 240M -- Obsolete HDTV */
335 V4L2_YCBCR_ENC_SMPTE240M = 8,
336};
337
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300338/*
Ricardo Ribalda Delgado8a0d62a2016-08-22 06:28:07 -0300339 * enum v4l2_hsv_encoding values should not collide with the ones from
340 * enum v4l2_ycbcr_encoding.
341 */
342enum v4l2_hsv_encoding {
343
344 /* Hue mapped to 0 - 179 */
345 V4L2_HSV_ENC_180 = 128,
346
347 /* Hue mapped to 0-255 */
348 V4L2_HSV_ENC_256 = 129,
349};
350
351/*
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300352 * Determine how YCBCR_ENC_DEFAULT should map to a proper Y'CbCr encoding.
353 * This depends on the colorspace.
354 */
355#define V4L2_MAP_YCBCR_ENC_DEFAULT(colsp) \
Hans Verkuil529a79602015-09-13 13:41:29 -0300356 (((colsp) == V4L2_COLORSPACE_REC709 || \
357 (colsp) == V4L2_COLORSPACE_DCI_P3) ? V4L2_YCBCR_ENC_709 : \
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300358 ((colsp) == V4L2_COLORSPACE_BT2020 ? V4L2_YCBCR_ENC_BT2020 : \
359 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_YCBCR_ENC_SMPTE240M : \
360 V4L2_YCBCR_ENC_601)))
361
Hans Verkuild5735d62014-11-17 09:06:42 -0300362enum v4l2_quantization {
363 /*
Hans Verkuilaa05b972015-03-08 04:53:32 -0300364 * The default for R'G'B' quantization is always full range, except
365 * for the BT2020 colorspace. For Y'CbCr the quantization is always
Hans Verkuil86c7eb42017-04-10 04:51:44 -0300366 * limited range, except for COLORSPACE_JPEG: this is full range.
Hans Verkuild5735d62014-11-17 09:06:42 -0300367 */
368 V4L2_QUANTIZATION_DEFAULT = 0,
369 V4L2_QUANTIZATION_FULL_RANGE = 1,
370 V4L2_QUANTIZATION_LIM_RANGE = 2,
David Howells607ca462012-10-13 10:46:48 +0100371};
372
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300373/*
374 * Determine how QUANTIZATION_DEFAULT should map to a proper quantization.
375 * This depends on whether the image is RGB or not, the colorspace and the
376 * Y'CbCr encoding.
377 */
Ricardo Ribalda Delgado8a0d62a2016-08-22 06:28:07 -0300378#define V4L2_MAP_QUANTIZATION_DEFAULT(is_rgb_or_hsv, colsp, ycbcr_enc) \
379 (((is_rgb_or_hsv) && (colsp) == V4L2_COLORSPACE_BT2020) ? \
380 V4L2_QUANTIZATION_LIM_RANGE : \
Hans Verkuil79e92dc2017-03-01 12:31:20 -0300381 (((is_rgb_or_hsv) || (colsp) == V4L2_COLORSPACE_JPEG) ? \
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300382 V4L2_QUANTIZATION_FULL_RANGE : V4L2_QUANTIZATION_LIM_RANGE))
383
David Howells607ca462012-10-13 10:46:48 +0100384enum v4l2_priority {
385 V4L2_PRIORITY_UNSET = 0, /* not initialized */
386 V4L2_PRIORITY_BACKGROUND = 1,
387 V4L2_PRIORITY_INTERACTIVE = 2,
388 V4L2_PRIORITY_RECORD = 3,
389 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
390};
391
392struct v4l2_rect {
393 __s32 left;
394 __s32 top;
Ricardo Ribaldaf90580c2013-11-26 05:31:42 -0300395 __u32 width;
396 __u32 height;
David Howells607ca462012-10-13 10:46:48 +0100397};
398
399struct v4l2_fract {
400 __u32 numerator;
401 __u32 denominator;
402};
403
404/**
405 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
406 *
407 * @driver: name of the driver module (e.g. "bttv")
408 * @card: name of the card (e.g. "Hauppauge WinTV")
409 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
410 * @version: KERNEL_VERSION
411 * @capabilities: capabilities of the physical device as a whole
412 * @device_caps: capabilities accessed via this particular device (node)
413 * @reserved: reserved fields for future extensions
414 */
415struct v4l2_capability {
416 __u8 driver[16];
417 __u8 card[32];
418 __u8 bus_info[32];
419 __u32 version;
420 __u32 capabilities;
421 __u32 device_caps;
422 __u32 reserved[3];
423};
424
425/* Values for 'capabilities' field */
426#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
427#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
428#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
429#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
430#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
431#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
432#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
433#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
434#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
435#define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
436#define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
437
438/* Is a video capture device that supports multiplanar formats */
439#define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
440/* Is a video output device that supports multiplanar formats */
441#define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
442/* Is a video mem-to-mem device that supports multiplanar formats */
443#define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
444/* Is a video mem-to-mem device */
445#define V4L2_CAP_VIDEO_M2M 0x00008000
446
447#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
448#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
449#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
450#define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
451
Antti Palosaaric9c54f72013-12-17 17:41:12 -0300452#define V4L2_CAP_SDR_CAPTURE 0x00100000 /* Is a SDR capture device */
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300453#define V4L2_CAP_EXT_PIX_FORMAT 0x00200000 /* Supports the extended pixel format */
Antti Palosaari9effc722015-10-10 13:51:00 -0300454#define V4L2_CAP_SDR_OUTPUT 0x00400000 /* Is a SDR output device */
Laurent Pinchartfb9ffa62016-04-12 19:40:46 -0300455#define V4L2_CAP_META_CAPTURE 0x00800000 /* Is a metadata capture device */
Antti Palosaaric9c54f72013-12-17 17:41:12 -0300456
David Howells607ca462012-10-13 10:46:48 +0100457#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
458#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
459#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
460
Nick Dyerb2fe22d2016-07-18 18:10:30 -0300461#define V4L2_CAP_TOUCH 0x10000000 /* Is a touch device */
462
David Howells607ca462012-10-13 10:46:48 +0100463#define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
464
465/*
466 * V I D E O I M A G E F O R M A T
467 */
468struct v4l2_pix_format {
469 __u32 width;
470 __u32 height;
471 __u32 pixelformat;
472 __u32 field; /* enum v4l2_field */
473 __u32 bytesperline; /* for padding, zero if unused */
474 __u32 sizeimage;
475 __u32 colorspace; /* enum v4l2_colorspace */
476 __u32 priv; /* private data, depends on pixelformat */
Laurent Pinchartc96fd462014-05-27 10:12:43 -0300477 __u32 flags; /* format flags (V4L2_PIX_FMT_FLAG_*) */
Ricardo Ribalda Delgado8a0d62a2016-08-22 06:28:07 -0300478 union {
479 /* enum v4l2_ycbcr_encoding */
480 __u32 ycbcr_enc;
481 /* enum v4l2_hsv_encoding */
482 __u32 hsv_enc;
483 };
Hans Verkuild5735d62014-11-17 09:06:42 -0300484 __u32 quantization; /* enum v4l2_quantization */
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300485 __u32 xfer_func; /* enum v4l2_xfer_func */
David Howells607ca462012-10-13 10:46:48 +0100486};
487
488/* Pixel format FOURCC depth Description */
489
490/* RGB formats */
491#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
492#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300493#define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16 aaaarrrr ggggbbbb */
494#define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16 xxxxrrrr ggggbbbb */
David Howells607ca462012-10-13 10:46:48 +0100495#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300496#define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16 ARGB-1-5-5-5 */
497#define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16 XRGB-1-5-5-5 */
David Howells607ca462012-10-13 10:46:48 +0100498#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
499#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
Laurent Pinchartfcc0d3d2014-07-21 17:06:33 -0300500#define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16 ARGB-5-5-5 BE */
501#define V4L2_PIX_FMT_XRGB555X v4l2_fourcc_be('X', 'R', '1', '5') /* 16 XRGB-5-5-5 BE */
David Howells607ca462012-10-13 10:46:48 +0100502#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
503#define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
504#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
505#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
506#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300507#define V4L2_PIX_FMT_ABGR32 v4l2_fourcc('A', 'R', '2', '4') /* 32 BGRA-8-8-8-8 */
508#define V4L2_PIX_FMT_XBGR32 v4l2_fourcc('X', 'R', '2', '4') /* 32 BGRX-8-8-8-8 */
David Howells607ca462012-10-13 10:46:48 +0100509#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300510#define V4L2_PIX_FMT_ARGB32 v4l2_fourcc('B', 'A', '2', '4') /* 32 ARGB-8-8-8-8 */
511#define V4L2_PIX_FMT_XRGB32 v4l2_fourcc('B', 'X', '2', '4') /* 32 XRGB-8-8-8-8 */
David Howells607ca462012-10-13 10:46:48 +0100512
513/* Grey formats */
514#define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
515#define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
516#define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
517#define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
518#define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
519#define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
Ricardo Ribalda2e5e4352015-05-04 05:07:30 -0300520#define V4L2_PIX_FMT_Y16_BE v4l2_fourcc_be('Y', '1', '6', ' ') /* 16 Greyscale BE */
David Howells607ca462012-10-13 10:46:48 +0100521
522/* Grey bit-packed formats */
523#define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
524
525/* Palette formats */
526#define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
527
Manjunath Hadli05ad6fc2012-10-18 07:58:02 -0300528/* Chrominance formats */
529#define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
530
David Howells607ca462012-10-13 10:46:48 +0100531/* Luminance+Chrominance formats */
David Howells607ca462012-10-13 10:46:48 +0100532#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
533#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
534#define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
535#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
536#define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
David Howells607ca462012-10-13 10:46:48 +0100537#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
538#define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
539#define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
540#define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
541#define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
David Howells607ca462012-10-13 10:46:48 +0100542#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
543#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
544#define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
545
546/* two planes -- one Y, one Cr + Cb interleaved */
547#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
548#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
549#define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
550#define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
551#define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
552#define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
553
554/* two non contiguous planes - one Y, one Cr + Cb interleaved */
555#define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
556#define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
Laurent Pinchart84930542013-06-26 09:46:42 -0300557#define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
558#define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
David Howells607ca462012-10-13 10:46:48 +0100559#define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
560#define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 macroblocks */
561
Laurent Pinchart79c8d082016-06-15 20:27:58 -0300562/* three planes - Y Cb, Cr */
563#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
564#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
Laurent Pinchartab46f6d2016-06-15 20:35:36 -0300565#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 12 YVU411 planar */
Laurent Pinchart79c8d082016-06-15 20:27:58 -0300566#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
567#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
568#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
569
David Howells607ca462012-10-13 10:46:48 +0100570/* three non contiguous planes - Y, Cb, Cr */
571#define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
572#define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
Laurent Pinchartd65fae92015-11-11 22:02:00 -0200573#define V4L2_PIX_FMT_YUV422M v4l2_fourcc('Y', 'M', '1', '6') /* 16 YUV422 planar */
574#define V4L2_PIX_FMT_YVU422M v4l2_fourcc('Y', 'M', '6', '1') /* 16 YVU422 planar */
575#define V4L2_PIX_FMT_YUV444M v4l2_fourcc('Y', 'M', '2', '4') /* 24 YUV444 planar */
576#define V4L2_PIX_FMT_YVU444M v4l2_fourcc('Y', 'M', '4', '2') /* 24 YVU444 planar */
David Howells607ca462012-10-13 10:46:48 +0100577
578/* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
579#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
580#define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
581#define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
582#define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
583#define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
584#define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
585#define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
586#define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
Aviv Greenberg4353e362014-12-03 08:14:09 -0300587 /* 10bit raw bayer packed, 5 bytes for every 4 pixels */
588#define V4L2_PIX_FMT_SBGGR10P v4l2_fourcc('p', 'B', 'A', 'A')
589#define V4L2_PIX_FMT_SGBRG10P v4l2_fourcc('p', 'G', 'A', 'A')
590#define V4L2_PIX_FMT_SGRBG10P v4l2_fourcc('p', 'g', 'A', 'A')
591#define V4L2_PIX_FMT_SRGGB10P v4l2_fourcc('p', 'R', 'A', 'A')
Manjunath Hadli05ad6fc2012-10-18 07:58:02 -0300592 /* 10bit raw bayer a-law compressed to 8 bits */
593#define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
594#define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
595#define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
596#define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
David Howells607ca462012-10-13 10:46:48 +0100597 /* 10bit raw bayer DPCM compressed to 8 bits */
598#define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
599#define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
600#define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
601#define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
Sakari Ailuscbb77bc2014-12-07 20:17:49 -0300602#define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
603#define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
604#define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
605#define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
David Howells607ca462012-10-13 10:46:48 +0100606#define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
Sakari Ailusb9a4b132016-06-27 10:46:16 -0300607#define V4L2_PIX_FMT_SGBRG16 v4l2_fourcc('G', 'B', '1', '6') /* 16 GBGB.. RGRG.. */
608#define V4L2_PIX_FMT_SGRBG16 v4l2_fourcc('G', 'R', '1', '6') /* 16 GRGR.. BGBG.. */
609#define V4L2_PIX_FMT_SRGGB16 v4l2_fourcc('R', 'G', '1', '6') /* 16 RGRG.. GBGB.. */
David Howells607ca462012-10-13 10:46:48 +0100610
Ricardo Ribalda Delgado66b2ab22016-08-18 11:33:27 -0300611/* HSV formats */
612#define V4L2_PIX_FMT_HSV24 v4l2_fourcc('H', 'S', 'V', '3')
613#define V4L2_PIX_FMT_HSV32 v4l2_fourcc('H', 'S', 'V', '4')
614
David Howells607ca462012-10-13 10:46:48 +0100615/* compressed formats */
616#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
617#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
618#define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
619#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
620#define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
621#define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
622#define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
623#define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
624#define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
625#define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
Ismael Lucenoadf62712013-04-18 08:16:08 -0300626#define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
David Howells607ca462012-10-13 10:46:48 +0100627#define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
628#define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
629#define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
630#define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
Wu-Cheng Lia8b4a1e2016-09-02 09:19:57 -0300631#define V4L2_PIX_FMT_VP9 v4l2_fourcc('V', 'P', '9', '0') /* VP9 */
David Howells607ca462012-10-13 10:46:48 +0100632
633/* Vendor-specific formats */
634#define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
635#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
636#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
637#define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
638#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
639#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
640#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
641#define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
642#define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
643#define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
644#define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
645#define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
646#define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
647#define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
648#define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
649#define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
650#define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
651#define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
652#define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
653#define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
654#define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
655#define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
656#define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
657#define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
658#define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
659#define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
Aviv Greenberg5d8d8db2016-02-03 15:08:52 -0200660#define V4L2_PIX_FMT_Y8I v4l2_fourcc('Y', '8', 'I', ' ') /* Greyscale 8-bit L/R interleaved */
661#define V4L2_PIX_FMT_Y12I v4l2_fourcc('Y', '1', '2', 'I') /* Greyscale 12-bit L/R interleaved */
662#define V4L2_PIX_FMT_Z16 v4l2_fourcc('Z', '1', '6', ' ') /* Depth data 16-bit */
Tiffany Lind4de6632016-09-09 12:48:04 -0300663#define V4L2_PIX_FMT_MT21C v4l2_fourcc('M', 'T', '2', '1') /* Mediatek compressed block mode */
Evgeni Raikhel5df082e2017-03-02 20:43:19 -0300664#define V4L2_PIX_FMT_INZI v4l2_fourcc('I', 'N', 'Z', 'I') /* Intel Planar Greyscale 10-bit and Depth 16-bit */
David Howells607ca462012-10-13 10:46:48 +0100665
Antti Palosaari00419a62014-02-04 23:55:25 -0300666/* SDR formats - used only for Software Defined Radio devices */
667#define V4L2_SDR_FMT_CU8 v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
668#define V4L2_SDR_FMT_CU16LE v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
Antti Palosaaric0c03882014-07-11 13:25:14 -0300669#define V4L2_SDR_FMT_CS8 v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
Antti Palosaari5c5be572014-07-11 16:35:47 -0300670#define V4L2_SDR_FMT_CS14LE v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
Antti Palosaari9e9e3922014-06-27 17:42:18 -0300671#define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
Antti Palosaari00419a62014-02-04 23:55:25 -0300672
Nick Dyerb2fe22d2016-07-18 18:10:30 -0300673/* Touch formats - used for Touch devices */
674#define V4L2_TCH_FMT_DELTA_TD16 v4l2_fourcc('T', 'D', '1', '6') /* 16-bit signed deltas */
675#define V4L2_TCH_FMT_DELTA_TD08 v4l2_fourcc('T', 'D', '0', '8') /* 8-bit signed deltas */
676#define V4L2_TCH_FMT_TU16 v4l2_fourcc('T', 'U', '1', '6') /* 16-bit unsigned touch data */
677#define V4L2_TCH_FMT_TU08 v4l2_fourcc('T', 'U', '0', '8') /* 8-bit unsigned touch data */
678
Laurent Pinchart14d66532016-04-10 04:37:48 -0300679/* Meta-data formats */
680#define V4L2_META_FMT_VSP1_HGO v4l2_fourcc('V', 'S', 'P', 'H') /* R-Car VSP1 Histogram */
681
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300682/* priv field value to indicates that subsequent fields are valid. */
683#define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
684
Laurent Pinchartc96fd462014-05-27 10:12:43 -0300685/* Flags */
686#define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
687
David Howells607ca462012-10-13 10:46:48 +0100688/*
689 * F O R M A T E N U M E R A T I O N
690 */
691struct v4l2_fmtdesc {
692 __u32 index; /* Format number */
693 __u32 type; /* enum v4l2_buf_type */
694 __u32 flags;
695 __u8 description[32]; /* Description string */
696 __u32 pixelformat; /* Format fourcc */
697 __u32 reserved[4];
698};
699
700#define V4L2_FMT_FLAG_COMPRESSED 0x0001
701#define V4L2_FMT_FLAG_EMULATED 0x0002
702
Hans Verkuil57c759872016-04-22 06:06:58 -0300703 /* Frame Size and frame rate enumeration */
David Howells607ca462012-10-13 10:46:48 +0100704/*
705 * F R A M E S I Z E E N U M E R A T I O N
706 */
707enum v4l2_frmsizetypes {
708 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
709 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
710 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
711};
712
713struct v4l2_frmsize_discrete {
714 __u32 width; /* Frame width [pixel] */
715 __u32 height; /* Frame height [pixel] */
716};
717
718struct v4l2_frmsize_stepwise {
719 __u32 min_width; /* Minimum frame width [pixel] */
720 __u32 max_width; /* Maximum frame width [pixel] */
721 __u32 step_width; /* Frame width step size [pixel] */
722 __u32 min_height; /* Minimum frame height [pixel] */
723 __u32 max_height; /* Maximum frame height [pixel] */
724 __u32 step_height; /* Frame height step size [pixel] */
725};
726
727struct v4l2_frmsizeenum {
728 __u32 index; /* Frame size number */
729 __u32 pixel_format; /* Pixel format */
730 __u32 type; /* Frame size type the device supports. */
731
732 union { /* Frame size */
733 struct v4l2_frmsize_discrete discrete;
734 struct v4l2_frmsize_stepwise stepwise;
735 };
736
737 __u32 reserved[2]; /* Reserved space for future use */
738};
739
740/*
741 * F R A M E R A T E E N U M E R A T I O N
742 */
743enum v4l2_frmivaltypes {
744 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
745 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
746 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
747};
748
749struct v4l2_frmival_stepwise {
750 struct v4l2_fract min; /* Minimum frame interval [s] */
751 struct v4l2_fract max; /* Maximum frame interval [s] */
752 struct v4l2_fract step; /* Frame interval step size [s] */
753};
754
755struct v4l2_frmivalenum {
756 __u32 index; /* Frame format index */
757 __u32 pixel_format; /* Pixel format */
758 __u32 width; /* Frame width */
759 __u32 height; /* Frame height */
760 __u32 type; /* Frame interval type the device supports. */
761
762 union { /* Frame interval */
763 struct v4l2_fract discrete;
764 struct v4l2_frmival_stepwise stepwise;
765 };
766
767 __u32 reserved[2]; /* Reserved space for future use */
768};
David Howells607ca462012-10-13 10:46:48 +0100769
770/*
771 * T I M E C O D E
772 */
773struct v4l2_timecode {
774 __u32 type;
775 __u32 flags;
776 __u8 frames;
777 __u8 seconds;
778 __u8 minutes;
779 __u8 hours;
780 __u8 userbits[4];
781};
782
783/* Type */
784#define V4L2_TC_TYPE_24FPS 1
785#define V4L2_TC_TYPE_25FPS 2
786#define V4L2_TC_TYPE_30FPS 3
787#define V4L2_TC_TYPE_50FPS 4
788#define V4L2_TC_TYPE_60FPS 5
789
790/* Flags */
791#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
792#define V4L2_TC_FLAG_COLORFRAME 0x0002
793#define V4L2_TC_USERBITS_field 0x000C
794#define V4L2_TC_USERBITS_USERDEFINED 0x0000
795#define V4L2_TC_USERBITS_8BITCHARS 0x0008
796/* The above is based on SMPTE timecodes */
797
798struct v4l2_jpegcompression {
799 int quality;
800
801 int APPn; /* Number of APP segment to be written,
802 * must be 0..15 */
803 int APP_len; /* Length of data in JPEG APPn segment */
804 char APP_data[60]; /* Data in the JPEG APPn segment. */
805
806 int COM_len; /* Length of data in JPEG COM segment */
807 char COM_data[60]; /* Data in JPEG COM segment */
808
809 __u32 jpeg_markers; /* Which markers should go into the JPEG
810 * output. Unless you exactly know what
811 * you do, leave them untouched.
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300812 * Including less markers will make the
David Howells607ca462012-10-13 10:46:48 +0100813 * resulting code smaller, but there will
814 * be fewer applications which can read it.
815 * The presence of the APP and COM marker
816 * is influenced by APP_len and COM_len
817 * ONLY, not by this property! */
818
819#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
820#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
821#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
822#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
823#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300824 * always use APP0 */
David Howells607ca462012-10-13 10:46:48 +0100825};
826
827/*
828 * M E M O R Y - M A P P I N G B U F F E R S
829 */
830struct v4l2_requestbuffers {
831 __u32 count;
832 __u32 type; /* enum v4l2_buf_type */
833 __u32 memory; /* enum v4l2_memory */
834 __u32 reserved[2];
835};
836
837/**
838 * struct v4l2_plane - plane info for multi-planar buffers
839 * @bytesused: number of bytes occupied by data in the plane (payload)
840 * @length: size of this plane (NOT the payload) in bytes
841 * @mem_offset: when memory in the associated struct v4l2_buffer is
842 * V4L2_MEMORY_MMAP, equals the offset from the start of
843 * the device memory for this plane (or is a "cookie" that
844 * should be passed to mmap() called on the video node)
845 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
846 * pointing to this plane
Sumit Semwal051c7782012-06-14 10:37:35 -0300847 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
848 * descriptor associated with this plane
David Howells607ca462012-10-13 10:46:48 +0100849 * @data_offset: offset in the plane to the start of data; usually 0,
850 * unless there is a header in front of the data
851 *
852 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
853 * with two planes can have one plane for Y, and another for interleaved CbCr
854 * components. Each plane can reside in a separate memory buffer, or even in
855 * a completely separate memory node (e.g. in embedded devices).
856 */
857struct v4l2_plane {
858 __u32 bytesused;
859 __u32 length;
860 union {
861 __u32 mem_offset;
862 unsigned long userptr;
Sumit Semwal051c7782012-06-14 10:37:35 -0300863 __s32 fd;
David Howells607ca462012-10-13 10:46:48 +0100864 } m;
865 __u32 data_offset;
866 __u32 reserved[11];
867};
868
869/**
870 * struct v4l2_buffer - video buffer info
871 * @index: id number of the buffer
872 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
873 * multiplanar buffers);
874 * @bytesused: number of bytes occupied by data in the buffer (payload);
875 * unused (set to 0) for multiplanar buffers
876 * @flags: buffer informational flags
877 * @field: enum v4l2_field; field order of the image in the buffer
878 * @timestamp: frame timestamp
879 * @timecode: frame timecode
880 * @sequence: sequence count of this frame
881 * @memory: enum v4l2_memory; the method, in which the actual video data is
882 * passed
883 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
884 * offset from the start of the device memory for this plane,
885 * (or a "cookie" that should be passed to mmap() as offset)
886 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
887 * a userspace pointer pointing to this buffer
Sumit Semwal051c7782012-06-14 10:37:35 -0300888 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
889 * a userspace file descriptor associated with this buffer
David Howells607ca462012-10-13 10:46:48 +0100890 * @planes: for multiplanar buffers; userspace pointer to the array of plane
891 * info structs for this buffer
892 * @length: size in bytes of the buffer (NOT its payload) for single-plane
893 * buffers (when type != *_MPLANE); number of elements in the
894 * planes array for multi-plane buffers
David Howells607ca462012-10-13 10:46:48 +0100895 *
896 * Contains data exchanged by application and driver using one of the Streaming
897 * I/O methods.
898 */
899struct v4l2_buffer {
900 __u32 index;
901 __u32 type;
902 __u32 bytesused;
903 __u32 flags;
904 __u32 field;
905 struct timeval timestamp;
906 struct v4l2_timecode timecode;
907 __u32 sequence;
908
909 /* memory location */
910 __u32 memory;
911 union {
912 __u32 offset;
913 unsigned long userptr;
914 struct v4l2_plane *planes;
Sumit Semwal051c7782012-06-14 10:37:35 -0300915 __s32 fd;
David Howells607ca462012-10-13 10:46:48 +0100916 } m;
917 __u32 length;
918 __u32 reserved2;
919 __u32 reserved;
920};
921
922/* Flags for 'flags' field */
Sakari Ailus939f1372013-08-25 14:00:43 -0300923/* Buffer is mapped (flag) */
924#define V4L2_BUF_FLAG_MAPPED 0x00000001
925/* Buffer is queued for processing */
926#define V4L2_BUF_FLAG_QUEUED 0x00000002
927/* Buffer is ready */
928#define V4L2_BUF_FLAG_DONE 0x00000004
929/* Image is a keyframe (I-frame) */
930#define V4L2_BUF_FLAG_KEYFRAME 0x00000008
931/* Image is a P-frame */
932#define V4L2_BUF_FLAG_PFRAME 0x00000010
933/* Image is a B-frame */
934#define V4L2_BUF_FLAG_BFRAME 0x00000020
David Howells607ca462012-10-13 10:46:48 +0100935/* Buffer is ready, but the data contained within is corrupted. */
Sakari Ailus939f1372013-08-25 14:00:43 -0300936#define V4L2_BUF_FLAG_ERROR 0x00000040
937/* timecode field is valid */
938#define V4L2_BUF_FLAG_TIMECODE 0x00000100
939/* Buffer is prepared for queuing */
940#define V4L2_BUF_FLAG_PREPARED 0x00000400
David Howells607ca462012-10-13 10:46:48 +0100941/* Cache handling flags */
Sakari Ailus939f1372013-08-25 14:00:43 -0300942#define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
943#define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
Sakari Ailus1202ecd2012-10-21 16:02:47 -0300944/* Timestamp type */
Sakari Ailus939f1372013-08-25 14:00:43 -0300945#define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
946#define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
947#define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
948#define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
Sakari Ailus872484c2013-08-25 17:57:03 -0300949/* Timestamp sources. */
950#define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
951#define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
952#define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
Peter Seidererdc199242015-05-04 07:51:05 -0300953/* mem2mem encoder/decoder */
954#define V4L2_BUF_FLAG_LAST 0x00100000
David Howells607ca462012-10-13 10:46:48 +0100955
Tomasz Stanislawskib799d09a2012-06-14 11:32:23 -0300956/**
957 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
958 *
959 * @index: id number of the buffer
960 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
961 * multiplanar buffers);
962 * @plane: index of the plane to be exported, 0 for single plane queues
963 * @flags: flags for newly created file, currently only O_CLOEXEC is
964 * supported, refer to manual of open syscall for more details
965 * @fd: file descriptor associated with DMABUF (set by driver)
966 *
967 * Contains data used for exporting a video buffer as DMABUF file descriptor.
968 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
969 * (identical to the cookie used to mmap() the buffer to userspace). All
970 * reserved fields must be set to zero. The field reserved0 is expected to
971 * become a structure 'type' allowing an alternative layout of the structure
972 * content. Therefore this field should not be used for any other extensions.
973 */
974struct v4l2_exportbuffer {
975 __u32 type; /* enum v4l2_buf_type */
976 __u32 index;
977 __u32 plane;
978 __u32 flags;
979 __s32 fd;
980 __u32 reserved[11];
981};
982
David Howells607ca462012-10-13 10:46:48 +0100983/*
984 * O V E R L A Y P R E V I E W
985 */
986struct v4l2_framebuffer {
987 __u32 capability;
988 __u32 flags;
989/* FIXME: in theory we should pass something like PCI device + memory
990 * region + offset instead of some physical address */
991 void *base;
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300992 struct {
993 __u32 width;
994 __u32 height;
995 __u32 pixelformat;
996 __u32 field; /* enum v4l2_field */
997 __u32 bytesperline; /* for padding, zero if unused */
998 __u32 sizeimage;
999 __u32 colorspace; /* enum v4l2_colorspace */
1000 __u32 priv; /* reserved field, set to 0 */
1001 } fmt;
David Howells607ca462012-10-13 10:46:48 +01001002};
1003/* Flags for the 'capability' field. Read only */
1004#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
1005#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
1006#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
1007#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
1008#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
1009#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
1010#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
1011#define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
1012/* Flags for the 'flags' field. */
1013#define V4L2_FBUF_FLAG_PRIMARY 0x0001
1014#define V4L2_FBUF_FLAG_OVERLAY 0x0002
1015#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
1016#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
1017#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
1018#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
1019#define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
1020
1021struct v4l2_clip {
1022 struct v4l2_rect c;
1023 struct v4l2_clip __user *next;
1024};
1025
1026struct v4l2_window {
1027 struct v4l2_rect w;
1028 __u32 field; /* enum v4l2_field */
1029 __u32 chromakey;
1030 struct v4l2_clip __user *clips;
1031 __u32 clipcount;
1032 void __user *bitmap;
1033 __u8 global_alpha;
1034};
1035
1036/*
1037 * C A P T U R E P A R A M E T E R S
1038 */
1039struct v4l2_captureparm {
1040 __u32 capability; /* Supported modes */
1041 __u32 capturemode; /* Current mode */
Kirill Smelkov2e745982012-10-22 14:14:01 -03001042 struct v4l2_fract timeperframe; /* Time per frame in seconds */
David Howells607ca462012-10-13 10:46:48 +01001043 __u32 extendedmode; /* Driver-specific extensions */
1044 __u32 readbuffers; /* # of buffers for read */
1045 __u32 reserved[4];
1046};
1047
1048/* Flags for 'capability' and 'capturemode' fields */
1049#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
1050#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
1051
1052struct v4l2_outputparm {
1053 __u32 capability; /* Supported modes */
1054 __u32 outputmode; /* Current mode */
1055 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1056 __u32 extendedmode; /* Driver-specific extensions */
1057 __u32 writebuffers; /* # of buffers for write */
1058 __u32 reserved[4];
1059};
1060
1061/*
1062 * I N P U T I M A G E C R O P P I N G
1063 */
1064struct v4l2_cropcap {
1065 __u32 type; /* enum v4l2_buf_type */
1066 struct v4l2_rect bounds;
1067 struct v4l2_rect defrect;
1068 struct v4l2_fract pixelaspect;
1069};
1070
1071struct v4l2_crop {
1072 __u32 type; /* enum v4l2_buf_type */
1073 struct v4l2_rect c;
1074};
1075
1076/**
1077 * struct v4l2_selection - selection info
1078 * @type: buffer type (do not use *_MPLANE types)
1079 * @target: Selection target, used to choose one of possible rectangles;
1080 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
1081 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1082 * @r: coordinates of selection window
1083 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
1084 *
1085 * Hardware may use multiple helper windows to process a video stream.
1086 * The structure is used to exchange this selection areas between
1087 * an application and a driver.
1088 */
1089struct v4l2_selection {
1090 __u32 type;
1091 __u32 target;
1092 __u32 flags;
1093 struct v4l2_rect r;
1094 __u32 reserved[9];
1095};
1096
1097
1098/*
1099 * A N A L O G V I D E O S T A N D A R D
1100 */
1101
1102typedef __u64 v4l2_std_id;
1103
1104/* one bit for each */
1105#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
1106#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
1107#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
1108#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
1109#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
1110#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
1111#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
1112#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
1113
1114#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
1115#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
1116#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
1117#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
1118
1119#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
1120#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
1121#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
1122#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
1123
1124#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
1125#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
1126#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
1127#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
1128#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
1129#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
1130#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
1131#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
1132
1133/* ATSC/HDTV */
1134#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
1135#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
1136
1137/* FIXME:
1138 Although std_id is 64 bits, there is an issue on PPC32 architecture that
1139 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
1140 this value to 32 bits.
1141 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1142 it should work fine. However, if needed to add more than two standards,
1143 v4l2-common.c should be fixed.
1144 */
1145
1146/*
1147 * Some macros to merge video standards in order to make live easier for the
1148 * drivers and V4L2 applications
1149 */
1150
1151/*
1152 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1153 * Missing here.
1154 */
1155#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
1156 V4L2_STD_NTSC_M_JP |\
1157 V4L2_STD_NTSC_M_KR)
1158/* Secam macros */
1159#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
1160 V4L2_STD_SECAM_K |\
1161 V4L2_STD_SECAM_K1)
1162/* All Secam Standards */
1163#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
1164 V4L2_STD_SECAM_G |\
1165 V4L2_STD_SECAM_H |\
1166 V4L2_STD_SECAM_DK |\
1167 V4L2_STD_SECAM_L |\
1168 V4L2_STD_SECAM_LC)
1169/* PAL macros */
1170#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
1171 V4L2_STD_PAL_B1 |\
1172 V4L2_STD_PAL_G)
1173#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
1174 V4L2_STD_PAL_D1 |\
1175 V4L2_STD_PAL_K)
1176/*
1177 * "Common" PAL - This macro is there to be compatible with the old
1178 * V4L1 concept of "PAL": /BGDKHI.
Lad, Prabhakarff29feb2013-05-20 06:02:40 -03001179 * Several PAL standards are missing here: /M, /N and /Nc
David Howells607ca462012-10-13 10:46:48 +01001180 */
1181#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
1182 V4L2_STD_PAL_DK |\
1183 V4L2_STD_PAL_H |\
1184 V4L2_STD_PAL_I)
1185/* Chroma "agnostic" standards */
1186#define V4L2_STD_B (V4L2_STD_PAL_B |\
1187 V4L2_STD_PAL_B1 |\
1188 V4L2_STD_SECAM_B)
1189#define V4L2_STD_G (V4L2_STD_PAL_G |\
1190 V4L2_STD_SECAM_G)
1191#define V4L2_STD_H (V4L2_STD_PAL_H |\
1192 V4L2_STD_SECAM_H)
1193#define V4L2_STD_L (V4L2_STD_SECAM_L |\
1194 V4L2_STD_SECAM_LC)
1195#define V4L2_STD_GH (V4L2_STD_G |\
1196 V4L2_STD_H)
1197#define V4L2_STD_DK (V4L2_STD_PAL_DK |\
1198 V4L2_STD_SECAM_DK)
1199#define V4L2_STD_BG (V4L2_STD_B |\
1200 V4L2_STD_G)
1201#define V4L2_STD_MN (V4L2_STD_PAL_M |\
1202 V4L2_STD_PAL_N |\
1203 V4L2_STD_PAL_Nc |\
1204 V4L2_STD_NTSC)
1205
1206/* Standards where MTS/BTSC stereo could be found */
1207#define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
1208 V4L2_STD_PAL_M |\
1209 V4L2_STD_PAL_N |\
1210 V4L2_STD_PAL_Nc)
1211
1212/* Standards for Countries with 60Hz Line frequency */
1213#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
1214 V4L2_STD_PAL_60 |\
1215 V4L2_STD_NTSC |\
1216 V4L2_STD_NTSC_443)
1217/* Standards for Countries with 50Hz Line frequency */
1218#define V4L2_STD_625_50 (V4L2_STD_PAL |\
1219 V4L2_STD_PAL_N |\
1220 V4L2_STD_PAL_Nc |\
1221 V4L2_STD_SECAM)
1222
1223#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1224 V4L2_STD_ATSC_16_VSB)
1225/* Macros with none and all analog standards */
1226#define V4L2_STD_UNKNOWN 0
1227#define V4L2_STD_ALL (V4L2_STD_525_60 |\
1228 V4L2_STD_625_50)
1229
1230struct v4l2_standard {
1231 __u32 index;
1232 v4l2_std_id id;
1233 __u8 name[24];
1234 struct v4l2_fract frameperiod; /* Frames, not fields */
1235 __u32 framelines;
1236 __u32 reserved[4];
1237};
1238
David Howells607ca462012-10-13 10:46:48 +01001239/*
1240 * D V B T T I M I N G S
1241 */
1242
1243/** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1244 * @width: total width of the active video in pixels
1245 * @height: total height of the active video in lines
1246 * @interlaced: Interlaced or progressive
1247 * @polarities: Positive or negative polarities
1248 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1249 * @hfrontporch:Horizontal front porch in pixels
1250 * @hsync: Horizontal Sync length in pixels
1251 * @hbackporch: Horizontal back porch in pixels
1252 * @vfrontporch:Vertical front porch in lines
1253 * @vsync: Vertical Sync length in lines
1254 * @vbackporch: Vertical back porch in lines
1255 * @il_vfrontporch:Vertical front porch for the even field
1256 * (aka field 2) of interlaced field formats
1257 * @il_vsync: Vertical Sync length for the even field
1258 * (aka field 2) of interlaced field formats
1259 * @il_vbackporch:Vertical back porch for the even field
1260 * (aka field 2) of interlaced field formats
1261 * @standards: Standards the timing belongs to
1262 * @flags: Flags
Hans Verkuil4f100ff2016-07-14 07:58:35 -03001263 * @picture_aspect: The picture aspect ratio (hor/vert).
1264 * @cea861_vic: VIC code as per the CEA-861 standard.
1265 * @hdmi_vic: VIC code as per the HDMI standard.
David Howells607ca462012-10-13 10:46:48 +01001266 * @reserved: Reserved fields, must be zeroed.
1267 *
1268 * A note regarding vertical interlaced timings: height refers to the total
1269 * height of the active video frame (= two fields). The blanking timings refer
1270 * to the blanking of each field. So the height of the total frame is
1271 * calculated as follows:
1272 *
1273 * tot_height = height + vfrontporch + vsync + vbackporch +
1274 * il_vfrontporch + il_vsync + il_vbackporch
1275 *
1276 * The active height of each field is height / 2.
1277 */
1278struct v4l2_bt_timings {
1279 __u32 width;
1280 __u32 height;
1281 __u32 interlaced;
1282 __u32 polarities;
1283 __u64 pixelclock;
1284 __u32 hfrontporch;
1285 __u32 hsync;
1286 __u32 hbackporch;
1287 __u32 vfrontporch;
1288 __u32 vsync;
1289 __u32 vbackporch;
1290 __u32 il_vfrontporch;
1291 __u32 il_vsync;
1292 __u32 il_vbackporch;
1293 __u32 standards;
1294 __u32 flags;
Hans Verkuil4f100ff2016-07-14 07:58:35 -03001295 struct v4l2_fract picture_aspect;
1296 __u8 cea861_vic;
1297 __u8 hdmi_vic;
1298 __u8 reserved[46];
David Howells607ca462012-10-13 10:46:48 +01001299} __attribute__ ((packed));
1300
1301/* Interlaced or progressive format */
1302#define V4L2_DV_PROGRESSIVE 0
1303#define V4L2_DV_INTERLACED 1
1304
1305/* Polarities. If bit is not set, it is assumed to be negative polarity */
1306#define V4L2_DV_VSYNC_POS_POL 0x00000001
1307#define V4L2_DV_HSYNC_POS_POL 0x00000002
1308
1309/* Timings standards */
1310#define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1311#define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1312#define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1313#define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
Charles-Antoine Couret7389e6e2016-09-15 12:29:50 -03001314#define V4L2_DV_BT_STD_SDI (1 << 4) /* SDI Timings */
David Howells607ca462012-10-13 10:46:48 +01001315
1316/* Flags */
1317
Hans Verkuil8fbe91e2016-09-16 07:47:08 -03001318/*
1319 * CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1320 * GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1321 * intervals are reduced, allowing a higher resolution over the same
1322 * bandwidth. This is a read-only flag.
1323 */
David Howells607ca462012-10-13 10:46:48 +01001324#define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
Hans Verkuil8fbe91e2016-09-16 07:47:08 -03001325/*
1326 * CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1327 * of six. These formats can be optionally played at 1 / 1.001 speed.
1328 * This is a read-only flag.
1329 */
David Howells607ca462012-10-13 10:46:48 +01001330#define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
Hans Verkuil8fbe91e2016-09-16 07:47:08 -03001331/*
1332 * CEA-861 specific: only valid for video transmitters, the flag is cleared
1333 * by receivers.
1334 * If the framerate of the format is a multiple of six, then the pixelclock
1335 * used to set up the transmitter is divided by 1.001 to make it compatible
1336 * with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1337 * 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1338 * such frequencies, then the flag will also be cleared.
1339 */
David Howells607ca462012-10-13 10:46:48 +01001340#define V4L2_DV_FL_REDUCED_FPS (1 << 2)
Hans Verkuil8fbe91e2016-09-16 07:47:08 -03001341/*
1342 * Specific to interlaced formats: if set, then field 1 is really one half-line
1343 * longer and field 2 is really one half-line shorter, so each field has
1344 * exactly the same number of half-lines. Whether half-lines can be detected
1345 * or used depends on the hardware.
1346 */
Hans Verkuil292a8782013-03-20 15:26:36 -03001347#define V4L2_DV_FL_HALF_LINE (1 << 3)
Hans Verkuil8fbe91e2016-09-16 07:47:08 -03001348/*
1349 * If set, then this is a Consumer Electronics (CE) video format. Such formats
Hans Verkuil5ce65d12015-03-20 14:05:03 -03001350 * differ from other formats (commonly called IT formats) in that if RGB
1351 * encoding is used then by default the RGB values use limited range (i.e.
1352 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
Hans Verkuil8fbe91e2016-09-16 07:47:08 -03001353 * except for the 640x480 format are CE formats.
1354 */
Hans Verkuil5ce65d12015-03-20 14:05:03 -03001355#define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
Charles-Antoine Couret7389e6e2016-09-15 12:29:50 -03001356/* Some formats like SMPTE-125M have an interlaced signal with a odd
1357 * total height. For these formats, if this flag is set, the first
1358 * field has the extra line. If not, it is the second field.
1359 */
Hans Verkuil4f100ff2016-07-14 07:58:35 -03001360#define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE (1 << 5)
1361/*
1362 * If set, then the picture_aspect field is valid. Otherwise assume that the
1363 * pixels are square, so the picture aspect ratio is the same as the width to
1364 * height ratio.
1365 */
1366#define V4L2_DV_FL_HAS_PICTURE_ASPECT (1 << 6)
1367/*
1368 * If set, then the cea861_vic field is valid and contains the Video
1369 * Identification Code as per the CEA-861 standard.
1370 */
1371#define V4L2_DV_FL_HAS_CEA861_VIC (1 << 7)
1372/*
1373 * If set, then the hdmi_vic field is valid and contains the Video
1374 * Identification Code as per the HDMI standard (HDMI Vendor Specific
1375 * InfoFrame).
1376 */
1377#define V4L2_DV_FL_HAS_HDMI_VIC (1 << 8)
David Howells607ca462012-10-13 10:46:48 +01001378
Hans Verkuil7f681272013-07-29 08:40:58 -03001379/* A few useful defines to calculate the total blanking and frame sizes */
1380#define V4L2_DV_BT_BLANKING_WIDTH(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001381 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
Hans Verkuil7f681272013-07-29 08:40:58 -03001382#define V4L2_DV_BT_FRAME_WIDTH(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001383 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
Hans Verkuil7f681272013-07-29 08:40:58 -03001384#define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001385 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1386 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
Hans Verkuil7f681272013-07-29 08:40:58 -03001387#define V4L2_DV_BT_FRAME_HEIGHT(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001388 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
David Howells607ca462012-10-13 10:46:48 +01001389
1390/** struct v4l2_dv_timings - DV timings
1391 * @type: the type of the timings
1392 * @bt: BT656/1120 timings
1393 */
1394struct v4l2_dv_timings {
1395 __u32 type;
1396 union {
1397 struct v4l2_bt_timings bt;
1398 __u32 reserved[32];
1399 };
1400} __attribute__ ((packed));
1401
1402/* Values for the type field */
1403#define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1404
1405
1406/** struct v4l2_enum_dv_timings - DV timings enumeration
1407 * @index: enumeration index
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001408 * @pad: the pad number for which to enumerate timings (used with
1409 * v4l-subdev nodes only)
David Howells607ca462012-10-13 10:46:48 +01001410 * @reserved: must be zeroed
1411 * @timings: the timings for the given index
1412 */
1413struct v4l2_enum_dv_timings {
1414 __u32 index;
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001415 __u32 pad;
1416 __u32 reserved[2];
David Howells607ca462012-10-13 10:46:48 +01001417 struct v4l2_dv_timings timings;
1418};
1419
1420/** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1421 * @min_width: width in pixels
1422 * @max_width: width in pixels
1423 * @min_height: height in lines
1424 * @max_height: height in lines
1425 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1426 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1427 * @standards: Supported standards
1428 * @capabilities: Supported capabilities
1429 * @reserved: Must be zeroed
1430 */
1431struct v4l2_bt_timings_cap {
1432 __u32 min_width;
1433 __u32 max_width;
1434 __u32 min_height;
1435 __u32 max_height;
1436 __u64 min_pixelclock;
1437 __u64 max_pixelclock;
1438 __u32 standards;
1439 __u32 capabilities;
1440 __u32 reserved[16];
1441} __attribute__ ((packed));
1442
1443/* Supports interlaced formats */
1444#define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1445/* Supports progressive formats */
1446#define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1447/* Supports CVT/GTF reduced blanking */
1448#define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1449/* Supports custom formats */
1450#define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1451
1452/** struct v4l2_dv_timings_cap - DV timings capabilities
1453 * @type: the type of the timings (same as in struct v4l2_dv_timings)
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001454 * @pad: the pad number for which to query capabilities (used with
1455 * v4l-subdev nodes only)
David Howells607ca462012-10-13 10:46:48 +01001456 * @bt: the BT656/1120 timings capabilities
1457 */
1458struct v4l2_dv_timings_cap {
1459 __u32 type;
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001460 __u32 pad;
1461 __u32 reserved[2];
David Howells607ca462012-10-13 10:46:48 +01001462 union {
1463 struct v4l2_bt_timings_cap bt;
1464 __u32 raw_data[32];
1465 };
1466};
1467
1468
1469/*
1470 * V I D E O I N P U T S
1471 */
1472struct v4l2_input {
1473 __u32 index; /* Which input */
1474 __u8 name[32]; /* Label */
1475 __u32 type; /* Type of input */
1476 __u32 audioset; /* Associated audios (bitfield) */
1477 __u32 tuner; /* enum v4l2_tuner_type */
1478 v4l2_std_id std;
1479 __u32 status;
1480 __u32 capabilities;
1481 __u32 reserved[3];
1482};
1483
1484/* Values for the 'type' field */
1485#define V4L2_INPUT_TYPE_TUNER 1
1486#define V4L2_INPUT_TYPE_CAMERA 2
Nick Dyerb2fe22d2016-07-18 18:10:30 -03001487#define V4L2_INPUT_TYPE_TOUCH 3
David Howells607ca462012-10-13 10:46:48 +01001488
1489/* field 'status' - general */
1490#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1491#define V4L2_IN_ST_NO_SIGNAL 0x00000002
1492#define V4L2_IN_ST_NO_COLOR 0x00000004
1493
1494/* field 'status' - sensor orientation */
1495/* If sensor is mounted upside down set both bits */
1496#define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1497#define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1498
1499/* field 'status' - analog */
1500#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1501#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
Charles-Antoine Couret7389e6e2016-09-15 12:29:50 -03001502#define V4L2_IN_ST_NO_V_LOCK 0x00000400 /* No vertical sync lock */
1503#define V4L2_IN_ST_NO_STD_LOCK 0x00000800 /* No standard format lock */
David Howells607ca462012-10-13 10:46:48 +01001504
1505/* field 'status' - digital */
1506#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1507#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1508#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1509
1510/* field 'status' - VCR and set-top box */
1511#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1512#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1513#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1514
1515/* capabilities flags */
David Howells607ca462012-10-13 10:46:48 +01001516#define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1517#define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1518#define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
Sakari Ailus8af03452014-11-18 02:27:00 -03001519#define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
David Howells607ca462012-10-13 10:46:48 +01001520
1521/*
1522 * V I D E O O U T P U T S
1523 */
1524struct v4l2_output {
1525 __u32 index; /* Which output */
1526 __u8 name[32]; /* Label */
1527 __u32 type; /* Type of output */
1528 __u32 audioset; /* Associated audios (bitfield) */
1529 __u32 modulator; /* Associated modulator */
1530 v4l2_std_id std;
1531 __u32 capabilities;
1532 __u32 reserved[3];
1533};
1534/* Values for the 'type' field */
1535#define V4L2_OUTPUT_TYPE_MODULATOR 1
1536#define V4L2_OUTPUT_TYPE_ANALOG 2
1537#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1538
1539/* capabilities flags */
David Howells607ca462012-10-13 10:46:48 +01001540#define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1541#define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1542#define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
Sakari Ailus8af03452014-11-18 02:27:00 -03001543#define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
David Howells607ca462012-10-13 10:46:48 +01001544
1545/*
1546 * C O N T R O L S
1547 */
1548struct v4l2_control {
1549 __u32 id;
1550 __s32 value;
1551};
1552
1553struct v4l2_ext_control {
1554 __u32 id;
1555 __u32 size;
1556 __u32 reserved2[1];
1557 union {
1558 __s32 value;
1559 __s64 value64;
Hans Verkuileadf9e22014-08-21 16:49:16 -03001560 char __user *string;
1561 __u8 __user *p_u8;
1562 __u16 __user *p_u16;
1563 __u32 __user *p_u32;
1564 void __user *ptr;
David Howells607ca462012-10-13 10:46:48 +01001565 };
1566} __attribute__ ((packed));
1567
1568struct v4l2_ext_controls {
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001569 union {
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001570#ifndef __KERNEL__
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001571 __u32 ctrl_class;
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001572#endif
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001573 __u32 which;
1574 };
David Howells607ca462012-10-13 10:46:48 +01001575 __u32 count;
1576 __u32 error_idx;
1577 __u32 reserved[2];
1578 struct v4l2_ext_control *controls;
1579};
1580
1581#define V4L2_CTRL_ID_MASK (0x0fffffff)
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001582#ifndef __KERNEL__
David Howells607ca462012-10-13 10:46:48 +01001583#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001584#endif
1585#define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
David Howells607ca462012-10-13 10:46:48 +01001586#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
Hans Verkuil5082c242014-06-10 04:14:50 -03001587#define V4L2_CTRL_MAX_DIMS (4)
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001588#define V4L2_CTRL_WHICH_CUR_VAL 0
1589#define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
David Howells607ca462012-10-13 10:46:48 +01001590
1591enum v4l2_ctrl_type {
1592 V4L2_CTRL_TYPE_INTEGER = 1,
1593 V4L2_CTRL_TYPE_BOOLEAN = 2,
1594 V4L2_CTRL_TYPE_MENU = 3,
1595 V4L2_CTRL_TYPE_BUTTON = 4,
1596 V4L2_CTRL_TYPE_INTEGER64 = 5,
1597 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1598 V4L2_CTRL_TYPE_STRING = 7,
1599 V4L2_CTRL_TYPE_BITMASK = 8,
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001600 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1601
1602 /* Compound types are >= 0x0100 */
1603 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
Hans Verkuildda4a4d2014-06-10 07:30:04 -03001604 V4L2_CTRL_TYPE_U8 = 0x0100,
1605 V4L2_CTRL_TYPE_U16 = 0x0101,
Hans Verkuil811c5082014-07-21 10:45:37 -03001606 V4L2_CTRL_TYPE_U32 = 0x0102,
David Howells607ca462012-10-13 10:46:48 +01001607};
1608
1609/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1610struct v4l2_queryctrl {
1611 __u32 id;
1612 __u32 type; /* enum v4l2_ctrl_type */
1613 __u8 name[32]; /* Whatever */
1614 __s32 minimum; /* Note signedness */
1615 __s32 maximum;
1616 __s32 step;
1617 __s32 default_value;
1618 __u32 flags;
1619 __u32 reserved[2];
1620};
1621
Hans Verkuil5082c242014-06-10 04:14:50 -03001622/* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1623struct v4l2_query_ext_ctrl {
1624 __u32 id;
1625 __u32 type;
1626 char name[32];
1627 __s64 minimum;
1628 __s64 maximum;
1629 __u64 step;
1630 __s64 default_value;
1631 __u32 flags;
1632 __u32 elem_size;
1633 __u32 elems;
1634 __u32 nr_of_dims;
1635 __u32 dims[V4L2_CTRL_MAX_DIMS];
1636 __u32 reserved[32];
1637};
1638
David Howells607ca462012-10-13 10:46:48 +01001639/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1640struct v4l2_querymenu {
1641 __u32 id;
1642 __u32 index;
1643 union {
1644 __u8 name[32]; /* Whatever */
1645 __s64 value;
1646 };
1647 __u32 reserved;
1648} __attribute__ ((packed));
1649
1650/* Control flags */
1651#define V4L2_CTRL_FLAG_DISABLED 0x0001
1652#define V4L2_CTRL_FLAG_GRABBED 0x0002
1653#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1654#define V4L2_CTRL_FLAG_UPDATE 0x0008
1655#define V4L2_CTRL_FLAG_INACTIVE 0x0010
1656#define V4L2_CTRL_FLAG_SLIDER 0x0020
1657#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1658#define V4L2_CTRL_FLAG_VOLATILE 0x0080
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001659#define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
Ricardo Ribaldab6e5b8f2015-03-20 10:45:43 -03001660#define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
David Howells607ca462012-10-13 10:46:48 +01001661
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001662/* Query flags, to be ORed with the control ID */
David Howells607ca462012-10-13 10:46:48 +01001663#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001664#define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
David Howells607ca462012-10-13 10:46:48 +01001665
1666/* User-class control IDs defined by V4L2 */
1667#define V4L2_CID_MAX_CTRLS 1024
1668/* IDs reserved for driver specific controls */
1669#define V4L2_CID_PRIVATE_BASE 0x08000000
1670
1671
David Howells607ca462012-10-13 10:46:48 +01001672/*
1673 * T U N I N G
1674 */
1675struct v4l2_tuner {
1676 __u32 index;
1677 __u8 name[32];
1678 __u32 type; /* enum v4l2_tuner_type */
1679 __u32 capability;
1680 __u32 rangelow;
1681 __u32 rangehigh;
1682 __u32 rxsubchans;
1683 __u32 audmode;
1684 __s32 signal;
1685 __s32 afc;
1686 __u32 reserved[4];
1687};
1688
1689struct v4l2_modulator {
1690 __u32 index;
1691 __u8 name[32];
1692 __u32 capability;
1693 __u32 rangelow;
1694 __u32 rangehigh;
1695 __u32 txsubchans;
Antti Palosaari4124a3c2015-10-10 13:51:02 -03001696 __u32 type; /* enum v4l2_tuner_type */
1697 __u32 reserved[3];
David Howells607ca462012-10-13 10:46:48 +01001698};
1699
1700/* Flags for the 'capability' field */
1701#define V4L2_TUNER_CAP_LOW 0x0001
1702#define V4L2_TUNER_CAP_NORM 0x0002
1703#define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1704#define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1705#define V4L2_TUNER_CAP_STEREO 0x0010
1706#define V4L2_TUNER_CAP_LANG2 0x0020
1707#define V4L2_TUNER_CAP_SAP 0x0020
1708#define V4L2_TUNER_CAP_LANG1 0x0040
1709#define V4L2_TUNER_CAP_RDS 0x0080
1710#define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1711#define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1712#define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1713#define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
Antti Palosaari67f9a112013-12-11 20:27:31 -03001714#define V4L2_TUNER_CAP_1HZ 0x1000
David Howells607ca462012-10-13 10:46:48 +01001715
1716/* Flags for the 'rxsubchans' field */
1717#define V4L2_TUNER_SUB_MONO 0x0001
1718#define V4L2_TUNER_SUB_STEREO 0x0002
1719#define V4L2_TUNER_SUB_LANG2 0x0004
1720#define V4L2_TUNER_SUB_SAP 0x0004
1721#define V4L2_TUNER_SUB_LANG1 0x0008
1722#define V4L2_TUNER_SUB_RDS 0x0010
1723
1724/* Values for the 'audmode' field */
1725#define V4L2_TUNER_MODE_MONO 0x0000
1726#define V4L2_TUNER_MODE_STEREO 0x0001
1727#define V4L2_TUNER_MODE_LANG2 0x0002
1728#define V4L2_TUNER_MODE_SAP 0x0002
1729#define V4L2_TUNER_MODE_LANG1 0x0003
1730#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1731
1732struct v4l2_frequency {
1733 __u32 tuner;
1734 __u32 type; /* enum v4l2_tuner_type */
1735 __u32 frequency;
1736 __u32 reserved[8];
1737};
1738
1739#define V4L2_BAND_MODULATION_VSB (1 << 1)
1740#define V4L2_BAND_MODULATION_FM (1 << 2)
1741#define V4L2_BAND_MODULATION_AM (1 << 3)
1742
1743struct v4l2_frequency_band {
1744 __u32 tuner;
1745 __u32 type; /* enum v4l2_tuner_type */
1746 __u32 index;
1747 __u32 capability;
1748 __u32 rangelow;
1749 __u32 rangehigh;
1750 __u32 modulation;
1751 __u32 reserved[9];
1752};
1753
1754struct v4l2_hw_freq_seek {
1755 __u32 tuner;
1756 __u32 type; /* enum v4l2_tuner_type */
1757 __u32 seek_upward;
1758 __u32 wrap_around;
1759 __u32 spacing;
1760 __u32 rangelow;
1761 __u32 rangehigh;
1762 __u32 reserved[5];
1763};
1764
1765/*
1766 * R D S
1767 */
1768
1769struct v4l2_rds_data {
1770 __u8 lsb;
1771 __u8 msb;
1772 __u8 block;
1773} __attribute__ ((packed));
1774
1775#define V4L2_RDS_BLOCK_MSK 0x7
1776#define V4L2_RDS_BLOCK_A 0
1777#define V4L2_RDS_BLOCK_B 1
1778#define V4L2_RDS_BLOCK_C 2
1779#define V4L2_RDS_BLOCK_D 3
1780#define V4L2_RDS_BLOCK_C_ALT 4
1781#define V4L2_RDS_BLOCK_INVALID 7
1782
1783#define V4L2_RDS_BLOCK_CORRECTED 0x40
1784#define V4L2_RDS_BLOCK_ERROR 0x80
1785
1786/*
1787 * A U D I O
1788 */
1789struct v4l2_audio {
1790 __u32 index;
1791 __u8 name[32];
1792 __u32 capability;
1793 __u32 mode;
1794 __u32 reserved[2];
1795};
1796
1797/* Flags for the 'capability' field */
1798#define V4L2_AUDCAP_STEREO 0x00001
1799#define V4L2_AUDCAP_AVL 0x00002
1800
1801/* Flags for the 'mode' field */
1802#define V4L2_AUDMODE_AVL 0x00001
1803
1804struct v4l2_audioout {
1805 __u32 index;
1806 __u8 name[32];
1807 __u32 capability;
1808 __u32 mode;
1809 __u32 reserved[2];
1810};
1811
1812/*
1813 * M P E G S E R V I C E S
David Howells607ca462012-10-13 10:46:48 +01001814 */
1815#if 1
1816#define V4L2_ENC_IDX_FRAME_I (0)
1817#define V4L2_ENC_IDX_FRAME_P (1)
1818#define V4L2_ENC_IDX_FRAME_B (2)
1819#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1820
1821struct v4l2_enc_idx_entry {
1822 __u64 offset;
1823 __u64 pts;
1824 __u32 length;
1825 __u32 flags;
1826 __u32 reserved[2];
1827};
1828
1829#define V4L2_ENC_IDX_ENTRIES (64)
1830struct v4l2_enc_idx {
1831 __u32 entries;
1832 __u32 entries_cap;
1833 __u32 reserved[4];
1834 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1835};
1836
1837
1838#define V4L2_ENC_CMD_START (0)
1839#define V4L2_ENC_CMD_STOP (1)
1840#define V4L2_ENC_CMD_PAUSE (2)
1841#define V4L2_ENC_CMD_RESUME (3)
1842
1843/* Flags for V4L2_ENC_CMD_STOP */
1844#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1845
1846struct v4l2_encoder_cmd {
1847 __u32 cmd;
1848 __u32 flags;
1849 union {
1850 struct {
1851 __u32 data[8];
1852 } raw;
1853 };
1854};
1855
1856/* Decoder commands */
1857#define V4L2_DEC_CMD_START (0)
1858#define V4L2_DEC_CMD_STOP (1)
1859#define V4L2_DEC_CMD_PAUSE (2)
1860#define V4L2_DEC_CMD_RESUME (3)
1861
1862/* Flags for V4L2_DEC_CMD_START */
1863#define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1864
1865/* Flags for V4L2_DEC_CMD_PAUSE */
1866#define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
1867
1868/* Flags for V4L2_DEC_CMD_STOP */
1869#define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
1870#define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
1871
1872/* Play format requirements (returned by the driver): */
1873
1874/* The decoder has no special format requirements */
1875#define V4L2_DEC_START_FMT_NONE (0)
1876/* The decoder requires full GOPs */
1877#define V4L2_DEC_START_FMT_GOP (1)
1878
1879/* The structure must be zeroed before use by the application
1880 This ensures it can be extended safely in the future. */
1881struct v4l2_decoder_cmd {
1882 __u32 cmd;
1883 __u32 flags;
1884 union {
1885 struct {
1886 __u64 pts;
1887 } stop;
1888
1889 struct {
1890 /* 0 or 1000 specifies normal speed,
1891 1 specifies forward single stepping,
1892 -1 specifies backward single stepping,
1893 >1: playback at speed/1000 of the normal speed,
1894 <-1: reverse playback at (-speed/1000) of the normal speed. */
1895 __s32 speed;
1896 __u32 format;
1897 } start;
1898
1899 struct {
1900 __u32 data[16];
1901 } raw;
1902 };
1903};
1904#endif
1905
1906
1907/*
1908 * D A T A S E R V I C E S ( V B I )
1909 *
1910 * Data services API by Michael Schimek
1911 */
1912
1913/* Raw VBI */
1914struct v4l2_vbi_format {
1915 __u32 sampling_rate; /* in 1 Hz */
1916 __u32 offset;
1917 __u32 samples_per_line;
1918 __u32 sample_format; /* V4L2_PIX_FMT_* */
1919 __s32 start[2];
1920 __u32 count[2];
1921 __u32 flags; /* V4L2_VBI_* */
1922 __u32 reserved[2]; /* must be zero */
1923};
1924
1925/* VBI flags */
1926#define V4L2_VBI_UNSYNC (1 << 0)
1927#define V4L2_VBI_INTERLACED (1 << 1)
1928
Hans Verkuil273886b2014-07-18 02:58:41 -03001929/* ITU-R start lines for each field */
1930#define V4L2_VBI_ITU_525_F1_START (1)
1931#define V4L2_VBI_ITU_525_F2_START (264)
1932#define V4L2_VBI_ITU_625_F1_START (1)
1933#define V4L2_VBI_ITU_625_F2_START (314)
1934
David Howells607ca462012-10-13 10:46:48 +01001935/* Sliced VBI
1936 *
1937 * This implements is a proposal V4L2 API to allow SLICED VBI
1938 * required for some hardware encoders. It should change without
1939 * notice in the definitive implementation.
1940 */
1941
1942struct v4l2_sliced_vbi_format {
1943 __u16 service_set;
1944 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1945 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1946 (equals frame lines 313-336 for 625 line video
1947 standards, 263-286 for 525 line standards) */
1948 __u16 service_lines[2][24];
1949 __u32 io_size;
1950 __u32 reserved[2]; /* must be zero */
1951};
1952
1953/* Teletext World System Teletext
1954 (WST), defined on ITU-R BT.653-2 */
1955#define V4L2_SLICED_TELETEXT_B (0x0001)
1956/* Video Program System, defined on ETS 300 231*/
1957#define V4L2_SLICED_VPS (0x0400)
1958/* Closed Caption, defined on EIA-608 */
1959#define V4L2_SLICED_CAPTION_525 (0x1000)
1960/* Wide Screen System, defined on ITU-R BT1119.1 */
1961#define V4L2_SLICED_WSS_625 (0x4000)
1962
1963#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1964#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
1965
1966struct v4l2_sliced_vbi_cap {
1967 __u16 service_set;
1968 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1969 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1970 (equals frame lines 313-336 for 625 line video
1971 standards, 263-286 for 525 line standards) */
1972 __u16 service_lines[2][24];
1973 __u32 type; /* enum v4l2_buf_type */
1974 __u32 reserved[3]; /* must be 0 */
1975};
1976
1977struct v4l2_sliced_vbi_data {
1978 __u32 id;
1979 __u32 field; /* 0: first field, 1: second field */
1980 __u32 line; /* 1-23 */
1981 __u32 reserved; /* must be 0 */
1982 __u8 data[48];
1983};
1984
1985/*
1986 * Sliced VBI data inserted into MPEG Streams
1987 */
1988
1989/*
1990 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1991 *
1992 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1993 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1994 * data
1995 *
1996 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1997 * definitions are not included here. See the MPEG-2 specifications for details
1998 * on these headers.
1999 */
2000
2001/* Line type IDs */
2002#define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
2003#define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
2004#define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
2005#define V4L2_MPEG_VBI_IVTV_VPS (7)
2006
2007struct v4l2_mpeg_vbi_itv0_line {
2008 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
2009 __u8 data[42]; /* Sliced VBI data for the line */
2010} __attribute__ ((packed));
2011
2012struct v4l2_mpeg_vbi_itv0 {
2013 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
2014 struct v4l2_mpeg_vbi_itv0_line line[35];
2015} __attribute__ ((packed));
2016
2017struct v4l2_mpeg_vbi_ITV0 {
2018 struct v4l2_mpeg_vbi_itv0_line line[36];
2019} __attribute__ ((packed));
2020
2021#define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
2022#define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
2023
2024struct v4l2_mpeg_vbi_fmt_ivtv {
2025 __u8 magic[4];
2026 union {
2027 struct v4l2_mpeg_vbi_itv0 itv0;
2028 struct v4l2_mpeg_vbi_ITV0 ITV0;
2029 };
2030} __attribute__ ((packed));
2031
2032/*
2033 * A G G R E G A T E S T R U C T U R E S
2034 */
2035
2036/**
2037 * struct v4l2_plane_pix_format - additional, per-plane format definition
2038 * @sizeimage: maximum size in bytes required for data, for which
2039 * this plane will be used
2040 * @bytesperline: distance in bytes between the leftmost pixels in two
2041 * adjacent lines
2042 */
2043struct v4l2_plane_pix_format {
2044 __u32 sizeimage;
Hans Verkuilcc7d2df2015-03-15 14:30:25 -03002045 __u32 bytesperline;
2046 __u16 reserved[6];
David Howells607ca462012-10-13 10:46:48 +01002047} __attribute__ ((packed));
2048
2049/**
2050 * struct v4l2_pix_format_mplane - multiplanar format definition
2051 * @width: image width in pixels
2052 * @height: image height in pixels
2053 * @pixelformat: little endian four character code (fourcc)
2054 * @field: enum v4l2_field; field order (for interlaced video)
2055 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
2056 * @plane_fmt: per-plane information
2057 * @num_planes: number of planes for this format
Laurent Pinchartc96fd462014-05-27 10:12:43 -03002058 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
Hans Verkuild5735d62014-11-17 09:06:42 -03002059 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
2060 * @quantization: enum v4l2_quantization, colorspace quantization
Hans Verkuil74fdcb22015-04-28 08:49:09 -03002061 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
David Howells607ca462012-10-13 10:46:48 +01002062 */
2063struct v4l2_pix_format_mplane {
2064 __u32 width;
2065 __u32 height;
2066 __u32 pixelformat;
2067 __u32 field;
2068 __u32 colorspace;
2069
2070 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
2071 __u8 num_planes;
Laurent Pinchartc96fd462014-05-27 10:12:43 -03002072 __u8 flags;
Ricardo Ribalda Delgado8a0d62a2016-08-22 06:28:07 -03002073 union {
2074 __u8 ycbcr_enc;
2075 __u8 hsv_enc;
2076 };
Hans Verkuild5735d62014-11-17 09:06:42 -03002077 __u8 quantization;
Hans Verkuil74fdcb22015-04-28 08:49:09 -03002078 __u8 xfer_func;
2079 __u8 reserved[7];
David Howells607ca462012-10-13 10:46:48 +01002080} __attribute__ ((packed));
2081
2082/**
Antti Palosaari87185c92014-03-10 10:43:24 -03002083 * struct v4l2_sdr_format - SDR format definition
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002084 * @pixelformat: little endian four character code (fourcc)
Antti Palosaariaaa968b2014-07-18 15:28:24 -03002085 * @buffersize: maximum size in bytes required for data
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002086 */
Antti Palosaari87185c92014-03-10 10:43:24 -03002087struct v4l2_sdr_format {
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002088 __u32 pixelformat;
Antti Palosaariaaa968b2014-07-18 15:28:24 -03002089 __u32 buffersize;
2090 __u8 reserved[24];
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002091} __attribute__ ((packed));
2092
2093/**
Laurent Pinchartfb9ffa62016-04-12 19:40:46 -03002094 * struct v4l2_meta_format - metadata format definition
2095 * @dataformat: little endian four character code (fourcc)
2096 * @buffersize: maximum size in bytes required for data
2097 */
2098struct v4l2_meta_format {
2099 __u32 dataformat;
2100 __u32 buffersize;
2101} __attribute__ ((packed));
2102
2103/**
David Howells607ca462012-10-13 10:46:48 +01002104 * struct v4l2_format - stream data format
2105 * @type: enum v4l2_buf_type; type of the data stream
2106 * @pix: definition of an image format
2107 * @pix_mp: definition of a multiplanar image format
2108 * @win: definition of an overlaid image
2109 * @vbi: raw VBI capture or output parameters
2110 * @sliced: sliced VBI capture or output parameters
2111 * @raw_data: placeholder for future extensions and custom formats
2112 */
2113struct v4l2_format {
2114 __u32 type;
2115 union {
2116 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2117 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2118 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2119 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
2120 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
Antti Palosaari87185c92014-03-10 10:43:24 -03002121 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
Laurent Pinchartfb9ffa62016-04-12 19:40:46 -03002122 struct v4l2_meta_format meta; /* V4L2_BUF_TYPE_META_CAPTURE */
David Howells607ca462012-10-13 10:46:48 +01002123 __u8 raw_data[200]; /* user-defined */
2124 } fmt;
2125};
2126
2127/* Stream type-dependent parameters
2128 */
2129struct v4l2_streamparm {
2130 __u32 type; /* enum v4l2_buf_type */
2131 union {
2132 struct v4l2_captureparm capture;
2133 struct v4l2_outputparm output;
2134 __u8 raw_data[200]; /* user-defined */
2135 } parm;
2136};
2137
2138/*
2139 * E V E N T S
2140 */
2141
2142#define V4L2_EVENT_ALL 0
2143#define V4L2_EVENT_VSYNC 1
2144#define V4L2_EVENT_EOS 2
2145#define V4L2_EVENT_CTRL 3
2146#define V4L2_EVENT_FRAME_SYNC 4
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002147#define V4L2_EVENT_SOURCE_CHANGE 5
Hans Verkuil78ea6112014-01-27 09:26:23 -03002148#define V4L2_EVENT_MOTION_DET 6
David Howells607ca462012-10-13 10:46:48 +01002149#define V4L2_EVENT_PRIVATE_START 0x08000000
2150
2151/* Payload for V4L2_EVENT_VSYNC */
2152struct v4l2_event_vsync {
2153 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2154 __u8 field;
2155} __attribute__ ((packed));
2156
2157/* Payload for V4L2_EVENT_CTRL */
2158#define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
2159#define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
Sylwester Nawrocki2ccbe772013-01-19 15:51:55 -03002160#define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
David Howells607ca462012-10-13 10:46:48 +01002161
2162struct v4l2_event_ctrl {
2163 __u32 changes;
2164 __u32 type;
2165 union {
2166 __s32 value;
2167 __s64 value64;
2168 };
2169 __u32 flags;
2170 __s32 minimum;
2171 __s32 maximum;
2172 __s32 step;
2173 __s32 default_value;
2174};
2175
2176struct v4l2_event_frame_sync {
2177 __u32 frame_sequence;
2178};
2179
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002180#define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
2181
2182struct v4l2_event_src_change {
2183 __u32 changes;
2184};
2185
Hans Verkuil78ea6112014-01-27 09:26:23 -03002186#define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2187
2188/**
2189 * struct v4l2_event_motion_det - motion detection event
2190 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2191 * frame_sequence field is valid.
2192 * @frame_sequence: the frame sequence number associated with this event.
2193 * @region_mask: which regions detected motion.
2194 */
2195struct v4l2_event_motion_det {
2196 __u32 flags;
2197 __u32 frame_sequence;
2198 __u32 region_mask;
2199};
2200
David Howells607ca462012-10-13 10:46:48 +01002201struct v4l2_event {
2202 __u32 type;
2203 union {
2204 struct v4l2_event_vsync vsync;
2205 struct v4l2_event_ctrl ctrl;
2206 struct v4l2_event_frame_sync frame_sync;
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002207 struct v4l2_event_src_change src_change;
Hans Verkuil78ea6112014-01-27 09:26:23 -03002208 struct v4l2_event_motion_det motion_det;
David Howells607ca462012-10-13 10:46:48 +01002209 __u8 data[64];
2210 } u;
2211 __u32 pending;
2212 __u32 sequence;
2213 struct timespec timestamp;
2214 __u32 id;
2215 __u32 reserved[8];
2216};
2217
2218#define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
2219#define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
2220
2221struct v4l2_event_subscription {
2222 __u32 type;
2223 __u32 id;
2224 __u32 flags;
2225 __u32 reserved[5];
2226};
2227
2228/*
2229 * A D V A N C E D D E B U G G I N G
2230 *
2231 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2232 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2233 */
2234
2235/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2236
Hans Verkuil79b0c642013-03-18 12:16:34 -03002237#define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
Hans Verkuilb71c9982013-05-26 10:03:01 -03002238#define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
2239
2240/* The following four defines are no longer in use */
Hans Verkuil79b0c642013-03-18 12:16:34 -03002241#define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2242#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
2243#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Lad, Prabhakarff29feb2013-05-20 06:02:40 -03002244#define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
David Howells607ca462012-10-13 10:46:48 +01002245
2246struct v4l2_dbg_match {
2247 __u32 type; /* Match type */
2248 union { /* Match this chip, meaning determined by type */
2249 __u32 addr;
2250 char name[32];
2251 };
2252} __attribute__ ((packed));
2253
2254struct v4l2_dbg_register {
2255 struct v4l2_dbg_match match;
2256 __u32 size; /* register size in bytes */
2257 __u64 reg;
2258 __u64 val;
2259} __attribute__ ((packed));
2260
Hans Verkuil79b0c642013-03-18 12:16:34 -03002261#define V4L2_CHIP_FL_READABLE (1 << 0)
2262#define V4L2_CHIP_FL_WRITABLE (1 << 1)
2263
Hans Verkuil96b03d22013-04-06 06:16:58 -03002264/* VIDIOC_DBG_G_CHIP_INFO */
2265struct v4l2_dbg_chip_info {
Hans Verkuil79b0c642013-03-18 12:16:34 -03002266 struct v4l2_dbg_match match;
2267 char name[32];
2268 __u32 flags;
Hans Verkuilb8399b82013-04-08 11:53:55 -03002269 __u32 reserved[32];
Hans Verkuil79b0c642013-03-18 12:16:34 -03002270} __attribute__ ((packed));
2271
David Howells607ca462012-10-13 10:46:48 +01002272/**
2273 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2274 * @index: on return, index of the first created buffer
2275 * @count: entry: number of requested buffers,
2276 * return: number of created buffers
2277 * @memory: enum v4l2_memory; buffer memory type
2278 * @format: frame format, for which buffers are requested
2279 * @reserved: future extensions
2280 */
2281struct v4l2_create_buffers {
2282 __u32 index;
2283 __u32 count;
2284 __u32 memory;
2285 struct v4l2_format format;
2286 __u32 reserved[8];
2287};
2288
2289/*
2290 * 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
2291 *
2292 */
2293#define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
2294#define VIDIOC_RESERVED _IO('V', 1)
2295#define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
2296#define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
2297#define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
2298#define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
2299#define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
2300#define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
2301#define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
2302#define VIDIOC_OVERLAY _IOW('V', 14, int)
2303#define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
Tomasz Stanislawskib799d09a2012-06-14 11:32:23 -03002304#define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
David Howells607ca462012-10-13 10:46:48 +01002305#define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
2306#define VIDIOC_STREAMON _IOW('V', 18, int)
2307#define VIDIOC_STREAMOFF _IOW('V', 19, int)
2308#define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
2309#define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
2310#define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
2311#define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
2312#define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
2313#define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2314#define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2315#define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2316#define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2317#define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2318#define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2319#define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2320#define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2321#define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2322#define VIDIOC_G_INPUT _IOR('V', 38, int)
2323#define VIDIOC_S_INPUT _IOWR('V', 39, int)
Hans Verkuil254a4772014-03-04 07:46:47 -03002324#define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2325#define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
David Howells607ca462012-10-13 10:46:48 +01002326#define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2327#define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2328#define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2329#define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2330#define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2331#define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2332#define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2333#define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2334#define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2335#define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2336#define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2337#define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2338#define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2339#define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2340#define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2341#define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2342#define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2343#define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2344#define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
2345#define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
2346#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2347#define VIDIOC_LOG_STATUS _IO('V', 70)
2348#define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2349#define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2350#define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
David Howells607ca462012-10-13 10:46:48 +01002351#define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2352#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2353#define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2354#define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2355#define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
David Howells607ca462012-10-13 10:46:48 +01002356
Hans Verkuil57c759872016-04-22 06:06:58 -03002357/*
2358 * Experimental, meant for debugging, testing and internal use.
2359 * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2360 * You must be root to use these ioctls. Never use these in applications!
2361 */
David Howells607ca462012-10-13 10:46:48 +01002362#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2363#define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2364
David Howells607ca462012-10-13 10:46:48 +01002365#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
David Howells607ca462012-10-13 10:46:48 +01002366#define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2367#define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2368#define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2369#define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2370#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
David Howells607ca462012-10-13 10:46:48 +01002371#define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2372#define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
David Howells607ca462012-10-13 10:46:48 +01002373#define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2374#define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
David Howells607ca462012-10-13 10:46:48 +01002375#define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2376#define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
David Howells607ca462012-10-13 10:46:48 +01002377#define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2378#define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2379#define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
David Howells607ca462012-10-13 10:46:48 +01002380#define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2381
Hans Verkuil57c759872016-04-22 06:06:58 -03002382/*
2383 * Experimental, meant for debugging, testing and internal use.
2384 * Never use this in applications!
2385 */
Hans Verkuil96b03d22013-04-06 06:16:58 -03002386#define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
Hans Verkuil79b0c642013-03-18 12:16:34 -03002387
Hans Verkuil5082c242014-06-10 04:14:50 -03002388#define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2389
David Howells607ca462012-10-13 10:46:48 +01002390/* Reminder: when adding new ioctls please add support for them to
Ricardo Ribaldad9e7d222015-08-21 10:19:20 -03002391 drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
David Howells607ca462012-10-13 10:46:48 +01002392
2393#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2394
2395#endif /* _UAPI__LINUX_VIDEODEV2_H */