2 * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
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:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
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.
25 * Video Acceleration (VA) API Specification
28 * <jonathan.bian@intel.com>
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
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.
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
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.
75 * This file contains the \ref api_core "Core API".
82 #include <va/va_version.h>
89 * \mainpage Video Acceleration (VA) API
91 * \section intro Introduction
93 * The main motivation for VA-API (Video Acceleration API) is to
94 * enable hardware accelerated video decode and encode at various
95 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
96 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
97 * AVC/H.264, VC-1/VMW3, and JPEG).
99 * VA-API is split into several modules:
101 * - \ref api_enc_h264
106 * \defgroup api_core Core API
114 The VA API is intended to provide an interface between a video decode/encode/display
115 application (client) and a hardware accelerator (server), to off-load
116 video decode/encode/display operations from the host to the hardware accelerator at various
119 The basic operation steps are:
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
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
130 Initialization & Configuration Management
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
139 typedef void* VADisplay; /* window system dependent */
141 typedef 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
169 * \brief An invalid/unsupported value was supplied.
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.
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
184 /** De-interlacing flags for vaPutSurface() */
185 #define VA_FRAME_PICTURE 0x00000000
186 #define VA_TOP_FIELD 0x00000001
187 #define VA_BOTTOM_FIELD 0x00000002
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
195 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
198 * Clears the drawable with background color.
199 * for hardware overlay based implementation this flag
200 * can be used to turn off the overlay
202 #define VA_CLEAR_DRAWABLE 0x00000008
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
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
217 * Returns a short english description of error_status
219 const char *vaErrorStr(VAStatus error_status);
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()
228 typedef void* VANativeDisplay; /* window system dependent */
230 int vaDisplayIsValid(VADisplay dpy);
233 * Initialize the library
235 VAStatus vaInitialize (
237 int *major_version, /* out */
238 int *minor_version /* out */
242 * After this call, all library internal resources will be cleaned up
244 VAStatus vaTerminate (
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"
256 const char *vaQueryVendorString (
260 typedef int (*VAPrivFunc)();
263 * Return a function pointer given a function name in the library.
264 * This allows private interfaces into the library
266 VAPrivFunc vaGetLibFunc (
271 /** Currently defined profiles */
274 /** \brief Profile ID used for video processing. */
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 VAProfileVP8Version0_3 = 14,
291 VAProfileH264MultiviewHigh = 15,
292 VAProfileH264StereoHigh = 16
296 * Currently defined entrypoints
302 VAEntrypointIDCT = 3,
303 VAEntrypointMoComp = 4,
304 VAEntrypointDeblocking = 5,
305 VAEntrypointEncSlice = 6, /* slice level encode */
306 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
307 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
310 /** Currently defined configuration attribute types */
313 VAConfigAttribRTFormat = 0,
314 VAConfigAttribSpatialResidual = 1,
315 VAConfigAttribSpatialClipping = 2,
316 VAConfigAttribIntraResidual = 3,
317 VAConfigAttribEncryption = 4,
318 VAConfigAttribRateControl = 5,
320 /** @name Attributes for encoding */
323 * \brief Packed headers mode. Read/write.
325 * This attribute determines what packed headers the driver supports,
326 * through vaGetConfigAttributes(); and what packed headers the user
327 * will be providing to the driver, through vaCreateConfig(), if the
328 * driver supports those.
330 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
332 VAConfigAttribEncPackedHeaders = 10,
334 * \brief Interlaced mode. Read/write.
336 * This attribute determines what kind of interlaced encoding mode
337 * the driver supports.
339 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
341 VAConfigAttribEncInterlaced = 11,
343 * \brief Maximum number of reference frames. Read-only.
345 * This attribute determines the maximum number of reference
346 * frames supported for encoding.
348 * Note: for H.264 encoding, the value represents the maximum number
349 * of reference frames for both the reference picture list 0 (bottom
350 * 16 bits) and the reference picture list 1 (top 16 bits).
352 VAConfigAttribEncMaxRefFrames = 13,
354 * \brief Maximum number of slices per frame. Read-only.
356 * This attribute determines the maximum number of slices the
357 * driver can support to encode a single frame.
359 VAConfigAttribEncMaxSlices = 14,
361 * \brief Slice structure. Read-only.
363 * This attribute determines slice structures supported by the
364 * driver for encoding. This attribute is a hint to the user so
365 * that he can choose a suitable surface size and how to arrange
366 * the encoding process of multiple slices per frame.
368 * More specifically, for H.264 encoding, this attribute
369 * determines the range of accepted values to
370 * VAEncSliceParameterBufferH264::macroblock_address and
371 * VAEncSliceParameterBufferH264::num_macroblocks.
373 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
376 VAConfigAttribEncSliceStructure = 15,
378 * \brief Macroblock information. Read-only.
380 * This attribute determines whether the driver supports extra
381 * encoding information per-macroblock. e.g. QP.
383 * More specifically, for H.264 encoding, if the driver returns a non-zero
384 * value for this attribute, this means the application can create
385 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
386 * through VAEncSliceParameterBufferH264::macroblock_info.
388 VAConfigAttribEncMacroblockInfo = 16,
390 * \brief Encoding quality range attribute. Read-only.
392 * This attribute conveys whether the driver supports different quality level settings
393 * for encoding. A value less than or equal to 1 means that the encoder only has a single
394 * quality setting, and a value greater than 1 represents the number of quality levels
395 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
397 VAConfigAttribEncQualityRange = 21,
399 VAConfigAttribTypeMax
400 } VAConfigAttribType;
403 * Configuration attributes
404 * If there is more than one value for an attribute, a default
405 * value will be assigned to the attribute if the client does not
406 * specify the attribute when creating a configuration
408 typedef struct _VAConfigAttrib {
409 VAConfigAttribType type;
410 unsigned int value; /* OR'd flags (bits) for this attribute */
413 /** attribute value for VAConfigAttribRTFormat */
414 #define VA_RT_FORMAT_YUV420 0x00000001
415 #define VA_RT_FORMAT_YUV422 0x00000002
416 #define VA_RT_FORMAT_YUV444 0x00000004
417 #define VA_RT_FORMAT_YUV411 0x00000008
418 #define VA_RT_FORMAT_YUV400 0x00000010
419 #define VA_RT_FORMAT_RGB16 0x00010000
420 #define VA_RT_FORMAT_RGB32 0x00020000
421 /* RGBP covers RGBP and BGRP fourcc */
422 #define VA_RT_FORMAT_RGBP 0x00100000
423 #define VA_RT_FORMAT_PROTECTED 0x80000000
425 /** @name Attribute values for VAConfigAttribRateControl */
427 /** \brief Driver does not support any form of rate control. */
428 #define VA_RC_NONE 0x00000001
429 /** \brief Constant bitrate. */
430 #define VA_RC_CBR 0x00000002
431 /** \brief Variable bitrate. */
432 #define VA_RC_VBR 0x00000004
433 /** \brief Video conference mode. */
434 #define VA_RC_VCM 0x00000008
435 /** \brief Constant QP. */
436 #define VA_RC_CQP 0x00000010
437 /** \brief Variable bitrate with peak rate higher than average bitrate. */
438 #define VA_RC_VBR_CONSTRAINED 0x00000020
441 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
443 /** \brief Driver does not support any packed headers mode. */
444 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
445 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
446 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
447 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
448 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
449 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
450 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
451 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
452 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
453 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
454 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
457 /** @name Attribute values for VAConfigAttribEncInterlaced */
459 /** \brief Driver does not support interlaced coding. */
460 #define VA_ENC_INTERLACED_NONE 0x00000000
461 /** \brief Driver supports interlaced frame coding. */
462 #define VA_ENC_INTERLACED_FRAME 0x00000001
463 /** \brief Driver supports interlaced field coding. */
464 #define VA_ENC_INTERLACED_FIELD 0x00000002
465 /** \brief Driver supports macroblock adaptive frame field coding. */
466 #define VA_ENC_INTERLACED_MBAFF 0x00000004
467 /** \brief Driver supports picture adaptive frame field coding. */
468 #define VA_ENC_INTERLACED_PAFF 0x00000008
471 /** @name Attribute values for VAConfigAttribEncSliceStructure */
473 /** \brief Driver supports an arbitrary number of rows per slice. */
474 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
475 /** \brief Driver supports a power-of-two number of rows per slice. */
476 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
477 /** \brief Driver supports an arbitrary number of rows per slice. */
478 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
482 * if an attribute is not applicable for a given
483 * profile/entrypoint pair, then set the value to the following
485 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
487 /** Get maximum number of profiles supported by the implementation */
488 int vaMaxNumProfiles (
492 /** Get maximum number of entrypoints supported by the implementation */
493 int vaMaxNumEntrypoints (
497 /** Get maximum number of attributs supported by the implementation */
498 int vaMaxNumConfigAttributes (
503 * Query supported profiles
504 * The caller must provide a "profile_list" array that can hold at
505 * least vaMaxNumProfile() entries. The actual number of profiles
506 * returned in "profile_list" is returned in "num_profile".
508 VAStatus vaQueryConfigProfiles (
510 VAProfile *profile_list, /* out */
511 int *num_profiles /* out */
515 * Query supported entrypoints for a given profile
516 * The caller must provide an "entrypoint_list" array that can hold at
517 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
518 * returned in "entrypoint_list" is returned in "num_entrypoints".
520 VAStatus vaQueryConfigEntrypoints (
523 VAEntrypoint *entrypoint_list, /* out */
524 int *num_entrypoints /* out */
528 * Get attributes for a given profile/entrypoint pair
529 * The caller must provide an "attrib_list" with all attributes to be
530 * retrieved. Upon return, the attributes in "attrib_list" have been
531 * updated with their value. Unknown attributes or attributes that are
532 * not supported for the given profile/entrypoint pair will have their
533 * value set to VA_ATTRIB_NOT_SUPPORTED
535 VAStatus vaGetConfigAttributes (
538 VAEntrypoint entrypoint,
539 VAConfigAttrib *attrib_list, /* in/out */
543 /** Generic ID type, can be re-typed for specific implementation */
544 typedef unsigned int VAGenericID;
546 typedef VAGenericID VAConfigID;
549 * Create a configuration for the decode pipeline
550 * it passes in the attribute list that specifies the attributes it cares
551 * about, with the rest taking default values.
553 VAStatus vaCreateConfig (
556 VAEntrypoint entrypoint,
557 VAConfigAttrib *attrib_list,
559 VAConfigID *config_id /* out */
563 * Free resources associdated with a given config
565 VAStatus vaDestroyConfig (
571 * Query all attributes for a given configuration
572 * The profile of the configuration is returned in "profile"
573 * The entrypoint of the configuration is returned in "entrypoint"
574 * The caller must provide an "attrib_list" array that can hold at least
575 * vaMaxNumConfigAttributes() entries. The actual number of attributes
576 * returned in "attrib_list" is returned in "num_attribs"
578 VAStatus vaQueryConfigAttributes (
580 VAConfigID config_id,
581 VAProfile *profile, /* out */
582 VAEntrypoint *entrypoint, /* out */
583 VAConfigAttrib *attrib_list,/* out */
584 int *num_attribs /* out */
589 * Contexts and Surfaces
591 * Context represents a "virtual" video decode pipeline. Surfaces are render
592 * targets for a given context. The data in the surfaces are not accessible
593 * to the client and the internal data format of the surface is implementatin
596 * Surfaces will be bound to a context when the context is created. Once
597 * a surface is bound to a given context, it can not be used to create
598 * another context. The association is removed when the context is destroyed
600 * Both contexts and surfaces are identified by unique IDs and its
601 * implementation specific internals are kept opaque to the clients
604 typedef VAGenericID VAContextID;
606 typedef VAGenericID VASurfaceID;
608 #define VA_INVALID_ID 0xffffffff
609 #define VA_INVALID_SURFACE VA_INVALID_ID
611 /** \brief Generic value types. */
613 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
614 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
615 VAGenericValueTypePointer, /**< Generic pointer type */
616 VAGenericValueTypeFunc /**< Pointer to function */
617 } VAGenericValueType;
619 /** \brief Generic function type. */
620 typedef void (*VAGenericFunc)(void);
622 /** \brief Generic value. */
623 typedef struct _VAGenericValue {
624 /** \brief Value type. See #VAGenericValueType. */
625 VAGenericValueType type;
626 /** \brief Value holder. */
628 /** \brief 32-bit signed integer. */
630 /** \brief 32-bit float. */
632 /** \brief Generic pointer. */
634 /** \brief Pointer to function. */
639 /** @name Surface attribute flags */
641 /** \brief Surface attribute is not supported. */
642 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
643 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
644 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
645 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
646 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
649 /** \brief Surface attribute types. */
651 VASurfaceAttribNone = 0,
653 * \brief Pixel format (fourcc).
655 * The value is meaningful as input to vaQuerySurfaceAttributes().
656 * If zero, the driver returns the optimal pixel format for the
657 * specified config. Otherwise, if non-zero, the value represents
658 * a pixel format (FOURCC) that is kept as is on output, if the
659 * driver supports it. Otherwise, the driver sets the value to
660 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
662 VASurfaceAttribPixelFormat,
663 /** \brief Minimal width in pixels (int, read-only). */
664 VASurfaceAttribMinWidth,
665 /** \brief Maximal width in pixels (int, read-only). */
666 VASurfaceAttribMaxWidth,
667 /** \brief Minimal height in pixels (int, read-only). */
668 VASurfaceAttribMinHeight,
669 /** \brief Maximal height in pixels (int, read-only). */
670 VASurfaceAttribMaxHeight,
671 /** \brief Surface memory type expressed in bit fields (int, read/write). */
672 VASurfaceAttribMemoryType,
673 /** \brief External buffer descriptor (pointer, write). */
674 VASurfaceAttribExternalBufferDescriptor,
675 /** \brief Surface usage hint, gives the driver a hint of intended usage
676 * to optimize allocation (e.g. tiling) (int, read/write). */
677 VASurfaceAttribUsageHint,
678 /** \brief Number of surface attributes. */
680 } VASurfaceAttribType;
682 /** \brief Surface attribute. */
683 typedef struct _VASurfaceAttrib {
685 VASurfaceAttribType type;
686 /** \brief Flags. See "Surface attribute flags". */
688 /** \brief Value. See "Surface attribute types" for the expected types. */
689 VAGenericValue value;
693 * @name VASurfaceAttribMemoryType values in bit fields.
694 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
695 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
696 * types are defined in DRM and Android header files.
699 /** \brief VA memory type (default) is supported. */
700 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
701 /** \brief V4L2 buffer memory type is supported. */
702 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
703 /** \brief User pointer memory type is supported. */
704 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
708 * \brief VASurfaceAttribExternalBuffers structure for
709 * the VASurfaceAttribExternalBufferDescriptor attribute.
711 typedef struct _VASurfaceAttribExternalBuffers {
712 /** \brief pixel format in fourcc. */
713 unsigned int pixel_format;
714 /** \brief width in pixels. */
716 /** \brief height in pixels. */
718 /** \brief total size of the buffer in bytes. */
719 unsigned int data_size;
720 /** \brief number of planes for planar layout */
721 unsigned int num_planes;
722 /** \brief pitch for each plane in bytes */
723 unsigned int pitches[4];
724 /** \brief offset for each plane in bytes */
725 unsigned int offsets[4];
726 /** \brief buffer handles or user pointers */
727 unsigned long *buffers;
728 /** \brief number of elements in the "buffers" array */
729 unsigned int num_buffers;
730 /** \brief flags. See "Surface external buffer descriptor flags". */
732 /** \brief reserved for passing private data */
734 } VASurfaceAttribExternalBuffers;
736 /** @name VASurfaceAttribExternalBuffers flags */
738 /** \brief Enable memory tiling */
739 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
740 /** \brief Memory is cacheable */
741 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
742 /** \brief Memory is non-cacheable */
743 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
744 /** \brief Memory is write-combined */
745 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
746 /** \brief Memory is protected */
747 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
749 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
751 /** \brief Surface usage not indicated. */
752 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
753 /** \brief Surface used by video decoder. */
754 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
755 /** \brief Surface used by video encoder. */
756 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
757 /** \brief Surface read by video post-processing. */
758 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
759 /** \brief Surface written by video post-processing. */
760 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
761 /** \brief Surface used for display. */
762 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
767 * \brief Queries surface attributes for the supplied config.
769 * Unlike vaGetSurfaceAttributes(), this function queries for all
770 * supported attributes for the supplied VA @config. In particular, if
771 * the underlying hardware supports the creation of VA surfaces in
772 * various formats, then this function will enumerate all pixel
773 * formats that are supported.
775 * The \c attrib_list array is allocated by the user and \c
776 * num_attribs shall be initialized to the number of allocated
777 * elements in that array. Upon successful return, the actual number
778 * of attributes will be overwritten into \c num_attribs. Otherwise,
779 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
780 * is adjusted to the number of elements that would be returned if
781 * enough space was available.
783 * Note: it is perfectly valid to pass NULL to the \c attrib_list
784 * argument when vaQuerySurfaceAttributes() is used to determine the
785 * actual number of elements that need to be allocated.
787 * @param[in] dpy the VA display
788 * @param[in] config the config identifying a codec or a video
789 * processing pipeline
790 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
791 * @param[in,out] num_attribs the number of elements allocated on
792 * input, the number of elements actually filled in output
795 vaQuerySurfaceAttributes(
798 VASurfaceAttrib *attrib_list,
799 unsigned int *num_attribs
803 * \brief Creates an array of surfaces
805 * Creates an array of surfaces. The optional list of attributes shall
806 * be constructed and validated through vaGetSurfaceAttributes() or
807 * constructed based based on what the underlying hardware could
808 * expose through vaQuerySurfaceAttributes().
810 * @param[in] dpy the VA display
811 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
812 * @param[in] width the surface width
813 * @param[in] height the surface height
814 * @param[out] surfaces the array of newly created surfaces
815 * @param[in] num_surfaces the number of surfaces to create
816 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
817 * @param[in] num_attribs the number of attributes supplied in
818 * \c attrib_list, or zero
826 VASurfaceID *surfaces,
827 unsigned int num_surfaces,
828 VASurfaceAttrib *attrib_list,
829 unsigned int num_attribs
833 * vaDestroySurfaces - Destroy resources associated with surfaces.
834 * Surfaces can only be destroyed after the context associated has been
837 * surfaces: array of surfaces to destroy
838 * num_surfaces: number of surfaces in the array to be destroyed.
840 VAStatus vaDestroySurfaces (
842 VASurfaceID *surfaces,
846 #define VA_PROGRESSIVE 0x1
848 * vaCreateContext - Create a context
850 * config_id: configuration for the context
851 * picture_width: coded picture width
852 * picture_height: coded picture height
853 * flag: any combination of the following:
854 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
855 * render_targets: render targets (surfaces) tied to the context
856 * num_render_targets: number of render targets in the above array
857 * context: created context id upon return
859 VAStatus vaCreateContext (
861 VAConfigID config_id,
865 VASurfaceID *render_targets,
866 int num_render_targets,
867 VAContextID *context /* out */
871 * vaDestroyContext - Destroy a context
873 * context: context to be destroyed
875 VAStatus vaDestroyContext (
882 * Buffers are used to pass various types of data from the
883 * client to the server. The server maintains a data store
884 * for each buffer created, and the client idenfies a buffer
885 * through a unique buffer id assigned by the server.
888 typedef VAGenericID VABufferID;
892 VAPictureParameterBufferType = 0,
893 VAIQMatrixBufferType = 1,
894 VABitPlaneBufferType = 2,
895 VASliceGroupMapBufferType = 3,
896 VASliceParameterBufferType = 4,
897 VASliceDataBufferType = 5,
898 VAMacroblockParameterBufferType = 6,
899 VAResidualDataBufferType = 7,
900 VADeblockingParameterBufferType = 8,
901 VAImageBufferType = 9,
902 VAProtectedSliceDataBufferType = 10,
903 VAQMatrixBufferType = 11,
904 VAHuffmanTableBufferType = 12,
905 VAProbabilityBufferType = 13,
907 /* Following are encode buffer types */
908 VAEncCodedBufferType = 21,
909 VAEncSequenceParameterBufferType = 22,
910 VAEncPictureParameterBufferType = 23,
911 VAEncSliceParameterBufferType = 24,
912 VAEncPackedHeaderParameterBufferType = 25,
913 VAEncPackedHeaderDataBufferType = 26,
914 VAEncMiscParameterBufferType = 27,
915 VAEncMacroblockParameterBufferType = 28,
916 VAEncMacroblockMapBufferType = 29,
917 /* Following are video processing buffer types */
919 * \brief Video processing pipeline parameter buffer.
921 * This buffer describes the video processing pipeline. See
922 * #VAProcPipelineParameterBuffer for details.
924 VAProcPipelineParameterBufferType = 41,
926 * \brief Video filter parameter buffer.
928 * This buffer describes the video filter parameters. All buffers
929 * inherit from #VAProcFilterParameterBufferBase, thus including
930 * a unique filter buffer type.
932 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
933 * Filters requiring advanced parameters include, but are not limited to,
934 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
935 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
937 VAProcFilterParameterBufferType = 42,
943 VAEncMiscParameterTypeFrameRate = 0,
944 VAEncMiscParameterTypeRateControl = 1,
945 VAEncMiscParameterTypeMaxSliceSize = 2,
946 VAEncMiscParameterTypeAIR = 3,
947 /** \brief Buffer type used to express a maximum frame size (in bits). */
948 VAEncMiscParameterTypeMaxFrameSize = 4,
949 /** \brief Buffer type used for HRD parameters. */
950 VAEncMiscParameterTypeHRD = 5,
951 VAEncMiscParameterTypeQualityLevel = 6,
952 } VAEncMiscParameterType;
954 /** \brief Packed header type. */
956 /** \brief Packed sequence header. */
957 VAEncPackedHeaderSequence = 1,
958 /** \brief Packed picture header. */
959 VAEncPackedHeaderPicture = 2,
960 /** \brief Packed slice header. */
961 VAEncPackedHeaderSlice = 3,
963 * \brief Packed raw header.
965 * Packed raw data header can be used by the client to insert a header
966 * into the bitstream data buffer at the point it is passed, the driver
967 * will handle the raw packed header based on "has_emulation_bytes" field
968 * in the packed header parameter structure.
970 VAEncPackedHeaderRawData = 4,
971 /** \brief Misc packed header. See codec-specific definitions. */
972 VAEncPackedHeaderMiscMask = 0x80000000,
973 } VAEncPackedHeaderType;
975 /** \brief Packed header parameter. */
976 typedef struct _VAEncPackedHeaderParameterBuffer {
977 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
979 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
980 unsigned int bit_length;
981 /** \brief Flag: buffer contains start code emulation prevention bytes? */
982 unsigned char has_emulation_bytes;
983 } VAEncPackedHeaderParameterBuffer;
986 * For application, e.g. set a new bitrate
988 * VAEncMiscParameterBuffer *misc_param;
989 * VAEncMiscParameterRateControl *misc_rate_ctrl;
991 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
992 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
995 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
996 * misc_param->type = VAEncMiscParameterTypeRateControl;
997 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
998 * misc_rate_ctrl->bits_per_second = 6400000;
999 * vaUnmapBuffer(dpy, buf_id);
1000 * vaRenderPicture(dpy, context, &buf_id, 1);
1002 typedef struct _VAEncMiscParameterBuffer
1004 VAEncMiscParameterType type;
1005 unsigned int data[0];
1006 } VAEncMiscParameterBuffer;
1009 /** \brief Rate control parameters */
1010 typedef struct _VAEncMiscParameterRateControl
1012 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1013 unsigned int bits_per_second;
1014 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1015 * bit-rate for example if target_percentage is 95 then the rate control will target
1016 * a bit-rate that is 95% of the maximum bit-rate
1018 unsigned int target_percentage;
1019 /* windows size in milliseconds. For example if this is set to 500,
1020 * then the rate control will guarantee the target bit-rate over a 500 ms window
1022 unsigned int window_size;
1023 /* initial QP at I frames */
1024 unsigned int initial_qp;
1025 unsigned int min_qp;
1026 unsigned int basic_unit_size;
1031 unsigned int reset : 1;
1032 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1033 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1037 } VAEncMiscParameterRateControl;
1039 typedef struct _VAEncMiscParameterFrameRate
1041 unsigned int framerate;
1042 } VAEncMiscParameterFrameRate;
1045 * Allow a maximum slice size to be specified (in bits).
1046 * The encoder will attempt to make sure that individual slices do not exceed this size
1047 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1049 typedef struct _VAEncMiscParameterMaxSliceSize
1051 unsigned int max_slice_size;
1052 } VAEncMiscParameterMaxSliceSize;
1054 typedef struct _VAEncMiscParameterAIR
1056 unsigned int air_num_mbs;
1057 unsigned int air_threshold;
1058 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1059 } VAEncMiscParameterAIR;
1061 typedef struct _VAEncMiscParameterHRD
1063 unsigned int initial_buffer_fullness; /* in bits */
1064 unsigned int buffer_size; /* in bits */
1065 } VAEncMiscParameterHRD;
1068 * \brief Defines a maximum frame size (in bits).
1070 * This misc parameter buffer defines the maximum size of a frame (in
1071 * bits). The encoder will try to make sure that each frame does not
1072 * exceed this size. Otherwise, if the frame size exceeds this size,
1073 * the \c status flag of #VACodedBufferSegment will contain
1074 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1076 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1077 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1078 VAEncMiscParameterType type;
1079 /** \brief Maximum size of a frame (in bits). */
1080 unsigned int max_frame_size;
1081 } VAEncMiscParameterBufferMaxFrameSize;
1084 * \brief Encoding quality level.
1086 * The encoding quality could be set through this structure, if the implementation
1087 * supports multiple quality levels. The quality level set through this structure is
1088 * persistent over the entire coded sequence, or until a new structure is being sent.
1089 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1090 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1091 * quality. The quality level setting is used as a trade-off between quality and speed/power
1092 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1094 typedef struct _VAEncMiscParameterBufferQualityLevel {
1095 /** \brief Encoding quality level setting. */
1096 unsigned int quality_level;
1097 } VAEncMiscParameterBufferQualityLevel;
1100 * There will be cases where the bitstream buffer will not have enough room to hold
1101 * the data for the entire slice, and the following flags will be used in the slice
1102 * parameter to signal to the server for the possible cases.
1103 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1104 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1105 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1107 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1108 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1109 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1110 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1112 /* Codec-independent Slice Parameter Buffer base */
1113 typedef struct _VASliceParameterBufferBase
1115 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1116 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1117 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1118 } VASliceParameterBufferBase;
1121 /****************************
1122 * JEPG data structure
1123 ***************************/
1124 typedef struct _VAQMatrixBufferJPEG
1126 int load_lum_quantiser_matrix;
1127 int load_chroma_quantiser_matrix;
1128 unsigned char lum_quantiser_matrix[64];
1129 unsigned char chroma_quantiser_matrix[64];
1130 } VAQMatrixBufferJPEG;
1132 typedef struct _VAEncPictureParameterBufferJPEG
1134 VASurfaceID reconstructed_picture;
1135 unsigned short picture_width;
1136 unsigned short picture_height;
1137 VABufferID coded_buf;
1138 } VAEncPictureParameterBufferJPEG;
1140 #include <va/va_dec_jpeg.h>
1142 /****************************
1143 * MPEG-2 data structures
1144 ****************************/
1146 /* MPEG-2 Picture Parameter Buffer */
1148 * For each frame or field, and before any slice data, a single
1149 * picture parameter buffer must be send.
1151 typedef struct _VAPictureParameterBufferMPEG2
1153 unsigned short horizontal_size;
1154 unsigned short vertical_size;
1155 VASurfaceID forward_reference_picture;
1156 VASurfaceID backward_reference_picture;
1157 /* meanings of the following fields are the same as in the standard */
1158 int picture_coding_type;
1159 int f_code; /* pack all four fcode into this */
1162 unsigned int intra_dc_precision : 2;
1163 unsigned int picture_structure : 2;
1164 unsigned int top_field_first : 1;
1165 unsigned int frame_pred_frame_dct : 1;
1166 unsigned int concealment_motion_vectors : 1;
1167 unsigned int q_scale_type : 1;
1168 unsigned int intra_vlc_format : 1;
1169 unsigned int alternate_scan : 1;
1170 unsigned int repeat_first_field : 1;
1171 unsigned int progressive_frame : 1;
1172 unsigned int is_first_field : 1; /* indicate whether the current field
1173 * is the first field for field picture
1177 } picture_coding_extension;
1178 } VAPictureParameterBufferMPEG2;
1180 /** MPEG-2 Inverse Quantization Matrix Buffer */
1181 typedef struct _VAIQMatrixBufferMPEG2
1183 int load_intra_quantiser_matrix;
1184 int load_non_intra_quantiser_matrix;
1185 int load_chroma_intra_quantiser_matrix;
1186 int load_chroma_non_intra_quantiser_matrix;
1187 unsigned char intra_quantiser_matrix[64];
1188 unsigned char non_intra_quantiser_matrix[64];
1189 unsigned char chroma_intra_quantiser_matrix[64];
1190 unsigned char chroma_non_intra_quantiser_matrix[64];
1191 } VAIQMatrixBufferMPEG2;
1193 /** MPEG-2 Slice Parameter Buffer */
1194 typedef struct _VASliceParameterBufferMPEG2
1196 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1197 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1198 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1199 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1200 unsigned int slice_horizontal_position;
1201 unsigned int slice_vertical_position;
1202 int quantiser_scale_code;
1203 int intra_slice_flag;
1204 } VASliceParameterBufferMPEG2;
1206 /** MPEG-2 Macroblock Parameter Buffer */
1207 typedef struct _VAMacroblockParameterBufferMPEG2
1209 unsigned short macroblock_address;
1211 * macroblock_address (in raster scan order)
1213 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1215 unsigned char macroblock_type; /* see definition below */
1218 unsigned int frame_motion_type : 2;
1219 unsigned int field_motion_type : 2;
1220 unsigned int dct_type : 1;
1224 unsigned char motion_vertical_field_select;
1226 * motion_vertical_field_select:
1227 * see section 6.3.17.2 in the spec
1228 * only the lower 4 bits are used
1229 * bit 0: first vector forward
1230 * bit 1: first vector backward
1231 * bit 2: second vector forward
1232 * bit 3: second vector backward
1234 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1235 unsigned short coded_block_pattern;
1237 * The bitplanes for coded_block_pattern are described
1238 * in Figure 6.10-12 in the spec
1241 /* Number of skipped macroblocks after this macroblock */
1242 unsigned short num_skipped_macroblocks;
1243 } VAMacroblockParameterBufferMPEG2;
1246 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1248 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1249 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1250 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1251 #define VA_MB_TYPE_MOTION_INTRA 0x10
1254 * MPEG-2 Residual Data Buffer
1255 * For each macroblock, there wil be 64 shorts (16-bit) in the
1256 * residual data buffer
1259 /****************************
1260 * MPEG-4 Part 2 data structures
1261 ****************************/
1263 /* MPEG-4 Picture Parameter Buffer */
1265 * For each frame or field, and before any slice data, a single
1266 * picture parameter buffer must be send.
1268 typedef struct _VAPictureParameterBufferMPEG4
1270 unsigned short vop_width;
1271 unsigned short vop_height;
1272 VASurfaceID forward_reference_picture;
1273 VASurfaceID backward_reference_picture;
1276 unsigned int short_video_header : 1;
1277 unsigned int chroma_format : 2;
1278 unsigned int interlaced : 1;
1279 unsigned int obmc_disable : 1;
1280 unsigned int sprite_enable : 2;
1281 unsigned int sprite_warping_accuracy : 2;
1282 unsigned int quant_type : 1;
1283 unsigned int quarter_sample : 1;
1284 unsigned int data_partitioned : 1;
1285 unsigned int reversible_vlc : 1;
1286 unsigned int resync_marker_disable : 1;
1290 unsigned char no_of_sprite_warping_points;
1291 short sprite_trajectory_du[3];
1292 short sprite_trajectory_dv[3];
1293 unsigned char quant_precision;
1296 unsigned int vop_coding_type : 2;
1297 unsigned int backward_reference_vop_coding_type : 2;
1298 unsigned int vop_rounding_type : 1;
1299 unsigned int intra_dc_vlc_thr : 3;
1300 unsigned int top_field_first : 1;
1301 unsigned int alternate_vertical_scan_flag : 1;
1305 unsigned char vop_fcode_forward;
1306 unsigned char vop_fcode_backward;
1307 unsigned short vop_time_increment_resolution;
1308 /* short header related */
1309 unsigned char num_gobs_in_vop;
1310 unsigned char num_macroblocks_in_gob;
1311 /* for direct mode prediction */
1314 } VAPictureParameterBufferMPEG4;
1316 /** MPEG-4 Inverse Quantization Matrix Buffer */
1317 typedef struct _VAIQMatrixBufferMPEG4
1319 int load_intra_quant_mat;
1320 int load_non_intra_quant_mat;
1321 unsigned char intra_quant_mat[64];
1322 unsigned char non_intra_quant_mat[64];
1323 } VAIQMatrixBufferMPEG4;
1325 /** MPEG-4 Slice Parameter Buffer */
1326 typedef struct _VASliceParameterBufferMPEG4
1328 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1329 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1330 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1331 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1332 unsigned int macroblock_number;
1334 } VASliceParameterBufferMPEG4;
1337 VC-1 data structures
1340 typedef enum /* see 7.1.1.32 */
1343 VAMvMode1MvHalfPel = 1,
1344 VAMvMode1MvHalfPelBilinear = 2,
1345 VAMvModeMixedMv = 3,
1346 VAMvModeIntensityCompensation = 4
1349 /** VC-1 Picture Parameter Buffer */
1351 * For each picture, and before any slice data, a picture parameter
1352 * buffer must be send. Multiple picture parameter buffers may be
1353 * sent for a single picture. In that case picture parameters will
1354 * apply to all slice data that follow it until a new picture
1355 * parameter buffer is sent.
1358 * pic_quantizer_type should be set to the applicable quantizer
1359 * type as defined by QUANTIZER (J.1.19) and either
1360 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1362 typedef struct _VAPictureParameterBufferVC1
1364 VASurfaceID forward_reference_picture;
1365 VASurfaceID backward_reference_picture;
1366 /* if out-of-loop post-processing is done on the render
1367 target, then we need to keep the in-loop decoded
1368 picture as a reference picture */
1369 VASurfaceID inloop_decoded_picture;
1371 /* sequence layer for AP or meta data for SP and MP */
1374 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1375 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1376 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1377 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1378 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1379 unsigned int multires : 1; /* METADATA::MULTIRES */
1380 unsigned int overlap : 1; /* METADATA::OVERLAP */
1381 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1382 unsigned int rangered : 1; /* METADATA::RANGERED */
1383 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1384 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1389 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1390 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1393 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1394 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1395 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1396 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1399 } entrypoint_fields;
1400 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1401 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1404 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1405 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1406 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1407 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1410 } range_mapping_fields;
1412 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1413 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1414 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1415 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1416 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1417 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1418 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1419 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1420 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1423 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1424 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1425 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1426 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1427 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1433 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1434 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1435 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1436 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1437 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1438 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1439 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1445 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1446 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1447 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1448 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1449 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1450 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1451 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1454 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1457 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1458 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1459 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1460 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1466 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1467 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1468 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1469 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1470 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1471 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1472 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1473 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1474 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1475 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1481 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1482 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1483 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1484 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1485 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1486 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1487 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1488 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1489 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1490 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1491 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1494 } pic_quantizer_fields;
1497 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1498 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1499 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1500 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1501 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1502 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1506 } VAPictureParameterBufferVC1;
1508 /** VC-1 Bitplane Buffer
1509 There will be at most three bitplanes coded in any picture header. To send
1510 the bitplane data more efficiently, each byte is divided in two nibbles, with
1511 each nibble carrying three bitplanes for one macroblock. The following table
1512 shows the bitplane data arrangement within each nibble based on the picture
1515 Picture Type Bit3 Bit2 Bit1 Bit0
1516 I or BI OVERFLAGS ACPRED FIELDTX
1517 P MYTYPEMB SKIPMB DIRECTMB
1518 B FORWARDMB SKIPMB DIRECTMB
1520 Within each byte, the lower nibble is for the first MB and the upper nibble is
1521 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1522 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1523 Macroblock #2 in the first row.
1526 /* VC-1 Slice Parameter Buffer */
1527 typedef struct _VASliceParameterBufferVC1
1529 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1530 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1531 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1532 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1533 unsigned int slice_vertical_position;
1534 } VASliceParameterBufferVC1;
1536 /* VC-1 Slice Data Buffer */
1538 This is simplely a buffer containing raw bit-stream bytes
1541 /****************************
1542 * H.264/AVC data structures
1543 ****************************/
1545 typedef struct _VAPictureH264
1547 VASurfaceID picture_id;
1548 unsigned int frame_idx;
1550 signed int TopFieldOrderCnt;
1551 signed int BottomFieldOrderCnt;
1553 /* flags in VAPictureH264 could be OR of the following */
1554 #define VA_PICTURE_H264_INVALID 0x00000001
1555 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1556 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1557 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1558 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1560 /** H.264 Picture Parameter Buffer */
1562 * For each picture, and before any slice data, a single
1563 * picture parameter buffer must be send.
1565 typedef struct _VAPictureParameterBufferH264
1567 VAPictureH264 CurrPic;
1568 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1569 unsigned short picture_width_in_mbs_minus1;
1570 unsigned short picture_height_in_mbs_minus1;
1571 unsigned char bit_depth_luma_minus8;
1572 unsigned char bit_depth_chroma_minus8;
1573 unsigned char num_ref_frames;
1576 unsigned int chroma_format_idc : 2;
1577 unsigned int residual_colour_transform_flag : 1;
1578 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1579 unsigned int frame_mbs_only_flag : 1;
1580 unsigned int mb_adaptive_frame_field_flag : 1;
1581 unsigned int direct_8x8_inference_flag : 1;
1582 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1583 unsigned int log2_max_frame_num_minus4 : 4;
1584 unsigned int pic_order_cnt_type : 2;
1585 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1586 unsigned int delta_pic_order_always_zero_flag : 1;
1590 unsigned char num_slice_groups_minus1;
1591 unsigned char slice_group_map_type;
1592 unsigned short slice_group_change_rate_minus1;
1593 signed char pic_init_qp_minus26;
1594 signed char pic_init_qs_minus26;
1595 signed char chroma_qp_index_offset;
1596 signed char second_chroma_qp_index_offset;
1599 unsigned int entropy_coding_mode_flag : 1;
1600 unsigned int weighted_pred_flag : 1;
1601 unsigned int weighted_bipred_idc : 2;
1602 unsigned int transform_8x8_mode_flag : 1;
1603 unsigned int field_pic_flag : 1;
1604 unsigned int constrained_intra_pred_flag : 1;
1605 unsigned int pic_order_present_flag : 1;
1606 unsigned int deblocking_filter_control_present_flag : 1;
1607 unsigned int redundant_pic_cnt_present_flag : 1;
1608 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1612 unsigned short frame_num;
1613 } VAPictureParameterBufferH264;
1615 /** H.264 Inverse Quantization Matrix Buffer */
1616 typedef struct _VAIQMatrixBufferH264
1618 unsigned char ScalingList4x4[6][16];
1619 unsigned char ScalingList8x8[2][64];
1620 } VAIQMatrixBufferH264;
1623 * H.264 Slice Group Map Buffer
1624 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1625 * A slice group map buffer should be sent for each picture if required. The buffer
1626 * is sent only when there is a change in the mapping values.
1627 * The slice group map buffer map "map units" to slice groups as specified in
1628 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1629 * in raster scan order
1632 /** H.264 Slice Parameter Buffer */
1633 typedef struct _VASliceParameterBufferH264
1635 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1636 /** \brief Byte offset to the NAL Header Unit for this slice. */
1637 unsigned int slice_data_offset;
1638 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1640 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1642 * This bit offset is relative to and includes the NAL unit byte
1643 * and represents the number of bits parsed in the slice_header()
1644 * after the removal of any emulation prevention bytes in
1645 * there. However, the slice data buffer passed to the hardware is
1646 * the original bitstream, thus including any emulation prevention
1649 unsigned short slice_data_bit_offset;
1650 unsigned short first_mb_in_slice;
1651 unsigned char slice_type;
1652 unsigned char direct_spatial_mv_pred_flag;
1653 unsigned char num_ref_idx_l0_active_minus1;
1654 unsigned char num_ref_idx_l1_active_minus1;
1655 unsigned char cabac_init_idc;
1656 char slice_qp_delta;
1657 unsigned char disable_deblocking_filter_idc;
1658 char slice_alpha_c0_offset_div2;
1659 char slice_beta_offset_div2;
1660 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1661 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1662 unsigned char luma_log2_weight_denom;
1663 unsigned char chroma_log2_weight_denom;
1664 unsigned char luma_weight_l0_flag;
1665 short luma_weight_l0[32];
1666 short luma_offset_l0[32];
1667 unsigned char chroma_weight_l0_flag;
1668 short chroma_weight_l0[32][2];
1669 short chroma_offset_l0[32][2];
1670 unsigned char luma_weight_l1_flag;
1671 short luma_weight_l1[32];
1672 short luma_offset_l1[32];
1673 unsigned char chroma_weight_l1_flag;
1674 short chroma_weight_l1[32][2];
1675 short chroma_offset_l1[32][2];
1676 } VASliceParameterBufferH264;
1678 /****************************
1679 * Common encode data structures
1680 ****************************/
1683 VAEncPictureTypeIntra = 0,
1684 VAEncPictureTypePredictive = 1,
1685 VAEncPictureTypeBidirectional = 2,
1688 /* Encode Slice Parameter Buffer */
1689 typedef struct _VAEncSliceParameterBuffer
1691 unsigned int start_row_number; /* starting MB row number for this slice */
1692 unsigned int slice_height; /* slice height measured in MB */
1695 unsigned int is_intra : 1;
1696 unsigned int disable_deblocking_filter_idc : 2;
1697 unsigned int uses_long_term_ref :1;
1698 unsigned int is_long_term_ref :1;
1702 } VAEncSliceParameterBuffer;
1705 /****************************
1706 * H.263 specific encode data structures
1707 ****************************/
1709 typedef struct _VAEncSequenceParameterBufferH263
1711 unsigned int intra_period;
1712 unsigned int bits_per_second;
1713 unsigned int frame_rate;
1714 unsigned int initial_qp;
1715 unsigned int min_qp;
1716 } VAEncSequenceParameterBufferH263;
1718 typedef struct _VAEncPictureParameterBufferH263
1720 VASurfaceID reference_picture;
1721 VASurfaceID reconstructed_picture;
1722 VABufferID coded_buf;
1723 unsigned short picture_width;
1724 unsigned short picture_height;
1725 VAEncPictureType picture_type;
1726 } VAEncPictureParameterBufferH263;
1728 /****************************
1729 * MPEG-4 specific encode data structures
1730 ****************************/
1732 typedef struct _VAEncSequenceParameterBufferMPEG4
1734 unsigned char profile_and_level_indication;
1735 unsigned int intra_period;
1736 unsigned int video_object_layer_width;
1737 unsigned int video_object_layer_height;
1738 unsigned int vop_time_increment_resolution;
1739 unsigned int fixed_vop_rate;
1740 unsigned int fixed_vop_time_increment;
1741 unsigned int bits_per_second;
1742 unsigned int frame_rate;
1743 unsigned int initial_qp;
1744 unsigned int min_qp;
1745 } VAEncSequenceParameterBufferMPEG4;
1747 typedef struct _VAEncPictureParameterBufferMPEG4
1749 VASurfaceID reference_picture;
1750 VASurfaceID reconstructed_picture;
1751 VABufferID coded_buf;
1752 unsigned short picture_width;
1753 unsigned short picture_height;
1754 unsigned int modulo_time_base; /* number of 1s */
1755 unsigned int vop_time_increment;
1756 VAEncPictureType picture_type;
1757 } VAEncPictureParameterBufferMPEG4;
1761 /** Buffer functions */
1764 * Creates a buffer for "num_elements" elements of "size" bytes and
1765 * initalize with "data".
1766 * if "data" is null, then the contents of the buffer data store
1768 * Basically there are two ways to get buffer data to the server side. One is
1769 * to call vaCreateBuffer() with a non-null "data", which results the data being
1770 * copied to the data store on the server side. A different method that
1771 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1772 * and then use vaMapBuffer() to map the data store from the server side to the
1773 * client address space for access.
1774 * Note: image buffers are created by the library, not the client. Please see
1775 * vaCreateImage on how image buffers are managed.
1777 VAStatus vaCreateBuffer (
1779 VAContextID context,
1780 VABufferType type, /* in */
1781 unsigned int size, /* in */
1782 unsigned int num_elements, /* in */
1783 void *data, /* in */
1784 VABufferID *buf_id /* out */
1788 * Convey to the server how many valid elements are in the buffer.
1789 * e.g. if multiple slice parameters are being held in a single buffer,
1790 * this will communicate to the server the number of slice parameters
1791 * that are valid in the buffer.
1793 VAStatus vaBufferSetNumElements (
1795 VABufferID buf_id, /* in */
1796 unsigned int num_elements /* in */
1801 * device independent data structure for codedbuffer
1805 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1806 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1807 * enough for the encoder to attempt to limit its size.
1808 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1809 * exceeded the maximum slice size specified.
1810 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1811 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1812 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1814 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1815 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1816 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1817 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1818 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1820 * \brief The frame has exceeded the maximum requested size.
1822 * This flag indicates that the encoded frame size exceeds the value
1823 * specified through a misc parameter buffer of type
1824 * #VAEncMiscParameterTypeMaxFrameSize.
1826 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1827 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1830 * \brief The coded buffer segment contains a single NAL unit.
1832 * This flag indicates that the coded buffer segment contains a
1833 * single NAL unit. This flag might be useful to the user for
1834 * processing the coded buffer.
1836 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1839 * \brief Coded buffer segment.
1841 * #VACodedBufferSegment is an element of a linked list describing
1842 * some information on the coded buffer. The coded buffer segment
1843 * could contain either a single NAL unit, or more than one NAL unit.
1844 * It is recommended (but not required) to return a single NAL unit
1845 * in a coded buffer segment, and the implementation should set the
1846 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1848 typedef struct _VACodedBufferSegment {
1850 * \brief Size of the data buffer in this segment (in bytes).
1853 /** \brief Bit offset into the data buffer where the video data starts. */
1854 unsigned int bit_offset;
1855 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1856 unsigned int status;
1857 /** \brief Reserved for future use. */
1858 unsigned int reserved;
1859 /** \brief Pointer to the start of the data buffer. */
1862 * \brief Pointer to the next #VACodedBufferSegment element,
1863 * or \c NULL if there is none.
1866 } VACodedBufferSegment;
1869 * Map data store of the buffer into the client's address space
1870 * vaCreateBuffer() needs to be called with "data" set to NULL before
1871 * calling vaMapBuffer()
1873 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1874 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1876 VAStatus vaMapBuffer (
1878 VABufferID buf_id, /* in */
1879 void **pbuf /* out */
1883 * After client making changes to a mapped data store, it needs to
1884 * "Unmap" it to let the server know that the data is ready to be
1885 * consumed by the server
1887 VAStatus vaUnmapBuffer (
1889 VABufferID buf_id /* in */
1893 * After this call, the buffer is deleted and this buffer_id is no longer valid
1894 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1896 VAStatus vaDestroyBuffer (
1898 VABufferID buffer_id
1902 Render (Decode) Pictures
1904 A picture represents either a frame or a field.
1906 The Begin/Render/End sequence sends the decode buffers to the server
1910 * Get ready to decode a picture to a target surface
1912 VAStatus vaBeginPicture (
1914 VAContextID context,
1915 VASurfaceID render_target
1919 * Send decode buffers to the server.
1920 * Buffers are automatically destroyed afterwards
1922 VAStatus vaRenderPicture (
1924 VAContextID context,
1925 VABufferID *buffers,
1930 * Make the end of rendering for a picture.
1931 * The server should start processing all pending operations for this
1932 * surface. This call is non-blocking. The client can start another
1933 * Begin/Render/End sequence on a different render target.
1935 VAStatus vaEndPicture (
1947 * This function blocks until all pending operations on the render target
1948 * have been completed. Upon return it is safe to use the render target for a
1949 * different picture.
1951 VAStatus vaSyncSurface (
1953 VASurfaceID render_target
1958 VASurfaceRendering = 1, /* Rendering in progress */
1959 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1960 /* this status is useful if surface is used as the source */
1962 VASurfaceReady = 4, /* not being rendered or displayed */
1963 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1967 * Find out any pending ops on the render target
1969 VAStatus vaQuerySurfaceStatus (
1971 VASurfaceID render_target,
1972 VASurfaceStatus *status /* out */
1977 VADecodeSliceMissing = 0,
1978 VADecodeMBError = 1,
1979 } VADecodeErrorType;
1982 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1983 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1985 typedef struct _VASurfaceDecodeMBErrors
1987 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1988 unsigned int start_mb; /* start mb address with errors */
1989 unsigned int end_mb; /* end mb address with errors */
1990 VADecodeErrorType decode_error_type;
1991 } VASurfaceDecodeMBErrors;
1994 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1995 * it can call vaQuerySurfaceError to find out further details on the particular error.
1996 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1997 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1998 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1999 * The array is terminated if "status==-1" is detected.
2001 VAStatus vaQuerySurfaceError(
2003 VASurfaceID surface,
2004 VAStatus error_status,
2009 * Images and Subpictures
2010 * VAImage is used to either get the surface data to client memory, or
2011 * to copy image data in client memory to a surface.
2012 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2013 * is at the upper left corner with positive X to the right and positive Y down
2015 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2016 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2017 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2020 * Pre-defined fourcc codes
2022 #define VA_FOURCC_NV12 0x3231564E
2023 #define VA_FOURCC_AI44 0x34344149
2024 #define VA_FOURCC_RGBA 0x41424752
2025 #define VA_FOURCC_RGBX 0x58424752
2026 #define VA_FOURCC_BGRA 0x41524742
2027 #define VA_FOURCC_BGRX 0x58524742
2028 #define VA_FOURCC_ARGB 0x42475241
2029 #define VA_FOURCC_XRGB 0x42475258
2030 #define VA_FOURCC_ABGR 0x52474241
2031 #define VA_FOURCC_XBGR 0x52474258
2032 #define VA_FOURCC_UYVY 0x59565955
2033 #define VA_FOURCC_YUY2 0x32595559
2034 #define VA_FOURCC_AYUV 0x56555941
2035 #define VA_FOURCC_NV11 0x3131564e
2036 #define VA_FOURCC_YV12 0x32315659
2037 #define VA_FOURCC_P208 0x38303250
2038 #define VA_FOURCC_IYUV 0x56555949
2039 #define VA_FOURCC_YV24 0x34325659
2040 #define VA_FOURCC_YV32 0x32335659
2041 #define VA_FOURCC_Y800 0x30303859
2042 #define VA_FOURCC_IMC3 0x33434D49
2043 #define VA_FOURCC_411P 0x50313134
2044 #define VA_FOURCC_422H 0x48323234
2045 #define VA_FOURCC_422V 0x56323234
2046 #define VA_FOURCC_444P 0x50343434
2047 #define VA_FOURCC_RGBP 0x50424752
2048 #define VA_FOURCC_BGRP 0x50524742
2049 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2052 #define VA_LSB_FIRST 1
2053 #define VA_MSB_FIRST 2
2055 typedef struct _VAImageFormat
2057 unsigned int fourcc;
2058 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2059 unsigned int bits_per_pixel;
2060 /* for RGB formats */
2061 unsigned int depth; /* significant bits per pixel */
2062 unsigned int red_mask;
2063 unsigned int green_mask;
2064 unsigned int blue_mask;
2065 unsigned int alpha_mask;
2068 typedef VAGenericID VAImageID;
2070 typedef struct _VAImage
2072 VAImageID image_id; /* uniquely identify this image */
2073 VAImageFormat format;
2074 VABufferID buf; /* image data buffer */
2076 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2077 * data store on the server side for optimal performance. The buffer will be
2078 * created by the CreateImage function, and proper storage allocated based on the image
2079 * size and format. This buffer is managed by the library implementation, and
2080 * accessed by the client through the buffer Map/Unmap functions.
2082 unsigned short width;
2083 unsigned short height;
2084 unsigned int data_size;
2085 unsigned int num_planes; /* can not be greater than 3 */
2087 * An array indicating the scanline pitch in bytes for each plane.
2088 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2090 unsigned int pitches[3];
2092 * An array indicating the byte offset from the beginning of the image data
2093 * to the start of each plane.
2095 unsigned int offsets[3];
2097 /* The following fields are only needed for paletted formats */
2098 int num_palette_entries; /* set to zero for non-palette images */
2100 * Each component is one byte and entry_bytes indicates the number of components in
2101 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2105 * An array of ascii characters describing the order of the components within the bytes.
2106 * Only entry_bytes characters of the string are used.
2108 char component_order[4];
2111 /** Get maximum number of image formats supported by the implementation */
2112 int vaMaxNumImageFormats (
2117 * Query supported image formats
2118 * The caller must provide a "format_list" array that can hold at
2119 * least vaMaxNumImageFormats() entries. The actual number of formats
2120 * returned in "format_list" is returned in "num_formats".
2122 VAStatus vaQueryImageFormats (
2124 VAImageFormat *format_list, /* out */
2125 int *num_formats /* out */
2129 * Create a VAImage structure
2130 * The width and height fields returned in the VAImage structure may get
2131 * enlarged for some YUV formats. Upon return from this function,
2132 * image->buf has been created and proper storage allocated by the library.
2133 * The client can access the image through the Map/Unmap calls.
2135 VAStatus vaCreateImage (
2137 VAImageFormat *format,
2140 VAImage *image /* out */
2144 * Should call DestroyImage before destroying the surface it is bound to
2146 VAStatus vaDestroyImage (
2151 VAStatus vaSetImagePalette (
2155 * pointer to an array holding the palette data. The size of the array is
2156 * num_palette_entries * entry_bytes in size. The order of the components
2157 * in the palette is described by the component_order in VAImage struct
2159 unsigned char *palette
2163 * Retrive surface data into a VAImage
2164 * Image must be in a format supported by the implementation
2166 VAStatus vaGetImage (
2168 VASurfaceID surface,
2169 int x, /* coordinates of the upper left source pixel */
2171 unsigned int width, /* width and height of the region */
2172 unsigned int height,
2177 * Copy data from a VAImage to a surface
2178 * Image must be in a format supported by the implementation
2179 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2180 * shouldn't be rendered into when this is called
2182 VAStatus vaPutImage (
2184 VASurfaceID surface,
2188 unsigned int src_width,
2189 unsigned int src_height,
2192 unsigned int dest_width,
2193 unsigned int dest_height
2197 * Derive an VAImage from an existing surface.
2198 * This interface will derive a VAImage and corresponding image buffer from
2199 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2200 * direct CPU access. This operation is only possible on implementations with
2201 * direct rendering capabilities and internal surface formats that can be
2202 * represented with a VAImage. When the operation is not possible this interface
2203 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2204 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2207 * Implementations should only return success when the resulting image buffer
2208 * would be useable with vaMap/Unmap.
2210 * When directly accessing a surface special care must be taken to insure
2211 * proper synchronization with the graphics hardware. Clients should call
2212 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2213 * rendering or currently being displayed by an overlay.
2215 * Additionally nothing about the contents of a surface should be assumed
2216 * following a vaPutSurface. Implementations are free to modify the surface for
2217 * scaling or subpicture blending within a call to vaPutImage.
2219 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2220 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2221 * vaGetImage with other surfaces is supported.
2223 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2224 * image and image buffer structures will be destroyed; however, the underlying
2225 * surface will remain unchanged until freed with vaDestroySurfaces.
2227 VAStatus vaDeriveImage (
2229 VASurfaceID surface,
2230 VAImage *image /* out */
2235 * Subpicture is a special type of image that can be blended
2236 * with a surface during vaPutSurface(). Subpicture can be used to render
2237 * DVD sub-titles or closed captioning text etc.
2240 typedef VAGenericID VASubpictureID;
2242 /** Get maximum number of subpicture formats supported by the implementation */
2243 int vaMaxNumSubpictureFormats (
2247 /** flags for subpictures */
2248 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2249 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2250 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2252 * Query supported subpicture formats
2253 * The caller must provide a "format_list" array that can hold at
2254 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2255 * for each format to indicate additional capabilities for that format. The actual
2256 * number of formats returned in "format_list" is returned in "num_formats".
2257 * flags: returned value to indicate addtional capabilities
2258 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2259 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2260 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2263 VAStatus vaQuerySubpictureFormats (
2265 VAImageFormat *format_list, /* out */
2266 unsigned int *flags, /* out */
2267 unsigned int *num_formats /* out */
2271 * Subpictures are created with an image associated.
2273 VAStatus vaCreateSubpicture (
2276 VASubpictureID *subpicture /* out */
2280 * Destroy the subpicture before destroying the image it is assocated to
2282 VAStatus vaDestroySubpicture (
2284 VASubpictureID subpicture
2288 * Bind an image to the subpicture. This image will now be associated with
2289 * the subpicture instead of the one at creation.
2291 VAStatus vaSetSubpictureImage (
2293 VASubpictureID subpicture,
2298 * If chromakey is enabled, then the area where the source value falls within
2299 * the chromakey [min, max] range is transparent
2300 * The chromakey component format is the following:
2301 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2302 * For YUV: [0:7] V [8:15] U [16:23] Y
2303 * The chromakey mask can be used to mask out certain components for chromakey
2306 VAStatus vaSetSubpictureChromakey (
2308 VASubpictureID subpicture,
2309 unsigned int chromakey_min,
2310 unsigned int chromakey_max,
2311 unsigned int chromakey_mask
2315 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2316 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2317 * the overall alpha is per-pixel alpha multiplied by the global alpha
2319 VAStatus vaSetSubpictureGlobalAlpha (
2321 VASubpictureID subpicture,
2326 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2327 * It defines the region mapping between the subpicture and the target
2328 * surfaces through source and destination rectangles (with the same width and height).
2329 * Both will be displayed at the next call to vaPutSurface. Additional
2330 * associations before the call to vaPutSurface simply overrides the association.
2332 VAStatus vaAssociateSubpicture (
2334 VASubpictureID subpicture,
2335 VASurfaceID *target_surfaces,
2337 short src_x, /* upper left offset in subpicture */
2339 unsigned short src_width,
2340 unsigned short src_height,
2341 short dest_x, /* upper left offset in surface */
2343 unsigned short dest_width,
2344 unsigned short dest_height,
2346 * whether to enable chroma-keying, global-alpha, or screen relative mode
2347 * see VA_SUBPICTURE_XXX values
2353 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2355 VAStatus vaDeassociateSubpicture (
2357 VASubpictureID subpicture,
2358 VASurfaceID *target_surfaces,
2362 typedef struct _VARectangle
2366 unsigned short width;
2367 unsigned short height;
2371 * Display attributes
2372 * Display attributes are used to control things such as contrast, hue, saturation,
2373 * brightness etc. in the rendering process. The application can query what
2374 * attributes are supported by the driver, and then set the appropriate attributes
2375 * before calling vaPutSurface()
2377 /* PowerVR IEP Lite attributes */
2380 VADISPLAYATTRIB_BLE_OFF = 0x00,
2381 VADISPLAYATTRIB_BLE_LOW,
2382 VADISPLAYATTRIB_BLE_MEDIUM,
2383 VADISPLAYATTRIB_BLE_HIGH,
2384 VADISPLAYATTRIB_BLE_NONE,
2385 } VADisplayAttribBLEMode;
2387 /** attribute value for VADisplayAttribRotation */
2388 #define VA_ROTATION_NONE 0x00000000
2389 #define VA_ROTATION_90 0x00000001
2390 #define VA_ROTATION_180 0x00000002
2391 #define VA_ROTATION_270 0x00000003
2393 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2394 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2395 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2398 #define VA_RENDER_MODE_UNDEFINED 0
2399 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2400 #define VA_RENDER_MODE_LOCAL_GPU 2
2401 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2402 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2404 /** Render device */
2405 #define VA_RENDER_DEVICE_UNDEFINED 0
2406 #define VA_RENDER_DEVICE_LOCAL 1
2407 #define VA_RENDER_DEVICE_EXTERNAL 2
2409 /** Currently defined display attribute types */
2412 VADisplayAttribBrightness = 0,
2413 VADisplayAttribContrast = 1,
2414 VADisplayAttribHue = 2,
2415 VADisplayAttribSaturation = 3,
2416 /* client can specifiy a background color for the target window
2417 * the new feature of video conference,
2418 * the uncovered area of the surface is filled by this color
2419 * also it will blend with the decoded video color
2421 VADisplayAttribBackgroundColor = 4,
2423 * this is a gettable only attribute. For some implementations that use the
2424 * hardware overlay, after PutSurface is called, the surface can not be
2425 * re-used until after the subsequent PutSurface call. If this is the case
2426 * then the value for this attribute will be set to 1 so that the client
2427 * will not attempt to re-use the surface right after returning from a call
2430 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2431 * driver may use overlay or GPU alternatively
2433 VADisplayAttribDirectSurface = 5,
2434 VADisplayAttribRotation = 6,
2435 VADisplayAttribOutofLoopDeblock = 7,
2437 /* PowerVR IEP Lite specific attributes */
2438 VADisplayAttribBLEBlackMode = 8,
2439 VADisplayAttribBLEWhiteMode = 9,
2440 VADisplayAttribBlueStretch = 10,
2441 VADisplayAttribSkinColorCorrection = 11,
2443 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2444 * conversion matrix. Each element in the matrix is float-point
2446 VADisplayAttribCSCMatrix = 12,
2447 /* specify the constant color used to blend with video surface
2448 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2449 * d: the final color to overwrite into the frame buffer
2450 * v: decoded video after color conversion,
2451 * c: video color specified by VADisplayAttribBlendColor
2452 * b: background color of the drawable
2454 VADisplayAttribBlendColor = 13,
2456 * Indicate driver to skip painting color key or not.
2457 * only applicable if the render is overlay
2459 VADisplayAttribOverlayAutoPaintColorKey = 14,
2461 * customized overlay color key, the format is RGB888
2462 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2464 VADisplayAttribOverlayColorKey = 15,
2466 * The hint for the implementation of vaPutSurface
2467 * normally, the driver could use an overlay or GPU to render the surface on the screen
2468 * this flag provides APP the flexibity to switch the render dynamically
2470 VADisplayAttribRenderMode = 16,
2472 * specify if vaPutSurface needs to render into specified monitors
2473 * one example is that one external monitor (e.g. HDMI) is enabled,
2474 * but the window manager is not aware of it, and there is no associated drawable
2476 VADisplayAttribRenderDevice = 17,
2478 * specify vaPutSurface render area if there is no drawable on the monitor
2480 VADisplayAttribRenderRect = 18,
2481 } VADisplayAttribType;
2483 /* flags for VADisplayAttribute */
2484 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2485 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2486 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2488 typedef struct _VADisplayAttribute
2490 VADisplayAttribType type;
2493 int value; /* used by the set/get attribute functions */
2494 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2496 } VADisplayAttribute;
2498 /** Get maximum number of display attributs supported by the implementation */
2499 int vaMaxNumDisplayAttributes (
2504 * Query display attributes
2505 * The caller must provide a "attr_list" array that can hold at
2506 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2507 * returned in "attr_list" is returned in "num_attributes".
2509 VAStatus vaQueryDisplayAttributes (
2511 VADisplayAttribute *attr_list, /* out */
2512 int *num_attributes /* out */
2516 * Get display attributes
2517 * This function returns the current attribute values in "attr_list".
2518 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2519 * from vaQueryDisplayAttributes() can have their values retrieved.
2521 VAStatus vaGetDisplayAttributes (
2523 VADisplayAttribute *attr_list, /* in/out */
2528 * Set display attributes
2529 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2530 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2531 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2533 VAStatus vaSetDisplayAttributes (
2535 VADisplayAttribute *attr_list,