2 * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19 * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
20 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 * Video Acceleration (VA) API Specification
28 * <jonathan.bian@intel.com>
31 * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
32 * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
33 * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
34 * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
35 * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
36 * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
37 * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
38 * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
39 * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
40 * and MPEG-2 motion compensation.
41 * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
42 * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
43 * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
44 * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
45 * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
46 * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
47 * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
48 * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
49 * rev 0.27 (11/19/2007 Matt Sottek) - Added DeriveImage
50 * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
52 * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
53 * added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
54 * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
55 * for ISO C conformance.
56 * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
57 * Application needs to relink with the new library.
59 * rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
60 * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
61 * screen relative rather than source video relative.
62 * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
63 * update VAAPI to 0.32.0
66 * Some concepts borrowed from XvMC and XvImage.
67 * Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
68 * contributed to various aspects of the API.
75 * This file contains the \ref api_core "Core API".
82 #include <va/va_version.h>
89 * \mainpage Video Acceleration (VA) API
91 * \section intro Introduction
93 * The main motivation for VA-API (Video Acceleration API) is to
94 * enable hardware accelerated video decode and encode at various
95 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
96 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
97 * AVC/H.264, VC-1/VMW3, and JPEG).
99 * VA-API is split into several modules:
101 * - \ref api_enc_h264
106 * \defgroup api_core Core API
114 The VA API is intended to provide an interface between a video decode/encode/display
115 application (client) and a hardware accelerator (server), to off-load
116 video decode/encode/display operations from the host to the hardware accelerator at various
119 The basic operation steps are:
121 - Negotiate a mutually acceptable configuration with the server to lock
122 down profile, entrypoints, and other attributes that will not change on
123 a frame-by-frame basis.
124 - Create a decode context which represents a "virtualized" hardware decode
126 - Get and fill decode buffers with picture level, slice level and macroblock
127 level data (depending on entrypoints)
128 - Pass the decode buffers to the server to decode the current frame
130 Initialization & Configuration Management
132 - Find out supported profiles
133 - Find out entrypoints for a given profile
134 - Find out configuration attributes for a given profile/entrypoint pair
135 - Create a configuration for use by the decoder
139 typedef void* VADisplay; /* window system dependent */
141 typedef int VAStatus; /** Return status type from functions */
142 /** Values for the return status */
143 #define VA_STATUS_SUCCESS 0x00000000
144 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
145 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
146 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
147 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
148 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
149 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
150 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
151 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
152 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
153 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
154 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
155 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
156 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
157 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
158 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
159 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
160 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
161 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
162 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
163 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
164 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
165 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
166 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
167 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
169 * \brief An invalid/unsupported value was supplied.
171 * This is a catch-all error code for invalid or unsupported values.
172 * e.g. value exceeding the valid range, invalid type in the context
173 * of generic attribute values.
175 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
176 /** \brief An unsupported filter was supplied. */
177 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
178 /** \brief An invalid filter chain was supplied. */
179 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
180 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
181 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
182 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
184 /** De-interlacing flags for vaPutSurface() */
185 #define VA_FRAME_PICTURE 0x00000000
186 #define VA_TOP_FIELD 0x00000001
187 #define VA_BOTTOM_FIELD 0x00000002
190 * Enabled the positioning/cropping/blending feature:
191 * 1, specify the video playback position in the isurface
192 * 2, specify the cropping info for video playback
193 * 3, encoded video will blend with background color
195 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
198 * Clears the drawable with background color.
199 * for hardware overlay based implementation this flag
200 * can be used to turn off the overlay
202 #define VA_CLEAR_DRAWABLE 0x00000008
204 /** Color space conversion flags for vaPutSurface() */
205 #define VA_SRC_BT601 0x00000010
206 #define VA_SRC_BT709 0x00000020
207 #define VA_SRC_SMPTE_240 0x00000040
209 /** Scaling flags for vaPutSurface() */
210 #define VA_FILTER_SCALING_DEFAULT 0x00000000
211 #define VA_FILTER_SCALING_FAST 0x00000100
212 #define VA_FILTER_SCALING_HQ 0x00000200
213 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
214 #define VA_FILTER_SCALING_MASK 0x00000f00
217 * Returns a short english description of error_status
219 const char *vaErrorStr(VAStatus error_status);
223 * A display must be obtained by calling vaGetDisplay() before calling
224 * vaInitialize() and other functions. This connects the API to the
225 * native window system.
226 * For X Windows, native_dpy would be from XOpenDisplay()
228 typedef void* VANativeDisplay; /* window system dependent */
230 int vaDisplayIsValid(VADisplay dpy);
233 * Initialize the library
235 VAStatus vaInitialize (
237 int *major_version, /* out */
238 int *minor_version /* out */
242 * After this call, all library internal resources will be cleaned up
244 VAStatus vaTerminate (
249 * vaQueryVendorString returns a pointer to a zero-terminated string
250 * describing some aspects of the VA implemenation on a specific
251 * hardware accelerator. The format of the returned string is vendor
252 * specific and at the discretion of the implementer.
253 * e.g. for the Intel GMA500 implementation, an example would be:
254 * "Intel GMA500 - 2.0.0.32L.0005"
256 const char *vaQueryVendorString (
260 typedef int (*VAPrivFunc)();
263 * Return a function pointer given a function name in the library.
264 * This allows private interfaces into the library
266 VAPrivFunc vaGetLibFunc (
271 /** Currently defined profiles */
274 /** \brief Profile ID used for video processing. */
276 VAProfileMPEG2Simple = 0,
277 VAProfileMPEG2Main = 1,
278 VAProfileMPEG4Simple = 2,
279 VAProfileMPEG4AdvancedSimple = 3,
280 VAProfileMPEG4Main = 4,
281 VAProfileH264Baseline = 5,
282 VAProfileH264Main = 6,
283 VAProfileH264High = 7,
284 VAProfileVC1Simple = 8,
285 VAProfileVC1Main = 9,
286 VAProfileVC1Advanced = 10,
287 VAProfileH263Baseline = 11,
288 VAProfileJPEGBaseline = 12,
289 VAProfileH264ConstrainedBaseline = 13,
290 VAProfileVP8Version0_3 = 14,
291 VAProfileH264MultiviewHigh = 15,
292 VAProfileH264StereoHigh = 16
296 * Currently defined entrypoints
302 VAEntrypointIDCT = 3,
303 VAEntrypointMoComp = 4,
304 VAEntrypointDeblocking = 5,
305 VAEntrypointEncSlice = 6, /* slice level encode */
306 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
307 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
310 /** Currently defined configuration attribute types */
313 VAConfigAttribRTFormat = 0,
314 VAConfigAttribSpatialResidual = 1,
315 VAConfigAttribSpatialClipping = 2,
316 VAConfigAttribIntraResidual = 3,
317 VAConfigAttribEncryption = 4,
318 VAConfigAttribRateControl = 5,
320 /** @name Attributes for encoding */
323 * \brief Packed headers mode. Read/write.
325 * This attribute determines what packed headers the driver supports,
326 * through vaGetConfigAttributes(); and what packed headers the user
327 * will be providing to the driver, through vaCreateConfig(), if the
328 * driver supports those.
330 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
332 VAConfigAttribEncPackedHeaders = 10,
334 * \brief Interlaced mode. Read/write.
336 * This attribute determines what kind of interlaced encoding mode
337 * the driver supports.
339 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
341 VAConfigAttribEncInterlaced = 11,
343 * \brief Maximum number of reference frames. Read-only.
345 * This attribute determines the maximum number of reference
346 * frames supported for encoding.
348 * Note: for H.264 encoding, the value represents the maximum number
349 * of reference frames for both the reference picture list 0 (bottom
350 * 16 bits) and the reference picture list 1 (top 16 bits).
352 VAConfigAttribEncMaxRefFrames = 13,
354 * \brief Maximum number of slices per frame. Read-only.
356 * This attribute determines the maximum number of slices the
357 * driver can support to encode a single frame.
359 VAConfigAttribEncMaxSlices = 14,
361 * \brief Slice structure. Read-only.
363 * This attribute determines slice structures supported by the
364 * driver for encoding. This attribute is a hint to the user so
365 * that he can choose a suitable surface size and how to arrange
366 * the encoding process of multiple slices per frame.
368 * More specifically, for H.264 encoding, this attribute
369 * determines the range of accepted values to
370 * VAEncSliceParameterBufferH264::macroblock_address and
371 * VAEncSliceParameterBufferH264::num_macroblocks.
373 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
376 VAConfigAttribEncSliceStructure = 15,
378 * \brief Macroblock information. Read-only.
380 * This attribute determines whether the driver supports extra
381 * encoding information per-macroblock. e.g. QP.
383 * More specifically, for H.264 encoding, if the driver returns a non-zero
384 * value for this attribute, this means the application can create
385 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
386 * through VAEncSliceParameterBufferH264::macroblock_info.
388 VAConfigAttribEncMacroblockInfo = 16,
390 VAConfigAttribTypeMax
391 } VAConfigAttribType;
394 * Configuration attributes
395 * If there is more than one value for an attribute, a default
396 * value will be assigned to the attribute if the client does not
397 * specify the attribute when creating a configuration
399 typedef struct _VAConfigAttrib {
400 VAConfigAttribType type;
401 unsigned int value; /* OR'd flags (bits) for this attribute */
404 /** attribute value for VAConfigAttribRTFormat */
405 #define VA_RT_FORMAT_YUV420 0x00000001
406 #define VA_RT_FORMAT_YUV422 0x00000002
407 #define VA_RT_FORMAT_YUV444 0x00000004
408 #define VA_RT_FORMAT_YUV411 0x00000008
409 #define VA_RT_FORMAT_YUV400 0x00000010
410 #define VA_RT_FORMAT_RGB16 0x00010000
411 #define VA_RT_FORMAT_RGB32 0x00020000
412 /* RGBP covers RGBP and BGRP fourcc */
413 #define VA_RT_FORMAT_RGBP 0x00100000
414 #define VA_RT_FORMAT_PROTECTED 0x80000000
416 /** @name Attribute values for VAConfigAttribRateControl */
418 /** \brief Driver does not support any form of rate control. */
419 #define VA_RC_NONE 0x00000001
420 /** \brief Constant bitrate. */
421 #define VA_RC_CBR 0x00000002
422 /** \brief Variable bitrate. */
423 #define VA_RC_VBR 0x00000004
424 /** \brief Video conference mode. */
425 #define VA_RC_VCM 0x00000008
426 /** \brief Constant QP. */
427 #define VA_RC_CQP 0x00000010
428 /** \brief Variable bitrate with peak rate higher than average bitrate. */
429 #define VA_RC_VBR_CONSTRAINED 0x00000020
432 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
434 /** \brief Driver does not support any packed headers mode. */
435 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
436 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
437 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
438 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
439 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
440 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
441 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
442 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
443 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
444 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
445 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
448 /** @name Attribute values for VAConfigAttribEncInterlaced */
450 /** \brief Driver does not support interlaced coding. */
451 #define VA_ENC_INTERLACED_NONE 0x00000000
452 /** \brief Driver supports interlaced frame coding. */
453 #define VA_ENC_INTERLACED_FRAME 0x00000001
454 /** \brief Driver supports interlaced field coding. */
455 #define VA_ENC_INTERLACED_FIELD 0x00000002
456 /** \brief Driver supports macroblock adaptive frame field coding. */
457 #define VA_ENC_INTERLACED_MBAFF 0x00000004
458 /** \brief Driver supports picture adaptive frame field coding. */
459 #define VA_ENC_INTERLACED_PAFF 0x00000008
462 /** @name Attribute values for VAConfigAttribEncSliceStructure */
464 /** \brief Driver supports an arbitrary number of rows per slice. */
465 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
466 /** \brief Driver supports a power-of-two number of rows per slice. */
467 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
468 /** \brief Driver supports an arbitrary number of rows per slice. */
469 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
473 * if an attribute is not applicable for a given
474 * profile/entrypoint pair, then set the value to the following
476 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
478 /** Get maximum number of profiles supported by the implementation */
479 int vaMaxNumProfiles (
483 /** Get maximum number of entrypoints supported by the implementation */
484 int vaMaxNumEntrypoints (
488 /** Get maximum number of attributs supported by the implementation */
489 int vaMaxNumConfigAttributes (
494 * Query supported profiles
495 * The caller must provide a "profile_list" array that can hold at
496 * least vaMaxNumProfile() entries. The actual number of profiles
497 * returned in "profile_list" is returned in "num_profile".
499 VAStatus vaQueryConfigProfiles (
501 VAProfile *profile_list, /* out */
502 int *num_profiles /* out */
506 * Query supported entrypoints for a given profile
507 * The caller must provide an "entrypoint_list" array that can hold at
508 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
509 * returned in "entrypoint_list" is returned in "num_entrypoints".
511 VAStatus vaQueryConfigEntrypoints (
514 VAEntrypoint *entrypoint_list, /* out */
515 int *num_entrypoints /* out */
519 * Get attributes for a given profile/entrypoint pair
520 * The caller must provide an "attrib_list" with all attributes to be
521 * retrieved. Upon return, the attributes in "attrib_list" have been
522 * updated with their value. Unknown attributes or attributes that are
523 * not supported for the given profile/entrypoint pair will have their
524 * value set to VA_ATTRIB_NOT_SUPPORTED
526 VAStatus vaGetConfigAttributes (
529 VAEntrypoint entrypoint,
530 VAConfigAttrib *attrib_list, /* in/out */
534 /** Generic ID type, can be re-typed for specific implementation */
535 typedef unsigned int VAGenericID;
537 typedef VAGenericID VAConfigID;
540 * Create a configuration for the decode pipeline
541 * it passes in the attribute list that specifies the attributes it cares
542 * about, with the rest taking default values.
544 VAStatus vaCreateConfig (
547 VAEntrypoint entrypoint,
548 VAConfigAttrib *attrib_list,
550 VAConfigID *config_id /* out */
554 * Free resources associdated with a given config
556 VAStatus vaDestroyConfig (
562 * Query all attributes for a given configuration
563 * The profile of the configuration is returned in "profile"
564 * The entrypoint of the configuration is returned in "entrypoint"
565 * The caller must provide an "attrib_list" array that can hold at least
566 * vaMaxNumConfigAttributes() entries. The actual number of attributes
567 * returned in "attrib_list" is returned in "num_attribs"
569 VAStatus vaQueryConfigAttributes (
571 VAConfigID config_id,
572 VAProfile *profile, /* out */
573 VAEntrypoint *entrypoint, /* out */
574 VAConfigAttrib *attrib_list,/* out */
575 int *num_attribs /* out */
580 * Contexts and Surfaces
582 * Context represents a "virtual" video decode pipeline. Surfaces are render
583 * targets for a given context. The data in the surfaces are not accessible
584 * to the client and the internal data format of the surface is implementatin
587 * Surfaces will be bound to a context when the context is created. Once
588 * a surface is bound to a given context, it can not be used to create
589 * another context. The association is removed when the context is destroyed
591 * Both contexts and surfaces are identified by unique IDs and its
592 * implementation specific internals are kept opaque to the clients
595 typedef VAGenericID VAContextID;
597 typedef VAGenericID VASurfaceID;
599 #define VA_INVALID_ID 0xffffffff
600 #define VA_INVALID_SURFACE VA_INVALID_ID
602 /** \brief Generic value types. */
604 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
605 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
606 VAGenericValueTypePointer, /**< Generic pointer type */
607 VAGenericValueTypeFunc /**< Pointer to function */
608 } VAGenericValueType;
610 /** \brief Generic function type. */
611 typedef void (*VAGenericFunc)(void);
613 /** \brief Generic value. */
614 typedef struct _VAGenericValue {
615 /** \brief Value type. See #VAGenericValueType. */
616 VAGenericValueType type;
617 /** \brief Value holder. */
619 /** \brief 32-bit signed integer. */
621 /** \brief 32-bit float. */
623 /** \brief Generic pointer. */
625 /** \brief Pointer to function. */
630 /** @name Surface attribute flags */
632 /** \brief Surface attribute is not supported. */
633 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
634 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
635 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
636 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
637 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
640 /** \brief Surface attribute types. */
642 VASurfaceAttribNone = 0,
644 * \brief Pixel format (fourcc).
646 * The value is meaningful as input to vaQuerySurfaceAttributes().
647 * If zero, the driver returns the optimal pixel format for the
648 * specified config. Otherwise, if non-zero, the value represents
649 * a pixel format (FOURCC) that is kept as is on output, if the
650 * driver supports it. Otherwise, the driver sets the value to
651 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
653 VASurfaceAttribPixelFormat,
654 /** \brief Minimal width in pixels (int, read-only). */
655 VASurfaceAttribMinWidth,
656 /** \brief Maximal width in pixels (int, read-only). */
657 VASurfaceAttribMaxWidth,
658 /** \brief Minimal height in pixels (int, read-only). */
659 VASurfaceAttribMinHeight,
660 /** \brief Maximal height in pixels (int, read-only). */
661 VASurfaceAttribMaxHeight,
662 /** \brief Surface memory type expressed in bit fields (int, read/write). */
663 VASurfaceAttribMemoryType,
664 /** \brief External buffer descriptor (pointer, write). */
665 VASurfaceAttribExternalBufferDescriptor,
666 /** \brief Number of surface attributes. */
668 } VASurfaceAttribType;
670 /** \brief Surface attribute. */
671 typedef struct _VASurfaceAttrib {
673 VASurfaceAttribType type;
674 /** \brief Flags. See "Surface attribute flags". */
676 /** \brief Value. See "Surface attribute types" for the expected types. */
677 VAGenericValue value;
681 * @name VASurfaceAttribMemoryType values in bit fields.
682 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
683 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
684 * types are defined in DRM and Android header files.
687 /** \brief VA memory type (default) is supported. */
688 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
689 /** \brief V4L2 buffer memory type is supported. */
690 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
691 /** \brief User pointer memory type is supported. */
692 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
696 * \brief VASurfaceAttribExternalBuffers structure for
697 * the VASurfaceAttribExternalBufferDescriptor attribute.
699 typedef struct _VASurfaceAttribExternalBuffers {
700 /** \brief pixel format in fourcc. */
701 unsigned int pixel_format;
702 /** \brief width in pixels. */
704 /** \brief height in pixels. */
706 /** \brief total size of the buffer in bytes. */
707 unsigned int data_size;
708 /** \brief number of planes for planar layout */
709 unsigned int num_planes;
710 /** \brief pitch for each plane in bytes */
711 unsigned int pitches[4];
712 /** \brief offset for each plane in bytes */
713 unsigned int offsets[4];
714 /** \brief buffer handles or user pointers */
715 unsigned long *buffers;
716 /** \brief number of elements in the "buffers" array */
717 unsigned int num_buffers;
718 /** \brief flags. See "Surface external buffer descriptor flags". */
720 /** \brief reserved for passing private data */
722 } VASurfaceAttribExternalBuffers;
724 /** @name VASurfaceAttribExternalBuffers flags */
726 /** \brief Enable memory tiling */
727 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
728 /** \brief Memory is cacheable */
729 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
730 /** \brief Memory is non-cacheable */
731 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
732 /** \brief Memory is write-combined */
733 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
734 /** \brief Memory is protected */
735 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
740 * \brief Queries surface attributes for the supplied config.
742 * Unlike vaGetSurfaceAttributes(), this function queries for all
743 * supported attributes for the supplied VA @config. In particular, if
744 * the underlying hardware supports the creation of VA surfaces in
745 * various formats, then this function will enumerate all pixel
746 * formats that are supported.
748 * The \c attrib_list array is allocated by the user and \c
749 * num_attribs shall be initialized to the number of allocated
750 * elements in that array. Upon successful return, the actual number
751 * of attributes will be overwritten into \c num_attribs. Otherwise,
752 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
753 * is adjusted to the number of elements that would be returned if
754 * enough space was available.
756 * Note: it is perfectly valid to pass NULL to the \c attrib_list
757 * argument when vaQuerySurfaceAttributes() is used to determine the
758 * actual number of elements that need to be allocated.
760 * @param[in] dpy the VA display
761 * @param[in] config the config identifying a codec or a video
762 * processing pipeline
763 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
764 * @param[in,out] num_attribs the number of elements allocated on
765 * input, the number of elements actually filled in output
768 vaQuerySurfaceAttributes(
771 VASurfaceAttrib *attrib_list,
772 unsigned int *num_attribs
776 * \brief Creates an array of surfaces
778 * Creates an array of surfaces. The optional list of attributes shall
779 * be constructed and validated through vaGetSurfaceAttributes() or
780 * constructed based based on what the underlying hardware could
781 * expose through vaQuerySurfaceAttributes().
783 * @param[in] dpy the VA display
784 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
785 * @param[in] width the surface width
786 * @param[in] height the surface height
787 * @param[out] surfaces the array of newly created surfaces
788 * @param[in] num_surfaces the number of surfaces to create
789 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
790 * @param[in] num_attribs the number of attributes supplied in
791 * \c attrib_list, or zero
799 VASurfaceID *surfaces,
800 unsigned int num_surfaces,
801 VASurfaceAttrib *attrib_list,
802 unsigned int num_attribs
806 * vaDestroySurfaces - Destroy resources associated with surfaces.
807 * Surfaces can only be destroyed after the context associated has been
810 * surfaces: array of surfaces to destroy
811 * num_surfaces: number of surfaces in the array to be destroyed.
813 VAStatus vaDestroySurfaces (
815 VASurfaceID *surfaces,
819 #define VA_PROGRESSIVE 0x1
821 * vaCreateContext - Create a context
823 * config_id: configuration for the context
824 * picture_width: coded picture width
825 * picture_height: coded picture height
826 * flag: any combination of the following:
827 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
828 * render_targets: render targets (surfaces) tied to the context
829 * num_render_targets: number of render targets in the above array
830 * context: created context id upon return
832 VAStatus vaCreateContext (
834 VAConfigID config_id,
838 VASurfaceID *render_targets,
839 int num_render_targets,
840 VAContextID *context /* out */
844 * vaDestroyContext - Destroy a context
846 * context: context to be destroyed
848 VAStatus vaDestroyContext (
855 * Buffers are used to pass various types of data from the
856 * client to the server. The server maintains a data store
857 * for each buffer created, and the client idenfies a buffer
858 * through a unique buffer id assigned by the server.
861 typedef VAGenericID VABufferID;
865 VAPictureParameterBufferType = 0,
866 VAIQMatrixBufferType = 1,
867 VABitPlaneBufferType = 2,
868 VASliceGroupMapBufferType = 3,
869 VASliceParameterBufferType = 4,
870 VASliceDataBufferType = 5,
871 VAMacroblockParameterBufferType = 6,
872 VAResidualDataBufferType = 7,
873 VADeblockingParameterBufferType = 8,
874 VAImageBufferType = 9,
875 VAProtectedSliceDataBufferType = 10,
876 VAQMatrixBufferType = 11,
877 VAHuffmanTableBufferType = 12,
878 VAProbabilityBufferType = 13,
880 /* Following are encode buffer types */
881 VAEncCodedBufferType = 21,
882 VAEncSequenceParameterBufferType = 22,
883 VAEncPictureParameterBufferType = 23,
884 VAEncSliceParameterBufferType = 24,
885 VAEncPackedHeaderParameterBufferType = 25,
886 VAEncPackedHeaderDataBufferType = 26,
887 VAEncMiscParameterBufferType = 27,
888 VAEncMacroblockParameterBufferType = 28,
889 VAEncMacroblockMapBufferType = 29,
890 /* Following are video processing buffer types */
892 * \brief Video processing pipeline parameter buffer.
894 * This buffer describes the video processing pipeline. See
895 * #VAProcPipelineParameterBuffer for details.
897 VAProcPipelineParameterBufferType = 41,
899 * \brief Video filter parameter buffer.
901 * This buffer describes the video filter parameters. All buffers
902 * inherit from #VAProcFilterParameterBufferBase, thus including
903 * a unique filter buffer type.
905 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
906 * Filters requiring advanced parameters include, but are not limited to,
907 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
908 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
910 VAProcFilterParameterBufferType = 42,
916 VAEncMiscParameterTypeFrameRate = 0,
917 VAEncMiscParameterTypeRateControl = 1,
918 VAEncMiscParameterTypeMaxSliceSize = 2,
919 VAEncMiscParameterTypeAIR = 3,
920 /** \brief Buffer type used to express a maximum frame size (in bits). */
921 VAEncMiscParameterTypeMaxFrameSize = 4,
922 /** \brief Buffer type used for HRD parameters. */
923 VAEncMiscParameterTypeHRD = 5,
924 } VAEncMiscParameterType;
926 /** \brief Packed header type. */
928 /** \brief Packed sequence header. */
929 VAEncPackedHeaderSequence = 1,
930 /** \brief Packed picture header. */
931 VAEncPackedHeaderPicture = 2,
932 /** \brief Packed slice header. */
933 VAEncPackedHeaderSlice = 3,
935 * \brief Packed raw header.
937 * Packed raw data header can be used by the client to insert a header
938 * into the bitstream data buffer at the point it is passed, the driver
939 * will handle the raw packed header based on "has_emulation_bytes" field
940 * in the packed header parameter structure.
942 VAEncPackedHeaderRawData = 4,
943 /** \brief Misc packed header. See codec-specific definitions. */
944 VAEncPackedHeaderMiscMask = 0x80000000,
945 } VAEncPackedHeaderType;
947 /** \brief Packed header parameter. */
948 typedef struct _VAEncPackedHeaderParameterBuffer {
949 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
951 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
952 unsigned int bit_length;
953 /** \brief Flag: buffer contains start code emulation prevention bytes? */
954 unsigned char has_emulation_bytes;
955 } VAEncPackedHeaderParameterBuffer;
958 * For application, e.g. set a new bitrate
960 * VAEncMiscParameterBuffer *misc_param;
961 * VAEncMiscParameterRateControl *misc_rate_ctrl;
963 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
964 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
967 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
968 * misc_param->type = VAEncMiscParameterTypeRateControl;
969 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
970 * misc_rate_ctrl->bits_per_second = 6400000;
971 * vaUnmapBuffer(dpy, buf_id);
972 * vaRenderPicture(dpy, context, &buf_id, 1);
974 typedef struct _VAEncMiscParameterBuffer
976 VAEncMiscParameterType type;
977 unsigned int data[0];
978 } VAEncMiscParameterBuffer;
981 /** \brief Rate control parameters */
982 typedef struct _VAEncMiscParameterRateControl
984 /* this is the maximum bit-rate to be constrained by the rate control implementation */
985 unsigned int bits_per_second;
986 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
987 * bit-rate for example if target_percentage is 95 then the rate control will target
988 * a bit-rate that is 95% of the maximum bit-rate
990 unsigned int target_percentage;
991 /* windows size in milliseconds. For example if this is set to 500,
992 * then the rate control will guarantee the target bit-rate over a 500 ms window
994 unsigned int window_size;
995 /* initial QP at I frames */
996 unsigned int initial_qp;
998 unsigned int basic_unit_size;
1003 unsigned int reset : 1;
1004 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1005 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1009 } VAEncMiscParameterRateControl;
1011 typedef struct _VAEncMiscParameterFrameRate
1013 unsigned int framerate;
1014 } VAEncMiscParameterFrameRate;
1017 * Allow a maximum slice size to be specified (in bits).
1018 * The encoder will attempt to make sure that individual slices do not exceed this size
1019 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1021 typedef struct _VAEncMiscParameterMaxSliceSize
1023 unsigned int max_slice_size;
1024 } VAEncMiscParameterMaxSliceSize;
1026 typedef struct _VAEncMiscParameterAIR
1028 unsigned int air_num_mbs;
1029 unsigned int air_threshold;
1030 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1031 } VAEncMiscParameterAIR;
1033 typedef struct _VAEncMiscParameterHRD
1035 unsigned int initial_buffer_fullness; /* in bits */
1036 unsigned int buffer_size; /* in bits */
1037 } VAEncMiscParameterHRD;
1040 * \brief Defines a maximum frame size (in bits).
1042 * This misc parameter buffer defines the maximum size of a frame (in
1043 * bits). The encoder will try to make sure that each frame does not
1044 * exceed this size. Otherwise, if the frame size exceeds this size,
1045 * the \c status flag of #VACodedBufferSegment will contain
1046 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1048 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1049 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1050 VAEncMiscParameterType type;
1051 /** \brief Maximum size of a frame (in bits). */
1052 unsigned int max_frame_size;
1053 } VAEncMiscParameterBufferMaxFrameSize;
1056 * There will be cases where the bitstream buffer will not have enough room to hold
1057 * the data for the entire slice, and the following flags will be used in the slice
1058 * parameter to signal to the server for the possible cases.
1059 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1060 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1061 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1063 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1064 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1065 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1066 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1068 /* Codec-independent Slice Parameter Buffer base */
1069 typedef struct _VASliceParameterBufferBase
1071 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1072 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1073 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1074 } VASliceParameterBufferBase;
1077 /****************************
1078 * JEPG data structure
1079 ***************************/
1080 typedef struct _VAQMatrixBufferJPEG
1082 int load_lum_quantiser_matrix;
1083 int load_chroma_quantiser_matrix;
1084 unsigned char lum_quantiser_matrix[64];
1085 unsigned char chroma_quantiser_matrix[64];
1086 } VAQMatrixBufferJPEG;
1088 typedef struct _VAEncPictureParameterBufferJPEG
1090 VASurfaceID reconstructed_picture;
1091 unsigned short picture_width;
1092 unsigned short picture_height;
1093 VABufferID coded_buf;
1094 } VAEncPictureParameterBufferJPEG;
1096 #include <va/va_dec_jpeg.h>
1098 /****************************
1099 * MPEG-2 data structures
1100 ****************************/
1102 /* MPEG-2 Picture Parameter Buffer */
1104 * For each frame or field, and before any slice data, a single
1105 * picture parameter buffer must be send.
1107 typedef struct _VAPictureParameterBufferMPEG2
1109 unsigned short horizontal_size;
1110 unsigned short vertical_size;
1111 VASurfaceID forward_reference_picture;
1112 VASurfaceID backward_reference_picture;
1113 /* meanings of the following fields are the same as in the standard */
1114 int picture_coding_type;
1115 int f_code; /* pack all four fcode into this */
1118 unsigned int intra_dc_precision : 2;
1119 unsigned int picture_structure : 2;
1120 unsigned int top_field_first : 1;
1121 unsigned int frame_pred_frame_dct : 1;
1122 unsigned int concealment_motion_vectors : 1;
1123 unsigned int q_scale_type : 1;
1124 unsigned int intra_vlc_format : 1;
1125 unsigned int alternate_scan : 1;
1126 unsigned int repeat_first_field : 1;
1127 unsigned int progressive_frame : 1;
1128 unsigned int is_first_field : 1; /* indicate whether the current field
1129 * is the first field for field picture
1133 } picture_coding_extension;
1134 } VAPictureParameterBufferMPEG2;
1136 /** MPEG-2 Inverse Quantization Matrix Buffer */
1137 typedef struct _VAIQMatrixBufferMPEG2
1139 int load_intra_quantiser_matrix;
1140 int load_non_intra_quantiser_matrix;
1141 int load_chroma_intra_quantiser_matrix;
1142 int load_chroma_non_intra_quantiser_matrix;
1143 unsigned char intra_quantiser_matrix[64];
1144 unsigned char non_intra_quantiser_matrix[64];
1145 unsigned char chroma_intra_quantiser_matrix[64];
1146 unsigned char chroma_non_intra_quantiser_matrix[64];
1147 } VAIQMatrixBufferMPEG2;
1149 /** MPEG-2 Slice Parameter Buffer */
1150 typedef struct _VASliceParameterBufferMPEG2
1152 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1153 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1154 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1155 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1156 unsigned int slice_horizontal_position;
1157 unsigned int slice_vertical_position;
1158 int quantiser_scale_code;
1159 int intra_slice_flag;
1160 } VASliceParameterBufferMPEG2;
1162 /** MPEG-2 Macroblock Parameter Buffer */
1163 typedef struct _VAMacroblockParameterBufferMPEG2
1165 unsigned short macroblock_address;
1167 * macroblock_address (in raster scan order)
1169 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1171 unsigned char macroblock_type; /* see definition below */
1174 unsigned int frame_motion_type : 2;
1175 unsigned int field_motion_type : 2;
1176 unsigned int dct_type : 1;
1180 unsigned char motion_vertical_field_select;
1182 * motion_vertical_field_select:
1183 * see section 6.3.17.2 in the spec
1184 * only the lower 4 bits are used
1185 * bit 0: first vector forward
1186 * bit 1: first vector backward
1187 * bit 2: second vector forward
1188 * bit 3: second vector backward
1190 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1191 unsigned short coded_block_pattern;
1193 * The bitplanes for coded_block_pattern are described
1194 * in Figure 6.10-12 in the spec
1197 /* Number of skipped macroblocks after this macroblock */
1198 unsigned short num_skipped_macroblocks;
1199 } VAMacroblockParameterBufferMPEG2;
1202 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1204 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1205 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1206 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1207 #define VA_MB_TYPE_MOTION_INTRA 0x10
1210 * MPEG-2 Residual Data Buffer
1211 * For each macroblock, there wil be 64 shorts (16-bit) in the
1212 * residual data buffer
1215 /****************************
1216 * MPEG-4 Part 2 data structures
1217 ****************************/
1219 /* MPEG-4 Picture Parameter Buffer */
1221 * For each frame or field, and before any slice data, a single
1222 * picture parameter buffer must be send.
1224 typedef struct _VAPictureParameterBufferMPEG4
1226 unsigned short vop_width;
1227 unsigned short vop_height;
1228 VASurfaceID forward_reference_picture;
1229 VASurfaceID backward_reference_picture;
1232 unsigned int short_video_header : 1;
1233 unsigned int chroma_format : 2;
1234 unsigned int interlaced : 1;
1235 unsigned int obmc_disable : 1;
1236 unsigned int sprite_enable : 2;
1237 unsigned int sprite_warping_accuracy : 2;
1238 unsigned int quant_type : 1;
1239 unsigned int quarter_sample : 1;
1240 unsigned int data_partitioned : 1;
1241 unsigned int reversible_vlc : 1;
1242 unsigned int resync_marker_disable : 1;
1246 unsigned char no_of_sprite_warping_points;
1247 short sprite_trajectory_du[3];
1248 short sprite_trajectory_dv[3];
1249 unsigned char quant_precision;
1252 unsigned int vop_coding_type : 2;
1253 unsigned int backward_reference_vop_coding_type : 2;
1254 unsigned int vop_rounding_type : 1;
1255 unsigned int intra_dc_vlc_thr : 3;
1256 unsigned int top_field_first : 1;
1257 unsigned int alternate_vertical_scan_flag : 1;
1261 unsigned char vop_fcode_forward;
1262 unsigned char vop_fcode_backward;
1263 unsigned short vop_time_increment_resolution;
1264 /* short header related */
1265 unsigned char num_gobs_in_vop;
1266 unsigned char num_macroblocks_in_gob;
1267 /* for direct mode prediction */
1270 } VAPictureParameterBufferMPEG4;
1272 /** MPEG-4 Inverse Quantization Matrix Buffer */
1273 typedef struct _VAIQMatrixBufferMPEG4
1275 int load_intra_quant_mat;
1276 int load_non_intra_quant_mat;
1277 unsigned char intra_quant_mat[64];
1278 unsigned char non_intra_quant_mat[64];
1279 } VAIQMatrixBufferMPEG4;
1281 /** MPEG-4 Slice Parameter Buffer */
1282 typedef struct _VASliceParameterBufferMPEG4
1284 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1285 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1286 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1287 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1288 unsigned int macroblock_number;
1290 } VASliceParameterBufferMPEG4;
1293 VC-1 data structures
1296 typedef enum /* see 7.1.1.32 */
1299 VAMvMode1MvHalfPel = 1,
1300 VAMvMode1MvHalfPelBilinear = 2,
1301 VAMvModeMixedMv = 3,
1302 VAMvModeIntensityCompensation = 4
1305 /** VC-1 Picture Parameter Buffer */
1307 * For each picture, and before any slice data, a picture parameter
1308 * buffer must be send. Multiple picture parameter buffers may be
1309 * sent for a single picture. In that case picture parameters will
1310 * apply to all slice data that follow it until a new picture
1311 * parameter buffer is sent.
1314 * pic_quantizer_type should be set to the applicable quantizer
1315 * type as defined by QUANTIZER (J.1.19) and either
1316 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1318 typedef struct _VAPictureParameterBufferVC1
1320 VASurfaceID forward_reference_picture;
1321 VASurfaceID backward_reference_picture;
1322 /* if out-of-loop post-processing is done on the render
1323 target, then we need to keep the in-loop decoded
1324 picture as a reference picture */
1325 VASurfaceID inloop_decoded_picture;
1327 /* sequence layer for AP or meta data for SP and MP */
1330 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1331 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1332 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1333 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1334 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1335 unsigned int multires : 1; /* METADATA::MULTIRES */
1336 unsigned int overlap : 1; /* METADATA::OVERLAP */
1337 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1338 unsigned int rangered : 1; /* METADATA::RANGERED */
1339 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1340 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1345 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1346 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1349 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1350 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1351 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1352 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1355 } entrypoint_fields;
1356 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1357 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1360 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1361 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1362 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1363 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1366 } range_mapping_fields;
1368 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1369 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1370 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1371 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1372 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1373 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1374 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1375 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1376 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1379 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1380 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1381 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1382 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1383 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1389 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1390 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1391 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1392 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1393 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1394 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1395 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1401 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1402 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1403 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1404 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1405 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1406 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1407 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1410 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1413 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1414 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1415 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1416 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1422 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1423 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1424 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1425 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1426 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1427 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1428 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1429 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1430 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1431 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1437 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1438 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1439 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1440 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1441 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1442 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1443 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1444 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1445 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1446 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1447 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1450 } pic_quantizer_fields;
1453 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1454 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1455 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1456 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1457 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1458 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1462 } VAPictureParameterBufferVC1;
1464 /** VC-1 Bitplane Buffer
1465 There will be at most three bitplanes coded in any picture header. To send
1466 the bitplane data more efficiently, each byte is divided in two nibbles, with
1467 each nibble carrying three bitplanes for one macroblock. The following table
1468 shows the bitplane data arrangement within each nibble based on the picture
1471 Picture Type Bit3 Bit2 Bit1 Bit0
1472 I or BI OVERFLAGS ACPRED FIELDTX
1473 P MYTYPEMB SKIPMB DIRECTMB
1474 B FORWARDMB SKIPMB DIRECTMB
1476 Within each byte, the lower nibble is for the first MB and the upper nibble is
1477 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1478 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1479 Macroblock #2 in the first row.
1482 /* VC-1 Slice Parameter Buffer */
1483 typedef struct _VASliceParameterBufferVC1
1485 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1486 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1487 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1488 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1489 unsigned int slice_vertical_position;
1490 } VASliceParameterBufferVC1;
1492 /* VC-1 Slice Data Buffer */
1494 This is simplely a buffer containing raw bit-stream bytes
1497 /****************************
1498 * H.264/AVC data structures
1499 ****************************/
1501 typedef struct _VAPictureH264
1503 VASurfaceID picture_id;
1504 unsigned int frame_idx;
1506 signed int TopFieldOrderCnt;
1507 signed int BottomFieldOrderCnt;
1509 /* flags in VAPictureH264 could be OR of the following */
1510 #define VA_PICTURE_H264_INVALID 0x00000001
1511 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1512 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1513 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1514 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1516 /** H.264 Picture Parameter Buffer */
1518 * For each picture, and before any slice data, a single
1519 * picture parameter buffer must be send.
1521 typedef struct _VAPictureParameterBufferH264
1523 VAPictureH264 CurrPic;
1524 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1525 unsigned short picture_width_in_mbs_minus1;
1526 unsigned short picture_height_in_mbs_minus1;
1527 unsigned char bit_depth_luma_minus8;
1528 unsigned char bit_depth_chroma_minus8;
1529 unsigned char num_ref_frames;
1532 unsigned int chroma_format_idc : 2;
1533 unsigned int residual_colour_transform_flag : 1;
1534 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1535 unsigned int frame_mbs_only_flag : 1;
1536 unsigned int mb_adaptive_frame_field_flag : 1;
1537 unsigned int direct_8x8_inference_flag : 1;
1538 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1539 unsigned int log2_max_frame_num_minus4 : 4;
1540 unsigned int pic_order_cnt_type : 2;
1541 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1542 unsigned int delta_pic_order_always_zero_flag : 1;
1546 unsigned char num_slice_groups_minus1;
1547 unsigned char slice_group_map_type;
1548 unsigned short slice_group_change_rate_minus1;
1549 signed char pic_init_qp_minus26;
1550 signed char pic_init_qs_minus26;
1551 signed char chroma_qp_index_offset;
1552 signed char second_chroma_qp_index_offset;
1555 unsigned int entropy_coding_mode_flag : 1;
1556 unsigned int weighted_pred_flag : 1;
1557 unsigned int weighted_bipred_idc : 2;
1558 unsigned int transform_8x8_mode_flag : 1;
1559 unsigned int field_pic_flag : 1;
1560 unsigned int constrained_intra_pred_flag : 1;
1561 unsigned int pic_order_present_flag : 1;
1562 unsigned int deblocking_filter_control_present_flag : 1;
1563 unsigned int redundant_pic_cnt_present_flag : 1;
1564 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1568 unsigned short frame_num;
1569 } VAPictureParameterBufferH264;
1571 /** H.264 Inverse Quantization Matrix Buffer */
1572 typedef struct _VAIQMatrixBufferH264
1574 unsigned char ScalingList4x4[6][16];
1575 unsigned char ScalingList8x8[2][64];
1576 } VAIQMatrixBufferH264;
1579 * H.264 Slice Group Map Buffer
1580 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1581 * A slice group map buffer should be sent for each picture if required. The buffer
1582 * is sent only when there is a change in the mapping values.
1583 * The slice group map buffer map "map units" to slice groups as specified in
1584 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1585 * in raster scan order
1588 /** H.264 Slice Parameter Buffer */
1589 typedef struct _VASliceParameterBufferH264
1591 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1592 /** \brief Byte offset to the NAL Header Unit for this slice. */
1593 unsigned int slice_data_offset;
1594 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1596 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1598 * This bit offset is relative to and includes the NAL unit byte
1599 * and represents the number of bits parsed in the slice_header()
1600 * after the removal of any emulation prevention bytes in
1601 * there. However, the slice data buffer passed to the hardware is
1602 * the original bitstream, thus including any emulation prevention
1605 unsigned short slice_data_bit_offset;
1606 unsigned short first_mb_in_slice;
1607 unsigned char slice_type;
1608 unsigned char direct_spatial_mv_pred_flag;
1609 unsigned char num_ref_idx_l0_active_minus1;
1610 unsigned char num_ref_idx_l1_active_minus1;
1611 unsigned char cabac_init_idc;
1612 char slice_qp_delta;
1613 unsigned char disable_deblocking_filter_idc;
1614 char slice_alpha_c0_offset_div2;
1615 char slice_beta_offset_div2;
1616 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1617 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1618 unsigned char luma_log2_weight_denom;
1619 unsigned char chroma_log2_weight_denom;
1620 unsigned char luma_weight_l0_flag;
1621 short luma_weight_l0[32];
1622 short luma_offset_l0[32];
1623 unsigned char chroma_weight_l0_flag;
1624 short chroma_weight_l0[32][2];
1625 short chroma_offset_l0[32][2];
1626 unsigned char luma_weight_l1_flag;
1627 short luma_weight_l1[32];
1628 short luma_offset_l1[32];
1629 unsigned char chroma_weight_l1_flag;
1630 short chroma_weight_l1[32][2];
1631 short chroma_offset_l1[32][2];
1632 } VASliceParameterBufferH264;
1634 /****************************
1635 * Common encode data structures
1636 ****************************/
1639 VAEncPictureTypeIntra = 0,
1640 VAEncPictureTypePredictive = 1,
1641 VAEncPictureTypeBidirectional = 2,
1644 /* Encode Slice Parameter Buffer */
1645 typedef struct _VAEncSliceParameterBuffer
1647 unsigned int start_row_number; /* starting MB row number for this slice */
1648 unsigned int slice_height; /* slice height measured in MB */
1651 unsigned int is_intra : 1;
1652 unsigned int disable_deblocking_filter_idc : 2;
1653 unsigned int uses_long_term_ref :1;
1654 unsigned int is_long_term_ref :1;
1658 } VAEncSliceParameterBuffer;
1661 /****************************
1662 * H.263 specific encode data structures
1663 ****************************/
1665 typedef struct _VAEncSequenceParameterBufferH263
1667 unsigned int intra_period;
1668 unsigned int bits_per_second;
1669 unsigned int frame_rate;
1670 unsigned int initial_qp;
1671 unsigned int min_qp;
1672 } VAEncSequenceParameterBufferH263;
1674 typedef struct _VAEncPictureParameterBufferH263
1676 VASurfaceID reference_picture;
1677 VASurfaceID reconstructed_picture;
1678 VABufferID coded_buf;
1679 unsigned short picture_width;
1680 unsigned short picture_height;
1681 VAEncPictureType picture_type;
1682 } VAEncPictureParameterBufferH263;
1684 /****************************
1685 * MPEG-4 specific encode data structures
1686 ****************************/
1688 typedef struct _VAEncSequenceParameterBufferMPEG4
1690 unsigned char profile_and_level_indication;
1691 unsigned int intra_period;
1692 unsigned int video_object_layer_width;
1693 unsigned int video_object_layer_height;
1694 unsigned int vop_time_increment_resolution;
1695 unsigned int fixed_vop_rate;
1696 unsigned int fixed_vop_time_increment;
1697 unsigned int bits_per_second;
1698 unsigned int frame_rate;
1699 unsigned int initial_qp;
1700 unsigned int min_qp;
1701 } VAEncSequenceParameterBufferMPEG4;
1703 typedef struct _VAEncPictureParameterBufferMPEG4
1705 VASurfaceID reference_picture;
1706 VASurfaceID reconstructed_picture;
1707 VABufferID coded_buf;
1708 unsigned short picture_width;
1709 unsigned short picture_height;
1710 unsigned int modulo_time_base; /* number of 1s */
1711 unsigned int vop_time_increment;
1712 VAEncPictureType picture_type;
1713 } VAEncPictureParameterBufferMPEG4;
1717 /** Buffer functions */
1720 * Creates a buffer for "num_elements" elements of "size" bytes and
1721 * initalize with "data".
1722 * if "data" is null, then the contents of the buffer data store
1724 * Basically there are two ways to get buffer data to the server side. One is
1725 * to call vaCreateBuffer() with a non-null "data", which results the data being
1726 * copied to the data store on the server side. A different method that
1727 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1728 * and then use vaMapBuffer() to map the data store from the server side to the
1729 * client address space for access.
1730 * Note: image buffers are created by the library, not the client. Please see
1731 * vaCreateImage on how image buffers are managed.
1733 VAStatus vaCreateBuffer (
1735 VAContextID context,
1736 VABufferType type, /* in */
1737 unsigned int size, /* in */
1738 unsigned int num_elements, /* in */
1739 void *data, /* in */
1740 VABufferID *buf_id /* out */
1744 * Convey to the server how many valid elements are in the buffer.
1745 * e.g. if multiple slice parameters are being held in a single buffer,
1746 * this will communicate to the server the number of slice parameters
1747 * that are valid in the buffer.
1749 VAStatus vaBufferSetNumElements (
1751 VABufferID buf_id, /* in */
1752 unsigned int num_elements /* in */
1757 * device independent data structure for codedbuffer
1761 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1762 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1763 * enough for the encoder to attempt to limit its size.
1764 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1765 * exceeded the maximum slice size specified.
1766 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1767 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1768 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1770 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1771 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1772 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1773 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1774 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1776 * \brief The frame has exceeded the maximum requested size.
1778 * This flag indicates that the encoded frame size exceeds the value
1779 * specified through a misc parameter buffer of type
1780 * #VAEncMiscParameterTypeMaxFrameSize.
1782 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1783 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1786 * \brief The coded buffer segment contains a single NAL unit.
1788 * This flag indicates that the coded buffer segment contains a
1789 * single NAL unit. This flag might be useful to the user for
1790 * processing the coded buffer.
1792 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1795 * \brief Coded buffer segment.
1797 * #VACodedBufferSegment is an element of a linked list describing
1798 * some information on the coded buffer. The coded buffer segment
1799 * could contain either a single NAL unit, or more than one NAL unit.
1800 * It is recommended (but not required) to return a single NAL unit
1801 * in a coded buffer segment, and the implementation should set the
1802 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1804 typedef struct _VACodedBufferSegment {
1806 * \brief Size of the data buffer in this segment (in bytes).
1809 /** \brief Bit offset into the data buffer where the video data starts. */
1810 unsigned int bit_offset;
1811 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1812 unsigned int status;
1813 /** \brief Reserved for future use. */
1814 unsigned int reserved;
1815 /** \brief Pointer to the start of the data buffer. */
1818 * \brief Pointer to the next #VACodedBufferSegment element,
1819 * or \c NULL if there is none.
1822 } VACodedBufferSegment;
1825 * Map data store of the buffer into the client's address space
1826 * vaCreateBuffer() needs to be called with "data" set to NULL before
1827 * calling vaMapBuffer()
1829 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1830 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1832 VAStatus vaMapBuffer (
1834 VABufferID buf_id, /* in */
1835 void **pbuf /* out */
1839 * After client making changes to a mapped data store, it needs to
1840 * "Unmap" it to let the server know that the data is ready to be
1841 * consumed by the server
1843 VAStatus vaUnmapBuffer (
1845 VABufferID buf_id /* in */
1849 * After this call, the buffer is deleted and this buffer_id is no longer valid
1850 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1852 VAStatus vaDestroyBuffer (
1854 VABufferID buffer_id
1858 Render (Decode) Pictures
1860 A picture represents either a frame or a field.
1862 The Begin/Render/End sequence sends the decode buffers to the server
1866 * Get ready to decode a picture to a target surface
1868 VAStatus vaBeginPicture (
1870 VAContextID context,
1871 VASurfaceID render_target
1875 * Send decode buffers to the server.
1876 * Buffers are automatically destroyed afterwards
1878 VAStatus vaRenderPicture (
1880 VAContextID context,
1881 VABufferID *buffers,
1886 * Make the end of rendering for a picture.
1887 * The server should start processing all pending operations for this
1888 * surface. This call is non-blocking. The client can start another
1889 * Begin/Render/End sequence on a different render target.
1891 VAStatus vaEndPicture (
1903 * This function blocks until all pending operations on the render target
1904 * have been completed. Upon return it is safe to use the render target for a
1905 * different picture.
1907 VAStatus vaSyncSurface (
1909 VASurfaceID render_target
1914 VASurfaceRendering = 1, /* Rendering in progress */
1915 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1916 /* this status is useful if surface is used as the source */
1918 VASurfaceReady = 4, /* not being rendered or displayed */
1919 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1923 * Find out any pending ops on the render target
1925 VAStatus vaQuerySurfaceStatus (
1927 VASurfaceID render_target,
1928 VASurfaceStatus *status /* out */
1933 VADecodeSliceMissing = 0,
1934 VADecodeMBError = 1,
1935 } VADecodeErrorType;
1938 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1939 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1941 typedef struct _VASurfaceDecodeMBErrors
1943 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1944 unsigned int start_mb; /* start mb address with errors */
1945 unsigned int end_mb; /* end mb address with errors */
1946 VADecodeErrorType decode_error_type;
1947 } VASurfaceDecodeMBErrors;
1950 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1951 * it can call vaQuerySurfaceError to find out further details on the particular error.
1952 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1953 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1954 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1955 * The array is terminated if "status==-1" is detected.
1957 VAStatus vaQuerySurfaceError(
1959 VASurfaceID surface,
1960 VAStatus error_status,
1965 * Images and Subpictures
1966 * VAImage is used to either get the surface data to client memory, or
1967 * to copy image data in client memory to a surface.
1968 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1969 * is at the upper left corner with positive X to the right and positive Y down
1971 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1972 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1973 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1976 * Pre-defined fourcc codes
1978 #define VA_FOURCC_NV12 0x3231564E
1979 #define VA_FOURCC_AI44 0x34344149
1980 #define VA_FOURCC_RGBA 0x41424752
1981 #define VA_FOURCC_RGBX 0x58424752
1982 #define VA_FOURCC_BGRA 0x41524742
1983 #define VA_FOURCC_BGRX 0x58524742
1984 #define VA_FOURCC_ARGB 0x42475241
1985 #define VA_FOURCC_XRGB 0x42475258
1986 #define VA_FOURCC_ABGR 0x52474241
1987 #define VA_FOURCC_XBGR 0x52474258
1988 #define VA_FOURCC_UYVY 0x59565955
1989 #define VA_FOURCC_YUY2 0x32595559
1990 #define VA_FOURCC_AYUV 0x56555941
1991 #define VA_FOURCC_NV11 0x3131564e
1992 #define VA_FOURCC_YV12 0x32315659
1993 #define VA_FOURCC_P208 0x38303250
1994 #define VA_FOURCC_IYUV 0x56555949
1995 #define VA_FOURCC_YV24 0x34325659
1996 #define VA_FOURCC_YV32 0x32335659
1997 #define VA_FOURCC_Y800 0x30303859
1998 #define VA_FOURCC_IMC3 0x33434D49
1999 #define VA_FOURCC_411P 0x50313134
2000 #define VA_FOURCC_422H 0x48323234
2001 #define VA_FOURCC_422V 0x56323234
2002 #define VA_FOURCC_444P 0x50343434
2003 #define VA_FOURCC_RGBP 0x50424752
2004 #define VA_FOURCC_BGRP 0x50524742
2005 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2008 #define VA_LSB_FIRST 1
2009 #define VA_MSB_FIRST 2
2011 typedef struct _VAImageFormat
2013 unsigned int fourcc;
2014 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2015 unsigned int bits_per_pixel;
2016 /* for RGB formats */
2017 unsigned int depth; /* significant bits per pixel */
2018 unsigned int red_mask;
2019 unsigned int green_mask;
2020 unsigned int blue_mask;
2021 unsigned int alpha_mask;
2024 typedef VAGenericID VAImageID;
2026 typedef struct _VAImage
2028 VAImageID image_id; /* uniquely identify this image */
2029 VAImageFormat format;
2030 VABufferID buf; /* image data buffer */
2032 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2033 * data store on the server side for optimal performance. The buffer will be
2034 * created by the CreateImage function, and proper storage allocated based on the image
2035 * size and format. This buffer is managed by the library implementation, and
2036 * accessed by the client through the buffer Map/Unmap functions.
2038 unsigned short width;
2039 unsigned short height;
2040 unsigned int data_size;
2041 unsigned int num_planes; /* can not be greater than 3 */
2043 * An array indicating the scanline pitch in bytes for each plane.
2044 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2046 unsigned int pitches[3];
2048 * An array indicating the byte offset from the beginning of the image data
2049 * to the start of each plane.
2051 unsigned int offsets[3];
2053 /* The following fields are only needed for paletted formats */
2054 int num_palette_entries; /* set to zero for non-palette images */
2056 * Each component is one byte and entry_bytes indicates the number of components in
2057 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2061 * An array of ascii characters describing the order of the components within the bytes.
2062 * Only entry_bytes characters of the string are used.
2064 char component_order[4];
2067 /** Get maximum number of image formats supported by the implementation */
2068 int vaMaxNumImageFormats (
2073 * Query supported image formats
2074 * The caller must provide a "format_list" array that can hold at
2075 * least vaMaxNumImageFormats() entries. The actual number of formats
2076 * returned in "format_list" is returned in "num_formats".
2078 VAStatus vaQueryImageFormats (
2080 VAImageFormat *format_list, /* out */
2081 int *num_formats /* out */
2085 * Create a VAImage structure
2086 * The width and height fields returned in the VAImage structure may get
2087 * enlarged for some YUV formats. Upon return from this function,
2088 * image->buf has been created and proper storage allocated by the library.
2089 * The client can access the image through the Map/Unmap calls.
2091 VAStatus vaCreateImage (
2093 VAImageFormat *format,
2096 VAImage *image /* out */
2100 * Should call DestroyImage before destroying the surface it is bound to
2102 VAStatus vaDestroyImage (
2107 VAStatus vaSetImagePalette (
2111 * pointer to an array holding the palette data. The size of the array is
2112 * num_palette_entries * entry_bytes in size. The order of the components
2113 * in the palette is described by the component_order in VAImage struct
2115 unsigned char *palette
2119 * Retrive surface data into a VAImage
2120 * Image must be in a format supported by the implementation
2122 VAStatus vaGetImage (
2124 VASurfaceID surface,
2125 int x, /* coordinates of the upper left source pixel */
2127 unsigned int width, /* width and height of the region */
2128 unsigned int height,
2133 * Copy data from a VAImage to a surface
2134 * Image must be in a format supported by the implementation
2135 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2136 * shouldn't be rendered into when this is called
2138 VAStatus vaPutImage (
2140 VASurfaceID surface,
2144 unsigned int src_width,
2145 unsigned int src_height,
2148 unsigned int dest_width,
2149 unsigned int dest_height
2153 * Derive an VAImage from an existing surface.
2154 * This interface will derive a VAImage and corresponding image buffer from
2155 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2156 * direct CPU access. This operation is only possible on implementations with
2157 * direct rendering capabilities and internal surface formats that can be
2158 * represented with a VAImage. When the operation is not possible this interface
2159 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2160 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2163 * Implementations should only return success when the resulting image buffer
2164 * would be useable with vaMap/Unmap.
2166 * When directly accessing a surface special care must be taken to insure
2167 * proper synchronization with the graphics hardware. Clients should call
2168 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2169 * rendering or currently being displayed by an overlay.
2171 * Additionally nothing about the contents of a surface should be assumed
2172 * following a vaPutSurface. Implementations are free to modify the surface for
2173 * scaling or subpicture blending within a call to vaPutImage.
2175 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2176 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2177 * vaGetImage with other surfaces is supported.
2179 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2180 * image and image buffer structures will be destroyed; however, the underlying
2181 * surface will remain unchanged until freed with vaDestroySurfaces.
2183 VAStatus vaDeriveImage (
2185 VASurfaceID surface,
2186 VAImage *image /* out */
2191 * Subpicture is a special type of image that can be blended
2192 * with a surface during vaPutSurface(). Subpicture can be used to render
2193 * DVD sub-titles or closed captioning text etc.
2196 typedef VAGenericID VASubpictureID;
2198 /** Get maximum number of subpicture formats supported by the implementation */
2199 int vaMaxNumSubpictureFormats (
2203 /** flags for subpictures */
2204 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2205 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2206 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2208 * Query supported subpicture formats
2209 * The caller must provide a "format_list" array that can hold at
2210 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2211 * for each format to indicate additional capabilities for that format. The actual
2212 * number of formats returned in "format_list" is returned in "num_formats".
2213 * flags: returned value to indicate addtional capabilities
2214 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2215 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2216 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2219 VAStatus vaQuerySubpictureFormats (
2221 VAImageFormat *format_list, /* out */
2222 unsigned int *flags, /* out */
2223 unsigned int *num_formats /* out */
2227 * Subpictures are created with an image associated.
2229 VAStatus vaCreateSubpicture (
2232 VASubpictureID *subpicture /* out */
2236 * Destroy the subpicture before destroying the image it is assocated to
2238 VAStatus vaDestroySubpicture (
2240 VASubpictureID subpicture
2244 * Bind an image to the subpicture. This image will now be associated with
2245 * the subpicture instead of the one at creation.
2247 VAStatus vaSetSubpictureImage (
2249 VASubpictureID subpicture,
2254 * If chromakey is enabled, then the area where the source value falls within
2255 * the chromakey [min, max] range is transparent
2256 * The chromakey component format is the following:
2257 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2258 * For YUV: [0:7] V [8:15] U [16:23] Y
2259 * The chromakey mask can be used to mask out certain components for chromakey
2262 VAStatus vaSetSubpictureChromakey (
2264 VASubpictureID subpicture,
2265 unsigned int chromakey_min,
2266 unsigned int chromakey_max,
2267 unsigned int chromakey_mask
2271 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2272 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2273 * the overall alpha is per-pixel alpha multiplied by the global alpha
2275 VAStatus vaSetSubpictureGlobalAlpha (
2277 VASubpictureID subpicture,
2282 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2283 * It defines the region mapping between the subpicture and the target
2284 * surfaces through source and destination rectangles (with the same width and height).
2285 * Both will be displayed at the next call to vaPutSurface. Additional
2286 * associations before the call to vaPutSurface simply overrides the association.
2288 VAStatus vaAssociateSubpicture (
2290 VASubpictureID subpicture,
2291 VASurfaceID *target_surfaces,
2293 short src_x, /* upper left offset in subpicture */
2295 unsigned short src_width,
2296 unsigned short src_height,
2297 short dest_x, /* upper left offset in surface */
2299 unsigned short dest_width,
2300 unsigned short dest_height,
2302 * whether to enable chroma-keying, global-alpha, or screen relative mode
2303 * see VA_SUBPICTURE_XXX values
2309 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2311 VAStatus vaDeassociateSubpicture (
2313 VASubpictureID subpicture,
2314 VASurfaceID *target_surfaces,
2318 typedef struct _VARectangle
2322 unsigned short width;
2323 unsigned short height;
2327 * Display attributes
2328 * Display attributes are used to control things such as contrast, hue, saturation,
2329 * brightness etc. in the rendering process. The application can query what
2330 * attributes are supported by the driver, and then set the appropriate attributes
2331 * before calling vaPutSurface()
2333 /* PowerVR IEP Lite attributes */
2336 VADISPLAYATTRIB_BLE_OFF = 0x00,
2337 VADISPLAYATTRIB_BLE_LOW,
2338 VADISPLAYATTRIB_BLE_MEDIUM,
2339 VADISPLAYATTRIB_BLE_HIGH,
2340 VADISPLAYATTRIB_BLE_NONE,
2341 } VADisplayAttribBLEMode;
2343 /** attribute value for VADisplayAttribRotation */
2344 #define VA_ROTATION_NONE 0x00000000
2345 #define VA_ROTATION_90 0x00000001
2346 #define VA_ROTATION_180 0x00000002
2347 #define VA_ROTATION_270 0x00000003
2349 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2350 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2351 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2354 #define VA_RENDER_MODE_UNDEFINED 0
2355 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2356 #define VA_RENDER_MODE_LOCAL_GPU 2
2357 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2358 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2360 /** Render device */
2361 #define VA_RENDER_DEVICE_UNDEFINED 0
2362 #define VA_RENDER_DEVICE_LOCAL 1
2363 #define VA_RENDER_DEVICE_EXTERNAL 2
2365 /** Currently defined display attribute types */
2368 VADisplayAttribBrightness = 0,
2369 VADisplayAttribContrast = 1,
2370 VADisplayAttribHue = 2,
2371 VADisplayAttribSaturation = 3,
2372 /* client can specifiy a background color for the target window
2373 * the new feature of video conference,
2374 * the uncovered area of the surface is filled by this color
2375 * also it will blend with the decoded video color
2377 VADisplayAttribBackgroundColor = 4,
2379 * this is a gettable only attribute. For some implementations that use the
2380 * hardware overlay, after PutSurface is called, the surface can not be
2381 * re-used until after the subsequent PutSurface call. If this is the case
2382 * then the value for this attribute will be set to 1 so that the client
2383 * will not attempt to re-use the surface right after returning from a call
2386 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2387 * driver may use overlay or GPU alternatively
2389 VADisplayAttribDirectSurface = 5,
2390 VADisplayAttribRotation = 6,
2391 VADisplayAttribOutofLoopDeblock = 7,
2393 /* PowerVR IEP Lite specific attributes */
2394 VADisplayAttribBLEBlackMode = 8,
2395 VADisplayAttribBLEWhiteMode = 9,
2396 VADisplayAttribBlueStretch = 10,
2397 VADisplayAttribSkinColorCorrection = 11,
2399 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2400 * conversion matrix. Each element in the matrix is float-point
2402 VADisplayAttribCSCMatrix = 12,
2403 /* specify the constant color used to blend with video surface
2404 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2405 * d: the final color to overwrite into the frame buffer
2406 * v: decoded video after color conversion,
2407 * c: video color specified by VADisplayAttribBlendColor
2408 * b: background color of the drawable
2410 VADisplayAttribBlendColor = 13,
2412 * Indicate driver to skip painting color key or not.
2413 * only applicable if the render is overlay
2415 VADisplayAttribOverlayAutoPaintColorKey = 14,
2417 * customized overlay color key, the format is RGB888
2418 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2420 VADisplayAttribOverlayColorKey = 15,
2422 * The hint for the implementation of vaPutSurface
2423 * normally, the driver could use an overlay or GPU to render the surface on the screen
2424 * this flag provides APP the flexibity to switch the render dynamically
2426 VADisplayAttribRenderMode = 16,
2428 * specify if vaPutSurface needs to render into specified monitors
2429 * one example is that one external monitor (e.g. HDMI) is enabled,
2430 * but the window manager is not aware of it, and there is no associated drawable
2432 VADisplayAttribRenderDevice = 17,
2434 * specify vaPutSurface render area if there is no drawable on the monitor
2436 VADisplayAttribRenderRect = 18,
2437 } VADisplayAttribType;
2439 /* flags for VADisplayAttribute */
2440 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2441 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2442 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2444 typedef struct _VADisplayAttribute
2446 VADisplayAttribType type;
2449 int value; /* used by the set/get attribute functions */
2450 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2452 } VADisplayAttribute;
2454 /** Get maximum number of display attributs supported by the implementation */
2455 int vaMaxNumDisplayAttributes (
2460 * Query display attributes
2461 * The caller must provide a "attr_list" array that can hold at
2462 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2463 * returned in "attr_list" is returned in "num_attributes".
2465 VAStatus vaQueryDisplayAttributes (
2467 VADisplayAttribute *attr_list, /* out */
2468 int *num_attributes /* out */
2472 * Get display attributes
2473 * This function returns the current attribute values in "attr_list".
2474 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2475 * from vaQueryDisplayAttributes() can have their values retrieved.
2477 VAStatus vaGetDisplayAttributes (
2479 VADisplayAttribute *attr_list, /* in/out */
2484 * Set display attributes
2485 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2486 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2487 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2489 VAStatus vaSetDisplayAttributes (
2491 VADisplayAttribute *attr_list,