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