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 * \brief JPEG decoding attribute. Read-only.
433 * This attribute exposes a number of capabilities of the underlying
434 * JPEG implementation. The attribute value is partitioned into fields as defined in the
435 * VAConfigAttribValDecJPEG union.
437 VAConfigAttribDecJPEG = 7,
438 /** @name Attributes for encoding */
441 * \brief Packed headers mode. Read/write.
443 * This attribute determines what packed headers the driver supports,
444 * through vaGetConfigAttributes(); and what packed headers the user
445 * will be providing to the driver, through vaCreateConfig(), if the
446 * driver supports those.
448 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
450 VAConfigAttribEncPackedHeaders = 10,
452 * \brief Interlaced mode. Read/write.
454 * This attribute determines what kind of interlaced encoding mode
455 * the driver supports.
457 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
459 VAConfigAttribEncInterlaced = 11,
461 * \brief Maximum number of reference frames. Read-only.
463 * This attribute determines the maximum number of reference
464 * frames supported for encoding.
466 * Note: for H.264 encoding, the value represents the maximum number
467 * of reference frames for both the reference picture list 0 (bottom
468 * 16 bits) and the reference picture list 1 (top 16 bits).
470 VAConfigAttribEncMaxRefFrames = 13,
472 * \brief Maximum number of slices per frame. Read-only.
474 * This attribute determines the maximum number of slices the
475 * driver can support to encode a single frame.
477 VAConfigAttribEncMaxSlices = 14,
479 * \brief Slice structure. Read-only.
481 * This attribute determines slice structures supported by the
482 * driver for encoding. This attribute is a hint to the user so
483 * that he can choose a suitable surface size and how to arrange
484 * the encoding process of multiple slices per frame.
486 * More specifically, for H.264 encoding, this attribute
487 * determines the range of accepted values to
488 * VAEncSliceParameterBufferH264::macroblock_address and
489 * VAEncSliceParameterBufferH264::num_macroblocks.
491 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
494 VAConfigAttribEncSliceStructure = 15,
496 * \brief Macroblock information. Read-only.
498 * This attribute determines whether the driver supports extra
499 * encoding information per-macroblock. e.g. QP.
501 * More specifically, for H.264 encoding, if the driver returns a non-zero
502 * value for this attribute, this means the application can create
503 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
504 * through VAEncSliceParameterBufferH264::macroblock_info.
506 VAConfigAttribEncMacroblockInfo = 16,
508 * \brief Maximum picture width. Read-only.
510 * This attribute determines the maximum picture width the driver supports
511 * for a given configuration.
513 VAConfigAttribMaxPictureWidth = 18,
515 * \brief Maximum picture height. Read-only.
517 * This attribute determines the maximum picture height the driver supports
518 * for a given configuration.
520 VAConfigAttribMaxPictureHeight = 19,
522 * \brief JPEG encoding attribute. Read-only.
524 * This attribute exposes a number of capabilities of the underlying
525 * JPEG implementation. The attribute value is partitioned into fields as defined in the
526 * VAConfigAttribValEncJPEG union.
528 VAConfigAttribEncJPEG = 20,
530 * \brief Encoding quality range attribute. Read-only.
532 * This attribute conveys whether the driver supports different quality level settings
533 * for encoding. A value less than or equal to 1 means that the encoder only has a single
534 * quality setting, and a value greater than 1 represents the number of quality levels
535 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
537 VAConfigAttribEncQualityRange = 21,
539 * \brief Encoding skip frame attribute. Read-only.
541 * This attribute conveys whether the driver supports sending skip frame parameters
542 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
543 * externally skipped frames.
545 VAConfigAttribEncSkipFrame = 24,
547 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
549 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
550 * based on user provided ROI rectangles. The attribute value is partitioned into fields
551 * as defined in the VAConfigAttribValEncROI union.
553 * If ROI encoding is supported, the ROI information is passed to the driver using
554 * VAEncMiscParameterTypeROI.
556 VAConfigAttribEncROI = 25,
558 * \brief Encoding extended rate control attribute. Read-only.
560 * This attribute conveys whether the driver supports any extended rate control features
561 * The attribute value is partitioned into fields as defined in the
562 * VAConfigAttribValEncRateControlExt union.
564 VAConfigAttribEncRateControlExt = 26,
567 * \brief Encode function type for FEI.
569 * This attribute conveys whether the driver supports different function types for encode.
570 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
571 * it is for FEI entry point only.
572 * Default is VA_FEI_FUNCTION_ENC_PAK.
574 VAConfigAttribFEIFunctionType = 32,
576 * \brief Maximum number of FEI MV predictors. Read-only.
578 * This attribute determines the maximum number of MV predictors the driver
579 * can support to encode a single frame. 0 means no MV predictor is supported.
580 * Currently it is for FEI entry point only.
582 VAConfigAttribFEIMVPredictors = 33,
584 VAConfigAttribTypeMax
585 } VAConfigAttribType;
588 * Configuration attributes
589 * If there is more than one value for an attribute, a default
590 * value will be assigned to the attribute if the client does not
591 * specify the attribute when creating a configuration
593 typedef struct _VAConfigAttrib {
594 VAConfigAttribType type;
595 uint32_t value; /* OR'd flags (bits) for this attribute */
598 /** attribute value for VAConfigAttribRTFormat */
599 #define VA_RT_FORMAT_YUV420 0x00000001
600 #define VA_RT_FORMAT_YUV422 0x00000002
601 #define VA_RT_FORMAT_YUV444 0x00000004
602 #define VA_RT_FORMAT_YUV411 0x00000008
603 #define VA_RT_FORMAT_YUV400 0x00000010
604 /** YUV formats with more than 8 bpp */
605 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
607 #define VA_RT_FORMAT_RGB16 0x00010000
608 #define VA_RT_FORMAT_RGB32 0x00020000
609 /* RGBP covers RGBP and BGRP fourcc */
610 #define VA_RT_FORMAT_RGBP 0x00100000
611 #define VA_RT_FORMAT_PROTECTED 0x80000000
613 /** @name Attribute values for VAConfigAttribRateControl */
615 /** \brief Driver does not support any form of rate control. */
616 #define VA_RC_NONE 0x00000001
617 /** \brief Constant bitrate. */
618 #define VA_RC_CBR 0x00000002
619 /** \brief Variable bitrate. */
620 #define VA_RC_VBR 0x00000004
621 /** \brief Video conference mode. */
622 #define VA_RC_VCM 0x00000008
623 /** \brief Constant QP. */
624 #define VA_RC_CQP 0x00000010
625 /** \brief Variable bitrate with peak rate higher than average bitrate. */
626 #define VA_RC_VBR_CONSTRAINED 0x00000020
627 /** \brief Macroblock based rate control. Per MB control is decided
628 * internally in the encoder. It may be combined with other RC modes, except CQP. */
629 #define VA_RC_MB 0x00000080
633 /** @name Attribute values for VAConfigAttribDecSliceMode */
635 /** \brief Driver supports normal mode for slice decoding */
636 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
637 /** \brief Driver supports base mode for slice decoding */
638 #define VA_DEC_SLICE_MODE_BASE 0x00000002
640 /** @name Attribute values for VAConfigAttribDecJPEG */
642 typedef union _VAConfigAttribValDecJPEG {
644 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
645 uint32_t rotation : 4;
646 /** \brief Reserved for future use. */
647 uint32_t reserved : 28;
650 uint32_t va_reserved[VA_PADDING_LOW];
651 } VAConfigAttribValDecJPEG;
654 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
656 /** \brief Driver does not support any packed headers mode. */
657 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
659 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
661 * Application must provide it to driver once this flag is returned through
662 * vaGetConfigAttributes()
664 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
666 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
668 * Application must provide it to driver once this falg is returned through
669 * vaGetConfigAttributes()
671 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
673 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
675 * Application must provide it to driver once this flag is returned through
676 * vaGetConfigAttributes()
678 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
680 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
683 * This is a deprecated packed header flag, All applications can use
684 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
685 * header data buffer to the driver
687 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
688 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
689 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
692 /** @name Attribute values for VAConfigAttribEncInterlaced */
694 /** \brief Driver does not support interlaced coding. */
695 #define VA_ENC_INTERLACED_NONE 0x00000000
696 /** \brief Driver supports interlaced frame coding. */
697 #define VA_ENC_INTERLACED_FRAME 0x00000001
698 /** \brief Driver supports interlaced field coding. */
699 #define VA_ENC_INTERLACED_FIELD 0x00000002
700 /** \brief Driver supports macroblock adaptive frame field coding. */
701 #define VA_ENC_INTERLACED_MBAFF 0x00000004
702 /** \brief Driver supports picture adaptive frame field coding. */
703 #define VA_ENC_INTERLACED_PAFF 0x00000008
706 /** @name Attribute values for VAConfigAttribEncSliceStructure */
708 /** \brief Driver supports a power-of-two number of rows per slice. */
709 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
710 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
711 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
712 /** \brief Dirver support 1 rows per slice */
713 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
714 /** \brief Dirver support max encoded slice size per slice */
715 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
716 /** \brief Driver supports an arbitrary number of rows per slice. */
717 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
720 /** \brief Attribute value for VAConfigAttribEncJPEG */
721 typedef union _VAConfigAttribValEncJPEG {
723 /** \brief set to 1 for arithmatic coding. */
724 uint32_t arithmatic_coding_mode : 1;
725 /** \brief set to 1 for progressive dct. */
726 uint32_t progressive_dct_mode : 1;
727 /** \brief set to 1 for non-interleaved. */
728 uint32_t non_interleaved_mode : 1;
729 /** \brief set to 1 for differential. */
730 uint32_t differential_mode : 1;
731 uint32_t max_num_components : 3;
732 uint32_t max_num_scans : 4;
733 uint32_t max_num_huffman_tables : 3;
734 uint32_t max_num_quantization_tables : 3;
737 } VAConfigAttribValEncJPEG;
739 /** \brief Attribute value for VAConfigAttribEncROI */
740 typedef union _VAConfigAttribValEncROI {
742 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
743 uint32_t num_roi_regions : 8;
745 * \brief A flag indicates whether ROI priority is supported
747 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
748 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
749 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
750 * the underlying driver doesn't support ROI priority.
752 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
753 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
755 uint32_t roi_rc_priority_support : 1;
757 * \brief A flag indicates whether ROI delta QP is supported
759 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
760 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
761 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
762 * the underlying driver doesn't support ROI delta QP.
764 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
765 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
767 uint32_t roi_rc_qp_delta_support : 1;
768 uint32_t reserved : 22;
771 } VAConfigAttribValEncROI;
773 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
774 typedef union _VAConfigAttribValEncRateControlExt {
777 * \brief The maximum number of temporal layers minus 1
779 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
780 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
781 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
783 uint32_t max_num_temporal_layers_minus1 : 8;
786 * /brief support temporal layer bit-rate control flag
788 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
789 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
790 * #VAConfigAttribRateControl == #VA_RC_VBR).
792 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
793 * \c max_num_temporal_layers_minus1 is equal to 0
795 * To use bit-rate control per temporal layer, an application must send the right layer
796 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
797 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
798 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
799 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
800 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
801 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
802 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
804 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
805 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
806 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
808 uint32_t temporal_layer_bitrate_control_flag : 1;
809 uint32_t reserved : 23;
812 } VAConfigAttribValEncRateControlExt;
815 * if an attribute is not applicable for a given
816 * profile/entrypoint pair, then set the value to the following
818 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
820 /** Get maximum number of profiles supported by the implementation */
821 int vaMaxNumProfiles (
825 /** Get maximum number of entrypoints supported by the implementation */
826 int vaMaxNumEntrypoints (
830 /** Get maximum number of attributs supported by the implementation */
831 int vaMaxNumConfigAttributes (
836 * Query supported profiles
837 * The caller must provide a "profile_list" array that can hold at
838 * least vaMaxNumProfile() entries. The actual number of profiles
839 * returned in "profile_list" is returned in "num_profile".
841 VAStatus vaQueryConfigProfiles (
843 VAProfile *profile_list, /* out */
844 int *num_profiles /* out */
848 * Query supported entrypoints for a given profile
849 * The caller must provide an "entrypoint_list" array that can hold at
850 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
851 * returned in "entrypoint_list" is returned in "num_entrypoints".
853 VAStatus vaQueryConfigEntrypoints (
856 VAEntrypoint *entrypoint_list, /* out */
857 int *num_entrypoints /* out */
861 * Get attributes for a given profile/entrypoint pair
862 * The caller must provide an "attrib_list" with all attributes to be
863 * retrieved. Upon return, the attributes in "attrib_list" have been
864 * updated with their value. Unknown attributes or attributes that are
865 * not supported for the given profile/entrypoint pair will have their
866 * value set to VA_ATTRIB_NOT_SUPPORTED
868 VAStatus vaGetConfigAttributes (
871 VAEntrypoint entrypoint,
872 VAConfigAttrib *attrib_list, /* in/out */
876 /** Generic ID type, can be re-typed for specific implementation */
877 typedef unsigned int VAGenericID;
879 typedef VAGenericID VAConfigID;
882 * Create a configuration for the video decode/encode/processing pipeline
883 * it passes in the attribute list that specifies the attributes it cares
884 * about, with the rest taking default values.
886 VAStatus vaCreateConfig (
889 VAEntrypoint entrypoint,
890 VAConfigAttrib *attrib_list,
892 VAConfigID *config_id /* out */
896 * Free resources associdated with a given config
898 VAStatus vaDestroyConfig (
904 * Query all attributes for a given configuration
905 * The profile of the configuration is returned in "profile"
906 * The entrypoint of the configuration is returned in "entrypoint"
907 * The caller must provide an "attrib_list" array that can hold at least
908 * vaMaxNumConfigAttributes() entries. The actual number of attributes
909 * returned in "attrib_list" is returned in "num_attribs"
911 VAStatus vaQueryConfigAttributes (
913 VAConfigID config_id,
914 VAProfile *profile, /* out */
915 VAEntrypoint *entrypoint, /* out */
916 VAConfigAttrib *attrib_list,/* out */
917 int *num_attribs /* out */
922 * Contexts and Surfaces
924 * Context represents a "virtual" video decode, encode or video processing
925 * pipeline. Surfaces are render targets for a given context. The data in the
926 * surfaces are not accessible to the client except if derived image is supported
927 * and the internal data format of the surface is implementation specific.
929 * Surfaces are provided as a hint of what surfaces will be used when the context
930 * is created through vaCreateContext(). A surface may be used by different contexts
931 * at the same time as soon as application can make sure the operations are synchronized
932 * between different contexts, e.g. a surface is used as the output of a decode context
933 * and the input of a video process context. Surfaces can only be destroyed after all
934 * contexts using these surfaces have been destroyed.
936 * Both contexts and surfaces are identified by unique IDs and its
937 * implementation specific internals are kept opaque to the clients
940 typedef VAGenericID VAContextID;
942 typedef VAGenericID VASurfaceID;
944 #define VA_INVALID_ID 0xffffffff
945 #define VA_INVALID_SURFACE VA_INVALID_ID
947 /** \brief Generic value types. */
949 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
950 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
951 VAGenericValueTypePointer, /**< Generic pointer type */
952 VAGenericValueTypeFunc /**< Pointer to function */
953 } VAGenericValueType;
955 /** \brief Generic function type. */
956 typedef void (*VAGenericFunc)(void);
958 /** \brief Generic value. */
959 typedef struct _VAGenericValue {
960 /** \brief Value type. See #VAGenericValueType. */
961 VAGenericValueType type;
962 /** \brief Value holder. */
964 /** \brief 32-bit signed integer. */
966 /** \brief 32-bit float. */
968 /** \brief Generic pointer. */
970 /** \brief Pointer to function. */
975 /** @name Surface attribute flags */
977 /** \brief Surface attribute is not supported. */
978 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
979 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
980 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
981 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
982 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
985 /** \brief Surface attribute types. */
987 VASurfaceAttribNone = 0,
989 * \brief Pixel format (fourcc).
991 * The value is meaningful as input to vaQuerySurfaceAttributes().
992 * If zero, the driver returns the optimal pixel format for the
993 * specified config. Otherwise, if non-zero, the value represents
994 * a pixel format (FOURCC) that is kept as is on output, if the
995 * driver supports it. Otherwise, the driver sets the value to
996 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
998 VASurfaceAttribPixelFormat,
999 /** \brief Minimal width in pixels (int, read-only). */
1000 VASurfaceAttribMinWidth,
1001 /** \brief Maximal width in pixels (int, read-only). */
1002 VASurfaceAttribMaxWidth,
1003 /** \brief Minimal height in pixels (int, read-only). */
1004 VASurfaceAttribMinHeight,
1005 /** \brief Maximal height in pixels (int, read-only). */
1006 VASurfaceAttribMaxHeight,
1007 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1008 VASurfaceAttribMemoryType,
1009 /** \brief External buffer descriptor (pointer, write). */
1010 VASurfaceAttribExternalBufferDescriptor,
1011 /** \brief Surface usage hint, gives the driver a hint of intended usage
1012 * to optimize allocation (e.g. tiling) (int, read/write). */
1013 VASurfaceAttribUsageHint,
1014 /** \brief Number of surface attributes. */
1015 VASurfaceAttribCount
1016 } VASurfaceAttribType;
1018 /** \brief Surface attribute. */
1019 typedef struct _VASurfaceAttrib {
1021 VASurfaceAttribType type;
1022 /** \brief Flags. See "Surface attribute flags". */
1024 /** \brief Value. See "Surface attribute types" for the expected types. */
1025 VAGenericValue value;
1029 * @name VASurfaceAttribMemoryType values in bit fields.
1030 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1031 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1032 * types are defined in DRM and Android header files.
1035 /** \brief VA memory type (default) is supported. */
1036 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1037 /** \brief V4L2 buffer memory type is supported. */
1038 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1039 /** \brief User pointer memory type is supported. */
1040 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1044 * \brief VASurfaceAttribExternalBuffers structure for
1045 * the VASurfaceAttribExternalBufferDescriptor attribute.
1047 typedef struct _VASurfaceAttribExternalBuffers {
1048 /** \brief pixel format in fourcc. */
1049 uint32_t pixel_format;
1050 /** \brief width in pixels. */
1052 /** \brief height in pixels. */
1054 /** \brief total size of the buffer in bytes. */
1056 /** \brief number of planes for planar layout */
1057 uint32_t num_planes;
1058 /** \brief pitch for each plane in bytes */
1059 uint32_t pitches[4];
1060 /** \brief offset for each plane in bytes */
1061 uint32_t offsets[4];
1062 /** \brief buffer handles or user pointers */
1064 /** \brief number of elements in the "buffers" array */
1065 uint32_t num_buffers;
1066 /** \brief flags. See "Surface external buffer descriptor flags". */
1068 /** \brief reserved for passing private data */
1070 } VASurfaceAttribExternalBuffers;
1072 /** @name VASurfaceAttribExternalBuffers flags */
1074 /** \brief Enable memory tiling */
1075 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1076 /** \brief Memory is cacheable */
1077 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1078 /** \brief Memory is non-cacheable */
1079 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1080 /** \brief Memory is write-combined */
1081 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1082 /** \brief Memory is protected */
1083 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1085 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1087 /** \brief Surface usage not indicated. */
1088 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1089 /** \brief Surface used by video decoder. */
1090 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1091 /** \brief Surface used by video encoder. */
1092 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1093 /** \brief Surface read by video post-processing. */
1094 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1095 /** \brief Surface written by video post-processing. */
1096 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1097 /** \brief Surface used for display. */
1098 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1103 * \brief Queries surface attributes for the supplied config.
1105 * This function queries for all supported attributes for the
1106 * supplied VA @config. In particular, if the underlying hardware
1107 * supports the creation of VA surfaces in various formats, then
1108 * this function will enumerate all pixel formats that are supported.
1110 * The \c attrib_list array is allocated by the user and \c
1111 * num_attribs shall be initialized to the number of allocated
1112 * elements in that array. Upon successful return, the actual number
1113 * of attributes will be overwritten into \c num_attribs. Otherwise,
1114 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1115 * is adjusted to the number of elements that would be returned if
1116 * enough space was available.
1118 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1119 * argument when vaQuerySurfaceAttributes() is used to determine the
1120 * actual number of elements that need to be allocated.
1122 * @param[in] dpy the VA display
1123 * @param[in] config the config identifying a codec or a video
1124 * processing pipeline
1125 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1126 * @param[in,out] num_attribs the number of elements allocated on
1127 * input, the number of elements actually filled in output
1130 vaQuerySurfaceAttributes(
1133 VASurfaceAttrib *attrib_list,
1134 unsigned int *num_attribs
1138 * \brief Creates an array of surfaces
1140 * Creates an array of surfaces. The optional list of attributes shall
1141 * be constructed based on what the underlying hardware could expose
1142 * through vaQuerySurfaceAttributes().
1144 * @param[in] dpy the VA display
1145 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1146 * @param[in] width the surface width
1147 * @param[in] height the surface height
1148 * @param[out] surfaces the array of newly created surfaces
1149 * @param[in] num_surfaces the number of surfaces to create
1150 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1151 * @param[in] num_attribs the number of attributes supplied in
1152 * \c attrib_list, or zero
1157 unsigned int format,
1159 unsigned int height,
1160 VASurfaceID *surfaces,
1161 unsigned int num_surfaces,
1162 VASurfaceAttrib *attrib_list,
1163 unsigned int num_attribs
1167 * vaDestroySurfaces - Destroy resources associated with surfaces.
1168 * Surfaces can only be destroyed after all contexts using these surfaces have been
1171 * surfaces: array of surfaces to destroy
1172 * num_surfaces: number of surfaces in the array to be destroyed.
1174 VAStatus vaDestroySurfaces (
1176 VASurfaceID *surfaces,
1180 #define VA_PROGRESSIVE 0x1
1182 * vaCreateContext - Create a context
1184 * config_id: configuration for the context
1185 * picture_width: coded picture width
1186 * picture_height: coded picture height
1187 * flag: any combination of the following:
1188 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1189 * render_targets: a hint for render targets (surfaces) tied to the context
1190 * num_render_targets: number of render targets in the above array
1191 * context: created context id upon return
1193 VAStatus vaCreateContext (
1195 VAConfigID config_id,
1199 VASurfaceID *render_targets,
1200 int num_render_targets,
1201 VAContextID *context /* out */
1205 * vaDestroyContext - Destroy a context
1207 * context: context to be destroyed
1209 VAStatus vaDestroyContext (
1214 //Multi-frame context
1215 typedef VAGenericID VAMFContextID;
1217 * vaCreateMFContext - Create a multi-frame context
1218 * interface encapsulating common for all streams memory objects and structures
1219 * required for single GPU task submission from several VAContextID's.
1220 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1221 * Support identification: Application can identify multi-frame feature support by ability
1222 * to create multi-frame context. If driver supports multi-frame - call successful,
1223 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1224 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1226 * VA_STATUS_SUCCESS - operation successful.
1227 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1228 * dpy: display adapter.
1229 * mf_context: Multi-Frame context encapsulating all associated context
1230 * for multi-frame submission.
1232 VAStatus vaCreateMFContext (
1234 VAMFContextID *mf_context /* out */
1238 * vaMFAddContext - Provide ability to associate each context used for
1239 * Multi-Frame submission and common Multi-Frame context.
1240 * Try to add context to understand if it is supported.
1241 * Allocation: this call allocates and/or reallocates all memory objects
1242 * common for all contexts associated with particular Multi-Frame context.
1243 * All memory required for each context(pixel buffers, internal driver
1244 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1245 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1246 * first context added will set entry point/profile for whole Multi-Frame context,
1247 * all other entry points and profiles can be rejected to be added.
1249 * VA_STATUS_SUCCESS - operation successful, context was added.
1250 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1251 * current mf_context and associated contexts and start working with new ones.
1252 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1253 * 1 - mf_context is not valid context or
1254 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1255 * and current context contradicts with previously added, application can continue with current mf_context
1256 * and other contexts passed this call, rejected context can continue work in stand-alone
1257 * mode or other mf_context.
1258 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1259 * unsupported VAEntrypoint. Application can continue with current mf_context
1260 * and other contexts passed this call, rejected context can continue work in stand-alone
1262 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1263 * but VAProfile is not supported. Application can continue with current mf_context
1264 * and other contexts passed this call, rejected context can continue work in stand-alone
1266 * dpy: display adapter.
1267 * context: context being associated with Multi-Frame context.
1268 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1270 VAStatus vaMFAddContext (
1272 VAMFContextID mf_context,
1277 * vaMFReleaseContext - Removes context from multi-frame and
1278 * association with multi-frame context.
1279 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1281 * VA_STATUS_SUCCESS - operation successful, context was removed.
1282 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1283 * application need to destroy this VAMFContextID and all assotiated VAContextID
1285 * mf_context: VAMFContextID where context is added
1286 * context: VAContextID to be added
1288 VAStatus vaMFReleaseContext (
1290 VAMFContextID mf_context,
1296 * Buffers are used to pass various types of data from the
1297 * client to the server. The server maintains a data store
1298 * for each buffer created, and the client idenfies a buffer
1299 * through a unique buffer id assigned by the server.
1302 typedef VAGenericID VABufferID;
1306 VAPictureParameterBufferType = 0,
1307 VAIQMatrixBufferType = 1,
1308 VABitPlaneBufferType = 2,
1309 VASliceGroupMapBufferType = 3,
1310 VASliceParameterBufferType = 4,
1311 VASliceDataBufferType = 5,
1312 VAMacroblockParameterBufferType = 6,
1313 VAResidualDataBufferType = 7,
1314 VADeblockingParameterBufferType = 8,
1315 VAImageBufferType = 9,
1316 VAProtectedSliceDataBufferType = 10,
1317 VAQMatrixBufferType = 11,
1318 VAHuffmanTableBufferType = 12,
1319 VAProbabilityBufferType = 13,
1321 /* Following are encode buffer types */
1322 VAEncCodedBufferType = 21,
1323 VAEncSequenceParameterBufferType = 22,
1324 VAEncPictureParameterBufferType = 23,
1325 VAEncSliceParameterBufferType = 24,
1326 VAEncPackedHeaderParameterBufferType = 25,
1327 VAEncPackedHeaderDataBufferType = 26,
1328 VAEncMiscParameterBufferType = 27,
1329 VAEncMacroblockParameterBufferType = 28,
1330 VAEncMacroblockMapBufferType = 29,
1333 * \brief Encoding QP buffer
1335 * This buffer contains QP per MB for encoding. Currently
1336 * VAEncQPBufferH264 is defined for H.264 encoding, see
1337 * #VAEncQPBufferH264 for details
1339 VAEncQPBufferType = 30,
1340 /* Following are video processing buffer types */
1342 * \brief Video processing pipeline parameter buffer.
1344 * This buffer describes the video processing pipeline. See
1345 * #VAProcPipelineParameterBuffer for details.
1347 VAProcPipelineParameterBufferType = 41,
1349 * \brief Video filter parameter buffer.
1351 * This buffer describes the video filter parameters. All buffers
1352 * inherit from #VAProcFilterParameterBufferBase, thus including
1353 * a unique filter buffer type.
1355 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1356 * Filters requiring advanced parameters include, but are not limited to,
1357 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1358 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1360 VAProcFilterParameterBufferType = 42,
1362 * \brief FEI specific buffer types
1364 VAEncFEIMVBufferType = 43,
1365 VAEncFEIMBCodeBufferType = 44,
1366 VAEncFEIDistortionBufferType = 45,
1367 VAEncFEIMBControlBufferType = 46,
1368 VAEncFEIMVPredictorBufferType = 47,
1374 VAEncMiscParameterTypeFrameRate = 0,
1375 VAEncMiscParameterTypeRateControl = 1,
1376 VAEncMiscParameterTypeMaxSliceSize = 2,
1377 VAEncMiscParameterTypeAIR = 3,
1378 /** \brief Buffer type used to express a maximum frame size (in bits). */
1379 VAEncMiscParameterTypeMaxFrameSize = 4,
1380 /** \brief Buffer type used for HRD parameters. */
1381 VAEncMiscParameterTypeHRD = 5,
1382 VAEncMiscParameterTypeQualityLevel = 6,
1383 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1384 * rate control, when the user has externally skipped frames. */
1385 VAEncMiscParameterTypeSkipFrame = 9,
1386 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1387 VAEncMiscParameterTypeROI = 10,
1388 /** \brief Buffer type used for temporal layer structure */
1389 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1390 /** \brief Buffer type used for FEI input frame level parameters */
1391 VAEncMiscParameterTypeFEIFrameControl = 18,
1392 } VAEncMiscParameterType;
1394 /** \brief Packed header type. */
1396 /** \brief Packed sequence header. */
1397 VAEncPackedHeaderSequence = 1,
1398 /** \brief Packed picture header. */
1399 VAEncPackedHeaderPicture = 2,
1400 /** \brief Packed slice header. */
1401 VAEncPackedHeaderSlice = 3,
1403 * \brief Packed raw header.
1405 * Packed raw data header can be used by the client to insert a header
1406 * into the bitstream data buffer at the point it is passed, the driver
1407 * will handle the raw packed header based on "has_emulation_bytes" field
1408 * in the packed header parameter structure.
1410 VAEncPackedHeaderRawData = 4,
1412 * \brief Misc packed header. See codec-specific definitions.
1415 * This is a deprecated packed header type. All applications can use
1416 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1418 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1419 } VAEncPackedHeaderType;
1421 /** \brief Packed header parameter. */
1422 typedef struct _VAEncPackedHeaderParameterBuffer {
1423 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1425 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1426 uint32_t bit_length;
1427 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1428 uint8_t has_emulation_bytes;
1430 /** \brief Reserved bytes for future use, must be zero */
1431 uint32_t va_reserved[VA_PADDING_LOW];
1432 } VAEncPackedHeaderParameterBuffer;
1435 * For application, e.g. set a new bitrate
1436 * VABufferID buf_id;
1437 * VAEncMiscParameterBuffer *misc_param;
1438 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1440 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1441 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1442 * 1, NULL, &buf_id);
1444 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1445 * misc_param->type = VAEncMiscParameterTypeRateControl;
1446 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1447 * misc_rate_ctrl->bits_per_second = 6400000;
1448 * vaUnmapBuffer(dpy, buf_id);
1449 * vaRenderPicture(dpy, context, &buf_id, 1);
1451 typedef struct _VAEncMiscParameterBuffer
1453 VAEncMiscParameterType type;
1455 } VAEncMiscParameterBuffer;
1457 /** \brief Temporal layer Structure*/
1458 typedef struct _VAEncMiscParameterTemporalLayerStructure
1460 /** \brief The number of temporal layers */
1461 uint32_t number_of_layers;
1462 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1463 uint32_t periodicity;
1465 * \brief The array indicating the layer id for each frame
1467 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1468 * ids for frames starting from the 2nd frame.
1470 uint32_t layer_id[32];
1472 /** \brief Reserved bytes for future use, must be zero */
1473 uint32_t va_reserved[VA_PADDING_LOW];
1474 } VAEncMiscParameterTemporalLayerStructure;
1477 /** \brief Rate control parameters */
1478 typedef struct _VAEncMiscParameterRateControl
1480 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1481 uint32_t bits_per_second;
1482 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1483 * bit-rate for example if target_percentage is 95 then the rate control will target
1484 * a bit-rate that is 95% of the maximum bit-rate
1486 uint32_t target_percentage;
1487 /* windows size in milliseconds. For example if this is set to 500,
1488 * then the rate control will guarantee the target bit-rate over a 500 ms window
1490 uint32_t window_size;
1491 /* initial QP at I frames */
1492 uint32_t initial_qp;
1494 uint32_t basic_unit_size;
1500 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1501 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1502 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1504 * The temporal layer that the rate control parameters are specified for.
1506 uint32_t temporal_id : 8;
1507 /** \brief Reserved for future use, must be zero */
1508 uint32_t reserved : 17;
1513 /** \brief Reserved bytes for future use, must be zero */
1514 uint32_t va_reserved[VA_PADDING_MEDIUM];
1515 } VAEncMiscParameterRateControl;
1517 typedef struct _VAEncMiscParameterFrameRate
1520 * The framerate is specified as a number of frames per second, as a
1521 * fraction. The denominator of the fraction is given in the top half
1522 * (the high two bytes) of the framerate field, and the numerator is
1523 * given in the bottom half (the low two bytes).
1526 * denominator = framerate >> 16 & 0xffff;
1527 * numerator = framerate & 0xffff;
1528 * fps = numerator / denominator;
1530 * For example, if framerate is set to (100 << 16 | 750), this is
1531 * 750 / 100, hence 7.5fps.
1533 * If the denominator is zero (the high two bytes are both zero) then
1534 * it takes the value one instead, so the framerate is just the integer
1535 * in the low 2 bytes.
1543 * The temporal id the framerate parameters are specified for.
1545 uint32_t temporal_id : 8;
1546 uint32_t reserved : 24;
1551 /** \brief Reserved bytes for future use, must be zero */
1552 uint32_t va_reserved[VA_PADDING_LOW];
1553 } VAEncMiscParameterFrameRate;
1556 * Allow a maximum slice size to be specified (in bits).
1557 * The encoder will attempt to make sure that individual slices do not exceed this size
1558 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1560 typedef struct _VAEncMiscParameterMaxSliceSize
1562 uint32_t max_slice_size;
1564 /** \brief Reserved bytes for future use, must be zero */
1565 uint32_t va_reserved[VA_PADDING_LOW];
1566 } VAEncMiscParameterMaxSliceSize;
1568 typedef struct _VAEncMiscParameterAIR
1570 uint32_t air_num_mbs;
1571 uint32_t air_threshold;
1572 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1574 /** \brief Reserved bytes for future use, must be zero */
1575 uint32_t va_reserved[VA_PADDING_LOW];
1576 } VAEncMiscParameterAIR;
1578 typedef struct _VAEncMiscParameterHRD
1580 uint32_t initial_buffer_fullness; /* in bits */
1581 uint32_t buffer_size; /* in bits */
1583 /** \brief Reserved bytes for future use, must be zero */
1584 uint32_t va_reserved[VA_PADDING_LOW];
1585 } VAEncMiscParameterHRD;
1588 * \brief Defines a maximum frame size (in bits).
1590 * This misc parameter buffer defines the maximum size of a frame (in
1591 * bits). The encoder will try to make sure that each frame does not
1592 * exceed this size. Otherwise, if the frame size exceeds this size,
1593 * the \c status flag of #VACodedBufferSegment will contain
1594 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1596 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1597 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1598 VAEncMiscParameterType type;
1599 /** \brief Maximum size of a frame (in bits). */
1600 uint32_t max_frame_size;
1602 /** \brief Reserved bytes for future use, must be zero */
1603 uint32_t va_reserved[VA_PADDING_LOW];
1604 } VAEncMiscParameterBufferMaxFrameSize;
1607 * \brief Encoding quality level.
1609 * The encoding quality could be set through this structure, if the implementation
1610 * supports multiple quality levels. The quality level set through this structure is
1611 * persistent over the entire coded sequence, or until a new structure is being sent.
1612 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1613 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1614 * quality. The quality level setting is used as a trade-off between quality and speed/power
1615 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1617 typedef struct _VAEncMiscParameterBufferQualityLevel {
1618 /** \brief Encoding quality level setting. When set to 0, default quality
1621 uint32_t quality_level;
1623 /** \brief Reserved bytes for future use, must be zero */
1624 uint32_t va_reserved[VA_PADDING_LOW];
1625 } VAEncMiscParameterBufferQualityLevel;
1628 * \brief Encoding skip frame.
1630 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1631 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1632 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1633 * current frame. It is allowed for the application to still send in packed headers for the driver to
1634 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1636 typedef struct _VAEncMiscParameterSkipFrame {
1637 /** \brief Indicates skip frames as below.
1638 * 0: Encode as normal, no skip.
1639 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1640 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1641 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1642 * in VAEncPackedHeaderPicture). */
1643 uint8_t skip_frame_flag;
1644 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1645 uint8_t num_skip_frames;
1646 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1647 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1648 uint32_t size_skip_frames;
1650 /** \brief Reserved bytes for future use, must be zero */
1651 uint32_t va_reserved[VA_PADDING_LOW];
1652 } VAEncMiscParameterSkipFrame;
1655 * \brief Encoding region-of-interest (ROI).
1657 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1658 * supports ROI input. The ROI set through this structure is applicable only to the
1659 * current frame or field, so must be sent every frame or field to be applied. The number of
1660 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1661 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1663 typedef struct _VAEncROI
1665 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1666 * codec coding units. It is relative to frame coordinates for the frame case and
1667 * to field coordinates for the field case. */
1668 VARectangle roi_rectangle;
1672 * \ref roi_value specifies ROI delta QP or ROI priority.
1673 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1674 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1675 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1676 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1677 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1678 * regions, the roi_value that is first in the ROI array will have priority.
1680 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1681 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1683 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1684 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1685 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1690 typedef struct _VAEncMiscParameterBufferROI {
1691 /** \brief Number of ROIs being sent.*/
1694 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1695 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1697 int8_t max_delta_qp;
1698 int8_t min_delta_qp;
1700 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1701 * coordinates for the frame case and to field coordinates for the field case.*/
1706 * \brief An indication for roi value.
1708 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1709 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1710 * in #VAEncROI should be used as ROI priority.
1712 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1713 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
1714 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1715 * when VAConfigAttribRateControl == VA_RC_CQP.
1717 uint32_t roi_value_is_qp_delta : 1;
1718 uint32_t reserved : 31;
1723 /** \brief Reserved bytes for future use, must be zero */
1724 uint32_t va_reserved[VA_PADDING_LOW];
1725 } VAEncMiscParameterBufferROI;
1728 * There will be cases where the bitstream buffer will not have enough room to hold
1729 * the data for the entire slice, and the following flags will be used in the slice
1730 * parameter to signal to the server for the possible cases.
1731 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1732 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1733 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1735 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1736 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1737 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1738 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1740 /* Codec-independent Slice Parameter Buffer base */
1741 typedef struct _VASliceParameterBufferBase
1743 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
1744 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
1745 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1746 } VASliceParameterBufferBase;
1748 /**********************************
1749 * JPEG common data structures
1750 **********************************/
1752 * \brief Huffman table for JPEG decoding.
1754 * This structure holds the complete Huffman tables. This is an
1755 * aggregation of all Huffman table (DHT) segments maintained by the
1756 * application. i.e. up to 2 Huffman tables are stored in there for
1759 * The #load_huffman_table array can be used as a hint to notify the
1760 * VA driver implementation about which table(s) actually changed
1761 * since the last submission of this buffer.
1763 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1764 /** \brief Specifies which #huffman_table is valid. */
1765 uint8_t load_huffman_table[2];
1766 /** \brief Huffman tables indexed by table identifier (Th). */
1768 /** @name DC table (up to 12 categories) */
1770 /** \brief Number of Huffman codes of length i + 1 (Li). */
1771 uint8_t num_dc_codes[16];
1772 /** \brief Value associated with each Huffman code (Vij). */
1773 uint8_t dc_values[12];
1775 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1777 /** \brief Number of Huffman codes of length i + 1 (Li). */
1778 uint8_t num_ac_codes[16];
1779 /** \brief Value associated with each Huffman code (Vij). */
1780 uint8_t ac_values[162];
1781 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1786 /** \brief Reserved bytes for future use, must be zero */
1787 uint32_t va_reserved[VA_PADDING_LOW];
1788 } VAHuffmanTableBufferJPEGBaseline;
1790 /****************************
1791 * MPEG-2 data structures
1792 ****************************/
1794 /* MPEG-2 Picture Parameter Buffer */
1796 * For each frame or field, and before any slice data, a single
1797 * picture parameter buffer must be send.
1799 typedef struct _VAPictureParameterBufferMPEG2
1801 uint16_t horizontal_size;
1802 uint16_t vertical_size;
1803 VASurfaceID forward_reference_picture;
1804 VASurfaceID backward_reference_picture;
1805 /* meanings of the following fields are the same as in the standard */
1806 int32_t picture_coding_type;
1807 int32_t f_code; /* pack all four fcode into this */
1810 uint32_t intra_dc_precision : 2;
1811 uint32_t picture_structure : 2;
1812 uint32_t top_field_first : 1;
1813 uint32_t frame_pred_frame_dct : 1;
1814 uint32_t concealment_motion_vectors : 1;
1815 uint32_t q_scale_type : 1;
1816 uint32_t intra_vlc_format : 1;
1817 uint32_t alternate_scan : 1;
1818 uint32_t repeat_first_field : 1;
1819 uint32_t progressive_frame : 1;
1820 uint32_t is_first_field : 1; /* indicate whether the current field
1821 * is the first field for field picture
1825 } picture_coding_extension;
1827 /** \brief Reserved bytes for future use, must be zero */
1828 uint32_t va_reserved[VA_PADDING_LOW];
1829 } VAPictureParameterBufferMPEG2;
1831 /** MPEG-2 Inverse Quantization Matrix Buffer */
1832 typedef struct _VAIQMatrixBufferMPEG2
1834 /** \brief Same as the MPEG-2 bitstream syntax element. */
1835 int32_t load_intra_quantiser_matrix;
1836 /** \brief Same as the MPEG-2 bitstream syntax element. */
1837 int32_t load_non_intra_quantiser_matrix;
1838 /** \brief Same as the MPEG-2 bitstream syntax element. */
1839 int32_t load_chroma_intra_quantiser_matrix;
1840 /** \brief Same as the MPEG-2 bitstream syntax element. */
1841 int32_t load_chroma_non_intra_quantiser_matrix;
1842 /** \brief Luminance intra matrix, in zig-zag scan order. */
1843 uint8_t intra_quantiser_matrix[64];
1844 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1845 uint8_t non_intra_quantiser_matrix[64];
1846 /** \brief Chroma intra matrix, in zig-zag scan order. */
1847 uint8_t chroma_intra_quantiser_matrix[64];
1848 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1849 uint8_t chroma_non_intra_quantiser_matrix[64];
1851 /** \brief Reserved bytes for future use, must be zero */
1852 uint32_t va_reserved[VA_PADDING_LOW];
1853 } VAIQMatrixBufferMPEG2;
1855 /** MPEG-2 Slice Parameter Buffer */
1856 typedef struct _VASliceParameterBufferMPEG2
1858 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1859 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1860 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1861 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1862 uint32_t slice_horizontal_position;
1863 uint32_t slice_vertical_position;
1864 int32_t quantiser_scale_code;
1865 int32_t intra_slice_flag;
1867 /** \brief Reserved bytes for future use, must be zero */
1868 uint32_t va_reserved[VA_PADDING_LOW];
1869 } VASliceParameterBufferMPEG2;
1871 /** MPEG-2 Macroblock Parameter Buffer */
1872 typedef struct _VAMacroblockParameterBufferMPEG2
1874 uint16_t macroblock_address;
1876 * macroblock_address (in raster scan order)
1878 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1880 uint8_t macroblock_type; /* see definition below */
1883 uint32_t frame_motion_type : 2;
1884 uint32_t field_motion_type : 2;
1885 uint32_t dct_type : 1;
1889 uint8_t motion_vertical_field_select;
1891 * motion_vertical_field_select:
1892 * see section 6.3.17.2 in the spec
1893 * only the lower 4 bits are used
1894 * bit 0: first vector forward
1895 * bit 1: first vector backward
1896 * bit 2: second vector forward
1897 * bit 3: second vector backward
1899 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
1900 uint16_t coded_block_pattern;
1902 * The bitplanes for coded_block_pattern are described
1903 * in Figure 6.10-12 in the spec
1906 /* Number of skipped macroblocks after this macroblock */
1907 uint16_t num_skipped_macroblocks;
1909 /** \brief Reserved bytes for future use, must be zero */
1910 uint32_t va_reserved[VA_PADDING_LOW];
1911 } VAMacroblockParameterBufferMPEG2;
1914 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1916 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1917 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1918 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1919 #define VA_MB_TYPE_MOTION_INTRA 0x10
1922 * MPEG-2 Residual Data Buffer
1923 * For each macroblock, there wil be 64 shorts (16-bit) in the
1924 * residual data buffer
1927 /****************************
1928 * MPEG-4 Part 2 data structures
1929 ****************************/
1931 /* MPEG-4 Picture Parameter Buffer */
1933 * For each frame or field, and before any slice data, a single
1934 * picture parameter buffer must be send.
1936 typedef struct _VAPictureParameterBufferMPEG4
1939 uint16_t vop_height;
1940 VASurfaceID forward_reference_picture;
1941 VASurfaceID backward_reference_picture;
1944 uint32_t short_video_header : 1;
1945 uint32_t chroma_format : 2;
1946 uint32_t interlaced : 1;
1947 uint32_t obmc_disable : 1;
1948 uint32_t sprite_enable : 2;
1949 uint32_t sprite_warping_accuracy : 2;
1950 uint32_t quant_type : 1;
1951 uint32_t quarter_sample : 1;
1952 uint32_t data_partitioned : 1;
1953 uint32_t reversible_vlc : 1;
1954 uint32_t resync_marker_disable : 1;
1958 uint8_t no_of_sprite_warping_points;
1959 int16_t sprite_trajectory_du[3];
1960 int16_t sprite_trajectory_dv[3];
1961 uint8_t quant_precision;
1964 uint32_t vop_coding_type : 2;
1965 uint32_t backward_reference_vop_coding_type : 2;
1966 uint32_t vop_rounding_type : 1;
1967 uint32_t intra_dc_vlc_thr : 3;
1968 uint32_t top_field_first : 1;
1969 uint32_t alternate_vertical_scan_flag : 1;
1973 uint8_t vop_fcode_forward;
1974 uint8_t vop_fcode_backward;
1975 uint16_t vop_time_increment_resolution;
1976 /* short header related */
1977 uint8_t num_gobs_in_vop;
1978 uint8_t num_macroblocks_in_gob;
1979 /* for direct mode prediction */
1983 /** \brief Reserved bytes for future use, must be zero */
1984 uint32_t va_reserved[VA_PADDING_LOW];
1985 } VAPictureParameterBufferMPEG4;
1987 /** MPEG-4 Inverse Quantization Matrix Buffer */
1988 typedef struct _VAIQMatrixBufferMPEG4
1990 /** Same as the MPEG-4:2 bitstream syntax element. */
1991 int32_t load_intra_quant_mat;
1992 /** Same as the MPEG-4:2 bitstream syntax element. */
1993 int32_t load_non_intra_quant_mat;
1994 /** The matrix for intra blocks, in zig-zag scan order. */
1995 uint8_t intra_quant_mat[64];
1996 /** The matrix for non-intra blocks, in zig-zag scan order. */
1997 uint8_t non_intra_quant_mat[64];
1999 /** \brief Reserved bytes for future use, must be zero */
2000 uint32_t va_reserved[VA_PADDING_LOW];
2001 } VAIQMatrixBufferMPEG4;
2003 /** MPEG-4 Slice Parameter Buffer */
2004 typedef struct _VASliceParameterBufferMPEG4
2006 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2007 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2008 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2009 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2010 uint32_t macroblock_number;
2011 int32_t quant_scale;
2013 /** \brief Reserved bytes for future use, must be zero */
2014 uint32_t va_reserved[VA_PADDING_LOW];
2015 } VASliceParameterBufferMPEG4;
2018 VC-1 data structures
2021 typedef enum /* see 7.1.1.32 */
2024 VAMvMode1MvHalfPel = 1,
2025 VAMvMode1MvHalfPelBilinear = 2,
2026 VAMvModeMixedMv = 3,
2027 VAMvModeIntensityCompensation = 4
2030 /** VC-1 Picture Parameter Buffer */
2032 * For each picture, and before any slice data, a picture parameter
2033 * buffer must be send. Multiple picture parameter buffers may be
2034 * sent for a single picture. In that case picture parameters will
2035 * apply to all slice data that follow it until a new picture
2036 * parameter buffer is sent.
2039 * pic_quantizer_type should be set to the applicable quantizer
2040 * type as defined by QUANTIZER (J.1.19) and either
2041 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2043 typedef struct _VAPictureParameterBufferVC1
2045 VASurfaceID forward_reference_picture;
2046 VASurfaceID backward_reference_picture;
2047 /* if out-of-loop post-processing is done on the render
2048 target, then we need to keep the in-loop decoded
2049 picture as a reference picture */
2050 VASurfaceID inloop_decoded_picture;
2052 /* sequence layer for AP or meta data for SP and MP */
2055 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2056 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2057 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2058 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2059 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2060 uint32_t multires : 1; /* METADATA::MULTIRES */
2061 uint32_t overlap : 1; /* METADATA::OVERLAP */
2062 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2063 uint32_t rangered : 1; /* METADATA::RANGERED */
2064 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2065 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2070 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2071 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2074 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2075 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2076 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2077 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2080 } entrypoint_fields;
2081 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2082 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2085 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2086 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2087 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2088 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2091 } range_mapping_fields;
2093 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2094 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2095 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2096 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2097 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2098 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2099 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2100 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2101 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2105 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2106 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2107 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2108 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2109 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2115 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2116 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2117 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2118 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2119 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2120 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2121 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2127 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2128 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2129 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2130 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2131 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2132 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2133 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2136 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2139 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2140 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2141 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2142 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2148 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2149 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2150 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2151 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2152 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2153 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2154 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2155 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2156 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2157 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2163 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2164 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2165 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2166 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2167 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2168 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2169 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2170 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2171 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2172 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2173 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2176 } pic_quantizer_fields;
2179 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2180 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2181 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2182 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2183 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2184 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2189 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2190 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2191 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2193 /** \brief Reserved bytes for future use, must be zero */
2194 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2195 } VAPictureParameterBufferVC1;
2197 /** VC-1 Bitplane Buffer
2198 There will be at most three bitplanes coded in any picture header. To send
2199 the bitplane data more efficiently, each byte is divided in two nibbles, with
2200 each nibble carrying three bitplanes for one macroblock. The following table
2201 shows the bitplane data arrangement within each nibble based on the picture
2204 Picture Type Bit3 Bit2 Bit1 Bit0
2205 I or BI OVERFLAGS ACPRED FIELDTX
2206 P MYTYPEMB SKIPMB DIRECTMB
2207 B FORWARDMB SKIPMB DIRECTMB
2209 Within each byte, the lower nibble is for the first MB and the upper nibble is
2210 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2211 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2212 Macroblock #2 in the first row.
2215 /* VC-1 Slice Parameter Buffer */
2216 typedef struct _VASliceParameterBufferVC1
2218 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2219 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2220 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2221 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2222 uint32_t slice_vertical_position;
2224 /** \brief Reserved bytes for future use, must be zero */
2225 uint32_t va_reserved[VA_PADDING_LOW];
2226 } VASliceParameterBufferVC1;
2228 /* VC-1 Slice Data Buffer */
2230 This is simplely a buffer containing raw bit-stream bytes
2233 /****************************
2234 * H.264/AVC data structures
2235 ****************************/
2237 typedef struct _VAPictureH264
2239 VASurfaceID picture_id;
2242 int32_t TopFieldOrderCnt;
2243 int32_t BottomFieldOrderCnt;
2245 /** \brief Reserved bytes for future use, must be zero */
2246 uint32_t va_reserved[VA_PADDING_LOW];
2248 /* flags in VAPictureH264 could be OR of the following */
2249 #define VA_PICTURE_H264_INVALID 0x00000001
2250 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2251 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2252 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2253 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2255 /** H.264 Picture Parameter Buffer */
2257 * For each picture, and before any slice data, a single
2258 * picture parameter buffer must be send.
2260 typedef struct _VAPictureParameterBufferH264
2262 VAPictureH264 CurrPic;
2263 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2264 uint16_t picture_width_in_mbs_minus1;
2265 uint16_t picture_height_in_mbs_minus1;
2266 uint8_t bit_depth_luma_minus8;
2267 uint8_t bit_depth_chroma_minus8;
2268 uint8_t num_ref_frames;
2271 uint32_t chroma_format_idc : 2;
2272 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2273 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2274 uint32_t frame_mbs_only_flag : 1;
2275 uint32_t mb_adaptive_frame_field_flag : 1;
2276 uint32_t direct_8x8_inference_flag : 1;
2277 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2278 uint32_t log2_max_frame_num_minus4 : 4;
2279 uint32_t pic_order_cnt_type : 2;
2280 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2281 uint32_t delta_pic_order_always_zero_flag : 1;
2285 // FMO is not supported.
2286 va_deprecated uint8_t num_slice_groups_minus1;
2287 va_deprecated uint8_t slice_group_map_type;
2288 va_deprecated uint16_t slice_group_change_rate_minus1;
2289 int8_t pic_init_qp_minus26;
2290 int8_t pic_init_qs_minus26;
2291 int8_t chroma_qp_index_offset;
2292 int8_t second_chroma_qp_index_offset;
2295 uint32_t entropy_coding_mode_flag : 1;
2296 uint32_t weighted_pred_flag : 1;
2297 uint32_t weighted_bipred_idc : 2;
2298 uint32_t transform_8x8_mode_flag : 1;
2299 uint32_t field_pic_flag : 1;
2300 uint32_t constrained_intra_pred_flag : 1;
2301 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2302 uint32_t deblocking_filter_control_present_flag : 1;
2303 uint32_t redundant_pic_cnt_present_flag : 1;
2304 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2310 /** \brief Reserved bytes for future use, must be zero */
2311 uint32_t va_reserved[VA_PADDING_MEDIUM];
2312 } VAPictureParameterBufferH264;
2314 /** H.264 Inverse Quantization Matrix Buffer */
2315 typedef struct _VAIQMatrixBufferH264
2317 /** \brief 4x4 scaling list, in raster scan order. */
2318 uint8_t ScalingList4x4[6][16];
2319 /** \brief 8x8 scaling list, in raster scan order. */
2320 uint8_t ScalingList8x8[2][64];
2322 /** \brief Reserved bytes for future use, must be zero */
2323 uint32_t va_reserved[VA_PADDING_LOW];
2324 } VAIQMatrixBufferH264;
2326 /** H.264 Slice Parameter Buffer */
2327 typedef struct _VASliceParameterBufferH264
2329 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2330 /** \brief Byte offset to the NAL Header Unit for this slice. */
2331 uint32_t slice_data_offset;
2332 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2334 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2336 * This bit offset is relative to and includes the NAL unit byte
2337 * and represents the number of bits parsed in the slice_header()
2338 * after the removal of any emulation prevention bytes in
2339 * there. However, the slice data buffer passed to the hardware is
2340 * the original bitstream, thus including any emulation prevention
2343 uint16_t slice_data_bit_offset;
2344 uint16_t first_mb_in_slice;
2346 uint8_t direct_spatial_mv_pred_flag;
2348 * H264/AVC syntax element
2350 * if num_ref_idx_active_override_flag equals 0, host decoder should
2351 * set its value to num_ref_idx_l0_default_active_minus1.
2353 uint8_t num_ref_idx_l0_active_minus1;
2355 * H264/AVC syntax element
2357 * if num_ref_idx_active_override_flag equals 0, host decoder should
2358 * set its value to num_ref_idx_l1_default_active_minus1.
2360 uint8_t num_ref_idx_l1_active_minus1;
2361 uint8_t cabac_init_idc;
2362 int8_t slice_qp_delta;
2363 uint8_t disable_deblocking_filter_idc;
2364 int8_t slice_alpha_c0_offset_div2;
2365 int8_t slice_beta_offset_div2;
2366 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2367 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2368 uint8_t luma_log2_weight_denom;
2369 uint8_t chroma_log2_weight_denom;
2370 uint8_t luma_weight_l0_flag;
2371 int16_t luma_weight_l0[32];
2372 int16_t luma_offset_l0[32];
2373 uint8_t chroma_weight_l0_flag;
2374 int16_t chroma_weight_l0[32][2];
2375 int16_t chroma_offset_l0[32][2];
2376 uint8_t luma_weight_l1_flag;
2377 int16_t luma_weight_l1[32];
2378 int16_t luma_offset_l1[32];
2379 uint8_t chroma_weight_l1_flag;
2380 int16_t chroma_weight_l1[32][2];
2381 int16_t chroma_offset_l1[32][2];
2383 /** \brief Reserved bytes for future use, must be zero */
2384 uint32_t va_reserved[VA_PADDING_LOW];
2385 } VASliceParameterBufferH264;
2387 /****************************
2388 * Common encode data structures
2389 ****************************/
2392 VAEncPictureTypeIntra = 0,
2393 VAEncPictureTypePredictive = 1,
2394 VAEncPictureTypeBidirectional = 2,
2397 /* Encode Slice Parameter Buffer */
2398 typedef struct _VAEncSliceParameterBuffer
2400 uint32_t start_row_number; /* starting MB row number for this slice */
2401 uint32_t slice_height; /* slice height measured in MB */
2404 uint32_t is_intra : 1;
2405 uint32_t disable_deblocking_filter_idc : 2;
2406 uint32_t uses_long_term_ref :1;
2407 uint32_t is_long_term_ref :1;
2412 /** \brief Reserved bytes for future use, must be zero */
2413 uint32_t va_reserved[VA_PADDING_LOW];
2414 } VAEncSliceParameterBuffer;
2417 /****************************
2418 * H.263 specific encode data structures
2419 ****************************/
2421 typedef struct _VAEncSequenceParameterBufferH263
2423 uint32_t intra_period;
2424 uint32_t bits_per_second;
2425 uint32_t frame_rate;
2426 uint32_t initial_qp;
2429 /** \brief Reserved bytes for future use, must be zero */
2430 uint32_t va_reserved[VA_PADDING_LOW];
2431 } VAEncSequenceParameterBufferH263;
2433 typedef struct _VAEncPictureParameterBufferH263
2435 VASurfaceID reference_picture;
2436 VASurfaceID reconstructed_picture;
2437 VABufferID coded_buf;
2438 uint16_t picture_width;
2439 uint16_t picture_height;
2440 VAEncPictureType picture_type;
2442 /** \brief Reserved bytes for future use, must be zero */
2443 uint32_t va_reserved[VA_PADDING_LOW];
2444 } VAEncPictureParameterBufferH263;
2446 /****************************
2447 * MPEG-4 specific encode data structures
2448 ****************************/
2450 typedef struct _VAEncSequenceParameterBufferMPEG4
2452 uint8_t profile_and_level_indication;
2453 uint32_t intra_period;
2454 uint32_t video_object_layer_width;
2455 uint32_t video_object_layer_height;
2456 uint32_t vop_time_increment_resolution;
2457 uint32_t fixed_vop_rate;
2458 uint32_t fixed_vop_time_increment;
2459 uint32_t bits_per_second;
2460 uint32_t frame_rate;
2461 uint32_t initial_qp;
2464 /** \brief Reserved bytes for future use, must be zero */
2465 uint32_t va_reserved[VA_PADDING_LOW];
2466 } VAEncSequenceParameterBufferMPEG4;
2468 typedef struct _VAEncPictureParameterBufferMPEG4
2470 VASurfaceID reference_picture;
2471 VASurfaceID reconstructed_picture;
2472 VABufferID coded_buf;
2473 uint16_t picture_width;
2474 uint16_t picture_height;
2475 uint32_t modulo_time_base; /* number of 1s */
2476 uint32_t vop_time_increment;
2477 VAEncPictureType picture_type;
2479 /** \brief Reserved bytes for future use, must be zero */
2480 uint32_t va_reserved[VA_PADDING_LOW];
2481 } VAEncPictureParameterBufferMPEG4;
2485 /** Buffer functions */
2488 * Creates a buffer for "num_elements" elements of "size" bytes and
2489 * initalize with "data".
2490 * if "data" is null, then the contents of the buffer data store
2492 * Basically there are two ways to get buffer data to the server side. One is
2493 * to call vaCreateBuffer() with a non-null "data", which results the data being
2494 * copied to the data store on the server side. A different method that
2495 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2496 * and then use vaMapBuffer() to map the data store from the server side to the
2497 * client address space for access.
2498 * The user must call vaDestroyBuffer() to destroy a buffer.
2499 * Note: image buffers are created by the library, not the client. Please see
2500 * vaCreateImage on how image buffers are managed.
2502 VAStatus vaCreateBuffer (
2504 VAContextID context,
2505 VABufferType type, /* in */
2506 unsigned int size, /* in */
2507 unsigned int num_elements, /* in */
2508 void *data, /* in */
2509 VABufferID *buf_id /* out */
2513 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
2514 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
2515 * can call vaMapBuffer with this Buffer ID to get virtual address.
2516 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
2517 * maybe it should align with 256, and one byte present one Qp.so, call the function.
2518 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
2519 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
2520 * pBuf + 256 is the start of next line.
2521 * different driver implementation maybe return different unit_size and pitch
2523 VAStatus vaCreateBuffer2(
2525 VAContextID context,
2528 unsigned int height,
2529 unsigned int *unit_size,
2530 unsigned int *pitch,
2535 * Convey to the server how many valid elements are in the buffer.
2536 * e.g. if multiple slice parameters are being held in a single buffer,
2537 * this will communicate to the server the number of slice parameters
2538 * that are valid in the buffer.
2540 VAStatus vaBufferSetNumElements (
2542 VABufferID buf_id, /* in */
2543 unsigned int num_elements /* in */
2548 * device independent data structure for codedbuffer
2552 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2553 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2554 * enough for the encoder to attempt to limit its size.
2555 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2556 * exceeded the maximum slice size specified.
2557 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2558 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2559 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2561 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2562 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2563 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2564 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2565 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2567 * \brief The frame has exceeded the maximum requested size.
2569 * This flag indicates that the encoded frame size exceeds the value
2570 * specified through a misc parameter buffer of type
2571 * #VAEncMiscParameterTypeMaxFrameSize.
2573 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2574 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2577 * \brief The coded buffer segment contains a single NAL unit.
2579 * This flag indicates that the coded buffer segment contains a
2580 * single NAL unit. This flag might be useful to the user for
2581 * processing the coded buffer.
2583 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2586 * \brief Coded buffer segment.
2588 * #VACodedBufferSegment is an element of a linked list describing
2589 * some information on the coded buffer. The coded buffer segment
2590 * could contain either a single NAL unit, or more than one NAL unit.
2591 * It is recommended (but not required) to return a single NAL unit
2592 * in a coded buffer segment, and the implementation should set the
2593 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2595 typedef struct _VACodedBufferSegment {
2597 * \brief Size of the data buffer in this segment (in bytes).
2600 /** \brief Bit offset into the data buffer where the video data starts. */
2601 uint32_t bit_offset;
2602 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2604 /** \brief Reserved for future use. */
2606 /** \brief Pointer to the start of the data buffer. */
2609 * \brief Pointer to the next #VACodedBufferSegment element,
2610 * or \c NULL if there is none.
2614 /** \brief Reserved bytes for future use, must be zero */
2615 uint32_t va_reserved[VA_PADDING_LOW];
2616 } VACodedBufferSegment;
2619 * Map data store of the buffer into the client's address space
2620 * vaCreateBuffer() needs to be called with "data" set to NULL before
2621 * calling vaMapBuffer()
2623 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2624 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2626 VAStatus vaMapBuffer (
2628 VABufferID buf_id, /* in */
2629 void **pbuf /* out */
2633 * After client making changes to a mapped data store, it needs to
2634 * "Unmap" it to let the server know that the data is ready to be
2635 * consumed by the server
2637 VAStatus vaUnmapBuffer (
2639 VABufferID buf_id /* in */
2643 * After this call, the buffer is deleted and this buffer_id is no longer valid
2645 * A buffer can be re-used and sent to the server by another Begin/Render/End
2646 * sequence if vaDestroyBuffer() is not called with this buffer.
2648 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
2649 * hardware accelerator can result in performance dropping.
2651 VAStatus vaDestroyBuffer (
2653 VABufferID buffer_id
2656 /** \brief VA buffer information */
2658 /** \brief Buffer handle */
2660 /** \brief Buffer type (See \ref VABufferType). */
2663 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2665 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2666 * to specify the set of memory types the caller is interested in.
2667 * On successful return from vaAcquireBufferHandle(), the field is
2668 * updated with the best matching memory type.
2671 /** \brief Size of the underlying buffer. */
2674 /** \brief Reserved bytes for future use, must be zero */
2675 uint32_t va_reserved[VA_PADDING_LOW];
2679 * \brief Acquires buffer handle for external API usage
2681 * Locks the VA buffer object \ref buf_id for external API usage like
2682 * EGL or OpenCL (OCL). This function is a synchronization point. This
2683 * means that any pending operation is guaranteed to be completed
2684 * prior to returning from the function.
2686 * If the referenced VA buffer object is the backing store of a VA
2687 * surface, then this function acts as if vaSyncSurface() on the
2688 * parent surface was called first.
2690 * The \ref VABufferInfo argument shall be zero'ed on input. On
2691 * successful output, the data structure is filled in with all the
2692 * necessary buffer level implementation details like handle, type,
2693 * memory type and memory size.
2695 * Note: the external API implementation, or the application, can
2696 * express the memory types it is interested in by filling in the \ref
2697 * mem_type field accordingly. On successful output, the memory type
2698 * that fits best the request and that was used is updated in the \ref
2699 * VABufferInfo data structure. If none of the supplied memory types
2700 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2701 * error is returned.
2703 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2704 * is called. Besides, no additional operation is allowed on any of
2705 * the buffer parent object until vaReleaseBufferHandle() is called.
2706 * e.g. decoding into a VA surface backed with the supplied VA buffer
2707 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2711 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2712 * does not support this interface
2713 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2714 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2715 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2716 * does not support exporting buffers of the specified type
2717 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2718 * memory types in \ref VABufferInfo.mem_type was supported
2720 * @param[in] dpy the VA display
2721 * @param[in] buf_id the VA buffer
2722 * @param[in,out] buf_info the associated VA buffer information
2723 * @return VA_STATUS_SUCCESS if successful
2726 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2729 * \brief Releases buffer after usage from external API
2731 * Unlocks the VA buffer object \ref buf_id from external API usage like
2732 * EGL or OpenCL (OCL). This function is a synchronization point. This
2733 * means that any pending operation is guaranteed to be completed
2734 * prior to returning from the function.
2736 * The \ref VABufferInfo argument shall point to the original data
2737 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2738 * This is necessary so that the VA driver implementation could
2739 * deallocate any resources that were needed.
2741 * In any case, returning from this function invalidates any contents
2742 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2743 * valid. Therefore, VA driver implementations are free to reset this
2744 * data structure to safe defaults.
2747 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2748 * does not support this interface
2749 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2750 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2751 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2752 * does not support exporting buffers of the specified type
2754 * @param[in] dpy the VA display
2755 * @param[in] buf_id the VA buffer
2756 * @return VA_STATUS_SUCCESS if successful
2759 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2762 * Render (Video Decode/Encode/Processing) Pictures
2764 * A picture represents either a frame or a field.
2766 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
2771 * Get ready for a video pipeline
2772 * - decode a picture to a target surface
2773 * - encode a picture from a target surface
2774 * - process a picture to a target surface
2776 VAStatus vaBeginPicture (
2778 VAContextID context,
2779 VASurfaceID render_target
2783 * Send video decode, encode or processing buffers to the server.
2785 VAStatus vaRenderPicture (
2787 VAContextID context,
2788 VABufferID *buffers,
2793 * Make the end of rendering for a picture.
2794 * The server should start processing all pending operations for this
2795 * surface. This call is non-blocking. The client can start another
2796 * Begin/Render/End sequence on a different render target.
2797 * if VAContextID used in this function previously successfully passed
2798 * vaMFAddContext call, real processing will be started during vaMFSubmit
2800 VAStatus vaEndPicture (
2806 * Make the end of rendering for a pictures in contexts passed with submission.
2807 * The server should start processing all pending operations for contexts.
2808 * All contexts passed should be associated through vaMFAddContext
2809 * and call sequence Begin/Render/End performed.
2810 * This call is non-blocking. The client can start another
2811 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
2813 * VA_STATUS_SUCCESS - operation successful, context was removed.
2814 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
2815 * due to mf_context not created or one of contexts not assotiated with mf_context
2816 * through vaAddContext.
2817 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
2818 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
2820 * mf_context: Multi-Frame context
2821 * contexts: list of contexts submitting their tasks for multi-frame operation.
2822 * num_contexts: number of passed contexts.
2824 VAStatus vaMFSubmit (
2826 VAMFContextID mf_context,
2827 VAContextID * contexts,
2838 * This function blocks until all pending operations on the render target
2839 * have been completed. Upon return it is safe to use the render target for a
2840 * different picture.
2842 VAStatus vaSyncSurface (
2844 VASurfaceID render_target
2849 VASurfaceRendering = 1, /* Rendering in progress */
2850 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2851 /* this status is useful if surface is used as the source */
2853 VASurfaceReady = 4, /* not being rendered or displayed */
2854 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2858 * Find out any pending ops on the render target
2860 VAStatus vaQuerySurfaceStatus (
2862 VASurfaceID render_target,
2863 VASurfaceStatus *status /* out */
2868 VADecodeSliceMissing = 0,
2869 VADecodeMBError = 1,
2870 } VADecodeErrorType;
2873 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2874 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2876 typedef struct _VASurfaceDecodeMBErrors
2878 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2879 uint32_t start_mb; /* start mb address with errors */
2880 uint32_t end_mb; /* end mb address with errors */
2881 VADecodeErrorType decode_error_type;
2883 /** \brief Reserved bytes for future use, must be zero */
2884 uint32_t va_reserved[VA_PADDING_LOW];
2885 } VASurfaceDecodeMBErrors;
2888 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2889 * it can call vaQuerySurfaceError to find out further details on the particular error.
2890 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2891 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2892 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2893 * The array is terminated if "status==-1" is detected.
2895 VAStatus vaQuerySurfaceError(
2897 VASurfaceID surface,
2898 VAStatus error_status,
2903 * Images and Subpictures
2904 * VAImage is used to either get the surface data to client memory, or
2905 * to copy image data in client memory to a surface.
2906 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2907 * is at the upper left corner with positive X to the right and positive Y down
2909 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2910 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2911 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2914 * Pre-defined fourcc codes
2916 #define VA_FOURCC_NV12 0x3231564E
2917 #define VA_FOURCC_AI44 0x34344149
2918 #define VA_FOURCC_RGBA 0x41424752
2919 #define VA_FOURCC_RGBX 0x58424752
2920 #define VA_FOURCC_BGRA 0x41524742
2921 #define VA_FOURCC_BGRX 0x58524742
2922 #define VA_FOURCC_ARGB 0x42475241
2923 #define VA_FOURCC_XRGB 0x42475258
2924 #define VA_FOURCC_ABGR 0x52474241
2925 #define VA_FOURCC_XBGR 0x52474258
2926 #define VA_FOURCC_UYVY 0x59565955
2927 #define VA_FOURCC_YUY2 0x32595559
2928 #define VA_FOURCC_AYUV 0x56555941
2929 #define VA_FOURCC_NV11 0x3131564e
2930 #define VA_FOURCC_YV12 0x32315659
2931 #define VA_FOURCC_P208 0x38303250
2932 /* IYUV same as I420, but most user perfer I420, will deprecate it */
2933 #define VA_FOURCC_IYUV 0x56555949
2934 #define VA_FOURCC_I420 0x30323449
2935 #define VA_FOURCC_YV24 0x34325659
2936 #define VA_FOURCC_YV32 0x32335659
2937 #define VA_FOURCC_Y800 0x30303859
2938 #define VA_FOURCC_IMC3 0x33434D49
2939 #define VA_FOURCC_411P 0x50313134
2940 #define VA_FOURCC_422H 0x48323234
2941 #define VA_FOURCC_422V 0x56323234
2942 #define VA_FOURCC_444P 0x50343434
2943 #define VA_FOURCC_RGBP 0x50424752
2944 #define VA_FOURCC_BGRP 0x50524742
2945 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2948 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
2950 #define VA_FOURCC_YV16 0x36315659
2952 * 10-bit and 16-bit Planar YUV 4:2:0.
2954 #define VA_FOURCC_P010 0x30313050
2955 #define VA_FOURCC_P016 0x36313050
2958 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
2960 #define VA_FOURCC_I010 0x30313049
2963 #define VA_LSB_FIRST 1
2964 #define VA_MSB_FIRST 2
2966 typedef struct _VAImageFormat
2969 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2970 uint32_t bits_per_pixel;
2971 /* for RGB formats */
2972 uint32_t depth; /* significant bits per pixel */
2974 uint32_t green_mask;
2976 uint32_t alpha_mask;
2978 /** \brief Reserved bytes for future use, must be zero */
2979 uint32_t va_reserved[VA_PADDING_LOW];
2982 typedef VAGenericID VAImageID;
2984 typedef struct _VAImage
2986 VAImageID image_id; /* uniquely identify this image */
2987 VAImageFormat format;
2988 VABufferID buf; /* image data buffer */
2990 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2991 * data store on the server side for optimal performance. The buffer will be
2992 * created by the CreateImage function, and proper storage allocated based on the image
2993 * size and format. This buffer is managed by the library implementation, and
2994 * accessed by the client through the buffer Map/Unmap functions.
2999 uint32_t num_planes; /* can not be greater than 3 */
3001 * An array indicating the scanline pitch in bytes for each plane.
3002 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3004 uint32_t pitches[3];
3006 * An array indicating the byte offset from the beginning of the image data
3007 * to the start of each plane.
3009 uint32_t offsets[3];
3011 /* The following fields are only needed for paletted formats */
3012 int32_t num_palette_entries; /* set to zero for non-palette images */
3014 * Each component is one byte and entry_bytes indicates the number of components in
3015 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3017 int32_t entry_bytes;
3019 * An array of ascii characters describing the order of the components within the bytes.
3020 * Only entry_bytes characters of the string are used.
3022 int8_t component_order[4];
3024 /** \brief Reserved bytes for future use, must be zero */
3025 uint32_t va_reserved[VA_PADDING_LOW];
3028 /** Get maximum number of image formats supported by the implementation */
3029 int vaMaxNumImageFormats (
3034 * Query supported image formats
3035 * The caller must provide a "format_list" array that can hold at
3036 * least vaMaxNumImageFormats() entries. The actual number of formats
3037 * returned in "format_list" is returned in "num_formats".
3039 VAStatus vaQueryImageFormats (
3041 VAImageFormat *format_list, /* out */
3042 int *num_formats /* out */
3046 * Create a VAImage structure
3047 * The width and height fields returned in the VAImage structure may get
3048 * enlarged for some YUV formats. Upon return from this function,
3049 * image->buf has been created and proper storage allocated by the library.
3050 * The client can access the image through the Map/Unmap calls.
3052 VAStatus vaCreateImage (
3054 VAImageFormat *format,
3057 VAImage *image /* out */
3061 * Should call DestroyImage before destroying the surface it is bound to
3063 VAStatus vaDestroyImage (
3068 VAStatus vaSetImagePalette (
3072 * pointer to an array holding the palette data. The size of the array is
3073 * num_palette_entries * entry_bytes in size. The order of the components
3074 * in the palette is described by the component_order in VAImage struct
3076 unsigned char *palette
3080 * Retrive surface data into a VAImage
3081 * Image must be in a format supported by the implementation
3083 VAStatus vaGetImage (
3085 VASurfaceID surface,
3086 int x, /* coordinates of the upper left source pixel */
3088 unsigned int width, /* width and height of the region */
3089 unsigned int height,
3094 * Copy data from a VAImage to a surface
3095 * Image must be in a format supported by the implementation
3096 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3097 * shouldn't be rendered into when this is called
3099 VAStatus vaPutImage (
3101 VASurfaceID surface,
3105 unsigned int src_width,
3106 unsigned int src_height,
3109 unsigned int dest_width,
3110 unsigned int dest_height
3114 * Derive an VAImage from an existing surface.
3115 * This interface will derive a VAImage and corresponding image buffer from
3116 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3117 * direct CPU access. This operation is only possible on implementations with
3118 * direct rendering capabilities and internal surface formats that can be
3119 * represented with a VAImage. When the operation is not possible this interface
3120 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3121 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3124 * Implementations should only return success when the resulting image buffer
3125 * would be useable with vaMap/Unmap.
3127 * When directly accessing a surface special care must be taken to insure
3128 * proper synchronization with the graphics hardware. Clients should call
3129 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3130 * rendering or currently being displayed by an overlay.
3132 * Additionally nothing about the contents of a surface should be assumed
3133 * following a vaPutSurface. Implementations are free to modify the surface for
3134 * scaling or subpicture blending within a call to vaPutImage.
3136 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3137 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3138 * vaGetImage with other surfaces is supported.
3140 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3141 * image and image buffer structures will be destroyed; however, the underlying
3142 * surface will remain unchanged until freed with vaDestroySurfaces.
3144 VAStatus vaDeriveImage (
3146 VASurfaceID surface,
3147 VAImage *image /* out */
3152 * Subpicture is a special type of image that can be blended
3153 * with a surface during vaPutSurface(). Subpicture can be used to render
3154 * DVD sub-titles or closed captioning text etc.
3157 typedef VAGenericID VASubpictureID;
3159 /** Get maximum number of subpicture formats supported by the implementation */
3160 int vaMaxNumSubpictureFormats (
3164 /** flags for subpictures */
3165 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3166 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3167 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3169 * Query supported subpicture formats
3170 * The caller must provide a "format_list" array that can hold at
3171 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3172 * for each format to indicate additional capabilities for that format. The actual
3173 * number of formats returned in "format_list" is returned in "num_formats".
3174 * flags: returned value to indicate addtional capabilities
3175 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3176 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3177 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3180 VAStatus vaQuerySubpictureFormats (
3182 VAImageFormat *format_list, /* out */
3183 unsigned int *flags, /* out */
3184 unsigned int *num_formats /* out */
3188 * Subpictures are created with an image associated.
3190 VAStatus vaCreateSubpicture (
3193 VASubpictureID *subpicture /* out */
3197 * Destroy the subpicture before destroying the image it is assocated to
3199 VAStatus vaDestroySubpicture (
3201 VASubpictureID subpicture
3205 * Bind an image to the subpicture. This image will now be associated with
3206 * the subpicture instead of the one at creation.
3208 VAStatus vaSetSubpictureImage (
3210 VASubpictureID subpicture,
3215 * If chromakey is enabled, then the area where the source value falls within
3216 * the chromakey [min, max] range is transparent
3217 * The chromakey component format is the following:
3218 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3219 * For YUV: [0:7] V [8:15] U [16:23] Y
3220 * The chromakey mask can be used to mask out certain components for chromakey
3223 VAStatus vaSetSubpictureChromakey (
3225 VASubpictureID subpicture,
3226 unsigned int chromakey_min,
3227 unsigned int chromakey_max,
3228 unsigned int chromakey_mask
3232 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3233 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3234 * the overall alpha is per-pixel alpha multiplied by the global alpha
3236 VAStatus vaSetSubpictureGlobalAlpha (
3238 VASubpictureID subpicture,
3243 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3244 * It defines the region mapping between the subpicture and the target
3245 * surfaces through source and destination rectangles (with the same width and height).
3246 * Both will be displayed at the next call to vaPutSurface. Additional
3247 * associations before the call to vaPutSurface simply overrides the association.
3249 VAStatus vaAssociateSubpicture (
3251 VASubpictureID subpicture,
3252 VASurfaceID *target_surfaces,
3254 int16_t src_x, /* upper left offset in subpicture */
3257 uint16_t src_height,
3258 int16_t dest_x, /* upper left offset in surface */
3260 uint16_t dest_width,
3261 uint16_t dest_height,
3263 * whether to enable chroma-keying, global-alpha, or screen relative mode
3264 * see VA_SUBPICTURE_XXX values
3270 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3272 VAStatus vaDeassociateSubpicture (
3274 VASubpictureID subpicture,
3275 VASurfaceID *target_surfaces,
3280 * Display attributes
3281 * Display attributes are used to control things such as contrast, hue, saturation,
3282 * brightness etc. in the rendering process. The application can query what
3283 * attributes are supported by the driver, and then set the appropriate attributes
3284 * before calling vaPutSurface()
3286 /* PowerVR IEP Lite attributes */
3289 VADISPLAYATTRIB_BLE_OFF = 0x00,
3290 VADISPLAYATTRIB_BLE_LOW,
3291 VADISPLAYATTRIB_BLE_MEDIUM,
3292 VADISPLAYATTRIB_BLE_HIGH,
3293 VADISPLAYATTRIB_BLE_NONE,
3294 } VADisplayAttribBLEMode;
3296 /** attribute value for VADisplayAttribRotation */
3297 #define VA_ROTATION_NONE 0x00000000
3298 #define VA_ROTATION_90 0x00000001
3299 #define VA_ROTATION_180 0x00000002
3300 #define VA_ROTATION_270 0x00000003
3304 * @name Mirroring directions
3306 * Those values could be used for VADisplayAttribMirror attribute or
3307 * VAProcPipelineParameterBuffer::mirror_state.
3311 /** \brief No Mirroring. */
3312 #define VA_MIRROR_NONE 0x00000000
3313 /** \brief Horizontal Mirroring. */
3314 #define VA_MIRROR_HORIZONTAL 0x00000001
3315 /** \brief Vertical Mirroring. */
3316 #define VA_MIRROR_VERTICAL 0x00000002
3319 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3320 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3321 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3324 #define VA_RENDER_MODE_UNDEFINED 0
3325 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3326 #define VA_RENDER_MODE_LOCAL_GPU 2
3327 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3328 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3330 /** Render device */
3331 #define VA_RENDER_DEVICE_UNDEFINED 0
3332 #define VA_RENDER_DEVICE_LOCAL 1
3333 #define VA_RENDER_DEVICE_EXTERNAL 2
3335 /** Currently defined display attribute types */
3338 VADisplayAttribBrightness = 0,
3339 VADisplayAttribContrast = 1,
3340 VADisplayAttribHue = 2,
3341 VADisplayAttribSaturation = 3,
3342 /* client can specifiy a background color for the target window
3343 * the new feature of video conference,
3344 * the uncovered area of the surface is filled by this color
3345 * also it will blend with the decoded video color
3347 VADisplayAttribBackgroundColor = 4,
3349 * this is a gettable only attribute. For some implementations that use the
3350 * hardware overlay, after PutSurface is called, the surface can not be
3351 * re-used until after the subsequent PutSurface call. If this is the case
3352 * then the value for this attribute will be set to 1 so that the client
3353 * will not attempt to re-use the surface right after returning from a call
3356 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3357 * driver may use overlay or GPU alternatively
3359 VADisplayAttribDirectSurface = 5,
3360 VADisplayAttribRotation = 6,
3361 VADisplayAttribOutofLoopDeblock = 7,
3363 /* PowerVR IEP Lite specific attributes */
3364 VADisplayAttribBLEBlackMode = 8,
3365 VADisplayAttribBLEWhiteMode = 9,
3366 VADisplayAttribBlueStretch = 10,
3367 VADisplayAttribSkinColorCorrection = 11,
3369 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3370 * conversion matrix. Each element in the matrix is float-point
3372 VADisplayAttribCSCMatrix = 12,
3373 /* specify the constant color used to blend with video surface
3374 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3375 * d: the final color to overwrite into the frame buffer
3376 * v: decoded video after color conversion,
3377 * c: video color specified by VADisplayAttribBlendColor
3378 * b: background color of the drawable
3380 VADisplayAttribBlendColor = 13,
3382 * Indicate driver to skip painting color key or not.
3383 * only applicable if the render is overlay
3385 VADisplayAttribOverlayAutoPaintColorKey = 14,
3387 * customized overlay color key, the format is RGB888
3388 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3390 VADisplayAttribOverlayColorKey = 15,
3392 * The hint for the implementation of vaPutSurface
3393 * normally, the driver could use an overlay or GPU to render the surface on the screen
3394 * this flag provides APP the flexibity to switch the render dynamically
3396 VADisplayAttribRenderMode = 16,
3398 * specify if vaPutSurface needs to render into specified monitors
3399 * one example is that one external monitor (e.g. HDMI) is enabled,
3400 * but the window manager is not aware of it, and there is no associated drawable
3402 VADisplayAttribRenderDevice = 17,
3404 * specify vaPutSurface render area if there is no drawable on the monitor
3406 VADisplayAttribRenderRect = 18,
3407 } VADisplayAttribType;
3409 /* flags for VADisplayAttribute */
3410 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3411 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3412 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3414 typedef struct _VADisplayAttribute
3416 VADisplayAttribType type;
3419 int32_t value; /* used by the set/get attribute functions */
3420 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3423 /** \brief Reserved bytes for future use, must be zero */
3424 uint32_t va_reserved[VA_PADDING_LOW];
3425 } VADisplayAttribute;
3427 /** Get maximum number of display attributs supported by the implementation */
3428 int vaMaxNumDisplayAttributes (
3433 * Query display attributes
3434 * The caller must provide a "attr_list" array that can hold at
3435 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3436 * returned in "attr_list" is returned in "num_attributes".
3438 VAStatus vaQueryDisplayAttributes (
3440 VADisplayAttribute *attr_list, /* out */
3441 int *num_attributes /* out */
3445 * Get display attributes
3446 * This function returns the current attribute values in "attr_list".
3447 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3448 * from vaQueryDisplayAttributes() can have their values retrieved.
3450 VAStatus vaGetDisplayAttributes (
3452 VADisplayAttribute *attr_list, /* in/out */
3457 * Set display attributes
3458 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3459 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3460 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3462 VAStatus vaSetDisplayAttributes (
3464 VADisplayAttribute *attr_list,
3468 /****************************
3469 * HEVC data structures
3470 ****************************/
3472 * \brief Description of picture properties of those in DPB surfaces.
3474 * If only progressive scan is supported, each surface contains one whole
3476 * Otherwise, each surface contains two fields of whole picture.
3477 * In this case, two entries of ReferenceFrames[] may share same picture_id
3480 typedef struct _VAPictureHEVC
3482 /** \brief reconstructed picture buffer surface index
3483 * invalid when taking value VA_INVALID_SURFACE.
3485 VASurfaceID picture_id;
3486 /** \brief picture order count.
3487 * in HEVC, POCs for top and bottom fields of same picture should
3488 * take different values.
3490 int32_t pic_order_cnt;
3491 /* described below */
3494 /** \brief Reserved bytes for future use, must be zero */
3495 uint32_t va_reserved[VA_PADDING_LOW];
3498 /* flags in VAPictureHEVC could be OR of the following */
3499 #define VA_PICTURE_HEVC_INVALID 0x00000001
3500 /** \brief indication of interlace scan picture.
3501 * should take same value for all the pictures in sequence.
3503 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3504 /** \brief polarity of the field picture.
3505 * top field takes even lines of buffer surface.
3506 * bottom field takes odd lines of buffer surface.
3508 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3509 /** \brief Long term reference picture */
3510 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3512 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3513 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3514 * be exclusive. No more than one of them can be set for any picture.
3515 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3516 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3517 * Application should provide valid values for both short format and long format.
3518 * The pictures in DPB with any of these three flags turned on are referred by
3519 * the current picture.
3521 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3522 * Number of ReferenceFrames[] entries with this bit set equals
3523 * NumPocStCurrBefore.
3525 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3526 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3527 * Number of ReferenceFrames[] entries with this bit set equals
3528 * NumPocStCurrAfter.
3530 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3531 /** \brief RefPicSetLtCurr of HEVC spec variable
3532 * Number of ReferenceFrames[] entries with this bit set equals
3535 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3537 #include <va/va_dec_hevc.h>
3538 #include <va/va_dec_jpeg.h>
3539 #include <va/va_dec_vp8.h>
3540 #include <va/va_dec_vp9.h>
3541 #include <va/va_enc_hevc.h>
3542 #include <va/va_enc_h264.h>
3543 #include <va/va_enc_jpeg.h>
3544 #include <va/va_enc_mpeg2.h>
3545 #include <va/va_enc_vp8.h>
3546 #include <va/va_enc_vp9.h>
3547 #include <va/va_fei.h>
3548 #include <va/va_fei_h264.h>
3549 #include <va/va_vpp.h>