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.15 */
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 #define VFL_TYPE_GRABBER 0
52 #define VFL_TYPE_VBI 1
53 #define VFL_TYPE_RADIO 2
54 #define VFL_TYPE_VTX 3
66 /* device ops + callbacks */
67 struct file_operations
*fops
;
68 void (*release
)(struct video_device
*vfd
);
71 #if OBSOLETE_OWNER /* to be removed in 2.6.15 */
72 /* obsolete -- fops->owner is used instead */
74 /* dev->driver_data will be used instead some day.
75 * Use the video_{get|set}_drvdata() helper functions,
76 * so the switch over will be transparent for you.
77 * Or use {pci|usb}_{get|set}_drvdata() directly. */
81 /* for videodev.c intenal usage -- please don't touch */
82 int users
; /* video_exclusive_{open|close} ... */
83 struct semaphore lock
; /* ... helper function uses these */
84 char devfs_name
[64]; /* devfs */
85 struct class_device class_dev
; /* sysfs */
88 #define VIDEO_MAJOR 81
90 extern int video_register_device(struct video_device
*, int type
, int nr
);
91 extern void video_unregister_device(struct video_device
*);
92 extern int video_usercopy(struct inode
*inode
, struct file
*file
,
93 unsigned int cmd
, unsigned long arg
,
94 int (*func
)(struct inode
*inode
, struct file
*file
,
95 unsigned int cmd
, void *arg
));
97 /* helper functions to alloc / release struct video_device, the
98 later can be used for video_device->release() */
99 struct video_device
*video_device_alloc(void);
100 void video_device_release(struct video_device
*vfd
);
105 * M I S C E L L A N E O U S
108 /* Four-character-code (FOURCC) */
109 #define v4l2_fourcc(a,b,c,d)\
110 (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))
116 V4L2_FIELD_ANY
= 0, /* driver can choose from none,
117 top, bottom, interlaced
118 depending on whatever it thinks
119 is approximate ... */
120 V4L2_FIELD_NONE
= 1, /* this device has no fields ... */
121 V4L2_FIELD_TOP
= 2, /* top field only */
122 V4L2_FIELD_BOTTOM
= 3, /* bottom field only */
123 V4L2_FIELD_INTERLACED
= 4, /* both fields interlaced */
124 V4L2_FIELD_SEQ_TB
= 5, /* both fields sequential into one
125 buffer, top-bottom order */
126 V4L2_FIELD_SEQ_BT
= 6, /* same as above + bottom-top order */
127 V4L2_FIELD_ALTERNATE
= 7, /* both fields alternating into
130 #define V4L2_FIELD_HAS_TOP(field) \
131 ((field) == V4L2_FIELD_TOP ||\
132 (field) == V4L2_FIELD_INTERLACED ||\
133 (field) == V4L2_FIELD_SEQ_TB ||\
134 (field) == V4L2_FIELD_SEQ_BT)
135 #define V4L2_FIELD_HAS_BOTTOM(field) \
136 ((field) == V4L2_FIELD_BOTTOM ||\
137 (field) == V4L2_FIELD_INTERLACED ||\
138 (field) == V4L2_FIELD_SEQ_TB ||\
139 (field) == V4L2_FIELD_SEQ_BT)
140 #define V4L2_FIELD_HAS_BOTH(field) \
141 ((field) == V4L2_FIELD_INTERLACED ||\
142 (field) == V4L2_FIELD_SEQ_TB ||\
143 (field) == V4L2_FIELD_SEQ_BT)
146 V4L2_BUF_TYPE_VIDEO_CAPTURE
= 1,
147 V4L2_BUF_TYPE_VIDEO_OUTPUT
= 2,
148 V4L2_BUF_TYPE_VIDEO_OVERLAY
= 3,
149 V4L2_BUF_TYPE_VBI_CAPTURE
= 4,
150 V4L2_BUF_TYPE_VBI_OUTPUT
= 5,
152 /* Experimental Sliced VBI */
153 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
= 6,
154 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT
= 7,
156 V4L2_BUF_TYPE_PRIVATE
= 0x80,
159 enum v4l2_ctrl_type
{
160 V4L2_CTRL_TYPE_INTEGER
= 1,
161 V4L2_CTRL_TYPE_BOOLEAN
= 2,
162 V4L2_CTRL_TYPE_MENU
= 3,
163 V4L2_CTRL_TYPE_BUTTON
= 4,
166 enum v4l2_tuner_type
{
167 V4L2_TUNER_RADIO
= 1,
168 V4L2_TUNER_ANALOG_TV
= 2,
169 V4L2_TUNER_DIGITAL_TV
= 3,
173 V4L2_MEMORY_MMAP
= 1,
174 V4L2_MEMORY_USERPTR
= 2,
175 V4L2_MEMORY_OVERLAY
= 3,
178 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
179 enum v4l2_colorspace
{
180 /* ITU-R 601 -- broadcast NTSC/PAL */
181 V4L2_COLORSPACE_SMPTE170M
= 1,
183 /* 1125-Line (US) HDTV */
184 V4L2_COLORSPACE_SMPTE240M
= 2,
186 /* HD and modern captures. */
187 V4L2_COLORSPACE_REC709
= 3,
189 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
190 V4L2_COLORSPACE_BT878
= 4,
192 /* These should be useful. Assume 601 extents. */
193 V4L2_COLORSPACE_470_SYSTEM_M
= 5,
194 V4L2_COLORSPACE_470_SYSTEM_BG
= 6,
196 /* I know there will be cameras that send this. So, this is
197 * unspecified chromaticities and full 0-255 on each of the
200 V4L2_COLORSPACE_JPEG
= 7,
202 /* For RGB colourspaces, this is probably a good start. */
203 V4L2_COLORSPACE_SRGB
= 8,
207 V4L2_PRIORITY_UNSET
= 0, /* not initialized */
208 V4L2_PRIORITY_BACKGROUND
= 1,
209 V4L2_PRIORITY_INTERACTIVE
= 2,
210 V4L2_PRIORITY_RECORD
= 3,
211 V4L2_PRIORITY_DEFAULT
= V4L2_PRIORITY_INTERACTIVE
,
227 * D R I V E R C A P A B I L I T I E S
229 struct v4l2_capability
231 __u8 driver
[16]; /* i.e. "bttv" */
232 __u8 card
[32]; /* i.e. "Hauppauge WinTV" */
233 __u8 bus_info
[32]; /* "PCI:" + pci_name(pci_dev) */
234 __u32 version
; /* should use KERNEL_VERSION() */
235 __u32 capabilities
; /* Device capabilities */
239 /* Values for 'capabilities' field */
240 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
241 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
242 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
243 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
244 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
246 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
247 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
249 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
251 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
252 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
253 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
255 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
256 #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
257 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
260 * V I D E O I M A G E F O R M A T
263 struct v4l2_pix_format
268 enum v4l2_field field
;
269 __u32 bytesperline
; /* for padding, zero if unused */
271 enum v4l2_colorspace colorspace
;
272 __u32 priv
; /* private data, depends on pixelformat */
275 /* Pixel format FOURCC depth Description */
276 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R','G','B','1') /* 8 RGB-3-3-2 */
277 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R','G','B','O') /* 16 RGB-5-5-5 */
278 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R','G','B','P') /* 16 RGB-5-6-5 */
279 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16 RGB-5-5-5 BE */
280 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16 RGB-5-6-5 BE */
281 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B','G','R','3') /* 24 BGR-8-8-8 */
282 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R','G','B','3') /* 24 RGB-8-8-8 */
283 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B','G','R','4') /* 32 BGR-8-8-8-8 */
284 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R','G','B','4') /* 32 RGB-8-8-8-8 */
285 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G','R','E','Y') /* 8 Greyscale */
286 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y','V','U','9') /* 9 YVU 4:1:0 */
287 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y','V','1','2') /* 12 YVU 4:2:0 */
288 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y','U','Y','V') /* 16 YUV 4:2:2 */
289 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U','Y','V','Y') /* 16 YUV 4:2:2 */
290 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16 YVU422 planar */
291 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16 YVU411 planar */
292 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y','4','1','P') /* 12 YUV 4:1:1 */
294 /* two planes -- one Y, one Cr + Cb interleaved */
295 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N','V','1','2') /* 12 Y/CbCr 4:2:0 */
296 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N','V','2','1') /* 12 Y/CrCb 4:2:0 */
298 /* The following formats are not defined in the V4L2 specification */
299 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y','U','V','9') /* 9 YUV 4:1:0 */
300 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y','U','1','2') /* 12 YUV 4:2:0 */
301 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y','Y','U','V') /* 16 YUV 4:2:2 */
302 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H','I','2','4') /* 8 8-bit color */
304 /* see http://www.siliconimaging.com/RGB%20Bayer.htm */
305 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B','A','8','1') /* 8 BGBG.. GRGR.. */
307 /* compressed formats */
308 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M','J','P','G') /* Motion-JPEG */
309 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J','P','E','G') /* JFIF JPEG */
310 #define V4L2_PIX_FMT_DV v4l2_fourcc('d','v','s','d') /* 1394 */
311 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M','P','E','G') /* MPEG */
313 /* Vendor-specific formats */
314 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W','N','V','A') /* Winnov hw compress */
315 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S','9','1','0') /* SN9C10x compression */
316 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') /* pwc older webcam */
317 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') /* pwc newer webcam */
320 * F O R M A T E N U M E R A T I O N
324 __u32 index
; /* Format number */
325 enum v4l2_buf_type type
; /* buffer type */
327 __u8 description
[32]; /* Description string */
328 __u32 pixelformat
; /* Format fourcc */
332 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
350 #define V4L2_TC_TYPE_24FPS 1
351 #define V4L2_TC_TYPE_25FPS 2
352 #define V4L2_TC_TYPE_30FPS 3
353 #define V4L2_TC_TYPE_50FPS 4
354 #define V4L2_TC_TYPE_60FPS 5
357 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
358 #define V4L2_TC_FLAG_COLORFRAME 0x0002
359 #define V4L2_TC_USERBITS_field 0x000C
360 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
361 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
362 /* The above is based on SMPTE timecodes */
366 * 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
368 * ### WARNING: this is still work-in-progress right now, most likely
369 * ### there will be some incompatible changes.
374 enum v4l2_bitrate_mode
{
375 V4L2_BITRATE_NONE
= 0, /* not specified */
376 V4L2_BITRATE_CBR
, /* constant bitrate */
377 V4L2_BITRATE_VBR
, /* variable bitrate */
379 struct v4l2_bitrate
{
380 /* rates are specified in kbit/sec */
381 enum v4l2_bitrate_mode mode
;
383 __u32 target
; /* use this one for CBR */
387 enum v4l2_mpeg_streamtype
{
388 V4L2_MPEG_SS_1
, /* MPEG-1 system stream */
389 V4L2_MPEG_PS_2
, /* MPEG-2 program stream */
390 V4L2_MPEG_TS_2
, /* MPEG-2 transport stream */
391 V4L2_MPEG_PS_DVD
, /* MPEG-2 program stream with DVD header fixups */
393 enum v4l2_mpeg_audiotype
{
394 V4L2_MPEG_AU_2_I
, /* MPEG-2 layer 1 */
395 V4L2_MPEG_AU_2_II
, /* MPEG-2 layer 2 */
396 V4L2_MPEG_AU_2_III
, /* MPEG-2 layer 3 */
397 V4L2_MPEG_AC3
, /* AC3 */
398 V4L2_MPEG_LPCM
, /* LPCM */
400 enum v4l2_mpeg_videotype
{
401 V4L2_MPEG_VI_1
, /* MPEG-1 */
402 V4L2_MPEG_VI_2
, /* MPEG-2 */
404 enum v4l2_mpeg_aspectratio
{
405 V4L2_MPEG_ASPECT_SQUARE
= 1, /* square pixel */
406 V4L2_MPEG_ASPECT_4_3
= 2, /* 4 : 3 */
407 V4L2_MPEG_ASPECT_16_9
= 3, /* 16 : 9 */
408 V4L2_MPEG_ASPECT_1_221
= 4, /* 1 : 2,21 */
411 struct v4l2_mpeg_compression
{
413 enum v4l2_mpeg_streamtype st_type
;
414 struct v4l2_bitrate st_bitrate
;
416 /* transport streams */
424 __u16 reserved_1
; /* align */
427 enum v4l2_mpeg_audiotype au_type
;
428 struct v4l2_bitrate au_bitrate
;
429 __u32 au_sample_rate
;
431 __u8 reserved_2
[3]; /* align */
434 enum v4l2_mpeg_videotype vi_type
;
435 enum v4l2_mpeg_aspectratio vi_aspect_ratio
;
436 struct v4l2_bitrate vi_bitrate
;
438 __u16 vi_frames_per_gop
;
439 __u16 vi_bframes_count
;
441 __u8 reserved_3
[3]; /* align */
446 __u32 reserved_4
:30; /* align */
448 /* I don't expect the above being perfect yet ;) */
452 struct v4l2_jpegcompression
456 int APPn
; /* Number of APP segment to be written,
458 int APP_len
; /* Length of data in JPEG APPn segment */
459 char APP_data
[60]; /* Data in the JPEG APPn segment. */
461 int COM_len
; /* Length of data in JPEG COM segment */
462 char COM_data
[60]; /* Data in JPEG COM segment */
464 __u32 jpeg_markers
; /* Which markers should go into the JPEG
465 * output. Unless you exactly know what
466 * you do, leave them untouched.
467 * Inluding less markers will make the
468 * resulting code smaller, but there will
469 * be fewer aplications which can read it.
470 * The presence of the APP and COM marker
471 * is influenced by APP_len and COM_len
472 * ONLY, not by this property! */
474 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
475 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
476 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
477 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
478 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
479 * allways use APP0 */
484 * M E M O R Y - M A P P I N G B U F F E R S
486 struct v4l2_requestbuffers
489 enum v4l2_buf_type type
;
490 enum v4l2_memory memory
;
497 enum v4l2_buf_type type
;
500 enum v4l2_field field
;
501 struct timeval timestamp
;
502 struct v4l2_timecode timecode
;
505 /* memory location */
506 enum v4l2_memory memory
;
509 unsigned long userptr
;
516 /* Flags for 'flags' field */
517 #define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
518 #define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
519 #define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
520 #define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
521 #define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
522 #define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
523 #define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
524 #define V4L2_BUF_FLAG_INPUT 0x0200 /* input field is valid */
527 * O V E R L A Y P R E V I E W
529 struct v4l2_framebuffer
533 /* FIXME: in theory we should pass something like PCI device + memory
534 * region + offset instead of some physical address */
536 struct v4l2_pix_format fmt
;
538 /* Flags for the 'capability' field. Read only */
539 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
540 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
541 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
542 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
543 /* Flags for the 'flags' field. */
544 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
545 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
546 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
551 struct v4l2_clip
*next
;
557 enum v4l2_field field
;
559 struct v4l2_clip __user
*clips
;
566 * C A P T U R E P A R A M E T E R S
568 struct v4l2_captureparm
570 __u32 capability
; /* Supported modes */
571 __u32 capturemode
; /* Current mode */
572 struct v4l2_fract timeperframe
; /* Time per frame in .1us units */
573 __u32 extendedmode
; /* Driver-specific extensions */
574 __u32 readbuffers
; /* # of buffers for read */
577 /* Flags for 'capability' and 'capturemode' fields */
578 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
579 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
581 struct v4l2_outputparm
583 __u32 capability
; /* Supported modes */
584 __u32 outputmode
; /* Current mode */
585 struct v4l2_fract timeperframe
; /* Time per frame in seconds */
586 __u32 extendedmode
; /* Driver-specific extensions */
587 __u32 writebuffers
; /* # of buffers for write */
592 * I N P U T I M A G E C R O P P I N G
595 struct v4l2_cropcap
{
596 enum v4l2_buf_type type
;
597 struct v4l2_rect bounds
;
598 struct v4l2_rect defrect
;
599 struct v4l2_fract pixelaspect
;
603 enum v4l2_buf_type type
;
608 * A N A L O G V I D E O S T A N D A R D
611 typedef __u64 v4l2_std_id
;
613 /* one bit for each */
614 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
615 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
616 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
617 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
618 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
619 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
620 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
621 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
623 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
624 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
625 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
626 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
628 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000)
629 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000)
630 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
632 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
633 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
634 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
635 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
636 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
637 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
638 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
639 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
642 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
643 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
645 /* some common needed stuff */
646 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
649 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
652 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
656 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
658 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
661 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
667 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
671 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
675 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
676 V4L2_STD_ATSC_16_VSB)
678 #define V4L2_STD_UNKNOWN 0
679 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
687 struct v4l2_fract frameperiod
; /* Frames, not fields */
694 * V I D E O I N P U T S
698 __u32 index
; /* Which input */
699 __u8 name
[32]; /* Label */
700 __u32 type
; /* Type of input */
701 __u32 audioset
; /* Associated audios (bitfield) */
702 __u32 tuner
; /* Associated tuner */
707 /* Values for the 'type' field */
708 #define V4L2_INPUT_TYPE_TUNER 1
709 #define V4L2_INPUT_TYPE_CAMERA 2
711 /* field 'status' - general */
712 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
713 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
714 #define V4L2_IN_ST_NO_COLOR 0x00000004
716 /* field 'status' - analog */
717 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
718 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
720 /* field 'status' - digital */
721 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
722 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
723 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
725 /* field 'status' - VCR and set-top box */
726 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
727 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
728 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
731 * V I D E O O U T P U T S
735 __u32 index
; /* Which output */
736 __u8 name
[32]; /* Label */
737 __u32 type
; /* Type of output */
738 __u32 audioset
; /* Associated audios (bitfield) */
739 __u32 modulator
; /* Associated modulator */
743 /* Values for the 'type' field */
744 #define V4L2_OUTPUT_TYPE_MODULATOR 1
745 #define V4L2_OUTPUT_TYPE_ANALOG 2
746 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
757 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
758 struct v4l2_queryctrl
761 enum v4l2_ctrl_type type
;
762 __u8 name
[32]; /* Whatever */
763 __s32 minimum
; /* Note signedness */
771 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
772 struct v4l2_querymenu
776 __u8 name
[32]; /* Whatever */
781 #define V4L2_CTRL_FLAG_DISABLED 0x0001
782 #define V4L2_CTRL_FLAG_GRABBED 0x0002
784 /* Control IDs defined by V4L2 */
785 #define V4L2_CID_BASE 0x00980900
786 /* IDs reserved for driver specific controls */
787 #define V4L2_CID_PRIVATE_BASE 0x08000000
789 #define V4L2_CID_BRIGHTNESS (V4L2_CID_BASE+0)
790 #define V4L2_CID_CONTRAST (V4L2_CID_BASE+1)
791 #define V4L2_CID_SATURATION (V4L2_CID_BASE+2)
792 #define V4L2_CID_HUE (V4L2_CID_BASE+3)
793 #define V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5)
794 #define V4L2_CID_AUDIO_BALANCE (V4L2_CID_BASE+6)
795 #define V4L2_CID_AUDIO_BASS (V4L2_CID_BASE+7)
796 #define V4L2_CID_AUDIO_TREBLE (V4L2_CID_BASE+8)
797 #define V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9)
798 #define V4L2_CID_AUDIO_LOUDNESS (V4L2_CID_BASE+10)
799 #define V4L2_CID_BLACK_LEVEL (V4L2_CID_BASE+11)
800 #define V4L2_CID_AUTO_WHITE_BALANCE (V4L2_CID_BASE+12)
801 #define V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13)
802 #define V4L2_CID_RED_BALANCE (V4L2_CID_BASE+14)
803 #define V4L2_CID_BLUE_BALANCE (V4L2_CID_BASE+15)
804 #define V4L2_CID_GAMMA (V4L2_CID_BASE+16)
805 #define V4L2_CID_WHITENESS (V4L2_CID_GAMMA) /* ? Not sure */
806 #define V4L2_CID_EXPOSURE (V4L2_CID_BASE+17)
807 #define V4L2_CID_AUTOGAIN (V4L2_CID_BASE+18)
808 #define V4L2_CID_GAIN (V4L2_CID_BASE+19)
809 #define V4L2_CID_HFLIP (V4L2_CID_BASE+20)
810 #define V4L2_CID_VFLIP (V4L2_CID_BASE+21)
811 #define V4L2_CID_HCENTER (V4L2_CID_BASE+22)
812 #define V4L2_CID_VCENTER (V4L2_CID_BASE+23)
813 #define V4L2_CID_LASTP1 (V4L2_CID_BASE+24) /* last CID + 1 */
822 enum v4l2_tuner_type type
;
833 struct v4l2_modulator
844 /* Flags for the 'capability' field */
845 #define V4L2_TUNER_CAP_LOW 0x0001
846 #define V4L2_TUNER_CAP_NORM 0x0002
847 #define V4L2_TUNER_CAP_STEREO 0x0010
848 #define V4L2_TUNER_CAP_LANG2 0x0020
849 #define V4L2_TUNER_CAP_SAP 0x0020
850 #define V4L2_TUNER_CAP_LANG1 0x0040
852 /* Flags for the 'rxsubchans' field */
853 #define V4L2_TUNER_SUB_MONO 0x0001
854 #define V4L2_TUNER_SUB_STEREO 0x0002
855 #define V4L2_TUNER_SUB_LANG2 0x0004
856 #define V4L2_TUNER_SUB_SAP 0x0004
857 #define V4L2_TUNER_SUB_LANG1 0x0008
859 /* Values for the 'audmode' field */
860 #define V4L2_TUNER_MODE_MONO 0x0000
861 #define V4L2_TUNER_MODE_STEREO 0x0001
862 #define V4L2_TUNER_MODE_LANG2 0x0002
863 #define V4L2_TUNER_MODE_SAP 0x0002
864 #define V4L2_TUNER_MODE_LANG1 0x0003
866 struct v4l2_frequency
869 enum v4l2_tuner_type type
;
885 /* Flags for the 'capability' field */
886 #define V4L2_AUDCAP_STEREO 0x00001
887 #define V4L2_AUDCAP_AVL 0x00002
889 /* Flags for the 'mode' field */
890 #define V4L2_AUDMODE_AVL 0x00001
891 #define V4L2_AUDMODE_32BITS 0x00002
903 * D A T A S E R V I C E S ( V B I )
905 * Data services API by Michael Schimek
910 struct v4l2_vbi_format
912 __u32 sampling_rate
; /* in 1 Hz */
914 __u32 samples_per_line
;
915 __u32 sample_format
; /* V4L2_PIX_FMT_* */
918 __u32 flags
; /* V4L2_VBI_* */
919 __u32 reserved
[2]; /* must be zero */
923 #define V4L2_VBI_UNSYNC (1<< 0)
924 #define V4L2_VBI_INTERLACED (1<< 1)
929 * This implements is a proposal V4L2 API to allow SLICED VBI
930 * required for some hardware encoders. It should change without
931 * notice in the definitive implementation.
934 struct v4l2_sliced_vbi_format
937 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
938 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
939 (equals frame lines 313-336 for 625 line video
940 standards, 263-286 for 525 line standards) */
941 __u16 service_lines
[2][24];
943 __u32 reserved
[2]; /* must be zero */
946 #define V4L2_SLICED_TELETEXT_B (0x0001)
947 #define V4L2_SLICED_VPS (0x0400)
948 #define V4L2_SLICED_CAPTION_525 (0x1000)
949 #define V4L2_SLICED_WSS_625 (0x4000)
951 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
952 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
954 struct v4l2_sliced_vbi_cap
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];
962 __u32 reserved
[4]; /* must be 0 */
965 struct v4l2_sliced_vbi_data
968 __u32 field
; /* 0: first field, 1: second field */
969 __u32 line
; /* 1-23 */
970 __u32 reserved
; /* must be 0 */
976 * A G G R E G A T E S T R U C T U R E S
979 /* Stream data format
983 enum v4l2_buf_type type
;
986 struct v4l2_pix_format pix
; // V4L2_BUF_TYPE_VIDEO_CAPTURE
987 struct v4l2_window win
; // V4L2_BUF_TYPE_VIDEO_OVERLAY
988 struct v4l2_vbi_format vbi
; // V4L2_BUF_TYPE_VBI_CAPTURE
990 struct v4l2_sliced_vbi_format sliced
; // V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
992 __u8 raw_data
[200]; // user-defined
997 /* Stream type-dependent parameters
999 struct v4l2_streamparm
1001 enum v4l2_buf_type type
;
1004 struct v4l2_captureparm capture
;
1005 struct v4l2_outputparm output
;
1006 __u8 raw_data
[200]; /* user-defined */
1013 * 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
1016 #define VIDIOC_QUERYCAP _IOR ('V', 0, struct v4l2_capability)
1017 #define VIDIOC_RESERVED _IO ('V', 1)
1018 #define VIDIOC_ENUM_FMT _IOWR ('V', 2, struct v4l2_fmtdesc)
1019 #define VIDIOC_G_FMT _IOWR ('V', 4, struct v4l2_format)
1020 #define VIDIOC_S_FMT _IOWR ('V', 5, struct v4l2_format)
1021 #define VIDIOC_G_MPEGCOMP _IOR ('V', 6, struct v4l2_mpeg_compression)
1022 #define VIDIOC_S_MPEGCOMP _IOW ('V', 7, struct v4l2_mpeg_compression)
1023 #define VIDIOC_REQBUFS _IOWR ('V', 8, struct v4l2_requestbuffers)
1024 #define VIDIOC_QUERYBUF _IOWR ('V', 9, struct v4l2_buffer)
1025 #define VIDIOC_G_FBUF _IOR ('V', 10, struct v4l2_framebuffer)
1026 #define VIDIOC_S_FBUF _IOW ('V', 11, struct v4l2_framebuffer)
1027 #define VIDIOC_OVERLAY _IOW ('V', 14, int)
1028 #define VIDIOC_QBUF _IOWR ('V', 15, struct v4l2_buffer)
1029 #define VIDIOC_DQBUF _IOWR ('V', 17, struct v4l2_buffer)
1030 #define VIDIOC_STREAMON _IOW ('V', 18, int)
1031 #define VIDIOC_STREAMOFF _IOW ('V', 19, int)
1032 #define VIDIOC_G_PARM _IOWR ('V', 21, struct v4l2_streamparm)
1033 #define VIDIOC_S_PARM _IOWR ('V', 22, struct v4l2_streamparm)
1034 #define VIDIOC_G_STD _IOR ('V', 23, v4l2_std_id)
1035 #define VIDIOC_S_STD _IOW ('V', 24, v4l2_std_id)
1036 #define VIDIOC_ENUMSTD _IOWR ('V', 25, struct v4l2_standard)
1037 #define VIDIOC_ENUMINPUT _IOWR ('V', 26, struct v4l2_input)
1038 #define VIDIOC_G_CTRL _IOWR ('V', 27, struct v4l2_control)
1039 #define VIDIOC_S_CTRL _IOWR ('V', 28, struct v4l2_control)
1040 #define VIDIOC_G_TUNER _IOWR ('V', 29, struct v4l2_tuner)
1041 #define VIDIOC_S_TUNER _IOW ('V', 30, struct v4l2_tuner)
1042 #define VIDIOC_G_AUDIO _IOR ('V', 33, struct v4l2_audio)
1043 #define VIDIOC_S_AUDIO _IOW ('V', 34, struct v4l2_audio)
1044 #define VIDIOC_QUERYCTRL _IOWR ('V', 36, struct v4l2_queryctrl)
1045 #define VIDIOC_QUERYMENU _IOWR ('V', 37, struct v4l2_querymenu)
1046 #define VIDIOC_G_INPUT _IOR ('V', 38, int)
1047 #define VIDIOC_S_INPUT _IOWR ('V', 39, int)
1048 #define VIDIOC_G_OUTPUT _IOR ('V', 46, int)
1049 #define VIDIOC_S_OUTPUT _IOWR ('V', 47, int)
1050 #define VIDIOC_ENUMOUTPUT _IOWR ('V', 48, struct v4l2_output)
1051 #define VIDIOC_G_AUDOUT _IOR ('V', 49, struct v4l2_audioout)
1052 #define VIDIOC_S_AUDOUT _IOW ('V', 50, struct v4l2_audioout)
1053 #define VIDIOC_G_MODULATOR _IOWR ('V', 54, struct v4l2_modulator)
1054 #define VIDIOC_S_MODULATOR _IOW ('V', 55, struct v4l2_modulator)
1055 #define VIDIOC_G_FREQUENCY _IOWR ('V', 56, struct v4l2_frequency)
1056 #define VIDIOC_S_FREQUENCY _IOW ('V', 57, struct v4l2_frequency)
1057 #define VIDIOC_CROPCAP _IOWR ('V', 58, struct v4l2_cropcap)
1058 #define VIDIOC_G_CROP _IOWR ('V', 59, struct v4l2_crop)
1059 #define VIDIOC_S_CROP _IOW ('V', 60, struct v4l2_crop)
1060 #define VIDIOC_G_JPEGCOMP _IOR ('V', 61, struct v4l2_jpegcompression)
1061 #define VIDIOC_S_JPEGCOMP _IOW ('V', 62, struct v4l2_jpegcompression)
1062 #define VIDIOC_QUERYSTD _IOR ('V', 63, v4l2_std_id)
1063 #define VIDIOC_TRY_FMT _IOWR ('V', 64, struct v4l2_format)
1064 #define VIDIOC_ENUMAUDIO _IOWR ('V', 65, struct v4l2_audio)
1065 #define VIDIOC_ENUMAUDOUT _IOWR ('V', 66, struct v4l2_audioout)
1066 #define VIDIOC_G_PRIORITY _IOR ('V', 67, enum v4l2_priority)
1067 #define VIDIOC_S_PRIORITY _IOW ('V', 68, enum v4l2_priority)
1069 #define VIDIOC_G_SLICED_VBI_CAP _IOR ('V', 69, struct v4l2_sliced_vbi_cap)
1071 #define VIDIOC_LOG_STATUS _IO ('V', 70)
1073 /* for compatibility, will go away some day */
1074 #define VIDIOC_OVERLAY_OLD _IOWR ('V', 14, int)
1075 #define VIDIOC_S_PARM_OLD _IOW ('V', 22, struct v4l2_streamparm)
1076 #define VIDIOC_S_CTRL_OLD _IOW ('V', 28, struct v4l2_control)
1077 #define VIDIOC_G_AUDIO_OLD _IOWR ('V', 33, struct v4l2_audio)
1078 #define VIDIOC_G_AUDOUT_OLD _IOWR ('V', 49, struct v4l2_audioout)
1079 #define VIDIOC_CROPCAP_OLD _IOR ('V', 58, struct v4l2_cropcap)
1081 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1087 * V 4 L 2 D R I V E R H E L P E R A P I
1089 * Some commonly needed functions for drivers (v4l2-common.o module)
1091 #include <linux/fs.h>
1093 /* Video standard functions */
1094 extern unsigned int v4l2_video_std_fps(struct v4l2_standard
*vs
);
1095 extern int v4l2_video_std_construct(struct v4l2_standard
*vs
,
1096 int id
, char *name
);
1098 /* prority handling */
1099 struct v4l2_prio_state
{
1102 int v4l2_prio_init(struct v4l2_prio_state
*global
);
1103 int v4l2_prio_change(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
,
1104 enum v4l2_priority
new);
1105 int v4l2_prio_open(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1106 int v4l2_prio_close(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1107 enum v4l2_priority
v4l2_prio_max(struct v4l2_prio_state
*global
);
1108 int v4l2_prio_check(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
1110 /* names for fancy debug output */
1111 extern char *v4l2_field_names
[];
1112 extern char *v4l2_type_names
[];
1113 extern char *v4l2_ioctl_names
[];
1115 /* Compatibility layer interface -- v4l1-compat module */
1116 typedef int (*v4l2_kioctl
)(struct inode
*inode
, struct file
*file
,
1117 unsigned int cmd
, void *arg
);
1118 int v4l_compat_translate_ioctl(struct inode
*inode
, struct file
*file
,
1119 int cmd
, void *arg
, v4l2_kioctl driver_ioctl
);
1121 #endif /* __KERNEL__ */
1122 #endif /* __LINUX_VIDEODEV2_H */