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