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