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