blob: a417270b337f179180d1a1f5bbe7ac0537305296 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Michael Schimekb1e7df12007-02-07 09:15:01 -03002 * Video for Linux Two header file
3 *
4 * Copyright (C) 1999-2007 the contributors
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * Alternatively you can redistribute this file under the terms of the
17 * BSD license as stated below:
18 *
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
21 * are met:
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in
26 * the documentation and/or other materials provided with the
27 * distribution.
28 * 3. The names of its contributors may not be used to endorse or promote
29 * products derived from this software without specific prior written
30 * permission.
31 *
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
38 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
39 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
40 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
41 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
42 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 *
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030044 * Header file for v4l or V4L2 drivers and applications
45 * with public API.
46 * All kernel-specific stuff were moved to media/v4l2-dev.h, so
47 * no #if __KERNEL tests are allowed here
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 *
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030049 * See http://linuxtv.org for more info
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 *
Mauro Carvalho Chehab43db48d2007-01-09 11:20:59 -030051 * Author: Bill Dirks <bill@thedirks.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * Justin Schoeman
Michael Schimekb1e7df12007-02-07 09:15:01 -030053 * Hans Verkuil <hverkuil@xs4all.nl>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * et al.
55 */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030056#ifndef __LINUX_VIDEODEV2_H
57#define __LINUX_VIDEODEV2_H
David Woodhouse5e6b83e2008-08-16 11:55:04 +010058
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030059#ifdef __KERNEL__
Mauro Carvalho Chehab89a58c82006-06-17 07:57:03 -030060#include <linux/time.h> /* need struct timeval */
Mauro Carvalho Chehab89a58c82006-06-17 07:57:03 -030061#else
Hans Verkuil3d58ffe2007-07-18 18:41:08 -030062#include <sys/time.h>
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030063#endif
David Woodhouse5e6b83e2008-08-16 11:55:04 +010064#include <linux/compiler.h>
Jiri Slaby83db33a2008-02-13 20:04:49 -030065#include <linux/ioctl.h>
David Mosberger-Tangc003d462006-05-26 10:28:13 -030066#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080068/*
69 * Common stuff for both V4L1 and V4L2
70 * Moved from videodev.h
71 */
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080072#define VIDEO_MAX_FRAME 32
Pawel Osciakf8f39142010-07-29 14:44:25 -030073#define VIDEO_MAX_PLANES 8
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080074
Hans Verkuilc1d7f4f2008-07-26 08:33:47 -030075#ifndef __KERNEL__
76
77/* These defines are V4L1 specific and should not be used with the V4L2 API!
78 They will be removed from this header in the future. */
79
Michael Schimekc12097f2005-11-08 21:38:24 -080080#define VID_TYPE_CAPTURE 1 /* Can capture */
81#define VID_TYPE_TUNER 2 /* Can tune */
82#define VID_TYPE_TELETEXT 4 /* Does teletext */
83#define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
84#define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
85#define VID_TYPE_CLIPPING 32 /* Can clip */
86#define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
87#define VID_TYPE_SCALES 128 /* Scalable */
88#define VID_TYPE_MONOCHROME 256 /* Monochrome only */
89#define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
90#define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
91#define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
92#define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
93#define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
Hans Verkuilc1d7f4f2008-07-26 08:33:47 -030094#endif
Michael Schimekc12097f2005-11-08 21:38:24 -080095
Linus Torvalds1da177e2005-04-16 15:20:36 -070096/*
97 * M I S C E L L A N E O U S
98 */
99
100/* Four-character-code (FOURCC) */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300101#define v4l2_fourcc(a, b, c, d)\
102 ((__u32)(a) | ((__u32)(b) << 8) | ((__u32)(c) << 16) | ((__u32)(d) << 24))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104/*
105 * E N U M S
106 */
107enum v4l2_field {
Hans Verkuilb2787842007-04-27 12:31:02 -0300108 V4L2_FIELD_ANY = 0, /* driver can choose from none,
109 top, bottom, interlaced
110 depending on whatever it thinks
111 is approximate ... */
112 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
113 V4L2_FIELD_TOP = 2, /* top field only */
114 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
115 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
116 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
117 buffer, top-bottom order */
118 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
119 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
120 separate buffers */
121 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
122 first and the top field is
123 transmitted first */
124 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
125 first and the bottom field is
126 transmitted first */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127};
128#define V4L2_FIELD_HAS_TOP(field) \
129 ((field) == V4L2_FIELD_TOP ||\
130 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300131 (field) == V4L2_FIELD_INTERLACED_TB ||\
132 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 (field) == V4L2_FIELD_SEQ_TB ||\
134 (field) == V4L2_FIELD_SEQ_BT)
135#define V4L2_FIELD_HAS_BOTTOM(field) \
136 ((field) == V4L2_FIELD_BOTTOM ||\
137 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300138 (field) == V4L2_FIELD_INTERLACED_TB ||\
139 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 (field) == V4L2_FIELD_SEQ_TB ||\
141 (field) == V4L2_FIELD_SEQ_BT)
142#define V4L2_FIELD_HAS_BOTH(field) \
143 ((field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300144 (field) == V4L2_FIELD_INTERLACED_TB ||\
145 (field) == V4L2_FIELD_INTERLACED_BT ||\
146 (field) == V4L2_FIELD_SEQ_TB ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 (field) == V4L2_FIELD_SEQ_BT)
148
149enum v4l2_buf_type {
Hans Verkuilb2787842007-04-27 12:31:02 -0300150 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
151 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
152 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
153 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
154 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
155 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
156 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
157#if 1
158 /* Experimental */
159 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
160#endif
Pawel Osciakf8f39142010-07-29 14:44:25 -0300161 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
162 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
Hans Verkuilb2787842007-04-27 12:31:02 -0300163 V4L2_BUF_TYPE_PRIVATE = 0x80,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164};
165
Pawel Osciakf8f39142010-07-29 14:44:25 -0300166#define V4L2_TYPE_IS_MULTIPLANAR(type) \
167 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
168 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
169
170#define V4L2_TYPE_IS_OUTPUT(type) \
171 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
172 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
173 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
174 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
175 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
176 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT)
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178enum v4l2_tuner_type {
179 V4L2_TUNER_RADIO = 1,
180 V4L2_TUNER_ANALOG_TV = 2,
181 V4L2_TUNER_DIGITAL_TV = 3,
182};
183
184enum v4l2_memory {
185 V4L2_MEMORY_MMAP = 1,
186 V4L2_MEMORY_USERPTR = 2,
187 V4L2_MEMORY_OVERLAY = 3,
188};
189
190/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
191enum v4l2_colorspace {
192 /* ITU-R 601 -- broadcast NTSC/PAL */
193 V4L2_COLORSPACE_SMPTE170M = 1,
194
195 /* 1125-Line (US) HDTV */
196 V4L2_COLORSPACE_SMPTE240M = 2,
197
198 /* HD and modern captures. */
199 V4L2_COLORSPACE_REC709 = 3,
200
201 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
202 V4L2_COLORSPACE_BT878 = 4,
203
204 /* These should be useful. Assume 601 extents. */
205 V4L2_COLORSPACE_470_SYSTEM_M = 5,
206 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
207
208 /* I know there will be cameras that send this. So, this is
209 * unspecified chromaticities and full 0-255 on each of the
210 * Y'CbCr components
211 */
212 V4L2_COLORSPACE_JPEG = 7,
213
214 /* For RGB colourspaces, this is probably a good start. */
215 V4L2_COLORSPACE_SRGB = 8,
216};
217
218enum v4l2_priority {
219 V4L2_PRIORITY_UNSET = 0, /* not initialized */
220 V4L2_PRIORITY_BACKGROUND = 1,
221 V4L2_PRIORITY_INTERACTIVE = 2,
222 V4L2_PRIORITY_RECORD = 3,
223 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
224};
225
226struct v4l2_rect {
227 __s32 left;
228 __s32 top;
229 __s32 width;
230 __s32 height;
231};
232
233struct v4l2_fract {
234 __u32 numerator;
235 __u32 denominator;
236};
237
238/*
239 * D R I V E R C A P A B I L I T I E S
240 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300241struct v4l2_capability {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 __u8 driver[16]; /* i.e. "bttv" */
243 __u8 card[32]; /* i.e. "Hauppauge WinTV" */
244 __u8 bus_info[32]; /* "PCI:" + pci_name(pci_dev) */
245 __u32 version; /* should use KERNEL_VERSION() */
246 __u32 capabilities; /* Device capabilities */
247 __u32 reserved[4];
248};
249
250/* Values for 'capabilities' field */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800251#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
252#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
253#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
254#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
255#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700256#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
257#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800258#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
Hans Verkuil1f137602007-05-29 08:18:37 -0300259#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -0300260#define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
Hans Verkuil6ace40e2009-06-20 09:50:39 -0300261#define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Pawel Osciakf8f39142010-07-29 14:44:25 -0300263/* Is a video capture device that supports multiplanar formats */
264#define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
265/* Is a video output device that supports multiplanar formats */
266#define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
267
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800268#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
269#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
270#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
Hans Verkuil6ace40e2009-06-20 09:50:39 -0300271#define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700273#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
274#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
275#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277/*
278 * V I D E O I M A G E F O R M A T
279 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300280struct v4l2_pix_format {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800281 __u32 width;
282 __u32 height;
283 __u32 pixelformat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 enum v4l2_field field;
285 __u32 bytesperline; /* for padding, zero if unused */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800286 __u32 sizeimage;
287 enum v4l2_colorspace colorspace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 __u32 priv; /* private data, depends on pixelformat */
289};
290
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300291/* Pixel format FOURCC depth Description */
292
293/* RGB formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300294#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
295#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
296#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
297#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
298#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
299#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
Sylwester Nawrocki5fd8f732010-08-03 09:50:29 -0300300#define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300301#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
302#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
303#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
304#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300305
306/* Grey formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300307#define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
Hans Verkuilb3e212d2010-03-22 04:52:21 -0300308#define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
309#define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
Guennadi Liakhovetskiee811522009-12-11 11:15:06 -0300310#define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
Michael Jonesd924de02011-03-29 05:19:06 -0300311#define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300312#define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300313
Antonio Ospite8bb36c22011-04-07 12:45:51 -0300314/* Grey bit-packed formats */
315#define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
316
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300317/* Palette formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300318#define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300319
320/* Luminance+Chrominance formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300321#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
322#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
323#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300324#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
325#define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300326#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
Robert Jarzmik69acdf12008-11-04 21:59:37 -0300327#define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300328#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
329#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 16 YVU411 planar */
330#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
331#define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
332#define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
333#define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
334#define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300335#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
336#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
337#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
338#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340/* two planes -- one Y, one Cr + Cb interleaved */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300341#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
342#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
Magnus Damm91962fa2008-12-18 11:45:00 -0300343#define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
344#define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
Sylwester Nawrocki4a3c9b42010-12-28 12:32:39 -0300346/* two non contiguous planes - one Y, one Cr + Cb interleaved */
347#define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
348#define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
349
350/* three non contiguous planes - Y, Cb, Cr */
351#define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
352
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300353/* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300354#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
355#define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
Mauro Carvalho Chehab509dd022009-06-30 16:07:26 -0300356#define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
Guennadi Liakhovetskiee811522009-12-11 11:15:06 -0300357#define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
358#define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
359#define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
360#define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
361#define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
Laurent Pinchart39187e12010-12-23 11:14:50 -0300362#define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
363#define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
364#define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
365#define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300366 /* 10bit raw bayer DPCM compressed to 8 bits */
Sergio Aguirre733d7102008-10-18 12:26:47 -0300367#define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300368 /*
369 * 10bit raw bayer, expanded to 16 bits
370 * xxxxrrrrrrrrrrxxxxgggggggggg xxxxggggggggggxxxxbbbbbbbbbb...
371 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300372#define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
374/* compressed formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300375#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
376#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
377#define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
378#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380/* Vendor-specific formats */
Hans de Goede54e8bc52010-01-14 09:37:18 -0300381#define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300382#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
383#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
Brian Johnson26e744b2009-07-19 05:52:58 -0300384#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 -0300385#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
386#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
387#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
388#define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
Mauro Carvalho Chehab9fa0f6d2008-07-27 08:55:17 -0300389#define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
390#define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300391#define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
392#define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
Kyle Guinn553d0d82009-01-16 05:28:38 -0300393#define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
Theodore Kilgore5bdd00b2009-12-25 05:16:32 -0300394#define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
Theodore Kilgore14a19c02009-03-25 07:13:13 -0300395#define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
Jean-Francois Moinef75c4952008-09-03 16:47:35 -0300396#define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
Hans de Goede1876bb92009-06-14 06:45:50 -0300397#define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
Hans de Goede49809d62009-06-07 12:10:39 -0300398#define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
Hans de Goede21f1b932009-10-23 06:50:12 -0300399#define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
Mauro Carvalho Chehab9701dc92009-09-14 09:42:41 -0300400#define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
Hans de Goede1f33de02010-09-05 16:05:22 -0300401#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 -0300402#define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
Jean-François Moinece5b2ac2011-03-14 08:49:28 -0300403#define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405/*
406 * F O R M A T E N U M E R A T I O N
407 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300408struct v4l2_fmtdesc {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800409 __u32 index; /* Format number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 enum v4l2_buf_type type; /* buffer type */
411 __u32 flags;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800412 __u8 description[32]; /* Description string */
413 __u32 pixelformat; /* Format fourcc */
414 __u32 reserved[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415};
416
417#define V4L2_FMT_FLAG_COMPRESSED 0x0001
Hans de Goede1e3c1f72009-08-31 11:32:46 -0300418#define V4L2_FMT_FLAG_EMULATED 0x0002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300420#if 1
421 /* Experimental Frame Size and frame rate enumeration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/*
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300423 * F R A M E S I Z E E N U M E R A T I O N
424 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300425enum v4l2_frmsizetypes {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300426 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
427 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
428 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
429};
430
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300431struct v4l2_frmsize_discrete {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300432 __u32 width; /* Frame width [pixel] */
433 __u32 height; /* Frame height [pixel] */
434};
435
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300436struct v4l2_frmsize_stepwise {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300437 __u32 min_width; /* Minimum frame width [pixel] */
438 __u32 max_width; /* Maximum frame width [pixel] */
439 __u32 step_width; /* Frame width step size [pixel] */
440 __u32 min_height; /* Minimum frame height [pixel] */
441 __u32 max_height; /* Maximum frame height [pixel] */
442 __u32 step_height; /* Frame height step size [pixel] */
443};
444
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300445struct v4l2_frmsizeenum {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300446 __u32 index; /* Frame size number */
447 __u32 pixel_format; /* Pixel format */
448 __u32 type; /* Frame size type the device supports. */
449
450 union { /* Frame size */
451 struct v4l2_frmsize_discrete discrete;
452 struct v4l2_frmsize_stepwise stepwise;
453 };
454
455 __u32 reserved[2]; /* Reserved space for future use */
456};
457
458/*
459 * F R A M E R A T E E N U M E R A T I O N
460 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300461enum v4l2_frmivaltypes {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300462 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
463 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
464 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
465};
466
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300467struct v4l2_frmival_stepwise {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300468 struct v4l2_fract min; /* Minimum frame interval [s] */
469 struct v4l2_fract max; /* Maximum frame interval [s] */
470 struct v4l2_fract step; /* Frame interval step size [s] */
471};
472
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300473struct v4l2_frmivalenum {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300474 __u32 index; /* Frame format index */
475 __u32 pixel_format; /* Pixel format */
476 __u32 width; /* Frame width */
477 __u32 height; /* Frame height */
478 __u32 type; /* Frame interval type the device supports. */
479
480 union { /* Frame interval */
481 struct v4l2_fract discrete;
482 struct v4l2_frmival_stepwise stepwise;
483 };
484
485 __u32 reserved[2]; /* Reserved space for future use */
486};
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300487#endif
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300488
489/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 * T I M E C O D E
491 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300492struct v4l2_timecode {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 __u32 type;
494 __u32 flags;
495 __u8 frames;
496 __u8 seconds;
497 __u8 minutes;
498 __u8 hours;
499 __u8 userbits[4];
500};
501
502/* Type */
503#define V4L2_TC_TYPE_24FPS 1
504#define V4L2_TC_TYPE_25FPS 2
505#define V4L2_TC_TYPE_30FPS 3
506#define V4L2_TC_TYPE_50FPS 4
507#define V4L2_TC_TYPE_60FPS 5
508
509/* Flags */
510#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
511#define V4L2_TC_FLAG_COLORFRAME 0x0002
512#define V4L2_TC_USERBITS_field 0x000C
513#define V4L2_TC_USERBITS_USERDEFINED 0x0000
514#define V4L2_TC_USERBITS_8BITCHARS 0x0008
515/* The above is based on SMPTE timecodes */
516
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300517struct v4l2_jpegcompression {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 int quality;
519
520 int APPn; /* Number of APP segment to be written,
521 * must be 0..15 */
522 int APP_len; /* Length of data in JPEG APPn segment */
523 char APP_data[60]; /* Data in the JPEG APPn segment. */
524
525 int COM_len; /* Length of data in JPEG COM segment */
526 char COM_data[60]; /* Data in JPEG COM segment */
527
528 __u32 jpeg_markers; /* Which markers should go into the JPEG
529 * output. Unless you exactly know what
530 * you do, leave them untouched.
531 * Inluding less markers will make the
532 * resulting code smaller, but there will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200533 * be fewer applications which can read it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 * The presence of the APP and COM marker
535 * is influenced by APP_len and COM_len
536 * ONLY, not by this property! */
537
538#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
539#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
540#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
541#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
542#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -0800543 * allways use APP0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544};
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546/*
547 * M E M O R Y - M A P P I N G B U F F E R S
548 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300549struct v4l2_requestbuffers {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800550 __u32 count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 enum v4l2_buf_type type;
552 enum v4l2_memory memory;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800553 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554};
555
Pawel Osciakf8f39142010-07-29 14:44:25 -0300556/**
557 * struct v4l2_plane - plane info for multi-planar buffers
558 * @bytesused: number of bytes occupied by data in the plane (payload)
559 * @length: size of this plane (NOT the payload) in bytes
560 * @mem_offset: when memory in the associated struct v4l2_buffer is
561 * V4L2_MEMORY_MMAP, equals the offset from the start of
562 * the device memory for this plane (or is a "cookie" that
563 * should be passed to mmap() called on the video node)
564 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
565 * pointing to this plane
566 * @data_offset: offset in the plane to the start of data; usually 0,
567 * unless there is a header in front of the data
568 *
569 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
570 * with two planes can have one plane for Y, and another for interleaved CbCr
571 * components. Each plane can reside in a separate memory buffer, or even in
572 * a completely separate memory node (e.g. in embedded devices).
573 */
574struct v4l2_plane {
575 __u32 bytesused;
576 __u32 length;
577 union {
578 __u32 mem_offset;
579 unsigned long userptr;
580 } m;
581 __u32 data_offset;
582 __u32 reserved[11];
583};
584
585/**
586 * struct v4l2_buffer - video buffer info
587 * @index: id number of the buffer
588 * @type: buffer type (type == *_MPLANE for multiplanar buffers)
589 * @bytesused: number of bytes occupied by data in the buffer (payload);
590 * unused (set to 0) for multiplanar buffers
591 * @flags: buffer informational flags
592 * @field: field order of the image in the buffer
593 * @timestamp: frame timestamp
594 * @timecode: frame timecode
595 * @sequence: sequence count of this frame
596 * @memory: the method, in which the actual video data is passed
597 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
598 * offset from the start of the device memory for this plane,
599 * (or a "cookie" that should be passed to mmap() as offset)
600 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
601 * a userspace pointer pointing to this buffer
602 * @planes: for multiplanar buffers; userspace pointer to the array of plane
603 * info structs for this buffer
604 * @length: size in bytes of the buffer (NOT its payload) for single-plane
605 * buffers (when type != *_MPLANE); number of elements in the
606 * planes array for multi-plane buffers
607 * @input: input number from which the video data has has been captured
608 *
609 * Contains data exchanged by application and driver using one of the Streaming
610 * I/O methods.
611 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300612struct v4l2_buffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 __u32 index;
614 enum v4l2_buf_type type;
615 __u32 bytesused;
616 __u32 flags;
617 enum v4l2_field field;
618 struct timeval timestamp;
619 struct v4l2_timecode timecode;
620 __u32 sequence;
621
622 /* memory location */
623 enum v4l2_memory memory;
624 union {
625 __u32 offset;
626 unsigned long userptr;
Pawel Osciakf8f39142010-07-29 14:44:25 -0300627 struct v4l2_plane *planes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 } m;
629 __u32 length;
630 __u32 input;
631 __u32 reserved;
632};
633
634/* Flags for 'flags' field */
635#define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
636#define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
637#define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
638#define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
639#define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
640#define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
Pawel Osciakbc0f7f12010-04-28 04:05:21 -0300641/* Buffer is ready, but the data contained within is corrupted. */
642#define V4L2_BUF_FLAG_ERROR 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643#define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
644#define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
645
646/*
647 * O V E R L A Y P R E V I E W
648 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300649struct v4l2_framebuffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 __u32 capability;
651 __u32 flags;
652/* FIXME: in theory we should pass something like PCI device + memory
653 * region + offset instead of some physical address */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300654 void *base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 struct v4l2_pix_format fmt;
656};
657/* Flags for the 'capability' field. Read only */
658#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
659#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
660#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
661#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
Hans Verkuilb2787842007-04-27 12:31:02 -0300662#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
663#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300664#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
Vaibhav Hiremathd8008562009-11-10 13:46:36 -0300665#define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666/* Flags for the 'flags' field. */
667#define V4L2_FBUF_FLAG_PRIMARY 0x0001
668#define V4L2_FBUF_FLAG_OVERLAY 0x0002
669#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
Hans Verkuilb2787842007-04-27 12:31:02 -0300670#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
671#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300672#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
Vaibhav Hiremathd8008562009-11-10 13:46:36 -0300673#define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300675struct v4l2_clip {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 struct v4l2_rect c;
Al Viro5b1a43d2006-02-01 05:24:20 -0500677 struct v4l2_clip __user *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678};
679
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300680struct v4l2_window {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 struct v4l2_rect w;
682 enum v4l2_field field;
683 __u32 chromakey;
684 struct v4l2_clip __user *clips;
685 __u32 clipcount;
686 void __user *bitmap;
Hans Verkuilb2787842007-04-27 12:31:02 -0300687 __u8 global_alpha;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688};
689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690/*
691 * C A P T U R E P A R A M E T E R S
692 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300693struct v4l2_captureparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 __u32 capability; /* Supported modes */
695 __u32 capturemode; /* Current mode */
696 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
697 __u32 extendedmode; /* Driver-specific extensions */
698 __u32 readbuffers; /* # of buffers for read */
699 __u32 reserved[4];
700};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702/* Flags for 'capability' and 'capturemode' fields */
703#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
704#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
705
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300706struct v4l2_outputparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 __u32 capability; /* Supported modes */
708 __u32 outputmode; /* Current mode */
709 struct v4l2_fract timeperframe; /* Time per frame in seconds */
710 __u32 extendedmode; /* Driver-specific extensions */
711 __u32 writebuffers; /* # of buffers for write */
712 __u32 reserved[4];
713};
714
715/*
716 * I N P U T I M A G E C R O P P I N G
717 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718struct v4l2_cropcap {
719 enum v4l2_buf_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800720 struct v4l2_rect bounds;
721 struct v4l2_rect defrect;
722 struct v4l2_fract pixelaspect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723};
724
725struct v4l2_crop {
726 enum v4l2_buf_type type;
727 struct v4l2_rect c;
728};
729
730/*
731 * A N A L O G V I D E O S T A N D A R D
732 */
733
734typedef __u64 v4l2_std_id;
735
736/* one bit for each */
737#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
738#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
739#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
740#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
741#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
742#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
743#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
744#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
745
746#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
747#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
748#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
749#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
750
751#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
752#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800753#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
Hans Verkuild97a11e2006-02-07 06:48:40 -0200754#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
757#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
758#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
759#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
760#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
761#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
762#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
Mauro Carvalho Chehab800d3c62005-11-13 16:07:48 -0800763#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
765/* ATSC/HDTV */
766#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
767#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
768
Mauro Carvalho Chehab412297d2007-01-07 08:51:05 -0300769/* FIXME:
770 Although std_id is 64 bits, there is an issue on PPC32 architecture that
771 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
772 this value to 32 bits.
773 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
774 it should work fine. However, if needed to add more than two standards,
775 v4l2-common.c should be fixed.
776 */
777
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200778/* some merged standards */
779#define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
780#define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
781#define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
782#define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
783
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784/* some common needed stuff */
785#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
786 V4L2_STD_PAL_B1 |\
787 V4L2_STD_PAL_G)
788#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
789 V4L2_STD_PAL_D1 |\
790 V4L2_STD_PAL_K)
791#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
792 V4L2_STD_PAL_DK |\
793 V4L2_STD_PAL_H |\
794 V4L2_STD_PAL_I)
795#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
Hans Verkuild97a11e2006-02-07 06:48:40 -0200796 V4L2_STD_NTSC_M_JP |\
797 V4L2_STD_NTSC_M_KR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
799 V4L2_STD_SECAM_K |\
800 V4L2_STD_SECAM_K1)
801#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
802 V4L2_STD_SECAM_G |\
803 V4L2_STD_SECAM_H |\
804 V4L2_STD_SECAM_DK |\
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200805 V4L2_STD_SECAM_L |\
806 V4L2_STD_SECAM_LC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
808#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
809 V4L2_STD_PAL_60 |\
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800810 V4L2_STD_NTSC |\
811 V4L2_STD_NTSC_443)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812#define V4L2_STD_625_50 (V4L2_STD_PAL |\
813 V4L2_STD_PAL_N |\
814 V4L2_STD_PAL_Nc |\
815 V4L2_STD_SECAM)
816#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800817 V4L2_STD_ATSC_16_VSB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
819#define V4L2_STD_UNKNOWN 0
820#define V4L2_STD_ALL (V4L2_STD_525_60 |\
821 V4L2_STD_625_50)
822
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300823struct v4l2_standard {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800824 __u32 index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 v4l2_std_id id;
826 __u8 name[24];
827 struct v4l2_fract frameperiod; /* Frames, not fields */
828 __u32 framelines;
829 __u32 reserved[4];
830};
831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832/*
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300833 * V I D E O T I M I N G S D V P R E S E T
834 */
835struct v4l2_dv_preset {
836 __u32 preset;
837 __u32 reserved[4];
838};
839
840/*
841 * D V P R E S E T S E N U M E R A T I O N
842 */
843struct v4l2_dv_enum_preset {
844 __u32 index;
845 __u32 preset;
846 __u8 name[32]; /* Name of the preset timing */
847 __u32 width;
848 __u32 height;
849 __u32 reserved[4];
850};
851
852/*
853 * D V P R E S E T V A L U E S
854 */
855#define V4L2_DV_INVALID 0
856#define V4L2_DV_480P59_94 1 /* BT.1362 */
857#define V4L2_DV_576P50 2 /* BT.1362 */
858#define V4L2_DV_720P24 3 /* SMPTE 296M */
859#define V4L2_DV_720P25 4 /* SMPTE 296M */
860#define V4L2_DV_720P30 5 /* SMPTE 296M */
861#define V4L2_DV_720P50 6 /* SMPTE 296M */
862#define V4L2_DV_720P59_94 7 /* SMPTE 274M */
863#define V4L2_DV_720P60 8 /* SMPTE 274M/296M */
864#define V4L2_DV_1080I29_97 9 /* BT.1120/ SMPTE 274M */
865#define V4L2_DV_1080I30 10 /* BT.1120/ SMPTE 274M */
866#define V4L2_DV_1080I25 11 /* BT.1120 */
867#define V4L2_DV_1080I50 12 /* SMPTE 296M */
868#define V4L2_DV_1080I60 13 /* SMPTE 296M */
869#define V4L2_DV_1080P24 14 /* SMPTE 296M */
870#define V4L2_DV_1080P25 15 /* SMPTE 296M */
871#define V4L2_DV_1080P30 16 /* SMPTE 296M */
872#define V4L2_DV_1080P50 17 /* BT.1120 */
873#define V4L2_DV_1080P60 18 /* BT.1120 */
874
875/*
876 * D V B T T I M I N G S
877 */
878
879/* BT.656/BT.1120 timing data */
880struct v4l2_bt_timings {
881 __u32 width; /* width in pixels */
882 __u32 height; /* height in lines */
883 __u32 interlaced; /* Interlaced or progressive */
884 __u32 polarities; /* Positive or negative polarity */
885 __u64 pixelclock; /* Pixel clock in HZ. Ex. 74.25MHz->74250000 */
886 __u32 hfrontporch; /* Horizpontal front porch in pixels */
887 __u32 hsync; /* Horizontal Sync length in pixels */
888 __u32 hbackporch; /* Horizontal back porch in pixels */
889 __u32 vfrontporch; /* Vertical front porch in pixels */
890 __u32 vsync; /* Vertical Sync length in lines */
891 __u32 vbackporch; /* Vertical back porch in lines */
892 __u32 il_vfrontporch; /* Vertical front porch for bottom field of
893 * interlaced field formats
894 */
895 __u32 il_vsync; /* Vertical sync length for bottom field of
896 * interlaced field formats
897 */
898 __u32 il_vbackporch; /* Vertical back porch for bottom field of
899 * interlaced field formats
900 */
901 __u32 reserved[16];
902} __attribute__ ((packed));
903
904/* Interlaced or progressive format */
905#define V4L2_DV_PROGRESSIVE 0
906#define V4L2_DV_INTERLACED 1
907
908/* Polarities. If bit is not set, it is assumed to be negative polarity */
909#define V4L2_DV_VSYNC_POS_POL 0x00000001
910#define V4L2_DV_HSYNC_POS_POL 0x00000002
911
912
913/* DV timings */
914struct v4l2_dv_timings {
915 __u32 type;
916 union {
917 struct v4l2_bt_timings bt;
918 __u32 reserved[32];
919 };
920} __attribute__ ((packed));
921
922/* Values for the type field */
923#define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
924
925/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 * V I D E O I N P U T S
927 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300928struct v4l2_input {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 __u32 index; /* Which input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800930 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 __u32 type; /* Type of input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800932 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 __u32 tuner; /* Associated tuner */
934 v4l2_std_id std;
935 __u32 status;
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300936 __u32 capabilities;
937 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940/* Values for the 'type' field */
941#define V4L2_INPUT_TYPE_TUNER 1
942#define V4L2_INPUT_TYPE_CAMERA 2
943
944/* field 'status' - general */
945#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
946#define V4L2_IN_ST_NO_SIGNAL 0x00000002
947#define V4L2_IN_ST_NO_COLOR 0x00000004
948
Adam Bakerdfa76fa2009-03-29 19:17:10 -0300949/* field 'status' - sensor orientation */
950/* If sensor is mounted upside down set both bits */
951#define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
952#define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
953
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954/* field 'status' - analog */
955#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
956#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
957
958/* field 'status' - digital */
959#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
960#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
961#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
962
963/* field 'status' - VCR and set-top box */
964#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
965#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
966#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
967
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300968/* capabilities flags */
969#define V4L2_IN_CAP_PRESETS 0x00000001 /* Supports S_DV_PRESET */
970#define V4L2_IN_CAP_CUSTOM_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
971#define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
972
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973/*
974 * V I D E O O U T P U T S
975 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300976struct v4l2_output {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 __u32 index; /* Which output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800978 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 __u32 type; /* Type of output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800980 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 __u32 modulator; /* Associated modulator */
982 v4l2_std_id std;
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300983 __u32 capabilities;
984 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985};
986/* Values for the 'type' field */
987#define V4L2_OUTPUT_TYPE_MODULATOR 1
988#define V4L2_OUTPUT_TYPE_ANALOG 2
989#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
990
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300991/* capabilities flags */
992#define V4L2_OUT_CAP_PRESETS 0x00000001 /* Supports S_DV_PRESET */
993#define V4L2_OUT_CAP_CUSTOM_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
994#define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
995
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996/*
997 * C O N T R O L S
998 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300999struct v4l2_control {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 __u32 id;
1001 __s32 value;
1002};
1003
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001004struct v4l2_ext_control {
Hans Verkuil4f341712006-06-18 13:27:19 -03001005 __u32 id;
Hans Verkuil6b5a9492009-08-11 18:47:18 -03001006 __u32 size;
1007 __u32 reserved2[1];
Hans Verkuil4f341712006-06-18 13:27:19 -03001008 union {
1009 __s32 value;
1010 __s64 value64;
Hans Verkuil6b5a9492009-08-11 18:47:18 -03001011 char *string;
Hans Verkuil4f341712006-06-18 13:27:19 -03001012 };
Mauro Carvalho Chehabf251d232006-07-22 08:20:07 -03001013} __attribute__ ((packed));
Hans Verkuil4f341712006-06-18 13:27:19 -03001014
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001015struct v4l2_ext_controls {
Hans Verkuil4f341712006-06-18 13:27:19 -03001016 __u32 ctrl_class;
1017 __u32 count;
1018 __u32 error_idx;
1019 __u32 reserved[2];
1020 struct v4l2_ext_control *controls;
1021};
1022
1023/* Values for ctrl_class field */
1024#define V4L2_CTRL_CLASS_USER 0x00980000 /* Old-style 'user' controls */
1025#define V4L2_CTRL_CLASS_MPEG 0x00990000 /* MPEG-compression controls */
Brandon Philipsf9bd5842008-04-22 14:42:02 -03001026#define V4L2_CTRL_CLASS_CAMERA 0x009a0000 /* Camera class controls */
Eduardo Valentin6b424942009-08-08 08:38:58 -03001027#define V4L2_CTRL_CLASS_FM_TX 0x009b0000 /* FM Modulator control class */
Hans Verkuil4f341712006-06-18 13:27:19 -03001028
1029#define V4L2_CTRL_ID_MASK (0x0fffffff)
1030#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1031#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1032
Hans Verkuilea64f8c2010-04-06 06:53:57 -03001033enum v4l2_ctrl_type {
1034 V4L2_CTRL_TYPE_INTEGER = 1,
1035 V4L2_CTRL_TYPE_BOOLEAN = 2,
1036 V4L2_CTRL_TYPE_MENU = 3,
1037 V4L2_CTRL_TYPE_BUTTON = 4,
1038 V4L2_CTRL_TYPE_INTEGER64 = 5,
1039 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1040 V4L2_CTRL_TYPE_STRING = 7,
1041};
1042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001044struct v4l2_queryctrl {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001045 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 enum v4l2_ctrl_type type;
1047 __u8 name[32]; /* Whatever */
1048 __s32 minimum; /* Note signedness */
1049 __s32 maximum;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001050 __s32 step;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 __s32 default_value;
1052 __u32 flags;
1053 __u32 reserved[2];
1054};
1055
1056/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001057struct v4l2_querymenu {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 __u32 id;
1059 __u32 index;
1060 __u8 name[32]; /* Whatever */
1061 __u32 reserved;
1062};
1063
1064/* Control flags */
1065#define V4L2_CTRL_FLAG_DISABLED 0x0001
1066#define V4L2_CTRL_FLAG_GRABBED 0x0002
Hans Verkuil4f341712006-06-18 13:27:19 -03001067#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1068#define V4L2_CTRL_FLAG_UPDATE 0x0008
1069#define V4L2_CTRL_FLAG_INACTIVE 0x0010
1070#define V4L2_CTRL_FLAG_SLIDER 0x0020
Hans Verkuil1a367f32009-02-20 05:55:39 -03001071#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Hans Verkuil4f341712006-06-18 13:27:19 -03001073/* Query flag, to be ORed with the control ID */
1074#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1075
1076/* User-class control IDs defined by V4L2 */
1077#define V4L2_CID_BASE (V4L2_CTRL_CLASS_USER | 0x900)
1078#define V4L2_CID_USER_BASE V4L2_CID_BASE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079/* IDs reserved for driver specific controls */
1080#define V4L2_CID_PRIVATE_BASE 0x08000000
1081
Hans Verkuil4f341712006-06-18 13:27:19 -03001082#define V4L2_CID_USER_CLASS (V4L2_CTRL_CLASS_USER | 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083#define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
1084#define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
1085#define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
1086#define V4L2_CID_HUE (V4L2_CID_BASE+3)
1087#define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
1088#define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
1089#define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
1090#define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
1091#define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
1092#define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
Brandon Philips26d507f2008-04-22 14:42:02 -03001093#define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11) /* Deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094#define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
1095#define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
1096#define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
1097#define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
1098#define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
Brandon Philips26d507f2008-04-22 14:42:02 -03001099#define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* Deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100#define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
1101#define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
1102#define V4L2_CID_GAIN (V4L2_CID_BASE+19)
1103#define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
1104#define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
Brandon Philips26d507f2008-04-22 14:42:02 -03001105
David Woodhouse39028ec2008-06-02 15:46:51 -03001106/* Deprecated; use V4L2_CID_PAN_RESET and V4L2_CID_TILT_RESET */
1107#define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
1108#define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
Brandon Philips26d507f2008-04-22 14:42:02 -03001109
1110#define V4L2_CID_POWER_LINE_FREQUENCY (V4L2_CID_BASE+24)
1111enum v4l2_power_line_frequency {
1112 V4L2_CID_POWER_LINE_FREQUENCY_DISABLED = 0,
1113 V4L2_CID_POWER_LINE_FREQUENCY_50HZ = 1,
1114 V4L2_CID_POWER_LINE_FREQUENCY_60HZ = 2,
1115};
1116#define V4L2_CID_HUE_AUTO (V4L2_CID_BASE+25)
1117#define V4L2_CID_WHITE_BALANCE_TEMPERATURE (V4L2_CID_BASE+26)
1118#define V4L2_CID_SHARPNESS (V4L2_CID_BASE+27)
1119#define V4L2_CID_BACKLIGHT_COMPENSATION (V4L2_CID_BASE+28)
Frej Drejhammar1c412d12008-03-23 22:43:20 -03001120#define V4L2_CID_CHROMA_AGC (V4L2_CID_BASE+29)
Frej Drejhammara8ac6882008-03-23 22:43:23 -03001121#define V4L2_CID_COLOR_KILLER (V4L2_CID_BASE+30)
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001122#define V4L2_CID_COLORFX (V4L2_CID_BASE+31)
1123enum v4l2_colorfx {
1124 V4L2_COLORFX_NONE = 0,
1125 V4L2_COLORFX_BW = 1,
1126 V4L2_COLORFX_SEPIA = 2,
Xiaolin Zhang35e6aa92010-04-18 23:06:50 -03001127 V4L2_COLORFX_NEGATIVE = 3,
1128 V4L2_COLORFX_EMBOSS = 4,
1129 V4L2_COLORFX_SKETCH = 5,
1130 V4L2_COLORFX_SKY_BLUE = 6,
1131 V4L2_COLORFX_GRASS_GREEN = 7,
1132 V4L2_COLORFX_SKIN_WHITEN = 8,
1133 V4L2_COLORFX_VIVID = 9,
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001134};
Hans de Goede02ab18b2009-06-14 04:32:04 -03001135#define V4L2_CID_AUTOBRIGHTNESS (V4L2_CID_BASE+32)
Guennadi Liakhovetski3418f162009-08-25 11:44:14 -03001136#define V4L2_CID_BAND_STOP_FILTER (V4L2_CID_BASE+33)
Sergio Aguirre2c32cc02009-01-20 18:34:43 -03001137
Vaibhav Hiremath85213632009-11-10 13:32:53 -03001138#define V4L2_CID_ROTATE (V4L2_CID_BASE+34)
1139#define V4L2_CID_BG_COLOR (V4L2_CID_BASE+35)
Devin Heitmueller7a01f6d2010-03-11 21:27:59 -03001140
1141#define V4L2_CID_CHROMA_GAIN (V4L2_CID_BASE+36)
1142
Jean-François Moine008d35f2010-09-13 07:04:49 -03001143#define V4L2_CID_ILLUMINATORS_1 (V4L2_CID_BASE+37)
1144#define V4L2_CID_ILLUMINATORS_2 (V4L2_CID_BASE+38)
1145
Frej Drejhammar1c412d12008-03-23 22:43:20 -03001146/* last CID + 1 */
Jean-François Moine008d35f2010-09-13 07:04:49 -03001147#define V4L2_CID_LASTP1 (V4L2_CID_BASE+39)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
Hans Verkuil4f341712006-06-18 13:27:19 -03001149/* MPEG-class control IDs defined by V4L2 */
1150#define V4L2_CID_MPEG_BASE (V4L2_CTRL_CLASS_MPEG | 0x900)
1151#define V4L2_CID_MPEG_CLASS (V4L2_CTRL_CLASS_MPEG | 1)
1152
1153/* MPEG streams */
1154#define V4L2_CID_MPEG_STREAM_TYPE (V4L2_CID_MPEG_BASE+0)
1155enum v4l2_mpeg_stream_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001156 V4L2_MPEG_STREAM_TYPE_MPEG2_PS = 0, /* MPEG-2 program stream */
1157 V4L2_MPEG_STREAM_TYPE_MPEG2_TS = 1, /* MPEG-2 transport stream */
1158 V4L2_MPEG_STREAM_TYPE_MPEG1_SS = 2, /* MPEG-1 system stream */
1159 V4L2_MPEG_STREAM_TYPE_MPEG2_DVD = 3, /* MPEG-2 DVD-compatible stream */
1160 V4L2_MPEG_STREAM_TYPE_MPEG1_VCD = 4, /* MPEG-1 VCD-compatible stream */
1161 V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD = 5, /* MPEG-2 SVCD-compatible stream */
Hans Verkuil4f341712006-06-18 13:27:19 -03001162};
1163#define V4L2_CID_MPEG_STREAM_PID_PMT (V4L2_CID_MPEG_BASE+1)
1164#define V4L2_CID_MPEG_STREAM_PID_AUDIO (V4L2_CID_MPEG_BASE+2)
1165#define V4L2_CID_MPEG_STREAM_PID_VIDEO (V4L2_CID_MPEG_BASE+3)
1166#define V4L2_CID_MPEG_STREAM_PID_PCR (V4L2_CID_MPEG_BASE+4)
1167#define V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (V4L2_CID_MPEG_BASE+5)
1168#define V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (V4L2_CID_MPEG_BASE+6)
Hans Verkuil8cbde942006-06-24 14:36:02 -03001169#define V4L2_CID_MPEG_STREAM_VBI_FMT (V4L2_CID_MPEG_BASE+7)
1170enum v4l2_mpeg_stream_vbi_fmt {
1171 V4L2_MPEG_STREAM_VBI_FMT_NONE = 0, /* No VBI in the MPEG stream */
1172 V4L2_MPEG_STREAM_VBI_FMT_IVTV = 1, /* VBI in private packets, IVTV format */
1173};
Hans Verkuil4f341712006-06-18 13:27:19 -03001174
1175/* MPEG audio */
1176#define V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ (V4L2_CID_MPEG_BASE+100)
1177enum v4l2_mpeg_audio_sampling_freq {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001178 V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100 = 0,
1179 V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000 = 1,
1180 V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001181};
1182#define V4L2_CID_MPEG_AUDIO_ENCODING (V4L2_CID_MPEG_BASE+101)
1183enum v4l2_mpeg_audio_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001184 V4L2_MPEG_AUDIO_ENCODING_LAYER_1 = 0,
1185 V4L2_MPEG_AUDIO_ENCODING_LAYER_2 = 1,
1186 V4L2_MPEG_AUDIO_ENCODING_LAYER_3 = 2,
Janne Grunau188919a2008-08-08 07:21:00 -03001187 V4L2_MPEG_AUDIO_ENCODING_AAC = 3,
Hans Verkuile6b5da82008-08-08 07:38:07 -03001188 V4L2_MPEG_AUDIO_ENCODING_AC3 = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001189};
1190#define V4L2_CID_MPEG_AUDIO_L1_BITRATE (V4L2_CID_MPEG_BASE+102)
1191enum v4l2_mpeg_audio_l1_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001192 V4L2_MPEG_AUDIO_L1_BITRATE_32K = 0,
1193 V4L2_MPEG_AUDIO_L1_BITRATE_64K = 1,
1194 V4L2_MPEG_AUDIO_L1_BITRATE_96K = 2,
1195 V4L2_MPEG_AUDIO_L1_BITRATE_128K = 3,
1196 V4L2_MPEG_AUDIO_L1_BITRATE_160K = 4,
1197 V4L2_MPEG_AUDIO_L1_BITRATE_192K = 5,
1198 V4L2_MPEG_AUDIO_L1_BITRATE_224K = 6,
1199 V4L2_MPEG_AUDIO_L1_BITRATE_256K = 7,
1200 V4L2_MPEG_AUDIO_L1_BITRATE_288K = 8,
1201 V4L2_MPEG_AUDIO_L1_BITRATE_320K = 9,
1202 V4L2_MPEG_AUDIO_L1_BITRATE_352K = 10,
1203 V4L2_MPEG_AUDIO_L1_BITRATE_384K = 11,
1204 V4L2_MPEG_AUDIO_L1_BITRATE_416K = 12,
1205 V4L2_MPEG_AUDIO_L1_BITRATE_448K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001206};
1207#define V4L2_CID_MPEG_AUDIO_L2_BITRATE (V4L2_CID_MPEG_BASE+103)
1208enum v4l2_mpeg_audio_l2_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001209 V4L2_MPEG_AUDIO_L2_BITRATE_32K = 0,
1210 V4L2_MPEG_AUDIO_L2_BITRATE_48K = 1,
1211 V4L2_MPEG_AUDIO_L2_BITRATE_56K = 2,
1212 V4L2_MPEG_AUDIO_L2_BITRATE_64K = 3,
1213 V4L2_MPEG_AUDIO_L2_BITRATE_80K = 4,
1214 V4L2_MPEG_AUDIO_L2_BITRATE_96K = 5,
1215 V4L2_MPEG_AUDIO_L2_BITRATE_112K = 6,
1216 V4L2_MPEG_AUDIO_L2_BITRATE_128K = 7,
1217 V4L2_MPEG_AUDIO_L2_BITRATE_160K = 8,
1218 V4L2_MPEG_AUDIO_L2_BITRATE_192K = 9,
1219 V4L2_MPEG_AUDIO_L2_BITRATE_224K = 10,
1220 V4L2_MPEG_AUDIO_L2_BITRATE_256K = 11,
1221 V4L2_MPEG_AUDIO_L2_BITRATE_320K = 12,
1222 V4L2_MPEG_AUDIO_L2_BITRATE_384K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001223};
1224#define V4L2_CID_MPEG_AUDIO_L3_BITRATE (V4L2_CID_MPEG_BASE+104)
1225enum v4l2_mpeg_audio_l3_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001226 V4L2_MPEG_AUDIO_L3_BITRATE_32K = 0,
1227 V4L2_MPEG_AUDIO_L3_BITRATE_40K = 1,
1228 V4L2_MPEG_AUDIO_L3_BITRATE_48K = 2,
1229 V4L2_MPEG_AUDIO_L3_BITRATE_56K = 3,
1230 V4L2_MPEG_AUDIO_L3_BITRATE_64K = 4,
1231 V4L2_MPEG_AUDIO_L3_BITRATE_80K = 5,
1232 V4L2_MPEG_AUDIO_L3_BITRATE_96K = 6,
1233 V4L2_MPEG_AUDIO_L3_BITRATE_112K = 7,
1234 V4L2_MPEG_AUDIO_L3_BITRATE_128K = 8,
1235 V4L2_MPEG_AUDIO_L3_BITRATE_160K = 9,
1236 V4L2_MPEG_AUDIO_L3_BITRATE_192K = 10,
1237 V4L2_MPEG_AUDIO_L3_BITRATE_224K = 11,
1238 V4L2_MPEG_AUDIO_L3_BITRATE_256K = 12,
1239 V4L2_MPEG_AUDIO_L3_BITRATE_320K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001240};
1241#define V4L2_CID_MPEG_AUDIO_MODE (V4L2_CID_MPEG_BASE+105)
1242enum v4l2_mpeg_audio_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001243 V4L2_MPEG_AUDIO_MODE_STEREO = 0,
1244 V4L2_MPEG_AUDIO_MODE_JOINT_STEREO = 1,
1245 V4L2_MPEG_AUDIO_MODE_DUAL = 2,
1246 V4L2_MPEG_AUDIO_MODE_MONO = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001247};
1248#define V4L2_CID_MPEG_AUDIO_MODE_EXTENSION (V4L2_CID_MPEG_BASE+106)
1249enum v4l2_mpeg_audio_mode_extension {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001250 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4 = 0,
1251 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8 = 1,
1252 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12 = 2,
1253 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001254};
1255#define V4L2_CID_MPEG_AUDIO_EMPHASIS (V4L2_CID_MPEG_BASE+107)
1256enum v4l2_mpeg_audio_emphasis {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001257 V4L2_MPEG_AUDIO_EMPHASIS_NONE = 0,
1258 V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS = 1,
1259 V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001260};
1261#define V4L2_CID_MPEG_AUDIO_CRC (V4L2_CID_MPEG_BASE+108)
1262enum v4l2_mpeg_audio_crc {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001263 V4L2_MPEG_AUDIO_CRC_NONE = 0,
1264 V4L2_MPEG_AUDIO_CRC_CRC16 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001265};
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001266#define V4L2_CID_MPEG_AUDIO_MUTE (V4L2_CID_MPEG_BASE+109)
Hans Verkuilf723af12008-08-09 10:35:29 -03001267#define V4L2_CID_MPEG_AUDIO_AAC_BITRATE (V4L2_CID_MPEG_BASE+110)
1268#define V4L2_CID_MPEG_AUDIO_AC3_BITRATE (V4L2_CID_MPEG_BASE+111)
Hans Verkuile6b5da82008-08-08 07:38:07 -03001269enum v4l2_mpeg_audio_ac3_bitrate {
1270 V4L2_MPEG_AUDIO_AC3_BITRATE_32K = 0,
1271 V4L2_MPEG_AUDIO_AC3_BITRATE_40K = 1,
1272 V4L2_MPEG_AUDIO_AC3_BITRATE_48K = 2,
1273 V4L2_MPEG_AUDIO_AC3_BITRATE_56K = 3,
1274 V4L2_MPEG_AUDIO_AC3_BITRATE_64K = 4,
1275 V4L2_MPEG_AUDIO_AC3_BITRATE_80K = 5,
1276 V4L2_MPEG_AUDIO_AC3_BITRATE_96K = 6,
1277 V4L2_MPEG_AUDIO_AC3_BITRATE_112K = 7,
1278 V4L2_MPEG_AUDIO_AC3_BITRATE_128K = 8,
1279 V4L2_MPEG_AUDIO_AC3_BITRATE_160K = 9,
1280 V4L2_MPEG_AUDIO_AC3_BITRATE_192K = 10,
1281 V4L2_MPEG_AUDIO_AC3_BITRATE_224K = 11,
1282 V4L2_MPEG_AUDIO_AC3_BITRATE_256K = 12,
1283 V4L2_MPEG_AUDIO_AC3_BITRATE_320K = 13,
1284 V4L2_MPEG_AUDIO_AC3_BITRATE_384K = 14,
1285 V4L2_MPEG_AUDIO_AC3_BITRATE_448K = 15,
1286 V4L2_MPEG_AUDIO_AC3_BITRATE_512K = 16,
1287 V4L2_MPEG_AUDIO_AC3_BITRATE_576K = 17,
1288 V4L2_MPEG_AUDIO_AC3_BITRATE_640K = 18,
1289};
Hans Verkuil4f341712006-06-18 13:27:19 -03001290
1291/* MPEG video */
1292#define V4L2_CID_MPEG_VIDEO_ENCODING (V4L2_CID_MPEG_BASE+200)
1293enum v4l2_mpeg_video_encoding {
Janne Grunau188919a2008-08-08 07:21:00 -03001294 V4L2_MPEG_VIDEO_ENCODING_MPEG_1 = 0,
1295 V4L2_MPEG_VIDEO_ENCODING_MPEG_2 = 1,
1296 V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001297};
1298#define V4L2_CID_MPEG_VIDEO_ASPECT (V4L2_CID_MPEG_BASE+201)
1299enum v4l2_mpeg_video_aspect {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001300 V4L2_MPEG_VIDEO_ASPECT_1x1 = 0,
1301 V4L2_MPEG_VIDEO_ASPECT_4x3 = 1,
1302 V4L2_MPEG_VIDEO_ASPECT_16x9 = 2,
1303 V4L2_MPEG_VIDEO_ASPECT_221x100 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001304};
1305#define V4L2_CID_MPEG_VIDEO_B_FRAMES (V4L2_CID_MPEG_BASE+202)
1306#define V4L2_CID_MPEG_VIDEO_GOP_SIZE (V4L2_CID_MPEG_BASE+203)
1307#define V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (V4L2_CID_MPEG_BASE+204)
1308#define V4L2_CID_MPEG_VIDEO_PULLDOWN (V4L2_CID_MPEG_BASE+205)
1309#define V4L2_CID_MPEG_VIDEO_BITRATE_MODE (V4L2_CID_MPEG_BASE+206)
1310enum v4l2_mpeg_video_bitrate_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001311 V4L2_MPEG_VIDEO_BITRATE_MODE_VBR = 0,
1312 V4L2_MPEG_VIDEO_BITRATE_MODE_CBR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001313};
1314#define V4L2_CID_MPEG_VIDEO_BITRATE (V4L2_CID_MPEG_BASE+207)
1315#define V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (V4L2_CID_MPEG_BASE+208)
1316#define V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (V4L2_CID_MPEG_BASE+209)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001317#define V4L2_CID_MPEG_VIDEO_MUTE (V4L2_CID_MPEG_BASE+210)
1318#define V4L2_CID_MPEG_VIDEO_MUTE_YUV (V4L2_CID_MPEG_BASE+211)
Hans Verkuil4f341712006-06-18 13:27:19 -03001319
Hans Verkuil4b00eb22008-12-19 11:17:56 -03001320/* MPEG-class control IDs specific to the CX2341x driver as defined by V4L2 */
Hans Verkuil4f341712006-06-18 13:27:19 -03001321#define V4L2_CID_MPEG_CX2341X_BASE (V4L2_CTRL_CLASS_MPEG | 0x1000)
1322#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+0)
1323enum v4l2_mpeg_cx2341x_video_spatial_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001324 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL = 0,
1325 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001326};
1327#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+1)
1328#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+2)
1329enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001330 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF = 0,
1331 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
1332 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT = 2,
1333 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE = 3,
1334 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001335};
1336#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+3)
1337enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001338 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF = 0,
1339 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001340};
1341#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+4)
1342enum v4l2_mpeg_cx2341x_video_temporal_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001343 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL = 0,
1344 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001345};
1346#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+5)
1347#define V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+6)
1348enum v4l2_mpeg_cx2341x_video_median_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001349 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF = 0,
1350 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR = 1,
1351 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT = 2,
1352 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT = 3,
1353 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001354};
1355#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+7)
1356#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+8)
1357#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+9)
1358#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+10)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001359#define V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (V4L2_CID_MPEG_CX2341X_BASE+11)
Hans Verkuil4f341712006-06-18 13:27:19 -03001360
Brandon Philipsf9bd5842008-04-22 14:42:02 -03001361/* Camera class control IDs */
1362#define V4L2_CID_CAMERA_CLASS_BASE (V4L2_CTRL_CLASS_CAMERA | 0x900)
1363#define V4L2_CID_CAMERA_CLASS (V4L2_CTRL_CLASS_CAMERA | 1)
1364
1365#define V4L2_CID_EXPOSURE_AUTO (V4L2_CID_CAMERA_CLASS_BASE+1)
1366enum v4l2_exposure_auto_type {
1367 V4L2_EXPOSURE_AUTO = 0,
1368 V4L2_EXPOSURE_MANUAL = 1,
1369 V4L2_EXPOSURE_SHUTTER_PRIORITY = 2,
1370 V4L2_EXPOSURE_APERTURE_PRIORITY = 3
1371};
1372#define V4L2_CID_EXPOSURE_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+2)
1373#define V4L2_CID_EXPOSURE_AUTO_PRIORITY (V4L2_CID_CAMERA_CLASS_BASE+3)
1374
1375#define V4L2_CID_PAN_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+4)
1376#define V4L2_CID_TILT_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+5)
1377#define V4L2_CID_PAN_RESET (V4L2_CID_CAMERA_CLASS_BASE+6)
1378#define V4L2_CID_TILT_RESET (V4L2_CID_CAMERA_CLASS_BASE+7)
1379
1380#define V4L2_CID_PAN_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+8)
1381#define V4L2_CID_TILT_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+9)
1382
1383#define V4L2_CID_FOCUS_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+10)
1384#define V4L2_CID_FOCUS_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+11)
1385#define V4L2_CID_FOCUS_AUTO (V4L2_CID_CAMERA_CLASS_BASE+12)
1386
Laurent Pinchart08772582008-12-14 16:21:16 -03001387#define V4L2_CID_ZOOM_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+13)
1388#define V4L2_CID_ZOOM_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+14)
1389#define V4L2_CID_ZOOM_CONTINUOUS (V4L2_CID_CAMERA_CLASS_BASE+15)
1390
Laurent Pinchart046425f2008-12-14 16:22:05 -03001391#define V4L2_CID_PRIVACY (V4L2_CID_CAMERA_CLASS_BASE+16)
1392
Laurent Pinchart48213fe2010-01-20 12:12:57 -03001393#define V4L2_CID_IRIS_ABSOLUTE (V4L2_CID_CAMERA_CLASS_BASE+17)
1394#define V4L2_CID_IRIS_RELATIVE (V4L2_CID_CAMERA_CLASS_BASE+18)
1395
Eduardo Valentin6b424942009-08-08 08:38:58 -03001396/* FM Modulator class control IDs */
1397#define V4L2_CID_FM_TX_CLASS_BASE (V4L2_CTRL_CLASS_FM_TX | 0x900)
1398#define V4L2_CID_FM_TX_CLASS (V4L2_CTRL_CLASS_FM_TX | 1)
1399
1400#define V4L2_CID_RDS_TX_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 1)
1401#define V4L2_CID_RDS_TX_PI (V4L2_CID_FM_TX_CLASS_BASE + 2)
1402#define V4L2_CID_RDS_TX_PTY (V4L2_CID_FM_TX_CLASS_BASE + 3)
1403#define V4L2_CID_RDS_TX_PS_NAME (V4L2_CID_FM_TX_CLASS_BASE + 5)
1404#define V4L2_CID_RDS_TX_RADIO_TEXT (V4L2_CID_FM_TX_CLASS_BASE + 6)
1405
1406#define V4L2_CID_AUDIO_LIMITER_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 64)
1407#define V4L2_CID_AUDIO_LIMITER_RELEASE_TIME (V4L2_CID_FM_TX_CLASS_BASE + 65)
1408#define V4L2_CID_AUDIO_LIMITER_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 66)
1409
1410#define V4L2_CID_AUDIO_COMPRESSION_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 80)
1411#define V4L2_CID_AUDIO_COMPRESSION_GAIN (V4L2_CID_FM_TX_CLASS_BASE + 81)
1412#define V4L2_CID_AUDIO_COMPRESSION_THRESHOLD (V4L2_CID_FM_TX_CLASS_BASE + 82)
1413#define V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME (V4L2_CID_FM_TX_CLASS_BASE + 83)
1414#define V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME (V4L2_CID_FM_TX_CLASS_BASE + 84)
1415
1416#define V4L2_CID_PILOT_TONE_ENABLED (V4L2_CID_FM_TX_CLASS_BASE + 96)
1417#define V4L2_CID_PILOT_TONE_DEVIATION (V4L2_CID_FM_TX_CLASS_BASE + 97)
1418#define V4L2_CID_PILOT_TONE_FREQUENCY (V4L2_CID_FM_TX_CLASS_BASE + 98)
1419
1420#define V4L2_CID_TUNE_PREEMPHASIS (V4L2_CID_FM_TX_CLASS_BASE + 112)
1421enum v4l2_preemphasis {
1422 V4L2_PREEMPHASIS_DISABLED = 0,
1423 V4L2_PREEMPHASIS_50_uS = 1,
1424 V4L2_PREEMPHASIS_75_uS = 2,
1425};
1426#define V4L2_CID_TUNE_POWER_LEVEL (V4L2_CID_FM_TX_CLASS_BASE + 113)
1427#define V4L2_CID_TUNE_ANTENNA_CAPACITOR (V4L2_CID_FM_TX_CLASS_BASE + 114)
1428
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429/*
1430 * T U N I N G
1431 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001432struct v4l2_tuner {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 __u32 index;
1434 __u8 name[32];
1435 enum v4l2_tuner_type type;
1436 __u32 capability;
1437 __u32 rangelow;
1438 __u32 rangehigh;
1439 __u32 rxsubchans;
1440 __u32 audmode;
1441 __s32 signal;
1442 __s32 afc;
1443 __u32 reserved[4];
1444};
1445
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001446struct v4l2_modulator {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 __u32 index;
1448 __u8 name[32];
1449 __u32 capability;
1450 __u32 rangelow;
1451 __u32 rangehigh;
1452 __u32 txsubchans;
1453 __u32 reserved[4];
1454};
1455
1456/* Flags for the 'capability' field */
1457#define V4L2_TUNER_CAP_LOW 0x0001
1458#define V4L2_TUNER_CAP_NORM 0x0002
1459#define V4L2_TUNER_CAP_STEREO 0x0010
1460#define V4L2_TUNER_CAP_LANG2 0x0020
1461#define V4L2_TUNER_CAP_SAP 0x0020
1462#define V4L2_TUNER_CAP_LANG1 0x0040
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001463#define V4L2_TUNER_CAP_RDS 0x0080
Matti Aaltonen44a81552010-10-07 10:16:11 -03001464#define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1465#define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
1467/* Flags for the 'rxsubchans' field */
1468#define V4L2_TUNER_SUB_MONO 0x0001
1469#define V4L2_TUNER_SUB_STEREO 0x0002
1470#define V4L2_TUNER_SUB_LANG2 0x0004
1471#define V4L2_TUNER_SUB_SAP 0x0004
1472#define V4L2_TUNER_SUB_LANG1 0x0008
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001473#define V4L2_TUNER_SUB_RDS 0x0010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
1475/* Values for the 'audmode' field */
1476#define V4L2_TUNER_MODE_MONO 0x0000
1477#define V4L2_TUNER_MODE_STEREO 0x0001
1478#define V4L2_TUNER_MODE_LANG2 0x0002
1479#define V4L2_TUNER_MODE_SAP 0x0002
1480#define V4L2_TUNER_MODE_LANG1 0x0003
Hans Verkuil301e22d2006-03-18 17:15:00 -03001481#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001483struct v4l2_frequency {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001484 __u32 tuner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 enum v4l2_tuner_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001486 __u32 frequency;
1487 __u32 reserved[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488};
1489
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -03001490struct v4l2_hw_freq_seek {
1491 __u32 tuner;
1492 enum v4l2_tuner_type type;
1493 __u32 seek_upward;
1494 __u32 wrap_around;
Matti Aaltonen44a81552010-10-07 10:16:11 -03001495 __u32 spacing;
1496 __u32 reserved[7];
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -03001497};
1498
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499/*
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001500 * R D S
1501 */
1502
1503struct v4l2_rds_data {
1504 __u8 lsb;
1505 __u8 msb;
1506 __u8 block;
1507} __attribute__ ((packed));
1508
1509#define V4L2_RDS_BLOCK_MSK 0x7
1510#define V4L2_RDS_BLOCK_A 0
1511#define V4L2_RDS_BLOCK_B 1
1512#define V4L2_RDS_BLOCK_C 2
1513#define V4L2_RDS_BLOCK_D 3
1514#define V4L2_RDS_BLOCK_C_ALT 4
1515#define V4L2_RDS_BLOCK_INVALID 7
1516
1517#define V4L2_RDS_BLOCK_CORRECTED 0x40
1518#define V4L2_RDS_BLOCK_ERROR 0x80
1519
1520/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 * A U D I O
1522 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001523struct v4l2_audio {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 __u32 index;
1525 __u8 name[32];
1526 __u32 capability;
1527 __u32 mode;
1528 __u32 reserved[2];
1529};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -03001530
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531/* Flags for the 'capability' field */
1532#define V4L2_AUDCAP_STEREO 0x00001
1533#define V4L2_AUDCAP_AVL 0x00002
1534
1535/* Flags for the 'mode' field */
1536#define V4L2_AUDMODE_AVL 0x00001
1537
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001538struct v4l2_audioout {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 __u32 index;
1540 __u8 name[32];
1541 __u32 capability;
1542 __u32 mode;
1543 __u32 reserved[2];
1544};
1545
1546/*
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001547 * M P E G S E R V I C E S
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001548 *
1549 * NOTE: EXPERIMENTAL API
1550 */
1551#if 1
1552#define V4L2_ENC_IDX_FRAME_I (0)
1553#define V4L2_ENC_IDX_FRAME_P (1)
1554#define V4L2_ENC_IDX_FRAME_B (2)
1555#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1556
1557struct v4l2_enc_idx_entry {
1558 __u64 offset;
1559 __u64 pts;
1560 __u32 length;
1561 __u32 flags;
1562 __u32 reserved[2];
1563};
1564
1565#define V4L2_ENC_IDX_ENTRIES (64)
1566struct v4l2_enc_idx {
1567 __u32 entries;
1568 __u32 entries_cap;
1569 __u32 reserved[4];
1570 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1571};
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001572
1573
1574#define V4L2_ENC_CMD_START (0)
1575#define V4L2_ENC_CMD_STOP (1)
1576#define V4L2_ENC_CMD_PAUSE (2)
1577#define V4L2_ENC_CMD_RESUME (3)
1578
1579/* Flags for V4L2_ENC_CMD_STOP */
1580#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1581
1582struct v4l2_encoder_cmd {
1583 __u32 cmd;
1584 __u32 flags;
1585 union {
1586 struct {
1587 __u32 data[8];
1588 } raw;
1589 };
1590};
1591
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001592#endif
1593
1594
1595/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 * D A T A S E R V I C E S ( V B I )
1597 *
1598 * Data services API by Michael Schimek
1599 */
1600
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001601/* Raw VBI */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001602struct v4l2_vbi_format {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 __u32 sampling_rate; /* in 1 Hz */
1604 __u32 offset;
1605 __u32 samples_per_line;
1606 __u32 sample_format; /* V4L2_PIX_FMT_* */
1607 __s32 start[2];
1608 __u32 count[2];
1609 __u32 flags; /* V4L2_VBI_* */
1610 __u32 reserved[2]; /* must be zero */
1611};
1612
1613/* VBI flags */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001614#define V4L2_VBI_UNSYNC (1 << 0)
1615#define V4L2_VBI_INTERLACED (1 << 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001617/* Sliced VBI
1618 *
1619 * This implements is a proposal V4L2 API to allow SLICED VBI
1620 * required for some hardware encoders. It should change without
1621 * notice in the definitive implementation.
1622 */
1623
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001624struct v4l2_sliced_vbi_format {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001625 __u16 service_set;
1626 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1627 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001628 (equals frame lines 313-336 for 625 line video
1629 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001630 __u16 service_lines[2][24];
1631 __u32 io_size;
1632 __u32 reserved[2]; /* must be zero */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001633};
1634
Mauro Carvalho Chehab4d0dddb2006-01-23 17:11:07 -02001635/* Teletext World System Teletext
1636 (WST), defined on ITU-R BT.653-2 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001637#define V4L2_SLICED_TELETEXT_B (0x0001)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001638/* Video Program System, defined on ETS 300 231*/
Hans Verkuil9bc74002006-03-29 18:02:51 -03001639#define V4L2_SLICED_VPS (0x0400)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001640/* Closed Caption, defined on EIA-608 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001641#define V4L2_SLICED_CAPTION_525 (0x1000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001642/* Wide Screen System, defined on ITU-R BT1119.1 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001643#define V4L2_SLICED_WSS_625 (0x4000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001644
Hans Verkuil9bc74002006-03-29 18:02:51 -03001645#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1646#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001647
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001648struct v4l2_sliced_vbi_cap {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001649 __u16 service_set;
1650 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1651 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001652 (equals frame lines 313-336 for 625 line video
1653 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001654 __u16 service_lines[2][24];
Hans Verkuil1739ade2006-08-26 03:05:17 -03001655 enum v4l2_buf_type type;
1656 __u32 reserved[3]; /* must be 0 */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001657};
1658
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001659struct v4l2_sliced_vbi_data {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001660 __u32 id;
1661 __u32 field; /* 0: first field, 1: second field */
1662 __u32 line; /* 1-23 */
1663 __u32 reserved; /* must be 0 */
1664 __u8 data[48];
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001665};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
1667/*
Andy Walls6273fda2009-03-14 17:06:07 -03001668 * Sliced VBI data inserted into MPEG Streams
1669 */
1670
1671/*
1672 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1673 *
1674 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1675 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1676 * data
1677 *
1678 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1679 * definitions are not included here. See the MPEG-2 specifications for details
1680 * on these headers.
1681 */
1682
1683/* Line type IDs */
1684#define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
1685#define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
1686#define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
1687#define V4L2_MPEG_VBI_IVTV_VPS (7)
1688
1689struct v4l2_mpeg_vbi_itv0_line {
1690 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
1691 __u8 data[42]; /* Sliced VBI data for the line */
1692} __attribute__ ((packed));
1693
1694struct v4l2_mpeg_vbi_itv0 {
1695 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
1696 struct v4l2_mpeg_vbi_itv0_line line[35];
1697} __attribute__ ((packed));
1698
1699struct v4l2_mpeg_vbi_ITV0 {
1700 struct v4l2_mpeg_vbi_itv0_line line[36];
1701} __attribute__ ((packed));
1702
1703#define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
1704#define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
1705
1706struct v4l2_mpeg_vbi_fmt_ivtv {
1707 __u8 magic[4];
1708 union {
1709 struct v4l2_mpeg_vbi_itv0 itv0;
1710 struct v4l2_mpeg_vbi_ITV0 ITV0;
1711 };
1712} __attribute__ ((packed));
1713
1714/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 * A G G R E G A T E S T R U C T U R E S
1716 */
1717
Pawel Osciakf8f39142010-07-29 14:44:25 -03001718/**
1719 * struct v4l2_plane_pix_format - additional, per-plane format definition
1720 * @sizeimage: maximum size in bytes required for data, for which
1721 * this plane will be used
1722 * @bytesperline: distance in bytes between the leftmost pixels in two
1723 * adjacent lines
1724 */
1725struct v4l2_plane_pix_format {
1726 __u32 sizeimage;
1727 __u16 bytesperline;
1728 __u16 reserved[7];
1729} __attribute__ ((packed));
1730
1731/**
1732 * struct v4l2_pix_format_mplane - multiplanar format definition
1733 * @width: image width in pixels
1734 * @height: image height in pixels
1735 * @pixelformat: little endian four character code (fourcc)
1736 * @field: field order (for interlaced video)
1737 * @colorspace: supplemental to pixelformat
1738 * @plane_fmt: per-plane information
1739 * @num_planes: number of planes for this format
1740 */
1741struct v4l2_pix_format_mplane {
1742 __u32 width;
1743 __u32 height;
1744 __u32 pixelformat;
1745 enum v4l2_field field;
1746 enum v4l2_colorspace colorspace;
1747
1748 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
1749 __u8 num_planes;
1750 __u8 reserved[11];
1751} __attribute__ ((packed));
1752
1753/**
1754 * struct v4l2_format - stream data format
1755 * @type: type of the data stream
1756 * @pix: definition of an image format
1757 * @pix_mp: definition of a multiplanar image format
1758 * @win: definition of an overlaid image
1759 * @vbi: raw VBI capture or output parameters
1760 * @sliced: sliced VBI capture or output parameters
1761 * @raw_data: placeholder for future extensions and custom formats
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001763struct v4l2_format {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 enum v4l2_buf_type type;
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001765 union {
1766 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
Pawel Osciakf8f39142010-07-29 14:44:25 -03001767 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001768 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
1769 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
1770 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
1771 __u8 raw_data[200]; /* user-defined */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 } fmt;
1773};
1774
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775/* Stream type-dependent parameters
1776 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001777struct v4l2_streamparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 enum v4l2_buf_type type;
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001779 union {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 struct v4l2_captureparm capture;
1781 struct v4l2_outputparm output;
1782 __u8 raw_data[200]; /* user-defined */
1783 } parm;
1784};
1785
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786/*
Sakari Ailusfda10212010-02-24 19:19:05 -03001787 * E V E N T S
1788 */
1789
Hans Verkuil1bcaf4b2010-03-27 14:09:52 -03001790#define V4L2_EVENT_ALL 0
1791#define V4L2_EVENT_VSYNC 1
1792#define V4L2_EVENT_EOS 2
1793#define V4L2_EVENT_PRIVATE_START 0x08000000
1794
1795/* Payload for V4L2_EVENT_VSYNC */
1796struct v4l2_event_vsync {
1797 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
1798 __u8 field;
1799} __attribute__ ((packed));
1800
Sakari Ailusfda10212010-02-24 19:19:05 -03001801struct v4l2_event {
1802 __u32 type;
1803 union {
Hans Verkuil1bcaf4b2010-03-27 14:09:52 -03001804 struct v4l2_event_vsync vsync;
Sakari Ailusfda10212010-02-24 19:19:05 -03001805 __u8 data[64];
1806 } u;
1807 __u32 pending;
1808 __u32 sequence;
1809 struct timespec timestamp;
1810 __u32 reserved[9];
1811};
1812
1813struct v4l2_event_subscription {
1814 __u32 type;
1815 __u32 reserved[7];
1816};
1817
Sakari Ailusfda10212010-02-24 19:19:05 -03001818/*
Trent Piepho52ebc762007-01-23 22:38:13 -03001819 * A D V A N C E D D E B U G G I N G
Hans Verkuilf3502b82007-02-23 21:16:01 -03001820 *
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001821 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
1822 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
Trent Piepho52ebc762007-01-23 22:38:13 -03001823 */
1824
1825/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001826
Hans Verkuilf3502b82007-02-23 21:16:01 -03001827#define V4L2_CHIP_MATCH_HOST 0 /* Match against chip ID on host (0 for the host) */
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001828#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
Hans Verkuilf3502b82007-02-23 21:16:01 -03001829#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Mauro Carvalho Chehab531c98e2008-12-22 13:18:27 -03001830#define V4L2_CHIP_MATCH_AC97 3 /* Match against anciliary AC97 chip */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001831
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001832struct v4l2_dbg_match {
1833 __u32 type; /* Match type */
1834 union { /* Match this chip, meaning determined by type */
1835 __u32 addr;
1836 char name[32];
1837 };
1838} __attribute__ ((packed));
1839
1840struct v4l2_dbg_register {
1841 struct v4l2_dbg_match match;
1842 __u32 size; /* register size in bytes */
Trent Piephoe7b58f52007-01-30 22:47:18 -03001843 __u64 reg;
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001844 __u64 val;
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001845} __attribute__ ((packed));
Trent Piepho52ebc762007-01-23 22:38:13 -03001846
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001847/* VIDIOC_DBG_G_CHIP_IDENT */
1848struct v4l2_dbg_chip_ident {
1849 struct v4l2_dbg_match match;
1850 __u32 ident; /* chip identifier as specified in <media/v4l2-chip-ident.h> */
1851 __u32 revision; /* chip revision, chip specific */
1852} __attribute__ ((packed));
1853
Trent Piepho52ebc762007-01-23 22:38:13 -03001854/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 * 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
1856 *
1857 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001858#define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
1859#define VIDIOC_RESERVED _IO('V', 1)
1860#define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
1861#define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
1862#define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
1863#define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
1864#define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
1865#define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
1866#define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
1867#define VIDIOC_OVERLAY _IOW('V', 14, int)
1868#define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
1869#define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
1870#define VIDIOC_STREAMON _IOW('V', 18, int)
1871#define VIDIOC_STREAMOFF _IOW('V', 19, int)
1872#define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
1873#define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
1874#define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
1875#define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
1876#define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
1877#define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
1878#define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
1879#define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
1880#define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
1881#define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
1882#define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
1883#define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
1884#define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
1885#define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
1886#define VIDIOC_G_INPUT _IOR('V', 38, int)
1887#define VIDIOC_S_INPUT _IOWR('V', 39, int)
1888#define VIDIOC_G_OUTPUT _IOR('V', 46, int)
1889#define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
1890#define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
1891#define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
1892#define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
1893#define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
1894#define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
1895#define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
1896#define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
1897#define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
1898#define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
1899#define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
1900#define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
1901#define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
1902#define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
1903#define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
1904#define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
1905#define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
1906#define VIDIOC_G_PRIORITY _IOR('V', 67, enum v4l2_priority)
1907#define VIDIOC_S_PRIORITY _IOW('V', 68, enum v4l2_priority)
1908#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
1909#define VIDIOC_LOG_STATUS _IO('V', 70)
1910#define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
1911#define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
1912#define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001913#if 1
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001914#define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
1915#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
1916#define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
1917#define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
1918#define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001919#endif
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001920
1921#if 1
1922/* Experimental, meant for debugging, testing and internal use.
1923 Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
1924 You must be root to use these ioctls. Never use these in applications! */
1925#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
1926#define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
1927
1928/* Experimental, meant for debugging, testing and internal use.
1929 Never use this ioctl in applications! */
1930#define VIDIOC_DBG_G_CHIP_IDENT _IOWR('V', 81, struct v4l2_dbg_chip_ident)
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001931#endif
1932
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001933#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001934#define VIDIOC_ENUM_DV_PRESETS _IOWR('V', 83, struct v4l2_dv_enum_preset)
1935#define VIDIOC_S_DV_PRESET _IOWR('V', 84, struct v4l2_dv_preset)
1936#define VIDIOC_G_DV_PRESET _IOWR('V', 85, struct v4l2_dv_preset)
1937#define VIDIOC_QUERY_DV_PRESET _IOR('V', 86, struct v4l2_dv_preset)
1938#define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
1939#define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
Sakari Ailusfda10212010-02-24 19:19:05 -03001940#define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
1941#define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
1942#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001943
Hans Verkuil92f45ba2008-12-21 10:35:25 -03001944/* Reminder: when adding new ioctls please add support for them to
1945 drivers/media/video/v4l2-compat-ioctl32.c as well! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1948
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949#endif /* __LINUX_VIDEODEV2_H */