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