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