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_PROTECTED 0x80000000
408 /** @name Attribute values for VAConfigAttribRateControl */
410 /** \brief Driver does not support any form of rate control. */
411 #define VA_RC_NONE 0x00000001
412 /** \brief Constant bitrate. */
413 #define VA_RC_CBR 0x00000002
414 /** \brief Variable bitrate. */
415 #define VA_RC_VBR 0x00000004
416 /** \brief Video conference mode. */
417 #define VA_RC_VCM 0x00000008
418 /** \brief Constant QP. */
419 #define VA_RC_CQP 0x00000010
420 /** \brief Variable bitrate with peak rate higher than average bitrate. */
421 #define VA_RC_VBR_CONSTRAINED 0x00000020
424 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
426 /** \brief Driver does not support any packed headers mode. */
427 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
428 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
429 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
430 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
431 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
432 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
433 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
434 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
435 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
436 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
437 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x0000000C
440 /** @name Attribute values for VAConfigAttribEncInterlaced */
442 /** \brief Driver does not support interlaced coding. */
443 #define VA_ENC_INTERLACED_NONE 0x00000000
444 /** \brief Driver supports interlaced frame coding. */
445 #define VA_ENC_INTERLACED_FRAME 0x00000001
446 /** \brief Driver supports interlaced field coding. */
447 #define VA_ENC_INTERLACED_FIELD 0x00000002
448 /** \brief Driver supports macroblock adaptive frame field coding. */
449 #define VA_ENC_INTERLACED_MBAFF 0x00000004
450 /** \brief Driver supports picture adaptive frame field coding. */
451 #define VA_ENC_INTERLACED_PAFF 0x00000008
454 /** @name Attribute values for VAConfigAttribEncSliceStructure */
456 /** \brief Driver supports an arbitrary number of rows per slice. */
457 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
458 /** \brief Driver supports a power-of-two number of rows per slice. */
459 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
460 /** \brief Driver supports an arbitrary number of rows per slice. */
461 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
465 * if an attribute is not applicable for a given
466 * profile/entrypoint pair, then set the value to the following
468 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
470 /* Get maximum number of profiles supported by the implementation */
471 int vaMaxNumProfiles (
475 /* Get maximum number of entrypoints supported by the implementation */
476 int vaMaxNumEntrypoints (
480 /* Get maximum number of attributs supported by the implementation */
481 int vaMaxNumConfigAttributes (
486 * Query supported profiles
487 * The caller must provide a "profile_list" array that can hold at
488 * least vaMaxNumProfile() entries. The actual number of profiles
489 * returned in "profile_list" is returned in "num_profile".
491 VAStatus vaQueryConfigProfiles (
493 VAProfile *profile_list, /* out */
494 int *num_profiles /* out */
498 * Query supported entrypoints for a given profile
499 * The caller must provide an "entrypoint_list" array that can hold at
500 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
501 * returned in "entrypoint_list" is returned in "num_entrypoints".
503 VAStatus vaQueryConfigEntrypoints (
506 VAEntrypoint *entrypoint_list, /* out */
507 int *num_entrypoints /* out */
511 * Get attributes for a given profile/entrypoint pair
512 * The caller must provide an "attrib_list" with all attributes to be
513 * retrieved. Upon return, the attributes in "attrib_list" have been
514 * updated with their value. Unknown attributes or attributes that are
515 * not supported for the given profile/entrypoint pair will have their
516 * value set to VA_ATTRIB_NOT_SUPPORTED
518 VAStatus vaGetConfigAttributes (
521 VAEntrypoint entrypoint,
522 VAConfigAttrib *attrib_list, /* in/out */
526 /* Generic ID type, can be re-typed for specific implementation */
527 typedef unsigned int VAGenericID;
529 typedef VAGenericID VAConfigID;
532 * Create a configuration for the decode pipeline
533 * it passes in the attribute list that specifies the attributes it cares
534 * about, with the rest taking default values.
536 VAStatus vaCreateConfig (
539 VAEntrypoint entrypoint,
540 VAConfigAttrib *attrib_list,
542 VAConfigID *config_id /* out */
546 * Free resources associdated with a given config
548 VAStatus vaDestroyConfig (
554 * Query all attributes for a given configuration
555 * The profile of the configuration is returned in "profile"
556 * The entrypoint of the configuration is returned in "entrypoint"
557 * The caller must provide an "attrib_list" array that can hold at least
558 * vaMaxNumConfigAttributes() entries. The actual number of attributes
559 * returned in "attrib_list" is returned in "num_attribs"
561 VAStatus vaQueryConfigAttributes (
563 VAConfigID config_id,
564 VAProfile *profile, /* out */
565 VAEntrypoint *entrypoint, /* out */
566 VAConfigAttrib *attrib_list,/* out */
567 int *num_attribs /* out */
572 * Contexts and Surfaces
574 * Context represents a "virtual" video decode pipeline. Surfaces are render
575 * targets for a given context. The data in the surfaces are not accessible
576 * to the client and the internal data format of the surface is implementatin
579 * Surfaces will be bound to a context when the context is created. Once
580 * a surface is bound to a given context, it can not be used to create
581 * another context. The association is removed when the context is destroyed
583 * Both contexts and surfaces are identified by unique IDs and its
584 * implementation specific internals are kept opaque to the clients
587 typedef VAGenericID VAContextID;
589 typedef VAGenericID VASurfaceID;
591 #define VA_INVALID_ID 0xffffffff
592 #define VA_INVALID_SURFACE VA_INVALID_ID
594 /** \brief Generic value types. */
596 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
597 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
598 VAGenericValueTypePointer, /**< Generic pointer type */
599 VAGenericValueTypeFunc /**< Pointer to function */
600 } VAGenericValueType;
602 /** \brief Generic function type. */
603 typedef void (*VAGenericFunc)(void);
605 /** \brief Generic value. */
606 typedef struct _VAGenericValue {
607 /** \brief Value type. See #VAGenericValueType. */
608 VAGenericValueType type;
609 /** \brief Value holder. */
611 /** \brief 32-bit signed integer. */
613 /** \brief 32-bit float. */
615 /** \brief Generic pointer. */
617 /** \brief Pointer to function. */
623 * vaCreateSurfaces - Create an array of surfaces used for decode and display
625 * width: surface width
626 * height: surface height
627 * format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
628 * num_surfaces: number of surfaces to be created
629 * surfaces: array of surfaces created upon return
631 VAStatus vaCreateSurfaces (
637 VASurfaceID *surfaces /* out */
642 * vaDestroySurfaces - Destroy resources associated with surfaces.
643 * Surfaces can only be destroyed after the context associated has been
646 * surfaces: array of surfaces to destroy
647 * num_surfaces: number of surfaces in the array to be destroyed.
649 VAStatus vaDestroySurfaces (
651 VASurfaceID *surfaces,
655 #define VA_PROGRESSIVE 0x1
657 * vaCreateContext - Create a context
659 * config_id: configuration for the context
660 * picture_width: coded picture width
661 * picture_height: coded picture height
662 * flag: any combination of the following:
663 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
664 * render_targets: render targets (surfaces) tied to the context
665 * num_render_targets: number of render targets in the above array
666 * context: created context id upon return
668 VAStatus vaCreateContext (
670 VAConfigID config_id,
674 VASurfaceID *render_targets,
675 int num_render_targets,
676 VAContextID *context /* out */
680 * vaDestroyContext - Destroy a context
682 * context: context to be destroyed
684 VAStatus vaDestroyContext (
691 * Buffers are used to pass various types of data from the
692 * client to the server. The server maintains a data store
693 * for each buffer created, and the client idenfies a buffer
694 * through a unique buffer id assigned by the server.
697 typedef VAGenericID VABufferID;
701 VAPictureParameterBufferType = 0,
702 VAIQMatrixBufferType = 1,
703 VABitPlaneBufferType = 2,
704 VASliceGroupMapBufferType = 3,
705 VASliceParameterBufferType = 4,
706 VASliceDataBufferType = 5,
707 VAMacroblockParameterBufferType = 6,
708 VAResidualDataBufferType = 7,
709 VADeblockingParameterBufferType = 8,
710 VAImageBufferType = 9,
711 VAProtectedSliceDataBufferType = 10,
712 VAQMatrixBufferType = 11,
713 VAHuffmanTableBufferType = 12,
715 /* Following are encode buffer types */
716 VAEncCodedBufferType = 21,
717 VAEncSequenceParameterBufferType = 22,
718 VAEncPictureParameterBufferType = 23,
719 VAEncSliceParameterBufferType = 24,
720 VAEncPackedHeaderParameterBufferType = 25,
721 VAEncPackedHeaderDataBufferType = 26,
722 VAEncMiscParameterBufferType = 27,
723 VAEncMacroblockParameterBufferType = 28,
724 /* Following are video processing buffer types */
726 * \brief Video processing pipeline parameter buffer.
728 * This buffer describes the video processing pipeline. See
729 * #VAProcPipelineParameterBuffer for details.
731 VAProcPipelineParameterBufferType = 41,
733 * \brief Video filter parameter buffer.
735 * This buffer describes the video filter parameters. All buffers
736 * inherit from #VAProcFilterParameterBufferBase, thus including
737 * a unique filter buffer type.
739 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
740 * Filters requiring advanced parameters include, but are not limited to,
741 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
742 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
744 VAProcFilterParameterBufferType = 42,
750 VAEncMiscParameterTypeFrameRate = 0,
751 VAEncMiscParameterTypeRateControl = 1,
752 VAEncMiscParameterTypeMaxSliceSize = 2,
753 VAEncMiscParameterTypeAIR = 3,
754 /** \brief Buffer type used to express a maximum frame size (in bits). */
755 VAEncMiscParameterTypeMaxFrameSize = 4,
756 /** \brief Buffer type used for HRD parameters. */
757 VAEncMiscParameterTypeHRD = 5,
758 } VAEncMiscParameterType;
760 /** \brief Packed header type. */
762 /** \brief Packed sequence header. */
763 VAEncPackedHeaderSequence = 1,
764 /** \brief Packed picture header. */
765 VAEncPackedHeaderPicture = 2,
766 /** \brief Packed slice header. */
767 VAEncPackedHeaderSlice = 3,
769 * \brief Packed raw header.
771 * Packed raw data header can be used by the client to insert a header
772 * into the bitstream data buffer at the point it is passed, the driver
773 * will handle the raw packed header based on "has_emulation_bytes" field
774 * in the packed header parameter structure.
776 VAEncPackedHeaderRawData = 4,
777 /** \brief Misc packed header. See codec-specific definitions. */
778 VAEncPackedHeaderMiscMask = 0x80000000,
779 } VAEncPackedHeaderType;
781 /** \brief Packed header parameter. */
782 typedef struct _VAEncPackedHeaderParameterBuffer {
783 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
785 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
786 unsigned int bit_length;
787 /** \brief Flag: buffer contains start code emulation prevention bytes? */
788 unsigned char has_emulation_bytes;
789 } VAEncPackedHeaderParameterBuffer;
792 * For application, e.g. set a new bitrate
794 * VAEncMiscParameterBuffer *misc_param;
795 * VAEncMiscParameterRateControl *misc_rate_ctrl;
797 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
798 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
801 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
802 * misc_param->type = VAEncMiscParameterTypeRateControl;
803 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
804 * misc_rate_ctrl->bits_per_second = 6400000;
805 * vaUnmapBuffer(dpy, buf_id);
806 * vaRenderPicture(dpy, context, &buf_id, 1);
808 typedef struct _VAEncMiscParameterBuffer
810 VAEncMiscParameterType type;
811 unsigned int data[0];
812 } VAEncMiscParameterBuffer;
815 /** \brief Rate control parameters */
816 typedef struct _VAEncMiscParameterRateControl
818 /* this is the maximum bit-rate to be constrained by the rate control implementation */
819 unsigned int bits_per_second;
820 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
821 * bit-rate for example if target_percentage is 95 then the rate control will target
822 * a bit-rate that is 95% of the maximum bit-rate
824 unsigned int target_percentage;
825 /* windows size in milliseconds. For example if this is set to 500,
826 * then the rate control will guarantee the target bit-rate over a 500 ms window
828 unsigned int window_size;
829 /* initial QP at I frames */
830 unsigned int initial_qp;
832 unsigned int basic_unit_size;
837 unsigned int reset : 1;
838 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
839 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
843 } VAEncMiscParameterRateControl;
845 typedef struct _VAEncMiscParameterFrameRate
847 unsigned int framerate;
848 } VAEncMiscParameterFrameRate;
851 * Allow a maximum slice size to be specified (in bits).
852 * The encoder will attempt to make sure that individual slices do not exceed this size
853 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
855 typedef struct _VAEncMiscParameterMaxSliceSize
857 unsigned int max_slice_size;
858 } VAEncMiscParameterMaxSliceSize;
860 typedef struct _VAEncMiscParameterAIR
862 unsigned int air_num_mbs;
863 unsigned int air_threshold;
864 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
865 } VAEncMiscParameterAIR;
867 typedef struct _VAEncMiscParameterHRD
869 unsigned int initial_buffer_fullness; /* in bits */
870 unsigned int buffer_size; /* in bits */
871 } VAEncMiscParameterHRD;
874 * \brief Defines a maximum frame size (in bits).
876 * This misc parameter buffer defines the maximum size of a frame (in
877 * bits). The encoder will try to make sure that each frame does not
878 * exceed this size. Otherwise, if the frame size exceeds this size,
879 * the \c status flag of #VACodedBufferSegment will contain
880 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
882 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
883 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
884 VAEncMiscParameterType type;
885 /** \brief Maximum size of a frame (in bits). */
886 unsigned int max_frame_size;
887 } VAEncMiscParameterBufferMaxFrameSize;
890 * There will be cases where the bitstream buffer will not have enough room to hold
891 * the data for the entire slice, and the following flags will be used in the slice
892 * parameter to signal to the server for the possible cases.
893 * If a slice parameter buffer and slice data buffer pair is sent to the server with
894 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
895 * then a slice parameter and data buffer needs to be sent again to complete this slice.
897 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
898 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
899 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
900 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
902 /* Codec-independent Slice Parameter Buffer base */
903 typedef struct _VASliceParameterBufferBase
905 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
906 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
907 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
908 } VASliceParameterBufferBase;
911 /****************************
912 * JEPG data structure
913 ***************************/
914 typedef struct _VAQMatrixBufferJPEG
916 int load_lum_quantiser_matrix;
917 int load_chroma_quantiser_matrix;
918 unsigned char lum_quantiser_matrix[64];
919 unsigned char chroma_quantiser_matrix[64];
920 } VAQMatrixBufferJPEG;
922 typedef struct _VAEncPictureParameterBufferJPEG
924 VASurfaceID reconstructed_picture;
925 unsigned short picture_width;
926 unsigned short picture_height;
927 VABufferID coded_buf;
928 } VAEncPictureParameterBufferJPEG;
930 #include <va/va_dec_jpeg.h>
932 /****************************
933 * MPEG-2 data structures
934 ****************************/
936 /* MPEG-2 Picture Parameter Buffer */
938 * For each frame or field, and before any slice data, a single
939 * picture parameter buffer must be send.
941 typedef struct _VAPictureParameterBufferMPEG2
943 unsigned short horizontal_size;
944 unsigned short vertical_size;
945 VASurfaceID forward_reference_picture;
946 VASurfaceID backward_reference_picture;
947 /* meanings of the following fields are the same as in the standard */
948 int picture_coding_type;
949 int f_code; /* pack all four fcode into this */
952 unsigned int intra_dc_precision : 2;
953 unsigned int picture_structure : 2;
954 unsigned int top_field_first : 1;
955 unsigned int frame_pred_frame_dct : 1;
956 unsigned int concealment_motion_vectors : 1;
957 unsigned int q_scale_type : 1;
958 unsigned int intra_vlc_format : 1;
959 unsigned int alternate_scan : 1;
960 unsigned int repeat_first_field : 1;
961 unsigned int progressive_frame : 1;
962 unsigned int is_first_field : 1; /* indicate whether the current field
963 * is the first field for field picture
967 } picture_coding_extension;
968 } VAPictureParameterBufferMPEG2;
970 /* MPEG-2 Inverse Quantization Matrix Buffer */
971 typedef struct _VAIQMatrixBufferMPEG2
973 int load_intra_quantiser_matrix;
974 int load_non_intra_quantiser_matrix;
975 int load_chroma_intra_quantiser_matrix;
976 int load_chroma_non_intra_quantiser_matrix;
977 unsigned char intra_quantiser_matrix[64];
978 unsigned char non_intra_quantiser_matrix[64];
979 unsigned char chroma_intra_quantiser_matrix[64];
980 unsigned char chroma_non_intra_quantiser_matrix[64];
981 } VAIQMatrixBufferMPEG2;
983 /* MPEG-2 Slice Parameter Buffer */
984 typedef struct _VASliceParameterBufferMPEG2
986 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
987 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
988 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
989 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
990 unsigned int slice_horizontal_position;
991 unsigned int slice_vertical_position;
992 int quantiser_scale_code;
993 int intra_slice_flag;
994 } VASliceParameterBufferMPEG2;
996 /* MPEG-2 Macroblock Parameter Buffer */
997 typedef struct _VAMacroblockParameterBufferMPEG2
999 unsigned short macroblock_address;
1001 * macroblock_address (in raster scan order)
1003 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1005 unsigned char macroblock_type; /* see definition below */
1008 unsigned int frame_motion_type : 2;
1009 unsigned int field_motion_type : 2;
1010 unsigned int dct_type : 1;
1014 unsigned char motion_vertical_field_select;
1016 * motion_vertical_field_select:
1017 * see section 6.3.17.2 in the spec
1018 * only the lower 4 bits are used
1019 * bit 0: first vector forward
1020 * bit 1: first vector backward
1021 * bit 2: second vector forward
1022 * bit 3: second vector backward
1024 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1025 unsigned short coded_block_pattern;
1027 * The bitplanes for coded_block_pattern are described
1028 * in Figure 6.10-12 in the spec
1031 /* Number of skipped macroblocks after this macroblock */
1032 unsigned short num_skipped_macroblocks;
1033 } VAMacroblockParameterBufferMPEG2;
1036 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1038 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1039 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1040 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1041 #define VA_MB_TYPE_MOTION_INTRA 0x10
1044 * MPEG-2 Residual Data Buffer
1045 * For each macroblock, there wil be 64 shorts (16-bit) in the
1046 * residual data buffer
1049 /****************************
1050 * MPEG-4 Part 2 data structures
1051 ****************************/
1053 /* MPEG-4 Picture Parameter Buffer */
1055 * For each frame or field, and before any slice data, a single
1056 * picture parameter buffer must be send.
1058 typedef struct _VAPictureParameterBufferMPEG4
1060 unsigned short vop_width;
1061 unsigned short vop_height;
1062 VASurfaceID forward_reference_picture;
1063 VASurfaceID backward_reference_picture;
1066 unsigned int short_video_header : 1;
1067 unsigned int chroma_format : 2;
1068 unsigned int interlaced : 1;
1069 unsigned int obmc_disable : 1;
1070 unsigned int sprite_enable : 2;
1071 unsigned int sprite_warping_accuracy : 2;
1072 unsigned int quant_type : 1;
1073 unsigned int quarter_sample : 1;
1074 unsigned int data_partitioned : 1;
1075 unsigned int reversible_vlc : 1;
1076 unsigned int resync_marker_disable : 1;
1080 unsigned char no_of_sprite_warping_points;
1081 short sprite_trajectory_du[3];
1082 short sprite_trajectory_dv[3];
1083 unsigned char quant_precision;
1086 unsigned int vop_coding_type : 2;
1087 unsigned int backward_reference_vop_coding_type : 2;
1088 unsigned int vop_rounding_type : 1;
1089 unsigned int intra_dc_vlc_thr : 3;
1090 unsigned int top_field_first : 1;
1091 unsigned int alternate_vertical_scan_flag : 1;
1095 unsigned char vop_fcode_forward;
1096 unsigned char vop_fcode_backward;
1097 unsigned short vop_time_increment_resolution;
1098 /* short header related */
1099 unsigned char num_gobs_in_vop;
1100 unsigned char num_macroblocks_in_gob;
1101 /* for direct mode prediction */
1104 } VAPictureParameterBufferMPEG4;
1106 /* MPEG-4 Inverse Quantization Matrix Buffer */
1107 typedef struct _VAIQMatrixBufferMPEG4
1109 int load_intra_quant_mat;
1110 int load_non_intra_quant_mat;
1111 unsigned char intra_quant_mat[64];
1112 unsigned char non_intra_quant_mat[64];
1113 } VAIQMatrixBufferMPEG4;
1115 /* MPEG-4 Slice Parameter Buffer */
1116 typedef struct _VASliceParameterBufferMPEG4
1118 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1119 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1120 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1121 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1122 unsigned int macroblock_number;
1124 } VASliceParameterBufferMPEG4;
1127 VC-1 data structures
1130 typedef enum /* see 7.1.1.32 */
1133 VAMvMode1MvHalfPel = 1,
1134 VAMvMode1MvHalfPelBilinear = 2,
1135 VAMvModeMixedMv = 3,
1136 VAMvModeIntensityCompensation = 4
1139 /* VC-1 Picture Parameter Buffer */
1141 * For each picture, and before any slice data, a picture parameter
1142 * buffer must be send. Multiple picture parameter buffers may be
1143 * sent for a single picture. In that case picture parameters will
1144 * apply to all slice data that follow it until a new picture
1145 * parameter buffer is sent.
1148 * pic_quantizer_type should be set to the applicable quantizer
1149 * type as defined by QUANTIZER (J.1.19) and either
1150 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1152 typedef struct _VAPictureParameterBufferVC1
1154 VASurfaceID forward_reference_picture;
1155 VASurfaceID backward_reference_picture;
1156 /* if out-of-loop post-processing is done on the render
1157 target, then we need to keep the in-loop decoded
1158 picture as a reference picture */
1159 VASurfaceID inloop_decoded_picture;
1161 /* sequence layer for AP or meta data for SP and MP */
1164 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1165 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1166 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1167 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1168 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1169 unsigned int multires : 1; /* METADATA::MULTIRES */
1170 unsigned int overlap : 1; /* METADATA::OVERLAP */
1171 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1172 unsigned int rangered : 1; /* METADATA::RANGERED */
1173 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1174 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1179 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1180 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1183 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1184 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1185 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1186 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1189 } entrypoint_fields;
1190 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1191 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1194 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1195 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1196 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1197 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1200 } range_mapping_fields;
1202 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1203 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1204 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1205 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1206 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1207 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1208 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1209 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1210 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1213 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1214 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1215 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1216 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1217 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1223 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1224 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1225 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1226 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1227 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1228 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1229 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1235 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1236 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1237 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1238 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1239 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1240 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1241 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1244 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1247 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1248 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1249 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1250 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1256 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1257 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1258 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1259 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1260 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1261 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1262 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1263 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1264 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1265 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1271 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1272 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1273 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1274 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1275 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1276 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1277 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1278 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1279 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1280 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1281 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1284 } pic_quantizer_fields;
1287 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1288 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1289 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1290 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1291 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1292 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1296 } VAPictureParameterBufferVC1;
1298 /* VC-1 Bitplane Buffer
1299 There will be at most three bitplanes coded in any picture header. To send
1300 the bitplane data more efficiently, each byte is divided in two nibbles, with
1301 each nibble carrying three bitplanes for one macroblock. The following table
1302 shows the bitplane data arrangement within each nibble based on the picture
1305 Picture Type Bit3 Bit2 Bit1 Bit0
1306 I or BI OVERFLAGS ACPRED FIELDTX
1307 P MYTYPEMB SKIPMB DIRECTMB
1308 B FORWARDMB SKIPMB DIRECTMB
1310 Within each byte, the lower nibble is for the first MB and the upper nibble is
1311 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1312 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1313 Macroblock #2 in the first row.
1316 /* VC-1 Slice Parameter Buffer */
1317 typedef struct _VASliceParameterBufferVC1
1319 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1320 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1321 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1322 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1323 unsigned int slice_vertical_position;
1324 } VASliceParameterBufferVC1;
1326 /* VC-1 Slice Data Buffer */
1328 This is simplely a buffer containing raw bit-stream bytes
1331 /****************************
1332 * H.264/AVC data structures
1333 ****************************/
1335 typedef struct _VAPictureH264
1337 VASurfaceID picture_id;
1338 unsigned int frame_idx;
1340 signed int TopFieldOrderCnt;
1341 signed int BottomFieldOrderCnt;
1343 /* flags in VAPictureH264 could be OR of the following */
1344 #define VA_PICTURE_H264_INVALID 0x00000001
1345 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1346 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1347 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1348 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1350 /* H.264 Picture Parameter Buffer */
1352 * For each picture, and before any slice data, a single
1353 * picture parameter buffer must be send.
1355 typedef struct _VAPictureParameterBufferH264
1357 VAPictureH264 CurrPic;
1358 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1359 unsigned short picture_width_in_mbs_minus1;
1360 unsigned short picture_height_in_mbs_minus1;
1361 unsigned char bit_depth_luma_minus8;
1362 unsigned char bit_depth_chroma_minus8;
1363 unsigned char num_ref_frames;
1366 unsigned int chroma_format_idc : 2;
1367 unsigned int residual_colour_transform_flag : 1;
1368 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1369 unsigned int frame_mbs_only_flag : 1;
1370 unsigned int mb_adaptive_frame_field_flag : 1;
1371 unsigned int direct_8x8_inference_flag : 1;
1372 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1373 unsigned int log2_max_frame_num_minus4 : 4;
1374 unsigned int pic_order_cnt_type : 2;
1375 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1376 unsigned int delta_pic_order_always_zero_flag : 1;
1380 unsigned char num_slice_groups_minus1;
1381 unsigned char slice_group_map_type;
1382 unsigned short slice_group_change_rate_minus1;
1383 signed char pic_init_qp_minus26;
1384 signed char pic_init_qs_minus26;
1385 signed char chroma_qp_index_offset;
1386 signed char second_chroma_qp_index_offset;
1389 unsigned int entropy_coding_mode_flag : 1;
1390 unsigned int weighted_pred_flag : 1;
1391 unsigned int weighted_bipred_idc : 2;
1392 unsigned int transform_8x8_mode_flag : 1;
1393 unsigned int field_pic_flag : 1;
1394 unsigned int constrained_intra_pred_flag : 1;
1395 unsigned int pic_order_present_flag : 1;
1396 unsigned int deblocking_filter_control_present_flag : 1;
1397 unsigned int redundant_pic_cnt_present_flag : 1;
1398 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1402 unsigned short frame_num;
1403 } VAPictureParameterBufferH264;
1405 /* H.264 Inverse Quantization Matrix Buffer */
1406 typedef struct _VAIQMatrixBufferH264
1408 unsigned char ScalingList4x4[6][16];
1409 unsigned char ScalingList8x8[2][64];
1410 } VAIQMatrixBufferH264;
1413 * H.264 Slice Group Map Buffer
1414 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1415 * A slice group map buffer should be sent for each picture if required. The buffer
1416 * is sent only when there is a change in the mapping values.
1417 * The slice group map buffer map "map units" to slice groups as specified in
1418 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1419 * in raster scan order
1422 /* H.264 Slice Parameter Buffer */
1423 typedef struct _VASliceParameterBufferH264
1425 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1426 /** \brief Byte offset to the NAL Header Unit for this slice. */
1427 unsigned int slice_data_offset;
1428 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1430 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1432 * This bit offset is relative to and includes the NAL unit byte
1433 * and represents the number of bits parsed in the slice_header()
1434 * after the removal of any emulation prevention bytes in
1435 * there. However, the slice data buffer passed to the hardware is
1436 * the original bitstream, thus including any emulation prevention
1439 unsigned short slice_data_bit_offset;
1440 unsigned short first_mb_in_slice;
1441 unsigned char slice_type;
1442 unsigned char direct_spatial_mv_pred_flag;
1443 unsigned char num_ref_idx_l0_active_minus1;
1444 unsigned char num_ref_idx_l1_active_minus1;
1445 unsigned char cabac_init_idc;
1446 char slice_qp_delta;
1447 unsigned char disable_deblocking_filter_idc;
1448 char slice_alpha_c0_offset_div2;
1449 char slice_beta_offset_div2;
1450 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1451 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1452 unsigned char luma_log2_weight_denom;
1453 unsigned char chroma_log2_weight_denom;
1454 unsigned char luma_weight_l0_flag;
1455 short luma_weight_l0[32];
1456 short luma_offset_l0[32];
1457 unsigned char chroma_weight_l0_flag;
1458 short chroma_weight_l0[32][2];
1459 short chroma_offset_l0[32][2];
1460 unsigned char luma_weight_l1_flag;
1461 short luma_weight_l1[32];
1462 short luma_offset_l1[32];
1463 unsigned char chroma_weight_l1_flag;
1464 short chroma_weight_l1[32][2];
1465 short chroma_offset_l1[32][2];
1466 } VASliceParameterBufferH264;
1468 /****************************
1469 * Common encode data structures
1470 ****************************/
1473 VAEncPictureTypeIntra = 0,
1474 VAEncPictureTypePredictive = 1,
1475 VAEncPictureTypeBidirectional = 2,
1478 /* Encode Slice Parameter Buffer */
1479 typedef struct _VAEncSliceParameterBuffer
1481 unsigned int start_row_number; /* starting MB row number for this slice */
1482 unsigned int slice_height; /* slice height measured in MB */
1485 unsigned int is_intra : 1;
1486 unsigned int disable_deblocking_filter_idc : 2;
1487 unsigned int uses_long_term_ref :1;
1488 unsigned int is_long_term_ref :1;
1492 } VAEncSliceParameterBuffer;
1495 /****************************
1496 * H.263 specific encode data structures
1497 ****************************/
1499 typedef struct _VAEncSequenceParameterBufferH263
1501 unsigned int intra_period;
1502 unsigned int bits_per_second;
1503 unsigned int frame_rate;
1504 unsigned int initial_qp;
1505 unsigned int min_qp;
1506 } VAEncSequenceParameterBufferH263;
1508 typedef struct _VAEncPictureParameterBufferH263
1510 VASurfaceID reference_picture;
1511 VASurfaceID reconstructed_picture;
1512 VABufferID coded_buf;
1513 unsigned short picture_width;
1514 unsigned short picture_height;
1515 VAEncPictureType picture_type;
1516 } VAEncPictureParameterBufferH263;
1518 /****************************
1519 * MPEG-4 specific encode data structures
1520 ****************************/
1522 typedef struct _VAEncSequenceParameterBufferMPEG4
1524 unsigned char profile_and_level_indication;
1525 unsigned int intra_period;
1526 unsigned int video_object_layer_width;
1527 unsigned int video_object_layer_height;
1528 unsigned int vop_time_increment_resolution;
1529 unsigned int fixed_vop_rate;
1530 unsigned int fixed_vop_time_increment;
1531 unsigned int bits_per_second;
1532 unsigned int frame_rate;
1533 unsigned int initial_qp;
1534 unsigned int min_qp;
1535 } VAEncSequenceParameterBufferMPEG4;
1537 typedef struct _VAEncPictureParameterBufferMPEG4
1539 VASurfaceID reference_picture;
1540 VASurfaceID reconstructed_picture;
1541 VABufferID coded_buf;
1542 unsigned short picture_width;
1543 unsigned short picture_height;
1544 unsigned int modulo_time_base; /* number of 1s */
1545 unsigned int vop_time_increment;
1546 VAEncPictureType picture_type;
1547 } VAEncPictureParameterBufferMPEG4;
1551 /* Buffer functions */
1554 * Creates a buffer for "num_elements" elements of "size" bytes and
1555 * initalize with "data".
1556 * if "data" is null, then the contents of the buffer data store
1558 * Basically there are two ways to get buffer data to the server side. One is
1559 * to call vaCreateBuffer() with a non-null "data", which results the data being
1560 * copied to the data store on the server side. A different method that
1561 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1562 * and then use vaMapBuffer() to map the data store from the server side to the
1563 * client address space for access.
1564 * Note: image buffers are created by the library, not the client. Please see
1565 * vaCreateImage on how image buffers are managed.
1567 VAStatus vaCreateBuffer (
1569 VAContextID context,
1570 VABufferType type, /* in */
1571 unsigned int size, /* in */
1572 unsigned int num_elements, /* in */
1573 void *data, /* in */
1574 VABufferID *buf_id /* out */
1578 * Convey to the server how many valid elements are in the buffer.
1579 * e.g. if multiple slice parameters are being held in a single buffer,
1580 * this will communicate to the server the number of slice parameters
1581 * that are valid in the buffer.
1583 VAStatus vaBufferSetNumElements (
1585 VABufferID buf_id, /* in */
1586 unsigned int num_elements /* in */
1591 * device independent data structure for codedbuffer
1595 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1596 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1597 * enough for the encoder to attempt to limit its size.
1598 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1599 * exceeded the maximum slice size specified.
1600 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1601 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1602 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1604 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1605 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1606 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1607 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1608 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1610 * \brief The frame has exceeded the maximum requested size.
1612 * This flag indicates that the encoded frame size exceeds the value
1613 * specified through a misc parameter buffer of type
1614 * #VAEncMiscParameterTypeMaxFrameSize.
1616 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1617 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1620 * \brief The coded buffer segment contains a single NAL unit.
1622 * This flag indicates that the coded buffer segment contains a
1623 * single NAL unit. This flag might be useful to the user for
1624 * processing the coded buffer.
1626 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1629 * \brief Coded buffer segment.
1631 * #VACodedBufferSegment is an element of a linked list describing
1632 * some information on the coded buffer. The coded buffer segment
1633 * could contain either a single NAL unit, or more than one NAL unit.
1634 * It is recommended (but not required) to return a single NAL unit
1635 * in a coded buffer segment, and the implementation should set the
1636 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1638 typedef struct _VACodedBufferSegment {
1640 * \brief Size of the data buffer in this segment (in bytes).
1643 /** \brief Bit offset into the data buffer where the video data starts. */
1644 unsigned int bit_offset;
1645 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1646 unsigned int status;
1647 /** \brief Reserved for future use. */
1648 unsigned int reserved;
1649 /** \brief Pointer to the start of the data buffer. */
1652 * \brief Pointer to the next #VACodedBufferSegment element,
1653 * or \c NULL if there is none.
1656 } VACodedBufferSegment;
1659 * Map data store of the buffer into the client's address space
1660 * vaCreateBuffer() needs to be called with "data" set to NULL before
1661 * calling vaMapBuffer()
1663 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1664 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1666 VAStatus vaMapBuffer (
1668 VABufferID buf_id, /* in */
1669 void **pbuf /* out */
1673 * After client making changes to a mapped data store, it needs to
1674 * "Unmap" it to let the server know that the data is ready to be
1675 * consumed by the server
1677 VAStatus vaUnmapBuffer (
1679 VABufferID buf_id /* in */
1683 * After this call, the buffer is deleted and this buffer_id is no longer valid
1684 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1686 VAStatus vaDestroyBuffer (
1688 VABufferID buffer_id
1692 Render (Decode) Pictures
1694 A picture represents either a frame or a field.
1696 The Begin/Render/End sequence sends the decode buffers to the server
1700 * Get ready to decode a picture to a target surface
1702 VAStatus vaBeginPicture (
1704 VAContextID context,
1705 VASurfaceID render_target
1709 * Send decode buffers to the server.
1710 * Buffers are automatically destroyed afterwards
1712 VAStatus vaRenderPicture (
1714 VAContextID context,
1715 VABufferID *buffers,
1720 * Make the end of rendering for a picture.
1721 * The server should start processing all pending operations for this
1722 * surface. This call is non-blocking. The client can start another
1723 * Begin/Render/End sequence on a different render target.
1725 VAStatus vaEndPicture (
1737 * This function blocks until all pending operations on the render target
1738 * have been completed. Upon return it is safe to use the render target for a
1739 * different picture.
1741 VAStatus vaSyncSurface (
1743 VASurfaceID render_target
1748 VASurfaceRendering = 1, /* Rendering in progress */
1749 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1750 /* this status is useful if surface is used as the source */
1752 VASurfaceReady = 4, /* not being rendered or displayed */
1753 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1757 * Find out any pending ops on the render target
1759 VAStatus vaQuerySurfaceStatus (
1761 VASurfaceID render_target,
1762 VASurfaceStatus *status /* out */
1767 VADecodeSliceMissing = 0,
1768 VADecodeMBError = 1,
1769 } VADecodeErrorType;
1772 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1773 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1775 typedef struct _VASurfaceDecodeMBErrors
1777 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1778 unsigned int start_mb; /* start mb address with errors */
1779 unsigned int end_mb; /* end mb address with errors */
1780 VADecodeErrorType decode_error_type;
1781 } VASurfaceDecodeMBErrors;
1784 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1785 * it can call vaQuerySurfaceError to find out further details on the particular error.
1786 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1787 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1788 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1789 * The array is terminated if "status==-1" is detected.
1791 VAStatus vaQuerySurfaceError(
1793 VASurfaceID surface,
1794 VAStatus error_status,
1799 * Images and Subpictures
1800 * VAImage is used to either get the surface data to client memory, or
1801 * to copy image data in client memory to a surface.
1802 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1803 * is at the upper left corner with positive X to the right and positive Y down
1805 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1806 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1807 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1809 /* a few common FourCCs */
1810 #define VA_FOURCC_NV12 0x3231564E
1811 #define VA_FOURCC_AI44 0x34344149
1812 #define VA_FOURCC_RGBA 0x41424752
1813 #define VA_FOURCC_BGRA 0x41524742
1814 #define VA_FOURCC_UYVY 0x59565955
1815 #define VA_FOURCC_YUY2 0x32595559
1816 #define VA_FOURCC_AYUV 0x56555941
1817 #define VA_FOURCC_NV11 0x3131564e
1818 #define VA_FOURCC_YV12 0x32315659
1819 #define VA_FOURCC_P208 0x38303250
1820 #define VA_FOURCC_IYUV 0x56555949
1823 #define VA_LSB_FIRST 1
1824 #define VA_MSB_FIRST 2
1826 typedef struct _VAImageFormat
1828 unsigned int fourcc;
1829 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1830 unsigned int bits_per_pixel;
1831 /* for RGB formats */
1832 unsigned int depth; /* significant bits per pixel */
1833 unsigned int red_mask;
1834 unsigned int green_mask;
1835 unsigned int blue_mask;
1836 unsigned int alpha_mask;
1839 typedef VAGenericID VAImageID;
1841 typedef struct _VAImage
1843 VAImageID image_id; /* uniquely identify this image */
1844 VAImageFormat format;
1845 VABufferID buf; /* image data buffer */
1847 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1848 * data store on the server side for optimal performance. The buffer will be
1849 * created by the CreateImage function, and proper storage allocated based on the image
1850 * size and format. This buffer is managed by the library implementation, and
1851 * accessed by the client through the buffer Map/Unmap functions.
1853 unsigned short width;
1854 unsigned short height;
1855 unsigned int data_size;
1856 unsigned int num_planes; /* can not be greater than 3 */
1858 * An array indicating the scanline pitch in bytes for each plane.
1859 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1861 unsigned int pitches[3];
1863 * An array indicating the byte offset from the beginning of the image data
1864 * to the start of each plane.
1866 unsigned int offsets[3];
1868 /* The following fields are only needed for paletted formats */
1869 int num_palette_entries; /* set to zero for non-palette images */
1871 * Each component is one byte and entry_bytes indicates the number of components in
1872 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1876 * An array of ascii characters describing the order of the components within the bytes.
1877 * Only entry_bytes characters of the string are used.
1879 char component_order[4];
1882 /* Get maximum number of image formats supported by the implementation */
1883 int vaMaxNumImageFormats (
1888 * Query supported image formats
1889 * The caller must provide a "format_list" array that can hold at
1890 * least vaMaxNumImageFormats() entries. The actual number of formats
1891 * returned in "format_list" is returned in "num_formats".
1893 VAStatus vaQueryImageFormats (
1895 VAImageFormat *format_list, /* out */
1896 int *num_formats /* out */
1900 * Create a VAImage structure
1901 * The width and height fields returned in the VAImage structure may get
1902 * enlarged for some YUV formats. Upon return from this function,
1903 * image->buf has been created and proper storage allocated by the library.
1904 * The client can access the image through the Map/Unmap calls.
1906 VAStatus vaCreateImage (
1908 VAImageFormat *format,
1911 VAImage *image /* out */
1915 * Should call DestroyImage before destroying the surface it is bound to
1917 VAStatus vaDestroyImage (
1922 VAStatus vaSetImagePalette (
1926 * pointer to an array holding the palette data. The size of the array is
1927 * num_palette_entries * entry_bytes in size. The order of the components
1928 * in the palette is described by the component_order in VAImage struct
1930 unsigned char *palette
1934 * Retrive surface data into a VAImage
1935 * Image must be in a format supported by the implementation
1937 VAStatus vaGetImage (
1939 VASurfaceID surface,
1940 int x, /* coordinates of the upper left source pixel */
1942 unsigned int width, /* width and height of the region */
1943 unsigned int height,
1948 * Copy data from a VAImage to a surface
1949 * Image must be in a format supported by the implementation
1950 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1951 * shouldn't be rendered into when this is called
1953 VAStatus vaPutImage (
1955 VASurfaceID surface,
1959 unsigned int src_width,
1960 unsigned int src_height,
1963 unsigned int dest_width,
1964 unsigned int dest_height
1968 * Derive an VAImage from an existing surface.
1969 * This interface will derive a VAImage and corresponding image buffer from
1970 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1971 * direct CPU access. This operation is only possible on implementations with
1972 * direct rendering capabilities and internal surface formats that can be
1973 * represented with a VAImage. When the operation is not possible this interface
1974 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1975 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1978 * Implementations should only return success when the resulting image buffer
1979 * would be useable with vaMap/Unmap.
1981 * When directly accessing a surface special care must be taken to insure
1982 * proper synchronization with the graphics hardware. Clients should call
1983 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1984 * rendering or currently being displayed by an overlay.
1986 * Additionally nothing about the contents of a surface should be assumed
1987 * following a vaPutSurface. Implementations are free to modify the surface for
1988 * scaling or subpicture blending within a call to vaPutImage.
1990 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1991 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1992 * vaGetImage with other surfaces is supported.
1994 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1995 * image and image buffer structures will be destroyed; however, the underlying
1996 * surface will remain unchanged until freed with vaDestroySurfaces.
1998 VAStatus vaDeriveImage (
2000 VASurfaceID surface,
2001 VAImage *image /* out */
2006 * Subpicture is a special type of image that can be blended
2007 * with a surface during vaPutSurface(). Subpicture can be used to render
2008 * DVD sub-titles or closed captioning text etc.
2011 typedef VAGenericID VASubpictureID;
2013 /* Get maximum number of subpicture formats supported by the implementation */
2014 int vaMaxNumSubpictureFormats (
2018 /* flags for subpictures */
2019 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2020 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2021 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2023 * Query supported subpicture formats
2024 * The caller must provide a "format_list" array that can hold at
2025 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2026 * for each format to indicate additional capabilities for that format. The actual
2027 * number of formats returned in "format_list" is returned in "num_formats".
2028 * flags: returned value to indicate addtional capabilities
2029 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2030 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2031 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2034 VAStatus vaQuerySubpictureFormats (
2036 VAImageFormat *format_list, /* out */
2037 unsigned int *flags, /* out */
2038 unsigned int *num_formats /* out */
2042 * Subpictures are created with an image associated.
2044 VAStatus vaCreateSubpicture (
2047 VASubpictureID *subpicture /* out */
2051 * Destroy the subpicture before destroying the image it is assocated to
2053 VAStatus vaDestroySubpicture (
2055 VASubpictureID subpicture
2059 * Bind an image to the subpicture. This image will now be associated with
2060 * the subpicture instead of the one at creation.
2062 VAStatus vaSetSubpictureImage (
2064 VASubpictureID subpicture,
2069 * If chromakey is enabled, then the area where the source value falls within
2070 * the chromakey [min, max] range is transparent
2071 * The chromakey component format is the following:
2072 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2073 * For YUV: [0:7] V [8:15] U [16:23] Y
2074 * The chromakey mask can be used to mask out certain components for chromakey
2077 VAStatus vaSetSubpictureChromakey (
2079 VASubpictureID subpicture,
2080 unsigned int chromakey_min,
2081 unsigned int chromakey_max,
2082 unsigned int chromakey_mask
2086 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2087 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2088 * the overall alpha is per-pixel alpha multiplied by the global alpha
2090 VAStatus vaSetSubpictureGlobalAlpha (
2092 VASubpictureID subpicture,
2097 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2098 * It defines the region mapping between the subpicture and the target
2099 * surfaces through source and destination rectangles (with the same width and height).
2100 * Both will be displayed at the next call to vaPutSurface. Additional
2101 * associations before the call to vaPutSurface simply overrides the association.
2103 VAStatus vaAssociateSubpicture (
2105 VASubpictureID subpicture,
2106 VASurfaceID *target_surfaces,
2108 short src_x, /* upper left offset in subpicture */
2110 unsigned short src_width,
2111 unsigned short src_height,
2112 short dest_x, /* upper left offset in surface */
2114 unsigned short dest_width,
2115 unsigned short dest_height,
2117 * whether to enable chroma-keying, global-alpha, or screen relative mode
2118 * see VA_SUBPICTURE_XXX values
2124 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2126 VAStatus vaDeassociateSubpicture (
2128 VASubpictureID subpicture,
2129 VASurfaceID *target_surfaces,
2133 typedef struct _VARectangle
2137 unsigned short width;
2138 unsigned short height;
2142 * Display attributes
2143 * Display attributes are used to control things such as contrast, hue, saturation,
2144 * brightness etc. in the rendering process. The application can query what
2145 * attributes are supported by the driver, and then set the appropriate attributes
2146 * before calling vaPutSurface()
2148 /* PowerVR IEP Lite attributes */
2151 VADISPLAYATTRIB_BLE_OFF = 0x00,
2152 VADISPLAYATTRIB_BLE_LOW,
2153 VADISPLAYATTRIB_BLE_MEDIUM,
2154 VADISPLAYATTRIB_BLE_HIGH,
2155 VADISPLAYATTRIB_BLE_NONE,
2156 } VADisplayAttribBLEMode;
2158 /* attribute value for VADisplayAttribRotation */
2159 #define VA_ROTATION_NONE 0x00000000
2160 #define VA_ROTATION_90 0x00000001
2161 #define VA_ROTATION_180 0x00000002
2162 #define VA_ROTATION_270 0x00000003
2164 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2165 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2166 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2169 #define VA_RENDER_MODE_UNDEFINED 0
2170 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2171 #define VA_RENDER_MODE_LOCAL_GPU 2
2172 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2173 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2176 #define VA_RENDER_DEVICE_UNDEFINED 0
2177 #define VA_RENDER_DEVICE_LOCAL 1
2178 #define VA_RENDER_DEVICE_EXTERNAL 2
2180 /* Currently defined display attribute types */
2183 VADisplayAttribBrightness = 0,
2184 VADisplayAttribContrast = 1,
2185 VADisplayAttribHue = 2,
2186 VADisplayAttribSaturation = 3,
2187 /* client can specifiy a background color for the target window
2188 * the new feature of video conference,
2189 * the uncovered area of the surface is filled by this color
2190 * also it will blend with the decoded video color
2192 VADisplayAttribBackgroundColor = 4,
2194 * this is a gettable only attribute. For some implementations that use the
2195 * hardware overlay, after PutSurface is called, the surface can not be
2196 * re-used until after the subsequent PutSurface call. If this is the case
2197 * then the value for this attribute will be set to 1 so that the client
2198 * will not attempt to re-use the surface right after returning from a call
2201 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2202 * driver may use overlay or GPU alternatively
2204 VADisplayAttribDirectSurface = 5,
2205 VADisplayAttribRotation = 6,
2206 VADisplayAttribOutofLoopDeblock = 7,
2208 /* PowerVR IEP Lite specific attributes */
2209 VADisplayAttribBLEBlackMode = 8,
2210 VADisplayAttribBLEWhiteMode = 9,
2211 VADisplayAttribBlueStretch = 10,
2212 VADisplayAttribSkinColorCorrection = 11,
2214 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2215 * conversion matrix. Each element in the matrix is float-point
2217 VADisplayAttribCSCMatrix = 12,
2218 /* specify the constant color used to blend with video surface
2219 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2220 * d: the final color to overwrite into the frame buffer
2221 * v: decoded video after color conversion,
2222 * c: video color specified by VADisplayAttribBlendColor
2223 * b: background color of the drawable
2225 VADisplayAttribBlendColor = 13,
2227 * Indicate driver to skip painting color key or not.
2228 * only applicable if the render is overlay
2230 VADisplayAttribOverlayAutoPaintColorKey = 14,
2232 * customized overlay color key, the format is RGB888
2233 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2235 VADisplayAttribOverlayColorKey = 15,
2237 * The hint for the implementation of vaPutSurface
2238 * normally, the driver could use an overlay or GPU to render the surface on the screen
2239 * this flag provides APP the flexibity to switch the render dynamically
2241 VADisplayAttribRenderMode = 16,
2243 * specify if vaPutSurface needs to render into specified monitors
2244 * one example is that one external monitor (e.g. HDMI) is enabled,
2245 * but the window manager is not aware of it, and there is no associated drawable
2247 VADisplayAttribRenderDevice = 17,
2249 * specify vaPutSurface render area if there is no drawable on the monitor
2251 VADisplayAttribRenderRect = 18,
2252 } VADisplayAttribType;
2254 /* flags for VADisplayAttribute */
2255 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2256 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2257 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2259 typedef struct _VADisplayAttribute
2261 VADisplayAttribType type;
2264 int value; /* used by the set/get attribute functions */
2265 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2267 } VADisplayAttribute;
2269 /* Get maximum number of display attributs supported by the implementation */
2270 int vaMaxNumDisplayAttributes (
2275 * Query display attributes
2276 * The caller must provide a "attr_list" array that can hold at
2277 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2278 * returned in "attr_list" is returned in "num_attributes".
2280 VAStatus vaQueryDisplayAttributes (
2282 VADisplayAttribute *attr_list, /* out */
2283 int *num_attributes /* out */
2287 * Get display attributes
2288 * This function returns the current attribute values in "attr_list".
2289 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2290 * from vaQueryDisplayAttributes() can have their values retrieved.
2292 VAStatus vaGetDisplayAttributes (
2294 VADisplayAttribute *attr_list, /* in/out */
2299 * Set display attributes
2300 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2301 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2302 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2304 VAStatus vaSetDisplayAttributes (
2306 VADisplayAttribute *attr_list,