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>
21 #include <linux/compiler.h> /* need __user */
24 #define OBSOLETE_OWNER 1 /* It will be removed for 2.6.17 */
28 * Common stuff for both V4L1 and V4L2
29 * Moved from videodev.h
32 #define VIDEO_MAX_FRAME 32
34 #define VID_TYPE_CAPTURE 1 /* Can capture */
35 #define VID_TYPE_TUNER 2 /* Can tune */
36 #define VID_TYPE_TELETEXT 4 /* Does teletext */
37 #define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
38 #define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
39 #define VID_TYPE_CLIPPING 32 /* Can clip */
40 #define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
41 #define VID_TYPE_SCALES 128 /* Scalable */
42 #define VID_TYPE_MONOCHROME 256 /* Monochrome only */
43 #define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
44 #define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
45 #define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
46 #define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
47 #define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
51 /* Minor device allocation */
52 #define MINOR_VFL_TYPE_GRABBER_MIN 0
53 #define MINOR_VFL_TYPE_GRABBER_MAX 63
54 #define MINOR_VFL_TYPE_RADIO_MIN 64
55 #define MINOR_VFL_TYPE_RADIO_MAX 127
56 #define MINOR_VFL_TYPE_VTX_MIN 192
57 #define MINOR_VFL_TYPE_VTX_MAX 223
58 #define MINOR_VFL_TYPE_VBI_MIN 224
59 #define MINOR_VFL_TYPE_VBI_MAX 255
61 #define VFL_TYPE_GRABBER 0
62 #define VFL_TYPE_VBI 1
63 #define VFL_TYPE_RADIO 2
64 #define VFL_TYPE_VTX 3
76 /* device ops + callbacks */
77 struct file_operations
*fops
;
78 void (*release
)(struct video_device
*vfd
);
81 #if OBSOLETE_OWNER /* to be removed in 2.6.15 */
82 /* obsolete -- fops->owner is used instead */
84 /* dev->driver_data will be used instead some day.
85 * Use the video_{get|set}_drvdata() helper functions,
86 * so the switch over will be transparent for you.
87 * Or use {pci|usb}_{get|set}_drvdata() directly. */
91 /* for videodev.c intenal usage -- please don't touch */
92 int users
; /* video_exclusive_{open|close} ... */
93 struct semaphore lock
; /* ... helper function uses these */
94 char devfs_name
[64]; /* devfs */
95 struct class_device class_dev
; /* sysfs */
98 #define VIDEO_MAJOR 81
100 extern int video_register_device(struct video_device
*, int type
, int nr
);
101 extern void video_unregister_device(struct video_device
*);
102 extern int video_usercopy(struct inode
*inode
, struct file
*file
,
103 unsigned int cmd
, unsigned long arg
,
104 int (*func
)(struct inode
*inode
, struct file
*file
,
105 unsigned int cmd
, void *arg
));
107 /* helper functions to alloc / release struct video_device, the
108 later can be used for video_device->release() */
109 struct video_device
*video_device_alloc(void);
110 void video_device_release(struct video_device
*vfd
);
115 * M I S C E L L A N E O U S
118 /* Four-character-code (FOURCC) */
119 #define v4l2_fourcc(a,b,c,d)\
120 (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))
126 V4L2_FIELD_ANY
= 0, /* driver can choose from none,
127 top, bottom, interlaced
128 depending on whatever it thinks
129 is approximate ... */
130 V4L2_FIELD_NONE
= 1, /* this device has no fields ... */
131 V4L2_FIELD_TOP
= 2, /* top field only */
132 V4L2_FIELD_BOTTOM
= 3, /* bottom field only */
133 V4L2_FIELD_INTERLACED
= 4, /* both fields interlaced */
134 V4L2_FIELD_SEQ_TB
= 5, /* both fields sequential into one
135 buffer, top-bottom order */
136 V4L2_FIELD_SEQ_BT
= 6, /* same as above + bottom-top order */
137 V4L2_FIELD_ALTERNATE
= 7, /* both fields alternating into
140 #define V4L2_FIELD_HAS_TOP(field) \
141 ((field) == V4L2_FIELD_TOP ||\
142 (field) == V4L2_FIELD_INTERLACED ||\
143 (field) == V4L2_FIELD_SEQ_TB ||\
144 (field) == V4L2_FIELD_SEQ_BT)
145 #define V4L2_FIELD_HAS_BOTTOM(field) \
146 ((field) == V4L2_FIELD_BOTTOM ||\
147 (field) == V4L2_FIELD_INTERLACED ||\
148 (field) == V4L2_FIELD_SEQ_TB ||\
149 (field) == V4L2_FIELD_SEQ_BT)
150 #define V4L2_FIELD_HAS_BOTH(field) \
151 ((field) == V4L2_FIELD_INTERLACED ||\
152 (field) == V4L2_FIELD_SEQ_TB ||\
153 (field) == V4L2_FIELD_SEQ_BT)
156 V4L2_BUF_TYPE_VIDEO_CAPTURE
= 1,
157 V4L2_BUF_TYPE_VIDEO_OUTPUT
= 2,
158 V4L2_BUF_TYPE_VIDEO_OVERLAY
= 3,
159 V4L2_BUF_TYPE_VBI_CAPTURE
= 4,
160 V4L2_BUF_TYPE_VBI_OUTPUT
= 5,
162 /* Experimental Sliced VBI */
163 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
= 6,
164 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT
= 7,
166 V4L2_BUF_TYPE_PRIVATE
= 0x80,
169 enum v4l2_ctrl_type
{
170 V4L2_CTRL_TYPE_INTEGER
= 1,
171 V4L2_CTRL_TYPE_BOOLEAN
= 2,
172 V4L2_CTRL_TYPE_MENU
= 3,
173 V4L2_CTRL_TYPE_BUTTON
= 4,
176 enum v4l2_tuner_type
{
177 V4L2_TUNER_RADIO
= 1,
178 V4L2_TUNER_ANALOG_TV
= 2,
179 V4L2_TUNER_DIGITAL_TV
= 3,
183 V4L2_MEMORY_MMAP
= 1,
184 V4L2_MEMORY_USERPTR
= 2,
185 V4L2_MEMORY_OVERLAY
= 3,
188 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
189 enum v4l2_colorspace
{
190 /* ITU-R 601 -- broadcast NTSC/PAL */
191 V4L2_COLORSPACE_SMPTE170M
= 1,
193 /* 1125-Line (US) HDTV */
194 V4L2_COLORSPACE_SMPTE240M
= 2,
196 /* HD and modern captures. */
197 V4L2_COLORSPACE_REC709
= 3,
199 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
200 V4L2_COLORSPACE_BT878
= 4,
202 /* These should be useful. Assume 601 extents. */
203 V4L2_COLORSPACE_470_SYSTEM_M
= 5,
204 V4L2_COLORSPACE_470_SYSTEM_BG
= 6,
206 /* I know there will be cameras that send this. So, this is
207 * unspecified chromaticities and full 0-255 on each of the
210 V4L2_COLORSPACE_JPEG
= 7,
212 /* For RGB colourspaces, this is probably a good start. */
213 V4L2_COLORSPACE_SRGB
= 8,
217 V4L2_PRIORITY_UNSET
= 0, /* not initialized */
218 V4L2_PRIORITY_BACKGROUND
= 1,
219 V4L2_PRIORITY_INTERACTIVE
= 2,
220 V4L2_PRIORITY_RECORD
= 3,
221 V4L2_PRIORITY_DEFAULT
= V4L2_PRIORITY_INTERACTIVE
,
237 * D R I V E R C A P A B I L I T I E S
239 struct v4l2_capability
241 __u8 driver
[16]; /* i.e. "bttv" */
242 __u8 card
[32]; /* i.e. "Hauppauge WinTV" */
243 __u8 bus_info
[32]; /* "PCI:" + pci_name(pci_dev) */
244 __u32 version
; /* should use KERNEL_VERSION() */
245 __u32 capabilities
; /* Device capabilities */
249 /* Values for 'capabilities' field */
250 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
251 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
252 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
253 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
254 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
256 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
257 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
259 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
261 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
262 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
263 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
265 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
266 #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
267 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
270 * V I D E O I M A G E F O R M A T
273 struct v4l2_pix_format
278 enum v4l2_field field
;
279 __u32 bytesperline
; /* for padding, zero if unused */
281 enum v4l2_colorspace colorspace
;
282 __u32 priv
; /* private data, depends on pixelformat */
285 /* Pixel format FOURCC depth Description */
286 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R','G','B','1') /* 8 RGB-3-3-2 */
287 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R','G','B','O') /* 16 RGB-5-5-5 */
288 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R','G','B','P') /* 16 RGB-5-6-5 */
289 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16 RGB-5-5-5 BE */
290 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16 RGB-5-6-5 BE */
291 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B','G','R','3') /* 24 BGR-8-8-8 */
292 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R','G','B','3') /* 24 RGB-8-8-8 */
293 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B','G','R','4') /* 32 BGR-8-8-8-8 */
294 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R','G','B','4') /* 32 RGB-8-8-8-8 */
295 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G','R','E','Y') /* 8 Greyscale */
296 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y','V','U','9') /* 9 YVU 4:1:0 */
297 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y','V','1','2') /* 12 YVU 4:2:0 */
298 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y','U','Y','V') /* 16 YUV 4:2:2 */
299 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U','Y','V','Y') /* 16 YUV 4:2:2 */
300 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16 YVU422 planar */
301 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16 YVU411 planar */
302 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y','4','1','P') /* 12 YUV 4:1:1 */
304 /* two planes -- one Y, one Cr + Cb interleaved */
305 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N','V','1','2') /* 12 Y/CbCr 4:2:0 */
306 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N','V','2','1') /* 12 Y/CrCb 4:2:0 */
308 /* The following formats are not defined in the V4L2 specification */
309 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y','U','V','9') /* 9 YUV 4:1:0 */
310 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y','U','1','2') /* 12 YUV 4:2:0 */
311 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y','Y','U','V') /* 16 YUV 4:2:2 */
312 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H','I','2','4') /* 8 8-bit color */
314 /* see http://www.siliconimaging.com/RGB%20Bayer.htm */
315 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B','A','8','1') /* 8 BGBG.. GRGR.. */
317 /* compressed formats */
318 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M','J','P','G') /* Motion-JPEG */
319 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J','P','E','G') /* JFIF JPEG */
320 #define V4L2_PIX_FMT_DV v4l2_fourcc('d','v','s','d') /* 1394 */
321 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M','P','E','G') /* MPEG */
323 /* Vendor-specific formats */
324 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W','N','V','A') /* Winnov hw compress */
325 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S','9','1','0') /* SN9C10x compression */
326 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') /* pwc older webcam */
327 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') /* pwc newer webcam */
330 * F O R M A T E N U M E R A T I O N
334 __u32 index
; /* Format number */
335 enum v4l2_buf_type type
; /* buffer type */
337 __u8 description
[32]; /* Description string */
338 __u32 pixelformat
; /* Format fourcc */
342 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
360 #define V4L2_TC_TYPE_24FPS 1
361 #define V4L2_TC_TYPE_25FPS 2
362 #define V4L2_TC_TYPE_30FPS 3
363 #define V4L2_TC_TYPE_50FPS 4
364 #define V4L2_TC_TYPE_60FPS 5
367 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
368 #define V4L2_TC_FLAG_COLORFRAME 0x0002
369 #define V4L2_TC_USERBITS_field 0x000C
370 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
371 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
372 /* The above is based on SMPTE timecodes */
376 * 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
378 * ### WARNING: this is still work-in-progress right now, most likely
379 * ### there will be some incompatible changes.
384 enum v4l2_bitrate_mode
{
385 V4L2_BITRATE_NONE
= 0, /* not specified */
386 V4L2_BITRATE_CBR
, /* constant bitrate */
387 V4L2_BITRATE_VBR
, /* variable bitrate */
389 struct v4l2_bitrate
{
390 /* rates are specified in kbit/sec */
391 enum v4l2_bitrate_mode mode
;
393 __u32 target
; /* use this one for CBR */
397 enum v4l2_mpeg_streamtype
{
398 V4L2_MPEG_SS_1
, /* MPEG-1 system stream */
399 V4L2_MPEG_PS_2
, /* MPEG-2 program stream */
400 V4L2_MPEG_TS_2
, /* MPEG-2 transport stream */
401 V4L2_MPEG_PS_DVD
, /* MPEG-2 program stream with DVD header fixups */
403 enum v4l2_mpeg_audiotype
{
404 V4L2_MPEG_AU_2_I
, /* MPEG-2 layer 1 */
405 V4L2_MPEG_AU_2_II
, /* MPEG-2 layer 2 */
406 V4L2_MPEG_AU_2_III
, /* MPEG-2 layer 3 */
407 V4L2_MPEG_AC3
, /* AC3 */
408 V4L2_MPEG_LPCM
, /* LPCM */
410 enum v4l2_mpeg_videotype
{
411 V4L2_MPEG_VI_1
, /* MPEG-1 */
412 V4L2_MPEG_VI_2
, /* MPEG-2 */
414 enum v4l2_mpeg_aspectratio
{
415 V4L2_MPEG_ASPECT_SQUARE
= 1, /* square pixel */
416 V4L2_MPEG_ASPECT_4_3
= 2, /* 4 : 3 */
417 V4L2_MPEG_ASPECT_16_9
= 3, /* 16 : 9 */
418 V4L2_MPEG_ASPECT_1_221
= 4, /* 1 : 2,21 */
421 struct v4l2_mpeg_compression
{
423 enum v4l2_mpeg_streamtype st_type
;
424 struct v4l2_bitrate st_bitrate
;
426 /* transport streams */
434 __u16 reserved_1
; /* align */
437 enum v4l2_mpeg_audiotype au_type
;
438 struct v4l2_bitrate au_bitrate
;
439 __u32 au_sample_rate
;
441 __u8 reserved_2
[3]; /* align */
444 enum v4l2_mpeg_videotype vi_type
;
445 enum v4l2_mpeg_aspectratio vi_aspect_ratio
;
446 struct v4l2_bitrate vi_bitrate
;
448 __u16 vi_frames_per_gop
;
449 __u16 vi_bframes_count
;
451 __u8 reserved_3
[3]; /* align */
456 __u32 reserved_4
:30; /* align */
458 /* I don't expect the above being perfect yet ;) */
462 struct v4l2_jpegcompression
466 int APPn
; /* Number of APP segment to be written,
468 int APP_len
; /* Length of data in JPEG APPn segment */
469 char APP_data
[60]; /* Data in the JPEG APPn segment. */
471 int COM_len
; /* Length of data in JPEG COM segment */
472 char COM_data
[60]; /* Data in JPEG COM segment */
474 __u32 jpeg_markers
; /* Which markers should go into the JPEG
475 * output. Unless you exactly know what
476 * you do, leave them untouched.
477 * Inluding less markers will make the
478 * resulting code smaller, but there will
479 * be fewer aplications which can read it.
480 * The presence of the APP and COM marker
481 * is influenced by APP_len and COM_len
482 * ONLY, not by this property! */
484 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
485 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
486 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
487 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
488 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
489 * allways use APP0 */
494 * M E M O R Y - M A P P I N G B U F F E R S
496 struct v4l2_requestbuffers
499 enum v4l2_buf_type type
;
500 enum v4l2_memory memory
;
507 enum v4l2_buf_type type
;
510 enum v4l2_field field
;
511 struct timeval timestamp
;
512 struct v4l2_timecode timecode
;
515 /* memory location */
516 enum v4l2_memory memory
;
519 unsigned long userptr
;
526 /* Flags for 'flags' field */
527 #define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
528 #define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
529 #define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
530 #define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
531 #define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
532 #define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
533 #define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
534 #define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
537 * O V E R L A Y P R E V I E W
539 struct v4l2_framebuffer
543 /* FIXME: in theory we should pass something like PCI device + memory
544 * region + offset instead of some physical address */
546 struct v4l2_pix_format fmt
;
548 /* Flags for the 'capability' field. Read only */
549 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
550 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
551 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
552 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
553 /* Flags for the 'flags' field. */
554 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
555 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
556 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
561 struct v4l2_clip
*next
;
567 enum v4l2_field field
;
569 struct v4l2_clip __user
*clips
;
576 * C A P T U R E P A R A M E T E R S
578 struct v4l2_captureparm
580 __u32 capability
; /* Supported modes */
581 __u32 capturemode
; /* Current mode */
582 struct v4l2_fract timeperframe
; /* Time per frame in .1us units */
583 __u32 extendedmode
; /* Driver-specific extensions */
584 __u32 readbuffers
; /* # of buffers for read */
587 /* Flags for 'capability' and 'capturemode' fields */
588 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
589 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
591 struct v4l2_outputparm
593 __u32 capability
; /* Supported modes */
594 __u32 outputmode
; /* Current mode */
595 struct v4l2_fract timeperframe
; /* Time per frame in seconds */
596 __u32 extendedmode
; /* Driver-specific extensions */
597 __u32 writebuffers
; /* # of buffers for write */
602 * I N P U T I M A G E C R O P P I N G
605 struct v4l2_cropcap
{
606 enum v4l2_buf_type type
;
607 struct v4l2_rect bounds
;
608 struct v4l2_rect defrect
;
609 struct v4l2_fract pixelaspect
;
613 enum v4l2_buf_type type
;
618 * A N A L O G V I D E O S T A N D A R D
621 typedef __u64 v4l2_std_id
;
623 /* one bit for each */
624 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
625 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
626 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
627 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
628 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
629 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
630 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
631 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
633 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
634 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
635 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
636 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
638 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
639 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
640 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
642 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
643 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
644 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
645 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
646 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
647 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
648 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
649 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
652 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
653 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
655 /* some merged standards */
656 #define V4L2_STD_MN (V4L2_STD_PAL_M|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|V4L2_STD_NTSC)
657 #define V4L2_STD_B (V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_SECAM_B)
658 #define V4L2_STD_GH (V4L2_STD_PAL_G|V4L2_STD_PAL_H|V4L2_STD_SECAM_G|V4L2_STD_SECAM_H)
659 #define V4L2_STD_DK (V4L2_STD_PAL_DK|V4L2_STD_SECAM_DK)
661 /* some common needed stuff */
662 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
665 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
668 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
672 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
674 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
677 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
684 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
688 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
692 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
693 V4L2_STD_ATSC_16_VSB)
695 #define V4L2_STD_UNKNOWN 0
696 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
704 struct v4l2_fract frameperiod
; /* Frames, not fields */
711 * V I D E O I N P U T S
715 __u32 index
; /* Which input */
716 __u8 name
[32]; /* Label */
717 __u32 type
; /* Type of input */
718 __u32 audioset
; /* Associated audios (bitfield) */
719 __u32 tuner
; /* Associated tuner */
724 /* Values for the 'type' field */
725 #define V4L2_INPUT_TYPE_TUNER 1
726 #define V4L2_INPUT_TYPE_CAMERA 2
728 /* field 'status' - general */
729 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
730 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
731 #define V4L2_IN_ST_NO_COLOR 0x00000004
733 /* field 'status' - analog */
734 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
735 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
737 /* field 'status' - digital */
738 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
739 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
740 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
742 /* field 'status' - VCR and set-top box */
743 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
744 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
745 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
748 * V I D E O O U T P U T S
752 __u32 index
; /* Which output */
753 __u8 name
[32]; /* Label */
754 __u32 type
; /* Type of output */
755 __u32 audioset
; /* Associated audios (bitfield) */
756 __u32 modulator
; /* Associated modulator */
760 /* Values for the 'type' field */
761 #define V4L2_OUTPUT_TYPE_MODULATOR 1
762 #define V4L2_OUTPUT_TYPE_ANALOG 2
763 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
774 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
775 struct v4l2_queryctrl
778 enum v4l2_ctrl_type type
;
779 __u8 name
[32]; /* Whatever */
780 __s32 minimum
; /* Note signedness */
788 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
789 struct v4l2_querymenu
793 __u8 name
[32]; /* Whatever */
798 #define V4L2_CTRL_FLAG_DISABLED 0x0001
799 #define V4L2_CTRL_FLAG_GRABBED 0x0002
801 /* Control IDs defined by V4L2 */
802 #define V4L2_CID_BASE 0x00980900
803 /* IDs reserved for driver specific controls */
804 #define V4L2_CID_PRIVATE_BASE 0x08000000
806 #define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
807 #define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
808 #define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
809 #define V4L2_CID_HUE (V4L2_CID_BASE+3)
810 #define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
811 #define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
812 #define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
813 #define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
814 #define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
815 #define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
816 #define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11)
817 #define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
818 #define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
819 #define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
820 #define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
821 #define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
822 #define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* ? Not sure */
823 #define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
824 #define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
825 #define V4L2_CID_GAIN (V4L2_CID_BASE+19)
826 #define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
827 #define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
828 #define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
829 #define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
830 #define V4L2_CID_LASTP1 (V4L2_CID_BASE+24) /* last CID + 1 */
839 enum v4l2_tuner_type type
;
850 struct v4l2_modulator
861 /* Flags for the 'capability' field */
862 #define V4L2_TUNER_CAP_LOW 0x0001
863 #define V4L2_TUNER_CAP_NORM 0x0002
864 #define V4L2_TUNER_CAP_STEREO 0x0010
865 #define V4L2_TUNER_CAP_LANG2 0x0020
866 #define V4L2_TUNER_CAP_SAP 0x0020
867 #define V4L2_TUNER_CAP_LANG1 0x0040
869 /* Flags for the 'rxsubchans' field */
870 #define V4L2_TUNER_SUB_MONO 0x0001
871 #define V4L2_TUNER_SUB_STEREO 0x0002
872 #define V4L2_TUNER_SUB_LANG2 0x0004
873 #define V4L2_TUNER_SUB_SAP 0x0004
874 #define V4L2_TUNER_SUB_LANG1 0x0008
876 /* Values for the 'audmode' field */
877 #define V4L2_TUNER_MODE_MONO 0x0000
878 #define V4L2_TUNER_MODE_STEREO 0x0001
879 #define V4L2_TUNER_MODE_LANG2 0x0002
880 #define V4L2_TUNER_MODE_SAP 0x0002
881 #define V4L2_TUNER_MODE_LANG1 0x0003
883 struct v4l2_frequency
886 enum v4l2_tuner_type type
;
902 /* Flags for the 'capability' field */
903 #define V4L2_AUDCAP_STEREO 0x00001
904 #define V4L2_AUDCAP_AVL 0x00002
906 /* Flags for the 'mode' field */
907 #define V4L2_AUDMODE_AVL 0x00001
919 * D A T A S E R V I C E S ( V B I )
921 * Data services API by Michael Schimek
926 struct v4l2_vbi_format
928 __u32 sampling_rate
; /* in 1 Hz */
930 __u32 samples_per_line
;
931 __u32 sample_format
; /* V4L2_PIX_FMT_* */
934 __u32 flags
; /* V4L2_VBI_* */
935 __u32 reserved
[2]; /* must be zero */
939 #define V4L2_VBI_UNSYNC (1<< 0)
940 #define V4L2_VBI_INTERLACED (1<< 1)
945 * This implements is a proposal V4L2 API to allow SLICED VBI
946 * required for some hardware encoders. It should change without
947 * notice in the definitive implementation.
950 struct v4l2_sliced_vbi_format
953 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
954 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
955 (equals frame lines 313-336 for 625 line video
956 standards, 263-286 for 525 line standards) */
957 __u16 service_lines
[2][24];
959 __u32 reserved
[2]; /* must be zero */
962 /* Teletext World System Teletext
963 (WST), defined on ITU-R BT.653-2 */
964 #define V4L2_SLICED_TELETEXT_PAL_B (0x000001)
965 #define V4L2_SLICED_TELETEXT_PAL_C (0x000002)
966 #define V4L2_SLICED_TELETEXT_NTSC_B (0x000010)
967 #define V4L2_SLICED_TELETEXT_SECAM (0x000020)
969 /* Teletext North American Broadcast Teletext Specification
970 (NABTS), defined on ITU-R BT.653-2 */
971 #define V4L2_SLICED_TELETEXT_NTSC_C (0x000040)
972 #define V4L2_SLICED_TELETEXT_NTSC_D (0x000080)
974 /* Video Program System, defined on ETS 300 231*/
975 #define V4L2_SLICED_VPS (0x000400)
977 /* Closed Caption, defined on EIA-608 */
978 #define V4L2_SLICED_CAPTION_525 (0x001000)
979 #define V4L2_SLICED_CAPTION_625 (0x002000)
981 /* Wide Screen System, defined on ITU-R BT1119.1 */
982 #define V4L2_SLICED_WSS_625 (0x004000)
984 /* Wide Screen System, defined on IEC 61880 */
985 #define V4L2_SLICED_WSS_525 (0x008000)
987 /* Vertical Interval Timecode (VITC), defined on SMPTE 12M */
988 #define V4l2_SLICED_VITC_625 (0x010000)
989 #define V4l2_SLICED_VITC_525 (0x020000)
991 #define V4L2_SLICED_TELETEXT_B (V4L2_SLICED_TELETEXT_PAL_B |\
992 V4L2_SLICED_TELETEXT_NTSC_B)
994 #define V4L2_SLICED_TELETEXT (V4L2_SLICED_TELETEXT_PAL_B |\
995 V4L2_SLICED_TELETEXT_PAL_C |\
996 V4L2_SLICED_TELETEXT_SECAM |\
997 V4L2_SLICED_TELETEXT_NTSC_B |\
998 V4L2_SLICED_TELETEXT_NTSC_C |\
999 V4L2_SLICED_TELETEXT_NTSC_D)
1001 #define V4L2_SLICED_CAPTION (V4L2_SLICED_CAPTION_525 |\
1002 V4L2_SLICED_CAPTION_625)
1004 #define V4L2_SLICED_WSS (V4L2_SLICED_WSS_525 |\
1005 V4L2_SLICED_WSS_625)
1007 #define V4L2_SLICED_VITC (V4L2_SLICED_VITC_525 |\
1008 V4L2_SLICED_VITC_625)
1010 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_TELETEXT_NTSC_B |\
1011 V4L2_SLICED_TELETEXT_NTSC_C |\
1012 V4L2_SLICED_TELETEXT_NTSC_D |\
1013 V4L2_SLICED_CAPTION_525 |\
1014 V4L2_SLICED_WSS_525 |\
1015 V4l2_SLICED_VITC_525)
1017 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_PAL_B |\
1018 V4L2_SLICED_TELETEXT_PAL_C |\
1019 V4L2_SLICED_TELETEXT_SECAM |\
1021 V4L2_SLICED_CAPTION_625 |\
1022 V4L2_SLICED_WSS_625 |\
1023 V4l2_SLICED_VITC_625)
1025 struct v4l2_sliced_vbi_cap
1028 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1029 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1030 (equals frame lines 313-336 for 625 line video
1031 standards, 263-286 for 525 line standards) */
1032 __u16 service_lines
[2][24];
1033 __u32 reserved
[4]; /* must be 0 */
1036 struct v4l2_sliced_vbi_data
1039 __u32 field
; /* 0: first field, 1: second field */
1040 __u32 line
; /* 1-23 */
1041 __u32 reserved
; /* must be 0 */
1047 * A G G R E G A T E S T R U C T U R E S
1050 /* Stream data format
1054 enum v4l2_buf_type type
;
1057 struct v4l2_pix_format pix
; // V4L2_BUF_TYPE_VIDEO_CAPTURE
1058 struct v4l2_window win
; // V4L2_BUF_TYPE_VIDEO_OVERLAY
1059 struct v4l2_vbi_format vbi
; // V4L2_BUF_TYPE_VBI_CAPTURE
1061 struct v4l2_sliced_vbi_format sliced
; // V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
1063 __u8 raw_data
[200]; // user-defined
1068 /* Stream type-dependent parameters
1070 struct v4l2_streamparm
1072 enum v4l2_buf_type type
;
1075 struct v4l2_captureparm capture
;
1076 struct v4l2_outputparm output
;
1077 __u8 raw_data
[200]; /* user-defined */
1084 * 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
1087 #define VIDIOC_QUERYCAP _IOR ('V', 0, struct v4l2_capability)
1088 #define VIDIOC_RESERVED _IO ('V', 1)
1089 #define VIDIOC_ENUM_FMT _IOWR ('V', 2, struct v4l2_fmtdesc)
1090 #define VIDIOC_G_FMT _IOWR ('V', 4, struct v4l2_format)
1091 #define VIDIOC_S_FMT _IOWR ('V', 5, struct v4l2_format)
1092 #define VIDIOC_G_MPEGCOMP _IOR ('V', 6, struct v4l2_mpeg_compression)
1093 #define VIDIOC_S_MPEGCOMP _IOW ('V', 7, struct v4l2_mpeg_compression)
1094 #define VIDIOC_REQBUFS _IOWR ('V', 8, struct v4l2_requestbuffers)
1095 #define VIDIOC_QUERYBUF _IOWR ('V', 9, struct v4l2_buffer)
1096 #define VIDIOC_G_FBUF _IOR ('V', 10, struct v4l2_framebuffer)
1097 #define VIDIOC_S_FBUF _IOW ('V', 11, struct v4l2_framebuffer)
1098 #define VIDIOC_OVERLAY _IOW ('V', 14, int)
1099 #define VIDIOC_QBUF _IOWR ('V', 15, struct v4l2_buffer)
1100 #define VIDIOC_DQBUF _IOWR ('V', 17, struct v4l2_buffer)
1101 #define VIDIOC_STREAMON _IOW ('V', 18, int)
1102 #define VIDIOC_STREAMOFF _IOW ('V', 19, int)
1103 #define VIDIOC_G_PARM _IOWR ('V', 21, struct v4l2_streamparm)
1104 #define VIDIOC_S_PARM _IOWR ('V', 22, struct v4l2_streamparm)
1105 #define VIDIOC_G_STD _IOR ('V', 23, v4l2_std_id)
1106 #define VIDIOC_S_STD _IOW ('V', 24, v4l2_std_id)
1107 #define VIDIOC_ENUMSTD _IOWR ('V', 25, struct v4l2_standard)
1108 #define VIDIOC_ENUMINPUT _IOWR ('V', 26, struct v4l2_input)
1109 #define VIDIOC_G_CTRL _IOWR ('V', 27, struct v4l2_control)
1110 #define VIDIOC_S_CTRL _IOWR ('V', 28, struct v4l2_control)
1111 #define VIDIOC_G_TUNER _IOWR ('V', 29, struct v4l2_tuner)
1112 #define VIDIOC_S_TUNER _IOW ('V', 30, struct v4l2_tuner)
1113 #define VIDIOC_G_AUDIO _IOR ('V', 33, struct v4l2_audio)
1114 #define VIDIOC_S_AUDIO _IOW ('V', 34, struct v4l2_audio)
1115 #define VIDIOC_QUERYCTRL _IOWR ('V', 36, struct v4l2_queryctrl)
1116 #define VIDIOC_QUERYMENU _IOWR ('V', 37, struct v4l2_querymenu)
1117 #define VIDIOC_G_INPUT _IOR ('V', 38, int)
1118 #define VIDIOC_S_INPUT _IOWR ('V', 39, int)
1119 #define VIDIOC_G_OUTPUT _IOR ('V', 46, int)
1120 #define VIDIOC_S_OUTPUT _IOWR ('V', 47, int)
1121 #define VIDIOC_ENUMOUTPUT _IOWR ('V', 48, struct v4l2_output)
1122 #define VIDIOC_G_AUDOUT _IOR ('V', 49, struct v4l2_audioout)
1123 #define VIDIOC_S_AUDOUT _IOW ('V', 50, struct v4l2_audioout)
1124 #define VIDIOC_G_MODULATOR _IOWR ('V', 54, struct v4l2_modulator)
1125 #define VIDIOC_S_MODULATOR _IOW ('V', 55, struct v4l2_modulator)
1126 #define VIDIOC_G_FREQUENCY _IOWR ('V', 56, struct v4l2_frequency)
1127 #define VIDIOC_S_FREQUENCY _IOW ('V', 57, struct v4l2_frequency)
1128 #define VIDIOC_CROPCAP _IOWR ('V', 58, struct v4l2_cropcap)
1129 #define VIDIOC_G_CROP _IOWR ('V', 59, struct v4l2_crop)
1130 #define VIDIOC_S_CROP _IOW ('V', 60, struct v4l2_crop)
1131 #define VIDIOC_G_JPEGCOMP _IOR ('V', 61, struct v4l2_jpegcompression)
1132 #define VIDIOC_S_JPEGCOMP _IOW ('V', 62, struct v4l2_jpegcompression)
1133 #define VIDIOC_QUERYSTD _IOR ('V', 63, v4l2_std_id)
1134 #define VIDIOC_TRY_FMT _IOWR ('V', 64, struct v4l2_format)
1135 #define VIDIOC_ENUMAUDIO _IOWR ('V', 65, struct v4l2_audio)
1136 #define VIDIOC_ENUMAUDOUT _IOWR ('V', 66, struct v4l2_audioout)
1137 #define VIDIOC_G_PRIORITY _IOR ('V', 67, enum v4l2_priority)
1138 #define VIDIOC_S_PRIORITY _IOW ('V', 68, enum v4l2_priority)
1140 #define VIDIOC_G_SLICED_VBI_CAP _IOR ('V', 69, struct v4l2_sliced_vbi_cap)
1142 #define VIDIOC_LOG_STATUS _IO ('V', 70)
1144 /* for compatibility, will go away some day */
1145 #define VIDIOC_OVERLAY_OLD _IOWR ('V', 14, int)
1146 #define VIDIOC_S_PARM_OLD _IOW ('V', 22, struct v4l2_streamparm)
1147 #define VIDIOC_S_CTRL_OLD _IOW ('V', 28, struct v4l2_control)
1148 #define VIDIOC_G_AUDIO_OLD _IOWR ('V', 33, struct v4l2_audio)
1149 #define VIDIOC_G_AUDOUT_OLD _IOWR ('V', 49, struct v4l2_audioout)
1150 #define VIDIOC_CROPCAP_OLD _IOR ('V', 58, struct v4l2_cropcap)
1152 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1158 * V 4 L 2 D R I V E R H E L P E R A P I
1160 * Some commonly needed functions for drivers (v4l2-common.o module)
1162 #include <linux/fs.h>
1164 /* Video standard functions */
1165 extern unsigned int v4l2_video_std_fps(struct v4l2_standard
*vs
);
1166 extern int v4l2_video_std_construct(struct v4l2_standard
*vs
,
1167 int id
, char *name
);
1169 /* prority handling */
1170 struct v4l2_prio_state
{
1173 int v4l2_prio_init(struct v4l2_prio_state
*global
);
1174 int v4l2_prio_change(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
,
1175 enum v4l2_priority
new);
1176 int v4l2_prio_open(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1177 int v4l2_prio_close(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1178 enum v4l2_priority
v4l2_prio_max(struct v4l2_prio_state
*global
);
1179 int v4l2_prio_check(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1181 /* names for fancy debug output */
1182 extern char *v4l2_field_names
[];
1183 extern char *v4l2_type_names
[];
1185 /* Compatibility layer interface -- v4l1-compat module */
1186 typedef int (*v4l2_kioctl
)(struct inode
*inode
, struct file
*file
,
1187 unsigned int cmd
, void *arg
);
1188 int v4l_compat_translate_ioctl(struct inode
*inode
, struct file
*file
,
1189 int cmd
, void *arg
, v4l2_kioctl driver_ioctl
);
1191 /* 32 Bits compatibility layer for 64 bits processors */
1192 extern long v4l_compat_ioctl32(struct file
*file
, unsigned int cmd
,
1196 #endif /* __KERNEL__ */
1197 #endif /* __LINUX_VIDEODEV2_H */