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