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