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
235 * Returns a short english description of error_status
237 const char *vaErrorStr(VAStatus error_status);
239 typedef struct _VARectangle
247 /** \brief Generic motion vector data structure. */
248 typedef struct _VAMotionVector {
249 /** \mv0[0]: horizontal motion vector for past reference */
250 /** \mv0[1]: vertical motion vector for past reference */
251 /** \mv1[0]: horizontal motion vector for future reference */
252 /** \mv1[1]: vertical motion vector for future reference */
253 int16_t mv0[2]; /* past reference */
254 int16_t mv1[2]; /* future reference */
257 /** Type of a message callback, used for both error and info log. */
258 typedef void (*VAMessageCallback)(void *user_context, const char *message);
261 * Set the callback for error messages, or NULL for no logging.
262 * Returns the previous one, or NULL if it was disabled.
264 VAMessageCallback vaSetErrorCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
267 * Set the callback for info messages, or NULL for no logging.
268 * Returns the previous one, or NULL if it was disabled.
270 VAMessageCallback vaSetInfoCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
274 * A display must be obtained by calling vaGetDisplay() before calling
275 * vaInitialize() and other functions. This connects the API to the
276 * native window system.
277 * For X Windows, native_dpy would be from XOpenDisplay()
279 typedef void* VANativeDisplay; /* window system dependent */
281 int vaDisplayIsValid(VADisplay dpy);
284 * Set the override driver name instead of queried driver driver.
286 VAStatus vaSetDriverName(VADisplay dpy,
291 * Initialize the library
293 VAStatus vaInitialize (
295 int *major_version, /* out */
296 int *minor_version /* out */
300 * After this call, all library internal resources will be cleaned up
302 VAStatus vaTerminate (
307 * vaQueryVendorString returns a pointer to a zero-terminated string
308 * describing some aspects of the VA implemenation on a specific
309 * hardware accelerator. The format of the returned string is vendor
310 * specific and at the discretion of the implementer.
311 * e.g. for the Intel GMA500 implementation, an example would be:
312 * "Intel GMA500 - 2.0.0.32L.0005"
314 const char *vaQueryVendorString (
318 typedef int (*VAPrivFunc)(void);
321 * Return a function pointer given a function name in the library.
322 * This allows private interfaces into the library
324 VAPrivFunc vaGetLibFunc (
329 /** Currently defined profiles */
332 /** \brief Profile ID used for video processing. */
334 VAProfileMPEG2Simple = 0,
335 VAProfileMPEG2Main = 1,
336 VAProfileMPEG4Simple = 2,
337 VAProfileMPEG4AdvancedSimple = 3,
338 VAProfileMPEG4Main = 4,
339 VAProfileH264Baseline va_deprecated_enum = 5,
340 VAProfileH264Main = 6,
341 VAProfileH264High = 7,
342 VAProfileVC1Simple = 8,
343 VAProfileVC1Main = 9,
344 VAProfileVC1Advanced = 10,
345 VAProfileH263Baseline = 11,
346 VAProfileJPEGBaseline = 12,
347 VAProfileH264ConstrainedBaseline = 13,
348 VAProfileVP8Version0_3 = 14,
349 VAProfileH264MultiviewHigh = 15,
350 VAProfileH264StereoHigh = 16,
351 VAProfileHEVCMain = 17,
352 VAProfileHEVCMain10 = 18,
353 VAProfileVP9Profile0 = 19,
354 VAProfileVP9Profile1 = 20,
355 VAProfileVP9Profile2 = 21,
356 VAProfileVP9Profile3 = 22
360 * Currently defined entrypoints
366 VAEntrypointIDCT = 3,
367 VAEntrypointMoComp = 4,
368 VAEntrypointDeblocking = 5,
369 VAEntrypointEncSlice = 6, /* slice level encode */
370 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
372 * For an implementation that supports a low power/high performance variant
373 * for slice level encode, it can choose to expose the
374 * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
375 * available with this entrypoint (e.g. interlace, MBAFF) and the
376 * application can query the encoding configuration attributes to find
377 * out more details if this entrypoint is supported.
379 VAEntrypointEncSliceLP = 8,
380 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
382 * \brief VAEntrypointFEI
384 * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to
385 * have more controls and trade off quality for speed with their own IPs.
386 * The application can optionally provide input to ENC for extra encode control
387 * and get the output from ENC. Application can chose to modify the ENC
388 * output/PAK input during encoding, but the performance impact is significant.
390 * On top of the existing buffers for normal encode, there will be
391 * one extra input buffer (VAEncMiscParameterFEIFrameControl) and
392 * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType
393 * and VAEncFEIDistortionBufferType) for VAEntrypointFEI entry function.
394 * If separate PAK is set, two extra input buffers
395 * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input.
397 VAEntrypointFEI = 11,
400 /** Currently defined configuration attribute types */
403 VAConfigAttribRTFormat = 0,
404 VAConfigAttribSpatialResidual = 1,
405 VAConfigAttribSpatialClipping = 2,
406 VAConfigAttribIntraResidual = 3,
407 VAConfigAttribEncryption = 4,
408 VAConfigAttribRateControl = 5,
410 /** @name Attributes for decoding */
413 * \brief Slice Decoding mode. Read/write.
415 * This attribute determines what mode the driver supports for slice
416 * decoding, through vaGetConfigAttributes(); and what mode the user
417 * will be providing to the driver, through vaCreateConfig(), if the
418 * driver supports those. If this attribute is not set by the user then
419 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
421 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
423 VAConfigAttribDecSliceMode = 6,
425 /** @name Attributes for encoding */
428 * \brief Packed headers mode. Read/write.
430 * This attribute determines what packed headers the driver supports,
431 * through vaGetConfigAttributes(); and what packed headers the user
432 * will be providing to the driver, through vaCreateConfig(), if the
433 * driver supports those.
435 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
437 VAConfigAttribEncPackedHeaders = 10,
439 * \brief Interlaced mode. Read/write.
441 * This attribute determines what kind of interlaced encoding mode
442 * the driver supports.
444 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
446 VAConfigAttribEncInterlaced = 11,
448 * \brief Maximum number of reference frames. Read-only.
450 * This attribute determines the maximum number of reference
451 * frames supported for encoding.
453 * Note: for H.264 encoding, the value represents the maximum number
454 * of reference frames for both the reference picture list 0 (bottom
455 * 16 bits) and the reference picture list 1 (top 16 bits).
457 VAConfigAttribEncMaxRefFrames = 13,
459 * \brief Maximum number of slices per frame. Read-only.
461 * This attribute determines the maximum number of slices the
462 * driver can support to encode a single frame.
464 VAConfigAttribEncMaxSlices = 14,
466 * \brief Slice structure. Read-only.
468 * This attribute determines slice structures supported by the
469 * driver for encoding. This attribute is a hint to the user so
470 * that he can choose a suitable surface size and how to arrange
471 * the encoding process of multiple slices per frame.
473 * More specifically, for H.264 encoding, this attribute
474 * determines the range of accepted values to
475 * VAEncSliceParameterBufferH264::macroblock_address and
476 * VAEncSliceParameterBufferH264::num_macroblocks.
478 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
481 VAConfigAttribEncSliceStructure = 15,
483 * \brief Macroblock information. Read-only.
485 * This attribute determines whether the driver supports extra
486 * encoding information per-macroblock. e.g. QP.
488 * More specifically, for H.264 encoding, if the driver returns a non-zero
489 * value for this attribute, this means the application can create
490 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
491 * through VAEncSliceParameterBufferH264::macroblock_info.
493 VAConfigAttribEncMacroblockInfo = 16,
495 * \brief JPEG encoding attribute. Read-only.
497 * This attribute exposes a number of capabilities of the underlying
498 * JPEG implementation. The attribute value is partitioned into fields as defined in the
499 * VAConfigAttribValEncJPEG union.
501 VAConfigAttribEncJPEG = 20,
503 * \brief Encoding quality range attribute. Read-only.
505 * This attribute conveys whether the driver supports different quality level settings
506 * for encoding. A value less than or equal to 1 means that the encoder only has a single
507 * quality setting, and a value greater than 1 represents the number of quality levels
508 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
510 VAConfigAttribEncQualityRange = 21,
512 * \brief Encoding skip frame attribute. Read-only.
514 * This attribute conveys whether the driver supports sending skip frame parameters
515 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
516 * externally skipped frames.
518 VAConfigAttribEncSkipFrame = 24,
520 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
522 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
523 * based on user provided ROI rectangles. The attribute value is partitioned into fields
524 * as defined in the VAConfigAttribValEncROI union.
526 * If ROI encoding is supported, the ROI information is passed to the driver using
527 * VAEncMiscParameterTypeROI.
529 VAConfigAttribEncROI = 25,
531 * \brief Encoding extended rate control attribute. Read-only.
533 * This attribute conveys whether the driver supports any extended rate control features
534 * The attribute value is partitioned into fields as defined in the
535 * VAConfigAttribValEncRateControlExt union.
537 VAConfigAttribEncRateControlExt = 26,
540 * \brief Encode function type for FEI.
542 * This attribute conveys whether the driver supports different function types for encode.
543 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
544 * it is for FEI entry point only.
545 * Default is VA_FEI_FUNCTION_ENC_PAK.
547 VAConfigAttribFEIFunctionType = 32,
549 * \brief Maximum number of FEI MV predictors. Read-only.
551 * This attribute determines the maximum number of MV predictors the driver
552 * can support to encode a single frame. 0 means no MV predictor is supported.
553 * Currently it is for FEI entry point only.
555 VAConfigAttribFEIMVPredictors = 33,
557 VAConfigAttribTypeMax
558 } VAConfigAttribType;
561 * Configuration attributes
562 * If there is more than one value for an attribute, a default
563 * value will be assigned to the attribute if the client does not
564 * specify the attribute when creating a configuration
566 typedef struct _VAConfigAttrib {
567 VAConfigAttribType type;
568 uint32_t value; /* OR'd flags (bits) for this attribute */
571 /** attribute value for VAConfigAttribRTFormat */
572 #define VA_RT_FORMAT_YUV420 0x00000001
573 #define VA_RT_FORMAT_YUV422 0x00000002
574 #define VA_RT_FORMAT_YUV444 0x00000004
575 #define VA_RT_FORMAT_YUV411 0x00000008
576 #define VA_RT_FORMAT_YUV400 0x00000010
577 /** YUV formats with more than 8 bpp */
578 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
580 #define VA_RT_FORMAT_RGB16 0x00010000
581 #define VA_RT_FORMAT_RGB32 0x00020000
582 /* RGBP covers RGBP and BGRP fourcc */
583 #define VA_RT_FORMAT_RGBP 0x00100000
584 #define VA_RT_FORMAT_PROTECTED 0x80000000
586 /** @name Attribute values for VAConfigAttribRateControl */
588 /** \brief Driver does not support any form of rate control. */
589 #define VA_RC_NONE 0x00000001
590 /** \brief Constant bitrate. */
591 #define VA_RC_CBR 0x00000002
592 /** \brief Variable bitrate. */
593 #define VA_RC_VBR 0x00000004
594 /** \brief Video conference mode. */
595 #define VA_RC_VCM 0x00000008
596 /** \brief Constant QP. */
597 #define VA_RC_CQP 0x00000010
598 /** \brief Variable bitrate with peak rate higher than average bitrate. */
599 #define VA_RC_VBR_CONSTRAINED 0x00000020
600 /** \brief Macroblock based rate control. Per MB control is decided
601 * internally in the encoder. It may be combined with other RC modes, except CQP. */
602 #define VA_RC_MB 0x00000080
606 /** @name Attribute values for VAConfigAttribDecSliceMode */
608 /** \brief Driver supports normal mode for slice decoding */
609 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
610 /** \brief Driver supports base mode for slice decoding */
611 #define VA_DEC_SLICE_MODE_BASE 0x00000002
614 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
616 /** \brief Driver does not support any packed headers mode. */
617 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
619 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
621 * Application must provide it to driver once this flag is returned through
622 * vaGetConfigAttributes()
624 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
626 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
628 * Application must provide it to driver once this falg is returned through
629 * vaGetConfigAttributes()
631 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
633 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
635 * Application must provide it to driver once this flag is returned through
636 * vaGetConfigAttributes()
638 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
640 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
643 * This is a deprecated packed header flag, All applications can use
644 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
645 * header data buffer to the driver
647 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
648 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
649 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
652 /** @name Attribute values for VAConfigAttribEncInterlaced */
654 /** \brief Driver does not support interlaced coding. */
655 #define VA_ENC_INTERLACED_NONE 0x00000000
656 /** \brief Driver supports interlaced frame coding. */
657 #define VA_ENC_INTERLACED_FRAME 0x00000001
658 /** \brief Driver supports interlaced field coding. */
659 #define VA_ENC_INTERLACED_FIELD 0x00000002
660 /** \brief Driver supports macroblock adaptive frame field coding. */
661 #define VA_ENC_INTERLACED_MBAFF 0x00000004
662 /** \brief Driver supports picture adaptive frame field coding. */
663 #define VA_ENC_INTERLACED_PAFF 0x00000008
666 /** @name Attribute values for VAConfigAttribEncSliceStructure */
668 /** \brief Driver supports a power-of-two number of rows per slice. */
669 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
670 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
671 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
672 /** \brief Dirver support 1 rows per slice */
673 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
674 /** \brief Dirver support max encoded slice size per slice */
675 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
676 /** \brief Driver supports an arbitrary number of rows per slice. */
677 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
680 /** \brief Attribute value for VAConfigAttribEncJPEG */
681 typedef union _VAConfigAttribValEncJPEG {
683 /** \brief set to 1 for arithmatic coding. */
684 uint32_t arithmatic_coding_mode : 1;
685 /** \brief set to 1 for progressive dct. */
686 uint32_t progressive_dct_mode : 1;
687 /** \brief set to 1 for non-interleaved. */
688 uint32_t non_interleaved_mode : 1;
689 /** \brief set to 1 for differential. */
690 uint32_t differential_mode : 1;
691 uint32_t max_num_components : 3;
692 uint32_t max_num_scans : 4;
693 uint32_t max_num_huffman_tables : 3;
694 uint32_t max_num_quantization_tables : 3;
697 } VAConfigAttribValEncJPEG;
699 /** \brief Attribute value for VAConfigAttribEncROI */
700 typedef union _VAConfigAttribValEncROI {
702 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
703 uint32_t num_roi_regions : 8;
705 * \brief A flag indicates whether ROI priority is supported
707 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
708 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
709 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
710 * the underlying driver doesn't support ROI priority.
712 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
713 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
715 uint32_t roi_rc_priority_support : 1;
717 * \brief A flag indicates whether ROI delta QP is supported
719 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
720 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
721 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
722 * the underlying driver doesn't support ROI delta QP.
724 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
725 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
727 uint32_t roi_rc_qp_delta_support : 1;
728 uint32_t reserved : 22;
731 } VAConfigAttribValEncROI;
733 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
734 typedef union _VAConfigAttribValEncRateControlExt {
737 * \brief The maximum number of temporal layers minus 1
739 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
740 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
741 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
743 uint32_t max_num_temporal_layers_minus1 : 8;
746 * /brief support temporal layer bit-rate control flag
748 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
749 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
750 * #VAConfigAttribRateControl == #VA_RC_VBR).
752 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
753 * \c max_num_temporal_layers_minus1 is equal to 0
755 * To use bit-rate control per temporal layer, an application must send the right layer
756 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
757 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
758 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
759 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
760 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
761 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
762 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
764 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
765 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
766 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
768 uint32_t temporal_layer_bitrate_control_flag : 1;
769 uint32_t reserved : 23;
772 } VAConfigAttribValEncRateControlExt;
775 * if an attribute is not applicable for a given
776 * profile/entrypoint pair, then set the value to the following
778 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
780 /** Get maximum number of profiles supported by the implementation */
781 int vaMaxNumProfiles (
785 /** Get maximum number of entrypoints supported by the implementation */
786 int vaMaxNumEntrypoints (
790 /** Get maximum number of attributs supported by the implementation */
791 int vaMaxNumConfigAttributes (
796 * Query supported profiles
797 * The caller must provide a "profile_list" array that can hold at
798 * least vaMaxNumProfile() entries. The actual number of profiles
799 * returned in "profile_list" is returned in "num_profile".
801 VAStatus vaQueryConfigProfiles (
803 VAProfile *profile_list, /* out */
804 int *num_profiles /* out */
808 * Query supported entrypoints for a given profile
809 * The caller must provide an "entrypoint_list" array that can hold at
810 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
811 * returned in "entrypoint_list" is returned in "num_entrypoints".
813 VAStatus vaQueryConfigEntrypoints (
816 VAEntrypoint *entrypoint_list, /* out */
817 int *num_entrypoints /* out */
821 * Get attributes for a given profile/entrypoint pair
822 * The caller must provide an "attrib_list" with all attributes to be
823 * retrieved. Upon return, the attributes in "attrib_list" have been
824 * updated with their value. Unknown attributes or attributes that are
825 * not supported for the given profile/entrypoint pair will have their
826 * value set to VA_ATTRIB_NOT_SUPPORTED
828 VAStatus vaGetConfigAttributes (
831 VAEntrypoint entrypoint,
832 VAConfigAttrib *attrib_list, /* in/out */
836 /** Generic ID type, can be re-typed for specific implementation */
837 typedef unsigned int VAGenericID;
839 typedef VAGenericID VAConfigID;
842 * Create a configuration for the video decode/encode/processing pipeline
843 * it passes in the attribute list that specifies the attributes it cares
844 * about, with the rest taking default values.
846 VAStatus vaCreateConfig (
849 VAEntrypoint entrypoint,
850 VAConfigAttrib *attrib_list,
852 VAConfigID *config_id /* out */
856 * Free resources associdated with a given config
858 VAStatus vaDestroyConfig (
864 * Query all attributes for a given configuration
865 * The profile of the configuration is returned in "profile"
866 * The entrypoint of the configuration is returned in "entrypoint"
867 * The caller must provide an "attrib_list" array that can hold at least
868 * vaMaxNumConfigAttributes() entries. The actual number of attributes
869 * returned in "attrib_list" is returned in "num_attribs"
871 VAStatus vaQueryConfigAttributes (
873 VAConfigID config_id,
874 VAProfile *profile, /* out */
875 VAEntrypoint *entrypoint, /* out */
876 VAConfigAttrib *attrib_list,/* out */
877 int *num_attribs /* out */
882 * Contexts and Surfaces
884 * Context represents a "virtual" video decode, encode or video processing
885 * pipeline. Surfaces are render targets for a given context. The data in the
886 * surfaces are not accessible to the client except if derived image is supported
887 * and the internal data format of the surface is implementation specific.
889 * Surfaces are provided as a hint of what surfaces will be used when the context
890 * is created through vaCreateContext(). A surface may be used by different contexts
891 * at the same time as soon as application can make sure the operations are synchronized
892 * between different contexts, e.g. a surface is used as the output of a decode context
893 * and the input of a video process context. Surfaces can only be destroyed after all
894 * contexts using these surfaces have been destroyed.
896 * Both contexts and surfaces are identified by unique IDs and its
897 * implementation specific internals are kept opaque to the clients
900 typedef VAGenericID VAContextID;
902 typedef VAGenericID VASurfaceID;
904 #define VA_INVALID_ID 0xffffffff
905 #define VA_INVALID_SURFACE VA_INVALID_ID
907 /** \brief Generic value types. */
909 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
910 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
911 VAGenericValueTypePointer, /**< Generic pointer type */
912 VAGenericValueTypeFunc /**< Pointer to function */
913 } VAGenericValueType;
915 /** \brief Generic function type. */
916 typedef void (*VAGenericFunc)(void);
918 /** \brief Generic value. */
919 typedef struct _VAGenericValue {
920 /** \brief Value type. See #VAGenericValueType. */
921 VAGenericValueType type;
922 /** \brief Value holder. */
924 /** \brief 32-bit signed integer. */
926 /** \brief 32-bit float. */
928 /** \brief Generic pointer. */
930 /** \brief Pointer to function. */
935 /** @name Surface attribute flags */
937 /** \brief Surface attribute is not supported. */
938 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
939 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
940 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
941 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
942 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
945 /** \brief Surface attribute types. */
947 VASurfaceAttribNone = 0,
949 * \brief Pixel format (fourcc).
951 * The value is meaningful as input to vaQuerySurfaceAttributes().
952 * If zero, the driver returns the optimal pixel format for the
953 * specified config. Otherwise, if non-zero, the value represents
954 * a pixel format (FOURCC) that is kept as is on output, if the
955 * driver supports it. Otherwise, the driver sets the value to
956 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
958 VASurfaceAttribPixelFormat,
959 /** \brief Minimal width in pixels (int, read-only). */
960 VASurfaceAttribMinWidth,
961 /** \brief Maximal width in pixels (int, read-only). */
962 VASurfaceAttribMaxWidth,
963 /** \brief Minimal height in pixels (int, read-only). */
964 VASurfaceAttribMinHeight,
965 /** \brief Maximal height in pixels (int, read-only). */
966 VASurfaceAttribMaxHeight,
967 /** \brief Surface memory type expressed in bit fields (int, read/write). */
968 VASurfaceAttribMemoryType,
969 /** \brief External buffer descriptor (pointer, write). */
970 VASurfaceAttribExternalBufferDescriptor,
971 /** \brief Surface usage hint, gives the driver a hint of intended usage
972 * to optimize allocation (e.g. tiling) (int, read/write). */
973 VASurfaceAttribUsageHint,
974 /** \brief Number of surface attributes. */
976 } VASurfaceAttribType;
978 /** \brief Surface attribute. */
979 typedef struct _VASurfaceAttrib {
981 VASurfaceAttribType type;
982 /** \brief Flags. See "Surface attribute flags". */
984 /** \brief Value. See "Surface attribute types" for the expected types. */
985 VAGenericValue value;
989 * @name VASurfaceAttribMemoryType values in bit fields.
990 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
991 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
992 * types are defined in DRM and Android header files.
995 /** \brief VA memory type (default) is supported. */
996 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
997 /** \brief V4L2 buffer memory type is supported. */
998 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
999 /** \brief User pointer memory type is supported. */
1000 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1004 * \brief VASurfaceAttribExternalBuffers structure for
1005 * the VASurfaceAttribExternalBufferDescriptor attribute.
1007 typedef struct _VASurfaceAttribExternalBuffers {
1008 /** \brief pixel format in fourcc. */
1009 uint32_t pixel_format;
1010 /** \brief width in pixels. */
1012 /** \brief height in pixels. */
1014 /** \brief total size of the buffer in bytes. */
1016 /** \brief number of planes for planar layout */
1017 uint32_t num_planes;
1018 /** \brief pitch for each plane in bytes */
1019 uint32_t pitches[4];
1020 /** \brief offset for each plane in bytes */
1021 uint32_t offsets[4];
1022 /** \brief buffer handles or user pointers */
1024 /** \brief number of elements in the "buffers" array */
1025 uint32_t num_buffers;
1026 /** \brief flags. See "Surface external buffer descriptor flags". */
1028 /** \brief reserved for passing private data */
1030 } VASurfaceAttribExternalBuffers;
1032 /** @name VASurfaceAttribExternalBuffers flags */
1034 /** \brief Enable memory tiling */
1035 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1036 /** \brief Memory is cacheable */
1037 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1038 /** \brief Memory is non-cacheable */
1039 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1040 /** \brief Memory is write-combined */
1041 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1042 /** \brief Memory is protected */
1043 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1045 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1047 /** \brief Surface usage not indicated. */
1048 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1049 /** \brief Surface used by video decoder. */
1050 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1051 /** \brief Surface used by video encoder. */
1052 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1053 /** \brief Surface read by video post-processing. */
1054 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1055 /** \brief Surface written by video post-processing. */
1056 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1057 /** \brief Surface used for display. */
1058 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1063 * \brief Queries surface attributes for the supplied config.
1065 * This function queries for all supported attributes for the
1066 * supplied VA @config. In particular, if the underlying hardware
1067 * supports the creation of VA surfaces in various formats, then
1068 * this function will enumerate all pixel formats that are supported.
1070 * The \c attrib_list array is allocated by the user and \c
1071 * num_attribs shall be initialized to the number of allocated
1072 * elements in that array. Upon successful return, the actual number
1073 * of attributes will be overwritten into \c num_attribs. Otherwise,
1074 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1075 * is adjusted to the number of elements that would be returned if
1076 * enough space was available.
1078 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1079 * argument when vaQuerySurfaceAttributes() is used to determine the
1080 * actual number of elements that need to be allocated.
1082 * @param[in] dpy the VA display
1083 * @param[in] config the config identifying a codec or a video
1084 * processing pipeline
1085 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1086 * @param[in,out] num_attribs the number of elements allocated on
1087 * input, the number of elements actually filled in output
1090 vaQuerySurfaceAttributes(
1093 VASurfaceAttrib *attrib_list,
1094 unsigned int *num_attribs
1098 * \brief Creates an array of surfaces
1100 * Creates an array of surfaces. The optional list of attributes shall
1101 * be constructed based on what the underlying hardware could expose
1102 * through vaQuerySurfaceAttributes().
1104 * @param[in] dpy the VA display
1105 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1106 * @param[in] width the surface width
1107 * @param[in] height the surface height
1108 * @param[out] surfaces the array of newly created surfaces
1109 * @param[in] num_surfaces the number of surfaces to create
1110 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1111 * @param[in] num_attribs the number of attributes supplied in
1112 * \c attrib_list, or zero
1117 unsigned int format,
1119 unsigned int height,
1120 VASurfaceID *surfaces,
1121 unsigned int num_surfaces,
1122 VASurfaceAttrib *attrib_list,
1123 unsigned int num_attribs
1127 * vaDestroySurfaces - Destroy resources associated with surfaces.
1128 * Surfaces can only be destroyed after all contexts using these surfaces have been
1131 * surfaces: array of surfaces to destroy
1132 * num_surfaces: number of surfaces in the array to be destroyed.
1134 VAStatus vaDestroySurfaces (
1136 VASurfaceID *surfaces,
1140 #define VA_PROGRESSIVE 0x1
1142 * vaCreateContext - Create a context
1144 * config_id: configuration for the context
1145 * picture_width: coded picture width
1146 * picture_height: coded picture height
1147 * flag: any combination of the following:
1148 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1149 * render_targets: a hint for render targets (surfaces) tied to the context
1150 * num_render_targets: number of render targets in the above array
1151 * context: created context id upon return
1153 VAStatus vaCreateContext (
1155 VAConfigID config_id,
1159 VASurfaceID *render_targets,
1160 int num_render_targets,
1161 VAContextID *context /* out */
1165 * vaDestroyContext - Destroy a context
1167 * context: context to be destroyed
1169 VAStatus vaDestroyContext (
1176 * Buffers are used to pass various types of data from the
1177 * client to the server. The server maintains a data store
1178 * for each buffer created, and the client idenfies a buffer
1179 * through a unique buffer id assigned by the server.
1182 typedef VAGenericID VABufferID;
1186 VAPictureParameterBufferType = 0,
1187 VAIQMatrixBufferType = 1,
1188 VABitPlaneBufferType = 2,
1189 VASliceGroupMapBufferType = 3,
1190 VASliceParameterBufferType = 4,
1191 VASliceDataBufferType = 5,
1192 VAMacroblockParameterBufferType = 6,
1193 VAResidualDataBufferType = 7,
1194 VADeblockingParameterBufferType = 8,
1195 VAImageBufferType = 9,
1196 VAProtectedSliceDataBufferType = 10,
1197 VAQMatrixBufferType = 11,
1198 VAHuffmanTableBufferType = 12,
1199 VAProbabilityBufferType = 13,
1201 /* Following are encode buffer types */
1202 VAEncCodedBufferType = 21,
1203 VAEncSequenceParameterBufferType = 22,
1204 VAEncPictureParameterBufferType = 23,
1205 VAEncSliceParameterBufferType = 24,
1206 VAEncPackedHeaderParameterBufferType = 25,
1207 VAEncPackedHeaderDataBufferType = 26,
1208 VAEncMiscParameterBufferType = 27,
1209 VAEncMacroblockParameterBufferType = 28,
1210 VAEncMacroblockMapBufferType = 29,
1213 * \brief Encoding QP buffer
1215 * This buffer contains QP per MB for encoding. Currently
1216 * VAEncQPBufferH264 is defined for H.264 encoding, see
1217 * #VAEncQPBufferH264 for details
1219 VAEncQPBufferType = 30,
1220 /* Following are video processing buffer types */
1222 * \brief Video processing pipeline parameter buffer.
1224 * This buffer describes the video processing pipeline. See
1225 * #VAProcPipelineParameterBuffer for details.
1227 VAProcPipelineParameterBufferType = 41,
1229 * \brief Video filter parameter buffer.
1231 * This buffer describes the video filter parameters. All buffers
1232 * inherit from #VAProcFilterParameterBufferBase, thus including
1233 * a unique filter buffer type.
1235 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1236 * Filters requiring advanced parameters include, but are not limited to,
1237 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1238 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1240 VAProcFilterParameterBufferType = 42,
1242 * \brief FEI specific buffer types
1244 VAEncFEIMVBufferType = 43,
1245 VAEncFEIMBCodeBufferType = 44,
1246 VAEncFEIDistortionBufferType = 45,
1247 VAEncFEIMBControlBufferType = 46,
1248 VAEncFEIMVPredictorBufferType = 47,
1254 VAEncMiscParameterTypeFrameRate = 0,
1255 VAEncMiscParameterTypeRateControl = 1,
1256 VAEncMiscParameterTypeMaxSliceSize = 2,
1257 VAEncMiscParameterTypeAIR = 3,
1258 /** \brief Buffer type used to express a maximum frame size (in bits). */
1259 VAEncMiscParameterTypeMaxFrameSize = 4,
1260 /** \brief Buffer type used for HRD parameters. */
1261 VAEncMiscParameterTypeHRD = 5,
1262 VAEncMiscParameterTypeQualityLevel = 6,
1263 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1264 * rate control, when the user has externally skipped frames. */
1265 VAEncMiscParameterTypeSkipFrame = 9,
1266 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1267 VAEncMiscParameterTypeROI = 10,
1268 /** \brief Buffer type used for temporal layer structure */
1269 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1270 /** \brief Buffer type used for FEI input frame level parameters */
1271 VAEncMiscParameterTypeFEIFrameControl = 18,
1272 } VAEncMiscParameterType;
1274 /** \brief Packed header type. */
1276 /** \brief Packed sequence header. */
1277 VAEncPackedHeaderSequence = 1,
1278 /** \brief Packed picture header. */
1279 VAEncPackedHeaderPicture = 2,
1280 /** \brief Packed slice header. */
1281 VAEncPackedHeaderSlice = 3,
1283 * \brief Packed raw header.
1285 * Packed raw data header can be used by the client to insert a header
1286 * into the bitstream data buffer at the point it is passed, the driver
1287 * will handle the raw packed header based on "has_emulation_bytes" field
1288 * in the packed header parameter structure.
1290 VAEncPackedHeaderRawData = 4,
1292 * \brief Misc packed header. See codec-specific definitions.
1295 * This is a deprecated packed header type. All applications can use
1296 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1298 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1299 } VAEncPackedHeaderType;
1301 /** \brief Packed header parameter. */
1302 typedef struct _VAEncPackedHeaderParameterBuffer {
1303 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1305 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1306 uint32_t bit_length;
1307 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1308 uint8_t has_emulation_bytes;
1309 } VAEncPackedHeaderParameterBuffer;
1312 * For application, e.g. set a new bitrate
1313 * VABufferID buf_id;
1314 * VAEncMiscParameterBuffer *misc_param;
1315 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1317 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1318 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1319 * 1, NULL, &buf_id);
1321 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1322 * misc_param->type = VAEncMiscParameterTypeRateControl;
1323 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1324 * misc_rate_ctrl->bits_per_second = 6400000;
1325 * vaUnmapBuffer(dpy, buf_id);
1326 * vaRenderPicture(dpy, context, &buf_id, 1);
1328 typedef struct _VAEncMiscParameterBuffer
1330 VAEncMiscParameterType type;
1332 } VAEncMiscParameterBuffer;
1334 /** \brief Temporal layer Structure*/
1335 typedef struct _VAEncMiscParameterTemporalLayerStructure
1337 /** \brief The number of temporal layers */
1338 uint32_t number_of_layers;
1339 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1340 uint32_t periodicity;
1342 * \brief The array indicating the layer id for each frame
1344 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1345 * ids for frames starting from the 2nd frame.
1347 uint32_t layer_id[32];
1348 } VAEncMiscParameterTemporalLayerStructure;
1351 /** \brief Rate control parameters */
1352 typedef struct _VAEncMiscParameterRateControl
1354 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1355 uint32_t bits_per_second;
1356 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1357 * bit-rate for example if target_percentage is 95 then the rate control will target
1358 * a bit-rate that is 95% of the maximum bit-rate
1360 uint32_t target_percentage;
1361 /* windows size in milliseconds. For example if this is set to 500,
1362 * then the rate control will guarantee the target bit-rate over a 500 ms window
1364 uint32_t window_size;
1365 /* initial QP at I frames */
1366 uint32_t initial_qp;
1368 uint32_t basic_unit_size;
1374 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1375 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1376 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1378 * The temporal layer that the rate control parameters are specified for.
1380 uint32_t temporal_id : 8;
1381 uint32_t reserved : 17;
1385 } VAEncMiscParameterRateControl;
1387 typedef struct _VAEncMiscParameterFrameRate
1390 * The framerate is specified as a number of frames per second, as a
1391 * fraction. The denominator of the fraction is given in the top half
1392 * (the high two bytes) of the framerate field, and the numerator is
1393 * given in the bottom half (the low two bytes).
1396 * denominator = framerate >> 16 & 0xffff;
1397 * numerator = framerate & 0xffff;
1398 * fps = numerator / denominator;
1400 * For example, if framerate is set to (100 << 16 | 750), this is
1401 * 750 / 100, hence 7.5fps.
1403 * If the denominator is zero (the high two bytes are both zero) then
1404 * it takes the value one instead, so the framerate is just the integer
1405 * in the low 2 bytes.
1413 * The temporal id the framerate parameters are specified for.
1415 uint32_t temporal_id : 8;
1416 uint32_t reserved : 24;
1420 } VAEncMiscParameterFrameRate;
1423 * Allow a maximum slice size to be specified (in bits).
1424 * The encoder will attempt to make sure that individual slices do not exceed this size
1425 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1427 typedef struct _VAEncMiscParameterMaxSliceSize
1429 uint32_t max_slice_size;
1430 } VAEncMiscParameterMaxSliceSize;
1432 typedef struct _VAEncMiscParameterAIR
1434 uint32_t air_num_mbs;
1435 uint32_t air_threshold;
1436 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1437 } VAEncMiscParameterAIR;
1439 typedef struct _VAEncMiscParameterHRD
1441 uint32_t initial_buffer_fullness; /* in bits */
1442 uint32_t buffer_size; /* in bits */
1443 } VAEncMiscParameterHRD;
1446 * \brief Defines a maximum frame size (in bits).
1448 * This misc parameter buffer defines the maximum size of a frame (in
1449 * bits). The encoder will try to make sure that each frame does not
1450 * exceed this size. Otherwise, if the frame size exceeds this size,
1451 * the \c status flag of #VACodedBufferSegment will contain
1452 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1454 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1455 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1456 VAEncMiscParameterType type;
1457 /** \brief Maximum size of a frame (in bits). */
1458 uint32_t max_frame_size;
1459 } VAEncMiscParameterBufferMaxFrameSize;
1462 * \brief Encoding quality level.
1464 * The encoding quality could be set through this structure, if the implementation
1465 * supports multiple quality levels. The quality level set through this structure is
1466 * persistent over the entire coded sequence, or until a new structure is being sent.
1467 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1468 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1469 * quality. The quality level setting is used as a trade-off between quality and speed/power
1470 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1472 typedef struct _VAEncMiscParameterBufferQualityLevel {
1473 /** \brief Encoding quality level setting. When set to 0, default quality
1476 uint32_t quality_level;
1477 } VAEncMiscParameterBufferQualityLevel;
1480 * \brief Encoding skip frame.
1482 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1483 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1484 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1485 * current frame. It is allowed for the application to still send in packed headers for the driver to
1486 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1488 typedef struct _VAEncMiscParameterSkipFrame {
1489 /** \brief Indicates skip frames as below.
1490 * 0: Encode as normal, no skip.
1491 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1492 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1493 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1494 * in VAEncPackedHeaderPicture). */
1495 uint8_t skip_frame_flag;
1496 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1497 uint8_t num_skip_frames;
1498 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1499 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1500 uint32_t size_skip_frames;
1501 } VAEncMiscParameterSkipFrame;
1504 * \brief Encoding region-of-interest (ROI).
1506 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1507 * supports ROI input. The ROI set through this structure is applicable only to the
1508 * current frame or field, so must be sent every frame or field to be applied. The number of
1509 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1510 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1512 typedef struct _VAEncROI
1514 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1515 * codec coding units. It is relative to frame coordinates for the frame case and
1516 * to field coordinates for the field case. */
1517 VARectangle roi_rectangle;
1521 * \ref roi_value specifies ROI delta QP or ROI priority.
1522 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1523 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1524 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1525 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1526 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1527 * regions, the roi_value that is first in the ROI array will have priority.
1529 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1530 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1532 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1533 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1534 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1539 typedef struct _VAEncMiscParameterBufferROI {
1540 /** \brief Number of ROIs being sent.*/
1543 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1544 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1546 int8_t max_delta_qp;
1547 int8_t min_delta_qp;
1549 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1550 * coordinates for the frame case and to field coordinates for the field case.*/
1555 * \brief An indication for roi value.
1557 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1558 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1559 * in #VAEncROI should be used as ROI priority.
1561 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1562 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
1563 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1564 * when VAConfigAttribRateControl == VA_RC_CQP.
1566 uint32_t roi_value_is_qp_delta : 1;
1567 uint32_t reserved : 31;
1571 } VAEncMiscParameterBufferROI;
1574 * There will be cases where the bitstream buffer will not have enough room to hold
1575 * the data for the entire slice, and the following flags will be used in the slice
1576 * parameter to signal to the server for the possible cases.
1577 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1578 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1579 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1581 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1582 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1583 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1584 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1586 /* Codec-independent Slice Parameter Buffer base */
1587 typedef struct _VASliceParameterBufferBase
1589 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
1590 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
1591 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1592 } VASliceParameterBufferBase;
1594 /**********************************
1595 * JPEG common data structures
1596 **********************************/
1598 * \brief Huffman table for JPEG decoding.
1600 * This structure holds the complete Huffman tables. This is an
1601 * aggregation of all Huffman table (DHT) segments maintained by the
1602 * application. i.e. up to 2 Huffman tables are stored in there for
1605 * The #load_huffman_table array can be used as a hint to notify the
1606 * VA driver implementation about which table(s) actually changed
1607 * since the last submission of this buffer.
1609 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1610 /** \brief Specifies which #huffman_table is valid. */
1611 uint8_t load_huffman_table[2];
1612 /** \brief Huffman tables indexed by table identifier (Th). */
1614 /** @name DC table (up to 12 categories) */
1616 /** \brief Number of Huffman codes of length i + 1 (Li). */
1617 uint8_t num_dc_codes[16];
1618 /** \brief Value associated with each Huffman code (Vij). */
1619 uint8_t dc_values[12];
1621 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1623 /** \brief Number of Huffman codes of length i + 1 (Li). */
1624 uint8_t num_ac_codes[16];
1625 /** \brief Value associated with each Huffman code (Vij). */
1626 uint8_t ac_values[162];
1627 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1631 } VAHuffmanTableBufferJPEGBaseline;
1633 /****************************
1634 * MPEG-2 data structures
1635 ****************************/
1637 /* MPEG-2 Picture Parameter Buffer */
1639 * For each frame or field, and before any slice data, a single
1640 * picture parameter buffer must be send.
1642 typedef struct _VAPictureParameterBufferMPEG2
1644 uint16_t horizontal_size;
1645 uint16_t vertical_size;
1646 VASurfaceID forward_reference_picture;
1647 VASurfaceID backward_reference_picture;
1648 /* meanings of the following fields are the same as in the standard */
1649 int32_t picture_coding_type;
1650 int32_t f_code; /* pack all four fcode into this */
1653 uint32_t intra_dc_precision : 2;
1654 uint32_t picture_structure : 2;
1655 uint32_t top_field_first : 1;
1656 uint32_t frame_pred_frame_dct : 1;
1657 uint32_t concealment_motion_vectors : 1;
1658 uint32_t q_scale_type : 1;
1659 uint32_t intra_vlc_format : 1;
1660 uint32_t alternate_scan : 1;
1661 uint32_t repeat_first_field : 1;
1662 uint32_t progressive_frame : 1;
1663 uint32_t is_first_field : 1; /* indicate whether the current field
1664 * is the first field for field picture
1668 } picture_coding_extension;
1669 } VAPictureParameterBufferMPEG2;
1671 /** MPEG-2 Inverse Quantization Matrix Buffer */
1672 typedef struct _VAIQMatrixBufferMPEG2
1674 /** \brief Same as the MPEG-2 bitstream syntax element. */
1675 int32_t load_intra_quantiser_matrix;
1676 /** \brief Same as the MPEG-2 bitstream syntax element. */
1677 int32_t load_non_intra_quantiser_matrix;
1678 /** \brief Same as the MPEG-2 bitstream syntax element. */
1679 int32_t load_chroma_intra_quantiser_matrix;
1680 /** \brief Same as the MPEG-2 bitstream syntax element. */
1681 int32_t load_chroma_non_intra_quantiser_matrix;
1682 /** \brief Luminance intra matrix, in zig-zag scan order. */
1683 uint8_t intra_quantiser_matrix[64];
1684 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1685 uint8_t non_intra_quantiser_matrix[64];
1686 /** \brief Chroma intra matrix, in zig-zag scan order. */
1687 uint8_t chroma_intra_quantiser_matrix[64];
1688 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1689 uint8_t chroma_non_intra_quantiser_matrix[64];
1690 } VAIQMatrixBufferMPEG2;
1692 /** MPEG-2 Slice Parameter Buffer */
1693 typedef struct _VASliceParameterBufferMPEG2
1695 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1696 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1697 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1698 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1699 uint32_t slice_horizontal_position;
1700 uint32_t slice_vertical_position;
1701 int32_t quantiser_scale_code;
1702 int32_t intra_slice_flag;
1703 } VASliceParameterBufferMPEG2;
1705 /** MPEG-2 Macroblock Parameter Buffer */
1706 typedef struct _VAMacroblockParameterBufferMPEG2
1708 uint16_t macroblock_address;
1710 * macroblock_address (in raster scan order)
1712 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1714 uint8_t macroblock_type; /* see definition below */
1717 uint32_t frame_motion_type : 2;
1718 uint32_t field_motion_type : 2;
1719 uint32_t dct_type : 1;
1723 uint8_t motion_vertical_field_select;
1725 * motion_vertical_field_select:
1726 * see section 6.3.17.2 in the spec
1727 * only the lower 4 bits are used
1728 * bit 0: first vector forward
1729 * bit 1: first vector backward
1730 * bit 2: second vector forward
1731 * bit 3: second vector backward
1733 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
1734 uint16_t coded_block_pattern;
1736 * The bitplanes for coded_block_pattern are described
1737 * in Figure 6.10-12 in the spec
1740 /* Number of skipped macroblocks after this macroblock */
1741 uint16_t num_skipped_macroblocks;
1742 } VAMacroblockParameterBufferMPEG2;
1745 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1747 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1748 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1749 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1750 #define VA_MB_TYPE_MOTION_INTRA 0x10
1753 * MPEG-2 Residual Data Buffer
1754 * For each macroblock, there wil be 64 shorts (16-bit) in the
1755 * residual data buffer
1758 /****************************
1759 * MPEG-4 Part 2 data structures
1760 ****************************/
1762 /* MPEG-4 Picture Parameter Buffer */
1764 * For each frame or field, and before any slice data, a single
1765 * picture parameter buffer must be send.
1767 typedef struct _VAPictureParameterBufferMPEG4
1770 uint16_t vop_height;
1771 VASurfaceID forward_reference_picture;
1772 VASurfaceID backward_reference_picture;
1775 uint32_t short_video_header : 1;
1776 uint32_t chroma_format : 2;
1777 uint32_t interlaced : 1;
1778 uint32_t obmc_disable : 1;
1779 uint32_t sprite_enable : 2;
1780 uint32_t sprite_warping_accuracy : 2;
1781 uint32_t quant_type : 1;
1782 uint32_t quarter_sample : 1;
1783 uint32_t data_partitioned : 1;
1784 uint32_t reversible_vlc : 1;
1785 uint32_t resync_marker_disable : 1;
1789 uint8_t no_of_sprite_warping_points;
1790 int16_t sprite_trajectory_du[3];
1791 int16_t sprite_trajectory_dv[3];
1792 uint8_t quant_precision;
1795 uint32_t vop_coding_type : 2;
1796 uint32_t backward_reference_vop_coding_type : 2;
1797 uint32_t vop_rounding_type : 1;
1798 uint32_t intra_dc_vlc_thr : 3;
1799 uint32_t top_field_first : 1;
1800 uint32_t alternate_vertical_scan_flag : 1;
1804 uint8_t vop_fcode_forward;
1805 uint8_t vop_fcode_backward;
1806 uint16_t vop_time_increment_resolution;
1807 /* short header related */
1808 uint8_t num_gobs_in_vop;
1809 uint8_t num_macroblocks_in_gob;
1810 /* for direct mode prediction */
1813 } VAPictureParameterBufferMPEG4;
1815 /** MPEG-4 Inverse Quantization Matrix Buffer */
1816 typedef struct _VAIQMatrixBufferMPEG4
1818 /** Same as the MPEG-4:2 bitstream syntax element. */
1819 int32_t load_intra_quant_mat;
1820 /** Same as the MPEG-4:2 bitstream syntax element. */
1821 int32_t load_non_intra_quant_mat;
1822 /** The matrix for intra blocks, in zig-zag scan order. */
1823 uint8_t intra_quant_mat[64];
1824 /** The matrix for non-intra blocks, in zig-zag scan order. */
1825 uint8_t non_intra_quant_mat[64];
1826 } VAIQMatrixBufferMPEG4;
1828 /** MPEG-4 Slice Parameter Buffer */
1829 typedef struct _VASliceParameterBufferMPEG4
1831 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1832 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1833 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1834 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1835 uint32_t macroblock_number;
1836 int32_t quant_scale;
1837 } VASliceParameterBufferMPEG4;
1840 VC-1 data structures
1843 typedef enum /* see 7.1.1.32 */
1846 VAMvMode1MvHalfPel = 1,
1847 VAMvMode1MvHalfPelBilinear = 2,
1848 VAMvModeMixedMv = 3,
1849 VAMvModeIntensityCompensation = 4
1852 /** VC-1 Picture Parameter Buffer */
1854 * For each picture, and before any slice data, a picture parameter
1855 * buffer must be send. Multiple picture parameter buffers may be
1856 * sent for a single picture. In that case picture parameters will
1857 * apply to all slice data that follow it until a new picture
1858 * parameter buffer is sent.
1861 * pic_quantizer_type should be set to the applicable quantizer
1862 * type as defined by QUANTIZER (J.1.19) and either
1863 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1865 typedef struct _VAPictureParameterBufferVC1
1867 VASurfaceID forward_reference_picture;
1868 VASurfaceID backward_reference_picture;
1869 /* if out-of-loop post-processing is done on the render
1870 target, then we need to keep the in-loop decoded
1871 picture as a reference picture */
1872 VASurfaceID inloop_decoded_picture;
1874 /* sequence layer for AP or meta data for SP and MP */
1877 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1878 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1879 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1880 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1881 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
1882 uint32_t multires : 1; /* METADATA::MULTIRES */
1883 uint32_t overlap : 1; /* METADATA::OVERLAP */
1884 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
1885 uint32_t rangered : 1; /* METADATA::RANGERED */
1886 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
1887 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1892 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1893 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1896 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1897 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1898 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1899 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1902 } entrypoint_fields;
1903 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1904 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1907 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1908 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1909 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1910 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1913 } range_mapping_fields;
1915 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
1916 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1917 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1918 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1919 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
1920 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
1921 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1922 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
1923 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1927 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
1928 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1929 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
1930 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
1931 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1937 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1938 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
1939 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
1940 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
1941 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
1942 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
1943 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
1949 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1950 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1951 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
1952 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
1953 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1954 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
1955 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
1958 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1961 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1962 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1963 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1964 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1970 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1971 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1972 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1973 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1974 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1975 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1976 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1977 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1978 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1979 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1985 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1986 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1987 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
1988 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1989 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1990 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1991 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1992 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1993 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1994 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1995 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1998 } pic_quantizer_fields;
2001 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2002 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2003 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2004 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2005 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2006 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2010 } VAPictureParameterBufferVC1;
2012 /** VC-1 Bitplane Buffer
2013 There will be at most three bitplanes coded in any picture header. To send
2014 the bitplane data more efficiently, each byte is divided in two nibbles, with
2015 each nibble carrying three bitplanes for one macroblock. The following table
2016 shows the bitplane data arrangement within each nibble based on the picture
2019 Picture Type Bit3 Bit2 Bit1 Bit0
2020 I or BI OVERFLAGS ACPRED FIELDTX
2021 P MYTYPEMB SKIPMB DIRECTMB
2022 B FORWARDMB SKIPMB DIRECTMB
2024 Within each byte, the lower nibble is for the first MB and the upper nibble is
2025 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2026 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2027 Macroblock #2 in the first row.
2030 /* VC-1 Slice Parameter Buffer */
2031 typedef struct _VASliceParameterBufferVC1
2033 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2034 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2035 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2036 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2037 uint32_t slice_vertical_position;
2038 } VASliceParameterBufferVC1;
2040 /* VC-1 Slice Data Buffer */
2042 This is simplely a buffer containing raw bit-stream bytes
2045 /****************************
2046 * H.264/AVC data structures
2047 ****************************/
2049 typedef struct _VAPictureH264
2051 VASurfaceID picture_id;
2054 int32_t TopFieldOrderCnt;
2055 int32_t BottomFieldOrderCnt;
2057 /* flags in VAPictureH264 could be OR of the following */
2058 #define VA_PICTURE_H264_INVALID 0x00000001
2059 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2060 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2061 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2062 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2064 /** H.264 Picture Parameter Buffer */
2066 * For each picture, and before any slice data, a single
2067 * picture parameter buffer must be send.
2069 typedef struct _VAPictureParameterBufferH264
2071 VAPictureH264 CurrPic;
2072 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2073 uint16_t picture_width_in_mbs_minus1;
2074 uint16_t picture_height_in_mbs_minus1;
2075 uint8_t bit_depth_luma_minus8;
2076 uint8_t bit_depth_chroma_minus8;
2077 uint8_t num_ref_frames;
2080 uint32_t chroma_format_idc : 2;
2081 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2082 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2083 uint32_t frame_mbs_only_flag : 1;
2084 uint32_t mb_adaptive_frame_field_flag : 1;
2085 uint32_t direct_8x8_inference_flag : 1;
2086 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2087 uint32_t log2_max_frame_num_minus4 : 4;
2088 uint32_t pic_order_cnt_type : 2;
2089 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2090 uint32_t delta_pic_order_always_zero_flag : 1;
2094 // FMO is not supported.
2095 va_deprecated uint8_t num_slice_groups_minus1;
2096 va_deprecated uint8_t slice_group_map_type;
2097 va_deprecated uint16_t slice_group_change_rate_minus1;
2098 int8_t pic_init_qp_minus26;
2099 int8_t pic_init_qs_minus26;
2100 int8_t chroma_qp_index_offset;
2101 int8_t second_chroma_qp_index_offset;
2104 uint32_t entropy_coding_mode_flag : 1;
2105 uint32_t weighted_pred_flag : 1;
2106 uint32_t weighted_bipred_idc : 2;
2107 uint32_t transform_8x8_mode_flag : 1;
2108 uint32_t field_pic_flag : 1;
2109 uint32_t constrained_intra_pred_flag : 1;
2110 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2111 uint32_t deblocking_filter_control_present_flag : 1;
2112 uint32_t redundant_pic_cnt_present_flag : 1;
2113 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2118 } VAPictureParameterBufferH264;
2120 /** H.264 Inverse Quantization Matrix Buffer */
2121 typedef struct _VAIQMatrixBufferH264
2123 /** \brief 4x4 scaling list, in raster scan order. */
2124 uint8_t ScalingList4x4[6][16];
2125 /** \brief 8x8 scaling list, in raster scan order. */
2126 uint8_t ScalingList8x8[2][64];
2127 } VAIQMatrixBufferH264;
2129 /** H.264 Slice Parameter Buffer */
2130 typedef struct _VASliceParameterBufferH264
2132 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2133 /** \brief Byte offset to the NAL Header Unit for this slice. */
2134 uint32_t slice_data_offset;
2135 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2137 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2139 * This bit offset is relative to and includes the NAL unit byte
2140 * and represents the number of bits parsed in the slice_header()
2141 * after the removal of any emulation prevention bytes in
2142 * there. However, the slice data buffer passed to the hardware is
2143 * the original bitstream, thus including any emulation prevention
2146 uint16_t slice_data_bit_offset;
2147 uint16_t first_mb_in_slice;
2149 uint8_t direct_spatial_mv_pred_flag;
2151 * H264/AVC syntax element
2153 * if num_ref_idx_active_override_flag equals 0, host decoder should
2154 * set its value to num_ref_idx_l0_default_active_minus1.
2156 uint8_t num_ref_idx_l0_active_minus1;
2158 * H264/AVC syntax element
2160 * if num_ref_idx_active_override_flag equals 0, host decoder should
2161 * set its value to num_ref_idx_l1_default_active_minus1.
2163 uint8_t num_ref_idx_l1_active_minus1;
2164 uint8_t cabac_init_idc;
2165 int8_t slice_qp_delta;
2166 uint8_t disable_deblocking_filter_idc;
2167 int8_t slice_alpha_c0_offset_div2;
2168 int8_t slice_beta_offset_div2;
2169 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2170 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2171 uint8_t luma_log2_weight_denom;
2172 uint8_t chroma_log2_weight_denom;
2173 uint8_t luma_weight_l0_flag;
2174 int16_t luma_weight_l0[32];
2175 int16_t luma_offset_l0[32];
2176 uint8_t chroma_weight_l0_flag;
2177 int16_t chroma_weight_l0[32][2];
2178 int16_t chroma_offset_l0[32][2];
2179 uint8_t luma_weight_l1_flag;
2180 int16_t luma_weight_l1[32];
2181 int16_t luma_offset_l1[32];
2182 uint8_t chroma_weight_l1_flag;
2183 int16_t chroma_weight_l1[32][2];
2184 int16_t chroma_offset_l1[32][2];
2185 } VASliceParameterBufferH264;
2187 /****************************
2188 * Common encode data structures
2189 ****************************/
2192 VAEncPictureTypeIntra = 0,
2193 VAEncPictureTypePredictive = 1,
2194 VAEncPictureTypeBidirectional = 2,
2197 /* Encode Slice Parameter Buffer */
2198 typedef struct _VAEncSliceParameterBuffer
2200 uint32_t start_row_number; /* starting MB row number for this slice */
2201 uint32_t slice_height; /* slice height measured in MB */
2204 uint32_t is_intra : 1;
2205 uint32_t disable_deblocking_filter_idc : 2;
2206 uint32_t uses_long_term_ref :1;
2207 uint32_t is_long_term_ref :1;
2211 } VAEncSliceParameterBuffer;
2214 /****************************
2215 * H.263 specific encode data structures
2216 ****************************/
2218 typedef struct _VAEncSequenceParameterBufferH263
2220 uint32_t intra_period;
2221 uint32_t bits_per_second;
2222 uint32_t frame_rate;
2223 uint32_t initial_qp;
2225 } VAEncSequenceParameterBufferH263;
2227 typedef struct _VAEncPictureParameterBufferH263
2229 VASurfaceID reference_picture;
2230 VASurfaceID reconstructed_picture;
2231 VABufferID coded_buf;
2232 uint16_t picture_width;
2233 uint16_t picture_height;
2234 VAEncPictureType picture_type;
2235 } VAEncPictureParameterBufferH263;
2237 /****************************
2238 * MPEG-4 specific encode data structures
2239 ****************************/
2241 typedef struct _VAEncSequenceParameterBufferMPEG4
2243 uint8_t profile_and_level_indication;
2244 uint32_t intra_period;
2245 uint32_t video_object_layer_width;
2246 uint32_t video_object_layer_height;
2247 uint32_t vop_time_increment_resolution;
2248 uint32_t fixed_vop_rate;
2249 uint32_t fixed_vop_time_increment;
2250 uint32_t bits_per_second;
2251 uint32_t frame_rate;
2252 uint32_t initial_qp;
2254 } VAEncSequenceParameterBufferMPEG4;
2256 typedef struct _VAEncPictureParameterBufferMPEG4
2258 VASurfaceID reference_picture;
2259 VASurfaceID reconstructed_picture;
2260 VABufferID coded_buf;
2261 uint16_t picture_width;
2262 uint16_t picture_height;
2263 uint32_t modulo_time_base; /* number of 1s */
2264 uint32_t vop_time_increment;
2265 VAEncPictureType picture_type;
2266 } VAEncPictureParameterBufferMPEG4;
2270 /** Buffer functions */
2273 * Creates a buffer for "num_elements" elements of "size" bytes and
2274 * initalize with "data".
2275 * if "data" is null, then the contents of the buffer data store
2277 * Basically there are two ways to get buffer data to the server side. One is
2278 * to call vaCreateBuffer() with a non-null "data", which results the data being
2279 * copied to the data store on the server side. A different method that
2280 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2281 * and then use vaMapBuffer() to map the data store from the server side to the
2282 * client address space for access.
2283 * The user must call vaDestroyBuffer() to destroy a buffer.
2284 * Note: image buffers are created by the library, not the client. Please see
2285 * vaCreateImage on how image buffers are managed.
2287 VAStatus vaCreateBuffer (
2289 VAContextID context,
2290 VABufferType type, /* in */
2291 unsigned int size, /* in */
2292 unsigned int num_elements, /* in */
2293 void *data, /* in */
2294 VABufferID *buf_id /* out */
2298 * Convey to the server how many valid elements are in the buffer.
2299 * e.g. if multiple slice parameters are being held in a single buffer,
2300 * this will communicate to the server the number of slice parameters
2301 * that are valid in the buffer.
2303 VAStatus vaBufferSetNumElements (
2305 VABufferID buf_id, /* in */
2306 unsigned int num_elements /* in */
2311 * device independent data structure for codedbuffer
2315 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2316 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2317 * enough for the encoder to attempt to limit its size.
2318 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2319 * exceeded the maximum slice size specified.
2320 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2321 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2322 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2324 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2325 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2326 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2327 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2328 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2330 * \brief The frame has exceeded the maximum requested size.
2332 * This flag indicates that the encoded frame size exceeds the value
2333 * specified through a misc parameter buffer of type
2334 * #VAEncMiscParameterTypeMaxFrameSize.
2336 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2337 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2340 * \brief The coded buffer segment contains a single NAL unit.
2342 * This flag indicates that the coded buffer segment contains a
2343 * single NAL unit. This flag might be useful to the user for
2344 * processing the coded buffer.
2346 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2349 * \brief Coded buffer segment.
2351 * #VACodedBufferSegment is an element of a linked list describing
2352 * some information on the coded buffer. The coded buffer segment
2353 * could contain either a single NAL unit, or more than one NAL unit.
2354 * It is recommended (but not required) to return a single NAL unit
2355 * in a coded buffer segment, and the implementation should set the
2356 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2358 typedef struct _VACodedBufferSegment {
2360 * \brief Size of the data buffer in this segment (in bytes).
2363 /** \brief Bit offset into the data buffer where the video data starts. */
2364 uint32_t bit_offset;
2365 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2367 /** \brief Reserved for future use. */
2369 /** \brief Pointer to the start of the data buffer. */
2372 * \brief Pointer to the next #VACodedBufferSegment element,
2373 * or \c NULL if there is none.
2376 } VACodedBufferSegment;
2379 * Map data store of the buffer into the client's address space
2380 * vaCreateBuffer() needs to be called with "data" set to NULL before
2381 * calling vaMapBuffer()
2383 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2384 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2386 VAStatus vaMapBuffer (
2388 VABufferID buf_id, /* in */
2389 void **pbuf /* out */
2393 * After client making changes to a mapped data store, it needs to
2394 * "Unmap" it to let the server know that the data is ready to be
2395 * consumed by the server
2397 VAStatus vaUnmapBuffer (
2399 VABufferID buf_id /* in */
2403 * After this call, the buffer is deleted and this buffer_id is no longer valid
2405 * A buffer can be re-used and sent to the server by another Begin/Render/End
2406 * sequence if vaDestroyBuffer() is not called with this buffer.
2408 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
2409 * hardware accelerator can result in performance dropping.
2411 VAStatus vaDestroyBuffer (
2413 VABufferID buffer_id
2416 /** \brief VA buffer information */
2418 /** \brief Buffer handle */
2420 /** \brief Buffer type (See \ref VABufferType). */
2423 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2425 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2426 * to specify the set of memory types the caller is interested in.
2427 * On successful return from vaAcquireBufferHandle(), the field is
2428 * updated with the best matching memory type.
2431 /** \brief Size of the underlying buffer. */
2436 * \brief Acquires buffer handle for external API usage
2438 * Locks the VA buffer object \ref buf_id for external API usage like
2439 * EGL or OpenCL (OCL). This function is a synchronization point. This
2440 * means that any pending operation is guaranteed to be completed
2441 * prior to returning from the function.
2443 * If the referenced VA buffer object is the backing store of a VA
2444 * surface, then this function acts as if vaSyncSurface() on the
2445 * parent surface was called first.
2447 * The \ref VABufferInfo argument shall be zero'ed on input. On
2448 * successful output, the data structure is filled in with all the
2449 * necessary buffer level implementation details like handle, type,
2450 * memory type and memory size.
2452 * Note: the external API implementation, or the application, can
2453 * express the memory types it is interested in by filling in the \ref
2454 * mem_type field accordingly. On successful output, the memory type
2455 * that fits best the request and that was used is updated in the \ref
2456 * VABufferInfo data structure. If none of the supplied memory types
2457 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2458 * error is returned.
2460 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2461 * is called. Besides, no additional operation is allowed on any of
2462 * the buffer parent object until vaReleaseBufferHandle() is called.
2463 * e.g. decoding into a VA surface backed with the supplied VA buffer
2464 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2468 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2469 * does not support this interface
2470 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2471 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2472 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2473 * does not support exporting buffers of the specified type
2474 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2475 * memory types in \ref VABufferInfo.mem_type was supported
2477 * @param[in] dpy the VA display
2478 * @param[in] buf_id the VA buffer
2479 * @param[in,out] buf_info the associated VA buffer information
2480 * @return VA_STATUS_SUCCESS if successful
2483 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2486 * \brief Releases buffer after usage from external API
2488 * Unlocks the VA buffer object \ref buf_id from external API usage like
2489 * EGL or OpenCL (OCL). This function is a synchronization point. This
2490 * means that any pending operation is guaranteed to be completed
2491 * prior to returning from the function.
2493 * The \ref VABufferInfo argument shall point to the original data
2494 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2495 * This is necessary so that the VA driver implementation could
2496 * deallocate any resources that were needed.
2498 * In any case, returning from this function invalidates any contents
2499 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2500 * valid. Therefore, VA driver implementations are free to reset this
2501 * data structure to safe defaults.
2504 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2505 * does not support this interface
2506 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2507 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2508 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2509 * does not support exporting buffers of the specified type
2511 * @param[in] dpy the VA display
2512 * @param[in] buf_id the VA buffer
2513 * @return VA_STATUS_SUCCESS if successful
2516 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2519 * Render (Video Decode/Encode/Processing) Pictures
2521 * A picture represents either a frame or a field.
2523 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
2528 * Get ready for a video pipeline
2529 * - decode a picture to a target surface
2530 * - encode a picture from a target surface
2531 * - process a picture to a target surface
2533 VAStatus vaBeginPicture (
2535 VAContextID context,
2536 VASurfaceID render_target
2540 * Send video decode, encode or processing buffers to the server.
2542 VAStatus vaRenderPicture (
2544 VAContextID context,
2545 VABufferID *buffers,
2550 * Make the end of rendering for a picture.
2551 * The server should start processing all pending operations for this
2552 * surface. This call is non-blocking. The client can start another
2553 * Begin/Render/End sequence on a different render target.
2555 VAStatus vaEndPicture (
2567 * This function blocks until all pending operations on the render target
2568 * have been completed. Upon return it is safe to use the render target for a
2569 * different picture.
2571 VAStatus vaSyncSurface (
2573 VASurfaceID render_target
2578 VASurfaceRendering = 1, /* Rendering in progress */
2579 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2580 /* this status is useful if surface is used as the source */
2582 VASurfaceReady = 4, /* not being rendered or displayed */
2583 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2587 * Find out any pending ops on the render target
2589 VAStatus vaQuerySurfaceStatus (
2591 VASurfaceID render_target,
2592 VASurfaceStatus *status /* out */
2597 VADecodeSliceMissing = 0,
2598 VADecodeMBError = 1,
2599 } VADecodeErrorType;
2602 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2603 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2605 typedef struct _VASurfaceDecodeMBErrors
2607 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2608 uint32_t start_mb; /* start mb address with errors */
2609 uint32_t end_mb; /* end mb address with errors */
2610 VADecodeErrorType decode_error_type;
2611 } VASurfaceDecodeMBErrors;
2614 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2615 * it can call vaQuerySurfaceError to find out further details on the particular error.
2616 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2617 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2618 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2619 * The array is terminated if "status==-1" is detected.
2621 VAStatus vaQuerySurfaceError(
2623 VASurfaceID surface,
2624 VAStatus error_status,
2629 * Images and Subpictures
2630 * VAImage is used to either get the surface data to client memory, or
2631 * to copy image data in client memory to a surface.
2632 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2633 * is at the upper left corner with positive X to the right and positive Y down
2635 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2636 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2637 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2640 * Pre-defined fourcc codes
2642 #define VA_FOURCC_NV12 0x3231564E
2643 #define VA_FOURCC_AI44 0x34344149
2644 #define VA_FOURCC_RGBA 0x41424752
2645 #define VA_FOURCC_RGBX 0x58424752
2646 #define VA_FOURCC_BGRA 0x41524742
2647 #define VA_FOURCC_BGRX 0x58524742
2648 #define VA_FOURCC_ARGB 0x42475241
2649 #define VA_FOURCC_XRGB 0x42475258
2650 #define VA_FOURCC_ABGR 0x52474241
2651 #define VA_FOURCC_XBGR 0x52474258
2652 #define VA_FOURCC_UYVY 0x59565955
2653 #define VA_FOURCC_YUY2 0x32595559
2654 #define VA_FOURCC_AYUV 0x56555941
2655 #define VA_FOURCC_NV11 0x3131564e
2656 #define VA_FOURCC_YV12 0x32315659
2657 #define VA_FOURCC_P208 0x38303250
2658 /* IYUV same as I420, but most user perfer I420, will deprecate it */
2659 #define VA_FOURCC_IYUV 0x56555949
2660 #define VA_FOURCC_I420 0x30323449
2661 #define VA_FOURCC_YV24 0x34325659
2662 #define VA_FOURCC_YV32 0x32335659
2663 #define VA_FOURCC_Y800 0x30303859
2664 #define VA_FOURCC_IMC3 0x33434D49
2665 #define VA_FOURCC_411P 0x50313134
2666 #define VA_FOURCC_422H 0x48323234
2667 #define VA_FOURCC_422V 0x56323234
2668 #define VA_FOURCC_444P 0x50343434
2669 #define VA_FOURCC_RGBP 0x50424752
2670 #define VA_FOURCC_BGRP 0x50524742
2671 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2674 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
2676 #define VA_FOURCC_YV16 0x36315659
2678 * 10-bit and 16-bit Planar YUV 4:2:0.
2680 #define VA_FOURCC_P010 0x30313050
2681 #define VA_FOURCC_P016 0x36313050
2684 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
2686 #define VA_FOURCC_I010 0x30313049
2689 #define VA_LSB_FIRST 1
2690 #define VA_MSB_FIRST 2
2692 typedef struct _VAImageFormat
2695 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2696 uint32_t bits_per_pixel;
2697 /* for RGB formats */
2698 uint32_t depth; /* significant bits per pixel */
2700 uint32_t green_mask;
2702 uint32_t alpha_mask;
2705 typedef VAGenericID VAImageID;
2707 typedef struct _VAImage
2709 VAImageID image_id; /* uniquely identify this image */
2710 VAImageFormat format;
2711 VABufferID buf; /* image data buffer */
2713 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2714 * data store on the server side for optimal performance. The buffer will be
2715 * created by the CreateImage function, and proper storage allocated based on the image
2716 * size and format. This buffer is managed by the library implementation, and
2717 * accessed by the client through the buffer Map/Unmap functions.
2722 uint32_t num_planes; /* can not be greater than 3 */
2724 * An array indicating the scanline pitch in bytes for each plane.
2725 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2727 uint32_t pitches[3];
2729 * An array indicating the byte offset from the beginning of the image data
2730 * to the start of each plane.
2732 uint32_t offsets[3];
2734 /* The following fields are only needed for paletted formats */
2735 int32_t num_palette_entries; /* set to zero for non-palette images */
2737 * Each component is one byte and entry_bytes indicates the number of components in
2738 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2740 int32_t entry_bytes;
2742 * An array of ascii characters describing the order of the components within the bytes.
2743 * Only entry_bytes characters of the string are used.
2745 int8_t component_order[4];
2748 /** Get maximum number of image formats supported by the implementation */
2749 int vaMaxNumImageFormats (
2754 * Query supported image formats
2755 * The caller must provide a "format_list" array that can hold at
2756 * least vaMaxNumImageFormats() entries. The actual number of formats
2757 * returned in "format_list" is returned in "num_formats".
2759 VAStatus vaQueryImageFormats (
2761 VAImageFormat *format_list, /* out */
2762 int *num_formats /* out */
2766 * Create a VAImage structure
2767 * The width and height fields returned in the VAImage structure may get
2768 * enlarged for some YUV formats. Upon return from this function,
2769 * image->buf has been created and proper storage allocated by the library.
2770 * The client can access the image through the Map/Unmap calls.
2772 VAStatus vaCreateImage (
2774 VAImageFormat *format,
2777 VAImage *image /* out */
2781 * Should call DestroyImage before destroying the surface it is bound to
2783 VAStatus vaDestroyImage (
2788 VAStatus vaSetImagePalette (
2792 * pointer to an array holding the palette data. The size of the array is
2793 * num_palette_entries * entry_bytes in size. The order of the components
2794 * in the palette is described by the component_order in VAImage struct
2796 unsigned char *palette
2800 * Retrive surface data into a VAImage
2801 * Image must be in a format supported by the implementation
2803 VAStatus vaGetImage (
2805 VASurfaceID surface,
2806 int x, /* coordinates of the upper left source pixel */
2808 unsigned int width, /* width and height of the region */
2809 unsigned int height,
2814 * Copy data from a VAImage to a surface
2815 * Image must be in a format supported by the implementation
2816 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2817 * shouldn't be rendered into when this is called
2819 VAStatus vaPutImage (
2821 VASurfaceID surface,
2825 unsigned int src_width,
2826 unsigned int src_height,
2829 unsigned int dest_width,
2830 unsigned int dest_height
2834 * Derive an VAImage from an existing surface.
2835 * This interface will derive a VAImage and corresponding image buffer from
2836 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2837 * direct CPU access. This operation is only possible on implementations with
2838 * direct rendering capabilities and internal surface formats that can be
2839 * represented with a VAImage. When the operation is not possible this interface
2840 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2841 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2844 * Implementations should only return success when the resulting image buffer
2845 * would be useable with vaMap/Unmap.
2847 * When directly accessing a surface special care must be taken to insure
2848 * proper synchronization with the graphics hardware. Clients should call
2849 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2850 * rendering or currently being displayed by an overlay.
2852 * Additionally nothing about the contents of a surface should be assumed
2853 * following a vaPutSurface. Implementations are free to modify the surface for
2854 * scaling or subpicture blending within a call to vaPutImage.
2856 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2857 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2858 * vaGetImage with other surfaces is supported.
2860 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2861 * image and image buffer structures will be destroyed; however, the underlying
2862 * surface will remain unchanged until freed with vaDestroySurfaces.
2864 VAStatus vaDeriveImage (
2866 VASurfaceID surface,
2867 VAImage *image /* out */
2872 * Subpicture is a special type of image that can be blended
2873 * with a surface during vaPutSurface(). Subpicture can be used to render
2874 * DVD sub-titles or closed captioning text etc.
2877 typedef VAGenericID VASubpictureID;
2879 /** Get maximum number of subpicture formats supported by the implementation */
2880 int vaMaxNumSubpictureFormats (
2884 /** flags for subpictures */
2885 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2886 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2887 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2889 * Query supported subpicture formats
2890 * The caller must provide a "format_list" array that can hold at
2891 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2892 * for each format to indicate additional capabilities for that format. The actual
2893 * number of formats returned in "format_list" is returned in "num_formats".
2894 * flags: returned value to indicate addtional capabilities
2895 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2896 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2897 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2900 VAStatus vaQuerySubpictureFormats (
2902 VAImageFormat *format_list, /* out */
2903 unsigned int *flags, /* out */
2904 unsigned int *num_formats /* out */
2908 * Subpictures are created with an image associated.
2910 VAStatus vaCreateSubpicture (
2913 VASubpictureID *subpicture /* out */
2917 * Destroy the subpicture before destroying the image it is assocated to
2919 VAStatus vaDestroySubpicture (
2921 VASubpictureID subpicture
2925 * Bind an image to the subpicture. This image will now be associated with
2926 * the subpicture instead of the one at creation.
2928 VAStatus vaSetSubpictureImage (
2930 VASubpictureID subpicture,
2935 * If chromakey is enabled, then the area where the source value falls within
2936 * the chromakey [min, max] range is transparent
2937 * The chromakey component format is the following:
2938 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2939 * For YUV: [0:7] V [8:15] U [16:23] Y
2940 * The chromakey mask can be used to mask out certain components for chromakey
2943 VAStatus vaSetSubpictureChromakey (
2945 VASubpictureID subpicture,
2946 unsigned int chromakey_min,
2947 unsigned int chromakey_max,
2948 unsigned int chromakey_mask
2952 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2953 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2954 * the overall alpha is per-pixel alpha multiplied by the global alpha
2956 VAStatus vaSetSubpictureGlobalAlpha (
2958 VASubpictureID subpicture,
2963 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2964 * It defines the region mapping between the subpicture and the target
2965 * surfaces through source and destination rectangles (with the same width and height).
2966 * Both will be displayed at the next call to vaPutSurface. Additional
2967 * associations before the call to vaPutSurface simply overrides the association.
2969 VAStatus vaAssociateSubpicture (
2971 VASubpictureID subpicture,
2972 VASurfaceID *target_surfaces,
2974 int16_t src_x, /* upper left offset in subpicture */
2977 uint16_t src_height,
2978 int16_t dest_x, /* upper left offset in surface */
2980 uint16_t dest_width,
2981 uint16_t dest_height,
2983 * whether to enable chroma-keying, global-alpha, or screen relative mode
2984 * see VA_SUBPICTURE_XXX values
2990 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2992 VAStatus vaDeassociateSubpicture (
2994 VASubpictureID subpicture,
2995 VASurfaceID *target_surfaces,
3000 * Display attributes
3001 * Display attributes are used to control things such as contrast, hue, saturation,
3002 * brightness etc. in the rendering process. The application can query what
3003 * attributes are supported by the driver, and then set the appropriate attributes
3004 * before calling vaPutSurface()
3006 /* PowerVR IEP Lite attributes */
3009 VADISPLAYATTRIB_BLE_OFF = 0x00,
3010 VADISPLAYATTRIB_BLE_LOW,
3011 VADISPLAYATTRIB_BLE_MEDIUM,
3012 VADISPLAYATTRIB_BLE_HIGH,
3013 VADISPLAYATTRIB_BLE_NONE,
3014 } VADisplayAttribBLEMode;
3016 /** attribute value for VADisplayAttribRotation */
3017 #define VA_ROTATION_NONE 0x00000000
3018 #define VA_ROTATION_90 0x00000001
3019 #define VA_ROTATION_180 0x00000002
3020 #define VA_ROTATION_270 0x00000003
3022 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3023 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3024 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3027 #define VA_RENDER_MODE_UNDEFINED 0
3028 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3029 #define VA_RENDER_MODE_LOCAL_GPU 2
3030 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3031 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3033 /** Render device */
3034 #define VA_RENDER_DEVICE_UNDEFINED 0
3035 #define VA_RENDER_DEVICE_LOCAL 1
3036 #define VA_RENDER_DEVICE_EXTERNAL 2
3038 /** Currently defined display attribute types */
3041 VADisplayAttribBrightness = 0,
3042 VADisplayAttribContrast = 1,
3043 VADisplayAttribHue = 2,
3044 VADisplayAttribSaturation = 3,
3045 /* client can specifiy a background color for the target window
3046 * the new feature of video conference,
3047 * the uncovered area of the surface is filled by this color
3048 * also it will blend with the decoded video color
3050 VADisplayAttribBackgroundColor = 4,
3052 * this is a gettable only attribute. For some implementations that use the
3053 * hardware overlay, after PutSurface is called, the surface can not be
3054 * re-used until after the subsequent PutSurface call. If this is the case
3055 * then the value for this attribute will be set to 1 so that the client
3056 * will not attempt to re-use the surface right after returning from a call
3059 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3060 * driver may use overlay or GPU alternatively
3062 VADisplayAttribDirectSurface = 5,
3063 VADisplayAttribRotation = 6,
3064 VADisplayAttribOutofLoopDeblock = 7,
3066 /* PowerVR IEP Lite specific attributes */
3067 VADisplayAttribBLEBlackMode = 8,
3068 VADisplayAttribBLEWhiteMode = 9,
3069 VADisplayAttribBlueStretch = 10,
3070 VADisplayAttribSkinColorCorrection = 11,
3072 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3073 * conversion matrix. Each element in the matrix is float-point
3075 VADisplayAttribCSCMatrix = 12,
3076 /* specify the constant color used to blend with video surface
3077 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3078 * d: the final color to overwrite into the frame buffer
3079 * v: decoded video after color conversion,
3080 * c: video color specified by VADisplayAttribBlendColor
3081 * b: background color of the drawable
3083 VADisplayAttribBlendColor = 13,
3085 * Indicate driver to skip painting color key or not.
3086 * only applicable if the render is overlay
3088 VADisplayAttribOverlayAutoPaintColorKey = 14,
3090 * customized overlay color key, the format is RGB888
3091 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3093 VADisplayAttribOverlayColorKey = 15,
3095 * The hint for the implementation of vaPutSurface
3096 * normally, the driver could use an overlay or GPU to render the surface on the screen
3097 * this flag provides APP the flexibity to switch the render dynamically
3099 VADisplayAttribRenderMode = 16,
3101 * specify if vaPutSurface needs to render into specified monitors
3102 * one example is that one external monitor (e.g. HDMI) is enabled,
3103 * but the window manager is not aware of it, and there is no associated drawable
3105 VADisplayAttribRenderDevice = 17,
3107 * specify vaPutSurface render area if there is no drawable on the monitor
3109 VADisplayAttribRenderRect = 18,
3110 } VADisplayAttribType;
3112 /* flags for VADisplayAttribute */
3113 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3114 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3115 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3117 typedef struct _VADisplayAttribute
3119 VADisplayAttribType type;
3122 int32_t value; /* used by the set/get attribute functions */
3123 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3125 } VADisplayAttribute;
3127 /** Get maximum number of display attributs supported by the implementation */
3128 int vaMaxNumDisplayAttributes (
3133 * Query display attributes
3134 * The caller must provide a "attr_list" array that can hold at
3135 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3136 * returned in "attr_list" is returned in "num_attributes".
3138 VAStatus vaQueryDisplayAttributes (
3140 VADisplayAttribute *attr_list, /* out */
3141 int *num_attributes /* out */
3145 * Get display attributes
3146 * This function returns the current attribute values in "attr_list".
3147 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3148 * from vaQueryDisplayAttributes() can have their values retrieved.
3150 VAStatus vaGetDisplayAttributes (
3152 VADisplayAttribute *attr_list, /* in/out */
3157 * Set display attributes
3158 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3159 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3160 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3162 VAStatus vaSetDisplayAttributes (
3164 VADisplayAttribute *attr_list,
3168 /****************************
3169 * HEVC data structures
3170 ****************************/
3172 * \brief Description of picture properties of those in DPB surfaces.
3174 * If only progressive scan is supported, each surface contains one whole
3176 * Otherwise, each surface contains two fields of whole picture.
3177 * In this case, two entries of ReferenceFrames[] may share same picture_id
3180 typedef struct _VAPictureHEVC
3182 /** \brief reconstructed picture buffer surface index
3183 * invalid when taking value VA_INVALID_SURFACE.
3185 VASurfaceID picture_id;
3186 /** \brief picture order count.
3187 * in HEVC, POCs for top and bottom fields of same picture should
3188 * take different values.
3190 int32_t pic_order_cnt;
3191 /* described below */
3195 /* flags in VAPictureHEVC could be OR of the following */
3196 #define VA_PICTURE_HEVC_INVALID 0x00000001
3197 /** \brief indication of interlace scan picture.
3198 * should take same value for all the pictures in sequence.
3200 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3201 /** \brief polarity of the field picture.
3202 * top field takes even lines of buffer surface.
3203 * bottom field takes odd lines of buffer surface.
3205 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3206 /** \brief Long term reference picture */
3207 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3209 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3210 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3211 * be exclusive. No more than one of them can be set for any picture.
3212 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3213 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3214 * Application should provide valid values for both short format and long format.
3215 * The pictures in DPB with any of these three flags turned on are referred by
3216 * the current picture.
3218 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3219 * Number of ReferenceFrames[] entries with this bit set equals
3220 * NumPocStCurrBefore.
3222 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3223 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3224 * Number of ReferenceFrames[] entries with this bit set equals
3225 * NumPocStCurrAfter.
3227 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3228 /** \brief RefPicSetLtCurr of HEVC spec variable
3229 * Number of ReferenceFrames[] entries with this bit set equals
3232 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3234 #include <va/va_dec_hevc.h>
3235 #include <va/va_dec_jpeg.h>
3236 #include <va/va_dec_vp8.h>
3237 #include <va/va_dec_vp9.h>
3238 #include <va/va_enc_hevc.h>
3239 #include <va/va_enc_h264.h>
3240 #include <va/va_enc_jpeg.h>
3241 #include <va/va_enc_mpeg2.h>
3242 #include <va/va_enc_vp8.h>
3243 #include <va/va_enc_vp9.h>
3244 #include <va/va_fei.h>
3245 #include <va/va_fei_h264.h>
3246 #include <va/va_vpp.h>