Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef __LINUX_VIDEODEV2_H
2#define __LINUX_VIDEODEV2_H
3/*
4 * Video for Linux Two
5 *
6 * Header file for v4l or V4L2 drivers and applications, for
7 * Linux kernels 2.2.x or 2.4.x.
8 *
9 * See http://bytesex.org/v4l/ for API specs and other
10 * v4l2 documentation.
11 *
12 * Author: Bill Dirks <bdirks@pacbell.net>
13 * Justin Schoeman
14 * et al.
15 */
16#ifdef __KERNEL__
17#include <linux/time.h> /* need struct timeval */
18#endif
19#include <linux/compiler.h> /* need __user */
20
21/*
22 * M I S C E L L A N E O U S
23 */
24
25/* Four-character-code (FOURCC) */
26#define v4l2_fourcc(a,b,c,d)\
27 (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))
28
29/*
30 * E N U M S
31 */
32enum v4l2_field {
33 V4L2_FIELD_ANY = 0, /* driver can choose from none,
34 top, bottom, interlaced
35 depending on whatever it thinks
36 is approximate ... */
37 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
38 V4L2_FIELD_TOP = 2, /* top field only */
39 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
40 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
41 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
42 buffer, top-bottom order */
43 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
44 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
45 separate buffers */
46};
47#define V4L2_FIELD_HAS_TOP(field) \
48 ((field) == V4L2_FIELD_TOP ||\
49 (field) == V4L2_FIELD_INTERLACED ||\
50 (field) == V4L2_FIELD_SEQ_TB ||\
51 (field) == V4L2_FIELD_SEQ_BT)
52#define V4L2_FIELD_HAS_BOTTOM(field) \
53 ((field) == V4L2_FIELD_BOTTOM ||\
54 (field) == V4L2_FIELD_INTERLACED ||\
55 (field) == V4L2_FIELD_SEQ_TB ||\
56 (field) == V4L2_FIELD_SEQ_BT)
57#define V4L2_FIELD_HAS_BOTH(field) \
58 ((field) == V4L2_FIELD_INTERLACED ||\
59 (field) == V4L2_FIELD_SEQ_TB ||\
60 (field) == V4L2_FIELD_SEQ_BT)
61
62enum v4l2_buf_type {
63 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
64 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
65 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
66 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
67 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
68#if 1
69 /* Experimental Sliced VBI */
70 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
71 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
72#endif
73 V4L2_BUF_TYPE_PRIVATE = 0x80,
74};
75
76enum v4l2_ctrl_type {
77 V4L2_CTRL_TYPE_INTEGER = 1,
78 V4L2_CTRL_TYPE_BOOLEAN = 2,
79 V4L2_CTRL_TYPE_MENU = 3,
80 V4L2_CTRL_TYPE_BUTTON = 4,
81};
82
83enum v4l2_tuner_type {
84 V4L2_TUNER_RADIO = 1,
85 V4L2_TUNER_ANALOG_TV = 2,
86 V4L2_TUNER_DIGITAL_TV = 3,
87};
88
89enum v4l2_memory {
90 V4L2_MEMORY_MMAP = 1,
91 V4L2_MEMORY_USERPTR = 2,
92 V4L2_MEMORY_OVERLAY = 3,
93};
94
95/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
96enum v4l2_colorspace {
97 /* ITU-R 601 -- broadcast NTSC/PAL */
98 V4L2_COLORSPACE_SMPTE170M = 1,
99
100 /* 1125-Line (US) HDTV */
101 V4L2_COLORSPACE_SMPTE240M = 2,
102
103 /* HD and modern captures. */
104 V4L2_COLORSPACE_REC709 = 3,
105
106 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
107 V4L2_COLORSPACE_BT878 = 4,
108
109 /* These should be useful. Assume 601 extents. */
110 V4L2_COLORSPACE_470_SYSTEM_M = 5,
111 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
112
113 /* I know there will be cameras that send this. So, this is
114 * unspecified chromaticities and full 0-255 on each of the
115 * Y'CbCr components
116 */
117 V4L2_COLORSPACE_JPEG = 7,
118
119 /* For RGB colourspaces, this is probably a good start. */
120 V4L2_COLORSPACE_SRGB = 8,
121};
122
123enum v4l2_priority {
124 V4L2_PRIORITY_UNSET = 0, /* not initialized */
125 V4L2_PRIORITY_BACKGROUND = 1,
126 V4L2_PRIORITY_INTERACTIVE = 2,
127 V4L2_PRIORITY_RECORD = 3,
128 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
129};
130
131struct v4l2_rect {
132 __s32 left;
133 __s32 top;
134 __s32 width;
135 __s32 height;
136};
137
138struct v4l2_fract {
139 __u32 numerator;
140 __u32 denominator;
141};
142
143/*
144 * D R I V E R C A P A B I L I T I E S
145 */
146struct v4l2_capability
147{
148 __u8 driver[16]; /* i.e. "bttv" */
149 __u8 card[32]; /* i.e. "Hauppauge WinTV" */
150 __u8 bus_info[32]; /* "PCI:" + pci_name(pci_dev) */
151 __u32 version; /* should use KERNEL_VERSION() */
152 __u32 capabilities; /* Device capabilities */
153 __u32 reserved[4];
154};
155
156/* Values for 'capabilities' field */
157#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
158#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
159#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
160#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
161#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
162#if 1
163#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
164#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
165#endif
166#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
167
168#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
169#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
170#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
171
172#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
173#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
174#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
175
176/*
177 * V I D E O I M A G E F O R M A T
178 */
179
180struct v4l2_pix_format
181{
182 __u32 width;
183 __u32 height;
184 __u32 pixelformat;
185 enum v4l2_field field;
186 __u32 bytesperline; /* for padding, zero if unused */
187 __u32 sizeimage;
188 enum v4l2_colorspace colorspace;
189 __u32 priv; /* private data, depends on pixelformat */
190};
191
192/* Pixel format FOURCC depth Description */
193#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R','G','B','1') /* 8 RGB-3-3-2 */
194#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R','G','B','O') /* 16 RGB-5-5-5 */
195#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R','G','B','P') /* 16 RGB-5-6-5 */
196#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16 RGB-5-5-5 BE */
197#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16 RGB-5-6-5 BE */
198#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B','G','R','3') /* 24 BGR-8-8-8 */
199#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R','G','B','3') /* 24 RGB-8-8-8 */
200#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B','G','R','4') /* 32 BGR-8-8-8-8 */
201#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R','G','B','4') /* 32 RGB-8-8-8-8 */
202#define V4L2_PIX_FMT_GREY v4l2_fourcc('G','R','E','Y') /* 8 Greyscale */
203#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y','V','U','9') /* 9 YVU 4:1:0 */
204#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y','V','1','2') /* 12 YVU 4:2:0 */
205#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y','U','Y','V') /* 16 YUV 4:2:2 */
206#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U','Y','V','Y') /* 16 YUV 4:2:2 */
207#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16 YVU422 planar */
208#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16 YVU411 planar */
209#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y','4','1','P') /* 12 YUV 4:1:1 */
210
211/* two planes -- one Y, one Cr + Cb interleaved */
212#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N','V','1','2') /* 12 Y/CbCr 4:2:0 */
213#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N','V','2','1') /* 12 Y/CrCb 4:2:0 */
214
215/* The following formats are not defined in the V4L2 specification */
216#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y','U','V','9') /* 9 YUV 4:1:0 */
217#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y','U','1','2') /* 12 YUV 4:2:0 */
218#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y','Y','U','V') /* 16 YUV 4:2:2 */
219#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H','I','2','4') /* 8 8-bit color */
220
221/* see http://www.siliconimaging.com/RGB%20Bayer.htm */
222#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B','A','8','1') /* 8 BGBG.. GRGR.. */
223
224/* compressed formats */
225#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M','J','P','G') /* Motion-JPEG */
226#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J','P','E','G') /* JFIF JPEG */
227#define V4L2_PIX_FMT_DV v4l2_fourcc('d','v','s','d') /* 1394 */
228#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M','P','E','G') /* MPEG */
229
230/* Vendor-specific formats */
231#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W','N','V','A') /* Winnov hw compress */
232#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S','9','1','0') /* SN9C10x compression */
233#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') /* pwc older webcam */
234#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') /* pwc newer webcam */
235
236/*
237 * F O R M A T E N U M E R A T I O N
238 */
239struct v4l2_fmtdesc
240{
241 __u32 index; /* Format number */
242 enum v4l2_buf_type type; /* buffer type */
243 __u32 flags;
244 __u8 description[32]; /* Description string */
245 __u32 pixelformat; /* Format fourcc */
246 __u32 reserved[4];
247};
248
249#define V4L2_FMT_FLAG_COMPRESSED 0x0001
250
251
252/*
253 * T I M E C O D E
254 */
255struct v4l2_timecode
256{
257 __u32 type;
258 __u32 flags;
259 __u8 frames;
260 __u8 seconds;
261 __u8 minutes;
262 __u8 hours;
263 __u8 userbits[4];
264};
265
266/* Type */
267#define V4L2_TC_TYPE_24FPS 1
268#define V4L2_TC_TYPE_25FPS 2
269#define V4L2_TC_TYPE_30FPS 3
270#define V4L2_TC_TYPE_50FPS 4
271#define V4L2_TC_TYPE_60FPS 5
272
273/* Flags */
274#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
275#define V4L2_TC_FLAG_COLORFRAME 0x0002
276#define V4L2_TC_USERBITS_field 0x000C
277#define V4L2_TC_USERBITS_USERDEFINED 0x0000
278#define V4L2_TC_USERBITS_8BITCHARS 0x0008
279/* The above is based on SMPTE timecodes */
280
281
282/*
283 * 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
284 *
285 * ### WARNING: this is still work-in-progress right now, most likely
286 * ### there will be some incompatible changes.
287 *
288 */
289
290
291enum v4l2_bitrate_mode {
292 V4L2_BITRATE_NONE = 0, /* not specified */
293 V4L2_BITRATE_CBR, /* constant bitrate */
294 V4L2_BITRATE_VBR, /* variable bitrate */
295};
296struct v4l2_bitrate {
297 /* rates are specified in kbit/sec */
298 enum v4l2_bitrate_mode mode;
299 __u32 min;
300 __u32 target; /* use this one for CBR */
301 __u32 max;
302};
303
304enum v4l2_mpeg_streamtype {
305 V4L2_MPEG_SS_1, /* MPEG-1 system stream */
306 V4L2_MPEG_PS_2, /* MPEG-2 program stream */
307 V4L2_MPEG_TS_2, /* MPEG-2 transport stream */
308 V4L2_MPEG_PS_DVD, /* MPEG-2 program stream with DVD header fixups */
309};
310enum v4l2_mpeg_audiotype {
311 V4L2_MPEG_AU_2_I, /* MPEG-2 layer 1 */
312 V4L2_MPEG_AU_2_II, /* MPEG-2 layer 2 */
313 V4L2_MPEG_AU_2_III, /* MPEG-2 layer 3 */
314 V4L2_MPEG_AC3, /* AC3 */
315 V4L2_MPEG_LPCM, /* LPCM */
316};
317enum v4l2_mpeg_videotype {
318 V4L2_MPEG_VI_1, /* MPEG-1 */
319 V4L2_MPEG_VI_2, /* MPEG-2 */
320};
321enum v4l2_mpeg_aspectratio {
322 V4L2_MPEG_ASPECT_SQUARE = 1, /* square pixel */
323 V4L2_MPEG_ASPECT_4_3 = 2, /* 4 : 3 */
324 V4L2_MPEG_ASPECT_16_9 = 3, /* 16 : 9 */
325 V4L2_MPEG_ASPECT_1_221 = 4, /* 1 : 2,21 */
326};
327
328struct v4l2_mpeg_compression {
329 /* general */
330 enum v4l2_mpeg_streamtype st_type;
331 struct v4l2_bitrate st_bitrate;
332
333 /* transport streams */
334 __u16 ts_pid_pmt;
335 __u16 ts_pid_audio;
336 __u16 ts_pid_video;
337 __u16 ts_pid_pcr;
338
339 /* program stream */
340 __u16 ps_size;
341 __u16 reserved_1; /* align */
342
343 /* audio */
344 enum v4l2_mpeg_audiotype au_type;
345 struct v4l2_bitrate au_bitrate;
346 __u32 au_sample_rate;
347 __u8 au_pesid;
348 __u8 reserved_2[3]; /* align */
349
350 /* video */
351 enum v4l2_mpeg_videotype vi_type;
352 enum v4l2_mpeg_aspectratio vi_aspect_ratio;
353 struct v4l2_bitrate vi_bitrate;
354 __u32 vi_frame_rate;
355 __u16 vi_frames_per_gop;
356 __u16 vi_bframes_count;
357 __u8 vi_pesid;
358 __u8 reserved_3[3]; /* align */
359
360 /* misc flags */
361 __u32 closed_gops:1;
362 __u32 pulldown:1;
363 __u32 reserved_4:30; /* align */
364
365 /* I don't expect the above being perfect yet ;) */
366 __u32 reserved_5[8];
367};
368
369struct v4l2_jpegcompression
370{
371 int quality;
372
373 int APPn; /* Number of APP segment to be written,
374 * must be 0..15 */
375 int APP_len; /* Length of data in JPEG APPn segment */
376 char APP_data[60]; /* Data in the JPEG APPn segment. */
377
378 int COM_len; /* Length of data in JPEG COM segment */
379 char COM_data[60]; /* Data in JPEG COM segment */
380
381 __u32 jpeg_markers; /* Which markers should go into the JPEG
382 * output. Unless you exactly know what
383 * you do, leave them untouched.
384 * Inluding less markers will make the
385 * resulting code smaller, but there will
386 * be fewer aplications which can read it.
387 * The presence of the APP and COM marker
388 * is influenced by APP_len and COM_len
389 * ONLY, not by this property! */
390
391#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
392#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
393#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
394#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
395#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
396 * allways use APP0 */
397};
398
399
400/*
401 * M E M O R Y - M A P P I N G B U F F E R S
402 */
403struct v4l2_requestbuffers
404{
405 __u32 count;
406 enum v4l2_buf_type type;
407 enum v4l2_memory memory;
408 __u32 reserved[2];
409};
410
411struct v4l2_buffer
412{
413 __u32 index;
414 enum v4l2_buf_type type;
415 __u32 bytesused;
416 __u32 flags;
417 enum v4l2_field field;
418 struct timeval timestamp;
419 struct v4l2_timecode timecode;
420 __u32 sequence;
421
422 /* memory location */
423 enum v4l2_memory memory;
424 union {
425 __u32 offset;
426 unsigned long userptr;
427 } m;
428 __u32 length;
429 __u32 input;
430 __u32 reserved;
431};
432
433/* Flags for 'flags' field */
434#define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
435#define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
436#define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
437#define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
438#define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
439#define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
440#define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
441#define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
442
443/*
444 * O V E R L A Y P R E V I E W
445 */
446struct v4l2_framebuffer
447{
448 __u32 capability;
449 __u32 flags;
450/* FIXME: in theory we should pass something like PCI device + memory
451 * region + offset instead of some physical address */
452 void* base;
453 struct v4l2_pix_format fmt;
454};
455/* Flags for the 'capability' field. Read only */
456#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
457#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
458#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
459#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
460/* Flags for the 'flags' field. */
461#define V4L2_FBUF_FLAG_PRIMARY 0x0001
462#define V4L2_FBUF_FLAG_OVERLAY 0x0002
463#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
464
465struct v4l2_clip
466{
467 struct v4l2_rect c;
468 struct v4l2_clip *next;
469};
470
471struct v4l2_window
472{
473 struct v4l2_rect w;
474 enum v4l2_field field;
475 __u32 chromakey;
476 struct v4l2_clip __user *clips;
477 __u32 clipcount;
478 void __user *bitmap;
479};
480
481
482/*
483 * C A P T U R E P A R A M E T E R S
484 */
485struct v4l2_captureparm
486{
487 __u32 capability; /* Supported modes */
488 __u32 capturemode; /* Current mode */
489 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
490 __u32 extendedmode; /* Driver-specific extensions */
491 __u32 readbuffers; /* # of buffers for read */
492 __u32 reserved[4];
493};
494/* Flags for 'capability' and 'capturemode' fields */
495#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
496#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
497
498struct v4l2_outputparm
499{
500 __u32 capability; /* Supported modes */
501 __u32 outputmode; /* Current mode */
502 struct v4l2_fract timeperframe; /* Time per frame in seconds */
503 __u32 extendedmode; /* Driver-specific extensions */
504 __u32 writebuffers; /* # of buffers for write */
505 __u32 reserved[4];
506};
507
508/*
509 * I N P U T I M A G E C R O P P I N G
510 */
511
512struct v4l2_cropcap {
513 enum v4l2_buf_type type;
514 struct v4l2_rect bounds;
515 struct v4l2_rect defrect;
516 struct v4l2_fract pixelaspect;
517};
518
519struct v4l2_crop {
520 enum v4l2_buf_type type;
521 struct v4l2_rect c;
522};
523
524/*
525 * A N A L O G V I D E O S T A N D A R D
526 */
527
528typedef __u64 v4l2_std_id;
529
530/* one bit for each */
531#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
532#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
533#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
534#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
535#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
536#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
537#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
538#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
539
540#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
541#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
542#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
543#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
544
545#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
546#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
547
548#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
549#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
550#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
551#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
552#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
553#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
554#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
555
556/* ATSC/HDTV */
557#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
558#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
559
560/* some common needed stuff */
561#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
562 V4L2_STD_PAL_B1 |\
563 V4L2_STD_PAL_G)
564#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
565 V4L2_STD_PAL_D1 |\
566 V4L2_STD_PAL_K)
567#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
568 V4L2_STD_PAL_DK |\
569 V4L2_STD_PAL_H |\
570 V4L2_STD_PAL_I)
571#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
572 V4L2_STD_NTSC_M_JP)
573#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
574 V4L2_STD_SECAM_K |\
575 V4L2_STD_SECAM_K1)
576#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
577 V4L2_STD_SECAM_G |\
578 V4L2_STD_SECAM_H |\
579 V4L2_STD_SECAM_DK |\
580 V4L2_STD_SECAM_L)
581
582#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
583 V4L2_STD_PAL_60 |\
584 V4L2_STD_NTSC)
585#define V4L2_STD_625_50 (V4L2_STD_PAL |\
586 V4L2_STD_PAL_N |\
587 V4L2_STD_PAL_Nc |\
588 V4L2_STD_SECAM)
589#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
590 V4L2_STD_ATSC_16_VSB)
591
592#define V4L2_STD_UNKNOWN 0
593#define V4L2_STD_ALL (V4L2_STD_525_60 |\
594 V4L2_STD_625_50)
595
596struct v4l2_standard
597{
598 __u32 index;
599 v4l2_std_id id;
600 __u8 name[24];
601 struct v4l2_fract frameperiod; /* Frames, not fields */
602 __u32 framelines;
603 __u32 reserved[4];
604};
605
606
607/*
608 * V I D E O I N P U T S
609 */
610struct v4l2_input
611{
612 __u32 index; /* Which input */
613 __u8 name[32]; /* Label */
614 __u32 type; /* Type of input */
615 __u32 audioset; /* Associated audios (bitfield) */
616 __u32 tuner; /* Associated tuner */
617 v4l2_std_id std;
618 __u32 status;
619 __u32 reserved[4];
620};
621/* Values for the 'type' field */
622#define V4L2_INPUT_TYPE_TUNER 1
623#define V4L2_INPUT_TYPE_CAMERA 2
624
625/* field 'status' - general */
626#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
627#define V4L2_IN_ST_NO_SIGNAL 0x00000002
628#define V4L2_IN_ST_NO_COLOR 0x00000004
629
630/* field 'status' - analog */
631#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
632#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
633
634/* field 'status' - digital */
635#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
636#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
637#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
638
639/* field 'status' - VCR and set-top box */
640#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
641#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
642#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
643
644/*
645 * V I D E O O U T P U T S
646 */
647struct v4l2_output
648{
649 __u32 index; /* Which output */
650 __u8 name[32]; /* Label */
651 __u32 type; /* Type of output */
652 __u32 audioset; /* Associated audios (bitfield) */
653 __u32 modulator; /* Associated modulator */
654 v4l2_std_id std;
655 __u32 reserved[4];
656};
657/* Values for the 'type' field */
658#define V4L2_OUTPUT_TYPE_MODULATOR 1
659#define V4L2_OUTPUT_TYPE_ANALOG 2
660#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
661
662/*
663 * C O N T R O L S
664 */
665struct v4l2_control
666{
667 __u32 id;
668 __s32 value;
669};
670
671/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
672struct v4l2_queryctrl
673{
674 __u32 id;
675 enum v4l2_ctrl_type type;
676 __u8 name[32]; /* Whatever */
677 __s32 minimum; /* Note signedness */
678 __s32 maximum;
679 __s32 step;
680 __s32 default_value;
681 __u32 flags;
682 __u32 reserved[2];
683};
684
685/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
686struct v4l2_querymenu
687{
688 __u32 id;
689 __u32 index;
690 __u8 name[32]; /* Whatever */
691 __u32 reserved;
692};
693
694/* Control flags */
695#define V4L2_CTRL_FLAG_DISABLED 0x0001
696#define V4L2_CTRL_FLAG_GRABBED 0x0002
697
698/* Control IDs defined by V4L2 */
699#define V4L2_CID_BASE 0x00980900
700/* IDs reserved for driver specific controls */
701#define V4L2_CID_PRIVATE_BASE 0x08000000
702
703#define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
704#define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
705#define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
706#define V4L2_CID_HUE (V4L2_CID_BASE+3)
707#define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
708#define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
709#define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
710#define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
711#define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
712#define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
713#define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11)
714#define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
715#define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
716#define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
717#define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
718#define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
719#define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* ? Not sure */
720#define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
721#define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
722#define V4L2_CID_GAIN (V4L2_CID_BASE+19)
723#define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
724#define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
725#define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
726#define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
727#define V4L2_CID_LASTP1 (V4L2_CID_BASE+24) /* last CID + 1 */
728
729/*
730 * T U N I N G
731 */
732struct v4l2_tuner
733{
734 __u32 index;
735 __u8 name[32];
736 enum v4l2_tuner_type type;
737 __u32 capability;
738 __u32 rangelow;
739 __u32 rangehigh;
740 __u32 rxsubchans;
741 __u32 audmode;
742 __s32 signal;
743 __s32 afc;
744 __u32 reserved[4];
745};
746
747struct v4l2_modulator
748{
749 __u32 index;
750 __u8 name[32];
751 __u32 capability;
752 __u32 rangelow;
753 __u32 rangehigh;
754 __u32 txsubchans;
755 __u32 reserved[4];
756};
757
758/* Flags for the 'capability' field */
759#define V4L2_TUNER_CAP_LOW 0x0001
760#define V4L2_TUNER_CAP_NORM 0x0002
761#define V4L2_TUNER_CAP_STEREO 0x0010
762#define V4L2_TUNER_CAP_LANG2 0x0020
763#define V4L2_TUNER_CAP_SAP 0x0020
764#define V4L2_TUNER_CAP_LANG1 0x0040
765
766/* Flags for the 'rxsubchans' field */
767#define V4L2_TUNER_SUB_MONO 0x0001
768#define V4L2_TUNER_SUB_STEREO 0x0002
769#define V4L2_TUNER_SUB_LANG2 0x0004
770#define V4L2_TUNER_SUB_SAP 0x0004
771#define V4L2_TUNER_SUB_LANG1 0x0008
772
773/* Values for the 'audmode' field */
774#define V4L2_TUNER_MODE_MONO 0x0000
775#define V4L2_TUNER_MODE_STEREO 0x0001
776#define V4L2_TUNER_MODE_LANG2 0x0002
777#define V4L2_TUNER_MODE_SAP 0x0002
778#define V4L2_TUNER_MODE_LANG1 0x0003
779
780struct v4l2_frequency
781{
782 __u32 tuner;
783 enum v4l2_tuner_type type;
784 __u32 frequency;
785 __u32 reserved[8];
786};
787
788/*
789 * A U D I O
790 */
791struct v4l2_audio
792{
793 __u32 index;
794 __u8 name[32];
795 __u32 capability;
796 __u32 mode;
797 __u32 reserved[2];
798};
799/* Flags for the 'capability' field */
800#define V4L2_AUDCAP_STEREO 0x00001
801#define V4L2_AUDCAP_AVL 0x00002
802
803/* Flags for the 'mode' field */
804#define V4L2_AUDMODE_AVL 0x00001
805
806struct v4l2_audioout
807{
808 __u32 index;
809 __u8 name[32];
810 __u32 capability;
811 __u32 mode;
812 __u32 reserved[2];
813};
814
815/*
816 * D A T A S E R V I C E S ( V B I )
817 *
818 * Data services API by Michael Schimek
819 */
820
821/* Raw VBI */
822
823struct v4l2_vbi_format
824{
825 __u32 sampling_rate; /* in 1 Hz */
826 __u32 offset;
827 __u32 samples_per_line;
828 __u32 sample_format; /* V4L2_PIX_FMT_* */
829 __s32 start[2];
830 __u32 count[2];
831 __u32 flags; /* V4L2_VBI_* */
832 __u32 reserved[2]; /* must be zero */
833};
834
835/* VBI flags */
836#define V4L2_VBI_UNSYNC (1<< 0)
837#define V4L2_VBI_INTERLACED (1<< 1)
838
839#if 1
840/* Sliced VBI
841 *
842 * This implements is a proposal V4L2 API to allow SLICED VBI
843 * required for some hardware encoders. It should change without
844 * notice in the definitive implementation.
845 */
846
847struct v4l2_sliced_vbi_format
848{
849 __u16 service_set;
850 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
851 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
852 (equals frame lines 313-336 for 625 line video
853 standards, 263-286 for 525 line standards) */
854 __u16 service_lines[2][24];
855 __u32 io_size;
856 __u32 reserved[2]; /* must be zero */
857};
858
859#define V4L2_SLICED_TELETEXT_B (0x0001)
860#define V4L2_SLICED_VPS (0x0400)
861#define V4L2_SLICED_CAPTION_525 (0x1000)
862#define V4L2_SLICED_WSS_625 (0x4000)
863
864#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
865#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
866
867struct v4l2_sliced_vbi_cap
868{
869 __u16 service_set;
870 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
871 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
872 (equals frame lines 313-336 for 625 line video
873 standards, 263-286 for 525 line standards) */
874 __u16 service_lines[2][24];
875 __u32 reserved[4]; /* must be 0 */
876};
877
878struct v4l2_sliced_vbi_data
879{
880 __u32 id;
881 __u32 field; /* 0: first field, 1: second field */
882 __u32 line; /* 1-23 */
883 __u32 reserved; /* must be 0 */
884 __u8 data[48];
885};
886#endif
887
888/*
889 * A G G R E G A T E S T R U C T U R E S
890 */
891
892/* Stream data format
893 */
894struct v4l2_format
895{
896 enum v4l2_buf_type type;
897 union
898 {
899 struct v4l2_pix_format pix; // V4L2_BUF_TYPE_VIDEO_CAPTURE
900 struct v4l2_window win; // V4L2_BUF_TYPE_VIDEO_OVERLAY
901 struct v4l2_vbi_format vbi; // V4L2_BUF_TYPE_VBI_CAPTURE
902#if 1
903 struct v4l2_sliced_vbi_format sliced; // V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
904#endif
905 __u8 raw_data[200]; // user-defined
906 } fmt;
907};
908
909
910/* Stream type-dependent parameters
911 */
912struct v4l2_streamparm
913{
914 enum v4l2_buf_type type;
915 union
916 {
917 struct v4l2_captureparm capture;
918 struct v4l2_outputparm output;
919 __u8 raw_data[200]; /* user-defined */
920 } parm;
921};
922
923
924
925/*
926 * 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
927 *
928 */
929#define VIDIOC_QUERYCAP _IOR ('V', 0, struct v4l2_capability)
930#define VIDIOC_RESERVED _IO ('V', 1)
931#define VIDIOC_ENUM_FMT _IOWR ('V', 2, struct v4l2_fmtdesc)
932#define VIDIOC_G_FMT _IOWR ('V', 4, struct v4l2_format)
933#define VIDIOC_S_FMT _IOWR ('V', 5, struct v4l2_format)
934#define VIDIOC_G_MPEGCOMP _IOR ('V', 6, struct v4l2_mpeg_compression)
935#define VIDIOC_S_MPEGCOMP _IOW ('V', 7, struct v4l2_mpeg_compression)
936#define VIDIOC_REQBUFS _IOWR ('V', 8, struct v4l2_requestbuffers)
937#define VIDIOC_QUERYBUF _IOWR ('V', 9, struct v4l2_buffer)
938#define VIDIOC_G_FBUF _IOR ('V', 10, struct v4l2_framebuffer)
939#define VIDIOC_S_FBUF _IOW ('V', 11, struct v4l2_framebuffer)
940#define VIDIOC_OVERLAY _IOW ('V', 14, int)
941#define VIDIOC_QBUF _IOWR ('V', 15, struct v4l2_buffer)
942#define VIDIOC_DQBUF _IOWR ('V', 17, struct v4l2_buffer)
943#define VIDIOC_STREAMON _IOW ('V', 18, int)
944#define VIDIOC_STREAMOFF _IOW ('V', 19, int)
945#define VIDIOC_G_PARM _IOWR ('V', 21, struct v4l2_streamparm)
946#define VIDIOC_S_PARM _IOWR ('V', 22, struct v4l2_streamparm)
947#define VIDIOC_G_STD _IOR ('V', 23, v4l2_std_id)
948#define VIDIOC_S_STD _IOW ('V', 24, v4l2_std_id)
949#define VIDIOC_ENUMSTD _IOWR ('V', 25, struct v4l2_standard)
950#define VIDIOC_ENUMINPUT _IOWR ('V', 26, struct v4l2_input)
951#define VIDIOC_G_CTRL _IOWR ('V', 27, struct v4l2_control)
952#define VIDIOC_S_CTRL _IOWR ('V', 28, struct v4l2_control)
953#define VIDIOC_G_TUNER _IOWR ('V', 29, struct v4l2_tuner)
954#define VIDIOC_S_TUNER _IOW ('V', 30, struct v4l2_tuner)
955#define VIDIOC_G_AUDIO _IOR ('V', 33, struct v4l2_audio)
956#define VIDIOC_S_AUDIO _IOW ('V', 34, struct v4l2_audio)
957#define VIDIOC_QUERYCTRL _IOWR ('V', 36, struct v4l2_queryctrl)
958#define VIDIOC_QUERYMENU _IOWR ('V', 37, struct v4l2_querymenu)
959#define VIDIOC_G_INPUT _IOR ('V', 38, int)
960#define VIDIOC_S_INPUT _IOWR ('V', 39, int)
961#define VIDIOC_G_OUTPUT _IOR ('V', 46, int)
962#define VIDIOC_S_OUTPUT _IOWR ('V', 47, int)
963#define VIDIOC_ENUMOUTPUT _IOWR ('V', 48, struct v4l2_output)
964#define VIDIOC_G_AUDOUT _IOR ('V', 49, struct v4l2_audioout)
965#define VIDIOC_S_AUDOUT _IOW ('V', 50, struct v4l2_audioout)
966#define VIDIOC_G_MODULATOR _IOWR ('V', 54, struct v4l2_modulator)
967#define VIDIOC_S_MODULATOR _IOW ('V', 55, struct v4l2_modulator)
968#define VIDIOC_G_FREQUENCY _IOWR ('V', 56, struct v4l2_frequency)
969#define VIDIOC_S_FREQUENCY _IOW ('V', 57, struct v4l2_frequency)
970#define VIDIOC_CROPCAP _IOWR ('V', 58, struct v4l2_cropcap)
971#define VIDIOC_G_CROP _IOWR ('V', 59, struct v4l2_crop)
972#define VIDIOC_S_CROP _IOW ('V', 60, struct v4l2_crop)
973#define VIDIOC_G_JPEGCOMP _IOR ('V', 61, struct v4l2_jpegcompression)
974#define VIDIOC_S_JPEGCOMP _IOW ('V', 62, struct v4l2_jpegcompression)
975#define VIDIOC_QUERYSTD _IOR ('V', 63, v4l2_std_id)
976#define VIDIOC_TRY_FMT _IOWR ('V', 64, struct v4l2_format)
977#define VIDIOC_ENUMAUDIO _IOWR ('V', 65, struct v4l2_audio)
978#define VIDIOC_ENUMAUDOUT _IOWR ('V', 66, struct v4l2_audioout)
979#define VIDIOC_G_PRIORITY _IOR ('V', 67, enum v4l2_priority)
980#define VIDIOC_S_PRIORITY _IOW ('V', 68, enum v4l2_priority)
981#if 1
982#define VIDIOC_G_SLICED_VBI_CAP _IOR ('V', 69, struct v4l2_sliced_vbi_cap)
983#endif
984
985/* for compatibility, will go away some day */
986#define VIDIOC_OVERLAY_OLD _IOWR ('V', 14, int)
987#define VIDIOC_S_PARM_OLD _IOW ('V', 22, struct v4l2_streamparm)
988#define VIDIOC_S_CTRL_OLD _IOW ('V', 28, struct v4l2_control)
989#define VIDIOC_G_AUDIO_OLD _IOWR ('V', 33, struct v4l2_audio)
990#define VIDIOC_G_AUDOUT_OLD _IOWR ('V', 49, struct v4l2_audioout)
991#define VIDIOC_CROPCAP_OLD _IOR ('V', 58, struct v4l2_cropcap)
992
993#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
994
995
996#ifdef __KERNEL__
997/*
998 *
999 * V 4 L 2 D R I V E R H E L P E R A P I
1000 *
1001 * Some commonly needed functions for drivers (v4l2-common.o module)
1002 */
1003#include <linux/fs.h>
1004
1005/* Video standard functions */
1006extern unsigned int v4l2_video_std_fps(struct v4l2_standard *vs);
1007extern int v4l2_video_std_construct(struct v4l2_standard *vs,
1008 int id, char *name);
1009
1010/* prority handling */
1011struct v4l2_prio_state {
1012 atomic_t prios[4];
1013};
1014int v4l2_prio_init(struct v4l2_prio_state *global);
1015int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
1016 enum v4l2_priority new);
1017int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
1018int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
1019enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
1020int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
1021
1022/* names for fancy debug output */
1023extern char *v4l2_field_names[];
1024extern char *v4l2_type_names[];
1025extern char *v4l2_ioctl_names[];
1026
1027/* Compatibility layer interface -- v4l1-compat module */
1028typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file,
1029 unsigned int cmd, void *arg);
1030int v4l_compat_translate_ioctl(struct inode *inode, struct file *file,
1031 int cmd, void *arg, v4l2_kioctl driver_ioctl);
1032
1033#endif /* __KERNEL__ */
1034#endif /* __LINUX_VIDEODEV2_H */
1035
1036/*
1037 * Local variables:
1038 * c-basic-offset: 8
1039 * End:
1040 */