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 expressed in bit fields (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 /**
 677  * @name VASurfaceAttribMemoryType values in bit fields.
 678  * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
 679  * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
 680  * types are defined in DRM and Android header files.
 681  */
 682 /**@{*/
 683 /** \brief VA memory type (default) is supported. */
 684 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA                   0x00000001
 685 /** \brief V4L2 buffer memory type is supported. */
 686 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2                 0x00000002
 687 /** \brief User pointer memory type is supported. */
 688 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR             0x00000004
 689 /**@}*/
 690
 691 /**
 692  * \brief VASurfaceAttribExternalBuffers structure for
 693  * the VASurfaceAttribExternalBufferDescriptor attribute.
 694  */
 695 typedef struct _VASurfaceAttribExternalBuffers {
 696     /** \brief pixel format in fourcc. */
 697     unsigned int pixel_format;
 698     /** \brief width in pixels. */
 699     unsigned int width;
 700     /** \brief height in pixels. */
 701     unsigned int height;
 702     /** \brief total size of the buffer in bytes. */
 703     unsigned int data_size;
 704     /** \brief number of planes for planar layout */
 705     unsigned int num_planes;
 706     /** \brief pitch for each plane in bytes */
 707     unsigned int pitches[4];
 708     /** \brief offset for each plane in bytes */
 709     unsigned int offsets[4];
 710     /** \brief buffer handles or user pointers */
 711     unsigned long *buffers;
 712     /** \brief number of elements in the "buffers" array */
 713     unsigned int num_buffers;
 714     /** \brief flags. See "Surface external buffer descriptor flags". */
 715     unsigned int flags;
 716     /** \brief reserved for passing private data */
 717     void *private_data;
 718 } VASurfaceAttribExternalBuffers;
 719
 720 /** @name VASurfaceAttribExternalBuffers flags */
 721 /**@{*/
 722 /** \brief Enable memory tiling */
 723 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING    0x00000001
 724 /**@}*/
 725
 726 /**
 727  * \brief Get surface attributes for the supplied config.
 728  *
 729  * This function retrieves the surface attributes matching the supplied
 730  * config. The caller shall provide an \c attrib_list with all attributes
 731  * to be retrieved. Upon successful return, the attributes in \c attrib_list
 732  * are updated with the requested value. Unknown attributes or attributes
 733  * that are not supported for the given config will have their \c flags
 734  * field set to \c VA_SURFACE_ATTRIB_NOT_SUPPORTED.
 735  *
 736  * @param[in] dpy               the VA display
 737  * @param[in] config            the config identifying a codec or a video
 738  *     processing pipeline
 739  * @param[in,out] attrib_list   the list of attributes on input, with at
 740  *     least \c type fields filled in, and possibly \c value fields whenever
 741  *     necessary. The updated list of attributes and flags on output
 742  * @param[in] num_attribs       the number of attributes supplied in the
 743  *     \c attrib_list array
 744  */
 745 VAStatus
 746 vaGetSurfaceAttributes(
 747     VADisplay           dpy,
 748     VAConfigID          config,
 749     VASurfaceAttrib    *attrib_list,
 750     unsigned int        num_attribs
 751 );
 752
 753 /**
 754  * \brief Creates an array of surfaces
 755  *
 756  * Creates an array of surfaces. The optional list of attributes shall
 757  * be constructed and verified through vaGetSurfaceAttributes().
 758  *
 759  * @param[in] dpy               the VA display
 760  * @param[in] format            the desired surface format. See \c VA_RT_FORMAT_*
 761  * @param[in] width             the surface width
 762  * @param[in] height            the surface height
 763  * @param[out] surfaces         the array of newly created surfaces
 764  * @param[in] num_surfaces      the number of surfaces to create
 765  * @param[in] attrib_list       the list of (optional) attributes, or \c NULL
 766  * @param[in] num_attribs       the number of attributes supplied in
 767  *     \c attrib_list, or zero
 768  */
 769 VAStatus
 770 vaCreateSurfaces(
 771     VADisplay           dpy,
 772     unsigned int        format,
 773     unsigned int        width,
 774     unsigned int        height,
 775     VASurfaceID        *surfaces,
 776     unsigned int        num_surfaces,
 777     VASurfaceAttrib    *attrib_list,
 778     unsigned int        num_attribs
 779 );
 780
 781 /*
 782  * vaDestroySurfaces - Destroy resources associated with surfaces.
 783  *  Surfaces can only be destroyed after the context associated has been
 784  *  destroyed.
 785  *  dpy: display
 786  *  surfaces: array of surfaces to destroy
 787  *  num_surfaces: number of surfaces in the array to be destroyed.
 788  */
 789 VAStatus vaDestroySurfaces (
 790     VADisplay dpy,
 791     VASurfaceID *surfaces,
 792     int num_surfaces
 793 );
 794
 795 #define VA_PROGRESSIVE 0x1
 796 /*
 797  * vaCreateContext - Create a context
 798  *  dpy: display
 799  *  config_id: configuration for the context
 800  *  picture_width: coded picture width
 801  *  picture_height: coded picture height
 802  *  flag: any combination of the following:
 803  *    VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
 804  *  render_targets: render targets (surfaces) tied to the context
 805  *  num_render_targets: number of render targets in the above array
 806  *  context: created context id upon return
 807  */
 808 VAStatus vaCreateContext (
 809     VADisplay dpy,
 810     VAConfigID config_id,
 811     int picture_width,
 812     int picture_height,
 813     int flag,
 814     VASurfaceID *render_targets,
 815     int num_render_targets,
 816     VAContextID *context                /* out */
 817 );
 818
 819 /*
 820  * vaDestroyContext - Destroy a context
 821  *  dpy: display
 822  *  context: context to be destroyed
 823  */
 824 VAStatus vaDestroyContext (
 825     VADisplay dpy,
 826     VAContextID context
 827 );
 828
 829 /*
 830  * Buffers
 831  * Buffers are used to pass various types of data from the
 832  * client to the server. The server maintains a data store
 833  * for each buffer created, and the client idenfies a buffer
 834  * through a unique buffer id assigned by the server.
 835  */
 836
 837 typedef VAGenericID VABufferID;
 838
 839 typedef enum
 840 {
 841     VAPictureParameterBufferType        = 0,
 842     VAIQMatrixBufferType                = 1,
 843     VABitPlaneBufferType                = 2,
 844     VASliceGroupMapBufferType           = 3,
 845     VASliceParameterBufferType          = 4,
 846     VASliceDataBufferType               = 5,
 847     VAMacroblockParameterBufferType     = 6,
 848     VAResidualDataBufferType            = 7,
 849     VADeblockingParameterBufferType     = 8,
 850     VAImageBufferType                   = 9,
 851     VAProtectedSliceDataBufferType      = 10,
 852     VAQMatrixBufferType                 = 11,
 853     VAHuffmanTableBufferType            = 12,
 854
 855 /* Following are encode buffer types */
 856     VAEncCodedBufferType                = 21,
 857     VAEncSequenceParameterBufferType    = 22,
 858     VAEncPictureParameterBufferType     = 23,
 859     VAEncSliceParameterBufferType       = 24,
 860     VAEncPackedHeaderParameterBufferType = 25,
 861     VAEncPackedHeaderDataBufferType     = 26,
 862     VAEncMiscParameterBufferType        = 27,
 863     VAEncMacroblockParameterBufferType  = 28,
 864 /* Following are video processing buffer types */
 865     /**
 866      * \brief Video processing pipeline parameter buffer.
 867      *
 868      * This buffer describes the video processing pipeline. See
 869      * #VAProcPipelineParameterBuffer for details.
 870      */
 871     VAProcPipelineParameterBufferType   = 41,
 872     /**
 873      * \brief Video filter parameter buffer.
 874      *
 875      * This buffer describes the video filter parameters. All buffers
 876      * inherit from #VAProcFilterParameterBufferBase, thus including
 877      * a unique filter buffer type.
 878      *
 879      * The default buffer used by most filters is #VAProcFilterParameterBuffer.
 880      * Filters requiring advanced parameters include, but are not limited to,
 881      * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
 882      * color balance (#VAProcFilterParameterBufferColorBalance), etc.
 883      */
 884     VAProcFilterParameterBufferType     = 42,
 885     VABufferTypeMax
 886 } VABufferType;
 887
 888 typedef enum
 889 {
 890     VAEncMiscParameterTypeFrameRate     = 0,
 891     VAEncMiscParameterTypeRateControl   = 1,
 892     VAEncMiscParameterTypeMaxSliceSize  = 2,
 893     VAEncMiscParameterTypeAIR           = 3,
 894     /** \brief Buffer type used to express a maximum frame size (in bits). */
 895     VAEncMiscParameterTypeMaxFrameSize  = 4,
 896     /** \brief Buffer type used for HRD parameters. */
 897     VAEncMiscParameterTypeHRD           = 5,
 898 } VAEncMiscParameterType;
 899
 900 /** \brief Packed header type. */
 901 typedef enum {
 902     /** \brief Packed sequence header. */
 903     VAEncPackedHeaderSequence   = 1,
 904     /** \brief Packed picture header. */
 905     VAEncPackedHeaderPicture    = 2,
 906     /** \brief Packed slice header. */
 907     VAEncPackedHeaderSlice      = 3,
 908     /**
 909      * \brief Packed raw header.
 910      *
 911      * Packed raw data header can be used by the client to insert a header
 912      * into the bitstream data buffer at the point it is passed, the driver
 913      * will handle the raw packed header based on "has_emulation_bytes" field
 914      * in the packed header parameter structure.
 915      */
 916     VAEncPackedHeaderRawData    = 4,
 917     /** \brief Misc packed header. See codec-specific definitions. */
 918     VAEncPackedHeaderMiscMask   = 0x80000000,
 919 } VAEncPackedHeaderType;
 920
 921 /** \brief Packed header parameter. */
 922 typedef struct _VAEncPackedHeaderParameterBuffer {
 923     /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
 924     unsigned int                type;
 925     /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
 926     unsigned int                bit_length;
 927     /** \brief Flag: buffer contains start code emulation prevention bytes? */
 928     unsigned char               has_emulation_bytes;
 929 } VAEncPackedHeaderParameterBuffer;
 930
 931 /*
 932  *  For application, e.g. set a new bitrate
 933  *    VABufferID buf_id;
 934  *    VAEncMiscParameterBuffer *misc_param;
 935  *    VAEncMiscParameterRateControl *misc_rate_ctrl;
 936  *
 937  *    vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
 938  *              sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
 939  *              1, NULL, &buf_id);
 940  *
 941  *    vaMapBuffer(dpy,buf_id,(void **)&misc_param);
 942  *    misc_param->type = VAEncMiscParameterTypeRateControl;
 943  *    misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
 944  *    misc_rate_ctrl->bits_per_second = 6400000;
 945  *    vaUnmapBuffer(dpy, buf_id);
 946  *    vaRenderPicture(dpy, context, &buf_id, 1);
 947  */
 948 typedef struct _VAEncMiscParameterBuffer
 949 {
 950     VAEncMiscParameterType type;
 951     unsigned int data[0];
 952 } VAEncMiscParameterBuffer;
 953
 954
 955 /** \brief Rate control parameters */
 956 typedef struct _VAEncMiscParameterRateControl
 957 {
 958     /* this is the maximum bit-rate to be constrained by the rate control implementation */
 959     unsigned int bits_per_second;
 960     /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
 961      * bit-rate for example if target_percentage is 95 then the rate control will target
 962      * a bit-rate that is 95% of the maximum bit-rate
 963      */
 964     unsigned int target_percentage;
 965     /* windows size in milliseconds. For example if this is set to 500,
 966      * then the rate control will guarantee the target bit-rate over a 500 ms window
 967      */
 968     unsigned int window_size;
 969     /* initial QP at I frames */
 970     unsigned int initial_qp;
 971     unsigned int min_qp;
 972     unsigned int basic_unit_size;
 973     union
 974     {
 975         struct
 976         {
 977             unsigned int reset : 1;
 978             unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
 979             unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
 980         } bits;
 981         unsigned int value;
 982     } rc_flags;
 983 } VAEncMiscParameterRateControl;
 984
 985 typedef struct _VAEncMiscParameterFrameRate
 986 {
 987     unsigned int framerate;
 988 } VAEncMiscParameterFrameRate;
 989
 990 /*
 991  * Allow a maximum slice size to be specified (in bits).
 992  * The encoder will attempt to make sure that individual slices do not exceed this size
 993  * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
 994  */
 995 typedef struct _VAEncMiscParameterMaxSliceSize
 996 {
 997     unsigned int max_slice_size;
 998 } VAEncMiscParameterMaxSliceSize;
 999
1000 typedef struct _VAEncMiscParameterAIR
1001 {
1002     unsigned int air_num_mbs;
1003     unsigned int air_threshold;
1004     unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1005 } VAEncMiscParameterAIR;
1006
1007 typedef struct _VAEncMiscParameterHRD
1008 {
1009     unsigned int initial_buffer_fullness;       /* in bits */
1010     unsigned int buffer_size;                   /* in bits */
1011 } VAEncMiscParameterHRD;
1012
1013 /**
1014  * \brief Defines a maximum frame size (in bits).
1015  *
1016  * This misc parameter buffer defines the maximum size of a frame (in
1017  * bits). The encoder will try to make sure that each frame does not
1018  * exceed this size. Otherwise, if the frame size exceeds this size,
1019  * the \c status flag of #VACodedBufferSegment will contain
1020  * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1021  */
1022 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1023     /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1024     VAEncMiscParameterType      type;
1025     /** \brief Maximum size of a frame (in bits). */
1026     unsigned int                max_frame_size;
1027 } VAEncMiscParameterBufferMaxFrameSize;
1028
1029 /*
1030  * There will be cases where the bitstream buffer will not have enough room to hold
1031  * the data for the entire slice, and the following flags will be used in the slice
1032  * parameter to signal to the server for the possible cases.
1033  * If a slice parameter buffer and slice data buffer pair is sent to the server with
1034  * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1035  * then a slice parameter and data buffer needs to be sent again to complete this slice.
1036  */
1037 #define VA_SLICE_DATA_FLAG_ALL          0x00    /* whole slice is in the buffer */
1038 #define VA_SLICE_DATA_FLAG_BEGIN        0x01    /* The beginning of the slice is in the buffer but the end if not */
1039 #define VA_SLICE_DATA_FLAG_MIDDLE       0x02    /* Neither beginning nor end of the slice is in the buffer */
1040 #define VA_SLICE_DATA_FLAG_END          0x04    /* end of the slice is in the buffer */
1041
1042 /* Codec-independent Slice Parameter Buffer base */
1043 typedef struct _VASliceParameterBufferBase
1044 {
1045     unsigned int slice_data_size;       /* number of bytes in the slice data buffer for this slice */
1046     unsigned int slice_data_offset;     /* the offset to the first byte of slice data */
1047     unsigned int slice_data_flag;       /* see VA_SLICE_DATA_FLAG_XXX definitions */
1048 } VASliceParameterBufferBase;
1049
1050
1051 /****************************
1052  * JEPG data structure
1053  ***************************/
1054 typedef struct _VAQMatrixBufferJPEG
1055 {
1056     int load_lum_quantiser_matrix;
1057     int load_chroma_quantiser_matrix;
1058     unsigned char lum_quantiser_matrix[64];
1059     unsigned char chroma_quantiser_matrix[64];
1060 } VAQMatrixBufferJPEG;
1061
1062 typedef struct _VAEncPictureParameterBufferJPEG
1063 {
1064     VASurfaceID reconstructed_picture;
1065     unsigned short picture_width;
1066     unsigned short picture_height;
1067     VABufferID coded_buf;
1068 } VAEncPictureParameterBufferJPEG;
1069
1070 #include <va/va_dec_jpeg.h>
1071
1072 /****************************
1073  * MPEG-2 data structures
1074  ****************************/
1075
1076 /* MPEG-2 Picture Parameter Buffer */
1077 /*
1078  * For each frame or field, and before any slice data, a single
1079  * picture parameter buffer must be send.
1080  */
1081 typedef struct _VAPictureParameterBufferMPEG2
1082 {
1083     unsigned short horizontal_size;
1084     unsigned short vertical_size;
1085     VASurfaceID forward_reference_picture;
1086     VASurfaceID backward_reference_picture;
1087     /* meanings of the following fields are the same as in the standard */
1088     int picture_coding_type;
1089     int f_code; /* pack all four fcode into this */
1090     union {
1091         struct {
1092             unsigned int intra_dc_precision             : 2;
1093             unsigned int picture_structure              : 2;
1094             unsigned int top_field_first                : 1;
1095             unsigned int frame_pred_frame_dct           : 1;
1096             unsigned int concealment_motion_vectors     : 1;
1097             unsigned int q_scale_type                   : 1;
1098             unsigned int intra_vlc_format               : 1;
1099             unsigned int alternate_scan                 : 1;
1100             unsigned int repeat_first_field             : 1;
1101             unsigned int progressive_frame              : 1;
1102             unsigned int is_first_field                 : 1; /* indicate whether the current field
1103                                                               * is the first field for field picture
1104                                                               */
1105         } bits;
1106         unsigned int value;
1107     } picture_coding_extension;
1108 } VAPictureParameterBufferMPEG2;
1109
1110 /* MPEG-2 Inverse Quantization Matrix Buffer */
1111 typedef struct _VAIQMatrixBufferMPEG2
1112 {
1113     int load_intra_quantiser_matrix;
1114     int load_non_intra_quantiser_matrix;
1115     int load_chroma_intra_quantiser_matrix;
1116     int load_chroma_non_intra_quantiser_matrix;
1117     unsigned char intra_quantiser_matrix[64];
1118     unsigned char non_intra_quantiser_matrix[64];
1119     unsigned char chroma_intra_quantiser_matrix[64];
1120     unsigned char chroma_non_intra_quantiser_matrix[64];
1121 } VAIQMatrixBufferMPEG2;
1122
1123 /* MPEG-2 Slice Parameter Buffer */
1124 typedef struct _VASliceParameterBufferMPEG2
1125 {
1126     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1127     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1128     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1129     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1130     unsigned int slice_horizontal_position;
1131     unsigned int slice_vertical_position;
1132     int quantiser_scale_code;
1133     int intra_slice_flag;
1134 } VASliceParameterBufferMPEG2;
1135
1136 /* MPEG-2 Macroblock Parameter Buffer */
1137 typedef struct _VAMacroblockParameterBufferMPEG2
1138 {
1139     unsigned short macroblock_address;
1140     /*
1141      * macroblock_address (in raster scan order)
1142      * top-left: 0
1143      * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1144      */
1145     unsigned char macroblock_type;  /* see definition below */
1146     union {
1147         struct {
1148             unsigned int frame_motion_type              : 2;
1149             unsigned int field_motion_type              : 2;
1150             unsigned int dct_type                       : 1;
1151         } bits;
1152         unsigned int value;
1153     } macroblock_modes;
1154     unsigned char motion_vertical_field_select;
1155     /*
1156      * motion_vertical_field_select:
1157      * see section 6.3.17.2 in the spec
1158      * only the lower 4 bits are used
1159      * bit 0: first vector forward
1160      * bit 1: first vector backward
1161      * bit 2: second vector forward
1162      * bit 3: second vector backward
1163      */
1164     short PMV[2][2][2]; /* see Table 7-7 in the spec */
1165     unsigned short coded_block_pattern;
1166     /*
1167      * The bitplanes for coded_block_pattern are described
1168      * in Figure 6.10-12 in the spec
1169      */
1170
1171     /* Number of skipped macroblocks after this macroblock */
1172     unsigned short num_skipped_macroblocks;
1173 } VAMacroblockParameterBufferMPEG2;
1174
1175 /*
1176  * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1177  */
1178 #define VA_MB_TYPE_MOTION_FORWARD       0x02
1179 #define VA_MB_TYPE_MOTION_BACKWARD      0x04
1180 #define VA_MB_TYPE_MOTION_PATTERN       0x08
1181 #define VA_MB_TYPE_MOTION_INTRA         0x10
1182
1183 /*
1184  * MPEG-2 Residual Data Buffer
1185  * For each macroblock, there wil be 64 shorts (16-bit) in the
1186  * residual data buffer
1187  */
1188
1189 /****************************
1190  * MPEG-4 Part 2 data structures
1191  ****************************/
1192
1193 /* MPEG-4 Picture Parameter Buffer */
1194 /*
1195  * For each frame or field, and before any slice data, a single
1196  * picture parameter buffer must be send.
1197  */
1198 typedef struct _VAPictureParameterBufferMPEG4
1199 {
1200     unsigned short vop_width;
1201     unsigned short vop_height;
1202     VASurfaceID forward_reference_picture;
1203     VASurfaceID backward_reference_picture;
1204     union {
1205         struct {
1206             unsigned int short_video_header             : 1;
1207             unsigned int chroma_format                  : 2;
1208             unsigned int interlaced                     : 1;
1209             unsigned int obmc_disable                   : 1;
1210             unsigned int sprite_enable                  : 2;
1211             unsigned int sprite_warping_accuracy        : 2;
1212             unsigned int quant_type                     : 1;
1213             unsigned int quarter_sample                 : 1;
1214             unsigned int data_partitioned               : 1;
1215             unsigned int reversible_vlc                 : 1;
1216             unsigned int resync_marker_disable          : 1;
1217         } bits;
1218         unsigned int value;
1219     } vol_fields;
1220     unsigned char no_of_sprite_warping_points;
1221     short sprite_trajectory_du[3];
1222     short sprite_trajectory_dv[3];
1223     unsigned char quant_precision;
1224     union {
1225         struct {
1226             unsigned int vop_coding_type                : 2;
1227             unsigned int backward_reference_vop_coding_type     : 2;
1228             unsigned int vop_rounding_type              : 1;
1229             unsigned int intra_dc_vlc_thr               : 3;
1230             unsigned int top_field_first                : 1;
1231             unsigned int alternate_vertical_scan_flag   : 1;
1232         } bits;
1233         unsigned int value;
1234     } vop_fields;
1235     unsigned char vop_fcode_forward;
1236     unsigned char vop_fcode_backward;
1237     unsigned short vop_time_increment_resolution;
1238     /* short header related */
1239     unsigned char num_gobs_in_vop;
1240     unsigned char num_macroblocks_in_gob;
1241     /* for direct mode prediction */
1242     short TRB;
1243     short TRD;
1244 } VAPictureParameterBufferMPEG4;
1245
1246 /* MPEG-4 Inverse Quantization Matrix Buffer */
1247 typedef struct _VAIQMatrixBufferMPEG4
1248 {
1249     int load_intra_quant_mat;
1250     int load_non_intra_quant_mat;
1251     unsigned char intra_quant_mat[64];
1252     unsigned char non_intra_quant_mat[64];
1253 } VAIQMatrixBufferMPEG4;
1254
1255 /* MPEG-4 Slice Parameter Buffer */
1256 typedef struct _VASliceParameterBufferMPEG4
1257 {
1258     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1259     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1260     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1261     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1262     unsigned int macroblock_number;
1263     int quant_scale;
1264 } VASliceParameterBufferMPEG4;
1265
1266 /*
1267  VC-1 data structures
1268 */
1269
1270 typedef enum   /* see 7.1.1.32 */
1271 {
1272     VAMvMode1Mv                        = 0,
1273     VAMvMode1MvHalfPel                 = 1,
1274     VAMvMode1MvHalfPelBilinear         = 2,
1275     VAMvModeMixedMv                    = 3,
1276     VAMvModeIntensityCompensation      = 4
1277 } VAMvModeVC1;
1278
1279 /* VC-1 Picture Parameter Buffer */
1280 /*
1281  * For each picture, and before any slice data, a picture parameter
1282  * buffer must be send. Multiple picture parameter buffers may be
1283  * sent for a single picture. In that case picture parameters will
1284  * apply to all slice data that follow it until a new picture
1285  * parameter buffer is sent.
1286  *
1287  * Notes:
1288  *   pic_quantizer_type should be set to the applicable quantizer
1289  *   type as defined by QUANTIZER (J.1.19) and either
1290  *   PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1291  */
1292 typedef struct _VAPictureParameterBufferVC1
1293 {
1294     VASurfaceID forward_reference_picture;
1295     VASurfaceID backward_reference_picture;
1296     /* if out-of-loop post-processing is done on the render
1297        target, then we need to keep the in-loop decoded
1298        picture as a reference picture */
1299     VASurfaceID inloop_decoded_picture;
1300
1301     /* sequence layer for AP or meta data for SP and MP */
1302     union {
1303         struct {
1304             unsigned int pulldown       : 1; /* SEQUENCE_LAYER::PULLDOWN */
1305             unsigned int interlace      : 1; /* SEQUENCE_LAYER::INTERLACE */
1306             unsigned int tfcntrflag     : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1307             unsigned int finterpflag    : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1308             unsigned int psf            : 1; /* SEQUENCE_LAYER::PSF */
1309             unsigned int multires       : 1; /* METADATA::MULTIRES */
1310             unsigned int overlap        : 1; /* METADATA::OVERLAP */
1311             unsigned int syncmarker     : 1; /* METADATA::SYNCMARKER */
1312             unsigned int rangered       : 1; /* METADATA::RANGERED */
1313             unsigned int max_b_frames   : 3; /* METADATA::MAXBFRAMES */
1314             unsigned int profile        : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1315         } bits;
1316         unsigned int value;
1317     } sequence_fields;
1318
1319     unsigned short coded_width;         /* ENTRY_POINT_LAYER::CODED_WIDTH */
1320     unsigned short coded_height;        /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1321     union {
1322         struct {
1323             unsigned int broken_link    : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1324             unsigned int closed_entry   : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1325             unsigned int panscan_flag   : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1326             unsigned int loopfilter     : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1327         } bits;
1328         unsigned int value;
1329     } entrypoint_fields;
1330     unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1331     unsigned char fast_uvmc_flag;       /* ENTRY_POINT_LAYER::FASTUVMC */
1332     union {
1333         struct {
1334             unsigned int luma_flag      : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1335             unsigned int luma           : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1336             unsigned int chroma_flag    : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1337             unsigned int chroma         : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1338         } bits;
1339         unsigned int value;
1340     } range_mapping_fields;
1341
1342     unsigned char b_picture_fraction;   /* PICTURE_LAYER::BFRACTION */
1343     unsigned char cbp_table;            /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1344     unsigned char mb_mode_table;        /* PICTURE_LAYER::MBMODETAB */
1345     unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1346     unsigned char rounding_control;     /* PICTURE_LAYER::RNDCTRL */
1347     unsigned char post_processing;      /* PICTURE_LAYER::POSTPROC */
1348     unsigned char picture_resolution_index;     /* PICTURE_LAYER::RESPIC */
1349     unsigned char luma_scale;           /* PICTURE_LAYER::LUMSCALE */
1350     unsigned char luma_shift;           /* PICTURE_LAYER::LUMSHIFT */
1351     union {
1352         struct {
1353             unsigned int picture_type           : 3; /* PICTURE_LAYER::PTYPE */
1354             unsigned int frame_coding_mode      : 3; /* PICTURE_LAYER::FCM */
1355             unsigned int top_field_first        : 1; /* PICTURE_LAYER::TFF */
1356             unsigned int is_first_field         : 1; /* set to 1 if it is the first field */
1357             unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1358         } bits;
1359         unsigned int value;
1360     } picture_fields;
1361     union {
1362         struct {
1363             unsigned int mv_type_mb     : 1;    /* PICTURE::MVTYPEMB */
1364             unsigned int direct_mb      : 1;    /* PICTURE::DIRECTMB */
1365             unsigned int skip_mb        : 1;    /* PICTURE::SKIPMB */
1366             unsigned int field_tx       : 1;    /* PICTURE::FIELDTX */
1367             unsigned int forward_mb     : 1;    /* PICTURE::FORWARDMB */
1368             unsigned int ac_pred        : 1;    /* PICTURE::ACPRED */
1369             unsigned int overflags      : 1;    /* PICTURE::OVERFLAGS */
1370         } flags;
1371         unsigned int value;
1372     } raw_coding;
1373     union {
1374         struct {
1375             unsigned int bp_mv_type_mb   : 1;    /* PICTURE::MVTYPEMB */
1376             unsigned int bp_direct_mb    : 1;    /* PICTURE::DIRECTMB */
1377             unsigned int bp_skip_mb      : 1;    /* PICTURE::SKIPMB */
1378             unsigned int bp_field_tx     : 1;    /* PICTURE::FIELDTX */
1379             unsigned int bp_forward_mb   : 1;    /* PICTURE::FORWARDMB */
1380             unsigned int bp_ac_pred      : 1;    /* PICTURE::ACPRED */
1381             unsigned int bp_overflags    : 1;    /* PICTURE::OVERFLAGS */
1382         } flags;
1383         unsigned int value;
1384     } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1385     union {
1386         struct {
1387             unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1388             unsigned int reference_distance     : 5;/* PICTURE_LAYER::REFDIST */
1389             unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1390             unsigned int reference_field_pic_indicator  : 1;/* PICTURE_LAYER::REFFIELD */
1391         } bits;
1392         unsigned int value;
1393     } reference_fields;
1394     union {
1395         struct {
1396             unsigned int mv_mode                : 3; /* PICTURE_LAYER::MVMODE */
1397             unsigned int mv_mode2               : 3; /* PICTURE_LAYER::MVMODE2 */
1398             unsigned int mv_table               : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1399             unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1400             unsigned int four_mv_switch         : 1; /* PICTURE_LAYER::4MVSWITCH */
1401             unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1402             unsigned int extended_mv_flag       : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1403             unsigned int extended_mv_range      : 2; /* PICTURE_LAYER::MVRANGE */
1404             unsigned int extended_dmv_flag      : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1405             unsigned int extended_dmv_range     : 2; /* PICTURE_LAYER::DMVRANGE */
1406         } bits;
1407         unsigned int value;
1408     } mv_fields;
1409     union {
1410         struct {
1411             unsigned int dquant : 2;    /* ENTRY_POINT_LAYER::DQUANT */
1412             unsigned int quantizer     : 2;     /* ENTRY_POINT_LAYER::QUANTIZER */
1413             unsigned int half_qp        : 1;    /* PICTURE_LAYER::HALFQP */
1414             unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1415             unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1416             unsigned int dq_frame       : 1;    /* VOPDQUANT::DQUANTFRM */
1417             unsigned int dq_profile     : 2;    /* VOPDQUANT::DQPROFILE */
1418             unsigned int dq_sb_edge     : 2;    /* VOPDQUANT::DQSBEDGE */
1419             unsigned int dq_db_edge     : 2;    /* VOPDQUANT::DQDBEDGE */
1420             unsigned int dq_binary_level : 1;   /* VOPDQUANT::DQBILEVEL */
1421             unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1422         } bits;
1423         unsigned int value;
1424     } pic_quantizer_fields;
1425     union {
1426         struct {
1427             unsigned int variable_sized_transform_flag  : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1428             unsigned int mb_level_transform_type_flag   : 1;/* PICTURE_LAYER::TTMBF */
1429             unsigned int frame_level_transform_type     : 2;/* PICTURE_LAYER::TTFRM */
1430             unsigned int transform_ac_codingset_idx1    : 2;/* PICTURE_LAYER::TRANSACFRM */
1431             unsigned int transform_ac_codingset_idx2    : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1432             unsigned int intra_transform_dc_table       : 1;/* PICTURE_LAYER::TRANSDCTAB */
1433         } bits;
1434         unsigned int value;
1435     } transform_fields;
1436 } VAPictureParameterBufferVC1;
1437
1438 /* VC-1 Bitplane Buffer
1439 There will be at most three bitplanes coded in any picture header. To send
1440 the bitplane data more efficiently, each byte is divided in two nibbles, with
1441 each nibble carrying three bitplanes for one macroblock.  The following table
1442 shows the bitplane data arrangement within each nibble based on the picture
1443 type.
1444
1445 Picture Type    Bit3            Bit2            Bit1            Bit0
1446 I or BI                         OVERFLAGS       ACPRED          FIELDTX
1447 P                               MYTYPEMB        SKIPMB          DIRECTMB
1448 B                               FORWARDMB       SKIPMB          DIRECTMB
1449
1450 Within each byte, the lower nibble is for the first MB and the upper nibble is
1451 for the second MB.  E.g. the lower nibble of the first byte in the bitplane
1452 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1453 Macroblock #2 in the first row.
1454 */
1455
1456 /* VC-1 Slice Parameter Buffer */
1457 typedef struct _VASliceParameterBufferVC1
1458 {
1459     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1460     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1461     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1462     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1463     unsigned int slice_vertical_position;
1464 } VASliceParameterBufferVC1;
1465
1466 /* VC-1 Slice Data Buffer */
1467 /*
1468 This is simplely a buffer containing raw bit-stream bytes
1469 */
1470
1471 /****************************
1472  * H.264/AVC data structures
1473  ****************************/
1474
1475 typedef struct _VAPictureH264
1476 {
1477     VASurfaceID picture_id;
1478     unsigned int frame_idx;
1479     unsigned int flags;
1480     signed int TopFieldOrderCnt;
1481     signed int BottomFieldOrderCnt;
1482 } VAPictureH264;
1483 /* flags in VAPictureH264 could be OR of the following */
1484 #define VA_PICTURE_H264_INVALID                 0x00000001
1485 #define VA_PICTURE_H264_TOP_FIELD               0x00000002
1486 #define VA_PICTURE_H264_BOTTOM_FIELD            0x00000004
1487 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE    0x00000008
1488 #define VA_PICTURE_H264_LONG_TERM_REFERENCE     0x00000010
1489
1490 /* H.264 Picture Parameter Buffer */
1491 /*
1492  * For each picture, and before any slice data, a single
1493  * picture parameter buffer must be send.
1494  */
1495 typedef struct _VAPictureParameterBufferH264
1496 {
1497     VAPictureH264 CurrPic;
1498     VAPictureH264 ReferenceFrames[16];  /* in DPB */
1499     unsigned short picture_width_in_mbs_minus1;
1500     unsigned short picture_height_in_mbs_minus1;
1501     unsigned char bit_depth_luma_minus8;
1502     unsigned char bit_depth_chroma_minus8;
1503     unsigned char num_ref_frames;
1504     union {
1505         struct {
1506             unsigned int chroma_format_idc                      : 2;
1507             unsigned int residual_colour_transform_flag         : 1;
1508             unsigned int gaps_in_frame_num_value_allowed_flag   : 1;
1509             unsigned int frame_mbs_only_flag                    : 1;
1510             unsigned int mb_adaptive_frame_field_flag           : 1;
1511             unsigned int direct_8x8_inference_flag              : 1;
1512             unsigned int MinLumaBiPredSize8x8                   : 1; /* see A.3.3.2 */
1513             unsigned int log2_max_frame_num_minus4              : 4;
1514             unsigned int pic_order_cnt_type                     : 2;
1515             unsigned int log2_max_pic_order_cnt_lsb_minus4      : 4;
1516             unsigned int delta_pic_order_always_zero_flag       : 1;
1517         } bits;
1518         unsigned int value;
1519     } seq_fields;
1520     unsigned char num_slice_groups_minus1;
1521     unsigned char slice_group_map_type;
1522     unsigned short slice_group_change_rate_minus1;
1523     signed char pic_init_qp_minus26;
1524     signed char pic_init_qs_minus26;
1525     signed char chroma_qp_index_offset;
1526     signed char second_chroma_qp_index_offset;
1527     union {
1528         struct {
1529             unsigned int entropy_coding_mode_flag       : 1;
1530             unsigned int weighted_pred_flag             : 1;
1531             unsigned int weighted_bipred_idc            : 2;
1532             unsigned int transform_8x8_mode_flag        : 1;
1533             unsigned int field_pic_flag                 : 1;
1534             unsigned int constrained_intra_pred_flag    : 1;
1535             unsigned int pic_order_present_flag                 : 1;
1536             unsigned int deblocking_filter_control_present_flag : 1;
1537             unsigned int redundant_pic_cnt_present_flag         : 1;
1538             unsigned int reference_pic_flag                     : 1; /* nal_ref_idc != 0 */
1539         } bits;
1540         unsigned int value;
1541     } pic_fields;
1542     unsigned short frame_num;
1543 } VAPictureParameterBufferH264;
1544
1545 /* H.264 Inverse Quantization Matrix Buffer */
1546 typedef struct _VAIQMatrixBufferH264
1547 {
1548     unsigned char ScalingList4x4[6][16];
1549     unsigned char ScalingList8x8[2][64];
1550 } VAIQMatrixBufferH264;
1551
1552 /*
1553  * H.264 Slice Group Map Buffer
1554  * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1555  * A slice group map buffer should be sent for each picture if required. The buffer
1556  * is sent only when there is a change in the mapping values.
1557  * The slice group map buffer map "map units" to slice groups as specified in
1558  * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1559  * in raster scan order
1560  */
1561
1562 /* H.264 Slice Parameter Buffer */
1563 typedef struct _VASliceParameterBufferH264
1564 {
1565     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1566     /** \brief Byte offset to the NAL Header Unit for this slice. */
1567     unsigned int slice_data_offset;
1568     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1569     /**
1570      * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1571      *
1572      * This bit offset is relative to and includes the NAL unit byte
1573      * and represents the number of bits parsed in the slice_header()
1574      * after the removal of any emulation prevention bytes in
1575      * there. However, the slice data buffer passed to the hardware is
1576      * the original bitstream, thus including any emulation prevention
1577      * bytes.
1578      */
1579     unsigned short slice_data_bit_offset;
1580     unsigned short first_mb_in_slice;
1581     unsigned char slice_type;
1582     unsigned char direct_spatial_mv_pred_flag;
1583     unsigned char num_ref_idx_l0_active_minus1;
1584     unsigned char num_ref_idx_l1_active_minus1;
1585     unsigned char cabac_init_idc;
1586     char slice_qp_delta;
1587     unsigned char disable_deblocking_filter_idc;
1588     char slice_alpha_c0_offset_div2;
1589     char slice_beta_offset_div2;
1590     VAPictureH264 RefPicList0[32];      /* See 8.2.4.2 */
1591     VAPictureH264 RefPicList1[32];      /* See 8.2.4.2 */
1592     unsigned char luma_log2_weight_denom;
1593     unsigned char chroma_log2_weight_denom;
1594     unsigned char luma_weight_l0_flag;
1595     short luma_weight_l0[32];
1596     short luma_offset_l0[32];
1597     unsigned char chroma_weight_l0_flag;
1598     short chroma_weight_l0[32][2];
1599     short chroma_offset_l0[32][2];
1600     unsigned char luma_weight_l1_flag;
1601     short luma_weight_l1[32];
1602     short luma_offset_l1[32];
1603     unsigned char chroma_weight_l1_flag;
1604     short chroma_weight_l1[32][2];
1605     short chroma_offset_l1[32][2];
1606 } VASliceParameterBufferH264;
1607
1608 /****************************
1609  * Common encode data structures
1610  ****************************/
1611 typedef enum
1612 {
1613     VAEncPictureTypeIntra               = 0,
1614     VAEncPictureTypePredictive          = 1,
1615     VAEncPictureTypeBidirectional       = 2,
1616 } VAEncPictureType;
1617
1618 /* Encode Slice Parameter Buffer */
1619 typedef struct _VAEncSliceParameterBuffer
1620 {
1621     unsigned int start_row_number;      /* starting MB row number for this slice */
1622     unsigned int slice_height;  /* slice height measured in MB */
1623     union {
1624         struct {
1625             unsigned int is_intra       : 1;
1626             unsigned int disable_deblocking_filter_idc : 2;
1627             unsigned int uses_long_term_ref             :1;
1628             unsigned int is_long_term_ref               :1;
1629         } bits;
1630         unsigned int value;
1631     } slice_flags;
1632 } VAEncSliceParameterBuffer;
1633
1634
1635 /****************************
1636  * H.263 specific encode data structures
1637  ****************************/
1638
1639 typedef struct _VAEncSequenceParameterBufferH263
1640 {
1641     unsigned int intra_period;
1642     unsigned int bits_per_second;
1643     unsigned int frame_rate;
1644     unsigned int initial_qp;
1645     unsigned int min_qp;
1646 } VAEncSequenceParameterBufferH263;
1647
1648 typedef struct _VAEncPictureParameterBufferH263
1649 {
1650     VASurfaceID reference_picture;
1651     VASurfaceID reconstructed_picture;
1652     VABufferID coded_buf;
1653     unsigned short picture_width;
1654     unsigned short picture_height;
1655     VAEncPictureType picture_type;
1656 } VAEncPictureParameterBufferH263;
1657
1658 /****************************
1659  * MPEG-4 specific encode data structures
1660  ****************************/
1661
1662 typedef struct _VAEncSequenceParameterBufferMPEG4
1663 {
1664     unsigned char profile_and_level_indication;
1665     unsigned int intra_period;
1666     unsigned int video_object_layer_width;
1667     unsigned int video_object_layer_height;
1668     unsigned int vop_time_increment_resolution;
1669     unsigned int fixed_vop_rate;
1670     unsigned int fixed_vop_time_increment;
1671     unsigned int bits_per_second;
1672     unsigned int frame_rate;
1673     unsigned int initial_qp;
1674     unsigned int min_qp;
1675 } VAEncSequenceParameterBufferMPEG4;
1676
1677 typedef struct _VAEncPictureParameterBufferMPEG4
1678 {
1679     VASurfaceID reference_picture;
1680     VASurfaceID reconstructed_picture;
1681     VABufferID coded_buf;
1682     unsigned short picture_width;
1683     unsigned short picture_height;
1684     unsigned int modulo_time_base; /* number of 1s */
1685     unsigned int vop_time_increment;
1686     VAEncPictureType picture_type;
1687 } VAEncPictureParameterBufferMPEG4;
1688
1689
1690
1691 /* Buffer functions */
1692
1693 /*
1694  * Creates a buffer for "num_elements" elements of "size" bytes and
1695  * initalize with "data".
1696  * if "data" is null, then the contents of the buffer data store
1697  * are undefined.
1698  * Basically there are two ways to get buffer data to the server side. One is
1699  * to call vaCreateBuffer() with a non-null "data", which results the data being
1700  * copied to the data store on the server side.  A different method that
1701  * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1702  * and then use vaMapBuffer() to map the data store from the server side to the
1703  * client address space for access.
1704  *  Note: image buffers are created by the library, not the client. Please see
1705  *        vaCreateImage on how image buffers are managed.
1706  */
1707 VAStatus vaCreateBuffer (
1708     VADisplay dpy,
1709     VAContextID context,
1710     VABufferType type,  /* in */
1711     unsigned int size,  /* in */
1712     unsigned int num_elements, /* in */
1713     void *data,         /* in */
1714     VABufferID *buf_id  /* out */
1715 );
1716
1717 /*
1718  * Convey to the server how many valid elements are in the buffer.
1719  * e.g. if multiple slice parameters are being held in a single buffer,
1720  * this will communicate to the server the number of slice parameters
1721  * that are valid in the buffer.
1722  */
1723 VAStatus vaBufferSetNumElements (
1724     VADisplay dpy,
1725     VABufferID buf_id,  /* in */
1726     unsigned int num_elements /* in */
1727 );
1728
1729
1730 /*
1731  * device independent data structure for codedbuffer
1732  */
1733
1734 /*
1735  * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1736  * LARGE_SLICE(bit8):At least one slice in the current frame was large
1737  *              enough for the encoder to attempt to limit its size.
1738  * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1739  *              exceeded the maximum slice size specified.
1740  * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1741  * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1742  * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1743  */
1744 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK         0xff
1745 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK            0x100
1746 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK         0x200
1747 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW            0x400
1748 #define VA_CODED_BUF_STATUS_BITRATE_HIGH                0x800
1749 /**
1750  * \brief The frame has exceeded the maximum requested size.
1751  *
1752  * This flag indicates that the encoded frame size exceeds the value
1753  * specified through a misc parameter buffer of type
1754  * #VAEncMiscParameterTypeMaxFrameSize.
1755  */
1756 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW         0x1000
1757 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD       0xff0000
1758
1759 /**
1760  * \brief The coded buffer segment contains a single NAL unit.
1761  *
1762  * This flag indicates that the coded buffer segment contains a
1763  * single NAL unit. This flag might be useful to the user for
1764  * processing the coded buffer.
1765  */
1766 #define VA_CODED_BUF_STATUS_SINGLE_NALU                 0x10000000
1767
1768 /**
1769  * \brief Coded buffer segment.
1770  *
1771  * #VACodedBufferSegment is an element of a linked list describing
1772  * some information on the coded buffer. The coded buffer segment
1773  * could contain either a single NAL unit, or more than one NAL unit.
1774  * It is recommended (but not required) to return a single NAL unit
1775  * in a coded buffer segment, and the implementation should set the
1776  * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1777  */
1778 typedef  struct _VACodedBufferSegment  {
1779     /**
1780      * \brief Size of the data buffer in this segment (in bytes).
1781      */
1782     unsigned int        size;
1783     /** \brief Bit offset into the data buffer where the video data starts. */
1784     unsigned int        bit_offset;
1785     /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1786     unsigned int        status;
1787     /** \brief Reserved for future use. */
1788     unsigned int        reserved;
1789     /** \brief Pointer to the start of the data buffer. */
1790     void               *buf;
1791     /**
1792      * \brief Pointer to the next #VACodedBufferSegment element,
1793      * or \c NULL if there is none.
1794      */
1795     void               *next;
1796 } VACodedBufferSegment;
1797
1798 /*
1799  * Map data store of the buffer into the client's address space
1800  * vaCreateBuffer() needs to be called with "data" set to NULL before
1801  * calling vaMapBuffer()
1802  *
1803  * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1804  * VACodedBufferSegment, and the list is terminated if "next" is NULL
1805  */
1806 VAStatus vaMapBuffer (
1807     VADisplay dpy,
1808     VABufferID buf_id,  /* in */
1809     void **pbuf         /* out */
1810 );
1811
1812 /*
1813  * After client making changes to a mapped data store, it needs to
1814  * "Unmap" it to let the server know that the data is ready to be
1815  * consumed by the server
1816  */
1817 VAStatus vaUnmapBuffer (
1818     VADisplay dpy,
1819     VABufferID buf_id   /* in */
1820 );
1821
1822 /*
1823  * After this call, the buffer is deleted and this buffer_id is no longer valid
1824  * Only call this if the buffer is not going to be passed to vaRenderBuffer
1825  */
1826 VAStatus vaDestroyBuffer (
1827     VADisplay dpy,
1828     VABufferID buffer_id
1829 );
1830
1831 /*
1832 Render (Decode) Pictures
1833
1834 A picture represents either a frame or a field.
1835
1836 The Begin/Render/End sequence sends the decode buffers to the server
1837 */
1838
1839 /*
1840  * Get ready to decode a picture to a target surface
1841  */
1842 VAStatus vaBeginPicture (
1843     VADisplay dpy,
1844     VAContextID context,
1845     VASurfaceID render_target
1846 );
1847
1848 /*
1849  * Send decode buffers to the server.
1850  * Buffers are automatically destroyed afterwards
1851  */
1852 VAStatus vaRenderPicture (
1853     VADisplay dpy,
1854     VAContextID context,
1855     VABufferID *buffers,
1856     int num_buffers
1857 );
1858
1859 /*
1860  * Make the end of rendering for a picture.
1861  * The server should start processing all pending operations for this
1862  * surface. This call is non-blocking. The client can start another
1863  * Begin/Render/End sequence on a different render target.
1864  */
1865 VAStatus vaEndPicture (
1866     VADisplay dpy,
1867     VAContextID context
1868 );
1869
1870 /*
1871
1872 Synchronization
1873
1874 */
1875
1876 /*
1877  * This function blocks until all pending operations on the render target
1878  * have been completed.  Upon return it is safe to use the render target for a
1879  * different picture.
1880  */
1881 VAStatus vaSyncSurface (
1882     VADisplay dpy,
1883     VASurfaceID render_target
1884 );
1885
1886 typedef enum
1887 {
1888     VASurfaceRendering  = 1, /* Rendering in progress */
1889     VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1890                              /* this status is useful if surface is used as the source */
1891                              /* of an overlay */
1892     VASurfaceReady      = 4, /* not being rendered or displayed */
1893     VASurfaceSkipped    = 8  /* Indicate a skipped frame during encode */
1894 } VASurfaceStatus;
1895
1896 /*
1897  * Find out any pending ops on the render target
1898  */
1899 VAStatus vaQuerySurfaceStatus (
1900     VADisplay dpy,
1901     VASurfaceID render_target,
1902     VASurfaceStatus *status     /* out */
1903 );
1904
1905 typedef enum
1906 {
1907     VADecodeSliceMissing            = 0,
1908     VADecodeMBError                 = 1,
1909 } VADecodeErrorType;
1910
1911 /*
1912  * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1913  * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1914 */
1915 typedef struct _VASurfaceDecodeMBErrors
1916 {
1917     int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1918     unsigned int start_mb; /* start mb address with errors */
1919     unsigned int end_mb;  /* end mb address with errors */
1920     VADecodeErrorType decode_error_type;
1921 } VASurfaceDecodeMBErrors;
1922
1923 /*
1924  * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1925  * it can call vaQuerySurfaceError to find out further details on the particular error.
1926  * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1927  * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1928  * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1929  * The array is terminated if "status==-1" is detected.
1930  */
1931 VAStatus vaQuerySurfaceError(
1932     VADisplay dpy,
1933     VASurfaceID surface,
1934     VAStatus error_status,
1935     void **error_info
1936 );
1937
1938 /*
1939  * Images and Subpictures
1940  * VAImage is used to either get the surface data to client memory, or
1941  * to copy image data in client memory to a surface.
1942  * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1943  * is at the upper left corner with positive X to the right and positive Y down
1944  */
1945 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1946     ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1947     ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1948
1949 /*
1950  * Pre-defined fourcc codes
1951  */
1952 #define VA_FOURCC_NV12          0x3231564E
1953 #define VA_FOURCC_AI44          0x34344149
1954 #define VA_FOURCC_RGBA          0x41424752
1955 #define VA_FOURCC_RGBX          0x58424752
1956 #define VA_FOURCC_BGRA          0x41524742
1957 #define VA_FOURCC_BGRX          0x58524742
1958 #define VA_FOURCC_ARGB          0x42475241
1959 #define VA_FOURCC_XRGB          0x42475258
1960 #define VA_FOURCC_UYVY          0x59565955
1961 #define VA_FOURCC_YUY2          0x32595559
1962 #define VA_FOURCC_AYUV          0x56555941
1963 #define VA_FOURCC_NV11          0x3131564e
1964 #define VA_FOURCC_YV12          0x32315659
1965 #define VA_FOURCC_P208          0x38303250
1966 #define VA_FOURCC_IYUV          0x56555949
1967 #define VA_FOURCC_YV24          0x34325659
1968 #define VA_FOURCC_YV32          0x32335659
1969 #define VA_FOURCC_Y800          0x30303859
1970 #define VA_FOURCC_IMC3          0x33434D49
1971 #define VA_FOURCC_411P          0x50313134
1972 #define VA_FOURCC_422H          0x48323234
1973 #define VA_FOURCC_422V          0x56323234
1974 #define VA_FOURCC_444P          0x50343434
1975 #define VA_FOURCC_RGBP          0x50424752
1976 #define VA_FOURCC_BGRP          0x50524742
1977
1978 /* byte order */
1979 #define VA_LSB_FIRST            1
1980 #define VA_MSB_FIRST            2
1981
1982 typedef struct _VAImageFormat
1983 {
1984     unsigned int        fourcc;
1985     unsigned int        byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1986     unsigned int        bits_per_pixel;
1987     /* for RGB formats */
1988     unsigned int        depth; /* significant bits per pixel */
1989     unsigned int        red_mask;
1990     unsigned int        green_mask;
1991     unsigned int        blue_mask;
1992     unsigned int        alpha_mask;
1993 } VAImageFormat;
1994
1995 typedef VAGenericID VAImageID;
1996
1997 typedef struct _VAImage
1998 {
1999     VAImageID           image_id; /* uniquely identify this image */
2000     VAImageFormat       format;
2001     VABufferID          buf;    /* image data buffer */
2002     /*
2003      * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2004      * data store on the server side for optimal performance. The buffer will be
2005      * created by the CreateImage function, and proper storage allocated based on the image
2006      * size and format. This buffer is managed by the library implementation, and
2007      * accessed by the client through the buffer Map/Unmap functions.
2008      */
2009     unsigned short      width;
2010     unsigned short      height;
2011     unsigned int        data_size;
2012     unsigned int        num_planes;     /* can not be greater than 3 */
2013     /*
2014      * An array indicating the scanline pitch in bytes for each plane.
2015      * Each plane may have a different pitch. Maximum 3 planes for planar formats
2016      */
2017     unsigned int        pitches[3];
2018     /*
2019      * An array indicating the byte offset from the beginning of the image data
2020      * to the start of each plane.
2021      */
2022     unsigned int        offsets[3];
2023
2024     /* The following fields are only needed for paletted formats */
2025     int num_palette_entries;   /* set to zero for non-palette images */
2026     /*
2027      * Each component is one byte and entry_bytes indicates the number of components in
2028      * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2029      */
2030     int entry_bytes;
2031     /*
2032      * An array of ascii characters describing the order of the components within the bytes.
2033      * Only entry_bytes characters of the string are used.
2034      */
2035     char component_order[4];
2036 } VAImage;
2037
2038 /* Get maximum number of image formats supported by the implementation */
2039 int vaMaxNumImageFormats (
2040     VADisplay dpy
2041 );
2042
2043 /*
2044  * Query supported image formats
2045  * The caller must provide a "format_list" array that can hold at
2046  * least vaMaxNumImageFormats() entries. The actual number of formats
2047  * returned in "format_list" is returned in "num_formats".
2048  */
2049 VAStatus vaQueryImageFormats (
2050     VADisplay dpy,
2051     VAImageFormat *format_list, /* out */
2052     int *num_formats            /* out */
2053 );
2054
2055 /*
2056  * Create a VAImage structure
2057  * The width and height fields returned in the VAImage structure may get
2058  * enlarged for some YUV formats. Upon return from this function,
2059  * image->buf has been created and proper storage allocated by the library.
2060  * The client can access the image through the Map/Unmap calls.
2061  */
2062 VAStatus vaCreateImage (
2063     VADisplay dpy,
2064     VAImageFormat *format,
2065     int width,
2066     int height,
2067     VAImage *image      /* out */
2068 );
2069
2070 /*
2071  * Should call DestroyImage before destroying the surface it is bound to
2072  */
2073 VAStatus vaDestroyImage (
2074     VADisplay dpy,
2075     VAImageID image
2076 );
2077
2078 VAStatus vaSetImagePalette (
2079     VADisplay dpy,
2080     VAImageID image,
2081     /*
2082      * pointer to an array holding the palette data.  The size of the array is
2083      * num_palette_entries * entry_bytes in size.  The order of the components
2084      * in the palette is described by the component_order in VAImage struct
2085      */
2086     unsigned char *palette
2087 );
2088
2089 /*
2090  * Retrive surface data into a VAImage
2091  * Image must be in a format supported by the implementation
2092  */
2093 VAStatus vaGetImage (
2094     VADisplay dpy,
2095     VASurfaceID surface,
2096     int x,      /* coordinates of the upper left source pixel */
2097     int y,
2098     unsigned int width, /* width and height of the region */
2099     unsigned int height,
2100     VAImageID image
2101 );
2102
2103 /*
2104  * Copy data from a VAImage to a surface
2105  * Image must be in a format supported by the implementation
2106  * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2107  * shouldn't be rendered into when this is called
2108  */
2109 VAStatus vaPutImage (
2110     VADisplay dpy,
2111     VASurfaceID surface,
2112     VAImageID image,
2113     int src_x,
2114     int src_y,
2115     unsigned int src_width,
2116     unsigned int src_height,
2117     int dest_x,
2118     int dest_y,
2119     unsigned int dest_width,
2120     unsigned int dest_height
2121 );
2122
2123 /*
2124  * Derive an VAImage from an existing surface.
2125  * This interface will derive a VAImage and corresponding image buffer from
2126  * an existing VA Surface. The image buffer can then be mapped/unmapped for
2127  * direct CPU access. This operation is only possible on implementations with
2128  * direct rendering capabilities and internal surface formats that can be
2129  * represented with a VAImage. When the operation is not possible this interface
2130  * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2131  * to using vaCreateImage + vaPutImage to accomplish the same task in an
2132  * indirect manner.
2133  *
2134  * Implementations should only return success when the resulting image buffer
2135  * would be useable with vaMap/Unmap.
2136  *
2137  * When directly accessing a surface special care must be taken to insure
2138  * proper synchronization with the graphics hardware. Clients should call
2139  * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2140  * rendering or currently being displayed by an overlay.
2141  *
2142  * Additionally nothing about the contents of a surface should be assumed
2143  * following a vaPutSurface. Implementations are free to modify the surface for
2144  * scaling or subpicture blending within a call to vaPutImage.
2145  *
2146  * Calls to vaPutImage or vaGetImage using the same surface from which the image
2147  * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2148  * vaGetImage with other surfaces is supported.
2149  *
2150  * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2151  * image and image buffer structures will be destroyed; however, the underlying
2152  * surface will remain unchanged until freed with vaDestroySurfaces.
2153  */
2154 VAStatus vaDeriveImage (
2155     VADisplay dpy,
2156     VASurfaceID surface,
2157     VAImage *image      /* out */
2158 );
2159
2160 /*
2161  * Subpictures
2162  * Subpicture is a special type of image that can be blended
2163  * with a surface during vaPutSurface(). Subpicture can be used to render
2164  * DVD sub-titles or closed captioning text etc.
2165  */
2166
2167 typedef VAGenericID VASubpictureID;
2168
2169 /* Get maximum number of subpicture formats supported by the implementation */
2170 int vaMaxNumSubpictureFormats (
2171     VADisplay dpy
2172 );
2173
2174 /* flags for subpictures */
2175 #define VA_SUBPICTURE_CHROMA_KEYING                     0x0001
2176 #define VA_SUBPICTURE_GLOBAL_ALPHA                      0x0002
2177 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD       0x0004
2178 /*
2179  * Query supported subpicture formats
2180  * The caller must provide a "format_list" array that can hold at
2181  * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2182  * for each format to indicate additional capabilities for that format. The actual
2183  * number of formats returned in "format_list" is returned in "num_formats".
2184  *  flags: returned value to indicate addtional capabilities
2185  *         VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2186  *         VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2187  *         VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2188  */
2189
2190 VAStatus vaQuerySubpictureFormats (
2191     VADisplay dpy,
2192     VAImageFormat *format_list, /* out */
2193     unsigned int *flags,        /* out */
2194     unsigned int *num_formats   /* out */
2195 );
2196
2197 /*
2198  * Subpictures are created with an image associated.
2199  */
2200 VAStatus vaCreateSubpicture (
2201     VADisplay dpy,
2202     VAImageID image,
2203     VASubpictureID *subpicture  /* out */
2204 );
2205
2206 /*
2207  * Destroy the subpicture before destroying the image it is assocated to
2208  */
2209 VAStatus vaDestroySubpicture (
2210     VADisplay dpy,
2211     VASubpictureID subpicture
2212 );
2213
2214 /*
2215  * Bind an image to the subpicture. This image will now be associated with
2216  * the subpicture instead of the one at creation.
2217  */
2218 VAStatus vaSetSubpictureImage (
2219     VADisplay dpy,
2220     VASubpictureID subpicture,
2221     VAImageID image
2222 );
2223
2224 /*
2225  * If chromakey is enabled, then the area where the source value falls within
2226  * the chromakey [min, max] range is transparent
2227  * The chromakey component format is the following:
2228  *  For RGB: [0:7] Red [8:15] Blue [16:23] Green
2229  *  For YUV: [0:7] V [8:15] U [16:23] Y
2230  * The chromakey mask can be used to mask out certain components for chromakey
2231  * comparision
2232  */
2233 VAStatus vaSetSubpictureChromakey (
2234     VADisplay dpy,
2235     VASubpictureID subpicture,
2236     unsigned int chromakey_min,
2237     unsigned int chromakey_max,
2238     unsigned int chromakey_mask
2239 );
2240
2241 /*
2242  * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2243  * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2244  * the overall alpha is per-pixel alpha multiplied by the global alpha
2245  */
2246 VAStatus vaSetSubpictureGlobalAlpha (
2247     VADisplay dpy,
2248     VASubpictureID subpicture,
2249     float global_alpha
2250 );
2251
2252 /*
2253  * vaAssociateSubpicture associates the subpicture with target_surfaces.
2254  * It defines the region mapping between the subpicture and the target
2255  * surfaces through source and destination rectangles (with the same width and height).
2256  * Both will be displayed at the next call to vaPutSurface.  Additional
2257  * associations before the call to vaPutSurface simply overrides the association.
2258  */
2259 VAStatus vaAssociateSubpicture (
2260     VADisplay dpy,
2261     VASubpictureID subpicture,
2262     VASurfaceID *target_surfaces,
2263     int num_surfaces,
2264     short src_x, /* upper left offset in subpicture */
2265     short src_y,
2266     unsigned short src_width,
2267     unsigned short src_height,
2268     short dest_x, /* upper left offset in surface */
2269     short dest_y,
2270     unsigned short dest_width,
2271     unsigned short dest_height,
2272     /*
2273      * whether to enable chroma-keying, global-alpha, or screen relative mode
2274      * see VA_SUBPICTURE_XXX values
2275      */
2276     unsigned int flags
2277 );
2278
2279 /*
2280  * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2281  */
2282 VAStatus vaDeassociateSubpicture (
2283     VADisplay dpy,
2284     VASubpictureID subpicture,
2285     VASurfaceID *target_surfaces,
2286     int num_surfaces
2287 );
2288
2289 typedef struct _VARectangle
2290 {
2291     short x;
2292     short y;
2293     unsigned short width;
2294     unsigned short height;
2295 } VARectangle;
2296
2297 /*
2298  * Display attributes
2299  * Display attributes are used to control things such as contrast, hue, saturation,
2300  * brightness etc. in the rendering process.  The application can query what
2301  * attributes are supported by the driver, and then set the appropriate attributes
2302  * before calling vaPutSurface()
2303  */
2304 /* PowerVR IEP Lite attributes */
2305 typedef enum
2306 {
2307     VADISPLAYATTRIB_BLE_OFF              = 0x00,
2308     VADISPLAYATTRIB_BLE_LOW,
2309     VADISPLAYATTRIB_BLE_MEDIUM,
2310     VADISPLAYATTRIB_BLE_HIGH,
2311     VADISPLAYATTRIB_BLE_NONE,
2312 } VADisplayAttribBLEMode;
2313
2314 /* attribute value for VADisplayAttribRotation   */
2315 #define VA_ROTATION_NONE        0x00000000
2316 #define VA_ROTATION_90          0x00000001
2317 #define VA_ROTATION_180         0x00000002
2318 #define VA_ROTATION_270         0x00000003
2319
2320 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2321 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2322 #define VA_OOL_DEBLOCKING_TRUE  0x00000001
2323
2324 /* Render mode */
2325 #define VA_RENDER_MODE_UNDEFINED           0
2326 #define VA_RENDER_MODE_LOCAL_OVERLAY       1
2327 #define VA_RENDER_MODE_LOCAL_GPU           2
2328 #define VA_RENDER_MODE_EXTERNAL_OVERLAY    4
2329 #define VA_RENDER_MODE_EXTERNAL_GPU        8
2330
2331 /* Render device */
2332 #define VA_RENDER_DEVICE_UNDEFINED  0
2333 #define VA_RENDER_DEVICE_LOCAL      1
2334 #define VA_RENDER_DEVICE_EXTERNAL   2
2335
2336 /* Currently defined display attribute types */
2337 typedef enum
2338 {
2339     VADisplayAttribBrightness           = 0,
2340     VADisplayAttribContrast             = 1,
2341     VADisplayAttribHue                  = 2,
2342     VADisplayAttribSaturation           = 3,
2343     /* client can specifiy a background color for the target window
2344      * the new feature of video conference,
2345      * the uncovered area of the surface is filled by this color
2346      * also it will blend with the decoded video color
2347      */
2348     VADisplayAttribBackgroundColor      = 4,
2349     /*
2350      * this is a gettable only attribute. For some implementations that use the
2351      * hardware overlay, after PutSurface is called, the surface can not be
2352      * re-used until after the subsequent PutSurface call. If this is the case
2353      * then the value for this attribute will be set to 1 so that the client
2354      * will not attempt to re-use the surface right after returning from a call
2355      * to PutSurface.
2356      *
2357      * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2358      * driver may use overlay or GPU alternatively
2359      */
2360     VADisplayAttribDirectSurface       = 5,
2361     VADisplayAttribRotation            = 6,
2362     VADisplayAttribOutofLoopDeblock    = 7,
2363
2364     /* PowerVR IEP Lite specific attributes */
2365     VADisplayAttribBLEBlackMode        = 8,
2366     VADisplayAttribBLEWhiteMode        = 9,
2367     VADisplayAttribBlueStretch         = 10,
2368     VADisplayAttribSkinColorCorrection = 11,
2369     /*
2370      * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2371      * conversion matrix. Each element in the matrix is float-point
2372      */
2373     VADisplayAttribCSCMatrix           = 12,
2374     /* specify the constant color used to blend with video surface
2375      * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2376      *      d: the final color to overwrite into the frame buffer
2377      *      v: decoded video after color conversion,
2378      *      c: video color specified by VADisplayAttribBlendColor
2379      *      b: background color of the drawable
2380      */
2381     VADisplayAttribBlendColor          = 13,
2382     /*
2383      * Indicate driver to skip painting color key or not.
2384      * only applicable if the render is overlay
2385      */
2386     VADisplayAttribOverlayAutoPaintColorKey   = 14,
2387     /*
2388      * customized overlay color key, the format is RGB888
2389      * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2390      */
2391     VADisplayAttribOverlayColorKey      = 15,
2392     /*
2393      * The hint for the implementation of vaPutSurface
2394      * normally, the driver could use an overlay or GPU to render the surface on the screen
2395      * this flag provides APP the flexibity to switch the render dynamically
2396      */
2397     VADisplayAttribRenderMode           = 16,
2398     /*
2399      * specify if vaPutSurface needs to render into specified monitors
2400      * one example is that one external monitor (e.g. HDMI) is enabled,
2401      * but the window manager is not aware of it, and there is no associated drawable
2402      */
2403     VADisplayAttribRenderDevice        = 17,
2404     /*
2405      * specify vaPutSurface render area if there is no drawable on the monitor
2406      */
2407     VADisplayAttribRenderRect          = 18,
2408 } VADisplayAttribType;
2409
2410 /* flags for VADisplayAttribute */
2411 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2412 #define VA_DISPLAY_ATTRIB_GETTABLE      0x0001
2413 #define VA_DISPLAY_ATTRIB_SETTABLE      0x0002
2414
2415 typedef struct _VADisplayAttribute
2416 {
2417     VADisplayAttribType type;
2418     int min_value;
2419     int max_value;
2420     int value;  /* used by the set/get attribute functions */
2421 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2422     unsigned int flags;
2423 } VADisplayAttribute;
2424
2425 /* Get maximum number of display attributs supported by the implementation */
2426 int vaMaxNumDisplayAttributes (
2427     VADisplay dpy
2428 );
2429
2430 /*
2431  * Query display attributes
2432  * The caller must provide a "attr_list" array that can hold at
2433  * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2434  * returned in "attr_list" is returned in "num_attributes".
2435  */
2436 VAStatus vaQueryDisplayAttributes (
2437     VADisplay dpy,
2438     VADisplayAttribute *attr_list,      /* out */
2439     int *num_attributes                 /* out */
2440 );
2441
2442 /*
2443  * Get display attributes
2444  * This function returns the current attribute values in "attr_list".
2445  * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2446  * from vaQueryDisplayAttributes() can have their values retrieved.
2447  */
2448 VAStatus vaGetDisplayAttributes (
2449     VADisplay dpy,
2450     VADisplayAttribute *attr_list,      /* in/out */
2451     int num_attributes
2452 );
2453
2454 /*
2455  * Set display attributes
2456  * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2457  * from vaQueryDisplayAttributes() can be set.  If the attribute is not settable or
2458  * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2459  */
2460 VAStatus vaSetDisplayAttributes (
2461     VADisplay dpy,
2462     VADisplayAttribute *attr_list,
2463     int num_attributes
2464 );
2465
2466 /**@}*/
2467
2468 #ifdef __cplusplus
2469 }
2470 #endif
2471
2472 #endif /* _VA_H_ */