include/linux/videodev2.h

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