blob: 93971bb294e05467bbc6673209de620fd3b4afff [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
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030058#ifdef __KERNEL__
Mauro Carvalho Chehab89a58c82006-06-17 07:57:03 -030059#include <linux/time.h> /* need struct timeval */
60#include <linux/compiler.h> /* need __user */
61#else
62#define __user
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030063#endif
David Mosberger-Tangc003d462006-05-26 10:28:13 -030064#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080066/*
67 * Common stuff for both V4L1 and V4L2
68 * Moved from videodev.h
69 */
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080070#define VIDEO_MAX_FRAME 32
71
Michael Schimekc12097f2005-11-08 21:38:24 -080072#define VID_TYPE_CAPTURE 1 /* Can capture */
73#define VID_TYPE_TUNER 2 /* Can tune */
74#define VID_TYPE_TELETEXT 4 /* Does teletext */
75#define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
76#define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
77#define VID_TYPE_CLIPPING 32 /* Can clip */
78#define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
79#define VID_TYPE_SCALES 128 /* Scalable */
80#define VID_TYPE_MONOCHROME 256 /* Monochrome only */
81#define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
82#define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
83#define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
84#define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
85#define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087/*
88 * M I S C E L L A N E O U S
89 */
90
91/* Four-character-code (FOURCC) */
92#define v4l2_fourcc(a,b,c,d)\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -080093 (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
95/*
96 * E N U M S
97 */
98enum v4l2_field {
Hans Verkuilb2787842007-04-27 12:31:02 -030099 V4L2_FIELD_ANY = 0, /* driver can choose from none,
100 top, bottom, interlaced
101 depending on whatever it thinks
102 is approximate ... */
103 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
104 V4L2_FIELD_TOP = 2, /* top field only */
105 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
106 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
107 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
108 buffer, top-bottom order */
109 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
110 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
111 separate buffers */
112 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
113 first and the top field is
114 transmitted first */
115 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
116 first and the bottom field is
117 transmitted first */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118};
119#define V4L2_FIELD_HAS_TOP(field) \
120 ((field) == V4L2_FIELD_TOP ||\
121 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300122 (field) == V4L2_FIELD_INTERLACED_TB ||\
123 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 (field) == V4L2_FIELD_SEQ_TB ||\
125 (field) == V4L2_FIELD_SEQ_BT)
126#define V4L2_FIELD_HAS_BOTTOM(field) \
127 ((field) == V4L2_FIELD_BOTTOM ||\
128 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300129 (field) == V4L2_FIELD_INTERLACED_TB ||\
130 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 (field) == V4L2_FIELD_SEQ_TB ||\
132 (field) == V4L2_FIELD_SEQ_BT)
133#define V4L2_FIELD_HAS_BOTH(field) \
134 ((field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300135 (field) == V4L2_FIELD_INTERLACED_TB ||\
136 (field) == V4L2_FIELD_INTERLACED_BT ||\
137 (field) == V4L2_FIELD_SEQ_TB ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 (field) == V4L2_FIELD_SEQ_BT)
139
140enum v4l2_buf_type {
Hans Verkuilb2787842007-04-27 12:31:02 -0300141 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
142 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
143 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
144 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
145 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
146 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
147 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
148#if 1
149 /* Experimental */
150 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
151#endif
152 V4L2_BUF_TYPE_PRIVATE = 0x80,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153};
154
155enum v4l2_ctrl_type {
156 V4L2_CTRL_TYPE_INTEGER = 1,
157 V4L2_CTRL_TYPE_BOOLEAN = 2,
158 V4L2_CTRL_TYPE_MENU = 3,
159 V4L2_CTRL_TYPE_BUTTON = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -0300160 V4L2_CTRL_TYPE_INTEGER64 = 5,
161 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162};
163
164enum v4l2_tuner_type {
165 V4L2_TUNER_RADIO = 1,
166 V4L2_TUNER_ANALOG_TV = 2,
167 V4L2_TUNER_DIGITAL_TV = 3,
168};
169
170enum v4l2_memory {
171 V4L2_MEMORY_MMAP = 1,
172 V4L2_MEMORY_USERPTR = 2,
173 V4L2_MEMORY_OVERLAY = 3,
174};
175
176/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
177enum v4l2_colorspace {
178 /* ITU-R 601 -- broadcast NTSC/PAL */
179 V4L2_COLORSPACE_SMPTE170M = 1,
180
181 /* 1125-Line (US) HDTV */
182 V4L2_COLORSPACE_SMPTE240M = 2,
183
184 /* HD and modern captures. */
185 V4L2_COLORSPACE_REC709 = 3,
186
187 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
188 V4L2_COLORSPACE_BT878 = 4,
189
190 /* These should be useful. Assume 601 extents. */
191 V4L2_COLORSPACE_470_SYSTEM_M = 5,
192 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
193
194 /* I know there will be cameras that send this. So, this is
195 * unspecified chromaticities and full 0-255 on each of the
196 * Y'CbCr components
197 */
198 V4L2_COLORSPACE_JPEG = 7,
199
200 /* For RGB colourspaces, this is probably a good start. */
201 V4L2_COLORSPACE_SRGB = 8,
202};
203
204enum v4l2_priority {
205 V4L2_PRIORITY_UNSET = 0, /* not initialized */
206 V4L2_PRIORITY_BACKGROUND = 1,
207 V4L2_PRIORITY_INTERACTIVE = 2,
208 V4L2_PRIORITY_RECORD = 3,
209 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
210};
211
212struct v4l2_rect {
213 __s32 left;
214 __s32 top;
215 __s32 width;
216 __s32 height;
217};
218
219struct v4l2_fract {
220 __u32 numerator;
221 __u32 denominator;
222};
223
224/*
225 * D R I V E R C A P A B I L I T I E S
226 */
227struct v4l2_capability
228{
229 __u8 driver[16]; /* i.e. "bttv" */
230 __u8 card[32]; /* i.e. "Hauppauge WinTV" */
231 __u8 bus_info[32]; /* "PCI:" + pci_name(pci_dev) */
232 __u32 version; /* should use KERNEL_VERSION() */
233 __u32 capabilities; /* Device capabilities */
234 __u32 reserved[4];
235};
236
237/* Values for 'capabilities' field */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800238#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
239#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
240#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
241#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
242#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700243#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
244#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800245#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
Hans Verkuil1f137602007-05-29 08:18:37 -0300246#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800248#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
249#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
250#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700252#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
253#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
254#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256/*
257 * V I D E O I M A G E F O R M A T
258 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259struct v4l2_pix_format
260{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800261 __u32 width;
262 __u32 height;
263 __u32 pixelformat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 enum v4l2_field field;
265 __u32 bytesperline; /* for padding, zero if unused */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800266 __u32 sizeimage;
267 enum v4l2_colorspace colorspace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 __u32 priv; /* private data, depends on pixelformat */
269};
270
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300271/* Pixel format FOURCC depth Description */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R','G','B','1') /* 8 RGB-3-3-2 */
273#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R','G','B','O') /* 16 RGB-5-5-5 */
274#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R','G','B','P') /* 16 RGB-5-6-5 */
275#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16 RGB-5-5-5 BE */
276#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16 RGB-5-6-5 BE */
277#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B','G','R','3') /* 24 BGR-8-8-8 */
278#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R','G','B','3') /* 24 RGB-8-8-8 */
279#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B','G','R','4') /* 32 BGR-8-8-8-8 */
280#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R','G','B','4') /* 32 RGB-8-8-8-8 */
281#define V4L2_PIX_FMT_GREY v4l2_fourcc('G','R','E','Y') /* 8 Greyscale */
282#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y','V','U','9') /* 9 YVU 4:1:0 */
283#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y','V','1','2') /* 12 YVU 4:2:0 */
284#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y','U','Y','V') /* 16 YUV 4:2:2 */
285#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U','Y','V','Y') /* 16 YUV 4:2:2 */
286#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16 YVU422 planar */
287#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16 YVU411 planar */
288#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y','4','1','P') /* 12 YUV 4:1:1 */
289
290/* two planes -- one Y, one Cr + Cb interleaved */
291#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N','V','1','2') /* 12 Y/CbCr 4:2:0 */
292#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N','V','2','1') /* 12 Y/CrCb 4:2:0 */
293
294/* The following formats are not defined in the V4L2 specification */
295#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y','U','V','9') /* 9 YUV 4:1:0 */
296#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y','U','1','2') /* 12 YUV 4:2:0 */
297#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y','Y','U','V') /* 16 YUV 4:2:2 */
298#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H','I','2','4') /* 8 8-bit color */
Hans Verkuil50119152006-10-13 05:12:42 -0300299#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H','M','1','2') /* 8 YUV 4:2:0 16x16 macroblocks */
Jonathan Corbet9c4dfad2006-11-04 09:22:27 -0300300#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R','4','4','4') /* 16 xxxxrrrr ggggbbbb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302/* see http://www.siliconimaging.com/RGB%20Bayer.htm */
303#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B','A','8','1') /* 8 BGBG.. GRGR.. */
304
305/* compressed formats */
306#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M','J','P','G') /* Motion-JPEG */
307#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J','P','E','G') /* JFIF JPEG */
308#define V4L2_PIX_FMT_DV v4l2_fourcc('d','v','s','d') /* 1394 */
Hans Verkuil4f341712006-06-18 13:27:19 -0300309#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M','P','E','G') /* MPEG-1/2/4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311/* Vendor-specific formats */
312#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W','N','V','A') /* Winnov hw compress */
313#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S','9','1','0') /* SN9C10x compression */
Mauro Carvalho Chehab115d6f32005-06-28 20:45:27 -0700314#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') /* pwc older webcam */
315#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') /* pwc newer webcam */
Mauro Carvalho Chehab749eef82006-02-27 00:07:40 -0300316#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E','6','2','5') /* ET61X251 compression */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318/*
319 * F O R M A T E N U M E R A T I O N
320 */
321struct v4l2_fmtdesc
322{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800323 __u32 index; /* Format number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 enum v4l2_buf_type type; /* buffer type */
325 __u32 flags;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800326 __u8 description[32]; /* Description string */
327 __u32 pixelformat; /* Format fourcc */
328 __u32 reserved[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329};
330
331#define V4L2_FMT_FLAG_COMPRESSED 0x0001
332
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300333#if 1
334 /* Experimental Frame Size and frame rate enumeration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335/*
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300336 * F R A M E S I Z E E N U M E R A T I O N
337 */
338enum v4l2_frmsizetypes
339{
340 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
341 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
342 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
343};
344
345struct v4l2_frmsize_discrete
346{
347 __u32 width; /* Frame width [pixel] */
348 __u32 height; /* Frame height [pixel] */
349};
350
351struct v4l2_frmsize_stepwise
352{
353 __u32 min_width; /* Minimum frame width [pixel] */
354 __u32 max_width; /* Maximum frame width [pixel] */
355 __u32 step_width; /* Frame width step size [pixel] */
356 __u32 min_height; /* Minimum frame height [pixel] */
357 __u32 max_height; /* Maximum frame height [pixel] */
358 __u32 step_height; /* Frame height step size [pixel] */
359};
360
361struct v4l2_frmsizeenum
362{
363 __u32 index; /* Frame size number */
364 __u32 pixel_format; /* Pixel format */
365 __u32 type; /* Frame size type the device supports. */
366
367 union { /* Frame size */
368 struct v4l2_frmsize_discrete discrete;
369 struct v4l2_frmsize_stepwise stepwise;
370 };
371
372 __u32 reserved[2]; /* Reserved space for future use */
373};
374
375/*
376 * F R A M E R A T E E N U M E R A T I O N
377 */
378enum v4l2_frmivaltypes
379{
380 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
381 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
382 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
383};
384
385struct v4l2_frmival_stepwise
386{
387 struct v4l2_fract min; /* Minimum frame interval [s] */
388 struct v4l2_fract max; /* Maximum frame interval [s] */
389 struct v4l2_fract step; /* Frame interval step size [s] */
390};
391
392struct v4l2_frmivalenum
393{
394 __u32 index; /* Frame format index */
395 __u32 pixel_format; /* Pixel format */
396 __u32 width; /* Frame width */
397 __u32 height; /* Frame height */
398 __u32 type; /* Frame interval type the device supports. */
399
400 union { /* Frame interval */
401 struct v4l2_fract discrete;
402 struct v4l2_frmival_stepwise stepwise;
403 };
404
405 __u32 reserved[2]; /* Reserved space for future use */
406};
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300407#endif
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300408
409/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 * T I M E C O D E
411 */
412struct v4l2_timecode
413{
414 __u32 type;
415 __u32 flags;
416 __u8 frames;
417 __u8 seconds;
418 __u8 minutes;
419 __u8 hours;
420 __u8 userbits[4];
421};
422
423/* Type */
424#define V4L2_TC_TYPE_24FPS 1
425#define V4L2_TC_TYPE_25FPS 2
426#define V4L2_TC_TYPE_30FPS 3
427#define V4L2_TC_TYPE_50FPS 4
428#define V4L2_TC_TYPE_60FPS 5
429
430/* Flags */
431#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
432#define V4L2_TC_FLAG_COLORFRAME 0x0002
433#define V4L2_TC_USERBITS_field 0x000C
434#define V4L2_TC_USERBITS_USERDEFINED 0x0000
435#define V4L2_TC_USERBITS_8BITCHARS 0x0008
436/* The above is based on SMPTE timecodes */
437
Hans Verkuilf81cf752006-06-18 16:54:20 -0300438#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439/*
440 * M P E G C O M P R E S S I O N P A R A M E T E R S
441 *
Hans Verkuilf81cf752006-06-18 16:54:20 -0300442 * ### WARNING: This experimental MPEG compression API is obsolete.
443 * ### It is replaced by the MPEG controls API.
444 * ### This old API will disappear in the near future!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 *
446 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447enum v4l2_bitrate_mode {
448 V4L2_BITRATE_NONE = 0, /* not specified */
449 V4L2_BITRATE_CBR, /* constant bitrate */
450 V4L2_BITRATE_VBR, /* variable bitrate */
451};
452struct v4l2_bitrate {
453 /* rates are specified in kbit/sec */
454 enum v4l2_bitrate_mode mode;
455 __u32 min;
456 __u32 target; /* use this one for CBR */
457 __u32 max;
458};
459
460enum v4l2_mpeg_streamtype {
461 V4L2_MPEG_SS_1, /* MPEG-1 system stream */
462 V4L2_MPEG_PS_2, /* MPEG-2 program stream */
463 V4L2_MPEG_TS_2, /* MPEG-2 transport stream */
464 V4L2_MPEG_PS_DVD, /* MPEG-2 program stream with DVD header fixups */
465};
466enum v4l2_mpeg_audiotype {
467 V4L2_MPEG_AU_2_I, /* MPEG-2 layer 1 */
468 V4L2_MPEG_AU_2_II, /* MPEG-2 layer 2 */
469 V4L2_MPEG_AU_2_III, /* MPEG-2 layer 3 */
470 V4L2_MPEG_AC3, /* AC3 */
471 V4L2_MPEG_LPCM, /* LPCM */
472};
473enum v4l2_mpeg_videotype {
474 V4L2_MPEG_VI_1, /* MPEG-1 */
475 V4L2_MPEG_VI_2, /* MPEG-2 */
476};
477enum v4l2_mpeg_aspectratio {
478 V4L2_MPEG_ASPECT_SQUARE = 1, /* square pixel */
479 V4L2_MPEG_ASPECT_4_3 = 2, /* 4 : 3 */
480 V4L2_MPEG_ASPECT_16_9 = 3, /* 16 : 9 */
481 V4L2_MPEG_ASPECT_1_221 = 4, /* 1 : 2,21 */
482};
483
484struct v4l2_mpeg_compression {
485 /* general */
486 enum v4l2_mpeg_streamtype st_type;
487 struct v4l2_bitrate st_bitrate;
488
489 /* transport streams */
490 __u16 ts_pid_pmt;
491 __u16 ts_pid_audio;
492 __u16 ts_pid_video;
493 __u16 ts_pid_pcr;
494
495 /* program stream */
496 __u16 ps_size;
497 __u16 reserved_1; /* align */
498
499 /* audio */
500 enum v4l2_mpeg_audiotype au_type;
501 struct v4l2_bitrate au_bitrate;
502 __u32 au_sample_rate;
503 __u8 au_pesid;
504 __u8 reserved_2[3]; /* align */
505
506 /* video */
507 enum v4l2_mpeg_videotype vi_type;
508 enum v4l2_mpeg_aspectratio vi_aspect_ratio;
509 struct v4l2_bitrate vi_bitrate;
510 __u32 vi_frame_rate;
511 __u16 vi_frames_per_gop;
512 __u16 vi_bframes_count;
513 __u8 vi_pesid;
514 __u8 reserved_3[3]; /* align */
515
516 /* misc flags */
517 __u32 closed_gops:1;
518 __u32 pulldown:1;
519 __u32 reserved_4:30; /* align */
520
521 /* I don't expect the above being perfect yet ;) */
522 __u32 reserved_5[8];
523};
Hans Verkuilf81cf752006-06-18 16:54:20 -0300524#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526struct v4l2_jpegcompression
527{
528 int quality;
529
530 int APPn; /* Number of APP segment to be written,
531 * must be 0..15 */
532 int APP_len; /* Length of data in JPEG APPn segment */
533 char APP_data[60]; /* Data in the JPEG APPn segment. */
534
535 int COM_len; /* Length of data in JPEG COM segment */
536 char COM_data[60]; /* Data in JPEG COM segment */
537
538 __u32 jpeg_markers; /* Which markers should go into the JPEG
539 * output. Unless you exactly know what
540 * you do, leave them untouched.
541 * Inluding less markers will make the
542 * resulting code smaller, but there will
543 * be fewer aplications which can read it.
544 * The presence of the APP and COM marker
545 * is influenced by APP_len and COM_len
546 * ONLY, not by this property! */
547
548#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
549#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
550#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
551#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
552#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -0800553 * allways use APP0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554};
555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556/*
557 * M E M O R Y - M A P P I N G B U F F E R S
558 */
559struct v4l2_requestbuffers
560{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800561 __u32 count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 enum v4l2_buf_type type;
563 enum v4l2_memory memory;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800564 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565};
566
567struct v4l2_buffer
568{
569 __u32 index;
570 enum v4l2_buf_type type;
571 __u32 bytesused;
572 __u32 flags;
573 enum v4l2_field field;
574 struct timeval timestamp;
575 struct v4l2_timecode timecode;
576 __u32 sequence;
577
578 /* memory location */
579 enum v4l2_memory memory;
580 union {
581 __u32 offset;
582 unsigned long userptr;
583 } m;
584 __u32 length;
585 __u32 input;
586 __u32 reserved;
587};
588
589/* Flags for 'flags' field */
590#define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
591#define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
592#define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
593#define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
594#define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
595#define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
596#define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
597#define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
598
599/*
600 * O V E R L A Y P R E V I E W
601 */
602struct v4l2_framebuffer
603{
604 __u32 capability;
605 __u32 flags;
606/* FIXME: in theory we should pass something like PCI device + memory
607 * region + offset instead of some physical address */
608 void* base;
609 struct v4l2_pix_format fmt;
610};
611/* Flags for the 'capability' field. Read only */
612#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
613#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
614#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
615#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
Hans Verkuilb2787842007-04-27 12:31:02 -0300616#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
617#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618/* Flags for the 'flags' field. */
619#define V4L2_FBUF_FLAG_PRIMARY 0x0001
620#define V4L2_FBUF_FLAG_OVERLAY 0x0002
621#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
Hans Verkuilb2787842007-04-27 12:31:02 -0300622#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
623#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
625struct v4l2_clip
626{
627 struct v4l2_rect c;
Al Viro5b1a43d2006-02-01 05:24:20 -0500628 struct v4l2_clip __user *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629};
630
631struct v4l2_window
632{
633 struct v4l2_rect w;
634 enum v4l2_field field;
635 __u32 chromakey;
636 struct v4l2_clip __user *clips;
637 __u32 clipcount;
638 void __user *bitmap;
Hans Verkuilb2787842007-04-27 12:31:02 -0300639 __u8 global_alpha;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640};
641
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642/*
643 * C A P T U R E P A R A M E T E R S
644 */
645struct v4l2_captureparm
646{
647 __u32 capability; /* Supported modes */
648 __u32 capturemode; /* Current mode */
649 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
650 __u32 extendedmode; /* Driver-specific extensions */
651 __u32 readbuffers; /* # of buffers for read */
652 __u32 reserved[4];
653};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300654
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655/* Flags for 'capability' and 'capturemode' fields */
656#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
657#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
658
659struct v4l2_outputparm
660{
661 __u32 capability; /* Supported modes */
662 __u32 outputmode; /* Current mode */
663 struct v4l2_fract timeperframe; /* Time per frame in seconds */
664 __u32 extendedmode; /* Driver-specific extensions */
665 __u32 writebuffers; /* # of buffers for write */
666 __u32 reserved[4];
667};
668
669/*
670 * I N P U T I M A G E C R O P P I N G
671 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672struct v4l2_cropcap {
673 enum v4l2_buf_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800674 struct v4l2_rect bounds;
675 struct v4l2_rect defrect;
676 struct v4l2_fract pixelaspect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677};
678
679struct v4l2_crop {
680 enum v4l2_buf_type type;
681 struct v4l2_rect c;
682};
683
684/*
685 * A N A L O G V I D E O S T A N D A R D
686 */
687
688typedef __u64 v4l2_std_id;
689
690/* one bit for each */
691#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
692#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
693#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
694#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
695#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
696#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
697#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
698#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
699
700#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
701#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
702#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
703#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
704
705#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
706#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800707#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
Hans Verkuild97a11e2006-02-07 06:48:40 -0200708#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
711#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
712#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
713#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
714#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
715#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
716#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
Mauro Carvalho Chehab800d3c62005-11-13 16:07:48 -0800717#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719/* ATSC/HDTV */
720#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
721#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
722
Mauro Carvalho Chehab412297d2007-01-07 08:51:05 -0300723/* FIXME:
724 Although std_id is 64 bits, there is an issue on PPC32 architecture that
725 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
726 this value to 32 bits.
727 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
728 it should work fine. However, if needed to add more than two standards,
729 v4l2-common.c should be fixed.
730 */
731
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200732/* some merged standards */
733#define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
734#define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
735#define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
736#define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738/* some common needed stuff */
739#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
740 V4L2_STD_PAL_B1 |\
741 V4L2_STD_PAL_G)
742#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
743 V4L2_STD_PAL_D1 |\
744 V4L2_STD_PAL_K)
745#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
746 V4L2_STD_PAL_DK |\
747 V4L2_STD_PAL_H |\
748 V4L2_STD_PAL_I)
749#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
Hans Verkuild97a11e2006-02-07 06:48:40 -0200750 V4L2_STD_NTSC_M_JP |\
751 V4L2_STD_NTSC_M_KR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
753 V4L2_STD_SECAM_K |\
754 V4L2_STD_SECAM_K1)
755#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
756 V4L2_STD_SECAM_G |\
757 V4L2_STD_SECAM_H |\
758 V4L2_STD_SECAM_DK |\
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200759 V4L2_STD_SECAM_L |\
760 V4L2_STD_SECAM_LC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
762#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
763 V4L2_STD_PAL_60 |\
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800764 V4L2_STD_NTSC |\
765 V4L2_STD_NTSC_443)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766#define V4L2_STD_625_50 (V4L2_STD_PAL |\
767 V4L2_STD_PAL_N |\
768 V4L2_STD_PAL_Nc |\
769 V4L2_STD_SECAM)
770#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800771 V4L2_STD_ATSC_16_VSB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
773#define V4L2_STD_UNKNOWN 0
774#define V4L2_STD_ALL (V4L2_STD_525_60 |\
775 V4L2_STD_625_50)
776
777struct v4l2_standard
778{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800779 __u32 index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 v4l2_std_id id;
781 __u8 name[24];
782 struct v4l2_fract frameperiod; /* Frames, not fields */
783 __u32 framelines;
784 __u32 reserved[4];
785};
786
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787/*
788 * V I D E O I N P U T S
789 */
790struct v4l2_input
791{
792 __u32 index; /* Which input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800793 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 __u32 type; /* Type of input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800795 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 __u32 tuner; /* Associated tuner */
797 v4l2_std_id std;
798 __u32 status;
799 __u32 reserved[4];
800};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802/* Values for the 'type' field */
803#define V4L2_INPUT_TYPE_TUNER 1
804#define V4L2_INPUT_TYPE_CAMERA 2
805
806/* field 'status' - general */
807#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
808#define V4L2_IN_ST_NO_SIGNAL 0x00000002
809#define V4L2_IN_ST_NO_COLOR 0x00000004
810
811/* field 'status' - analog */
812#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
813#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
814
815/* field 'status' - digital */
816#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
817#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
818#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
819
820/* field 'status' - VCR and set-top box */
821#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
822#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
823#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
824
825/*
826 * V I D E O O U T P U T S
827 */
828struct v4l2_output
829{
830 __u32 index; /* Which output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800831 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 __u32 type; /* Type of output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800833 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 __u32 modulator; /* Associated modulator */
835 v4l2_std_id std;
836 __u32 reserved[4];
837};
838/* Values for the 'type' field */
839#define V4L2_OUTPUT_TYPE_MODULATOR 1
840#define V4L2_OUTPUT_TYPE_ANALOG 2
841#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
842
843/*
844 * C O N T R O L S
845 */
846struct v4l2_control
847{
848 __u32 id;
849 __s32 value;
850};
851
Hans Verkuil4f341712006-06-18 13:27:19 -0300852struct v4l2_ext_control
853{
854 __u32 id;
855 __u32 reserved2[2];
856 union {
857 __s32 value;
858 __s64 value64;
859 void *reserved;
860 };
Mauro Carvalho Chehabf251d232006-07-22 08:20:07 -0300861} __attribute__ ((packed));
Hans Verkuil4f341712006-06-18 13:27:19 -0300862
863struct v4l2_ext_controls
864{
865 __u32 ctrl_class;
866 __u32 count;
867 __u32 error_idx;
868 __u32 reserved[2];
869 struct v4l2_ext_control *controls;
870};
871
872/* Values for ctrl_class field */
873#define V4L2_CTRL_CLASS_USER 0x00980000 /* Old-style 'user' controls */
874#define V4L2_CTRL_CLASS_MPEG 0x00990000 /* MPEG-compression controls */
875
876#define V4L2_CTRL_ID_MASK (0x0fffffff)
877#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
878#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
881struct v4l2_queryctrl
882{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800883 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 enum v4l2_ctrl_type type;
885 __u8 name[32]; /* Whatever */
886 __s32 minimum; /* Note signedness */
887 __s32 maximum;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800888 __s32 step;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 __s32 default_value;
890 __u32 flags;
891 __u32 reserved[2];
892};
893
894/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
895struct v4l2_querymenu
896{
897 __u32 id;
898 __u32 index;
899 __u8 name[32]; /* Whatever */
900 __u32 reserved;
901};
902
903/* Control flags */
904#define V4L2_CTRL_FLAG_DISABLED 0x0001
905#define V4L2_CTRL_FLAG_GRABBED 0x0002
Hans Verkuil4f341712006-06-18 13:27:19 -0300906#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
907#define V4L2_CTRL_FLAG_UPDATE 0x0008
908#define V4L2_CTRL_FLAG_INACTIVE 0x0010
909#define V4L2_CTRL_FLAG_SLIDER 0x0020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
Hans Verkuil4f341712006-06-18 13:27:19 -0300911/* Query flag, to be ORed with the control ID */
912#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
913
914/* User-class control IDs defined by V4L2 */
915#define V4L2_CID_BASE (V4L2_CTRL_CLASS_USER | 0x900)
916#define V4L2_CID_USER_BASE V4L2_CID_BASE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917/* IDs reserved for driver specific controls */
918#define V4L2_CID_PRIVATE_BASE 0x08000000
919
Hans Verkuil4f341712006-06-18 13:27:19 -0300920#define V4L2_CID_USER_CLASS (V4L2_CTRL_CLASS_USER | 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921#define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
922#define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
923#define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
924#define V4L2_CID_HUE (V4L2_CID_BASE+3)
925#define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
926#define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
927#define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
928#define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
929#define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
930#define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
931#define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11)
932#define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
933#define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
934#define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
935#define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
936#define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
937#define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* ? Not sure */
938#define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
939#define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
940#define V4L2_CID_GAIN (V4L2_CID_BASE+19)
941#define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
942#define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
943#define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
944#define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
945#define V4L2_CID_LASTP1 (V4L2_CID_BASE+24) /* last CID + 1 */
946
Hans Verkuil4f341712006-06-18 13:27:19 -0300947/* MPEG-class control IDs defined by V4L2 */
948#define V4L2_CID_MPEG_BASE (V4L2_CTRL_CLASS_MPEG | 0x900)
949#define V4L2_CID_MPEG_CLASS (V4L2_CTRL_CLASS_MPEG | 1)
950
951/* MPEG streams */
952#define V4L2_CID_MPEG_STREAM_TYPE (V4L2_CID_MPEG_BASE+0)
953enum v4l2_mpeg_stream_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300954 V4L2_MPEG_STREAM_TYPE_MPEG2_PS = 0, /* MPEG-2 program stream */
955 V4L2_MPEG_STREAM_TYPE_MPEG2_TS = 1, /* MPEG-2 transport stream */
956 V4L2_MPEG_STREAM_TYPE_MPEG1_SS = 2, /* MPEG-1 system stream */
957 V4L2_MPEG_STREAM_TYPE_MPEG2_DVD = 3, /* MPEG-2 DVD-compatible stream */
958 V4L2_MPEG_STREAM_TYPE_MPEG1_VCD = 4, /* MPEG-1 VCD-compatible stream */
959 V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD = 5, /* MPEG-2 SVCD-compatible stream */
Hans Verkuil4f341712006-06-18 13:27:19 -0300960};
961#define V4L2_CID_MPEG_STREAM_PID_PMT (V4L2_CID_MPEG_BASE+1)
962#define V4L2_CID_MPEG_STREAM_PID_AUDIO (V4L2_CID_MPEG_BASE+2)
963#define V4L2_CID_MPEG_STREAM_PID_VIDEO (V4L2_CID_MPEG_BASE+3)
964#define V4L2_CID_MPEG_STREAM_PID_PCR (V4L2_CID_MPEG_BASE+4)
965#define V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (V4L2_CID_MPEG_BASE+5)
966#define V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (V4L2_CID_MPEG_BASE+6)
Hans Verkuil8cbde942006-06-24 14:36:02 -0300967#define V4L2_CID_MPEG_STREAM_VBI_FMT (V4L2_CID_MPEG_BASE+7)
968enum v4l2_mpeg_stream_vbi_fmt {
969 V4L2_MPEG_STREAM_VBI_FMT_NONE = 0, /* No VBI in the MPEG stream */
970 V4L2_MPEG_STREAM_VBI_FMT_IVTV = 1, /* VBI in private packets, IVTV format */
971};
Hans Verkuil4f341712006-06-18 13:27:19 -0300972
973/* MPEG audio */
974#define V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ (V4L2_CID_MPEG_BASE+100)
975enum v4l2_mpeg_audio_sampling_freq {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300976 V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100 = 0,
977 V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000 = 1,
978 V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -0300979};
980#define V4L2_CID_MPEG_AUDIO_ENCODING (V4L2_CID_MPEG_BASE+101)
981enum v4l2_mpeg_audio_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300982 V4L2_MPEG_AUDIO_ENCODING_LAYER_1 = 0,
983 V4L2_MPEG_AUDIO_ENCODING_LAYER_2 = 1,
984 V4L2_MPEG_AUDIO_ENCODING_LAYER_3 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -0300985};
986#define V4L2_CID_MPEG_AUDIO_L1_BITRATE (V4L2_CID_MPEG_BASE+102)
987enum v4l2_mpeg_audio_l1_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300988 V4L2_MPEG_AUDIO_L1_BITRATE_32K = 0,
989 V4L2_MPEG_AUDIO_L1_BITRATE_64K = 1,
990 V4L2_MPEG_AUDIO_L1_BITRATE_96K = 2,
991 V4L2_MPEG_AUDIO_L1_BITRATE_128K = 3,
992 V4L2_MPEG_AUDIO_L1_BITRATE_160K = 4,
993 V4L2_MPEG_AUDIO_L1_BITRATE_192K = 5,
994 V4L2_MPEG_AUDIO_L1_BITRATE_224K = 6,
995 V4L2_MPEG_AUDIO_L1_BITRATE_256K = 7,
996 V4L2_MPEG_AUDIO_L1_BITRATE_288K = 8,
997 V4L2_MPEG_AUDIO_L1_BITRATE_320K = 9,
998 V4L2_MPEG_AUDIO_L1_BITRATE_352K = 10,
999 V4L2_MPEG_AUDIO_L1_BITRATE_384K = 11,
1000 V4L2_MPEG_AUDIO_L1_BITRATE_416K = 12,
1001 V4L2_MPEG_AUDIO_L1_BITRATE_448K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001002};
1003#define V4L2_CID_MPEG_AUDIO_L2_BITRATE (V4L2_CID_MPEG_BASE+103)
1004enum v4l2_mpeg_audio_l2_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001005 V4L2_MPEG_AUDIO_L2_BITRATE_32K = 0,
1006 V4L2_MPEG_AUDIO_L2_BITRATE_48K = 1,
1007 V4L2_MPEG_AUDIO_L2_BITRATE_56K = 2,
1008 V4L2_MPEG_AUDIO_L2_BITRATE_64K = 3,
1009 V4L2_MPEG_AUDIO_L2_BITRATE_80K = 4,
1010 V4L2_MPEG_AUDIO_L2_BITRATE_96K = 5,
1011 V4L2_MPEG_AUDIO_L2_BITRATE_112K = 6,
1012 V4L2_MPEG_AUDIO_L2_BITRATE_128K = 7,
1013 V4L2_MPEG_AUDIO_L2_BITRATE_160K = 8,
1014 V4L2_MPEG_AUDIO_L2_BITRATE_192K = 9,
1015 V4L2_MPEG_AUDIO_L2_BITRATE_224K = 10,
1016 V4L2_MPEG_AUDIO_L2_BITRATE_256K = 11,
1017 V4L2_MPEG_AUDIO_L2_BITRATE_320K = 12,
1018 V4L2_MPEG_AUDIO_L2_BITRATE_384K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001019};
1020#define V4L2_CID_MPEG_AUDIO_L3_BITRATE (V4L2_CID_MPEG_BASE+104)
1021enum v4l2_mpeg_audio_l3_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001022 V4L2_MPEG_AUDIO_L3_BITRATE_32K = 0,
1023 V4L2_MPEG_AUDIO_L3_BITRATE_40K = 1,
1024 V4L2_MPEG_AUDIO_L3_BITRATE_48K = 2,
1025 V4L2_MPEG_AUDIO_L3_BITRATE_56K = 3,
1026 V4L2_MPEG_AUDIO_L3_BITRATE_64K = 4,
1027 V4L2_MPEG_AUDIO_L3_BITRATE_80K = 5,
1028 V4L2_MPEG_AUDIO_L3_BITRATE_96K = 6,
1029 V4L2_MPEG_AUDIO_L3_BITRATE_112K = 7,
1030 V4L2_MPEG_AUDIO_L3_BITRATE_128K = 8,
1031 V4L2_MPEG_AUDIO_L3_BITRATE_160K = 9,
1032 V4L2_MPEG_AUDIO_L3_BITRATE_192K = 10,
1033 V4L2_MPEG_AUDIO_L3_BITRATE_224K = 11,
1034 V4L2_MPEG_AUDIO_L3_BITRATE_256K = 12,
1035 V4L2_MPEG_AUDIO_L3_BITRATE_320K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001036};
1037#define V4L2_CID_MPEG_AUDIO_MODE (V4L2_CID_MPEG_BASE+105)
1038enum v4l2_mpeg_audio_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001039 V4L2_MPEG_AUDIO_MODE_STEREO = 0,
1040 V4L2_MPEG_AUDIO_MODE_JOINT_STEREO = 1,
1041 V4L2_MPEG_AUDIO_MODE_DUAL = 2,
1042 V4L2_MPEG_AUDIO_MODE_MONO = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001043};
1044#define V4L2_CID_MPEG_AUDIO_MODE_EXTENSION (V4L2_CID_MPEG_BASE+106)
1045enum v4l2_mpeg_audio_mode_extension {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001046 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4 = 0,
1047 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8 = 1,
1048 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12 = 2,
1049 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001050};
1051#define V4L2_CID_MPEG_AUDIO_EMPHASIS (V4L2_CID_MPEG_BASE+107)
1052enum v4l2_mpeg_audio_emphasis {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001053 V4L2_MPEG_AUDIO_EMPHASIS_NONE = 0,
1054 V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS = 1,
1055 V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001056};
1057#define V4L2_CID_MPEG_AUDIO_CRC (V4L2_CID_MPEG_BASE+108)
1058enum v4l2_mpeg_audio_crc {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001059 V4L2_MPEG_AUDIO_CRC_NONE = 0,
1060 V4L2_MPEG_AUDIO_CRC_CRC16 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001061};
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001062#define V4L2_CID_MPEG_AUDIO_MUTE (V4L2_CID_MPEG_BASE+109)
Hans Verkuil4f341712006-06-18 13:27:19 -03001063
1064/* MPEG video */
1065#define V4L2_CID_MPEG_VIDEO_ENCODING (V4L2_CID_MPEG_BASE+200)
1066enum v4l2_mpeg_video_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001067 V4L2_MPEG_VIDEO_ENCODING_MPEG_1 = 0,
1068 V4L2_MPEG_VIDEO_ENCODING_MPEG_2 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001069};
1070#define V4L2_CID_MPEG_VIDEO_ASPECT (V4L2_CID_MPEG_BASE+201)
1071enum v4l2_mpeg_video_aspect {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001072 V4L2_MPEG_VIDEO_ASPECT_1x1 = 0,
1073 V4L2_MPEG_VIDEO_ASPECT_4x3 = 1,
1074 V4L2_MPEG_VIDEO_ASPECT_16x9 = 2,
1075 V4L2_MPEG_VIDEO_ASPECT_221x100 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001076};
1077#define V4L2_CID_MPEG_VIDEO_B_FRAMES (V4L2_CID_MPEG_BASE+202)
1078#define V4L2_CID_MPEG_VIDEO_GOP_SIZE (V4L2_CID_MPEG_BASE+203)
1079#define V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (V4L2_CID_MPEG_BASE+204)
1080#define V4L2_CID_MPEG_VIDEO_PULLDOWN (V4L2_CID_MPEG_BASE+205)
1081#define V4L2_CID_MPEG_VIDEO_BITRATE_MODE (V4L2_CID_MPEG_BASE+206)
1082enum v4l2_mpeg_video_bitrate_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001083 V4L2_MPEG_VIDEO_BITRATE_MODE_VBR = 0,
1084 V4L2_MPEG_VIDEO_BITRATE_MODE_CBR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001085};
1086#define V4L2_CID_MPEG_VIDEO_BITRATE (V4L2_CID_MPEG_BASE+207)
1087#define V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (V4L2_CID_MPEG_BASE+208)
1088#define V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (V4L2_CID_MPEG_BASE+209)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001089#define V4L2_CID_MPEG_VIDEO_MUTE (V4L2_CID_MPEG_BASE+210)
1090#define V4L2_CID_MPEG_VIDEO_MUTE_YUV (V4L2_CID_MPEG_BASE+211)
Hans Verkuil4f341712006-06-18 13:27:19 -03001091
1092/* MPEG-class control IDs specific to the CX2584x driver as defined by V4L2 */
1093#define V4L2_CID_MPEG_CX2341X_BASE (V4L2_CTRL_CLASS_MPEG | 0x1000)
1094#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+0)
1095enum v4l2_mpeg_cx2341x_video_spatial_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001096 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL = 0,
1097 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001098};
1099#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+1)
1100#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+2)
1101enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001102 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF = 0,
1103 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
1104 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT = 2,
1105 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE = 3,
1106 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001107};
1108#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+3)
1109enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001110 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF = 0,
1111 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001112};
1113#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+4)
1114enum v4l2_mpeg_cx2341x_video_temporal_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001115 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL = 0,
1116 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001117};
1118#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+5)
1119#define V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+6)
1120enum v4l2_mpeg_cx2341x_video_median_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001121 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF = 0,
1122 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR = 1,
1123 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT = 2,
1124 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT = 3,
1125 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001126};
1127#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+7)
1128#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+8)
1129#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+9)
1130#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+10)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001131#define V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (V4L2_CID_MPEG_CX2341X_BASE+11)
Hans Verkuil4f341712006-06-18 13:27:19 -03001132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133/*
1134 * T U N I N G
1135 */
1136struct v4l2_tuner
1137{
1138 __u32 index;
1139 __u8 name[32];
1140 enum v4l2_tuner_type type;
1141 __u32 capability;
1142 __u32 rangelow;
1143 __u32 rangehigh;
1144 __u32 rxsubchans;
1145 __u32 audmode;
1146 __s32 signal;
1147 __s32 afc;
1148 __u32 reserved[4];
1149};
1150
1151struct v4l2_modulator
1152{
1153 __u32 index;
1154 __u8 name[32];
1155 __u32 capability;
1156 __u32 rangelow;
1157 __u32 rangehigh;
1158 __u32 txsubchans;
1159 __u32 reserved[4];
1160};
1161
1162/* Flags for the 'capability' field */
1163#define V4L2_TUNER_CAP_LOW 0x0001
1164#define V4L2_TUNER_CAP_NORM 0x0002
1165#define V4L2_TUNER_CAP_STEREO 0x0010
1166#define V4L2_TUNER_CAP_LANG2 0x0020
1167#define V4L2_TUNER_CAP_SAP 0x0020
1168#define V4L2_TUNER_CAP_LANG1 0x0040
1169
1170/* Flags for the 'rxsubchans' field */
1171#define V4L2_TUNER_SUB_MONO 0x0001
1172#define V4L2_TUNER_SUB_STEREO 0x0002
1173#define V4L2_TUNER_SUB_LANG2 0x0004
1174#define V4L2_TUNER_SUB_SAP 0x0004
1175#define V4L2_TUNER_SUB_LANG1 0x0008
1176
1177/* Values for the 'audmode' field */
1178#define V4L2_TUNER_MODE_MONO 0x0000
1179#define V4L2_TUNER_MODE_STEREO 0x0001
1180#define V4L2_TUNER_MODE_LANG2 0x0002
1181#define V4L2_TUNER_MODE_SAP 0x0002
1182#define V4L2_TUNER_MODE_LANG1 0x0003
Hans Verkuil301e22d2006-03-18 17:15:00 -03001183#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
1185struct v4l2_frequency
1186{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001187 __u32 tuner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 enum v4l2_tuner_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001189 __u32 frequency;
1190 __u32 reserved[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191};
1192
1193/*
1194 * A U D I O
1195 */
1196struct v4l2_audio
1197{
1198 __u32 index;
1199 __u8 name[32];
1200 __u32 capability;
1201 __u32 mode;
1202 __u32 reserved[2];
1203};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -03001204
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205/* Flags for the 'capability' field */
1206#define V4L2_AUDCAP_STEREO 0x00001
1207#define V4L2_AUDCAP_AVL 0x00002
1208
1209/* Flags for the 'mode' field */
1210#define V4L2_AUDMODE_AVL 0x00001
1211
1212struct v4l2_audioout
1213{
1214 __u32 index;
1215 __u8 name[32];
1216 __u32 capability;
1217 __u32 mode;
1218 __u32 reserved[2];
1219};
1220
1221/*
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001222 * M P E G S E R V I C E S
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001223 *
1224 * NOTE: EXPERIMENTAL API
1225 */
1226#if 1
1227#define V4L2_ENC_IDX_FRAME_I (0)
1228#define V4L2_ENC_IDX_FRAME_P (1)
1229#define V4L2_ENC_IDX_FRAME_B (2)
1230#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1231
1232struct v4l2_enc_idx_entry {
1233 __u64 offset;
1234 __u64 pts;
1235 __u32 length;
1236 __u32 flags;
1237 __u32 reserved[2];
1238};
1239
1240#define V4L2_ENC_IDX_ENTRIES (64)
1241struct v4l2_enc_idx {
1242 __u32 entries;
1243 __u32 entries_cap;
1244 __u32 reserved[4];
1245 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1246};
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001247
1248
1249#define V4L2_ENC_CMD_START (0)
1250#define V4L2_ENC_CMD_STOP (1)
1251#define V4L2_ENC_CMD_PAUSE (2)
1252#define V4L2_ENC_CMD_RESUME (3)
1253
1254/* Flags for V4L2_ENC_CMD_STOP */
1255#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1256
1257struct v4l2_encoder_cmd {
1258 __u32 cmd;
1259 __u32 flags;
1260 union {
1261 struct {
1262 __u32 data[8];
1263 } raw;
1264 };
1265};
1266
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001267#endif
1268
1269
1270/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 * D A T A S E R V I C E S ( V B I )
1272 *
1273 * Data services API by Michael Schimek
1274 */
1275
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001276/* Raw VBI */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277struct v4l2_vbi_format
1278{
1279 __u32 sampling_rate; /* in 1 Hz */
1280 __u32 offset;
1281 __u32 samples_per_line;
1282 __u32 sample_format; /* V4L2_PIX_FMT_* */
1283 __s32 start[2];
1284 __u32 count[2];
1285 __u32 flags; /* V4L2_VBI_* */
1286 __u32 reserved[2]; /* must be zero */
1287};
1288
1289/* VBI flags */
1290#define V4L2_VBI_UNSYNC (1<< 0)
1291#define V4L2_VBI_INTERLACED (1<< 1)
1292
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001293/* Sliced VBI
1294 *
1295 * This implements is a proposal V4L2 API to allow SLICED VBI
1296 * required for some hardware encoders. It should change without
1297 * notice in the definitive implementation.
1298 */
1299
1300struct v4l2_sliced_vbi_format
1301{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001302 __u16 service_set;
1303 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1304 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001305 (equals frame lines 313-336 for 625 line video
1306 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001307 __u16 service_lines[2][24];
1308 __u32 io_size;
1309 __u32 reserved[2]; /* must be zero */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001310};
1311
Mauro Carvalho Chehab4d0dddb2006-01-23 17:11:07 -02001312/* Teletext World System Teletext
1313 (WST), defined on ITU-R BT.653-2 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001314#define V4L2_SLICED_TELETEXT_B (0x0001)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001315/* Video Program System, defined on ETS 300 231*/
Hans Verkuil9bc74002006-03-29 18:02:51 -03001316#define V4L2_SLICED_VPS (0x0400)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001317/* Closed Caption, defined on EIA-608 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001318#define V4L2_SLICED_CAPTION_525 (0x1000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001319/* Wide Screen System, defined on ITU-R BT1119.1 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001320#define V4L2_SLICED_WSS_625 (0x4000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001321
Hans Verkuil9bc74002006-03-29 18:02:51 -03001322#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1323#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001324
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001325struct v4l2_sliced_vbi_cap
1326{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001327 __u16 service_set;
1328 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1329 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001330 (equals frame lines 313-336 for 625 line video
1331 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001332 __u16 service_lines[2][24];
Hans Verkuil1739ade2006-08-26 03:05:17 -03001333 enum v4l2_buf_type type;
1334 __u32 reserved[3]; /* must be 0 */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001335};
1336
1337struct v4l2_sliced_vbi_data
1338{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001339 __u32 id;
1340 __u32 field; /* 0: first field, 1: second field */
1341 __u32 line; /* 1-23 */
1342 __u32 reserved; /* must be 0 */
1343 __u8 data[48];
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001344};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
1346/*
1347 * A G G R E G A T E S T R U C T U R E S
1348 */
1349
1350/* Stream data format
1351 */
1352struct v4l2_format
1353{
1354 enum v4l2_buf_type type;
1355 union
1356 {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001357 struct v4l2_pix_format pix; // V4L2_BUF_TYPE_VIDEO_CAPTURE
1358 struct v4l2_window win; // V4L2_BUF_TYPE_VIDEO_OVERLAY
1359 struct v4l2_vbi_format vbi; // V4L2_BUF_TYPE_VBI_CAPTURE
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001360 struct v4l2_sliced_vbi_format sliced; // V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001361 __u8 raw_data[200]; // user-defined
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 } fmt;
1363};
1364
1365
1366/* Stream type-dependent parameters
1367 */
1368struct v4l2_streamparm
1369{
1370 enum v4l2_buf_type type;
1371 union
1372 {
1373 struct v4l2_captureparm capture;
1374 struct v4l2_outputparm output;
1375 __u8 raw_data[200]; /* user-defined */
1376 } parm;
1377};
1378
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379/*
Trent Piepho52ebc762007-01-23 22:38:13 -03001380 * A D V A N C E D D E B U G G I N G
Hans Verkuilf3502b82007-02-23 21:16:01 -03001381 *
1382 * NOTE: EXPERIMENTAL API
Trent Piepho52ebc762007-01-23 22:38:13 -03001383 */
1384
1385/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001386
Hans Verkuilf3502b82007-02-23 21:16:01 -03001387#define V4L2_CHIP_MATCH_HOST 0 /* Match against chip ID on host (0 for the host) */
1388#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver ID */
1389#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001390
Trent Piepho52ebc762007-01-23 22:38:13 -03001391struct v4l2_register {
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001392 __u32 match_type; /* Match type */
1393 __u32 match_chip; /* Match this chip, meaning determined by match_type */
Trent Piephoe7b58f52007-01-30 22:47:18 -03001394 __u64 reg;
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001395 __u64 val;
Trent Piepho52ebc762007-01-23 22:38:13 -03001396};
1397
Hans Verkuil3434eb72007-04-27 12:31:08 -03001398/* VIDIOC_G_CHIP_IDENT */
1399struct v4l2_chip_ident {
1400 __u32 match_type; /* Match type */
1401 __u32 match_chip; /* Match this chip, meaning determined by match_type */
1402 __u32 ident; /* chip identifier as specified in <media/v4l2-chip-ident.h> */
1403 __u32 revision; /* chip revision, chip specific */
1404};
1405
Trent Piepho52ebc762007-01-23 22:38:13 -03001406/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 * 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
1408 *
1409 */
1410#define VIDIOC_QUERYCAP _IOR ('V', 0, struct v4l2_capability)
1411#define VIDIOC_RESERVED _IO ('V', 1)
1412#define VIDIOC_ENUM_FMT _IOWR ('V', 2, struct v4l2_fmtdesc)
1413#define VIDIOC_G_FMT _IOWR ('V', 4, struct v4l2_format)
1414#define VIDIOC_S_FMT _IOWR ('V', 5, struct v4l2_format)
Hans Verkuilf81cf752006-06-18 16:54:20 -03001415#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416#define VIDIOC_G_MPEGCOMP _IOR ('V', 6, struct v4l2_mpeg_compression)
1417#define VIDIOC_S_MPEGCOMP _IOW ('V', 7, struct v4l2_mpeg_compression)
Hans Verkuilf81cf752006-06-18 16:54:20 -03001418#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419#define VIDIOC_REQBUFS _IOWR ('V', 8, struct v4l2_requestbuffers)
1420#define VIDIOC_QUERYBUF _IOWR ('V', 9, struct v4l2_buffer)
1421#define VIDIOC_G_FBUF _IOR ('V', 10, struct v4l2_framebuffer)
1422#define VIDIOC_S_FBUF _IOW ('V', 11, struct v4l2_framebuffer)
1423#define VIDIOC_OVERLAY _IOW ('V', 14, int)
1424#define VIDIOC_QBUF _IOWR ('V', 15, struct v4l2_buffer)
1425#define VIDIOC_DQBUF _IOWR ('V', 17, struct v4l2_buffer)
1426#define VIDIOC_STREAMON _IOW ('V', 18, int)
1427#define VIDIOC_STREAMOFF _IOW ('V', 19, int)
1428#define VIDIOC_G_PARM _IOWR ('V', 21, struct v4l2_streamparm)
1429#define VIDIOC_S_PARM _IOWR ('V', 22, struct v4l2_streamparm)
1430#define VIDIOC_G_STD _IOR ('V', 23, v4l2_std_id)
1431#define VIDIOC_S_STD _IOW ('V', 24, v4l2_std_id)
1432#define VIDIOC_ENUMSTD _IOWR ('V', 25, struct v4l2_standard)
1433#define VIDIOC_ENUMINPUT _IOWR ('V', 26, struct v4l2_input)
1434#define VIDIOC_G_CTRL _IOWR ('V', 27, struct v4l2_control)
1435#define VIDIOC_S_CTRL _IOWR ('V', 28, struct v4l2_control)
1436#define VIDIOC_G_TUNER _IOWR ('V', 29, struct v4l2_tuner)
1437#define VIDIOC_S_TUNER _IOW ('V', 30, struct v4l2_tuner)
1438#define VIDIOC_G_AUDIO _IOR ('V', 33, struct v4l2_audio)
1439#define VIDIOC_S_AUDIO _IOW ('V', 34, struct v4l2_audio)
1440#define VIDIOC_QUERYCTRL _IOWR ('V', 36, struct v4l2_queryctrl)
1441#define VIDIOC_QUERYMENU _IOWR ('V', 37, struct v4l2_querymenu)
1442#define VIDIOC_G_INPUT _IOR ('V', 38, int)
1443#define VIDIOC_S_INPUT _IOWR ('V', 39, int)
1444#define VIDIOC_G_OUTPUT _IOR ('V', 46, int)
1445#define VIDIOC_S_OUTPUT _IOWR ('V', 47, int)
1446#define VIDIOC_ENUMOUTPUT _IOWR ('V', 48, struct v4l2_output)
1447#define VIDIOC_G_AUDOUT _IOR ('V', 49, struct v4l2_audioout)
1448#define VIDIOC_S_AUDOUT _IOW ('V', 50, struct v4l2_audioout)
1449#define VIDIOC_G_MODULATOR _IOWR ('V', 54, struct v4l2_modulator)
1450#define VIDIOC_S_MODULATOR _IOW ('V', 55, struct v4l2_modulator)
1451#define VIDIOC_G_FREQUENCY _IOWR ('V', 56, struct v4l2_frequency)
1452#define VIDIOC_S_FREQUENCY _IOW ('V', 57, struct v4l2_frequency)
1453#define VIDIOC_CROPCAP _IOWR ('V', 58, struct v4l2_cropcap)
1454#define VIDIOC_G_CROP _IOWR ('V', 59, struct v4l2_crop)
1455#define VIDIOC_S_CROP _IOW ('V', 60, struct v4l2_crop)
1456#define VIDIOC_G_JPEGCOMP _IOR ('V', 61, struct v4l2_jpegcompression)
1457#define VIDIOC_S_JPEGCOMP _IOW ('V', 62, struct v4l2_jpegcompression)
1458#define VIDIOC_QUERYSTD _IOR ('V', 63, v4l2_std_id)
1459#define VIDIOC_TRY_FMT _IOWR ('V', 64, struct v4l2_format)
1460#define VIDIOC_ENUMAUDIO _IOWR ('V', 65, struct v4l2_audio)
1461#define VIDIOC_ENUMAUDOUT _IOWR ('V', 66, struct v4l2_audioout)
1462#define VIDIOC_G_PRIORITY _IOR ('V', 67, enum v4l2_priority)
1463#define VIDIOC_S_PRIORITY _IOW ('V', 68, enum v4l2_priority)
Hans Verkuil616b8b62006-09-01 18:36:48 -03001464#define VIDIOC_G_SLICED_VBI_CAP _IOWR ('V', 69, struct v4l2_sliced_vbi_cap)
Hans Verkuil299392b2005-11-08 21:37:42 -08001465#define VIDIOC_LOG_STATUS _IO ('V', 70)
Hans Verkuil4f341712006-06-18 13:27:19 -03001466#define VIDIOC_G_EXT_CTRLS _IOWR ('V', 71, struct v4l2_ext_controls)
1467#define VIDIOC_S_EXT_CTRLS _IOWR ('V', 72, struct v4l2_ext_controls)
1468#define VIDIOC_TRY_EXT_CTRLS _IOWR ('V', 73, struct v4l2_ext_controls)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001469#if 1
Laurent Pinchart92b2db02006-09-28 13:42:05 -03001470#define VIDIOC_ENUM_FRAMESIZES _IOWR ('V', 74, struct v4l2_frmsizeenum)
1471#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR ('V', 75, struct v4l2_frmivalenum)
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001472#define VIDIOC_G_ENC_INDEX _IOR ('V', 76, struct v4l2_enc_idx)
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001473#define VIDIOC_ENCODER_CMD _IOWR ('V', 77, struct v4l2_encoder_cmd)
1474#define VIDIOC_TRY_ENCODER_CMD _IOWR ('V', 78, struct v4l2_encoder_cmd)
Hans Verkuilf3502b82007-02-23 21:16:01 -03001475
1476/* Experimental, only implemented if CONFIG_VIDEO_ADV_DEBUG is defined */
1477#define VIDIOC_DBG_S_REGISTER _IOW ('V', 79, struct v4l2_register)
1478#define VIDIOC_DBG_G_REGISTER _IOWR ('V', 80, struct v4l2_register)
Hans Verkuil3434eb72007-04-27 12:31:08 -03001479
1480#define VIDIOC_G_CHIP_IDENT _IOWR ('V', 81, struct v4l2_chip_ident)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001481#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001483#ifdef __OLD_VIDIOC_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484/* for compatibility, will go away some day */
1485#define VIDIOC_OVERLAY_OLD _IOWR ('V', 14, int)
1486#define VIDIOC_S_PARM_OLD _IOW ('V', 22, struct v4l2_streamparm)
1487#define VIDIOC_S_CTRL_OLD _IOW ('V', 28, struct v4l2_control)
1488#define VIDIOC_G_AUDIO_OLD _IOWR ('V', 33, struct v4l2_audio)
1489#define VIDIOC_G_AUDOUT_OLD _IOWR ('V', 49, struct v4l2_audioout)
1490#define VIDIOC_CROPCAP_OLD _IOR ('V', 58, struct v4l2_cropcap)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001491#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492
1493#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1494
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495#endif /* __LINUX_VIDEODEV2_H */
1496
1497/*
1498 * Local variables:
1499 * c-basic-offset: 8
1500 * End:
1501 */