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".
81 #include <va/va_version.h>
88 * \mainpage Video Acceleration (VA) API
90 * \section intro Introduction
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).
98 * VA-API is split into several modules:
100 * - \ref api_enc_core
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
293 * Currently defined entrypoints
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. */
308 /* Currently defined configuration attribute types */
311 VAConfigAttribRTFormat = 0,
312 VAConfigAttribSpatialResidual = 1,
313 VAConfigAttribSpatialClipping = 2,
314 VAConfigAttribIntraResidual = 3,
315 VAConfigAttribEncryption = 4,
316 VAConfigAttribRateControl = 5,
318 /** @name Attributes for encoding */
321 * \brief Packed headers mode. Read/write.
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.
328 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
330 VAConfigAttribEncPackedHeaders = 10,
332 * \brief Interlaced mode. Read/write.
334 * This attribute determines what kind of interlaced encoding mode
335 * the driver supports.
337 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
339 VAConfigAttribEncInterlaced = 11,
341 * \brief Maximum number of reference frames. Read-only.
343 * This attribute determines the maximum number of reference
344 * frames supported for encoding.
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).
350 VAConfigAttribEncMaxRefFrames = 13,
352 * \brief Maximum number of slices per frame. Read-only.
354 * This attribute determines the maximum number of slices the
355 * driver can support to encode a single frame.
357 VAConfigAttribEncMaxSlices = 14,
359 * \brief Slice structure. Read-only.
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.
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.
371 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
374 VAConfigAttribEncSliceStructure = 15,
376 * \brief Macroblock information. Read-only.
378 * This attribute determines whether the driver supports extra
379 * encoding information per-macroblock. e.g. QP.
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.
386 VAConfigAttribEncMacroblockInfo = 16,
388 VAConfigAttribTypeMax
389 } VAConfigAttribType;
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
397 typedef struct _VAConfigAttrib {
398 VAConfigAttribType type;
399 unsigned int value; /* OR'd flags (bits) for this attribute */
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
414 /** @name Attribute values for VAConfigAttribRateControl */
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
430 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
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
446 /** @name Attribute values for VAConfigAttribEncInterlaced */
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
460 /** @name Attribute values for VAConfigAttribEncSliceStructure */
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
471 * if an attribute is not applicable for a given
472 * profile/entrypoint pair, then set the value to the following
474 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
476 /* Get maximum number of profiles supported by the implementation */
477 int vaMaxNumProfiles (
481 /* Get maximum number of entrypoints supported by the implementation */
482 int vaMaxNumEntrypoints (
486 /* Get maximum number of attributs supported by the implementation */
487 int vaMaxNumConfigAttributes (
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".
497 VAStatus vaQueryConfigProfiles (
499 VAProfile *profile_list, /* out */
500 int *num_profiles /* out */
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".
509 VAStatus vaQueryConfigEntrypoints (
512 VAEntrypoint *entrypoint_list, /* out */
513 int *num_entrypoints /* out */
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
524 VAStatus vaGetConfigAttributes (
527 VAEntrypoint entrypoint,
528 VAConfigAttrib *attrib_list, /* in/out */
532 /* Generic ID type, can be re-typed for specific implementation */
533 typedef unsigned int VAGenericID;
535 typedef VAGenericID VAConfigID;
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.
542 VAStatus vaCreateConfig (
545 VAEntrypoint entrypoint,
546 VAConfigAttrib *attrib_list,
548 VAConfigID *config_id /* out */
552 * Free resources associdated with a given config
554 VAStatus vaDestroyConfig (
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"
567 VAStatus vaQueryConfigAttributes (
569 VAConfigID config_id,
570 VAProfile *profile, /* out */
571 VAEntrypoint *entrypoint, /* out */
572 VAConfigAttrib *attrib_list,/* out */
573 int *num_attribs /* out */
578 * Contexts and Surfaces
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
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
589 * Both contexts and surfaces are identified by unique IDs and its
590 * implementation specific internals are kept opaque to the clients
593 typedef VAGenericID VAContextID;
595 typedef VAGenericID VASurfaceID;
597 #define VA_INVALID_ID 0xffffffff
598 #define VA_INVALID_SURFACE VA_INVALID_ID
600 /** \brief Generic value types. */
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;
608 /** \brief Generic function type. */
609 typedef void (*VAGenericFunc)(void);
611 /** \brief Generic value. */
612 typedef struct _VAGenericValue {
613 /** \brief Value type. See #VAGenericValueType. */
614 VAGenericValueType type;
615 /** \brief Value holder. */
617 /** \brief 32-bit signed integer. */
619 /** \brief 32-bit float. */
621 /** \brief Generic pointer. */
623 /** \brief Pointer to function. */
628 /** @name Surface attribute flags */
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
638 /** \brief Surface attribute types. */
640 VASurfaceAttribNone = 0,
642 * \brief Pixel format (fourcc).
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.
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. */
666 } VASurfaceAttribType;
668 /** \brief Surface attribute. */
669 typedef struct _VASurfaceAttrib {
671 VASurfaceAttribType type;
672 /** \brief Flags. See "Surface attribute flags". */
674 /** \brief Value. See "Surface attribute types" for the expected types. */
675 VAGenericValue value;
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.
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
694 * \brief VASurfaceAttribExternalBuffers structure for
695 * the VASurfaceAttribExternalBufferDescriptor attribute.
697 typedef struct _VASurfaceAttribExternalBuffers {
698 /** \brief pixel format in fourcc. */
699 unsigned int pixel_format;
700 /** \brief width in pixels. */
702 /** \brief height in pixels. */
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". */
718 /** \brief reserved for passing private data */
720 } VASurfaceAttribExternalBuffers;
722 /** @name VASurfaceAttribExternalBuffers flags */
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
738 * \brief Get surface attributes for the supplied config.
740 * This function retrieves the surface attributes matching the supplied
741 * config. The caller shall provide an \c attrib_list with all attributes
742 * to be retrieved. Upon successful return, the attributes in \c attrib_list
743 * are updated with the requested value. Unknown attributes or attributes
744 * that are not supported for the given config will have their \c flags
745 * field set to \c VA_SURFACE_ATTRIB_NOT_SUPPORTED.
747 * @param[in] dpy the VA display
748 * @param[in] config the config identifying a codec or a video
749 * processing pipeline
750 * @param[in,out] attrib_list the list of attributes on input, with at
751 * least \c type fields filled in, and possibly \c value fields whenever
752 * necessary. The updated list of attributes and flags on output
753 * @param[in] num_attribs the number of attributes supplied in the
754 * \c attrib_list array
757 vaGetSurfaceAttributes(
760 VASurfaceAttrib *attrib_list,
761 unsigned int num_attribs
765 * \brief Creates an array of surfaces
767 * Creates an array of surfaces. The optional list of attributes shall
768 * be constructed and verified through vaGetSurfaceAttributes().
770 * @param[in] dpy the VA display
771 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
772 * @param[in] width the surface width
773 * @param[in] height the surface height
774 * @param[out] surfaces the array of newly created surfaces
775 * @param[in] num_surfaces the number of surfaces to create
776 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
777 * @param[in] num_attribs the number of attributes supplied in
778 * \c attrib_list, or zero
786 VASurfaceID *surfaces,
787 unsigned int num_surfaces,
788 VASurfaceAttrib *attrib_list,
789 unsigned int num_attribs
793 * vaDestroySurfaces - Destroy resources associated with surfaces.
794 * Surfaces can only be destroyed after the context associated has been
797 * surfaces: array of surfaces to destroy
798 * num_surfaces: number of surfaces in the array to be destroyed.
800 VAStatus vaDestroySurfaces (
802 VASurfaceID *surfaces,
806 #define VA_PROGRESSIVE 0x1
808 * vaCreateContext - Create a context
810 * config_id: configuration for the context
811 * picture_width: coded picture width
812 * picture_height: coded picture height
813 * flag: any combination of the following:
814 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
815 * render_targets: render targets (surfaces) tied to the context
816 * num_render_targets: number of render targets in the above array
817 * context: created context id upon return
819 VAStatus vaCreateContext (
821 VAConfigID config_id,
825 VASurfaceID *render_targets,
826 int num_render_targets,
827 VAContextID *context /* out */
831 * vaDestroyContext - Destroy a context
833 * context: context to be destroyed
835 VAStatus vaDestroyContext (
842 * Buffers are used to pass various types of data from the
843 * client to the server. The server maintains a data store
844 * for each buffer created, and the client idenfies a buffer
845 * through a unique buffer id assigned by the server.
848 typedef VAGenericID VABufferID;
852 VAPictureParameterBufferType = 0,
853 VAIQMatrixBufferType = 1,
854 VABitPlaneBufferType = 2,
855 VASliceGroupMapBufferType = 3,
856 VASliceParameterBufferType = 4,
857 VASliceDataBufferType = 5,
858 VAMacroblockParameterBufferType = 6,
859 VAResidualDataBufferType = 7,
860 VADeblockingParameterBufferType = 8,
861 VAImageBufferType = 9,
862 VAProtectedSliceDataBufferType = 10,
863 VAQMatrixBufferType = 11,
864 VAHuffmanTableBufferType = 12,
866 /* Following are encode buffer types */
867 VAEncCodedBufferType = 21,
868 VAEncSequenceParameterBufferType = 22,
869 VAEncPictureParameterBufferType = 23,
870 VAEncSliceParameterBufferType = 24,
871 VAEncPackedHeaderParameterBufferType = 25,
872 VAEncPackedHeaderDataBufferType = 26,
873 VAEncMiscParameterBufferType = 27,
874 VAEncMacroblockParameterBufferType = 28,
875 /* Following are video processing buffer types */
877 * \brief Video processing pipeline parameter buffer.
879 * This buffer describes the video processing pipeline. See
880 * #VAProcPipelineParameterBuffer for details.
882 VAProcPipelineParameterBufferType = 41,
884 * \brief Video filter parameter buffer.
886 * This buffer describes the video filter parameters. All buffers
887 * inherit from #VAProcFilterParameterBufferBase, thus including
888 * a unique filter buffer type.
890 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
891 * Filters requiring advanced parameters include, but are not limited to,
892 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
893 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
895 VAProcFilterParameterBufferType = 42,
901 VAEncMiscParameterTypeFrameRate = 0,
902 VAEncMiscParameterTypeRateControl = 1,
903 VAEncMiscParameterTypeMaxSliceSize = 2,
904 VAEncMiscParameterTypeAIR = 3,
905 /** \brief Buffer type used to express a maximum frame size (in bits). */
906 VAEncMiscParameterTypeMaxFrameSize = 4,
907 /** \brief Buffer type used for HRD parameters. */
908 VAEncMiscParameterTypeHRD = 5,
909 } VAEncMiscParameterType;
911 /** \brief Packed header type. */
913 /** \brief Packed sequence header. */
914 VAEncPackedHeaderSequence = 1,
915 /** \brief Packed picture header. */
916 VAEncPackedHeaderPicture = 2,
917 /** \brief Packed slice header. */
918 VAEncPackedHeaderSlice = 3,
920 * \brief Packed raw header.
922 * Packed raw data header can be used by the client to insert a header
923 * into the bitstream data buffer at the point it is passed, the driver
924 * will handle the raw packed header based on "has_emulation_bytes" field
925 * in the packed header parameter structure.
927 VAEncPackedHeaderRawData = 4,
928 /** \brief Misc packed header. See codec-specific definitions. */
929 VAEncPackedHeaderMiscMask = 0x80000000,
930 } VAEncPackedHeaderType;
932 /** \brief Packed header parameter. */
933 typedef struct _VAEncPackedHeaderParameterBuffer {
934 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
936 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
937 unsigned int bit_length;
938 /** \brief Flag: buffer contains start code emulation prevention bytes? */
939 unsigned char has_emulation_bytes;
940 } VAEncPackedHeaderParameterBuffer;
943 * For application, e.g. set a new bitrate
945 * VAEncMiscParameterBuffer *misc_param;
946 * VAEncMiscParameterRateControl *misc_rate_ctrl;
948 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
949 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
952 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
953 * misc_param->type = VAEncMiscParameterTypeRateControl;
954 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
955 * misc_rate_ctrl->bits_per_second = 6400000;
956 * vaUnmapBuffer(dpy, buf_id);
957 * vaRenderPicture(dpy, context, &buf_id, 1);
959 typedef struct _VAEncMiscParameterBuffer
961 VAEncMiscParameterType type;
962 unsigned int data[0];
963 } VAEncMiscParameterBuffer;
966 /** \brief Rate control parameters */
967 typedef struct _VAEncMiscParameterRateControl
969 /* this is the maximum bit-rate to be constrained by the rate control implementation */
970 unsigned int bits_per_second;
971 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
972 * bit-rate for example if target_percentage is 95 then the rate control will target
973 * a bit-rate that is 95% of the maximum bit-rate
975 unsigned int target_percentage;
976 /* windows size in milliseconds. For example if this is set to 500,
977 * then the rate control will guarantee the target bit-rate over a 500 ms window
979 unsigned int window_size;
980 /* initial QP at I frames */
981 unsigned int initial_qp;
983 unsigned int basic_unit_size;
988 unsigned int reset : 1;
989 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
990 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
994 } VAEncMiscParameterRateControl;
996 typedef struct _VAEncMiscParameterFrameRate
998 unsigned int framerate;
999 } VAEncMiscParameterFrameRate;
1002 * Allow a maximum slice size to be specified (in bits).
1003 * The encoder will attempt to make sure that individual slices do not exceed this size
1004 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1006 typedef struct _VAEncMiscParameterMaxSliceSize
1008 unsigned int max_slice_size;
1009 } VAEncMiscParameterMaxSliceSize;
1011 typedef struct _VAEncMiscParameterAIR
1013 unsigned int air_num_mbs;
1014 unsigned int air_threshold;
1015 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1016 } VAEncMiscParameterAIR;
1018 typedef struct _VAEncMiscParameterHRD
1020 unsigned int initial_buffer_fullness; /* in bits */
1021 unsigned int buffer_size; /* in bits */
1022 } VAEncMiscParameterHRD;
1025 * \brief Defines a maximum frame size (in bits).
1027 * This misc parameter buffer defines the maximum size of a frame (in
1028 * bits). The encoder will try to make sure that each frame does not
1029 * exceed this size. Otherwise, if the frame size exceeds this size,
1030 * the \c status flag of #VACodedBufferSegment will contain
1031 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1033 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1034 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1035 VAEncMiscParameterType type;
1036 /** \brief Maximum size of a frame (in bits). */
1037 unsigned int max_frame_size;
1038 } VAEncMiscParameterBufferMaxFrameSize;
1041 * There will be cases where the bitstream buffer will not have enough room to hold
1042 * the data for the entire slice, and the following flags will be used in the slice
1043 * parameter to signal to the server for the possible cases.
1044 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1045 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1046 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1048 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1049 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1050 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1051 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1053 /* Codec-independent Slice Parameter Buffer base */
1054 typedef struct _VASliceParameterBufferBase
1056 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1057 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1058 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1059 } VASliceParameterBufferBase;
1062 /****************************
1063 * JEPG data structure
1064 ***************************/
1065 typedef struct _VAQMatrixBufferJPEG
1067 int load_lum_quantiser_matrix;
1068 int load_chroma_quantiser_matrix;
1069 unsigned char lum_quantiser_matrix[64];
1070 unsigned char chroma_quantiser_matrix[64];
1071 } VAQMatrixBufferJPEG;
1073 typedef struct _VAEncPictureParameterBufferJPEG
1075 VASurfaceID reconstructed_picture;
1076 unsigned short picture_width;
1077 unsigned short picture_height;
1078 VABufferID coded_buf;
1079 } VAEncPictureParameterBufferJPEG;
1081 #include <va/va_dec_jpeg.h>
1083 /****************************
1084 * MPEG-2 data structures
1085 ****************************/
1087 /* MPEG-2 Picture Parameter Buffer */
1089 * For each frame or field, and before any slice data, a single
1090 * picture parameter buffer must be send.
1092 typedef struct _VAPictureParameterBufferMPEG2
1094 unsigned short horizontal_size;
1095 unsigned short vertical_size;
1096 VASurfaceID forward_reference_picture;
1097 VASurfaceID backward_reference_picture;
1098 /* meanings of the following fields are the same as in the standard */
1099 int picture_coding_type;
1100 int f_code; /* pack all four fcode into this */
1103 unsigned int intra_dc_precision : 2;
1104 unsigned int picture_structure : 2;
1105 unsigned int top_field_first : 1;
1106 unsigned int frame_pred_frame_dct : 1;
1107 unsigned int concealment_motion_vectors : 1;
1108 unsigned int q_scale_type : 1;
1109 unsigned int intra_vlc_format : 1;
1110 unsigned int alternate_scan : 1;
1111 unsigned int repeat_first_field : 1;
1112 unsigned int progressive_frame : 1;
1113 unsigned int is_first_field : 1; /* indicate whether the current field
1114 * is the first field for field picture
1118 } picture_coding_extension;
1119 } VAPictureParameterBufferMPEG2;
1121 /* MPEG-2 Inverse Quantization Matrix Buffer */
1122 typedef struct _VAIQMatrixBufferMPEG2
1124 int load_intra_quantiser_matrix;
1125 int load_non_intra_quantiser_matrix;
1126 int load_chroma_intra_quantiser_matrix;
1127 int load_chroma_non_intra_quantiser_matrix;
1128 unsigned char intra_quantiser_matrix[64];
1129 unsigned char non_intra_quantiser_matrix[64];
1130 unsigned char chroma_intra_quantiser_matrix[64];
1131 unsigned char chroma_non_intra_quantiser_matrix[64];
1132 } VAIQMatrixBufferMPEG2;
1134 /* MPEG-2 Slice Parameter Buffer */
1135 typedef struct _VASliceParameterBufferMPEG2
1137 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1138 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1139 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1140 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1141 unsigned int slice_horizontal_position;
1142 unsigned int slice_vertical_position;
1143 int quantiser_scale_code;
1144 int intra_slice_flag;
1145 } VASliceParameterBufferMPEG2;
1147 /* MPEG-2 Macroblock Parameter Buffer */
1148 typedef struct _VAMacroblockParameterBufferMPEG2
1150 unsigned short macroblock_address;
1152 * macroblock_address (in raster scan order)
1154 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1156 unsigned char macroblock_type; /* see definition below */
1159 unsigned int frame_motion_type : 2;
1160 unsigned int field_motion_type : 2;
1161 unsigned int dct_type : 1;
1165 unsigned char motion_vertical_field_select;
1167 * motion_vertical_field_select:
1168 * see section 6.3.17.2 in the spec
1169 * only the lower 4 bits are used
1170 * bit 0: first vector forward
1171 * bit 1: first vector backward
1172 * bit 2: second vector forward
1173 * bit 3: second vector backward
1175 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1176 unsigned short coded_block_pattern;
1178 * The bitplanes for coded_block_pattern are described
1179 * in Figure 6.10-12 in the spec
1182 /* Number of skipped macroblocks after this macroblock */
1183 unsigned short num_skipped_macroblocks;
1184 } VAMacroblockParameterBufferMPEG2;
1187 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1189 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1190 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1191 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1192 #define VA_MB_TYPE_MOTION_INTRA 0x10
1195 * MPEG-2 Residual Data Buffer
1196 * For each macroblock, there wil be 64 shorts (16-bit) in the
1197 * residual data buffer
1200 /****************************
1201 * MPEG-4 Part 2 data structures
1202 ****************************/
1204 /* MPEG-4 Picture Parameter Buffer */
1206 * For each frame or field, and before any slice data, a single
1207 * picture parameter buffer must be send.
1209 typedef struct _VAPictureParameterBufferMPEG4
1211 unsigned short vop_width;
1212 unsigned short vop_height;
1213 VASurfaceID forward_reference_picture;
1214 VASurfaceID backward_reference_picture;
1217 unsigned int short_video_header : 1;
1218 unsigned int chroma_format : 2;
1219 unsigned int interlaced : 1;
1220 unsigned int obmc_disable : 1;
1221 unsigned int sprite_enable : 2;
1222 unsigned int sprite_warping_accuracy : 2;
1223 unsigned int quant_type : 1;
1224 unsigned int quarter_sample : 1;
1225 unsigned int data_partitioned : 1;
1226 unsigned int reversible_vlc : 1;
1227 unsigned int resync_marker_disable : 1;
1231 unsigned char no_of_sprite_warping_points;
1232 short sprite_trajectory_du[3];
1233 short sprite_trajectory_dv[3];
1234 unsigned char quant_precision;
1237 unsigned int vop_coding_type : 2;
1238 unsigned int backward_reference_vop_coding_type : 2;
1239 unsigned int vop_rounding_type : 1;
1240 unsigned int intra_dc_vlc_thr : 3;
1241 unsigned int top_field_first : 1;
1242 unsigned int alternate_vertical_scan_flag : 1;
1246 unsigned char vop_fcode_forward;
1247 unsigned char vop_fcode_backward;
1248 unsigned short vop_time_increment_resolution;
1249 /* short header related */
1250 unsigned char num_gobs_in_vop;
1251 unsigned char num_macroblocks_in_gob;
1252 /* for direct mode prediction */
1255 } VAPictureParameterBufferMPEG4;
1257 /* MPEG-4 Inverse Quantization Matrix Buffer */
1258 typedef struct _VAIQMatrixBufferMPEG4
1260 int load_intra_quant_mat;
1261 int load_non_intra_quant_mat;
1262 unsigned char intra_quant_mat[64];
1263 unsigned char non_intra_quant_mat[64];
1264 } VAIQMatrixBufferMPEG4;
1266 /* MPEG-4 Slice Parameter Buffer */
1267 typedef struct _VASliceParameterBufferMPEG4
1269 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1270 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1271 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1272 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1273 unsigned int macroblock_number;
1275 } VASliceParameterBufferMPEG4;
1278 VC-1 data structures
1281 typedef enum /* see 7.1.1.32 */
1284 VAMvMode1MvHalfPel = 1,
1285 VAMvMode1MvHalfPelBilinear = 2,
1286 VAMvModeMixedMv = 3,
1287 VAMvModeIntensityCompensation = 4
1290 /* VC-1 Picture Parameter Buffer */
1292 * For each picture, and before any slice data, a picture parameter
1293 * buffer must be send. Multiple picture parameter buffers may be
1294 * sent for a single picture. In that case picture parameters will
1295 * apply to all slice data that follow it until a new picture
1296 * parameter buffer is sent.
1299 * pic_quantizer_type should be set to the applicable quantizer
1300 * type as defined by QUANTIZER (J.1.19) and either
1301 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1303 typedef struct _VAPictureParameterBufferVC1
1305 VASurfaceID forward_reference_picture;
1306 VASurfaceID backward_reference_picture;
1307 /* if out-of-loop post-processing is done on the render
1308 target, then we need to keep the in-loop decoded
1309 picture as a reference picture */
1310 VASurfaceID inloop_decoded_picture;
1312 /* sequence layer for AP or meta data for SP and MP */
1315 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1316 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1317 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1318 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1319 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1320 unsigned int multires : 1; /* METADATA::MULTIRES */
1321 unsigned int overlap : 1; /* METADATA::OVERLAP */
1322 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1323 unsigned int rangered : 1; /* METADATA::RANGERED */
1324 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1325 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1330 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1331 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1334 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1335 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1336 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1337 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1340 } entrypoint_fields;
1341 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1342 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1345 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1346 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1347 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1348 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1351 } range_mapping_fields;
1353 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1354 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1355 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1356 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1357 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1358 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1359 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1360 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1361 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1364 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1365 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1366 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1367 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1368 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1374 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1375 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1376 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1377 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1378 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1379 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1380 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1386 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1387 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1388 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1389 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1390 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1391 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1392 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1395 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1398 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1399 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1400 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1401 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1407 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1408 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1409 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1410 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1411 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1412 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1413 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1414 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1415 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1416 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1422 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1423 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1424 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1425 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1426 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1427 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1428 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1429 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1430 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1431 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1432 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1435 } pic_quantizer_fields;
1438 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1439 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1440 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1441 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1442 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1443 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1447 } VAPictureParameterBufferVC1;
1449 /* VC-1 Bitplane Buffer
1450 There will be at most three bitplanes coded in any picture header. To send
1451 the bitplane data more efficiently, each byte is divided in two nibbles, with
1452 each nibble carrying three bitplanes for one macroblock. The following table
1453 shows the bitplane data arrangement within each nibble based on the picture
1456 Picture Type Bit3 Bit2 Bit1 Bit0
1457 I or BI OVERFLAGS ACPRED FIELDTX
1458 P MYTYPEMB SKIPMB DIRECTMB
1459 B FORWARDMB SKIPMB DIRECTMB
1461 Within each byte, the lower nibble is for the first MB and the upper nibble is
1462 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1463 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1464 Macroblock #2 in the first row.
1467 /* VC-1 Slice Parameter Buffer */
1468 typedef struct _VASliceParameterBufferVC1
1470 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1471 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1472 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1473 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1474 unsigned int slice_vertical_position;
1475 } VASliceParameterBufferVC1;
1477 /* VC-1 Slice Data Buffer */
1479 This is simplely a buffer containing raw bit-stream bytes
1482 /****************************
1483 * H.264/AVC data structures
1484 ****************************/
1486 typedef struct _VAPictureH264
1488 VASurfaceID picture_id;
1489 unsigned int frame_idx;
1491 signed int TopFieldOrderCnt;
1492 signed int BottomFieldOrderCnt;
1494 /* flags in VAPictureH264 could be OR of the following */
1495 #define VA_PICTURE_H264_INVALID 0x00000001
1496 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1497 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1498 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1499 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1501 /* H.264 Picture Parameter Buffer */
1503 * For each picture, and before any slice data, a single
1504 * picture parameter buffer must be send.
1506 typedef struct _VAPictureParameterBufferH264
1508 VAPictureH264 CurrPic;
1509 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1510 unsigned short picture_width_in_mbs_minus1;
1511 unsigned short picture_height_in_mbs_minus1;
1512 unsigned char bit_depth_luma_minus8;
1513 unsigned char bit_depth_chroma_minus8;
1514 unsigned char num_ref_frames;
1517 unsigned int chroma_format_idc : 2;
1518 unsigned int residual_colour_transform_flag : 1;
1519 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1520 unsigned int frame_mbs_only_flag : 1;
1521 unsigned int mb_adaptive_frame_field_flag : 1;
1522 unsigned int direct_8x8_inference_flag : 1;
1523 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1524 unsigned int log2_max_frame_num_minus4 : 4;
1525 unsigned int pic_order_cnt_type : 2;
1526 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1527 unsigned int delta_pic_order_always_zero_flag : 1;
1531 unsigned char num_slice_groups_minus1;
1532 unsigned char slice_group_map_type;
1533 unsigned short slice_group_change_rate_minus1;
1534 signed char pic_init_qp_minus26;
1535 signed char pic_init_qs_minus26;
1536 signed char chroma_qp_index_offset;
1537 signed char second_chroma_qp_index_offset;
1540 unsigned int entropy_coding_mode_flag : 1;
1541 unsigned int weighted_pred_flag : 1;
1542 unsigned int weighted_bipred_idc : 2;
1543 unsigned int transform_8x8_mode_flag : 1;
1544 unsigned int field_pic_flag : 1;
1545 unsigned int constrained_intra_pred_flag : 1;
1546 unsigned int pic_order_present_flag : 1;
1547 unsigned int deblocking_filter_control_present_flag : 1;
1548 unsigned int redundant_pic_cnt_present_flag : 1;
1549 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1553 unsigned short frame_num;
1554 } VAPictureParameterBufferH264;
1556 /* H.264 Inverse Quantization Matrix Buffer */
1557 typedef struct _VAIQMatrixBufferH264
1559 unsigned char ScalingList4x4[6][16];
1560 unsigned char ScalingList8x8[2][64];
1561 } VAIQMatrixBufferH264;
1564 * H.264 Slice Group Map Buffer
1565 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1566 * A slice group map buffer should be sent for each picture if required. The buffer
1567 * is sent only when there is a change in the mapping values.
1568 * The slice group map buffer map "map units" to slice groups as specified in
1569 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1570 * in raster scan order
1573 /* H.264 Slice Parameter Buffer */
1574 typedef struct _VASliceParameterBufferH264
1576 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1577 /** \brief Byte offset to the NAL Header Unit for this slice. */
1578 unsigned int slice_data_offset;
1579 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1581 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1583 * This bit offset is relative to and includes the NAL unit byte
1584 * and represents the number of bits parsed in the slice_header()
1585 * after the removal of any emulation prevention bytes in
1586 * there. However, the slice data buffer passed to the hardware is
1587 * the original bitstream, thus including any emulation prevention
1590 unsigned short slice_data_bit_offset;
1591 unsigned short first_mb_in_slice;
1592 unsigned char slice_type;
1593 unsigned char direct_spatial_mv_pred_flag;
1594 unsigned char num_ref_idx_l0_active_minus1;
1595 unsigned char num_ref_idx_l1_active_minus1;
1596 unsigned char cabac_init_idc;
1597 char slice_qp_delta;
1598 unsigned char disable_deblocking_filter_idc;
1599 char slice_alpha_c0_offset_div2;
1600 char slice_beta_offset_div2;
1601 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1602 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1603 unsigned char luma_log2_weight_denom;
1604 unsigned char chroma_log2_weight_denom;
1605 unsigned char luma_weight_l0_flag;
1606 short luma_weight_l0[32];
1607 short luma_offset_l0[32];
1608 unsigned char chroma_weight_l0_flag;
1609 short chroma_weight_l0[32][2];
1610 short chroma_offset_l0[32][2];
1611 unsigned char luma_weight_l1_flag;
1612 short luma_weight_l1[32];
1613 short luma_offset_l1[32];
1614 unsigned char chroma_weight_l1_flag;
1615 short chroma_weight_l1[32][2];
1616 short chroma_offset_l1[32][2];
1617 } VASliceParameterBufferH264;
1619 /****************************
1620 * Common encode data structures
1621 ****************************/
1624 VAEncPictureTypeIntra = 0,
1625 VAEncPictureTypePredictive = 1,
1626 VAEncPictureTypeBidirectional = 2,
1629 /* Encode Slice Parameter Buffer */
1630 typedef struct _VAEncSliceParameterBuffer
1632 unsigned int start_row_number; /* starting MB row number for this slice */
1633 unsigned int slice_height; /* slice height measured in MB */
1636 unsigned int is_intra : 1;
1637 unsigned int disable_deblocking_filter_idc : 2;
1638 unsigned int uses_long_term_ref :1;
1639 unsigned int is_long_term_ref :1;
1643 } VAEncSliceParameterBuffer;
1646 /****************************
1647 * H.263 specific encode data structures
1648 ****************************/
1650 typedef struct _VAEncSequenceParameterBufferH263
1652 unsigned int intra_period;
1653 unsigned int bits_per_second;
1654 unsigned int frame_rate;
1655 unsigned int initial_qp;
1656 unsigned int min_qp;
1657 } VAEncSequenceParameterBufferH263;
1659 typedef struct _VAEncPictureParameterBufferH263
1661 VASurfaceID reference_picture;
1662 VASurfaceID reconstructed_picture;
1663 VABufferID coded_buf;
1664 unsigned short picture_width;
1665 unsigned short picture_height;
1666 VAEncPictureType picture_type;
1667 } VAEncPictureParameterBufferH263;
1669 /****************************
1670 * MPEG-4 specific encode data structures
1671 ****************************/
1673 typedef struct _VAEncSequenceParameterBufferMPEG4
1675 unsigned char profile_and_level_indication;
1676 unsigned int intra_period;
1677 unsigned int video_object_layer_width;
1678 unsigned int video_object_layer_height;
1679 unsigned int vop_time_increment_resolution;
1680 unsigned int fixed_vop_rate;
1681 unsigned int fixed_vop_time_increment;
1682 unsigned int bits_per_second;
1683 unsigned int frame_rate;
1684 unsigned int initial_qp;
1685 unsigned int min_qp;
1686 } VAEncSequenceParameterBufferMPEG4;
1688 typedef struct _VAEncPictureParameterBufferMPEG4
1690 VASurfaceID reference_picture;
1691 VASurfaceID reconstructed_picture;
1692 VABufferID coded_buf;
1693 unsigned short picture_width;
1694 unsigned short picture_height;
1695 unsigned int modulo_time_base; /* number of 1s */
1696 unsigned int vop_time_increment;
1697 VAEncPictureType picture_type;
1698 } VAEncPictureParameterBufferMPEG4;
1702 /* Buffer functions */
1705 * Creates a buffer for "num_elements" elements of "size" bytes and
1706 * initalize with "data".
1707 * if "data" is null, then the contents of the buffer data store
1709 * Basically there are two ways to get buffer data to the server side. One is
1710 * to call vaCreateBuffer() with a non-null "data", which results the data being
1711 * copied to the data store on the server side. A different method that
1712 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1713 * and then use vaMapBuffer() to map the data store from the server side to the
1714 * client address space for access.
1715 * Note: image buffers are created by the library, not the client. Please see
1716 * vaCreateImage on how image buffers are managed.
1718 VAStatus vaCreateBuffer (
1720 VAContextID context,
1721 VABufferType type, /* in */
1722 unsigned int size, /* in */
1723 unsigned int num_elements, /* in */
1724 void *data, /* in */
1725 VABufferID *buf_id /* out */
1729 * Convey to the server how many valid elements are in the buffer.
1730 * e.g. if multiple slice parameters are being held in a single buffer,
1731 * this will communicate to the server the number of slice parameters
1732 * that are valid in the buffer.
1734 VAStatus vaBufferSetNumElements (
1736 VABufferID buf_id, /* in */
1737 unsigned int num_elements /* in */
1742 * device independent data structure for codedbuffer
1746 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1747 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1748 * enough for the encoder to attempt to limit its size.
1749 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1750 * exceeded the maximum slice size specified.
1751 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1752 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1753 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1755 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1756 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1757 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1758 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1759 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1761 * \brief The frame has exceeded the maximum requested size.
1763 * This flag indicates that the encoded frame size exceeds the value
1764 * specified through a misc parameter buffer of type
1765 * #VAEncMiscParameterTypeMaxFrameSize.
1767 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1768 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1771 * \brief The coded buffer segment contains a single NAL unit.
1773 * This flag indicates that the coded buffer segment contains a
1774 * single NAL unit. This flag might be useful to the user for
1775 * processing the coded buffer.
1777 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1780 * \brief Coded buffer segment.
1782 * #VACodedBufferSegment is an element of a linked list describing
1783 * some information on the coded buffer. The coded buffer segment
1784 * could contain either a single NAL unit, or more than one NAL unit.
1785 * It is recommended (but not required) to return a single NAL unit
1786 * in a coded buffer segment, and the implementation should set the
1787 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1789 typedef struct _VACodedBufferSegment {
1791 * \brief Size of the data buffer in this segment (in bytes).
1794 /** \brief Bit offset into the data buffer where the video data starts. */
1795 unsigned int bit_offset;
1796 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1797 unsigned int status;
1798 /** \brief Reserved for future use. */
1799 unsigned int reserved;
1800 /** \brief Pointer to the start of the data buffer. */
1803 * \brief Pointer to the next #VACodedBufferSegment element,
1804 * or \c NULL if there is none.
1807 } VACodedBufferSegment;
1810 * Map data store of the buffer into the client's address space
1811 * vaCreateBuffer() needs to be called with "data" set to NULL before
1812 * calling vaMapBuffer()
1814 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1815 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1817 VAStatus vaMapBuffer (
1819 VABufferID buf_id, /* in */
1820 void **pbuf /* out */
1824 * After client making changes to a mapped data store, it needs to
1825 * "Unmap" it to let the server know that the data is ready to be
1826 * consumed by the server
1828 VAStatus vaUnmapBuffer (
1830 VABufferID buf_id /* in */
1834 * After this call, the buffer is deleted and this buffer_id is no longer valid
1835 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1837 VAStatus vaDestroyBuffer (
1839 VABufferID buffer_id
1843 Render (Decode) Pictures
1845 A picture represents either a frame or a field.
1847 The Begin/Render/End sequence sends the decode buffers to the server
1851 * Get ready to decode a picture to a target surface
1853 VAStatus vaBeginPicture (
1855 VAContextID context,
1856 VASurfaceID render_target
1860 * Send decode buffers to the server.
1861 * Buffers are automatically destroyed afterwards
1863 VAStatus vaRenderPicture (
1865 VAContextID context,
1866 VABufferID *buffers,
1871 * Make the end of rendering for a picture.
1872 * The server should start processing all pending operations for this
1873 * surface. This call is non-blocking. The client can start another
1874 * Begin/Render/End sequence on a different render target.
1876 VAStatus vaEndPicture (
1888 * This function blocks until all pending operations on the render target
1889 * have been completed. Upon return it is safe to use the render target for a
1890 * different picture.
1892 VAStatus vaSyncSurface (
1894 VASurfaceID render_target
1899 VASurfaceRendering = 1, /* Rendering in progress */
1900 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1901 /* this status is useful if surface is used as the source */
1903 VASurfaceReady = 4, /* not being rendered or displayed */
1904 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1908 * Find out any pending ops on the render target
1910 VAStatus vaQuerySurfaceStatus (
1912 VASurfaceID render_target,
1913 VASurfaceStatus *status /* out */
1918 VADecodeSliceMissing = 0,
1919 VADecodeMBError = 1,
1920 } VADecodeErrorType;
1923 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1924 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1926 typedef struct _VASurfaceDecodeMBErrors
1928 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1929 unsigned int start_mb; /* start mb address with errors */
1930 unsigned int end_mb; /* end mb address with errors */
1931 VADecodeErrorType decode_error_type;
1932 } VASurfaceDecodeMBErrors;
1935 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1936 * it can call vaQuerySurfaceError to find out further details on the particular error.
1937 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1938 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1939 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1940 * The array is terminated if "status==-1" is detected.
1942 VAStatus vaQuerySurfaceError(
1944 VASurfaceID surface,
1945 VAStatus error_status,
1950 * Images and Subpictures
1951 * VAImage is used to either get the surface data to client memory, or
1952 * to copy image data in client memory to a surface.
1953 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1954 * is at the upper left corner with positive X to the right and positive Y down
1956 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1957 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1958 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1961 * Pre-defined fourcc codes
1963 #define VA_FOURCC_NV12 0x3231564E
1964 #define VA_FOURCC_AI44 0x34344149
1965 #define VA_FOURCC_RGBA 0x41424752
1966 #define VA_FOURCC_RGBX 0x58424752
1967 #define VA_FOURCC_BGRA 0x41524742
1968 #define VA_FOURCC_BGRX 0x58524742
1969 #define VA_FOURCC_ARGB 0x42475241
1970 #define VA_FOURCC_XRGB 0x42475258
1971 #define VA_FOURCC_UYVY 0x59565955
1972 #define VA_FOURCC_YUY2 0x32595559
1973 #define VA_FOURCC_AYUV 0x56555941
1974 #define VA_FOURCC_NV11 0x3131564e
1975 #define VA_FOURCC_YV12 0x32315659
1976 #define VA_FOURCC_P208 0x38303250
1977 #define VA_FOURCC_IYUV 0x56555949
1978 #define VA_FOURCC_YV24 0x34325659
1979 #define VA_FOURCC_YV32 0x32335659
1980 #define VA_FOURCC_Y800 0x30303859
1981 #define VA_FOURCC_IMC3 0x33434D49
1982 #define VA_FOURCC_411P 0x50313134
1983 #define VA_FOURCC_422H 0x48323234
1984 #define VA_FOURCC_422V 0x56323234
1985 #define VA_FOURCC_444P 0x50343434
1986 #define VA_FOURCC_RGBP 0x50424752
1987 #define VA_FOURCC_BGRP 0x50524742
1988 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
1991 #define VA_LSB_FIRST 1
1992 #define VA_MSB_FIRST 2
1994 typedef struct _VAImageFormat
1996 unsigned int fourcc;
1997 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1998 unsigned int bits_per_pixel;
1999 /* for RGB formats */
2000 unsigned int depth; /* significant bits per pixel */
2001 unsigned int red_mask;
2002 unsigned int green_mask;
2003 unsigned int blue_mask;
2004 unsigned int alpha_mask;
2007 typedef VAGenericID VAImageID;
2009 typedef struct _VAImage
2011 VAImageID image_id; /* uniquely identify this image */
2012 VAImageFormat format;
2013 VABufferID buf; /* image data buffer */
2015 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2016 * data store on the server side for optimal performance. The buffer will be
2017 * created by the CreateImage function, and proper storage allocated based on the image
2018 * size and format. This buffer is managed by the library implementation, and
2019 * accessed by the client through the buffer Map/Unmap functions.
2021 unsigned short width;
2022 unsigned short height;
2023 unsigned int data_size;
2024 unsigned int num_planes; /* can not be greater than 3 */
2026 * An array indicating the scanline pitch in bytes for each plane.
2027 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2029 unsigned int pitches[3];
2031 * An array indicating the byte offset from the beginning of the image data
2032 * to the start of each plane.
2034 unsigned int offsets[3];
2036 /* The following fields are only needed for paletted formats */
2037 int num_palette_entries; /* set to zero for non-palette images */
2039 * Each component is one byte and entry_bytes indicates the number of components in
2040 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2044 * An array of ascii characters describing the order of the components within the bytes.
2045 * Only entry_bytes characters of the string are used.
2047 char component_order[4];
2050 /* Get maximum number of image formats supported by the implementation */
2051 int vaMaxNumImageFormats (
2056 * Query supported image formats
2057 * The caller must provide a "format_list" array that can hold at
2058 * least vaMaxNumImageFormats() entries. The actual number of formats
2059 * returned in "format_list" is returned in "num_formats".
2061 VAStatus vaQueryImageFormats (
2063 VAImageFormat *format_list, /* out */
2064 int *num_formats /* out */
2068 * Create a VAImage structure
2069 * The width and height fields returned in the VAImage structure may get
2070 * enlarged for some YUV formats. Upon return from this function,
2071 * image->buf has been created and proper storage allocated by the library.
2072 * The client can access the image through the Map/Unmap calls.
2074 VAStatus vaCreateImage (
2076 VAImageFormat *format,
2079 VAImage *image /* out */
2083 * Should call DestroyImage before destroying the surface it is bound to
2085 VAStatus vaDestroyImage (
2090 VAStatus vaSetImagePalette (
2094 * pointer to an array holding the palette data. The size of the array is
2095 * num_palette_entries * entry_bytes in size. The order of the components
2096 * in the palette is described by the component_order in VAImage struct
2098 unsigned char *palette
2102 * Retrive surface data into a VAImage
2103 * Image must be in a format supported by the implementation
2105 VAStatus vaGetImage (
2107 VASurfaceID surface,
2108 int x, /* coordinates of the upper left source pixel */
2110 unsigned int width, /* width and height of the region */
2111 unsigned int height,
2116 * Copy data from a VAImage to a surface
2117 * Image must be in a format supported by the implementation
2118 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2119 * shouldn't be rendered into when this is called
2121 VAStatus vaPutImage (
2123 VASurfaceID surface,
2127 unsigned int src_width,
2128 unsigned int src_height,
2131 unsigned int dest_width,
2132 unsigned int dest_height
2136 * Derive an VAImage from an existing surface.
2137 * This interface will derive a VAImage and corresponding image buffer from
2138 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2139 * direct CPU access. This operation is only possible on implementations with
2140 * direct rendering capabilities and internal surface formats that can be
2141 * represented with a VAImage. When the operation is not possible this interface
2142 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2143 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2146 * Implementations should only return success when the resulting image buffer
2147 * would be useable with vaMap/Unmap.
2149 * When directly accessing a surface special care must be taken to insure
2150 * proper synchronization with the graphics hardware. Clients should call
2151 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2152 * rendering or currently being displayed by an overlay.
2154 * Additionally nothing about the contents of a surface should be assumed
2155 * following a vaPutSurface. Implementations are free to modify the surface for
2156 * scaling or subpicture blending within a call to vaPutImage.
2158 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2159 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2160 * vaGetImage with other surfaces is supported.
2162 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2163 * image and image buffer structures will be destroyed; however, the underlying
2164 * surface will remain unchanged until freed with vaDestroySurfaces.
2166 VAStatus vaDeriveImage (
2168 VASurfaceID surface,
2169 VAImage *image /* out */
2174 * Subpicture is a special type of image that can be blended
2175 * with a surface during vaPutSurface(). Subpicture can be used to render
2176 * DVD sub-titles or closed captioning text etc.
2179 typedef VAGenericID VASubpictureID;
2181 /* Get maximum number of subpicture formats supported by the implementation */
2182 int vaMaxNumSubpictureFormats (
2186 /* flags for subpictures */
2187 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2188 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2189 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2191 * Query supported subpicture formats
2192 * The caller must provide a "format_list" array that can hold at
2193 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2194 * for each format to indicate additional capabilities for that format. The actual
2195 * number of formats returned in "format_list" is returned in "num_formats".
2196 * flags: returned value to indicate addtional capabilities
2197 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2198 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2199 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2202 VAStatus vaQuerySubpictureFormats (
2204 VAImageFormat *format_list, /* out */
2205 unsigned int *flags, /* out */
2206 unsigned int *num_formats /* out */
2210 * Subpictures are created with an image associated.
2212 VAStatus vaCreateSubpicture (
2215 VASubpictureID *subpicture /* out */
2219 * Destroy the subpicture before destroying the image it is assocated to
2221 VAStatus vaDestroySubpicture (
2223 VASubpictureID subpicture
2227 * Bind an image to the subpicture. This image will now be associated with
2228 * the subpicture instead of the one at creation.
2230 VAStatus vaSetSubpictureImage (
2232 VASubpictureID subpicture,
2237 * If chromakey is enabled, then the area where the source value falls within
2238 * the chromakey [min, max] range is transparent
2239 * The chromakey component format is the following:
2240 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2241 * For YUV: [0:7] V [8:15] U [16:23] Y
2242 * The chromakey mask can be used to mask out certain components for chromakey
2245 VAStatus vaSetSubpictureChromakey (
2247 VASubpictureID subpicture,
2248 unsigned int chromakey_min,
2249 unsigned int chromakey_max,
2250 unsigned int chromakey_mask
2254 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2255 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2256 * the overall alpha is per-pixel alpha multiplied by the global alpha
2258 VAStatus vaSetSubpictureGlobalAlpha (
2260 VASubpictureID subpicture,
2265 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2266 * It defines the region mapping between the subpicture and the target
2267 * surfaces through source and destination rectangles (with the same width and height).
2268 * Both will be displayed at the next call to vaPutSurface. Additional
2269 * associations before the call to vaPutSurface simply overrides the association.
2271 VAStatus vaAssociateSubpicture (
2273 VASubpictureID subpicture,
2274 VASurfaceID *target_surfaces,
2276 short src_x, /* upper left offset in subpicture */
2278 unsigned short src_width,
2279 unsigned short src_height,
2280 short dest_x, /* upper left offset in surface */
2282 unsigned short dest_width,
2283 unsigned short dest_height,
2285 * whether to enable chroma-keying, global-alpha, or screen relative mode
2286 * see VA_SUBPICTURE_XXX values
2292 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2294 VAStatus vaDeassociateSubpicture (
2296 VASubpictureID subpicture,
2297 VASurfaceID *target_surfaces,
2301 typedef struct _VARectangle
2305 unsigned short width;
2306 unsigned short height;
2310 * Display attributes
2311 * Display attributes are used to control things such as contrast, hue, saturation,
2312 * brightness etc. in the rendering process. The application can query what
2313 * attributes are supported by the driver, and then set the appropriate attributes
2314 * before calling vaPutSurface()
2316 /* PowerVR IEP Lite attributes */
2319 VADISPLAYATTRIB_BLE_OFF = 0x00,
2320 VADISPLAYATTRIB_BLE_LOW,
2321 VADISPLAYATTRIB_BLE_MEDIUM,
2322 VADISPLAYATTRIB_BLE_HIGH,
2323 VADISPLAYATTRIB_BLE_NONE,
2324 } VADisplayAttribBLEMode;
2326 /* attribute value for VADisplayAttribRotation */
2327 #define VA_ROTATION_NONE 0x00000000
2328 #define VA_ROTATION_90 0x00000001
2329 #define VA_ROTATION_180 0x00000002
2330 #define VA_ROTATION_270 0x00000003
2332 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2333 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2334 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2337 #define VA_RENDER_MODE_UNDEFINED 0
2338 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2339 #define VA_RENDER_MODE_LOCAL_GPU 2
2340 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2341 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2344 #define VA_RENDER_DEVICE_UNDEFINED 0
2345 #define VA_RENDER_DEVICE_LOCAL 1
2346 #define VA_RENDER_DEVICE_EXTERNAL 2
2348 /* Currently defined display attribute types */
2351 VADisplayAttribBrightness = 0,
2352 VADisplayAttribContrast = 1,
2353 VADisplayAttribHue = 2,
2354 VADisplayAttribSaturation = 3,
2355 /* client can specifiy a background color for the target window
2356 * the new feature of video conference,
2357 * the uncovered area of the surface is filled by this color
2358 * also it will blend with the decoded video color
2360 VADisplayAttribBackgroundColor = 4,
2362 * this is a gettable only attribute. For some implementations that use the
2363 * hardware overlay, after PutSurface is called, the surface can not be
2364 * re-used until after the subsequent PutSurface call. If this is the case
2365 * then the value for this attribute will be set to 1 so that the client
2366 * will not attempt to re-use the surface right after returning from a call
2369 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2370 * driver may use overlay or GPU alternatively
2372 VADisplayAttribDirectSurface = 5,
2373 VADisplayAttribRotation = 6,
2374 VADisplayAttribOutofLoopDeblock = 7,
2376 /* PowerVR IEP Lite specific attributes */
2377 VADisplayAttribBLEBlackMode = 8,
2378 VADisplayAttribBLEWhiteMode = 9,
2379 VADisplayAttribBlueStretch = 10,
2380 VADisplayAttribSkinColorCorrection = 11,
2382 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2383 * conversion matrix. Each element in the matrix is float-point
2385 VADisplayAttribCSCMatrix = 12,
2386 /* specify the constant color used to blend with video surface
2387 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2388 * d: the final color to overwrite into the frame buffer
2389 * v: decoded video after color conversion,
2390 * c: video color specified by VADisplayAttribBlendColor
2391 * b: background color of the drawable
2393 VADisplayAttribBlendColor = 13,
2395 * Indicate driver to skip painting color key or not.
2396 * only applicable if the render is overlay
2398 VADisplayAttribOverlayAutoPaintColorKey = 14,
2400 * customized overlay color key, the format is RGB888
2401 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2403 VADisplayAttribOverlayColorKey = 15,
2405 * The hint for the implementation of vaPutSurface
2406 * normally, the driver could use an overlay or GPU to render the surface on the screen
2407 * this flag provides APP the flexibity to switch the render dynamically
2409 VADisplayAttribRenderMode = 16,
2411 * specify if vaPutSurface needs to render into specified monitors
2412 * one example is that one external monitor (e.g. HDMI) is enabled,
2413 * but the window manager is not aware of it, and there is no associated drawable
2415 VADisplayAttribRenderDevice = 17,
2417 * specify vaPutSurface render area if there is no drawable on the monitor
2419 VADisplayAttribRenderRect = 18,
2420 } VADisplayAttribType;
2422 /* flags for VADisplayAttribute */
2423 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2424 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2425 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2427 typedef struct _VADisplayAttribute
2429 VADisplayAttribType type;
2432 int value; /* used by the set/get attribute functions */
2433 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2435 } VADisplayAttribute;
2437 /* Get maximum number of display attributs supported by the implementation */
2438 int vaMaxNumDisplayAttributes (
2443 * Query display attributes
2444 * The caller must provide a "attr_list" array that can hold at
2445 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2446 * returned in "attr_list" is returned in "num_attributes".
2448 VAStatus vaQueryDisplayAttributes (
2450 VADisplayAttribute *attr_list, /* out */
2451 int *num_attributes /* out */
2455 * Get display attributes
2456 * This function returns the current attribute values in "attr_list".
2457 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2458 * from vaQueryDisplayAttributes() can have their values retrieved.
2460 VAStatus vaGetDisplayAttributes (
2462 VADisplayAttribute *attr_list, /* in/out */
2467 * Set display attributes
2468 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2469 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2470 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2472 VAStatus vaSetDisplayAttributes (
2474 VADisplayAttribute *attr_list,