2 * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19 * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
20 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 * Video Acceleration (VA) API Specification
28 * <jonathan.bian@intel.com>
31 * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
32 * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
33 * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
34 * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
35 * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
36 * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
37 * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
38 * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
39 * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
40 * and MPEG-2 motion compensation.
41 * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
42 * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
43 * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
44 * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
45 * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
46 * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
47 * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
48 * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
49 * rev 0.27 (11/19/2007 Matt Sottek) - Added DeriveImage
50 * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
52 * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
53 * added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
54 * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
55 * for ISO C conformance.
56 * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
57 * Application needs to relink with the new library.
59 * rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
60 * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
61 * screen relative rather than source video relative.
62 * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
63 * update VAAPI to 0.32.0
66 * Some concepts borrowed from XvMC and XvImage.
67 * Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
68 * contributed to various aspects of the API.
75 * This file contains the \ref api_core "Core API".
83 #include <va/va_version.h>
90 #define va_deprecated __attribute__((deprecated))
92 #define va_deprecated_enum va_deprecated
94 #define va_deprecated_enum
98 #define va_deprecated_enum
102 * \mainpage Video Acceleration (VA) API
104 * \section intro Introduction
106 * The main motivation for VA-API (Video Acceleration API) is to
107 * enable hardware accelerated video decode and encode at various
108 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
109 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
110 * AVC/H.264, VC-1/VMW3, and JPEG, HEVC/H265, VP8, VP9) and video pre/post
113 * VA-API is split into several modules:
115 * - \ref api_enc_xxx (xxx = h264, hevc, jpec, mpeg2, vp8, vp9)
116 * - \ref api_dec_xxx (xxx = hevc, jpec, vp8, vp9)
121 * \defgroup api_core Core API
129 The VA API is intended to provide an interface between a video decode/encode/processing
130 application (client) and a hardware accelerator (server), to off-load
131 video decode/encode/processing operations from the host to the hardware accelerator at various
134 The basic operation steps are:
136 - Negotiate a mutually acceptable configuration with the server to lock
137 down profile, entrypoints, and other attributes that will not change on
138 a frame-by-frame basis.
139 - Create a video decode, encode or processing context which represents a
140 "virtualized" hardware device
141 - Get and fill the render buffers with the corresponding data (depending on
142 profiles and entrypoints)
143 - Pass the render buffers to the server to handle the current frame
145 Initialization & Configuration Management
147 - Find out supported profiles
148 - Find out entrypoints for a given profile
149 - Find out configuration attributes for a given profile/entrypoint pair
150 - Create a configuration for use by the application
154 typedef void* VADisplay; /* window system dependent */
156 typedef int VAStatus; /** Return status type from functions */
157 /** Values for the return status */
158 #define VA_STATUS_SUCCESS 0x00000000
159 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
160 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
161 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
162 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
163 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
164 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
165 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
166 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
167 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
168 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
169 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
170 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
171 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
172 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
173 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
174 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
175 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
176 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
177 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
178 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
179 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
180 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
181 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
182 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
184 * \brief An invalid/unsupported value was supplied.
186 * This is a catch-all error code for invalid or unsupported values.
187 * e.g. value exceeding the valid range, invalid type in the context
188 * of generic attribute values.
190 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
191 /** \brief An unsupported filter was supplied. */
192 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
193 /** \brief An invalid filter chain was supplied. */
194 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
195 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
196 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
197 /** \brief An unsupported memory type was supplied. */
198 #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
199 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
201 /** De-interlacing flags for vaPutSurface() */
202 #define VA_FRAME_PICTURE 0x00000000
203 #define VA_TOP_FIELD 0x00000001
204 #define VA_BOTTOM_FIELD 0x00000002
207 * Enabled the positioning/cropping/blending feature:
208 * 1, specify the video playback position in the isurface
209 * 2, specify the cropping info for video playback
210 * 3, encoded video will blend with background color
212 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
215 * Clears the drawable with background color.
216 * for hardware overlay based implementation this flag
217 * can be used to turn off the overlay
219 #define VA_CLEAR_DRAWABLE 0x00000008
221 /** Color space conversion flags for vaPutSurface() */
222 #define VA_SRC_COLOR_MASK 0x000000f0
223 #define VA_SRC_BT601 0x00000010
224 #define VA_SRC_BT709 0x00000020
225 #define VA_SRC_SMPTE_240 0x00000040
227 /** Scaling flags for vaPutSurface() */
228 #define VA_FILTER_SCALING_DEFAULT 0x00000000
229 #define VA_FILTER_SCALING_FAST 0x00000100
230 #define VA_FILTER_SCALING_HQ 0x00000200
231 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
232 #define VA_FILTER_SCALING_MASK 0x00000f00
234 /** Padding size in 4-bytes */
235 #define VA_PADDING_LOW 4
236 #define VA_PADDING_MEDIUM 8
237 #define VA_PADDING_HIGH 16
238 #define VA_PADDING_LARGE 32
241 * Returns a short english description of error_status
243 const char *vaErrorStr(VAStatus error_status);
245 typedef struct _VARectangle
253 /** \brief Generic motion vector data structure. */
254 typedef struct _VAMotionVector {
255 /** \mv0[0]: horizontal motion vector for past reference */
256 /** \mv0[1]: vertical motion vector for past reference */
257 /** \mv1[0]: horizontal motion vector for future reference */
258 /** \mv1[1]: vertical motion vector for future reference */
259 int16_t mv0[2]; /* past reference */
260 int16_t mv1[2]; /* future reference */
263 /** Type of a message callback, used for both error and info log. */
264 typedef void (*VAMessageCallback)(void *user_context, const char *message);
267 * Set the callback for error messages, or NULL for no logging.
268 * Returns the previous one, or NULL if it was disabled.
270 VAMessageCallback vaSetErrorCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
273 * Set the callback for info messages, or NULL for no logging.
274 * Returns the previous one, or NULL if it was disabled.
276 VAMessageCallback vaSetInfoCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
280 * A display must be obtained by calling vaGetDisplay() before calling
281 * vaInitialize() and other functions. This connects the API to the
282 * native window system.
283 * For X Windows, native_dpy would be from XOpenDisplay()
285 typedef void* VANativeDisplay; /* window system dependent */
287 int vaDisplayIsValid(VADisplay dpy);
290 * Set the override driver name instead of queried driver driver.
292 VAStatus vaSetDriverName(VADisplay dpy,
297 * Initialize the library
299 VAStatus vaInitialize (
301 int *major_version, /* out */
302 int *minor_version /* out */
306 * After this call, all library internal resources will be cleaned up
308 VAStatus vaTerminate (
313 * vaQueryVendorString returns a pointer to a zero-terminated string
314 * describing some aspects of the VA implemenation on a specific
315 * hardware accelerator. The format of the returned string is vendor
316 * specific and at the discretion of the implementer.
317 * e.g. for the Intel GMA500 implementation, an example would be:
318 * "Intel GMA500 - 2.0.0.32L.0005"
320 const char *vaQueryVendorString (
324 typedef int (*VAPrivFunc)(void);
327 * Return a function pointer given a function name in the library.
328 * This allows private interfaces into the library
330 VAPrivFunc vaGetLibFunc (
335 /** Currently defined profiles */
338 /** \brief Profile ID used for video processing. */
340 VAProfileMPEG2Simple = 0,
341 VAProfileMPEG2Main = 1,
342 VAProfileMPEG4Simple = 2,
343 VAProfileMPEG4AdvancedSimple = 3,
344 VAProfileMPEG4Main = 4,
345 VAProfileH264Baseline va_deprecated_enum = 5,
346 VAProfileH264Main = 6,
347 VAProfileH264High = 7,
348 VAProfileVC1Simple = 8,
349 VAProfileVC1Main = 9,
350 VAProfileVC1Advanced = 10,
351 VAProfileH263Baseline = 11,
352 VAProfileJPEGBaseline = 12,
353 VAProfileH264ConstrainedBaseline = 13,
354 VAProfileVP8Version0_3 = 14,
355 VAProfileH264MultiviewHigh = 15,
356 VAProfileH264StereoHigh = 16,
357 VAProfileHEVCMain = 17,
358 VAProfileHEVCMain10 = 18,
359 VAProfileVP9Profile0 = 19,
360 VAProfileVP9Profile1 = 20,
361 VAProfileVP9Profile2 = 21,
362 VAProfileVP9Profile3 = 22
366 * Currently defined entrypoints
372 VAEntrypointIDCT = 3,
373 VAEntrypointMoComp = 4,
374 VAEntrypointDeblocking = 5,
375 VAEntrypointEncSlice = 6, /* slice level encode */
376 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
378 * For an implementation that supports a low power/high performance variant
379 * for slice level encode, it can choose to expose the
380 * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
381 * available with this entrypoint (e.g. interlace, MBAFF) and the
382 * application can query the encoding configuration attributes to find
383 * out more details if this entrypoint is supported.
385 VAEntrypointEncSliceLP = 8,
386 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
388 * \brief VAEntrypointFEI
390 * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to
391 * have more controls and trade off quality for speed with their own IPs.
392 * The application can optionally provide input to ENC for extra encode control
393 * and get the output from ENC. Application can chose to modify the ENC
394 * output/PAK input during encoding, but the performance impact is significant.
396 * On top of the existing buffers for normal encode, there will be
397 * one extra input buffer (VAEncMiscParameterFEIFrameControl) and
398 * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType
399 * and VAEncFEIDistortionBufferType) for VAEntrypointFEI entry function.
400 * If separate PAK is set, two extra input buffers
401 * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input.
403 VAEntrypointFEI = 11,
406 /** Currently defined configuration attribute types */
409 VAConfigAttribRTFormat = 0,
410 VAConfigAttribSpatialResidual = 1,
411 VAConfigAttribSpatialClipping = 2,
412 VAConfigAttribIntraResidual = 3,
413 VAConfigAttribEncryption = 4,
414 VAConfigAttribRateControl = 5,
416 /** @name Attributes for decoding */
419 * \brief Slice Decoding mode. Read/write.
421 * This attribute determines what mode the driver supports for slice
422 * decoding, through vaGetConfigAttributes(); and what mode the user
423 * will be providing to the driver, through vaCreateConfig(), if the
424 * driver supports those. If this attribute is not set by the user then
425 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
427 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
429 VAConfigAttribDecSliceMode = 6,
431 * \brief JPEG decoding attribute. Read-only.
433 * This attribute exposes a number of capabilities of the underlying
434 * JPEG implementation. The attribute value is partitioned into fields as defined in the
435 * VAConfigAttribValDecJPEG union.
437 VAConfigAttribDecJPEG = 7,
438 /** @name Attributes for encoding */
441 * \brief Packed headers mode. Read/write.
443 * This attribute determines what packed headers the driver supports,
444 * through vaGetConfigAttributes(); and what packed headers the user
445 * will be providing to the driver, through vaCreateConfig(), if the
446 * driver supports those.
448 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
450 VAConfigAttribEncPackedHeaders = 10,
452 * \brief Interlaced mode. Read/write.
454 * This attribute determines what kind of interlaced encoding mode
455 * the driver supports.
457 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
459 VAConfigAttribEncInterlaced = 11,
461 * \brief Maximum number of reference frames. Read-only.
463 * This attribute determines the maximum number of reference
464 * frames supported for encoding.
466 * Note: for H.264 encoding, the value represents the maximum number
467 * of reference frames for both the reference picture list 0 (bottom
468 * 16 bits) and the reference picture list 1 (top 16 bits).
470 VAConfigAttribEncMaxRefFrames = 13,
472 * \brief Maximum number of slices per frame. Read-only.
474 * This attribute determines the maximum number of slices the
475 * driver can support to encode a single frame.
477 VAConfigAttribEncMaxSlices = 14,
479 * \brief Slice structure. Read-only.
481 * This attribute determines slice structures supported by the
482 * driver for encoding. This attribute is a hint to the user so
483 * that he can choose a suitable surface size and how to arrange
484 * the encoding process of multiple slices per frame.
486 * More specifically, for H.264 encoding, this attribute
487 * determines the range of accepted values to
488 * VAEncSliceParameterBufferH264::macroblock_address and
489 * VAEncSliceParameterBufferH264::num_macroblocks.
491 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
494 VAConfigAttribEncSliceStructure = 15,
496 * \brief Macroblock information. Read-only.
498 * This attribute determines whether the driver supports extra
499 * encoding information per-macroblock. e.g. QP.
501 * More specifically, for H.264 encoding, if the driver returns a non-zero
502 * value for this attribute, this means the application can create
503 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
504 * through VAEncSliceParameterBufferH264::macroblock_info.
506 VAConfigAttribEncMacroblockInfo = 16,
508 * \brief Maximum picture width. Read-only.
510 * This attribute determines the maximum picture width the driver supports
511 * for a given configuration.
513 VAConfigAttribMaxPictureWidth = 18,
515 * \brief Maximum picture height. Read-only.
517 * This attribute determines the maximum picture height the driver supports
518 * for a given configuration.
520 VAConfigAttribMaxPictureHeight = 19,
522 * \brief JPEG encoding attribute. Read-only.
524 * This attribute exposes a number of capabilities of the underlying
525 * JPEG implementation. The attribute value is partitioned into fields as defined in the
526 * VAConfigAttribValEncJPEG union.
528 VAConfigAttribEncJPEG = 20,
530 * \brief Encoding quality range attribute. Read-only.
532 * This attribute conveys whether the driver supports different quality level settings
533 * for encoding. A value less than or equal to 1 means that the encoder only has a single
534 * quality setting, and a value greater than 1 represents the number of quality levels
535 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
537 VAConfigAttribEncQualityRange = 21,
539 * \brief Encoding quantization attribute. Read-only.
541 * This attribute conveys whether the driver supports certain types of quantization methods
542 * for encoding (e.g. trellis). See \c VA_ENC_QUANTIZATION_xxx for the list of quantization methods
544 VAConfigAttribEncQuantization = 22,
546 * \brief Encoding intra refresh attribute. Read-only.
548 * This attribute conveys whether the driver supports certain types of intra refresh methods
549 * for encoding (e.g. adaptive intra refresh or rolling intra refresh).
550 * See \c VA_ENC_INTRA_REFRESH_xxx for intra refresh methods
552 VAConfigAttribEncIntraRefresh = 23,
554 * \brief Encoding skip frame attribute. Read-only.
556 * This attribute conveys whether the driver supports sending skip frame parameters
557 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
558 * externally skipped frames.
560 VAConfigAttribEncSkipFrame = 24,
562 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
564 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
565 * based on user provided ROI rectangles. The attribute value is partitioned into fields
566 * as defined in the VAConfigAttribValEncROI union.
568 * If ROI encoding is supported, the ROI information is passed to the driver using
569 * VAEncMiscParameterTypeROI.
571 VAConfigAttribEncROI = 25,
573 * \brief Encoding extended rate control attribute. Read-only.
575 * This attribute conveys whether the driver supports any extended rate control features
576 * The attribute value is partitioned into fields as defined in the
577 * VAConfigAttribValEncRateControlExt union.
579 VAConfigAttribEncRateControlExt = 26,
581 * \brief Processing rate reporting attribute. Read-only.
583 * This attribute conveys whether the driver supports reporting of
584 * encode/decode processing rate based on certain set of parameters
585 * (i.e. levels, I frame internvals) for a given configuration.
586 * If this is supported, vaQueryProcessingRate() can be used to get
587 * encode or decode processing rate.
588 * See \c VA_PROCESSING_RATE_xxx for encode/decode processing rate
590 VAConfigAttribProcessingRate = 27,
592 * \brief Encoding dirty rectangle. Read-only.
594 * This attribute conveys whether the driver supports dirty rectangle.
595 * encoding, based on user provided ROI rectangles which indicate the rectangular areas
596 * where the content has changed as compared to the previous picture. The regions of the
597 * picture that are not covered by dirty rect rectangles are assumed to have not changed
598 * compared to the previous picture. The encoder may do some optimizations based on
599 * this information. The attribute value returned indicates the number of regions that
600 * are supported. e.g. A value of 0 means dirty rect encoding is not supported. If dirty
601 * rect encoding is supported, the ROI information is passed to the driver using
602 * VAEncMiscParameterTypeDirtyRect.
604 VAConfigAttribEncDirtyRect = 28,
606 * \brief Parallel Rate Control (hierachical B) attribute. Read-only.
608 * This attribute conveys whether the encoder supports parallel rate control.
609 * It is a integer value 0 - unsupported, > 0 - maximum layer supported.
610 * This is the way when hireachical B frames are encoded, multiple independent B frames
611 * on the same layer may be processed at same time. If supported, app may enable it by
612 * setting enable_parallel_brc in VAEncMiscParameterRateControl,and the number of B frames
613 * per layer per GOP will be passed to driver through VAEncMiscParameterParallelRateControl
614 * structure.Currently three layers are defined.
616 VAConfigAttribEncParallelRateControl = 29,
618 * \brief Dynamic Scaling Attribute. Read-only.
620 * This attribute conveys whether encoder is capable to determine dynamic frame
621 * resolutions adaptive to bandwidth utilization and processing power, etc.
622 * It is a boolean value 0 - unsupported, 1 - supported.
623 * If it is supported,for VP9, suggested frame resolution can be retrieved from VACodedBufferVP9Status.
625 VAConfigAttribEncDynamicScaling = 30,
628 * \brief Encode function type for FEI.
630 * This attribute conveys whether the driver supports different function types for encode.
631 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
632 * it is for FEI entry point only.
633 * Default is VA_FEI_FUNCTION_ENC_PAK.
635 VAConfigAttribFEIFunctionType = 32,
637 * \brief Maximum number of FEI MV predictors. Read-only.
639 * This attribute determines the maximum number of MV predictors the driver
640 * can support to encode a single frame. 0 means no MV predictor is supported.
641 * Currently it is for FEI entry point only.
643 VAConfigAttribFEIMVPredictors = 33,
645 VAConfigAttribTypeMax
646 } VAConfigAttribType;
649 * Configuration attributes
650 * If there is more than one value for an attribute, a default
651 * value will be assigned to the attribute if the client does not
652 * specify the attribute when creating a configuration
654 typedef struct _VAConfigAttrib {
655 VAConfigAttribType type;
656 uint32_t value; /* OR'd flags (bits) for this attribute */
659 /** attribute value for VAConfigAttribRTFormat */
660 #define VA_RT_FORMAT_YUV420 0x00000001
661 #define VA_RT_FORMAT_YUV422 0x00000002
662 #define VA_RT_FORMAT_YUV444 0x00000004
663 #define VA_RT_FORMAT_YUV411 0x00000008
664 #define VA_RT_FORMAT_YUV400 0x00000010
665 /** YUV formats with more than 8 bpp */
666 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
668 #define VA_RT_FORMAT_RGB16 0x00010000
669 #define VA_RT_FORMAT_RGB32 0x00020000
670 /* RGBP covers RGBP and BGRP fourcc */
671 #define VA_RT_FORMAT_RGBP 0x00100000
672 #define VA_RT_FORMAT_PROTECTED 0x80000000
674 /** @name Attribute values for VAConfigAttribRateControl */
676 /** \brief Driver does not support any form of rate control. */
677 #define VA_RC_NONE 0x00000001
678 /** \brief Constant bitrate. */
679 #define VA_RC_CBR 0x00000002
680 /** \brief Variable bitrate. */
681 #define VA_RC_VBR 0x00000004
682 /** \brief Video conference mode. */
683 #define VA_RC_VCM 0x00000008
684 /** \brief Constant QP. */
685 #define VA_RC_CQP 0x00000010
686 /** \brief Variable bitrate with peak rate higher than average bitrate. */
687 #define VA_RC_VBR_CONSTRAINED 0x00000020
688 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
689 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
690 #define VA_RC_ICQ 0x00000040
691 /** \brief Macroblock based rate control. Per MB control is decided
692 * internally in the encoder. It may be combined with other RC modes, except CQP. */
693 #define VA_RC_MB 0x00000080
694 /** \brief Constant Frame Size, it is used for small tolerent */
695 #define VA_RC_CFS 0x00000100
696 /** \brief Parallel BRC, for hierachical B.
698 * For hierachical B, B frames can be refered by other B frames.
699 * Currently three layers of hierachy are defined:
700 * B0 - regular B, no reference to other B frames.
701 * B1 - reference to only I, P and regular B0 frames.
702 * B2 - reference to any other frames, including B1.
703 * In Hierachical B structure, B frames on the same layer can be processed
704 * simultaneously. And BRC would adjust accordingly. This is so called
706 #define VA_RC_PARALLEL 0x00000200
710 /** @name Attribute values for VAConfigAttribDecSliceMode */
712 /** \brief Driver supports normal mode for slice decoding */
713 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
714 /** \brief Driver supports base mode for slice decoding */
715 #define VA_DEC_SLICE_MODE_BASE 0x00000002
717 /** @name Attribute values for VAConfigAttribDecJPEG */
719 typedef union _VAConfigAttribValDecJPEG {
721 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
722 uint32_t rotation : 4;
723 /** \brief Reserved for future use. */
724 uint32_t reserved : 28;
727 uint32_t va_reserved[VA_PADDING_LOW];
728 } VAConfigAttribValDecJPEG;
731 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
733 /** \brief Driver does not support any packed headers mode. */
734 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
736 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
738 * Application must provide it to driver once this flag is returned through
739 * vaGetConfigAttributes()
741 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
743 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
745 * Application must provide it to driver once this falg is returned through
746 * vaGetConfigAttributes()
748 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
750 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
752 * Application must provide it to driver once this flag is returned through
753 * vaGetConfigAttributes()
755 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
757 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
760 * This is a deprecated packed header flag, All applications can use
761 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
762 * header data buffer to the driver
764 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
765 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
766 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
769 /** @name Attribute values for VAConfigAttribEncInterlaced */
771 /** \brief Driver does not support interlaced coding. */
772 #define VA_ENC_INTERLACED_NONE 0x00000000
773 /** \brief Driver supports interlaced frame coding. */
774 #define VA_ENC_INTERLACED_FRAME 0x00000001
775 /** \brief Driver supports interlaced field coding. */
776 #define VA_ENC_INTERLACED_FIELD 0x00000002
777 /** \brief Driver supports macroblock adaptive frame field coding. */
778 #define VA_ENC_INTERLACED_MBAFF 0x00000004
779 /** \brief Driver supports picture adaptive frame field coding. */
780 #define VA_ENC_INTERLACED_PAFF 0x00000008
783 /** @name Attribute values for VAConfigAttribEncSliceStructure */
785 /** \brief Driver supports a power-of-two number of rows per slice. */
786 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
787 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
788 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
789 /** \brief Dirver support 1 rows per slice */
790 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
791 /** \brief Dirver support max encoded slice size per slice */
792 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
793 /** \brief Driver supports an arbitrary number of rows per slice. */
794 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
797 /** \brief Attribute value for VAConfigAttribEncJPEG */
798 typedef union _VAConfigAttribValEncJPEG {
800 /** \brief set to 1 for arithmatic coding. */
801 uint32_t arithmatic_coding_mode : 1;
802 /** \brief set to 1 for progressive dct. */
803 uint32_t progressive_dct_mode : 1;
804 /** \brief set to 1 for non-interleaved. */
805 uint32_t non_interleaved_mode : 1;
806 /** \brief set to 1 for differential. */
807 uint32_t differential_mode : 1;
808 uint32_t max_num_components : 3;
809 uint32_t max_num_scans : 4;
810 uint32_t max_num_huffman_tables : 3;
811 uint32_t max_num_quantization_tables : 3;
814 } VAConfigAttribValEncJPEG;
816 /** @name Attribute values for VAConfigAttribEncQuantization */
818 /** \brief Driver does not support special types of quantization */
819 #define VA_ENC_QUANTIZATION_NONE 0x00000000
820 /** \brief Driver supports trellis quantization */
821 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
824 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
826 /** \brief Driver does not support intra refresh */
827 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
828 /** \brief Driver supports column based rolling intra refresh */
829 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
830 /** \brief Driver supports row based rolling intra refresh */
831 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
832 /** \brief Driver supports adaptive intra refresh */
833 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
834 /** \brief Driver supports cyclic intra refresh */
835 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
836 /** \brief Driver supports intra refresh of P frame*/
837 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
838 /** \brief Driver supports intra refresh of B frame */
839 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
840 /** \brief Driver supports intra refresh of multiple reference encoder */
841 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
845 /** \brief Attribute value for VAConfigAttribEncROI */
846 typedef union _VAConfigAttribValEncROI {
848 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
849 uint32_t num_roi_regions : 8;
851 * \brief A flag indicates whether ROI priority is supported
853 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
854 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
855 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
856 * the underlying driver doesn't support ROI priority.
858 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
859 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
861 uint32_t roi_rc_priority_support : 1;
863 * \brief A flag indicates whether ROI delta QP is supported
865 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
866 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
867 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
868 * the underlying driver doesn't support ROI delta QP.
870 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
871 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
873 uint32_t roi_rc_qp_delta_support : 1;
874 uint32_t reserved : 22;
877 } VAConfigAttribValEncROI;
879 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
880 typedef union _VAConfigAttribValEncRateControlExt {
883 * \brief The maximum number of temporal layers minus 1
885 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
886 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
887 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
889 uint32_t max_num_temporal_layers_minus1 : 8;
892 * /brief support temporal layer bit-rate control flag
894 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
895 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
896 * #VAConfigAttribRateControl == #VA_RC_VBR).
898 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
899 * \c max_num_temporal_layers_minus1 is equal to 0
901 * To use bit-rate control per temporal layer, an application must send the right layer
902 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
903 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
904 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
905 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
906 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
907 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
908 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
910 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
911 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
912 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
914 uint32_t temporal_layer_bitrate_control_flag : 1;
915 uint32_t reserved : 23;
918 } VAConfigAttribValEncRateControlExt;
920 /** @name Attribute values for VAConfigAttribProcessingRate. */
922 /** \brief Driver does not support processing rate report */
923 #define VA_PROCESSING_RATE_NONE 0x00000000
924 /** \brief Driver supports encode processing rate report */
925 #define VA_PROCESSING_RATE_ENCODE 0x00000001
926 /** \brief Driver supports decode processing rate report */
927 #define VA_PROCESSING_RATE_DECODE 0x00000002
930 * if an attribute is not applicable for a given
931 * profile/entrypoint pair, then set the value to the following
933 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
935 /** Get maximum number of profiles supported by the implementation */
936 int vaMaxNumProfiles (
940 /** Get maximum number of entrypoints supported by the implementation */
941 int vaMaxNumEntrypoints (
945 /** Get maximum number of attributs supported by the implementation */
946 int vaMaxNumConfigAttributes (
951 * Query supported profiles
952 * The caller must provide a "profile_list" array that can hold at
953 * least vaMaxNumProfile() entries. The actual number of profiles
954 * returned in "profile_list" is returned in "num_profile".
956 VAStatus vaQueryConfigProfiles (
958 VAProfile *profile_list, /* out */
959 int *num_profiles /* out */
963 * Query supported entrypoints for a given profile
964 * The caller must provide an "entrypoint_list" array that can hold at
965 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
966 * returned in "entrypoint_list" is returned in "num_entrypoints".
968 VAStatus vaQueryConfigEntrypoints (
971 VAEntrypoint *entrypoint_list, /* out */
972 int *num_entrypoints /* out */
976 * Get attributes for a given profile/entrypoint pair
977 * The caller must provide an "attrib_list" with all attributes to be
978 * retrieved. Upon return, the attributes in "attrib_list" have been
979 * updated with their value. Unknown attributes or attributes that are
980 * not supported for the given profile/entrypoint pair will have their
981 * value set to VA_ATTRIB_NOT_SUPPORTED
983 VAStatus vaGetConfigAttributes (
986 VAEntrypoint entrypoint,
987 VAConfigAttrib *attrib_list, /* in/out */
991 /** Generic ID type, can be re-typed for specific implementation */
992 typedef unsigned int VAGenericID;
994 typedef VAGenericID VAConfigID;
997 * Create a configuration for the video decode/encode/processing pipeline
998 * it passes in the attribute list that specifies the attributes it cares
999 * about, with the rest taking default values.
1001 VAStatus vaCreateConfig (
1004 VAEntrypoint entrypoint,
1005 VAConfigAttrib *attrib_list,
1007 VAConfigID *config_id /* out */
1011 * Free resources associdated with a given config
1013 VAStatus vaDestroyConfig (
1015 VAConfigID config_id
1019 * Query all attributes for a given configuration
1020 * The profile of the configuration is returned in "profile"
1021 * The entrypoint of the configuration is returned in "entrypoint"
1022 * The caller must provide an "attrib_list" array that can hold at least
1023 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1024 * returned in "attrib_list" is returned in "num_attribs"
1026 VAStatus vaQueryConfigAttributes (
1028 VAConfigID config_id,
1029 VAProfile *profile, /* out */
1030 VAEntrypoint *entrypoint, /* out */
1031 VAConfigAttrib *attrib_list,/* out */
1032 int *num_attribs /* out */
1037 * Contexts and Surfaces
1039 * Context represents a "virtual" video decode, encode or video processing
1040 * pipeline. Surfaces are render targets for a given context. The data in the
1041 * surfaces are not accessible to the client except if derived image is supported
1042 * and the internal data format of the surface is implementation specific.
1044 * Surfaces are provided as a hint of what surfaces will be used when the context
1045 * is created through vaCreateContext(). A surface may be used by different contexts
1046 * at the same time as soon as application can make sure the operations are synchronized
1047 * between different contexts, e.g. a surface is used as the output of a decode context
1048 * and the input of a video process context. Surfaces can only be destroyed after all
1049 * contexts using these surfaces have been destroyed.
1051 * Both contexts and surfaces are identified by unique IDs and its
1052 * implementation specific internals are kept opaque to the clients
1055 typedef VAGenericID VAContextID;
1057 typedef VAGenericID VASurfaceID;
1059 #define VA_INVALID_ID 0xffffffff
1060 #define VA_INVALID_SURFACE VA_INVALID_ID
1062 /** \brief Generic value types. */
1064 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1065 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1066 VAGenericValueTypePointer, /**< Generic pointer type */
1067 VAGenericValueTypeFunc /**< Pointer to function */
1068 } VAGenericValueType;
1070 /** \brief Generic function type. */
1071 typedef void (*VAGenericFunc)(void);
1073 /** \brief Generic value. */
1074 typedef struct _VAGenericValue {
1075 /** \brief Value type. See #VAGenericValueType. */
1076 VAGenericValueType type;
1077 /** \brief Value holder. */
1079 /** \brief 32-bit signed integer. */
1081 /** \brief 32-bit float. */
1083 /** \brief Generic pointer. */
1085 /** \brief Pointer to function. */
1090 /** @name Surface attribute flags */
1092 /** \brief Surface attribute is not supported. */
1093 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1094 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1095 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1096 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1097 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1100 /** \brief Surface attribute types. */
1102 VASurfaceAttribNone = 0,
1104 * \brief Pixel format (fourcc).
1106 * The value is meaningful as input to vaQuerySurfaceAttributes().
1107 * If zero, the driver returns the optimal pixel format for the
1108 * specified config. Otherwise, if non-zero, the value represents
1109 * a pixel format (FOURCC) that is kept as is on output, if the
1110 * driver supports it. Otherwise, the driver sets the value to
1111 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1113 VASurfaceAttribPixelFormat,
1114 /** \brief Minimal width in pixels (int, read-only). */
1115 VASurfaceAttribMinWidth,
1116 /** \brief Maximal width in pixels (int, read-only). */
1117 VASurfaceAttribMaxWidth,
1118 /** \brief Minimal height in pixels (int, read-only). */
1119 VASurfaceAttribMinHeight,
1120 /** \brief Maximal height in pixels (int, read-only). */
1121 VASurfaceAttribMaxHeight,
1122 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1123 VASurfaceAttribMemoryType,
1124 /** \brief External buffer descriptor (pointer, write). */
1125 VASurfaceAttribExternalBufferDescriptor,
1126 /** \brief Surface usage hint, gives the driver a hint of intended usage
1127 * to optimize allocation (e.g. tiling) (int, read/write). */
1128 VASurfaceAttribUsageHint,
1129 /** \brief Number of surface attributes. */
1130 VASurfaceAttribCount
1131 } VASurfaceAttribType;
1133 /** \brief Surface attribute. */
1134 typedef struct _VASurfaceAttrib {
1136 VASurfaceAttribType type;
1137 /** \brief Flags. See "Surface attribute flags". */
1139 /** \brief Value. See "Surface attribute types" for the expected types. */
1140 VAGenericValue value;
1144 * @name VASurfaceAttribMemoryType values in bit fields.
1145 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1146 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1147 * types are defined in DRM and Android header files.
1150 /** \brief VA memory type (default) is supported. */
1151 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1152 /** \brief V4L2 buffer memory type is supported. */
1153 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1154 /** \brief User pointer memory type is supported. */
1155 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1159 * \brief VASurfaceAttribExternalBuffers structure for
1160 * the VASurfaceAttribExternalBufferDescriptor attribute.
1162 typedef struct _VASurfaceAttribExternalBuffers {
1163 /** \brief pixel format in fourcc. */
1164 uint32_t pixel_format;
1165 /** \brief width in pixels. */
1167 /** \brief height in pixels. */
1169 /** \brief total size of the buffer in bytes. */
1171 /** \brief number of planes for planar layout */
1172 uint32_t num_planes;
1173 /** \brief pitch for each plane in bytes */
1174 uint32_t pitches[4];
1175 /** \brief offset for each plane in bytes */
1176 uint32_t offsets[4];
1177 /** \brief buffer handles or user pointers */
1179 /** \brief number of elements in the "buffers" array */
1180 uint32_t num_buffers;
1181 /** \brief flags. See "Surface external buffer descriptor flags". */
1183 /** \brief reserved for passing private data */
1185 } VASurfaceAttribExternalBuffers;
1187 /** @name VASurfaceAttribExternalBuffers flags */
1189 /** \brief Enable memory tiling */
1190 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1191 /** \brief Memory is cacheable */
1192 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1193 /** \brief Memory is non-cacheable */
1194 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1195 /** \brief Memory is write-combined */
1196 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1197 /** \brief Memory is protected */
1198 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1200 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1202 /** \brief Surface usage not indicated. */
1203 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1204 /** \brief Surface used by video decoder. */
1205 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1206 /** \brief Surface used by video encoder. */
1207 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1208 /** \brief Surface read by video post-processing. */
1209 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1210 /** \brief Surface written by video post-processing. */
1211 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1212 /** \brief Surface used for display. */
1213 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1218 * \brief Queries surface attributes for the supplied config.
1220 * This function queries for all supported attributes for the
1221 * supplied VA @config. In particular, if the underlying hardware
1222 * supports the creation of VA surfaces in various formats, then
1223 * this function will enumerate all pixel formats that are supported.
1225 * The \c attrib_list array is allocated by the user and \c
1226 * num_attribs shall be initialized to the number of allocated
1227 * elements in that array. Upon successful return, the actual number
1228 * of attributes will be overwritten into \c num_attribs. Otherwise,
1229 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1230 * is adjusted to the number of elements that would be returned if
1231 * enough space was available.
1233 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1234 * argument when vaQuerySurfaceAttributes() is used to determine the
1235 * actual number of elements that need to be allocated.
1237 * @param[in] dpy the VA display
1238 * @param[in] config the config identifying a codec or a video
1239 * processing pipeline
1240 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1241 * @param[in,out] num_attribs the number of elements allocated on
1242 * input, the number of elements actually filled in output
1245 vaQuerySurfaceAttributes(
1248 VASurfaceAttrib *attrib_list,
1249 unsigned int *num_attribs
1253 * \brief Creates an array of surfaces
1255 * Creates an array of surfaces. The optional list of attributes shall
1256 * be constructed based on what the underlying hardware could expose
1257 * through vaQuerySurfaceAttributes().
1259 * @param[in] dpy the VA display
1260 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1261 * @param[in] width the surface width
1262 * @param[in] height the surface height
1263 * @param[out] surfaces the array of newly created surfaces
1264 * @param[in] num_surfaces the number of surfaces to create
1265 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1266 * @param[in] num_attribs the number of attributes supplied in
1267 * \c attrib_list, or zero
1272 unsigned int format,
1274 unsigned int height,
1275 VASurfaceID *surfaces,
1276 unsigned int num_surfaces,
1277 VASurfaceAttrib *attrib_list,
1278 unsigned int num_attribs
1282 * vaDestroySurfaces - Destroy resources associated with surfaces.
1283 * Surfaces can only be destroyed after all contexts using these surfaces have been
1286 * surfaces: array of surfaces to destroy
1287 * num_surfaces: number of surfaces in the array to be destroyed.
1289 VAStatus vaDestroySurfaces (
1291 VASurfaceID *surfaces,
1295 #define VA_PROGRESSIVE 0x1
1297 * vaCreateContext - Create a context
1299 * config_id: configuration for the context
1300 * picture_width: coded picture width
1301 * picture_height: coded picture height
1302 * flag: any combination of the following:
1303 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1304 * render_targets: a hint for render targets (surfaces) tied to the context
1305 * num_render_targets: number of render targets in the above array
1306 * context: created context id upon return
1308 VAStatus vaCreateContext (
1310 VAConfigID config_id,
1314 VASurfaceID *render_targets,
1315 int num_render_targets,
1316 VAContextID *context /* out */
1320 * vaDestroyContext - Destroy a context
1322 * context: context to be destroyed
1324 VAStatus vaDestroyContext (
1329 //Multi-frame context
1330 typedef VAGenericID VAMFContextID;
1332 * vaCreateMFContext - Create a multi-frame context
1333 * interface encapsulating common for all streams memory objects and structures
1334 * required for single GPU task submission from several VAContextID's.
1335 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1336 * Support identification: Application can identify multi-frame feature support by ability
1337 * to create multi-frame context. If driver supports multi-frame - call successful,
1338 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1339 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1341 * VA_STATUS_SUCCESS - operation successful.
1342 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1343 * dpy: display adapter.
1344 * mf_context: Multi-Frame context encapsulating all associated context
1345 * for multi-frame submission.
1347 VAStatus vaCreateMFContext (
1349 VAMFContextID *mf_context /* out */
1353 * vaMFAddContext - Provide ability to associate each context used for
1354 * Multi-Frame submission and common Multi-Frame context.
1355 * Try to add context to understand if it is supported.
1356 * Allocation: this call allocates and/or reallocates all memory objects
1357 * common for all contexts associated with particular Multi-Frame context.
1358 * All memory required for each context(pixel buffers, internal driver
1359 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1360 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1361 * first context added will set entry point/profile for whole Multi-Frame context,
1362 * all other entry points and profiles can be rejected to be added.
1364 * VA_STATUS_SUCCESS - operation successful, context was added.
1365 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1366 * current mf_context and associated contexts and start working with new ones.
1367 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1368 * 1 - mf_context is not valid context or
1369 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1370 * and current context contradicts with previously added, application can continue with current mf_context
1371 * and other contexts passed this call, rejected context can continue work in stand-alone
1372 * mode or other mf_context.
1373 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1374 * unsupported VAEntrypoint. Application can continue with current mf_context
1375 * and other contexts passed this call, rejected context can continue work in stand-alone
1377 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1378 * but VAProfile is not supported. Application can continue with current mf_context
1379 * and other contexts passed this call, rejected context can continue work in stand-alone
1381 * dpy: display adapter.
1382 * context: context being associated with Multi-Frame context.
1383 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1385 VAStatus vaMFAddContext (
1387 VAMFContextID mf_context,
1392 * vaMFReleaseContext - Removes context from multi-frame and
1393 * association with multi-frame context.
1394 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1396 * VA_STATUS_SUCCESS - operation successful, context was removed.
1397 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1398 * application need to destroy this VAMFContextID and all assotiated VAContextID
1400 * mf_context: VAMFContextID where context is added
1401 * context: VAContextID to be added
1403 VAStatus vaMFReleaseContext (
1405 VAMFContextID mf_context,
1411 * Buffers are used to pass various types of data from the
1412 * client to the server. The server maintains a data store
1413 * for each buffer created, and the client idenfies a buffer
1414 * through a unique buffer id assigned by the server.
1417 typedef VAGenericID VABufferID;
1421 VAPictureParameterBufferType = 0,
1422 VAIQMatrixBufferType = 1,
1423 VABitPlaneBufferType = 2,
1424 VASliceGroupMapBufferType = 3,
1425 VASliceParameterBufferType = 4,
1426 VASliceDataBufferType = 5,
1427 VAMacroblockParameterBufferType = 6,
1428 VAResidualDataBufferType = 7,
1429 VADeblockingParameterBufferType = 8,
1430 VAImageBufferType = 9,
1431 VAProtectedSliceDataBufferType = 10,
1432 VAQMatrixBufferType = 11,
1433 VAHuffmanTableBufferType = 12,
1434 VAProbabilityBufferType = 13,
1436 /* Following are encode buffer types */
1437 VAEncCodedBufferType = 21,
1438 VAEncSequenceParameterBufferType = 22,
1439 VAEncPictureParameterBufferType = 23,
1440 VAEncSliceParameterBufferType = 24,
1441 VAEncPackedHeaderParameterBufferType = 25,
1442 VAEncPackedHeaderDataBufferType = 26,
1443 VAEncMiscParameterBufferType = 27,
1444 VAEncMacroblockParameterBufferType = 28,
1445 VAEncMacroblockMapBufferType = 29,
1448 * \brief Encoding QP buffer
1450 * This buffer contains QP per MB for encoding. Currently
1451 * VAEncQPBufferH264 is defined for H.264 encoding, see
1452 * #VAEncQPBufferH264 for details
1454 VAEncQPBufferType = 30,
1455 /* Following are video processing buffer types */
1457 * \brief Video processing pipeline parameter buffer.
1459 * This buffer describes the video processing pipeline. See
1460 * #VAProcPipelineParameterBuffer for details.
1462 VAProcPipelineParameterBufferType = 41,
1464 * \brief Video filter parameter buffer.
1466 * This buffer describes the video filter parameters. All buffers
1467 * inherit from #VAProcFilterParameterBufferBase, thus including
1468 * a unique filter buffer type.
1470 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1471 * Filters requiring advanced parameters include, but are not limited to,
1472 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1473 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1475 VAProcFilterParameterBufferType = 42,
1477 * \brief FEI specific buffer types
1479 VAEncFEIMVBufferType = 43,
1480 VAEncFEIMBCodeBufferType = 44,
1481 VAEncFEIDistortionBufferType = 45,
1482 VAEncFEIMBControlBufferType = 46,
1483 VAEncFEIMVPredictorBufferType = 47,
1488 * Processing rate parameter for encode.
1490 typedef struct _VAProcessingRateParameterEnc {
1491 /** \brief Profile level */
1493 uint8_t reserved[3];
1494 /** \brief quality level. When set to 0, default quality
1497 uint32_t quality_level;
1498 /** \brief Period between I frames. */
1499 uint32_t intra_period;
1500 /** \brief Period between I/P frames. */
1502 } VAProcessingRateParameterEnc;
1505 * Processing rate parameter for decode.
1507 typedef struct _VAProcessingRateParameterDec {
1508 /** \brief Profile level */
1510 uint8_t reserved0[3];
1512 } VAProcessingRateParameterDec;
1514 typedef struct _VAProcessingRateParameter {
1516 VAProcessingRateParameterEnc proc_buf_enc;
1517 VAProcessingRateParameterDec proc_buf_dec;
1519 } VAProcessingRateParameter;
1522 * \brief Queries processing rate for the supplied config.
1524 * This function queries the processing rate based on parameters in
1525 * \c proc_buf for the given \c config. Upon successful return, the processing
1526 * rate value will be stored in \c processing_rate. Processing rate is
1527 * specified as the number of macroblocks per second.
1529 * If NULL is passed to the \c proc_buf, the default processing rate for the
1530 * given configuration will be returned.
1532 * @param[in] dpy the VA display
1533 * @param[in] config the config identifying a codec or a video
1534 * processing pipeline
1535 * @param[in] proc_buf the buffer that contains the parameters for
1536 either the encode or decode processing rate
1537 * @param[out] processing_rate processing rate in number of macroblocks per
1538 second constrained by parameters specified in proc_buf
1542 vaQueryProcessingRate(
1545 VAProcessingRateParameter *proc_buf,
1546 unsigned int *processing_rate
1551 VAEncMiscParameterTypeFrameRate = 0,
1552 VAEncMiscParameterTypeRateControl = 1,
1553 VAEncMiscParameterTypeMaxSliceSize = 2,
1554 VAEncMiscParameterTypeAIR = 3,
1555 /** \brief Buffer type used to express a maximum frame size (in bits). */
1556 VAEncMiscParameterTypeMaxFrameSize = 4,
1557 /** \brief Buffer type used for HRD parameters. */
1558 VAEncMiscParameterTypeHRD = 5,
1559 VAEncMiscParameterTypeQualityLevel = 6,
1560 /** \brief Buffer type used for Rolling intra refresh */
1561 VAEncMiscParameterTypeRIR = 7,
1562 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1563 VAEncMiscParameterTypeQuantization = 8,
1564 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1565 * rate control, when the user has externally skipped frames. */
1566 VAEncMiscParameterTypeSkipFrame = 9,
1567 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1568 VAEncMiscParameterTypeROI = 10,
1569 /** \brief Buffer type used for temporal layer structure */
1570 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1571 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1572 VAEncMiscParameterTypeDirtyRect = 13,
1573 /** \brief Buffer type used for parallel BRC parameters. */
1574 VAEncMiscParameterTypeParallelBRC = 14,
1575 /** \brief Buffer type used for FEI input frame level parameters */
1576 VAEncMiscParameterTypeFEIFrameControl = 18,
1577 } VAEncMiscParameterType;
1579 /** \brief Packed header type. */
1581 /** \brief Packed sequence header. */
1582 VAEncPackedHeaderSequence = 1,
1583 /** \brief Packed picture header. */
1584 VAEncPackedHeaderPicture = 2,
1585 /** \brief Packed slice header. */
1586 VAEncPackedHeaderSlice = 3,
1588 * \brief Packed raw header.
1590 * Packed raw data header can be used by the client to insert a header
1591 * into the bitstream data buffer at the point it is passed, the driver
1592 * will handle the raw packed header based on "has_emulation_bytes" field
1593 * in the packed header parameter structure.
1595 VAEncPackedHeaderRawData = 4,
1597 * \brief Misc packed header. See codec-specific definitions.
1600 * This is a deprecated packed header type. All applications can use
1601 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1603 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1604 } VAEncPackedHeaderType;
1606 /** \brief Packed header parameter. */
1607 typedef struct _VAEncPackedHeaderParameterBuffer {
1608 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1610 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1611 uint32_t bit_length;
1612 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1613 uint8_t has_emulation_bytes;
1615 /** \brief Reserved bytes for future use, must be zero */
1616 uint32_t va_reserved[VA_PADDING_LOW];
1617 } VAEncPackedHeaderParameterBuffer;
1620 * For application, e.g. set a new bitrate
1621 * VABufferID buf_id;
1622 * VAEncMiscParameterBuffer *misc_param;
1623 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1625 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1626 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1627 * 1, NULL, &buf_id);
1629 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1630 * misc_param->type = VAEncMiscParameterTypeRateControl;
1631 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1632 * misc_rate_ctrl->bits_per_second = 6400000;
1633 * vaUnmapBuffer(dpy, buf_id);
1634 * vaRenderPicture(dpy, context, &buf_id, 1);
1636 typedef struct _VAEncMiscParameterBuffer
1638 VAEncMiscParameterType type;
1640 } VAEncMiscParameterBuffer;
1642 /** \brief Temporal layer Structure*/
1643 typedef struct _VAEncMiscParameterTemporalLayerStructure
1645 /** \brief The number of temporal layers */
1646 uint32_t number_of_layers;
1647 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1648 uint32_t periodicity;
1650 * \brief The array indicating the layer id for each frame
1652 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1653 * ids for frames starting from the 2nd frame.
1655 uint32_t layer_id[32];
1657 /** \brief Reserved bytes for future use, must be zero */
1658 uint32_t va_reserved[VA_PADDING_LOW];
1659 } VAEncMiscParameterTemporalLayerStructure;
1662 /** \brief Rate control parameters */
1663 typedef struct _VAEncMiscParameterRateControl
1665 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1666 uint32_t bits_per_second;
1667 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1668 * bit-rate for example if target_percentage is 95 then the rate control will target
1669 * a bit-rate that is 95% of the maximum bit-rate
1671 uint32_t target_percentage;
1672 /* windows size in milliseconds. For example if this is set to 500,
1673 * then the rate control will guarantee the target bit-rate over a 500 ms window
1675 uint32_t window_size;
1676 /* initial QP at I frames */
1677 uint32_t initial_qp;
1679 uint32_t basic_unit_size;
1685 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1686 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1687 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1689 * The temporal layer that the rate control parameters are specified for.
1691 uint32_t temporal_id : 8;
1692 uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1693 uint32_t enable_parallel_brc : 1;
1694 uint32_t enable_dynamic_scaling : 1;
1695 uint32_t reserved : 14;
1699 uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1700 /** \brief Reserved bytes for future use, must be zero */
1702 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1703 } VAEncMiscParameterRateControl;
1705 typedef struct _VAEncMiscParameterFrameRate
1708 * The framerate is specified as a number of frames per second, as a
1709 * fraction. The denominator of the fraction is given in the top half
1710 * (the high two bytes) of the framerate field, and the numerator is
1711 * given in the bottom half (the low two bytes).
1714 * denominator = framerate >> 16 & 0xffff;
1715 * numerator = framerate & 0xffff;
1716 * fps = numerator / denominator;
1718 * For example, if framerate is set to (100 << 16 | 750), this is
1719 * 750 / 100, hence 7.5fps.
1721 * If the denominator is zero (the high two bytes are both zero) then
1722 * it takes the value one instead, so the framerate is just the integer
1723 * in the low 2 bytes.
1731 * The temporal id the framerate parameters are specified for.
1733 uint32_t temporal_id : 8;
1734 uint32_t reserved : 24;
1739 /** \brief Reserved bytes for future use, must be zero */
1740 uint32_t va_reserved[VA_PADDING_LOW];
1741 } VAEncMiscParameterFrameRate;
1744 * Allow a maximum slice size to be specified (in bits).
1745 * The encoder will attempt to make sure that individual slices do not exceed this size
1746 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1748 typedef struct _VAEncMiscParameterMaxSliceSize
1750 uint32_t max_slice_size;
1752 /** \brief Reserved bytes for future use, must be zero */
1753 uint32_t va_reserved[VA_PADDING_LOW];
1754 } VAEncMiscParameterMaxSliceSize;
1756 typedef struct _VAEncMiscParameterAIR
1758 uint32_t air_num_mbs;
1759 uint32_t air_threshold;
1760 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1762 /** \brief Reserved bytes for future use, must be zero */
1763 uint32_t va_reserved[VA_PADDING_LOW];
1764 } VAEncMiscParameterAIR;
1767 * \brief Rolling intra refresh data structure for encoding.
1769 typedef struct _VAEncMiscParameterRIR
1775 * \brief Indicate if intra refresh is enabled in column/row.
1777 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1778 * by the driver before sending this structure.
1781 /* \brief enable RIR in column */
1782 uint32_t enable_rir_column : 1;
1783 /* \brief enable RIR in row */
1784 uint32_t enable_rir_row : 1;
1785 uint32_t reserved : 30;
1790 * \brief Indicates the column or row location in MB. It is ignored if
1793 uint16_t intra_insertion_location;
1795 * \brief Indicates the number of columns or rows in MB. It is ignored if
1798 uint16_t intra_insert_size;
1800 * \brief indicates the Qp difference for inserted intra columns or rows.
1801 * App can use this to adjust intra Qp based on bitrate & max frame size.
1803 uint8_t qp_delta_for_inserted_intra;
1804 /** \brief Reserved bytes for future use, must be zero */
1805 uint32_t va_reserved[VA_PADDING_LOW];
1806 } VAEncMiscParameterRIR;
1808 typedef struct _VAEncMiscParameterHRD
1810 uint32_t initial_buffer_fullness; /* in bits */
1811 uint32_t buffer_size; /* in bits */
1813 /** \brief Reserved bytes for future use, must be zero */
1814 uint32_t va_reserved[VA_PADDING_LOW];
1815 } VAEncMiscParameterHRD;
1818 * \brief Defines a maximum frame size (in bits).
1820 * This misc parameter buffer defines the maximum size of a frame (in
1821 * bits). The encoder will try to make sure that each frame does not
1822 * exceed this size. Otherwise, if the frame size exceeds this size,
1823 * the \c status flag of #VACodedBufferSegment will contain
1824 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1826 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1827 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1828 VAEncMiscParameterType type;
1829 /** \brief Maximum size of a frame (in bits). */
1830 uint32_t max_frame_size;
1832 /** \brief Reserved bytes for future use, must be zero */
1833 uint32_t va_reserved[VA_PADDING_LOW];
1834 } VAEncMiscParameterBufferMaxFrameSize;
1837 * \brief Encoding quality level.
1839 * The encoding quality could be set through this structure, if the implementation
1840 * supports multiple quality levels. The quality level set through this structure is
1841 * persistent over the entire coded sequence, or until a new structure is being sent.
1842 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1843 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1844 * quality. The quality level setting is used as a trade-off between quality and speed/power
1845 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1847 typedef struct _VAEncMiscParameterBufferQualityLevel {
1848 /** \brief Encoding quality level setting. When set to 0, default quality
1851 uint32_t quality_level;
1853 /** \brief Reserved bytes for future use, must be zero */
1854 uint32_t va_reserved[VA_PADDING_LOW];
1855 } VAEncMiscParameterBufferQualityLevel;
1858 * \brief Quantization settings for encoding.
1860 * Some encoders support special types of quantization such as trellis, and this structure
1861 * can be used by the app to control these special types of quantization by the encoder.
1863 typedef struct _VAEncMiscParameterQuantization
1867 /* if no flags is set then quantization is determined by the driver */
1870 /* \brief disable trellis for all frames/fields */
1871 uint64_t disable_trellis : 1;
1872 /* \brief enable trellis for I frames/fields */
1873 uint64_t enable_trellis_I : 1;
1874 /* \brief enable trellis for P frames/fields */
1875 uint64_t enable_trellis_P : 1;
1876 /* \brief enable trellis for B frames/fields */
1877 uint64_t enable_trellis_B : 1;
1878 uint64_t reserved : 28;
1881 } quantization_flags;
1882 } VAEncMiscParameterQuantization;
1885 * \brief Encoding skip frame.
1887 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1888 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1889 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1890 * current frame. It is allowed for the application to still send in packed headers for the driver to
1891 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1893 typedef struct _VAEncMiscParameterSkipFrame {
1894 /** \brief Indicates skip frames as below.
1895 * 0: Encode as normal, no skip.
1896 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1897 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1898 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1899 * in VAEncPackedHeaderPicture). */
1900 uint8_t skip_frame_flag;
1901 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1902 uint8_t num_skip_frames;
1903 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1904 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1905 uint32_t size_skip_frames;
1907 /** \brief Reserved bytes for future use, must be zero */
1908 uint32_t va_reserved[VA_PADDING_LOW];
1909 } VAEncMiscParameterSkipFrame;
1912 * \brief Encoding region-of-interest (ROI).
1914 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1915 * supports ROI input. The ROI set through this structure is applicable only to the
1916 * current frame or field, so must be sent every frame or field to be applied. The number of
1917 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1918 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1920 typedef struct _VAEncROI
1922 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1923 * codec coding units. It is relative to frame coordinates for the frame case and
1924 * to field coordinates for the field case. */
1925 VARectangle roi_rectangle;
1929 * \ref roi_value specifies ROI delta QP or ROI priority.
1930 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1931 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1932 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1933 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1934 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1935 * regions, the roi_value that is first in the ROI array will have priority.
1937 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1938 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1940 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1941 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1942 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1947 typedef struct _VAEncMiscParameterBufferROI {
1948 /** \brief Number of ROIs being sent.*/
1951 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1952 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1954 int8_t max_delta_qp;
1955 int8_t min_delta_qp;
1957 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1958 * coordinates for the frame case and to field coordinates for the field case.*/
1963 * \brief An indication for roi value.
1965 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1966 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1967 * in #VAEncROI should be used as ROI priority.
1969 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1970 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
1971 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1972 * when VAConfigAttribRateControl == VA_RC_CQP.
1974 uint32_t roi_value_is_qp_delta : 1;
1975 uint32_t reserved : 31;
1980 /** \brief Reserved bytes for future use, must be zero */
1981 uint32_t va_reserved[VA_PADDING_LOW];
1982 } VAEncMiscParameterBufferROI;
1984 * \brief Dirty rectangle data structure for encoding.
1986 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
1987 * implementation supports dirty rect input. The rect set through this structure is applicable
1988 * only to the current frame or field, so must be sent every frame or field to be applied.
1989 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
1990 * encoder will use the rect information to know those rectangle areas have changed while the
1991 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
1992 * previous picture. The encoder may do some internal optimizations.
1994 typedef struct _VAEncMiscParameterBufferDirtyRect
1996 /** \brief Number of Rectangle being sent.*/
1997 uint32_t num_roi_rectangle;
1999 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2000 VARectangle *roi_rectangle;
2001 } VAEncMiscParameterBufferDirtyRect;
2003 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2004 typedef struct _VAEncMiscParameterParallelRateControl {
2005 /** brief Number of layers*/
2006 uint32_t num_layers;
2007 /** brief Number of B frames per layer per GOP.
2009 * it should be allocated by application, and the is num_layers.
2010 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2011 uint32_t *num_b_in_gop;
2012 } VAEncMiscParameterParallelRateControl;
2015 * There will be cases where the bitstream buffer will not have enough room to hold
2016 * the data for the entire slice, and the following flags will be used in the slice
2017 * parameter to signal to the server for the possible cases.
2018 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2019 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2020 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2022 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2023 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2024 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2025 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2027 /* Codec-independent Slice Parameter Buffer base */
2028 typedef struct _VASliceParameterBufferBase
2030 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2031 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2032 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2033 } VASliceParameterBufferBase;
2035 /**********************************
2036 * JPEG common data structures
2037 **********************************/
2039 * \brief Huffman table for JPEG decoding.
2041 * This structure holds the complete Huffman tables. This is an
2042 * aggregation of all Huffman table (DHT) segments maintained by the
2043 * application. i.e. up to 2 Huffman tables are stored in there for
2046 * The #load_huffman_table array can be used as a hint to notify the
2047 * VA driver implementation about which table(s) actually changed
2048 * since the last submission of this buffer.
2050 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2051 /** \brief Specifies which #huffman_table is valid. */
2052 uint8_t load_huffman_table[2];
2053 /** \brief Huffman tables indexed by table identifier (Th). */
2055 /** @name DC table (up to 12 categories) */
2057 /** \brief Number of Huffman codes of length i + 1 (Li). */
2058 uint8_t num_dc_codes[16];
2059 /** \brief Value associated with each Huffman code (Vij). */
2060 uint8_t dc_values[12];
2062 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2064 /** \brief Number of Huffman codes of length i + 1 (Li). */
2065 uint8_t num_ac_codes[16];
2066 /** \brief Value associated with each Huffman code (Vij). */
2067 uint8_t ac_values[162];
2068 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2073 /** \brief Reserved bytes for future use, must be zero */
2074 uint32_t va_reserved[VA_PADDING_LOW];
2075 } VAHuffmanTableBufferJPEGBaseline;
2077 /****************************
2078 * MPEG-2 data structures
2079 ****************************/
2081 /* MPEG-2 Picture Parameter Buffer */
2083 * For each frame or field, and before any slice data, a single
2084 * picture parameter buffer must be send.
2086 typedef struct _VAPictureParameterBufferMPEG2
2088 uint16_t horizontal_size;
2089 uint16_t vertical_size;
2090 VASurfaceID forward_reference_picture;
2091 VASurfaceID backward_reference_picture;
2092 /* meanings of the following fields are the same as in the standard */
2093 int32_t picture_coding_type;
2094 int32_t f_code; /* pack all four fcode into this */
2097 uint32_t intra_dc_precision : 2;
2098 uint32_t picture_structure : 2;
2099 uint32_t top_field_first : 1;
2100 uint32_t frame_pred_frame_dct : 1;
2101 uint32_t concealment_motion_vectors : 1;
2102 uint32_t q_scale_type : 1;
2103 uint32_t intra_vlc_format : 1;
2104 uint32_t alternate_scan : 1;
2105 uint32_t repeat_first_field : 1;
2106 uint32_t progressive_frame : 1;
2107 uint32_t is_first_field : 1; /* indicate whether the current field
2108 * is the first field for field picture
2112 } picture_coding_extension;
2114 /** \brief Reserved bytes for future use, must be zero */
2115 uint32_t va_reserved[VA_PADDING_LOW];
2116 } VAPictureParameterBufferMPEG2;
2118 /** MPEG-2 Inverse Quantization Matrix Buffer */
2119 typedef struct _VAIQMatrixBufferMPEG2
2121 /** \brief Same as the MPEG-2 bitstream syntax element. */
2122 int32_t load_intra_quantiser_matrix;
2123 /** \brief Same as the MPEG-2 bitstream syntax element. */
2124 int32_t load_non_intra_quantiser_matrix;
2125 /** \brief Same as the MPEG-2 bitstream syntax element. */
2126 int32_t load_chroma_intra_quantiser_matrix;
2127 /** \brief Same as the MPEG-2 bitstream syntax element. */
2128 int32_t load_chroma_non_intra_quantiser_matrix;
2129 /** \brief Luminance intra matrix, in zig-zag scan order. */
2130 uint8_t intra_quantiser_matrix[64];
2131 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2132 uint8_t non_intra_quantiser_matrix[64];
2133 /** \brief Chroma intra matrix, in zig-zag scan order. */
2134 uint8_t chroma_intra_quantiser_matrix[64];
2135 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2136 uint8_t chroma_non_intra_quantiser_matrix[64];
2138 /** \brief Reserved bytes for future use, must be zero */
2139 uint32_t va_reserved[VA_PADDING_LOW];
2140 } VAIQMatrixBufferMPEG2;
2142 /** MPEG-2 Slice Parameter Buffer */
2143 typedef struct _VASliceParameterBufferMPEG2
2145 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2146 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2147 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2148 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2149 uint32_t slice_horizontal_position;
2150 uint32_t slice_vertical_position;
2151 int32_t quantiser_scale_code;
2152 int32_t intra_slice_flag;
2154 /** \brief Reserved bytes for future use, must be zero */
2155 uint32_t va_reserved[VA_PADDING_LOW];
2156 } VASliceParameterBufferMPEG2;
2158 /** MPEG-2 Macroblock Parameter Buffer */
2159 typedef struct _VAMacroblockParameterBufferMPEG2
2161 uint16_t macroblock_address;
2163 * macroblock_address (in raster scan order)
2165 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2167 uint8_t macroblock_type; /* see definition below */
2170 uint32_t frame_motion_type : 2;
2171 uint32_t field_motion_type : 2;
2172 uint32_t dct_type : 1;
2176 uint8_t motion_vertical_field_select;
2178 * motion_vertical_field_select:
2179 * see section 6.3.17.2 in the spec
2180 * only the lower 4 bits are used
2181 * bit 0: first vector forward
2182 * bit 1: first vector backward
2183 * bit 2: second vector forward
2184 * bit 3: second vector backward
2186 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2187 uint16_t coded_block_pattern;
2189 * The bitplanes for coded_block_pattern are described
2190 * in Figure 6.10-12 in the spec
2193 /* Number of skipped macroblocks after this macroblock */
2194 uint16_t num_skipped_macroblocks;
2196 /** \brief Reserved bytes for future use, must be zero */
2197 uint32_t va_reserved[VA_PADDING_LOW];
2198 } VAMacroblockParameterBufferMPEG2;
2201 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2203 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2204 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2205 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2206 #define VA_MB_TYPE_MOTION_INTRA 0x10
2209 * MPEG-2 Residual Data Buffer
2210 * For each macroblock, there wil be 64 shorts (16-bit) in the
2211 * residual data buffer
2214 /****************************
2215 * MPEG-4 Part 2 data structures
2216 ****************************/
2218 /* MPEG-4 Picture Parameter Buffer */
2220 * For each frame or field, and before any slice data, a single
2221 * picture parameter buffer must be send.
2223 typedef struct _VAPictureParameterBufferMPEG4
2226 uint16_t vop_height;
2227 VASurfaceID forward_reference_picture;
2228 VASurfaceID backward_reference_picture;
2231 uint32_t short_video_header : 1;
2232 uint32_t chroma_format : 2;
2233 uint32_t interlaced : 1;
2234 uint32_t obmc_disable : 1;
2235 uint32_t sprite_enable : 2;
2236 uint32_t sprite_warping_accuracy : 2;
2237 uint32_t quant_type : 1;
2238 uint32_t quarter_sample : 1;
2239 uint32_t data_partitioned : 1;
2240 uint32_t reversible_vlc : 1;
2241 uint32_t resync_marker_disable : 1;
2245 uint8_t no_of_sprite_warping_points;
2246 int16_t sprite_trajectory_du[3];
2247 int16_t sprite_trajectory_dv[3];
2248 uint8_t quant_precision;
2251 uint32_t vop_coding_type : 2;
2252 uint32_t backward_reference_vop_coding_type : 2;
2253 uint32_t vop_rounding_type : 1;
2254 uint32_t intra_dc_vlc_thr : 3;
2255 uint32_t top_field_first : 1;
2256 uint32_t alternate_vertical_scan_flag : 1;
2260 uint8_t vop_fcode_forward;
2261 uint8_t vop_fcode_backward;
2262 uint16_t vop_time_increment_resolution;
2263 /* short header related */
2264 uint8_t num_gobs_in_vop;
2265 uint8_t num_macroblocks_in_gob;
2266 /* for direct mode prediction */
2270 /** \brief Reserved bytes for future use, must be zero */
2271 uint32_t va_reserved[VA_PADDING_LOW];
2272 } VAPictureParameterBufferMPEG4;
2274 /** MPEG-4 Inverse Quantization Matrix Buffer */
2275 typedef struct _VAIQMatrixBufferMPEG4
2277 /** Same as the MPEG-4:2 bitstream syntax element. */
2278 int32_t load_intra_quant_mat;
2279 /** Same as the MPEG-4:2 bitstream syntax element. */
2280 int32_t load_non_intra_quant_mat;
2281 /** The matrix for intra blocks, in zig-zag scan order. */
2282 uint8_t intra_quant_mat[64];
2283 /** The matrix for non-intra blocks, in zig-zag scan order. */
2284 uint8_t non_intra_quant_mat[64];
2286 /** \brief Reserved bytes for future use, must be zero */
2287 uint32_t va_reserved[VA_PADDING_LOW];
2288 } VAIQMatrixBufferMPEG4;
2290 /** MPEG-4 Slice Parameter Buffer */
2291 typedef struct _VASliceParameterBufferMPEG4
2293 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2294 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2295 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2296 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2297 uint32_t macroblock_number;
2298 int32_t quant_scale;
2300 /** \brief Reserved bytes for future use, must be zero */
2301 uint32_t va_reserved[VA_PADDING_LOW];
2302 } VASliceParameterBufferMPEG4;
2305 VC-1 data structures
2308 typedef enum /* see 7.1.1.32 */
2311 VAMvMode1MvHalfPel = 1,
2312 VAMvMode1MvHalfPelBilinear = 2,
2313 VAMvModeMixedMv = 3,
2314 VAMvModeIntensityCompensation = 4
2317 /** VC-1 Picture Parameter Buffer */
2319 * For each picture, and before any slice data, a picture parameter
2320 * buffer must be send. Multiple picture parameter buffers may be
2321 * sent for a single picture. In that case picture parameters will
2322 * apply to all slice data that follow it until a new picture
2323 * parameter buffer is sent.
2326 * pic_quantizer_type should be set to the applicable quantizer
2327 * type as defined by QUANTIZER (J.1.19) and either
2328 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2330 typedef struct _VAPictureParameterBufferVC1
2332 VASurfaceID forward_reference_picture;
2333 VASurfaceID backward_reference_picture;
2334 /* if out-of-loop post-processing is done on the render
2335 target, then we need to keep the in-loop decoded
2336 picture as a reference picture */
2337 VASurfaceID inloop_decoded_picture;
2339 /* sequence layer for AP or meta data for SP and MP */
2342 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2343 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2344 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2345 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2346 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2347 uint32_t multires : 1; /* METADATA::MULTIRES */
2348 uint32_t overlap : 1; /* METADATA::OVERLAP */
2349 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2350 uint32_t rangered : 1; /* METADATA::RANGERED */
2351 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2352 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2357 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2358 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2361 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2362 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2363 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2364 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2367 } entrypoint_fields;
2368 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2369 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2372 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2373 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2374 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2375 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2378 } range_mapping_fields;
2380 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2381 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2382 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2383 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2384 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2385 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2386 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2387 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2388 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2392 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2393 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2394 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2395 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2396 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2402 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2403 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2404 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2405 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2406 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2407 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2408 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2414 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2415 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2416 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2417 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2418 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2419 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2420 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2423 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2426 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2427 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2428 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2429 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2435 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2436 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2437 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2438 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2439 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2440 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2441 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2442 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2443 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2444 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2450 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2451 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2452 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2453 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2454 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2455 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2456 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2457 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2458 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2459 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2460 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2463 } pic_quantizer_fields;
2466 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2467 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2468 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2469 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2470 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2471 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2476 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2477 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2478 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2480 /** \brief Reserved bytes for future use, must be zero */
2481 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2482 } VAPictureParameterBufferVC1;
2484 /** VC-1 Bitplane Buffer
2485 There will be at most three bitplanes coded in any picture header. To send
2486 the bitplane data more efficiently, each byte is divided in two nibbles, with
2487 each nibble carrying three bitplanes for one macroblock. The following table
2488 shows the bitplane data arrangement within each nibble based on the picture
2491 Picture Type Bit3 Bit2 Bit1 Bit0
2492 I or BI OVERFLAGS ACPRED FIELDTX
2493 P MYTYPEMB SKIPMB DIRECTMB
2494 B FORWARDMB SKIPMB DIRECTMB
2496 Within each byte, the lower nibble is for the first MB and the upper nibble is
2497 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2498 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2499 Macroblock #2 in the first row.
2502 /* VC-1 Slice Parameter Buffer */
2503 typedef struct _VASliceParameterBufferVC1
2505 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2506 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2507 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2508 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2509 uint32_t slice_vertical_position;
2511 /** \brief Reserved bytes for future use, must be zero */
2512 uint32_t va_reserved[VA_PADDING_LOW];
2513 } VASliceParameterBufferVC1;
2515 /* VC-1 Slice Data Buffer */
2517 This is simplely a buffer containing raw bit-stream bytes
2520 /****************************
2521 * H.264/AVC data structures
2522 ****************************/
2524 typedef struct _VAPictureH264
2526 VASurfaceID picture_id;
2529 int32_t TopFieldOrderCnt;
2530 int32_t BottomFieldOrderCnt;
2532 /** \brief Reserved bytes for future use, must be zero */
2533 uint32_t va_reserved[VA_PADDING_LOW];
2535 /* flags in VAPictureH264 could be OR of the following */
2536 #define VA_PICTURE_H264_INVALID 0x00000001
2537 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2538 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2539 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2540 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2542 /** H.264 Picture Parameter Buffer */
2544 * For each picture, and before any slice data, a single
2545 * picture parameter buffer must be send.
2547 typedef struct _VAPictureParameterBufferH264
2549 VAPictureH264 CurrPic;
2550 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2551 uint16_t picture_width_in_mbs_minus1;
2552 uint16_t picture_height_in_mbs_minus1;
2553 uint8_t bit_depth_luma_minus8;
2554 uint8_t bit_depth_chroma_minus8;
2555 uint8_t num_ref_frames;
2558 uint32_t chroma_format_idc : 2;
2559 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2560 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2561 uint32_t frame_mbs_only_flag : 1;
2562 uint32_t mb_adaptive_frame_field_flag : 1;
2563 uint32_t direct_8x8_inference_flag : 1;
2564 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2565 uint32_t log2_max_frame_num_minus4 : 4;
2566 uint32_t pic_order_cnt_type : 2;
2567 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2568 uint32_t delta_pic_order_always_zero_flag : 1;
2572 // FMO is not supported.
2573 va_deprecated uint8_t num_slice_groups_minus1;
2574 va_deprecated uint8_t slice_group_map_type;
2575 va_deprecated uint16_t slice_group_change_rate_minus1;
2576 int8_t pic_init_qp_minus26;
2577 int8_t pic_init_qs_minus26;
2578 int8_t chroma_qp_index_offset;
2579 int8_t second_chroma_qp_index_offset;
2582 uint32_t entropy_coding_mode_flag : 1;
2583 uint32_t weighted_pred_flag : 1;
2584 uint32_t weighted_bipred_idc : 2;
2585 uint32_t transform_8x8_mode_flag : 1;
2586 uint32_t field_pic_flag : 1;
2587 uint32_t constrained_intra_pred_flag : 1;
2588 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2589 uint32_t deblocking_filter_control_present_flag : 1;
2590 uint32_t redundant_pic_cnt_present_flag : 1;
2591 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2597 /** \brief Reserved bytes for future use, must be zero */
2598 uint32_t va_reserved[VA_PADDING_MEDIUM];
2599 } VAPictureParameterBufferH264;
2601 /** H.264 Inverse Quantization Matrix Buffer */
2602 typedef struct _VAIQMatrixBufferH264
2604 /** \brief 4x4 scaling list, in raster scan order. */
2605 uint8_t ScalingList4x4[6][16];
2606 /** \brief 8x8 scaling list, in raster scan order. */
2607 uint8_t ScalingList8x8[2][64];
2609 /** \brief Reserved bytes for future use, must be zero */
2610 uint32_t va_reserved[VA_PADDING_LOW];
2611 } VAIQMatrixBufferH264;
2613 /** H.264 Slice Parameter Buffer */
2614 typedef struct _VASliceParameterBufferH264
2616 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2617 /** \brief Byte offset to the NAL Header Unit for this slice. */
2618 uint32_t slice_data_offset;
2619 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2621 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2623 * This bit offset is relative to and includes the NAL unit byte
2624 * and represents the number of bits parsed in the slice_header()
2625 * after the removal of any emulation prevention bytes in
2626 * there. However, the slice data buffer passed to the hardware is
2627 * the original bitstream, thus including any emulation prevention
2630 uint16_t slice_data_bit_offset;
2631 uint16_t first_mb_in_slice;
2633 uint8_t direct_spatial_mv_pred_flag;
2635 * H264/AVC syntax element
2637 * if num_ref_idx_active_override_flag equals 0, host decoder should
2638 * set its value to num_ref_idx_l0_default_active_minus1.
2640 uint8_t num_ref_idx_l0_active_minus1;
2642 * H264/AVC syntax element
2644 * if num_ref_idx_active_override_flag equals 0, host decoder should
2645 * set its value to num_ref_idx_l1_default_active_minus1.
2647 uint8_t num_ref_idx_l1_active_minus1;
2648 uint8_t cabac_init_idc;
2649 int8_t slice_qp_delta;
2650 uint8_t disable_deblocking_filter_idc;
2651 int8_t slice_alpha_c0_offset_div2;
2652 int8_t slice_beta_offset_div2;
2653 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2654 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2655 uint8_t luma_log2_weight_denom;
2656 uint8_t chroma_log2_weight_denom;
2657 uint8_t luma_weight_l0_flag;
2658 int16_t luma_weight_l0[32];
2659 int16_t luma_offset_l0[32];
2660 uint8_t chroma_weight_l0_flag;
2661 int16_t chroma_weight_l0[32][2];
2662 int16_t chroma_offset_l0[32][2];
2663 uint8_t luma_weight_l1_flag;
2664 int16_t luma_weight_l1[32];
2665 int16_t luma_offset_l1[32];
2666 uint8_t chroma_weight_l1_flag;
2667 int16_t chroma_weight_l1[32][2];
2668 int16_t chroma_offset_l1[32][2];
2670 /** \brief Reserved bytes for future use, must be zero */
2671 uint32_t va_reserved[VA_PADDING_LOW];
2672 } VASliceParameterBufferH264;
2674 /****************************
2675 * Common encode data structures
2676 ****************************/
2679 VAEncPictureTypeIntra = 0,
2680 VAEncPictureTypePredictive = 1,
2681 VAEncPictureTypeBidirectional = 2,
2684 /* Encode Slice Parameter Buffer */
2685 typedef struct _VAEncSliceParameterBuffer
2687 uint32_t start_row_number; /* starting MB row number for this slice */
2688 uint32_t slice_height; /* slice height measured in MB */
2691 uint32_t is_intra : 1;
2692 uint32_t disable_deblocking_filter_idc : 2;
2693 uint32_t uses_long_term_ref :1;
2694 uint32_t is_long_term_ref :1;
2699 /** \brief Reserved bytes for future use, must be zero */
2700 uint32_t va_reserved[VA_PADDING_LOW];
2701 } VAEncSliceParameterBuffer;
2704 /****************************
2705 * H.263 specific encode data structures
2706 ****************************/
2708 typedef struct _VAEncSequenceParameterBufferH263
2710 uint32_t intra_period;
2711 uint32_t bits_per_second;
2712 uint32_t frame_rate;
2713 uint32_t initial_qp;
2716 /** \brief Reserved bytes for future use, must be zero */
2717 uint32_t va_reserved[VA_PADDING_LOW];
2718 } VAEncSequenceParameterBufferH263;
2720 typedef struct _VAEncPictureParameterBufferH263
2722 VASurfaceID reference_picture;
2723 VASurfaceID reconstructed_picture;
2724 VABufferID coded_buf;
2725 uint16_t picture_width;
2726 uint16_t picture_height;
2727 VAEncPictureType picture_type;
2729 /** \brief Reserved bytes for future use, must be zero */
2730 uint32_t va_reserved[VA_PADDING_LOW];
2731 } VAEncPictureParameterBufferH263;
2733 /****************************
2734 * MPEG-4 specific encode data structures
2735 ****************************/
2737 typedef struct _VAEncSequenceParameterBufferMPEG4
2739 uint8_t profile_and_level_indication;
2740 uint32_t intra_period;
2741 uint32_t video_object_layer_width;
2742 uint32_t video_object_layer_height;
2743 uint32_t vop_time_increment_resolution;
2744 uint32_t fixed_vop_rate;
2745 uint32_t fixed_vop_time_increment;
2746 uint32_t bits_per_second;
2747 uint32_t frame_rate;
2748 uint32_t initial_qp;
2751 /** \brief Reserved bytes for future use, must be zero */
2752 uint32_t va_reserved[VA_PADDING_LOW];
2753 } VAEncSequenceParameterBufferMPEG4;
2755 typedef struct _VAEncPictureParameterBufferMPEG4
2757 VASurfaceID reference_picture;
2758 VASurfaceID reconstructed_picture;
2759 VABufferID coded_buf;
2760 uint16_t picture_width;
2761 uint16_t picture_height;
2762 uint32_t modulo_time_base; /* number of 1s */
2763 uint32_t vop_time_increment;
2764 VAEncPictureType picture_type;
2766 /** \brief Reserved bytes for future use, must be zero */
2767 uint32_t va_reserved[VA_PADDING_LOW];
2768 } VAEncPictureParameterBufferMPEG4;
2772 /** Buffer functions */
2775 * Creates a buffer for "num_elements" elements of "size" bytes and
2776 * initalize with "data".
2777 * if "data" is null, then the contents of the buffer data store
2779 * Basically there are two ways to get buffer data to the server side. One is
2780 * to call vaCreateBuffer() with a non-null "data", which results the data being
2781 * copied to the data store on the server side. A different method that
2782 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2783 * and then use vaMapBuffer() to map the data store from the server side to the
2784 * client address space for access.
2785 * The user must call vaDestroyBuffer() to destroy a buffer.
2786 * Note: image buffers are created by the library, not the client. Please see
2787 * vaCreateImage on how image buffers are managed.
2789 VAStatus vaCreateBuffer (
2791 VAContextID context,
2792 VABufferType type, /* in */
2793 unsigned int size, /* in */
2794 unsigned int num_elements, /* in */
2795 void *data, /* in */
2796 VABufferID *buf_id /* out */
2800 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
2801 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
2802 * can call vaMapBuffer with this Buffer ID to get virtual address.
2803 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
2804 * maybe it should align with 256, and one byte present one Qp.so, call the function.
2805 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
2806 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
2807 * pBuf + 256 is the start of next line.
2808 * different driver implementation maybe return different unit_size and pitch
2810 VAStatus vaCreateBuffer2(
2812 VAContextID context,
2815 unsigned int height,
2816 unsigned int *unit_size,
2817 unsigned int *pitch,
2822 * Convey to the server how many valid elements are in the buffer.
2823 * e.g. if multiple slice parameters are being held in a single buffer,
2824 * this will communicate to the server the number of slice parameters
2825 * that are valid in the buffer.
2827 VAStatus vaBufferSetNumElements (
2829 VABufferID buf_id, /* in */
2830 unsigned int num_elements /* in */
2835 * device independent data structure for codedbuffer
2839 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2840 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2841 * enough for the encoder to attempt to limit its size.
2842 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2843 * exceeded the maximum slice size specified.
2844 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2845 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2846 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2848 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2849 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2850 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2851 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2852 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2854 * \brief The frame has exceeded the maximum requested size.
2856 * This flag indicates that the encoded frame size exceeds the value
2857 * specified through a misc parameter buffer of type
2858 * #VAEncMiscParameterTypeMaxFrameSize.
2860 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2861 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2864 * \brief The coded buffer segment contains a single NAL unit.
2866 * This flag indicates that the coded buffer segment contains a
2867 * single NAL unit. This flag might be useful to the user for
2868 * processing the coded buffer.
2870 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2873 * \brief Coded buffer segment.
2875 * #VACodedBufferSegment is an element of a linked list describing
2876 * some information on the coded buffer. The coded buffer segment
2877 * could contain either a single NAL unit, or more than one NAL unit.
2878 * It is recommended (but not required) to return a single NAL unit
2879 * in a coded buffer segment, and the implementation should set the
2880 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2882 typedef struct _VACodedBufferSegment {
2884 * \brief Size of the data buffer in this segment (in bytes).
2887 /** \brief Bit offset into the data buffer where the video data starts. */
2888 uint32_t bit_offset;
2889 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2891 /** \brief Reserved for future use. */
2893 /** \brief Pointer to the start of the data buffer. */
2896 * \brief Pointer to the next #VACodedBufferSegment element,
2897 * or \c NULL if there is none.
2901 /** \brief Reserved bytes for future use, must be zero */
2902 uint32_t va_reserved[VA_PADDING_LOW];
2903 } VACodedBufferSegment;
2906 * Map data store of the buffer into the client's address space
2907 * vaCreateBuffer() needs to be called with "data" set to NULL before
2908 * calling vaMapBuffer()
2910 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2911 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2913 VAStatus vaMapBuffer (
2915 VABufferID buf_id, /* in */
2916 void **pbuf /* out */
2920 * After client making changes to a mapped data store, it needs to
2921 * "Unmap" it to let the server know that the data is ready to be
2922 * consumed by the server
2924 VAStatus vaUnmapBuffer (
2926 VABufferID buf_id /* in */
2930 * After this call, the buffer is deleted and this buffer_id is no longer valid
2932 * A buffer can be re-used and sent to the server by another Begin/Render/End
2933 * sequence if vaDestroyBuffer() is not called with this buffer.
2935 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
2936 * hardware accelerator can result in performance dropping.
2938 VAStatus vaDestroyBuffer (
2940 VABufferID buffer_id
2943 /** \brief VA buffer information */
2945 /** \brief Buffer handle */
2947 /** \brief Buffer type (See \ref VABufferType). */
2950 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2952 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2953 * to specify the set of memory types the caller is interested in.
2954 * On successful return from vaAcquireBufferHandle(), the field is
2955 * updated with the best matching memory type.
2958 /** \brief Size of the underlying buffer. */
2961 /** \brief Reserved bytes for future use, must be zero */
2962 uint32_t va_reserved[VA_PADDING_LOW];
2966 * \brief Acquires buffer handle for external API usage
2968 * Locks the VA buffer object \ref buf_id for external API usage like
2969 * EGL or OpenCL (OCL). This function is a synchronization point. This
2970 * means that any pending operation is guaranteed to be completed
2971 * prior to returning from the function.
2973 * If the referenced VA buffer object is the backing store of a VA
2974 * surface, then this function acts as if vaSyncSurface() on the
2975 * parent surface was called first.
2977 * The \ref VABufferInfo argument shall be zero'ed on input. On
2978 * successful output, the data structure is filled in with all the
2979 * necessary buffer level implementation details like handle, type,
2980 * memory type and memory size.
2982 * Note: the external API implementation, or the application, can
2983 * express the memory types it is interested in by filling in the \ref
2984 * mem_type field accordingly. On successful output, the memory type
2985 * that fits best the request and that was used is updated in the \ref
2986 * VABufferInfo data structure. If none of the supplied memory types
2987 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2988 * error is returned.
2990 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2991 * is called. Besides, no additional operation is allowed on any of
2992 * the buffer parent object until vaReleaseBufferHandle() is called.
2993 * e.g. decoding into a VA surface backed with the supplied VA buffer
2994 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2998 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2999 * does not support this interface
3000 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3001 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3002 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3003 * does not support exporting buffers of the specified type
3004 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3005 * memory types in \ref VABufferInfo.mem_type was supported
3007 * @param[in] dpy the VA display
3008 * @param[in] buf_id the VA buffer
3009 * @param[in,out] buf_info the associated VA buffer information
3010 * @return VA_STATUS_SUCCESS if successful
3013 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3016 * \brief Releases buffer after usage from external API
3018 * Unlocks the VA buffer object \ref buf_id from external API usage like
3019 * EGL or OpenCL (OCL). This function is a synchronization point. This
3020 * means that any pending operation is guaranteed to be completed
3021 * prior to returning from the function.
3023 * The \ref VABufferInfo argument shall point to the original data
3024 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3025 * This is necessary so that the VA driver implementation could
3026 * deallocate any resources that were needed.
3028 * In any case, returning from this function invalidates any contents
3029 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3030 * valid. Therefore, VA driver implementations are free to reset this
3031 * data structure to safe defaults.
3034 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3035 * does not support this interface
3036 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3037 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3038 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3039 * does not support exporting buffers of the specified type
3041 * @param[in] dpy the VA display
3042 * @param[in] buf_id the VA buffer
3043 * @return VA_STATUS_SUCCESS if successful
3046 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3049 * Render (Video Decode/Encode/Processing) Pictures
3051 * A picture represents either a frame or a field.
3053 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3058 * Get ready for a video pipeline
3059 * - decode a picture to a target surface
3060 * - encode a picture from a target surface
3061 * - process a picture to a target surface
3063 VAStatus vaBeginPicture (
3065 VAContextID context,
3066 VASurfaceID render_target
3070 * Send video decode, encode or processing buffers to the server.
3072 VAStatus vaRenderPicture (
3074 VAContextID context,
3075 VABufferID *buffers,
3080 * Make the end of rendering for a picture.
3081 * The server should start processing all pending operations for this
3082 * surface. This call is non-blocking. The client can start another
3083 * Begin/Render/End sequence on a different render target.
3084 * if VAContextID used in this function previously successfully passed
3085 * vaMFAddContext call, real processing will be started during vaMFSubmit
3087 VAStatus vaEndPicture (
3093 * Make the end of rendering for a pictures in contexts passed with submission.
3094 * The server should start processing all pending operations for contexts.
3095 * All contexts passed should be associated through vaMFAddContext
3096 * and call sequence Begin/Render/End performed.
3097 * This call is non-blocking. The client can start another
3098 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3100 * VA_STATUS_SUCCESS - operation successful, context was removed.
3101 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3102 * due to mf_context not created or one of contexts not assotiated with mf_context
3103 * through vaAddContext.
3104 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3105 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3107 * mf_context: Multi-Frame context
3108 * contexts: list of contexts submitting their tasks for multi-frame operation.
3109 * num_contexts: number of passed contexts.
3111 VAStatus vaMFSubmit (
3113 VAMFContextID mf_context,
3114 VAContextID * contexts,
3125 * This function blocks until all pending operations on the render target
3126 * have been completed. Upon return it is safe to use the render target for a
3127 * different picture.
3129 VAStatus vaSyncSurface (
3131 VASurfaceID render_target
3136 VASurfaceRendering = 1, /* Rendering in progress */
3137 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3138 /* this status is useful if surface is used as the source */
3140 VASurfaceReady = 4, /* not being rendered or displayed */
3141 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3145 * Find out any pending ops on the render target
3147 VAStatus vaQuerySurfaceStatus (
3149 VASurfaceID render_target,
3150 VASurfaceStatus *status /* out */
3155 VADecodeSliceMissing = 0,
3156 VADecodeMBError = 1,
3157 } VADecodeErrorType;
3160 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3161 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3163 typedef struct _VASurfaceDecodeMBErrors
3165 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3166 uint32_t start_mb; /* start mb address with errors */
3167 uint32_t end_mb; /* end mb address with errors */
3168 VADecodeErrorType decode_error_type;
3170 /** \brief Reserved bytes for future use, must be zero */
3171 uint32_t va_reserved[VA_PADDING_LOW];
3172 } VASurfaceDecodeMBErrors;
3175 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3176 * it can call vaQuerySurfaceError to find out further details on the particular error.
3177 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3178 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3179 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3180 * The array is terminated if "status==-1" is detected.
3182 VAStatus vaQuerySurfaceError(
3184 VASurfaceID surface,
3185 VAStatus error_status,
3190 * Images and Subpictures
3191 * VAImage is used to either get the surface data to client memory, or
3192 * to copy image data in client memory to a surface.
3193 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3194 * is at the upper left corner with positive X to the right and positive Y down
3196 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3197 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3198 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3201 * Pre-defined fourcc codes
3203 #define VA_FOURCC_NV12 0x3231564E
3204 #define VA_FOURCC_AI44 0x34344149
3205 #define VA_FOURCC_RGBA 0x41424752
3206 #define VA_FOURCC_RGBX 0x58424752
3207 #define VA_FOURCC_BGRA 0x41524742
3208 #define VA_FOURCC_BGRX 0x58524742
3209 #define VA_FOURCC_ARGB 0x42475241
3210 #define VA_FOURCC_XRGB 0x42475258
3211 #define VA_FOURCC_ABGR 0x52474241
3212 #define VA_FOURCC_XBGR 0x52474258
3213 #define VA_FOURCC_UYVY 0x59565955
3214 #define VA_FOURCC_YUY2 0x32595559
3215 #define VA_FOURCC_AYUV 0x56555941
3216 #define VA_FOURCC_NV11 0x3131564e
3217 #define VA_FOURCC_YV12 0x32315659
3218 #define VA_FOURCC_P208 0x38303250
3219 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3220 #define VA_FOURCC_IYUV 0x56555949
3221 #define VA_FOURCC_I420 0x30323449
3222 #define VA_FOURCC_YV24 0x34325659
3223 #define VA_FOURCC_YV32 0x32335659
3224 #define VA_FOURCC_Y800 0x30303859
3225 #define VA_FOURCC_IMC3 0x33434D49
3226 #define VA_FOURCC_411P 0x50313134
3227 #define VA_FOURCC_422H 0x48323234
3228 #define VA_FOURCC_422V 0x56323234
3229 #define VA_FOURCC_444P 0x50343434
3230 #define VA_FOURCC_RGBP 0x50424752
3231 #define VA_FOURCC_BGRP 0x50524742
3232 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
3235 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3237 #define VA_FOURCC_YV16 0x36315659
3239 * 10-bit and 16-bit Planar YUV 4:2:0.
3241 #define VA_FOURCC_P010 0x30313050
3242 #define VA_FOURCC_P016 0x36313050
3245 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3247 #define VA_FOURCC_I010 0x30313049
3250 #define VA_LSB_FIRST 1
3251 #define VA_MSB_FIRST 2
3253 typedef struct _VAImageFormat
3256 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3257 uint32_t bits_per_pixel;
3258 /* for RGB formats */
3259 uint32_t depth; /* significant bits per pixel */
3261 uint32_t green_mask;
3263 uint32_t alpha_mask;
3265 /** \brief Reserved bytes for future use, must be zero */
3266 uint32_t va_reserved[VA_PADDING_LOW];
3269 typedef VAGenericID VAImageID;
3271 typedef struct _VAImage
3273 VAImageID image_id; /* uniquely identify this image */
3274 VAImageFormat format;
3275 VABufferID buf; /* image data buffer */
3277 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3278 * data store on the server side for optimal performance. The buffer will be
3279 * created by the CreateImage function, and proper storage allocated based on the image
3280 * size and format. This buffer is managed by the library implementation, and
3281 * accessed by the client through the buffer Map/Unmap functions.
3286 uint32_t num_planes; /* can not be greater than 3 */
3288 * An array indicating the scanline pitch in bytes for each plane.
3289 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3291 uint32_t pitches[3];
3293 * An array indicating the byte offset from the beginning of the image data
3294 * to the start of each plane.
3296 uint32_t offsets[3];
3298 /* The following fields are only needed for paletted formats */
3299 int32_t num_palette_entries; /* set to zero for non-palette images */
3301 * Each component is one byte and entry_bytes indicates the number of components in
3302 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3304 int32_t entry_bytes;
3306 * An array of ascii characters describing the order of the components within the bytes.
3307 * Only entry_bytes characters of the string are used.
3309 int8_t component_order[4];
3311 /** \brief Reserved bytes for future use, must be zero */
3312 uint32_t va_reserved[VA_PADDING_LOW];
3315 /** Get maximum number of image formats supported by the implementation */
3316 int vaMaxNumImageFormats (
3321 * Query supported image formats
3322 * The caller must provide a "format_list" array that can hold at
3323 * least vaMaxNumImageFormats() entries. The actual number of formats
3324 * returned in "format_list" is returned in "num_formats".
3326 VAStatus vaQueryImageFormats (
3328 VAImageFormat *format_list, /* out */
3329 int *num_formats /* out */
3333 * Create a VAImage structure
3334 * The width and height fields returned in the VAImage structure may get
3335 * enlarged for some YUV formats. Upon return from this function,
3336 * image->buf has been created and proper storage allocated by the library.
3337 * The client can access the image through the Map/Unmap calls.
3339 VAStatus vaCreateImage (
3341 VAImageFormat *format,
3344 VAImage *image /* out */
3348 * Should call DestroyImage before destroying the surface it is bound to
3350 VAStatus vaDestroyImage (
3355 VAStatus vaSetImagePalette (
3359 * pointer to an array holding the palette data. The size of the array is
3360 * num_palette_entries * entry_bytes in size. The order of the components
3361 * in the palette is described by the component_order in VAImage struct
3363 unsigned char *palette
3367 * Retrive surface data into a VAImage
3368 * Image must be in a format supported by the implementation
3370 VAStatus vaGetImage (
3372 VASurfaceID surface,
3373 int x, /* coordinates of the upper left source pixel */
3375 unsigned int width, /* width and height of the region */
3376 unsigned int height,
3381 * Copy data from a VAImage to a surface
3382 * Image must be in a format supported by the implementation
3383 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3384 * shouldn't be rendered into when this is called
3386 VAStatus vaPutImage (
3388 VASurfaceID surface,
3392 unsigned int src_width,
3393 unsigned int src_height,
3396 unsigned int dest_width,
3397 unsigned int dest_height
3401 * Derive an VAImage from an existing surface.
3402 * This interface will derive a VAImage and corresponding image buffer from
3403 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3404 * direct CPU access. This operation is only possible on implementations with
3405 * direct rendering capabilities and internal surface formats that can be
3406 * represented with a VAImage. When the operation is not possible this interface
3407 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3408 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3411 * Implementations should only return success when the resulting image buffer
3412 * would be useable with vaMap/Unmap.
3414 * When directly accessing a surface special care must be taken to insure
3415 * proper synchronization with the graphics hardware. Clients should call
3416 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3417 * rendering or currently being displayed by an overlay.
3419 * Additionally nothing about the contents of a surface should be assumed
3420 * following a vaPutSurface. Implementations are free to modify the surface for
3421 * scaling or subpicture blending within a call to vaPutImage.
3423 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3424 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3425 * vaGetImage with other surfaces is supported.
3427 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3428 * image and image buffer structures will be destroyed; however, the underlying
3429 * surface will remain unchanged until freed with vaDestroySurfaces.
3431 VAStatus vaDeriveImage (
3433 VASurfaceID surface,
3434 VAImage *image /* out */
3439 * Subpicture is a special type of image that can be blended
3440 * with a surface during vaPutSurface(). Subpicture can be used to render
3441 * DVD sub-titles or closed captioning text etc.
3444 typedef VAGenericID VASubpictureID;
3446 /** Get maximum number of subpicture formats supported by the implementation */
3447 int vaMaxNumSubpictureFormats (
3451 /** flags for subpictures */
3452 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3453 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3454 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3456 * Query supported subpicture formats
3457 * The caller must provide a "format_list" array that can hold at
3458 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3459 * for each format to indicate additional capabilities for that format. The actual
3460 * number of formats returned in "format_list" is returned in "num_formats".
3461 * flags: returned value to indicate addtional capabilities
3462 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3463 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3464 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3467 VAStatus vaQuerySubpictureFormats (
3469 VAImageFormat *format_list, /* out */
3470 unsigned int *flags, /* out */
3471 unsigned int *num_formats /* out */
3475 * Subpictures are created with an image associated.
3477 VAStatus vaCreateSubpicture (
3480 VASubpictureID *subpicture /* out */
3484 * Destroy the subpicture before destroying the image it is assocated to
3486 VAStatus vaDestroySubpicture (
3488 VASubpictureID subpicture
3492 * Bind an image to the subpicture. This image will now be associated with
3493 * the subpicture instead of the one at creation.
3495 VAStatus vaSetSubpictureImage (
3497 VASubpictureID subpicture,
3502 * If chromakey is enabled, then the area where the source value falls within
3503 * the chromakey [min, max] range is transparent
3504 * The chromakey component format is the following:
3505 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3506 * For YUV: [0:7] V [8:15] U [16:23] Y
3507 * The chromakey mask can be used to mask out certain components for chromakey
3510 VAStatus vaSetSubpictureChromakey (
3512 VASubpictureID subpicture,
3513 unsigned int chromakey_min,
3514 unsigned int chromakey_max,
3515 unsigned int chromakey_mask
3519 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3520 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3521 * the overall alpha is per-pixel alpha multiplied by the global alpha
3523 VAStatus vaSetSubpictureGlobalAlpha (
3525 VASubpictureID subpicture,
3530 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3531 * It defines the region mapping between the subpicture and the target
3532 * surfaces through source and destination rectangles (with the same width and height).
3533 * Both will be displayed at the next call to vaPutSurface. Additional
3534 * associations before the call to vaPutSurface simply overrides the association.
3536 VAStatus vaAssociateSubpicture (
3538 VASubpictureID subpicture,
3539 VASurfaceID *target_surfaces,
3541 int16_t src_x, /* upper left offset in subpicture */
3544 uint16_t src_height,
3545 int16_t dest_x, /* upper left offset in surface */
3547 uint16_t dest_width,
3548 uint16_t dest_height,
3550 * whether to enable chroma-keying, global-alpha, or screen relative mode
3551 * see VA_SUBPICTURE_XXX values
3557 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3559 VAStatus vaDeassociateSubpicture (
3561 VASubpictureID subpicture,
3562 VASurfaceID *target_surfaces,
3567 * Display attributes
3568 * Display attributes are used to control things such as contrast, hue, saturation,
3569 * brightness etc. in the rendering process. The application can query what
3570 * attributes are supported by the driver, and then set the appropriate attributes
3571 * before calling vaPutSurface()
3573 /* PowerVR IEP Lite attributes */
3576 VADISPLAYATTRIB_BLE_OFF = 0x00,
3577 VADISPLAYATTRIB_BLE_LOW,
3578 VADISPLAYATTRIB_BLE_MEDIUM,
3579 VADISPLAYATTRIB_BLE_HIGH,
3580 VADISPLAYATTRIB_BLE_NONE,
3581 } VADisplayAttribBLEMode;
3583 /** attribute value for VADisplayAttribRotation */
3584 #define VA_ROTATION_NONE 0x00000000
3585 #define VA_ROTATION_90 0x00000001
3586 #define VA_ROTATION_180 0x00000002
3587 #define VA_ROTATION_270 0x00000003
3591 * @name Mirroring directions
3593 * Those values could be used for VADisplayAttribMirror attribute or
3594 * VAProcPipelineParameterBuffer::mirror_state.
3598 /** \brief No Mirroring. */
3599 #define VA_MIRROR_NONE 0x00000000
3600 /** \brief Horizontal Mirroring. */
3601 #define VA_MIRROR_HORIZONTAL 0x00000001
3602 /** \brief Vertical Mirroring. */
3603 #define VA_MIRROR_VERTICAL 0x00000002
3606 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3607 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3608 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3611 #define VA_RENDER_MODE_UNDEFINED 0
3612 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3613 #define VA_RENDER_MODE_LOCAL_GPU 2
3614 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3615 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3617 /** Render device */
3618 #define VA_RENDER_DEVICE_UNDEFINED 0
3619 #define VA_RENDER_DEVICE_LOCAL 1
3620 #define VA_RENDER_DEVICE_EXTERNAL 2
3622 /** Currently defined display attribute types */
3625 VADisplayAttribBrightness = 0,
3626 VADisplayAttribContrast = 1,
3627 VADisplayAttribHue = 2,
3628 VADisplayAttribSaturation = 3,
3629 /* client can specifiy a background color for the target window
3630 * the new feature of video conference,
3631 * the uncovered area of the surface is filled by this color
3632 * also it will blend with the decoded video color
3634 VADisplayAttribBackgroundColor = 4,
3636 * this is a gettable only attribute. For some implementations that use the
3637 * hardware overlay, after PutSurface is called, the surface can not be
3638 * re-used until after the subsequent PutSurface call. If this is the case
3639 * then the value for this attribute will be set to 1 so that the client
3640 * will not attempt to re-use the surface right after returning from a call
3643 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3644 * driver may use overlay or GPU alternatively
3646 VADisplayAttribDirectSurface = 5,
3647 VADisplayAttribRotation = 6,
3648 VADisplayAttribOutofLoopDeblock = 7,
3650 /* PowerVR IEP Lite specific attributes */
3651 VADisplayAttribBLEBlackMode = 8,
3652 VADisplayAttribBLEWhiteMode = 9,
3653 VADisplayAttribBlueStretch = 10,
3654 VADisplayAttribSkinColorCorrection = 11,
3656 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3657 * conversion matrix. Each element in the matrix is float-point
3659 VADisplayAttribCSCMatrix = 12,
3660 /* specify the constant color used to blend with video surface
3661 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3662 * d: the final color to overwrite into the frame buffer
3663 * v: decoded video after color conversion,
3664 * c: video color specified by VADisplayAttribBlendColor
3665 * b: background color of the drawable
3667 VADisplayAttribBlendColor = 13,
3669 * Indicate driver to skip painting color key or not.
3670 * only applicable if the render is overlay
3672 VADisplayAttribOverlayAutoPaintColorKey = 14,
3674 * customized overlay color key, the format is RGB888
3675 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3677 VADisplayAttribOverlayColorKey = 15,
3679 * The hint for the implementation of vaPutSurface
3680 * normally, the driver could use an overlay or GPU to render the surface on the screen
3681 * this flag provides APP the flexibity to switch the render dynamically
3683 VADisplayAttribRenderMode = 16,
3685 * specify if vaPutSurface needs to render into specified monitors
3686 * one example is that one external monitor (e.g. HDMI) is enabled,
3687 * but the window manager is not aware of it, and there is no associated drawable
3689 VADisplayAttribRenderDevice = 17,
3691 * specify vaPutSurface render area if there is no drawable on the monitor
3693 VADisplayAttribRenderRect = 18,
3694 } VADisplayAttribType;
3696 /* flags for VADisplayAttribute */
3697 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3698 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3699 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3701 typedef struct _VADisplayAttribute
3703 VADisplayAttribType type;
3706 int32_t value; /* used by the set/get attribute functions */
3707 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3710 /** \brief Reserved bytes for future use, must be zero */
3711 uint32_t va_reserved[VA_PADDING_LOW];
3712 } VADisplayAttribute;
3714 /** Get maximum number of display attributs supported by the implementation */
3715 int vaMaxNumDisplayAttributes (
3720 * Query display attributes
3721 * The caller must provide a "attr_list" array that can hold at
3722 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3723 * returned in "attr_list" is returned in "num_attributes".
3725 VAStatus vaQueryDisplayAttributes (
3727 VADisplayAttribute *attr_list, /* out */
3728 int *num_attributes /* out */
3732 * Get display attributes
3733 * This function returns the current attribute values in "attr_list".
3734 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3735 * from vaQueryDisplayAttributes() can have their values retrieved.
3737 VAStatus vaGetDisplayAttributes (
3739 VADisplayAttribute *attr_list, /* in/out */
3744 * Set display attributes
3745 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3746 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3747 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3749 VAStatus vaSetDisplayAttributes (
3751 VADisplayAttribute *attr_list,
3755 /****************************
3756 * HEVC data structures
3757 ****************************/
3759 * \brief Description of picture properties of those in DPB surfaces.
3761 * If only progressive scan is supported, each surface contains one whole
3763 * Otherwise, each surface contains two fields of whole picture.
3764 * In this case, two entries of ReferenceFrames[] may share same picture_id
3767 typedef struct _VAPictureHEVC
3769 /** \brief reconstructed picture buffer surface index
3770 * invalid when taking value VA_INVALID_SURFACE.
3772 VASurfaceID picture_id;
3773 /** \brief picture order count.
3774 * in HEVC, POCs for top and bottom fields of same picture should
3775 * take different values.
3777 int32_t pic_order_cnt;
3778 /* described below */
3781 /** \brief Reserved bytes for future use, must be zero */
3782 uint32_t va_reserved[VA_PADDING_LOW];
3785 /* flags in VAPictureHEVC could be OR of the following */
3786 #define VA_PICTURE_HEVC_INVALID 0x00000001
3787 /** \brief indication of interlace scan picture.
3788 * should take same value for all the pictures in sequence.
3790 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3791 /** \brief polarity of the field picture.
3792 * top field takes even lines of buffer surface.
3793 * bottom field takes odd lines of buffer surface.
3795 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3796 /** \brief Long term reference picture */
3797 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3799 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3800 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3801 * be exclusive. No more than one of them can be set for any picture.
3802 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3803 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3804 * Application should provide valid values for both short format and long format.
3805 * The pictures in DPB with any of these three flags turned on are referred by
3806 * the current picture.
3808 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3809 * Number of ReferenceFrames[] entries with this bit set equals
3810 * NumPocStCurrBefore.
3812 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3813 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3814 * Number of ReferenceFrames[] entries with this bit set equals
3815 * NumPocStCurrAfter.
3817 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3818 /** \brief RefPicSetLtCurr of HEVC spec variable
3819 * Number of ReferenceFrames[] entries with this bit set equals
3822 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3824 #include <va/va_dec_hevc.h>
3825 #include <va/va_dec_jpeg.h>
3826 #include <va/va_dec_vp8.h>
3827 #include <va/va_dec_vp9.h>
3828 #include <va/va_enc_hevc.h>
3829 #include <va/va_enc_h264.h>
3830 #include <va/va_enc_jpeg.h>
3831 #include <va/va_enc_mpeg2.h>
3832 #include <va/va_enc_vp8.h>
3833 #include <va/va_enc_vp9.h>
3834 #include <va/va_fei.h>
3835 #include <va/va_fei_h264.h>
3836 #include <va/va_vpp.h>