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