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