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