blob: 42cfdd2d50db578607f0faacb1c3d717ad161722 [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 {
99 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};
113#define V4L2_FIELD_HAS_TOP(field) \
114 ((field) == V4L2_FIELD_TOP ||\
115 (field) == V4L2_FIELD_INTERLACED ||\
116 (field) == V4L2_FIELD_SEQ_TB ||\
117 (field) == V4L2_FIELD_SEQ_BT)
118#define V4L2_FIELD_HAS_BOTTOM(field) \
119 ((field) == V4L2_FIELD_BOTTOM ||\
120 (field) == V4L2_FIELD_INTERLACED ||\
121 (field) == V4L2_FIELD_SEQ_TB ||\
122 (field) == V4L2_FIELD_SEQ_BT)
123#define V4L2_FIELD_HAS_BOTH(field) \
124 ((field) == V4L2_FIELD_INTERLACED ||\
125 (field) == V4L2_FIELD_SEQ_TB ||\
126 (field) == V4L2_FIELD_SEQ_BT)
127
128enum v4l2_buf_type {
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700129 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
130 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
131 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
132 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
133 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700134 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
135 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700136 V4L2_BUF_TYPE_PRIVATE = 0x80,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137};
138
139enum v4l2_ctrl_type {
140 V4L2_CTRL_TYPE_INTEGER = 1,
141 V4L2_CTRL_TYPE_BOOLEAN = 2,
142 V4L2_CTRL_TYPE_MENU = 3,
143 V4L2_CTRL_TYPE_BUTTON = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -0300144 V4L2_CTRL_TYPE_INTEGER64 = 5,
145 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146};
147
148enum v4l2_tuner_type {
149 V4L2_TUNER_RADIO = 1,
150 V4L2_TUNER_ANALOG_TV = 2,
151 V4L2_TUNER_DIGITAL_TV = 3,
152};
153
154enum v4l2_memory {
155 V4L2_MEMORY_MMAP = 1,
156 V4L2_MEMORY_USERPTR = 2,
157 V4L2_MEMORY_OVERLAY = 3,
158};
159
160/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
161enum v4l2_colorspace {
162 /* ITU-R 601 -- broadcast NTSC/PAL */
163 V4L2_COLORSPACE_SMPTE170M = 1,
164
165 /* 1125-Line (US) HDTV */
166 V4L2_COLORSPACE_SMPTE240M = 2,
167
168 /* HD and modern captures. */
169 V4L2_COLORSPACE_REC709 = 3,
170
171 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
172 V4L2_COLORSPACE_BT878 = 4,
173
174 /* These should be useful. Assume 601 extents. */
175 V4L2_COLORSPACE_470_SYSTEM_M = 5,
176 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
177
178 /* I know there will be cameras that send this. So, this is
179 * unspecified chromaticities and full 0-255 on each of the
180 * Y'CbCr components
181 */
182 V4L2_COLORSPACE_JPEG = 7,
183
184 /* For RGB colourspaces, this is probably a good start. */
185 V4L2_COLORSPACE_SRGB = 8,
186};
187
188enum v4l2_priority {
189 V4L2_PRIORITY_UNSET = 0, /* not initialized */
190 V4L2_PRIORITY_BACKGROUND = 1,
191 V4L2_PRIORITY_INTERACTIVE = 2,
192 V4L2_PRIORITY_RECORD = 3,
193 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
194};
195
196struct v4l2_rect {
197 __s32 left;
198 __s32 top;
199 __s32 width;
200 __s32 height;
201};
202
203struct v4l2_fract {
204 __u32 numerator;
205 __u32 denominator;
206};
207
208/*
209 * D R I V E R C A P A B I L I T I E S
210 */
211struct v4l2_capability
212{
213 __u8 driver[16]; /* i.e. "bttv" */
214 __u8 card[32]; /* i.e. "Hauppauge WinTV" */
215 __u8 bus_info[32]; /* "PCI:" + pci_name(pci_dev) */
216 __u32 version; /* should use KERNEL_VERSION() */
217 __u32 capabilities; /* Device capabilities */
218 __u32 reserved[4];
219};
220
221/* Values for 'capabilities' field */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800222#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
223#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
224#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
225#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
226#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700227#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
228#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800229#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800231#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
232#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
233#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700235#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
236#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
237#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
239/*
240 * V I D E O I M A G E F O R M A T
241 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242struct v4l2_pix_format
243{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800244 __u32 width;
245 __u32 height;
246 __u32 pixelformat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 enum v4l2_field field;
248 __u32 bytesperline; /* for padding, zero if unused */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800249 __u32 sizeimage;
250 enum v4l2_colorspace colorspace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 __u32 priv; /* private data, depends on pixelformat */
252};
253
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300254/* Pixel format FOURCC depth Description */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R','G','B','1') /* 8 RGB-3-3-2 */
256#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R','G','B','O') /* 16 RGB-5-5-5 */
257#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R','G','B','P') /* 16 RGB-5-6-5 */
258#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16 RGB-5-5-5 BE */
259#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16 RGB-5-6-5 BE */
260#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B','G','R','3') /* 24 BGR-8-8-8 */
261#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R','G','B','3') /* 24 RGB-8-8-8 */
262#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B','G','R','4') /* 32 BGR-8-8-8-8 */
263#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R','G','B','4') /* 32 RGB-8-8-8-8 */
264#define V4L2_PIX_FMT_GREY v4l2_fourcc('G','R','E','Y') /* 8 Greyscale */
265#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y','V','U','9') /* 9 YVU 4:1:0 */
266#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y','V','1','2') /* 12 YVU 4:2:0 */
267#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y','U','Y','V') /* 16 YUV 4:2:2 */
268#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U','Y','V','Y') /* 16 YUV 4:2:2 */
269#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16 YVU422 planar */
270#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16 YVU411 planar */
271#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y','4','1','P') /* 12 YUV 4:1:1 */
272
273/* two planes -- one Y, one Cr + Cb interleaved */
274#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N','V','1','2') /* 12 Y/CbCr 4:2:0 */
275#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N','V','2','1') /* 12 Y/CrCb 4:2:0 */
276
277/* The following formats are not defined in the V4L2 specification */
278#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y','U','V','9') /* 9 YUV 4:1:0 */
279#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y','U','1','2') /* 12 YUV 4:2:0 */
280#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y','Y','U','V') /* 16 YUV 4:2:2 */
281#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H','I','2','4') /* 8 8-bit color */
Hans Verkuil50119152006-10-13 05:12:42 -0300282#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 -0300283#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R','4','4','4') /* 16 xxxxrrrr ggggbbbb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
285/* see http://www.siliconimaging.com/RGB%20Bayer.htm */
286#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B','A','8','1') /* 8 BGBG.. GRGR.. */
287
288/* compressed formats */
289#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M','J','P','G') /* Motion-JPEG */
290#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J','P','E','G') /* JFIF JPEG */
291#define V4L2_PIX_FMT_DV v4l2_fourcc('d','v','s','d') /* 1394 */
Hans Verkuil4f341712006-06-18 13:27:19 -0300292#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M','P','E','G') /* MPEG-1/2/4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
294/* Vendor-specific formats */
295#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W','N','V','A') /* Winnov hw compress */
296#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S','9','1','0') /* SN9C10x compression */
Mauro Carvalho Chehab115d6f32005-06-28 20:45:27 -0700297#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') /* pwc older webcam */
298#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') /* pwc newer webcam */
Mauro Carvalho Chehab749eef82006-02-27 00:07:40 -0300299#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E','6','2','5') /* ET61X251 compression */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301/*
302 * F O R M A T E N U M E R A T I O N
303 */
304struct v4l2_fmtdesc
305{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800306 __u32 index; /* Format number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 enum v4l2_buf_type type; /* buffer type */
308 __u32 flags;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800309 __u8 description[32]; /* Description string */
310 __u32 pixelformat; /* Format fourcc */
311 __u32 reserved[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312};
313
314#define V4L2_FMT_FLAG_COMPRESSED 0x0001
315
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300316#if 1
317 /* Experimental Frame Size and frame rate enumeration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318/*
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300319 * F R A M E S I Z E E N U M E R A T I O N
320 */
321enum v4l2_frmsizetypes
322{
323 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
324 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
325 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
326};
327
328struct v4l2_frmsize_discrete
329{
330 __u32 width; /* Frame width [pixel] */
331 __u32 height; /* Frame height [pixel] */
332};
333
334struct v4l2_frmsize_stepwise
335{
336 __u32 min_width; /* Minimum frame width [pixel] */
337 __u32 max_width; /* Maximum frame width [pixel] */
338 __u32 step_width; /* Frame width step size [pixel] */
339 __u32 min_height; /* Minimum frame height [pixel] */
340 __u32 max_height; /* Maximum frame height [pixel] */
341 __u32 step_height; /* Frame height step size [pixel] */
342};
343
344struct v4l2_frmsizeenum
345{
346 __u32 index; /* Frame size number */
347 __u32 pixel_format; /* Pixel format */
348 __u32 type; /* Frame size type the device supports. */
349
350 union { /* Frame size */
351 struct v4l2_frmsize_discrete discrete;
352 struct v4l2_frmsize_stepwise stepwise;
353 };
354
355 __u32 reserved[2]; /* Reserved space for future use */
356};
357
358/*
359 * F R A M E R A T E E N U M E R A T I O N
360 */
361enum v4l2_frmivaltypes
362{
363 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
364 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
365 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
366};
367
368struct v4l2_frmival_stepwise
369{
370 struct v4l2_fract min; /* Minimum frame interval [s] */
371 struct v4l2_fract max; /* Maximum frame interval [s] */
372 struct v4l2_fract step; /* Frame interval step size [s] */
373};
374
375struct v4l2_frmivalenum
376{
377 __u32 index; /* Frame format index */
378 __u32 pixel_format; /* Pixel format */
379 __u32 width; /* Frame width */
380 __u32 height; /* Frame height */
381 __u32 type; /* Frame interval type the device supports. */
382
383 union { /* Frame interval */
384 struct v4l2_fract discrete;
385 struct v4l2_frmival_stepwise stepwise;
386 };
387
388 __u32 reserved[2]; /* Reserved space for future use */
389};
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300390#endif
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300391
392/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 * T I M E C O D E
394 */
395struct v4l2_timecode
396{
397 __u32 type;
398 __u32 flags;
399 __u8 frames;
400 __u8 seconds;
401 __u8 minutes;
402 __u8 hours;
403 __u8 userbits[4];
404};
405
406/* Type */
407#define V4L2_TC_TYPE_24FPS 1
408#define V4L2_TC_TYPE_25FPS 2
409#define V4L2_TC_TYPE_30FPS 3
410#define V4L2_TC_TYPE_50FPS 4
411#define V4L2_TC_TYPE_60FPS 5
412
413/* Flags */
414#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
415#define V4L2_TC_FLAG_COLORFRAME 0x0002
416#define V4L2_TC_USERBITS_field 0x000C
417#define V4L2_TC_USERBITS_USERDEFINED 0x0000
418#define V4L2_TC_USERBITS_8BITCHARS 0x0008
419/* The above is based on SMPTE timecodes */
420
Hans Verkuilf81cf752006-06-18 16:54:20 -0300421#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/*
423 * 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
424 *
Hans Verkuilf81cf752006-06-18 16:54:20 -0300425 * ### WARNING: This experimental MPEG compression API is obsolete.
426 * ### It is replaced by the MPEG controls API.
427 * ### This old API will disappear in the near future!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 *
429 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430enum v4l2_bitrate_mode {
431 V4L2_BITRATE_NONE = 0, /* not specified */
432 V4L2_BITRATE_CBR, /* constant bitrate */
433 V4L2_BITRATE_VBR, /* variable bitrate */
434};
435struct v4l2_bitrate {
436 /* rates are specified in kbit/sec */
437 enum v4l2_bitrate_mode mode;
438 __u32 min;
439 __u32 target; /* use this one for CBR */
440 __u32 max;
441};
442
443enum v4l2_mpeg_streamtype {
444 V4L2_MPEG_SS_1, /* MPEG-1 system stream */
445 V4L2_MPEG_PS_2, /* MPEG-2 program stream */
446 V4L2_MPEG_TS_2, /* MPEG-2 transport stream */
447 V4L2_MPEG_PS_DVD, /* MPEG-2 program stream with DVD header fixups */
448};
449enum v4l2_mpeg_audiotype {
450 V4L2_MPEG_AU_2_I, /* MPEG-2 layer 1 */
451 V4L2_MPEG_AU_2_II, /* MPEG-2 layer 2 */
452 V4L2_MPEG_AU_2_III, /* MPEG-2 layer 3 */
453 V4L2_MPEG_AC3, /* AC3 */
454 V4L2_MPEG_LPCM, /* LPCM */
455};
456enum v4l2_mpeg_videotype {
457 V4L2_MPEG_VI_1, /* MPEG-1 */
458 V4L2_MPEG_VI_2, /* MPEG-2 */
459};
460enum v4l2_mpeg_aspectratio {
461 V4L2_MPEG_ASPECT_SQUARE = 1, /* square pixel */
462 V4L2_MPEG_ASPECT_4_3 = 2, /* 4 : 3 */
463 V4L2_MPEG_ASPECT_16_9 = 3, /* 16 : 9 */
464 V4L2_MPEG_ASPECT_1_221 = 4, /* 1 : 2,21 */
465};
466
467struct v4l2_mpeg_compression {
468 /* general */
469 enum v4l2_mpeg_streamtype st_type;
470 struct v4l2_bitrate st_bitrate;
471
472 /* transport streams */
473 __u16 ts_pid_pmt;
474 __u16 ts_pid_audio;
475 __u16 ts_pid_video;
476 __u16 ts_pid_pcr;
477
478 /* program stream */
479 __u16 ps_size;
480 __u16 reserved_1; /* align */
481
482 /* audio */
483 enum v4l2_mpeg_audiotype au_type;
484 struct v4l2_bitrate au_bitrate;
485 __u32 au_sample_rate;
486 __u8 au_pesid;
487 __u8 reserved_2[3]; /* align */
488
489 /* video */
490 enum v4l2_mpeg_videotype vi_type;
491 enum v4l2_mpeg_aspectratio vi_aspect_ratio;
492 struct v4l2_bitrate vi_bitrate;
493 __u32 vi_frame_rate;
494 __u16 vi_frames_per_gop;
495 __u16 vi_bframes_count;
496 __u8 vi_pesid;
497 __u8 reserved_3[3]; /* align */
498
499 /* misc flags */
500 __u32 closed_gops:1;
501 __u32 pulldown:1;
502 __u32 reserved_4:30; /* align */
503
504 /* I don't expect the above being perfect yet ;) */
505 __u32 reserved_5[8];
506};
Hans Verkuilf81cf752006-06-18 16:54:20 -0300507#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509struct v4l2_jpegcompression
510{
511 int quality;
512
513 int APPn; /* Number of APP segment to be written,
514 * must be 0..15 */
515 int APP_len; /* Length of data in JPEG APPn segment */
516 char APP_data[60]; /* Data in the JPEG APPn segment. */
517
518 int COM_len; /* Length of data in JPEG COM segment */
519 char COM_data[60]; /* Data in JPEG COM segment */
520
521 __u32 jpeg_markers; /* Which markers should go into the JPEG
522 * output. Unless you exactly know what
523 * you do, leave them untouched.
524 * Inluding less markers will make the
525 * resulting code smaller, but there will
526 * be fewer aplications which can read it.
527 * The presence of the APP and COM marker
528 * is influenced by APP_len and COM_len
529 * ONLY, not by this property! */
530
531#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
532#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
533#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
534#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
535#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -0800536 * allways use APP0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537};
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539/*
540 * M E M O R Y - M A P P I N G B U F F E R S
541 */
542struct v4l2_requestbuffers
543{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800544 __u32 count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 enum v4l2_buf_type type;
546 enum v4l2_memory memory;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800547 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548};
549
550struct v4l2_buffer
551{
552 __u32 index;
553 enum v4l2_buf_type type;
554 __u32 bytesused;
555 __u32 flags;
556 enum v4l2_field field;
557 struct timeval timestamp;
558 struct v4l2_timecode timecode;
559 __u32 sequence;
560
561 /* memory location */
562 enum v4l2_memory memory;
563 union {
564 __u32 offset;
565 unsigned long userptr;
566 } m;
567 __u32 length;
568 __u32 input;
569 __u32 reserved;
570};
571
572/* Flags for 'flags' field */
573#define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
574#define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
575#define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
576#define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
577#define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
578#define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
579#define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
580#define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
581
582/*
583 * O V E R L A Y P R E V I E W
584 */
585struct v4l2_framebuffer
586{
587 __u32 capability;
588 __u32 flags;
589/* FIXME: in theory we should pass something like PCI device + memory
590 * region + offset instead of some physical address */
591 void* base;
592 struct v4l2_pix_format fmt;
593};
594/* Flags for the 'capability' field. Read only */
595#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
596#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
597#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
598#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
599/* Flags for the 'flags' field. */
600#define V4L2_FBUF_FLAG_PRIMARY 0x0001
601#define V4L2_FBUF_FLAG_OVERLAY 0x0002
602#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
603
604struct v4l2_clip
605{
606 struct v4l2_rect c;
Al Viro5b1a43d2006-02-01 05:24:20 -0500607 struct v4l2_clip __user *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608};
609
610struct v4l2_window
611{
612 struct v4l2_rect w;
613 enum v4l2_field field;
614 __u32 chromakey;
615 struct v4l2_clip __user *clips;
616 __u32 clipcount;
617 void __user *bitmap;
618};
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620/*
621 * C A P T U R E P A R A M E T E R S
622 */
623struct v4l2_captureparm
624{
625 __u32 capability; /* Supported modes */
626 __u32 capturemode; /* Current mode */
627 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
628 __u32 extendedmode; /* Driver-specific extensions */
629 __u32 readbuffers; /* # of buffers for read */
630 __u32 reserved[4];
631};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633/* Flags for 'capability' and 'capturemode' fields */
634#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
635#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
636
637struct v4l2_outputparm
638{
639 __u32 capability; /* Supported modes */
640 __u32 outputmode; /* Current mode */
641 struct v4l2_fract timeperframe; /* Time per frame in seconds */
642 __u32 extendedmode; /* Driver-specific extensions */
643 __u32 writebuffers; /* # of buffers for write */
644 __u32 reserved[4];
645};
646
647/*
648 * I N P U T I M A G E C R O P P I N G
649 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650struct v4l2_cropcap {
651 enum v4l2_buf_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800652 struct v4l2_rect bounds;
653 struct v4l2_rect defrect;
654 struct v4l2_fract pixelaspect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655};
656
657struct v4l2_crop {
658 enum v4l2_buf_type type;
659 struct v4l2_rect c;
660};
661
662/*
663 * A N A L O G V I D E O S T A N D A R D
664 */
665
666typedef __u64 v4l2_std_id;
667
668/* one bit for each */
669#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
670#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
671#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
672#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
673#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
674#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
675#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
676#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
677
678#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
679#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
680#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
681#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
682
683#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
684#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800685#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
Hans Verkuild97a11e2006-02-07 06:48:40 -0200686#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
689#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
690#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
691#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
692#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
693#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
694#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
Mauro Carvalho Chehab800d3c62005-11-13 16:07:48 -0800695#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
697/* ATSC/HDTV */
698#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
699#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
700
Mauro Carvalho Chehab412297d2007-01-07 08:51:05 -0300701/* FIXME:
702 Although std_id is 64 bits, there is an issue on PPC32 architecture that
703 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
704 this value to 32 bits.
705 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
706 it should work fine. However, if needed to add more than two standards,
707 v4l2-common.c should be fixed.
708 */
709
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200710/* some merged standards */
711#define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
712#define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
713#define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
714#define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
715
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716/* some common needed stuff */
717#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
718 V4L2_STD_PAL_B1 |\
719 V4L2_STD_PAL_G)
720#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
721 V4L2_STD_PAL_D1 |\
722 V4L2_STD_PAL_K)
723#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
724 V4L2_STD_PAL_DK |\
725 V4L2_STD_PAL_H |\
726 V4L2_STD_PAL_I)
727#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
Hans Verkuild97a11e2006-02-07 06:48:40 -0200728 V4L2_STD_NTSC_M_JP |\
729 V4L2_STD_NTSC_M_KR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
731 V4L2_STD_SECAM_K |\
732 V4L2_STD_SECAM_K1)
733#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
734 V4L2_STD_SECAM_G |\
735 V4L2_STD_SECAM_H |\
736 V4L2_STD_SECAM_DK |\
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200737 V4L2_STD_SECAM_L |\
738 V4L2_STD_SECAM_LC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
740#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
741 V4L2_STD_PAL_60 |\
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800742 V4L2_STD_NTSC |\
743 V4L2_STD_NTSC_443)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744#define V4L2_STD_625_50 (V4L2_STD_PAL |\
745 V4L2_STD_PAL_N |\
746 V4L2_STD_PAL_Nc |\
747 V4L2_STD_SECAM)
748#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800749 V4L2_STD_ATSC_16_VSB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
751#define V4L2_STD_UNKNOWN 0
752#define V4L2_STD_ALL (V4L2_STD_525_60 |\
753 V4L2_STD_625_50)
754
755struct v4l2_standard
756{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800757 __u32 index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 v4l2_std_id id;
759 __u8 name[24];
760 struct v4l2_fract frameperiod; /* Frames, not fields */
761 __u32 framelines;
762 __u32 reserved[4];
763};
764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765/*
766 * V I D E O I N P U T S
767 */
768struct v4l2_input
769{
770 __u32 index; /* Which input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800771 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 __u32 type; /* Type of input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800773 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 __u32 tuner; /* Associated tuner */
775 v4l2_std_id std;
776 __u32 status;
777 __u32 reserved[4];
778};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780/* Values for the 'type' field */
781#define V4L2_INPUT_TYPE_TUNER 1
782#define V4L2_INPUT_TYPE_CAMERA 2
783
784/* field 'status' - general */
785#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
786#define V4L2_IN_ST_NO_SIGNAL 0x00000002
787#define V4L2_IN_ST_NO_COLOR 0x00000004
788
789/* field 'status' - analog */
790#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
791#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
792
793/* field 'status' - digital */
794#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
795#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
796#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
797
798/* field 'status' - VCR and set-top box */
799#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
800#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
801#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
802
803/*
804 * V I D E O O U T P U T S
805 */
806struct v4l2_output
807{
808 __u32 index; /* Which output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800809 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 __u32 type; /* Type of output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800811 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 __u32 modulator; /* Associated modulator */
813 v4l2_std_id std;
814 __u32 reserved[4];
815};
816/* Values for the 'type' field */
817#define V4L2_OUTPUT_TYPE_MODULATOR 1
818#define V4L2_OUTPUT_TYPE_ANALOG 2
819#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
820
821/*
822 * C O N T R O L S
823 */
824struct v4l2_control
825{
826 __u32 id;
827 __s32 value;
828};
829
Hans Verkuil4f341712006-06-18 13:27:19 -0300830struct v4l2_ext_control
831{
832 __u32 id;
833 __u32 reserved2[2];
834 union {
835 __s32 value;
836 __s64 value64;
837 void *reserved;
838 };
Mauro Carvalho Chehabf251d232006-07-22 08:20:07 -0300839} __attribute__ ((packed));
Hans Verkuil4f341712006-06-18 13:27:19 -0300840
841struct v4l2_ext_controls
842{
843 __u32 ctrl_class;
844 __u32 count;
845 __u32 error_idx;
846 __u32 reserved[2];
847 struct v4l2_ext_control *controls;
848};
849
850/* Values for ctrl_class field */
851#define V4L2_CTRL_CLASS_USER 0x00980000 /* Old-style 'user' controls */
852#define V4L2_CTRL_CLASS_MPEG 0x00990000 /* MPEG-compression controls */
853
854#define V4L2_CTRL_ID_MASK (0x0fffffff)
855#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
856#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
859struct v4l2_queryctrl
860{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800861 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 enum v4l2_ctrl_type type;
863 __u8 name[32]; /* Whatever */
864 __s32 minimum; /* Note signedness */
865 __s32 maximum;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800866 __s32 step;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 __s32 default_value;
868 __u32 flags;
869 __u32 reserved[2];
870};
871
872/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
873struct v4l2_querymenu
874{
875 __u32 id;
876 __u32 index;
877 __u8 name[32]; /* Whatever */
878 __u32 reserved;
879};
880
881/* Control flags */
882#define V4L2_CTRL_FLAG_DISABLED 0x0001
883#define V4L2_CTRL_FLAG_GRABBED 0x0002
Hans Verkuil4f341712006-06-18 13:27:19 -0300884#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
885#define V4L2_CTRL_FLAG_UPDATE 0x0008
886#define V4L2_CTRL_FLAG_INACTIVE 0x0010
887#define V4L2_CTRL_FLAG_SLIDER 0x0020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Hans Verkuil4f341712006-06-18 13:27:19 -0300889/* Query flag, to be ORed with the control ID */
890#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
891
892/* User-class control IDs defined by V4L2 */
893#define V4L2_CID_BASE (V4L2_CTRL_CLASS_USER | 0x900)
894#define V4L2_CID_USER_BASE V4L2_CID_BASE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895/* IDs reserved for driver specific controls */
896#define V4L2_CID_PRIVATE_BASE 0x08000000
897
Hans Verkuil4f341712006-06-18 13:27:19 -0300898#define V4L2_CID_USER_CLASS (V4L2_CTRL_CLASS_USER | 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899#define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
900#define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
901#define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
902#define V4L2_CID_HUE (V4L2_CID_BASE+3)
903#define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
904#define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
905#define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
906#define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
907#define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
908#define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
909#define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11)
910#define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
911#define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
912#define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
913#define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
914#define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
915#define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* ? Not sure */
916#define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
917#define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
918#define V4L2_CID_GAIN (V4L2_CID_BASE+19)
919#define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
920#define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
921#define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
922#define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
923#define V4L2_CID_LASTP1 (V4L2_CID_BASE+24) /* last CID + 1 */
924
Hans Verkuil4f341712006-06-18 13:27:19 -0300925/* MPEG-class control IDs defined by V4L2 */
926#define V4L2_CID_MPEG_BASE (V4L2_CTRL_CLASS_MPEG | 0x900)
927#define V4L2_CID_MPEG_CLASS (V4L2_CTRL_CLASS_MPEG | 1)
928
929/* MPEG streams */
930#define V4L2_CID_MPEG_STREAM_TYPE (V4L2_CID_MPEG_BASE+0)
931enum v4l2_mpeg_stream_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300932 V4L2_MPEG_STREAM_TYPE_MPEG2_PS = 0, /* MPEG-2 program stream */
933 V4L2_MPEG_STREAM_TYPE_MPEG2_TS = 1, /* MPEG-2 transport stream */
934 V4L2_MPEG_STREAM_TYPE_MPEG1_SS = 2, /* MPEG-1 system stream */
935 V4L2_MPEG_STREAM_TYPE_MPEG2_DVD = 3, /* MPEG-2 DVD-compatible stream */
936 V4L2_MPEG_STREAM_TYPE_MPEG1_VCD = 4, /* MPEG-1 VCD-compatible stream */
937 V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD = 5, /* MPEG-2 SVCD-compatible stream */
Hans Verkuil4f341712006-06-18 13:27:19 -0300938};
939#define V4L2_CID_MPEG_STREAM_PID_PMT (V4L2_CID_MPEG_BASE+1)
940#define V4L2_CID_MPEG_STREAM_PID_AUDIO (V4L2_CID_MPEG_BASE+2)
941#define V4L2_CID_MPEG_STREAM_PID_VIDEO (V4L2_CID_MPEG_BASE+3)
942#define V4L2_CID_MPEG_STREAM_PID_PCR (V4L2_CID_MPEG_BASE+4)
943#define V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (V4L2_CID_MPEG_BASE+5)
944#define V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (V4L2_CID_MPEG_BASE+6)
Hans Verkuil8cbde942006-06-24 14:36:02 -0300945#define V4L2_CID_MPEG_STREAM_VBI_FMT (V4L2_CID_MPEG_BASE+7)
946enum v4l2_mpeg_stream_vbi_fmt {
947 V4L2_MPEG_STREAM_VBI_FMT_NONE = 0, /* No VBI in the MPEG stream */
948 V4L2_MPEG_STREAM_VBI_FMT_IVTV = 1, /* VBI in private packets, IVTV format */
949};
Hans Verkuil4f341712006-06-18 13:27:19 -0300950
951/* MPEG audio */
952#define V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ (V4L2_CID_MPEG_BASE+100)
953enum v4l2_mpeg_audio_sampling_freq {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300954 V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100 = 0,
955 V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000 = 1,
956 V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -0300957};
958#define V4L2_CID_MPEG_AUDIO_ENCODING (V4L2_CID_MPEG_BASE+101)
959enum v4l2_mpeg_audio_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300960 V4L2_MPEG_AUDIO_ENCODING_LAYER_1 = 0,
961 V4L2_MPEG_AUDIO_ENCODING_LAYER_2 = 1,
962 V4L2_MPEG_AUDIO_ENCODING_LAYER_3 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -0300963};
964#define V4L2_CID_MPEG_AUDIO_L1_BITRATE (V4L2_CID_MPEG_BASE+102)
965enum v4l2_mpeg_audio_l1_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300966 V4L2_MPEG_AUDIO_L1_BITRATE_32K = 0,
967 V4L2_MPEG_AUDIO_L1_BITRATE_64K = 1,
968 V4L2_MPEG_AUDIO_L1_BITRATE_96K = 2,
969 V4L2_MPEG_AUDIO_L1_BITRATE_128K = 3,
970 V4L2_MPEG_AUDIO_L1_BITRATE_160K = 4,
971 V4L2_MPEG_AUDIO_L1_BITRATE_192K = 5,
972 V4L2_MPEG_AUDIO_L1_BITRATE_224K = 6,
973 V4L2_MPEG_AUDIO_L1_BITRATE_256K = 7,
974 V4L2_MPEG_AUDIO_L1_BITRATE_288K = 8,
975 V4L2_MPEG_AUDIO_L1_BITRATE_320K = 9,
976 V4L2_MPEG_AUDIO_L1_BITRATE_352K = 10,
977 V4L2_MPEG_AUDIO_L1_BITRATE_384K = 11,
978 V4L2_MPEG_AUDIO_L1_BITRATE_416K = 12,
979 V4L2_MPEG_AUDIO_L1_BITRATE_448K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -0300980};
981#define V4L2_CID_MPEG_AUDIO_L2_BITRATE (V4L2_CID_MPEG_BASE+103)
982enum v4l2_mpeg_audio_l2_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300983 V4L2_MPEG_AUDIO_L2_BITRATE_32K = 0,
984 V4L2_MPEG_AUDIO_L2_BITRATE_48K = 1,
985 V4L2_MPEG_AUDIO_L2_BITRATE_56K = 2,
986 V4L2_MPEG_AUDIO_L2_BITRATE_64K = 3,
987 V4L2_MPEG_AUDIO_L2_BITRATE_80K = 4,
988 V4L2_MPEG_AUDIO_L2_BITRATE_96K = 5,
989 V4L2_MPEG_AUDIO_L2_BITRATE_112K = 6,
990 V4L2_MPEG_AUDIO_L2_BITRATE_128K = 7,
991 V4L2_MPEG_AUDIO_L2_BITRATE_160K = 8,
992 V4L2_MPEG_AUDIO_L2_BITRATE_192K = 9,
993 V4L2_MPEG_AUDIO_L2_BITRATE_224K = 10,
994 V4L2_MPEG_AUDIO_L2_BITRATE_256K = 11,
995 V4L2_MPEG_AUDIO_L2_BITRATE_320K = 12,
996 V4L2_MPEG_AUDIO_L2_BITRATE_384K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -0300997};
998#define V4L2_CID_MPEG_AUDIO_L3_BITRATE (V4L2_CID_MPEG_BASE+104)
999enum v4l2_mpeg_audio_l3_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001000 V4L2_MPEG_AUDIO_L3_BITRATE_32K = 0,
1001 V4L2_MPEG_AUDIO_L3_BITRATE_40K = 1,
1002 V4L2_MPEG_AUDIO_L3_BITRATE_48K = 2,
1003 V4L2_MPEG_AUDIO_L3_BITRATE_56K = 3,
1004 V4L2_MPEG_AUDIO_L3_BITRATE_64K = 4,
1005 V4L2_MPEG_AUDIO_L3_BITRATE_80K = 5,
1006 V4L2_MPEG_AUDIO_L3_BITRATE_96K = 6,
1007 V4L2_MPEG_AUDIO_L3_BITRATE_112K = 7,
1008 V4L2_MPEG_AUDIO_L3_BITRATE_128K = 8,
1009 V4L2_MPEG_AUDIO_L3_BITRATE_160K = 9,
1010 V4L2_MPEG_AUDIO_L3_BITRATE_192K = 10,
1011 V4L2_MPEG_AUDIO_L3_BITRATE_224K = 11,
1012 V4L2_MPEG_AUDIO_L3_BITRATE_256K = 12,
1013 V4L2_MPEG_AUDIO_L3_BITRATE_320K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -03001014};
1015#define V4L2_CID_MPEG_AUDIO_MODE (V4L2_CID_MPEG_BASE+105)
1016enum v4l2_mpeg_audio_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001017 V4L2_MPEG_AUDIO_MODE_STEREO = 0,
1018 V4L2_MPEG_AUDIO_MODE_JOINT_STEREO = 1,
1019 V4L2_MPEG_AUDIO_MODE_DUAL = 2,
1020 V4L2_MPEG_AUDIO_MODE_MONO = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001021};
1022#define V4L2_CID_MPEG_AUDIO_MODE_EXTENSION (V4L2_CID_MPEG_BASE+106)
1023enum v4l2_mpeg_audio_mode_extension {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001024 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4 = 0,
1025 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8 = 1,
1026 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12 = 2,
1027 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001028};
1029#define V4L2_CID_MPEG_AUDIO_EMPHASIS (V4L2_CID_MPEG_BASE+107)
1030enum v4l2_mpeg_audio_emphasis {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001031 V4L2_MPEG_AUDIO_EMPHASIS_NONE = 0,
1032 V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS = 1,
1033 V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -03001034};
1035#define V4L2_CID_MPEG_AUDIO_CRC (V4L2_CID_MPEG_BASE+108)
1036enum v4l2_mpeg_audio_crc {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001037 V4L2_MPEG_AUDIO_CRC_NONE = 0,
1038 V4L2_MPEG_AUDIO_CRC_CRC16 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001039};
1040
1041/* MPEG video */
1042#define V4L2_CID_MPEG_VIDEO_ENCODING (V4L2_CID_MPEG_BASE+200)
1043enum v4l2_mpeg_video_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001044 V4L2_MPEG_VIDEO_ENCODING_MPEG_1 = 0,
1045 V4L2_MPEG_VIDEO_ENCODING_MPEG_2 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001046};
1047#define V4L2_CID_MPEG_VIDEO_ASPECT (V4L2_CID_MPEG_BASE+201)
1048enum v4l2_mpeg_video_aspect {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001049 V4L2_MPEG_VIDEO_ASPECT_1x1 = 0,
1050 V4L2_MPEG_VIDEO_ASPECT_4x3 = 1,
1051 V4L2_MPEG_VIDEO_ASPECT_16x9 = 2,
1052 V4L2_MPEG_VIDEO_ASPECT_221x100 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001053};
1054#define V4L2_CID_MPEG_VIDEO_B_FRAMES (V4L2_CID_MPEG_BASE+202)
1055#define V4L2_CID_MPEG_VIDEO_GOP_SIZE (V4L2_CID_MPEG_BASE+203)
1056#define V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (V4L2_CID_MPEG_BASE+204)
1057#define V4L2_CID_MPEG_VIDEO_PULLDOWN (V4L2_CID_MPEG_BASE+205)
1058#define V4L2_CID_MPEG_VIDEO_BITRATE_MODE (V4L2_CID_MPEG_BASE+206)
1059enum v4l2_mpeg_video_bitrate_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001060 V4L2_MPEG_VIDEO_BITRATE_MODE_VBR = 0,
1061 V4L2_MPEG_VIDEO_BITRATE_MODE_CBR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001062};
1063#define V4L2_CID_MPEG_VIDEO_BITRATE (V4L2_CID_MPEG_BASE+207)
1064#define V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (V4L2_CID_MPEG_BASE+208)
1065#define V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (V4L2_CID_MPEG_BASE+209)
1066
1067/* MPEG-class control IDs specific to the CX2584x driver as defined by V4L2 */
1068#define V4L2_CID_MPEG_CX2341X_BASE (V4L2_CTRL_CLASS_MPEG | 0x1000)
1069#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+0)
1070enum v4l2_mpeg_cx2341x_video_spatial_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001071 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL = 0,
1072 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001073};
1074#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+1)
1075#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+2)
1076enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001077 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF = 0,
1078 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
1079 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT = 2,
1080 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE = 3,
1081 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001082};
1083#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+3)
1084enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001085 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF = 0,
1086 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001087};
1088#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+4)
1089enum v4l2_mpeg_cx2341x_video_temporal_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001090 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL = 0,
1091 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001092};
1093#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+5)
1094#define V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+6)
1095enum v4l2_mpeg_cx2341x_video_median_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001096 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF = 0,
1097 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR = 1,
1098 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT = 2,
1099 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT = 3,
1100 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001101};
1102#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+7)
1103#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+8)
1104#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+9)
1105#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+10)
1106
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107/*
1108 * T U N I N G
1109 */
1110struct v4l2_tuner
1111{
1112 __u32 index;
1113 __u8 name[32];
1114 enum v4l2_tuner_type type;
1115 __u32 capability;
1116 __u32 rangelow;
1117 __u32 rangehigh;
1118 __u32 rxsubchans;
1119 __u32 audmode;
1120 __s32 signal;
1121 __s32 afc;
1122 __u32 reserved[4];
1123};
1124
1125struct v4l2_modulator
1126{
1127 __u32 index;
1128 __u8 name[32];
1129 __u32 capability;
1130 __u32 rangelow;
1131 __u32 rangehigh;
1132 __u32 txsubchans;
1133 __u32 reserved[4];
1134};
1135
1136/* Flags for the 'capability' field */
1137#define V4L2_TUNER_CAP_LOW 0x0001
1138#define V4L2_TUNER_CAP_NORM 0x0002
1139#define V4L2_TUNER_CAP_STEREO 0x0010
1140#define V4L2_TUNER_CAP_LANG2 0x0020
1141#define V4L2_TUNER_CAP_SAP 0x0020
1142#define V4L2_TUNER_CAP_LANG1 0x0040
1143
1144/* Flags for the 'rxsubchans' field */
1145#define V4L2_TUNER_SUB_MONO 0x0001
1146#define V4L2_TUNER_SUB_STEREO 0x0002
1147#define V4L2_TUNER_SUB_LANG2 0x0004
1148#define V4L2_TUNER_SUB_SAP 0x0004
1149#define V4L2_TUNER_SUB_LANG1 0x0008
1150
1151/* Values for the 'audmode' field */
1152#define V4L2_TUNER_MODE_MONO 0x0000
1153#define V4L2_TUNER_MODE_STEREO 0x0001
1154#define V4L2_TUNER_MODE_LANG2 0x0002
1155#define V4L2_TUNER_MODE_SAP 0x0002
1156#define V4L2_TUNER_MODE_LANG1 0x0003
Hans Verkuil301e22d2006-03-18 17:15:00 -03001157#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158
1159struct v4l2_frequency
1160{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001161 __u32 tuner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 enum v4l2_tuner_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001163 __u32 frequency;
1164 __u32 reserved[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165};
1166
1167/*
1168 * A U D I O
1169 */
1170struct v4l2_audio
1171{
1172 __u32 index;
1173 __u8 name[32];
1174 __u32 capability;
1175 __u32 mode;
1176 __u32 reserved[2];
1177};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -03001178
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179/* Flags for the 'capability' field */
1180#define V4L2_AUDCAP_STEREO 0x00001
1181#define V4L2_AUDCAP_AVL 0x00002
1182
1183/* Flags for the 'mode' field */
1184#define V4L2_AUDMODE_AVL 0x00001
1185
1186struct v4l2_audioout
1187{
1188 __u32 index;
1189 __u8 name[32];
1190 __u32 capability;
1191 __u32 mode;
1192 __u32 reserved[2];
1193};
1194
1195/*
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001196 * M P E G I N D E X
1197 *
1198 * NOTE: EXPERIMENTAL API
1199 */
1200#if 1
1201#define V4L2_ENC_IDX_FRAME_I (0)
1202#define V4L2_ENC_IDX_FRAME_P (1)
1203#define V4L2_ENC_IDX_FRAME_B (2)
1204#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1205
1206struct v4l2_enc_idx_entry {
1207 __u64 offset;
1208 __u64 pts;
1209 __u32 length;
1210 __u32 flags;
1211 __u32 reserved[2];
1212};
1213
1214#define V4L2_ENC_IDX_ENTRIES (64)
1215struct v4l2_enc_idx {
1216 __u32 entries;
1217 __u32 entries_cap;
1218 __u32 reserved[4];
1219 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1220};
1221#endif
1222
1223
1224/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 * D A T A S E R V I C E S ( V B I )
1226 *
1227 * Data services API by Michael Schimek
1228 */
1229
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001230/* Raw VBI */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231struct v4l2_vbi_format
1232{
1233 __u32 sampling_rate; /* in 1 Hz */
1234 __u32 offset;
1235 __u32 samples_per_line;
1236 __u32 sample_format; /* V4L2_PIX_FMT_* */
1237 __s32 start[2];
1238 __u32 count[2];
1239 __u32 flags; /* V4L2_VBI_* */
1240 __u32 reserved[2]; /* must be zero */
1241};
1242
1243/* VBI flags */
1244#define V4L2_VBI_UNSYNC (1<< 0)
1245#define V4L2_VBI_INTERLACED (1<< 1)
1246
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001247/* Sliced VBI
1248 *
1249 * This implements is a proposal V4L2 API to allow SLICED VBI
1250 * required for some hardware encoders. It should change without
1251 * notice in the definitive implementation.
1252 */
1253
1254struct v4l2_sliced_vbi_format
1255{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001256 __u16 service_set;
1257 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1258 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001259 (equals frame lines 313-336 for 625 line video
1260 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001261 __u16 service_lines[2][24];
1262 __u32 io_size;
1263 __u32 reserved[2]; /* must be zero */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001264};
1265
Mauro Carvalho Chehab4d0dddb2006-01-23 17:11:07 -02001266/* Teletext World System Teletext
1267 (WST), defined on ITU-R BT.653-2 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001268#define V4L2_SLICED_TELETEXT_B (0x0001)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001269/* Video Program System, defined on ETS 300 231*/
Hans Verkuil9bc74002006-03-29 18:02:51 -03001270#define V4L2_SLICED_VPS (0x0400)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001271/* Closed Caption, defined on EIA-608 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001272#define V4L2_SLICED_CAPTION_525 (0x1000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001273/* Wide Screen System, defined on ITU-R BT1119.1 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001274#define V4L2_SLICED_WSS_625 (0x4000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001275
Hans Verkuil9bc74002006-03-29 18:02:51 -03001276#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1277#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001278
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001279struct v4l2_sliced_vbi_cap
1280{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001281 __u16 service_set;
1282 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1283 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001284 (equals frame lines 313-336 for 625 line video
1285 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001286 __u16 service_lines[2][24];
Hans Verkuil1739ade2006-08-26 03:05:17 -03001287 enum v4l2_buf_type type;
1288 __u32 reserved[3]; /* must be 0 */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001289};
1290
1291struct v4l2_sliced_vbi_data
1292{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001293 __u32 id;
1294 __u32 field; /* 0: first field, 1: second field */
1295 __u32 line; /* 1-23 */
1296 __u32 reserved; /* must be 0 */
1297 __u8 data[48];
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001298};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
1300/*
1301 * A G G R E G A T E S T R U C T U R E S
1302 */
1303
1304/* Stream data format
1305 */
1306struct v4l2_format
1307{
1308 enum v4l2_buf_type type;
1309 union
1310 {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001311 struct v4l2_pix_format pix; // V4L2_BUF_TYPE_VIDEO_CAPTURE
1312 struct v4l2_window win; // V4L2_BUF_TYPE_VIDEO_OVERLAY
1313 struct v4l2_vbi_format vbi; // V4L2_BUF_TYPE_VBI_CAPTURE
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001314 struct v4l2_sliced_vbi_format sliced; // V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001315 __u8 raw_data[200]; // user-defined
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 } fmt;
1317};
1318
1319
1320/* Stream type-dependent parameters
1321 */
1322struct v4l2_streamparm
1323{
1324 enum v4l2_buf_type type;
1325 union
1326 {
1327 struct v4l2_captureparm capture;
1328 struct v4l2_outputparm output;
1329 __u8 raw_data[200]; /* user-defined */
1330 } parm;
1331};
1332
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333/*
Trent Piepho52ebc762007-01-23 22:38:13 -03001334 * A D V A N C E D D E B U G G I N G
1335 */
1336
1337/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001338
1339#define V4L2_CHIP_MATCH_ALWAYS 0 /* Match always (match_chip is not used) */
1340#define V4L2_CHIP_MATCH_HOST 1 /* Match against chip ID on host (0 for the host) */
1341#define V4L2_CHIP_MATCH_I2C_DRIVER 2 /* Match against I2C driver ID */
1342#define V4L2_CHIP_MATCH_I2C_ADDR 3 /* Match against I2C 7-bit address */
1343
Trent Piepho52ebc762007-01-23 22:38:13 -03001344struct v4l2_register {
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001345 __u32 match_type; /* Match type */
1346 __u32 match_chip; /* Match this chip, meaning determined by match_type */
Trent Piephoe7b58f52007-01-30 22:47:18 -03001347 __u64 reg;
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001348 __u64 val;
Trent Piepho52ebc762007-01-23 22:38:13 -03001349};
1350
1351/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 * 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
1353 *
1354 */
1355#define VIDIOC_QUERYCAP _IOR ('V', 0, struct v4l2_capability)
1356#define VIDIOC_RESERVED _IO ('V', 1)
1357#define VIDIOC_ENUM_FMT _IOWR ('V', 2, struct v4l2_fmtdesc)
1358#define VIDIOC_G_FMT _IOWR ('V', 4, struct v4l2_format)
1359#define VIDIOC_S_FMT _IOWR ('V', 5, struct v4l2_format)
Hans Verkuilf81cf752006-06-18 16:54:20 -03001360#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361#define VIDIOC_G_MPEGCOMP _IOR ('V', 6, struct v4l2_mpeg_compression)
1362#define VIDIOC_S_MPEGCOMP _IOW ('V', 7, struct v4l2_mpeg_compression)
Hans Verkuilf81cf752006-06-18 16:54:20 -03001363#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364#define VIDIOC_REQBUFS _IOWR ('V', 8, struct v4l2_requestbuffers)
1365#define VIDIOC_QUERYBUF _IOWR ('V', 9, struct v4l2_buffer)
1366#define VIDIOC_G_FBUF _IOR ('V', 10, struct v4l2_framebuffer)
1367#define VIDIOC_S_FBUF _IOW ('V', 11, struct v4l2_framebuffer)
1368#define VIDIOC_OVERLAY _IOW ('V', 14, int)
1369#define VIDIOC_QBUF _IOWR ('V', 15, struct v4l2_buffer)
1370#define VIDIOC_DQBUF _IOWR ('V', 17, struct v4l2_buffer)
1371#define VIDIOC_STREAMON _IOW ('V', 18, int)
1372#define VIDIOC_STREAMOFF _IOW ('V', 19, int)
1373#define VIDIOC_G_PARM _IOWR ('V', 21, struct v4l2_streamparm)
1374#define VIDIOC_S_PARM _IOWR ('V', 22, struct v4l2_streamparm)
1375#define VIDIOC_G_STD _IOR ('V', 23, v4l2_std_id)
1376#define VIDIOC_S_STD _IOW ('V', 24, v4l2_std_id)
1377#define VIDIOC_ENUMSTD _IOWR ('V', 25, struct v4l2_standard)
1378#define VIDIOC_ENUMINPUT _IOWR ('V', 26, struct v4l2_input)
1379#define VIDIOC_G_CTRL _IOWR ('V', 27, struct v4l2_control)
1380#define VIDIOC_S_CTRL _IOWR ('V', 28, struct v4l2_control)
1381#define VIDIOC_G_TUNER _IOWR ('V', 29, struct v4l2_tuner)
1382#define VIDIOC_S_TUNER _IOW ('V', 30, struct v4l2_tuner)
1383#define VIDIOC_G_AUDIO _IOR ('V', 33, struct v4l2_audio)
1384#define VIDIOC_S_AUDIO _IOW ('V', 34, struct v4l2_audio)
1385#define VIDIOC_QUERYCTRL _IOWR ('V', 36, struct v4l2_queryctrl)
1386#define VIDIOC_QUERYMENU _IOWR ('V', 37, struct v4l2_querymenu)
1387#define VIDIOC_G_INPUT _IOR ('V', 38, int)
1388#define VIDIOC_S_INPUT _IOWR ('V', 39, int)
1389#define VIDIOC_G_OUTPUT _IOR ('V', 46, int)
1390#define VIDIOC_S_OUTPUT _IOWR ('V', 47, int)
1391#define VIDIOC_ENUMOUTPUT _IOWR ('V', 48, struct v4l2_output)
1392#define VIDIOC_G_AUDOUT _IOR ('V', 49, struct v4l2_audioout)
1393#define VIDIOC_S_AUDOUT _IOW ('V', 50, struct v4l2_audioout)
1394#define VIDIOC_G_MODULATOR _IOWR ('V', 54, struct v4l2_modulator)
1395#define VIDIOC_S_MODULATOR _IOW ('V', 55, struct v4l2_modulator)
1396#define VIDIOC_G_FREQUENCY _IOWR ('V', 56, struct v4l2_frequency)
1397#define VIDIOC_S_FREQUENCY _IOW ('V', 57, struct v4l2_frequency)
1398#define VIDIOC_CROPCAP _IOWR ('V', 58, struct v4l2_cropcap)
1399#define VIDIOC_G_CROP _IOWR ('V', 59, struct v4l2_crop)
1400#define VIDIOC_S_CROP _IOW ('V', 60, struct v4l2_crop)
1401#define VIDIOC_G_JPEGCOMP _IOR ('V', 61, struct v4l2_jpegcompression)
1402#define VIDIOC_S_JPEGCOMP _IOW ('V', 62, struct v4l2_jpegcompression)
1403#define VIDIOC_QUERYSTD _IOR ('V', 63, v4l2_std_id)
1404#define VIDIOC_TRY_FMT _IOWR ('V', 64, struct v4l2_format)
1405#define VIDIOC_ENUMAUDIO _IOWR ('V', 65, struct v4l2_audio)
1406#define VIDIOC_ENUMAUDOUT _IOWR ('V', 66, struct v4l2_audioout)
1407#define VIDIOC_G_PRIORITY _IOR ('V', 67, enum v4l2_priority)
1408#define VIDIOC_S_PRIORITY _IOW ('V', 68, enum v4l2_priority)
Hans Verkuil616b8b62006-09-01 18:36:48 -03001409#define VIDIOC_G_SLICED_VBI_CAP _IOWR ('V', 69, struct v4l2_sliced_vbi_cap)
Hans Verkuil299392b2005-11-08 21:37:42 -08001410#define VIDIOC_LOG_STATUS _IO ('V', 70)
Hans Verkuil4f341712006-06-18 13:27:19 -03001411#define VIDIOC_G_EXT_CTRLS _IOWR ('V', 71, struct v4l2_ext_controls)
1412#define VIDIOC_S_EXT_CTRLS _IOWR ('V', 72, struct v4l2_ext_controls)
1413#define VIDIOC_TRY_EXT_CTRLS _IOWR ('V', 73, struct v4l2_ext_controls)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001414#if 1
Laurent Pinchart92b2db02006-09-28 13:42:05 -03001415#define VIDIOC_ENUM_FRAMESIZES _IOWR ('V', 74, struct v4l2_frmsizeenum)
1416#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR ('V', 75, struct v4l2_frmivalenum)
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001417#define VIDIOC_G_ENC_INDEX _IOR ('V', 76, struct v4l2_enc_idx)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001418#endif
Trent Piepho52ebc762007-01-23 22:38:13 -03001419/* only implemented if CONFIG_VIDEO_ADV_DEBUG is defined */
1420#define VIDIOC_DBG_S_REGISTER _IOW ('d', 100, struct v4l2_register)
1421#define VIDIOC_DBG_G_REGISTER _IOWR('d', 101, struct v4l2_register)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001423#ifdef __OLD_VIDIOC_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424/* for compatibility, will go away some day */
1425#define VIDIOC_OVERLAY_OLD _IOWR ('V', 14, int)
1426#define VIDIOC_S_PARM_OLD _IOW ('V', 22, struct v4l2_streamparm)
1427#define VIDIOC_S_CTRL_OLD _IOW ('V', 28, struct v4l2_control)
1428#define VIDIOC_G_AUDIO_OLD _IOWR ('V', 33, struct v4l2_audio)
1429#define VIDIOC_G_AUDOUT_OLD _IOWR ('V', 49, struct v4l2_audioout)
1430#define VIDIOC_CROPCAP_OLD _IOR ('V', 58, struct v4l2_cropcap)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001431#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432
1433#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1434
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435#endif /* __LINUX_VIDEODEV2_H */
1436
1437/*
1438 * Local variables:
1439 * c-basic-offset: 8
1440 * End:
1441 */