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