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.
74 #include <va/va_version.h>
83 The VA API is intended to provide an interface between a video decode/encode/display
84 application (client) and a hardware accelerator (server), to off-load
85 video decode/encode/display operations from the host to the hardware accelerator at various
88 The basic operation steps are:
90 - Negotiate a mutually acceptable configuration with the server to lock
91 down profile, entrypoints, and other attributes that will not change on
92 a frame-by-frame basis.
93 - Create a decode context which represents a "virtualized" hardware decode
95 - Get and fill decode buffers with picture level, slice level and macroblock
96 level data (depending on entrypoints)
97 - Pass the decode buffers to the server to decode the current frame
99 Initialization & Configuration Management
101 - Find out supported profiles
102 - Find out entrypoints for a given profile
103 - Find out configuration attributes for a given profile/entrypoint pair
104 - Create a configuration for use by the decoder
108 typedef void* VADisplay; /* window system dependent */
110 typedef int VAStatus; /* Return status type from functions */
111 /* Values for the return status */
112 #define VA_STATUS_SUCCESS 0x00000000
113 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
114 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
115 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
116 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
117 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
118 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
119 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
120 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
121 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
122 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
123 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
124 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
125 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
126 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
127 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
128 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
129 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
130 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
131 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
132 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
133 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
134 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
135 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
136 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
138 * \brief An invalid/unsupported value was supplied.
140 * This is a catch-all error code for invalid or unsupported values.
141 * e.g. value exceeding the valid range, invalid type in the context
142 * of generic attribute values.
144 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
145 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
146 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
147 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
149 /* De-interlacing flags for vaPutSurface() */
150 #define VA_FRAME_PICTURE 0x00000000
151 #define VA_TOP_FIELD 0x00000001
152 #define VA_BOTTOM_FIELD 0x00000002
155 * Enabled the positioning/cropping/blending feature:
156 * 1, specify the video playback position in the isurface
157 * 2, specify the cropping info for video playback
158 * 3, encoded video will blend with background color
160 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
163 * Clears the drawable with background color.
164 * for hardware overlay based implementation this flag
165 * can be used to turn off the overlay
167 #define VA_CLEAR_DRAWABLE 0x00000008
169 /* Color space conversion flags for vaPutSurface() */
170 #define VA_SRC_BT601 0x00000010
171 #define VA_SRC_BT709 0x00000020
172 #define VA_SRC_SMPTE_240 0x00000040
174 /* Scaling flags for vaPutSurface() */
175 #define VA_FILTER_SCALING_DEFAULT 0x00000000
176 #define VA_FILTER_SCALING_FAST 0x00000100
177 #define VA_FILTER_SCALING_HQ 0x00000200
178 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
179 #define VA_FILTER_SCALING_MASK 0x00000f00
182 * Returns a short english description of error_status
184 const char *vaErrorStr(VAStatus error_status);
188 * A display must be obtained by calling vaGetDisplay() before calling
189 * vaInitialize() and other functions. This connects the API to the
190 * native window system.
191 * For X Windows, native_dpy would be from XOpenDisplay()
193 typedef void* VANativeDisplay; /* window system dependent */
195 int vaDisplayIsValid(VADisplay dpy);
198 * Initialize the library
200 VAStatus vaInitialize (
202 int *major_version, /* out */
203 int *minor_version /* out */
207 * After this call, all library internal resources will be cleaned up
209 VAStatus vaTerminate (
214 * vaQueryVendorString returns a pointer to a zero-terminated string
215 * describing some aspects of the VA implemenation on a specific
216 * hardware accelerator. The format of the returned string is vendor
217 * specific and at the discretion of the implementer.
218 * e.g. for the Intel GMA500 implementation, an example would be:
219 * "Intel GMA500 - 2.0.0.32L.0005"
221 const char *vaQueryVendorString (
225 typedef int (*VAPrivFunc)();
228 * Return a function pointer given a function name in the library.
229 * This allows private interfaces into the library
231 VAPrivFunc vaGetLibFunc (
236 /* Currently defined profiles */
239 VAProfileMPEG2Simple = 0,
240 VAProfileMPEG2Main = 1,
241 VAProfileMPEG4Simple = 2,
242 VAProfileMPEG4AdvancedSimple = 3,
243 VAProfileMPEG4Main = 4,
244 VAProfileH264Baseline = 5,
245 VAProfileH264Main = 6,
246 VAProfileH264High = 7,
247 VAProfileVC1Simple = 8,
248 VAProfileVC1Main = 9,
249 VAProfileVC1Advanced = 10,
250 VAProfileH263Baseline = 11,
251 VAProfileJPEGBaseline = 12,
252 VAProfileH264ConstrainedBaseline = 13
256 * Currently defined entrypoints
262 VAEntrypointIDCT = 3,
263 VAEntrypointMoComp = 4,
264 VAEntrypointDeblocking = 5,
265 VAEntrypointEncSlice = 6, /* slice level encode */
266 VAEntrypointEncPicture = 7 /* pictuer encode, JPEG, etc */
269 /* Currently defined configuration attribute types */
272 VAConfigAttribRTFormat = 0,
273 VAConfigAttribSpatialResidual = 1,
274 VAConfigAttribSpatialClipping = 2,
275 VAConfigAttribIntraResidual = 3,
276 VAConfigAttribEncryption = 4,
277 VAConfigAttribRateControl = 5,
279 /** @name Attributes for encoding */
282 * \brief Packed headers mode. Read/write.
284 * This attribute determines what packed headers the driver supports,
285 * through vaGetConfigAttributes(); and what packed headers the user
286 * will be providing to the driver, through vaCreateConfig(), if the
287 * driver supports those.
289 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
291 VAConfigAttribEncPackedHeaders = 10,
293 * \brief Interlaced mode. Read/write.
295 * This attribute determines what kind of interlaced encoding mode
296 * the driver supports.
298 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
300 VAConfigAttribEncInterlaced = 11,
302 * \brief Maximum number of reference frames. Read-only.
304 * This attribute determines the maximum number of reference
305 * frames supported for encoding.
307 * Note: for H.264 encoding, the value represents the maximum number
308 * of reference frames for both the reference picture list 0 (bottom
309 * 16 bits) and the reference picture list 1 (top 16 bits).
311 VAConfigAttribEncMaxRefFrames = 13,
313 * \brief Maximum number of slices per frame. Read-only.
315 * This attribute determines the maximum number of slices the
316 * driver can support to encode a single frame.
318 VAConfigAttribEncMaxSlices = 14,
320 * \brief Slice structure. Read-only.
322 * This attribute determines slice structures supported by the
323 * driver for encoding. This attribute is a hint to the user so
324 * that he can choose a suitable surface size and how to arrange
325 * the encoding process of multiple slices per frame.
327 * More specifically, for H.264 encoding, this attribute
328 * determines the range of accepted values to
329 * VAEncSliceParameterBufferH264::macroblock_address and
330 * VAEncSliceParameterBufferH264::num_macroblocks.
332 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
335 VAConfigAttribEncSliceStructure = 15,
337 * \brief Macroblock information. Read-only.
339 * This attribute determines whether the driver supports extra
340 * encoding information per-macroblock. e.g. QP.
342 * More specifically, for H.264 encoding, if the driver returns a non-zero
343 * value for this attribute, this means the application can create
344 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
345 * through VAEncSliceParameterBufferH264::macroblock_info.
347 VAConfigAttribEncMacroblockInfo = 16,
349 } VAConfigAttribType;
352 * Configuration attributes
353 * If there is more than one value for an attribute, a default
354 * value will be assigned to the attribute if the client does not
355 * specify the attribute when creating a configuration
357 typedef struct _VAConfigAttrib {
358 VAConfigAttribType type;
359 unsigned int value; /* OR'd flags (bits) for this attribute */
362 /* attribute value for VAConfigAttribRTFormat */
363 #define VA_RT_FORMAT_YUV420 0x00000001
364 #define VA_RT_FORMAT_YUV422 0x00000002
365 #define VA_RT_FORMAT_YUV444 0x00000004
366 #define VA_RT_FORMAT_PROTECTED 0x80000000
368 /** @name Attribute values for VAConfigAttribRateControl */
370 /** \brief Driver does not support any form of rate control. */
371 #define VA_RC_NONE 0x00000001
372 /** \brief Constant bitrate. */
373 #define VA_RC_CBR 0x00000002
374 /** \brief Variable bitrate. */
375 #define VA_RC_VBR 0x00000004
376 /** \brief Video conference mode. */
377 #define VA_RC_VCM 0x00000008
378 /** \brief Constant QP. */
379 #define VA_RC_CQP 0x00000010
380 /** \brief Variable bitrate with peak rate higher than average bitrate. */
381 #define VA_RC_VBR_CONSTRAINED 0x00000020
384 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
386 /** \brief Driver does not support any packed headers mode. */
387 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
388 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
389 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
390 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
391 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
392 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
393 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
394 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
395 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
398 /** @name Attribute values for VAConfigAttribEncInterlaced */
400 /** \brief Driver does not support interlaced coding. */
401 #define VA_ENC_INTERLACED_NONE 0x00000000
402 /** \brief Driver supports interlaced frame coding. */
403 #define VA_ENC_INTERLACED_FRAME 0x00000001
404 /** \brief Driver supports interlaced field coding. */
405 #define VA_ENC_INTERLACED_FIELD 0x00000002
406 /** \brief Driver supports macroblock adaptive frame field coding. */
407 #define VA_ENC_INTERLACED_MBAFF 0x00000004
408 /** \brief Driver supports picture adaptive frame field coding. */
409 #define VA_ENC_INTERLACED_PAFF 0x00000008
412 /** @name Attribute values for VAConfigAttribEncSliceStructure */
414 /** \brief Driver supports an arbitrary number of rows per slice. */
415 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
416 /** \brief Driver supports a power-of-two number of rows per slice. */
417 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
418 /** \brief Driver supports an arbitrary number of rows per slice. */
419 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
423 * if an attribute is not applicable for a given
424 * profile/entrypoint pair, then set the value to the following
426 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
428 /* Get maximum number of profiles supported by the implementation */
429 int vaMaxNumProfiles (
433 /* Get maximum number of entrypoints supported by the implementation */
434 int vaMaxNumEntrypoints (
438 /* Get maximum number of attributs supported by the implementation */
439 int vaMaxNumConfigAttributes (
444 * Query supported profiles
445 * The caller must provide a "profile_list" array that can hold at
446 * least vaMaxNumProfile() entries. The actual number of profiles
447 * returned in "profile_list" is returned in "num_profile".
449 VAStatus vaQueryConfigProfiles (
451 VAProfile *profile_list, /* out */
452 int *num_profiles /* out */
456 * Query supported entrypoints for a given profile
457 * The caller must provide an "entrypoint_list" array that can hold at
458 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
459 * returned in "entrypoint_list" is returned in "num_entrypoints".
461 VAStatus vaQueryConfigEntrypoints (
464 VAEntrypoint *entrypoint_list, /* out */
465 int *num_entrypoints /* out */
469 * Get attributes for a given profile/entrypoint pair
470 * The caller must provide an "attrib_list" with all attributes to be
471 * retrieved. Upon return, the attributes in "attrib_list" have been
472 * updated with their value. Unknown attributes or attributes that are
473 * not supported for the given profile/entrypoint pair will have their
474 * value set to VA_ATTRIB_NOT_SUPPORTED
476 VAStatus vaGetConfigAttributes (
479 VAEntrypoint entrypoint,
480 VAConfigAttrib *attrib_list, /* in/out */
484 /* Generic ID type, can be re-typed for specific implementation */
485 typedef unsigned int VAGenericID;
487 typedef VAGenericID VAConfigID;
490 * Create a configuration for the decode pipeline
491 * it passes in the attribute list that specifies the attributes it cares
492 * about, with the rest taking default values.
494 VAStatus vaCreateConfig (
497 VAEntrypoint entrypoint,
498 VAConfigAttrib *attrib_list,
500 VAConfigID *config_id /* out */
504 * Free resources associdated with a given config
506 VAStatus vaDestroyConfig (
512 * Query all attributes for a given configuration
513 * The profile of the configuration is returned in "profile"
514 * The entrypoint of the configuration is returned in "entrypoint"
515 * The caller must provide an "attrib_list" array that can hold at least
516 * vaMaxNumConfigAttributes() entries. The actual number of attributes
517 * returned in "attrib_list" is returned in "num_attribs"
519 VAStatus vaQueryConfigAttributes (
521 VAConfigID config_id,
522 VAProfile *profile, /* out */
523 VAEntrypoint *entrypoint, /* out */
524 VAConfigAttrib *attrib_list,/* out */
525 int *num_attribs /* out */
530 * Contexts and Surfaces
532 * Context represents a "virtual" video decode pipeline. Surfaces are render
533 * targets for a given context. The data in the surfaces are not accessible
534 * to the client and the internal data format of the surface is implementatin
537 * Surfaces will be bound to a context when the context is created. Once
538 * a surface is bound to a given context, it can not be used to create
539 * another context. The association is removed when the context is destroyed
541 * Both contexts and surfaces are identified by unique IDs and its
542 * implementation specific internals are kept opaque to the clients
545 typedef VAGenericID VAContextID;
547 typedef VAGenericID VASurfaceID;
549 #define VA_INVALID_ID 0xffffffff
550 #define VA_INVALID_SURFACE VA_INVALID_ID
552 /** \brief Generic value types. */
554 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
555 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
556 VAGenericValueTypePointer, /**< Generic pointer type */
557 VAGenericValueTypeFunc /**< Pointer to function */
558 } VAGenericValueType;
560 /** \brief Generic function type. */
561 typedef void (*VAGenericFunc)(void);
563 /** \brief Generic value. */
564 typedef struct _VAGenericValue {
565 /** \brief Value type. See #VAGenericValueType. */
566 VAGenericValueType type;
567 /** \brief Value holder. */
569 /** \brief 32-bit signed integer. */
571 /** \brief 32-bit float. */
573 /** \brief Generic pointer. */
575 /** \brief Pointer to function. */
581 * vaCreateSurfaces - Create an array of surfaces used for decode and display
583 * width: surface width
584 * height: surface height
585 * format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
586 * num_surfaces: number of surfaces to be created
587 * surfaces: array of surfaces created upon return
589 VAStatus vaCreateSurfaces (
595 VASurfaceID *surfaces /* out */
600 * vaDestroySurfaces - Destroy resources associated with surfaces.
601 * Surfaces can only be destroyed after the context associated has been
604 * surfaces: array of surfaces to destroy
605 * num_surfaces: number of surfaces in the array to be destroyed.
607 VAStatus vaDestroySurfaces (
609 VASurfaceID *surfaces,
613 #define VA_PROGRESSIVE 0x1
615 * vaCreateContext - Create a context
617 * config_id: configuration for the context
618 * picture_width: coded picture width
619 * picture_height: coded picture height
620 * flag: any combination of the following:
621 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
622 * render_targets: render targets (surfaces) tied to the context
623 * num_render_targets: number of render targets in the above array
624 * context: created context id upon return
626 VAStatus vaCreateContext (
628 VAConfigID config_id,
632 VASurfaceID *render_targets,
633 int num_render_targets,
634 VAContextID *context /* out */
638 * vaDestroyContext - Destroy a context
640 * context: context to be destroyed
642 VAStatus vaDestroyContext (
649 * Buffers are used to pass various types of data from the
650 * client to the server. The server maintains a data store
651 * for each buffer created, and the client idenfies a buffer
652 * through a unique buffer id assigned by the server.
655 typedef VAGenericID VABufferID;
659 VAPictureParameterBufferType = 0,
660 VAIQMatrixBufferType = 1,
661 VABitPlaneBufferType = 2,
662 VASliceGroupMapBufferType = 3,
663 VASliceParameterBufferType = 4,
664 VASliceDataBufferType = 5,
665 VAMacroblockParameterBufferType = 6,
666 VAResidualDataBufferType = 7,
667 VADeblockingParameterBufferType = 8,
668 VAImageBufferType = 9,
669 VAProtectedSliceDataBufferType = 10,
670 VAQMatrixBufferType = 11,
671 VAHuffmanTableBufferType = 12,
673 /* Following are encode buffer types */
674 VAEncCodedBufferType = 21,
675 VAEncSequenceParameterBufferType = 22,
676 VAEncPictureParameterBufferType = 23,
677 VAEncSliceParameterBufferType = 24,
678 VAEncPackedHeaderParameterBufferType = 25,
679 VAEncPackedHeaderDataBufferType = 26,
680 VAEncMiscParameterBufferType = 27,
681 VAEncMacroblockParameterBufferType = 28,
682 VABufferTypeMax = 0xff
687 VAEncMiscParameterTypeFrameRate = 0,
688 VAEncMiscParameterTypeRateControl = 1,
689 VAEncMiscParameterTypeMaxSliceSize = 2,
690 VAEncMiscParameterTypeAIR = 3,
691 /** \brief Buffer type used to express a maximum frame size (in bits). */
692 VAEncMiscParameterTypeMaxFrameSize = 4,
693 /** \brief Buffer type used for HRD parameters. */
694 VAEncMiscParameterTypeHRD = 5,
695 } VAEncMiscParameterType;
697 /** \brief Packed header type. */
699 /** \brief Packed sequence header. */
700 VAEncPackedHeaderSequence = 1,
701 /** \brief Packed picture header. */
702 VAEncPackedHeaderPicture = 2,
703 /** \brief Packed slice header. */
704 VAEncPackedHeaderSlice = 3,
705 /** \brief Misc packed header. See codec-specific definitions. */
706 VAEncPackedHeaderMiscMask = 0x80000000,
707 } VAEncPackedHeaderType;
709 /** \brief Packed header parameter. */
710 typedef struct _VAEncPackedHeaderParameterBuffer {
711 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
713 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
714 unsigned int bit_length;
715 /** \brief Flag: buffer contains start code emulation prevention bytes? */
716 unsigned char has_emulation_bytes;
717 } VAEncPackedHeaderParameterBuffer;
720 * For application, e.g. set a new bitrate
722 * VAEncMiscParameterBuffer *misc_param;
723 * VAEncMiscParameterRateControl *misc_rate_ctrl;
725 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
726 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
729 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
730 * misc_param->type = VAEncMiscParameterTypeRateControl;
731 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
732 * misc_rate_ctrl->bits_per_second = 6400000;
733 * vaUnmapBuffer(dpy, buf_id);
734 * vaRenderPicture(dpy, context, &buf_id, 1);
736 typedef struct _VAEncMiscParameterBuffer
738 VAEncMiscParameterType type;
739 unsigned int data[0];
740 } VAEncMiscParameterBuffer;
743 /** \brief Rate control parameters */
744 typedef struct _VAEncMiscParameterRateControl
746 /* this is the maximum bit-rate to be constrained by the rate control implementation */
747 unsigned int bits_per_second;
748 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
749 * bit-rate for example if target_percentage is 95 then the rate control will target
750 * a bit-rate that is 95% of the maximum bit-rate
752 unsigned int target_percentage;
753 /* windows size in milliseconds. For example if this is set to 500,
754 * then the rate control will guarantee the target bit-rate over a 500 ms window
756 unsigned int window_size;
757 /* initial QP at I frames */
758 unsigned int initial_qp;
760 unsigned int basic_unit_size;
765 unsigned int reset : 1;
766 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
767 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
771 } VAEncMiscParameterRateControl;
773 typedef struct _VAEncMiscParameterFrameRate
775 unsigned int framerate;
776 } VAEncMiscParameterFrameRate;
779 * Allow a maximum slice size to be specified (in bits).
780 * The encoder will attempt to make sure that individual slices do not exceed this size
781 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
783 typedef struct _VAEncMiscParameterMaxSliceSize
785 unsigned int max_slice_size;
786 } VAEncMiscParameterMaxSliceSize;
788 typedef struct _VAEncMiscParameterAIR
790 unsigned int air_num_mbs;
791 unsigned int air_threshold;
792 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
793 } VAEncMiscParameterAIR;
795 typedef struct _VAEncMiscParameterHRD
797 unsigned int initial_buffer_fullness; /* in bits */
798 unsigned int buffer_size; /* in bits */
799 } VAEncMiscParameterHRD;
802 * \brief Defines a maximum frame size (in bits).
804 * This misc parameter buffer defines the maximum size of a frame (in
805 * bits). The encoder will try to make sure that each frame does not
806 * exceed this size. Otherwise, if the frame size exceeds this size,
807 * the \c status flag of #VACodedBufferSegment will contain
808 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
810 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
811 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
812 VAEncMiscParameterType type;
813 /** \brief Maximum size of a frame (in bits). */
814 unsigned int max_frame_size;
815 } VAEncMiscParameterBufferMaxFrameSize;
818 * There will be cases where the bitstream buffer will not have enough room to hold
819 * the data for the entire slice, and the following flags will be used in the slice
820 * parameter to signal to the server for the possible cases.
821 * If a slice parameter buffer and slice data buffer pair is sent to the server with
822 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
823 * then a slice parameter and data buffer needs to be sent again to complete this slice.
825 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
826 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
827 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
828 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
830 /* Codec-independent Slice Parameter Buffer base */
831 typedef struct _VASliceParameterBufferBase
833 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
834 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
835 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
836 } VASliceParameterBufferBase;
839 /****************************
840 * JEPG data structure
841 ***************************/
842 typedef struct _VAQMatrixBufferJPEG
844 int load_lum_quantiser_matrix;
845 int load_chroma_quantiser_matrix;
846 unsigned char lum_quantiser_matrix[64];
847 unsigned char chroma_quantiser_matrix[64];
848 } VAQMatrixBufferJPEG;
850 typedef struct _VAEncPictureParameterBufferJPEG
852 VASurfaceID reconstructed_picture;
853 unsigned short picture_width;
854 unsigned short picture_height;
855 VABufferID coded_buf;
856 } VAEncPictureParameterBufferJPEG;
858 #include <va/va_dec_jpeg.h>
860 /****************************
861 * MPEG-2 data structures
862 ****************************/
864 /* MPEG-2 Picture Parameter Buffer */
866 * For each frame or field, and before any slice data, a single
867 * picture parameter buffer must be send.
869 typedef struct _VAPictureParameterBufferMPEG2
871 unsigned short horizontal_size;
872 unsigned short vertical_size;
873 VASurfaceID forward_reference_picture;
874 VASurfaceID backward_reference_picture;
875 /* meanings of the following fields are the same as in the standard */
876 int picture_coding_type;
877 int f_code; /* pack all four fcode into this */
880 unsigned int intra_dc_precision : 2;
881 unsigned int picture_structure : 2;
882 unsigned int top_field_first : 1;
883 unsigned int frame_pred_frame_dct : 1;
884 unsigned int concealment_motion_vectors : 1;
885 unsigned int q_scale_type : 1;
886 unsigned int intra_vlc_format : 1;
887 unsigned int alternate_scan : 1;
888 unsigned int repeat_first_field : 1;
889 unsigned int progressive_frame : 1;
890 unsigned int is_first_field : 1; /* indicate whether the current field
891 * is the first field for field picture
895 } picture_coding_extension;
896 } VAPictureParameterBufferMPEG2;
898 /* MPEG-2 Inverse Quantization Matrix Buffer */
899 typedef struct _VAIQMatrixBufferMPEG2
901 int load_intra_quantiser_matrix;
902 int load_non_intra_quantiser_matrix;
903 int load_chroma_intra_quantiser_matrix;
904 int load_chroma_non_intra_quantiser_matrix;
905 unsigned char intra_quantiser_matrix[64];
906 unsigned char non_intra_quantiser_matrix[64];
907 unsigned char chroma_intra_quantiser_matrix[64];
908 unsigned char chroma_non_intra_quantiser_matrix[64];
909 } VAIQMatrixBufferMPEG2;
911 /* MPEG-2 Slice Parameter Buffer */
912 typedef struct _VASliceParameterBufferMPEG2
914 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
915 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
916 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
917 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
918 unsigned int slice_horizontal_position;
919 unsigned int slice_vertical_position;
920 int quantiser_scale_code;
921 int intra_slice_flag;
922 } VASliceParameterBufferMPEG2;
924 /* MPEG-2 Macroblock Parameter Buffer */
925 typedef struct _VAMacroblockParameterBufferMPEG2
927 unsigned short macroblock_address;
929 * macroblock_address (in raster scan order)
931 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
933 unsigned char macroblock_type; /* see definition below */
936 unsigned int frame_motion_type : 2;
937 unsigned int field_motion_type : 2;
938 unsigned int dct_type : 1;
942 unsigned char motion_vertical_field_select;
944 * motion_vertical_field_select:
945 * see section 6.3.17.2 in the spec
946 * only the lower 4 bits are used
947 * bit 0: first vector forward
948 * bit 1: first vector backward
949 * bit 2: second vector forward
950 * bit 3: second vector backward
952 short PMV[2][2][2]; /* see Table 7-7 in the spec */
953 unsigned short coded_block_pattern;
955 * The bitplanes for coded_block_pattern are described
956 * in Figure 6.10-12 in the spec
959 /* Number of skipped macroblocks after this macroblock */
960 unsigned short num_skipped_macroblocks;
961 } VAMacroblockParameterBufferMPEG2;
964 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
966 #define VA_MB_TYPE_MOTION_FORWARD 0x02
967 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
968 #define VA_MB_TYPE_MOTION_PATTERN 0x08
969 #define VA_MB_TYPE_MOTION_INTRA 0x10
972 * MPEG-2 Residual Data Buffer
973 * For each macroblock, there wil be 64 shorts (16-bit) in the
974 * residual data buffer
977 /****************************
978 * MPEG-4 Part 2 data structures
979 ****************************/
981 /* MPEG-4 Picture Parameter Buffer */
983 * For each frame or field, and before any slice data, a single
984 * picture parameter buffer must be send.
986 typedef struct _VAPictureParameterBufferMPEG4
988 unsigned short vop_width;
989 unsigned short vop_height;
990 VASurfaceID forward_reference_picture;
991 VASurfaceID backward_reference_picture;
994 unsigned int short_video_header : 1;
995 unsigned int chroma_format : 2;
996 unsigned int interlaced : 1;
997 unsigned int obmc_disable : 1;
998 unsigned int sprite_enable : 2;
999 unsigned int sprite_warping_accuracy : 2;
1000 unsigned int quant_type : 1;
1001 unsigned int quarter_sample : 1;
1002 unsigned int data_partitioned : 1;
1003 unsigned int reversible_vlc : 1;
1004 unsigned int resync_marker_disable : 1;
1008 unsigned char no_of_sprite_warping_points;
1009 short sprite_trajectory_du[3];
1010 short sprite_trajectory_dv[3];
1011 unsigned char quant_precision;
1014 unsigned int vop_coding_type : 2;
1015 unsigned int backward_reference_vop_coding_type : 2;
1016 unsigned int vop_rounding_type : 1;
1017 unsigned int intra_dc_vlc_thr : 3;
1018 unsigned int top_field_first : 1;
1019 unsigned int alternate_vertical_scan_flag : 1;
1023 unsigned char vop_fcode_forward;
1024 unsigned char vop_fcode_backward;
1025 unsigned short vop_time_increment_resolution;
1026 /* short header related */
1027 unsigned char num_gobs_in_vop;
1028 unsigned char num_macroblocks_in_gob;
1029 /* for direct mode prediction */
1032 } VAPictureParameterBufferMPEG4;
1034 /* MPEG-4 Inverse Quantization Matrix Buffer */
1035 typedef struct _VAIQMatrixBufferMPEG4
1037 int load_intra_quant_mat;
1038 int load_non_intra_quant_mat;
1039 unsigned char intra_quant_mat[64];
1040 unsigned char non_intra_quant_mat[64];
1041 } VAIQMatrixBufferMPEG4;
1043 /* MPEG-4 Slice Parameter Buffer */
1044 typedef struct _VASliceParameterBufferMPEG4
1046 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1047 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1048 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1049 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1050 unsigned int macroblock_number;
1052 } VASliceParameterBufferMPEG4;
1055 VC-1 data structures
1058 typedef enum /* see 7.1.1.32 */
1061 VAMvMode1MvHalfPel = 1,
1062 VAMvMode1MvHalfPelBilinear = 2,
1063 VAMvModeMixedMv = 3,
1064 VAMvModeIntensityCompensation = 4
1067 /* VC-1 Picture Parameter Buffer */
1069 * For each picture, and before any slice data, a picture parameter
1070 * buffer must be send. Multiple picture parameter buffers may be
1071 * sent for a single picture. In that case picture parameters will
1072 * apply to all slice data that follow it until a new picture
1073 * parameter buffer is sent.
1076 * pic_quantizer_type should be set to the applicable quantizer
1077 * type as defined by QUANTIZER (J.1.19) and either
1078 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1080 typedef struct _VAPictureParameterBufferVC1
1082 VASurfaceID forward_reference_picture;
1083 VASurfaceID backward_reference_picture;
1084 /* if out-of-loop post-processing is done on the render
1085 target, then we need to keep the in-loop decoded
1086 picture as a reference picture */
1087 VASurfaceID inloop_decoded_picture;
1089 /* sequence layer for AP or meta data for SP and MP */
1092 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1093 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1094 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1095 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1096 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1097 unsigned int multires : 1; /* METADATA::MULTIRES */
1098 unsigned int overlap : 1; /* METADATA::OVERLAP */
1099 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1100 unsigned int rangered : 1; /* METADATA::RANGERED */
1101 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1102 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1107 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1108 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1111 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1112 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1113 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1114 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1117 } entrypoint_fields;
1118 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1119 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1122 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1123 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1124 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1125 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1128 } range_mapping_fields;
1130 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1131 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1132 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1133 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1134 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1135 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1136 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1137 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1138 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1141 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1142 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1143 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1144 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1145 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1151 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1152 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1153 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1154 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1155 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1156 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1157 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1163 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1164 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1165 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1166 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1167 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1168 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1169 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1172 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1175 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1176 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1177 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1178 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1184 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1185 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1186 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1187 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1188 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1189 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1190 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1191 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1192 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1193 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1199 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1200 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1201 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1202 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1203 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1204 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1205 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1206 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1207 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1208 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1209 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1212 } pic_quantizer_fields;
1215 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1216 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1217 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1218 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1219 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1220 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1224 } VAPictureParameterBufferVC1;
1226 /* VC-1 Bitplane Buffer
1227 There will be at most three bitplanes coded in any picture header. To send
1228 the bitplane data more efficiently, each byte is divided in two nibbles, with
1229 each nibble carrying three bitplanes for one macroblock. The following table
1230 shows the bitplane data arrangement within each nibble based on the picture
1233 Picture Type Bit3 Bit2 Bit1 Bit0
1234 I or BI OVERFLAGS ACPRED FIELDTX
1235 P MYTYPEMB SKIPMB DIRECTMB
1236 B FORWARDMB SKIPMB DIRECTMB
1238 Within each byte, the lower nibble is for the first MB and the upper nibble is
1239 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1240 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1241 Macroblock #2 in the first row.
1244 /* VC-1 Slice Parameter Buffer */
1245 typedef struct _VASliceParameterBufferVC1
1247 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1248 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1249 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1250 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1251 unsigned int slice_vertical_position;
1252 } VASliceParameterBufferVC1;
1254 /* VC-1 Slice Data Buffer */
1256 This is simplely a buffer containing raw bit-stream bytes
1259 /****************************
1260 * H.264/AVC data structures
1261 ****************************/
1263 typedef struct _VAPictureH264
1265 VASurfaceID picture_id;
1266 unsigned int frame_idx;
1268 signed int TopFieldOrderCnt;
1269 signed int BottomFieldOrderCnt;
1271 /* flags in VAPictureH264 could be OR of the following */
1272 #define VA_PICTURE_H264_INVALID 0x00000001
1273 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1274 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1275 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1276 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1278 /* H.264 Picture Parameter Buffer */
1280 * For each picture, and before any slice data, a single
1281 * picture parameter buffer must be send.
1283 typedef struct _VAPictureParameterBufferH264
1285 VAPictureH264 CurrPic;
1286 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1287 unsigned short picture_width_in_mbs_minus1;
1288 unsigned short picture_height_in_mbs_minus1;
1289 unsigned char bit_depth_luma_minus8;
1290 unsigned char bit_depth_chroma_minus8;
1291 unsigned char num_ref_frames;
1294 unsigned int chroma_format_idc : 2;
1295 unsigned int residual_colour_transform_flag : 1;
1296 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1297 unsigned int frame_mbs_only_flag : 1;
1298 unsigned int mb_adaptive_frame_field_flag : 1;
1299 unsigned int direct_8x8_inference_flag : 1;
1300 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1301 unsigned int log2_max_frame_num_minus4 : 4;
1302 unsigned int pic_order_cnt_type : 2;
1303 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1304 unsigned int delta_pic_order_always_zero_flag : 1;
1308 unsigned char num_slice_groups_minus1;
1309 unsigned char slice_group_map_type;
1310 unsigned short slice_group_change_rate_minus1;
1311 signed char pic_init_qp_minus26;
1312 signed char pic_init_qs_minus26;
1313 signed char chroma_qp_index_offset;
1314 signed char second_chroma_qp_index_offset;
1317 unsigned int entropy_coding_mode_flag : 1;
1318 unsigned int weighted_pred_flag : 1;
1319 unsigned int weighted_bipred_idc : 2;
1320 unsigned int transform_8x8_mode_flag : 1;
1321 unsigned int field_pic_flag : 1;
1322 unsigned int constrained_intra_pred_flag : 1;
1323 unsigned int pic_order_present_flag : 1;
1324 unsigned int deblocking_filter_control_present_flag : 1;
1325 unsigned int redundant_pic_cnt_present_flag : 1;
1326 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1330 unsigned short frame_num;
1331 } VAPictureParameterBufferH264;
1333 /* H.264 Inverse Quantization Matrix Buffer */
1334 typedef struct _VAIQMatrixBufferH264
1336 unsigned char ScalingList4x4[6][16];
1337 unsigned char ScalingList8x8[2][64];
1338 } VAIQMatrixBufferH264;
1341 * H.264 Slice Group Map Buffer
1342 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1343 * A slice group map buffer should be sent for each picture if required. The buffer
1344 * is sent only when there is a change in the mapping values.
1345 * The slice group map buffer map "map units" to slice groups as specified in
1346 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1347 * in raster scan order
1350 /* H.264 Slice Parameter Buffer */
1351 typedef struct _VASliceParameterBufferH264
1353 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1354 /** \brief Byte offset to the NAL Header Unit for this slice. */
1355 unsigned int slice_data_offset;
1356 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1358 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1360 * This bit offset is relative to and includes the NAL unit byte
1361 * and represents the number of bits parsed in the slice_header()
1362 * after the removal of any emulation prevention bytes in
1363 * there. However, the slice data buffer passed to the hardware is
1364 * the original bitstream, thus including any emulation prevention
1367 unsigned short slice_data_bit_offset;
1368 unsigned short first_mb_in_slice;
1369 unsigned char slice_type;
1370 unsigned char direct_spatial_mv_pred_flag;
1371 unsigned char num_ref_idx_l0_active_minus1;
1372 unsigned char num_ref_idx_l1_active_minus1;
1373 unsigned char cabac_init_idc;
1374 char slice_qp_delta;
1375 unsigned char disable_deblocking_filter_idc;
1376 char slice_alpha_c0_offset_div2;
1377 char slice_beta_offset_div2;
1378 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1379 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1380 unsigned char luma_log2_weight_denom;
1381 unsigned char chroma_log2_weight_denom;
1382 unsigned char luma_weight_l0_flag;
1383 short luma_weight_l0[32];
1384 short luma_offset_l0[32];
1385 unsigned char chroma_weight_l0_flag;
1386 short chroma_weight_l0[32][2];
1387 short chroma_offset_l0[32][2];
1388 unsigned char luma_weight_l1_flag;
1389 short luma_weight_l1[32];
1390 short luma_offset_l1[32];
1391 unsigned char chroma_weight_l1_flag;
1392 short chroma_weight_l1[32][2];
1393 short chroma_offset_l1[32][2];
1394 } VASliceParameterBufferH264;
1396 /****************************
1397 * Common encode data structures
1398 ****************************/
1401 VAEncPictureTypeIntra = 0,
1402 VAEncPictureTypePredictive = 1,
1403 VAEncPictureTypeBidirectional = 2,
1406 /* Encode Slice Parameter Buffer */
1407 typedef struct _VAEncSliceParameterBuffer
1409 unsigned int start_row_number; /* starting MB row number for this slice */
1410 unsigned int slice_height; /* slice height measured in MB */
1413 unsigned int is_intra : 1;
1414 unsigned int disable_deblocking_filter_idc : 2;
1415 unsigned int uses_long_term_ref :1;
1416 unsigned int is_long_term_ref :1;
1420 } VAEncSliceParameterBuffer;
1423 /****************************
1424 * H.263 specific encode data structures
1425 ****************************/
1427 typedef struct _VAEncSequenceParameterBufferH263
1429 unsigned int intra_period;
1430 unsigned int bits_per_second;
1431 unsigned int frame_rate;
1432 unsigned int initial_qp;
1433 unsigned int min_qp;
1434 } VAEncSequenceParameterBufferH263;
1436 typedef struct _VAEncPictureParameterBufferH263
1438 VASurfaceID reference_picture;
1439 VASurfaceID reconstructed_picture;
1440 VABufferID coded_buf;
1441 unsigned short picture_width;
1442 unsigned short picture_height;
1443 VAEncPictureType picture_type;
1444 } VAEncPictureParameterBufferH263;
1446 /****************************
1447 * MPEG-4 specific encode data structures
1448 ****************************/
1450 typedef struct _VAEncSequenceParameterBufferMPEG4
1452 unsigned char profile_and_level_indication;
1453 unsigned int intra_period;
1454 unsigned int video_object_layer_width;
1455 unsigned int video_object_layer_height;
1456 unsigned int vop_time_increment_resolution;
1457 unsigned int fixed_vop_rate;
1458 unsigned int fixed_vop_time_increment;
1459 unsigned int bits_per_second;
1460 unsigned int frame_rate;
1461 unsigned int initial_qp;
1462 unsigned int min_qp;
1463 } VAEncSequenceParameterBufferMPEG4;
1465 typedef struct _VAEncPictureParameterBufferMPEG4
1467 VASurfaceID reference_picture;
1468 VASurfaceID reconstructed_picture;
1469 VABufferID coded_buf;
1470 unsigned short picture_width;
1471 unsigned short picture_height;
1472 unsigned int modulo_time_base; /* number of 1s */
1473 unsigned int vop_time_increment;
1474 VAEncPictureType picture_type;
1475 } VAEncPictureParameterBufferMPEG4;
1479 /* Buffer functions */
1482 * Creates a buffer for "num_elements" elements of "size" bytes and
1483 * initalize with "data".
1484 * if "data" is null, then the contents of the buffer data store
1486 * Basically there are two ways to get buffer data to the server side. One is
1487 * to call vaCreateBuffer() with a non-null "data", which results the data being
1488 * copied to the data store on the server side. A different method that
1489 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1490 * and then use vaMapBuffer() to map the data store from the server side to the
1491 * client address space for access.
1492 * Note: image buffers are created by the library, not the client. Please see
1493 * vaCreateImage on how image buffers are managed.
1495 VAStatus vaCreateBuffer (
1497 VAContextID context,
1498 VABufferType type, /* in */
1499 unsigned int size, /* in */
1500 unsigned int num_elements, /* in */
1501 void *data, /* in */
1502 VABufferID *buf_id /* out */
1506 * Convey to the server how many valid elements are in the buffer.
1507 * e.g. if multiple slice parameters are being held in a single buffer,
1508 * this will communicate to the server the number of slice parameters
1509 * that are valid in the buffer.
1511 VAStatus vaBufferSetNumElements (
1513 VABufferID buf_id, /* in */
1514 unsigned int num_elements /* in */
1519 * device independent data structure for codedbuffer
1523 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1524 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1525 * enough for the encoder to attempt to limit its size.
1526 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1527 * exceeded the maximum slice size specified.
1528 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1529 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1530 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1532 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1533 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1534 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1535 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1536 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1538 * \brief The frame has exceeded the maximum requested size.
1540 * This flag indicates that the encoded frame size exceeds the value
1541 * specified through a misc parameter buffer of type
1542 * #VAEncMiscParameterTypeMaxFrameSize.
1544 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1545 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1548 * \brief The coded buffer segment contains a single NAL unit.
1550 * This flag indicates that the coded buffer segment contains a
1551 * single NAL unit. This flag might be useful to the user for
1552 * processing the coded buffer.
1554 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1557 * \brief Coded buffer segment.
1559 * #VACodedBufferSegment is an element of a linked list describing
1560 * some information on the coded buffer. The coded buffer segment
1561 * could contain either a single NAL unit, or more than one NAL unit.
1562 * It is recommended (but not required) to return a single NAL unit
1563 * in a coded buffer segment, and the implementation should set the
1564 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1566 typedef struct _VACodedBufferSegment {
1568 * \brief Size of the data buffer in this segment (in bytes).
1571 /** \brief Bit offset into the data buffer where the video data starts. */
1572 unsigned int bit_offset;
1573 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1574 unsigned int status;
1575 /** \brief Reserved for future use. */
1576 unsigned int reserved;
1577 /** \brief Pointer to the start of the data buffer. */
1580 * \brief Pointer to the next #VACodedBufferSegment element,
1581 * or \c NULL if there is none.
1584 } VACodedBufferSegment;
1587 * Map data store of the buffer into the client's address space
1588 * vaCreateBuffer() needs to be called with "data" set to NULL before
1589 * calling vaMapBuffer()
1591 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1592 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1594 VAStatus vaMapBuffer (
1596 VABufferID buf_id, /* in */
1597 void **pbuf /* out */
1601 * After client making changes to a mapped data store, it needs to
1602 * "Unmap" it to let the server know that the data is ready to be
1603 * consumed by the server
1605 VAStatus vaUnmapBuffer (
1607 VABufferID buf_id /* in */
1611 * After this call, the buffer is deleted and this buffer_id is no longer valid
1612 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1614 VAStatus vaDestroyBuffer (
1616 VABufferID buffer_id
1620 Render (Decode) Pictures
1622 A picture represents either a frame or a field.
1624 The Begin/Render/End sequence sends the decode buffers to the server
1628 * Get ready to decode a picture to a target surface
1630 VAStatus vaBeginPicture (
1632 VAContextID context,
1633 VASurfaceID render_target
1637 * Send decode buffers to the server.
1638 * Buffers are automatically destroyed afterwards
1640 VAStatus vaRenderPicture (
1642 VAContextID context,
1643 VABufferID *buffers,
1648 * Make the end of rendering for a picture.
1649 * The server should start processing all pending operations for this
1650 * surface. This call is non-blocking. The client can start another
1651 * Begin/Render/End sequence on a different render target.
1653 VAStatus vaEndPicture (
1665 * This function blocks until all pending operations on the render target
1666 * have been completed. Upon return it is safe to use the render target for a
1667 * different picture.
1669 VAStatus vaSyncSurface (
1671 VASurfaceID render_target
1676 VASurfaceRendering = 1, /* Rendering in progress */
1677 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1678 /* this status is useful if surface is used as the source */
1680 VASurfaceReady = 4, /* not being rendered or displayed */
1681 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1685 * Find out any pending ops on the render target
1687 VAStatus vaQuerySurfaceStatus (
1689 VASurfaceID render_target,
1690 VASurfaceStatus *status /* out */
1695 VADecodeSliceMissing = 0,
1696 VADecodeMBError = 1,
1697 } VADecodeErrorType;
1700 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1701 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1703 typedef struct _VASurfaceDecodeMBErrors
1705 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1706 unsigned int start_mb; /* start mb address with errors */
1707 unsigned int end_mb; /* end mb address with errors */
1708 VADecodeErrorType decode_error_type;
1709 } VASurfaceDecodeMBErrors;
1712 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1713 * it can call vaQuerySurfaceError to find out further details on the particular error.
1714 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1715 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1716 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1717 * The array is terminated if "status==-1" is detected.
1719 VAStatus vaQuerySurfaceError(
1721 VASurfaceID surface,
1722 VAStatus error_status,
1727 * Images and Subpictures
1728 * VAImage is used to either get the surface data to client memory, or
1729 * to copy image data in client memory to a surface.
1730 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1731 * is at the upper left corner with positive X to the right and positive Y down
1733 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1734 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1735 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1737 /* a few common FourCCs */
1738 #define VA_FOURCC_NV12 0x3231564E
1739 #define VA_FOURCC_AI44 0x34344149
1740 #define VA_FOURCC_RGBA 0x41424752
1741 #define VA_FOURCC_BGRA 0x41524742
1742 #define VA_FOURCC_UYVY 0x59565955
1743 #define VA_FOURCC_YUY2 0x32595559
1744 #define VA_FOURCC_AYUV 0x56555941
1745 #define VA_FOURCC_NV11 0x3131564e
1746 #define VA_FOURCC_YV12 0x32315659
1747 #define VA_FOURCC_P208 0x38303250
1748 #define VA_FOURCC_IYUV 0x56555949
1751 #define VA_LSB_FIRST 1
1752 #define VA_MSB_FIRST 2
1754 typedef struct _VAImageFormat
1756 unsigned int fourcc;
1757 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1758 unsigned int bits_per_pixel;
1759 /* for RGB formats */
1760 unsigned int depth; /* significant bits per pixel */
1761 unsigned int red_mask;
1762 unsigned int green_mask;
1763 unsigned int blue_mask;
1764 unsigned int alpha_mask;
1767 typedef VAGenericID VAImageID;
1769 typedef struct _VAImage
1771 VAImageID image_id; /* uniquely identify this image */
1772 VAImageFormat format;
1773 VABufferID buf; /* image data buffer */
1775 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1776 * data store on the server side for optimal performance. The buffer will be
1777 * created by the CreateImage function, and proper storage allocated based on the image
1778 * size and format. This buffer is managed by the library implementation, and
1779 * accessed by the client through the buffer Map/Unmap functions.
1781 unsigned short width;
1782 unsigned short height;
1783 unsigned int data_size;
1784 unsigned int num_planes; /* can not be greater than 3 */
1786 * An array indicating the scanline pitch in bytes for each plane.
1787 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1789 unsigned int pitches[3];
1791 * An array indicating the byte offset from the beginning of the image data
1792 * to the start of each plane.
1794 unsigned int offsets[3];
1796 /* The following fields are only needed for paletted formats */
1797 int num_palette_entries; /* set to zero for non-palette images */
1799 * Each component is one byte and entry_bytes indicates the number of components in
1800 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1804 * An array of ascii characters describing the order of the components within the bytes.
1805 * Only entry_bytes characters of the string are used.
1807 char component_order[4];
1810 /* Get maximum number of image formats supported by the implementation */
1811 int vaMaxNumImageFormats (
1816 * Query supported image formats
1817 * The caller must provide a "format_list" array that can hold at
1818 * least vaMaxNumImageFormats() entries. The actual number of formats
1819 * returned in "format_list" is returned in "num_formats".
1821 VAStatus vaQueryImageFormats (
1823 VAImageFormat *format_list, /* out */
1824 int *num_formats /* out */
1828 * Create a VAImage structure
1829 * The width and height fields returned in the VAImage structure may get
1830 * enlarged for some YUV formats. Upon return from this function,
1831 * image->buf has been created and proper storage allocated by the library.
1832 * The client can access the image through the Map/Unmap calls.
1834 VAStatus vaCreateImage (
1836 VAImageFormat *format,
1839 VAImage *image /* out */
1843 * Should call DestroyImage before destroying the surface it is bound to
1845 VAStatus vaDestroyImage (
1850 VAStatus vaSetImagePalette (
1854 * pointer to an array holding the palette data. The size of the array is
1855 * num_palette_entries * entry_bytes in size. The order of the components
1856 * in the palette is described by the component_order in VAImage struct
1858 unsigned char *palette
1862 * Retrive surface data into a VAImage
1863 * Image must be in a format supported by the implementation
1865 VAStatus vaGetImage (
1867 VASurfaceID surface,
1868 int x, /* coordinates of the upper left source pixel */
1870 unsigned int width, /* width and height of the region */
1871 unsigned int height,
1876 * Copy data from a VAImage to a surface
1877 * Image must be in a format supported by the implementation
1878 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1879 * shouldn't be rendered into when this is called
1881 VAStatus vaPutImage (
1883 VASurfaceID surface,
1887 unsigned int src_width,
1888 unsigned int src_height,
1891 unsigned int dest_width,
1892 unsigned int dest_height
1896 * Derive an VAImage from an existing surface.
1897 * This interface will derive a VAImage and corresponding image buffer from
1898 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1899 * direct CPU access. This operation is only possible on implementations with
1900 * direct rendering capabilities and internal surface formats that can be
1901 * represented with a VAImage. When the operation is not possible this interface
1902 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1903 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1906 * Implementations should only return success when the resulting image buffer
1907 * would be useable with vaMap/Unmap.
1909 * When directly accessing a surface special care must be taken to insure
1910 * proper synchronization with the graphics hardware. Clients should call
1911 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1912 * rendering or currently being displayed by an overlay.
1914 * Additionally nothing about the contents of a surface should be assumed
1915 * following a vaPutSurface. Implementations are free to modify the surface for
1916 * scaling or subpicture blending within a call to vaPutImage.
1918 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1919 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1920 * vaGetImage with other surfaces is supported.
1922 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1923 * image and image buffer structures will be destroyed; however, the underlying
1924 * surface will remain unchanged until freed with vaDestroySurfaces.
1926 VAStatus vaDeriveImage (
1928 VASurfaceID surface,
1929 VAImage *image /* out */
1934 * Subpicture is a special type of image that can be blended
1935 * with a surface during vaPutSurface(). Subpicture can be used to render
1936 * DVD sub-titles or closed captioning text etc.
1939 typedef VAGenericID VASubpictureID;
1941 /* Get maximum number of subpicture formats supported by the implementation */
1942 int vaMaxNumSubpictureFormats (
1946 /* flags for subpictures */
1947 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
1948 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
1949 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
1951 * Query supported subpicture formats
1952 * The caller must provide a "format_list" array that can hold at
1953 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1954 * for each format to indicate additional capabilities for that format. The actual
1955 * number of formats returned in "format_list" is returned in "num_formats".
1956 * flags: returned value to indicate addtional capabilities
1957 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1958 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1959 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
1962 VAStatus vaQuerySubpictureFormats (
1964 VAImageFormat *format_list, /* out */
1965 unsigned int *flags, /* out */
1966 unsigned int *num_formats /* out */
1970 * Subpictures are created with an image associated.
1972 VAStatus vaCreateSubpicture (
1975 VASubpictureID *subpicture /* out */
1979 * Destroy the subpicture before destroying the image it is assocated to
1981 VAStatus vaDestroySubpicture (
1983 VASubpictureID subpicture
1987 * Bind an image to the subpicture. This image will now be associated with
1988 * the subpicture instead of the one at creation.
1990 VAStatus vaSetSubpictureImage (
1992 VASubpictureID subpicture,
1997 * If chromakey is enabled, then the area where the source value falls within
1998 * the chromakey [min, max] range is transparent
1999 * The chromakey component format is the following:
2000 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2001 * For YUV: [0:7] V [8:15] U [16:23] Y
2002 * The chromakey mask can be used to mask out certain components for chromakey
2005 VAStatus vaSetSubpictureChromakey (
2007 VASubpictureID subpicture,
2008 unsigned int chromakey_min,
2009 unsigned int chromakey_max,
2010 unsigned int chromakey_mask
2014 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2015 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2016 * the overall alpha is per-pixel alpha multiplied by the global alpha
2018 VAStatus vaSetSubpictureGlobalAlpha (
2020 VASubpictureID subpicture,
2025 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2026 * It defines the region mapping between the subpicture and the target
2027 * surfaces through source and destination rectangles (with the same width and height).
2028 * Both will be displayed at the next call to vaPutSurface. Additional
2029 * associations before the call to vaPutSurface simply overrides the association.
2031 VAStatus vaAssociateSubpicture (
2033 VASubpictureID subpicture,
2034 VASurfaceID *target_surfaces,
2036 short src_x, /* upper left offset in subpicture */
2038 unsigned short src_width,
2039 unsigned short src_height,
2040 short dest_x, /* upper left offset in surface */
2042 unsigned short dest_width,
2043 unsigned short dest_height,
2045 * whether to enable chroma-keying, global-alpha, or screen relative mode
2046 * see VA_SUBPICTURE_XXX values
2052 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2054 VAStatus vaDeassociateSubpicture (
2056 VASubpictureID subpicture,
2057 VASurfaceID *target_surfaces,
2061 typedef struct _VARectangle
2065 unsigned short width;
2066 unsigned short height;
2070 * Display attributes
2071 * Display attributes are used to control things such as contrast, hue, saturation,
2072 * brightness etc. in the rendering process. The application can query what
2073 * attributes are supported by the driver, and then set the appropriate attributes
2074 * before calling vaPutSurface()
2076 /* PowerVR IEP Lite attributes */
2079 VADISPLAYATTRIB_BLE_OFF = 0x00,
2080 VADISPLAYATTRIB_BLE_LOW,
2081 VADISPLAYATTRIB_BLE_MEDIUM,
2082 VADISPLAYATTRIB_BLE_HIGH,
2083 VADISPLAYATTRIB_BLE_NONE,
2084 } VADisplayAttribBLEMode;
2086 /* attribute value for VADisplayAttribRotation */
2087 #define VA_ROTATION_NONE 0x00000000
2088 #define VA_ROTATION_90 0x00000001
2089 #define VA_ROTATION_180 0x00000002
2090 #define VA_ROTATION_270 0x00000003
2092 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2093 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2094 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2097 #define VA_RENDER_MODE_UNDEFINED 0
2098 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2099 #define VA_RENDER_MODE_LOCAL_GPU 2
2100 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2101 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2104 #define VA_RENDER_DEVICE_UNDEFINED 0
2105 #define VA_RENDER_DEVICE_LOCAL 1
2106 #define VA_RENDER_DEVICE_EXTERNAL 2
2108 /* Currently defined display attribute types */
2111 VADisplayAttribBrightness = 0,
2112 VADisplayAttribContrast = 1,
2113 VADisplayAttribHue = 2,
2114 VADisplayAttribSaturation = 3,
2115 /* client can specifiy a background color for the target window
2116 * the new feature of video conference,
2117 * the uncovered area of the surface is filled by this color
2118 * also it will blend with the decoded video color
2120 VADisplayAttribBackgroundColor = 4,
2122 * this is a gettable only attribute. For some implementations that use the
2123 * hardware overlay, after PutSurface is called, the surface can not be
2124 * re-used until after the subsequent PutSurface call. If this is the case
2125 * then the value for this attribute will be set to 1 so that the client
2126 * will not attempt to re-use the surface right after returning from a call
2129 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2130 * driver may use overlay or GPU alternatively
2132 VADisplayAttribDirectSurface = 5,
2133 VADisplayAttribRotation = 6,
2134 VADisplayAttribOutofLoopDeblock = 7,
2136 /* PowerVR IEP Lite specific attributes */
2137 VADisplayAttribBLEBlackMode = 8,
2138 VADisplayAttribBLEWhiteMode = 9,
2139 VADisplayAttribBlueStretch = 10,
2140 VADisplayAttribSkinColorCorrection = 11,
2142 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2143 * conversion matrix. Each element in the matrix is float-point
2145 VADisplayAttribCSCMatrix = 12,
2146 /* specify the constant color used to blend with video surface
2147 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2148 * d: the final color to overwrite into the frame buffer
2149 * v: decoded video after color conversion,
2150 * c: video color specified by VADisplayAttribBlendColor
2151 * b: background color of the drawable
2153 VADisplayAttribBlendColor = 13,
2155 * Indicate driver to skip painting color key or not.
2156 * only applicable if the render is overlay
2158 VADisplayAttribOverlayAutoPaintColorKey = 14,
2160 * customized overlay color key, the format is RGB888
2161 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2163 VADisplayAttribOverlayColorKey = 15,
2165 * The hint for the implementation of vaPutSurface
2166 * normally, the driver could use an overlay or GPU to render the surface on the screen
2167 * this flag provides APP the flexibity to switch the render dynamically
2169 VADisplayAttribRenderMode = 16,
2171 * specify if vaPutSurface needs to render into specified monitors
2172 * one example is that one external monitor (e.g. HDMI) is enabled,
2173 * but the window manager is not aware of it, and there is no associated drawable
2175 VADisplayAttribRenderDevice = 17,
2177 * specify vaPutSurface render area if there is no drawable on the monitor
2179 VADisplayAttribRenderRect = 18,
2180 } VADisplayAttribType;
2182 /* flags for VADisplayAttribute */
2183 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2184 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2185 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2187 typedef struct _VADisplayAttribute
2189 VADisplayAttribType type;
2192 int value; /* used by the set/get attribute functions */
2193 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2195 } VADisplayAttribute;
2197 /* Get maximum number of display attributs supported by the implementation */
2198 int vaMaxNumDisplayAttributes (
2203 * Query display attributes
2204 * The caller must provide a "attr_list" array that can hold at
2205 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2206 * returned in "attr_list" is returned in "num_attributes".
2208 VAStatus vaQueryDisplayAttributes (
2210 VADisplayAttribute *attr_list, /* out */
2211 int *num_attributes /* out */
2215 * Get display attributes
2216 * This function returns the current attribute values in "attr_list".
2217 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2218 * from vaQueryDisplayAttributes() can have their values retrieved.
2220 VAStatus vaGetDisplayAttributes (
2222 VADisplayAttribute *attr_list, /* in/out */
2227 * Set display attributes
2228 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2229 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2230 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2232 VAStatus vaSetDisplayAttributes (
2234 VADisplayAttribute *attr_list,