2 * Video for Linux Two header file
4 * Copyright (C) 1999-2012 the contributors
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * Alternatively you can redistribute this file under the terms of the
17 * BSD license as stated below:
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in
26 * the documentation and/or other materials provided with the
28 * 3. The names of its contributors may not be used to endorse or promote
29 * products derived from this software without specific prior written
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
38 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
39 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
40 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
41 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
42 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 * Header file for v4l or V4L2 drivers and applications
46 * All kernel-specific stuff were moved to media/v4l2-dev.h, so
47 * no #if __KERNEL tests are allowed here
49 * See http://linuxtv.org for more info
51 * Author: Bill Dirks <bill@thedirks.org>
53 * Hans Verkuil <hverkuil@xs4all.nl>
56 #ifndef __LINUX_VIDEODEV2_H
57 #define __LINUX_VIDEODEV2_H
60 #include <sys/ioctl.h>
61 #include <linux/types.h>
63 #include "ext/v4l2-common.h"
64 #include "ext/v4l2-controls.h"
67 * Common stuff for both V4L1 and V4L2
68 * Moved from videodev.h
70 #define VIDEO_MAX_FRAME 32
71 #define VIDEO_MAX_PLANES 8
74 * M I S C E L L A N E O U S
77 /* Four-character-code (FOURCC) */
78 #define v4l2_fourcc(a, b, c, d)\
79 ((__u32)(a) | ((__u32)(b) << 8) | ((__u32)(c) << 16) | ((__u32)(d) << 24))
85 V4L2_FIELD_ANY = 0, /* driver can choose from none,
86 top, bottom, interlaced
87 depending on whatever it thinks
89 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
90 V4L2_FIELD_TOP = 2, /* top field only */
91 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
92 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
93 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
94 buffer, top-bottom order */
95 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
96 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
98 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
99 first and the top field is
101 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
102 first and the bottom field is
105 #define V4L2_FIELD_HAS_TOP(field) \
106 ((field) == V4L2_FIELD_TOP ||\
107 (field) == V4L2_FIELD_INTERLACED ||\
108 (field) == V4L2_FIELD_INTERLACED_TB ||\
109 (field) == V4L2_FIELD_INTERLACED_BT ||\
110 (field) == V4L2_FIELD_SEQ_TB ||\
111 (field) == V4L2_FIELD_SEQ_BT)
112 #define V4L2_FIELD_HAS_BOTTOM(field) \
113 ((field) == V4L2_FIELD_BOTTOM ||\
114 (field) == V4L2_FIELD_INTERLACED ||\
115 (field) == V4L2_FIELD_INTERLACED_TB ||\
116 (field) == V4L2_FIELD_INTERLACED_BT ||\
117 (field) == V4L2_FIELD_SEQ_TB ||\
118 (field) == V4L2_FIELD_SEQ_BT)
119 #define V4L2_FIELD_HAS_BOTH(field) \
120 ((field) == V4L2_FIELD_INTERLACED ||\
121 (field) == V4L2_FIELD_INTERLACED_TB ||\
122 (field) == V4L2_FIELD_INTERLACED_BT ||\
123 (field) == V4L2_FIELD_SEQ_TB ||\
124 (field) == V4L2_FIELD_SEQ_BT)
127 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
128 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
129 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
130 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
131 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
132 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
133 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
136 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
138 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
139 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
140 /* Deprecated, do not use */
141 V4L2_BUF_TYPE_PRIVATE = 0x80,
144 #define V4L2_TYPE_IS_MULTIPLANAR(type) \
145 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
146 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
148 #define V4L2_TYPE_IS_OUTPUT(type) \
149 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
150 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
151 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
152 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
153 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
154 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT)
156 enum v4l2_tuner_type {
157 V4L2_TUNER_RADIO = 1,
158 V4L2_TUNER_ANALOG_TV = 2,
159 V4L2_TUNER_DIGITAL_TV = 3,
163 V4L2_MEMORY_MMAP = 1,
164 V4L2_MEMORY_USERPTR = 2,
165 V4L2_MEMORY_OVERLAY = 3,
166 V4L2_MEMORY_DMABUF = 4,
169 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
170 enum v4l2_colorspace {
171 /* ITU-R 601 -- broadcast NTSC/PAL */
172 V4L2_COLORSPACE_SMPTE170M = 1,
174 /* 1125-Line (US) HDTV */
175 V4L2_COLORSPACE_SMPTE240M = 2,
177 /* HD and modern captures. */
178 V4L2_COLORSPACE_REC709 = 3,
180 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
181 V4L2_COLORSPACE_BT878 = 4,
183 /* These should be useful. Assume 601 extents. */
184 V4L2_COLORSPACE_470_SYSTEM_M = 5,
185 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
187 /* I know there will be cameras that send this. So, this is
188 * unspecified chromaticities and full 0-255 on each of the
191 V4L2_COLORSPACE_JPEG = 7,
193 /* For RGB colourspaces, this is probably a good start. */
194 V4L2_COLORSPACE_SRGB = 8,
198 V4L2_PRIORITY_UNSET = 0, /* not initialized */
199 V4L2_PRIORITY_BACKGROUND = 1,
200 V4L2_PRIORITY_INTERACTIVE = 2,
201 V4L2_PRIORITY_RECORD = 3,
202 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
218 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
220 * @driver: name of the driver module (e.g. "bttv")
221 * @card: name of the card (e.g. "Hauppauge WinTV")
222 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
223 * @version: KERNEL_VERSION
224 * @capabilities: capabilities of the physical device as a whole
225 * @device_caps: capabilities accessed via this particular device (node)
226 * @reserved: reserved fields for future extensions
228 struct v4l2_capability {
238 /* Values for 'capabilities' field */
239 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
240 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
241 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
242 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
243 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
244 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
245 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
246 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
247 #define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
248 #define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
249 #define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
251 /* Is a video capture device that supports multiplanar formats */
252 #define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
253 /* Is a video output device that supports multiplanar formats */
254 #define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
255 /* Is a video mem-to-mem device that supports multiplanar formats */
256 #define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
257 /* Is a video mem-to-mem device */
258 #define V4L2_CAP_VIDEO_M2M 0x00008000
260 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
261 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
262 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
263 #define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
265 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
266 #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
267 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
269 #define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
272 * V I D E O I M A G E F O R M A T
274 struct v4l2_pix_format {
278 __u32 field; /* enum v4l2_field */
279 __u32 bytesperline; /* for padding, zero if unused */
281 __u32 colorspace; /* enum v4l2_colorspace */
282 __u32 priv; /* private data, depends on pixelformat */
285 /* Pixel format FOURCC depth Description */
288 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
289 #define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
290 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
291 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
292 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
293 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
294 #define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
295 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
296 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
297 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
298 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
301 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
302 #define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
303 #define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
304 #define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
305 #define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
306 #define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
308 /* Grey bit-packed formats */
309 #define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
311 /* Palette formats */
312 #define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
314 /* Chrominance formats */
315 #define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
317 /* Luminance+Chrominance formats */
318 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
319 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
320 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
321 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
322 #define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
323 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
324 #define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
325 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
326 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 16 YVU411 planar */
327 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
328 #define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
329 #define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
330 #define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
331 #define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
332 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
333 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
334 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
335 #define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
336 #define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
338 /* two planes -- one Y, one Cr + Cb interleaved */
339 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
340 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
341 #define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
342 #define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
343 #define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
344 #define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
346 /* two non contiguous planes - one Y, one Cr + Cb interleaved */
347 #define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
348 #define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
349 #define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
350 #define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
351 #define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
352 #define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 macroblocks */
354 /* three non contiguous planes - Y, Cb, Cr */
355 #define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
356 #define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
358 /* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
359 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
360 #define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
361 #define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
362 #define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
363 #define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
364 #define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
365 #define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
366 #define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
367 #define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
368 #define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
369 #define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
370 #define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
371 /* 10bit raw bayer a-law compressed to 8 bits */
372 #define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
373 #define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
374 #define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
375 #define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
376 /* 10bit raw bayer DPCM compressed to 8 bits */
377 #define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
378 #define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
379 #define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
380 #define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
382 * 10bit raw bayer, expanded to 16 bits
383 * xxxxrrrrrrrrrrxxxxgggggggggg xxxxggggggggggxxxxbbbbbbbbbb...
385 #define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
387 /* compressed formats */
388 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
389 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
390 #define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
391 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
392 #define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
393 #define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
394 #define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
395 #define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
396 #define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
397 #define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
398 #define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
399 #define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
400 #define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
401 #define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
402 #define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
404 /* Vendor-specific formats */
405 #define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
406 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
407 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
408 #define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
409 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
410 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
411 #define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
412 #define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
413 #define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
414 #define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
415 #define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
416 #define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
417 #define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
418 #define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
419 #define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
420 #define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
421 #define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
422 #define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
423 #define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
424 #define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
425 #define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
426 #define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
427 #define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
428 #define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
429 #define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
430 #define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
433 * F O R M A T E N U M E R A T I O N
435 struct v4l2_fmtdesc {
436 __u32 index; /* Format number */
437 __u32 type; /* enum v4l2_buf_type */
439 __u8 description[32]; /* Description string */
440 __u32 pixelformat; /* Format fourcc */
444 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
445 #define V4L2_FMT_FLAG_EMULATED 0x0002
448 /* Experimental Frame Size and frame rate enumeration */
450 * F R A M E S I Z E E N U M E R A T I O N
452 enum v4l2_frmsizetypes {
453 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
454 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
455 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
458 struct v4l2_frmsize_discrete {
459 __u32 width; /* Frame width [pixel] */
460 __u32 height; /* Frame height [pixel] */
463 struct v4l2_frmsize_stepwise {
464 __u32 min_width; /* Minimum frame width [pixel] */
465 __u32 max_width; /* Maximum frame width [pixel] */
466 __u32 step_width; /* Frame width step size [pixel] */
467 __u32 min_height; /* Minimum frame height [pixel] */
468 __u32 max_height; /* Maximum frame height [pixel] */
469 __u32 step_height; /* Frame height step size [pixel] */
472 struct v4l2_frmsizeenum {
473 __u32 index; /* Frame size number */
474 __u32 pixel_format; /* Pixel format */
475 __u32 type; /* Frame size type the device supports. */
477 union { /* Frame size */
478 struct v4l2_frmsize_discrete discrete;
479 struct v4l2_frmsize_stepwise stepwise;
482 __u32 reserved[2]; /* Reserved space for future use */
486 * F R A M E R A T E E N U M E R A T I O N
488 enum v4l2_frmivaltypes {
489 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
490 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
491 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
494 struct v4l2_frmival_stepwise {
495 struct v4l2_fract min; /* Minimum frame interval [s] */
496 struct v4l2_fract max; /* Maximum frame interval [s] */
497 struct v4l2_fract step; /* Frame interval step size [s] */
500 struct v4l2_frmivalenum {
501 __u32 index; /* Frame format index */
502 __u32 pixel_format; /* Pixel format */
503 __u32 width; /* Frame width */
504 __u32 height; /* Frame height */
505 __u32 type; /* Frame interval type the device supports. */
507 union { /* Frame interval */
508 struct v4l2_fract discrete;
509 struct v4l2_frmival_stepwise stepwise;
512 __u32 reserved[2]; /* Reserved space for future use */
519 struct v4l2_timecode {
530 #define V4L2_TC_TYPE_24FPS 1
531 #define V4L2_TC_TYPE_25FPS 2
532 #define V4L2_TC_TYPE_30FPS 3
533 #define V4L2_TC_TYPE_50FPS 4
534 #define V4L2_TC_TYPE_60FPS 5
537 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
538 #define V4L2_TC_FLAG_COLORFRAME 0x0002
539 #define V4L2_TC_USERBITS_field 0x000C
540 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
541 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
542 /* The above is based on SMPTE timecodes */
544 struct v4l2_jpegcompression {
547 int APPn; /* Number of APP segment to be written,
549 int APP_len; /* Length of data in JPEG APPn segment */
550 char APP_data[60]; /* Data in the JPEG APPn segment. */
552 int COM_len; /* Length of data in JPEG COM segment */
553 char COM_data[60]; /* Data in JPEG COM segment */
555 __u32 jpeg_markers; /* Which markers should go into the JPEG
556 * output. Unless you exactly know what
557 * you do, leave them untouched.
558 * Including less markers will make the
559 * resulting code smaller, but there will
560 * be fewer applications which can read it.
561 * The presence of the APP and COM marker
562 * is influenced by APP_len and COM_len
563 * ONLY, not by this property! */
565 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
566 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
567 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
568 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
569 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
574 * M E M O R Y - M A P P I N G B U F F E R S
576 struct v4l2_requestbuffers {
578 __u32 type; /* enum v4l2_buf_type */
579 __u32 memory; /* enum v4l2_memory */
584 * struct v4l2_plane - plane info for multi-planar buffers
585 * @bytesused: number of bytes occupied by data in the plane (payload)
586 * @length: size of this plane (NOT the payload) in bytes
587 * @mem_offset: when memory in the associated struct v4l2_buffer is
588 * V4L2_MEMORY_MMAP, equals the offset from the start of
589 * the device memory for this plane (or is a "cookie" that
590 * should be passed to mmap() called on the video node)
591 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
592 * pointing to this plane
593 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
594 * descriptor associated with this plane
595 * @data_offset: offset in the plane to the start of data; usually 0,
596 * unless there is a header in front of the data
598 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
599 * with two planes can have one plane for Y, and another for interleaved CbCr
600 * components. Each plane can reside in a separate memory buffer, or even in
601 * a completely separate memory node (e.g. in embedded devices).
608 unsigned long userptr;
616 * struct v4l2_buffer - video buffer info
617 * @index: id number of the buffer
618 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
619 * multiplanar buffers);
620 * @bytesused: number of bytes occupied by data in the buffer (payload);
621 * unused (set to 0) for multiplanar buffers
622 * @flags: buffer informational flags
623 * @field: enum v4l2_field; field order of the image in the buffer
624 * @timestamp: frame timestamp
625 * @timecode: frame timecode
626 * @sequence: sequence count of this frame
627 * @memory: enum v4l2_memory; the method, in which the actual video data is
629 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
630 * offset from the start of the device memory for this plane,
631 * (or a "cookie" that should be passed to mmap() as offset)
632 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
633 * a userspace pointer pointing to this buffer
634 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
635 * a userspace file descriptor associated with this buffer
636 * @planes: for multiplanar buffers; userspace pointer to the array of plane
637 * info structs for this buffer
638 * @length: size in bytes of the buffer (NOT its payload) for single-plane
639 * buffers (when type != *_MPLANE); number of elements in the
640 * planes array for multi-plane buffers
641 * @input: input number from which the video data has has been captured
643 * Contains data exchanged by application and driver using one of the Streaming
652 struct timeval timestamp;
653 struct v4l2_timecode timecode;
656 /* memory location */
660 unsigned long userptr;
661 struct v4l2_plane *planes;
669 /* Flags for 'flags' field */
670 #define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
671 #define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
672 #define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
673 #define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
674 #define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
675 #define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
676 /* Buffer is ready, but the data contained within is corrupted. */
677 #define V4L2_BUF_FLAG_ERROR 0x0040
678 #define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
679 #define V4L2_BUF_FLAG_PREPARED 0x0400 /* Buffer is prepared for queuing */
680 /* Cache handling flags */
681 #define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x0800
682 #define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x1000
684 #define V4L2_BUF_FLAG_TIMESTAMP_MASK 0xe000
685 #define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x0000
686 #define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x2000
687 #define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x4000
690 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
692 * @index: id number of the buffer
693 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
694 * multiplanar buffers);
695 * @plane: index of the plane to be exported, 0 for single plane queues
696 * @flags: flags for newly created file, currently only O_CLOEXEC is
697 * supported, refer to manual of open syscall for more details
698 * @fd: file descriptor associated with DMABUF (set by driver)
700 * Contains data used for exporting a video buffer as DMABUF file descriptor.
701 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
702 * (identical to the cookie used to mmap() the buffer to userspace). All
703 * reserved fields must be set to zero. The field reserved0 is expected to
704 * become a structure 'type' allowing an alternative layout of the structure
705 * content. Therefore this field should not be used for any other extensions.
707 struct v4l2_exportbuffer {
708 __u32 type; /* enum v4l2_buf_type */
717 * O V E R L A Y P R E V I E W
719 struct v4l2_framebuffer {
722 /* FIXME: in theory we should pass something like PCI device + memory
723 * region + offset instead of some physical address */
725 struct v4l2_pix_format fmt;
727 /* Flags for the 'capability' field. Read only */
728 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
729 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
730 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
731 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
732 #define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
733 #define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
734 #define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
735 #define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
736 /* Flags for the 'flags' field. */
737 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
738 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
739 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
740 #define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
741 #define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
742 #define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
743 #define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
747 struct v4l2_clip *next;
752 __u32 field; /* enum v4l2_field */
754 struct v4l2_clip *clips;
761 * C A P T U R E P A R A M E T E R S
763 struct v4l2_captureparm {
764 __u32 capability; /* Supported modes */
765 __u32 capturemode; /* Current mode */
766 struct v4l2_fract timeperframe; /* Time per frame in seconds */
767 __u32 extendedmode; /* Driver-specific extensions */
768 __u32 readbuffers; /* # of buffers for read */
772 /* Flags for 'capability' and 'capturemode' fields */
773 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
774 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
776 struct v4l2_outputparm {
777 __u32 capability; /* Supported modes */
778 __u32 outputmode; /* Current mode */
779 struct v4l2_fract timeperframe; /* Time per frame in seconds */
780 __u32 extendedmode; /* Driver-specific extensions */
781 __u32 writebuffers; /* # of buffers for write */
786 * I N P U T I M A G E C R O P P I N G
788 struct v4l2_cropcap {
789 __u32 type; /* enum v4l2_buf_type */
790 struct v4l2_rect bounds;
791 struct v4l2_rect defrect;
792 struct v4l2_fract pixelaspect;
796 __u32 type; /* enum v4l2_buf_type */
801 * struct v4l2_selection - selection info
802 * @type: buffer type (do not use *_MPLANE types)
803 * @target: Selection target, used to choose one of possible rectangles;
804 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
805 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
806 * @r: coordinates of selection window
807 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
809 * Hardware may use multiple helper windows to process a video stream.
810 * The structure is used to exchange this selection areas between
811 * an application and a driver.
813 struct v4l2_selection {
823 * A N A L O G V I D E O S T A N D A R D
826 typedef __u64 v4l2_std_id;
828 /* one bit for each */
829 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
830 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
831 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
832 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
833 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
834 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
835 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
836 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
838 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
839 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
840 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
841 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
843 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
844 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
845 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
846 #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
848 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
849 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
850 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
851 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
852 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
853 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
854 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
855 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
858 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
859 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
862 Although std_id is 64 bits, there is an issue on PPC32 architecture that
863 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
864 this value to 32 bits.
865 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
866 it should work fine. However, if needed to add more than two standards,
867 v4l2-common.c should be fixed.
871 * Some macros to merge video standards in order to make live easier for the
872 * drivers and V4L2 applications
876 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
879 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
880 V4L2_STD_NTSC_M_JP |\
883 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
886 /* All Secam Standards */
887 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
894 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
897 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
901 * "Common" PAL - This macro is there to be compatible with the old
902 * V4L1 concept of "PAL": /BGDKHI.
903 * Several PAL standards are missing here: /M, /N and /Nc
905 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
909 /* Chroma "agnostic" standards */
910 #define V4L2_STD_B (V4L2_STD_PAL_B |\
913 #define V4L2_STD_G (V4L2_STD_PAL_G |\
915 #define V4L2_STD_H (V4L2_STD_PAL_H |\
917 #define V4L2_STD_L (V4L2_STD_SECAM_L |\
919 #define V4L2_STD_GH (V4L2_STD_G |\
921 #define V4L2_STD_DK (V4L2_STD_PAL_DK |\
923 #define V4L2_STD_BG (V4L2_STD_B |\
925 #define V4L2_STD_MN (V4L2_STD_PAL_M |\
930 /* Standards where MTS/BTSC stereo could be found */
931 #define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
936 /* Standards for Countries with 60Hz Line frequency */
937 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
941 /* Standards for Countries with 50Hz Line frequency */
942 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
947 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
948 V4L2_STD_ATSC_16_VSB)
949 /* Macros with none and all analog standards */
950 #define V4L2_STD_UNKNOWN 0
951 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
954 struct v4l2_standard {
958 struct v4l2_fract frameperiod; /* Frames, not fields */
964 * D V B T T I M I N G S
967 /** struct v4l2_bt_timings - BT.656/BT.1120 timing data
968 * @width: total width of the active video in pixels
969 * @height: total height of the active video in lines
970 * @interlaced: Interlaced or progressive
971 * @polarities: Positive or negative polarities
972 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
973 * @hfrontporch:Horizontal front porch in pixels
974 * @hsync: Horizontal Sync length in pixels
975 * @hbackporch: Horizontal back porch in pixels
976 * @vfrontporch:Vertical front porch in lines
977 * @vsync: Vertical Sync length in lines
978 * @vbackporch: Vertical back porch in lines
979 * @il_vfrontporch:Vertical front porch for the even field
980 * (aka field 2) of interlaced field formats
981 * @il_vsync: Vertical Sync length for the even field
982 * (aka field 2) of interlaced field formats
983 * @il_vbackporch:Vertical back porch for the even field
984 * (aka field 2) of interlaced field formats
985 * @standards: Standards the timing belongs to
987 * @reserved: Reserved fields, must be zeroed.
989 * A note regarding vertical interlaced timings: height refers to the total
990 * height of the active video frame (= two fields). The blanking timings refer
991 * to the blanking of each field. So the height of the total frame is
992 * calculated as follows:
994 * tot_height = height + vfrontporch + vsync + vbackporch +
995 * il_vfrontporch + il_vsync + il_vbackporch
997 * The active height of each field is height / 2.
999 struct v4l2_bt_timings {
1011 __u32 il_vfrontporch;
1013 __u32 il_vbackporch;
1017 } __attribute__ ((packed));
1019 /* Interlaced or progressive format */
1020 #define V4L2_DV_PROGRESSIVE 0
1021 #define V4L2_DV_INTERLACED 1
1023 /* Polarities. If bit is not set, it is assumed to be negative polarity */
1024 #define V4L2_DV_VSYNC_POS_POL 0x00000001
1025 #define V4L2_DV_HSYNC_POS_POL 0x00000002
1027 /* Timings standards */
1028 #define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1029 #define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1030 #define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1031 #define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
1035 /* CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1036 GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1037 intervals are reduced, allowing a higher resolution over the same
1038 bandwidth. This is a read-only flag. */
1039 #define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1040 /* CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1041 of six. These formats can be optionally played at 1 / 1.001 speed.
1042 This is a read-only flag. */
1043 #define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1044 /* CEA-861 specific: only valid for video transmitters, the flag is cleared
1046 If the framerate of the format is a multiple of six, then the pixelclock
1047 used to set up the transmitter is divided by 1.001 to make it compatible
1048 with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1049 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1050 such frequencies, then the flag will also be cleared. */
1051 #define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1052 /* Specific to interlaced formats: if set, then field 1 is really one half-line
1053 longer and field 2 is really one half-line shorter, so each field has
1054 exactly the same number of half-lines. Whether half-lines can be detected
1055 or used depends on the hardware. */
1056 #define V4L2_DV_FL_HALF_LINE (1 << 3)
1058 /* A few useful defines to calculate the total blanking and frame sizes */
1059 #define V4L2_DV_BT_BLANKING_WIDTH(bt) \
1060 (bt->hfrontporch + bt->hsync + bt->hbackporch)
1061 #define V4L2_DV_BT_FRAME_WIDTH(bt) \
1062 (bt->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
1063 #define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
1064 (bt->vfrontporch + bt->vsync + bt->vbackporch + \
1065 bt->il_vfrontporch + bt->il_vsync + bt->il_vbackporch)
1066 #define V4L2_DV_BT_FRAME_HEIGHT(bt) \
1067 (bt->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
1069 /** struct v4l2_dv_timings - DV timings
1070 * @type: the type of the timings
1071 * @bt: BT656/1120 timings
1073 struct v4l2_dv_timings {
1076 struct v4l2_bt_timings bt;
1079 } __attribute__ ((packed));
1081 /* Values for the type field */
1082 #define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1085 /** struct v4l2_enum_dv_timings - DV timings enumeration
1086 * @index: enumeration index
1087 * @reserved: must be zeroed
1088 * @timings: the timings for the given index
1090 struct v4l2_enum_dv_timings {
1093 struct v4l2_dv_timings timings;
1096 /** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1097 * @min_width: width in pixels
1098 * @max_width: width in pixels
1099 * @min_height: height in lines
1100 * @max_height: height in lines
1101 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1102 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1103 * @standards: Supported standards
1104 * @capabilities: Supported capabilities
1105 * @reserved: Must be zeroed
1107 struct v4l2_bt_timings_cap {
1112 __u64 min_pixelclock;
1113 __u64 max_pixelclock;
1117 } __attribute__ ((packed));
1119 /* Supports interlaced formats */
1120 #define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1121 /* Supports progressive formats */
1122 #define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1123 /* Supports CVT/GTF reduced blanking */
1124 #define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1125 /* Supports custom formats */
1126 #define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1128 /** struct v4l2_dv_timings_cap - DV timings capabilities
1129 * @type: the type of the timings (same as in struct v4l2_dv_timings)
1130 * @bt: the BT656/1120 timings capabilities
1132 struct v4l2_dv_timings_cap {
1136 struct v4l2_bt_timings_cap bt;
1143 * V I D E O I N P U T S
1146 __u32 index; /* Which input */
1147 __u8 name[32]; /* Label */
1148 __u32 type; /* Type of input */
1149 __u32 audioset; /* Associated audios (bitfield) */
1150 __u32 tuner; /* enum v4l2_tuner_type */
1157 /* Values for the 'type' field */
1158 #define V4L2_INPUT_TYPE_TUNER 1
1159 #define V4L2_INPUT_TYPE_CAMERA 2
1161 /* field 'status' - general */
1162 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1163 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
1164 #define V4L2_IN_ST_NO_COLOR 0x00000004
1166 /* field 'status' - sensor orientation */
1167 /* If sensor is mounted upside down set both bits */
1168 #define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1169 #define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1171 /* field 'status' - analog */
1172 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1173 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1175 /* field 'status' - digital */
1176 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1177 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1178 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1180 /* field 'status' - VCR and set-top box */
1181 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1182 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1183 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1185 /* capabilities flags */
1186 #define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1187 #define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1188 #define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
1191 * V I D E O O U T P U T S
1193 struct v4l2_output {
1194 __u32 index; /* Which output */
1195 __u8 name[32]; /* Label */
1196 __u32 type; /* Type of output */
1197 __u32 audioset; /* Associated audios (bitfield) */
1198 __u32 modulator; /* Associated modulator */
1203 /* Values for the 'type' field */
1204 #define V4L2_OUTPUT_TYPE_MODULATOR 1
1205 #define V4L2_OUTPUT_TYPE_ANALOG 2
1206 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1208 /* capabilities flags */
1209 #define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1210 #define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1211 #define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
1216 struct v4l2_control {
1221 struct v4l2_ext_control {
1230 } __attribute__ ((packed));
1232 struct v4l2_ext_controls {
1237 struct v4l2_ext_control *controls;
1240 #define V4L2_CTRL_ID_MASK (0x0fffffff)
1241 #define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1242 #define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1244 enum v4l2_ctrl_type {
1245 V4L2_CTRL_TYPE_INTEGER = 1,
1246 V4L2_CTRL_TYPE_BOOLEAN = 2,
1247 V4L2_CTRL_TYPE_MENU = 3,
1248 V4L2_CTRL_TYPE_BUTTON = 4,
1249 V4L2_CTRL_TYPE_INTEGER64 = 5,
1250 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1251 V4L2_CTRL_TYPE_STRING = 7,
1252 V4L2_CTRL_TYPE_BITMASK = 8,
1253 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1256 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1257 struct v4l2_queryctrl {
1259 __u32 type; /* enum v4l2_ctrl_type */
1260 __u8 name[32]; /* Whatever */
1261 __s32 minimum; /* Note signedness */
1264 __s32 default_value;
1269 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1270 struct v4l2_querymenu {
1274 __u8 name[32]; /* Whatever */
1278 } __attribute__ ((packed));
1281 #define V4L2_CTRL_FLAG_DISABLED 0x0001
1282 #define V4L2_CTRL_FLAG_GRABBED 0x0002
1283 #define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1284 #define V4L2_CTRL_FLAG_UPDATE 0x0008
1285 #define V4L2_CTRL_FLAG_INACTIVE 0x0010
1286 #define V4L2_CTRL_FLAG_SLIDER 0x0020
1287 #define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1288 #define V4L2_CTRL_FLAG_VOLATILE 0x0080
1290 /* Query flag, to be ORed with the control ID */
1291 #define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1293 /* User-class control IDs defined by V4L2 */
1294 #define V4L2_CID_MAX_CTRLS 1024
1295 /* IDs reserved for driver specific controls */
1296 #define V4L2_CID_PRIVATE_BASE 0x08000000
1305 __u32 type; /* enum v4l2_tuner_type */
1316 struct v4l2_modulator {
1326 /* Flags for the 'capability' field */
1327 #define V4L2_TUNER_CAP_LOW 0x0001
1328 #define V4L2_TUNER_CAP_NORM 0x0002
1329 #define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1330 #define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1331 #define V4L2_TUNER_CAP_STEREO 0x0010
1332 #define V4L2_TUNER_CAP_LANG2 0x0020
1333 #define V4L2_TUNER_CAP_SAP 0x0020
1334 #define V4L2_TUNER_CAP_LANG1 0x0040
1335 #define V4L2_TUNER_CAP_RDS 0x0080
1336 #define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1337 #define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1338 #define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1339 #define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
1341 /* Flags for the 'rxsubchans' field */
1342 #define V4L2_TUNER_SUB_MONO 0x0001
1343 #define V4L2_TUNER_SUB_STEREO 0x0002
1344 #define V4L2_TUNER_SUB_LANG2 0x0004
1345 #define V4L2_TUNER_SUB_SAP 0x0004
1346 #define V4L2_TUNER_SUB_LANG1 0x0008
1347 #define V4L2_TUNER_SUB_RDS 0x0010
1349 /* Values for the 'audmode' field */
1350 #define V4L2_TUNER_MODE_MONO 0x0000
1351 #define V4L2_TUNER_MODE_STEREO 0x0001
1352 #define V4L2_TUNER_MODE_LANG2 0x0002
1353 #define V4L2_TUNER_MODE_SAP 0x0002
1354 #define V4L2_TUNER_MODE_LANG1 0x0003
1355 #define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1357 struct v4l2_frequency {
1359 __u32 type; /* enum v4l2_tuner_type */
1364 #define V4L2_BAND_MODULATION_VSB (1 << 1)
1365 #define V4L2_BAND_MODULATION_FM (1 << 2)
1366 #define V4L2_BAND_MODULATION_AM (1 << 3)
1368 struct v4l2_frequency_band {
1370 __u32 type; /* enum v4l2_tuner_type */
1379 struct v4l2_hw_freq_seek {
1381 __u32 type; /* enum v4l2_tuner_type */
1394 struct v4l2_rds_data {
1398 } __attribute__ ((packed));
1400 #define V4L2_RDS_BLOCK_MSK 0x7
1401 #define V4L2_RDS_BLOCK_A 0
1402 #define V4L2_RDS_BLOCK_B 1
1403 #define V4L2_RDS_BLOCK_C 2
1404 #define V4L2_RDS_BLOCK_D 3
1405 #define V4L2_RDS_BLOCK_C_ALT 4
1406 #define V4L2_RDS_BLOCK_INVALID 7
1408 #define V4L2_RDS_BLOCK_CORRECTED 0x40
1409 #define V4L2_RDS_BLOCK_ERROR 0x80
1422 /* Flags for the 'capability' field */
1423 #define V4L2_AUDCAP_STEREO 0x00001
1424 #define V4L2_AUDCAP_AVL 0x00002
1426 /* Flags for the 'mode' field */
1427 #define V4L2_AUDMODE_AVL 0x00001
1429 struct v4l2_audioout {
1438 * M P E G S E R V I C E S
1440 * NOTE: EXPERIMENTAL API
1443 #define V4L2_ENC_IDX_FRAME_I (0)
1444 #define V4L2_ENC_IDX_FRAME_P (1)
1445 #define V4L2_ENC_IDX_FRAME_B (2)
1446 #define V4L2_ENC_IDX_FRAME_MASK (0xf)
1448 struct v4l2_enc_idx_entry {
1456 #define V4L2_ENC_IDX_ENTRIES (64)
1457 struct v4l2_enc_idx {
1461 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1465 #define V4L2_ENC_CMD_START (0)
1466 #define V4L2_ENC_CMD_STOP (1)
1467 #define V4L2_ENC_CMD_PAUSE (2)
1468 #define V4L2_ENC_CMD_RESUME (3)
1470 /* Flags for V4L2_ENC_CMD_STOP */
1471 #define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1473 struct v4l2_encoder_cmd {
1483 /* Decoder commands */
1484 #define V4L2_DEC_CMD_START (0)
1485 #define V4L2_DEC_CMD_STOP (1)
1486 #define V4L2_DEC_CMD_PAUSE (2)
1487 #define V4L2_DEC_CMD_RESUME (3)
1489 /* Flags for V4L2_DEC_CMD_START */
1490 #define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1492 /* Flags for V4L2_DEC_CMD_PAUSE */
1493 #define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
1495 /* Flags for V4L2_DEC_CMD_STOP */
1496 #define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
1497 #define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
1499 /* Play format requirements (returned by the driver): */
1501 /* The decoder has no special format requirements */
1502 #define V4L2_DEC_START_FMT_NONE (0)
1503 /* The decoder requires full GOPs */
1504 #define V4L2_DEC_START_FMT_GOP (1)
1506 /* The structure must be zeroed before use by the application
1507 This ensures it can be extended safely in the future. */
1508 struct v4l2_decoder_cmd {
1517 /* 0 or 1000 specifies normal speed,
1518 1 specifies forward single stepping,
1519 -1 specifies backward single stepping,
1520 >1: playback at speed/1000 of the normal speed,
1521 <-1: reverse playback at (-speed/1000) of the normal speed. */
1535 * D A T A S E R V I C E S ( V B I )
1537 * Data services API by Michael Schimek
1541 struct v4l2_vbi_format {
1542 __u32 sampling_rate; /* in 1 Hz */
1544 __u32 samples_per_line;
1545 __u32 sample_format; /* V4L2_PIX_FMT_* */
1548 __u32 flags; /* V4L2_VBI_* */
1549 __u32 reserved[2]; /* must be zero */
1553 #define V4L2_VBI_UNSYNC (1 << 0)
1554 #define V4L2_VBI_INTERLACED (1 << 1)
1558 * This implements is a proposal V4L2 API to allow SLICED VBI
1559 * required for some hardware encoders. It should change without
1560 * notice in the definitive implementation.
1563 struct v4l2_sliced_vbi_format {
1565 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1566 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1567 (equals frame lines 313-336 for 625 line video
1568 standards, 263-286 for 525 line standards) */
1569 __u16 service_lines[2][24];
1571 __u32 reserved[2]; /* must be zero */
1574 /* Teletext World System Teletext
1575 (WST), defined on ITU-R BT.653-2 */
1576 #define V4L2_SLICED_TELETEXT_B (0x0001)
1577 /* Video Program System, defined on ETS 300 231*/
1578 #define V4L2_SLICED_VPS (0x0400)
1579 /* Closed Caption, defined on EIA-608 */
1580 #define V4L2_SLICED_CAPTION_525 (0x1000)
1581 /* Wide Screen System, defined on ITU-R BT1119.1 */
1582 #define V4L2_SLICED_WSS_625 (0x4000)
1584 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1585 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
1587 struct v4l2_sliced_vbi_cap {
1589 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1590 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1591 (equals frame lines 313-336 for 625 line video
1592 standards, 263-286 for 525 line standards) */
1593 __u16 service_lines[2][24];
1594 __u32 type; /* enum v4l2_buf_type */
1595 __u32 reserved[3]; /* must be 0 */
1598 struct v4l2_sliced_vbi_data {
1600 __u32 field; /* 0: first field, 1: second field */
1601 __u32 line; /* 1-23 */
1602 __u32 reserved; /* must be 0 */
1607 * Sliced VBI data inserted into MPEG Streams
1611 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1613 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1614 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1617 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1618 * definitions are not included here. See the MPEG-2 specifications for details
1623 #define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
1624 #define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
1625 #define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
1626 #define V4L2_MPEG_VBI_IVTV_VPS (7)
1628 struct v4l2_mpeg_vbi_itv0_line {
1629 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
1630 __u8 data[42]; /* Sliced VBI data for the line */
1631 } __attribute__ ((packed));
1633 struct v4l2_mpeg_vbi_itv0 {
1634 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
1635 struct v4l2_mpeg_vbi_itv0_line line[35];
1636 } __attribute__ ((packed));
1638 struct v4l2_mpeg_vbi_ITV0 {
1639 struct v4l2_mpeg_vbi_itv0_line line[36];
1640 } __attribute__ ((packed));
1642 #define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
1643 #define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
1645 struct v4l2_mpeg_vbi_fmt_ivtv {
1648 struct v4l2_mpeg_vbi_itv0 itv0;
1649 struct v4l2_mpeg_vbi_ITV0 ITV0;
1651 } __attribute__ ((packed));
1654 * A G G R E G A T E S T R U C T U R E S
1658 * struct v4l2_plane_pix_format - additional, per-plane format definition
1659 * @sizeimage: maximum size in bytes required for data, for which
1660 * this plane will be used
1661 * @bytesperline: distance in bytes between the leftmost pixels in two
1664 struct v4l2_plane_pix_format {
1668 } __attribute__ ((packed));
1671 * struct v4l2_pix_format_mplane - multiplanar format definition
1672 * @width: image width in pixels
1673 * @height: image height in pixels
1674 * @pixelformat: little endian four character code (fourcc)
1675 * @field: enum v4l2_field; field order (for interlaced video)
1676 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
1677 * @plane_fmt: per-plane information
1678 * @num_planes: number of planes for this format
1680 struct v4l2_pix_format_mplane {
1687 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
1690 } __attribute__ ((packed));
1693 * struct v4l2_format - stream data format
1694 * @type: enum v4l2_buf_type; type of the data stream
1695 * @pix: definition of an image format
1696 * @pix_mp: definition of a multiplanar image format
1697 * @win: definition of an overlaid image
1698 * @vbi: raw VBI capture or output parameters
1699 * @sliced: sliced VBI capture or output parameters
1700 * @raw_data: placeholder for future extensions and custom formats
1702 struct v4l2_format {
1705 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
1706 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
1707 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
1708 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
1709 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
1710 __u8 raw_data[200]; /* user-defined */
1714 /* Stream type-dependent parameters
1716 struct v4l2_streamparm {
1717 __u32 type; /* enum v4l2_buf_type */
1719 struct v4l2_captureparm capture;
1720 struct v4l2_outputparm output;
1721 __u8 raw_data[200]; /* user-defined */
1729 #define V4L2_EVENT_ALL 0
1730 #define V4L2_EVENT_VSYNC 1
1731 #define V4L2_EVENT_EOS 2
1732 #define V4L2_EVENT_CTRL 3
1733 #define V4L2_EVENT_FRAME_SYNC 4
1734 #define V4L2_EVENT_PRIVATE_START 0x08000000
1736 /* Payload for V4L2_EVENT_VSYNC */
1737 struct v4l2_event_vsync {
1738 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
1740 } __attribute__ ((packed));
1742 /* Payload for V4L2_EVENT_CTRL */
1743 #define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
1744 #define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
1745 #define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
1747 struct v4l2_event_ctrl {
1758 __s32 default_value;
1761 struct v4l2_event_frame_sync {
1762 __u32 frame_sequence;
1768 struct v4l2_event_vsync vsync;
1769 struct v4l2_event_ctrl ctrl;
1770 struct v4l2_event_frame_sync frame_sync;
1775 struct timespec timestamp;
1780 #define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
1781 #define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
1783 struct v4l2_event_subscription {
1791 * A D V A N C E D D E B U G G I N G
1793 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
1794 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
1797 /* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
1799 #define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
1800 #define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
1802 /* The following four defines are no longer in use */
1803 #define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
1804 #define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
1805 #define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
1806 #define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
1808 struct v4l2_dbg_match {
1809 __u32 type; /* Match type */
1810 union { /* Match this chip, meaning determined by type */
1814 } __attribute__ ((packed));
1816 struct v4l2_dbg_register {
1817 struct v4l2_dbg_match match;
1818 __u32 size; /* register size in bytes */
1821 } __attribute__ ((packed));
1823 #define V4L2_CHIP_FL_READABLE (1 << 0)
1824 #define V4L2_CHIP_FL_WRITABLE (1 << 1)
1826 /* VIDIOC_DBG_G_CHIP_INFO */
1827 struct v4l2_dbg_chip_info {
1828 struct v4l2_dbg_match match;
1832 } __attribute__ ((packed));
1835 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
1836 * @index: on return, index of the first created buffer
1837 * @count: entry: number of requested buffers,
1838 * return: number of created buffers
1839 * @memory: enum v4l2_memory; buffer memory type
1840 * @format: frame format, for which buffers are requested
1841 * @reserved: future extensions
1843 struct v4l2_create_buffers {
1847 struct v4l2_format format;
1852 * 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
1855 #define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
1856 #define VIDIOC_RESERVED _IO('V', 1)
1857 #define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
1858 #define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
1859 #define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
1860 #define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
1861 #define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
1862 #define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
1863 #define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
1864 #define VIDIOC_OVERLAY _IOW('V', 14, int)
1865 #define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
1866 #define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
1867 #define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
1868 #define VIDIOC_STREAMON _IOW('V', 18, int)
1869 #define VIDIOC_STREAMOFF _IOW('V', 19, int)
1870 #define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
1871 #define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
1872 #define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
1873 #define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
1874 #define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
1875 #define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
1876 #define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
1877 #define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
1878 #define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
1879 #define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
1880 #define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
1881 #define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
1882 #define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
1883 #define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
1884 #define VIDIOC_G_INPUT _IOR('V', 38, int)
1885 #define VIDIOC_S_INPUT _IOWR('V', 39, int)
1886 #define VIDIOC_G_OUTPUT _IOR('V', 46, int)
1887 #define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
1888 #define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
1889 #define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
1890 #define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
1891 #define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
1892 #define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
1893 #define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
1894 #define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
1895 #define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
1896 #define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
1897 #define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
1898 #define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
1899 #define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
1900 #define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
1901 #define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
1902 #define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
1903 #define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
1904 #define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
1905 #define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
1906 #define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
1907 #define VIDIOC_LOG_STATUS _IO('V', 70)
1908 #define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
1909 #define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
1910 #define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
1911 #define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
1912 #define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
1913 #define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
1914 #define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
1915 #define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
1917 /* Experimental, meant for debugging, testing and internal use.
1918 Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
1919 You must be root to use these ioctls. Never use these in applications! */
1920 #define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
1921 #define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
1923 #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
1925 #define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
1926 #define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
1927 #define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
1928 #define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
1929 #define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
1931 /* Experimental, the below two ioctls may change over the next couple of kernel
1933 #define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
1934 #define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
1936 /* Experimental selection API */
1937 #define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
1938 #define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
1940 /* Experimental, these two ioctls may change over the next couple of kernel
1942 #define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
1943 #define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
1945 /* Experimental, these three ioctls may change over the next couple of kernel
1947 #define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
1948 #define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
1949 #define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
1951 /* Experimental, this ioctl may change over the next couple of kernel
1953 #define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
1955 /* Experimental, meant for debugging, testing and internal use.
1956 Never use these in applications! */
1957 #define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
1959 /* Reminder: when adding new ioctls please add support for them to
1960 drivers/media/video/v4l2-compat-ioctl32.c as well! */
1962 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1964 #endif /* __LINUX_VIDEODEV2_H */