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