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