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 #define va_deprecated __attribute__((deprecated))
92 #define va_deprecated_enum va_deprecated
94 #define va_deprecated_enum
98 #define va_deprecated_enum
102 * \mainpage Video Acceleration (VA) API
104 * \section intro Introduction
106 * The main motivation for VA-API (Video Acceleration API) is to
107 * enable hardware accelerated video decode and encode at various
108 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
109 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
110 * AVC/H.264, VC-1/VMW3, and JPEG, HEVC/H265, VP8, VP9) and video pre/post
113 * VA-API is split into several modules:
115 * - \ref api_enc_xxx (xxx = h264, hevc, jpec, mpeg2, vp8, vp9)
116 * - \ref api_dec_xxx (xxx = hevc, jpec, vp8, vp9)
121 * \defgroup api_core Core API
129 The VA API is intended to provide an interface between a video decode/encode/processing
130 application (client) and a hardware accelerator (server), to off-load
131 video decode/encode/processing operations from the host to the hardware accelerator at various
134 The basic operation steps are:
136 - Negotiate a mutually acceptable configuration with the server to lock
137 down profile, entrypoints, and other attributes that will not change on
138 a frame-by-frame basis.
139 - Create a video decode, encode or processing context which represents a
140 "virtualized" hardware device
141 - Get and fill the render buffers with the corresponding data (depending on
142 profiles and entrypoints)
143 - Pass the render buffers to the server to handle the current frame
145 Initialization & Configuration Management
147 - Find out supported profiles
148 - Find out entrypoints for a given profile
149 - Find out configuration attributes for a given profile/entrypoint pair
150 - Create a configuration for use by the application
154 typedef void* VADisplay; /* window system dependent */
156 typedef int VAStatus; /** Return status type from functions */
157 /** Values for the return status */
158 #define VA_STATUS_SUCCESS 0x00000000
159 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
160 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
161 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
162 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
163 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
164 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
165 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
166 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
167 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
168 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
169 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
170 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
171 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
172 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
173 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
174 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
175 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
176 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
177 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
178 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
179 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
180 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
181 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
182 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
184 * \brief An invalid/unsupported value was supplied.
186 * This is a catch-all error code for invalid or unsupported values.
187 * e.g. value exceeding the valid range, invalid type in the context
188 * of generic attribute values.
190 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
191 /** \brief An unsupported filter was supplied. */
192 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
193 /** \brief An invalid filter chain was supplied. */
194 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
195 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
196 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
197 /** \brief An unsupported memory type was supplied. */
198 #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
199 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
201 /** De-interlacing flags for vaPutSurface() */
202 #define VA_FRAME_PICTURE 0x00000000
203 #define VA_TOP_FIELD 0x00000001
204 #define VA_BOTTOM_FIELD 0x00000002
207 * Enabled the positioning/cropping/blending feature:
208 * 1, specify the video playback position in the isurface
209 * 2, specify the cropping info for video playback
210 * 3, encoded video will blend with background color
212 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
215 * Clears the drawable with background color.
216 * for hardware overlay based implementation this flag
217 * can be used to turn off the overlay
219 #define VA_CLEAR_DRAWABLE 0x00000008
221 /** Color space conversion flags for vaPutSurface() */
222 #define VA_SRC_COLOR_MASK 0x000000f0
223 #define VA_SRC_BT601 0x00000010
224 #define VA_SRC_BT709 0x00000020
225 #define VA_SRC_SMPTE_240 0x00000040
227 /** Scaling flags for vaPutSurface() */
228 #define VA_FILTER_SCALING_DEFAULT 0x00000000
229 #define VA_FILTER_SCALING_FAST 0x00000100
230 #define VA_FILTER_SCALING_HQ 0x00000200
231 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
232 #define VA_FILTER_SCALING_MASK 0x00000f00
234 /** Padding size in 4-bytes */
235 #define VA_PADDING_LOW 4
236 #define VA_PADDING_MEDIUM 8
237 #define VA_PADDING_HIGH 16
238 #define VA_PADDING_LARGE 32
241 * Returns a short english description of error_status
243 const char *vaErrorStr(VAStatus error_status);
245 typedef struct _VARectangle
253 /** \brief Generic motion vector data structure. */
254 typedef struct _VAMotionVector {
255 /** \mv0[0]: horizontal motion vector for past reference */
256 /** \mv0[1]: vertical motion vector for past reference */
257 /** \mv1[0]: horizontal motion vector for future reference */
258 /** \mv1[1]: vertical motion vector for future reference */
259 int16_t mv0[2]; /* past reference */
260 int16_t mv1[2]; /* future reference */
263 /** Type of a message callback, used for both error and info log. */
264 typedef void (*VAMessageCallback)(void *user_context, const char *message);
267 * Set the callback for error messages, or NULL for no logging.
268 * Returns the previous one, or NULL if it was disabled.
270 VAMessageCallback vaSetErrorCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
273 * Set the callback for info messages, or NULL for no logging.
274 * Returns the previous one, or NULL if it was disabled.
276 VAMessageCallback vaSetInfoCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
280 * A display must be obtained by calling vaGetDisplay() before calling
281 * vaInitialize() and other functions. This connects the API to the
282 * native window system.
283 * For X Windows, native_dpy would be from XOpenDisplay()
285 typedef void* VANativeDisplay; /* window system dependent */
287 int vaDisplayIsValid(VADisplay dpy);
290 * Set the override driver name instead of queried driver driver.
292 VAStatus vaSetDriverName(VADisplay dpy,
297 * Initialize the library
299 VAStatus vaInitialize (
301 int *major_version, /* out */
302 int *minor_version /* out */
306 * After this call, all library internal resources will be cleaned up
308 VAStatus vaTerminate (
313 * vaQueryVendorString returns a pointer to a zero-terminated string
314 * describing some aspects of the VA implemenation on a specific
315 * hardware accelerator. The format of the returned string is vendor
316 * specific and at the discretion of the implementer.
317 * e.g. for the Intel GMA500 implementation, an example would be:
318 * "Intel GMA500 - 2.0.0.32L.0005"
320 const char *vaQueryVendorString (
324 typedef int (*VAPrivFunc)(void);
327 * Return a function pointer given a function name in the library.
328 * This allows private interfaces into the library
330 VAPrivFunc vaGetLibFunc (
335 /** Currently defined profiles */
338 /** \brief Profile ID used for video processing. */
340 VAProfileMPEG2Simple = 0,
341 VAProfileMPEG2Main = 1,
342 VAProfileMPEG4Simple = 2,
343 VAProfileMPEG4AdvancedSimple = 3,
344 VAProfileMPEG4Main = 4,
345 VAProfileH264Baseline va_deprecated_enum = 5,
346 VAProfileH264Main = 6,
347 VAProfileH264High = 7,
348 VAProfileVC1Simple = 8,
349 VAProfileVC1Main = 9,
350 VAProfileVC1Advanced = 10,
351 VAProfileH263Baseline = 11,
352 VAProfileJPEGBaseline = 12,
353 VAProfileH264ConstrainedBaseline = 13,
354 VAProfileVP8Version0_3 = 14,
355 VAProfileH264MultiviewHigh = 15,
356 VAProfileH264StereoHigh = 16,
357 VAProfileHEVCMain = 17,
358 VAProfileHEVCMain10 = 18,
359 VAProfileVP9Profile0 = 19,
360 VAProfileVP9Profile1 = 20,
361 VAProfileVP9Profile2 = 21,
362 VAProfileVP9Profile3 = 22
366 * Currently defined entrypoints
372 VAEntrypointIDCT = 3,
373 VAEntrypointMoComp = 4,
374 VAEntrypointDeblocking = 5,
375 VAEntrypointEncSlice = 6, /* slice level encode */
376 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
378 * For an implementation that supports a low power/high performance variant
379 * for slice level encode, it can choose to expose the
380 * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
381 * available with this entrypoint (e.g. interlace, MBAFF) and the
382 * application can query the encoding configuration attributes to find
383 * out more details if this entrypoint is supported.
385 VAEntrypointEncSliceLP = 8,
386 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
388 * \brief VAEntrypointFEI
390 * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to
391 * have more controls and trade off quality for speed with their own IPs.
392 * The application can optionally provide input to ENC for extra encode control
393 * and get the output from ENC. Application can chose to modify the ENC
394 * output/PAK input during encoding, but the performance impact is significant.
396 * On top of the existing buffers for normal encode, there will be
397 * one extra input buffer (VAEncMiscParameterFEIFrameControl) and
398 * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType
399 * and VAEncFEIDistortionBufferType) for VAEntrypointFEI entry function.
400 * If separate PAK is set, two extra input buffers
401 * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input.
403 VAEntrypointFEI = 11,
406 /** Currently defined configuration attribute types */
409 VAConfigAttribRTFormat = 0,
410 VAConfigAttribSpatialResidual = 1,
411 VAConfigAttribSpatialClipping = 2,
412 VAConfigAttribIntraResidual = 3,
413 VAConfigAttribEncryption = 4,
414 VAConfigAttribRateControl = 5,
416 /** @name Attributes for decoding */
419 * \brief Slice Decoding mode. Read/write.
421 * This attribute determines what mode the driver supports for slice
422 * decoding, through vaGetConfigAttributes(); and what mode the user
423 * will be providing to the driver, through vaCreateConfig(), if the
424 * driver supports those. If this attribute is not set by the user then
425 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
427 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
429 VAConfigAttribDecSliceMode = 6,
431 /** @name Attributes for encoding */
434 * \brief Packed headers mode. Read/write.
436 * This attribute determines what packed headers the driver supports,
437 * through vaGetConfigAttributes(); and what packed headers the user
438 * will be providing to the driver, through vaCreateConfig(), if the
439 * driver supports those.
441 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
443 VAConfigAttribEncPackedHeaders = 10,
445 * \brief Interlaced mode. Read/write.
447 * This attribute determines what kind of interlaced encoding mode
448 * the driver supports.
450 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
452 VAConfigAttribEncInterlaced = 11,
454 * \brief Maximum number of reference frames. Read-only.
456 * This attribute determines the maximum number of reference
457 * frames supported for encoding.
459 * Note: for H.264 encoding, the value represents the maximum number
460 * of reference frames for both the reference picture list 0 (bottom
461 * 16 bits) and the reference picture list 1 (top 16 bits).
463 VAConfigAttribEncMaxRefFrames = 13,
465 * \brief Maximum number of slices per frame. Read-only.
467 * This attribute determines the maximum number of slices the
468 * driver can support to encode a single frame.
470 VAConfigAttribEncMaxSlices = 14,
472 * \brief Slice structure. Read-only.
474 * This attribute determines slice structures supported by the
475 * driver for encoding. This attribute is a hint to the user so
476 * that he can choose a suitable surface size and how to arrange
477 * the encoding process of multiple slices per frame.
479 * More specifically, for H.264 encoding, this attribute
480 * determines the range of accepted values to
481 * VAEncSliceParameterBufferH264::macroblock_address and
482 * VAEncSliceParameterBufferH264::num_macroblocks.
484 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
487 VAConfigAttribEncSliceStructure = 15,
489 * \brief Macroblock information. Read-only.
491 * This attribute determines whether the driver supports extra
492 * encoding information per-macroblock. e.g. QP.
494 * More specifically, for H.264 encoding, if the driver returns a non-zero
495 * value for this attribute, this means the application can create
496 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
497 * through VAEncSliceParameterBufferH264::macroblock_info.
499 VAConfigAttribEncMacroblockInfo = 16,
501 * \brief JPEG encoding attribute. Read-only.
503 * This attribute exposes a number of capabilities of the underlying
504 * JPEG implementation. The attribute value is partitioned into fields as defined in the
505 * VAConfigAttribValEncJPEG union.
507 VAConfigAttribEncJPEG = 20,
509 * \brief Encoding quality range attribute. Read-only.
511 * This attribute conveys whether the driver supports different quality level settings
512 * for encoding. A value less than or equal to 1 means that the encoder only has a single
513 * quality setting, and a value greater than 1 represents the number of quality levels
514 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
516 VAConfigAttribEncQualityRange = 21,
518 * \brief Encoding skip frame attribute. Read-only.
520 * This attribute conveys whether the driver supports sending skip frame parameters
521 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
522 * externally skipped frames.
524 VAConfigAttribEncSkipFrame = 24,
526 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
528 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
529 * based on user provided ROI rectangles. The attribute value is partitioned into fields
530 * as defined in the VAConfigAttribValEncROI union.
532 * If ROI encoding is supported, the ROI information is passed to the driver using
533 * VAEncMiscParameterTypeROI.
535 VAConfigAttribEncROI = 25,
537 * \brief Encoding extended rate control attribute. Read-only.
539 * This attribute conveys whether the driver supports any extended rate control features
540 * The attribute value is partitioned into fields as defined in the
541 * VAConfigAttribValEncRateControlExt union.
543 VAConfigAttribEncRateControlExt = 26,
546 * \brief Encode function type for FEI.
548 * This attribute conveys whether the driver supports different function types for encode.
549 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
550 * it is for FEI entry point only.
551 * Default is VA_FEI_FUNCTION_ENC_PAK.
553 VAConfigAttribFEIFunctionType = 32,
555 * \brief Maximum number of FEI MV predictors. Read-only.
557 * This attribute determines the maximum number of MV predictors the driver
558 * can support to encode a single frame. 0 means no MV predictor is supported.
559 * Currently it is for FEI entry point only.
561 VAConfigAttribFEIMVPredictors = 33,
563 VAConfigAttribTypeMax
564 } VAConfigAttribType;
567 * Configuration attributes
568 * If there is more than one value for an attribute, a default
569 * value will be assigned to the attribute if the client does not
570 * specify the attribute when creating a configuration
572 typedef struct _VAConfigAttrib {
573 VAConfigAttribType type;
574 uint32_t value; /* OR'd flags (bits) for this attribute */
577 /** attribute value for VAConfigAttribRTFormat */
578 #define VA_RT_FORMAT_YUV420 0x00000001
579 #define VA_RT_FORMAT_YUV422 0x00000002
580 #define VA_RT_FORMAT_YUV444 0x00000004
581 #define VA_RT_FORMAT_YUV411 0x00000008
582 #define VA_RT_FORMAT_YUV400 0x00000010
583 /** YUV formats with more than 8 bpp */
584 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
586 #define VA_RT_FORMAT_RGB16 0x00010000
587 #define VA_RT_FORMAT_RGB32 0x00020000
588 /* RGBP covers RGBP and BGRP fourcc */
589 #define VA_RT_FORMAT_RGBP 0x00100000
590 #define VA_RT_FORMAT_PROTECTED 0x80000000
592 /** @name Attribute values for VAConfigAttribRateControl */
594 /** \brief Driver does not support any form of rate control. */
595 #define VA_RC_NONE 0x00000001
596 /** \brief Constant bitrate. */
597 #define VA_RC_CBR 0x00000002
598 /** \brief Variable bitrate. */
599 #define VA_RC_VBR 0x00000004
600 /** \brief Video conference mode. */
601 #define VA_RC_VCM 0x00000008
602 /** \brief Constant QP. */
603 #define VA_RC_CQP 0x00000010
604 /** \brief Variable bitrate with peak rate higher than average bitrate. */
605 #define VA_RC_VBR_CONSTRAINED 0x00000020
606 /** \brief Macroblock based rate control. Per MB control is decided
607 * internally in the encoder. It may be combined with other RC modes, except CQP. */
608 #define VA_RC_MB 0x00000080
612 /** @name Attribute values for VAConfigAttribDecSliceMode */
614 /** \brief Driver supports normal mode for slice decoding */
615 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
616 /** \brief Driver supports base mode for slice decoding */
617 #define VA_DEC_SLICE_MODE_BASE 0x00000002
620 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
622 /** \brief Driver does not support any packed headers mode. */
623 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
625 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
627 * Application must provide it to driver once this flag is returned through
628 * vaGetConfigAttributes()
630 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
632 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
634 * Application must provide it to driver once this falg is returned through
635 * vaGetConfigAttributes()
637 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
639 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
641 * Application must provide it to driver once this flag is returned through
642 * vaGetConfigAttributes()
644 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
646 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
649 * This is a deprecated packed header flag, All applications can use
650 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
651 * header data buffer to the driver
653 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
654 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
655 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
658 /** @name Attribute values for VAConfigAttribEncInterlaced */
660 /** \brief Driver does not support interlaced coding. */
661 #define VA_ENC_INTERLACED_NONE 0x00000000
662 /** \brief Driver supports interlaced frame coding. */
663 #define VA_ENC_INTERLACED_FRAME 0x00000001
664 /** \brief Driver supports interlaced field coding. */
665 #define VA_ENC_INTERLACED_FIELD 0x00000002
666 /** \brief Driver supports macroblock adaptive frame field coding. */
667 #define VA_ENC_INTERLACED_MBAFF 0x00000004
668 /** \brief Driver supports picture adaptive frame field coding. */
669 #define VA_ENC_INTERLACED_PAFF 0x00000008
672 /** @name Attribute values for VAConfigAttribEncSliceStructure */
674 /** \brief Driver supports a power-of-two number of rows per slice. */
675 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
676 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
677 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
678 /** \brief Dirver support 1 rows per slice */
679 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
680 /** \brief Dirver support max encoded slice size per slice */
681 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
682 /** \brief Driver supports an arbitrary number of rows per slice. */
683 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
686 /** \brief Attribute value for VAConfigAttribEncJPEG */
687 typedef union _VAConfigAttribValEncJPEG {
689 /** \brief set to 1 for arithmatic coding. */
690 uint32_t arithmatic_coding_mode : 1;
691 /** \brief set to 1 for progressive dct. */
692 uint32_t progressive_dct_mode : 1;
693 /** \brief set to 1 for non-interleaved. */
694 uint32_t non_interleaved_mode : 1;
695 /** \brief set to 1 for differential. */
696 uint32_t differential_mode : 1;
697 uint32_t max_num_components : 3;
698 uint32_t max_num_scans : 4;
699 uint32_t max_num_huffman_tables : 3;
700 uint32_t max_num_quantization_tables : 3;
703 } VAConfigAttribValEncJPEG;
705 /** \brief Attribute value for VAConfigAttribEncROI */
706 typedef union _VAConfigAttribValEncROI {
708 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
709 uint32_t num_roi_regions : 8;
711 * \brief A flag indicates whether ROI priority is supported
713 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
714 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
715 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
716 * the underlying driver doesn't support ROI priority.
718 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
719 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
721 uint32_t roi_rc_priority_support : 1;
723 * \brief A flag indicates whether ROI delta QP is supported
725 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
726 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
727 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
728 * the underlying driver doesn't support ROI delta QP.
730 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
731 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
733 uint32_t roi_rc_qp_delta_support : 1;
734 uint32_t reserved : 22;
737 } VAConfigAttribValEncROI;
739 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
740 typedef union _VAConfigAttribValEncRateControlExt {
743 * \brief The maximum number of temporal layers minus 1
745 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
746 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
747 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
749 uint32_t max_num_temporal_layers_minus1 : 8;
752 * /brief support temporal layer bit-rate control flag
754 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
755 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
756 * #VAConfigAttribRateControl == #VA_RC_VBR).
758 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
759 * \c max_num_temporal_layers_minus1 is equal to 0
761 * To use bit-rate control per temporal layer, an application must send the right layer
762 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
763 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
764 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
765 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
766 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
767 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
768 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
770 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
771 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
772 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
774 uint32_t temporal_layer_bitrate_control_flag : 1;
775 uint32_t reserved : 23;
778 } VAConfigAttribValEncRateControlExt;
781 * if an attribute is not applicable for a given
782 * profile/entrypoint pair, then set the value to the following
784 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
786 /** Get maximum number of profiles supported by the implementation */
787 int vaMaxNumProfiles (
791 /** Get maximum number of entrypoints supported by the implementation */
792 int vaMaxNumEntrypoints (
796 /** Get maximum number of attributs supported by the implementation */
797 int vaMaxNumConfigAttributes (
802 * Query supported profiles
803 * The caller must provide a "profile_list" array that can hold at
804 * least vaMaxNumProfile() entries. The actual number of profiles
805 * returned in "profile_list" is returned in "num_profile".
807 VAStatus vaQueryConfigProfiles (
809 VAProfile *profile_list, /* out */
810 int *num_profiles /* out */
814 * Query supported entrypoints for a given profile
815 * The caller must provide an "entrypoint_list" array that can hold at
816 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
817 * returned in "entrypoint_list" is returned in "num_entrypoints".
819 VAStatus vaQueryConfigEntrypoints (
822 VAEntrypoint *entrypoint_list, /* out */
823 int *num_entrypoints /* out */
827 * Get attributes for a given profile/entrypoint pair
828 * The caller must provide an "attrib_list" with all attributes to be
829 * retrieved. Upon return, the attributes in "attrib_list" have been
830 * updated with their value. Unknown attributes or attributes that are
831 * not supported for the given profile/entrypoint pair will have their
832 * value set to VA_ATTRIB_NOT_SUPPORTED
834 VAStatus vaGetConfigAttributes (
837 VAEntrypoint entrypoint,
838 VAConfigAttrib *attrib_list, /* in/out */
842 /** Generic ID type, can be re-typed for specific implementation */
843 typedef unsigned int VAGenericID;
845 typedef VAGenericID VAConfigID;
848 * Create a configuration for the video decode/encode/processing pipeline
849 * it passes in the attribute list that specifies the attributes it cares
850 * about, with the rest taking default values.
852 VAStatus vaCreateConfig (
855 VAEntrypoint entrypoint,
856 VAConfigAttrib *attrib_list,
858 VAConfigID *config_id /* out */
862 * Free resources associdated with a given config
864 VAStatus vaDestroyConfig (
870 * Query all attributes for a given configuration
871 * The profile of the configuration is returned in "profile"
872 * The entrypoint of the configuration is returned in "entrypoint"
873 * The caller must provide an "attrib_list" array that can hold at least
874 * vaMaxNumConfigAttributes() entries. The actual number of attributes
875 * returned in "attrib_list" is returned in "num_attribs"
877 VAStatus vaQueryConfigAttributes (
879 VAConfigID config_id,
880 VAProfile *profile, /* out */
881 VAEntrypoint *entrypoint, /* out */
882 VAConfigAttrib *attrib_list,/* out */
883 int *num_attribs /* out */
888 * Contexts and Surfaces
890 * Context represents a "virtual" video decode, encode or video processing
891 * pipeline. Surfaces are render targets for a given context. The data in the
892 * surfaces are not accessible to the client except if derived image is supported
893 * and the internal data format of the surface is implementation specific.
895 * Surfaces are provided as a hint of what surfaces will be used when the context
896 * is created through vaCreateContext(). A surface may be used by different contexts
897 * at the same time as soon as application can make sure the operations are synchronized
898 * between different contexts, e.g. a surface is used as the output of a decode context
899 * and the input of a video process context. Surfaces can only be destroyed after all
900 * contexts using these surfaces have been destroyed.
902 * Both contexts and surfaces are identified by unique IDs and its
903 * implementation specific internals are kept opaque to the clients
906 typedef VAGenericID VAContextID;
908 typedef VAGenericID VASurfaceID;
910 #define VA_INVALID_ID 0xffffffff
911 #define VA_INVALID_SURFACE VA_INVALID_ID
913 /** \brief Generic value types. */
915 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
916 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
917 VAGenericValueTypePointer, /**< Generic pointer type */
918 VAGenericValueTypeFunc /**< Pointer to function */
919 } VAGenericValueType;
921 /** \brief Generic function type. */
922 typedef void (*VAGenericFunc)(void);
924 /** \brief Generic value. */
925 typedef struct _VAGenericValue {
926 /** \brief Value type. See #VAGenericValueType. */
927 VAGenericValueType type;
928 /** \brief Value holder. */
930 /** \brief 32-bit signed integer. */
932 /** \brief 32-bit float. */
934 /** \brief Generic pointer. */
936 /** \brief Pointer to function. */
941 /** @name Surface attribute flags */
943 /** \brief Surface attribute is not supported. */
944 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
945 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
946 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
947 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
948 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
951 /** \brief Surface attribute types. */
953 VASurfaceAttribNone = 0,
955 * \brief Pixel format (fourcc).
957 * The value is meaningful as input to vaQuerySurfaceAttributes().
958 * If zero, the driver returns the optimal pixel format for the
959 * specified config. Otherwise, if non-zero, the value represents
960 * a pixel format (FOURCC) that is kept as is on output, if the
961 * driver supports it. Otherwise, the driver sets the value to
962 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
964 VASurfaceAttribPixelFormat,
965 /** \brief Minimal width in pixels (int, read-only). */
966 VASurfaceAttribMinWidth,
967 /** \brief Maximal width in pixels (int, read-only). */
968 VASurfaceAttribMaxWidth,
969 /** \brief Minimal height in pixels (int, read-only). */
970 VASurfaceAttribMinHeight,
971 /** \brief Maximal height in pixels (int, read-only). */
972 VASurfaceAttribMaxHeight,
973 /** \brief Surface memory type expressed in bit fields (int, read/write). */
974 VASurfaceAttribMemoryType,
975 /** \brief External buffer descriptor (pointer, write). */
976 VASurfaceAttribExternalBufferDescriptor,
977 /** \brief Surface usage hint, gives the driver a hint of intended usage
978 * to optimize allocation (e.g. tiling) (int, read/write). */
979 VASurfaceAttribUsageHint,
980 /** \brief Number of surface attributes. */
982 } VASurfaceAttribType;
984 /** \brief Surface attribute. */
985 typedef struct _VASurfaceAttrib {
987 VASurfaceAttribType type;
988 /** \brief Flags. See "Surface attribute flags". */
990 /** \brief Value. See "Surface attribute types" for the expected types. */
991 VAGenericValue value;
995 * @name VASurfaceAttribMemoryType values in bit fields.
996 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
997 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
998 * types are defined in DRM and Android header files.
1001 /** \brief VA memory type (default) is supported. */
1002 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1003 /** \brief V4L2 buffer memory type is supported. */
1004 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1005 /** \brief User pointer memory type is supported. */
1006 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1010 * \brief VASurfaceAttribExternalBuffers structure for
1011 * the VASurfaceAttribExternalBufferDescriptor attribute.
1013 typedef struct _VASurfaceAttribExternalBuffers {
1014 /** \brief pixel format in fourcc. */
1015 uint32_t pixel_format;
1016 /** \brief width in pixels. */
1018 /** \brief height in pixels. */
1020 /** \brief total size of the buffer in bytes. */
1022 /** \brief number of planes for planar layout */
1023 uint32_t num_planes;
1024 /** \brief pitch for each plane in bytes */
1025 uint32_t pitches[4];
1026 /** \brief offset for each plane in bytes */
1027 uint32_t offsets[4];
1028 /** \brief buffer handles or user pointers */
1030 /** \brief number of elements in the "buffers" array */
1031 uint32_t num_buffers;
1032 /** \brief flags. See "Surface external buffer descriptor flags". */
1034 /** \brief reserved for passing private data */
1036 } VASurfaceAttribExternalBuffers;
1038 /** @name VASurfaceAttribExternalBuffers flags */
1040 /** \brief Enable memory tiling */
1041 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1042 /** \brief Memory is cacheable */
1043 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1044 /** \brief Memory is non-cacheable */
1045 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1046 /** \brief Memory is write-combined */
1047 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1048 /** \brief Memory is protected */
1049 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1051 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1053 /** \brief Surface usage not indicated. */
1054 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1055 /** \brief Surface used by video decoder. */
1056 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1057 /** \brief Surface used by video encoder. */
1058 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1059 /** \brief Surface read by video post-processing. */
1060 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1061 /** \brief Surface written by video post-processing. */
1062 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1063 /** \brief Surface used for display. */
1064 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1069 * \brief Queries surface attributes for the supplied config.
1071 * This function queries for all supported attributes for the
1072 * supplied VA @config. In particular, if the underlying hardware
1073 * supports the creation of VA surfaces in various formats, then
1074 * this function will enumerate all pixel formats that are supported.
1076 * The \c attrib_list array is allocated by the user and \c
1077 * num_attribs shall be initialized to the number of allocated
1078 * elements in that array. Upon successful return, the actual number
1079 * of attributes will be overwritten into \c num_attribs. Otherwise,
1080 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1081 * is adjusted to the number of elements that would be returned if
1082 * enough space was available.
1084 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1085 * argument when vaQuerySurfaceAttributes() is used to determine the
1086 * actual number of elements that need to be allocated.
1088 * @param[in] dpy the VA display
1089 * @param[in] config the config identifying a codec or a video
1090 * processing pipeline
1091 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1092 * @param[in,out] num_attribs the number of elements allocated on
1093 * input, the number of elements actually filled in output
1096 vaQuerySurfaceAttributes(
1099 VASurfaceAttrib *attrib_list,
1100 unsigned int *num_attribs
1104 * \brief Creates an array of surfaces
1106 * Creates an array of surfaces. The optional list of attributes shall
1107 * be constructed based on what the underlying hardware could expose
1108 * through vaQuerySurfaceAttributes().
1110 * @param[in] dpy the VA display
1111 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1112 * @param[in] width the surface width
1113 * @param[in] height the surface height
1114 * @param[out] surfaces the array of newly created surfaces
1115 * @param[in] num_surfaces the number of surfaces to create
1116 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1117 * @param[in] num_attribs the number of attributes supplied in
1118 * \c attrib_list, or zero
1123 unsigned int format,
1125 unsigned int height,
1126 VASurfaceID *surfaces,
1127 unsigned int num_surfaces,
1128 VASurfaceAttrib *attrib_list,
1129 unsigned int num_attribs
1133 * vaDestroySurfaces - Destroy resources associated with surfaces.
1134 * Surfaces can only be destroyed after all contexts using these surfaces have been
1137 * surfaces: array of surfaces to destroy
1138 * num_surfaces: number of surfaces in the array to be destroyed.
1140 VAStatus vaDestroySurfaces (
1142 VASurfaceID *surfaces,
1146 #define VA_PROGRESSIVE 0x1
1148 * vaCreateContext - Create a context
1150 * config_id: configuration for the context
1151 * picture_width: coded picture width
1152 * picture_height: coded picture height
1153 * flag: any combination of the following:
1154 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1155 * render_targets: a hint for render targets (surfaces) tied to the context
1156 * num_render_targets: number of render targets in the above array
1157 * context: created context id upon return
1159 VAStatus vaCreateContext (
1161 VAConfigID config_id,
1165 VASurfaceID *render_targets,
1166 int num_render_targets,
1167 VAContextID *context /* out */
1171 * vaDestroyContext - Destroy a context
1173 * context: context to be destroyed
1175 VAStatus vaDestroyContext (
1180 //Multi-frame context
1181 typedef VAGenericID VAMFContextID;
1183 * vaCreateMFContext - Create a multi-frame context
1184 * interface encapsulating common for all streams memory objects and structures
1185 * required for single GPU task submission from several VAContextID's.
1186 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1187 * Support identification: Application can identify multi-frame feature support by ability
1188 * to create multi-frame context. If driver supports multi-frame - call successful,
1189 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1190 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1192 * VA_STATUS_SUCCESS - operation successful.
1193 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1194 * dpy: display adapter.
1195 * mf_context: Multi-Frame context encapsulating all associated context
1196 * for multi-frame submission.
1198 VAStatus vaCreateMFContext (
1200 VAMFContextID *mf_context /* out */
1204 * vaMFAddContext - Provide ability to associate each context used for
1205 * Multi-Frame submission and common Multi-Frame context.
1206 * Try to add context to understand if it is supported.
1207 * Allocation: this call allocates and/or reallocates all memory objects
1208 * common for all contexts associated with particular Multi-Frame context.
1209 * All memory required for each context(pixel buffers, internal driver
1210 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1211 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1212 * first context added will set entry point/profile for whole Multi-Frame context,
1213 * all other entry points and profiles can be rejected to be added.
1215 * VA_STATUS_SUCCESS - operation successful, context was added.
1216 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1217 * current mf_context and associated contexts and start working with new ones.
1218 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1219 * 1 - mf_context is not valid context or
1220 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1221 * and current context contradicts with previously added, application can continue with current mf_context
1222 * and other contexts passed this call, rejected context can continue work in stand-alone
1223 * mode or other mf_context.
1224 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1225 * unsupported VAEntrypoint. Application can continue with current mf_context
1226 * and other contexts passed this call, rejected context can continue work in stand-alone
1228 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1229 * but VAProfile is not supported. Application can continue with current mf_context
1230 * and other contexts passed this call, rejected context can continue work in stand-alone
1232 * dpy: display adapter.
1233 * context: context being associated with Multi-Frame context.
1234 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1236 VAStatus vaMFAddContext (
1238 VAMFContextID mf_context,
1243 * vaMFReleaseContext - Removes context from multi-frame and
1244 * association with multi-frame context.
1245 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1247 * VA_STATUS_SUCCESS - operation successful, context was removed.
1248 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1249 * application need to destroy this VAMFContextID and all assotiated VAContextID
1251 * mf_context: VAMFContextID where context is added
1252 * context: VAContextID to be added
1254 VAStatus vaMFReleaseContext (
1256 VAMFContextID mf_context,
1262 * Buffers are used to pass various types of data from the
1263 * client to the server. The server maintains a data store
1264 * for each buffer created, and the client idenfies a buffer
1265 * through a unique buffer id assigned by the server.
1268 typedef VAGenericID VABufferID;
1272 VAPictureParameterBufferType = 0,
1273 VAIQMatrixBufferType = 1,
1274 VABitPlaneBufferType = 2,
1275 VASliceGroupMapBufferType = 3,
1276 VASliceParameterBufferType = 4,
1277 VASliceDataBufferType = 5,
1278 VAMacroblockParameterBufferType = 6,
1279 VAResidualDataBufferType = 7,
1280 VADeblockingParameterBufferType = 8,
1281 VAImageBufferType = 9,
1282 VAProtectedSliceDataBufferType = 10,
1283 VAQMatrixBufferType = 11,
1284 VAHuffmanTableBufferType = 12,
1285 VAProbabilityBufferType = 13,
1287 /* Following are encode buffer types */
1288 VAEncCodedBufferType = 21,
1289 VAEncSequenceParameterBufferType = 22,
1290 VAEncPictureParameterBufferType = 23,
1291 VAEncSliceParameterBufferType = 24,
1292 VAEncPackedHeaderParameterBufferType = 25,
1293 VAEncPackedHeaderDataBufferType = 26,
1294 VAEncMiscParameterBufferType = 27,
1295 VAEncMacroblockParameterBufferType = 28,
1296 VAEncMacroblockMapBufferType = 29,
1299 * \brief Encoding QP buffer
1301 * This buffer contains QP per MB for encoding. Currently
1302 * VAEncQPBufferH264 is defined for H.264 encoding, see
1303 * #VAEncQPBufferH264 for details
1305 VAEncQPBufferType = 30,
1306 /* Following are video processing buffer types */
1308 * \brief Video processing pipeline parameter buffer.
1310 * This buffer describes the video processing pipeline. See
1311 * #VAProcPipelineParameterBuffer for details.
1313 VAProcPipelineParameterBufferType = 41,
1315 * \brief Video filter parameter buffer.
1317 * This buffer describes the video filter parameters. All buffers
1318 * inherit from #VAProcFilterParameterBufferBase, thus including
1319 * a unique filter buffer type.
1321 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1322 * Filters requiring advanced parameters include, but are not limited to,
1323 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1324 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1326 VAProcFilterParameterBufferType = 42,
1328 * \brief FEI specific buffer types
1330 VAEncFEIMVBufferType = 43,
1331 VAEncFEIMBCodeBufferType = 44,
1332 VAEncFEIDistortionBufferType = 45,
1333 VAEncFEIMBControlBufferType = 46,
1334 VAEncFEIMVPredictorBufferType = 47,
1340 VAEncMiscParameterTypeFrameRate = 0,
1341 VAEncMiscParameterTypeRateControl = 1,
1342 VAEncMiscParameterTypeMaxSliceSize = 2,
1343 VAEncMiscParameterTypeAIR = 3,
1344 /** \brief Buffer type used to express a maximum frame size (in bits). */
1345 VAEncMiscParameterTypeMaxFrameSize = 4,
1346 /** \brief Buffer type used for HRD parameters. */
1347 VAEncMiscParameterTypeHRD = 5,
1348 VAEncMiscParameterTypeQualityLevel = 6,
1349 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1350 * rate control, when the user has externally skipped frames. */
1351 VAEncMiscParameterTypeSkipFrame = 9,
1352 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1353 VAEncMiscParameterTypeROI = 10,
1354 /** \brief Buffer type used for temporal layer structure */
1355 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1356 /** \brief Buffer type used for FEI input frame level parameters */
1357 VAEncMiscParameterTypeFEIFrameControl = 18,
1358 } VAEncMiscParameterType;
1360 /** \brief Packed header type. */
1362 /** \brief Packed sequence header. */
1363 VAEncPackedHeaderSequence = 1,
1364 /** \brief Packed picture header. */
1365 VAEncPackedHeaderPicture = 2,
1366 /** \brief Packed slice header. */
1367 VAEncPackedHeaderSlice = 3,
1369 * \brief Packed raw header.
1371 * Packed raw data header can be used by the client to insert a header
1372 * into the bitstream data buffer at the point it is passed, the driver
1373 * will handle the raw packed header based on "has_emulation_bytes" field
1374 * in the packed header parameter structure.
1376 VAEncPackedHeaderRawData = 4,
1378 * \brief Misc packed header. See codec-specific definitions.
1381 * This is a deprecated packed header type. All applications can use
1382 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1384 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1385 } VAEncPackedHeaderType;
1387 /** \brief Packed header parameter. */
1388 typedef struct _VAEncPackedHeaderParameterBuffer {
1389 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1391 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1392 uint32_t bit_length;
1393 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1394 uint8_t has_emulation_bytes;
1396 /** \brief Reserved bytes for future use, must be zero */
1397 uint32_t va_reserved[VA_PADDING_LOW];
1398 } VAEncPackedHeaderParameterBuffer;
1401 * For application, e.g. set a new bitrate
1402 * VABufferID buf_id;
1403 * VAEncMiscParameterBuffer *misc_param;
1404 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1406 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1407 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1408 * 1, NULL, &buf_id);
1410 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1411 * misc_param->type = VAEncMiscParameterTypeRateControl;
1412 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1413 * misc_rate_ctrl->bits_per_second = 6400000;
1414 * vaUnmapBuffer(dpy, buf_id);
1415 * vaRenderPicture(dpy, context, &buf_id, 1);
1417 typedef struct _VAEncMiscParameterBuffer
1419 VAEncMiscParameterType type;
1421 } VAEncMiscParameterBuffer;
1423 /** \brief Temporal layer Structure*/
1424 typedef struct _VAEncMiscParameterTemporalLayerStructure
1426 /** \brief The number of temporal layers */
1427 uint32_t number_of_layers;
1428 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1429 uint32_t periodicity;
1431 * \brief The array indicating the layer id for each frame
1433 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1434 * ids for frames starting from the 2nd frame.
1436 uint32_t layer_id[32];
1438 /** \brief Reserved bytes for future use, must be zero */
1439 uint32_t va_reserved[VA_PADDING_LOW];
1440 } VAEncMiscParameterTemporalLayerStructure;
1443 /** \brief Rate control parameters */
1444 typedef struct _VAEncMiscParameterRateControl
1446 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1447 uint32_t bits_per_second;
1448 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1449 * bit-rate for example if target_percentage is 95 then the rate control will target
1450 * a bit-rate that is 95% of the maximum bit-rate
1452 uint32_t target_percentage;
1453 /* windows size in milliseconds. For example if this is set to 500,
1454 * then the rate control will guarantee the target bit-rate over a 500 ms window
1456 uint32_t window_size;
1457 /* initial QP at I frames */
1458 uint32_t initial_qp;
1460 uint32_t basic_unit_size;
1466 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1467 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1468 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1470 * The temporal layer that the rate control parameters are specified for.
1472 uint32_t temporal_id : 8;
1473 /** \brief Reserved for future use, must be zero */
1474 uint32_t reserved : 17;
1479 /** \brief Reserved bytes for future use, must be zero */
1480 uint32_t va_reserved[VA_PADDING_MEDIUM];
1481 } VAEncMiscParameterRateControl;
1483 typedef struct _VAEncMiscParameterFrameRate
1486 * The framerate is specified as a number of frames per second, as a
1487 * fraction. The denominator of the fraction is given in the top half
1488 * (the high two bytes) of the framerate field, and the numerator is
1489 * given in the bottom half (the low two bytes).
1492 * denominator = framerate >> 16 & 0xffff;
1493 * numerator = framerate & 0xffff;
1494 * fps = numerator / denominator;
1496 * For example, if framerate is set to (100 << 16 | 750), this is
1497 * 750 / 100, hence 7.5fps.
1499 * If the denominator is zero (the high two bytes are both zero) then
1500 * it takes the value one instead, so the framerate is just the integer
1501 * in the low 2 bytes.
1509 * The temporal id the framerate parameters are specified for.
1511 uint32_t temporal_id : 8;
1512 uint32_t reserved : 24;
1517 /** \brief Reserved bytes for future use, must be zero */
1518 uint32_t va_reserved[VA_PADDING_LOW];
1519 } VAEncMiscParameterFrameRate;
1522 * Allow a maximum slice size to be specified (in bits).
1523 * The encoder will attempt to make sure that individual slices do not exceed this size
1524 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1526 typedef struct _VAEncMiscParameterMaxSliceSize
1528 uint32_t max_slice_size;
1530 /** \brief Reserved bytes for future use, must be zero */
1531 uint32_t va_reserved[VA_PADDING_LOW];
1532 } VAEncMiscParameterMaxSliceSize;
1534 typedef struct _VAEncMiscParameterAIR
1536 uint32_t air_num_mbs;
1537 uint32_t air_threshold;
1538 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1540 /** \brief Reserved bytes for future use, must be zero */
1541 uint32_t va_reserved[VA_PADDING_LOW];
1542 } VAEncMiscParameterAIR;
1544 typedef struct _VAEncMiscParameterHRD
1546 uint32_t initial_buffer_fullness; /* in bits */
1547 uint32_t buffer_size; /* in bits */
1549 /** \brief Reserved bytes for future use, must be zero */
1550 uint32_t va_reserved[VA_PADDING_LOW];
1551 } VAEncMiscParameterHRD;
1554 * \brief Defines a maximum frame size (in bits).
1556 * This misc parameter buffer defines the maximum size of a frame (in
1557 * bits). The encoder will try to make sure that each frame does not
1558 * exceed this size. Otherwise, if the frame size exceeds this size,
1559 * the \c status flag of #VACodedBufferSegment will contain
1560 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1562 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1563 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1564 VAEncMiscParameterType type;
1565 /** \brief Maximum size of a frame (in bits). */
1566 uint32_t max_frame_size;
1568 /** \brief Reserved bytes for future use, must be zero */
1569 uint32_t va_reserved[VA_PADDING_LOW];
1570 } VAEncMiscParameterBufferMaxFrameSize;
1573 * \brief Encoding quality level.
1575 * The encoding quality could be set through this structure, if the implementation
1576 * supports multiple quality levels. The quality level set through this structure is
1577 * persistent over the entire coded sequence, or until a new structure is being sent.
1578 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1579 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1580 * quality. The quality level setting is used as a trade-off between quality and speed/power
1581 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1583 typedef struct _VAEncMiscParameterBufferQualityLevel {
1584 /** \brief Encoding quality level setting. When set to 0, default quality
1587 uint32_t quality_level;
1589 /** \brief Reserved bytes for future use, must be zero */
1590 uint32_t va_reserved[VA_PADDING_LOW];
1591 } VAEncMiscParameterBufferQualityLevel;
1594 * \brief Encoding skip frame.
1596 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1597 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1598 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1599 * current frame. It is allowed for the application to still send in packed headers for the driver to
1600 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1602 typedef struct _VAEncMiscParameterSkipFrame {
1603 /** \brief Indicates skip frames as below.
1604 * 0: Encode as normal, no skip.
1605 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1606 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1607 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1608 * in VAEncPackedHeaderPicture). */
1609 uint8_t skip_frame_flag;
1610 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1611 uint8_t num_skip_frames;
1612 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1613 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1614 uint32_t size_skip_frames;
1616 /** \brief Reserved bytes for future use, must be zero */
1617 uint32_t va_reserved[VA_PADDING_LOW];
1618 } VAEncMiscParameterSkipFrame;
1621 * \brief Encoding region-of-interest (ROI).
1623 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1624 * supports ROI input. The ROI set through this structure is applicable only to the
1625 * current frame or field, so must be sent every frame or field to be applied. The number of
1626 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1627 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1629 typedef struct _VAEncROI
1631 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1632 * codec coding units. It is relative to frame coordinates for the frame case and
1633 * to field coordinates for the field case. */
1634 VARectangle roi_rectangle;
1638 * \ref roi_value specifies ROI delta QP or ROI priority.
1639 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1640 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1641 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1642 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1643 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1644 * regions, the roi_value that is first in the ROI array will have priority.
1646 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1647 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1649 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1650 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1651 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1656 typedef struct _VAEncMiscParameterBufferROI {
1657 /** \brief Number of ROIs being sent.*/
1660 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1661 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1663 int8_t max_delta_qp;
1664 int8_t min_delta_qp;
1666 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1667 * coordinates for the frame case and to field coordinates for the field case.*/
1672 * \brief An indication for roi value.
1674 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1675 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1676 * in #VAEncROI should be used as ROI priority.
1678 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1679 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
1680 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1681 * when VAConfigAttribRateControl == VA_RC_CQP.
1683 uint32_t roi_value_is_qp_delta : 1;
1684 uint32_t reserved : 31;
1689 /** \brief Reserved bytes for future use, must be zero */
1690 uint32_t va_reserved[VA_PADDING_LOW];
1691 } VAEncMiscParameterBufferROI;
1694 * There will be cases where the bitstream buffer will not have enough room to hold
1695 * the data for the entire slice, and the following flags will be used in the slice
1696 * parameter to signal to the server for the possible cases.
1697 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1698 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1699 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1701 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1702 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1703 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1704 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1706 /* Codec-independent Slice Parameter Buffer base */
1707 typedef struct _VASliceParameterBufferBase
1709 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
1710 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
1711 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1712 } VASliceParameterBufferBase;
1714 /**********************************
1715 * JPEG common data structures
1716 **********************************/
1718 * \brief Huffman table for JPEG decoding.
1720 * This structure holds the complete Huffman tables. This is an
1721 * aggregation of all Huffman table (DHT) segments maintained by the
1722 * application. i.e. up to 2 Huffman tables are stored in there for
1725 * The #load_huffman_table array can be used as a hint to notify the
1726 * VA driver implementation about which table(s) actually changed
1727 * since the last submission of this buffer.
1729 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1730 /** \brief Specifies which #huffman_table is valid. */
1731 uint8_t load_huffman_table[2];
1732 /** \brief Huffman tables indexed by table identifier (Th). */
1734 /** @name DC table (up to 12 categories) */
1736 /** \brief Number of Huffman codes of length i + 1 (Li). */
1737 uint8_t num_dc_codes[16];
1738 /** \brief Value associated with each Huffman code (Vij). */
1739 uint8_t dc_values[12];
1741 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1743 /** \brief Number of Huffman codes of length i + 1 (Li). */
1744 uint8_t num_ac_codes[16];
1745 /** \brief Value associated with each Huffman code (Vij). */
1746 uint8_t ac_values[162];
1747 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1752 /** \brief Reserved bytes for future use, must be zero */
1753 uint32_t va_reserved[VA_PADDING_LOW];
1754 } VAHuffmanTableBufferJPEGBaseline;
1756 /****************************
1757 * MPEG-2 data structures
1758 ****************************/
1760 /* MPEG-2 Picture Parameter Buffer */
1762 * For each frame or field, and before any slice data, a single
1763 * picture parameter buffer must be send.
1765 typedef struct _VAPictureParameterBufferMPEG2
1767 uint16_t horizontal_size;
1768 uint16_t vertical_size;
1769 VASurfaceID forward_reference_picture;
1770 VASurfaceID backward_reference_picture;
1771 /* meanings of the following fields are the same as in the standard */
1772 int32_t picture_coding_type;
1773 int32_t f_code; /* pack all four fcode into this */
1776 uint32_t intra_dc_precision : 2;
1777 uint32_t picture_structure : 2;
1778 uint32_t top_field_first : 1;
1779 uint32_t frame_pred_frame_dct : 1;
1780 uint32_t concealment_motion_vectors : 1;
1781 uint32_t q_scale_type : 1;
1782 uint32_t intra_vlc_format : 1;
1783 uint32_t alternate_scan : 1;
1784 uint32_t repeat_first_field : 1;
1785 uint32_t progressive_frame : 1;
1786 uint32_t is_first_field : 1; /* indicate whether the current field
1787 * is the first field for field picture
1791 } picture_coding_extension;
1793 /** \brief Reserved bytes for future use, must be zero */
1794 uint32_t va_reserved[VA_PADDING_LOW];
1795 } VAPictureParameterBufferMPEG2;
1797 /** MPEG-2 Inverse Quantization Matrix Buffer */
1798 typedef struct _VAIQMatrixBufferMPEG2
1800 /** \brief Same as the MPEG-2 bitstream syntax element. */
1801 int32_t load_intra_quantiser_matrix;
1802 /** \brief Same as the MPEG-2 bitstream syntax element. */
1803 int32_t load_non_intra_quantiser_matrix;
1804 /** \brief Same as the MPEG-2 bitstream syntax element. */
1805 int32_t load_chroma_intra_quantiser_matrix;
1806 /** \brief Same as the MPEG-2 bitstream syntax element. */
1807 int32_t load_chroma_non_intra_quantiser_matrix;
1808 /** \brief Luminance intra matrix, in zig-zag scan order. */
1809 uint8_t intra_quantiser_matrix[64];
1810 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1811 uint8_t non_intra_quantiser_matrix[64];
1812 /** \brief Chroma intra matrix, in zig-zag scan order. */
1813 uint8_t chroma_intra_quantiser_matrix[64];
1814 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1815 uint8_t chroma_non_intra_quantiser_matrix[64];
1817 /** \brief Reserved bytes for future use, must be zero */
1818 uint32_t va_reserved[VA_PADDING_LOW];
1819 } VAIQMatrixBufferMPEG2;
1821 /** MPEG-2 Slice Parameter Buffer */
1822 typedef struct _VASliceParameterBufferMPEG2
1824 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1825 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1826 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1827 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1828 uint32_t slice_horizontal_position;
1829 uint32_t slice_vertical_position;
1830 int32_t quantiser_scale_code;
1831 int32_t intra_slice_flag;
1833 /** \brief Reserved bytes for future use, must be zero */
1834 uint32_t va_reserved[VA_PADDING_LOW];
1835 } VASliceParameterBufferMPEG2;
1837 /** MPEG-2 Macroblock Parameter Buffer */
1838 typedef struct _VAMacroblockParameterBufferMPEG2
1840 uint16_t macroblock_address;
1842 * macroblock_address (in raster scan order)
1844 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1846 uint8_t macroblock_type; /* see definition below */
1849 uint32_t frame_motion_type : 2;
1850 uint32_t field_motion_type : 2;
1851 uint32_t dct_type : 1;
1855 uint8_t motion_vertical_field_select;
1857 * motion_vertical_field_select:
1858 * see section 6.3.17.2 in the spec
1859 * only the lower 4 bits are used
1860 * bit 0: first vector forward
1861 * bit 1: first vector backward
1862 * bit 2: second vector forward
1863 * bit 3: second vector backward
1865 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
1866 uint16_t coded_block_pattern;
1868 * The bitplanes for coded_block_pattern are described
1869 * in Figure 6.10-12 in the spec
1872 /* Number of skipped macroblocks after this macroblock */
1873 uint16_t num_skipped_macroblocks;
1875 /** \brief Reserved bytes for future use, must be zero */
1876 uint32_t va_reserved[VA_PADDING_LOW];
1877 } VAMacroblockParameterBufferMPEG2;
1880 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1882 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1883 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1884 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1885 #define VA_MB_TYPE_MOTION_INTRA 0x10
1888 * MPEG-2 Residual Data Buffer
1889 * For each macroblock, there wil be 64 shorts (16-bit) in the
1890 * residual data buffer
1893 /****************************
1894 * MPEG-4 Part 2 data structures
1895 ****************************/
1897 /* MPEG-4 Picture Parameter Buffer */
1899 * For each frame or field, and before any slice data, a single
1900 * picture parameter buffer must be send.
1902 typedef struct _VAPictureParameterBufferMPEG4
1905 uint16_t vop_height;
1906 VASurfaceID forward_reference_picture;
1907 VASurfaceID backward_reference_picture;
1910 uint32_t short_video_header : 1;
1911 uint32_t chroma_format : 2;
1912 uint32_t interlaced : 1;
1913 uint32_t obmc_disable : 1;
1914 uint32_t sprite_enable : 2;
1915 uint32_t sprite_warping_accuracy : 2;
1916 uint32_t quant_type : 1;
1917 uint32_t quarter_sample : 1;
1918 uint32_t data_partitioned : 1;
1919 uint32_t reversible_vlc : 1;
1920 uint32_t resync_marker_disable : 1;
1924 uint8_t no_of_sprite_warping_points;
1925 int16_t sprite_trajectory_du[3];
1926 int16_t sprite_trajectory_dv[3];
1927 uint8_t quant_precision;
1930 uint32_t vop_coding_type : 2;
1931 uint32_t backward_reference_vop_coding_type : 2;
1932 uint32_t vop_rounding_type : 1;
1933 uint32_t intra_dc_vlc_thr : 3;
1934 uint32_t top_field_first : 1;
1935 uint32_t alternate_vertical_scan_flag : 1;
1939 uint8_t vop_fcode_forward;
1940 uint8_t vop_fcode_backward;
1941 uint16_t vop_time_increment_resolution;
1942 /* short header related */
1943 uint8_t num_gobs_in_vop;
1944 uint8_t num_macroblocks_in_gob;
1945 /* for direct mode prediction */
1949 /** \brief Reserved bytes for future use, must be zero */
1950 uint32_t va_reserved[VA_PADDING_LOW];
1951 } VAPictureParameterBufferMPEG4;
1953 /** MPEG-4 Inverse Quantization Matrix Buffer */
1954 typedef struct _VAIQMatrixBufferMPEG4
1956 /** Same as the MPEG-4:2 bitstream syntax element. */
1957 int32_t load_intra_quant_mat;
1958 /** Same as the MPEG-4:2 bitstream syntax element. */
1959 int32_t load_non_intra_quant_mat;
1960 /** The matrix for intra blocks, in zig-zag scan order. */
1961 uint8_t intra_quant_mat[64];
1962 /** The matrix for non-intra blocks, in zig-zag scan order. */
1963 uint8_t non_intra_quant_mat[64];
1965 /** \brief Reserved bytes for future use, must be zero */
1966 uint32_t va_reserved[VA_PADDING_LOW];
1967 } VAIQMatrixBufferMPEG4;
1969 /** MPEG-4 Slice Parameter Buffer */
1970 typedef struct _VASliceParameterBufferMPEG4
1972 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1973 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1974 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1975 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1976 uint32_t macroblock_number;
1977 int32_t quant_scale;
1979 /** \brief Reserved bytes for future use, must be zero */
1980 uint32_t va_reserved[VA_PADDING_LOW];
1981 } VASliceParameterBufferMPEG4;
1984 VC-1 data structures
1987 typedef enum /* see 7.1.1.32 */
1990 VAMvMode1MvHalfPel = 1,
1991 VAMvMode1MvHalfPelBilinear = 2,
1992 VAMvModeMixedMv = 3,
1993 VAMvModeIntensityCompensation = 4
1996 /** VC-1 Picture Parameter Buffer */
1998 * For each picture, and before any slice data, a picture parameter
1999 * buffer must be send. Multiple picture parameter buffers may be
2000 * sent for a single picture. In that case picture parameters will
2001 * apply to all slice data that follow it until a new picture
2002 * parameter buffer is sent.
2005 * pic_quantizer_type should be set to the applicable quantizer
2006 * type as defined by QUANTIZER (J.1.19) and either
2007 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2009 typedef struct _VAPictureParameterBufferVC1
2011 VASurfaceID forward_reference_picture;
2012 VASurfaceID backward_reference_picture;
2013 /* if out-of-loop post-processing is done on the render
2014 target, then we need to keep the in-loop decoded
2015 picture as a reference picture */
2016 VASurfaceID inloop_decoded_picture;
2018 /* sequence layer for AP or meta data for SP and MP */
2021 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2022 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2023 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2024 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2025 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2026 uint32_t multires : 1; /* METADATA::MULTIRES */
2027 uint32_t overlap : 1; /* METADATA::OVERLAP */
2028 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2029 uint32_t rangered : 1; /* METADATA::RANGERED */
2030 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2031 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2036 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2037 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2040 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2041 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2042 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2043 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2046 } entrypoint_fields;
2047 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2048 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2051 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2052 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2053 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2054 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2057 } range_mapping_fields;
2059 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2060 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2061 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2062 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2063 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2064 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2065 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2066 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2067 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2071 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2072 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2073 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2074 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2075 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2081 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2082 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2083 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2084 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2085 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2086 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2087 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2093 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2094 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2095 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2096 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2097 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2098 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2099 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2102 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2105 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2106 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2107 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2108 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2114 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2115 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2116 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2117 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2118 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2119 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2120 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2121 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2122 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2123 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2129 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2130 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2131 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2132 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2133 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2134 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2135 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2136 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2137 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2138 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2139 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2142 } pic_quantizer_fields;
2145 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2146 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2147 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2148 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2149 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2150 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2155 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2156 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2157 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2159 /** \brief Reserved bytes for future use, must be zero */
2160 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2161 } VAPictureParameterBufferVC1;
2163 /** VC-1 Bitplane Buffer
2164 There will be at most three bitplanes coded in any picture header. To send
2165 the bitplane data more efficiently, each byte is divided in two nibbles, with
2166 each nibble carrying three bitplanes for one macroblock. The following table
2167 shows the bitplane data arrangement within each nibble based on the picture
2170 Picture Type Bit3 Bit2 Bit1 Bit0
2171 I or BI OVERFLAGS ACPRED FIELDTX
2172 P MYTYPEMB SKIPMB DIRECTMB
2173 B FORWARDMB SKIPMB DIRECTMB
2175 Within each byte, the lower nibble is for the first MB and the upper nibble is
2176 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2177 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2178 Macroblock #2 in the first row.
2181 /* VC-1 Slice Parameter Buffer */
2182 typedef struct _VASliceParameterBufferVC1
2184 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2185 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2186 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2187 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2188 uint32_t slice_vertical_position;
2190 /** \brief Reserved bytes for future use, must be zero */
2191 uint32_t va_reserved[VA_PADDING_LOW];
2192 } VASliceParameterBufferVC1;
2194 /* VC-1 Slice Data Buffer */
2196 This is simplely a buffer containing raw bit-stream bytes
2199 /****************************
2200 * H.264/AVC data structures
2201 ****************************/
2203 typedef struct _VAPictureH264
2205 VASurfaceID picture_id;
2208 int32_t TopFieldOrderCnt;
2209 int32_t BottomFieldOrderCnt;
2211 /** \brief Reserved bytes for future use, must be zero */
2212 uint32_t va_reserved[VA_PADDING_LOW];
2214 /* flags in VAPictureH264 could be OR of the following */
2215 #define VA_PICTURE_H264_INVALID 0x00000001
2216 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2217 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2218 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2219 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2221 /** H.264 Picture Parameter Buffer */
2223 * For each picture, and before any slice data, a single
2224 * picture parameter buffer must be send.
2226 typedef struct _VAPictureParameterBufferH264
2228 VAPictureH264 CurrPic;
2229 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2230 uint16_t picture_width_in_mbs_minus1;
2231 uint16_t picture_height_in_mbs_minus1;
2232 uint8_t bit_depth_luma_minus8;
2233 uint8_t bit_depth_chroma_minus8;
2234 uint8_t num_ref_frames;
2237 uint32_t chroma_format_idc : 2;
2238 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2239 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2240 uint32_t frame_mbs_only_flag : 1;
2241 uint32_t mb_adaptive_frame_field_flag : 1;
2242 uint32_t direct_8x8_inference_flag : 1;
2243 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2244 uint32_t log2_max_frame_num_minus4 : 4;
2245 uint32_t pic_order_cnt_type : 2;
2246 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2247 uint32_t delta_pic_order_always_zero_flag : 1;
2251 // FMO is not supported.
2252 va_deprecated uint8_t num_slice_groups_minus1;
2253 va_deprecated uint8_t slice_group_map_type;
2254 va_deprecated uint16_t slice_group_change_rate_minus1;
2255 int8_t pic_init_qp_minus26;
2256 int8_t pic_init_qs_minus26;
2257 int8_t chroma_qp_index_offset;
2258 int8_t second_chroma_qp_index_offset;
2261 uint32_t entropy_coding_mode_flag : 1;
2262 uint32_t weighted_pred_flag : 1;
2263 uint32_t weighted_bipred_idc : 2;
2264 uint32_t transform_8x8_mode_flag : 1;
2265 uint32_t field_pic_flag : 1;
2266 uint32_t constrained_intra_pred_flag : 1;
2267 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2268 uint32_t deblocking_filter_control_present_flag : 1;
2269 uint32_t redundant_pic_cnt_present_flag : 1;
2270 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2276 /** \brief Reserved bytes for future use, must be zero */
2277 uint32_t va_reserved[VA_PADDING_MEDIUM];
2278 } VAPictureParameterBufferH264;
2280 /** H.264 Inverse Quantization Matrix Buffer */
2281 typedef struct _VAIQMatrixBufferH264
2283 /** \brief 4x4 scaling list, in raster scan order. */
2284 uint8_t ScalingList4x4[6][16];
2285 /** \brief 8x8 scaling list, in raster scan order. */
2286 uint8_t ScalingList8x8[2][64];
2288 /** \brief Reserved bytes for future use, must be zero */
2289 uint32_t va_reserved[VA_PADDING_LOW];
2290 } VAIQMatrixBufferH264;
2292 /** H.264 Slice Parameter Buffer */
2293 typedef struct _VASliceParameterBufferH264
2295 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2296 /** \brief Byte offset to the NAL Header Unit for this slice. */
2297 uint32_t slice_data_offset;
2298 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2300 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2302 * This bit offset is relative to and includes the NAL unit byte
2303 * and represents the number of bits parsed in the slice_header()
2304 * after the removal of any emulation prevention bytes in
2305 * there. However, the slice data buffer passed to the hardware is
2306 * the original bitstream, thus including any emulation prevention
2309 uint16_t slice_data_bit_offset;
2310 uint16_t first_mb_in_slice;
2312 uint8_t direct_spatial_mv_pred_flag;
2314 * H264/AVC syntax element
2316 * if num_ref_idx_active_override_flag equals 0, host decoder should
2317 * set its value to num_ref_idx_l0_default_active_minus1.
2319 uint8_t num_ref_idx_l0_active_minus1;
2321 * H264/AVC syntax element
2323 * if num_ref_idx_active_override_flag equals 0, host decoder should
2324 * set its value to num_ref_idx_l1_default_active_minus1.
2326 uint8_t num_ref_idx_l1_active_minus1;
2327 uint8_t cabac_init_idc;
2328 int8_t slice_qp_delta;
2329 uint8_t disable_deblocking_filter_idc;
2330 int8_t slice_alpha_c0_offset_div2;
2331 int8_t slice_beta_offset_div2;
2332 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2333 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2334 uint8_t luma_log2_weight_denom;
2335 uint8_t chroma_log2_weight_denom;
2336 uint8_t luma_weight_l0_flag;
2337 int16_t luma_weight_l0[32];
2338 int16_t luma_offset_l0[32];
2339 uint8_t chroma_weight_l0_flag;
2340 int16_t chroma_weight_l0[32][2];
2341 int16_t chroma_offset_l0[32][2];
2342 uint8_t luma_weight_l1_flag;
2343 int16_t luma_weight_l1[32];
2344 int16_t luma_offset_l1[32];
2345 uint8_t chroma_weight_l1_flag;
2346 int16_t chroma_weight_l1[32][2];
2347 int16_t chroma_offset_l1[32][2];
2349 /** \brief Reserved bytes for future use, must be zero */
2350 uint32_t va_reserved[VA_PADDING_LOW];
2351 } VASliceParameterBufferH264;
2353 /****************************
2354 * Common encode data structures
2355 ****************************/
2358 VAEncPictureTypeIntra = 0,
2359 VAEncPictureTypePredictive = 1,
2360 VAEncPictureTypeBidirectional = 2,
2363 /* Encode Slice Parameter Buffer */
2364 typedef struct _VAEncSliceParameterBuffer
2366 uint32_t start_row_number; /* starting MB row number for this slice */
2367 uint32_t slice_height; /* slice height measured in MB */
2370 uint32_t is_intra : 1;
2371 uint32_t disable_deblocking_filter_idc : 2;
2372 uint32_t uses_long_term_ref :1;
2373 uint32_t is_long_term_ref :1;
2378 /** \brief Reserved bytes for future use, must be zero */
2379 uint32_t va_reserved[VA_PADDING_LOW];
2380 } VAEncSliceParameterBuffer;
2383 /****************************
2384 * H.263 specific encode data structures
2385 ****************************/
2387 typedef struct _VAEncSequenceParameterBufferH263
2389 uint32_t intra_period;
2390 uint32_t bits_per_second;
2391 uint32_t frame_rate;
2392 uint32_t initial_qp;
2395 /** \brief Reserved bytes for future use, must be zero */
2396 uint32_t va_reserved[VA_PADDING_LOW];
2397 } VAEncSequenceParameterBufferH263;
2399 typedef struct _VAEncPictureParameterBufferH263
2401 VASurfaceID reference_picture;
2402 VASurfaceID reconstructed_picture;
2403 VABufferID coded_buf;
2404 uint16_t picture_width;
2405 uint16_t picture_height;
2406 VAEncPictureType picture_type;
2408 /** \brief Reserved bytes for future use, must be zero */
2409 uint32_t va_reserved[VA_PADDING_LOW];
2410 } VAEncPictureParameterBufferH263;
2412 /****************************
2413 * MPEG-4 specific encode data structures
2414 ****************************/
2416 typedef struct _VAEncSequenceParameterBufferMPEG4
2418 uint8_t profile_and_level_indication;
2419 uint32_t intra_period;
2420 uint32_t video_object_layer_width;
2421 uint32_t video_object_layer_height;
2422 uint32_t vop_time_increment_resolution;
2423 uint32_t fixed_vop_rate;
2424 uint32_t fixed_vop_time_increment;
2425 uint32_t bits_per_second;
2426 uint32_t frame_rate;
2427 uint32_t initial_qp;
2430 /** \brief Reserved bytes for future use, must be zero */
2431 uint32_t va_reserved[VA_PADDING_LOW];
2432 } VAEncSequenceParameterBufferMPEG4;
2434 typedef struct _VAEncPictureParameterBufferMPEG4
2436 VASurfaceID reference_picture;
2437 VASurfaceID reconstructed_picture;
2438 VABufferID coded_buf;
2439 uint16_t picture_width;
2440 uint16_t picture_height;
2441 uint32_t modulo_time_base; /* number of 1s */
2442 uint32_t vop_time_increment;
2443 VAEncPictureType picture_type;
2445 /** \brief Reserved bytes for future use, must be zero */
2446 uint32_t va_reserved[VA_PADDING_LOW];
2447 } VAEncPictureParameterBufferMPEG4;
2451 /** Buffer functions */
2454 * Creates a buffer for "num_elements" elements of "size" bytes and
2455 * initalize with "data".
2456 * if "data" is null, then the contents of the buffer data store
2458 * Basically there are two ways to get buffer data to the server side. One is
2459 * to call vaCreateBuffer() with a non-null "data", which results the data being
2460 * copied to the data store on the server side. A different method that
2461 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2462 * and then use vaMapBuffer() to map the data store from the server side to the
2463 * client address space for access.
2464 * The user must call vaDestroyBuffer() to destroy a buffer.
2465 * Note: image buffers are created by the library, not the client. Please see
2466 * vaCreateImage on how image buffers are managed.
2468 VAStatus vaCreateBuffer (
2470 VAContextID context,
2471 VABufferType type, /* in */
2472 unsigned int size, /* in */
2473 unsigned int num_elements, /* in */
2474 void *data, /* in */
2475 VABufferID *buf_id /* out */
2479 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
2480 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
2481 * can call vaMapBuffer with this Buffer ID to get virtual address.
2482 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
2483 * maybe it should align with 256, and one byte present one Qp.so, call the function.
2484 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
2485 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
2486 * pBuf + 256 is the start of next line.
2487 * different driver implementation maybe return different unit_size and pitch
2489 VAStatus vaCreateBuffer2(
2491 VAContextID context,
2494 unsigned int height,
2495 unsigned int *unit_size,
2496 unsigned int *pitch,
2501 * Convey to the server how many valid elements are in the buffer.
2502 * e.g. if multiple slice parameters are being held in a single buffer,
2503 * this will communicate to the server the number of slice parameters
2504 * that are valid in the buffer.
2506 VAStatus vaBufferSetNumElements (
2508 VABufferID buf_id, /* in */
2509 unsigned int num_elements /* in */
2514 * device independent data structure for codedbuffer
2518 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2519 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2520 * enough for the encoder to attempt to limit its size.
2521 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2522 * exceeded the maximum slice size specified.
2523 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2524 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2525 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2527 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2528 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2529 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2530 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2531 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2533 * \brief The frame has exceeded the maximum requested size.
2535 * This flag indicates that the encoded frame size exceeds the value
2536 * specified through a misc parameter buffer of type
2537 * #VAEncMiscParameterTypeMaxFrameSize.
2539 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2540 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2543 * \brief The coded buffer segment contains a single NAL unit.
2545 * This flag indicates that the coded buffer segment contains a
2546 * single NAL unit. This flag might be useful to the user for
2547 * processing the coded buffer.
2549 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2552 * \brief Coded buffer segment.
2554 * #VACodedBufferSegment is an element of a linked list describing
2555 * some information on the coded buffer. The coded buffer segment
2556 * could contain either a single NAL unit, or more than one NAL unit.
2557 * It is recommended (but not required) to return a single NAL unit
2558 * in a coded buffer segment, and the implementation should set the
2559 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2561 typedef struct _VACodedBufferSegment {
2563 * \brief Size of the data buffer in this segment (in bytes).
2566 /** \brief Bit offset into the data buffer where the video data starts. */
2567 uint32_t bit_offset;
2568 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2570 /** \brief Reserved for future use. */
2572 /** \brief Pointer to the start of the data buffer. */
2575 * \brief Pointer to the next #VACodedBufferSegment element,
2576 * or \c NULL if there is none.
2580 /** \brief Reserved bytes for future use, must be zero */
2581 uint32_t va_reserved[VA_PADDING_LOW];
2582 } VACodedBufferSegment;
2585 * Map data store of the buffer into the client's address space
2586 * vaCreateBuffer() needs to be called with "data" set to NULL before
2587 * calling vaMapBuffer()
2589 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2590 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2592 VAStatus vaMapBuffer (
2594 VABufferID buf_id, /* in */
2595 void **pbuf /* out */
2599 * After client making changes to a mapped data store, it needs to
2600 * "Unmap" it to let the server know that the data is ready to be
2601 * consumed by the server
2603 VAStatus vaUnmapBuffer (
2605 VABufferID buf_id /* in */
2609 * After this call, the buffer is deleted and this buffer_id is no longer valid
2611 * A buffer can be re-used and sent to the server by another Begin/Render/End
2612 * sequence if vaDestroyBuffer() is not called with this buffer.
2614 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
2615 * hardware accelerator can result in performance dropping.
2617 VAStatus vaDestroyBuffer (
2619 VABufferID buffer_id
2622 /** \brief VA buffer information */
2624 /** \brief Buffer handle */
2626 /** \brief Buffer type (See \ref VABufferType). */
2629 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2631 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2632 * to specify the set of memory types the caller is interested in.
2633 * On successful return from vaAcquireBufferHandle(), the field is
2634 * updated with the best matching memory type.
2637 /** \brief Size of the underlying buffer. */
2640 /** \brief Reserved bytes for future use, must be zero */
2641 uint32_t va_reserved[VA_PADDING_LOW];
2645 * \brief Acquires buffer handle for external API usage
2647 * Locks the VA buffer object \ref buf_id for external API usage like
2648 * EGL or OpenCL (OCL). This function is a synchronization point. This
2649 * means that any pending operation is guaranteed to be completed
2650 * prior to returning from the function.
2652 * If the referenced VA buffer object is the backing store of a VA
2653 * surface, then this function acts as if vaSyncSurface() on the
2654 * parent surface was called first.
2656 * The \ref VABufferInfo argument shall be zero'ed on input. On
2657 * successful output, the data structure is filled in with all the
2658 * necessary buffer level implementation details like handle, type,
2659 * memory type and memory size.
2661 * Note: the external API implementation, or the application, can
2662 * express the memory types it is interested in by filling in the \ref
2663 * mem_type field accordingly. On successful output, the memory type
2664 * that fits best the request and that was used is updated in the \ref
2665 * VABufferInfo data structure. If none of the supplied memory types
2666 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2667 * error is returned.
2669 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2670 * is called. Besides, no additional operation is allowed on any of
2671 * the buffer parent object until vaReleaseBufferHandle() is called.
2672 * e.g. decoding into a VA surface backed with the supplied VA buffer
2673 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2677 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2678 * does not support this interface
2679 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2680 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2681 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2682 * does not support exporting buffers of the specified type
2683 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2684 * memory types in \ref VABufferInfo.mem_type was supported
2686 * @param[in] dpy the VA display
2687 * @param[in] buf_id the VA buffer
2688 * @param[in,out] buf_info the associated VA buffer information
2689 * @return VA_STATUS_SUCCESS if successful
2692 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2695 * \brief Releases buffer after usage from external API
2697 * Unlocks the VA buffer object \ref buf_id from external API usage like
2698 * EGL or OpenCL (OCL). This function is a synchronization point. This
2699 * means that any pending operation is guaranteed to be completed
2700 * prior to returning from the function.
2702 * The \ref VABufferInfo argument shall point to the original data
2703 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2704 * This is necessary so that the VA driver implementation could
2705 * deallocate any resources that were needed.
2707 * In any case, returning from this function invalidates any contents
2708 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2709 * valid. Therefore, VA driver implementations are free to reset this
2710 * data structure to safe defaults.
2713 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2714 * does not support this interface
2715 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2716 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2717 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2718 * does not support exporting buffers of the specified type
2720 * @param[in] dpy the VA display
2721 * @param[in] buf_id the VA buffer
2722 * @return VA_STATUS_SUCCESS if successful
2725 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2728 * Render (Video Decode/Encode/Processing) Pictures
2730 * A picture represents either a frame or a field.
2732 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
2737 * Get ready for a video pipeline
2738 * - decode a picture to a target surface
2739 * - encode a picture from a target surface
2740 * - process a picture to a target surface
2742 VAStatus vaBeginPicture (
2744 VAContextID context,
2745 VASurfaceID render_target
2749 * Send video decode, encode or processing buffers to the server.
2751 VAStatus vaRenderPicture (
2753 VAContextID context,
2754 VABufferID *buffers,
2759 * Make the end of rendering for a picture.
2760 * The server should start processing all pending operations for this
2761 * surface. This call is non-blocking. The client can start another
2762 * Begin/Render/End sequence on a different render target.
2763 * if VAContextID used in this function previously successfully passed
2764 * vaMFAddContext call, real processing will be started during vaMFSubmit
2766 VAStatus vaEndPicture (
2772 * Make the end of rendering for a pictures in contexts passed with submission.
2773 * The server should start processing all pending operations for contexts.
2774 * All contexts passed should be associated through vaMFAddContext
2775 * and call sequence Begin/Render/End performed.
2776 * This call is non-blocking. The client can start another
2777 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
2779 * VA_STATUS_SUCCESS - operation successful, context was removed.
2780 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
2781 * due to mf_context not created or one of contexts not assotiated with mf_context
2782 * through vaAddContext.
2783 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
2784 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
2786 * mf_context: Multi-Frame context
2787 * contexts: list of contexts submitting their tasks for multi-frame operation.
2788 * num_contexts: number of passed contexts.
2790 VAStatus vaMFSubmit (
2792 VAMFContextID mf_context,
2793 VAContextID * contexts,
2804 * This function blocks until all pending operations on the render target
2805 * have been completed. Upon return it is safe to use the render target for a
2806 * different picture.
2808 VAStatus vaSyncSurface (
2810 VASurfaceID render_target
2815 VASurfaceRendering = 1, /* Rendering in progress */
2816 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2817 /* this status is useful if surface is used as the source */
2819 VASurfaceReady = 4, /* not being rendered or displayed */
2820 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2824 * Find out any pending ops on the render target
2826 VAStatus vaQuerySurfaceStatus (
2828 VASurfaceID render_target,
2829 VASurfaceStatus *status /* out */
2834 VADecodeSliceMissing = 0,
2835 VADecodeMBError = 1,
2836 } VADecodeErrorType;
2839 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2840 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2842 typedef struct _VASurfaceDecodeMBErrors
2844 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2845 uint32_t start_mb; /* start mb address with errors */
2846 uint32_t end_mb; /* end mb address with errors */
2847 VADecodeErrorType decode_error_type;
2849 /** \brief Reserved bytes for future use, must be zero */
2850 uint32_t va_reserved[VA_PADDING_LOW];
2851 } VASurfaceDecodeMBErrors;
2854 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2855 * it can call vaQuerySurfaceError to find out further details on the particular error.
2856 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2857 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2858 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2859 * The array is terminated if "status==-1" is detected.
2861 VAStatus vaQuerySurfaceError(
2863 VASurfaceID surface,
2864 VAStatus error_status,
2869 * Images and Subpictures
2870 * VAImage is used to either get the surface data to client memory, or
2871 * to copy image data in client memory to a surface.
2872 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2873 * is at the upper left corner with positive X to the right and positive Y down
2875 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2876 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2877 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2880 * Pre-defined fourcc codes
2882 #define VA_FOURCC_NV12 0x3231564E
2883 #define VA_FOURCC_AI44 0x34344149
2884 #define VA_FOURCC_RGBA 0x41424752
2885 #define VA_FOURCC_RGBX 0x58424752
2886 #define VA_FOURCC_BGRA 0x41524742
2887 #define VA_FOURCC_BGRX 0x58524742
2888 #define VA_FOURCC_ARGB 0x42475241
2889 #define VA_FOURCC_XRGB 0x42475258
2890 #define VA_FOURCC_ABGR 0x52474241
2891 #define VA_FOURCC_XBGR 0x52474258
2892 #define VA_FOURCC_UYVY 0x59565955
2893 #define VA_FOURCC_YUY2 0x32595559
2894 #define VA_FOURCC_AYUV 0x56555941
2895 #define VA_FOURCC_NV11 0x3131564e
2896 #define VA_FOURCC_YV12 0x32315659
2897 #define VA_FOURCC_P208 0x38303250
2898 /* IYUV same as I420, but most user perfer I420, will deprecate it */
2899 #define VA_FOURCC_IYUV 0x56555949
2900 #define VA_FOURCC_I420 0x30323449
2901 #define VA_FOURCC_YV24 0x34325659
2902 #define VA_FOURCC_YV32 0x32335659
2903 #define VA_FOURCC_Y800 0x30303859
2904 #define VA_FOURCC_IMC3 0x33434D49
2905 #define VA_FOURCC_411P 0x50313134
2906 #define VA_FOURCC_422H 0x48323234
2907 #define VA_FOURCC_422V 0x56323234
2908 #define VA_FOURCC_444P 0x50343434
2909 #define VA_FOURCC_RGBP 0x50424752
2910 #define VA_FOURCC_BGRP 0x50524742
2911 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2914 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
2916 #define VA_FOURCC_YV16 0x36315659
2918 * 10-bit and 16-bit Planar YUV 4:2:0.
2920 #define VA_FOURCC_P010 0x30313050
2921 #define VA_FOURCC_P016 0x36313050
2924 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
2926 #define VA_FOURCC_I010 0x30313049
2929 #define VA_LSB_FIRST 1
2930 #define VA_MSB_FIRST 2
2932 typedef struct _VAImageFormat
2935 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2936 uint32_t bits_per_pixel;
2937 /* for RGB formats */
2938 uint32_t depth; /* significant bits per pixel */
2940 uint32_t green_mask;
2942 uint32_t alpha_mask;
2944 /** \brief Reserved bytes for future use, must be zero */
2945 uint32_t va_reserved[VA_PADDING_LOW];
2948 typedef VAGenericID VAImageID;
2950 typedef struct _VAImage
2952 VAImageID image_id; /* uniquely identify this image */
2953 VAImageFormat format;
2954 VABufferID buf; /* image data buffer */
2956 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2957 * data store on the server side for optimal performance. The buffer will be
2958 * created by the CreateImage function, and proper storage allocated based on the image
2959 * size and format. This buffer is managed by the library implementation, and
2960 * accessed by the client through the buffer Map/Unmap functions.
2965 uint32_t num_planes; /* can not be greater than 3 */
2967 * An array indicating the scanline pitch in bytes for each plane.
2968 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2970 uint32_t pitches[3];
2972 * An array indicating the byte offset from the beginning of the image data
2973 * to the start of each plane.
2975 uint32_t offsets[3];
2977 /* The following fields are only needed for paletted formats */
2978 int32_t num_palette_entries; /* set to zero for non-palette images */
2980 * Each component is one byte and entry_bytes indicates the number of components in
2981 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2983 int32_t entry_bytes;
2985 * An array of ascii characters describing the order of the components within the bytes.
2986 * Only entry_bytes characters of the string are used.
2988 int8_t component_order[4];
2990 /** \brief Reserved bytes for future use, must be zero */
2991 uint32_t va_reserved[VA_PADDING_LOW];
2994 /** Get maximum number of image formats supported by the implementation */
2995 int vaMaxNumImageFormats (
3000 * Query supported image formats
3001 * The caller must provide a "format_list" array that can hold at
3002 * least vaMaxNumImageFormats() entries. The actual number of formats
3003 * returned in "format_list" is returned in "num_formats".
3005 VAStatus vaQueryImageFormats (
3007 VAImageFormat *format_list, /* out */
3008 int *num_formats /* out */
3012 * Create a VAImage structure
3013 * The width and height fields returned in the VAImage structure may get
3014 * enlarged for some YUV formats. Upon return from this function,
3015 * image->buf has been created and proper storage allocated by the library.
3016 * The client can access the image through the Map/Unmap calls.
3018 VAStatus vaCreateImage (
3020 VAImageFormat *format,
3023 VAImage *image /* out */
3027 * Should call DestroyImage before destroying the surface it is bound to
3029 VAStatus vaDestroyImage (
3034 VAStatus vaSetImagePalette (
3038 * pointer to an array holding the palette data. The size of the array is
3039 * num_palette_entries * entry_bytes in size. The order of the components
3040 * in the palette is described by the component_order in VAImage struct
3042 unsigned char *palette
3046 * Retrive surface data into a VAImage
3047 * Image must be in a format supported by the implementation
3049 VAStatus vaGetImage (
3051 VASurfaceID surface,
3052 int x, /* coordinates of the upper left source pixel */
3054 unsigned int width, /* width and height of the region */
3055 unsigned int height,
3060 * Copy data from a VAImage to a surface
3061 * Image must be in a format supported by the implementation
3062 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3063 * shouldn't be rendered into when this is called
3065 VAStatus vaPutImage (
3067 VASurfaceID surface,
3071 unsigned int src_width,
3072 unsigned int src_height,
3075 unsigned int dest_width,
3076 unsigned int dest_height
3080 * Derive an VAImage from an existing surface.
3081 * This interface will derive a VAImage and corresponding image buffer from
3082 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3083 * direct CPU access. This operation is only possible on implementations with
3084 * direct rendering capabilities and internal surface formats that can be
3085 * represented with a VAImage. When the operation is not possible this interface
3086 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3087 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3090 * Implementations should only return success when the resulting image buffer
3091 * would be useable with vaMap/Unmap.
3093 * When directly accessing a surface special care must be taken to insure
3094 * proper synchronization with the graphics hardware. Clients should call
3095 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3096 * rendering or currently being displayed by an overlay.
3098 * Additionally nothing about the contents of a surface should be assumed
3099 * following a vaPutSurface. Implementations are free to modify the surface for
3100 * scaling or subpicture blending within a call to vaPutImage.
3102 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3103 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3104 * vaGetImage with other surfaces is supported.
3106 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3107 * image and image buffer structures will be destroyed; however, the underlying
3108 * surface will remain unchanged until freed with vaDestroySurfaces.
3110 VAStatus vaDeriveImage (
3112 VASurfaceID surface,
3113 VAImage *image /* out */
3118 * Subpicture is a special type of image that can be blended
3119 * with a surface during vaPutSurface(). Subpicture can be used to render
3120 * DVD sub-titles or closed captioning text etc.
3123 typedef VAGenericID VASubpictureID;
3125 /** Get maximum number of subpicture formats supported by the implementation */
3126 int vaMaxNumSubpictureFormats (
3130 /** flags for subpictures */
3131 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3132 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3133 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3135 * Query supported subpicture formats
3136 * The caller must provide a "format_list" array that can hold at
3137 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3138 * for each format to indicate additional capabilities for that format. The actual
3139 * number of formats returned in "format_list" is returned in "num_formats".
3140 * flags: returned value to indicate addtional capabilities
3141 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3142 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3143 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3146 VAStatus vaQuerySubpictureFormats (
3148 VAImageFormat *format_list, /* out */
3149 unsigned int *flags, /* out */
3150 unsigned int *num_formats /* out */
3154 * Subpictures are created with an image associated.
3156 VAStatus vaCreateSubpicture (
3159 VASubpictureID *subpicture /* out */
3163 * Destroy the subpicture before destroying the image it is assocated to
3165 VAStatus vaDestroySubpicture (
3167 VASubpictureID subpicture
3171 * Bind an image to the subpicture. This image will now be associated with
3172 * the subpicture instead of the one at creation.
3174 VAStatus vaSetSubpictureImage (
3176 VASubpictureID subpicture,
3181 * If chromakey is enabled, then the area where the source value falls within
3182 * the chromakey [min, max] range is transparent
3183 * The chromakey component format is the following:
3184 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3185 * For YUV: [0:7] V [8:15] U [16:23] Y
3186 * The chromakey mask can be used to mask out certain components for chromakey
3189 VAStatus vaSetSubpictureChromakey (
3191 VASubpictureID subpicture,
3192 unsigned int chromakey_min,
3193 unsigned int chromakey_max,
3194 unsigned int chromakey_mask
3198 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3199 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3200 * the overall alpha is per-pixel alpha multiplied by the global alpha
3202 VAStatus vaSetSubpictureGlobalAlpha (
3204 VASubpictureID subpicture,
3209 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3210 * It defines the region mapping between the subpicture and the target
3211 * surfaces through source and destination rectangles (with the same width and height).
3212 * Both will be displayed at the next call to vaPutSurface. Additional
3213 * associations before the call to vaPutSurface simply overrides the association.
3215 VAStatus vaAssociateSubpicture (
3217 VASubpictureID subpicture,
3218 VASurfaceID *target_surfaces,
3220 int16_t src_x, /* upper left offset in subpicture */
3223 uint16_t src_height,
3224 int16_t dest_x, /* upper left offset in surface */
3226 uint16_t dest_width,
3227 uint16_t dest_height,
3229 * whether to enable chroma-keying, global-alpha, or screen relative mode
3230 * see VA_SUBPICTURE_XXX values
3236 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3238 VAStatus vaDeassociateSubpicture (
3240 VASubpictureID subpicture,
3241 VASurfaceID *target_surfaces,
3246 * Display attributes
3247 * Display attributes are used to control things such as contrast, hue, saturation,
3248 * brightness etc. in the rendering process. The application can query what
3249 * attributes are supported by the driver, and then set the appropriate attributes
3250 * before calling vaPutSurface()
3252 /* PowerVR IEP Lite attributes */
3255 VADISPLAYATTRIB_BLE_OFF = 0x00,
3256 VADISPLAYATTRIB_BLE_LOW,
3257 VADISPLAYATTRIB_BLE_MEDIUM,
3258 VADISPLAYATTRIB_BLE_HIGH,
3259 VADISPLAYATTRIB_BLE_NONE,
3260 } VADisplayAttribBLEMode;
3262 /** attribute value for VADisplayAttribRotation */
3263 #define VA_ROTATION_NONE 0x00000000
3264 #define VA_ROTATION_90 0x00000001
3265 #define VA_ROTATION_180 0x00000002
3266 #define VA_ROTATION_270 0x00000003
3270 * @name Mirroring directions
3272 * Those values could be used for VADisplayAttribMirror attribute or
3273 * VAProcPipelineParameterBuffer::mirror_state.
3277 /** \brief No Mirroring. */
3278 #define VA_MIRROR_NONE 0x00000000
3279 /** \brief Horizontal Mirroring. */
3280 #define VA_MIRROR_HORIZONTAL 0x00000001
3281 /** \brief Vertical Mirroring. */
3282 #define VA_MIRROR_VERTICAL 0x00000002
3285 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3286 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3287 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3290 #define VA_RENDER_MODE_UNDEFINED 0
3291 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3292 #define VA_RENDER_MODE_LOCAL_GPU 2
3293 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3294 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3296 /** Render device */
3297 #define VA_RENDER_DEVICE_UNDEFINED 0
3298 #define VA_RENDER_DEVICE_LOCAL 1
3299 #define VA_RENDER_DEVICE_EXTERNAL 2
3301 /** Currently defined display attribute types */
3304 VADisplayAttribBrightness = 0,
3305 VADisplayAttribContrast = 1,
3306 VADisplayAttribHue = 2,
3307 VADisplayAttribSaturation = 3,
3308 /* client can specifiy a background color for the target window
3309 * the new feature of video conference,
3310 * the uncovered area of the surface is filled by this color
3311 * also it will blend with the decoded video color
3313 VADisplayAttribBackgroundColor = 4,
3315 * this is a gettable only attribute. For some implementations that use the
3316 * hardware overlay, after PutSurface is called, the surface can not be
3317 * re-used until after the subsequent PutSurface call. If this is the case
3318 * then the value for this attribute will be set to 1 so that the client
3319 * will not attempt to re-use the surface right after returning from a call
3322 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3323 * driver may use overlay or GPU alternatively
3325 VADisplayAttribDirectSurface = 5,
3326 VADisplayAttribRotation = 6,
3327 VADisplayAttribOutofLoopDeblock = 7,
3329 /* PowerVR IEP Lite specific attributes */
3330 VADisplayAttribBLEBlackMode = 8,
3331 VADisplayAttribBLEWhiteMode = 9,
3332 VADisplayAttribBlueStretch = 10,
3333 VADisplayAttribSkinColorCorrection = 11,
3335 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3336 * conversion matrix. Each element in the matrix is float-point
3338 VADisplayAttribCSCMatrix = 12,
3339 /* specify the constant color used to blend with video surface
3340 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3341 * d: the final color to overwrite into the frame buffer
3342 * v: decoded video after color conversion,
3343 * c: video color specified by VADisplayAttribBlendColor
3344 * b: background color of the drawable
3346 VADisplayAttribBlendColor = 13,
3348 * Indicate driver to skip painting color key or not.
3349 * only applicable if the render is overlay
3351 VADisplayAttribOverlayAutoPaintColorKey = 14,
3353 * customized overlay color key, the format is RGB888
3354 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3356 VADisplayAttribOverlayColorKey = 15,
3358 * The hint for the implementation of vaPutSurface
3359 * normally, the driver could use an overlay or GPU to render the surface on the screen
3360 * this flag provides APP the flexibity to switch the render dynamically
3362 VADisplayAttribRenderMode = 16,
3364 * specify if vaPutSurface needs to render into specified monitors
3365 * one example is that one external monitor (e.g. HDMI) is enabled,
3366 * but the window manager is not aware of it, and there is no associated drawable
3368 VADisplayAttribRenderDevice = 17,
3370 * specify vaPutSurface render area if there is no drawable on the monitor
3372 VADisplayAttribRenderRect = 18,
3373 } VADisplayAttribType;
3375 /* flags for VADisplayAttribute */
3376 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3377 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3378 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3380 typedef struct _VADisplayAttribute
3382 VADisplayAttribType type;
3385 int32_t value; /* used by the set/get attribute functions */
3386 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3389 /** \brief Reserved bytes for future use, must be zero */
3390 uint32_t va_reserved[VA_PADDING_LOW];
3391 } VADisplayAttribute;
3393 /** Get maximum number of display attributs supported by the implementation */
3394 int vaMaxNumDisplayAttributes (
3399 * Query display attributes
3400 * The caller must provide a "attr_list" array that can hold at
3401 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3402 * returned in "attr_list" is returned in "num_attributes".
3404 VAStatus vaQueryDisplayAttributes (
3406 VADisplayAttribute *attr_list, /* out */
3407 int *num_attributes /* out */
3411 * Get display attributes
3412 * This function returns the current attribute values in "attr_list".
3413 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3414 * from vaQueryDisplayAttributes() can have their values retrieved.
3416 VAStatus vaGetDisplayAttributes (
3418 VADisplayAttribute *attr_list, /* in/out */
3423 * Set display attributes
3424 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3425 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3426 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3428 VAStatus vaSetDisplayAttributes (
3430 VADisplayAttribute *attr_list,
3434 /****************************
3435 * HEVC data structures
3436 ****************************/
3438 * \brief Description of picture properties of those in DPB surfaces.
3440 * If only progressive scan is supported, each surface contains one whole
3442 * Otherwise, each surface contains two fields of whole picture.
3443 * In this case, two entries of ReferenceFrames[] may share same picture_id
3446 typedef struct _VAPictureHEVC
3448 /** \brief reconstructed picture buffer surface index
3449 * invalid when taking value VA_INVALID_SURFACE.
3451 VASurfaceID picture_id;
3452 /** \brief picture order count.
3453 * in HEVC, POCs for top and bottom fields of same picture should
3454 * take different values.
3456 int32_t pic_order_cnt;
3457 /* described below */
3460 /** \brief Reserved bytes for future use, must be zero */
3461 uint32_t va_reserved[VA_PADDING_LOW];
3464 /* flags in VAPictureHEVC could be OR of the following */
3465 #define VA_PICTURE_HEVC_INVALID 0x00000001
3466 /** \brief indication of interlace scan picture.
3467 * should take same value for all the pictures in sequence.
3469 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3470 /** \brief polarity of the field picture.
3471 * top field takes even lines of buffer surface.
3472 * bottom field takes odd lines of buffer surface.
3474 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3475 /** \brief Long term reference picture */
3476 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3478 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3479 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3480 * be exclusive. No more than one of them can be set for any picture.
3481 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3482 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3483 * Application should provide valid values for both short format and long format.
3484 * The pictures in DPB with any of these three flags turned on are referred by
3485 * the current picture.
3487 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3488 * Number of ReferenceFrames[] entries with this bit set equals
3489 * NumPocStCurrBefore.
3491 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3492 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3493 * Number of ReferenceFrames[] entries with this bit set equals
3494 * NumPocStCurrAfter.
3496 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3497 /** \brief RefPicSetLtCurr of HEVC spec variable
3498 * Number of ReferenceFrames[] entries with this bit set equals
3501 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3503 #include <va/va_dec_hevc.h>
3504 #include <va/va_dec_jpeg.h>
3505 #include <va/va_dec_vp8.h>
3506 #include <va/va_dec_vp9.h>
3507 #include <va/va_enc_hevc.h>
3508 #include <va/va_enc_h264.h>
3509 #include <va/va_enc_jpeg.h>
3510 #include <va/va_enc_mpeg2.h>
3511 #include <va/va_enc_vp8.h>
3512 #include <va/va_enc_vp9.h>
3513 #include <va/va_fei.h>
3514 #include <va/va_fei_h264.h>
3515 #include <va/va_vpp.h>