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 * \defgroup api_core Core API
96 The VA API is intended to provide an interface between a video decode/encode/display
97 application (client) and a hardware accelerator (server), to off-load
98 video decode/encode/display operations from the host to the hardware accelerator at various
101 The basic operation steps are:
103 - Negotiate a mutually acceptable configuration with the server to lock
104 down profile, entrypoints, and other attributes that will not change on
105 a frame-by-frame basis.
106 - Create a decode context which represents a "virtualized" hardware decode
108 - Get and fill decode buffers with picture level, slice level and macroblock
109 level data (depending on entrypoints)
110 - Pass the decode buffers to the server to decode the current frame
112 Initialization & Configuration Management
114 - Find out supported profiles
115 - Find out entrypoints for a given profile
116 - Find out configuration attributes for a given profile/entrypoint pair
117 - Create a configuration for use by the decoder
121 typedef void* VADisplay; /* window system dependent */
123 typedef int VAStatus; /* Return status type from functions */
124 /* Values for the return status */
125 #define VA_STATUS_SUCCESS 0x00000000
126 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
127 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
128 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
129 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
130 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
131 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
132 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
133 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
134 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
135 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
136 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
137 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
138 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
139 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
140 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
141 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
142 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
143 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
144 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
145 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
146 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
147 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
148 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
149 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
151 * \brief An invalid/unsupported value was supplied.
153 * This is a catch-all error code for invalid or unsupported values.
154 * e.g. value exceeding the valid range, invalid type in the context
155 * of generic attribute values.
157 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
158 /** \brief An unsupported filter was supplied. */
159 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
160 /** \brief An invalid filter chain was supplied. */
161 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
162 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
163 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
164 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
166 /* De-interlacing flags for vaPutSurface() */
167 #define VA_FRAME_PICTURE 0x00000000
168 #define VA_TOP_FIELD 0x00000001
169 #define VA_BOTTOM_FIELD 0x00000002
172 * Enabled the positioning/cropping/blending feature:
173 * 1, specify the video playback position in the isurface
174 * 2, specify the cropping info for video playback
175 * 3, encoded video will blend with background color
177 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
180 * Clears the drawable with background color.
181 * for hardware overlay based implementation this flag
182 * can be used to turn off the overlay
184 #define VA_CLEAR_DRAWABLE 0x00000008
186 /* Color space conversion flags for vaPutSurface() */
187 #define VA_SRC_BT601 0x00000010
188 #define VA_SRC_BT709 0x00000020
189 #define VA_SRC_SMPTE_240 0x00000040
191 /* Scaling flags for vaPutSurface() */
192 #define VA_FILTER_SCALING_DEFAULT 0x00000000
193 #define VA_FILTER_SCALING_FAST 0x00000100
194 #define VA_FILTER_SCALING_HQ 0x00000200
195 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
196 #define VA_FILTER_SCALING_MASK 0x00000f00
199 * Returns a short english description of error_status
201 const char *vaErrorStr(VAStatus error_status);
205 * A display must be obtained by calling vaGetDisplay() before calling
206 * vaInitialize() and other functions. This connects the API to the
207 * native window system.
208 * For X Windows, native_dpy would be from XOpenDisplay()
210 typedef void* VANativeDisplay; /* window system dependent */
212 int vaDisplayIsValid(VADisplay dpy);
215 * Initialize the library
217 VAStatus vaInitialize (
219 int *major_version, /* out */
220 int *minor_version /* out */
224 * After this call, all library internal resources will be cleaned up
226 VAStatus vaTerminate (
231 * vaQueryVendorString returns a pointer to a zero-terminated string
232 * describing some aspects of the VA implemenation on a specific
233 * hardware accelerator. The format of the returned string is vendor
234 * specific and at the discretion of the implementer.
235 * e.g. for the Intel GMA500 implementation, an example would be:
236 * "Intel GMA500 - 2.0.0.32L.0005"
238 const char *vaQueryVendorString (
242 typedef int (*VAPrivFunc)();
245 * Return a function pointer given a function name in the library.
246 * This allows private interfaces into the library
248 VAPrivFunc vaGetLibFunc (
253 /* Currently defined profiles */
256 /** \brief Profile ID used for video processing. */
258 VAProfileMPEG2Simple = 0,
259 VAProfileMPEG2Main = 1,
260 VAProfileMPEG4Simple = 2,
261 VAProfileMPEG4AdvancedSimple = 3,
262 VAProfileMPEG4Main = 4,
263 VAProfileH264Baseline = 5,
264 VAProfileH264Main = 6,
265 VAProfileH264High = 7,
266 VAProfileVC1Simple = 8,
267 VAProfileVC1Main = 9,
268 VAProfileVC1Advanced = 10,
269 VAProfileH263Baseline = 11,
270 VAProfileJPEGBaseline = 12,
271 VAProfileH264ConstrainedBaseline = 13
275 * Currently defined entrypoints
281 VAEntrypointIDCT = 3,
282 VAEntrypointMoComp = 4,
283 VAEntrypointDeblocking = 5,
284 VAEntrypointEncSlice = 6, /* slice level encode */
285 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
286 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
290 /* Currently defined configuration attribute types */
293 VAConfigAttribRTFormat = 0,
294 VAConfigAttribSpatialResidual = 1,
295 VAConfigAttribSpatialClipping = 2,
296 VAConfigAttribIntraResidual = 3,
297 VAConfigAttribEncryption = 4,
298 VAConfigAttribRateControl = 5,
300 /** @name Attributes for encoding */
303 * \brief Packed headers mode. Read/write.
305 * This attribute determines what packed headers the driver supports,
306 * through vaGetConfigAttributes(); and what packed headers the user
307 * will be providing to the driver, through vaCreateConfig(), if the
308 * driver supports those.
310 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
312 VAConfigAttribEncPackedHeaders = 10,
314 * \brief Interlaced mode. Read/write.
316 * This attribute determines what kind of interlaced encoding mode
317 * the driver supports.
319 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
321 VAConfigAttribEncInterlaced = 11,
323 * \brief Maximum number of reference frames. Read-only.
325 * This attribute determines the maximum number of reference
326 * frames supported for encoding.
328 * Note: for H.264 encoding, the value represents the maximum number
329 * of reference frames for both the reference picture list 0 (bottom
330 * 16 bits) and the reference picture list 1 (top 16 bits).
332 VAConfigAttribEncMaxRefFrames = 13,
334 * \brief Maximum number of slices per frame. Read-only.
336 * This attribute determines the maximum number of slices the
337 * driver can support to encode a single frame.
339 VAConfigAttribEncMaxSlices = 14,
341 * \brief Slice structure. Read-only.
343 * This attribute determines slice structures supported by the
344 * driver for encoding. This attribute is a hint to the user so
345 * that he can choose a suitable surface size and how to arrange
346 * the encoding process of multiple slices per frame.
348 * More specifically, for H.264 encoding, this attribute
349 * determines the range of accepted values to
350 * VAEncSliceParameterBufferH264::macroblock_address and
351 * VAEncSliceParameterBufferH264::num_macroblocks.
353 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
356 VAConfigAttribEncSliceStructure = 15,
358 * \brief Macroblock information. Read-only.
360 * This attribute determines whether the driver supports extra
361 * encoding information per-macroblock. e.g. QP.
363 * More specifically, for H.264 encoding, if the driver returns a non-zero
364 * value for this attribute, this means the application can create
365 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
366 * through VAEncSliceParameterBufferH264::macroblock_info.
368 VAConfigAttribEncMacroblockInfo = 16,
370 VAConfigAttribTypeMax
371 } VAConfigAttribType;
374 * Configuration attributes
375 * If there is more than one value for an attribute, a default
376 * value will be assigned to the attribute if the client does not
377 * specify the attribute when creating a configuration
379 typedef struct _VAConfigAttrib {
380 VAConfigAttribType type;
381 unsigned int value; /* OR'd flags (bits) for this attribute */
384 /* attribute value for VAConfigAttribRTFormat */
385 #define VA_RT_FORMAT_YUV420 0x00000001
386 #define VA_RT_FORMAT_YUV422 0x00000002
387 #define VA_RT_FORMAT_YUV444 0x00000004
388 #define VA_RT_FORMAT_PROTECTED 0x80000000
390 /** @name Attribute values for VAConfigAttribRateControl */
392 /** \brief Driver does not support any form of rate control. */
393 #define VA_RC_NONE 0x00000001
394 /** \brief Constant bitrate. */
395 #define VA_RC_CBR 0x00000002
396 /** \brief Variable bitrate. */
397 #define VA_RC_VBR 0x00000004
398 /** \brief Video conference mode. */
399 #define VA_RC_VCM 0x00000008
400 /** \brief Constant QP. */
401 #define VA_RC_CQP 0x00000010
402 /** \brief Variable bitrate with peak rate higher than average bitrate. */
403 #define VA_RC_VBR_CONSTRAINED 0x00000020
406 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
408 /** \brief Driver does not support any packed headers mode. */
409 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
410 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
411 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
412 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
413 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
414 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
415 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
416 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
417 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
418 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
419 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x0000000C
422 /** @name Attribute values for VAConfigAttribEncInterlaced */
424 /** \brief Driver does not support interlaced coding. */
425 #define VA_ENC_INTERLACED_NONE 0x00000000
426 /** \brief Driver supports interlaced frame coding. */
427 #define VA_ENC_INTERLACED_FRAME 0x00000001
428 /** \brief Driver supports interlaced field coding. */
429 #define VA_ENC_INTERLACED_FIELD 0x00000002
430 /** \brief Driver supports macroblock adaptive frame field coding. */
431 #define VA_ENC_INTERLACED_MBAFF 0x00000004
432 /** \brief Driver supports picture adaptive frame field coding. */
433 #define VA_ENC_INTERLACED_PAFF 0x00000008
436 /** @name Attribute values for VAConfigAttribEncSliceStructure */
438 /** \brief Driver supports an arbitrary number of rows per slice. */
439 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
440 /** \brief Driver supports a power-of-two number of rows per slice. */
441 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
442 /** \brief Driver supports an arbitrary number of rows per slice. */
443 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
447 * if an attribute is not applicable for a given
448 * profile/entrypoint pair, then set the value to the following
450 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
452 /* Get maximum number of profiles supported by the implementation */
453 int vaMaxNumProfiles (
457 /* Get maximum number of entrypoints supported by the implementation */
458 int vaMaxNumEntrypoints (
462 /* Get maximum number of attributs supported by the implementation */
463 int vaMaxNumConfigAttributes (
468 * Query supported profiles
469 * The caller must provide a "profile_list" array that can hold at
470 * least vaMaxNumProfile() entries. The actual number of profiles
471 * returned in "profile_list" is returned in "num_profile".
473 VAStatus vaQueryConfigProfiles (
475 VAProfile *profile_list, /* out */
476 int *num_profiles /* out */
480 * Query supported entrypoints for a given profile
481 * The caller must provide an "entrypoint_list" array that can hold at
482 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
483 * returned in "entrypoint_list" is returned in "num_entrypoints".
485 VAStatus vaQueryConfigEntrypoints (
488 VAEntrypoint *entrypoint_list, /* out */
489 int *num_entrypoints /* out */
493 * Get attributes for a given profile/entrypoint pair
494 * The caller must provide an "attrib_list" with all attributes to be
495 * retrieved. Upon return, the attributes in "attrib_list" have been
496 * updated with their value. Unknown attributes or attributes that are
497 * not supported for the given profile/entrypoint pair will have their
498 * value set to VA_ATTRIB_NOT_SUPPORTED
500 VAStatus vaGetConfigAttributes (
503 VAEntrypoint entrypoint,
504 VAConfigAttrib *attrib_list, /* in/out */
508 /* Generic ID type, can be re-typed for specific implementation */
509 typedef unsigned int VAGenericID;
511 typedef VAGenericID VAConfigID;
514 * Create a configuration for the decode pipeline
515 * it passes in the attribute list that specifies the attributes it cares
516 * about, with the rest taking default values.
518 VAStatus vaCreateConfig (
521 VAEntrypoint entrypoint,
522 VAConfigAttrib *attrib_list,
524 VAConfigID *config_id /* out */
528 * Free resources associdated with a given config
530 VAStatus vaDestroyConfig (
536 * Query all attributes for a given configuration
537 * The profile of the configuration is returned in "profile"
538 * The entrypoint of the configuration is returned in "entrypoint"
539 * The caller must provide an "attrib_list" array that can hold at least
540 * vaMaxNumConfigAttributes() entries. The actual number of attributes
541 * returned in "attrib_list" is returned in "num_attribs"
543 VAStatus vaQueryConfigAttributes (
545 VAConfigID config_id,
546 VAProfile *profile, /* out */
547 VAEntrypoint *entrypoint, /* out */
548 VAConfigAttrib *attrib_list,/* out */
549 int *num_attribs /* out */
554 * Contexts and Surfaces
556 * Context represents a "virtual" video decode pipeline. Surfaces are render
557 * targets for a given context. The data in the surfaces are not accessible
558 * to the client and the internal data format of the surface is implementatin
561 * Surfaces will be bound to a context when the context is created. Once
562 * a surface is bound to a given context, it can not be used to create
563 * another context. The association is removed when the context is destroyed
565 * Both contexts and surfaces are identified by unique IDs and its
566 * implementation specific internals are kept opaque to the clients
569 typedef VAGenericID VAContextID;
571 typedef VAGenericID VASurfaceID;
573 #define VA_INVALID_ID 0xffffffff
574 #define VA_INVALID_SURFACE VA_INVALID_ID
576 /** \brief Generic value types. */
578 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
579 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
580 VAGenericValueTypePointer, /**< Generic pointer type */
581 VAGenericValueTypeFunc /**< Pointer to function */
582 } VAGenericValueType;
584 /** \brief Generic function type. */
585 typedef void (*VAGenericFunc)(void);
587 /** \brief Generic value. */
588 typedef struct _VAGenericValue {
589 /** \brief Value type. See #VAGenericValueType. */
590 VAGenericValueType type;
591 /** \brief Value holder. */
593 /** \brief 32-bit signed integer. */
595 /** \brief 32-bit float. */
597 /** \brief Generic pointer. */
599 /** \brief Pointer to function. */
605 * vaCreateSurfaces - Create an array of surfaces used for decode and display
607 * width: surface width
608 * height: surface height
609 * format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
610 * num_surfaces: number of surfaces to be created
611 * surfaces: array of surfaces created upon return
613 VAStatus vaCreateSurfaces (
619 VASurfaceID *surfaces /* out */
624 * vaDestroySurfaces - Destroy resources associated with surfaces.
625 * Surfaces can only be destroyed after the context associated has been
628 * surfaces: array of surfaces to destroy
629 * num_surfaces: number of surfaces in the array to be destroyed.
631 VAStatus vaDestroySurfaces (
633 VASurfaceID *surfaces,
637 #define VA_PROGRESSIVE 0x1
639 * vaCreateContext - Create a context
641 * config_id: configuration for the context
642 * picture_width: coded picture width
643 * picture_height: coded picture height
644 * flag: any combination of the following:
645 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
646 * render_targets: render targets (surfaces) tied to the context
647 * num_render_targets: number of render targets in the above array
648 * context: created context id upon return
650 VAStatus vaCreateContext (
652 VAConfigID config_id,
656 VASurfaceID *render_targets,
657 int num_render_targets,
658 VAContextID *context /* out */
662 * vaDestroyContext - Destroy a context
664 * context: context to be destroyed
666 VAStatus vaDestroyContext (
673 * Buffers are used to pass various types of data from the
674 * client to the server. The server maintains a data store
675 * for each buffer created, and the client idenfies a buffer
676 * through a unique buffer id assigned by the server.
679 typedef VAGenericID VABufferID;
683 VAPictureParameterBufferType = 0,
684 VAIQMatrixBufferType = 1,
685 VABitPlaneBufferType = 2,
686 VASliceGroupMapBufferType = 3,
687 VASliceParameterBufferType = 4,
688 VASliceDataBufferType = 5,
689 VAMacroblockParameterBufferType = 6,
690 VAResidualDataBufferType = 7,
691 VADeblockingParameterBufferType = 8,
692 VAImageBufferType = 9,
693 VAProtectedSliceDataBufferType = 10,
694 VAQMatrixBufferType = 11,
695 VAHuffmanTableBufferType = 12,
697 /* Following are encode buffer types */
698 VAEncCodedBufferType = 21,
699 VAEncSequenceParameterBufferType = 22,
700 VAEncPictureParameterBufferType = 23,
701 VAEncSliceParameterBufferType = 24,
702 VAEncPackedHeaderParameterBufferType = 25,
703 VAEncPackedHeaderDataBufferType = 26,
704 VAEncMiscParameterBufferType = 27,
705 VAEncMacroblockParameterBufferType = 28,
706 /* Following are video processing buffer types */
708 * \brief Video processing pipeline parameter buffer.
710 * This buffer describes the video processing pipeline. See
711 * #VAProcPipelineParameterBuffer for details.
713 VAProcPipelineParameterBufferType = 41,
715 * \brief Video filter parameter buffer.
717 * This buffer describes the video filter parameters. All buffers
718 * inherit from #VAProcFilterParameterBufferBase, thus including
719 * a unique filter buffer type.
721 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
722 * Filters requiring advanced parameters include, but are not limited to,
723 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
724 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
726 VAProcFilterParameterBufferType = 42,
732 VAEncMiscParameterTypeFrameRate = 0,
733 VAEncMiscParameterTypeRateControl = 1,
734 VAEncMiscParameterTypeMaxSliceSize = 2,
735 VAEncMiscParameterTypeAIR = 3,
736 /** \brief Buffer type used to express a maximum frame size (in bits). */
737 VAEncMiscParameterTypeMaxFrameSize = 4,
738 /** \brief Buffer type used for HRD parameters. */
739 VAEncMiscParameterTypeHRD = 5,
740 } VAEncMiscParameterType;
742 /** \brief Packed header type. */
744 /** \brief Packed sequence header. */
745 VAEncPackedHeaderSequence = 1,
746 /** \brief Packed picture header. */
747 VAEncPackedHeaderPicture = 2,
748 /** \brief Packed slice header. */
749 VAEncPackedHeaderSlice = 3,
751 * \brief Packed raw header.
753 * Packed raw data header can be used by the client to insert a header
754 * into the bitstream data buffer at the point it is passed, the driver
755 * will handle the raw packed header based on "has_emulation_bytes" field
756 * in the packed header parameter structure.
758 VAEncPackedHeaderRawData = 4,
759 /** \brief Misc packed header. See codec-specific definitions. */
760 VAEncPackedHeaderMiscMask = 0x80000000,
761 } VAEncPackedHeaderType;
763 /** \brief Packed header parameter. */
764 typedef struct _VAEncPackedHeaderParameterBuffer {
765 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
767 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
768 unsigned int bit_length;
769 /** \brief Flag: buffer contains start code emulation prevention bytes? */
770 unsigned char has_emulation_bytes;
771 } VAEncPackedHeaderParameterBuffer;
774 * For application, e.g. set a new bitrate
776 * VAEncMiscParameterBuffer *misc_param;
777 * VAEncMiscParameterRateControl *misc_rate_ctrl;
779 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
780 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
783 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
784 * misc_param->type = VAEncMiscParameterTypeRateControl;
785 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
786 * misc_rate_ctrl->bits_per_second = 6400000;
787 * vaUnmapBuffer(dpy, buf_id);
788 * vaRenderPicture(dpy, context, &buf_id, 1);
790 typedef struct _VAEncMiscParameterBuffer
792 VAEncMiscParameterType type;
793 unsigned int data[0];
794 } VAEncMiscParameterBuffer;
797 /** \brief Rate control parameters */
798 typedef struct _VAEncMiscParameterRateControl
800 /* this is the maximum bit-rate to be constrained by the rate control implementation */
801 unsigned int bits_per_second;
802 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
803 * bit-rate for example if target_percentage is 95 then the rate control will target
804 * a bit-rate that is 95% of the maximum bit-rate
806 unsigned int target_percentage;
807 /* windows size in milliseconds. For example if this is set to 500,
808 * then the rate control will guarantee the target bit-rate over a 500 ms window
810 unsigned int window_size;
811 /* initial QP at I frames */
812 unsigned int initial_qp;
814 unsigned int basic_unit_size;
819 unsigned int reset : 1;
820 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
821 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
825 } VAEncMiscParameterRateControl;
827 typedef struct _VAEncMiscParameterFrameRate
829 unsigned int framerate;
830 } VAEncMiscParameterFrameRate;
833 * Allow a maximum slice size to be specified (in bits).
834 * The encoder will attempt to make sure that individual slices do not exceed this size
835 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
837 typedef struct _VAEncMiscParameterMaxSliceSize
839 unsigned int max_slice_size;
840 } VAEncMiscParameterMaxSliceSize;
842 typedef struct _VAEncMiscParameterAIR
844 unsigned int air_num_mbs;
845 unsigned int air_threshold;
846 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
847 } VAEncMiscParameterAIR;
849 typedef struct _VAEncMiscParameterHRD
851 unsigned int initial_buffer_fullness; /* in bits */
852 unsigned int buffer_size; /* in bits */
853 } VAEncMiscParameterHRD;
856 * \brief Defines a maximum frame size (in bits).
858 * This misc parameter buffer defines the maximum size of a frame (in
859 * bits). The encoder will try to make sure that each frame does not
860 * exceed this size. Otherwise, if the frame size exceeds this size,
861 * the \c status flag of #VACodedBufferSegment will contain
862 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
864 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
865 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
866 VAEncMiscParameterType type;
867 /** \brief Maximum size of a frame (in bits). */
868 unsigned int max_frame_size;
869 } VAEncMiscParameterBufferMaxFrameSize;
872 * There will be cases where the bitstream buffer will not have enough room to hold
873 * the data for the entire slice, and the following flags will be used in the slice
874 * parameter to signal to the server for the possible cases.
875 * If a slice parameter buffer and slice data buffer pair is sent to the server with
876 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
877 * then a slice parameter and data buffer needs to be sent again to complete this slice.
879 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
880 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
881 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
882 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
884 /* Codec-independent Slice Parameter Buffer base */
885 typedef struct _VASliceParameterBufferBase
887 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
888 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
889 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
890 } VASliceParameterBufferBase;
893 /****************************
894 * JEPG data structure
895 ***************************/
896 typedef struct _VAQMatrixBufferJPEG
898 int load_lum_quantiser_matrix;
899 int load_chroma_quantiser_matrix;
900 unsigned char lum_quantiser_matrix[64];
901 unsigned char chroma_quantiser_matrix[64];
902 } VAQMatrixBufferJPEG;
904 typedef struct _VAEncPictureParameterBufferJPEG
906 VASurfaceID reconstructed_picture;
907 unsigned short picture_width;
908 unsigned short picture_height;
909 VABufferID coded_buf;
910 } VAEncPictureParameterBufferJPEG;
912 #include <va/va_dec_jpeg.h>
914 /****************************
915 * MPEG-2 data structures
916 ****************************/
918 /* MPEG-2 Picture Parameter Buffer */
920 * For each frame or field, and before any slice data, a single
921 * picture parameter buffer must be send.
923 typedef struct _VAPictureParameterBufferMPEG2
925 unsigned short horizontal_size;
926 unsigned short vertical_size;
927 VASurfaceID forward_reference_picture;
928 VASurfaceID backward_reference_picture;
929 /* meanings of the following fields are the same as in the standard */
930 int picture_coding_type;
931 int f_code; /* pack all four fcode into this */
934 unsigned int intra_dc_precision : 2;
935 unsigned int picture_structure : 2;
936 unsigned int top_field_first : 1;
937 unsigned int frame_pred_frame_dct : 1;
938 unsigned int concealment_motion_vectors : 1;
939 unsigned int q_scale_type : 1;
940 unsigned int intra_vlc_format : 1;
941 unsigned int alternate_scan : 1;
942 unsigned int repeat_first_field : 1;
943 unsigned int progressive_frame : 1;
944 unsigned int is_first_field : 1; /* indicate whether the current field
945 * is the first field for field picture
949 } picture_coding_extension;
950 } VAPictureParameterBufferMPEG2;
952 /* MPEG-2 Inverse Quantization Matrix Buffer */
953 typedef struct _VAIQMatrixBufferMPEG2
955 int load_intra_quantiser_matrix;
956 int load_non_intra_quantiser_matrix;
957 int load_chroma_intra_quantiser_matrix;
958 int load_chroma_non_intra_quantiser_matrix;
959 unsigned char intra_quantiser_matrix[64];
960 unsigned char non_intra_quantiser_matrix[64];
961 unsigned char chroma_intra_quantiser_matrix[64];
962 unsigned char chroma_non_intra_quantiser_matrix[64];
963 } VAIQMatrixBufferMPEG2;
965 /* MPEG-2 Slice Parameter Buffer */
966 typedef struct _VASliceParameterBufferMPEG2
968 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
969 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
970 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
971 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
972 unsigned int slice_horizontal_position;
973 unsigned int slice_vertical_position;
974 int quantiser_scale_code;
975 int intra_slice_flag;
976 } VASliceParameterBufferMPEG2;
978 /* MPEG-2 Macroblock Parameter Buffer */
979 typedef struct _VAMacroblockParameterBufferMPEG2
981 unsigned short macroblock_address;
983 * macroblock_address (in raster scan order)
985 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
987 unsigned char macroblock_type; /* see definition below */
990 unsigned int frame_motion_type : 2;
991 unsigned int field_motion_type : 2;
992 unsigned int dct_type : 1;
996 unsigned char motion_vertical_field_select;
998 * motion_vertical_field_select:
999 * see section 6.3.17.2 in the spec
1000 * only the lower 4 bits are used
1001 * bit 0: first vector forward
1002 * bit 1: first vector backward
1003 * bit 2: second vector forward
1004 * bit 3: second vector backward
1006 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1007 unsigned short coded_block_pattern;
1009 * The bitplanes for coded_block_pattern are described
1010 * in Figure 6.10-12 in the spec
1013 /* Number of skipped macroblocks after this macroblock */
1014 unsigned short num_skipped_macroblocks;
1015 } VAMacroblockParameterBufferMPEG2;
1018 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1020 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1021 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1022 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1023 #define VA_MB_TYPE_MOTION_INTRA 0x10
1026 * MPEG-2 Residual Data Buffer
1027 * For each macroblock, there wil be 64 shorts (16-bit) in the
1028 * residual data buffer
1031 /****************************
1032 * MPEG-4 Part 2 data structures
1033 ****************************/
1035 /* MPEG-4 Picture Parameter Buffer */
1037 * For each frame or field, and before any slice data, a single
1038 * picture parameter buffer must be send.
1040 typedef struct _VAPictureParameterBufferMPEG4
1042 unsigned short vop_width;
1043 unsigned short vop_height;
1044 VASurfaceID forward_reference_picture;
1045 VASurfaceID backward_reference_picture;
1048 unsigned int short_video_header : 1;
1049 unsigned int chroma_format : 2;
1050 unsigned int interlaced : 1;
1051 unsigned int obmc_disable : 1;
1052 unsigned int sprite_enable : 2;
1053 unsigned int sprite_warping_accuracy : 2;
1054 unsigned int quant_type : 1;
1055 unsigned int quarter_sample : 1;
1056 unsigned int data_partitioned : 1;
1057 unsigned int reversible_vlc : 1;
1058 unsigned int resync_marker_disable : 1;
1062 unsigned char no_of_sprite_warping_points;
1063 short sprite_trajectory_du[3];
1064 short sprite_trajectory_dv[3];
1065 unsigned char quant_precision;
1068 unsigned int vop_coding_type : 2;
1069 unsigned int backward_reference_vop_coding_type : 2;
1070 unsigned int vop_rounding_type : 1;
1071 unsigned int intra_dc_vlc_thr : 3;
1072 unsigned int top_field_first : 1;
1073 unsigned int alternate_vertical_scan_flag : 1;
1077 unsigned char vop_fcode_forward;
1078 unsigned char vop_fcode_backward;
1079 unsigned short vop_time_increment_resolution;
1080 /* short header related */
1081 unsigned char num_gobs_in_vop;
1082 unsigned char num_macroblocks_in_gob;
1083 /* for direct mode prediction */
1086 } VAPictureParameterBufferMPEG4;
1088 /* MPEG-4 Inverse Quantization Matrix Buffer */
1089 typedef struct _VAIQMatrixBufferMPEG4
1091 int load_intra_quant_mat;
1092 int load_non_intra_quant_mat;
1093 unsigned char intra_quant_mat[64];
1094 unsigned char non_intra_quant_mat[64];
1095 } VAIQMatrixBufferMPEG4;
1097 /* MPEG-4 Slice Parameter Buffer */
1098 typedef struct _VASliceParameterBufferMPEG4
1100 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1101 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1102 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1103 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1104 unsigned int macroblock_number;
1106 } VASliceParameterBufferMPEG4;
1109 VC-1 data structures
1112 typedef enum /* see 7.1.1.32 */
1115 VAMvMode1MvHalfPel = 1,
1116 VAMvMode1MvHalfPelBilinear = 2,
1117 VAMvModeMixedMv = 3,
1118 VAMvModeIntensityCompensation = 4
1121 /* VC-1 Picture Parameter Buffer */
1123 * For each picture, and before any slice data, a picture parameter
1124 * buffer must be send. Multiple picture parameter buffers may be
1125 * sent for a single picture. In that case picture parameters will
1126 * apply to all slice data that follow it until a new picture
1127 * parameter buffer is sent.
1130 * pic_quantizer_type should be set to the applicable quantizer
1131 * type as defined by QUANTIZER (J.1.19) and either
1132 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1134 typedef struct _VAPictureParameterBufferVC1
1136 VASurfaceID forward_reference_picture;
1137 VASurfaceID backward_reference_picture;
1138 /* if out-of-loop post-processing is done on the render
1139 target, then we need to keep the in-loop decoded
1140 picture as a reference picture */
1141 VASurfaceID inloop_decoded_picture;
1143 /* sequence layer for AP or meta data for SP and MP */
1146 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1147 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1148 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1149 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1150 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1151 unsigned int multires : 1; /* METADATA::MULTIRES */
1152 unsigned int overlap : 1; /* METADATA::OVERLAP */
1153 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1154 unsigned int rangered : 1; /* METADATA::RANGERED */
1155 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1156 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1161 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1162 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1165 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1166 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1167 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1168 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1171 } entrypoint_fields;
1172 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1173 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1176 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1177 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1178 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1179 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1182 } range_mapping_fields;
1184 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1185 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1186 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1187 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1188 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1189 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1190 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1191 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1192 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1195 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1196 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1197 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1198 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1199 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1205 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1206 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1207 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1208 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1209 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1210 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1211 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1217 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1218 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1219 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1220 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1221 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1222 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1223 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1226 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1229 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1230 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1231 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1232 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1238 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1239 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1240 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1241 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1242 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1243 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1244 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1245 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1246 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1247 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1253 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1254 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1255 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1256 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1257 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1258 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1259 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1260 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1261 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1262 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1263 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1266 } pic_quantizer_fields;
1269 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1270 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1271 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1272 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1273 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1274 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1278 } VAPictureParameterBufferVC1;
1280 /* VC-1 Bitplane Buffer
1281 There will be at most three bitplanes coded in any picture header. To send
1282 the bitplane data more efficiently, each byte is divided in two nibbles, with
1283 each nibble carrying three bitplanes for one macroblock. The following table
1284 shows the bitplane data arrangement within each nibble based on the picture
1287 Picture Type Bit3 Bit2 Bit1 Bit0
1288 I or BI OVERFLAGS ACPRED FIELDTX
1289 P MYTYPEMB SKIPMB DIRECTMB
1290 B FORWARDMB SKIPMB DIRECTMB
1292 Within each byte, the lower nibble is for the first MB and the upper nibble is
1293 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1294 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1295 Macroblock #2 in the first row.
1298 /* VC-1 Slice Parameter Buffer */
1299 typedef struct _VASliceParameterBufferVC1
1301 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1302 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1303 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1304 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1305 unsigned int slice_vertical_position;
1306 } VASliceParameterBufferVC1;
1308 /* VC-1 Slice Data Buffer */
1310 This is simplely a buffer containing raw bit-stream bytes
1313 /****************************
1314 * H.264/AVC data structures
1315 ****************************/
1317 typedef struct _VAPictureH264
1319 VASurfaceID picture_id;
1320 unsigned int frame_idx;
1322 signed int TopFieldOrderCnt;
1323 signed int BottomFieldOrderCnt;
1325 /* flags in VAPictureH264 could be OR of the following */
1326 #define VA_PICTURE_H264_INVALID 0x00000001
1327 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1328 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1329 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1330 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1332 /* H.264 Picture Parameter Buffer */
1334 * For each picture, and before any slice data, a single
1335 * picture parameter buffer must be send.
1337 typedef struct _VAPictureParameterBufferH264
1339 VAPictureH264 CurrPic;
1340 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1341 unsigned short picture_width_in_mbs_minus1;
1342 unsigned short picture_height_in_mbs_minus1;
1343 unsigned char bit_depth_luma_minus8;
1344 unsigned char bit_depth_chroma_minus8;
1345 unsigned char num_ref_frames;
1348 unsigned int chroma_format_idc : 2;
1349 unsigned int residual_colour_transform_flag : 1;
1350 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1351 unsigned int frame_mbs_only_flag : 1;
1352 unsigned int mb_adaptive_frame_field_flag : 1;
1353 unsigned int direct_8x8_inference_flag : 1;
1354 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1355 unsigned int log2_max_frame_num_minus4 : 4;
1356 unsigned int pic_order_cnt_type : 2;
1357 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1358 unsigned int delta_pic_order_always_zero_flag : 1;
1362 unsigned char num_slice_groups_minus1;
1363 unsigned char slice_group_map_type;
1364 unsigned short slice_group_change_rate_minus1;
1365 signed char pic_init_qp_minus26;
1366 signed char pic_init_qs_minus26;
1367 signed char chroma_qp_index_offset;
1368 signed char second_chroma_qp_index_offset;
1371 unsigned int entropy_coding_mode_flag : 1;
1372 unsigned int weighted_pred_flag : 1;
1373 unsigned int weighted_bipred_idc : 2;
1374 unsigned int transform_8x8_mode_flag : 1;
1375 unsigned int field_pic_flag : 1;
1376 unsigned int constrained_intra_pred_flag : 1;
1377 unsigned int pic_order_present_flag : 1;
1378 unsigned int deblocking_filter_control_present_flag : 1;
1379 unsigned int redundant_pic_cnt_present_flag : 1;
1380 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1384 unsigned short frame_num;
1385 } VAPictureParameterBufferH264;
1387 /* H.264 Inverse Quantization Matrix Buffer */
1388 typedef struct _VAIQMatrixBufferH264
1390 unsigned char ScalingList4x4[6][16];
1391 unsigned char ScalingList8x8[2][64];
1392 } VAIQMatrixBufferH264;
1395 * H.264 Slice Group Map Buffer
1396 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1397 * A slice group map buffer should be sent for each picture if required. The buffer
1398 * is sent only when there is a change in the mapping values.
1399 * The slice group map buffer map "map units" to slice groups as specified in
1400 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1401 * in raster scan order
1404 /* H.264 Slice Parameter Buffer */
1405 typedef struct _VASliceParameterBufferH264
1407 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1408 /** \brief Byte offset to the NAL Header Unit for this slice. */
1409 unsigned int slice_data_offset;
1410 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1412 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1414 * This bit offset is relative to and includes the NAL unit byte
1415 * and represents the number of bits parsed in the slice_header()
1416 * after the removal of any emulation prevention bytes in
1417 * there. However, the slice data buffer passed to the hardware is
1418 * the original bitstream, thus including any emulation prevention
1421 unsigned short slice_data_bit_offset;
1422 unsigned short first_mb_in_slice;
1423 unsigned char slice_type;
1424 unsigned char direct_spatial_mv_pred_flag;
1425 unsigned char num_ref_idx_l0_active_minus1;
1426 unsigned char num_ref_idx_l1_active_minus1;
1427 unsigned char cabac_init_idc;
1428 char slice_qp_delta;
1429 unsigned char disable_deblocking_filter_idc;
1430 char slice_alpha_c0_offset_div2;
1431 char slice_beta_offset_div2;
1432 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1433 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1434 unsigned char luma_log2_weight_denom;
1435 unsigned char chroma_log2_weight_denom;
1436 unsigned char luma_weight_l0_flag;
1437 short luma_weight_l0[32];
1438 short luma_offset_l0[32];
1439 unsigned char chroma_weight_l0_flag;
1440 short chroma_weight_l0[32][2];
1441 short chroma_offset_l0[32][2];
1442 unsigned char luma_weight_l1_flag;
1443 short luma_weight_l1[32];
1444 short luma_offset_l1[32];
1445 unsigned char chroma_weight_l1_flag;
1446 short chroma_weight_l1[32][2];
1447 short chroma_offset_l1[32][2];
1448 } VASliceParameterBufferH264;
1450 /****************************
1451 * Common encode data structures
1452 ****************************/
1455 VAEncPictureTypeIntra = 0,
1456 VAEncPictureTypePredictive = 1,
1457 VAEncPictureTypeBidirectional = 2,
1460 /* Encode Slice Parameter Buffer */
1461 typedef struct _VAEncSliceParameterBuffer
1463 unsigned int start_row_number; /* starting MB row number for this slice */
1464 unsigned int slice_height; /* slice height measured in MB */
1467 unsigned int is_intra : 1;
1468 unsigned int disable_deblocking_filter_idc : 2;
1469 unsigned int uses_long_term_ref :1;
1470 unsigned int is_long_term_ref :1;
1474 } VAEncSliceParameterBuffer;
1477 /****************************
1478 * H.263 specific encode data structures
1479 ****************************/
1481 typedef struct _VAEncSequenceParameterBufferH263
1483 unsigned int intra_period;
1484 unsigned int bits_per_second;
1485 unsigned int frame_rate;
1486 unsigned int initial_qp;
1487 unsigned int min_qp;
1488 } VAEncSequenceParameterBufferH263;
1490 typedef struct _VAEncPictureParameterBufferH263
1492 VASurfaceID reference_picture;
1493 VASurfaceID reconstructed_picture;
1494 VABufferID coded_buf;
1495 unsigned short picture_width;
1496 unsigned short picture_height;
1497 VAEncPictureType picture_type;
1498 } VAEncPictureParameterBufferH263;
1500 /****************************
1501 * MPEG-4 specific encode data structures
1502 ****************************/
1504 typedef struct _VAEncSequenceParameterBufferMPEG4
1506 unsigned char profile_and_level_indication;
1507 unsigned int intra_period;
1508 unsigned int video_object_layer_width;
1509 unsigned int video_object_layer_height;
1510 unsigned int vop_time_increment_resolution;
1511 unsigned int fixed_vop_rate;
1512 unsigned int fixed_vop_time_increment;
1513 unsigned int bits_per_second;
1514 unsigned int frame_rate;
1515 unsigned int initial_qp;
1516 unsigned int min_qp;
1517 } VAEncSequenceParameterBufferMPEG4;
1519 typedef struct _VAEncPictureParameterBufferMPEG4
1521 VASurfaceID reference_picture;
1522 VASurfaceID reconstructed_picture;
1523 VABufferID coded_buf;
1524 unsigned short picture_width;
1525 unsigned short picture_height;
1526 unsigned int modulo_time_base; /* number of 1s */
1527 unsigned int vop_time_increment;
1528 VAEncPictureType picture_type;
1529 } VAEncPictureParameterBufferMPEG4;
1533 /* Buffer functions */
1536 * Creates a buffer for "num_elements" elements of "size" bytes and
1537 * initalize with "data".
1538 * if "data" is null, then the contents of the buffer data store
1540 * Basically there are two ways to get buffer data to the server side. One is
1541 * to call vaCreateBuffer() with a non-null "data", which results the data being
1542 * copied to the data store on the server side. A different method that
1543 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1544 * and then use vaMapBuffer() to map the data store from the server side to the
1545 * client address space for access.
1546 * Note: image buffers are created by the library, not the client. Please see
1547 * vaCreateImage on how image buffers are managed.
1549 VAStatus vaCreateBuffer (
1551 VAContextID context,
1552 VABufferType type, /* in */
1553 unsigned int size, /* in */
1554 unsigned int num_elements, /* in */
1555 void *data, /* in */
1556 VABufferID *buf_id /* out */
1560 * Convey to the server how many valid elements are in the buffer.
1561 * e.g. if multiple slice parameters are being held in a single buffer,
1562 * this will communicate to the server the number of slice parameters
1563 * that are valid in the buffer.
1565 VAStatus vaBufferSetNumElements (
1567 VABufferID buf_id, /* in */
1568 unsigned int num_elements /* in */
1573 * device independent data structure for codedbuffer
1577 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1578 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1579 * enough for the encoder to attempt to limit its size.
1580 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1581 * exceeded the maximum slice size specified.
1582 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1583 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1584 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1586 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1587 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1588 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1589 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1590 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1592 * \brief The frame has exceeded the maximum requested size.
1594 * This flag indicates that the encoded frame size exceeds the value
1595 * specified through a misc parameter buffer of type
1596 * #VAEncMiscParameterTypeMaxFrameSize.
1598 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1599 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1602 * \brief The coded buffer segment contains a single NAL unit.
1604 * This flag indicates that the coded buffer segment contains a
1605 * single NAL unit. This flag might be useful to the user for
1606 * processing the coded buffer.
1608 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1611 * \brief Coded buffer segment.
1613 * #VACodedBufferSegment is an element of a linked list describing
1614 * some information on the coded buffer. The coded buffer segment
1615 * could contain either a single NAL unit, or more than one NAL unit.
1616 * It is recommended (but not required) to return a single NAL unit
1617 * in a coded buffer segment, and the implementation should set the
1618 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1620 typedef struct _VACodedBufferSegment {
1622 * \brief Size of the data buffer in this segment (in bytes).
1625 /** \brief Bit offset into the data buffer where the video data starts. */
1626 unsigned int bit_offset;
1627 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1628 unsigned int status;
1629 /** \brief Reserved for future use. */
1630 unsigned int reserved;
1631 /** \brief Pointer to the start of the data buffer. */
1634 * \brief Pointer to the next #VACodedBufferSegment element,
1635 * or \c NULL if there is none.
1638 } VACodedBufferSegment;
1641 * Map data store of the buffer into the client's address space
1642 * vaCreateBuffer() needs to be called with "data" set to NULL before
1643 * calling vaMapBuffer()
1645 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1646 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1648 VAStatus vaMapBuffer (
1650 VABufferID buf_id, /* in */
1651 void **pbuf /* out */
1655 * After client making changes to a mapped data store, it needs to
1656 * "Unmap" it to let the server know that the data is ready to be
1657 * consumed by the server
1659 VAStatus vaUnmapBuffer (
1661 VABufferID buf_id /* in */
1665 * After this call, the buffer is deleted and this buffer_id is no longer valid
1666 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1668 VAStatus vaDestroyBuffer (
1670 VABufferID buffer_id
1674 Render (Decode) Pictures
1676 A picture represents either a frame or a field.
1678 The Begin/Render/End sequence sends the decode buffers to the server
1682 * Get ready to decode a picture to a target surface
1684 VAStatus vaBeginPicture (
1686 VAContextID context,
1687 VASurfaceID render_target
1691 * Send decode buffers to the server.
1692 * Buffers are automatically destroyed afterwards
1694 VAStatus vaRenderPicture (
1696 VAContextID context,
1697 VABufferID *buffers,
1702 * Make the end of rendering for a picture.
1703 * The server should start processing all pending operations for this
1704 * surface. This call is non-blocking. The client can start another
1705 * Begin/Render/End sequence on a different render target.
1707 VAStatus vaEndPicture (
1719 * This function blocks until all pending operations on the render target
1720 * have been completed. Upon return it is safe to use the render target for a
1721 * different picture.
1723 VAStatus vaSyncSurface (
1725 VASurfaceID render_target
1730 VASurfaceRendering = 1, /* Rendering in progress */
1731 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1732 /* this status is useful if surface is used as the source */
1734 VASurfaceReady = 4, /* not being rendered or displayed */
1735 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1739 * Find out any pending ops on the render target
1741 VAStatus vaQuerySurfaceStatus (
1743 VASurfaceID render_target,
1744 VASurfaceStatus *status /* out */
1749 VADecodeSliceMissing = 0,
1750 VADecodeMBError = 1,
1751 } VADecodeErrorType;
1754 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1755 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1757 typedef struct _VASurfaceDecodeMBErrors
1759 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1760 unsigned int start_mb; /* start mb address with errors */
1761 unsigned int end_mb; /* end mb address with errors */
1762 VADecodeErrorType decode_error_type;
1763 } VASurfaceDecodeMBErrors;
1766 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1767 * it can call vaQuerySurfaceError to find out further details on the particular error.
1768 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1769 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1770 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1771 * The array is terminated if "status==-1" is detected.
1773 VAStatus vaQuerySurfaceError(
1775 VASurfaceID surface,
1776 VAStatus error_status,
1781 * Images and Subpictures
1782 * VAImage is used to either get the surface data to client memory, or
1783 * to copy image data in client memory to a surface.
1784 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1785 * is at the upper left corner with positive X to the right and positive Y down
1787 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1788 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1789 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1791 /* a few common FourCCs */
1792 #define VA_FOURCC_NV12 0x3231564E
1793 #define VA_FOURCC_AI44 0x34344149
1794 #define VA_FOURCC_RGBA 0x41424752
1795 #define VA_FOURCC_BGRA 0x41524742
1796 #define VA_FOURCC_UYVY 0x59565955
1797 #define VA_FOURCC_YUY2 0x32595559
1798 #define VA_FOURCC_AYUV 0x56555941
1799 #define VA_FOURCC_NV11 0x3131564e
1800 #define VA_FOURCC_YV12 0x32315659
1801 #define VA_FOURCC_P208 0x38303250
1802 #define VA_FOURCC_IYUV 0x56555949
1805 #define VA_LSB_FIRST 1
1806 #define VA_MSB_FIRST 2
1808 typedef struct _VAImageFormat
1810 unsigned int fourcc;
1811 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1812 unsigned int bits_per_pixel;
1813 /* for RGB formats */
1814 unsigned int depth; /* significant bits per pixel */
1815 unsigned int red_mask;
1816 unsigned int green_mask;
1817 unsigned int blue_mask;
1818 unsigned int alpha_mask;
1821 typedef VAGenericID VAImageID;
1823 typedef struct _VAImage
1825 VAImageID image_id; /* uniquely identify this image */
1826 VAImageFormat format;
1827 VABufferID buf; /* image data buffer */
1829 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1830 * data store on the server side for optimal performance. The buffer will be
1831 * created by the CreateImage function, and proper storage allocated based on the image
1832 * size and format. This buffer is managed by the library implementation, and
1833 * accessed by the client through the buffer Map/Unmap functions.
1835 unsigned short width;
1836 unsigned short height;
1837 unsigned int data_size;
1838 unsigned int num_planes; /* can not be greater than 3 */
1840 * An array indicating the scanline pitch in bytes for each plane.
1841 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1843 unsigned int pitches[3];
1845 * An array indicating the byte offset from the beginning of the image data
1846 * to the start of each plane.
1848 unsigned int offsets[3];
1850 /* The following fields are only needed for paletted formats */
1851 int num_palette_entries; /* set to zero for non-palette images */
1853 * Each component is one byte and entry_bytes indicates the number of components in
1854 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1858 * An array of ascii characters describing the order of the components within the bytes.
1859 * Only entry_bytes characters of the string are used.
1861 char component_order[4];
1864 /* Get maximum number of image formats supported by the implementation */
1865 int vaMaxNumImageFormats (
1870 * Query supported image formats
1871 * The caller must provide a "format_list" array that can hold at
1872 * least vaMaxNumImageFormats() entries. The actual number of formats
1873 * returned in "format_list" is returned in "num_formats".
1875 VAStatus vaQueryImageFormats (
1877 VAImageFormat *format_list, /* out */
1878 int *num_formats /* out */
1882 * Create a VAImage structure
1883 * The width and height fields returned in the VAImage structure may get
1884 * enlarged for some YUV formats. Upon return from this function,
1885 * image->buf has been created and proper storage allocated by the library.
1886 * The client can access the image through the Map/Unmap calls.
1888 VAStatus vaCreateImage (
1890 VAImageFormat *format,
1893 VAImage *image /* out */
1897 * Should call DestroyImage before destroying the surface it is bound to
1899 VAStatus vaDestroyImage (
1904 VAStatus vaSetImagePalette (
1908 * pointer to an array holding the palette data. The size of the array is
1909 * num_palette_entries * entry_bytes in size. The order of the components
1910 * in the palette is described by the component_order in VAImage struct
1912 unsigned char *palette
1916 * Retrive surface data into a VAImage
1917 * Image must be in a format supported by the implementation
1919 VAStatus vaGetImage (
1921 VASurfaceID surface,
1922 int x, /* coordinates of the upper left source pixel */
1924 unsigned int width, /* width and height of the region */
1925 unsigned int height,
1930 * Copy data from a VAImage to a surface
1931 * Image must be in a format supported by the implementation
1932 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1933 * shouldn't be rendered into when this is called
1935 VAStatus vaPutImage (
1937 VASurfaceID surface,
1941 unsigned int src_width,
1942 unsigned int src_height,
1945 unsigned int dest_width,
1946 unsigned int dest_height
1950 * Derive an VAImage from an existing surface.
1951 * This interface will derive a VAImage and corresponding image buffer from
1952 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1953 * direct CPU access. This operation is only possible on implementations with
1954 * direct rendering capabilities and internal surface formats that can be
1955 * represented with a VAImage. When the operation is not possible this interface
1956 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1957 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1960 * Implementations should only return success when the resulting image buffer
1961 * would be useable with vaMap/Unmap.
1963 * When directly accessing a surface special care must be taken to insure
1964 * proper synchronization with the graphics hardware. Clients should call
1965 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1966 * rendering or currently being displayed by an overlay.
1968 * Additionally nothing about the contents of a surface should be assumed
1969 * following a vaPutSurface. Implementations are free to modify the surface for
1970 * scaling or subpicture blending within a call to vaPutImage.
1972 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1973 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1974 * vaGetImage with other surfaces is supported.
1976 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1977 * image and image buffer structures will be destroyed; however, the underlying
1978 * surface will remain unchanged until freed with vaDestroySurfaces.
1980 VAStatus vaDeriveImage (
1982 VASurfaceID surface,
1983 VAImage *image /* out */
1988 * Subpicture is a special type of image that can be blended
1989 * with a surface during vaPutSurface(). Subpicture can be used to render
1990 * DVD sub-titles or closed captioning text etc.
1993 typedef VAGenericID VASubpictureID;
1995 /* Get maximum number of subpicture formats supported by the implementation */
1996 int vaMaxNumSubpictureFormats (
2000 /* flags for subpictures */
2001 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2002 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2003 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2005 * Query supported subpicture formats
2006 * The caller must provide a "format_list" array that can hold at
2007 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2008 * for each format to indicate additional capabilities for that format. The actual
2009 * number of formats returned in "format_list" is returned in "num_formats".
2010 * flags: returned value to indicate addtional capabilities
2011 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2012 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2013 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2016 VAStatus vaQuerySubpictureFormats (
2018 VAImageFormat *format_list, /* out */
2019 unsigned int *flags, /* out */
2020 unsigned int *num_formats /* out */
2024 * Subpictures are created with an image associated.
2026 VAStatus vaCreateSubpicture (
2029 VASubpictureID *subpicture /* out */
2033 * Destroy the subpicture before destroying the image it is assocated to
2035 VAStatus vaDestroySubpicture (
2037 VASubpictureID subpicture
2041 * Bind an image to the subpicture. This image will now be associated with
2042 * the subpicture instead of the one at creation.
2044 VAStatus vaSetSubpictureImage (
2046 VASubpictureID subpicture,
2051 * If chromakey is enabled, then the area where the source value falls within
2052 * the chromakey [min, max] range is transparent
2053 * The chromakey component format is the following:
2054 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2055 * For YUV: [0:7] V [8:15] U [16:23] Y
2056 * The chromakey mask can be used to mask out certain components for chromakey
2059 VAStatus vaSetSubpictureChromakey (
2061 VASubpictureID subpicture,
2062 unsigned int chromakey_min,
2063 unsigned int chromakey_max,
2064 unsigned int chromakey_mask
2068 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2069 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2070 * the overall alpha is per-pixel alpha multiplied by the global alpha
2072 VAStatus vaSetSubpictureGlobalAlpha (
2074 VASubpictureID subpicture,
2079 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2080 * It defines the region mapping between the subpicture and the target
2081 * surfaces through source and destination rectangles (with the same width and height).
2082 * Both will be displayed at the next call to vaPutSurface. Additional
2083 * associations before the call to vaPutSurface simply overrides the association.
2085 VAStatus vaAssociateSubpicture (
2087 VASubpictureID subpicture,
2088 VASurfaceID *target_surfaces,
2090 short src_x, /* upper left offset in subpicture */
2092 unsigned short src_width,
2093 unsigned short src_height,
2094 short dest_x, /* upper left offset in surface */
2096 unsigned short dest_width,
2097 unsigned short dest_height,
2099 * whether to enable chroma-keying, global-alpha, or screen relative mode
2100 * see VA_SUBPICTURE_XXX values
2106 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2108 VAStatus vaDeassociateSubpicture (
2110 VASubpictureID subpicture,
2111 VASurfaceID *target_surfaces,
2115 typedef struct _VARectangle
2119 unsigned short width;
2120 unsigned short height;
2124 * Display attributes
2125 * Display attributes are used to control things such as contrast, hue, saturation,
2126 * brightness etc. in the rendering process. The application can query what
2127 * attributes are supported by the driver, and then set the appropriate attributes
2128 * before calling vaPutSurface()
2130 /* PowerVR IEP Lite attributes */
2133 VADISPLAYATTRIB_BLE_OFF = 0x00,
2134 VADISPLAYATTRIB_BLE_LOW,
2135 VADISPLAYATTRIB_BLE_MEDIUM,
2136 VADISPLAYATTRIB_BLE_HIGH,
2137 VADISPLAYATTRIB_BLE_NONE,
2138 } VADisplayAttribBLEMode;
2140 /* attribute value for VADisplayAttribRotation */
2141 #define VA_ROTATION_NONE 0x00000000
2142 #define VA_ROTATION_90 0x00000001
2143 #define VA_ROTATION_180 0x00000002
2144 #define VA_ROTATION_270 0x00000003
2146 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2147 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2148 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2151 #define VA_RENDER_MODE_UNDEFINED 0
2152 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2153 #define VA_RENDER_MODE_LOCAL_GPU 2
2154 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2155 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2158 #define VA_RENDER_DEVICE_UNDEFINED 0
2159 #define VA_RENDER_DEVICE_LOCAL 1
2160 #define VA_RENDER_DEVICE_EXTERNAL 2
2162 /* Currently defined display attribute types */
2165 VADisplayAttribBrightness = 0,
2166 VADisplayAttribContrast = 1,
2167 VADisplayAttribHue = 2,
2168 VADisplayAttribSaturation = 3,
2169 /* client can specifiy a background color for the target window
2170 * the new feature of video conference,
2171 * the uncovered area of the surface is filled by this color
2172 * also it will blend with the decoded video color
2174 VADisplayAttribBackgroundColor = 4,
2176 * this is a gettable only attribute. For some implementations that use the
2177 * hardware overlay, after PutSurface is called, the surface can not be
2178 * re-used until after the subsequent PutSurface call. If this is the case
2179 * then the value for this attribute will be set to 1 so that the client
2180 * will not attempt to re-use the surface right after returning from a call
2183 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2184 * driver may use overlay or GPU alternatively
2186 VADisplayAttribDirectSurface = 5,
2187 VADisplayAttribRotation = 6,
2188 VADisplayAttribOutofLoopDeblock = 7,
2190 /* PowerVR IEP Lite specific attributes */
2191 VADisplayAttribBLEBlackMode = 8,
2192 VADisplayAttribBLEWhiteMode = 9,
2193 VADisplayAttribBlueStretch = 10,
2194 VADisplayAttribSkinColorCorrection = 11,
2196 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2197 * conversion matrix. Each element in the matrix is float-point
2199 VADisplayAttribCSCMatrix = 12,
2200 /* specify the constant color used to blend with video surface
2201 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2202 * d: the final color to overwrite into the frame buffer
2203 * v: decoded video after color conversion,
2204 * c: video color specified by VADisplayAttribBlendColor
2205 * b: background color of the drawable
2207 VADisplayAttribBlendColor = 13,
2209 * Indicate driver to skip painting color key or not.
2210 * only applicable if the render is overlay
2212 VADisplayAttribOverlayAutoPaintColorKey = 14,
2214 * customized overlay color key, the format is RGB888
2215 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2217 VADisplayAttribOverlayColorKey = 15,
2219 * The hint for the implementation of vaPutSurface
2220 * normally, the driver could use an overlay or GPU to render the surface on the screen
2221 * this flag provides APP the flexibity to switch the render dynamically
2223 VADisplayAttribRenderMode = 16,
2225 * specify if vaPutSurface needs to render into specified monitors
2226 * one example is that one external monitor (e.g. HDMI) is enabled,
2227 * but the window manager is not aware of it, and there is no associated drawable
2229 VADisplayAttribRenderDevice = 17,
2231 * specify vaPutSurface render area if there is no drawable on the monitor
2233 VADisplayAttribRenderRect = 18,
2234 } VADisplayAttribType;
2236 /* flags for VADisplayAttribute */
2237 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2238 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2239 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2241 typedef struct _VADisplayAttribute
2243 VADisplayAttribType type;
2246 int value; /* used by the set/get attribute functions */
2247 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2249 } VADisplayAttribute;
2251 /* Get maximum number of display attributs supported by the implementation */
2252 int vaMaxNumDisplayAttributes (
2257 * Query display attributes
2258 * The caller must provide a "attr_list" array that can hold at
2259 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2260 * returned in "attr_list" is returned in "num_attributes".
2262 VAStatus vaQueryDisplayAttributes (
2264 VADisplayAttribute *attr_list, /* out */
2265 int *num_attributes /* out */
2269 * Get display attributes
2270 * This function returns the current attribute values in "attr_list".
2271 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2272 * from vaQueryDisplayAttributes() can have their values retrieved.
2274 VAStatus vaGetDisplayAttributes (
2276 VADisplayAttribute *attr_list, /* in/out */
2281 * Set display attributes
2282 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2283 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2284 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2286 VAStatus vaSetDisplayAttributes (
2288 VADisplayAttribute *attr_list,