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