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