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