blob: 8a4c309d23444450a13a9e675cdc51e4a14376f4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Michael Schimekb1e7df12007-02-07 09:15:01 -03002 * Video for Linux Two header file
3 *
4 * Copyright (C) 1999-2007 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 *
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030044 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 *
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030049 * See http://linuxtv.org for more info
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 *
Mauro Carvalho Chehab43db48d2007-01-09 11:20:59 -030051 * Author: Bill Dirks <bill@thedirks.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * Justin Schoeman
Michael Schimekb1e7df12007-02-07 09:15:01 -030053 * Hans Verkuil <hverkuil@xs4all.nl>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * et al.
55 */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030056#ifndef __LINUX_VIDEODEV2_H
57#define __LINUX_VIDEODEV2_H
David Woodhouse5e6b83e2008-08-16 11:55:04 +010058
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030059#ifdef __KERNEL__
Mauro Carvalho Chehab89a58c82006-06-17 07:57:03 -030060#include <linux/time.h> /* need struct timeval */
Mauro Carvalho Chehab89a58c82006-06-17 07:57:03 -030061#else
Hans Verkuil3d58ffe2007-07-18 18:41:08 -030062#include <sys/time.h>
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030063#endif
David Woodhouse5e6b83e2008-08-16 11:55:04 +010064#include <linux/compiler.h>
Jiri Slaby83db33a2008-02-13 20:04:49 -030065#include <linux/ioctl.h>
David Mosberger-Tangc003d462006-05-26 10:28:13 -030066#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080068/*
69 * Common stuff for both V4L1 and V4L2
70 * Moved from videodev.h
71 */
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080072#define VIDEO_MAX_FRAME 32
Pawel Osciakf8f39142010-07-29 14:44:25 -030073#define VIDEO_MAX_PLANES 8
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080074
Hans Verkuilc1d7f4f2008-07-26 08:33:47 -030075#ifndef __KERNEL__
76
77/* These defines are V4L1 specific and should not be used with the V4L2 API!
78 They will be removed from this header in the future. */
79
Michael Schimekc12097f2005-11-08 21:38:24 -080080#define VID_TYPE_CAPTURE 1 /* Can capture */
81#define VID_TYPE_TUNER 2 /* Can tune */
82#define VID_TYPE_TELETEXT 4 /* Does teletext */
83#define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
84#define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
85#define VID_TYPE_CLIPPING 32 /* Can clip */
86#define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
87#define VID_TYPE_SCALES 128 /* Scalable */
88#define VID_TYPE_MONOCHROME 256 /* Monochrome only */
89#define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
90#define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
91#define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
92#define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
93#define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
Hans Verkuilc1d7f4f2008-07-26 08:33:47 -030094#endif
Michael Schimekc12097f2005-11-08 21:38:24 -080095
Linus Torvalds1da177e2005-04-16 15:20:36 -070096/*
97 * M I S C E L L A N E O U S
98 */
99
100/* Four-character-code (FOURCC) */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300101#define v4l2_fourcc(a, b, c, d)\
102 ((__u32)(a) | ((__u32)(b) << 8) | ((__u32)(c) << 16) | ((__u32)(d) << 24))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104/*
105 * E N U M S
106 */
107enum v4l2_field {
Hans Verkuilb2787842007-04-27 12:31:02 -0300108 V4L2_FIELD_ANY = 0, /* driver can choose from none,
109 top, bottom, interlaced
110 depending on whatever it thinks
111 is approximate ... */
112 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
113 V4L2_FIELD_TOP = 2, /* top field only */
114 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
115 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
116 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
117 buffer, top-bottom order */
118 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
119 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
120 separate buffers */
121 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
122 first and the top field is
123 transmitted first */
124 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
125 first and the bottom field is
126 transmitted first */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127};
128#define V4L2_FIELD_HAS_TOP(field) \
129 ((field) == V4L2_FIELD_TOP ||\
130 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300131 (field) == V4L2_FIELD_INTERLACED_TB ||\
132 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 (field) == V4L2_FIELD_SEQ_TB ||\
134 (field) == V4L2_FIELD_SEQ_BT)
135#define V4L2_FIELD_HAS_BOTTOM(field) \
136 ((field) == V4L2_FIELD_BOTTOM ||\
137 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300138 (field) == V4L2_FIELD_INTERLACED_TB ||\
139 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 (field) == V4L2_FIELD_SEQ_TB ||\
141 (field) == V4L2_FIELD_SEQ_BT)
142#define V4L2_FIELD_HAS_BOTH(field) \
143 ((field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300144 (field) == V4L2_FIELD_INTERLACED_TB ||\
145 (field) == V4L2_FIELD_INTERLACED_BT ||\
146 (field) == V4L2_FIELD_SEQ_TB ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 (field) == V4L2_FIELD_SEQ_BT)
148
149enum v4l2_buf_type {
Hans Verkuilb2787842007-04-27 12:31:02 -0300150 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
151 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
152 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
153 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
154 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
155 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
156 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
157#if 1
158 /* Experimental */
159 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
160#endif
Pawel Osciakf8f39142010-07-29 14:44:25 -0300161 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
162 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
Hans Verkuilb2787842007-04-27 12:31:02 -0300163 V4L2_BUF_TYPE_PRIVATE = 0x80,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164};
165
Pawel Osciakf8f39142010-07-29 14:44:25 -0300166#define V4L2_TYPE_IS_MULTIPLANAR(type) \
167 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
168 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
169
170#define V4L2_TYPE_IS_OUTPUT(type) \
171 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
172 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
173 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
174 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
175 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
176 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT)
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178enum v4l2_tuner_type {
179 V4L2_TUNER_RADIO = 1,
180 V4L2_TUNER_ANALOG_TV = 2,
181 V4L2_TUNER_DIGITAL_TV = 3,
182};
183
184enum v4l2_memory {
185 V4L2_MEMORY_MMAP = 1,
186 V4L2_MEMORY_USERPTR = 2,
187 V4L2_MEMORY_OVERLAY = 3,
188};
189
190/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
191enum v4l2_colorspace {
192 /* ITU-R 601 -- broadcast NTSC/PAL */
193 V4L2_COLORSPACE_SMPTE170M = 1,
194
195 /* 1125-Line (US) HDTV */
196 V4L2_COLORSPACE_SMPTE240M = 2,
197
198 /* HD and modern captures. */
199 V4L2_COLORSPACE_REC709 = 3,
200
201 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
202 V4L2_COLORSPACE_BT878 = 4,
203
204 /* These should be useful. Assume 601 extents. */
205 V4L2_COLORSPACE_470_SYSTEM_M = 5,
206 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
207
208 /* I know there will be cameras that send this. So, this is
209 * unspecified chromaticities and full 0-255 on each of the
210 * Y'CbCr components
211 */
212 V4L2_COLORSPACE_JPEG = 7,
213
214 /* For RGB colourspaces, this is probably a good start. */
215 V4L2_COLORSPACE_SRGB = 8,
216};
217
218enum v4l2_priority {
219 V4L2_PRIORITY_UNSET = 0, /* not initialized */
220 V4L2_PRIORITY_BACKGROUND = 1,
221 V4L2_PRIORITY_INTERACTIVE = 2,
222 V4L2_PRIORITY_RECORD = 3,
223 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
224};
225
226struct v4l2_rect {
227 __s32 left;
228 __s32 top;
229 __s32 width;
230 __s32 height;
231};
232
233struct v4l2_fract {
234 __u32 numerator;
235 __u32 denominator;
236};
237
238/*
239 * D R I V E R C A P A B I L I T I E S
240 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300241struct v4l2_capability {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 __u8 driver[16]; /* i.e. "bttv" */
243 __u8 card[32]; /* i.e. "Hauppauge WinTV" */
244 __u8 bus_info[32]; /* "PCI:" + pci_name(pci_dev) */
245 __u32 version; /* should use KERNEL_VERSION() */
246 __u32 capabilities; /* Device capabilities */
247 __u32 reserved[4];
248};
249
250/* Values for 'capabilities' field */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800251#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
252#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
253#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
254#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
255#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700256#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
257#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800258#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
Hans Verkuil1f137602007-05-29 08:18:37 -0300259#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -0300260#define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
Hans Verkuil6ace40e2009-06-20 09:50:39 -0300261#define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Pawel Osciakf8f39142010-07-29 14:44:25 -0300263/* Is a video capture device that supports multiplanar formats */
264#define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
265/* Is a video output device that supports multiplanar formats */
266#define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
267
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800268#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
269#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
270#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
Hans Verkuil6ace40e2009-06-20 09:50:39 -0300271#define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700273#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
274#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
275#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277/*
278 * V I D E O I M A G E F O R M A T
279 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300280struct v4l2_pix_format {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800281 __u32 width;
282 __u32 height;
283 __u32 pixelformat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 enum v4l2_field field;
285 __u32 bytesperline; /* for padding, zero if unused */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800286 __u32 sizeimage;
287 enum v4l2_colorspace colorspace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 __u32 priv; /* private data, depends on pixelformat */
289};
290
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300291/* Pixel format FOURCC depth Description */
292
293/* RGB formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300294#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
295#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
296#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
297#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
298#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
299#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
Sylwester Nawrocki5fd8f732010-08-03 09:50:29 -0300300#define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300301#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
302#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
303#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
304#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300305
306/* Grey formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300307#define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
Hans Verkuilb3e212d2010-03-22 04:52:21 -0300308#define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
309#define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
Guennadi Liakhovetskiee811522009-12-11 11:15:06 -0300310#define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
Michael Jonesd924de02011-03-29 05:19:06 -0300311#define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300312#define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300313
Antonio Ospite8bb36c22011-04-07 12:45:51 -0300314/* Grey bit-packed formats */
315#define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
316
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300317/* Palette formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300318#define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300319
320/* Luminance+Chrominance formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300321#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
322#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
323#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300324#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
325#define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300326#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
Robert Jarzmik69acdf12008-11-04 21:59:37 -0300327#define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300328#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
329#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 16 YVU411 planar */
330#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
331#define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
332#define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
333#define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
334#define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300335#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
336#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
337#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
338#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
Hans de Goede0e59fd02011-05-11 09:56:20 -0300339#define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341/* two planes -- one Y, one Cr + Cb interleaved */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300342#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
343#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
Magnus Damm91962fa2008-12-18 11:45:00 -0300344#define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
345#define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Sylwester Nawrocki4a3c9b42010-12-28 12:32:39 -0300347/* two non contiguous planes - one Y, one Cr + Cb interleaved */
348#define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
349#define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
350
351/* three non contiguous planes - Y, Cb, Cr */
352#define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
353
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300354/* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300355#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
356#define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
Mauro Carvalho Chehab509dd022009-06-30 16:07:26 -0300357#define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
Guennadi Liakhovetskiee811522009-12-11 11:15:06 -0300358#define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
359#define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
360#define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
361#define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
362#define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
Laurent Pinchart39187e12010-12-23 11:14:50 -0300363#define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
364#define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
365#define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
366#define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300367 /* 10bit raw bayer DPCM compressed to 8 bits */
Sergio Aguirre733d7102008-10-18 12:26:47 -0300368#define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300369 /*
370 * 10bit raw bayer, expanded to 16 bits
371 * xxxxrrrrrrrrrrxxxxgggggggggg xxxxggggggggggxxxxbbbbbbbbbb...
372 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300373#define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375/* compressed formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300376#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
377#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
378#define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
379#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381/* Vendor-specific formats */
Hans de Goede54e8bc52010-01-14 09:37:18 -0300382#define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300383#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
384#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
Brian Johnson26e744b2009-07-19 05:52:58 -0300385#define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300386#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
387#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
388#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
389#define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
Mauro Carvalho Chehab9fa0f6d2008-07-27 08:55:17 -0300390#define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
391#define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300392#define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
393#define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
Kyle Guinn553d0d82009-01-16 05:28:38 -0300394#define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
Theodore Kilgore5bdd00b2009-12-25 05:16:32 -0300395#define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
Theodore Kilgore14a19c02009-03-25 07:13:13 -0300396#define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
Jean-Francois Moinef75c4952008-09-03 16:47:35 -0300397#define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
Hans de Goede1876bb92009-06-14 06:45:50 -0300398#define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
Hans de Goede49809d62009-06-07 12:10:39 -0300399#define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
Hans de Goede21f1b932009-10-23 06:50:12 -0300400#define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
Mauro Carvalho Chehab9701dc92009-09-14 09:42:41 -0300401#define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
Hans de Goede1f33de02010-09-05 16:05:22 -0300402#define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
Hans de Goedeb517af72010-09-05 16:30:30 -0300403#define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
Jean-François Moinece5b2ac2011-03-14 08:49:28 -0300404#define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406/*
407 * F O R M A T E N U M E R A T I O N
408 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300409struct v4l2_fmtdesc {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800410 __u32 index; /* Format number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 enum v4l2_buf_type type; /* buffer type */
412 __u32 flags;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800413 __u8 description[32]; /* Description string */
414 __u32 pixelformat; /* Format fourcc */
415 __u32 reserved[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416};
417
418#define V4L2_FMT_FLAG_COMPRESSED 0x0001
Hans de Goede1e3c1f72009-08-31 11:32:46 -0300419#define V4L2_FMT_FLAG_EMULATED 0x0002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300421#if 1
422 /* Experimental Frame Size and frame rate enumeration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423/*
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300424 * F R A M E S I Z E E N U M E R A T I O N
425 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300426enum v4l2_frmsizetypes {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300427 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
428 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
429 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
430};
431
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300432struct v4l2_frmsize_discrete {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300433 __u32 width; /* Frame width [pixel] */
434 __u32 height; /* Frame height [pixel] */
435};
436
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300437struct v4l2_frmsize_stepwise {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300438 __u32 min_width; /* Minimum frame width [pixel] */
439 __u32 max_width; /* Maximum frame width [pixel] */
440 __u32 step_width; /* Frame width step size [pixel] */
441 __u32 min_height; /* Minimum frame height [pixel] */
442 __u32 max_height; /* Maximum frame height [pixel] */
443 __u32 step_height; /* Frame height step size [pixel] */
444};
445
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300446struct v4l2_frmsizeenum {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300447 __u32 index; /* Frame size number */
448 __u32 pixel_format; /* Pixel format */
449 __u32 type; /* Frame size type the device supports. */
450
451 union { /* Frame size */
452 struct v4l2_frmsize_discrete discrete;
453 struct v4l2_frmsize_stepwise stepwise;
454 };
455
456 __u32 reserved[2]; /* Reserved space for future use */
457};
458
459/*
460 * F R A M E R A T E E N U M E R A T I O N
461 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300462enum v4l2_frmivaltypes {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300463 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
464 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
465 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
466};
467
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300468struct v4l2_frmival_stepwise {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300469 struct v4l2_fract min; /* Minimum frame interval [s] */
470 struct v4l2_fract max; /* Maximum frame interval [s] */
471 struct v4l2_fract step; /* Frame interval step size [s] */
472};
473
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300474struct v4l2_frmivalenum {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300475 __u32 index; /* Frame format index */
476 __u32 pixel_format; /* Pixel format */
477 __u32 width; /* Frame width */
478 __u32 height; /* Frame height */
479 __u32 type; /* Frame interval type the device supports. */
480
481 union { /* Frame interval */
482 struct v4l2_fract discrete;
483 struct v4l2_frmival_stepwise stepwise;
484 };
485
486 __u32 reserved[2]; /* Reserved space for future use */
487};
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300488#endif
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300489
490/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 * T I M E C O D E
492 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300493struct v4l2_timecode {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 __u32 type;
495 __u32 flags;
496 __u8 frames;
497 __u8 seconds;
498 __u8 minutes;
499 __u8 hours;
500 __u8 userbits[4];
501};
502
503/* Type */
504#define V4L2_TC_TYPE_24FPS 1
505#define V4L2_TC_TYPE_25FPS 2
506#define V4L2_TC_TYPE_30FPS 3
507#define V4L2_TC_TYPE_50FPS 4
508#define V4L2_TC_TYPE_60FPS 5
509
510/* Flags */
511#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
512#define V4L2_TC_FLAG_COLORFRAME 0x0002
513#define V4L2_TC_USERBITS_field 0x000C
514#define V4L2_TC_USERBITS_USERDEFINED 0x0000
515#define V4L2_TC_USERBITS_8BITCHARS 0x0008
516/* The above is based on SMPTE timecodes */
517
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300518struct v4l2_jpegcompression {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 int quality;
520
521 int APPn; /* Number of APP segment to be written,
522 * must be 0..15 */
523 int APP_len; /* Length of data in JPEG APPn segment */
524 char APP_data[60]; /* Data in the JPEG APPn segment. */
525
526 int COM_len; /* Length of data in JPEG COM segment */
527 char COM_data[60]; /* Data in JPEG COM segment */
528
529 __u32 jpeg_markers; /* Which markers should go into the JPEG
530 * output. Unless you exactly know what
531 * you do, leave them untouched.
532 * Inluding less markers will make the
533 * resulting code smaller, but there will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200534 * be fewer applications which can read it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 * The presence of the APP and COM marker
536 * is influenced by APP_len and COM_len
537 * ONLY, not by this property! */
538
539#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
540#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
541#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
542#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
543#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -0800544 * allways use APP0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545};
546
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547/*
548 * M E M O R Y - M A P P I N G B U F F E R S
549 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300550struct v4l2_requestbuffers {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800551 __u32 count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 enum v4l2_buf_type type;
553 enum v4l2_memory memory;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800554 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555};
556
Pawel Osciakf8f39142010-07-29 14:44:25 -0300557/**
558 * struct v4l2_plane - plane info for multi-planar buffers
559 * @bytesused: number of bytes occupied by data in the plane (payload)
560 * @length: size of this plane (NOT the payload) in bytes
561 * @mem_offset: when memory in the associated struct v4l2_buffer is
562 * V4L2_MEMORY_MMAP, equals the offset from the start of
563 * the device memory for this plane (or is a "cookie" that
564 * should be passed to mmap() called on the video node)
565 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
566 * pointing to this plane
567 * @data_offset: offset in the plane to the start of data; usually 0,
568 * unless there is a header in front of the data
569 *
570 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
571 * with two planes can have one plane for Y, and another for interleaved CbCr
572 * components. Each plane can reside in a separate memory buffer, or even in
573 * a completely separate memory node (e.g. in embedded devices).
574 */
575struct v4l2_plane {
576 __u32 bytesused;
577 __u32 length;
578 union {
579 __u32 mem_offset;
580 unsigned long userptr;
581 } m;
582 __u32 data_offset;
583 __u32 reserved[11];
584};
585
586/**
587 * struct v4l2_buffer - video buffer info
588 * @index: id number of the buffer
589 * @type: buffer type (type == *_MPLANE for multiplanar buffers)
590 * @bytesused: number of bytes occupied by data in the buffer (payload);
591 * unused (set to 0) for multiplanar buffers
592 * @flags: buffer informational flags
593 * @field: field order of the image in the buffer
594 * @timestamp: frame timestamp
595 * @timecode: frame timecode
596 * @sequence: sequence count of this frame
597 * @memory: the method, in which the actual video data is passed
598 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
599 * offset from the start of the device memory for this plane,
600 * (or a "cookie" that should be passed to mmap() as offset)
601 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
602 * a userspace pointer pointing to this buffer
603 * @planes: for multiplanar buffers; userspace pointer to the array of plane
604 * info structs for this buffer
605 * @length: size in bytes of the buffer (NOT its payload) for single-plane
606 * buffers (when type != *_MPLANE); number of elements in the
607 * planes array for multi-plane buffers
608 * @input: input number from which the video data has has been captured
609 *
610 * Contains data exchanged by application and driver using one of the Streaming
611 * I/O methods.
612 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300613struct v4l2_buffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 __u32 index;
615 enum v4l2_buf_type type;
616 __u32 bytesused;
617 __u32 flags;
618 enum v4l2_field field;
619 struct timeval timestamp;
620 struct v4l2_timecode timecode;
621 __u32 sequence;
622
623 /* memory location */
624 enum v4l2_memory memory;
625 union {
626 __u32 offset;
627 unsigned long userptr;
Pawel Osciakf8f39142010-07-29 14:44:25 -0300628 struct v4l2_plane *planes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 } m;
630 __u32 length;
631 __u32 input;
632 __u32 reserved;
633};
634
635/* Flags for 'flags' field */
636#define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
637#define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
638#define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
639#define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
640#define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
641#define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
Pawel Osciakbc0f7f12010-04-28 04:05:21 -0300642/* Buffer is ready, but the data contained within is corrupted. */
643#define V4L2_BUF_FLAG_ERROR 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644#define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
645#define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
646
647/*
648 * O V E R L A Y P R E V I E W
649 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300650struct v4l2_framebuffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 __u32 capability;
652 __u32 flags;
653/* FIXME: in theory we should pass something like PCI device + memory
654 * region + offset instead of some physical address */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300655 void *base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 struct v4l2_pix_format fmt;
657};
658/* Flags for the 'capability' field. Read only */
659#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
660#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
661#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
662#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
Hans Verkuilb2787842007-04-27 12:31:02 -0300663#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
664#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300665#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
Vaibhav Hiremathd8008562009-11-10 13:46:36 -0300666#define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667/* Flags for the 'flags' field. */
668#define V4L2_FBUF_FLAG_PRIMARY 0x0001
669#define V4L2_FBUF_FLAG_OVERLAY 0x0002
670#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
Hans Verkuilb2787842007-04-27 12:31:02 -0300671#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
672#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300673#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
Vaibhav Hiremathd8008562009-11-10 13:46:36 -0300674#define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300676struct v4l2_clip {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 struct v4l2_rect c;
Al Viro5b1a43d2006-02-01 05:24:20 -0500678 struct v4l2_clip __user *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679};
680
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300681struct v4l2_window {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 struct v4l2_rect w;
683 enum v4l2_field field;
684 __u32 chromakey;
685 struct v4l2_clip __user *clips;
686 __u32 clipcount;
687 void __user *bitmap;
Hans Verkuilb2787842007-04-27 12:31:02 -0300688 __u8 global_alpha;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689};
690
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691/*
692 * C A P T U R E P A R A M E T E R S
693 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300694struct v4l2_captureparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 __u32 capability; /* Supported modes */
696 __u32 capturemode; /* Current mode */
697 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
698 __u32 extendedmode; /* Driver-specific extensions */
699 __u32 readbuffers; /* # of buffers for read */
700 __u32 reserved[4];
701};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300702
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703/* Flags for 'capability' and 'capturemode' fields */
704#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
705#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
706
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300707struct v4l2_outputparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 __u32 capability; /* Supported modes */
709 __u32 outputmode; /* Current mode */
710 struct v4l2_fract timeperframe; /* Time per frame in seconds */
711 __u32 extendedmode; /* Driver-specific extensions */
712 __u32 writebuffers; /* # of buffers for write */
713 __u32 reserved[4];
714};
715
716/*
717 * I N P U T I M A G E C R O P P I N G
718 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719struct v4l2_cropcap {
720 enum v4l2_buf_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800721 struct v4l2_rect bounds;
722 struct v4l2_rect defrect;
723 struct v4l2_fract pixelaspect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724};
725
726struct v4l2_crop {
727 enum v4l2_buf_type type;
728 struct v4l2_rect c;
729};
730
731/*
732 * A N A L O G V I D E O S T A N D A R D
733 */
734
735typedef __u64 v4l2_std_id;
736
737/* one bit for each */
738#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
739#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
740#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
741#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
742#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
743#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
744#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
745#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
746
747#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
748#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
749#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
750#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
751
752#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
753#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800754#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
Hans Verkuild97a11e2006-02-07 06:48:40 -0200755#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
757#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
758#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
759#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
760#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
761#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
762#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
763#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
Mauro Carvalho Chehab800d3c62005-11-13 16:07:48 -0800764#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
766/* ATSC/HDTV */
767#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
768#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
769
Mauro Carvalho Chehab412297d2007-01-07 08:51:05 -0300770/* FIXME:
771 Although std_id is 64 bits, there is an issue on PPC32 architecture that
772 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
773 this value to 32 bits.
774 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
775 it should work fine. However, if needed to add more than two standards,
776 v4l2-common.c should be fixed.
777 */
778
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200779/* some merged standards */
780#define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
781#define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
782#define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
783#define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
784
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785/* some common needed stuff */
786#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
787 V4L2_STD_PAL_B1 |\
788 V4L2_STD_PAL_G)
789#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
790 V4L2_STD_PAL_D1 |\
791 V4L2_STD_PAL_K)
792#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
793 V4L2_STD_PAL_DK |\
794 V4L2_STD_PAL_H |\
795 V4L2_STD_PAL_I)
796#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
Hans Verkuild97a11e2006-02-07 06:48:40 -0200797 V4L2_STD_NTSC_M_JP |\
798 V4L2_STD_NTSC_M_KR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
800 V4L2_STD_SECAM_K |\
801 V4L2_STD_SECAM_K1)
802#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
803 V4L2_STD_SECAM_G |\
804 V4L2_STD_SECAM_H |\
805 V4L2_STD_SECAM_DK |\
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200806 V4L2_STD_SECAM_L |\
807 V4L2_STD_SECAM_LC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
809#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
810 V4L2_STD_PAL_60 |\
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800811 V4L2_STD_NTSC |\
812 V4L2_STD_NTSC_443)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813#define V4L2_STD_625_50 (V4L2_STD_PAL |\
814 V4L2_STD_PAL_N |\
815 V4L2_STD_PAL_Nc |\
816 V4L2_STD_SECAM)
817#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800818 V4L2_STD_ATSC_16_VSB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
820#define V4L2_STD_UNKNOWN 0
821#define V4L2_STD_ALL (V4L2_STD_525_60 |\
822 V4L2_STD_625_50)
823
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300824struct v4l2_standard {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800825 __u32 index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 v4l2_std_id id;
827 __u8 name[24];
828 struct v4l2_fract frameperiod; /* Frames, not fields */
829 __u32 framelines;
830 __u32 reserved[4];
831};
832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833/*
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300834 * V I D E O T I M I N G S D V P R E S E T
835 */
836struct v4l2_dv_preset {
837 __u32 preset;
838 __u32 reserved[4];
839};
840
841/*
842 * D V P R E S E T S E N U M E R A T I O N
843 */
844struct v4l2_dv_enum_preset {
845 __u32 index;
846 __u32 preset;
847 __u8 name[32]; /* Name of the preset timing */
848 __u32 width;
849 __u32 height;
850 __u32 reserved[4];
851};
852
853/*
854 * D V P R E S E T V A L U E S
855 */
856#define V4L2_DV_INVALID 0
857#define V4L2_DV_480P59_94 1 /* BT.1362 */
858#define V4L2_DV_576P50 2 /* BT.1362 */
859#define V4L2_DV_720P24 3 /* SMPTE 296M */
860#define V4L2_DV_720P25 4 /* SMPTE 296M */
861#define V4L2_DV_720P30 5 /* SMPTE 296M */
862#define V4L2_DV_720P50 6 /* SMPTE 296M */
863#define V4L2_DV_720P59_94 7 /* SMPTE 274M */
864#define V4L2_DV_720P60 8 /* SMPTE 274M/296M */
865#define V4L2_DV_1080I29_97 9 /* BT.1120/ SMPTE 274M */
866#define V4L2_DV_1080I30 10 /* BT.1120/ SMPTE 274M */
867#define V4L2_DV_1080I25 11 /* BT.1120 */
868#define V4L2_DV_1080I50 12 /* SMPTE 296M */
869#define V4L2_DV_1080I60 13 /* SMPTE 296M */
870#define V4L2_DV_1080P24 14 /* SMPTE 296M */
871#define V4L2_DV_1080P25 15 /* SMPTE 296M */
872#define V4L2_DV_1080P30 16 /* SMPTE 296M */
873#define V4L2_DV_1080P50 17 /* BT.1120 */
874#define V4L2_DV_1080P60 18 /* BT.1120 */
875
876/*
877 * D V B T T I M I N G S
878 */
879
880/* BT.656/BT.1120 timing data */
881struct v4l2_bt_timings {
882 __u32 width; /* width in pixels */
883 __u32 height; /* height in lines */
884 __u32 interlaced; /* Interlaced or progressive */
885 __u32 polarities; /* Positive or negative polarity */
886 __u64 pixelclock; /* Pixel clock in HZ. Ex. 74.25MHz->74250000 */
887 __u32 hfrontporch; /* Horizpontal front porch in pixels */
888 __u32 hsync; /* Horizontal Sync length in pixels */
889 __u32 hbackporch; /* Horizontal back porch in pixels */
890 __u32 vfrontporch; /* Vertical front porch in pixels */
891 __u32 vsync; /* Vertical Sync length in lines */
892 __u32 vbackporch; /* Vertical back porch in lines */
893 __u32 il_vfrontporch; /* Vertical front porch for bottom field of
894 * interlaced field formats
895 */
896 __u32 il_vsync; /* Vertical sync length for bottom field of
897 * interlaced field formats
898 */
899 __u32 il_vbackporch; /* Vertical back porch for bottom field of
900 * interlaced field formats
901 */
902 __u32 reserved[16];
903} __attribute__ ((packed));
904
905/* Interlaced or progressive format */
906#define V4L2_DV_PROGRESSIVE 0
907#define V4L2_DV_INTERLACED 1
908
909/* Polarities. If bit is not set, it is assumed to be negative polarity */
910#define V4L2_DV_VSYNC_POS_POL 0x00000001
911#define V4L2_DV_HSYNC_POS_POL 0x00000002
912
913
914/* DV timings */
915struct v4l2_dv_timings {
916 __u32 type;
917 union {
918 struct v4l2_bt_timings bt;
919 __u32 reserved[32];
920 };
921} __attribute__ ((packed));
922
923/* Values for the type field */
924#define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
925
926/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 * V I D E O I N P U T S
928 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300929struct v4l2_input {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 __u32 index; /* Which input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800931 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 __u32 type; /* Type of input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800933 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 __u32 tuner; /* Associated tuner */
935 v4l2_std_id std;
936 __u32 status;
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300937 __u32 capabilities;
938 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941/* Values for the 'type' field */
942#define V4L2_INPUT_TYPE_TUNER 1
943#define V4L2_INPUT_TYPE_CAMERA 2
944
945/* field 'status' - general */
946#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
947#define V4L2_IN_ST_NO_SIGNAL 0x00000002
948#define V4L2_IN_ST_NO_COLOR 0x00000004
949
Adam Bakerdfa76fa2009-03-29 19:17:10 -0300950/* field 'status' - sensor orientation */
951/* If sensor is mounted upside down set both bits */
952#define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
953#define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955/* field 'status' - analog */
956#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
957#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
958
959/* field 'status' - digital */
960#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
961#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
962#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
963
964/* field 'status' - VCR and set-top box */
965#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
966#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
967#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
968
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300969/* capabilities flags */
970#define V4L2_IN_CAP_PRESETS 0x00000001 /* Supports S_DV_PRESET */
971#define V4L2_IN_CAP_CUSTOM_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
972#define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974/*
975 * V I D E O O U T P U T S
976 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300977struct v4l2_output {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 __u32 index; /* Which output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800979 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 __u32 type; /* Type of output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800981 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 __u32 modulator; /* Associated modulator */
983 v4l2_std_id std;
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300984 __u32 capabilities;
985 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986};
987/* Values for the 'type' field */
988#define V4L2_OUTPUT_TYPE_MODULATOR 1
989#define V4L2_OUTPUT_TYPE_ANALOG 2
990#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
991
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300992/* capabilities flags */
993#define V4L2_OUT_CAP_PRESETS 0x00000001 /* Supports S_DV_PRESET */
994#define V4L2_OUT_CAP_CUSTOM_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
995#define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
996
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997/*
998 * C O N T R O L S
999 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001000struct v4l2_control {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 __u32 id;
1002 __s32 value;
1003};
1004
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001005struct v4l2_ext_control {
Hans Verkuil4f341712006-06-18 13:27:19 -03001006 __u32 id;
Hans Verkuil6b5a9492009-08-11 18:47:18 -03001007 __u32 size;
1008 __u32 reserved2[1];
Hans Verkuil4f341712006-06-18 13:27:19 -03001009 union {
1010 __s32 value;
1011 __s64 value64;
Hans Verkuil6b5a9492009-08-11 18:47:18 -03001012 char *string;
Hans Verkuil4f341712006-06-18 13:27:19 -03001013 };
Mauro Carvalho Chehabf251d232006-07-22 08:20:07 -03001014} __attribute__ ((packed));
Hans Verkuil4f341712006-06-18 13:27:19 -03001015
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001016struct v4l2_ext_controls {
Hans Verkuil4f341712006-06-18 13:27:19 -03001017 __u32 ctrl_class;
1018 __u32 count;
1019 __u32 error_idx;
1020 __u32 reserved[2];
1021 struct v4l2_ext_control *controls;
1022};
1023
1024/* Values for ctrl_class field */
1025#define V4L2_CTRL_CLASS_USER 0x00980000 /* Old-style 'user' controls */
1026#define V4L2_CTRL_CLASS_MPEG 0x00990000 /* MPEG-compression controls */
Brandon Philipsf9bd5842008-04-22 14:42:02 -03001027#define V4L2_CTRL_CLASS_CAMERA 0x009a0000 /* Camera class controls */
Eduardo Valentin6b424942009-08-08 08:38:58 -03001028#define V4L2_CTRL_CLASS_FM_TX 0x009b0000 /* FM Modulator control class */
Hans Verkuil4f341712006-06-18 13:27:19 -03001029
1030#define V4L2_CTRL_ID_MASK (0x0fffffff)
1031#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1032#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1033
Hans Verkuilea64f8c2010-04-06 06:53:57 -03001034enum v4l2_ctrl_type {
1035 V4L2_CTRL_TYPE_INTEGER = 1,
1036 V4L2_CTRL_TYPE_BOOLEAN = 2,
1037 V4L2_CTRL_TYPE_MENU = 3,
1038 V4L2_CTRL_TYPE_BUTTON = 4,
1039 V4L2_CTRL_TYPE_INTEGER64 = 5,
1040 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1041 V4L2_CTRL_TYPE_STRING = 7,
1042};
1043
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001045struct v4l2_queryctrl {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001046 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 enum v4l2_ctrl_type type;
1048 __u8 name[32]; /* Whatever */
1049 __s32 minimum; /* Note signedness */
1050 __s32 maximum;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001051 __s32 step;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 __s32 default_value;
1053 __u32 flags;
1054 __u32 reserved[2];
1055};
1056
1057/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001058struct v4l2_querymenu {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 __u32 id;
1060 __u32 index;
1061 __u8 name[32]; /* Whatever */
1062 __u32 reserved;
1063};
1064
1065/* Control flags */
1066#define V4L2_CTRL_FLAG_DISABLED 0x0001
1067#define V4L2_CTRL_FLAG_GRABBED 0x0002
Hans Verkuil4f341712006-06-18 13:27:19 -03001068#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1069#define V4L2_CTRL_FLAG_UPDATE 0x0008
1070#define V4L2_CTRL_FLAG_INACTIVE 0x0010
1071#define V4L2_CTRL_FLAG_SLIDER 0x0020
Hans Verkuil1a367f32009-02-20 05:55:39 -03001072#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
Hans Verkuil4f341712006-06-18 13:27:19 -03001074/* Query flag, to be ORed with the control ID */
1075#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1076
1077/* User-class control IDs defined by V4L2 */
1078#define V4L2_CID_BASE (V4L2_CTRL_CLASS_USER | 0x900)
1079#define V4L2_CID_USER_BASE V4L2_CID_BASE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080/* IDs reserved for driver specific controls */
1081#define V4L2_CID_PRIVATE_BASE 0x08000000
1082
Hans Verkuil4f341712006-06-18 13:27:19 -03001083#define V4L2_CID_USER_CLASS (V4L2_CTRL_CLASS_USER | 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084#define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
1085#define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
1086#define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
1087#define V4L2_CID_HUE (V4L2_CID_BASE+3)
1088#define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
1089#define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
1090#define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
1091#define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
1092#define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
1093#define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
Brandon Philips26d507f2008-04-22 14:42:02 -03001094#define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11) /* Deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095#define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
1096#define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
1097#define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
1098#define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
1099#define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
Brandon Philips26d507f2008-04-22 14:42:02 -03001100#define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* Deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101#define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
1102#define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
1103#define V4L2_CID_GAIN (V4L2_CID_BASE+19)
1104#define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
1105#define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
Brandon Philips26d507f2008-04-22 14:42:02 -03001106
David Woodhouse39028ec2008-06-02 15:46:51 -03001107/* Deprecated; use V4L2_CID_PAN_RESET and V4L2_CID_TILT_RESET */
1108#define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
1109#define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
Brandon Philips26d507f2008-04-22 14:42:02 -03001110
1111#define V4L2_CID_POWER_LINE_FREQUENCY (V4L2_CID_BASE+24)
1112enum v4l2_power_line_frequency {
1113 V4L2_CID_POWER_LINE_FREQUENCY_DISABLED = 0,
1114 V4L2_CID_POWER_LINE_FREQUENCY_50HZ = 1,
1115 V4L2_CID_POWER_LINE_FREQUENCY_60HZ = 2,
1116};
1117#define V4L2_CID_HUE_AUTO (V4L2_CID_BASE+25)
1118#define V4L2_CID_WHITE_BALANCE_TEMPERATURE (V4L2_CID_BASE+26)
1119#define V4L2_CID_SHARPNESS (V4L2_CID_BASE+27)
1120#define V4L2_CID_BACKLIGHT_COMPENSATION (V4L2_CID_BASE+28)
Frej Drejhammar1c412d12008-03-23 22:43:20 -03001121#define V4L2_CID_CHROMA_AGC (V4L2_CID_BASE+29)
Frej Drejhammara8ac6882008-03-23 22:43:23 -03001122#define V4L2_CID_COLOR_KILLER (V4L2_CID_BASE+30)
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001123#define V4L2_CID_COLORFX (V4L2_CID_BASE+31)
1124enum v4l2_colorfx {
1125 V4L2_COLORFX_NONE = 0,
1126 V4L2_COLORFX_BW = 1,
1127 V4L2_COLORFX_SEPIA = 2,
Xiaolin Zhang35e6aa92010-04-18 23:06:50 -03001128 V4L2_COLORFX_NEGATIVE = 3,
1129 V4L2_COLORFX_EMBOSS = 4,
1130 V4L2_COLORFX_SKETCH = 5,
1131 V4L2_COLORFX_SKY_BLUE = 6,
1132 V4L2_COLORFX_GRASS_GREEN = 7,
1133 V4L2_COLORFX_SKIN_WHITEN = 8,
1134 V4L2_COLORFX_VIVID = 9,
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001135};
Hans de Goede02ab18b2009-06-14 04:32:04 -03001136#define V4L2_CID_AUTOBRIGHTNESS (V4L2_CID_BASE+32)
Guennadi Liakhovetski3418f162009-08-25 11:44:14 -03001137#define V4L2_CID_BAND_STOP_FILTER (V4L2_CID_BASE+33)
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001138
Vaibhav Hiremath85213632009-11-10 13:32:53 -03001139#define V4L2_CID_ROTATE (V4L2_CID_BASE+34)
1140#define V4L2_CID_BG_COLOR (V4L2_CID_BASE+35)
Devin Heitmueller7a01f6d2010-03-11 21:27:59 -03001141
1142#define V4L2_CID_CHROMA_GAIN (V4L2_CID_BASE+36)
1143
Jean-François Moine008d35f2010-09-13 07:04:49 -03001144#define V4L2_CID_ILLUMINATORS_1 (V4L2_CID_BASE+37)
1145#define V4L2_CID_ILLUMINATORS_2 (V4L2_CID_BASE+38)
1146
Frej Drejhammar1c412d12008-03-23 22:43:20 -03001147/* last CID + 1 */
Jean-François Moine008d35f2010-09-13 07:04:49 -03001148#define V4L2_CID_LASTP1 (V4L2_CID_BASE+39)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149
Hans Verkuil4f341712006-06-18 13:27:19 -03001150/* MPEG-class control IDs defined by V4L2 */
1151#define V4L2_CID_MPEG_BASE (V4L2_CTRL_CLASS_MPEG | 0x900)
1152#define V4L2_CID_MPEG_CLASS (V4L2_CTRL_CLASS_MPEG | 1)
1153
1154/* MPEG streams */
1155#define V4L2_CID_MPEG_STREAM_TYPE (V4L2_CID_MPEG_BASE+0)
1156enum v4l2_mpeg_stream_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001157 V4L2_MPEG_STREAM_TYPE_MPEG2_PS = 0, /* MPEG-2 program stream */
1158 V4L2_MPEG_STREAM_TYPE_MPEG2_TS = 1, /* MPEG-2 transport stream */
1159 V4L2_MPEG_STREAM_TYPE_MPEG1_SS = 2, /* MPEG-1 system stream */
1160 V4L2_MPEG_STREAM_TYPE_MPEG2_DVD = 3, /* MPEG-2 DVD-compatible stream */
1161 V4L2_MPEG_STREAM_TYPE_MPEG1_VCD = 4, /* MPEG-1 VCD-compatible stream */
1162 V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD = 5, /* MPEG-2 SVCD-compatible stream */
Hans Verkuil4f341712006-06-18 13:27:19 -03001163};
1164#define V4L2_CID_MPEG_STREAM_PID_PMT (V4L2_CID_MPEG_BASE+1)
1165#define V4L2_CID_MPEG_STREAM_PID_AUDIO (V4L2_CID_MPEG_BASE+2)
1166#define V4L2_CID_MPEG_STREAM_PID_VIDEO (V4L2_CID_MPEG_BASE+3)
1167#define V4L2_CID_MPEG_STREAM_PID_PCR (V4L2_CID_MPEG_BASE+4)
1168#define V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (V4L2_CID_MPEG_BASE+5)
1169#define V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (V4L2_CID_MPEG_BASE+6)
Hans Verkuil8cbde942006-06-24 14:36:02 -03001170#define V4L2_CID_MPEG_STREAM_VBI_FMT (V4L2_CID_MPEG_BASE+7)
1171enum v4l2_mpeg_stream_vbi_fmt {
1172 V4L2_MPEG_STREAM_VBI_FMT_NONE = 0, /* No VBI in the MPEG stream */
1173 V4L2_MPEG_STREAM_VBI_FMT_IVTV = 1, /* VBI in private packets, IVTV format */
1174};
Hans Verkuil4f341712006-06-18 13:27:19 -03001175
1176/* MPEG audio */
1177#define V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ (V4L2_CID_MPEG_BASE+100)
1178enum v4l2_mpeg_audio_sampling_freq {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001179 V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100 = 0,
1180 V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000 = 1,
1181 V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001182};
1183#define V4L2_CID_MPEG_AUDIO_ENCODING (V4L2_CID_MPEG_BASE+101)
1184enum v4l2_mpeg_audio_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001185 V4L2_MPEG_AUDIO_ENCODING_LAYER_1 = 0,
1186 V4L2_MPEG_AUDIO_ENCODING_LAYER_2 = 1,
1187 V4L2_MPEG_AUDIO_ENCODING_LAYER_3 = 2,
Janne Grunau188919a2008-08-08 07:21:00 -03001188 V4L2_MPEG_AUDIO_ENCODING_AAC = 3,
Hans Verkuile6b5da82008-08-08 07:38:07 -03001189 V4L2_MPEG_AUDIO_ENCODING_AC3 = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001190};
1191#define V4L2_CID_MPEG_AUDIO_L1_BITRATE (V4L2_CID_MPEG_BASE+102)
1192enum v4l2_mpeg_audio_l1_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001193 V4L2_MPEG_AUDIO_L1_BITRATE_32K = 0,
1194 V4L2_MPEG_AUDIO_L1_BITRATE_64K = 1,
1195 V4L2_MPEG_AUDIO_L1_BITRATE_96K = 2,
1196 V4L2_MPEG_AUDIO_L1_BITRATE_128K = 3,
1197 V4L2_MPEG_AUDIO_L1_BITRATE_160K = 4,
1198 V4L2_MPEG_AUDIO_L1_BITRATE_192K = 5,
1199 V4L2_MPEG_AUDIO_L1_BITRATE_224K = 6,
1200 V4L2_MPEG_AUDIO_L1_BITRATE_256K = 7,
1201 V4L2_MPEG_AUDIO_L1_BITRATE_288K = 8,
1202 V4L2_MPEG_AUDIO_L1_BITRATE_320K = 9,
1203 V4L2_MPEG_AUDIO_L1_BITRATE_352K = 10,
1204 V4L2_MPEG_AUDIO_L1_BITRATE_384K = 11,
1205 V4L2_MPEG_AUDIO_L1_BITRATE_416K = 12,
1206 V4L2_MPEG_AUDIO_L1_BITRATE_448K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001207};
1208#define V4L2_CID_MPEG_AUDIO_L2_BITRATE (V4L2_CID_MPEG_BASE+103)
1209enum v4l2_mpeg_audio_l2_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001210 V4L2_MPEG_AUDIO_L2_BITRATE_32K = 0,
1211 V4L2_MPEG_AUDIO_L2_BITRATE_48K = 1,
1212 V4L2_MPEG_AUDIO_L2_BITRATE_56K = 2,
1213 V4L2_MPEG_AUDIO_L2_BITRATE_64K = 3,
1214 V4L2_MPEG_AUDIO_L2_BITRATE_80K = 4,
1215 V4L2_MPEG_AUDIO_L2_BITRATE_96K = 5,
1216 V4L2_MPEG_AUDIO_L2_BITRATE_112K = 6,
1217 V4L2_MPEG_AUDIO_L2_BITRATE_128K = 7,
1218 V4L2_MPEG_AUDIO_L2_BITRATE_160K = 8,
1219 V4L2_MPEG_AUDIO_L2_BITRATE_192K = 9,
1220 V4L2_MPEG_AUDIO_L2_BITRATE_224K = 10,
1221 V4L2_MPEG_AUDIO_L2_BITRATE_256K = 11,
1222 V4L2_MPEG_AUDIO_L2_BITRATE_320K = 12,
1223 V4L2_MPEG_AUDIO_L2_BITRATE_384K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001224};
1225#define V4L2_CID_MPEG_AUDIO_L3_BITRATE (V4L2_CID_MPEG_BASE+104)
1226enum v4l2_mpeg_audio_l3_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001227 V4L2_MPEG_AUDIO_L3_BITRATE_32K = 0,
1228 V4L2_MPEG_AUDIO_L3_BITRATE_40K = 1,
1229 V4L2_MPEG_AUDIO_L3_BITRATE_48K = 2,
1230 V4L2_MPEG_AUDIO_L3_BITRATE_56K = 3,
1231 V4L2_MPEG_AUDIO_L3_BITRATE_64K = 4,
1232 V4L2_MPEG_AUDIO_L3_BITRATE_80K = 5,
1233 V4L2_MPEG_AUDIO_L3_BITRATE_96K = 6,
1234 V4L2_MPEG_AUDIO_L3_BITRATE_112K = 7,
1235 V4L2_MPEG_AUDIO_L3_BITRATE_128K = 8,
1236 V4L2_MPEG_AUDIO_L3_BITRATE_160K = 9,
1237 V4L2_MPEG_AUDIO_L3_BITRATE_192K = 10,
1238 V4L2_MPEG_AUDIO_L3_BITRATE_224K = 11,
1239 V4L2_MPEG_AUDIO_L3_BITRATE_256K = 12,
1240 V4L2_MPEG_AUDIO_L3_BITRATE_320K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001241};
1242#define V4L2_CID_MPEG_AUDIO_MODE (V4L2_CID_MPEG_BASE+105)
1243enum v4l2_mpeg_audio_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001244 V4L2_MPEG_AUDIO_MODE_STEREO = 0,
1245 V4L2_MPEG_AUDIO_MODE_JOINT_STEREO = 1,
1246 V4L2_MPEG_AUDIO_MODE_DUAL = 2,
1247 V4L2_MPEG_AUDIO_MODE_MONO = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001248};
1249#define V4L2_CID_MPEG_AUDIO_MODE_EXTENSION (V4L2_CID_MPEG_BASE+106)
1250enum v4l2_mpeg_audio_mode_extension {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001251 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4 = 0,
1252 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8 = 1,
1253 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12 = 2,
1254 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001255};
1256#define V4L2_CID_MPEG_AUDIO_EMPHASIS (V4L2_CID_MPEG_BASE+107)
1257enum v4l2_mpeg_audio_emphasis {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001258 V4L2_MPEG_AUDIO_EMPHASIS_NONE = 0,
1259 V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS = 1,
1260 V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001261};
1262#define V4L2_CID_MPEG_AUDIO_CRC (V4L2_CID_MPEG_BASE+108)
1263enum v4l2_mpeg_audio_crc {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001264 V4L2_MPEG_AUDIO_CRC_NONE = 0,
1265 V4L2_MPEG_AUDIO_CRC_CRC16 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001266};
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001267#define V4L2_CID_MPEG_AUDIO_MUTE (V4L2_CID_MPEG_BASE+109)
Hans Verkuilf723af12008-08-09 10:35:29 -03001268#define V4L2_CID_MPEG_AUDIO_AAC_BITRATE (V4L2_CID_MPEG_BASE+110)
1269#define V4L2_CID_MPEG_AUDIO_AC3_BITRATE (V4L2_CID_MPEG_BASE+111)
Hans Verkuile6b5da82008-08-08 07:38:07 -03001270enum v4l2_mpeg_audio_ac3_bitrate {
1271 V4L2_MPEG_AUDIO_AC3_BITRATE_32K = 0,
1272 V4L2_MPEG_AUDIO_AC3_BITRATE_40K = 1,
1273 V4L2_MPEG_AUDIO_AC3_BITRATE_48K = 2,
1274 V4L2_MPEG_AUDIO_AC3_BITRATE_56K = 3,
1275 V4L2_MPEG_AUDIO_AC3_BITRATE_64K = 4,
1276 V4L2_MPEG_AUDIO_AC3_BITRATE_80K = 5,
1277 V4L2_MPEG_AUDIO_AC3_BITRATE_96K = 6,
1278 V4L2_MPEG_AUDIO_AC3_BITRATE_112K = 7,
1279 V4L2_MPEG_AUDIO_AC3_BITRATE_128K = 8,
1280 V4L2_MPEG_AUDIO_AC3_BITRATE_160K = 9,
1281 V4L2_MPEG_AUDIO_AC3_BITRATE_192K = 10,
1282 V4L2_MPEG_AUDIO_AC3_BITRATE_224K = 11,
1283 V4L2_MPEG_AUDIO_AC3_BITRATE_256K = 12,
1284 V4L2_MPEG_AUDIO_AC3_BITRATE_320K = 13,
1285 V4L2_MPEG_AUDIO_AC3_BITRATE_384K = 14,
1286 V4L2_MPEG_AUDIO_AC3_BITRATE_448K = 15,
1287 V4L2_MPEG_AUDIO_AC3_BITRATE_512K = 16,
1288 V4L2_MPEG_AUDIO_AC3_BITRATE_576K = 17,
1289 V4L2_MPEG_AUDIO_AC3_BITRATE_640K = 18,
1290};
Hans Verkuil4f341712006-06-18 13:27:19 -03001291
1292/* MPEG video */
1293#define V4L2_CID_MPEG_VIDEO_ENCODING (V4L2_CID_MPEG_BASE+200)
1294enum v4l2_mpeg_video_encoding {
Janne Grunau188919a2008-08-08 07:21:00 -03001295 V4L2_MPEG_VIDEO_ENCODING_MPEG_1 = 0,
1296 V4L2_MPEG_VIDEO_ENCODING_MPEG_2 = 1,
1297 V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001298};
1299#define V4L2_CID_MPEG_VIDEO_ASPECT (V4L2_CID_MPEG_BASE+201)
1300enum v4l2_mpeg_video_aspect {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001301 V4L2_MPEG_VIDEO_ASPECT_1x1 = 0,
1302 V4L2_MPEG_VIDEO_ASPECT_4x3 = 1,
1303 V4L2_MPEG_VIDEO_ASPECT_16x9 = 2,
1304 V4L2_MPEG_VIDEO_ASPECT_221x100 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001305};
1306#define V4L2_CID_MPEG_VIDEO_B_FRAMES (V4L2_CID_MPEG_BASE+202)
1307#define V4L2_CID_MPEG_VIDEO_GOP_SIZE (V4L2_CID_MPEG_BASE+203)
1308#define V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (V4L2_CID_MPEG_BASE+204)
1309#define V4L2_CID_MPEG_VIDEO_PULLDOWN (V4L2_CID_MPEG_BASE+205)
1310#define V4L2_CID_MPEG_VIDEO_BITRATE_MODE (V4L2_CID_MPEG_BASE+206)
1311enum v4l2_mpeg_video_bitrate_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001312 V4L2_MPEG_VIDEO_BITRATE_MODE_VBR = 0,
1313 V4L2_MPEG_VIDEO_BITRATE_MODE_CBR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001314};
1315#define V4L2_CID_MPEG_VIDEO_BITRATE (V4L2_CID_MPEG_BASE+207)
1316#define V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (V4L2_CID_MPEG_BASE+208)
1317#define V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (V4L2_CID_MPEG_BASE+209)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001318#define V4L2_CID_MPEG_VIDEO_MUTE (V4L2_CID_MPEG_BASE+210)
1319#define V4L2_CID_MPEG_VIDEO_MUTE_YUV (V4L2_CID_MPEG_BASE+211)
Hans Verkuil4f341712006-06-18 13:27:19 -03001320
Hans Verkuil4b00eb22008-12-19 11:17:56 -03001321/* MPEG-class control IDs specific to the CX2341x driver as defined by V4L2 */
Hans Verkuil4f341712006-06-18 13:27:19 -03001322#define V4L2_CID_MPEG_CX2341X_BASE (V4L2_CTRL_CLASS_MPEG | 0x1000)
1323#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+0)
1324enum v4l2_mpeg_cx2341x_video_spatial_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001325 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL = 0,
1326 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001327};
1328#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+1)
1329#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+2)
1330enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001331 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF = 0,
1332 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
1333 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT = 2,
1334 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE = 3,
1335 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001336};
1337#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+3)
1338enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001339 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF = 0,
1340 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001341};
1342#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+4)
1343enum v4l2_mpeg_cx2341x_video_temporal_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001344 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL = 0,
1345 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001346};
1347#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+5)
1348#define V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+6)
1349enum v4l2_mpeg_cx2341x_video_median_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001350 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF = 0,
1351 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR = 1,
1352 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT = 2,
1353 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT = 3,
1354 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001355};
1356#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+7)
1357#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+8)
1358#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+9)
1359#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+10)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001360#define V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (V4L2_CID_MPEG_CX2341X_BASE+11)
Hans Verkuil4f341712006-06-18 13:27:19 -03001361
Brandon Philipsf9bd5842008-04-22 14:42:02 -03001362/* Camera class control IDs */
1363#define V4L2_CID_CAMERA_CLASS_BASE (V4L2_CTRL_CLASS_CAMERA | 0x900)
1364#define V4L2_CID_CAMERA_CLASS (V4L2_CTRL_CLASS_CAMERA | 1)
1365
1366#define V4L2_CID_EXPOSURE_AUTO (V4L2_CID_CAMERA_CLASS_BASE+1)
1367enum v4l2_exposure_auto_type {
1368 V4L2_EXPOSURE_AUTO = 0,
1369 V4L2_EXPOSURE_MANUAL = 1,
1370 V4L2_EXPOSURE_SHUTTER_PRIORITY = 2,
1371 V4L2_EXPOSURE_APERTURE_PRIORITY = 3
1372};
1373#define V4L2_CID_EXPOSURE_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+2)
1374#define V4L2_CID_EXPOSURE_AUTO_PRIORITY (V4L2_CID_CAMERA_CLASS_BASE+3)
1375
1376#define V4L2_CID_PAN_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+4)
1377#define V4L2_CID_TILT_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+5)
1378#define V4L2_CID_PAN_RESET (V4L2_CID_CAMERA_CLASS_BASE+6)
1379#define V4L2_CID_TILT_RESET (V4L2_CID_CAMERA_CLASS_BASE+7)
1380
1381#define V4L2_CID_PAN_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+8)
1382#define V4L2_CID_TILT_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+9)
1383
1384#define V4L2_CID_FOCUS_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+10)
1385#define V4L2_CID_FOCUS_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+11)
1386#define V4L2_CID_FOCUS_AUTO (V4L2_CID_CAMERA_CLASS_BASE+12)
1387
Laurent Pinchart08772582008-12-14 16:21:16 -03001388#define V4L2_CID_ZOOM_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+13)
1389#define V4L2_CID_ZOOM_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+14)
1390#define V4L2_CID_ZOOM_CONTINUOUS (V4L2_CID_CAMERA_CLASS_BASE+15)
1391
Laurent Pinchart046425f2008-12-14 16:22:05 -03001392#define V4L2_CID_PRIVACY (V4L2_CID_CAMERA_CLASS_BASE+16)
1393
Laurent Pinchart48213fe2010-01-20 12:12:57 -03001394#define V4L2_CID_IRIS_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+17)
1395#define V4L2_CID_IRIS_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+18)
1396
Eduardo Valentin6b424942009-08-08 08:38:58 -03001397/* FM Modulator class control IDs */
1398#define V4L2_CID_FM_TX_CLASS_BASE (V4L2_CTRL_CLASS_FM_TX | 0x900)
1399#define V4L2_CID_FM_TX_CLASS (V4L2_CTRL_CLASS_FM_TX | 1)
1400
1401#define V4L2_CID_RDS_TX_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 1)
1402#define V4L2_CID_RDS_TX_PI (V4L2_CID_FM_TX_CLASS_BASE + 2)
1403#define V4L2_CID_RDS_TX_PTY (V4L2_CID_FM_TX_CLASS_BASE + 3)
1404#define V4L2_CID_RDS_TX_PS_NAME (V4L2_CID_FM_TX_CLASS_BASE + 5)
1405#define V4L2_CID_RDS_TX_RADIO_TEXT (V4L2_CID_FM_TX_CLASS_BASE + 6)
1406
1407#define V4L2_CID_AUDIO_LIMITER_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 64)
1408#define V4L2_CID_AUDIO_LIMITER_RELEASE_TIME (V4L2_CID_FM_TX_CLASS_BASE + 65)
1409#define V4L2_CID_AUDIO_LIMITER_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 66)
1410
1411#define V4L2_CID_AUDIO_COMPRESSION_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 80)
1412#define V4L2_CID_AUDIO_COMPRESSION_GAIN (V4L2_CID_FM_TX_CLASS_BASE + 81)
1413#define V4L2_CID_AUDIO_COMPRESSION_THRESHOLD (V4L2_CID_FM_TX_CLASS_BASE + 82)
1414#define V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME (V4L2_CID_FM_TX_CLASS_BASE + 83)
1415#define V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME (V4L2_CID_FM_TX_CLASS_BASE + 84)
1416
1417#define V4L2_CID_PILOT_TONE_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 96)
1418#define V4L2_CID_PILOT_TONE_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 97)
1419#define V4L2_CID_PILOT_TONE_FREQUENCY (V4L2_CID_FM_TX_CLASS_BASE + 98)
1420
1421#define V4L2_CID_TUNE_PREEMPHASIS (V4L2_CID_FM_TX_CLASS_BASE + 112)
1422enum v4l2_preemphasis {
1423 V4L2_PREEMPHASIS_DISABLED = 0,
1424 V4L2_PREEMPHASIS_50_uS = 1,
1425 V4L2_PREEMPHASIS_75_uS = 2,
1426};
1427#define V4L2_CID_TUNE_POWER_LEVEL (V4L2_CID_FM_TX_CLASS_BASE + 113)
1428#define V4L2_CID_TUNE_ANTENNA_CAPACITOR (V4L2_CID_FM_TX_CLASS_BASE + 114)
1429
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430/*
1431 * T U N I N G
1432 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001433struct v4l2_tuner {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 __u32 index;
1435 __u8 name[32];
1436 enum v4l2_tuner_type type;
1437 __u32 capability;
1438 __u32 rangelow;
1439 __u32 rangehigh;
1440 __u32 rxsubchans;
1441 __u32 audmode;
1442 __s32 signal;
1443 __s32 afc;
1444 __u32 reserved[4];
1445};
1446
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001447struct v4l2_modulator {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 __u32 index;
1449 __u8 name[32];
1450 __u32 capability;
1451 __u32 rangelow;
1452 __u32 rangehigh;
1453 __u32 txsubchans;
1454 __u32 reserved[4];
1455};
1456
1457/* Flags for the 'capability' field */
1458#define V4L2_TUNER_CAP_LOW 0x0001
1459#define V4L2_TUNER_CAP_NORM 0x0002
1460#define V4L2_TUNER_CAP_STEREO 0x0010
1461#define V4L2_TUNER_CAP_LANG2 0x0020
1462#define V4L2_TUNER_CAP_SAP 0x0020
1463#define V4L2_TUNER_CAP_LANG1 0x0040
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001464#define V4L2_TUNER_CAP_RDS 0x0080
Matti Aaltonen44a81552010-10-07 10:16:11 -03001465#define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1466#define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
1468/* Flags for the 'rxsubchans' field */
1469#define V4L2_TUNER_SUB_MONO 0x0001
1470#define V4L2_TUNER_SUB_STEREO 0x0002
1471#define V4L2_TUNER_SUB_LANG2 0x0004
1472#define V4L2_TUNER_SUB_SAP 0x0004
1473#define V4L2_TUNER_SUB_LANG1 0x0008
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001474#define V4L2_TUNER_SUB_RDS 0x0010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475
1476/* Values for the 'audmode' field */
1477#define V4L2_TUNER_MODE_MONO 0x0000
1478#define V4L2_TUNER_MODE_STEREO 0x0001
1479#define V4L2_TUNER_MODE_LANG2 0x0002
1480#define V4L2_TUNER_MODE_SAP 0x0002
1481#define V4L2_TUNER_MODE_LANG1 0x0003
Hans Verkuil301e22d2006-03-18 17:15:00 -03001482#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001484struct v4l2_frequency {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001485 __u32 tuner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 enum v4l2_tuner_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001487 __u32 frequency;
1488 __u32 reserved[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489};
1490
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -03001491struct v4l2_hw_freq_seek {
1492 __u32 tuner;
1493 enum v4l2_tuner_type type;
1494 __u32 seek_upward;
1495 __u32 wrap_around;
Matti Aaltonen44a81552010-10-07 10:16:11 -03001496 __u32 spacing;
1497 __u32 reserved[7];
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -03001498};
1499
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500/*
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001501 * R D S
1502 */
1503
1504struct v4l2_rds_data {
1505 __u8 lsb;
1506 __u8 msb;
1507 __u8 block;
1508} __attribute__ ((packed));
1509
1510#define V4L2_RDS_BLOCK_MSK 0x7
1511#define V4L2_RDS_BLOCK_A 0
1512#define V4L2_RDS_BLOCK_B 1
1513#define V4L2_RDS_BLOCK_C 2
1514#define V4L2_RDS_BLOCK_D 3
1515#define V4L2_RDS_BLOCK_C_ALT 4
1516#define V4L2_RDS_BLOCK_INVALID 7
1517
1518#define V4L2_RDS_BLOCK_CORRECTED 0x40
1519#define V4L2_RDS_BLOCK_ERROR 0x80
1520
1521/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 * A U D I O
1523 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001524struct v4l2_audio {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 __u32 index;
1526 __u8 name[32];
1527 __u32 capability;
1528 __u32 mode;
1529 __u32 reserved[2];
1530};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -03001531
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532/* Flags for the 'capability' field */
1533#define V4L2_AUDCAP_STEREO 0x00001
1534#define V4L2_AUDCAP_AVL 0x00002
1535
1536/* Flags for the 'mode' field */
1537#define V4L2_AUDMODE_AVL 0x00001
1538
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001539struct v4l2_audioout {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 __u32 index;
1541 __u8 name[32];
1542 __u32 capability;
1543 __u32 mode;
1544 __u32 reserved[2];
1545};
1546
1547/*
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001548 * M P E G S E R V I C E S
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001549 *
1550 * NOTE: EXPERIMENTAL API
1551 */
1552#if 1
1553#define V4L2_ENC_IDX_FRAME_I (0)
1554#define V4L2_ENC_IDX_FRAME_P (1)
1555#define V4L2_ENC_IDX_FRAME_B (2)
1556#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1557
1558struct v4l2_enc_idx_entry {
1559 __u64 offset;
1560 __u64 pts;
1561 __u32 length;
1562 __u32 flags;
1563 __u32 reserved[2];
1564};
1565
1566#define V4L2_ENC_IDX_ENTRIES (64)
1567struct v4l2_enc_idx {
1568 __u32 entries;
1569 __u32 entries_cap;
1570 __u32 reserved[4];
1571 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1572};
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001573
1574
1575#define V4L2_ENC_CMD_START (0)
1576#define V4L2_ENC_CMD_STOP (1)
1577#define V4L2_ENC_CMD_PAUSE (2)
1578#define V4L2_ENC_CMD_RESUME (3)
1579
1580/* Flags for V4L2_ENC_CMD_STOP */
1581#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1582
1583struct v4l2_encoder_cmd {
1584 __u32 cmd;
1585 __u32 flags;
1586 union {
1587 struct {
1588 __u32 data[8];
1589 } raw;
1590 };
1591};
1592
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001593#endif
1594
1595
1596/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 * D A T A S E R V I C E S ( V B I )
1598 *
1599 * Data services API by Michael Schimek
1600 */
1601
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001602/* Raw VBI */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001603struct v4l2_vbi_format {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 __u32 sampling_rate; /* in 1 Hz */
1605 __u32 offset;
1606 __u32 samples_per_line;
1607 __u32 sample_format; /* V4L2_PIX_FMT_* */
1608 __s32 start[2];
1609 __u32 count[2];
1610 __u32 flags; /* V4L2_VBI_* */
1611 __u32 reserved[2]; /* must be zero */
1612};
1613
1614/* VBI flags */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001615#define V4L2_VBI_UNSYNC (1 << 0)
1616#define V4L2_VBI_INTERLACED (1 << 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001618/* Sliced VBI
1619 *
1620 * This implements is a proposal V4L2 API to allow SLICED VBI
1621 * required for some hardware encoders. It should change without
1622 * notice in the definitive implementation.
1623 */
1624
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001625struct v4l2_sliced_vbi_format {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001626 __u16 service_set;
1627 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1628 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001629 (equals frame lines 313-336 for 625 line video
1630 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001631 __u16 service_lines[2][24];
1632 __u32 io_size;
1633 __u32 reserved[2]; /* must be zero */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001634};
1635
Mauro Carvalho Chehab4d0dddb2006-01-23 17:11:07 -02001636/* Teletext World System Teletext
1637 (WST), defined on ITU-R BT.653-2 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001638#define V4L2_SLICED_TELETEXT_B (0x0001)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001639/* Video Program System, defined on ETS 300 231*/
Hans Verkuil9bc74002006-03-29 18:02:51 -03001640#define V4L2_SLICED_VPS (0x0400)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001641/* Closed Caption, defined on EIA-608 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001642#define V4L2_SLICED_CAPTION_525 (0x1000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001643/* Wide Screen System, defined on ITU-R BT1119.1 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001644#define V4L2_SLICED_WSS_625 (0x4000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001645
Hans Verkuil9bc74002006-03-29 18:02:51 -03001646#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1647#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001648
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001649struct v4l2_sliced_vbi_cap {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001650 __u16 service_set;
1651 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1652 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001653 (equals frame lines 313-336 for 625 line video
1654 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001655 __u16 service_lines[2][24];
Hans Verkuil1739ade2006-08-26 03:05:17 -03001656 enum v4l2_buf_type type;
1657 __u32 reserved[3]; /* must be 0 */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001658};
1659
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001660struct v4l2_sliced_vbi_data {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001661 __u32 id;
1662 __u32 field; /* 0: first field, 1: second field */
1663 __u32 line; /* 1-23 */
1664 __u32 reserved; /* must be 0 */
1665 __u8 data[48];
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001666};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
1668/*
Andy Walls6273fda2009-03-14 17:06:07 -03001669 * Sliced VBI data inserted into MPEG Streams
1670 */
1671
1672/*
1673 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1674 *
1675 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1676 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1677 * data
1678 *
1679 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1680 * definitions are not included here. See the MPEG-2 specifications for details
1681 * on these headers.
1682 */
1683
1684/* Line type IDs */
1685#define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
1686#define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
1687#define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
1688#define V4L2_MPEG_VBI_IVTV_VPS (7)
1689
1690struct v4l2_mpeg_vbi_itv0_line {
1691 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
1692 __u8 data[42]; /* Sliced VBI data for the line */
1693} __attribute__ ((packed));
1694
1695struct v4l2_mpeg_vbi_itv0 {
1696 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
1697 struct v4l2_mpeg_vbi_itv0_line line[35];
1698} __attribute__ ((packed));
1699
1700struct v4l2_mpeg_vbi_ITV0 {
1701 struct v4l2_mpeg_vbi_itv0_line line[36];
1702} __attribute__ ((packed));
1703
1704#define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
1705#define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
1706
1707struct v4l2_mpeg_vbi_fmt_ivtv {
1708 __u8 magic[4];
1709 union {
1710 struct v4l2_mpeg_vbi_itv0 itv0;
1711 struct v4l2_mpeg_vbi_ITV0 ITV0;
1712 };
1713} __attribute__ ((packed));
1714
1715/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 * A G G R E G A T E S T R U C T U R E S
1717 */
1718
Pawel Osciakf8f39142010-07-29 14:44:25 -03001719/**
1720 * struct v4l2_plane_pix_format - additional, per-plane format definition
1721 * @sizeimage: maximum size in bytes required for data, for which
1722 * this plane will be used
1723 * @bytesperline: distance in bytes between the leftmost pixels in two
1724 * adjacent lines
1725 */
1726struct v4l2_plane_pix_format {
1727 __u32 sizeimage;
1728 __u16 bytesperline;
1729 __u16 reserved[7];
1730} __attribute__ ((packed));
1731
1732/**
1733 * struct v4l2_pix_format_mplane - multiplanar format definition
1734 * @width: image width in pixels
1735 * @height: image height in pixels
1736 * @pixelformat: little endian four character code (fourcc)
1737 * @field: field order (for interlaced video)
1738 * @colorspace: supplemental to pixelformat
1739 * @plane_fmt: per-plane information
1740 * @num_planes: number of planes for this format
1741 */
1742struct v4l2_pix_format_mplane {
1743 __u32 width;
1744 __u32 height;
1745 __u32 pixelformat;
1746 enum v4l2_field field;
1747 enum v4l2_colorspace colorspace;
1748
1749 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
1750 __u8 num_planes;
1751 __u8 reserved[11];
1752} __attribute__ ((packed));
1753
1754/**
1755 * struct v4l2_format - stream data format
1756 * @type: type of the data stream
1757 * @pix: definition of an image format
1758 * @pix_mp: definition of a multiplanar image format
1759 * @win: definition of an overlaid image
1760 * @vbi: raw VBI capture or output parameters
1761 * @sliced: sliced VBI capture or output parameters
1762 * @raw_data: placeholder for future extensions and custom formats
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001764struct v4l2_format {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 enum v4l2_buf_type type;
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001766 union {
1767 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
Pawel Osciakf8f39142010-07-29 14:44:25 -03001768 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001769 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
1770 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
1771 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
1772 __u8 raw_data[200]; /* user-defined */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 } fmt;
1774};
1775
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776/* Stream type-dependent parameters
1777 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001778struct v4l2_streamparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 enum v4l2_buf_type type;
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001780 union {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 struct v4l2_captureparm capture;
1782 struct v4l2_outputparm output;
1783 __u8 raw_data[200]; /* user-defined */
1784 } parm;
1785};
1786
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787/*
Sakari Ailusfda10212010-02-24 19:19:05 -03001788 * E V E N T S
1789 */
1790
Hans Verkuil1bcaf4b2010-03-27 14:09:52 -03001791#define V4L2_EVENT_ALL 0
1792#define V4L2_EVENT_VSYNC 1
1793#define V4L2_EVENT_EOS 2
1794#define V4L2_EVENT_PRIVATE_START 0x08000000
1795
1796/* Payload for V4L2_EVENT_VSYNC */
1797struct v4l2_event_vsync {
1798 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
1799 __u8 field;
1800} __attribute__ ((packed));
1801
Sakari Ailusfda10212010-02-24 19:19:05 -03001802struct v4l2_event {
1803 __u32 type;
1804 union {
Hans Verkuil1bcaf4b2010-03-27 14:09:52 -03001805 struct v4l2_event_vsync vsync;
Sakari Ailusfda10212010-02-24 19:19:05 -03001806 __u8 data[64];
1807 } u;
1808 __u32 pending;
1809 __u32 sequence;
1810 struct timespec timestamp;
1811 __u32 reserved[9];
1812};
1813
1814struct v4l2_event_subscription {
1815 __u32 type;
1816 __u32 reserved[7];
1817};
1818
Sakari Ailusfda10212010-02-24 19:19:05 -03001819/*
Trent Piepho52ebc762007-01-23 22:38:13 -03001820 * A D V A N C E D D E B U G G I N G
Hans Verkuilf3502b82007-02-23 21:16:01 -03001821 *
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001822 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
1823 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
Trent Piepho52ebc762007-01-23 22:38:13 -03001824 */
1825
1826/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001827
Hans Verkuilf3502b82007-02-23 21:16:01 -03001828#define V4L2_CHIP_MATCH_HOST 0 /* Match against chip ID on host (0 for the host) */
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001829#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
Hans Verkuilf3502b82007-02-23 21:16:01 -03001830#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Mauro Carvalho Chehab531c98e2008-12-22 13:18:27 -03001831#define V4L2_CHIP_MATCH_AC97 3 /* Match against anciliary AC97 chip */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001832
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001833struct v4l2_dbg_match {
1834 __u32 type; /* Match type */
1835 union { /* Match this chip, meaning determined by type */
1836 __u32 addr;
1837 char name[32];
1838 };
1839} __attribute__ ((packed));
1840
1841struct v4l2_dbg_register {
1842 struct v4l2_dbg_match match;
1843 __u32 size; /* register size in bytes */
Trent Piephoe7b58f52007-01-30 22:47:18 -03001844 __u64 reg;
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001845 __u64 val;
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001846} __attribute__ ((packed));
Trent Piepho52ebc762007-01-23 22:38:13 -03001847
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001848/* VIDIOC_DBG_G_CHIP_IDENT */
1849struct v4l2_dbg_chip_ident {
1850 struct v4l2_dbg_match match;
1851 __u32 ident; /* chip identifier as specified in <media/v4l2-chip-ident.h> */
1852 __u32 revision; /* chip revision, chip specific */
1853} __attribute__ ((packed));
1854
Trent Piepho52ebc762007-01-23 22:38:13 -03001855/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 * 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
1857 *
1858 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001859#define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
1860#define VIDIOC_RESERVED _IO('V', 1)
1861#define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
1862#define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
1863#define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
1864#define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
1865#define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
1866#define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
1867#define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
1868#define VIDIOC_OVERLAY _IOW('V', 14, int)
1869#define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
1870#define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
1871#define VIDIOC_STREAMON _IOW('V', 18, int)
1872#define VIDIOC_STREAMOFF _IOW('V', 19, int)
1873#define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
1874#define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
1875#define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
1876#define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
1877#define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
1878#define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
1879#define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
1880#define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
1881#define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
1882#define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
1883#define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
1884#define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
1885#define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
1886#define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
1887#define VIDIOC_G_INPUT _IOR('V', 38, int)
1888#define VIDIOC_S_INPUT _IOWR('V', 39, int)
1889#define VIDIOC_G_OUTPUT _IOR('V', 46, int)
1890#define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
1891#define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
1892#define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
1893#define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
1894#define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
1895#define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
1896#define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
1897#define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
1898#define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
1899#define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
1900#define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
1901#define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
1902#define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
1903#define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
1904#define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
1905#define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
1906#define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
1907#define VIDIOC_G_PRIORITY _IOR('V', 67, enum v4l2_priority)
1908#define VIDIOC_S_PRIORITY _IOW('V', 68, enum v4l2_priority)
1909#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
1910#define VIDIOC_LOG_STATUS _IO('V', 70)
1911#define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
1912#define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
1913#define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001914#if 1
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001915#define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
1916#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
1917#define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
1918#define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
1919#define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001920#endif
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001921
1922#if 1
1923/* Experimental, meant for debugging, testing and internal use.
1924 Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
1925 You must be root to use these ioctls. Never use these in applications! */
1926#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
1927#define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
1928
1929/* Experimental, meant for debugging, testing and internal use.
1930 Never use this ioctl in applications! */
1931#define VIDIOC_DBG_G_CHIP_IDENT _IOWR('V', 81, struct v4l2_dbg_chip_ident)
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001932#endif
1933
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001934#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001935#define VIDIOC_ENUM_DV_PRESETS _IOWR('V', 83, struct v4l2_dv_enum_preset)
1936#define VIDIOC_S_DV_PRESET _IOWR('V', 84, struct v4l2_dv_preset)
1937#define VIDIOC_G_DV_PRESET _IOWR('V', 85, struct v4l2_dv_preset)
1938#define VIDIOC_QUERY_DV_PRESET _IOR('V', 86, struct v4l2_dv_preset)
1939#define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
1940#define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
Sakari Ailusfda10212010-02-24 19:19:05 -03001941#define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
1942#define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
1943#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001944
Hans Verkuil92f45ba2008-12-21 10:35:25 -03001945/* Reminder: when adding new ioctls please add support for them to
1946 drivers/media/video/v4l2-compat-ioctl32.c as well! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1949
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950#endif /* __LINUX_VIDEODEV2_H */