blob: 777bcb0daa11a8e631aab5472803659ecb1ea76b [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
Hans Verkuil3d58ffe2007-07-18 18:41:08 -030063#include <sys/time.h>
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030064#endif
Jiri Slaby83db33a2008-02-13 20:04:49 -030065#include <linux/ioctl.h>
David Mosberger-Tangc003d462006-05-26 10:28:13 -030066#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080068/*
69 * Common stuff for both V4L1 and V4L2
70 * Moved from videodev.h
71 */
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080072#define VIDEO_MAX_FRAME 32
73
Michael Schimekc12097f2005-11-08 21:38:24 -080074#define VID_TYPE_CAPTURE 1 /* Can capture */
75#define VID_TYPE_TUNER 2 /* Can tune */
76#define VID_TYPE_TELETEXT 4 /* Does teletext */
77#define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
78#define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
79#define VID_TYPE_CLIPPING 32 /* Can clip */
80#define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
81#define VID_TYPE_SCALES 128 /* Scalable */
82#define VID_TYPE_MONOCHROME 256 /* Monochrome only */
83#define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
84#define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
85#define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
86#define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
87#define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089/*
90 * M I S C E L L A N E O U S
91 */
92
93/* Four-character-code (FOURCC) */
94#define v4l2_fourcc(a,b,c,d)\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -080095 (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97/*
98 * E N U M S
99 */
100enum v4l2_field {
Hans Verkuilb2787842007-04-27 12:31:02 -0300101 V4L2_FIELD_ANY = 0, /* driver can choose from none,
102 top, bottom, interlaced
103 depending on whatever it thinks
104 is approximate ... */
105 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
106 V4L2_FIELD_TOP = 2, /* top field only */
107 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
108 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
109 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
110 buffer, top-bottom order */
111 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
112 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
113 separate buffers */
114 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
115 first and the top field is
116 transmitted first */
117 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
118 first and the bottom field is
119 transmitted first */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120};
121#define V4L2_FIELD_HAS_TOP(field) \
122 ((field) == V4L2_FIELD_TOP ||\
123 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300124 (field) == V4L2_FIELD_INTERLACED_TB ||\
125 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 (field) == V4L2_FIELD_SEQ_TB ||\
127 (field) == V4L2_FIELD_SEQ_BT)
128#define V4L2_FIELD_HAS_BOTTOM(field) \
129 ((field) == V4L2_FIELD_BOTTOM ||\
130 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300131 (field) == V4L2_FIELD_INTERLACED_TB ||\
132 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 (field) == V4L2_FIELD_SEQ_TB ||\
134 (field) == V4L2_FIELD_SEQ_BT)
135#define V4L2_FIELD_HAS_BOTH(field) \
136 ((field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300137 (field) == V4L2_FIELD_INTERLACED_TB ||\
138 (field) == V4L2_FIELD_INTERLACED_BT ||\
139 (field) == V4L2_FIELD_SEQ_TB ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 (field) == V4L2_FIELD_SEQ_BT)
141
142enum v4l2_buf_type {
Hans Verkuilb2787842007-04-27 12:31:02 -0300143 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
144 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
145 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
146 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
147 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
148 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
149 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
150#if 1
151 /* Experimental */
152 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
153#endif
154 V4L2_BUF_TYPE_PRIVATE = 0x80,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155};
156
157enum v4l2_ctrl_type {
158 V4L2_CTRL_TYPE_INTEGER = 1,
159 V4L2_CTRL_TYPE_BOOLEAN = 2,
160 V4L2_CTRL_TYPE_MENU = 3,
161 V4L2_CTRL_TYPE_BUTTON = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -0300162 V4L2_CTRL_TYPE_INTEGER64 = 5,
163 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164};
165
166enum v4l2_tuner_type {
167 V4L2_TUNER_RADIO = 1,
168 V4L2_TUNER_ANALOG_TV = 2,
169 V4L2_TUNER_DIGITAL_TV = 3,
170};
171
172enum v4l2_memory {
173 V4L2_MEMORY_MMAP = 1,
174 V4L2_MEMORY_USERPTR = 2,
175 V4L2_MEMORY_OVERLAY = 3,
176};
177
178/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
179enum v4l2_colorspace {
180 /* ITU-R 601 -- broadcast NTSC/PAL */
181 V4L2_COLORSPACE_SMPTE170M = 1,
182
183 /* 1125-Line (US) HDTV */
184 V4L2_COLORSPACE_SMPTE240M = 2,
185
186 /* HD and modern captures. */
187 V4L2_COLORSPACE_REC709 = 3,
188
189 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
190 V4L2_COLORSPACE_BT878 = 4,
191
192 /* These should be useful. Assume 601 extents. */
193 V4L2_COLORSPACE_470_SYSTEM_M = 5,
194 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
195
196 /* I know there will be cameras that send this. So, this is
197 * unspecified chromaticities and full 0-255 on each of the
198 * Y'CbCr components
199 */
200 V4L2_COLORSPACE_JPEG = 7,
201
202 /* For RGB colourspaces, this is probably a good start. */
203 V4L2_COLORSPACE_SRGB = 8,
204};
205
206enum v4l2_priority {
207 V4L2_PRIORITY_UNSET = 0, /* not initialized */
208 V4L2_PRIORITY_BACKGROUND = 1,
209 V4L2_PRIORITY_INTERACTIVE = 2,
210 V4L2_PRIORITY_RECORD = 3,
211 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
212};
213
214struct v4l2_rect {
215 __s32 left;
216 __s32 top;
217 __s32 width;
218 __s32 height;
219};
220
221struct v4l2_fract {
222 __u32 numerator;
223 __u32 denominator;
224};
225
226/*
227 * D R I V E R C A P A B I L I T I E S
228 */
229struct v4l2_capability
230{
231 __u8 driver[16]; /* i.e. "bttv" */
232 __u8 card[32]; /* i.e. "Hauppauge WinTV" */
233 __u8 bus_info[32]; /* "PCI:" + pci_name(pci_dev) */
234 __u32 version; /* should use KERNEL_VERSION() */
235 __u32 capabilities; /* Device capabilities */
236 __u32 reserved[4];
237};
238
239/* Values for 'capabilities' field */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800240#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
241#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
242#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
243#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
244#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700245#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
246#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800247#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
Hans Verkuil1f137602007-05-29 08:18:37 -0300248#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800250#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
251#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
252#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700254#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
255#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
256#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258/*
259 * V I D E O I M A G E F O R M A T
260 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261struct v4l2_pix_format
262{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800263 __u32 width;
264 __u32 height;
265 __u32 pixelformat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 enum v4l2_field field;
267 __u32 bytesperline; /* for padding, zero if unused */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800268 __u32 sizeimage;
269 enum v4l2_colorspace colorspace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 __u32 priv; /* private data, depends on pixelformat */
271};
272
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300273/* Pixel format FOURCC depth Description */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R','G','B','1') /* 8 RGB-3-3-2 */
Hans Verkuil5d057042007-08-25 15:16:37 -0300275#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R','4','4','4') /* 16 xxxxrrrr ggggbbbb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R','G','B','O') /* 16 RGB-5-5-5 */
277#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R','G','B','P') /* 16 RGB-5-6-5 */
278#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16 RGB-5-5-5 BE */
279#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16 RGB-5-6-5 BE */
280#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B','G','R','3') /* 24 BGR-8-8-8 */
281#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R','G','B','3') /* 24 RGB-8-8-8 */
282#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B','G','R','4') /* 32 BGR-8-8-8-8 */
283#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R','G','B','4') /* 32 RGB-8-8-8-8 */
284#define V4L2_PIX_FMT_GREY v4l2_fourcc('G','R','E','Y') /* 8 Greyscale */
Hans Verkuil5d057042007-08-25 15:16:37 -0300285#define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P','A','L','8') /* 8 8-bit palette */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y','V','U','9') /* 9 YVU 4:1:0 */
287#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y','V','1','2') /* 12 YVU 4:2:0 */
288#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y','U','Y','V') /* 16 YUV 4:2:2 */
289#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U','Y','V','Y') /* 16 YUV 4:2:2 */
290#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16 YVU422 planar */
291#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16 YVU411 planar */
292#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y','4','1','P') /* 12 YUV 4:1:1 */
Hans Verkuil5d057042007-08-25 15:16:37 -0300293#define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y','4','4','4') /* 16 xxxxyyyy uuuuvvvv */
294#define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y','U','V','O') /* 16 YUV-5-5-5 */
295#define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y','U','V','P') /* 16 YUV-5-6-5 */
296#define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y','U','V','4') /* 32 YUV-8-8-8-8 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
298/* two planes -- one Y, one Cr + Cb interleaved */
299#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N','V','1','2') /* 12 Y/CbCr 4:2:0 */
300#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N','V','2','1') /* 12 Y/CrCb 4:2:0 */
301
302/* The following formats are not defined in the V4L2 specification */
303#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y','U','V','9') /* 9 YUV 4:1:0 */
304#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y','U','1','2') /* 12 YUV 4:2:0 */
305#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y','Y','U','V') /* 16 YUV 4:2:2 */
306#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H','I','2','4') /* 8 8-bit color */
Hans Verkuil50119152006-10-13 05:12:42 -0300307#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H','M','1','2') /* 8 YUV 4:2:0 16x16 macroblocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309/* see http://www.siliconimaging.com/RGB%20Bayer.htm */
310#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B','A','8','1') /* 8 BGBG.. GRGR.. */
311
312/* compressed formats */
313#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M','J','P','G') /* Motion-JPEG */
314#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J','P','E','G') /* JFIF JPEG */
315#define V4L2_PIX_FMT_DV v4l2_fourcc('d','v','s','d') /* 1394 */
Hans Verkuil4f341712006-06-18 13:27:19 -0300316#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M','P','E','G') /* MPEG-1/2/4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318/* Vendor-specific formats */
319#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W','N','V','A') /* Winnov hw compress */
320#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S','9','1','0') /* SN9C10x compression */
Mauro Carvalho Chehab115d6f32005-06-28 20:45:27 -0700321#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') /* pwc older webcam */
322#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') /* pwc newer webcam */
Mauro Carvalho Chehab749eef82006-02-27 00:07:40 -0300323#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E','6','2','5') /* ET61X251 compression */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325/*
326 * F O R M A T E N U M E R A T I O N
327 */
328struct v4l2_fmtdesc
329{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800330 __u32 index; /* Format number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 enum v4l2_buf_type type; /* buffer type */
332 __u32 flags;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800333 __u8 description[32]; /* Description string */
334 __u32 pixelformat; /* Format fourcc */
335 __u32 reserved[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336};
337
338#define V4L2_FMT_FLAG_COMPRESSED 0x0001
339
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300340#if 1
341 /* Experimental Frame Size and frame rate enumeration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342/*
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300343 * F R A M E S I Z E E N U M E R A T I O N
344 */
345enum v4l2_frmsizetypes
346{
347 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
348 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
349 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
350};
351
352struct v4l2_frmsize_discrete
353{
354 __u32 width; /* Frame width [pixel] */
355 __u32 height; /* Frame height [pixel] */
356};
357
358struct v4l2_frmsize_stepwise
359{
360 __u32 min_width; /* Minimum frame width [pixel] */
361 __u32 max_width; /* Maximum frame width [pixel] */
362 __u32 step_width; /* Frame width step size [pixel] */
363 __u32 min_height; /* Minimum frame height [pixel] */
364 __u32 max_height; /* Maximum frame height [pixel] */
365 __u32 step_height; /* Frame height step size [pixel] */
366};
367
368struct v4l2_frmsizeenum
369{
370 __u32 index; /* Frame size number */
371 __u32 pixel_format; /* Pixel format */
372 __u32 type; /* Frame size type the device supports. */
373
374 union { /* Frame size */
375 struct v4l2_frmsize_discrete discrete;
376 struct v4l2_frmsize_stepwise stepwise;
377 };
378
379 __u32 reserved[2]; /* Reserved space for future use */
380};
381
382/*
383 * F R A M E R A T E E N U M E R A T I O N
384 */
385enum v4l2_frmivaltypes
386{
387 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
388 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
389 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
390};
391
392struct v4l2_frmival_stepwise
393{
394 struct v4l2_fract min; /* Minimum frame interval [s] */
395 struct v4l2_fract max; /* Maximum frame interval [s] */
396 struct v4l2_fract step; /* Frame interval step size [s] */
397};
398
399struct v4l2_frmivalenum
400{
401 __u32 index; /* Frame format index */
402 __u32 pixel_format; /* Pixel format */
403 __u32 width; /* Frame width */
404 __u32 height; /* Frame height */
405 __u32 type; /* Frame interval type the device supports. */
406
407 union { /* Frame interval */
408 struct v4l2_fract discrete;
409 struct v4l2_frmival_stepwise stepwise;
410 };
411
412 __u32 reserved[2]; /* Reserved space for future use */
413};
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300414#endif
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300415
416/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 * T I M E C O D E
418 */
419struct v4l2_timecode
420{
421 __u32 type;
422 __u32 flags;
423 __u8 frames;
424 __u8 seconds;
425 __u8 minutes;
426 __u8 hours;
427 __u8 userbits[4];
428};
429
430/* Type */
431#define V4L2_TC_TYPE_24FPS 1
432#define V4L2_TC_TYPE_25FPS 2
433#define V4L2_TC_TYPE_30FPS 3
434#define V4L2_TC_TYPE_50FPS 4
435#define V4L2_TC_TYPE_60FPS 5
436
437/* Flags */
438#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
439#define V4L2_TC_FLAG_COLORFRAME 0x0002
440#define V4L2_TC_USERBITS_field 0x000C
441#define V4L2_TC_USERBITS_USERDEFINED 0x0000
442#define V4L2_TC_USERBITS_8BITCHARS 0x0008
443/* The above is based on SMPTE timecodes */
444
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445struct v4l2_jpegcompression
446{
447 int quality;
448
449 int APPn; /* Number of APP segment to be written,
450 * must be 0..15 */
451 int APP_len; /* Length of data in JPEG APPn segment */
452 char APP_data[60]; /* Data in the JPEG APPn segment. */
453
454 int COM_len; /* Length of data in JPEG COM segment */
455 char COM_data[60]; /* Data in JPEG COM segment */
456
457 __u32 jpeg_markers; /* Which markers should go into the JPEG
458 * output. Unless you exactly know what
459 * you do, leave them untouched.
460 * Inluding less markers will make the
461 * resulting code smaller, but there will
462 * be fewer aplications which can read it.
463 * The presence of the APP and COM marker
464 * is influenced by APP_len and COM_len
465 * ONLY, not by this property! */
466
467#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
468#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
469#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
470#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
471#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -0800472 * allways use APP0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473};
474
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475/*
476 * M E M O R Y - M A P P I N G B U F F E R S
477 */
478struct v4l2_requestbuffers
479{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800480 __u32 count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 enum v4l2_buf_type type;
482 enum v4l2_memory memory;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800483 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484};
485
486struct v4l2_buffer
487{
488 __u32 index;
489 enum v4l2_buf_type type;
490 __u32 bytesused;
491 __u32 flags;
492 enum v4l2_field field;
493 struct timeval timestamp;
494 struct v4l2_timecode timecode;
495 __u32 sequence;
496
497 /* memory location */
498 enum v4l2_memory memory;
499 union {
500 __u32 offset;
501 unsigned long userptr;
502 } m;
503 __u32 length;
504 __u32 input;
505 __u32 reserved;
506};
507
508/* Flags for 'flags' field */
509#define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
510#define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
511#define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
512#define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
513#define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
514#define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
515#define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
516#define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
517
518/*
519 * O V E R L A Y P R E V I E W
520 */
521struct v4l2_framebuffer
522{
523 __u32 capability;
524 __u32 flags;
525/* FIXME: in theory we should pass something like PCI device + memory
526 * region + offset instead of some physical address */
527 void* base;
528 struct v4l2_pix_format fmt;
529};
530/* Flags for the 'capability' field. Read only */
531#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
532#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
533#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
534#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
Hans Verkuilb2787842007-04-27 12:31:02 -0300535#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
536#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300537#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538/* Flags for the 'flags' field. */
539#define V4L2_FBUF_FLAG_PRIMARY 0x0001
540#define V4L2_FBUF_FLAG_OVERLAY 0x0002
541#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
Hans Verkuilb2787842007-04-27 12:31:02 -0300542#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
543#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300544#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546struct v4l2_clip
547{
548 struct v4l2_rect c;
Al Viro5b1a43d2006-02-01 05:24:20 -0500549 struct v4l2_clip __user *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550};
551
552struct v4l2_window
553{
554 struct v4l2_rect w;
555 enum v4l2_field field;
556 __u32 chromakey;
557 struct v4l2_clip __user *clips;
558 __u32 clipcount;
559 void __user *bitmap;
Hans Verkuilb2787842007-04-27 12:31:02 -0300560 __u8 global_alpha;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561};
562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563/*
564 * C A P T U R E P A R A M E T E R S
565 */
566struct v4l2_captureparm
567{
568 __u32 capability; /* Supported modes */
569 __u32 capturemode; /* Current mode */
570 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
571 __u32 extendedmode; /* Driver-specific extensions */
572 __u32 readbuffers; /* # of buffers for read */
573 __u32 reserved[4];
574};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576/* Flags for 'capability' and 'capturemode' fields */
577#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
578#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
579
580struct v4l2_outputparm
581{
582 __u32 capability; /* Supported modes */
583 __u32 outputmode; /* Current mode */
584 struct v4l2_fract timeperframe; /* Time per frame in seconds */
585 __u32 extendedmode; /* Driver-specific extensions */
586 __u32 writebuffers; /* # of buffers for write */
587 __u32 reserved[4];
588};
589
590/*
591 * I N P U T I M A G E C R O P P I N G
592 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593struct v4l2_cropcap {
594 enum v4l2_buf_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800595 struct v4l2_rect bounds;
596 struct v4l2_rect defrect;
597 struct v4l2_fract pixelaspect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598};
599
600struct v4l2_crop {
601 enum v4l2_buf_type type;
602 struct v4l2_rect c;
603};
604
605/*
606 * A N A L O G V I D E O S T A N D A R D
607 */
608
609typedef __u64 v4l2_std_id;
610
611/* one bit for each */
612#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
613#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
614#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
615#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
616#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
617#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
618#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
619#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
620
621#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
622#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
623#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
624#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
625
626#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
627#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800628#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
Hans Verkuild97a11e2006-02-07 06:48:40 -0200629#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
631#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
632#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
633#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
634#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
635#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
636#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
637#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
Mauro Carvalho Chehab800d3c62005-11-13 16:07:48 -0800638#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640/* ATSC/HDTV */
641#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
642#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
643
Mauro Carvalho Chehab412297d2007-01-07 08:51:05 -0300644/* FIXME:
645 Although std_id is 64 bits, there is an issue on PPC32 architecture that
646 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
647 this value to 32 bits.
648 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
649 it should work fine. However, if needed to add more than two standards,
650 v4l2-common.c should be fixed.
651 */
652
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200653/* some merged standards */
654#define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
655#define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
656#define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
657#define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659/* some common needed stuff */
660#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
661 V4L2_STD_PAL_B1 |\
662 V4L2_STD_PAL_G)
663#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
664 V4L2_STD_PAL_D1 |\
665 V4L2_STD_PAL_K)
666#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
667 V4L2_STD_PAL_DK |\
668 V4L2_STD_PAL_H |\
669 V4L2_STD_PAL_I)
670#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
Hans Verkuild97a11e2006-02-07 06:48:40 -0200671 V4L2_STD_NTSC_M_JP |\
672 V4L2_STD_NTSC_M_KR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
674 V4L2_STD_SECAM_K |\
675 V4L2_STD_SECAM_K1)
676#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
677 V4L2_STD_SECAM_G |\
678 V4L2_STD_SECAM_H |\
679 V4L2_STD_SECAM_DK |\
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200680 V4L2_STD_SECAM_L |\
681 V4L2_STD_SECAM_LC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
683#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
684 V4L2_STD_PAL_60 |\
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800685 V4L2_STD_NTSC |\
686 V4L2_STD_NTSC_443)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687#define V4L2_STD_625_50 (V4L2_STD_PAL |\
688 V4L2_STD_PAL_N |\
689 V4L2_STD_PAL_Nc |\
690 V4L2_STD_SECAM)
691#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800692 V4L2_STD_ATSC_16_VSB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
694#define V4L2_STD_UNKNOWN 0
695#define V4L2_STD_ALL (V4L2_STD_525_60 |\
696 V4L2_STD_625_50)
697
698struct v4l2_standard
699{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800700 __u32 index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 v4l2_std_id id;
702 __u8 name[24];
703 struct v4l2_fract frameperiod; /* Frames, not fields */
704 __u32 framelines;
705 __u32 reserved[4];
706};
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708/*
709 * V I D E O I N P U T S
710 */
711struct v4l2_input
712{
713 __u32 index; /* Which input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800714 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 __u32 type; /* Type of input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800716 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 __u32 tuner; /* Associated tuner */
718 v4l2_std_id std;
719 __u32 status;
720 __u32 reserved[4];
721};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723/* Values for the 'type' field */
724#define V4L2_INPUT_TYPE_TUNER 1
725#define V4L2_INPUT_TYPE_CAMERA 2
726
727/* field 'status' - general */
728#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
729#define V4L2_IN_ST_NO_SIGNAL 0x00000002
730#define V4L2_IN_ST_NO_COLOR 0x00000004
731
732/* field 'status' - analog */
733#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
734#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
735
736/* field 'status' - digital */
737#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
738#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
739#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
740
741/* field 'status' - VCR and set-top box */
742#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
743#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
744#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
745
746/*
747 * V I D E O O U T P U T S
748 */
749struct v4l2_output
750{
751 __u32 index; /* Which output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800752 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 __u32 type; /* Type of output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800754 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 __u32 modulator; /* Associated modulator */
756 v4l2_std_id std;
757 __u32 reserved[4];
758};
759/* Values for the 'type' field */
760#define V4L2_OUTPUT_TYPE_MODULATOR 1
761#define V4L2_OUTPUT_TYPE_ANALOG 2
762#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
763
764/*
765 * C O N T R O L S
766 */
767struct v4l2_control
768{
769 __u32 id;
770 __s32 value;
771};
772
Hans Verkuil4f341712006-06-18 13:27:19 -0300773struct v4l2_ext_control
774{
775 __u32 id;
776 __u32 reserved2[2];
777 union {
778 __s32 value;
779 __s64 value64;
780 void *reserved;
781 };
Mauro Carvalho Chehabf251d232006-07-22 08:20:07 -0300782} __attribute__ ((packed));
Hans Verkuil4f341712006-06-18 13:27:19 -0300783
784struct v4l2_ext_controls
785{
786 __u32 ctrl_class;
787 __u32 count;
788 __u32 error_idx;
789 __u32 reserved[2];
790 struct v4l2_ext_control *controls;
791};
792
793/* Values for ctrl_class field */
794#define V4L2_CTRL_CLASS_USER 0x00980000 /* Old-style 'user' controls */
795#define V4L2_CTRL_CLASS_MPEG 0x00990000 /* MPEG-compression controls */
796
797#define V4L2_CTRL_ID_MASK (0x0fffffff)
798#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
799#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
802struct v4l2_queryctrl
803{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800804 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 enum v4l2_ctrl_type type;
806 __u8 name[32]; /* Whatever */
807 __s32 minimum; /* Note signedness */
808 __s32 maximum;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800809 __s32 step;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 __s32 default_value;
811 __u32 flags;
812 __u32 reserved[2];
813};
814
815/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
816struct v4l2_querymenu
817{
818 __u32 id;
819 __u32 index;
820 __u8 name[32]; /* Whatever */
821 __u32 reserved;
822};
823
824/* Control flags */
825#define V4L2_CTRL_FLAG_DISABLED 0x0001
826#define V4L2_CTRL_FLAG_GRABBED 0x0002
Hans Verkuil4f341712006-06-18 13:27:19 -0300827#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
828#define V4L2_CTRL_FLAG_UPDATE 0x0008
829#define V4L2_CTRL_FLAG_INACTIVE 0x0010
830#define V4L2_CTRL_FLAG_SLIDER 0x0020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Hans Verkuil4f341712006-06-18 13:27:19 -0300832/* Query flag, to be ORed with the control ID */
833#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
834
835/* User-class control IDs defined by V4L2 */
836#define V4L2_CID_BASE (V4L2_CTRL_CLASS_USER | 0x900)
837#define V4L2_CID_USER_BASE V4L2_CID_BASE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838/* IDs reserved for driver specific controls */
839#define V4L2_CID_PRIVATE_BASE 0x08000000
840
Hans Verkuil4f341712006-06-18 13:27:19 -0300841#define V4L2_CID_USER_CLASS (V4L2_CTRL_CLASS_USER | 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842#define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
843#define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
844#define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
845#define V4L2_CID_HUE (V4L2_CID_BASE+3)
846#define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
847#define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
848#define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
849#define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
850#define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
851#define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
Brandon Philips26d507f2008-04-22 14:42:02 -0300852#define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11) /* Deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853#define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
854#define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
855#define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
856#define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
857#define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
Brandon Philips26d507f2008-04-22 14:42:02 -0300858#define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* Deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859#define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
860#define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
861#define V4L2_CID_GAIN (V4L2_CID_BASE+19)
862#define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
863#define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
Brandon Philips26d507f2008-04-22 14:42:02 -0300864
865/* Deprecated, use V4L2_CID_PAN_RESET and V4L2_CID_TILT_RESET */
866#define V4L2_CID_HCENTER_DEPRECATED (V4L2_CID_BASE+22)
867#define V4L2_CID_VCENTER_DEPRECATED (V4L2_CID_BASE+23)
868
869#define V4L2_CID_POWER_LINE_FREQUENCY (V4L2_CID_BASE+24)
870enum v4l2_power_line_frequency {
871 V4L2_CID_POWER_LINE_FREQUENCY_DISABLED = 0,
872 V4L2_CID_POWER_LINE_FREQUENCY_50HZ = 1,
873 V4L2_CID_POWER_LINE_FREQUENCY_60HZ = 2,
874};
875#define V4L2_CID_HUE_AUTO (V4L2_CID_BASE+25)
876#define V4L2_CID_WHITE_BALANCE_TEMPERATURE (V4L2_CID_BASE+26)
877#define V4L2_CID_SHARPNESS (V4L2_CID_BASE+27)
878#define V4L2_CID_BACKLIGHT_COMPENSATION (V4L2_CID_BASE+28)
879#define V4L2_CID_LASTP1 (V4L2_CID_BASE+29) /* last CID + 1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
Hans Verkuil4f341712006-06-18 13:27:19 -0300881/* MPEG-class control IDs defined by V4L2 */
882#define V4L2_CID_MPEG_BASE (V4L2_CTRL_CLASS_MPEG | 0x900)
883#define V4L2_CID_MPEG_CLASS (V4L2_CTRL_CLASS_MPEG | 1)
884
885/* MPEG streams */
886#define V4L2_CID_MPEG_STREAM_TYPE (V4L2_CID_MPEG_BASE+0)
887enum v4l2_mpeg_stream_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300888 V4L2_MPEG_STREAM_TYPE_MPEG2_PS = 0, /* MPEG-2 program stream */
889 V4L2_MPEG_STREAM_TYPE_MPEG2_TS = 1, /* MPEG-2 transport stream */
890 V4L2_MPEG_STREAM_TYPE_MPEG1_SS = 2, /* MPEG-1 system stream */
891 V4L2_MPEG_STREAM_TYPE_MPEG2_DVD = 3, /* MPEG-2 DVD-compatible stream */
892 V4L2_MPEG_STREAM_TYPE_MPEG1_VCD = 4, /* MPEG-1 VCD-compatible stream */
893 V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD = 5, /* MPEG-2 SVCD-compatible stream */
Hans Verkuil4f341712006-06-18 13:27:19 -0300894};
895#define V4L2_CID_MPEG_STREAM_PID_PMT (V4L2_CID_MPEG_BASE+1)
896#define V4L2_CID_MPEG_STREAM_PID_AUDIO (V4L2_CID_MPEG_BASE+2)
897#define V4L2_CID_MPEG_STREAM_PID_VIDEO (V4L2_CID_MPEG_BASE+3)
898#define V4L2_CID_MPEG_STREAM_PID_PCR (V4L2_CID_MPEG_BASE+4)
899#define V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (V4L2_CID_MPEG_BASE+5)
900#define V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (V4L2_CID_MPEG_BASE+6)
Hans Verkuil8cbde942006-06-24 14:36:02 -0300901#define V4L2_CID_MPEG_STREAM_VBI_FMT (V4L2_CID_MPEG_BASE+7)
902enum v4l2_mpeg_stream_vbi_fmt {
903 V4L2_MPEG_STREAM_VBI_FMT_NONE = 0, /* No VBI in the MPEG stream */
904 V4L2_MPEG_STREAM_VBI_FMT_IVTV = 1, /* VBI in private packets, IVTV format */
905};
Hans Verkuil4f341712006-06-18 13:27:19 -0300906
907/* MPEG audio */
908#define V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ (V4L2_CID_MPEG_BASE+100)
909enum v4l2_mpeg_audio_sampling_freq {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300910 V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100 = 0,
911 V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000 = 1,
912 V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -0300913};
914#define V4L2_CID_MPEG_AUDIO_ENCODING (V4L2_CID_MPEG_BASE+101)
915enum v4l2_mpeg_audio_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300916 V4L2_MPEG_AUDIO_ENCODING_LAYER_1 = 0,
917 V4L2_MPEG_AUDIO_ENCODING_LAYER_2 = 1,
918 V4L2_MPEG_AUDIO_ENCODING_LAYER_3 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -0300919};
920#define V4L2_CID_MPEG_AUDIO_L1_BITRATE (V4L2_CID_MPEG_BASE+102)
921enum v4l2_mpeg_audio_l1_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300922 V4L2_MPEG_AUDIO_L1_BITRATE_32K = 0,
923 V4L2_MPEG_AUDIO_L1_BITRATE_64K = 1,
924 V4L2_MPEG_AUDIO_L1_BITRATE_96K = 2,
925 V4L2_MPEG_AUDIO_L1_BITRATE_128K = 3,
926 V4L2_MPEG_AUDIO_L1_BITRATE_160K = 4,
927 V4L2_MPEG_AUDIO_L1_BITRATE_192K = 5,
928 V4L2_MPEG_AUDIO_L1_BITRATE_224K = 6,
929 V4L2_MPEG_AUDIO_L1_BITRATE_256K = 7,
930 V4L2_MPEG_AUDIO_L1_BITRATE_288K = 8,
931 V4L2_MPEG_AUDIO_L1_BITRATE_320K = 9,
932 V4L2_MPEG_AUDIO_L1_BITRATE_352K = 10,
933 V4L2_MPEG_AUDIO_L1_BITRATE_384K = 11,
934 V4L2_MPEG_AUDIO_L1_BITRATE_416K = 12,
935 V4L2_MPEG_AUDIO_L1_BITRATE_448K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -0300936};
937#define V4L2_CID_MPEG_AUDIO_L2_BITRATE (V4L2_CID_MPEG_BASE+103)
938enum v4l2_mpeg_audio_l2_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300939 V4L2_MPEG_AUDIO_L2_BITRATE_32K = 0,
940 V4L2_MPEG_AUDIO_L2_BITRATE_48K = 1,
941 V4L2_MPEG_AUDIO_L2_BITRATE_56K = 2,
942 V4L2_MPEG_AUDIO_L2_BITRATE_64K = 3,
943 V4L2_MPEG_AUDIO_L2_BITRATE_80K = 4,
944 V4L2_MPEG_AUDIO_L2_BITRATE_96K = 5,
945 V4L2_MPEG_AUDIO_L2_BITRATE_112K = 6,
946 V4L2_MPEG_AUDIO_L2_BITRATE_128K = 7,
947 V4L2_MPEG_AUDIO_L2_BITRATE_160K = 8,
948 V4L2_MPEG_AUDIO_L2_BITRATE_192K = 9,
949 V4L2_MPEG_AUDIO_L2_BITRATE_224K = 10,
950 V4L2_MPEG_AUDIO_L2_BITRATE_256K = 11,
951 V4L2_MPEG_AUDIO_L2_BITRATE_320K = 12,
952 V4L2_MPEG_AUDIO_L2_BITRATE_384K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -0300953};
954#define V4L2_CID_MPEG_AUDIO_L3_BITRATE (V4L2_CID_MPEG_BASE+104)
955enum v4l2_mpeg_audio_l3_bitrate {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300956 V4L2_MPEG_AUDIO_L3_BITRATE_32K = 0,
957 V4L2_MPEG_AUDIO_L3_BITRATE_40K = 1,
958 V4L2_MPEG_AUDIO_L3_BITRATE_48K = 2,
959 V4L2_MPEG_AUDIO_L3_BITRATE_56K = 3,
960 V4L2_MPEG_AUDIO_L3_BITRATE_64K = 4,
961 V4L2_MPEG_AUDIO_L3_BITRATE_80K = 5,
962 V4L2_MPEG_AUDIO_L3_BITRATE_96K = 6,
963 V4L2_MPEG_AUDIO_L3_BITRATE_112K = 7,
964 V4L2_MPEG_AUDIO_L3_BITRATE_128K = 8,
965 V4L2_MPEG_AUDIO_L3_BITRATE_160K = 9,
966 V4L2_MPEG_AUDIO_L3_BITRATE_192K = 10,
967 V4L2_MPEG_AUDIO_L3_BITRATE_224K = 11,
968 V4L2_MPEG_AUDIO_L3_BITRATE_256K = 12,
969 V4L2_MPEG_AUDIO_L3_BITRATE_320K = 13,
Hans Verkuil4f341712006-06-18 13:27:19 -0300970};
971#define V4L2_CID_MPEG_AUDIO_MODE (V4L2_CID_MPEG_BASE+105)
972enum v4l2_mpeg_audio_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300973 V4L2_MPEG_AUDIO_MODE_STEREO = 0,
974 V4L2_MPEG_AUDIO_MODE_JOINT_STEREO = 1,
975 V4L2_MPEG_AUDIO_MODE_DUAL = 2,
976 V4L2_MPEG_AUDIO_MODE_MONO = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -0300977};
978#define V4L2_CID_MPEG_AUDIO_MODE_EXTENSION (V4L2_CID_MPEG_BASE+106)
979enum v4l2_mpeg_audio_mode_extension {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300980 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4 = 0,
981 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8 = 1,
982 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12 = 2,
983 V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -0300984};
985#define V4L2_CID_MPEG_AUDIO_EMPHASIS (V4L2_CID_MPEG_BASE+107)
986enum v4l2_mpeg_audio_emphasis {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300987 V4L2_MPEG_AUDIO_EMPHASIS_NONE = 0,
988 V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS = 1,
989 V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17 = 2,
Hans Verkuil4f341712006-06-18 13:27:19 -0300990};
991#define V4L2_CID_MPEG_AUDIO_CRC (V4L2_CID_MPEG_BASE+108)
992enum v4l2_mpeg_audio_crc {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -0300993 V4L2_MPEG_AUDIO_CRC_NONE = 0,
994 V4L2_MPEG_AUDIO_CRC_CRC16 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -0300995};
Hans Verkuil5eee72e2007-04-27 12:31:00 -0300996#define V4L2_CID_MPEG_AUDIO_MUTE (V4L2_CID_MPEG_BASE+109)
Hans Verkuil4f341712006-06-18 13:27:19 -0300997
998/* MPEG video */
999#define V4L2_CID_MPEG_VIDEO_ENCODING (V4L2_CID_MPEG_BASE+200)
1000enum v4l2_mpeg_video_encoding {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001001 V4L2_MPEG_VIDEO_ENCODING_MPEG_1 = 0,
1002 V4L2_MPEG_VIDEO_ENCODING_MPEG_2 = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001003};
1004#define V4L2_CID_MPEG_VIDEO_ASPECT (V4L2_CID_MPEG_BASE+201)
1005enum v4l2_mpeg_video_aspect {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001006 V4L2_MPEG_VIDEO_ASPECT_1x1 = 0,
1007 V4L2_MPEG_VIDEO_ASPECT_4x3 = 1,
1008 V4L2_MPEG_VIDEO_ASPECT_16x9 = 2,
1009 V4L2_MPEG_VIDEO_ASPECT_221x100 = 3,
Hans Verkuil4f341712006-06-18 13:27:19 -03001010};
1011#define V4L2_CID_MPEG_VIDEO_B_FRAMES (V4L2_CID_MPEG_BASE+202)
1012#define V4L2_CID_MPEG_VIDEO_GOP_SIZE (V4L2_CID_MPEG_BASE+203)
1013#define V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (V4L2_CID_MPEG_BASE+204)
1014#define V4L2_CID_MPEG_VIDEO_PULLDOWN (V4L2_CID_MPEG_BASE+205)
1015#define V4L2_CID_MPEG_VIDEO_BITRATE_MODE (V4L2_CID_MPEG_BASE+206)
1016enum v4l2_mpeg_video_bitrate_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001017 V4L2_MPEG_VIDEO_BITRATE_MODE_VBR = 0,
1018 V4L2_MPEG_VIDEO_BITRATE_MODE_CBR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001019};
1020#define V4L2_CID_MPEG_VIDEO_BITRATE (V4L2_CID_MPEG_BASE+207)
1021#define V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (V4L2_CID_MPEG_BASE+208)
1022#define V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (V4L2_CID_MPEG_BASE+209)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001023#define V4L2_CID_MPEG_VIDEO_MUTE (V4L2_CID_MPEG_BASE+210)
1024#define V4L2_CID_MPEG_VIDEO_MUTE_YUV (V4L2_CID_MPEG_BASE+211)
Hans Verkuil4f341712006-06-18 13:27:19 -03001025
1026/* MPEG-class control IDs specific to the CX2584x driver as defined by V4L2 */
1027#define V4L2_CID_MPEG_CX2341X_BASE (V4L2_CTRL_CLASS_MPEG | 0x1000)
1028#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+0)
1029enum v4l2_mpeg_cx2341x_video_spatial_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001030 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL = 0,
1031 V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001032};
1033#define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+1)
1034#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+2)
1035enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001036 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF = 0,
1037 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
1038 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT = 2,
1039 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE = 3,
1040 V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001041};
1042#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+3)
1043enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001044 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF = 0,
1045 V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001046};
1047#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE (V4L2_CID_MPEG_CX2341X_BASE+4)
1048enum v4l2_mpeg_cx2341x_video_temporal_filter_mode {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001049 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL = 0,
1050 V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO = 1,
Hans Verkuil4f341712006-06-18 13:27:19 -03001051};
1052#define V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (V4L2_CID_MPEG_CX2341X_BASE+5)
1053#define V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE (V4L2_CID_MPEG_CX2341X_BASE+6)
1054enum v4l2_mpeg_cx2341x_video_median_filter_type {
Hans Verkuil0ccac4a2006-06-23 15:52:50 -03001055 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF = 0,
1056 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR = 1,
1057 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT = 2,
1058 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT = 3,
1059 V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG = 4,
Hans Verkuil4f341712006-06-18 13:27:19 -03001060};
1061#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+7)
1062#define V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+8)
1063#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (V4L2_CID_MPEG_CX2341X_BASE+9)
1064#define V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (V4L2_CID_MPEG_CX2341X_BASE+10)
Hans Verkuil5eee72e2007-04-27 12:31:00 -03001065#define V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (V4L2_CID_MPEG_CX2341X_BASE+11)
Hans Verkuil4f341712006-06-18 13:27:19 -03001066
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067/*
1068 * T U N I N G
1069 */
1070struct v4l2_tuner
1071{
1072 __u32 index;
1073 __u8 name[32];
1074 enum v4l2_tuner_type type;
1075 __u32 capability;
1076 __u32 rangelow;
1077 __u32 rangehigh;
1078 __u32 rxsubchans;
1079 __u32 audmode;
1080 __s32 signal;
1081 __s32 afc;
1082 __u32 reserved[4];
1083};
1084
1085struct v4l2_modulator
1086{
1087 __u32 index;
1088 __u8 name[32];
1089 __u32 capability;
1090 __u32 rangelow;
1091 __u32 rangehigh;
1092 __u32 txsubchans;
1093 __u32 reserved[4];
1094};
1095
1096/* Flags for the 'capability' field */
1097#define V4L2_TUNER_CAP_LOW 0x0001
1098#define V4L2_TUNER_CAP_NORM 0x0002
1099#define V4L2_TUNER_CAP_STEREO 0x0010
1100#define V4L2_TUNER_CAP_LANG2 0x0020
1101#define V4L2_TUNER_CAP_SAP 0x0020
1102#define V4L2_TUNER_CAP_LANG1 0x0040
1103
1104/* Flags for the 'rxsubchans' field */
1105#define V4L2_TUNER_SUB_MONO 0x0001
1106#define V4L2_TUNER_SUB_STEREO 0x0002
1107#define V4L2_TUNER_SUB_LANG2 0x0004
1108#define V4L2_TUNER_SUB_SAP 0x0004
1109#define V4L2_TUNER_SUB_LANG1 0x0008
1110
1111/* Values for the 'audmode' field */
1112#define V4L2_TUNER_MODE_MONO 0x0000
1113#define V4L2_TUNER_MODE_STEREO 0x0001
1114#define V4L2_TUNER_MODE_LANG2 0x0002
1115#define V4L2_TUNER_MODE_SAP 0x0002
1116#define V4L2_TUNER_MODE_LANG1 0x0003
Hans Verkuil301e22d2006-03-18 17:15:00 -03001117#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
1119struct v4l2_frequency
1120{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001121 __u32 tuner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 enum v4l2_tuner_type type;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001123 __u32 frequency;
1124 __u32 reserved[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125};
1126
1127/*
1128 * A U D I O
1129 */
1130struct v4l2_audio
1131{
1132 __u32 index;
1133 __u8 name[32];
1134 __u32 capability;
1135 __u32 mode;
1136 __u32 reserved[2];
1137};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -03001138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139/* Flags for the 'capability' field */
1140#define V4L2_AUDCAP_STEREO 0x00001
1141#define V4L2_AUDCAP_AVL 0x00002
1142
1143/* Flags for the 'mode' field */
1144#define V4L2_AUDMODE_AVL 0x00001
1145
1146struct v4l2_audioout
1147{
1148 __u32 index;
1149 __u8 name[32];
1150 __u32 capability;
1151 __u32 mode;
1152 __u32 reserved[2];
1153};
1154
1155/*
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001156 * M P E G S E R V I C E S
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001157 *
1158 * NOTE: EXPERIMENTAL API
1159 */
1160#if 1
1161#define V4L2_ENC_IDX_FRAME_I (0)
1162#define V4L2_ENC_IDX_FRAME_P (1)
1163#define V4L2_ENC_IDX_FRAME_B (2)
1164#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1165
1166struct v4l2_enc_idx_entry {
1167 __u64 offset;
1168 __u64 pts;
1169 __u32 length;
1170 __u32 flags;
1171 __u32 reserved[2];
1172};
1173
1174#define V4L2_ENC_IDX_ENTRIES (64)
1175struct v4l2_enc_idx {
1176 __u32 entries;
1177 __u32 entries_cap;
1178 __u32 reserved[4];
1179 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1180};
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001181
1182
1183#define V4L2_ENC_CMD_START (0)
1184#define V4L2_ENC_CMD_STOP (1)
1185#define V4L2_ENC_CMD_PAUSE (2)
1186#define V4L2_ENC_CMD_RESUME (3)
1187
1188/* Flags for V4L2_ENC_CMD_STOP */
1189#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1190
1191struct v4l2_encoder_cmd {
1192 __u32 cmd;
1193 __u32 flags;
1194 union {
1195 struct {
1196 __u32 data[8];
1197 } raw;
1198 };
1199};
1200
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001201#endif
1202
1203
1204/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 * D A T A S E R V I C E S ( V B I )
1206 *
1207 * Data services API by Michael Schimek
1208 */
1209
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001210/* Raw VBI */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211struct v4l2_vbi_format
1212{
1213 __u32 sampling_rate; /* in 1 Hz */
1214 __u32 offset;
1215 __u32 samples_per_line;
1216 __u32 sample_format; /* V4L2_PIX_FMT_* */
1217 __s32 start[2];
1218 __u32 count[2];
1219 __u32 flags; /* V4L2_VBI_* */
1220 __u32 reserved[2]; /* must be zero */
1221};
1222
1223/* VBI flags */
1224#define V4L2_VBI_UNSYNC (1<< 0)
1225#define V4L2_VBI_INTERLACED (1<< 1)
1226
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001227/* Sliced VBI
1228 *
1229 * This implements is a proposal V4L2 API to allow SLICED VBI
1230 * required for some hardware encoders. It should change without
1231 * notice in the definitive implementation.
1232 */
1233
1234struct v4l2_sliced_vbi_format
1235{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001236 __u16 service_set;
1237 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1238 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001239 (equals frame lines 313-336 for 625 line video
1240 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001241 __u16 service_lines[2][24];
1242 __u32 io_size;
1243 __u32 reserved[2]; /* must be zero */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001244};
1245
Mauro Carvalho Chehab4d0dddb2006-01-23 17:11:07 -02001246/* Teletext World System Teletext
1247 (WST), defined on ITU-R BT.653-2 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001248#define V4L2_SLICED_TELETEXT_B (0x0001)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001249/* Video Program System, defined on ETS 300 231*/
Hans Verkuil9bc74002006-03-29 18:02:51 -03001250#define V4L2_SLICED_VPS (0x0400)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001251/* Closed Caption, defined on EIA-608 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001252#define V4L2_SLICED_CAPTION_525 (0x1000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001253/* Wide Screen System, defined on ITU-R BT1119.1 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001254#define V4L2_SLICED_WSS_625 (0x4000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001255
Hans Verkuil9bc74002006-03-29 18:02:51 -03001256#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1257#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001258
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001259struct v4l2_sliced_vbi_cap
1260{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001261 __u16 service_set;
1262 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1263 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001264 (equals frame lines 313-336 for 625 line video
1265 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001266 __u16 service_lines[2][24];
Hans Verkuil1739ade2006-08-26 03:05:17 -03001267 enum v4l2_buf_type type;
1268 __u32 reserved[3]; /* must be 0 */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001269};
1270
1271struct v4l2_sliced_vbi_data
1272{
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001273 __u32 id;
1274 __u32 field; /* 0: first field, 1: second field */
1275 __u32 line; /* 1-23 */
1276 __u32 reserved; /* must be 0 */
1277 __u8 data[48];
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001278};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279
1280/*
1281 * A G G R E G A T E S T R U C T U R E S
1282 */
1283
1284/* Stream data format
1285 */
1286struct v4l2_format
1287{
1288 enum v4l2_buf_type type;
1289 union
1290 {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001291 struct v4l2_pix_format pix; // V4L2_BUF_TYPE_VIDEO_CAPTURE
1292 struct v4l2_window win; // V4L2_BUF_TYPE_VIDEO_OVERLAY
1293 struct v4l2_vbi_format vbi; // V4L2_BUF_TYPE_VBI_CAPTURE
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001294 struct v4l2_sliced_vbi_format sliced; // V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001295 __u8 raw_data[200]; // user-defined
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 } fmt;
1297};
1298
1299
1300/* Stream type-dependent parameters
1301 */
1302struct v4l2_streamparm
1303{
1304 enum v4l2_buf_type type;
1305 union
1306 {
1307 struct v4l2_captureparm capture;
1308 struct v4l2_outputparm output;
1309 __u8 raw_data[200]; /* user-defined */
1310 } parm;
1311};
1312
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313/*
Trent Piepho52ebc762007-01-23 22:38:13 -03001314 * A D V A N C E D D E B U G G I N G
Hans Verkuilf3502b82007-02-23 21:16:01 -03001315 *
1316 * NOTE: EXPERIMENTAL API
Trent Piepho52ebc762007-01-23 22:38:13 -03001317 */
1318
1319/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001320
Hans Verkuilf3502b82007-02-23 21:16:01 -03001321#define V4L2_CHIP_MATCH_HOST 0 /* Match against chip ID on host (0 for the host) */
1322#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver ID */
1323#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001324
Trent Piepho52ebc762007-01-23 22:38:13 -03001325struct v4l2_register {
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001326 __u32 match_type; /* Match type */
1327 __u32 match_chip; /* Match this chip, meaning determined by match_type */
Trent Piephoe7b58f52007-01-30 22:47:18 -03001328 __u64 reg;
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001329 __u64 val;
Trent Piepho52ebc762007-01-23 22:38:13 -03001330};
1331
Hans Verkuil3434eb72007-04-27 12:31:08 -03001332/* VIDIOC_G_CHIP_IDENT */
1333struct v4l2_chip_ident {
1334 __u32 match_type; /* Match type */
1335 __u32 match_chip; /* Match this chip, meaning determined by match_type */
1336 __u32 ident; /* chip identifier as specified in <media/v4l2-chip-ident.h> */
1337 __u32 revision; /* chip revision, chip specific */
1338};
1339
Trent Piepho52ebc762007-01-23 22:38:13 -03001340/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 * 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
1342 *
1343 */
1344#define VIDIOC_QUERYCAP _IOR ('V', 0, struct v4l2_capability)
1345#define VIDIOC_RESERVED _IO ('V', 1)
1346#define VIDIOC_ENUM_FMT _IOWR ('V', 2, struct v4l2_fmtdesc)
1347#define VIDIOC_G_FMT _IOWR ('V', 4, struct v4l2_format)
1348#define VIDIOC_S_FMT _IOWR ('V', 5, struct v4l2_format)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349#define VIDIOC_REQBUFS _IOWR ('V', 8, struct v4l2_requestbuffers)
1350#define VIDIOC_QUERYBUF _IOWR ('V', 9, struct v4l2_buffer)
1351#define VIDIOC_G_FBUF _IOR ('V', 10, struct v4l2_framebuffer)
1352#define VIDIOC_S_FBUF _IOW ('V', 11, struct v4l2_framebuffer)
1353#define VIDIOC_OVERLAY _IOW ('V', 14, int)
1354#define VIDIOC_QBUF _IOWR ('V', 15, struct v4l2_buffer)
1355#define VIDIOC_DQBUF _IOWR ('V', 17, struct v4l2_buffer)
1356#define VIDIOC_STREAMON _IOW ('V', 18, int)
1357#define VIDIOC_STREAMOFF _IOW ('V', 19, int)
1358#define VIDIOC_G_PARM _IOWR ('V', 21, struct v4l2_streamparm)
1359#define VIDIOC_S_PARM _IOWR ('V', 22, struct v4l2_streamparm)
1360#define VIDIOC_G_STD _IOR ('V', 23, v4l2_std_id)
1361#define VIDIOC_S_STD _IOW ('V', 24, v4l2_std_id)
1362#define VIDIOC_ENUMSTD _IOWR ('V', 25, struct v4l2_standard)
1363#define VIDIOC_ENUMINPUT _IOWR ('V', 26, struct v4l2_input)
1364#define VIDIOC_G_CTRL _IOWR ('V', 27, struct v4l2_control)
1365#define VIDIOC_S_CTRL _IOWR ('V', 28, struct v4l2_control)
1366#define VIDIOC_G_TUNER _IOWR ('V', 29, struct v4l2_tuner)
1367#define VIDIOC_S_TUNER _IOW ('V', 30, struct v4l2_tuner)
1368#define VIDIOC_G_AUDIO _IOR ('V', 33, struct v4l2_audio)
1369#define VIDIOC_S_AUDIO _IOW ('V', 34, struct v4l2_audio)
1370#define VIDIOC_QUERYCTRL _IOWR ('V', 36, struct v4l2_queryctrl)
1371#define VIDIOC_QUERYMENU _IOWR ('V', 37, struct v4l2_querymenu)
1372#define VIDIOC_G_INPUT _IOR ('V', 38, int)
1373#define VIDIOC_S_INPUT _IOWR ('V', 39, int)
1374#define VIDIOC_G_OUTPUT _IOR ('V', 46, int)
1375#define VIDIOC_S_OUTPUT _IOWR ('V', 47, int)
1376#define VIDIOC_ENUMOUTPUT _IOWR ('V', 48, struct v4l2_output)
1377#define VIDIOC_G_AUDOUT _IOR ('V', 49, struct v4l2_audioout)
1378#define VIDIOC_S_AUDOUT _IOW ('V', 50, struct v4l2_audioout)
1379#define VIDIOC_G_MODULATOR _IOWR ('V', 54, struct v4l2_modulator)
1380#define VIDIOC_S_MODULATOR _IOW ('V', 55, struct v4l2_modulator)
1381#define VIDIOC_G_FREQUENCY _IOWR ('V', 56, struct v4l2_frequency)
1382#define VIDIOC_S_FREQUENCY _IOW ('V', 57, struct v4l2_frequency)
1383#define VIDIOC_CROPCAP _IOWR ('V', 58, struct v4l2_cropcap)
1384#define VIDIOC_G_CROP _IOWR ('V', 59, struct v4l2_crop)
1385#define VIDIOC_S_CROP _IOW ('V', 60, struct v4l2_crop)
1386#define VIDIOC_G_JPEGCOMP _IOR ('V', 61, struct v4l2_jpegcompression)
1387#define VIDIOC_S_JPEGCOMP _IOW ('V', 62, struct v4l2_jpegcompression)
1388#define VIDIOC_QUERYSTD _IOR ('V', 63, v4l2_std_id)
1389#define VIDIOC_TRY_FMT _IOWR ('V', 64, struct v4l2_format)
1390#define VIDIOC_ENUMAUDIO _IOWR ('V', 65, struct v4l2_audio)
1391#define VIDIOC_ENUMAUDOUT _IOWR ('V', 66, struct v4l2_audioout)
1392#define VIDIOC_G_PRIORITY _IOR ('V', 67, enum v4l2_priority)
1393#define VIDIOC_S_PRIORITY _IOW ('V', 68, enum v4l2_priority)
Hans Verkuil616b8b62006-09-01 18:36:48 -03001394#define VIDIOC_G_SLICED_VBI_CAP _IOWR ('V', 69, struct v4l2_sliced_vbi_cap)
Hans Verkuil299392b2005-11-08 21:37:42 -08001395#define VIDIOC_LOG_STATUS _IO ('V', 70)
Hans Verkuil4f341712006-06-18 13:27:19 -03001396#define VIDIOC_G_EXT_CTRLS _IOWR ('V', 71, struct v4l2_ext_controls)
1397#define VIDIOC_S_EXT_CTRLS _IOWR ('V', 72, struct v4l2_ext_controls)
1398#define VIDIOC_TRY_EXT_CTRLS _IOWR ('V', 73, struct v4l2_ext_controls)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001399#if 1
Laurent Pinchart92b2db02006-09-28 13:42:05 -03001400#define VIDIOC_ENUM_FRAMESIZES _IOWR ('V', 74, struct v4l2_frmsizeenum)
1401#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR ('V', 75, struct v4l2_frmivalenum)
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001402#define VIDIOC_G_ENC_INDEX _IOR ('V', 76, struct v4l2_enc_idx)
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001403#define VIDIOC_ENCODER_CMD _IOWR ('V', 77, struct v4l2_encoder_cmd)
1404#define VIDIOC_TRY_ENCODER_CMD _IOWR ('V', 78, struct v4l2_encoder_cmd)
Hans Verkuilf3502b82007-02-23 21:16:01 -03001405
1406/* Experimental, only implemented if CONFIG_VIDEO_ADV_DEBUG is defined */
1407#define VIDIOC_DBG_S_REGISTER _IOW ('V', 79, struct v4l2_register)
1408#define VIDIOC_DBG_G_REGISTER _IOWR ('V', 80, struct v4l2_register)
Hans Verkuil3434eb72007-04-27 12:31:08 -03001409
1410#define VIDIOC_G_CHIP_IDENT _IOWR ('V', 81, struct v4l2_chip_ident)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001411#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001413#ifdef __OLD_VIDIOC_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414/* for compatibility, will go away some day */
1415#define VIDIOC_OVERLAY_OLD _IOWR ('V', 14, int)
1416#define VIDIOC_S_PARM_OLD _IOW ('V', 22, struct v4l2_streamparm)
1417#define VIDIOC_S_CTRL_OLD _IOW ('V', 28, struct v4l2_control)
1418#define VIDIOC_G_AUDIO_OLD _IOWR ('V', 33, struct v4l2_audio)
1419#define VIDIOC_G_AUDOUT_OLD _IOWR ('V', 49, struct v4l2_audioout)
1420#define VIDIOC_CROPCAP_OLD _IOR ('V', 58, struct v4l2_cropcap)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001421#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
1423#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1424
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425#endif /* __LINUX_VIDEODEV2_H */
1426
1427/*
1428 * Local variables:
1429 * c-basic-offset: 8
1430 * End:
1431 */