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,
439 * \brief Decode processing support. Read/write.
441 * This attribute determines if the driver supports video processing
442 * with decoding using the decoding context in a single call, through
443 * vaGetConfigAttributes(); and if the user may use this feature,
444 * through vaCreateConfig(), if the driver supports the user scenario.
445 * The user will essentially create a regular decode VAContext. Therefore,
446 * the parameters of vaCreateContext() such as picture_width, picture_height
447 * and render_targets are in relation to the decode output parameters
448 * (not processing output parameters) as normal.
449 * If this attribute is not set by the user then it is assumed that no
450 * extra processing is done after decoding for this decode context.
452 * Since essentially the application is creating a decoder config and context,
453 * all function calls that take in the config (e.g. vaQuerySurfaceAttributes())
454 * or context are in relation to the decoder, except those video processing
455 * function specified in the next paragraph.
457 * Once the decode config and context are created, the user must further
458 * query the supported processing filters using vaQueryVideoProcFilters(),
459 * vaQueryVideoProcFilterCaps(), vaQueryVideoProcPipelineCaps() by specifying
460 * the created decode context. The user must provide processing information
461 * and extra processing output surfaces as "additional_outputs" to the driver
462 * through VAProcPipelineParameterBufferType. The render_target specified
463 * at vaBeginPicture() time refers to the decode output surface. The
464 * target surface for the output of processing needs to be a different
465 * surface since the decode process requires the original reconstructed buffer.
466 * The “surface” member of VAProcPipelineParameterBuffer should be set to the
467 * same as “render_target” set in vaBeginPicture(), but the driver may choose
468 * to ignore this parameter.
470 VAConfigAttribDecProcessing = 8,
471 /** @name Attributes for encoding */
474 * \brief Packed headers mode. Read/write.
476 * This attribute determines what packed headers the driver supports,
477 * through vaGetConfigAttributes(); and what packed headers the user
478 * will be providing to the driver, through vaCreateConfig(), if the
479 * driver supports those.
481 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
483 VAConfigAttribEncPackedHeaders = 10,
485 * \brief Interlaced mode. Read/write.
487 * This attribute determines what kind of interlaced encoding mode
488 * the driver supports.
490 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
492 VAConfigAttribEncInterlaced = 11,
494 * \brief Maximum number of reference frames. Read-only.
496 * This attribute determines the maximum number of reference
497 * frames supported for encoding.
499 * Note: for H.264 encoding, the value represents the maximum number
500 * of reference frames for both the reference picture list 0 (bottom
501 * 16 bits) and the reference picture list 1 (top 16 bits).
503 VAConfigAttribEncMaxRefFrames = 13,
505 * \brief Maximum number of slices per frame. Read-only.
507 * This attribute determines the maximum number of slices the
508 * driver can support to encode a single frame.
510 VAConfigAttribEncMaxSlices = 14,
512 * \brief Slice structure. Read-only.
514 * This attribute determines slice structures supported by the
515 * driver for encoding. This attribute is a hint to the user so
516 * that he can choose a suitable surface size and how to arrange
517 * the encoding process of multiple slices per frame.
519 * More specifically, for H.264 encoding, this attribute
520 * determines the range of accepted values to
521 * VAEncSliceParameterBufferH264::macroblock_address and
522 * VAEncSliceParameterBufferH264::num_macroblocks.
524 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
527 VAConfigAttribEncSliceStructure = 15,
529 * \brief Macroblock information. Read-only.
531 * This attribute determines whether the driver supports extra
532 * encoding information per-macroblock. e.g. QP.
534 * More specifically, for H.264 encoding, if the driver returns a non-zero
535 * value for this attribute, this means the application can create
536 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
537 * through VAEncSliceParameterBufferH264::macroblock_info.
539 VAConfigAttribEncMacroblockInfo = 16,
541 * \brief Maximum picture width. Read-only.
543 * This attribute determines the maximum picture width the driver supports
544 * for a given configuration.
546 VAConfigAttribMaxPictureWidth = 18,
548 * \brief Maximum picture height. Read-only.
550 * This attribute determines the maximum picture height the driver supports
551 * for a given configuration.
553 VAConfigAttribMaxPictureHeight = 19,
555 * \brief JPEG encoding attribute. Read-only.
557 * This attribute exposes a number of capabilities of the underlying
558 * JPEG implementation. The attribute value is partitioned into fields as defined in the
559 * VAConfigAttribValEncJPEG union.
561 VAConfigAttribEncJPEG = 20,
563 * \brief Encoding quality range attribute. Read-only.
565 * This attribute conveys whether the driver supports different quality level settings
566 * for encoding. A value less than or equal to 1 means that the encoder only has a single
567 * quality setting, and a value greater than 1 represents the number of quality levels
568 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
570 VAConfigAttribEncQualityRange = 21,
572 * \brief Encoding quantization attribute. Read-only.
574 * This attribute conveys whether the driver supports certain types of quantization methods
575 * for encoding (e.g. trellis). See \c VA_ENC_QUANTIZATION_xxx for the list of quantization methods
577 VAConfigAttribEncQuantization = 22,
579 * \brief Encoding intra refresh attribute. Read-only.
581 * This attribute conveys whether the driver supports certain types of intra refresh methods
582 * for encoding (e.g. adaptive intra refresh or rolling intra refresh).
583 * See \c VA_ENC_INTRA_REFRESH_xxx for intra refresh methods
585 VAConfigAttribEncIntraRefresh = 23,
587 * \brief Encoding skip frame attribute. Read-only.
589 * This attribute conveys whether the driver supports sending skip frame parameters
590 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
591 * externally skipped frames.
593 VAConfigAttribEncSkipFrame = 24,
595 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
597 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
598 * based on user provided ROI rectangles. The attribute value is partitioned into fields
599 * as defined in the VAConfigAttribValEncROI union.
601 * If ROI encoding is supported, the ROI information is passed to the driver using
602 * VAEncMiscParameterTypeROI.
604 VAConfigAttribEncROI = 25,
606 * \brief Encoding extended rate control attribute. Read-only.
608 * This attribute conveys whether the driver supports any extended rate control features
609 * The attribute value is partitioned into fields as defined in the
610 * VAConfigAttribValEncRateControlExt union.
612 VAConfigAttribEncRateControlExt = 26,
614 * \brief Processing rate reporting attribute. Read-only.
616 * This attribute conveys whether the driver supports reporting of
617 * encode/decode processing rate based on certain set of parameters
618 * (i.e. levels, I frame internvals) for a given configuration.
619 * If this is supported, vaQueryProcessingRate() can be used to get
620 * encode or decode processing rate.
621 * See \c VA_PROCESSING_RATE_xxx for encode/decode processing rate
623 VAConfigAttribProcessingRate = 27,
625 * \brief Encoding dirty rectangle. Read-only.
627 * This attribute conveys whether the driver supports dirty rectangle.
628 * encoding, based on user provided ROI rectangles which indicate the rectangular areas
629 * where the content has changed as compared to the previous picture. The regions of the
630 * picture that are not covered by dirty rect rectangles are assumed to have not changed
631 * compared to the previous picture. The encoder may do some optimizations based on
632 * this information. The attribute value returned indicates the number of regions that
633 * are supported. e.g. A value of 0 means dirty rect encoding is not supported. If dirty
634 * rect encoding is supported, the ROI information is passed to the driver using
635 * VAEncMiscParameterTypeDirtyRect.
637 VAConfigAttribEncDirtyRect = 28,
639 * \brief Parallel Rate Control (hierachical B) attribute. Read-only.
641 * This attribute conveys whether the encoder supports parallel rate control.
642 * It is a integer value 0 - unsupported, > 0 - maximum layer supported.
643 * This is the way when hireachical B frames are encoded, multiple independent B frames
644 * on the same layer may be processed at same time. If supported, app may enable it by
645 * setting enable_parallel_brc in VAEncMiscParameterRateControl,and the number of B frames
646 * per layer per GOP will be passed to driver through VAEncMiscParameterParallelRateControl
647 * structure.Currently three layers are defined.
649 VAConfigAttribEncParallelRateControl = 29,
651 * \brief Dynamic Scaling Attribute. Read-only.
653 * This attribute conveys whether encoder is capable to determine dynamic frame
654 * resolutions adaptive to bandwidth utilization and processing power, etc.
655 * It is a boolean value 0 - unsupported, 1 - supported.
656 * If it is supported,for VP9, suggested frame resolution can be retrieved from VACodedBufferVP9Status.
658 VAConfigAttribEncDynamicScaling = 30,
660 * \brief frame size tolerance support
661 * it indicates the tolerance of frame size
663 VAConfigAttribFrameSizeToleranceSupport = 31,
665 * \brief Encode function type for FEI.
667 * This attribute conveys whether the driver supports different function types for encode.
668 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
669 * it is for FEI entry point only.
670 * Default is VA_FEI_FUNCTION_ENC_PAK.
672 VAConfigAttribFEIFunctionType = 32,
674 * \brief Maximum number of FEI MV predictors. Read-only.
676 * This attribute determines the maximum number of MV predictors the driver
677 * can support to encode a single frame. 0 means no MV predictor is supported.
678 * Currently it is for FEI entry point only.
680 VAConfigAttribFEIMVPredictors = 33,
682 * \brief Tile Support Attribute. Read-only.
684 * This attribute conveys whether encoder is capable to support tiles.
685 * If not supported, the tile related parameters sent to encoder, such as
686 * tiling structure, should be ignored. 0 - unsupported, 1 - supported.
688 VAConfigAttribEncTileSupport = 35,
690 * \brief whether accept rouding setting from application. Read-only.
691 * This attribute is for encode quality, if it is report,
692 * application can change the rounding setting by VAEncMiscParameterTypeCustomRoundingControl
694 VAConfigAttribCustomRoundingControl = 36,
696 VAConfigAttribTypeMax
697 } VAConfigAttribType;
700 * Configuration attributes
701 * If there is more than one value for an attribute, a default
702 * value will be assigned to the attribute if the client does not
703 * specify the attribute when creating a configuration
705 typedef struct _VAConfigAttrib {
706 VAConfigAttribType type;
707 uint32_t value; /* OR'd flags (bits) for this attribute */
710 /** attribute value for VAConfigAttribRTFormat */
711 #define VA_RT_FORMAT_YUV420 0x00000001
712 #define VA_RT_FORMAT_YUV422 0x00000002
713 #define VA_RT_FORMAT_YUV444 0x00000004
714 #define VA_RT_FORMAT_YUV411 0x00000008
715 #define VA_RT_FORMAT_YUV400 0x00000010
716 /** YUV formats with more than 8 bpp */
717 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
719 #define VA_RT_FORMAT_RGB16 0x00010000
720 #define VA_RT_FORMAT_RGB32 0x00020000
721 /* RGBP covers RGBP and BGRP fourcc */
722 #define VA_RT_FORMAT_RGBP 0x00100000
724 * RGB 10-bit packed format with upper 2 bits as alpha channel.
725 * The existing pre-defined fourcc codes can be used to signal
726 * the position of each component for this RT format.
728 #define VA_RT_FORMAT_RGB32_10BPP 0x00200000
729 #define VA_RT_FORMAT_PROTECTED 0x80000000
731 /** @name Attribute values for VAConfigAttribRateControl */
733 /** \brief Driver does not support any form of rate control. */
734 #define VA_RC_NONE 0x00000001
735 /** \brief Constant bitrate. */
736 #define VA_RC_CBR 0x00000002
737 /** \brief Variable bitrate. */
738 #define VA_RC_VBR 0x00000004
739 /** \brief Video conference mode. */
740 #define VA_RC_VCM 0x00000008
741 /** \brief Constant QP. */
742 #define VA_RC_CQP 0x00000010
743 /** \brief Variable bitrate with peak rate higher than average bitrate. */
744 #define VA_RC_VBR_CONSTRAINED 0x00000020
745 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
746 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
747 #define VA_RC_ICQ 0x00000040
748 /** \brief Macroblock based rate control. Per MB control is decided
749 * internally in the encoder. It may be combined with other RC modes, except CQP. */
750 #define VA_RC_MB 0x00000080
751 /** \brief Constant Frame Size, it is used for small tolerent */
752 #define VA_RC_CFS 0x00000100
753 /** \brief Parallel BRC, for hierachical B.
755 * For hierachical B, B frames can be refered by other B frames.
756 * Currently three layers of hierachy are defined:
757 * B0 - regular B, no reference to other B frames.
758 * B1 - reference to only I, P and regular B0 frames.
759 * B2 - reference to any other frames, including B1.
760 * In Hierachical B structure, B frames on the same layer can be processed
761 * simultaneously. And BRC would adjust accordingly. This is so called
763 #define VA_RC_PARALLEL 0x00000200
767 /** @name Attribute values for VAConfigAttribDecSliceMode */
769 /** \brief Driver supports normal mode for slice decoding */
770 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
771 /** \brief Driver supports base mode for slice decoding */
772 #define VA_DEC_SLICE_MODE_BASE 0x00000002
774 /** @name Attribute values for VAConfigAttribDecJPEG */
776 typedef union _VAConfigAttribValDecJPEG {
778 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
779 uint32_t rotation : 4;
780 /** \brief Reserved for future use. */
781 uint32_t reserved : 28;
784 uint32_t va_reserved[VA_PADDING_LOW];
785 } VAConfigAttribValDecJPEG;
786 /** @name Attribute values for VAConfigAttribDecProcessing */
788 /** \brief No decoding + processing in a single decoding call. */
789 #define VA_DEC_PROCESSING_NONE 0x00000000
790 /** \brief Decode + processing in a single decoding call. */
791 #define VA_DEC_PROCESSING 0x00000001
794 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
796 /** \brief Driver does not support any packed headers mode. */
797 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
799 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
801 * Application must provide it to driver once this flag is returned through
802 * vaGetConfigAttributes()
804 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
806 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
808 * Application must provide it to driver once this falg is returned through
809 * vaGetConfigAttributes()
811 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
813 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
815 * Application must provide it to driver once this flag is returned through
816 * vaGetConfigAttributes()
818 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
820 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
823 * This is a deprecated packed header flag, All applications can use
824 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
825 * header data buffer to the driver
827 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
828 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
829 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
832 /** @name Attribute values for VAConfigAttribEncInterlaced */
834 /** \brief Driver does not support interlaced coding. */
835 #define VA_ENC_INTERLACED_NONE 0x00000000
836 /** \brief Driver supports interlaced frame coding. */
837 #define VA_ENC_INTERLACED_FRAME 0x00000001
838 /** \brief Driver supports interlaced field coding. */
839 #define VA_ENC_INTERLACED_FIELD 0x00000002
840 /** \brief Driver supports macroblock adaptive frame field coding. */
841 #define VA_ENC_INTERLACED_MBAFF 0x00000004
842 /** \brief Driver supports picture adaptive frame field coding. */
843 #define VA_ENC_INTERLACED_PAFF 0x00000008
846 /** @name Attribute values for VAConfigAttribEncSliceStructure */
848 /** \brief Driver supports a power-of-two number of rows per slice. */
849 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
850 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
851 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
852 /** \brief Dirver support 1 rows per slice */
853 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
854 /** \brief Dirver support max encoded slice size per slice */
855 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
856 /** \brief Driver supports an arbitrary number of rows per slice. */
857 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
860 /** \brief Attribute value for VAConfigAttribEncJPEG */
861 typedef union _VAConfigAttribValEncJPEG {
863 /** \brief set to 1 for arithmatic coding. */
864 uint32_t arithmatic_coding_mode : 1;
865 /** \brief set to 1 for progressive dct. */
866 uint32_t progressive_dct_mode : 1;
867 /** \brief set to 1 for non-interleaved. */
868 uint32_t non_interleaved_mode : 1;
869 /** \brief set to 1 for differential. */
870 uint32_t differential_mode : 1;
871 uint32_t max_num_components : 3;
872 uint32_t max_num_scans : 4;
873 uint32_t max_num_huffman_tables : 3;
874 uint32_t max_num_quantization_tables : 3;
877 } VAConfigAttribValEncJPEG;
879 /** @name Attribute values for VAConfigAttribEncQuantization */
881 /** \brief Driver does not support special types of quantization */
882 #define VA_ENC_QUANTIZATION_NONE 0x00000000
883 /** \brief Driver supports trellis quantization */
884 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
887 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
889 /** \brief Driver does not support intra refresh */
890 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
891 /** \brief Driver supports column based rolling intra refresh */
892 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
893 /** \brief Driver supports row based rolling intra refresh */
894 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
895 /** \brief Driver supports adaptive intra refresh */
896 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
897 /** \brief Driver supports cyclic intra refresh */
898 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
899 /** \brief Driver supports intra refresh of P frame*/
900 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
901 /** \brief Driver supports intra refresh of B frame */
902 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
903 /** \brief Driver supports intra refresh of multiple reference encoder */
904 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
908 /** \brief Attribute value for VAConfigAttribEncROI */
909 typedef union _VAConfigAttribValEncROI {
911 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
912 uint32_t num_roi_regions : 8;
914 * \brief A flag indicates whether ROI priority is supported
916 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
917 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
918 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
919 * the underlying driver doesn't support ROI priority.
921 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
922 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
924 uint32_t roi_rc_priority_support : 1;
926 * \brief A flag indicates whether ROI delta QP is supported
928 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
929 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
930 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
931 * the underlying driver doesn't support ROI delta QP.
933 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
934 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
936 uint32_t roi_rc_qp_delta_support : 1;
937 uint32_t reserved : 22;
940 } VAConfigAttribValEncROI;
942 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
943 typedef union _VAConfigAttribValEncRateControlExt {
946 * \brief The maximum number of temporal layers minus 1
948 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
949 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
950 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
952 uint32_t max_num_temporal_layers_minus1 : 8;
955 * /brief support temporal layer bit-rate control flag
957 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
958 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
959 * #VAConfigAttribRateControl == #VA_RC_VBR).
961 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
962 * \c max_num_temporal_layers_minus1 is equal to 0
964 * To use bit-rate control per temporal layer, an application must send the right layer
965 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
966 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
967 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
968 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
969 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
970 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
971 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
973 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
974 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
975 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
977 uint32_t temporal_layer_bitrate_control_flag : 1;
978 uint32_t reserved : 23;
981 } VAConfigAttribValEncRateControlExt;
983 /** @name Attribute values for VAConfigAttribProcessingRate. */
985 /** \brief Driver does not support processing rate report */
986 #define VA_PROCESSING_RATE_NONE 0x00000000
987 /** \brief Driver supports encode processing rate report */
988 #define VA_PROCESSING_RATE_ENCODE 0x00000001
989 /** \brief Driver supports decode processing rate report */
990 #define VA_PROCESSING_RATE_DECODE 0x00000002
993 * if an attribute is not applicable for a given
994 * profile/entrypoint pair, then set the value to the following
996 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
998 /** Get maximum number of profiles supported by the implementation */
999 int vaMaxNumProfiles (
1003 /** Get maximum number of entrypoints supported by the implementation */
1004 int vaMaxNumEntrypoints (
1008 /** Get maximum number of attributs supported by the implementation */
1009 int vaMaxNumConfigAttributes (
1014 * Query supported profiles
1015 * The caller must provide a "profile_list" array that can hold at
1016 * least vaMaxNumProfile() entries. The actual number of profiles
1017 * returned in "profile_list" is returned in "num_profile".
1019 VAStatus vaQueryConfigProfiles (
1021 VAProfile *profile_list, /* out */
1022 int *num_profiles /* out */
1026 * Query supported entrypoints for a given profile
1027 * The caller must provide an "entrypoint_list" array that can hold at
1028 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
1029 * returned in "entrypoint_list" is returned in "num_entrypoints".
1031 VAStatus vaQueryConfigEntrypoints (
1034 VAEntrypoint *entrypoint_list, /* out */
1035 int *num_entrypoints /* out */
1039 * Get attributes for a given profile/entrypoint pair
1040 * The caller must provide an "attrib_list" with all attributes to be
1041 * retrieved. Upon return, the attributes in "attrib_list" have been
1042 * updated with their value. Unknown attributes or attributes that are
1043 * not supported for the given profile/entrypoint pair will have their
1044 * value set to VA_ATTRIB_NOT_SUPPORTED
1046 VAStatus vaGetConfigAttributes (
1049 VAEntrypoint entrypoint,
1050 VAConfigAttrib *attrib_list, /* in/out */
1054 /** Generic ID type, can be re-typed for specific implementation */
1055 typedef unsigned int VAGenericID;
1057 typedef VAGenericID VAConfigID;
1060 * Create a configuration for the video decode/encode/processing pipeline
1061 * it passes in the attribute list that specifies the attributes it cares
1062 * about, with the rest taking default values.
1064 VAStatus vaCreateConfig (
1067 VAEntrypoint entrypoint,
1068 VAConfigAttrib *attrib_list,
1070 VAConfigID *config_id /* out */
1074 * Free resources associdated with a given config
1076 VAStatus vaDestroyConfig (
1078 VAConfigID config_id
1082 * Query all attributes for a given configuration
1083 * The profile of the configuration is returned in "profile"
1084 * The entrypoint of the configuration is returned in "entrypoint"
1085 * The caller must provide an "attrib_list" array that can hold at least
1086 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1087 * returned in "attrib_list" is returned in "num_attribs"
1089 VAStatus vaQueryConfigAttributes (
1091 VAConfigID config_id,
1092 VAProfile *profile, /* out */
1093 VAEntrypoint *entrypoint, /* out */
1094 VAConfigAttrib *attrib_list,/* out */
1095 int *num_attribs /* out */
1100 * Contexts and Surfaces
1102 * Context represents a "virtual" video decode, encode or video processing
1103 * pipeline. Surfaces are render targets for a given context. The data in the
1104 * surfaces are not accessible to the client except if derived image is supported
1105 * and the internal data format of the surface is implementation specific.
1107 * Surfaces are provided as a hint of what surfaces will be used when the context
1108 * is created through vaCreateContext(). A surface may be used by different contexts
1109 * at the same time as soon as application can make sure the operations are synchronized
1110 * between different contexts, e.g. a surface is used as the output of a decode context
1111 * and the input of a video process context. Surfaces can only be destroyed after all
1112 * contexts using these surfaces have been destroyed.
1114 * Both contexts and surfaces are identified by unique IDs and its
1115 * implementation specific internals are kept opaque to the clients
1118 typedef VAGenericID VAContextID;
1120 typedef VAGenericID VASurfaceID;
1122 #define VA_INVALID_ID 0xffffffff
1123 #define VA_INVALID_SURFACE VA_INVALID_ID
1125 /** \brief Generic value types. */
1127 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1128 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1129 VAGenericValueTypePointer, /**< Generic pointer type */
1130 VAGenericValueTypeFunc /**< Pointer to function */
1131 } VAGenericValueType;
1133 /** \brief Generic function type. */
1134 typedef void (*VAGenericFunc)(void);
1136 /** \brief Generic value. */
1137 typedef struct _VAGenericValue {
1138 /** \brief Value type. See #VAGenericValueType. */
1139 VAGenericValueType type;
1140 /** \brief Value holder. */
1142 /** \brief 32-bit signed integer. */
1144 /** \brief 32-bit float. */
1146 /** \brief Generic pointer. */
1148 /** \brief Pointer to function. */
1153 /** @name Surface attribute flags */
1155 /** \brief Surface attribute is not supported. */
1156 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1157 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1158 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1159 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1160 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1163 /** \brief Surface attribute types. */
1165 VASurfaceAttribNone = 0,
1167 * \brief Pixel format (fourcc).
1169 * The value is meaningful as input to vaQuerySurfaceAttributes().
1170 * If zero, the driver returns the optimal pixel format for the
1171 * specified config. Otherwise, if non-zero, the value represents
1172 * a pixel format (FOURCC) that is kept as is on output, if the
1173 * driver supports it. Otherwise, the driver sets the value to
1174 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1176 VASurfaceAttribPixelFormat,
1177 /** \brief Minimal width in pixels (int, read-only). */
1178 VASurfaceAttribMinWidth,
1179 /** \brief Maximal width in pixels (int, read-only). */
1180 VASurfaceAttribMaxWidth,
1181 /** \brief Minimal height in pixels (int, read-only). */
1182 VASurfaceAttribMinHeight,
1183 /** \brief Maximal height in pixels (int, read-only). */
1184 VASurfaceAttribMaxHeight,
1185 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1186 VASurfaceAttribMemoryType,
1187 /** \brief External buffer descriptor (pointer, write). */
1188 VASurfaceAttribExternalBufferDescriptor,
1189 /** \brief Surface usage hint, gives the driver a hint of intended usage
1190 * to optimize allocation (e.g. tiling) (int, read/write). */
1191 VASurfaceAttribUsageHint,
1192 /** \brief Number of surface attributes. */
1193 VASurfaceAttribCount
1194 } VASurfaceAttribType;
1196 /** \brief Surface attribute. */
1197 typedef struct _VASurfaceAttrib {
1199 VASurfaceAttribType type;
1200 /** \brief Flags. See "Surface attribute flags". */
1202 /** \brief Value. See "Surface attribute types" for the expected types. */
1203 VAGenericValue value;
1207 * @name VASurfaceAttribMemoryType values in bit fields.
1208 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1209 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1210 * types are defined in DRM and Android header files.
1213 /** \brief VA memory type (default) is supported. */
1214 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1215 /** \brief V4L2 buffer memory type is supported. */
1216 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1217 /** \brief User pointer memory type is supported. */
1218 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1222 * \brief VASurfaceAttribExternalBuffers structure for
1223 * the VASurfaceAttribExternalBufferDescriptor attribute.
1225 typedef struct _VASurfaceAttribExternalBuffers {
1226 /** \brief pixel format in fourcc. */
1227 uint32_t pixel_format;
1228 /** \brief width in pixels. */
1230 /** \brief height in pixels. */
1232 /** \brief total size of the buffer in bytes. */
1234 /** \brief number of planes for planar layout */
1235 uint32_t num_planes;
1236 /** \brief pitch for each plane in bytes */
1237 uint32_t pitches[4];
1238 /** \brief offset for each plane in bytes */
1239 uint32_t offsets[4];
1240 /** \brief buffer handles or user pointers */
1242 /** \brief number of elements in the "buffers" array */
1243 uint32_t num_buffers;
1244 /** \brief flags. See "Surface external buffer descriptor flags". */
1246 /** \brief reserved for passing private data */
1248 } VASurfaceAttribExternalBuffers;
1250 /** @name VASurfaceAttribExternalBuffers flags */
1252 /** \brief Enable memory tiling */
1253 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1254 /** \brief Memory is cacheable */
1255 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1256 /** \brief Memory is non-cacheable */
1257 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1258 /** \brief Memory is write-combined */
1259 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1260 /** \brief Memory is protected */
1261 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1263 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1265 /** \brief Surface usage not indicated. */
1266 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1267 /** \brief Surface used by video decoder. */
1268 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1269 /** \brief Surface used by video encoder. */
1270 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1271 /** \brief Surface read by video post-processing. */
1272 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1273 /** \brief Surface written by video post-processing. */
1274 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1275 /** \brief Surface used for display. */
1276 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1281 * \brief Queries surface attributes for the supplied config.
1283 * This function queries for all supported attributes for the
1284 * supplied VA @config. In particular, if the underlying hardware
1285 * supports the creation of VA surfaces in various formats, then
1286 * this function will enumerate all pixel formats that are supported.
1288 * The \c attrib_list array is allocated by the user and \c
1289 * num_attribs shall be initialized to the number of allocated
1290 * elements in that array. Upon successful return, the actual number
1291 * of attributes will be overwritten into \c num_attribs. Otherwise,
1292 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1293 * is adjusted to the number of elements that would be returned if
1294 * enough space was available.
1296 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1297 * argument when vaQuerySurfaceAttributes() is used to determine the
1298 * actual number of elements that need to be allocated.
1300 * @param[in] dpy the VA display
1301 * @param[in] config the config identifying a codec or a video
1302 * processing pipeline
1303 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1304 * @param[in,out] num_attribs the number of elements allocated on
1305 * input, the number of elements actually filled in output
1308 vaQuerySurfaceAttributes(
1311 VASurfaceAttrib *attrib_list,
1312 unsigned int *num_attribs
1316 * \brief Creates an array of surfaces
1318 * Creates an array of surfaces. The optional list of attributes shall
1319 * be constructed based on what the underlying hardware could expose
1320 * through vaQuerySurfaceAttributes().
1322 * @param[in] dpy the VA display
1323 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1324 * @param[in] width the surface width
1325 * @param[in] height the surface height
1326 * @param[out] surfaces the array of newly created surfaces
1327 * @param[in] num_surfaces the number of surfaces to create
1328 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1329 * @param[in] num_attribs the number of attributes supplied in
1330 * \c attrib_list, or zero
1335 unsigned int format,
1337 unsigned int height,
1338 VASurfaceID *surfaces,
1339 unsigned int num_surfaces,
1340 VASurfaceAttrib *attrib_list,
1341 unsigned int num_attribs
1345 * vaDestroySurfaces - Destroy resources associated with surfaces.
1346 * Surfaces can only be destroyed after all contexts using these surfaces have been
1349 * surfaces: array of surfaces to destroy
1350 * num_surfaces: number of surfaces in the array to be destroyed.
1352 VAStatus vaDestroySurfaces (
1354 VASurfaceID *surfaces,
1358 #define VA_PROGRESSIVE 0x1
1360 * vaCreateContext - Create a context
1362 * config_id: configuration for the context
1363 * picture_width: coded picture width
1364 * picture_height: coded picture height
1365 * flag: any combination of the following:
1366 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1367 * render_targets: a hint for render targets (surfaces) tied to the context
1368 * num_render_targets: number of render targets in the above array
1369 * context: created context id upon return
1371 VAStatus vaCreateContext (
1373 VAConfigID config_id,
1377 VASurfaceID *render_targets,
1378 int num_render_targets,
1379 VAContextID *context /* out */
1383 * vaDestroyContext - Destroy a context
1385 * context: context to be destroyed
1387 VAStatus vaDestroyContext (
1392 //Multi-frame context
1393 typedef VAGenericID VAMFContextID;
1395 * vaCreateMFContext - Create a multi-frame context
1396 * interface encapsulating common for all streams memory objects and structures
1397 * required for single GPU task submission from several VAContextID's.
1398 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1399 * Support identification: Application can identify multi-frame feature support by ability
1400 * to create multi-frame context. If driver supports multi-frame - call successful,
1401 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1402 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1404 * VA_STATUS_SUCCESS - operation successful.
1405 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1406 * dpy: display adapter.
1407 * mf_context: Multi-Frame context encapsulating all associated context
1408 * for multi-frame submission.
1410 VAStatus vaCreateMFContext (
1412 VAMFContextID *mf_context /* out */
1416 * vaMFAddContext - Provide ability to associate each context used for
1417 * Multi-Frame submission and common Multi-Frame context.
1418 * Try to add context to understand if it is supported.
1419 * Allocation: this call allocates and/or reallocates all memory objects
1420 * common for all contexts associated with particular Multi-Frame context.
1421 * All memory required for each context(pixel buffers, internal driver
1422 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1423 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1424 * first context added will set entry point/profile for whole Multi-Frame context,
1425 * all other entry points and profiles can be rejected to be added.
1427 * VA_STATUS_SUCCESS - operation successful, context was added.
1428 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1429 * current mf_context and associated contexts and start working with new ones.
1430 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1431 * 1 - mf_context is not valid context or
1432 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1433 * and current context contradicts with previously added, application can continue with current mf_context
1434 * and other contexts passed this call, rejected context can continue work in stand-alone
1435 * mode or other mf_context.
1436 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1437 * unsupported VAEntrypoint. Application can continue with current mf_context
1438 * and other contexts passed this call, rejected context can continue work in stand-alone
1440 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1441 * but VAProfile is not supported. Application can continue with current mf_context
1442 * and other contexts passed this call, rejected context can continue work in stand-alone
1444 * dpy: display adapter.
1445 * context: context being associated with Multi-Frame context.
1446 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1448 VAStatus vaMFAddContext (
1450 VAMFContextID mf_context,
1455 * vaMFReleaseContext - Removes context from multi-frame and
1456 * association with multi-frame context.
1457 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1459 * VA_STATUS_SUCCESS - operation successful, context was removed.
1460 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1461 * application need to destroy this VAMFContextID and all assotiated VAContextID
1463 * mf_context: VAMFContextID where context is added
1464 * context: VAContextID to be added
1466 VAStatus vaMFReleaseContext (
1468 VAMFContextID mf_context,
1474 * Buffers are used to pass various types of data from the
1475 * client to the server. The server maintains a data store
1476 * for each buffer created, and the client idenfies a buffer
1477 * through a unique buffer id assigned by the server.
1480 typedef VAGenericID VABufferID;
1484 VAPictureParameterBufferType = 0,
1485 VAIQMatrixBufferType = 1,
1486 VABitPlaneBufferType = 2,
1487 VASliceGroupMapBufferType = 3,
1488 VASliceParameterBufferType = 4,
1489 VASliceDataBufferType = 5,
1490 VAMacroblockParameterBufferType = 6,
1491 VAResidualDataBufferType = 7,
1492 VADeblockingParameterBufferType = 8,
1493 VAImageBufferType = 9,
1494 VAProtectedSliceDataBufferType = 10,
1495 VAQMatrixBufferType = 11,
1496 VAHuffmanTableBufferType = 12,
1497 VAProbabilityBufferType = 13,
1499 /* Following are encode buffer types */
1500 VAEncCodedBufferType = 21,
1501 VAEncSequenceParameterBufferType = 22,
1502 VAEncPictureParameterBufferType = 23,
1503 VAEncSliceParameterBufferType = 24,
1504 VAEncPackedHeaderParameterBufferType = 25,
1505 VAEncPackedHeaderDataBufferType = 26,
1506 VAEncMiscParameterBufferType = 27,
1507 VAEncMacroblockParameterBufferType = 28,
1508 VAEncMacroblockMapBufferType = 29,
1511 * \brief Encoding QP buffer
1513 * This buffer contains QP per MB for encoding. Currently
1514 * VAEncQPBufferH264 is defined for H.264 encoding, see
1515 * #VAEncQPBufferH264 for details
1517 VAEncQPBufferType = 30,
1518 /* Following are video processing buffer types */
1520 * \brief Video processing pipeline parameter buffer.
1522 * This buffer describes the video processing pipeline. See
1523 * #VAProcPipelineParameterBuffer for details.
1525 VAProcPipelineParameterBufferType = 41,
1527 * \brief Video filter parameter buffer.
1529 * This buffer describes the video filter parameters. All buffers
1530 * inherit from #VAProcFilterParameterBufferBase, thus including
1531 * a unique filter buffer type.
1533 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1534 * Filters requiring advanced parameters include, but are not limited to,
1535 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1536 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1538 VAProcFilterParameterBufferType = 42,
1540 * \brief FEI specific buffer types
1542 VAEncFEIMVBufferType = 43,
1543 VAEncFEIMBCodeBufferType = 44,
1544 VAEncFEIDistortionBufferType = 45,
1545 VAEncFEIMBControlBufferType = 46,
1546 VAEncFEIMVPredictorBufferType = 47,
1547 /** Force MB's to be non skip for encode.it's per-mb control buffer, The width of the MB map
1548 * Surface is (width of the Picture in MB unit) * 1 byte, multiple of 64 bytes.
1549 * The height is (height of the picture in MB unit). The picture is either
1550 * frame or non-interleaved top or bottom field. If the application provides this
1551 *surface, it will override the "skipCheckDisable" setting in VAEncMiscParameterEncQuality.
1553 VAEncMacroblockDisableSkipMapBufferType = 53,
1558 * Processing rate parameter for encode.
1560 typedef struct _VAProcessingRateParameterEnc {
1561 /** \brief Profile level */
1563 uint8_t reserved[3];
1564 /** \brief quality level. When set to 0, default quality
1567 uint32_t quality_level;
1568 /** \brief Period between I frames. */
1569 uint32_t intra_period;
1570 /** \brief Period between I/P frames. */
1572 } VAProcessingRateParameterEnc;
1575 * Processing rate parameter for decode.
1577 typedef struct _VAProcessingRateParameterDec {
1578 /** \brief Profile level */
1580 uint8_t reserved0[3];
1582 } VAProcessingRateParameterDec;
1584 typedef struct _VAProcessingRateParameter {
1586 VAProcessingRateParameterEnc proc_buf_enc;
1587 VAProcessingRateParameterDec proc_buf_dec;
1589 } VAProcessingRateParameter;
1592 * \brief Queries processing rate for the supplied config.
1594 * This function queries the processing rate based on parameters in
1595 * \c proc_buf for the given \c config. Upon successful return, the processing
1596 * rate value will be stored in \c processing_rate. Processing rate is
1597 * specified as the number of macroblocks/CTU per second.
1599 * If NULL is passed to the \c proc_buf, the default processing rate for the
1600 * given configuration will be returned.
1602 * @param[in] dpy the VA display
1603 * @param[in] config the config identifying a codec or a video
1604 * processing pipeline
1605 * @param[in] proc_buf the buffer that contains the parameters for
1606 either the encode or decode processing rate
1607 * @param[out] processing_rate processing rate in number of macroblocks per
1608 second constrained by parameters specified in proc_buf
1612 vaQueryProcessingRate(
1615 VAProcessingRateParameter *proc_buf,
1616 unsigned int *processing_rate
1621 VAEncMiscParameterTypeFrameRate = 0,
1622 VAEncMiscParameterTypeRateControl = 1,
1623 VAEncMiscParameterTypeMaxSliceSize = 2,
1624 VAEncMiscParameterTypeAIR = 3,
1625 /** \brief Buffer type used to express a maximum frame size (in bits). */
1626 VAEncMiscParameterTypeMaxFrameSize = 4,
1627 /** \brief Buffer type used for HRD parameters. */
1628 VAEncMiscParameterTypeHRD = 5,
1629 VAEncMiscParameterTypeQualityLevel = 6,
1630 /** \brief Buffer type used for Rolling intra refresh */
1631 VAEncMiscParameterTypeRIR = 7,
1632 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1633 VAEncMiscParameterTypeQuantization = 8,
1634 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1635 * rate control, when the user has externally skipped frames. */
1636 VAEncMiscParameterTypeSkipFrame = 9,
1637 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1638 VAEncMiscParameterTypeROI = 10,
1639 /** \brief Buffer type used for temporal layer structure */
1640 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1641 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1642 VAEncMiscParameterTypeDirtyRect = 13,
1643 /** \brief Buffer type used for parallel BRC parameters. */
1644 VAEncMiscParameterTypeParallelBRC = 14,
1645 /** \brief Set MB partion mode mask and Half-pel/Quant-pel motion search */
1646 VAEncMiscParameterTypeSubMbPartPel = 15,
1647 /** \brief set encode quality tuning */
1648 VAEncMiscParameterTypeEncQuality = 16,
1649 /** \brief Buffer type used for encoder rounding offset parameters. */
1650 VAEncMiscParameterTypeCustomRoundingControl = 17,
1651 /** \brief Buffer type used for FEI input frame level parameters */
1652 VAEncMiscParameterTypeFEIFrameControl = 18,
1653 /** \brief encode extension buffer, ect. MPEG2 Sequence extenstion data */
1654 VAEncMiscParameterTypeExtensionData = 19
1655 } VAEncMiscParameterType;
1657 /** \brief Packed header type. */
1659 /** \brief Packed sequence header. */
1660 VAEncPackedHeaderSequence = 1,
1661 /** \brief Packed picture header. */
1662 VAEncPackedHeaderPicture = 2,
1663 /** \brief Packed slice header. */
1664 VAEncPackedHeaderSlice = 3,
1666 * \brief Packed raw header.
1668 * Packed raw data header can be used by the client to insert a header
1669 * into the bitstream data buffer at the point it is passed, the driver
1670 * will handle the raw packed header based on "has_emulation_bytes" field
1671 * in the packed header parameter structure.
1673 VAEncPackedHeaderRawData = 4,
1675 * \brief Misc packed header. See codec-specific definitions.
1678 * This is a deprecated packed header type. All applications can use
1679 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1681 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1682 } VAEncPackedHeaderType;
1684 /** \brief Packed header parameter. */
1685 typedef struct _VAEncPackedHeaderParameterBuffer {
1686 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1688 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1689 uint32_t bit_length;
1690 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1691 uint8_t has_emulation_bytes;
1693 /** \brief Reserved bytes for future use, must be zero */
1694 uint32_t va_reserved[VA_PADDING_LOW];
1695 } VAEncPackedHeaderParameterBuffer;
1698 * For application, e.g. set a new bitrate
1699 * VABufferID buf_id;
1700 * VAEncMiscParameterBuffer *misc_param;
1701 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1703 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1704 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1705 * 1, NULL, &buf_id);
1707 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1708 * misc_param->type = VAEncMiscParameterTypeRateControl;
1709 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1710 * misc_rate_ctrl->bits_per_second = 6400000;
1711 * vaUnmapBuffer(dpy, buf_id);
1712 * vaRenderPicture(dpy, context, &buf_id, 1);
1714 typedef struct _VAEncMiscParameterBuffer
1716 VAEncMiscParameterType type;
1718 } VAEncMiscParameterBuffer;
1720 /** \brief Temporal layer Structure*/
1721 typedef struct _VAEncMiscParameterTemporalLayerStructure
1723 /** \brief The number of temporal layers */
1724 uint32_t number_of_layers;
1725 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1726 uint32_t periodicity;
1728 * \brief The array indicating the layer id for each frame
1730 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1731 * ids for frames starting from the 2nd frame.
1733 uint32_t layer_id[32];
1735 /** \brief Reserved bytes for future use, must be zero */
1736 uint32_t va_reserved[VA_PADDING_LOW];
1737 } VAEncMiscParameterTemporalLayerStructure;
1740 /** \brief Rate control parameters */
1741 typedef struct _VAEncMiscParameterRateControl
1743 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1744 uint32_t bits_per_second;
1745 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1746 * bit-rate for example if target_percentage is 95 then the rate control will target
1747 * a bit-rate that is 95% of the maximum bit-rate
1749 uint32_t target_percentage;
1750 /* windows size in milliseconds. For example if this is set to 500,
1751 * then the rate control will guarantee the target bit-rate over a 500 ms window
1753 uint32_t window_size;
1754 /* initial QP at I frames */
1755 uint32_t initial_qp;
1757 uint32_t basic_unit_size;
1763 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1764 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1765 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1767 * The temporal layer that the rate control parameters are specified for.
1769 uint32_t temporal_id : 8;
1770 uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1771 uint32_t enable_parallel_brc : 1;
1772 uint32_t enable_dynamic_scaling : 1;
1773 /** \brief Frame Tolerance Mode
1774 * Indicates the tolerance the application has to variations in the frame size.
1775 * For example, wireless display scenarios may require very steady bit rate to
1776 * reduce buffering time. It affects the rate control algorithm used,
1777 * but may or may not have an effect based on the combination of other BRC
1778 * parameters. Only valid when the driver reports support for
1779 * #VAConfigAttribFrameSizeToleranceSupport.
1781 * equals 0 -- normal mode;
1782 * equals 1 -- maps to sliding window;
1783 * equals 2 -- maps to low delay mode;
1786 uint32_t frame_tolerance_mode : 2;
1787 uint32_t reserved : 12;
1791 uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1792 /** \brief Reserved bytes for future use, must be zero */
1794 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1795 } VAEncMiscParameterRateControl;
1797 typedef struct _VAEncMiscParameterFrameRate
1800 * The framerate is specified as a number of frames per second, as a
1801 * fraction. The denominator of the fraction is given in the top half
1802 * (the high two bytes) of the framerate field, and the numerator is
1803 * given in the bottom half (the low two bytes).
1806 * denominator = framerate >> 16 & 0xffff;
1807 * numerator = framerate & 0xffff;
1808 * fps = numerator / denominator;
1810 * For example, if framerate is set to (100 << 16 | 750), this is
1811 * 750 / 100, hence 7.5fps.
1813 * If the denominator is zero (the high two bytes are both zero) then
1814 * it takes the value one instead, so the framerate is just the integer
1815 * in the low 2 bytes.
1823 * The temporal id the framerate parameters are specified for.
1825 uint32_t temporal_id : 8;
1826 uint32_t reserved : 24;
1831 /** \brief Reserved bytes for future use, must be zero */
1832 uint32_t va_reserved[VA_PADDING_LOW];
1833 } VAEncMiscParameterFrameRate;
1836 * Allow a maximum slice size to be specified (in bits).
1837 * The encoder will attempt to make sure that individual slices do not exceed this size
1838 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1840 typedef struct _VAEncMiscParameterMaxSliceSize
1842 uint32_t max_slice_size;
1844 /** \brief Reserved bytes for future use, must be zero */
1845 uint32_t va_reserved[VA_PADDING_LOW];
1846 } VAEncMiscParameterMaxSliceSize;
1848 typedef struct _VAEncMiscParameterAIR
1850 uint32_t air_num_mbs;
1851 uint32_t air_threshold;
1852 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1854 /** \brief Reserved bytes for future use, must be zero */
1855 uint32_t va_reserved[VA_PADDING_LOW];
1856 } VAEncMiscParameterAIR;
1859 * \brief Rolling intra refresh data structure for encoding.
1861 typedef struct _VAEncMiscParameterRIR
1867 * \brief Indicate if intra refresh is enabled in column/row.
1869 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1870 * by the driver before sending this structure.
1873 /* \brief enable RIR in column */
1874 uint32_t enable_rir_column : 1;
1875 /* \brief enable RIR in row */
1876 uint32_t enable_rir_row : 1;
1877 uint32_t reserved : 30;
1882 * \brief Indicates the column or row location in MB. It is ignored if
1885 uint16_t intra_insertion_location;
1887 * \brief Indicates the number of columns or rows in MB. It is ignored if
1890 uint16_t intra_insert_size;
1892 * \brief indicates the Qp difference for inserted intra columns or rows.
1893 * App can use this to adjust intra Qp based on bitrate & max frame size.
1895 uint8_t qp_delta_for_inserted_intra;
1896 /** \brief Reserved bytes for future use, must be zero */
1897 uint32_t va_reserved[VA_PADDING_LOW];
1898 } VAEncMiscParameterRIR;
1900 typedef struct _VAEncMiscParameterHRD
1902 uint32_t initial_buffer_fullness; /* in bits */
1903 uint32_t buffer_size; /* in bits */
1905 /** \brief Reserved bytes for future use, must be zero */
1906 uint32_t va_reserved[VA_PADDING_LOW];
1907 } VAEncMiscParameterHRD;
1910 * \brief Defines a maximum frame size (in bits).
1912 * This misc parameter buffer defines the maximum size of a frame (in
1913 * bits). The encoder will try to make sure that each frame does not
1914 * exceed this size. Otherwise, if the frame size exceeds this size,
1915 * the \c status flag of #VACodedBufferSegment will contain
1916 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1918 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1919 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1920 VAEncMiscParameterType type;
1921 /** \brief Maximum size of a frame (in bits). */
1922 uint32_t max_frame_size;
1924 /** \brief Reserved bytes for future use, must be zero */
1925 uint32_t va_reserved[VA_PADDING_LOW];
1926 } VAEncMiscParameterBufferMaxFrameSize;
1929 * \brief Encoding quality level.
1931 * The encoding quality could be set through this structure, if the implementation
1932 * supports multiple quality levels. The quality level set through this structure is
1933 * persistent over the entire coded sequence, or until a new structure is being sent.
1934 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1935 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1936 * quality. The quality level setting is used as a trade-off between quality and speed/power
1937 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1939 typedef struct _VAEncMiscParameterBufferQualityLevel {
1940 /** \brief Encoding quality level setting. When set to 0, default quality
1943 uint32_t quality_level;
1945 /** \brief Reserved bytes for future use, must be zero */
1946 uint32_t va_reserved[VA_PADDING_LOW];
1947 } VAEncMiscParameterBufferQualityLevel;
1950 * \brief Quantization settings for encoding.
1952 * Some encoders support special types of quantization such as trellis, and this structure
1953 * can be used by the app to control these special types of quantization by the encoder.
1955 typedef struct _VAEncMiscParameterQuantization
1959 /* if no flags is set then quantization is determined by the driver */
1962 /* \brief disable trellis for all frames/fields */
1963 uint64_t disable_trellis : 1;
1964 /* \brief enable trellis for I frames/fields */
1965 uint64_t enable_trellis_I : 1;
1966 /* \brief enable trellis for P frames/fields */
1967 uint64_t enable_trellis_P : 1;
1968 /* \brief enable trellis for B frames/fields */
1969 uint64_t enable_trellis_B : 1;
1970 uint64_t reserved : 28;
1973 } quantization_flags;
1974 } VAEncMiscParameterQuantization;
1977 * \brief Encoding skip frame.
1979 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1980 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1981 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1982 * current frame. It is allowed for the application to still send in packed headers for the driver to
1983 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1985 typedef struct _VAEncMiscParameterSkipFrame {
1986 /** \brief Indicates skip frames as below.
1987 * 0: Encode as normal, no skip.
1988 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1989 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1990 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1991 * in VAEncPackedHeaderPicture). */
1992 uint8_t skip_frame_flag;
1993 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1994 uint8_t num_skip_frames;
1995 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1996 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1997 uint32_t size_skip_frames;
1999 /** \brief Reserved bytes for future use, must be zero */
2000 uint32_t va_reserved[VA_PADDING_LOW];
2001 } VAEncMiscParameterSkipFrame;
2004 * \brief Encoding region-of-interest (ROI).
2006 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
2007 * supports ROI input. The ROI set through this structure is applicable only to the
2008 * current frame or field, so must be sent every frame or field to be applied. The number of
2009 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
2010 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
2012 typedef struct _VAEncROI
2014 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
2015 * codec coding units. It is relative to frame coordinates for the frame case and
2016 * to field coordinates for the field case. */
2017 VARectangle roi_rectangle;
2021 * \ref roi_value specifies ROI delta QP or ROI priority.
2022 * -- ROI delta QP is the value that will be added on top of the frame level QP.
2023 * -- ROI priority specifies the priority of a region, it can be positive (more important)
2024 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2025 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2026 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2027 * regions, the roi_value that is first in the ROI array will have priority.
2029 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2030 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2032 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2033 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2034 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2039 typedef struct _VAEncMiscParameterBufferROI {
2040 /** \brief Number of ROIs being sent.*/
2043 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2044 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
2046 int8_t max_delta_qp;
2047 int8_t min_delta_qp;
2049 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
2050 * coordinates for the frame case and to field coordinates for the field case.*/
2055 * \brief An indication for roi value.
2057 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2058 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2059 * in #VAEncROI should be used as ROI priority.
2061 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2062 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2063 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2064 * when VAConfigAttribRateControl == VA_RC_CQP.
2066 uint32_t roi_value_is_qp_delta : 1;
2067 uint32_t reserved : 31;
2072 /** \brief Reserved bytes for future use, must be zero */
2073 uint32_t va_reserved[VA_PADDING_LOW];
2074 } VAEncMiscParameterBufferROI;
2076 * \brief Dirty rectangle data structure for encoding.
2078 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2079 * implementation supports dirty rect input. The rect set through this structure is applicable
2080 * only to the current frame or field, so must be sent every frame or field to be applied.
2081 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
2082 * encoder will use the rect information to know those rectangle areas have changed while the
2083 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2084 * previous picture. The encoder may do some internal optimizations.
2086 typedef struct _VAEncMiscParameterBufferDirtyRect
2088 /** \brief Number of Rectangle being sent.*/
2089 uint32_t num_roi_rectangle;
2091 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2092 VARectangle *roi_rectangle;
2093 } VAEncMiscParameterBufferDirtyRect;
2095 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2096 typedef struct _VAEncMiscParameterParallelRateControl {
2097 /** brief Number of layers*/
2098 uint32_t num_layers;
2099 /** brief Number of B frames per layer per GOP.
2101 * it should be allocated by application, and the is num_layers.
2102 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2103 uint32_t *num_b_in_gop;
2104 } VAEncMiscParameterParallelRateControl;
2106 /** per frame encoder quality controls, once set they will persist for all future frames
2107 *till it is updated again. */
2108 typedef struct _VAEncMiscParameterEncQuality
2114 /** Use raw frames for reference instead of reconstructed frames.
2115 * it only impact motion estimation (ME) stage, and will not impact MC stage
2116 * so the reconstruct picture will can match with decode side */
2117 uint32_t useRawPicForRef : 1;
2118 /** Disables skip check for ME stage, it will increase the bistream size
2119 * but will improve the qulity */
2120 uint32_t skipCheckDisable : 1;
2121 /** Indicates app will override default driver FTQ settings using FTQEnable.
2122 * FTQ is forward transform quantization */
2123 uint32_t FTQOverride : 1;
2124 /** Enables/disables FTQ. */
2125 uint32_t FTQEnable : 1;
2126 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2127 * enabled (FTQSkipThresholdLUT), else default driver thresholds will be used. */
2128 uint32_t FTQSkipThresholdLUTInput : 1;
2129 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2130 * disabled (NonFTQSkipThresholdLUT), else default driver thresholds will be used. */
2131 uint32_t NonFTQSkipThresholdLUTInput : 1;
2132 uint32_t ReservedBit : 1;
2133 /** Control to enable the ME mode decision algorithm to bias to fewer B Direct/Skip types.
2134 * Applies only to B frames, all other frames will ignore this setting. */
2135 uint32_t directBiasAdjustmentEnable : 1;
2136 /** Enables global motion bias. global motion also is called HME (Heirarchical Motion Estimation )
2137 * HME is used to handle large motions and avoiding local minima in the video encoding process
2138 * down scaled the input and reference picture, then do ME. the result will be a predictor to next level HME or ME
2139 * current interface divide the HME to 3 level. UltraHME , SuperHME, and HME, result of UltraHME will be input of SurperHME,
2140 * result of superHME will be a input for HME. HME result will be input of ME. it is a switch for HMEMVCostScalingFactor
2141 * can change the HME bias inside RDO stage*/
2142 uint32_t globalMotionBiasAdjustmentEnable : 1;
2143 /** MV cost scaling ratio for HME ( predictors. It is used when
2144 * globalMotionBiasAdjustmentEnable == 1, else it is ignored. Values are:
2145 * 0: set MV cost to be 0 for HME predictor.
2146 * 1: scale MV cost to be 1/2 of the default value for HME predictor.
2147 * 2: scale MV cost to be 1/4 of the default value for HME predictor.
2148 * 3: scale MV cost to be 1/8 of the default value for HME predictor. */
2149 uint32_t HMEMVCostScalingFactor : 2;
2150 /**disable HME, if it is disabled. Super*ultraHME should also be disabled */
2151 uint32_t HMEDisable : 1;
2152 /**disable Super HME, if it is disabled, ultraHME should be disabled */
2153 uint32_t SuperHMEDisable : 1;
2154 /** disable Ultra HME */
2155 uint32_t UltraHMEDisable : 1;
2156 /** disable panic mode. Panic mode happened when there are extreme BRC (bit rate control) requirement
2157 * frame size cant achieve the target of BRC. when Panic mode is triggered, Coefficients will
2158 * be set to zero. disable panic mode will improve quality but will impact BRC */
2159 uint32_t PanicModeDisable : 1;
2160 /** Force RepartitionCheck
2161 * 0: DEFAULT - follow driver default settings.
2162 * 1: FORCE_ENABLE - enable this feature totally for all cases.
2163 * 2: FORCE_DISABLE - disable this feature totally for all cases. */
2164 uint32_t ForceRepartitionCheck : 2;
2167 uint32_t encControls;
2170 /** Maps QP to skip thresholds when FTQ is enabled. Valid range is 0-255. */
2171 uint8_t FTQSkipThresholdLUT[52];
2172 /** Maps QP to skip thresholds when FTQ is disabled. Valid range is 0-65535. */
2173 uint16_t NonFTQSkipThresholdLUT[52];
2175 uint32_t reserved[VA_PADDING_HIGH]; // Reserved for future use.
2177 } VAEncMiscParameterEncQuality;
2180 * \brief Custom Encoder Rounding Offset Control.
2181 * Application may use this structure to set customized rounding
2182 * offset parameters for quantization.
2183 * Valid when \c VAConfigAttribCustomRoundingControl equals 1.
2185 typedef struct _VAEncMiscParameterCustomRoundingControl
2189 /** \brief Enable customized rounding offset for intra blocks.
2190 * If 0, default value would be taken by driver for intra
2193 uint32_t enable_custom_rouding_intra : 1 ;
2195 /** \brief Intra rounding offset
2196 * Ignored if \c enable_custom_rouding_intra equals 0.
2198 uint32_t rounding_offset_intra : 7;
2200 /** \brief Enable customized rounding offset for inter blocks.
2201 * If 0, default value would be taken by driver for inter
2204 uint32_t enable_custom_rounding_inter : 1 ;
2206 /** \brief Inter rounding offset
2207 * Ignored if \c enable_custom_rouding_inter equals 0.
2209 uint32_t rounding_offset_inter : 7;
2212 uint32_t reserved :16;
2215 } rounding_offset_setting;
2216 } VAEncMiscParameterCustomRoundingControl;
2218 * There will be cases where the bitstream buffer will not have enough room to hold
2219 * the data for the entire slice, and the following flags will be used in the slice
2220 * parameter to signal to the server for the possible cases.
2221 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2222 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2223 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2225 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2226 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2227 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2228 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2230 /* Codec-independent Slice Parameter Buffer base */
2231 typedef struct _VASliceParameterBufferBase
2233 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2234 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2235 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2236 } VASliceParameterBufferBase;
2238 /**********************************
2239 * JPEG common data structures
2240 **********************************/
2242 * \brief Huffman table for JPEG decoding.
2244 * This structure holds the complete Huffman tables. This is an
2245 * aggregation of all Huffman table (DHT) segments maintained by the
2246 * application. i.e. up to 2 Huffman tables are stored in there for
2249 * The #load_huffman_table array can be used as a hint to notify the
2250 * VA driver implementation about which table(s) actually changed
2251 * since the last submission of this buffer.
2253 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2254 /** \brief Specifies which #huffman_table is valid. */
2255 uint8_t load_huffman_table[2];
2256 /** \brief Huffman tables indexed by table identifier (Th). */
2258 /** @name DC table (up to 12 categories) */
2260 /** \brief Number of Huffman codes of length i + 1 (Li). */
2261 uint8_t num_dc_codes[16];
2262 /** \brief Value associated with each Huffman code (Vij). */
2263 uint8_t dc_values[12];
2265 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2267 /** \brief Number of Huffman codes of length i + 1 (Li). */
2268 uint8_t num_ac_codes[16];
2269 /** \brief Value associated with each Huffman code (Vij). */
2270 uint8_t ac_values[162];
2271 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2276 /** \brief Reserved bytes for future use, must be zero */
2277 uint32_t va_reserved[VA_PADDING_LOW];
2278 } VAHuffmanTableBufferJPEGBaseline;
2280 /****************************
2281 * MPEG-2 data structures
2282 ****************************/
2284 /* MPEG-2 Picture Parameter Buffer */
2286 * For each frame or field, and before any slice data, a single
2287 * picture parameter buffer must be send.
2289 typedef struct _VAPictureParameterBufferMPEG2
2291 uint16_t horizontal_size;
2292 uint16_t vertical_size;
2293 VASurfaceID forward_reference_picture;
2294 VASurfaceID backward_reference_picture;
2295 /* meanings of the following fields are the same as in the standard */
2296 int32_t picture_coding_type;
2297 int32_t f_code; /* pack all four fcode into this */
2300 uint32_t intra_dc_precision : 2;
2301 uint32_t picture_structure : 2;
2302 uint32_t top_field_first : 1;
2303 uint32_t frame_pred_frame_dct : 1;
2304 uint32_t concealment_motion_vectors : 1;
2305 uint32_t q_scale_type : 1;
2306 uint32_t intra_vlc_format : 1;
2307 uint32_t alternate_scan : 1;
2308 uint32_t repeat_first_field : 1;
2309 uint32_t progressive_frame : 1;
2310 uint32_t is_first_field : 1; /* indicate whether the current field
2311 * is the first field for field picture
2315 } picture_coding_extension;
2317 /** \brief Reserved bytes for future use, must be zero */
2318 uint32_t va_reserved[VA_PADDING_LOW];
2319 } VAPictureParameterBufferMPEG2;
2321 /** MPEG-2 Inverse Quantization Matrix Buffer */
2322 typedef struct _VAIQMatrixBufferMPEG2
2324 /** \brief Same as the MPEG-2 bitstream syntax element. */
2325 int32_t load_intra_quantiser_matrix;
2326 /** \brief Same as the MPEG-2 bitstream syntax element. */
2327 int32_t load_non_intra_quantiser_matrix;
2328 /** \brief Same as the MPEG-2 bitstream syntax element. */
2329 int32_t load_chroma_intra_quantiser_matrix;
2330 /** \brief Same as the MPEG-2 bitstream syntax element. */
2331 int32_t load_chroma_non_intra_quantiser_matrix;
2332 /** \brief Luminance intra matrix, in zig-zag scan order. */
2333 uint8_t intra_quantiser_matrix[64];
2334 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2335 uint8_t non_intra_quantiser_matrix[64];
2336 /** \brief Chroma intra matrix, in zig-zag scan order. */
2337 uint8_t chroma_intra_quantiser_matrix[64];
2338 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2339 uint8_t chroma_non_intra_quantiser_matrix[64];
2341 /** \brief Reserved bytes for future use, must be zero */
2342 uint32_t va_reserved[VA_PADDING_LOW];
2343 } VAIQMatrixBufferMPEG2;
2345 /** MPEG-2 Slice Parameter Buffer */
2346 typedef struct _VASliceParameterBufferMPEG2
2348 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2349 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2350 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2351 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2352 uint32_t slice_horizontal_position;
2353 uint32_t slice_vertical_position;
2354 int32_t quantiser_scale_code;
2355 int32_t intra_slice_flag;
2357 /** \brief Reserved bytes for future use, must be zero */
2358 uint32_t va_reserved[VA_PADDING_LOW];
2359 } VASliceParameterBufferMPEG2;
2361 /** MPEG-2 Macroblock Parameter Buffer */
2362 typedef struct _VAMacroblockParameterBufferMPEG2
2364 uint16_t macroblock_address;
2366 * macroblock_address (in raster scan order)
2368 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2370 uint8_t macroblock_type; /* see definition below */
2373 uint32_t frame_motion_type : 2;
2374 uint32_t field_motion_type : 2;
2375 uint32_t dct_type : 1;
2379 uint8_t motion_vertical_field_select;
2381 * motion_vertical_field_select:
2382 * see section 6.3.17.2 in the spec
2383 * only the lower 4 bits are used
2384 * bit 0: first vector forward
2385 * bit 1: first vector backward
2386 * bit 2: second vector forward
2387 * bit 3: second vector backward
2389 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2390 uint16_t coded_block_pattern;
2392 * The bitplanes for coded_block_pattern are described
2393 * in Figure 6.10-12 in the spec
2396 /* Number of skipped macroblocks after this macroblock */
2397 uint16_t num_skipped_macroblocks;
2399 /** \brief Reserved bytes for future use, must be zero */
2400 uint32_t va_reserved[VA_PADDING_LOW];
2401 } VAMacroblockParameterBufferMPEG2;
2404 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2406 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2407 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2408 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2409 #define VA_MB_TYPE_MOTION_INTRA 0x10
2412 * MPEG-2 Residual Data Buffer
2413 * For each macroblock, there wil be 64 shorts (16-bit) in the
2414 * residual data buffer
2417 /****************************
2418 * MPEG-4 Part 2 data structures
2419 ****************************/
2421 /* MPEG-4 Picture Parameter Buffer */
2423 * For each frame or field, and before any slice data, a single
2424 * picture parameter buffer must be send.
2426 typedef struct _VAPictureParameterBufferMPEG4
2429 uint16_t vop_height;
2430 VASurfaceID forward_reference_picture;
2431 VASurfaceID backward_reference_picture;
2434 uint32_t short_video_header : 1;
2435 uint32_t chroma_format : 2;
2436 uint32_t interlaced : 1;
2437 uint32_t obmc_disable : 1;
2438 uint32_t sprite_enable : 2;
2439 uint32_t sprite_warping_accuracy : 2;
2440 uint32_t quant_type : 1;
2441 uint32_t quarter_sample : 1;
2442 uint32_t data_partitioned : 1;
2443 uint32_t reversible_vlc : 1;
2444 uint32_t resync_marker_disable : 1;
2448 uint8_t no_of_sprite_warping_points;
2449 int16_t sprite_trajectory_du[3];
2450 int16_t sprite_trajectory_dv[3];
2451 uint8_t quant_precision;
2454 uint32_t vop_coding_type : 2;
2455 uint32_t backward_reference_vop_coding_type : 2;
2456 uint32_t vop_rounding_type : 1;
2457 uint32_t intra_dc_vlc_thr : 3;
2458 uint32_t top_field_first : 1;
2459 uint32_t alternate_vertical_scan_flag : 1;
2463 uint8_t vop_fcode_forward;
2464 uint8_t vop_fcode_backward;
2465 uint16_t vop_time_increment_resolution;
2466 /* short header related */
2467 uint8_t num_gobs_in_vop;
2468 uint8_t num_macroblocks_in_gob;
2469 /* for direct mode prediction */
2473 /** \brief Reserved bytes for future use, must be zero */
2474 uint32_t va_reserved[VA_PADDING_LOW];
2475 } VAPictureParameterBufferMPEG4;
2477 /** MPEG-4 Inverse Quantization Matrix Buffer */
2478 typedef struct _VAIQMatrixBufferMPEG4
2480 /** Same as the MPEG-4:2 bitstream syntax element. */
2481 int32_t load_intra_quant_mat;
2482 /** Same as the MPEG-4:2 bitstream syntax element. */
2483 int32_t load_non_intra_quant_mat;
2484 /** The matrix for intra blocks, in zig-zag scan order. */
2485 uint8_t intra_quant_mat[64];
2486 /** The matrix for non-intra blocks, in zig-zag scan order. */
2487 uint8_t non_intra_quant_mat[64];
2489 /** \brief Reserved bytes for future use, must be zero */
2490 uint32_t va_reserved[VA_PADDING_LOW];
2491 } VAIQMatrixBufferMPEG4;
2493 /** MPEG-4 Slice Parameter Buffer */
2494 typedef struct _VASliceParameterBufferMPEG4
2496 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2497 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2498 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2499 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2500 uint32_t macroblock_number;
2501 int32_t quant_scale;
2503 /** \brief Reserved bytes for future use, must be zero */
2504 uint32_t va_reserved[VA_PADDING_LOW];
2505 } VASliceParameterBufferMPEG4;
2508 VC-1 data structures
2511 typedef enum /* see 7.1.1.32 */
2514 VAMvMode1MvHalfPel = 1,
2515 VAMvMode1MvHalfPelBilinear = 2,
2516 VAMvModeMixedMv = 3,
2517 VAMvModeIntensityCompensation = 4
2520 /** VC-1 Picture Parameter Buffer */
2522 * For each picture, and before any slice data, a picture parameter
2523 * buffer must be send. Multiple picture parameter buffers may be
2524 * sent for a single picture. In that case picture parameters will
2525 * apply to all slice data that follow it until a new picture
2526 * parameter buffer is sent.
2529 * pic_quantizer_type should be set to the applicable quantizer
2530 * type as defined by QUANTIZER (J.1.19) and either
2531 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2533 typedef struct _VAPictureParameterBufferVC1
2535 VASurfaceID forward_reference_picture;
2536 VASurfaceID backward_reference_picture;
2537 /* if out-of-loop post-processing is done on the render
2538 target, then we need to keep the in-loop decoded
2539 picture as a reference picture */
2540 VASurfaceID inloop_decoded_picture;
2542 /* sequence layer for AP or meta data for SP and MP */
2545 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2546 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2547 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2548 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2549 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2550 uint32_t multires : 1; /* METADATA::MULTIRES */
2551 uint32_t overlap : 1; /* METADATA::OVERLAP */
2552 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2553 uint32_t rangered : 1; /* METADATA::RANGERED */
2554 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2555 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2560 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2561 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2564 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2565 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2566 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2567 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2570 } entrypoint_fields;
2571 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2572 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2575 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2576 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2577 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2578 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2581 } range_mapping_fields;
2583 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2584 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2585 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2586 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2587 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2588 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2589 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2590 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2591 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2595 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2596 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2597 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2598 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2599 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2605 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2606 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2607 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2608 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2609 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2610 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2611 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2617 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2618 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2619 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2620 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2621 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2622 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2623 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2626 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2629 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2630 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2631 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2632 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2638 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2639 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2640 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2641 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2642 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2643 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2644 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2645 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2646 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2647 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2653 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2654 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2655 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2656 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2657 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2658 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2659 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2660 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2661 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2662 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2663 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2666 } pic_quantizer_fields;
2669 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2670 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2671 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2672 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2673 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2674 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2679 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2680 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2681 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2683 /** \brief Reserved bytes for future use, must be zero */
2684 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2685 } VAPictureParameterBufferVC1;
2687 /** VC-1 Bitplane Buffer
2688 There will be at most three bitplanes coded in any picture header. To send
2689 the bitplane data more efficiently, each byte is divided in two nibbles, with
2690 each nibble carrying three bitplanes for one macroblock. The following table
2691 shows the bitplane data arrangement within each nibble based on the picture
2694 Picture Type Bit3 Bit2 Bit1 Bit0
2695 I or BI OVERFLAGS ACPRED FIELDTX
2696 P MYTYPEMB SKIPMB DIRECTMB
2697 B FORWARDMB SKIPMB DIRECTMB
2699 Within each byte, the lower nibble is for the first MB and the upper nibble is
2700 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2701 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2702 Macroblock #2 in the first row.
2705 /* VC-1 Slice Parameter Buffer */
2706 typedef struct _VASliceParameterBufferVC1
2708 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2709 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2710 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2711 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2712 uint32_t slice_vertical_position;
2714 /** \brief Reserved bytes for future use, must be zero */
2715 uint32_t va_reserved[VA_PADDING_LOW];
2716 } VASliceParameterBufferVC1;
2718 /* VC-1 Slice Data Buffer */
2720 This is simplely a buffer containing raw bit-stream bytes
2723 /****************************
2724 * H.264/AVC data structures
2725 ****************************/
2727 typedef struct _VAPictureH264
2729 VASurfaceID picture_id;
2732 int32_t TopFieldOrderCnt;
2733 int32_t BottomFieldOrderCnt;
2735 /** \brief Reserved bytes for future use, must be zero */
2736 uint32_t va_reserved[VA_PADDING_LOW];
2738 /* flags in VAPictureH264 could be OR of the following */
2739 #define VA_PICTURE_H264_INVALID 0x00000001
2740 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2741 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2742 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2743 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2745 /** H.264 Picture Parameter Buffer */
2747 * For each picture, and before any slice data, a single
2748 * picture parameter buffer must be send.
2750 typedef struct _VAPictureParameterBufferH264
2752 VAPictureH264 CurrPic;
2753 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2754 uint16_t picture_width_in_mbs_minus1;
2755 uint16_t picture_height_in_mbs_minus1;
2756 uint8_t bit_depth_luma_minus8;
2757 uint8_t bit_depth_chroma_minus8;
2758 uint8_t num_ref_frames;
2761 uint32_t chroma_format_idc : 2;
2762 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2763 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2764 uint32_t frame_mbs_only_flag : 1;
2765 uint32_t mb_adaptive_frame_field_flag : 1;
2766 uint32_t direct_8x8_inference_flag : 1;
2767 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2768 uint32_t log2_max_frame_num_minus4 : 4;
2769 uint32_t pic_order_cnt_type : 2;
2770 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2771 uint32_t delta_pic_order_always_zero_flag : 1;
2775 // FMO is not supported.
2776 va_deprecated uint8_t num_slice_groups_minus1;
2777 va_deprecated uint8_t slice_group_map_type;
2778 va_deprecated uint16_t slice_group_change_rate_minus1;
2779 int8_t pic_init_qp_minus26;
2780 int8_t pic_init_qs_minus26;
2781 int8_t chroma_qp_index_offset;
2782 int8_t second_chroma_qp_index_offset;
2785 uint32_t entropy_coding_mode_flag : 1;
2786 uint32_t weighted_pred_flag : 1;
2787 uint32_t weighted_bipred_idc : 2;
2788 uint32_t transform_8x8_mode_flag : 1;
2789 uint32_t field_pic_flag : 1;
2790 uint32_t constrained_intra_pred_flag : 1;
2791 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2792 uint32_t deblocking_filter_control_present_flag : 1;
2793 uint32_t redundant_pic_cnt_present_flag : 1;
2794 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2800 /** \brief Reserved bytes for future use, must be zero */
2801 uint32_t va_reserved[VA_PADDING_MEDIUM];
2802 } VAPictureParameterBufferH264;
2804 /** H.264 Inverse Quantization Matrix Buffer */
2805 typedef struct _VAIQMatrixBufferH264
2807 /** \brief 4x4 scaling list, in raster scan order. */
2808 uint8_t ScalingList4x4[6][16];
2809 /** \brief 8x8 scaling list, in raster scan order. */
2810 uint8_t ScalingList8x8[2][64];
2812 /** \brief Reserved bytes for future use, must be zero */
2813 uint32_t va_reserved[VA_PADDING_LOW];
2814 } VAIQMatrixBufferH264;
2816 /** H.264 Slice Parameter Buffer */
2817 typedef struct _VASliceParameterBufferH264
2819 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2820 /** \brief Byte offset to the NAL Header Unit for this slice. */
2821 uint32_t slice_data_offset;
2822 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2824 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2826 * This bit offset is relative to and includes the NAL unit byte
2827 * and represents the number of bits parsed in the slice_header()
2828 * after the removal of any emulation prevention bytes in
2829 * there. However, the slice data buffer passed to the hardware is
2830 * the original bitstream, thus including any emulation prevention
2833 uint16_t slice_data_bit_offset;
2834 uint16_t first_mb_in_slice;
2836 uint8_t direct_spatial_mv_pred_flag;
2838 * H264/AVC syntax element
2840 * if num_ref_idx_active_override_flag equals 0, host decoder should
2841 * set its value to num_ref_idx_l0_default_active_minus1.
2843 uint8_t num_ref_idx_l0_active_minus1;
2845 * H264/AVC syntax element
2847 * if num_ref_idx_active_override_flag equals 0, host decoder should
2848 * set its value to num_ref_idx_l1_default_active_minus1.
2850 uint8_t num_ref_idx_l1_active_minus1;
2851 uint8_t cabac_init_idc;
2852 int8_t slice_qp_delta;
2853 uint8_t disable_deblocking_filter_idc;
2854 int8_t slice_alpha_c0_offset_div2;
2855 int8_t slice_beta_offset_div2;
2856 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2857 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2858 uint8_t luma_log2_weight_denom;
2859 uint8_t chroma_log2_weight_denom;
2860 uint8_t luma_weight_l0_flag;
2861 int16_t luma_weight_l0[32];
2862 int16_t luma_offset_l0[32];
2863 uint8_t chroma_weight_l0_flag;
2864 int16_t chroma_weight_l0[32][2];
2865 int16_t chroma_offset_l0[32][2];
2866 uint8_t luma_weight_l1_flag;
2867 int16_t luma_weight_l1[32];
2868 int16_t luma_offset_l1[32];
2869 uint8_t chroma_weight_l1_flag;
2870 int16_t chroma_weight_l1[32][2];
2871 int16_t chroma_offset_l1[32][2];
2873 /** \brief Reserved bytes for future use, must be zero */
2874 uint32_t va_reserved[VA_PADDING_LOW];
2875 } VASliceParameterBufferH264;
2877 /****************************
2878 * Common encode data structures
2879 ****************************/
2882 VAEncPictureTypeIntra = 0,
2883 VAEncPictureTypePredictive = 1,
2884 VAEncPictureTypeBidirectional = 2,
2887 /* Encode Slice Parameter Buffer */
2888 typedef struct _VAEncSliceParameterBuffer
2890 uint32_t start_row_number; /* starting MB row number for this slice */
2891 uint32_t slice_height; /* slice height measured in MB */
2894 uint32_t is_intra : 1;
2895 uint32_t disable_deblocking_filter_idc : 2;
2896 uint32_t uses_long_term_ref :1;
2897 uint32_t is_long_term_ref :1;
2902 /** \brief Reserved bytes for future use, must be zero */
2903 uint32_t va_reserved[VA_PADDING_LOW];
2904 } VAEncSliceParameterBuffer;
2907 /****************************
2908 * H.263 specific encode data structures
2909 ****************************/
2911 typedef struct _VAEncSequenceParameterBufferH263
2913 uint32_t intra_period;
2914 uint32_t bits_per_second;
2915 uint32_t frame_rate;
2916 uint32_t initial_qp;
2919 /** \brief Reserved bytes for future use, must be zero */
2920 uint32_t va_reserved[VA_PADDING_LOW];
2921 } VAEncSequenceParameterBufferH263;
2923 typedef struct _VAEncPictureParameterBufferH263
2925 VASurfaceID reference_picture;
2926 VASurfaceID reconstructed_picture;
2927 VABufferID coded_buf;
2928 uint16_t picture_width;
2929 uint16_t picture_height;
2930 VAEncPictureType picture_type;
2932 /** \brief Reserved bytes for future use, must be zero */
2933 uint32_t va_reserved[VA_PADDING_LOW];
2934 } VAEncPictureParameterBufferH263;
2936 /****************************
2937 * MPEG-4 specific encode data structures
2938 ****************************/
2940 typedef struct _VAEncSequenceParameterBufferMPEG4
2942 uint8_t profile_and_level_indication;
2943 uint32_t intra_period;
2944 uint32_t video_object_layer_width;
2945 uint32_t video_object_layer_height;
2946 uint32_t vop_time_increment_resolution;
2947 uint32_t fixed_vop_rate;
2948 uint32_t fixed_vop_time_increment;
2949 uint32_t bits_per_second;
2950 uint32_t frame_rate;
2951 uint32_t initial_qp;
2954 /** \brief Reserved bytes for future use, must be zero */
2955 uint32_t va_reserved[VA_PADDING_LOW];
2956 } VAEncSequenceParameterBufferMPEG4;
2958 typedef struct _VAEncPictureParameterBufferMPEG4
2960 VASurfaceID reference_picture;
2961 VASurfaceID reconstructed_picture;
2962 VABufferID coded_buf;
2963 uint16_t picture_width;
2964 uint16_t picture_height;
2965 uint32_t modulo_time_base; /* number of 1s */
2966 uint32_t vop_time_increment;
2967 VAEncPictureType picture_type;
2969 /** \brief Reserved bytes for future use, must be zero */
2970 uint32_t va_reserved[VA_PADDING_LOW];
2971 } VAEncPictureParameterBufferMPEG4;
2975 /** Buffer functions */
2978 * Creates a buffer for "num_elements" elements of "size" bytes and
2979 * initalize with "data".
2980 * if "data" is null, then the contents of the buffer data store
2982 * Basically there are two ways to get buffer data to the server side. One is
2983 * to call vaCreateBuffer() with a non-null "data", which results the data being
2984 * copied to the data store on the server side. A different method that
2985 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2986 * and then use vaMapBuffer() to map the data store from the server side to the
2987 * client address space for access.
2988 * The user must call vaDestroyBuffer() to destroy a buffer.
2989 * Note: image buffers are created by the library, not the client. Please see
2990 * vaCreateImage on how image buffers are managed.
2992 VAStatus vaCreateBuffer (
2994 VAContextID context,
2995 VABufferType type, /* in */
2996 unsigned int size, /* in */
2997 unsigned int num_elements, /* in */
2998 void *data, /* in */
2999 VABufferID *buf_id /* out */
3003 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
3004 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
3005 * can call vaMapBuffer with this Buffer ID to get virtual address.
3006 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
3007 * maybe it should align with 256, and one byte present one Qp.so, call the function.
3008 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
3009 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
3010 * pBuf + 256 is the start of next line.
3011 * different driver implementation maybe return different unit_size and pitch
3013 VAStatus vaCreateBuffer2(
3015 VAContextID context,
3018 unsigned int height,
3019 unsigned int *unit_size,
3020 unsigned int *pitch,
3025 * Convey to the server how many valid elements are in the buffer.
3026 * e.g. if multiple slice parameters are being held in a single buffer,
3027 * this will communicate to the server the number of slice parameters
3028 * that are valid in the buffer.
3030 VAStatus vaBufferSetNumElements (
3032 VABufferID buf_id, /* in */
3033 unsigned int num_elements /* in */
3038 * device independent data structure for codedbuffer
3042 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
3043 * LARGE_SLICE(bit8):At least one slice in the current frame was large
3044 * enough for the encoder to attempt to limit its size.
3045 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
3046 * exceeded the maximum slice size specified.
3047 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
3048 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
3049 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
3051 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
3052 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
3053 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
3054 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
3055 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
3057 * \brief The frame has exceeded the maximum requested size.
3059 * This flag indicates that the encoded frame size exceeds the value
3060 * specified through a misc parameter buffer of type
3061 * #VAEncMiscParameterTypeMaxFrameSize.
3063 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
3064 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
3067 * \brief The coded buffer segment contains a single NAL unit.
3069 * This flag indicates that the coded buffer segment contains a
3070 * single NAL unit. This flag might be useful to the user for
3071 * processing the coded buffer.
3073 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
3076 * \brief Coded buffer segment.
3078 * #VACodedBufferSegment is an element of a linked list describing
3079 * some information on the coded buffer. The coded buffer segment
3080 * could contain either a single NAL unit, or more than one NAL unit.
3081 * It is recommended (but not required) to return a single NAL unit
3082 * in a coded buffer segment, and the implementation should set the
3083 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
3085 typedef struct _VACodedBufferSegment {
3087 * \brief Size of the data buffer in this segment (in bytes).
3090 /** \brief Bit offset into the data buffer where the video data starts. */
3091 uint32_t bit_offset;
3092 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
3094 /** \brief Reserved for future use. */
3096 /** \brief Pointer to the start of the data buffer. */
3099 * \brief Pointer to the next #VACodedBufferSegment element,
3100 * or \c NULL if there is none.
3104 /** \brief Reserved bytes for future use, must be zero */
3105 uint32_t va_reserved[VA_PADDING_LOW];
3106 } VACodedBufferSegment;
3109 * Map data store of the buffer into the client's address space
3110 * vaCreateBuffer() needs to be called with "data" set to NULL before
3111 * calling vaMapBuffer()
3113 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
3114 * VACodedBufferSegment, and the list is terminated if "next" is NULL
3116 VAStatus vaMapBuffer (
3118 VABufferID buf_id, /* in */
3119 void **pbuf /* out */
3123 * After client making changes to a mapped data store, it needs to
3124 * "Unmap" it to let the server know that the data is ready to be
3125 * consumed by the server
3127 VAStatus vaUnmapBuffer (
3129 VABufferID buf_id /* in */
3133 * After this call, the buffer is deleted and this buffer_id is no longer valid
3135 * A buffer can be re-used and sent to the server by another Begin/Render/End
3136 * sequence if vaDestroyBuffer() is not called with this buffer.
3138 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3139 * hardware accelerator can result in performance dropping.
3141 VAStatus vaDestroyBuffer (
3143 VABufferID buffer_id
3146 /** \brief VA buffer information */
3148 /** \brief Buffer handle */
3150 /** \brief Buffer type (See \ref VABufferType). */
3153 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3155 * On input to vaAcquireBufferHandle(), this field can serve as a hint
3156 * to specify the set of memory types the caller is interested in.
3157 * On successful return from vaAcquireBufferHandle(), the field is
3158 * updated with the best matching memory type.
3161 /** \brief Size of the underlying buffer. */
3164 /** \brief Reserved bytes for future use, must be zero */
3165 uint32_t va_reserved[VA_PADDING_LOW];
3169 * \brief Acquires buffer handle for external API usage
3171 * Locks the VA buffer object \ref buf_id for external API usage like
3172 * EGL or OpenCL (OCL). This function is a synchronization point. This
3173 * means that any pending operation is guaranteed to be completed
3174 * prior to returning from the function.
3176 * If the referenced VA buffer object is the backing store of a VA
3177 * surface, then this function acts as if vaSyncSurface() on the
3178 * parent surface was called first.
3180 * The \ref VABufferInfo argument shall be zero'ed on input. On
3181 * successful output, the data structure is filled in with all the
3182 * necessary buffer level implementation details like handle, type,
3183 * memory type and memory size.
3185 * Note: the external API implementation, or the application, can
3186 * express the memory types it is interested in by filling in the \ref
3187 * mem_type field accordingly. On successful output, the memory type
3188 * that fits best the request and that was used is updated in the \ref
3189 * VABufferInfo data structure. If none of the supplied memory types
3190 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3191 * error is returned.
3193 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3194 * is called. Besides, no additional operation is allowed on any of
3195 * the buffer parent object until vaReleaseBufferHandle() is called.
3196 * e.g. decoding into a VA surface backed with the supplied VA buffer
3197 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3201 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3202 * does not support this interface
3203 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3204 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3205 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3206 * does not support exporting buffers of the specified type
3207 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3208 * memory types in \ref VABufferInfo.mem_type was supported
3210 * @param[in] dpy the VA display
3211 * @param[in] buf_id the VA buffer
3212 * @param[in,out] buf_info the associated VA buffer information
3213 * @return VA_STATUS_SUCCESS if successful
3216 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3219 * \brief Releases buffer after usage from external API
3221 * Unlocks the VA buffer object \ref buf_id from external API usage like
3222 * EGL or OpenCL (OCL). This function is a synchronization point. This
3223 * means that any pending operation is guaranteed to be completed
3224 * prior to returning from the function.
3226 * The \ref VABufferInfo argument shall point to the original data
3227 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3228 * This is necessary so that the VA driver implementation could
3229 * deallocate any resources that were needed.
3231 * In any case, returning from this function invalidates any contents
3232 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3233 * valid. Therefore, VA driver implementations are free to reset this
3234 * data structure to safe defaults.
3237 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3238 * does not support this interface
3239 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3240 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3241 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3242 * does not support exporting buffers of the specified type
3244 * @param[in] dpy the VA display
3245 * @param[in] buf_id the VA buffer
3246 * @return VA_STATUS_SUCCESS if successful
3249 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3252 * Render (Video Decode/Encode/Processing) Pictures
3254 * A picture represents either a frame or a field.
3256 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3261 * Get ready for a video pipeline
3262 * - decode a picture to a target surface
3263 * - encode a picture from a target surface
3264 * - process a picture to a target surface
3266 VAStatus vaBeginPicture (
3268 VAContextID context,
3269 VASurfaceID render_target
3273 * Send video decode, encode or processing buffers to the server.
3275 VAStatus vaRenderPicture (
3277 VAContextID context,
3278 VABufferID *buffers,
3283 * Make the end of rendering for a picture.
3284 * The server should start processing all pending operations for this
3285 * surface. This call is non-blocking. The client can start another
3286 * Begin/Render/End sequence on a different render target.
3287 * if VAContextID used in this function previously successfully passed
3288 * vaMFAddContext call, real processing will be started during vaMFSubmit
3290 VAStatus vaEndPicture (
3296 * Make the end of rendering for a pictures in contexts passed with submission.
3297 * The server should start processing all pending operations for contexts.
3298 * All contexts passed should be associated through vaMFAddContext
3299 * and call sequence Begin/Render/End performed.
3300 * This call is non-blocking. The client can start another
3301 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3303 * VA_STATUS_SUCCESS - operation successful, context was removed.
3304 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3305 * due to mf_context not created or one of contexts not assotiated with mf_context
3306 * through vaAddContext.
3307 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3308 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3310 * mf_context: Multi-Frame context
3311 * contexts: list of contexts submitting their tasks for multi-frame operation.
3312 * num_contexts: number of passed contexts.
3314 VAStatus vaMFSubmit (
3316 VAMFContextID mf_context,
3317 VAContextID * contexts,
3328 * This function blocks until all pending operations on the render target
3329 * have been completed. Upon return it is safe to use the render target for a
3330 * different picture.
3332 VAStatus vaSyncSurface (
3334 VASurfaceID render_target
3339 VASurfaceRendering = 1, /* Rendering in progress */
3340 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3341 /* this status is useful if surface is used as the source */
3343 VASurfaceReady = 4, /* not being rendered or displayed */
3344 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3348 * Find out any pending ops on the render target
3350 VAStatus vaQuerySurfaceStatus (
3352 VASurfaceID render_target,
3353 VASurfaceStatus *status /* out */
3358 VADecodeSliceMissing = 0,
3359 VADecodeMBError = 1,
3360 } VADecodeErrorType;
3363 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3364 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3366 typedef struct _VASurfaceDecodeMBErrors
3368 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3369 uint32_t start_mb; /* start mb address with errors */
3370 uint32_t end_mb; /* end mb address with errors */
3371 VADecodeErrorType decode_error_type;
3372 uint32_t num_mb; /* number of mbs with errors */
3373 /** \brief Reserved bytes for future use, must be zero */
3374 uint32_t va_reserved[VA_PADDING_LOW - 1];
3375 } VASurfaceDecodeMBErrors;
3378 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3379 * it can call vaQuerySurfaceError to find out further details on the particular error.
3380 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3381 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3382 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3383 * The array is terminated if "status==-1" is detected.
3385 VAStatus vaQuerySurfaceError(
3387 VASurfaceID surface,
3388 VAStatus error_status,
3393 * Images and Subpictures
3394 * VAImage is used to either get the surface data to client memory, or
3395 * to copy image data in client memory to a surface.
3396 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3397 * is at the upper left corner with positive X to the right and positive Y down
3399 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3400 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3401 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3404 * Pre-defined fourcc codes
3406 #define VA_FOURCC_NV12 0x3231564E
3407 #define VA_FOURCC_NV21 0x3132564E
3408 #define VA_FOURCC_AI44 0x34344149
3409 #define VA_FOURCC_RGBA 0x41424752
3410 #define VA_FOURCC_RGBX 0x58424752
3411 #define VA_FOURCC_BGRA 0x41524742
3412 #define VA_FOURCC_BGRX 0x58524742
3413 #define VA_FOURCC_ARGB 0x42475241
3414 #define VA_FOURCC_XRGB 0x42475258
3415 #define VA_FOURCC_ABGR 0x52474241
3416 #define VA_FOURCC_XBGR 0x52474258
3417 #define VA_FOURCC_UYVY 0x59565955
3418 #define VA_FOURCC_YUY2 0x32595559
3419 #define VA_FOURCC_AYUV 0x56555941
3420 #define VA_FOURCC_NV11 0x3131564e
3421 #define VA_FOURCC_YV12 0x32315659
3422 #define VA_FOURCC_P208 0x38303250
3423 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3424 #define VA_FOURCC_IYUV 0x56555949
3425 #define VA_FOURCC_I420 0x30323449
3426 #define VA_FOURCC_YV24 0x34325659
3427 #define VA_FOURCC_YV32 0x32335659
3428 #define VA_FOURCC_Y800 0x30303859
3429 #define VA_FOURCC_IMC3 0x33434D49
3430 #define VA_FOURCC_411P 0x50313134
3431 #define VA_FOURCC_422H 0x48323234
3432 #define VA_FOURCC_422V 0x56323234
3433 #define VA_FOURCC_444P 0x50343434
3434 #define VA_FOURCC_RGBP 0x50424752
3435 #define VA_FOURCC_BGRP 0x50524742
3436 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
3439 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3441 #define VA_FOURCC_YV16 0x36315659
3443 * 10-bit and 16-bit Planar YUV 4:2:0.
3445 #define VA_FOURCC_P010 0x30313050
3446 #define VA_FOURCC_P016 0x36313050
3449 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3451 #define VA_FOURCC_I010 0x30313049
3454 #define VA_LSB_FIRST 1
3455 #define VA_MSB_FIRST 2
3457 typedef struct _VAImageFormat
3460 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3461 uint32_t bits_per_pixel;
3462 /* for RGB formats */
3463 uint32_t depth; /* significant bits per pixel */
3465 uint32_t green_mask;
3467 uint32_t alpha_mask;
3469 /** \brief Reserved bytes for future use, must be zero */
3470 uint32_t va_reserved[VA_PADDING_LOW];
3473 typedef VAGenericID VAImageID;
3475 typedef struct _VAImage
3477 VAImageID image_id; /* uniquely identify this image */
3478 VAImageFormat format;
3479 VABufferID buf; /* image data buffer */
3481 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3482 * data store on the server side for optimal performance. The buffer will be
3483 * created by the CreateImage function, and proper storage allocated based on the image
3484 * size and format. This buffer is managed by the library implementation, and
3485 * accessed by the client through the buffer Map/Unmap functions.
3490 uint32_t num_planes; /* can not be greater than 3 */
3492 * An array indicating the scanline pitch in bytes for each plane.
3493 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3495 uint32_t pitches[3];
3497 * An array indicating the byte offset from the beginning of the image data
3498 * to the start of each plane.
3500 uint32_t offsets[3];
3502 /* The following fields are only needed for paletted formats */
3503 int32_t num_palette_entries; /* set to zero for non-palette images */
3505 * Each component is one byte and entry_bytes indicates the number of components in
3506 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3508 int32_t entry_bytes;
3510 * An array of ascii characters describing the order of the components within the bytes.
3511 * Only entry_bytes characters of the string are used.
3513 int8_t component_order[4];
3515 /** \brief Reserved bytes for future use, must be zero */
3516 uint32_t va_reserved[VA_PADDING_LOW];
3519 /** Get maximum number of image formats supported by the implementation */
3520 int vaMaxNumImageFormats (
3525 * Query supported image formats
3526 * The caller must provide a "format_list" array that can hold at
3527 * least vaMaxNumImageFormats() entries. The actual number of formats
3528 * returned in "format_list" is returned in "num_formats".
3530 VAStatus vaQueryImageFormats (
3532 VAImageFormat *format_list, /* out */
3533 int *num_formats /* out */
3537 * Create a VAImage structure
3538 * The width and height fields returned in the VAImage structure may get
3539 * enlarged for some YUV formats. Upon return from this function,
3540 * image->buf has been created and proper storage allocated by the library.
3541 * The client can access the image through the Map/Unmap calls.
3543 VAStatus vaCreateImage (
3545 VAImageFormat *format,
3548 VAImage *image /* out */
3552 * Should call DestroyImage before destroying the surface it is bound to
3554 VAStatus vaDestroyImage (
3559 VAStatus vaSetImagePalette (
3563 * pointer to an array holding the palette data. The size of the array is
3564 * num_palette_entries * entry_bytes in size. The order of the components
3565 * in the palette is described by the component_order in VAImage struct
3567 unsigned char *palette
3571 * Retrive surface data into a VAImage
3572 * Image must be in a format supported by the implementation
3574 VAStatus vaGetImage (
3576 VASurfaceID surface,
3577 int x, /* coordinates of the upper left source pixel */
3579 unsigned int width, /* width and height of the region */
3580 unsigned int height,
3585 * Copy data from a VAImage to a surface
3586 * Image must be in a format supported by the implementation
3587 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3588 * shouldn't be rendered into when this is called
3590 VAStatus vaPutImage (
3592 VASurfaceID surface,
3596 unsigned int src_width,
3597 unsigned int src_height,
3600 unsigned int dest_width,
3601 unsigned int dest_height
3605 * Derive an VAImage from an existing surface.
3606 * This interface will derive a VAImage and corresponding image buffer from
3607 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3608 * direct CPU access. This operation is only possible on implementations with
3609 * direct rendering capabilities and internal surface formats that can be
3610 * represented with a VAImage. When the operation is not possible this interface
3611 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3612 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3615 * Implementations should only return success when the resulting image buffer
3616 * would be useable with vaMap/Unmap.
3618 * When directly accessing a surface special care must be taken to insure
3619 * proper synchronization with the graphics hardware. Clients should call
3620 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3621 * rendering or currently being displayed by an overlay.
3623 * Additionally nothing about the contents of a surface should be assumed
3624 * following a vaPutSurface. Implementations are free to modify the surface for
3625 * scaling or subpicture blending within a call to vaPutImage.
3627 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3628 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3629 * vaGetImage with other surfaces is supported.
3631 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3632 * image and image buffer structures will be destroyed; however, the underlying
3633 * surface will remain unchanged until freed with vaDestroySurfaces.
3635 VAStatus vaDeriveImage (
3637 VASurfaceID surface,
3638 VAImage *image /* out */
3643 * Subpicture is a special type of image that can be blended
3644 * with a surface during vaPutSurface(). Subpicture can be used to render
3645 * DVD sub-titles or closed captioning text etc.
3648 typedef VAGenericID VASubpictureID;
3650 /** Get maximum number of subpicture formats supported by the implementation */
3651 int vaMaxNumSubpictureFormats (
3655 /** flags for subpictures */
3656 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3657 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3658 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3660 * Query supported subpicture formats
3661 * The caller must provide a "format_list" array that can hold at
3662 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3663 * for each format to indicate additional capabilities for that format. The actual
3664 * number of formats returned in "format_list" is returned in "num_formats".
3665 * flags: returned value to indicate addtional capabilities
3666 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3667 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3668 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3671 VAStatus vaQuerySubpictureFormats (
3673 VAImageFormat *format_list, /* out */
3674 unsigned int *flags, /* out */
3675 unsigned int *num_formats /* out */
3679 * Subpictures are created with an image associated.
3681 VAStatus vaCreateSubpicture (
3684 VASubpictureID *subpicture /* out */
3688 * Destroy the subpicture before destroying the image it is assocated to
3690 VAStatus vaDestroySubpicture (
3692 VASubpictureID subpicture
3696 * Bind an image to the subpicture. This image will now be associated with
3697 * the subpicture instead of the one at creation.
3699 VAStatus vaSetSubpictureImage (
3701 VASubpictureID subpicture,
3706 * If chromakey is enabled, then the area where the source value falls within
3707 * the chromakey [min, max] range is transparent
3708 * The chromakey component format is the following:
3709 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3710 * For YUV: [0:7] V [8:15] U [16:23] Y
3711 * The chromakey mask can be used to mask out certain components for chromakey
3714 VAStatus vaSetSubpictureChromakey (
3716 VASubpictureID subpicture,
3717 unsigned int chromakey_min,
3718 unsigned int chromakey_max,
3719 unsigned int chromakey_mask
3723 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3724 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3725 * the overall alpha is per-pixel alpha multiplied by the global alpha
3727 VAStatus vaSetSubpictureGlobalAlpha (
3729 VASubpictureID subpicture,
3734 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3735 * It defines the region mapping between the subpicture and the target
3736 * surfaces through source and destination rectangles (with the same width and height).
3737 * Both will be displayed at the next call to vaPutSurface. Additional
3738 * associations before the call to vaPutSurface simply overrides the association.
3740 VAStatus vaAssociateSubpicture (
3742 VASubpictureID subpicture,
3743 VASurfaceID *target_surfaces,
3745 int16_t src_x, /* upper left offset in subpicture */
3748 uint16_t src_height,
3749 int16_t dest_x, /* upper left offset in surface */
3751 uint16_t dest_width,
3752 uint16_t dest_height,
3754 * whether to enable chroma-keying, global-alpha, or screen relative mode
3755 * see VA_SUBPICTURE_XXX values
3761 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3763 VAStatus vaDeassociateSubpicture (
3765 VASubpictureID subpicture,
3766 VASurfaceID *target_surfaces,
3771 * Display attributes
3772 * Display attributes are used to control things such as contrast, hue, saturation,
3773 * brightness etc. in the rendering process. The application can query what
3774 * attributes are supported by the driver, and then set the appropriate attributes
3775 * before calling vaPutSurface()
3777 /* PowerVR IEP Lite attributes */
3780 VADISPLAYATTRIB_BLE_OFF = 0x00,
3781 VADISPLAYATTRIB_BLE_LOW,
3782 VADISPLAYATTRIB_BLE_MEDIUM,
3783 VADISPLAYATTRIB_BLE_HIGH,
3784 VADISPLAYATTRIB_BLE_NONE,
3785 } VADisplayAttribBLEMode;
3787 /** attribute value for VADisplayAttribRotation */
3788 #define VA_ROTATION_NONE 0x00000000
3789 #define VA_ROTATION_90 0x00000001
3790 #define VA_ROTATION_180 0x00000002
3791 #define VA_ROTATION_270 0x00000003
3795 * @name Mirroring directions
3797 * Those values could be used for VADisplayAttribMirror attribute or
3798 * VAProcPipelineParameterBuffer::mirror_state.
3802 /** \brief No Mirroring. */
3803 #define VA_MIRROR_NONE 0x00000000
3804 /** \brief Horizontal Mirroring. */
3805 #define VA_MIRROR_HORIZONTAL 0x00000001
3806 /** \brief Vertical Mirroring. */
3807 #define VA_MIRROR_VERTICAL 0x00000002
3810 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3811 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3812 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3815 #define VA_RENDER_MODE_UNDEFINED 0
3816 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3817 #define VA_RENDER_MODE_LOCAL_GPU 2
3818 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3819 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3821 /** Render device */
3822 #define VA_RENDER_DEVICE_UNDEFINED 0
3823 #define VA_RENDER_DEVICE_LOCAL 1
3824 #define VA_RENDER_DEVICE_EXTERNAL 2
3826 /** Currently defined display attribute types */
3829 VADisplayAttribBrightness = 0,
3830 VADisplayAttribContrast = 1,
3831 VADisplayAttribHue = 2,
3832 VADisplayAttribSaturation = 3,
3833 /* client can specifiy a background color for the target window
3834 * the new feature of video conference,
3835 * the uncovered area of the surface is filled by this color
3836 * also it will blend with the decoded video color
3838 VADisplayAttribBackgroundColor = 4,
3840 * this is a gettable only attribute. For some implementations that use the
3841 * hardware overlay, after PutSurface is called, the surface can not be
3842 * re-used until after the subsequent PutSurface call. If this is the case
3843 * then the value for this attribute will be set to 1 so that the client
3844 * will not attempt to re-use the surface right after returning from a call
3847 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3848 * driver may use overlay or GPU alternatively
3850 VADisplayAttribDirectSurface = 5,
3851 VADisplayAttribRotation = 6,
3852 VADisplayAttribOutofLoopDeblock = 7,
3854 /* PowerVR IEP Lite specific attributes */
3855 VADisplayAttribBLEBlackMode = 8,
3856 VADisplayAttribBLEWhiteMode = 9,
3857 VADisplayAttribBlueStretch = 10,
3858 VADisplayAttribSkinColorCorrection = 11,
3860 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3861 * conversion matrix. Each element in the matrix is float-point
3863 VADisplayAttribCSCMatrix = 12,
3864 /* specify the constant color used to blend with video surface
3865 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3866 * d: the final color to overwrite into the frame buffer
3867 * v: decoded video after color conversion,
3868 * c: video color specified by VADisplayAttribBlendColor
3869 * b: background color of the drawable
3871 VADisplayAttribBlendColor = 13,
3873 * Indicate driver to skip painting color key or not.
3874 * only applicable if the render is overlay
3876 VADisplayAttribOverlayAutoPaintColorKey = 14,
3878 * customized overlay color key, the format is RGB888
3879 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3881 VADisplayAttribOverlayColorKey = 15,
3883 * The hint for the implementation of vaPutSurface
3884 * normally, the driver could use an overlay or GPU to render the surface on the screen
3885 * this flag provides APP the flexibity to switch the render dynamically
3887 VADisplayAttribRenderMode = 16,
3889 * specify if vaPutSurface needs to render into specified monitors
3890 * one example is that one external monitor (e.g. HDMI) is enabled,
3891 * but the window manager is not aware of it, and there is no associated drawable
3893 VADisplayAttribRenderDevice = 17,
3895 * specify vaPutSurface render area if there is no drawable on the monitor
3897 VADisplayAttribRenderRect = 18,
3898 } VADisplayAttribType;
3900 /* flags for VADisplayAttribute */
3901 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3902 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3903 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3905 typedef struct _VADisplayAttribute
3907 VADisplayAttribType type;
3910 int32_t value; /* used by the set/get attribute functions */
3911 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3914 /** \brief Reserved bytes for future use, must be zero */
3915 uint32_t va_reserved[VA_PADDING_LOW];
3916 } VADisplayAttribute;
3918 /** Get maximum number of display attributs supported by the implementation */
3919 int vaMaxNumDisplayAttributes (
3924 * Query display attributes
3925 * The caller must provide a "attr_list" array that can hold at
3926 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3927 * returned in "attr_list" is returned in "num_attributes".
3929 VAStatus vaQueryDisplayAttributes (
3931 VADisplayAttribute *attr_list, /* out */
3932 int *num_attributes /* out */
3936 * Get display attributes
3937 * This function returns the current attribute values in "attr_list".
3938 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3939 * from vaQueryDisplayAttributes() can have their values retrieved.
3941 VAStatus vaGetDisplayAttributes (
3943 VADisplayAttribute *attr_list, /* in/out */
3948 * Set display attributes
3949 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3950 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3951 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3953 VAStatus vaSetDisplayAttributes (
3955 VADisplayAttribute *attr_list,
3959 /****************************
3960 * HEVC data structures
3961 ****************************/
3963 * \brief Description of picture properties of those in DPB surfaces.
3965 * If only progressive scan is supported, each surface contains one whole
3967 * Otherwise, each surface contains two fields of whole picture.
3968 * In this case, two entries of ReferenceFrames[] may share same picture_id
3971 typedef struct _VAPictureHEVC
3973 /** \brief reconstructed picture buffer surface index
3974 * invalid when taking value VA_INVALID_SURFACE.
3976 VASurfaceID picture_id;
3977 /** \brief picture order count.
3978 * in HEVC, POCs for top and bottom fields of same picture should
3979 * take different values.
3981 int32_t pic_order_cnt;
3982 /* described below */
3985 /** \brief Reserved bytes for future use, must be zero */
3986 uint32_t va_reserved[VA_PADDING_LOW];
3989 /* flags in VAPictureHEVC could be OR of the following */
3990 #define VA_PICTURE_HEVC_INVALID 0x00000001
3991 /** \brief indication of interlace scan picture.
3992 * should take same value for all the pictures in sequence.
3994 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3995 /** \brief polarity of the field picture.
3996 * top field takes even lines of buffer surface.
3997 * bottom field takes odd lines of buffer surface.
3999 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
4000 /** \brief Long term reference picture */
4001 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
4003 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
4004 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
4005 * be exclusive. No more than one of them can be set for any picture.
4006 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
4007 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
4008 * Application should provide valid values for both short format and long format.
4009 * The pictures in DPB with any of these three flags turned on are referred by
4010 * the current picture.
4012 /** \brief RefPicSetStCurrBefore of HEVC spec variable
4013 * Number of ReferenceFrames[] entries with this bit set equals
4014 * NumPocStCurrBefore.
4016 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
4017 /** \brief RefPicSetStCurrAfter of HEVC spec variable
4018 * Number of ReferenceFrames[] entries with this bit set equals
4019 * NumPocStCurrAfter.
4021 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
4022 /** \brief RefPicSetLtCurr of HEVC spec variable
4023 * Number of ReferenceFrames[] entries with this bit set equals
4026 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
4028 #include <va/va_dec_hevc.h>
4029 #include <va/va_dec_jpeg.h>
4030 #include <va/va_dec_vp8.h>
4031 #include <va/va_dec_vp9.h>
4032 #include <va/va_enc_hevc.h>
4033 #include <va/va_enc_h264.h>
4034 #include <va/va_enc_jpeg.h>
4035 #include <va/va_enc_mpeg2.h>
4036 #include <va/va_enc_vp8.h>
4037 #include <va/va_enc_vp9.h>
4038 #include <va/va_fei.h>
4039 #include <va/va_fei_h264.h>
4040 #include <va/va_vpp.h>