videodev2.h 28.5 KB
Newer Older
1 2 3
#ifndef __LINUX_VIDEODEV2_H
#define __LINUX_VIDEODEV2_H
/*
4
 *    Video for Linux Two
5
 *
6 7
 *    Header file for v4l or V4L2 drivers and applications, for
 *    Linux kernels 2.2.x or 2.4.x.
8
 *
9 10
 *    See http://bytesex.org/v4l/ for API specs and other
 *    v4l2 documentation.
11
 *
12 13 14
 *    Author: Bill Dirks <bdirks@pacbell.net>
 *        Justin Schoeman
 *        et al.
15 16 17
 */

/*
18
 *    M I S C E L L A N E O U S
19 20 21 22 23 24 25
 */

/*  Four-character-code (FOURCC) */
#define v4l2_fourcc(a,b,c,d)\
        (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))

/*
26
 *    E N U M S
27 28
 */
enum v4l2_field {
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
    V4L2_FIELD_ANY        = 0, /* driver can choose from none,
                      top, bottom, interlaced
                      depending on whatever it thinks
                      is approximate ... */
    V4L2_FIELD_NONE       = 1, /* this device has no fields ... */
    V4L2_FIELD_TOP        = 2, /* top field only */
    V4L2_FIELD_BOTTOM     = 3, /* bottom field only */
    V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
    V4L2_FIELD_SEQ_TB     = 5, /* both fields sequential into one
                      buffer, top-bottom order */
    V4L2_FIELD_SEQ_BT     = 6, /* same as above + bottom-top order */
    V4L2_FIELD_ALTERNATE  = 7, /* both fields alternating into
                      separate buffers */
};
#define V4L2_FIELD_HAS_TOP(field)    \
    ((field) == V4L2_FIELD_TOP     ||\
     (field) == V4L2_FIELD_INTERLACED ||\
     (field) == V4L2_FIELD_SEQ_TB    ||\
     (field) == V4L2_FIELD_SEQ_BT)
#define V4L2_FIELD_HAS_BOTTOM(field)    \
    ((field) == V4L2_FIELD_BOTTOM     ||\
     (field) == V4L2_FIELD_INTERLACED ||\
     (field) == V4L2_FIELD_SEQ_TB    ||\
     (field) == V4L2_FIELD_SEQ_BT)
#define V4L2_FIELD_HAS_BOTH(field)    \
    ((field) == V4L2_FIELD_INTERLACED ||\
     (field) == V4L2_FIELD_SEQ_TB    ||\
     (field) == V4L2_FIELD_SEQ_BT)
57 58

enum v4l2_buf_type {
59 60 61 62 63 64
    V4L2_BUF_TYPE_VIDEO_CAPTURE  = 1,
    V4L2_BUF_TYPE_VIDEO_OUTPUT   = 2,
    V4L2_BUF_TYPE_VIDEO_OVERLAY  = 3,
    V4L2_BUF_TYPE_VBI_CAPTURE    = 4,
    V4L2_BUF_TYPE_VBI_OUTPUT     = 5,
    V4L2_BUF_TYPE_PRIVATE        = 0x80,
65 66 67
};

enum v4l2_ctrl_type {
68 69 70 71
    V4L2_CTRL_TYPE_INTEGER         = 1,
    V4L2_CTRL_TYPE_BOOLEAN         = 2,
    V4L2_CTRL_TYPE_MENU         = 3,
    V4L2_CTRL_TYPE_BUTTON         = 4,
72 73 74
};

enum v4l2_tuner_type {
75 76
    V4L2_TUNER_RADIO         = 1,
    V4L2_TUNER_ANALOG_TV         = 2,
77 78 79
};

enum v4l2_memory {
80 81 82
    V4L2_MEMORY_MMAP             = 1,
    V4L2_MEMORY_USERPTR          = 2,
    V4L2_MEMORY_OVERLAY          = 3,
83 84 85 86
};

/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
enum v4l2_colorspace {
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
    /* ITU-R 601 -- broadcast NTSC/PAL */
    V4L2_COLORSPACE_SMPTE170M     = 1,

    /* 1125-Line (US) HDTV */
    V4L2_COLORSPACE_SMPTE240M     = 2,

    /* HD and modern captures. */
    V4L2_COLORSPACE_REC709        = 3,
    
    /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
    V4L2_COLORSPACE_BT878         = 4,
    
    /* These should be useful.  Assume 601 extents. */
    V4L2_COLORSPACE_470_SYSTEM_M  = 5,
    V4L2_COLORSPACE_470_SYSTEM_BG = 6,
    
    /* I know there will be cameras that send this.  So, this is
     * unspecified chromaticities and full 0-255 on each of the
     * Y'CbCr components
     */
    V4L2_COLORSPACE_JPEG          = 7,
    
    /* For RGB colourspaces, this is probably a good start. */
    V4L2_COLORSPACE_SRGB          = 8,
111 112 113
};

struct v4l2_rect {
114 115 116 117
    __s32   left;
    __s32   top;
    __s32   width;
    __s32   height;
118 119 120
};

struct v4l2_fract {
121 122
    __u32   numerator;
    __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 129
 */
struct v4l2_capability
{
130 131 132 133 134 135
    __u8    driver[16];    /* i.e. "bttv" */
    __u8    card[32];    /* i.e. "Hauppauge WinTV" */
    __u8    bus_info[32];    /* "PCI:" + pci_dev->slot_name */
    __u32   version;        /* should use KERNEL_VERSION() */
    __u32    capabilities;    /* Device capabilities */
    __u32    reserved[4];
136 137 138
};

/* Values for 'capabilities' field */
139 140 141 142 143 144
#define V4L2_CAP_VIDEO_CAPTURE    0x00000001  /* Is a video capture device */
#define V4L2_CAP_VIDEO_OUTPUT    0x00000002  /* Is a video output device */
#define V4L2_CAP_VIDEO_OVERLAY    0x00000004  /* Can do video overlay */
#define V4L2_CAP_VBI_CAPTURE    0x00000010  /* Is a VBI capture device */
#define V4L2_CAP_VBI_OUTPUT    0x00000020  /* Is a VBI output device */
#define V4L2_CAP_RDS_CAPTURE    0x00000100  /* RDS data capture */
145

146 147
#define V4L2_CAP_TUNER        0x00010000  /* Has a tuner */
#define V4L2_CAP_AUDIO        0x00020000  /* has audio support */
148 149 150 151 152 153

#define V4L2_CAP_READWRITE      0x01000000  /* read/write systemcalls */
#define V4L2_CAP_ASYNCIO        0x02000000  /* async I/O */
#define V4L2_CAP_STREAMING      0x04000000  /* streaming I/O ioctls */

/*
154
 *    V I D E O   I M A G E   F O R M A T
155 156 157 158
 */

struct v4l2_pix_format
{
159 160 161 162 163 164 165 166
    __u32                  width;
    __u32                 height;
    __u32                 pixelformat;
    enum v4l2_field      field;
    __u32                bytesperline;    /* for padding, zero if unused */
    __u32                   sizeimage;
        enum v4l2_colorspace    colorspace;
    __u32            priv;        /* private data, depends on pixelformat */
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
};

/*           Pixel format    FOURCC                  depth  Description   */
#define V4L2_PIX_FMT_RGB332  v4l2_fourcc('R','G','B','1') /*  8  RGB-3-3-2     */
#define V4L2_PIX_FMT_RGB555  v4l2_fourcc('R','G','B','O') /* 16  RGB-5-5-5     */
#define V4L2_PIX_FMT_RGB565  v4l2_fourcc('R','G','B','P') /* 16  RGB-5-6-5     */
#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R','G','B','Q') /* 16  RGB-5-5-5 BE  */
#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R','G','B','R') /* 16  RGB-5-6-5 BE  */
#define V4L2_PIX_FMT_BGR24   v4l2_fourcc('B','G','R','3') /* 24  BGR-8-8-8     */
#define V4L2_PIX_FMT_RGB24   v4l2_fourcc('R','G','B','3') /* 24  RGB-8-8-8     */
#define V4L2_PIX_FMT_BGR32   v4l2_fourcc('B','G','R','4') /* 32  BGR-8-8-8-8   */
#define V4L2_PIX_FMT_RGB32   v4l2_fourcc('R','G','B','4') /* 32  RGB-8-8-8-8   */
#define V4L2_PIX_FMT_GREY    v4l2_fourcc('G','R','E','Y') /*  8  Greyscale     */
#define V4L2_PIX_FMT_YVU410  v4l2_fourcc('Y','V','U','9') /*  9  YVU 4:1:0     */
#define V4L2_PIX_FMT_YVU420  v4l2_fourcc('Y','V','1','2') /* 12  YVU 4:2:0     */
#define V4L2_PIX_FMT_YUYV    v4l2_fourcc('Y','U','Y','V') /* 16  YUV 4:2:2     */
#define V4L2_PIX_FMT_UYVY    v4l2_fourcc('U','Y','V','Y') /* 16  YUV 4:2:2     */
#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4','2','2','P') /* 16  YVU422 planar */
#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4','1','1','P') /* 16  YVU411 planar */
#define V4L2_PIX_FMT_Y41P    v4l2_fourcc('Y','4','1','P') /* 12  YUV 4:1:1     */

/* two planes -- one Y, one Cr + Cb interleaved  */
#define V4L2_PIX_FMT_NV12    v4l2_fourcc('N','V','1','2') /* 12  Y/CbCr 4:2:0  */
#define V4L2_PIX_FMT_NV21    v4l2_fourcc('N','V','2','1') /* 12  Y/CrCb 4:2:0  */

/*  The following formats are not defined in the V4L2 specification */
#define V4L2_PIX_FMT_YUV410  v4l2_fourcc('Y','U','V','9') /*  9  YUV 4:1:0     */
#define V4L2_PIX_FMT_YUV420  v4l2_fourcc('Y','U','1','2') /* 12  YUV 4:2:0     */
#define V4L2_PIX_FMT_YYUV    v4l2_fourcc('Y','Y','U','V') /* 16  YUV 4:2:2     */
#define V4L2_PIX_FMT_HI240   v4l2_fourcc('H','I','2','4') /*  8  8-bit color   */

/* compressed formats */
#define V4L2_PIX_FMT_MJPEG    v4l2_fourcc('M','J','P','G') /* Motion-JPEG   */
#define V4L2_PIX_FMT_JPEG     v4l2_fourcc('J','P','E','G') /* JFIF JPEG     */
#define V4L2_PIX_FMT_DV       v4l2_fourcc('d','v','s','d') /* 1394          */
#define V4L2_PIX_FMT_MPEG     v4l2_fourcc('M','P','E','G') /* MPEG          */

/*  Vendor-specific formats   */
#define V4L2_PIX_FMT_WNVA    v4l2_fourcc('W','N','V','A') /* Winnov hw compres */

/*
208
 *    F O R M A T   E N U M E R A T I O N
209 210 211
 */
struct v4l2_fmtdesc
{
212 213 214 215 216 217
    __u32                index;             /* Format number      */
    enum v4l2_buf_type  type;              /* buffer type        */
    __u32               flags;
    __u8                description[32];   /* Description string */
    __u32                pixelformat;       /* Format fourcc      */
    __u32                reserved[4];
218 219 220 221 222 223
};

#define V4L2_FMT_FLAG_COMPRESSED 0x0001


/*
224
 *    T I M E C O D E
225 226 227
 */
struct v4l2_timecode
{
228 229 230 231 232 233 234
    __u32    type;
    __u32    flags;
    __u8    frames;
    __u8    seconds;
    __u8    minutes;
    __u8    hours;
    __u8    userbits[4];
235 236 237
};

/*  Type  */
238 239 240 241 242
#define V4L2_TC_TYPE_24FPS        1
#define V4L2_TC_TYPE_25FPS        2
#define V4L2_TC_TYPE_30FPS        3
#define V4L2_TC_TYPE_50FPS        4
#define V4L2_TC_TYPE_60FPS        5
243 244

/*  Flags  */
245 246 247 248 249
#define V4L2_TC_FLAG_DROPFRAME        0x0001 /* "drop-frame" mode */
#define V4L2_TC_FLAG_COLORFRAME        0x0002
#define V4L2_TC_USERBITS_field        0x000C
#define V4L2_TC_USERBITS_USERDEFINED    0x0000
#define V4L2_TC_USERBITS_8BITCHARS    0x0008
250 251 252 253
/* The above is based on SMPTE timecodes */


/*
254
 *    C O M P R E S S I O N   P A R A M E T E R S
255 256 257 258 259 260 261
 */
#if 0
/* ### generic compression settings don't work, there is too much
 * ### codec-specific stuff.  Maybe reuse that for MPEG codec settings
 * ### later ... */
struct v4l2_compression
{
262 263 264 265
    __u32    quality;
    __u32    keyframerate;
    __u32    pframerate;
    __u32    reserved[5];
266 267 268 269 270
};
#endif

struct v4l2_jpegcompression
{
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
    int quality;

    int  APPn;              /* Number of APP segment to be written,
                 * must be 0..15 */
    int  APP_len;           /* Length of data in JPEG APPn segment */
    char APP_data[60];      /* Data in the JPEG APPn segment. */
    
    int  COM_len;           /* Length of data in JPEG COM segment */
    char COM_data[60];      /* Data in JPEG COM segment */
    
    __u32 jpeg_markers;     /* Which markers should go into the JPEG
                 * output. Unless you exactly know what
                 * you do, leave them untouched.
                 * Inluding less markers will make the
                 * resulting code smaller, but there will
                 * be fewer aplications which can read it.
                 * The presence of the APP and COM marker
                 * is influenced by APP_len and COM_len
                 * ONLY, not by this property! */
    
291 292 293 294 295 296 297 298 299 300
#define V4L2_JPEG_MARKER_DHT (1<<3)    /* Define Huffman Tables */
#define V4L2_JPEG_MARKER_DQT (1<<4)    /* Define Quantization Tables */
#define V4L2_JPEG_MARKER_DRI (1<<5)    /* Define Restart Interval */
#define V4L2_JPEG_MARKER_COM (1<<6)    /* Comment segment */
#define V4L2_JPEG_MARKER_APP (1<<7)    /* App segment, driver will
                                        * allways use APP0 */
};


/*
301
 *    M E M O R Y - M A P P I N G   B U F F E R S
302 303 304
 */
struct v4l2_requestbuffers
{
305 306 307 308
    __u32                    count;
    enum v4l2_buf_type      type;
    enum v4l2_memory        memory;
    __u32                    reserved[2];
309 310 311 312
};

struct v4l2_buffer
{
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
    __u32            index;
    enum v4l2_buf_type      type;
    __u32            bytesused;
    __u32            flags;
    enum v4l2_field        field;
    struct timeval        timestamp;
    struct v4l2_timecode    timecode;
    __u32            sequence;

    /* memory location */
    enum v4l2_memory        memory;
    union {
        __u32           offset;
        unsigned long   userptr;
    } m;
    __u32            length;

    __u32            reserved[2];
331 332 333
};

/*  Flags for 'flags' field */
334 335 336 337 338 339 340
#define V4L2_BUF_FLAG_MAPPED    0x0001  /* Buffer is mapped (flag) */
#define V4L2_BUF_FLAG_QUEUED    0x0002    /* Buffer is queued for processing */
#define V4L2_BUF_FLAG_DONE    0x0004    /* Buffer is ready */
#define V4L2_BUF_FLAG_KEYFRAME    0x0008    /* Image is a keyframe (I-frame) */
#define V4L2_BUF_FLAG_PFRAME    0x0010    /* Image is a P-frame */
#define V4L2_BUF_FLAG_BFRAME    0x0020    /* Image is a B-frame */
#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 346
 */
struct v4l2_framebuffer
{
347 348
    __u32            capability;
    __u32            flags;
349 350
/* FIXME: in theory we should pass something like PCI device + memory
 * region + offset instead of some physical address */
351 352
    void*                   base;
    struct v4l2_pix_format    fmt;
353 354
};
/*  Flags for the 'capability' field. Read only */
355 356
#define V4L2_FBUF_CAP_EXTERNOVERLAY    0x0001
#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 361 362
#define V4L2_FBUF_FLAG_PRIMARY        0x0001
#define V4L2_FBUF_FLAG_OVERLAY        0x0002
#define V4L2_FBUF_FLAG_CHROMAKEY    0x0004
363 364 365

struct v4l2_clip
{
366 367
    struct v4l2_rect        c;
    struct v4l2_clip    *next;
368 369 370 371
};

struct v4l2_window
{
372 373 374 375 376 377
    struct v4l2_rect        w;
    enum v4l2_field      field;
    __u32            chromakey;
    struct v4l2_clip    *clips;
    __u32            clipcount;
    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 385
 */
struct v4l2_captureparm
{
386 387 388 389 390 391
    __u32           capability;      /*  Supported modes */
    __u32           capturemode;      /*  Current mode */
    struct v4l2_fract  timeperframe;  /*  Time per frame in .1us units */
    __u32           extendedmode;  /*  Driver-specific extensions */
    __u32              readbuffers;   /*  # of buffers for read */
    __u32           reserved[4];
392 393
};
/*  Flags for 'capability' and 'capturemode' fields */
394 395
#define V4L2_MODE_HIGHQUALITY    0x0001    /*  High quality imaging mode */
#define V4L2_CAP_TIMEPERFRAME    0x1000    /*  timeperframe field is supported */
396 397 398

struct v4l2_outputparm
{
399 400 401 402 403 404
    __u32           capability;     /*  Supported modes */
    __u32           outputmode;     /*  Current mode */
    struct v4l2_fract  timeperframe; /*  Time per frame in seconds */
    __u32           extendedmode; /*  Driver-specific extensions */
    __u32              writebuffers; /*  # of buffers for write */
    __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 414 415 416 417 418
        struct v4l2_rect        bounds;
        struct v4l2_rect        defrect;
        struct v4l2_fract       pixelaspect;
};

struct v4l2_crop {
419 420
    enum v4l2_buf_type      type;
    struct v4l2_rect        c;
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
};

/*
 *      A N A L O G   V I D E O   S T A N D A R D
 */

typedef __u64 v4l2_std_id;

/* one bit for each */
#define V4L2_STD_PAL_B          ((v4l2_std_id)0x00000001)
#define V4L2_STD_PAL_B1         ((v4l2_std_id)0x00000002)
#define V4L2_STD_PAL_G          ((v4l2_std_id)0x00000004)
#define V4L2_STD_PAL_H          ((v4l2_std_id)0x00000008)
#define V4L2_STD_PAL_I          ((v4l2_std_id)0x00000010)
#define V4L2_STD_PAL_D          ((v4l2_std_id)0x00000020)
#define V4L2_STD_PAL_D1         ((v4l2_std_id)0x00000040)
#define V4L2_STD_PAL_K          ((v4l2_std_id)0x00000080)

#define V4L2_STD_PAL_M          ((v4l2_std_id)0x00000100)
#define V4L2_STD_PAL_N          ((v4l2_std_id)0x00000200)
#define V4L2_STD_PAL_Nc         ((v4l2_std_id)0x00000400)
#define V4L2_STD_PAL_60         ((v4l2_std_id)0x00000800)

#define V4L2_STD_NTSC_M         ((v4l2_std_id)0x00001000)
#define V4L2_STD_NTSC_M_JP      ((v4l2_std_id)0x00002000)

#define V4L2_STD_SECAM_B        ((v4l2_std_id)0x00010000)
#define V4L2_STD_SECAM_D        ((v4l2_std_id)0x00020000)
#define V4L2_STD_SECAM_G        ((v4l2_std_id)0x00040000)
#define V4L2_STD_SECAM_H        ((v4l2_std_id)0x00080000)
#define V4L2_STD_SECAM_K        ((v4l2_std_id)0x00100000)
#define V4L2_STD_SECAM_K1       ((v4l2_std_id)0x00200000)
#define V4L2_STD_SECAM_L        ((v4l2_std_id)0x00400000)

/* ATSC/HDTV */
#define V4L2_STD_ATSC_8_VSB     ((v4l2_std_id)0x01000000)
#define V4L2_STD_ATSC_16_VSB    ((v4l2_std_id)0x02000000)

/* some common needed stuff */
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
#define V4L2_STD_PAL_BG        (V4L2_STD_PAL_B        |\
                 V4L2_STD_PAL_B1    |\
                 V4L2_STD_PAL_G)
#define V4L2_STD_PAL_DK        (V4L2_STD_PAL_D        |\
                 V4L2_STD_PAL_D1    |\
                 V4L2_STD_PAL_K)
#define V4L2_STD_PAL        (V4L2_STD_PAL_BG    |\
                 V4L2_STD_PAL_DK    |\
                 V4L2_STD_PAL_H        |\
                 V4L2_STD_PAL_I)
#define V4L2_STD_NTSC           (V4L2_STD_NTSC_M    |\
                 V4L2_STD_NTSC_M_JP)
#define V4L2_STD_SECAM        (V4L2_STD_SECAM_B    |\
                 V4L2_STD_SECAM_D    |\
                 V4L2_STD_SECAM_G    |\
                 V4L2_STD_SECAM_H    |\
                 V4L2_STD_SECAM_K    |\
                 V4L2_STD_SECAM_K1    |\
                 V4L2_STD_SECAM_L)

#define V4L2_STD_525_60        (V4L2_STD_PAL_M        |\
                 V4L2_STD_PAL_60    |\
                 V4L2_STD_NTSC)
#define V4L2_STD_625_50        (V4L2_STD_PAL        |\
                 V4L2_STD_PAL_N        |\
                 V4L2_STD_PAL_Nc    |\
                 V4L2_STD_SECAM)
487 488

#define V4L2_STD_UNKNOWN        0
489 490
#define V4L2_STD_ALL            (V4L2_STD_525_60    |\
                 V4L2_STD_625_50)
491 492 493

struct v4l2_standard
{
494 495 496 497 498 499
    __u32                    index;
    v4l2_std_id          id;
    __u8             name[24];
    struct v4l2_fract    frameperiod; /* Frames, not fields */
    __u32             framelines;
    __u32             reserved[4];
500 501 502 503
};


/*
504
 *    V I D E O   I N P U T S
505 506 507
 */
struct v4l2_input
{
508 509 510 511 512 513 514 515
    __u32         index;        /*  Which input */
    __u8         name[32];            /*  Label */
    __u32         type;        /*  Type of input */
    __u32         audioset;            /*  Associated audios (bitfield) */
    __u32        tuner;             /*  Associated tuner */
    v4l2_std_id  std;
    __u32         status;
    __u32         reserved[4];
516 517
};
/*  Values for the 'type' field */
518 519
#define V4L2_INPUT_TYPE_TUNER        1
#define V4L2_INPUT_TYPE_CAMERA        2
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540

/* field 'status' - general */
#define V4L2_IN_ST_NO_POWER    0x00000001  /* Attached device is off */
#define V4L2_IN_ST_NO_SIGNAL   0x00000002
#define V4L2_IN_ST_NO_COLOR    0x00000004

/* field 'status' - analog */
#define V4L2_IN_ST_NO_H_LOCK   0x00000100  /* No horizontal sync lock */
#define V4L2_IN_ST_COLOR_KILL  0x00000200  /* Color killer is active */

/* field 'status' - digital */
#define V4L2_IN_ST_NO_SYNC     0x00010000  /* No synchronization lock */
#define V4L2_IN_ST_NO_EQU      0x00020000  /* No equalizer lock */
#define V4L2_IN_ST_NO_CARRIER  0x00040000  /* Carrier recovery failed */

/* field 'status' - VCR and set-top box */
#define V4L2_IN_ST_MACROVISION 0x01000000  /* Macrovision detected */
#define V4L2_IN_ST_NO_ACCESS   0x02000000  /* Conditional access denied */
#define V4L2_IN_ST_VTR         0x04000000  /* VTR time constant */

/*
541
 *    V I D E O   O U T P U T S
542 543 544
 */
struct v4l2_output
{
545 546 547 548 549 550 551
    __u32         index;        /*  Which output */
    __u8         name[32];            /*  Label */
    __u32         type;        /*  Type of output */
    __u32         audioset;            /*  Associated audios (bitfield) */
    __u32         modulator;         /*  Associated modulator */
    v4l2_std_id  std;
    __u32         reserved[4];
552 553
};
/*  Values for the 'type' field */
554 555 556
#define V4L2_OUTPUT_TYPE_MODULATOR        1
#define V4L2_OUTPUT_TYPE_ANALOG            2
#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY    3
557 558

/*
559
 *    C O N T R O L S
560 561 562
 */
struct v4l2_control
{
563 564
    __u32             id;
    __s32             value;
565 566 567 568 569
};

/*  Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
struct v4l2_queryctrl
{
570 571 572 573 574 575 576 577 578
    __u32                 id;
    enum v4l2_ctrl_type  type;
    __u8             name[32];    /* Whatever */
    __s32             minimum;    /* Note signedness */
    __s32             maximum;
    __s32                 step;
    __s32             default_value;
    __u32                flags;
    __u32             reserved[2];
579 580 581 582 583
};

/*  Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
struct v4l2_querymenu
{
584 585 586 587
    __u32        id;
    __u32        index;
    __u8        name[32];    /* Whatever */
    __u32        reserved;
588 589 590
};

/*  Control flags  */
591 592
#define V4L2_CTRL_FLAG_DISABLED        0x0001
#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 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
#define V4L2_CID_PRIVATE_BASE        0x08000000

#define V4L2_CID_BRIGHTNESS        (V4L2_CID_BASE+0)
#define V4L2_CID_CONTRAST        (V4L2_CID_BASE+1)
#define V4L2_CID_SATURATION        (V4L2_CID_BASE+2)
#define V4L2_CID_HUE            (V4L2_CID_BASE+3)
#define V4L2_CID_AUDIO_VOLUME        (V4L2_CID_BASE+5)
#define V4L2_CID_AUDIO_BALANCE        (V4L2_CID_BASE+6)
#define V4L2_CID_AUDIO_BASS        (V4L2_CID_BASE+7)
#define V4L2_CID_AUDIO_TREBLE        (V4L2_CID_BASE+8)
#define V4L2_CID_AUDIO_MUTE        (V4L2_CID_BASE+9)
#define V4L2_CID_AUDIO_LOUDNESS        (V4L2_CID_BASE+10)
#define V4L2_CID_BLACK_LEVEL        (V4L2_CID_BASE+11)
#define V4L2_CID_AUTO_WHITE_BALANCE    (V4L2_CID_BASE+12)
#define V4L2_CID_DO_WHITE_BALANCE    (V4L2_CID_BASE+13)
#define V4L2_CID_RED_BALANCE        (V4L2_CID_BASE+14)
#define V4L2_CID_BLUE_BALANCE        (V4L2_CID_BASE+15)
#define V4L2_CID_GAMMA            (V4L2_CID_BASE+16)
#define V4L2_CID_WHITENESS        (V4L2_CID_GAMMA) /* ? Not sure */
#define V4L2_CID_EXPOSURE        (V4L2_CID_BASE+17)
#define V4L2_CID_AUTOGAIN        (V4L2_CID_BASE+18)
#define V4L2_CID_GAIN            (V4L2_CID_BASE+19)
#define V4L2_CID_HFLIP            (V4L2_CID_BASE+20)
#define V4L2_CID_VFLIP            (V4L2_CID_BASE+21)
#define V4L2_CID_HCENTER        (V4L2_CID_BASE+22)
#define V4L2_CID_VCENTER        (V4L2_CID_BASE+23)
#define V4L2_CID_LASTP1            (V4L2_CID_BASE+24) /* last CID + 1 */
624 625

/*
626
 *    T U N I N G
627 628 629
 */
struct v4l2_tuner
{
630 631 632 633 634 635 636 637 638 639 640
    __u32                   index;
    __u8            name[32];
    enum v4l2_tuner_type    type;
    __u32            capability;
    __u32            rangelow;
    __u32            rangehigh;
    __u32            rxsubchans;
    __u32            audmode;
    __s32            signal;
    __s32            afc;
    __u32            reserved[4];
641 642 643 644
};

struct v4l2_modulator
{
645 646 647 648 649 650 651
    __u32            index;
    __u8            name[32];
    __u32            capability;
    __u32            rangelow;
    __u32            rangehigh;
    __u32            txsubchans;
    __u32            reserved[4];
652 653 654
};

/*  Flags for the 'capability' field */
655 656 657 658 659 660
#define V4L2_TUNER_CAP_LOW        0x0001
#define V4L2_TUNER_CAP_NORM        0x0002
#define V4L2_TUNER_CAP_STEREO        0x0010
#define V4L2_TUNER_CAP_LANG2        0x0020
#define V4L2_TUNER_CAP_SAP        0x0020
#define V4L2_TUNER_CAP_LANG1        0x0040
661 662

/*  Flags for the 'rxsubchans' field */
663 664 665 666 667
#define V4L2_TUNER_SUB_MONO        0x0001
#define V4L2_TUNER_SUB_STEREO        0x0002
#define V4L2_TUNER_SUB_LANG2        0x0004
#define V4L2_TUNER_SUB_SAP        0x0004
#define V4L2_TUNER_SUB_LANG1        0x0008
668 669

/*  Values for the 'audmode' field */
670 671 672 673 674
#define V4L2_TUNER_MODE_MONO        0x0000
#define V4L2_TUNER_MODE_STEREO        0x0001
#define V4L2_TUNER_MODE_LANG2        0x0002
#define V4L2_TUNER_MODE_SAP        0x0002
#define V4L2_TUNER_MODE_LANG1        0x0003
675 676 677

struct v4l2_frequency
{
678 679 680 681
    __u32                  tuner;
    enum v4l2_tuner_type  type;
        __u32                  frequency;
    __u32                  reserved[8];
682 683 684
};

/*
685
 *    A U D I O
686 687 688
 */
struct v4l2_audio
{
689 690 691 692 693
    __u32    index;
    __u8    name[32];
    __u32    capability;
    __u32    mode;
    __u32    reserved[2];
694 695
};
/*  Flags for the 'capability' field */
696 697
#define V4L2_AUDCAP_STEREO        0x00001
#define V4L2_AUDCAP_AVL            0x00002
698 699

/*  Flags for the 'mode' field */
700
#define V4L2_AUDMODE_AVL        0x00001
701 702 703

struct v4l2_audioout
{
704 705 706 707 708
    __u32    index;
    __u8    name[32];
    __u32    capability;
    __u32    mode;
    __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 718
 */

struct v4l2_vbi_format
{
719 720 721 722 723 724 725 726
    __u32    sampling_rate;        /* in 1 Hz */
    __u32    offset;
    __u32    samples_per_line;
    __u32    sample_format;        /* V4L2_PIX_FMT_* */
    __s32    start[2];
    __u32    count[2];
    __u32    flags;            /* V4L2_VBI_* */
    __u32    reserved[2];        /* must be zero */
727 728 729
};

/*  VBI flags  */
730 731
#define V4L2_VBI_UNSYNC        (1<< 0)
#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 741
 */
struct v4l2_format
{
742 743 744 745 746 747 748 749
    enum v4l2_buf_type type;
    union
    {
        struct v4l2_pix_format    pix;  // V4L2_BUF_TYPE_VIDEO_CAPTURE
        struct v4l2_window    win;  // V4L2_BUF_TYPE_VIDEO_OVERLAY
        struct v4l2_vbi_format    vbi;  // V4L2_BUF_TYPE_VBI_CAPTURE
        __u8    raw_data[200];        // user-defined
    } fmt;
750 751 752
};


753
/*    Stream type-dependent parameters
754 755 756
 */
struct v4l2_streamparm
{
757 758 759 760 761 762 763
    enum v4l2_buf_type type;
    union
    {
        struct v4l2_captureparm    capture;
        struct v4l2_outputparm    output;
        __u8    raw_data[200];  /* user-defined */
    } 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 773
#define VIDIOC_QUERYCAP        _IOR  ('V',  0, struct v4l2_capability)
#define VIDIOC_RESERVED        _IO   ('V',  1)
774
#define VIDIOC_ENUM_FMT         _IOWR ('V',  2, struct v4l2_fmtdesc)
775 776
#define VIDIOC_G_FMT        _IOWR ('V',  4, struct v4l2_format)
#define VIDIOC_S_FMT        _IOWR ('V',  5, struct v4l2_format)
777
#if 0
778 779
#define VIDIOC_G_COMP        _IOR  ('V',  6, struct v4l2_compression)
#define VIDIOC_S_COMP        _IOW  ('V',  7, struct v4l2_compression)
780
#endif
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
#define VIDIOC_REQBUFS        _IOWR ('V',  8, struct v4l2_requestbuffers)
#define VIDIOC_QUERYBUF        _IOWR ('V',  9, struct v4l2_buffer)
#define VIDIOC_G_FBUF        _IOR  ('V', 10, struct v4l2_framebuffer)
#define VIDIOC_S_FBUF        _IOW  ('V', 11, struct v4l2_framebuffer)
#define VIDIOC_OVERLAY        _IOWR ('V', 14, int)
#define VIDIOC_QBUF        _IOWR ('V', 15, struct v4l2_buffer)
#define VIDIOC_DQBUF        _IOWR ('V', 17, struct v4l2_buffer)
#define VIDIOC_STREAMON        _IOW  ('V', 18, int)
#define VIDIOC_STREAMOFF    _IOW  ('V', 19, int)
#define VIDIOC_G_PARM        _IOWR ('V', 21, struct v4l2_streamparm)
#define VIDIOC_S_PARM        _IOW  ('V', 22, struct v4l2_streamparm)
#define VIDIOC_G_STD        _IOR  ('V', 23, v4l2_std_id)
#define VIDIOC_S_STD        _IOW  ('V', 24, v4l2_std_id)
#define VIDIOC_ENUMSTD        _IOWR ('V', 25, struct v4l2_standard)
#define VIDIOC_ENUMINPUT    _IOWR ('V', 26, struct v4l2_input)
#define VIDIOC_G_CTRL        _IOWR ('V', 27, struct v4l2_control)
#define VIDIOC_S_CTRL        _IOW  ('V', 28, struct v4l2_control)
#define VIDIOC_G_TUNER        _IOWR ('V', 29, struct v4l2_tuner)
#define VIDIOC_S_TUNER        _IOW  ('V', 30, struct v4l2_tuner)
#define VIDIOC_G_AUDIO        _IOWR ('V', 33, struct v4l2_audio)
#define VIDIOC_S_AUDIO        _IOW  ('V', 34, struct v4l2_audio)
#define VIDIOC_QUERYCTRL    _IOWR ('V', 36, struct v4l2_queryctrl)
#define VIDIOC_QUERYMENU    _IOWR ('V', 37, struct v4l2_querymenu)
#define VIDIOC_G_INPUT        _IOR  ('V', 38, int)
#define VIDIOC_S_INPUT        _IOWR ('V', 39, int)
#define VIDIOC_G_OUTPUT        _IOR  ('V', 46, int)
#define VIDIOC_S_OUTPUT        _IOWR ('V', 47, int)
#define VIDIOC_ENUMOUTPUT    _IOWR ('V', 48, struct v4l2_output)
#define VIDIOC_G_AUDOUT        _IOWR ('V', 49, struct v4l2_audioout)
#define VIDIOC_S_AUDOUT        _IOW  ('V', 50, struct v4l2_audioout)
#define VIDIOC_G_MODULATOR    _IOWR ('V', 54, struct v4l2_modulator)
#define VIDIOC_S_MODULATOR    _IOW  ('V', 55, struct v4l2_modulator)
#define VIDIOC_G_FREQUENCY    _IOWR ('V', 56, struct v4l2_frequency)
#define VIDIOC_S_FREQUENCY    _IOW  ('V', 57, struct v4l2_frequency)
#define VIDIOC_CROPCAP        _IOR  ('V', 58, struct v4l2_cropcap)
#define VIDIOC_G_CROP        _IOWR ('V', 59, struct v4l2_crop)
#define VIDIOC_S_CROP        _IOW  ('V', 60, struct v4l2_crop)
#define VIDIOC_G_JPEGCOMP    _IOR  ('V', 61, struct v4l2_jpegcompression)
#define VIDIOC_S_JPEGCOMP    _IOW  ('V', 62, struct v4l2_jpegcompression)
#define VIDIOC_QUERYSTD          _IOR  ('V', 63, v4l2_std_id)
#define VIDIOC_TRY_FMT          _IOWR ('V', 64, struct v4l2_format)

#define BASE_VIDIOC_PRIVATE    192        /* 192-255 are private */
824 825 826 827 828


#ifdef __KERNEL__
/*
 *
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 834 835 836 837
 */
#include <linux/fs.h>

/*  Video standard functions  */
extern unsigned int v4l2_video_std_fps(struct v4l2_standard *vs);
extern int v4l2_video_std_construct(struct v4l2_standard *vs,
838
                    int id, char *name);
839 840 841

/*  Compatibility layer interface  */
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 847 848 849 850 851 852 853 854 855 856 857 858

/* names for fancy debug output */
extern char *v4l2_field_names[];
extern char *v4l2_type_names[];
extern char *v4l2_ioctl_names[];

#endif /* __KERNEL__ */
#endif /* __LINUX_VIDEODEV2_H */

/*
 * Local variables:
 * c-basic-offset: 8
 * End:
 */