2 * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19 * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
20 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 * Video Acceleration (VA) API Specification
28 * <jonathan.bian@intel.com>
31 * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
32 * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
33 * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
34 * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
35 * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
36 * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
37 * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
38 * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
39 * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
40 * and MPEG-2 motion compensation.
41 * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
42 * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
43 * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
44 * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
45 * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
46 * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
47 * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
48 * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
49 * rev 0.27 (11/19/2007 Matt Sottek) - Added DeriveImage
50 * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
52 * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
53 * added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
54 * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
55 * for ISO C conformance.
56 * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
57 * Application needs to relink with the new library.
59 * rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
60 * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
61 * screen relative rather than source video relative.
62 * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
63 * update VAAPI to 0.32.0
66 * Some concepts borrowed from XvMC and XvImage.
67 * Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
68 * contributed to various aspects of the API.
75 * This file contains the \ref api_core "Core API".
83 #include <va/va_version.h>
90 * \mainpage Video Acceleration (VA) API
92 * \section intro Introduction
94 * The main motivation for VA-API (Video Acceleration API) is to
95 * enable hardware accelerated video decode and encode at various
96 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
97 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
98 * AVC/H.264, VC-1/VMW3, and JPEG).
100 * VA-API is split into several modules:
102 * - \ref api_enc_h264
107 * \defgroup api_core Core API
115 The VA API is intended to provide an interface between a video decode/encode/display
116 application (client) and a hardware accelerator (server), to off-load
117 video decode/encode/display operations from the host to the hardware accelerator at various
120 The basic operation steps are:
122 - Negotiate a mutually acceptable configuration with the server to lock
123 down profile, entrypoints, and other attributes that will not change on
124 a frame-by-frame basis.
125 - Create a decode context which represents a "virtualized" hardware decode
127 - Get and fill decode buffers with picture level, slice level and macroblock
128 level data (depending on entrypoints)
129 - Pass the decode buffers to the server to decode the current frame
131 Initialization & Configuration Management
133 - Find out supported profiles
134 - Find out entrypoints for a given profile
135 - Find out configuration attributes for a given profile/entrypoint pair
136 - Create a configuration for use by the decoder
140 typedef void* VADisplay; /* window system dependent */
142 typedef int VAStatus; /** Return status type from functions */
143 /** Values for the return status */
144 #define VA_STATUS_SUCCESS 0x00000000
145 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
146 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
147 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
148 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
149 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
150 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
151 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
152 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
153 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
154 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
155 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
156 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
157 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
158 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
159 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
160 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
161 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
162 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
163 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
164 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
165 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
166 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
167 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
168 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
170 * \brief An invalid/unsupported value was supplied.
172 * This is a catch-all error code for invalid or unsupported values.
173 * e.g. value exceeding the valid range, invalid type in the context
174 * of generic attribute values.
176 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
177 /** \brief An unsupported filter was supplied. */
178 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
179 /** \brief An invalid filter chain was supplied. */
180 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
181 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
182 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
183 /** \brief An unsupported memory type was supplied. */
184 #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
185 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
187 /** De-interlacing flags for vaPutSurface() */
188 #define VA_FRAME_PICTURE 0x00000000
189 #define VA_TOP_FIELD 0x00000001
190 #define VA_BOTTOM_FIELD 0x00000002
193 * Enabled the positioning/cropping/blending feature:
194 * 1, specify the video playback position in the isurface
195 * 2, specify the cropping info for video playback
196 * 3, encoded video will blend with background color
198 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
201 * Clears the drawable with background color.
202 * for hardware overlay based implementation this flag
203 * can be used to turn off the overlay
205 #define VA_CLEAR_DRAWABLE 0x00000008
207 /** Color space conversion flags for vaPutSurface() */
208 #define VA_SRC_COLOR_MASK 0x000000f0
209 #define VA_SRC_BT601 0x00000010
210 #define VA_SRC_BT709 0x00000020
211 #define VA_SRC_SMPTE_240 0x00000040
213 /** Scaling flags for vaPutSurface() */
214 #define VA_FILTER_SCALING_DEFAULT 0x00000000
215 #define VA_FILTER_SCALING_FAST 0x00000100
216 #define VA_FILTER_SCALING_HQ 0x00000200
217 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
218 #define VA_FILTER_SCALING_MASK 0x00000f00
221 * Returns a short english description of error_status
223 const char *vaErrorStr(VAStatus error_status);
227 * A display must be obtained by calling vaGetDisplay() before calling
228 * vaInitialize() and other functions. This connects the API to the
229 * native window system.
230 * For X Windows, native_dpy would be from XOpenDisplay()
232 typedef void* VANativeDisplay; /* window system dependent */
234 int vaDisplayIsValid(VADisplay dpy);
237 * Initialize the library
239 VAStatus vaInitialize (
241 int *major_version, /* out */
242 int *minor_version /* out */
246 * After this call, all library internal resources will be cleaned up
248 VAStatus vaTerminate (
253 * vaQueryVendorString returns a pointer to a zero-terminated string
254 * describing some aspects of the VA implemenation on a specific
255 * hardware accelerator. The format of the returned string is vendor
256 * specific and at the discretion of the implementer.
257 * e.g. for the Intel GMA500 implementation, an example would be:
258 * "Intel GMA500 - 2.0.0.32L.0005"
260 const char *vaQueryVendorString (
264 typedef int (*VAPrivFunc)();
267 * Return a function pointer given a function name in the library.
268 * This allows private interfaces into the library
270 VAPrivFunc vaGetLibFunc (
275 /** Currently defined profiles */
278 /** \brief Profile ID used for video processing. */
280 VAProfileMPEG2Simple = 0,
281 VAProfileMPEG2Main = 1,
282 VAProfileMPEG4Simple = 2,
283 VAProfileMPEG4AdvancedSimple = 3,
284 VAProfileMPEG4Main = 4,
285 VAProfileH264Baseline = 5,
286 VAProfileH264Main = 6,
287 VAProfileH264High = 7,
288 VAProfileVC1Simple = 8,
289 VAProfileVC1Main = 9,
290 VAProfileVC1Advanced = 10,
291 VAProfileH263Baseline = 11,
292 VAProfileJPEGBaseline = 12,
293 VAProfileH264ConstrainedBaseline = 13,
294 VAProfileVP8Version0_3 = 14,
295 VAProfileH264MultiviewHigh = 15,
296 VAProfileH264StereoHigh = 16,
297 VAProfileHEVCMain = 17,
298 VAProfileHEVCMain10 = 18,
299 VAProfileVP9Profile0 = 19
303 * Currently defined entrypoints
309 VAEntrypointIDCT = 3,
310 VAEntrypointMoComp = 4,
311 VAEntrypointDeblocking = 5,
312 VAEntrypointEncSlice = 6, /* slice level encode */
313 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
314 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
317 /** Currently defined configuration attribute types */
320 VAConfigAttribRTFormat = 0,
321 VAConfigAttribSpatialResidual = 1,
322 VAConfigAttribSpatialClipping = 2,
323 VAConfigAttribIntraResidual = 3,
324 VAConfigAttribEncryption = 4,
325 VAConfigAttribRateControl = 5,
327 /** @name Attributes for decoding */
330 * \brief Slice Decoding mode. Read/write.
332 * This attribute determines what mode the driver supports for slice
333 * decoding, through vaGetConfigAttributes(); and what mode the user
334 * will be providing to the driver, through vaCreateConfig(), if the
335 * driver supports those. If this attribute is not set by the user then
336 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
338 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
340 VAConfigAttribDecSliceMode = 6,
342 /** @name Attributes for encoding */
345 * \brief Packed headers mode. Read/write.
347 * This attribute determines what packed headers the driver supports,
348 * through vaGetConfigAttributes(); and what packed headers the user
349 * will be providing to the driver, through vaCreateConfig(), if the
350 * driver supports those.
352 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
354 VAConfigAttribEncPackedHeaders = 10,
356 * \brief Interlaced mode. Read/write.
358 * This attribute determines what kind of interlaced encoding mode
359 * the driver supports.
361 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
363 VAConfigAttribEncInterlaced = 11,
365 * \brief Maximum number of reference frames. Read-only.
367 * This attribute determines the maximum number of reference
368 * frames supported for encoding.
370 * Note: for H.264 encoding, the value represents the maximum number
371 * of reference frames for both the reference picture list 0 (bottom
372 * 16 bits) and the reference picture list 1 (top 16 bits).
374 VAConfigAttribEncMaxRefFrames = 13,
376 * \brief Maximum number of slices per frame. Read-only.
378 * This attribute determines the maximum number of slices the
379 * driver can support to encode a single frame.
381 VAConfigAttribEncMaxSlices = 14,
383 * \brief Slice structure. Read-only.
385 * This attribute determines slice structures supported by the
386 * driver for encoding. This attribute is a hint to the user so
387 * that he can choose a suitable surface size and how to arrange
388 * the encoding process of multiple slices per frame.
390 * More specifically, for H.264 encoding, this attribute
391 * determines the range of accepted values to
392 * VAEncSliceParameterBufferH264::macroblock_address and
393 * VAEncSliceParameterBufferH264::num_macroblocks.
395 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
398 VAConfigAttribEncSliceStructure = 15,
400 * \brief Macroblock information. Read-only.
402 * This attribute determines whether the driver supports extra
403 * encoding information per-macroblock. e.g. QP.
405 * More specifically, for H.264 encoding, if the driver returns a non-zero
406 * value for this attribute, this means the application can create
407 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
408 * through VAEncSliceParameterBufferH264::macroblock_info.
410 VAConfigAttribEncMacroblockInfo = 16,
412 * \brief JPEG encoding attribute. Read-only.
414 * This attribute exposes a number of capabilities of the underlying
415 * JPEG implementation. The attribute value is partitioned into fields as defined in the
416 * VAConfigAttribValEncJPEG union.
418 VAConfigAttribEncJPEG = 20,
420 * \brief Encoding quality range attribute. Read-only.
422 * This attribute conveys whether the driver supports different quality level settings
423 * for encoding. A value less than or equal to 1 means that the encoder only has a single
424 * quality setting, and a value greater than 1 represents the number of quality levels
425 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
427 VAConfigAttribEncQualityRange = 21,
429 VAConfigAttribTypeMax
430 } VAConfigAttribType;
433 * Configuration attributes
434 * If there is more than one value for an attribute, a default
435 * value will be assigned to the attribute if the client does not
436 * specify the attribute when creating a configuration
438 typedef struct _VAConfigAttrib {
439 VAConfigAttribType type;
440 unsigned int value; /* OR'd flags (bits) for this attribute */
443 /** attribute value for VAConfigAttribRTFormat */
444 #define VA_RT_FORMAT_YUV420 0x00000001
445 #define VA_RT_FORMAT_YUV422 0x00000002
446 #define VA_RT_FORMAT_YUV444 0x00000004
447 #define VA_RT_FORMAT_YUV411 0x00000008
448 #define VA_RT_FORMAT_YUV400 0x00000010
449 #define VA_RT_FORMAT_RGB16 0x00010000
450 #define VA_RT_FORMAT_RGB32 0x00020000
451 /* RGBP covers RGBP and BGRP fourcc */
452 #define VA_RT_FORMAT_RGBP 0x00100000
453 #define VA_RT_FORMAT_PROTECTED 0x80000000
455 /** @name Attribute values for VAConfigAttribRateControl */
457 /** \brief Driver does not support any form of rate control. */
458 #define VA_RC_NONE 0x00000001
459 /** \brief Constant bitrate. */
460 #define VA_RC_CBR 0x00000002
461 /** \brief Variable bitrate. */
462 #define VA_RC_VBR 0x00000004
463 /** \brief Video conference mode. */
464 #define VA_RC_VCM 0x00000008
465 /** \brief Constant QP. */
466 #define VA_RC_CQP 0x00000010
467 /** \brief Variable bitrate with peak rate higher than average bitrate. */
468 #define VA_RC_VBR_CONSTRAINED 0x00000020
471 /** @name Attribute values for VAConfigAttribDecSliceMode */
473 /** \brief Driver supports normal mode for slice decoding */
474 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
475 /** \brief Driver supports base mode for slice decoding */
476 #define VA_DEC_SLICE_MODE_BASE 0x00000002
479 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
481 /** \brief Driver does not support any packed headers mode. */
482 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
483 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
484 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
485 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
486 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
487 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
488 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
489 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
490 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
491 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
492 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
495 /** @name Attribute values for VAConfigAttribEncInterlaced */
497 /** \brief Driver does not support interlaced coding. */
498 #define VA_ENC_INTERLACED_NONE 0x00000000
499 /** \brief Driver supports interlaced frame coding. */
500 #define VA_ENC_INTERLACED_FRAME 0x00000001
501 /** \brief Driver supports interlaced field coding. */
502 #define VA_ENC_INTERLACED_FIELD 0x00000002
503 /** \brief Driver supports macroblock adaptive frame field coding. */
504 #define VA_ENC_INTERLACED_MBAFF 0x00000004
505 /** \brief Driver supports picture adaptive frame field coding. */
506 #define VA_ENC_INTERLACED_PAFF 0x00000008
509 /** @name Attribute values for VAConfigAttribEncSliceStructure */
511 /** \brief Driver supports an arbitrary number of rows per slice. */
512 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
513 /** \brief Driver supports a power-of-two number of rows per slice. */
514 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
515 /** \brief Driver supports an arbitrary number of rows per slice. */
516 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
519 /** \brief Attribute value for VAConfigAttribEncJPEG */
520 typedef union _VAConfigAttribValEncJPEG {
522 /** \brief set to 1 for arithmatic coding. */
523 unsigned int arithmatic_coding_mode : 1;
524 /** \brief set to 1 for progressive dct. */
525 unsigned int progressive_dct_mode : 1;
526 /** \brief set to 1 for non-interleaved. */
527 unsigned int non_interleaved_mode : 1;
528 /** \brief set to 1 for differential. */
529 unsigned int differential_mode : 1;
530 unsigned int max_num_components : 3;
531 unsigned int max_num_scans : 4;
532 unsigned int max_num_huffman_tables : 3;
533 unsigned int max_num_quantization_tables : 3;
536 } VAConfigAttribValEncJPEG;
539 * if an attribute is not applicable for a given
540 * profile/entrypoint pair, then set the value to the following
542 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
544 /** Get maximum number of profiles supported by the implementation */
545 int vaMaxNumProfiles (
549 /** Get maximum number of entrypoints supported by the implementation */
550 int vaMaxNumEntrypoints (
554 /** Get maximum number of attributs supported by the implementation */
555 int vaMaxNumConfigAttributes (
560 * Query supported profiles
561 * The caller must provide a "profile_list" array that can hold at
562 * least vaMaxNumProfile() entries. The actual number of profiles
563 * returned in "profile_list" is returned in "num_profile".
565 VAStatus vaQueryConfigProfiles (
567 VAProfile *profile_list, /* out */
568 int *num_profiles /* out */
572 * Query supported entrypoints for a given profile
573 * The caller must provide an "entrypoint_list" array that can hold at
574 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
575 * returned in "entrypoint_list" is returned in "num_entrypoints".
577 VAStatus vaQueryConfigEntrypoints (
580 VAEntrypoint *entrypoint_list, /* out */
581 int *num_entrypoints /* out */
585 * Get attributes for a given profile/entrypoint pair
586 * The caller must provide an "attrib_list" with all attributes to be
587 * retrieved. Upon return, the attributes in "attrib_list" have been
588 * updated with their value. Unknown attributes or attributes that are
589 * not supported for the given profile/entrypoint pair will have their
590 * value set to VA_ATTRIB_NOT_SUPPORTED
592 VAStatus vaGetConfigAttributes (
595 VAEntrypoint entrypoint,
596 VAConfigAttrib *attrib_list, /* in/out */
600 /** Generic ID type, can be re-typed for specific implementation */
601 typedef unsigned int VAGenericID;
603 typedef VAGenericID VAConfigID;
606 * Create a configuration for the decode pipeline
607 * it passes in the attribute list that specifies the attributes it cares
608 * about, with the rest taking default values.
610 VAStatus vaCreateConfig (
613 VAEntrypoint entrypoint,
614 VAConfigAttrib *attrib_list,
616 VAConfigID *config_id /* out */
620 * Free resources associdated with a given config
622 VAStatus vaDestroyConfig (
628 * Query all attributes for a given configuration
629 * The profile of the configuration is returned in "profile"
630 * The entrypoint of the configuration is returned in "entrypoint"
631 * The caller must provide an "attrib_list" array that can hold at least
632 * vaMaxNumConfigAttributes() entries. The actual number of attributes
633 * returned in "attrib_list" is returned in "num_attribs"
635 VAStatus vaQueryConfigAttributes (
637 VAConfigID config_id,
638 VAProfile *profile, /* out */
639 VAEntrypoint *entrypoint, /* out */
640 VAConfigAttrib *attrib_list,/* out */
641 int *num_attribs /* out */
646 * Contexts and Surfaces
648 * Context represents a "virtual" video decode pipeline. Surfaces are render
649 * targets for a given context. The data in the surfaces are not accessible
650 * to the client and the internal data format of the surface is implementatin
653 * Surfaces will be bound to a context when the context is created. Once
654 * a surface is bound to a given context, it can not be used to create
655 * another context. The association is removed when the context is destroyed
657 * Both contexts and surfaces are identified by unique IDs and its
658 * implementation specific internals are kept opaque to the clients
661 typedef VAGenericID VAContextID;
663 typedef VAGenericID VASurfaceID;
665 #define VA_INVALID_ID 0xffffffff
666 #define VA_INVALID_SURFACE VA_INVALID_ID
668 /** \brief Generic value types. */
670 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
671 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
672 VAGenericValueTypePointer, /**< Generic pointer type */
673 VAGenericValueTypeFunc /**< Pointer to function */
674 } VAGenericValueType;
676 /** \brief Generic function type. */
677 typedef void (*VAGenericFunc)(void);
679 /** \brief Generic value. */
680 typedef struct _VAGenericValue {
681 /** \brief Value type. See #VAGenericValueType. */
682 VAGenericValueType type;
683 /** \brief Value holder. */
685 /** \brief 32-bit signed integer. */
687 /** \brief 32-bit float. */
689 /** \brief Generic pointer. */
691 /** \brief Pointer to function. */
696 /** @name Surface attribute flags */
698 /** \brief Surface attribute is not supported. */
699 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
700 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
701 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
702 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
703 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
706 /** \brief Surface attribute types. */
708 VASurfaceAttribNone = 0,
710 * \brief Pixel format (fourcc).
712 * The value is meaningful as input to vaQuerySurfaceAttributes().
713 * If zero, the driver returns the optimal pixel format for the
714 * specified config. Otherwise, if non-zero, the value represents
715 * a pixel format (FOURCC) that is kept as is on output, if the
716 * driver supports it. Otherwise, the driver sets the value to
717 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
719 VASurfaceAttribPixelFormat,
720 /** \brief Minimal width in pixels (int, read-only). */
721 VASurfaceAttribMinWidth,
722 /** \brief Maximal width in pixels (int, read-only). */
723 VASurfaceAttribMaxWidth,
724 /** \brief Minimal height in pixels (int, read-only). */
725 VASurfaceAttribMinHeight,
726 /** \brief Maximal height in pixels (int, read-only). */
727 VASurfaceAttribMaxHeight,
728 /** \brief Surface memory type expressed in bit fields (int, read/write). */
729 VASurfaceAttribMemoryType,
730 /** \brief External buffer descriptor (pointer, write). */
731 VASurfaceAttribExternalBufferDescriptor,
732 /** \brief Surface usage hint, gives the driver a hint of intended usage
733 * to optimize allocation (e.g. tiling) (int, read/write). */
734 VASurfaceAttribUsageHint,
735 /** \brief Number of surface attributes. */
737 } VASurfaceAttribType;
739 /** \brief Surface attribute. */
740 typedef struct _VASurfaceAttrib {
742 VASurfaceAttribType type;
743 /** \brief Flags. See "Surface attribute flags". */
745 /** \brief Value. See "Surface attribute types" for the expected types. */
746 VAGenericValue value;
750 * @name VASurfaceAttribMemoryType values in bit fields.
751 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
752 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
753 * types are defined in DRM and Android header files.
756 /** \brief VA memory type (default) is supported. */
757 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
758 /** \brief V4L2 buffer memory type is supported. */
759 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
760 /** \brief User pointer memory type is supported. */
761 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
765 * \brief VASurfaceAttribExternalBuffers structure for
766 * the VASurfaceAttribExternalBufferDescriptor attribute.
768 typedef struct _VASurfaceAttribExternalBuffers {
769 /** \brief pixel format in fourcc. */
770 unsigned int pixel_format;
771 /** \brief width in pixels. */
773 /** \brief height in pixels. */
775 /** \brief total size of the buffer in bytes. */
776 unsigned int data_size;
777 /** \brief number of planes for planar layout */
778 unsigned int num_planes;
779 /** \brief pitch for each plane in bytes */
780 unsigned int pitches[4];
781 /** \brief offset for each plane in bytes */
782 unsigned int offsets[4];
783 /** \brief buffer handles or user pointers */
784 unsigned long *buffers;
785 /** \brief number of elements in the "buffers" array */
786 unsigned int num_buffers;
787 /** \brief flags. See "Surface external buffer descriptor flags". */
789 /** \brief reserved for passing private data */
791 } VASurfaceAttribExternalBuffers;
793 /** @name VASurfaceAttribExternalBuffers flags */
795 /** \brief Enable memory tiling */
796 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
797 /** \brief Memory is cacheable */
798 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
799 /** \brief Memory is non-cacheable */
800 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
801 /** \brief Memory is write-combined */
802 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
803 /** \brief Memory is protected */
804 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
806 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
808 /** \brief Surface usage not indicated. */
809 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
810 /** \brief Surface used by video decoder. */
811 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
812 /** \brief Surface used by video encoder. */
813 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
814 /** \brief Surface read by video post-processing. */
815 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
816 /** \brief Surface written by video post-processing. */
817 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
818 /** \brief Surface used for display. */
819 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
824 * \brief Queries surface attributes for the supplied config.
826 * Unlike vaGetSurfaceAttributes(), this function queries for all
827 * supported attributes for the supplied VA @config. In particular, if
828 * the underlying hardware supports the creation of VA surfaces in
829 * various formats, then this function will enumerate all pixel
830 * formats that are supported.
832 * The \c attrib_list array is allocated by the user and \c
833 * num_attribs shall be initialized to the number of allocated
834 * elements in that array. Upon successful return, the actual number
835 * of attributes will be overwritten into \c num_attribs. Otherwise,
836 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
837 * is adjusted to the number of elements that would be returned if
838 * enough space was available.
840 * Note: it is perfectly valid to pass NULL to the \c attrib_list
841 * argument when vaQuerySurfaceAttributes() is used to determine the
842 * actual number of elements that need to be allocated.
844 * @param[in] dpy the VA display
845 * @param[in] config the config identifying a codec or a video
846 * processing pipeline
847 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
848 * @param[in,out] num_attribs the number of elements allocated on
849 * input, the number of elements actually filled in output
852 vaQuerySurfaceAttributes(
855 VASurfaceAttrib *attrib_list,
856 unsigned int *num_attribs
860 * \brief Creates an array of surfaces
862 * Creates an array of surfaces. The optional list of attributes shall
863 * be constructed and validated through vaGetSurfaceAttributes() or
864 * constructed based based on what the underlying hardware could
865 * expose through vaQuerySurfaceAttributes().
867 * @param[in] dpy the VA display
868 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
869 * @param[in] width the surface width
870 * @param[in] height the surface height
871 * @param[out] surfaces the array of newly created surfaces
872 * @param[in] num_surfaces the number of surfaces to create
873 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
874 * @param[in] num_attribs the number of attributes supplied in
875 * \c attrib_list, or zero
883 VASurfaceID *surfaces,
884 unsigned int num_surfaces,
885 VASurfaceAttrib *attrib_list,
886 unsigned int num_attribs
890 * vaDestroySurfaces - Destroy resources associated with surfaces.
891 * Surfaces can only be destroyed after the context associated has been
894 * surfaces: array of surfaces to destroy
895 * num_surfaces: number of surfaces in the array to be destroyed.
897 VAStatus vaDestroySurfaces (
899 VASurfaceID *surfaces,
903 #define VA_PROGRESSIVE 0x1
905 * vaCreateContext - Create a context
907 * config_id: configuration for the context
908 * picture_width: coded picture width
909 * picture_height: coded picture height
910 * flag: any combination of the following:
911 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
912 * render_targets: render targets (surfaces) tied to the context
913 * num_render_targets: number of render targets in the above array
914 * context: created context id upon return
916 VAStatus vaCreateContext (
918 VAConfigID config_id,
922 VASurfaceID *render_targets,
923 int num_render_targets,
924 VAContextID *context /* out */
928 * vaDestroyContext - Destroy a context
930 * context: context to be destroyed
932 VAStatus vaDestroyContext (
939 * Buffers are used to pass various types of data from the
940 * client to the server. The server maintains a data store
941 * for each buffer created, and the client idenfies a buffer
942 * through a unique buffer id assigned by the server.
945 typedef VAGenericID VABufferID;
949 VAPictureParameterBufferType = 0,
950 VAIQMatrixBufferType = 1,
951 VABitPlaneBufferType = 2,
952 VASliceGroupMapBufferType = 3,
953 VASliceParameterBufferType = 4,
954 VASliceDataBufferType = 5,
955 VAMacroblockParameterBufferType = 6,
956 VAResidualDataBufferType = 7,
957 VADeblockingParameterBufferType = 8,
958 VAImageBufferType = 9,
959 VAProtectedSliceDataBufferType = 10,
960 VAQMatrixBufferType = 11,
961 VAHuffmanTableBufferType = 12,
962 VAProbabilityBufferType = 13,
964 /* Following are encode buffer types */
965 VAEncCodedBufferType = 21,
966 VAEncSequenceParameterBufferType = 22,
967 VAEncPictureParameterBufferType = 23,
968 VAEncSliceParameterBufferType = 24,
969 VAEncPackedHeaderParameterBufferType = 25,
970 VAEncPackedHeaderDataBufferType = 26,
971 VAEncMiscParameterBufferType = 27,
972 VAEncMacroblockParameterBufferType = 28,
973 VAEncMacroblockMapBufferType = 29,
974 /* Following are video processing buffer types */
976 * \brief Video processing pipeline parameter buffer.
978 * This buffer describes the video processing pipeline. See
979 * #VAProcPipelineParameterBuffer for details.
981 VAProcPipelineParameterBufferType = 41,
983 * \brief Video filter parameter buffer.
985 * This buffer describes the video filter parameters. All buffers
986 * inherit from #VAProcFilterParameterBufferBase, thus including
987 * a unique filter buffer type.
989 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
990 * Filters requiring advanced parameters include, but are not limited to,
991 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
992 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
994 VAProcFilterParameterBufferType = 42,
1000 VAEncMiscParameterTypeFrameRate = 0,
1001 VAEncMiscParameterTypeRateControl = 1,
1002 VAEncMiscParameterTypeMaxSliceSize = 2,
1003 VAEncMiscParameterTypeAIR = 3,
1004 /** \brief Buffer type used to express a maximum frame size (in bits). */
1005 VAEncMiscParameterTypeMaxFrameSize = 4,
1006 /** \brief Buffer type used for HRD parameters. */
1007 VAEncMiscParameterTypeHRD = 5,
1008 VAEncMiscParameterTypeQualityLevel = 6,
1009 } VAEncMiscParameterType;
1011 /** \brief Packed header type. */
1013 /** \brief Packed sequence header. */
1014 VAEncPackedHeaderSequence = 1,
1015 /** \brief Packed picture header. */
1016 VAEncPackedHeaderPicture = 2,
1017 /** \brief Packed slice header. */
1018 VAEncPackedHeaderSlice = 3,
1020 * \brief Packed raw header.
1022 * Packed raw data header can be used by the client to insert a header
1023 * into the bitstream data buffer at the point it is passed, the driver
1024 * will handle the raw packed header based on "has_emulation_bytes" field
1025 * in the packed header parameter structure.
1027 VAEncPackedHeaderRawData = 4,
1028 /** \brief Misc packed header. See codec-specific definitions. */
1029 VAEncPackedHeaderMiscMask = 0x80000000,
1030 } VAEncPackedHeaderType;
1032 /** \brief Packed header parameter. */
1033 typedef struct _VAEncPackedHeaderParameterBuffer {
1034 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1036 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1037 unsigned int bit_length;
1038 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1039 unsigned char has_emulation_bytes;
1040 } VAEncPackedHeaderParameterBuffer;
1043 * For application, e.g. set a new bitrate
1044 * VABufferID buf_id;
1045 * VAEncMiscParameterBuffer *misc_param;
1046 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1048 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1049 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1050 * 1, NULL, &buf_id);
1052 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1053 * misc_param->type = VAEncMiscParameterTypeRateControl;
1054 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1055 * misc_rate_ctrl->bits_per_second = 6400000;
1056 * vaUnmapBuffer(dpy, buf_id);
1057 * vaRenderPicture(dpy, context, &buf_id, 1);
1059 typedef struct _VAEncMiscParameterBuffer
1061 VAEncMiscParameterType type;
1062 unsigned int data[0];
1063 } VAEncMiscParameterBuffer;
1066 /** \brief Rate control parameters */
1067 typedef struct _VAEncMiscParameterRateControl
1069 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1070 unsigned int bits_per_second;
1071 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1072 * bit-rate for example if target_percentage is 95 then the rate control will target
1073 * a bit-rate that is 95% of the maximum bit-rate
1075 unsigned int target_percentage;
1076 /* windows size in milliseconds. For example if this is set to 500,
1077 * then the rate control will guarantee the target bit-rate over a 500 ms window
1079 unsigned int window_size;
1080 /* initial QP at I frames */
1081 unsigned int initial_qp;
1082 unsigned int min_qp;
1083 unsigned int basic_unit_size;
1088 unsigned int reset : 1;
1089 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1090 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1094 } VAEncMiscParameterRateControl;
1096 typedef struct _VAEncMiscParameterFrameRate
1098 unsigned int framerate;
1099 } VAEncMiscParameterFrameRate;
1102 * Allow a maximum slice size to be specified (in bits).
1103 * The encoder will attempt to make sure that individual slices do not exceed this size
1104 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1106 typedef struct _VAEncMiscParameterMaxSliceSize
1108 unsigned int max_slice_size;
1109 } VAEncMiscParameterMaxSliceSize;
1111 typedef struct _VAEncMiscParameterAIR
1113 unsigned int air_num_mbs;
1114 unsigned int air_threshold;
1115 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1116 } VAEncMiscParameterAIR;
1118 typedef struct _VAEncMiscParameterHRD
1120 unsigned int initial_buffer_fullness; /* in bits */
1121 unsigned int buffer_size; /* in bits */
1122 } VAEncMiscParameterHRD;
1125 * \brief Defines a maximum frame size (in bits).
1127 * This misc parameter buffer defines the maximum size of a frame (in
1128 * bits). The encoder will try to make sure that each frame does not
1129 * exceed this size. Otherwise, if the frame size exceeds this size,
1130 * the \c status flag of #VACodedBufferSegment will contain
1131 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1133 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1134 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1135 VAEncMiscParameterType type;
1136 /** \brief Maximum size of a frame (in bits). */
1137 unsigned int max_frame_size;
1138 } VAEncMiscParameterBufferMaxFrameSize;
1141 * \brief Encoding quality level.
1143 * The encoding quality could be set through this structure, if the implementation
1144 * supports multiple quality levels. The quality level set through this structure is
1145 * persistent over the entire coded sequence, or until a new structure is being sent.
1146 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1147 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1148 * quality. The quality level setting is used as a trade-off between quality and speed/power
1149 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1151 typedef struct _VAEncMiscParameterBufferQualityLevel {
1152 /** \brief Encoding quality level setting. When set to 0, default quality
1155 unsigned int quality_level;
1156 } VAEncMiscParameterBufferQualityLevel;
1159 * There will be cases where the bitstream buffer will not have enough room to hold
1160 * the data for the entire slice, and the following flags will be used in the slice
1161 * parameter to signal to the server for the possible cases.
1162 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1163 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1164 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1166 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1167 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1168 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1169 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1171 /* Codec-independent Slice Parameter Buffer base */
1172 typedef struct _VASliceParameterBufferBase
1174 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1175 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1176 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1177 } VASliceParameterBufferBase;
1179 /**********************************
1180 * JPEG common data structures
1181 **********************************/
1183 * \brief Huffman table for JPEG decoding.
1185 * This structure holds the complete Huffman tables. This is an
1186 * aggregation of all Huffman table (DHT) segments maintained by the
1187 * application. i.e. up to 2 Huffman tables are stored in there for
1190 * The #load_huffman_table array can be used as a hint to notify the
1191 * VA driver implementation about which table(s) actually changed
1192 * since the last submission of this buffer.
1194 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1195 /** \brief Specifies which #huffman_table is valid. */
1196 unsigned char load_huffman_table[2];
1197 /** \brief Huffman tables indexed by table identifier (Th). */
1199 /** @name DC table (up to 12 categories) */
1201 /** \brief Number of Huffman codes of length i + 1 (Li). */
1202 unsigned char num_dc_codes[16];
1203 /** \brief Value associated with each Huffman code (Vij). */
1204 unsigned char dc_values[12];
1206 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1208 /** \brief Number of Huffman codes of length i + 1 (Li). */
1209 unsigned char num_ac_codes[16];
1210 /** \brief Value associated with each Huffman code (Vij). */
1211 unsigned char ac_values[162];
1212 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1213 unsigned char pad[2];
1216 } VAHuffmanTableBufferJPEGBaseline;
1218 /****************************
1219 * MPEG-2 data structures
1220 ****************************/
1222 /* MPEG-2 Picture Parameter Buffer */
1224 * For each frame or field, and before any slice data, a single
1225 * picture parameter buffer must be send.
1227 typedef struct _VAPictureParameterBufferMPEG2
1229 unsigned short horizontal_size;
1230 unsigned short vertical_size;
1231 VASurfaceID forward_reference_picture;
1232 VASurfaceID backward_reference_picture;
1233 /* meanings of the following fields are the same as in the standard */
1234 int picture_coding_type;
1235 int f_code; /* pack all four fcode into this */
1238 unsigned int intra_dc_precision : 2;
1239 unsigned int picture_structure : 2;
1240 unsigned int top_field_first : 1;
1241 unsigned int frame_pred_frame_dct : 1;
1242 unsigned int concealment_motion_vectors : 1;
1243 unsigned int q_scale_type : 1;
1244 unsigned int intra_vlc_format : 1;
1245 unsigned int alternate_scan : 1;
1246 unsigned int repeat_first_field : 1;
1247 unsigned int progressive_frame : 1;
1248 unsigned int is_first_field : 1; /* indicate whether the current field
1249 * is the first field for field picture
1253 } picture_coding_extension;
1254 } VAPictureParameterBufferMPEG2;
1256 /** MPEG-2 Inverse Quantization Matrix Buffer */
1257 typedef struct _VAIQMatrixBufferMPEG2
1259 /** \brief Same as the MPEG-2 bitstream syntax element. */
1260 int load_intra_quantiser_matrix;
1261 /** \brief Same as the MPEG-2 bitstream syntax element. */
1262 int load_non_intra_quantiser_matrix;
1263 /** \brief Same as the MPEG-2 bitstream syntax element. */
1264 int load_chroma_intra_quantiser_matrix;
1265 /** \brief Same as the MPEG-2 bitstream syntax element. */
1266 int load_chroma_non_intra_quantiser_matrix;
1267 /** \brief Luminance intra matrix, in zig-zag scan order. */
1268 unsigned char intra_quantiser_matrix[64];
1269 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1270 unsigned char non_intra_quantiser_matrix[64];
1271 /** \brief Chroma intra matrix, in zig-zag scan order. */
1272 unsigned char chroma_intra_quantiser_matrix[64];
1273 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1274 unsigned char chroma_non_intra_quantiser_matrix[64];
1275 } VAIQMatrixBufferMPEG2;
1277 /** MPEG-2 Slice Parameter Buffer */
1278 typedef struct _VASliceParameterBufferMPEG2
1280 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1281 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1282 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1283 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1284 unsigned int slice_horizontal_position;
1285 unsigned int slice_vertical_position;
1286 int quantiser_scale_code;
1287 int intra_slice_flag;
1288 } VASliceParameterBufferMPEG2;
1290 /** MPEG-2 Macroblock Parameter Buffer */
1291 typedef struct _VAMacroblockParameterBufferMPEG2
1293 unsigned short macroblock_address;
1295 * macroblock_address (in raster scan order)
1297 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1299 unsigned char macroblock_type; /* see definition below */
1302 unsigned int frame_motion_type : 2;
1303 unsigned int field_motion_type : 2;
1304 unsigned int dct_type : 1;
1308 unsigned char motion_vertical_field_select;
1310 * motion_vertical_field_select:
1311 * see section 6.3.17.2 in the spec
1312 * only the lower 4 bits are used
1313 * bit 0: first vector forward
1314 * bit 1: first vector backward
1315 * bit 2: second vector forward
1316 * bit 3: second vector backward
1318 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1319 unsigned short coded_block_pattern;
1321 * The bitplanes for coded_block_pattern are described
1322 * in Figure 6.10-12 in the spec
1325 /* Number of skipped macroblocks after this macroblock */
1326 unsigned short num_skipped_macroblocks;
1327 } VAMacroblockParameterBufferMPEG2;
1330 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1332 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1333 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1334 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1335 #define VA_MB_TYPE_MOTION_INTRA 0x10
1338 * MPEG-2 Residual Data Buffer
1339 * For each macroblock, there wil be 64 shorts (16-bit) in the
1340 * residual data buffer
1343 /****************************
1344 * MPEG-4 Part 2 data structures
1345 ****************************/
1347 /* MPEG-4 Picture Parameter Buffer */
1349 * For each frame or field, and before any slice data, a single
1350 * picture parameter buffer must be send.
1352 typedef struct _VAPictureParameterBufferMPEG4
1354 unsigned short vop_width;
1355 unsigned short vop_height;
1356 VASurfaceID forward_reference_picture;
1357 VASurfaceID backward_reference_picture;
1360 unsigned int short_video_header : 1;
1361 unsigned int chroma_format : 2;
1362 unsigned int interlaced : 1;
1363 unsigned int obmc_disable : 1;
1364 unsigned int sprite_enable : 2;
1365 unsigned int sprite_warping_accuracy : 2;
1366 unsigned int quant_type : 1;
1367 unsigned int quarter_sample : 1;
1368 unsigned int data_partitioned : 1;
1369 unsigned int reversible_vlc : 1;
1370 unsigned int resync_marker_disable : 1;
1374 unsigned char no_of_sprite_warping_points;
1375 short sprite_trajectory_du[3];
1376 short sprite_trajectory_dv[3];
1377 unsigned char quant_precision;
1380 unsigned int vop_coding_type : 2;
1381 unsigned int backward_reference_vop_coding_type : 2;
1382 unsigned int vop_rounding_type : 1;
1383 unsigned int intra_dc_vlc_thr : 3;
1384 unsigned int top_field_first : 1;
1385 unsigned int alternate_vertical_scan_flag : 1;
1389 unsigned char vop_fcode_forward;
1390 unsigned char vop_fcode_backward;
1391 unsigned short vop_time_increment_resolution;
1392 /* short header related */
1393 unsigned char num_gobs_in_vop;
1394 unsigned char num_macroblocks_in_gob;
1395 /* for direct mode prediction */
1398 } VAPictureParameterBufferMPEG4;
1400 /** MPEG-4 Inverse Quantization Matrix Buffer */
1401 typedef struct _VAIQMatrixBufferMPEG4
1403 /** Same as the MPEG-4:2 bitstream syntax element. */
1404 int load_intra_quant_mat;
1405 /** Same as the MPEG-4:2 bitstream syntax element. */
1406 int load_non_intra_quant_mat;
1407 /** The matrix for intra blocks, in zig-zag scan order. */
1408 unsigned char intra_quant_mat[64];
1409 /** The matrix for non-intra blocks, in zig-zag scan order. */
1410 unsigned char non_intra_quant_mat[64];
1411 } VAIQMatrixBufferMPEG4;
1413 /** MPEG-4 Slice Parameter Buffer */
1414 typedef struct _VASliceParameterBufferMPEG4
1416 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1417 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1418 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1419 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1420 unsigned int macroblock_number;
1422 } VASliceParameterBufferMPEG4;
1425 VC-1 data structures
1428 typedef enum /* see 7.1.1.32 */
1431 VAMvMode1MvHalfPel = 1,
1432 VAMvMode1MvHalfPelBilinear = 2,
1433 VAMvModeMixedMv = 3,
1434 VAMvModeIntensityCompensation = 4
1437 /** VC-1 Picture Parameter Buffer */
1439 * For each picture, and before any slice data, a picture parameter
1440 * buffer must be send. Multiple picture parameter buffers may be
1441 * sent for a single picture. In that case picture parameters will
1442 * apply to all slice data that follow it until a new picture
1443 * parameter buffer is sent.
1446 * pic_quantizer_type should be set to the applicable quantizer
1447 * type as defined by QUANTIZER (J.1.19) and either
1448 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1450 typedef struct _VAPictureParameterBufferVC1
1452 VASurfaceID forward_reference_picture;
1453 VASurfaceID backward_reference_picture;
1454 /* if out-of-loop post-processing is done on the render
1455 target, then we need to keep the in-loop decoded
1456 picture as a reference picture */
1457 VASurfaceID inloop_decoded_picture;
1459 /* sequence layer for AP or meta data for SP and MP */
1462 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1463 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1464 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1465 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1466 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1467 unsigned int multires : 1; /* METADATA::MULTIRES */
1468 unsigned int overlap : 1; /* METADATA::OVERLAP */
1469 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1470 unsigned int rangered : 1; /* METADATA::RANGERED */
1471 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1472 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1477 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1478 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1481 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1482 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1483 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1484 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1487 } entrypoint_fields;
1488 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1489 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1492 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1493 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1494 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1495 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1498 } range_mapping_fields;
1500 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1501 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1502 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1503 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1504 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1505 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1506 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1507 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1508 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1511 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1512 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1513 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1514 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1515 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1521 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1522 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1523 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1524 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1525 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1526 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1527 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1533 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1534 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1535 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1536 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1537 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1538 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1539 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1542 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1545 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1546 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1547 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1548 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1554 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1555 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1556 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1557 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1558 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1559 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1560 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1561 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1562 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1563 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1569 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1570 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1571 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1572 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1573 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1574 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1575 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1576 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1577 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1578 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1579 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1582 } pic_quantizer_fields;
1585 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1586 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1587 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1588 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1589 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1590 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1594 } VAPictureParameterBufferVC1;
1596 /** VC-1 Bitplane Buffer
1597 There will be at most three bitplanes coded in any picture header. To send
1598 the bitplane data more efficiently, each byte is divided in two nibbles, with
1599 each nibble carrying three bitplanes for one macroblock. The following table
1600 shows the bitplane data arrangement within each nibble based on the picture
1603 Picture Type Bit3 Bit2 Bit1 Bit0
1604 I or BI OVERFLAGS ACPRED FIELDTX
1605 P MYTYPEMB SKIPMB DIRECTMB
1606 B FORWARDMB SKIPMB DIRECTMB
1608 Within each byte, the lower nibble is for the first MB and the upper nibble is
1609 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1610 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1611 Macroblock #2 in the first row.
1614 /* VC-1 Slice Parameter Buffer */
1615 typedef struct _VASliceParameterBufferVC1
1617 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1618 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1619 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1620 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1621 unsigned int slice_vertical_position;
1622 } VASliceParameterBufferVC1;
1624 /* VC-1 Slice Data Buffer */
1626 This is simplely a buffer containing raw bit-stream bytes
1629 /****************************
1630 * H.264/AVC data structures
1631 ****************************/
1633 typedef struct _VAPictureH264
1635 VASurfaceID picture_id;
1636 unsigned int frame_idx;
1638 signed int TopFieldOrderCnt;
1639 signed int BottomFieldOrderCnt;
1641 /* flags in VAPictureH264 could be OR of the following */
1642 #define VA_PICTURE_H264_INVALID 0x00000001
1643 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1644 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1645 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1646 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1648 /** H.264 Picture Parameter Buffer */
1650 * For each picture, and before any slice data, a single
1651 * picture parameter buffer must be send.
1653 typedef struct _VAPictureParameterBufferH264
1655 VAPictureH264 CurrPic;
1656 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1657 unsigned short picture_width_in_mbs_minus1;
1658 unsigned short picture_height_in_mbs_minus1;
1659 unsigned char bit_depth_luma_minus8;
1660 unsigned char bit_depth_chroma_minus8;
1661 unsigned char num_ref_frames;
1664 unsigned int chroma_format_idc : 2;
1665 unsigned int residual_colour_transform_flag : 1;
1666 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1667 unsigned int frame_mbs_only_flag : 1;
1668 unsigned int mb_adaptive_frame_field_flag : 1;
1669 unsigned int direct_8x8_inference_flag : 1;
1670 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1671 unsigned int log2_max_frame_num_minus4 : 4;
1672 unsigned int pic_order_cnt_type : 2;
1673 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1674 unsigned int delta_pic_order_always_zero_flag : 1;
1678 unsigned char num_slice_groups_minus1;
1679 unsigned char slice_group_map_type;
1680 unsigned short slice_group_change_rate_minus1;
1681 signed char pic_init_qp_minus26;
1682 signed char pic_init_qs_minus26;
1683 signed char chroma_qp_index_offset;
1684 signed char second_chroma_qp_index_offset;
1687 unsigned int entropy_coding_mode_flag : 1;
1688 unsigned int weighted_pred_flag : 1;
1689 unsigned int weighted_bipred_idc : 2;
1690 unsigned int transform_8x8_mode_flag : 1;
1691 unsigned int field_pic_flag : 1;
1692 unsigned int constrained_intra_pred_flag : 1;
1693 unsigned int pic_order_present_flag : 1;
1694 unsigned int deblocking_filter_control_present_flag : 1;
1695 unsigned int redundant_pic_cnt_present_flag : 1;
1696 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1700 unsigned short frame_num;
1701 } VAPictureParameterBufferH264;
1703 /** H.264 Inverse Quantization Matrix Buffer */
1704 typedef struct _VAIQMatrixBufferH264
1706 /** \brief 4x4 scaling list, in raster scan order. */
1707 unsigned char ScalingList4x4[6][16];
1708 /** \brief 8x8 scaling list, in raster scan order. */
1709 unsigned char ScalingList8x8[2][64];
1710 } VAIQMatrixBufferH264;
1713 * H.264 Slice Group Map Buffer
1714 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1715 * A slice group map buffer should be sent for each picture if required. The buffer
1716 * is sent only when there is a change in the mapping values.
1717 * The slice group map buffer map "map units" to slice groups as specified in
1718 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1719 * in raster scan order
1722 /** H.264 Slice Parameter Buffer */
1723 typedef struct _VASliceParameterBufferH264
1725 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1726 /** \brief Byte offset to the NAL Header Unit for this slice. */
1727 unsigned int slice_data_offset;
1728 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1730 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1732 * This bit offset is relative to and includes the NAL unit byte
1733 * and represents the number of bits parsed in the slice_header()
1734 * after the removal of any emulation prevention bytes in
1735 * there. However, the slice data buffer passed to the hardware is
1736 * the original bitstream, thus including any emulation prevention
1739 unsigned short slice_data_bit_offset;
1740 unsigned short first_mb_in_slice;
1741 unsigned char slice_type;
1742 unsigned char direct_spatial_mv_pred_flag;
1743 unsigned char num_ref_idx_l0_active_minus1;
1744 unsigned char num_ref_idx_l1_active_minus1;
1745 unsigned char cabac_init_idc;
1746 char slice_qp_delta;
1747 unsigned char disable_deblocking_filter_idc;
1748 char slice_alpha_c0_offset_div2;
1749 char slice_beta_offset_div2;
1750 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1751 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1752 unsigned char luma_log2_weight_denom;
1753 unsigned char chroma_log2_weight_denom;
1754 unsigned char luma_weight_l0_flag;
1755 short luma_weight_l0[32];
1756 short luma_offset_l0[32];
1757 unsigned char chroma_weight_l0_flag;
1758 short chroma_weight_l0[32][2];
1759 short chroma_offset_l0[32][2];
1760 unsigned char luma_weight_l1_flag;
1761 short luma_weight_l1[32];
1762 short luma_offset_l1[32];
1763 unsigned char chroma_weight_l1_flag;
1764 short chroma_weight_l1[32][2];
1765 short chroma_offset_l1[32][2];
1766 } VASliceParameterBufferH264;
1768 /****************************
1769 * Common encode data structures
1770 ****************************/
1773 VAEncPictureTypeIntra = 0,
1774 VAEncPictureTypePredictive = 1,
1775 VAEncPictureTypeBidirectional = 2,
1778 /* Encode Slice Parameter Buffer */
1779 typedef struct _VAEncSliceParameterBuffer
1781 unsigned int start_row_number; /* starting MB row number for this slice */
1782 unsigned int slice_height; /* slice height measured in MB */
1785 unsigned int is_intra : 1;
1786 unsigned int disable_deblocking_filter_idc : 2;
1787 unsigned int uses_long_term_ref :1;
1788 unsigned int is_long_term_ref :1;
1792 } VAEncSliceParameterBuffer;
1795 /****************************
1796 * H.263 specific encode data structures
1797 ****************************/
1799 typedef struct _VAEncSequenceParameterBufferH263
1801 unsigned int intra_period;
1802 unsigned int bits_per_second;
1803 unsigned int frame_rate;
1804 unsigned int initial_qp;
1805 unsigned int min_qp;
1806 } VAEncSequenceParameterBufferH263;
1808 typedef struct _VAEncPictureParameterBufferH263
1810 VASurfaceID reference_picture;
1811 VASurfaceID reconstructed_picture;
1812 VABufferID coded_buf;
1813 unsigned short picture_width;
1814 unsigned short picture_height;
1815 VAEncPictureType picture_type;
1816 } VAEncPictureParameterBufferH263;
1818 /****************************
1819 * MPEG-4 specific encode data structures
1820 ****************************/
1822 typedef struct _VAEncSequenceParameterBufferMPEG4
1824 unsigned char profile_and_level_indication;
1825 unsigned int intra_period;
1826 unsigned int video_object_layer_width;
1827 unsigned int video_object_layer_height;
1828 unsigned int vop_time_increment_resolution;
1829 unsigned int fixed_vop_rate;
1830 unsigned int fixed_vop_time_increment;
1831 unsigned int bits_per_second;
1832 unsigned int frame_rate;
1833 unsigned int initial_qp;
1834 unsigned int min_qp;
1835 } VAEncSequenceParameterBufferMPEG4;
1837 typedef struct _VAEncPictureParameterBufferMPEG4
1839 VASurfaceID reference_picture;
1840 VASurfaceID reconstructed_picture;
1841 VABufferID coded_buf;
1842 unsigned short picture_width;
1843 unsigned short picture_height;
1844 unsigned int modulo_time_base; /* number of 1s */
1845 unsigned int vop_time_increment;
1846 VAEncPictureType picture_type;
1847 } VAEncPictureParameterBufferMPEG4;
1851 /** Buffer functions */
1854 * Creates a buffer for "num_elements" elements of "size" bytes and
1855 * initalize with "data".
1856 * if "data" is null, then the contents of the buffer data store
1858 * Basically there are two ways to get buffer data to the server side. One is
1859 * to call vaCreateBuffer() with a non-null "data", which results the data being
1860 * copied to the data store on the server side. A different method that
1861 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1862 * and then use vaMapBuffer() to map the data store from the server side to the
1863 * client address space for access.
1864 * Note: image buffers are created by the library, not the client. Please see
1865 * vaCreateImage on how image buffers are managed.
1867 VAStatus vaCreateBuffer (
1869 VAContextID context,
1870 VABufferType type, /* in */
1871 unsigned int size, /* in */
1872 unsigned int num_elements, /* in */
1873 void *data, /* in */
1874 VABufferID *buf_id /* out */
1878 * Convey to the server how many valid elements are in the buffer.
1879 * e.g. if multiple slice parameters are being held in a single buffer,
1880 * this will communicate to the server the number of slice parameters
1881 * that are valid in the buffer.
1883 VAStatus vaBufferSetNumElements (
1885 VABufferID buf_id, /* in */
1886 unsigned int num_elements /* in */
1891 * device independent data structure for codedbuffer
1895 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1896 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1897 * enough for the encoder to attempt to limit its size.
1898 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1899 * exceeded the maximum slice size specified.
1900 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1901 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1902 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1904 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1905 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1906 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1907 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1908 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1910 * \brief The frame has exceeded the maximum requested size.
1912 * This flag indicates that the encoded frame size exceeds the value
1913 * specified through a misc parameter buffer of type
1914 * #VAEncMiscParameterTypeMaxFrameSize.
1916 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1917 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1920 * \brief The coded buffer segment contains a single NAL unit.
1922 * This flag indicates that the coded buffer segment contains a
1923 * single NAL unit. This flag might be useful to the user for
1924 * processing the coded buffer.
1926 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1929 * \brief Coded buffer segment.
1931 * #VACodedBufferSegment is an element of a linked list describing
1932 * some information on the coded buffer. The coded buffer segment
1933 * could contain either a single NAL unit, or more than one NAL unit.
1934 * It is recommended (but not required) to return a single NAL unit
1935 * in a coded buffer segment, and the implementation should set the
1936 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1938 typedef struct _VACodedBufferSegment {
1940 * \brief Size of the data buffer in this segment (in bytes).
1943 /** \brief Bit offset into the data buffer where the video data starts. */
1944 unsigned int bit_offset;
1945 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1946 unsigned int status;
1947 /** \brief Reserved for future use. */
1948 unsigned int reserved;
1949 /** \brief Pointer to the start of the data buffer. */
1952 * \brief Pointer to the next #VACodedBufferSegment element,
1953 * or \c NULL if there is none.
1956 } VACodedBufferSegment;
1959 * Map data store of the buffer into the client's address space
1960 * vaCreateBuffer() needs to be called with "data" set to NULL before
1961 * calling vaMapBuffer()
1963 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1964 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1966 VAStatus vaMapBuffer (
1968 VABufferID buf_id, /* in */
1969 void **pbuf /* out */
1973 * After client making changes to a mapped data store, it needs to
1974 * "Unmap" it to let the server know that the data is ready to be
1975 * consumed by the server
1977 VAStatus vaUnmapBuffer (
1979 VABufferID buf_id /* in */
1983 * After this call, the buffer is deleted and this buffer_id is no longer valid
1984 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1986 VAStatus vaDestroyBuffer (
1988 VABufferID buffer_id
1991 /** \brief VA buffer information */
1993 /** \brief Buffer handle */
1995 /** \brief Buffer type (See \ref VABufferType). */
1998 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2000 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2001 * to specify the set of memory types the caller is interested in.
2002 * On successful return from vaAcquireBufferHandle(), the field is
2003 * updated with the best matching memory type.
2006 /** \brief Size of the underlying buffer. */
2011 * \brief Acquires buffer handle for external API usage
2013 * Locks the VA buffer object \ref buf_id for external API usage like
2014 * EGL or OpenCL (OCL). This function is a synchronization point. This
2015 * means that any pending operation is guaranteed to be completed
2016 * prior to returning from the function.
2018 * If the referenced VA buffer object is the backing store of a VA
2019 * surface, then this function acts as if vaSyncSurface() on the
2020 * parent surface was called first.
2022 * The \ref VABufferInfo argument shall be zero'ed on input. On
2023 * successful output, the data structure is filled in with all the
2024 * necessary buffer level implementation details like handle, type,
2025 * memory type and memory size.
2027 * Note: the external API implementation, or the application, can
2028 * express the memory types it is interested in by filling in the \ref
2029 * mem_type field accordingly. On successful output, the memory type
2030 * that fits best the request and that was used is updated in the \ref
2031 * VABufferInfo data structure. If none of the supplied memory types
2032 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2033 * error is returned.
2035 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2036 * is called. Besides, no additional operation is allowed on any of
2037 * the buffer parent object until vaReleaseBufferHandle() is called.
2038 * e.g. decoding into a VA surface backed with the supplied VA buffer
2039 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2043 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2044 * does not support this interface
2045 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2046 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2047 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2048 * does not support exporting buffers of the specified type
2049 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2050 * memory types in \ref VABufferInfo.mem_type was supported
2052 * @param[in] dpy the VA display
2053 * @param[in] buf_id the VA buffer
2054 * @param[in,out] buf_info the associated VA buffer information
2055 * @return VA_STATUS_SUCCESS if successful
2058 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2061 * \brief Releases buffer after usage from external API
2063 * Unlocks the VA buffer object \ref buf_id from external API usage like
2064 * EGL or OpenCL (OCL). This function is a synchronization point. This
2065 * means that any pending operation is guaranteed to be completed
2066 * prior to returning from the function.
2068 * The \ref VABufferInfo argument shall point to the original data
2069 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2070 * This is necessary so that the VA driver implementation could
2071 * deallocate any resources that were needed.
2073 * In any case, returning from this function invalidates any contents
2074 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2075 * valid. Therefore, VA driver implementations are free to reset this
2076 * data structure to safe defaults.
2079 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2080 * does not support this interface
2081 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2082 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2083 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2084 * does not support exporting buffers of the specified type
2086 * @param[in] dpy the VA display
2087 * @param[in] buf_id the VA buffer
2088 * @return VA_STATUS_SUCCESS if successful
2091 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2094 Render (Decode) Pictures
2096 A picture represents either a frame or a field.
2098 The Begin/Render/End sequence sends the decode buffers to the server
2102 * Get ready to decode a picture to a target surface
2104 VAStatus vaBeginPicture (
2106 VAContextID context,
2107 VASurfaceID render_target
2111 * Send decode buffers to the server.
2112 * Buffers are automatically destroyed afterwards
2114 VAStatus vaRenderPicture (
2116 VAContextID context,
2117 VABufferID *buffers,
2122 * Make the end of rendering for a picture.
2123 * The server should start processing all pending operations for this
2124 * surface. This call is non-blocking. The client can start another
2125 * Begin/Render/End sequence on a different render target.
2127 VAStatus vaEndPicture (
2139 * This function blocks until all pending operations on the render target
2140 * have been completed. Upon return it is safe to use the render target for a
2141 * different picture.
2143 VAStatus vaSyncSurface (
2145 VASurfaceID render_target
2150 VASurfaceRendering = 1, /* Rendering in progress */
2151 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2152 /* this status is useful if surface is used as the source */
2154 VASurfaceReady = 4, /* not being rendered or displayed */
2155 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2159 * Find out any pending ops on the render target
2161 VAStatus vaQuerySurfaceStatus (
2163 VASurfaceID render_target,
2164 VASurfaceStatus *status /* out */
2169 VADecodeSliceMissing = 0,
2170 VADecodeMBError = 1,
2171 } VADecodeErrorType;
2174 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2175 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2177 typedef struct _VASurfaceDecodeMBErrors
2179 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2180 unsigned int start_mb; /* start mb address with errors */
2181 unsigned int end_mb; /* end mb address with errors */
2182 VADecodeErrorType decode_error_type;
2183 } VASurfaceDecodeMBErrors;
2186 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2187 * it can call vaQuerySurfaceError to find out further details on the particular error.
2188 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2189 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2190 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2191 * The array is terminated if "status==-1" is detected.
2193 VAStatus vaQuerySurfaceError(
2195 VASurfaceID surface,
2196 VAStatus error_status,
2201 * Images and Subpictures
2202 * VAImage is used to either get the surface data to client memory, or
2203 * to copy image data in client memory to a surface.
2204 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2205 * is at the upper left corner with positive X to the right and positive Y down
2207 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2208 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2209 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2212 * Pre-defined fourcc codes
2214 #define VA_FOURCC_NV12 0x3231564E
2215 #define VA_FOURCC_AI44 0x34344149
2216 #define VA_FOURCC_RGBA 0x41424752
2217 #define VA_FOURCC_RGBX 0x58424752
2218 #define VA_FOURCC_BGRA 0x41524742
2219 #define VA_FOURCC_BGRX 0x58524742
2220 #define VA_FOURCC_ARGB 0x42475241
2221 #define VA_FOURCC_XRGB 0x42475258
2222 #define VA_FOURCC_ABGR 0x52474241
2223 #define VA_FOURCC_XBGR 0x52474258
2224 #define VA_FOURCC_UYVY 0x59565955
2225 #define VA_FOURCC_YUY2 0x32595559
2226 #define VA_FOURCC_AYUV 0x56555941
2227 #define VA_FOURCC_NV11 0x3131564e
2228 #define VA_FOURCC_YV12 0x32315659
2229 #define VA_FOURCC_P208 0x38303250
2230 #define VA_FOURCC_IYUV 0x56555949
2231 #define VA_FOURCC_YV24 0x34325659
2232 #define VA_FOURCC_YV32 0x32335659
2233 #define VA_FOURCC_Y800 0x30303859
2234 #define VA_FOURCC_IMC3 0x33434D49
2235 #define VA_FOURCC_411P 0x50313134
2236 #define VA_FOURCC_422H 0x48323234
2237 #define VA_FOURCC_422V 0x56323234
2238 #define VA_FOURCC_444P 0x50343434
2239 #define VA_FOURCC_RGBP 0x50424752
2240 #define VA_FOURCC_BGRP 0x50524742
2241 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2244 #define VA_LSB_FIRST 1
2245 #define VA_MSB_FIRST 2
2247 typedef struct _VAImageFormat
2249 unsigned int fourcc;
2250 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2251 unsigned int bits_per_pixel;
2252 /* for RGB formats */
2253 unsigned int depth; /* significant bits per pixel */
2254 unsigned int red_mask;
2255 unsigned int green_mask;
2256 unsigned int blue_mask;
2257 unsigned int alpha_mask;
2260 typedef VAGenericID VAImageID;
2262 typedef struct _VAImage
2264 VAImageID image_id; /* uniquely identify this image */
2265 VAImageFormat format;
2266 VABufferID buf; /* image data buffer */
2268 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2269 * data store on the server side for optimal performance. The buffer will be
2270 * created by the CreateImage function, and proper storage allocated based on the image
2271 * size and format. This buffer is managed by the library implementation, and
2272 * accessed by the client through the buffer Map/Unmap functions.
2274 unsigned short width;
2275 unsigned short height;
2276 unsigned int data_size;
2277 unsigned int num_planes; /* can not be greater than 3 */
2279 * An array indicating the scanline pitch in bytes for each plane.
2280 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2282 unsigned int pitches[3];
2284 * An array indicating the byte offset from the beginning of the image data
2285 * to the start of each plane.
2287 unsigned int offsets[3];
2289 /* The following fields are only needed for paletted formats */
2290 int num_palette_entries; /* set to zero for non-palette images */
2292 * Each component is one byte and entry_bytes indicates the number of components in
2293 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2297 * An array of ascii characters describing the order of the components within the bytes.
2298 * Only entry_bytes characters of the string are used.
2300 char component_order[4];
2303 /** Get maximum number of image formats supported by the implementation */
2304 int vaMaxNumImageFormats (
2309 * Query supported image formats
2310 * The caller must provide a "format_list" array that can hold at
2311 * least vaMaxNumImageFormats() entries. The actual number of formats
2312 * returned in "format_list" is returned in "num_formats".
2314 VAStatus vaQueryImageFormats (
2316 VAImageFormat *format_list, /* out */
2317 int *num_formats /* out */
2321 * Create a VAImage structure
2322 * The width and height fields returned in the VAImage structure may get
2323 * enlarged for some YUV formats. Upon return from this function,
2324 * image->buf has been created and proper storage allocated by the library.
2325 * The client can access the image through the Map/Unmap calls.
2327 VAStatus vaCreateImage (
2329 VAImageFormat *format,
2332 VAImage *image /* out */
2336 * Should call DestroyImage before destroying the surface it is bound to
2338 VAStatus vaDestroyImage (
2343 VAStatus vaSetImagePalette (
2347 * pointer to an array holding the palette data. The size of the array is
2348 * num_palette_entries * entry_bytes in size. The order of the components
2349 * in the palette is described by the component_order in VAImage struct
2351 unsigned char *palette
2355 * Retrive surface data into a VAImage
2356 * Image must be in a format supported by the implementation
2358 VAStatus vaGetImage (
2360 VASurfaceID surface,
2361 int x, /* coordinates of the upper left source pixel */
2363 unsigned int width, /* width and height of the region */
2364 unsigned int height,
2369 * Copy data from a VAImage to a surface
2370 * Image must be in a format supported by the implementation
2371 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2372 * shouldn't be rendered into when this is called
2374 VAStatus vaPutImage (
2376 VASurfaceID surface,
2380 unsigned int src_width,
2381 unsigned int src_height,
2384 unsigned int dest_width,
2385 unsigned int dest_height
2389 * Derive an VAImage from an existing surface.
2390 * This interface will derive a VAImage and corresponding image buffer from
2391 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2392 * direct CPU access. This operation is only possible on implementations with
2393 * direct rendering capabilities and internal surface formats that can be
2394 * represented with a VAImage. When the operation is not possible this interface
2395 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2396 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2399 * Implementations should only return success when the resulting image buffer
2400 * would be useable with vaMap/Unmap.
2402 * When directly accessing a surface special care must be taken to insure
2403 * proper synchronization with the graphics hardware. Clients should call
2404 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2405 * rendering or currently being displayed by an overlay.
2407 * Additionally nothing about the contents of a surface should be assumed
2408 * following a vaPutSurface. Implementations are free to modify the surface for
2409 * scaling or subpicture blending within a call to vaPutImage.
2411 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2412 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2413 * vaGetImage with other surfaces is supported.
2415 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2416 * image and image buffer structures will be destroyed; however, the underlying
2417 * surface will remain unchanged until freed with vaDestroySurfaces.
2419 VAStatus vaDeriveImage (
2421 VASurfaceID surface,
2422 VAImage *image /* out */
2427 * Subpicture is a special type of image that can be blended
2428 * with a surface during vaPutSurface(). Subpicture can be used to render
2429 * DVD sub-titles or closed captioning text etc.
2432 typedef VAGenericID VASubpictureID;
2434 /** Get maximum number of subpicture formats supported by the implementation */
2435 int vaMaxNumSubpictureFormats (
2439 /** flags for subpictures */
2440 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2441 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2442 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2444 * Query supported subpicture formats
2445 * The caller must provide a "format_list" array that can hold at
2446 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2447 * for each format to indicate additional capabilities for that format. The actual
2448 * number of formats returned in "format_list" is returned in "num_formats".
2449 * flags: returned value to indicate addtional capabilities
2450 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2451 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2452 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2455 VAStatus vaQuerySubpictureFormats (
2457 VAImageFormat *format_list, /* out */
2458 unsigned int *flags, /* out */
2459 unsigned int *num_formats /* out */
2463 * Subpictures are created with an image associated.
2465 VAStatus vaCreateSubpicture (
2468 VASubpictureID *subpicture /* out */
2472 * Destroy the subpicture before destroying the image it is assocated to
2474 VAStatus vaDestroySubpicture (
2476 VASubpictureID subpicture
2480 * Bind an image to the subpicture. This image will now be associated with
2481 * the subpicture instead of the one at creation.
2483 VAStatus vaSetSubpictureImage (
2485 VASubpictureID subpicture,
2490 * If chromakey is enabled, then the area where the source value falls within
2491 * the chromakey [min, max] range is transparent
2492 * The chromakey component format is the following:
2493 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2494 * For YUV: [0:7] V [8:15] U [16:23] Y
2495 * The chromakey mask can be used to mask out certain components for chromakey
2498 VAStatus vaSetSubpictureChromakey (
2500 VASubpictureID subpicture,
2501 unsigned int chromakey_min,
2502 unsigned int chromakey_max,
2503 unsigned int chromakey_mask
2507 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2508 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2509 * the overall alpha is per-pixel alpha multiplied by the global alpha
2511 VAStatus vaSetSubpictureGlobalAlpha (
2513 VASubpictureID subpicture,
2518 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2519 * It defines the region mapping between the subpicture and the target
2520 * surfaces through source and destination rectangles (with the same width and height).
2521 * Both will be displayed at the next call to vaPutSurface. Additional
2522 * associations before the call to vaPutSurface simply overrides the association.
2524 VAStatus vaAssociateSubpicture (
2526 VASubpictureID subpicture,
2527 VASurfaceID *target_surfaces,
2529 short src_x, /* upper left offset in subpicture */
2531 unsigned short src_width,
2532 unsigned short src_height,
2533 short dest_x, /* upper left offset in surface */
2535 unsigned short dest_width,
2536 unsigned short dest_height,
2538 * whether to enable chroma-keying, global-alpha, or screen relative mode
2539 * see VA_SUBPICTURE_XXX values
2545 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2547 VAStatus vaDeassociateSubpicture (
2549 VASubpictureID subpicture,
2550 VASurfaceID *target_surfaces,
2554 typedef struct _VARectangle
2558 unsigned short width;
2559 unsigned short height;
2563 * Display attributes
2564 * Display attributes are used to control things such as contrast, hue, saturation,
2565 * brightness etc. in the rendering process. The application can query what
2566 * attributes are supported by the driver, and then set the appropriate attributes
2567 * before calling vaPutSurface()
2569 /* PowerVR IEP Lite attributes */
2572 VADISPLAYATTRIB_BLE_OFF = 0x00,
2573 VADISPLAYATTRIB_BLE_LOW,
2574 VADISPLAYATTRIB_BLE_MEDIUM,
2575 VADISPLAYATTRIB_BLE_HIGH,
2576 VADISPLAYATTRIB_BLE_NONE,
2577 } VADisplayAttribBLEMode;
2579 /** attribute value for VADisplayAttribRotation */
2580 #define VA_ROTATION_NONE 0x00000000
2581 #define VA_ROTATION_90 0x00000001
2582 #define VA_ROTATION_180 0x00000002
2583 #define VA_ROTATION_270 0x00000003
2585 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2586 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2587 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2590 #define VA_RENDER_MODE_UNDEFINED 0
2591 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2592 #define VA_RENDER_MODE_LOCAL_GPU 2
2593 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2594 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2596 /** Render device */
2597 #define VA_RENDER_DEVICE_UNDEFINED 0
2598 #define VA_RENDER_DEVICE_LOCAL 1
2599 #define VA_RENDER_DEVICE_EXTERNAL 2
2601 /** Currently defined display attribute types */
2604 VADisplayAttribBrightness = 0,
2605 VADisplayAttribContrast = 1,
2606 VADisplayAttribHue = 2,
2607 VADisplayAttribSaturation = 3,
2608 /* client can specifiy a background color for the target window
2609 * the new feature of video conference,
2610 * the uncovered area of the surface is filled by this color
2611 * also it will blend with the decoded video color
2613 VADisplayAttribBackgroundColor = 4,
2615 * this is a gettable only attribute. For some implementations that use the
2616 * hardware overlay, after PutSurface is called, the surface can not be
2617 * re-used until after the subsequent PutSurface call. If this is the case
2618 * then the value for this attribute will be set to 1 so that the client
2619 * will not attempt to re-use the surface right after returning from a call
2622 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2623 * driver may use overlay or GPU alternatively
2625 VADisplayAttribDirectSurface = 5,
2626 VADisplayAttribRotation = 6,
2627 VADisplayAttribOutofLoopDeblock = 7,
2629 /* PowerVR IEP Lite specific attributes */
2630 VADisplayAttribBLEBlackMode = 8,
2631 VADisplayAttribBLEWhiteMode = 9,
2632 VADisplayAttribBlueStretch = 10,
2633 VADisplayAttribSkinColorCorrection = 11,
2635 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2636 * conversion matrix. Each element in the matrix is float-point
2638 VADisplayAttribCSCMatrix = 12,
2639 /* specify the constant color used to blend with video surface
2640 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2641 * d: the final color to overwrite into the frame buffer
2642 * v: decoded video after color conversion,
2643 * c: video color specified by VADisplayAttribBlendColor
2644 * b: background color of the drawable
2646 VADisplayAttribBlendColor = 13,
2648 * Indicate driver to skip painting color key or not.
2649 * only applicable if the render is overlay
2651 VADisplayAttribOverlayAutoPaintColorKey = 14,
2653 * customized overlay color key, the format is RGB888
2654 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2656 VADisplayAttribOverlayColorKey = 15,
2658 * The hint for the implementation of vaPutSurface
2659 * normally, the driver could use an overlay or GPU to render the surface on the screen
2660 * this flag provides APP the flexibity to switch the render dynamically
2662 VADisplayAttribRenderMode = 16,
2664 * specify if vaPutSurface needs to render into specified monitors
2665 * one example is that one external monitor (e.g. HDMI) is enabled,
2666 * but the window manager is not aware of it, and there is no associated drawable
2668 VADisplayAttribRenderDevice = 17,
2670 * specify vaPutSurface render area if there is no drawable on the monitor
2672 VADisplayAttribRenderRect = 18,
2673 } VADisplayAttribType;
2675 /* flags for VADisplayAttribute */
2676 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2677 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2678 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2680 typedef struct _VADisplayAttribute
2682 VADisplayAttribType type;
2685 int value; /* used by the set/get attribute functions */
2686 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2688 } VADisplayAttribute;
2690 /** Get maximum number of display attributs supported by the implementation */
2691 int vaMaxNumDisplayAttributes (
2696 * Query display attributes
2697 * The caller must provide a "attr_list" array that can hold at
2698 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2699 * returned in "attr_list" is returned in "num_attributes".
2701 VAStatus vaQueryDisplayAttributes (
2703 VADisplayAttribute *attr_list, /* out */
2704 int *num_attributes /* out */
2708 * Get display attributes
2709 * This function returns the current attribute values in "attr_list".
2710 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2711 * from vaQueryDisplayAttributes() can have their values retrieved.
2713 VAStatus vaGetDisplayAttributes (
2715 VADisplayAttribute *attr_list, /* in/out */
2720 * Set display attributes
2721 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2722 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2723 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2725 VAStatus vaSetDisplayAttributes (
2727 VADisplayAttribute *attr_list,
2731 /****************************
2732 * HEVC data structures
2733 ****************************/
2735 * \brief Description of picture properties of those in DPB surfaces.
2737 * If only progressive scan is supported, each surface contains one whole
2739 * Otherwise, each surface contains two fields of whole picture.
2740 * In this case, two entries of ReferenceFrames[] may share same picture_id
2743 typedef struct _VAPictureHEVC
2745 /** \brief reconstructed picture buffer surface index
2746 * invalid when taking value VA_INVALID_SURFACE.
2748 VASurfaceID picture_id;
2749 /** \brief picture order count.
2750 * in HEVC, POCs for top and bottom fields of same picture should
2751 * take different values.
2753 int32_t pic_order_cnt;
2754 /* described below */
2758 /* flags in VAPictureHEVC could be OR of the following */
2759 #define VA_PICTURE_HEVC_INVALID 0x00000001
2760 /** \brief indication of interlace scan picture.
2761 * should take same value for all the pictures in sequence.
2763 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
2764 /** \brief polarity of the field picture.
2765 * top field takes even lines of buffer surface.
2766 * bottom field takes odd lines of buffer surface.
2768 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
2769 /** \brief Long term reference picture */
2770 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
2772 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
2773 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
2774 * be exclusive. No more than one of them can be set for any picture.
2775 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
2776 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
2777 * Application should provide valid values for both short format and long format.
2778 * The pictures in DPB with any of these three flags turned on are referred by
2779 * the current picture.
2781 /** \brief RefPicSetStCurrBefore of HEVC spec variable
2782 * Number of ReferenceFrames[] entries with this bit set equals
2783 * NumPocStCurrBefore.
2785 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
2786 /** \brief RefPicSetStCurrAfter of HEVC spec variable
2787 * Number of ReferenceFrames[] entries with this bit set equals
2788 * NumPocStCurrAfter.
2790 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
2791 /** \brief RefPicSetLtCurr of HEVC spec variable
2792 * Number of ReferenceFrames[] entries with this bit set equals
2795 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
2797 #include <va/va_dec_hevc.h>
2798 #include <va/va_dec_jpeg.h>
2799 #include <va/va_dec_vp8.h>
2800 #include <va/va_dec_vp9.h>
2801 #include <va/va_enc_hevc.h>
2802 #include <va/va_enc_h264.h>
2803 #include <va/va_enc_jpeg.h>
2804 #include <va/va_enc_mpeg2.h>
2805 #include <va/va_enc_vp8.h>
2806 #include <va/va_vpp.h>