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 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
147 /* De-interlacing flags for vaPutSurface() */
148 #define VA_FRAME_PICTURE 0x00000000
149 #define VA_TOP_FIELD 0x00000001
150 #define VA_BOTTOM_FIELD 0x00000002
153 * Enabled the positioning/cropping/blending feature:
154 * 1, specify the video playback position in the isurface
155 * 2, specify the cropping info for video playback
156 * 3, encoded video will blend with background color
158 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
161 * Clears the drawable with background color.
162 * for hardware overlay based implementation this flag
163 * can be used to turn off the overlay
165 #define VA_CLEAR_DRAWABLE 0x00000008
167 /* Color space conversion flags for vaPutSurface() */
168 #define VA_SRC_BT601 0x00000010
169 #define VA_SRC_BT709 0x00000020
170 #define VA_SRC_SMPTE_240 0x00000040
172 /* Scaling flags for vaPutSurface() */
173 #define VA_FILTER_SCALING_DEFAULT 0x00000000
174 #define VA_FILTER_SCALING_FAST 0x00000100
175 #define VA_FILTER_SCALING_HQ 0x00000200
176 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
177 #define VA_FILTER_SCALING_MASK 0x00000f00
180 * Returns a short english description of error_status
182 const char *vaErrorStr(VAStatus error_status);
186 * A display must be obtained by calling vaGetDisplay() before calling
187 * vaInitialize() and other functions. This connects the API to the
188 * native window system.
189 * For X Windows, native_dpy would be from XOpenDisplay()
191 typedef void* VANativeDisplay; /* window system dependent */
193 int vaDisplayIsValid(VADisplay dpy);
196 * Initialize the library
198 VAStatus vaInitialize (
200 int *major_version, /* out */
201 int *minor_version /* out */
205 * After this call, all library internal resources will be cleaned up
207 VAStatus vaTerminate (
212 * vaQueryVendorString returns a pointer to a zero-terminated string
213 * describing some aspects of the VA implemenation on a specific
214 * hardware accelerator. The format of the returned string is vendor
215 * specific and at the discretion of the implementer.
216 * e.g. for the Intel GMA500 implementation, an example would be:
217 * "Intel GMA500 - 2.0.0.32L.0005"
219 const char *vaQueryVendorString (
223 typedef int (*VAPrivFunc)();
226 * Return a function pointer given a function name in the library.
227 * This allows private interfaces into the library
229 VAPrivFunc vaGetLibFunc (
234 /* Currently defined profiles */
237 VAProfileMPEG2Simple = 0,
238 VAProfileMPEG2Main = 1,
239 VAProfileMPEG4Simple = 2,
240 VAProfileMPEG4AdvancedSimple = 3,
241 VAProfileMPEG4Main = 4,
242 VAProfileH264Baseline = 5,
243 VAProfileH264Main = 6,
244 VAProfileH264High = 7,
245 VAProfileVC1Simple = 8,
246 VAProfileVC1Main = 9,
247 VAProfileVC1Advanced = 10,
248 VAProfileH263Baseline = 11,
249 VAProfileJPEGBaseline = 12,
250 VAProfileH264ConstrainedBaseline = 13
254 * Currently defined entrypoints
260 VAEntrypointIDCT = 3,
261 VAEntrypointMoComp = 4,
262 VAEntrypointDeblocking = 5,
263 VAEntrypointEncSlice = 6, /* slice level encode */
264 VAEntrypointEncPicture = 7 /* pictuer encode, JPEG, etc */
267 /* Currently defined configuration attribute types */
270 VAConfigAttribRTFormat = 0,
271 VAConfigAttribSpatialResidual = 1,
272 VAConfigAttribSpatialClipping = 2,
273 VAConfigAttribIntraResidual = 3,
274 VAConfigAttribEncryption = 4,
275 VAConfigAttribRateControl = 5,
277 /** @name Attributes for encoding */
280 * \brief Packed headers mode. Read/write.
282 * This attribute determines what packed headers the driver supports,
283 * through vaGetConfigAttributes(); and what packed headers the user
284 * will be providing to the driver, through vaCreateConfig(), if the
285 * driver supports those.
287 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
289 VAConfigAttribEncPackedHeaders = 10,
291 * \brief Interlaced mode. Read/write.
293 * This attribute determines what kind of interlaced encoding mode
294 * the driver supports.
296 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
298 VAConfigAttribEncInterlaced = 11,
300 * \brief Maximum number of reference frames. Read-only.
302 * This attribute determines the maximum number of reference
303 * frames supported for encoding.
305 * Note: for H.264 encoding, the value represents the maximum number
306 * of reference frames for both the reference picture list 0 (bottom
307 * 16 bits) and the reference picture list 1 (top 16 bits).
309 VAConfigAttribEncMaxRefFrames = 13,
311 * \brief Maximum number of slices per frame. Read-only.
313 * This attribute determines the maximum number of slices the
314 * driver can support to encode a single frame.
316 VAConfigAttribEncMaxSlices = 14,
318 * \brief Slice structure. Read-only.
320 * This attribute determines slice structures supported by the
321 * driver for encoding. This attribute is a hint to the user so
322 * that he can choose a suitable surface size and how to arrange
323 * the encoding process of multiple slices per frame.
325 * More specifically, for H.264 encoding, this attribute
326 * determines the range of accepted values to
327 * VAEncSliceParameterBufferH264::macroblock_address and
328 * VAEncSliceParameterBufferH264::num_macroblocks.
330 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
333 VAConfigAttribEncSliceStructure = 15,
335 * \brief Macroblock information. Read-only.
337 * This attribute determines whether the driver supports extra
338 * encoding information per-macroblock. e.g. QP.
340 * More specifically, for H.264 encoding, if the driver returns a non-zero
341 * value for this attribute, this means the application can create
342 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
343 * through VAEncSliceParameterBufferH264::macroblock_info.
345 VAConfigAttribEncMacroblockInfo = 16,
347 } VAConfigAttribType;
350 * Configuration attributes
351 * If there is more than one value for an attribute, a default
352 * value will be assigned to the attribute if the client does not
353 * specify the attribute when creating a configuration
355 typedef struct _VAConfigAttrib {
356 VAConfigAttribType type;
357 unsigned int value; /* OR'd flags (bits) for this attribute */
360 /* attribute value for VAConfigAttribRTFormat */
361 #define VA_RT_FORMAT_YUV420 0x00000001
362 #define VA_RT_FORMAT_YUV422 0x00000002
363 #define VA_RT_FORMAT_YUV444 0x00000004
364 #define VA_RT_FORMAT_PROTECTED 0x80000000
366 /** @name Attribute values for VAConfigAttribRateControl */
368 /** \brief Driver does not support any form of rate control. */
369 #define VA_RC_NONE 0x00000001
370 /** \brief Constant bitrate. */
371 #define VA_RC_CBR 0x00000002
372 /** \brief Variable bitrate. */
373 #define VA_RC_VBR 0x00000004
374 /** \brief Video conference mode. */
375 #define VA_RC_VCM 0x00000008
376 /** \brief Constant QP. */
377 #define VA_RC_CQP 0x00000010
380 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
382 /** \brief Driver does not support any packed headers mode. */
383 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
384 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
385 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
386 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
387 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
388 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
389 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
390 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
391 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
394 /** @name Attribute values for VAConfigAttribEncInterlaced */
396 /** \brief Driver does not support interlaced coding. */
397 #define VA_ENC_INTERLACED_NONE 0x00000000
398 /** \brief Driver supports interlaced frame coding. */
399 #define VA_ENC_INTERLACED_FRAME 0x00000001
400 /** \brief Driver supports interlaced field coding. */
401 #define VA_ENC_INTERLACED_FIELD 0x00000002
402 /** \brief Driver supports macroblock adaptive frame field coding. */
403 #define VA_ENC_INTERLACED_MBAFF 0x00000004
404 /** \brief Driver supports picture adaptive frame field coding. */
405 #define VA_ENC_INTERLACED_PAFF 0x00000008
408 /** @name Attribute values for VAConfigAttribEncSliceStructure */
410 /** \brief Driver supports an arbitrary number of rows per slice. */
411 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
412 /** \brief Driver supports a power-of-two number of rows per slice. */
413 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
414 /** \brief Driver supports an arbitrary number of rows per slice. */
415 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
419 * if an attribute is not applicable for a given
420 * profile/entrypoint pair, then set the value to the following
422 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
424 /* Get maximum number of profiles supported by the implementation */
425 int vaMaxNumProfiles (
429 /* Get maximum number of entrypoints supported by the implementation */
430 int vaMaxNumEntrypoints (
434 /* Get maximum number of attributs supported by the implementation */
435 int vaMaxNumConfigAttributes (
440 * Query supported profiles
441 * The caller must provide a "profile_list" array that can hold at
442 * least vaMaxNumProfile() entries. The actual number of profiles
443 * returned in "profile_list" is returned in "num_profile".
445 VAStatus vaQueryConfigProfiles (
447 VAProfile *profile_list, /* out */
448 int *num_profiles /* out */
452 * Query supported entrypoints for a given profile
453 * The caller must provide an "entrypoint_list" array that can hold at
454 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
455 * returned in "entrypoint_list" is returned in "num_entrypoints".
457 VAStatus vaQueryConfigEntrypoints (
460 VAEntrypoint *entrypoint_list, /* out */
461 int *num_entrypoints /* out */
465 * Get attributes for a given profile/entrypoint pair
466 * The caller must provide an "attrib_list" with all attributes to be
467 * retrieved. Upon return, the attributes in "attrib_list" have been
468 * updated with their value. Unknown attributes or attributes that are
469 * not supported for the given profile/entrypoint pair will have their
470 * value set to VA_ATTRIB_NOT_SUPPORTED
472 VAStatus vaGetConfigAttributes (
475 VAEntrypoint entrypoint,
476 VAConfigAttrib *attrib_list, /* in/out */
480 /* Generic ID type, can be re-typed for specific implementation */
481 typedef unsigned int VAGenericID;
483 typedef VAGenericID VAConfigID;
486 * Create a configuration for the decode pipeline
487 * it passes in the attribute list that specifies the attributes it cares
488 * about, with the rest taking default values.
490 VAStatus vaCreateConfig (
493 VAEntrypoint entrypoint,
494 VAConfigAttrib *attrib_list,
496 VAConfigID *config_id /* out */
500 * Free resources associdated with a given config
502 VAStatus vaDestroyConfig (
508 * Query all attributes for a given configuration
509 * The profile of the configuration is returned in "profile"
510 * The entrypoint of the configuration is returned in "entrypoint"
511 * The caller must provide an "attrib_list" array that can hold at least
512 * vaMaxNumConfigAttributes() entries. The actual number of attributes
513 * returned in "attrib_list" is returned in "num_attribs"
515 VAStatus vaQueryConfigAttributes (
517 VAConfigID config_id,
518 VAProfile *profile, /* out */
519 VAEntrypoint *entrypoint, /* out */
520 VAConfigAttrib *attrib_list,/* out */
521 int *num_attribs /* out */
526 * Contexts and Surfaces
528 * Context represents a "virtual" video decode pipeline. Surfaces are render
529 * targets for a given context. The data in the surfaces are not accessible
530 * to the client and the internal data format of the surface is implementatin
533 * Surfaces will be bound to a context when the context is created. Once
534 * a surface is bound to a given context, it can not be used to create
535 * another context. The association is removed when the context is destroyed
537 * Both contexts and surfaces are identified by unique IDs and its
538 * implementation specific internals are kept opaque to the clients
541 typedef VAGenericID VAContextID;
543 typedef VAGenericID VASurfaceID;
545 #define VA_INVALID_ID 0xffffffff
546 #define VA_INVALID_SURFACE VA_INVALID_ID
548 /** \brief Generic value types. */
550 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
551 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
552 VAGenericValueTypePointer, /**< Generic pointer type */
553 VAGenericValueTypeFunc /**< Pointer to function */
554 } VAGenericValueType;
556 /** \brief Generic function type. */
557 typedef void (*VAGenericFunc)(void);
559 /** \brief Generic value. */
560 typedef struct _VAGenericValue {
561 /** \brief Value type. See #VAGenericValueType. */
562 VAGenericValueType type;
563 /** \brief Value holder. */
565 /** \brief 32-bit signed integer. */
567 /** \brief 32-bit float. */
569 /** \brief Generic pointer. */
571 /** \brief Pointer to function. */
577 * vaCreateSurfaces - Create an array of surfaces used for decode and display
579 * width: surface width
580 * height: surface height
581 * format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
582 * num_surfaces: number of surfaces to be created
583 * surfaces: array of surfaces created upon return
585 VAStatus vaCreateSurfaces (
591 VASurfaceID *surfaces /* out */
596 * vaDestroySurfaces - Destroy resources associated with surfaces.
597 * Surfaces can only be destroyed after the context associated has been
600 * surfaces: array of surfaces to destroy
601 * num_surfaces: number of surfaces in the array to be destroyed.
603 VAStatus vaDestroySurfaces (
605 VASurfaceID *surfaces,
609 #define VA_PROGRESSIVE 0x1
611 * vaCreateContext - Create a context
613 * config_id: configuration for the context
614 * picture_width: coded picture width
615 * picture_height: coded picture height
616 * flag: any combination of the following:
617 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
618 * render_targets: render targets (surfaces) tied to the context
619 * num_render_targets: number of render targets in the above array
620 * context: created context id upon return
622 VAStatus vaCreateContext (
624 VAConfigID config_id,
628 VASurfaceID *render_targets,
629 int num_render_targets,
630 VAContextID *context /* out */
634 * vaDestroyContext - Destroy a context
636 * context: context to be destroyed
638 VAStatus vaDestroyContext (
645 * Buffers are used to pass various types of data from the
646 * client to the server. The server maintains a data store
647 * for each buffer created, and the client idenfies a buffer
648 * through a unique buffer id assigned by the server.
651 typedef VAGenericID VABufferID;
655 VAPictureParameterBufferType = 0,
656 VAIQMatrixBufferType = 1,
657 VABitPlaneBufferType = 2,
658 VASliceGroupMapBufferType = 3,
659 VASliceParameterBufferType = 4,
660 VASliceDataBufferType = 5,
661 VAMacroblockParameterBufferType = 6,
662 VAResidualDataBufferType = 7,
663 VADeblockingParameterBufferType = 8,
664 VAImageBufferType = 9,
665 VAProtectedSliceDataBufferType = 10,
666 VAQMatrixBufferType = 11,
667 VAHuffmanTableBufferType = 12,
669 /* Following are encode buffer types */
670 VAEncCodedBufferType = 21,
671 VAEncSequenceParameterBufferType = 22,
672 VAEncPictureParameterBufferType = 23,
673 VAEncSliceParameterBufferType = 24,
674 VAEncPackedHeaderParameterBufferType = 25,
675 VAEncPackedHeaderDataBufferType = 26,
676 VAEncMiscParameterBufferType = 27,
677 VAEncMacroblockParameterBufferType = 28,
678 VABufferTypeMax = 0xff
683 VAEncMiscParameterTypeFrameRate = 0,
684 VAEncMiscParameterTypeRateControl = 1,
685 VAEncMiscParameterTypeMaxSliceSize = 2,
686 VAEncMiscParameterTypeAIR = 3,
687 /** \brief Buffer type used to express a maximum frame size (in bits). */
688 VAEncMiscParameterTypeMaxFrameSize = 4,
689 } VAEncMiscParameterType;
691 /** \brief Packed header type. */
693 /** \brief Packed sequence header. */
694 VAEncPackedHeaderSequence = 1,
695 /** \brief Packed picture header. */
696 VAEncPackedHeaderPicture = 2,
697 /** \brief Packed slice header. */
698 VAEncPackedHeaderSlice = 3,
699 /** \brief Misc packed header. See codec-specific definitions. */
700 VAEncPackedHeaderMiscMask = 0x80000000,
701 } VAEncPackedHeaderType;
703 /** \brief Packed header parameter. */
704 typedef struct _VAEncPackedHeaderParameterBuffer {
705 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
707 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
708 unsigned int bit_length;
709 /** \brief Flag: buffer contains start code emulation prevention bytes? */
710 unsigned char has_emulation_bytes;
711 } VAEncPackedHeaderParameterBuffer;
714 * For application, e.g. set a new bitrate
716 * VAEncMiscParameterBuffer *misc_param;
717 * VAEncMiscParameterRateControl *misc_rate_ctrl;
719 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
720 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
723 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
724 * misc_param->type = VAEncMiscParameterTypeRateControl;
725 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
726 * misc_rate_ctrl->bits_per_second = 6400000;
727 * vaUnmapBuffer(dpy, buf_id);
728 * vaRenderPicture(dpy, context, &buf_id, 1);
730 typedef struct _VAEncMiscParameterBuffer
732 VAEncMiscParameterType type;
733 unsigned int data[0];
734 } VAEncMiscParameterBuffer;
736 typedef struct _VAEncMiscParameterRateControl
738 unsigned int bits_per_second; /* this is the maximum bit-rate to be constrained by the rate control implementation */
739 unsigned int target_percentage; /* this is the bit-rate the rate control is targeting, as a percentage of the maximum bit-rate */
740 /* for example if target_percentage is 95 then the rate control will target a bit-rate that is */
741 /* 95% of the maximum bit-rate */
742 unsigned int window_size; /* windows size in milliseconds. For example if this is set to 500, then the rate control will guarantee the */
743 /* target bit-rate over a 500 ms window */
744 unsigned int initial_qp; /* initial QP at I frames */
746 } VAEncMiscParameterRateControl;
748 typedef struct _VAEncMiscParameterFrameRate
750 unsigned int framerate;
751 } VAEncMiscParameterFrameRate;
754 * Allow a maximum slice size to be specified (in bits).
755 * The encoder will attempt to make sure that individual slices do not exceed this size
756 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
758 typedef struct _VAEncMiscParameterMaxSliceSize
760 unsigned int max_slice_size;
761 } VAEncMiscParameterMaxSliceSize;
763 typedef struct _VAEncMiscParameterAIR
765 unsigned int air_num_mbs;
766 unsigned int air_threshold;
767 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
768 } VAEncMiscParameterAIR;
771 * \brief Defines a maximum frame size (in bits).
773 * This misc parameter buffer defines the maximum size of a frame (in
774 * bits). The encoder will try to make sure that each frame does not
775 * exceed this size. Otherwise, if the frame size exceeds this size,
776 * the \c status flag of #VACodedBufferSegment will contain
777 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
779 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
780 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
781 VAEncMiscParameterType type;
782 /** \brief Maximum size of a frame (in bits). */
783 unsigned int max_frame_size;
784 } VAEncMiscParameterBufferMaxFrameSize;
787 * There will be cases where the bitstream buffer will not have enough room to hold
788 * the data for the entire slice, and the following flags will be used in the slice
789 * parameter to signal to the server for the possible cases.
790 * If a slice parameter buffer and slice data buffer pair is sent to the server with
791 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
792 * then a slice parameter and data buffer needs to be sent again to complete this slice.
794 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
795 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
796 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
797 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
799 /* Codec-independent Slice Parameter Buffer base */
800 typedef struct _VASliceParameterBufferBase
802 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
803 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
804 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
805 } VASliceParameterBufferBase;
808 /****************************
809 * JEPG data structure
810 ***************************/
811 typedef struct _VAQMatrixBufferJPEG
813 int load_lum_quantiser_matrix;
814 int load_chroma_quantiser_matrix;
815 unsigned char lum_quantiser_matrix[64];
816 unsigned char chroma_quantiser_matrix[64];
817 } VAQMatrixBufferJPEG;
819 typedef struct _VAEncPictureParameterBufferJPEG
821 VASurfaceID reconstructed_picture;
822 unsigned short picture_width;
823 unsigned short picture_height;
824 VABufferID coded_buf;
825 } VAEncPictureParameterBufferJPEG;
827 #include <va/va_dec_jpeg.h>
829 /****************************
830 * MPEG-2 data structures
831 ****************************/
833 /* MPEG-2 Picture Parameter Buffer */
835 * For each frame or field, and before any slice data, a single
836 * picture parameter buffer must be send.
838 typedef struct _VAPictureParameterBufferMPEG2
840 unsigned short horizontal_size;
841 unsigned short vertical_size;
842 VASurfaceID forward_reference_picture;
843 VASurfaceID backward_reference_picture;
844 /* meanings of the following fields are the same as in the standard */
845 int picture_coding_type;
846 int f_code; /* pack all four fcode into this */
849 unsigned int intra_dc_precision : 2;
850 unsigned int picture_structure : 2;
851 unsigned int top_field_first : 1;
852 unsigned int frame_pred_frame_dct : 1;
853 unsigned int concealment_motion_vectors : 1;
854 unsigned int q_scale_type : 1;
855 unsigned int intra_vlc_format : 1;
856 unsigned int alternate_scan : 1;
857 unsigned int repeat_first_field : 1;
858 unsigned int progressive_frame : 1;
859 unsigned int is_first_field : 1; /* indicate whether the current field
860 * is the first field for field picture
864 } picture_coding_extension;
865 } VAPictureParameterBufferMPEG2;
867 /* MPEG-2 Inverse Quantization Matrix Buffer */
868 typedef struct _VAIQMatrixBufferMPEG2
870 int load_intra_quantiser_matrix;
871 int load_non_intra_quantiser_matrix;
872 int load_chroma_intra_quantiser_matrix;
873 int load_chroma_non_intra_quantiser_matrix;
874 unsigned char intra_quantiser_matrix[64];
875 unsigned char non_intra_quantiser_matrix[64];
876 unsigned char chroma_intra_quantiser_matrix[64];
877 unsigned char chroma_non_intra_quantiser_matrix[64];
878 } VAIQMatrixBufferMPEG2;
880 /* MPEG-2 Slice Parameter Buffer */
881 typedef struct _VASliceParameterBufferMPEG2
883 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
884 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
885 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
886 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
887 unsigned int slice_horizontal_position;
888 unsigned int slice_vertical_position;
889 int quantiser_scale_code;
890 int intra_slice_flag;
891 } VASliceParameterBufferMPEG2;
893 /* MPEG-2 Macroblock Parameter Buffer */
894 typedef struct _VAMacroblockParameterBufferMPEG2
896 unsigned short macroblock_address;
898 * macroblock_address (in raster scan order)
900 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
902 unsigned char macroblock_type; /* see definition below */
905 unsigned int frame_motion_type : 2;
906 unsigned int field_motion_type : 2;
907 unsigned int dct_type : 1;
911 unsigned char motion_vertical_field_select;
913 * motion_vertical_field_select:
914 * see section 6.3.17.2 in the spec
915 * only the lower 4 bits are used
916 * bit 0: first vector forward
917 * bit 1: first vector backward
918 * bit 2: second vector forward
919 * bit 3: second vector backward
921 short PMV[2][2][2]; /* see Table 7-7 in the spec */
922 unsigned short coded_block_pattern;
924 * The bitplanes for coded_block_pattern are described
925 * in Figure 6.10-12 in the spec
928 /* Number of skipped macroblocks after this macroblock */
929 unsigned short num_skipped_macroblocks;
930 } VAMacroblockParameterBufferMPEG2;
933 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
935 #define VA_MB_TYPE_MOTION_FORWARD 0x02
936 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
937 #define VA_MB_TYPE_MOTION_PATTERN 0x08
938 #define VA_MB_TYPE_MOTION_INTRA 0x10
941 * MPEG-2 Residual Data Buffer
942 * For each macroblock, there wil be 64 shorts (16-bit) in the
943 * residual data buffer
946 /****************************
947 * MPEG-4 Part 2 data structures
948 ****************************/
950 /* MPEG-4 Picture Parameter Buffer */
952 * For each frame or field, and before any slice data, a single
953 * picture parameter buffer must be send.
955 typedef struct _VAPictureParameterBufferMPEG4
957 unsigned short vop_width;
958 unsigned short vop_height;
959 VASurfaceID forward_reference_picture;
960 VASurfaceID backward_reference_picture;
963 unsigned int short_video_header : 1;
964 unsigned int chroma_format : 2;
965 unsigned int interlaced : 1;
966 unsigned int obmc_disable : 1;
967 unsigned int sprite_enable : 2;
968 unsigned int sprite_warping_accuracy : 2;
969 unsigned int quant_type : 1;
970 unsigned int quarter_sample : 1;
971 unsigned int data_partitioned : 1;
972 unsigned int reversible_vlc : 1;
973 unsigned int resync_marker_disable : 1;
977 unsigned char no_of_sprite_warping_points;
978 short sprite_trajectory_du[3];
979 short sprite_trajectory_dv[3];
980 unsigned char quant_precision;
983 unsigned int vop_coding_type : 2;
984 unsigned int backward_reference_vop_coding_type : 2;
985 unsigned int vop_rounding_type : 1;
986 unsigned int intra_dc_vlc_thr : 3;
987 unsigned int top_field_first : 1;
988 unsigned int alternate_vertical_scan_flag : 1;
992 unsigned char vop_fcode_forward;
993 unsigned char vop_fcode_backward;
994 unsigned short vop_time_increment_resolution;
995 /* short header related */
996 unsigned char num_gobs_in_vop;
997 unsigned char num_macroblocks_in_gob;
998 /* for direct mode prediction */
1001 } VAPictureParameterBufferMPEG4;
1003 /* MPEG-4 Inverse Quantization Matrix Buffer */
1004 typedef struct _VAIQMatrixBufferMPEG4
1006 int load_intra_quant_mat;
1007 int load_non_intra_quant_mat;
1008 unsigned char intra_quant_mat[64];
1009 unsigned char non_intra_quant_mat[64];
1010 } VAIQMatrixBufferMPEG4;
1012 /* MPEG-4 Slice Parameter Buffer */
1013 typedef struct _VASliceParameterBufferMPEG4
1015 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1016 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1017 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1018 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1019 unsigned int macroblock_number;
1021 } VASliceParameterBufferMPEG4;
1024 VC-1 data structures
1027 typedef enum /* see 7.1.1.32 */
1030 VAMvMode1MvHalfPel = 1,
1031 VAMvMode1MvHalfPelBilinear = 2,
1032 VAMvModeMixedMv = 3,
1033 VAMvModeIntensityCompensation = 4
1036 /* VC-1 Picture Parameter Buffer */
1038 * For each picture, and before any slice data, a picture parameter
1039 * buffer must be send. Multiple picture parameter buffers may be
1040 * sent for a single picture. In that case picture parameters will
1041 * apply to all slice data that follow it until a new picture
1042 * parameter buffer is sent.
1045 * pic_quantizer_type should be set to the applicable quantizer
1046 * type as defined by QUANTIZER (J.1.19) and either
1047 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1049 typedef struct _VAPictureParameterBufferVC1
1051 VASurfaceID forward_reference_picture;
1052 VASurfaceID backward_reference_picture;
1053 /* if out-of-loop post-processing is done on the render
1054 target, then we need to keep the in-loop decoded
1055 picture as a reference picture */
1056 VASurfaceID inloop_decoded_picture;
1058 /* sequence layer for AP or meta data for SP and MP */
1061 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1062 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1063 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1064 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1065 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1066 unsigned int multires : 1; /* METADATA::MULTIRES */
1067 unsigned int overlap : 1; /* METADATA::OVERLAP */
1068 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1069 unsigned int rangered : 1; /* METADATA::RANGERED */
1070 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1071 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1076 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1077 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1080 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1081 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1082 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1083 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1086 } entrypoint_fields;
1087 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1088 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1091 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1092 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1093 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1094 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1097 } range_mapping_fields;
1099 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1100 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1101 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1102 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1103 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1104 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1105 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1106 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1107 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1110 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1111 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1112 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1113 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1114 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1120 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1121 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1122 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1123 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1124 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1125 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1126 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1132 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1133 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1134 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1135 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1136 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1137 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1138 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1141 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1144 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1145 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1146 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1147 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1153 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1154 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1155 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1156 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1157 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1158 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1159 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1160 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1161 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1162 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1168 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1169 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1170 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1171 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1172 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1173 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1174 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1175 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1176 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1177 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1178 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1181 } pic_quantizer_fields;
1184 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1185 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1186 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1187 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1188 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1189 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1193 } VAPictureParameterBufferVC1;
1195 /* VC-1 Bitplane Buffer
1196 There will be at most three bitplanes coded in any picture header. To send
1197 the bitplane data more efficiently, each byte is divided in two nibbles, with
1198 each nibble carrying three bitplanes for one macroblock. The following table
1199 shows the bitplane data arrangement within each nibble based on the picture
1202 Picture Type Bit3 Bit2 Bit1 Bit0
1203 I or BI OVERFLAGS ACPRED FIELDTX
1204 P MYTYPEMB SKIPMB DIRECTMB
1205 B FORWARDMB SKIPMB DIRECTMB
1207 Within each byte, the lower nibble is for the first MB and the upper nibble is
1208 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1209 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1210 Macroblock #2 in the first row.
1213 /* VC-1 Slice Parameter Buffer */
1214 typedef struct _VASliceParameterBufferVC1
1216 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1217 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1218 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1219 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1220 unsigned int slice_vertical_position;
1221 } VASliceParameterBufferVC1;
1223 /* VC-1 Slice Data Buffer */
1225 This is simplely a buffer containing raw bit-stream bytes
1228 /****************************
1229 * H.264/AVC data structures
1230 ****************************/
1232 typedef struct _VAPictureH264
1234 VASurfaceID picture_id;
1235 unsigned int frame_idx;
1237 signed int TopFieldOrderCnt;
1238 signed int BottomFieldOrderCnt;
1240 /* flags in VAPictureH264 could be OR of the following */
1241 #define VA_PICTURE_H264_INVALID 0x00000001
1242 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1243 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1244 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1245 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1247 /* H.264 Picture Parameter Buffer */
1249 * For each picture, and before any slice data, a single
1250 * picture parameter buffer must be send.
1252 typedef struct _VAPictureParameterBufferH264
1254 VAPictureH264 CurrPic;
1255 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1256 unsigned short picture_width_in_mbs_minus1;
1257 unsigned short picture_height_in_mbs_minus1;
1258 unsigned char bit_depth_luma_minus8;
1259 unsigned char bit_depth_chroma_minus8;
1260 unsigned char num_ref_frames;
1263 unsigned int chroma_format_idc : 2;
1264 unsigned int residual_colour_transform_flag : 1;
1265 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1266 unsigned int frame_mbs_only_flag : 1;
1267 unsigned int mb_adaptive_frame_field_flag : 1;
1268 unsigned int direct_8x8_inference_flag : 1;
1269 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1270 unsigned int log2_max_frame_num_minus4 : 4;
1271 unsigned int pic_order_cnt_type : 2;
1272 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1273 unsigned int delta_pic_order_always_zero_flag : 1;
1277 unsigned char num_slice_groups_minus1;
1278 unsigned char slice_group_map_type;
1279 unsigned short slice_group_change_rate_minus1;
1280 signed char pic_init_qp_minus26;
1281 signed char pic_init_qs_minus26;
1282 signed char chroma_qp_index_offset;
1283 signed char second_chroma_qp_index_offset;
1286 unsigned int entropy_coding_mode_flag : 1;
1287 unsigned int weighted_pred_flag : 1;
1288 unsigned int weighted_bipred_idc : 2;
1289 unsigned int transform_8x8_mode_flag : 1;
1290 unsigned int field_pic_flag : 1;
1291 unsigned int constrained_intra_pred_flag : 1;
1292 unsigned int pic_order_present_flag : 1;
1293 unsigned int deblocking_filter_control_present_flag : 1;
1294 unsigned int redundant_pic_cnt_present_flag : 1;
1295 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1299 unsigned short frame_num;
1300 } VAPictureParameterBufferH264;
1302 /* H.264 Inverse Quantization Matrix Buffer */
1303 typedef struct _VAIQMatrixBufferH264
1305 unsigned char ScalingList4x4[6][16];
1306 unsigned char ScalingList8x8[2][64];
1307 } VAIQMatrixBufferH264;
1310 * H.264 Slice Group Map Buffer
1311 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1312 * A slice group map buffer should be sent for each picture if required. The buffer
1313 * is sent only when there is a change in the mapping values.
1314 * The slice group map buffer map "map units" to slice groups as specified in
1315 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1316 * in raster scan order
1319 /* H.264 Slice Parameter Buffer */
1320 typedef struct _VASliceParameterBufferH264
1322 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1323 /** \brief Byte offset to the NAL Header Unit for this slice. */
1324 unsigned int slice_data_offset;
1325 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1327 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1329 * This bit offset is relative to and includes the NAL unit byte
1330 * and represents the number of bits parsed in the slice_header()
1331 * after the removal of any emulation prevention bytes in
1332 * there. However, the slice data buffer passed to the hardware is
1333 * the original bitstream, thus including any emulation prevention
1336 unsigned short slice_data_bit_offset;
1337 unsigned short first_mb_in_slice;
1338 unsigned char slice_type;
1339 unsigned char direct_spatial_mv_pred_flag;
1340 unsigned char num_ref_idx_l0_active_minus1;
1341 unsigned char num_ref_idx_l1_active_minus1;
1342 unsigned char cabac_init_idc;
1343 char slice_qp_delta;
1344 unsigned char disable_deblocking_filter_idc;
1345 char slice_alpha_c0_offset_div2;
1346 char slice_beta_offset_div2;
1347 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1348 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1349 unsigned char luma_log2_weight_denom;
1350 unsigned char chroma_log2_weight_denom;
1351 unsigned char luma_weight_l0_flag;
1352 short luma_weight_l0[32];
1353 short luma_offset_l0[32];
1354 unsigned char chroma_weight_l0_flag;
1355 short chroma_weight_l0[32][2];
1356 short chroma_offset_l0[32][2];
1357 unsigned char luma_weight_l1_flag;
1358 short luma_weight_l1[32];
1359 short luma_offset_l1[32];
1360 unsigned char chroma_weight_l1_flag;
1361 short chroma_weight_l1[32][2];
1362 short chroma_offset_l1[32][2];
1363 } VASliceParameterBufferH264;
1365 /****************************
1366 * Common encode data structures
1367 ****************************/
1370 VAEncPictureTypeIntra = 0,
1371 VAEncPictureTypePredictive = 1,
1372 VAEncPictureTypeBidirectional = 2,
1375 /* Encode Slice Parameter Buffer */
1376 typedef struct _VAEncSliceParameterBuffer
1378 unsigned int start_row_number; /* starting MB row number for this slice */
1379 unsigned int slice_height; /* slice height measured in MB */
1382 unsigned int is_intra : 1;
1383 unsigned int disable_deblocking_filter_idc : 2;
1384 unsigned int uses_long_term_ref :1;
1385 unsigned int is_long_term_ref :1;
1389 } VAEncSliceParameterBuffer;
1391 /****************************
1392 * H.264 specific encode data structures
1393 ****************************/
1395 typedef struct _VAEncSequenceParameterBufferH264Baseline
1397 unsigned char seq_parameter_set_id;
1398 unsigned char level_idc;
1399 unsigned int intra_period;
1400 unsigned int intra_idr_period;
1401 unsigned int max_num_ref_frames;
1402 unsigned int picture_width_in_mbs;
1403 unsigned int picture_height_in_mbs;
1404 unsigned int bits_per_second;
1405 unsigned int frame_rate;
1406 unsigned int initial_qp;
1407 unsigned int min_qp;
1408 unsigned int basic_unit_size;
1409 unsigned char vui_flag;
1410 } VAEncSequenceParameterBufferH264Baseline;
1412 #define H264_LAST_PICTURE_EOSEQ 0x01 /* the last picture in the sequence */
1413 #define H264_LAST_PICTURE_EOSTREAM 0x02 /* the last picture in the stream */
1414 typedef struct _VAEncPictureParameterBufferH264Baseline
1416 VASurfaceID reference_picture;
1417 VASurfaceID reconstructed_picture;
1418 VABufferID coded_buf;
1419 unsigned short picture_width;
1420 unsigned short picture_height;
1421 unsigned char last_picture;
1422 } VAEncPictureParameterBufferH264Baseline;
1424 /****************************
1425 * H.263 specific encode data structures
1426 ****************************/
1428 typedef struct _VAEncSequenceParameterBufferH263
1430 unsigned int intra_period;
1431 unsigned int bits_per_second;
1432 unsigned int frame_rate;
1433 unsigned int initial_qp;
1434 unsigned int min_qp;
1435 } VAEncSequenceParameterBufferH263;
1437 typedef struct _VAEncPictureParameterBufferH263
1439 VASurfaceID reference_picture;
1440 VASurfaceID reconstructed_picture;
1441 VABufferID coded_buf;
1442 unsigned short picture_width;
1443 unsigned short picture_height;
1444 VAEncPictureType picture_type;
1445 } VAEncPictureParameterBufferH263;
1447 /****************************
1448 * MPEG-4 specific encode data structures
1449 ****************************/
1451 typedef struct _VAEncSequenceParameterBufferMPEG4
1453 unsigned char profile_and_level_indication;
1454 unsigned int intra_period;
1455 unsigned int video_object_layer_width;
1456 unsigned int video_object_layer_height;
1457 unsigned int vop_time_increment_resolution;
1458 unsigned int fixed_vop_rate;
1459 unsigned int fixed_vop_time_increment;
1460 unsigned int bits_per_second;
1461 unsigned int frame_rate;
1462 unsigned int initial_qp;
1463 unsigned int min_qp;
1464 } VAEncSequenceParameterBufferMPEG4;
1466 typedef struct _VAEncPictureParameterBufferMPEG4
1468 VASurfaceID reference_picture;
1469 VASurfaceID reconstructed_picture;
1470 VABufferID coded_buf;
1471 unsigned short picture_width;
1472 unsigned short picture_height;
1473 unsigned int modulo_time_base; /* number of 1s */
1474 unsigned int vop_time_increment;
1475 VAEncPictureType picture_type;
1476 } VAEncPictureParameterBufferMPEG4;
1480 /* Buffer functions */
1483 * Creates a buffer for "num_elements" elements of "size" bytes and
1484 * initalize with "data".
1485 * if "data" is null, then the contents of the buffer data store
1487 * Basically there are two ways to get buffer data to the server side. One is
1488 * to call vaCreateBuffer() with a non-null "data", which results the data being
1489 * copied to the data store on the server side. A different method that
1490 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1491 * and then use vaMapBuffer() to map the data store from the server side to the
1492 * client address space for access.
1493 * Note: image buffers are created by the library, not the client. Please see
1494 * vaCreateImage on how image buffers are managed.
1496 VAStatus vaCreateBuffer (
1498 VAContextID context,
1499 VABufferType type, /* in */
1500 unsigned int size, /* in */
1501 unsigned int num_elements, /* in */
1502 void *data, /* in */
1503 VABufferID *buf_id /* out */
1507 * Convey to the server how many valid elements are in the buffer.
1508 * e.g. if multiple slice parameters are being held in a single buffer,
1509 * this will communicate to the server the number of slice parameters
1510 * that are valid in the buffer.
1512 VAStatus vaBufferSetNumElements (
1514 VABufferID buf_id, /* in */
1515 unsigned int num_elements /* in */
1520 * device independent data structure for codedbuffer
1524 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1525 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1526 * enough for the encoder to attempt to limit its size.
1527 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1528 * exceeded the maximum slice size specified.
1529 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1530 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1531 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1533 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1534 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1535 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1536 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1537 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1539 * \brief The frame has exceeded the maximum requested size.
1541 * This flag indicates that the encoded frame size exceeds the value
1542 * specified through a misc parameter buffer of type
1543 * #VAEncMiscParameterTypeMaxFrameSize.
1545 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1546 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1549 * device independent data structure for codedbuffer
1551 typedef struct _VACodedBufferSegment {
1552 unsigned int size;/* size of the data buffer in the coded buffer segment, in bytes */
1553 unsigned int bit_offset; /* bit offset into the data buffer where valid bitstream data begins */
1554 unsigned int status; /* status set by the driver on the coded buffer*/
1555 unsigned int reserved; /* for future use */
1556 void *buf; /* pointer to the beginning of the data buffer in the coded buffer segment */
1557 void *next; /* pointer to the next VACodedBufferSegment */
1558 } VACodedBufferSegment;
1561 * Map data store of the buffer into the client's address space
1562 * vaCreateBuffer() needs to be called with "data" set to NULL before
1563 * calling vaMapBuffer()
1565 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1566 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1568 VAStatus vaMapBuffer (
1570 VABufferID buf_id, /* in */
1571 void **pbuf /* out */
1575 * After client making changes to a mapped data store, it needs to
1576 * "Unmap" it to let the server know that the data is ready to be
1577 * consumed by the server
1579 VAStatus vaUnmapBuffer (
1581 VABufferID buf_id /* in */
1585 * After this call, the buffer is deleted and this buffer_id is no longer valid
1586 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1588 VAStatus vaDestroyBuffer (
1590 VABufferID buffer_id
1594 Render (Decode) Pictures
1596 A picture represents either a frame or a field.
1598 The Begin/Render/End sequence sends the decode buffers to the server
1602 * Get ready to decode a picture to a target surface
1604 VAStatus vaBeginPicture (
1606 VAContextID context,
1607 VASurfaceID render_target
1611 * Send decode buffers to the server.
1612 * Buffers are automatically destroyed afterwards
1614 VAStatus vaRenderPicture (
1616 VAContextID context,
1617 VABufferID *buffers,
1622 * Make the end of rendering for a picture.
1623 * The server should start processing all pending operations for this
1624 * surface. This call is non-blocking. The client can start another
1625 * Begin/Render/End sequence on a different render target.
1627 VAStatus vaEndPicture (
1639 * This function blocks until all pending operations on the render target
1640 * have been completed. Upon return it is safe to use the render target for a
1641 * different picture.
1643 VAStatus vaSyncSurface (
1645 VASurfaceID render_target
1650 VASurfaceRendering = 1, /* Rendering in progress */
1651 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1652 /* this status is useful if surface is used as the source */
1654 VASurfaceReady = 4, /* not being rendered or displayed */
1655 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1659 * Find out any pending ops on the render target
1661 VAStatus vaQuerySurfaceStatus (
1663 VASurfaceID render_target,
1664 VASurfaceStatus *status /* out */
1669 VADecodeSliceMissing = 0,
1670 VADecodeMBError = 1,
1671 } VADecodeErrorType;
1674 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1675 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1677 typedef struct _VASurfaceDecodeMBErrors
1679 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1680 unsigned int start_mb; /* start mb address with errors */
1681 unsigned int end_mb; /* end mb address with errors */
1682 VADecodeErrorType decode_error_type;
1683 } VASurfaceDecodeMBErrors;
1686 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1687 * it can call vaQuerySurfaceError to find out further details on the particular error.
1688 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1689 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1690 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1691 * The array is terminated if "status==-1" is detected.
1693 VAStatus vaQuerySurfaceError(
1695 VASurfaceID surface,
1696 VAStatus error_status,
1701 * Images and Subpictures
1702 * VAImage is used to either get the surface data to client memory, or
1703 * to copy image data in client memory to a surface.
1704 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1705 * is at the upper left corner with positive X to the right and positive Y down
1707 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1708 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1709 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1711 /* a few common FourCCs */
1712 #define VA_FOURCC_NV12 0x3231564E
1713 #define VA_FOURCC_AI44 0x34344149
1714 #define VA_FOURCC_RGBA 0x41424752
1715 #define VA_FOURCC_BGRA 0x41524742
1716 #define VA_FOURCC_UYVY 0x59565955
1717 #define VA_FOURCC_YUY2 0x32595559
1718 #define VA_FOURCC_AYUV 0x56555941
1719 #define VA_FOURCC_NV11 0x3131564e
1720 #define VA_FOURCC_YV12 0x32315659
1721 #define VA_FOURCC_P208 0x38303250
1722 #define VA_FOURCC_IYUV 0x56555949
1725 #define VA_LSB_FIRST 1
1726 #define VA_MSB_FIRST 2
1728 typedef struct _VAImageFormat
1730 unsigned int fourcc;
1731 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1732 unsigned int bits_per_pixel;
1733 /* for RGB formats */
1734 unsigned int depth; /* significant bits per pixel */
1735 unsigned int red_mask;
1736 unsigned int green_mask;
1737 unsigned int blue_mask;
1738 unsigned int alpha_mask;
1741 typedef VAGenericID VAImageID;
1743 typedef struct _VAImage
1745 VAImageID image_id; /* uniquely identify this image */
1746 VAImageFormat format;
1747 VABufferID buf; /* image data buffer */
1749 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1750 * data store on the server side for optimal performance. The buffer will be
1751 * created by the CreateImage function, and proper storage allocated based on the image
1752 * size and format. This buffer is managed by the library implementation, and
1753 * accessed by the client through the buffer Map/Unmap functions.
1755 unsigned short width;
1756 unsigned short height;
1757 unsigned int data_size;
1758 unsigned int num_planes; /* can not be greater than 3 */
1760 * An array indicating the scanline pitch in bytes for each plane.
1761 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1763 unsigned int pitches[3];
1765 * An array indicating the byte offset from the beginning of the image data
1766 * to the start of each plane.
1768 unsigned int offsets[3];
1770 /* The following fields are only needed for paletted formats */
1771 int num_palette_entries; /* set to zero for non-palette images */
1773 * Each component is one byte and entry_bytes indicates the number of components in
1774 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1778 * An array of ascii characters describing the order of the components within the bytes.
1779 * Only entry_bytes characters of the string are used.
1781 char component_order[4];
1784 /* Get maximum number of image formats supported by the implementation */
1785 int vaMaxNumImageFormats (
1790 * Query supported image formats
1791 * The caller must provide a "format_list" array that can hold at
1792 * least vaMaxNumImageFormats() entries. The actual number of formats
1793 * returned in "format_list" is returned in "num_formats".
1795 VAStatus vaQueryImageFormats (
1797 VAImageFormat *format_list, /* out */
1798 int *num_formats /* out */
1802 * Create a VAImage structure
1803 * The width and height fields returned in the VAImage structure may get
1804 * enlarged for some YUV formats. Upon return from this function,
1805 * image->buf has been created and proper storage allocated by the library.
1806 * The client can access the image through the Map/Unmap calls.
1808 VAStatus vaCreateImage (
1810 VAImageFormat *format,
1813 VAImage *image /* out */
1817 * Should call DestroyImage before destroying the surface it is bound to
1819 VAStatus vaDestroyImage (
1824 VAStatus vaSetImagePalette (
1828 * pointer to an array holding the palette data. The size of the array is
1829 * num_palette_entries * entry_bytes in size. The order of the components
1830 * in the palette is described by the component_order in VAImage struct
1832 unsigned char *palette
1836 * Retrive surface data into a VAImage
1837 * Image must be in a format supported by the implementation
1839 VAStatus vaGetImage (
1841 VASurfaceID surface,
1842 int x, /* coordinates of the upper left source pixel */
1844 unsigned int width, /* width and height of the region */
1845 unsigned int height,
1850 * Copy data from a VAImage to a surface
1851 * Image must be in a format supported by the implementation
1852 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1853 * shouldn't be rendered into when this is called
1855 VAStatus vaPutImage (
1857 VASurfaceID surface,
1861 unsigned int src_width,
1862 unsigned int src_height,
1865 unsigned int dest_width,
1866 unsigned int dest_height
1870 * Derive an VAImage from an existing surface.
1871 * This interface will derive a VAImage and corresponding image buffer from
1872 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1873 * direct CPU access. This operation is only possible on implementations with
1874 * direct rendering capabilities and internal surface formats that can be
1875 * represented with a VAImage. When the operation is not possible this interface
1876 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1877 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1880 * Implementations should only return success when the resulting image buffer
1881 * would be useable with vaMap/Unmap.
1883 * When directly accessing a surface special care must be taken to insure
1884 * proper synchronization with the graphics hardware. Clients should call
1885 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1886 * rendering or currently being displayed by an overlay.
1888 * Additionally nothing about the contents of a surface should be assumed
1889 * following a vaPutSurface. Implementations are free to modify the surface for
1890 * scaling or subpicture blending within a call to vaPutImage.
1892 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1893 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1894 * vaGetImage with other surfaces is supported.
1896 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1897 * image and image buffer structures will be destroyed; however, the underlying
1898 * surface will remain unchanged until freed with vaDestroySurfaces.
1900 VAStatus vaDeriveImage (
1902 VASurfaceID surface,
1903 VAImage *image /* out */
1908 * Subpicture is a special type of image that can be blended
1909 * with a surface during vaPutSurface(). Subpicture can be used to render
1910 * DVD sub-titles or closed captioning text etc.
1913 typedef VAGenericID VASubpictureID;
1915 /* Get maximum number of subpicture formats supported by the implementation */
1916 int vaMaxNumSubpictureFormats (
1920 /* flags for subpictures */
1921 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
1922 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
1923 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
1925 * Query supported subpicture formats
1926 * The caller must provide a "format_list" array that can hold at
1927 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1928 * for each format to indicate additional capabilities for that format. The actual
1929 * number of formats returned in "format_list" is returned in "num_formats".
1930 * flags: returned value to indicate addtional capabilities
1931 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1932 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1933 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
1936 VAStatus vaQuerySubpictureFormats (
1938 VAImageFormat *format_list, /* out */
1939 unsigned int *flags, /* out */
1940 unsigned int *num_formats /* out */
1944 * Subpictures are created with an image associated.
1946 VAStatus vaCreateSubpicture (
1949 VASubpictureID *subpicture /* out */
1953 * Destroy the subpicture before destroying the image it is assocated to
1955 VAStatus vaDestroySubpicture (
1957 VASubpictureID subpicture
1961 * Bind an image to the subpicture. This image will now be associated with
1962 * the subpicture instead of the one at creation.
1964 VAStatus vaSetSubpictureImage (
1966 VASubpictureID subpicture,
1971 * If chromakey is enabled, then the area where the source value falls within
1972 * the chromakey [min, max] range is transparent
1973 * The chromakey component format is the following:
1974 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
1975 * For YUV: [0:7] V [8:15] U [16:23] Y
1976 * The chromakey mask can be used to mask out certain components for chromakey
1979 VAStatus vaSetSubpictureChromakey (
1981 VASubpictureID subpicture,
1982 unsigned int chromakey_min,
1983 unsigned int chromakey_max,
1984 unsigned int chromakey_mask
1988 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
1989 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
1990 * the overall alpha is per-pixel alpha multiplied by the global alpha
1992 VAStatus vaSetSubpictureGlobalAlpha (
1994 VASubpictureID subpicture,
1999 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2000 * It defines the region mapping between the subpicture and the target
2001 * surfaces through source and destination rectangles (with the same width and height).
2002 * Both will be displayed at the next call to vaPutSurface. Additional
2003 * associations before the call to vaPutSurface simply overrides the association.
2005 VAStatus vaAssociateSubpicture (
2007 VASubpictureID subpicture,
2008 VASurfaceID *target_surfaces,
2010 short src_x, /* upper left offset in subpicture */
2012 unsigned short src_width,
2013 unsigned short src_height,
2014 short dest_x, /* upper left offset in surface */
2016 unsigned short dest_width,
2017 unsigned short dest_height,
2019 * whether to enable chroma-keying, global-alpha, or screen relative mode
2020 * see VA_SUBPICTURE_XXX values
2026 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2028 VAStatus vaDeassociateSubpicture (
2030 VASubpictureID subpicture,
2031 VASurfaceID *target_surfaces,
2035 typedef struct _VARectangle
2039 unsigned short width;
2040 unsigned short height;
2044 * Display attributes
2045 * Display attributes are used to control things such as contrast, hue, saturation,
2046 * brightness etc. in the rendering process. The application can query what
2047 * attributes are supported by the driver, and then set the appropriate attributes
2048 * before calling vaPutSurface()
2050 /* PowerVR IEP Lite attributes */
2053 VADISPLAYATTRIB_BLE_OFF = 0x00,
2054 VADISPLAYATTRIB_BLE_LOW,
2055 VADISPLAYATTRIB_BLE_MEDIUM,
2056 VADISPLAYATTRIB_BLE_HIGH,
2057 VADISPLAYATTRIB_BLE_NONE,
2058 } VADisplayAttribBLEMode;
2060 /* attribute value for VADisplayAttribRotation */
2061 #define VA_ROTATION_NONE 0x00000000
2062 #define VA_ROTATION_90 0x00000001
2063 #define VA_ROTATION_180 0x00000002
2064 #define VA_ROTATION_270 0x00000003
2066 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2067 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2068 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2071 #define VA_RENDER_MODE_UNDEFINED 0
2072 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2073 #define VA_RENDER_MODE_LOCAL_GPU 2
2074 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2075 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2078 #define VA_RENDER_DEVICE_UNDEFINED 0
2079 #define VA_RENDER_DEVICE_LOCAL 1
2080 #define VA_RENDER_DEVICE_EXTERNAL 2
2082 /* Currently defined display attribute types */
2085 VADisplayAttribBrightness = 0,
2086 VADisplayAttribContrast = 1,
2087 VADisplayAttribHue = 2,
2088 VADisplayAttribSaturation = 3,
2089 /* client can specifiy a background color for the target window
2090 * the new feature of video conference,
2091 * the uncovered area of the surface is filled by this color
2092 * also it will blend with the decoded video color
2094 VADisplayAttribBackgroundColor = 4,
2096 * this is a gettable only attribute. For some implementations that use the
2097 * hardware overlay, after PutSurface is called, the surface can not be
2098 * re-used until after the subsequent PutSurface call. If this is the case
2099 * then the value for this attribute will be set to 1 so that the client
2100 * will not attempt to re-use the surface right after returning from a call
2103 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2104 * driver may use overlay or GPU alternatively
2106 VADisplayAttribDirectSurface = 5,
2107 VADisplayAttribRotation = 6,
2108 VADisplayAttribOutofLoopDeblock = 7,
2110 /* PowerVR IEP Lite specific attributes */
2111 VADisplayAttribBLEBlackMode = 8,
2112 VADisplayAttribBLEWhiteMode = 9,
2113 VADisplayAttribBlueStretch = 10,
2114 VADisplayAttribSkinColorCorrection = 11,
2116 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2117 * conversion matrix. Each element in the matrix is float-point
2119 VADisplayAttribCSCMatrix = 12,
2120 /* specify the constant color used to blend with video surface
2121 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2122 * d: the final color to overwrite into the frame buffer
2123 * v: decoded video after color conversion,
2124 * c: video color specified by VADisplayAttribBlendColor
2125 * b: background color of the drawable
2127 VADisplayAttribBlendColor = 13,
2129 * Indicate driver to skip painting color key or not.
2130 * only applicable if the render is overlay
2132 VADisplayAttribOverlayAutoPaintColorKey = 14,
2134 * customized overlay color key, the format is RGB888
2135 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2137 VADisplayAttribOverlayColorKey = 15,
2139 * The hint for the implementation of vaPutSurface
2140 * normally, the driver could use an overlay or GPU to render the surface on the screen
2141 * this flag provides APP the flexibity to switch the render dynamically
2143 VADisplayAttribRenderMode = 16,
2145 * specify if vaPutSurface needs to render into specified monitors
2146 * one example is that one external monitor (e.g. HDMI) is enabled,
2147 * but the window manager is not aware of it, and there is no associated drawable
2149 VADisplayAttribRenderDevice = 17,
2151 * specify vaPutSurface render area if there is no drawable on the monitor
2153 VADisplayAttribRenderRect = 18,
2154 } VADisplayAttribType;
2156 /* flags for VADisplayAttribute */
2157 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2158 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2159 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2161 typedef struct _VADisplayAttribute
2163 VADisplayAttribType type;
2166 int value; /* used by the set/get attribute functions */
2167 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2169 } VADisplayAttribute;
2171 /* Get maximum number of display attributs supported by the implementation */
2172 int vaMaxNumDisplayAttributes (
2177 * Query display attributes
2178 * The caller must provide a "attr_list" array that can hold at
2179 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2180 * returned in "attr_list" is returned in "num_attributes".
2182 VAStatus vaQueryDisplayAttributes (
2184 VADisplayAttribute *attr_list, /* out */
2185 int *num_attributes /* out */
2189 * Get display attributes
2190 * This function returns the current attribute values in "attr_list".
2191 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2192 * from vaQueryDisplayAttributes() can have their values retrieved.
2194 VAStatus vaGetDisplayAttributes (
2196 VADisplayAttribute *attr_list, /* in/out */
2201 * Set display attributes
2202 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2203 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2204 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2206 VAStatus vaSetDisplayAttributes (
2208 VADisplayAttribute *attr_list,