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