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