va/va.h

   1 /*
   2  * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sub license, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial portions
  14  * of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  19  * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
  20  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  21  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  22  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 /*
  25  * Video Acceleration (VA) API Specification
  26  *
  27  * Rev. 0.30
  28  * <jonathan.bian@intel.com>
  29  *
  30  * Revision History:
  31  * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
  32  * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
  33  * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
  34  * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
  35  * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
  36  * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
  37  * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
  38  * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
  39  * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
  40  *                                       and MPEG-2 motion compensation.
  41  * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
  42  * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
  43  * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
  44  * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
  45  * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
  46  * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
  47  * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
  48  * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
  49  * rev 0.27 (11/19/2007 Matt Sottek)   - Added DeriveImage
  50  * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
  51  *                                       to enable scaling
  52  * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
  53  *                                       added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
  54  * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
  55  *                                       for ISO C conformance.
  56  * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
  57  *                                       Application needs to relink with the new library.
  58  *
  59  * rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
  60  *
  61  * Acknowledgements:
  62  *  Some concepts borrowed from XvMC and XvImage.
  63  *  Waldo Bastian (Intel), Matt Sottek (Intel),  Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
  64  *  contributed to various aspects of the API.
  65  */
  66
  67 #ifndef _VA_H_
  68 #define _VA_H_
  69
  70 #include <va/va_version.h>
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 /*
  77 Overview
  78
  79 The VA API is intended to provide an interface between a video decode/encode/display
  80 application (client) and a hardware accelerator (server), to off-load
  81 video decode/encode/display operations from the host to the hardware accelerator at various
  82 entry-points.
  83
  84 The basic operation steps are:
  85
  86 - Negotiate a mutually acceptable configuration with the server to lock
  87   down profile, entrypoints, and other attributes that will not change on
  88   a frame-by-frame basis.
  89 - Create a decode context which represents a "virtualized" hardware decode
  90   device
  91 - Get and fill decode buffers with picture level, slice level and macroblock
  92   level data (depending on entrypoints)
  93 - Pass the decode buffers to the server to decode the current frame
  94
  95 Initialization & Configuration Management
  96
  97 - Find out supported profiles
  98 - Find out entrypoints for a given profile
  99 - Find out configuration attributes for a given profile/entrypoint pair
 100 - Create a configuration for use by the decoder
 101
 102 */
 103
 104 typedef void* VADisplay;        /* window system dependent */
 105
 106 typedef int VAStatus;   /* Return status type from functions */
 107 /* Values for the return status */
 108 #define VA_STATUS_SUCCESS                       0x00000000
 109 #define VA_STATUS_ERROR_OPERATION_FAILED        0x00000001
 110 #define VA_STATUS_ERROR_ALLOCATION_FAILED       0x00000002
 111 #define VA_STATUS_ERROR_INVALID_DISPLAY         0x00000003
 112 #define VA_STATUS_ERROR_INVALID_CONFIG          0x00000004
 113 #define VA_STATUS_ERROR_INVALID_CONTEXT         0x00000005
 114 #define VA_STATUS_ERROR_INVALID_SURFACE         0x00000006
 115 #define VA_STATUS_ERROR_INVALID_BUFFER          0x00000007
 116 #define VA_STATUS_ERROR_INVALID_IMAGE           0x00000008
 117 #define VA_STATUS_ERROR_INVALID_SUBPICTURE      0x00000009
 118 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED      0x0000000a
 119 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED        0x0000000b
 120 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE     0x0000000c
 121 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT  0x0000000d
 122 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT   0x0000000e
 123 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE  0x0000000f
 124 #define VA_STATUS_ERROR_SURFACE_BUSY            0x00000010
 125 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED      0x00000011
 126 #define VA_STATUS_ERROR_INVALID_PARAMETER       0x00000012
 127 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
 128 #define VA_STATUS_ERROR_UNIMPLEMENTED           0x00000014
 129 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING   0x00000015
 130 #define VA_STATUS_ERROR_UNKNOWN                 0xFFFFFFFF
 131
 132 /* De-interlacing flags for vaPutSurface() */
 133 #define VA_FRAME_PICTURE        0x00000000
 134 #define VA_TOP_FIELD            0x00000001
 135 #define VA_BOTTOM_FIELD         0x00000002
 136
 137 /*
 138  * Clears the drawable with background color.
 139  * for hardware overlay based implementation this flag
 140  * can be used to turn off the overlay
 141  */
 142 #define VA_CLEAR_DRAWABLE       0x00000008
 143
 144 /* Color space conversion flags for vaPutSurface() */
 145 #define VA_SRC_BT601            0x00000010
 146 #define VA_SRC_BT709            0x00000020
 147
 148 /*
 149  * Returns a short english description of error_status
 150  */
 151 const char *vaErrorStr(VAStatus error_status);
 152
 153 /*
 154  * Initialization:
 155  * A display must be obtained by calling vaGetDisplay() before calling
 156  * vaInitialize() and other functions. This connects the API to the
 157  * native window system.
 158  * For X Windows, native_dpy would be from XOpenDisplay()
 159  */
 160 typedef void* NativeDisplay;    /* window system dependent */
 161
 162 int vaDisplayIsValid(VADisplay dpy);
 163
 164 /*
 165  * Initialize the library
 166  */
 167 VAStatus vaInitialize (
 168     VADisplay dpy,
 169     int *major_version,  /* out */
 170     int *minor_version   /* out */
 171 );
 172
 173 /*
 174  * After this call, all library internal resources will be cleaned up
 175  */
 176 VAStatus vaTerminate (
 177     VADisplay dpy
 178 );
 179
 180 /*
 181  * vaQueryVendorString returns a pointer to a zero-terminated string
 182  * describing some aspects of the VA implemenation on a specific
 183  * hardware accelerator. The format of the returned string is vendor
 184  * specific and at the discretion of the implementer.
 185  * e.g. for the Intel GMA500 implementation, an example would be:
 186  * "Intel GMA500 - 2.0.0.32L.0005"
 187  */
 188 const char *vaQueryVendorString (
 189     VADisplay dpy
 190 );
 191
 192 typedef int (*VAPrivFunc)();
 193
 194 /*
 195  * Return a function pointer given a function name in the library.
 196  * This allows private interfaces into the library
 197  */
 198 VAPrivFunc vaGetLibFunc (
 199     VADisplay dpy,
 200     const char *func
 201 );
 202
 203 /* Currently defined profiles */
 204 typedef enum
 205 {
 206     VAProfileMPEG2Simple                = 0,
 207     VAProfileMPEG2Main                  = 1,
 208     VAProfileMPEG4Simple                = 2,
 209     VAProfileMPEG4AdvancedSimple        = 3,
 210     VAProfileMPEG4Main                  = 4,
 211     VAProfileH264Baseline               = 5,
 212     VAProfileH264Main                   = 6,
 213     VAProfileH264High                   = 7,
 214     VAProfileVC1Simple                  = 8,
 215     VAProfileVC1Main                    = 9,
 216     VAProfileVC1Advanced                = 10,
 217     VAProfileH263Baseline               = 11,
 218     VAProfileJPEGBaseline               = 12
 219 } VAProfile;
 220
 221 /*
 222  *  Currently defined entrypoints
 223  */
 224 typedef enum
 225 {
 226     VAEntrypointVLD             = 1,
 227     VAEntrypointIZZ             = 2,
 228     VAEntrypointIDCT            = 3,
 229     VAEntrypointMoComp          = 4,
 230     VAEntrypointDeblocking      = 5,
 231     VAEntrypointEncSlice        = 6,    /* slice level encode */
 232     VAEntrypointEncPicture      = 7     /* pictuer encode, JPEG, etc */
 233 } VAEntrypoint;
 234
 235 /* Currently defined configuration attribute types */
 236 typedef enum
 237 {
 238     VAConfigAttribRTFormat              = 0,
 239     VAConfigAttribSpatialResidual       = 1,
 240     VAConfigAttribSpatialClipping       = 2,
 241     VAConfigAttribIntraResidual         = 3,
 242     VAConfigAttribEncryption            = 4,
 243     VAConfigAttribRateControl           = 5
 244 } VAConfigAttribType;
 245
 246 /*
 247  * Configuration attributes
 248  * If there is more than one value for an attribute, a default
 249  * value will be assigned to the attribute if the client does not
 250  * specify the attribute when creating a configuration
 251  */
 252 typedef struct _VAConfigAttrib {
 253     VAConfigAttribType type;
 254     unsigned int value; /* OR'd flags (bits) for this attribute */
 255 } VAConfigAttrib;
 256
 257 /* attribute value for VAConfigAttribRTFormat */
 258 #define VA_RT_FORMAT_YUV420     0x00000001
 259 #define VA_RT_FORMAT_YUV422     0x00000002
 260 #define VA_RT_FORMAT_YUV444     0x00000004
 261 #define VA_RT_FORMAT_PROTECTED  0x80000000
 262
 263 /* attribute value for VAConfigAttribRateControl */
 264 #define VA_RC_NONE      0x00000001
 265 #define VA_RC_CBR       0x00000002
 266 #define VA_RC_VBR       0x00000004
 267
 268 /*
 269  * if an attribute is not applicable for a given
 270  * profile/entrypoint pair, then set the value to the following
 271  */
 272 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
 273
 274 /* Get maximum number of profiles supported by the implementation */
 275 int vaMaxNumProfiles (
 276     VADisplay dpy
 277 );
 278
 279 /* Get maximum number of entrypoints supported by the implementation */
 280 int vaMaxNumEntrypoints (
 281     VADisplay dpy
 282 );
 283
 284 /* Get maximum number of attributs supported by the implementation */
 285 int vaMaxNumConfigAttributes (
 286     VADisplay dpy
 287 );
 288
 289 /*
 290  * Query supported profiles
 291  * The caller must provide a "profile_list" array that can hold at
 292  * least vaMaxNumProfile() entries. The actual number of profiles
 293  * returned in "profile_list" is returned in "num_profile".
 294  */
 295 VAStatus vaQueryConfigProfiles (
 296     VADisplay dpy,
 297     VAProfile *profile_list,    /* out */
 298     int *num_profiles           /* out */
 299 );
 300
 301 /*
 302  * Query supported entrypoints for a given profile
 303  * The caller must provide an "entrypoint_list" array that can hold at
 304  * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
 305  * returned in "entrypoint_list" is returned in "num_entrypoints".
 306  */
 307 VAStatus vaQueryConfigEntrypoints (
 308     VADisplay dpy,
 309     VAProfile profile,
 310     VAEntrypoint *entrypoint_list,      /* out */
 311     int *num_entrypoints                /* out */
 312 );
 313
 314 /*
 315  * Get attributes for a given profile/entrypoint pair
 316  * The caller must provide an "attrib_list" with all attributes to be
 317  * retrieved.  Upon return, the attributes in "attrib_list" have been
 318  * updated with their value.  Unknown attributes or attributes that are
 319  * not supported for the given profile/entrypoint pair will have their
 320  * value set to VA_ATTRIB_NOT_SUPPORTED
 321  */
 322 VAStatus vaGetConfigAttributes (
 323     VADisplay dpy,
 324     VAProfile profile,
 325     VAEntrypoint entrypoint,
 326     VAConfigAttrib *attrib_list, /* in/out */
 327     int num_attribs
 328 );
 329
 330 /* Generic ID type, can be re-typed for specific implementation */
 331 typedef unsigned int VAGenericID;
 332
 333 typedef VAGenericID VAConfigID;
 334
 335 /*
 336  * Create a configuration for the decode pipeline
 337  * it passes in the attribute list that specifies the attributes it cares
 338  * about, with the rest taking default values.
 339  */
 340 VAStatus vaCreateConfig (
 341     VADisplay dpy,
 342     VAProfile profile,
 343     VAEntrypoint entrypoint,
 344     VAConfigAttrib *attrib_list,
 345     int num_attribs,
 346     VAConfigID *config_id /* out */
 347 );
 348
 349 /*
 350  * Free resources associdated with a given config
 351  */
 352 VAStatus vaDestroyConfig (
 353     VADisplay dpy,
 354     VAConfigID config_id
 355 );
 356
 357 /*
 358  * Query all attributes for a given configuration
 359  * The profile of the configuration is returned in "profile"
 360  * The entrypoint of the configuration is returned in "entrypoint"
 361  * The caller must provide an "attrib_list" array that can hold at least
 362  * vaMaxNumConfigAttributes() entries. The actual number of attributes
 363  * returned in "attrib_list" is returned in "num_attribs"
 364  */
 365 VAStatus vaQueryConfigAttributes (
 366     VADisplay dpy,
 367     VAConfigID config_id,
 368     VAProfile *profile,         /* out */
 369     VAEntrypoint *entrypoint,   /* out */
 370     VAConfigAttrib *attrib_list,/* out */
 371     int *num_attribs            /* out */
 372 );
 373
 374
 375 /*
 376  * Contexts and Surfaces
 377  *
 378  * Context represents a "virtual" video decode pipeline. Surfaces are render
 379  * targets for a given context. The data in the surfaces are not accessible
 380  * to the client and the internal data format of the surface is implementatin
 381  * specific.
 382  *
 383  * Surfaces will be bound to a context when the context is created. Once
 384  * a surface is bound to a given context, it can not be used to create
 385  * another context. The association is removed when the context is destroyed
 386  *
 387  * Both contexts and surfaces are identified by unique IDs and its
 388  * implementation specific internals are kept opaque to the clients
 389  */
 390
 391 typedef VAGenericID VAContextID;
 392
 393 typedef VAGenericID VASurfaceID;
 394
 395 #define VA_INVALID_ID           0xffffffff
 396 #define VA_INVALID_SURFACE      VA_INVALID_ID
 397
 398 /*
 399  * vaCreateSurfaces - Create an array of surfaces used for decode and display
 400  *  dpy: display
 401  *  width: surface width
 402  *  height: surface height
 403  *  format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
 404  *  num_surfaces: number of surfaces to be created
 405  *  surfaces: array of surfaces created upon return
 406  */
 407 VAStatus vaCreateSurfaces (
 408     VADisplay dpy,
 409     int width,
 410     int height,
 411     int format,
 412     int num_surfaces,
 413     VASurfaceID *surfaces       /* out */
 414 );
 415
 416
 417 /*
 418  * vaDestroySurfaces - Destroy resources associated with surfaces.
 419  *  Surfaces can only be destroyed after the context associated has been
 420  *  destroyed.
 421  *  dpy: display
 422  *  surfaces: array of surfaces to destroy
 423  *  num_surfaces: number of surfaces in the array to be destroyed.
 424  */
 425 VAStatus vaDestroySurfaces (
 426     VADisplay dpy,
 427     VASurfaceID *surfaces,
 428     int num_surfaces
 429 );
 430
 431 #define VA_PROGRESSIVE 0x1
 432 /*
 433  * vaCreateContext - Create a context
 434  *  dpy: display
 435  *  config_id: configuration for the context
 436  *  picture_width: coded picture width
 437  *  picture_height: coded picture height
 438  *  flag: any combination of the following:
 439  *    VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
 440  *  render_targets: render targets (surfaces) tied to the context
 441  *  num_render_targets: number of render targets in the above array
 442  *  context: created context id upon return
 443  */
 444 VAStatus vaCreateContext (
 445     VADisplay dpy,
 446     VAConfigID config_id,
 447     int picture_width,
 448     int picture_height,
 449     int flag,
 450     VASurfaceID *render_targets,
 451     int num_render_targets,
 452     VAContextID *context                /* out */
 453 );
 454
 455 /*
 456  * vaDestroyContext - Destroy a context
 457  *  dpy: display
 458  *  context: context to be destroyed
 459  */
 460 VAStatus vaDestroyContext (
 461     VADisplay dpy,
 462     VAContextID context
 463 );
 464
 465 /*
 466  * Buffers
 467  * Buffers are used to pass various types of data from the
 468  * client to the server. The server maintains a data store
 469  * for each buffer created, and the client idenfies a buffer
 470  * through a unique buffer id assigned by the server.
 471  */
 472
 473 typedef VAGenericID VABufferID;
 474
 475 typedef enum
 476 {
 477     VAPictureParameterBufferType        = 0,
 478     VAIQMatrixBufferType                = 1,
 479     VABitPlaneBufferType                = 2,
 480     VASliceGroupMapBufferType           = 3,
 481     VASliceParameterBufferType          = 4,
 482     VASliceDataBufferType               = 5,
 483     VAMacroblockParameterBufferType     = 6,
 484     VAResidualDataBufferType            = 7,
 485     VADeblockingParameterBufferType     = 8,
 486     VAImageBufferType                   = 9,
 487     VAProtectedSliceDataBufferType      = 10,
 488     VAQMatrixBufferType                 = 11,
 489 /* Following are encode buffer types */
 490     VAEncCodedBufferType                = 21,
 491     VAEncSequenceParameterBufferType    = 22,
 492     VAEncPictureParameterBufferType     = 23,
 493     VAEncSliceParameterBufferType       = 24,
 494     VAEncH264VUIBufferType              = 25,
 495     VAEncH264SEIBufferType              = 26,
 496 } VABufferType;
 497
 498
 499 /*
 500  * There will be cases where the bitstream buffer will not have enough room to hold
 501  * the data for the entire slice, and the following flags will be used in the slice
 502  * parameter to signal to the server for the possible cases.
 503  * If a slice parameter buffer and slice data buffer pair is sent to the server with
 504  * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
 505  * then a slice parameter and data buffer needs to be sent again to complete this slice.
 506  */
 507 #define VA_SLICE_DATA_FLAG_ALL          0x00    /* whole slice is in the buffer */
 508 #define VA_SLICE_DATA_FLAG_BEGIN        0x01    /* The beginning of the slice is in the buffer but the end if not */
 509 #define VA_SLICE_DATA_FLAG_MIDDLE       0x02    /* Neither beginning nor end of the slice is in the buffer */
 510 #define VA_SLICE_DATA_FLAG_END          0x04    /* end of the slice is in the buffer */
 511
 512 /* Codec-independent Slice Parameter Buffer base */
 513 typedef struct _VASliceParameterBufferBase
 514 {
 515     unsigned int slice_data_size;       /* number of bytes in the slice data buffer for this slice */
 516     unsigned int slice_data_offset;     /* the offset to the first byte of slice data */
 517     unsigned int slice_data_flag;       /* see VA_SLICE_DATA_FLAG_XXX definitions */
 518 } VASliceParameterBufferBase;
 519
 520
 521 /****************************
 522  * JEPG data structure
 523  ***************************/
 524 typedef struct _VAQMatrixBufferJPEG
 525 {
 526     int load_lum_quantiser_matrix;
 527     int load_chroma_quantiser_matrix;
 528     unsigned char lum_quantiser_matrix[64];
 529     unsigned char chroma_quantiser_matrix[64];
 530 } VAQMatrixBufferJPEG;
 531
 532 typedef struct _VAEncPictureParameterBufferJPEG
 533 {
 534     VASurfaceID reconstructed_picture;
 535     unsigned short picture_width;
 536     unsigned short picture_height;
 537     VABufferID coded_buf;
 538 } VAEncPictureParameterBufferJPEG;
 539
 540
 541 /****************************
 542  * MPEG-2 data structures
 543  ****************************/
 544
 545 /* MPEG-2 Picture Parameter Buffer */
 546 /*
 547  * For each frame or field, and before any slice data, a single
 548  * picture parameter buffer must be send.
 549  */
 550 typedef struct _VAPictureParameterBufferMPEG2
 551 {
 552     unsigned short horizontal_size;
 553     unsigned short vertical_size;
 554     VASurfaceID forward_reference_picture;
 555     VASurfaceID backward_reference_picture;
 556     /* meanings of the following fields are the same as in the standard */
 557     int picture_coding_type;
 558     int f_code; /* pack all four fcode into this */
 559     union {
 560         struct {
 561             unsigned int intra_dc_precision             : 2;
 562             unsigned int picture_structure              : 2;
 563             unsigned int top_field_first                : 1;
 564             unsigned int frame_pred_frame_dct           : 1;
 565             unsigned int concealment_motion_vectors     : 1;
 566             unsigned int q_scale_type                   : 1;
 567             unsigned int intra_vlc_format               : 1;
 568             unsigned int alternate_scan                 : 1;
 569             unsigned int repeat_first_field             : 1;
 570             unsigned int progressive_frame              : 1;
 571             unsigned int is_first_field                 : 1; /* indicate whether the current field
 572                                                               * is the first field for field picture
 573                                                               */
 574         } bits;
 575         unsigned int value;
 576     } picture_coding_extension;
 577 } VAPictureParameterBufferMPEG2;
 578
 579 /* MPEG-2 Inverse Quantization Matrix Buffer */
 580 typedef struct _VAIQMatrixBufferMPEG2
 581 {
 582     int load_intra_quantiser_matrix;
 583     int load_non_intra_quantiser_matrix;
 584     int load_chroma_intra_quantiser_matrix;
 585     int load_chroma_non_intra_quantiser_matrix;
 586     unsigned char intra_quantiser_matrix[64];
 587     unsigned char non_intra_quantiser_matrix[64];
 588     unsigned char chroma_intra_quantiser_matrix[64];
 589     unsigned char chroma_non_intra_quantiser_matrix[64];
 590 } VAIQMatrixBufferMPEG2;
 591
 592 /* MPEG-2 Slice Parameter Buffer */
 593 typedef struct _VASliceParameterBufferMPEG2
 594 {
 595     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 596     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 597     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 598     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 599     unsigned int slice_horizontal_position;
 600     unsigned int slice_vertical_position;
 601     int quantiser_scale_code;
 602     int intra_slice_flag;
 603 } VASliceParameterBufferMPEG2;
 604
 605 /* MPEG-2 Macroblock Parameter Buffer */
 606 typedef struct _VAMacroblockParameterBufferMPEG2
 607 {
 608     unsigned short macroblock_address;
 609     /*
 610      * macroblock_address (in raster scan order)
 611      * top-left: 0
 612      * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
 613      */
 614     unsigned char macroblock_type;  /* see definition below */
 615     union {
 616         struct {
 617             unsigned int frame_motion_type              : 2;
 618             unsigned int field_motion_type              : 2;
 619             unsigned int dct_type                       : 1;
 620         } bits;
 621         unsigned int value;
 622     } macroblock_modes;
 623     unsigned char motion_vertical_field_select;
 624     /*
 625      * motion_vertical_field_select:
 626      * see section 6.3.17.2 in the spec
 627      * only the lower 4 bits are used
 628      * bit 0: first vector forward
 629      * bit 1: first vector backward
 630      * bit 2: second vector forward
 631      * bit 3: second vector backward
 632      */
 633     short PMV[2][2][2]; /* see Table 7-7 in the spec */
 634     unsigned short coded_block_pattern;
 635     /*
 636      * The bitplanes for coded_block_pattern are described
 637      * in Figure 6.10-12 in the spec
 638      */
 639
 640     /* Number of skipped macroblocks after this macroblock */
 641     unsigned short num_skipped_macroblocks;
 642 } VAMacroblockParameterBufferMPEG2;
 643
 644 /*
 645  * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
 646  */
 647 #define VA_MB_TYPE_MOTION_FORWARD       0x02
 648 #define VA_MB_TYPE_MOTION_BACKWARD      0x04
 649 #define VA_MB_TYPE_MOTION_PATTERN       0x08
 650 #define VA_MB_TYPE_MOTION_INTRA         0x10
 651
 652 /*
 653  * MPEG-2 Residual Data Buffer
 654  * For each macroblock, there wil be 64 shorts (16-bit) in the
 655  * residual data buffer
 656  */
 657
 658 /****************************
 659  * MPEG-4 Part 2 data structures
 660  ****************************/
 661
 662 /* MPEG-4 Picture Parameter Buffer */
 663 /*
 664  * For each frame or field, and before any slice data, a single
 665  * picture parameter buffer must be send.
 666  */
 667 typedef struct _VAPictureParameterBufferMPEG4
 668 {
 669     unsigned short vop_width;
 670     unsigned short vop_height;
 671     VASurfaceID forward_reference_picture;
 672     VASurfaceID backward_reference_picture;
 673     union {
 674         struct {
 675             unsigned int short_video_header             : 1;
 676             unsigned int chroma_format                  : 2;
 677             unsigned int interlaced                     : 1;
 678             unsigned int obmc_disable                   : 1;
 679             unsigned int sprite_enable                  : 2;
 680             unsigned int sprite_warping_accuracy        : 2;
 681             unsigned int quant_type                     : 1;
 682             unsigned int quarter_sample                 : 1;
 683             unsigned int data_partitioned               : 1;
 684             unsigned int reversible_vlc                 : 1;
 685             unsigned int resync_marker_disable          : 1;
 686         } bits;
 687         unsigned int value;
 688     } vol_fields;
 689     unsigned char no_of_sprite_warping_points;
 690     short sprite_trajectory_du[3];
 691     short sprite_trajectory_dv[3];
 692     unsigned char quant_precision;
 693     union {
 694         struct {
 695             unsigned int vop_coding_type                : 2;
 696             unsigned int backward_reference_vop_coding_type     : 2;
 697             unsigned int vop_rounding_type              : 1;
 698             unsigned int intra_dc_vlc_thr               : 3;
 699             unsigned int top_field_first                : 1;
 700             unsigned int alternate_vertical_scan_flag   : 1;
 701         } bits;
 702         unsigned int value;
 703     } vop_fields;
 704     unsigned char vop_fcode_forward;
 705     unsigned char vop_fcode_backward;
 706     unsigned short vop_time_increment_resolution;
 707     /* short header related */
 708     unsigned char num_gobs_in_vop;
 709     unsigned char num_macroblocks_in_gob;
 710     /* for direct mode prediction */
 711     short TRB;
 712     short TRD;
 713 } VAPictureParameterBufferMPEG4;
 714
 715 /* MPEG-4 Inverse Quantization Matrix Buffer */
 716 typedef struct _VAIQMatrixBufferMPEG4
 717 {
 718     int load_intra_quant_mat;
 719     int load_non_intra_quant_mat;
 720     unsigned char intra_quant_mat[64];
 721     unsigned char non_intra_quant_mat[64];
 722 } VAIQMatrixBufferMPEG4;
 723
 724 /* MPEG-4 Slice Parameter Buffer */
 725 typedef struct _VASliceParameterBufferMPEG4
 726 {
 727     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 728     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 729     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 730     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 731     unsigned int macroblock_number;
 732     int quant_scale;
 733 } VASliceParameterBufferMPEG4;
 734
 735 /*
 736  VC-1 data structures
 737 */
 738
 739 typedef enum   /* see 7.1.1.32 */
 740 {
 741     VAMvMode1Mv                        = 0,
 742     VAMvMode1MvHalfPel                 = 1,
 743     VAMvMode1MvHalfPelBilinear         = 2,
 744     VAMvModeMixedMv                    = 3,
 745     VAMvModeIntensityCompensation      = 4
 746 } VAMvModeVC1;
 747
 748 /* VC-1 Picture Parameter Buffer */
 749 /*
 750  * For each picture, and before any slice data, a picture parameter
 751  * buffer must be send. Multiple picture parameter buffers may be
 752  * sent for a single picture. In that case picture parameters will
 753  * apply to all slice data that follow it until a new picture
 754  * parameter buffer is sent.
 755  *
 756  * Notes:
 757  *   pic_quantizer_type should be set to the applicable quantizer
 758  *   type as defined by QUANTIZER (J.1.19) and either
 759  *   PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
 760  */
 761 typedef struct _VAPictureParameterBufferVC1
 762 {
 763     VASurfaceID forward_reference_picture;
 764     VASurfaceID backward_reference_picture;
 765     /* if out-of-loop post-processing is done on the render
 766        target, then we need to keep the in-loop decoded
 767        picture as a reference picture */
 768     VASurfaceID inloop_decoded_picture;
 769
 770     /* sequence layer for AP or meta data for SP and MP */
 771     union {
 772         struct {
 773             unsigned int pulldown       : 1; /* SEQUENCE_LAYER::PULLDOWN */
 774             unsigned int interlace      : 1; /* SEQUENCE_LAYER::INTERLACE */
 775             unsigned int tfcntrflag     : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
 776             unsigned int finterpflag    : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
 777             unsigned int psf            : 1; /* SEQUENCE_LAYER::PSF */
 778             unsigned int multires       : 1; /* METADATA::MULTIRES */
 779             unsigned int overlap        : 1; /* METADATA::OVERLAP */
 780             unsigned int syncmarker     : 1; /* METADATA::SYNCMARKER */
 781             unsigned int rangered       : 1; /* METADATA::RANGERED */
 782             unsigned int max_b_frames   : 3; /* METADATA::MAXBFRAMES */
 783         } bits;
 784         unsigned int value;
 785     } sequence_fields;
 786
 787     unsigned short coded_width;         /* ENTRY_POINT_LAYER::CODED_WIDTH */
 788     unsigned short coded_height;        /* ENTRY_POINT_LAYER::CODED_HEIGHT */
 789     union {
 790         struct {
 791             unsigned int broken_link    : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
 792             unsigned int closed_entry   : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
 793             unsigned int panscan_flag   : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
 794             unsigned int loopfilter     : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
 795         } bits;
 796         unsigned int value;
 797     } entrypoint_fields;
 798     unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
 799     unsigned char fast_uvmc_flag;       /* ENTRY_POINT_LAYER::FASTUVMC */
 800     union {
 801         struct {
 802             unsigned int luma_flag      : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
 803             unsigned int luma           : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
 804             unsigned int chroma_flag    : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
 805             unsigned int chroma         : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
 806         } bits;
 807         unsigned int value;
 808     } range_mapping_fields;
 809
 810     unsigned char b_picture_fraction;   /* PICTURE_LAYER::BFRACTION */
 811     unsigned char cbp_table;            /* PICTURE_LAYER::CBPTAB/ICBPTAB */
 812     unsigned char mb_mode_table;        /* PICTURE_LAYER::MBMODETAB */
 813     unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
 814     unsigned char rounding_control;     /* PICTURE_LAYER::RNDCTRL */
 815     unsigned char post_processing;      /* PICTURE_LAYER::POSTPROC */
 816     unsigned char picture_resolution_index;     /* PICTURE_LAYER::RESPIC */
 817     unsigned char luma_scale;           /* PICTURE_LAYER::LUMSCALE */
 818     unsigned char luma_shift;           /* PICTURE_LAYER::LUMSHIFT */
 819     union {
 820         struct {
 821             unsigned int picture_type           : 3; /* PICTURE_LAYER::PTYPE */
 822             unsigned int frame_coding_mode      : 3; /* PICTURE_LAYER::FCM */
 823             unsigned int top_field_first        : 1; /* PICTURE_LAYER::TFF */
 824             unsigned int is_first_field         : 1; /* set to 1 if it is the first field */
 825             unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
 826         } bits;
 827         unsigned int value;
 828     } picture_fields;
 829     union {
 830         struct {
 831             unsigned int mv_type_mb     : 1;    /* PICTURE::MVTYPEMB */
 832             unsigned int direct_mb      : 1;    /* PICTURE::DIRECTMB */
 833             unsigned int skip_mb        : 1;    /* PICTURE::SKIPMB */
 834             unsigned int field_tx       : 1;    /* PICTURE::FIELDTX */
 835             unsigned int forward_mb     : 1;    /* PICTURE::FORWARDMB */
 836             unsigned int ac_pred        : 1;    /* PICTURE::ACPRED */
 837             unsigned int overflags      : 1;    /* PICTURE::OVERFLAGS */
 838         } flags;
 839         unsigned int value;
 840     } raw_coding;
 841     union {
 842         struct {
 843             unsigned int bp_mv_type_mb   : 1;    /* PICTURE::MVTYPEMB */
 844             unsigned int bp_direct_mb    : 1;    /* PICTURE::DIRECTMB */
 845             unsigned int bp_skip_mb      : 1;    /* PICTURE::SKIPMB */
 846             unsigned int bp_field_tx     : 1;    /* PICTURE::FIELDTX */
 847             unsigned int bp_forward_mb   : 1;    /* PICTURE::FORWARDMB */
 848             unsigned int bp_ac_pred      : 1;    /* PICTURE::ACPRED */
 849             unsigned int bp_overflags    : 1;    /* PICTURE::OVERFLAGS */
 850         } flags;
 851         unsigned int value;
 852     } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
 853     union {
 854         struct {
 855             unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
 856             unsigned int reference_distance     : 5;/* PICTURE_LAYER::REFDIST */
 857             unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
 858             unsigned int reference_field_pic_indicator  : 1;/* PICTURE_LAYER::REFFIELD */
 859         } bits;
 860         unsigned int value;
 861     } reference_fields;
 862     union {
 863         struct {
 864             unsigned int mv_mode                : 3; /* PICTURE_LAYER::MVMODE */
 865             unsigned int mv_mode2               : 3; /* PICTURE_LAYER::MVMODE2 */
 866             unsigned int mv_table               : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
 867             unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
 868             unsigned int four_mv_switch         : 1; /* PICTURE_LAYER::4MVSWITCH */
 869             unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
 870             unsigned int extended_mv_flag       : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
 871             unsigned int extended_mv_range      : 2; /* PICTURE_LAYER::MVRANGE */
 872             unsigned int extended_dmv_flag      : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
 873             unsigned int extended_dmv_range     : 2; /* PICTURE_LAYER::DMVRANGE */
 874         } bits;
 875         unsigned int value;
 876     } mv_fields;
 877     union {
 878         struct {
 879             unsigned int dquant : 2;    /* ENTRY_POINT_LAYER::DQUANT */
 880             unsigned int quantizer     : 2;     /* ENTRY_POINT_LAYER::QUANTIZER */
 881             unsigned int half_qp        : 1;    /* PICTURE_LAYER::HALFQP */
 882             unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
 883             unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
 884             unsigned int dq_frame       : 1;    /* VOPDQUANT::DQUANTFRM */
 885             unsigned int dq_profile     : 2;    /* VOPDQUANT::DQPROFILE */
 886             unsigned int dq_sb_edge     : 2;    /* VOPDQUANT::DQSBEDGE */
 887             unsigned int dq_db_edge     : 2;    /* VOPDQUANT::DQDBEDGE */
 888             unsigned int dq_binary_level : 1;   /* VOPDQUANT::DQBILEVEL */
 889             unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
 890         } bits;
 891         unsigned int value;
 892     } pic_quantizer_fields;
 893     union {
 894         struct {
 895             unsigned int variable_sized_transform_flag  : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
 896             unsigned int mb_level_transform_type_flag   : 1;/* PICTURE_LAYER::TTMBF */
 897             unsigned int frame_level_transform_type     : 2;/* PICTURE_LAYER::TTFRM */
 898             unsigned int transform_ac_codingset_idx1    : 2;/* PICTURE_LAYER::TRANSACFRM */
 899             unsigned int transform_ac_codingset_idx2    : 2;/* PICTURE_LAYER::TRANSACFRM2 */
 900             unsigned int intra_transform_dc_table       : 1;/* PICTURE_LAYER::TRANSDCTAB */
 901         } bits;
 902         unsigned int value;
 903     } transform_fields;
 904 } VAPictureParameterBufferVC1;
 905
 906 /* VC-1 Bitplane Buffer
 907 There will be at most three bitplanes coded in any picture header. To send
 908 the bitplane data more efficiently, each byte is divided in two nibbles, with
 909 each nibble carrying three bitplanes for one macroblock.  The following table
 910 shows the bitplane data arrangement within each nibble based on the picture
 911 type.
 912
 913 Picture Type    Bit3            Bit2            Bit1            Bit0
 914 I or BI                         OVERFLAGS       ACPRED          FIELDTX
 915 P                               MYTYPEMB        SKIPMB          DIRECTMB
 916 B                               FORWARDMB       SKIPMB          DIRECTMB
 917
 918 Within each byte, the lower nibble is for the first MB and the upper nibble is
 919 for the second MB.  E.g. the lower nibble of the first byte in the bitplane
 920 buffer is for Macroblock #1 and the upper nibble of the first byte is for
 921 Macroblock #2 in the first row.
 922 */
 923
 924 /* VC-1 Slice Parameter Buffer */
 925 typedef struct _VASliceParameterBufferVC1
 926 {
 927     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 928     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 929     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 930     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 931     unsigned int slice_vertical_position;
 932 } VASliceParameterBufferVC1;
 933
 934 /* VC-1 Slice Data Buffer */
 935 /*
 936 This is simplely a buffer containing raw bit-stream bytes
 937 */
 938
 939 /****************************
 940  * H.264/AVC data structures
 941  ****************************/
 942
 943 typedef struct _VAPictureH264
 944 {
 945     VASurfaceID picture_id;
 946     unsigned int frame_idx;
 947     unsigned int flags;
 948     unsigned int TopFieldOrderCnt;
 949     unsigned int BottomFieldOrderCnt;
 950 } VAPictureH264;
 951 /* flags in VAPictureH264 could be OR of the following */
 952 #define VA_PICTURE_H264_INVALID                 0x00000001
 953 #define VA_PICTURE_H264_TOP_FIELD               0x00000002
 954 #define VA_PICTURE_H264_BOTTOM_FIELD            0x00000004
 955 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE    0x00000008
 956 #define VA_PICTURE_H264_LONG_TERM_REFERENCE     0x00000010
 957
 958 /* H.264 Picture Parameter Buffer */
 959 /*
 960  * For each picture, and before any slice data, a single
 961  * picture parameter buffer must be send.
 962  */
 963 typedef struct _VAPictureParameterBufferH264
 964 {
 965     VAPictureH264 CurrPic;
 966     VAPictureH264 ReferenceFrames[16];  /* in DPB */
 967     unsigned short picture_width_in_mbs_minus1;
 968     unsigned short picture_height_in_mbs_minus1;
 969     unsigned char bit_depth_luma_minus8;
 970     unsigned char bit_depth_chroma_minus8;
 971     unsigned char num_ref_frames;
 972     union {
 973         struct {
 974             unsigned int chroma_format_idc                      : 2;
 975             unsigned int residual_colour_transform_flag         : 1;
 976             unsigned int gaps_in_frame_num_value_allowed_flag   : 1;
 977             unsigned int frame_mbs_only_flag                    : 1;
 978             unsigned int mb_adaptive_frame_field_flag           : 1;
 979             unsigned int direct_8x8_inference_flag              : 1;
 980             unsigned int MinLumaBiPredSize8x8                   : 1; /* see A.3.3.2 */
 981             unsigned int log2_max_frame_num_minus4              : 4;
 982             unsigned int pic_order_cnt_type                     : 2;
 983             unsigned int log2_max_pic_order_cnt_lsb_minus4      : 4;
 984             unsigned int delta_pic_order_always_zero_flag       : 1;
 985         } bits;
 986         unsigned int value;
 987     } seq_fields;
 988     unsigned char num_slice_groups_minus1;
 989     unsigned char slice_group_map_type;
 990     unsigned short slice_group_change_rate_minus1;
 991     signed char pic_init_qp_minus26;
 992     signed char pic_init_qs_minus26;
 993     signed char chroma_qp_index_offset;
 994     signed char second_chroma_qp_index_offset;
 995     union {
 996         struct {
 997             unsigned int entropy_coding_mode_flag       : 1;
 998             unsigned int weighted_pred_flag             : 1;
 999             unsigned int weighted_bipred_idc            : 2;
1000             unsigned int transform_8x8_mode_flag        : 1;
1001             unsigned int field_pic_flag                 : 1;
1002             unsigned int constrained_intra_pred_flag    : 1;
1003             unsigned int pic_order_present_flag                 : 1;
1004             unsigned int deblocking_filter_control_present_flag : 1;
1005             unsigned int redundant_pic_cnt_present_flag         : 1;
1006             unsigned int reference_pic_flag                     : 1; /* nal_ref_idc != 0 */
1007         } bits;
1008         unsigned int value;
1009     } pic_fields;
1010     unsigned short frame_num;
1011 } VAPictureParameterBufferH264;
1012
1013 /* H.264 Inverse Quantization Matrix Buffer */
1014 typedef struct _VAIQMatrixBufferH264
1015 {
1016     unsigned char ScalingList4x4[6][16];
1017     unsigned char ScalingList8x8[2][64];
1018 } VAIQMatrixBufferH264;
1019
1020 /*
1021  * H.264 Slice Group Map Buffer
1022  * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1023  * A slice group map buffer should be sent for each picture if required. The buffer
1024  * is sent only when there is a change in the mapping values.
1025  * The slice group map buffer map "map units" to slice groups as specified in
1026  * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1027  * in raster scan order
1028  */
1029
1030 /* H.264 Slice Parameter Buffer */
1031 typedef struct _VASliceParameterBufferH264
1032 {
1033     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1034     unsigned int slice_data_offset;/* the offset to the NAL start code for this slice */
1035     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1036     unsigned short slice_data_bit_offset; /* bit offset from NAL start code to the beginning of slice data */
1037     unsigned short first_mb_in_slice;
1038     unsigned char slice_type;
1039     unsigned char direct_spatial_mv_pred_flag;
1040     unsigned char num_ref_idx_l0_active_minus1;
1041     unsigned char num_ref_idx_l1_active_minus1;
1042     unsigned char cabac_init_idc;
1043     char slice_qp_delta;
1044     unsigned char disable_deblocking_filter_idc;
1045     char slice_alpha_c0_offset_div2;
1046     char slice_beta_offset_div2;
1047     VAPictureH264 RefPicList0[32];      /* See 8.2.4.2 */
1048     VAPictureH264 RefPicList1[32];      /* See 8.2.4.2 */
1049     unsigned char luma_log2_weight_denom;
1050     unsigned char chroma_log2_weight_denom;
1051     unsigned char luma_weight_l0_flag;
1052     short luma_weight_l0[32];
1053     short luma_offset_l0[32];
1054     unsigned char chroma_weight_l0_flag;
1055     short chroma_weight_l0[32][2];
1056     short chroma_offset_l0[32][2];
1057     unsigned char luma_weight_l1_flag;
1058     short luma_weight_l1[32];
1059     short luma_offset_l1[32];
1060     unsigned char chroma_weight_l1_flag;
1061     short chroma_weight_l1[32][2];
1062     short chroma_offset_l1[32][2];
1063 } VASliceParameterBufferH264;
1064
1065 /****************************
1066  * Common encode data structures
1067  ****************************/
1068 typedef enum
1069 {
1070     VAEncPictureTypeIntra               = 0,
1071     VAEncPictureTypePredictive          = 1,
1072     VAEncPictureTypeBidirectional       = 2,
1073 } VAEncPictureType;
1074
1075 /* Encode Slice Parameter Buffer */
1076 typedef struct _VAEncSliceParameterBuffer
1077 {
1078     unsigned int start_row_number;      /* starting MB row number for this slice */
1079     unsigned int slice_height;  /* slice height measured in MB */
1080     union {
1081         struct {
1082             unsigned int is_intra       : 1;
1083             unsigned int disable_deblocking_filter_idc : 2;
1084         } bits;
1085         unsigned int value;
1086     } slice_flags;
1087 } VAEncSliceParameterBuffer;
1088
1089 /****************************
1090  * H.264 specific encode data structures
1091  ****************************/
1092
1093 typedef struct _VAEncSequenceParameterBufferH264
1094 {
1095     unsigned char seq_parameter_set_id;
1096     unsigned char level_idc;
1097     unsigned int intra_period;
1098     unsigned int intra_idr_period;
1099     unsigned int picture_width_in_mbs;
1100     unsigned int picture_height_in_mbs;
1101     unsigned int bits_per_second;
1102     unsigned int frame_rate;
1103     unsigned int initial_qp;
1104     unsigned int min_qp;
1105     unsigned int basic_unit_size;
1106     unsigned char vui_flag;
1107 } VAEncSequenceParameterBufferH264;
1108
1109 typedef struct _VAEncPictureParameterBufferH264
1110 {
1111     VASurfaceID reference_picture;
1112     VASurfaceID reconstructed_picture;
1113     VABufferID coded_buf;
1114     unsigned short picture_width;
1115     unsigned short picture_height;
1116     unsigned char last_picture; /* if set to 1 it indicates the last picture in the sequence */
1117 } VAEncPictureParameterBufferH264;
1118
1119 /****************************
1120  * H.263 specific encode data structures
1121  ****************************/
1122
1123 typedef struct _VAEncSequenceParameterBufferH263
1124 {
1125     unsigned int intra_period;
1126     unsigned int bits_per_second;
1127     unsigned int frame_rate;
1128     unsigned int initial_qp;
1129     unsigned int min_qp;
1130 } VAEncSequenceParameterBufferH263;
1131
1132 typedef struct _VAEncPictureParameterBufferH263
1133 {
1134     VASurfaceID reference_picture;
1135     VASurfaceID reconstructed_picture;
1136     VABufferID coded_buf;
1137     unsigned short picture_width;
1138     unsigned short picture_height;
1139     VAEncPictureType picture_type;
1140 } VAEncPictureParameterBufferH263;
1141
1142 /****************************
1143  * MPEG-4 specific encode data structures
1144  ****************************/
1145
1146 typedef struct _VAEncSequenceParameterBufferMPEG4
1147 {
1148     unsigned char profile_and_level_indication;
1149     unsigned int intra_period;
1150     unsigned int video_object_layer_width;
1151     unsigned int video_object_layer_height;
1152     unsigned int vop_time_increment_resolution;
1153     unsigned int fixed_vop_rate;
1154     unsigned int fixed_vop_time_increment;
1155     unsigned int bits_per_second;
1156     unsigned int frame_rate;
1157     unsigned int initial_qp;
1158     unsigned int min_qp;
1159 } VAEncSequenceParameterBufferMPEG4;
1160
1161 typedef struct _VAEncPictureParameterBufferMPEG4
1162 {
1163     VASurfaceID reference_picture;
1164     VASurfaceID reconstructed_picture;
1165     VABufferID coded_buf;
1166     unsigned short picture_width;
1167     unsigned short picture_height;
1168     unsigned int modulo_time_base; /* number of 1s */
1169     unsigned int vop_time_increment;
1170     VAEncPictureType picture_type;
1171 } VAEncPictureParameterBufferMPEG4;
1172
1173
1174
1175 /* Buffer functions */
1176
1177 /*
1178  * Creates a buffer for "num_elements" elements of "size" bytes and
1179  * initalize with "data".
1180  * if "data" is null, then the contents of the buffer data store
1181  * are undefined.
1182  * Basically there are two ways to get buffer data to the server side. One is
1183  * to call vaCreateBuffer() with a non-null "data", which results the data being
1184  * copied to the data store on the server side.  A different method that
1185  * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1186  * and then use vaMapBuffer() to map the data store from the server side to the
1187  * client address space for access.
1188  *  Note: image buffers are created by the library, not the client. Please see
1189  *        vaCreateImage on how image buffers are managed.
1190  */
1191 VAStatus vaCreateBuffer (
1192     VADisplay dpy,
1193     VAContextID context,
1194     VABufferType type,  /* in */
1195     unsigned int size,  /* in */
1196     unsigned int num_elements, /* in */
1197     void *data,         /* in */
1198     VABufferID *buf_id  /* out */
1199 );
1200
1201 /*
1202  * Convey to the server how many valid elements are in the buffer.
1203  * e.g. if multiple slice parameters are being held in a single buffer,
1204  * this will communicate to the server the number of slice parameters
1205  * that are valid in the buffer.
1206  */
1207 VAStatus vaBufferSetNumElements (
1208     VADisplay dpy,
1209     VABufferID buf_id,  /* in */
1210     unsigned int num_elements /* in */
1211 );
1212
1213
1214 /*
1215  * device independent data structure for codedbuffer
1216  */
1217 typedef  struct _VACodedBufferSegment {
1218     unsigned int size; /* size of the data buffer in the coded buffer segment, in bytes */
1219     unsigned int bit_offset;/* bit offset into the data buffer where valid bitstream data begins */
1220     void *buf; /* pointer to the beginning of the data buffer in the coded buffer segment */
1221     void *next; /* pointer to the next VACodedBufferSegment */
1222 } VACodedBufferSegment;
1223
1224 /*
1225  * Map data store of the buffer into the client's address space
1226  * vaCreateBuffer() needs to be called with "data" set to NULL before
1227  * calling vaMapBuffer()
1228  *
1229  * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1230  * VACodedBufferSegment, and the list is terminated if "next" is NULL
1231  */
1232 VAStatus vaMapBuffer (
1233     VADisplay dpy,
1234     VABufferID buf_id,  /* in */
1235     void **pbuf         /* out */
1236 );
1237
1238 /*
1239  * After client making changes to a mapped data store, it needs to
1240  * "Unmap" it to let the server know that the data is ready to be
1241  * consumed by the server
1242  */
1243 VAStatus vaUnmapBuffer (
1244     VADisplay dpy,
1245     VABufferID buf_id   /* in */
1246 );
1247
1248 /*
1249  * After this call, the buffer is deleted and this buffer_id is no longer valid
1250  * Only call this if the buffer is not going to be passed to vaRenderBuffer
1251  */
1252 VAStatus vaDestroyBuffer (
1253     VADisplay dpy,
1254     VABufferID buffer_id
1255 );
1256
1257 /*
1258 Render (Decode) Pictures
1259
1260 A picture represents either a frame or a field.
1261
1262 The Begin/Render/End sequence sends the decode buffers to the server
1263 */
1264
1265 /*
1266  * Get ready to decode a picture to a target surface
1267  */
1268 VAStatus vaBeginPicture (
1269     VADisplay dpy,
1270     VAContextID context,
1271     VASurfaceID render_target
1272 );
1273
1274 /*
1275  * Send decode buffers to the server.
1276  * Buffers are automatically destroyed afterwards
1277  */
1278 VAStatus vaRenderPicture (
1279     VADisplay dpy,
1280     VAContextID context,
1281     VABufferID *buffers,
1282     int num_buffers
1283 );
1284
1285 /*
1286  * Make the end of rendering for a picture.
1287  * The server should start processing all pending operations for this
1288  * surface. This call is non-blocking. The client can start another
1289  * Begin/Render/End sequence on a different render target.
1290  */
1291 VAStatus vaEndPicture (
1292     VADisplay dpy,
1293     VAContextID context
1294 );
1295
1296 /*
1297
1298 Synchronization
1299
1300 */
1301
1302 /*
1303  * This function blocks until all pending operations on the render target
1304  * have been completed.  Upon return it is safe to use the render target for a
1305  * different picture.
1306  */
1307 VAStatus vaSyncSurface (
1308     VADisplay dpy,
1309     VASurfaceID render_target
1310 );
1311
1312 typedef enum
1313 {
1314     VASurfaceRendering  = 1, /* Rendering in progress */
1315     VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1316                              /* this status is useful if surface is used as the source */
1317                              /* of an overlay */
1318     VASurfaceReady      = 4, /* not being rendered or displayed */
1319     VASurfaceSkipped    = 8  /* Indicate a skipped frame during encode */
1320 } VASurfaceStatus;
1321
1322 /*
1323  * Find out any pending ops on the render target
1324  */
1325 VAStatus vaQuerySurfaceStatus (
1326     VADisplay dpy,
1327     VASurfaceID render_target,
1328     VASurfaceStatus *status     /* out */
1329 );
1330
1331 /*
1332  * Images and Subpictures
1333  * VAImage is used to either get the surface data to client memory, or
1334  * to copy image data in client memory to a surface.
1335  * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1336  * is at the upper left corner with positive X to the right and positive Y down
1337  */
1338 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1339     ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1340     ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1341
1342 /* a few common FourCCs */
1343 #define VA_FOURCC_NV12          0x3231564E
1344 #define VA_FOURCC_AI44          0x34344149
1345 #define VA_FOURCC_RGBA          0x41424752
1346 #define VA_FOURCC_UYVY          0x59565955
1347 #define VA_FOURCC_YUY2          0x32595559
1348 #define VA_FOURCC_AYUV          0x56555941
1349 #define VA_FOURCC_NV11          0x3131564e
1350 #define VA_FOURCC_YV12          0x32315659
1351 #define VA_FOURCC_P208          0x38303250
1352 #define VA_FOURCC_IYUV          0x56555949
1353
1354 /* byte order */
1355 #define VA_LSB_FIRST            1
1356 #define VA_MSB_FIRST            2
1357
1358 typedef struct _VAImageFormat
1359 {
1360     unsigned int        fourcc;
1361     unsigned int        byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1362     unsigned int        bits_per_pixel;
1363     /* for RGB formats */
1364     unsigned int        depth; /* significant bits per pixel */
1365     unsigned int        red_mask;
1366     unsigned int        green_mask;
1367     unsigned int        blue_mask;
1368     unsigned int        alpha_mask;
1369 } VAImageFormat;
1370
1371 typedef VAGenericID VAImageID;
1372
1373 typedef struct _VAImage
1374 {
1375     VAImageID           image_id; /* uniquely identify this image */
1376     VAImageFormat       format;
1377     VABufferID          buf;    /* image data buffer */
1378     /*
1379      * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1380      * data store on the server side for optimal performance. The buffer will be
1381      * created by the CreateImage function, and proper storage allocated based on the image
1382      * size and format. This buffer is managed by the library implementation, and
1383      * accessed by the client through the buffer Map/Unmap functions.
1384      */
1385     unsigned short      width;
1386     unsigned short      height;
1387     unsigned int        data_size;
1388     unsigned int        num_planes;     /* can not be greater than 3 */
1389     /*
1390      * An array indicating the scanline pitch in bytes for each plane.
1391      * Each plane may have a different pitch. Maximum 3 planes for planar formats
1392      */
1393     unsigned int        pitches[3];
1394     /*
1395      * An array indicating the byte offset from the beginning of the image data
1396      * to the start of each plane.
1397      */
1398     unsigned int        offsets[3];
1399
1400     /* The following fields are only needed for paletted formats */
1401     int num_palette_entries;   /* set to zero for non-palette images */
1402     /*
1403      * Each component is one byte and entry_bytes indicates the number of components in
1404      * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1405      */
1406     int entry_bytes;
1407     /*
1408      * An array of ascii characters describing the order of the components within the bytes.
1409      * Only entry_bytes characters of the string are used.
1410      */
1411     char component_order[4];
1412 } VAImage;
1413
1414 /* Get maximum number of image formats supported by the implementation */
1415 int vaMaxNumImageFormats (
1416     VADisplay dpy
1417 );
1418
1419 /*
1420  * Query supported image formats
1421  * The caller must provide a "format_list" array that can hold at
1422  * least vaMaxNumImageFormats() entries. The actual number of formats
1423  * returned in "format_list" is returned in "num_formats".
1424  */
1425 VAStatus vaQueryImageFormats (
1426     VADisplay dpy,
1427     VAImageFormat *format_list, /* out */
1428     int *num_formats            /* out */
1429 );
1430
1431 /*
1432  * Create a VAImage structure
1433  * The width and height fields returned in the VAImage structure may get
1434  * enlarged for some YUV formats. Upon return from this function,
1435  * image->buf has been created and proper storage allocated by the library.
1436  * The client can access the image through the Map/Unmap calls.
1437  */
1438 VAStatus vaCreateImage (
1439     VADisplay dpy,
1440     VAImageFormat *format,
1441     int width,
1442     int height,
1443     VAImage *image      /* out */
1444 );
1445
1446 /*
1447  * Should call DestroyImage before destroying the surface it is bound to
1448  */
1449 VAStatus vaDestroyImage (
1450     VADisplay dpy,
1451     VAImageID image
1452 );
1453
1454 VAStatus vaSetImagePalette (
1455     VADisplay dpy,
1456     VAImageID image,
1457     /*
1458      * pointer to an array holding the palette data.  The size of the array is
1459      * num_palette_entries * entry_bytes in size.  The order of the components
1460      * in the palette is described by the component_order in VAImage struct
1461      */
1462     unsigned char *palette
1463 );
1464
1465 /*
1466  * Retrive surface data into a VAImage
1467  * Image must be in a format supported by the implementation
1468  */
1469 VAStatus vaGetImage (
1470     VADisplay dpy,
1471     VASurfaceID surface,
1472     int x,      /* coordinates of the upper left source pixel */
1473     int y,
1474     unsigned int width, /* width and height of the region */
1475     unsigned int height,
1476     VAImageID image
1477 );
1478
1479 /*
1480  * Copy data from a VAImage to a surface
1481  * Image must be in a format supported by the implementation
1482  * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1483  * shouldn't be rendered into when this is called
1484  */
1485 VAStatus vaPutImage (
1486     VADisplay dpy,
1487     VASurfaceID surface,
1488     VAImageID image,
1489     int src_x,
1490     int src_y,
1491     unsigned int src_width,
1492     unsigned int src_height,
1493     int dest_x,
1494     int dest_y,
1495     unsigned int dest_width,
1496     unsigned int dest_height
1497 );
1498
1499 /*
1500  * Derive an VAImage from an existing surface.
1501  * This interface will derive a VAImage and corresponding image buffer from
1502  * an existing VA Surface. The image buffer can then be mapped/unmapped for
1503  * direct CPU access. This operation is only possible on implementations with
1504  * direct rendering capabilities and internal surface formats that can be
1505  * represented with a VAImage. When the operation is not possible this interface
1506  * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1507  * to using vaCreateImage + vaPutImage to accomplish the same task in an
1508  * indirect manner.
1509  *
1510  * Implementations should only return success when the resulting image buffer
1511  * would be useable with vaMap/Unmap.
1512  *
1513  * When directly accessing a surface special care must be taken to insure
1514  * proper synchronization with the graphics hardware. Clients should call
1515  * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1516  * rendering or currently being displayed by an overlay.
1517  *
1518  * Additionally nothing about the contents of a surface should be assumed
1519  * following a vaPutSurface. Implementations are free to modify the surface for
1520  * scaling or subpicture blending within a call to vaPutImage.
1521  *
1522  * Calls to vaPutImage or vaGetImage using the same surface from which the image
1523  * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1524  * vaGetImage with other surfaces is supported.
1525  *
1526  * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1527  * image and image buffer structures will be destroyed; however, the underlying
1528  * surface will remain unchanged until freed with vaDestroySurfaces.
1529  */
1530 VAStatus vaDeriveImage (
1531     VADisplay dpy,
1532     VASurfaceID surface,
1533     VAImage *image      /* out */
1534 );
1535
1536 /*
1537  * Subpictures
1538  * Subpicture is a special type of image that can be blended
1539  * with a surface during vaPutSurface(). Subpicture can be used to render
1540  * DVD sub-titles or closed captioning text etc.
1541  */
1542
1543 typedef VAGenericID VASubpictureID;
1544
1545 /* Get maximum number of subpicture formats supported by the implementation */
1546 int vaMaxNumSubpictureFormats (
1547     VADisplay dpy
1548 );
1549
1550 /* flags for subpictures */
1551 #define VA_SUBPICTURE_CHROMA_KEYING     0x0001
1552 #define VA_SUBPICTURE_GLOBAL_ALPHA      0x0002
1553 /*
1554  * Query supported subpicture formats
1555  * The caller must provide a "format_list" array that can hold at
1556  * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1557  * for each format to indicate additional capabilities for that format. The actual
1558  * number of formats returned in "format_list" is returned in "num_formats".
1559  *  flags: returned value to indicate addtional capabilities
1560  *         VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1561  *         VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1562  */
1563 VAStatus vaQuerySubpictureFormats (
1564     VADisplay dpy,
1565     VAImageFormat *format_list, /* out */
1566     unsigned int *flags,        /* out */
1567     unsigned int *num_formats   /* out */
1568 );
1569
1570 /*
1571  * Subpictures are created with an image associated.
1572  */
1573 VAStatus vaCreateSubpicture (
1574     VADisplay dpy,
1575     VAImageID image,
1576     VASubpictureID *subpicture  /* out */
1577 );
1578
1579 /*
1580  * Destroy the subpicture before destroying the image it is assocated to
1581  */
1582 VAStatus vaDestroySubpicture (
1583     VADisplay dpy,
1584     VASubpictureID subpicture
1585 );
1586
1587 /*
1588  * Bind an image to the subpicture. This image will now be associated with
1589  * the subpicture instead of the one at creation.
1590  */
1591 VAStatus vaSetSubpictureImage (
1592     VADisplay dpy,
1593     VASubpictureID subpicture,
1594     VAImageID image
1595 );
1596
1597 /*
1598  * If chromakey is enabled, then the area where the source value falls within
1599  * the chromakey [min, max] range is transparent
1600  * The chromakey component format is the following:
1601  *  For RGB: [0:7] Red [8:15] Blue [16:23] Green
1602  *  For YUV: [0:7] V [8:15] U [16:23] Y
1603  * The chromakey mask can be used to mask out certain components for chromakey
1604  * comparision
1605  */
1606 VAStatus vaSetSubpictureChromakey (
1607     VADisplay dpy,
1608     VASubpictureID subpicture,
1609     unsigned int chromakey_min,
1610     unsigned int chromakey_max,
1611     unsigned int chromakey_mask
1612 );
1613
1614 /*
1615  * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
1616  * a value of 0 means fully transparent. If per-pixel alpha is also specified then
1617  * the overall alpha is per-pixel alpha multiplied by the global alpha
1618  */
1619 VAStatus vaSetSubpictureGlobalAlpha (
1620     VADisplay dpy,
1621     VASubpictureID subpicture,
1622     float global_alpha
1623 );
1624
1625 /*
1626  * vaAssociateSubpicture associates the subpicture with target_surfaces.
1627  * It defines the region mapping between the subpicture and the target
1628  * surfaces through source and destination rectangles (with the same width and height).
1629  * Both will be displayed at the next call to vaPutSurface.  Additional
1630  * associations before the call to vaPutSurface simply overrides the association.
1631  */
1632 VAStatus vaAssociateSubpicture (
1633     VADisplay dpy,
1634     VASubpictureID subpicture,
1635     VASurfaceID *target_surfaces,
1636     int num_surfaces,
1637     short src_x, /* upper left offset in subpicture */
1638     short src_y,
1639     unsigned short src_width,
1640     unsigned short src_height,
1641     short dest_x, /* upper left offset in surface */
1642     short dest_y,
1643     unsigned short dest_width,
1644     unsigned short dest_height,
1645     /*
1646      * whether to enable chroma-keying or global-alpha
1647      * see VA_SUBPICTURE_XXX values
1648      */
1649     unsigned int flags
1650 );
1651
1652 /*
1653  * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
1654  */
1655 VAStatus vaDeassociateSubpicture (
1656     VADisplay dpy,
1657     VASubpictureID subpicture,
1658     VASurfaceID *target_surfaces,
1659     int num_surfaces
1660 );
1661
1662 typedef struct _VARectangle
1663 {
1664     short x;
1665     short y;
1666     unsigned short width;
1667     unsigned short height;
1668 } VARectangle;
1669
1670 /*
1671  * Display attributes
1672  * Display attributes are used to control things such as contrast, hue, saturation,
1673  * brightness etc. in the rendering process.  The application can query what
1674  * attributes are supported by the driver, and then set the appropriate attributes
1675  * before calling vaPutSurface()
1676  */
1677 /* PowerVR IEP Lite attributes */
1678 typedef enum
1679 {
1680     VADISPLAYATTRIB_BLE_OFF              = 0x00,
1681     VADISPLAYATTRIB_BLE_LOW,
1682     VADISPLAYATTRIB_BLE_MEDIUM,
1683     VADISPLAYATTRIB_BLE_HIGH,
1684     VADISPLAYATTRIB_BLE_NONE,
1685 } VADisplayAttribBLEMode;
1686
1687 typedef enum
1688 {
1689     VADISPLAYATTRIB_CSC_FORMAT_YCC_BT601 = 0x00,
1690     VADISPLAYATTRIB_CSC_FORMAT_YCC_BT709,
1691     VADISPLAYATTRIB_CSC_FORMAT_YCC_SMPTE_240,
1692     VADISPLAYATTRIB_CSC_FORMAT_RGB,
1693     VADISPLAYATTRIB_CSC_FORMAT_NONE,
1694 } VADisplayAttribCSCFormat;
1695
1696 /* attribute value for VADisplayAttribRotation   */
1697 #define VA_ROTATION_NONE        0x00000000
1698 #define VA_ROTATION_90          0x00000001
1699 #define VA_ROTATION_180         0x00000002
1700 #define VA_ROTATION_270         0x00000004
1701
1702 /* attribute value for VADisplayAttribOutOfLoopDeblock */
1703 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
1704 #define VA_OOL_DEBLOCKING_TRUE  0x00000001
1705
1706
1707 /* Currently defined display attribute types */
1708 typedef enum
1709 {
1710     VADisplayAttribBrightness           = 0,
1711     VADisplayAttribContrast             = 1,
1712     VADisplayAttribHue                  = 2,
1713     VADisplayAttribSaturation           = 3,
1714     /* client can specifiy a background color for the target window */
1715     VADisplayAttribBackgroundColor      = 4,
1716     /*
1717      * this is a gettable only attribute. For some implementations that use the
1718      * hardware overlay, after PutSurface is called, the surface can not be
1719      * re-used until after the subsequent PutSurface call. If this is the case
1720      * then the value for this attribute will be set to 1 so that the client
1721      * will not attempt to re-use the surface right after returning from a call
1722      * to PutSurface.
1723      */
1724     VADisplayAttribDirectSurface       = 5,
1725     VADisplayAttribRotation            = 6,
1726     VADisplayAttribOutofLoopDeblock    = 7,
1727
1728     /* PowerVR IEP Lite specific attributes */
1729     VADisplayAttribBLEBlackMode        = 8,
1730     VADisplayAttribBLEWhiteMode        = 9,
1731     VADisplayAttribBlueStretch         = 10,
1732     VADisplayAttribSkinColorCorrection = 11,
1733     VADisplayAttribCSCInputColorFormat = 12,
1734     VADisplayAttribCSCHue              = 13,
1735     VADisplayAttribCSCSaturation       = 14,
1736     VADisplayAttribCSCBrightness       = 15,
1737     VADisplayAttribCSCContrast         = 16,
1738 } VADisplayAttribType;
1739
1740 /* flags for VADisplayAttribute */
1741 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
1742 #define VA_DISPLAY_ATTRIB_GETTABLE      0x0001
1743 #define VA_DISPLAY_ATTRIB_SETTABLE      0x0002
1744
1745 typedef struct _VADisplayAttribute
1746 {
1747     VADisplayAttribType type;
1748     int min_value;
1749     int max_value;
1750     int value;  /* used by the set/get attribute functions */
1751 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
1752     unsigned int flags;
1753 } VADisplayAttribute;
1754
1755 /* Get maximum number of display attributs supported by the implementation */
1756 int vaMaxNumDisplayAttributes (
1757     VADisplay dpy
1758 );
1759
1760 /*
1761  * Query display attributes
1762  * The caller must provide a "attr_list" array that can hold at
1763  * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
1764  * returned in "attr_list" is returned in "num_attributes".
1765  */
1766 VAStatus vaQueryDisplayAttributes (
1767     VADisplay dpy,
1768     VADisplayAttribute *attr_list,      /* out */
1769     int *num_attributes                 /* out */
1770 );
1771
1772 /*
1773  * Get display attributes
1774  * This function returns the current attribute values in "attr_list".
1775  * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
1776  * from vaQueryDisplayAttributes() can have their values retrieved.
1777  */
1778 VAStatus vaGetDisplayAttributes (
1779     VADisplay dpy,
1780     VADisplayAttribute *attr_list,      /* in/out */
1781     int num_attributes
1782 );
1783
1784 /*
1785  * Set display attributes
1786  * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
1787  * from vaQueryDisplayAttributes() can be set.  If the attribute is not settable or
1788  * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
1789  */
1790 VAStatus vaSetDisplayAttributes (
1791     VADisplay dpy,
1792     VADisplayAttribute *attr_list,
1793     int num_attributes
1794 );
1795
1796 #ifdef __cplusplus
1797 }
1798 #endif
1799
1800 #endif /* _VA_H_ */