2 * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19 * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
20 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 * Video Acceleration (VA) API Specification
28 * <jonathan.bian@intel.com>
31 * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
32 * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
33 * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
34 * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
35 * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
36 * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
37 * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
38 * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
39 * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
40 * and MPEG-2 motion compensation.
41 * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
42 * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
43 * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
44 * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
45 * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
46 * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
47 * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
48 * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
49 * rev 0.27 (11/19/2007 Matt Sottek) - Added DeriveImage
50 * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
52 * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
53 * added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
54 * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
55 * for ISO C conformance.
56 * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
57 * Application needs to relink with the new library.
59 * rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
60 * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
61 * screen relative rather than source video relative.
62 * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
63 * update VAAPI to 0.32.0
66 * Some concepts borrowed from XvMC and XvImage.
67 * Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
68 * contributed to various aspects of the API.
75 * This file contains the \ref api_core "Core API".
81 #include <va/va_version.h>
88 * \mainpage Video Acceleration (VA) API
90 * \section intro Introduction
92 * The main motivation for VA-API (Video Acceleration API) is to
93 * enable hardware accelerated video decode and encode at various
94 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
95 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
96 * AVC/H.264, VC-1/VMW3, and JPEG).
98 * VA-API is split into several modules:
100 * - \ref api_enc_core
101 * - \ref api_enc_h264
106 * \defgroup api_core Core API
114 The VA API is intended to provide an interface between a video decode/encode/display
115 application (client) and a hardware accelerator (server), to off-load
116 video decode/encode/display operations from the host to the hardware accelerator at various
119 The basic operation steps are:
121 - Negotiate a mutually acceptable configuration with the server to lock
122 down profile, entrypoints, and other attributes that will not change on
123 a frame-by-frame basis.
124 - Create a decode context which represents a "virtualized" hardware decode
126 - Get and fill decode buffers with picture level, slice level and macroblock
127 level data (depending on entrypoints)
128 - Pass the decode buffers to the server to decode the current frame
130 Initialization & Configuration Management
132 - Find out supported profiles
133 - Find out entrypoints for a given profile
134 - Find out configuration attributes for a given profile/entrypoint pair
135 - Create a configuration for use by the decoder
139 typedef void* VADisplay; /* window system dependent */
141 typedef int VAStatus; /* Return status type from functions */
142 /* Values for the return status */
143 #define VA_STATUS_SUCCESS 0x00000000
144 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
145 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
146 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
147 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
148 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
149 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
150 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
151 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
152 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
153 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
154 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
155 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
156 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
157 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
158 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
159 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
160 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
161 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
162 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
163 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
164 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
165 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
166 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
167 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
169 * \brief An invalid/unsupported value was supplied.
171 * This is a catch-all error code for invalid or unsupported values.
172 * e.g. value exceeding the valid range, invalid type in the context
173 * of generic attribute values.
175 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
176 /** \brief An unsupported filter was supplied. */
177 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
178 /** \brief An invalid filter chain was supplied. */
179 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
180 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
181 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
182 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
184 /* De-interlacing flags for vaPutSurface() */
185 #define VA_FRAME_PICTURE 0x00000000
186 #define VA_TOP_FIELD 0x00000001
187 #define VA_BOTTOM_FIELD 0x00000002
190 * Enabled the positioning/cropping/blending feature:
191 * 1, specify the video playback position in the isurface
192 * 2, specify the cropping info for video playback
193 * 3, encoded video will blend with background color
195 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
198 * Clears the drawable with background color.
199 * for hardware overlay based implementation this flag
200 * can be used to turn off the overlay
202 #define VA_CLEAR_DRAWABLE 0x00000008
204 /* Color space conversion flags for vaPutSurface() */
205 #define VA_SRC_BT601 0x00000010
206 #define VA_SRC_BT709 0x00000020
207 #define VA_SRC_SMPTE_240 0x00000040
209 /* Scaling flags for vaPutSurface() */
210 #define VA_FILTER_SCALING_DEFAULT 0x00000000
211 #define VA_FILTER_SCALING_FAST 0x00000100
212 #define VA_FILTER_SCALING_HQ 0x00000200
213 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
214 #define VA_FILTER_SCALING_MASK 0x00000f00
217 * Returns a short english description of error_status
219 const char *vaErrorStr(VAStatus error_status);
223 * A display must be obtained by calling vaGetDisplay() before calling
224 * vaInitialize() and other functions. This connects the API to the
225 * native window system.
226 * For X Windows, native_dpy would be from XOpenDisplay()
228 typedef void* VANativeDisplay; /* window system dependent */
230 int vaDisplayIsValid(VADisplay dpy);
233 * Initialize the library
235 VAStatus vaInitialize (
237 int *major_version, /* out */
238 int *minor_version /* out */
242 * After this call, all library internal resources will be cleaned up
244 VAStatus vaTerminate (
249 * vaQueryVendorString returns a pointer to a zero-terminated string
250 * describing some aspects of the VA implemenation on a specific
251 * hardware accelerator. The format of the returned string is vendor
252 * specific and at the discretion of the implementer.
253 * e.g. for the Intel GMA500 implementation, an example would be:
254 * "Intel GMA500 - 2.0.0.32L.0005"
256 const char *vaQueryVendorString (
260 typedef int (*VAPrivFunc)();
263 * Return a function pointer given a function name in the library.
264 * This allows private interfaces into the library
266 VAPrivFunc vaGetLibFunc (
271 /* Currently defined profiles */
274 /** \brief Profile ID used for video processing. */
276 VAProfileMPEG2Simple = 0,
277 VAProfileMPEG2Main = 1,
278 VAProfileMPEG4Simple = 2,
279 VAProfileMPEG4AdvancedSimple = 3,
280 VAProfileMPEG4Main = 4,
281 VAProfileH264Baseline = 5,
282 VAProfileH264Main = 6,
283 VAProfileH264High = 7,
284 VAProfileVC1Simple = 8,
285 VAProfileVC1Main = 9,
286 VAProfileVC1Advanced = 10,
287 VAProfileH263Baseline = 11,
288 VAProfileJPEGBaseline = 12,
289 VAProfileH264ConstrainedBaseline = 13
293 * Currently defined entrypoints
299 VAEntrypointIDCT = 3,
300 VAEntrypointMoComp = 4,
301 VAEntrypointDeblocking = 5,
302 VAEntrypointEncSlice = 6, /* slice level encode */
303 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
304 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
308 /* Currently defined configuration attribute types */
311 VAConfigAttribRTFormat = 0,
312 VAConfigAttribSpatialResidual = 1,
313 VAConfigAttribSpatialClipping = 2,
314 VAConfigAttribIntraResidual = 3,
315 VAConfigAttribEncryption = 4,
316 VAConfigAttribRateControl = 5,
318 /** @name Attributes for encoding */
321 * \brief Packed headers mode. Read/write.
323 * This attribute determines what packed headers the driver supports,
324 * through vaGetConfigAttributes(); and what packed headers the user
325 * will be providing to the driver, through vaCreateConfig(), if the
326 * driver supports those.
328 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
330 VAConfigAttribEncPackedHeaders = 10,
332 * \brief Interlaced mode. Read/write.
334 * This attribute determines what kind of interlaced encoding mode
335 * the driver supports.
337 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
339 VAConfigAttribEncInterlaced = 11,
341 * \brief Maximum number of reference frames. Read-only.
343 * This attribute determines the maximum number of reference
344 * frames supported for encoding.
346 * Note: for H.264 encoding, the value represents the maximum number
347 * of reference frames for both the reference picture list 0 (bottom
348 * 16 bits) and the reference picture list 1 (top 16 bits).
350 VAConfigAttribEncMaxRefFrames = 13,
352 * \brief Maximum number of slices per frame. Read-only.
354 * This attribute determines the maximum number of slices the
355 * driver can support to encode a single frame.
357 VAConfigAttribEncMaxSlices = 14,
359 * \brief Slice structure. Read-only.
361 * This attribute determines slice structures supported by the
362 * driver for encoding. This attribute is a hint to the user so
363 * that he can choose a suitable surface size and how to arrange
364 * the encoding process of multiple slices per frame.
366 * More specifically, for H.264 encoding, this attribute
367 * determines the range of accepted values to
368 * VAEncSliceParameterBufferH264::macroblock_address and
369 * VAEncSliceParameterBufferH264::num_macroblocks.
371 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
374 VAConfigAttribEncSliceStructure = 15,
376 * \brief Macroblock information. Read-only.
378 * This attribute determines whether the driver supports extra
379 * encoding information per-macroblock. e.g. QP.
381 * More specifically, for H.264 encoding, if the driver returns a non-zero
382 * value for this attribute, this means the application can create
383 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
384 * through VAEncSliceParameterBufferH264::macroblock_info.
386 VAConfigAttribEncMacroblockInfo = 16,
388 VAConfigAttribTypeMax
389 } VAConfigAttribType;
392 * Configuration attributes
393 * If there is more than one value for an attribute, a default
394 * value will be assigned to the attribute if the client does not
395 * specify the attribute when creating a configuration
397 typedef struct _VAConfigAttrib {
398 VAConfigAttribType type;
399 unsigned int value; /* OR'd flags (bits) for this attribute */
402 /* attribute value for VAConfigAttribRTFormat */
403 #define VA_RT_FORMAT_YUV420 0x00000001
404 #define VA_RT_FORMAT_YUV422 0x00000002
405 #define VA_RT_FORMAT_YUV444 0x00000004
406 #define VA_RT_FORMAT_RGB16 0x00010000
407 #define VA_RT_FORMAT_RGB32 0x00020000
408 #define VA_RT_FORMAT_PROTECTED 0x80000000
410 /** @name Attribute values for VAConfigAttribRateControl */
412 /** \brief Driver does not support any form of rate control. */
413 #define VA_RC_NONE 0x00000001
414 /** \brief Constant bitrate. */
415 #define VA_RC_CBR 0x00000002
416 /** \brief Variable bitrate. */
417 #define VA_RC_VBR 0x00000004
418 /** \brief Video conference mode. */
419 #define VA_RC_VCM 0x00000008
420 /** \brief Constant QP. */
421 #define VA_RC_CQP 0x00000010
422 /** \brief Variable bitrate with peak rate higher than average bitrate. */
423 #define VA_RC_VBR_CONSTRAINED 0x00000020
426 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
428 /** \brief Driver does not support any packed headers mode. */
429 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
430 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
431 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
432 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
433 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
434 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
435 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
436 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
437 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
438 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
439 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x0000000C
442 /** @name Attribute values for VAConfigAttribEncInterlaced */
444 /** \brief Driver does not support interlaced coding. */
445 #define VA_ENC_INTERLACED_NONE 0x00000000
446 /** \brief Driver supports interlaced frame coding. */
447 #define VA_ENC_INTERLACED_FRAME 0x00000001
448 /** \brief Driver supports interlaced field coding. */
449 #define VA_ENC_INTERLACED_FIELD 0x00000002
450 /** \brief Driver supports macroblock adaptive frame field coding. */
451 #define VA_ENC_INTERLACED_MBAFF 0x00000004
452 /** \brief Driver supports picture adaptive frame field coding. */
453 #define VA_ENC_INTERLACED_PAFF 0x00000008
456 /** @name Attribute values for VAConfigAttribEncSliceStructure */
458 /** \brief Driver supports an arbitrary number of rows per slice. */
459 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
460 /** \brief Driver supports a power-of-two number of rows per slice. */
461 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
462 /** \brief Driver supports an arbitrary number of rows per slice. */
463 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
467 * if an attribute is not applicable for a given
468 * profile/entrypoint pair, then set the value to the following
470 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
472 /* Get maximum number of profiles supported by the implementation */
473 int vaMaxNumProfiles (
477 /* Get maximum number of entrypoints supported by the implementation */
478 int vaMaxNumEntrypoints (
482 /* Get maximum number of attributs supported by the implementation */
483 int vaMaxNumConfigAttributes (
488 * Query supported profiles
489 * The caller must provide a "profile_list" array that can hold at
490 * least vaMaxNumProfile() entries. The actual number of profiles
491 * returned in "profile_list" is returned in "num_profile".
493 VAStatus vaQueryConfigProfiles (
495 VAProfile *profile_list, /* out */
496 int *num_profiles /* out */
500 * Query supported entrypoints for a given profile
501 * The caller must provide an "entrypoint_list" array that can hold at
502 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
503 * returned in "entrypoint_list" is returned in "num_entrypoints".
505 VAStatus vaQueryConfigEntrypoints (
508 VAEntrypoint *entrypoint_list, /* out */
509 int *num_entrypoints /* out */
513 * Get attributes for a given profile/entrypoint pair
514 * The caller must provide an "attrib_list" with all attributes to be
515 * retrieved. Upon return, the attributes in "attrib_list" have been
516 * updated with their value. Unknown attributes or attributes that are
517 * not supported for the given profile/entrypoint pair will have their
518 * value set to VA_ATTRIB_NOT_SUPPORTED
520 VAStatus vaGetConfigAttributes (
523 VAEntrypoint entrypoint,
524 VAConfigAttrib *attrib_list, /* in/out */
528 /* Generic ID type, can be re-typed for specific implementation */
529 typedef unsigned int VAGenericID;
531 typedef VAGenericID VAConfigID;
534 * Create a configuration for the decode pipeline
535 * it passes in the attribute list that specifies the attributes it cares
536 * about, with the rest taking default values.
538 VAStatus vaCreateConfig (
541 VAEntrypoint entrypoint,
542 VAConfigAttrib *attrib_list,
544 VAConfigID *config_id /* out */
548 * Free resources associdated with a given config
550 VAStatus vaDestroyConfig (
556 * Query all attributes for a given configuration
557 * The profile of the configuration is returned in "profile"
558 * The entrypoint of the configuration is returned in "entrypoint"
559 * The caller must provide an "attrib_list" array that can hold at least
560 * vaMaxNumConfigAttributes() entries. The actual number of attributes
561 * returned in "attrib_list" is returned in "num_attribs"
563 VAStatus vaQueryConfigAttributes (
565 VAConfigID config_id,
566 VAProfile *profile, /* out */
567 VAEntrypoint *entrypoint, /* out */
568 VAConfigAttrib *attrib_list,/* out */
569 int *num_attribs /* out */
574 * Contexts and Surfaces
576 * Context represents a "virtual" video decode pipeline. Surfaces are render
577 * targets for a given context. The data in the surfaces are not accessible
578 * to the client and the internal data format of the surface is implementatin
581 * Surfaces will be bound to a context when the context is created. Once
582 * a surface is bound to a given context, it can not be used to create
583 * another context. The association is removed when the context is destroyed
585 * Both contexts and surfaces are identified by unique IDs and its
586 * implementation specific internals are kept opaque to the clients
589 typedef VAGenericID VAContextID;
591 typedef VAGenericID VASurfaceID;
593 #define VA_INVALID_ID 0xffffffff
594 #define VA_INVALID_SURFACE VA_INVALID_ID
596 /** \brief Generic value types. */
598 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
599 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
600 VAGenericValueTypePointer, /**< Generic pointer type */
601 VAGenericValueTypeFunc /**< Pointer to function */
602 } VAGenericValueType;
604 /** \brief Generic function type. */
605 typedef void (*VAGenericFunc)(void);
607 /** \brief Generic value. */
608 typedef struct _VAGenericValue {
609 /** \brief Value type. See #VAGenericValueType. */
610 VAGenericValueType type;
611 /** \brief Value holder. */
613 /** \brief 32-bit signed integer. */
615 /** \brief 32-bit float. */
617 /** \brief Generic pointer. */
619 /** \brief Pointer to function. */
624 /** @name Surface attribute flags */
626 /** \brief Surface attribute is not supported. */
627 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
628 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
629 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
630 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
631 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
634 /** \brief Surface attribute types. */
636 VASurfaceAttribNone = 0,
638 * \brief Pixel format (fourcc).
640 * The value is meaningful as input to vaQuerySurfaceAttributes().
641 * If zero, the driver returns the optimal pixel format for the
642 * specified config. Otherwise, if non-zero, the value represents
643 * a pixel format (FOURCC) that is kept as is on output, if the
644 * driver supports it. Otherwise, the driver sets the value to
645 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
647 VASurfaceAttribPixelFormat,
648 /** \brief Minimal width in pixels (int, read-only). */
649 VASurfaceAttribMinWidth,
650 /** \brief Maximal width in pixels (int, read-only). */
651 VASurfaceAttribMaxWidth,
652 /** \brief Minimal height in pixels (int, read-only). */
653 VASurfaceAttribMinHeight,
654 /** \brief Maximal height in pixels (int, read-only). */
655 VASurfaceAttribMaxHeight,
656 /** \brief Surface memory type in fourcc (int, read/write). */
657 VASurfaceAttribMemoryType,
658 /** \brief External buffer descriptor (pointer, write). */
659 VASurfaceAttribExternalBufferDescriptor,
660 /** \brief Number of surface attributes. */
662 } VASurfaceAttribType;
664 /** \brief Surface attribute. */
665 typedef struct _VASurfaceAttrib {
667 VASurfaceAttribType type;
668 /** \brief Flags. See "Surface attribute flags". */
670 /** \brief Value. See "Surface attribute types" for the expected types. */
671 VAGenericValue value;
674 /** @name VASurfaceAttribMemoryType values in fourcc */
676 /** \brief VA memory type (default) is supported. VAVA in fourcc */
677 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x41564156
678 /** \brief V4L2 buffer memory type is supported. V4L2 in fourcc */
679 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x324C3456
680 /** \brief User pointer memory type is supported. UPTR in fourcc */
681 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x52545055
685 * \brief VASurfaceAttribExternalBuffers structure for
686 * the VASurfaceAttribExternalBufferDescriptor attribute.
688 typedef struct _VASurfaceAttribExternalBuffers {
689 /** \brief pixel format in fourcc. */
690 unsigned int pixel_format;
691 /** \brief width in pixels. */
693 /** \brief height in pixels. */
695 /** \brief total size of the buffer in bytes. */
696 unsigned int data_size;
697 /** \brief number of planes for planar layout */
698 unsigned int num_planes;
699 /** \brief pitch for each plane in bytes */
700 unsigned int pitches[4];
701 /** \brief offset for each plane in bytes */
702 unsigned int offsets[4];
703 /** \brief buffer handles or user pointers */
704 unsigned long *buffers;
705 /** \brief number of elements in the "buffers" array */
706 unsigned int num_buffers;
707 /** \brief flags. See "Surface external buffer descriptor flags". */
709 /** \brief reserved for passing private data */
711 } VASurfaceAttribExternalBuffers;
713 /** @name VASurfaceAttribExternalBuffers flags */
715 /** \brief Enable memory tiling */
716 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
720 * \brief Get surface attributes for the supplied config.
722 * This function retrieves the surface attributes matching the supplied
723 * config. The caller shall provide an \c attrib_list with all attributes
724 * to be retrieved. Upon successful return, the attributes in \c attrib_list
725 * are updated with the requested value. Unknown attributes or attributes
726 * that are not supported for the given config will have their \c flags
727 * field set to \c VA_SURFACE_ATTRIB_NOT_SUPPORTED.
729 * @param[in] dpy the VA display
730 * @param[in] config the config identifying a codec or a video
731 * processing pipeline
732 * @param[in,out] attrib_list the list of attributes on input, with at
733 * least \c type fields filled in, and possibly \c value fields whenever
734 * necessary. The updated list of attributes and flags on output
735 * @param[in] num_attribs the number of attributes supplied in the
736 * \c attrib_list array
739 vaGetSurfaceAttributes(
742 VASurfaceAttrib *attrib_list,
743 unsigned int num_attribs
747 * \brief Creates an array of surfaces
749 * Creates an array of surfaces. The optional list of attributes shall
750 * be constructed and verified through vaGetSurfaceAttributes().
752 * @param[in] dpy the VA display
753 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
754 * @param[in] width the surface width
755 * @param[in] height the surface height
756 * @param[out] surfaces the array of newly created surfaces
757 * @param[in] num_surfaces the number of surfaces to create
758 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
759 * @param[in] num_attribs the number of attributes supplied in
760 * \c attrib_list, or zero
768 VASurfaceID *surfaces,
769 unsigned int num_surfaces,
770 VASurfaceAttrib *attrib_list,
771 unsigned int num_attribs
775 * vaDestroySurfaces - Destroy resources associated with surfaces.
776 * Surfaces can only be destroyed after the context associated has been
779 * surfaces: array of surfaces to destroy
780 * num_surfaces: number of surfaces in the array to be destroyed.
782 VAStatus vaDestroySurfaces (
784 VASurfaceID *surfaces,
788 #define VA_PROGRESSIVE 0x1
790 * vaCreateContext - Create a context
792 * config_id: configuration for the context
793 * picture_width: coded picture width
794 * picture_height: coded picture height
795 * flag: any combination of the following:
796 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
797 * render_targets: render targets (surfaces) tied to the context
798 * num_render_targets: number of render targets in the above array
799 * context: created context id upon return
801 VAStatus vaCreateContext (
803 VAConfigID config_id,
807 VASurfaceID *render_targets,
808 int num_render_targets,
809 VAContextID *context /* out */
813 * vaDestroyContext - Destroy a context
815 * context: context to be destroyed
817 VAStatus vaDestroyContext (
824 * Buffers are used to pass various types of data from the
825 * client to the server. The server maintains a data store
826 * for each buffer created, and the client idenfies a buffer
827 * through a unique buffer id assigned by the server.
830 typedef VAGenericID VABufferID;
834 VAPictureParameterBufferType = 0,
835 VAIQMatrixBufferType = 1,
836 VABitPlaneBufferType = 2,
837 VASliceGroupMapBufferType = 3,
838 VASliceParameterBufferType = 4,
839 VASliceDataBufferType = 5,
840 VAMacroblockParameterBufferType = 6,
841 VAResidualDataBufferType = 7,
842 VADeblockingParameterBufferType = 8,
843 VAImageBufferType = 9,
844 VAProtectedSliceDataBufferType = 10,
845 VAQMatrixBufferType = 11,
846 VAHuffmanTableBufferType = 12,
848 /* Following are encode buffer types */
849 VAEncCodedBufferType = 21,
850 VAEncSequenceParameterBufferType = 22,
851 VAEncPictureParameterBufferType = 23,
852 VAEncSliceParameterBufferType = 24,
853 VAEncPackedHeaderParameterBufferType = 25,
854 VAEncPackedHeaderDataBufferType = 26,
855 VAEncMiscParameterBufferType = 27,
856 VAEncMacroblockParameterBufferType = 28,
857 /* Following are video processing buffer types */
859 * \brief Video processing pipeline parameter buffer.
861 * This buffer describes the video processing pipeline. See
862 * #VAProcPipelineParameterBuffer for details.
864 VAProcPipelineParameterBufferType = 41,
866 * \brief Video filter parameter buffer.
868 * This buffer describes the video filter parameters. All buffers
869 * inherit from #VAProcFilterParameterBufferBase, thus including
870 * a unique filter buffer type.
872 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
873 * Filters requiring advanced parameters include, but are not limited to,
874 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
875 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
877 VAProcFilterParameterBufferType = 42,
883 VAEncMiscParameterTypeFrameRate = 0,
884 VAEncMiscParameterTypeRateControl = 1,
885 VAEncMiscParameterTypeMaxSliceSize = 2,
886 VAEncMiscParameterTypeAIR = 3,
887 /** \brief Buffer type used to express a maximum frame size (in bits). */
888 VAEncMiscParameterTypeMaxFrameSize = 4,
889 /** \brief Buffer type used for HRD parameters. */
890 VAEncMiscParameterTypeHRD = 5,
891 } VAEncMiscParameterType;
893 /** \brief Packed header type. */
895 /** \brief Packed sequence header. */
896 VAEncPackedHeaderSequence = 1,
897 /** \brief Packed picture header. */
898 VAEncPackedHeaderPicture = 2,
899 /** \brief Packed slice header. */
900 VAEncPackedHeaderSlice = 3,
902 * \brief Packed raw header.
904 * Packed raw data header can be used by the client to insert a header
905 * into the bitstream data buffer at the point it is passed, the driver
906 * will handle the raw packed header based on "has_emulation_bytes" field
907 * in the packed header parameter structure.
909 VAEncPackedHeaderRawData = 4,
910 /** \brief Misc packed header. See codec-specific definitions. */
911 VAEncPackedHeaderMiscMask = 0x80000000,
912 } VAEncPackedHeaderType;
914 /** \brief Packed header parameter. */
915 typedef struct _VAEncPackedHeaderParameterBuffer {
916 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
918 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
919 unsigned int bit_length;
920 /** \brief Flag: buffer contains start code emulation prevention bytes? */
921 unsigned char has_emulation_bytes;
922 } VAEncPackedHeaderParameterBuffer;
925 * For application, e.g. set a new bitrate
927 * VAEncMiscParameterBuffer *misc_param;
928 * VAEncMiscParameterRateControl *misc_rate_ctrl;
930 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
931 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
934 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
935 * misc_param->type = VAEncMiscParameterTypeRateControl;
936 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
937 * misc_rate_ctrl->bits_per_second = 6400000;
938 * vaUnmapBuffer(dpy, buf_id);
939 * vaRenderPicture(dpy, context, &buf_id, 1);
941 typedef struct _VAEncMiscParameterBuffer
943 VAEncMiscParameterType type;
944 unsigned int data[0];
945 } VAEncMiscParameterBuffer;
948 /** \brief Rate control parameters */
949 typedef struct _VAEncMiscParameterRateControl
951 /* this is the maximum bit-rate to be constrained by the rate control implementation */
952 unsigned int bits_per_second;
953 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
954 * bit-rate for example if target_percentage is 95 then the rate control will target
955 * a bit-rate that is 95% of the maximum bit-rate
957 unsigned int target_percentage;
958 /* windows size in milliseconds. For example if this is set to 500,
959 * then the rate control will guarantee the target bit-rate over a 500 ms window
961 unsigned int window_size;
962 /* initial QP at I frames */
963 unsigned int initial_qp;
965 unsigned int basic_unit_size;
970 unsigned int reset : 1;
971 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
972 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
976 } VAEncMiscParameterRateControl;
978 typedef struct _VAEncMiscParameterFrameRate
980 unsigned int framerate;
981 } VAEncMiscParameterFrameRate;
984 * Allow a maximum slice size to be specified (in bits).
985 * The encoder will attempt to make sure that individual slices do not exceed this size
986 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
988 typedef struct _VAEncMiscParameterMaxSliceSize
990 unsigned int max_slice_size;
991 } VAEncMiscParameterMaxSliceSize;
993 typedef struct _VAEncMiscParameterAIR
995 unsigned int air_num_mbs;
996 unsigned int air_threshold;
997 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
998 } VAEncMiscParameterAIR;
1000 typedef struct _VAEncMiscParameterHRD
1002 unsigned int initial_buffer_fullness; /* in bits */
1003 unsigned int buffer_size; /* in bits */
1004 } VAEncMiscParameterHRD;
1007 * \brief Defines a maximum frame size (in bits).
1009 * This misc parameter buffer defines the maximum size of a frame (in
1010 * bits). The encoder will try to make sure that each frame does not
1011 * exceed this size. Otherwise, if the frame size exceeds this size,
1012 * the \c status flag of #VACodedBufferSegment will contain
1013 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1015 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1016 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1017 VAEncMiscParameterType type;
1018 /** \brief Maximum size of a frame (in bits). */
1019 unsigned int max_frame_size;
1020 } VAEncMiscParameterBufferMaxFrameSize;
1023 * There will be cases where the bitstream buffer will not have enough room to hold
1024 * the data for the entire slice, and the following flags will be used in the slice
1025 * parameter to signal to the server for the possible cases.
1026 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1027 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1028 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1030 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1031 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1032 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1033 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1035 /* Codec-independent Slice Parameter Buffer base */
1036 typedef struct _VASliceParameterBufferBase
1038 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1039 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1040 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1041 } VASliceParameterBufferBase;
1044 /****************************
1045 * JEPG data structure
1046 ***************************/
1047 typedef struct _VAQMatrixBufferJPEG
1049 int load_lum_quantiser_matrix;
1050 int load_chroma_quantiser_matrix;
1051 unsigned char lum_quantiser_matrix[64];
1052 unsigned char chroma_quantiser_matrix[64];
1053 } VAQMatrixBufferJPEG;
1055 typedef struct _VAEncPictureParameterBufferJPEG
1057 VASurfaceID reconstructed_picture;
1058 unsigned short picture_width;
1059 unsigned short picture_height;
1060 VABufferID coded_buf;
1061 } VAEncPictureParameterBufferJPEG;
1063 #include <va/va_dec_jpeg.h>
1065 /****************************
1066 * MPEG-2 data structures
1067 ****************************/
1069 /* MPEG-2 Picture Parameter Buffer */
1071 * For each frame or field, and before any slice data, a single
1072 * picture parameter buffer must be send.
1074 typedef struct _VAPictureParameterBufferMPEG2
1076 unsigned short horizontal_size;
1077 unsigned short vertical_size;
1078 VASurfaceID forward_reference_picture;
1079 VASurfaceID backward_reference_picture;
1080 /* meanings of the following fields are the same as in the standard */
1081 int picture_coding_type;
1082 int f_code; /* pack all four fcode into this */
1085 unsigned int intra_dc_precision : 2;
1086 unsigned int picture_structure : 2;
1087 unsigned int top_field_first : 1;
1088 unsigned int frame_pred_frame_dct : 1;
1089 unsigned int concealment_motion_vectors : 1;
1090 unsigned int q_scale_type : 1;
1091 unsigned int intra_vlc_format : 1;
1092 unsigned int alternate_scan : 1;
1093 unsigned int repeat_first_field : 1;
1094 unsigned int progressive_frame : 1;
1095 unsigned int is_first_field : 1; /* indicate whether the current field
1096 * is the first field for field picture
1100 } picture_coding_extension;
1101 } VAPictureParameterBufferMPEG2;
1103 /* MPEG-2 Inverse Quantization Matrix Buffer */
1104 typedef struct _VAIQMatrixBufferMPEG2
1106 int load_intra_quantiser_matrix;
1107 int load_non_intra_quantiser_matrix;
1108 int load_chroma_intra_quantiser_matrix;
1109 int load_chroma_non_intra_quantiser_matrix;
1110 unsigned char intra_quantiser_matrix[64];
1111 unsigned char non_intra_quantiser_matrix[64];
1112 unsigned char chroma_intra_quantiser_matrix[64];
1113 unsigned char chroma_non_intra_quantiser_matrix[64];
1114 } VAIQMatrixBufferMPEG2;
1116 /* MPEG-2 Slice Parameter Buffer */
1117 typedef struct _VASliceParameterBufferMPEG2
1119 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1120 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1121 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1122 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1123 unsigned int slice_horizontal_position;
1124 unsigned int slice_vertical_position;
1125 int quantiser_scale_code;
1126 int intra_slice_flag;
1127 } VASliceParameterBufferMPEG2;
1129 /* MPEG-2 Macroblock Parameter Buffer */
1130 typedef struct _VAMacroblockParameterBufferMPEG2
1132 unsigned short macroblock_address;
1134 * macroblock_address (in raster scan order)
1136 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1138 unsigned char macroblock_type; /* see definition below */
1141 unsigned int frame_motion_type : 2;
1142 unsigned int field_motion_type : 2;
1143 unsigned int dct_type : 1;
1147 unsigned char motion_vertical_field_select;
1149 * motion_vertical_field_select:
1150 * see section 6.3.17.2 in the spec
1151 * only the lower 4 bits are used
1152 * bit 0: first vector forward
1153 * bit 1: first vector backward
1154 * bit 2: second vector forward
1155 * bit 3: second vector backward
1157 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1158 unsigned short coded_block_pattern;
1160 * The bitplanes for coded_block_pattern are described
1161 * in Figure 6.10-12 in the spec
1164 /* Number of skipped macroblocks after this macroblock */
1165 unsigned short num_skipped_macroblocks;
1166 } VAMacroblockParameterBufferMPEG2;
1169 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1171 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1172 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1173 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1174 #define VA_MB_TYPE_MOTION_INTRA 0x10
1177 * MPEG-2 Residual Data Buffer
1178 * For each macroblock, there wil be 64 shorts (16-bit) in the
1179 * residual data buffer
1182 /****************************
1183 * MPEG-4 Part 2 data structures
1184 ****************************/
1186 /* MPEG-4 Picture Parameter Buffer */
1188 * For each frame or field, and before any slice data, a single
1189 * picture parameter buffer must be send.
1191 typedef struct _VAPictureParameterBufferMPEG4
1193 unsigned short vop_width;
1194 unsigned short vop_height;
1195 VASurfaceID forward_reference_picture;
1196 VASurfaceID backward_reference_picture;
1199 unsigned int short_video_header : 1;
1200 unsigned int chroma_format : 2;
1201 unsigned int interlaced : 1;
1202 unsigned int obmc_disable : 1;
1203 unsigned int sprite_enable : 2;
1204 unsigned int sprite_warping_accuracy : 2;
1205 unsigned int quant_type : 1;
1206 unsigned int quarter_sample : 1;
1207 unsigned int data_partitioned : 1;
1208 unsigned int reversible_vlc : 1;
1209 unsigned int resync_marker_disable : 1;
1213 unsigned char no_of_sprite_warping_points;
1214 short sprite_trajectory_du[3];
1215 short sprite_trajectory_dv[3];
1216 unsigned char quant_precision;
1219 unsigned int vop_coding_type : 2;
1220 unsigned int backward_reference_vop_coding_type : 2;
1221 unsigned int vop_rounding_type : 1;
1222 unsigned int intra_dc_vlc_thr : 3;
1223 unsigned int top_field_first : 1;
1224 unsigned int alternate_vertical_scan_flag : 1;
1228 unsigned char vop_fcode_forward;
1229 unsigned char vop_fcode_backward;
1230 unsigned short vop_time_increment_resolution;
1231 /* short header related */
1232 unsigned char num_gobs_in_vop;
1233 unsigned char num_macroblocks_in_gob;
1234 /* for direct mode prediction */
1237 } VAPictureParameterBufferMPEG4;
1239 /* MPEG-4 Inverse Quantization Matrix Buffer */
1240 typedef struct _VAIQMatrixBufferMPEG4
1242 int load_intra_quant_mat;
1243 int load_non_intra_quant_mat;
1244 unsigned char intra_quant_mat[64];
1245 unsigned char non_intra_quant_mat[64];
1246 } VAIQMatrixBufferMPEG4;
1248 /* MPEG-4 Slice Parameter Buffer */
1249 typedef struct _VASliceParameterBufferMPEG4
1251 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1252 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1253 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1254 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1255 unsigned int macroblock_number;
1257 } VASliceParameterBufferMPEG4;
1260 VC-1 data structures
1263 typedef enum /* see 7.1.1.32 */
1266 VAMvMode1MvHalfPel = 1,
1267 VAMvMode1MvHalfPelBilinear = 2,
1268 VAMvModeMixedMv = 3,
1269 VAMvModeIntensityCompensation = 4
1272 /* VC-1 Picture Parameter Buffer */
1274 * For each picture, and before any slice data, a picture parameter
1275 * buffer must be send. Multiple picture parameter buffers may be
1276 * sent for a single picture. In that case picture parameters will
1277 * apply to all slice data that follow it until a new picture
1278 * parameter buffer is sent.
1281 * pic_quantizer_type should be set to the applicable quantizer
1282 * type as defined by QUANTIZER (J.1.19) and either
1283 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1285 typedef struct _VAPictureParameterBufferVC1
1287 VASurfaceID forward_reference_picture;
1288 VASurfaceID backward_reference_picture;
1289 /* if out-of-loop post-processing is done on the render
1290 target, then we need to keep the in-loop decoded
1291 picture as a reference picture */
1292 VASurfaceID inloop_decoded_picture;
1294 /* sequence layer for AP or meta data for SP and MP */
1297 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1298 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1299 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1300 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1301 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1302 unsigned int multires : 1; /* METADATA::MULTIRES */
1303 unsigned int overlap : 1; /* METADATA::OVERLAP */
1304 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1305 unsigned int rangered : 1; /* METADATA::RANGERED */
1306 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1307 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1312 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1313 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1316 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1317 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1318 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1319 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1322 } entrypoint_fields;
1323 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1324 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1327 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1328 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1329 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1330 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1333 } range_mapping_fields;
1335 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1336 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1337 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1338 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1339 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1340 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1341 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1342 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1343 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1346 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1347 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1348 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1349 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1350 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1356 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1357 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1358 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1359 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1360 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1361 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1362 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1368 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1369 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1370 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1371 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1372 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1373 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1374 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1377 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1380 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1381 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1382 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1383 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1389 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1390 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1391 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1392 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1393 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1394 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1395 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1396 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1397 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1398 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1404 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1405 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1406 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1407 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1408 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1409 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1410 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1411 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1412 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1413 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1414 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1417 } pic_quantizer_fields;
1420 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1421 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1422 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1423 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1424 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1425 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1429 } VAPictureParameterBufferVC1;
1431 /* VC-1 Bitplane Buffer
1432 There will be at most three bitplanes coded in any picture header. To send
1433 the bitplane data more efficiently, each byte is divided in two nibbles, with
1434 each nibble carrying three bitplanes for one macroblock. The following table
1435 shows the bitplane data arrangement within each nibble based on the picture
1438 Picture Type Bit3 Bit2 Bit1 Bit0
1439 I or BI OVERFLAGS ACPRED FIELDTX
1440 P MYTYPEMB SKIPMB DIRECTMB
1441 B FORWARDMB SKIPMB DIRECTMB
1443 Within each byte, the lower nibble is for the first MB and the upper nibble is
1444 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1445 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1446 Macroblock #2 in the first row.
1449 /* VC-1 Slice Parameter Buffer */
1450 typedef struct _VASliceParameterBufferVC1
1452 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1453 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1454 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1455 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1456 unsigned int slice_vertical_position;
1457 } VASliceParameterBufferVC1;
1459 /* VC-1 Slice Data Buffer */
1461 This is simplely a buffer containing raw bit-stream bytes
1464 /****************************
1465 * H.264/AVC data structures
1466 ****************************/
1468 typedef struct _VAPictureH264
1470 VASurfaceID picture_id;
1471 unsigned int frame_idx;
1473 signed int TopFieldOrderCnt;
1474 signed int BottomFieldOrderCnt;
1476 /* flags in VAPictureH264 could be OR of the following */
1477 #define VA_PICTURE_H264_INVALID 0x00000001
1478 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1479 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1480 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1481 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1483 /* H.264 Picture Parameter Buffer */
1485 * For each picture, and before any slice data, a single
1486 * picture parameter buffer must be send.
1488 typedef struct _VAPictureParameterBufferH264
1490 VAPictureH264 CurrPic;
1491 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1492 unsigned short picture_width_in_mbs_minus1;
1493 unsigned short picture_height_in_mbs_minus1;
1494 unsigned char bit_depth_luma_minus8;
1495 unsigned char bit_depth_chroma_minus8;
1496 unsigned char num_ref_frames;
1499 unsigned int chroma_format_idc : 2;
1500 unsigned int residual_colour_transform_flag : 1;
1501 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1502 unsigned int frame_mbs_only_flag : 1;
1503 unsigned int mb_adaptive_frame_field_flag : 1;
1504 unsigned int direct_8x8_inference_flag : 1;
1505 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1506 unsigned int log2_max_frame_num_minus4 : 4;
1507 unsigned int pic_order_cnt_type : 2;
1508 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1509 unsigned int delta_pic_order_always_zero_flag : 1;
1513 unsigned char num_slice_groups_minus1;
1514 unsigned char slice_group_map_type;
1515 unsigned short slice_group_change_rate_minus1;
1516 signed char pic_init_qp_minus26;
1517 signed char pic_init_qs_minus26;
1518 signed char chroma_qp_index_offset;
1519 signed char second_chroma_qp_index_offset;
1522 unsigned int entropy_coding_mode_flag : 1;
1523 unsigned int weighted_pred_flag : 1;
1524 unsigned int weighted_bipred_idc : 2;
1525 unsigned int transform_8x8_mode_flag : 1;
1526 unsigned int field_pic_flag : 1;
1527 unsigned int constrained_intra_pred_flag : 1;
1528 unsigned int pic_order_present_flag : 1;
1529 unsigned int deblocking_filter_control_present_flag : 1;
1530 unsigned int redundant_pic_cnt_present_flag : 1;
1531 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1535 unsigned short frame_num;
1536 } VAPictureParameterBufferH264;
1538 /* H.264 Inverse Quantization Matrix Buffer */
1539 typedef struct _VAIQMatrixBufferH264
1541 unsigned char ScalingList4x4[6][16];
1542 unsigned char ScalingList8x8[2][64];
1543 } VAIQMatrixBufferH264;
1546 * H.264 Slice Group Map Buffer
1547 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1548 * A slice group map buffer should be sent for each picture if required. The buffer
1549 * is sent only when there is a change in the mapping values.
1550 * The slice group map buffer map "map units" to slice groups as specified in
1551 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1552 * in raster scan order
1555 /* H.264 Slice Parameter Buffer */
1556 typedef struct _VASliceParameterBufferH264
1558 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1559 /** \brief Byte offset to the NAL Header Unit for this slice. */
1560 unsigned int slice_data_offset;
1561 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1563 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1565 * This bit offset is relative to and includes the NAL unit byte
1566 * and represents the number of bits parsed in the slice_header()
1567 * after the removal of any emulation prevention bytes in
1568 * there. However, the slice data buffer passed to the hardware is
1569 * the original bitstream, thus including any emulation prevention
1572 unsigned short slice_data_bit_offset;
1573 unsigned short first_mb_in_slice;
1574 unsigned char slice_type;
1575 unsigned char direct_spatial_mv_pred_flag;
1576 unsigned char num_ref_idx_l0_active_minus1;
1577 unsigned char num_ref_idx_l1_active_minus1;
1578 unsigned char cabac_init_idc;
1579 char slice_qp_delta;
1580 unsigned char disable_deblocking_filter_idc;
1581 char slice_alpha_c0_offset_div2;
1582 char slice_beta_offset_div2;
1583 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1584 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1585 unsigned char luma_log2_weight_denom;
1586 unsigned char chroma_log2_weight_denom;
1587 unsigned char luma_weight_l0_flag;
1588 short luma_weight_l0[32];
1589 short luma_offset_l0[32];
1590 unsigned char chroma_weight_l0_flag;
1591 short chroma_weight_l0[32][2];
1592 short chroma_offset_l0[32][2];
1593 unsigned char luma_weight_l1_flag;
1594 short luma_weight_l1[32];
1595 short luma_offset_l1[32];
1596 unsigned char chroma_weight_l1_flag;
1597 short chroma_weight_l1[32][2];
1598 short chroma_offset_l1[32][2];
1599 } VASliceParameterBufferH264;
1601 /****************************
1602 * Common encode data structures
1603 ****************************/
1606 VAEncPictureTypeIntra = 0,
1607 VAEncPictureTypePredictive = 1,
1608 VAEncPictureTypeBidirectional = 2,
1611 /* Encode Slice Parameter Buffer */
1612 typedef struct _VAEncSliceParameterBuffer
1614 unsigned int start_row_number; /* starting MB row number for this slice */
1615 unsigned int slice_height; /* slice height measured in MB */
1618 unsigned int is_intra : 1;
1619 unsigned int disable_deblocking_filter_idc : 2;
1620 unsigned int uses_long_term_ref :1;
1621 unsigned int is_long_term_ref :1;
1625 } VAEncSliceParameterBuffer;
1628 /****************************
1629 * H.263 specific encode data structures
1630 ****************************/
1632 typedef struct _VAEncSequenceParameterBufferH263
1634 unsigned int intra_period;
1635 unsigned int bits_per_second;
1636 unsigned int frame_rate;
1637 unsigned int initial_qp;
1638 unsigned int min_qp;
1639 } VAEncSequenceParameterBufferH263;
1641 typedef struct _VAEncPictureParameterBufferH263
1643 VASurfaceID reference_picture;
1644 VASurfaceID reconstructed_picture;
1645 VABufferID coded_buf;
1646 unsigned short picture_width;
1647 unsigned short picture_height;
1648 VAEncPictureType picture_type;
1649 } VAEncPictureParameterBufferH263;
1651 /****************************
1652 * MPEG-4 specific encode data structures
1653 ****************************/
1655 typedef struct _VAEncSequenceParameterBufferMPEG4
1657 unsigned char profile_and_level_indication;
1658 unsigned int intra_period;
1659 unsigned int video_object_layer_width;
1660 unsigned int video_object_layer_height;
1661 unsigned int vop_time_increment_resolution;
1662 unsigned int fixed_vop_rate;
1663 unsigned int fixed_vop_time_increment;
1664 unsigned int bits_per_second;
1665 unsigned int frame_rate;
1666 unsigned int initial_qp;
1667 unsigned int min_qp;
1668 } VAEncSequenceParameterBufferMPEG4;
1670 typedef struct _VAEncPictureParameterBufferMPEG4
1672 VASurfaceID reference_picture;
1673 VASurfaceID reconstructed_picture;
1674 VABufferID coded_buf;
1675 unsigned short picture_width;
1676 unsigned short picture_height;
1677 unsigned int modulo_time_base; /* number of 1s */
1678 unsigned int vop_time_increment;
1679 VAEncPictureType picture_type;
1680 } VAEncPictureParameterBufferMPEG4;
1684 /* Buffer functions */
1687 * Creates a buffer for "num_elements" elements of "size" bytes and
1688 * initalize with "data".
1689 * if "data" is null, then the contents of the buffer data store
1691 * Basically there are two ways to get buffer data to the server side. One is
1692 * to call vaCreateBuffer() with a non-null "data", which results the data being
1693 * copied to the data store on the server side. A different method that
1694 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1695 * and then use vaMapBuffer() to map the data store from the server side to the
1696 * client address space for access.
1697 * Note: image buffers are created by the library, not the client. Please see
1698 * vaCreateImage on how image buffers are managed.
1700 VAStatus vaCreateBuffer (
1702 VAContextID context,
1703 VABufferType type, /* in */
1704 unsigned int size, /* in */
1705 unsigned int num_elements, /* in */
1706 void *data, /* in */
1707 VABufferID *buf_id /* out */
1711 * Convey to the server how many valid elements are in the buffer.
1712 * e.g. if multiple slice parameters are being held in a single buffer,
1713 * this will communicate to the server the number of slice parameters
1714 * that are valid in the buffer.
1716 VAStatus vaBufferSetNumElements (
1718 VABufferID buf_id, /* in */
1719 unsigned int num_elements /* in */
1724 * device independent data structure for codedbuffer
1728 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1729 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1730 * enough for the encoder to attempt to limit its size.
1731 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1732 * exceeded the maximum slice size specified.
1733 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1734 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1735 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1737 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1738 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1739 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1740 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1741 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1743 * \brief The frame has exceeded the maximum requested size.
1745 * This flag indicates that the encoded frame size exceeds the value
1746 * specified through a misc parameter buffer of type
1747 * #VAEncMiscParameterTypeMaxFrameSize.
1749 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1750 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1753 * \brief The coded buffer segment contains a single NAL unit.
1755 * This flag indicates that the coded buffer segment contains a
1756 * single NAL unit. This flag might be useful to the user for
1757 * processing the coded buffer.
1759 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1762 * \brief Coded buffer segment.
1764 * #VACodedBufferSegment is an element of a linked list describing
1765 * some information on the coded buffer. The coded buffer segment
1766 * could contain either a single NAL unit, or more than one NAL unit.
1767 * It is recommended (but not required) to return a single NAL unit
1768 * in a coded buffer segment, and the implementation should set the
1769 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1771 typedef struct _VACodedBufferSegment {
1773 * \brief Size of the data buffer in this segment (in bytes).
1776 /** \brief Bit offset into the data buffer where the video data starts. */
1777 unsigned int bit_offset;
1778 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1779 unsigned int status;
1780 /** \brief Reserved for future use. */
1781 unsigned int reserved;
1782 /** \brief Pointer to the start of the data buffer. */
1785 * \brief Pointer to the next #VACodedBufferSegment element,
1786 * or \c NULL if there is none.
1789 } VACodedBufferSegment;
1792 * Map data store of the buffer into the client's address space
1793 * vaCreateBuffer() needs to be called with "data" set to NULL before
1794 * calling vaMapBuffer()
1796 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1797 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1799 VAStatus vaMapBuffer (
1801 VABufferID buf_id, /* in */
1802 void **pbuf /* out */
1806 * After client making changes to a mapped data store, it needs to
1807 * "Unmap" it to let the server know that the data is ready to be
1808 * consumed by the server
1810 VAStatus vaUnmapBuffer (
1812 VABufferID buf_id /* in */
1816 * After this call, the buffer is deleted and this buffer_id is no longer valid
1817 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1819 VAStatus vaDestroyBuffer (
1821 VABufferID buffer_id
1825 Render (Decode) Pictures
1827 A picture represents either a frame or a field.
1829 The Begin/Render/End sequence sends the decode buffers to the server
1833 * Get ready to decode a picture to a target surface
1835 VAStatus vaBeginPicture (
1837 VAContextID context,
1838 VASurfaceID render_target
1842 * Send decode buffers to the server.
1843 * Buffers are automatically destroyed afterwards
1845 VAStatus vaRenderPicture (
1847 VAContextID context,
1848 VABufferID *buffers,
1853 * Make the end of rendering for a picture.
1854 * The server should start processing all pending operations for this
1855 * surface. This call is non-blocking. The client can start another
1856 * Begin/Render/End sequence on a different render target.
1858 VAStatus vaEndPicture (
1870 * This function blocks until all pending operations on the render target
1871 * have been completed. Upon return it is safe to use the render target for a
1872 * different picture.
1874 VAStatus vaSyncSurface (
1876 VASurfaceID render_target
1881 VASurfaceRendering = 1, /* Rendering in progress */
1882 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1883 /* this status is useful if surface is used as the source */
1885 VASurfaceReady = 4, /* not being rendered or displayed */
1886 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1890 * Find out any pending ops on the render target
1892 VAStatus vaQuerySurfaceStatus (
1894 VASurfaceID render_target,
1895 VASurfaceStatus *status /* out */
1900 VADecodeSliceMissing = 0,
1901 VADecodeMBError = 1,
1902 } VADecodeErrorType;
1905 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1906 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1908 typedef struct _VASurfaceDecodeMBErrors
1910 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1911 unsigned int start_mb; /* start mb address with errors */
1912 unsigned int end_mb; /* end mb address with errors */
1913 VADecodeErrorType decode_error_type;
1914 } VASurfaceDecodeMBErrors;
1917 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1918 * it can call vaQuerySurfaceError to find out further details on the particular error.
1919 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1920 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1921 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1922 * The array is terminated if "status==-1" is detected.
1924 VAStatus vaQuerySurfaceError(
1926 VASurfaceID surface,
1927 VAStatus error_status,
1932 * Images and Subpictures
1933 * VAImage is used to either get the surface data to client memory, or
1934 * to copy image data in client memory to a surface.
1935 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1936 * is at the upper left corner with positive X to the right and positive Y down
1938 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1939 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1940 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1942 /* a few common FourCCs */
1943 #define VA_FOURCC_NV12 0x3231564E
1944 #define VA_FOURCC_AI44 0x34344149
1945 #define VA_FOURCC_RGBA 0x41424752
1946 #define VA_FOURCC_BGRA 0x41524742
1947 #define VA_FOURCC_UYVY 0x59565955
1948 #define VA_FOURCC_YUY2 0x32595559
1949 #define VA_FOURCC_AYUV 0x56555941
1950 #define VA_FOURCC_NV11 0x3131564e
1951 #define VA_FOURCC_YV12 0x32315659
1952 #define VA_FOURCC_P208 0x38303250
1953 #define VA_FOURCC_IYUV 0x56555949
1954 #define VA_FOURCC_YV24 0x34325659
1955 #define VA_FOURCC_YV32 0x32335659
1958 #define VA_LSB_FIRST 1
1959 #define VA_MSB_FIRST 2
1961 typedef struct _VAImageFormat
1963 unsigned int fourcc;
1964 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1965 unsigned int bits_per_pixel;
1966 /* for RGB formats */
1967 unsigned int depth; /* significant bits per pixel */
1968 unsigned int red_mask;
1969 unsigned int green_mask;
1970 unsigned int blue_mask;
1971 unsigned int alpha_mask;
1974 typedef VAGenericID VAImageID;
1976 typedef struct _VAImage
1978 VAImageID image_id; /* uniquely identify this image */
1979 VAImageFormat format;
1980 VABufferID buf; /* image data buffer */
1982 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1983 * data store on the server side for optimal performance. The buffer will be
1984 * created by the CreateImage function, and proper storage allocated based on the image
1985 * size and format. This buffer is managed by the library implementation, and
1986 * accessed by the client through the buffer Map/Unmap functions.
1988 unsigned short width;
1989 unsigned short height;
1990 unsigned int data_size;
1991 unsigned int num_planes; /* can not be greater than 3 */
1993 * An array indicating the scanline pitch in bytes for each plane.
1994 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1996 unsigned int pitches[3];
1998 * An array indicating the byte offset from the beginning of the image data
1999 * to the start of each plane.
2001 unsigned int offsets[3];
2003 /* The following fields are only needed for paletted formats */
2004 int num_palette_entries; /* set to zero for non-palette images */
2006 * Each component is one byte and entry_bytes indicates the number of components in
2007 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2011 * An array of ascii characters describing the order of the components within the bytes.
2012 * Only entry_bytes characters of the string are used.
2014 char component_order[4];
2017 /* Get maximum number of image formats supported by the implementation */
2018 int vaMaxNumImageFormats (
2023 * Query supported image formats
2024 * The caller must provide a "format_list" array that can hold at
2025 * least vaMaxNumImageFormats() entries. The actual number of formats
2026 * returned in "format_list" is returned in "num_formats".
2028 VAStatus vaQueryImageFormats (
2030 VAImageFormat *format_list, /* out */
2031 int *num_formats /* out */
2035 * Create a VAImage structure
2036 * The width and height fields returned in the VAImage structure may get
2037 * enlarged for some YUV formats. Upon return from this function,
2038 * image->buf has been created and proper storage allocated by the library.
2039 * The client can access the image through the Map/Unmap calls.
2041 VAStatus vaCreateImage (
2043 VAImageFormat *format,
2046 VAImage *image /* out */
2050 * Should call DestroyImage before destroying the surface it is bound to
2052 VAStatus vaDestroyImage (
2057 VAStatus vaSetImagePalette (
2061 * pointer to an array holding the palette data. The size of the array is
2062 * num_palette_entries * entry_bytes in size. The order of the components
2063 * in the palette is described by the component_order in VAImage struct
2065 unsigned char *palette
2069 * Retrive surface data into a VAImage
2070 * Image must be in a format supported by the implementation
2072 VAStatus vaGetImage (
2074 VASurfaceID surface,
2075 int x, /* coordinates of the upper left source pixel */
2077 unsigned int width, /* width and height of the region */
2078 unsigned int height,
2083 * Copy data from a VAImage to a surface
2084 * Image must be in a format supported by the implementation
2085 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2086 * shouldn't be rendered into when this is called
2088 VAStatus vaPutImage (
2090 VASurfaceID surface,
2094 unsigned int src_width,
2095 unsigned int src_height,
2098 unsigned int dest_width,
2099 unsigned int dest_height
2103 * Derive an VAImage from an existing surface.
2104 * This interface will derive a VAImage and corresponding image buffer from
2105 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2106 * direct CPU access. This operation is only possible on implementations with
2107 * direct rendering capabilities and internal surface formats that can be
2108 * represented with a VAImage. When the operation is not possible this interface
2109 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2110 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2113 * Implementations should only return success when the resulting image buffer
2114 * would be useable with vaMap/Unmap.
2116 * When directly accessing a surface special care must be taken to insure
2117 * proper synchronization with the graphics hardware. Clients should call
2118 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2119 * rendering or currently being displayed by an overlay.
2121 * Additionally nothing about the contents of a surface should be assumed
2122 * following a vaPutSurface. Implementations are free to modify the surface for
2123 * scaling or subpicture blending within a call to vaPutImage.
2125 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2126 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2127 * vaGetImage with other surfaces is supported.
2129 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2130 * image and image buffer structures will be destroyed; however, the underlying
2131 * surface will remain unchanged until freed with vaDestroySurfaces.
2133 VAStatus vaDeriveImage (
2135 VASurfaceID surface,
2136 VAImage *image /* out */
2141 * Subpicture is a special type of image that can be blended
2142 * with a surface during vaPutSurface(). Subpicture can be used to render
2143 * DVD sub-titles or closed captioning text etc.
2146 typedef VAGenericID VASubpictureID;
2148 /* Get maximum number of subpicture formats supported by the implementation */
2149 int vaMaxNumSubpictureFormats (
2153 /* flags for subpictures */
2154 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2155 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2156 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2158 * Query supported subpicture formats
2159 * The caller must provide a "format_list" array that can hold at
2160 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2161 * for each format to indicate additional capabilities for that format. The actual
2162 * number of formats returned in "format_list" is returned in "num_formats".
2163 * flags: returned value to indicate addtional capabilities
2164 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2165 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2166 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2169 VAStatus vaQuerySubpictureFormats (
2171 VAImageFormat *format_list, /* out */
2172 unsigned int *flags, /* out */
2173 unsigned int *num_formats /* out */
2177 * Subpictures are created with an image associated.
2179 VAStatus vaCreateSubpicture (
2182 VASubpictureID *subpicture /* out */
2186 * Destroy the subpicture before destroying the image it is assocated to
2188 VAStatus vaDestroySubpicture (
2190 VASubpictureID subpicture
2194 * Bind an image to the subpicture. This image will now be associated with
2195 * the subpicture instead of the one at creation.
2197 VAStatus vaSetSubpictureImage (
2199 VASubpictureID subpicture,
2204 * If chromakey is enabled, then the area where the source value falls within
2205 * the chromakey [min, max] range is transparent
2206 * The chromakey component format is the following:
2207 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2208 * For YUV: [0:7] V [8:15] U [16:23] Y
2209 * The chromakey mask can be used to mask out certain components for chromakey
2212 VAStatus vaSetSubpictureChromakey (
2214 VASubpictureID subpicture,
2215 unsigned int chromakey_min,
2216 unsigned int chromakey_max,
2217 unsigned int chromakey_mask
2221 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2222 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2223 * the overall alpha is per-pixel alpha multiplied by the global alpha
2225 VAStatus vaSetSubpictureGlobalAlpha (
2227 VASubpictureID subpicture,
2232 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2233 * It defines the region mapping between the subpicture and the target
2234 * surfaces through source and destination rectangles (with the same width and height).
2235 * Both will be displayed at the next call to vaPutSurface. Additional
2236 * associations before the call to vaPutSurface simply overrides the association.
2238 VAStatus vaAssociateSubpicture (
2240 VASubpictureID subpicture,
2241 VASurfaceID *target_surfaces,
2243 short src_x, /* upper left offset in subpicture */
2245 unsigned short src_width,
2246 unsigned short src_height,
2247 short dest_x, /* upper left offset in surface */
2249 unsigned short dest_width,
2250 unsigned short dest_height,
2252 * whether to enable chroma-keying, global-alpha, or screen relative mode
2253 * see VA_SUBPICTURE_XXX values
2259 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2261 VAStatus vaDeassociateSubpicture (
2263 VASubpictureID subpicture,
2264 VASurfaceID *target_surfaces,
2268 typedef struct _VARectangle
2272 unsigned short width;
2273 unsigned short height;
2277 * Display attributes
2278 * Display attributes are used to control things such as contrast, hue, saturation,
2279 * brightness etc. in the rendering process. The application can query what
2280 * attributes are supported by the driver, and then set the appropriate attributes
2281 * before calling vaPutSurface()
2283 /* PowerVR IEP Lite attributes */
2286 VADISPLAYATTRIB_BLE_OFF = 0x00,
2287 VADISPLAYATTRIB_BLE_LOW,
2288 VADISPLAYATTRIB_BLE_MEDIUM,
2289 VADISPLAYATTRIB_BLE_HIGH,
2290 VADISPLAYATTRIB_BLE_NONE,
2291 } VADisplayAttribBLEMode;
2293 /* attribute value for VADisplayAttribRotation */
2294 #define VA_ROTATION_NONE 0x00000000
2295 #define VA_ROTATION_90 0x00000001
2296 #define VA_ROTATION_180 0x00000002
2297 #define VA_ROTATION_270 0x00000003
2299 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2300 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2301 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2304 #define VA_RENDER_MODE_UNDEFINED 0
2305 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2306 #define VA_RENDER_MODE_LOCAL_GPU 2
2307 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2308 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2311 #define VA_RENDER_DEVICE_UNDEFINED 0
2312 #define VA_RENDER_DEVICE_LOCAL 1
2313 #define VA_RENDER_DEVICE_EXTERNAL 2
2315 /* Currently defined display attribute types */
2318 VADisplayAttribBrightness = 0,
2319 VADisplayAttribContrast = 1,
2320 VADisplayAttribHue = 2,
2321 VADisplayAttribSaturation = 3,
2322 /* client can specifiy a background color for the target window
2323 * the new feature of video conference,
2324 * the uncovered area of the surface is filled by this color
2325 * also it will blend with the decoded video color
2327 VADisplayAttribBackgroundColor = 4,
2329 * this is a gettable only attribute. For some implementations that use the
2330 * hardware overlay, after PutSurface is called, the surface can not be
2331 * re-used until after the subsequent PutSurface call. If this is the case
2332 * then the value for this attribute will be set to 1 so that the client
2333 * will not attempt to re-use the surface right after returning from a call
2336 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2337 * driver may use overlay or GPU alternatively
2339 VADisplayAttribDirectSurface = 5,
2340 VADisplayAttribRotation = 6,
2341 VADisplayAttribOutofLoopDeblock = 7,
2343 /* PowerVR IEP Lite specific attributes */
2344 VADisplayAttribBLEBlackMode = 8,
2345 VADisplayAttribBLEWhiteMode = 9,
2346 VADisplayAttribBlueStretch = 10,
2347 VADisplayAttribSkinColorCorrection = 11,
2349 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2350 * conversion matrix. Each element in the matrix is float-point
2352 VADisplayAttribCSCMatrix = 12,
2353 /* specify the constant color used to blend with video surface
2354 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2355 * d: the final color to overwrite into the frame buffer
2356 * v: decoded video after color conversion,
2357 * c: video color specified by VADisplayAttribBlendColor
2358 * b: background color of the drawable
2360 VADisplayAttribBlendColor = 13,
2362 * Indicate driver to skip painting color key or not.
2363 * only applicable if the render is overlay
2365 VADisplayAttribOverlayAutoPaintColorKey = 14,
2367 * customized overlay color key, the format is RGB888
2368 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2370 VADisplayAttribOverlayColorKey = 15,
2372 * The hint for the implementation of vaPutSurface
2373 * normally, the driver could use an overlay or GPU to render the surface on the screen
2374 * this flag provides APP the flexibity to switch the render dynamically
2376 VADisplayAttribRenderMode = 16,
2378 * specify if vaPutSurface needs to render into specified monitors
2379 * one example is that one external monitor (e.g. HDMI) is enabled,
2380 * but the window manager is not aware of it, and there is no associated drawable
2382 VADisplayAttribRenderDevice = 17,
2384 * specify vaPutSurface render area if there is no drawable on the monitor
2386 VADisplayAttribRenderRect = 18,
2387 } VADisplayAttribType;
2389 /* flags for VADisplayAttribute */
2390 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2391 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2392 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2394 typedef struct _VADisplayAttribute
2396 VADisplayAttribType type;
2399 int value; /* used by the set/get attribute functions */
2400 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2402 } VADisplayAttribute;
2404 /* Get maximum number of display attributs supported by the implementation */
2405 int vaMaxNumDisplayAttributes (
2410 * Query display attributes
2411 * The caller must provide a "attr_list" array that can hold at
2412 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2413 * returned in "attr_list" is returned in "num_attributes".
2415 VAStatus vaQueryDisplayAttributes (
2417 VADisplayAttribute *attr_list, /* out */
2418 int *num_attributes /* out */
2422 * Get display attributes
2423 * This function returns the current attribute values in "attr_list".
2424 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2425 * from vaQueryDisplayAttributes() can have their values retrieved.
2427 VAStatus vaGetDisplayAttributes (
2429 VADisplayAttribute *attr_list, /* in/out */
2434 * Set display attributes
2435 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2436 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2437 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2439 VAStatus vaSetDisplayAttributes (
2441 VADisplayAttribute *attr_list,