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