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 } VAEncMiscParameterType;
693 /** \brief Packed header type. */
695 /** \brief Packed sequence header. */
696 VAEncPackedHeaderSequence = 1,
697 /** \brief Packed picture header. */
698 VAEncPackedHeaderPicture = 2,
699 /** \brief Packed slice header. */
700 VAEncPackedHeaderSlice = 3,
701 /** \brief Misc packed header. See codec-specific definitions. */
702 VAEncPackedHeaderMiscMask = 0x80000000,
703 } VAEncPackedHeaderType;
705 /** \brief Packed header parameter. */
706 typedef struct _VAEncPackedHeaderParameterBuffer {
707 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
709 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
710 unsigned int bit_length;
711 /** \brief Flag: buffer contains start code emulation prevention bytes? */
712 unsigned char has_emulation_bytes;
713 } VAEncPackedHeaderParameterBuffer;
716 * For application, e.g. set a new bitrate
718 * VAEncMiscParameterBuffer *misc_param;
719 * VAEncMiscParameterRateControl *misc_rate_ctrl;
721 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
722 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
725 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
726 * misc_param->type = VAEncMiscParameterTypeRateControl;
727 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
728 * misc_rate_ctrl->bits_per_second = 6400000;
729 * vaUnmapBuffer(dpy, buf_id);
730 * vaRenderPicture(dpy, context, &buf_id, 1);
732 typedef struct _VAEncMiscParameterBuffer
734 VAEncMiscParameterType type;
735 unsigned int data[0];
736 } VAEncMiscParameterBuffer;
738 typedef struct _VAEncMiscParameterRateControl
740 unsigned int bits_per_second; /* this is the maximum bit-rate to be constrained by the rate control implementation */
741 unsigned int target_percentage; /* this is the bit-rate the rate control is targeting, as a percentage of the maximum bit-rate */
742 /* for example if target_percentage is 95 then the rate control will target a bit-rate that is */
743 /* 95% of the maximum bit-rate */
744 unsigned int window_size; /* windows size in milliseconds. For example if this is set to 500, then the rate control will guarantee the */
745 /* target bit-rate over a 500 ms window */
746 unsigned int initial_qp; /* initial QP at I frames */
748 } VAEncMiscParameterRateControl;
750 typedef struct _VAEncMiscParameterFrameRate
752 unsigned int framerate;
753 } VAEncMiscParameterFrameRate;
756 * Allow a maximum slice size to be specified (in bits).
757 * The encoder will attempt to make sure that individual slices do not exceed this size
758 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
760 typedef struct _VAEncMiscParameterMaxSliceSize
762 unsigned int max_slice_size;
763 } VAEncMiscParameterMaxSliceSize;
765 typedef struct _VAEncMiscParameterAIR
767 unsigned int air_num_mbs;
768 unsigned int air_threshold;
769 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
770 } VAEncMiscParameterAIR;
773 * \brief Defines a maximum frame size (in bits).
775 * This misc parameter buffer defines the maximum size of a frame (in
776 * bits). The encoder will try to make sure that each frame does not
777 * exceed this size. Otherwise, if the frame size exceeds this size,
778 * the \c status flag of #VACodedBufferSegment will contain
779 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
781 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
782 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
783 VAEncMiscParameterType type;
784 /** \brief Maximum size of a frame (in bits). */
785 unsigned int max_frame_size;
786 } VAEncMiscParameterBufferMaxFrameSize;
789 * There will be cases where the bitstream buffer will not have enough room to hold
790 * the data for the entire slice, and the following flags will be used in the slice
791 * parameter to signal to the server for the possible cases.
792 * If a slice parameter buffer and slice data buffer pair is sent to the server with
793 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
794 * then a slice parameter and data buffer needs to be sent again to complete this slice.
796 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
797 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
798 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
799 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
801 /* Codec-independent Slice Parameter Buffer base */
802 typedef struct _VASliceParameterBufferBase
804 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
805 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
806 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
807 } VASliceParameterBufferBase;
810 /****************************
811 * JEPG data structure
812 ***************************/
813 typedef struct _VAQMatrixBufferJPEG
815 int load_lum_quantiser_matrix;
816 int load_chroma_quantiser_matrix;
817 unsigned char lum_quantiser_matrix[64];
818 unsigned char chroma_quantiser_matrix[64];
819 } VAQMatrixBufferJPEG;
821 typedef struct _VAEncPictureParameterBufferJPEG
823 VASurfaceID reconstructed_picture;
824 unsigned short picture_width;
825 unsigned short picture_height;
826 VABufferID coded_buf;
827 } VAEncPictureParameterBufferJPEG;
829 #include <va/va_dec_jpeg.h>
831 /****************************
832 * MPEG-2 data structures
833 ****************************/
835 /* MPEG-2 Picture Parameter Buffer */
837 * For each frame or field, and before any slice data, a single
838 * picture parameter buffer must be send.
840 typedef struct _VAPictureParameterBufferMPEG2
842 unsigned short horizontal_size;
843 unsigned short vertical_size;
844 VASurfaceID forward_reference_picture;
845 VASurfaceID backward_reference_picture;
846 /* meanings of the following fields are the same as in the standard */
847 int picture_coding_type;
848 int f_code; /* pack all four fcode into this */
851 unsigned int intra_dc_precision : 2;
852 unsigned int picture_structure : 2;
853 unsigned int top_field_first : 1;
854 unsigned int frame_pred_frame_dct : 1;
855 unsigned int concealment_motion_vectors : 1;
856 unsigned int q_scale_type : 1;
857 unsigned int intra_vlc_format : 1;
858 unsigned int alternate_scan : 1;
859 unsigned int repeat_first_field : 1;
860 unsigned int progressive_frame : 1;
861 unsigned int is_first_field : 1; /* indicate whether the current field
862 * is the first field for field picture
866 } picture_coding_extension;
867 } VAPictureParameterBufferMPEG2;
869 /* MPEG-2 Inverse Quantization Matrix Buffer */
870 typedef struct _VAIQMatrixBufferMPEG2
872 int load_intra_quantiser_matrix;
873 int load_non_intra_quantiser_matrix;
874 int load_chroma_intra_quantiser_matrix;
875 int load_chroma_non_intra_quantiser_matrix;
876 unsigned char intra_quantiser_matrix[64];
877 unsigned char non_intra_quantiser_matrix[64];
878 unsigned char chroma_intra_quantiser_matrix[64];
879 unsigned char chroma_non_intra_quantiser_matrix[64];
880 } VAIQMatrixBufferMPEG2;
882 /* MPEG-2 Slice Parameter Buffer */
883 typedef struct _VASliceParameterBufferMPEG2
885 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
886 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
887 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
888 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
889 unsigned int slice_horizontal_position;
890 unsigned int slice_vertical_position;
891 int quantiser_scale_code;
892 int intra_slice_flag;
893 } VASliceParameterBufferMPEG2;
895 /* MPEG-2 Macroblock Parameter Buffer */
896 typedef struct _VAMacroblockParameterBufferMPEG2
898 unsigned short macroblock_address;
900 * macroblock_address (in raster scan order)
902 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
904 unsigned char macroblock_type; /* see definition below */
907 unsigned int frame_motion_type : 2;
908 unsigned int field_motion_type : 2;
909 unsigned int dct_type : 1;
913 unsigned char motion_vertical_field_select;
915 * motion_vertical_field_select:
916 * see section 6.3.17.2 in the spec
917 * only the lower 4 bits are used
918 * bit 0: first vector forward
919 * bit 1: first vector backward
920 * bit 2: second vector forward
921 * bit 3: second vector backward
923 short PMV[2][2][2]; /* see Table 7-7 in the spec */
924 unsigned short coded_block_pattern;
926 * The bitplanes for coded_block_pattern are described
927 * in Figure 6.10-12 in the spec
930 /* Number of skipped macroblocks after this macroblock */
931 unsigned short num_skipped_macroblocks;
932 } VAMacroblockParameterBufferMPEG2;
935 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
937 #define VA_MB_TYPE_MOTION_FORWARD 0x02
938 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
939 #define VA_MB_TYPE_MOTION_PATTERN 0x08
940 #define VA_MB_TYPE_MOTION_INTRA 0x10
943 * MPEG-2 Residual Data Buffer
944 * For each macroblock, there wil be 64 shorts (16-bit) in the
945 * residual data buffer
948 /****************************
949 * MPEG-4 Part 2 data structures
950 ****************************/
952 /* MPEG-4 Picture Parameter Buffer */
954 * For each frame or field, and before any slice data, a single
955 * picture parameter buffer must be send.
957 typedef struct _VAPictureParameterBufferMPEG4
959 unsigned short vop_width;
960 unsigned short vop_height;
961 VASurfaceID forward_reference_picture;
962 VASurfaceID backward_reference_picture;
965 unsigned int short_video_header : 1;
966 unsigned int chroma_format : 2;
967 unsigned int interlaced : 1;
968 unsigned int obmc_disable : 1;
969 unsigned int sprite_enable : 2;
970 unsigned int sprite_warping_accuracy : 2;
971 unsigned int quant_type : 1;
972 unsigned int quarter_sample : 1;
973 unsigned int data_partitioned : 1;
974 unsigned int reversible_vlc : 1;
975 unsigned int resync_marker_disable : 1;
979 unsigned char no_of_sprite_warping_points;
980 short sprite_trajectory_du[3];
981 short sprite_trajectory_dv[3];
982 unsigned char quant_precision;
985 unsigned int vop_coding_type : 2;
986 unsigned int backward_reference_vop_coding_type : 2;
987 unsigned int vop_rounding_type : 1;
988 unsigned int intra_dc_vlc_thr : 3;
989 unsigned int top_field_first : 1;
990 unsigned int alternate_vertical_scan_flag : 1;
994 unsigned char vop_fcode_forward;
995 unsigned char vop_fcode_backward;
996 unsigned short vop_time_increment_resolution;
997 /* short header related */
998 unsigned char num_gobs_in_vop;
999 unsigned char num_macroblocks_in_gob;
1000 /* for direct mode prediction */
1003 } VAPictureParameterBufferMPEG4;
1005 /* MPEG-4 Inverse Quantization Matrix Buffer */
1006 typedef struct _VAIQMatrixBufferMPEG4
1008 int load_intra_quant_mat;
1009 int load_non_intra_quant_mat;
1010 unsigned char intra_quant_mat[64];
1011 unsigned char non_intra_quant_mat[64];
1012 } VAIQMatrixBufferMPEG4;
1014 /* MPEG-4 Slice Parameter Buffer */
1015 typedef struct _VASliceParameterBufferMPEG4
1017 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1018 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1019 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1020 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1021 unsigned int macroblock_number;
1023 } VASliceParameterBufferMPEG4;
1026 VC-1 data structures
1029 typedef enum /* see 7.1.1.32 */
1032 VAMvMode1MvHalfPel = 1,
1033 VAMvMode1MvHalfPelBilinear = 2,
1034 VAMvModeMixedMv = 3,
1035 VAMvModeIntensityCompensation = 4
1038 /* VC-1 Picture Parameter Buffer */
1040 * For each picture, and before any slice data, a picture parameter
1041 * buffer must be send. Multiple picture parameter buffers may be
1042 * sent for a single picture. In that case picture parameters will
1043 * apply to all slice data that follow it until a new picture
1044 * parameter buffer is sent.
1047 * pic_quantizer_type should be set to the applicable quantizer
1048 * type as defined by QUANTIZER (J.1.19) and either
1049 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1051 typedef struct _VAPictureParameterBufferVC1
1053 VASurfaceID forward_reference_picture;
1054 VASurfaceID backward_reference_picture;
1055 /* if out-of-loop post-processing is done on the render
1056 target, then we need to keep the in-loop decoded
1057 picture as a reference picture */
1058 VASurfaceID inloop_decoded_picture;
1060 /* sequence layer for AP or meta data for SP and MP */
1063 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1064 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1065 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1066 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1067 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1068 unsigned int multires : 1; /* METADATA::MULTIRES */
1069 unsigned int overlap : 1; /* METADATA::OVERLAP */
1070 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1071 unsigned int rangered : 1; /* METADATA::RANGERED */
1072 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1073 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1078 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1079 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1082 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1083 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1084 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1085 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1088 } entrypoint_fields;
1089 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1090 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1093 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1094 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1095 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1096 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1099 } range_mapping_fields;
1101 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1102 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1103 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1104 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1105 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1106 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1107 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1108 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1109 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1112 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1113 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1114 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1115 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1116 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1122 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1123 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1124 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1125 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1126 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1127 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1128 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1134 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1135 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1136 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1137 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1138 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1139 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1140 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1143 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1146 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1147 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1148 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1149 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1155 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1156 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1157 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1158 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1159 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1160 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1161 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1162 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1163 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1164 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1170 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1171 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1172 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1173 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1174 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1175 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1176 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1177 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1178 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1179 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1180 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1183 } pic_quantizer_fields;
1186 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1187 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1188 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1189 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1190 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1191 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1195 } VAPictureParameterBufferVC1;
1197 /* VC-1 Bitplane Buffer
1198 There will be at most three bitplanes coded in any picture header. To send
1199 the bitplane data more efficiently, each byte is divided in two nibbles, with
1200 each nibble carrying three bitplanes for one macroblock. The following table
1201 shows the bitplane data arrangement within each nibble based on the picture
1204 Picture Type Bit3 Bit2 Bit1 Bit0
1205 I or BI OVERFLAGS ACPRED FIELDTX
1206 P MYTYPEMB SKIPMB DIRECTMB
1207 B FORWARDMB SKIPMB DIRECTMB
1209 Within each byte, the lower nibble is for the first MB and the upper nibble is
1210 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1211 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1212 Macroblock #2 in the first row.
1215 /* VC-1 Slice Parameter Buffer */
1216 typedef struct _VASliceParameterBufferVC1
1218 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1219 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1220 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1221 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1222 unsigned int slice_vertical_position;
1223 } VASliceParameterBufferVC1;
1225 /* VC-1 Slice Data Buffer */
1227 This is simplely a buffer containing raw bit-stream bytes
1230 /****************************
1231 * H.264/AVC data structures
1232 ****************************/
1234 typedef struct _VAPictureH264
1236 VASurfaceID picture_id;
1237 unsigned int frame_idx;
1239 signed int TopFieldOrderCnt;
1240 signed int BottomFieldOrderCnt;
1242 /* flags in VAPictureH264 could be OR of the following */
1243 #define VA_PICTURE_H264_INVALID 0x00000001
1244 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1245 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1246 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1247 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1249 /* H.264 Picture Parameter Buffer */
1251 * For each picture, and before any slice data, a single
1252 * picture parameter buffer must be send.
1254 typedef struct _VAPictureParameterBufferH264
1256 VAPictureH264 CurrPic;
1257 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1258 unsigned short picture_width_in_mbs_minus1;
1259 unsigned short picture_height_in_mbs_minus1;
1260 unsigned char bit_depth_luma_minus8;
1261 unsigned char bit_depth_chroma_minus8;
1262 unsigned char num_ref_frames;
1265 unsigned int chroma_format_idc : 2;
1266 unsigned int residual_colour_transform_flag : 1;
1267 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1268 unsigned int frame_mbs_only_flag : 1;
1269 unsigned int mb_adaptive_frame_field_flag : 1;
1270 unsigned int direct_8x8_inference_flag : 1;
1271 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1272 unsigned int log2_max_frame_num_minus4 : 4;
1273 unsigned int pic_order_cnt_type : 2;
1274 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1275 unsigned int delta_pic_order_always_zero_flag : 1;
1279 unsigned char num_slice_groups_minus1;
1280 unsigned char slice_group_map_type;
1281 unsigned short slice_group_change_rate_minus1;
1282 signed char pic_init_qp_minus26;
1283 signed char pic_init_qs_minus26;
1284 signed char chroma_qp_index_offset;
1285 signed char second_chroma_qp_index_offset;
1288 unsigned int entropy_coding_mode_flag : 1;
1289 unsigned int weighted_pred_flag : 1;
1290 unsigned int weighted_bipred_idc : 2;
1291 unsigned int transform_8x8_mode_flag : 1;
1292 unsigned int field_pic_flag : 1;
1293 unsigned int constrained_intra_pred_flag : 1;
1294 unsigned int pic_order_present_flag : 1;
1295 unsigned int deblocking_filter_control_present_flag : 1;
1296 unsigned int redundant_pic_cnt_present_flag : 1;
1297 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1301 unsigned short frame_num;
1302 } VAPictureParameterBufferH264;
1304 /* H.264 Inverse Quantization Matrix Buffer */
1305 typedef struct _VAIQMatrixBufferH264
1307 unsigned char ScalingList4x4[6][16];
1308 unsigned char ScalingList8x8[2][64];
1309 } VAIQMatrixBufferH264;
1312 * H.264 Slice Group Map Buffer
1313 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1314 * A slice group map buffer should be sent for each picture if required. The buffer
1315 * is sent only when there is a change in the mapping values.
1316 * The slice group map buffer map "map units" to slice groups as specified in
1317 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1318 * in raster scan order
1321 /* H.264 Slice Parameter Buffer */
1322 typedef struct _VASliceParameterBufferH264
1324 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1325 /** \brief Byte offset to the NAL Header Unit for this slice. */
1326 unsigned int slice_data_offset;
1327 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1329 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1331 * This bit offset is relative to and includes the NAL unit byte
1332 * and represents the number of bits parsed in the slice_header()
1333 * after the removal of any emulation prevention bytes in
1334 * there. However, the slice data buffer passed to the hardware is
1335 * the original bitstream, thus including any emulation prevention
1338 unsigned short slice_data_bit_offset;
1339 unsigned short first_mb_in_slice;
1340 unsigned char slice_type;
1341 unsigned char direct_spatial_mv_pred_flag;
1342 unsigned char num_ref_idx_l0_active_minus1;
1343 unsigned char num_ref_idx_l1_active_minus1;
1344 unsigned char cabac_init_idc;
1345 char slice_qp_delta;
1346 unsigned char disable_deblocking_filter_idc;
1347 char slice_alpha_c0_offset_div2;
1348 char slice_beta_offset_div2;
1349 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1350 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1351 unsigned char luma_log2_weight_denom;
1352 unsigned char chroma_log2_weight_denom;
1353 unsigned char luma_weight_l0_flag;
1354 short luma_weight_l0[32];
1355 short luma_offset_l0[32];
1356 unsigned char chroma_weight_l0_flag;
1357 short chroma_weight_l0[32][2];
1358 short chroma_offset_l0[32][2];
1359 unsigned char luma_weight_l1_flag;
1360 short luma_weight_l1[32];
1361 short luma_offset_l1[32];
1362 unsigned char chroma_weight_l1_flag;
1363 short chroma_weight_l1[32][2];
1364 short chroma_offset_l1[32][2];
1365 } VASliceParameterBufferH264;
1367 /****************************
1368 * Common encode data structures
1369 ****************************/
1372 VAEncPictureTypeIntra = 0,
1373 VAEncPictureTypePredictive = 1,
1374 VAEncPictureTypeBidirectional = 2,
1377 /* Encode Slice Parameter Buffer */
1378 typedef struct _VAEncSliceParameterBuffer
1380 unsigned int start_row_number; /* starting MB row number for this slice */
1381 unsigned int slice_height; /* slice height measured in MB */
1384 unsigned int is_intra : 1;
1385 unsigned int disable_deblocking_filter_idc : 2;
1386 unsigned int uses_long_term_ref :1;
1387 unsigned int is_long_term_ref :1;
1391 } VAEncSliceParameterBuffer;
1393 /****************************
1394 * H.264 specific encode data structures
1395 ****************************/
1397 typedef struct _VAEncSequenceParameterBufferH264Baseline
1399 unsigned char seq_parameter_set_id;
1400 unsigned char level_idc;
1401 unsigned int intra_period;
1402 unsigned int intra_idr_period;
1403 unsigned int max_num_ref_frames;
1404 unsigned int picture_width_in_mbs;
1405 unsigned int picture_height_in_mbs;
1406 unsigned int bits_per_second;
1407 unsigned int frame_rate;
1408 unsigned int initial_qp;
1409 unsigned int min_qp;
1410 unsigned int basic_unit_size;
1411 unsigned char vui_flag;
1412 } VAEncSequenceParameterBufferH264Baseline;
1414 #define H264_LAST_PICTURE_EOSEQ 0x01 /* the last picture in the sequence */
1415 #define H264_LAST_PICTURE_EOSTREAM 0x02 /* the last picture in the stream */
1416 typedef struct _VAEncPictureParameterBufferH264Baseline
1418 VASurfaceID reference_picture;
1419 VASurfaceID reconstructed_picture;
1420 VABufferID coded_buf;
1421 unsigned short picture_width;
1422 unsigned short picture_height;
1423 unsigned char last_picture;
1424 } VAEncPictureParameterBufferH264Baseline;
1426 /****************************
1427 * H.263 specific encode data structures
1428 ****************************/
1430 typedef struct _VAEncSequenceParameterBufferH263
1432 unsigned int intra_period;
1433 unsigned int bits_per_second;
1434 unsigned int frame_rate;
1435 unsigned int initial_qp;
1436 unsigned int min_qp;
1437 } VAEncSequenceParameterBufferH263;
1439 typedef struct _VAEncPictureParameterBufferH263
1441 VASurfaceID reference_picture;
1442 VASurfaceID reconstructed_picture;
1443 VABufferID coded_buf;
1444 unsigned short picture_width;
1445 unsigned short picture_height;
1446 VAEncPictureType picture_type;
1447 } VAEncPictureParameterBufferH263;
1449 /****************************
1450 * MPEG-4 specific encode data structures
1451 ****************************/
1453 typedef struct _VAEncSequenceParameterBufferMPEG4
1455 unsigned char profile_and_level_indication;
1456 unsigned int intra_period;
1457 unsigned int video_object_layer_width;
1458 unsigned int video_object_layer_height;
1459 unsigned int vop_time_increment_resolution;
1460 unsigned int fixed_vop_rate;
1461 unsigned int fixed_vop_time_increment;
1462 unsigned int bits_per_second;
1463 unsigned int frame_rate;
1464 unsigned int initial_qp;
1465 unsigned int min_qp;
1466 } VAEncSequenceParameterBufferMPEG4;
1468 typedef struct _VAEncPictureParameterBufferMPEG4
1470 VASurfaceID reference_picture;
1471 VASurfaceID reconstructed_picture;
1472 VABufferID coded_buf;
1473 unsigned short picture_width;
1474 unsigned short picture_height;
1475 unsigned int modulo_time_base; /* number of 1s */
1476 unsigned int vop_time_increment;
1477 VAEncPictureType picture_type;
1478 } VAEncPictureParameterBufferMPEG4;
1482 /* Buffer functions */
1485 * Creates a buffer for "num_elements" elements of "size" bytes and
1486 * initalize with "data".
1487 * if "data" is null, then the contents of the buffer data store
1489 * Basically there are two ways to get buffer data to the server side. One is
1490 * to call vaCreateBuffer() with a non-null "data", which results the data being
1491 * copied to the data store on the server side. A different method that
1492 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1493 * and then use vaMapBuffer() to map the data store from the server side to the
1494 * client address space for access.
1495 * Note: image buffers are created by the library, not the client. Please see
1496 * vaCreateImage on how image buffers are managed.
1498 VAStatus vaCreateBuffer (
1500 VAContextID context,
1501 VABufferType type, /* in */
1502 unsigned int size, /* in */
1503 unsigned int num_elements, /* in */
1504 void *data, /* in */
1505 VABufferID *buf_id /* out */
1509 * Convey to the server how many valid elements are in the buffer.
1510 * e.g. if multiple slice parameters are being held in a single buffer,
1511 * this will communicate to the server the number of slice parameters
1512 * that are valid in the buffer.
1514 VAStatus vaBufferSetNumElements (
1516 VABufferID buf_id, /* in */
1517 unsigned int num_elements /* in */
1522 * device independent data structure for codedbuffer
1526 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1527 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1528 * enough for the encoder to attempt to limit its size.
1529 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1530 * exceeded the maximum slice size specified.
1531 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1532 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1533 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1535 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1536 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1537 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1538 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1539 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1541 * \brief The frame has exceeded the maximum requested size.
1543 * This flag indicates that the encoded frame size exceeds the value
1544 * specified through a misc parameter buffer of type
1545 * #VAEncMiscParameterTypeMaxFrameSize.
1547 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1548 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1551 * \brief Coded buffer segment.
1553 * #VACodedBufferSegment is an element of a linked list describing
1554 * some information on the coded buffer. The size of the linked list
1555 * shall be equal to the number of returned NAL units. That is, there
1556 * shall be as many coded buffer segments as NAL units.
1558 typedef struct _VACodedBufferSegment {
1560 * \brief Size of the data buffer in this segment (in bytes).
1562 * The size of the corresponding NAL unit can be obtained with
1563 * \c size - \c bit_offset/8.
1566 /** \brief Bit offset into the data buffer where the NAL unit starts. */
1567 unsigned int bit_offset;
1568 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1569 unsigned int status;
1570 /** \brief Reserved for future use. */
1571 unsigned int reserved;
1572 /** \brief Pointer to the start of the data buffer. */
1575 * \brief Pointer to the next #VACodedBufferSegment element,
1576 * or \c NULL if there is none.
1579 } VACodedBufferSegment;
1582 * Map data store of the buffer into the client's address space
1583 * vaCreateBuffer() needs to be called with "data" set to NULL before
1584 * calling vaMapBuffer()
1586 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1587 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1589 VAStatus vaMapBuffer (
1591 VABufferID buf_id, /* in */
1592 void **pbuf /* out */
1596 * After client making changes to a mapped data store, it needs to
1597 * "Unmap" it to let the server know that the data is ready to be
1598 * consumed by the server
1600 VAStatus vaUnmapBuffer (
1602 VABufferID buf_id /* in */
1606 * After this call, the buffer is deleted and this buffer_id is no longer valid
1607 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1609 VAStatus vaDestroyBuffer (
1611 VABufferID buffer_id
1615 Render (Decode) Pictures
1617 A picture represents either a frame or a field.
1619 The Begin/Render/End sequence sends the decode buffers to the server
1623 * Get ready to decode a picture to a target surface
1625 VAStatus vaBeginPicture (
1627 VAContextID context,
1628 VASurfaceID render_target
1632 * Send decode buffers to the server.
1633 * Buffers are automatically destroyed afterwards
1635 VAStatus vaRenderPicture (
1637 VAContextID context,
1638 VABufferID *buffers,
1643 * Make the end of rendering for a picture.
1644 * The server should start processing all pending operations for this
1645 * surface. This call is non-blocking. The client can start another
1646 * Begin/Render/End sequence on a different render target.
1648 VAStatus vaEndPicture (
1660 * This function blocks until all pending operations on the render target
1661 * have been completed. Upon return it is safe to use the render target for a
1662 * different picture.
1664 VAStatus vaSyncSurface (
1666 VASurfaceID render_target
1671 VASurfaceRendering = 1, /* Rendering in progress */
1672 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1673 /* this status is useful if surface is used as the source */
1675 VASurfaceReady = 4, /* not being rendered or displayed */
1676 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1680 * Find out any pending ops on the render target
1682 VAStatus vaQuerySurfaceStatus (
1684 VASurfaceID render_target,
1685 VASurfaceStatus *status /* out */
1690 VADecodeSliceMissing = 0,
1691 VADecodeMBError = 1,
1692 } VADecodeErrorType;
1695 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1696 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1698 typedef struct _VASurfaceDecodeMBErrors
1700 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1701 unsigned int start_mb; /* start mb address with errors */
1702 unsigned int end_mb; /* end mb address with errors */
1703 VADecodeErrorType decode_error_type;
1704 } VASurfaceDecodeMBErrors;
1707 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1708 * it can call vaQuerySurfaceError to find out further details on the particular error.
1709 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1710 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1711 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1712 * The array is terminated if "status==-1" is detected.
1714 VAStatus vaQuerySurfaceError(
1716 VASurfaceID surface,
1717 VAStatus error_status,
1722 * Images and Subpictures
1723 * VAImage is used to either get the surface data to client memory, or
1724 * to copy image data in client memory to a surface.
1725 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1726 * is at the upper left corner with positive X to the right and positive Y down
1728 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1729 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1730 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1732 /* a few common FourCCs */
1733 #define VA_FOURCC_NV12 0x3231564E
1734 #define VA_FOURCC_AI44 0x34344149
1735 #define VA_FOURCC_RGBA 0x41424752
1736 #define VA_FOURCC_BGRA 0x41524742
1737 #define VA_FOURCC_UYVY 0x59565955
1738 #define VA_FOURCC_YUY2 0x32595559
1739 #define VA_FOURCC_AYUV 0x56555941
1740 #define VA_FOURCC_NV11 0x3131564e
1741 #define VA_FOURCC_YV12 0x32315659
1742 #define VA_FOURCC_P208 0x38303250
1743 #define VA_FOURCC_IYUV 0x56555949
1746 #define VA_LSB_FIRST 1
1747 #define VA_MSB_FIRST 2
1749 typedef struct _VAImageFormat
1751 unsigned int fourcc;
1752 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1753 unsigned int bits_per_pixel;
1754 /* for RGB formats */
1755 unsigned int depth; /* significant bits per pixel */
1756 unsigned int red_mask;
1757 unsigned int green_mask;
1758 unsigned int blue_mask;
1759 unsigned int alpha_mask;
1762 typedef VAGenericID VAImageID;
1764 typedef struct _VAImage
1766 VAImageID image_id; /* uniquely identify this image */
1767 VAImageFormat format;
1768 VABufferID buf; /* image data buffer */
1770 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1771 * data store on the server side for optimal performance. The buffer will be
1772 * created by the CreateImage function, and proper storage allocated based on the image
1773 * size and format. This buffer is managed by the library implementation, and
1774 * accessed by the client through the buffer Map/Unmap functions.
1776 unsigned short width;
1777 unsigned short height;
1778 unsigned int data_size;
1779 unsigned int num_planes; /* can not be greater than 3 */
1781 * An array indicating the scanline pitch in bytes for each plane.
1782 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1784 unsigned int pitches[3];
1786 * An array indicating the byte offset from the beginning of the image data
1787 * to the start of each plane.
1789 unsigned int offsets[3];
1791 /* The following fields are only needed for paletted formats */
1792 int num_palette_entries; /* set to zero for non-palette images */
1794 * Each component is one byte and entry_bytes indicates the number of components in
1795 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1799 * An array of ascii characters describing the order of the components within the bytes.
1800 * Only entry_bytes characters of the string are used.
1802 char component_order[4];
1805 /* Get maximum number of image formats supported by the implementation */
1806 int vaMaxNumImageFormats (
1811 * Query supported image formats
1812 * The caller must provide a "format_list" array that can hold at
1813 * least vaMaxNumImageFormats() entries. The actual number of formats
1814 * returned in "format_list" is returned in "num_formats".
1816 VAStatus vaQueryImageFormats (
1818 VAImageFormat *format_list, /* out */
1819 int *num_formats /* out */
1823 * Create a VAImage structure
1824 * The width and height fields returned in the VAImage structure may get
1825 * enlarged for some YUV formats. Upon return from this function,
1826 * image->buf has been created and proper storage allocated by the library.
1827 * The client can access the image through the Map/Unmap calls.
1829 VAStatus vaCreateImage (
1831 VAImageFormat *format,
1834 VAImage *image /* out */
1838 * Should call DestroyImage before destroying the surface it is bound to
1840 VAStatus vaDestroyImage (
1845 VAStatus vaSetImagePalette (
1849 * pointer to an array holding the palette data. The size of the array is
1850 * num_palette_entries * entry_bytes in size. The order of the components
1851 * in the palette is described by the component_order in VAImage struct
1853 unsigned char *palette
1857 * Retrive surface data into a VAImage
1858 * Image must be in a format supported by the implementation
1860 VAStatus vaGetImage (
1862 VASurfaceID surface,
1863 int x, /* coordinates of the upper left source pixel */
1865 unsigned int width, /* width and height of the region */
1866 unsigned int height,
1871 * Copy data from a VAImage to a surface
1872 * Image must be in a format supported by the implementation
1873 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1874 * shouldn't be rendered into when this is called
1876 VAStatus vaPutImage (
1878 VASurfaceID surface,
1882 unsigned int src_width,
1883 unsigned int src_height,
1886 unsigned int dest_width,
1887 unsigned int dest_height
1891 * Derive an VAImage from an existing surface.
1892 * This interface will derive a VAImage and corresponding image buffer from
1893 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1894 * direct CPU access. This operation is only possible on implementations with
1895 * direct rendering capabilities and internal surface formats that can be
1896 * represented with a VAImage. When the operation is not possible this interface
1897 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1898 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1901 * Implementations should only return success when the resulting image buffer
1902 * would be useable with vaMap/Unmap.
1904 * When directly accessing a surface special care must be taken to insure
1905 * proper synchronization with the graphics hardware. Clients should call
1906 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1907 * rendering or currently being displayed by an overlay.
1909 * Additionally nothing about the contents of a surface should be assumed
1910 * following a vaPutSurface. Implementations are free to modify the surface for
1911 * scaling or subpicture blending within a call to vaPutImage.
1913 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1914 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1915 * vaGetImage with other surfaces is supported.
1917 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1918 * image and image buffer structures will be destroyed; however, the underlying
1919 * surface will remain unchanged until freed with vaDestroySurfaces.
1921 VAStatus vaDeriveImage (
1923 VASurfaceID surface,
1924 VAImage *image /* out */
1929 * Subpicture is a special type of image that can be blended
1930 * with a surface during vaPutSurface(). Subpicture can be used to render
1931 * DVD sub-titles or closed captioning text etc.
1934 typedef VAGenericID VASubpictureID;
1936 /* Get maximum number of subpicture formats supported by the implementation */
1937 int vaMaxNumSubpictureFormats (
1941 /* flags for subpictures */
1942 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
1943 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
1944 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
1946 * Query supported subpicture formats
1947 * The caller must provide a "format_list" array that can hold at
1948 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1949 * for each format to indicate additional capabilities for that format. The actual
1950 * number of formats returned in "format_list" is returned in "num_formats".
1951 * flags: returned value to indicate addtional capabilities
1952 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1953 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1954 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
1957 VAStatus vaQuerySubpictureFormats (
1959 VAImageFormat *format_list, /* out */
1960 unsigned int *flags, /* out */
1961 unsigned int *num_formats /* out */
1965 * Subpictures are created with an image associated.
1967 VAStatus vaCreateSubpicture (
1970 VASubpictureID *subpicture /* out */
1974 * Destroy the subpicture before destroying the image it is assocated to
1976 VAStatus vaDestroySubpicture (
1978 VASubpictureID subpicture
1982 * Bind an image to the subpicture. This image will now be associated with
1983 * the subpicture instead of the one at creation.
1985 VAStatus vaSetSubpictureImage (
1987 VASubpictureID subpicture,
1992 * If chromakey is enabled, then the area where the source value falls within
1993 * the chromakey [min, max] range is transparent
1994 * The chromakey component format is the following:
1995 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
1996 * For YUV: [0:7] V [8:15] U [16:23] Y
1997 * The chromakey mask can be used to mask out certain components for chromakey
2000 VAStatus vaSetSubpictureChromakey (
2002 VASubpictureID subpicture,
2003 unsigned int chromakey_min,
2004 unsigned int chromakey_max,
2005 unsigned int chromakey_mask
2009 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2010 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2011 * the overall alpha is per-pixel alpha multiplied by the global alpha
2013 VAStatus vaSetSubpictureGlobalAlpha (
2015 VASubpictureID subpicture,
2020 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2021 * It defines the region mapping between the subpicture and the target
2022 * surfaces through source and destination rectangles (with the same width and height).
2023 * Both will be displayed at the next call to vaPutSurface. Additional
2024 * associations before the call to vaPutSurface simply overrides the association.
2026 VAStatus vaAssociateSubpicture (
2028 VASubpictureID subpicture,
2029 VASurfaceID *target_surfaces,
2031 short src_x, /* upper left offset in subpicture */
2033 unsigned short src_width,
2034 unsigned short src_height,
2035 short dest_x, /* upper left offset in surface */
2037 unsigned short dest_width,
2038 unsigned short dest_height,
2040 * whether to enable chroma-keying, global-alpha, or screen relative mode
2041 * see VA_SUBPICTURE_XXX values
2047 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2049 VAStatus vaDeassociateSubpicture (
2051 VASubpictureID subpicture,
2052 VASurfaceID *target_surfaces,
2056 typedef struct _VARectangle
2060 unsigned short width;
2061 unsigned short height;
2065 * Display attributes
2066 * Display attributes are used to control things such as contrast, hue, saturation,
2067 * brightness etc. in the rendering process. The application can query what
2068 * attributes are supported by the driver, and then set the appropriate attributes
2069 * before calling vaPutSurface()
2071 /* PowerVR IEP Lite attributes */
2074 VADISPLAYATTRIB_BLE_OFF = 0x00,
2075 VADISPLAYATTRIB_BLE_LOW,
2076 VADISPLAYATTRIB_BLE_MEDIUM,
2077 VADISPLAYATTRIB_BLE_HIGH,
2078 VADISPLAYATTRIB_BLE_NONE,
2079 } VADisplayAttribBLEMode;
2081 /* attribute value for VADisplayAttribRotation */
2082 #define VA_ROTATION_NONE 0x00000000
2083 #define VA_ROTATION_90 0x00000001
2084 #define VA_ROTATION_180 0x00000002
2085 #define VA_ROTATION_270 0x00000003
2087 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2088 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2089 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2092 #define VA_RENDER_MODE_UNDEFINED 0
2093 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2094 #define VA_RENDER_MODE_LOCAL_GPU 2
2095 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2096 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2099 #define VA_RENDER_DEVICE_UNDEFINED 0
2100 #define VA_RENDER_DEVICE_LOCAL 1
2101 #define VA_RENDER_DEVICE_EXTERNAL 2
2103 /* Currently defined display attribute types */
2106 VADisplayAttribBrightness = 0,
2107 VADisplayAttribContrast = 1,
2108 VADisplayAttribHue = 2,
2109 VADisplayAttribSaturation = 3,
2110 /* client can specifiy a background color for the target window
2111 * the new feature of video conference,
2112 * the uncovered area of the surface is filled by this color
2113 * also it will blend with the decoded video color
2115 VADisplayAttribBackgroundColor = 4,
2117 * this is a gettable only attribute. For some implementations that use the
2118 * hardware overlay, after PutSurface is called, the surface can not be
2119 * re-used until after the subsequent PutSurface call. If this is the case
2120 * then the value for this attribute will be set to 1 so that the client
2121 * will not attempt to re-use the surface right after returning from a call
2124 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2125 * driver may use overlay or GPU alternatively
2127 VADisplayAttribDirectSurface = 5,
2128 VADisplayAttribRotation = 6,
2129 VADisplayAttribOutofLoopDeblock = 7,
2131 /* PowerVR IEP Lite specific attributes */
2132 VADisplayAttribBLEBlackMode = 8,
2133 VADisplayAttribBLEWhiteMode = 9,
2134 VADisplayAttribBlueStretch = 10,
2135 VADisplayAttribSkinColorCorrection = 11,
2137 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2138 * conversion matrix. Each element in the matrix is float-point
2140 VADisplayAttribCSCMatrix = 12,
2141 /* specify the constant color used to blend with video surface
2142 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2143 * d: the final color to overwrite into the frame buffer
2144 * v: decoded video after color conversion,
2145 * c: video color specified by VADisplayAttribBlendColor
2146 * b: background color of the drawable
2148 VADisplayAttribBlendColor = 13,
2150 * Indicate driver to skip painting color key or not.
2151 * only applicable if the render is overlay
2153 VADisplayAttribOverlayAutoPaintColorKey = 14,
2155 * customized overlay color key, the format is RGB888
2156 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2158 VADisplayAttribOverlayColorKey = 15,
2160 * The hint for the implementation of vaPutSurface
2161 * normally, the driver could use an overlay or GPU to render the surface on the screen
2162 * this flag provides APP the flexibity to switch the render dynamically
2164 VADisplayAttribRenderMode = 16,
2166 * specify if vaPutSurface needs to render into specified monitors
2167 * one example is that one external monitor (e.g. HDMI) is enabled,
2168 * but the window manager is not aware of it, and there is no associated drawable
2170 VADisplayAttribRenderDevice = 17,
2172 * specify vaPutSurface render area if there is no drawable on the monitor
2174 VADisplayAttribRenderRect = 18,
2175 } VADisplayAttribType;
2177 /* flags for VADisplayAttribute */
2178 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2179 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2180 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2182 typedef struct _VADisplayAttribute
2184 VADisplayAttribType type;
2187 int value; /* used by the set/get attribute functions */
2188 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2190 } VADisplayAttribute;
2192 /* Get maximum number of display attributs supported by the implementation */
2193 int vaMaxNumDisplayAttributes (
2198 * Query display attributes
2199 * The caller must provide a "attr_list" array that can hold at
2200 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2201 * returned in "attr_list" is returned in "num_attributes".
2203 VAStatus vaQueryDisplayAttributes (
2205 VADisplayAttribute *attr_list, /* out */
2206 int *num_attributes /* out */
2210 * Get display attributes
2211 * This function returns the current attribute values in "attr_list".
2212 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2213 * from vaQueryDisplayAttributes() can have their values retrieved.
2215 VAStatus vaGetDisplayAttributes (
2217 VADisplayAttribute *attr_list, /* in/out */
2222 * Set display attributes
2223 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2224 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2225 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2227 VAStatus vaSetDisplayAttributes (
2229 VADisplayAttribute *attr_list,