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     VAEncMacroblockParameterBufferType  = 28,
 589     VABufferTypeMax                     = 0xff
 590 } VABufferType;
 591
 592 typedef enum
 593 {
 594     VAEncMiscParameterTypeFrameRate     = 0,
 595     VAEncMiscParameterTypeRateControl   = 1,
 596     VAEncMiscParameterTypeMaxSliceSize  = 2,
 597     VAEncMiscParameterTypeAIR           = 3,
 598 } VAEncMiscParameterType;
 599
 600 /** \brief Packed header type. */
 601 typedef enum {
 602     VAEncPackedHeaderSequence           = 1, /**< Packed sequence header. */
 603     VAEncPackedHeaderPicture            = 2, /**< Packed picture header. */
 604     VAEncPackedHeaderSlice              = 3, /**< Packed slice header. */
 605 } VAEncPackedHeaderType;
 606
 607 /** \brief Packed header parameter. */
 608 typedef struct _VAEncPackedHeaderParameterBuffer {
 609     /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
 610     VAEncPackedHeaderType       type;
 611     /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
 612     unsigned int                bit_length;
 613     /** \brief Flag: buffer contains start code emulation prevention bytes? */
 614     unsigned char               has_emulation_bytes;
 615 } VAEncPackedHeaderParameterBuffer;
 616
 617 /*
 618  *  For application, e.g. set a new bitrate
 619  *    VABufferID buf_id;
 620  *    VAEncMiscParameterBuffer *misc_param;
 621  *    VAEncMiscParameterRateControl *misc_rate_ctrl;
 622  *
 623  *    vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
 624  *              sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
 625  *              1, NULL, &buf_id);
 626  *
 627  *    vaMapBuffer(dpy,buf_id,(void **)&misc_param);
 628  *    misc_param->type = VAEncMiscParameterTypeRateControl;
 629  *    misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
 630  *    misc_rate_ctrl->bits_per_second = 6400000;
 631  *    vaUnmapBuffer(dpy, buf_id);
 632  *    vaRenderPicture(dpy, context, &buf_id, 1);
 633  */
 634 typedef struct _VAEncMiscParameterBuffer
 635 {
 636     VAEncMiscParameterType type;
 637     unsigned int data[0];
 638 } VAEncMiscParameterBuffer;
 639
 640 typedef struct _VAEncMiscParameterRateControl
 641 {
 642     unsigned int bits_per_second; /* this is the maximum bit-rate to be constrained by the rate control implementation */
 643     unsigned int target_percentage; /* this is the bit-rate the rate control is targeting, as a percentage of the maximum bit-rate */
 644                                     /* for example if target_percentage is 95 then the rate control will target a bit-rate that is */
 645                                     /* 95% of the maximum bit-rate */
 646     unsigned int window_size; /* windows size in milliseconds. For example if this is set to 500, then the rate control will guarantee the */
 647                               /* target bit-rate over a 500 ms window */
 648     unsigned int initial_qp;  /* initial QP at I frames */
 649     unsigned int min_qp;
 650 } VAEncMiscParameterRateControl;
 651
 652 typedef struct _VAEncMiscParameterFrameRate
 653 {
 654     unsigned int framerate;
 655 } VAEncMiscParameterFrameRate;
 656
 657 /*
 658  * Allow a maximum slice size to be specified (in bits).
 659  * The encoder will attempt to make sure that individual slices do not exceed this size
 660  * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
 661  */
 662 typedef struct _VAEncMiscParameterMaxSliceSize
 663 {
 664     unsigned int max_slice_size;
 665 } VAEncMiscParameterMaxSliceSize;
 666
 667 typedef struct _VAEncMiscParameterAIR
 668 {
 669     unsigned int air_num_mbs;
 670     unsigned int air_threshold;
 671     unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
 672 } VAEncMiscParameterAIR;
 673
 674
 675 /*
 676  * There will be cases where the bitstream buffer will not have enough room to hold
 677  * the data for the entire slice, and the following flags will be used in the slice
 678  * parameter to signal to the server for the possible cases.
 679  * If a slice parameter buffer and slice data buffer pair is sent to the server with
 680  * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
 681  * then a slice parameter and data buffer needs to be sent again to complete this slice.
 682  */
 683 #define VA_SLICE_DATA_FLAG_ALL          0x00    /* whole slice is in the buffer */
 684 #define VA_SLICE_DATA_FLAG_BEGIN        0x01    /* The beginning of the slice is in the buffer but the end if not */
 685 #define VA_SLICE_DATA_FLAG_MIDDLE       0x02    /* Neither beginning nor end of the slice is in the buffer */
 686 #define VA_SLICE_DATA_FLAG_END          0x04    /* end of the slice is in the buffer */
 687
 688 /* Codec-independent Slice Parameter Buffer base */
 689 typedef struct _VASliceParameterBufferBase
 690 {
 691     unsigned int slice_data_size;       /* number of bytes in the slice data buffer for this slice */
 692     unsigned int slice_data_offset;     /* the offset to the first byte of slice data */
 693     unsigned int slice_data_flag;       /* see VA_SLICE_DATA_FLAG_XXX definitions */
 694 } VASliceParameterBufferBase;
 695
 696
 697 /****************************
 698  * JEPG data structure
 699  ***************************/
 700 typedef struct _VAQMatrixBufferJPEG
 701 {
 702     int load_lum_quantiser_matrix;
 703     int load_chroma_quantiser_matrix;
 704     unsigned char lum_quantiser_matrix[64];
 705     unsigned char chroma_quantiser_matrix[64];
 706 } VAQMatrixBufferJPEG;
 707
 708 typedef struct _VAEncPictureParameterBufferJPEG
 709 {
 710     VASurfaceID reconstructed_picture;
 711     unsigned short picture_width;
 712     unsigned short picture_height;
 713     VABufferID coded_buf;
 714 } VAEncPictureParameterBufferJPEG;
 715
 716 #include <va/va_dec_jpeg.h>
 717
 718 /****************************
 719  * MPEG-2 data structures
 720  ****************************/
 721
 722 /* MPEG-2 Picture Parameter Buffer */
 723 /*
 724  * For each frame or field, and before any slice data, a single
 725  * picture parameter buffer must be send.
 726  */
 727 typedef struct _VAPictureParameterBufferMPEG2
 728 {
 729     unsigned short horizontal_size;
 730     unsigned short vertical_size;
 731     VASurfaceID forward_reference_picture;
 732     VASurfaceID backward_reference_picture;
 733     /* meanings of the following fields are the same as in the standard */
 734     int picture_coding_type;
 735     int f_code; /* pack all four fcode into this */
 736     union {
 737         struct {
 738             unsigned int intra_dc_precision             : 2;
 739             unsigned int picture_structure              : 2;
 740             unsigned int top_field_first                : 1;
 741             unsigned int frame_pred_frame_dct           : 1;
 742             unsigned int concealment_motion_vectors     : 1;
 743             unsigned int q_scale_type                   : 1;
 744             unsigned int intra_vlc_format               : 1;
 745             unsigned int alternate_scan                 : 1;
 746             unsigned int repeat_first_field             : 1;
 747             unsigned int progressive_frame              : 1;
 748             unsigned int is_first_field                 : 1; /* indicate whether the current field
 749                                                               * is the first field for field picture
 750                                                               */
 751         } bits;
 752         unsigned int value;
 753     } picture_coding_extension;
 754 } VAPictureParameterBufferMPEG2;
 755
 756 /* MPEG-2 Inverse Quantization Matrix Buffer */
 757 typedef struct _VAIQMatrixBufferMPEG2
 758 {
 759     int load_intra_quantiser_matrix;
 760     int load_non_intra_quantiser_matrix;
 761     int load_chroma_intra_quantiser_matrix;
 762     int load_chroma_non_intra_quantiser_matrix;
 763     unsigned char intra_quantiser_matrix[64];
 764     unsigned char non_intra_quantiser_matrix[64];
 765     unsigned char chroma_intra_quantiser_matrix[64];
 766     unsigned char chroma_non_intra_quantiser_matrix[64];
 767 } VAIQMatrixBufferMPEG2;
 768
 769 /* MPEG-2 Slice Parameter Buffer */
 770 typedef struct _VASliceParameterBufferMPEG2
 771 {
 772     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 773     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 774     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 775     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 776     unsigned int slice_horizontal_position;
 777     unsigned int slice_vertical_position;
 778     int quantiser_scale_code;
 779     int intra_slice_flag;
 780 } VASliceParameterBufferMPEG2;
 781
 782 /* MPEG-2 Macroblock Parameter Buffer */
 783 typedef struct _VAMacroblockParameterBufferMPEG2
 784 {
 785     unsigned short macroblock_address;
 786     /*
 787      * macroblock_address (in raster scan order)
 788      * top-left: 0
 789      * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
 790      */
 791     unsigned char macroblock_type;  /* see definition below */
 792     union {
 793         struct {
 794             unsigned int frame_motion_type              : 2;
 795             unsigned int field_motion_type              : 2;
 796             unsigned int dct_type                       : 1;
 797         } bits;
 798         unsigned int value;
 799     } macroblock_modes;
 800     unsigned char motion_vertical_field_select;
 801     /*
 802      * motion_vertical_field_select:
 803      * see section 6.3.17.2 in the spec
 804      * only the lower 4 bits are used
 805      * bit 0: first vector forward
 806      * bit 1: first vector backward
 807      * bit 2: second vector forward
 808      * bit 3: second vector backward
 809      */
 810     short PMV[2][2][2]; /* see Table 7-7 in the spec */
 811     unsigned short coded_block_pattern;
 812     /*
 813      * The bitplanes for coded_block_pattern are described
 814      * in Figure 6.10-12 in the spec
 815      */
 816
 817     /* Number of skipped macroblocks after this macroblock */
 818     unsigned short num_skipped_macroblocks;
 819 } VAMacroblockParameterBufferMPEG2;
 820
 821 /*
 822  * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
 823  */
 824 #define VA_MB_TYPE_MOTION_FORWARD       0x02
 825 #define VA_MB_TYPE_MOTION_BACKWARD      0x04
 826 #define VA_MB_TYPE_MOTION_PATTERN       0x08
 827 #define VA_MB_TYPE_MOTION_INTRA         0x10
 828
 829 /*
 830  * MPEG-2 Residual Data Buffer
 831  * For each macroblock, there wil be 64 shorts (16-bit) in the
 832  * residual data buffer
 833  */
 834
 835 /****************************
 836  * MPEG-4 Part 2 data structures
 837  ****************************/
 838
 839 /* MPEG-4 Picture Parameter Buffer */
 840 /*
 841  * For each frame or field, and before any slice data, a single
 842  * picture parameter buffer must be send.
 843  */
 844 typedef struct _VAPictureParameterBufferMPEG4
 845 {
 846     unsigned short vop_width;
 847     unsigned short vop_height;
 848     VASurfaceID forward_reference_picture;
 849     VASurfaceID backward_reference_picture;
 850     union {
 851         struct {
 852             unsigned int short_video_header             : 1;
 853             unsigned int chroma_format                  : 2;
 854             unsigned int interlaced                     : 1;
 855             unsigned int obmc_disable                   : 1;
 856             unsigned int sprite_enable                  : 2;
 857             unsigned int sprite_warping_accuracy        : 2;
 858             unsigned int quant_type                     : 1;
 859             unsigned int quarter_sample                 : 1;
 860             unsigned int data_partitioned               : 1;
 861             unsigned int reversible_vlc                 : 1;
 862             unsigned int resync_marker_disable          : 1;
 863         } bits;
 864         unsigned int value;
 865     } vol_fields;
 866     unsigned char no_of_sprite_warping_points;
 867     short sprite_trajectory_du[3];
 868     short sprite_trajectory_dv[3];
 869     unsigned char quant_precision;
 870     union {
 871         struct {
 872             unsigned int vop_coding_type                : 2;
 873             unsigned int backward_reference_vop_coding_type     : 2;
 874             unsigned int vop_rounding_type              : 1;
 875             unsigned int intra_dc_vlc_thr               : 3;
 876             unsigned int top_field_first                : 1;
 877             unsigned int alternate_vertical_scan_flag   : 1;
 878         } bits;
 879         unsigned int value;
 880     } vop_fields;
 881     unsigned char vop_fcode_forward;
 882     unsigned char vop_fcode_backward;
 883     unsigned short vop_time_increment_resolution;
 884     /* short header related */
 885     unsigned char num_gobs_in_vop;
 886     unsigned char num_macroblocks_in_gob;
 887     /* for direct mode prediction */
 888     short TRB;
 889     short TRD;
 890 } VAPictureParameterBufferMPEG4;
 891
 892 /* MPEG-4 Inverse Quantization Matrix Buffer */
 893 typedef struct _VAIQMatrixBufferMPEG4
 894 {
 895     int load_intra_quant_mat;
 896     int load_non_intra_quant_mat;
 897     unsigned char intra_quant_mat[64];
 898     unsigned char non_intra_quant_mat[64];
 899 } VAIQMatrixBufferMPEG4;
 900
 901 /* MPEG-4 Slice Parameter Buffer */
 902 typedef struct _VASliceParameterBufferMPEG4
 903 {
 904     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
 905     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
 906     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
 907     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
 908     unsigned int macroblock_number;
 909     int quant_scale;
 910 } VASliceParameterBufferMPEG4;
 911
 912 /*
 913  VC-1 data structures
 914 */
 915
 916 typedef enum   /* see 7.1.1.32 */
 917 {
 918     VAMvMode1Mv                        = 0,
 919     VAMvMode1MvHalfPel                 = 1,
 920     VAMvMode1MvHalfPelBilinear         = 2,
 921     VAMvModeMixedMv                    = 3,
 922     VAMvModeIntensityCompensation      = 4
 923 } VAMvModeVC1;
 924
 925 /* VC-1 Picture Parameter Buffer */
 926 /*
 927  * For each picture, and before any slice data, a picture parameter
 928  * buffer must be send. Multiple picture parameter buffers may be
 929  * sent for a single picture. In that case picture parameters will
 930  * apply to all slice data that follow it until a new picture
 931  * parameter buffer is sent.
 932  *
 933  * Notes:
 934  *   pic_quantizer_type should be set to the applicable quantizer
 935  *   type as defined by QUANTIZER (J.1.19) and either
 936  *   PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
 937  */
 938 typedef struct _VAPictureParameterBufferVC1
 939 {
 940     VASurfaceID forward_reference_picture;
 941     VASurfaceID backward_reference_picture;
 942     /* if out-of-loop post-processing is done on the render
 943        target, then we need to keep the in-loop decoded
 944        picture as a reference picture */
 945     VASurfaceID inloop_decoded_picture;
 946
 947     /* sequence layer for AP or meta data for SP and MP */
 948     union {
 949         struct {
 950             unsigned int pulldown       : 1; /* SEQUENCE_LAYER::PULLDOWN */
 951             unsigned int interlace      : 1; /* SEQUENCE_LAYER::INTERLACE */
 952             unsigned int tfcntrflag     : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
 953             unsigned int finterpflag    : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
 954             unsigned int psf            : 1; /* SEQUENCE_LAYER::PSF */
 955             unsigned int multires       : 1; /* METADATA::MULTIRES */
 956             unsigned int overlap        : 1; /* METADATA::OVERLAP */
 957             unsigned int syncmarker     : 1; /* METADATA::SYNCMARKER */
 958             unsigned int rangered       : 1; /* METADATA::RANGERED */
 959             unsigned int max_b_frames   : 3; /* METADATA::MAXBFRAMES */
 960             unsigned int profile        : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
 961         } bits;
 962         unsigned int value;
 963     } sequence_fields;
 964
 965     unsigned short coded_width;         /* ENTRY_POINT_LAYER::CODED_WIDTH */
 966     unsigned short coded_height;        /* ENTRY_POINT_LAYER::CODED_HEIGHT */
 967     union {
 968         struct {
 969             unsigned int broken_link    : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
 970             unsigned int closed_entry   : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
 971             unsigned int panscan_flag   : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
 972             unsigned int loopfilter     : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
 973         } bits;
 974         unsigned int value;
 975     } entrypoint_fields;
 976     unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
 977     unsigned char fast_uvmc_flag;       /* ENTRY_POINT_LAYER::FASTUVMC */
 978     union {
 979         struct {
 980             unsigned int luma_flag      : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
 981             unsigned int luma           : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
 982             unsigned int chroma_flag    : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
 983             unsigned int chroma         : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
 984         } bits;
 985         unsigned int value;
 986     } range_mapping_fields;
 987
 988     unsigned char b_picture_fraction;   /* PICTURE_LAYER::BFRACTION */
 989     unsigned char cbp_table;            /* PICTURE_LAYER::CBPTAB/ICBPTAB */
 990     unsigned char mb_mode_table;        /* PICTURE_LAYER::MBMODETAB */
 991     unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
 992     unsigned char rounding_control;     /* PICTURE_LAYER::RNDCTRL */
 993     unsigned char post_processing;      /* PICTURE_LAYER::POSTPROC */
 994     unsigned char picture_resolution_index;     /* PICTURE_LAYER::RESPIC */
 995     unsigned char luma_scale;           /* PICTURE_LAYER::LUMSCALE */
 996     unsigned char luma_shift;           /* PICTURE_LAYER::LUMSHIFT */
 997     union {
 998         struct {
 999             unsigned int picture_type           : 3; /* PICTURE_LAYER::PTYPE */
1000             unsigned int frame_coding_mode      : 3; /* PICTURE_LAYER::FCM */
1001             unsigned int top_field_first        : 1; /* PICTURE_LAYER::TFF */
1002             unsigned int is_first_field         : 1; /* set to 1 if it is the first field */
1003             unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1004         } bits;
1005         unsigned int value;
1006     } picture_fields;
1007     union {
1008         struct {
1009             unsigned int mv_type_mb     : 1;    /* PICTURE::MVTYPEMB */
1010             unsigned int direct_mb      : 1;    /* PICTURE::DIRECTMB */
1011             unsigned int skip_mb        : 1;    /* PICTURE::SKIPMB */
1012             unsigned int field_tx       : 1;    /* PICTURE::FIELDTX */
1013             unsigned int forward_mb     : 1;    /* PICTURE::FORWARDMB */
1014             unsigned int ac_pred        : 1;    /* PICTURE::ACPRED */
1015             unsigned int overflags      : 1;    /* PICTURE::OVERFLAGS */
1016         } flags;
1017         unsigned int value;
1018     } raw_coding;
1019     union {
1020         struct {
1021             unsigned int bp_mv_type_mb   : 1;    /* PICTURE::MVTYPEMB */
1022             unsigned int bp_direct_mb    : 1;    /* PICTURE::DIRECTMB */
1023             unsigned int bp_skip_mb      : 1;    /* PICTURE::SKIPMB */
1024             unsigned int bp_field_tx     : 1;    /* PICTURE::FIELDTX */
1025             unsigned int bp_forward_mb   : 1;    /* PICTURE::FORWARDMB */
1026             unsigned int bp_ac_pred      : 1;    /* PICTURE::ACPRED */
1027             unsigned int bp_overflags    : 1;    /* PICTURE::OVERFLAGS */
1028         } flags;
1029         unsigned int value;
1030     } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1031     union {
1032         struct {
1033             unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1034             unsigned int reference_distance     : 5;/* PICTURE_LAYER::REFDIST */
1035             unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1036             unsigned int reference_field_pic_indicator  : 1;/* PICTURE_LAYER::REFFIELD */
1037         } bits;
1038         unsigned int value;
1039     } reference_fields;
1040     union {
1041         struct {
1042             unsigned int mv_mode                : 3; /* PICTURE_LAYER::MVMODE */
1043             unsigned int mv_mode2               : 3; /* PICTURE_LAYER::MVMODE2 */
1044             unsigned int mv_table               : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1045             unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1046             unsigned int four_mv_switch         : 1; /* PICTURE_LAYER::4MVSWITCH */
1047             unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1048             unsigned int extended_mv_flag       : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1049             unsigned int extended_mv_range      : 2; /* PICTURE_LAYER::MVRANGE */
1050             unsigned int extended_dmv_flag      : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1051             unsigned int extended_dmv_range     : 2; /* PICTURE_LAYER::DMVRANGE */
1052         } bits;
1053         unsigned int value;
1054     } mv_fields;
1055     union {
1056         struct {
1057             unsigned int dquant : 2;    /* ENTRY_POINT_LAYER::DQUANT */
1058             unsigned int quantizer     : 2;     /* ENTRY_POINT_LAYER::QUANTIZER */
1059             unsigned int half_qp        : 1;    /* PICTURE_LAYER::HALFQP */
1060             unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1061             unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1062             unsigned int dq_frame       : 1;    /* VOPDQUANT::DQUANTFRM */
1063             unsigned int dq_profile     : 2;    /* VOPDQUANT::DQPROFILE */
1064             unsigned int dq_sb_edge     : 2;    /* VOPDQUANT::DQSBEDGE */
1065             unsigned int dq_db_edge     : 2;    /* VOPDQUANT::DQDBEDGE */
1066             unsigned int dq_binary_level : 1;   /* VOPDQUANT::DQBILEVEL */
1067             unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1068         } bits;
1069         unsigned int value;
1070     } pic_quantizer_fields;
1071     union {
1072         struct {
1073             unsigned int variable_sized_transform_flag  : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1074             unsigned int mb_level_transform_type_flag   : 1;/* PICTURE_LAYER::TTMBF */
1075             unsigned int frame_level_transform_type     : 2;/* PICTURE_LAYER::TTFRM */
1076             unsigned int transform_ac_codingset_idx1    : 2;/* PICTURE_LAYER::TRANSACFRM */
1077             unsigned int transform_ac_codingset_idx2    : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1078             unsigned int intra_transform_dc_table       : 1;/* PICTURE_LAYER::TRANSDCTAB */
1079         } bits;
1080         unsigned int value;
1081     } transform_fields;
1082 } VAPictureParameterBufferVC1;
1083
1084 /* VC-1 Bitplane Buffer
1085 There will be at most three bitplanes coded in any picture header. To send
1086 the bitplane data more efficiently, each byte is divided in two nibbles, with
1087 each nibble carrying three bitplanes for one macroblock.  The following table
1088 shows the bitplane data arrangement within each nibble based on the picture
1089 type.
1090
1091 Picture Type    Bit3            Bit2            Bit1            Bit0
1092 I or BI                         OVERFLAGS       ACPRED          FIELDTX
1093 P                               MYTYPEMB        SKIPMB          DIRECTMB
1094 B                               FORWARDMB       SKIPMB          DIRECTMB
1095
1096 Within each byte, the lower nibble is for the first MB and the upper nibble is
1097 for the second MB.  E.g. the lower nibble of the first byte in the bitplane
1098 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1099 Macroblock #2 in the first row.
1100 */
1101
1102 /* VC-1 Slice Parameter Buffer */
1103 typedef struct _VASliceParameterBufferVC1
1104 {
1105     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1106     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1107     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1108     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1109     unsigned int slice_vertical_position;
1110 } VASliceParameterBufferVC1;
1111
1112 /* VC-1 Slice Data Buffer */
1113 /*
1114 This is simplely a buffer containing raw bit-stream bytes
1115 */
1116
1117 /****************************
1118  * H.264/AVC data structures
1119  ****************************/
1120
1121 typedef struct _VAPictureH264
1122 {
1123     VASurfaceID picture_id;
1124     unsigned int frame_idx;
1125     unsigned int flags;
1126     signed int TopFieldOrderCnt;
1127     signed int BottomFieldOrderCnt;
1128 } VAPictureH264;
1129 /* flags in VAPictureH264 could be OR of the following */
1130 #define VA_PICTURE_H264_INVALID                 0x00000001
1131 #define VA_PICTURE_H264_TOP_FIELD               0x00000002
1132 #define VA_PICTURE_H264_BOTTOM_FIELD            0x00000004
1133 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE    0x00000008
1134 #define VA_PICTURE_H264_LONG_TERM_REFERENCE     0x00000010
1135
1136 /* H.264 Picture Parameter Buffer */
1137 /*
1138  * For each picture, and before any slice data, a single
1139  * picture parameter buffer must be send.
1140  */
1141 typedef struct _VAPictureParameterBufferH264
1142 {
1143     VAPictureH264 CurrPic;
1144     VAPictureH264 ReferenceFrames[16];  /* in DPB */
1145     unsigned short picture_width_in_mbs_minus1;
1146     unsigned short picture_height_in_mbs_minus1;
1147     unsigned char bit_depth_luma_minus8;
1148     unsigned char bit_depth_chroma_minus8;
1149     unsigned char num_ref_frames;
1150     union {
1151         struct {
1152             unsigned int chroma_format_idc                      : 2;
1153             unsigned int residual_colour_transform_flag         : 1;
1154             unsigned int gaps_in_frame_num_value_allowed_flag   : 1;
1155             unsigned int frame_mbs_only_flag                    : 1;
1156             unsigned int mb_adaptive_frame_field_flag           : 1;
1157             unsigned int direct_8x8_inference_flag              : 1;
1158             unsigned int MinLumaBiPredSize8x8                   : 1; /* see A.3.3.2 */
1159             unsigned int log2_max_frame_num_minus4              : 4;
1160             unsigned int pic_order_cnt_type                     : 2;
1161             unsigned int log2_max_pic_order_cnt_lsb_minus4      : 4;
1162             unsigned int delta_pic_order_always_zero_flag       : 1;
1163         } bits;
1164         unsigned int value;
1165     } seq_fields;
1166     unsigned char num_slice_groups_minus1;
1167     unsigned char slice_group_map_type;
1168     unsigned short slice_group_change_rate_minus1;
1169     signed char pic_init_qp_minus26;
1170     signed char pic_init_qs_minus26;
1171     signed char chroma_qp_index_offset;
1172     signed char second_chroma_qp_index_offset;
1173     union {
1174         struct {
1175             unsigned int entropy_coding_mode_flag       : 1;
1176             unsigned int weighted_pred_flag             : 1;
1177             unsigned int weighted_bipred_idc            : 2;
1178             unsigned int transform_8x8_mode_flag        : 1;
1179             unsigned int field_pic_flag                 : 1;
1180             unsigned int constrained_intra_pred_flag    : 1;
1181             unsigned int pic_order_present_flag                 : 1;
1182             unsigned int deblocking_filter_control_present_flag : 1;
1183             unsigned int redundant_pic_cnt_present_flag         : 1;
1184             unsigned int reference_pic_flag                     : 1; /* nal_ref_idc != 0 */
1185         } bits;
1186         unsigned int value;
1187     } pic_fields;
1188     unsigned short frame_num;
1189 } VAPictureParameterBufferH264;
1190
1191 /* H.264 Inverse Quantization Matrix Buffer */
1192 typedef struct _VAIQMatrixBufferH264
1193 {
1194     unsigned char ScalingList4x4[6][16];
1195     unsigned char ScalingList8x8[2][64];
1196 } VAIQMatrixBufferH264;
1197
1198 /*
1199  * H.264 Slice Group Map Buffer
1200  * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1201  * A slice group map buffer should be sent for each picture if required. The buffer
1202  * is sent only when there is a change in the mapping values.
1203  * The slice group map buffer map "map units" to slice groups as specified in
1204  * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1205  * in raster scan order
1206  */
1207
1208 /* H.264 Slice Parameter Buffer */
1209 typedef struct _VASliceParameterBufferH264
1210 {
1211     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1212     /** \brief Byte offset to the NAL Header Unit for this slice. */
1213     unsigned int slice_data_offset;
1214     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1215     /**
1216      * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1217      *
1218      * This bit offset is relative to and includes the NAL unit byte
1219      * and represents the number of bits parsed in the slice_header()
1220      * after the removal of any emulation prevention bytes in
1221      * there. However, the slice data buffer passed to the hardware is
1222      * the original bitstream, thus including any emulation prevention
1223      * bytes.
1224      */
1225     unsigned short slice_data_bit_offset;
1226     unsigned short first_mb_in_slice;
1227     unsigned char slice_type;
1228     unsigned char direct_spatial_mv_pred_flag;
1229     unsigned char num_ref_idx_l0_active_minus1;
1230     unsigned char num_ref_idx_l1_active_minus1;
1231     unsigned char cabac_init_idc;
1232     char slice_qp_delta;
1233     unsigned char disable_deblocking_filter_idc;
1234     char slice_alpha_c0_offset_div2;
1235     char slice_beta_offset_div2;
1236     VAPictureH264 RefPicList0[32];      /* See 8.2.4.2 */
1237     VAPictureH264 RefPicList1[32];      /* See 8.2.4.2 */
1238     unsigned char luma_log2_weight_denom;
1239     unsigned char chroma_log2_weight_denom;
1240     unsigned char luma_weight_l0_flag;
1241     short luma_weight_l0[32];
1242     short luma_offset_l0[32];
1243     unsigned char chroma_weight_l0_flag;
1244     short chroma_weight_l0[32][2];
1245     short chroma_offset_l0[32][2];
1246     unsigned char luma_weight_l1_flag;
1247     short luma_weight_l1[32];
1248     short luma_offset_l1[32];
1249     unsigned char chroma_weight_l1_flag;
1250     short chroma_weight_l1[32][2];
1251     short chroma_offset_l1[32][2];
1252 } VASliceParameterBufferH264;
1253
1254 /****************************
1255  * Common encode data structures
1256  ****************************/
1257 typedef enum
1258 {
1259     VAEncPictureTypeIntra               = 0,
1260     VAEncPictureTypePredictive          = 1,
1261     VAEncPictureTypeBidirectional       = 2,
1262 } VAEncPictureType;
1263
1264 /* Encode Slice Parameter Buffer */
1265 typedef struct _VAEncSliceParameterBuffer
1266 {
1267     unsigned int start_row_number;      /* starting MB row number for this slice */
1268     unsigned int slice_height;  /* slice height measured in MB */
1269     union {
1270         struct {
1271             unsigned int is_intra       : 1;
1272             unsigned int disable_deblocking_filter_idc : 2;
1273             unsigned int uses_long_term_ref             :1;
1274             unsigned int is_long_term_ref               :1;
1275         } bits;
1276         unsigned int value;
1277     } slice_flags;
1278 } VAEncSliceParameterBuffer;
1279
1280 /****************************
1281  * H.264 specific encode data structures
1282  ****************************/
1283
1284 typedef struct _VAEncSequenceParameterBufferH264Baseline
1285 {
1286     unsigned char seq_parameter_set_id;
1287     unsigned char level_idc;
1288     unsigned int intra_period;
1289     unsigned int intra_idr_period;
1290     unsigned int max_num_ref_frames;
1291     unsigned int picture_width_in_mbs;
1292     unsigned int picture_height_in_mbs;
1293     unsigned int bits_per_second;
1294     unsigned int frame_rate;
1295     unsigned int initial_qp;
1296     unsigned int min_qp;
1297     unsigned int basic_unit_size;
1298     unsigned char vui_flag;
1299 } VAEncSequenceParameterBufferH264Baseline;
1300
1301 #define H264_LAST_PICTURE_EOSEQ     0x01 /* the last picture in the sequence */
1302 #define H264_LAST_PICTURE_EOSTREAM  0x02 /* the last picture in the stream */
1303 typedef struct _VAEncPictureParameterBufferH264Baseline
1304 {
1305     VASurfaceID reference_picture;
1306     VASurfaceID reconstructed_picture;
1307     VABufferID coded_buf;
1308     unsigned short picture_width;
1309     unsigned short picture_height;
1310     unsigned char last_picture;
1311 } VAEncPictureParameterBufferH264Baseline;
1312
1313 /****************************
1314  * H.263 specific encode data structures
1315  ****************************/
1316
1317 typedef struct _VAEncSequenceParameterBufferH263
1318 {
1319     unsigned int intra_period;
1320     unsigned int bits_per_second;
1321     unsigned int frame_rate;
1322     unsigned int initial_qp;
1323     unsigned int min_qp;
1324 } VAEncSequenceParameterBufferH263;
1325
1326 typedef struct _VAEncPictureParameterBufferH263
1327 {
1328     VASurfaceID reference_picture;
1329     VASurfaceID reconstructed_picture;
1330     VABufferID coded_buf;
1331     unsigned short picture_width;
1332     unsigned short picture_height;
1333     VAEncPictureType picture_type;
1334 } VAEncPictureParameterBufferH263;
1335
1336 /****************************
1337  * MPEG-4 specific encode data structures
1338  ****************************/
1339
1340 typedef struct _VAEncSequenceParameterBufferMPEG4
1341 {
1342     unsigned char profile_and_level_indication;
1343     unsigned int intra_period;
1344     unsigned int video_object_layer_width;
1345     unsigned int video_object_layer_height;
1346     unsigned int vop_time_increment_resolution;
1347     unsigned int fixed_vop_rate;
1348     unsigned int fixed_vop_time_increment;
1349     unsigned int bits_per_second;
1350     unsigned int frame_rate;
1351     unsigned int initial_qp;
1352     unsigned int min_qp;
1353 } VAEncSequenceParameterBufferMPEG4;
1354
1355 typedef struct _VAEncPictureParameterBufferMPEG4
1356 {
1357     VASurfaceID reference_picture;
1358     VASurfaceID reconstructed_picture;
1359     VABufferID coded_buf;
1360     unsigned short picture_width;
1361     unsigned short picture_height;
1362     unsigned int modulo_time_base; /* number of 1s */
1363     unsigned int vop_time_increment;
1364     VAEncPictureType picture_type;
1365 } VAEncPictureParameterBufferMPEG4;
1366
1367
1368
1369 /* Buffer functions */
1370
1371 /*
1372  * Creates a buffer for "num_elements" elements of "size" bytes and
1373  * initalize with "data".
1374  * if "data" is null, then the contents of the buffer data store
1375  * are undefined.
1376  * Basically there are two ways to get buffer data to the server side. One is
1377  * to call vaCreateBuffer() with a non-null "data", which results the data being
1378  * copied to the data store on the server side.  A different method that
1379  * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1380  * and then use vaMapBuffer() to map the data store from the server side to the
1381  * client address space for access.
1382  *  Note: image buffers are created by the library, not the client. Please see
1383  *        vaCreateImage on how image buffers are managed.
1384  */
1385 VAStatus vaCreateBuffer (
1386     VADisplay dpy,
1387     VAContextID context,
1388     VABufferType type,  /* in */
1389     unsigned int size,  /* in */
1390     unsigned int num_elements, /* in */
1391     void *data,         /* in */
1392     VABufferID *buf_id  /* out */
1393 );
1394
1395 /*
1396  * Convey to the server how many valid elements are in the buffer.
1397  * e.g. if multiple slice parameters are being held in a single buffer,
1398  * this will communicate to the server the number of slice parameters
1399  * that are valid in the buffer.
1400  */
1401 VAStatus vaBufferSetNumElements (
1402     VADisplay dpy,
1403     VABufferID buf_id,  /* in */
1404     unsigned int num_elements /* in */
1405 );
1406
1407
1408 /*
1409  * device independent data structure for codedbuffer
1410  */
1411
1412 /*
1413  * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1414  * LARGE_SLICE(bit8):At least one slice in the current frame was large
1415  *              enough for the encoder to attempt to limit its size.
1416  * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1417  *              exceeded the maximum slice size specified.
1418  * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1419  * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1420  * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1421  */
1422 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK         0xff
1423 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK            0x100
1424 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK         0x200
1425 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW            0x400
1426 #define VA_CODED_BUF_STATUS_BITRATE_HIGH                0x800
1427 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD       0xff0000
1428
1429 /*
1430  * device independent data structure for codedbuffer
1431  */
1432 typedef  struct _VACodedBufferSegment  {
1433     unsigned int size;/* size of the data buffer in the coded buffer segment, in bytes */
1434     unsigned int bit_offset; /* bit offset into the data buffer where valid bitstream data begins */
1435     unsigned int status; /* status set by the driver on the coded buffer*/
1436     unsigned int reserved; /* for future use */
1437     void *buf; /* pointer to the beginning of the data buffer in the coded buffer segment */
1438     void *next; /* pointer to the next VACodedBufferSegment */
1439 } VACodedBufferSegment;
1440
1441 /*
1442  * Map data store of the buffer into the client's address space
1443  * vaCreateBuffer() needs to be called with "data" set to NULL before
1444  * calling vaMapBuffer()
1445  *
1446  * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1447  * VACodedBufferSegment, and the list is terminated if "next" is NULL
1448  */
1449 VAStatus vaMapBuffer (
1450     VADisplay dpy,
1451     VABufferID buf_id,  /* in */
1452     void **pbuf         /* out */
1453 );
1454
1455 /*
1456  * After client making changes to a mapped data store, it needs to
1457  * "Unmap" it to let the server know that the data is ready to be
1458  * consumed by the server
1459  */
1460 VAStatus vaUnmapBuffer (
1461     VADisplay dpy,
1462     VABufferID buf_id   /* in */
1463 );
1464
1465 /*
1466  * After this call, the buffer is deleted and this buffer_id is no longer valid
1467  * Only call this if the buffer is not going to be passed to vaRenderBuffer
1468  */
1469 VAStatus vaDestroyBuffer (
1470     VADisplay dpy,
1471     VABufferID buffer_id
1472 );
1473
1474 /*
1475 Render (Decode) Pictures
1476
1477 A picture represents either a frame or a field.
1478
1479 The Begin/Render/End sequence sends the decode buffers to the server
1480 */
1481
1482 /*
1483  * Get ready to decode a picture to a target surface
1484  */
1485 VAStatus vaBeginPicture (
1486     VADisplay dpy,
1487     VAContextID context,
1488     VASurfaceID render_target
1489 );
1490
1491 /*
1492  * Send decode buffers to the server.
1493  * Buffers are automatically destroyed afterwards
1494  */
1495 VAStatus vaRenderPicture (
1496     VADisplay dpy,
1497     VAContextID context,
1498     VABufferID *buffers,
1499     int num_buffers
1500 );
1501
1502 /*
1503  * Make the end of rendering for a picture.
1504  * The server should start processing all pending operations for this
1505  * surface. This call is non-blocking. The client can start another
1506  * Begin/Render/End sequence on a different render target.
1507  */
1508 VAStatus vaEndPicture (
1509     VADisplay dpy,
1510     VAContextID context
1511 );
1512
1513 /*
1514
1515 Synchronization
1516
1517 */
1518
1519 /*
1520  * This function blocks until all pending operations on the render target
1521  * have been completed.  Upon return it is safe to use the render target for a
1522  * different picture.
1523  */
1524 VAStatus vaSyncSurface (
1525     VADisplay dpy,
1526     VASurfaceID render_target
1527 );
1528
1529 typedef enum
1530 {
1531     VASurfaceRendering  = 1, /* Rendering in progress */
1532     VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1533                              /* this status is useful if surface is used as the source */
1534                              /* of an overlay */
1535     VASurfaceReady      = 4, /* not being rendered or displayed */
1536     VASurfaceSkipped    = 8  /* Indicate a skipped frame during encode */
1537 } VASurfaceStatus;
1538
1539 /*
1540  * Find out any pending ops on the render target
1541  */
1542 VAStatus vaQuerySurfaceStatus (
1543     VADisplay dpy,
1544     VASurfaceID render_target,
1545     VASurfaceStatus *status     /* out */
1546 );
1547
1548 typedef enum
1549 {
1550     VADecodeSliceMissing            = 0,
1551     VADecodeMBError                 = 1,
1552 } VADecodeErrorType;
1553
1554 /*
1555  * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1556  * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1557 */
1558 typedef struct _VASurfaceDecodeMBErrors
1559 {
1560     int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1561     unsigned int start_mb; /* start mb address with errors */
1562     unsigned int end_mb;  /* end mb address with errors */
1563     VADecodeErrorType decode_error_type;
1564 } VASurfaceDecodeMBErrors;
1565
1566 /*
1567  * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1568  * it can call vaQuerySurfaceError to find out further details on the particular error.
1569  * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1570  * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1571  * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1572  * The array is terminated if "status==-1" is detected.
1573  */
1574 VAStatus vaQuerySurfaceError(
1575     VADisplay dpy,
1576     VASurfaceID surface,
1577     VAStatus error_status,
1578     void **error_info
1579 );
1580
1581 /*
1582  * Images and Subpictures
1583  * VAImage is used to either get the surface data to client memory, or
1584  * to copy image data in client memory to a surface.
1585  * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1586  * is at the upper left corner with positive X to the right and positive Y down
1587  */
1588 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1589     ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1590     ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1591
1592 /* a few common FourCCs */
1593 #define VA_FOURCC_NV12          0x3231564E
1594 #define VA_FOURCC_AI44          0x34344149
1595 #define VA_FOURCC_RGBA          0x41424752
1596 #define VA_FOURCC_BGRA          0x41524742
1597 #define VA_FOURCC_UYVY          0x59565955
1598 #define VA_FOURCC_YUY2          0x32595559
1599 #define VA_FOURCC_AYUV          0x56555941
1600 #define VA_FOURCC_NV11          0x3131564e
1601 #define VA_FOURCC_YV12          0x32315659
1602 #define VA_FOURCC_P208          0x38303250
1603 #define VA_FOURCC_IYUV          0x56555949
1604
1605 /* byte order */
1606 #define VA_LSB_FIRST            1
1607 #define VA_MSB_FIRST            2
1608
1609 typedef struct _VAImageFormat
1610 {
1611     unsigned int        fourcc;
1612     unsigned int        byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1613     unsigned int        bits_per_pixel;
1614     /* for RGB formats */
1615     unsigned int        depth; /* significant bits per pixel */
1616     unsigned int        red_mask;
1617     unsigned int        green_mask;
1618     unsigned int        blue_mask;
1619     unsigned int        alpha_mask;
1620 } VAImageFormat;
1621
1622 typedef VAGenericID VAImageID;
1623
1624 typedef struct _VAImage
1625 {
1626     VAImageID           image_id; /* uniquely identify this image */
1627     VAImageFormat       format;
1628     VABufferID          buf;    /* image data buffer */
1629     /*
1630      * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1631      * data store on the server side for optimal performance. The buffer will be
1632      * created by the CreateImage function, and proper storage allocated based on the image
1633      * size and format. This buffer is managed by the library implementation, and
1634      * accessed by the client through the buffer Map/Unmap functions.
1635      */
1636     unsigned short      width;
1637     unsigned short      height;
1638     unsigned int        data_size;
1639     unsigned int        num_planes;     /* can not be greater than 3 */
1640     /*
1641      * An array indicating the scanline pitch in bytes for each plane.
1642      * Each plane may have a different pitch. Maximum 3 planes for planar formats
1643      */
1644     unsigned int        pitches[3];
1645     /*
1646      * An array indicating the byte offset from the beginning of the image data
1647      * to the start of each plane.
1648      */
1649     unsigned int        offsets[3];
1650
1651     /* The following fields are only needed for paletted formats */
1652     int num_palette_entries;   /* set to zero for non-palette images */
1653     /*
1654      * Each component is one byte and entry_bytes indicates the number of components in
1655      * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1656      */
1657     int entry_bytes;
1658     /*
1659      * An array of ascii characters describing the order of the components within the bytes.
1660      * Only entry_bytes characters of the string are used.
1661      */
1662     char component_order[4];
1663 } VAImage;
1664
1665 /* Get maximum number of image formats supported by the implementation */
1666 int vaMaxNumImageFormats (
1667     VADisplay dpy
1668 );
1669
1670 /*
1671  * Query supported image formats
1672  * The caller must provide a "format_list" array that can hold at
1673  * least vaMaxNumImageFormats() entries. The actual number of formats
1674  * returned in "format_list" is returned in "num_formats".
1675  */
1676 VAStatus vaQueryImageFormats (
1677     VADisplay dpy,
1678     VAImageFormat *format_list, /* out */
1679     int *num_formats            /* out */
1680 );
1681
1682 /*
1683  * Create a VAImage structure
1684  * The width and height fields returned in the VAImage structure may get
1685  * enlarged for some YUV formats. Upon return from this function,
1686  * image->buf has been created and proper storage allocated by the library.
1687  * The client can access the image through the Map/Unmap calls.
1688  */
1689 VAStatus vaCreateImage (
1690     VADisplay dpy,
1691     VAImageFormat *format,
1692     int width,
1693     int height,
1694     VAImage *image      /* out */
1695 );
1696
1697 /*
1698  * Should call DestroyImage before destroying the surface it is bound to
1699  */
1700 VAStatus vaDestroyImage (
1701     VADisplay dpy,
1702     VAImageID image
1703 );
1704
1705 VAStatus vaSetImagePalette (
1706     VADisplay dpy,
1707     VAImageID image,
1708     /*
1709      * pointer to an array holding the palette data.  The size of the array is
1710      * num_palette_entries * entry_bytes in size.  The order of the components
1711      * in the palette is described by the component_order in VAImage struct
1712      */
1713     unsigned char *palette
1714 );
1715
1716 /*
1717  * Retrive surface data into a VAImage
1718  * Image must be in a format supported by the implementation
1719  */
1720 VAStatus vaGetImage (
1721     VADisplay dpy,
1722     VASurfaceID surface,
1723     int x,      /* coordinates of the upper left source pixel */
1724     int y,
1725     unsigned int width, /* width and height of the region */
1726     unsigned int height,
1727     VAImageID image
1728 );
1729
1730 /*
1731  * Copy data from a VAImage to a surface
1732  * Image must be in a format supported by the implementation
1733  * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1734  * shouldn't be rendered into when this is called
1735  */
1736 VAStatus vaPutImage (
1737     VADisplay dpy,
1738     VASurfaceID surface,
1739     VAImageID image,
1740     int src_x,
1741     int src_y,
1742     unsigned int src_width,
1743     unsigned int src_height,
1744     int dest_x,
1745     int dest_y,
1746     unsigned int dest_width,
1747     unsigned int dest_height
1748 );
1749
1750 /*
1751  * Derive an VAImage from an existing surface.
1752  * This interface will derive a VAImage and corresponding image buffer from
1753  * an existing VA Surface. The image buffer can then be mapped/unmapped for
1754  * direct CPU access. This operation is only possible on implementations with
1755  * direct rendering capabilities and internal surface formats that can be
1756  * represented with a VAImage. When the operation is not possible this interface
1757  * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1758  * to using vaCreateImage + vaPutImage to accomplish the same task in an
1759  * indirect manner.
1760  *
1761  * Implementations should only return success when the resulting image buffer
1762  * would be useable with vaMap/Unmap.
1763  *
1764  * When directly accessing a surface special care must be taken to insure
1765  * proper synchronization with the graphics hardware. Clients should call
1766  * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1767  * rendering or currently being displayed by an overlay.
1768  *
1769  * Additionally nothing about the contents of a surface should be assumed
1770  * following a vaPutSurface. Implementations are free to modify the surface for
1771  * scaling or subpicture blending within a call to vaPutImage.
1772  *
1773  * Calls to vaPutImage or vaGetImage using the same surface from which the image
1774  * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1775  * vaGetImage with other surfaces is supported.
1776  *
1777  * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1778  * image and image buffer structures will be destroyed; however, the underlying
1779  * surface will remain unchanged until freed with vaDestroySurfaces.
1780  */
1781 VAStatus vaDeriveImage (
1782     VADisplay dpy,
1783     VASurfaceID surface,
1784     VAImage *image      /* out */
1785 );
1786
1787 /*
1788  * Subpictures
1789  * Subpicture is a special type of image that can be blended
1790  * with a surface during vaPutSurface(). Subpicture can be used to render
1791  * DVD sub-titles or closed captioning text etc.
1792  */
1793
1794 typedef VAGenericID VASubpictureID;
1795
1796 /* Get maximum number of subpicture formats supported by the implementation */
1797 int vaMaxNumSubpictureFormats (
1798     VADisplay dpy
1799 );
1800
1801 /* flags for subpictures */
1802 #define VA_SUBPICTURE_CHROMA_KEYING                     0x0001
1803 #define VA_SUBPICTURE_GLOBAL_ALPHA                      0x0002
1804 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD       0x0004
1805 /*
1806  * Query supported subpicture formats
1807  * The caller must provide a "format_list" array that can hold at
1808  * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1809  * for each format to indicate additional capabilities for that format. The actual
1810  * number of formats returned in "format_list" is returned in "num_formats".
1811  *  flags: returned value to indicate addtional capabilities
1812  *         VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1813  *         VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1814  *         VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
1815  */
1816
1817 VAStatus vaQuerySubpictureFormats (
1818     VADisplay dpy,
1819     VAImageFormat *format_list, /* out */
1820     unsigned int *flags,        /* out */
1821     unsigned int *num_formats   /* out */
1822 );
1823
1824 /*
1825  * Subpictures are created with an image associated.
1826  */
1827 VAStatus vaCreateSubpicture (
1828     VADisplay dpy,
1829     VAImageID image,
1830     VASubpictureID *subpicture  /* out */
1831 );
1832
1833 /*
1834  * Destroy the subpicture before destroying the image it is assocated to
1835  */
1836 VAStatus vaDestroySubpicture (
1837     VADisplay dpy,
1838     VASubpictureID subpicture
1839 );
1840
1841 /*
1842  * Bind an image to the subpicture. This image will now be associated with
1843  * the subpicture instead of the one at creation.
1844  */
1845 VAStatus vaSetSubpictureImage (
1846     VADisplay dpy,
1847     VASubpictureID subpicture,
1848     VAImageID image
1849 );
1850
1851 /*
1852  * If chromakey is enabled, then the area where the source value falls within
1853  * the chromakey [min, max] range is transparent
1854  * The chromakey component format is the following:
1855  *  For RGB: [0:7] Red [8:15] Blue [16:23] Green
1856  *  For YUV: [0:7] V [8:15] U [16:23] Y
1857  * The chromakey mask can be used to mask out certain components for chromakey
1858  * comparision
1859  */
1860 VAStatus vaSetSubpictureChromakey (
1861     VADisplay dpy,
1862     VASubpictureID subpicture,
1863     unsigned int chromakey_min,
1864     unsigned int chromakey_max,
1865     unsigned int chromakey_mask
1866 );
1867
1868 /*
1869  * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
1870  * a value of 0 means fully transparent. If per-pixel alpha is also specified then
1871  * the overall alpha is per-pixel alpha multiplied by the global alpha
1872  */
1873 VAStatus vaSetSubpictureGlobalAlpha (
1874     VADisplay dpy,
1875     VASubpictureID subpicture,
1876     float global_alpha
1877 );
1878
1879 /*
1880  * vaAssociateSubpicture associates the subpicture with target_surfaces.
1881  * It defines the region mapping between the subpicture and the target
1882  * surfaces through source and destination rectangles (with the same width and height).
1883  * Both will be displayed at the next call to vaPutSurface.  Additional
1884  * associations before the call to vaPutSurface simply overrides the association.
1885  */
1886 VAStatus vaAssociateSubpicture (
1887     VADisplay dpy,
1888     VASubpictureID subpicture,
1889     VASurfaceID *target_surfaces,
1890     int num_surfaces,
1891     short src_x, /* upper left offset in subpicture */
1892     short src_y,
1893     unsigned short src_width,
1894     unsigned short src_height,
1895     short dest_x, /* upper left offset in surface */
1896     short dest_y,
1897     unsigned short dest_width,
1898     unsigned short dest_height,
1899     /*
1900      * whether to enable chroma-keying, global-alpha, or screen relative mode
1901      * see VA_SUBPICTURE_XXX values
1902      */
1903     unsigned int flags
1904 );
1905
1906 /*
1907  * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
1908  */
1909 VAStatus vaDeassociateSubpicture (
1910     VADisplay dpy,
1911     VASubpictureID subpicture,
1912     VASurfaceID *target_surfaces,
1913     int num_surfaces
1914 );
1915
1916 typedef struct _VARectangle
1917 {
1918     short x;
1919     short y;
1920     unsigned short width;
1921     unsigned short height;
1922 } VARectangle;
1923
1924 /*
1925  * Display attributes
1926  * Display attributes are used to control things such as contrast, hue, saturation,
1927  * brightness etc. in the rendering process.  The application can query what
1928  * attributes are supported by the driver, and then set the appropriate attributes
1929  * before calling vaPutSurface()
1930  */
1931 /* PowerVR IEP Lite attributes */
1932 typedef enum
1933 {
1934     VADISPLAYATTRIB_BLE_OFF              = 0x00,
1935     VADISPLAYATTRIB_BLE_LOW,
1936     VADISPLAYATTRIB_BLE_MEDIUM,
1937     VADISPLAYATTRIB_BLE_HIGH,
1938     VADISPLAYATTRIB_BLE_NONE,
1939 } VADisplayAttribBLEMode;
1940
1941 /* attribute value for VADisplayAttribRotation   */
1942 #define VA_ROTATION_NONE        0x00000000
1943 #define VA_ROTATION_90          0x00000001
1944 #define VA_ROTATION_180         0x00000002
1945 #define VA_ROTATION_270         0x00000003
1946
1947 /* attribute value for VADisplayAttribOutOfLoopDeblock */
1948 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
1949 #define VA_OOL_DEBLOCKING_TRUE  0x00000001
1950
1951 /* Render mode */
1952 #define VA_RENDER_MODE_UNDEFINED           0
1953 #define VA_RENDER_MODE_LOCAL_OVERLAY       1
1954 #define VA_RENDER_MODE_LOCAL_GPU           2
1955 #define VA_RENDER_MODE_EXTERNAL_OVERLAY    4
1956 #define VA_RENDER_MODE_EXTERNAL_GPU        8
1957
1958 /* Render device */
1959 #define VA_RENDER_DEVICE_UNDEFINED  0
1960 #define VA_RENDER_DEVICE_LOCAL      1
1961 #define VA_RENDER_DEVICE_EXTERNAL   2
1962
1963 /* Currently defined display attribute types */
1964 typedef enum
1965 {
1966     VADisplayAttribBrightness           = 0,
1967     VADisplayAttribContrast             = 1,
1968     VADisplayAttribHue                  = 2,
1969     VADisplayAttribSaturation           = 3,
1970     /* client can specifiy a background color for the target window
1971      * the new feature of video conference,
1972      * the uncovered area of the surface is filled by this color
1973      * also it will blend with the decoded video color
1974      */
1975     VADisplayAttribBackgroundColor      = 4,
1976     /*
1977      * this is a gettable only attribute. For some implementations that use the
1978      * hardware overlay, after PutSurface is called, the surface can not be
1979      * re-used until after the subsequent PutSurface call. If this is the case
1980      * then the value for this attribute will be set to 1 so that the client
1981      * will not attempt to re-use the surface right after returning from a call
1982      * to PutSurface.
1983      *
1984      * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
1985      * driver may use overlay or GPU alternatively
1986      */
1987     VADisplayAttribDirectSurface       = 5,
1988     VADisplayAttribRotation            = 6,
1989     VADisplayAttribOutofLoopDeblock    = 7,
1990
1991     /* PowerVR IEP Lite specific attributes */
1992     VADisplayAttribBLEBlackMode        = 8,
1993     VADisplayAttribBLEWhiteMode        = 9,
1994     VADisplayAttribBlueStretch         = 10,
1995     VADisplayAttribSkinColorCorrection = 11,
1996     /*
1997      * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
1998      * conversion matrix. Each element in the matrix is float-point
1999      */
2000     VADisplayAttribCSCMatrix           = 12,
2001     /* specify the constant color used to blend with video surface
2002      * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2003      *      d: the final color to overwrite into the frame buffer
2004      *      v: decoded video after color conversion,
2005      *      c: video color specified by VADisplayAttribBlendColor
2006      *      b: background color of the drawable
2007      */
2008     VADisplayAttribBlendColor          = 13,
2009     /*
2010      * Indicate driver to skip painting color key or not.
2011      * only applicable if the render is overlay
2012      */
2013     VADisplayAttribOverlayAutoPaintColorKey   = 14,
2014     /*
2015      * customized overlay color key, the format is RGB888
2016      * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2017      */
2018     VADisplayAttribOverlayColorKey      = 15,
2019     /*
2020      * The hint for the implementation of vaPutSurface
2021      * normally, the driver could use an overlay or GPU to render the surface on the screen
2022      * this flag provides APP the flexibity to switch the render dynamically
2023      */
2024     VADisplayAttribRenderMode           = 16,
2025     /*
2026      * specify if vaPutSurface needs to render into specified monitors
2027      * one example is that one external monitor (e.g. HDMI) is enabled,
2028      * but the window manager is not aware of it, and there is no associated drawable
2029      */
2030     VADisplayAttribRenderDevice        = 17,
2031     /*
2032      * specify vaPutSurface render area if there is no drawable on the monitor
2033      */
2034     VADisplayAttribRenderRect          = 18,
2035 } VADisplayAttribType;
2036
2037 /* flags for VADisplayAttribute */
2038 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2039 #define VA_DISPLAY_ATTRIB_GETTABLE      0x0001
2040 #define VA_DISPLAY_ATTRIB_SETTABLE      0x0002
2041
2042 typedef struct _VADisplayAttribute
2043 {
2044     VADisplayAttribType type;
2045     int min_value;
2046     int max_value;
2047     int value;  /* used by the set/get attribute functions */
2048 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2049     unsigned int flags;
2050 } VADisplayAttribute;
2051
2052 /* Get maximum number of display attributs supported by the implementation */
2053 int vaMaxNumDisplayAttributes (
2054     VADisplay dpy
2055 );
2056
2057 /*
2058  * Query display attributes
2059  * The caller must provide a "attr_list" array that can hold at
2060  * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2061  * returned in "attr_list" is returned in "num_attributes".
2062  */
2063 VAStatus vaQueryDisplayAttributes (
2064     VADisplay dpy,
2065     VADisplayAttribute *attr_list,      /* out */
2066     int *num_attributes                 /* out */
2067 );
2068
2069 /*
2070  * Get display attributes
2071  * This function returns the current attribute values in "attr_list".
2072  * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2073  * from vaQueryDisplayAttributes() can have their values retrieved.
2074  */
2075 VAStatus vaGetDisplayAttributes (
2076     VADisplay dpy,
2077     VADisplayAttribute *attr_list,      /* in/out */
2078     int num_attributes
2079 );
2080
2081 /*
2082  * Set display attributes
2083  * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2084  * from vaQueryDisplayAttributes() can be set.  If the attribute is not settable or
2085  * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2086  */
2087 VAStatus vaSetDisplayAttributes (
2088     VADisplay dpy,
2089     VADisplayAttribute *attr_list,
2090     int num_attributes
2091 );
2092
2093 #ifdef __cplusplus
2094 }
2095 #endif
2096
2097 #endif /* _VA_H_ */