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
673 * RGB 10-bit packed format with upper 2 bits as alpha channel.
674 * The existing pre-defined fourcc codes can be used to signal
675 * the position of each component for this RT format.
677 #define VA_RT_FORMAT_RGB32_10BPP 0x00200000
678 #define VA_RT_FORMAT_PROTECTED 0x80000000
680 /** @name Attribute values for VAConfigAttribRateControl */
682 /** \brief Driver does not support any form of rate control. */
683 #define VA_RC_NONE 0x00000001
684 /** \brief Constant bitrate. */
685 #define VA_RC_CBR 0x00000002
686 /** \brief Variable bitrate. */
687 #define VA_RC_VBR 0x00000004
688 /** \brief Video conference mode. */
689 #define VA_RC_VCM 0x00000008
690 /** \brief Constant QP. */
691 #define VA_RC_CQP 0x00000010
692 /** \brief Variable bitrate with peak rate higher than average bitrate. */
693 #define VA_RC_VBR_CONSTRAINED 0x00000020
694 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
695 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
696 #define VA_RC_ICQ 0x00000040
697 /** \brief Macroblock based rate control. Per MB control is decided
698 * internally in the encoder. It may be combined with other RC modes, except CQP. */
699 #define VA_RC_MB 0x00000080
700 /** \brief Constant Frame Size, it is used for small tolerent */
701 #define VA_RC_CFS 0x00000100
702 /** \brief Parallel BRC, for hierachical B.
704 * For hierachical B, B frames can be refered by other B frames.
705 * Currently three layers of hierachy are defined:
706 * B0 - regular B, no reference to other B frames.
707 * B1 - reference to only I, P and regular B0 frames.
708 * B2 - reference to any other frames, including B1.
709 * In Hierachical B structure, B frames on the same layer can be processed
710 * simultaneously. And BRC would adjust accordingly. This is so called
712 #define VA_RC_PARALLEL 0x00000200
716 /** @name Attribute values for VAConfigAttribDecSliceMode */
718 /** \brief Driver supports normal mode for slice decoding */
719 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
720 /** \brief Driver supports base mode for slice decoding */
721 #define VA_DEC_SLICE_MODE_BASE 0x00000002
723 /** @name Attribute values for VAConfigAttribDecJPEG */
725 typedef union _VAConfigAttribValDecJPEG {
727 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
728 uint32_t rotation : 4;
729 /** \brief Reserved for future use. */
730 uint32_t reserved : 28;
733 uint32_t va_reserved[VA_PADDING_LOW];
734 } VAConfigAttribValDecJPEG;
737 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
739 /** \brief Driver does not support any packed headers mode. */
740 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
742 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
744 * Application must provide it to driver once this flag is returned through
745 * vaGetConfigAttributes()
747 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
749 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
751 * Application must provide it to driver once this falg is returned through
752 * vaGetConfigAttributes()
754 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
756 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
758 * Application must provide it to driver once this flag is returned through
759 * vaGetConfigAttributes()
761 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
763 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
766 * This is a deprecated packed header flag, All applications can use
767 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
768 * header data buffer to the driver
770 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
771 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
772 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
775 /** @name Attribute values for VAConfigAttribEncInterlaced */
777 /** \brief Driver does not support interlaced coding. */
778 #define VA_ENC_INTERLACED_NONE 0x00000000
779 /** \brief Driver supports interlaced frame coding. */
780 #define VA_ENC_INTERLACED_FRAME 0x00000001
781 /** \brief Driver supports interlaced field coding. */
782 #define VA_ENC_INTERLACED_FIELD 0x00000002
783 /** \brief Driver supports macroblock adaptive frame field coding. */
784 #define VA_ENC_INTERLACED_MBAFF 0x00000004
785 /** \brief Driver supports picture adaptive frame field coding. */
786 #define VA_ENC_INTERLACED_PAFF 0x00000008
789 /** @name Attribute values for VAConfigAttribEncSliceStructure */
791 /** \brief Driver supports a power-of-two number of rows per slice. */
792 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
793 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
794 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
795 /** \brief Dirver support 1 rows per slice */
796 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
797 /** \brief Dirver support max encoded slice size per slice */
798 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
799 /** \brief Driver supports an arbitrary number of rows per slice. */
800 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
803 /** \brief Attribute value for VAConfigAttribEncJPEG */
804 typedef union _VAConfigAttribValEncJPEG {
806 /** \brief set to 1 for arithmatic coding. */
807 uint32_t arithmatic_coding_mode : 1;
808 /** \brief set to 1 for progressive dct. */
809 uint32_t progressive_dct_mode : 1;
810 /** \brief set to 1 for non-interleaved. */
811 uint32_t non_interleaved_mode : 1;
812 /** \brief set to 1 for differential. */
813 uint32_t differential_mode : 1;
814 uint32_t max_num_components : 3;
815 uint32_t max_num_scans : 4;
816 uint32_t max_num_huffman_tables : 3;
817 uint32_t max_num_quantization_tables : 3;
820 } VAConfigAttribValEncJPEG;
822 /** @name Attribute values for VAConfigAttribEncQuantization */
824 /** \brief Driver does not support special types of quantization */
825 #define VA_ENC_QUANTIZATION_NONE 0x00000000
826 /** \brief Driver supports trellis quantization */
827 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
830 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
832 /** \brief Driver does not support intra refresh */
833 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
834 /** \brief Driver supports column based rolling intra refresh */
835 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
836 /** \brief Driver supports row based rolling intra refresh */
837 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
838 /** \brief Driver supports adaptive intra refresh */
839 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
840 /** \brief Driver supports cyclic intra refresh */
841 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
842 /** \brief Driver supports intra refresh of P frame*/
843 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
844 /** \brief Driver supports intra refresh of B frame */
845 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
846 /** \brief Driver supports intra refresh of multiple reference encoder */
847 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
851 /** \brief Attribute value for VAConfigAttribEncROI */
852 typedef union _VAConfigAttribValEncROI {
854 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
855 uint32_t num_roi_regions : 8;
857 * \brief A flag indicates whether ROI priority is supported
859 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
860 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
861 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
862 * the underlying driver doesn't support ROI priority.
864 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
865 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
867 uint32_t roi_rc_priority_support : 1;
869 * \brief A flag indicates whether ROI delta QP is supported
871 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
872 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
873 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
874 * the underlying driver doesn't support ROI delta QP.
876 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
877 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
879 uint32_t roi_rc_qp_delta_support : 1;
880 uint32_t reserved : 22;
883 } VAConfigAttribValEncROI;
885 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
886 typedef union _VAConfigAttribValEncRateControlExt {
889 * \brief The maximum number of temporal layers minus 1
891 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
892 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
893 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
895 uint32_t max_num_temporal_layers_minus1 : 8;
898 * /brief support temporal layer bit-rate control flag
900 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
901 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
902 * #VAConfigAttribRateControl == #VA_RC_VBR).
904 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
905 * \c max_num_temporal_layers_minus1 is equal to 0
907 * To use bit-rate control per temporal layer, an application must send the right layer
908 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
909 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
910 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
911 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
912 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
913 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
914 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
916 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
917 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
918 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
920 uint32_t temporal_layer_bitrate_control_flag : 1;
921 uint32_t reserved : 23;
924 } VAConfigAttribValEncRateControlExt;
926 /** @name Attribute values for VAConfigAttribProcessingRate. */
928 /** \brief Driver does not support processing rate report */
929 #define VA_PROCESSING_RATE_NONE 0x00000000
930 /** \brief Driver supports encode processing rate report */
931 #define VA_PROCESSING_RATE_ENCODE 0x00000001
932 /** \brief Driver supports decode processing rate report */
933 #define VA_PROCESSING_RATE_DECODE 0x00000002
936 * if an attribute is not applicable for a given
937 * profile/entrypoint pair, then set the value to the following
939 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
941 /** Get maximum number of profiles supported by the implementation */
942 int vaMaxNumProfiles (
946 /** Get maximum number of entrypoints supported by the implementation */
947 int vaMaxNumEntrypoints (
951 /** Get maximum number of attributs supported by the implementation */
952 int vaMaxNumConfigAttributes (
957 * Query supported profiles
958 * The caller must provide a "profile_list" array that can hold at
959 * least vaMaxNumProfile() entries. The actual number of profiles
960 * returned in "profile_list" is returned in "num_profile".
962 VAStatus vaQueryConfigProfiles (
964 VAProfile *profile_list, /* out */
965 int *num_profiles /* out */
969 * Query supported entrypoints for a given profile
970 * The caller must provide an "entrypoint_list" array that can hold at
971 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
972 * returned in "entrypoint_list" is returned in "num_entrypoints".
974 VAStatus vaQueryConfigEntrypoints (
977 VAEntrypoint *entrypoint_list, /* out */
978 int *num_entrypoints /* out */
982 * Get attributes for a given profile/entrypoint pair
983 * The caller must provide an "attrib_list" with all attributes to be
984 * retrieved. Upon return, the attributes in "attrib_list" have been
985 * updated with their value. Unknown attributes or attributes that are
986 * not supported for the given profile/entrypoint pair will have their
987 * value set to VA_ATTRIB_NOT_SUPPORTED
989 VAStatus vaGetConfigAttributes (
992 VAEntrypoint entrypoint,
993 VAConfigAttrib *attrib_list, /* in/out */
997 /** Generic ID type, can be re-typed for specific implementation */
998 typedef unsigned int VAGenericID;
1000 typedef VAGenericID VAConfigID;
1003 * Create a configuration for the video decode/encode/processing pipeline
1004 * it passes in the attribute list that specifies the attributes it cares
1005 * about, with the rest taking default values.
1007 VAStatus vaCreateConfig (
1010 VAEntrypoint entrypoint,
1011 VAConfigAttrib *attrib_list,
1013 VAConfigID *config_id /* out */
1017 * Free resources associdated with a given config
1019 VAStatus vaDestroyConfig (
1021 VAConfigID config_id
1025 * Query all attributes for a given configuration
1026 * The profile of the configuration is returned in "profile"
1027 * The entrypoint of the configuration is returned in "entrypoint"
1028 * The caller must provide an "attrib_list" array that can hold at least
1029 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1030 * returned in "attrib_list" is returned in "num_attribs"
1032 VAStatus vaQueryConfigAttributes (
1034 VAConfigID config_id,
1035 VAProfile *profile, /* out */
1036 VAEntrypoint *entrypoint, /* out */
1037 VAConfigAttrib *attrib_list,/* out */
1038 int *num_attribs /* out */
1043 * Contexts and Surfaces
1045 * Context represents a "virtual" video decode, encode or video processing
1046 * pipeline. Surfaces are render targets for a given context. The data in the
1047 * surfaces are not accessible to the client except if derived image is supported
1048 * and the internal data format of the surface is implementation specific.
1050 * Surfaces are provided as a hint of what surfaces will be used when the context
1051 * is created through vaCreateContext(). A surface may be used by different contexts
1052 * at the same time as soon as application can make sure the operations are synchronized
1053 * between different contexts, e.g. a surface is used as the output of a decode context
1054 * and the input of a video process context. Surfaces can only be destroyed after all
1055 * contexts using these surfaces have been destroyed.
1057 * Both contexts and surfaces are identified by unique IDs and its
1058 * implementation specific internals are kept opaque to the clients
1061 typedef VAGenericID VAContextID;
1063 typedef VAGenericID VASurfaceID;
1065 #define VA_INVALID_ID 0xffffffff
1066 #define VA_INVALID_SURFACE VA_INVALID_ID
1068 /** \brief Generic value types. */
1070 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1071 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1072 VAGenericValueTypePointer, /**< Generic pointer type */
1073 VAGenericValueTypeFunc /**< Pointer to function */
1074 } VAGenericValueType;
1076 /** \brief Generic function type. */
1077 typedef void (*VAGenericFunc)(void);
1079 /** \brief Generic value. */
1080 typedef struct _VAGenericValue {
1081 /** \brief Value type. See #VAGenericValueType. */
1082 VAGenericValueType type;
1083 /** \brief Value holder. */
1085 /** \brief 32-bit signed integer. */
1087 /** \brief 32-bit float. */
1089 /** \brief Generic pointer. */
1091 /** \brief Pointer to function. */
1096 /** @name Surface attribute flags */
1098 /** \brief Surface attribute is not supported. */
1099 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1100 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1101 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1102 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1103 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1106 /** \brief Surface attribute types. */
1108 VASurfaceAttribNone = 0,
1110 * \brief Pixel format (fourcc).
1112 * The value is meaningful as input to vaQuerySurfaceAttributes().
1113 * If zero, the driver returns the optimal pixel format for the
1114 * specified config. Otherwise, if non-zero, the value represents
1115 * a pixel format (FOURCC) that is kept as is on output, if the
1116 * driver supports it. Otherwise, the driver sets the value to
1117 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1119 VASurfaceAttribPixelFormat,
1120 /** \brief Minimal width in pixels (int, read-only). */
1121 VASurfaceAttribMinWidth,
1122 /** \brief Maximal width in pixels (int, read-only). */
1123 VASurfaceAttribMaxWidth,
1124 /** \brief Minimal height in pixels (int, read-only). */
1125 VASurfaceAttribMinHeight,
1126 /** \brief Maximal height in pixels (int, read-only). */
1127 VASurfaceAttribMaxHeight,
1128 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1129 VASurfaceAttribMemoryType,
1130 /** \brief External buffer descriptor (pointer, write). */
1131 VASurfaceAttribExternalBufferDescriptor,
1132 /** \brief Surface usage hint, gives the driver a hint of intended usage
1133 * to optimize allocation (e.g. tiling) (int, read/write). */
1134 VASurfaceAttribUsageHint,
1135 /** \brief Number of surface attributes. */
1136 VASurfaceAttribCount
1137 } VASurfaceAttribType;
1139 /** \brief Surface attribute. */
1140 typedef struct _VASurfaceAttrib {
1142 VASurfaceAttribType type;
1143 /** \brief Flags. See "Surface attribute flags". */
1145 /** \brief Value. See "Surface attribute types" for the expected types. */
1146 VAGenericValue value;
1150 * @name VASurfaceAttribMemoryType values in bit fields.
1151 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1152 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1153 * types are defined in DRM and Android header files.
1156 /** \brief VA memory type (default) is supported. */
1157 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1158 /** \brief V4L2 buffer memory type is supported. */
1159 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1160 /** \brief User pointer memory type is supported. */
1161 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1165 * \brief VASurfaceAttribExternalBuffers structure for
1166 * the VASurfaceAttribExternalBufferDescriptor attribute.
1168 typedef struct _VASurfaceAttribExternalBuffers {
1169 /** \brief pixel format in fourcc. */
1170 uint32_t pixel_format;
1171 /** \brief width in pixels. */
1173 /** \brief height in pixels. */
1175 /** \brief total size of the buffer in bytes. */
1177 /** \brief number of planes for planar layout */
1178 uint32_t num_planes;
1179 /** \brief pitch for each plane in bytes */
1180 uint32_t pitches[4];
1181 /** \brief offset for each plane in bytes */
1182 uint32_t offsets[4];
1183 /** \brief buffer handles or user pointers */
1185 /** \brief number of elements in the "buffers" array */
1186 uint32_t num_buffers;
1187 /** \brief flags. See "Surface external buffer descriptor flags". */
1189 /** \brief reserved for passing private data */
1191 } VASurfaceAttribExternalBuffers;
1193 /** @name VASurfaceAttribExternalBuffers flags */
1195 /** \brief Enable memory tiling */
1196 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1197 /** \brief Memory is cacheable */
1198 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1199 /** \brief Memory is non-cacheable */
1200 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1201 /** \brief Memory is write-combined */
1202 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1203 /** \brief Memory is protected */
1204 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1206 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1208 /** \brief Surface usage not indicated. */
1209 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1210 /** \brief Surface used by video decoder. */
1211 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1212 /** \brief Surface used by video encoder. */
1213 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1214 /** \brief Surface read by video post-processing. */
1215 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1216 /** \brief Surface written by video post-processing. */
1217 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1218 /** \brief Surface used for display. */
1219 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1224 * \brief Queries surface attributes for the supplied config.
1226 * This function queries for all supported attributes for the
1227 * supplied VA @config. In particular, if the underlying hardware
1228 * supports the creation of VA surfaces in various formats, then
1229 * this function will enumerate all pixel formats that are supported.
1231 * The \c attrib_list array is allocated by the user and \c
1232 * num_attribs shall be initialized to the number of allocated
1233 * elements in that array. Upon successful return, the actual number
1234 * of attributes will be overwritten into \c num_attribs. Otherwise,
1235 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1236 * is adjusted to the number of elements that would be returned if
1237 * enough space was available.
1239 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1240 * argument when vaQuerySurfaceAttributes() is used to determine the
1241 * actual number of elements that need to be allocated.
1243 * @param[in] dpy the VA display
1244 * @param[in] config the config identifying a codec or a video
1245 * processing pipeline
1246 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1247 * @param[in,out] num_attribs the number of elements allocated on
1248 * input, the number of elements actually filled in output
1251 vaQuerySurfaceAttributes(
1254 VASurfaceAttrib *attrib_list,
1255 unsigned int *num_attribs
1259 * \brief Creates an array of surfaces
1261 * Creates an array of surfaces. The optional list of attributes shall
1262 * be constructed based on what the underlying hardware could expose
1263 * through vaQuerySurfaceAttributes().
1265 * @param[in] dpy the VA display
1266 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1267 * @param[in] width the surface width
1268 * @param[in] height the surface height
1269 * @param[out] surfaces the array of newly created surfaces
1270 * @param[in] num_surfaces the number of surfaces to create
1271 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1272 * @param[in] num_attribs the number of attributes supplied in
1273 * \c attrib_list, or zero
1278 unsigned int format,
1280 unsigned int height,
1281 VASurfaceID *surfaces,
1282 unsigned int num_surfaces,
1283 VASurfaceAttrib *attrib_list,
1284 unsigned int num_attribs
1288 * vaDestroySurfaces - Destroy resources associated with surfaces.
1289 * Surfaces can only be destroyed after all contexts using these surfaces have been
1292 * surfaces: array of surfaces to destroy
1293 * num_surfaces: number of surfaces in the array to be destroyed.
1295 VAStatus vaDestroySurfaces (
1297 VASurfaceID *surfaces,
1301 #define VA_PROGRESSIVE 0x1
1303 * vaCreateContext - Create a context
1305 * config_id: configuration for the context
1306 * picture_width: coded picture width
1307 * picture_height: coded picture height
1308 * flag: any combination of the following:
1309 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1310 * render_targets: a hint for render targets (surfaces) tied to the context
1311 * num_render_targets: number of render targets in the above array
1312 * context: created context id upon return
1314 VAStatus vaCreateContext (
1316 VAConfigID config_id,
1320 VASurfaceID *render_targets,
1321 int num_render_targets,
1322 VAContextID *context /* out */
1326 * vaDestroyContext - Destroy a context
1328 * context: context to be destroyed
1330 VAStatus vaDestroyContext (
1335 //Multi-frame context
1336 typedef VAGenericID VAMFContextID;
1338 * vaCreateMFContext - Create a multi-frame context
1339 * interface encapsulating common for all streams memory objects and structures
1340 * required for single GPU task submission from several VAContextID's.
1341 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1342 * Support identification: Application can identify multi-frame feature support by ability
1343 * to create multi-frame context. If driver supports multi-frame - call successful,
1344 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1345 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1347 * VA_STATUS_SUCCESS - operation successful.
1348 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1349 * dpy: display adapter.
1350 * mf_context: Multi-Frame context encapsulating all associated context
1351 * for multi-frame submission.
1353 VAStatus vaCreateMFContext (
1355 VAMFContextID *mf_context /* out */
1359 * vaMFAddContext - Provide ability to associate each context used for
1360 * Multi-Frame submission and common Multi-Frame context.
1361 * Try to add context to understand if it is supported.
1362 * Allocation: this call allocates and/or reallocates all memory objects
1363 * common for all contexts associated with particular Multi-Frame context.
1364 * All memory required for each context(pixel buffers, internal driver
1365 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1366 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1367 * first context added will set entry point/profile for whole Multi-Frame context,
1368 * all other entry points and profiles can be rejected to be added.
1370 * VA_STATUS_SUCCESS - operation successful, context was added.
1371 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1372 * current mf_context and associated contexts and start working with new ones.
1373 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1374 * 1 - mf_context is not valid context or
1375 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1376 * and current context contradicts with previously added, application can continue with current mf_context
1377 * and other contexts passed this call, rejected context can continue work in stand-alone
1378 * mode or other mf_context.
1379 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1380 * unsupported VAEntrypoint. Application can continue with current mf_context
1381 * and other contexts passed this call, rejected context can continue work in stand-alone
1383 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1384 * but VAProfile is not supported. Application can continue with current mf_context
1385 * and other contexts passed this call, rejected context can continue work in stand-alone
1387 * dpy: display adapter.
1388 * context: context being associated with Multi-Frame context.
1389 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1391 VAStatus vaMFAddContext (
1393 VAMFContextID mf_context,
1398 * vaMFReleaseContext - Removes context from multi-frame and
1399 * association with multi-frame context.
1400 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1402 * VA_STATUS_SUCCESS - operation successful, context was removed.
1403 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1404 * application need to destroy this VAMFContextID and all assotiated VAContextID
1406 * mf_context: VAMFContextID where context is added
1407 * context: VAContextID to be added
1409 VAStatus vaMFReleaseContext (
1411 VAMFContextID mf_context,
1417 * Buffers are used to pass various types of data from the
1418 * client to the server. The server maintains a data store
1419 * for each buffer created, and the client idenfies a buffer
1420 * through a unique buffer id assigned by the server.
1423 typedef VAGenericID VABufferID;
1427 VAPictureParameterBufferType = 0,
1428 VAIQMatrixBufferType = 1,
1429 VABitPlaneBufferType = 2,
1430 VASliceGroupMapBufferType = 3,
1431 VASliceParameterBufferType = 4,
1432 VASliceDataBufferType = 5,
1433 VAMacroblockParameterBufferType = 6,
1434 VAResidualDataBufferType = 7,
1435 VADeblockingParameterBufferType = 8,
1436 VAImageBufferType = 9,
1437 VAProtectedSliceDataBufferType = 10,
1438 VAQMatrixBufferType = 11,
1439 VAHuffmanTableBufferType = 12,
1440 VAProbabilityBufferType = 13,
1442 /* Following are encode buffer types */
1443 VAEncCodedBufferType = 21,
1444 VAEncSequenceParameterBufferType = 22,
1445 VAEncPictureParameterBufferType = 23,
1446 VAEncSliceParameterBufferType = 24,
1447 VAEncPackedHeaderParameterBufferType = 25,
1448 VAEncPackedHeaderDataBufferType = 26,
1449 VAEncMiscParameterBufferType = 27,
1450 VAEncMacroblockParameterBufferType = 28,
1451 VAEncMacroblockMapBufferType = 29,
1454 * \brief Encoding QP buffer
1456 * This buffer contains QP per MB for encoding. Currently
1457 * VAEncQPBufferH264 is defined for H.264 encoding, see
1458 * #VAEncQPBufferH264 for details
1460 VAEncQPBufferType = 30,
1461 /* Following are video processing buffer types */
1463 * \brief Video processing pipeline parameter buffer.
1465 * This buffer describes the video processing pipeline. See
1466 * #VAProcPipelineParameterBuffer for details.
1468 VAProcPipelineParameterBufferType = 41,
1470 * \brief Video filter parameter buffer.
1472 * This buffer describes the video filter parameters. All buffers
1473 * inherit from #VAProcFilterParameterBufferBase, thus including
1474 * a unique filter buffer type.
1476 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1477 * Filters requiring advanced parameters include, but are not limited to,
1478 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1479 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1481 VAProcFilterParameterBufferType = 42,
1483 * \brief FEI specific buffer types
1485 VAEncFEIMVBufferType = 43,
1486 VAEncFEIMBCodeBufferType = 44,
1487 VAEncFEIDistortionBufferType = 45,
1488 VAEncFEIMBControlBufferType = 46,
1489 VAEncFEIMVPredictorBufferType = 47,
1494 * Processing rate parameter for encode.
1496 typedef struct _VAProcessingRateParameterEnc {
1497 /** \brief Profile level */
1499 uint8_t reserved[3];
1500 /** \brief quality level. When set to 0, default quality
1503 uint32_t quality_level;
1504 /** \brief Period between I frames. */
1505 uint32_t intra_period;
1506 /** \brief Period between I/P frames. */
1508 } VAProcessingRateParameterEnc;
1511 * Processing rate parameter for decode.
1513 typedef struct _VAProcessingRateParameterDec {
1514 /** \brief Profile level */
1516 uint8_t reserved0[3];
1518 } VAProcessingRateParameterDec;
1520 typedef struct _VAProcessingRateParameter {
1522 VAProcessingRateParameterEnc proc_buf_enc;
1523 VAProcessingRateParameterDec proc_buf_dec;
1525 } VAProcessingRateParameter;
1528 * \brief Queries processing rate for the supplied config.
1530 * This function queries the processing rate based on parameters in
1531 * \c proc_buf for the given \c config. Upon successful return, the processing
1532 * rate value will be stored in \c processing_rate. Processing rate is
1533 * specified as the number of macroblocks per second.
1535 * If NULL is passed to the \c proc_buf, the default processing rate for the
1536 * given configuration will be returned.
1538 * @param[in] dpy the VA display
1539 * @param[in] config the config identifying a codec or a video
1540 * processing pipeline
1541 * @param[in] proc_buf the buffer that contains the parameters for
1542 either the encode or decode processing rate
1543 * @param[out] processing_rate processing rate in number of macroblocks per
1544 second constrained by parameters specified in proc_buf
1548 vaQueryProcessingRate(
1551 VAProcessingRateParameter *proc_buf,
1552 unsigned int *processing_rate
1557 VAEncMiscParameterTypeFrameRate = 0,
1558 VAEncMiscParameterTypeRateControl = 1,
1559 VAEncMiscParameterTypeMaxSliceSize = 2,
1560 VAEncMiscParameterTypeAIR = 3,
1561 /** \brief Buffer type used to express a maximum frame size (in bits). */
1562 VAEncMiscParameterTypeMaxFrameSize = 4,
1563 /** \brief Buffer type used for HRD parameters. */
1564 VAEncMiscParameterTypeHRD = 5,
1565 VAEncMiscParameterTypeQualityLevel = 6,
1566 /** \brief Buffer type used for Rolling intra refresh */
1567 VAEncMiscParameterTypeRIR = 7,
1568 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1569 VAEncMiscParameterTypeQuantization = 8,
1570 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1571 * rate control, when the user has externally skipped frames. */
1572 VAEncMiscParameterTypeSkipFrame = 9,
1573 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1574 VAEncMiscParameterTypeROI = 10,
1575 /** \brief Buffer type used for temporal layer structure */
1576 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1577 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1578 VAEncMiscParameterTypeDirtyRect = 13,
1579 /** \brief Buffer type used for parallel BRC parameters. */
1580 VAEncMiscParameterTypeParallelBRC = 14,
1581 /** \brief Buffer type used for FEI input frame level parameters */
1582 VAEncMiscParameterTypeFEIFrameControl = 18,
1583 } VAEncMiscParameterType;
1585 /** \brief Packed header type. */
1587 /** \brief Packed sequence header. */
1588 VAEncPackedHeaderSequence = 1,
1589 /** \brief Packed picture header. */
1590 VAEncPackedHeaderPicture = 2,
1591 /** \brief Packed slice header. */
1592 VAEncPackedHeaderSlice = 3,
1594 * \brief Packed raw header.
1596 * Packed raw data header can be used by the client to insert a header
1597 * into the bitstream data buffer at the point it is passed, the driver
1598 * will handle the raw packed header based on "has_emulation_bytes" field
1599 * in the packed header parameter structure.
1601 VAEncPackedHeaderRawData = 4,
1603 * \brief Misc packed header. See codec-specific definitions.
1606 * This is a deprecated packed header type. All applications can use
1607 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1609 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1610 } VAEncPackedHeaderType;
1612 /** \brief Packed header parameter. */
1613 typedef struct _VAEncPackedHeaderParameterBuffer {
1614 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1616 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1617 uint32_t bit_length;
1618 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1619 uint8_t has_emulation_bytes;
1621 /** \brief Reserved bytes for future use, must be zero */
1622 uint32_t va_reserved[VA_PADDING_LOW];
1623 } VAEncPackedHeaderParameterBuffer;
1626 * For application, e.g. set a new bitrate
1627 * VABufferID buf_id;
1628 * VAEncMiscParameterBuffer *misc_param;
1629 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1631 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1632 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1633 * 1, NULL, &buf_id);
1635 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1636 * misc_param->type = VAEncMiscParameterTypeRateControl;
1637 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1638 * misc_rate_ctrl->bits_per_second = 6400000;
1639 * vaUnmapBuffer(dpy, buf_id);
1640 * vaRenderPicture(dpy, context, &buf_id, 1);
1642 typedef struct _VAEncMiscParameterBuffer
1644 VAEncMiscParameterType type;
1646 } VAEncMiscParameterBuffer;
1648 /** \brief Temporal layer Structure*/
1649 typedef struct _VAEncMiscParameterTemporalLayerStructure
1651 /** \brief The number of temporal layers */
1652 uint32_t number_of_layers;
1653 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1654 uint32_t periodicity;
1656 * \brief The array indicating the layer id for each frame
1658 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1659 * ids for frames starting from the 2nd frame.
1661 uint32_t layer_id[32];
1663 /** \brief Reserved bytes for future use, must be zero */
1664 uint32_t va_reserved[VA_PADDING_LOW];
1665 } VAEncMiscParameterTemporalLayerStructure;
1668 /** \brief Rate control parameters */
1669 typedef struct _VAEncMiscParameterRateControl
1671 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1672 uint32_t bits_per_second;
1673 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1674 * bit-rate for example if target_percentage is 95 then the rate control will target
1675 * a bit-rate that is 95% of the maximum bit-rate
1677 uint32_t target_percentage;
1678 /* windows size in milliseconds. For example if this is set to 500,
1679 * then the rate control will guarantee the target bit-rate over a 500 ms window
1681 uint32_t window_size;
1682 /* initial QP at I frames */
1683 uint32_t initial_qp;
1685 uint32_t basic_unit_size;
1691 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1692 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1693 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1695 * The temporal layer that the rate control parameters are specified for.
1697 uint32_t temporal_id : 8;
1698 uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1699 uint32_t enable_parallel_brc : 1;
1700 uint32_t enable_dynamic_scaling : 1;
1701 uint32_t reserved : 14;
1705 uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1706 /** \brief Reserved bytes for future use, must be zero */
1708 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1709 } VAEncMiscParameterRateControl;
1711 typedef struct _VAEncMiscParameterFrameRate
1714 * The framerate is specified as a number of frames per second, as a
1715 * fraction. The denominator of the fraction is given in the top half
1716 * (the high two bytes) of the framerate field, and the numerator is
1717 * given in the bottom half (the low two bytes).
1720 * denominator = framerate >> 16 & 0xffff;
1721 * numerator = framerate & 0xffff;
1722 * fps = numerator / denominator;
1724 * For example, if framerate is set to (100 << 16 | 750), this is
1725 * 750 / 100, hence 7.5fps.
1727 * If the denominator is zero (the high two bytes are both zero) then
1728 * it takes the value one instead, so the framerate is just the integer
1729 * in the low 2 bytes.
1737 * The temporal id the framerate parameters are specified for.
1739 uint32_t temporal_id : 8;
1740 uint32_t reserved : 24;
1745 /** \brief Reserved bytes for future use, must be zero */
1746 uint32_t va_reserved[VA_PADDING_LOW];
1747 } VAEncMiscParameterFrameRate;
1750 * Allow a maximum slice size to be specified (in bits).
1751 * The encoder will attempt to make sure that individual slices do not exceed this size
1752 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1754 typedef struct _VAEncMiscParameterMaxSliceSize
1756 uint32_t max_slice_size;
1758 /** \brief Reserved bytes for future use, must be zero */
1759 uint32_t va_reserved[VA_PADDING_LOW];
1760 } VAEncMiscParameterMaxSliceSize;
1762 typedef struct _VAEncMiscParameterAIR
1764 uint32_t air_num_mbs;
1765 uint32_t air_threshold;
1766 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1768 /** \brief Reserved bytes for future use, must be zero */
1769 uint32_t va_reserved[VA_PADDING_LOW];
1770 } VAEncMiscParameterAIR;
1773 * \brief Rolling intra refresh data structure for encoding.
1775 typedef struct _VAEncMiscParameterRIR
1781 * \brief Indicate if intra refresh is enabled in column/row.
1783 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1784 * by the driver before sending this structure.
1787 /* \brief enable RIR in column */
1788 uint32_t enable_rir_column : 1;
1789 /* \brief enable RIR in row */
1790 uint32_t enable_rir_row : 1;
1791 uint32_t reserved : 30;
1796 * \brief Indicates the column or row location in MB. It is ignored if
1799 uint16_t intra_insertion_location;
1801 * \brief Indicates the number of columns or rows in MB. It is ignored if
1804 uint16_t intra_insert_size;
1806 * \brief indicates the Qp difference for inserted intra columns or rows.
1807 * App can use this to adjust intra Qp based on bitrate & max frame size.
1809 uint8_t qp_delta_for_inserted_intra;
1810 /** \brief Reserved bytes for future use, must be zero */
1811 uint32_t va_reserved[VA_PADDING_LOW];
1812 } VAEncMiscParameterRIR;
1814 typedef struct _VAEncMiscParameterHRD
1816 uint32_t initial_buffer_fullness; /* in bits */
1817 uint32_t buffer_size; /* in bits */
1819 /** \brief Reserved bytes for future use, must be zero */
1820 uint32_t va_reserved[VA_PADDING_LOW];
1821 } VAEncMiscParameterHRD;
1824 * \brief Defines a maximum frame size (in bits).
1826 * This misc parameter buffer defines the maximum size of a frame (in
1827 * bits). The encoder will try to make sure that each frame does not
1828 * exceed this size. Otherwise, if the frame size exceeds this size,
1829 * the \c status flag of #VACodedBufferSegment will contain
1830 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1832 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1833 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1834 VAEncMiscParameterType type;
1835 /** \brief Maximum size of a frame (in bits). */
1836 uint32_t max_frame_size;
1838 /** \brief Reserved bytes for future use, must be zero */
1839 uint32_t va_reserved[VA_PADDING_LOW];
1840 } VAEncMiscParameterBufferMaxFrameSize;
1843 * \brief Encoding quality level.
1845 * The encoding quality could be set through this structure, if the implementation
1846 * supports multiple quality levels. The quality level set through this structure is
1847 * persistent over the entire coded sequence, or until a new structure is being sent.
1848 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1849 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1850 * quality. The quality level setting is used as a trade-off between quality and speed/power
1851 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1853 typedef struct _VAEncMiscParameterBufferQualityLevel {
1854 /** \brief Encoding quality level setting. When set to 0, default quality
1857 uint32_t quality_level;
1859 /** \brief Reserved bytes for future use, must be zero */
1860 uint32_t va_reserved[VA_PADDING_LOW];
1861 } VAEncMiscParameterBufferQualityLevel;
1864 * \brief Quantization settings for encoding.
1866 * Some encoders support special types of quantization such as trellis, and this structure
1867 * can be used by the app to control these special types of quantization by the encoder.
1869 typedef struct _VAEncMiscParameterQuantization
1873 /* if no flags is set then quantization is determined by the driver */
1876 /* \brief disable trellis for all frames/fields */
1877 uint64_t disable_trellis : 1;
1878 /* \brief enable trellis for I frames/fields */
1879 uint64_t enable_trellis_I : 1;
1880 /* \brief enable trellis for P frames/fields */
1881 uint64_t enable_trellis_P : 1;
1882 /* \brief enable trellis for B frames/fields */
1883 uint64_t enable_trellis_B : 1;
1884 uint64_t reserved : 28;
1887 } quantization_flags;
1888 } VAEncMiscParameterQuantization;
1891 * \brief Encoding skip frame.
1893 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1894 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1895 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1896 * current frame. It is allowed for the application to still send in packed headers for the driver to
1897 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1899 typedef struct _VAEncMiscParameterSkipFrame {
1900 /** \brief Indicates skip frames as below.
1901 * 0: Encode as normal, no skip.
1902 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1903 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1904 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1905 * in VAEncPackedHeaderPicture). */
1906 uint8_t skip_frame_flag;
1907 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1908 uint8_t num_skip_frames;
1909 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1910 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1911 uint32_t size_skip_frames;
1913 /** \brief Reserved bytes for future use, must be zero */
1914 uint32_t va_reserved[VA_PADDING_LOW];
1915 } VAEncMiscParameterSkipFrame;
1918 * \brief Encoding region-of-interest (ROI).
1920 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1921 * supports ROI input. The ROI set through this structure is applicable only to the
1922 * current frame or field, so must be sent every frame or field to be applied. The number of
1923 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1924 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1926 typedef struct _VAEncROI
1928 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1929 * codec coding units. It is relative to frame coordinates for the frame case and
1930 * to field coordinates for the field case. */
1931 VARectangle roi_rectangle;
1935 * \ref roi_value specifies ROI delta QP or ROI priority.
1936 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1937 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1938 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1939 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1940 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1941 * regions, the roi_value that is first in the ROI array will have priority.
1943 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1944 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1946 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1947 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1948 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1953 typedef struct _VAEncMiscParameterBufferROI {
1954 /** \brief Number of ROIs being sent.*/
1957 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1958 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1960 int8_t max_delta_qp;
1961 int8_t min_delta_qp;
1963 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1964 * coordinates for the frame case and to field coordinates for the field case.*/
1969 * \brief An indication for roi value.
1971 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1972 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1973 * in #VAEncROI should be used as ROI priority.
1975 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1976 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
1977 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1978 * when VAConfigAttribRateControl == VA_RC_CQP.
1980 uint32_t roi_value_is_qp_delta : 1;
1981 uint32_t reserved : 31;
1986 /** \brief Reserved bytes for future use, must be zero */
1987 uint32_t va_reserved[VA_PADDING_LOW];
1988 } VAEncMiscParameterBufferROI;
1990 * \brief Dirty rectangle data structure for encoding.
1992 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
1993 * implementation supports dirty rect input. The rect set through this structure is applicable
1994 * only to the current frame or field, so must be sent every frame or field to be applied.
1995 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
1996 * encoder will use the rect information to know those rectangle areas have changed while the
1997 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
1998 * previous picture. The encoder may do some internal optimizations.
2000 typedef struct _VAEncMiscParameterBufferDirtyRect
2002 /** \brief Number of Rectangle being sent.*/
2003 uint32_t num_roi_rectangle;
2005 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2006 VARectangle *roi_rectangle;
2007 } VAEncMiscParameterBufferDirtyRect;
2009 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2010 typedef struct _VAEncMiscParameterParallelRateControl {
2011 /** brief Number of layers*/
2012 uint32_t num_layers;
2013 /** brief Number of B frames per layer per GOP.
2015 * it should be allocated by application, and the is num_layers.
2016 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2017 uint32_t *num_b_in_gop;
2018 } VAEncMiscParameterParallelRateControl;
2021 * There will be cases where the bitstream buffer will not have enough room to hold
2022 * the data for the entire slice, and the following flags will be used in the slice
2023 * parameter to signal to the server for the possible cases.
2024 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2025 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2026 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2028 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2029 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2030 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2031 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2033 /* Codec-independent Slice Parameter Buffer base */
2034 typedef struct _VASliceParameterBufferBase
2036 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2037 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2038 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2039 } VASliceParameterBufferBase;
2041 /**********************************
2042 * JPEG common data structures
2043 **********************************/
2045 * \brief Huffman table for JPEG decoding.
2047 * This structure holds the complete Huffman tables. This is an
2048 * aggregation of all Huffman table (DHT) segments maintained by the
2049 * application. i.e. up to 2 Huffman tables are stored in there for
2052 * The #load_huffman_table array can be used as a hint to notify the
2053 * VA driver implementation about which table(s) actually changed
2054 * since the last submission of this buffer.
2056 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2057 /** \brief Specifies which #huffman_table is valid. */
2058 uint8_t load_huffman_table[2];
2059 /** \brief Huffman tables indexed by table identifier (Th). */
2061 /** @name DC table (up to 12 categories) */
2063 /** \brief Number of Huffman codes of length i + 1 (Li). */
2064 uint8_t num_dc_codes[16];
2065 /** \brief Value associated with each Huffman code (Vij). */
2066 uint8_t dc_values[12];
2068 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2070 /** \brief Number of Huffman codes of length i + 1 (Li). */
2071 uint8_t num_ac_codes[16];
2072 /** \brief Value associated with each Huffman code (Vij). */
2073 uint8_t ac_values[162];
2074 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2079 /** \brief Reserved bytes for future use, must be zero */
2080 uint32_t va_reserved[VA_PADDING_LOW];
2081 } VAHuffmanTableBufferJPEGBaseline;
2083 /****************************
2084 * MPEG-2 data structures
2085 ****************************/
2087 /* MPEG-2 Picture Parameter Buffer */
2089 * For each frame or field, and before any slice data, a single
2090 * picture parameter buffer must be send.
2092 typedef struct _VAPictureParameterBufferMPEG2
2094 uint16_t horizontal_size;
2095 uint16_t vertical_size;
2096 VASurfaceID forward_reference_picture;
2097 VASurfaceID backward_reference_picture;
2098 /* meanings of the following fields are the same as in the standard */
2099 int32_t picture_coding_type;
2100 int32_t f_code; /* pack all four fcode into this */
2103 uint32_t intra_dc_precision : 2;
2104 uint32_t picture_structure : 2;
2105 uint32_t top_field_first : 1;
2106 uint32_t frame_pred_frame_dct : 1;
2107 uint32_t concealment_motion_vectors : 1;
2108 uint32_t q_scale_type : 1;
2109 uint32_t intra_vlc_format : 1;
2110 uint32_t alternate_scan : 1;
2111 uint32_t repeat_first_field : 1;
2112 uint32_t progressive_frame : 1;
2113 uint32_t is_first_field : 1; /* indicate whether the current field
2114 * is the first field for field picture
2118 } picture_coding_extension;
2120 /** \brief Reserved bytes for future use, must be zero */
2121 uint32_t va_reserved[VA_PADDING_LOW];
2122 } VAPictureParameterBufferMPEG2;
2124 /** MPEG-2 Inverse Quantization Matrix Buffer */
2125 typedef struct _VAIQMatrixBufferMPEG2
2127 /** \brief Same as the MPEG-2 bitstream syntax element. */
2128 int32_t load_intra_quantiser_matrix;
2129 /** \brief Same as the MPEG-2 bitstream syntax element. */
2130 int32_t load_non_intra_quantiser_matrix;
2131 /** \brief Same as the MPEG-2 bitstream syntax element. */
2132 int32_t load_chroma_intra_quantiser_matrix;
2133 /** \brief Same as the MPEG-2 bitstream syntax element. */
2134 int32_t load_chroma_non_intra_quantiser_matrix;
2135 /** \brief Luminance intra matrix, in zig-zag scan order. */
2136 uint8_t intra_quantiser_matrix[64];
2137 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2138 uint8_t non_intra_quantiser_matrix[64];
2139 /** \brief Chroma intra matrix, in zig-zag scan order. */
2140 uint8_t chroma_intra_quantiser_matrix[64];
2141 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2142 uint8_t chroma_non_intra_quantiser_matrix[64];
2144 /** \brief Reserved bytes for future use, must be zero */
2145 uint32_t va_reserved[VA_PADDING_LOW];
2146 } VAIQMatrixBufferMPEG2;
2148 /** MPEG-2 Slice Parameter Buffer */
2149 typedef struct _VASliceParameterBufferMPEG2
2151 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2152 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2153 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2154 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2155 uint32_t slice_horizontal_position;
2156 uint32_t slice_vertical_position;
2157 int32_t quantiser_scale_code;
2158 int32_t intra_slice_flag;
2160 /** \brief Reserved bytes for future use, must be zero */
2161 uint32_t va_reserved[VA_PADDING_LOW];
2162 } VASliceParameterBufferMPEG2;
2164 /** MPEG-2 Macroblock Parameter Buffer */
2165 typedef struct _VAMacroblockParameterBufferMPEG2
2167 uint16_t macroblock_address;
2169 * macroblock_address (in raster scan order)
2171 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2173 uint8_t macroblock_type; /* see definition below */
2176 uint32_t frame_motion_type : 2;
2177 uint32_t field_motion_type : 2;
2178 uint32_t dct_type : 1;
2182 uint8_t motion_vertical_field_select;
2184 * motion_vertical_field_select:
2185 * see section 6.3.17.2 in the spec
2186 * only the lower 4 bits are used
2187 * bit 0: first vector forward
2188 * bit 1: first vector backward
2189 * bit 2: second vector forward
2190 * bit 3: second vector backward
2192 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2193 uint16_t coded_block_pattern;
2195 * The bitplanes for coded_block_pattern are described
2196 * in Figure 6.10-12 in the spec
2199 /* Number of skipped macroblocks after this macroblock */
2200 uint16_t num_skipped_macroblocks;
2202 /** \brief Reserved bytes for future use, must be zero */
2203 uint32_t va_reserved[VA_PADDING_LOW];
2204 } VAMacroblockParameterBufferMPEG2;
2207 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2209 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2210 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2211 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2212 #define VA_MB_TYPE_MOTION_INTRA 0x10
2215 * MPEG-2 Residual Data Buffer
2216 * For each macroblock, there wil be 64 shorts (16-bit) in the
2217 * residual data buffer
2220 /****************************
2221 * MPEG-4 Part 2 data structures
2222 ****************************/
2224 /* MPEG-4 Picture Parameter Buffer */
2226 * For each frame or field, and before any slice data, a single
2227 * picture parameter buffer must be send.
2229 typedef struct _VAPictureParameterBufferMPEG4
2232 uint16_t vop_height;
2233 VASurfaceID forward_reference_picture;
2234 VASurfaceID backward_reference_picture;
2237 uint32_t short_video_header : 1;
2238 uint32_t chroma_format : 2;
2239 uint32_t interlaced : 1;
2240 uint32_t obmc_disable : 1;
2241 uint32_t sprite_enable : 2;
2242 uint32_t sprite_warping_accuracy : 2;
2243 uint32_t quant_type : 1;
2244 uint32_t quarter_sample : 1;
2245 uint32_t data_partitioned : 1;
2246 uint32_t reversible_vlc : 1;
2247 uint32_t resync_marker_disable : 1;
2251 uint8_t no_of_sprite_warping_points;
2252 int16_t sprite_trajectory_du[3];
2253 int16_t sprite_trajectory_dv[3];
2254 uint8_t quant_precision;
2257 uint32_t vop_coding_type : 2;
2258 uint32_t backward_reference_vop_coding_type : 2;
2259 uint32_t vop_rounding_type : 1;
2260 uint32_t intra_dc_vlc_thr : 3;
2261 uint32_t top_field_first : 1;
2262 uint32_t alternate_vertical_scan_flag : 1;
2266 uint8_t vop_fcode_forward;
2267 uint8_t vop_fcode_backward;
2268 uint16_t vop_time_increment_resolution;
2269 /* short header related */
2270 uint8_t num_gobs_in_vop;
2271 uint8_t num_macroblocks_in_gob;
2272 /* for direct mode prediction */
2276 /** \brief Reserved bytes for future use, must be zero */
2277 uint32_t va_reserved[VA_PADDING_LOW];
2278 } VAPictureParameterBufferMPEG4;
2280 /** MPEG-4 Inverse Quantization Matrix Buffer */
2281 typedef struct _VAIQMatrixBufferMPEG4
2283 /** Same as the MPEG-4:2 bitstream syntax element. */
2284 int32_t load_intra_quant_mat;
2285 /** Same as the MPEG-4:2 bitstream syntax element. */
2286 int32_t load_non_intra_quant_mat;
2287 /** The matrix for intra blocks, in zig-zag scan order. */
2288 uint8_t intra_quant_mat[64];
2289 /** The matrix for non-intra blocks, in zig-zag scan order. */
2290 uint8_t non_intra_quant_mat[64];
2292 /** \brief Reserved bytes for future use, must be zero */
2293 uint32_t va_reserved[VA_PADDING_LOW];
2294 } VAIQMatrixBufferMPEG4;
2296 /** MPEG-4 Slice Parameter Buffer */
2297 typedef struct _VASliceParameterBufferMPEG4
2299 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2300 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2301 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2302 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2303 uint32_t macroblock_number;
2304 int32_t quant_scale;
2306 /** \brief Reserved bytes for future use, must be zero */
2307 uint32_t va_reserved[VA_PADDING_LOW];
2308 } VASliceParameterBufferMPEG4;
2311 VC-1 data structures
2314 typedef enum /* see 7.1.1.32 */
2317 VAMvMode1MvHalfPel = 1,
2318 VAMvMode1MvHalfPelBilinear = 2,
2319 VAMvModeMixedMv = 3,
2320 VAMvModeIntensityCompensation = 4
2323 /** VC-1 Picture Parameter Buffer */
2325 * For each picture, and before any slice data, a picture parameter
2326 * buffer must be send. Multiple picture parameter buffers may be
2327 * sent for a single picture. In that case picture parameters will
2328 * apply to all slice data that follow it until a new picture
2329 * parameter buffer is sent.
2332 * pic_quantizer_type should be set to the applicable quantizer
2333 * type as defined by QUANTIZER (J.1.19) and either
2334 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2336 typedef struct _VAPictureParameterBufferVC1
2338 VASurfaceID forward_reference_picture;
2339 VASurfaceID backward_reference_picture;
2340 /* if out-of-loop post-processing is done on the render
2341 target, then we need to keep the in-loop decoded
2342 picture as a reference picture */
2343 VASurfaceID inloop_decoded_picture;
2345 /* sequence layer for AP or meta data for SP and MP */
2348 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2349 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2350 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2351 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2352 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2353 uint32_t multires : 1; /* METADATA::MULTIRES */
2354 uint32_t overlap : 1; /* METADATA::OVERLAP */
2355 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2356 uint32_t rangered : 1; /* METADATA::RANGERED */
2357 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2358 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2363 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2364 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2367 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2368 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2369 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2370 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2373 } entrypoint_fields;
2374 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2375 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2378 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2379 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2380 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2381 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2384 } range_mapping_fields;
2386 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2387 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2388 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2389 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2390 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2391 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2392 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2393 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2394 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2398 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2399 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2400 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2401 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2402 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2408 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2409 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2410 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2411 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2412 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2413 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2414 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2420 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2421 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2422 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2423 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2424 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2425 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2426 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2429 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2432 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2433 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2434 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2435 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2441 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2442 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2443 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2444 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2445 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2446 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2447 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2448 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2449 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2450 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2456 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2457 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2458 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2459 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2460 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2461 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2462 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2463 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2464 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2465 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2466 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2469 } pic_quantizer_fields;
2472 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2473 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2474 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2475 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2476 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2477 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2482 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2483 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2484 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2486 /** \brief Reserved bytes for future use, must be zero */
2487 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2488 } VAPictureParameterBufferVC1;
2490 /** VC-1 Bitplane Buffer
2491 There will be at most three bitplanes coded in any picture header. To send
2492 the bitplane data more efficiently, each byte is divided in two nibbles, with
2493 each nibble carrying three bitplanes for one macroblock. The following table
2494 shows the bitplane data arrangement within each nibble based on the picture
2497 Picture Type Bit3 Bit2 Bit1 Bit0
2498 I or BI OVERFLAGS ACPRED FIELDTX
2499 P MYTYPEMB SKIPMB DIRECTMB
2500 B FORWARDMB SKIPMB DIRECTMB
2502 Within each byte, the lower nibble is for the first MB and the upper nibble is
2503 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2504 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2505 Macroblock #2 in the first row.
2508 /* VC-1 Slice Parameter Buffer */
2509 typedef struct _VASliceParameterBufferVC1
2511 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2512 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2513 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2514 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2515 uint32_t slice_vertical_position;
2517 /** \brief Reserved bytes for future use, must be zero */
2518 uint32_t va_reserved[VA_PADDING_LOW];
2519 } VASliceParameterBufferVC1;
2521 /* VC-1 Slice Data Buffer */
2523 This is simplely a buffer containing raw bit-stream bytes
2526 /****************************
2527 * H.264/AVC data structures
2528 ****************************/
2530 typedef struct _VAPictureH264
2532 VASurfaceID picture_id;
2535 int32_t TopFieldOrderCnt;
2536 int32_t BottomFieldOrderCnt;
2538 /** \brief Reserved bytes for future use, must be zero */
2539 uint32_t va_reserved[VA_PADDING_LOW];
2541 /* flags in VAPictureH264 could be OR of the following */
2542 #define VA_PICTURE_H264_INVALID 0x00000001
2543 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2544 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2545 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2546 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2548 /** H.264 Picture Parameter Buffer */
2550 * For each picture, and before any slice data, a single
2551 * picture parameter buffer must be send.
2553 typedef struct _VAPictureParameterBufferH264
2555 VAPictureH264 CurrPic;
2556 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2557 uint16_t picture_width_in_mbs_minus1;
2558 uint16_t picture_height_in_mbs_minus1;
2559 uint8_t bit_depth_luma_minus8;
2560 uint8_t bit_depth_chroma_minus8;
2561 uint8_t num_ref_frames;
2564 uint32_t chroma_format_idc : 2;
2565 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2566 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2567 uint32_t frame_mbs_only_flag : 1;
2568 uint32_t mb_adaptive_frame_field_flag : 1;
2569 uint32_t direct_8x8_inference_flag : 1;
2570 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2571 uint32_t log2_max_frame_num_minus4 : 4;
2572 uint32_t pic_order_cnt_type : 2;
2573 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2574 uint32_t delta_pic_order_always_zero_flag : 1;
2578 // FMO is not supported.
2579 va_deprecated uint8_t num_slice_groups_minus1;
2580 va_deprecated uint8_t slice_group_map_type;
2581 va_deprecated uint16_t slice_group_change_rate_minus1;
2582 int8_t pic_init_qp_minus26;
2583 int8_t pic_init_qs_minus26;
2584 int8_t chroma_qp_index_offset;
2585 int8_t second_chroma_qp_index_offset;
2588 uint32_t entropy_coding_mode_flag : 1;
2589 uint32_t weighted_pred_flag : 1;
2590 uint32_t weighted_bipred_idc : 2;
2591 uint32_t transform_8x8_mode_flag : 1;
2592 uint32_t field_pic_flag : 1;
2593 uint32_t constrained_intra_pred_flag : 1;
2594 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2595 uint32_t deblocking_filter_control_present_flag : 1;
2596 uint32_t redundant_pic_cnt_present_flag : 1;
2597 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2603 /** \brief Reserved bytes for future use, must be zero */
2604 uint32_t va_reserved[VA_PADDING_MEDIUM];
2605 } VAPictureParameterBufferH264;
2607 /** H.264 Inverse Quantization Matrix Buffer */
2608 typedef struct _VAIQMatrixBufferH264
2610 /** \brief 4x4 scaling list, in raster scan order. */
2611 uint8_t ScalingList4x4[6][16];
2612 /** \brief 8x8 scaling list, in raster scan order. */
2613 uint8_t ScalingList8x8[2][64];
2615 /** \brief Reserved bytes for future use, must be zero */
2616 uint32_t va_reserved[VA_PADDING_LOW];
2617 } VAIQMatrixBufferH264;
2619 /** H.264 Slice Parameter Buffer */
2620 typedef struct _VASliceParameterBufferH264
2622 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2623 /** \brief Byte offset to the NAL Header Unit for this slice. */
2624 uint32_t slice_data_offset;
2625 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2627 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2629 * This bit offset is relative to and includes the NAL unit byte
2630 * and represents the number of bits parsed in the slice_header()
2631 * after the removal of any emulation prevention bytes in
2632 * there. However, the slice data buffer passed to the hardware is
2633 * the original bitstream, thus including any emulation prevention
2636 uint16_t slice_data_bit_offset;
2637 uint16_t first_mb_in_slice;
2639 uint8_t direct_spatial_mv_pred_flag;
2641 * H264/AVC syntax element
2643 * if num_ref_idx_active_override_flag equals 0, host decoder should
2644 * set its value to num_ref_idx_l0_default_active_minus1.
2646 uint8_t num_ref_idx_l0_active_minus1;
2648 * H264/AVC syntax element
2650 * if num_ref_idx_active_override_flag equals 0, host decoder should
2651 * set its value to num_ref_idx_l1_default_active_minus1.
2653 uint8_t num_ref_idx_l1_active_minus1;
2654 uint8_t cabac_init_idc;
2655 int8_t slice_qp_delta;
2656 uint8_t disable_deblocking_filter_idc;
2657 int8_t slice_alpha_c0_offset_div2;
2658 int8_t slice_beta_offset_div2;
2659 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2660 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2661 uint8_t luma_log2_weight_denom;
2662 uint8_t chroma_log2_weight_denom;
2663 uint8_t luma_weight_l0_flag;
2664 int16_t luma_weight_l0[32];
2665 int16_t luma_offset_l0[32];
2666 uint8_t chroma_weight_l0_flag;
2667 int16_t chroma_weight_l0[32][2];
2668 int16_t chroma_offset_l0[32][2];
2669 uint8_t luma_weight_l1_flag;
2670 int16_t luma_weight_l1[32];
2671 int16_t luma_offset_l1[32];
2672 uint8_t chroma_weight_l1_flag;
2673 int16_t chroma_weight_l1[32][2];
2674 int16_t chroma_offset_l1[32][2];
2676 /** \brief Reserved bytes for future use, must be zero */
2677 uint32_t va_reserved[VA_PADDING_LOW];
2678 } VASliceParameterBufferH264;
2680 /****************************
2681 * Common encode data structures
2682 ****************************/
2685 VAEncPictureTypeIntra = 0,
2686 VAEncPictureTypePredictive = 1,
2687 VAEncPictureTypeBidirectional = 2,
2690 /* Encode Slice Parameter Buffer */
2691 typedef struct _VAEncSliceParameterBuffer
2693 uint32_t start_row_number; /* starting MB row number for this slice */
2694 uint32_t slice_height; /* slice height measured in MB */
2697 uint32_t is_intra : 1;
2698 uint32_t disable_deblocking_filter_idc : 2;
2699 uint32_t uses_long_term_ref :1;
2700 uint32_t is_long_term_ref :1;
2705 /** \brief Reserved bytes for future use, must be zero */
2706 uint32_t va_reserved[VA_PADDING_LOW];
2707 } VAEncSliceParameterBuffer;
2710 /****************************
2711 * H.263 specific encode data structures
2712 ****************************/
2714 typedef struct _VAEncSequenceParameterBufferH263
2716 uint32_t intra_period;
2717 uint32_t bits_per_second;
2718 uint32_t frame_rate;
2719 uint32_t initial_qp;
2722 /** \brief Reserved bytes for future use, must be zero */
2723 uint32_t va_reserved[VA_PADDING_LOW];
2724 } VAEncSequenceParameterBufferH263;
2726 typedef struct _VAEncPictureParameterBufferH263
2728 VASurfaceID reference_picture;
2729 VASurfaceID reconstructed_picture;
2730 VABufferID coded_buf;
2731 uint16_t picture_width;
2732 uint16_t picture_height;
2733 VAEncPictureType picture_type;
2735 /** \brief Reserved bytes for future use, must be zero */
2736 uint32_t va_reserved[VA_PADDING_LOW];
2737 } VAEncPictureParameterBufferH263;
2739 /****************************
2740 * MPEG-4 specific encode data structures
2741 ****************************/
2743 typedef struct _VAEncSequenceParameterBufferMPEG4
2745 uint8_t profile_and_level_indication;
2746 uint32_t intra_period;
2747 uint32_t video_object_layer_width;
2748 uint32_t video_object_layer_height;
2749 uint32_t vop_time_increment_resolution;
2750 uint32_t fixed_vop_rate;
2751 uint32_t fixed_vop_time_increment;
2752 uint32_t bits_per_second;
2753 uint32_t frame_rate;
2754 uint32_t initial_qp;
2757 /** \brief Reserved bytes for future use, must be zero */
2758 uint32_t va_reserved[VA_PADDING_LOW];
2759 } VAEncSequenceParameterBufferMPEG4;
2761 typedef struct _VAEncPictureParameterBufferMPEG4
2763 VASurfaceID reference_picture;
2764 VASurfaceID reconstructed_picture;
2765 VABufferID coded_buf;
2766 uint16_t picture_width;
2767 uint16_t picture_height;
2768 uint32_t modulo_time_base; /* number of 1s */
2769 uint32_t vop_time_increment;
2770 VAEncPictureType picture_type;
2772 /** \brief Reserved bytes for future use, must be zero */
2773 uint32_t va_reserved[VA_PADDING_LOW];
2774 } VAEncPictureParameterBufferMPEG4;
2778 /** Buffer functions */
2781 * Creates a buffer for "num_elements" elements of "size" bytes and
2782 * initalize with "data".
2783 * if "data" is null, then the contents of the buffer data store
2785 * Basically there are two ways to get buffer data to the server side. One is
2786 * to call vaCreateBuffer() with a non-null "data", which results the data being
2787 * copied to the data store on the server side. A different method that
2788 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2789 * and then use vaMapBuffer() to map the data store from the server side to the
2790 * client address space for access.
2791 * The user must call vaDestroyBuffer() to destroy a buffer.
2792 * Note: image buffers are created by the library, not the client. Please see
2793 * vaCreateImage on how image buffers are managed.
2795 VAStatus vaCreateBuffer (
2797 VAContextID context,
2798 VABufferType type, /* in */
2799 unsigned int size, /* in */
2800 unsigned int num_elements, /* in */
2801 void *data, /* in */
2802 VABufferID *buf_id /* out */
2806 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
2807 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
2808 * can call vaMapBuffer with this Buffer ID to get virtual address.
2809 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
2810 * maybe it should align with 256, and one byte present one Qp.so, call the function.
2811 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
2812 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
2813 * pBuf + 256 is the start of next line.
2814 * different driver implementation maybe return different unit_size and pitch
2816 VAStatus vaCreateBuffer2(
2818 VAContextID context,
2821 unsigned int height,
2822 unsigned int *unit_size,
2823 unsigned int *pitch,
2828 * Convey to the server how many valid elements are in the buffer.
2829 * e.g. if multiple slice parameters are being held in a single buffer,
2830 * this will communicate to the server the number of slice parameters
2831 * that are valid in the buffer.
2833 VAStatus vaBufferSetNumElements (
2835 VABufferID buf_id, /* in */
2836 unsigned int num_elements /* in */
2841 * device independent data structure for codedbuffer
2845 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2846 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2847 * enough for the encoder to attempt to limit its size.
2848 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2849 * exceeded the maximum slice size specified.
2850 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2851 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2852 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2854 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2855 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2856 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2857 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2858 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2860 * \brief The frame has exceeded the maximum requested size.
2862 * This flag indicates that the encoded frame size exceeds the value
2863 * specified through a misc parameter buffer of type
2864 * #VAEncMiscParameterTypeMaxFrameSize.
2866 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2867 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2870 * \brief The coded buffer segment contains a single NAL unit.
2872 * This flag indicates that the coded buffer segment contains a
2873 * single NAL unit. This flag might be useful to the user for
2874 * processing the coded buffer.
2876 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2879 * \brief Coded buffer segment.
2881 * #VACodedBufferSegment is an element of a linked list describing
2882 * some information on the coded buffer. The coded buffer segment
2883 * could contain either a single NAL unit, or more than one NAL unit.
2884 * It is recommended (but not required) to return a single NAL unit
2885 * in a coded buffer segment, and the implementation should set the
2886 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2888 typedef struct _VACodedBufferSegment {
2890 * \brief Size of the data buffer in this segment (in bytes).
2893 /** \brief Bit offset into the data buffer where the video data starts. */
2894 uint32_t bit_offset;
2895 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2897 /** \brief Reserved for future use. */
2899 /** \brief Pointer to the start of the data buffer. */
2902 * \brief Pointer to the next #VACodedBufferSegment element,
2903 * or \c NULL if there is none.
2907 /** \brief Reserved bytes for future use, must be zero */
2908 uint32_t va_reserved[VA_PADDING_LOW];
2909 } VACodedBufferSegment;
2912 * Map data store of the buffer into the client's address space
2913 * vaCreateBuffer() needs to be called with "data" set to NULL before
2914 * calling vaMapBuffer()
2916 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2917 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2919 VAStatus vaMapBuffer (
2921 VABufferID buf_id, /* in */
2922 void **pbuf /* out */
2926 * After client making changes to a mapped data store, it needs to
2927 * "Unmap" it to let the server know that the data is ready to be
2928 * consumed by the server
2930 VAStatus vaUnmapBuffer (
2932 VABufferID buf_id /* in */
2936 * After this call, the buffer is deleted and this buffer_id is no longer valid
2938 * A buffer can be re-used and sent to the server by another Begin/Render/End
2939 * sequence if vaDestroyBuffer() is not called with this buffer.
2941 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
2942 * hardware accelerator can result in performance dropping.
2944 VAStatus vaDestroyBuffer (
2946 VABufferID buffer_id
2949 /** \brief VA buffer information */
2951 /** \brief Buffer handle */
2953 /** \brief Buffer type (See \ref VABufferType). */
2956 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2958 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2959 * to specify the set of memory types the caller is interested in.
2960 * On successful return from vaAcquireBufferHandle(), the field is
2961 * updated with the best matching memory type.
2964 /** \brief Size of the underlying buffer. */
2967 /** \brief Reserved bytes for future use, must be zero */
2968 uint32_t va_reserved[VA_PADDING_LOW];
2972 * \brief Acquires buffer handle for external API usage
2974 * Locks the VA buffer object \ref buf_id for external API usage like
2975 * EGL or OpenCL (OCL). This function is a synchronization point. This
2976 * means that any pending operation is guaranteed to be completed
2977 * prior to returning from the function.
2979 * If the referenced VA buffer object is the backing store of a VA
2980 * surface, then this function acts as if vaSyncSurface() on the
2981 * parent surface was called first.
2983 * The \ref VABufferInfo argument shall be zero'ed on input. On
2984 * successful output, the data structure is filled in with all the
2985 * necessary buffer level implementation details like handle, type,
2986 * memory type and memory size.
2988 * Note: the external API implementation, or the application, can
2989 * express the memory types it is interested in by filling in the \ref
2990 * mem_type field accordingly. On successful output, the memory type
2991 * that fits best the request and that was used is updated in the \ref
2992 * VABufferInfo data structure. If none of the supplied memory types
2993 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2994 * error is returned.
2996 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2997 * is called. Besides, no additional operation is allowed on any of
2998 * the buffer parent object until vaReleaseBufferHandle() is called.
2999 * e.g. decoding into a VA surface backed with the supplied VA buffer
3000 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3004 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3005 * does not support this interface
3006 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3007 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3008 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3009 * does not support exporting buffers of the specified type
3010 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3011 * memory types in \ref VABufferInfo.mem_type was supported
3013 * @param[in] dpy the VA display
3014 * @param[in] buf_id the VA buffer
3015 * @param[in,out] buf_info the associated VA buffer information
3016 * @return VA_STATUS_SUCCESS if successful
3019 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3022 * \brief Releases buffer after usage from external API
3024 * Unlocks the VA buffer object \ref buf_id from external API usage like
3025 * EGL or OpenCL (OCL). This function is a synchronization point. This
3026 * means that any pending operation is guaranteed to be completed
3027 * prior to returning from the function.
3029 * The \ref VABufferInfo argument shall point to the original data
3030 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3031 * This is necessary so that the VA driver implementation could
3032 * deallocate any resources that were needed.
3034 * In any case, returning from this function invalidates any contents
3035 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3036 * valid. Therefore, VA driver implementations are free to reset this
3037 * data structure to safe defaults.
3040 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3041 * does not support this interface
3042 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3043 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3044 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3045 * does not support exporting buffers of the specified type
3047 * @param[in] dpy the VA display
3048 * @param[in] buf_id the VA buffer
3049 * @return VA_STATUS_SUCCESS if successful
3052 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3055 * Render (Video Decode/Encode/Processing) Pictures
3057 * A picture represents either a frame or a field.
3059 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3064 * Get ready for a video pipeline
3065 * - decode a picture to a target surface
3066 * - encode a picture from a target surface
3067 * - process a picture to a target surface
3069 VAStatus vaBeginPicture (
3071 VAContextID context,
3072 VASurfaceID render_target
3076 * Send video decode, encode or processing buffers to the server.
3078 VAStatus vaRenderPicture (
3080 VAContextID context,
3081 VABufferID *buffers,
3086 * Make the end of rendering for a picture.
3087 * The server should start processing all pending operations for this
3088 * surface. This call is non-blocking. The client can start another
3089 * Begin/Render/End sequence on a different render target.
3090 * if VAContextID used in this function previously successfully passed
3091 * vaMFAddContext call, real processing will be started during vaMFSubmit
3093 VAStatus vaEndPicture (
3099 * Make the end of rendering for a pictures in contexts passed with submission.
3100 * The server should start processing all pending operations for contexts.
3101 * All contexts passed should be associated through vaMFAddContext
3102 * and call sequence Begin/Render/End performed.
3103 * This call is non-blocking. The client can start another
3104 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3106 * VA_STATUS_SUCCESS - operation successful, context was removed.
3107 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3108 * due to mf_context not created or one of contexts not assotiated with mf_context
3109 * through vaAddContext.
3110 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3111 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3113 * mf_context: Multi-Frame context
3114 * contexts: list of contexts submitting their tasks for multi-frame operation.
3115 * num_contexts: number of passed contexts.
3117 VAStatus vaMFSubmit (
3119 VAMFContextID mf_context,
3120 VAContextID * contexts,
3131 * This function blocks until all pending operations on the render target
3132 * have been completed. Upon return it is safe to use the render target for a
3133 * different picture.
3135 VAStatus vaSyncSurface (
3137 VASurfaceID render_target
3142 VASurfaceRendering = 1, /* Rendering in progress */
3143 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3144 /* this status is useful if surface is used as the source */
3146 VASurfaceReady = 4, /* not being rendered or displayed */
3147 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3151 * Find out any pending ops on the render target
3153 VAStatus vaQuerySurfaceStatus (
3155 VASurfaceID render_target,
3156 VASurfaceStatus *status /* out */
3161 VADecodeSliceMissing = 0,
3162 VADecodeMBError = 1,
3163 } VADecodeErrorType;
3166 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3167 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3169 typedef struct _VASurfaceDecodeMBErrors
3171 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3172 uint32_t start_mb; /* start mb address with errors */
3173 uint32_t end_mb; /* end mb address with errors */
3174 VADecodeErrorType decode_error_type;
3176 /** \brief Reserved bytes for future use, must be zero */
3177 uint32_t va_reserved[VA_PADDING_LOW];
3178 } VASurfaceDecodeMBErrors;
3181 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3182 * it can call vaQuerySurfaceError to find out further details on the particular error.
3183 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3184 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3185 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3186 * The array is terminated if "status==-1" is detected.
3188 VAStatus vaQuerySurfaceError(
3190 VASurfaceID surface,
3191 VAStatus error_status,
3196 * Images and Subpictures
3197 * VAImage is used to either get the surface data to client memory, or
3198 * to copy image data in client memory to a surface.
3199 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3200 * is at the upper left corner with positive X to the right and positive Y down
3202 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3203 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3204 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3207 * Pre-defined fourcc codes
3209 #define VA_FOURCC_NV12 0x3231564E
3210 #define VA_FOURCC_NV21 0x3132564E
3211 #define VA_FOURCC_AI44 0x34344149
3212 #define VA_FOURCC_RGBA 0x41424752
3213 #define VA_FOURCC_RGBX 0x58424752
3214 #define VA_FOURCC_BGRA 0x41524742
3215 #define VA_FOURCC_BGRX 0x58524742
3216 #define VA_FOURCC_ARGB 0x42475241
3217 #define VA_FOURCC_XRGB 0x42475258
3218 #define VA_FOURCC_ABGR 0x52474241
3219 #define VA_FOURCC_XBGR 0x52474258
3220 #define VA_FOURCC_UYVY 0x59565955
3221 #define VA_FOURCC_YUY2 0x32595559
3222 #define VA_FOURCC_AYUV 0x56555941
3223 #define VA_FOURCC_NV11 0x3131564e
3224 #define VA_FOURCC_YV12 0x32315659
3225 #define VA_FOURCC_P208 0x38303250
3226 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3227 #define VA_FOURCC_IYUV 0x56555949
3228 #define VA_FOURCC_I420 0x30323449
3229 #define VA_FOURCC_YV24 0x34325659
3230 #define VA_FOURCC_YV32 0x32335659
3231 #define VA_FOURCC_Y800 0x30303859
3232 #define VA_FOURCC_IMC3 0x33434D49
3233 #define VA_FOURCC_411P 0x50313134
3234 #define VA_FOURCC_422H 0x48323234
3235 #define VA_FOURCC_422V 0x56323234
3236 #define VA_FOURCC_444P 0x50343434
3237 #define VA_FOURCC_RGBP 0x50424752
3238 #define VA_FOURCC_BGRP 0x50524742
3239 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
3242 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3244 #define VA_FOURCC_YV16 0x36315659
3246 * 10-bit and 16-bit Planar YUV 4:2:0.
3248 #define VA_FOURCC_P010 0x30313050
3249 #define VA_FOURCC_P016 0x36313050
3252 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3254 #define VA_FOURCC_I010 0x30313049
3257 #define VA_LSB_FIRST 1
3258 #define VA_MSB_FIRST 2
3260 typedef struct _VAImageFormat
3263 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3264 uint32_t bits_per_pixel;
3265 /* for RGB formats */
3266 uint32_t depth; /* significant bits per pixel */
3268 uint32_t green_mask;
3270 uint32_t alpha_mask;
3272 /** \brief Reserved bytes for future use, must be zero */
3273 uint32_t va_reserved[VA_PADDING_LOW];
3276 typedef VAGenericID VAImageID;
3278 typedef struct _VAImage
3280 VAImageID image_id; /* uniquely identify this image */
3281 VAImageFormat format;
3282 VABufferID buf; /* image data buffer */
3284 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3285 * data store on the server side for optimal performance. The buffer will be
3286 * created by the CreateImage function, and proper storage allocated based on the image
3287 * size and format. This buffer is managed by the library implementation, and
3288 * accessed by the client through the buffer Map/Unmap functions.
3293 uint32_t num_planes; /* can not be greater than 3 */
3295 * An array indicating the scanline pitch in bytes for each plane.
3296 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3298 uint32_t pitches[3];
3300 * An array indicating the byte offset from the beginning of the image data
3301 * to the start of each plane.
3303 uint32_t offsets[3];
3305 /* The following fields are only needed for paletted formats */
3306 int32_t num_palette_entries; /* set to zero for non-palette images */
3308 * Each component is one byte and entry_bytes indicates the number of components in
3309 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3311 int32_t entry_bytes;
3313 * An array of ascii characters describing the order of the components within the bytes.
3314 * Only entry_bytes characters of the string are used.
3316 int8_t component_order[4];
3318 /** \brief Reserved bytes for future use, must be zero */
3319 uint32_t va_reserved[VA_PADDING_LOW];
3322 /** Get maximum number of image formats supported by the implementation */
3323 int vaMaxNumImageFormats (
3328 * Query supported image formats
3329 * The caller must provide a "format_list" array that can hold at
3330 * least vaMaxNumImageFormats() entries. The actual number of formats
3331 * returned in "format_list" is returned in "num_formats".
3333 VAStatus vaQueryImageFormats (
3335 VAImageFormat *format_list, /* out */
3336 int *num_formats /* out */
3340 * Create a VAImage structure
3341 * The width and height fields returned in the VAImage structure may get
3342 * enlarged for some YUV formats. Upon return from this function,
3343 * image->buf has been created and proper storage allocated by the library.
3344 * The client can access the image through the Map/Unmap calls.
3346 VAStatus vaCreateImage (
3348 VAImageFormat *format,
3351 VAImage *image /* out */
3355 * Should call DestroyImage before destroying the surface it is bound to
3357 VAStatus vaDestroyImage (
3362 VAStatus vaSetImagePalette (
3366 * pointer to an array holding the palette data. The size of the array is
3367 * num_palette_entries * entry_bytes in size. The order of the components
3368 * in the palette is described by the component_order in VAImage struct
3370 unsigned char *palette
3374 * Retrive surface data into a VAImage
3375 * Image must be in a format supported by the implementation
3377 VAStatus vaGetImage (
3379 VASurfaceID surface,
3380 int x, /* coordinates of the upper left source pixel */
3382 unsigned int width, /* width and height of the region */
3383 unsigned int height,
3388 * Copy data from a VAImage to a surface
3389 * Image must be in a format supported by the implementation
3390 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3391 * shouldn't be rendered into when this is called
3393 VAStatus vaPutImage (
3395 VASurfaceID surface,
3399 unsigned int src_width,
3400 unsigned int src_height,
3403 unsigned int dest_width,
3404 unsigned int dest_height
3408 * Derive an VAImage from an existing surface.
3409 * This interface will derive a VAImage and corresponding image buffer from
3410 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3411 * direct CPU access. This operation is only possible on implementations with
3412 * direct rendering capabilities and internal surface formats that can be
3413 * represented with a VAImage. When the operation is not possible this interface
3414 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3415 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3418 * Implementations should only return success when the resulting image buffer
3419 * would be useable with vaMap/Unmap.
3421 * When directly accessing a surface special care must be taken to insure
3422 * proper synchronization with the graphics hardware. Clients should call
3423 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3424 * rendering or currently being displayed by an overlay.
3426 * Additionally nothing about the contents of a surface should be assumed
3427 * following a vaPutSurface. Implementations are free to modify the surface for
3428 * scaling or subpicture blending within a call to vaPutImage.
3430 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3431 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3432 * vaGetImage with other surfaces is supported.
3434 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3435 * image and image buffer structures will be destroyed; however, the underlying
3436 * surface will remain unchanged until freed with vaDestroySurfaces.
3438 VAStatus vaDeriveImage (
3440 VASurfaceID surface,
3441 VAImage *image /* out */
3446 * Subpicture is a special type of image that can be blended
3447 * with a surface during vaPutSurface(). Subpicture can be used to render
3448 * DVD sub-titles or closed captioning text etc.
3451 typedef VAGenericID VASubpictureID;
3453 /** Get maximum number of subpicture formats supported by the implementation */
3454 int vaMaxNumSubpictureFormats (
3458 /** flags for subpictures */
3459 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3460 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3461 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3463 * Query supported subpicture formats
3464 * The caller must provide a "format_list" array that can hold at
3465 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3466 * for each format to indicate additional capabilities for that format. The actual
3467 * number of formats returned in "format_list" is returned in "num_formats".
3468 * flags: returned value to indicate addtional capabilities
3469 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3470 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3471 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3474 VAStatus vaQuerySubpictureFormats (
3476 VAImageFormat *format_list, /* out */
3477 unsigned int *flags, /* out */
3478 unsigned int *num_formats /* out */
3482 * Subpictures are created with an image associated.
3484 VAStatus vaCreateSubpicture (
3487 VASubpictureID *subpicture /* out */
3491 * Destroy the subpicture before destroying the image it is assocated to
3493 VAStatus vaDestroySubpicture (
3495 VASubpictureID subpicture
3499 * Bind an image to the subpicture. This image will now be associated with
3500 * the subpicture instead of the one at creation.
3502 VAStatus vaSetSubpictureImage (
3504 VASubpictureID subpicture,
3509 * If chromakey is enabled, then the area where the source value falls within
3510 * the chromakey [min, max] range is transparent
3511 * The chromakey component format is the following:
3512 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3513 * For YUV: [0:7] V [8:15] U [16:23] Y
3514 * The chromakey mask can be used to mask out certain components for chromakey
3517 VAStatus vaSetSubpictureChromakey (
3519 VASubpictureID subpicture,
3520 unsigned int chromakey_min,
3521 unsigned int chromakey_max,
3522 unsigned int chromakey_mask
3526 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3527 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3528 * the overall alpha is per-pixel alpha multiplied by the global alpha
3530 VAStatus vaSetSubpictureGlobalAlpha (
3532 VASubpictureID subpicture,
3537 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3538 * It defines the region mapping between the subpicture and the target
3539 * surfaces through source and destination rectangles (with the same width and height).
3540 * Both will be displayed at the next call to vaPutSurface. Additional
3541 * associations before the call to vaPutSurface simply overrides the association.
3543 VAStatus vaAssociateSubpicture (
3545 VASubpictureID subpicture,
3546 VASurfaceID *target_surfaces,
3548 int16_t src_x, /* upper left offset in subpicture */
3551 uint16_t src_height,
3552 int16_t dest_x, /* upper left offset in surface */
3554 uint16_t dest_width,
3555 uint16_t dest_height,
3557 * whether to enable chroma-keying, global-alpha, or screen relative mode
3558 * see VA_SUBPICTURE_XXX values
3564 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3566 VAStatus vaDeassociateSubpicture (
3568 VASubpictureID subpicture,
3569 VASurfaceID *target_surfaces,
3574 * Display attributes
3575 * Display attributes are used to control things such as contrast, hue, saturation,
3576 * brightness etc. in the rendering process. The application can query what
3577 * attributes are supported by the driver, and then set the appropriate attributes
3578 * before calling vaPutSurface()
3580 /* PowerVR IEP Lite attributes */
3583 VADISPLAYATTRIB_BLE_OFF = 0x00,
3584 VADISPLAYATTRIB_BLE_LOW,
3585 VADISPLAYATTRIB_BLE_MEDIUM,
3586 VADISPLAYATTRIB_BLE_HIGH,
3587 VADISPLAYATTRIB_BLE_NONE,
3588 } VADisplayAttribBLEMode;
3590 /** attribute value for VADisplayAttribRotation */
3591 #define VA_ROTATION_NONE 0x00000000
3592 #define VA_ROTATION_90 0x00000001
3593 #define VA_ROTATION_180 0x00000002
3594 #define VA_ROTATION_270 0x00000003
3598 * @name Mirroring directions
3600 * Those values could be used for VADisplayAttribMirror attribute or
3601 * VAProcPipelineParameterBuffer::mirror_state.
3605 /** \brief No Mirroring. */
3606 #define VA_MIRROR_NONE 0x00000000
3607 /** \brief Horizontal Mirroring. */
3608 #define VA_MIRROR_HORIZONTAL 0x00000001
3609 /** \brief Vertical Mirroring. */
3610 #define VA_MIRROR_VERTICAL 0x00000002
3613 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3614 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3615 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3618 #define VA_RENDER_MODE_UNDEFINED 0
3619 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3620 #define VA_RENDER_MODE_LOCAL_GPU 2
3621 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3622 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3624 /** Render device */
3625 #define VA_RENDER_DEVICE_UNDEFINED 0
3626 #define VA_RENDER_DEVICE_LOCAL 1
3627 #define VA_RENDER_DEVICE_EXTERNAL 2
3629 /** Currently defined display attribute types */
3632 VADisplayAttribBrightness = 0,
3633 VADisplayAttribContrast = 1,
3634 VADisplayAttribHue = 2,
3635 VADisplayAttribSaturation = 3,
3636 /* client can specifiy a background color for the target window
3637 * the new feature of video conference,
3638 * the uncovered area of the surface is filled by this color
3639 * also it will blend with the decoded video color
3641 VADisplayAttribBackgroundColor = 4,
3643 * this is a gettable only attribute. For some implementations that use the
3644 * hardware overlay, after PutSurface is called, the surface can not be
3645 * re-used until after the subsequent PutSurface call. If this is the case
3646 * then the value for this attribute will be set to 1 so that the client
3647 * will not attempt to re-use the surface right after returning from a call
3650 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3651 * driver may use overlay or GPU alternatively
3653 VADisplayAttribDirectSurface = 5,
3654 VADisplayAttribRotation = 6,
3655 VADisplayAttribOutofLoopDeblock = 7,
3657 /* PowerVR IEP Lite specific attributes */
3658 VADisplayAttribBLEBlackMode = 8,
3659 VADisplayAttribBLEWhiteMode = 9,
3660 VADisplayAttribBlueStretch = 10,
3661 VADisplayAttribSkinColorCorrection = 11,
3663 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3664 * conversion matrix. Each element in the matrix is float-point
3666 VADisplayAttribCSCMatrix = 12,
3667 /* specify the constant color used to blend with video surface
3668 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3669 * d: the final color to overwrite into the frame buffer
3670 * v: decoded video after color conversion,
3671 * c: video color specified by VADisplayAttribBlendColor
3672 * b: background color of the drawable
3674 VADisplayAttribBlendColor = 13,
3676 * Indicate driver to skip painting color key or not.
3677 * only applicable if the render is overlay
3679 VADisplayAttribOverlayAutoPaintColorKey = 14,
3681 * customized overlay color key, the format is RGB888
3682 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3684 VADisplayAttribOverlayColorKey = 15,
3686 * The hint for the implementation of vaPutSurface
3687 * normally, the driver could use an overlay or GPU to render the surface on the screen
3688 * this flag provides APP the flexibity to switch the render dynamically
3690 VADisplayAttribRenderMode = 16,
3692 * specify if vaPutSurface needs to render into specified monitors
3693 * one example is that one external monitor (e.g. HDMI) is enabled,
3694 * but the window manager is not aware of it, and there is no associated drawable
3696 VADisplayAttribRenderDevice = 17,
3698 * specify vaPutSurface render area if there is no drawable on the monitor
3700 VADisplayAttribRenderRect = 18,
3701 } VADisplayAttribType;
3703 /* flags for VADisplayAttribute */
3704 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3705 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3706 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3708 typedef struct _VADisplayAttribute
3710 VADisplayAttribType type;
3713 int32_t value; /* used by the set/get attribute functions */
3714 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3717 /** \brief Reserved bytes for future use, must be zero */
3718 uint32_t va_reserved[VA_PADDING_LOW];
3719 } VADisplayAttribute;
3721 /** Get maximum number of display attributs supported by the implementation */
3722 int vaMaxNumDisplayAttributes (
3727 * Query display attributes
3728 * The caller must provide a "attr_list" array that can hold at
3729 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3730 * returned in "attr_list" is returned in "num_attributes".
3732 VAStatus vaQueryDisplayAttributes (
3734 VADisplayAttribute *attr_list, /* out */
3735 int *num_attributes /* out */
3739 * Get display attributes
3740 * This function returns the current attribute values in "attr_list".
3741 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3742 * from vaQueryDisplayAttributes() can have their values retrieved.
3744 VAStatus vaGetDisplayAttributes (
3746 VADisplayAttribute *attr_list, /* in/out */
3751 * Set display attributes
3752 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3753 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3754 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3756 VAStatus vaSetDisplayAttributes (
3758 VADisplayAttribute *attr_list,
3762 /****************************
3763 * HEVC data structures
3764 ****************************/
3766 * \brief Description of picture properties of those in DPB surfaces.
3768 * If only progressive scan is supported, each surface contains one whole
3770 * Otherwise, each surface contains two fields of whole picture.
3771 * In this case, two entries of ReferenceFrames[] may share same picture_id
3774 typedef struct _VAPictureHEVC
3776 /** \brief reconstructed picture buffer surface index
3777 * invalid when taking value VA_INVALID_SURFACE.
3779 VASurfaceID picture_id;
3780 /** \brief picture order count.
3781 * in HEVC, POCs for top and bottom fields of same picture should
3782 * take different values.
3784 int32_t pic_order_cnt;
3785 /* described below */
3788 /** \brief Reserved bytes for future use, must be zero */
3789 uint32_t va_reserved[VA_PADDING_LOW];
3792 /* flags in VAPictureHEVC could be OR of the following */
3793 #define VA_PICTURE_HEVC_INVALID 0x00000001
3794 /** \brief indication of interlace scan picture.
3795 * should take same value for all the pictures in sequence.
3797 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3798 /** \brief polarity of the field picture.
3799 * top field takes even lines of buffer surface.
3800 * bottom field takes odd lines of buffer surface.
3802 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3803 /** \brief Long term reference picture */
3804 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3806 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3807 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3808 * be exclusive. No more than one of them can be set for any picture.
3809 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3810 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3811 * Application should provide valid values for both short format and long format.
3812 * The pictures in DPB with any of these three flags turned on are referred by
3813 * the current picture.
3815 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3816 * Number of ReferenceFrames[] entries with this bit set equals
3817 * NumPocStCurrBefore.
3819 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3820 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3821 * Number of ReferenceFrames[] entries with this bit set equals
3822 * NumPocStCurrAfter.
3824 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3825 /** \brief RefPicSetLtCurr of HEVC spec variable
3826 * Number of ReferenceFrames[] entries with this bit set equals
3829 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3831 #include <va/va_dec_hevc.h>
3832 #include <va/va_dec_jpeg.h>
3833 #include <va/va_dec_vp8.h>
3834 #include <va/va_dec_vp9.h>
3835 #include <va/va_enc_hevc.h>
3836 #include <va/va_enc_h264.h>
3837 #include <va/va_enc_jpeg.h>
3838 #include <va/va_enc_mpeg2.h>
3839 #include <va/va_enc_vp8.h>
3840 #include <va/va_enc_vp9.h>
3841 #include <va/va_fei.h>
3842 #include <va/va_fei_h264.h>
3843 #include <va/va_vpp.h>