2 * This header comes from linux, but it has no license. The author
3 * (Bill Dirks) gave explicit permissions to use it in FreeBSD.
4 * The FreeBSD vendor branch for v4l gives a more detailed description
5 * about this in the README.
10 #ifndef __LINUX_VIDEODEV2_H
11 #define __LINUX_VIDEODEV2_H
15 * Header file for v4l or V4L2 drivers and applications, for
16 * Linux kernels 2.2.x or 2.4.x.
18 * See http://bytesex.org/v4l/ for API specs and other
21 * Author: Bill Dirks <bdirks@pacbell.net>
27 typedef uint64_t __u64;
28 typedef int64_t __s64;
31 #include <linux/time.h> /* need struct timeval */
32 #include <linux/poll.h>
33 #include <linux/device.h>
34 #include <linux/mutex.h>
36 #include <linux/compiler.h> /* need __user */
40 #define OBSOLETE_OWNER 1 /* It will be removed for 2.6.17 */
44 * Common stuff for both V4L1 and V4L2
45 * Moved from videodev.h
48 #define VIDEO_MAX_FRAME 32
50 #define VID_TYPE_CAPTURE 1 /* Can capture */
51 #define VID_TYPE_TUNER 2 /* Can tune */
52 #define VID_TYPE_TELETEXT 4 /* Does teletext */
53 #define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
54 #define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
55 #define VID_TYPE_CLIPPING 32 /* Can clip */
56 #define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
57 #define VID_TYPE_SCALES 128 /* Scalable */
58 #define VID_TYPE_MONOCHROME 256 /* Monochrome only */
59 #define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
60 #define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
61 #define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
62 #define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
63 #define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
67 /* Minor device allocation */
68 #define MINOR_VFL_TYPE_GRABBER_MIN 0
69 #define MINOR_VFL_TYPE_GRABBER_MAX 63
70 #define MINOR_VFL_TYPE_RADIO_MIN 64
71 #define MINOR_VFL_TYPE_RADIO_MAX 127
72 #define MINOR_VFL_TYPE_VTX_MIN 192
73 #define MINOR_VFL_TYPE_VTX_MAX 223
74 #define MINOR_VFL_TYPE_VBI_MIN 224
75 #define MINOR_VFL_TYPE_VBI_MAX 255
77 #define VFL_TYPE_GRABBER 0
78 #define VFL_TYPE_VBI 1
79 #define VFL_TYPE_RADIO 2
80 #define VFL_TYPE_VTX 3
92 /* device ops + callbacks */
93 const struct file_operations *fops;
94 void (*release)(struct video_device *vfd);
97 #if OBSOLETE_OWNER /* to be removed in 2.6.15 */
98 /* obsolete -- fops->owner is used instead */
100 /* dev->driver_data will be used instead some day.
101 * Use the video_{get|set}_drvdata() helper functions,
102 * so the switch over will be transparent for you.
103 * Or use {pci|usb}_{get|set}_drvdata() directly. */
107 /* for videodev.c intenal usage -- please don't touch */
108 int users; /* video_exclusive_{open|close} ... */
109 struct mutex lock; /* ... helper function uses these */
110 char devfs_name[64]; /* devfs */
111 struct class_device class_dev; /* sysfs */
114 #define VIDEO_MAJOR 81
116 extern int video_register_device(struct video_device *, int type, int nr);
117 extern void video_unregister_device(struct video_device *);
118 extern int video_usercopy(struct inode *inode, struct file *file,
119 unsigned int cmd, unsigned long arg,
120 int (*func)(struct inode *inode, struct file *file,
121 unsigned int cmd, void *arg));
123 /* helper functions to alloc / release struct video_device, the
124 later can be used for video_device->release() */
125 struct video_device *video_device_alloc(void);
126 void video_device_release(struct video_device *vfd);
131 * M I S C E L L A N E O U S
134 /* Four-character-code (FOURCC) */
135 #define v4l2_fourcc(a,b,c,d)\
136 (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))
142 V4L2_FIELD_ANY = 0, /* driver can choose from none,
143 top, bottom, interlaced
144 depending on whatever it thinks
145 is approximate ... */
146 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
147 V4L2_FIELD_TOP = 2, /* top field only */
148 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
149 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
150 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
151 buffer, top-bottom order */
152 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
153 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
156 #define V4L2_FIELD_HAS_TOP(field) \
157 ((field) == V4L2_FIELD_TOP ||\
158 (field) == V4L2_FIELD_INTERLACED ||\
159 (field) == V4L2_FIELD_SEQ_TB ||\
160 (field) == V4L2_FIELD_SEQ_BT)
161 #define V4L2_FIELD_HAS_BOTTOM(field) \
162 ((field) == V4L2_FIELD_BOTTOM ||\
163 (field) == V4L2_FIELD_INTERLACED ||\
164 (field) == V4L2_FIELD_SEQ_TB ||\
165 (field) == V4L2_FIELD_SEQ_BT)
166 #define V4L2_FIELD_HAS_BOTH(field) \
167 ((field) == V4L2_FIELD_INTERLACED ||\
168 (field) == V4L2_FIELD_SEQ_TB ||\
169 (field) == V4L2_FIELD_SEQ_BT)
172 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
173 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
174 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
175 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
176 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
178 /* Experimental Sliced VBI */
179 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
180 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
182 V4L2_BUF_TYPE_PRIVATE = 0x80,
185 enum v4l2_ctrl_type {
186 V4L2_CTRL_TYPE_INTEGER = 1,
187 V4L2_CTRL_TYPE_BOOLEAN = 2,
188 V4L2_CTRL_TYPE_MENU = 3,
189 V4L2_CTRL_TYPE_BUTTON = 4,
192 enum v4l2_tuner_type {
193 V4L2_TUNER_RADIO = 1,
194 V4L2_TUNER_ANALOG_TV = 2,
195 V4L2_TUNER_DIGITAL_TV = 3,
199 V4L2_MEMORY_MMAP = 1,
200 V4L2_MEMORY_USERPTR = 2,
201 V4L2_MEMORY_OVERLAY = 3,
204 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
205 enum v4l2_colorspace {
206 /* ITU-R 601 -- broadcast NTSC/PAL */
207 V4L2_COLORSPACE_SMPTE170M = 1,
209 /* 1125-Line (US) HDTV */
210 V4L2_COLORSPACE_SMPTE240M = 2,
212 /* HD and modern captures. */
213 V4L2_COLORSPACE_REC709 = 3,
215 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
216 V4L2_COLORSPACE_BT878 = 4,
218 /* These should be useful. Assume 601 extents. */
219 V4L2_COLORSPACE_470_SYSTEM_M = 5,
220 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
222 /* I know there will be cameras that send this. So, this is
223 * unspecified chromaticities and full 0-255 on each of the
226 V4L2_COLORSPACE_JPEG = 7,
228 /* For RGB colourspaces, this is probably a good start. */
229 V4L2_COLORSPACE_SRGB = 8,
233 V4L2_PRIORITY_UNSET = 0, /* not initialized */
234 V4L2_PRIORITY_BACKGROUND = 1,
235 V4L2_PRIORITY_INTERACTIVE = 2,
236 V4L2_PRIORITY_RECORD = 3,
237 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
253 * D R I V E R C A P A B I L I T I E S
255 struct v4l2_capability
257 __u8 driver[16]; /* i.e. "bttv" */
258 __u8 card[32]; /* i.e. "Hauppauge WinTV" */
259 __u8 bus_info[32]; /* "PCI:" + pci_name(pci_dev) */
260 __u32 version; /* should use KERNEL_VERSION() */
261 __u32 capabilities; /* Device capabilities */
265 /* Values for 'capabilities' field */
266 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
267 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
268 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
269 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
270 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
272 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
273 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
275 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
277 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
278 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
279 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
281 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
282 #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
283 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
286 * V I D E O I M A G E F O R M A T
289 struct v4l2_pix_format
294 enum v4l2_field field;
295 __u32 bytesperline; /* for padding, zero if unused */
297 enum v4l2_colorspace colorspace;
298 __u32 priv; /* private data, depends on pixelformat */
301 /* Pixel format FOURCC depth Description */
302 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R','G','B','1') /* 8 RGB-3-3-2 */
303 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R','G','B','O') /* 16 RGB-5-5-5 */
304 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R','G','B','P') /* 16 RGB-5-6-5 */
305 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16 RGB-5-5-5 BE */
306 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16 RGB-5-6-5 BE */
307 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B','G','R','3') /* 24 BGR-8-8-8 */
308 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R','G','B','3') /* 24 RGB-8-8-8 */
309 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B','G','R','4') /* 32 BGR-8-8-8-8 */
310 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R','G','B','4') /* 32 RGB-8-8-8-8 */
311 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G','R','E','Y') /* 8 Greyscale */
312 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y','V','U','9') /* 9 YVU 4:1:0 */
313 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y','V','1','2') /* 12 YVU 4:2:0 */
314 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y','U','Y','V') /* 16 YUV 4:2:2 */
315 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U','Y','V','Y') /* 16 YUV 4:2:2 */
316 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16 YVU422 planar */
317 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16 YVU411 planar */
318 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y','4','1','P') /* 12 YUV 4:1:1 */
320 /* two planes -- one Y, one Cr + Cb interleaved */
321 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N','V','1','2') /* 12 Y/CbCr 4:2:0 */
322 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N','V','2','1') /* 12 Y/CrCb 4:2:0 */
324 /* The following formats are not defined in the V4L2 specification */
325 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y','U','V','9') /* 9 YUV 4:1:0 */
326 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y','U','1','2') /* 12 YUV 4:2:0 */
327 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y','Y','U','V') /* 16 YUV 4:2:2 */
328 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H','I','2','4') /* 8 8-bit color */
330 /* see http://www.siliconimaging.com/RGB%20Bayer.htm */
331 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B','A','8','1') /* 8 BGBG.. GRGR.. */
333 /* compressed formats */
334 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M','J','P','G') /* Motion-JPEG */
335 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J','P','E','G') /* JFIF JPEG */
336 #define V4L2_PIX_FMT_DV v4l2_fourcc('d','v','s','d') /* 1394 */
337 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M','P','E','G') /* MPEG */
339 /* Vendor-specific formats */
340 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W','N','V','A') /* Winnov hw compress */
341 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S','9','1','0') /* SN9C10x compression */
342 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') /* pwc older webcam */
343 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') /* pwc newer webcam */
344 #define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E','6','2','5') /* ET61X251 compression */
347 * F O R M A T E N U M E R A T I O N
351 __u32 index; /* Format number */
352 enum v4l2_buf_type type; /* buffer type */
354 __u8 description[32]; /* Description string */
355 __u32 pixelformat; /* Format fourcc */
359 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
377 #define V4L2_TC_TYPE_24FPS 1
378 #define V4L2_TC_TYPE_25FPS 2
379 #define V4L2_TC_TYPE_30FPS 3
380 #define V4L2_TC_TYPE_50FPS 4
381 #define V4L2_TC_TYPE_60FPS 5
384 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
385 #define V4L2_TC_FLAG_COLORFRAME 0x0002
386 #define V4L2_TC_USERBITS_field 0x000C
387 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
388 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
389 /* The above is based on SMPTE timecodes */
393 * 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
395 * ### WARNING: this is still work-in-progress right now, most likely
396 * ### there will be some incompatible changes.
401 enum v4l2_bitrate_mode {
402 V4L2_BITRATE_NONE = 0, /* not specified */
403 V4L2_BITRATE_CBR, /* constant bitrate */
404 V4L2_BITRATE_VBR, /* variable bitrate */
406 struct v4l2_bitrate {
407 /* rates are specified in kbit/sec */
408 enum v4l2_bitrate_mode mode;
410 __u32 target; /* use this one for CBR */
414 enum v4l2_mpeg_streamtype {
415 V4L2_MPEG_SS_1, /* MPEG-1 system stream */
416 V4L2_MPEG_PS_2, /* MPEG-2 program stream */
417 V4L2_MPEG_TS_2, /* MPEG-2 transport stream */
418 V4L2_MPEG_PS_DVD, /* MPEG-2 program stream with DVD header fixups */
420 enum v4l2_mpeg_audiotype {
421 V4L2_MPEG_AU_2_I, /* MPEG-2 layer 1 */
422 V4L2_MPEG_AU_2_II, /* MPEG-2 layer 2 */
423 V4L2_MPEG_AU_2_III, /* MPEG-2 layer 3 */
424 V4L2_MPEG_AC3, /* AC3 */
425 V4L2_MPEG_LPCM, /* LPCM */
427 enum v4l2_mpeg_videotype {
428 V4L2_MPEG_VI_1, /* MPEG-1 */
429 V4L2_MPEG_VI_2, /* MPEG-2 */
431 enum v4l2_mpeg_aspectratio {
432 V4L2_MPEG_ASPECT_SQUARE = 1, /* square pixel */
433 V4L2_MPEG_ASPECT_4_3 = 2, /* 4 : 3 */
434 V4L2_MPEG_ASPECT_16_9 = 3, /* 16 : 9 */
435 V4L2_MPEG_ASPECT_1_221 = 4, /* 1 : 2,21 */
438 struct v4l2_mpeg_compression {
440 enum v4l2_mpeg_streamtype st_type;
441 struct v4l2_bitrate st_bitrate;
443 /* transport streams */
451 __u16 reserved_1; /* align */
454 enum v4l2_mpeg_audiotype au_type;
455 struct v4l2_bitrate au_bitrate;
456 __u32 au_sample_rate;
458 __u8 reserved_2[3]; /* align */
461 enum v4l2_mpeg_videotype vi_type;
462 enum v4l2_mpeg_aspectratio vi_aspect_ratio;
463 struct v4l2_bitrate vi_bitrate;
465 __u16 vi_frames_per_gop;
466 __u16 vi_bframes_count;
468 __u8 reserved_3[3]; /* align */
473 __u32 reserved_4:30; /* align */
475 /* I don't expect the above being perfect yet ;) */
479 struct v4l2_jpegcompression
483 int APPn; /* Number of APP segment to be written,
485 int APP_len; /* Length of data in JPEG APPn segment */
486 char APP_data[60]; /* Data in the JPEG APPn segment. */
488 int COM_len; /* Length of data in JPEG COM segment */
489 char COM_data[60]; /* Data in JPEG COM segment */
491 __u32 jpeg_markers; /* Which markers should go into the JPEG
492 * output. Unless you exactly know what
493 * you do, leave them untouched.
494 * Inluding less markers will make the
495 * resulting code smaller, but there will
496 * be fewer aplications which can read it.
497 * The presence of the APP and COM marker
498 * is influenced by APP_len and COM_len
499 * ONLY, not by this property! */
501 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
502 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
503 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
504 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
505 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
506 * allways use APP0 */
511 * M E M O R Y - M A P P I N G B U F F E R S
513 struct v4l2_requestbuffers
516 enum v4l2_buf_type type;
517 enum v4l2_memory memory;
524 enum v4l2_buf_type type;
527 enum v4l2_field field;
528 struct timeval timestamp;
529 struct v4l2_timecode timecode;
532 /* memory location */
533 enum v4l2_memory memory;
536 unsigned long userptr;
543 /* Flags for 'flags' field */
544 #define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
545 #define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
546 #define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
547 #define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
548 #define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
549 #define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
550 #define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
551 #define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
554 * O V E R L A Y P R E V I E W
556 struct v4l2_framebuffer
560 /* FIXME: in theory we should pass something like PCI device + memory
561 * region + offset instead of some physical address */
563 struct v4l2_pix_format fmt;
565 /* Flags for the 'capability' field. Read only */
566 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
567 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
568 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
569 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
570 /* Flags for the 'flags' field. */
571 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
572 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
573 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
578 struct v4l2_clip __user *next;
584 enum v4l2_field field;
586 struct v4l2_clip __user *clips;
593 * C A P T U R E P A R A M E T E R S
595 struct v4l2_captureparm
597 __u32 capability; /* Supported modes */
598 __u32 capturemode; /* Current mode */
599 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
600 __u32 extendedmode; /* Driver-specific extensions */
601 __u32 readbuffers; /* # of buffers for read */
604 /* Flags for 'capability' and 'capturemode' fields */
605 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
606 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
608 struct v4l2_outputparm
610 __u32 capability; /* Supported modes */
611 __u32 outputmode; /* Current mode */
612 struct v4l2_fract timeperframe; /* Time per frame in seconds */
613 __u32 extendedmode; /* Driver-specific extensions */
614 __u32 writebuffers; /* # of buffers for write */
619 * I N P U T I M A G E C R O P P I N G
622 struct v4l2_cropcap {
623 enum v4l2_buf_type type;
624 struct v4l2_rect bounds;
625 struct v4l2_rect defrect;
626 struct v4l2_fract pixelaspect;
630 enum v4l2_buf_type type;
635 * A N A L O G V I D E O S T A N D A R D
638 typedef __u64 v4l2_std_id;
640 /* one bit for each */
641 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
642 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
643 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
644 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
645 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
646 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
647 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
648 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
650 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
651 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
652 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
653 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
655 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
656 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
657 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
658 #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000)
660 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
661 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
662 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
663 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
664 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
665 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
666 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
667 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
670 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
671 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
673 /* some merged standards */
674 #define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
675 #define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
676 #define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
677 #define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
679 /* some common needed stuff */
680 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
683 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
686 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
690 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
691 V4L2_STD_NTSC_M_JP |\
693 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
696 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
703 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
707 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
711 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
712 V4L2_STD_ATSC_16_VSB)
714 #define V4L2_STD_UNKNOWN 0
715 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
723 struct v4l2_fract frameperiod; /* Frames, not fields */
730 * V I D E O I N P U T S
734 __u32 index; /* Which input */
735 __u8 name[32]; /* Label */
736 __u32 type; /* Type of input */
737 __u32 audioset; /* Associated audios (bitfield) */
738 __u32 tuner; /* Associated tuner */
743 /* Values for the 'type' field */
744 #define V4L2_INPUT_TYPE_TUNER 1
745 #define V4L2_INPUT_TYPE_CAMERA 2
747 /* field 'status' - general */
748 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
749 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
750 #define V4L2_IN_ST_NO_COLOR 0x00000004
752 /* field 'status' - analog */
753 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
754 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
756 /* field 'status' - digital */
757 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
758 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
759 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
761 /* field 'status' - VCR and set-top box */
762 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
763 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
764 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
767 * V I D E O O U T P U T S
771 __u32 index; /* Which output */
772 __u8 name[32]; /* Label */
773 __u32 type; /* Type of output */
774 __u32 audioset; /* Associated audios (bitfield) */
775 __u32 modulator; /* Associated modulator */
779 /* Values for the 'type' field */
780 #define V4L2_OUTPUT_TYPE_MODULATOR 1
781 #define V4L2_OUTPUT_TYPE_ANALOG 2
782 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
793 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
794 struct v4l2_queryctrl
797 enum v4l2_ctrl_type type;
798 __u8 name[32]; /* Whatever */
799 __s32 minimum; /* Note signedness */
807 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
808 struct v4l2_querymenu
812 __u8 name[32]; /* Whatever */
817 #define V4L2_CTRL_FLAG_DISABLED 0x0001
818 #define V4L2_CTRL_FLAG_GRABBED 0x0002
820 /* Control IDs defined by V4L2 */
821 #define V4L2_CID_BASE 0x00980900
822 /* IDs reserved for driver specific controls */
823 #define V4L2_CID_PRIVATE_BASE 0x08000000
825 #define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
826 #define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
827 #define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
828 #define V4L2_CID_HUE (V4L2_CID_BASE+3)
829 #define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
830 #define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
831 #define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
832 #define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
833 #define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
834 #define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
835 #define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11)
836 #define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
837 #define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
838 #define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
839 #define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
840 #define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
841 #define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* ? Not sure */
842 #define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
843 #define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
844 #define V4L2_CID_GAIN (V4L2_CID_BASE+19)
845 #define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
846 #define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
847 #define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
848 #define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
849 #define V4L2_CID_LASTP1 (V4L2_CID_BASE+24) /* last CID + 1 */
858 enum v4l2_tuner_type type;
869 struct v4l2_modulator
880 /* Flags for the 'capability' field */
881 #define V4L2_TUNER_CAP_LOW 0x0001
882 #define V4L2_TUNER_CAP_NORM 0x0002
883 #define V4L2_TUNER_CAP_STEREO 0x0010
884 #define V4L2_TUNER_CAP_LANG2 0x0020
885 #define V4L2_TUNER_CAP_SAP 0x0020
886 #define V4L2_TUNER_CAP_LANG1 0x0040
888 /* Flags for the 'rxsubchans' field */
889 #define V4L2_TUNER_SUB_MONO 0x0001
890 #define V4L2_TUNER_SUB_STEREO 0x0002
891 #define V4L2_TUNER_SUB_LANG2 0x0004
892 #define V4L2_TUNER_SUB_SAP 0x0004
893 #define V4L2_TUNER_SUB_LANG1 0x0008
895 /* Values for the 'audmode' field */
896 #define V4L2_TUNER_MODE_MONO 0x0000
897 #define V4L2_TUNER_MODE_STEREO 0x0001
898 #define V4L2_TUNER_MODE_LANG2 0x0002
899 #define V4L2_TUNER_MODE_SAP 0x0002
900 #define V4L2_TUNER_MODE_LANG1 0x0003
901 #define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
903 struct v4l2_frequency
906 enum v4l2_tuner_type type;
922 /* Flags for the 'capability' field */
923 #define V4L2_AUDCAP_STEREO 0x00001
924 #define V4L2_AUDCAP_AVL 0x00002
926 /* Flags for the 'mode' field */
927 #define V4L2_AUDMODE_AVL 0x00001
939 * D A T A S E R V I C E S ( V B I )
941 * Data services API by Michael Schimek
946 struct v4l2_vbi_format
948 __u32 sampling_rate; /* in 1 Hz */
950 __u32 samples_per_line;
951 __u32 sample_format; /* V4L2_PIX_FMT_* */
954 __u32 flags; /* V4L2_VBI_* */
955 __u32 reserved[2]; /* must be zero */
959 #define V4L2_VBI_UNSYNC (1<< 0)
960 #define V4L2_VBI_INTERLACED (1<< 1)
965 * This implements is a proposal V4L2 API to allow SLICED VBI
966 * required for some hardware encoders. It should change without
967 * notice in the definitive implementation.
970 struct v4l2_sliced_vbi_format
973 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
974 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
975 (equals frame lines 313-336 for 625 line video
976 standards, 263-286 for 525 line standards) */
977 __u16 service_lines[2][24];
979 __u32 reserved[2]; /* must be zero */
982 /* Teletext World System Teletext
983 (WST), defined on ITU-R BT.653-2 */
984 #define V4L2_SLICED_TELETEXT_B (0x0001)
985 /* Video Program System, defined on ETS 300 231*/
986 #define V4L2_SLICED_VPS (0x0400)
987 /* Closed Caption, defined on EIA-608 */
988 #define V4L2_SLICED_CAPTION_525 (0x1000)
989 /* Wide Screen System, defined on ITU-R BT1119.1 */
990 #define V4L2_SLICED_WSS_625 (0x4000)
992 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
993 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
996 struct v4l2_sliced_vbi_cap
999 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1000 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1001 (equals frame lines 313-336 for 625 line video
1002 standards, 263-286 for 525 line standards) */
1003 __u16 service_lines[2][24];
1004 __u32 reserved[4]; /* must be 0 */
1007 struct v4l2_sliced_vbi_data
1010 __u32 field; /* 0: first field, 1: second field */
1011 __u32 line; /* 1-23 */
1012 __u32 reserved; /* must be 0 */
1018 * A G G R E G A T E S T R U C T U R E S
1021 /* Stream data format
1025 enum v4l2_buf_type type;
1028 struct v4l2_pix_format pix; // V4L2_BUF_TYPE_VIDEO_CAPTURE
1029 struct v4l2_window win; // V4L2_BUF_TYPE_VIDEO_OVERLAY
1030 struct v4l2_vbi_format vbi; // V4L2_BUF_TYPE_VBI_CAPTURE
1032 struct v4l2_sliced_vbi_format sliced; // V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
1034 __u8 raw_data[200]; // user-defined
1039 /* Stream type-dependent parameters
1041 struct v4l2_streamparm
1043 enum v4l2_buf_type type;
1046 struct v4l2_captureparm capture;
1047 struct v4l2_outputparm output;
1048 __u8 raw_data[200]; /* user-defined */
1055 * 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
1058 #define VIDIOC_QUERYCAP _IOR ('V', 0, struct v4l2_capability)
1059 #define VIDIOC_RESERVED _IO ('V', 1)
1060 #define VIDIOC_ENUM_FMT _IOWR ('V', 2, struct v4l2_fmtdesc)
1061 #define VIDIOC_G_FMT _IOWR ('V', 4, struct v4l2_format)
1062 #define VIDIOC_S_FMT _IOWR ('V', 5, struct v4l2_format)
1063 #define VIDIOC_G_MPEGCOMP _IOR ('V', 6, struct v4l2_mpeg_compression)
1064 #define VIDIOC_S_MPEGCOMP _IOW ('V', 7, struct v4l2_mpeg_compression)
1065 #define VIDIOC_REQBUFS _IOWR ('V', 8, struct v4l2_requestbuffers)
1066 #define VIDIOC_QUERYBUF _IOWR ('V', 9, struct v4l2_buffer)
1067 #define VIDIOC_G_FBUF _IOR ('V', 10, struct v4l2_framebuffer)
1068 #define VIDIOC_S_FBUF _IOW ('V', 11, struct v4l2_framebuffer)
1069 #define VIDIOC_OVERLAY _IOW ('V', 14, int)
1070 #define VIDIOC_QBUF _IOWR ('V', 15, struct v4l2_buffer)
1071 #define VIDIOC_DQBUF _IOWR ('V', 17, struct v4l2_buffer)
1072 #define VIDIOC_STREAMON _IOW ('V', 18, int)
1073 #define VIDIOC_STREAMOFF _IOW ('V', 19, int)
1074 #define VIDIOC_G_PARM _IOWR ('V', 21, struct v4l2_streamparm)
1075 #define VIDIOC_S_PARM _IOWR ('V', 22, struct v4l2_streamparm)
1076 #define VIDIOC_G_STD _IOR ('V', 23, v4l2_std_id)
1077 #define VIDIOC_S_STD _IOW ('V', 24, v4l2_std_id)
1078 #define VIDIOC_ENUMSTD _IOWR ('V', 25, struct v4l2_standard)
1079 #define VIDIOC_ENUMINPUT _IOWR ('V', 26, struct v4l2_input)
1080 #define VIDIOC_G_CTRL _IOWR ('V', 27, struct v4l2_control)
1081 #define VIDIOC_S_CTRL _IOWR ('V', 28, struct v4l2_control)
1082 #define VIDIOC_G_TUNER _IOWR ('V', 29, struct v4l2_tuner)
1083 #define VIDIOC_S_TUNER _IOW ('V', 30, struct v4l2_tuner)
1084 #define VIDIOC_G_AUDIO _IOR ('V', 33, struct v4l2_audio)
1085 #define VIDIOC_S_AUDIO _IOW ('V', 34, struct v4l2_audio)
1086 #define VIDIOC_QUERYCTRL _IOWR ('V', 36, struct v4l2_queryctrl)
1087 #define VIDIOC_QUERYMENU _IOWR ('V', 37, struct v4l2_querymenu)
1088 #define VIDIOC_G_INPUT _IOR ('V', 38, int)
1089 #define VIDIOC_S_INPUT _IOWR ('V', 39, int)
1090 #define VIDIOC_G_OUTPUT _IOR ('V', 46, int)
1091 #define VIDIOC_S_OUTPUT _IOWR ('V', 47, int)
1092 #define VIDIOC_ENUMOUTPUT _IOWR ('V', 48, struct v4l2_output)
1093 #define VIDIOC_G_AUDOUT _IOR ('V', 49, struct v4l2_audioout)
1094 #define VIDIOC_S_AUDOUT _IOW ('V', 50, struct v4l2_audioout)
1095 #define VIDIOC_G_MODULATOR _IOWR ('V', 54, struct v4l2_modulator)
1096 #define VIDIOC_S_MODULATOR _IOW ('V', 55, struct v4l2_modulator)
1097 #define VIDIOC_G_FREQUENCY _IOWR ('V', 56, struct v4l2_frequency)
1098 #define VIDIOC_S_FREQUENCY _IOW ('V', 57, struct v4l2_frequency)
1099 #define VIDIOC_CROPCAP _IOWR ('V', 58, struct v4l2_cropcap)
1100 #define VIDIOC_G_CROP _IOWR ('V', 59, struct v4l2_crop)
1101 #define VIDIOC_S_CROP _IOW ('V', 60, struct v4l2_crop)
1102 #define VIDIOC_G_JPEGCOMP _IOR ('V', 61, struct v4l2_jpegcompression)
1103 #define VIDIOC_S_JPEGCOMP _IOW ('V', 62, struct v4l2_jpegcompression)
1104 #define VIDIOC_QUERYSTD _IOR ('V', 63, v4l2_std_id)
1105 #define VIDIOC_TRY_FMT _IOWR ('V', 64, struct v4l2_format)
1106 #define VIDIOC_ENUMAUDIO _IOWR ('V', 65, struct v4l2_audio)
1107 #define VIDIOC_ENUMAUDOUT _IOWR ('V', 66, struct v4l2_audioout)
1108 #define VIDIOC_G_PRIORITY _IOR ('V', 67, enum v4l2_priority)
1109 #define VIDIOC_S_PRIORITY _IOW ('V', 68, enum v4l2_priority)
1111 #define VIDIOC_G_SLICED_VBI_CAP _IOR ('V', 69, struct v4l2_sliced_vbi_cap)
1113 #define VIDIOC_LOG_STATUS _IO ('V', 70)
1115 /* for compatibility, will go away some day */
1116 #define VIDIOC_OVERLAY_OLD _IOWR ('V', 14, int)
1117 #define VIDIOC_S_PARM_OLD _IOW ('V', 22, struct v4l2_streamparm)
1118 #define VIDIOC_S_CTRL_OLD _IOW ('V', 28, struct v4l2_control)
1119 #define VIDIOC_G_AUDIO_OLD _IOWR ('V', 33, struct v4l2_audio)
1120 #define VIDIOC_G_AUDOUT_OLD _IOWR ('V', 49, struct v4l2_audioout)
1121 #define VIDIOC_CROPCAP_OLD _IOR ('V', 58, struct v4l2_cropcap)
1123 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1129 * V 4 L 2 D R I V E R H E L P E R A P I
1131 * Some commonly needed functions for drivers (v4l2-common.o module)
1133 #include <linux/fs.h>
1135 /* Video standard functions */
1136 extern unsigned int v4l2_video_std_fps(struct v4l2_standard *vs);
1137 extern int v4l2_video_std_construct(struct v4l2_standard *vs,
1138 int id, char *name);
1140 /* prority handling */
1141 struct v4l2_prio_state {
1144 int v4l2_prio_init(struct v4l2_prio_state *global);
1145 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
1146 enum v4l2_priority new);
1147 int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
1148 int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
1149 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
1150 int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
1152 /* names for fancy debug output */
1153 extern char *v4l2_field_names[];
1154 extern char *v4l2_type_names[];
1156 /* Compatibility layer interface -- v4l1-compat module */
1157 typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file,
1158 unsigned int cmd, void *arg);
1160 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1161 int v4l_compat_translate_ioctl(struct inode *inode, struct file *file,
1162 int cmd, void *arg, v4l2_kioctl driver_ioctl);
1164 #define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL
1167 /* 32 Bits compatibility layer for 64 bits processors */
1168 extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd,
1172 #endif /* __KERNEL__ */
1173 #endif /* __LINUX_VIDEODEV2_H */