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/** 72 * \file va.h 73 * \brief The Core API 74 * 75 * This file contains the \ref api_core "Core API". 76 */ 77 78#ifndef _VA_H_ 79#define _VA_H_ 80 81#include <va/va_version.h> 82 83#ifdef __cplusplus 84extern "C" { 85#endif 86 87/** 88 * \mainpage Video Acceleration (VA) API 89 * 90 * \section intro Introduction 91 * 92 * The main motivation for VA-API (Video Acceleration API) is to 93 * enable hardware accelerated video decode and encode at various 94 * entry-points (VLD, IDCT, Motion Compensation etc.) for the 95 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4 96 * AVC/H.264, VC-1/VMW3, and JPEG). 97 * 98 * VA-API is split into several modules: 99 * - \ref api_core 100 * - \ref api_enc_core 101 * - \ref api_enc_h264 102 * - \ref api_vpp 103 */ 104 105/** 106 * \defgroup api_core Core API 107 * 108 * @{ 109 */ 110 111/* 112Overview 113 114The VA API is intended to provide an interface between a video decode/encode/display 115application (client) and a hardware accelerator (server), to off-load 116video decode/encode/display operations from the host to the hardware accelerator at various 117entry-points. 118 119The basic operation steps are: 120 121- Negotiate a mutually acceptable configuration with the server to lock 122 down profile, entrypoints, and other attributes that will not change on 123 a frame-by-frame basis. 124- Create a decode context which represents a "virtualized" hardware decode 125 device 126- Get and fill decode buffers with picture level, slice level and macroblock 127 level data (depending on entrypoints) 128- Pass the decode buffers to the server to decode the current frame 129 130Initialization & Configuration Management 131 132- Find out supported profiles 133- Find out entrypoints for a given profile 134- Find out configuration attributes for a given profile/entrypoint pair 135- Create a configuration for use by the decoder 136 137*/ 138 139typedef void* VADisplay; /* window system dependent */ 140 141typedef int VAStatus; /* Return status type from functions */ 142/* Values for the return status */ 143#define VA_STATUS_SUCCESS 0x00000000 144#define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001 145#define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002 146#define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003 147#define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004 148#define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005 149#define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006 150#define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007 151#define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008 152#define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009 153#define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a 154#define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b 155#define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c 156#define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d 157#define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e 158#define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f 159#define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010 160#define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011 161#define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012 162#define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013 163#define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014 164#define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015 165#define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016 166#define VA_STATUS_ERROR_DECODING_ERROR 0x00000017 167#define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018 168/** 169 * \brief An invalid/unsupported value was supplied. 170 * 171 * This is a catch-all error code for invalid or unsupported values. 172 * e.g. value exceeding the valid range, invalid type in the context 173 * of generic attribute values. 174 */ 175#define VA_STATUS_ERROR_INVALID_VALUE 0x00000019 176/** \brief An unsupported filter was supplied. */ 177#define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020 178/** \brief An invalid filter chain was supplied. */ 179#define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021 180/** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */ 181#define VA_STATUS_ERROR_HW_BUSY 0x00000022 182#define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF 183 184/* De-interlacing flags for vaPutSurface() */ 185#define VA_FRAME_PICTURE 0x00000000 186#define VA_TOP_FIELD 0x00000001 187#define VA_BOTTOM_FIELD 0x00000002 188 189/* 190 * Enabled the positioning/cropping/blending feature: 191 * 1, specify the video playback position in the isurface 192 * 2, specify the cropping info for video playback 193 * 3, encoded video will blend with background color 194 */ 195#define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */ 196 197/* 198 * Clears the drawable with background color. 199 * for hardware overlay based implementation this flag 200 * can be used to turn off the overlay 201 */ 202#define VA_CLEAR_DRAWABLE 0x00000008 203 204/* Color space conversion flags for vaPutSurface() */ 205#define VA_SRC_BT601 0x00000010 206#define VA_SRC_BT709 0x00000020 207#define VA_SRC_SMPTE_240 0x00000040 208 209/* Scaling flags for vaPutSurface() */ 210#define VA_FILTER_SCALING_DEFAULT 0x00000000 211#define VA_FILTER_SCALING_FAST 0x00000100 212#define VA_FILTER_SCALING_HQ 0x00000200 213#define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300 214#define VA_FILTER_SCALING_MASK 0x00000f00 215 216/* 217 * Returns a short english description of error_status 218 */ 219const char *vaErrorStr(VAStatus error_status); 220 221/* 222 * Initialization: 223 * A display must be obtained by calling vaGetDisplay() before calling 224 * vaInitialize() and other functions. This connects the API to the 225 * native window system. 226 * For X Windows, native_dpy would be from XOpenDisplay() 227 */ 228typedef void* VANativeDisplay; /* window system dependent */ 229 230int vaDisplayIsValid(VADisplay dpy); 231 232/* 233 * Initialize the library 234 */ 235VAStatus vaInitialize ( 236 VADisplay dpy, 237 int *major_version, /* out */ 238 int *minor_version /* out */ 239); 240 241/* 242 * After this call, all library internal resources will be cleaned up 243 */ 244VAStatus vaTerminate ( 245 VADisplay dpy 246); 247 248/* 249 * vaQueryVendorString returns a pointer to a zero-terminated string 250 * describing some aspects of the VA implemenation on a specific 251 * hardware accelerator. The format of the returned string is vendor 252 * specific and at the discretion of the implementer. 253 * e.g. for the Intel GMA500 implementation, an example would be: 254 * "Intel GMA500 - 2.0.0.32L.0005" 255 */ 256const char *vaQueryVendorString ( 257 VADisplay dpy 258); 259 260typedef int (*VAPrivFunc)(); 261 262/* 263 * Return a function pointer given a function name in the library. 264 * This allows private interfaces into the library 265 */ 266VAPrivFunc vaGetLibFunc ( 267 VADisplay dpy, 268 const char *func 269); 270 271/* Currently defined profiles */ 272typedef enum 273{ 274 /** \brief Profile ID used for video processing. */ 275 VAProfileNone = -1, 276 VAProfileMPEG2Simple = 0, 277 VAProfileMPEG2Main = 1, 278 VAProfileMPEG4Simple = 2, 279 VAProfileMPEG4AdvancedSimple = 3, 280 VAProfileMPEG4Main = 4, 281 VAProfileH264Baseline = 5, 282 VAProfileH264Main = 6, 283 VAProfileH264High = 7, 284 VAProfileVC1Simple = 8, 285 VAProfileVC1Main = 9, 286 VAProfileVC1Advanced = 10, 287 VAProfileH263Baseline = 11, 288 VAProfileJPEGBaseline = 12, 289 VAProfileH264ConstrainedBaseline = 13 290} VAProfile; 291 292/* 293 * Currently defined entrypoints 294 */ 295typedef enum 296{ 297 VAEntrypointVLD = 1, 298 VAEntrypointIZZ = 2, 299 VAEntrypointIDCT = 3, 300 VAEntrypointMoComp = 4, 301 VAEntrypointDeblocking = 5, 302 VAEntrypointEncSlice = 6, /* slice level encode */ 303 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */ 304 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */ 305 VAEntrypointMax 306} VAEntrypoint; 307 308/* Currently defined configuration attribute types */ 309typedef enum 310{ 311 VAConfigAttribRTFormat = 0, 312 VAConfigAttribSpatialResidual = 1, 313 VAConfigAttribSpatialClipping = 2, 314 VAConfigAttribIntraResidual = 3, 315 VAConfigAttribEncryption = 4, 316 VAConfigAttribRateControl = 5, 317 318 /** @name Attributes for encoding */ 319 /**@{*/ 320 /** 321 * \brief Packed headers mode. Read/write. 322 * 323 * This attribute determines what packed headers the driver supports, 324 * through vaGetConfigAttributes(); and what packed headers the user 325 * will be providing to the driver, through vaCreateConfig(), if the 326 * driver supports those. 327 * 328 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers. 329 */ 330 VAConfigAttribEncPackedHeaders = 10, 331 /** 332 * \brief Interlaced mode. Read/write. 333 * 334 * This attribute determines what kind of interlaced encoding mode 335 * the driver supports. 336 * 337 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes. 338 */ 339 VAConfigAttribEncInterlaced = 11, 340 /** 341 * \brief Maximum number of reference frames. Read-only. 342 * 343 * This attribute determines the maximum number of reference 344 * frames supported for encoding. 345 * 346 * Note: for H.264 encoding, the value represents the maximum number 347 * of reference frames for both the reference picture list 0 (bottom 348 * 16 bits) and the reference picture list 1 (top 16 bits). 349 */ 350 VAConfigAttribEncMaxRefFrames = 13, 351 /** 352 * \brief Maximum number of slices per frame. Read-only. 353 * 354 * This attribute determines the maximum number of slices the 355 * driver can support to encode a single frame. 356 */ 357 VAConfigAttribEncMaxSlices = 14, 358 /** 359 * \brief Slice structure. Read-only. 360 * 361 * This attribute determines slice structures supported by the 362 * driver for encoding. This attribute is a hint to the user so 363 * that he can choose a suitable surface size and how to arrange 364 * the encoding process of multiple slices per frame. 365 * 366 * More specifically, for H.264 encoding, this attribute 367 * determines the range of accepted values to 368 * VAEncSliceParameterBufferH264::macroblock_address and 369 * VAEncSliceParameterBufferH264::num_macroblocks. 370 * 371 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice 372 * structure types. 373 */ 374 VAConfigAttribEncSliceStructure = 15, 375 /** 376 * \brief Macroblock information. Read-only. 377 * 378 * This attribute determines whether the driver supports extra 379 * encoding information per-macroblock. e.g. QP. 380 * 381 * More specifically, for H.264 encoding, if the driver returns a non-zero 382 * value for this attribute, this means the application can create 383 * additional #VAEncMacroblockParameterBufferH264 buffers referenced 384 * through VAEncSliceParameterBufferH264::macroblock_info. 385 */ 386 VAConfigAttribEncMacroblockInfo = 16, 387 /**@}*/ 388 VAConfigAttribTypeMax 389} VAConfigAttribType; 390 391/* 392 * Configuration attributes 393 * If there is more than one value for an attribute, a default 394 * value will be assigned to the attribute if the client does not 395 * specify the attribute when creating a configuration 396 */ 397typedef struct _VAConfigAttrib { 398 VAConfigAttribType type; 399 unsigned int value; /* OR'd flags (bits) for this attribute */ 400} VAConfigAttrib; 401 402/* attribute value for VAConfigAttribRTFormat */ 403#define VA_RT_FORMAT_YUV420 0x00000001 404#define VA_RT_FORMAT_YUV422 0x00000002 405#define VA_RT_FORMAT_YUV444 0x00000004 406#define VA_RT_FORMAT_YUV411 0x00000008 407#define VA_RT_FORMAT_YUV400 0x00000010 408#define VA_RT_FORMAT_RGB16 0x00010000 409#define VA_RT_FORMAT_RGB32 0x00020000 410/* RGBP covers RGBP and BGRP fourcc */ 411#define VA_RT_FORMAT_RGBP 0x00100000 412#define VA_RT_FORMAT_PROTECTED 0x80000000 413 414/** @name Attribute values for VAConfigAttribRateControl */ 415/**@{*/ 416/** \brief Driver does not support any form of rate control. */ 417#define VA_RC_NONE 0x00000001 418/** \brief Constant bitrate. */ 419#define VA_RC_CBR 0x00000002 420/** \brief Variable bitrate. */ 421#define VA_RC_VBR 0x00000004 422/** \brief Video conference mode. */ 423#define VA_RC_VCM 0x00000008 424/** \brief Constant QP. */ 425#define VA_RC_CQP 0x00000010 426/** \brief Variable bitrate with peak rate higher than average bitrate. */ 427#define VA_RC_VBR_CONSTRAINED 0x00000020 428/**@}*/ 429 430/** @name Attribute values for VAConfigAttribEncPackedHeaders */ 431/**@{*/ 432/** \brief Driver does not support any packed headers mode. */ 433#define VA_ENC_PACKED_HEADER_NONE 0x00000000 434/** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */ 435#define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001 436/** \brief Driver supports packed picture headers. e.g. PPS for H.264. */ 437#define VA_ENC_PACKED_HEADER_PICTURE 0x00000002 438/** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */ 439#define VA_ENC_PACKED_HEADER_SLICE 0x00000004 440/** \brief Driver supports misc packed headers. e.g. SEI for H.264. */ 441#define VA_ENC_PACKED_HEADER_MISC 0x00000008 442/** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */ 443#define VA_ENC_PACKED_HEADER_RAW_DATA 0x0000000C 444/**@}*/ 445 446/** @name Attribute values for VAConfigAttribEncInterlaced */ 447/**@{*/ 448/** \brief Driver does not support interlaced coding. */ 449#define VA_ENC_INTERLACED_NONE 0x00000000 450/** \brief Driver supports interlaced frame coding. */ 451#define VA_ENC_INTERLACED_FRAME 0x00000001 452/** \brief Driver supports interlaced field coding. */ 453#define VA_ENC_INTERLACED_FIELD 0x00000002 454/** \brief Driver supports macroblock adaptive frame field coding. */ 455#define VA_ENC_INTERLACED_MBAFF 0x00000004 456/** \brief Driver supports picture adaptive frame field coding. */ 457#define VA_ENC_INTERLACED_PAFF 0x00000008 458/**@}*/ 459 460/** @name Attribute values for VAConfigAttribEncSliceStructure */ 461/**@{*/ 462/** \brief Driver supports an arbitrary number of rows per slice. */ 463#define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000 464/** \brief Driver supports a power-of-two number of rows per slice. */ 465#define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001 466/** \brief Driver supports an arbitrary number of rows per slice. */ 467#define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002 468/**@}*/ 469 470/* 471 * if an attribute is not applicable for a given 472 * profile/entrypoint pair, then set the value to the following 473 */ 474#define VA_ATTRIB_NOT_SUPPORTED 0x80000000 475 476/* Get maximum number of profiles supported by the implementation */ 477int vaMaxNumProfiles ( 478 VADisplay dpy 479); 480 481/* Get maximum number of entrypoints supported by the implementation */ 482int vaMaxNumEntrypoints ( 483 VADisplay dpy 484); 485 486/* Get maximum number of attributs supported by the implementation */ 487int vaMaxNumConfigAttributes ( 488 VADisplay dpy 489); 490 491/* 492 * Query supported profiles 493 * The caller must provide a "profile_list" array that can hold at 494 * least vaMaxNumProfile() entries. The actual number of profiles 495 * returned in "profile_list" is returned in "num_profile". 496 */ 497VAStatus vaQueryConfigProfiles ( 498 VADisplay dpy, 499 VAProfile *profile_list, /* out */ 500 int *num_profiles /* out */ 501); 502 503/* 504 * Query supported entrypoints for a given profile 505 * The caller must provide an "entrypoint_list" array that can hold at 506 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints 507 * returned in "entrypoint_list" is returned in "num_entrypoints". 508 */ 509VAStatus vaQueryConfigEntrypoints ( 510 VADisplay dpy, 511 VAProfile profile, 512 VAEntrypoint *entrypoint_list, /* out */ 513 int *num_entrypoints /* out */ 514); 515 516/* 517 * Get attributes for a given profile/entrypoint pair 518 * The caller must provide an "attrib_list" with all attributes to be 519 * retrieved. Upon return, the attributes in "attrib_list" have been 520 * updated with their value. Unknown attributes or attributes that are 521 * not supported for the given profile/entrypoint pair will have their 522 * value set to VA_ATTRIB_NOT_SUPPORTED 523 */ 524VAStatus vaGetConfigAttributes ( 525 VADisplay dpy, 526 VAProfile profile, 527 VAEntrypoint entrypoint, 528 VAConfigAttrib *attrib_list, /* in/out */ 529 int num_attribs 530); 531 532/* Generic ID type, can be re-typed for specific implementation */ 533typedef unsigned int VAGenericID; 534 535typedef VAGenericID VAConfigID; 536 537/* 538 * Create a configuration for the decode pipeline 539 * it passes in the attribute list that specifies the attributes it cares 540 * about, with the rest taking default values. 541 */ 542VAStatus vaCreateConfig ( 543 VADisplay dpy, 544 VAProfile profile, 545 VAEntrypoint entrypoint, 546 VAConfigAttrib *attrib_list, 547 int num_attribs, 548 VAConfigID *config_id /* out */ 549); 550 551/* 552 * Free resources associdated with a given config 553 */ 554VAStatus vaDestroyConfig ( 555 VADisplay dpy, 556 VAConfigID config_id 557); 558 559/* 560 * Query all attributes for a given configuration 561 * The profile of the configuration is returned in "profile" 562 * The entrypoint of the configuration is returned in "entrypoint" 563 * The caller must provide an "attrib_list" array that can hold at least 564 * vaMaxNumConfigAttributes() entries. The actual number of attributes 565 * returned in "attrib_list" is returned in "num_attribs" 566 */ 567VAStatus vaQueryConfigAttributes ( 568 VADisplay dpy, 569 VAConfigID config_id, 570 VAProfile *profile, /* out */ 571 VAEntrypoint *entrypoint, /* out */ 572 VAConfigAttrib *attrib_list,/* out */ 573 int *num_attribs /* out */ 574); 575 576 577/* 578 * Contexts and Surfaces 579 * 580 * Context represents a "virtual" video decode pipeline. Surfaces are render 581 * targets for a given context. The data in the surfaces are not accessible 582 * to the client and the internal data format of the surface is implementatin 583 * specific. 584 * 585 * Surfaces will be bound to a context when the context is created. Once 586 * a surface is bound to a given context, it can not be used to create 587 * another context. The association is removed when the context is destroyed 588 * 589 * Both contexts and surfaces are identified by unique IDs and its 590 * implementation specific internals are kept opaque to the clients 591 */ 592 593typedef VAGenericID VAContextID; 594 595typedef VAGenericID VASurfaceID; 596 597#define VA_INVALID_ID 0xffffffff 598#define VA_INVALID_SURFACE VA_INVALID_ID 599 600/** \brief Generic value types. */ 601typedef enum { 602 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */ 603 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */ 604 VAGenericValueTypePointer, /**< Generic pointer type */ 605 VAGenericValueTypeFunc /**< Pointer to function */ 606} VAGenericValueType; 607 608/** \brief Generic function type. */ 609typedef void (*VAGenericFunc)(void); 610 611/** \brief Generic value. */ 612typedef struct _VAGenericValue { 613 /** \brief Value type. See #VAGenericValueType. */ 614 VAGenericValueType type; 615 /** \brief Value holder. */ 616 union { 617 /** \brief 32-bit signed integer. */ 618 int i; 619 /** \brief 32-bit float. */ 620 float f; 621 /** \brief Generic pointer. */ 622 void *p; 623 /** \brief Pointer to function. */ 624 VAGenericFunc fn; 625 } value; 626} VAGenericValue; 627 628/** @name Surface attribute flags */ 629/**@{*/ 630/** \brief Surface attribute is not supported. */ 631#define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000 632/** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */ 633#define VA_SURFACE_ATTRIB_GETTABLE 0x00000001 634/** \brief Surface attribute can be set through vaCreateSurfaces(). */ 635#define VA_SURFACE_ATTRIB_SETTABLE 0x00000002 636/**@}*/ 637 638/** \brief Surface attribute types. */ 639typedef enum { 640 VASurfaceAttribNone = 0, 641 /** 642 * \brief Pixel format (fourcc). 643 * 644 * The value is meaningful as input to vaQuerySurfaceAttributes(). 645 * If zero, the driver returns the optimal pixel format for the 646 * specified config. Otherwise, if non-zero, the value represents 647 * a pixel format (FOURCC) that is kept as is on output, if the 648 * driver supports it. Otherwise, the driver sets the value to 649 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag. 650 */ 651 VASurfaceAttribPixelFormat, 652 /** \brief Minimal width in pixels (int, read-only). */ 653 VASurfaceAttribMinWidth, 654 /** \brief Maximal width in pixels (int, read-only). */ 655 VASurfaceAttribMaxWidth, 656 /** \brief Minimal height in pixels (int, read-only). */ 657 VASurfaceAttribMinHeight, 658 /** \brief Maximal height in pixels (int, read-only). */ 659 VASurfaceAttribMaxHeight, 660 /** \brief Surface memory type expressed in bit fields (int, read/write). */ 661 VASurfaceAttribMemoryType, 662 /** \brief External buffer descriptor (pointer, write). */ 663 VASurfaceAttribExternalBufferDescriptor, 664 /** \brief Number of surface attributes. */ 665 VASurfaceAttribCount 666} VASurfaceAttribType; 667 668/** \brief Surface attribute. */ 669typedef struct _VASurfaceAttrib { 670 /** \brief Type. */ 671 VASurfaceAttribType type; 672 /** \brief Flags. See "Surface attribute flags". */ 673 unsigned int flags; 674 /** \brief Value. See "Surface attribute types" for the expected types. */ 675 VAGenericValue value; 676} VASurfaceAttrib; 677 678/** 679 * @name VASurfaceAttribMemoryType values in bit fields. 680 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for 681 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific 682 * types are defined in DRM and Android header files. 683 */ 684/**@{*/ 685/** \brief VA memory type (default) is supported. */ 686#define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001 687/** \brief V4L2 buffer memory type is supported. */ 688#define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002 689/** \brief User pointer memory type is supported. */ 690#define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004 691/**@}*/ 692 693/** 694 * \brief VASurfaceAttribExternalBuffers structure for 695 * the VASurfaceAttribExternalBufferDescriptor attribute. 696 */ 697typedef struct _VASurfaceAttribExternalBuffers { 698 /** \brief pixel format in fourcc. */ 699 unsigned int pixel_format; 700 /** \brief width in pixels. */ 701 unsigned int width; 702 /** \brief height in pixels. */ 703 unsigned int height; 704 /** \brief total size of the buffer in bytes. */ 705 unsigned int data_size; 706 /** \brief number of planes for planar layout */ 707 unsigned int num_planes; 708 /** \brief pitch for each plane in bytes */ 709 unsigned int pitches[4]; 710 /** \brief offset for each plane in bytes */ 711 unsigned int offsets[4]; 712 /** \brief buffer handles or user pointers */ 713 unsigned long *buffers; 714 /** \brief number of elements in the "buffers" array */ 715 unsigned int num_buffers; 716 /** \brief flags. See "Surface external buffer descriptor flags". */ 717 unsigned int flags; 718 /** \brief reserved for passing private data */ 719 void *private_data; 720} VASurfaceAttribExternalBuffers; 721 722/** @name VASurfaceAttribExternalBuffers flags */ 723/**@{*/ 724/** \brief Enable memory tiling */ 725#define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001 726/** \brief Memory is cacheable */ 727#define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002 728/** \brief Memory is non-cacheable */ 729#define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004 730/** \brief Memory is write-combined */ 731#define VA_SURFACE_EXTBUF_DESC_WC 0x00000008 732/** \brief Memory is protected */ 733#define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000 734 735/**@}*/ 736 737/** 738 * \brief Queries surface attributes for the supplied config. 739 * 740 * Unlike vaGetSurfaceAttributes(), this function queries for all 741 * supported attributes for the supplied VA @config. In particular, if 742 * the underlying hardware supports the creation of VA surfaces in 743 * various formats, then this function will enumerate all pixel 744 * formats that are supported. 745 * 746 * The \c attrib_list array is allocated by the user and \c 747 * num_attribs shall be initialized to the number of allocated 748 * elements in that array. Upon successful return, the actual number 749 * of attributes will be overwritten into \c num_attribs. Otherwise, 750 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs 751 * is adjusted to the number of elements that would be returned if 752 * enough space was available. 753 * 754 * Note: it is perfectly valid to pass NULL to the \c attrib_list 755 * argument when vaQuerySurfaceAttributes() is used to determine the 756 * actual number of elements that need to be allocated. 757 * 758 * @param[in] dpy the VA display 759 * @param[in] config the config identifying a codec or a video 760 * processing pipeline 761 * @param[out] attrib_list the output array of #VASurfaceAttrib elements 762 * @param[in,out] num_attribs the number of elements allocated on 763 * input, the number of elements actually filled in output 764 */ 765VAStatus 766vaQuerySurfaceAttributes( 767 VADisplay dpy, 768 VAConfigID config, 769 VASurfaceAttrib *attrib_list, 770 unsigned int *num_attribs 771); 772 773/** 774 * \brief Creates an array of surfaces 775 * 776 * Creates an array of surfaces. The optional list of attributes shall 777 * be constructed and validated through vaGetSurfaceAttributes() or 778 * constructed based based on what the underlying hardware could 779 * expose through vaQuerySurfaceAttributes(). 780 * 781 * @param[in] dpy the VA display 782 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_* 783 * @param[in] width the surface width 784 * @param[in] height the surface height 785 * @param[out] surfaces the array of newly created surfaces 786 * @param[in] num_surfaces the number of surfaces to create 787 * @param[in] attrib_list the list of (optional) attributes, or \c NULL 788 * @param[in] num_attribs the number of attributes supplied in 789 * \c attrib_list, or zero 790 */ 791VAStatus 792vaCreateSurfaces( 793 VADisplay dpy, 794 unsigned int format, 795 unsigned int width, 796 unsigned int height, 797 VASurfaceID *surfaces, 798 unsigned int num_surfaces, 799 VASurfaceAttrib *attrib_list, 800 unsigned int num_attribs 801); 802 803/* 804 * vaDestroySurfaces - Destroy resources associated with surfaces. 805 * Surfaces can only be destroyed after the context associated has been 806 * destroyed. 807 * dpy: display 808 * surfaces: array of surfaces to destroy 809 * num_surfaces: number of surfaces in the array to be destroyed. 810 */ 811VAStatus vaDestroySurfaces ( 812 VADisplay dpy, 813 VASurfaceID *surfaces, 814 int num_surfaces 815); 816 817#define VA_PROGRESSIVE 0x1 818/* 819 * vaCreateContext - Create a context 820 * dpy: display 821 * config_id: configuration for the context 822 * picture_width: coded picture width 823 * picture_height: coded picture height 824 * flag: any combination of the following: 825 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set) 826 * render_targets: render targets (surfaces) tied to the context 827 * num_render_targets: number of render targets in the above array 828 * context: created context id upon return 829 */ 830VAStatus vaCreateContext ( 831 VADisplay dpy, 832 VAConfigID config_id, 833 int picture_width, 834 int picture_height, 835 int flag, 836 VASurfaceID *render_targets, 837 int num_render_targets, 838 VAContextID *context /* out */ 839); 840 841/* 842 * vaDestroyContext - Destroy a context 843 * dpy: display 844 * context: context to be destroyed 845 */ 846VAStatus vaDestroyContext ( 847 VADisplay dpy, 848 VAContextID context 849); 850 851/* 852 * Buffers 853 * Buffers are used to pass various types of data from the 854 * client to the server. The server maintains a data store 855 * for each buffer created, and the client idenfies a buffer 856 * through a unique buffer id assigned by the server. 857 */ 858 859typedef VAGenericID VABufferID; 860 861typedef enum 862{ 863 VAPictureParameterBufferType = 0, 864 VAIQMatrixBufferType = 1, 865 VABitPlaneBufferType = 2, 866 VASliceGroupMapBufferType = 3, 867 VASliceParameterBufferType = 4, 868 VASliceDataBufferType = 5, 869 VAMacroblockParameterBufferType = 6, 870 VAResidualDataBufferType = 7, 871 VADeblockingParameterBufferType = 8, 872 VAImageBufferType = 9, 873 VAProtectedSliceDataBufferType = 10, 874 VAQMatrixBufferType = 11, 875 VAHuffmanTableBufferType = 12, 876 877/* Following are encode buffer types */ 878 VAEncCodedBufferType = 21, 879 VAEncSequenceParameterBufferType = 22, 880 VAEncPictureParameterBufferType = 23, 881 VAEncSliceParameterBufferType = 24, 882 VAEncPackedHeaderParameterBufferType = 25, 883 VAEncPackedHeaderDataBufferType = 26, 884 VAEncMiscParameterBufferType = 27, 885 VAEncMacroblockParameterBufferType = 28, 886/* Following are video processing buffer types */ 887 /** 888 * \brief Video processing pipeline parameter buffer. 889 * 890 * This buffer describes the video processing pipeline. See 891 * #VAProcPipelineParameterBuffer for details. 892 */ 893 VAProcPipelineParameterBufferType = 41, 894 /** 895 * \brief Video filter parameter buffer. 896 * 897 * This buffer describes the video filter parameters. All buffers 898 * inherit from #VAProcFilterParameterBufferBase, thus including 899 * a unique filter buffer type. 900 * 901 * The default buffer used by most filters is #VAProcFilterParameterBuffer. 902 * Filters requiring advanced parameters include, but are not limited to, 903 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing), 904 * color balance (#VAProcFilterParameterBufferColorBalance), etc. 905 */ 906 VAProcFilterParameterBufferType = 42, 907 VABufferTypeMax 908} VABufferType; 909 910typedef enum 911{ 912 VAEncMiscParameterTypeFrameRate = 0, 913 VAEncMiscParameterTypeRateControl = 1, 914 VAEncMiscParameterTypeMaxSliceSize = 2, 915 VAEncMiscParameterTypeAIR = 3, 916 /** \brief Buffer type used to express a maximum frame size (in bits). */ 917 VAEncMiscParameterTypeMaxFrameSize = 4, 918 /** \brief Buffer type used for HRD parameters. */ 919 VAEncMiscParameterTypeHRD = 5, 920} VAEncMiscParameterType; 921 922/** \brief Packed header type. */ 923typedef enum { 924 /** \brief Packed sequence header. */ 925 VAEncPackedHeaderSequence = 1, 926 /** \brief Packed picture header. */ 927 VAEncPackedHeaderPicture = 2, 928 /** \brief Packed slice header. */ 929 VAEncPackedHeaderSlice = 3, 930 /** 931 * \brief Packed raw header. 932 * 933 * Packed raw data header can be used by the client to insert a header 934 * into the bitstream data buffer at the point it is passed, the driver 935 * will handle the raw packed header based on "has_emulation_bytes" field 936 * in the packed header parameter structure. 937 */ 938 VAEncPackedHeaderRawData = 4, 939 /** \brief Misc packed header. See codec-specific definitions. */ 940 VAEncPackedHeaderMiscMask = 0x80000000, 941} VAEncPackedHeaderType; 942 943/** \brief Packed header parameter. */ 944typedef struct _VAEncPackedHeaderParameterBuffer { 945 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */ 946 unsigned int type; 947 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */ 948 unsigned int bit_length; 949 /** \brief Flag: buffer contains start code emulation prevention bytes? */ 950 unsigned char has_emulation_bytes; 951} VAEncPackedHeaderParameterBuffer; 952 953/* 954 * For application, e.g. set a new bitrate 955 * VABufferID buf_id; 956 * VAEncMiscParameterBuffer *misc_param; 957 * VAEncMiscParameterRateControl *misc_rate_ctrl; 958 * 959 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType, 960 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl), 961 * 1, NULL, &buf_id); 962 * 963 * vaMapBuffer(dpy,buf_id,(void **)&misc_param); 964 * misc_param->type = VAEncMiscParameterTypeRateControl; 965 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data; 966 * misc_rate_ctrl->bits_per_second = 6400000; 967 * vaUnmapBuffer(dpy, buf_id); 968 * vaRenderPicture(dpy, context, &buf_id, 1); 969 */ 970typedef struct _VAEncMiscParameterBuffer 971{ 972 VAEncMiscParameterType type; 973 unsigned int data[0]; 974} VAEncMiscParameterBuffer; 975 976 977/** \brief Rate control parameters */ 978typedef struct _VAEncMiscParameterRateControl 979{ 980 /* this is the maximum bit-rate to be constrained by the rate control implementation */ 981 unsigned int bits_per_second; 982 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum 983 * bit-rate for example if target_percentage is 95 then the rate control will target 984 * a bit-rate that is 95% of the maximum bit-rate 985 */ 986 unsigned int target_percentage; 987 /* windows size in milliseconds. For example if this is set to 500, 988 * then the rate control will guarantee the target bit-rate over a 500 ms window 989 */ 990 unsigned int window_size; 991 /* initial QP at I frames */ 992 unsigned int initial_qp; 993 unsigned int min_qp; 994 unsigned int basic_unit_size; 995 union 996 { 997 struct 998 { 999 unsigned int reset : 1; 1000 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */ 1001 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */ 1002 } bits; 1003 unsigned int value; 1004 } rc_flags; 1005} VAEncMiscParameterRateControl; 1006 1007typedef struct _VAEncMiscParameterFrameRate 1008{ 1009 unsigned int framerate; 1010} VAEncMiscParameterFrameRate; 1011 1012/* 1013 * Allow a maximum slice size to be specified (in bits). 1014 * The encoder will attempt to make sure that individual slices do not exceed this size 1015 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment 1016 */ 1017typedef struct _VAEncMiscParameterMaxSliceSize 1018{ 1019 unsigned int max_slice_size; 1020} VAEncMiscParameterMaxSliceSize; 1021 1022typedef struct _VAEncMiscParameterAIR 1023{ 1024 unsigned int air_num_mbs; 1025 unsigned int air_threshold; 1026 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */ 1027} VAEncMiscParameterAIR; 1028 1029typedef struct _VAEncMiscParameterHRD 1030{ 1031 unsigned int initial_buffer_fullness; /* in bits */ 1032 unsigned int buffer_size; /* in bits */ 1033} VAEncMiscParameterHRD; 1034 1035/** 1036 * \brief Defines a maximum frame size (in bits). 1037 * 1038 * This misc parameter buffer defines the maximum size of a frame (in 1039 * bits). The encoder will try to make sure that each frame does not 1040 * exceed this size. Otherwise, if the frame size exceeds this size, 1041 * the \c status flag of #VACodedBufferSegment will contain 1042 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW. 1043 */ 1044typedef struct _VAEncMiscParameterBufferMaxFrameSize { 1045 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */ 1046 VAEncMiscParameterType type; 1047 /** \brief Maximum size of a frame (in bits). */ 1048 unsigned int max_frame_size; 1049} VAEncMiscParameterBufferMaxFrameSize; 1050 1051/* 1052 * There will be cases where the bitstream buffer will not have enough room to hold 1053 * the data for the entire slice, and the following flags will be used in the slice 1054 * parameter to signal to the server for the possible cases. 1055 * If a slice parameter buffer and slice data buffer pair is sent to the server with 1056 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below), 1057 * then a slice parameter and data buffer needs to be sent again to complete this slice. 1058 */ 1059#define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */ 1060#define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */ 1061#define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */ 1062#define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */ 1063 1064/* Codec-independent Slice Parameter Buffer base */ 1065typedef struct _VASliceParameterBufferBase 1066{ 1067 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */ 1068 unsigned int slice_data_offset; /* the offset to the first byte of slice data */ 1069 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */ 1070} VASliceParameterBufferBase; 1071 1072 1073/**************************** 1074 * JEPG data structure 1075 ***************************/ 1076typedef struct _VAQMatrixBufferJPEG 1077{ 1078 int load_lum_quantiser_matrix; 1079 int load_chroma_quantiser_matrix; 1080 unsigned char lum_quantiser_matrix[64]; 1081 unsigned char chroma_quantiser_matrix[64]; 1082} VAQMatrixBufferJPEG; 1083 1084typedef struct _VAEncPictureParameterBufferJPEG 1085{ 1086 VASurfaceID reconstructed_picture; 1087 unsigned short picture_width; 1088 unsigned short picture_height; 1089 VABufferID coded_buf; 1090} VAEncPictureParameterBufferJPEG; 1091 1092#include <va/va_dec_jpeg.h> 1093 1094/**************************** 1095 * MPEG-2 data structures 1096 ****************************/ 1097 1098/* MPEG-2 Picture Parameter Buffer */ 1099/* 1100 * For each frame or field, and before any slice data, a single 1101 * picture parameter buffer must be send. 1102 */ 1103typedef struct _VAPictureParameterBufferMPEG2 1104{ 1105 unsigned short horizontal_size; 1106 unsigned short vertical_size; 1107 VASurfaceID forward_reference_picture; 1108 VASurfaceID backward_reference_picture; 1109 /* meanings of the following fields are the same as in the standard */ 1110 int picture_coding_type; 1111 int f_code; /* pack all four fcode into this */ 1112 union { 1113 struct { 1114 unsigned int intra_dc_precision : 2; 1115 unsigned int picture_structure : 2; 1116 unsigned int top_field_first : 1; 1117 unsigned int frame_pred_frame_dct : 1; 1118 unsigned int concealment_motion_vectors : 1; 1119 unsigned int q_scale_type : 1; 1120 unsigned int intra_vlc_format : 1; 1121 unsigned int alternate_scan : 1; 1122 unsigned int repeat_first_field : 1; 1123 unsigned int progressive_frame : 1; 1124 unsigned int is_first_field : 1; /* indicate whether the current field 1125 * is the first field for field picture 1126 */ 1127 } bits; 1128 unsigned int value; 1129 } picture_coding_extension; 1130} VAPictureParameterBufferMPEG2; 1131 1132/* MPEG-2 Inverse Quantization Matrix Buffer */ 1133typedef struct _VAIQMatrixBufferMPEG2 1134{ 1135 int load_intra_quantiser_matrix; 1136 int load_non_intra_quantiser_matrix; 1137 int load_chroma_intra_quantiser_matrix; 1138 int load_chroma_non_intra_quantiser_matrix; 1139 unsigned char intra_quantiser_matrix[64]; 1140 unsigned char non_intra_quantiser_matrix[64]; 1141 unsigned char chroma_intra_quantiser_matrix[64]; 1142 unsigned char chroma_non_intra_quantiser_matrix[64]; 1143} VAIQMatrixBufferMPEG2; 1144 1145/* MPEG-2 Slice Parameter Buffer */ 1146typedef struct _VASliceParameterBufferMPEG2 1147{ 1148 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */ 1149 unsigned int slice_data_offset;/* the offset to the first byte of slice data */ 1150 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */ 1151 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */ 1152 unsigned int slice_horizontal_position; 1153 unsigned int slice_vertical_position; 1154 int quantiser_scale_code; 1155 int intra_slice_flag; 1156} VASliceParameterBufferMPEG2; 1157 1158/* MPEG-2 Macroblock Parameter Buffer */ 1159typedef struct _VAMacroblockParameterBufferMPEG2 1160{ 1161 unsigned short macroblock_address; 1162 /* 1163 * macroblock_address (in raster scan order) 1164 * top-left: 0 1165 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1 1166 */ 1167 unsigned char macroblock_type; /* see definition below */ 1168 union { 1169 struct { 1170 unsigned int frame_motion_type : 2; 1171 unsigned int field_motion_type : 2; 1172 unsigned int dct_type : 1; 1173 } bits; 1174 unsigned int value; 1175 } macroblock_modes; 1176 unsigned char motion_vertical_field_select; 1177 /* 1178 * motion_vertical_field_select: 1179 * see section 6.3.17.2 in the spec 1180 * only the lower 4 bits are used 1181 * bit 0: first vector forward 1182 * bit 1: first vector backward 1183 * bit 2: second vector forward 1184 * bit 3: second vector backward 1185 */ 1186 short PMV[2][2][2]; /* see Table 7-7 in the spec */ 1187 unsigned short coded_block_pattern; 1188 /* 1189 * The bitplanes for coded_block_pattern are described 1190 * in Figure 6.10-12 in the spec 1191 */ 1192 1193 /* Number of skipped macroblocks after this macroblock */ 1194 unsigned short num_skipped_macroblocks; 1195} VAMacroblockParameterBufferMPEG2; 1196 1197/* 1198 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec) 1199 */ 1200#define VA_MB_TYPE_MOTION_FORWARD 0x02 1201#define VA_MB_TYPE_MOTION_BACKWARD 0x04 1202#define VA_MB_TYPE_MOTION_PATTERN 0x08 1203#define VA_MB_TYPE_MOTION_INTRA 0x10 1204 1205/* 1206 * MPEG-2 Residual Data Buffer 1207 * For each macroblock, there wil be 64 shorts (16-bit) in the 1208 * residual data buffer 1209 */ 1210 1211/**************************** 1212 * MPEG-4 Part 2 data structures 1213 ****************************/ 1214 1215/* MPEG-4 Picture Parameter Buffer */ 1216/* 1217 * For each frame or field, and before any slice data, a single 1218 * picture parameter buffer must be send. 1219 */ 1220typedef struct _VAPictureParameterBufferMPEG4 1221{ 1222 unsigned short vop_width; 1223 unsigned short vop_height; 1224 VASurfaceID forward_reference_picture; 1225 VASurfaceID backward_reference_picture; 1226 union { 1227 struct { 1228 unsigned int short_video_header : 1; 1229 unsigned int chroma_format : 2; 1230 unsigned int interlaced : 1; 1231 unsigned int obmc_disable : 1; 1232 unsigned int sprite_enable : 2; 1233 unsigned int sprite_warping_accuracy : 2; 1234 unsigned int quant_type : 1; 1235 unsigned int quarter_sample : 1; 1236 unsigned int data_partitioned : 1; 1237 unsigned int reversible_vlc : 1; 1238 unsigned int resync_marker_disable : 1; 1239 } bits; 1240 unsigned int value; 1241 } vol_fields; 1242 unsigned char no_of_sprite_warping_points; 1243 short sprite_trajectory_du[3]; 1244 short sprite_trajectory_dv[3]; 1245 unsigned char quant_precision; 1246 union { 1247 struct { 1248 unsigned int vop_coding_type : 2; 1249 unsigned int backward_reference_vop_coding_type : 2; 1250 unsigned int vop_rounding_type : 1; 1251 unsigned int intra_dc_vlc_thr : 3; 1252 unsigned int top_field_first : 1; 1253 unsigned int alternate_vertical_scan_flag : 1; 1254 } bits; 1255 unsigned int value; 1256 } vop_fields; 1257 unsigned char vop_fcode_forward; 1258 unsigned char vop_fcode_backward; 1259 unsigned short vop_time_increment_resolution; 1260 /* short header related */ 1261 unsigned char num_gobs_in_vop; 1262 unsigned char num_macroblocks_in_gob; 1263 /* for direct mode prediction */ 1264 short TRB; 1265 short TRD; 1266} VAPictureParameterBufferMPEG4; 1267 1268/* MPEG-4 Inverse Quantization Matrix Buffer */ 1269typedef struct _VAIQMatrixBufferMPEG4 1270{ 1271 int load_intra_quant_mat; 1272 int load_non_intra_quant_mat; 1273 unsigned char intra_quant_mat[64]; 1274 unsigned char non_intra_quant_mat[64]; 1275} VAIQMatrixBufferMPEG4; 1276 1277/* MPEG-4 Slice Parameter Buffer */ 1278typedef struct _VASliceParameterBufferMPEG4 1279{ 1280 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */ 1281 unsigned int slice_data_offset;/* the offset to the first byte of slice data */ 1282 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */ 1283 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */ 1284 unsigned int macroblock_number; 1285 int quant_scale; 1286} VASliceParameterBufferMPEG4; 1287 1288/* 1289 VC-1 data structures 1290*/ 1291 1292typedef enum /* see 7.1.1.32 */ 1293{ 1294 VAMvMode1Mv = 0, 1295 VAMvMode1MvHalfPel = 1, 1296 VAMvMode1MvHalfPelBilinear = 2, 1297 VAMvModeMixedMv = 3, 1298 VAMvModeIntensityCompensation = 4 1299} VAMvModeVC1; 1300 1301/* VC-1 Picture Parameter Buffer */ 1302/* 1303 * For each picture, and before any slice data, a picture parameter 1304 * buffer must be send. Multiple picture parameter buffers may be 1305 * sent for a single picture. In that case picture parameters will 1306 * apply to all slice data that follow it until a new picture 1307 * parameter buffer is sent. 1308 * 1309 * Notes: 1310 * pic_quantizer_type should be set to the applicable quantizer 1311 * type as defined by QUANTIZER (J.1.19) and either 1312 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6) 1313 */ 1314typedef struct _VAPictureParameterBufferVC1 1315{ 1316 VASurfaceID forward_reference_picture; 1317 VASurfaceID backward_reference_picture; 1318 /* if out-of-loop post-processing is done on the render 1319 target, then we need to keep the in-loop decoded 1320 picture as a reference picture */ 1321 VASurfaceID inloop_decoded_picture; 1322 1323 /* sequence layer for AP or meta data for SP and MP */ 1324 union { 1325 struct { 1326 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */ 1327 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */ 1328 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */ 1329 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */ 1330 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */ 1331 unsigned int multires : 1; /* METADATA::MULTIRES */ 1332 unsigned int overlap : 1; /* METADATA::OVERLAP */ 1333 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */ 1334 unsigned int rangered : 1; /* METADATA::RANGERED */ 1335 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */ 1336 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */ 1337 } bits; 1338 unsigned int value; 1339 } sequence_fields; 1340 1341 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */ 1342 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */ 1343 union { 1344 struct { 1345 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */ 1346 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */ 1347 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */ 1348 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */ 1349 } bits; 1350 unsigned int value; 1351 } entrypoint_fields; 1352 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */ 1353 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */ 1354 union { 1355 struct { 1356 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */ 1357 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */ 1358 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */ 1359 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */ 1360 } bits; 1361 unsigned int value; 1362 } range_mapping_fields; 1363 1364 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */ 1365 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */ 1366 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */ 1367 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */ 1368 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */ 1369 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */ 1370 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */ 1371 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */ 1372 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */ 1373 union { 1374 struct { 1375 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */ 1376 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */ 1377 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */ 1378 unsigned int is_first_field : 1; /* set to 1 if it is the first field */ 1379 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */ 1380 } bits; 1381 unsigned int value; 1382 } picture_fields; 1383 union { 1384 struct { 1385 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */ 1386 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */ 1387 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */ 1388 unsigned int field_tx : 1; /* PICTURE::FIELDTX */ 1389 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */ 1390 unsigned int ac_pred : 1; /* PICTURE::ACPRED */ 1391 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */ 1392 } flags; 1393 unsigned int value; 1394 } raw_coding; 1395 union { 1396 struct { 1397 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */ 1398 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */ 1399 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */ 1400 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */ 1401 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */ 1402 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */ 1403 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */ 1404 } flags; 1405 unsigned int value; 1406 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */ 1407 union { 1408 struct { 1409 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */ 1410 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */ 1411 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */ 1412 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */ 1413 } bits; 1414 unsigned int value; 1415 } reference_fields; 1416 union { 1417 struct { 1418 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */ 1419 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */ 1420 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */ 1421 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */ 1422 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */ 1423 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */ 1424 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */ 1425 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */ 1426 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */ 1427 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */ 1428 } bits; 1429 unsigned int value; 1430 } mv_fields; 1431 union { 1432 struct { 1433 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */ 1434 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */ 1435 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */ 1436 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */ 1437 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */ 1438 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */ 1439 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */ 1440 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */ 1441 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */ 1442 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */ 1443 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */ 1444 } bits; 1445 unsigned int value; 1446 } pic_quantizer_fields; 1447 union { 1448 struct { 1449 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */ 1450 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */ 1451 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */ 1452 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */ 1453 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */ 1454 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */ 1455 } bits; 1456 unsigned int value; 1457 } transform_fields; 1458} VAPictureParameterBufferVC1; 1459 1460/* VC-1 Bitplane Buffer 1461There will be at most three bitplanes coded in any picture header. To send 1462the bitplane data more efficiently, each byte is divided in two nibbles, with 1463each nibble carrying three bitplanes for one macroblock. The following table 1464shows the bitplane data arrangement within each nibble based on the picture 1465type. 1466 1467Picture Type Bit3 Bit2 Bit1 Bit0 1468I or BI OVERFLAGS ACPRED FIELDTX 1469P MYTYPEMB SKIPMB DIRECTMB 1470B FORWARDMB SKIPMB DIRECTMB 1471 1472Within each byte, the lower nibble is for the first MB and the upper nibble is 1473for the second MB. E.g. the lower nibble of the first byte in the bitplane 1474buffer is for Macroblock #1 and the upper nibble of the first byte is for 1475Macroblock #2 in the first row. 1476*/ 1477 1478/* VC-1 Slice Parameter Buffer */ 1479typedef struct _VASliceParameterBufferVC1 1480{ 1481 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */ 1482 unsigned int slice_data_offset;/* the offset to the first byte of slice data */ 1483 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */ 1484 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */ 1485 unsigned int slice_vertical_position; 1486} VASliceParameterBufferVC1; 1487 1488/* VC-1 Slice Data Buffer */ 1489/* 1490This is simplely a buffer containing raw bit-stream bytes 1491*/ 1492 1493/**************************** 1494 * H.264/AVC data structures 1495 ****************************/ 1496 1497typedef struct _VAPictureH264 1498{ 1499 VASurfaceID picture_id; 1500 unsigned int frame_idx; 1501 unsigned int flags; 1502 signed int TopFieldOrderCnt; 1503 signed int BottomFieldOrderCnt; 1504} VAPictureH264; 1505/* flags in VAPictureH264 could be OR of the following */ 1506#define VA_PICTURE_H264_INVALID 0x00000001 1507#define VA_PICTURE_H264_TOP_FIELD 0x00000002 1508#define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004 1509#define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008 1510#define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010 1511 1512/* H.264 Picture Parameter Buffer */ 1513/* 1514 * For each picture, and before any slice data, a single 1515 * picture parameter buffer must be send. 1516 */ 1517typedef struct _VAPictureParameterBufferH264 1518{ 1519 VAPictureH264 CurrPic; 1520 VAPictureH264 ReferenceFrames[16]; /* in DPB */ 1521 unsigned short picture_width_in_mbs_minus1; 1522 unsigned short picture_height_in_mbs_minus1; 1523 unsigned char bit_depth_luma_minus8; 1524 unsigned char bit_depth_chroma_minus8; 1525 unsigned char num_ref_frames; 1526 union { 1527 struct { 1528 unsigned int chroma_format_idc : 2; 1529 unsigned int residual_colour_transform_flag : 1; 1530 unsigned int gaps_in_frame_num_value_allowed_flag : 1; 1531 unsigned int frame_mbs_only_flag : 1; 1532 unsigned int mb_adaptive_frame_field_flag : 1; 1533 unsigned int direct_8x8_inference_flag : 1; 1534 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */ 1535 unsigned int log2_max_frame_num_minus4 : 4; 1536 unsigned int pic_order_cnt_type : 2; 1537 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4; 1538 unsigned int delta_pic_order_always_zero_flag : 1; 1539 } bits; 1540 unsigned int value; 1541 } seq_fields; 1542 unsigned char num_slice_groups_minus1; 1543 unsigned char slice_group_map_type; 1544 unsigned short slice_group_change_rate_minus1; 1545 signed char pic_init_qp_minus26; 1546 signed char pic_init_qs_minus26; 1547 signed char chroma_qp_index_offset; 1548 signed char second_chroma_qp_index_offset; 1549 union { 1550 struct { 1551 unsigned int entropy_coding_mode_flag : 1; 1552 unsigned int weighted_pred_flag : 1; 1553 unsigned int weighted_bipred_idc : 2; 1554 unsigned int transform_8x8_mode_flag : 1; 1555 unsigned int field_pic_flag : 1; 1556 unsigned int constrained_intra_pred_flag : 1; 1557 unsigned int pic_order_present_flag : 1; 1558 unsigned int deblocking_filter_control_present_flag : 1; 1559 unsigned int redundant_pic_cnt_present_flag : 1; 1560 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */ 1561 } bits; 1562 unsigned int value; 1563 } pic_fields; 1564 unsigned short frame_num; 1565} VAPictureParameterBufferH264; 1566 1567/* H.264 Inverse Quantization Matrix Buffer */ 1568typedef struct _VAIQMatrixBufferH264 1569{ 1570 unsigned char ScalingList4x4[6][16]; 1571 unsigned char ScalingList8x8[2][64]; 1572} VAIQMatrixBufferH264; 1573 1574/* 1575 * H.264 Slice Group Map Buffer 1576 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0, 1577 * A slice group map buffer should be sent for each picture if required. The buffer 1578 * is sent only when there is a change in the mapping values. 1579 * The slice group map buffer map "map units" to slice groups as specified in 1580 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock 1581 * in raster scan order 1582 */ 1583 1584/* H.264 Slice Parameter Buffer */ 1585typedef struct _VASliceParameterBufferH264 1586{ 1587 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */ 1588 /** \brief Byte offset to the NAL Header Unit for this slice. */ 1589 unsigned int slice_data_offset; 1590 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */ 1591 /** 1592 * \brief Bit offset from NAL Header Unit to the begining of slice_data(). 1593 * 1594 * This bit offset is relative to and includes the NAL unit byte 1595 * and represents the number of bits parsed in the slice_header() 1596 * after the removal of any emulation prevention bytes in 1597 * there. However, the slice data buffer passed to the hardware is 1598 * the original bitstream, thus including any emulation prevention 1599 * bytes. 1600 */ 1601 unsigned short slice_data_bit_offset; 1602 unsigned short first_mb_in_slice; 1603 unsigned char slice_type; 1604 unsigned char direct_spatial_mv_pred_flag; 1605 unsigned char num_ref_idx_l0_active_minus1; 1606 unsigned char num_ref_idx_l1_active_minus1; 1607 unsigned char cabac_init_idc; 1608 char slice_qp_delta; 1609 unsigned char disable_deblocking_filter_idc; 1610 char slice_alpha_c0_offset_div2; 1611 char slice_beta_offset_div2; 1612 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */ 1613 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */ 1614 unsigned char luma_log2_weight_denom; 1615 unsigned char chroma_log2_weight_denom; 1616 unsigned char luma_weight_l0_flag; 1617 short luma_weight_l0[32]; 1618 short luma_offset_l0[32]; 1619 unsigned char chroma_weight_l0_flag; 1620 short chroma_weight_l0[32][2]; 1621 short chroma_offset_l0[32][2]; 1622 unsigned char luma_weight_l1_flag; 1623 short luma_weight_l1[32]; 1624 short luma_offset_l1[32]; 1625 unsigned char chroma_weight_l1_flag; 1626 short chroma_weight_l1[32][2]; 1627 short chroma_offset_l1[32][2]; 1628} VASliceParameterBufferH264; 1629 1630/**************************** 1631 * Common encode data structures 1632 ****************************/ 1633typedef enum 1634{ 1635 VAEncPictureTypeIntra = 0, 1636 VAEncPictureTypePredictive = 1, 1637 VAEncPictureTypeBidirectional = 2, 1638} VAEncPictureType; 1639 1640/* Encode Slice Parameter Buffer */ 1641typedef struct _VAEncSliceParameterBuffer 1642{ 1643 unsigned int start_row_number; /* starting MB row number for this slice */ 1644 unsigned int slice_height; /* slice height measured in MB */ 1645 union { 1646 struct { 1647 unsigned int is_intra : 1; 1648 unsigned int disable_deblocking_filter_idc : 2; 1649 unsigned int uses_long_term_ref :1; 1650 unsigned int is_long_term_ref :1; 1651 } bits; 1652 unsigned int value; 1653 } slice_flags; 1654} VAEncSliceParameterBuffer; 1655 1656 1657/**************************** 1658 * H.263 specific encode data structures 1659 ****************************/ 1660 1661typedef struct _VAEncSequenceParameterBufferH263 1662{ 1663 unsigned int intra_period; 1664 unsigned int bits_per_second; 1665 unsigned int frame_rate; 1666 unsigned int initial_qp; 1667 unsigned int min_qp; 1668} VAEncSequenceParameterBufferH263; 1669 1670typedef struct _VAEncPictureParameterBufferH263 1671{ 1672 VASurfaceID reference_picture; 1673 VASurfaceID reconstructed_picture; 1674 VABufferID coded_buf; 1675 unsigned short picture_width; 1676 unsigned short picture_height; 1677 VAEncPictureType picture_type; 1678} VAEncPictureParameterBufferH263; 1679 1680/**************************** 1681 * MPEG-4 specific encode data structures 1682 ****************************/ 1683 1684typedef struct _VAEncSequenceParameterBufferMPEG4 1685{ 1686 unsigned char profile_and_level_indication; 1687 unsigned int intra_period; 1688 unsigned int video_object_layer_width; 1689 unsigned int video_object_layer_height; 1690 unsigned int vop_time_increment_resolution; 1691 unsigned int fixed_vop_rate; 1692 unsigned int fixed_vop_time_increment; 1693 unsigned int bits_per_second; 1694 unsigned int frame_rate; 1695 unsigned int initial_qp; 1696 unsigned int min_qp; 1697} VAEncSequenceParameterBufferMPEG4; 1698 1699typedef struct _VAEncPictureParameterBufferMPEG4 1700{ 1701 VASurfaceID reference_picture; 1702 VASurfaceID reconstructed_picture; 1703 VABufferID coded_buf; 1704 unsigned short picture_width; 1705 unsigned short picture_height; 1706 unsigned int modulo_time_base; /* number of 1s */ 1707 unsigned int vop_time_increment; 1708 VAEncPictureType picture_type; 1709} VAEncPictureParameterBufferMPEG4; 1710 1711 1712 1713/* Buffer functions */ 1714 1715/* 1716 * Creates a buffer for "num_elements" elements of "size" bytes and 1717 * initalize with "data". 1718 * if "data" is null, then the contents of the buffer data store 1719 * are undefined. 1720 * Basically there are two ways to get buffer data to the server side. One is 1721 * to call vaCreateBuffer() with a non-null "data", which results the data being 1722 * copied to the data store on the server side. A different method that 1723 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(), 1724 * and then use vaMapBuffer() to map the data store from the server side to the 1725 * client address space for access. 1726 * Note: image buffers are created by the library, not the client. Please see 1727 * vaCreateImage on how image buffers are managed. 1728 */ 1729VAStatus vaCreateBuffer ( 1730 VADisplay dpy, 1731 VAContextID context, 1732 VABufferType type, /* in */ 1733 unsigned int size, /* in */ 1734 unsigned int num_elements, /* in */ 1735 void *data, /* in */ 1736 VABufferID *buf_id /* out */ 1737); 1738 1739/* 1740 * Convey to the server how many valid elements are in the buffer. 1741 * e.g. if multiple slice parameters are being held in a single buffer, 1742 * this will communicate to the server the number of slice parameters 1743 * that are valid in the buffer. 1744 */ 1745VAStatus vaBufferSetNumElements ( 1746 VADisplay dpy, 1747 VABufferID buf_id, /* in */ 1748 unsigned int num_elements /* in */ 1749); 1750 1751 1752/* 1753 * device independent data structure for codedbuffer 1754 */ 1755 1756/* 1757 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame 1758 * LARGE_SLICE(bit8):At least one slice in the current frame was large 1759 * enough for the encoder to attempt to limit its size. 1760 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has 1761 * exceeded the maximum slice size specified. 1762 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame. 1763 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only) 1764 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB 1765 */ 1766#define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff 1767#define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100 1768#define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200 1769#define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400 1770#define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800 1771/** 1772 * \brief The frame has exceeded the maximum requested size. 1773 * 1774 * This flag indicates that the encoded frame size exceeds the value 1775 * specified through a misc parameter buffer of type 1776 * #VAEncMiscParameterTypeMaxFrameSize. 1777 */ 1778#define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000 1779#define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000 1780 1781/** 1782 * \brief The coded buffer segment contains a single NAL unit. 1783 * 1784 * This flag indicates that the coded buffer segment contains a 1785 * single NAL unit. This flag might be useful to the user for 1786 * processing the coded buffer. 1787 */ 1788#define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000 1789 1790/** 1791 * \brief Coded buffer segment. 1792 * 1793 * #VACodedBufferSegment is an element of a linked list describing 1794 * some information on the coded buffer. The coded buffer segment 1795 * could contain either a single NAL unit, or more than one NAL unit. 1796 * It is recommended (but not required) to return a single NAL unit 1797 * in a coded buffer segment, and the implementation should set the 1798 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case. 1799 */ 1800typedef struct _VACodedBufferSegment { 1801 /** 1802 * \brief Size of the data buffer in this segment (in bytes). 1803 */ 1804 unsigned int size; 1805 /** \brief Bit offset into the data buffer where the video data starts. */ 1806 unsigned int bit_offset; 1807 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */ 1808 unsigned int status; 1809 /** \brief Reserved for future use. */ 1810 unsigned int reserved; 1811 /** \brief Pointer to the start of the data buffer. */ 1812 void *buf; 1813 /** 1814 * \brief Pointer to the next #VACodedBufferSegment element, 1815 * or \c NULL if there is none. 1816 */ 1817 void *next; 1818} VACodedBufferSegment; 1819 1820/* 1821 * Map data store of the buffer into the client's address space 1822 * vaCreateBuffer() needs to be called with "data" set to NULL before 1823 * calling vaMapBuffer() 1824 * 1825 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of 1826 * VACodedBufferSegment, and the list is terminated if "next" is NULL 1827 */ 1828VAStatus vaMapBuffer ( 1829 VADisplay dpy, 1830 VABufferID buf_id, /* in */ 1831 void **pbuf /* out */ 1832); 1833 1834/* 1835 * After client making changes to a mapped data store, it needs to 1836 * "Unmap" it to let the server know that the data is ready to be 1837 * consumed by the server 1838 */ 1839VAStatus vaUnmapBuffer ( 1840 VADisplay dpy, 1841 VABufferID buf_id /* in */ 1842); 1843 1844/* 1845 * After this call, the buffer is deleted and this buffer_id is no longer valid 1846 * Only call this if the buffer is not going to be passed to vaRenderBuffer 1847 */ 1848VAStatus vaDestroyBuffer ( 1849 VADisplay dpy, 1850 VABufferID buffer_id 1851); 1852 1853/* 1854Render (Decode) Pictures 1855 1856A picture represents either a frame or a field. 1857 1858The Begin/Render/End sequence sends the decode buffers to the server 1859*/ 1860 1861/* 1862 * Get ready to decode a picture to a target surface 1863 */ 1864VAStatus vaBeginPicture ( 1865 VADisplay dpy, 1866 VAContextID context, 1867 VASurfaceID render_target 1868); 1869 1870/* 1871 * Send decode buffers to the server. 1872 * Buffers are automatically destroyed afterwards 1873 */ 1874VAStatus vaRenderPicture ( 1875 VADisplay dpy, 1876 VAContextID context, 1877 VABufferID *buffers, 1878 int num_buffers 1879); 1880 1881/* 1882 * Make the end of rendering for a picture. 1883 * The server should start processing all pending operations for this 1884 * surface. This call is non-blocking. The client can start another 1885 * Begin/Render/End sequence on a different render target. 1886 */ 1887VAStatus vaEndPicture ( 1888 VADisplay dpy, 1889 VAContextID context 1890); 1891 1892/* 1893 1894Synchronization 1895 1896*/ 1897 1898/* 1899 * This function blocks until all pending operations on the render target 1900 * have been completed. Upon return it is safe to use the render target for a 1901 * different picture. 1902 */ 1903VAStatus vaSyncSurface ( 1904 VADisplay dpy, 1905 VASurfaceID render_target 1906); 1907 1908typedef enum 1909{ 1910 VASurfaceRendering = 1, /* Rendering in progress */ 1911 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */ 1912 /* this status is useful if surface is used as the source */ 1913 /* of an overlay */ 1914 VASurfaceReady = 4, /* not being rendered or displayed */ 1915 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */ 1916} VASurfaceStatus; 1917 1918/* 1919 * Find out any pending ops on the render target 1920 */ 1921VAStatus vaQuerySurfaceStatus ( 1922 VADisplay dpy, 1923 VASurfaceID render_target, 1924 VASurfaceStatus *status /* out */ 1925); 1926 1927typedef enum 1928{ 1929 VADecodeSliceMissing = 0, 1930 VADecodeMBError = 1, 1931} VADecodeErrorType; 1932 1933/* 1934 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns 1935 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1 1936*/ 1937typedef struct _VASurfaceDecodeMBErrors 1938{ 1939 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */ 1940 unsigned int start_mb; /* start mb address with errors */ 1941 unsigned int end_mb; /* end mb address with errors */ 1942 VADecodeErrorType decode_error_type; 1943} VASurfaceDecodeMBErrors; 1944 1945/* 1946 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(), 1947 * it can call vaQuerySurfaceError to find out further details on the particular error. 1948 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status", 1949 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure, 1950 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks. 1951 * The array is terminated if "status==-1" is detected. 1952 */ 1953VAStatus vaQuerySurfaceError( 1954 VADisplay dpy, 1955 VASurfaceID surface, 1956 VAStatus error_status, 1957 void **error_info 1958); 1959 1960/* 1961 * Images and Subpictures 1962 * VAImage is used to either get the surface data to client memory, or 1963 * to copy image data in client memory to a surface. 1964 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin 1965 * is at the upper left corner with positive X to the right and positive Y down 1966 */ 1967#define VA_FOURCC(ch0, ch1, ch2, ch3) \ 1968 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \ 1969 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 )) 1970 1971/* 1972 * Pre-defined fourcc codes 1973 */ 1974#define VA_FOURCC_NV12 0x3231564E 1975#define VA_FOURCC_AI44 0x34344149 1976#define VA_FOURCC_RGBA 0x41424752 1977#define VA_FOURCC_RGBX 0x58424752 1978#define VA_FOURCC_BGRA 0x41524742 1979#define VA_FOURCC_BGRX 0x58524742 1980#define VA_FOURCC_ARGB 0x42475241 1981#define VA_FOURCC_XRGB 0x42475258 1982#define VA_FOURCC_UYVY 0x59565955 1983#define VA_FOURCC_YUY2 0x32595559 1984#define VA_FOURCC_AYUV 0x56555941 1985#define VA_FOURCC_NV11 0x3131564e 1986#define VA_FOURCC_YV12 0x32315659 1987#define VA_FOURCC_P208 0x38303250 1988#define VA_FOURCC_IYUV 0x56555949 1989#define VA_FOURCC_YV24 0x34325659 1990#define VA_FOURCC_YV32 0x32335659 1991#define VA_FOURCC_Y800 0x30303859 1992#define VA_FOURCC_IMC3 0x33434D49 1993#define VA_FOURCC_411P 0x50313134 1994#define VA_FOURCC_422H 0x48323234 1995#define VA_FOURCC_422V 0x56323234 1996#define VA_FOURCC_444P 0x50343434 1997#define VA_FOURCC_RGBP 0x50424752 1998#define VA_FOURCC_BGRP 0x50524742 1999#define VA_FOURCC_411R 0x52313134 /* rotated 411P */ 2000 2001/* byte order */ 2002#define VA_LSB_FIRST 1 2003#define VA_MSB_FIRST 2 2004 2005typedef struct _VAImageFormat 2006{ 2007 unsigned int fourcc; 2008 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */ 2009 unsigned int bits_per_pixel; 2010 /* for RGB formats */ 2011 unsigned int depth; /* significant bits per pixel */ 2012 unsigned int red_mask; 2013 unsigned int green_mask; 2014 unsigned int blue_mask; 2015 unsigned int alpha_mask; 2016} VAImageFormat; 2017 2018typedef VAGenericID VAImageID; 2019 2020typedef struct _VAImage 2021{ 2022 VAImageID image_id; /* uniquely identify this image */ 2023 VAImageFormat format; 2024 VABufferID buf; /* image data buffer */ 2025 /* 2026 * Image data will be stored in a buffer of type VAImageBufferType to facilitate 2027 * data store on the server side for optimal performance. The buffer will be 2028 * created by the CreateImage function, and proper storage allocated based on the image 2029 * size and format. This buffer is managed by the library implementation, and 2030 * accessed by the client through the buffer Map/Unmap functions. 2031 */ 2032 unsigned short width; 2033 unsigned short height; 2034 unsigned int data_size; 2035 unsigned int num_planes; /* can not be greater than 3 */ 2036 /* 2037 * An array indicating the scanline pitch in bytes for each plane. 2038 * Each plane may have a different pitch. Maximum 3 planes for planar formats 2039 */ 2040 unsigned int pitches[3]; 2041 /* 2042 * An array indicating the byte offset from the beginning of the image data 2043 * to the start of each plane. 2044 */ 2045 unsigned int offsets[3]; 2046 2047 /* The following fields are only needed for paletted formats */ 2048 int num_palette_entries; /* set to zero for non-palette images */ 2049 /* 2050 * Each component is one byte and entry_bytes indicates the number of components in 2051 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images 2052 */ 2053 int entry_bytes; 2054 /* 2055 * An array of ascii characters describing the order of the components within the bytes. 2056 * Only entry_bytes characters of the string are used. 2057 */ 2058 char component_order[4]; 2059} VAImage; 2060 2061/* Get maximum number of image formats supported by the implementation */ 2062int vaMaxNumImageFormats ( 2063 VADisplay dpy 2064); 2065 2066/* 2067 * Query supported image formats 2068 * The caller must provide a "format_list" array that can hold at 2069 * least vaMaxNumImageFormats() entries. The actual number of formats 2070 * returned in "format_list" is returned in "num_formats". 2071 */ 2072VAStatus vaQueryImageFormats ( 2073 VADisplay dpy, 2074 VAImageFormat *format_list, /* out */ 2075 int *num_formats /* out */ 2076); 2077 2078/* 2079 * Create a VAImage structure 2080 * The width and height fields returned in the VAImage structure may get 2081 * enlarged for some YUV formats. Upon return from this function, 2082 * image->buf has been created and proper storage allocated by the library. 2083 * The client can access the image through the Map/Unmap calls. 2084 */ 2085VAStatus vaCreateImage ( 2086 VADisplay dpy, 2087 VAImageFormat *format, 2088 int width, 2089 int height, 2090 VAImage *image /* out */ 2091); 2092 2093/* 2094 * Should call DestroyImage before destroying the surface it is bound to 2095 */ 2096VAStatus vaDestroyImage ( 2097 VADisplay dpy, 2098 VAImageID image 2099); 2100 2101VAStatus vaSetImagePalette ( 2102 VADisplay dpy, 2103 VAImageID image, 2104 /* 2105 * pointer to an array holding the palette data. The size of the array is 2106 * num_palette_entries * entry_bytes in size. The order of the components 2107 * in the palette is described by the component_order in VAImage struct 2108 */ 2109 unsigned char *palette 2110); 2111 2112/* 2113 * Retrive surface data into a VAImage 2114 * Image must be in a format supported by the implementation 2115 */ 2116VAStatus vaGetImage ( 2117 VADisplay dpy, 2118 VASurfaceID surface, 2119 int x, /* coordinates of the upper left source pixel */ 2120 int y, 2121 unsigned int width, /* width and height of the region */ 2122 unsigned int height, 2123 VAImageID image 2124); 2125 2126/* 2127 * Copy data from a VAImage to a surface 2128 * Image must be in a format supported by the implementation 2129 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface 2130 * shouldn't be rendered into when this is called 2131 */ 2132VAStatus vaPutImage ( 2133 VADisplay dpy, 2134 VASurfaceID surface, 2135 VAImageID image, 2136 int src_x, 2137 int src_y, 2138 unsigned int src_width, 2139 unsigned int src_height, 2140 int dest_x, 2141 int dest_y, 2142 unsigned int dest_width, 2143 unsigned int dest_height 2144); 2145 2146/* 2147 * Derive an VAImage from an existing surface. 2148 * This interface will derive a VAImage and corresponding image buffer from 2149 * an existing VA Surface. The image buffer can then be mapped/unmapped for 2150 * direct CPU access. This operation is only possible on implementations with 2151 * direct rendering capabilities and internal surface formats that can be 2152 * represented with a VAImage. When the operation is not possible this interface 2153 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back 2154 * to using vaCreateImage + vaPutImage to accomplish the same task in an 2155 * indirect manner. 2156 * 2157 * Implementations should only return success when the resulting image buffer 2158 * would be useable with vaMap/Unmap. 2159 * 2160 * When directly accessing a surface special care must be taken to insure 2161 * proper synchronization with the graphics hardware. Clients should call 2162 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent 2163 * rendering or currently being displayed by an overlay. 2164 * 2165 * Additionally nothing about the contents of a surface should be assumed 2166 * following a vaPutSurface. Implementations are free to modify the surface for 2167 * scaling or subpicture blending within a call to vaPutImage. 2168 * 2169 * Calls to vaPutImage or vaGetImage using the same surface from which the image 2170 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or 2171 * vaGetImage with other surfaces is supported. 2172 * 2173 * An image created with vaDeriveImage should be freed with vaDestroyImage. The 2174 * image and image buffer structures will be destroyed; however, the underlying 2175 * surface will remain unchanged until freed with vaDestroySurfaces. 2176 */ 2177VAStatus vaDeriveImage ( 2178 VADisplay dpy, 2179 VASurfaceID surface, 2180 VAImage *image /* out */ 2181); 2182 2183/* 2184 * Subpictures 2185 * Subpicture is a special type of image that can be blended 2186 * with a surface during vaPutSurface(). Subpicture can be used to render 2187 * DVD sub-titles or closed captioning text etc. 2188 */ 2189 2190typedef VAGenericID VASubpictureID; 2191 2192/* Get maximum number of subpicture formats supported by the implementation */ 2193int vaMaxNumSubpictureFormats ( 2194 VADisplay dpy 2195); 2196 2197/* flags for subpictures */ 2198#define VA_SUBPICTURE_CHROMA_KEYING 0x0001 2199#define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002 2200#define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004 2201/* 2202 * Query supported subpicture formats 2203 * The caller must provide a "format_list" array that can hold at 2204 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag 2205 * for each format to indicate additional capabilities for that format. The actual 2206 * number of formats returned in "format_list" is returned in "num_formats". 2207 * flags: returned value to indicate addtional capabilities 2208 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying 2209 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha 2210 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display 2211 */ 2212 2213VAStatus vaQuerySubpictureFormats ( 2214 VADisplay dpy, 2215 VAImageFormat *format_list, /* out */ 2216 unsigned int *flags, /* out */ 2217 unsigned int *num_formats /* out */ 2218); 2219 2220/* 2221 * Subpictures are created with an image associated. 2222 */ 2223VAStatus vaCreateSubpicture ( 2224 VADisplay dpy, 2225 VAImageID image, 2226 VASubpictureID *subpicture /* out */ 2227); 2228 2229/* 2230 * Destroy the subpicture before destroying the image it is assocated to 2231 */ 2232VAStatus vaDestroySubpicture ( 2233 VADisplay dpy, 2234 VASubpictureID subpicture 2235); 2236 2237/* 2238 * Bind an image to the subpicture. This image will now be associated with 2239 * the subpicture instead of the one at creation. 2240 */ 2241VAStatus vaSetSubpictureImage ( 2242 VADisplay dpy, 2243 VASubpictureID subpicture, 2244 VAImageID image 2245); 2246 2247/* 2248 * If chromakey is enabled, then the area where the source value falls within 2249 * the chromakey [min, max] range is transparent 2250 * The chromakey component format is the following: 2251 * For RGB: [0:7] Red [8:15] Blue [16:23] Green 2252 * For YUV: [0:7] V [8:15] U [16:23] Y 2253 * The chromakey mask can be used to mask out certain components for chromakey 2254 * comparision 2255 */ 2256VAStatus vaSetSubpictureChromakey ( 2257 VADisplay dpy, 2258 VASubpictureID subpicture, 2259 unsigned int chromakey_min, 2260 unsigned int chromakey_max, 2261 unsigned int chromakey_mask 2262); 2263 2264/* 2265 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and 2266 * a value of 0 means fully transparent. If per-pixel alpha is also specified then 2267 * the overall alpha is per-pixel alpha multiplied by the global alpha 2268 */ 2269VAStatus vaSetSubpictureGlobalAlpha ( 2270 VADisplay dpy, 2271 VASubpictureID subpicture, 2272 float global_alpha 2273); 2274 2275/* 2276 * vaAssociateSubpicture associates the subpicture with target_surfaces. 2277 * It defines the region mapping between the subpicture and the target 2278 * surfaces through source and destination rectangles (with the same width and height). 2279 * Both will be displayed at the next call to vaPutSurface. Additional 2280 * associations before the call to vaPutSurface simply overrides the association. 2281 */ 2282VAStatus vaAssociateSubpicture ( 2283 VADisplay dpy, 2284 VASubpictureID subpicture, 2285 VASurfaceID *target_surfaces, 2286 int num_surfaces, 2287 short src_x, /* upper left offset in subpicture */ 2288 short src_y, 2289 unsigned short src_width, 2290 unsigned short src_height, 2291 short dest_x, /* upper left offset in surface */ 2292 short dest_y, 2293 unsigned short dest_width, 2294 unsigned short dest_height, 2295 /* 2296 * whether to enable chroma-keying, global-alpha, or screen relative mode 2297 * see VA_SUBPICTURE_XXX values 2298 */ 2299 unsigned int flags 2300); 2301 2302/* 2303 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces. 2304 */ 2305VAStatus vaDeassociateSubpicture ( 2306 VADisplay dpy, 2307 VASubpictureID subpicture, 2308 VASurfaceID *target_surfaces, 2309 int num_surfaces 2310); 2311 2312typedef struct _VARectangle 2313{ 2314 short x; 2315 short y; 2316 unsigned short width; 2317 unsigned short height; 2318} VARectangle; 2319 2320/* 2321 * Display attributes 2322 * Display attributes are used to control things such as contrast, hue, saturation, 2323 * brightness etc. in the rendering process. The application can query what 2324 * attributes are supported by the driver, and then set the appropriate attributes 2325 * before calling vaPutSurface() 2326 */ 2327/* PowerVR IEP Lite attributes */ 2328typedef enum 2329{ 2330 VADISPLAYATTRIB_BLE_OFF = 0x00, 2331 VADISPLAYATTRIB_BLE_LOW, 2332 VADISPLAYATTRIB_BLE_MEDIUM, 2333 VADISPLAYATTRIB_BLE_HIGH, 2334 VADISPLAYATTRIB_BLE_NONE, 2335} VADisplayAttribBLEMode; 2336 2337/* attribute value for VADisplayAttribRotation */ 2338#define VA_ROTATION_NONE 0x00000000 2339#define VA_ROTATION_90 0x00000001 2340#define VA_ROTATION_180 0x00000002 2341#define VA_ROTATION_270 0x00000003 2342 2343/* attribute value for VADisplayAttribOutOfLoopDeblock */ 2344#define VA_OOL_DEBLOCKING_FALSE 0x00000000 2345#define VA_OOL_DEBLOCKING_TRUE 0x00000001 2346 2347/* Render mode */ 2348#define VA_RENDER_MODE_UNDEFINED 0 2349#define VA_RENDER_MODE_LOCAL_OVERLAY 1 2350#define VA_RENDER_MODE_LOCAL_GPU 2 2351#define VA_RENDER_MODE_EXTERNAL_OVERLAY 4 2352#define VA_RENDER_MODE_EXTERNAL_GPU 8 2353 2354/* Render device */ 2355#define VA_RENDER_DEVICE_UNDEFINED 0 2356#define VA_RENDER_DEVICE_LOCAL 1 2357#define VA_RENDER_DEVICE_EXTERNAL 2 2358 2359/* Currently defined display attribute types */ 2360typedef enum 2361{ 2362 VADisplayAttribBrightness = 0, 2363 VADisplayAttribContrast = 1, 2364 VADisplayAttribHue = 2, 2365 VADisplayAttribSaturation = 3, 2366 /* client can specifiy a background color for the target window 2367 * the new feature of video conference, 2368 * the uncovered area of the surface is filled by this color 2369 * also it will blend with the decoded video color 2370 */ 2371 VADisplayAttribBackgroundColor = 4, 2372 /* 2373 * this is a gettable only attribute. For some implementations that use the 2374 * hardware overlay, after PutSurface is called, the surface can not be 2375 * re-used until after the subsequent PutSurface call. If this is the case 2376 * then the value for this attribute will be set to 1 so that the client 2377 * will not attempt to re-use the surface right after returning from a call 2378 * to PutSurface. 2379 * 2380 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since 2381 * driver may use overlay or GPU alternatively 2382 */ 2383 VADisplayAttribDirectSurface = 5, 2384 VADisplayAttribRotation = 6, 2385 VADisplayAttribOutofLoopDeblock = 7, 2386 2387 /* PowerVR IEP Lite specific attributes */ 2388 VADisplayAttribBLEBlackMode = 8, 2389 VADisplayAttribBLEWhiteMode = 9, 2390 VADisplayAttribBlueStretch = 10, 2391 VADisplayAttribSkinColorCorrection = 11, 2392 /* 2393 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color 2394 * conversion matrix. Each element in the matrix is float-point 2395 */ 2396 VADisplayAttribCSCMatrix = 12, 2397 /* specify the constant color used to blend with video surface 2398 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB 2399 * d: the final color to overwrite into the frame buffer 2400 * v: decoded video after color conversion, 2401 * c: video color specified by VADisplayAttribBlendColor 2402 * b: background color of the drawable 2403 */ 2404 VADisplayAttribBlendColor = 13, 2405 /* 2406 * Indicate driver to skip painting color key or not. 2407 * only applicable if the render is overlay 2408 */ 2409 VADisplayAttribOverlayAutoPaintColorKey = 14, 2410 /* 2411 * customized overlay color key, the format is RGB888 2412 * [23:16] = Red, [15:08] = Green, [07:00] = Blue. 2413 */ 2414 VADisplayAttribOverlayColorKey = 15, 2415 /* 2416 * The hint for the implementation of vaPutSurface 2417 * normally, the driver could use an overlay or GPU to render the surface on the screen 2418 * this flag provides APP the flexibity to switch the render dynamically 2419 */ 2420 VADisplayAttribRenderMode = 16, 2421 /* 2422 * specify if vaPutSurface needs to render into specified monitors 2423 * one example is that one external monitor (e.g. HDMI) is enabled, 2424 * but the window manager is not aware of it, and there is no associated drawable 2425 */ 2426 VADisplayAttribRenderDevice = 17, 2427 /* 2428 * specify vaPutSurface render area if there is no drawable on the monitor 2429 */ 2430 VADisplayAttribRenderRect = 18, 2431} VADisplayAttribType; 2432 2433/* flags for VADisplayAttribute */ 2434#define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000 2435#define VA_DISPLAY_ATTRIB_GETTABLE 0x0001 2436#define VA_DISPLAY_ATTRIB_SETTABLE 0x0002 2437 2438typedef struct _VADisplayAttribute 2439{ 2440 VADisplayAttribType type; 2441 int min_value; 2442 int max_value; 2443 int value; /* used by the set/get attribute functions */ 2444/* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */ 2445 unsigned int flags; 2446} VADisplayAttribute; 2447 2448/* Get maximum number of display attributs supported by the implementation */ 2449int vaMaxNumDisplayAttributes ( 2450 VADisplay dpy 2451); 2452 2453/* 2454 * Query display attributes 2455 * The caller must provide a "attr_list" array that can hold at 2456 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes 2457 * returned in "attr_list" is returned in "num_attributes". 2458 */ 2459VAStatus vaQueryDisplayAttributes ( 2460 VADisplay dpy, 2461 VADisplayAttribute *attr_list, /* out */ 2462 int *num_attributes /* out */ 2463); 2464 2465/* 2466 * Get display attributes 2467 * This function returns the current attribute values in "attr_list". 2468 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field 2469 * from vaQueryDisplayAttributes() can have their values retrieved. 2470 */ 2471VAStatus vaGetDisplayAttributes ( 2472 VADisplay dpy, 2473 VADisplayAttribute *attr_list, /* in/out */ 2474 int num_attributes 2475); 2476 2477/* 2478 * Set display attributes 2479 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field 2480 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or 2481 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 2482 */ 2483VAStatus vaSetDisplayAttributes ( 2484 VADisplay dpy, 2485 VADisplayAttribute *attr_list, 2486 int num_attributes 2487); 2488 2489/**@}*/ 2490 2491#ifdef __cplusplus 2492} 2493#endif 2494 2495#endif /* _VA_H_ */ 2496