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 JPEG encoding attribute. Read-only.
510 * This attribute exposes a number of capabilities of the underlying
511 * JPEG implementation. The attribute value is partitioned into fields as defined in the
512 * VAConfigAttribValEncJPEG union.
514 VAConfigAttribEncJPEG = 20,
516 * \brief Encoding quality range attribute. Read-only.
518 * This attribute conveys whether the driver supports different quality level settings
519 * for encoding. A value less than or equal to 1 means that the encoder only has a single
520 * quality setting, and a value greater than 1 represents the number of quality levels
521 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
523 VAConfigAttribEncQualityRange = 21,
525 * \brief Encoding skip frame attribute. Read-only.
527 * This attribute conveys whether the driver supports sending skip frame parameters
528 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
529 * externally skipped frames.
531 VAConfigAttribEncSkipFrame = 24,
533 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
535 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
536 * based on user provided ROI rectangles. The attribute value is partitioned into fields
537 * as defined in the VAConfigAttribValEncROI union.
539 * If ROI encoding is supported, the ROI information is passed to the driver using
540 * VAEncMiscParameterTypeROI.
542 VAConfigAttribEncROI = 25,
544 * \brief Encoding extended rate control attribute. Read-only.
546 * This attribute conveys whether the driver supports any extended rate control features
547 * The attribute value is partitioned into fields as defined in the
548 * VAConfigAttribValEncRateControlExt union.
550 VAConfigAttribEncRateControlExt = 26,
553 * \brief Encode function type for FEI.
555 * This attribute conveys whether the driver supports different function types for encode.
556 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
557 * it is for FEI entry point only.
558 * Default is VA_FEI_FUNCTION_ENC_PAK.
560 VAConfigAttribFEIFunctionType = 32,
562 * \brief Maximum number of FEI MV predictors. Read-only.
564 * This attribute determines the maximum number of MV predictors the driver
565 * can support to encode a single frame. 0 means no MV predictor is supported.
566 * Currently it is for FEI entry point only.
568 VAConfigAttribFEIMVPredictors = 33,
570 VAConfigAttribTypeMax
571 } VAConfigAttribType;
574 * Configuration attributes
575 * If there is more than one value for an attribute, a default
576 * value will be assigned to the attribute if the client does not
577 * specify the attribute when creating a configuration
579 typedef struct _VAConfigAttrib {
580 VAConfigAttribType type;
581 uint32_t value; /* OR'd flags (bits) for this attribute */
584 /** attribute value for VAConfigAttribRTFormat */
585 #define VA_RT_FORMAT_YUV420 0x00000001
586 #define VA_RT_FORMAT_YUV422 0x00000002
587 #define VA_RT_FORMAT_YUV444 0x00000004
588 #define VA_RT_FORMAT_YUV411 0x00000008
589 #define VA_RT_FORMAT_YUV400 0x00000010
590 /** YUV formats with more than 8 bpp */
591 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
593 #define VA_RT_FORMAT_RGB16 0x00010000
594 #define VA_RT_FORMAT_RGB32 0x00020000
595 /* RGBP covers RGBP and BGRP fourcc */
596 #define VA_RT_FORMAT_RGBP 0x00100000
597 #define VA_RT_FORMAT_PROTECTED 0x80000000
599 /** @name Attribute values for VAConfigAttribRateControl */
601 /** \brief Driver does not support any form of rate control. */
602 #define VA_RC_NONE 0x00000001
603 /** \brief Constant bitrate. */
604 #define VA_RC_CBR 0x00000002
605 /** \brief Variable bitrate. */
606 #define VA_RC_VBR 0x00000004
607 /** \brief Video conference mode. */
608 #define VA_RC_VCM 0x00000008
609 /** \brief Constant QP. */
610 #define VA_RC_CQP 0x00000010
611 /** \brief Variable bitrate with peak rate higher than average bitrate. */
612 #define VA_RC_VBR_CONSTRAINED 0x00000020
613 /** \brief Macroblock based rate control. Per MB control is decided
614 * internally in the encoder. It may be combined with other RC modes, except CQP. */
615 #define VA_RC_MB 0x00000080
619 /** @name Attribute values for VAConfigAttribDecSliceMode */
621 /** \brief Driver supports normal mode for slice decoding */
622 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
623 /** \brief Driver supports base mode for slice decoding */
624 #define VA_DEC_SLICE_MODE_BASE 0x00000002
626 /** @name Attribute values for VAConfigAttribDecJPEG */
628 typedef union _VAConfigAttribValDecJPEG {
630 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
631 uint32_t rotation : 4;
632 /** \brief Reserved for future use. */
633 uint32_t reserved : 28;
636 uint32_t va_reserved[VA_PADDING_LOW];
637 } VAConfigAttribValDecJPEG;
640 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
642 /** \brief Driver does not support any packed headers mode. */
643 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
645 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
647 * Application must provide it to driver once this flag is returned through
648 * vaGetConfigAttributes()
650 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
652 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
654 * Application must provide it to driver once this falg is returned through
655 * vaGetConfigAttributes()
657 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
659 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
661 * Application must provide it to driver once this flag is returned through
662 * vaGetConfigAttributes()
664 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
666 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
669 * This is a deprecated packed header flag, All applications can use
670 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
671 * header data buffer to the driver
673 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
674 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
675 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
678 /** @name Attribute values for VAConfigAttribEncInterlaced */
680 /** \brief Driver does not support interlaced coding. */
681 #define VA_ENC_INTERLACED_NONE 0x00000000
682 /** \brief Driver supports interlaced frame coding. */
683 #define VA_ENC_INTERLACED_FRAME 0x00000001
684 /** \brief Driver supports interlaced field coding. */
685 #define VA_ENC_INTERLACED_FIELD 0x00000002
686 /** \brief Driver supports macroblock adaptive frame field coding. */
687 #define VA_ENC_INTERLACED_MBAFF 0x00000004
688 /** \brief Driver supports picture adaptive frame field coding. */
689 #define VA_ENC_INTERLACED_PAFF 0x00000008
692 /** @name Attribute values for VAConfigAttribEncSliceStructure */
694 /** \brief Driver supports a power-of-two number of rows per slice. */
695 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
696 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
697 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
698 /** \brief Dirver support 1 rows per slice */
699 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
700 /** \brief Dirver support max encoded slice size per slice */
701 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
702 /** \brief Driver supports an arbitrary number of rows per slice. */
703 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
706 /** \brief Attribute value for VAConfigAttribEncJPEG */
707 typedef union _VAConfigAttribValEncJPEG {
709 /** \brief set to 1 for arithmatic coding. */
710 uint32_t arithmatic_coding_mode : 1;
711 /** \brief set to 1 for progressive dct. */
712 uint32_t progressive_dct_mode : 1;
713 /** \brief set to 1 for non-interleaved. */
714 uint32_t non_interleaved_mode : 1;
715 /** \brief set to 1 for differential. */
716 uint32_t differential_mode : 1;
717 uint32_t max_num_components : 3;
718 uint32_t max_num_scans : 4;
719 uint32_t max_num_huffman_tables : 3;
720 uint32_t max_num_quantization_tables : 3;
723 } VAConfigAttribValEncJPEG;
725 /** \brief Attribute value for VAConfigAttribEncROI */
726 typedef union _VAConfigAttribValEncROI {
728 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
729 uint32_t num_roi_regions : 8;
731 * \brief A flag indicates whether ROI priority is supported
733 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
734 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
735 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
736 * the underlying driver doesn't support ROI priority.
738 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
739 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
741 uint32_t roi_rc_priority_support : 1;
743 * \brief A flag indicates whether ROI delta QP is supported
745 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
746 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
747 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
748 * the underlying driver doesn't support ROI delta QP.
750 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
751 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
753 uint32_t roi_rc_qp_delta_support : 1;
754 uint32_t reserved : 22;
757 } VAConfigAttribValEncROI;
759 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
760 typedef union _VAConfigAttribValEncRateControlExt {
763 * \brief The maximum number of temporal layers minus 1
765 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
766 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
767 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
769 uint32_t max_num_temporal_layers_minus1 : 8;
772 * /brief support temporal layer bit-rate control flag
774 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
775 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
776 * #VAConfigAttribRateControl == #VA_RC_VBR).
778 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
779 * \c max_num_temporal_layers_minus1 is equal to 0
781 * To use bit-rate control per temporal layer, an application must send the right layer
782 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
783 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
784 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
785 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
786 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
787 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
788 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
790 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
791 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
792 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
794 uint32_t temporal_layer_bitrate_control_flag : 1;
795 uint32_t reserved : 23;
798 } VAConfigAttribValEncRateControlExt;
801 * if an attribute is not applicable for a given
802 * profile/entrypoint pair, then set the value to the following
804 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
806 /** Get maximum number of profiles supported by the implementation */
807 int vaMaxNumProfiles (
811 /** Get maximum number of entrypoints supported by the implementation */
812 int vaMaxNumEntrypoints (
816 /** Get maximum number of attributs supported by the implementation */
817 int vaMaxNumConfigAttributes (
822 * Query supported profiles
823 * The caller must provide a "profile_list" array that can hold at
824 * least vaMaxNumProfile() entries. The actual number of profiles
825 * returned in "profile_list" is returned in "num_profile".
827 VAStatus vaQueryConfigProfiles (
829 VAProfile *profile_list, /* out */
830 int *num_profiles /* out */
834 * Query supported entrypoints for a given profile
835 * The caller must provide an "entrypoint_list" array that can hold at
836 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
837 * returned in "entrypoint_list" is returned in "num_entrypoints".
839 VAStatus vaQueryConfigEntrypoints (
842 VAEntrypoint *entrypoint_list, /* out */
843 int *num_entrypoints /* out */
847 * Get attributes for a given profile/entrypoint pair
848 * The caller must provide an "attrib_list" with all attributes to be
849 * retrieved. Upon return, the attributes in "attrib_list" have been
850 * updated with their value. Unknown attributes or attributes that are
851 * not supported for the given profile/entrypoint pair will have their
852 * value set to VA_ATTRIB_NOT_SUPPORTED
854 VAStatus vaGetConfigAttributes (
857 VAEntrypoint entrypoint,
858 VAConfigAttrib *attrib_list, /* in/out */
862 /** Generic ID type, can be re-typed for specific implementation */
863 typedef unsigned int VAGenericID;
865 typedef VAGenericID VAConfigID;
868 * Create a configuration for the video decode/encode/processing pipeline
869 * it passes in the attribute list that specifies the attributes it cares
870 * about, with the rest taking default values.
872 VAStatus vaCreateConfig (
875 VAEntrypoint entrypoint,
876 VAConfigAttrib *attrib_list,
878 VAConfigID *config_id /* out */
882 * Free resources associdated with a given config
884 VAStatus vaDestroyConfig (
890 * Query all attributes for a given configuration
891 * The profile of the configuration is returned in "profile"
892 * The entrypoint of the configuration is returned in "entrypoint"
893 * The caller must provide an "attrib_list" array that can hold at least
894 * vaMaxNumConfigAttributes() entries. The actual number of attributes
895 * returned in "attrib_list" is returned in "num_attribs"
897 VAStatus vaQueryConfigAttributes (
899 VAConfigID config_id,
900 VAProfile *profile, /* out */
901 VAEntrypoint *entrypoint, /* out */
902 VAConfigAttrib *attrib_list,/* out */
903 int *num_attribs /* out */
908 * Contexts and Surfaces
910 * Context represents a "virtual" video decode, encode or video processing
911 * pipeline. Surfaces are render targets for a given context. The data in the
912 * surfaces are not accessible to the client except if derived image is supported
913 * and the internal data format of the surface is implementation specific.
915 * Surfaces are provided as a hint of what surfaces will be used when the context
916 * is created through vaCreateContext(). A surface may be used by different contexts
917 * at the same time as soon as application can make sure the operations are synchronized
918 * between different contexts, e.g. a surface is used as the output of a decode context
919 * and the input of a video process context. Surfaces can only be destroyed after all
920 * contexts using these surfaces have been destroyed.
922 * Both contexts and surfaces are identified by unique IDs and its
923 * implementation specific internals are kept opaque to the clients
926 typedef VAGenericID VAContextID;
928 typedef VAGenericID VASurfaceID;
930 #define VA_INVALID_ID 0xffffffff
931 #define VA_INVALID_SURFACE VA_INVALID_ID
933 /** \brief Generic value types. */
935 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
936 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
937 VAGenericValueTypePointer, /**< Generic pointer type */
938 VAGenericValueTypeFunc /**< Pointer to function */
939 } VAGenericValueType;
941 /** \brief Generic function type. */
942 typedef void (*VAGenericFunc)(void);
944 /** \brief Generic value. */
945 typedef struct _VAGenericValue {
946 /** \brief Value type. See #VAGenericValueType. */
947 VAGenericValueType type;
948 /** \brief Value holder. */
950 /** \brief 32-bit signed integer. */
952 /** \brief 32-bit float. */
954 /** \brief Generic pointer. */
956 /** \brief Pointer to function. */
961 /** @name Surface attribute flags */
963 /** \brief Surface attribute is not supported. */
964 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
965 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
966 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
967 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
968 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
971 /** \brief Surface attribute types. */
973 VASurfaceAttribNone = 0,
975 * \brief Pixel format (fourcc).
977 * The value is meaningful as input to vaQuerySurfaceAttributes().
978 * If zero, the driver returns the optimal pixel format for the
979 * specified config. Otherwise, if non-zero, the value represents
980 * a pixel format (FOURCC) that is kept as is on output, if the
981 * driver supports it. Otherwise, the driver sets the value to
982 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
984 VASurfaceAttribPixelFormat,
985 /** \brief Minimal width in pixels (int, read-only). */
986 VASurfaceAttribMinWidth,
987 /** \brief Maximal width in pixels (int, read-only). */
988 VASurfaceAttribMaxWidth,
989 /** \brief Minimal height in pixels (int, read-only). */
990 VASurfaceAttribMinHeight,
991 /** \brief Maximal height in pixels (int, read-only). */
992 VASurfaceAttribMaxHeight,
993 /** \brief Surface memory type expressed in bit fields (int, read/write). */
994 VASurfaceAttribMemoryType,
995 /** \brief External buffer descriptor (pointer, write). */
996 VASurfaceAttribExternalBufferDescriptor,
997 /** \brief Surface usage hint, gives the driver a hint of intended usage
998 * to optimize allocation (e.g. tiling) (int, read/write). */
999 VASurfaceAttribUsageHint,
1000 /** \brief Number of surface attributes. */
1001 VASurfaceAttribCount
1002 } VASurfaceAttribType;
1004 /** \brief Surface attribute. */
1005 typedef struct _VASurfaceAttrib {
1007 VASurfaceAttribType type;
1008 /** \brief Flags. See "Surface attribute flags". */
1010 /** \brief Value. See "Surface attribute types" for the expected types. */
1011 VAGenericValue value;
1015 * @name VASurfaceAttribMemoryType values in bit fields.
1016 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1017 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1018 * types are defined in DRM and Android header files.
1021 /** \brief VA memory type (default) is supported. */
1022 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1023 /** \brief V4L2 buffer memory type is supported. */
1024 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1025 /** \brief User pointer memory type is supported. */
1026 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1030 * \brief VASurfaceAttribExternalBuffers structure for
1031 * the VASurfaceAttribExternalBufferDescriptor attribute.
1033 typedef struct _VASurfaceAttribExternalBuffers {
1034 /** \brief pixel format in fourcc. */
1035 uint32_t pixel_format;
1036 /** \brief width in pixels. */
1038 /** \brief height in pixels. */
1040 /** \brief total size of the buffer in bytes. */
1042 /** \brief number of planes for planar layout */
1043 uint32_t num_planes;
1044 /** \brief pitch for each plane in bytes */
1045 uint32_t pitches[4];
1046 /** \brief offset for each plane in bytes */
1047 uint32_t offsets[4];
1048 /** \brief buffer handles or user pointers */
1050 /** \brief number of elements in the "buffers" array */
1051 uint32_t num_buffers;
1052 /** \brief flags. See "Surface external buffer descriptor flags". */
1054 /** \brief reserved for passing private data */
1056 } VASurfaceAttribExternalBuffers;
1058 /** @name VASurfaceAttribExternalBuffers flags */
1060 /** \brief Enable memory tiling */
1061 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1062 /** \brief Memory is cacheable */
1063 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1064 /** \brief Memory is non-cacheable */
1065 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1066 /** \brief Memory is write-combined */
1067 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1068 /** \brief Memory is protected */
1069 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1071 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1073 /** \brief Surface usage not indicated. */
1074 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1075 /** \brief Surface used by video decoder. */
1076 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1077 /** \brief Surface used by video encoder. */
1078 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1079 /** \brief Surface read by video post-processing. */
1080 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1081 /** \brief Surface written by video post-processing. */
1082 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1083 /** \brief Surface used for display. */
1084 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1089 * \brief Queries surface attributes for the supplied config.
1091 * This function queries for all supported attributes for the
1092 * supplied VA @config. In particular, if the underlying hardware
1093 * supports the creation of VA surfaces in various formats, then
1094 * this function will enumerate all pixel formats that are supported.
1096 * The \c attrib_list array is allocated by the user and \c
1097 * num_attribs shall be initialized to the number of allocated
1098 * elements in that array. Upon successful return, the actual number
1099 * of attributes will be overwritten into \c num_attribs. Otherwise,
1100 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1101 * is adjusted to the number of elements that would be returned if
1102 * enough space was available.
1104 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1105 * argument when vaQuerySurfaceAttributes() is used to determine the
1106 * actual number of elements that need to be allocated.
1108 * @param[in] dpy the VA display
1109 * @param[in] config the config identifying a codec or a video
1110 * processing pipeline
1111 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1112 * @param[in,out] num_attribs the number of elements allocated on
1113 * input, the number of elements actually filled in output
1116 vaQuerySurfaceAttributes(
1119 VASurfaceAttrib *attrib_list,
1120 unsigned int *num_attribs
1124 * \brief Creates an array of surfaces
1126 * Creates an array of surfaces. The optional list of attributes shall
1127 * be constructed based on what the underlying hardware could expose
1128 * through vaQuerySurfaceAttributes().
1130 * @param[in] dpy the VA display
1131 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1132 * @param[in] width the surface width
1133 * @param[in] height the surface height
1134 * @param[out] surfaces the array of newly created surfaces
1135 * @param[in] num_surfaces the number of surfaces to create
1136 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1137 * @param[in] num_attribs the number of attributes supplied in
1138 * \c attrib_list, or zero
1143 unsigned int format,
1145 unsigned int height,
1146 VASurfaceID *surfaces,
1147 unsigned int num_surfaces,
1148 VASurfaceAttrib *attrib_list,
1149 unsigned int num_attribs
1153 * vaDestroySurfaces - Destroy resources associated with surfaces.
1154 * Surfaces can only be destroyed after all contexts using these surfaces have been
1157 * surfaces: array of surfaces to destroy
1158 * num_surfaces: number of surfaces in the array to be destroyed.
1160 VAStatus vaDestroySurfaces (
1162 VASurfaceID *surfaces,
1166 #define VA_PROGRESSIVE 0x1
1168 * vaCreateContext - Create a context
1170 * config_id: configuration for the context
1171 * picture_width: coded picture width
1172 * picture_height: coded picture height
1173 * flag: any combination of the following:
1174 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1175 * render_targets: a hint for render targets (surfaces) tied to the context
1176 * num_render_targets: number of render targets in the above array
1177 * context: created context id upon return
1179 VAStatus vaCreateContext (
1181 VAConfigID config_id,
1185 VASurfaceID *render_targets,
1186 int num_render_targets,
1187 VAContextID *context /* out */
1191 * vaDestroyContext - Destroy a context
1193 * context: context to be destroyed
1195 VAStatus vaDestroyContext (
1200 //Multi-frame context
1201 typedef VAGenericID VAMFContextID;
1203 * vaCreateMFContext - Create a multi-frame context
1204 * interface encapsulating common for all streams memory objects and structures
1205 * required for single GPU task submission from several VAContextID's.
1206 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1207 * Support identification: Application can identify multi-frame feature support by ability
1208 * to create multi-frame context. If driver supports multi-frame - call successful,
1209 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1210 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1212 * VA_STATUS_SUCCESS - operation successful.
1213 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1214 * dpy: display adapter.
1215 * mf_context: Multi-Frame context encapsulating all associated context
1216 * for multi-frame submission.
1218 VAStatus vaCreateMFContext (
1220 VAMFContextID *mf_context /* out */
1224 * vaMFAddContext - Provide ability to associate each context used for
1225 * Multi-Frame submission and common Multi-Frame context.
1226 * Try to add context to understand if it is supported.
1227 * Allocation: this call allocates and/or reallocates all memory objects
1228 * common for all contexts associated with particular Multi-Frame context.
1229 * All memory required for each context(pixel buffers, internal driver
1230 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1231 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1232 * first context added will set entry point/profile for whole Multi-Frame context,
1233 * all other entry points and profiles can be rejected to be added.
1235 * VA_STATUS_SUCCESS - operation successful, context was added.
1236 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1237 * current mf_context and associated contexts and start working with new ones.
1238 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1239 * 1 - mf_context is not valid context or
1240 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1241 * and current context contradicts with previously added, application can continue with current mf_context
1242 * and other contexts passed this call, rejected context can continue work in stand-alone
1243 * mode or other mf_context.
1244 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1245 * unsupported VAEntrypoint. Application can continue with current mf_context
1246 * and other contexts passed this call, rejected context can continue work in stand-alone
1248 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1249 * but VAProfile is not supported. Application can continue with current mf_context
1250 * and other contexts passed this call, rejected context can continue work in stand-alone
1252 * dpy: display adapter.
1253 * context: context being associated with Multi-Frame context.
1254 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1256 VAStatus vaMFAddContext (
1258 VAMFContextID mf_context,
1263 * vaMFReleaseContext - Removes context from multi-frame and
1264 * association with multi-frame context.
1265 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1267 * VA_STATUS_SUCCESS - operation successful, context was removed.
1268 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1269 * application need to destroy this VAMFContextID and all assotiated VAContextID
1271 * mf_context: VAMFContextID where context is added
1272 * context: VAContextID to be added
1274 VAStatus vaMFReleaseContext (
1276 VAMFContextID mf_context,
1282 * Buffers are used to pass various types of data from the
1283 * client to the server. The server maintains a data store
1284 * for each buffer created, and the client idenfies a buffer
1285 * through a unique buffer id assigned by the server.
1288 typedef VAGenericID VABufferID;
1292 VAPictureParameterBufferType = 0,
1293 VAIQMatrixBufferType = 1,
1294 VABitPlaneBufferType = 2,
1295 VASliceGroupMapBufferType = 3,
1296 VASliceParameterBufferType = 4,
1297 VASliceDataBufferType = 5,
1298 VAMacroblockParameterBufferType = 6,
1299 VAResidualDataBufferType = 7,
1300 VADeblockingParameterBufferType = 8,
1301 VAImageBufferType = 9,
1302 VAProtectedSliceDataBufferType = 10,
1303 VAQMatrixBufferType = 11,
1304 VAHuffmanTableBufferType = 12,
1305 VAProbabilityBufferType = 13,
1307 /* Following are encode buffer types */
1308 VAEncCodedBufferType = 21,
1309 VAEncSequenceParameterBufferType = 22,
1310 VAEncPictureParameterBufferType = 23,
1311 VAEncSliceParameterBufferType = 24,
1312 VAEncPackedHeaderParameterBufferType = 25,
1313 VAEncPackedHeaderDataBufferType = 26,
1314 VAEncMiscParameterBufferType = 27,
1315 VAEncMacroblockParameterBufferType = 28,
1316 VAEncMacroblockMapBufferType = 29,
1319 * \brief Encoding QP buffer
1321 * This buffer contains QP per MB for encoding. Currently
1322 * VAEncQPBufferH264 is defined for H.264 encoding, see
1323 * #VAEncQPBufferH264 for details
1325 VAEncQPBufferType = 30,
1326 /* Following are video processing buffer types */
1328 * \brief Video processing pipeline parameter buffer.
1330 * This buffer describes the video processing pipeline. See
1331 * #VAProcPipelineParameterBuffer for details.
1333 VAProcPipelineParameterBufferType = 41,
1335 * \brief Video filter parameter buffer.
1337 * This buffer describes the video filter parameters. All buffers
1338 * inherit from #VAProcFilterParameterBufferBase, thus including
1339 * a unique filter buffer type.
1341 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1342 * Filters requiring advanced parameters include, but are not limited to,
1343 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1344 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1346 VAProcFilterParameterBufferType = 42,
1348 * \brief FEI specific buffer types
1350 VAEncFEIMVBufferType = 43,
1351 VAEncFEIMBCodeBufferType = 44,
1352 VAEncFEIDistortionBufferType = 45,
1353 VAEncFEIMBControlBufferType = 46,
1354 VAEncFEIMVPredictorBufferType = 47,
1360 VAEncMiscParameterTypeFrameRate = 0,
1361 VAEncMiscParameterTypeRateControl = 1,
1362 VAEncMiscParameterTypeMaxSliceSize = 2,
1363 VAEncMiscParameterTypeAIR = 3,
1364 /** \brief Buffer type used to express a maximum frame size (in bits). */
1365 VAEncMiscParameterTypeMaxFrameSize = 4,
1366 /** \brief Buffer type used for HRD parameters. */
1367 VAEncMiscParameterTypeHRD = 5,
1368 VAEncMiscParameterTypeQualityLevel = 6,
1369 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1370 * rate control, when the user has externally skipped frames. */
1371 VAEncMiscParameterTypeSkipFrame = 9,
1372 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1373 VAEncMiscParameterTypeROI = 10,
1374 /** \brief Buffer type used for temporal layer structure */
1375 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1376 /** \brief Buffer type used for FEI input frame level parameters */
1377 VAEncMiscParameterTypeFEIFrameControl = 18,
1378 } VAEncMiscParameterType;
1380 /** \brief Packed header type. */
1382 /** \brief Packed sequence header. */
1383 VAEncPackedHeaderSequence = 1,
1384 /** \brief Packed picture header. */
1385 VAEncPackedHeaderPicture = 2,
1386 /** \brief Packed slice header. */
1387 VAEncPackedHeaderSlice = 3,
1389 * \brief Packed raw header.
1391 * Packed raw data header can be used by the client to insert a header
1392 * into the bitstream data buffer at the point it is passed, the driver
1393 * will handle the raw packed header based on "has_emulation_bytes" field
1394 * in the packed header parameter structure.
1396 VAEncPackedHeaderRawData = 4,
1398 * \brief Misc packed header. See codec-specific definitions.
1401 * This is a deprecated packed header type. All applications can use
1402 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1404 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1405 } VAEncPackedHeaderType;
1407 /** \brief Packed header parameter. */
1408 typedef struct _VAEncPackedHeaderParameterBuffer {
1409 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1411 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1412 uint32_t bit_length;
1413 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1414 uint8_t has_emulation_bytes;
1416 /** \brief Reserved bytes for future use, must be zero */
1417 uint32_t va_reserved[VA_PADDING_LOW];
1418 } VAEncPackedHeaderParameterBuffer;
1421 * For application, e.g. set a new bitrate
1422 * VABufferID buf_id;
1423 * VAEncMiscParameterBuffer *misc_param;
1424 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1426 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1427 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1428 * 1, NULL, &buf_id);
1430 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1431 * misc_param->type = VAEncMiscParameterTypeRateControl;
1432 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1433 * misc_rate_ctrl->bits_per_second = 6400000;
1434 * vaUnmapBuffer(dpy, buf_id);
1435 * vaRenderPicture(dpy, context, &buf_id, 1);
1437 typedef struct _VAEncMiscParameterBuffer
1439 VAEncMiscParameterType type;
1441 } VAEncMiscParameterBuffer;
1443 /** \brief Temporal layer Structure*/
1444 typedef struct _VAEncMiscParameterTemporalLayerStructure
1446 /** \brief The number of temporal layers */
1447 uint32_t number_of_layers;
1448 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1449 uint32_t periodicity;
1451 * \brief The array indicating the layer id for each frame
1453 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1454 * ids for frames starting from the 2nd frame.
1456 uint32_t layer_id[32];
1458 /** \brief Reserved bytes for future use, must be zero */
1459 uint32_t va_reserved[VA_PADDING_LOW];
1460 } VAEncMiscParameterTemporalLayerStructure;
1463 /** \brief Rate control parameters */
1464 typedef struct _VAEncMiscParameterRateControl
1466 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1467 uint32_t bits_per_second;
1468 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1469 * bit-rate for example if target_percentage is 95 then the rate control will target
1470 * a bit-rate that is 95% of the maximum bit-rate
1472 uint32_t target_percentage;
1473 /* windows size in milliseconds. For example if this is set to 500,
1474 * then the rate control will guarantee the target bit-rate over a 500 ms window
1476 uint32_t window_size;
1477 /* initial QP at I frames */
1478 uint32_t initial_qp;
1480 uint32_t basic_unit_size;
1486 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1487 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1488 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1490 * The temporal layer that the rate control parameters are specified for.
1492 uint32_t temporal_id : 8;
1493 /** \brief Reserved for future use, must be zero */
1494 uint32_t reserved : 17;
1499 /** \brief Reserved bytes for future use, must be zero */
1500 uint32_t va_reserved[VA_PADDING_MEDIUM];
1501 } VAEncMiscParameterRateControl;
1503 typedef struct _VAEncMiscParameterFrameRate
1506 * The framerate is specified as a number of frames per second, as a
1507 * fraction. The denominator of the fraction is given in the top half
1508 * (the high two bytes) of the framerate field, and the numerator is
1509 * given in the bottom half (the low two bytes).
1512 * denominator = framerate >> 16 & 0xffff;
1513 * numerator = framerate & 0xffff;
1514 * fps = numerator / denominator;
1516 * For example, if framerate is set to (100 << 16 | 750), this is
1517 * 750 / 100, hence 7.5fps.
1519 * If the denominator is zero (the high two bytes are both zero) then
1520 * it takes the value one instead, so the framerate is just the integer
1521 * in the low 2 bytes.
1529 * The temporal id the framerate parameters are specified for.
1531 uint32_t temporal_id : 8;
1532 uint32_t reserved : 24;
1537 /** \brief Reserved bytes for future use, must be zero */
1538 uint32_t va_reserved[VA_PADDING_LOW];
1539 } VAEncMiscParameterFrameRate;
1542 * Allow a maximum slice size to be specified (in bits).
1543 * The encoder will attempt to make sure that individual slices do not exceed this size
1544 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1546 typedef struct _VAEncMiscParameterMaxSliceSize
1548 uint32_t max_slice_size;
1550 /** \brief Reserved bytes for future use, must be zero */
1551 uint32_t va_reserved[VA_PADDING_LOW];
1552 } VAEncMiscParameterMaxSliceSize;
1554 typedef struct _VAEncMiscParameterAIR
1556 uint32_t air_num_mbs;
1557 uint32_t air_threshold;
1558 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1560 /** \brief Reserved bytes for future use, must be zero */
1561 uint32_t va_reserved[VA_PADDING_LOW];
1562 } VAEncMiscParameterAIR;
1564 typedef struct _VAEncMiscParameterHRD
1566 uint32_t initial_buffer_fullness; /* in bits */
1567 uint32_t buffer_size; /* in bits */
1569 /** \brief Reserved bytes for future use, must be zero */
1570 uint32_t va_reserved[VA_PADDING_LOW];
1571 } VAEncMiscParameterHRD;
1574 * \brief Defines a maximum frame size (in bits).
1576 * This misc parameter buffer defines the maximum size of a frame (in
1577 * bits). The encoder will try to make sure that each frame does not
1578 * exceed this size. Otherwise, if the frame size exceeds this size,
1579 * the \c status flag of #VACodedBufferSegment will contain
1580 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1582 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1583 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1584 VAEncMiscParameterType type;
1585 /** \brief Maximum size of a frame (in bits). */
1586 uint32_t max_frame_size;
1588 /** \brief Reserved bytes for future use, must be zero */
1589 uint32_t va_reserved[VA_PADDING_LOW];
1590 } VAEncMiscParameterBufferMaxFrameSize;
1593 * \brief Encoding quality level.
1595 * The encoding quality could be set through this structure, if the implementation
1596 * supports multiple quality levels. The quality level set through this structure is
1597 * persistent over the entire coded sequence, or until a new structure is being sent.
1598 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1599 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1600 * quality. The quality level setting is used as a trade-off between quality and speed/power
1601 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1603 typedef struct _VAEncMiscParameterBufferQualityLevel {
1604 /** \brief Encoding quality level setting. When set to 0, default quality
1607 uint32_t quality_level;
1609 /** \brief Reserved bytes for future use, must be zero */
1610 uint32_t va_reserved[VA_PADDING_LOW];
1611 } VAEncMiscParameterBufferQualityLevel;
1614 * \brief Encoding skip frame.
1616 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1617 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1618 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1619 * current frame. It is allowed for the application to still send in packed headers for the driver to
1620 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1622 typedef struct _VAEncMiscParameterSkipFrame {
1623 /** \brief Indicates skip frames as below.
1624 * 0: Encode as normal, no skip.
1625 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1626 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1627 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1628 * in VAEncPackedHeaderPicture). */
1629 uint8_t skip_frame_flag;
1630 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1631 uint8_t num_skip_frames;
1632 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1633 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1634 uint32_t size_skip_frames;
1636 /** \brief Reserved bytes for future use, must be zero */
1637 uint32_t va_reserved[VA_PADDING_LOW];
1638 } VAEncMiscParameterSkipFrame;
1641 * \brief Encoding region-of-interest (ROI).
1643 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1644 * supports ROI input. The ROI set through this structure is applicable only to the
1645 * current frame or field, so must be sent every frame or field to be applied. The number of
1646 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1647 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1649 typedef struct _VAEncROI
1651 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1652 * codec coding units. It is relative to frame coordinates for the frame case and
1653 * to field coordinates for the field case. */
1654 VARectangle roi_rectangle;
1658 * \ref roi_value specifies ROI delta QP or ROI priority.
1659 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1660 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1661 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1662 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1663 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1664 * regions, the roi_value that is first in the ROI array will have priority.
1666 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1667 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1669 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1670 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1671 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1676 typedef struct _VAEncMiscParameterBufferROI {
1677 /** \brief Number of ROIs being sent.*/
1680 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1681 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1683 int8_t max_delta_qp;
1684 int8_t min_delta_qp;
1686 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1687 * coordinates for the frame case and to field coordinates for the field case.*/
1692 * \brief An indication for roi value.
1694 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1695 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1696 * in #VAEncROI should be used as ROI priority.
1698 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1699 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
1700 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1701 * when VAConfigAttribRateControl == VA_RC_CQP.
1703 uint32_t roi_value_is_qp_delta : 1;
1704 uint32_t reserved : 31;
1709 /** \brief Reserved bytes for future use, must be zero */
1710 uint32_t va_reserved[VA_PADDING_LOW];
1711 } VAEncMiscParameterBufferROI;
1714 * There will be cases where the bitstream buffer will not have enough room to hold
1715 * the data for the entire slice, and the following flags will be used in the slice
1716 * parameter to signal to the server for the possible cases.
1717 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1718 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1719 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1721 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1722 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1723 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1724 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1726 /* Codec-independent Slice Parameter Buffer base */
1727 typedef struct _VASliceParameterBufferBase
1729 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
1730 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
1731 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1732 } VASliceParameterBufferBase;
1734 /**********************************
1735 * JPEG common data structures
1736 **********************************/
1738 * \brief Huffman table for JPEG decoding.
1740 * This structure holds the complete Huffman tables. This is an
1741 * aggregation of all Huffman table (DHT) segments maintained by the
1742 * application. i.e. up to 2 Huffman tables are stored in there for
1745 * The #load_huffman_table array can be used as a hint to notify the
1746 * VA driver implementation about which table(s) actually changed
1747 * since the last submission of this buffer.
1749 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1750 /** \brief Specifies which #huffman_table is valid. */
1751 uint8_t load_huffman_table[2];
1752 /** \brief Huffman tables indexed by table identifier (Th). */
1754 /** @name DC table (up to 12 categories) */
1756 /** \brief Number of Huffman codes of length i + 1 (Li). */
1757 uint8_t num_dc_codes[16];
1758 /** \brief Value associated with each Huffman code (Vij). */
1759 uint8_t dc_values[12];
1761 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1763 /** \brief Number of Huffman codes of length i + 1 (Li). */
1764 uint8_t num_ac_codes[16];
1765 /** \brief Value associated with each Huffman code (Vij). */
1766 uint8_t ac_values[162];
1767 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1772 /** \brief Reserved bytes for future use, must be zero */
1773 uint32_t va_reserved[VA_PADDING_LOW];
1774 } VAHuffmanTableBufferJPEGBaseline;
1776 /****************************
1777 * MPEG-2 data structures
1778 ****************************/
1780 /* MPEG-2 Picture Parameter Buffer */
1782 * For each frame or field, and before any slice data, a single
1783 * picture parameter buffer must be send.
1785 typedef struct _VAPictureParameterBufferMPEG2
1787 uint16_t horizontal_size;
1788 uint16_t vertical_size;
1789 VASurfaceID forward_reference_picture;
1790 VASurfaceID backward_reference_picture;
1791 /* meanings of the following fields are the same as in the standard */
1792 int32_t picture_coding_type;
1793 int32_t f_code; /* pack all four fcode into this */
1796 uint32_t intra_dc_precision : 2;
1797 uint32_t picture_structure : 2;
1798 uint32_t top_field_first : 1;
1799 uint32_t frame_pred_frame_dct : 1;
1800 uint32_t concealment_motion_vectors : 1;
1801 uint32_t q_scale_type : 1;
1802 uint32_t intra_vlc_format : 1;
1803 uint32_t alternate_scan : 1;
1804 uint32_t repeat_first_field : 1;
1805 uint32_t progressive_frame : 1;
1806 uint32_t is_first_field : 1; /* indicate whether the current field
1807 * is the first field for field picture
1811 } picture_coding_extension;
1813 /** \brief Reserved bytes for future use, must be zero */
1814 uint32_t va_reserved[VA_PADDING_LOW];
1815 } VAPictureParameterBufferMPEG2;
1817 /** MPEG-2 Inverse Quantization Matrix Buffer */
1818 typedef struct _VAIQMatrixBufferMPEG2
1820 /** \brief Same as the MPEG-2 bitstream syntax element. */
1821 int32_t load_intra_quantiser_matrix;
1822 /** \brief Same as the MPEG-2 bitstream syntax element. */
1823 int32_t load_non_intra_quantiser_matrix;
1824 /** \brief Same as the MPEG-2 bitstream syntax element. */
1825 int32_t load_chroma_intra_quantiser_matrix;
1826 /** \brief Same as the MPEG-2 bitstream syntax element. */
1827 int32_t load_chroma_non_intra_quantiser_matrix;
1828 /** \brief Luminance intra matrix, in zig-zag scan order. */
1829 uint8_t intra_quantiser_matrix[64];
1830 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1831 uint8_t non_intra_quantiser_matrix[64];
1832 /** \brief Chroma intra matrix, in zig-zag scan order. */
1833 uint8_t chroma_intra_quantiser_matrix[64];
1834 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1835 uint8_t chroma_non_intra_quantiser_matrix[64];
1837 /** \brief Reserved bytes for future use, must be zero */
1838 uint32_t va_reserved[VA_PADDING_LOW];
1839 } VAIQMatrixBufferMPEG2;
1841 /** MPEG-2 Slice Parameter Buffer */
1842 typedef struct _VASliceParameterBufferMPEG2
1844 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1845 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1846 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1847 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1848 uint32_t slice_horizontal_position;
1849 uint32_t slice_vertical_position;
1850 int32_t quantiser_scale_code;
1851 int32_t intra_slice_flag;
1853 /** \brief Reserved bytes for future use, must be zero */
1854 uint32_t va_reserved[VA_PADDING_LOW];
1855 } VASliceParameterBufferMPEG2;
1857 /** MPEG-2 Macroblock Parameter Buffer */
1858 typedef struct _VAMacroblockParameterBufferMPEG2
1860 uint16_t macroblock_address;
1862 * macroblock_address (in raster scan order)
1864 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1866 uint8_t macroblock_type; /* see definition below */
1869 uint32_t frame_motion_type : 2;
1870 uint32_t field_motion_type : 2;
1871 uint32_t dct_type : 1;
1875 uint8_t motion_vertical_field_select;
1877 * motion_vertical_field_select:
1878 * see section 6.3.17.2 in the spec
1879 * only the lower 4 bits are used
1880 * bit 0: first vector forward
1881 * bit 1: first vector backward
1882 * bit 2: second vector forward
1883 * bit 3: second vector backward
1885 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
1886 uint16_t coded_block_pattern;
1888 * The bitplanes for coded_block_pattern are described
1889 * in Figure 6.10-12 in the spec
1892 /* Number of skipped macroblocks after this macroblock */
1893 uint16_t num_skipped_macroblocks;
1895 /** \brief Reserved bytes for future use, must be zero */
1896 uint32_t va_reserved[VA_PADDING_LOW];
1897 } VAMacroblockParameterBufferMPEG2;
1900 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1902 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1903 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1904 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1905 #define VA_MB_TYPE_MOTION_INTRA 0x10
1908 * MPEG-2 Residual Data Buffer
1909 * For each macroblock, there wil be 64 shorts (16-bit) in the
1910 * residual data buffer
1913 /****************************
1914 * MPEG-4 Part 2 data structures
1915 ****************************/
1917 /* MPEG-4 Picture Parameter Buffer */
1919 * For each frame or field, and before any slice data, a single
1920 * picture parameter buffer must be send.
1922 typedef struct _VAPictureParameterBufferMPEG4
1925 uint16_t vop_height;
1926 VASurfaceID forward_reference_picture;
1927 VASurfaceID backward_reference_picture;
1930 uint32_t short_video_header : 1;
1931 uint32_t chroma_format : 2;
1932 uint32_t interlaced : 1;
1933 uint32_t obmc_disable : 1;
1934 uint32_t sprite_enable : 2;
1935 uint32_t sprite_warping_accuracy : 2;
1936 uint32_t quant_type : 1;
1937 uint32_t quarter_sample : 1;
1938 uint32_t data_partitioned : 1;
1939 uint32_t reversible_vlc : 1;
1940 uint32_t resync_marker_disable : 1;
1944 uint8_t no_of_sprite_warping_points;
1945 int16_t sprite_trajectory_du[3];
1946 int16_t sprite_trajectory_dv[3];
1947 uint8_t quant_precision;
1950 uint32_t vop_coding_type : 2;
1951 uint32_t backward_reference_vop_coding_type : 2;
1952 uint32_t vop_rounding_type : 1;
1953 uint32_t intra_dc_vlc_thr : 3;
1954 uint32_t top_field_first : 1;
1955 uint32_t alternate_vertical_scan_flag : 1;
1959 uint8_t vop_fcode_forward;
1960 uint8_t vop_fcode_backward;
1961 uint16_t vop_time_increment_resolution;
1962 /* short header related */
1963 uint8_t num_gobs_in_vop;
1964 uint8_t num_macroblocks_in_gob;
1965 /* for direct mode prediction */
1969 /** \brief Reserved bytes for future use, must be zero */
1970 uint32_t va_reserved[VA_PADDING_LOW];
1971 } VAPictureParameterBufferMPEG4;
1973 /** MPEG-4 Inverse Quantization Matrix Buffer */
1974 typedef struct _VAIQMatrixBufferMPEG4
1976 /** Same as the MPEG-4:2 bitstream syntax element. */
1977 int32_t load_intra_quant_mat;
1978 /** Same as the MPEG-4:2 bitstream syntax element. */
1979 int32_t load_non_intra_quant_mat;
1980 /** The matrix for intra blocks, in zig-zag scan order. */
1981 uint8_t intra_quant_mat[64];
1982 /** The matrix for non-intra blocks, in zig-zag scan order. */
1983 uint8_t non_intra_quant_mat[64];
1985 /** \brief Reserved bytes for future use, must be zero */
1986 uint32_t va_reserved[VA_PADDING_LOW];
1987 } VAIQMatrixBufferMPEG4;
1989 /** MPEG-4 Slice Parameter Buffer */
1990 typedef struct _VASliceParameterBufferMPEG4
1992 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1993 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1994 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1995 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1996 uint32_t macroblock_number;
1997 int32_t quant_scale;
1999 /** \brief Reserved bytes for future use, must be zero */
2000 uint32_t va_reserved[VA_PADDING_LOW];
2001 } VASliceParameterBufferMPEG4;
2004 VC-1 data structures
2007 typedef enum /* see 7.1.1.32 */
2010 VAMvMode1MvHalfPel = 1,
2011 VAMvMode1MvHalfPelBilinear = 2,
2012 VAMvModeMixedMv = 3,
2013 VAMvModeIntensityCompensation = 4
2016 /** VC-1 Picture Parameter Buffer */
2018 * For each picture, and before any slice data, a picture parameter
2019 * buffer must be send. Multiple picture parameter buffers may be
2020 * sent for a single picture. In that case picture parameters will
2021 * apply to all slice data that follow it until a new picture
2022 * parameter buffer is sent.
2025 * pic_quantizer_type should be set to the applicable quantizer
2026 * type as defined by QUANTIZER (J.1.19) and either
2027 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2029 typedef struct _VAPictureParameterBufferVC1
2031 VASurfaceID forward_reference_picture;
2032 VASurfaceID backward_reference_picture;
2033 /* if out-of-loop post-processing is done on the render
2034 target, then we need to keep the in-loop decoded
2035 picture as a reference picture */
2036 VASurfaceID inloop_decoded_picture;
2038 /* sequence layer for AP or meta data for SP and MP */
2041 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2042 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2043 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2044 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2045 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2046 uint32_t multires : 1; /* METADATA::MULTIRES */
2047 uint32_t overlap : 1; /* METADATA::OVERLAP */
2048 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2049 uint32_t rangered : 1; /* METADATA::RANGERED */
2050 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2051 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2056 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2057 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2060 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2061 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2062 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2063 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2066 } entrypoint_fields;
2067 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2068 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2071 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2072 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2073 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2074 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2077 } range_mapping_fields;
2079 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2080 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2081 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2082 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2083 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2084 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2085 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2086 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2087 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2091 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2092 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2093 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2094 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2095 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2101 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2102 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2103 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2104 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2105 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2106 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2107 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2113 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2114 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2115 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2116 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2117 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2118 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2119 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2122 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2125 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2126 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2127 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2128 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2134 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2135 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2136 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2137 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2138 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2139 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2140 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2141 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2142 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2143 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2149 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2150 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2151 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2152 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2153 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2154 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2155 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2156 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2157 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2158 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2159 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2162 } pic_quantizer_fields;
2165 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2166 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2167 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2168 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2169 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2170 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2175 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2176 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2177 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2179 /** \brief Reserved bytes for future use, must be zero */
2180 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2181 } VAPictureParameterBufferVC1;
2183 /** VC-1 Bitplane Buffer
2184 There will be at most three bitplanes coded in any picture header. To send
2185 the bitplane data more efficiently, each byte is divided in two nibbles, with
2186 each nibble carrying three bitplanes for one macroblock. The following table
2187 shows the bitplane data arrangement within each nibble based on the picture
2190 Picture Type Bit3 Bit2 Bit1 Bit0
2191 I or BI OVERFLAGS ACPRED FIELDTX
2192 P MYTYPEMB SKIPMB DIRECTMB
2193 B FORWARDMB SKIPMB DIRECTMB
2195 Within each byte, the lower nibble is for the first MB and the upper nibble is
2196 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2197 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2198 Macroblock #2 in the first row.
2201 /* VC-1 Slice Parameter Buffer */
2202 typedef struct _VASliceParameterBufferVC1
2204 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2205 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2206 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2207 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2208 uint32_t slice_vertical_position;
2210 /** \brief Reserved bytes for future use, must be zero */
2211 uint32_t va_reserved[VA_PADDING_LOW];
2212 } VASliceParameterBufferVC1;
2214 /* VC-1 Slice Data Buffer */
2216 This is simplely a buffer containing raw bit-stream bytes
2219 /****************************
2220 * H.264/AVC data structures
2221 ****************************/
2223 typedef struct _VAPictureH264
2225 VASurfaceID picture_id;
2228 int32_t TopFieldOrderCnt;
2229 int32_t BottomFieldOrderCnt;
2231 /** \brief Reserved bytes for future use, must be zero */
2232 uint32_t va_reserved[VA_PADDING_LOW];
2234 /* flags in VAPictureH264 could be OR of the following */
2235 #define VA_PICTURE_H264_INVALID 0x00000001
2236 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2237 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2238 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2239 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2241 /** H.264 Picture Parameter Buffer */
2243 * For each picture, and before any slice data, a single
2244 * picture parameter buffer must be send.
2246 typedef struct _VAPictureParameterBufferH264
2248 VAPictureH264 CurrPic;
2249 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2250 uint16_t picture_width_in_mbs_minus1;
2251 uint16_t picture_height_in_mbs_minus1;
2252 uint8_t bit_depth_luma_minus8;
2253 uint8_t bit_depth_chroma_minus8;
2254 uint8_t num_ref_frames;
2257 uint32_t chroma_format_idc : 2;
2258 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2259 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2260 uint32_t frame_mbs_only_flag : 1;
2261 uint32_t mb_adaptive_frame_field_flag : 1;
2262 uint32_t direct_8x8_inference_flag : 1;
2263 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2264 uint32_t log2_max_frame_num_minus4 : 4;
2265 uint32_t pic_order_cnt_type : 2;
2266 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2267 uint32_t delta_pic_order_always_zero_flag : 1;
2271 // FMO is not supported.
2272 va_deprecated uint8_t num_slice_groups_minus1;
2273 va_deprecated uint8_t slice_group_map_type;
2274 va_deprecated uint16_t slice_group_change_rate_minus1;
2275 int8_t pic_init_qp_minus26;
2276 int8_t pic_init_qs_minus26;
2277 int8_t chroma_qp_index_offset;
2278 int8_t second_chroma_qp_index_offset;
2281 uint32_t entropy_coding_mode_flag : 1;
2282 uint32_t weighted_pred_flag : 1;
2283 uint32_t weighted_bipred_idc : 2;
2284 uint32_t transform_8x8_mode_flag : 1;
2285 uint32_t field_pic_flag : 1;
2286 uint32_t constrained_intra_pred_flag : 1;
2287 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2288 uint32_t deblocking_filter_control_present_flag : 1;
2289 uint32_t redundant_pic_cnt_present_flag : 1;
2290 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2296 /** \brief Reserved bytes for future use, must be zero */
2297 uint32_t va_reserved[VA_PADDING_MEDIUM];
2298 } VAPictureParameterBufferH264;
2300 /** H.264 Inverse Quantization Matrix Buffer */
2301 typedef struct _VAIQMatrixBufferH264
2303 /** \brief 4x4 scaling list, in raster scan order. */
2304 uint8_t ScalingList4x4[6][16];
2305 /** \brief 8x8 scaling list, in raster scan order. */
2306 uint8_t ScalingList8x8[2][64];
2308 /** \brief Reserved bytes for future use, must be zero */
2309 uint32_t va_reserved[VA_PADDING_LOW];
2310 } VAIQMatrixBufferH264;
2312 /** H.264 Slice Parameter Buffer */
2313 typedef struct _VASliceParameterBufferH264
2315 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2316 /** \brief Byte offset to the NAL Header Unit for this slice. */
2317 uint32_t slice_data_offset;
2318 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2320 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2322 * This bit offset is relative to and includes the NAL unit byte
2323 * and represents the number of bits parsed in the slice_header()
2324 * after the removal of any emulation prevention bytes in
2325 * there. However, the slice data buffer passed to the hardware is
2326 * the original bitstream, thus including any emulation prevention
2329 uint16_t slice_data_bit_offset;
2330 uint16_t first_mb_in_slice;
2332 uint8_t direct_spatial_mv_pred_flag;
2334 * H264/AVC syntax element
2336 * if num_ref_idx_active_override_flag equals 0, host decoder should
2337 * set its value to num_ref_idx_l0_default_active_minus1.
2339 uint8_t num_ref_idx_l0_active_minus1;
2341 * H264/AVC syntax element
2343 * if num_ref_idx_active_override_flag equals 0, host decoder should
2344 * set its value to num_ref_idx_l1_default_active_minus1.
2346 uint8_t num_ref_idx_l1_active_minus1;
2347 uint8_t cabac_init_idc;
2348 int8_t slice_qp_delta;
2349 uint8_t disable_deblocking_filter_idc;
2350 int8_t slice_alpha_c0_offset_div2;
2351 int8_t slice_beta_offset_div2;
2352 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2353 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2354 uint8_t luma_log2_weight_denom;
2355 uint8_t chroma_log2_weight_denom;
2356 uint8_t luma_weight_l0_flag;
2357 int16_t luma_weight_l0[32];
2358 int16_t luma_offset_l0[32];
2359 uint8_t chroma_weight_l0_flag;
2360 int16_t chroma_weight_l0[32][2];
2361 int16_t chroma_offset_l0[32][2];
2362 uint8_t luma_weight_l1_flag;
2363 int16_t luma_weight_l1[32];
2364 int16_t luma_offset_l1[32];
2365 uint8_t chroma_weight_l1_flag;
2366 int16_t chroma_weight_l1[32][2];
2367 int16_t chroma_offset_l1[32][2];
2369 /** \brief Reserved bytes for future use, must be zero */
2370 uint32_t va_reserved[VA_PADDING_LOW];
2371 } VASliceParameterBufferH264;
2373 /****************************
2374 * Common encode data structures
2375 ****************************/
2378 VAEncPictureTypeIntra = 0,
2379 VAEncPictureTypePredictive = 1,
2380 VAEncPictureTypeBidirectional = 2,
2383 /* Encode Slice Parameter Buffer */
2384 typedef struct _VAEncSliceParameterBuffer
2386 uint32_t start_row_number; /* starting MB row number for this slice */
2387 uint32_t slice_height; /* slice height measured in MB */
2390 uint32_t is_intra : 1;
2391 uint32_t disable_deblocking_filter_idc : 2;
2392 uint32_t uses_long_term_ref :1;
2393 uint32_t is_long_term_ref :1;
2398 /** \brief Reserved bytes for future use, must be zero */
2399 uint32_t va_reserved[VA_PADDING_LOW];
2400 } VAEncSliceParameterBuffer;
2403 /****************************
2404 * H.263 specific encode data structures
2405 ****************************/
2407 typedef struct _VAEncSequenceParameterBufferH263
2409 uint32_t intra_period;
2410 uint32_t bits_per_second;
2411 uint32_t frame_rate;
2412 uint32_t initial_qp;
2415 /** \brief Reserved bytes for future use, must be zero */
2416 uint32_t va_reserved[VA_PADDING_LOW];
2417 } VAEncSequenceParameterBufferH263;
2419 typedef struct _VAEncPictureParameterBufferH263
2421 VASurfaceID reference_picture;
2422 VASurfaceID reconstructed_picture;
2423 VABufferID coded_buf;
2424 uint16_t picture_width;
2425 uint16_t picture_height;
2426 VAEncPictureType picture_type;
2428 /** \brief Reserved bytes for future use, must be zero */
2429 uint32_t va_reserved[VA_PADDING_LOW];
2430 } VAEncPictureParameterBufferH263;
2432 /****************************
2433 * MPEG-4 specific encode data structures
2434 ****************************/
2436 typedef struct _VAEncSequenceParameterBufferMPEG4
2438 uint8_t profile_and_level_indication;
2439 uint32_t intra_period;
2440 uint32_t video_object_layer_width;
2441 uint32_t video_object_layer_height;
2442 uint32_t vop_time_increment_resolution;
2443 uint32_t fixed_vop_rate;
2444 uint32_t fixed_vop_time_increment;
2445 uint32_t bits_per_second;
2446 uint32_t frame_rate;
2447 uint32_t initial_qp;
2450 /** \brief Reserved bytes for future use, must be zero */
2451 uint32_t va_reserved[VA_PADDING_LOW];
2452 } VAEncSequenceParameterBufferMPEG4;
2454 typedef struct _VAEncPictureParameterBufferMPEG4
2456 VASurfaceID reference_picture;
2457 VASurfaceID reconstructed_picture;
2458 VABufferID coded_buf;
2459 uint16_t picture_width;
2460 uint16_t picture_height;
2461 uint32_t modulo_time_base; /* number of 1s */
2462 uint32_t vop_time_increment;
2463 VAEncPictureType picture_type;
2465 /** \brief Reserved bytes for future use, must be zero */
2466 uint32_t va_reserved[VA_PADDING_LOW];
2467 } VAEncPictureParameterBufferMPEG4;
2471 /** Buffer functions */
2474 * Creates a buffer for "num_elements" elements of "size" bytes and
2475 * initalize with "data".
2476 * if "data" is null, then the contents of the buffer data store
2478 * Basically there are two ways to get buffer data to the server side. One is
2479 * to call vaCreateBuffer() with a non-null "data", which results the data being
2480 * copied to the data store on the server side. A different method that
2481 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2482 * and then use vaMapBuffer() to map the data store from the server side to the
2483 * client address space for access.
2484 * The user must call vaDestroyBuffer() to destroy a buffer.
2485 * Note: image buffers are created by the library, not the client. Please see
2486 * vaCreateImage on how image buffers are managed.
2488 VAStatus vaCreateBuffer (
2490 VAContextID context,
2491 VABufferType type, /* in */
2492 unsigned int size, /* in */
2493 unsigned int num_elements, /* in */
2494 void *data, /* in */
2495 VABufferID *buf_id /* out */
2499 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
2500 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
2501 * can call vaMapBuffer with this Buffer ID to get virtual address.
2502 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
2503 * maybe it should align with 256, and one byte present one Qp.so, call the function.
2504 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
2505 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
2506 * pBuf + 256 is the start of next line.
2507 * different driver implementation maybe return different unit_size and pitch
2509 VAStatus vaCreateBuffer2(
2511 VAContextID context,
2514 unsigned int height,
2515 unsigned int *unit_size,
2516 unsigned int *pitch,
2521 * Convey to the server how many valid elements are in the buffer.
2522 * e.g. if multiple slice parameters are being held in a single buffer,
2523 * this will communicate to the server the number of slice parameters
2524 * that are valid in the buffer.
2526 VAStatus vaBufferSetNumElements (
2528 VABufferID buf_id, /* in */
2529 unsigned int num_elements /* in */
2534 * device independent data structure for codedbuffer
2538 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2539 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2540 * enough for the encoder to attempt to limit its size.
2541 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2542 * exceeded the maximum slice size specified.
2543 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2544 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2545 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2547 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2548 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2549 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2550 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2551 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2553 * \brief The frame has exceeded the maximum requested size.
2555 * This flag indicates that the encoded frame size exceeds the value
2556 * specified through a misc parameter buffer of type
2557 * #VAEncMiscParameterTypeMaxFrameSize.
2559 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2560 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2563 * \brief The coded buffer segment contains a single NAL unit.
2565 * This flag indicates that the coded buffer segment contains a
2566 * single NAL unit. This flag might be useful to the user for
2567 * processing the coded buffer.
2569 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2572 * \brief Coded buffer segment.
2574 * #VACodedBufferSegment is an element of a linked list describing
2575 * some information on the coded buffer. The coded buffer segment
2576 * could contain either a single NAL unit, or more than one NAL unit.
2577 * It is recommended (but not required) to return a single NAL unit
2578 * in a coded buffer segment, and the implementation should set the
2579 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2581 typedef struct _VACodedBufferSegment {
2583 * \brief Size of the data buffer in this segment (in bytes).
2586 /** \brief Bit offset into the data buffer where the video data starts. */
2587 uint32_t bit_offset;
2588 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2590 /** \brief Reserved for future use. */
2592 /** \brief Pointer to the start of the data buffer. */
2595 * \brief Pointer to the next #VACodedBufferSegment element,
2596 * or \c NULL if there is none.
2600 /** \brief Reserved bytes for future use, must be zero */
2601 uint32_t va_reserved[VA_PADDING_LOW];
2602 } VACodedBufferSegment;
2605 * Map data store of the buffer into the client's address space
2606 * vaCreateBuffer() needs to be called with "data" set to NULL before
2607 * calling vaMapBuffer()
2609 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2610 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2612 VAStatus vaMapBuffer (
2614 VABufferID buf_id, /* in */
2615 void **pbuf /* out */
2619 * After client making changes to a mapped data store, it needs to
2620 * "Unmap" it to let the server know that the data is ready to be
2621 * consumed by the server
2623 VAStatus vaUnmapBuffer (
2625 VABufferID buf_id /* in */
2629 * After this call, the buffer is deleted and this buffer_id is no longer valid
2631 * A buffer can be re-used and sent to the server by another Begin/Render/End
2632 * sequence if vaDestroyBuffer() is not called with this buffer.
2634 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
2635 * hardware accelerator can result in performance dropping.
2637 VAStatus vaDestroyBuffer (
2639 VABufferID buffer_id
2642 /** \brief VA buffer information */
2644 /** \brief Buffer handle */
2646 /** \brief Buffer type (See \ref VABufferType). */
2649 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2651 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2652 * to specify the set of memory types the caller is interested in.
2653 * On successful return from vaAcquireBufferHandle(), the field is
2654 * updated with the best matching memory type.
2657 /** \brief Size of the underlying buffer. */
2660 /** \brief Reserved bytes for future use, must be zero */
2661 uint32_t va_reserved[VA_PADDING_LOW];
2665 * \brief Acquires buffer handle for external API usage
2667 * Locks the VA buffer object \ref buf_id for external API usage like
2668 * EGL or OpenCL (OCL). This function is a synchronization point. This
2669 * means that any pending operation is guaranteed to be completed
2670 * prior to returning from the function.
2672 * If the referenced VA buffer object is the backing store of a VA
2673 * surface, then this function acts as if vaSyncSurface() on the
2674 * parent surface was called first.
2676 * The \ref VABufferInfo argument shall be zero'ed on input. On
2677 * successful output, the data structure is filled in with all the
2678 * necessary buffer level implementation details like handle, type,
2679 * memory type and memory size.
2681 * Note: the external API implementation, or the application, can
2682 * express the memory types it is interested in by filling in the \ref
2683 * mem_type field accordingly. On successful output, the memory type
2684 * that fits best the request and that was used is updated in the \ref
2685 * VABufferInfo data structure. If none of the supplied memory types
2686 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2687 * error is returned.
2689 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2690 * is called. Besides, no additional operation is allowed on any of
2691 * the buffer parent object until vaReleaseBufferHandle() is called.
2692 * e.g. decoding into a VA surface backed with the supplied VA buffer
2693 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2697 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2698 * does not support this interface
2699 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2700 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2701 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2702 * does not support exporting buffers of the specified type
2703 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2704 * memory types in \ref VABufferInfo.mem_type was supported
2706 * @param[in] dpy the VA display
2707 * @param[in] buf_id the VA buffer
2708 * @param[in,out] buf_info the associated VA buffer information
2709 * @return VA_STATUS_SUCCESS if successful
2712 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2715 * \brief Releases buffer after usage from external API
2717 * Unlocks the VA buffer object \ref buf_id from external API usage like
2718 * EGL or OpenCL (OCL). This function is a synchronization point. This
2719 * means that any pending operation is guaranteed to be completed
2720 * prior to returning from the function.
2722 * The \ref VABufferInfo argument shall point to the original data
2723 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2724 * This is necessary so that the VA driver implementation could
2725 * deallocate any resources that were needed.
2727 * In any case, returning from this function invalidates any contents
2728 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2729 * valid. Therefore, VA driver implementations are free to reset this
2730 * data structure to safe defaults.
2733 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2734 * does not support this interface
2735 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2736 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2737 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2738 * does not support exporting buffers of the specified type
2740 * @param[in] dpy the VA display
2741 * @param[in] buf_id the VA buffer
2742 * @return VA_STATUS_SUCCESS if successful
2745 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2748 * Render (Video Decode/Encode/Processing) Pictures
2750 * A picture represents either a frame or a field.
2752 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
2757 * Get ready for a video pipeline
2758 * - decode a picture to a target surface
2759 * - encode a picture from a target surface
2760 * - process a picture to a target surface
2762 VAStatus vaBeginPicture (
2764 VAContextID context,
2765 VASurfaceID render_target
2769 * Send video decode, encode or processing buffers to the server.
2771 VAStatus vaRenderPicture (
2773 VAContextID context,
2774 VABufferID *buffers,
2779 * Make the end of rendering for a picture.
2780 * The server should start processing all pending operations for this
2781 * surface. This call is non-blocking. The client can start another
2782 * Begin/Render/End sequence on a different render target.
2783 * if VAContextID used in this function previously successfully passed
2784 * vaMFAddContext call, real processing will be started during vaMFSubmit
2786 VAStatus vaEndPicture (
2792 * Make the end of rendering for a pictures in contexts passed with submission.
2793 * The server should start processing all pending operations for contexts.
2794 * All contexts passed should be associated through vaMFAddContext
2795 * and call sequence Begin/Render/End performed.
2796 * This call is non-blocking. The client can start another
2797 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
2799 * VA_STATUS_SUCCESS - operation successful, context was removed.
2800 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
2801 * due to mf_context not created or one of contexts not assotiated with mf_context
2802 * through vaAddContext.
2803 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
2804 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
2806 * mf_context: Multi-Frame context
2807 * contexts: list of contexts submitting their tasks for multi-frame operation.
2808 * num_contexts: number of passed contexts.
2810 VAStatus vaMFSubmit (
2812 VAMFContextID mf_context,
2813 VAContextID * contexts,
2824 * This function blocks until all pending operations on the render target
2825 * have been completed. Upon return it is safe to use the render target for a
2826 * different picture.
2828 VAStatus vaSyncSurface (
2830 VASurfaceID render_target
2835 VASurfaceRendering = 1, /* Rendering in progress */
2836 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2837 /* this status is useful if surface is used as the source */
2839 VASurfaceReady = 4, /* not being rendered or displayed */
2840 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2844 * Find out any pending ops on the render target
2846 VAStatus vaQuerySurfaceStatus (
2848 VASurfaceID render_target,
2849 VASurfaceStatus *status /* out */
2854 VADecodeSliceMissing = 0,
2855 VADecodeMBError = 1,
2856 } VADecodeErrorType;
2859 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2860 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2862 typedef struct _VASurfaceDecodeMBErrors
2864 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2865 uint32_t start_mb; /* start mb address with errors */
2866 uint32_t end_mb; /* end mb address with errors */
2867 VADecodeErrorType decode_error_type;
2869 /** \brief Reserved bytes for future use, must be zero */
2870 uint32_t va_reserved[VA_PADDING_LOW];
2871 } VASurfaceDecodeMBErrors;
2874 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2875 * it can call vaQuerySurfaceError to find out further details on the particular error.
2876 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2877 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2878 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2879 * The array is terminated if "status==-1" is detected.
2881 VAStatus vaQuerySurfaceError(
2883 VASurfaceID surface,
2884 VAStatus error_status,
2889 * Images and Subpictures
2890 * VAImage is used to either get the surface data to client memory, or
2891 * to copy image data in client memory to a surface.
2892 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2893 * is at the upper left corner with positive X to the right and positive Y down
2895 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2896 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2897 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2900 * Pre-defined fourcc codes
2902 #define VA_FOURCC_NV12 0x3231564E
2903 #define VA_FOURCC_AI44 0x34344149
2904 #define VA_FOURCC_RGBA 0x41424752
2905 #define VA_FOURCC_RGBX 0x58424752
2906 #define VA_FOURCC_BGRA 0x41524742
2907 #define VA_FOURCC_BGRX 0x58524742
2908 #define VA_FOURCC_ARGB 0x42475241
2909 #define VA_FOURCC_XRGB 0x42475258
2910 #define VA_FOURCC_ABGR 0x52474241
2911 #define VA_FOURCC_XBGR 0x52474258
2912 #define VA_FOURCC_UYVY 0x59565955
2913 #define VA_FOURCC_YUY2 0x32595559
2914 #define VA_FOURCC_AYUV 0x56555941
2915 #define VA_FOURCC_NV11 0x3131564e
2916 #define VA_FOURCC_YV12 0x32315659
2917 #define VA_FOURCC_P208 0x38303250
2918 /* IYUV same as I420, but most user perfer I420, will deprecate it */
2919 #define VA_FOURCC_IYUV 0x56555949
2920 #define VA_FOURCC_I420 0x30323449
2921 #define VA_FOURCC_YV24 0x34325659
2922 #define VA_FOURCC_YV32 0x32335659
2923 #define VA_FOURCC_Y800 0x30303859
2924 #define VA_FOURCC_IMC3 0x33434D49
2925 #define VA_FOURCC_411P 0x50313134
2926 #define VA_FOURCC_422H 0x48323234
2927 #define VA_FOURCC_422V 0x56323234
2928 #define VA_FOURCC_444P 0x50343434
2929 #define VA_FOURCC_RGBP 0x50424752
2930 #define VA_FOURCC_BGRP 0x50524742
2931 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2934 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
2936 #define VA_FOURCC_YV16 0x36315659
2938 * 10-bit and 16-bit Planar YUV 4:2:0.
2940 #define VA_FOURCC_P010 0x30313050
2941 #define VA_FOURCC_P016 0x36313050
2944 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
2946 #define VA_FOURCC_I010 0x30313049
2949 #define VA_LSB_FIRST 1
2950 #define VA_MSB_FIRST 2
2952 typedef struct _VAImageFormat
2955 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2956 uint32_t bits_per_pixel;
2957 /* for RGB formats */
2958 uint32_t depth; /* significant bits per pixel */
2960 uint32_t green_mask;
2962 uint32_t alpha_mask;
2964 /** \brief Reserved bytes for future use, must be zero */
2965 uint32_t va_reserved[VA_PADDING_LOW];
2968 typedef VAGenericID VAImageID;
2970 typedef struct _VAImage
2972 VAImageID image_id; /* uniquely identify this image */
2973 VAImageFormat format;
2974 VABufferID buf; /* image data buffer */
2976 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2977 * data store on the server side for optimal performance. The buffer will be
2978 * created by the CreateImage function, and proper storage allocated based on the image
2979 * size and format. This buffer is managed by the library implementation, and
2980 * accessed by the client through the buffer Map/Unmap functions.
2985 uint32_t num_planes; /* can not be greater than 3 */
2987 * An array indicating the scanline pitch in bytes for each plane.
2988 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2990 uint32_t pitches[3];
2992 * An array indicating the byte offset from the beginning of the image data
2993 * to the start of each plane.
2995 uint32_t offsets[3];
2997 /* The following fields are only needed for paletted formats */
2998 int32_t num_palette_entries; /* set to zero for non-palette images */
3000 * Each component is one byte and entry_bytes indicates the number of components in
3001 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3003 int32_t entry_bytes;
3005 * An array of ascii characters describing the order of the components within the bytes.
3006 * Only entry_bytes characters of the string are used.
3008 int8_t component_order[4];
3010 /** \brief Reserved bytes for future use, must be zero */
3011 uint32_t va_reserved[VA_PADDING_LOW];
3014 /** Get maximum number of image formats supported by the implementation */
3015 int vaMaxNumImageFormats (
3020 * Query supported image formats
3021 * The caller must provide a "format_list" array that can hold at
3022 * least vaMaxNumImageFormats() entries. The actual number of formats
3023 * returned in "format_list" is returned in "num_formats".
3025 VAStatus vaQueryImageFormats (
3027 VAImageFormat *format_list, /* out */
3028 int *num_formats /* out */
3032 * Create a VAImage structure
3033 * The width and height fields returned in the VAImage structure may get
3034 * enlarged for some YUV formats. Upon return from this function,
3035 * image->buf has been created and proper storage allocated by the library.
3036 * The client can access the image through the Map/Unmap calls.
3038 VAStatus vaCreateImage (
3040 VAImageFormat *format,
3043 VAImage *image /* out */
3047 * Should call DestroyImage before destroying the surface it is bound to
3049 VAStatus vaDestroyImage (
3054 VAStatus vaSetImagePalette (
3058 * pointer to an array holding the palette data. The size of the array is
3059 * num_palette_entries * entry_bytes in size. The order of the components
3060 * in the palette is described by the component_order in VAImage struct
3062 unsigned char *palette
3066 * Retrive surface data into a VAImage
3067 * Image must be in a format supported by the implementation
3069 VAStatus vaGetImage (
3071 VASurfaceID surface,
3072 int x, /* coordinates of the upper left source pixel */
3074 unsigned int width, /* width and height of the region */
3075 unsigned int height,
3080 * Copy data from a VAImage to a surface
3081 * Image must be in a format supported by the implementation
3082 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3083 * shouldn't be rendered into when this is called
3085 VAStatus vaPutImage (
3087 VASurfaceID surface,
3091 unsigned int src_width,
3092 unsigned int src_height,
3095 unsigned int dest_width,
3096 unsigned int dest_height
3100 * Derive an VAImage from an existing surface.
3101 * This interface will derive a VAImage and corresponding image buffer from
3102 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3103 * direct CPU access. This operation is only possible on implementations with
3104 * direct rendering capabilities and internal surface formats that can be
3105 * represented with a VAImage. When the operation is not possible this interface
3106 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3107 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3110 * Implementations should only return success when the resulting image buffer
3111 * would be useable with vaMap/Unmap.
3113 * When directly accessing a surface special care must be taken to insure
3114 * proper synchronization with the graphics hardware. Clients should call
3115 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3116 * rendering or currently being displayed by an overlay.
3118 * Additionally nothing about the contents of a surface should be assumed
3119 * following a vaPutSurface. Implementations are free to modify the surface for
3120 * scaling or subpicture blending within a call to vaPutImage.
3122 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3123 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3124 * vaGetImage with other surfaces is supported.
3126 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3127 * image and image buffer structures will be destroyed; however, the underlying
3128 * surface will remain unchanged until freed with vaDestroySurfaces.
3130 VAStatus vaDeriveImage (
3132 VASurfaceID surface,
3133 VAImage *image /* out */
3138 * Subpicture is a special type of image that can be blended
3139 * with a surface during vaPutSurface(). Subpicture can be used to render
3140 * DVD sub-titles or closed captioning text etc.
3143 typedef VAGenericID VASubpictureID;
3145 /** Get maximum number of subpicture formats supported by the implementation */
3146 int vaMaxNumSubpictureFormats (
3150 /** flags for subpictures */
3151 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3152 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3153 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3155 * Query supported subpicture formats
3156 * The caller must provide a "format_list" array that can hold at
3157 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3158 * for each format to indicate additional capabilities for that format. The actual
3159 * number of formats returned in "format_list" is returned in "num_formats".
3160 * flags: returned value to indicate addtional capabilities
3161 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3162 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3163 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3166 VAStatus vaQuerySubpictureFormats (
3168 VAImageFormat *format_list, /* out */
3169 unsigned int *flags, /* out */
3170 unsigned int *num_formats /* out */
3174 * Subpictures are created with an image associated.
3176 VAStatus vaCreateSubpicture (
3179 VASubpictureID *subpicture /* out */
3183 * Destroy the subpicture before destroying the image it is assocated to
3185 VAStatus vaDestroySubpicture (
3187 VASubpictureID subpicture
3191 * Bind an image to the subpicture. This image will now be associated with
3192 * the subpicture instead of the one at creation.
3194 VAStatus vaSetSubpictureImage (
3196 VASubpictureID subpicture,
3201 * If chromakey is enabled, then the area where the source value falls within
3202 * the chromakey [min, max] range is transparent
3203 * The chromakey component format is the following:
3204 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3205 * For YUV: [0:7] V [8:15] U [16:23] Y
3206 * The chromakey mask can be used to mask out certain components for chromakey
3209 VAStatus vaSetSubpictureChromakey (
3211 VASubpictureID subpicture,
3212 unsigned int chromakey_min,
3213 unsigned int chromakey_max,
3214 unsigned int chromakey_mask
3218 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3219 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3220 * the overall alpha is per-pixel alpha multiplied by the global alpha
3222 VAStatus vaSetSubpictureGlobalAlpha (
3224 VASubpictureID subpicture,
3229 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3230 * It defines the region mapping between the subpicture and the target
3231 * surfaces through source and destination rectangles (with the same width and height).
3232 * Both will be displayed at the next call to vaPutSurface. Additional
3233 * associations before the call to vaPutSurface simply overrides the association.
3235 VAStatus vaAssociateSubpicture (
3237 VASubpictureID subpicture,
3238 VASurfaceID *target_surfaces,
3240 int16_t src_x, /* upper left offset in subpicture */
3243 uint16_t src_height,
3244 int16_t dest_x, /* upper left offset in surface */
3246 uint16_t dest_width,
3247 uint16_t dest_height,
3249 * whether to enable chroma-keying, global-alpha, or screen relative mode
3250 * see VA_SUBPICTURE_XXX values
3256 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3258 VAStatus vaDeassociateSubpicture (
3260 VASubpictureID subpicture,
3261 VASurfaceID *target_surfaces,
3266 * Display attributes
3267 * Display attributes are used to control things such as contrast, hue, saturation,
3268 * brightness etc. in the rendering process. The application can query what
3269 * attributes are supported by the driver, and then set the appropriate attributes
3270 * before calling vaPutSurface()
3272 /* PowerVR IEP Lite attributes */
3275 VADISPLAYATTRIB_BLE_OFF = 0x00,
3276 VADISPLAYATTRIB_BLE_LOW,
3277 VADISPLAYATTRIB_BLE_MEDIUM,
3278 VADISPLAYATTRIB_BLE_HIGH,
3279 VADISPLAYATTRIB_BLE_NONE,
3280 } VADisplayAttribBLEMode;
3282 /** attribute value for VADisplayAttribRotation */
3283 #define VA_ROTATION_NONE 0x00000000
3284 #define VA_ROTATION_90 0x00000001
3285 #define VA_ROTATION_180 0x00000002
3286 #define VA_ROTATION_270 0x00000003
3290 * @name Mirroring directions
3292 * Those values could be used for VADisplayAttribMirror attribute or
3293 * VAProcPipelineParameterBuffer::mirror_state.
3297 /** \brief No Mirroring. */
3298 #define VA_MIRROR_NONE 0x00000000
3299 /** \brief Horizontal Mirroring. */
3300 #define VA_MIRROR_HORIZONTAL 0x00000001
3301 /** \brief Vertical Mirroring. */
3302 #define VA_MIRROR_VERTICAL 0x00000002
3305 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3306 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3307 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3310 #define VA_RENDER_MODE_UNDEFINED 0
3311 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3312 #define VA_RENDER_MODE_LOCAL_GPU 2
3313 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3314 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3316 /** Render device */
3317 #define VA_RENDER_DEVICE_UNDEFINED 0
3318 #define VA_RENDER_DEVICE_LOCAL 1
3319 #define VA_RENDER_DEVICE_EXTERNAL 2
3321 /** Currently defined display attribute types */
3324 VADisplayAttribBrightness = 0,
3325 VADisplayAttribContrast = 1,
3326 VADisplayAttribHue = 2,
3327 VADisplayAttribSaturation = 3,
3328 /* client can specifiy a background color for the target window
3329 * the new feature of video conference,
3330 * the uncovered area of the surface is filled by this color
3331 * also it will blend with the decoded video color
3333 VADisplayAttribBackgroundColor = 4,
3335 * this is a gettable only attribute. For some implementations that use the
3336 * hardware overlay, after PutSurface is called, the surface can not be
3337 * re-used until after the subsequent PutSurface call. If this is the case
3338 * then the value for this attribute will be set to 1 so that the client
3339 * will not attempt to re-use the surface right after returning from a call
3342 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3343 * driver may use overlay or GPU alternatively
3345 VADisplayAttribDirectSurface = 5,
3346 VADisplayAttribRotation = 6,
3347 VADisplayAttribOutofLoopDeblock = 7,
3349 /* PowerVR IEP Lite specific attributes */
3350 VADisplayAttribBLEBlackMode = 8,
3351 VADisplayAttribBLEWhiteMode = 9,
3352 VADisplayAttribBlueStretch = 10,
3353 VADisplayAttribSkinColorCorrection = 11,
3355 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3356 * conversion matrix. Each element in the matrix is float-point
3358 VADisplayAttribCSCMatrix = 12,
3359 /* specify the constant color used to blend with video surface
3360 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3361 * d: the final color to overwrite into the frame buffer
3362 * v: decoded video after color conversion,
3363 * c: video color specified by VADisplayAttribBlendColor
3364 * b: background color of the drawable
3366 VADisplayAttribBlendColor = 13,
3368 * Indicate driver to skip painting color key or not.
3369 * only applicable if the render is overlay
3371 VADisplayAttribOverlayAutoPaintColorKey = 14,
3373 * customized overlay color key, the format is RGB888
3374 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3376 VADisplayAttribOverlayColorKey = 15,
3378 * The hint for the implementation of vaPutSurface
3379 * normally, the driver could use an overlay or GPU to render the surface on the screen
3380 * this flag provides APP the flexibity to switch the render dynamically
3382 VADisplayAttribRenderMode = 16,
3384 * specify if vaPutSurface needs to render into specified monitors
3385 * one example is that one external monitor (e.g. HDMI) is enabled,
3386 * but the window manager is not aware of it, and there is no associated drawable
3388 VADisplayAttribRenderDevice = 17,
3390 * specify vaPutSurface render area if there is no drawable on the monitor
3392 VADisplayAttribRenderRect = 18,
3393 } VADisplayAttribType;
3395 /* flags for VADisplayAttribute */
3396 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3397 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3398 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3400 typedef struct _VADisplayAttribute
3402 VADisplayAttribType type;
3405 int32_t value; /* used by the set/get attribute functions */
3406 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3409 /** \brief Reserved bytes for future use, must be zero */
3410 uint32_t va_reserved[VA_PADDING_LOW];
3411 } VADisplayAttribute;
3413 /** Get maximum number of display attributs supported by the implementation */
3414 int vaMaxNumDisplayAttributes (
3419 * Query display attributes
3420 * The caller must provide a "attr_list" array that can hold at
3421 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3422 * returned in "attr_list" is returned in "num_attributes".
3424 VAStatus vaQueryDisplayAttributes (
3426 VADisplayAttribute *attr_list, /* out */
3427 int *num_attributes /* out */
3431 * Get display attributes
3432 * This function returns the current attribute values in "attr_list".
3433 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3434 * from vaQueryDisplayAttributes() can have their values retrieved.
3436 VAStatus vaGetDisplayAttributes (
3438 VADisplayAttribute *attr_list, /* in/out */
3443 * Set display attributes
3444 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3445 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3446 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3448 VAStatus vaSetDisplayAttributes (
3450 VADisplayAttribute *attr_list,
3454 /****************************
3455 * HEVC data structures
3456 ****************************/
3458 * \brief Description of picture properties of those in DPB surfaces.
3460 * If only progressive scan is supported, each surface contains one whole
3462 * Otherwise, each surface contains two fields of whole picture.
3463 * In this case, two entries of ReferenceFrames[] may share same picture_id
3466 typedef struct _VAPictureHEVC
3468 /** \brief reconstructed picture buffer surface index
3469 * invalid when taking value VA_INVALID_SURFACE.
3471 VASurfaceID picture_id;
3472 /** \brief picture order count.
3473 * in HEVC, POCs for top and bottom fields of same picture should
3474 * take different values.
3476 int32_t pic_order_cnt;
3477 /* described below */
3480 /** \brief Reserved bytes for future use, must be zero */
3481 uint32_t va_reserved[VA_PADDING_LOW];
3484 /* flags in VAPictureHEVC could be OR of the following */
3485 #define VA_PICTURE_HEVC_INVALID 0x00000001
3486 /** \brief indication of interlace scan picture.
3487 * should take same value for all the pictures in sequence.
3489 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3490 /** \brief polarity of the field picture.
3491 * top field takes even lines of buffer surface.
3492 * bottom field takes odd lines of buffer surface.
3494 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3495 /** \brief Long term reference picture */
3496 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3498 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3499 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3500 * be exclusive. No more than one of them can be set for any picture.
3501 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3502 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3503 * Application should provide valid values for both short format and long format.
3504 * The pictures in DPB with any of these three flags turned on are referred by
3505 * the current picture.
3507 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3508 * Number of ReferenceFrames[] entries with this bit set equals
3509 * NumPocStCurrBefore.
3511 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3512 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3513 * Number of ReferenceFrames[] entries with this bit set equals
3514 * NumPocStCurrAfter.
3516 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3517 /** \brief RefPicSetLtCurr of HEVC spec variable
3518 * Number of ReferenceFrames[] entries with this bit set equals
3521 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3523 #include <va/va_dec_hevc.h>
3524 #include <va/va_dec_jpeg.h>
3525 #include <va/va_dec_vp8.h>
3526 #include <va/va_dec_vp9.h>
3527 #include <va/va_enc_hevc.h>
3528 #include <va/va_enc_h264.h>
3529 #include <va/va_enc_jpeg.h>
3530 #include <va/va_enc_mpeg2.h>
3531 #include <va/va_enc_vp8.h>
3532 #include <va/va_enc_vp9.h>
3533 #include <va/va_fei.h>
3534 #include <va/va_fei_h264.h>
3535 #include <va/va_vpp.h>