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