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