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,
290 VAProfileVP8Version0_3 = 14
294 * Currently defined entrypoints
300 VAEntrypointIDCT = 3,
301 VAEntrypointMoComp = 4,
302 VAEntrypointDeblocking = 5,
303 VAEntrypointEncSlice = 6, /* slice level encode */
304 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
305 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
309 /* Currently defined configuration attribute types */
312 VAConfigAttribRTFormat = 0,
313 VAConfigAttribSpatialResidual = 1,
314 VAConfigAttribSpatialClipping = 2,
315 VAConfigAttribIntraResidual = 3,
316 VAConfigAttribEncryption = 4,
317 VAConfigAttribRateControl = 5,
319 /** @name Attributes for encoding */
322 * \brief Packed headers mode. Read/write.
324 * This attribute determines what packed headers the driver supports,
325 * through vaGetConfigAttributes(); and what packed headers the user
326 * will be providing to the driver, through vaCreateConfig(), if the
327 * driver supports those.
329 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
331 VAConfigAttribEncPackedHeaders = 10,
333 * \brief Interlaced mode. Read/write.
335 * This attribute determines what kind of interlaced encoding mode
336 * the driver supports.
338 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
340 VAConfigAttribEncInterlaced = 11,
342 * \brief Maximum number of reference frames. Read-only.
344 * This attribute determines the maximum number of reference
345 * frames supported for encoding.
347 * Note: for H.264 encoding, the value represents the maximum number
348 * of reference frames for both the reference picture list 0 (bottom
349 * 16 bits) and the reference picture list 1 (top 16 bits).
351 VAConfigAttribEncMaxRefFrames = 13,
353 * \brief Maximum number of slices per frame. Read-only.
355 * This attribute determines the maximum number of slices the
356 * driver can support to encode a single frame.
358 VAConfigAttribEncMaxSlices = 14,
360 * \brief Slice structure. Read-only.
362 * This attribute determines slice structures supported by the
363 * driver for encoding. This attribute is a hint to the user so
364 * that he can choose a suitable surface size and how to arrange
365 * the encoding process of multiple slices per frame.
367 * More specifically, for H.264 encoding, this attribute
368 * determines the range of accepted values to
369 * VAEncSliceParameterBufferH264::macroblock_address and
370 * VAEncSliceParameterBufferH264::num_macroblocks.
372 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
375 VAConfigAttribEncSliceStructure = 15,
377 * \brief Macroblock information. Read-only.
379 * This attribute determines whether the driver supports extra
380 * encoding information per-macroblock. e.g. QP.
382 * More specifically, for H.264 encoding, if the driver returns a non-zero
383 * value for this attribute, this means the application can create
384 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
385 * through VAEncSliceParameterBufferH264::macroblock_info.
387 VAConfigAttribEncMacroblockInfo = 16,
389 VAConfigAttribTypeMax
390 } VAConfigAttribType;
393 * Configuration attributes
394 * If there is more than one value for an attribute, a default
395 * value will be assigned to the attribute if the client does not
396 * specify the attribute when creating a configuration
398 typedef struct _VAConfigAttrib {
399 VAConfigAttribType type;
400 unsigned int value; /* OR'd flags (bits) for this attribute */
403 /* attribute value for VAConfigAttribRTFormat */
404 #define VA_RT_FORMAT_YUV420 0x00000001
405 #define VA_RT_FORMAT_YUV422 0x00000002
406 #define VA_RT_FORMAT_YUV444 0x00000004
407 #define VA_RT_FORMAT_YUV411 0x00000008
408 #define VA_RT_FORMAT_YUV400 0x00000010
409 #define VA_RT_FORMAT_RGB16 0x00010000
410 #define VA_RT_FORMAT_RGB32 0x00020000
411 /* RGBP covers RGBP and BGRP fourcc */
412 #define VA_RT_FORMAT_RGBP 0x00100000
413 #define VA_RT_FORMAT_PROTECTED 0x80000000
415 /** @name Attribute values for VAConfigAttribRateControl */
417 /** \brief Driver does not support any form of rate control. */
418 #define VA_RC_NONE 0x00000001
419 /** \brief Constant bitrate. */
420 #define VA_RC_CBR 0x00000002
421 /** \brief Variable bitrate. */
422 #define VA_RC_VBR 0x00000004
423 /** \brief Video conference mode. */
424 #define VA_RC_VCM 0x00000008
425 /** \brief Constant QP. */
426 #define VA_RC_CQP 0x00000010
427 /** \brief Variable bitrate with peak rate higher than average bitrate. */
428 #define VA_RC_VBR_CONSTRAINED 0x00000020
431 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
433 /** \brief Driver does not support any packed headers mode. */
434 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
435 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
436 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
437 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
438 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
439 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
440 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
441 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
442 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
443 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
444 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x0000000C
447 /** @name Attribute values for VAConfigAttribEncInterlaced */
449 /** \brief Driver does not support interlaced coding. */
450 #define VA_ENC_INTERLACED_NONE 0x00000000
451 /** \brief Driver supports interlaced frame coding. */
452 #define VA_ENC_INTERLACED_FRAME 0x00000001
453 /** \brief Driver supports interlaced field coding. */
454 #define VA_ENC_INTERLACED_FIELD 0x00000002
455 /** \brief Driver supports macroblock adaptive frame field coding. */
456 #define VA_ENC_INTERLACED_MBAFF 0x00000004
457 /** \brief Driver supports picture adaptive frame field coding. */
458 #define VA_ENC_INTERLACED_PAFF 0x00000008
461 /** @name Attribute values for VAConfigAttribEncSliceStructure */
463 /** \brief Driver supports an arbitrary number of rows per slice. */
464 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
465 /** \brief Driver supports a power-of-two number of rows per slice. */
466 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
467 /** \brief Driver supports an arbitrary number of rows per slice. */
468 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
472 * if an attribute is not applicable for a given
473 * profile/entrypoint pair, then set the value to the following
475 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
477 /* Get maximum number of profiles supported by the implementation */
478 int vaMaxNumProfiles (
482 /* Get maximum number of entrypoints supported by the implementation */
483 int vaMaxNumEntrypoints (
487 /* Get maximum number of attributs supported by the implementation */
488 int vaMaxNumConfigAttributes (
493 * Query supported profiles
494 * The caller must provide a "profile_list" array that can hold at
495 * least vaMaxNumProfile() entries. The actual number of profiles
496 * returned in "profile_list" is returned in "num_profile".
498 VAStatus vaQueryConfigProfiles (
500 VAProfile *profile_list, /* out */
501 int *num_profiles /* out */
505 * Query supported entrypoints for a given profile
506 * The caller must provide an "entrypoint_list" array that can hold at
507 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
508 * returned in "entrypoint_list" is returned in "num_entrypoints".
510 VAStatus vaQueryConfigEntrypoints (
513 VAEntrypoint *entrypoint_list, /* out */
514 int *num_entrypoints /* out */
518 * Get attributes for a given profile/entrypoint pair
519 * The caller must provide an "attrib_list" with all attributes to be
520 * retrieved. Upon return, the attributes in "attrib_list" have been
521 * updated with their value. Unknown attributes or attributes that are
522 * not supported for the given profile/entrypoint pair will have their
523 * value set to VA_ATTRIB_NOT_SUPPORTED
525 VAStatus vaGetConfigAttributes (
528 VAEntrypoint entrypoint,
529 VAConfigAttrib *attrib_list, /* in/out */
533 /* Generic ID type, can be re-typed for specific implementation */
534 typedef unsigned int VAGenericID;
536 typedef VAGenericID VAConfigID;
539 * Create a configuration for the decode pipeline
540 * it passes in the attribute list that specifies the attributes it cares
541 * about, with the rest taking default values.
543 VAStatus vaCreateConfig (
546 VAEntrypoint entrypoint,
547 VAConfigAttrib *attrib_list,
549 VAConfigID *config_id /* out */
553 * Free resources associdated with a given config
555 VAStatus vaDestroyConfig (
561 * Query all attributes for a given configuration
562 * The profile of the configuration is returned in "profile"
563 * The entrypoint of the configuration is returned in "entrypoint"
564 * The caller must provide an "attrib_list" array that can hold at least
565 * vaMaxNumConfigAttributes() entries. The actual number of attributes
566 * returned in "attrib_list" is returned in "num_attribs"
568 VAStatus vaQueryConfigAttributes (
570 VAConfigID config_id,
571 VAProfile *profile, /* out */
572 VAEntrypoint *entrypoint, /* out */
573 VAConfigAttrib *attrib_list,/* out */
574 int *num_attribs /* out */
579 * Contexts and Surfaces
581 * Context represents a "virtual" video decode pipeline. Surfaces are render
582 * targets for a given context. The data in the surfaces are not accessible
583 * to the client and the internal data format of the surface is implementatin
586 * Surfaces will be bound to a context when the context is created. Once
587 * a surface is bound to a given context, it can not be used to create
588 * another context. The association is removed when the context is destroyed
590 * Both contexts and surfaces are identified by unique IDs and its
591 * implementation specific internals are kept opaque to the clients
594 typedef VAGenericID VAContextID;
596 typedef VAGenericID VASurfaceID;
598 #define VA_INVALID_ID 0xffffffff
599 #define VA_INVALID_SURFACE VA_INVALID_ID
601 /** \brief Generic value types. */
603 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
604 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
605 VAGenericValueTypePointer, /**< Generic pointer type */
606 VAGenericValueTypeFunc /**< Pointer to function */
607 } VAGenericValueType;
609 /** \brief Generic function type. */
610 typedef void (*VAGenericFunc)(void);
612 /** \brief Generic value. */
613 typedef struct _VAGenericValue {
614 /** \brief Value type. See #VAGenericValueType. */
615 VAGenericValueType type;
616 /** \brief Value holder. */
618 /** \brief 32-bit signed integer. */
620 /** \brief 32-bit float. */
622 /** \brief Generic pointer. */
624 /** \brief Pointer to function. */
629 /** @name Surface attribute flags */
631 /** \brief Surface attribute is not supported. */
632 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
633 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
634 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
635 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
636 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
639 /** \brief Surface attribute types. */
641 VASurfaceAttribNone = 0,
643 * \brief Pixel format (fourcc).
645 * The value is meaningful as input to vaQuerySurfaceAttributes().
646 * If zero, the driver returns the optimal pixel format for the
647 * specified config. Otherwise, if non-zero, the value represents
648 * a pixel format (FOURCC) that is kept as is on output, if the
649 * driver supports it. Otherwise, the driver sets the value to
650 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
652 VASurfaceAttribPixelFormat,
653 /** \brief Minimal width in pixels (int, read-only). */
654 VASurfaceAttribMinWidth,
655 /** \brief Maximal width in pixels (int, read-only). */
656 VASurfaceAttribMaxWidth,
657 /** \brief Minimal height in pixels (int, read-only). */
658 VASurfaceAttribMinHeight,
659 /** \brief Maximal height in pixels (int, read-only). */
660 VASurfaceAttribMaxHeight,
661 /** \brief Surface memory type expressed in bit fields (int, read/write). */
662 VASurfaceAttribMemoryType,
663 /** \brief External buffer descriptor (pointer, write). */
664 VASurfaceAttribExternalBufferDescriptor,
665 /** \brief Number of surface attributes. */
667 } VASurfaceAttribType;
669 /** \brief Surface attribute. */
670 typedef struct _VASurfaceAttrib {
672 VASurfaceAttribType type;
673 /** \brief Flags. See "Surface attribute flags". */
675 /** \brief Value. See "Surface attribute types" for the expected types. */
676 VAGenericValue value;
680 * @name VASurfaceAttribMemoryType values in bit fields.
681 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
682 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
683 * types are defined in DRM and Android header files.
686 /** \brief VA memory type (default) is supported. */
687 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
688 /** \brief V4L2 buffer memory type is supported. */
689 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
690 /** \brief User pointer memory type is supported. */
691 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
695 * \brief VASurfaceAttribExternalBuffers structure for
696 * the VASurfaceAttribExternalBufferDescriptor attribute.
698 typedef struct _VASurfaceAttribExternalBuffers {
699 /** \brief pixel format in fourcc. */
700 unsigned int pixel_format;
701 /** \brief width in pixels. */
703 /** \brief height in pixels. */
705 /** \brief total size of the buffer in bytes. */
706 unsigned int data_size;
707 /** \brief number of planes for planar layout */
708 unsigned int num_planes;
709 /** \brief pitch for each plane in bytes */
710 unsigned int pitches[4];
711 /** \brief offset for each plane in bytes */
712 unsigned int offsets[4];
713 /** \brief buffer handles or user pointers */
714 unsigned long *buffers;
715 /** \brief number of elements in the "buffers" array */
716 unsigned int num_buffers;
717 /** \brief flags. See "Surface external buffer descriptor flags". */
719 /** \brief reserved for passing private data */
721 } VASurfaceAttribExternalBuffers;
723 /** @name VASurfaceAttribExternalBuffers flags */
725 /** \brief Enable memory tiling */
726 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
727 /** \brief Memory is cacheable */
728 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
729 /** \brief Memory is non-cacheable */
730 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
731 /** \brief Memory is write-combined */
732 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
733 /** \brief Memory is protected */
734 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
739 * \brief Queries surface attributes for the supplied config.
741 * Unlike vaGetSurfaceAttributes(), this function queries for all
742 * supported attributes for the supplied VA @config. In particular, if
743 * the underlying hardware supports the creation of VA surfaces in
744 * various formats, then this function will enumerate all pixel
745 * formats that are supported.
747 * The \c attrib_list array is allocated by the user and \c
748 * num_attribs shall be initialized to the number of allocated
749 * elements in that array. Upon successful return, the actual number
750 * of attributes will be overwritten into \c num_attribs. Otherwise,
751 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
752 * is adjusted to the number of elements that would be returned if
753 * enough space was available.
755 * Note: it is perfectly valid to pass NULL to the \c attrib_list
756 * argument when vaQuerySurfaceAttributes() is used to determine the
757 * actual number of elements that need to be allocated.
759 * @param[in] dpy the VA display
760 * @param[in] config the config identifying a codec or a video
761 * processing pipeline
762 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
763 * @param[in,out] num_attribs the number of elements allocated on
764 * input, the number of elements actually filled in output
767 vaQuerySurfaceAttributes(
770 VASurfaceAttrib *attrib_list,
771 unsigned int *num_attribs
775 * \brief Creates an array of surfaces
777 * Creates an array of surfaces. The optional list of attributes shall
778 * be constructed and validated through vaGetSurfaceAttributes() or
779 * constructed based based on what the underlying hardware could
780 * expose through vaQuerySurfaceAttributes().
782 * @param[in] dpy the VA display
783 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
784 * @param[in] width the surface width
785 * @param[in] height the surface height
786 * @param[out] surfaces the array of newly created surfaces
787 * @param[in] num_surfaces the number of surfaces to create
788 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
789 * @param[in] num_attribs the number of attributes supplied in
790 * \c attrib_list, or zero
798 VASurfaceID *surfaces,
799 unsigned int num_surfaces,
800 VASurfaceAttrib *attrib_list,
801 unsigned int num_attribs
805 * vaDestroySurfaces - Destroy resources associated with surfaces.
806 * Surfaces can only be destroyed after the context associated has been
809 * surfaces: array of surfaces to destroy
810 * num_surfaces: number of surfaces in the array to be destroyed.
812 VAStatus vaDestroySurfaces (
814 VASurfaceID *surfaces,
818 #define VA_PROGRESSIVE 0x1
820 * vaCreateContext - Create a context
822 * config_id: configuration for the context
823 * picture_width: coded picture width
824 * picture_height: coded picture height
825 * flag: any combination of the following:
826 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
827 * render_targets: render targets (surfaces) tied to the context
828 * num_render_targets: number of render targets in the above array
829 * context: created context id upon return
831 VAStatus vaCreateContext (
833 VAConfigID config_id,
837 VASurfaceID *render_targets,
838 int num_render_targets,
839 VAContextID *context /* out */
843 * vaDestroyContext - Destroy a context
845 * context: context to be destroyed
847 VAStatus vaDestroyContext (
854 * Buffers are used to pass various types of data from the
855 * client to the server. The server maintains a data store
856 * for each buffer created, and the client idenfies a buffer
857 * through a unique buffer id assigned by the server.
860 typedef VAGenericID VABufferID;
864 VAPictureParameterBufferType = 0,
865 VAIQMatrixBufferType = 1,
866 VABitPlaneBufferType = 2,
867 VASliceGroupMapBufferType = 3,
868 VASliceParameterBufferType = 4,
869 VASliceDataBufferType = 5,
870 VAMacroblockParameterBufferType = 6,
871 VAResidualDataBufferType = 7,
872 VADeblockingParameterBufferType = 8,
873 VAImageBufferType = 9,
874 VAProtectedSliceDataBufferType = 10,
875 VAQMatrixBufferType = 11,
876 VAHuffmanTableBufferType = 12,
877 VAProbabilityBufferType = 13,
879 /* Following are encode buffer types */
880 VAEncCodedBufferType = 21,
881 VAEncSequenceParameterBufferType = 22,
882 VAEncPictureParameterBufferType = 23,
883 VAEncSliceParameterBufferType = 24,
884 VAEncPackedHeaderParameterBufferType = 25,
885 VAEncPackedHeaderDataBufferType = 26,
886 VAEncMiscParameterBufferType = 27,
887 VAEncMacroblockParameterBufferType = 28,
888 /* Following are video processing buffer types */
890 * \brief Video processing pipeline parameter buffer.
892 * This buffer describes the video processing pipeline. See
893 * #VAProcPipelineParameterBuffer for details.
895 VAProcPipelineParameterBufferType = 41,
897 * \brief Video filter parameter buffer.
899 * This buffer describes the video filter parameters. All buffers
900 * inherit from #VAProcFilterParameterBufferBase, thus including
901 * a unique filter buffer type.
903 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
904 * Filters requiring advanced parameters include, but are not limited to,
905 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
906 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
908 VAProcFilterParameterBufferType = 42,
914 VAEncMiscParameterTypeFrameRate = 0,
915 VAEncMiscParameterTypeRateControl = 1,
916 VAEncMiscParameterTypeMaxSliceSize = 2,
917 VAEncMiscParameterTypeAIR = 3,
918 /** \brief Buffer type used to express a maximum frame size (in bits). */
919 VAEncMiscParameterTypeMaxFrameSize = 4,
920 /** \brief Buffer type used for HRD parameters. */
921 VAEncMiscParameterTypeHRD = 5,
922 } VAEncMiscParameterType;
924 /** \brief Packed header type. */
926 /** \brief Packed sequence header. */
927 VAEncPackedHeaderSequence = 1,
928 /** \brief Packed picture header. */
929 VAEncPackedHeaderPicture = 2,
930 /** \brief Packed slice header. */
931 VAEncPackedHeaderSlice = 3,
933 * \brief Packed raw header.
935 * Packed raw data header can be used by the client to insert a header
936 * into the bitstream data buffer at the point it is passed, the driver
937 * will handle the raw packed header based on "has_emulation_bytes" field
938 * in the packed header parameter structure.
940 VAEncPackedHeaderRawData = 4,
941 /** \brief Misc packed header. See codec-specific definitions. */
942 VAEncPackedHeaderMiscMask = 0x80000000,
943 } VAEncPackedHeaderType;
945 /** \brief Packed header parameter. */
946 typedef struct _VAEncPackedHeaderParameterBuffer {
947 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
949 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
950 unsigned int bit_length;
951 /** \brief Flag: buffer contains start code emulation prevention bytes? */
952 unsigned char has_emulation_bytes;
953 } VAEncPackedHeaderParameterBuffer;
956 * For application, e.g. set a new bitrate
958 * VAEncMiscParameterBuffer *misc_param;
959 * VAEncMiscParameterRateControl *misc_rate_ctrl;
961 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
962 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
965 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
966 * misc_param->type = VAEncMiscParameterTypeRateControl;
967 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
968 * misc_rate_ctrl->bits_per_second = 6400000;
969 * vaUnmapBuffer(dpy, buf_id);
970 * vaRenderPicture(dpy, context, &buf_id, 1);
972 typedef struct _VAEncMiscParameterBuffer
974 VAEncMiscParameterType type;
975 unsigned int data[0];
976 } VAEncMiscParameterBuffer;
979 /** \brief Rate control parameters */
980 typedef struct _VAEncMiscParameterRateControl
982 /* this is the maximum bit-rate to be constrained by the rate control implementation */
983 unsigned int bits_per_second;
984 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
985 * bit-rate for example if target_percentage is 95 then the rate control will target
986 * a bit-rate that is 95% of the maximum bit-rate
988 unsigned int target_percentage;
989 /* windows size in milliseconds. For example if this is set to 500,
990 * then the rate control will guarantee the target bit-rate over a 500 ms window
992 unsigned int window_size;
993 /* initial QP at I frames */
994 unsigned int initial_qp;
996 unsigned int basic_unit_size;
1001 unsigned int reset : 1;
1002 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1003 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1007 } VAEncMiscParameterRateControl;
1009 typedef struct _VAEncMiscParameterFrameRate
1011 unsigned int framerate;
1012 } VAEncMiscParameterFrameRate;
1015 * Allow a maximum slice size to be specified (in bits).
1016 * The encoder will attempt to make sure that individual slices do not exceed this size
1017 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1019 typedef struct _VAEncMiscParameterMaxSliceSize
1021 unsigned int max_slice_size;
1022 } VAEncMiscParameterMaxSliceSize;
1024 typedef struct _VAEncMiscParameterAIR
1026 unsigned int air_num_mbs;
1027 unsigned int air_threshold;
1028 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1029 } VAEncMiscParameterAIR;
1031 typedef struct _VAEncMiscParameterHRD
1033 unsigned int initial_buffer_fullness; /* in bits */
1034 unsigned int buffer_size; /* in bits */
1035 } VAEncMiscParameterHRD;
1038 * \brief Defines a maximum frame size (in bits).
1040 * This misc parameter buffer defines the maximum size of a frame (in
1041 * bits). The encoder will try to make sure that each frame does not
1042 * exceed this size. Otherwise, if the frame size exceeds this size,
1043 * the \c status flag of #VACodedBufferSegment will contain
1044 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1046 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1047 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1048 VAEncMiscParameterType type;
1049 /** \brief Maximum size of a frame (in bits). */
1050 unsigned int max_frame_size;
1051 } VAEncMiscParameterBufferMaxFrameSize;
1054 * There will be cases where the bitstream buffer will not have enough room to hold
1055 * the data for the entire slice, and the following flags will be used in the slice
1056 * parameter to signal to the server for the possible cases.
1057 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1058 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1059 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1061 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1062 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1063 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1064 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1066 /* Codec-independent Slice Parameter Buffer base */
1067 typedef struct _VASliceParameterBufferBase
1069 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1070 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1071 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1072 } VASliceParameterBufferBase;
1075 /****************************
1076 * JEPG data structure
1077 ***************************/
1078 typedef struct _VAQMatrixBufferJPEG
1080 int load_lum_quantiser_matrix;
1081 int load_chroma_quantiser_matrix;
1082 unsigned char lum_quantiser_matrix[64];
1083 unsigned char chroma_quantiser_matrix[64];
1084 } VAQMatrixBufferJPEG;
1086 typedef struct _VAEncPictureParameterBufferJPEG
1088 VASurfaceID reconstructed_picture;
1089 unsigned short picture_width;
1090 unsigned short picture_height;
1091 VABufferID coded_buf;
1092 } VAEncPictureParameterBufferJPEG;
1094 #include <va/va_dec_jpeg.h>
1096 /****************************
1097 * MPEG-2 data structures
1098 ****************************/
1100 /* MPEG-2 Picture Parameter Buffer */
1102 * For each frame or field, and before any slice data, a single
1103 * picture parameter buffer must be send.
1105 typedef struct _VAPictureParameterBufferMPEG2
1107 unsigned short horizontal_size;
1108 unsigned short vertical_size;
1109 VASurfaceID forward_reference_picture;
1110 VASurfaceID backward_reference_picture;
1111 /* meanings of the following fields are the same as in the standard */
1112 int picture_coding_type;
1113 int f_code; /* pack all four fcode into this */
1116 unsigned int intra_dc_precision : 2;
1117 unsigned int picture_structure : 2;
1118 unsigned int top_field_first : 1;
1119 unsigned int frame_pred_frame_dct : 1;
1120 unsigned int concealment_motion_vectors : 1;
1121 unsigned int q_scale_type : 1;
1122 unsigned int intra_vlc_format : 1;
1123 unsigned int alternate_scan : 1;
1124 unsigned int repeat_first_field : 1;
1125 unsigned int progressive_frame : 1;
1126 unsigned int is_first_field : 1; /* indicate whether the current field
1127 * is the first field for field picture
1131 } picture_coding_extension;
1132 } VAPictureParameterBufferMPEG2;
1134 /* MPEG-2 Inverse Quantization Matrix Buffer */
1135 typedef struct _VAIQMatrixBufferMPEG2
1137 int load_intra_quantiser_matrix;
1138 int load_non_intra_quantiser_matrix;
1139 int load_chroma_intra_quantiser_matrix;
1140 int load_chroma_non_intra_quantiser_matrix;
1141 unsigned char intra_quantiser_matrix[64];
1142 unsigned char non_intra_quantiser_matrix[64];
1143 unsigned char chroma_intra_quantiser_matrix[64];
1144 unsigned char chroma_non_intra_quantiser_matrix[64];
1145 } VAIQMatrixBufferMPEG2;
1147 /* MPEG-2 Slice Parameter Buffer */
1148 typedef struct _VASliceParameterBufferMPEG2
1150 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1151 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1152 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1153 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1154 unsigned int slice_horizontal_position;
1155 unsigned int slice_vertical_position;
1156 int quantiser_scale_code;
1157 int intra_slice_flag;
1158 } VASliceParameterBufferMPEG2;
1160 /* MPEG-2 Macroblock Parameter Buffer */
1161 typedef struct _VAMacroblockParameterBufferMPEG2
1163 unsigned short macroblock_address;
1165 * macroblock_address (in raster scan order)
1167 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1169 unsigned char macroblock_type; /* see definition below */
1172 unsigned int frame_motion_type : 2;
1173 unsigned int field_motion_type : 2;
1174 unsigned int dct_type : 1;
1178 unsigned char motion_vertical_field_select;
1180 * motion_vertical_field_select:
1181 * see section 6.3.17.2 in the spec
1182 * only the lower 4 bits are used
1183 * bit 0: first vector forward
1184 * bit 1: first vector backward
1185 * bit 2: second vector forward
1186 * bit 3: second vector backward
1188 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1189 unsigned short coded_block_pattern;
1191 * The bitplanes for coded_block_pattern are described
1192 * in Figure 6.10-12 in the spec
1195 /* Number of skipped macroblocks after this macroblock */
1196 unsigned short num_skipped_macroblocks;
1197 } VAMacroblockParameterBufferMPEG2;
1200 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1202 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1203 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1204 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1205 #define VA_MB_TYPE_MOTION_INTRA 0x10
1208 * MPEG-2 Residual Data Buffer
1209 * For each macroblock, there wil be 64 shorts (16-bit) in the
1210 * residual data buffer
1213 /****************************
1214 * MPEG-4 Part 2 data structures
1215 ****************************/
1217 /* MPEG-4 Picture Parameter Buffer */
1219 * For each frame or field, and before any slice data, a single
1220 * picture parameter buffer must be send.
1222 typedef struct _VAPictureParameterBufferMPEG4
1224 unsigned short vop_width;
1225 unsigned short vop_height;
1226 VASurfaceID forward_reference_picture;
1227 VASurfaceID backward_reference_picture;
1230 unsigned int short_video_header : 1;
1231 unsigned int chroma_format : 2;
1232 unsigned int interlaced : 1;
1233 unsigned int obmc_disable : 1;
1234 unsigned int sprite_enable : 2;
1235 unsigned int sprite_warping_accuracy : 2;
1236 unsigned int quant_type : 1;
1237 unsigned int quarter_sample : 1;
1238 unsigned int data_partitioned : 1;
1239 unsigned int reversible_vlc : 1;
1240 unsigned int resync_marker_disable : 1;
1244 unsigned char no_of_sprite_warping_points;
1245 short sprite_trajectory_du[3];
1246 short sprite_trajectory_dv[3];
1247 unsigned char quant_precision;
1250 unsigned int vop_coding_type : 2;
1251 unsigned int backward_reference_vop_coding_type : 2;
1252 unsigned int vop_rounding_type : 1;
1253 unsigned int intra_dc_vlc_thr : 3;
1254 unsigned int top_field_first : 1;
1255 unsigned int alternate_vertical_scan_flag : 1;
1259 unsigned char vop_fcode_forward;
1260 unsigned char vop_fcode_backward;
1261 unsigned short vop_time_increment_resolution;
1262 /* short header related */
1263 unsigned char num_gobs_in_vop;
1264 unsigned char num_macroblocks_in_gob;
1265 /* for direct mode prediction */
1268 } VAPictureParameterBufferMPEG4;
1270 /* MPEG-4 Inverse Quantization Matrix Buffer */
1271 typedef struct _VAIQMatrixBufferMPEG4
1273 int load_intra_quant_mat;
1274 int load_non_intra_quant_mat;
1275 unsigned char intra_quant_mat[64];
1276 unsigned char non_intra_quant_mat[64];
1277 } VAIQMatrixBufferMPEG4;
1279 /* MPEG-4 Slice Parameter Buffer */
1280 typedef struct _VASliceParameterBufferMPEG4
1282 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1283 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1284 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1285 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1286 unsigned int macroblock_number;
1288 } VASliceParameterBufferMPEG4;
1291 VC-1 data structures
1294 typedef enum /* see 7.1.1.32 */
1297 VAMvMode1MvHalfPel = 1,
1298 VAMvMode1MvHalfPelBilinear = 2,
1299 VAMvModeMixedMv = 3,
1300 VAMvModeIntensityCompensation = 4
1303 /* VC-1 Picture Parameter Buffer */
1305 * For each picture, and before any slice data, a picture parameter
1306 * buffer must be send. Multiple picture parameter buffers may be
1307 * sent for a single picture. In that case picture parameters will
1308 * apply to all slice data that follow it until a new picture
1309 * parameter buffer is sent.
1312 * pic_quantizer_type should be set to the applicable quantizer
1313 * type as defined by QUANTIZER (J.1.19) and either
1314 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1316 typedef struct _VAPictureParameterBufferVC1
1318 VASurfaceID forward_reference_picture;
1319 VASurfaceID backward_reference_picture;
1320 /* if out-of-loop post-processing is done on the render
1321 target, then we need to keep the in-loop decoded
1322 picture as a reference picture */
1323 VASurfaceID inloop_decoded_picture;
1325 /* sequence layer for AP or meta data for SP and MP */
1328 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1329 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1330 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1331 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1332 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1333 unsigned int multires : 1; /* METADATA::MULTIRES */
1334 unsigned int overlap : 1; /* METADATA::OVERLAP */
1335 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1336 unsigned int rangered : 1; /* METADATA::RANGERED */
1337 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1338 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1343 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1344 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1347 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1348 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1349 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1350 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1353 } entrypoint_fields;
1354 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1355 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1358 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1359 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1360 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1361 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1364 } range_mapping_fields;
1366 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1367 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1368 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1369 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1370 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1371 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1372 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1373 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1374 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1377 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1378 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1379 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1380 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1381 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1387 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1388 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1389 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1390 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1391 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1392 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1393 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1399 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1400 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1401 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1402 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1403 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1404 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1405 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1408 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1411 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1412 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1413 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1414 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1420 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1421 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1422 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1423 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1424 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1425 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1426 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1427 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1428 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1429 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1435 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1436 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1437 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1438 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1439 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1440 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1441 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1442 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1443 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1444 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1445 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1448 } pic_quantizer_fields;
1451 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1452 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1453 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1454 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1455 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1456 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1460 } VAPictureParameterBufferVC1;
1462 /* VC-1 Bitplane Buffer
1463 There will be at most three bitplanes coded in any picture header. To send
1464 the bitplane data more efficiently, each byte is divided in two nibbles, with
1465 each nibble carrying three bitplanes for one macroblock. The following table
1466 shows the bitplane data arrangement within each nibble based on the picture
1469 Picture Type Bit3 Bit2 Bit1 Bit0
1470 I or BI OVERFLAGS ACPRED FIELDTX
1471 P MYTYPEMB SKIPMB DIRECTMB
1472 B FORWARDMB SKIPMB DIRECTMB
1474 Within each byte, the lower nibble is for the first MB and the upper nibble is
1475 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1476 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1477 Macroblock #2 in the first row.
1480 /* VC-1 Slice Parameter Buffer */
1481 typedef struct _VASliceParameterBufferVC1
1483 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1484 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1485 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1486 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1487 unsigned int slice_vertical_position;
1488 } VASliceParameterBufferVC1;
1490 /* VC-1 Slice Data Buffer */
1492 This is simplely a buffer containing raw bit-stream bytes
1495 /****************************
1496 * H.264/AVC data structures
1497 ****************************/
1499 typedef struct _VAPictureH264
1501 VASurfaceID picture_id;
1502 unsigned int frame_idx;
1504 signed int TopFieldOrderCnt;
1505 signed int BottomFieldOrderCnt;
1507 /* flags in VAPictureH264 could be OR of the following */
1508 #define VA_PICTURE_H264_INVALID 0x00000001
1509 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1510 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1511 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1512 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1514 /* H.264 Picture Parameter Buffer */
1516 * For each picture, and before any slice data, a single
1517 * picture parameter buffer must be send.
1519 typedef struct _VAPictureParameterBufferH264
1521 VAPictureH264 CurrPic;
1522 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1523 unsigned short picture_width_in_mbs_minus1;
1524 unsigned short picture_height_in_mbs_minus1;
1525 unsigned char bit_depth_luma_minus8;
1526 unsigned char bit_depth_chroma_minus8;
1527 unsigned char num_ref_frames;
1530 unsigned int chroma_format_idc : 2;
1531 unsigned int residual_colour_transform_flag : 1;
1532 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1533 unsigned int frame_mbs_only_flag : 1;
1534 unsigned int mb_adaptive_frame_field_flag : 1;
1535 unsigned int direct_8x8_inference_flag : 1;
1536 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1537 unsigned int log2_max_frame_num_minus4 : 4;
1538 unsigned int pic_order_cnt_type : 2;
1539 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1540 unsigned int delta_pic_order_always_zero_flag : 1;
1544 unsigned char num_slice_groups_minus1;
1545 unsigned char slice_group_map_type;
1546 unsigned short slice_group_change_rate_minus1;
1547 signed char pic_init_qp_minus26;
1548 signed char pic_init_qs_minus26;
1549 signed char chroma_qp_index_offset;
1550 signed char second_chroma_qp_index_offset;
1553 unsigned int entropy_coding_mode_flag : 1;
1554 unsigned int weighted_pred_flag : 1;
1555 unsigned int weighted_bipred_idc : 2;
1556 unsigned int transform_8x8_mode_flag : 1;
1557 unsigned int field_pic_flag : 1;
1558 unsigned int constrained_intra_pred_flag : 1;
1559 unsigned int pic_order_present_flag : 1;
1560 unsigned int deblocking_filter_control_present_flag : 1;
1561 unsigned int redundant_pic_cnt_present_flag : 1;
1562 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1566 unsigned short frame_num;
1567 } VAPictureParameterBufferH264;
1569 /* H.264 Inverse Quantization Matrix Buffer */
1570 typedef struct _VAIQMatrixBufferH264
1572 unsigned char ScalingList4x4[6][16];
1573 unsigned char ScalingList8x8[2][64];
1574 } VAIQMatrixBufferH264;
1577 * H.264 Slice Group Map Buffer
1578 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1579 * A slice group map buffer should be sent for each picture if required. The buffer
1580 * is sent only when there is a change in the mapping values.
1581 * The slice group map buffer map "map units" to slice groups as specified in
1582 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1583 * in raster scan order
1586 /* H.264 Slice Parameter Buffer */
1587 typedef struct _VASliceParameterBufferH264
1589 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1590 /** \brief Byte offset to the NAL Header Unit for this slice. */
1591 unsigned int slice_data_offset;
1592 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1594 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1596 * This bit offset is relative to and includes the NAL unit byte
1597 * and represents the number of bits parsed in the slice_header()
1598 * after the removal of any emulation prevention bytes in
1599 * there. However, the slice data buffer passed to the hardware is
1600 * the original bitstream, thus including any emulation prevention
1603 unsigned short slice_data_bit_offset;
1604 unsigned short first_mb_in_slice;
1605 unsigned char slice_type;
1606 unsigned char direct_spatial_mv_pred_flag;
1607 unsigned char num_ref_idx_l0_active_minus1;
1608 unsigned char num_ref_idx_l1_active_minus1;
1609 unsigned char cabac_init_idc;
1610 char slice_qp_delta;
1611 unsigned char disable_deblocking_filter_idc;
1612 char slice_alpha_c0_offset_div2;
1613 char slice_beta_offset_div2;
1614 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1615 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1616 unsigned char luma_log2_weight_denom;
1617 unsigned char chroma_log2_weight_denom;
1618 unsigned char luma_weight_l0_flag;
1619 short luma_weight_l0[32];
1620 short luma_offset_l0[32];
1621 unsigned char chroma_weight_l0_flag;
1622 short chroma_weight_l0[32][2];
1623 short chroma_offset_l0[32][2];
1624 unsigned char luma_weight_l1_flag;
1625 short luma_weight_l1[32];
1626 short luma_offset_l1[32];
1627 unsigned char chroma_weight_l1_flag;
1628 short chroma_weight_l1[32][2];
1629 short chroma_offset_l1[32][2];
1630 } VASliceParameterBufferH264;
1632 /****************************
1633 * Common encode data structures
1634 ****************************/
1637 VAEncPictureTypeIntra = 0,
1638 VAEncPictureTypePredictive = 1,
1639 VAEncPictureTypeBidirectional = 2,
1642 /* Encode Slice Parameter Buffer */
1643 typedef struct _VAEncSliceParameterBuffer
1645 unsigned int start_row_number; /* starting MB row number for this slice */
1646 unsigned int slice_height; /* slice height measured in MB */
1649 unsigned int is_intra : 1;
1650 unsigned int disable_deblocking_filter_idc : 2;
1651 unsigned int uses_long_term_ref :1;
1652 unsigned int is_long_term_ref :1;
1656 } VAEncSliceParameterBuffer;
1659 /****************************
1660 * H.263 specific encode data structures
1661 ****************************/
1663 typedef struct _VAEncSequenceParameterBufferH263
1665 unsigned int intra_period;
1666 unsigned int bits_per_second;
1667 unsigned int frame_rate;
1668 unsigned int initial_qp;
1669 unsigned int min_qp;
1670 } VAEncSequenceParameterBufferH263;
1672 typedef struct _VAEncPictureParameterBufferH263
1674 VASurfaceID reference_picture;
1675 VASurfaceID reconstructed_picture;
1676 VABufferID coded_buf;
1677 unsigned short picture_width;
1678 unsigned short picture_height;
1679 VAEncPictureType picture_type;
1680 } VAEncPictureParameterBufferH263;
1682 /****************************
1683 * MPEG-4 specific encode data structures
1684 ****************************/
1686 typedef struct _VAEncSequenceParameterBufferMPEG4
1688 unsigned char profile_and_level_indication;
1689 unsigned int intra_period;
1690 unsigned int video_object_layer_width;
1691 unsigned int video_object_layer_height;
1692 unsigned int vop_time_increment_resolution;
1693 unsigned int fixed_vop_rate;
1694 unsigned int fixed_vop_time_increment;
1695 unsigned int bits_per_second;
1696 unsigned int frame_rate;
1697 unsigned int initial_qp;
1698 unsigned int min_qp;
1699 } VAEncSequenceParameterBufferMPEG4;
1701 typedef struct _VAEncPictureParameterBufferMPEG4
1703 VASurfaceID reference_picture;
1704 VASurfaceID reconstructed_picture;
1705 VABufferID coded_buf;
1706 unsigned short picture_width;
1707 unsigned short picture_height;
1708 unsigned int modulo_time_base; /* number of 1s */
1709 unsigned int vop_time_increment;
1710 VAEncPictureType picture_type;
1711 } VAEncPictureParameterBufferMPEG4;
1715 /* Buffer functions */
1718 * Creates a buffer for "num_elements" elements of "size" bytes and
1719 * initalize with "data".
1720 * if "data" is null, then the contents of the buffer data store
1722 * Basically there are two ways to get buffer data to the server side. One is
1723 * to call vaCreateBuffer() with a non-null "data", which results the data being
1724 * copied to the data store on the server side. A different method that
1725 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1726 * and then use vaMapBuffer() to map the data store from the server side to the
1727 * client address space for access.
1728 * Note: image buffers are created by the library, not the client. Please see
1729 * vaCreateImage on how image buffers are managed.
1731 VAStatus vaCreateBuffer (
1733 VAContextID context,
1734 VABufferType type, /* in */
1735 unsigned int size, /* in */
1736 unsigned int num_elements, /* in */
1737 void *data, /* in */
1738 VABufferID *buf_id /* out */
1742 * Convey to the server how many valid elements are in the buffer.
1743 * e.g. if multiple slice parameters are being held in a single buffer,
1744 * this will communicate to the server the number of slice parameters
1745 * that are valid in the buffer.
1747 VAStatus vaBufferSetNumElements (
1749 VABufferID buf_id, /* in */
1750 unsigned int num_elements /* in */
1755 * device independent data structure for codedbuffer
1759 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1760 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1761 * enough for the encoder to attempt to limit its size.
1762 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1763 * exceeded the maximum slice size specified.
1764 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1765 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1766 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1768 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1769 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1770 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1771 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1772 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1774 * \brief The frame has exceeded the maximum requested size.
1776 * This flag indicates that the encoded frame size exceeds the value
1777 * specified through a misc parameter buffer of type
1778 * #VAEncMiscParameterTypeMaxFrameSize.
1780 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1781 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1784 * \brief The coded buffer segment contains a single NAL unit.
1786 * This flag indicates that the coded buffer segment contains a
1787 * single NAL unit. This flag might be useful to the user for
1788 * processing the coded buffer.
1790 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1793 * \brief Coded buffer segment.
1795 * #VACodedBufferSegment is an element of a linked list describing
1796 * some information on the coded buffer. The coded buffer segment
1797 * could contain either a single NAL unit, or more than one NAL unit.
1798 * It is recommended (but not required) to return a single NAL unit
1799 * in a coded buffer segment, and the implementation should set the
1800 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1802 typedef struct _VACodedBufferSegment {
1804 * \brief Size of the data buffer in this segment (in bytes).
1807 /** \brief Bit offset into the data buffer where the video data starts. */
1808 unsigned int bit_offset;
1809 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1810 unsigned int status;
1811 /** \brief Reserved for future use. */
1812 unsigned int reserved;
1813 /** \brief Pointer to the start of the data buffer. */
1816 * \brief Pointer to the next #VACodedBufferSegment element,
1817 * or \c NULL if there is none.
1820 } VACodedBufferSegment;
1823 * Map data store of the buffer into the client's address space
1824 * vaCreateBuffer() needs to be called with "data" set to NULL before
1825 * calling vaMapBuffer()
1827 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1828 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1830 VAStatus vaMapBuffer (
1832 VABufferID buf_id, /* in */
1833 void **pbuf /* out */
1837 * After client making changes to a mapped data store, it needs to
1838 * "Unmap" it to let the server know that the data is ready to be
1839 * consumed by the server
1841 VAStatus vaUnmapBuffer (
1843 VABufferID buf_id /* in */
1847 * After this call, the buffer is deleted and this buffer_id is no longer valid
1848 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1850 VAStatus vaDestroyBuffer (
1852 VABufferID buffer_id
1856 Render (Decode) Pictures
1858 A picture represents either a frame or a field.
1860 The Begin/Render/End sequence sends the decode buffers to the server
1864 * Get ready to decode a picture to a target surface
1866 VAStatus vaBeginPicture (
1868 VAContextID context,
1869 VASurfaceID render_target
1873 * Send decode buffers to the server.
1874 * Buffers are automatically destroyed afterwards
1876 VAStatus vaRenderPicture (
1878 VAContextID context,
1879 VABufferID *buffers,
1884 * Make the end of rendering for a picture.
1885 * The server should start processing all pending operations for this
1886 * surface. This call is non-blocking. The client can start another
1887 * Begin/Render/End sequence on a different render target.
1889 VAStatus vaEndPicture (
1901 * This function blocks until all pending operations on the render target
1902 * have been completed. Upon return it is safe to use the render target for a
1903 * different picture.
1905 VAStatus vaSyncSurface (
1907 VASurfaceID render_target
1912 VASurfaceRendering = 1, /* Rendering in progress */
1913 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1914 /* this status is useful if surface is used as the source */
1916 VASurfaceReady = 4, /* not being rendered or displayed */
1917 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1921 * Find out any pending ops on the render target
1923 VAStatus vaQuerySurfaceStatus (
1925 VASurfaceID render_target,
1926 VASurfaceStatus *status /* out */
1931 VADecodeSliceMissing = 0,
1932 VADecodeMBError = 1,
1933 } VADecodeErrorType;
1936 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1937 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1939 typedef struct _VASurfaceDecodeMBErrors
1941 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1942 unsigned int start_mb; /* start mb address with errors */
1943 unsigned int end_mb; /* end mb address with errors */
1944 VADecodeErrorType decode_error_type;
1945 } VASurfaceDecodeMBErrors;
1948 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1949 * it can call vaQuerySurfaceError to find out further details on the particular error.
1950 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1951 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1952 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1953 * The array is terminated if "status==-1" is detected.
1955 VAStatus vaQuerySurfaceError(
1957 VASurfaceID surface,
1958 VAStatus error_status,
1963 * Images and Subpictures
1964 * VAImage is used to either get the surface data to client memory, or
1965 * to copy image data in client memory to a surface.
1966 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1967 * is at the upper left corner with positive X to the right and positive Y down
1969 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1970 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1971 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1974 * Pre-defined fourcc codes
1976 #define VA_FOURCC_NV12 0x3231564E
1977 #define VA_FOURCC_AI44 0x34344149
1978 #define VA_FOURCC_RGBA 0x41424752
1979 #define VA_FOURCC_RGBX 0x58424752
1980 #define VA_FOURCC_BGRA 0x41524742
1981 #define VA_FOURCC_BGRX 0x58524742
1982 #define VA_FOURCC_ARGB 0x42475241
1983 #define VA_FOURCC_XRGB 0x42475258
1984 #define VA_FOURCC_ABGR 0x52474241
1985 #define VA_FOURCC_XBGR 0x52474258
1986 #define VA_FOURCC_UYVY 0x59565955
1987 #define VA_FOURCC_YUY2 0x32595559
1988 #define VA_FOURCC_AYUV 0x56555941
1989 #define VA_FOURCC_NV11 0x3131564e
1990 #define VA_FOURCC_YV12 0x32315659
1991 #define VA_FOURCC_P208 0x38303250
1992 #define VA_FOURCC_IYUV 0x56555949
1993 #define VA_FOURCC_YV24 0x34325659
1994 #define VA_FOURCC_YV32 0x32335659
1995 #define VA_FOURCC_Y800 0x30303859
1996 #define VA_FOURCC_IMC3 0x33434D49
1997 #define VA_FOURCC_411P 0x50313134
1998 #define VA_FOURCC_422H 0x48323234
1999 #define VA_FOURCC_422V 0x56323234
2000 #define VA_FOURCC_444P 0x50343434
2001 #define VA_FOURCC_RGBP 0x50424752
2002 #define VA_FOURCC_BGRP 0x50524742
2003 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2006 #define VA_LSB_FIRST 1
2007 #define VA_MSB_FIRST 2
2009 typedef struct _VAImageFormat
2011 unsigned int fourcc;
2012 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2013 unsigned int bits_per_pixel;
2014 /* for RGB formats */
2015 unsigned int depth; /* significant bits per pixel */
2016 unsigned int red_mask;
2017 unsigned int green_mask;
2018 unsigned int blue_mask;
2019 unsigned int alpha_mask;
2022 typedef VAGenericID VAImageID;
2024 typedef struct _VAImage
2026 VAImageID image_id; /* uniquely identify this image */
2027 VAImageFormat format;
2028 VABufferID buf; /* image data buffer */
2030 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2031 * data store on the server side for optimal performance. The buffer will be
2032 * created by the CreateImage function, and proper storage allocated based on the image
2033 * size and format. This buffer is managed by the library implementation, and
2034 * accessed by the client through the buffer Map/Unmap functions.
2036 unsigned short width;
2037 unsigned short height;
2038 unsigned int data_size;
2039 unsigned int num_planes; /* can not be greater than 3 */
2041 * An array indicating the scanline pitch in bytes for each plane.
2042 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2044 unsigned int pitches[3];
2046 * An array indicating the byte offset from the beginning of the image data
2047 * to the start of each plane.
2049 unsigned int offsets[3];
2051 /* The following fields are only needed for paletted formats */
2052 int num_palette_entries; /* set to zero for non-palette images */
2054 * Each component is one byte and entry_bytes indicates the number of components in
2055 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2059 * An array of ascii characters describing the order of the components within the bytes.
2060 * Only entry_bytes characters of the string are used.
2062 char component_order[4];
2065 /* Get maximum number of image formats supported by the implementation */
2066 int vaMaxNumImageFormats (
2071 * Query supported image formats
2072 * The caller must provide a "format_list" array that can hold at
2073 * least vaMaxNumImageFormats() entries. The actual number of formats
2074 * returned in "format_list" is returned in "num_formats".
2076 VAStatus vaQueryImageFormats (
2078 VAImageFormat *format_list, /* out */
2079 int *num_formats /* out */
2083 * Create a VAImage structure
2084 * The width and height fields returned in the VAImage structure may get
2085 * enlarged for some YUV formats. Upon return from this function,
2086 * image->buf has been created and proper storage allocated by the library.
2087 * The client can access the image through the Map/Unmap calls.
2089 VAStatus vaCreateImage (
2091 VAImageFormat *format,
2094 VAImage *image /* out */
2098 * Should call DestroyImage before destroying the surface it is bound to
2100 VAStatus vaDestroyImage (
2105 VAStatus vaSetImagePalette (
2109 * pointer to an array holding the palette data. The size of the array is
2110 * num_palette_entries * entry_bytes in size. The order of the components
2111 * in the palette is described by the component_order in VAImage struct
2113 unsigned char *palette
2117 * Retrive surface data into a VAImage
2118 * Image must be in a format supported by the implementation
2120 VAStatus vaGetImage (
2122 VASurfaceID surface,
2123 int x, /* coordinates of the upper left source pixel */
2125 unsigned int width, /* width and height of the region */
2126 unsigned int height,
2131 * Copy data from a VAImage to a surface
2132 * Image must be in a format supported by the implementation
2133 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2134 * shouldn't be rendered into when this is called
2136 VAStatus vaPutImage (
2138 VASurfaceID surface,
2142 unsigned int src_width,
2143 unsigned int src_height,
2146 unsigned int dest_width,
2147 unsigned int dest_height
2151 * Derive an VAImage from an existing surface.
2152 * This interface will derive a VAImage and corresponding image buffer from
2153 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2154 * direct CPU access. This operation is only possible on implementations with
2155 * direct rendering capabilities and internal surface formats that can be
2156 * represented with a VAImage. When the operation is not possible this interface
2157 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2158 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2161 * Implementations should only return success when the resulting image buffer
2162 * would be useable with vaMap/Unmap.
2164 * When directly accessing a surface special care must be taken to insure
2165 * proper synchronization with the graphics hardware. Clients should call
2166 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2167 * rendering or currently being displayed by an overlay.
2169 * Additionally nothing about the contents of a surface should be assumed
2170 * following a vaPutSurface. Implementations are free to modify the surface for
2171 * scaling or subpicture blending within a call to vaPutImage.
2173 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2174 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2175 * vaGetImage with other surfaces is supported.
2177 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2178 * image and image buffer structures will be destroyed; however, the underlying
2179 * surface will remain unchanged until freed with vaDestroySurfaces.
2181 VAStatus vaDeriveImage (
2183 VASurfaceID surface,
2184 VAImage *image /* out */
2189 * Subpicture is a special type of image that can be blended
2190 * with a surface during vaPutSurface(). Subpicture can be used to render
2191 * DVD sub-titles or closed captioning text etc.
2194 typedef VAGenericID VASubpictureID;
2196 /* Get maximum number of subpicture formats supported by the implementation */
2197 int vaMaxNumSubpictureFormats (
2201 /* flags for subpictures */
2202 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2203 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2204 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2206 * Query supported subpicture formats
2207 * The caller must provide a "format_list" array that can hold at
2208 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2209 * for each format to indicate additional capabilities for that format. The actual
2210 * number of formats returned in "format_list" is returned in "num_formats".
2211 * flags: returned value to indicate addtional capabilities
2212 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2213 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2214 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2217 VAStatus vaQuerySubpictureFormats (
2219 VAImageFormat *format_list, /* out */
2220 unsigned int *flags, /* out */
2221 unsigned int *num_formats /* out */
2225 * Subpictures are created with an image associated.
2227 VAStatus vaCreateSubpicture (
2230 VASubpictureID *subpicture /* out */
2234 * Destroy the subpicture before destroying the image it is assocated to
2236 VAStatus vaDestroySubpicture (
2238 VASubpictureID subpicture
2242 * Bind an image to the subpicture. This image will now be associated with
2243 * the subpicture instead of the one at creation.
2245 VAStatus vaSetSubpictureImage (
2247 VASubpictureID subpicture,
2252 * If chromakey is enabled, then the area where the source value falls within
2253 * the chromakey [min, max] range is transparent
2254 * The chromakey component format is the following:
2255 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2256 * For YUV: [0:7] V [8:15] U [16:23] Y
2257 * The chromakey mask can be used to mask out certain components for chromakey
2260 VAStatus vaSetSubpictureChromakey (
2262 VASubpictureID subpicture,
2263 unsigned int chromakey_min,
2264 unsigned int chromakey_max,
2265 unsigned int chromakey_mask
2269 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2270 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2271 * the overall alpha is per-pixel alpha multiplied by the global alpha
2273 VAStatus vaSetSubpictureGlobalAlpha (
2275 VASubpictureID subpicture,
2280 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2281 * It defines the region mapping between the subpicture and the target
2282 * surfaces through source and destination rectangles (with the same width and height).
2283 * Both will be displayed at the next call to vaPutSurface. Additional
2284 * associations before the call to vaPutSurface simply overrides the association.
2286 VAStatus vaAssociateSubpicture (
2288 VASubpictureID subpicture,
2289 VASurfaceID *target_surfaces,
2291 short src_x, /* upper left offset in subpicture */
2293 unsigned short src_width,
2294 unsigned short src_height,
2295 short dest_x, /* upper left offset in surface */
2297 unsigned short dest_width,
2298 unsigned short dest_height,
2300 * whether to enable chroma-keying, global-alpha, or screen relative mode
2301 * see VA_SUBPICTURE_XXX values
2307 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2309 VAStatus vaDeassociateSubpicture (
2311 VASubpictureID subpicture,
2312 VASurfaceID *target_surfaces,
2316 typedef struct _VARectangle
2320 unsigned short width;
2321 unsigned short height;
2325 * Display attributes
2326 * Display attributes are used to control things such as contrast, hue, saturation,
2327 * brightness etc. in the rendering process. The application can query what
2328 * attributes are supported by the driver, and then set the appropriate attributes
2329 * before calling vaPutSurface()
2331 /* PowerVR IEP Lite attributes */
2334 VADISPLAYATTRIB_BLE_OFF = 0x00,
2335 VADISPLAYATTRIB_BLE_LOW,
2336 VADISPLAYATTRIB_BLE_MEDIUM,
2337 VADISPLAYATTRIB_BLE_HIGH,
2338 VADISPLAYATTRIB_BLE_NONE,
2339 } VADisplayAttribBLEMode;
2341 /* attribute value for VADisplayAttribRotation */
2342 #define VA_ROTATION_NONE 0x00000000
2343 #define VA_ROTATION_90 0x00000001
2344 #define VA_ROTATION_180 0x00000002
2345 #define VA_ROTATION_270 0x00000003
2347 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2348 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2349 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2352 #define VA_RENDER_MODE_UNDEFINED 0
2353 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2354 #define VA_RENDER_MODE_LOCAL_GPU 2
2355 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2356 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2359 #define VA_RENDER_DEVICE_UNDEFINED 0
2360 #define VA_RENDER_DEVICE_LOCAL 1
2361 #define VA_RENDER_DEVICE_EXTERNAL 2
2363 /* Currently defined display attribute types */
2366 VADisplayAttribBrightness = 0,
2367 VADisplayAttribContrast = 1,
2368 VADisplayAttribHue = 2,
2369 VADisplayAttribSaturation = 3,
2370 /* client can specifiy a background color for the target window
2371 * the new feature of video conference,
2372 * the uncovered area of the surface is filled by this color
2373 * also it will blend with the decoded video color
2375 VADisplayAttribBackgroundColor = 4,
2377 * this is a gettable only attribute. For some implementations that use the
2378 * hardware overlay, after PutSurface is called, the surface can not be
2379 * re-used until after the subsequent PutSurface call. If this is the case
2380 * then the value for this attribute will be set to 1 so that the client
2381 * will not attempt to re-use the surface right after returning from a call
2384 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2385 * driver may use overlay or GPU alternatively
2387 VADisplayAttribDirectSurface = 5,
2388 VADisplayAttribRotation = 6,
2389 VADisplayAttribOutofLoopDeblock = 7,
2391 /* PowerVR IEP Lite specific attributes */
2392 VADisplayAttribBLEBlackMode = 8,
2393 VADisplayAttribBLEWhiteMode = 9,
2394 VADisplayAttribBlueStretch = 10,
2395 VADisplayAttribSkinColorCorrection = 11,
2397 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2398 * conversion matrix. Each element in the matrix is float-point
2400 VADisplayAttribCSCMatrix = 12,
2401 /* specify the constant color used to blend with video surface
2402 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2403 * d: the final color to overwrite into the frame buffer
2404 * v: decoded video after color conversion,
2405 * c: video color specified by VADisplayAttribBlendColor
2406 * b: background color of the drawable
2408 VADisplayAttribBlendColor = 13,
2410 * Indicate driver to skip painting color key or not.
2411 * only applicable if the render is overlay
2413 VADisplayAttribOverlayAutoPaintColorKey = 14,
2415 * customized overlay color key, the format is RGB888
2416 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2418 VADisplayAttribOverlayColorKey = 15,
2420 * The hint for the implementation of vaPutSurface
2421 * normally, the driver could use an overlay or GPU to render the surface on the screen
2422 * this flag provides APP the flexibity to switch the render dynamically
2424 VADisplayAttribRenderMode = 16,
2426 * specify if vaPutSurface needs to render into specified monitors
2427 * one example is that one external monitor (e.g. HDMI) is enabled,
2428 * but the window manager is not aware of it, and there is no associated drawable
2430 VADisplayAttribRenderDevice = 17,
2432 * specify vaPutSurface render area if there is no drawable on the monitor
2434 VADisplayAttribRenderRect = 18,
2435 } VADisplayAttribType;
2437 /* flags for VADisplayAttribute */
2438 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2439 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2440 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2442 typedef struct _VADisplayAttribute
2444 VADisplayAttribType type;
2447 int value; /* used by the set/get attribute functions */
2448 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2450 } VADisplayAttribute;
2452 /* Get maximum number of display attributs supported by the implementation */
2453 int vaMaxNumDisplayAttributes (
2458 * Query display attributes
2459 * The caller must provide a "attr_list" array that can hold at
2460 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2461 * returned in "attr_list" is returned in "num_attributes".
2463 VAStatus vaQueryDisplayAttributes (
2465 VADisplayAttribute *attr_list, /* out */
2466 int *num_attributes /* out */
2470 * Get display attributes
2471 * This function returns the current attribute values in "attr_list".
2472 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2473 * from vaQueryDisplayAttributes() can have their values retrieved.
2475 VAStatus vaGetDisplayAttributes (
2477 VADisplayAttribute *attr_list, /* in/out */
2482 * Set display attributes
2483 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2484 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2485 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2487 VAStatus vaSetDisplayAttributes (
2489 VADisplayAttribute *attr_list,