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