blob: 5122b265dde66215752dcd7b64fc1ba0d35d0b39 [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 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300311#define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300312
313/* Palette formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300314#define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300315
316/* Luminance+Chrominance formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300317#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
318#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
319#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300320#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
321#define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300322#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
Robert Jarzmik69acdf12008-11-04 21:59:37 -0300323#define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300324#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
325#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 16 YVU411 planar */
326#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
327#define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
328#define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
329#define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
330#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 -0300331#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
332#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
333#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
334#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336/* two planes -- one Y, one Cr + Cb interleaved */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300337#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
338#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
Magnus Damm91962fa2008-12-18 11:45:00 -0300339#define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
340#define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
Sylwester Nawrocki4a3c9b42010-12-28 12:32:39 -0300342/* two non contiguous planes - one Y, one Cr + Cb interleaved */
343#define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
344#define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
345
346/* three non contiguous planes - Y, Cb, Cr */
347#define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
348
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300349/* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300350#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
351#define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
Mauro Carvalho Chehab509dd022009-06-30 16:07:26 -0300352#define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
Guennadi Liakhovetskiee811522009-12-11 11:15:06 -0300353#define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
354#define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
355#define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
356#define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
357#define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300358 /* 10bit raw bayer DPCM compressed to 8 bits */
Sergio Aguirre733d7102008-10-18 12:26:47 -0300359#define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300360 /*
361 * 10bit raw bayer, expanded to 16 bits
362 * xxxxrrrrrrrrrrxxxxgggggggggg xxxxggggggggggxxxxbbbbbbbbbb...
363 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300364#define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
366/* compressed formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300367#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
368#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
369#define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
370#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
372/* Vendor-specific formats */
Hans de Goede54e8bc52010-01-14 09:37:18 -0300373#define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300374#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
375#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
Brian Johnson26e744b2009-07-19 05:52:58 -0300376#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 -0300377#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
378#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
379#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
380#define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
Mauro Carvalho Chehab9fa0f6d2008-07-27 08:55:17 -0300381#define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
382#define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300383#define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
384#define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
Kyle Guinn553d0d82009-01-16 05:28:38 -0300385#define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
Theodore Kilgore5bdd00b2009-12-25 05:16:32 -0300386#define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
Theodore Kilgore14a19c02009-03-25 07:13:13 -0300387#define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
Jean-Francois Moinef75c4952008-09-03 16:47:35 -0300388#define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
Hans de Goede1876bb92009-06-14 06:45:50 -0300389#define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
Hans de Goede49809d62009-06-07 12:10:39 -0300390#define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
Hans de Goede21f1b932009-10-23 06:50:12 -0300391#define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
Mauro Carvalho Chehab9701dc92009-09-14 09:42:41 -0300392#define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
Hans de Goede1f33de02010-09-05 16:05:22 -0300393#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 -0300394#define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
396/*
397 * F O R M A T E N U M E R A T I O N
398 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300399struct v4l2_fmtdesc {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800400 __u32 index; /* Format number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 enum v4l2_buf_type type; /* buffer type */
402 __u32 flags;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800403 __u8 description[32]; /* Description string */
404 __u32 pixelformat; /* Format fourcc */
405 __u32 reserved[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406};
407
408#define V4L2_FMT_FLAG_COMPRESSED 0x0001
Hans de Goede1e3c1f72009-08-31 11:32:46 -0300409#define V4L2_FMT_FLAG_EMULATED 0x0002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300411#if 1
412 /* Experimental Frame Size and frame rate enumeration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413/*
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300414 * F R A M E S I Z E E N U M E R A T I O N
415 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300416enum v4l2_frmsizetypes {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300417 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
418 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
419 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
420};
421
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300422struct v4l2_frmsize_discrete {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300423 __u32 width; /* Frame width [pixel] */
424 __u32 height; /* Frame height [pixel] */
425};
426
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300427struct v4l2_frmsize_stepwise {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300428 __u32 min_width; /* Minimum frame width [pixel] */
429 __u32 max_width; /* Maximum frame width [pixel] */
430 __u32 step_width; /* Frame width step size [pixel] */
431 __u32 min_height; /* Minimum frame height [pixel] */
432 __u32 max_height; /* Maximum frame height [pixel] */
433 __u32 step_height; /* Frame height step size [pixel] */
434};
435
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300436struct v4l2_frmsizeenum {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300437 __u32 index; /* Frame size number */
438 __u32 pixel_format; /* Pixel format */
439 __u32 type; /* Frame size type the device supports. */
440
441 union { /* Frame size */
442 struct v4l2_frmsize_discrete discrete;
443 struct v4l2_frmsize_stepwise stepwise;
444 };
445
446 __u32 reserved[2]; /* Reserved space for future use */
447};
448
449/*
450 * F R A M E R A T E E N U M E R A T I O N
451 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300452enum v4l2_frmivaltypes {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300453 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
454 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
455 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
456};
457
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300458struct v4l2_frmival_stepwise {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300459 struct v4l2_fract min; /* Minimum frame interval [s] */
460 struct v4l2_fract max; /* Maximum frame interval [s] */
461 struct v4l2_fract step; /* Frame interval step size [s] */
462};
463
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300464struct v4l2_frmivalenum {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300465 __u32 index; /* Frame format index */
466 __u32 pixel_format; /* Pixel format */
467 __u32 width; /* Frame width */
468 __u32 height; /* Frame height */
469 __u32 type; /* Frame interval type the device supports. */
470
471 union { /* Frame interval */
472 struct v4l2_fract discrete;
473 struct v4l2_frmival_stepwise stepwise;
474 };
475
476 __u32 reserved[2]; /* Reserved space for future use */
477};
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300478#endif
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300479
480/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 * T I M E C O D E
482 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300483struct v4l2_timecode {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 __u32 type;
485 __u32 flags;
486 __u8 frames;
487 __u8 seconds;
488 __u8 minutes;
489 __u8 hours;
490 __u8 userbits[4];
491};
492
493/* Type */
494#define V4L2_TC_TYPE_24FPS 1
495#define V4L2_TC_TYPE_25FPS 2
496#define V4L2_TC_TYPE_30FPS 3
497#define V4L2_TC_TYPE_50FPS 4
498#define V4L2_TC_TYPE_60FPS 5
499
500/* Flags */
501#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
502#define V4L2_TC_FLAG_COLORFRAME 0x0002
503#define V4L2_TC_USERBITS_field 0x000C
504#define V4L2_TC_USERBITS_USERDEFINED 0x0000
505#define V4L2_TC_USERBITS_8BITCHARS 0x0008
506/* The above is based on SMPTE timecodes */
507
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300508struct v4l2_jpegcompression {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 int quality;
510
511 int APPn; /* Number of APP segment to be written,
512 * must be 0..15 */
513 int APP_len; /* Length of data in JPEG APPn segment */
514 char APP_data[60]; /* Data in the JPEG APPn segment. */
515
516 int COM_len; /* Length of data in JPEG COM segment */
517 char COM_data[60]; /* Data in JPEG COM segment */
518
519 __u32 jpeg_markers; /* Which markers should go into the JPEG
520 * output. Unless you exactly know what
521 * you do, leave them untouched.
522 * Inluding less markers will make the
523 * resulting code smaller, but there will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200524 * be fewer applications which can read it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 * The presence of the APP and COM marker
526 * is influenced by APP_len and COM_len
527 * ONLY, not by this property! */
528
529#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
530#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
531#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
532#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
533#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -0800534 * allways use APP0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535};
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537/*
538 * M E M O R Y - M A P P I N G B U F F E R S
539 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300540struct v4l2_requestbuffers {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800541 __u32 count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 enum v4l2_buf_type type;
543 enum v4l2_memory memory;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800544 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545};
546
Pawel Osciakf8f39142010-07-29 14:44:25 -0300547/**
548 * struct v4l2_plane - plane info for multi-planar buffers
549 * @bytesused: number of bytes occupied by data in the plane (payload)
550 * @length: size of this plane (NOT the payload) in bytes
551 * @mem_offset: when memory in the associated struct v4l2_buffer is
552 * V4L2_MEMORY_MMAP, equals the offset from the start of
553 * the device memory for this plane (or is a "cookie" that
554 * should be passed to mmap() called on the video node)
555 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
556 * pointing to this plane
557 * @data_offset: offset in the plane to the start of data; usually 0,
558 * unless there is a header in front of the data
559 *
560 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
561 * with two planes can have one plane for Y, and another for interleaved CbCr
562 * components. Each plane can reside in a separate memory buffer, or even in
563 * a completely separate memory node (e.g. in embedded devices).
564 */
565struct v4l2_plane {
566 __u32 bytesused;
567 __u32 length;
568 union {
569 __u32 mem_offset;
570 unsigned long userptr;
571 } m;
572 __u32 data_offset;
573 __u32 reserved[11];
574};
575
576/**
577 * struct v4l2_buffer - video buffer info
578 * @index: id number of the buffer
579 * @type: buffer type (type == *_MPLANE for multiplanar buffers)
580 * @bytesused: number of bytes occupied by data in the buffer (payload);
581 * unused (set to 0) for multiplanar buffers
582 * @flags: buffer informational flags
583 * @field: field order of the image in the buffer
584 * @timestamp: frame timestamp
585 * @timecode: frame timecode
586 * @sequence: sequence count of this frame
587 * @memory: the method, in which the actual video data is passed
588 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
589 * offset from the start of the device memory for this plane,
590 * (or a "cookie" that should be passed to mmap() as offset)
591 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
592 * a userspace pointer pointing to this buffer
593 * @planes: for multiplanar buffers; userspace pointer to the array of plane
594 * info structs for this buffer
595 * @length: size in bytes of the buffer (NOT its payload) for single-plane
596 * buffers (when type != *_MPLANE); number of elements in the
597 * planes array for multi-plane buffers
598 * @input: input number from which the video data has has been captured
599 *
600 * Contains data exchanged by application and driver using one of the Streaming
601 * I/O methods.
602 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300603struct v4l2_buffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 __u32 index;
605 enum v4l2_buf_type type;
606 __u32 bytesused;
607 __u32 flags;
608 enum v4l2_field field;
609 struct timeval timestamp;
610 struct v4l2_timecode timecode;
611 __u32 sequence;
612
613 /* memory location */
614 enum v4l2_memory memory;
615 union {
616 __u32 offset;
617 unsigned long userptr;
Pawel Osciakf8f39142010-07-29 14:44:25 -0300618 struct v4l2_plane *planes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 } m;
620 __u32 length;
621 __u32 input;
622 __u32 reserved;
623};
624
625/* Flags for 'flags' field */
626#define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
627#define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
628#define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
629#define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
630#define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
631#define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
Pawel Osciakbc0f7f12010-04-28 04:05:21 -0300632/* Buffer is ready, but the data contained within is corrupted. */
633#define V4L2_BUF_FLAG_ERROR 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634#define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
635#define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
636
637/*
638 * O V E R L A Y P R E V I E W
639 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300640struct v4l2_framebuffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 __u32 capability;
642 __u32 flags;
643/* FIXME: in theory we should pass something like PCI device + memory
644 * region + offset instead of some physical address */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300645 void *base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 struct v4l2_pix_format fmt;
647};
648/* Flags for the 'capability' field. Read only */
649#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
650#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
651#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
652#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
Hans Verkuilb2787842007-04-27 12:31:02 -0300653#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
654#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300655#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
Vaibhav Hiremathd8008562009-11-10 13:46:36 -0300656#define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657/* Flags for the 'flags' field. */
658#define V4L2_FBUF_FLAG_PRIMARY 0x0001
659#define V4L2_FBUF_FLAG_OVERLAY 0x0002
660#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
Hans Verkuilb2787842007-04-27 12:31:02 -0300661#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
662#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300663#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
Vaibhav Hiremathd8008562009-11-10 13:46:36 -0300664#define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300666struct v4l2_clip {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 struct v4l2_rect c;
Al Viro5b1a43d2006-02-01 05:24:20 -0500668 struct v4l2_clip __user *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669};
670
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300671struct v4l2_window {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 struct v4l2_rect w;
673 enum v4l2_field field;
674 __u32 chromakey;
675 struct v4l2_clip __user *clips;
676 __u32 clipcount;
677 void __user *bitmap;
Hans Verkuilb2787842007-04-27 12:31:02 -0300678 __u8 global_alpha;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679};
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681/*
682 * C A P T U R E P A R A M E T E R S
683 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300684struct v4l2_captureparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 __u32 capability; /* Supported modes */
686 __u32 capturemode; /* Current mode */
687 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
688 __u32 extendedmode; /* Driver-specific extensions */
689 __u32 readbuffers; /* # of buffers for read */
690 __u32 reserved[4];
691};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300692
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693/* Flags for 'capability' and 'capturemode' fields */
694#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
695#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
696
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300697struct v4l2_outputparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 __u32 capability; /* Supported modes */
699 __u32 outputmode; /* Current mode */
700 struct v4l2_fract timeperframe; /* Time per frame in seconds */
701 __u32 extendedmode; /* Driver-specific extensions */
702 __u32 writebuffers; /* # of buffers for write */
703 __u32 reserved[4];
704};
705
706/*
707 * I N P U T I M A G E C R O P P I N G
708 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709struct v4l2_cropcap {
710 enum v4l2_buf_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800711 struct v4l2_rect bounds;
712 struct v4l2_rect defrect;
713 struct v4l2_fract pixelaspect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714};
715
716struct v4l2_crop {
717 enum v4l2_buf_type type;
718 struct v4l2_rect c;
719};
720
721/*
722 * A N A L O G V I D E O S T A N D A R D
723 */
724
725typedef __u64 v4l2_std_id;
726
727/* one bit for each */
728#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
729#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
730#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
731#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
732#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
733#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
734#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
735#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
736
737#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
738#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
739#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
740#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
741
742#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
743#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800744#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
Hans Verkuild97a11e2006-02-07 06:48:40 -0200745#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
747#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
748#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
749#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
750#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
751#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
752#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
753#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
Mauro Carvalho Chehab800d3c62005-11-13 16:07:48 -0800754#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756/* ATSC/HDTV */
757#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
758#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
759
Mauro Carvalho Chehab412297d2007-01-07 08:51:05 -0300760/* FIXME:
761 Although std_id is 64 bits, there is an issue on PPC32 architecture that
762 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
763 this value to 32 bits.
764 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
765 it should work fine. However, if needed to add more than two standards,
766 v4l2-common.c should be fixed.
767 */
768
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200769/* some merged standards */
770#define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
771#define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
772#define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
773#define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
774
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775/* some common needed stuff */
776#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
777 V4L2_STD_PAL_B1 |\
778 V4L2_STD_PAL_G)
779#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
780 V4L2_STD_PAL_D1 |\
781 V4L2_STD_PAL_K)
782#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
783 V4L2_STD_PAL_DK |\
784 V4L2_STD_PAL_H |\
785 V4L2_STD_PAL_I)
786#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
Hans Verkuild97a11e2006-02-07 06:48:40 -0200787 V4L2_STD_NTSC_M_JP |\
788 V4L2_STD_NTSC_M_KR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
790 V4L2_STD_SECAM_K |\
791 V4L2_STD_SECAM_K1)
792#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
793 V4L2_STD_SECAM_G |\
794 V4L2_STD_SECAM_H |\
795 V4L2_STD_SECAM_DK |\
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200796 V4L2_STD_SECAM_L |\
797 V4L2_STD_SECAM_LC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
799#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
800 V4L2_STD_PAL_60 |\
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800801 V4L2_STD_NTSC |\
802 V4L2_STD_NTSC_443)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803#define V4L2_STD_625_50 (V4L2_STD_PAL |\
804 V4L2_STD_PAL_N |\
805 V4L2_STD_PAL_Nc |\
806 V4L2_STD_SECAM)
807#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800808 V4L2_STD_ATSC_16_VSB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
810#define V4L2_STD_UNKNOWN 0
811#define V4L2_STD_ALL (V4L2_STD_525_60 |\
812 V4L2_STD_625_50)
813
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300814struct v4l2_standard {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800815 __u32 index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 v4l2_std_id id;
817 __u8 name[24];
818 struct v4l2_fract frameperiod; /* Frames, not fields */
819 __u32 framelines;
820 __u32 reserved[4];
821};
822
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823/*
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300824 * V I D E O T I M I N G S D V P R E S E T
825 */
826struct v4l2_dv_preset {
827 __u32 preset;
828 __u32 reserved[4];
829};
830
831/*
832 * D V P R E S E T S E N U M E R A T I O N
833 */
834struct v4l2_dv_enum_preset {
835 __u32 index;
836 __u32 preset;
837 __u8 name[32]; /* Name of the preset timing */
838 __u32 width;
839 __u32 height;
840 __u32 reserved[4];
841};
842
843/*
844 * D V P R E S E T V A L U E S
845 */
846#define V4L2_DV_INVALID 0
847#define V4L2_DV_480P59_94 1 /* BT.1362 */
848#define V4L2_DV_576P50 2 /* BT.1362 */
849#define V4L2_DV_720P24 3 /* SMPTE 296M */
850#define V4L2_DV_720P25 4 /* SMPTE 296M */
851#define V4L2_DV_720P30 5 /* SMPTE 296M */
852#define V4L2_DV_720P50 6 /* SMPTE 296M */
853#define V4L2_DV_720P59_94 7 /* SMPTE 274M */
854#define V4L2_DV_720P60 8 /* SMPTE 274M/296M */
855#define V4L2_DV_1080I29_97 9 /* BT.1120/ SMPTE 274M */
856#define V4L2_DV_1080I30 10 /* BT.1120/ SMPTE 274M */
857#define V4L2_DV_1080I25 11 /* BT.1120 */
858#define V4L2_DV_1080I50 12 /* SMPTE 296M */
859#define V4L2_DV_1080I60 13 /* SMPTE 296M */
860#define V4L2_DV_1080P24 14 /* SMPTE 296M */
861#define V4L2_DV_1080P25 15 /* SMPTE 296M */
862#define V4L2_DV_1080P30 16 /* SMPTE 296M */
863#define V4L2_DV_1080P50 17 /* BT.1120 */
864#define V4L2_DV_1080P60 18 /* BT.1120 */
865
866/*
867 * D V B T T I M I N G S
868 */
869
870/* BT.656/BT.1120 timing data */
871struct v4l2_bt_timings {
872 __u32 width; /* width in pixels */
873 __u32 height; /* height in lines */
874 __u32 interlaced; /* Interlaced or progressive */
875 __u32 polarities; /* Positive or negative polarity */
876 __u64 pixelclock; /* Pixel clock in HZ. Ex. 74.25MHz->74250000 */
877 __u32 hfrontporch; /* Horizpontal front porch in pixels */
878 __u32 hsync; /* Horizontal Sync length in pixels */
879 __u32 hbackporch; /* Horizontal back porch in pixels */
880 __u32 vfrontporch; /* Vertical front porch in pixels */
881 __u32 vsync; /* Vertical Sync length in lines */
882 __u32 vbackporch; /* Vertical back porch in lines */
883 __u32 il_vfrontporch; /* Vertical front porch for bottom field of
884 * interlaced field formats
885 */
886 __u32 il_vsync; /* Vertical sync length for bottom field of
887 * interlaced field formats
888 */
889 __u32 il_vbackporch; /* Vertical back porch for bottom field of
890 * interlaced field formats
891 */
892 __u32 reserved[16];
893} __attribute__ ((packed));
894
895/* Interlaced or progressive format */
896#define V4L2_DV_PROGRESSIVE 0
897#define V4L2_DV_INTERLACED 1
898
899/* Polarities. If bit is not set, it is assumed to be negative polarity */
900#define V4L2_DV_VSYNC_POS_POL 0x00000001
901#define V4L2_DV_HSYNC_POS_POL 0x00000002
902
903
904/* DV timings */
905struct v4l2_dv_timings {
906 __u32 type;
907 union {
908 struct v4l2_bt_timings bt;
909 __u32 reserved[32];
910 };
911} __attribute__ ((packed));
912
913/* Values for the type field */
914#define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
915
916/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 * V I D E O I N P U T S
918 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300919struct v4l2_input {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 __u32 index; /* Which input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800921 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 __u32 type; /* Type of input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800923 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 __u32 tuner; /* Associated tuner */
925 v4l2_std_id std;
926 __u32 status;
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300927 __u32 capabilities;
928 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300930
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931/* Values for the 'type' field */
932#define V4L2_INPUT_TYPE_TUNER 1
933#define V4L2_INPUT_TYPE_CAMERA 2
934
935/* field 'status' - general */
936#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
937#define V4L2_IN_ST_NO_SIGNAL 0x00000002
938#define V4L2_IN_ST_NO_COLOR 0x00000004
939
Adam Bakerdfa76fa2009-03-29 19:17:10 -0300940/* field 'status' - sensor orientation */
941/* If sensor is mounted upside down set both bits */
942#define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
943#define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
944
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945/* field 'status' - analog */
946#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
947#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
948
949/* field 'status' - digital */
950#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
951#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
952#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
953
954/* field 'status' - VCR and set-top box */
955#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
956#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
957#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
958
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300959/* capabilities flags */
960#define V4L2_IN_CAP_PRESETS 0x00000001 /* Supports S_DV_PRESET */
961#define V4L2_IN_CAP_CUSTOM_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
962#define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964/*
965 * V I D E O O U T P U T S
966 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300967struct v4l2_output {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 __u32 index; /* Which output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800969 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 __u32 type; /* Type of output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800971 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 __u32 modulator; /* Associated modulator */
973 v4l2_std_id std;
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300974 __u32 capabilities;
975 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976};
977/* Values for the 'type' field */
978#define V4L2_OUTPUT_TYPE_MODULATOR 1
979#define V4L2_OUTPUT_TYPE_ANALOG 2
980#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
981
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300982/* capabilities flags */
983#define V4L2_OUT_CAP_PRESETS 0x00000001 /* Supports S_DV_PRESET */
984#define V4L2_OUT_CAP_CUSTOM_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
985#define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987/*
988 * C O N T R O L S
989 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300990struct v4l2_control {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 __u32 id;
992 __s32 value;
993};
994
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300995struct v4l2_ext_control {
Hans Verkuil4f341712006-06-18 13:27:19 -0300996 __u32 id;
Hans Verkuil6b5a9492009-08-11 18:47:18 -0300997 __u32 size;
998 __u32 reserved2[1];
Hans Verkuil4f341712006-06-18 13:27:19 -0300999 union {
1000 __s32 value;
1001 __s64 value64;
Hans Verkuil6b5a9492009-08-11 18:47:18 -03001002 char *string;
Hans Verkuil4f341712006-06-18 13:27:19 -03001003 };
Mauro Carvalho Chehabf251d232006-07-22 08:20:07 -03001004} __attribute__ ((packed));
Hans Verkuil4f341712006-06-18 13:27:19 -03001005
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001006struct v4l2_ext_controls {
Hans Verkuil4f341712006-06-18 13:27:19 -03001007 __u32 ctrl_class;
1008 __u32 count;
1009 __u32 error_idx;
1010 __u32 reserved[2];
1011 struct v4l2_ext_control *controls;
1012};
1013
1014/* Values for ctrl_class field */
1015#define V4L2_CTRL_CLASS_USER 0x00980000 /* Old-style 'user' controls */
1016#define V4L2_CTRL_CLASS_MPEG 0x00990000 /* MPEG-compression controls */
Brandon Philipsf9bd5842008-04-22 14:42:02 -03001017#define V4L2_CTRL_CLASS_CAMERA 0x009a0000 /* Camera class controls */
Eduardo Valentin6b424942009-08-08 08:38:58 -03001018#define V4L2_CTRL_CLASS_FM_TX 0x009b0000 /* FM Modulator control class */
Hans Verkuil4f341712006-06-18 13:27:19 -03001019
1020#define V4L2_CTRL_ID_MASK (0x0fffffff)
1021#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1022#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1023
Hans Verkuilea64f8c2010-04-06 06:53:57 -03001024enum v4l2_ctrl_type {
1025 V4L2_CTRL_TYPE_INTEGER = 1,
1026 V4L2_CTRL_TYPE_BOOLEAN = 2,
1027 V4L2_CTRL_TYPE_MENU = 3,
1028 V4L2_CTRL_TYPE_BUTTON = 4,
1029 V4L2_CTRL_TYPE_INTEGER64 = 5,
1030 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1031 V4L2_CTRL_TYPE_STRING = 7,
1032};
1033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001035struct v4l2_queryctrl {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001036 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 enum v4l2_ctrl_type type;
1038 __u8 name[32]; /* Whatever */
1039 __s32 minimum; /* Note signedness */
1040 __s32 maximum;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001041 __s32 step;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 __s32 default_value;
1043 __u32 flags;
1044 __u32 reserved[2];
1045};
1046
1047/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001048struct v4l2_querymenu {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 __u32 id;
1050 __u32 index;
1051 __u8 name[32]; /* Whatever */
1052 __u32 reserved;
1053};
1054
1055/* Control flags */
1056#define V4L2_CTRL_FLAG_DISABLED 0x0001
1057#define V4L2_CTRL_FLAG_GRABBED 0x0002
Hans Verkuil4f341712006-06-18 13:27:19 -03001058#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1059#define V4L2_CTRL_FLAG_UPDATE 0x0008
1060#define V4L2_CTRL_FLAG_INACTIVE 0x0010
1061#define V4L2_CTRL_FLAG_SLIDER 0x0020
Hans Verkuil1a367f32009-02-20 05:55:39 -03001062#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
Hans Verkuil4f341712006-06-18 13:27:19 -03001064/* Query flag, to be ORed with the control ID */
1065#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1066
1067/* User-class control IDs defined by V4L2 */
1068#define V4L2_CID_BASE (V4L2_CTRL_CLASS_USER | 0x900)
1069#define V4L2_CID_USER_BASE V4L2_CID_BASE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070/* IDs reserved for driver specific controls */
1071#define V4L2_CID_PRIVATE_BASE 0x08000000
1072
Hans Verkuil4f341712006-06-18 13:27:19 -03001073#define V4L2_CID_USER_CLASS (V4L2_CTRL_CLASS_USER | 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074#define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
1075#define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
1076#define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
1077#define V4L2_CID_HUE (V4L2_CID_BASE+3)
1078#define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
1079#define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
1080#define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
1081#define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
1082#define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
1083#define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
Brandon Philips26d507f2008-04-22 14:42:02 -03001084#define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11) /* Deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085#define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
1086#define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
1087#define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
1088#define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
1089#define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
Brandon Philips26d507f2008-04-22 14:42:02 -03001090#define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* Deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091#define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
1092#define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
1093#define V4L2_CID_GAIN (V4L2_CID_BASE+19)
1094#define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
1095#define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
Brandon Philips26d507f2008-04-22 14:42:02 -03001096
David Woodhouse39028ec2008-06-02 15:46:51 -03001097/* Deprecated; use V4L2_CID_PAN_RESET and V4L2_CID_TILT_RESET */
1098#define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
1099#define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
Brandon Philips26d507f2008-04-22 14:42:02 -03001100
1101#define V4L2_CID_POWER_LINE_FREQUENCY (V4L2_CID_BASE+24)
1102enum v4l2_power_line_frequency {
1103 V4L2_CID_POWER_LINE_FREQUENCY_DISABLED = 0,
1104 V4L2_CID_POWER_LINE_FREQUENCY_50HZ = 1,
1105 V4L2_CID_POWER_LINE_FREQUENCY_60HZ = 2,
1106};
1107#define V4L2_CID_HUE_AUTO (V4L2_CID_BASE+25)
1108#define V4L2_CID_WHITE_BALANCE_TEMPERATURE (V4L2_CID_BASE+26)
1109#define V4L2_CID_SHARPNESS (V4L2_CID_BASE+27)
1110#define V4L2_CID_BACKLIGHT_COMPENSATION (V4L2_CID_BASE+28)
Frej Drejhammar1c412d12008-03-23 22:43:20 -03001111#define V4L2_CID_CHROMA_AGC (V4L2_CID_BASE+29)
Frej Drejhammara8ac6882008-03-23 22:43:23 -03001112#define V4L2_CID_COLOR_KILLER (V4L2_CID_BASE+30)
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001113#define V4L2_CID_COLORFX (V4L2_CID_BASE+31)
1114enum v4l2_colorfx {
1115 V4L2_COLORFX_NONE = 0,
1116 V4L2_COLORFX_BW = 1,
1117 V4L2_COLORFX_SEPIA = 2,
Xiaolin Zhang35e6aa92010-04-18 23:06:50 -03001118 V4L2_COLORFX_NEGATIVE = 3,
1119 V4L2_COLORFX_EMBOSS = 4,
1120 V4L2_COLORFX_SKETCH = 5,
1121 V4L2_COLORFX_SKY_BLUE = 6,
1122 V4L2_COLORFX_GRASS_GREEN = 7,
1123 V4L2_COLORFX_SKIN_WHITEN = 8,
1124 V4L2_COLORFX_VIVID = 9,
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001125};
Hans de Goede02ab18b2009-06-14 04:32:04 -03001126#define V4L2_CID_AUTOBRIGHTNESS (V4L2_CID_BASE+32)
Guennadi Liakhovetski3418f162009-08-25 11:44:14 -03001127#define V4L2_CID_BAND_STOP_FILTER (V4L2_CID_BASE+33)
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001128
Vaibhav Hiremath85213632009-11-10 13:32:53 -03001129#define V4L2_CID_ROTATE (V4L2_CID_BASE+34)
1130#define V4L2_CID_BG_COLOR (V4L2_CID_BASE+35)
Devin Heitmueller7a01f6d2010-03-11 21:27:59 -03001131
1132#define V4L2_CID_CHROMA_GAIN (V4L2_CID_BASE+36)
1133
Jean-François Moine008d35f2010-09-13 07:04:49 -03001134#define V4L2_CID_ILLUMINATORS_1 (V4L2_CID_BASE+37)
1135#define V4L2_CID_ILLUMINATORS_2 (V4L2_CID_BASE+38)
1136
Frej Drejhammar1c412d12008-03-23 22:43:20 -03001137/* last CID + 1 */
Jean-François Moine008d35f2010-09-13 07:04:49 -03001138#define V4L2_CID_LASTP1 (V4L2_CID_BASE+39)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
Hans Verkuil4f341712006-06-18 13:27:19 -03001140/* MPEG-class control IDs defined by V4L2 */
1141#define V4L2_CID_MPEG_BASE (V4L2_CTRL_CLASS_MPEG | 0x900)
1142#define V4L2_CID_MPEG_CLASS (V4L2_CTRL_CLASS_MPEG | 1)
1143
1144/* MPEG streams */
1145#define V4L2_CID_MPEG_STREAM_TYPE (V4L2_CID_MPEG_BASE+0)
1146enum v4l2_mpeg_stream_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001147 V4L2_MPEG_STREAM_TYPE_MPEG2_PS = 0, /* MPEG-2 program stream */
1148 V4L2_MPEG_STREAM_TYPE_MPEG2_TS = 1, /* MPEG-2 transport stream */
1149 V4L2_MPEG_STREAM_TYPE_MPEG1_SS = 2, /* MPEG-1 system stream */
1150 V4L2_MPEG_STREAM_TYPE_MPEG2_DVD = 3, /* MPEG-2 DVD-compatible stream */
1151 V4L2_MPEG_STREAM_TYPE_MPEG1_VCD = 4, /* MPEG-1 VCD-compatible stream */
1152 V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD = 5, /* MPEG-2 SVCD-compatible stream */
Hans Verkuil4f341712006-06-18 13:27:19 -03001153};
1154#define V4L2_CID_MPEG_STREAM_PID_PMT (V4L2_CID_MPEG_BASE+1)
1155#define V4L2_CID_MPEG_STREAM_PID_AUDIO (V4L2_CID_MPEG_BASE+2)
1156#define V4L2_CID_MPEG_STREAM_PID_VIDEO (V4L2_CID_MPEG_BASE+3)
1157#define V4L2_CID_MPEG_STREAM_PID_PCR (V4L2_CID_MPEG_BASE+4)
1158#define V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (V4L2_CID_MPEG_BASE+5)
1159#define V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (V4L2_CID_MPEG_BASE+6)
Hans Verkuil8cbde942006-06-24 14:36:02 -03001160#define V4L2_CID_MPEG_STREAM_VBI_FMT (V4L2_CID_MPEG_BASE+7)
1161enum v4l2_mpeg_stream_vbi_fmt {
1162 V4L2_MPEG_STREAM_VBI_FMT_NONE = 0, /* No VBI in the MPEG stream */
1163 V4L2_MPEG_STREAM_VBI_FMT_IVTV = 1, /* VBI in private packets, IVTV format */
1164};
Hans Verkuil4f341712006-06-18 13:27:19 -03001165
1166/* MPEG audio */
1167#define V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ (V4L2_CID_MPEG_BASE+100)
1168enum v4l2_mpeg_audio_sampling_freq {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001169 V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100 = 0,
1170 V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000 = 1,
1171 V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001172};
1173#define V4L2_CID_MPEG_AUDIO_ENCODING (V4L2_CID_MPEG_BASE+101)
1174enum v4l2_mpeg_audio_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001175 V4L2_MPEG_AUDIO_ENCODING_LAYER_1 = 0,
1176 V4L2_MPEG_AUDIO_ENCODING_LAYER_2 = 1,
1177 V4L2_MPEG_AUDIO_ENCODING_LAYER_3 = 2,
Janne Grunau188919a2008-08-08 07:21:00 -03001178 V4L2_MPEG_AUDIO_ENCODING_AAC = 3,
Hans Verkuile6b5da82008-08-08 07:38:07 -03001179 V4L2_MPEG_AUDIO_ENCODING_AC3 = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001180};
1181#define V4L2_CID_MPEG_AUDIO_L1_BITRATE (V4L2_CID_MPEG_BASE+102)
1182enum v4l2_mpeg_audio_l1_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001183 V4L2_MPEG_AUDIO_L1_BITRATE_32K = 0,
1184 V4L2_MPEG_AUDIO_L1_BITRATE_64K = 1,
1185 V4L2_MPEG_AUDIO_L1_BITRATE_96K = 2,
1186 V4L2_MPEG_AUDIO_L1_BITRATE_128K = 3,
1187 V4L2_MPEG_AUDIO_L1_BITRATE_160K = 4,
1188 V4L2_MPEG_AUDIO_L1_BITRATE_192K = 5,
1189 V4L2_MPEG_AUDIO_L1_BITRATE_224K = 6,
1190 V4L2_MPEG_AUDIO_L1_BITRATE_256K = 7,
1191 V4L2_MPEG_AUDIO_L1_BITRATE_288K = 8,
1192 V4L2_MPEG_AUDIO_L1_BITRATE_320K = 9,
1193 V4L2_MPEG_AUDIO_L1_BITRATE_352K = 10,
1194 V4L2_MPEG_AUDIO_L1_BITRATE_384K = 11,
1195 V4L2_MPEG_AUDIO_L1_BITRATE_416K = 12,
1196 V4L2_MPEG_AUDIO_L1_BITRATE_448K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001197};
1198#define V4L2_CID_MPEG_AUDIO_L2_BITRATE (V4L2_CID_MPEG_BASE+103)
1199enum v4l2_mpeg_audio_l2_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001200 V4L2_MPEG_AUDIO_L2_BITRATE_32K = 0,
1201 V4L2_MPEG_AUDIO_L2_BITRATE_48K = 1,
1202 V4L2_MPEG_AUDIO_L2_BITRATE_56K = 2,
1203 V4L2_MPEG_AUDIO_L2_BITRATE_64K = 3,
1204 V4L2_MPEG_AUDIO_L2_BITRATE_80K = 4,
1205 V4L2_MPEG_AUDIO_L2_BITRATE_96K = 5,
1206 V4L2_MPEG_AUDIO_L2_BITRATE_112K = 6,
1207 V4L2_MPEG_AUDIO_L2_BITRATE_128K = 7,
1208 V4L2_MPEG_AUDIO_L2_BITRATE_160K = 8,
1209 V4L2_MPEG_AUDIO_L2_BITRATE_192K = 9,
1210 V4L2_MPEG_AUDIO_L2_BITRATE_224K = 10,
1211 V4L2_MPEG_AUDIO_L2_BITRATE_256K = 11,
1212 V4L2_MPEG_AUDIO_L2_BITRATE_320K = 12,
1213 V4L2_MPEG_AUDIO_L2_BITRATE_384K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001214};
1215#define V4L2_CID_MPEG_AUDIO_L3_BITRATE (V4L2_CID_MPEG_BASE+104)
1216enum v4l2_mpeg_audio_l3_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001217 V4L2_MPEG_AUDIO_L3_BITRATE_32K = 0,
1218 V4L2_MPEG_AUDIO_L3_BITRATE_40K = 1,
1219 V4L2_MPEG_AUDIO_L3_BITRATE_48K = 2,
1220 V4L2_MPEG_AUDIO_L3_BITRATE_56K = 3,
1221 V4L2_MPEG_AUDIO_L3_BITRATE_64K = 4,
1222 V4L2_MPEG_AUDIO_L3_BITRATE_80K = 5,
1223 V4L2_MPEG_AUDIO_L3_BITRATE_96K = 6,
1224 V4L2_MPEG_AUDIO_L3_BITRATE_112K = 7,
1225 V4L2_MPEG_AUDIO_L3_BITRATE_128K = 8,
1226 V4L2_MPEG_AUDIO_L3_BITRATE_160K = 9,
1227 V4L2_MPEG_AUDIO_L3_BITRATE_192K = 10,
1228 V4L2_MPEG_AUDIO_L3_BITRATE_224K = 11,
1229 V4L2_MPEG_AUDIO_L3_BITRATE_256K = 12,
1230 V4L2_MPEG_AUDIO_L3_BITRATE_320K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001231};
1232#define V4L2_CID_MPEG_AUDIO_MODE (V4L2_CID_MPEG_BASE+105)
1233enum v4l2_mpeg_audio_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001234 V4L2_MPEG_AUDIO_MODE_STEREO = 0,
1235 V4L2_MPEG_AUDIO_MODE_JOINT_STEREO = 1,
1236 V4L2_MPEG_AUDIO_MODE_DUAL = 2,
1237 V4L2_MPEG_AUDIO_MODE_MONO = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001238};
1239#define V4L2_CID_MPEG_AUDIO_MODE_EXTENSION (V4L2_CID_MPEG_BASE+106)
1240enum v4l2_mpeg_audio_mode_extension {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001241 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4 = 0,
1242 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8 = 1,
1243 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12 = 2,
1244 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001245};
1246#define V4L2_CID_MPEG_AUDIO_EMPHASIS (V4L2_CID_MPEG_BASE+107)
1247enum v4l2_mpeg_audio_emphasis {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001248 V4L2_MPEG_AUDIO_EMPHASIS_NONE = 0,
1249 V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS = 1,
1250 V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001251};
1252#define V4L2_CID_MPEG_AUDIO_CRC (V4L2_CID_MPEG_BASE+108)
1253enum v4l2_mpeg_audio_crc {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001254 V4L2_MPEG_AUDIO_CRC_NONE = 0,
1255 V4L2_MPEG_AUDIO_CRC_CRC16 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001256};
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001257#define V4L2_CID_MPEG_AUDIO_MUTE (V4L2_CID_MPEG_BASE+109)
Hans Verkuilf723af12008-08-09 10:35:29 -03001258#define V4L2_CID_MPEG_AUDIO_AAC_BITRATE (V4L2_CID_MPEG_BASE+110)
1259#define V4L2_CID_MPEG_AUDIO_AC3_BITRATE (V4L2_CID_MPEG_BASE+111)
Hans Verkuile6b5da82008-08-08 07:38:07 -03001260enum v4l2_mpeg_audio_ac3_bitrate {
1261 V4L2_MPEG_AUDIO_AC3_BITRATE_32K = 0,
1262 V4L2_MPEG_AUDIO_AC3_BITRATE_40K = 1,
1263 V4L2_MPEG_AUDIO_AC3_BITRATE_48K = 2,
1264 V4L2_MPEG_AUDIO_AC3_BITRATE_56K = 3,
1265 V4L2_MPEG_AUDIO_AC3_BITRATE_64K = 4,
1266 V4L2_MPEG_AUDIO_AC3_BITRATE_80K = 5,
1267 V4L2_MPEG_AUDIO_AC3_BITRATE_96K = 6,
1268 V4L2_MPEG_AUDIO_AC3_BITRATE_112K = 7,
1269 V4L2_MPEG_AUDIO_AC3_BITRATE_128K = 8,
1270 V4L2_MPEG_AUDIO_AC3_BITRATE_160K = 9,
1271 V4L2_MPEG_AUDIO_AC3_BITRATE_192K = 10,
1272 V4L2_MPEG_AUDIO_AC3_BITRATE_224K = 11,
1273 V4L2_MPEG_AUDIO_AC3_BITRATE_256K = 12,
1274 V4L2_MPEG_AUDIO_AC3_BITRATE_320K = 13,
1275 V4L2_MPEG_AUDIO_AC3_BITRATE_384K = 14,
1276 V4L2_MPEG_AUDIO_AC3_BITRATE_448K = 15,
1277 V4L2_MPEG_AUDIO_AC3_BITRATE_512K = 16,
1278 V4L2_MPEG_AUDIO_AC3_BITRATE_576K = 17,
1279 V4L2_MPEG_AUDIO_AC3_BITRATE_640K = 18,
1280};
Hans Verkuil4f341712006-06-18 13:27:19 -03001281
1282/* MPEG video */
1283#define V4L2_CID_MPEG_VIDEO_ENCODING (V4L2_CID_MPEG_BASE+200)
1284enum v4l2_mpeg_video_encoding {
Janne Grunau188919a2008-08-08 07:21:00 -03001285 V4L2_MPEG_VIDEO_ENCODING_MPEG_1 = 0,
1286 V4L2_MPEG_VIDEO_ENCODING_MPEG_2 = 1,
1287 V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001288};
1289#define V4L2_CID_MPEG_VIDEO_ASPECT (V4L2_CID_MPEG_BASE+201)
1290enum v4l2_mpeg_video_aspect {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001291 V4L2_MPEG_VIDEO_ASPECT_1x1 = 0,
1292 V4L2_MPEG_VIDEO_ASPECT_4x3 = 1,
1293 V4L2_MPEG_VIDEO_ASPECT_16x9 = 2,
1294 V4L2_MPEG_VIDEO_ASPECT_221x100 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001295};
1296#define V4L2_CID_MPEG_VIDEO_B_FRAMES (V4L2_CID_MPEG_BASE+202)
1297#define V4L2_CID_MPEG_VIDEO_GOP_SIZE (V4L2_CID_MPEG_BASE+203)
1298#define V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (V4L2_CID_MPEG_BASE+204)
1299#define V4L2_CID_MPEG_VIDEO_PULLDOWN (V4L2_CID_MPEG_BASE+205)
1300#define V4L2_CID_MPEG_VIDEO_BITRATE_MODE (V4L2_CID_MPEG_BASE+206)
1301enum v4l2_mpeg_video_bitrate_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001302 V4L2_MPEG_VIDEO_BITRATE_MODE_VBR = 0,
1303 V4L2_MPEG_VIDEO_BITRATE_MODE_CBR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001304};
1305#define V4L2_CID_MPEG_VIDEO_BITRATE (V4L2_CID_MPEG_BASE+207)
1306#define V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (V4L2_CID_MPEG_BASE+208)
1307#define V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (V4L2_CID_MPEG_BASE+209)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001308#define V4L2_CID_MPEG_VIDEO_MUTE (V4L2_CID_MPEG_BASE+210)
1309#define V4L2_CID_MPEG_VIDEO_MUTE_YUV (V4L2_CID_MPEG_BASE+211)
Hans Verkuil4f341712006-06-18 13:27:19 -03001310
Hans Verkuil4b00eb22008-12-19 11:17:56 -03001311/* MPEG-class control IDs specific to the CX2341x driver as defined by V4L2 */
Hans Verkuil4f341712006-06-18 13:27:19 -03001312#define V4L2_CID_MPEG_CX2341X_BASE (V4L2_CTRL_CLASS_MPEG | 0x1000)
1313#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+0)
1314enum v4l2_mpeg_cx2341x_video_spatial_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001315 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL = 0,
1316 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001317};
1318#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+1)
1319#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+2)
1320enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001321 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF = 0,
1322 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
1323 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT = 2,
1324 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE = 3,
1325 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001326};
1327#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+3)
1328enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001329 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF = 0,
1330 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001331};
1332#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+4)
1333enum v4l2_mpeg_cx2341x_video_temporal_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001334 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL = 0,
1335 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001336};
1337#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+5)
1338#define V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+6)
1339enum v4l2_mpeg_cx2341x_video_median_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001340 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF = 0,
1341 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR = 1,
1342 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT = 2,
1343 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT = 3,
1344 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001345};
1346#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+7)
1347#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+8)
1348#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+9)
1349#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+10)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001350#define V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (V4L2_CID_MPEG_CX2341X_BASE+11)
Hans Verkuil4f341712006-06-18 13:27:19 -03001351
Brandon Philipsf9bd5842008-04-22 14:42:02 -03001352/* Camera class control IDs */
1353#define V4L2_CID_CAMERA_CLASS_BASE (V4L2_CTRL_CLASS_CAMERA | 0x900)
1354#define V4L2_CID_CAMERA_CLASS (V4L2_CTRL_CLASS_CAMERA | 1)
1355
1356#define V4L2_CID_EXPOSURE_AUTO (V4L2_CID_CAMERA_CLASS_BASE+1)
1357enum v4l2_exposure_auto_type {
1358 V4L2_EXPOSURE_AUTO = 0,
1359 V4L2_EXPOSURE_MANUAL = 1,
1360 V4L2_EXPOSURE_SHUTTER_PRIORITY = 2,
1361 V4L2_EXPOSURE_APERTURE_PRIORITY = 3
1362};
1363#define V4L2_CID_EXPOSURE_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+2)
1364#define V4L2_CID_EXPOSURE_AUTO_PRIORITY (V4L2_CID_CAMERA_CLASS_BASE+3)
1365
1366#define V4L2_CID_PAN_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+4)
1367#define V4L2_CID_TILT_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+5)
1368#define V4L2_CID_PAN_RESET (V4L2_CID_CAMERA_CLASS_BASE+6)
1369#define V4L2_CID_TILT_RESET (V4L2_CID_CAMERA_CLASS_BASE+7)
1370
1371#define V4L2_CID_PAN_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+8)
1372#define V4L2_CID_TILT_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+9)
1373
1374#define V4L2_CID_FOCUS_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+10)
1375#define V4L2_CID_FOCUS_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+11)
1376#define V4L2_CID_FOCUS_AUTO (V4L2_CID_CAMERA_CLASS_BASE+12)
1377
Laurent Pinchart08772582008-12-14 16:21:16 -03001378#define V4L2_CID_ZOOM_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+13)
1379#define V4L2_CID_ZOOM_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+14)
1380#define V4L2_CID_ZOOM_CONTINUOUS (V4L2_CID_CAMERA_CLASS_BASE+15)
1381
Laurent Pinchart046425f2008-12-14 16:22:05 -03001382#define V4L2_CID_PRIVACY (V4L2_CID_CAMERA_CLASS_BASE+16)
1383
Laurent Pinchart48213fe2010-01-20 12:12:57 -03001384#define V4L2_CID_IRIS_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+17)
1385#define V4L2_CID_IRIS_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+18)
1386
Eduardo Valentin6b424942009-08-08 08:38:58 -03001387/* FM Modulator class control IDs */
1388#define V4L2_CID_FM_TX_CLASS_BASE (V4L2_CTRL_CLASS_FM_TX | 0x900)
1389#define V4L2_CID_FM_TX_CLASS (V4L2_CTRL_CLASS_FM_TX | 1)
1390
1391#define V4L2_CID_RDS_TX_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 1)
1392#define V4L2_CID_RDS_TX_PI (V4L2_CID_FM_TX_CLASS_BASE + 2)
1393#define V4L2_CID_RDS_TX_PTY (V4L2_CID_FM_TX_CLASS_BASE + 3)
1394#define V4L2_CID_RDS_TX_PS_NAME (V4L2_CID_FM_TX_CLASS_BASE + 5)
1395#define V4L2_CID_RDS_TX_RADIO_TEXT (V4L2_CID_FM_TX_CLASS_BASE + 6)
1396
1397#define V4L2_CID_AUDIO_LIMITER_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 64)
1398#define V4L2_CID_AUDIO_LIMITER_RELEASE_TIME (V4L2_CID_FM_TX_CLASS_BASE + 65)
1399#define V4L2_CID_AUDIO_LIMITER_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 66)
1400
1401#define V4L2_CID_AUDIO_COMPRESSION_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 80)
1402#define V4L2_CID_AUDIO_COMPRESSION_GAIN (V4L2_CID_FM_TX_CLASS_BASE + 81)
1403#define V4L2_CID_AUDIO_COMPRESSION_THRESHOLD (V4L2_CID_FM_TX_CLASS_BASE + 82)
1404#define V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME (V4L2_CID_FM_TX_CLASS_BASE + 83)
1405#define V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME (V4L2_CID_FM_TX_CLASS_BASE + 84)
1406
1407#define V4L2_CID_PILOT_TONE_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 96)
1408#define V4L2_CID_PILOT_TONE_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 97)
1409#define V4L2_CID_PILOT_TONE_FREQUENCY (V4L2_CID_FM_TX_CLASS_BASE + 98)
1410
1411#define V4L2_CID_TUNE_PREEMPHASIS (V4L2_CID_FM_TX_CLASS_BASE + 112)
1412enum v4l2_preemphasis {
1413 V4L2_PREEMPHASIS_DISABLED = 0,
1414 V4L2_PREEMPHASIS_50_uS = 1,
1415 V4L2_PREEMPHASIS_75_uS = 2,
1416};
1417#define V4L2_CID_TUNE_POWER_LEVEL (V4L2_CID_FM_TX_CLASS_BASE + 113)
1418#define V4L2_CID_TUNE_ANTENNA_CAPACITOR (V4L2_CID_FM_TX_CLASS_BASE + 114)
1419
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420/*
1421 * T U N I N G
1422 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001423struct v4l2_tuner {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 __u32 index;
1425 __u8 name[32];
1426 enum v4l2_tuner_type type;
1427 __u32 capability;
1428 __u32 rangelow;
1429 __u32 rangehigh;
1430 __u32 rxsubchans;
1431 __u32 audmode;
1432 __s32 signal;
1433 __s32 afc;
1434 __u32 reserved[4];
1435};
1436
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001437struct v4l2_modulator {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 __u32 index;
1439 __u8 name[32];
1440 __u32 capability;
1441 __u32 rangelow;
1442 __u32 rangehigh;
1443 __u32 txsubchans;
1444 __u32 reserved[4];
1445};
1446
1447/* Flags for the 'capability' field */
1448#define V4L2_TUNER_CAP_LOW 0x0001
1449#define V4L2_TUNER_CAP_NORM 0x0002
1450#define V4L2_TUNER_CAP_STEREO 0x0010
1451#define V4L2_TUNER_CAP_LANG2 0x0020
1452#define V4L2_TUNER_CAP_SAP 0x0020
1453#define V4L2_TUNER_CAP_LANG1 0x0040
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001454#define V4L2_TUNER_CAP_RDS 0x0080
Matti Aaltonen44a81552010-10-07 10:16:11 -03001455#define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1456#define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
1458/* Flags for the 'rxsubchans' field */
1459#define V4L2_TUNER_SUB_MONO 0x0001
1460#define V4L2_TUNER_SUB_STEREO 0x0002
1461#define V4L2_TUNER_SUB_LANG2 0x0004
1462#define V4L2_TUNER_SUB_SAP 0x0004
1463#define V4L2_TUNER_SUB_LANG1 0x0008
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001464#define V4L2_TUNER_SUB_RDS 0x0010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
1466/* Values for the 'audmode' field */
1467#define V4L2_TUNER_MODE_MONO 0x0000
1468#define V4L2_TUNER_MODE_STEREO 0x0001
1469#define V4L2_TUNER_MODE_LANG2 0x0002
1470#define V4L2_TUNER_MODE_SAP 0x0002
1471#define V4L2_TUNER_MODE_LANG1 0x0003
Hans Verkuil301e22d2006-03-18 17:15:00 -03001472#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001474struct v4l2_frequency {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001475 __u32 tuner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 enum v4l2_tuner_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001477 __u32 frequency;
1478 __u32 reserved[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479};
1480
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -03001481struct v4l2_hw_freq_seek {
1482 __u32 tuner;
1483 enum v4l2_tuner_type type;
1484 __u32 seek_upward;
1485 __u32 wrap_around;
Matti Aaltonen44a81552010-10-07 10:16:11 -03001486 __u32 spacing;
1487 __u32 reserved[7];
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -03001488};
1489
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490/*
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001491 * R D S
1492 */
1493
1494struct v4l2_rds_data {
1495 __u8 lsb;
1496 __u8 msb;
1497 __u8 block;
1498} __attribute__ ((packed));
1499
1500#define V4L2_RDS_BLOCK_MSK 0x7
1501#define V4L2_RDS_BLOCK_A 0
1502#define V4L2_RDS_BLOCK_B 1
1503#define V4L2_RDS_BLOCK_C 2
1504#define V4L2_RDS_BLOCK_D 3
1505#define V4L2_RDS_BLOCK_C_ALT 4
1506#define V4L2_RDS_BLOCK_INVALID 7
1507
1508#define V4L2_RDS_BLOCK_CORRECTED 0x40
1509#define V4L2_RDS_BLOCK_ERROR 0x80
1510
1511/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 * A U D I O
1513 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001514struct v4l2_audio {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 __u32 index;
1516 __u8 name[32];
1517 __u32 capability;
1518 __u32 mode;
1519 __u32 reserved[2];
1520};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -03001521
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522/* Flags for the 'capability' field */
1523#define V4L2_AUDCAP_STEREO 0x00001
1524#define V4L2_AUDCAP_AVL 0x00002
1525
1526/* Flags for the 'mode' field */
1527#define V4L2_AUDMODE_AVL 0x00001
1528
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001529struct v4l2_audioout {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 __u32 index;
1531 __u8 name[32];
1532 __u32 capability;
1533 __u32 mode;
1534 __u32 reserved[2];
1535};
1536
1537/*
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001538 * M P E G S E R V I C E S
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001539 *
1540 * NOTE: EXPERIMENTAL API
1541 */
1542#if 1
1543#define V4L2_ENC_IDX_FRAME_I (0)
1544#define V4L2_ENC_IDX_FRAME_P (1)
1545#define V4L2_ENC_IDX_FRAME_B (2)
1546#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1547
1548struct v4l2_enc_idx_entry {
1549 __u64 offset;
1550 __u64 pts;
1551 __u32 length;
1552 __u32 flags;
1553 __u32 reserved[2];
1554};
1555
1556#define V4L2_ENC_IDX_ENTRIES (64)
1557struct v4l2_enc_idx {
1558 __u32 entries;
1559 __u32 entries_cap;
1560 __u32 reserved[4];
1561 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1562};
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001563
1564
1565#define V4L2_ENC_CMD_START (0)
1566#define V4L2_ENC_CMD_STOP (1)
1567#define V4L2_ENC_CMD_PAUSE (2)
1568#define V4L2_ENC_CMD_RESUME (3)
1569
1570/* Flags for V4L2_ENC_CMD_STOP */
1571#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1572
1573struct v4l2_encoder_cmd {
1574 __u32 cmd;
1575 __u32 flags;
1576 union {
1577 struct {
1578 __u32 data[8];
1579 } raw;
1580 };
1581};
1582
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001583#endif
1584
1585
1586/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 * D A T A S E R V I C E S ( V B I )
1588 *
1589 * Data services API by Michael Schimek
1590 */
1591
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001592/* Raw VBI */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001593struct v4l2_vbi_format {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 __u32 sampling_rate; /* in 1 Hz */
1595 __u32 offset;
1596 __u32 samples_per_line;
1597 __u32 sample_format; /* V4L2_PIX_FMT_* */
1598 __s32 start[2];
1599 __u32 count[2];
1600 __u32 flags; /* V4L2_VBI_* */
1601 __u32 reserved[2]; /* must be zero */
1602};
1603
1604/* VBI flags */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001605#define V4L2_VBI_UNSYNC (1 << 0)
1606#define V4L2_VBI_INTERLACED (1 << 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001608/* Sliced VBI
1609 *
1610 * This implements is a proposal V4L2 API to allow SLICED VBI
1611 * required for some hardware encoders. It should change without
1612 * notice in the definitive implementation.
1613 */
1614
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001615struct v4l2_sliced_vbi_format {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001616 __u16 service_set;
1617 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1618 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001619 (equals frame lines 313-336 for 625 line video
1620 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001621 __u16 service_lines[2][24];
1622 __u32 io_size;
1623 __u32 reserved[2]; /* must be zero */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001624};
1625
Mauro Carvalho Chehab4d0dddb2006-01-23 17:11:07 -02001626/* Teletext World System Teletext
1627 (WST), defined on ITU-R BT.653-2 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001628#define V4L2_SLICED_TELETEXT_B (0x0001)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001629/* Video Program System, defined on ETS 300 231*/
Hans Verkuil9bc74002006-03-29 18:02:51 -03001630#define V4L2_SLICED_VPS (0x0400)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001631/* Closed Caption, defined on EIA-608 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001632#define V4L2_SLICED_CAPTION_525 (0x1000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001633/* Wide Screen System, defined on ITU-R BT1119.1 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001634#define V4L2_SLICED_WSS_625 (0x4000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001635
Hans Verkuil9bc74002006-03-29 18:02:51 -03001636#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1637#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001638
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001639struct v4l2_sliced_vbi_cap {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001640 __u16 service_set;
1641 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1642 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001643 (equals frame lines 313-336 for 625 line video
1644 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001645 __u16 service_lines[2][24];
Hans Verkuil1739ade2006-08-26 03:05:17 -03001646 enum v4l2_buf_type type;
1647 __u32 reserved[3]; /* must be 0 */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001648};
1649
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001650struct v4l2_sliced_vbi_data {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001651 __u32 id;
1652 __u32 field; /* 0: first field, 1: second field */
1653 __u32 line; /* 1-23 */
1654 __u32 reserved; /* must be 0 */
1655 __u8 data[48];
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001656};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
1658/*
Andy Walls6273fda2009-03-14 17:06:07 -03001659 * Sliced VBI data inserted into MPEG Streams
1660 */
1661
1662/*
1663 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1664 *
1665 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1666 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1667 * data
1668 *
1669 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1670 * definitions are not included here. See the MPEG-2 specifications for details
1671 * on these headers.
1672 */
1673
1674/* Line type IDs */
1675#define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
1676#define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
1677#define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
1678#define V4L2_MPEG_VBI_IVTV_VPS (7)
1679
1680struct v4l2_mpeg_vbi_itv0_line {
1681 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
1682 __u8 data[42]; /* Sliced VBI data for the line */
1683} __attribute__ ((packed));
1684
1685struct v4l2_mpeg_vbi_itv0 {
1686 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
1687 struct v4l2_mpeg_vbi_itv0_line line[35];
1688} __attribute__ ((packed));
1689
1690struct v4l2_mpeg_vbi_ITV0 {
1691 struct v4l2_mpeg_vbi_itv0_line line[36];
1692} __attribute__ ((packed));
1693
1694#define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
1695#define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
1696
1697struct v4l2_mpeg_vbi_fmt_ivtv {
1698 __u8 magic[4];
1699 union {
1700 struct v4l2_mpeg_vbi_itv0 itv0;
1701 struct v4l2_mpeg_vbi_ITV0 ITV0;
1702 };
1703} __attribute__ ((packed));
1704
1705/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 * A G G R E G A T E S T R U C T U R E S
1707 */
1708
Pawel Osciakf8f39142010-07-29 14:44:25 -03001709/**
1710 * struct v4l2_plane_pix_format - additional, per-plane format definition
1711 * @sizeimage: maximum size in bytes required for data, for which
1712 * this plane will be used
1713 * @bytesperline: distance in bytes between the leftmost pixels in two
1714 * adjacent lines
1715 */
1716struct v4l2_plane_pix_format {
1717 __u32 sizeimage;
1718 __u16 bytesperline;
1719 __u16 reserved[7];
1720} __attribute__ ((packed));
1721
1722/**
1723 * struct v4l2_pix_format_mplane - multiplanar format definition
1724 * @width: image width in pixels
1725 * @height: image height in pixels
1726 * @pixelformat: little endian four character code (fourcc)
1727 * @field: field order (for interlaced video)
1728 * @colorspace: supplemental to pixelformat
1729 * @plane_fmt: per-plane information
1730 * @num_planes: number of planes for this format
1731 */
1732struct v4l2_pix_format_mplane {
1733 __u32 width;
1734 __u32 height;
1735 __u32 pixelformat;
1736 enum v4l2_field field;
1737 enum v4l2_colorspace colorspace;
1738
1739 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
1740 __u8 num_planes;
1741 __u8 reserved[11];
1742} __attribute__ ((packed));
1743
1744/**
1745 * struct v4l2_format - stream data format
1746 * @type: type of the data stream
1747 * @pix: definition of an image format
1748 * @pix_mp: definition of a multiplanar image format
1749 * @win: definition of an overlaid image
1750 * @vbi: raw VBI capture or output parameters
1751 * @sliced: sliced VBI capture or output parameters
1752 * @raw_data: placeholder for future extensions and custom formats
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001754struct v4l2_format {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 enum v4l2_buf_type type;
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001756 union {
1757 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
Pawel Osciakf8f39142010-07-29 14:44:25 -03001758 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001759 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
1760 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
1761 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
1762 __u8 raw_data[200]; /* user-defined */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 } fmt;
1764};
1765
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766/* Stream type-dependent parameters
1767 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001768struct v4l2_streamparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 enum v4l2_buf_type type;
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001770 union {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 struct v4l2_captureparm capture;
1772 struct v4l2_outputparm output;
1773 __u8 raw_data[200]; /* user-defined */
1774 } parm;
1775};
1776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777/*
Sakari Ailusfda10212010-02-24 19:19:05 -03001778 * E V E N T S
1779 */
1780
Hans Verkuil1bcaf4b2010-03-27 14:09:52 -03001781#define V4L2_EVENT_ALL 0
1782#define V4L2_EVENT_VSYNC 1
1783#define V4L2_EVENT_EOS 2
1784#define V4L2_EVENT_PRIVATE_START 0x08000000
1785
1786/* Payload for V4L2_EVENT_VSYNC */
1787struct v4l2_event_vsync {
1788 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
1789 __u8 field;
1790} __attribute__ ((packed));
1791
Sakari Ailusfda10212010-02-24 19:19:05 -03001792struct v4l2_event {
1793 __u32 type;
1794 union {
Hans Verkuil1bcaf4b2010-03-27 14:09:52 -03001795 struct v4l2_event_vsync vsync;
Sakari Ailusfda10212010-02-24 19:19:05 -03001796 __u8 data[64];
1797 } u;
1798 __u32 pending;
1799 __u32 sequence;
1800 struct timespec timestamp;
1801 __u32 reserved[9];
1802};
1803
1804struct v4l2_event_subscription {
1805 __u32 type;
1806 __u32 reserved[7];
1807};
1808
Sakari Ailusfda10212010-02-24 19:19:05 -03001809/*
Trent Piepho52ebc762007-01-23 22:38:13 -03001810 * A D V A N C E D D E B U G G I N G
Hans Verkuilf3502b82007-02-23 21:16:01 -03001811 *
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001812 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
1813 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
Trent Piepho52ebc762007-01-23 22:38:13 -03001814 */
1815
1816/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001817
Hans Verkuilf3502b82007-02-23 21:16:01 -03001818#define V4L2_CHIP_MATCH_HOST 0 /* Match against chip ID on host (0 for the host) */
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001819#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
Hans Verkuilf3502b82007-02-23 21:16:01 -03001820#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Mauro Carvalho Chehab531c98e2008-12-22 13:18:27 -03001821#define V4L2_CHIP_MATCH_AC97 3 /* Match against anciliary AC97 chip */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001822
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001823struct v4l2_dbg_match {
1824 __u32 type; /* Match type */
1825 union { /* Match this chip, meaning determined by type */
1826 __u32 addr;
1827 char name[32];
1828 };
1829} __attribute__ ((packed));
1830
1831struct v4l2_dbg_register {
1832 struct v4l2_dbg_match match;
1833 __u32 size; /* register size in bytes */
Trent Piephoe7b58f52007-01-30 22:47:18 -03001834 __u64 reg;
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001835 __u64 val;
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001836} __attribute__ ((packed));
Trent Piepho52ebc762007-01-23 22:38:13 -03001837
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001838/* VIDIOC_DBG_G_CHIP_IDENT */
1839struct v4l2_dbg_chip_ident {
1840 struct v4l2_dbg_match match;
1841 __u32 ident; /* chip identifier as specified in <media/v4l2-chip-ident.h> */
1842 __u32 revision; /* chip revision, chip specific */
1843} __attribute__ ((packed));
1844
Trent Piepho52ebc762007-01-23 22:38:13 -03001845/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 * 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
1847 *
1848 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001849#define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
1850#define VIDIOC_RESERVED _IO('V', 1)
1851#define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
1852#define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
1853#define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
1854#define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
1855#define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
1856#define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
1857#define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
1858#define VIDIOC_OVERLAY _IOW('V', 14, int)
1859#define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
1860#define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
1861#define VIDIOC_STREAMON _IOW('V', 18, int)
1862#define VIDIOC_STREAMOFF _IOW('V', 19, int)
1863#define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
1864#define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
1865#define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
1866#define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
1867#define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
1868#define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
1869#define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
1870#define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
1871#define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
1872#define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
1873#define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
1874#define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
1875#define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
1876#define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
1877#define VIDIOC_G_INPUT _IOR('V', 38, int)
1878#define VIDIOC_S_INPUT _IOWR('V', 39, int)
1879#define VIDIOC_G_OUTPUT _IOR('V', 46, int)
1880#define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
1881#define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
1882#define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
1883#define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
1884#define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
1885#define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
1886#define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
1887#define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
1888#define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
1889#define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
1890#define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
1891#define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
1892#define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
1893#define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
1894#define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
1895#define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
1896#define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
1897#define VIDIOC_G_PRIORITY _IOR('V', 67, enum v4l2_priority)
1898#define VIDIOC_S_PRIORITY _IOW('V', 68, enum v4l2_priority)
1899#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
1900#define VIDIOC_LOG_STATUS _IO('V', 70)
1901#define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
1902#define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
1903#define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001904#if 1
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001905#define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
1906#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
1907#define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
1908#define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
1909#define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001910#endif
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001911
1912#if 1
1913/* Experimental, meant for debugging, testing and internal use.
1914 Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
1915 You must be root to use these ioctls. Never use these in applications! */
1916#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
1917#define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
1918
1919/* Experimental, meant for debugging, testing and internal use.
1920 Never use this ioctl in applications! */
1921#define VIDIOC_DBG_G_CHIP_IDENT _IOWR('V', 81, struct v4l2_dbg_chip_ident)
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001922#endif
1923
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001924#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001925#define VIDIOC_ENUM_DV_PRESETS _IOWR('V', 83, struct v4l2_dv_enum_preset)
1926#define VIDIOC_S_DV_PRESET _IOWR('V', 84, struct v4l2_dv_preset)
1927#define VIDIOC_G_DV_PRESET _IOWR('V', 85, struct v4l2_dv_preset)
1928#define VIDIOC_QUERY_DV_PRESET _IOR('V', 86, struct v4l2_dv_preset)
1929#define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
1930#define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
Sakari Ailusfda10212010-02-24 19:19:05 -03001931#define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
1932#define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
1933#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001934
Hans Verkuil92f45ba2008-12-21 10:35:25 -03001935/* Reminder: when adding new ioctls please add support for them to
1936 drivers/media/video/v4l2-compat-ioctl32.c as well! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001938#ifdef __OLD_VIDIOC_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939/* for compatibility, will go away some day */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001940#define VIDIOC_OVERLAY_OLD _IOWR('V', 14, int)
1941#define VIDIOC_S_PARM_OLD _IOW('V', 22, struct v4l2_streamparm)
1942#define VIDIOC_S_CTRL_OLD _IOW('V', 28, struct v4l2_control)
1943#define VIDIOC_G_AUDIO_OLD _IOWR('V', 33, struct v4l2_audio)
1944#define VIDIOC_G_AUDOUT_OLD _IOWR('V', 49, struct v4l2_audioout)
1945#define VIDIOC_CROPCAP_OLD _IOR('V', 58, struct v4l2_cropcap)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001946#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
1948#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1949
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950#endif /* __LINUX_VIDEODEV2_H */