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_BT601 0x00000010
209 #define VA_SRC_BT709 0x00000020
210 #define VA_SRC_SMPTE_240 0x00000040
212 /** Scaling flags for vaPutSurface() */
213 #define VA_FILTER_SCALING_DEFAULT 0x00000000
214 #define VA_FILTER_SCALING_FAST 0x00000100
215 #define VA_FILTER_SCALING_HQ 0x00000200
216 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
217 #define VA_FILTER_SCALING_MASK 0x00000f00
220 * Returns a short english description of error_status
222 const char *vaErrorStr(VAStatus error_status);
226 * A display must be obtained by calling vaGetDisplay() before calling
227 * vaInitialize() and other functions. This connects the API to the
228 * native window system.
229 * For X Windows, native_dpy would be from XOpenDisplay()
231 typedef void* VANativeDisplay; /* window system dependent */
233 int vaDisplayIsValid(VADisplay dpy);
236 * Initialize the library
238 VAStatus vaInitialize (
240 int *major_version, /* out */
241 int *minor_version /* out */
245 * After this call, all library internal resources will be cleaned up
247 VAStatus vaTerminate (
252 * vaQueryVendorString returns a pointer to a zero-terminated string
253 * describing some aspects of the VA implemenation on a specific
254 * hardware accelerator. The format of the returned string is vendor
255 * specific and at the discretion of the implementer.
256 * e.g. for the Intel GMA500 implementation, an example would be:
257 * "Intel GMA500 - 2.0.0.32L.0005"
259 const char *vaQueryVendorString (
263 typedef int (*VAPrivFunc)();
266 * Return a function pointer given a function name in the library.
267 * This allows private interfaces into the library
269 VAPrivFunc vaGetLibFunc (
274 /** Currently defined profiles */
277 /** \brief Profile ID used for video processing. */
279 VAProfileMPEG2Simple = 0,
280 VAProfileMPEG2Main = 1,
281 VAProfileMPEG4Simple = 2,
282 VAProfileMPEG4AdvancedSimple = 3,
283 VAProfileMPEG4Main = 4,
284 VAProfileH264Baseline = 5,
285 VAProfileH264Main = 6,
286 VAProfileH264High = 7,
287 VAProfileVC1Simple = 8,
288 VAProfileVC1Main = 9,
289 VAProfileVC1Advanced = 10,
290 VAProfileH263Baseline = 11,
291 VAProfileJPEGBaseline = 12,
292 VAProfileH264ConstrainedBaseline = 13,
293 VAProfileVP8Version0_3 = 14,
294 VAProfileH264MultiviewHigh = 15,
295 VAProfileH264StereoHigh = 16,
296 VAProfileHEVCMain = 17,
297 VAProfileHEVCMain10 = 18
301 * Currently defined entrypoints
307 VAEntrypointIDCT = 3,
308 VAEntrypointMoComp = 4,
309 VAEntrypointDeblocking = 5,
310 VAEntrypointEncSlice = 6, /* slice level encode */
311 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
312 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
315 /** Currently defined configuration attribute types */
318 VAConfigAttribRTFormat = 0,
319 VAConfigAttribSpatialResidual = 1,
320 VAConfigAttribSpatialClipping = 2,
321 VAConfigAttribIntraResidual = 3,
322 VAConfigAttribEncryption = 4,
323 VAConfigAttribRateControl = 5,
325 /** @name Attributes for encoding */
328 * \brief Packed headers mode. Read/write.
330 * This attribute determines what packed headers the driver supports,
331 * through vaGetConfigAttributes(); and what packed headers the user
332 * will be providing to the driver, through vaCreateConfig(), if the
333 * driver supports those.
335 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
337 VAConfigAttribEncPackedHeaders = 10,
339 * \brief Interlaced mode. Read/write.
341 * This attribute determines what kind of interlaced encoding mode
342 * the driver supports.
344 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
346 VAConfigAttribEncInterlaced = 11,
348 * \brief Maximum number of reference frames. Read-only.
350 * This attribute determines the maximum number of reference
351 * frames supported for encoding.
353 * Note: for H.264 encoding, the value represents the maximum number
354 * of reference frames for both the reference picture list 0 (bottom
355 * 16 bits) and the reference picture list 1 (top 16 bits).
357 VAConfigAttribEncMaxRefFrames = 13,
359 * \brief Maximum number of slices per frame. Read-only.
361 * This attribute determines the maximum number of slices the
362 * driver can support to encode a single frame.
364 VAConfigAttribEncMaxSlices = 14,
366 * \brief Slice structure. Read-only.
368 * This attribute determines slice structures supported by the
369 * driver for encoding. This attribute is a hint to the user so
370 * that he can choose a suitable surface size and how to arrange
371 * the encoding process of multiple slices per frame.
373 * More specifically, for H.264 encoding, this attribute
374 * determines the range of accepted values to
375 * VAEncSliceParameterBufferH264::macroblock_address and
376 * VAEncSliceParameterBufferH264::num_macroblocks.
378 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
381 VAConfigAttribEncSliceStructure = 15,
383 * \brief Macroblock information. Read-only.
385 * This attribute determines whether the driver supports extra
386 * encoding information per-macroblock. e.g. QP.
388 * More specifically, for H.264 encoding, if the driver returns a non-zero
389 * value for this attribute, this means the application can create
390 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
391 * through VAEncSliceParameterBufferH264::macroblock_info.
393 VAConfigAttribEncMacroblockInfo = 16,
395 * \brief JPEG encoding attribute. Read-only.
397 * This attribute exposes a number of capabilities of the underlying
398 * JPEG implementation. The attribute value is partitioned into fields as defined in the
399 * VAConfigAttribValEncJPEG union.
401 VAConfigAttribEncJPEG = 20,
403 * \brief Encoding quality range attribute. Read-only.
405 * This attribute conveys whether the driver supports different quality level settings
406 * for encoding. A value less than or equal to 1 means that the encoder only has a single
407 * quality setting, and a value greater than 1 represents the number of quality levels
408 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
410 VAConfigAttribEncQualityRange = 21,
412 VAConfigAttribTypeMax
413 } VAConfigAttribType;
416 * Configuration attributes
417 * If there is more than one value for an attribute, a default
418 * value will be assigned to the attribute if the client does not
419 * specify the attribute when creating a configuration
421 typedef struct _VAConfigAttrib {
422 VAConfigAttribType type;
423 unsigned int value; /* OR'd flags (bits) for this attribute */
426 /** attribute value for VAConfigAttribRTFormat */
427 #define VA_RT_FORMAT_YUV420 0x00000001
428 #define VA_RT_FORMAT_YUV422 0x00000002
429 #define VA_RT_FORMAT_YUV444 0x00000004
430 #define VA_RT_FORMAT_YUV411 0x00000008
431 #define VA_RT_FORMAT_YUV400 0x00000010
432 #define VA_RT_FORMAT_RGB16 0x00010000
433 #define VA_RT_FORMAT_RGB32 0x00020000
434 /* RGBP covers RGBP and BGRP fourcc */
435 #define VA_RT_FORMAT_RGBP 0x00100000
436 #define VA_RT_FORMAT_PROTECTED 0x80000000
438 /** @name Attribute values for VAConfigAttribRateControl */
440 /** \brief Driver does not support any form of rate control. */
441 #define VA_RC_NONE 0x00000001
442 /** \brief Constant bitrate. */
443 #define VA_RC_CBR 0x00000002
444 /** \brief Variable bitrate. */
445 #define VA_RC_VBR 0x00000004
446 /** \brief Video conference mode. */
447 #define VA_RC_VCM 0x00000008
448 /** \brief Constant QP. */
449 #define VA_RC_CQP 0x00000010
450 /** \brief Variable bitrate with peak rate higher than average bitrate. */
451 #define VA_RC_VBR_CONSTRAINED 0x00000020
454 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
456 /** \brief Driver does not support any packed headers mode. */
457 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
458 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
459 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
460 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
461 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
462 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
463 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
464 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
465 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
466 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
467 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
470 /** @name Attribute values for VAConfigAttribEncInterlaced */
472 /** \brief Driver does not support interlaced coding. */
473 #define VA_ENC_INTERLACED_NONE 0x00000000
474 /** \brief Driver supports interlaced frame coding. */
475 #define VA_ENC_INTERLACED_FRAME 0x00000001
476 /** \brief Driver supports interlaced field coding. */
477 #define VA_ENC_INTERLACED_FIELD 0x00000002
478 /** \brief Driver supports macroblock adaptive frame field coding. */
479 #define VA_ENC_INTERLACED_MBAFF 0x00000004
480 /** \brief Driver supports picture adaptive frame field coding. */
481 #define VA_ENC_INTERLACED_PAFF 0x00000008
484 /** @name Attribute values for VAConfigAttribEncSliceStructure */
486 /** \brief Driver supports an arbitrary number of rows per slice. */
487 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
488 /** \brief Driver supports a power-of-two number of rows per slice. */
489 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
490 /** \brief Driver supports an arbitrary number of rows per slice. */
491 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
494 /** \brief Attribute value for VAConfigAttribEncJPEG */
495 typedef union _VAConfigAttribValEncJPEG {
497 /** \brief set to 1 for arithmatic coding. */
498 unsigned int arithmatic_coding_mode : 1;
499 /** \brief set to 1 for progressive dct. */
500 unsigned int progressive_dct_mode : 1;
501 /** \brief set to 1 for non-interleaved. */
502 unsigned int non_interleaved_mode : 1;
503 /** \brief set to 1 for differential. */
504 unsigned int differential_mode : 1;
505 unsigned int max_num_components : 3;
506 unsigned int max_num_scans : 4;
507 unsigned int max_num_huffman_tables : 3;
508 unsigned int max_num_quantization_tables : 3;
511 } VAConfigAttribValEncJPEG;
514 * if an attribute is not applicable for a given
515 * profile/entrypoint pair, then set the value to the following
517 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
519 /** Get maximum number of profiles supported by the implementation */
520 int vaMaxNumProfiles (
524 /** Get maximum number of entrypoints supported by the implementation */
525 int vaMaxNumEntrypoints (
529 /** Get maximum number of attributs supported by the implementation */
530 int vaMaxNumConfigAttributes (
535 * Query supported profiles
536 * The caller must provide a "profile_list" array that can hold at
537 * least vaMaxNumProfile() entries. The actual number of profiles
538 * returned in "profile_list" is returned in "num_profile".
540 VAStatus vaQueryConfigProfiles (
542 VAProfile *profile_list, /* out */
543 int *num_profiles /* out */
547 * Query supported entrypoints for a given profile
548 * The caller must provide an "entrypoint_list" array that can hold at
549 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
550 * returned in "entrypoint_list" is returned in "num_entrypoints".
552 VAStatus vaQueryConfigEntrypoints (
555 VAEntrypoint *entrypoint_list, /* out */
556 int *num_entrypoints /* out */
560 * Get attributes for a given profile/entrypoint pair
561 * The caller must provide an "attrib_list" with all attributes to be
562 * retrieved. Upon return, the attributes in "attrib_list" have been
563 * updated with their value. Unknown attributes or attributes that are
564 * not supported for the given profile/entrypoint pair will have their
565 * value set to VA_ATTRIB_NOT_SUPPORTED
567 VAStatus vaGetConfigAttributes (
570 VAEntrypoint entrypoint,
571 VAConfigAttrib *attrib_list, /* in/out */
575 /** Generic ID type, can be re-typed for specific implementation */
576 typedef unsigned int VAGenericID;
578 typedef VAGenericID VAConfigID;
581 * Create a configuration for the decode pipeline
582 * it passes in the attribute list that specifies the attributes it cares
583 * about, with the rest taking default values.
585 VAStatus vaCreateConfig (
588 VAEntrypoint entrypoint,
589 VAConfigAttrib *attrib_list,
591 VAConfigID *config_id /* out */
595 * Free resources associdated with a given config
597 VAStatus vaDestroyConfig (
603 * Query all attributes for a given configuration
604 * The profile of the configuration is returned in "profile"
605 * The entrypoint of the configuration is returned in "entrypoint"
606 * The caller must provide an "attrib_list" array that can hold at least
607 * vaMaxNumConfigAttributes() entries. The actual number of attributes
608 * returned in "attrib_list" is returned in "num_attribs"
610 VAStatus vaQueryConfigAttributes (
612 VAConfigID config_id,
613 VAProfile *profile, /* out */
614 VAEntrypoint *entrypoint, /* out */
615 VAConfigAttrib *attrib_list,/* out */
616 int *num_attribs /* out */
621 * Contexts and Surfaces
623 * Context represents a "virtual" video decode pipeline. Surfaces are render
624 * targets for a given context. The data in the surfaces are not accessible
625 * to the client and the internal data format of the surface is implementatin
628 * Surfaces will be bound to a context when the context is created. Once
629 * a surface is bound to a given context, it can not be used to create
630 * another context. The association is removed when the context is destroyed
632 * Both contexts and surfaces are identified by unique IDs and its
633 * implementation specific internals are kept opaque to the clients
636 typedef VAGenericID VAContextID;
638 typedef VAGenericID VASurfaceID;
640 #define VA_INVALID_ID 0xffffffff
641 #define VA_INVALID_SURFACE VA_INVALID_ID
643 /** \brief Generic value types. */
645 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
646 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
647 VAGenericValueTypePointer, /**< Generic pointer type */
648 VAGenericValueTypeFunc /**< Pointer to function */
649 } VAGenericValueType;
651 /** \brief Generic function type. */
652 typedef void (*VAGenericFunc)(void);
654 /** \brief Generic value. */
655 typedef struct _VAGenericValue {
656 /** \brief Value type. See #VAGenericValueType. */
657 VAGenericValueType type;
658 /** \brief Value holder. */
660 /** \brief 32-bit signed integer. */
662 /** \brief 32-bit float. */
664 /** \brief Generic pointer. */
666 /** \brief Pointer to function. */
671 /** @name Surface attribute flags */
673 /** \brief Surface attribute is not supported. */
674 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
675 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
676 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
677 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
678 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
681 /** \brief Surface attribute types. */
683 VASurfaceAttribNone = 0,
685 * \brief Pixel format (fourcc).
687 * The value is meaningful as input to vaQuerySurfaceAttributes().
688 * If zero, the driver returns the optimal pixel format for the
689 * specified config. Otherwise, if non-zero, the value represents
690 * a pixel format (FOURCC) that is kept as is on output, if the
691 * driver supports it. Otherwise, the driver sets the value to
692 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
694 VASurfaceAttribPixelFormat,
695 /** \brief Minimal width in pixels (int, read-only). */
696 VASurfaceAttribMinWidth,
697 /** \brief Maximal width in pixels (int, read-only). */
698 VASurfaceAttribMaxWidth,
699 /** \brief Minimal height in pixels (int, read-only). */
700 VASurfaceAttribMinHeight,
701 /** \brief Maximal height in pixels (int, read-only). */
702 VASurfaceAttribMaxHeight,
703 /** \brief Surface memory type expressed in bit fields (int, read/write). */
704 VASurfaceAttribMemoryType,
705 /** \brief External buffer descriptor (pointer, write). */
706 VASurfaceAttribExternalBufferDescriptor,
707 /** \brief Surface usage hint, gives the driver a hint of intended usage
708 * to optimize allocation (e.g. tiling) (int, read/write). */
709 VASurfaceAttribUsageHint,
710 /** \brief Number of surface attributes. */
712 } VASurfaceAttribType;
714 /** \brief Surface attribute. */
715 typedef struct _VASurfaceAttrib {
717 VASurfaceAttribType type;
718 /** \brief Flags. See "Surface attribute flags". */
720 /** \brief Value. See "Surface attribute types" for the expected types. */
721 VAGenericValue value;
725 * @name VASurfaceAttribMemoryType values in bit fields.
726 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
727 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
728 * types are defined in DRM and Android header files.
731 /** \brief VA memory type (default) is supported. */
732 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
733 /** \brief V4L2 buffer memory type is supported. */
734 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
735 /** \brief User pointer memory type is supported. */
736 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
740 * \brief VASurfaceAttribExternalBuffers structure for
741 * the VASurfaceAttribExternalBufferDescriptor attribute.
743 typedef struct _VASurfaceAttribExternalBuffers {
744 /** \brief pixel format in fourcc. */
745 unsigned int pixel_format;
746 /** \brief width in pixels. */
748 /** \brief height in pixels. */
750 /** \brief total size of the buffer in bytes. */
751 unsigned int data_size;
752 /** \brief number of planes for planar layout */
753 unsigned int num_planes;
754 /** \brief pitch for each plane in bytes */
755 unsigned int pitches[4];
756 /** \brief offset for each plane in bytes */
757 unsigned int offsets[4];
758 /** \brief buffer handles or user pointers */
759 unsigned long *buffers;
760 /** \brief number of elements in the "buffers" array */
761 unsigned int num_buffers;
762 /** \brief flags. See "Surface external buffer descriptor flags". */
764 /** \brief reserved for passing private data */
766 } VASurfaceAttribExternalBuffers;
768 /** @name VASurfaceAttribExternalBuffers flags */
770 /** \brief Enable memory tiling */
771 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
772 /** \brief Memory is cacheable */
773 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
774 /** \brief Memory is non-cacheable */
775 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
776 /** \brief Memory is write-combined */
777 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
778 /** \brief Memory is protected */
779 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
781 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
783 /** \brief Surface usage not indicated. */
784 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
785 /** \brief Surface used by video decoder. */
786 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
787 /** \brief Surface used by video encoder. */
788 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
789 /** \brief Surface read by video post-processing. */
790 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
791 /** \brief Surface written by video post-processing. */
792 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
793 /** \brief Surface used for display. */
794 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
799 * \brief Queries surface attributes for the supplied config.
801 * Unlike vaGetSurfaceAttributes(), this function queries for all
802 * supported attributes for the supplied VA @config. In particular, if
803 * the underlying hardware supports the creation of VA surfaces in
804 * various formats, then this function will enumerate all pixel
805 * formats that are supported.
807 * The \c attrib_list array is allocated by the user and \c
808 * num_attribs shall be initialized to the number of allocated
809 * elements in that array. Upon successful return, the actual number
810 * of attributes will be overwritten into \c num_attribs. Otherwise,
811 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
812 * is adjusted to the number of elements that would be returned if
813 * enough space was available.
815 * Note: it is perfectly valid to pass NULL to the \c attrib_list
816 * argument when vaQuerySurfaceAttributes() is used to determine the
817 * actual number of elements that need to be allocated.
819 * @param[in] dpy the VA display
820 * @param[in] config the config identifying a codec or a video
821 * processing pipeline
822 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
823 * @param[in,out] num_attribs the number of elements allocated on
824 * input, the number of elements actually filled in output
827 vaQuerySurfaceAttributes(
830 VASurfaceAttrib *attrib_list,
831 unsigned int *num_attribs
835 * \brief Creates an array of surfaces
837 * Creates an array of surfaces. The optional list of attributes shall
838 * be constructed and validated through vaGetSurfaceAttributes() or
839 * constructed based based on what the underlying hardware could
840 * expose through vaQuerySurfaceAttributes().
842 * @param[in] dpy the VA display
843 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
844 * @param[in] width the surface width
845 * @param[in] height the surface height
846 * @param[out] surfaces the array of newly created surfaces
847 * @param[in] num_surfaces the number of surfaces to create
848 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
849 * @param[in] num_attribs the number of attributes supplied in
850 * \c attrib_list, or zero
858 VASurfaceID *surfaces,
859 unsigned int num_surfaces,
860 VASurfaceAttrib *attrib_list,
861 unsigned int num_attribs
865 * vaDestroySurfaces - Destroy resources associated with surfaces.
866 * Surfaces can only be destroyed after the context associated has been
869 * surfaces: array of surfaces to destroy
870 * num_surfaces: number of surfaces in the array to be destroyed.
872 VAStatus vaDestroySurfaces (
874 VASurfaceID *surfaces,
878 #define VA_PROGRESSIVE 0x1
880 * vaCreateContext - Create a context
882 * config_id: configuration for the context
883 * picture_width: coded picture width
884 * picture_height: coded picture height
885 * flag: any combination of the following:
886 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
887 * render_targets: render targets (surfaces) tied to the context
888 * num_render_targets: number of render targets in the above array
889 * context: created context id upon return
891 VAStatus vaCreateContext (
893 VAConfigID config_id,
897 VASurfaceID *render_targets,
898 int num_render_targets,
899 VAContextID *context /* out */
903 * vaDestroyContext - Destroy a context
905 * context: context to be destroyed
907 VAStatus vaDestroyContext (
914 * Buffers are used to pass various types of data from the
915 * client to the server. The server maintains a data store
916 * for each buffer created, and the client idenfies a buffer
917 * through a unique buffer id assigned by the server.
920 typedef VAGenericID VABufferID;
924 VAPictureParameterBufferType = 0,
925 VAIQMatrixBufferType = 1,
926 VABitPlaneBufferType = 2,
927 VASliceGroupMapBufferType = 3,
928 VASliceParameterBufferType = 4,
929 VASliceDataBufferType = 5,
930 VAMacroblockParameterBufferType = 6,
931 VAResidualDataBufferType = 7,
932 VADeblockingParameterBufferType = 8,
933 VAImageBufferType = 9,
934 VAProtectedSliceDataBufferType = 10,
935 VAQMatrixBufferType = 11,
936 VAHuffmanTableBufferType = 12,
937 VAProbabilityBufferType = 13,
939 /* Following are encode buffer types */
940 VAEncCodedBufferType = 21,
941 VAEncSequenceParameterBufferType = 22,
942 VAEncPictureParameterBufferType = 23,
943 VAEncSliceParameterBufferType = 24,
944 VAEncPackedHeaderParameterBufferType = 25,
945 VAEncPackedHeaderDataBufferType = 26,
946 VAEncMiscParameterBufferType = 27,
947 VAEncMacroblockParameterBufferType = 28,
948 VAEncMacroblockMapBufferType = 29,
949 /* Following are video processing buffer types */
951 * \brief Video processing pipeline parameter buffer.
953 * This buffer describes the video processing pipeline. See
954 * #VAProcPipelineParameterBuffer for details.
956 VAProcPipelineParameterBufferType = 41,
958 * \brief Video filter parameter buffer.
960 * This buffer describes the video filter parameters. All buffers
961 * inherit from #VAProcFilterParameterBufferBase, thus including
962 * a unique filter buffer type.
964 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
965 * Filters requiring advanced parameters include, but are not limited to,
966 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
967 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
969 VAProcFilterParameterBufferType = 42,
975 VAEncMiscParameterTypeFrameRate = 0,
976 VAEncMiscParameterTypeRateControl = 1,
977 VAEncMiscParameterTypeMaxSliceSize = 2,
978 VAEncMiscParameterTypeAIR = 3,
979 /** \brief Buffer type used to express a maximum frame size (in bits). */
980 VAEncMiscParameterTypeMaxFrameSize = 4,
981 /** \brief Buffer type used for HRD parameters. */
982 VAEncMiscParameterTypeHRD = 5,
983 VAEncMiscParameterTypeQualityLevel = 6,
984 } VAEncMiscParameterType;
986 /** \brief Packed header type. */
988 /** \brief Packed sequence header. */
989 VAEncPackedHeaderSequence = 1,
990 /** \brief Packed picture header. */
991 VAEncPackedHeaderPicture = 2,
992 /** \brief Packed slice header. */
993 VAEncPackedHeaderSlice = 3,
995 * \brief Packed raw header.
997 * Packed raw data header can be used by the client to insert a header
998 * into the bitstream data buffer at the point it is passed, the driver
999 * will handle the raw packed header based on "has_emulation_bytes" field
1000 * in the packed header parameter structure.
1002 VAEncPackedHeaderRawData = 4,
1003 /** \brief Misc packed header. See codec-specific definitions. */
1004 VAEncPackedHeaderMiscMask = 0x80000000,
1005 } VAEncPackedHeaderType;
1007 /** \brief Packed header parameter. */
1008 typedef struct _VAEncPackedHeaderParameterBuffer {
1009 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1011 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1012 unsigned int bit_length;
1013 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1014 unsigned char has_emulation_bytes;
1015 } VAEncPackedHeaderParameterBuffer;
1018 * For application, e.g. set a new bitrate
1019 * VABufferID buf_id;
1020 * VAEncMiscParameterBuffer *misc_param;
1021 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1023 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1024 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1025 * 1, NULL, &buf_id);
1027 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1028 * misc_param->type = VAEncMiscParameterTypeRateControl;
1029 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1030 * misc_rate_ctrl->bits_per_second = 6400000;
1031 * vaUnmapBuffer(dpy, buf_id);
1032 * vaRenderPicture(dpy, context, &buf_id, 1);
1034 typedef struct _VAEncMiscParameterBuffer
1036 VAEncMiscParameterType type;
1037 unsigned int data[0];
1038 } VAEncMiscParameterBuffer;
1041 /** \brief Rate control parameters */
1042 typedef struct _VAEncMiscParameterRateControl
1044 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1045 unsigned int bits_per_second;
1046 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1047 * bit-rate for example if target_percentage is 95 then the rate control will target
1048 * a bit-rate that is 95% of the maximum bit-rate
1050 unsigned int target_percentage;
1051 /* windows size in milliseconds. For example if this is set to 500,
1052 * then the rate control will guarantee the target bit-rate over a 500 ms window
1054 unsigned int window_size;
1055 /* initial QP at I frames */
1056 unsigned int initial_qp;
1057 unsigned int min_qp;
1058 unsigned int basic_unit_size;
1063 unsigned int reset : 1;
1064 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1065 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1069 } VAEncMiscParameterRateControl;
1071 typedef struct _VAEncMiscParameterFrameRate
1073 unsigned int framerate;
1074 } VAEncMiscParameterFrameRate;
1077 * Allow a maximum slice size to be specified (in bits).
1078 * The encoder will attempt to make sure that individual slices do not exceed this size
1079 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1081 typedef struct _VAEncMiscParameterMaxSliceSize
1083 unsigned int max_slice_size;
1084 } VAEncMiscParameterMaxSliceSize;
1086 typedef struct _VAEncMiscParameterAIR
1088 unsigned int air_num_mbs;
1089 unsigned int air_threshold;
1090 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1091 } VAEncMiscParameterAIR;
1093 typedef struct _VAEncMiscParameterHRD
1095 unsigned int initial_buffer_fullness; /* in bits */
1096 unsigned int buffer_size; /* in bits */
1097 } VAEncMiscParameterHRD;
1100 * \brief Defines a maximum frame size (in bits).
1102 * This misc parameter buffer defines the maximum size of a frame (in
1103 * bits). The encoder will try to make sure that each frame does not
1104 * exceed this size. Otherwise, if the frame size exceeds this size,
1105 * the \c status flag of #VACodedBufferSegment will contain
1106 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1108 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1109 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1110 VAEncMiscParameterType type;
1111 /** \brief Maximum size of a frame (in bits). */
1112 unsigned int max_frame_size;
1113 } VAEncMiscParameterBufferMaxFrameSize;
1116 * \brief Encoding quality level.
1118 * The encoding quality could be set through this structure, if the implementation
1119 * supports multiple quality levels. The quality level set through this structure is
1120 * persistent over the entire coded sequence, or until a new structure is being sent.
1121 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1122 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1123 * quality. The quality level setting is used as a trade-off between quality and speed/power
1124 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1126 typedef struct _VAEncMiscParameterBufferQualityLevel {
1127 /** \brief Encoding quality level setting. When set to 0, default quality
1130 unsigned int quality_level;
1131 } VAEncMiscParameterBufferQualityLevel;
1134 * There will be cases where the bitstream buffer will not have enough room to hold
1135 * the data for the entire slice, and the following flags will be used in the slice
1136 * parameter to signal to the server for the possible cases.
1137 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1138 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1139 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1141 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1142 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1143 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1144 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1146 /* Codec-independent Slice Parameter Buffer base */
1147 typedef struct _VASliceParameterBufferBase
1149 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1150 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1151 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1152 } VASliceParameterBufferBase;
1154 /**********************************
1155 * JPEG common data structures
1156 **********************************/
1158 * \brief Huffman table for JPEG decoding.
1160 * This structure holds the complete Huffman tables. This is an
1161 * aggregation of all Huffman table (DHT) segments maintained by the
1162 * application. i.e. up to 2 Huffman tables are stored in there for
1165 * The #load_huffman_table array can be used as a hint to notify the
1166 * VA driver implementation about which table(s) actually changed
1167 * since the last submission of this buffer.
1169 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1170 /** \brief Specifies which #huffman_table is valid. */
1171 unsigned char load_huffman_table[2];
1172 /** \brief Huffman tables indexed by table identifier (Th). */
1174 /** @name DC table (up to 12 categories) */
1176 /** \brief Number of Huffman codes of length i + 1 (Li). */
1177 unsigned char num_dc_codes[16];
1178 /** \brief Value associated with each Huffman code (Vij). */
1179 unsigned char dc_values[12];
1181 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1183 /** \brief Number of Huffman codes of length i + 1 (Li). */
1184 unsigned char num_ac_codes[16];
1185 /** \brief Value associated with each Huffman code (Vij). */
1186 unsigned char ac_values[162];
1187 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1188 unsigned char pad[2];
1191 } VAHuffmanTableBufferJPEGBaseline;
1193 #include <va/va_dec_jpeg.h>
1195 /****************************
1196 * MPEG-2 data structures
1197 ****************************/
1199 /* MPEG-2 Picture Parameter Buffer */
1201 * For each frame or field, and before any slice data, a single
1202 * picture parameter buffer must be send.
1204 typedef struct _VAPictureParameterBufferMPEG2
1206 unsigned short horizontal_size;
1207 unsigned short vertical_size;
1208 VASurfaceID forward_reference_picture;
1209 VASurfaceID backward_reference_picture;
1210 /* meanings of the following fields are the same as in the standard */
1211 int picture_coding_type;
1212 int f_code; /* pack all four fcode into this */
1215 unsigned int intra_dc_precision : 2;
1216 unsigned int picture_structure : 2;
1217 unsigned int top_field_first : 1;
1218 unsigned int frame_pred_frame_dct : 1;
1219 unsigned int concealment_motion_vectors : 1;
1220 unsigned int q_scale_type : 1;
1221 unsigned int intra_vlc_format : 1;
1222 unsigned int alternate_scan : 1;
1223 unsigned int repeat_first_field : 1;
1224 unsigned int progressive_frame : 1;
1225 unsigned int is_first_field : 1; /* indicate whether the current field
1226 * is the first field for field picture
1230 } picture_coding_extension;
1231 } VAPictureParameterBufferMPEG2;
1233 /** MPEG-2 Inverse Quantization Matrix Buffer */
1234 typedef struct _VAIQMatrixBufferMPEG2
1236 /** \brief Same as the MPEG-2 bitstream syntax element. */
1237 int load_intra_quantiser_matrix;
1238 /** \brief Same as the MPEG-2 bitstream syntax element. */
1239 int load_non_intra_quantiser_matrix;
1240 /** \brief Same as the MPEG-2 bitstream syntax element. */
1241 int load_chroma_intra_quantiser_matrix;
1242 /** \brief Same as the MPEG-2 bitstream syntax element. */
1243 int load_chroma_non_intra_quantiser_matrix;
1244 /** \brief Luminance intra matrix, in zig-zag scan order. */
1245 unsigned char intra_quantiser_matrix[64];
1246 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1247 unsigned char non_intra_quantiser_matrix[64];
1248 /** \brief Chroma intra matrix, in zig-zag scan order. */
1249 unsigned char chroma_intra_quantiser_matrix[64];
1250 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1251 unsigned char chroma_non_intra_quantiser_matrix[64];
1252 } VAIQMatrixBufferMPEG2;
1254 /** MPEG-2 Slice Parameter Buffer */
1255 typedef struct _VASliceParameterBufferMPEG2
1257 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1258 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1259 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1260 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1261 unsigned int slice_horizontal_position;
1262 unsigned int slice_vertical_position;
1263 int quantiser_scale_code;
1264 int intra_slice_flag;
1265 } VASliceParameterBufferMPEG2;
1267 /** MPEG-2 Macroblock Parameter Buffer */
1268 typedef struct _VAMacroblockParameterBufferMPEG2
1270 unsigned short macroblock_address;
1272 * macroblock_address (in raster scan order)
1274 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1276 unsigned char macroblock_type; /* see definition below */
1279 unsigned int frame_motion_type : 2;
1280 unsigned int field_motion_type : 2;
1281 unsigned int dct_type : 1;
1285 unsigned char motion_vertical_field_select;
1287 * motion_vertical_field_select:
1288 * see section 6.3.17.2 in the spec
1289 * only the lower 4 bits are used
1290 * bit 0: first vector forward
1291 * bit 1: first vector backward
1292 * bit 2: second vector forward
1293 * bit 3: second vector backward
1295 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1296 unsigned short coded_block_pattern;
1298 * The bitplanes for coded_block_pattern are described
1299 * in Figure 6.10-12 in the spec
1302 /* Number of skipped macroblocks after this macroblock */
1303 unsigned short num_skipped_macroblocks;
1304 } VAMacroblockParameterBufferMPEG2;
1307 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1309 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1310 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1311 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1312 #define VA_MB_TYPE_MOTION_INTRA 0x10
1315 * MPEG-2 Residual Data Buffer
1316 * For each macroblock, there wil be 64 shorts (16-bit) in the
1317 * residual data buffer
1320 /****************************
1321 * MPEG-4 Part 2 data structures
1322 ****************************/
1324 /* MPEG-4 Picture Parameter Buffer */
1326 * For each frame or field, and before any slice data, a single
1327 * picture parameter buffer must be send.
1329 typedef struct _VAPictureParameterBufferMPEG4
1331 unsigned short vop_width;
1332 unsigned short vop_height;
1333 VASurfaceID forward_reference_picture;
1334 VASurfaceID backward_reference_picture;
1337 unsigned int short_video_header : 1;
1338 unsigned int chroma_format : 2;
1339 unsigned int interlaced : 1;
1340 unsigned int obmc_disable : 1;
1341 unsigned int sprite_enable : 2;
1342 unsigned int sprite_warping_accuracy : 2;
1343 unsigned int quant_type : 1;
1344 unsigned int quarter_sample : 1;
1345 unsigned int data_partitioned : 1;
1346 unsigned int reversible_vlc : 1;
1347 unsigned int resync_marker_disable : 1;
1351 unsigned char no_of_sprite_warping_points;
1352 short sprite_trajectory_du[3];
1353 short sprite_trajectory_dv[3];
1354 unsigned char quant_precision;
1357 unsigned int vop_coding_type : 2;
1358 unsigned int backward_reference_vop_coding_type : 2;
1359 unsigned int vop_rounding_type : 1;
1360 unsigned int intra_dc_vlc_thr : 3;
1361 unsigned int top_field_first : 1;
1362 unsigned int alternate_vertical_scan_flag : 1;
1366 unsigned char vop_fcode_forward;
1367 unsigned char vop_fcode_backward;
1368 unsigned short vop_time_increment_resolution;
1369 /* short header related */
1370 unsigned char num_gobs_in_vop;
1371 unsigned char num_macroblocks_in_gob;
1372 /* for direct mode prediction */
1375 } VAPictureParameterBufferMPEG4;
1377 /** MPEG-4 Inverse Quantization Matrix Buffer */
1378 typedef struct _VAIQMatrixBufferMPEG4
1380 /** Same as the MPEG-4:2 bitstream syntax element. */
1381 int load_intra_quant_mat;
1382 /** Same as the MPEG-4:2 bitstream syntax element. */
1383 int load_non_intra_quant_mat;
1384 /** The matrix for intra blocks, in zig-zag scan order. */
1385 unsigned char intra_quant_mat[64];
1386 /** The matrix for non-intra blocks, in zig-zag scan order. */
1387 unsigned char non_intra_quant_mat[64];
1388 } VAIQMatrixBufferMPEG4;
1390 /** MPEG-4 Slice Parameter Buffer */
1391 typedef struct _VASliceParameterBufferMPEG4
1393 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1394 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1395 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1396 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1397 unsigned int macroblock_number;
1399 } VASliceParameterBufferMPEG4;
1402 VC-1 data structures
1405 typedef enum /* see 7.1.1.32 */
1408 VAMvMode1MvHalfPel = 1,
1409 VAMvMode1MvHalfPelBilinear = 2,
1410 VAMvModeMixedMv = 3,
1411 VAMvModeIntensityCompensation = 4
1414 /** VC-1 Picture Parameter Buffer */
1416 * For each picture, and before any slice data, a picture parameter
1417 * buffer must be send. Multiple picture parameter buffers may be
1418 * sent for a single picture. In that case picture parameters will
1419 * apply to all slice data that follow it until a new picture
1420 * parameter buffer is sent.
1423 * pic_quantizer_type should be set to the applicable quantizer
1424 * type as defined by QUANTIZER (J.1.19) and either
1425 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1427 typedef struct _VAPictureParameterBufferVC1
1429 VASurfaceID forward_reference_picture;
1430 VASurfaceID backward_reference_picture;
1431 /* if out-of-loop post-processing is done on the render
1432 target, then we need to keep the in-loop decoded
1433 picture as a reference picture */
1434 VASurfaceID inloop_decoded_picture;
1436 /* sequence layer for AP or meta data for SP and MP */
1439 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1440 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1441 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1442 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1443 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1444 unsigned int multires : 1; /* METADATA::MULTIRES */
1445 unsigned int overlap : 1; /* METADATA::OVERLAP */
1446 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1447 unsigned int rangered : 1; /* METADATA::RANGERED */
1448 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1449 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1454 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1455 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1458 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1459 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1460 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1461 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1464 } entrypoint_fields;
1465 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1466 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1469 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1470 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1471 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1472 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1475 } range_mapping_fields;
1477 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1478 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1479 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1480 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1481 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1482 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1483 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1484 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1485 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1488 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1489 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1490 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1491 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1492 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1498 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1499 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1500 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1501 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1502 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1503 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1504 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1510 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1511 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1512 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1513 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1514 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1515 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1516 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1519 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1522 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1523 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1524 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1525 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1531 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1532 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1533 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1534 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1535 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1536 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1537 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1538 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1539 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1540 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1546 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1547 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1548 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1549 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1550 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1551 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1552 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1553 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1554 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1555 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1556 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1559 } pic_quantizer_fields;
1562 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1563 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1564 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1565 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1566 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1567 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1571 } VAPictureParameterBufferVC1;
1573 /** VC-1 Bitplane Buffer
1574 There will be at most three bitplanes coded in any picture header. To send
1575 the bitplane data more efficiently, each byte is divided in two nibbles, with
1576 each nibble carrying three bitplanes for one macroblock. The following table
1577 shows the bitplane data arrangement within each nibble based on the picture
1580 Picture Type Bit3 Bit2 Bit1 Bit0
1581 I or BI OVERFLAGS ACPRED FIELDTX
1582 P MYTYPEMB SKIPMB DIRECTMB
1583 B FORWARDMB SKIPMB DIRECTMB
1585 Within each byte, the lower nibble is for the first MB and the upper nibble is
1586 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1587 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1588 Macroblock #2 in the first row.
1591 /* VC-1 Slice Parameter Buffer */
1592 typedef struct _VASliceParameterBufferVC1
1594 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1595 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1596 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1597 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1598 unsigned int slice_vertical_position;
1599 } VASliceParameterBufferVC1;
1601 /* VC-1 Slice Data Buffer */
1603 This is simplely a buffer containing raw bit-stream bytes
1606 /****************************
1607 * H.264/AVC data structures
1608 ****************************/
1610 typedef struct _VAPictureH264
1612 VASurfaceID picture_id;
1613 unsigned int frame_idx;
1615 signed int TopFieldOrderCnt;
1616 signed int BottomFieldOrderCnt;
1618 /* flags in VAPictureH264 could be OR of the following */
1619 #define VA_PICTURE_H264_INVALID 0x00000001
1620 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1621 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1622 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1623 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1625 /** H.264 Picture Parameter Buffer */
1627 * For each picture, and before any slice data, a single
1628 * picture parameter buffer must be send.
1630 typedef struct _VAPictureParameterBufferH264
1632 VAPictureH264 CurrPic;
1633 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1634 unsigned short picture_width_in_mbs_minus1;
1635 unsigned short picture_height_in_mbs_minus1;
1636 unsigned char bit_depth_luma_minus8;
1637 unsigned char bit_depth_chroma_minus8;
1638 unsigned char num_ref_frames;
1641 unsigned int chroma_format_idc : 2;
1642 unsigned int residual_colour_transform_flag : 1;
1643 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1644 unsigned int frame_mbs_only_flag : 1;
1645 unsigned int mb_adaptive_frame_field_flag : 1;
1646 unsigned int direct_8x8_inference_flag : 1;
1647 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1648 unsigned int log2_max_frame_num_minus4 : 4;
1649 unsigned int pic_order_cnt_type : 2;
1650 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1651 unsigned int delta_pic_order_always_zero_flag : 1;
1655 unsigned char num_slice_groups_minus1;
1656 unsigned char slice_group_map_type;
1657 unsigned short slice_group_change_rate_minus1;
1658 signed char pic_init_qp_minus26;
1659 signed char pic_init_qs_minus26;
1660 signed char chroma_qp_index_offset;
1661 signed char second_chroma_qp_index_offset;
1664 unsigned int entropy_coding_mode_flag : 1;
1665 unsigned int weighted_pred_flag : 1;
1666 unsigned int weighted_bipred_idc : 2;
1667 unsigned int transform_8x8_mode_flag : 1;
1668 unsigned int field_pic_flag : 1;
1669 unsigned int constrained_intra_pred_flag : 1;
1670 unsigned int pic_order_present_flag : 1;
1671 unsigned int deblocking_filter_control_present_flag : 1;
1672 unsigned int redundant_pic_cnt_present_flag : 1;
1673 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1677 unsigned short frame_num;
1678 } VAPictureParameterBufferH264;
1680 /** H.264 Inverse Quantization Matrix Buffer */
1681 typedef struct _VAIQMatrixBufferH264
1683 /** \brief 4x4 scaling list, in raster scan order. */
1684 unsigned char ScalingList4x4[6][16];
1685 /** \brief 8x8 scaling list, in raster scan order. */
1686 unsigned char ScalingList8x8[2][64];
1687 } VAIQMatrixBufferH264;
1690 * H.264 Slice Group Map Buffer
1691 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1692 * A slice group map buffer should be sent for each picture if required. The buffer
1693 * is sent only when there is a change in the mapping values.
1694 * The slice group map buffer map "map units" to slice groups as specified in
1695 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1696 * in raster scan order
1699 /** H.264 Slice Parameter Buffer */
1700 typedef struct _VASliceParameterBufferH264
1702 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1703 /** \brief Byte offset to the NAL Header Unit for this slice. */
1704 unsigned int slice_data_offset;
1705 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1707 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1709 * This bit offset is relative to and includes the NAL unit byte
1710 * and represents the number of bits parsed in the slice_header()
1711 * after the removal of any emulation prevention bytes in
1712 * there. However, the slice data buffer passed to the hardware is
1713 * the original bitstream, thus including any emulation prevention
1716 unsigned short slice_data_bit_offset;
1717 unsigned short first_mb_in_slice;
1718 unsigned char slice_type;
1719 unsigned char direct_spatial_mv_pred_flag;
1720 unsigned char num_ref_idx_l0_active_minus1;
1721 unsigned char num_ref_idx_l1_active_minus1;
1722 unsigned char cabac_init_idc;
1723 char slice_qp_delta;
1724 unsigned char disable_deblocking_filter_idc;
1725 char slice_alpha_c0_offset_div2;
1726 char slice_beta_offset_div2;
1727 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1728 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1729 unsigned char luma_log2_weight_denom;
1730 unsigned char chroma_log2_weight_denom;
1731 unsigned char luma_weight_l0_flag;
1732 short luma_weight_l0[32];
1733 short luma_offset_l0[32];
1734 unsigned char chroma_weight_l0_flag;
1735 short chroma_weight_l0[32][2];
1736 short chroma_offset_l0[32][2];
1737 unsigned char luma_weight_l1_flag;
1738 short luma_weight_l1[32];
1739 short luma_offset_l1[32];
1740 unsigned char chroma_weight_l1_flag;
1741 short chroma_weight_l1[32][2];
1742 short chroma_offset_l1[32][2];
1743 } VASliceParameterBufferH264;
1745 /****************************
1746 * Common encode data structures
1747 ****************************/
1750 VAEncPictureTypeIntra = 0,
1751 VAEncPictureTypePredictive = 1,
1752 VAEncPictureTypeBidirectional = 2,
1755 /* Encode Slice Parameter Buffer */
1756 typedef struct _VAEncSliceParameterBuffer
1758 unsigned int start_row_number; /* starting MB row number for this slice */
1759 unsigned int slice_height; /* slice height measured in MB */
1762 unsigned int is_intra : 1;
1763 unsigned int disable_deblocking_filter_idc : 2;
1764 unsigned int uses_long_term_ref :1;
1765 unsigned int is_long_term_ref :1;
1769 } VAEncSliceParameterBuffer;
1772 /****************************
1773 * H.263 specific encode data structures
1774 ****************************/
1776 typedef struct _VAEncSequenceParameterBufferH263
1778 unsigned int intra_period;
1779 unsigned int bits_per_second;
1780 unsigned int frame_rate;
1781 unsigned int initial_qp;
1782 unsigned int min_qp;
1783 } VAEncSequenceParameterBufferH263;
1785 typedef struct _VAEncPictureParameterBufferH263
1787 VASurfaceID reference_picture;
1788 VASurfaceID reconstructed_picture;
1789 VABufferID coded_buf;
1790 unsigned short picture_width;
1791 unsigned short picture_height;
1792 VAEncPictureType picture_type;
1793 } VAEncPictureParameterBufferH263;
1795 /****************************
1796 * MPEG-4 specific encode data structures
1797 ****************************/
1799 typedef struct _VAEncSequenceParameterBufferMPEG4
1801 unsigned char profile_and_level_indication;
1802 unsigned int intra_period;
1803 unsigned int video_object_layer_width;
1804 unsigned int video_object_layer_height;
1805 unsigned int vop_time_increment_resolution;
1806 unsigned int fixed_vop_rate;
1807 unsigned int fixed_vop_time_increment;
1808 unsigned int bits_per_second;
1809 unsigned int frame_rate;
1810 unsigned int initial_qp;
1811 unsigned int min_qp;
1812 } VAEncSequenceParameterBufferMPEG4;
1814 typedef struct _VAEncPictureParameterBufferMPEG4
1816 VASurfaceID reference_picture;
1817 VASurfaceID reconstructed_picture;
1818 VABufferID coded_buf;
1819 unsigned short picture_width;
1820 unsigned short picture_height;
1821 unsigned int modulo_time_base; /* number of 1s */
1822 unsigned int vop_time_increment;
1823 VAEncPictureType picture_type;
1824 } VAEncPictureParameterBufferMPEG4;
1828 /** Buffer functions */
1831 * Creates a buffer for "num_elements" elements of "size" bytes and
1832 * initalize with "data".
1833 * if "data" is null, then the contents of the buffer data store
1835 * Basically there are two ways to get buffer data to the server side. One is
1836 * to call vaCreateBuffer() with a non-null "data", which results the data being
1837 * copied to the data store on the server side. A different method that
1838 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1839 * and then use vaMapBuffer() to map the data store from the server side to the
1840 * client address space for access.
1841 * Note: image buffers are created by the library, not the client. Please see
1842 * vaCreateImage on how image buffers are managed.
1844 VAStatus vaCreateBuffer (
1846 VAContextID context,
1847 VABufferType type, /* in */
1848 unsigned int size, /* in */
1849 unsigned int num_elements, /* in */
1850 void *data, /* in */
1851 VABufferID *buf_id /* out */
1855 * Convey to the server how many valid elements are in the buffer.
1856 * e.g. if multiple slice parameters are being held in a single buffer,
1857 * this will communicate to the server the number of slice parameters
1858 * that are valid in the buffer.
1860 VAStatus vaBufferSetNumElements (
1862 VABufferID buf_id, /* in */
1863 unsigned int num_elements /* in */
1868 * device independent data structure for codedbuffer
1872 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1873 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1874 * enough for the encoder to attempt to limit its size.
1875 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1876 * exceeded the maximum slice size specified.
1877 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1878 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1879 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1881 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1882 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1883 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1884 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1885 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1887 * \brief The frame has exceeded the maximum requested size.
1889 * This flag indicates that the encoded frame size exceeds the value
1890 * specified through a misc parameter buffer of type
1891 * #VAEncMiscParameterTypeMaxFrameSize.
1893 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1894 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1897 * \brief The coded buffer segment contains a single NAL unit.
1899 * This flag indicates that the coded buffer segment contains a
1900 * single NAL unit. This flag might be useful to the user for
1901 * processing the coded buffer.
1903 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1906 * \brief Coded buffer segment.
1908 * #VACodedBufferSegment is an element of a linked list describing
1909 * some information on the coded buffer. The coded buffer segment
1910 * could contain either a single NAL unit, or more than one NAL unit.
1911 * It is recommended (but not required) to return a single NAL unit
1912 * in a coded buffer segment, and the implementation should set the
1913 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1915 typedef struct _VACodedBufferSegment {
1917 * \brief Size of the data buffer in this segment (in bytes).
1920 /** \brief Bit offset into the data buffer where the video data starts. */
1921 unsigned int bit_offset;
1922 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1923 unsigned int status;
1924 /** \brief Reserved for future use. */
1925 unsigned int reserved;
1926 /** \brief Pointer to the start of the data buffer. */
1929 * \brief Pointer to the next #VACodedBufferSegment element,
1930 * or \c NULL if there is none.
1933 } VACodedBufferSegment;
1936 * Map data store of the buffer into the client's address space
1937 * vaCreateBuffer() needs to be called with "data" set to NULL before
1938 * calling vaMapBuffer()
1940 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1941 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1943 VAStatus vaMapBuffer (
1945 VABufferID buf_id, /* in */
1946 void **pbuf /* out */
1950 * After client making changes to a mapped data store, it needs to
1951 * "Unmap" it to let the server know that the data is ready to be
1952 * consumed by the server
1954 VAStatus vaUnmapBuffer (
1956 VABufferID buf_id /* in */
1960 * After this call, the buffer is deleted and this buffer_id is no longer valid
1961 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1963 VAStatus vaDestroyBuffer (
1965 VABufferID buffer_id
1968 /** \brief VA buffer information */
1970 /** \brief Buffer handle */
1972 /** \brief Buffer type (See \ref VABufferType). */
1975 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
1977 * On input to vaAcquireBufferHandle(), this field can serve as a hint
1978 * to specify the set of memory types the caller is interested in.
1979 * On successful return from vaAcquireBufferHandle(), the field is
1980 * updated with the best matching memory type.
1983 /** \brief Size of the underlying buffer. */
1988 * \brief Acquires buffer handle for external API usage
1990 * Locks the VA buffer object \ref buf_id for external API usage like
1991 * EGL or OpenCL (OCL). This function is a synchronization point. This
1992 * means that any pending operation is guaranteed to be completed
1993 * prior to returning from the function.
1995 * If the referenced VA buffer object is the backing store of a VA
1996 * surface, then this function acts as if vaSyncSurface() on the
1997 * parent surface was called first.
1999 * The \ref VABufferInfo argument shall be zero'ed on input. On
2000 * successful output, the data structure is filled in with all the
2001 * necessary buffer level implementation details like handle, type,
2002 * memory type and memory size.
2004 * Note: the external API implementation, or the application, can
2005 * express the memory types it is interested in by filling in the \ref
2006 * mem_type field accordingly. On successful output, the memory type
2007 * that fits best the request and that was used is updated in the \ref
2008 * VABufferInfo data structure. If none of the supplied memory types
2009 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2010 * error is returned.
2012 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2013 * is called. Besides, no additional operation is allowed on any of
2014 * the buffer parent object until vaReleaseBufferHandle() is called.
2015 * e.g. decoding into a VA surface backed with the supplied VA buffer
2016 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2020 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2021 * does not support this interface
2022 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2023 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2024 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2025 * does not support exporting buffers of the specified type
2026 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2027 * memory types in \ref VABufferInfo.mem_type was supported
2029 * @param[in] dpy the VA display
2030 * @param[in] buf_id the VA buffer
2031 * @param[in,out] buf_info the associated VA buffer information
2032 * @return VA_STATUS_SUCCESS if successful
2035 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2038 * \brief Releases buffer after usage from external API
2040 * Unlocks the VA buffer object \ref buf_id from external API usage like
2041 * EGL or OpenCL (OCL). This function is a synchronization point. This
2042 * means that any pending operation is guaranteed to be completed
2043 * prior to returning from the function.
2045 * The \ref VABufferInfo argument shall point to the original data
2046 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2047 * This is necessary so that the VA driver implementation could
2048 * deallocate any resources that were needed.
2050 * In any case, returning from this function invalidates any contents
2051 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2052 * valid. Therefore, VA driver implementations are free to reset this
2053 * data structure to safe defaults.
2056 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2057 * does not support this interface
2058 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2059 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2060 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2061 * does not support exporting buffers of the specified type
2063 * @param[in] dpy the VA display
2064 * @param[in] buf_id the VA buffer
2065 * @return VA_STATUS_SUCCESS if successful
2068 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2071 Render (Decode) Pictures
2073 A picture represents either a frame or a field.
2075 The Begin/Render/End sequence sends the decode buffers to the server
2079 * Get ready to decode a picture to a target surface
2081 VAStatus vaBeginPicture (
2083 VAContextID context,
2084 VASurfaceID render_target
2088 * Send decode buffers to the server.
2089 * Buffers are automatically destroyed afterwards
2091 VAStatus vaRenderPicture (
2093 VAContextID context,
2094 VABufferID *buffers,
2099 * Make the end of rendering for a picture.
2100 * The server should start processing all pending operations for this
2101 * surface. This call is non-blocking. The client can start another
2102 * Begin/Render/End sequence on a different render target.
2104 VAStatus vaEndPicture (
2116 * This function blocks until all pending operations on the render target
2117 * have been completed. Upon return it is safe to use the render target for a
2118 * different picture.
2120 VAStatus vaSyncSurface (
2122 VASurfaceID render_target
2127 VASurfaceRendering = 1, /* Rendering in progress */
2128 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2129 /* this status is useful if surface is used as the source */
2131 VASurfaceReady = 4, /* not being rendered or displayed */
2132 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2136 * Find out any pending ops on the render target
2138 VAStatus vaQuerySurfaceStatus (
2140 VASurfaceID render_target,
2141 VASurfaceStatus *status /* out */
2146 VADecodeSliceMissing = 0,
2147 VADecodeMBError = 1,
2148 } VADecodeErrorType;
2151 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2152 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2154 typedef struct _VASurfaceDecodeMBErrors
2156 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2157 unsigned int start_mb; /* start mb address with errors */
2158 unsigned int end_mb; /* end mb address with errors */
2159 VADecodeErrorType decode_error_type;
2160 } VASurfaceDecodeMBErrors;
2163 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2164 * it can call vaQuerySurfaceError to find out further details on the particular error.
2165 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2166 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2167 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2168 * The array is terminated if "status==-1" is detected.
2170 VAStatus vaQuerySurfaceError(
2172 VASurfaceID surface,
2173 VAStatus error_status,
2178 * Images and Subpictures
2179 * VAImage is used to either get the surface data to client memory, or
2180 * to copy image data in client memory to a surface.
2181 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2182 * is at the upper left corner with positive X to the right and positive Y down
2184 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2185 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2186 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2189 * Pre-defined fourcc codes
2191 #define VA_FOURCC_NV12 0x3231564E
2192 #define VA_FOURCC_AI44 0x34344149
2193 #define VA_FOURCC_RGBA 0x41424752
2194 #define VA_FOURCC_RGBX 0x58424752
2195 #define VA_FOURCC_BGRA 0x41524742
2196 #define VA_FOURCC_BGRX 0x58524742
2197 #define VA_FOURCC_ARGB 0x42475241
2198 #define VA_FOURCC_XRGB 0x42475258
2199 #define VA_FOURCC_ABGR 0x52474241
2200 #define VA_FOURCC_XBGR 0x52474258
2201 #define VA_FOURCC_UYVY 0x59565955
2202 #define VA_FOURCC_YUY2 0x32595559
2203 #define VA_FOURCC_AYUV 0x56555941
2204 #define VA_FOURCC_NV11 0x3131564e
2205 #define VA_FOURCC_YV12 0x32315659
2206 #define VA_FOURCC_P208 0x38303250
2207 #define VA_FOURCC_IYUV 0x56555949
2208 #define VA_FOURCC_YV24 0x34325659
2209 #define VA_FOURCC_YV32 0x32335659
2210 #define VA_FOURCC_Y800 0x30303859
2211 #define VA_FOURCC_IMC3 0x33434D49
2212 #define VA_FOURCC_411P 0x50313134
2213 #define VA_FOURCC_422H 0x48323234
2214 #define VA_FOURCC_422V 0x56323234
2215 #define VA_FOURCC_444P 0x50343434
2216 #define VA_FOURCC_RGBP 0x50424752
2217 #define VA_FOURCC_BGRP 0x50524742
2218 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2221 #define VA_LSB_FIRST 1
2222 #define VA_MSB_FIRST 2
2224 typedef struct _VAImageFormat
2226 unsigned int fourcc;
2227 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2228 unsigned int bits_per_pixel;
2229 /* for RGB formats */
2230 unsigned int depth; /* significant bits per pixel */
2231 unsigned int red_mask;
2232 unsigned int green_mask;
2233 unsigned int blue_mask;
2234 unsigned int alpha_mask;
2237 typedef VAGenericID VAImageID;
2239 typedef struct _VAImage
2241 VAImageID image_id; /* uniquely identify this image */
2242 VAImageFormat format;
2243 VABufferID buf; /* image data buffer */
2245 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2246 * data store on the server side for optimal performance. The buffer will be
2247 * created by the CreateImage function, and proper storage allocated based on the image
2248 * size and format. This buffer is managed by the library implementation, and
2249 * accessed by the client through the buffer Map/Unmap functions.
2251 unsigned short width;
2252 unsigned short height;
2253 unsigned int data_size;
2254 unsigned int num_planes; /* can not be greater than 3 */
2256 * An array indicating the scanline pitch in bytes for each plane.
2257 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2259 unsigned int pitches[3];
2261 * An array indicating the byte offset from the beginning of the image data
2262 * to the start of each plane.
2264 unsigned int offsets[3];
2266 /* The following fields are only needed for paletted formats */
2267 int num_palette_entries; /* set to zero for non-palette images */
2269 * Each component is one byte and entry_bytes indicates the number of components in
2270 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2274 * An array of ascii characters describing the order of the components within the bytes.
2275 * Only entry_bytes characters of the string are used.
2277 char component_order[4];
2280 /** Get maximum number of image formats supported by the implementation */
2281 int vaMaxNumImageFormats (
2286 * Query supported image formats
2287 * The caller must provide a "format_list" array that can hold at
2288 * least vaMaxNumImageFormats() entries. The actual number of formats
2289 * returned in "format_list" is returned in "num_formats".
2291 VAStatus vaQueryImageFormats (
2293 VAImageFormat *format_list, /* out */
2294 int *num_formats /* out */
2298 * Create a VAImage structure
2299 * The width and height fields returned in the VAImage structure may get
2300 * enlarged for some YUV formats. Upon return from this function,
2301 * image->buf has been created and proper storage allocated by the library.
2302 * The client can access the image through the Map/Unmap calls.
2304 VAStatus vaCreateImage (
2306 VAImageFormat *format,
2309 VAImage *image /* out */
2313 * Should call DestroyImage before destroying the surface it is bound to
2315 VAStatus vaDestroyImage (
2320 VAStatus vaSetImagePalette (
2324 * pointer to an array holding the palette data. The size of the array is
2325 * num_palette_entries * entry_bytes in size. The order of the components
2326 * in the palette is described by the component_order in VAImage struct
2328 unsigned char *palette
2332 * Retrive surface data into a VAImage
2333 * Image must be in a format supported by the implementation
2335 VAStatus vaGetImage (
2337 VASurfaceID surface,
2338 int x, /* coordinates of the upper left source pixel */
2340 unsigned int width, /* width and height of the region */
2341 unsigned int height,
2346 * Copy data from a VAImage to a surface
2347 * Image must be in a format supported by the implementation
2348 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2349 * shouldn't be rendered into when this is called
2351 VAStatus vaPutImage (
2353 VASurfaceID surface,
2357 unsigned int src_width,
2358 unsigned int src_height,
2361 unsigned int dest_width,
2362 unsigned int dest_height
2366 * Derive an VAImage from an existing surface.
2367 * This interface will derive a VAImage and corresponding image buffer from
2368 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2369 * direct CPU access. This operation is only possible on implementations with
2370 * direct rendering capabilities and internal surface formats that can be
2371 * represented with a VAImage. When the operation is not possible this interface
2372 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2373 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2376 * Implementations should only return success when the resulting image buffer
2377 * would be useable with vaMap/Unmap.
2379 * When directly accessing a surface special care must be taken to insure
2380 * proper synchronization with the graphics hardware. Clients should call
2381 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2382 * rendering or currently being displayed by an overlay.
2384 * Additionally nothing about the contents of a surface should be assumed
2385 * following a vaPutSurface. Implementations are free to modify the surface for
2386 * scaling or subpicture blending within a call to vaPutImage.
2388 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2389 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2390 * vaGetImage with other surfaces is supported.
2392 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2393 * image and image buffer structures will be destroyed; however, the underlying
2394 * surface will remain unchanged until freed with vaDestroySurfaces.
2396 VAStatus vaDeriveImage (
2398 VASurfaceID surface,
2399 VAImage *image /* out */
2404 * Subpicture is a special type of image that can be blended
2405 * with a surface during vaPutSurface(). Subpicture can be used to render
2406 * DVD sub-titles or closed captioning text etc.
2409 typedef VAGenericID VASubpictureID;
2411 /** Get maximum number of subpicture formats supported by the implementation */
2412 int vaMaxNumSubpictureFormats (
2416 /** flags for subpictures */
2417 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2418 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2419 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2421 * Query supported subpicture formats
2422 * The caller must provide a "format_list" array that can hold at
2423 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2424 * for each format to indicate additional capabilities for that format. The actual
2425 * number of formats returned in "format_list" is returned in "num_formats".
2426 * flags: returned value to indicate addtional capabilities
2427 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2428 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2429 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2432 VAStatus vaQuerySubpictureFormats (
2434 VAImageFormat *format_list, /* out */
2435 unsigned int *flags, /* out */
2436 unsigned int *num_formats /* out */
2440 * Subpictures are created with an image associated.
2442 VAStatus vaCreateSubpicture (
2445 VASubpictureID *subpicture /* out */
2449 * Destroy the subpicture before destroying the image it is assocated to
2451 VAStatus vaDestroySubpicture (
2453 VASubpictureID subpicture
2457 * Bind an image to the subpicture. This image will now be associated with
2458 * the subpicture instead of the one at creation.
2460 VAStatus vaSetSubpictureImage (
2462 VASubpictureID subpicture,
2467 * If chromakey is enabled, then the area where the source value falls within
2468 * the chromakey [min, max] range is transparent
2469 * The chromakey component format is the following:
2470 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2471 * For YUV: [0:7] V [8:15] U [16:23] Y
2472 * The chromakey mask can be used to mask out certain components for chromakey
2475 VAStatus vaSetSubpictureChromakey (
2477 VASubpictureID subpicture,
2478 unsigned int chromakey_min,
2479 unsigned int chromakey_max,
2480 unsigned int chromakey_mask
2484 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2485 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2486 * the overall alpha is per-pixel alpha multiplied by the global alpha
2488 VAStatus vaSetSubpictureGlobalAlpha (
2490 VASubpictureID subpicture,
2495 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2496 * It defines the region mapping between the subpicture and the target
2497 * surfaces through source and destination rectangles (with the same width and height).
2498 * Both will be displayed at the next call to vaPutSurface. Additional
2499 * associations before the call to vaPutSurface simply overrides the association.
2501 VAStatus vaAssociateSubpicture (
2503 VASubpictureID subpicture,
2504 VASurfaceID *target_surfaces,
2506 short src_x, /* upper left offset in subpicture */
2508 unsigned short src_width,
2509 unsigned short src_height,
2510 short dest_x, /* upper left offset in surface */
2512 unsigned short dest_width,
2513 unsigned short dest_height,
2515 * whether to enable chroma-keying, global-alpha, or screen relative mode
2516 * see VA_SUBPICTURE_XXX values
2522 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2524 VAStatus vaDeassociateSubpicture (
2526 VASubpictureID subpicture,
2527 VASurfaceID *target_surfaces,
2531 typedef struct _VARectangle
2535 unsigned short width;
2536 unsigned short height;
2540 * Display attributes
2541 * Display attributes are used to control things such as contrast, hue, saturation,
2542 * brightness etc. in the rendering process. The application can query what
2543 * attributes are supported by the driver, and then set the appropriate attributes
2544 * before calling vaPutSurface()
2546 /* PowerVR IEP Lite attributes */
2549 VADISPLAYATTRIB_BLE_OFF = 0x00,
2550 VADISPLAYATTRIB_BLE_LOW,
2551 VADISPLAYATTRIB_BLE_MEDIUM,
2552 VADISPLAYATTRIB_BLE_HIGH,
2553 VADISPLAYATTRIB_BLE_NONE,
2554 } VADisplayAttribBLEMode;
2556 /** attribute value for VADisplayAttribRotation */
2557 #define VA_ROTATION_NONE 0x00000000
2558 #define VA_ROTATION_90 0x00000001
2559 #define VA_ROTATION_180 0x00000002
2560 #define VA_ROTATION_270 0x00000003
2562 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2563 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2564 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2567 #define VA_RENDER_MODE_UNDEFINED 0
2568 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2569 #define VA_RENDER_MODE_LOCAL_GPU 2
2570 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2571 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2573 /** Render device */
2574 #define VA_RENDER_DEVICE_UNDEFINED 0
2575 #define VA_RENDER_DEVICE_LOCAL 1
2576 #define VA_RENDER_DEVICE_EXTERNAL 2
2578 /** Currently defined display attribute types */
2581 VADisplayAttribBrightness = 0,
2582 VADisplayAttribContrast = 1,
2583 VADisplayAttribHue = 2,
2584 VADisplayAttribSaturation = 3,
2585 /* client can specifiy a background color for the target window
2586 * the new feature of video conference,
2587 * the uncovered area of the surface is filled by this color
2588 * also it will blend with the decoded video color
2590 VADisplayAttribBackgroundColor = 4,
2592 * this is a gettable only attribute. For some implementations that use the
2593 * hardware overlay, after PutSurface is called, the surface can not be
2594 * re-used until after the subsequent PutSurface call. If this is the case
2595 * then the value for this attribute will be set to 1 so that the client
2596 * will not attempt to re-use the surface right after returning from a call
2599 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2600 * driver may use overlay or GPU alternatively
2602 VADisplayAttribDirectSurface = 5,
2603 VADisplayAttribRotation = 6,
2604 VADisplayAttribOutofLoopDeblock = 7,
2606 /* PowerVR IEP Lite specific attributes */
2607 VADisplayAttribBLEBlackMode = 8,
2608 VADisplayAttribBLEWhiteMode = 9,
2609 VADisplayAttribBlueStretch = 10,
2610 VADisplayAttribSkinColorCorrection = 11,
2612 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2613 * conversion matrix. Each element in the matrix is float-point
2615 VADisplayAttribCSCMatrix = 12,
2616 /* specify the constant color used to blend with video surface
2617 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2618 * d: the final color to overwrite into the frame buffer
2619 * v: decoded video after color conversion,
2620 * c: video color specified by VADisplayAttribBlendColor
2621 * b: background color of the drawable
2623 VADisplayAttribBlendColor = 13,
2625 * Indicate driver to skip painting color key or not.
2626 * only applicable if the render is overlay
2628 VADisplayAttribOverlayAutoPaintColorKey = 14,
2630 * customized overlay color key, the format is RGB888
2631 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2633 VADisplayAttribOverlayColorKey = 15,
2635 * The hint for the implementation of vaPutSurface
2636 * normally, the driver could use an overlay or GPU to render the surface on the screen
2637 * this flag provides APP the flexibity to switch the render dynamically
2639 VADisplayAttribRenderMode = 16,
2641 * specify if vaPutSurface needs to render into specified monitors
2642 * one example is that one external monitor (e.g. HDMI) is enabled,
2643 * but the window manager is not aware of it, and there is no associated drawable
2645 VADisplayAttribRenderDevice = 17,
2647 * specify vaPutSurface render area if there is no drawable on the monitor
2649 VADisplayAttribRenderRect = 18,
2650 } VADisplayAttribType;
2652 /* flags for VADisplayAttribute */
2653 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2654 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2655 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2657 typedef struct _VADisplayAttribute
2659 VADisplayAttribType type;
2662 int value; /* used by the set/get attribute functions */
2663 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2665 } VADisplayAttribute;
2667 /** Get maximum number of display attributs supported by the implementation */
2668 int vaMaxNumDisplayAttributes (
2673 * Query display attributes
2674 * The caller must provide a "attr_list" array that can hold at
2675 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2676 * returned in "attr_list" is returned in "num_attributes".
2678 VAStatus vaQueryDisplayAttributes (
2680 VADisplayAttribute *attr_list, /* out */
2681 int *num_attributes /* out */
2685 * Get display attributes
2686 * This function returns the current attribute values in "attr_list".
2687 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2688 * from vaQueryDisplayAttributes() can have their values retrieved.
2690 VAStatus vaGetDisplayAttributes (
2692 VADisplayAttribute *attr_list, /* in/out */
2697 * Set display attributes
2698 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2699 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2700 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2702 VAStatus vaSetDisplayAttributes (
2704 VADisplayAttribute *attr_list,
2708 /****************************
2709 * HEVC data structures
2710 ****************************/
2712 * \brief Description of picture properties of those in DPB surfaces.
2714 * If only progressive scan is supported, each surface contains one whole
2716 * Otherwise, each surface contains two fields of whole picture.
2717 * In this case, two entries of ReferenceFrames[] may share same picture_id
2720 typedef struct _VAPictureHEVC
2722 /** \brief reconstructed picture buffer surface index
2723 * invalid when taking value VA_INVALID_SURFACE.
2725 VASurfaceID picture_id;
2726 /** \brief picture order count.
2727 * in HEVC, POCs for top and bottom fields of same picture should
2728 * take different values.
2730 int32_t pic_order_cnt;
2731 /* described below */
2735 /* flags in VAPictureHEVC could be OR of the following */
2736 #define VA_PICTURE_HEVC_INVALID 0x00000001
2737 /** \brief indication of interlace scan picture.
2738 * should take same value for all the pictures in sequence.
2740 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
2741 /** \brief polarity of the field picture.
2742 * top field takes even lines of buffer surface.
2743 * bottom field takes odd lines of buffer surface.
2745 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
2746 /** \brief Long term reference picture */
2747 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
2749 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
2750 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
2751 * be exclusive. No more than one of them can be set for any picture.
2752 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
2753 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
2754 * Application should provide valid values for both short format and long format.
2755 * The pictures in DPB with any of these three flags turned on are referred by
2756 * the current picture.
2758 /** \brief RefPicSetStCurrBefore of HEVC spec variable
2759 * Number of ReferenceFrames[] entries with this bit set equals
2760 * NumPocStCurrBefore.
2762 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
2763 /** \brief RefPicSetStCurrAfter of HEVC spec variable
2764 * Number of ReferenceFrames[] entries with this bit set equals
2765 * NumPocStCurrAfter.
2767 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
2768 /** \brief RefPicSetLtCurr of HEVC spec variable
2769 * Number of ReferenceFrames[] entries with this bit set equals
2772 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040