2 * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19 * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
20 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 * Video Acceleration (VA) API Specification
28 * <jonathan.bian@intel.com>
31 * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
32 * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
33 * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
34 * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
35 * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
36 * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
37 * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
38 * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
39 * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
40 * and MPEG-2 motion compensation.
41 * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
42 * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
43 * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
44 * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
45 * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
46 * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
47 * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
48 * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
49 * rev 0.27 (11/19/2007 Matt Sottek) - Added DeriveImage
50 * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
52 * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
53 * added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
54 * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
55 * for ISO C conformance.
56 * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
57 * Application needs to relink with the new library.
59 * rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
60 * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
61 * screen relative rather than source video relative.
62 * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
63 * update VAAPI to 0.32.0
66 * Some concepts borrowed from XvMC and XvImage.
67 * Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
68 * contributed to various aspects of the API.
75 * This file contains the \ref api_core "Core API".
81 #include <va/va_version.h>
88 * \mainpage Video Acceleration (VA) API
90 * \section intro Introduction
92 * The main motivation for VA-API (Video Acceleration API) is to
93 * enable hardware accelerated video decode and encode at various
94 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
95 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
96 * AVC/H.264, VC-1/VMW3, and JPEG).
98 * VA-API is split into several modules:
100 * - \ref api_enc_core
101 * - \ref api_enc_h264
106 * \defgroup api_core Core API
114 The VA API is intended to provide an interface between a video decode/encode/display
115 application (client) and a hardware accelerator (server), to off-load
116 video decode/encode/display operations from the host to the hardware accelerator at various
119 The basic operation steps are:
121 - Negotiate a mutually acceptable configuration with the server to lock
122 down profile, entrypoints, and other attributes that will not change on
123 a frame-by-frame basis.
124 - Create a decode context which represents a "virtualized" hardware decode
126 - Get and fill decode buffers with picture level, slice level and macroblock
127 level data (depending on entrypoints)
128 - Pass the decode buffers to the server to decode the current frame
130 Initialization & Configuration Management
132 - Find out supported profiles
133 - Find out entrypoints for a given profile
134 - Find out configuration attributes for a given profile/entrypoint pair
135 - Create a configuration for use by the decoder
139 typedef void* VADisplay; /* window system dependent */
141 typedef int VAStatus; /* Return status type from functions */
142 /* Values for the return status */
143 #define VA_STATUS_SUCCESS 0x00000000
144 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
145 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
146 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
147 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
148 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
149 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
150 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
151 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
152 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
153 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
154 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
155 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
156 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
157 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
158 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
159 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
160 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
161 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
162 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
163 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
164 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
165 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
166 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
167 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
169 * \brief An invalid/unsupported value was supplied.
171 * This is a catch-all error code for invalid or unsupported values.
172 * e.g. value exceeding the valid range, invalid type in the context
173 * of generic attribute values.
175 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
176 /** \brief An unsupported filter was supplied. */
177 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
178 /** \brief An invalid filter chain was supplied. */
179 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
180 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
181 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
182 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
184 /* De-interlacing flags for vaPutSurface() */
185 #define VA_FRAME_PICTURE 0x00000000
186 #define VA_TOP_FIELD 0x00000001
187 #define VA_BOTTOM_FIELD 0x00000002
190 * Enabled the positioning/cropping/blending feature:
191 * 1, specify the video playback position in the isurface
192 * 2, specify the cropping info for video playback
193 * 3, encoded video will blend with background color
195 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
198 * Clears the drawable with background color.
199 * for hardware overlay based implementation this flag
200 * can be used to turn off the overlay
202 #define VA_CLEAR_DRAWABLE 0x00000008
204 /* Color space conversion flags for vaPutSurface() */
205 #define VA_SRC_BT601 0x00000010
206 #define VA_SRC_BT709 0x00000020
207 #define VA_SRC_SMPTE_240 0x00000040
209 /* Scaling flags for vaPutSurface() */
210 #define VA_FILTER_SCALING_DEFAULT 0x00000000
211 #define VA_FILTER_SCALING_FAST 0x00000100
212 #define VA_FILTER_SCALING_HQ 0x00000200
213 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
214 #define VA_FILTER_SCALING_MASK 0x00000f00
217 * Returns a short english description of error_status
219 const char *vaErrorStr(VAStatus error_status);
223 * A display must be obtained by calling vaGetDisplay() before calling
224 * vaInitialize() and other functions. This connects the API to the
225 * native window system.
226 * For X Windows, native_dpy would be from XOpenDisplay()
228 typedef void* VANativeDisplay; /* window system dependent */
230 int vaDisplayIsValid(VADisplay dpy);
233 * Initialize the library
235 VAStatus vaInitialize (
237 int *major_version, /* out */
238 int *minor_version /* out */
242 * After this call, all library internal resources will be cleaned up
244 VAStatus vaTerminate (
249 * vaQueryVendorString returns a pointer to a zero-terminated string
250 * describing some aspects of the VA implemenation on a specific
251 * hardware accelerator. The format of the returned string is vendor
252 * specific and at the discretion of the implementer.
253 * e.g. for the Intel GMA500 implementation, an example would be:
254 * "Intel GMA500 - 2.0.0.32L.0005"
256 const char *vaQueryVendorString (
260 typedef int (*VAPrivFunc)();
263 * Return a function pointer given a function name in the library.
264 * This allows private interfaces into the library
266 VAPrivFunc vaGetLibFunc (
271 /* Currently defined profiles */
274 /** \brief Profile ID used for video processing. */
276 VAProfileMPEG2Simple = 0,
277 VAProfileMPEG2Main = 1,
278 VAProfileMPEG4Simple = 2,
279 VAProfileMPEG4AdvancedSimple = 3,
280 VAProfileMPEG4Main = 4,
281 VAProfileH264Baseline = 5,
282 VAProfileH264Main = 6,
283 VAProfileH264High = 7,
284 VAProfileVC1Simple = 8,
285 VAProfileVC1Main = 9,
286 VAProfileVC1Advanced = 10,
287 VAProfileH263Baseline = 11,
288 VAProfileJPEGBaseline = 12,
289 VAProfileH264ConstrainedBaseline = 13,
290 VAProfileH264MultiviewHigh = 14,
291 VAProfileH264StereoHigh = 15,
292 VAProfileVP8Version0_3 = 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. */
311 /* Currently defined configuration attribute types */
314 VAConfigAttribRTFormat = 0,
315 VAConfigAttribSpatialResidual = 1,
316 VAConfigAttribSpatialClipping = 2,
317 VAConfigAttribIntraResidual = 3,
318 VAConfigAttribEncryption = 4,
319 VAConfigAttribRateControl = 5,
321 /** @name Attributes for encoding */
324 * \brief Packed headers mode. Read/write.
326 * This attribute determines what packed headers the driver supports,
327 * through vaGetConfigAttributes(); and what packed headers the user
328 * will be providing to the driver, through vaCreateConfig(), if the
329 * driver supports those.
331 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
333 VAConfigAttribEncPackedHeaders = 10,
335 * \brief Interlaced mode. Read/write.
337 * This attribute determines what kind of interlaced encoding mode
338 * the driver supports.
340 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
342 VAConfigAttribEncInterlaced = 11,
344 * \brief Maximum number of reference frames. Read-only.
346 * This attribute determines the maximum number of reference
347 * frames supported for encoding.
349 * Note: for H.264 encoding, the value represents the maximum number
350 * of reference frames for both the reference picture list 0 (bottom
351 * 16 bits) and the reference picture list 1 (top 16 bits).
353 VAConfigAttribEncMaxRefFrames = 13,
355 * \brief Maximum number of slices per frame. Read-only.
357 * This attribute determines the maximum number of slices the
358 * driver can support to encode a single frame.
360 VAConfigAttribEncMaxSlices = 14,
362 * \brief Slice structure. Read-only.
364 * This attribute determines slice structures supported by the
365 * driver for encoding. This attribute is a hint to the user so
366 * that he can choose a suitable surface size and how to arrange
367 * the encoding process of multiple slices per frame.
369 * More specifically, for H.264 encoding, this attribute
370 * determines the range of accepted values to
371 * VAEncSliceParameterBufferH264::macroblock_address and
372 * VAEncSliceParameterBufferH264::num_macroblocks.
374 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
377 VAConfigAttribEncSliceStructure = 15,
379 * \brief Macroblock information. Read-only.
381 * This attribute determines whether the driver supports extra
382 * encoding information per-macroblock. e.g. QP.
384 * More specifically, for H.264 encoding, if the driver returns a non-zero
385 * value for this attribute, this means the application can create
386 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
387 * through VAEncSliceParameterBufferH264::macroblock_info.
389 VAConfigAttribEncMacroblockInfo = 16,
391 VAConfigAttribTypeMax
392 } VAConfigAttribType;
395 * Configuration attributes
396 * If there is more than one value for an attribute, a default
397 * value will be assigned to the attribute if the client does not
398 * specify the attribute when creating a configuration
400 typedef struct _VAConfigAttrib {
401 VAConfigAttribType type;
402 unsigned int value; /* OR'd flags (bits) for this attribute */
405 /* attribute value for VAConfigAttribRTFormat */
406 #define VA_RT_FORMAT_YUV420 0x00000001
407 #define VA_RT_FORMAT_YUV422 0x00000002
408 #define VA_RT_FORMAT_YUV444 0x00000004
409 #define VA_RT_FORMAT_PROTECTED 0x80000000
411 /** @name Attribute values for VAConfigAttribRateControl */
413 /** \brief Driver does not support any form of rate control. */
414 #define VA_RC_NONE 0x00000001
415 /** \brief Constant bitrate. */
416 #define VA_RC_CBR 0x00000002
417 /** \brief Variable bitrate. */
418 #define VA_RC_VBR 0x00000004
419 /** \brief Video conference mode. */
420 #define VA_RC_VCM 0x00000008
421 /** \brief Constant QP. */
422 #define VA_RC_CQP 0x00000010
423 /** \brief Variable bitrate with peak rate higher than average bitrate. */
424 #define VA_RC_VBR_CONSTRAINED 0x00000020
427 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
429 /** \brief Driver does not support any packed headers mode. */
430 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
431 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
432 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
433 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
434 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
435 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
436 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
437 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
438 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
441 /** @name Attribute values for VAConfigAttribEncInterlaced */
443 /** \brief Driver does not support interlaced coding. */
444 #define VA_ENC_INTERLACED_NONE 0x00000000
445 /** \brief Driver supports interlaced frame coding. */
446 #define VA_ENC_INTERLACED_FRAME 0x00000001
447 /** \brief Driver supports interlaced field coding. */
448 #define VA_ENC_INTERLACED_FIELD 0x00000002
449 /** \brief Driver supports macroblock adaptive frame field coding. */
450 #define VA_ENC_INTERLACED_MBAFF 0x00000004
451 /** \brief Driver supports picture adaptive frame field coding. */
452 #define VA_ENC_INTERLACED_PAFF 0x00000008
455 /** @name Attribute values for VAConfigAttribEncSliceStructure */
457 /** \brief Driver supports an arbitrary number of rows per slice. */
458 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
459 /** \brief Driver supports a power-of-two number of rows per slice. */
460 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
461 /** \brief Driver supports an arbitrary number of rows per slice. */
462 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
466 * if an attribute is not applicable for a given
467 * profile/entrypoint pair, then set the value to the following
469 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
471 /* Get maximum number of profiles supported by the implementation */
472 int vaMaxNumProfiles (
476 /* Get maximum number of entrypoints supported by the implementation */
477 int vaMaxNumEntrypoints (
481 /* Get maximum number of attributs supported by the implementation */
482 int vaMaxNumConfigAttributes (
487 * Query supported profiles
488 * The caller must provide a "profile_list" array that can hold at
489 * least vaMaxNumProfile() entries. The actual number of profiles
490 * returned in "profile_list" is returned in "num_profile".
492 VAStatus vaQueryConfigProfiles (
494 VAProfile *profile_list, /* out */
495 int *num_profiles /* out */
499 * Query supported entrypoints for a given profile
500 * The caller must provide an "entrypoint_list" array that can hold at
501 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
502 * returned in "entrypoint_list" is returned in "num_entrypoints".
504 VAStatus vaQueryConfigEntrypoints (
507 VAEntrypoint *entrypoint_list, /* out */
508 int *num_entrypoints /* out */
512 * Get attributes for a given profile/entrypoint pair
513 * The caller must provide an "attrib_list" with all attributes to be
514 * retrieved. Upon return, the attributes in "attrib_list" have been
515 * updated with their value. Unknown attributes or attributes that are
516 * not supported for the given profile/entrypoint pair will have their
517 * value set to VA_ATTRIB_NOT_SUPPORTED
519 VAStatus vaGetConfigAttributes (
522 VAEntrypoint entrypoint,
523 VAConfigAttrib *attrib_list, /* in/out */
527 /* Generic ID type, can be re-typed for specific implementation */
528 typedef unsigned int VAGenericID;
530 typedef VAGenericID VAConfigID;
533 * Create a configuration for the decode pipeline
534 * it passes in the attribute list that specifies the attributes it cares
535 * about, with the rest taking default values.
537 VAStatus vaCreateConfig (
540 VAEntrypoint entrypoint,
541 VAConfigAttrib *attrib_list,
543 VAConfigID *config_id /* out */
547 * Free resources associdated with a given config
549 VAStatus vaDestroyConfig (
555 * Query all attributes for a given configuration
556 * The profile of the configuration is returned in "profile"
557 * The entrypoint of the configuration is returned in "entrypoint"
558 * The caller must provide an "attrib_list" array that can hold at least
559 * vaMaxNumConfigAttributes() entries. The actual number of attributes
560 * returned in "attrib_list" is returned in "num_attribs"
562 VAStatus vaQueryConfigAttributes (
564 VAConfigID config_id,
565 VAProfile *profile, /* out */
566 VAEntrypoint *entrypoint, /* out */
567 VAConfigAttrib *attrib_list,/* out */
568 int *num_attribs /* out */
573 * Contexts and Surfaces
575 * Context represents a "virtual" video decode pipeline. Surfaces are render
576 * targets for a given context. The data in the surfaces are not accessible
577 * to the client and the internal data format of the surface is implementatin
580 * Surfaces will be bound to a context when the context is created. Once
581 * a surface is bound to a given context, it can not be used to create
582 * another context. The association is removed when the context is destroyed
584 * Both contexts and surfaces are identified by unique IDs and its
585 * implementation specific internals are kept opaque to the clients
588 typedef VAGenericID VAContextID;
590 typedef VAGenericID VASurfaceID;
592 #define VA_INVALID_ID 0xffffffff
593 #define VA_INVALID_SURFACE VA_INVALID_ID
595 /** \brief Generic value types. */
597 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
598 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
599 VAGenericValueTypePointer, /**< Generic pointer type */
600 VAGenericValueTypeFunc /**< Pointer to function */
601 } VAGenericValueType;
603 /** \brief Generic function type. */
604 typedef void (*VAGenericFunc)(void);
606 /** \brief Generic value. */
607 typedef struct _VAGenericValue {
608 /** \brief Value type. See #VAGenericValueType. */
609 VAGenericValueType type;
610 /** \brief Value holder. */
612 /** \brief 32-bit signed integer. */
614 /** \brief 32-bit float. */
616 /** \brief Generic pointer. */
618 /** \brief Pointer to function. */
623 /** @name Surface attribute flags */
625 /** \brief Surface attribute is not supported. */
626 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
627 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
628 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
629 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
630 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
633 /** \brief Surface attribute types. */
635 VASurfaceAttribNone = 0,
637 * \brief Pixel format (fourcc).
639 * The value is meaningful as input to vaQuerySurfaceAttributes().
640 * If zero, the driver returns the optimal pixel format for the
641 * specified config. Otherwise, if non-zero, the value represents
642 * a pixel format (FOURCC) that is kept as is on output, if the
643 * driver supports it. Otherwise, the driver sets the value to
644 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
646 VASurfaceAttribPixelFormat,
647 /** \brief Minimal width in pixels (int, read/write). */
648 VASurfaceAttribMinWidth,
649 /** \brief Maximal width in pixels (int, read-only). */
650 VASurfaceAttribMaxWidth,
651 /** \brief Minimal height in pixels (int, read-only). */
652 VASurfaceAttribMinHeight,
653 /** \brief Maximal height in pixels (int, read-only). */
654 VASurfaceAttribMaxHeight,
655 /** \brief Number of surface attributes. */
657 } VASurfaceAttribType;
659 /** \brief Surface attribute. */
660 typedef struct _VASurfaceAttrib {
662 VASurfaceAttribType type;
663 /** \brief Flags. See "Surface attribute flags". */
665 /** \brief Value. See "Surface attribute types" for the expected types. */
666 VAGenericValue value;
670 * \brief Get surface attributes for the supplied config.
672 * This function retrieves the surface attributes matching the supplied
673 * config. The caller shall provide an \c attrib_list with all attributes
674 * to be retrieved. Upon successful return, the attributes in \c attrib_list
675 * are updated with the requested value. Unknown attributes or attributes
676 * that are not supported for the given config will have their \c flags
677 * field set to \c VA_SURFACE_ATTRIB_NOT_SUPPORTED.
679 * @param[in] dpy the VA display
680 * @param[in] config the config identifying a codec or a video
681 * processing pipeline
682 * @param[in,out] attrib_list the list of attributes on input, with at
683 * least \c type fields filled in, and possibly \c value fields whenever
684 * necessary. The updated list of attributes and flags on output
685 * @param[in] num_attribs the number of attributes supplied in the
686 * \c attrib_list array
689 vaGetSurfaceAttributes(
692 VASurfaceAttrib *attrib_list,
693 unsigned int num_attribs
697 * \brief Creates an array of surfaces
699 * Creates an array of surfaces. The optional list of attributes shall
700 * be constructed and verified through vaGetSurfaceAttributes().
702 * @param[in] dpy the VA display
703 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
704 * @param[in] width the surface width
705 * @param[in] height the surface height
706 * @param[out] surfaces the array of newly created surfaces
707 * @param[in] num_surfaces the number of surfaces to create
708 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
709 * @param[in] num_attribs the number of attributes supplied in
710 * \c attrib_list, or zero
718 VASurfaceID *surfaces,
719 unsigned int num_surfaces,
720 VASurfaceAttrib *attrib_list,
721 unsigned int num_attribs
725 * vaDestroySurfaces - Destroy resources associated with surfaces.
726 * Surfaces can only be destroyed after the context associated has been
729 * surfaces: array of surfaces to destroy
730 * num_surfaces: number of surfaces in the array to be destroyed.
732 VAStatus vaDestroySurfaces (
734 VASurfaceID *surfaces,
738 #define VA_PROGRESSIVE 0x1
740 * vaCreateContext - Create a context
742 * config_id: configuration for the context
743 * picture_width: coded picture width
744 * picture_height: coded picture height
745 * flag: any combination of the following:
746 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
747 * render_targets: render targets (surfaces) tied to the context
748 * num_render_targets: number of render targets in the above array
749 * context: created context id upon return
751 VAStatus vaCreateContext (
753 VAConfigID config_id,
757 VASurfaceID *render_targets,
758 int num_render_targets,
759 VAContextID *context /* out */
763 * vaDestroyContext - Destroy a context
765 * context: context to be destroyed
767 VAStatus vaDestroyContext (
774 * Buffers are used to pass various types of data from the
775 * client to the server. The server maintains a data store
776 * for each buffer created, and the client idenfies a buffer
777 * through a unique buffer id assigned by the server.
780 typedef VAGenericID VABufferID;
784 VAPictureParameterBufferType = 0,
785 VAIQMatrixBufferType = 1,
786 VABitPlaneBufferType = 2,
787 VASliceGroupMapBufferType = 3,
788 VASliceParameterBufferType = 4,
789 VASliceDataBufferType = 5,
790 VAMacroblockParameterBufferType = 6,
791 VAResidualDataBufferType = 7,
792 VADeblockingParameterBufferType = 8,
793 VAImageBufferType = 9,
794 VAProtectedSliceDataBufferType = 10,
795 VAQMatrixBufferType = 11,
796 VAHuffmanTableBufferType = 12,
797 VAProbabilityBufferType = 13,
798 /* Following are encode buffer types */
799 VAEncCodedBufferType = 21,
800 VAEncSequenceParameterBufferType = 22,
801 VAEncPictureParameterBufferType = 23,
802 VAEncSliceParameterBufferType = 24,
803 VAEncPackedHeaderParameterBufferType = 25,
804 VAEncPackedHeaderDataBufferType = 26,
805 VAEncMiscParameterBufferType = 27,
806 VAEncMacroblockParameterBufferType = 28,
807 /* Following are video processing buffer types */
809 * \brief Video processing pipeline parameter buffer.
811 * This buffer describes the video processing pipeline. See
812 * #VAProcPipelineParameterBuffer for details.
814 VAProcPipelineParameterBufferType = 41,
816 * \brief Video filter parameter buffer.
818 * This buffer describes the video filter parameters. All buffers
819 * inherit from #VAProcFilterParameterBufferBase, thus including
820 * a unique filter buffer type.
822 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
823 * Filters requiring advanced parameters include, but are not limited to,
824 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
825 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
827 VAProcFilterParameterBufferType = 42,
833 VAEncMiscParameterTypeFrameRate = 0,
834 VAEncMiscParameterTypeRateControl = 1,
835 VAEncMiscParameterTypeMaxSliceSize = 2,
836 VAEncMiscParameterTypeAIR = 3,
837 /** \brief Buffer type used to express a maximum frame size (in bits). */
838 VAEncMiscParameterTypeMaxFrameSize = 4,
839 /** \brief Buffer type used for HRD parameters. */
840 VAEncMiscParameterTypeHRD = 5,
841 } VAEncMiscParameterType;
843 /** \brief Packed header type. */
845 /** \brief Packed sequence header. */
846 VAEncPackedHeaderSequence = 1,
847 /** \brief Packed picture header. */
848 VAEncPackedHeaderPicture = 2,
849 /** \brief Packed slice header. */
850 VAEncPackedHeaderSlice = 3,
851 /** \brief Misc packed header. See codec-specific definitions. */
852 VAEncPackedHeaderMiscMask = 0x80000000,
853 } VAEncPackedHeaderType;
855 /** \brief Packed header parameter. */
856 typedef struct _VAEncPackedHeaderParameterBuffer {
857 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
859 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
860 unsigned int bit_length;
861 /** \brief Flag: buffer contains start code emulation prevention bytes? */
862 unsigned char has_emulation_bytes;
863 } VAEncPackedHeaderParameterBuffer;
866 * For application, e.g. set a new bitrate
868 * VAEncMiscParameterBuffer *misc_param;
869 * VAEncMiscParameterRateControl *misc_rate_ctrl;
871 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
872 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
875 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
876 * misc_param->type = VAEncMiscParameterTypeRateControl;
877 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
878 * misc_rate_ctrl->bits_per_second = 6400000;
879 * vaUnmapBuffer(dpy, buf_id);
880 * vaRenderPicture(dpy, context, &buf_id, 1);
882 typedef struct _VAEncMiscParameterBuffer
884 VAEncMiscParameterType type;
885 unsigned int data[0];
886 } VAEncMiscParameterBuffer;
889 /** \brief Rate control parameters */
890 typedef struct _VAEncMiscParameterRateControl
892 /* this is the maximum bit-rate to be constrained by the rate control implementation */
893 unsigned int bits_per_second;
894 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
895 * bit-rate for example if target_percentage is 95 then the rate control will target
896 * a bit-rate that is 95% of the maximum bit-rate
898 unsigned int target_percentage;
899 /* windows size in milliseconds. For example if this is set to 500,
900 * then the rate control will guarantee the target bit-rate over a 500 ms window
902 unsigned int window_size;
903 /* initial QP at I frames */
904 unsigned int initial_qp;
906 unsigned int basic_unit_size;
911 unsigned int reset : 1;
912 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
913 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
917 } VAEncMiscParameterRateControl;
919 typedef struct _VAEncMiscParameterFrameRate
921 unsigned int framerate;
922 } VAEncMiscParameterFrameRate;
925 * Allow a maximum slice size to be specified (in bits).
926 * The encoder will attempt to make sure that individual slices do not exceed this size
927 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
929 typedef struct _VAEncMiscParameterMaxSliceSize
931 unsigned int max_slice_size;
932 } VAEncMiscParameterMaxSliceSize;
934 typedef struct _VAEncMiscParameterAIR
936 unsigned int air_num_mbs;
937 unsigned int air_threshold;
938 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
939 } VAEncMiscParameterAIR;
941 typedef struct _VAEncMiscParameterHRD
943 unsigned int initial_buffer_fullness; /* in bits */
944 unsigned int buffer_size; /* in bits */
945 } VAEncMiscParameterHRD;
948 * \brief Defines a maximum frame size (in bits).
950 * This misc parameter buffer defines the maximum size of a frame (in
951 * bits). The encoder will try to make sure that each frame does not
952 * exceed this size. Otherwise, if the frame size exceeds this size,
953 * the \c status flag of #VACodedBufferSegment will contain
954 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
956 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
957 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
958 VAEncMiscParameterType type;
959 /** \brief Maximum size of a frame (in bits). */
960 unsigned int max_frame_size;
961 } VAEncMiscParameterBufferMaxFrameSize;
964 * There will be cases where the bitstream buffer will not have enough room to hold
965 * the data for the entire slice, and the following flags will be used in the slice
966 * parameter to signal to the server for the possible cases.
967 * If a slice parameter buffer and slice data buffer pair is sent to the server with
968 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
969 * then a slice parameter and data buffer needs to be sent again to complete this slice.
971 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
972 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
973 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
974 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
976 /* Codec-independent Slice Parameter Buffer base */
977 typedef struct _VASliceParameterBufferBase
979 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
980 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
981 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
982 } VASliceParameterBufferBase;
985 /****************************
986 * JEPG data structure
987 ***************************/
988 typedef struct _VAQMatrixBufferJPEG
990 int load_lum_quantiser_matrix;
991 int load_chroma_quantiser_matrix;
992 unsigned char lum_quantiser_matrix[64];
993 unsigned char chroma_quantiser_matrix[64];
994 } VAQMatrixBufferJPEG;
996 typedef struct _VAEncPictureParameterBufferJPEG
998 VASurfaceID reconstructed_picture;
999 unsigned short picture_width;
1000 unsigned short picture_height;
1001 VABufferID coded_buf;
1002 } VAEncPictureParameterBufferJPEG;
1004 #include <va/va_dec_jpeg.h>
1006 /****************************
1007 * MPEG-2 data structures
1008 ****************************/
1010 /* MPEG-2 Picture Parameter Buffer */
1012 * For each frame or field, and before any slice data, a single
1013 * picture parameter buffer must be send.
1015 typedef struct _VAPictureParameterBufferMPEG2
1017 unsigned short horizontal_size;
1018 unsigned short vertical_size;
1019 VASurfaceID forward_reference_picture;
1020 VASurfaceID backward_reference_picture;
1021 /* meanings of the following fields are the same as in the standard */
1022 int picture_coding_type;
1023 int f_code; /* pack all four fcode into this */
1026 unsigned int intra_dc_precision : 2;
1027 unsigned int picture_structure : 2;
1028 unsigned int top_field_first : 1;
1029 unsigned int frame_pred_frame_dct : 1;
1030 unsigned int concealment_motion_vectors : 1;
1031 unsigned int q_scale_type : 1;
1032 unsigned int intra_vlc_format : 1;
1033 unsigned int alternate_scan : 1;
1034 unsigned int repeat_first_field : 1;
1035 unsigned int progressive_frame : 1;
1036 unsigned int is_first_field : 1; /* indicate whether the current field
1037 * is the first field for field picture
1041 } picture_coding_extension;
1042 } VAPictureParameterBufferMPEG2;
1044 /* MPEG-2 Inverse Quantization Matrix Buffer */
1045 typedef struct _VAIQMatrixBufferMPEG2
1047 int load_intra_quantiser_matrix;
1048 int load_non_intra_quantiser_matrix;
1049 int load_chroma_intra_quantiser_matrix;
1050 int load_chroma_non_intra_quantiser_matrix;
1051 unsigned char intra_quantiser_matrix[64];
1052 unsigned char non_intra_quantiser_matrix[64];
1053 unsigned char chroma_intra_quantiser_matrix[64];
1054 unsigned char chroma_non_intra_quantiser_matrix[64];
1055 } VAIQMatrixBufferMPEG2;
1057 /* MPEG-2 Slice Parameter Buffer */
1058 typedef struct _VASliceParameterBufferMPEG2
1060 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1061 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1062 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1063 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1064 unsigned int slice_horizontal_position;
1065 unsigned int slice_vertical_position;
1066 int quantiser_scale_code;
1067 int intra_slice_flag;
1068 } VASliceParameterBufferMPEG2;
1070 /* MPEG-2 Macroblock Parameter Buffer */
1071 typedef struct _VAMacroblockParameterBufferMPEG2
1073 unsigned short macroblock_address;
1075 * macroblock_address (in raster scan order)
1077 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1079 unsigned char macroblock_type; /* see definition below */
1082 unsigned int frame_motion_type : 2;
1083 unsigned int field_motion_type : 2;
1084 unsigned int dct_type : 1;
1088 unsigned char motion_vertical_field_select;
1090 * motion_vertical_field_select:
1091 * see section 6.3.17.2 in the spec
1092 * only the lower 4 bits are used
1093 * bit 0: first vector forward
1094 * bit 1: first vector backward
1095 * bit 2: second vector forward
1096 * bit 3: second vector backward
1098 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1099 unsigned short coded_block_pattern;
1101 * The bitplanes for coded_block_pattern are described
1102 * in Figure 6.10-12 in the spec
1105 /* Number of skipped macroblocks after this macroblock */
1106 unsigned short num_skipped_macroblocks;
1107 } VAMacroblockParameterBufferMPEG2;
1110 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1112 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1113 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1114 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1115 #define VA_MB_TYPE_MOTION_INTRA 0x10
1118 * MPEG-2 Residual Data Buffer
1119 * For each macroblock, there wil be 64 shorts (16-bit) in the
1120 * residual data buffer
1123 /****************************
1124 * MPEG-4 Part 2 data structures
1125 ****************************/
1127 /* MPEG-4 Picture Parameter Buffer */
1129 * For each frame or field, and before any slice data, a single
1130 * picture parameter buffer must be send.
1132 typedef struct _VAPictureParameterBufferMPEG4
1134 unsigned short vop_width;
1135 unsigned short vop_height;
1136 VASurfaceID forward_reference_picture;
1137 VASurfaceID backward_reference_picture;
1140 unsigned int short_video_header : 1;
1141 unsigned int chroma_format : 2;
1142 unsigned int interlaced : 1;
1143 unsigned int obmc_disable : 1;
1144 unsigned int sprite_enable : 2;
1145 unsigned int sprite_warping_accuracy : 2;
1146 unsigned int quant_type : 1;
1147 unsigned int quarter_sample : 1;
1148 unsigned int data_partitioned : 1;
1149 unsigned int reversible_vlc : 1;
1150 unsigned int resync_marker_disable : 1;
1154 unsigned char no_of_sprite_warping_points;
1155 short sprite_trajectory_du[3];
1156 short sprite_trajectory_dv[3];
1157 unsigned char quant_precision;
1160 unsigned int vop_coding_type : 2;
1161 unsigned int backward_reference_vop_coding_type : 2;
1162 unsigned int vop_rounding_type : 1;
1163 unsigned int intra_dc_vlc_thr : 3;
1164 unsigned int top_field_first : 1;
1165 unsigned int alternate_vertical_scan_flag : 1;
1169 unsigned char vop_fcode_forward;
1170 unsigned char vop_fcode_backward;
1171 unsigned short vop_time_increment_resolution;
1172 /* short header related */
1173 unsigned char num_gobs_in_vop;
1174 unsigned char num_macroblocks_in_gob;
1175 /* for direct mode prediction */
1178 } VAPictureParameterBufferMPEG4;
1180 /* MPEG-4 Inverse Quantization Matrix Buffer */
1181 typedef struct _VAIQMatrixBufferMPEG4
1183 int load_intra_quant_mat;
1184 int load_non_intra_quant_mat;
1185 unsigned char intra_quant_mat[64];
1186 unsigned char non_intra_quant_mat[64];
1187 } VAIQMatrixBufferMPEG4;
1189 /* MPEG-4 Slice Parameter Buffer */
1190 typedef struct _VASliceParameterBufferMPEG4
1192 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1193 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1194 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1195 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1196 unsigned int macroblock_number;
1198 } VASliceParameterBufferMPEG4;
1201 VC-1 data structures
1204 typedef enum /* see 7.1.1.32 */
1207 VAMvMode1MvHalfPel = 1,
1208 VAMvMode1MvHalfPelBilinear = 2,
1209 VAMvModeMixedMv = 3,
1210 VAMvModeIntensityCompensation = 4
1213 /* VC-1 Picture Parameter Buffer */
1215 * For each picture, and before any slice data, a picture parameter
1216 * buffer must be send. Multiple picture parameter buffers may be
1217 * sent for a single picture. In that case picture parameters will
1218 * apply to all slice data that follow it until a new picture
1219 * parameter buffer is sent.
1222 * pic_quantizer_type should be set to the applicable quantizer
1223 * type as defined by QUANTIZER (J.1.19) and either
1224 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1226 typedef struct _VAPictureParameterBufferVC1
1228 VASurfaceID forward_reference_picture;
1229 VASurfaceID backward_reference_picture;
1230 /* if out-of-loop post-processing is done on the render
1231 target, then we need to keep the in-loop decoded
1232 picture as a reference picture */
1233 VASurfaceID inloop_decoded_picture;
1235 /* sequence layer for AP or meta data for SP and MP */
1238 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1239 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1240 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1241 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1242 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1243 unsigned int multires : 1; /* METADATA::MULTIRES */
1244 unsigned int overlap : 1; /* METADATA::OVERLAP */
1245 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1246 unsigned int rangered : 1; /* METADATA::RANGERED */
1247 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1248 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1253 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1254 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1257 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1258 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1259 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1260 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1263 } entrypoint_fields;
1264 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1265 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1268 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1269 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1270 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1271 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1274 } range_mapping_fields;
1276 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1277 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1278 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1279 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1280 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1281 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1282 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1283 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1284 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1287 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1288 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1289 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1290 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1291 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1297 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1298 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1299 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1300 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1301 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1302 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1303 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1309 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1310 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1311 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1312 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1313 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1314 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1315 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1318 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1321 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1322 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1323 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1324 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1330 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1331 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1332 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1333 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1334 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1335 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1336 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1337 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1338 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1339 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1345 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1346 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1347 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1348 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1349 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1350 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1351 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1352 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1353 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1354 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1355 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1358 } pic_quantizer_fields;
1361 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1362 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1363 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1364 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1365 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1366 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1370 } VAPictureParameterBufferVC1;
1372 /* VC-1 Bitplane Buffer
1373 There will be at most three bitplanes coded in any picture header. To send
1374 the bitplane data more efficiently, each byte is divided in two nibbles, with
1375 each nibble carrying three bitplanes for one macroblock. The following table
1376 shows the bitplane data arrangement within each nibble based on the picture
1379 Picture Type Bit3 Bit2 Bit1 Bit0
1380 I or BI OVERFLAGS ACPRED FIELDTX
1381 P MYTYPEMB SKIPMB DIRECTMB
1382 B FORWARDMB SKIPMB DIRECTMB
1384 Within each byte, the lower nibble is for the first MB and the upper nibble is
1385 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1386 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1387 Macroblock #2 in the first row.
1390 /* VC-1 Slice Parameter Buffer */
1391 typedef struct _VASliceParameterBufferVC1
1393 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1394 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1395 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1396 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1397 unsigned int slice_vertical_position;
1398 } VASliceParameterBufferVC1;
1400 /* VC-1 Slice Data Buffer */
1402 This is simplely a buffer containing raw bit-stream bytes
1405 /****************************
1406 * H.264/AVC data structures
1407 ****************************/
1409 typedef struct _VAPictureH264
1411 VASurfaceID picture_id;
1412 unsigned int frame_idx;
1414 signed int TopFieldOrderCnt;
1415 signed int BottomFieldOrderCnt;
1417 /* flags in VAPictureH264 could be OR of the following */
1418 #define VA_PICTURE_H264_INVALID 0x00000001
1419 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1420 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1421 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1422 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1424 /* H.264 Picture Parameter Buffer */
1426 * For each picture, and before any slice data, a single
1427 * picture parameter buffer must be send.
1429 typedef struct _VAPictureParameterBufferH264
1431 VAPictureH264 CurrPic;
1432 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1433 unsigned short picture_width_in_mbs_minus1;
1434 unsigned short picture_height_in_mbs_minus1;
1435 unsigned char bit_depth_luma_minus8;
1436 unsigned char bit_depth_chroma_minus8;
1437 unsigned char num_ref_frames;
1440 unsigned int chroma_format_idc : 2;
1441 unsigned int residual_colour_transform_flag : 1;
1442 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1443 unsigned int frame_mbs_only_flag : 1;
1444 unsigned int mb_adaptive_frame_field_flag : 1;
1445 unsigned int direct_8x8_inference_flag : 1;
1446 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1447 unsigned int log2_max_frame_num_minus4 : 4;
1448 unsigned int pic_order_cnt_type : 2;
1449 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1450 unsigned int delta_pic_order_always_zero_flag : 1;
1454 unsigned char num_slice_groups_minus1;
1455 unsigned char slice_group_map_type;
1456 unsigned short slice_group_change_rate_minus1;
1457 signed char pic_init_qp_minus26;
1458 signed char pic_init_qs_minus26;
1459 signed char chroma_qp_index_offset;
1460 signed char second_chroma_qp_index_offset;
1463 unsigned int entropy_coding_mode_flag : 1;
1464 unsigned int weighted_pred_flag : 1;
1465 unsigned int weighted_bipred_idc : 2;
1466 unsigned int transform_8x8_mode_flag : 1;
1467 unsigned int field_pic_flag : 1;
1468 unsigned int constrained_intra_pred_flag : 1;
1469 unsigned int pic_order_present_flag : 1;
1470 unsigned int deblocking_filter_control_present_flag : 1;
1471 unsigned int redundant_pic_cnt_present_flag : 1;
1472 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1476 unsigned short frame_num;
1477 } VAPictureParameterBufferH264;
1479 /* H.264 Inverse Quantization Matrix Buffer */
1480 typedef struct _VAIQMatrixBufferH264
1482 unsigned char ScalingList4x4[6][16];
1483 unsigned char ScalingList8x8[2][64];
1484 } VAIQMatrixBufferH264;
1487 * H.264 Slice Group Map Buffer
1488 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1489 * A slice group map buffer should be sent for each picture if required. The buffer
1490 * is sent only when there is a change in the mapping values.
1491 * The slice group map buffer map "map units" to slice groups as specified in
1492 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1493 * in raster scan order
1496 /* H.264 Slice Parameter Buffer */
1497 typedef struct _VASliceParameterBufferH264
1499 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1500 /** \brief Byte offset to the NAL Header Unit for this slice. */
1501 unsigned int slice_data_offset;
1502 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1504 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1506 * This bit offset is relative to and includes the NAL unit byte
1507 * and represents the number of bits parsed in the slice_header()
1508 * after the removal of any emulation prevention bytes in
1509 * there. However, the slice data buffer passed to the hardware is
1510 * the original bitstream, thus including any emulation prevention
1513 unsigned short slice_data_bit_offset;
1514 unsigned short first_mb_in_slice;
1515 unsigned char slice_type;
1516 unsigned char direct_spatial_mv_pred_flag;
1517 unsigned char num_ref_idx_l0_active_minus1;
1518 unsigned char num_ref_idx_l1_active_minus1;
1519 unsigned char cabac_init_idc;
1520 char slice_qp_delta;
1521 unsigned char disable_deblocking_filter_idc;
1522 char slice_alpha_c0_offset_div2;
1523 char slice_beta_offset_div2;
1524 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1525 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1526 unsigned char luma_log2_weight_denom;
1527 unsigned char chroma_log2_weight_denom;
1528 unsigned char luma_weight_l0_flag;
1529 short luma_weight_l0[32];
1530 short luma_offset_l0[32];
1531 unsigned char chroma_weight_l0_flag;
1532 short chroma_weight_l0[32][2];
1533 short chroma_offset_l0[32][2];
1534 unsigned char luma_weight_l1_flag;
1535 short luma_weight_l1[32];
1536 short luma_offset_l1[32];
1537 unsigned char chroma_weight_l1_flag;
1538 short chroma_weight_l1[32][2];
1539 short chroma_offset_l1[32][2];
1540 } VASliceParameterBufferH264;
1542 /****************************
1543 * Common encode data structures
1544 ****************************/
1547 VAEncPictureTypeIntra = 0,
1548 VAEncPictureTypePredictive = 1,
1549 VAEncPictureTypeBidirectional = 2,
1552 /* Encode Slice Parameter Buffer */
1553 typedef struct _VAEncSliceParameterBuffer
1555 unsigned int start_row_number; /* starting MB row number for this slice */
1556 unsigned int slice_height; /* slice height measured in MB */
1559 unsigned int is_intra : 1;
1560 unsigned int disable_deblocking_filter_idc : 2;
1561 unsigned int uses_long_term_ref :1;
1562 unsigned int is_long_term_ref :1;
1566 } VAEncSliceParameterBuffer;
1569 /****************************
1570 * H.263 specific encode data structures
1571 ****************************/
1573 typedef struct _VAEncSequenceParameterBufferH263
1575 unsigned int intra_period;
1576 unsigned int bits_per_second;
1577 unsigned int frame_rate;
1578 unsigned int initial_qp;
1579 unsigned int min_qp;
1580 } VAEncSequenceParameterBufferH263;
1582 typedef struct _VAEncPictureParameterBufferH263
1584 VASurfaceID reference_picture;
1585 VASurfaceID reconstructed_picture;
1586 VABufferID coded_buf;
1587 unsigned short picture_width;
1588 unsigned short picture_height;
1589 VAEncPictureType picture_type;
1590 } VAEncPictureParameterBufferH263;
1592 /****************************
1593 * MPEG-4 specific encode data structures
1594 ****************************/
1596 typedef struct _VAEncSequenceParameterBufferMPEG4
1598 unsigned char profile_and_level_indication;
1599 unsigned int intra_period;
1600 unsigned int video_object_layer_width;
1601 unsigned int video_object_layer_height;
1602 unsigned int vop_time_increment_resolution;
1603 unsigned int fixed_vop_rate;
1604 unsigned int fixed_vop_time_increment;
1605 unsigned int bits_per_second;
1606 unsigned int frame_rate;
1607 unsigned int initial_qp;
1608 unsigned int min_qp;
1609 } VAEncSequenceParameterBufferMPEG4;
1611 typedef struct _VAEncPictureParameterBufferMPEG4
1613 VASurfaceID reference_picture;
1614 VASurfaceID reconstructed_picture;
1615 VABufferID coded_buf;
1616 unsigned short picture_width;
1617 unsigned short picture_height;
1618 unsigned int modulo_time_base; /* number of 1s */
1619 unsigned int vop_time_increment;
1620 VAEncPictureType picture_type;
1621 } VAEncPictureParameterBufferMPEG4;
1625 /* Buffer functions */
1628 * Creates a buffer for "num_elements" elements of "size" bytes and
1629 * initalize with "data".
1630 * if "data" is null, then the contents of the buffer data store
1632 * Basically there are two ways to get buffer data to the server side. One is
1633 * to call vaCreateBuffer() with a non-null "data", which results the data being
1634 * copied to the data store on the server side. A different method that
1635 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1636 * and then use vaMapBuffer() to map the data store from the server side to the
1637 * client address space for access.
1638 * Note: image buffers are created by the library, not the client. Please see
1639 * vaCreateImage on how image buffers are managed.
1641 VAStatus vaCreateBuffer (
1643 VAContextID context,
1644 VABufferType type, /* in */
1645 unsigned int size, /* in */
1646 unsigned int num_elements, /* in */
1647 void *data, /* in */
1648 VABufferID *buf_id /* out */
1652 * Convey to the server how many valid elements are in the buffer.
1653 * e.g. if multiple slice parameters are being held in a single buffer,
1654 * this will communicate to the server the number of slice parameters
1655 * that are valid in the buffer.
1657 VAStatus vaBufferSetNumElements (
1659 VABufferID buf_id, /* in */
1660 unsigned int num_elements /* in */
1665 * device independent data structure for codedbuffer
1669 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1670 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1671 * enough for the encoder to attempt to limit its size.
1672 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1673 * exceeded the maximum slice size specified.
1674 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1675 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1676 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1678 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1679 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1680 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1681 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1682 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1684 * \brief The frame has exceeded the maximum requested size.
1686 * This flag indicates that the encoded frame size exceeds the value
1687 * specified through a misc parameter buffer of type
1688 * #VAEncMiscParameterTypeMaxFrameSize.
1690 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1691 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1694 * \brief The coded buffer segment contains a single NAL unit.
1696 * This flag indicates that the coded buffer segment contains a
1697 * single NAL unit. This flag might be useful to the user for
1698 * processing the coded buffer.
1700 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1703 * \brief Coded buffer segment.
1705 * #VACodedBufferSegment is an element of a linked list describing
1706 * some information on the coded buffer. The coded buffer segment
1707 * could contain either a single NAL unit, or more than one NAL unit.
1708 * It is recommended (but not required) to return a single NAL unit
1709 * in a coded buffer segment, and the implementation should set the
1710 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1712 typedef struct _VACodedBufferSegment {
1714 * \brief Size of the data buffer in this segment (in bytes).
1717 /** \brief Bit offset into the data buffer where the video data starts. */
1718 unsigned int bit_offset;
1719 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1720 unsigned int status;
1721 /** \brief Reserved for future use. */
1722 unsigned int reserved;
1723 /** \brief Pointer to the start of the data buffer. */
1726 * \brief Pointer to the next #VACodedBufferSegment element,
1727 * or \c NULL if there is none.
1730 } VACodedBufferSegment;
1733 * Map data store of the buffer into the client's address space
1734 * vaCreateBuffer() needs to be called with "data" set to NULL before
1735 * calling vaMapBuffer()
1737 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1738 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1740 VAStatus vaMapBuffer (
1742 VABufferID buf_id, /* in */
1743 void **pbuf /* out */
1747 * After client making changes to a mapped data store, it needs to
1748 * "Unmap" it to let the server know that the data is ready to be
1749 * consumed by the server
1751 VAStatus vaUnmapBuffer (
1753 VABufferID buf_id /* in */
1757 * After this call, the buffer is deleted and this buffer_id is no longer valid
1758 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1760 VAStatus vaDestroyBuffer (
1762 VABufferID buffer_id
1766 Render (Decode) Pictures
1768 A picture represents either a frame or a field.
1770 The Begin/Render/End sequence sends the decode buffers to the server
1774 * Get ready to decode a picture to a target surface
1776 VAStatus vaBeginPicture (
1778 VAContextID context,
1779 VASurfaceID render_target
1783 * Send decode buffers to the server.
1784 * Buffers are automatically destroyed afterwards
1786 VAStatus vaRenderPicture (
1788 VAContextID context,
1789 VABufferID *buffers,
1794 * Make the end of rendering for a picture.
1795 * The server should start processing all pending operations for this
1796 * surface. This call is non-blocking. The client can start another
1797 * Begin/Render/End sequence on a different render target.
1799 VAStatus vaEndPicture (
1811 * This function blocks until all pending operations on the render target
1812 * have been completed. Upon return it is safe to use the render target for a
1813 * different picture.
1815 VAStatus vaSyncSurface (
1817 VASurfaceID render_target
1822 VASurfaceRendering = 1, /* Rendering in progress */
1823 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1824 /* this status is useful if surface is used as the source */
1826 VASurfaceReady = 4, /* not being rendered or displayed */
1827 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1831 * Find out any pending ops on the render target
1833 VAStatus vaQuerySurfaceStatus (
1835 VASurfaceID render_target,
1836 VASurfaceStatus *status /* out */
1841 VADecodeSliceMissing = 0,
1842 VADecodeMBError = 1,
1843 } VADecodeErrorType;
1846 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1847 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1849 typedef struct _VASurfaceDecodeMBErrors
1851 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1852 unsigned int start_mb; /* start mb address with errors */
1853 unsigned int end_mb; /* end mb address with errors */
1854 VADecodeErrorType decode_error_type;
1855 } VASurfaceDecodeMBErrors;
1858 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1859 * it can call vaQuerySurfaceError to find out further details on the particular error.
1860 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1861 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1862 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1863 * The array is terminated if "status==-1" is detected.
1865 VAStatus vaQuerySurfaceError(
1867 VASurfaceID surface,
1868 VAStatus error_status,
1873 * Images and Subpictures
1874 * VAImage is used to either get the surface data to client memory, or
1875 * to copy image data in client memory to a surface.
1876 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1877 * is at the upper left corner with positive X to the right and positive Y down
1879 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1880 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1881 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1883 /* a few common FourCCs */
1884 #define VA_FOURCC_NV12 0x3231564E
1885 #define VA_FOURCC_AI44 0x34344149
1886 #define VA_FOURCC_RGBA 0x41424752
1887 #define VA_FOURCC_BGRA 0x41524742
1888 #define VA_FOURCC_UYVY 0x59565955
1889 #define VA_FOURCC_YUY2 0x32595559
1890 #define VA_FOURCC_AYUV 0x56555941
1891 #define VA_FOURCC_NV11 0x3131564e
1892 #define VA_FOURCC_YV12 0x32315659
1893 #define VA_FOURCC_P208 0x38303250
1894 #define VA_FOURCC_IYUV 0x56555949
1895 #define VA_FOURCC_YV24 0x34325659
1896 #define VA_FOURCC_YV32 0x32335659
1899 #define VA_LSB_FIRST 1
1900 #define VA_MSB_FIRST 2
1902 typedef struct _VAImageFormat
1904 unsigned int fourcc;
1905 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1906 unsigned int bits_per_pixel;
1907 /* for RGB formats */
1908 unsigned int depth; /* significant bits per pixel */
1909 unsigned int red_mask;
1910 unsigned int green_mask;
1911 unsigned int blue_mask;
1912 unsigned int alpha_mask;
1915 typedef VAGenericID VAImageID;
1917 typedef struct _VAImage
1919 VAImageID image_id; /* uniquely identify this image */
1920 VAImageFormat format;
1921 VABufferID buf; /* image data buffer */
1923 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1924 * data store on the server side for optimal performance. The buffer will be
1925 * created by the CreateImage function, and proper storage allocated based on the image
1926 * size and format. This buffer is managed by the library implementation, and
1927 * accessed by the client through the buffer Map/Unmap functions.
1929 unsigned short width;
1930 unsigned short height;
1931 unsigned int data_size;
1932 unsigned int num_planes; /* can not be greater than 3 */
1934 * An array indicating the scanline pitch in bytes for each plane.
1935 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1937 unsigned int pitches[3];
1939 * An array indicating the byte offset from the beginning of the image data
1940 * to the start of each plane.
1942 unsigned int offsets[3];
1944 /* The following fields are only needed for paletted formats */
1945 int num_palette_entries; /* set to zero for non-palette images */
1947 * Each component is one byte and entry_bytes indicates the number of components in
1948 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1952 * An array of ascii characters describing the order of the components within the bytes.
1953 * Only entry_bytes characters of the string are used.
1955 char component_order[4];
1958 /* Get maximum number of image formats supported by the implementation */
1959 int vaMaxNumImageFormats (
1964 * Query supported image formats
1965 * The caller must provide a "format_list" array that can hold at
1966 * least vaMaxNumImageFormats() entries. The actual number of formats
1967 * returned in "format_list" is returned in "num_formats".
1969 VAStatus vaQueryImageFormats (
1971 VAImageFormat *format_list, /* out */
1972 int *num_formats /* out */
1976 * Create a VAImage structure
1977 * The width and height fields returned in the VAImage structure may get
1978 * enlarged for some YUV formats. Upon return from this function,
1979 * image->buf has been created and proper storage allocated by the library.
1980 * The client can access the image through the Map/Unmap calls.
1982 VAStatus vaCreateImage (
1984 VAImageFormat *format,
1987 VAImage *image /* out */
1991 * Should call DestroyImage before destroying the surface it is bound to
1993 VAStatus vaDestroyImage (
1998 VAStatus vaSetImagePalette (
2002 * pointer to an array holding the palette data. The size of the array is
2003 * num_palette_entries * entry_bytes in size. The order of the components
2004 * in the palette is described by the component_order in VAImage struct
2006 unsigned char *palette
2010 * Retrive surface data into a VAImage
2011 * Image must be in a format supported by the implementation
2013 VAStatus vaGetImage (
2015 VASurfaceID surface,
2016 int x, /* coordinates of the upper left source pixel */
2018 unsigned int width, /* width and height of the region */
2019 unsigned int height,
2024 * Copy data from a VAImage to a surface
2025 * Image must be in a format supported by the implementation
2026 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2027 * shouldn't be rendered into when this is called
2029 VAStatus vaPutImage (
2031 VASurfaceID surface,
2035 unsigned int src_width,
2036 unsigned int src_height,
2039 unsigned int dest_width,
2040 unsigned int dest_height
2044 * Derive an VAImage from an existing surface.
2045 * This interface will derive a VAImage and corresponding image buffer from
2046 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2047 * direct CPU access. This operation is only possible on implementations with
2048 * direct rendering capabilities and internal surface formats that can be
2049 * represented with a VAImage. When the operation is not possible this interface
2050 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2051 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2054 * Implementations should only return success when the resulting image buffer
2055 * would be useable with vaMap/Unmap.
2057 * When directly accessing a surface special care must be taken to insure
2058 * proper synchronization with the graphics hardware. Clients should call
2059 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2060 * rendering or currently being displayed by an overlay.
2062 * Additionally nothing about the contents of a surface should be assumed
2063 * following a vaPutSurface. Implementations are free to modify the surface for
2064 * scaling or subpicture blending within a call to vaPutImage.
2066 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2067 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2068 * vaGetImage with other surfaces is supported.
2070 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2071 * image and image buffer structures will be destroyed; however, the underlying
2072 * surface will remain unchanged until freed with vaDestroySurfaces.
2074 VAStatus vaDeriveImage (
2076 VASurfaceID surface,
2077 VAImage *image /* out */
2082 * Subpicture is a special type of image that can be blended
2083 * with a surface during vaPutSurface(). Subpicture can be used to render
2084 * DVD sub-titles or closed captioning text etc.
2087 typedef VAGenericID VASubpictureID;
2089 /* Get maximum number of subpicture formats supported by the implementation */
2090 int vaMaxNumSubpictureFormats (
2094 /* flags for subpictures */
2095 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2096 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2097 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2099 * Query supported subpicture formats
2100 * The caller must provide a "format_list" array that can hold at
2101 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2102 * for each format to indicate additional capabilities for that format. The actual
2103 * number of formats returned in "format_list" is returned in "num_formats".
2104 * flags: returned value to indicate addtional capabilities
2105 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2106 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2107 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2110 VAStatus vaQuerySubpictureFormats (
2112 VAImageFormat *format_list, /* out */
2113 unsigned int *flags, /* out */
2114 unsigned int *num_formats /* out */
2118 * Subpictures are created with an image associated.
2120 VAStatus vaCreateSubpicture (
2123 VASubpictureID *subpicture /* out */
2127 * Destroy the subpicture before destroying the image it is assocated to
2129 VAStatus vaDestroySubpicture (
2131 VASubpictureID subpicture
2135 * Bind an image to the subpicture. This image will now be associated with
2136 * the subpicture instead of the one at creation.
2138 VAStatus vaSetSubpictureImage (
2140 VASubpictureID subpicture,
2145 * If chromakey is enabled, then the area where the source value falls within
2146 * the chromakey [min, max] range is transparent
2147 * The chromakey component format is the following:
2148 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2149 * For YUV: [0:7] V [8:15] U [16:23] Y
2150 * The chromakey mask can be used to mask out certain components for chromakey
2153 VAStatus vaSetSubpictureChromakey (
2155 VASubpictureID subpicture,
2156 unsigned int chromakey_min,
2157 unsigned int chromakey_max,
2158 unsigned int chromakey_mask
2162 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2163 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2164 * the overall alpha is per-pixel alpha multiplied by the global alpha
2166 VAStatus vaSetSubpictureGlobalAlpha (
2168 VASubpictureID subpicture,
2173 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2174 * It defines the region mapping between the subpicture and the target
2175 * surfaces through source and destination rectangles (with the same width and height).
2176 * Both will be displayed at the next call to vaPutSurface. Additional
2177 * associations before the call to vaPutSurface simply overrides the association.
2179 VAStatus vaAssociateSubpicture (
2181 VASubpictureID subpicture,
2182 VASurfaceID *target_surfaces,
2184 short src_x, /* upper left offset in subpicture */
2186 unsigned short src_width,
2187 unsigned short src_height,
2188 short dest_x, /* upper left offset in surface */
2190 unsigned short dest_width,
2191 unsigned short dest_height,
2193 * whether to enable chroma-keying, global-alpha, or screen relative mode
2194 * see VA_SUBPICTURE_XXX values
2200 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2202 VAStatus vaDeassociateSubpicture (
2204 VASubpictureID subpicture,
2205 VASurfaceID *target_surfaces,
2209 typedef struct _VARectangle
2213 unsigned short width;
2214 unsigned short height;
2218 * Display attributes
2219 * Display attributes are used to control things such as contrast, hue, saturation,
2220 * brightness etc. in the rendering process. The application can query what
2221 * attributes are supported by the driver, and then set the appropriate attributes
2222 * before calling vaPutSurface()
2225 /* attribute value for VADisplayAttribRotation */
2226 #define VA_ROTATION_NONE 0x00000000
2227 #define VA_ROTATION_90 0x00000001
2228 #define VA_ROTATION_180 0x00000002
2229 #define VA_ROTATION_270 0x00000003
2231 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2232 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2233 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2236 #define VA_RENDER_MODE_UNDEFINED 0
2237 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2238 #define VA_RENDER_MODE_LOCAL_GPU 2
2239 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2240 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2243 #define VA_RENDER_DEVICE_UNDEFINED 0
2244 #define VA_RENDER_DEVICE_LOCAL 1
2245 #define VA_RENDER_DEVICE_EXTERNAL 2
2247 /* Currently defined display attribute types */
2250 VADisplayAttribBrightness = 0,
2251 VADisplayAttribContrast = 1,
2252 VADisplayAttribHue = 2,
2253 VADisplayAttribSaturation = 3,
2254 /* client can specifiy a background color for the target window
2255 * the new feature of video conference,
2256 * the uncovered area of the surface is filled by this color
2257 * also it will blend with the decoded video color
2259 VADisplayAttribBackgroundColor = 4,
2260 VADisplayAttribRotation = 6,
2261 VADisplayAttribOutofLoopDeblock = 7,
2264 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2265 * conversion matrix. Each element in the matrix is float-point
2267 VADisplayAttribCSCMatrix = 12,
2268 /* specify the constant color used to blend with video surface
2269 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2270 * d: the final color to overwrite into the frame buffer
2271 * v: decoded video after color conversion,
2272 * c: video color specified by VADisplayAttribBlendColor
2273 * b: background color of the drawable
2275 VADisplayAttribBlendColor = 13,
2277 * Indicate driver to skip painting color key or not.
2278 * only applicable if the render is overlay
2280 VADisplayAttribOverlayAutoPaintColorKey = 14,
2282 * customized overlay color key, the format is RGB888
2283 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2285 VADisplayAttribOverlayColorKey = 15,
2287 * The hint for the implementation of vaPutSurface
2288 * normally, the driver could use an overlay or GPU to render the surface on the screen
2289 * this flag provides APP the flexibity to switch the render dynamically
2291 VADisplayAttribRenderMode = 16,
2293 * specify if vaPutSurface needs to render into specified monitors
2294 * one example is that one external monitor (e.g. HDMI) is enabled,
2295 * but the window manager is not aware of it, and there is no associated drawable
2297 VADisplayAttribRenderDevice = 17,
2299 * specify vaPutSurface render area if there is no drawable on the monitor
2301 VADisplayAttribRenderRect = 18,
2302 } VADisplayAttribType;
2304 /* flags for VADisplayAttribute */
2305 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2306 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2307 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2309 typedef struct _VADisplayAttribute
2311 VADisplayAttribType type;
2314 int value; /* used by the set/get attribute functions */
2315 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2317 } VADisplayAttribute;
2319 /* Get maximum number of display attributs supported by the implementation */
2320 int vaMaxNumDisplayAttributes (
2325 * Query display attributes
2326 * The caller must provide a "attr_list" array that can hold at
2327 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2328 * returned in "attr_list" is returned in "num_attributes".
2330 VAStatus vaQueryDisplayAttributes (
2332 VADisplayAttribute *attr_list, /* out */
2333 int *num_attributes /* out */
2337 * Get display attributes
2338 * This function returns the current attribute values in "attr_list".
2339 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2340 * from vaQueryDisplayAttributes() can have their values retrieved.
2342 VAStatus vaGetDisplayAttributes (
2344 VADisplayAttribute *attr_list, /* in/out */
2349 * Set display attributes
2350 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2351 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2352 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2354 VAStatus vaSetDisplayAttributes (
2356 VADisplayAttribute *attr_list,