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  * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
  61  *                                        screen relative rather than source video relative.
  62  * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
  63  *                                        update VAAPI to 0.32.0
  64  *
  65  * Acknowledgements:
  66  *  Some concepts borrowed from XvMC and XvImage.
  67  *  Waldo Bastian (Intel), Matt Sottek (Intel),  Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
  68  *  contributed to various aspects of the API.
  69  */
  70
  71 #ifndef _VA_H_
  72 #define _VA_H_
  73
  74 #include <va/va_version.h>
  75
  76 #ifdef __cplusplus
  77 extern "C" {
  78 #endif
  79
  80 /*
  81 Overview
  82
  83 The VA API is intended to provide an interface between a video decode/encode/display
  84 application (client) and a hardware accelerator (server), to off-load
  85 video decode/encode/display operations from the host to the hardware accelerator at various
  86 entry-points.
  87
  88 The basic operation steps are:
  89
  90 - Negotiate a mutually acceptable configuration with the server to lock
  91   down profile, entrypoints, and other attributes that will not change on
  92   a frame-by-frame basis.
  93 - Create a decode context which represents a "virtualized" hardware decode
  94   device
  95 - Get and fill decode buffers with picture level, slice level and macroblock
  96   level data (depending on entrypoints)
  97 - Pass the decode buffers to the server to decode the current frame
  98
  99 Initialization & Configuration Management
 100
 101 - Find out supported profiles
 102 - Find out entrypoints for a given profile
 103 - Find out configuration attributes for a given profile/entrypoint pair
 104 - Create a configuration for use by the decoder
 105
 106 */
 107
 108 typedef void* VADisplay;        /* window system dependent */
 109
 110 typedef int VAStatus;   /* Return status type from functions */
 111 /* Values for the return status */
 112 #define VA_STATUS_SUCCESS                       0x00000000
 113 #define VA_STATUS_ERROR_OPERATION_FAILED        0x00000001
 114 #define VA_STATUS_ERROR_ALLOCATION_FAILED       0x00000002
 115 #define VA_STATUS_ERROR_INVALID_DISPLAY         0x00000003
 116 #define VA_STATUS_ERROR_INVALID_CONFIG          0x00000004
 117 #define VA_STATUS_ERROR_INVALID_CONTEXT         0x00000005
 118 #define VA_STATUS_ERROR_INVALID_SURFACE         0x00000006
 119 #define VA_STATUS_ERROR_INVALID_BUFFER          0x00000007
 120 #define VA_STATUS_ERROR_INVALID_IMAGE           0x00000008
 121 #define VA_STATUS_ERROR_INVALID_SUBPICTURE      0x00000009
 122 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED      0x0000000a
 123 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED        0x0000000b
 124 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE     0x0000000c
 125 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT  0x0000000d
 126 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT   0x0000000e
 127 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE  0x0000000f
 128 #define VA_STATUS_ERROR_SURFACE_BUSY            0x00000010
 129 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED      0x00000011
 130 #define VA_STATUS_ERROR_INVALID_PARAMETER       0x00000012
 131 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
 132 #define VA_STATUS_ERROR_UNIMPLEMENTED           0x00000014
 133 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING   0x00000015
 134 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT    0x00000016
 135 #define VA_STATUS_ERROR_DECODING_ERROR          0x00000017
 136 #define VA_STATUS_ERROR_ENCODING_ERROR          0x00000018
 137 /**
 138  * \brief An invalid/unsupported value was supplied.
 139  *
 140  * This is a catch-all error code for invalid or unsupported values.
 141  * e.g. value exceeding the valid range, invalid type in the context
 142  * of generic attribute values.
 143  */
 144 #define VA_STATUS_ERROR_INVALID_VALUE           0x00000019
 145 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
 146 #define VA_STATUS_ERROR_HW_BUSY                 0x00000022
 147 #define VA_STATUS_ERROR_UNKNOWN                 0xFFFFFFFF
 148
 149 /* De-interlacing flags for vaPutSurface() */
 150 #define VA_FRAME_PICTURE        0x00000000
 151 #define VA_TOP_FIELD            0x00000001
 152 #define VA_BOTTOM_FIELD         0x00000002
 153
 154 /*
 155  * Enabled the positioning/cropping/blending feature:
 156  * 1, specify the video playback position in the isurface
 157  * 2, specify the cropping info for video playback
 158  * 3, encoded video will blend with background color
 159  */
 160 #define VA_ENABLE_BLEND         0x00000004 /* video area blend with the constant color */
 161
 162 /*
 163  * Clears the drawable with background color.
 164  * for hardware overlay based implementation this flag
 165  * can be used to turn off the overlay
 166  */
 167 #define VA_CLEAR_DRAWABLE       0x00000008
 168
 169 /* Color space conversion flags for vaPutSurface() */
 170 #define VA_SRC_BT601            0x00000010
 171 #define VA_SRC_BT709            0x00000020
 172 #define VA_SRC_SMPTE_240        0x00000040
 173
 174 /* Scaling flags for vaPutSurface() */
 175 #define VA_FILTER_SCALING_DEFAULT       0x00000000
 176 #define VA_FILTER_SCALING_FAST          0x00000100
 177 #define VA_FILTER_SCALING_HQ            0x00000200
 178 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
 179 #define VA_FILTER_SCALING_MASK          0x00000f00
 180
 181 /*
 182  * Returns a short english description of error_status
 183  */
 184 const char *vaErrorStr(VAStatus error_status);
 185
 186 /*
 187  * Initialization:
 188  * A display must be obtained by calling vaGetDisplay() before calling
 189  * vaInitialize() and other functions. This connects the API to the
 190  * native window system.
 191  * For X Windows, native_dpy would be from XOpenDisplay()
 192  */
 193 typedef void* VANativeDisplay;  /* window system dependent */
 194
 195 int vaDisplayIsValid(VADisplay dpy);
 196
 197 /*
 198  * Initialize the library
 199  */
 200 VAStatus vaInitialize (
 201     VADisplay dpy,
 202     int *major_version,  /* out */
 203     int *minor_version   /* out */
 204 );
 205
 206 /*
 207  * After this call, all library internal resources will be cleaned up
 208  */
 209 VAStatus vaTerminate (
 210     VADisplay dpy
 211 );
 212
 213 /*
 214  * vaQueryVendorString returns a pointer to a zero-terminated string
 215  * describing some aspects of the VA implemenation on a specific
 216  * hardware accelerator. The format of the returned string is vendor
 217  * specific and at the discretion of the implementer.
 218  * e.g. for the Intel GMA500 implementation, an example would be:
 219  * "Intel GMA500 - 2.0.0.32L.0005"
 220  */
 221 const char *vaQueryVendorString (
 222     VADisplay dpy
 223 );
 224
 225 typedef int (*VAPrivFunc)();
 226
 227 /*
 228  * Return a function pointer given a function name in the library.
 229  * This allows private interfaces into the library
 230  */
 231 VAPrivFunc vaGetLibFunc (
 232     VADisplay dpy,
 233     const char *func
 234 );
 235
 236 /* Currently defined profiles */
 237 typedef enum
 238 {
 239     VAProfileMPEG2Simple                = 0,
 240     VAProfileMPEG2Main                  = 1,
 241     VAProfileMPEG4Simple                = 2,
 242     VAProfileMPEG4AdvancedSimple        = 3,
 243     VAProfileMPEG4Main                  = 4,
 244     VAProfileH264Baseline               = 5,
 245     VAProfileH264Main                   = 6,
 246     VAProfileH264High                   = 7,
 247     VAProfileVC1Simple                  = 8,
 248     VAProfileVC1Main                    = 9,
 249     VAProfileVC1Advanced                = 10,
 250     VAProfileH263Baseline               = 11,
 251     VAProfileJPEGBaseline               = 12,
 252     VAProfileH264ConstrainedBaseline = 13
 253 } VAProfile;
 254
 255 /*
 256  *  Currently defined entrypoints
 257  */
 258 typedef enum
 259 {
 260     VAEntrypointVLD             = 1,
 261     VAEntrypointIZZ             = 2,
 262     VAEntrypointIDCT            = 3,
 263     VAEntrypointMoComp          = 4,
 264     VAEntrypointDeblocking      = 5,
 265     VAEntrypointEncSlice        = 6,    /* slice level encode */
 266     VAEntrypointEncPicture      = 7     /* pictuer encode, JPEG, etc */
 267 } VAEntrypoint;
 268
 269 /* Currently defined configuration attribute types */
 270 typedef enum
 271 {
 272     VAConfigAttribRTFormat              = 0,
 273     VAConfigAttribSpatialResidual       = 1,
 274     VAConfigAttribSpatialClipping       = 2,
 275     VAConfigAttribIntraResidual         = 3,
 276     VAConfigAttribEncryption            = 4,
 277     VAConfigAttribRateControl           = 5,
 278
 279     /** @name Attributes for encoding */
 280     /**@{*/
 281     /**
 282      * \brief Packed headers mode. Read/write.
 283      *
 284      * This attribute determines what packed headers the driver supports,
 285      * through vaGetConfigAttributes(); and what packed headers the user
 286      * will be providing to the driver, through vaCreateConfig(), if the
 287      * driver supports those.
 288      *
 289      * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
 290      */
 291     VAConfigAttribEncPackedHeaders      = 10,
 292     /**
 293      * \brief Interlaced mode. Read/write.
 294      *
 295      * This attribute determines what kind of interlaced encoding mode
 296      * the driver supports.
 297      *
 298      * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
 299      */
 300     VAConfigAttribEncInterlaced         = 11,
 301     /**
 302      * \brief Maximum number of reference frames. Read-only.
 303      *
 304      * This attribute determines the maximum number of reference
 305      * frames supported for encoding.
 306      *
 307      * Note: for H.264 encoding, the value represents the maximum number
 308      * of reference frames for both the reference picture list 0 (bottom
 309      * 16 bits) and the reference picture list 1 (top 16 bits).
 310      */
 311     VAConfigAttribEncMaxRefFrames       = 13,
 312     /**
 313      * \brief Maximum number of slices per frame. Read-only.
 314      *
 315      * This attribute determines the maximum number of slices the
 316      * driver can support to encode a single frame.
 317      */
 318     VAConfigAttribEncMaxSlices          = 14,
 319     /**
 320      * \brief Slice structure. Read-only.
 321      *
 322      * This attribute determines slice structures supported by the
 323      * driver for encoding. This attribute is a hint to the user so
 324      * that he can choose a suitable surface size and how to arrange
 325      * the encoding process of multiple slices per frame.
 326      *
 327      * More specifically, for H.264 encoding, this attribute
 328      * determines the range of accepted values to
 329      * VAEncSliceParameterBufferH264::macroblock_address and
 330      * VAEncSliceParameterBufferH264::num_macroblocks.
 331      *
 332      * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
 333      * structure types.
 334      */
 335     VAConfigAttribEncSliceStructure     = 15,
 336     /**
 337      * \brief Macroblock information. Read-only.
 338      *
 339      * This attribute determines whether the driver supports extra
 340      * encoding information per-macroblock. e.g. QP.
 341      *
 342      * More specifically, for H.264 encoding, if the driver returns a non-zero
 343      * value for this attribute, this means the application can create
 344      * additional #VAEncMacroblockParameterBufferH264 buffers referenced
 345      * through VAEncSliceParameterBufferH264::macroblock_info.
 346      */
 347     VAConfigAttribEncMacroblockInfo     = 16,
 348     /**@}*/
 349 } VAConfigAttribType;
 350
 351 /*
 352  * Configuration attributes
 353  * If there is more than one value for an attribute, a default
 354  * value will be assigned to the attribute if the client does not
 355  * specify the attribute when creating a configuration
 356  */
 357 typedef struct _VAConfigAttrib {
 358     VAConfigAttribType type;
 359     unsigned int value; /* OR'd flags (bits) for this attribute */
 360 } VAConfigAttrib;
 361
 362 /* attribute value for VAConfigAttribRTFormat */
 363 #define VA_RT_FORMAT_YUV420     0x00000001
 364 #define VA_RT_FORMAT_YUV422     0x00000002
 365 #define VA_RT_FORMAT_YUV444     0x00000004
 366 #define VA_RT_FORMAT_PROTECTED  0x80000000
 367
 368 /** @name Attribute values for VAConfigAttribRateControl */
 369 /**@{*/
 370 /** \brief Driver does not support any form of rate control. */
 371 #define VA_RC_NONE                      0x00000001
 372 /** \brief Constant bitrate. */
 373 #define VA_RC_CBR                       0x00000002
 374 /** \brief Variable bitrate. */
 375 #define VA_RC_VBR                       0x00000004
 376 /** \brief Video conference mode. */
 377 #define VA_RC_VCM                       0x00000008
 378 /** \brief Constant QP. */
 379 #define VA_RC_CQP                       0x00000010
 380 /** \brief Variable bitrate with peak rate higher than average bitrate. */
 381 #define VA_RC_VBR_CONSTRAINED           0x00000020
 382 /**@}*/
 383
 384 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
 385 /**@{*/
 386 /** \brief Driver does not support any packed headers mode. */
 387 #define VA_ENC_PACKED_HEADER_NONE       0x00000000
 388 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
 389 #define VA_ENC_PACKED_HEADER_SEQUENCE   0x00000001
 390 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
 391 #define VA_ENC_PACKED_HEADER_PICTURE    0x00000002
 392 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
 393 #define VA_ENC_PACKED_HEADER_SLICE      0x00000004
 394 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
 395 #define VA_ENC_PACKED_HEADER_MISC       0x00000008
 396 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
 397 #define VA_ENC_PACKED_HEADER_RAW_DATA   0x0000000C
 398 /**@}*/
 399
 400 /** @name Attribute values for VAConfigAttribEncInterlaced */
 401 /**@{*/
 402 /** \brief Driver does not support interlaced coding. */
 403 #define VA_ENC_INTERLACED_NONE          0x00000000
 404 /** \brief Driver supports interlaced frame coding. */
 405 #define VA_ENC_INTERLACED_FRAME         0x00000001
 406 /** \brief Driver supports interlaced field coding. */
 407 #define VA_ENC_INTERLACED_FIELD         0x00000002
 408 /** \brief Driver supports macroblock adaptive frame field coding. */
 409 #define VA_ENC_INTERLACED_MBAFF         0x00000004
 410 /** \brief Driver supports picture adaptive frame field coding. */
 411 #define VA_ENC_INTERLACED_PAFF          0x00000008
 412 /**@}*/
 413
 414 /** @name Attribute values for VAConfigAttribEncSliceStructure */
 415 /**@{*/
 416 /** \brief Driver supports an arbitrary number of rows per slice. */
 417 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS           0x00000000
 418 /** \brief Driver supports a power-of-two number of rows per slice. */
 419 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS        0x00000001
 420 /** \brief Driver supports an arbitrary number of rows per slice. */
 421 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS    0x00000002
 422 /**@}*/
 423
 424 /*
 425  * if an attribute is not applicable for a given
 426  * profile/entrypoint pair, then set the value to the following
 427  */
 428 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
 429
 430 /* Get maximum number of profiles supported by the implementation */
 431 int vaMaxNumProfiles (
 432     VADisplay dpy
 433 );
 434
 435 /* Get maximum number of entrypoints supported by the implementation */
 436 int vaMaxNumEntrypoints (
 437     VADisplay dpy
 438 );
 439
 440 /* Get maximum number of attributs supported by the implementation */
 441 int vaMaxNumConfigAttributes (
 442     VADisplay dpy
 443 );
 444
 445 /*
 446  * Query supported profiles
 447  * The caller must provide a "profile_list" array that can hold at
 448  * least vaMaxNumProfile() entries. The actual number of profiles
 449  * returned in "profile_list" is returned in "num_profile".
 450  */
 451 VAStatus vaQueryConfigProfiles (
 452     VADisplay dpy,
 453     VAProfile *profile_list,    /* out */
 454     int *num_profiles           /* out */
 455 );
 456
 457 /*
 458  * Query supported entrypoints for a given profile
 459  * The caller must provide an "entrypoint_list" array that can hold at
 460  * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
 461  * returned in "entrypoint_list" is returned in "num_entrypoints".
 462  */
 463 VAStatus vaQueryConfigEntrypoints (
 464     VADisplay dpy,
 465     VAProfile profile,
 466     VAEntrypoint *entrypoint_list,      /* out */
 467     int *num_entrypoints                /* out */
 468 );
 469
 470 /*
 471  * Get attributes for a given profile/entrypoint pair
 472  * The caller must provide an "attrib_list" with all attributes to be
 473  * retrieved.  Upon return, the attributes in "attrib_list" have been
 474  * updated with their value.  Unknown attributes or attributes that are
 475  * not supported for the given profile/entrypoint pair will have their
 476  * value set to VA_ATTRIB_NOT_SUPPORTED
 477  */
 478 VAStatus vaGetConfigAttributes (
 479     VADisplay dpy,
 480     VAProfile profile,
 481     VAEntrypoint entrypoint,
 482     VAConfigAttrib *attrib_list, /* in/out */
 483     int num_attribs
 484 );
 485
 486 /* Generic ID type, can be re-typed for specific implementation */
 487 typedef unsigned int VAGenericID;
 488
 489 typedef VAGenericID VAConfigID;
 490
 491 /*
 492  * Create a configuration for the decode pipeline
 493  * it passes in the attribute list that specifies the attributes it cares
 494  * about, with the rest taking default values.
 495  */
 496 VAStatus vaCreateConfig (
 497     VADisplay dpy,
 498     VAProfile profile,
 499     VAEntrypoint entrypoint,
 500     VAConfigAttrib *attrib_list,
 501     int num_attribs,
 502     VAConfigID *config_id /* out */
 503 );
 504
 505 /*
 506  * Free resources associdated with a given config
 507  */
 508 VAStatus vaDestroyConfig (
 509     VADisplay dpy,
 510     VAConfigID config_id
 511 );
 512
 513 /*
 514  * Query all attributes for a given configuration
 515  * The profile of the configuration is returned in "profile"
 516  * The entrypoint of the configuration is returned in "entrypoint"
 517  * The caller must provide an "attrib_list" array that can hold at least
 518  * vaMaxNumConfigAttributes() entries. The actual number of attributes
 519  * returned in "attrib_list" is returned in "num_attribs"
 520  */
 521 VAStatus vaQueryConfigAttributes (
 522     VADisplay dpy,
 523     VAConfigID config_id,
 524     VAProfile *profile,         /* out */
 525     VAEntrypoint *entrypoint,   /* out */
 526     VAConfigAttrib *attrib_list,/* out */
 527     int *num_attribs            /* out */
 528 );
 529
 530
 531 /*
 532  * Contexts and Surfaces
 533  *
 534  * Context represents a "virtual" video decode pipeline. Surfaces are render
 535  * targets for a given context. The data in the surfaces are not accessible
 536  * to the client and the internal data format of the surface is implementatin
 537  * specific.
 538  *
 539  * Surfaces will be bound to a context when the context is created. Once
 540  * a surface is bound to a given context, it can not be used to create
 541  * another context. The association is removed when the context is destroyed
 542  *
 543  * Both contexts and surfaces are identified by unique IDs and its
 544  * implementation specific internals are kept opaque to the clients
 545  */
 546
 547 typedef VAGenericID VAContextID;
 548
 549 typedef VAGenericID VASurfaceID;
 550
 551 #define VA_INVALID_ID           0xffffffff
 552 #define VA_INVALID_SURFACE      VA_INVALID_ID
 553
 554 /** \brief Generic value types. */
 555 typedef enum  {
 556     VAGenericValueTypeInteger = 1,      /**< 32-bit signed integer. */
 557     VAGenericValueTypeFloat,            /**< 32-bit floating-point value. */
 558     VAGenericValueTypePointer,          /**< Generic pointer type */
 559     VAGenericValueTypeFunc              /**< Pointer to function */
 560 } VAGenericValueType;
 561
 562 /** \brief Generic function type. */
 563 typedef void (*VAGenericFunc)(void);
 564
 565 /** \brief Generic value. */
 566 typedef struct _VAGenericValue {
 567     /** \brief Value type. See #VAGenericValueType. */
 568     VAGenericValueType  type;
 569     /** \brief Value holder. */
 570     union {
 571         /** \brief 32-bit signed integer. */
 572         int             i;
 573         /** \brief 32-bit float. */
 574         float           f;
 575         /** \brief Generic pointer. */
 576         void           *p;
 577         /** \brief Pointer to function. */
 578         VAGenericFunc   fn;
 579     }                   value;
 580 } VAGenericValue;
 581
 582 /*
 583  * vaCreateSurfaces - Create an array of surfaces used for decode and display
 584  *  dpy: display
 585  *  width: surface width
 586  *  height: surface height
 587  *  format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
 588  *  num_surfaces: number of surfaces to be created
 589  *  surfaces: array of surfaces created upon return
 590  */
 591 VAStatus vaCreateSurfaces (
 592     VADisplay dpy,
 593     int width,
 594     int height,
 595     int format,
 596     int num_surfaces,
 597     VASurfaceID *surfaces       /* out */
 598 );
 599
 600
 601 /*
 602  * vaDestroySurfaces - Destroy resources associated with surfaces.
 603  *  Surfaces can only be destroyed after the context associated has been
 604  *  destroyed.
 605  *  dpy: display
 606  *  surfaces: array of surfaces to destroy
 607  *  num_surfaces: number of surfaces in the array to be destroyed.
 608  */
 609 VAStatus vaDestroySurfaces (
 610     VADisplay dpy,
 611     VASurfaceID *surfaces,
 612     int num_surfaces
 613 );
 614
 615 #define VA_PROGRESSIVE 0x1
 616 /*
 617  * vaCreateContext - Create a context
 618  *  dpy: display
 619  *  config_id: configuration for the context
 620  *  picture_width: coded picture width
 621  *  picture_height: coded picture height
 622  *  flag: any combination of the following:
 623  *    VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
 624  *  render_targets: render targets (surfaces) tied to the context
 625  *  num_render_targets: number of render targets in the above array
 626  *  context: created context id upon return
 627  */
 628 VAStatus vaCreateContext (
 629     VADisplay dpy,
 630     VAConfigID config_id,
 631     int picture_width,
 632     int picture_height,
 633     int flag,
 634     VASurfaceID *render_targets,
 635     int num_render_targets,
 636     VAContextID *context                /* out */
 637 );
 638
 639 /*
 640  * vaDestroyContext - Destroy a context
 641  *  dpy: display
 642  *  context: context to be destroyed
 643  */
 644 VAStatus vaDestroyContext (
 645     VADisplay dpy,
 646     VAContextID context
 647 );
 648
 649 /*
 650  * Buffers
 651  * Buffers are used to pass various types of data from the
 652  * client to the server. The server maintains a data store
 653  * for each buffer created, and the client idenfies a buffer
 654  * through a unique buffer id assigned by the server.
 655  */
 656
 657 typedef VAGenericID VABufferID;
 658
 659 typedef enum
 660 {
 661     VAPictureParameterBufferType        = 0,
 662     VAIQMatrixBufferType                = 1,
 663     VABitPlaneBufferType                = 2,
 664     VASliceGroupMapBufferType           = 3,
 665     VASliceParameterBufferType          = 4,
 666     VASliceDataBufferType               = 5,
 667     VAMacroblockParameterBufferType     = 6,
 668     VAResidualDataBufferType            = 7,
 669     VADeblockingParameterBufferType     = 8,
 670     VAImageBufferType                   = 9,
 671     VAProtectedSliceDataBufferType      = 10,
 672     VAQMatrixBufferType                 = 11,
 673     VAHuffmanTableBufferType            = 12,
 674
 675 /* Following are encode buffer types */
 676     VAEncCodedBufferType                = 21,
 677     VAEncSequenceParameterBufferType    = 22,
 678     VAEncPictureParameterBufferType     = 23,
 679     VAEncSliceParameterBufferType       = 24,
 680     VAEncPackedHeaderParameterBufferType = 25,
 681     VAEncPackedHeaderDataBufferType     = 26,
 682     VAEncMiscParameterBufferType        = 27,
 683     VAEncMacroblockParameterBufferType  = 28,
 684     VABufferTypeMax                     = 0xff
 685 } VABufferType;
 686
 687 typedef enum
 688 {
 689     VAEncMiscParameterTypeFrameRate     = 0,
 690     VAEncMiscParameterTypeRateControl   = 1,
 691     VAEncMiscParameterTypeMaxSliceSize  = 2,
 692     VAEncMiscParameterTypeAIR           = 3,
 693     /** \brief Buffer type used to express a maximum frame size (in bits). */
 694     VAEncMiscParameterTypeMaxFrameSize  = 4,
 695     /** \brief Buffer type used for HRD parameters. */
 696     VAEncMiscParameterTypeHRD           = 5,
 697 } VAEncMiscParameterType;
 698
 699 /** \brief Packed header type. */
 700 typedef enum {
 701     /** \brief Packed sequence header. */
 702     VAEncPackedHeaderSequence   = 1,
 703     /** \brief Packed picture header. */
 704     VAEncPackedHeaderPicture    = 2,
 705     /** \brief Packed slice header. */
 706     VAEncPackedHeaderSlice      = 3,
 707     /**
 708      * \brief Packed raw header.
 709      *
 710      * Packed raw data header can be used by the client to insert a header
 711      * into the bitstream data buffer at the point it is passed, the driver
 712      * will handle the raw packed header based on "has_emulation_bytes" field
 713      * in the packed header parameter structure.
 714      */
 715     VAEncPackedHeaderRawData    = 4,
 716     /** \brief Misc packed header. See codec-specific definitions. */
 717     VAEncPackedHeaderMiscMask   = 0x80000000,
 718 } VAEncPackedHeaderType;
 719
 720 /** \brief Packed header parameter. */
 721 typedef struct _VAEncPackedHeaderParameterBuffer {
 722     /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
 723     unsigned int                type;
 724     /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
 725     unsigned int                bit_length;
 726     /** \brief Flag: buffer contains start code emulation prevention bytes? */
 727     unsigned char               has_emulation_bytes;
 728 } VAEncPackedHeaderParameterBuffer;
 729
 730 /*
 731  *  For application, e.g. set a new bitrate
 732  *    VABufferID buf_id;
 733  *    VAEncMiscParameterBuffer *misc_param;
 734  *    VAEncMiscParameterRateControl *misc_rate_ctrl;
 735  *
 736  *    vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
 737  *              sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
 738  *              1, NULL, &buf_id);
 739  *
 740  *    vaMapBuffer(dpy,buf_id,(void **)&misc_param);
 741  *    misc_param->type = VAEncMiscParameterTypeRateControl;
 742  *    misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
 743  *    misc_rate_ctrl->bits_per_second = 6400000;
 744  *    vaUnmapBuffer(dpy, buf_id);
 745  *    vaRenderPicture(dpy, context, &buf_id, 1);
 746  */
 747 typedef struct _VAEncMiscParameterBuffer
 748 {
 749     VAEncMiscParameterType type;
 750     unsigned int data[0];
 751 } VAEncMiscParameterBuffer;
 752
 753
 754 /** \brief Rate control parameters */
 755 typedef struct _VAEncMiscParameterRateControl
 756 {
 757     /* this is the maximum bit-rate to be constrained by the rate control implementation */
 758     unsigned int bits_per_second;
 759     /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
 760      * bit-rate for example if target_percentage is 95 then the rate control will target
 761      * a bit-rate that is 95% of the maximum bit-rate
 762      */
 763     unsigned int target_percentage;
 764     /* windows size in milliseconds. For example if this is set to 500,
 765      * then the rate control will guarantee the target bit-rate over a 500 ms window
 766      */
 767     unsigned int window_size;
 768     /* initial QP at I frames */
 769     unsigned int initial_qp;
 770     unsigned int min_qp;
 771     unsigned int basic_unit_size;
 772     union
 773     {
 774         struct
 775         {
 776             unsigned int reset : 1;
 777             unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
 778             unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
 779         } bits;
 780         unsigned int value;
 781     } rc_flags;
 782 } VAEncMiscParameterRateControl;
 783
 784 typedef struct _VAEncMiscParameterFrameRate
 785 {
 786     unsigned int framerate;
 787 } VAEncMiscParameterFrameRate;
 788
 789 /*
 790  * Allow a maximum slice size to be specified (in bits).
 791  * The encoder will attempt to make sure that individual slices do not exceed this size
 792  * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
 793  */
 794 typedef struct _VAEncMiscParameterMaxSliceSize
 795 {
 796     unsigned int max_slice_size;
 797 } VAEncMiscParameterMaxSliceSize;
 798
 799 typedef struct _VAEncMiscParameterAIR
 800 {
 801     unsigned int air_num_mbs;
 802     unsigned int air_threshold;
 803     unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
 804 } VAEncMiscParameterAIR;
 805
 806 typedef struct _VAEncMiscParameterHRD
 807 {
 808     unsigned int initial_buffer_fullness;       /* in bits */
 809     unsigned int buffer_size;                   /* in bits */
 810 } VAEncMiscParameterHRD;
 811
 812 /**
 813  * \brief Defines a maximum frame size (in bits).
 814  *
 815  * This misc parameter buffer defines the maximum size of a frame (in
 816  * bits). The encoder will try to make sure that each frame does not
 817  * exceed this size. Otherwise, if the frame size exceeds this size,
 818  * the \c status flag of #VACodedBufferSegment will contain
 819  * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
 820  */
 821 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
 822     /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
 823     VAEncMiscParameterType      type;
 824     /** \brief Maximum size of a frame (in bits). */
 825     unsigned int                max_frame_size;
 826 } VAEncMiscParameterBufferMaxFrameSize;
 827
 828 /*
 829  * There will be cases where the bitstream buffer will not have enough room to hold
 830  * the data for the entire slice, and the following flags will be used in the slice
 831  * parameter to signal to the server for the possible cases.
 832  * If a slice parameter buffer and slice data buffer pair is sent to the server with
 833  * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
 834  * then a slice parameter and data buffer needs to be sent again to complete this slice.
 835  */
 836 #define VA_SLICE_DATA_FLAG_ALL          0x00    /* whole slice is in the buffer */
 837 #define VA_SLICE_DATA_FLAG_BEGIN        0x01    /* The beginning of the slice is in the buffer but the end if not */
 838 #define VA_SLICE_DATA_FLAG_MIDDLE       0x02    /* Neither beginning nor end of the slice is in the buffer */
 839 #define VA_SLICE_DATA_FLAG_END          0x04    /* end of the slice is in the buffer */
 840
 841 /* Codec-independent Slice Parameter Buffer base */
 842 typedef struct _VASliceParameterBufferBase
 843 {
 844     unsigned int slice_data_size;       /* number of bytes in the slice data buffer for this slice */
 845     unsigned int slice_data_offset;     /* the offset to the first byte of slice data */
 846     unsigned int slice_data_flag;       /* see VA_SLICE_DATA_FLAG_XXX definitions */
 847 } VASliceParameterBufferBase;
 848
 849
 850 /****************************
 851  * JEPG data structure
 852  ***************************/
 853 typedef struct _VAQMatrixBufferJPEG
 854 {
 855     int load_lum_quantiser_matrix;
 856     int load_chroma_quantiser_matrix;
 857     unsigned char lum_quantiser_matrix[64];
 858     unsigned char chroma_quantiser_matrix[64];
 859 } VAQMatrixBufferJPEG;
 860
 861 typedef struct _VAEncPictureParameterBufferJPEG
 862 {
 863     VASurfaceID reconstructed_picture;
 864     unsigned short picture_width;
 865     unsigned short picture_height;
 866     VABufferID coded_buf;
 867 } VAEncPictureParameterBufferJPEG;
 868
 869 #include <va/va_dec_jpeg.h>
 870
 871 /****************************
 872  * MPEG-2 data structures
 873  ****************************/
 874
 875 /* MPEG-2 Picture Parameter Buffer */
 876 /*
 877  * For each frame or field, and before any slice data, a single
 878  * picture parameter buffer must be send.
 879  */
 880 typedef struct _VAPictureParameterBufferMPEG2
 881 {
 882     unsigned short horizontal_size;
 883     unsigned short vertical_size;
 884     VASurfaceID forward_reference_picture;
 885     VASurfaceID backward_reference_picture;
 886     /* meanings of the following fields are the same as in the standard */
 887     int picture_coding_type;
 888     int f_code; /* pack all four fcode into this */
 889     union {
 890         struct {
 891             unsigned int intra_dc_precision             : 2;
 892             unsigned int picture_structure              : 2;
 893             unsigned int top_field_first                : 1;
 894             unsigned int frame_pred_frame_dct           : 1;
 895             unsigned int concealment_motion_vectors     : 1;
 896             unsigned int q_scale_type                   : 1;
 897             unsigned int intra_vlc_format               : 1;
 898             unsigned int alternate_scan                 : 1;
 899             unsigned int repeat_first_field             : 1;
 900             unsigned int progressive_frame              : 1;
 901             unsigned int is_first_field                 : 1; /* indicate whether the current field
 902                                                               * is the first field for field picture
 903                                                               */
 904         } bits;
 905         unsigned int value;
 906     } picture_coding_extension;
 907 } VAPictureParameterBufferMPEG2;
 908
 909 /* MPEG-2 Inverse Quantization Matrix Buffer */
 910 typedef struct _VAIQMatrixBufferMPEG2
 911 {
 912     int load_intra_quantiser_matrix;
 913     int load_non_intra_quantiser_matrix;
 914     int load_chroma_intra_quantiser_matrix;
 915     int load_chroma_non_intra_quantiser_matrix;
 916     unsigned char intra_quantiser_matrix[64];
 917     unsigned char non_intra_quantiser_matrix[64];
 918     unsigned char chroma_intra_quantiser_matrix[64];
 919     unsigned char chroma_non_intra_quantiser_matrix[64];
 920 } VAIQMatrixBufferMPEG2;
 921
 922 /* MPEG-2 Slice Parameter Buffer */
 923 typedef struct _VASliceParameterBufferMPEG2
 924 {
 925     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 926     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 927     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 928     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 929     unsigned int slice_horizontal_position;
 930     unsigned int slice_vertical_position;
 931     int quantiser_scale_code;
 932     int intra_slice_flag;
 933 } VASliceParameterBufferMPEG2;
 934
 935 /* MPEG-2 Macroblock Parameter Buffer */
 936 typedef struct _VAMacroblockParameterBufferMPEG2
 937 {
 938     unsigned short macroblock_address;
 939     /*
 940      * macroblock_address (in raster scan order)
 941      * top-left: 0
 942      * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
 943      */
 944     unsigned char macroblock_type;  /* see definition below */
 945     union {
 946         struct {
 947             unsigned int frame_motion_type              : 2;
 948             unsigned int field_motion_type              : 2;
 949             unsigned int dct_type                       : 1;
 950         } bits;
 951         unsigned int value;
 952     } macroblock_modes;
 953     unsigned char motion_vertical_field_select;
 954     /*
 955      * motion_vertical_field_select:
 956      * see section 6.3.17.2 in the spec
 957      * only the lower 4 bits are used
 958      * bit 0: first vector forward
 959      * bit 1: first vector backward
 960      * bit 2: second vector forward
 961      * bit 3: second vector backward
 962      */
 963     short PMV[2][2][2]; /* see Table 7-7 in the spec */
 964     unsigned short coded_block_pattern;
 965     /*
 966      * The bitplanes for coded_block_pattern are described
 967      * in Figure 6.10-12 in the spec
 968      */
 969
 970     /* Number of skipped macroblocks after this macroblock */
 971     unsigned short num_skipped_macroblocks;
 972 } VAMacroblockParameterBufferMPEG2;
 973
 974 /*
 975  * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
 976  */
 977 #define VA_MB_TYPE_MOTION_FORWARD       0x02
 978 #define VA_MB_TYPE_MOTION_BACKWARD      0x04
 979 #define VA_MB_TYPE_MOTION_PATTERN       0x08
 980 #define VA_MB_TYPE_MOTION_INTRA         0x10
 981
 982 /*
 983  * MPEG-2 Residual Data Buffer
 984  * For each macroblock, there wil be 64 shorts (16-bit) in the
 985  * residual data buffer
 986  */
 987
 988 /****************************
 989  * MPEG-4 Part 2 data structures
 990  ****************************/
 991
 992 /* MPEG-4 Picture Parameter Buffer */
 993 /*
 994  * For each frame or field, and before any slice data, a single
 995  * picture parameter buffer must be send.
 996  */
 997 typedef struct _VAPictureParameterBufferMPEG4
 998 {
 999     unsigned short vop_width;
1000     unsigned short vop_height;
1001     VASurfaceID forward_reference_picture;
1002     VASurfaceID backward_reference_picture;
1003     union {
1004         struct {
1005             unsigned int short_video_header             : 1;
1006             unsigned int chroma_format                  : 2;
1007             unsigned int interlaced                     : 1;
1008             unsigned int obmc_disable                   : 1;
1009             unsigned int sprite_enable                  : 2;
1010             unsigned int sprite_warping_accuracy        : 2;
1011             unsigned int quant_type                     : 1;
1012             unsigned int quarter_sample                 : 1;
1013             unsigned int data_partitioned               : 1;
1014             unsigned int reversible_vlc                 : 1;
1015             unsigned int resync_marker_disable          : 1;
1016         } bits;
1017         unsigned int value;
1018     } vol_fields;
1019     unsigned char no_of_sprite_warping_points;
1020     short sprite_trajectory_du[3];
1021     short sprite_trajectory_dv[3];
1022     unsigned char quant_precision;
1023     union {
1024         struct {
1025             unsigned int vop_coding_type                : 2;
1026             unsigned int backward_reference_vop_coding_type     : 2;
1027             unsigned int vop_rounding_type              : 1;
1028             unsigned int intra_dc_vlc_thr               : 3;
1029             unsigned int top_field_first                : 1;
1030             unsigned int alternate_vertical_scan_flag   : 1;
1031         } bits;
1032         unsigned int value;
1033     } vop_fields;
1034     unsigned char vop_fcode_forward;
1035     unsigned char vop_fcode_backward;
1036     unsigned short vop_time_increment_resolution;
1037     /* short header related */
1038     unsigned char num_gobs_in_vop;
1039     unsigned char num_macroblocks_in_gob;
1040     /* for direct mode prediction */
1041     short TRB;
1042     short TRD;
1043 } VAPictureParameterBufferMPEG4;
1044
1045 /* MPEG-4 Inverse Quantization Matrix Buffer */
1046 typedef struct _VAIQMatrixBufferMPEG4
1047 {
1048     int load_intra_quant_mat;
1049     int load_non_intra_quant_mat;
1050     unsigned char intra_quant_mat[64];
1051     unsigned char non_intra_quant_mat[64];
1052 } VAIQMatrixBufferMPEG4;
1053
1054 /* MPEG-4 Slice Parameter Buffer */
1055 typedef struct _VASliceParameterBufferMPEG4
1056 {
1057     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1058     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1059     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1060     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1061     unsigned int macroblock_number;
1062     int quant_scale;
1063 } VASliceParameterBufferMPEG4;
1064
1065 /*
1066  VC-1 data structures
1067 */
1068
1069 typedef enum   /* see 7.1.1.32 */
1070 {
1071     VAMvMode1Mv                        = 0,
1072     VAMvMode1MvHalfPel                 = 1,
1073     VAMvMode1MvHalfPelBilinear         = 2,
1074     VAMvModeMixedMv                    = 3,
1075     VAMvModeIntensityCompensation      = 4
1076 } VAMvModeVC1;
1077
1078 /* VC-1 Picture Parameter Buffer */
1079 /*
1080  * For each picture, and before any slice data, a picture parameter
1081  * buffer must be send. Multiple picture parameter buffers may be
1082  * sent for a single picture. In that case picture parameters will
1083  * apply to all slice data that follow it until a new picture
1084  * parameter buffer is sent.
1085  *
1086  * Notes:
1087  *   pic_quantizer_type should be set to the applicable quantizer
1088  *   type as defined by QUANTIZER (J.1.19) and either
1089  *   PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1090  */
1091 typedef struct _VAPictureParameterBufferVC1
1092 {
1093     VASurfaceID forward_reference_picture;
1094     VASurfaceID backward_reference_picture;
1095     /* if out-of-loop post-processing is done on the render
1096        target, then we need to keep the in-loop decoded
1097        picture as a reference picture */
1098     VASurfaceID inloop_decoded_picture;
1099
1100     /* sequence layer for AP or meta data for SP and MP */
1101     union {
1102         struct {
1103             unsigned int pulldown       : 1; /* SEQUENCE_LAYER::PULLDOWN */
1104             unsigned int interlace      : 1; /* SEQUENCE_LAYER::INTERLACE */
1105             unsigned int tfcntrflag     : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1106             unsigned int finterpflag    : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1107             unsigned int psf            : 1; /* SEQUENCE_LAYER::PSF */
1108             unsigned int multires       : 1; /* METADATA::MULTIRES */
1109             unsigned int overlap        : 1; /* METADATA::OVERLAP */
1110             unsigned int syncmarker     : 1; /* METADATA::SYNCMARKER */
1111             unsigned int rangered       : 1; /* METADATA::RANGERED */
1112             unsigned int max_b_frames   : 3; /* METADATA::MAXBFRAMES */
1113             unsigned int profile        : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1114         } bits;
1115         unsigned int value;
1116     } sequence_fields;
1117
1118     unsigned short coded_width;         /* ENTRY_POINT_LAYER::CODED_WIDTH */
1119     unsigned short coded_height;        /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1120     union {
1121         struct {
1122             unsigned int broken_link    : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1123             unsigned int closed_entry   : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1124             unsigned int panscan_flag   : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1125             unsigned int loopfilter     : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1126         } bits;
1127         unsigned int value;
1128     } entrypoint_fields;
1129     unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1130     unsigned char fast_uvmc_flag;       /* ENTRY_POINT_LAYER::FASTUVMC */
1131     union {
1132         struct {
1133             unsigned int luma_flag      : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1134             unsigned int luma           : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1135             unsigned int chroma_flag    : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1136             unsigned int chroma         : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1137         } bits;
1138         unsigned int value;
1139     } range_mapping_fields;
1140
1141     unsigned char b_picture_fraction;   /* PICTURE_LAYER::BFRACTION */
1142     unsigned char cbp_table;            /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1143     unsigned char mb_mode_table;        /* PICTURE_LAYER::MBMODETAB */
1144     unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1145     unsigned char rounding_control;     /* PICTURE_LAYER::RNDCTRL */
1146     unsigned char post_processing;      /* PICTURE_LAYER::POSTPROC */
1147     unsigned char picture_resolution_index;     /* PICTURE_LAYER::RESPIC */
1148     unsigned char luma_scale;           /* PICTURE_LAYER::LUMSCALE */
1149     unsigned char luma_shift;           /* PICTURE_LAYER::LUMSHIFT */
1150     union {
1151         struct {
1152             unsigned int picture_type           : 3; /* PICTURE_LAYER::PTYPE */
1153             unsigned int frame_coding_mode      : 3; /* PICTURE_LAYER::FCM */
1154             unsigned int top_field_first        : 1; /* PICTURE_LAYER::TFF */
1155             unsigned int is_first_field         : 1; /* set to 1 if it is the first field */
1156             unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1157         } bits;
1158         unsigned int value;
1159     } picture_fields;
1160     union {
1161         struct {
1162             unsigned int mv_type_mb     : 1;    /* PICTURE::MVTYPEMB */
1163             unsigned int direct_mb      : 1;    /* PICTURE::DIRECTMB */
1164             unsigned int skip_mb        : 1;    /* PICTURE::SKIPMB */
1165             unsigned int field_tx       : 1;    /* PICTURE::FIELDTX */
1166             unsigned int forward_mb     : 1;    /* PICTURE::FORWARDMB */
1167             unsigned int ac_pred        : 1;    /* PICTURE::ACPRED */
1168             unsigned int overflags      : 1;    /* PICTURE::OVERFLAGS */
1169         } flags;
1170         unsigned int value;
1171     } raw_coding;
1172     union {
1173         struct {
1174             unsigned int bp_mv_type_mb   : 1;    /* PICTURE::MVTYPEMB */
1175             unsigned int bp_direct_mb    : 1;    /* PICTURE::DIRECTMB */
1176             unsigned int bp_skip_mb      : 1;    /* PICTURE::SKIPMB */
1177             unsigned int bp_field_tx     : 1;    /* PICTURE::FIELDTX */
1178             unsigned int bp_forward_mb   : 1;    /* PICTURE::FORWARDMB */
1179             unsigned int bp_ac_pred      : 1;    /* PICTURE::ACPRED */
1180             unsigned int bp_overflags    : 1;    /* PICTURE::OVERFLAGS */
1181         } flags;
1182         unsigned int value;
1183     } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1184     union {
1185         struct {
1186             unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1187             unsigned int reference_distance     : 5;/* PICTURE_LAYER::REFDIST */
1188             unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1189             unsigned int reference_field_pic_indicator  : 1;/* PICTURE_LAYER::REFFIELD */
1190         } bits;
1191         unsigned int value;
1192     } reference_fields;
1193     union {
1194         struct {
1195             unsigned int mv_mode                : 3; /* PICTURE_LAYER::MVMODE */
1196             unsigned int mv_mode2               : 3; /* PICTURE_LAYER::MVMODE2 */
1197             unsigned int mv_table               : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1198             unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1199             unsigned int four_mv_switch         : 1; /* PICTURE_LAYER::4MVSWITCH */
1200             unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1201             unsigned int extended_mv_flag       : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1202             unsigned int extended_mv_range      : 2; /* PICTURE_LAYER::MVRANGE */
1203             unsigned int extended_dmv_flag      : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1204             unsigned int extended_dmv_range     : 2; /* PICTURE_LAYER::DMVRANGE */
1205         } bits;
1206         unsigned int value;
1207     } mv_fields;
1208     union {
1209         struct {
1210             unsigned int dquant : 2;    /* ENTRY_POINT_LAYER::DQUANT */
1211             unsigned int quantizer     : 2;     /* ENTRY_POINT_LAYER::QUANTIZER */
1212             unsigned int half_qp        : 1;    /* PICTURE_LAYER::HALFQP */
1213             unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1214             unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1215             unsigned int dq_frame       : 1;    /* VOPDQUANT::DQUANTFRM */
1216             unsigned int dq_profile     : 2;    /* VOPDQUANT::DQPROFILE */
1217             unsigned int dq_sb_edge     : 2;    /* VOPDQUANT::DQSBEDGE */
1218             unsigned int dq_db_edge     : 2;    /* VOPDQUANT::DQDBEDGE */
1219             unsigned int dq_binary_level : 1;   /* VOPDQUANT::DQBILEVEL */
1220             unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1221         } bits;
1222         unsigned int value;
1223     } pic_quantizer_fields;
1224     union {
1225         struct {
1226             unsigned int variable_sized_transform_flag  : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1227             unsigned int mb_level_transform_type_flag   : 1;/* PICTURE_LAYER::TTMBF */
1228             unsigned int frame_level_transform_type     : 2;/* PICTURE_LAYER::TTFRM */
1229             unsigned int transform_ac_codingset_idx1    : 2;/* PICTURE_LAYER::TRANSACFRM */
1230             unsigned int transform_ac_codingset_idx2    : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1231             unsigned int intra_transform_dc_table       : 1;/* PICTURE_LAYER::TRANSDCTAB */
1232         } bits;
1233         unsigned int value;
1234     } transform_fields;
1235 } VAPictureParameterBufferVC1;
1236
1237 /* VC-1 Bitplane Buffer
1238 There will be at most three bitplanes coded in any picture header. To send
1239 the bitplane data more efficiently, each byte is divided in two nibbles, with
1240 each nibble carrying three bitplanes for one macroblock.  The following table
1241 shows the bitplane data arrangement within each nibble based on the picture
1242 type.
1243
1244 Picture Type    Bit3            Bit2            Bit1            Bit0
1245 I or BI                         OVERFLAGS       ACPRED          FIELDTX
1246 P                               MYTYPEMB        SKIPMB          DIRECTMB
1247 B                               FORWARDMB       SKIPMB          DIRECTMB
1248
1249 Within each byte, the lower nibble is for the first MB and the upper nibble is
1250 for the second MB.  E.g. the lower nibble of the first byte in the bitplane
1251 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1252 Macroblock #2 in the first row.
1253 */
1254
1255 /* VC-1 Slice Parameter Buffer */
1256 typedef struct _VASliceParameterBufferVC1
1257 {
1258     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1259     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1260     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1261     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1262     unsigned int slice_vertical_position;
1263 } VASliceParameterBufferVC1;
1264
1265 /* VC-1 Slice Data Buffer */
1266 /*
1267 This is simplely a buffer containing raw bit-stream bytes
1268 */
1269
1270 /****************************
1271  * H.264/AVC data structures
1272  ****************************/
1273
1274 typedef struct _VAPictureH264
1275 {
1276     VASurfaceID picture_id;
1277     unsigned int frame_idx;
1278     unsigned int flags;
1279     signed int TopFieldOrderCnt;
1280     signed int BottomFieldOrderCnt;
1281 } VAPictureH264;
1282 /* flags in VAPictureH264 could be OR of the following */
1283 #define VA_PICTURE_H264_INVALID                 0x00000001
1284 #define VA_PICTURE_H264_TOP_FIELD               0x00000002
1285 #define VA_PICTURE_H264_BOTTOM_FIELD            0x00000004
1286 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE    0x00000008
1287 #define VA_PICTURE_H264_LONG_TERM_REFERENCE     0x00000010
1288
1289 /* H.264 Picture Parameter Buffer */
1290 /*
1291  * For each picture, and before any slice data, a single
1292  * picture parameter buffer must be send.
1293  */
1294 typedef struct _VAPictureParameterBufferH264
1295 {
1296     VAPictureH264 CurrPic;
1297     VAPictureH264 ReferenceFrames[16];  /* in DPB */
1298     unsigned short picture_width_in_mbs_minus1;
1299     unsigned short picture_height_in_mbs_minus1;
1300     unsigned char bit_depth_luma_minus8;
1301     unsigned char bit_depth_chroma_minus8;
1302     unsigned char num_ref_frames;
1303     union {
1304         struct {
1305             unsigned int chroma_format_idc                      : 2;
1306             unsigned int residual_colour_transform_flag         : 1;
1307             unsigned int gaps_in_frame_num_value_allowed_flag   : 1;
1308             unsigned int frame_mbs_only_flag                    : 1;
1309             unsigned int mb_adaptive_frame_field_flag           : 1;
1310             unsigned int direct_8x8_inference_flag              : 1;
1311             unsigned int MinLumaBiPredSize8x8                   : 1; /* see A.3.3.2 */
1312             unsigned int log2_max_frame_num_minus4              : 4;
1313             unsigned int pic_order_cnt_type                     : 2;
1314             unsigned int log2_max_pic_order_cnt_lsb_minus4      : 4;
1315             unsigned int delta_pic_order_always_zero_flag       : 1;
1316         } bits;
1317         unsigned int value;
1318     } seq_fields;
1319     unsigned char num_slice_groups_minus1;
1320     unsigned char slice_group_map_type;
1321     unsigned short slice_group_change_rate_minus1;
1322     signed char pic_init_qp_minus26;
1323     signed char pic_init_qs_minus26;
1324     signed char chroma_qp_index_offset;
1325     signed char second_chroma_qp_index_offset;
1326     union {
1327         struct {
1328             unsigned int entropy_coding_mode_flag       : 1;
1329             unsigned int weighted_pred_flag             : 1;
1330             unsigned int weighted_bipred_idc            : 2;
1331             unsigned int transform_8x8_mode_flag        : 1;
1332             unsigned int field_pic_flag                 : 1;
1333             unsigned int constrained_intra_pred_flag    : 1;
1334             unsigned int pic_order_present_flag                 : 1;
1335             unsigned int deblocking_filter_control_present_flag : 1;
1336             unsigned int redundant_pic_cnt_present_flag         : 1;
1337             unsigned int reference_pic_flag                     : 1; /* nal_ref_idc != 0 */
1338         } bits;
1339         unsigned int value;
1340     } pic_fields;
1341     unsigned short frame_num;
1342 } VAPictureParameterBufferH264;
1343
1344 /* H.264 Inverse Quantization Matrix Buffer */
1345 typedef struct _VAIQMatrixBufferH264
1346 {
1347     unsigned char ScalingList4x4[6][16];
1348     unsigned char ScalingList8x8[2][64];
1349 } VAIQMatrixBufferH264;
1350
1351 /*
1352  * H.264 Slice Group Map Buffer
1353  * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1354  * A slice group map buffer should be sent for each picture if required. The buffer
1355  * is sent only when there is a change in the mapping values.
1356  * The slice group map buffer map "map units" to slice groups as specified in
1357  * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1358  * in raster scan order
1359  */
1360
1361 /* H.264 Slice Parameter Buffer */
1362 typedef struct _VASliceParameterBufferH264
1363 {
1364     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1365     /** \brief Byte offset to the NAL Header Unit for this slice. */
1366     unsigned int slice_data_offset;
1367     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1368     /**
1369      * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1370      *
1371      * This bit offset is relative to and includes the NAL unit byte
1372      * and represents the number of bits parsed in the slice_header()
1373      * after the removal of any emulation prevention bytes in
1374      * there. However, the slice data buffer passed to the hardware is
1375      * the original bitstream, thus including any emulation prevention
1376      * bytes.
1377      */
1378     unsigned short slice_data_bit_offset;
1379     unsigned short first_mb_in_slice;
1380     unsigned char slice_type;
1381     unsigned char direct_spatial_mv_pred_flag;
1382     unsigned char num_ref_idx_l0_active_minus1;
1383     unsigned char num_ref_idx_l1_active_minus1;
1384     unsigned char cabac_init_idc;
1385     char slice_qp_delta;
1386     unsigned char disable_deblocking_filter_idc;
1387     char slice_alpha_c0_offset_div2;
1388     char slice_beta_offset_div2;
1389     VAPictureH264 RefPicList0[32];      /* See 8.2.4.2 */
1390     VAPictureH264 RefPicList1[32];      /* See 8.2.4.2 */
1391     unsigned char luma_log2_weight_denom;
1392     unsigned char chroma_log2_weight_denom;
1393     unsigned char luma_weight_l0_flag;
1394     short luma_weight_l0[32];
1395     short luma_offset_l0[32];
1396     unsigned char chroma_weight_l0_flag;
1397     short chroma_weight_l0[32][2];
1398     short chroma_offset_l0[32][2];
1399     unsigned char luma_weight_l1_flag;
1400     short luma_weight_l1[32];
1401     short luma_offset_l1[32];
1402     unsigned char chroma_weight_l1_flag;
1403     short chroma_weight_l1[32][2];
1404     short chroma_offset_l1[32][2];
1405 } VASliceParameterBufferH264;
1406
1407 /****************************
1408  * Common encode data structures
1409  ****************************/
1410 typedef enum
1411 {
1412     VAEncPictureTypeIntra               = 0,
1413     VAEncPictureTypePredictive          = 1,
1414     VAEncPictureTypeBidirectional       = 2,
1415 } VAEncPictureType;
1416
1417 /* Encode Slice Parameter Buffer */
1418 typedef struct _VAEncSliceParameterBuffer
1419 {
1420     unsigned int start_row_number;      /* starting MB row number for this slice */
1421     unsigned int slice_height;  /* slice height measured in MB */
1422     union {
1423         struct {
1424             unsigned int is_intra       : 1;
1425             unsigned int disable_deblocking_filter_idc : 2;
1426             unsigned int uses_long_term_ref             :1;
1427             unsigned int is_long_term_ref               :1;
1428         } bits;
1429         unsigned int value;
1430     } slice_flags;
1431 } VAEncSliceParameterBuffer;
1432
1433
1434 /****************************
1435  * H.263 specific encode data structures
1436  ****************************/
1437
1438 typedef struct _VAEncSequenceParameterBufferH263
1439 {
1440     unsigned int intra_period;
1441     unsigned int bits_per_second;
1442     unsigned int frame_rate;
1443     unsigned int initial_qp;
1444     unsigned int min_qp;
1445 } VAEncSequenceParameterBufferH263;
1446
1447 typedef struct _VAEncPictureParameterBufferH263
1448 {
1449     VASurfaceID reference_picture;
1450     VASurfaceID reconstructed_picture;
1451     VABufferID coded_buf;
1452     unsigned short picture_width;
1453     unsigned short picture_height;
1454     VAEncPictureType picture_type;
1455 } VAEncPictureParameterBufferH263;
1456
1457 /****************************
1458  * MPEG-4 specific encode data structures
1459  ****************************/
1460
1461 typedef struct _VAEncSequenceParameterBufferMPEG4
1462 {
1463     unsigned char profile_and_level_indication;
1464     unsigned int intra_period;
1465     unsigned int video_object_layer_width;
1466     unsigned int video_object_layer_height;
1467     unsigned int vop_time_increment_resolution;
1468     unsigned int fixed_vop_rate;
1469     unsigned int fixed_vop_time_increment;
1470     unsigned int bits_per_second;
1471     unsigned int frame_rate;
1472     unsigned int initial_qp;
1473     unsigned int min_qp;
1474 } VAEncSequenceParameterBufferMPEG4;
1475
1476 typedef struct _VAEncPictureParameterBufferMPEG4
1477 {
1478     VASurfaceID reference_picture;
1479     VASurfaceID reconstructed_picture;
1480     VABufferID coded_buf;
1481     unsigned short picture_width;
1482     unsigned short picture_height;
1483     unsigned int modulo_time_base; /* number of 1s */
1484     unsigned int vop_time_increment;
1485     VAEncPictureType picture_type;
1486 } VAEncPictureParameterBufferMPEG4;
1487
1488
1489
1490 /* Buffer functions */
1491
1492 /*
1493  * Creates a buffer for "num_elements" elements of "size" bytes and
1494  * initalize with "data".
1495  * if "data" is null, then the contents of the buffer data store
1496  * are undefined.
1497  * Basically there are two ways to get buffer data to the server side. One is
1498  * to call vaCreateBuffer() with a non-null "data", which results the data being
1499  * copied to the data store on the server side.  A different method that
1500  * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1501  * and then use vaMapBuffer() to map the data store from the server side to the
1502  * client address space for access.
1503  *  Note: image buffers are created by the library, not the client. Please see
1504  *        vaCreateImage on how image buffers are managed.
1505  */
1506 VAStatus vaCreateBuffer (
1507     VADisplay dpy,
1508     VAContextID context,
1509     VABufferType type,  /* in */
1510     unsigned int size,  /* in */
1511     unsigned int num_elements, /* in */
1512     void *data,         /* in */
1513     VABufferID *buf_id  /* out */
1514 );
1515
1516 /*
1517  * Convey to the server how many valid elements are in the buffer.
1518  * e.g. if multiple slice parameters are being held in a single buffer,
1519  * this will communicate to the server the number of slice parameters
1520  * that are valid in the buffer.
1521  */
1522 VAStatus vaBufferSetNumElements (
1523     VADisplay dpy,
1524     VABufferID buf_id,  /* in */
1525     unsigned int num_elements /* in */
1526 );
1527
1528
1529 /*
1530  * device independent data structure for codedbuffer
1531  */
1532
1533 /*
1534  * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1535  * LARGE_SLICE(bit8):At least one slice in the current frame was large
1536  *              enough for the encoder to attempt to limit its size.
1537  * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1538  *              exceeded the maximum slice size specified.
1539  * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1540  * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1541  * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1542  */
1543 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK         0xff
1544 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK            0x100
1545 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK         0x200
1546 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW            0x400
1547 #define VA_CODED_BUF_STATUS_BITRATE_HIGH                0x800
1548 /**
1549  * \brief The frame has exceeded the maximum requested size.
1550  *
1551  * This flag indicates that the encoded frame size exceeds the value
1552  * specified through a misc parameter buffer of type
1553  * #VAEncMiscParameterTypeMaxFrameSize.
1554  */
1555 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW         0x1000
1556 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD       0xff0000
1557
1558 /**
1559  * \brief The coded buffer segment contains a single NAL unit.
1560  *
1561  * This flag indicates that the coded buffer segment contains a
1562  * single NAL unit. This flag might be useful to the user for
1563  * processing the coded buffer.
1564  */
1565 #define VA_CODED_BUF_STATUS_SINGLE_NALU                 0x10000000
1566
1567 /**
1568  * \brief Coded buffer segment.
1569  *
1570  * #VACodedBufferSegment is an element of a linked list describing
1571  * some information on the coded buffer. The coded buffer segment
1572  * could contain either a single NAL unit, or more than one NAL unit.
1573  * It is recommended (but not required) to return a single NAL unit
1574  * in a coded buffer segment, and the implementation should set the
1575  * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1576  */
1577 typedef  struct _VACodedBufferSegment  {
1578     /**
1579      * \brief Size of the data buffer in this segment (in bytes).
1580      */
1581     unsigned int        size;
1582     /** \brief Bit offset into the data buffer where the video data starts. */
1583     unsigned int        bit_offset;
1584     /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1585     unsigned int        status;
1586     /** \brief Reserved for future use. */
1587     unsigned int        reserved;
1588     /** \brief Pointer to the start of the data buffer. */
1589     void               *buf;
1590     /**
1591      * \brief Pointer to the next #VACodedBufferSegment element,
1592      * or \c NULL if there is none.
1593      */
1594     void               *next;
1595 } VACodedBufferSegment;
1596
1597 /*
1598  * Map data store of the buffer into the client's address space
1599  * vaCreateBuffer() needs to be called with "data" set to NULL before
1600  * calling vaMapBuffer()
1601  *
1602  * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1603  * VACodedBufferSegment, and the list is terminated if "next" is NULL
1604  */
1605 VAStatus vaMapBuffer (
1606     VADisplay dpy,
1607     VABufferID buf_id,  /* in */
1608     void **pbuf         /* out */
1609 );
1610
1611 /*
1612  * After client making changes to a mapped data store, it needs to
1613  * "Unmap" it to let the server know that the data is ready to be
1614  * consumed by the server
1615  */
1616 VAStatus vaUnmapBuffer (
1617     VADisplay dpy,
1618     VABufferID buf_id   /* in */
1619 );
1620
1621 /*
1622  * After this call, the buffer is deleted and this buffer_id is no longer valid
1623  * Only call this if the buffer is not going to be passed to vaRenderBuffer
1624  */
1625 VAStatus vaDestroyBuffer (
1626     VADisplay dpy,
1627     VABufferID buffer_id
1628 );
1629
1630 /*
1631 Render (Decode) Pictures
1632
1633 A picture represents either a frame or a field.
1634
1635 The Begin/Render/End sequence sends the decode buffers to the server
1636 */
1637
1638 /*
1639  * Get ready to decode a picture to a target surface
1640  */
1641 VAStatus vaBeginPicture (
1642     VADisplay dpy,
1643     VAContextID context,
1644     VASurfaceID render_target
1645 );
1646
1647 /*
1648  * Send decode buffers to the server.
1649  * Buffers are automatically destroyed afterwards
1650  */
1651 VAStatus vaRenderPicture (
1652     VADisplay dpy,
1653     VAContextID context,
1654     VABufferID *buffers,
1655     int num_buffers
1656 );
1657
1658 /*
1659  * Make the end of rendering for a picture.
1660  * The server should start processing all pending operations for this
1661  * surface. This call is non-blocking. The client can start another
1662  * Begin/Render/End sequence on a different render target.
1663  */
1664 VAStatus vaEndPicture (
1665     VADisplay dpy,
1666     VAContextID context
1667 );
1668
1669 /*
1670
1671 Synchronization
1672
1673 */
1674
1675 /*
1676  * This function blocks until all pending operations on the render target
1677  * have been completed.  Upon return it is safe to use the render target for a
1678  * different picture.
1679  */
1680 VAStatus vaSyncSurface (
1681     VADisplay dpy,
1682     VASurfaceID render_target
1683 );
1684
1685 typedef enum
1686 {
1687     VASurfaceRendering  = 1, /* Rendering in progress */
1688     VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1689                              /* this status is useful if surface is used as the source */
1690                              /* of an overlay */
1691     VASurfaceReady      = 4, /* not being rendered or displayed */
1692     VASurfaceSkipped    = 8  /* Indicate a skipped frame during encode */
1693 } VASurfaceStatus;
1694
1695 /*
1696  * Find out any pending ops on the render target
1697  */
1698 VAStatus vaQuerySurfaceStatus (
1699     VADisplay dpy,
1700     VASurfaceID render_target,
1701     VASurfaceStatus *status     /* out */
1702 );
1703
1704 typedef enum
1705 {
1706     VADecodeSliceMissing            = 0,
1707     VADecodeMBError                 = 1,
1708 } VADecodeErrorType;
1709
1710 /*
1711  * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1712  * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1713 */
1714 typedef struct _VASurfaceDecodeMBErrors
1715 {
1716     int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1717     unsigned int start_mb; /* start mb address with errors */
1718     unsigned int end_mb;  /* end mb address with errors */
1719     VADecodeErrorType decode_error_type;
1720 } VASurfaceDecodeMBErrors;
1721
1722 /*
1723  * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1724  * it can call vaQuerySurfaceError to find out further details on the particular error.
1725  * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1726  * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1727  * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1728  * The array is terminated if "status==-1" is detected.
1729  */
1730 VAStatus vaQuerySurfaceError(
1731     VADisplay dpy,
1732     VASurfaceID surface,
1733     VAStatus error_status,
1734     void **error_info
1735 );
1736
1737 /*
1738  * Images and Subpictures
1739  * VAImage is used to either get the surface data to client memory, or
1740  * to copy image data in client memory to a surface.
1741  * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1742  * is at the upper left corner with positive X to the right and positive Y down
1743  */
1744 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1745     ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1746     ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1747
1748 /* a few common FourCCs */
1749 #define VA_FOURCC_NV12          0x3231564E
1750 #define VA_FOURCC_AI44          0x34344149
1751 #define VA_FOURCC_RGBA          0x41424752
1752 #define VA_FOURCC_BGRA          0x41524742
1753 #define VA_FOURCC_UYVY          0x59565955
1754 #define VA_FOURCC_YUY2          0x32595559
1755 #define VA_FOURCC_AYUV          0x56555941
1756 #define VA_FOURCC_NV11          0x3131564e
1757 #define VA_FOURCC_YV12          0x32315659
1758 #define VA_FOURCC_P208          0x38303250
1759 #define VA_FOURCC_IYUV          0x56555949
1760
1761 /* byte order */
1762 #define VA_LSB_FIRST            1
1763 #define VA_MSB_FIRST            2
1764
1765 typedef struct _VAImageFormat
1766 {
1767     unsigned int        fourcc;
1768     unsigned int        byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1769     unsigned int        bits_per_pixel;
1770     /* for RGB formats */
1771     unsigned int        depth; /* significant bits per pixel */
1772     unsigned int        red_mask;
1773     unsigned int        green_mask;
1774     unsigned int        blue_mask;
1775     unsigned int        alpha_mask;
1776 } VAImageFormat;
1777
1778 typedef VAGenericID VAImageID;
1779
1780 typedef struct _VAImage
1781 {
1782     VAImageID           image_id; /* uniquely identify this image */
1783     VAImageFormat       format;
1784     VABufferID          buf;    /* image data buffer */
1785     /*
1786      * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1787      * data store on the server side for optimal performance. The buffer will be
1788      * created by the CreateImage function, and proper storage allocated based on the image
1789      * size and format. This buffer is managed by the library implementation, and
1790      * accessed by the client through the buffer Map/Unmap functions.
1791      */
1792     unsigned short      width;
1793     unsigned short      height;
1794     unsigned int        data_size;
1795     unsigned int        num_planes;     /* can not be greater than 3 */
1796     /*
1797      * An array indicating the scanline pitch in bytes for each plane.
1798      * Each plane may have a different pitch. Maximum 3 planes for planar formats
1799      */
1800     unsigned int        pitches[3];
1801     /*
1802      * An array indicating the byte offset from the beginning of the image data
1803      * to the start of each plane.
1804      */
1805     unsigned int        offsets[3];
1806
1807     /* The following fields are only needed for paletted formats */
1808     int num_palette_entries;   /* set to zero for non-palette images */
1809     /*
1810      * Each component is one byte and entry_bytes indicates the number of components in
1811      * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1812      */
1813     int entry_bytes;
1814     /*
1815      * An array of ascii characters describing the order of the components within the bytes.
1816      * Only entry_bytes characters of the string are used.
1817      */
1818     char component_order[4];
1819 } VAImage;
1820
1821 /* Get maximum number of image formats supported by the implementation */
1822 int vaMaxNumImageFormats (
1823     VADisplay dpy
1824 );
1825
1826 /*
1827  * Query supported image formats
1828  * The caller must provide a "format_list" array that can hold at
1829  * least vaMaxNumImageFormats() entries. The actual number of formats
1830  * returned in "format_list" is returned in "num_formats".
1831  */
1832 VAStatus vaQueryImageFormats (
1833     VADisplay dpy,
1834     VAImageFormat *format_list, /* out */
1835     int *num_formats            /* out */
1836 );
1837
1838 /*
1839  * Create a VAImage structure
1840  * The width and height fields returned in the VAImage structure may get
1841  * enlarged for some YUV formats. Upon return from this function,
1842  * image->buf has been created and proper storage allocated by the library.
1843  * The client can access the image through the Map/Unmap calls.
1844  */
1845 VAStatus vaCreateImage (
1846     VADisplay dpy,
1847     VAImageFormat *format,
1848     int width,
1849     int height,
1850     VAImage *image      /* out */
1851 );
1852
1853 /*
1854  * Should call DestroyImage before destroying the surface it is bound to
1855  */
1856 VAStatus vaDestroyImage (
1857     VADisplay dpy,
1858     VAImageID image
1859 );
1860
1861 VAStatus vaSetImagePalette (
1862     VADisplay dpy,
1863     VAImageID image,
1864     /*
1865      * pointer to an array holding the palette data.  The size of the array is
1866      * num_palette_entries * entry_bytes in size.  The order of the components
1867      * in the palette is described by the component_order in VAImage struct
1868      */
1869     unsigned char *palette
1870 );
1871
1872 /*
1873  * Retrive surface data into a VAImage
1874  * Image must be in a format supported by the implementation
1875  */
1876 VAStatus vaGetImage (
1877     VADisplay dpy,
1878     VASurfaceID surface,
1879     int x,      /* coordinates of the upper left source pixel */
1880     int y,
1881     unsigned int width, /* width and height of the region */
1882     unsigned int height,
1883     VAImageID image
1884 );
1885
1886 /*
1887  * Copy data from a VAImage to a surface
1888  * Image must be in a format supported by the implementation
1889  * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1890  * shouldn't be rendered into when this is called
1891  */
1892 VAStatus vaPutImage (
1893     VADisplay dpy,
1894     VASurfaceID surface,
1895     VAImageID image,
1896     int src_x,
1897     int src_y,
1898     unsigned int src_width,
1899     unsigned int src_height,
1900     int dest_x,
1901     int dest_y,
1902     unsigned int dest_width,
1903     unsigned int dest_height
1904 );
1905
1906 /*
1907  * Derive an VAImage from an existing surface.
1908  * This interface will derive a VAImage and corresponding image buffer from
1909  * an existing VA Surface. The image buffer can then be mapped/unmapped for
1910  * direct CPU access. This operation is only possible on implementations with
1911  * direct rendering capabilities and internal surface formats that can be
1912  * represented with a VAImage. When the operation is not possible this interface
1913  * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1914  * to using vaCreateImage + vaPutImage to accomplish the same task in an
1915  * indirect manner.
1916  *
1917  * Implementations should only return success when the resulting image buffer
1918  * would be useable with vaMap/Unmap.
1919  *
1920  * When directly accessing a surface special care must be taken to insure
1921  * proper synchronization with the graphics hardware. Clients should call
1922  * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1923  * rendering or currently being displayed by an overlay.
1924  *
1925  * Additionally nothing about the contents of a surface should be assumed
1926  * following a vaPutSurface. Implementations are free to modify the surface for
1927  * scaling or subpicture blending within a call to vaPutImage.
1928  *
1929  * Calls to vaPutImage or vaGetImage using the same surface from which the image
1930  * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1931  * vaGetImage with other surfaces is supported.
1932  *
1933  * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1934  * image and image buffer structures will be destroyed; however, the underlying
1935  * surface will remain unchanged until freed with vaDestroySurfaces.
1936  */
1937 VAStatus vaDeriveImage (
1938     VADisplay dpy,
1939     VASurfaceID surface,
1940     VAImage *image      /* out */
1941 );
1942
1943 /*
1944  * Subpictures
1945  * Subpicture is a special type of image that can be blended
1946  * with a surface during vaPutSurface(). Subpicture can be used to render
1947  * DVD sub-titles or closed captioning text etc.
1948  */
1949
1950 typedef VAGenericID VASubpictureID;
1951
1952 /* Get maximum number of subpicture formats supported by the implementation */
1953 int vaMaxNumSubpictureFormats (
1954     VADisplay dpy
1955 );
1956
1957 /* flags for subpictures */
1958 #define VA_SUBPICTURE_CHROMA_KEYING                     0x0001
1959 #define VA_SUBPICTURE_GLOBAL_ALPHA                      0x0002
1960 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD       0x0004
1961 /*
1962  * Query supported subpicture formats
1963  * The caller must provide a "format_list" array that can hold at
1964  * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1965  * for each format to indicate additional capabilities for that format. The actual
1966  * number of formats returned in "format_list" is returned in "num_formats".
1967  *  flags: returned value to indicate addtional capabilities
1968  *         VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1969  *         VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1970  *         VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
1971  */
1972
1973 VAStatus vaQuerySubpictureFormats (
1974     VADisplay dpy,
1975     VAImageFormat *format_list, /* out */
1976     unsigned int *flags,        /* out */
1977     unsigned int *num_formats   /* out */
1978 );
1979
1980 /*
1981  * Subpictures are created with an image associated.
1982  */
1983 VAStatus vaCreateSubpicture (
1984     VADisplay dpy,
1985     VAImageID image,
1986     VASubpictureID *subpicture  /* out */
1987 );
1988
1989 /*
1990  * Destroy the subpicture before destroying the image it is assocated to
1991  */
1992 VAStatus vaDestroySubpicture (
1993     VADisplay dpy,
1994     VASubpictureID subpicture
1995 );
1996
1997 /*
1998  * Bind an image to the subpicture. This image will now be associated with
1999  * the subpicture instead of the one at creation.
2000  */
2001 VAStatus vaSetSubpictureImage (
2002     VADisplay dpy,
2003     VASubpictureID subpicture,
2004     VAImageID image
2005 );
2006
2007 /*
2008  * If chromakey is enabled, then the area where the source value falls within
2009  * the chromakey [min, max] range is transparent
2010  * The chromakey component format is the following:
2011  *  For RGB: [0:7] Red [8:15] Blue [16:23] Green
2012  *  For YUV: [0:7] V [8:15] U [16:23] Y
2013  * The chromakey mask can be used to mask out certain components for chromakey
2014  * comparision
2015  */
2016 VAStatus vaSetSubpictureChromakey (
2017     VADisplay dpy,
2018     VASubpictureID subpicture,
2019     unsigned int chromakey_min,
2020     unsigned int chromakey_max,
2021     unsigned int chromakey_mask
2022 );
2023
2024 /*
2025  * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2026  * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2027  * the overall alpha is per-pixel alpha multiplied by the global alpha
2028  */
2029 VAStatus vaSetSubpictureGlobalAlpha (
2030     VADisplay dpy,
2031     VASubpictureID subpicture,
2032     float global_alpha
2033 );
2034
2035 /*
2036  * vaAssociateSubpicture associates the subpicture with target_surfaces.
2037  * It defines the region mapping between the subpicture and the target
2038  * surfaces through source and destination rectangles (with the same width and height).
2039  * Both will be displayed at the next call to vaPutSurface.  Additional
2040  * associations before the call to vaPutSurface simply overrides the association.
2041  */
2042 VAStatus vaAssociateSubpicture (
2043     VADisplay dpy,
2044     VASubpictureID subpicture,
2045     VASurfaceID *target_surfaces,
2046     int num_surfaces,
2047     short src_x, /* upper left offset in subpicture */
2048     short src_y,
2049     unsigned short src_width,
2050     unsigned short src_height,
2051     short dest_x, /* upper left offset in surface */
2052     short dest_y,
2053     unsigned short dest_width,
2054     unsigned short dest_height,
2055     /*
2056      * whether to enable chroma-keying, global-alpha, or screen relative mode
2057      * see VA_SUBPICTURE_XXX values
2058      */
2059     unsigned int flags
2060 );
2061
2062 /*
2063  * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2064  */
2065 VAStatus vaDeassociateSubpicture (
2066     VADisplay dpy,
2067     VASubpictureID subpicture,
2068     VASurfaceID *target_surfaces,
2069     int num_surfaces
2070 );
2071
2072 typedef struct _VARectangle
2073 {
2074     short x;
2075     short y;
2076     unsigned short width;
2077     unsigned short height;
2078 } VARectangle;
2079
2080 /*
2081  * Display attributes
2082  * Display attributes are used to control things such as contrast, hue, saturation,
2083  * brightness etc. in the rendering process.  The application can query what
2084  * attributes are supported by the driver, and then set the appropriate attributes
2085  * before calling vaPutSurface()
2086  */
2087 /* PowerVR IEP Lite attributes */
2088 typedef enum
2089 {
2090     VADISPLAYATTRIB_BLE_OFF              = 0x00,
2091     VADISPLAYATTRIB_BLE_LOW,
2092     VADISPLAYATTRIB_BLE_MEDIUM,
2093     VADISPLAYATTRIB_BLE_HIGH,
2094     VADISPLAYATTRIB_BLE_NONE,
2095 } VADisplayAttribBLEMode;
2096
2097 /* attribute value for VADisplayAttribRotation   */
2098 #define VA_ROTATION_NONE        0x00000000
2099 #define VA_ROTATION_90          0x00000001
2100 #define VA_ROTATION_180         0x00000002
2101 #define VA_ROTATION_270         0x00000003
2102
2103 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2104 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2105 #define VA_OOL_DEBLOCKING_TRUE  0x00000001
2106
2107 /* Render mode */
2108 #define VA_RENDER_MODE_UNDEFINED           0
2109 #define VA_RENDER_MODE_LOCAL_OVERLAY       1
2110 #define VA_RENDER_MODE_LOCAL_GPU           2
2111 #define VA_RENDER_MODE_EXTERNAL_OVERLAY    4
2112 #define VA_RENDER_MODE_EXTERNAL_GPU        8
2113
2114 /* Render device */
2115 #define VA_RENDER_DEVICE_UNDEFINED  0
2116 #define VA_RENDER_DEVICE_LOCAL      1
2117 #define VA_RENDER_DEVICE_EXTERNAL   2
2118
2119 /* Currently defined display attribute types */
2120 typedef enum
2121 {
2122     VADisplayAttribBrightness           = 0,
2123     VADisplayAttribContrast             = 1,
2124     VADisplayAttribHue                  = 2,
2125     VADisplayAttribSaturation           = 3,
2126     /* client can specifiy a background color for the target window
2127      * the new feature of video conference,
2128      * the uncovered area of the surface is filled by this color
2129      * also it will blend with the decoded video color
2130      */
2131     VADisplayAttribBackgroundColor      = 4,
2132     /*
2133      * this is a gettable only attribute. For some implementations that use the
2134      * hardware overlay, after PutSurface is called, the surface can not be
2135      * re-used until after the subsequent PutSurface call. If this is the case
2136      * then the value for this attribute will be set to 1 so that the client
2137      * will not attempt to re-use the surface right after returning from a call
2138      * to PutSurface.
2139      *
2140      * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2141      * driver may use overlay or GPU alternatively
2142      */
2143     VADisplayAttribDirectSurface       = 5,
2144     VADisplayAttribRotation            = 6,
2145     VADisplayAttribOutofLoopDeblock    = 7,
2146
2147     /* PowerVR IEP Lite specific attributes */
2148     VADisplayAttribBLEBlackMode        = 8,
2149     VADisplayAttribBLEWhiteMode        = 9,
2150     VADisplayAttribBlueStretch         = 10,
2151     VADisplayAttribSkinColorCorrection = 11,
2152     /*
2153      * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2154      * conversion matrix. Each element in the matrix is float-point
2155      */
2156     VADisplayAttribCSCMatrix           = 12,
2157     /* specify the constant color used to blend with video surface
2158      * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2159      *      d: the final color to overwrite into the frame buffer
2160      *      v: decoded video after color conversion,
2161      *      c: video color specified by VADisplayAttribBlendColor
2162      *      b: background color of the drawable
2163      */
2164     VADisplayAttribBlendColor          = 13,
2165     /*
2166      * Indicate driver to skip painting color key or not.
2167      * only applicable if the render is overlay
2168      */
2169     VADisplayAttribOverlayAutoPaintColorKey   = 14,
2170     /*
2171      * customized overlay color key, the format is RGB888
2172      * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2173      */
2174     VADisplayAttribOverlayColorKey      = 15,
2175     /*
2176      * The hint for the implementation of vaPutSurface
2177      * normally, the driver could use an overlay or GPU to render the surface on the screen
2178      * this flag provides APP the flexibity to switch the render dynamically
2179      */
2180     VADisplayAttribRenderMode           = 16,
2181     /*
2182      * specify if vaPutSurface needs to render into specified monitors
2183      * one example is that one external monitor (e.g. HDMI) is enabled,
2184      * but the window manager is not aware of it, and there is no associated drawable
2185      */
2186     VADisplayAttribRenderDevice        = 17,
2187     /*
2188      * specify vaPutSurface render area if there is no drawable on the monitor
2189      */
2190     VADisplayAttribRenderRect          = 18,
2191 } VADisplayAttribType;
2192
2193 /* flags for VADisplayAttribute */
2194 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2195 #define VA_DISPLAY_ATTRIB_GETTABLE      0x0001
2196 #define VA_DISPLAY_ATTRIB_SETTABLE      0x0002
2197
2198 typedef struct _VADisplayAttribute
2199 {
2200     VADisplayAttribType type;
2201     int min_value;
2202     int max_value;
2203     int value;  /* used by the set/get attribute functions */
2204 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2205     unsigned int flags;
2206 } VADisplayAttribute;
2207
2208 /* Get maximum number of display attributs supported by the implementation */
2209 int vaMaxNumDisplayAttributes (
2210     VADisplay dpy
2211 );
2212
2213 /*
2214  * Query display attributes
2215  * The caller must provide a "attr_list" array that can hold at
2216  * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2217  * returned in "attr_list" is returned in "num_attributes".
2218  */
2219 VAStatus vaQueryDisplayAttributes (
2220     VADisplay dpy,
2221     VADisplayAttribute *attr_list,      /* out */
2222     int *num_attributes                 /* out */
2223 );
2224
2225 /*
2226  * Get display attributes
2227  * This function returns the current attribute values in "attr_list".
2228  * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2229  * from vaQueryDisplayAttributes() can have their values retrieved.
2230  */
2231 VAStatus vaGetDisplayAttributes (
2232     VADisplay dpy,
2233     VADisplayAttribute *attr_list,      /* in/out */
2234     int num_attributes
2235 );
2236
2237 /*
2238  * Set display attributes
2239  * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2240  * from vaQueryDisplayAttributes() can be set.  If the attribute is not settable or
2241  * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2242  */
2243 VAStatus vaSetDisplayAttributes (
2244     VADisplay dpy,
2245     VADisplayAttribute *attr_list,
2246     int num_attributes
2247 );
2248
2249 #ifdef __cplusplus
2250 }
2251 #endif
2252
2253 #endif /* _VA_H_ */