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 VAConfigAttribTypeMax
691 } VAConfigAttribType;
694 * Configuration attributes
695 * If there is more than one value for an attribute, a default
696 * value will be assigned to the attribute if the client does not
697 * specify the attribute when creating a configuration
699 typedef struct _VAConfigAttrib {
700 VAConfigAttribType type;
701 uint32_t value; /* OR'd flags (bits) for this attribute */
704 /** attribute value for VAConfigAttribRTFormat */
705 #define VA_RT_FORMAT_YUV420 0x00000001
706 #define VA_RT_FORMAT_YUV422 0x00000002
707 #define VA_RT_FORMAT_YUV444 0x00000004
708 #define VA_RT_FORMAT_YUV411 0x00000008
709 #define VA_RT_FORMAT_YUV400 0x00000010
710 /** YUV formats with more than 8 bpp */
711 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
713 #define VA_RT_FORMAT_RGB16 0x00010000
714 #define VA_RT_FORMAT_RGB32 0x00020000
715 /* RGBP covers RGBP and BGRP fourcc */
716 #define VA_RT_FORMAT_RGBP 0x00100000
718 * RGB 10-bit packed format with upper 2 bits as alpha channel.
719 * The existing pre-defined fourcc codes can be used to signal
720 * the position of each component for this RT format.
722 #define VA_RT_FORMAT_RGB32_10BPP 0x00200000
723 #define VA_RT_FORMAT_PROTECTED 0x80000000
725 /** @name Attribute values for VAConfigAttribRateControl */
727 /** \brief Driver does not support any form of rate control. */
728 #define VA_RC_NONE 0x00000001
729 /** \brief Constant bitrate. */
730 #define VA_RC_CBR 0x00000002
731 /** \brief Variable bitrate. */
732 #define VA_RC_VBR 0x00000004
733 /** \brief Video conference mode. */
734 #define VA_RC_VCM 0x00000008
735 /** \brief Constant QP. */
736 #define VA_RC_CQP 0x00000010
737 /** \brief Variable bitrate with peak rate higher than average bitrate. */
738 #define VA_RC_VBR_CONSTRAINED 0x00000020
739 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
740 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
741 #define VA_RC_ICQ 0x00000040
742 /** \brief Macroblock based rate control. Per MB control is decided
743 * internally in the encoder. It may be combined with other RC modes, except CQP. */
744 #define VA_RC_MB 0x00000080
745 /** \brief Constant Frame Size, it is used for small tolerent */
746 #define VA_RC_CFS 0x00000100
747 /** \brief Parallel BRC, for hierachical B.
749 * For hierachical B, B frames can be refered by other B frames.
750 * Currently three layers of hierachy are defined:
751 * B0 - regular B, no reference to other B frames.
752 * B1 - reference to only I, P and regular B0 frames.
753 * B2 - reference to any other frames, including B1.
754 * In Hierachical B structure, B frames on the same layer can be processed
755 * simultaneously. And BRC would adjust accordingly. This is so called
757 #define VA_RC_PARALLEL 0x00000200
761 /** @name Attribute values for VAConfigAttribDecSliceMode */
763 /** \brief Driver supports normal mode for slice decoding */
764 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
765 /** \brief Driver supports base mode for slice decoding */
766 #define VA_DEC_SLICE_MODE_BASE 0x00000002
768 /** @name Attribute values for VAConfigAttribDecJPEG */
770 typedef union _VAConfigAttribValDecJPEG {
772 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
773 uint32_t rotation : 4;
774 /** \brief Reserved for future use. */
775 uint32_t reserved : 28;
778 uint32_t va_reserved[VA_PADDING_LOW];
779 } VAConfigAttribValDecJPEG;
780 /** @name Attribute values for VAConfigAttribDecProcessing */
782 /** \brief No decoding + processing in a single decoding call. */
783 #define VA_DEC_PROCESSING_NONE 0x00000000
784 /** \brief Decode + processing in a single decoding call. */
785 #define VA_DEC_PROCESSING 0x00000001
788 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
790 /** \brief Driver does not support any packed headers mode. */
791 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
793 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
795 * Application must provide it to driver once this flag is returned through
796 * vaGetConfigAttributes()
798 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
800 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
802 * Application must provide it to driver once this falg is returned through
803 * vaGetConfigAttributes()
805 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
807 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
809 * Application must provide it to driver once this flag is returned through
810 * vaGetConfigAttributes()
812 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
814 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
817 * This is a deprecated packed header flag, All applications can use
818 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
819 * header data buffer to the driver
821 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
822 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
823 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
826 /** @name Attribute values for VAConfigAttribEncInterlaced */
828 /** \brief Driver does not support interlaced coding. */
829 #define VA_ENC_INTERLACED_NONE 0x00000000
830 /** \brief Driver supports interlaced frame coding. */
831 #define VA_ENC_INTERLACED_FRAME 0x00000001
832 /** \brief Driver supports interlaced field coding. */
833 #define VA_ENC_INTERLACED_FIELD 0x00000002
834 /** \brief Driver supports macroblock adaptive frame field coding. */
835 #define VA_ENC_INTERLACED_MBAFF 0x00000004
836 /** \brief Driver supports picture adaptive frame field coding. */
837 #define VA_ENC_INTERLACED_PAFF 0x00000008
840 /** @name Attribute values for VAConfigAttribEncSliceStructure */
842 /** \brief Driver supports a power-of-two number of rows per slice. */
843 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
844 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
845 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
846 /** \brief Dirver support 1 rows per slice */
847 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
848 /** \brief Dirver support max encoded slice size per slice */
849 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
850 /** \brief Driver supports an arbitrary number of rows per slice. */
851 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
854 /** \brief Attribute value for VAConfigAttribEncJPEG */
855 typedef union _VAConfigAttribValEncJPEG {
857 /** \brief set to 1 for arithmatic coding. */
858 uint32_t arithmatic_coding_mode : 1;
859 /** \brief set to 1 for progressive dct. */
860 uint32_t progressive_dct_mode : 1;
861 /** \brief set to 1 for non-interleaved. */
862 uint32_t non_interleaved_mode : 1;
863 /** \brief set to 1 for differential. */
864 uint32_t differential_mode : 1;
865 uint32_t max_num_components : 3;
866 uint32_t max_num_scans : 4;
867 uint32_t max_num_huffman_tables : 3;
868 uint32_t max_num_quantization_tables : 3;
871 } VAConfigAttribValEncJPEG;
873 /** @name Attribute values for VAConfigAttribEncQuantization */
875 /** \brief Driver does not support special types of quantization */
876 #define VA_ENC_QUANTIZATION_NONE 0x00000000
877 /** \brief Driver supports trellis quantization */
878 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
881 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
883 /** \brief Driver does not support intra refresh */
884 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
885 /** \brief Driver supports column based rolling intra refresh */
886 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
887 /** \brief Driver supports row based rolling intra refresh */
888 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
889 /** \brief Driver supports adaptive intra refresh */
890 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
891 /** \brief Driver supports cyclic intra refresh */
892 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
893 /** \brief Driver supports intra refresh of P frame*/
894 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
895 /** \brief Driver supports intra refresh of B frame */
896 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
897 /** \brief Driver supports intra refresh of multiple reference encoder */
898 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
902 /** \brief Attribute value for VAConfigAttribEncROI */
903 typedef union _VAConfigAttribValEncROI {
905 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
906 uint32_t num_roi_regions : 8;
908 * \brief A flag indicates whether ROI priority is supported
910 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
911 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
912 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
913 * the underlying driver doesn't support ROI priority.
915 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
916 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
918 uint32_t roi_rc_priority_support : 1;
920 * \brief A flag indicates whether ROI delta QP is supported
922 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
923 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
924 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
925 * the underlying driver doesn't support ROI delta QP.
927 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
928 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
930 uint32_t roi_rc_qp_delta_support : 1;
931 uint32_t reserved : 22;
934 } VAConfigAttribValEncROI;
936 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
937 typedef union _VAConfigAttribValEncRateControlExt {
940 * \brief The maximum number of temporal layers minus 1
942 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
943 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
944 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
946 uint32_t max_num_temporal_layers_minus1 : 8;
949 * /brief support temporal layer bit-rate control flag
951 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
952 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
953 * #VAConfigAttribRateControl == #VA_RC_VBR).
955 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
956 * \c max_num_temporal_layers_minus1 is equal to 0
958 * To use bit-rate control per temporal layer, an application must send the right layer
959 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
960 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
961 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
962 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
963 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
964 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
965 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
967 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
968 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
969 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
971 uint32_t temporal_layer_bitrate_control_flag : 1;
972 uint32_t reserved : 23;
975 } VAConfigAttribValEncRateControlExt;
977 /** @name Attribute values for VAConfigAttribProcessingRate. */
979 /** \brief Driver does not support processing rate report */
980 #define VA_PROCESSING_RATE_NONE 0x00000000
981 /** \brief Driver supports encode processing rate report */
982 #define VA_PROCESSING_RATE_ENCODE 0x00000001
983 /** \brief Driver supports decode processing rate report */
984 #define VA_PROCESSING_RATE_DECODE 0x00000002
987 * if an attribute is not applicable for a given
988 * profile/entrypoint pair, then set the value to the following
990 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
992 /** Get maximum number of profiles supported by the implementation */
993 int vaMaxNumProfiles (
997 /** Get maximum number of entrypoints supported by the implementation */
998 int vaMaxNumEntrypoints (
1002 /** Get maximum number of attributs supported by the implementation */
1003 int vaMaxNumConfigAttributes (
1008 * Query supported profiles
1009 * The caller must provide a "profile_list" array that can hold at
1010 * least vaMaxNumProfile() entries. The actual number of profiles
1011 * returned in "profile_list" is returned in "num_profile".
1013 VAStatus vaQueryConfigProfiles (
1015 VAProfile *profile_list, /* out */
1016 int *num_profiles /* out */
1020 * Query supported entrypoints for a given profile
1021 * The caller must provide an "entrypoint_list" array that can hold at
1022 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
1023 * returned in "entrypoint_list" is returned in "num_entrypoints".
1025 VAStatus vaQueryConfigEntrypoints (
1028 VAEntrypoint *entrypoint_list, /* out */
1029 int *num_entrypoints /* out */
1033 * Get attributes for a given profile/entrypoint pair
1034 * The caller must provide an "attrib_list" with all attributes to be
1035 * retrieved. Upon return, the attributes in "attrib_list" have been
1036 * updated with their value. Unknown attributes or attributes that are
1037 * not supported for the given profile/entrypoint pair will have their
1038 * value set to VA_ATTRIB_NOT_SUPPORTED
1040 VAStatus vaGetConfigAttributes (
1043 VAEntrypoint entrypoint,
1044 VAConfigAttrib *attrib_list, /* in/out */
1048 /** Generic ID type, can be re-typed for specific implementation */
1049 typedef unsigned int VAGenericID;
1051 typedef VAGenericID VAConfigID;
1054 * Create a configuration for the video decode/encode/processing pipeline
1055 * it passes in the attribute list that specifies the attributes it cares
1056 * about, with the rest taking default values.
1058 VAStatus vaCreateConfig (
1061 VAEntrypoint entrypoint,
1062 VAConfigAttrib *attrib_list,
1064 VAConfigID *config_id /* out */
1068 * Free resources associdated with a given config
1070 VAStatus vaDestroyConfig (
1072 VAConfigID config_id
1076 * Query all attributes for a given configuration
1077 * The profile of the configuration is returned in "profile"
1078 * The entrypoint of the configuration is returned in "entrypoint"
1079 * The caller must provide an "attrib_list" array that can hold at least
1080 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1081 * returned in "attrib_list" is returned in "num_attribs"
1083 VAStatus vaQueryConfigAttributes (
1085 VAConfigID config_id,
1086 VAProfile *profile, /* out */
1087 VAEntrypoint *entrypoint, /* out */
1088 VAConfigAttrib *attrib_list,/* out */
1089 int *num_attribs /* out */
1094 * Contexts and Surfaces
1096 * Context represents a "virtual" video decode, encode or video processing
1097 * pipeline. Surfaces are render targets for a given context. The data in the
1098 * surfaces are not accessible to the client except if derived image is supported
1099 * and the internal data format of the surface is implementation specific.
1101 * Surfaces are provided as a hint of what surfaces will be used when the context
1102 * is created through vaCreateContext(). A surface may be used by different contexts
1103 * at the same time as soon as application can make sure the operations are synchronized
1104 * between different contexts, e.g. a surface is used as the output of a decode context
1105 * and the input of a video process context. Surfaces can only be destroyed after all
1106 * contexts using these surfaces have been destroyed.
1108 * Both contexts and surfaces are identified by unique IDs and its
1109 * implementation specific internals are kept opaque to the clients
1112 typedef VAGenericID VAContextID;
1114 typedef VAGenericID VASurfaceID;
1116 #define VA_INVALID_ID 0xffffffff
1117 #define VA_INVALID_SURFACE VA_INVALID_ID
1119 /** \brief Generic value types. */
1121 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1122 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1123 VAGenericValueTypePointer, /**< Generic pointer type */
1124 VAGenericValueTypeFunc /**< Pointer to function */
1125 } VAGenericValueType;
1127 /** \brief Generic function type. */
1128 typedef void (*VAGenericFunc)(void);
1130 /** \brief Generic value. */
1131 typedef struct _VAGenericValue {
1132 /** \brief Value type. See #VAGenericValueType. */
1133 VAGenericValueType type;
1134 /** \brief Value holder. */
1136 /** \brief 32-bit signed integer. */
1138 /** \brief 32-bit float. */
1140 /** \brief Generic pointer. */
1142 /** \brief Pointer to function. */
1147 /** @name Surface attribute flags */
1149 /** \brief Surface attribute is not supported. */
1150 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1151 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1152 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1153 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1154 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1157 /** \brief Surface attribute types. */
1159 VASurfaceAttribNone = 0,
1161 * \brief Pixel format (fourcc).
1163 * The value is meaningful as input to vaQuerySurfaceAttributes().
1164 * If zero, the driver returns the optimal pixel format for the
1165 * specified config. Otherwise, if non-zero, the value represents
1166 * a pixel format (FOURCC) that is kept as is on output, if the
1167 * driver supports it. Otherwise, the driver sets the value to
1168 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1170 VASurfaceAttribPixelFormat,
1171 /** \brief Minimal width in pixels (int, read-only). */
1172 VASurfaceAttribMinWidth,
1173 /** \brief Maximal width in pixels (int, read-only). */
1174 VASurfaceAttribMaxWidth,
1175 /** \brief Minimal height in pixels (int, read-only). */
1176 VASurfaceAttribMinHeight,
1177 /** \brief Maximal height in pixels (int, read-only). */
1178 VASurfaceAttribMaxHeight,
1179 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1180 VASurfaceAttribMemoryType,
1181 /** \brief External buffer descriptor (pointer, write). */
1182 VASurfaceAttribExternalBufferDescriptor,
1183 /** \brief Surface usage hint, gives the driver a hint of intended usage
1184 * to optimize allocation (e.g. tiling) (int, read/write). */
1185 VASurfaceAttribUsageHint,
1186 /** \brief Number of surface attributes. */
1187 VASurfaceAttribCount
1188 } VASurfaceAttribType;
1190 /** \brief Surface attribute. */
1191 typedef struct _VASurfaceAttrib {
1193 VASurfaceAttribType type;
1194 /** \brief Flags. See "Surface attribute flags". */
1196 /** \brief Value. See "Surface attribute types" for the expected types. */
1197 VAGenericValue value;
1201 * @name VASurfaceAttribMemoryType values in bit fields.
1202 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1203 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1204 * types are defined in DRM and Android header files.
1207 /** \brief VA memory type (default) is supported. */
1208 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1209 /** \brief V4L2 buffer memory type is supported. */
1210 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1211 /** \brief User pointer memory type is supported. */
1212 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1216 * \brief VASurfaceAttribExternalBuffers structure for
1217 * the VASurfaceAttribExternalBufferDescriptor attribute.
1219 typedef struct _VASurfaceAttribExternalBuffers {
1220 /** \brief pixel format in fourcc. */
1221 uint32_t pixel_format;
1222 /** \brief width in pixels. */
1224 /** \brief height in pixels. */
1226 /** \brief total size of the buffer in bytes. */
1228 /** \brief number of planes for planar layout */
1229 uint32_t num_planes;
1230 /** \brief pitch for each plane in bytes */
1231 uint32_t pitches[4];
1232 /** \brief offset for each plane in bytes */
1233 uint32_t offsets[4];
1234 /** \brief buffer handles or user pointers */
1236 /** \brief number of elements in the "buffers" array */
1237 uint32_t num_buffers;
1238 /** \brief flags. See "Surface external buffer descriptor flags". */
1240 /** \brief reserved for passing private data */
1242 } VASurfaceAttribExternalBuffers;
1244 /** @name VASurfaceAttribExternalBuffers flags */
1246 /** \brief Enable memory tiling */
1247 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1248 /** \brief Memory is cacheable */
1249 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1250 /** \brief Memory is non-cacheable */
1251 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1252 /** \brief Memory is write-combined */
1253 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1254 /** \brief Memory is protected */
1255 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1257 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1259 /** \brief Surface usage not indicated. */
1260 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1261 /** \brief Surface used by video decoder. */
1262 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1263 /** \brief Surface used by video encoder. */
1264 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1265 /** \brief Surface read by video post-processing. */
1266 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1267 /** \brief Surface written by video post-processing. */
1268 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1269 /** \brief Surface used for display. */
1270 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1275 * \brief Queries surface attributes for the supplied config.
1277 * This function queries for all supported attributes for the
1278 * supplied VA @config. In particular, if the underlying hardware
1279 * supports the creation of VA surfaces in various formats, then
1280 * this function will enumerate all pixel formats that are supported.
1282 * The \c attrib_list array is allocated by the user and \c
1283 * num_attribs shall be initialized to the number of allocated
1284 * elements in that array. Upon successful return, the actual number
1285 * of attributes will be overwritten into \c num_attribs. Otherwise,
1286 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1287 * is adjusted to the number of elements that would be returned if
1288 * enough space was available.
1290 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1291 * argument when vaQuerySurfaceAttributes() is used to determine the
1292 * actual number of elements that need to be allocated.
1294 * @param[in] dpy the VA display
1295 * @param[in] config the config identifying a codec or a video
1296 * processing pipeline
1297 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1298 * @param[in,out] num_attribs the number of elements allocated on
1299 * input, the number of elements actually filled in output
1302 vaQuerySurfaceAttributes(
1305 VASurfaceAttrib *attrib_list,
1306 unsigned int *num_attribs
1310 * \brief Creates an array of surfaces
1312 * Creates an array of surfaces. The optional list of attributes shall
1313 * be constructed based on what the underlying hardware could expose
1314 * through vaQuerySurfaceAttributes().
1316 * @param[in] dpy the VA display
1317 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1318 * @param[in] width the surface width
1319 * @param[in] height the surface height
1320 * @param[out] surfaces the array of newly created surfaces
1321 * @param[in] num_surfaces the number of surfaces to create
1322 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1323 * @param[in] num_attribs the number of attributes supplied in
1324 * \c attrib_list, or zero
1329 unsigned int format,
1331 unsigned int height,
1332 VASurfaceID *surfaces,
1333 unsigned int num_surfaces,
1334 VASurfaceAttrib *attrib_list,
1335 unsigned int num_attribs
1339 * vaDestroySurfaces - Destroy resources associated with surfaces.
1340 * Surfaces can only be destroyed after all contexts using these surfaces have been
1343 * surfaces: array of surfaces to destroy
1344 * num_surfaces: number of surfaces in the array to be destroyed.
1346 VAStatus vaDestroySurfaces (
1348 VASurfaceID *surfaces,
1352 #define VA_PROGRESSIVE 0x1
1354 * vaCreateContext - Create a context
1356 * config_id: configuration for the context
1357 * picture_width: coded picture width
1358 * picture_height: coded picture height
1359 * flag: any combination of the following:
1360 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1361 * render_targets: a hint for render targets (surfaces) tied to the context
1362 * num_render_targets: number of render targets in the above array
1363 * context: created context id upon return
1365 VAStatus vaCreateContext (
1367 VAConfigID config_id,
1371 VASurfaceID *render_targets,
1372 int num_render_targets,
1373 VAContextID *context /* out */
1377 * vaDestroyContext - Destroy a context
1379 * context: context to be destroyed
1381 VAStatus vaDestroyContext (
1386 //Multi-frame context
1387 typedef VAGenericID VAMFContextID;
1389 * vaCreateMFContext - Create a multi-frame context
1390 * interface encapsulating common for all streams memory objects and structures
1391 * required for single GPU task submission from several VAContextID's.
1392 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1393 * Support identification: Application can identify multi-frame feature support by ability
1394 * to create multi-frame context. If driver supports multi-frame - call successful,
1395 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1396 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1398 * VA_STATUS_SUCCESS - operation successful.
1399 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1400 * dpy: display adapter.
1401 * mf_context: Multi-Frame context encapsulating all associated context
1402 * for multi-frame submission.
1404 VAStatus vaCreateMFContext (
1406 VAMFContextID *mf_context /* out */
1410 * vaMFAddContext - Provide ability to associate each context used for
1411 * Multi-Frame submission and common Multi-Frame context.
1412 * Try to add context to understand if it is supported.
1413 * Allocation: this call allocates and/or reallocates all memory objects
1414 * common for all contexts associated with particular Multi-Frame context.
1415 * All memory required for each context(pixel buffers, internal driver
1416 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1417 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1418 * first context added will set entry point/profile for whole Multi-Frame context,
1419 * all other entry points and profiles can be rejected to be added.
1421 * VA_STATUS_SUCCESS - operation successful, context was added.
1422 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1423 * current mf_context and associated contexts and start working with new ones.
1424 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1425 * 1 - mf_context is not valid context or
1426 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1427 * and current context contradicts with previously added, application can continue with current mf_context
1428 * and other contexts passed this call, rejected context can continue work in stand-alone
1429 * mode or other mf_context.
1430 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1431 * unsupported VAEntrypoint. Application can continue with current mf_context
1432 * and other contexts passed this call, rejected context can continue work in stand-alone
1434 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1435 * but VAProfile is not supported. Application can continue with current mf_context
1436 * and other contexts passed this call, rejected context can continue work in stand-alone
1438 * dpy: display adapter.
1439 * context: context being associated with Multi-Frame context.
1440 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1442 VAStatus vaMFAddContext (
1444 VAMFContextID mf_context,
1449 * vaMFReleaseContext - Removes context from multi-frame and
1450 * association with multi-frame context.
1451 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1453 * VA_STATUS_SUCCESS - operation successful, context was removed.
1454 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1455 * application need to destroy this VAMFContextID and all assotiated VAContextID
1457 * mf_context: VAMFContextID where context is added
1458 * context: VAContextID to be added
1460 VAStatus vaMFReleaseContext (
1462 VAMFContextID mf_context,
1468 * Buffers are used to pass various types of data from the
1469 * client to the server. The server maintains a data store
1470 * for each buffer created, and the client idenfies a buffer
1471 * through a unique buffer id assigned by the server.
1474 typedef VAGenericID VABufferID;
1478 VAPictureParameterBufferType = 0,
1479 VAIQMatrixBufferType = 1,
1480 VABitPlaneBufferType = 2,
1481 VASliceGroupMapBufferType = 3,
1482 VASliceParameterBufferType = 4,
1483 VASliceDataBufferType = 5,
1484 VAMacroblockParameterBufferType = 6,
1485 VAResidualDataBufferType = 7,
1486 VADeblockingParameterBufferType = 8,
1487 VAImageBufferType = 9,
1488 VAProtectedSliceDataBufferType = 10,
1489 VAQMatrixBufferType = 11,
1490 VAHuffmanTableBufferType = 12,
1491 VAProbabilityBufferType = 13,
1493 /* Following are encode buffer types */
1494 VAEncCodedBufferType = 21,
1495 VAEncSequenceParameterBufferType = 22,
1496 VAEncPictureParameterBufferType = 23,
1497 VAEncSliceParameterBufferType = 24,
1498 VAEncPackedHeaderParameterBufferType = 25,
1499 VAEncPackedHeaderDataBufferType = 26,
1500 VAEncMiscParameterBufferType = 27,
1501 VAEncMacroblockParameterBufferType = 28,
1502 VAEncMacroblockMapBufferType = 29,
1505 * \brief Encoding QP buffer
1507 * This buffer contains QP per MB for encoding. Currently
1508 * VAEncQPBufferH264 is defined for H.264 encoding, see
1509 * #VAEncQPBufferH264 for details
1511 VAEncQPBufferType = 30,
1512 /* Following are video processing buffer types */
1514 * \brief Video processing pipeline parameter buffer.
1516 * This buffer describes the video processing pipeline. See
1517 * #VAProcPipelineParameterBuffer for details.
1519 VAProcPipelineParameterBufferType = 41,
1521 * \brief Video filter parameter buffer.
1523 * This buffer describes the video filter parameters. All buffers
1524 * inherit from #VAProcFilterParameterBufferBase, thus including
1525 * a unique filter buffer type.
1527 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1528 * Filters requiring advanced parameters include, but are not limited to,
1529 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1530 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1532 VAProcFilterParameterBufferType = 42,
1534 * \brief FEI specific buffer types
1536 VAEncFEIMVBufferType = 43,
1537 VAEncFEIMBCodeBufferType = 44,
1538 VAEncFEIDistortionBufferType = 45,
1539 VAEncFEIMBControlBufferType = 46,
1540 VAEncFEIMVPredictorBufferType = 47,
1545 * Processing rate parameter for encode.
1547 typedef struct _VAProcessingRateParameterEnc {
1548 /** \brief Profile level */
1550 uint8_t reserved[3];
1551 /** \brief quality level. When set to 0, default quality
1554 uint32_t quality_level;
1555 /** \brief Period between I frames. */
1556 uint32_t intra_period;
1557 /** \brief Period between I/P frames. */
1559 } VAProcessingRateParameterEnc;
1562 * Processing rate parameter for decode.
1564 typedef struct _VAProcessingRateParameterDec {
1565 /** \brief Profile level */
1567 uint8_t reserved0[3];
1569 } VAProcessingRateParameterDec;
1571 typedef struct _VAProcessingRateParameter {
1573 VAProcessingRateParameterEnc proc_buf_enc;
1574 VAProcessingRateParameterDec proc_buf_dec;
1576 } VAProcessingRateParameter;
1579 * \brief Queries processing rate for the supplied config.
1581 * This function queries the processing rate based on parameters in
1582 * \c proc_buf for the given \c config. Upon successful return, the processing
1583 * rate value will be stored in \c processing_rate. Processing rate is
1584 * specified as the number of macroblocks per second.
1586 * If NULL is passed to the \c proc_buf, the default processing rate for the
1587 * given configuration will be returned.
1589 * @param[in] dpy the VA display
1590 * @param[in] config the config identifying a codec or a video
1591 * processing pipeline
1592 * @param[in] proc_buf the buffer that contains the parameters for
1593 either the encode or decode processing rate
1594 * @param[out] processing_rate processing rate in number of macroblocks per
1595 second constrained by parameters specified in proc_buf
1599 vaQueryProcessingRate(
1602 VAProcessingRateParameter *proc_buf,
1603 unsigned int *processing_rate
1608 VAEncMiscParameterTypeFrameRate = 0,
1609 VAEncMiscParameterTypeRateControl = 1,
1610 VAEncMiscParameterTypeMaxSliceSize = 2,
1611 VAEncMiscParameterTypeAIR = 3,
1612 /** \brief Buffer type used to express a maximum frame size (in bits). */
1613 VAEncMiscParameterTypeMaxFrameSize = 4,
1614 /** \brief Buffer type used for HRD parameters. */
1615 VAEncMiscParameterTypeHRD = 5,
1616 VAEncMiscParameterTypeQualityLevel = 6,
1617 /** \brief Buffer type used for Rolling intra refresh */
1618 VAEncMiscParameterTypeRIR = 7,
1619 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1620 VAEncMiscParameterTypeQuantization = 8,
1621 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1622 * rate control, when the user has externally skipped frames. */
1623 VAEncMiscParameterTypeSkipFrame = 9,
1624 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1625 VAEncMiscParameterTypeROI = 10,
1626 /** \brief Buffer type used for temporal layer structure */
1627 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1628 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1629 VAEncMiscParameterTypeDirtyRect = 13,
1630 /** \brief Buffer type used for parallel BRC parameters. */
1631 VAEncMiscParameterTypeParallelBRC = 14,
1632 /** \brief Buffer type used for FEI input frame level parameters */
1633 VAEncMiscParameterTypeFEIFrameControl = 18,
1634 } VAEncMiscParameterType;
1636 /** \brief Packed header type. */
1638 /** \brief Packed sequence header. */
1639 VAEncPackedHeaderSequence = 1,
1640 /** \brief Packed picture header. */
1641 VAEncPackedHeaderPicture = 2,
1642 /** \brief Packed slice header. */
1643 VAEncPackedHeaderSlice = 3,
1645 * \brief Packed raw header.
1647 * Packed raw data header can be used by the client to insert a header
1648 * into the bitstream data buffer at the point it is passed, the driver
1649 * will handle the raw packed header based on "has_emulation_bytes" field
1650 * in the packed header parameter structure.
1652 VAEncPackedHeaderRawData = 4,
1654 * \brief Misc packed header. See codec-specific definitions.
1657 * This is a deprecated packed header type. All applications can use
1658 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1660 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1661 } VAEncPackedHeaderType;
1663 /** \brief Packed header parameter. */
1664 typedef struct _VAEncPackedHeaderParameterBuffer {
1665 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1667 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1668 uint32_t bit_length;
1669 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1670 uint8_t has_emulation_bytes;
1672 /** \brief Reserved bytes for future use, must be zero */
1673 uint32_t va_reserved[VA_PADDING_LOW];
1674 } VAEncPackedHeaderParameterBuffer;
1677 * For application, e.g. set a new bitrate
1678 * VABufferID buf_id;
1679 * VAEncMiscParameterBuffer *misc_param;
1680 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1682 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1683 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1684 * 1, NULL, &buf_id);
1686 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1687 * misc_param->type = VAEncMiscParameterTypeRateControl;
1688 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1689 * misc_rate_ctrl->bits_per_second = 6400000;
1690 * vaUnmapBuffer(dpy, buf_id);
1691 * vaRenderPicture(dpy, context, &buf_id, 1);
1693 typedef struct _VAEncMiscParameterBuffer
1695 VAEncMiscParameterType type;
1697 } VAEncMiscParameterBuffer;
1699 /** \brief Temporal layer Structure*/
1700 typedef struct _VAEncMiscParameterTemporalLayerStructure
1702 /** \brief The number of temporal layers */
1703 uint32_t number_of_layers;
1704 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1705 uint32_t periodicity;
1707 * \brief The array indicating the layer id for each frame
1709 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1710 * ids for frames starting from the 2nd frame.
1712 uint32_t layer_id[32];
1714 /** \brief Reserved bytes for future use, must be zero */
1715 uint32_t va_reserved[VA_PADDING_LOW];
1716 } VAEncMiscParameterTemporalLayerStructure;
1719 /** \brief Rate control parameters */
1720 typedef struct _VAEncMiscParameterRateControl
1722 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1723 uint32_t bits_per_second;
1724 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1725 * bit-rate for example if target_percentage is 95 then the rate control will target
1726 * a bit-rate that is 95% of the maximum bit-rate
1728 uint32_t target_percentage;
1729 /* windows size in milliseconds. For example if this is set to 500,
1730 * then the rate control will guarantee the target bit-rate over a 500 ms window
1732 uint32_t window_size;
1733 /* initial QP at I frames */
1734 uint32_t initial_qp;
1736 uint32_t basic_unit_size;
1742 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1743 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1744 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1746 * The temporal layer that the rate control parameters are specified for.
1748 uint32_t temporal_id : 8;
1749 uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1750 uint32_t enable_parallel_brc : 1;
1751 uint32_t enable_dynamic_scaling : 1;
1752 /** \brief Frame Tolerance Mode
1753 * Indicates the tolerance the application has to variations in the frame size.
1754 * For example, wireless display scenarios may require very steady bit rate to
1755 * reduce buffering time. It affects the rate control algorithm used,
1756 * but may or may not have an effect based on the combination of other BRC
1757 * parameters. Only valid when the driver reports support for
1758 * #VAConfigAttribFrameSizeToleranceSupport.
1760 * equals 0 -- normal mode;
1761 * equals 1 -- maps to sliding window;
1762 * equals 2 -- maps to low delay mode;
1765 uint32_t frame_tolerance_mode : 2;
1766 uint32_t reserved : 12;
1770 uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1771 /** \brief Reserved bytes for future use, must be zero */
1773 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1774 } VAEncMiscParameterRateControl;
1776 typedef struct _VAEncMiscParameterFrameRate
1779 * The framerate is specified as a number of frames per second, as a
1780 * fraction. The denominator of the fraction is given in the top half
1781 * (the high two bytes) of the framerate field, and the numerator is
1782 * given in the bottom half (the low two bytes).
1785 * denominator = framerate >> 16 & 0xffff;
1786 * numerator = framerate & 0xffff;
1787 * fps = numerator / denominator;
1789 * For example, if framerate is set to (100 << 16 | 750), this is
1790 * 750 / 100, hence 7.5fps.
1792 * If the denominator is zero (the high two bytes are both zero) then
1793 * it takes the value one instead, so the framerate is just the integer
1794 * in the low 2 bytes.
1802 * The temporal id the framerate parameters are specified for.
1804 uint32_t temporal_id : 8;
1805 uint32_t reserved : 24;
1810 /** \brief Reserved bytes for future use, must be zero */
1811 uint32_t va_reserved[VA_PADDING_LOW];
1812 } VAEncMiscParameterFrameRate;
1815 * Allow a maximum slice size to be specified (in bits).
1816 * The encoder will attempt to make sure that individual slices do not exceed this size
1817 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1819 typedef struct _VAEncMiscParameterMaxSliceSize
1821 uint32_t max_slice_size;
1823 /** \brief Reserved bytes for future use, must be zero */
1824 uint32_t va_reserved[VA_PADDING_LOW];
1825 } VAEncMiscParameterMaxSliceSize;
1827 typedef struct _VAEncMiscParameterAIR
1829 uint32_t air_num_mbs;
1830 uint32_t air_threshold;
1831 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1833 /** \brief Reserved bytes for future use, must be zero */
1834 uint32_t va_reserved[VA_PADDING_LOW];
1835 } VAEncMiscParameterAIR;
1838 * \brief Rolling intra refresh data structure for encoding.
1840 typedef struct _VAEncMiscParameterRIR
1846 * \brief Indicate if intra refresh is enabled in column/row.
1848 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1849 * by the driver before sending this structure.
1852 /* \brief enable RIR in column */
1853 uint32_t enable_rir_column : 1;
1854 /* \brief enable RIR in row */
1855 uint32_t enable_rir_row : 1;
1856 uint32_t reserved : 30;
1861 * \brief Indicates the column or row location in MB. It is ignored if
1864 uint16_t intra_insertion_location;
1866 * \brief Indicates the number of columns or rows in MB. It is ignored if
1869 uint16_t intra_insert_size;
1871 * \brief indicates the Qp difference for inserted intra columns or rows.
1872 * App can use this to adjust intra Qp based on bitrate & max frame size.
1874 uint8_t qp_delta_for_inserted_intra;
1875 /** \brief Reserved bytes for future use, must be zero */
1876 uint32_t va_reserved[VA_PADDING_LOW];
1877 } VAEncMiscParameterRIR;
1879 typedef struct _VAEncMiscParameterHRD
1881 uint32_t initial_buffer_fullness; /* in bits */
1882 uint32_t buffer_size; /* in bits */
1884 /** \brief Reserved bytes for future use, must be zero */
1885 uint32_t va_reserved[VA_PADDING_LOW];
1886 } VAEncMiscParameterHRD;
1889 * \brief Defines a maximum frame size (in bits).
1891 * This misc parameter buffer defines the maximum size of a frame (in
1892 * bits). The encoder will try to make sure that each frame does not
1893 * exceed this size. Otherwise, if the frame size exceeds this size,
1894 * the \c status flag of #VACodedBufferSegment will contain
1895 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1897 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1898 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1899 VAEncMiscParameterType type;
1900 /** \brief Maximum size of a frame (in bits). */
1901 uint32_t max_frame_size;
1903 /** \brief Reserved bytes for future use, must be zero */
1904 uint32_t va_reserved[VA_PADDING_LOW];
1905 } VAEncMiscParameterBufferMaxFrameSize;
1908 * \brief Encoding quality level.
1910 * The encoding quality could be set through this structure, if the implementation
1911 * supports multiple quality levels. The quality level set through this structure is
1912 * persistent over the entire coded sequence, or until a new structure is being sent.
1913 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1914 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1915 * quality. The quality level setting is used as a trade-off between quality and speed/power
1916 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1918 typedef struct _VAEncMiscParameterBufferQualityLevel {
1919 /** \brief Encoding quality level setting. When set to 0, default quality
1922 uint32_t quality_level;
1924 /** \brief Reserved bytes for future use, must be zero */
1925 uint32_t va_reserved[VA_PADDING_LOW];
1926 } VAEncMiscParameterBufferQualityLevel;
1929 * \brief Quantization settings for encoding.
1931 * Some encoders support special types of quantization such as trellis, and this structure
1932 * can be used by the app to control these special types of quantization by the encoder.
1934 typedef struct _VAEncMiscParameterQuantization
1938 /* if no flags is set then quantization is determined by the driver */
1941 /* \brief disable trellis for all frames/fields */
1942 uint64_t disable_trellis : 1;
1943 /* \brief enable trellis for I frames/fields */
1944 uint64_t enable_trellis_I : 1;
1945 /* \brief enable trellis for P frames/fields */
1946 uint64_t enable_trellis_P : 1;
1947 /* \brief enable trellis for B frames/fields */
1948 uint64_t enable_trellis_B : 1;
1949 uint64_t reserved : 28;
1952 } quantization_flags;
1953 } VAEncMiscParameterQuantization;
1956 * \brief Encoding skip frame.
1958 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1959 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1960 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1961 * current frame. It is allowed for the application to still send in packed headers for the driver to
1962 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1964 typedef struct _VAEncMiscParameterSkipFrame {
1965 /** \brief Indicates skip frames as below.
1966 * 0: Encode as normal, no skip.
1967 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1968 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1969 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1970 * in VAEncPackedHeaderPicture). */
1971 uint8_t skip_frame_flag;
1972 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1973 uint8_t num_skip_frames;
1974 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1975 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1976 uint32_t size_skip_frames;
1978 /** \brief Reserved bytes for future use, must be zero */
1979 uint32_t va_reserved[VA_PADDING_LOW];
1980 } VAEncMiscParameterSkipFrame;
1983 * \brief Encoding region-of-interest (ROI).
1985 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1986 * supports ROI input. The ROI set through this structure is applicable only to the
1987 * current frame or field, so must be sent every frame or field to be applied. The number of
1988 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1989 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1991 typedef struct _VAEncROI
1993 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1994 * codec coding units. It is relative to frame coordinates for the frame case and
1995 * to field coordinates for the field case. */
1996 VARectangle roi_rectangle;
2000 * \ref roi_value specifies ROI delta QP or ROI priority.
2001 * -- ROI delta QP is the value that will be added on top of the frame level QP.
2002 * -- ROI priority specifies the priority of a region, it can be positive (more important)
2003 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2004 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2005 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2006 * regions, the roi_value that is first in the ROI array will have priority.
2008 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2009 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2011 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2012 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2013 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2018 typedef struct _VAEncMiscParameterBufferROI {
2019 /** \brief Number of ROIs being sent.*/
2022 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2023 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
2025 int8_t max_delta_qp;
2026 int8_t min_delta_qp;
2028 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
2029 * coordinates for the frame case and to field coordinates for the field case.*/
2034 * \brief An indication for roi value.
2036 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2037 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2038 * in #VAEncROI should be used as ROI priority.
2040 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2041 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2042 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2043 * when VAConfigAttribRateControl == VA_RC_CQP.
2045 uint32_t roi_value_is_qp_delta : 1;
2046 uint32_t reserved : 31;
2051 /** \brief Reserved bytes for future use, must be zero */
2052 uint32_t va_reserved[VA_PADDING_LOW];
2053 } VAEncMiscParameterBufferROI;
2055 * \brief Dirty rectangle data structure for encoding.
2057 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2058 * implementation supports dirty rect input. The rect set through this structure is applicable
2059 * only to the current frame or field, so must be sent every frame or field to be applied.
2060 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
2061 * encoder will use the rect information to know those rectangle areas have changed while the
2062 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2063 * previous picture. The encoder may do some internal optimizations.
2065 typedef struct _VAEncMiscParameterBufferDirtyRect
2067 /** \brief Number of Rectangle being sent.*/
2068 uint32_t num_roi_rectangle;
2070 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2071 VARectangle *roi_rectangle;
2072 } VAEncMiscParameterBufferDirtyRect;
2074 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2075 typedef struct _VAEncMiscParameterParallelRateControl {
2076 /** brief Number of layers*/
2077 uint32_t num_layers;
2078 /** brief Number of B frames per layer per GOP.
2080 * it should be allocated by application, and the is num_layers.
2081 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2082 uint32_t *num_b_in_gop;
2083 } VAEncMiscParameterParallelRateControl;
2086 * There will be cases where the bitstream buffer will not have enough room to hold
2087 * the data for the entire slice, and the following flags will be used in the slice
2088 * parameter to signal to the server for the possible cases.
2089 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2090 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2091 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2093 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2094 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2095 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2096 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2098 /* Codec-independent Slice Parameter Buffer base */
2099 typedef struct _VASliceParameterBufferBase
2101 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2102 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2103 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2104 } VASliceParameterBufferBase;
2106 /**********************************
2107 * JPEG common data structures
2108 **********************************/
2110 * \brief Huffman table for JPEG decoding.
2112 * This structure holds the complete Huffman tables. This is an
2113 * aggregation of all Huffman table (DHT) segments maintained by the
2114 * application. i.e. up to 2 Huffman tables are stored in there for
2117 * The #load_huffman_table array can be used as a hint to notify the
2118 * VA driver implementation about which table(s) actually changed
2119 * since the last submission of this buffer.
2121 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2122 /** \brief Specifies which #huffman_table is valid. */
2123 uint8_t load_huffman_table[2];
2124 /** \brief Huffman tables indexed by table identifier (Th). */
2126 /** @name DC table (up to 12 categories) */
2128 /** \brief Number of Huffman codes of length i + 1 (Li). */
2129 uint8_t num_dc_codes[16];
2130 /** \brief Value associated with each Huffman code (Vij). */
2131 uint8_t dc_values[12];
2133 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2135 /** \brief Number of Huffman codes of length i + 1 (Li). */
2136 uint8_t num_ac_codes[16];
2137 /** \brief Value associated with each Huffman code (Vij). */
2138 uint8_t ac_values[162];
2139 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2144 /** \brief Reserved bytes for future use, must be zero */
2145 uint32_t va_reserved[VA_PADDING_LOW];
2146 } VAHuffmanTableBufferJPEGBaseline;
2148 /****************************
2149 * MPEG-2 data structures
2150 ****************************/
2152 /* MPEG-2 Picture Parameter Buffer */
2154 * For each frame or field, and before any slice data, a single
2155 * picture parameter buffer must be send.
2157 typedef struct _VAPictureParameterBufferMPEG2
2159 uint16_t horizontal_size;
2160 uint16_t vertical_size;
2161 VASurfaceID forward_reference_picture;
2162 VASurfaceID backward_reference_picture;
2163 /* meanings of the following fields are the same as in the standard */
2164 int32_t picture_coding_type;
2165 int32_t f_code; /* pack all four fcode into this */
2168 uint32_t intra_dc_precision : 2;
2169 uint32_t picture_structure : 2;
2170 uint32_t top_field_first : 1;
2171 uint32_t frame_pred_frame_dct : 1;
2172 uint32_t concealment_motion_vectors : 1;
2173 uint32_t q_scale_type : 1;
2174 uint32_t intra_vlc_format : 1;
2175 uint32_t alternate_scan : 1;
2176 uint32_t repeat_first_field : 1;
2177 uint32_t progressive_frame : 1;
2178 uint32_t is_first_field : 1; /* indicate whether the current field
2179 * is the first field for field picture
2183 } picture_coding_extension;
2185 /** \brief Reserved bytes for future use, must be zero */
2186 uint32_t va_reserved[VA_PADDING_LOW];
2187 } VAPictureParameterBufferMPEG2;
2189 /** MPEG-2 Inverse Quantization Matrix Buffer */
2190 typedef struct _VAIQMatrixBufferMPEG2
2192 /** \brief Same as the MPEG-2 bitstream syntax element. */
2193 int32_t load_intra_quantiser_matrix;
2194 /** \brief Same as the MPEG-2 bitstream syntax element. */
2195 int32_t load_non_intra_quantiser_matrix;
2196 /** \brief Same as the MPEG-2 bitstream syntax element. */
2197 int32_t load_chroma_intra_quantiser_matrix;
2198 /** \brief Same as the MPEG-2 bitstream syntax element. */
2199 int32_t load_chroma_non_intra_quantiser_matrix;
2200 /** \brief Luminance intra matrix, in zig-zag scan order. */
2201 uint8_t intra_quantiser_matrix[64];
2202 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2203 uint8_t non_intra_quantiser_matrix[64];
2204 /** \brief Chroma intra matrix, in zig-zag scan order. */
2205 uint8_t chroma_intra_quantiser_matrix[64];
2206 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2207 uint8_t chroma_non_intra_quantiser_matrix[64];
2209 /** \brief Reserved bytes for future use, must be zero */
2210 uint32_t va_reserved[VA_PADDING_LOW];
2211 } VAIQMatrixBufferMPEG2;
2213 /** MPEG-2 Slice Parameter Buffer */
2214 typedef struct _VASliceParameterBufferMPEG2
2216 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2217 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2218 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2219 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2220 uint32_t slice_horizontal_position;
2221 uint32_t slice_vertical_position;
2222 int32_t quantiser_scale_code;
2223 int32_t intra_slice_flag;
2225 /** \brief Reserved bytes for future use, must be zero */
2226 uint32_t va_reserved[VA_PADDING_LOW];
2227 } VASliceParameterBufferMPEG2;
2229 /** MPEG-2 Macroblock Parameter Buffer */
2230 typedef struct _VAMacroblockParameterBufferMPEG2
2232 uint16_t macroblock_address;
2234 * macroblock_address (in raster scan order)
2236 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2238 uint8_t macroblock_type; /* see definition below */
2241 uint32_t frame_motion_type : 2;
2242 uint32_t field_motion_type : 2;
2243 uint32_t dct_type : 1;
2247 uint8_t motion_vertical_field_select;
2249 * motion_vertical_field_select:
2250 * see section 6.3.17.2 in the spec
2251 * only the lower 4 bits are used
2252 * bit 0: first vector forward
2253 * bit 1: first vector backward
2254 * bit 2: second vector forward
2255 * bit 3: second vector backward
2257 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2258 uint16_t coded_block_pattern;
2260 * The bitplanes for coded_block_pattern are described
2261 * in Figure 6.10-12 in the spec
2264 /* Number of skipped macroblocks after this macroblock */
2265 uint16_t num_skipped_macroblocks;
2267 /** \brief Reserved bytes for future use, must be zero */
2268 uint32_t va_reserved[VA_PADDING_LOW];
2269 } VAMacroblockParameterBufferMPEG2;
2272 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2274 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2275 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2276 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2277 #define VA_MB_TYPE_MOTION_INTRA 0x10
2280 * MPEG-2 Residual Data Buffer
2281 * For each macroblock, there wil be 64 shorts (16-bit) in the
2282 * residual data buffer
2285 /****************************
2286 * MPEG-4 Part 2 data structures
2287 ****************************/
2289 /* MPEG-4 Picture Parameter Buffer */
2291 * For each frame or field, and before any slice data, a single
2292 * picture parameter buffer must be send.
2294 typedef struct _VAPictureParameterBufferMPEG4
2297 uint16_t vop_height;
2298 VASurfaceID forward_reference_picture;
2299 VASurfaceID backward_reference_picture;
2302 uint32_t short_video_header : 1;
2303 uint32_t chroma_format : 2;
2304 uint32_t interlaced : 1;
2305 uint32_t obmc_disable : 1;
2306 uint32_t sprite_enable : 2;
2307 uint32_t sprite_warping_accuracy : 2;
2308 uint32_t quant_type : 1;
2309 uint32_t quarter_sample : 1;
2310 uint32_t data_partitioned : 1;
2311 uint32_t reversible_vlc : 1;
2312 uint32_t resync_marker_disable : 1;
2316 uint8_t no_of_sprite_warping_points;
2317 int16_t sprite_trajectory_du[3];
2318 int16_t sprite_trajectory_dv[3];
2319 uint8_t quant_precision;
2322 uint32_t vop_coding_type : 2;
2323 uint32_t backward_reference_vop_coding_type : 2;
2324 uint32_t vop_rounding_type : 1;
2325 uint32_t intra_dc_vlc_thr : 3;
2326 uint32_t top_field_first : 1;
2327 uint32_t alternate_vertical_scan_flag : 1;
2331 uint8_t vop_fcode_forward;
2332 uint8_t vop_fcode_backward;
2333 uint16_t vop_time_increment_resolution;
2334 /* short header related */
2335 uint8_t num_gobs_in_vop;
2336 uint8_t num_macroblocks_in_gob;
2337 /* for direct mode prediction */
2341 /** \brief Reserved bytes for future use, must be zero */
2342 uint32_t va_reserved[VA_PADDING_LOW];
2343 } VAPictureParameterBufferMPEG4;
2345 /** MPEG-4 Inverse Quantization Matrix Buffer */
2346 typedef struct _VAIQMatrixBufferMPEG4
2348 /** Same as the MPEG-4:2 bitstream syntax element. */
2349 int32_t load_intra_quant_mat;
2350 /** Same as the MPEG-4:2 bitstream syntax element. */
2351 int32_t load_non_intra_quant_mat;
2352 /** The matrix for intra blocks, in zig-zag scan order. */
2353 uint8_t intra_quant_mat[64];
2354 /** The matrix for non-intra blocks, in zig-zag scan order. */
2355 uint8_t non_intra_quant_mat[64];
2357 /** \brief Reserved bytes for future use, must be zero */
2358 uint32_t va_reserved[VA_PADDING_LOW];
2359 } VAIQMatrixBufferMPEG4;
2361 /** MPEG-4 Slice Parameter Buffer */
2362 typedef struct _VASliceParameterBufferMPEG4
2364 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2365 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2366 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2367 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2368 uint32_t macroblock_number;
2369 int32_t quant_scale;
2371 /** \brief Reserved bytes for future use, must be zero */
2372 uint32_t va_reserved[VA_PADDING_LOW];
2373 } VASliceParameterBufferMPEG4;
2376 VC-1 data structures
2379 typedef enum /* see 7.1.1.32 */
2382 VAMvMode1MvHalfPel = 1,
2383 VAMvMode1MvHalfPelBilinear = 2,
2384 VAMvModeMixedMv = 3,
2385 VAMvModeIntensityCompensation = 4
2388 /** VC-1 Picture Parameter Buffer */
2390 * For each picture, and before any slice data, a picture parameter
2391 * buffer must be send. Multiple picture parameter buffers may be
2392 * sent for a single picture. In that case picture parameters will
2393 * apply to all slice data that follow it until a new picture
2394 * parameter buffer is sent.
2397 * pic_quantizer_type should be set to the applicable quantizer
2398 * type as defined by QUANTIZER (J.1.19) and either
2399 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2401 typedef struct _VAPictureParameterBufferVC1
2403 VASurfaceID forward_reference_picture;
2404 VASurfaceID backward_reference_picture;
2405 /* if out-of-loop post-processing is done on the render
2406 target, then we need to keep the in-loop decoded
2407 picture as a reference picture */
2408 VASurfaceID inloop_decoded_picture;
2410 /* sequence layer for AP or meta data for SP and MP */
2413 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2414 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2415 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2416 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2417 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2418 uint32_t multires : 1; /* METADATA::MULTIRES */
2419 uint32_t overlap : 1; /* METADATA::OVERLAP */
2420 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2421 uint32_t rangered : 1; /* METADATA::RANGERED */
2422 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2423 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2428 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2429 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2432 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2433 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2434 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2435 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2438 } entrypoint_fields;
2439 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2440 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2443 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2444 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2445 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2446 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2449 } range_mapping_fields;
2451 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2452 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2453 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2454 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2455 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2456 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2457 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2458 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2459 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2463 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2464 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2465 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2466 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2467 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2473 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2474 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2475 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2476 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2477 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2478 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2479 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2485 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2486 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2487 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2488 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2489 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2490 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2491 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2494 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2497 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2498 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2499 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2500 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2506 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2507 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2508 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2509 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2510 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2511 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2512 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2513 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2514 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2515 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2521 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2522 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2523 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2524 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2525 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2526 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2527 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2528 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2529 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2530 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2531 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2534 } pic_quantizer_fields;
2537 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2538 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2539 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2540 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2541 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2542 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2547 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2548 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2549 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2551 /** \brief Reserved bytes for future use, must be zero */
2552 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2553 } VAPictureParameterBufferVC1;
2555 /** VC-1 Bitplane Buffer
2556 There will be at most three bitplanes coded in any picture header. To send
2557 the bitplane data more efficiently, each byte is divided in two nibbles, with
2558 each nibble carrying three bitplanes for one macroblock. The following table
2559 shows the bitplane data arrangement within each nibble based on the picture
2562 Picture Type Bit3 Bit2 Bit1 Bit0
2563 I or BI OVERFLAGS ACPRED FIELDTX
2564 P MYTYPEMB SKIPMB DIRECTMB
2565 B FORWARDMB SKIPMB DIRECTMB
2567 Within each byte, the lower nibble is for the first MB and the upper nibble is
2568 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2569 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2570 Macroblock #2 in the first row.
2573 /* VC-1 Slice Parameter Buffer */
2574 typedef struct _VASliceParameterBufferVC1
2576 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2577 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2578 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2579 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2580 uint32_t slice_vertical_position;
2582 /** \brief Reserved bytes for future use, must be zero */
2583 uint32_t va_reserved[VA_PADDING_LOW];
2584 } VASliceParameterBufferVC1;
2586 /* VC-1 Slice Data Buffer */
2588 This is simplely a buffer containing raw bit-stream bytes
2591 /****************************
2592 * H.264/AVC data structures
2593 ****************************/
2595 typedef struct _VAPictureH264
2597 VASurfaceID picture_id;
2600 int32_t TopFieldOrderCnt;
2601 int32_t BottomFieldOrderCnt;
2603 /** \brief Reserved bytes for future use, must be zero */
2604 uint32_t va_reserved[VA_PADDING_LOW];
2606 /* flags in VAPictureH264 could be OR of the following */
2607 #define VA_PICTURE_H264_INVALID 0x00000001
2608 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2609 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2610 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2611 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2613 /** H.264 Picture Parameter Buffer */
2615 * For each picture, and before any slice data, a single
2616 * picture parameter buffer must be send.
2618 typedef struct _VAPictureParameterBufferH264
2620 VAPictureH264 CurrPic;
2621 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2622 uint16_t picture_width_in_mbs_minus1;
2623 uint16_t picture_height_in_mbs_minus1;
2624 uint8_t bit_depth_luma_minus8;
2625 uint8_t bit_depth_chroma_minus8;
2626 uint8_t num_ref_frames;
2629 uint32_t chroma_format_idc : 2;
2630 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2631 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2632 uint32_t frame_mbs_only_flag : 1;
2633 uint32_t mb_adaptive_frame_field_flag : 1;
2634 uint32_t direct_8x8_inference_flag : 1;
2635 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2636 uint32_t log2_max_frame_num_minus4 : 4;
2637 uint32_t pic_order_cnt_type : 2;
2638 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2639 uint32_t delta_pic_order_always_zero_flag : 1;
2643 // FMO is not supported.
2644 va_deprecated uint8_t num_slice_groups_minus1;
2645 va_deprecated uint8_t slice_group_map_type;
2646 va_deprecated uint16_t slice_group_change_rate_minus1;
2647 int8_t pic_init_qp_minus26;
2648 int8_t pic_init_qs_minus26;
2649 int8_t chroma_qp_index_offset;
2650 int8_t second_chroma_qp_index_offset;
2653 uint32_t entropy_coding_mode_flag : 1;
2654 uint32_t weighted_pred_flag : 1;
2655 uint32_t weighted_bipred_idc : 2;
2656 uint32_t transform_8x8_mode_flag : 1;
2657 uint32_t field_pic_flag : 1;
2658 uint32_t constrained_intra_pred_flag : 1;
2659 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2660 uint32_t deblocking_filter_control_present_flag : 1;
2661 uint32_t redundant_pic_cnt_present_flag : 1;
2662 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2668 /** \brief Reserved bytes for future use, must be zero */
2669 uint32_t va_reserved[VA_PADDING_MEDIUM];
2670 } VAPictureParameterBufferH264;
2672 /** H.264 Inverse Quantization Matrix Buffer */
2673 typedef struct _VAIQMatrixBufferH264
2675 /** \brief 4x4 scaling list, in raster scan order. */
2676 uint8_t ScalingList4x4[6][16];
2677 /** \brief 8x8 scaling list, in raster scan order. */
2678 uint8_t ScalingList8x8[2][64];
2680 /** \brief Reserved bytes for future use, must be zero */
2681 uint32_t va_reserved[VA_PADDING_LOW];
2682 } VAIQMatrixBufferH264;
2684 /** H.264 Slice Parameter Buffer */
2685 typedef struct _VASliceParameterBufferH264
2687 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2688 /** \brief Byte offset to the NAL Header Unit for this slice. */
2689 uint32_t slice_data_offset;
2690 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2692 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2694 * This bit offset is relative to and includes the NAL unit byte
2695 * and represents the number of bits parsed in the slice_header()
2696 * after the removal of any emulation prevention bytes in
2697 * there. However, the slice data buffer passed to the hardware is
2698 * the original bitstream, thus including any emulation prevention
2701 uint16_t slice_data_bit_offset;
2702 uint16_t first_mb_in_slice;
2704 uint8_t direct_spatial_mv_pred_flag;
2706 * H264/AVC syntax element
2708 * if num_ref_idx_active_override_flag equals 0, host decoder should
2709 * set its value to num_ref_idx_l0_default_active_minus1.
2711 uint8_t num_ref_idx_l0_active_minus1;
2713 * H264/AVC syntax element
2715 * if num_ref_idx_active_override_flag equals 0, host decoder should
2716 * set its value to num_ref_idx_l1_default_active_minus1.
2718 uint8_t num_ref_idx_l1_active_minus1;
2719 uint8_t cabac_init_idc;
2720 int8_t slice_qp_delta;
2721 uint8_t disable_deblocking_filter_idc;
2722 int8_t slice_alpha_c0_offset_div2;
2723 int8_t slice_beta_offset_div2;
2724 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2725 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2726 uint8_t luma_log2_weight_denom;
2727 uint8_t chroma_log2_weight_denom;
2728 uint8_t luma_weight_l0_flag;
2729 int16_t luma_weight_l0[32];
2730 int16_t luma_offset_l0[32];
2731 uint8_t chroma_weight_l0_flag;
2732 int16_t chroma_weight_l0[32][2];
2733 int16_t chroma_offset_l0[32][2];
2734 uint8_t luma_weight_l1_flag;
2735 int16_t luma_weight_l1[32];
2736 int16_t luma_offset_l1[32];
2737 uint8_t chroma_weight_l1_flag;
2738 int16_t chroma_weight_l1[32][2];
2739 int16_t chroma_offset_l1[32][2];
2741 /** \brief Reserved bytes for future use, must be zero */
2742 uint32_t va_reserved[VA_PADDING_LOW];
2743 } VASliceParameterBufferH264;
2745 /****************************
2746 * Common encode data structures
2747 ****************************/
2750 VAEncPictureTypeIntra = 0,
2751 VAEncPictureTypePredictive = 1,
2752 VAEncPictureTypeBidirectional = 2,
2755 /* Encode Slice Parameter Buffer */
2756 typedef struct _VAEncSliceParameterBuffer
2758 uint32_t start_row_number; /* starting MB row number for this slice */
2759 uint32_t slice_height; /* slice height measured in MB */
2762 uint32_t is_intra : 1;
2763 uint32_t disable_deblocking_filter_idc : 2;
2764 uint32_t uses_long_term_ref :1;
2765 uint32_t is_long_term_ref :1;
2770 /** \brief Reserved bytes for future use, must be zero */
2771 uint32_t va_reserved[VA_PADDING_LOW];
2772 } VAEncSliceParameterBuffer;
2775 /****************************
2776 * H.263 specific encode data structures
2777 ****************************/
2779 typedef struct _VAEncSequenceParameterBufferH263
2781 uint32_t intra_period;
2782 uint32_t bits_per_second;
2783 uint32_t frame_rate;
2784 uint32_t initial_qp;
2787 /** \brief Reserved bytes for future use, must be zero */
2788 uint32_t va_reserved[VA_PADDING_LOW];
2789 } VAEncSequenceParameterBufferH263;
2791 typedef struct _VAEncPictureParameterBufferH263
2793 VASurfaceID reference_picture;
2794 VASurfaceID reconstructed_picture;
2795 VABufferID coded_buf;
2796 uint16_t picture_width;
2797 uint16_t picture_height;
2798 VAEncPictureType picture_type;
2800 /** \brief Reserved bytes for future use, must be zero */
2801 uint32_t va_reserved[VA_PADDING_LOW];
2802 } VAEncPictureParameterBufferH263;
2804 /****************************
2805 * MPEG-4 specific encode data structures
2806 ****************************/
2808 typedef struct _VAEncSequenceParameterBufferMPEG4
2810 uint8_t profile_and_level_indication;
2811 uint32_t intra_period;
2812 uint32_t video_object_layer_width;
2813 uint32_t video_object_layer_height;
2814 uint32_t vop_time_increment_resolution;
2815 uint32_t fixed_vop_rate;
2816 uint32_t fixed_vop_time_increment;
2817 uint32_t bits_per_second;
2818 uint32_t frame_rate;
2819 uint32_t initial_qp;
2822 /** \brief Reserved bytes for future use, must be zero */
2823 uint32_t va_reserved[VA_PADDING_LOW];
2824 } VAEncSequenceParameterBufferMPEG4;
2826 typedef struct _VAEncPictureParameterBufferMPEG4
2828 VASurfaceID reference_picture;
2829 VASurfaceID reconstructed_picture;
2830 VABufferID coded_buf;
2831 uint16_t picture_width;
2832 uint16_t picture_height;
2833 uint32_t modulo_time_base; /* number of 1s */
2834 uint32_t vop_time_increment;
2835 VAEncPictureType picture_type;
2837 /** \brief Reserved bytes for future use, must be zero */
2838 uint32_t va_reserved[VA_PADDING_LOW];
2839 } VAEncPictureParameterBufferMPEG4;
2843 /** Buffer functions */
2846 * Creates a buffer for "num_elements" elements of "size" bytes and
2847 * initalize with "data".
2848 * if "data" is null, then the contents of the buffer data store
2850 * Basically there are two ways to get buffer data to the server side. One is
2851 * to call vaCreateBuffer() with a non-null "data", which results the data being
2852 * copied to the data store on the server side. A different method that
2853 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2854 * and then use vaMapBuffer() to map the data store from the server side to the
2855 * client address space for access.
2856 * The user must call vaDestroyBuffer() to destroy a buffer.
2857 * Note: image buffers are created by the library, not the client. Please see
2858 * vaCreateImage on how image buffers are managed.
2860 VAStatus vaCreateBuffer (
2862 VAContextID context,
2863 VABufferType type, /* in */
2864 unsigned int size, /* in */
2865 unsigned int num_elements, /* in */
2866 void *data, /* in */
2867 VABufferID *buf_id /* out */
2871 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
2872 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
2873 * can call vaMapBuffer with this Buffer ID to get virtual address.
2874 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
2875 * maybe it should align with 256, and one byte present one Qp.so, call the function.
2876 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
2877 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
2878 * pBuf + 256 is the start of next line.
2879 * different driver implementation maybe return different unit_size and pitch
2881 VAStatus vaCreateBuffer2(
2883 VAContextID context,
2886 unsigned int height,
2887 unsigned int *unit_size,
2888 unsigned int *pitch,
2893 * Convey to the server how many valid elements are in the buffer.
2894 * e.g. if multiple slice parameters are being held in a single buffer,
2895 * this will communicate to the server the number of slice parameters
2896 * that are valid in the buffer.
2898 VAStatus vaBufferSetNumElements (
2900 VABufferID buf_id, /* in */
2901 unsigned int num_elements /* in */
2906 * device independent data structure for codedbuffer
2910 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2911 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2912 * enough for the encoder to attempt to limit its size.
2913 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2914 * exceeded the maximum slice size specified.
2915 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2916 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2917 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2919 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2920 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2921 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2922 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2923 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2925 * \brief The frame has exceeded the maximum requested size.
2927 * This flag indicates that the encoded frame size exceeds the value
2928 * specified through a misc parameter buffer of type
2929 * #VAEncMiscParameterTypeMaxFrameSize.
2931 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2932 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2935 * \brief The coded buffer segment contains a single NAL unit.
2937 * This flag indicates that the coded buffer segment contains a
2938 * single NAL unit. This flag might be useful to the user for
2939 * processing the coded buffer.
2941 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2944 * \brief Coded buffer segment.
2946 * #VACodedBufferSegment is an element of a linked list describing
2947 * some information on the coded buffer. The coded buffer segment
2948 * could contain either a single NAL unit, or more than one NAL unit.
2949 * It is recommended (but not required) to return a single NAL unit
2950 * in a coded buffer segment, and the implementation should set the
2951 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2953 typedef struct _VACodedBufferSegment {
2955 * \brief Size of the data buffer in this segment (in bytes).
2958 /** \brief Bit offset into the data buffer where the video data starts. */
2959 uint32_t bit_offset;
2960 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2962 /** \brief Reserved for future use. */
2964 /** \brief Pointer to the start of the data buffer. */
2967 * \brief Pointer to the next #VACodedBufferSegment element,
2968 * or \c NULL if there is none.
2972 /** \brief Reserved bytes for future use, must be zero */
2973 uint32_t va_reserved[VA_PADDING_LOW];
2974 } VACodedBufferSegment;
2977 * Map data store of the buffer into the client's address space
2978 * vaCreateBuffer() needs to be called with "data" set to NULL before
2979 * calling vaMapBuffer()
2981 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2982 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2984 VAStatus vaMapBuffer (
2986 VABufferID buf_id, /* in */
2987 void **pbuf /* out */
2991 * After client making changes to a mapped data store, it needs to
2992 * "Unmap" it to let the server know that the data is ready to be
2993 * consumed by the server
2995 VAStatus vaUnmapBuffer (
2997 VABufferID buf_id /* in */
3001 * After this call, the buffer is deleted and this buffer_id is no longer valid
3003 * A buffer can be re-used and sent to the server by another Begin/Render/End
3004 * sequence if vaDestroyBuffer() is not called with this buffer.
3006 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3007 * hardware accelerator can result in performance dropping.
3009 VAStatus vaDestroyBuffer (
3011 VABufferID buffer_id
3014 /** \brief VA buffer information */
3016 /** \brief Buffer handle */
3018 /** \brief Buffer type (See \ref VABufferType). */
3021 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3023 * On input to vaAcquireBufferHandle(), this field can serve as a hint
3024 * to specify the set of memory types the caller is interested in.
3025 * On successful return from vaAcquireBufferHandle(), the field is
3026 * updated with the best matching memory type.
3029 /** \brief Size of the underlying buffer. */
3032 /** \brief Reserved bytes for future use, must be zero */
3033 uint32_t va_reserved[VA_PADDING_LOW];
3037 * \brief Acquires buffer handle for external API usage
3039 * Locks the VA buffer object \ref buf_id for external API usage like
3040 * EGL or OpenCL (OCL). This function is a synchronization point. This
3041 * means that any pending operation is guaranteed to be completed
3042 * prior to returning from the function.
3044 * If the referenced VA buffer object is the backing store of a VA
3045 * surface, then this function acts as if vaSyncSurface() on the
3046 * parent surface was called first.
3048 * The \ref VABufferInfo argument shall be zero'ed on input. On
3049 * successful output, the data structure is filled in with all the
3050 * necessary buffer level implementation details like handle, type,
3051 * memory type and memory size.
3053 * Note: the external API implementation, or the application, can
3054 * express the memory types it is interested in by filling in the \ref
3055 * mem_type field accordingly. On successful output, the memory type
3056 * that fits best the request and that was used is updated in the \ref
3057 * VABufferInfo data structure. If none of the supplied memory types
3058 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3059 * error is returned.
3061 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3062 * is called. Besides, no additional operation is allowed on any of
3063 * the buffer parent object until vaReleaseBufferHandle() is called.
3064 * e.g. decoding into a VA surface backed with the supplied VA buffer
3065 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3069 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3070 * does not support this interface
3071 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3072 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3073 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3074 * does not support exporting buffers of the specified type
3075 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3076 * memory types in \ref VABufferInfo.mem_type was supported
3078 * @param[in] dpy the VA display
3079 * @param[in] buf_id the VA buffer
3080 * @param[in,out] buf_info the associated VA buffer information
3081 * @return VA_STATUS_SUCCESS if successful
3084 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3087 * \brief Releases buffer after usage from external API
3089 * Unlocks the VA buffer object \ref buf_id from external API usage like
3090 * EGL or OpenCL (OCL). This function is a synchronization point. This
3091 * means that any pending operation is guaranteed to be completed
3092 * prior to returning from the function.
3094 * The \ref VABufferInfo argument shall point to the original data
3095 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3096 * This is necessary so that the VA driver implementation could
3097 * deallocate any resources that were needed.
3099 * In any case, returning from this function invalidates any contents
3100 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3101 * valid. Therefore, VA driver implementations are free to reset this
3102 * data structure to safe defaults.
3105 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3106 * does not support this interface
3107 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3108 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3109 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3110 * does not support exporting buffers of the specified type
3112 * @param[in] dpy the VA display
3113 * @param[in] buf_id the VA buffer
3114 * @return VA_STATUS_SUCCESS if successful
3117 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3120 * Render (Video Decode/Encode/Processing) Pictures
3122 * A picture represents either a frame or a field.
3124 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3129 * Get ready for a video pipeline
3130 * - decode a picture to a target surface
3131 * - encode a picture from a target surface
3132 * - process a picture to a target surface
3134 VAStatus vaBeginPicture (
3136 VAContextID context,
3137 VASurfaceID render_target
3141 * Send video decode, encode or processing buffers to the server.
3143 VAStatus vaRenderPicture (
3145 VAContextID context,
3146 VABufferID *buffers,
3151 * Make the end of rendering for a picture.
3152 * The server should start processing all pending operations for this
3153 * surface. This call is non-blocking. The client can start another
3154 * Begin/Render/End sequence on a different render target.
3155 * if VAContextID used in this function previously successfully passed
3156 * vaMFAddContext call, real processing will be started during vaMFSubmit
3158 VAStatus vaEndPicture (
3164 * Make the end of rendering for a pictures in contexts passed with submission.
3165 * The server should start processing all pending operations for contexts.
3166 * All contexts passed should be associated through vaMFAddContext
3167 * and call sequence Begin/Render/End performed.
3168 * This call is non-blocking. The client can start another
3169 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3171 * VA_STATUS_SUCCESS - operation successful, context was removed.
3172 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3173 * due to mf_context not created or one of contexts not assotiated with mf_context
3174 * through vaAddContext.
3175 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3176 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3178 * mf_context: Multi-Frame context
3179 * contexts: list of contexts submitting their tasks for multi-frame operation.
3180 * num_contexts: number of passed contexts.
3182 VAStatus vaMFSubmit (
3184 VAMFContextID mf_context,
3185 VAContextID * contexts,
3196 * This function blocks until all pending operations on the render target
3197 * have been completed. Upon return it is safe to use the render target for a
3198 * different picture.
3200 VAStatus vaSyncSurface (
3202 VASurfaceID render_target
3207 VASurfaceRendering = 1, /* Rendering in progress */
3208 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3209 /* this status is useful if surface is used as the source */
3211 VASurfaceReady = 4, /* not being rendered or displayed */
3212 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3216 * Find out any pending ops on the render target
3218 VAStatus vaQuerySurfaceStatus (
3220 VASurfaceID render_target,
3221 VASurfaceStatus *status /* out */
3226 VADecodeSliceMissing = 0,
3227 VADecodeMBError = 1,
3228 } VADecodeErrorType;
3231 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3232 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3234 typedef struct _VASurfaceDecodeMBErrors
3236 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3237 uint32_t start_mb; /* start mb address with errors */
3238 uint32_t end_mb; /* end mb address with errors */
3239 VADecodeErrorType decode_error_type;
3241 /** \brief Reserved bytes for future use, must be zero */
3242 uint32_t va_reserved[VA_PADDING_LOW];
3243 } VASurfaceDecodeMBErrors;
3246 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3247 * it can call vaQuerySurfaceError to find out further details on the particular error.
3248 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3249 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3250 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3251 * The array is terminated if "status==-1" is detected.
3253 VAStatus vaQuerySurfaceError(
3255 VASurfaceID surface,
3256 VAStatus error_status,
3261 * Images and Subpictures
3262 * VAImage is used to either get the surface data to client memory, or
3263 * to copy image data in client memory to a surface.
3264 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3265 * is at the upper left corner with positive X to the right and positive Y down
3267 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3268 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3269 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3272 * Pre-defined fourcc codes
3274 #define VA_FOURCC_NV12 0x3231564E
3275 #define VA_FOURCC_NV21 0x3132564E
3276 #define VA_FOURCC_AI44 0x34344149
3277 #define VA_FOURCC_RGBA 0x41424752
3278 #define VA_FOURCC_RGBX 0x58424752
3279 #define VA_FOURCC_BGRA 0x41524742
3280 #define VA_FOURCC_BGRX 0x58524742
3281 #define VA_FOURCC_ARGB 0x42475241
3282 #define VA_FOURCC_XRGB 0x42475258
3283 #define VA_FOURCC_ABGR 0x52474241
3284 #define VA_FOURCC_XBGR 0x52474258
3285 #define VA_FOURCC_UYVY 0x59565955
3286 #define VA_FOURCC_YUY2 0x32595559
3287 #define VA_FOURCC_AYUV 0x56555941
3288 #define VA_FOURCC_NV11 0x3131564e
3289 #define VA_FOURCC_YV12 0x32315659
3290 #define VA_FOURCC_P208 0x38303250
3291 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3292 #define VA_FOURCC_IYUV 0x56555949
3293 #define VA_FOURCC_I420 0x30323449
3294 #define VA_FOURCC_YV24 0x34325659
3295 #define VA_FOURCC_YV32 0x32335659
3296 #define VA_FOURCC_Y800 0x30303859
3297 #define VA_FOURCC_IMC3 0x33434D49
3298 #define VA_FOURCC_411P 0x50313134
3299 #define VA_FOURCC_422H 0x48323234
3300 #define VA_FOURCC_422V 0x56323234
3301 #define VA_FOURCC_444P 0x50343434
3302 #define VA_FOURCC_RGBP 0x50424752
3303 #define VA_FOURCC_BGRP 0x50524742
3304 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
3307 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3309 #define VA_FOURCC_YV16 0x36315659
3311 * 10-bit and 16-bit Planar YUV 4:2:0.
3313 #define VA_FOURCC_P010 0x30313050
3314 #define VA_FOURCC_P016 0x36313050
3317 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3319 #define VA_FOURCC_I010 0x30313049
3322 #define VA_LSB_FIRST 1
3323 #define VA_MSB_FIRST 2
3325 typedef struct _VAImageFormat
3328 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3329 uint32_t bits_per_pixel;
3330 /* for RGB formats */
3331 uint32_t depth; /* significant bits per pixel */
3333 uint32_t green_mask;
3335 uint32_t alpha_mask;
3337 /** \brief Reserved bytes for future use, must be zero */
3338 uint32_t va_reserved[VA_PADDING_LOW];
3341 typedef VAGenericID VAImageID;
3343 typedef struct _VAImage
3345 VAImageID image_id; /* uniquely identify this image */
3346 VAImageFormat format;
3347 VABufferID buf; /* image data buffer */
3349 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3350 * data store on the server side for optimal performance. The buffer will be
3351 * created by the CreateImage function, and proper storage allocated based on the image
3352 * size and format. This buffer is managed by the library implementation, and
3353 * accessed by the client through the buffer Map/Unmap functions.
3358 uint32_t num_planes; /* can not be greater than 3 */
3360 * An array indicating the scanline pitch in bytes for each plane.
3361 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3363 uint32_t pitches[3];
3365 * An array indicating the byte offset from the beginning of the image data
3366 * to the start of each plane.
3368 uint32_t offsets[3];
3370 /* The following fields are only needed for paletted formats */
3371 int32_t num_palette_entries; /* set to zero for non-palette images */
3373 * Each component is one byte and entry_bytes indicates the number of components in
3374 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3376 int32_t entry_bytes;
3378 * An array of ascii characters describing the order of the components within the bytes.
3379 * Only entry_bytes characters of the string are used.
3381 int8_t component_order[4];
3383 /** \brief Reserved bytes for future use, must be zero */
3384 uint32_t va_reserved[VA_PADDING_LOW];
3387 /** Get maximum number of image formats supported by the implementation */
3388 int vaMaxNumImageFormats (
3393 * Query supported image formats
3394 * The caller must provide a "format_list" array that can hold at
3395 * least vaMaxNumImageFormats() entries. The actual number of formats
3396 * returned in "format_list" is returned in "num_formats".
3398 VAStatus vaQueryImageFormats (
3400 VAImageFormat *format_list, /* out */
3401 int *num_formats /* out */
3405 * Create a VAImage structure
3406 * The width and height fields returned in the VAImage structure may get
3407 * enlarged for some YUV formats. Upon return from this function,
3408 * image->buf has been created and proper storage allocated by the library.
3409 * The client can access the image through the Map/Unmap calls.
3411 VAStatus vaCreateImage (
3413 VAImageFormat *format,
3416 VAImage *image /* out */
3420 * Should call DestroyImage before destroying the surface it is bound to
3422 VAStatus vaDestroyImage (
3427 VAStatus vaSetImagePalette (
3431 * pointer to an array holding the palette data. The size of the array is
3432 * num_palette_entries * entry_bytes in size. The order of the components
3433 * in the palette is described by the component_order in VAImage struct
3435 unsigned char *palette
3439 * Retrive surface data into a VAImage
3440 * Image must be in a format supported by the implementation
3442 VAStatus vaGetImage (
3444 VASurfaceID surface,
3445 int x, /* coordinates of the upper left source pixel */
3447 unsigned int width, /* width and height of the region */
3448 unsigned int height,
3453 * Copy data from a VAImage to a surface
3454 * Image must be in a format supported by the implementation
3455 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3456 * shouldn't be rendered into when this is called
3458 VAStatus vaPutImage (
3460 VASurfaceID surface,
3464 unsigned int src_width,
3465 unsigned int src_height,
3468 unsigned int dest_width,
3469 unsigned int dest_height
3473 * Derive an VAImage from an existing surface.
3474 * This interface will derive a VAImage and corresponding image buffer from
3475 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3476 * direct CPU access. This operation is only possible on implementations with
3477 * direct rendering capabilities and internal surface formats that can be
3478 * represented with a VAImage. When the operation is not possible this interface
3479 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3480 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3483 * Implementations should only return success when the resulting image buffer
3484 * would be useable with vaMap/Unmap.
3486 * When directly accessing a surface special care must be taken to insure
3487 * proper synchronization with the graphics hardware. Clients should call
3488 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3489 * rendering or currently being displayed by an overlay.
3491 * Additionally nothing about the contents of a surface should be assumed
3492 * following a vaPutSurface. Implementations are free to modify the surface for
3493 * scaling or subpicture blending within a call to vaPutImage.
3495 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3496 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3497 * vaGetImage with other surfaces is supported.
3499 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3500 * image and image buffer structures will be destroyed; however, the underlying
3501 * surface will remain unchanged until freed with vaDestroySurfaces.
3503 VAStatus vaDeriveImage (
3505 VASurfaceID surface,
3506 VAImage *image /* out */
3511 * Subpicture is a special type of image that can be blended
3512 * with a surface during vaPutSurface(). Subpicture can be used to render
3513 * DVD sub-titles or closed captioning text etc.
3516 typedef VAGenericID VASubpictureID;
3518 /** Get maximum number of subpicture formats supported by the implementation */
3519 int vaMaxNumSubpictureFormats (
3523 /** flags for subpictures */
3524 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3525 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3526 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3528 * Query supported subpicture formats
3529 * The caller must provide a "format_list" array that can hold at
3530 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3531 * for each format to indicate additional capabilities for that format. The actual
3532 * number of formats returned in "format_list" is returned in "num_formats".
3533 * flags: returned value to indicate addtional capabilities
3534 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3535 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3536 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3539 VAStatus vaQuerySubpictureFormats (
3541 VAImageFormat *format_list, /* out */
3542 unsigned int *flags, /* out */
3543 unsigned int *num_formats /* out */
3547 * Subpictures are created with an image associated.
3549 VAStatus vaCreateSubpicture (
3552 VASubpictureID *subpicture /* out */
3556 * Destroy the subpicture before destroying the image it is assocated to
3558 VAStatus vaDestroySubpicture (
3560 VASubpictureID subpicture
3564 * Bind an image to the subpicture. This image will now be associated with
3565 * the subpicture instead of the one at creation.
3567 VAStatus vaSetSubpictureImage (
3569 VASubpictureID subpicture,
3574 * If chromakey is enabled, then the area where the source value falls within
3575 * the chromakey [min, max] range is transparent
3576 * The chromakey component format is the following:
3577 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3578 * For YUV: [0:7] V [8:15] U [16:23] Y
3579 * The chromakey mask can be used to mask out certain components for chromakey
3582 VAStatus vaSetSubpictureChromakey (
3584 VASubpictureID subpicture,
3585 unsigned int chromakey_min,
3586 unsigned int chromakey_max,
3587 unsigned int chromakey_mask
3591 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3592 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3593 * the overall alpha is per-pixel alpha multiplied by the global alpha
3595 VAStatus vaSetSubpictureGlobalAlpha (
3597 VASubpictureID subpicture,
3602 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3603 * It defines the region mapping between the subpicture and the target
3604 * surfaces through source and destination rectangles (with the same width and height).
3605 * Both will be displayed at the next call to vaPutSurface. Additional
3606 * associations before the call to vaPutSurface simply overrides the association.
3608 VAStatus vaAssociateSubpicture (
3610 VASubpictureID subpicture,
3611 VASurfaceID *target_surfaces,
3613 int16_t src_x, /* upper left offset in subpicture */
3616 uint16_t src_height,
3617 int16_t dest_x, /* upper left offset in surface */
3619 uint16_t dest_width,
3620 uint16_t dest_height,
3622 * whether to enable chroma-keying, global-alpha, or screen relative mode
3623 * see VA_SUBPICTURE_XXX values
3629 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3631 VAStatus vaDeassociateSubpicture (
3633 VASubpictureID subpicture,
3634 VASurfaceID *target_surfaces,
3639 * Display attributes
3640 * Display attributes are used to control things such as contrast, hue, saturation,
3641 * brightness etc. in the rendering process. The application can query what
3642 * attributes are supported by the driver, and then set the appropriate attributes
3643 * before calling vaPutSurface()
3645 /* PowerVR IEP Lite attributes */
3648 VADISPLAYATTRIB_BLE_OFF = 0x00,
3649 VADISPLAYATTRIB_BLE_LOW,
3650 VADISPLAYATTRIB_BLE_MEDIUM,
3651 VADISPLAYATTRIB_BLE_HIGH,
3652 VADISPLAYATTRIB_BLE_NONE,
3653 } VADisplayAttribBLEMode;
3655 /** attribute value for VADisplayAttribRotation */
3656 #define VA_ROTATION_NONE 0x00000000
3657 #define VA_ROTATION_90 0x00000001
3658 #define VA_ROTATION_180 0x00000002
3659 #define VA_ROTATION_270 0x00000003
3663 * @name Mirroring directions
3665 * Those values could be used for VADisplayAttribMirror attribute or
3666 * VAProcPipelineParameterBuffer::mirror_state.
3670 /** \brief No Mirroring. */
3671 #define VA_MIRROR_NONE 0x00000000
3672 /** \brief Horizontal Mirroring. */
3673 #define VA_MIRROR_HORIZONTAL 0x00000001
3674 /** \brief Vertical Mirroring. */
3675 #define VA_MIRROR_VERTICAL 0x00000002
3678 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3679 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3680 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3683 #define VA_RENDER_MODE_UNDEFINED 0
3684 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3685 #define VA_RENDER_MODE_LOCAL_GPU 2
3686 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3687 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3689 /** Render device */
3690 #define VA_RENDER_DEVICE_UNDEFINED 0
3691 #define VA_RENDER_DEVICE_LOCAL 1
3692 #define VA_RENDER_DEVICE_EXTERNAL 2
3694 /** Currently defined display attribute types */
3697 VADisplayAttribBrightness = 0,
3698 VADisplayAttribContrast = 1,
3699 VADisplayAttribHue = 2,
3700 VADisplayAttribSaturation = 3,
3701 /* client can specifiy a background color for the target window
3702 * the new feature of video conference,
3703 * the uncovered area of the surface is filled by this color
3704 * also it will blend with the decoded video color
3706 VADisplayAttribBackgroundColor = 4,
3708 * this is a gettable only attribute. For some implementations that use the
3709 * hardware overlay, after PutSurface is called, the surface can not be
3710 * re-used until after the subsequent PutSurface call. If this is the case
3711 * then the value for this attribute will be set to 1 so that the client
3712 * will not attempt to re-use the surface right after returning from a call
3715 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3716 * driver may use overlay or GPU alternatively
3718 VADisplayAttribDirectSurface = 5,
3719 VADisplayAttribRotation = 6,
3720 VADisplayAttribOutofLoopDeblock = 7,
3722 /* PowerVR IEP Lite specific attributes */
3723 VADisplayAttribBLEBlackMode = 8,
3724 VADisplayAttribBLEWhiteMode = 9,
3725 VADisplayAttribBlueStretch = 10,
3726 VADisplayAttribSkinColorCorrection = 11,
3728 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3729 * conversion matrix. Each element in the matrix is float-point
3731 VADisplayAttribCSCMatrix = 12,
3732 /* specify the constant color used to blend with video surface
3733 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3734 * d: the final color to overwrite into the frame buffer
3735 * v: decoded video after color conversion,
3736 * c: video color specified by VADisplayAttribBlendColor
3737 * b: background color of the drawable
3739 VADisplayAttribBlendColor = 13,
3741 * Indicate driver to skip painting color key or not.
3742 * only applicable if the render is overlay
3744 VADisplayAttribOverlayAutoPaintColorKey = 14,
3746 * customized overlay color key, the format is RGB888
3747 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3749 VADisplayAttribOverlayColorKey = 15,
3751 * The hint for the implementation of vaPutSurface
3752 * normally, the driver could use an overlay or GPU to render the surface on the screen
3753 * this flag provides APP the flexibity to switch the render dynamically
3755 VADisplayAttribRenderMode = 16,
3757 * specify if vaPutSurface needs to render into specified monitors
3758 * one example is that one external monitor (e.g. HDMI) is enabled,
3759 * but the window manager is not aware of it, and there is no associated drawable
3761 VADisplayAttribRenderDevice = 17,
3763 * specify vaPutSurface render area if there is no drawable on the monitor
3765 VADisplayAttribRenderRect = 18,
3766 } VADisplayAttribType;
3768 /* flags for VADisplayAttribute */
3769 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3770 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3771 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3773 typedef struct _VADisplayAttribute
3775 VADisplayAttribType type;
3778 int32_t value; /* used by the set/get attribute functions */
3779 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3782 /** \brief Reserved bytes for future use, must be zero */
3783 uint32_t va_reserved[VA_PADDING_LOW];
3784 } VADisplayAttribute;
3786 /** Get maximum number of display attributs supported by the implementation */
3787 int vaMaxNumDisplayAttributes (
3792 * Query display attributes
3793 * The caller must provide a "attr_list" array that can hold at
3794 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3795 * returned in "attr_list" is returned in "num_attributes".
3797 VAStatus vaQueryDisplayAttributes (
3799 VADisplayAttribute *attr_list, /* out */
3800 int *num_attributes /* out */
3804 * Get display attributes
3805 * This function returns the current attribute values in "attr_list".
3806 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3807 * from vaQueryDisplayAttributes() can have their values retrieved.
3809 VAStatus vaGetDisplayAttributes (
3811 VADisplayAttribute *attr_list, /* in/out */
3816 * Set display attributes
3817 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3818 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3819 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3821 VAStatus vaSetDisplayAttributes (
3823 VADisplayAttribute *attr_list,
3827 /****************************
3828 * HEVC data structures
3829 ****************************/
3831 * \brief Description of picture properties of those in DPB surfaces.
3833 * If only progressive scan is supported, each surface contains one whole
3835 * Otherwise, each surface contains two fields of whole picture.
3836 * In this case, two entries of ReferenceFrames[] may share same picture_id
3839 typedef struct _VAPictureHEVC
3841 /** \brief reconstructed picture buffer surface index
3842 * invalid when taking value VA_INVALID_SURFACE.
3844 VASurfaceID picture_id;
3845 /** \brief picture order count.
3846 * in HEVC, POCs for top and bottom fields of same picture should
3847 * take different values.
3849 int32_t pic_order_cnt;
3850 /* described below */
3853 /** \brief Reserved bytes for future use, must be zero */
3854 uint32_t va_reserved[VA_PADDING_LOW];
3857 /* flags in VAPictureHEVC could be OR of the following */
3858 #define VA_PICTURE_HEVC_INVALID 0x00000001
3859 /** \brief indication of interlace scan picture.
3860 * should take same value for all the pictures in sequence.
3862 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3863 /** \brief polarity of the field picture.
3864 * top field takes even lines of buffer surface.
3865 * bottom field takes odd lines of buffer surface.
3867 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3868 /** \brief Long term reference picture */
3869 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3871 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3872 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3873 * be exclusive. No more than one of them can be set for any picture.
3874 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3875 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3876 * Application should provide valid values for both short format and long format.
3877 * The pictures in DPB with any of these three flags turned on are referred by
3878 * the current picture.
3880 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3881 * Number of ReferenceFrames[] entries with this bit set equals
3882 * NumPocStCurrBefore.
3884 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3885 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3886 * Number of ReferenceFrames[] entries with this bit set equals
3887 * NumPocStCurrAfter.
3889 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3890 /** \brief RefPicSetLtCurr of HEVC spec variable
3891 * Number of ReferenceFrames[] entries with this bit set equals
3894 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3896 #include <va/va_dec_hevc.h>
3897 #include <va/va_dec_jpeg.h>
3898 #include <va/va_dec_vp8.h>
3899 #include <va/va_dec_vp9.h>
3900 #include <va/va_enc_hevc.h>
3901 #include <va/va_enc_h264.h>
3902 #include <va/va_enc_jpeg.h>
3903 #include <va/va_enc_mpeg2.h>
3904 #include <va/va_enc_vp8.h>
3905 #include <va/va_enc_vp9.h>
3906 #include <va/va_fei.h>
3907 #include <va/va_fei_h264.h>
3908 #include <va/va_vpp.h>