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     VABufferID coded_buf;
 550 } VAEncPictureParameterBufferJPEG;
 551
 552
 553 /****************************
 554  * MPEG-2 data structures
 555  ****************************/
 556
 557 /* MPEG-2 Picture Parameter Buffer */
 558 /*
 559  * For each frame or field, and before any slice data, a single
 560  * picture parameter buffer must be send.
 561  */
 562 typedef struct _VAPictureParameterBufferMPEG2
 563 {
 564     unsigned short horizontal_size;
 565     unsigned short vertical_size;
 566     VASurfaceID forward_reference_picture;
 567     VASurfaceID backward_reference_picture;
 568     /* meanings of the following fields are the same as in the standard */
 569     int picture_coding_type;
 570     int f_code; /* pack all four fcode into this */
 571     union {
 572         struct {
 573             unsigned int intra_dc_precision             : 2;
 574             unsigned int picture_structure              : 2;
 575             unsigned int top_field_first                : 1;
 576             unsigned int frame_pred_frame_dct           : 1;
 577             unsigned int concealment_motion_vectors     : 1;
 578             unsigned int q_scale_type                   : 1;
 579             unsigned int intra_vlc_format               : 1;
 580             unsigned int alternate_scan                 : 1;
 581             unsigned int repeat_first_field             : 1;
 582             unsigned int progressive_frame              : 1;
 583             unsigned int is_first_field                 : 1; /* indicate whether the current field
 584                                                               * is the first field for field picture
 585                                                               */
 586         } bits;
 587         unsigned int value;
 588     } picture_coding_extension;
 589 } VAPictureParameterBufferMPEG2;
 590
 591 /* MPEG-2 Inverse Quantization Matrix Buffer */
 592 typedef struct _VAIQMatrixBufferMPEG2
 593 {
 594     int load_intra_quantiser_matrix;
 595     int load_non_intra_quantiser_matrix;
 596     int load_chroma_intra_quantiser_matrix;
 597     int load_chroma_non_intra_quantiser_matrix;
 598     unsigned char intra_quantiser_matrix[64];
 599     unsigned char non_intra_quantiser_matrix[64];
 600     unsigned char chroma_intra_quantiser_matrix[64];
 601     unsigned char chroma_non_intra_quantiser_matrix[64];
 602 } VAIQMatrixBufferMPEG2;
 603
 604 /* MPEG-2 Slice Parameter Buffer */
 605 typedef struct _VASliceParameterBufferMPEG2
 606 {
 607     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 608     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 609     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 610     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 611     unsigned int slice_horizontal_position;
 612     unsigned int slice_vertical_position;
 613     int quantiser_scale_code;
 614     int intra_slice_flag;
 615 } VASliceParameterBufferMPEG2;
 616
 617 /* MPEG-2 Macroblock Parameter Buffer */
 618 typedef struct _VAMacroblockParameterBufferMPEG2
 619 {
 620     unsigned short macroblock_address;
 621     /*
 622      * macroblock_address (in raster scan order)
 623      * top-left: 0
 624      * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
 625      */
 626     unsigned char macroblock_type;  /* see definition below */
 627     union {
 628         struct {
 629             unsigned int frame_motion_type              : 2;
 630             unsigned int field_motion_type              : 2;
 631             unsigned int dct_type                       : 1;
 632         } bits;
 633         unsigned int value;
 634     } macroblock_modes;
 635     unsigned char motion_vertical_field_select;
 636     /*
 637      * motion_vertical_field_select:
 638      * see section 6.3.17.2 in the spec
 639      * only the lower 4 bits are used
 640      * bit 0: first vector forward
 641      * bit 1: first vector backward
 642      * bit 2: second vector forward
 643      * bit 3: second vector backward
 644      */
 645     short PMV[2][2][2]; /* see Table 7-7 in the spec */
 646     unsigned short coded_block_pattern;
 647     /*
 648      * The bitplanes for coded_block_pattern are described
 649      * in Figure 6.10-12 in the spec
 650      */
 651
 652     /* Number of skipped macroblocks after this macroblock */
 653     unsigned short num_skipped_macroblocks;
 654 } VAMacroblockParameterBufferMPEG2;
 655
 656 /*
 657  * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
 658  */
 659 #define VA_MB_TYPE_MOTION_FORWARD       0x02
 660 #define VA_MB_TYPE_MOTION_BACKWARD      0x04
 661 #define VA_MB_TYPE_MOTION_PATTERN       0x08
 662 #define VA_MB_TYPE_MOTION_INTRA         0x10
 663
 664 /*
 665  * MPEG-2 Residual Data Buffer
 666  * For each macroblock, there wil be 64 shorts (16-bit) in the
 667  * residual data buffer
 668  */
 669
 670 /****************************
 671  * MPEG-4 Part 2 data structures
 672  ****************************/
 673
 674 /* MPEG-4 Picture Parameter Buffer */
 675 /*
 676  * For each frame or field, and before any slice data, a single
 677  * picture parameter buffer must be send.
 678  */
 679 typedef struct _VAPictureParameterBufferMPEG4
 680 {
 681     unsigned short vop_width;
 682     unsigned short vop_height;
 683     VASurfaceID forward_reference_picture;
 684     VASurfaceID backward_reference_picture;
 685     union {
 686         struct {
 687             unsigned int short_video_header             : 1;
 688             unsigned int chroma_format                  : 2;
 689             unsigned int interlaced                     : 1;
 690             unsigned int obmc_disable                   : 1;
 691             unsigned int sprite_enable                  : 2;
 692             unsigned int sprite_warping_accuracy        : 2;
 693             unsigned int quant_type                     : 1;
 694             unsigned int quarter_sample                 : 1;
 695             unsigned int data_partitioned               : 1;
 696             unsigned int reversible_vlc                 : 1;
 697             unsigned int resync_marker_disable          : 1;
 698         } bits;
 699         unsigned int value;
 700     } vol_fields;
 701     unsigned char no_of_sprite_warping_points;
 702     short sprite_trajectory_du[3];
 703     short sprite_trajectory_dv[3];
 704     unsigned char quant_precision;
 705     union {
 706         struct {
 707             unsigned int vop_coding_type                : 2;
 708             unsigned int backward_reference_vop_coding_type     : 2;
 709             unsigned int vop_rounding_type              : 1;
 710             unsigned int intra_dc_vlc_thr               : 3;
 711             unsigned int top_field_first                : 1;
 712             unsigned int alternate_vertical_scan_flag   : 1;
 713         } bits;
 714         unsigned int value;
 715     } vop_fields;
 716     unsigned char vop_fcode_forward;
 717     unsigned char vop_fcode_backward;
 718     unsigned short vop_time_increment_resolution;
 719     /* short header related */
 720     unsigned char num_gobs_in_vop;
 721     unsigned char num_macroblocks_in_gob;
 722     /* for direct mode prediction */
 723     short TRB;
 724     short TRD;
 725 } VAPictureParameterBufferMPEG4;
 726
 727 /* MPEG-4 Inverse Quantization Matrix Buffer */
 728 typedef struct _VAIQMatrixBufferMPEG4
 729 {
 730     int load_intra_quant_mat;
 731     int load_non_intra_quant_mat;
 732     unsigned char intra_quant_mat[64];
 733     unsigned char non_intra_quant_mat[64];
 734 } VAIQMatrixBufferMPEG4;
 735
 736 /* MPEG-4 Slice Parameter Buffer */
 737 typedef struct _VASliceParameterBufferMPEG4
 738 {
 739     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 740     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 741     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 742     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 743     unsigned int macroblock_number;
 744     int quant_scale;
 745 } VASliceParameterBufferMPEG4;
 746
 747 /*
 748  VC-1 data structures
 749 */
 750
 751 typedef enum   /* see 7.1.1.32 */
 752 {
 753     VAMvMode1Mv                        = 0,
 754     VAMvMode1MvHalfPel                 = 1,
 755     VAMvMode1MvHalfPelBilinear         = 2,
 756     VAMvModeMixedMv                    = 3,
 757     VAMvModeIntensityCompensation      = 4
 758 } VAMvModeVC1;
 759
 760 /* VC-1 Picture Parameter Buffer */
 761 /*
 762  * For each picture, and before any slice data, a picture parameter
 763  * buffer must be send. Multiple picture parameter buffers may be
 764  * sent for a single picture. In that case picture parameters will
 765  * apply to all slice data that follow it until a new picture
 766  * parameter buffer is sent.
 767  *
 768  * Notes:
 769  *   pic_quantizer_type should be set to the applicable quantizer
 770  *   type as defined by QUANTIZER (J.1.19) and either
 771  *   PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
 772  */
 773 typedef struct _VAPictureParameterBufferVC1
 774 {
 775     VASurfaceID forward_reference_picture;
 776     VASurfaceID backward_reference_picture;
 777     /* if out-of-loop post-processing is done on the render
 778        target, then we need to keep the in-loop decoded
 779        picture as a reference picture */
 780     VASurfaceID inloop_decoded_picture;
 781
 782     /* sequence layer for AP or meta data for SP and MP */
 783     union {
 784         struct {
 785             unsigned int pulldown       : 1; /* SEQUENCE_LAYER::PULLDOWN */
 786             unsigned int interlace      : 1; /* SEQUENCE_LAYER::INTERLACE */
 787             unsigned int tfcntrflag     : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
 788             unsigned int finterpflag    : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
 789             unsigned int psf            : 1; /* SEQUENCE_LAYER::PSF */
 790             unsigned int multires       : 1; /* METADATA::MULTIRES */
 791             unsigned int overlap        : 1; /* METADATA::OVERLAP */
 792             unsigned int syncmarker     : 1; /* METADATA::SYNCMARKER */
 793             unsigned int rangered       : 1; /* METADATA::RANGERED */
 794             unsigned int max_b_frames   : 3; /* METADATA::MAXBFRAMES */
 795         } bits;
 796         unsigned int value;
 797     } sequence_fields;
 798
 799     unsigned short coded_width;         /* ENTRY_POINT_LAYER::CODED_WIDTH */
 800     unsigned short coded_height;        /* ENTRY_POINT_LAYER::CODED_HEIGHT */
 801     union {
 802         struct {
 803             unsigned int broken_link    : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
 804             unsigned int closed_entry   : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
 805             unsigned int panscan_flag   : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
 806             unsigned int loopfilter     : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
 807         } bits;
 808         unsigned int value;
 809     } entrypoint_fields;
 810     unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
 811     unsigned char fast_uvmc_flag;       /* ENTRY_POINT_LAYER::FASTUVMC */
 812     union {
 813         struct {
 814             unsigned int luma_flag      : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
 815             unsigned int luma           : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
 816             unsigned int chroma_flag    : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
 817             unsigned int chroma         : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
 818         } bits;
 819         unsigned int value;
 820     } range_mapping_fields;
 821
 822     unsigned char b_picture_fraction;   /* PICTURE_LAYER::BFRACTION */
 823     unsigned char cbp_table;            /* PICTURE_LAYER::CBPTAB/ICBPTAB */
 824     unsigned char mb_mode_table;        /* PICTURE_LAYER::MBMODETAB */
 825     unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
 826     unsigned char rounding_control;     /* PICTURE_LAYER::RNDCTRL */
 827     unsigned char post_processing;      /* PICTURE_LAYER::POSTPROC */
 828     unsigned char picture_resolution_index;     /* PICTURE_LAYER::RESPIC */
 829     unsigned char luma_scale;           /* PICTURE_LAYER::LUMSCALE */
 830     unsigned char luma_shift;           /* PICTURE_LAYER::LUMSHIFT */
 831     union {
 832         struct {
 833             unsigned int picture_type           : 3; /* PICTURE_LAYER::PTYPE */
 834             unsigned int frame_coding_mode      : 3; /* PICTURE_LAYER::FCM */
 835             unsigned int top_field_first        : 1; /* PICTURE_LAYER::TFF */
 836             unsigned int is_first_field         : 1; /* set to 1 if it is the first field */
 837             unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
 838         } bits;
 839         unsigned int value;
 840     } picture_fields;
 841     union {
 842         struct {
 843             unsigned int mv_type_mb     : 1;    /* PICTURE::MVTYPEMB */
 844             unsigned int direct_mb      : 1;    /* PICTURE::DIRECTMB */
 845             unsigned int skip_mb        : 1;    /* PICTURE::SKIPMB */
 846             unsigned int field_tx       : 1;    /* PICTURE::FIELDTX */
 847             unsigned int forward_mb     : 1;    /* PICTURE::FORWARDMB */
 848             unsigned int ac_pred        : 1;    /* PICTURE::ACPRED */
 849             unsigned int overflags      : 1;    /* PICTURE::OVERFLAGS */
 850         } flags;
 851         unsigned int value;
 852     } raw_coding;
 853     union {
 854         struct {
 855             unsigned int bp_mv_type_mb   : 1;    /* PICTURE::MVTYPEMB */
 856             unsigned int bp_direct_mb    : 1;    /* PICTURE::DIRECTMB */
 857             unsigned int bp_skip_mb      : 1;    /* PICTURE::SKIPMB */
 858             unsigned int bp_field_tx     : 1;    /* PICTURE::FIELDTX */
 859             unsigned int bp_forward_mb   : 1;    /* PICTURE::FORWARDMB */
 860             unsigned int bp_ac_pred      : 1;    /* PICTURE::ACPRED */
 861             unsigned int bp_overflags    : 1;    /* PICTURE::OVERFLAGS */
 862         } flags;
 863         unsigned int value;
 864     } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
 865     union {
 866         struct {
 867             unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
 868             unsigned int reference_distance     : 5;/* PICTURE_LAYER::REFDIST */
 869             unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
 870             unsigned int reference_field_pic_indicator  : 1;/* PICTURE_LAYER::REFFIELD */
 871         } bits;
 872         unsigned int value;
 873     } reference_fields;
 874     union {
 875         struct {
 876             unsigned int mv_mode                : 3; /* PICTURE_LAYER::MVMODE */
 877             unsigned int mv_mode2               : 3; /* PICTURE_LAYER::MVMODE2 */
 878             unsigned int mv_table               : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
 879             unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
 880             unsigned int four_mv_switch         : 1; /* PICTURE_LAYER::4MVSWITCH */
 881             unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
 882             unsigned int extended_mv_flag       : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
 883             unsigned int extended_mv_range      : 2; /* PICTURE_LAYER::MVRANGE */
 884             unsigned int extended_dmv_flag      : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
 885             unsigned int extended_dmv_range     : 2; /* PICTURE_LAYER::DMVRANGE */
 886         } bits;
 887         unsigned int value;
 888     } mv_fields;
 889     union {
 890         struct {
 891             unsigned int dquant : 2;    /* ENTRY_POINT_LAYER::DQUANT */
 892             unsigned int quantizer     : 2;     /* ENTRY_POINT_LAYER::QUANTIZER */
 893             unsigned int half_qp        : 1;    /* PICTURE_LAYER::HALFQP */
 894             unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
 895             unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
 896             unsigned int dq_frame       : 1;    /* VOPDQUANT::DQUANTFRM */
 897             unsigned int dq_profile     : 2;    /* VOPDQUANT::DQPROFILE */
 898             unsigned int dq_sb_edge     : 2;    /* VOPDQUANT::DQSBEDGE */
 899             unsigned int dq_db_edge     : 2;    /* VOPDQUANT::DQDBEDGE */
 900             unsigned int dq_binary_level : 1;   /* VOPDQUANT::DQBILEVEL */
 901             unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
 902         } bits;
 903         unsigned int value;
 904     } pic_quantizer_fields;
 905     union {
 906         struct {
 907             unsigned int variable_sized_transform_flag  : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
 908             unsigned int mb_level_transform_type_flag   : 1;/* PICTURE_LAYER::TTMBF */
 909             unsigned int frame_level_transform_type     : 2;/* PICTURE_LAYER::TTFRM */
 910             unsigned int transform_ac_codingset_idx1    : 2;/* PICTURE_LAYER::TRANSACFRM */
 911             unsigned int transform_ac_codingset_idx2    : 2;/* PICTURE_LAYER::TRANSACFRM2 */
 912             unsigned int intra_transform_dc_table       : 1;/* PICTURE_LAYER::TRANSDCTAB */
 913         } bits;
 914         unsigned int value;
 915     } transform_fields;
 916 } VAPictureParameterBufferVC1;
 917
 918 /* VC-1 Bitplane Buffer
 919 There will be at most three bitplanes coded in any picture header. To send
 920 the bitplane data more efficiently, each byte is divided in two nibbles, with
 921 each nibble carrying three bitplanes for one macroblock.  The following table
 922 shows the bitplane data arrangement within each nibble based on the picture
 923 type.
 924
 925 Picture Type    Bit3            Bit2            Bit1            Bit0
 926 I or BI                         OVERFLAGS       ACPRED          FIELDTX
 927 P                               MYTYPEMB        SKIPMB          DIRECTMB
 928 B                               FORWARDMB       SKIPMB          DIRECTMB
 929
 930 Within each byte, the lower nibble is for the first MB and the upper nibble is
 931 for the second MB.  E.g. the lower nibble of the first byte in the bitplane
 932 buffer is for Macroblock #1 and the upper nibble of the first byte is for
 933 Macroblock #2 in the first row.
 934 */
 935
 936 /* VC-1 Slice Parameter Buffer */
 937 typedef struct _VASliceParameterBufferVC1
 938 {
 939     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 940     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 941     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 942     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 943     unsigned int slice_vertical_position;
 944 } VASliceParameterBufferVC1;
 945
 946 /* VC-1 Slice Data Buffer */
 947 /*
 948 This is simplely a buffer containing raw bit-stream bytes
 949 */
 950
 951 /****************************
 952  * H.264/AVC data structures
 953  ****************************/
 954
 955 typedef struct _VAPictureH264
 956 {
 957     VASurfaceID picture_id;
 958     unsigned int frame_idx;
 959     unsigned int flags;
 960     unsigned int TopFieldOrderCnt;
 961     unsigned int BottomFieldOrderCnt;
 962 } VAPictureH264;
 963 /* flags in VAPictureH264 could be OR of the following */
 964 #define VA_PICTURE_H264_INVALID                 0x00000001
 965 #define VA_PICTURE_H264_TOP_FIELD               0x00000002
 966 #define VA_PICTURE_H264_BOTTOM_FIELD            0x00000004
 967 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE    0x00000008
 968 #define VA_PICTURE_H264_LONG_TERM_REFERENCE     0x00000010
 969
 970 /* H.264 Picture Parameter Buffer */
 971 /*
 972  * For each picture, and before any slice data, a single
 973  * picture parameter buffer must be send.
 974  */
 975 typedef struct _VAPictureParameterBufferH264
 976 {
 977     VAPictureH264 CurrPic;
 978     VAPictureH264 ReferenceFrames[16];  /* in DPB */
 979     unsigned short picture_width_in_mbs_minus1;
 980     unsigned short picture_height_in_mbs_minus1;
 981     unsigned char bit_depth_luma_minus8;
 982     unsigned char bit_depth_chroma_minus8;
 983     unsigned char num_ref_frames;
 984     union {
 985         struct {
 986             unsigned int chroma_format_idc                      : 2;
 987             unsigned int residual_colour_transform_flag         : 1;
 988             unsigned int gaps_in_frame_num_value_allowed_flag   : 1;
 989             unsigned int frame_mbs_only_flag                    : 1;
 990             unsigned int mb_adaptive_frame_field_flag           : 1;
 991             unsigned int direct_8x8_inference_flag              : 1;
 992             unsigned int MinLumaBiPredSize8x8                   : 1; /* see A.3.3.2 */
 993             unsigned int log2_max_frame_num_minus4              : 4;
 994             unsigned int pic_order_cnt_type                     : 2;
 995             unsigned int log2_max_pic_order_cnt_lsb_minus4      : 4;
 996             unsigned int delta_pic_order_always_zero_flag       : 1;
 997         } bits;
 998         unsigned int value;
 999     } seq_fields;
1000     unsigned char num_slice_groups_minus1;
1001     unsigned char slice_group_map_type;
1002     unsigned short slice_group_change_rate_minus1;
1003     signed char pic_init_qp_minus26;
1004     signed char pic_init_qs_minus26;
1005     signed char chroma_qp_index_offset;
1006     signed char second_chroma_qp_index_offset;
1007     union {
1008         struct {
1009             unsigned int entropy_coding_mode_flag       : 1;
1010             unsigned int weighted_pred_flag             : 1;
1011             unsigned int weighted_bipred_idc            : 2;
1012             unsigned int transform_8x8_mode_flag        : 1;
1013             unsigned int field_pic_flag                 : 1;
1014             unsigned int constrained_intra_pred_flag    : 1;
1015             unsigned int pic_order_present_flag                 : 1;
1016             unsigned int deblocking_filter_control_present_flag : 1;
1017             unsigned int redundant_pic_cnt_present_flag         : 1;
1018             unsigned int reference_pic_flag                     : 1; /* nal_ref_idc != 0 */
1019         } bits;
1020         unsigned int value;
1021     } pic_fields;
1022     unsigned short frame_num;
1023 } VAPictureParameterBufferH264;
1024
1025 /* H.264 Inverse Quantization Matrix Buffer */
1026 typedef struct _VAIQMatrixBufferH264
1027 {
1028     unsigned char ScalingList4x4[6][16];
1029     unsigned char ScalingList8x8[2][64];
1030 } VAIQMatrixBufferH264;
1031
1032 /*
1033  * H.264 Slice Group Map Buffer
1034  * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1035  * A slice group map buffer should be sent for each picture if required. The buffer
1036  * is sent only when there is a change in the mapping values.
1037  * The slice group map buffer map "map units" to slice groups as specified in
1038  * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1039  * in raster scan order
1040  */
1041
1042 /* H.264 Slice Parameter Buffer */
1043 typedef struct _VASliceParameterBufferH264
1044 {
1045     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1046     unsigned int slice_data_offset;/* the offset to the NAL start code for this slice */
1047     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1048     unsigned short slice_data_bit_offset; /* bit offset from NAL start code to the beginning of slice data */
1049     unsigned short first_mb_in_slice;
1050     unsigned char slice_type;
1051     unsigned char direct_spatial_mv_pred_flag;
1052     unsigned char num_ref_idx_l0_active_minus1;
1053     unsigned char num_ref_idx_l1_active_minus1;
1054     unsigned char cabac_init_idc;
1055     char slice_qp_delta;
1056     unsigned char disable_deblocking_filter_idc;
1057     char slice_alpha_c0_offset_div2;
1058     char slice_beta_offset_div2;
1059     VAPictureH264 RefPicList0[32];      /* See 8.2.4.2 */
1060     VAPictureH264 RefPicList1[32];      /* See 8.2.4.2 */
1061     unsigned char luma_log2_weight_denom;
1062     unsigned char chroma_log2_weight_denom;
1063     unsigned char luma_weight_l0_flag;
1064     short luma_weight_l0[32];
1065     short luma_offset_l0[32];
1066     unsigned char chroma_weight_l0_flag;
1067     short chroma_weight_l0[32][2];
1068     short chroma_offset_l0[32][2];
1069     unsigned char luma_weight_l1_flag;
1070     short luma_weight_l1[32];
1071     short luma_offset_l1[32];
1072     unsigned char chroma_weight_l1_flag;
1073     short chroma_weight_l1[32][2];
1074     short chroma_offset_l1[32][2];
1075 } VASliceParameterBufferH264;
1076
1077 /****************************
1078  * Common encode data structures
1079  ****************************/
1080 typedef enum
1081 {
1082     VAEncPictureTypeIntra               = 0,
1083     VAEncPictureTypePredictive          = 1,
1084     VAEncPictureTypeBidirectional       = 2,
1085 } VAEncPictureType;
1086
1087 /* Encode Slice Parameter Buffer */
1088 typedef struct _VAEncSliceParameterBuffer
1089 {
1090     unsigned int start_row_number;      /* starting MB row number for this slice */
1091     unsigned int slice_height;  /* slice height measured in MB */
1092     union {
1093         struct {
1094             unsigned int is_intra       : 1;
1095             unsigned int disable_deblocking_filter_idc : 2;
1096         } bits;
1097         unsigned int value;
1098     } slice_flags;
1099 } VAEncSliceParameterBuffer;
1100
1101 /****************************
1102  * H.264 specific encode data structures
1103  ****************************/
1104
1105 typedef struct _VAEncSequenceParameterBufferH264
1106 {
1107     unsigned char seq_parameter_set_id;
1108     unsigned char level_idc;
1109     unsigned int intra_period;
1110     unsigned int picture_width_in_mbs;
1111     unsigned int picture_height_in_mbs;
1112     unsigned int bits_per_second;
1113     unsigned int frame_rate;
1114     unsigned int initial_qp;
1115     unsigned int min_qp;
1116     unsigned int basic_unit_size;
1117     unsigned char vui_flag;
1118 } VAEncSequenceParameterBufferH264;
1119
1120 typedef struct _VAEncPictureParameterBufferH264
1121 {
1122     VASurfaceID reference_picture;
1123     VASurfaceID reconstructed_picture;
1124     VABufferID coded_buf;
1125     unsigned short picture_width;
1126     unsigned short picture_height;
1127     unsigned char last_picture; /* if set to 1 it indicates the last picture in the sequence */
1128 } VAEncPictureParameterBufferH264;
1129
1130 /****************************
1131  * H.263 specific encode data structures
1132  ****************************/
1133
1134 typedef struct _VAEncSequenceParameterBufferH263
1135 {
1136     unsigned int intra_period;
1137     unsigned int bits_per_second;
1138     unsigned int frame_rate;
1139     unsigned int initial_qp;
1140     unsigned int min_qp;
1141 } VAEncSequenceParameterBufferH263;
1142
1143 typedef struct _VAEncPictureParameterBufferH263
1144 {
1145     VASurfaceID reference_picture;
1146     VASurfaceID reconstructed_picture;
1147     VABufferID coded_buf;
1148     unsigned short picture_width;
1149     unsigned short picture_height;
1150     VAEncPictureType picture_type;
1151 } VAEncPictureParameterBufferH263;
1152
1153 /****************************
1154  * MPEG-4 specific encode data structures
1155  ****************************/
1156
1157 typedef struct _VAEncSequenceParameterBufferMPEG4
1158 {
1159     unsigned char profile_and_level_indication;
1160     unsigned int intra_period;
1161     unsigned int video_object_layer_width;
1162     unsigned int video_object_layer_height;
1163     unsigned int vop_time_increment_resolution;
1164     unsigned int fixed_vop_rate;
1165     unsigned int fixed_vop_time_increment;
1166     unsigned int bits_per_second;
1167     unsigned int frame_rate;
1168     unsigned int initial_qp;
1169     unsigned int min_qp;
1170 } VAEncSequenceParameterBufferMPEG4;
1171
1172 typedef struct _VAEncPictureParameterBufferMPEG4
1173 {
1174     VASurfaceID reference_picture;
1175     VASurfaceID reconstructed_picture;
1176     VABufferID coded_buf;
1177     unsigned short picture_width;
1178     unsigned short picture_height;
1179     unsigned int modulo_time_base; /* number of 1s */
1180     unsigned int vop_time_increment;
1181     VAEncPictureType picture_type;
1182 } VAEncPictureParameterBufferMPEG4;
1183
1184
1185
1186 /* Buffer functions */
1187
1188 /*
1189  * Creates a buffer for "num_elements" elements of "size" bytes and
1190  * initalize with "data".
1191  * if "data" is null, then the contents of the buffer data store
1192  * are undefined.
1193  * Basically there are two ways to get buffer data to the server side. One is
1194  * to call vaCreateBuffer() with a non-null "data", which results the data being
1195  * copied to the data store on the server side.  A different method that
1196  * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1197  * and then use vaMapBuffer() to map the data store from the server side to the
1198  * client address space for access.
1199  *  Note: image buffers are created by the library, not the client. Please see
1200  *        vaCreateImage on how image buffers are managed.
1201  */
1202 VAStatus vaCreateBuffer (
1203     VADisplay dpy,
1204     VAContextID context,
1205     VABufferType type,  /* in */
1206     unsigned int size,  /* in */
1207     unsigned int num_elements, /* in */
1208     void *data,         /* in */
1209     VABufferID *buf_id  /* out */
1210 );
1211
1212 /*
1213  * Convey to the server how many valid elements are in the buffer.
1214  * e.g. if multiple slice parameters are being held in a single buffer,
1215  * this will communicate to the server the number of slice parameters
1216  * that are valid in the buffer.
1217  */
1218 VAStatus vaBufferSetNumElements (
1219     VADisplay dpy,
1220     VABufferID buf_id,  /* in */
1221     unsigned int num_elements /* in */
1222 );
1223
1224
1225 /*
1226  * device independent data structure for codedbuffer
1227  */
1228 typedef  struct _VACodedBufferSegment {
1229     unsigned int size; /* size of the data buffer in the coded buffer segment, in bytes */
1230     unsigned int bit_offset;/* bit offset into the data buffer where valid bitstream data begins */
1231     void *buf; /* pointer to the beginning of the data buffer in the coded buffer segment */
1232     void *next; /* pointer to the next VACodedBufferSegment */
1233 } VACodedBufferSegment;
1234
1235 /*
1236  * Map data store of the buffer into the client's address space
1237  * vaCreateBuffer() needs to be called with "data" set to NULL before
1238  * calling vaMapBuffer()
1239  *
1240  * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1241  * VACodedBufferSegment, and the list is terminated if "next" is NULL
1242  */
1243 VAStatus vaMapBuffer (
1244     VADisplay dpy,
1245     VABufferID buf_id,  /* in */
1246     void **pbuf         /* out */
1247 );
1248
1249 /*
1250  * After client making changes to a mapped data store, it needs to
1251  * "Unmap" it to let the server know that the data is ready to be
1252  * consumed by the server
1253  */
1254 VAStatus vaUnmapBuffer (
1255     VADisplay dpy,
1256     VABufferID buf_id   /* in */
1257 );
1258
1259 /*
1260  * After this call, the buffer is deleted and this buffer_id is no longer valid
1261  * Only call this if the buffer is not going to be passed to vaRenderBuffer
1262  */
1263 VAStatus vaDestroyBuffer (
1264     VADisplay dpy,
1265     VABufferID buffer_id
1266 );
1267
1268 /*
1269 Render (Decode) Pictures
1270
1271 A picture represents either a frame or a field.
1272
1273 The Begin/Render/End sequence sends the decode buffers to the server
1274 */
1275
1276 /*
1277  * Get ready to decode a picture to a target surface
1278  */
1279 VAStatus vaBeginPicture (
1280     VADisplay dpy,
1281     VAContextID context,
1282     VASurfaceID render_target
1283 );
1284
1285 /*
1286  * Send decode buffers to the server.
1287  * Buffers are automatically destroyed afterwards
1288  */
1289 VAStatus vaRenderPicture (
1290     VADisplay dpy,
1291     VAContextID context,
1292     VABufferID *buffers,
1293     int num_buffers
1294 );
1295
1296 /*
1297  * Make the end of rendering for a picture.
1298  * The server should start processing all pending operations for this
1299  * surface. This call is non-blocking. The client can start another
1300  * Begin/Render/End sequence on a different render target.
1301  */
1302 VAStatus vaEndPicture (
1303     VADisplay dpy,
1304     VAContextID context
1305 );
1306
1307 /*
1308
1309 Synchronization
1310
1311 */
1312
1313 /*
1314  * This function blocks until all pending operations on the render target
1315  * have been completed.  Upon return it is safe to use the render target for a
1316  * different picture.
1317  */
1318 VAStatus vaSyncSurface (
1319     VADisplay dpy,
1320     VASurfaceID render_target
1321 );
1322
1323 typedef enum
1324 {
1325     VASurfaceRendering  = 1, /* Rendering in progress */
1326     VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1327                              /* this status is useful if surface is used as the source */
1328                              /* of an overlay */
1329     VASurfaceReady      = 4, /* not being rendered or displayed */
1330     VASurfaceSkipped    = 8  /* Indicate a skipped frame during encode */
1331 } VASurfaceStatus;
1332
1333 /*
1334  * Find out any pending ops on the render target
1335  */
1336 VAStatus vaQuerySurfaceStatus (
1337     VADisplay dpy,
1338     VASurfaceID render_target,
1339     VASurfaceStatus *status     /* out */
1340 );
1341
1342 /*
1343  * Images and Subpictures
1344  * VAImage is used to either get the surface data to client memory, or
1345  * to copy image data in client memory to a surface.
1346  * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1347  * is at the upper left corner with positive X to the right and positive Y down
1348  */
1349 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1350     ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1351     ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1352
1353 /* a few common FourCCs */
1354 #define VA_FOURCC_NV12          0x3231564E
1355 #define VA_FOURCC_AI44          0x34344149
1356 #define VA_FOURCC_RGBA          0x41424752
1357 #define VA_FOURCC_UYVY          0x59565955
1358 #define VA_FOURCC_YUY2          0x32595559
1359 #define VA_FOURCC_AYUV          0x56555941
1360 #define VA_FOURCC_NV11          0x3131564e
1361 #define VA_FOURCC_YV12          0x32315659
1362 #define VA_FOURCC_P208          0x38303250
1363 #define VA_FOURCC_IYUV          0x56555949
1364
1365 /* byte order */
1366 #define VA_LSB_FIRST            1
1367 #define VA_MSB_FIRST            2
1368
1369 typedef struct _VAImageFormat
1370 {
1371     unsigned int        fourcc;
1372     unsigned int        byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1373     unsigned int        bits_per_pixel;
1374     /* for RGB formats */
1375     unsigned int        depth; /* significant bits per pixel */
1376     unsigned int        red_mask;
1377     unsigned int        green_mask;
1378     unsigned int        blue_mask;
1379     unsigned int        alpha_mask;
1380 } VAImageFormat;
1381
1382 typedef VAGenericID VAImageID;
1383
1384 typedef struct _VAImage
1385 {
1386     VAImageID           image_id; /* uniquely identify this image */
1387     VAImageFormat       format;
1388     VABufferID          buf;    /* image data buffer */
1389     /*
1390      * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1391      * data store on the server side for optimal performance. The buffer will be
1392      * created by the CreateImage function, and proper storage allocated based on the image
1393      * size and format. This buffer is managed by the library implementation, and
1394      * accessed by the client through the buffer Map/Unmap functions.
1395      */
1396     unsigned short      width;
1397     unsigned short      height;
1398     unsigned int        data_size;
1399     unsigned int        num_planes;     /* can not be greater than 3 */
1400     /*
1401      * An array indicating the scanline pitch in bytes for each plane.
1402      * Each plane may have a different pitch. Maximum 3 planes for planar formats
1403      */
1404     unsigned int        pitches[3];
1405     /*
1406      * An array indicating the byte offset from the beginning of the image data
1407      * to the start of each plane.
1408      */
1409     unsigned int        offsets[3];
1410
1411     /* The following fields are only needed for paletted formats */
1412     int num_palette_entries;   /* set to zero for non-palette images */
1413     /*
1414      * Each component is one byte and entry_bytes indicates the number of components in
1415      * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1416      */
1417     int entry_bytes;
1418     /*
1419      * An array of ascii characters describing the order of the components within the bytes.
1420      * Only entry_bytes characters of the string are used.
1421      */
1422     char component_order[4];
1423 } VAImage;
1424
1425 /* Get maximum number of image formats supported by the implementation */
1426 int vaMaxNumImageFormats (
1427     VADisplay dpy
1428 );
1429
1430 /*
1431  * Query supported image formats
1432  * The caller must provide a "format_list" array that can hold at
1433  * least vaMaxNumImageFormats() entries. The actual number of formats
1434  * returned in "format_list" is returned in "num_formats".
1435  */
1436 VAStatus vaQueryImageFormats (
1437     VADisplay dpy,
1438     VAImageFormat *format_list, /* out */
1439     int *num_formats            /* out */
1440 );
1441
1442 /*
1443  * Create a VAImage structure
1444  * The width and height fields returned in the VAImage structure may get
1445  * enlarged for some YUV formats. Upon return from this function,
1446  * image->buf has been created and proper storage allocated by the library.
1447  * The client can access the image through the Map/Unmap calls.
1448  */
1449 VAStatus vaCreateImage (
1450     VADisplay dpy,
1451     VAImageFormat *format,
1452     int width,
1453     int height,
1454     VAImage *image      /* out */
1455 );
1456
1457 /*
1458  * Should call DestroyImage before destroying the surface it is bound to
1459  */
1460 VAStatus vaDestroyImage (
1461     VADisplay dpy,
1462     VAImageID image
1463 );
1464
1465 VAStatus vaSetImagePalette (
1466     VADisplay dpy,
1467     VAImageID image,
1468     /*
1469      * pointer to an array holding the palette data.  The size of the array is
1470      * num_palette_entries * entry_bytes in size.  The order of the components
1471      * in the palette is described by the component_order in VAImage struct
1472      */
1473     unsigned char *palette
1474 );
1475
1476 /*
1477  * Retrive surface data into a VAImage
1478  * Image must be in a format supported by the implementation
1479  */
1480 VAStatus vaGetImage (
1481     VADisplay dpy,
1482     VASurfaceID surface,
1483     int x,      /* coordinates of the upper left source pixel */
1484     int y,
1485     unsigned int width, /* width and height of the region */
1486     unsigned int height,
1487     VAImageID image
1488 );
1489
1490 /*
1491  * Copy data from a VAImage to a surface
1492  * Image must be in a format supported by the implementation
1493  * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1494  * shouldn't be rendered into when this is called
1495  */
1496 VAStatus vaPutImage (
1497     VADisplay dpy,
1498     VASurfaceID surface,
1499     VAImageID image,
1500     int src_x,
1501     int src_y,
1502     unsigned int src_width,
1503     unsigned int src_height,
1504     int dest_x,
1505     int dest_y,
1506     unsigned int dest_width,
1507     unsigned int dest_height
1508 );
1509
1510 /*
1511  * Derive an VAImage from an existing surface.
1512  * This interface will derive a VAImage and corresponding image buffer from
1513  * an existing VA Surface. The image buffer can then be mapped/unmapped for
1514  * direct CPU access. This operation is only possible on implementations with
1515  * direct rendering capabilities and internal surface formats that can be
1516  * represented with a VAImage. When the operation is not possible this interface
1517  * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1518  * to using vaCreateImage + vaPutImage to accomplish the same task in an
1519  * indirect manner.
1520  *
1521  * Implementations should only return success when the resulting image buffer
1522  * would be useable with vaMap/Unmap.
1523  *
1524  * When directly accessing a surface special care must be taken to insure
1525  * proper synchronization with the graphics hardware. Clients should call
1526  * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1527  * rendering or currently being displayed by an overlay.
1528  *
1529  * Additionally nothing about the contents of a surface should be assumed
1530  * following a vaPutSurface. Implementations are free to modify the surface for
1531  * scaling or subpicture blending within a call to vaPutImage.
1532  *
1533  * Calls to vaPutImage or vaGetImage using the same surface from which the image
1534  * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1535  * vaGetImage with other surfaces is supported.
1536  *
1537  * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1538  * image and image buffer structures will be destroyed; however, the underlying
1539  * surface will remain unchanged until freed with vaDestroySurfaces.
1540  */
1541 VAStatus vaDeriveImage (
1542     VADisplay dpy,
1543     VASurfaceID surface,
1544     VAImage *image      /* out */
1545 );
1546
1547 /*
1548  * Subpictures
1549  * Subpicture is a special type of image that can be blended
1550  * with a surface during vaPutSurface(). Subpicture can be used to render
1551  * DVD sub-titles or closed captioning text etc.
1552  */
1553
1554 typedef VAGenericID VASubpictureID;
1555
1556 /* Get maximum number of subpicture formats supported by the implementation */
1557 int vaMaxNumSubpictureFormats (
1558     VADisplay dpy
1559 );
1560
1561 /* flags for subpictures */
1562 #define VA_SUBPICTURE_CHROMA_KEYING     0x0001
1563 #define VA_SUBPICTURE_GLOBAL_ALPHA      0x0002
1564 /*
1565  * Query supported subpicture formats
1566  * The caller must provide a "format_list" array that can hold at
1567  * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1568  * for each format to indicate additional capabilities for that format. The actual
1569  * number of formats returned in "format_list" is returned in "num_formats".
1570  *  flags: returned value to indicate addtional capabilities
1571  *         VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1572  *         VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1573  */
1574 VAStatus vaQuerySubpictureFormats (
1575     VADisplay dpy,
1576     VAImageFormat *format_list, /* out */
1577     unsigned int *flags,        /* out */
1578     unsigned int *num_formats   /* out */
1579 );
1580
1581 /*
1582  * Subpictures are created with an image associated.
1583  */
1584 VAStatus vaCreateSubpicture (
1585     VADisplay dpy,
1586     VAImageID image,
1587     VASubpictureID *subpicture  /* out */
1588 );
1589
1590 /*
1591  * Destroy the subpicture before destroying the image it is assocated to
1592  */
1593 VAStatus vaDestroySubpicture (
1594     VADisplay dpy,
1595     VASubpictureID subpicture
1596 );
1597
1598 /*
1599  * Bind an image to the subpicture. This image will now be associated with
1600  * the subpicture instead of the one at creation.
1601  */
1602 VAStatus vaSetSubpictureImage (
1603     VADisplay dpy,
1604     VASubpictureID subpicture,
1605     VAImageID image
1606 );
1607
1608 /*
1609  * If chromakey is enabled, then the area where the source value falls within
1610  * the chromakey [min, max] range is transparent
1611  * The chromakey component format is the following:
1612  *  For RGB: [0:7] Red [8:15] Blue [16:23] Green
1613  *  For YUV: [0:7] V [8:15] U [16:23] Y
1614  * The chromakey mask can be used to mask out certain components for chromakey
1615  * comparision
1616  */
1617 VAStatus vaSetSubpictureChromakey (
1618     VADisplay dpy,
1619     VASubpictureID subpicture,
1620     unsigned int chromakey_min,
1621     unsigned int chromakey_max,
1622     unsigned int chromakey_mask
1623 );
1624
1625 /*
1626  * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
1627  * a value of 0 means fully transparent. If per-pixel alpha is also specified then
1628  * the overall alpha is per-pixel alpha multiplied by the global alpha
1629  */
1630 VAStatus vaSetSubpictureGlobalAlpha (
1631     VADisplay dpy,
1632     VASubpictureID subpicture,
1633     float global_alpha
1634 );
1635
1636 /*
1637  * vaAssociateSubpicture associates the subpicture with target_surfaces.
1638  * It defines the region mapping between the subpicture and the target
1639  * surfaces through source and destination rectangles (with the same width and height).
1640  * Both will be displayed at the next call to vaPutSurface.  Additional
1641  * associations before the call to vaPutSurface simply overrides the association.
1642  */
1643 VAStatus vaAssociateSubpicture (
1644     VADisplay dpy,
1645     VASubpictureID subpicture,
1646     VASurfaceID *target_surfaces,
1647     int num_surfaces,
1648     short src_x, /* upper left offset in subpicture */
1649     short src_y,
1650     unsigned short src_width,
1651     unsigned short src_height,
1652     short dest_x, /* upper left offset in surface */
1653     short dest_y,
1654     unsigned short dest_width,
1655     unsigned short dest_height,
1656     /*
1657      * whether to enable chroma-keying or global-alpha
1658      * see VA_SUBPICTURE_XXX values
1659      */
1660     unsigned int flags
1661 );
1662
1663 /*
1664  * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
1665  */
1666 VAStatus vaDeassociateSubpicture (
1667     VADisplay dpy,
1668     VASubpictureID subpicture,
1669     VASurfaceID *target_surfaces,
1670     int num_surfaces
1671 );
1672
1673 typedef struct _VARectangle
1674 {
1675     short x;
1676     short y;
1677     unsigned short width;
1678     unsigned short height;
1679 } VARectangle;
1680
1681 /*
1682  * Display attributes
1683  * Display attributes are used to control things such as contrast, hue, saturation,
1684  * brightness etc. in the rendering process.  The application can query what
1685  * attributes are supported by the driver, and then set the appropriate attributes
1686  * before calling vaPutSurface()
1687  */
1688 /* PowerVR IEP Lite attributes */
1689 typedef enum
1690 {
1691     VADISPLAYATTRIB_BLE_OFF              = 0x00,
1692     VADISPLAYATTRIB_BLE_LOW,
1693     VADISPLAYATTRIB_BLE_MEDIUM,
1694     VADISPLAYATTRIB_BLE_HIGH,
1695     VADISPLAYATTRIB_BLE_NONE,
1696 } VADisplayAttribBLEMode;
1697
1698 typedef enum
1699 {
1700     VADISPLAYATTRIB_CSC_FORMAT_YCC_BT601 = 0x00,
1701     VADISPLAYATTRIB_CSC_FORMAT_YCC_BT709,
1702     VADISPLAYATTRIB_CSC_FORMAT_YCC_SMPTE_240,
1703     VADISPLAYATTRIB_CSC_FORMAT_RGB,
1704     VADISPLAYATTRIB_CSC_FORMAT_NONE,
1705 } VADisplayAttribCSCFormat;
1706
1707 /* attribute value for VADisplayAttribRotation   */
1708 #define VA_ROTATION_NONE        0x00000000
1709 #define VA_ROTATION_90          0x00000001
1710 #define VA_ROTATION_180         0x00000002
1711 #define VA_ROTATION_270         0x00000004
1712
1713 /* attribute value for VADisplayAttribOutOfLoopDeblock */
1714 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
1715 #define VA_OOL_DEBLOCKING_TRUE  0x00000001
1716
1717
1718 /* Currently defined display attribute types */
1719 typedef enum
1720 {
1721     VADisplayAttribBrightness           = 0,
1722     VADisplayAttribContrast             = 1,
1723     VADisplayAttribHue                  = 2,
1724     VADisplayAttribSaturation           = 3,
1725     /* client can specifiy a background color for the target window */
1726     VADisplayAttribBackgroundColor      = 4,
1727     /*
1728      * this is a gettable only attribute. For some implementations that use the
1729      * hardware overlay, after PutSurface is called, the surface can not be
1730      * re-used until after the subsequent PutSurface call. If this is the case
1731      * then the value for this attribute will be set to 1 so that the client
1732      * will not attempt to re-use the surface right after returning from a call
1733      * to PutSurface.
1734      */
1735     VADisplayAttribDirectSurface       = 5,
1736     VADisplayAttribRotation            = 6,
1737     VADisplayAttribOutofLoopDeblock    = 7,
1738
1739     /* PowerVR IEP Lite specific attributes */
1740     VADisplayAttribBLEBlackMode        = 8,
1741     VADisplayAttribBLEWhiteMode        = 9,
1742     VADisplayAttribBlueStretch         = 10,
1743     VADisplayAttribSkinColorCorrection = 11,
1744     VADisplayAttribCSCInputColorFormat = 12,
1745     VADisplayAttribCSCHue              = 13,
1746     VADisplayAttribCSCSaturation       = 14,
1747     VADisplayAttribCSCBrightness       = 15,
1748     VADisplayAttribCSCContrast         = 16,
1749 } VADisplayAttribType;
1750
1751 /* flags for VADisplayAttribute */
1752 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
1753 #define VA_DISPLAY_ATTRIB_GETTABLE      0x0001
1754 #define VA_DISPLAY_ATTRIB_SETTABLE      0x0002
1755
1756 typedef struct _VADisplayAttribute
1757 {
1758     VADisplayAttribType type;
1759     int min_value;
1760     int max_value;
1761     int value;  /* used by the set/get attribute functions */
1762 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
1763     unsigned int flags;
1764 } VADisplayAttribute;
1765
1766 /* Get maximum number of display attributs supported by the implementation */
1767 int vaMaxNumDisplayAttributes (
1768     VADisplay dpy
1769 );
1770
1771 /*
1772  * Query display attributes
1773  * The caller must provide a "attr_list" array that can hold at
1774  * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
1775  * returned in "attr_list" is returned in "num_attributes".
1776  */
1777 VAStatus vaQueryDisplayAttributes (
1778     VADisplay dpy,
1779     VADisplayAttribute *attr_list,      /* out */
1780     int *num_attributes                 /* out */
1781 );
1782
1783 /*
1784  * Get display attributes
1785  * This function returns the current attribute values in "attr_list".
1786  * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
1787  * from vaQueryDisplayAttributes() can have their values retrieved.
1788  */
1789 VAStatus vaGetDisplayAttributes (
1790     VADisplay dpy,
1791     VADisplayAttribute *attr_list,      /* in/out */
1792     int num_attributes
1793 );
1794
1795 /*
1796  * Set display attributes
1797  * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
1798  * from vaQueryDisplayAttributes() can be set.  If the attribute is not settable or
1799  * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
1800  */
1801 VAStatus vaSetDisplayAttributes (
1802     VADisplay dpy,
1803     VADisplayAttribute *attr_list,
1804     int num_attributes
1805 );
1806
1807 #ifdef ANDROID
1808 #define Display unsigned int
1809 #define Drawable unsigned int
1810 #define XID unsigned int
1811 #define Bool int
1812 #define Status int
1813 #define True 1
1814 #define False 0
1815 #define Xfree(ptr) free((ptr))
1816 #endif
1817
1818 #ifdef __cplusplus
1819 }
1820 #endif
1821
1822 #endif /* _VA_H_ */