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 Surface usage hint, gives the driver a hint of intended usage
667 * to optimize allocation (e.g. tiling) (int, read/write). */
668 VASurfaceAttribUsageHint,
669 /** \brief Number of surface attributes. */
671 } VASurfaceAttribType;
673 /** \brief Surface attribute. */
674 typedef struct _VASurfaceAttrib {
676 VASurfaceAttribType type;
677 /** \brief Flags. See "Surface attribute flags". */
679 /** \brief Value. See "Surface attribute types" for the expected types. */
680 VAGenericValue value;
684 * @name VASurfaceAttribMemoryType values in bit fields.
685 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
686 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
687 * types are defined in DRM and Android header files.
690 /** \brief VA memory type (default) is supported. */
691 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
692 /** \brief V4L2 buffer memory type is supported. */
693 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
694 /** \brief User pointer memory type is supported. */
695 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
699 * \brief VASurfaceAttribExternalBuffers structure for
700 * the VASurfaceAttribExternalBufferDescriptor attribute.
702 typedef struct _VASurfaceAttribExternalBuffers {
703 /** \brief pixel format in fourcc. */
704 unsigned int pixel_format;
705 /** \brief width in pixels. */
707 /** \brief height in pixels. */
709 /** \brief total size of the buffer in bytes. */
710 unsigned int data_size;
711 /** \brief number of planes for planar layout */
712 unsigned int num_planes;
713 /** \brief pitch for each plane in bytes */
714 unsigned int pitches[4];
715 /** \brief offset for each plane in bytes */
716 unsigned int offsets[4];
717 /** \brief buffer handles or user pointers */
718 unsigned long *buffers;
719 /** \brief number of elements in the "buffers" array */
720 unsigned int num_buffers;
721 /** \brief flags. See "Surface external buffer descriptor flags". */
723 /** \brief reserved for passing private data */
725 } VASurfaceAttribExternalBuffers;
727 /** @name VASurfaceAttribExternalBuffers flags */
729 /** \brief Enable memory tiling */
730 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
731 /** \brief Memory is cacheable */
732 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
733 /** \brief Memory is non-cacheable */
734 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
735 /** \brief Memory is write-combined */
736 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
737 /** \brief Memory is protected */
738 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
740 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
742 /** \brief Surface usage not indicated. */
743 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
744 /** \brief Surface used by video decoder. */
745 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
746 /** \brief Surface used by video encoder. */
747 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
748 /** \brief Surface read by video post-processing. */
749 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
750 /** \brief Surface written by video post-processing. */
751 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
752 /** \brief Surface used for display. */
753 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
758 * \brief Queries surface attributes for the supplied config.
760 * Unlike vaGetSurfaceAttributes(), this function queries for all
761 * supported attributes for the supplied VA @config. In particular, if
762 * the underlying hardware supports the creation of VA surfaces in
763 * various formats, then this function will enumerate all pixel
764 * formats that are supported.
766 * The \c attrib_list array is allocated by the user and \c
767 * num_attribs shall be initialized to the number of allocated
768 * elements in that array. Upon successful return, the actual number
769 * of attributes will be overwritten into \c num_attribs. Otherwise,
770 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
771 * is adjusted to the number of elements that would be returned if
772 * enough space was available.
774 * Note: it is perfectly valid to pass NULL to the \c attrib_list
775 * argument when vaQuerySurfaceAttributes() is used to determine the
776 * actual number of elements that need to be allocated.
778 * @param[in] dpy the VA display
779 * @param[in] config the config identifying a codec or a video
780 * processing pipeline
781 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
782 * @param[in,out] num_attribs the number of elements allocated on
783 * input, the number of elements actually filled in output
786 vaQuerySurfaceAttributes(
789 VASurfaceAttrib *attrib_list,
790 unsigned int *num_attribs
794 * \brief Creates an array of surfaces
796 * Creates an array of surfaces. The optional list of attributes shall
797 * be constructed and validated through vaGetSurfaceAttributes() or
798 * constructed based based on what the underlying hardware could
799 * expose through vaQuerySurfaceAttributes().
801 * @param[in] dpy the VA display
802 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
803 * @param[in] width the surface width
804 * @param[in] height the surface height
805 * @param[out] surfaces the array of newly created surfaces
806 * @param[in] num_surfaces the number of surfaces to create
807 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
808 * @param[in] num_attribs the number of attributes supplied in
809 * \c attrib_list, or zero
817 VASurfaceID *surfaces,
818 unsigned int num_surfaces,
819 VASurfaceAttrib *attrib_list,
820 unsigned int num_attribs
824 * vaDestroySurfaces - Destroy resources associated with surfaces.
825 * Surfaces can only be destroyed after the context associated has been
828 * surfaces: array of surfaces to destroy
829 * num_surfaces: number of surfaces in the array to be destroyed.
831 VAStatus vaDestroySurfaces (
833 VASurfaceID *surfaces,
837 #define VA_PROGRESSIVE 0x1
839 * vaCreateContext - Create a context
841 * config_id: configuration for the context
842 * picture_width: coded picture width
843 * picture_height: coded picture height
844 * flag: any combination of the following:
845 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
846 * render_targets: render targets (surfaces) tied to the context
847 * num_render_targets: number of render targets in the above array
848 * context: created context id upon return
850 VAStatus vaCreateContext (
852 VAConfigID config_id,
856 VASurfaceID *render_targets,
857 int num_render_targets,
858 VAContextID *context /* out */
862 * vaDestroyContext - Destroy a context
864 * context: context to be destroyed
866 VAStatus vaDestroyContext (
873 * Buffers are used to pass various types of data from the
874 * client to the server. The server maintains a data store
875 * for each buffer created, and the client idenfies a buffer
876 * through a unique buffer id assigned by the server.
879 typedef VAGenericID VABufferID;
883 VAPictureParameterBufferType = 0,
884 VAIQMatrixBufferType = 1,
885 VABitPlaneBufferType = 2,
886 VASliceGroupMapBufferType = 3,
887 VASliceParameterBufferType = 4,
888 VASliceDataBufferType = 5,
889 VAMacroblockParameterBufferType = 6,
890 VAResidualDataBufferType = 7,
891 VADeblockingParameterBufferType = 8,
892 VAImageBufferType = 9,
893 VAProtectedSliceDataBufferType = 10,
894 VAQMatrixBufferType = 11,
895 VAHuffmanTableBufferType = 12,
896 VAProbabilityBufferType = 13,
898 /* Following are encode buffer types */
899 VAEncCodedBufferType = 21,
900 VAEncSequenceParameterBufferType = 22,
901 VAEncPictureParameterBufferType = 23,
902 VAEncSliceParameterBufferType = 24,
903 VAEncPackedHeaderParameterBufferType = 25,
904 VAEncPackedHeaderDataBufferType = 26,
905 VAEncMiscParameterBufferType = 27,
906 VAEncMacroblockParameterBufferType = 28,
907 VAEncMacroblockMapBufferType = 29,
908 /* Following are video processing buffer types */
910 * \brief Video processing pipeline parameter buffer.
912 * This buffer describes the video processing pipeline. See
913 * #VAProcPipelineParameterBuffer for details.
915 VAProcPipelineParameterBufferType = 41,
917 * \brief Video filter parameter buffer.
919 * This buffer describes the video filter parameters. All buffers
920 * inherit from #VAProcFilterParameterBufferBase, thus including
921 * a unique filter buffer type.
923 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
924 * Filters requiring advanced parameters include, but are not limited to,
925 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
926 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
928 VAProcFilterParameterBufferType = 42,
934 VAEncMiscParameterTypeFrameRate = 0,
935 VAEncMiscParameterTypeRateControl = 1,
936 VAEncMiscParameterTypeMaxSliceSize = 2,
937 VAEncMiscParameterTypeAIR = 3,
938 /** \brief Buffer type used to express a maximum frame size (in bits). */
939 VAEncMiscParameterTypeMaxFrameSize = 4,
940 /** \brief Buffer type used for HRD parameters. */
941 VAEncMiscParameterTypeHRD = 5,
942 } VAEncMiscParameterType;
944 /** \brief Packed header type. */
946 /** \brief Packed sequence header. */
947 VAEncPackedHeaderSequence = 1,
948 /** \brief Packed picture header. */
949 VAEncPackedHeaderPicture = 2,
950 /** \brief Packed slice header. */
951 VAEncPackedHeaderSlice = 3,
953 * \brief Packed raw header.
955 * Packed raw data header can be used by the client to insert a header
956 * into the bitstream data buffer at the point it is passed, the driver
957 * will handle the raw packed header based on "has_emulation_bytes" field
958 * in the packed header parameter structure.
960 VAEncPackedHeaderRawData = 4,
961 /** \brief Misc packed header. See codec-specific definitions. */
962 VAEncPackedHeaderMiscMask = 0x80000000,
963 } VAEncPackedHeaderType;
965 /** \brief Packed header parameter. */
966 typedef struct _VAEncPackedHeaderParameterBuffer {
967 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
969 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
970 unsigned int bit_length;
971 /** \brief Flag: buffer contains start code emulation prevention bytes? */
972 unsigned char has_emulation_bytes;
973 } VAEncPackedHeaderParameterBuffer;
976 * For application, e.g. set a new bitrate
978 * VAEncMiscParameterBuffer *misc_param;
979 * VAEncMiscParameterRateControl *misc_rate_ctrl;
981 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
982 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
985 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
986 * misc_param->type = VAEncMiscParameterTypeRateControl;
987 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
988 * misc_rate_ctrl->bits_per_second = 6400000;
989 * vaUnmapBuffer(dpy, buf_id);
990 * vaRenderPicture(dpy, context, &buf_id, 1);
992 typedef struct _VAEncMiscParameterBuffer
994 VAEncMiscParameterType type;
995 unsigned int data[0];
996 } VAEncMiscParameterBuffer;
999 /** \brief Rate control parameters */
1000 typedef struct _VAEncMiscParameterRateControl
1002 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1003 unsigned int bits_per_second;
1004 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1005 * bit-rate for example if target_percentage is 95 then the rate control will target
1006 * a bit-rate that is 95% of the maximum bit-rate
1008 unsigned int target_percentage;
1009 /* windows size in milliseconds. For example if this is set to 500,
1010 * then the rate control will guarantee the target bit-rate over a 500 ms window
1012 unsigned int window_size;
1013 /* initial QP at I frames */
1014 unsigned int initial_qp;
1015 unsigned int min_qp;
1016 unsigned int basic_unit_size;
1021 unsigned int reset : 1;
1022 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1023 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1027 } VAEncMiscParameterRateControl;
1029 typedef struct _VAEncMiscParameterFrameRate
1031 unsigned int framerate;
1032 } VAEncMiscParameterFrameRate;
1035 * Allow a maximum slice size to be specified (in bits).
1036 * The encoder will attempt to make sure that individual slices do not exceed this size
1037 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1039 typedef struct _VAEncMiscParameterMaxSliceSize
1041 unsigned int max_slice_size;
1042 } VAEncMiscParameterMaxSliceSize;
1044 typedef struct _VAEncMiscParameterAIR
1046 unsigned int air_num_mbs;
1047 unsigned int air_threshold;
1048 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1049 } VAEncMiscParameterAIR;
1051 typedef struct _VAEncMiscParameterHRD
1053 unsigned int initial_buffer_fullness; /* in bits */
1054 unsigned int buffer_size; /* in bits */
1055 } VAEncMiscParameterHRD;
1058 * \brief Defines a maximum frame size (in bits).
1060 * This misc parameter buffer defines the maximum size of a frame (in
1061 * bits). The encoder will try to make sure that each frame does not
1062 * exceed this size. Otherwise, if the frame size exceeds this size,
1063 * the \c status flag of #VACodedBufferSegment will contain
1064 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1066 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1067 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1068 VAEncMiscParameterType type;
1069 /** \brief Maximum size of a frame (in bits). */
1070 unsigned int max_frame_size;
1071 } VAEncMiscParameterBufferMaxFrameSize;
1074 * There will be cases where the bitstream buffer will not have enough room to hold
1075 * the data for the entire slice, and the following flags will be used in the slice
1076 * parameter to signal to the server for the possible cases.
1077 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1078 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1079 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1081 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1082 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1083 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1084 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1086 /* Codec-independent Slice Parameter Buffer base */
1087 typedef struct _VASliceParameterBufferBase
1089 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1090 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1091 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1092 } VASliceParameterBufferBase;
1095 /****************************
1096 * JEPG data structure
1097 ***************************/
1098 typedef struct _VAQMatrixBufferJPEG
1100 int load_lum_quantiser_matrix;
1101 int load_chroma_quantiser_matrix;
1102 unsigned char lum_quantiser_matrix[64];
1103 unsigned char chroma_quantiser_matrix[64];
1104 } VAQMatrixBufferJPEG;
1106 typedef struct _VAEncPictureParameterBufferJPEG
1108 VASurfaceID reconstructed_picture;
1109 unsigned short picture_width;
1110 unsigned short picture_height;
1111 VABufferID coded_buf;
1112 } VAEncPictureParameterBufferJPEG;
1114 #include <va/va_dec_jpeg.h>
1116 /****************************
1117 * MPEG-2 data structures
1118 ****************************/
1120 /* MPEG-2 Picture Parameter Buffer */
1122 * For each frame or field, and before any slice data, a single
1123 * picture parameter buffer must be send.
1125 typedef struct _VAPictureParameterBufferMPEG2
1127 unsigned short horizontal_size;
1128 unsigned short vertical_size;
1129 VASurfaceID forward_reference_picture;
1130 VASurfaceID backward_reference_picture;
1131 /* meanings of the following fields are the same as in the standard */
1132 int picture_coding_type;
1133 int f_code; /* pack all four fcode into this */
1136 unsigned int intra_dc_precision : 2;
1137 unsigned int picture_structure : 2;
1138 unsigned int top_field_first : 1;
1139 unsigned int frame_pred_frame_dct : 1;
1140 unsigned int concealment_motion_vectors : 1;
1141 unsigned int q_scale_type : 1;
1142 unsigned int intra_vlc_format : 1;
1143 unsigned int alternate_scan : 1;
1144 unsigned int repeat_first_field : 1;
1145 unsigned int progressive_frame : 1;
1146 unsigned int is_first_field : 1; /* indicate whether the current field
1147 * is the first field for field picture
1151 } picture_coding_extension;
1152 } VAPictureParameterBufferMPEG2;
1154 /** MPEG-2 Inverse Quantization Matrix Buffer */
1155 typedef struct _VAIQMatrixBufferMPEG2
1157 int load_intra_quantiser_matrix;
1158 int load_non_intra_quantiser_matrix;
1159 int load_chroma_intra_quantiser_matrix;
1160 int load_chroma_non_intra_quantiser_matrix;
1161 unsigned char intra_quantiser_matrix[64];
1162 unsigned char non_intra_quantiser_matrix[64];
1163 unsigned char chroma_intra_quantiser_matrix[64];
1164 unsigned char chroma_non_intra_quantiser_matrix[64];
1165 } VAIQMatrixBufferMPEG2;
1167 /** MPEG-2 Slice Parameter Buffer */
1168 typedef struct _VASliceParameterBufferMPEG2
1170 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1171 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1172 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1173 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1174 unsigned int slice_horizontal_position;
1175 unsigned int slice_vertical_position;
1176 int quantiser_scale_code;
1177 int intra_slice_flag;
1178 } VASliceParameterBufferMPEG2;
1180 /** MPEG-2 Macroblock Parameter Buffer */
1181 typedef struct _VAMacroblockParameterBufferMPEG2
1183 unsigned short macroblock_address;
1185 * macroblock_address (in raster scan order)
1187 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1189 unsigned char macroblock_type; /* see definition below */
1192 unsigned int frame_motion_type : 2;
1193 unsigned int field_motion_type : 2;
1194 unsigned int dct_type : 1;
1198 unsigned char motion_vertical_field_select;
1200 * motion_vertical_field_select:
1201 * see section 6.3.17.2 in the spec
1202 * only the lower 4 bits are used
1203 * bit 0: first vector forward
1204 * bit 1: first vector backward
1205 * bit 2: second vector forward
1206 * bit 3: second vector backward
1208 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1209 unsigned short coded_block_pattern;
1211 * The bitplanes for coded_block_pattern are described
1212 * in Figure 6.10-12 in the spec
1215 /* Number of skipped macroblocks after this macroblock */
1216 unsigned short num_skipped_macroblocks;
1217 } VAMacroblockParameterBufferMPEG2;
1220 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1222 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1223 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1224 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1225 #define VA_MB_TYPE_MOTION_INTRA 0x10
1228 * MPEG-2 Residual Data Buffer
1229 * For each macroblock, there wil be 64 shorts (16-bit) in the
1230 * residual data buffer
1233 /****************************
1234 * MPEG-4 Part 2 data structures
1235 ****************************/
1237 /* MPEG-4 Picture Parameter Buffer */
1239 * For each frame or field, and before any slice data, a single
1240 * picture parameter buffer must be send.
1242 typedef struct _VAPictureParameterBufferMPEG4
1244 unsigned short vop_width;
1245 unsigned short vop_height;
1246 VASurfaceID forward_reference_picture;
1247 VASurfaceID backward_reference_picture;
1250 unsigned int short_video_header : 1;
1251 unsigned int chroma_format : 2;
1252 unsigned int interlaced : 1;
1253 unsigned int obmc_disable : 1;
1254 unsigned int sprite_enable : 2;
1255 unsigned int sprite_warping_accuracy : 2;
1256 unsigned int quant_type : 1;
1257 unsigned int quarter_sample : 1;
1258 unsigned int data_partitioned : 1;
1259 unsigned int reversible_vlc : 1;
1260 unsigned int resync_marker_disable : 1;
1264 unsigned char no_of_sprite_warping_points;
1265 short sprite_trajectory_du[3];
1266 short sprite_trajectory_dv[3];
1267 unsigned char quant_precision;
1270 unsigned int vop_coding_type : 2;
1271 unsigned int backward_reference_vop_coding_type : 2;
1272 unsigned int vop_rounding_type : 1;
1273 unsigned int intra_dc_vlc_thr : 3;
1274 unsigned int top_field_first : 1;
1275 unsigned int alternate_vertical_scan_flag : 1;
1279 unsigned char vop_fcode_forward;
1280 unsigned char vop_fcode_backward;
1281 unsigned short vop_time_increment_resolution;
1282 /* short header related */
1283 unsigned char num_gobs_in_vop;
1284 unsigned char num_macroblocks_in_gob;
1285 /* for direct mode prediction */
1288 } VAPictureParameterBufferMPEG4;
1290 /** MPEG-4 Inverse Quantization Matrix Buffer */
1291 typedef struct _VAIQMatrixBufferMPEG4
1293 int load_intra_quant_mat;
1294 int load_non_intra_quant_mat;
1295 unsigned char intra_quant_mat[64];
1296 unsigned char non_intra_quant_mat[64];
1297 } VAIQMatrixBufferMPEG4;
1299 /** MPEG-4 Slice Parameter Buffer */
1300 typedef struct _VASliceParameterBufferMPEG4
1302 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1303 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1304 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1305 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1306 unsigned int macroblock_number;
1308 } VASliceParameterBufferMPEG4;
1311 VC-1 data structures
1314 typedef enum /* see 7.1.1.32 */
1317 VAMvMode1MvHalfPel = 1,
1318 VAMvMode1MvHalfPelBilinear = 2,
1319 VAMvModeMixedMv = 3,
1320 VAMvModeIntensityCompensation = 4
1323 /** VC-1 Picture Parameter Buffer */
1325 * For each picture, and before any slice data, a picture parameter
1326 * buffer must be send. Multiple picture parameter buffers may be
1327 * sent for a single picture. In that case picture parameters will
1328 * apply to all slice data that follow it until a new picture
1329 * parameter buffer is sent.
1332 * pic_quantizer_type should be set to the applicable quantizer
1333 * type as defined by QUANTIZER (J.1.19) and either
1334 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1336 typedef struct _VAPictureParameterBufferVC1
1338 VASurfaceID forward_reference_picture;
1339 VASurfaceID backward_reference_picture;
1340 /* if out-of-loop post-processing is done on the render
1341 target, then we need to keep the in-loop decoded
1342 picture as a reference picture */
1343 VASurfaceID inloop_decoded_picture;
1345 /* sequence layer for AP or meta data for SP and MP */
1348 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1349 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1350 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1351 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1352 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1353 unsigned int multires : 1; /* METADATA::MULTIRES */
1354 unsigned int overlap : 1; /* METADATA::OVERLAP */
1355 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1356 unsigned int rangered : 1; /* METADATA::RANGERED */
1357 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1358 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1363 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1364 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1367 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1368 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1369 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1370 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1373 } entrypoint_fields;
1374 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1375 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1378 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1379 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1380 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1381 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1384 } range_mapping_fields;
1386 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1387 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1388 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1389 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1390 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1391 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1392 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1393 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1394 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1397 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1398 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1399 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1400 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1401 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1407 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1408 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1409 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1410 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1411 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1412 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1413 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1419 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1420 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1421 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1422 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1423 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1424 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1425 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1428 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1431 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1432 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1433 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1434 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1440 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1441 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1442 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1443 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1444 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1445 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1446 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1447 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1448 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1449 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1455 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1456 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1457 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1458 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1459 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1460 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1461 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1462 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1463 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1464 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1465 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1468 } pic_quantizer_fields;
1471 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1472 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1473 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1474 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1475 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1476 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1480 } VAPictureParameterBufferVC1;
1482 /** VC-1 Bitplane Buffer
1483 There will be at most three bitplanes coded in any picture header. To send
1484 the bitplane data more efficiently, each byte is divided in two nibbles, with
1485 each nibble carrying three bitplanes for one macroblock. The following table
1486 shows the bitplane data arrangement within each nibble based on the picture
1489 Picture Type Bit3 Bit2 Bit1 Bit0
1490 I or BI OVERFLAGS ACPRED FIELDTX
1491 P MYTYPEMB SKIPMB DIRECTMB
1492 B FORWARDMB SKIPMB DIRECTMB
1494 Within each byte, the lower nibble is for the first MB and the upper nibble is
1495 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1496 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1497 Macroblock #2 in the first row.
1500 /* VC-1 Slice Parameter Buffer */
1501 typedef struct _VASliceParameterBufferVC1
1503 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1504 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1505 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1506 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1507 unsigned int slice_vertical_position;
1508 } VASliceParameterBufferVC1;
1510 /* VC-1 Slice Data Buffer */
1512 This is simplely a buffer containing raw bit-stream bytes
1515 /****************************
1516 * H.264/AVC data structures
1517 ****************************/
1519 typedef struct _VAPictureH264
1521 VASurfaceID picture_id;
1522 unsigned int frame_idx;
1524 signed int TopFieldOrderCnt;
1525 signed int BottomFieldOrderCnt;
1527 /* flags in VAPictureH264 could be OR of the following */
1528 #define VA_PICTURE_H264_INVALID 0x00000001
1529 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1530 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1531 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1532 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1534 /** H.264 Picture Parameter Buffer */
1536 * For each picture, and before any slice data, a single
1537 * picture parameter buffer must be send.
1539 typedef struct _VAPictureParameterBufferH264
1541 VAPictureH264 CurrPic;
1542 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1543 unsigned short picture_width_in_mbs_minus1;
1544 unsigned short picture_height_in_mbs_minus1;
1545 unsigned char bit_depth_luma_minus8;
1546 unsigned char bit_depth_chroma_minus8;
1547 unsigned char num_ref_frames;
1550 unsigned int chroma_format_idc : 2;
1551 unsigned int residual_colour_transform_flag : 1;
1552 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1553 unsigned int frame_mbs_only_flag : 1;
1554 unsigned int mb_adaptive_frame_field_flag : 1;
1555 unsigned int direct_8x8_inference_flag : 1;
1556 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1557 unsigned int log2_max_frame_num_minus4 : 4;
1558 unsigned int pic_order_cnt_type : 2;
1559 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1560 unsigned int delta_pic_order_always_zero_flag : 1;
1564 unsigned char num_slice_groups_minus1;
1565 unsigned char slice_group_map_type;
1566 unsigned short slice_group_change_rate_minus1;
1567 signed char pic_init_qp_minus26;
1568 signed char pic_init_qs_minus26;
1569 signed char chroma_qp_index_offset;
1570 signed char second_chroma_qp_index_offset;
1573 unsigned int entropy_coding_mode_flag : 1;
1574 unsigned int weighted_pred_flag : 1;
1575 unsigned int weighted_bipred_idc : 2;
1576 unsigned int transform_8x8_mode_flag : 1;
1577 unsigned int field_pic_flag : 1;
1578 unsigned int constrained_intra_pred_flag : 1;
1579 unsigned int pic_order_present_flag : 1;
1580 unsigned int deblocking_filter_control_present_flag : 1;
1581 unsigned int redundant_pic_cnt_present_flag : 1;
1582 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1586 unsigned short frame_num;
1587 } VAPictureParameterBufferH264;
1589 /** H.264 Inverse Quantization Matrix Buffer */
1590 typedef struct _VAIQMatrixBufferH264
1592 unsigned char ScalingList4x4[6][16];
1593 unsigned char ScalingList8x8[2][64];
1594 } VAIQMatrixBufferH264;
1597 * H.264 Slice Group Map Buffer
1598 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1599 * A slice group map buffer should be sent for each picture if required. The buffer
1600 * is sent only when there is a change in the mapping values.
1601 * The slice group map buffer map "map units" to slice groups as specified in
1602 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1603 * in raster scan order
1606 /** H.264 Slice Parameter Buffer */
1607 typedef struct _VASliceParameterBufferH264
1609 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1610 /** \brief Byte offset to the NAL Header Unit for this slice. */
1611 unsigned int slice_data_offset;
1612 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1614 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1616 * This bit offset is relative to and includes the NAL unit byte
1617 * and represents the number of bits parsed in the slice_header()
1618 * after the removal of any emulation prevention bytes in
1619 * there. However, the slice data buffer passed to the hardware is
1620 * the original bitstream, thus including any emulation prevention
1623 unsigned short slice_data_bit_offset;
1624 unsigned short first_mb_in_slice;
1625 unsigned char slice_type;
1626 unsigned char direct_spatial_mv_pred_flag;
1627 unsigned char num_ref_idx_l0_active_minus1;
1628 unsigned char num_ref_idx_l1_active_minus1;
1629 unsigned char cabac_init_idc;
1630 char slice_qp_delta;
1631 unsigned char disable_deblocking_filter_idc;
1632 char slice_alpha_c0_offset_div2;
1633 char slice_beta_offset_div2;
1634 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1635 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1636 unsigned char luma_log2_weight_denom;
1637 unsigned char chroma_log2_weight_denom;
1638 unsigned char luma_weight_l0_flag;
1639 short luma_weight_l0[32];
1640 short luma_offset_l0[32];
1641 unsigned char chroma_weight_l0_flag;
1642 short chroma_weight_l0[32][2];
1643 short chroma_offset_l0[32][2];
1644 unsigned char luma_weight_l1_flag;
1645 short luma_weight_l1[32];
1646 short luma_offset_l1[32];
1647 unsigned char chroma_weight_l1_flag;
1648 short chroma_weight_l1[32][2];
1649 short chroma_offset_l1[32][2];
1650 } VASliceParameterBufferH264;
1652 /****************************
1653 * Common encode data structures
1654 ****************************/
1657 VAEncPictureTypeIntra = 0,
1658 VAEncPictureTypePredictive = 1,
1659 VAEncPictureTypeBidirectional = 2,
1662 /* Encode Slice Parameter Buffer */
1663 typedef struct _VAEncSliceParameterBuffer
1665 unsigned int start_row_number; /* starting MB row number for this slice */
1666 unsigned int slice_height; /* slice height measured in MB */
1669 unsigned int is_intra : 1;
1670 unsigned int disable_deblocking_filter_idc : 2;
1671 unsigned int uses_long_term_ref :1;
1672 unsigned int is_long_term_ref :1;
1676 } VAEncSliceParameterBuffer;
1679 /****************************
1680 * H.263 specific encode data structures
1681 ****************************/
1683 typedef struct _VAEncSequenceParameterBufferH263
1685 unsigned int intra_period;
1686 unsigned int bits_per_second;
1687 unsigned int frame_rate;
1688 unsigned int initial_qp;
1689 unsigned int min_qp;
1690 } VAEncSequenceParameterBufferH263;
1692 typedef struct _VAEncPictureParameterBufferH263
1694 VASurfaceID reference_picture;
1695 VASurfaceID reconstructed_picture;
1696 VABufferID coded_buf;
1697 unsigned short picture_width;
1698 unsigned short picture_height;
1699 VAEncPictureType picture_type;
1700 } VAEncPictureParameterBufferH263;
1702 /****************************
1703 * MPEG-4 specific encode data structures
1704 ****************************/
1706 typedef struct _VAEncSequenceParameterBufferMPEG4
1708 unsigned char profile_and_level_indication;
1709 unsigned int intra_period;
1710 unsigned int video_object_layer_width;
1711 unsigned int video_object_layer_height;
1712 unsigned int vop_time_increment_resolution;
1713 unsigned int fixed_vop_rate;
1714 unsigned int fixed_vop_time_increment;
1715 unsigned int bits_per_second;
1716 unsigned int frame_rate;
1717 unsigned int initial_qp;
1718 unsigned int min_qp;
1719 } VAEncSequenceParameterBufferMPEG4;
1721 typedef struct _VAEncPictureParameterBufferMPEG4
1723 VASurfaceID reference_picture;
1724 VASurfaceID reconstructed_picture;
1725 VABufferID coded_buf;
1726 unsigned short picture_width;
1727 unsigned short picture_height;
1728 unsigned int modulo_time_base; /* number of 1s */
1729 unsigned int vop_time_increment;
1730 VAEncPictureType picture_type;
1731 } VAEncPictureParameterBufferMPEG4;
1735 /** Buffer functions */
1738 * Creates a buffer for "num_elements" elements of "size" bytes and
1739 * initalize with "data".
1740 * if "data" is null, then the contents of the buffer data store
1742 * Basically there are two ways to get buffer data to the server side. One is
1743 * to call vaCreateBuffer() with a non-null "data", which results the data being
1744 * copied to the data store on the server side. A different method that
1745 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1746 * and then use vaMapBuffer() to map the data store from the server side to the
1747 * client address space for access.
1748 * Note: image buffers are created by the library, not the client. Please see
1749 * vaCreateImage on how image buffers are managed.
1751 VAStatus vaCreateBuffer (
1753 VAContextID context,
1754 VABufferType type, /* in */
1755 unsigned int size, /* in */
1756 unsigned int num_elements, /* in */
1757 void *data, /* in */
1758 VABufferID *buf_id /* out */
1762 * Convey to the server how many valid elements are in the buffer.
1763 * e.g. if multiple slice parameters are being held in a single buffer,
1764 * this will communicate to the server the number of slice parameters
1765 * that are valid in the buffer.
1767 VAStatus vaBufferSetNumElements (
1769 VABufferID buf_id, /* in */
1770 unsigned int num_elements /* in */
1775 * device independent data structure for codedbuffer
1779 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1780 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1781 * enough for the encoder to attempt to limit its size.
1782 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1783 * exceeded the maximum slice size specified.
1784 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1785 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1786 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1788 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1789 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1790 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1791 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1792 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1794 * \brief The frame has exceeded the maximum requested size.
1796 * This flag indicates that the encoded frame size exceeds the value
1797 * specified through a misc parameter buffer of type
1798 * #VAEncMiscParameterTypeMaxFrameSize.
1800 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1801 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1804 * \brief The coded buffer segment contains a single NAL unit.
1806 * This flag indicates that the coded buffer segment contains a
1807 * single NAL unit. This flag might be useful to the user for
1808 * processing the coded buffer.
1810 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1813 * \brief Coded buffer segment.
1815 * #VACodedBufferSegment is an element of a linked list describing
1816 * some information on the coded buffer. The coded buffer segment
1817 * could contain either a single NAL unit, or more than one NAL unit.
1818 * It is recommended (but not required) to return a single NAL unit
1819 * in a coded buffer segment, and the implementation should set the
1820 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1822 typedef struct _VACodedBufferSegment {
1824 * \brief Size of the data buffer in this segment (in bytes).
1827 /** \brief Bit offset into the data buffer where the video data starts. */
1828 unsigned int bit_offset;
1829 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1830 unsigned int status;
1831 /** \brief Reserved for future use. */
1832 unsigned int reserved;
1833 /** \brief Pointer to the start of the data buffer. */
1836 * \brief Pointer to the next #VACodedBufferSegment element,
1837 * or \c NULL if there is none.
1840 } VACodedBufferSegment;
1843 * Map data store of the buffer into the client's address space
1844 * vaCreateBuffer() needs to be called with "data" set to NULL before
1845 * calling vaMapBuffer()
1847 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1848 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1850 VAStatus vaMapBuffer (
1852 VABufferID buf_id, /* in */
1853 void **pbuf /* out */
1857 * After client making changes to a mapped data store, it needs to
1858 * "Unmap" it to let the server know that the data is ready to be
1859 * consumed by the server
1861 VAStatus vaUnmapBuffer (
1863 VABufferID buf_id /* in */
1867 * After this call, the buffer is deleted and this buffer_id is no longer valid
1868 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1870 VAStatus vaDestroyBuffer (
1872 VABufferID buffer_id
1876 Render (Decode) Pictures
1878 A picture represents either a frame or a field.
1880 The Begin/Render/End sequence sends the decode buffers to the server
1884 * Get ready to decode a picture to a target surface
1886 VAStatus vaBeginPicture (
1888 VAContextID context,
1889 VASurfaceID render_target
1893 * Send decode buffers to the server.
1894 * Buffers are automatically destroyed afterwards
1896 VAStatus vaRenderPicture (
1898 VAContextID context,
1899 VABufferID *buffers,
1904 * Make the end of rendering for a picture.
1905 * The server should start processing all pending operations for this
1906 * surface. This call is non-blocking. The client can start another
1907 * Begin/Render/End sequence on a different render target.
1909 VAStatus vaEndPicture (
1921 * This function blocks until all pending operations on the render target
1922 * have been completed. Upon return it is safe to use the render target for a
1923 * different picture.
1925 VAStatus vaSyncSurface (
1927 VASurfaceID render_target
1932 VASurfaceRendering = 1, /* Rendering in progress */
1933 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1934 /* this status is useful if surface is used as the source */
1936 VASurfaceReady = 4, /* not being rendered or displayed */
1937 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1941 * Find out any pending ops on the render target
1943 VAStatus vaQuerySurfaceStatus (
1945 VASurfaceID render_target,
1946 VASurfaceStatus *status /* out */
1951 VADecodeSliceMissing = 0,
1952 VADecodeMBError = 1,
1953 } VADecodeErrorType;
1956 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1957 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1959 typedef struct _VASurfaceDecodeMBErrors
1961 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1962 unsigned int start_mb; /* start mb address with errors */
1963 unsigned int end_mb; /* end mb address with errors */
1964 VADecodeErrorType decode_error_type;
1965 } VASurfaceDecodeMBErrors;
1968 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1969 * it can call vaQuerySurfaceError to find out further details on the particular error.
1970 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1971 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1972 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1973 * The array is terminated if "status==-1" is detected.
1975 VAStatus vaQuerySurfaceError(
1977 VASurfaceID surface,
1978 VAStatus error_status,
1983 * Images and Subpictures
1984 * VAImage is used to either get the surface data to client memory, or
1985 * to copy image data in client memory to a surface.
1986 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1987 * is at the upper left corner with positive X to the right and positive Y down
1989 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1990 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1991 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1994 * Pre-defined fourcc codes
1996 #define VA_FOURCC_NV12 0x3231564E
1997 #define VA_FOURCC_AI44 0x34344149
1998 #define VA_FOURCC_RGBA 0x41424752
1999 #define VA_FOURCC_RGBX 0x58424752
2000 #define VA_FOURCC_BGRA 0x41524742
2001 #define VA_FOURCC_BGRX 0x58524742
2002 #define VA_FOURCC_ARGB 0x42475241
2003 #define VA_FOURCC_XRGB 0x42475258
2004 #define VA_FOURCC_ABGR 0x52474241
2005 #define VA_FOURCC_XBGR 0x52474258
2006 #define VA_FOURCC_UYVY 0x59565955
2007 #define VA_FOURCC_YUY2 0x32595559
2008 #define VA_FOURCC_AYUV 0x56555941
2009 #define VA_FOURCC_NV11 0x3131564e
2010 #define VA_FOURCC_YV12 0x32315659
2011 #define VA_FOURCC_P208 0x38303250
2012 #define VA_FOURCC_IYUV 0x56555949
2013 #define VA_FOURCC_YV24 0x34325659
2014 #define VA_FOURCC_YV32 0x32335659
2015 #define VA_FOURCC_Y800 0x30303859
2016 #define VA_FOURCC_IMC3 0x33434D49
2017 #define VA_FOURCC_411P 0x50313134
2018 #define VA_FOURCC_422H 0x48323234
2019 #define VA_FOURCC_422V 0x56323234
2020 #define VA_FOURCC_444P 0x50343434
2021 #define VA_FOURCC_RGBP 0x50424752
2022 #define VA_FOURCC_BGRP 0x50524742
2023 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2026 #define VA_LSB_FIRST 1
2027 #define VA_MSB_FIRST 2
2029 typedef struct _VAImageFormat
2031 unsigned int fourcc;
2032 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2033 unsigned int bits_per_pixel;
2034 /* for RGB formats */
2035 unsigned int depth; /* significant bits per pixel */
2036 unsigned int red_mask;
2037 unsigned int green_mask;
2038 unsigned int blue_mask;
2039 unsigned int alpha_mask;
2042 typedef VAGenericID VAImageID;
2044 typedef struct _VAImage
2046 VAImageID image_id; /* uniquely identify this image */
2047 VAImageFormat format;
2048 VABufferID buf; /* image data buffer */
2050 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2051 * data store on the server side for optimal performance. The buffer will be
2052 * created by the CreateImage function, and proper storage allocated based on the image
2053 * size and format. This buffer is managed by the library implementation, and
2054 * accessed by the client through the buffer Map/Unmap functions.
2056 unsigned short width;
2057 unsigned short height;
2058 unsigned int data_size;
2059 unsigned int num_planes; /* can not be greater than 3 */
2061 * An array indicating the scanline pitch in bytes for each plane.
2062 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2064 unsigned int pitches[3];
2066 * An array indicating the byte offset from the beginning of the image data
2067 * to the start of each plane.
2069 unsigned int offsets[3];
2071 /* The following fields are only needed for paletted formats */
2072 int num_palette_entries; /* set to zero for non-palette images */
2074 * Each component is one byte and entry_bytes indicates the number of components in
2075 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2079 * An array of ascii characters describing the order of the components within the bytes.
2080 * Only entry_bytes characters of the string are used.
2082 char component_order[4];
2085 /** Get maximum number of image formats supported by the implementation */
2086 int vaMaxNumImageFormats (
2091 * Query supported image formats
2092 * The caller must provide a "format_list" array that can hold at
2093 * least vaMaxNumImageFormats() entries. The actual number of formats
2094 * returned in "format_list" is returned in "num_formats".
2096 VAStatus vaQueryImageFormats (
2098 VAImageFormat *format_list, /* out */
2099 int *num_formats /* out */
2103 * Create a VAImage structure
2104 * The width and height fields returned in the VAImage structure may get
2105 * enlarged for some YUV formats. Upon return from this function,
2106 * image->buf has been created and proper storage allocated by the library.
2107 * The client can access the image through the Map/Unmap calls.
2109 VAStatus vaCreateImage (
2111 VAImageFormat *format,
2114 VAImage *image /* out */
2118 * Should call DestroyImage before destroying the surface it is bound to
2120 VAStatus vaDestroyImage (
2125 VAStatus vaSetImagePalette (
2129 * pointer to an array holding the palette data. The size of the array is
2130 * num_palette_entries * entry_bytes in size. The order of the components
2131 * in the palette is described by the component_order in VAImage struct
2133 unsigned char *palette
2137 * Retrive surface data into a VAImage
2138 * Image must be in a format supported by the implementation
2140 VAStatus vaGetImage (
2142 VASurfaceID surface,
2143 int x, /* coordinates of the upper left source pixel */
2145 unsigned int width, /* width and height of the region */
2146 unsigned int height,
2151 * Copy data from a VAImage to a surface
2152 * Image must be in a format supported by the implementation
2153 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2154 * shouldn't be rendered into when this is called
2156 VAStatus vaPutImage (
2158 VASurfaceID surface,
2162 unsigned int src_width,
2163 unsigned int src_height,
2166 unsigned int dest_width,
2167 unsigned int dest_height
2171 * Derive an VAImage from an existing surface.
2172 * This interface will derive a VAImage and corresponding image buffer from
2173 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2174 * direct CPU access. This operation is only possible on implementations with
2175 * direct rendering capabilities and internal surface formats that can be
2176 * represented with a VAImage. When the operation is not possible this interface
2177 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2178 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2181 * Implementations should only return success when the resulting image buffer
2182 * would be useable with vaMap/Unmap.
2184 * When directly accessing a surface special care must be taken to insure
2185 * proper synchronization with the graphics hardware. Clients should call
2186 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2187 * rendering or currently being displayed by an overlay.
2189 * Additionally nothing about the contents of a surface should be assumed
2190 * following a vaPutSurface. Implementations are free to modify the surface for
2191 * scaling or subpicture blending within a call to vaPutImage.
2193 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2194 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2195 * vaGetImage with other surfaces is supported.
2197 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2198 * image and image buffer structures will be destroyed; however, the underlying
2199 * surface will remain unchanged until freed with vaDestroySurfaces.
2201 VAStatus vaDeriveImage (
2203 VASurfaceID surface,
2204 VAImage *image /* out */
2209 * Subpicture is a special type of image that can be blended
2210 * with a surface during vaPutSurface(). Subpicture can be used to render
2211 * DVD sub-titles or closed captioning text etc.
2214 typedef VAGenericID VASubpictureID;
2216 /** Get maximum number of subpicture formats supported by the implementation */
2217 int vaMaxNumSubpictureFormats (
2221 /** flags for subpictures */
2222 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2223 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2224 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2226 * Query supported subpicture formats
2227 * The caller must provide a "format_list" array that can hold at
2228 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2229 * for each format to indicate additional capabilities for that format. The actual
2230 * number of formats returned in "format_list" is returned in "num_formats".
2231 * flags: returned value to indicate addtional capabilities
2232 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2233 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2234 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2237 VAStatus vaQuerySubpictureFormats (
2239 VAImageFormat *format_list, /* out */
2240 unsigned int *flags, /* out */
2241 unsigned int *num_formats /* out */
2245 * Subpictures are created with an image associated.
2247 VAStatus vaCreateSubpicture (
2250 VASubpictureID *subpicture /* out */
2254 * Destroy the subpicture before destroying the image it is assocated to
2256 VAStatus vaDestroySubpicture (
2258 VASubpictureID subpicture
2262 * Bind an image to the subpicture. This image will now be associated with
2263 * the subpicture instead of the one at creation.
2265 VAStatus vaSetSubpictureImage (
2267 VASubpictureID subpicture,
2272 * If chromakey is enabled, then the area where the source value falls within
2273 * the chromakey [min, max] range is transparent
2274 * The chromakey component format is the following:
2275 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2276 * For YUV: [0:7] V [8:15] U [16:23] Y
2277 * The chromakey mask can be used to mask out certain components for chromakey
2280 VAStatus vaSetSubpictureChromakey (
2282 VASubpictureID subpicture,
2283 unsigned int chromakey_min,
2284 unsigned int chromakey_max,
2285 unsigned int chromakey_mask
2289 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2290 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2291 * the overall alpha is per-pixel alpha multiplied by the global alpha
2293 VAStatus vaSetSubpictureGlobalAlpha (
2295 VASubpictureID subpicture,
2300 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2301 * It defines the region mapping between the subpicture and the target
2302 * surfaces through source and destination rectangles (with the same width and height).
2303 * Both will be displayed at the next call to vaPutSurface. Additional
2304 * associations before the call to vaPutSurface simply overrides the association.
2306 VAStatus vaAssociateSubpicture (
2308 VASubpictureID subpicture,
2309 VASurfaceID *target_surfaces,
2311 short src_x, /* upper left offset in subpicture */
2313 unsigned short src_width,
2314 unsigned short src_height,
2315 short dest_x, /* upper left offset in surface */
2317 unsigned short dest_width,
2318 unsigned short dest_height,
2320 * whether to enable chroma-keying, global-alpha, or screen relative mode
2321 * see VA_SUBPICTURE_XXX values
2327 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2329 VAStatus vaDeassociateSubpicture (
2331 VASubpictureID subpicture,
2332 VASurfaceID *target_surfaces,
2336 typedef struct _VARectangle
2340 unsigned short width;
2341 unsigned short height;
2345 * Display attributes
2346 * Display attributes are used to control things such as contrast, hue, saturation,
2347 * brightness etc. in the rendering process. The application can query what
2348 * attributes are supported by the driver, and then set the appropriate attributes
2349 * before calling vaPutSurface()
2351 /* PowerVR IEP Lite attributes */
2354 VADISPLAYATTRIB_BLE_OFF = 0x00,
2355 VADISPLAYATTRIB_BLE_LOW,
2356 VADISPLAYATTRIB_BLE_MEDIUM,
2357 VADISPLAYATTRIB_BLE_HIGH,
2358 VADISPLAYATTRIB_BLE_NONE,
2359 } VADisplayAttribBLEMode;
2361 /** attribute value for VADisplayAttribRotation */
2362 #define VA_ROTATION_NONE 0x00000000
2363 #define VA_ROTATION_90 0x00000001
2364 #define VA_ROTATION_180 0x00000002
2365 #define VA_ROTATION_270 0x00000003
2367 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2368 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2369 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2372 #define VA_RENDER_MODE_UNDEFINED 0
2373 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2374 #define VA_RENDER_MODE_LOCAL_GPU 2
2375 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2376 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2378 /** Render device */
2379 #define VA_RENDER_DEVICE_UNDEFINED 0
2380 #define VA_RENDER_DEVICE_LOCAL 1
2381 #define VA_RENDER_DEVICE_EXTERNAL 2
2383 /** Currently defined display attribute types */
2386 VADisplayAttribBrightness = 0,
2387 VADisplayAttribContrast = 1,
2388 VADisplayAttribHue = 2,
2389 VADisplayAttribSaturation = 3,
2390 /* client can specifiy a background color for the target window
2391 * the new feature of video conference,
2392 * the uncovered area of the surface is filled by this color
2393 * also it will blend with the decoded video color
2395 VADisplayAttribBackgroundColor = 4,
2397 * this is a gettable only attribute. For some implementations that use the
2398 * hardware overlay, after PutSurface is called, the surface can not be
2399 * re-used until after the subsequent PutSurface call. If this is the case
2400 * then the value for this attribute will be set to 1 so that the client
2401 * will not attempt to re-use the surface right after returning from a call
2404 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2405 * driver may use overlay or GPU alternatively
2407 VADisplayAttribDirectSurface = 5,
2408 VADisplayAttribRotation = 6,
2409 VADisplayAttribOutofLoopDeblock = 7,
2411 /* PowerVR IEP Lite specific attributes */
2412 VADisplayAttribBLEBlackMode = 8,
2413 VADisplayAttribBLEWhiteMode = 9,
2414 VADisplayAttribBlueStretch = 10,
2415 VADisplayAttribSkinColorCorrection = 11,
2417 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2418 * conversion matrix. Each element in the matrix is float-point
2420 VADisplayAttribCSCMatrix = 12,
2421 /* specify the constant color used to blend with video surface
2422 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2423 * d: the final color to overwrite into the frame buffer
2424 * v: decoded video after color conversion,
2425 * c: video color specified by VADisplayAttribBlendColor
2426 * b: background color of the drawable
2428 VADisplayAttribBlendColor = 13,
2430 * Indicate driver to skip painting color key or not.
2431 * only applicable if the render is overlay
2433 VADisplayAttribOverlayAutoPaintColorKey = 14,
2435 * customized overlay color key, the format is RGB888
2436 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2438 VADisplayAttribOverlayColorKey = 15,
2440 * The hint for the implementation of vaPutSurface
2441 * normally, the driver could use an overlay or GPU to render the surface on the screen
2442 * this flag provides APP the flexibity to switch the render dynamically
2444 VADisplayAttribRenderMode = 16,
2446 * specify if vaPutSurface needs to render into specified monitors
2447 * one example is that one external monitor (e.g. HDMI) is enabled,
2448 * but the window manager is not aware of it, and there is no associated drawable
2450 VADisplayAttribRenderDevice = 17,
2452 * specify vaPutSurface render area if there is no drawable on the monitor
2454 VADisplayAttribRenderRect = 18,
2455 } VADisplayAttribType;
2457 /* flags for VADisplayAttribute */
2458 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2459 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2460 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2462 typedef struct _VADisplayAttribute
2464 VADisplayAttribType type;
2467 int value; /* used by the set/get attribute functions */
2468 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2470 } VADisplayAttribute;
2472 /** Get maximum number of display attributs supported by the implementation */
2473 int vaMaxNumDisplayAttributes (
2478 * Query display attributes
2479 * The caller must provide a "attr_list" array that can hold at
2480 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2481 * returned in "attr_list" is returned in "num_attributes".
2483 VAStatus vaQueryDisplayAttributes (
2485 VADisplayAttribute *attr_list, /* out */
2486 int *num_attributes /* out */
2490 * Get display attributes
2491 * This function returns the current attribute values in "attr_list".
2492 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2493 * from vaQueryDisplayAttributes() can have their values retrieved.
2495 VAStatus vaGetDisplayAttributes (
2497 VADisplayAttribute *attr_list, /* in/out */
2502 * Set display attributes
2503 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2504 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2505 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2507 VAStatus vaSetDisplayAttributes (
2509 VADisplayAttribute *attr_list,