1 #ifndef __LINUX_VIDEODEV2_H
2 #define __LINUX_VIDEODEV2_H
6 * Header file for v4l or V4L2 drivers and applications, for
7 * Linux kernels 2.2.x or 2.4.x.
9 * See http://bytesex.org/v4l/ for API specs and other
12 * Author: Bill Dirks <bdirks@pacbell.net>
17 #include <linux/time.h> /* need struct timeval */
18 #include <linux/poll.h>
19 #include <linux/device.h>
20 #include <linux/mutex.h>
22 #include <linux/compiler.h> /* need __user */
25 #define OBSOLETE_OWNER 1 /* It will be removed for 2.6.17 */
29 * Common stuff for both V4L1 and V4L2
30 * Moved from videodev.h
33 #define VIDEO_MAX_FRAME 32
35 #define VID_TYPE_CAPTURE 1 /* Can capture */
36 #define VID_TYPE_TUNER 2 /* Can tune */
37 #define VID_TYPE_TELETEXT 4 /* Does teletext */
38 #define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
39 #define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
40 #define VID_TYPE_CLIPPING 32 /* Can clip */
41 #define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
42 #define VID_TYPE_SCALES 128 /* Scalable */
43 #define VID_TYPE_MONOCHROME 256 /* Monochrome only */
44 #define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
45 #define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
46 #define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
47 #define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
48 #define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
52 /* Minor device allocation */
53 #define MINOR_VFL_TYPE_GRABBER_MIN 0
54 #define MINOR_VFL_TYPE_GRABBER_MAX 63
55 #define MINOR_VFL_TYPE_RADIO_MIN 64
56 #define MINOR_VFL_TYPE_RADIO_MAX 127
57 #define MINOR_VFL_TYPE_VTX_MIN 192
58 #define MINOR_VFL_TYPE_VTX_MAX 223
59 #define MINOR_VFL_TYPE_VBI_MIN 224
60 #define MINOR_VFL_TYPE_VBI_MAX 255
62 #define VFL_TYPE_GRABBER 0
63 #define VFL_TYPE_VBI 1
64 #define VFL_TYPE_RADIO 2
65 #define VFL_TYPE_VTX 3
77 /* device ops + callbacks */
78 struct file_operations
*fops
;
79 void (*release
)(struct video_device
*vfd
);
82 #if OBSOLETE_OWNER /* to be removed in 2.6.15 */
83 /* obsolete -- fops->owner is used instead */
85 /* dev->driver_data will be used instead some day.
86 * Use the video_{get|set}_drvdata() helper functions,
87 * so the switch over will be transparent for you.
88 * Or use {pci|usb}_{get|set}_drvdata() directly. */
92 /* for videodev.c intenal usage -- please don't touch */
93 int users
; /* video_exclusive_{open|close} ... */
94 struct mutex lock
; /* ... helper function uses these */
95 char devfs_name
[64]; /* devfs */
96 struct class_device class_dev
; /* sysfs */
99 #define VIDEO_MAJOR 81
101 extern int video_register_device(struct video_device
*, int type
, int nr
);
102 extern void video_unregister_device(struct video_device
*);
103 extern int video_usercopy(struct inode
*inode
, struct file
*file
,
104 unsigned int cmd
, unsigned long arg
,
105 int (*func
)(struct inode
*inode
, struct file
*file
,
106 unsigned int cmd
, void *arg
));
108 /* helper functions to alloc / release struct video_device, the
109 later can be used for video_device->release() */
110 struct video_device
*video_device_alloc(void);
111 void video_device_release(struct video_device
*vfd
);
116 * M I S C E L L A N E O U S
119 /* Four-character-code (FOURCC) */
120 #define v4l2_fourcc(a,b,c,d)\
121 (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))
127 V4L2_FIELD_ANY
= 0, /* driver can choose from none,
128 top, bottom, interlaced
129 depending on whatever it thinks
130 is approximate ... */
131 V4L2_FIELD_NONE
= 1, /* this device has no fields ... */
132 V4L2_FIELD_TOP
= 2, /* top field only */
133 V4L2_FIELD_BOTTOM
= 3, /* bottom field only */
134 V4L2_FIELD_INTERLACED
= 4, /* both fields interlaced */
135 V4L2_FIELD_SEQ_TB
= 5, /* both fields sequential into one
136 buffer, top-bottom order */
137 V4L2_FIELD_SEQ_BT
= 6, /* same as above + bottom-top order */
138 V4L2_FIELD_ALTERNATE
= 7, /* both fields alternating into
141 #define V4L2_FIELD_HAS_TOP(field) \
142 ((field) == V4L2_FIELD_TOP ||\
143 (field) == V4L2_FIELD_INTERLACED ||\
144 (field) == V4L2_FIELD_SEQ_TB ||\
145 (field) == V4L2_FIELD_SEQ_BT)
146 #define V4L2_FIELD_HAS_BOTTOM(field) \
147 ((field) == V4L2_FIELD_BOTTOM ||\
148 (field) == V4L2_FIELD_INTERLACED ||\
149 (field) == V4L2_FIELD_SEQ_TB ||\
150 (field) == V4L2_FIELD_SEQ_BT)
151 #define V4L2_FIELD_HAS_BOTH(field) \
152 ((field) == V4L2_FIELD_INTERLACED ||\
153 (field) == V4L2_FIELD_SEQ_TB ||\
154 (field) == V4L2_FIELD_SEQ_BT)
157 V4L2_BUF_TYPE_VIDEO_CAPTURE
= 1,
158 V4L2_BUF_TYPE_VIDEO_OUTPUT
= 2,
159 V4L2_BUF_TYPE_VIDEO_OVERLAY
= 3,
160 V4L2_BUF_TYPE_VBI_CAPTURE
= 4,
161 V4L2_BUF_TYPE_VBI_OUTPUT
= 5,
163 /* Experimental Sliced VBI */
164 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
= 6,
165 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT
= 7,
167 V4L2_BUF_TYPE_PRIVATE
= 0x80,
170 enum v4l2_ctrl_type
{
171 V4L2_CTRL_TYPE_INTEGER
= 1,
172 V4L2_CTRL_TYPE_BOOLEAN
= 2,
173 V4L2_CTRL_TYPE_MENU
= 3,
174 V4L2_CTRL_TYPE_BUTTON
= 4,
177 enum v4l2_tuner_type
{
178 V4L2_TUNER_RADIO
= 1,
179 V4L2_TUNER_ANALOG_TV
= 2,
180 V4L2_TUNER_DIGITAL_TV
= 3,
184 V4L2_MEMORY_MMAP
= 1,
185 V4L2_MEMORY_USERPTR
= 2,
186 V4L2_MEMORY_OVERLAY
= 3,
189 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
190 enum v4l2_colorspace
{
191 /* ITU-R 601 -- broadcast NTSC/PAL */
192 V4L2_COLORSPACE_SMPTE170M
= 1,
194 /* 1125-Line (US) HDTV */
195 V4L2_COLORSPACE_SMPTE240M
= 2,
197 /* HD and modern captures. */
198 V4L2_COLORSPACE_REC709
= 3,
200 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
201 V4L2_COLORSPACE_BT878
= 4,
203 /* These should be useful. Assume 601 extents. */
204 V4L2_COLORSPACE_470_SYSTEM_M
= 5,
205 V4L2_COLORSPACE_470_SYSTEM_BG
= 6,
207 /* I know there will be cameras that send this. So, this is
208 * unspecified chromaticities and full 0-255 on each of the
211 V4L2_COLORSPACE_JPEG
= 7,
213 /* For RGB colourspaces, this is probably a good start. */
214 V4L2_COLORSPACE_SRGB
= 8,
218 V4L2_PRIORITY_UNSET
= 0, /* not initialized */
219 V4L2_PRIORITY_BACKGROUND
= 1,
220 V4L2_PRIORITY_INTERACTIVE
= 2,
221 V4L2_PRIORITY_RECORD
= 3,
222 V4L2_PRIORITY_DEFAULT
= V4L2_PRIORITY_INTERACTIVE
,
238 * D R I V E R C A P A B I L I T I E S
240 struct v4l2_capability
242 __u8 driver
[16]; /* i.e. "bttv" */
243 __u8 card
[32]; /* i.e. "Hauppauge WinTV" */
244 __u8 bus_info
[32]; /* "PCI:" + pci_name(pci_dev) */
245 __u32 version
; /* should use KERNEL_VERSION() */
246 __u32 capabilities
; /* Device capabilities */
250 /* Values for 'capabilities' field */
251 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
252 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
253 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
254 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
255 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
257 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
258 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
260 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
262 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
263 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
264 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
266 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
267 #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
268 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
271 * V I D E O I M A G E F O R M A T
274 struct v4l2_pix_format
279 enum v4l2_field field
;
280 __u32 bytesperline
; /* for padding, zero if unused */
282 enum v4l2_colorspace colorspace
;
283 __u32 priv
; /* private data, depends on pixelformat */
286 /* Pixel format FOURCC depth Description */
287 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R','G','B','1') /* 8 RGB-3-3-2 */
288 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R','G','B','O') /* 16 RGB-5-5-5 */
289 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R','G','B','P') /* 16 RGB-5-6-5 */
290 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16 RGB-5-5-5 BE */
291 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16 RGB-5-6-5 BE */
292 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B','G','R','3') /* 24 BGR-8-8-8 */
293 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R','G','B','3') /* 24 RGB-8-8-8 */
294 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B','G','R','4') /* 32 BGR-8-8-8-8 */
295 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R','G','B','4') /* 32 RGB-8-8-8-8 */
296 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G','R','E','Y') /* 8 Greyscale */
297 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y','V','U','9') /* 9 YVU 4:1:0 */
298 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y','V','1','2') /* 12 YVU 4:2:0 */
299 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y','U','Y','V') /* 16 YUV 4:2:2 */
300 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U','Y','V','Y') /* 16 YUV 4:2:2 */
301 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16 YVU422 planar */
302 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16 YVU411 planar */
303 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y','4','1','P') /* 12 YUV 4:1:1 */
305 /* two planes -- one Y, one Cr + Cb interleaved */
306 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N','V','1','2') /* 12 Y/CbCr 4:2:0 */
307 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N','V','2','1') /* 12 Y/CrCb 4:2:0 */
309 /* The following formats are not defined in the V4L2 specification */
310 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y','U','V','9') /* 9 YUV 4:1:0 */
311 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y','U','1','2') /* 12 YUV 4:2:0 */
312 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y','Y','U','V') /* 16 YUV 4:2:2 */
313 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H','I','2','4') /* 8 8-bit color */
315 /* see http://www.siliconimaging.com/RGB%20Bayer.htm */
316 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B','A','8','1') /* 8 BGBG.. GRGR.. */
318 /* compressed formats */
319 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M','J','P','G') /* Motion-JPEG */
320 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J','P','E','G') /* JFIF JPEG */
321 #define V4L2_PIX_FMT_DV v4l2_fourcc('d','v','s','d') /* 1394 */
322 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M','P','E','G') /* MPEG */
324 /* Vendor-specific formats */
325 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W','N','V','A') /* Winnov hw compress */
326 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S','9','1','0') /* SN9C10x compression */
327 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') /* pwc older webcam */
328 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') /* pwc newer webcam */
329 #define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E','6','2','5') /* ET61X251 compression */
332 * F O R M A T E N U M E R A T I O N
336 __u32 index
; /* Format number */
337 enum v4l2_buf_type type
; /* buffer type */
339 __u8 description
[32]; /* Description string */
340 __u32 pixelformat
; /* Format fourcc */
344 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
362 #define V4L2_TC_TYPE_24FPS 1
363 #define V4L2_TC_TYPE_25FPS 2
364 #define V4L2_TC_TYPE_30FPS 3
365 #define V4L2_TC_TYPE_50FPS 4
366 #define V4L2_TC_TYPE_60FPS 5
369 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
370 #define V4L2_TC_FLAG_COLORFRAME 0x0002
371 #define V4L2_TC_USERBITS_field 0x000C
372 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
373 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
374 /* The above is based on SMPTE timecodes */
378 * 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
380 * ### WARNING: this is still work-in-progress right now, most likely
381 * ### there will be some incompatible changes.
386 enum v4l2_bitrate_mode
{
387 V4L2_BITRATE_NONE
= 0, /* not specified */
388 V4L2_BITRATE_CBR
, /* constant bitrate */
389 V4L2_BITRATE_VBR
, /* variable bitrate */
391 struct v4l2_bitrate
{
392 /* rates are specified in kbit/sec */
393 enum v4l2_bitrate_mode mode
;
395 __u32 target
; /* use this one for CBR */
399 enum v4l2_mpeg_streamtype
{
400 V4L2_MPEG_SS_1
, /* MPEG-1 system stream */
401 V4L2_MPEG_PS_2
, /* MPEG-2 program stream */
402 V4L2_MPEG_TS_2
, /* MPEG-2 transport stream */
403 V4L2_MPEG_PS_DVD
, /* MPEG-2 program stream with DVD header fixups */
405 enum v4l2_mpeg_audiotype
{
406 V4L2_MPEG_AU_2_I
, /* MPEG-2 layer 1 */
407 V4L2_MPEG_AU_2_II
, /* MPEG-2 layer 2 */
408 V4L2_MPEG_AU_2_III
, /* MPEG-2 layer 3 */
409 V4L2_MPEG_AC3
, /* AC3 */
410 V4L2_MPEG_LPCM
, /* LPCM */
412 enum v4l2_mpeg_videotype
{
413 V4L2_MPEG_VI_1
, /* MPEG-1 */
414 V4L2_MPEG_VI_2
, /* MPEG-2 */
416 enum v4l2_mpeg_aspectratio
{
417 V4L2_MPEG_ASPECT_SQUARE
= 1, /* square pixel */
418 V4L2_MPEG_ASPECT_4_3
= 2, /* 4 : 3 */
419 V4L2_MPEG_ASPECT_16_9
= 3, /* 16 : 9 */
420 V4L2_MPEG_ASPECT_1_221
= 4, /* 1 : 2,21 */
423 struct v4l2_mpeg_compression
{
425 enum v4l2_mpeg_streamtype st_type
;
426 struct v4l2_bitrate st_bitrate
;
428 /* transport streams */
436 __u16 reserved_1
; /* align */
439 enum v4l2_mpeg_audiotype au_type
;
440 struct v4l2_bitrate au_bitrate
;
441 __u32 au_sample_rate
;
443 __u8 reserved_2
[3]; /* align */
446 enum v4l2_mpeg_videotype vi_type
;
447 enum v4l2_mpeg_aspectratio vi_aspect_ratio
;
448 struct v4l2_bitrate vi_bitrate
;
450 __u16 vi_frames_per_gop
;
451 __u16 vi_bframes_count
;
453 __u8 reserved_3
[3]; /* align */
458 __u32 reserved_4
:30; /* align */
460 /* I don't expect the above being perfect yet ;) */
464 struct v4l2_jpegcompression
468 int APPn
; /* Number of APP segment to be written,
470 int APP_len
; /* Length of data in JPEG APPn segment */
471 char APP_data
[60]; /* Data in the JPEG APPn segment. */
473 int COM_len
; /* Length of data in JPEG COM segment */
474 char COM_data
[60]; /* Data in JPEG COM segment */
476 __u32 jpeg_markers
; /* Which markers should go into the JPEG
477 * output. Unless you exactly know what
478 * you do, leave them untouched.
479 * Inluding less markers will make the
480 * resulting code smaller, but there will
481 * be fewer aplications which can read it.
482 * The presence of the APP and COM marker
483 * is influenced by APP_len and COM_len
484 * ONLY, not by this property! */
486 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
487 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
488 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
489 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
490 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
491 * allways use APP0 */
496 * M E M O R Y - M A P P I N G B U F F E R S
498 struct v4l2_requestbuffers
501 enum v4l2_buf_type type
;
502 enum v4l2_memory memory
;
509 enum v4l2_buf_type type
;
512 enum v4l2_field field
;
513 struct timeval timestamp
;
514 struct v4l2_timecode timecode
;
517 /* memory location */
518 enum v4l2_memory memory
;
521 unsigned long userptr
;
528 /* Flags for 'flags' field */
529 #define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
530 #define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
531 #define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
532 #define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
533 #define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
534 #define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
535 #define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
536 #define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
539 * O V E R L A Y P R E V I E W
541 struct v4l2_framebuffer
545 /* FIXME: in theory we should pass something like PCI device + memory
546 * region + offset instead of some physical address */
548 struct v4l2_pix_format fmt
;
550 /* Flags for the 'capability' field. Read only */
551 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
552 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
553 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
554 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
555 /* Flags for the 'flags' field. */
556 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
557 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
558 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
563 struct v4l2_clip __user
*next
;
569 enum v4l2_field field
;
571 struct v4l2_clip __user
*clips
;
578 * C A P T U R E P A R A M E T E R S
580 struct v4l2_captureparm
582 __u32 capability
; /* Supported modes */
583 __u32 capturemode
; /* Current mode */
584 struct v4l2_fract timeperframe
; /* Time per frame in .1us units */
585 __u32 extendedmode
; /* Driver-specific extensions */
586 __u32 readbuffers
; /* # of buffers for read */
589 /* Flags for 'capability' and 'capturemode' fields */
590 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
591 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
593 struct v4l2_outputparm
595 __u32 capability
; /* Supported modes */
596 __u32 outputmode
; /* Current mode */
597 struct v4l2_fract timeperframe
; /* Time per frame in seconds */
598 __u32 extendedmode
; /* Driver-specific extensions */
599 __u32 writebuffers
; /* # of buffers for write */
604 * I N P U T I M A G E C R O P P I N G
607 struct v4l2_cropcap
{
608 enum v4l2_buf_type type
;
609 struct v4l2_rect bounds
;
610 struct v4l2_rect defrect
;
611 struct v4l2_fract pixelaspect
;
615 enum v4l2_buf_type type
;
620 * A N A L O G V I D E O S T A N D A R D
623 typedef __u64 v4l2_std_id
;
625 /* one bit for each */
626 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
627 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
628 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
629 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
630 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
631 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
632 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
633 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
635 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
636 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
637 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
638 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
640 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
641 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
642 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
643 #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000)
645 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
646 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
647 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
648 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
649 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
650 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
651 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
652 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
655 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
656 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
658 /* some merged standards */
659 #define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
660 #define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
661 #define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
662 #define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
664 /* some common needed stuff */
665 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
668 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
671 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
675 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
676 V4L2_STD_NTSC_M_JP |\
678 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
681 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
688 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
692 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
696 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
697 V4L2_STD_ATSC_16_VSB)
699 #define V4L2_STD_UNKNOWN 0
700 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
708 struct v4l2_fract frameperiod
; /* Frames, not fields */
715 * V I D E O I N P U T S
719 __u32 index
; /* Which input */
720 __u8 name
[32]; /* Label */
721 __u32 type
; /* Type of input */
722 __u32 audioset
; /* Associated audios (bitfield) */
723 __u32 tuner
; /* Associated tuner */
728 /* Values for the 'type' field */
729 #define V4L2_INPUT_TYPE_TUNER 1
730 #define V4L2_INPUT_TYPE_CAMERA 2
732 /* field 'status' - general */
733 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
734 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
735 #define V4L2_IN_ST_NO_COLOR 0x00000004
737 /* field 'status' - analog */
738 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
739 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
741 /* field 'status' - digital */
742 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
743 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
744 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
746 /* field 'status' - VCR and set-top box */
747 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
748 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
749 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
752 * V I D E O O U T P U T S
756 __u32 index
; /* Which output */
757 __u8 name
[32]; /* Label */
758 __u32 type
; /* Type of output */
759 __u32 audioset
; /* Associated audios (bitfield) */
760 __u32 modulator
; /* Associated modulator */
764 /* Values for the 'type' field */
765 #define V4L2_OUTPUT_TYPE_MODULATOR 1
766 #define V4L2_OUTPUT_TYPE_ANALOG 2
767 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
778 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
779 struct v4l2_queryctrl
782 enum v4l2_ctrl_type type
;
783 __u8 name
[32]; /* Whatever */
784 __s32 minimum
; /* Note signedness */
792 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
793 struct v4l2_querymenu
797 __u8 name
[32]; /* Whatever */
802 #define V4L2_CTRL_FLAG_DISABLED 0x0001
803 #define V4L2_CTRL_FLAG_GRABBED 0x0002
805 /* Control IDs defined by V4L2 */
806 #define V4L2_CID_BASE 0x00980900
807 /* IDs reserved for driver specific controls */
808 #define V4L2_CID_PRIVATE_BASE 0x08000000
810 #define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
811 #define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
812 #define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
813 #define V4L2_CID_HUE (V4L2_CID_BASE+3)
814 #define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
815 #define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
816 #define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
817 #define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
818 #define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
819 #define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
820 #define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11)
821 #define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
822 #define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
823 #define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
824 #define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
825 #define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
826 #define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* ? Not sure */
827 #define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
828 #define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
829 #define V4L2_CID_GAIN (V4L2_CID_BASE+19)
830 #define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
831 #define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
832 #define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
833 #define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
834 #define V4L2_CID_LASTP1 (V4L2_CID_BASE+24) /* last CID + 1 */
843 enum v4l2_tuner_type type
;
854 struct v4l2_modulator
865 /* Flags for the 'capability' field */
866 #define V4L2_TUNER_CAP_LOW 0x0001
867 #define V4L2_TUNER_CAP_NORM 0x0002
868 #define V4L2_TUNER_CAP_STEREO 0x0010
869 #define V4L2_TUNER_CAP_LANG2 0x0020
870 #define V4L2_TUNER_CAP_SAP 0x0020
871 #define V4L2_TUNER_CAP_LANG1 0x0040
873 /* Flags for the 'rxsubchans' field */
874 #define V4L2_TUNER_SUB_MONO 0x0001
875 #define V4L2_TUNER_SUB_STEREO 0x0002
876 #define V4L2_TUNER_SUB_LANG2 0x0004
877 #define V4L2_TUNER_SUB_SAP 0x0004
878 #define V4L2_TUNER_SUB_LANG1 0x0008
880 /* Values for the 'audmode' field */
881 #define V4L2_TUNER_MODE_MONO 0x0000
882 #define V4L2_TUNER_MODE_STEREO 0x0001
883 #define V4L2_TUNER_MODE_LANG2 0x0002
884 #define V4L2_TUNER_MODE_SAP 0x0002
885 #define V4L2_TUNER_MODE_LANG1 0x0003
887 struct v4l2_frequency
890 enum v4l2_tuner_type type
;
906 /* Flags for the 'capability' field */
907 #define V4L2_AUDCAP_STEREO 0x00001
908 #define V4L2_AUDCAP_AVL 0x00002
910 /* Flags for the 'mode' field */
911 #define V4L2_AUDMODE_AVL 0x00001
923 * D A T A S E R V I C E S ( V B I )
925 * Data services API by Michael Schimek
930 struct v4l2_vbi_format
932 __u32 sampling_rate
; /* in 1 Hz */
934 __u32 samples_per_line
;
935 __u32 sample_format
; /* V4L2_PIX_FMT_* */
938 __u32 flags
; /* V4L2_VBI_* */
939 __u32 reserved
[2]; /* must be zero */
943 #define V4L2_VBI_UNSYNC (1<< 0)
944 #define V4L2_VBI_INTERLACED (1<< 1)
949 * This implements is a proposal V4L2 API to allow SLICED VBI
950 * required for some hardware encoders. It should change without
951 * notice in the definitive implementation.
954 struct v4l2_sliced_vbi_format
957 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
958 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
959 (equals frame lines 313-336 for 625 line video
960 standards, 263-286 for 525 line standards) */
961 __u16 service_lines
[2][24];
963 __u32 reserved
[2]; /* must be zero */
966 /* Teletext World System Teletext
967 (WST), defined on ITU-R BT.653-2 */
968 #define V4L2_SLICED_TELETEXT_PAL_B (0x000001)
969 #define V4L2_SLICED_TELETEXT_PAL_C (0x000002)
970 #define V4L2_SLICED_TELETEXT_NTSC_B (0x000010)
971 #define V4L2_SLICED_TELETEXT_SECAM (0x000020)
973 /* Teletext North American Broadcast Teletext Specification
974 (NABTS), defined on ITU-R BT.653-2 */
975 #define V4L2_SLICED_TELETEXT_NTSC_C (0x000040)
976 #define V4L2_SLICED_TELETEXT_NTSC_D (0x000080)
978 /* Video Program System, defined on ETS 300 231*/
979 #define V4L2_SLICED_VPS (0x000400)
981 /* Closed Caption, defined on EIA-608 */
982 #define V4L2_SLICED_CAPTION_525 (0x001000)
983 #define V4L2_SLICED_CAPTION_625 (0x002000)
985 /* Wide Screen System, defined on ITU-R BT1119.1 */
986 #define V4L2_SLICED_WSS_625 (0x004000)
988 /* Wide Screen System, defined on IEC 61880 */
989 #define V4L2_SLICED_WSS_525 (0x008000)
991 /* Vertical Interval Timecode (VITC), defined on SMPTE 12M */
992 #define V4l2_SLICED_VITC_625 (0x010000)
993 #define V4l2_SLICED_VITC_525 (0x020000)
995 #define V4L2_SLICED_TELETEXT_B (V4L2_SLICED_TELETEXT_PAL_B |\
996 V4L2_SLICED_TELETEXT_NTSC_B)
998 #define V4L2_SLICED_TELETEXT (V4L2_SLICED_TELETEXT_PAL_B |\
999 V4L2_SLICED_TELETEXT_PAL_C |\
1000 V4L2_SLICED_TELETEXT_SECAM |\
1001 V4L2_SLICED_TELETEXT_NTSC_B |\
1002 V4L2_SLICED_TELETEXT_NTSC_C |\
1003 V4L2_SLICED_TELETEXT_NTSC_D)
1005 #define V4L2_SLICED_CAPTION (V4L2_SLICED_CAPTION_525 |\
1006 V4L2_SLICED_CAPTION_625)
1008 #define V4L2_SLICED_WSS (V4L2_SLICED_WSS_525 |\
1009 V4L2_SLICED_WSS_625)
1011 #define V4L2_SLICED_VITC (V4L2_SLICED_VITC_525 |\
1012 V4L2_SLICED_VITC_625)
1014 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_TELETEXT_NTSC_B |\
1015 V4L2_SLICED_TELETEXT_NTSC_C |\
1016 V4L2_SLICED_TELETEXT_NTSC_D |\
1017 V4L2_SLICED_CAPTION_525 |\
1018 V4L2_SLICED_WSS_525 |\
1019 V4l2_SLICED_VITC_525)
1021 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_PAL_B |\
1022 V4L2_SLICED_TELETEXT_PAL_C |\
1023 V4L2_SLICED_TELETEXT_SECAM |\
1025 V4L2_SLICED_CAPTION_625 |\
1026 V4L2_SLICED_WSS_625 |\
1027 V4l2_SLICED_VITC_625)
1029 struct v4l2_sliced_vbi_cap
1032 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1033 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1034 (equals frame lines 313-336 for 625 line video
1035 standards, 263-286 for 525 line standards) */
1036 __u16 service_lines
[2][24];
1037 __u32 reserved
[4]; /* must be 0 */
1040 struct v4l2_sliced_vbi_data
1043 __u32 field
; /* 0: first field, 1: second field */
1044 __u32 line
; /* 1-23 */
1045 __u32 reserved
; /* must be 0 */
1051 * A G G R E G A T E S T R U C T U R E S
1054 /* Stream data format
1058 enum v4l2_buf_type type
;
1061 struct v4l2_pix_format pix
; // V4L2_BUF_TYPE_VIDEO_CAPTURE
1062 struct v4l2_window win
; // V4L2_BUF_TYPE_VIDEO_OVERLAY
1063 struct v4l2_vbi_format vbi
; // V4L2_BUF_TYPE_VBI_CAPTURE
1065 struct v4l2_sliced_vbi_format sliced
; // V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
1067 __u8 raw_data
[200]; // user-defined
1072 /* Stream type-dependent parameters
1074 struct v4l2_streamparm
1076 enum v4l2_buf_type type
;
1079 struct v4l2_captureparm capture
;
1080 struct v4l2_outputparm output
;
1081 __u8 raw_data
[200]; /* user-defined */
1088 * 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
1091 #define VIDIOC_QUERYCAP _IOR ('V', 0, struct v4l2_capability)
1092 #define VIDIOC_RESERVED _IO ('V', 1)
1093 #define VIDIOC_ENUM_FMT _IOWR ('V', 2, struct v4l2_fmtdesc)
1094 #define VIDIOC_G_FMT _IOWR ('V', 4, struct v4l2_format)
1095 #define VIDIOC_S_FMT _IOWR ('V', 5, struct v4l2_format)
1096 #define VIDIOC_G_MPEGCOMP _IOR ('V', 6, struct v4l2_mpeg_compression)
1097 #define VIDIOC_S_MPEGCOMP _IOW ('V', 7, struct v4l2_mpeg_compression)
1098 #define VIDIOC_REQBUFS _IOWR ('V', 8, struct v4l2_requestbuffers)
1099 #define VIDIOC_QUERYBUF _IOWR ('V', 9, struct v4l2_buffer)
1100 #define VIDIOC_G_FBUF _IOR ('V', 10, struct v4l2_framebuffer)
1101 #define VIDIOC_S_FBUF _IOW ('V', 11, struct v4l2_framebuffer)
1102 #define VIDIOC_OVERLAY _IOW ('V', 14, int)
1103 #define VIDIOC_QBUF _IOWR ('V', 15, struct v4l2_buffer)
1104 #define VIDIOC_DQBUF _IOWR ('V', 17, struct v4l2_buffer)
1105 #define VIDIOC_STREAMON _IOW ('V', 18, int)
1106 #define VIDIOC_STREAMOFF _IOW ('V', 19, int)
1107 #define VIDIOC_G_PARM _IOWR ('V', 21, struct v4l2_streamparm)
1108 #define VIDIOC_S_PARM _IOWR ('V', 22, struct v4l2_streamparm)
1109 #define VIDIOC_G_STD _IOR ('V', 23, v4l2_std_id)
1110 #define VIDIOC_S_STD _IOW ('V', 24, v4l2_std_id)
1111 #define VIDIOC_ENUMSTD _IOWR ('V', 25, struct v4l2_standard)
1112 #define VIDIOC_ENUMINPUT _IOWR ('V', 26, struct v4l2_input)
1113 #define VIDIOC_G_CTRL _IOWR ('V', 27, struct v4l2_control)
1114 #define VIDIOC_S_CTRL _IOWR ('V', 28, struct v4l2_control)
1115 #define VIDIOC_G_TUNER _IOWR ('V', 29, struct v4l2_tuner)
1116 #define VIDIOC_S_TUNER _IOW ('V', 30, struct v4l2_tuner)
1117 #define VIDIOC_G_AUDIO _IOR ('V', 33, struct v4l2_audio)
1118 #define VIDIOC_S_AUDIO _IOW ('V', 34, struct v4l2_audio)
1119 #define VIDIOC_QUERYCTRL _IOWR ('V', 36, struct v4l2_queryctrl)
1120 #define VIDIOC_QUERYMENU _IOWR ('V', 37, struct v4l2_querymenu)
1121 #define VIDIOC_G_INPUT _IOR ('V', 38, int)
1122 #define VIDIOC_S_INPUT _IOWR ('V', 39, int)
1123 #define VIDIOC_G_OUTPUT _IOR ('V', 46, int)
1124 #define VIDIOC_S_OUTPUT _IOWR ('V', 47, int)
1125 #define VIDIOC_ENUMOUTPUT _IOWR ('V', 48, struct v4l2_output)
1126 #define VIDIOC_G_AUDOUT _IOR ('V', 49, struct v4l2_audioout)
1127 #define VIDIOC_S_AUDOUT _IOW ('V', 50, struct v4l2_audioout)
1128 #define VIDIOC_G_MODULATOR _IOWR ('V', 54, struct v4l2_modulator)
1129 #define VIDIOC_S_MODULATOR _IOW ('V', 55, struct v4l2_modulator)
1130 #define VIDIOC_G_FREQUENCY _IOWR ('V', 56, struct v4l2_frequency)
1131 #define VIDIOC_S_FREQUENCY _IOW ('V', 57, struct v4l2_frequency)
1132 #define VIDIOC_CROPCAP _IOWR ('V', 58, struct v4l2_cropcap)
1133 #define VIDIOC_G_CROP _IOWR ('V', 59, struct v4l2_crop)
1134 #define VIDIOC_S_CROP _IOW ('V', 60, struct v4l2_crop)
1135 #define VIDIOC_G_JPEGCOMP _IOR ('V', 61, struct v4l2_jpegcompression)
1136 #define VIDIOC_S_JPEGCOMP _IOW ('V', 62, struct v4l2_jpegcompression)
1137 #define VIDIOC_QUERYSTD _IOR ('V', 63, v4l2_std_id)
1138 #define VIDIOC_TRY_FMT _IOWR ('V', 64, struct v4l2_format)
1139 #define VIDIOC_ENUMAUDIO _IOWR ('V', 65, struct v4l2_audio)
1140 #define VIDIOC_ENUMAUDOUT _IOWR ('V', 66, struct v4l2_audioout)
1141 #define VIDIOC_G_PRIORITY _IOR ('V', 67, enum v4l2_priority)
1142 #define VIDIOC_S_PRIORITY _IOW ('V', 68, enum v4l2_priority)
1144 #define VIDIOC_G_SLICED_VBI_CAP _IOR ('V', 69, struct v4l2_sliced_vbi_cap)
1146 #define VIDIOC_LOG_STATUS _IO ('V', 70)
1148 /* for compatibility, will go away some day */
1149 #define VIDIOC_OVERLAY_OLD _IOWR ('V', 14, int)
1150 #define VIDIOC_S_PARM_OLD _IOW ('V', 22, struct v4l2_streamparm)
1151 #define VIDIOC_S_CTRL_OLD _IOW ('V', 28, struct v4l2_control)
1152 #define VIDIOC_G_AUDIO_OLD _IOWR ('V', 33, struct v4l2_audio)
1153 #define VIDIOC_G_AUDOUT_OLD _IOWR ('V', 49, struct v4l2_audioout)
1154 #define VIDIOC_CROPCAP_OLD _IOR ('V', 58, struct v4l2_cropcap)
1156 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1162 * V 4 L 2 D R I V E R H E L P E R A P I
1164 * Some commonly needed functions for drivers (v4l2-common.o module)
1166 #include <linux/fs.h>
1168 /* Video standard functions */
1169 extern unsigned int v4l2_video_std_fps(struct v4l2_standard
*vs
);
1170 extern int v4l2_video_std_construct(struct v4l2_standard
*vs
,
1171 int id
, char *name
);
1173 /* prority handling */
1174 struct v4l2_prio_state
{
1177 int v4l2_prio_init(struct v4l2_prio_state
*global
);
1178 int v4l2_prio_change(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
,
1179 enum v4l2_priority
new);
1180 int v4l2_prio_open(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1181 int v4l2_prio_close(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1182 enum v4l2_priority
v4l2_prio_max(struct v4l2_prio_state
*global
);
1183 int v4l2_prio_check(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1185 /* names for fancy debug output */
1186 extern char *v4l2_field_names
[];
1187 extern char *v4l2_type_names
[];
1189 /* Compatibility layer interface -- v4l1-compat module */
1190 typedef int (*v4l2_kioctl
)(struct inode
*inode
, struct file
*file
,
1191 unsigned int cmd
, void *arg
);
1192 int v4l_compat_translate_ioctl(struct inode
*inode
, struct file
*file
,
1193 int cmd
, void *arg
, v4l2_kioctl driver_ioctl
);
1195 /* 32 Bits compatibility layer for 64 bits processors */
1196 extern long v4l_compat_ioctl32(struct file
*file
, unsigned int cmd
,
1200 #endif /* __KERNEL__ */
1201 #endif /* __LINUX_VIDEODEV2_H */