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