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