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
378 /** \brief Variable bitrate with peak rate higher than average bitrate. */
379 #define VA_RC_VBR_CONSTRAINED 0x00000020
382 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
384 /** \brief Driver does not support any packed headers mode. */
385 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
386 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
387 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
388 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
389 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
390 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
391 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
392 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
393 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
396 /** @name Attribute values for VAConfigAttribEncInterlaced */
398 /** \brief Driver does not support interlaced coding. */
399 #define VA_ENC_INTERLACED_NONE 0x00000000
400 /** \brief Driver supports interlaced frame coding. */
401 #define VA_ENC_INTERLACED_FRAME 0x00000001
402 /** \brief Driver supports interlaced field coding. */
403 #define VA_ENC_INTERLACED_FIELD 0x00000002
404 /** \brief Driver supports macroblock adaptive frame field coding. */
405 #define VA_ENC_INTERLACED_MBAFF 0x00000004
406 /** \brief Driver supports picture adaptive frame field coding. */
407 #define VA_ENC_INTERLACED_PAFF 0x00000008
410 /** @name Attribute values for VAConfigAttribEncSliceStructure */
412 /** \brief Driver supports an arbitrary number of rows per slice. */
413 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
414 /** \brief Driver supports a power-of-two number of rows per slice. */
415 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
416 /** \brief Driver supports an arbitrary number of rows per slice. */
417 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
421 * if an attribute is not applicable for a given
422 * profile/entrypoint pair, then set the value to the following
424 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
426 /* Get maximum number of profiles supported by the implementation */
427 int vaMaxNumProfiles (
431 /* Get maximum number of entrypoints supported by the implementation */
432 int vaMaxNumEntrypoints (
436 /* Get maximum number of attributs supported by the implementation */
437 int vaMaxNumConfigAttributes (
442 * Query supported profiles
443 * The caller must provide a "profile_list" array that can hold at
444 * least vaMaxNumProfile() entries. The actual number of profiles
445 * returned in "profile_list" is returned in "num_profile".
447 VAStatus vaQueryConfigProfiles (
449 VAProfile *profile_list, /* out */
450 int *num_profiles /* out */
454 * Query supported entrypoints for a given profile
455 * The caller must provide an "entrypoint_list" array that can hold at
456 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
457 * returned in "entrypoint_list" is returned in "num_entrypoints".
459 VAStatus vaQueryConfigEntrypoints (
462 VAEntrypoint *entrypoint_list, /* out */
463 int *num_entrypoints /* out */
467 * Get attributes for a given profile/entrypoint pair
468 * The caller must provide an "attrib_list" with all attributes to be
469 * retrieved. Upon return, the attributes in "attrib_list" have been
470 * updated with their value. Unknown attributes or attributes that are
471 * not supported for the given profile/entrypoint pair will have their
472 * value set to VA_ATTRIB_NOT_SUPPORTED
474 VAStatus vaGetConfigAttributes (
477 VAEntrypoint entrypoint,
478 VAConfigAttrib *attrib_list, /* in/out */
482 /* Generic ID type, can be re-typed for specific implementation */
483 typedef unsigned int VAGenericID;
485 typedef VAGenericID VAConfigID;
488 * Create a configuration for the decode pipeline
489 * it passes in the attribute list that specifies the attributes it cares
490 * about, with the rest taking default values.
492 VAStatus vaCreateConfig (
495 VAEntrypoint entrypoint,
496 VAConfigAttrib *attrib_list,
498 VAConfigID *config_id /* out */
502 * Free resources associdated with a given config
504 VAStatus vaDestroyConfig (
510 * Query all attributes for a given configuration
511 * The profile of the configuration is returned in "profile"
512 * The entrypoint of the configuration is returned in "entrypoint"
513 * The caller must provide an "attrib_list" array that can hold at least
514 * vaMaxNumConfigAttributes() entries. The actual number of attributes
515 * returned in "attrib_list" is returned in "num_attribs"
517 VAStatus vaQueryConfigAttributes (
519 VAConfigID config_id,
520 VAProfile *profile, /* out */
521 VAEntrypoint *entrypoint, /* out */
522 VAConfigAttrib *attrib_list,/* out */
523 int *num_attribs /* out */
528 * Contexts and Surfaces
530 * Context represents a "virtual" video decode pipeline. Surfaces are render
531 * targets for a given context. The data in the surfaces are not accessible
532 * to the client and the internal data format of the surface is implementatin
535 * Surfaces will be bound to a context when the context is created. Once
536 * a surface is bound to a given context, it can not be used to create
537 * another context. The association is removed when the context is destroyed
539 * Both contexts and surfaces are identified by unique IDs and its
540 * implementation specific internals are kept opaque to the clients
543 typedef VAGenericID VAContextID;
545 typedef VAGenericID VASurfaceID;
547 #define VA_INVALID_ID 0xffffffff
548 #define VA_INVALID_SURFACE VA_INVALID_ID
550 /** \brief Generic value types. */
552 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
553 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
554 VAGenericValueTypePointer, /**< Generic pointer type */
555 VAGenericValueTypeFunc /**< Pointer to function */
556 } VAGenericValueType;
558 /** \brief Generic function type. */
559 typedef void (*VAGenericFunc)(void);
561 /** \brief Generic value. */
562 typedef struct _VAGenericValue {
563 /** \brief Value type. See #VAGenericValueType. */
564 VAGenericValueType type;
565 /** \brief Value holder. */
567 /** \brief 32-bit signed integer. */
569 /** \brief 32-bit float. */
571 /** \brief Generic pointer. */
573 /** \brief Pointer to function. */
579 * vaCreateSurfaces - Create an array of surfaces used for decode and display
581 * width: surface width
582 * height: surface height
583 * format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
584 * num_surfaces: number of surfaces to be created
585 * surfaces: array of surfaces created upon return
587 VAStatus vaCreateSurfaces (
593 VASurfaceID *surfaces /* out */
598 * vaDestroySurfaces - Destroy resources associated with surfaces.
599 * Surfaces can only be destroyed after the context associated has been
602 * surfaces: array of surfaces to destroy
603 * num_surfaces: number of surfaces in the array to be destroyed.
605 VAStatus vaDestroySurfaces (
607 VASurfaceID *surfaces,
611 #define VA_PROGRESSIVE 0x1
613 * vaCreateContext - Create a context
615 * config_id: configuration for the context
616 * picture_width: coded picture width
617 * picture_height: coded picture height
618 * flag: any combination of the following:
619 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
620 * render_targets: render targets (surfaces) tied to the context
621 * num_render_targets: number of render targets in the above array
622 * context: created context id upon return
624 VAStatus vaCreateContext (
626 VAConfigID config_id,
630 VASurfaceID *render_targets,
631 int num_render_targets,
632 VAContextID *context /* out */
636 * vaDestroyContext - Destroy a context
638 * context: context to be destroyed
640 VAStatus vaDestroyContext (
647 * Buffers are used to pass various types of data from the
648 * client to the server. The server maintains a data store
649 * for each buffer created, and the client idenfies a buffer
650 * through a unique buffer id assigned by the server.
653 typedef VAGenericID VABufferID;
657 VAPictureParameterBufferType = 0,
658 VAIQMatrixBufferType = 1,
659 VABitPlaneBufferType = 2,
660 VASliceGroupMapBufferType = 3,
661 VASliceParameterBufferType = 4,
662 VASliceDataBufferType = 5,
663 VAMacroblockParameterBufferType = 6,
664 VAResidualDataBufferType = 7,
665 VADeblockingParameterBufferType = 8,
666 VAImageBufferType = 9,
667 VAProtectedSliceDataBufferType = 10,
668 VAQMatrixBufferType = 11,
669 VAHuffmanTableBufferType = 12,
671 /* Following are encode buffer types */
672 VAEncCodedBufferType = 21,
673 VAEncSequenceParameterBufferType = 22,
674 VAEncPictureParameterBufferType = 23,
675 VAEncSliceParameterBufferType = 24,
676 VAEncPackedHeaderParameterBufferType = 25,
677 VAEncPackedHeaderDataBufferType = 26,
678 VAEncMiscParameterBufferType = 27,
679 VAEncMacroblockParameterBufferType = 28,
680 VABufferTypeMax = 0xff
685 VAEncMiscParameterTypeFrameRate = 0,
686 VAEncMiscParameterTypeRateControl = 1,
687 VAEncMiscParameterTypeMaxSliceSize = 2,
688 VAEncMiscParameterTypeAIR = 3,
689 /** \brief Buffer type used to express a maximum frame size (in bits). */
690 VAEncMiscParameterTypeMaxFrameSize = 4,
691 /** \brief Buffer type used for HRD parameters. */
692 VAEncMiscParameterTypeHRD = 5,
693 } VAEncMiscParameterType;
695 /** \brief Packed header type. */
697 /** \brief Packed sequence header. */
698 VAEncPackedHeaderSequence = 1,
699 /** \brief Packed picture header. */
700 VAEncPackedHeaderPicture = 2,
701 /** \brief Packed slice header. */
702 VAEncPackedHeaderSlice = 3,
703 /** \brief Misc packed header. See codec-specific definitions. */
704 VAEncPackedHeaderMiscMask = 0x80000000,
705 } VAEncPackedHeaderType;
707 /** \brief Packed header parameter. */
708 typedef struct _VAEncPackedHeaderParameterBuffer {
709 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
711 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
712 unsigned int bit_length;
713 /** \brief Flag: buffer contains start code emulation prevention bytes? */
714 unsigned char has_emulation_bytes;
715 } VAEncPackedHeaderParameterBuffer;
718 * For application, e.g. set a new bitrate
720 * VAEncMiscParameterBuffer *misc_param;
721 * VAEncMiscParameterRateControl *misc_rate_ctrl;
723 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
724 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
727 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
728 * misc_param->type = VAEncMiscParameterTypeRateControl;
729 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
730 * misc_rate_ctrl->bits_per_second = 6400000;
731 * vaUnmapBuffer(dpy, buf_id);
732 * vaRenderPicture(dpy, context, &buf_id, 1);
734 typedef struct _VAEncMiscParameterBuffer
736 VAEncMiscParameterType type;
737 unsigned int data[0];
738 } VAEncMiscParameterBuffer;
741 /** \brief Rate control parameters */
742 typedef struct _VAEncMiscParameterRateControl
744 /* this is the maximum bit-rate to be constrained by the rate control implementation */
745 unsigned int bits_per_second;
746 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
747 * bit-rate for example if target_percentage is 95 then the rate control will target
748 * a bit-rate that is 95% of the maximum bit-rate
750 unsigned int target_percentage;
751 /* windows size in milliseconds. For example if this is set to 500,
752 * then the rate control will guarantee the target bit-rate over a 500 ms window
754 unsigned int window_size;
755 /* initial QP at I frames */
756 unsigned int initial_qp;
758 unsigned int basic_unit_size;
763 unsigned int reset : 1;
764 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
765 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
769 } VAEncMiscParameterRateControl;
771 typedef struct _VAEncMiscParameterFrameRate
773 unsigned int framerate;
774 } VAEncMiscParameterFrameRate;
777 * Allow a maximum slice size to be specified (in bits).
778 * The encoder will attempt to make sure that individual slices do not exceed this size
779 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
781 typedef struct _VAEncMiscParameterMaxSliceSize
783 unsigned int max_slice_size;
784 } VAEncMiscParameterMaxSliceSize;
786 typedef struct _VAEncMiscParameterAIR
788 unsigned int air_num_mbs;
789 unsigned int air_threshold;
790 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
791 } VAEncMiscParameterAIR;
793 typedef struct _VAEncMiscParameterHRD
795 unsigned int initial_buffer_fullness; /* in bits */
796 unsigned int buffer_size; /* in bits */
797 } VAEncMiscParameterHRD;
800 * \brief Defines a maximum frame size (in bits).
802 * This misc parameter buffer defines the maximum size of a frame (in
803 * bits). The encoder will try to make sure that each frame does not
804 * exceed this size. Otherwise, if the frame size exceeds this size,
805 * the \c status flag of #VACodedBufferSegment will contain
806 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
808 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
809 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
810 VAEncMiscParameterType type;
811 /** \brief Maximum size of a frame (in bits). */
812 unsigned int max_frame_size;
813 } VAEncMiscParameterBufferMaxFrameSize;
816 * There will be cases where the bitstream buffer will not have enough room to hold
817 * the data for the entire slice, and the following flags will be used in the slice
818 * parameter to signal to the server for the possible cases.
819 * If a slice parameter buffer and slice data buffer pair is sent to the server with
820 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
821 * then a slice parameter and data buffer needs to be sent again to complete this slice.
823 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
824 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
825 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
826 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
828 /* Codec-independent Slice Parameter Buffer base */
829 typedef struct _VASliceParameterBufferBase
831 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
832 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
833 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
834 } VASliceParameterBufferBase;
837 /****************************
838 * JEPG data structure
839 ***************************/
840 typedef struct _VAQMatrixBufferJPEG
842 int load_lum_quantiser_matrix;
843 int load_chroma_quantiser_matrix;
844 unsigned char lum_quantiser_matrix[64];
845 unsigned char chroma_quantiser_matrix[64];
846 } VAQMatrixBufferJPEG;
848 typedef struct _VAEncPictureParameterBufferJPEG
850 VASurfaceID reconstructed_picture;
851 unsigned short picture_width;
852 unsigned short picture_height;
853 VABufferID coded_buf;
854 } VAEncPictureParameterBufferJPEG;
856 #include <va/va_dec_jpeg.h>
858 /****************************
859 * MPEG-2 data structures
860 ****************************/
862 /* MPEG-2 Picture Parameter Buffer */
864 * For each frame or field, and before any slice data, a single
865 * picture parameter buffer must be send.
867 typedef struct _VAPictureParameterBufferMPEG2
869 unsigned short horizontal_size;
870 unsigned short vertical_size;
871 VASurfaceID forward_reference_picture;
872 VASurfaceID backward_reference_picture;
873 /* meanings of the following fields are the same as in the standard */
874 int picture_coding_type;
875 int f_code; /* pack all four fcode into this */
878 unsigned int intra_dc_precision : 2;
879 unsigned int picture_structure : 2;
880 unsigned int top_field_first : 1;
881 unsigned int frame_pred_frame_dct : 1;
882 unsigned int concealment_motion_vectors : 1;
883 unsigned int q_scale_type : 1;
884 unsigned int intra_vlc_format : 1;
885 unsigned int alternate_scan : 1;
886 unsigned int repeat_first_field : 1;
887 unsigned int progressive_frame : 1;
888 unsigned int is_first_field : 1; /* indicate whether the current field
889 * is the first field for field picture
893 } picture_coding_extension;
894 } VAPictureParameterBufferMPEG2;
896 /* MPEG-2 Inverse Quantization Matrix Buffer */
897 typedef struct _VAIQMatrixBufferMPEG2
899 int load_intra_quantiser_matrix;
900 int load_non_intra_quantiser_matrix;
901 int load_chroma_intra_quantiser_matrix;
902 int load_chroma_non_intra_quantiser_matrix;
903 unsigned char intra_quantiser_matrix[64];
904 unsigned char non_intra_quantiser_matrix[64];
905 unsigned char chroma_intra_quantiser_matrix[64];
906 unsigned char chroma_non_intra_quantiser_matrix[64];
907 } VAIQMatrixBufferMPEG2;
909 /* MPEG-2 Slice Parameter Buffer */
910 typedef struct _VASliceParameterBufferMPEG2
912 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
913 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
914 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
915 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
916 unsigned int slice_horizontal_position;
917 unsigned int slice_vertical_position;
918 int quantiser_scale_code;
919 int intra_slice_flag;
920 } VASliceParameterBufferMPEG2;
922 /* MPEG-2 Macroblock Parameter Buffer */
923 typedef struct _VAMacroblockParameterBufferMPEG2
925 unsigned short macroblock_address;
927 * macroblock_address (in raster scan order)
929 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
931 unsigned char macroblock_type; /* see definition below */
934 unsigned int frame_motion_type : 2;
935 unsigned int field_motion_type : 2;
936 unsigned int dct_type : 1;
940 unsigned char motion_vertical_field_select;
942 * motion_vertical_field_select:
943 * see section 6.3.17.2 in the spec
944 * only the lower 4 bits are used
945 * bit 0: first vector forward
946 * bit 1: first vector backward
947 * bit 2: second vector forward
948 * bit 3: second vector backward
950 short PMV[2][2][2]; /* see Table 7-7 in the spec */
951 unsigned short coded_block_pattern;
953 * The bitplanes for coded_block_pattern are described
954 * in Figure 6.10-12 in the spec
957 /* Number of skipped macroblocks after this macroblock */
958 unsigned short num_skipped_macroblocks;
959 } VAMacroblockParameterBufferMPEG2;
962 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
964 #define VA_MB_TYPE_MOTION_FORWARD 0x02
965 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
966 #define VA_MB_TYPE_MOTION_PATTERN 0x08
967 #define VA_MB_TYPE_MOTION_INTRA 0x10
970 * MPEG-2 Residual Data Buffer
971 * For each macroblock, there wil be 64 shorts (16-bit) in the
972 * residual data buffer
975 /****************************
976 * MPEG-4 Part 2 data structures
977 ****************************/
979 /* MPEG-4 Picture Parameter Buffer */
981 * For each frame or field, and before any slice data, a single
982 * picture parameter buffer must be send.
984 typedef struct _VAPictureParameterBufferMPEG4
986 unsigned short vop_width;
987 unsigned short vop_height;
988 VASurfaceID forward_reference_picture;
989 VASurfaceID backward_reference_picture;
992 unsigned int short_video_header : 1;
993 unsigned int chroma_format : 2;
994 unsigned int interlaced : 1;
995 unsigned int obmc_disable : 1;
996 unsigned int sprite_enable : 2;
997 unsigned int sprite_warping_accuracy : 2;
998 unsigned int quant_type : 1;
999 unsigned int quarter_sample : 1;
1000 unsigned int data_partitioned : 1;
1001 unsigned int reversible_vlc : 1;
1002 unsigned int resync_marker_disable : 1;
1006 unsigned char no_of_sprite_warping_points;
1007 short sprite_trajectory_du[3];
1008 short sprite_trajectory_dv[3];
1009 unsigned char quant_precision;
1012 unsigned int vop_coding_type : 2;
1013 unsigned int backward_reference_vop_coding_type : 2;
1014 unsigned int vop_rounding_type : 1;
1015 unsigned int intra_dc_vlc_thr : 3;
1016 unsigned int top_field_first : 1;
1017 unsigned int alternate_vertical_scan_flag : 1;
1021 unsigned char vop_fcode_forward;
1022 unsigned char vop_fcode_backward;
1023 unsigned short vop_time_increment_resolution;
1024 /* short header related */
1025 unsigned char num_gobs_in_vop;
1026 unsigned char num_macroblocks_in_gob;
1027 /* for direct mode prediction */
1030 } VAPictureParameterBufferMPEG4;
1032 /* MPEG-4 Inverse Quantization Matrix Buffer */
1033 typedef struct _VAIQMatrixBufferMPEG4
1035 int load_intra_quant_mat;
1036 int load_non_intra_quant_mat;
1037 unsigned char intra_quant_mat[64];
1038 unsigned char non_intra_quant_mat[64];
1039 } VAIQMatrixBufferMPEG4;
1041 /* MPEG-4 Slice Parameter Buffer */
1042 typedef struct _VASliceParameterBufferMPEG4
1044 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1045 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1046 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1047 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1048 unsigned int macroblock_number;
1050 } VASliceParameterBufferMPEG4;
1053 VC-1 data structures
1056 typedef enum /* see 7.1.1.32 */
1059 VAMvMode1MvHalfPel = 1,
1060 VAMvMode1MvHalfPelBilinear = 2,
1061 VAMvModeMixedMv = 3,
1062 VAMvModeIntensityCompensation = 4
1065 /* VC-1 Picture Parameter Buffer */
1067 * For each picture, and before any slice data, a picture parameter
1068 * buffer must be send. Multiple picture parameter buffers may be
1069 * sent for a single picture. In that case picture parameters will
1070 * apply to all slice data that follow it until a new picture
1071 * parameter buffer is sent.
1074 * pic_quantizer_type should be set to the applicable quantizer
1075 * type as defined by QUANTIZER (J.1.19) and either
1076 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1078 typedef struct _VAPictureParameterBufferVC1
1080 VASurfaceID forward_reference_picture;
1081 VASurfaceID backward_reference_picture;
1082 /* if out-of-loop post-processing is done on the render
1083 target, then we need to keep the in-loop decoded
1084 picture as a reference picture */
1085 VASurfaceID inloop_decoded_picture;
1087 /* sequence layer for AP or meta data for SP and MP */
1090 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1091 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1092 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1093 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1094 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1095 unsigned int multires : 1; /* METADATA::MULTIRES */
1096 unsigned int overlap : 1; /* METADATA::OVERLAP */
1097 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1098 unsigned int rangered : 1; /* METADATA::RANGERED */
1099 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1100 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1105 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1106 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1109 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1110 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1111 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1112 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1115 } entrypoint_fields;
1116 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1117 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1120 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1121 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1122 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1123 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1126 } range_mapping_fields;
1128 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1129 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1130 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1131 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1132 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1133 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1134 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1135 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1136 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1139 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1140 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1141 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1142 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1143 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1149 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1150 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1151 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1152 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1153 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1154 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1155 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1161 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1162 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1163 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1164 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1165 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1166 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1167 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1170 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1173 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1174 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1175 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1176 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1182 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1183 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1184 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1185 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1186 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1187 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1188 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1189 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1190 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1191 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1197 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1198 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1199 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1200 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1201 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1202 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1203 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1204 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1205 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1206 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1207 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1210 } pic_quantizer_fields;
1213 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1214 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1215 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1216 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1217 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1218 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1222 } VAPictureParameterBufferVC1;
1224 /* VC-1 Bitplane Buffer
1225 There will be at most three bitplanes coded in any picture header. To send
1226 the bitplane data more efficiently, each byte is divided in two nibbles, with
1227 each nibble carrying three bitplanes for one macroblock. The following table
1228 shows the bitplane data arrangement within each nibble based on the picture
1231 Picture Type Bit3 Bit2 Bit1 Bit0
1232 I or BI OVERFLAGS ACPRED FIELDTX
1233 P MYTYPEMB SKIPMB DIRECTMB
1234 B FORWARDMB SKIPMB DIRECTMB
1236 Within each byte, the lower nibble is for the first MB and the upper nibble is
1237 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1238 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1239 Macroblock #2 in the first row.
1242 /* VC-1 Slice Parameter Buffer */
1243 typedef struct _VASliceParameterBufferVC1
1245 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1246 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1247 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1248 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1249 unsigned int slice_vertical_position;
1250 } VASliceParameterBufferVC1;
1252 /* VC-1 Slice Data Buffer */
1254 This is simplely a buffer containing raw bit-stream bytes
1257 /****************************
1258 * H.264/AVC data structures
1259 ****************************/
1261 typedef struct _VAPictureH264
1263 VASurfaceID picture_id;
1264 unsigned int frame_idx;
1266 signed int TopFieldOrderCnt;
1267 signed int BottomFieldOrderCnt;
1269 /* flags in VAPictureH264 could be OR of the following */
1270 #define VA_PICTURE_H264_INVALID 0x00000001
1271 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1272 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1273 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1274 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1276 /* H.264 Picture Parameter Buffer */
1278 * For each picture, and before any slice data, a single
1279 * picture parameter buffer must be send.
1281 typedef struct _VAPictureParameterBufferH264
1283 VAPictureH264 CurrPic;
1284 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1285 unsigned short picture_width_in_mbs_minus1;
1286 unsigned short picture_height_in_mbs_minus1;
1287 unsigned char bit_depth_luma_minus8;
1288 unsigned char bit_depth_chroma_minus8;
1289 unsigned char num_ref_frames;
1292 unsigned int chroma_format_idc : 2;
1293 unsigned int residual_colour_transform_flag : 1;
1294 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1295 unsigned int frame_mbs_only_flag : 1;
1296 unsigned int mb_adaptive_frame_field_flag : 1;
1297 unsigned int direct_8x8_inference_flag : 1;
1298 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1299 unsigned int log2_max_frame_num_minus4 : 4;
1300 unsigned int pic_order_cnt_type : 2;
1301 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1302 unsigned int delta_pic_order_always_zero_flag : 1;
1306 unsigned char num_slice_groups_minus1;
1307 unsigned char slice_group_map_type;
1308 unsigned short slice_group_change_rate_minus1;
1309 signed char pic_init_qp_minus26;
1310 signed char pic_init_qs_minus26;
1311 signed char chroma_qp_index_offset;
1312 signed char second_chroma_qp_index_offset;
1315 unsigned int entropy_coding_mode_flag : 1;
1316 unsigned int weighted_pred_flag : 1;
1317 unsigned int weighted_bipred_idc : 2;
1318 unsigned int transform_8x8_mode_flag : 1;
1319 unsigned int field_pic_flag : 1;
1320 unsigned int constrained_intra_pred_flag : 1;
1321 unsigned int pic_order_present_flag : 1;
1322 unsigned int deblocking_filter_control_present_flag : 1;
1323 unsigned int redundant_pic_cnt_present_flag : 1;
1324 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1328 unsigned short frame_num;
1329 } VAPictureParameterBufferH264;
1331 /* H.264 Inverse Quantization Matrix Buffer */
1332 typedef struct _VAIQMatrixBufferH264
1334 unsigned char ScalingList4x4[6][16];
1335 unsigned char ScalingList8x8[2][64];
1336 } VAIQMatrixBufferH264;
1339 * H.264 Slice Group Map Buffer
1340 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1341 * A slice group map buffer should be sent for each picture if required. The buffer
1342 * is sent only when there is a change in the mapping values.
1343 * The slice group map buffer map "map units" to slice groups as specified in
1344 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1345 * in raster scan order
1348 /* H.264 Slice Parameter Buffer */
1349 typedef struct _VASliceParameterBufferH264
1351 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1352 /** \brief Byte offset to the NAL Header Unit for this slice. */
1353 unsigned int slice_data_offset;
1354 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1356 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1358 * This bit offset is relative to and includes the NAL unit byte
1359 * and represents the number of bits parsed in the slice_header()
1360 * after the removal of any emulation prevention bytes in
1361 * there. However, the slice data buffer passed to the hardware is
1362 * the original bitstream, thus including any emulation prevention
1365 unsigned short slice_data_bit_offset;
1366 unsigned short first_mb_in_slice;
1367 unsigned char slice_type;
1368 unsigned char direct_spatial_mv_pred_flag;
1369 unsigned char num_ref_idx_l0_active_minus1;
1370 unsigned char num_ref_idx_l1_active_minus1;
1371 unsigned char cabac_init_idc;
1372 char slice_qp_delta;
1373 unsigned char disable_deblocking_filter_idc;
1374 char slice_alpha_c0_offset_div2;
1375 char slice_beta_offset_div2;
1376 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1377 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1378 unsigned char luma_log2_weight_denom;
1379 unsigned char chroma_log2_weight_denom;
1380 unsigned char luma_weight_l0_flag;
1381 short luma_weight_l0[32];
1382 short luma_offset_l0[32];
1383 unsigned char chroma_weight_l0_flag;
1384 short chroma_weight_l0[32][2];
1385 short chroma_offset_l0[32][2];
1386 unsigned char luma_weight_l1_flag;
1387 short luma_weight_l1[32];
1388 short luma_offset_l1[32];
1389 unsigned char chroma_weight_l1_flag;
1390 short chroma_weight_l1[32][2];
1391 short chroma_offset_l1[32][2];
1392 } VASliceParameterBufferH264;
1394 /****************************
1395 * Common encode data structures
1396 ****************************/
1399 VAEncPictureTypeIntra = 0,
1400 VAEncPictureTypePredictive = 1,
1401 VAEncPictureTypeBidirectional = 2,
1404 /* Encode Slice Parameter Buffer */
1405 typedef struct _VAEncSliceParameterBuffer
1407 unsigned int start_row_number; /* starting MB row number for this slice */
1408 unsigned int slice_height; /* slice height measured in MB */
1411 unsigned int is_intra : 1;
1412 unsigned int disable_deblocking_filter_idc : 2;
1413 unsigned int uses_long_term_ref :1;
1414 unsigned int is_long_term_ref :1;
1418 } VAEncSliceParameterBuffer;
1420 /****************************
1421 * H.264 specific encode data structures
1422 ****************************/
1424 typedef struct _VAEncSequenceParameterBufferH264Baseline
1426 unsigned char seq_parameter_set_id;
1427 unsigned char level_idc;
1428 unsigned int intra_period;
1429 unsigned int intra_idr_period;
1430 unsigned int max_num_ref_frames;
1431 unsigned int picture_width_in_mbs;
1432 unsigned int picture_height_in_mbs;
1433 unsigned int bits_per_second;
1434 unsigned int frame_rate;
1435 unsigned int initial_qp;
1436 unsigned int min_qp;
1437 unsigned int basic_unit_size;
1438 unsigned char vui_flag;
1439 } VAEncSequenceParameterBufferH264Baseline;
1441 #define H264_LAST_PICTURE_EOSEQ 0x01 /* the last picture in the sequence */
1442 #define H264_LAST_PICTURE_EOSTREAM 0x02 /* the last picture in the stream */
1443 typedef struct _VAEncPictureParameterBufferH264Baseline
1445 VASurfaceID reference_picture;
1446 VASurfaceID reconstructed_picture;
1447 VABufferID coded_buf;
1448 unsigned short picture_width;
1449 unsigned short picture_height;
1450 unsigned char last_picture;
1451 } VAEncPictureParameterBufferH264Baseline;
1453 /****************************
1454 * H.263 specific encode data structures
1455 ****************************/
1457 typedef struct _VAEncSequenceParameterBufferH263
1459 unsigned int intra_period;
1460 unsigned int bits_per_second;
1461 unsigned int frame_rate;
1462 unsigned int initial_qp;
1463 unsigned int min_qp;
1464 } VAEncSequenceParameterBufferH263;
1466 typedef struct _VAEncPictureParameterBufferH263
1468 VASurfaceID reference_picture;
1469 VASurfaceID reconstructed_picture;
1470 VABufferID coded_buf;
1471 unsigned short picture_width;
1472 unsigned short picture_height;
1473 VAEncPictureType picture_type;
1474 } VAEncPictureParameterBufferH263;
1476 /****************************
1477 * MPEG-4 specific encode data structures
1478 ****************************/
1480 typedef struct _VAEncSequenceParameterBufferMPEG4
1482 unsigned char profile_and_level_indication;
1483 unsigned int intra_period;
1484 unsigned int video_object_layer_width;
1485 unsigned int video_object_layer_height;
1486 unsigned int vop_time_increment_resolution;
1487 unsigned int fixed_vop_rate;
1488 unsigned int fixed_vop_time_increment;
1489 unsigned int bits_per_second;
1490 unsigned int frame_rate;
1491 unsigned int initial_qp;
1492 unsigned int min_qp;
1493 } VAEncSequenceParameterBufferMPEG4;
1495 typedef struct _VAEncPictureParameterBufferMPEG4
1497 VASurfaceID reference_picture;
1498 VASurfaceID reconstructed_picture;
1499 VABufferID coded_buf;
1500 unsigned short picture_width;
1501 unsigned short picture_height;
1502 unsigned int modulo_time_base; /* number of 1s */
1503 unsigned int vop_time_increment;
1504 VAEncPictureType picture_type;
1505 } VAEncPictureParameterBufferMPEG4;
1509 /* Buffer functions */
1512 * Creates a buffer for "num_elements" elements of "size" bytes and
1513 * initalize with "data".
1514 * if "data" is null, then the contents of the buffer data store
1516 * Basically there are two ways to get buffer data to the server side. One is
1517 * to call vaCreateBuffer() with a non-null "data", which results the data being
1518 * copied to the data store on the server side. A different method that
1519 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1520 * and then use vaMapBuffer() to map the data store from the server side to the
1521 * client address space for access.
1522 * Note: image buffers are created by the library, not the client. Please see
1523 * vaCreateImage on how image buffers are managed.
1525 VAStatus vaCreateBuffer (
1527 VAContextID context,
1528 VABufferType type, /* in */
1529 unsigned int size, /* in */
1530 unsigned int num_elements, /* in */
1531 void *data, /* in */
1532 VABufferID *buf_id /* out */
1536 * Convey to the server how many valid elements are in the buffer.
1537 * e.g. if multiple slice parameters are being held in a single buffer,
1538 * this will communicate to the server the number of slice parameters
1539 * that are valid in the buffer.
1541 VAStatus vaBufferSetNumElements (
1543 VABufferID buf_id, /* in */
1544 unsigned int num_elements /* in */
1549 * device independent data structure for codedbuffer
1553 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1554 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1555 * enough for the encoder to attempt to limit its size.
1556 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1557 * exceeded the maximum slice size specified.
1558 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1559 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1560 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1562 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1563 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1564 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1565 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1566 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1568 * \brief The frame has exceeded the maximum requested size.
1570 * This flag indicates that the encoded frame size exceeds the value
1571 * specified through a misc parameter buffer of type
1572 * #VAEncMiscParameterTypeMaxFrameSize.
1574 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1575 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1578 * \brief The coded buffer segment contains a single NAL unit.
1580 * This flag indicates that the coded buffer segment contains a
1581 * single NAL unit. This flag might be useful to the user for
1582 * processing the coded buffer.
1584 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1587 * \brief Coded buffer segment.
1589 * #VACodedBufferSegment is an element of a linked list describing
1590 * some information on the coded buffer. The coded buffer segment
1591 * could contain either a single NAL unit, or more than one NAL unit.
1592 * It is recommended (but not required) to return a single NAL unit
1593 * in a coded buffer segment, and the implementation should set the
1594 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1596 typedef struct _VACodedBufferSegment {
1598 * \brief Size of the data buffer in this segment (in bytes).
1600 * The size of the corresponding NAL unit can be obtained with
1601 * \c size - \c bit_offset/8.
1604 /** \brief Bit offset into the data buffer where the NAL unit starts. */
1605 unsigned int bit_offset;
1606 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1607 unsigned int status;
1608 /** \brief Reserved for future use. */
1609 unsigned int reserved;
1610 /** \brief Pointer to the start of the data buffer. */
1613 * \brief Pointer to the next #VACodedBufferSegment element,
1614 * or \c NULL if there is none.
1617 } VACodedBufferSegment;
1620 * Map data store of the buffer into the client's address space
1621 * vaCreateBuffer() needs to be called with "data" set to NULL before
1622 * calling vaMapBuffer()
1624 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1625 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1627 VAStatus vaMapBuffer (
1629 VABufferID buf_id, /* in */
1630 void **pbuf /* out */
1634 * After client making changes to a mapped data store, it needs to
1635 * "Unmap" it to let the server know that the data is ready to be
1636 * consumed by the server
1638 VAStatus vaUnmapBuffer (
1640 VABufferID buf_id /* in */
1644 * After this call, the buffer is deleted and this buffer_id is no longer valid
1645 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1647 VAStatus vaDestroyBuffer (
1649 VABufferID buffer_id
1653 Render (Decode) Pictures
1655 A picture represents either a frame or a field.
1657 The Begin/Render/End sequence sends the decode buffers to the server
1661 * Get ready to decode a picture to a target surface
1663 VAStatus vaBeginPicture (
1665 VAContextID context,
1666 VASurfaceID render_target
1670 * Send decode buffers to the server.
1671 * Buffers are automatically destroyed afterwards
1673 VAStatus vaRenderPicture (
1675 VAContextID context,
1676 VABufferID *buffers,
1681 * Make the end of rendering for a picture.
1682 * The server should start processing all pending operations for this
1683 * surface. This call is non-blocking. The client can start another
1684 * Begin/Render/End sequence on a different render target.
1686 VAStatus vaEndPicture (
1698 * This function blocks until all pending operations on the render target
1699 * have been completed. Upon return it is safe to use the render target for a
1700 * different picture.
1702 VAStatus vaSyncSurface (
1704 VASurfaceID render_target
1709 VASurfaceRendering = 1, /* Rendering in progress */
1710 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1711 /* this status is useful if surface is used as the source */
1713 VASurfaceReady = 4, /* not being rendered or displayed */
1714 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1718 * Find out any pending ops on the render target
1720 VAStatus vaQuerySurfaceStatus (
1722 VASurfaceID render_target,
1723 VASurfaceStatus *status /* out */
1728 VADecodeSliceMissing = 0,
1729 VADecodeMBError = 1,
1730 } VADecodeErrorType;
1733 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1734 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1736 typedef struct _VASurfaceDecodeMBErrors
1738 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1739 unsigned int start_mb; /* start mb address with errors */
1740 unsigned int end_mb; /* end mb address with errors */
1741 VADecodeErrorType decode_error_type;
1742 } VASurfaceDecodeMBErrors;
1745 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1746 * it can call vaQuerySurfaceError to find out further details on the particular error.
1747 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1748 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1749 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1750 * The array is terminated if "status==-1" is detected.
1752 VAStatus vaQuerySurfaceError(
1754 VASurfaceID surface,
1755 VAStatus error_status,
1760 * Images and Subpictures
1761 * VAImage is used to either get the surface data to client memory, or
1762 * to copy image data in client memory to a surface.
1763 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1764 * is at the upper left corner with positive X to the right and positive Y down
1766 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1767 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1768 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1770 /* a few common FourCCs */
1771 #define VA_FOURCC_NV12 0x3231564E
1772 #define VA_FOURCC_AI44 0x34344149
1773 #define VA_FOURCC_RGBA 0x41424752
1774 #define VA_FOURCC_BGRA 0x41524742
1775 #define VA_FOURCC_UYVY 0x59565955
1776 #define VA_FOURCC_YUY2 0x32595559
1777 #define VA_FOURCC_AYUV 0x56555941
1778 #define VA_FOURCC_NV11 0x3131564e
1779 #define VA_FOURCC_YV12 0x32315659
1780 #define VA_FOURCC_P208 0x38303250
1781 #define VA_FOURCC_IYUV 0x56555949
1784 #define VA_LSB_FIRST 1
1785 #define VA_MSB_FIRST 2
1787 typedef struct _VAImageFormat
1789 unsigned int fourcc;
1790 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1791 unsigned int bits_per_pixel;
1792 /* for RGB formats */
1793 unsigned int depth; /* significant bits per pixel */
1794 unsigned int red_mask;
1795 unsigned int green_mask;
1796 unsigned int blue_mask;
1797 unsigned int alpha_mask;
1800 typedef VAGenericID VAImageID;
1802 typedef struct _VAImage
1804 VAImageID image_id; /* uniquely identify this image */
1805 VAImageFormat format;
1806 VABufferID buf; /* image data buffer */
1808 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1809 * data store on the server side for optimal performance. The buffer will be
1810 * created by the CreateImage function, and proper storage allocated based on the image
1811 * size and format. This buffer is managed by the library implementation, and
1812 * accessed by the client through the buffer Map/Unmap functions.
1814 unsigned short width;
1815 unsigned short height;
1816 unsigned int data_size;
1817 unsigned int num_planes; /* can not be greater than 3 */
1819 * An array indicating the scanline pitch in bytes for each plane.
1820 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1822 unsigned int pitches[3];
1824 * An array indicating the byte offset from the beginning of the image data
1825 * to the start of each plane.
1827 unsigned int offsets[3];
1829 /* The following fields are only needed for paletted formats */
1830 int num_palette_entries; /* set to zero for non-palette images */
1832 * Each component is one byte and entry_bytes indicates the number of components in
1833 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1837 * An array of ascii characters describing the order of the components within the bytes.
1838 * Only entry_bytes characters of the string are used.
1840 char component_order[4];
1843 /* Get maximum number of image formats supported by the implementation */
1844 int vaMaxNumImageFormats (
1849 * Query supported image formats
1850 * The caller must provide a "format_list" array that can hold at
1851 * least vaMaxNumImageFormats() entries. The actual number of formats
1852 * returned in "format_list" is returned in "num_formats".
1854 VAStatus vaQueryImageFormats (
1856 VAImageFormat *format_list, /* out */
1857 int *num_formats /* out */
1861 * Create a VAImage structure
1862 * The width and height fields returned in the VAImage structure may get
1863 * enlarged for some YUV formats. Upon return from this function,
1864 * image->buf has been created and proper storage allocated by the library.
1865 * The client can access the image through the Map/Unmap calls.
1867 VAStatus vaCreateImage (
1869 VAImageFormat *format,
1872 VAImage *image /* out */
1876 * Should call DestroyImage before destroying the surface it is bound to
1878 VAStatus vaDestroyImage (
1883 VAStatus vaSetImagePalette (
1887 * pointer to an array holding the palette data. The size of the array is
1888 * num_palette_entries * entry_bytes in size. The order of the components
1889 * in the palette is described by the component_order in VAImage struct
1891 unsigned char *palette
1895 * Retrive surface data into a VAImage
1896 * Image must be in a format supported by the implementation
1898 VAStatus vaGetImage (
1900 VASurfaceID surface,
1901 int x, /* coordinates of the upper left source pixel */
1903 unsigned int width, /* width and height of the region */
1904 unsigned int height,
1909 * Copy data from a VAImage to a surface
1910 * Image must be in a format supported by the implementation
1911 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1912 * shouldn't be rendered into when this is called
1914 VAStatus vaPutImage (
1916 VASurfaceID surface,
1920 unsigned int src_width,
1921 unsigned int src_height,
1924 unsigned int dest_width,
1925 unsigned int dest_height
1929 * Derive an VAImage from an existing surface.
1930 * This interface will derive a VAImage and corresponding image buffer from
1931 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1932 * direct CPU access. This operation is only possible on implementations with
1933 * direct rendering capabilities and internal surface formats that can be
1934 * represented with a VAImage. When the operation is not possible this interface
1935 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1936 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1939 * Implementations should only return success when the resulting image buffer
1940 * would be useable with vaMap/Unmap.
1942 * When directly accessing a surface special care must be taken to insure
1943 * proper synchronization with the graphics hardware. Clients should call
1944 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1945 * rendering or currently being displayed by an overlay.
1947 * Additionally nothing about the contents of a surface should be assumed
1948 * following a vaPutSurface. Implementations are free to modify the surface for
1949 * scaling or subpicture blending within a call to vaPutImage.
1951 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1952 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1953 * vaGetImage with other surfaces is supported.
1955 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1956 * image and image buffer structures will be destroyed; however, the underlying
1957 * surface will remain unchanged until freed with vaDestroySurfaces.
1959 VAStatus vaDeriveImage (
1961 VASurfaceID surface,
1962 VAImage *image /* out */
1967 * Subpicture is a special type of image that can be blended
1968 * with a surface during vaPutSurface(). Subpicture can be used to render
1969 * DVD sub-titles or closed captioning text etc.
1972 typedef VAGenericID VASubpictureID;
1974 /* Get maximum number of subpicture formats supported by the implementation */
1975 int vaMaxNumSubpictureFormats (
1979 /* flags for subpictures */
1980 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
1981 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
1982 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
1984 * Query supported subpicture formats
1985 * The caller must provide a "format_list" array that can hold at
1986 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1987 * for each format to indicate additional capabilities for that format. The actual
1988 * number of formats returned in "format_list" is returned in "num_formats".
1989 * flags: returned value to indicate addtional capabilities
1990 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1991 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1992 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
1995 VAStatus vaQuerySubpictureFormats (
1997 VAImageFormat *format_list, /* out */
1998 unsigned int *flags, /* out */
1999 unsigned int *num_formats /* out */
2003 * Subpictures are created with an image associated.
2005 VAStatus vaCreateSubpicture (
2008 VASubpictureID *subpicture /* out */
2012 * Destroy the subpicture before destroying the image it is assocated to
2014 VAStatus vaDestroySubpicture (
2016 VASubpictureID subpicture
2020 * Bind an image to the subpicture. This image will now be associated with
2021 * the subpicture instead of the one at creation.
2023 VAStatus vaSetSubpictureImage (
2025 VASubpictureID subpicture,
2030 * If chromakey is enabled, then the area where the source value falls within
2031 * the chromakey [min, max] range is transparent
2032 * The chromakey component format is the following:
2033 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2034 * For YUV: [0:7] V [8:15] U [16:23] Y
2035 * The chromakey mask can be used to mask out certain components for chromakey
2038 VAStatus vaSetSubpictureChromakey (
2040 VASubpictureID subpicture,
2041 unsigned int chromakey_min,
2042 unsigned int chromakey_max,
2043 unsigned int chromakey_mask
2047 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2048 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2049 * the overall alpha is per-pixel alpha multiplied by the global alpha
2051 VAStatus vaSetSubpictureGlobalAlpha (
2053 VASubpictureID subpicture,
2058 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2059 * It defines the region mapping between the subpicture and the target
2060 * surfaces through source and destination rectangles (with the same width and height).
2061 * Both will be displayed at the next call to vaPutSurface. Additional
2062 * associations before the call to vaPutSurface simply overrides the association.
2064 VAStatus vaAssociateSubpicture (
2066 VASubpictureID subpicture,
2067 VASurfaceID *target_surfaces,
2069 short src_x, /* upper left offset in subpicture */
2071 unsigned short src_width,
2072 unsigned short src_height,
2073 short dest_x, /* upper left offset in surface */
2075 unsigned short dest_width,
2076 unsigned short dest_height,
2078 * whether to enable chroma-keying, global-alpha, or screen relative mode
2079 * see VA_SUBPICTURE_XXX values
2085 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2087 VAStatus vaDeassociateSubpicture (
2089 VASubpictureID subpicture,
2090 VASurfaceID *target_surfaces,
2094 typedef struct _VARectangle
2098 unsigned short width;
2099 unsigned short height;
2103 * Display attributes
2104 * Display attributes are used to control things such as contrast, hue, saturation,
2105 * brightness etc. in the rendering process. The application can query what
2106 * attributes are supported by the driver, and then set the appropriate attributes
2107 * before calling vaPutSurface()
2109 /* PowerVR IEP Lite attributes */
2112 VADISPLAYATTRIB_BLE_OFF = 0x00,
2113 VADISPLAYATTRIB_BLE_LOW,
2114 VADISPLAYATTRIB_BLE_MEDIUM,
2115 VADISPLAYATTRIB_BLE_HIGH,
2116 VADISPLAYATTRIB_BLE_NONE,
2117 } VADisplayAttribBLEMode;
2119 /* attribute value for VADisplayAttribRotation */
2120 #define VA_ROTATION_NONE 0x00000000
2121 #define VA_ROTATION_90 0x00000001
2122 #define VA_ROTATION_180 0x00000002
2123 #define VA_ROTATION_270 0x00000003
2125 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2126 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2127 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2130 #define VA_RENDER_MODE_UNDEFINED 0
2131 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2132 #define VA_RENDER_MODE_LOCAL_GPU 2
2133 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2134 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2137 #define VA_RENDER_DEVICE_UNDEFINED 0
2138 #define VA_RENDER_DEVICE_LOCAL 1
2139 #define VA_RENDER_DEVICE_EXTERNAL 2
2141 /* Currently defined display attribute types */
2144 VADisplayAttribBrightness = 0,
2145 VADisplayAttribContrast = 1,
2146 VADisplayAttribHue = 2,
2147 VADisplayAttribSaturation = 3,
2148 /* client can specifiy a background color for the target window
2149 * the new feature of video conference,
2150 * the uncovered area of the surface is filled by this color
2151 * also it will blend with the decoded video color
2153 VADisplayAttribBackgroundColor = 4,
2155 * this is a gettable only attribute. For some implementations that use the
2156 * hardware overlay, after PutSurface is called, the surface can not be
2157 * re-used until after the subsequent PutSurface call. If this is the case
2158 * then the value for this attribute will be set to 1 so that the client
2159 * will not attempt to re-use the surface right after returning from a call
2162 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2163 * driver may use overlay or GPU alternatively
2165 VADisplayAttribDirectSurface = 5,
2166 VADisplayAttribRotation = 6,
2167 VADisplayAttribOutofLoopDeblock = 7,
2169 /* PowerVR IEP Lite specific attributes */
2170 VADisplayAttribBLEBlackMode = 8,
2171 VADisplayAttribBLEWhiteMode = 9,
2172 VADisplayAttribBlueStretch = 10,
2173 VADisplayAttribSkinColorCorrection = 11,
2175 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2176 * conversion matrix. Each element in the matrix is float-point
2178 VADisplayAttribCSCMatrix = 12,
2179 /* specify the constant color used to blend with video surface
2180 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2181 * d: the final color to overwrite into the frame buffer
2182 * v: decoded video after color conversion,
2183 * c: video color specified by VADisplayAttribBlendColor
2184 * b: background color of the drawable
2186 VADisplayAttribBlendColor = 13,
2188 * Indicate driver to skip painting color key or not.
2189 * only applicable if the render is overlay
2191 VADisplayAttribOverlayAutoPaintColorKey = 14,
2193 * customized overlay color key, the format is RGB888
2194 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2196 VADisplayAttribOverlayColorKey = 15,
2198 * The hint for the implementation of vaPutSurface
2199 * normally, the driver could use an overlay or GPU to render the surface on the screen
2200 * this flag provides APP the flexibity to switch the render dynamically
2202 VADisplayAttribRenderMode = 16,
2204 * specify if vaPutSurface needs to render into specified monitors
2205 * one example is that one external monitor (e.g. HDMI) is enabled,
2206 * but the window manager is not aware of it, and there is no associated drawable
2208 VADisplayAttribRenderDevice = 17,
2210 * specify vaPutSurface render area if there is no drawable on the monitor
2212 VADisplayAttribRenderRect = 18,
2213 } VADisplayAttribType;
2215 /* flags for VADisplayAttribute */
2216 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2217 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2218 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2220 typedef struct _VADisplayAttribute
2222 VADisplayAttribType type;
2225 int value; /* used by the set/get attribute functions */
2226 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2228 } VADisplayAttribute;
2230 /* Get maximum number of display attributs supported by the implementation */
2231 int vaMaxNumDisplayAttributes (
2236 * Query display attributes
2237 * The caller must provide a "attr_list" array that can hold at
2238 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2239 * returned in "attr_list" is returned in "num_attributes".
2241 VAStatus vaQueryDisplayAttributes (
2243 VADisplayAttribute *attr_list, /* out */
2244 int *num_attributes /* out */
2248 * Get display attributes
2249 * This function returns the current attribute values in "attr_list".
2250 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2251 * from vaQueryDisplayAttributes() can have their values retrieved.
2253 VAStatus vaGetDisplayAttributes (
2255 VADisplayAttribute *attr_list, /* in/out */
2260 * Set display attributes
2261 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2262 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2263 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2265 VAStatus vaSetDisplayAttributes (
2267 VADisplayAttribute *attr_list,