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 * \brief Encoding QP info block size attribute. Read-only.
697 * This attribute conveys the block sizes that underlying driver
698 * support for QP info for buffer #VAEncQpBuffer.
700 VAConfigAttribQPBlockSize = 37,
702 VAConfigAttribTypeMax
703 } VAConfigAttribType;
706 * Configuration attributes
707 * If there is more than one value for an attribute, a default
708 * value will be assigned to the attribute if the client does not
709 * specify the attribute when creating a configuration
711 typedef struct _VAConfigAttrib {
712 VAConfigAttribType type;
713 uint32_t value; /* OR'd flags (bits) for this attribute */
716 /** attribute value for VAConfigAttribRTFormat */
717 #define VA_RT_FORMAT_YUV420 0x00000001
718 #define VA_RT_FORMAT_YUV422 0x00000002
719 #define VA_RT_FORMAT_YUV444 0x00000004
720 #define VA_RT_FORMAT_YUV411 0x00000008
721 #define VA_RT_FORMAT_YUV400 0x00000010
722 /** YUV formats with more than 8 bpp */
723 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
725 #define VA_RT_FORMAT_RGB16 0x00010000
726 #define VA_RT_FORMAT_RGB32 0x00020000
727 /* RGBP covers RGBP and BGRP fourcc */
728 #define VA_RT_FORMAT_RGBP 0x00100000
730 * RGB 10-bit packed format with upper 2 bits as alpha channel.
731 * The existing pre-defined fourcc codes can be used to signal
732 * the position of each component for this RT format.
734 #define VA_RT_FORMAT_RGB32_10BPP 0x00200000
735 #define VA_RT_FORMAT_PROTECTED 0x80000000
737 /** @name Attribute values for VAConfigAttribRateControl */
739 /** \brief Driver does not support any form of rate control. */
740 #define VA_RC_NONE 0x00000001
741 /** \brief Constant bitrate. */
742 #define VA_RC_CBR 0x00000002
743 /** \brief Variable bitrate. */
744 #define VA_RC_VBR 0x00000004
745 /** \brief Video conference mode. */
746 #define VA_RC_VCM 0x00000008
747 /** \brief Constant QP. */
748 #define VA_RC_CQP 0x00000010
749 /** \brief Variable bitrate with peak rate higher than average bitrate. */
750 #define VA_RC_VBR_CONSTRAINED 0x00000020
751 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
752 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
753 #define VA_RC_ICQ 0x00000040
754 /** \brief Macroblock based rate control. Per MB control is decided
755 * internally in the encoder. It may be combined with other RC modes, except CQP. */
756 #define VA_RC_MB 0x00000080
757 /** \brief Constant Frame Size, it is used for small tolerent */
758 #define VA_RC_CFS 0x00000100
759 /** \brief Parallel BRC, for hierachical B.
761 * For hierachical B, B frames can be refered by other B frames.
762 * Currently three layers of hierachy are defined:
763 * B0 - regular B, no reference to other B frames.
764 * B1 - reference to only I, P and regular B0 frames.
765 * B2 - reference to any other frames, including B1.
766 * In Hierachical B structure, B frames on the same layer can be processed
767 * simultaneously. And BRC would adjust accordingly. This is so called
769 #define VA_RC_PARALLEL 0x00000200
773 /** @name Attribute values for VAConfigAttribDecSliceMode */
775 /** \brief Driver supports normal mode for slice decoding */
776 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
777 /** \brief Driver supports base mode for slice decoding */
778 #define VA_DEC_SLICE_MODE_BASE 0x00000002
780 /** @name Attribute values for VAConfigAttribDecJPEG */
782 typedef union _VAConfigAttribValDecJPEG {
784 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
785 uint32_t rotation : 4;
786 /** \brief Reserved for future use. */
787 uint32_t reserved : 28;
790 uint32_t va_reserved[VA_PADDING_LOW];
791 } VAConfigAttribValDecJPEG;
792 /** @name Attribute values for VAConfigAttribDecProcessing */
794 /** \brief No decoding + processing in a single decoding call. */
795 #define VA_DEC_PROCESSING_NONE 0x00000000
796 /** \brief Decode + processing in a single decoding call. */
797 #define VA_DEC_PROCESSING 0x00000001
800 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
802 /** \brief Driver does not support any packed headers mode. */
803 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
805 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
807 * Application must provide it to driver once this flag is returned through
808 * vaGetConfigAttributes()
810 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
812 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
814 * Application must provide it to driver once this falg is returned through
815 * vaGetConfigAttributes()
817 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
819 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
821 * Application must provide it to driver once this flag is returned through
822 * vaGetConfigAttributes()
824 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
826 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
829 * This is a deprecated packed header flag, All applications can use
830 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
831 * header data buffer to the driver
833 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
834 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
835 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
838 /** @name Attribute values for VAConfigAttribEncInterlaced */
840 /** \brief Driver does not support interlaced coding. */
841 #define VA_ENC_INTERLACED_NONE 0x00000000
842 /** \brief Driver supports interlaced frame coding. */
843 #define VA_ENC_INTERLACED_FRAME 0x00000001
844 /** \brief Driver supports interlaced field coding. */
845 #define VA_ENC_INTERLACED_FIELD 0x00000002
846 /** \brief Driver supports macroblock adaptive frame field coding. */
847 #define VA_ENC_INTERLACED_MBAFF 0x00000004
848 /** \brief Driver supports picture adaptive frame field coding. */
849 #define VA_ENC_INTERLACED_PAFF 0x00000008
852 /** @name Attribute values for VAConfigAttribEncSliceStructure */
854 /** \brief Driver supports a power-of-two number of rows per slice. */
855 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
856 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
857 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
858 /** \brief Dirver support 1 rows per slice */
859 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
860 /** \brief Dirver support max encoded slice size per slice */
861 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
862 /** \brief Driver supports an arbitrary number of rows per slice. */
863 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
866 /** \brief Attribute value for VAConfigAttribEncJPEG */
867 typedef union _VAConfigAttribValEncJPEG {
869 /** \brief set to 1 for arithmatic coding. */
870 uint32_t arithmatic_coding_mode : 1;
871 /** \brief set to 1 for progressive dct. */
872 uint32_t progressive_dct_mode : 1;
873 /** \brief set to 1 for non-interleaved. */
874 uint32_t non_interleaved_mode : 1;
875 /** \brief set to 1 for differential. */
876 uint32_t differential_mode : 1;
877 uint32_t max_num_components : 3;
878 uint32_t max_num_scans : 4;
879 uint32_t max_num_huffman_tables : 3;
880 uint32_t max_num_quantization_tables : 3;
883 } VAConfigAttribValEncJPEG;
885 /** @name Attribute values for VAConfigAttribEncQuantization */
887 /** \brief Driver does not support special types of quantization */
888 #define VA_ENC_QUANTIZATION_NONE 0x00000000
889 /** \brief Driver supports trellis quantization */
890 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
893 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
895 /** \brief Driver does not support intra refresh */
896 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
897 /** \brief Driver supports column based rolling intra refresh */
898 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
899 /** \brief Driver supports row based rolling intra refresh */
900 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
901 /** \brief Driver supports adaptive intra refresh */
902 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
903 /** \brief Driver supports cyclic intra refresh */
904 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
905 /** \brief Driver supports intra refresh of P frame*/
906 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
907 /** \brief Driver supports intra refresh of B frame */
908 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
909 /** \brief Driver supports intra refresh of multiple reference encoder */
910 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
914 /** \brief Attribute value for VAConfigAttribEncROI */
915 typedef union _VAConfigAttribValEncROI {
917 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
918 uint32_t num_roi_regions : 8;
920 * \brief A flag indicates whether ROI priority is supported
922 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
923 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
924 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
925 * the underlying driver doesn't support ROI priority.
927 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
928 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
930 uint32_t roi_rc_priority_support : 1;
932 * \brief A flag indicates whether ROI delta QP is supported
934 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
935 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
936 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
937 * the underlying driver doesn't support ROI delta QP.
939 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
940 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
942 uint32_t roi_rc_qp_delta_support : 1;
943 uint32_t reserved : 22;
946 } VAConfigAttribValEncROI;
948 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
949 typedef union _VAConfigAttribValEncRateControlExt {
952 * \brief The maximum number of temporal layers minus 1
954 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
955 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
956 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
958 uint32_t max_num_temporal_layers_minus1 : 8;
961 * /brief support temporal layer bit-rate control flag
963 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
964 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
965 * #VAConfigAttribRateControl == #VA_RC_VBR).
967 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
968 * \c max_num_temporal_layers_minus1 is equal to 0
970 * To use bit-rate control per temporal layer, an application must send the right layer
971 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
972 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
973 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
974 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
975 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
976 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
977 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
979 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
980 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
981 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
983 uint32_t temporal_layer_bitrate_control_flag : 1;
984 uint32_t reserved : 23;
987 } VAConfigAttribValEncRateControlExt;
989 /** @name Attribute values for VAConfigAttribProcessingRate. */
991 /** \brief Driver does not support processing rate report */
992 #define VA_PROCESSING_RATE_NONE 0x00000000
993 /** \brief Driver supports encode processing rate report */
994 #define VA_PROCESSING_RATE_ENCODE 0x00000001
995 /** \brief Driver supports decode processing rate report */
996 #define VA_PROCESSING_RATE_DECODE 0x00000002
999 * if an attribute is not applicable for a given
1000 * profile/entrypoint pair, then set the value to the following
1002 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
1004 /** Get maximum number of profiles supported by the implementation */
1005 int vaMaxNumProfiles (
1009 /** Get maximum number of entrypoints supported by the implementation */
1010 int vaMaxNumEntrypoints (
1014 /** Get maximum number of attributs supported by the implementation */
1015 int vaMaxNumConfigAttributes (
1020 * Query supported profiles
1021 * The caller must provide a "profile_list" array that can hold at
1022 * least vaMaxNumProfile() entries. The actual number of profiles
1023 * returned in "profile_list" is returned in "num_profile".
1025 VAStatus vaQueryConfigProfiles (
1027 VAProfile *profile_list, /* out */
1028 int *num_profiles /* out */
1032 * Query supported entrypoints for a given profile
1033 * The caller must provide an "entrypoint_list" array that can hold at
1034 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
1035 * returned in "entrypoint_list" is returned in "num_entrypoints".
1037 VAStatus vaQueryConfigEntrypoints (
1040 VAEntrypoint *entrypoint_list, /* out */
1041 int *num_entrypoints /* out */
1045 * Get attributes for a given profile/entrypoint pair
1046 * The caller must provide an "attrib_list" with all attributes to be
1047 * retrieved. Upon return, the attributes in "attrib_list" have been
1048 * updated with their value. Unknown attributes or attributes that are
1049 * not supported for the given profile/entrypoint pair will have their
1050 * value set to VA_ATTRIB_NOT_SUPPORTED
1052 VAStatus vaGetConfigAttributes (
1055 VAEntrypoint entrypoint,
1056 VAConfigAttrib *attrib_list, /* in/out */
1060 /** Generic ID type, can be re-typed for specific implementation */
1061 typedef unsigned int VAGenericID;
1063 typedef VAGenericID VAConfigID;
1066 * Create a configuration for the video decode/encode/processing pipeline
1067 * it passes in the attribute list that specifies the attributes it cares
1068 * about, with the rest taking default values.
1070 VAStatus vaCreateConfig (
1073 VAEntrypoint entrypoint,
1074 VAConfigAttrib *attrib_list,
1076 VAConfigID *config_id /* out */
1080 * Free resources associdated with a given config
1082 VAStatus vaDestroyConfig (
1084 VAConfigID config_id
1088 * Query all attributes for a given configuration
1089 * The profile of the configuration is returned in "profile"
1090 * The entrypoint of the configuration is returned in "entrypoint"
1091 * The caller must provide an "attrib_list" array that can hold at least
1092 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1093 * returned in "attrib_list" is returned in "num_attribs"
1095 VAStatus vaQueryConfigAttributes (
1097 VAConfigID config_id,
1098 VAProfile *profile, /* out */
1099 VAEntrypoint *entrypoint, /* out */
1100 VAConfigAttrib *attrib_list,/* out */
1101 int *num_attribs /* out */
1106 * Contexts and Surfaces
1108 * Context represents a "virtual" video decode, encode or video processing
1109 * pipeline. Surfaces are render targets for a given context. The data in the
1110 * surfaces are not accessible to the client except if derived image is supported
1111 * and the internal data format of the surface is implementation specific.
1113 * Surfaces are provided as a hint of what surfaces will be used when the context
1114 * is created through vaCreateContext(). A surface may be used by different contexts
1115 * at the same time as soon as application can make sure the operations are synchronized
1116 * between different contexts, e.g. a surface is used as the output of a decode context
1117 * and the input of a video process context. Surfaces can only be destroyed after all
1118 * contexts using these surfaces have been destroyed.
1120 * Both contexts and surfaces are identified by unique IDs and its
1121 * implementation specific internals are kept opaque to the clients
1124 typedef VAGenericID VAContextID;
1126 typedef VAGenericID VASurfaceID;
1128 #define VA_INVALID_ID 0xffffffff
1129 #define VA_INVALID_SURFACE VA_INVALID_ID
1131 /** \brief Generic value types. */
1133 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1134 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1135 VAGenericValueTypePointer, /**< Generic pointer type */
1136 VAGenericValueTypeFunc /**< Pointer to function */
1137 } VAGenericValueType;
1139 /** \brief Generic function type. */
1140 typedef void (*VAGenericFunc)(void);
1142 /** \brief Generic value. */
1143 typedef struct _VAGenericValue {
1144 /** \brief Value type. See #VAGenericValueType. */
1145 VAGenericValueType type;
1146 /** \brief Value holder. */
1148 /** \brief 32-bit signed integer. */
1150 /** \brief 32-bit float. */
1152 /** \brief Generic pointer. */
1154 /** \brief Pointer to function. */
1159 /** @name Surface attribute flags */
1161 /** \brief Surface attribute is not supported. */
1162 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1163 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1164 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1165 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1166 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1169 /** \brief Surface attribute types. */
1171 VASurfaceAttribNone = 0,
1173 * \brief Pixel format (fourcc).
1175 * The value is meaningful as input to vaQuerySurfaceAttributes().
1176 * If zero, the driver returns the optimal pixel format for the
1177 * specified config. Otherwise, if non-zero, the value represents
1178 * a pixel format (FOURCC) that is kept as is on output, if the
1179 * driver supports it. Otherwise, the driver sets the value to
1180 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1182 VASurfaceAttribPixelFormat,
1183 /** \brief Minimal width in pixels (int, read-only). */
1184 VASurfaceAttribMinWidth,
1185 /** \brief Maximal width in pixels (int, read-only). */
1186 VASurfaceAttribMaxWidth,
1187 /** \brief Minimal height in pixels (int, read-only). */
1188 VASurfaceAttribMinHeight,
1189 /** \brief Maximal height in pixels (int, read-only). */
1190 VASurfaceAttribMaxHeight,
1191 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1192 VASurfaceAttribMemoryType,
1193 /** \brief External buffer descriptor (pointer, write). */
1194 VASurfaceAttribExternalBufferDescriptor,
1195 /** \brief Surface usage hint, gives the driver a hint of intended usage
1196 * to optimize allocation (e.g. tiling) (int, read/write). */
1197 VASurfaceAttribUsageHint,
1198 /** \brief Number of surface attributes. */
1199 VASurfaceAttribCount
1200 } VASurfaceAttribType;
1202 /** \brief Surface attribute. */
1203 typedef struct _VASurfaceAttrib {
1205 VASurfaceAttribType type;
1206 /** \brief Flags. See "Surface attribute flags". */
1208 /** \brief Value. See "Surface attribute types" for the expected types. */
1209 VAGenericValue value;
1213 * @name VASurfaceAttribMemoryType values in bit fields.
1214 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1215 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1216 * types are defined in DRM and Android header files.
1219 /** \brief VA memory type (default) is supported. */
1220 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1221 /** \brief V4L2 buffer memory type is supported. */
1222 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1223 /** \brief User pointer memory type is supported. */
1224 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1228 * \brief VASurfaceAttribExternalBuffers structure for
1229 * the VASurfaceAttribExternalBufferDescriptor attribute.
1231 typedef struct _VASurfaceAttribExternalBuffers {
1232 /** \brief pixel format in fourcc. */
1233 uint32_t pixel_format;
1234 /** \brief width in pixels. */
1236 /** \brief height in pixels. */
1238 /** \brief total size of the buffer in bytes. */
1240 /** \brief number of planes for planar layout */
1241 uint32_t num_planes;
1242 /** \brief pitch for each plane in bytes */
1243 uint32_t pitches[4];
1244 /** \brief offset for each plane in bytes */
1245 uint32_t offsets[4];
1246 /** \brief buffer handles or user pointers */
1248 /** \brief number of elements in the "buffers" array */
1249 uint32_t num_buffers;
1250 /** \brief flags. See "Surface external buffer descriptor flags". */
1252 /** \brief reserved for passing private data */
1254 } VASurfaceAttribExternalBuffers;
1256 /** @name VASurfaceAttribExternalBuffers flags */
1258 /** \brief Enable memory tiling */
1259 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1260 /** \brief Memory is cacheable */
1261 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1262 /** \brief Memory is non-cacheable */
1263 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1264 /** \brief Memory is write-combined */
1265 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1266 /** \brief Memory is protected */
1267 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1269 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1271 /** \brief Surface usage not indicated. */
1272 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1273 /** \brief Surface used by video decoder. */
1274 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1275 /** \brief Surface used by video encoder. */
1276 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1277 /** \brief Surface read by video post-processing. */
1278 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1279 /** \brief Surface written by video post-processing. */
1280 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1281 /** \brief Surface used for display. */
1282 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1287 * \brief Queries surface attributes for the supplied config.
1289 * This function queries for all supported attributes for the
1290 * supplied VA @config. In particular, if the underlying hardware
1291 * supports the creation of VA surfaces in various formats, then
1292 * this function will enumerate all pixel formats that are supported.
1294 * The \c attrib_list array is allocated by the user and \c
1295 * num_attribs shall be initialized to the number of allocated
1296 * elements in that array. Upon successful return, the actual number
1297 * of attributes will be overwritten into \c num_attribs. Otherwise,
1298 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1299 * is adjusted to the number of elements that would be returned if
1300 * enough space was available.
1302 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1303 * argument when vaQuerySurfaceAttributes() is used to determine the
1304 * actual number of elements that need to be allocated.
1306 * @param[in] dpy the VA display
1307 * @param[in] config the config identifying a codec or a video
1308 * processing pipeline
1309 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1310 * @param[in,out] num_attribs the number of elements allocated on
1311 * input, the number of elements actually filled in output
1314 vaQuerySurfaceAttributes(
1317 VASurfaceAttrib *attrib_list,
1318 unsigned int *num_attribs
1322 * \brief Creates an array of surfaces
1324 * Creates an array of surfaces. The optional list of attributes shall
1325 * be constructed based on what the underlying hardware could expose
1326 * through vaQuerySurfaceAttributes().
1328 * @param[in] dpy the VA display
1329 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1330 * @param[in] width the surface width
1331 * @param[in] height the surface height
1332 * @param[out] surfaces the array of newly created surfaces
1333 * @param[in] num_surfaces the number of surfaces to create
1334 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1335 * @param[in] num_attribs the number of attributes supplied in
1336 * \c attrib_list, or zero
1341 unsigned int format,
1343 unsigned int height,
1344 VASurfaceID *surfaces,
1345 unsigned int num_surfaces,
1346 VASurfaceAttrib *attrib_list,
1347 unsigned int num_attribs
1351 * vaDestroySurfaces - Destroy resources associated with surfaces.
1352 * Surfaces can only be destroyed after all contexts using these surfaces have been
1355 * surfaces: array of surfaces to destroy
1356 * num_surfaces: number of surfaces in the array to be destroyed.
1358 VAStatus vaDestroySurfaces (
1360 VASurfaceID *surfaces,
1364 #define VA_PROGRESSIVE 0x1
1366 * vaCreateContext - Create a context
1368 * config_id: configuration for the context
1369 * picture_width: coded picture width
1370 * picture_height: coded picture height
1371 * flag: any combination of the following:
1372 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1373 * render_targets: a hint for render targets (surfaces) tied to the context
1374 * num_render_targets: number of render targets in the above array
1375 * context: created context id upon return
1377 VAStatus vaCreateContext (
1379 VAConfigID config_id,
1383 VASurfaceID *render_targets,
1384 int num_render_targets,
1385 VAContextID *context /* out */
1389 * vaDestroyContext - Destroy a context
1391 * context: context to be destroyed
1393 VAStatus vaDestroyContext (
1398 //Multi-frame context
1399 typedef VAGenericID VAMFContextID;
1401 * vaCreateMFContext - Create a multi-frame context
1402 * interface encapsulating common for all streams memory objects and structures
1403 * required for single GPU task submission from several VAContextID's.
1404 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1405 * Support identification: Application can identify multi-frame feature support by ability
1406 * to create multi-frame context. If driver supports multi-frame - call successful,
1407 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1408 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1410 * VA_STATUS_SUCCESS - operation successful.
1411 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1412 * dpy: display adapter.
1413 * mf_context: Multi-Frame context encapsulating all associated context
1414 * for multi-frame submission.
1416 VAStatus vaCreateMFContext (
1418 VAMFContextID *mf_context /* out */
1422 * vaMFAddContext - Provide ability to associate each context used for
1423 * Multi-Frame submission and common Multi-Frame context.
1424 * Try to add context to understand if it is supported.
1425 * Allocation: this call allocates and/or reallocates all memory objects
1426 * common for all contexts associated with particular Multi-Frame context.
1427 * All memory required for each context(pixel buffers, internal driver
1428 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1429 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1430 * first context added will set entry point/profile for whole Multi-Frame context,
1431 * all other entry points and profiles can be rejected to be added.
1433 * VA_STATUS_SUCCESS - operation successful, context was added.
1434 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1435 * current mf_context and associated contexts and start working with new ones.
1436 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1437 * 1 - mf_context is not valid context or
1438 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1439 * and current context contradicts with previously added, application can continue with current mf_context
1440 * and other contexts passed this call, rejected context can continue work in stand-alone
1441 * mode or other mf_context.
1442 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1443 * unsupported VAEntrypoint. Application can continue with current mf_context
1444 * and other contexts passed this call, rejected context can continue work in stand-alone
1446 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1447 * but VAProfile is not supported. Application can continue with current mf_context
1448 * and other contexts passed this call, rejected context can continue work in stand-alone
1450 * dpy: display adapter.
1451 * context: context being associated with Multi-Frame context.
1452 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1454 VAStatus vaMFAddContext (
1456 VAMFContextID mf_context,
1461 * vaMFReleaseContext - Removes context from multi-frame and
1462 * association with multi-frame context.
1463 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1465 * VA_STATUS_SUCCESS - operation successful, context was removed.
1466 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1467 * application need to destroy this VAMFContextID and all assotiated VAContextID
1469 * mf_context: VAMFContextID where context is added
1470 * context: VAContextID to be added
1472 VAStatus vaMFReleaseContext (
1474 VAMFContextID mf_context,
1480 * Buffers are used to pass various types of data from the
1481 * client to the server. The server maintains a data store
1482 * for each buffer created, and the client idenfies a buffer
1483 * through a unique buffer id assigned by the server.
1486 typedef VAGenericID VABufferID;
1490 VAPictureParameterBufferType = 0,
1491 VAIQMatrixBufferType = 1,
1492 VABitPlaneBufferType = 2,
1493 VASliceGroupMapBufferType = 3,
1494 VASliceParameterBufferType = 4,
1495 VASliceDataBufferType = 5,
1496 VAMacroblockParameterBufferType = 6,
1497 VAResidualDataBufferType = 7,
1498 VADeblockingParameterBufferType = 8,
1499 VAImageBufferType = 9,
1500 VAProtectedSliceDataBufferType = 10,
1501 VAQMatrixBufferType = 11,
1502 VAHuffmanTableBufferType = 12,
1503 VAProbabilityBufferType = 13,
1505 /* Following are encode buffer types */
1506 VAEncCodedBufferType = 21,
1507 VAEncSequenceParameterBufferType = 22,
1508 VAEncPictureParameterBufferType = 23,
1509 VAEncSliceParameterBufferType = 24,
1510 VAEncPackedHeaderParameterBufferType = 25,
1511 VAEncPackedHeaderDataBufferType = 26,
1512 VAEncMiscParameterBufferType = 27,
1513 VAEncMacroblockParameterBufferType = 28,
1514 VAEncMacroblockMapBufferType = 29,
1517 * \brief Encoding QP buffer
1519 * This buffer contains QP per MB for encoding. Currently
1520 * VAEncQPBufferH264 is defined for H.264 encoding, see
1521 * #VAEncQPBufferH264 for details
1523 VAEncQPBufferType = 30,
1524 /* Following are video processing buffer types */
1526 * \brief Video processing pipeline parameter buffer.
1528 * This buffer describes the video processing pipeline. See
1529 * #VAProcPipelineParameterBuffer for details.
1531 VAProcPipelineParameterBufferType = 41,
1533 * \brief Video filter parameter buffer.
1535 * This buffer describes the video filter parameters. All buffers
1536 * inherit from #VAProcFilterParameterBufferBase, thus including
1537 * a unique filter buffer type.
1539 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1540 * Filters requiring advanced parameters include, but are not limited to,
1541 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1542 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1544 VAProcFilterParameterBufferType = 42,
1546 * \brief FEI specific buffer types
1548 VAEncFEIMVBufferType = 43,
1549 VAEncFEIMBCodeBufferType = 44,
1550 VAEncFEIDistortionBufferType = 45,
1551 VAEncFEIMBControlBufferType = 46,
1552 VAEncFEIMVPredictorBufferType = 47,
1553 /** Force MB's to be non skip for encode.it's per-mb control buffer, The width of the MB map
1554 * Surface is (width of the Picture in MB unit) * 1 byte, multiple of 64 bytes.
1555 * The height is (height of the picture in MB unit). The picture is either
1556 * frame or non-interleaved top or bottom field. If the application provides this
1557 *surface, it will override the "skipCheckDisable" setting in VAEncMiscParameterEncQuality.
1559 VAEncMacroblockDisableSkipMapBufferType = 53,
1560 /** decode stream out buffer, intermedia data of decode, it may include MV, MB mode etc.
1561 * it can be used to detect motion and analyze the frame contain */
1562 VADecodeStreamoutBufferType = 56,
1567 * Processing rate parameter for encode.
1569 typedef struct _VAProcessingRateParameterEnc {
1570 /** \brief Profile level */
1572 uint8_t reserved[3];
1573 /** \brief quality level. When set to 0, default quality
1576 uint32_t quality_level;
1577 /** \brief Period between I frames. */
1578 uint32_t intra_period;
1579 /** \brief Period between I/P frames. */
1581 } VAProcessingRateParameterEnc;
1584 * Processing rate parameter for decode.
1586 typedef struct _VAProcessingRateParameterDec {
1587 /** \brief Profile level */
1589 uint8_t reserved0[3];
1591 } VAProcessingRateParameterDec;
1593 typedef struct _VAProcessingRateParameter {
1595 VAProcessingRateParameterEnc proc_buf_enc;
1596 VAProcessingRateParameterDec proc_buf_dec;
1598 } VAProcessingRateParameter;
1601 * \brief Queries processing rate for the supplied config.
1603 * This function queries the processing rate based on parameters in
1604 * \c proc_buf for the given \c config. Upon successful return, the processing
1605 * rate value will be stored in \c processing_rate. Processing rate is
1606 * specified as the number of macroblocks/CTU per second.
1608 * If NULL is passed to the \c proc_buf, the default processing rate for the
1609 * given configuration will be returned.
1611 * @param[in] dpy the VA display
1612 * @param[in] config the config identifying a codec or a video
1613 * processing pipeline
1614 * @param[in] proc_buf the buffer that contains the parameters for
1615 either the encode or decode processing rate
1616 * @param[out] processing_rate processing rate in number of macroblocks per
1617 second constrained by parameters specified in proc_buf
1621 vaQueryProcessingRate(
1624 VAProcessingRateParameter *proc_buf,
1625 unsigned int *processing_rate
1630 VAEncMiscParameterTypeFrameRate = 0,
1631 VAEncMiscParameterTypeRateControl = 1,
1632 VAEncMiscParameterTypeMaxSliceSize = 2,
1633 VAEncMiscParameterTypeAIR = 3,
1634 /** \brief Buffer type used to express a maximum frame size (in bits). */
1635 VAEncMiscParameterTypeMaxFrameSize = 4,
1636 /** \brief Buffer type used for HRD parameters. */
1637 VAEncMiscParameterTypeHRD = 5,
1638 VAEncMiscParameterTypeQualityLevel = 6,
1639 /** \brief Buffer type used for Rolling intra refresh */
1640 VAEncMiscParameterTypeRIR = 7,
1641 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1642 VAEncMiscParameterTypeQuantization = 8,
1643 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1644 * rate control, when the user has externally skipped frames. */
1645 VAEncMiscParameterTypeSkipFrame = 9,
1646 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1647 VAEncMiscParameterTypeROI = 10,
1648 /** \brief Buffer type used for temporal layer structure */
1649 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1650 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1651 VAEncMiscParameterTypeDirtyRect = 13,
1652 /** \brief Buffer type used for parallel BRC parameters. */
1653 VAEncMiscParameterTypeParallelBRC = 14,
1654 /** \brief Set MB partion mode mask and Half-pel/Quant-pel motion search */
1655 VAEncMiscParameterTypeSubMbPartPel = 15,
1656 /** \brief set encode quality tuning */
1657 VAEncMiscParameterTypeEncQuality = 16,
1658 /** \brief Buffer type used for encoder rounding offset parameters. */
1659 VAEncMiscParameterTypeCustomRoundingControl = 17,
1660 /** \brief Buffer type used for FEI input frame level parameters */
1661 VAEncMiscParameterTypeFEIFrameControl = 18,
1662 /** \brief encode extension buffer, ect. MPEG2 Sequence extenstion data */
1663 VAEncMiscParameterTypeExtensionData = 19
1664 } VAEncMiscParameterType;
1666 /** \brief Packed header type. */
1668 /** \brief Packed sequence header. */
1669 VAEncPackedHeaderSequence = 1,
1670 /** \brief Packed picture header. */
1671 VAEncPackedHeaderPicture = 2,
1672 /** \brief Packed slice header. */
1673 VAEncPackedHeaderSlice = 3,
1675 * \brief Packed raw header.
1677 * Packed raw data header can be used by the client to insert a header
1678 * into the bitstream data buffer at the point it is passed, the driver
1679 * will handle the raw packed header based on "has_emulation_bytes" field
1680 * in the packed header parameter structure.
1682 VAEncPackedHeaderRawData = 4,
1684 * \brief Misc packed header. See codec-specific definitions.
1687 * This is a deprecated packed header type. All applications can use
1688 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1690 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1691 } VAEncPackedHeaderType;
1693 /** \brief Packed header parameter. */
1694 typedef struct _VAEncPackedHeaderParameterBuffer {
1695 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1697 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1698 uint32_t bit_length;
1699 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1700 uint8_t has_emulation_bytes;
1702 /** \brief Reserved bytes for future use, must be zero */
1703 uint32_t va_reserved[VA_PADDING_LOW];
1704 } VAEncPackedHeaderParameterBuffer;
1707 * For application, e.g. set a new bitrate
1708 * VABufferID buf_id;
1709 * VAEncMiscParameterBuffer *misc_param;
1710 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1712 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1713 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1714 * 1, NULL, &buf_id);
1716 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1717 * misc_param->type = VAEncMiscParameterTypeRateControl;
1718 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1719 * misc_rate_ctrl->bits_per_second = 6400000;
1720 * vaUnmapBuffer(dpy, buf_id);
1721 * vaRenderPicture(dpy, context, &buf_id, 1);
1723 typedef struct _VAEncMiscParameterBuffer
1725 VAEncMiscParameterType type;
1727 } VAEncMiscParameterBuffer;
1729 /** \brief Temporal layer Structure*/
1730 typedef struct _VAEncMiscParameterTemporalLayerStructure
1732 /** \brief The number of temporal layers */
1733 uint32_t number_of_layers;
1734 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1735 uint32_t periodicity;
1737 * \brief The array indicating the layer id for each frame
1739 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1740 * ids for frames starting from the 2nd frame.
1742 uint32_t layer_id[32];
1744 /** \brief Reserved bytes for future use, must be zero */
1745 uint32_t va_reserved[VA_PADDING_LOW];
1746 } VAEncMiscParameterTemporalLayerStructure;
1749 /** \brief Rate control parameters */
1750 typedef struct _VAEncMiscParameterRateControl
1752 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1753 uint32_t bits_per_second;
1754 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1755 * bit-rate for example if target_percentage is 95 then the rate control will target
1756 * a bit-rate that is 95% of the maximum bit-rate
1758 uint32_t target_percentage;
1759 /* windows size in milliseconds. For example if this is set to 500,
1760 * then the rate control will guarantee the target bit-rate over a 500 ms window
1762 uint32_t window_size;
1763 /* initial QP at I frames */
1764 uint32_t initial_qp;
1766 uint32_t basic_unit_size;
1772 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1773 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1774 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1776 * The temporal layer that the rate control parameters are specified for.
1778 uint32_t temporal_id : 8;
1779 uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1780 uint32_t enable_parallel_brc : 1;
1781 uint32_t enable_dynamic_scaling : 1;
1782 /** \brief Frame Tolerance Mode
1783 * Indicates the tolerance the application has to variations in the frame size.
1784 * For example, wireless display scenarios may require very steady bit rate to
1785 * reduce buffering time. It affects the rate control algorithm used,
1786 * but may or may not have an effect based on the combination of other BRC
1787 * parameters. Only valid when the driver reports support for
1788 * #VAConfigAttribFrameSizeToleranceSupport.
1790 * equals 0 -- normal mode;
1791 * equals 1 -- maps to sliding window;
1792 * equals 2 -- maps to low delay mode;
1795 uint32_t frame_tolerance_mode : 2;
1796 uint32_t reserved : 12;
1800 uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1801 /** \brief Reserved bytes for future use, must be zero */
1803 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1804 } VAEncMiscParameterRateControl;
1806 typedef struct _VAEncMiscParameterFrameRate
1809 * The framerate is specified as a number of frames per second, as a
1810 * fraction. The denominator of the fraction is given in the top half
1811 * (the high two bytes) of the framerate field, and the numerator is
1812 * given in the bottom half (the low two bytes).
1815 * denominator = framerate >> 16 & 0xffff;
1816 * numerator = framerate & 0xffff;
1817 * fps = numerator / denominator;
1819 * For example, if framerate is set to (100 << 16 | 750), this is
1820 * 750 / 100, hence 7.5fps.
1822 * If the denominator is zero (the high two bytes are both zero) then
1823 * it takes the value one instead, so the framerate is just the integer
1824 * in the low 2 bytes.
1832 * The temporal id the framerate parameters are specified for.
1834 uint32_t temporal_id : 8;
1835 uint32_t reserved : 24;
1840 /** \brief Reserved bytes for future use, must be zero */
1841 uint32_t va_reserved[VA_PADDING_LOW];
1842 } VAEncMiscParameterFrameRate;
1845 * Allow a maximum slice size to be specified (in bits).
1846 * The encoder will attempt to make sure that individual slices do not exceed this size
1847 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1849 typedef struct _VAEncMiscParameterMaxSliceSize
1851 uint32_t max_slice_size;
1853 /** \brief Reserved bytes for future use, must be zero */
1854 uint32_t va_reserved[VA_PADDING_LOW];
1855 } VAEncMiscParameterMaxSliceSize;
1857 typedef struct _VAEncMiscParameterAIR
1859 uint32_t air_num_mbs;
1860 uint32_t air_threshold;
1861 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1863 /** \brief Reserved bytes for future use, must be zero */
1864 uint32_t va_reserved[VA_PADDING_LOW];
1865 } VAEncMiscParameterAIR;
1868 * \brief Rolling intra refresh data structure for encoding.
1870 typedef struct _VAEncMiscParameterRIR
1876 * \brief Indicate if intra refresh is enabled in column/row.
1878 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1879 * by the driver before sending this structure.
1882 /* \brief enable RIR in column */
1883 uint32_t enable_rir_column : 1;
1884 /* \brief enable RIR in row */
1885 uint32_t enable_rir_row : 1;
1886 uint32_t reserved : 30;
1891 * \brief Indicates the column or row location in MB. It is ignored if
1894 uint16_t intra_insertion_location;
1896 * \brief Indicates the number of columns or rows in MB. It is ignored if
1899 uint16_t intra_insert_size;
1901 * \brief indicates the Qp difference for inserted intra columns or rows.
1902 * App can use this to adjust intra Qp based on bitrate & max frame size.
1904 uint8_t qp_delta_for_inserted_intra;
1905 /** \brief Reserved bytes for future use, must be zero */
1906 uint32_t va_reserved[VA_PADDING_LOW];
1907 } VAEncMiscParameterRIR;
1909 typedef struct _VAEncMiscParameterHRD
1911 uint32_t initial_buffer_fullness; /* in bits */
1912 uint32_t buffer_size; /* in bits */
1914 /** \brief Reserved bytes for future use, must be zero */
1915 uint32_t va_reserved[VA_PADDING_LOW];
1916 } VAEncMiscParameterHRD;
1919 * \brief Defines a maximum frame size (in bits).
1921 * This misc parameter buffer defines the maximum size of a frame (in
1922 * bits). The encoder will try to make sure that each frame does not
1923 * exceed this size. Otherwise, if the frame size exceeds this size,
1924 * the \c status flag of #VACodedBufferSegment will contain
1925 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1927 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1928 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1929 VAEncMiscParameterType type;
1930 /** \brief Maximum size of a frame (in bits). */
1931 uint32_t max_frame_size;
1933 /** \brief Reserved bytes for future use, must be zero */
1934 uint32_t va_reserved[VA_PADDING_LOW];
1935 } VAEncMiscParameterBufferMaxFrameSize;
1938 * \brief Encoding quality level.
1940 * The encoding quality could be set through this structure, if the implementation
1941 * supports multiple quality levels. The quality level set through this structure is
1942 * persistent over the entire coded sequence, or until a new structure is being sent.
1943 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1944 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1945 * quality. The quality level setting is used as a trade-off between quality and speed/power
1946 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1948 typedef struct _VAEncMiscParameterBufferQualityLevel {
1949 /** \brief Encoding quality level setting. When set to 0, default quality
1952 uint32_t quality_level;
1954 /** \brief Reserved bytes for future use, must be zero */
1955 uint32_t va_reserved[VA_PADDING_LOW];
1956 } VAEncMiscParameterBufferQualityLevel;
1959 * \brief Quantization settings for encoding.
1961 * Some encoders support special types of quantization such as trellis, and this structure
1962 * can be used by the app to control these special types of quantization by the encoder.
1964 typedef struct _VAEncMiscParameterQuantization
1968 /* if no flags is set then quantization is determined by the driver */
1971 /* \brief disable trellis for all frames/fields */
1972 uint64_t disable_trellis : 1;
1973 /* \brief enable trellis for I frames/fields */
1974 uint64_t enable_trellis_I : 1;
1975 /* \brief enable trellis for P frames/fields */
1976 uint64_t enable_trellis_P : 1;
1977 /* \brief enable trellis for B frames/fields */
1978 uint64_t enable_trellis_B : 1;
1979 uint64_t reserved : 28;
1982 } quantization_flags;
1983 } VAEncMiscParameterQuantization;
1986 * \brief Encoding skip frame.
1988 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1989 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1990 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1991 * current frame. It is allowed for the application to still send in packed headers for the driver to
1992 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1994 typedef struct _VAEncMiscParameterSkipFrame {
1995 /** \brief Indicates skip frames as below.
1996 * 0: Encode as normal, no skip.
1997 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1998 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1999 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
2000 * in VAEncPackedHeaderPicture). */
2001 uint8_t skip_frame_flag;
2002 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
2003 uint8_t num_skip_frames;
2004 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
2005 * the size of the current skipped frame that is to be packed/encrypted in bits. */
2006 uint32_t size_skip_frames;
2008 /** \brief Reserved bytes for future use, must be zero */
2009 uint32_t va_reserved[VA_PADDING_LOW];
2010 } VAEncMiscParameterSkipFrame;
2013 * \brief Encoding region-of-interest (ROI).
2015 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
2016 * supports ROI input. The ROI set through this structure is applicable only to the
2017 * current frame or field, so must be sent every frame or field to be applied. The number of
2018 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
2019 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
2021 typedef struct _VAEncROI
2023 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
2024 * codec coding units. It is relative to frame coordinates for the frame case and
2025 * to field coordinates for the field case. */
2026 VARectangle roi_rectangle;
2030 * \ref roi_value specifies ROI delta QP or ROI priority.
2031 * -- ROI delta QP is the value that will be added on top of the frame level QP.
2032 * -- ROI priority specifies the priority of a region, it can be positive (more important)
2033 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2034 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2035 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2036 * regions, the roi_value that is first in the ROI array will have priority.
2038 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2039 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2041 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2042 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2043 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2048 typedef struct _VAEncMiscParameterBufferROI {
2049 /** \brief Number of ROIs being sent.*/
2052 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2053 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
2055 int8_t max_delta_qp;
2056 int8_t min_delta_qp;
2058 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
2059 * coordinates for the frame case and to field coordinates for the field case.*/
2064 * \brief An indication for roi value.
2066 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2067 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2068 * in #VAEncROI should be used as ROI priority.
2070 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2071 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2072 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2073 * when VAConfigAttribRateControl == VA_RC_CQP.
2075 uint32_t roi_value_is_qp_delta : 1;
2076 uint32_t reserved : 31;
2081 /** \brief Reserved bytes for future use, must be zero */
2082 uint32_t va_reserved[VA_PADDING_LOW];
2083 } VAEncMiscParameterBufferROI;
2085 * \brief Dirty rectangle data structure for encoding.
2087 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2088 * implementation supports dirty rect input. The rect set through this structure is applicable
2089 * only to the current frame or field, so must be sent every frame or field to be applied.
2090 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
2091 * encoder will use the rect information to know those rectangle areas have changed while the
2092 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2093 * previous picture. The encoder may do some internal optimizations.
2095 typedef struct _VAEncMiscParameterBufferDirtyRect
2097 /** \brief Number of Rectangle being sent.*/
2098 uint32_t num_roi_rectangle;
2100 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2101 VARectangle *roi_rectangle;
2102 } VAEncMiscParameterBufferDirtyRect;
2104 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2105 typedef struct _VAEncMiscParameterParallelRateControl {
2106 /** brief Number of layers*/
2107 uint32_t num_layers;
2108 /** brief Number of B frames per layer per GOP.
2110 * it should be allocated by application, and the is num_layers.
2111 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2112 uint32_t *num_b_in_gop;
2113 } VAEncMiscParameterParallelRateControl;
2115 /** per frame encoder quality controls, once set they will persist for all future frames
2116 *till it is updated again. */
2117 typedef struct _VAEncMiscParameterEncQuality
2123 /** Use raw frames for reference instead of reconstructed frames.
2124 * it only impact motion estimation (ME) stage, and will not impact MC stage
2125 * so the reconstruct picture will can match with decode side */
2126 uint32_t useRawPicForRef : 1;
2127 /** Disables skip check for ME stage, it will increase the bistream size
2128 * but will improve the qulity */
2129 uint32_t skipCheckDisable : 1;
2130 /** Indicates app will override default driver FTQ settings using FTQEnable.
2131 * FTQ is forward transform quantization */
2132 uint32_t FTQOverride : 1;
2133 /** Enables/disables FTQ. */
2134 uint32_t FTQEnable : 1;
2135 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2136 * enabled (FTQSkipThresholdLUT), else default driver thresholds will be used. */
2137 uint32_t FTQSkipThresholdLUTInput : 1;
2138 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2139 * disabled (NonFTQSkipThresholdLUT), else default driver thresholds will be used. */
2140 uint32_t NonFTQSkipThresholdLUTInput : 1;
2141 uint32_t ReservedBit : 1;
2142 /** Control to enable the ME mode decision algorithm to bias to fewer B Direct/Skip types.
2143 * Applies only to B frames, all other frames will ignore this setting. */
2144 uint32_t directBiasAdjustmentEnable : 1;
2145 /** Enables global motion bias. global motion also is called HME (Heirarchical Motion Estimation )
2146 * HME is used to handle large motions and avoiding local minima in the video encoding process
2147 * down scaled the input and reference picture, then do ME. the result will be a predictor to next level HME or ME
2148 * current interface divide the HME to 3 level. UltraHME , SuperHME, and HME, result of UltraHME will be input of SurperHME,
2149 * result of superHME will be a input for HME. HME result will be input of ME. it is a switch for HMEMVCostScalingFactor
2150 * can change the HME bias inside RDO stage*/
2151 uint32_t globalMotionBiasAdjustmentEnable : 1;
2152 /** MV cost scaling ratio for HME ( predictors. It is used when
2153 * globalMotionBiasAdjustmentEnable == 1, else it is ignored. Values are:
2154 * 0: set MV cost to be 0 for HME predictor.
2155 * 1: scale MV cost to be 1/2 of the default value for HME predictor.
2156 * 2: scale MV cost to be 1/4 of the default value for HME predictor.
2157 * 3: scale MV cost to be 1/8 of the default value for HME predictor. */
2158 uint32_t HMEMVCostScalingFactor : 2;
2159 /**disable HME, if it is disabled. Super*ultraHME should also be disabled */
2160 uint32_t HMEDisable : 1;
2161 /**disable Super HME, if it is disabled, ultraHME should be disabled */
2162 uint32_t SuperHMEDisable : 1;
2163 /** disable Ultra HME */
2164 uint32_t UltraHMEDisable : 1;
2165 /** disable panic mode. Panic mode happened when there are extreme BRC (bit rate control) requirement
2166 * frame size cant achieve the target of BRC. when Panic mode is triggered, Coefficients will
2167 * be set to zero. disable panic mode will improve quality but will impact BRC */
2168 uint32_t PanicModeDisable : 1;
2169 /** Force RepartitionCheck
2170 * 0: DEFAULT - follow driver default settings.
2171 * 1: FORCE_ENABLE - enable this feature totally for all cases.
2172 * 2: FORCE_DISABLE - disable this feature totally for all cases. */
2173 uint32_t ForceRepartitionCheck : 2;
2176 uint32_t encControls;
2179 /** Maps QP to skip thresholds when FTQ is enabled. Valid range is 0-255. */
2180 uint8_t FTQSkipThresholdLUT[52];
2181 /** Maps QP to skip thresholds when FTQ is disabled. Valid range is 0-65535. */
2182 uint16_t NonFTQSkipThresholdLUT[52];
2184 uint32_t reserved[VA_PADDING_HIGH]; // Reserved for future use.
2186 } VAEncMiscParameterEncQuality;
2189 * \brief Custom Encoder Rounding Offset Control.
2190 * Application may use this structure to set customized rounding
2191 * offset parameters for quantization.
2192 * Valid when \c VAConfigAttribCustomRoundingControl equals 1.
2194 typedef struct _VAEncMiscParameterCustomRoundingControl
2198 /** \brief Enable customized rounding offset for intra blocks.
2199 * If 0, default value would be taken by driver for intra
2202 uint32_t enable_custom_rouding_intra : 1 ;
2204 /** \brief Intra rounding offset
2205 * Ignored if \c enable_custom_rouding_intra equals 0.
2207 uint32_t rounding_offset_intra : 7;
2209 /** \brief Enable customized rounding offset for inter blocks.
2210 * If 0, default value would be taken by driver for inter
2213 uint32_t enable_custom_rounding_inter : 1 ;
2215 /** \brief Inter rounding offset
2216 * Ignored if \c enable_custom_rouding_inter equals 0.
2218 uint32_t rounding_offset_inter : 7;
2221 uint32_t reserved :16;
2224 } rounding_offset_setting;
2225 } VAEncMiscParameterCustomRoundingControl;
2227 * There will be cases where the bitstream buffer will not have enough room to hold
2228 * the data for the entire slice, and the following flags will be used in the slice
2229 * parameter to signal to the server for the possible cases.
2230 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2231 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2232 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2234 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2235 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2236 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2237 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2239 /* Codec-independent Slice Parameter Buffer base */
2240 typedef struct _VASliceParameterBufferBase
2242 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2243 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2244 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2245 } VASliceParameterBufferBase;
2247 /**********************************
2248 * JPEG common data structures
2249 **********************************/
2251 * \brief Huffman table for JPEG decoding.
2253 * This structure holds the complete Huffman tables. This is an
2254 * aggregation of all Huffman table (DHT) segments maintained by the
2255 * application. i.e. up to 2 Huffman tables are stored in there for
2258 * The #load_huffman_table array can be used as a hint to notify the
2259 * VA driver implementation about which table(s) actually changed
2260 * since the last submission of this buffer.
2262 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2263 /** \brief Specifies which #huffman_table is valid. */
2264 uint8_t load_huffman_table[2];
2265 /** \brief Huffman tables indexed by table identifier (Th). */
2267 /** @name DC table (up to 12 categories) */
2269 /** \brief Number of Huffman codes of length i + 1 (Li). */
2270 uint8_t num_dc_codes[16];
2271 /** \brief Value associated with each Huffman code (Vij). */
2272 uint8_t dc_values[12];
2274 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2276 /** \brief Number of Huffman codes of length i + 1 (Li). */
2277 uint8_t num_ac_codes[16];
2278 /** \brief Value associated with each Huffman code (Vij). */
2279 uint8_t ac_values[162];
2280 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2285 /** \brief Reserved bytes for future use, must be zero */
2286 uint32_t va_reserved[VA_PADDING_LOW];
2287 } VAHuffmanTableBufferJPEGBaseline;
2289 /****************************
2290 * MPEG-2 data structures
2291 ****************************/
2293 /* MPEG-2 Picture Parameter Buffer */
2295 * For each frame or field, and before any slice data, a single
2296 * picture parameter buffer must be send.
2298 typedef struct _VAPictureParameterBufferMPEG2
2300 uint16_t horizontal_size;
2301 uint16_t vertical_size;
2302 VASurfaceID forward_reference_picture;
2303 VASurfaceID backward_reference_picture;
2304 /* meanings of the following fields are the same as in the standard */
2305 int32_t picture_coding_type;
2306 int32_t f_code; /* pack all four fcode into this */
2309 uint32_t intra_dc_precision : 2;
2310 uint32_t picture_structure : 2;
2311 uint32_t top_field_first : 1;
2312 uint32_t frame_pred_frame_dct : 1;
2313 uint32_t concealment_motion_vectors : 1;
2314 uint32_t q_scale_type : 1;
2315 uint32_t intra_vlc_format : 1;
2316 uint32_t alternate_scan : 1;
2317 uint32_t repeat_first_field : 1;
2318 uint32_t progressive_frame : 1;
2319 uint32_t is_first_field : 1; /* indicate whether the current field
2320 * is the first field for field picture
2324 } picture_coding_extension;
2326 /** \brief Reserved bytes for future use, must be zero */
2327 uint32_t va_reserved[VA_PADDING_LOW];
2328 } VAPictureParameterBufferMPEG2;
2330 /** MPEG-2 Inverse Quantization Matrix Buffer */
2331 typedef struct _VAIQMatrixBufferMPEG2
2333 /** \brief Same as the MPEG-2 bitstream syntax element. */
2334 int32_t load_intra_quantiser_matrix;
2335 /** \brief Same as the MPEG-2 bitstream syntax element. */
2336 int32_t load_non_intra_quantiser_matrix;
2337 /** \brief Same as the MPEG-2 bitstream syntax element. */
2338 int32_t load_chroma_intra_quantiser_matrix;
2339 /** \brief Same as the MPEG-2 bitstream syntax element. */
2340 int32_t load_chroma_non_intra_quantiser_matrix;
2341 /** \brief Luminance intra matrix, in zig-zag scan order. */
2342 uint8_t intra_quantiser_matrix[64];
2343 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2344 uint8_t non_intra_quantiser_matrix[64];
2345 /** \brief Chroma intra matrix, in zig-zag scan order. */
2346 uint8_t chroma_intra_quantiser_matrix[64];
2347 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2348 uint8_t chroma_non_intra_quantiser_matrix[64];
2350 /** \brief Reserved bytes for future use, must be zero */
2351 uint32_t va_reserved[VA_PADDING_LOW];
2352 } VAIQMatrixBufferMPEG2;
2354 /** MPEG-2 Slice Parameter Buffer */
2355 typedef struct _VASliceParameterBufferMPEG2
2357 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2358 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2359 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2360 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2361 uint32_t slice_horizontal_position;
2362 uint32_t slice_vertical_position;
2363 int32_t quantiser_scale_code;
2364 int32_t intra_slice_flag;
2366 /** \brief Reserved bytes for future use, must be zero */
2367 uint32_t va_reserved[VA_PADDING_LOW];
2368 } VASliceParameterBufferMPEG2;
2370 /** MPEG-2 Macroblock Parameter Buffer */
2371 typedef struct _VAMacroblockParameterBufferMPEG2
2373 uint16_t macroblock_address;
2375 * macroblock_address (in raster scan order)
2377 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2379 uint8_t macroblock_type; /* see definition below */
2382 uint32_t frame_motion_type : 2;
2383 uint32_t field_motion_type : 2;
2384 uint32_t dct_type : 1;
2388 uint8_t motion_vertical_field_select;
2390 * motion_vertical_field_select:
2391 * see section 6.3.17.2 in the spec
2392 * only the lower 4 bits are used
2393 * bit 0: first vector forward
2394 * bit 1: first vector backward
2395 * bit 2: second vector forward
2396 * bit 3: second vector backward
2398 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2399 uint16_t coded_block_pattern;
2401 * The bitplanes for coded_block_pattern are described
2402 * in Figure 6.10-12 in the spec
2405 /* Number of skipped macroblocks after this macroblock */
2406 uint16_t num_skipped_macroblocks;
2408 /** \brief Reserved bytes for future use, must be zero */
2409 uint32_t va_reserved[VA_PADDING_LOW];
2410 } VAMacroblockParameterBufferMPEG2;
2413 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2415 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2416 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2417 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2418 #define VA_MB_TYPE_MOTION_INTRA 0x10
2421 * MPEG-2 Residual Data Buffer
2422 * For each macroblock, there wil be 64 shorts (16-bit) in the
2423 * residual data buffer
2426 /****************************
2427 * MPEG-4 Part 2 data structures
2428 ****************************/
2430 /* MPEG-4 Picture Parameter Buffer */
2432 * For each frame or field, and before any slice data, a single
2433 * picture parameter buffer must be send.
2435 typedef struct _VAPictureParameterBufferMPEG4
2438 uint16_t vop_height;
2439 VASurfaceID forward_reference_picture;
2440 VASurfaceID backward_reference_picture;
2443 uint32_t short_video_header : 1;
2444 uint32_t chroma_format : 2;
2445 uint32_t interlaced : 1;
2446 uint32_t obmc_disable : 1;
2447 uint32_t sprite_enable : 2;
2448 uint32_t sprite_warping_accuracy : 2;
2449 uint32_t quant_type : 1;
2450 uint32_t quarter_sample : 1;
2451 uint32_t data_partitioned : 1;
2452 uint32_t reversible_vlc : 1;
2453 uint32_t resync_marker_disable : 1;
2457 uint8_t no_of_sprite_warping_points;
2458 int16_t sprite_trajectory_du[3];
2459 int16_t sprite_trajectory_dv[3];
2460 uint8_t quant_precision;
2463 uint32_t vop_coding_type : 2;
2464 uint32_t backward_reference_vop_coding_type : 2;
2465 uint32_t vop_rounding_type : 1;
2466 uint32_t intra_dc_vlc_thr : 3;
2467 uint32_t top_field_first : 1;
2468 uint32_t alternate_vertical_scan_flag : 1;
2472 uint8_t vop_fcode_forward;
2473 uint8_t vop_fcode_backward;
2474 uint16_t vop_time_increment_resolution;
2475 /* short header related */
2476 uint8_t num_gobs_in_vop;
2477 uint8_t num_macroblocks_in_gob;
2478 /* for direct mode prediction */
2482 /** \brief Reserved bytes for future use, must be zero */
2483 uint32_t va_reserved[VA_PADDING_LOW];
2484 } VAPictureParameterBufferMPEG4;
2486 /** MPEG-4 Inverse Quantization Matrix Buffer */
2487 typedef struct _VAIQMatrixBufferMPEG4
2489 /** Same as the MPEG-4:2 bitstream syntax element. */
2490 int32_t load_intra_quant_mat;
2491 /** Same as the MPEG-4:2 bitstream syntax element. */
2492 int32_t load_non_intra_quant_mat;
2493 /** The matrix for intra blocks, in zig-zag scan order. */
2494 uint8_t intra_quant_mat[64];
2495 /** The matrix for non-intra blocks, in zig-zag scan order. */
2496 uint8_t non_intra_quant_mat[64];
2498 /** \brief Reserved bytes for future use, must be zero */
2499 uint32_t va_reserved[VA_PADDING_LOW];
2500 } VAIQMatrixBufferMPEG4;
2502 /** MPEG-4 Slice Parameter Buffer */
2503 typedef struct _VASliceParameterBufferMPEG4
2505 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2506 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2507 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2508 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2509 uint32_t macroblock_number;
2510 int32_t quant_scale;
2512 /** \brief Reserved bytes for future use, must be zero */
2513 uint32_t va_reserved[VA_PADDING_LOW];
2514 } VASliceParameterBufferMPEG4;
2517 VC-1 data structures
2520 typedef enum /* see 7.1.1.32 */
2523 VAMvMode1MvHalfPel = 1,
2524 VAMvMode1MvHalfPelBilinear = 2,
2525 VAMvModeMixedMv = 3,
2526 VAMvModeIntensityCompensation = 4
2529 /** VC-1 Picture Parameter Buffer */
2531 * For each picture, and before any slice data, a picture parameter
2532 * buffer must be send. Multiple picture parameter buffers may be
2533 * sent for a single picture. In that case picture parameters will
2534 * apply to all slice data that follow it until a new picture
2535 * parameter buffer is sent.
2538 * pic_quantizer_type should be set to the applicable quantizer
2539 * type as defined by QUANTIZER (J.1.19) and either
2540 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2542 typedef struct _VAPictureParameterBufferVC1
2544 VASurfaceID forward_reference_picture;
2545 VASurfaceID backward_reference_picture;
2546 /* if out-of-loop post-processing is done on the render
2547 target, then we need to keep the in-loop decoded
2548 picture as a reference picture */
2549 VASurfaceID inloop_decoded_picture;
2551 /* sequence layer for AP or meta data for SP and MP */
2554 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2555 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2556 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2557 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2558 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2559 uint32_t multires : 1; /* METADATA::MULTIRES */
2560 uint32_t overlap : 1; /* METADATA::OVERLAP */
2561 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2562 uint32_t rangered : 1; /* METADATA::RANGERED */
2563 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2564 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2569 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2570 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2573 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2574 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2575 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2576 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2579 } entrypoint_fields;
2580 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2581 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2584 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2585 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2586 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2587 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2590 } range_mapping_fields;
2592 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2593 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2594 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2595 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2596 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2597 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2598 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2599 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2600 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2604 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2605 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2606 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2607 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2608 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2614 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2615 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2616 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2617 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2618 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2619 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2620 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2626 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2627 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2628 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2629 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2630 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2631 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2632 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2635 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2638 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2639 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2640 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2641 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2647 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2648 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2649 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2650 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2651 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2652 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2653 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2654 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2655 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2656 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2662 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2663 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2664 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2665 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2666 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2667 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2668 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2669 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2670 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2671 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2672 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2675 } pic_quantizer_fields;
2678 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2679 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2680 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2681 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2682 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2683 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2688 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2689 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2690 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2692 /** \brief Reserved bytes for future use, must be zero */
2693 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2694 } VAPictureParameterBufferVC1;
2696 /** VC-1 Bitplane Buffer
2697 There will be at most three bitplanes coded in any picture header. To send
2698 the bitplane data more efficiently, each byte is divided in two nibbles, with
2699 each nibble carrying three bitplanes for one macroblock. The following table
2700 shows the bitplane data arrangement within each nibble based on the picture
2703 Picture Type Bit3 Bit2 Bit1 Bit0
2704 I or BI OVERFLAGS ACPRED FIELDTX
2705 P MYTYPEMB SKIPMB DIRECTMB
2706 B FORWARDMB SKIPMB DIRECTMB
2708 Within each byte, the lower nibble is for the first MB and the upper nibble is
2709 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2710 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2711 Macroblock #2 in the first row.
2714 /* VC-1 Slice Parameter Buffer */
2715 typedef struct _VASliceParameterBufferVC1
2717 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2718 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2719 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2720 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2721 uint32_t slice_vertical_position;
2723 /** \brief Reserved bytes for future use, must be zero */
2724 uint32_t va_reserved[VA_PADDING_LOW];
2725 } VASliceParameterBufferVC1;
2727 /* VC-1 Slice Data Buffer */
2729 This is simplely a buffer containing raw bit-stream bytes
2732 /****************************
2733 * H.264/AVC data structures
2734 ****************************/
2736 typedef struct _VAPictureH264
2738 VASurfaceID picture_id;
2741 int32_t TopFieldOrderCnt;
2742 int32_t BottomFieldOrderCnt;
2744 /** \brief Reserved bytes for future use, must be zero */
2745 uint32_t va_reserved[VA_PADDING_LOW];
2747 /* flags in VAPictureH264 could be OR of the following */
2748 #define VA_PICTURE_H264_INVALID 0x00000001
2749 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2750 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2751 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2752 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2754 /** H.264 Picture Parameter Buffer */
2756 * For each picture, and before any slice data, a single
2757 * picture parameter buffer must be send.
2759 typedef struct _VAPictureParameterBufferH264
2761 VAPictureH264 CurrPic;
2762 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2763 uint16_t picture_width_in_mbs_minus1;
2764 uint16_t picture_height_in_mbs_minus1;
2765 uint8_t bit_depth_luma_minus8;
2766 uint8_t bit_depth_chroma_minus8;
2767 uint8_t num_ref_frames;
2770 uint32_t chroma_format_idc : 2;
2771 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2772 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2773 uint32_t frame_mbs_only_flag : 1;
2774 uint32_t mb_adaptive_frame_field_flag : 1;
2775 uint32_t direct_8x8_inference_flag : 1;
2776 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2777 uint32_t log2_max_frame_num_minus4 : 4;
2778 uint32_t pic_order_cnt_type : 2;
2779 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2780 uint32_t delta_pic_order_always_zero_flag : 1;
2784 // FMO is not supported.
2785 va_deprecated uint8_t num_slice_groups_minus1;
2786 va_deprecated uint8_t slice_group_map_type;
2787 va_deprecated uint16_t slice_group_change_rate_minus1;
2788 int8_t pic_init_qp_minus26;
2789 int8_t pic_init_qs_minus26;
2790 int8_t chroma_qp_index_offset;
2791 int8_t second_chroma_qp_index_offset;
2794 uint32_t entropy_coding_mode_flag : 1;
2795 uint32_t weighted_pred_flag : 1;
2796 uint32_t weighted_bipred_idc : 2;
2797 uint32_t transform_8x8_mode_flag : 1;
2798 uint32_t field_pic_flag : 1;
2799 uint32_t constrained_intra_pred_flag : 1;
2800 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2801 uint32_t deblocking_filter_control_present_flag : 1;
2802 uint32_t redundant_pic_cnt_present_flag : 1;
2803 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2809 /** \brief Reserved bytes for future use, must be zero */
2810 uint32_t va_reserved[VA_PADDING_MEDIUM];
2811 } VAPictureParameterBufferH264;
2813 /** H.264 Inverse Quantization Matrix Buffer */
2814 typedef struct _VAIQMatrixBufferH264
2816 /** \brief 4x4 scaling list, in raster scan order. */
2817 uint8_t ScalingList4x4[6][16];
2818 /** \brief 8x8 scaling list, in raster scan order. */
2819 uint8_t ScalingList8x8[2][64];
2821 /** \brief Reserved bytes for future use, must be zero */
2822 uint32_t va_reserved[VA_PADDING_LOW];
2823 } VAIQMatrixBufferH264;
2825 /** H.264 Slice Parameter Buffer */
2826 typedef struct _VASliceParameterBufferH264
2828 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2829 /** \brief Byte offset to the NAL Header Unit for this slice. */
2830 uint32_t slice_data_offset;
2831 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2833 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2835 * This bit offset is relative to and includes the NAL unit byte
2836 * and represents the number of bits parsed in the slice_header()
2837 * after the removal of any emulation prevention bytes in
2838 * there. However, the slice data buffer passed to the hardware is
2839 * the original bitstream, thus including any emulation prevention
2842 uint16_t slice_data_bit_offset;
2843 uint16_t first_mb_in_slice;
2845 uint8_t direct_spatial_mv_pred_flag;
2847 * H264/AVC syntax element
2849 * if num_ref_idx_active_override_flag equals 0, host decoder should
2850 * set its value to num_ref_idx_l0_default_active_minus1.
2852 uint8_t num_ref_idx_l0_active_minus1;
2854 * H264/AVC syntax element
2856 * if num_ref_idx_active_override_flag equals 0, host decoder should
2857 * set its value to num_ref_idx_l1_default_active_minus1.
2859 uint8_t num_ref_idx_l1_active_minus1;
2860 uint8_t cabac_init_idc;
2861 int8_t slice_qp_delta;
2862 uint8_t disable_deblocking_filter_idc;
2863 int8_t slice_alpha_c0_offset_div2;
2864 int8_t slice_beta_offset_div2;
2865 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2866 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2867 uint8_t luma_log2_weight_denom;
2868 uint8_t chroma_log2_weight_denom;
2869 uint8_t luma_weight_l0_flag;
2870 int16_t luma_weight_l0[32];
2871 int16_t luma_offset_l0[32];
2872 uint8_t chroma_weight_l0_flag;
2873 int16_t chroma_weight_l0[32][2];
2874 int16_t chroma_offset_l0[32][2];
2875 uint8_t luma_weight_l1_flag;
2876 int16_t luma_weight_l1[32];
2877 int16_t luma_offset_l1[32];
2878 uint8_t chroma_weight_l1_flag;
2879 int16_t chroma_weight_l1[32][2];
2880 int16_t chroma_offset_l1[32][2];
2882 /** \brief Reserved bytes for future use, must be zero */
2883 uint32_t va_reserved[VA_PADDING_LOW];
2884 } VASliceParameterBufferH264;
2886 /****************************
2887 * Common encode data structures
2888 ****************************/
2891 VAEncPictureTypeIntra = 0,
2892 VAEncPictureTypePredictive = 1,
2893 VAEncPictureTypeBidirectional = 2,
2896 /* Encode Slice Parameter Buffer */
2897 typedef struct _VAEncSliceParameterBuffer
2899 uint32_t start_row_number; /* starting MB row number for this slice */
2900 uint32_t slice_height; /* slice height measured in MB */
2903 uint32_t is_intra : 1;
2904 uint32_t disable_deblocking_filter_idc : 2;
2905 uint32_t uses_long_term_ref :1;
2906 uint32_t is_long_term_ref :1;
2911 /** \brief Reserved bytes for future use, must be zero */
2912 uint32_t va_reserved[VA_PADDING_LOW];
2913 } VAEncSliceParameterBuffer;
2916 /****************************
2917 * H.263 specific encode data structures
2918 ****************************/
2920 typedef struct _VAEncSequenceParameterBufferH263
2922 uint32_t intra_period;
2923 uint32_t bits_per_second;
2924 uint32_t frame_rate;
2925 uint32_t initial_qp;
2928 /** \brief Reserved bytes for future use, must be zero */
2929 uint32_t va_reserved[VA_PADDING_LOW];
2930 } VAEncSequenceParameterBufferH263;
2932 typedef struct _VAEncPictureParameterBufferH263
2934 VASurfaceID reference_picture;
2935 VASurfaceID reconstructed_picture;
2936 VABufferID coded_buf;
2937 uint16_t picture_width;
2938 uint16_t picture_height;
2939 VAEncPictureType picture_type;
2941 /** \brief Reserved bytes for future use, must be zero */
2942 uint32_t va_reserved[VA_PADDING_LOW];
2943 } VAEncPictureParameterBufferH263;
2945 /****************************
2946 * MPEG-4 specific encode data structures
2947 ****************************/
2949 typedef struct _VAEncSequenceParameterBufferMPEG4
2951 uint8_t profile_and_level_indication;
2952 uint32_t intra_period;
2953 uint32_t video_object_layer_width;
2954 uint32_t video_object_layer_height;
2955 uint32_t vop_time_increment_resolution;
2956 uint32_t fixed_vop_rate;
2957 uint32_t fixed_vop_time_increment;
2958 uint32_t bits_per_second;
2959 uint32_t frame_rate;
2960 uint32_t initial_qp;
2963 /** \brief Reserved bytes for future use, must be zero */
2964 uint32_t va_reserved[VA_PADDING_LOW];
2965 } VAEncSequenceParameterBufferMPEG4;
2967 typedef struct _VAEncPictureParameterBufferMPEG4
2969 VASurfaceID reference_picture;
2970 VASurfaceID reconstructed_picture;
2971 VABufferID coded_buf;
2972 uint16_t picture_width;
2973 uint16_t picture_height;
2974 uint32_t modulo_time_base; /* number of 1s */
2975 uint32_t vop_time_increment;
2976 VAEncPictureType picture_type;
2978 /** \brief Reserved bytes for future use, must be zero */
2979 uint32_t va_reserved[VA_PADDING_LOW];
2980 } VAEncPictureParameterBufferMPEG4;
2984 /** Buffer functions */
2987 * Creates a buffer for "num_elements" elements of "size" bytes and
2988 * initalize with "data".
2989 * if "data" is null, then the contents of the buffer data store
2991 * Basically there are two ways to get buffer data to the server side. One is
2992 * to call vaCreateBuffer() with a non-null "data", which results the data being
2993 * copied to the data store on the server side. A different method that
2994 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2995 * and then use vaMapBuffer() to map the data store from the server side to the
2996 * client address space for access.
2997 * The user must call vaDestroyBuffer() to destroy a buffer.
2998 * Note: image buffers are created by the library, not the client. Please see
2999 * vaCreateImage on how image buffers are managed.
3001 VAStatus vaCreateBuffer (
3003 VAContextID context,
3004 VABufferType type, /* in */
3005 unsigned int size, /* in */
3006 unsigned int num_elements, /* in */
3007 void *data, /* in */
3008 VABufferID *buf_id /* out */
3012 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
3013 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
3014 * can call vaMapBuffer with this Buffer ID to get virtual address.
3015 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
3016 * maybe it should align with 256, and one byte present one Qp.so, call the function.
3017 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
3018 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
3019 * pBuf + 256 is the start of next line.
3020 * different driver implementation maybe return different unit_size and pitch
3022 VAStatus vaCreateBuffer2(
3024 VAContextID context,
3027 unsigned int height,
3028 unsigned int *unit_size,
3029 unsigned int *pitch,
3034 * Convey to the server how many valid elements are in the buffer.
3035 * e.g. if multiple slice parameters are being held in a single buffer,
3036 * this will communicate to the server the number of slice parameters
3037 * that are valid in the buffer.
3039 VAStatus vaBufferSetNumElements (
3041 VABufferID buf_id, /* in */
3042 unsigned int num_elements /* in */
3047 * device independent data structure for codedbuffer
3051 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
3052 * LARGE_SLICE(bit8):At least one slice in the current frame was large
3053 * enough for the encoder to attempt to limit its size.
3054 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
3055 * exceeded the maximum slice size specified.
3056 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
3057 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
3058 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
3060 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
3061 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
3062 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
3063 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
3064 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
3066 * \brief The frame has exceeded the maximum requested size.
3068 * This flag indicates that the encoded frame size exceeds the value
3069 * specified through a misc parameter buffer of type
3070 * #VAEncMiscParameterTypeMaxFrameSize.
3072 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
3074 * \brief the bitstream is bad or corrupt.
3076 #define VA_CODED_BUF_STATUS_BAD_BITSTREAM 0x8000
3077 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
3080 * \brief The coded buffer segment contains a single NAL unit.
3082 * This flag indicates that the coded buffer segment contains a
3083 * single NAL unit. This flag might be useful to the user for
3084 * processing the coded buffer.
3086 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
3089 * \brief Coded buffer segment.
3091 * #VACodedBufferSegment is an element of a linked list describing
3092 * some information on the coded buffer. The coded buffer segment
3093 * could contain either a single NAL unit, or more than one NAL unit.
3094 * It is recommended (but not required) to return a single NAL unit
3095 * in a coded buffer segment, and the implementation should set the
3096 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
3098 typedef struct _VACodedBufferSegment {
3100 * \brief Size of the data buffer in this segment (in bytes).
3103 /** \brief Bit offset into the data buffer where the video data starts. */
3104 uint32_t bit_offset;
3105 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
3107 /** \brief Reserved for future use. */
3109 /** \brief Pointer to the start of the data buffer. */
3112 * \brief Pointer to the next #VACodedBufferSegment element,
3113 * or \c NULL if there is none.
3117 /** \brief Reserved bytes for future use, must be zero */
3118 uint32_t va_reserved[VA_PADDING_LOW];
3119 } VACodedBufferSegment;
3122 * Map data store of the buffer into the client's address space
3123 * vaCreateBuffer() needs to be called with "data" set to NULL before
3124 * calling vaMapBuffer()
3126 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
3127 * VACodedBufferSegment, and the list is terminated if "next" is NULL
3129 VAStatus vaMapBuffer (
3131 VABufferID buf_id, /* in */
3132 void **pbuf /* out */
3136 * After client making changes to a mapped data store, it needs to
3137 * "Unmap" it to let the server know that the data is ready to be
3138 * consumed by the server
3140 VAStatus vaUnmapBuffer (
3142 VABufferID buf_id /* in */
3146 * After this call, the buffer is deleted and this buffer_id is no longer valid
3148 * A buffer can be re-used and sent to the server by another Begin/Render/End
3149 * sequence if vaDestroyBuffer() is not called with this buffer.
3151 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3152 * hardware accelerator can result in performance dropping.
3154 VAStatus vaDestroyBuffer (
3156 VABufferID buffer_id
3159 /** \brief VA buffer information */
3161 /** \brief Buffer handle */
3163 /** \brief Buffer type (See \ref VABufferType). */
3166 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3168 * On input to vaAcquireBufferHandle(), this field can serve as a hint
3169 * to specify the set of memory types the caller is interested in.
3170 * On successful return from vaAcquireBufferHandle(), the field is
3171 * updated with the best matching memory type.
3174 /** \brief Size of the underlying buffer. */
3177 /** \brief Reserved bytes for future use, must be zero */
3178 uint32_t va_reserved[VA_PADDING_LOW];
3182 * \brief Acquires buffer handle for external API usage
3184 * Locks the VA buffer object \ref buf_id for external API usage like
3185 * EGL or OpenCL (OCL). This function is a synchronization point. This
3186 * means that any pending operation is guaranteed to be completed
3187 * prior to returning from the function.
3189 * If the referenced VA buffer object is the backing store of a VA
3190 * surface, then this function acts as if vaSyncSurface() on the
3191 * parent surface was called first.
3193 * The \ref VABufferInfo argument shall be zero'ed on input. On
3194 * successful output, the data structure is filled in with all the
3195 * necessary buffer level implementation details like handle, type,
3196 * memory type and memory size.
3198 * Note: the external API implementation, or the application, can
3199 * express the memory types it is interested in by filling in the \ref
3200 * mem_type field accordingly. On successful output, the memory type
3201 * that fits best the request and that was used is updated in the \ref
3202 * VABufferInfo data structure. If none of the supplied memory types
3203 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3204 * error is returned.
3206 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3207 * is called. Besides, no additional operation is allowed on any of
3208 * the buffer parent object until vaReleaseBufferHandle() is called.
3209 * e.g. decoding into a VA surface backed with the supplied VA buffer
3210 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3214 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3215 * does not support this interface
3216 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3217 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3218 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3219 * does not support exporting buffers of the specified type
3220 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3221 * memory types in \ref VABufferInfo.mem_type was supported
3223 * @param[in] dpy the VA display
3224 * @param[in] buf_id the VA buffer
3225 * @param[in,out] buf_info the associated VA buffer information
3226 * @return VA_STATUS_SUCCESS if successful
3229 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3232 * \brief Releases buffer after usage from external API
3234 * Unlocks the VA buffer object \ref buf_id from external API usage like
3235 * EGL or OpenCL (OCL). This function is a synchronization point. This
3236 * means that any pending operation is guaranteed to be completed
3237 * prior to returning from the function.
3239 * The \ref VABufferInfo argument shall point to the original data
3240 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3241 * This is necessary so that the VA driver implementation could
3242 * deallocate any resources that were needed.
3244 * In any case, returning from this function invalidates any contents
3245 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3246 * valid. Therefore, VA driver implementations are free to reset this
3247 * data structure to safe defaults.
3250 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3251 * does not support this interface
3252 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3253 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3254 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3255 * does not support exporting buffers of the specified type
3257 * @param[in] dpy the VA display
3258 * @param[in] buf_id the VA buffer
3259 * @return VA_STATUS_SUCCESS if successful
3262 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3265 * Render (Video Decode/Encode/Processing) Pictures
3267 * A picture represents either a frame or a field.
3269 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3274 * Get ready for a video pipeline
3275 * - decode a picture to a target surface
3276 * - encode a picture from a target surface
3277 * - process a picture to a target surface
3279 VAStatus vaBeginPicture (
3281 VAContextID context,
3282 VASurfaceID render_target
3286 * Send video decode, encode or processing buffers to the server.
3288 VAStatus vaRenderPicture (
3290 VAContextID context,
3291 VABufferID *buffers,
3296 * Make the end of rendering for a picture.
3297 * The server should start processing all pending operations for this
3298 * surface. This call is non-blocking. The client can start another
3299 * Begin/Render/End sequence on a different render target.
3300 * if VAContextID used in this function previously successfully passed
3301 * vaMFAddContext call, real processing will be started during vaMFSubmit
3303 VAStatus vaEndPicture (
3309 * Make the end of rendering for a pictures in contexts passed with submission.
3310 * The server should start processing all pending operations for contexts.
3311 * All contexts passed should be associated through vaMFAddContext
3312 * and call sequence Begin/Render/End performed.
3313 * This call is non-blocking. The client can start another
3314 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3316 * VA_STATUS_SUCCESS - operation successful, context was removed.
3317 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3318 * due to mf_context not created or one of contexts not assotiated with mf_context
3319 * through vaAddContext.
3320 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3321 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3323 * mf_context: Multi-Frame context
3324 * contexts: list of contexts submitting their tasks for multi-frame operation.
3325 * num_contexts: number of passed contexts.
3327 VAStatus vaMFSubmit (
3329 VAMFContextID mf_context,
3330 VAContextID * contexts,
3341 * This function blocks until all pending operations on the render target
3342 * have been completed. Upon return it is safe to use the render target for a
3343 * different picture.
3345 VAStatus vaSyncSurface (
3347 VASurfaceID render_target
3352 VASurfaceRendering = 1, /* Rendering in progress */
3353 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3354 /* this status is useful if surface is used as the source */
3356 VASurfaceReady = 4, /* not being rendered or displayed */
3357 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3361 * Find out any pending ops on the render target
3363 VAStatus vaQuerySurfaceStatus (
3365 VASurfaceID render_target,
3366 VASurfaceStatus *status /* out */
3371 VADecodeSliceMissing = 0,
3372 VADecodeMBError = 1,
3373 } VADecodeErrorType;
3376 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3377 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3379 typedef struct _VASurfaceDecodeMBErrors
3381 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3382 uint32_t start_mb; /* start mb address with errors */
3383 uint32_t end_mb; /* end mb address with errors */
3384 VADecodeErrorType decode_error_type;
3385 uint32_t num_mb; /* number of mbs with errors */
3386 /** \brief Reserved bytes for future use, must be zero */
3387 uint32_t va_reserved[VA_PADDING_LOW - 1];
3388 } VASurfaceDecodeMBErrors;
3391 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3392 * it can call vaQuerySurfaceError to find out further details on the particular error.
3393 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3394 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3395 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3396 * The array is terminated if "status==-1" is detected.
3398 VAStatus vaQuerySurfaceError(
3400 VASurfaceID surface,
3401 VAStatus error_status,
3406 * Images and Subpictures
3407 * VAImage is used to either get the surface data to client memory, or
3408 * to copy image data in client memory to a surface.
3409 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3410 * is at the upper left corner with positive X to the right and positive Y down
3412 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3413 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3414 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3417 * Pre-defined fourcc codes
3419 #define VA_FOURCC_NV12 0x3231564E
3420 #define VA_FOURCC_NV21 0x3132564E
3421 #define VA_FOURCC_AI44 0x34344149
3422 #define VA_FOURCC_RGBA 0x41424752
3423 #define VA_FOURCC_RGBX 0x58424752
3424 #define VA_FOURCC_BGRA 0x41524742
3425 #define VA_FOURCC_BGRX 0x58524742
3426 #define VA_FOURCC_ARGB 0x42475241
3427 #define VA_FOURCC_XRGB 0x42475258
3428 #define VA_FOURCC_ABGR 0x52474241
3429 #define VA_FOURCC_XBGR 0x52474258
3430 #define VA_FOURCC_UYVY 0x59565955
3431 #define VA_FOURCC_YUY2 0x32595559
3432 #define VA_FOURCC_AYUV 0x56555941
3433 #define VA_FOURCC_NV11 0x3131564e
3434 #define VA_FOURCC_YV12 0x32315659
3435 #define VA_FOURCC_P208 0x38303250
3436 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3437 #define VA_FOURCC_IYUV 0x56555949
3438 #define VA_FOURCC_I420 0x30323449
3439 #define VA_FOURCC_YV24 0x34325659
3440 #define VA_FOURCC_YV32 0x32335659
3441 #define VA_FOURCC_Y800 0x30303859
3442 #define VA_FOURCC_IMC3 0x33434D49
3443 #define VA_FOURCC_411P 0x50313134
3444 #define VA_FOURCC_422H 0x48323234
3445 #define VA_FOURCC_422V 0x56323234
3446 #define VA_FOURCC_444P 0x50343434
3447 #define VA_FOURCC_RGBP 0x50424752
3448 #define VA_FOURCC_BGRP 0x50524742
3449 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
3452 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3454 #define VA_FOURCC_YV16 0x36315659
3456 * 10-bit and 16-bit Planar YUV 4:2:0.
3458 #define VA_FOURCC_P010 0x30313050
3459 #define VA_FOURCC_P016 0x36313050
3462 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3464 #define VA_FOURCC_I010 0x30313049
3467 #define VA_LSB_FIRST 1
3468 #define VA_MSB_FIRST 2
3470 typedef struct _VAImageFormat
3473 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3474 uint32_t bits_per_pixel;
3475 /* for RGB formats */
3476 uint32_t depth; /* significant bits per pixel */
3478 uint32_t green_mask;
3480 uint32_t alpha_mask;
3482 /** \brief Reserved bytes for future use, must be zero */
3483 uint32_t va_reserved[VA_PADDING_LOW];
3486 typedef VAGenericID VAImageID;
3488 typedef struct _VAImage
3490 VAImageID image_id; /* uniquely identify this image */
3491 VAImageFormat format;
3492 VABufferID buf; /* image data buffer */
3494 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3495 * data store on the server side for optimal performance. The buffer will be
3496 * created by the CreateImage function, and proper storage allocated based on the image
3497 * size and format. This buffer is managed by the library implementation, and
3498 * accessed by the client through the buffer Map/Unmap functions.
3503 uint32_t num_planes; /* can not be greater than 3 */
3505 * An array indicating the scanline pitch in bytes for each plane.
3506 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3508 uint32_t pitches[3];
3510 * An array indicating the byte offset from the beginning of the image data
3511 * to the start of each plane.
3513 uint32_t offsets[3];
3515 /* The following fields are only needed for paletted formats */
3516 int32_t num_palette_entries; /* set to zero for non-palette images */
3518 * Each component is one byte and entry_bytes indicates the number of components in
3519 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3521 int32_t entry_bytes;
3523 * An array of ascii characters describing the order of the components within the bytes.
3524 * Only entry_bytes characters of the string are used.
3526 int8_t component_order[4];
3528 /** \brief Reserved bytes for future use, must be zero */
3529 uint32_t va_reserved[VA_PADDING_LOW];
3532 /** Get maximum number of image formats supported by the implementation */
3533 int vaMaxNumImageFormats (
3538 * Query supported image formats
3539 * The caller must provide a "format_list" array that can hold at
3540 * least vaMaxNumImageFormats() entries. The actual number of formats
3541 * returned in "format_list" is returned in "num_formats".
3543 VAStatus vaQueryImageFormats (
3545 VAImageFormat *format_list, /* out */
3546 int *num_formats /* out */
3550 * Create a VAImage structure
3551 * The width and height fields returned in the VAImage structure may get
3552 * enlarged for some YUV formats. Upon return from this function,
3553 * image->buf has been created and proper storage allocated by the library.
3554 * The client can access the image through the Map/Unmap calls.
3556 VAStatus vaCreateImage (
3558 VAImageFormat *format,
3561 VAImage *image /* out */
3565 * Should call DestroyImage before destroying the surface it is bound to
3567 VAStatus vaDestroyImage (
3572 VAStatus vaSetImagePalette (
3576 * pointer to an array holding the palette data. The size of the array is
3577 * num_palette_entries * entry_bytes in size. The order of the components
3578 * in the palette is described by the component_order in VAImage struct
3580 unsigned char *palette
3584 * Retrive surface data into a VAImage
3585 * Image must be in a format supported by the implementation
3587 VAStatus vaGetImage (
3589 VASurfaceID surface,
3590 int x, /* coordinates of the upper left source pixel */
3592 unsigned int width, /* width and height of the region */
3593 unsigned int height,
3598 * Copy data from a VAImage to a surface
3599 * Image must be in a format supported by the implementation
3600 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3601 * shouldn't be rendered into when this is called
3603 VAStatus vaPutImage (
3605 VASurfaceID surface,
3609 unsigned int src_width,
3610 unsigned int src_height,
3613 unsigned int dest_width,
3614 unsigned int dest_height
3618 * Derive an VAImage from an existing surface.
3619 * This interface will derive a VAImage and corresponding image buffer from
3620 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3621 * direct CPU access. This operation is only possible on implementations with
3622 * direct rendering capabilities and internal surface formats that can be
3623 * represented with a VAImage. When the operation is not possible this interface
3624 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3625 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3628 * Implementations should only return success when the resulting image buffer
3629 * would be useable with vaMap/Unmap.
3631 * When directly accessing a surface special care must be taken to insure
3632 * proper synchronization with the graphics hardware. Clients should call
3633 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3634 * rendering or currently being displayed by an overlay.
3636 * Additionally nothing about the contents of a surface should be assumed
3637 * following a vaPutSurface. Implementations are free to modify the surface for
3638 * scaling or subpicture blending within a call to vaPutImage.
3640 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3641 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3642 * vaGetImage with other surfaces is supported.
3644 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3645 * image and image buffer structures will be destroyed; however, the underlying
3646 * surface will remain unchanged until freed with vaDestroySurfaces.
3648 VAStatus vaDeriveImage (
3650 VASurfaceID surface,
3651 VAImage *image /* out */
3656 * Subpicture is a special type of image that can be blended
3657 * with a surface during vaPutSurface(). Subpicture can be used to render
3658 * DVD sub-titles or closed captioning text etc.
3661 typedef VAGenericID VASubpictureID;
3663 /** Get maximum number of subpicture formats supported by the implementation */
3664 int vaMaxNumSubpictureFormats (
3668 /** flags for subpictures */
3669 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3670 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3671 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3673 * Query supported subpicture formats
3674 * The caller must provide a "format_list" array that can hold at
3675 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3676 * for each format to indicate additional capabilities for that format. The actual
3677 * number of formats returned in "format_list" is returned in "num_formats".
3678 * flags: returned value to indicate addtional capabilities
3679 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3680 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3681 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3684 VAStatus vaQuerySubpictureFormats (
3686 VAImageFormat *format_list, /* out */
3687 unsigned int *flags, /* out */
3688 unsigned int *num_formats /* out */
3692 * Subpictures are created with an image associated.
3694 VAStatus vaCreateSubpicture (
3697 VASubpictureID *subpicture /* out */
3701 * Destroy the subpicture before destroying the image it is assocated to
3703 VAStatus vaDestroySubpicture (
3705 VASubpictureID subpicture
3709 * Bind an image to the subpicture. This image will now be associated with
3710 * the subpicture instead of the one at creation.
3712 VAStatus vaSetSubpictureImage (
3714 VASubpictureID subpicture,
3719 * If chromakey is enabled, then the area where the source value falls within
3720 * the chromakey [min, max] range is transparent
3721 * The chromakey component format is the following:
3722 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3723 * For YUV: [0:7] V [8:15] U [16:23] Y
3724 * The chromakey mask can be used to mask out certain components for chromakey
3727 VAStatus vaSetSubpictureChromakey (
3729 VASubpictureID subpicture,
3730 unsigned int chromakey_min,
3731 unsigned int chromakey_max,
3732 unsigned int chromakey_mask
3736 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3737 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3738 * the overall alpha is per-pixel alpha multiplied by the global alpha
3740 VAStatus vaSetSubpictureGlobalAlpha (
3742 VASubpictureID subpicture,
3747 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3748 * It defines the region mapping between the subpicture and the target
3749 * surfaces through source and destination rectangles (with the same width and height).
3750 * Both will be displayed at the next call to vaPutSurface. Additional
3751 * associations before the call to vaPutSurface simply overrides the association.
3753 VAStatus vaAssociateSubpicture (
3755 VASubpictureID subpicture,
3756 VASurfaceID *target_surfaces,
3758 int16_t src_x, /* upper left offset in subpicture */
3761 uint16_t src_height,
3762 int16_t dest_x, /* upper left offset in surface */
3764 uint16_t dest_width,
3765 uint16_t dest_height,
3767 * whether to enable chroma-keying, global-alpha, or screen relative mode
3768 * see VA_SUBPICTURE_XXX values
3774 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3776 VAStatus vaDeassociateSubpicture (
3778 VASubpictureID subpicture,
3779 VASurfaceID *target_surfaces,
3784 * Display attributes
3785 * Display attributes are used to control things such as contrast, hue, saturation,
3786 * brightness etc. in the rendering process. The application can query what
3787 * attributes are supported by the driver, and then set the appropriate attributes
3788 * before calling vaPutSurface()
3790 /* PowerVR IEP Lite attributes */
3793 VADISPLAYATTRIB_BLE_OFF = 0x00,
3794 VADISPLAYATTRIB_BLE_LOW,
3795 VADISPLAYATTRIB_BLE_MEDIUM,
3796 VADISPLAYATTRIB_BLE_HIGH,
3797 VADISPLAYATTRIB_BLE_NONE,
3798 } VADisplayAttribBLEMode;
3800 /** attribute value for VADisplayAttribRotation */
3801 #define VA_ROTATION_NONE 0x00000000
3802 #define VA_ROTATION_90 0x00000001
3803 #define VA_ROTATION_180 0x00000002
3804 #define VA_ROTATION_270 0x00000003
3808 * @name Mirroring directions
3810 * Those values could be used for VADisplayAttribMirror attribute or
3811 * VAProcPipelineParameterBuffer::mirror_state.
3815 /** \brief No Mirroring. */
3816 #define VA_MIRROR_NONE 0x00000000
3817 /** \brief Horizontal Mirroring. */
3818 #define VA_MIRROR_HORIZONTAL 0x00000001
3819 /** \brief Vertical Mirroring. */
3820 #define VA_MIRROR_VERTICAL 0x00000002
3823 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3824 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3825 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3828 #define VA_RENDER_MODE_UNDEFINED 0
3829 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3830 #define VA_RENDER_MODE_LOCAL_GPU 2
3831 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3832 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3834 /** Render device */
3835 #define VA_RENDER_DEVICE_UNDEFINED 0
3836 #define VA_RENDER_DEVICE_LOCAL 1
3837 #define VA_RENDER_DEVICE_EXTERNAL 2
3839 /** Currently defined display attribute types */
3842 VADisplayAttribBrightness = 0,
3843 VADisplayAttribContrast = 1,
3844 VADisplayAttribHue = 2,
3845 VADisplayAttribSaturation = 3,
3846 /* client can specifiy a background color for the target window
3847 * the new feature of video conference,
3848 * the uncovered area of the surface is filled by this color
3849 * also it will blend with the decoded video color
3851 VADisplayAttribBackgroundColor = 4,
3853 * this is a gettable only attribute. For some implementations that use the
3854 * hardware overlay, after PutSurface is called, the surface can not be
3855 * re-used until after the subsequent PutSurface call. If this is the case
3856 * then the value for this attribute will be set to 1 so that the client
3857 * will not attempt to re-use the surface right after returning from a call
3860 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3861 * driver may use overlay or GPU alternatively
3863 VADisplayAttribDirectSurface = 5,
3864 VADisplayAttribRotation = 6,
3865 VADisplayAttribOutofLoopDeblock = 7,
3867 /* PowerVR IEP Lite specific attributes */
3868 VADisplayAttribBLEBlackMode = 8,
3869 VADisplayAttribBLEWhiteMode = 9,
3870 VADisplayAttribBlueStretch = 10,
3871 VADisplayAttribSkinColorCorrection = 11,
3873 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3874 * conversion matrix. Each element in the matrix is float-point
3876 VADisplayAttribCSCMatrix = 12,
3877 /* specify the constant color used to blend with video surface
3878 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3879 * d: the final color to overwrite into the frame buffer
3880 * v: decoded video after color conversion,
3881 * c: video color specified by VADisplayAttribBlendColor
3882 * b: background color of the drawable
3884 VADisplayAttribBlendColor = 13,
3886 * Indicate driver to skip painting color key or not.
3887 * only applicable if the render is overlay
3889 VADisplayAttribOverlayAutoPaintColorKey = 14,
3891 * customized overlay color key, the format is RGB888
3892 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3894 VADisplayAttribOverlayColorKey = 15,
3896 * The hint for the implementation of vaPutSurface
3897 * normally, the driver could use an overlay or GPU to render the surface on the screen
3898 * this flag provides APP the flexibity to switch the render dynamically
3900 VADisplayAttribRenderMode = 16,
3902 * specify if vaPutSurface needs to render into specified monitors
3903 * one example is that one external monitor (e.g. HDMI) is enabled,
3904 * but the window manager is not aware of it, and there is no associated drawable
3906 VADisplayAttribRenderDevice = 17,
3908 * specify vaPutSurface render area if there is no drawable on the monitor
3910 VADisplayAttribRenderRect = 18,
3911 } VADisplayAttribType;
3913 /* flags for VADisplayAttribute */
3914 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3915 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3916 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3918 typedef struct _VADisplayAttribute
3920 VADisplayAttribType type;
3923 int32_t value; /* used by the set/get attribute functions */
3924 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3927 /** \brief Reserved bytes for future use, must be zero */
3928 uint32_t va_reserved[VA_PADDING_LOW];
3929 } VADisplayAttribute;
3931 /** Get maximum number of display attributs supported by the implementation */
3932 int vaMaxNumDisplayAttributes (
3937 * Query display attributes
3938 * The caller must provide a "attr_list" array that can hold at
3939 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3940 * returned in "attr_list" is returned in "num_attributes".
3942 VAStatus vaQueryDisplayAttributes (
3944 VADisplayAttribute *attr_list, /* out */
3945 int *num_attributes /* out */
3949 * Get display attributes
3950 * This function returns the current attribute values in "attr_list".
3951 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3952 * from vaQueryDisplayAttributes() can have their values retrieved.
3954 VAStatus vaGetDisplayAttributes (
3956 VADisplayAttribute *attr_list, /* in/out */
3961 * Set display attributes
3962 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3963 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3964 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3966 VAStatus vaSetDisplayAttributes (
3968 VADisplayAttribute *attr_list,
3972 /****************************
3973 * HEVC data structures
3974 ****************************/
3976 * \brief Description of picture properties of those in DPB surfaces.
3978 * If only progressive scan is supported, each surface contains one whole
3980 * Otherwise, each surface contains two fields of whole picture.
3981 * In this case, two entries of ReferenceFrames[] may share same picture_id
3984 typedef struct _VAPictureHEVC
3986 /** \brief reconstructed picture buffer surface index
3987 * invalid when taking value VA_INVALID_SURFACE.
3989 VASurfaceID picture_id;
3990 /** \brief picture order count.
3991 * in HEVC, POCs for top and bottom fields of same picture should
3992 * take different values.
3994 int32_t pic_order_cnt;
3995 /* described below */
3998 /** \brief Reserved bytes for future use, must be zero */
3999 uint32_t va_reserved[VA_PADDING_LOW];
4002 /* flags in VAPictureHEVC could be OR of the following */
4003 #define VA_PICTURE_HEVC_INVALID 0x00000001
4004 /** \brief indication of interlace scan picture.
4005 * should take same value for all the pictures in sequence.
4007 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
4008 /** \brief polarity of the field picture.
4009 * top field takes even lines of buffer surface.
4010 * bottom field takes odd lines of buffer surface.
4012 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
4013 /** \brief Long term reference picture */
4014 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
4016 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
4017 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
4018 * be exclusive. No more than one of them can be set for any picture.
4019 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
4020 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
4021 * Application should provide valid values for both short format and long format.
4022 * The pictures in DPB with any of these three flags turned on are referred by
4023 * the current picture.
4025 /** \brief RefPicSetStCurrBefore of HEVC spec variable
4026 * Number of ReferenceFrames[] entries with this bit set equals
4027 * NumPocStCurrBefore.
4029 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
4030 /** \brief RefPicSetStCurrAfter of HEVC spec variable
4031 * Number of ReferenceFrames[] entries with this bit set equals
4032 * NumPocStCurrAfter.
4034 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
4035 /** \brief RefPicSetLtCurr of HEVC spec variable
4036 * Number of ReferenceFrames[] entries with this bit set equals
4039 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
4041 #include <va/va_dec_hevc.h>
4042 #include <va/va_dec_jpeg.h>
4043 #include <va/va_dec_vp8.h>
4044 #include <va/va_dec_vp9.h>
4045 #include <va/va_enc_hevc.h>
4046 #include <va/va_enc_h264.h>
4047 #include <va/va_enc_jpeg.h>
4048 #include <va/va_enc_mpeg2.h>
4049 #include <va/va_enc_vp8.h>
4050 #include <va/va_enc_vp9.h>
4051 #include <va/va_fei.h>
4052 #include <va/va_fei_h264.h>
4053 #include <va/va_vpp.h>