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,
405 * \brief VAEntrypointStats
407 * A pre-processing function for getting some statistics and motion vectors is added,
408 * and some extra controls for Encode pipeline are provided. The application can
409 * optionally call the statistics function to get motion vectors and statistics like
410 * variances, distortions before calling Encode function via this entry point.
412 * Checking whether Statistics is supported can be performed with vaQueryConfigEntrypoints().
413 * If Statistics entry point is supported, then the list of returned entry-points will
414 * include #VAEntrypointStats. Supported pixel format, maximum resolution and statistics
415 * specific attributes can be obtained via normal attribute query. One input buffer
416 * (VAStatsStatisticsParameterBufferType) and one or two output buffers
417 * (VAStatsStatisticsBufferType, VAStatsStatisticsBottomFieldBufferType (for interlace only)
418 * and VAStatsMVBufferType) are needed for this entry point.
420 VAEntrypointStats = 12,
423 /** Currently defined configuration attribute types */
426 VAConfigAttribRTFormat = 0,
427 VAConfigAttribSpatialResidual = 1,
428 VAConfigAttribSpatialClipping = 2,
429 VAConfigAttribIntraResidual = 3,
430 VAConfigAttribEncryption = 4,
431 VAConfigAttribRateControl = 5,
433 /** @name Attributes for decoding */
436 * \brief Slice Decoding mode. Read/write.
438 * This attribute determines what mode the driver supports for slice
439 * decoding, through vaGetConfigAttributes(); and what mode the user
440 * will be providing to the driver, through vaCreateConfig(), if the
441 * driver supports those. If this attribute is not set by the user then
442 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
444 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
446 VAConfigAttribDecSliceMode = 6,
448 * \brief JPEG decoding attribute. Read-only.
450 * This attribute exposes a number of capabilities of the underlying
451 * JPEG implementation. The attribute value is partitioned into fields as defined in the
452 * VAConfigAttribValDecJPEG union.
454 VAConfigAttribDecJPEG = 7,
456 * \brief Decode processing support. Read/write.
458 * This attribute determines if the driver supports video processing
459 * with decoding using the decoding context in a single call, through
460 * vaGetConfigAttributes(); and if the user may use this feature,
461 * through vaCreateConfig(), if the driver supports the user scenario.
462 * The user will essentially create a regular decode VAContext. Therefore,
463 * the parameters of vaCreateContext() such as picture_width, picture_height
464 * and render_targets are in relation to the decode output parameters
465 * (not processing output parameters) as normal.
466 * If this attribute is not set by the user then it is assumed that no
467 * extra processing is done after decoding for this decode context.
469 * Since essentially the application is creating a decoder config and context,
470 * all function calls that take in the config (e.g. vaQuerySurfaceAttributes())
471 * or context are in relation to the decoder, except those video processing
472 * function specified in the next paragraph.
474 * Once the decode config and context are created, the user must further
475 * query the supported processing filters using vaQueryVideoProcFilters(),
476 * vaQueryVideoProcFilterCaps(), vaQueryVideoProcPipelineCaps() by specifying
477 * the created decode context. The user must provide processing information
478 * and extra processing output surfaces as "additional_outputs" to the driver
479 * through VAProcPipelineParameterBufferType. The render_target specified
480 * at vaBeginPicture() time refers to the decode output surface. The
481 * target surface for the output of processing needs to be a different
482 * surface since the decode process requires the original reconstructed buffer.
483 * The “surface” member of VAProcPipelineParameterBuffer should be set to the
484 * same as “render_target” set in vaBeginPicture(), but the driver may choose
485 * to ignore this parameter.
487 VAConfigAttribDecProcessing = 8,
488 /** @name Attributes for encoding */
491 * \brief Packed headers mode. Read/write.
493 * This attribute determines what packed headers the driver supports,
494 * through vaGetConfigAttributes(); and what packed headers the user
495 * will be providing to the driver, through vaCreateConfig(), if the
496 * driver supports those.
498 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
500 VAConfigAttribEncPackedHeaders = 10,
502 * \brief Interlaced mode. Read/write.
504 * This attribute determines what kind of interlaced encoding mode
505 * the driver supports.
507 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
509 VAConfigAttribEncInterlaced = 11,
511 * \brief Maximum number of reference frames. Read-only.
513 * This attribute determines the maximum number of reference
514 * frames supported for encoding.
516 * Note: for H.264 encoding, the value represents the maximum number
517 * of reference frames for both the reference picture list 0 (bottom
518 * 16 bits) and the reference picture list 1 (top 16 bits).
520 VAConfigAttribEncMaxRefFrames = 13,
522 * \brief Maximum number of slices per frame. Read-only.
524 * This attribute determines the maximum number of slices the
525 * driver can support to encode a single frame.
527 VAConfigAttribEncMaxSlices = 14,
529 * \brief Slice structure. Read-only.
531 * This attribute determines slice structures supported by the
532 * driver for encoding. This attribute is a hint to the user so
533 * that he can choose a suitable surface size and how to arrange
534 * the encoding process of multiple slices per frame.
536 * More specifically, for H.264 encoding, this attribute
537 * determines the range of accepted values to
538 * VAEncSliceParameterBufferH264::macroblock_address and
539 * VAEncSliceParameterBufferH264::num_macroblocks.
541 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
544 VAConfigAttribEncSliceStructure = 15,
546 * \brief Macroblock information. Read-only.
548 * This attribute determines whether the driver supports extra
549 * encoding information per-macroblock. e.g. QP.
551 * More specifically, for H.264 encoding, if the driver returns a non-zero
552 * value for this attribute, this means the application can create
553 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
554 * through VAEncSliceParameterBufferH264::macroblock_info.
556 VAConfigAttribEncMacroblockInfo = 16,
558 * \brief Maximum picture width. Read-only.
560 * This attribute determines the maximum picture width the driver supports
561 * for a given configuration.
563 VAConfigAttribMaxPictureWidth = 18,
565 * \brief Maximum picture height. Read-only.
567 * This attribute determines the maximum picture height the driver supports
568 * for a given configuration.
570 VAConfigAttribMaxPictureHeight = 19,
572 * \brief JPEG encoding attribute. Read-only.
574 * This attribute exposes a number of capabilities of the underlying
575 * JPEG implementation. The attribute value is partitioned into fields as defined in the
576 * VAConfigAttribValEncJPEG union.
578 VAConfigAttribEncJPEG = 20,
580 * \brief Encoding quality range attribute. Read-only.
582 * This attribute conveys whether the driver supports different quality level settings
583 * for encoding. A value less than or equal to 1 means that the encoder only has a single
584 * quality setting, and a value greater than 1 represents the number of quality levels
585 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
587 VAConfigAttribEncQualityRange = 21,
589 * \brief Encoding quantization attribute. Read-only.
591 * This attribute conveys whether the driver supports certain types of quantization methods
592 * for encoding (e.g. trellis). See \c VA_ENC_QUANTIZATION_xxx for the list of quantization methods
594 VAConfigAttribEncQuantization = 22,
596 * \brief Encoding intra refresh attribute. Read-only.
598 * This attribute conveys whether the driver supports certain types of intra refresh methods
599 * for encoding (e.g. adaptive intra refresh or rolling intra refresh).
600 * See \c VA_ENC_INTRA_REFRESH_xxx for intra refresh methods
602 VAConfigAttribEncIntraRefresh = 23,
604 * \brief Encoding skip frame attribute. Read-only.
606 * This attribute conveys whether the driver supports sending skip frame parameters
607 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
608 * externally skipped frames.
610 VAConfigAttribEncSkipFrame = 24,
612 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
614 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
615 * based on user provided ROI rectangles. The attribute value is partitioned into fields
616 * as defined in the VAConfigAttribValEncROI union.
618 * If ROI encoding is supported, the ROI information is passed to the driver using
619 * VAEncMiscParameterTypeROI.
621 VAConfigAttribEncROI = 25,
623 * \brief Encoding extended rate control attribute. Read-only.
625 * This attribute conveys whether the driver supports any extended rate control features
626 * The attribute value is partitioned into fields as defined in the
627 * VAConfigAttribValEncRateControlExt union.
629 VAConfigAttribEncRateControlExt = 26,
631 * \brief Processing rate reporting attribute. Read-only.
633 * This attribute conveys whether the driver supports reporting of
634 * encode/decode processing rate based on certain set of parameters
635 * (i.e. levels, I frame internvals) for a given configuration.
636 * If this is supported, vaQueryProcessingRate() can be used to get
637 * encode or decode processing rate.
638 * See \c VA_PROCESSING_RATE_xxx for encode/decode processing rate
640 VAConfigAttribProcessingRate = 27,
642 * \brief Encoding dirty rectangle. Read-only.
644 * This attribute conveys whether the driver supports dirty rectangle.
645 * encoding, based on user provided ROI rectangles which indicate the rectangular areas
646 * where the content has changed as compared to the previous picture. The regions of the
647 * picture that are not covered by dirty rect rectangles are assumed to have not changed
648 * compared to the previous picture. The encoder may do some optimizations based on
649 * this information. The attribute value returned indicates the number of regions that
650 * are supported. e.g. A value of 0 means dirty rect encoding is not supported. If dirty
651 * rect encoding is supported, the ROI information is passed to the driver using
652 * VAEncMiscParameterTypeDirtyRect.
654 VAConfigAttribEncDirtyRect = 28,
656 * \brief Parallel Rate Control (hierachical B) attribute. Read-only.
658 * This attribute conveys whether the encoder supports parallel rate control.
659 * It is a integer value 0 - unsupported, > 0 - maximum layer supported.
660 * This is the way when hireachical B frames are encoded, multiple independent B frames
661 * on the same layer may be processed at same time. If supported, app may enable it by
662 * setting enable_parallel_brc in VAEncMiscParameterRateControl,and the number of B frames
663 * per layer per GOP will be passed to driver through VAEncMiscParameterParallelRateControl
664 * structure.Currently three layers are defined.
666 VAConfigAttribEncParallelRateControl = 29,
668 * \brief Dynamic Scaling Attribute. Read-only.
670 * This attribute conveys whether encoder is capable to determine dynamic frame
671 * resolutions adaptive to bandwidth utilization and processing power, etc.
672 * It is a boolean value 0 - unsupported, 1 - supported.
673 * If it is supported,for VP9, suggested frame resolution can be retrieved from VACodedBufferVP9Status.
675 VAConfigAttribEncDynamicScaling = 30,
677 * \brief frame size tolerance support
678 * it indicates the tolerance of frame size
680 VAConfigAttribFrameSizeToleranceSupport = 31,
682 * \brief Encode function type for FEI.
684 * This attribute conveys whether the driver supports different function types for encode.
685 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
686 * it is for FEI entry point only.
687 * Default is VA_FEI_FUNCTION_ENC_PAK.
689 VAConfigAttribFEIFunctionType = 32,
691 * \brief Maximum number of FEI MV predictors. Read-only.
693 * This attribute determines the maximum number of MV predictors the driver
694 * can support to encode a single frame. 0 means no MV predictor is supported.
695 * Currently it is for FEI entry point only.
697 VAConfigAttribFEIMVPredictors = 33,
699 * \brief Statistics attribute. Read-only.
701 * This attribute exposes a number of capabilities of the VAEntrypointStats entry
702 * point. The attribute value is partitioned into fields as defined in the
703 * VAConfigAttribValStats union. Currently it is for VAEntrypointStats only.
705 VAConfigAttribStats = 34,
707 * \brief Tile Support Attribute. Read-only.
709 * This attribute conveys whether encoder is capable to support tiles.
710 * If not supported, the tile related parameters sent to encoder, such as
711 * tiling structure, should be ignored. 0 - unsupported, 1 - supported.
713 VAConfigAttribEncTileSupport = 35,
715 * \brief whether accept rouding setting from application. Read-only.
716 * This attribute is for encode quality, if it is report,
717 * application can change the rounding setting by VAEncMiscParameterTypeCustomRoundingControl
719 VAConfigAttribCustomRoundingControl = 36,
721 * \brief Encoding QP info block size attribute. Read-only.
722 * This attribute conveys the block sizes that underlying driver
723 * support for QP info for buffer #VAEncQpBuffer.
725 VAConfigAttribQPBlockSize = 37,
727 VAConfigAttribTypeMax
728 } VAConfigAttribType;
731 * Configuration attributes
732 * If there is more than one value for an attribute, a default
733 * value will be assigned to the attribute if the client does not
734 * specify the attribute when creating a configuration
736 typedef struct _VAConfigAttrib {
737 VAConfigAttribType type;
738 uint32_t value; /* OR'd flags (bits) for this attribute */
741 /** attribute value for VAConfigAttribRTFormat */
742 #define VA_RT_FORMAT_YUV420 0x00000001
743 #define VA_RT_FORMAT_YUV422 0x00000002
744 #define VA_RT_FORMAT_YUV444 0x00000004
745 #define VA_RT_FORMAT_YUV411 0x00000008
746 #define VA_RT_FORMAT_YUV400 0x00000010
747 /** YUV formats with more than 8 bpp */
748 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
750 #define VA_RT_FORMAT_RGB16 0x00010000
751 #define VA_RT_FORMAT_RGB32 0x00020000
752 /* RGBP covers RGBP and BGRP fourcc */
753 #define VA_RT_FORMAT_RGBP 0x00100000
755 * RGB 10-bit packed format with upper 2 bits as alpha channel.
756 * The existing pre-defined fourcc codes can be used to signal
757 * the position of each component for this RT format.
759 #define VA_RT_FORMAT_RGB32_10BPP 0x00200000
760 #define VA_RT_FORMAT_PROTECTED 0x80000000
762 /** @name Attribute values for VAConfigAttribRateControl */
764 /** \brief Driver does not support any form of rate control. */
765 #define VA_RC_NONE 0x00000001
766 /** \brief Constant bitrate. */
767 #define VA_RC_CBR 0x00000002
768 /** \brief Variable bitrate. */
769 #define VA_RC_VBR 0x00000004
770 /** \brief Video conference mode. */
771 #define VA_RC_VCM 0x00000008
772 /** \brief Constant QP. */
773 #define VA_RC_CQP 0x00000010
774 /** \brief Variable bitrate with peak rate higher than average bitrate. */
775 #define VA_RC_VBR_CONSTRAINED 0x00000020
776 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
777 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
778 #define VA_RC_ICQ 0x00000040
779 /** \brief Macroblock based rate control. Per MB control is decided
780 * internally in the encoder. It may be combined with other RC modes, except CQP. */
781 #define VA_RC_MB 0x00000080
782 /** \brief Constant Frame Size, it is used for small tolerent */
783 #define VA_RC_CFS 0x00000100
784 /** \brief Parallel BRC, for hierachical B.
786 * For hierachical B, B frames can be refered by other B frames.
787 * Currently three layers of hierachy are defined:
788 * B0 - regular B, no reference to other B frames.
789 * B1 - reference to only I, P and regular B0 frames.
790 * B2 - reference to any other frames, including B1.
791 * In Hierachical B structure, B frames on the same layer can be processed
792 * simultaneously. And BRC would adjust accordingly. This is so called
794 #define VA_RC_PARALLEL 0x00000200
798 /** @name Attribute values for VAConfigAttribDecSliceMode */
800 /** \brief Driver supports normal mode for slice decoding */
801 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
802 /** \brief Driver supports base mode for slice decoding */
803 #define VA_DEC_SLICE_MODE_BASE 0x00000002
805 /** @name Attribute values for VAConfigAttribDecJPEG */
807 typedef union _VAConfigAttribValDecJPEG {
809 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
810 uint32_t rotation : 4;
811 /** \brief Reserved for future use. */
812 uint32_t reserved : 28;
815 uint32_t va_reserved[VA_PADDING_LOW];
816 } VAConfigAttribValDecJPEG;
817 /** @name Attribute values for VAConfigAttribDecProcessing */
819 /** \brief No decoding + processing in a single decoding call. */
820 #define VA_DEC_PROCESSING_NONE 0x00000000
821 /** \brief Decode + processing in a single decoding call. */
822 #define VA_DEC_PROCESSING 0x00000001
825 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
827 /** \brief Driver does not support any packed headers mode. */
828 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
830 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
832 * Application must provide it to driver once this flag is returned through
833 * vaGetConfigAttributes()
835 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
837 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
839 * Application must provide it to driver once this falg is returned through
840 * vaGetConfigAttributes()
842 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
844 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
846 * Application must provide it to driver once this flag is returned through
847 * vaGetConfigAttributes()
849 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
851 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
854 * This is a deprecated packed header flag, All applications can use
855 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
856 * header data buffer to the driver
858 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
859 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
860 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
863 /** @name Attribute values for VAConfigAttribEncInterlaced */
865 /** \brief Driver does not support interlaced coding. */
866 #define VA_ENC_INTERLACED_NONE 0x00000000
867 /** \brief Driver supports interlaced frame coding. */
868 #define VA_ENC_INTERLACED_FRAME 0x00000001
869 /** \brief Driver supports interlaced field coding. */
870 #define VA_ENC_INTERLACED_FIELD 0x00000002
871 /** \brief Driver supports macroblock adaptive frame field coding. */
872 #define VA_ENC_INTERLACED_MBAFF 0x00000004
873 /** \brief Driver supports picture adaptive frame field coding. */
874 #define VA_ENC_INTERLACED_PAFF 0x00000008
877 /** @name Attribute values for VAConfigAttribEncSliceStructure */
879 /** \brief Driver supports a power-of-two number of rows per slice. */
880 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
881 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
882 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
883 /** \brief Dirver support 1 rows per slice */
884 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
885 /** \brief Dirver support max encoded slice size per slice */
886 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
887 /** \brief Driver supports an arbitrary number of rows per slice. */
888 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
891 /** \brief Attribute value for VAConfigAttribEncJPEG */
892 typedef union _VAConfigAttribValEncJPEG {
894 /** \brief set to 1 for arithmatic coding. */
895 uint32_t arithmatic_coding_mode : 1;
896 /** \brief set to 1 for progressive dct. */
897 uint32_t progressive_dct_mode : 1;
898 /** \brief set to 1 for non-interleaved. */
899 uint32_t non_interleaved_mode : 1;
900 /** \brief set to 1 for differential. */
901 uint32_t differential_mode : 1;
902 uint32_t max_num_components : 3;
903 uint32_t max_num_scans : 4;
904 uint32_t max_num_huffman_tables : 3;
905 uint32_t max_num_quantization_tables : 3;
908 } VAConfigAttribValEncJPEG;
910 /** @name Attribute values for VAConfigAttribEncQuantization */
912 /** \brief Driver does not support special types of quantization */
913 #define VA_ENC_QUANTIZATION_NONE 0x00000000
914 /** \brief Driver supports trellis quantization */
915 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
918 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
920 /** \brief Driver does not support intra refresh */
921 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
922 /** \brief Driver supports column based rolling intra refresh */
923 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
924 /** \brief Driver supports row based rolling intra refresh */
925 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
926 /** \brief Driver supports adaptive intra refresh */
927 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
928 /** \brief Driver supports cyclic intra refresh */
929 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
930 /** \brief Driver supports intra refresh of P frame*/
931 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
932 /** \brief Driver supports intra refresh of B frame */
933 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
934 /** \brief Driver supports intra refresh of multiple reference encoder */
935 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
939 /** \brief Attribute value for VAConfigAttribEncROI */
940 typedef union _VAConfigAttribValEncROI {
942 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
943 uint32_t num_roi_regions : 8;
945 * \brief A flag indicates whether ROI priority is supported
947 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
948 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
949 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
950 * the underlying driver doesn't support ROI priority.
952 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
953 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
955 uint32_t roi_rc_priority_support : 1;
957 * \brief A flag indicates whether ROI delta QP is supported
959 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
960 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
961 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
962 * the underlying driver doesn't support ROI delta QP.
964 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
965 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
967 uint32_t roi_rc_qp_delta_support : 1;
968 uint32_t reserved : 22;
971 } VAConfigAttribValEncROI;
973 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
974 typedef union _VAConfigAttribValEncRateControlExt {
977 * \brief The maximum number of temporal layers minus 1
979 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
980 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
981 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
983 uint32_t max_num_temporal_layers_minus1 : 8;
986 * /brief support temporal layer bit-rate control flag
988 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
989 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
990 * #VAConfigAttribRateControl == #VA_RC_VBR).
992 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
993 * \c max_num_temporal_layers_minus1 is equal to 0
995 * To use bit-rate control per temporal layer, an application must send the right layer
996 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
997 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
998 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
999 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
1000 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
1001 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
1002 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
1004 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
1005 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
1006 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
1008 uint32_t temporal_layer_bitrate_control_flag : 1;
1009 uint32_t reserved : 23;
1012 } VAConfigAttribValEncRateControlExt;
1014 /** @name Attribute values for VAConfigAttribProcessingRate. */
1016 /** \brief Driver does not support processing rate report */
1017 #define VA_PROCESSING_RATE_NONE 0x00000000
1018 /** \brief Driver supports encode processing rate report */
1019 #define VA_PROCESSING_RATE_ENCODE 0x00000001
1020 /** \brief Driver supports decode processing rate report */
1021 #define VA_PROCESSING_RATE_DECODE 0x00000002
1024 * if an attribute is not applicable for a given
1025 * profile/entrypoint pair, then set the value to the following
1027 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
1029 /** Get maximum number of profiles supported by the implementation */
1030 int vaMaxNumProfiles (
1034 /** Get maximum number of entrypoints supported by the implementation */
1035 int vaMaxNumEntrypoints (
1039 /** Get maximum number of attributs supported by the implementation */
1040 int vaMaxNumConfigAttributes (
1045 * Query supported profiles
1046 * The caller must provide a "profile_list" array that can hold at
1047 * least vaMaxNumProfile() entries. The actual number of profiles
1048 * returned in "profile_list" is returned in "num_profile".
1050 VAStatus vaQueryConfigProfiles (
1052 VAProfile *profile_list, /* out */
1053 int *num_profiles /* out */
1057 * Query supported entrypoints for a given profile
1058 * The caller must provide an "entrypoint_list" array that can hold at
1059 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
1060 * returned in "entrypoint_list" is returned in "num_entrypoints".
1062 VAStatus vaQueryConfigEntrypoints (
1065 VAEntrypoint *entrypoint_list, /* out */
1066 int *num_entrypoints /* out */
1070 * Get attributes for a given profile/entrypoint pair
1071 * The caller must provide an "attrib_list" with all attributes to be
1072 * retrieved. Upon return, the attributes in "attrib_list" have been
1073 * updated with their value. Unknown attributes or attributes that are
1074 * not supported for the given profile/entrypoint pair will have their
1075 * value set to VA_ATTRIB_NOT_SUPPORTED
1077 VAStatus vaGetConfigAttributes (
1080 VAEntrypoint entrypoint,
1081 VAConfigAttrib *attrib_list, /* in/out */
1085 /** Generic ID type, can be re-typed for specific implementation */
1086 typedef unsigned int VAGenericID;
1088 typedef VAGenericID VAConfigID;
1091 * Create a configuration for the video decode/encode/processing pipeline
1092 * it passes in the attribute list that specifies the attributes it cares
1093 * about, with the rest taking default values.
1095 VAStatus vaCreateConfig (
1098 VAEntrypoint entrypoint,
1099 VAConfigAttrib *attrib_list,
1101 VAConfigID *config_id /* out */
1105 * Free resources associdated with a given config
1107 VAStatus vaDestroyConfig (
1109 VAConfigID config_id
1113 * Query all attributes for a given configuration
1114 * The profile of the configuration is returned in "profile"
1115 * The entrypoint of the configuration is returned in "entrypoint"
1116 * The caller must provide an "attrib_list" array that can hold at least
1117 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1118 * returned in "attrib_list" is returned in "num_attribs"
1120 VAStatus vaQueryConfigAttributes (
1122 VAConfigID config_id,
1123 VAProfile *profile, /* out */
1124 VAEntrypoint *entrypoint, /* out */
1125 VAConfigAttrib *attrib_list,/* out */
1126 int *num_attribs /* out */
1131 * Contexts and Surfaces
1133 * Context represents a "virtual" video decode, encode or video processing
1134 * pipeline. Surfaces are render targets for a given context. The data in the
1135 * surfaces are not accessible to the client except if derived image is supported
1136 * and the internal data format of the surface is implementation specific.
1138 * Surfaces are provided as a hint of what surfaces will be used when the context
1139 * is created through vaCreateContext(). A surface may be used by different contexts
1140 * at the same time as soon as application can make sure the operations are synchronized
1141 * between different contexts, e.g. a surface is used as the output of a decode context
1142 * and the input of a video process context. Surfaces can only be destroyed after all
1143 * contexts using these surfaces have been destroyed.
1145 * Both contexts and surfaces are identified by unique IDs and its
1146 * implementation specific internals are kept opaque to the clients
1149 typedef VAGenericID VAContextID;
1151 typedef VAGenericID VASurfaceID;
1153 #define VA_INVALID_ID 0xffffffff
1154 #define VA_INVALID_SURFACE VA_INVALID_ID
1156 /** \brief Generic value types. */
1158 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1159 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1160 VAGenericValueTypePointer, /**< Generic pointer type */
1161 VAGenericValueTypeFunc /**< Pointer to function */
1162 } VAGenericValueType;
1164 /** \brief Generic function type. */
1165 typedef void (*VAGenericFunc)(void);
1167 /** \brief Generic value. */
1168 typedef struct _VAGenericValue {
1169 /** \brief Value type. See #VAGenericValueType. */
1170 VAGenericValueType type;
1171 /** \brief Value holder. */
1173 /** \brief 32-bit signed integer. */
1175 /** \brief 32-bit float. */
1177 /** \brief Generic pointer. */
1179 /** \brief Pointer to function. */
1184 /** @name Surface attribute flags */
1186 /** \brief Surface attribute is not supported. */
1187 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1188 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1189 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1190 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1191 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1194 /** \brief Surface attribute types. */
1196 VASurfaceAttribNone = 0,
1198 * \brief Pixel format (fourcc).
1200 * The value is meaningful as input to vaQuerySurfaceAttributes().
1201 * If zero, the driver returns the optimal pixel format for the
1202 * specified config. Otherwise, if non-zero, the value represents
1203 * a pixel format (FOURCC) that is kept as is on output, if the
1204 * driver supports it. Otherwise, the driver sets the value to
1205 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1207 VASurfaceAttribPixelFormat,
1208 /** \brief Minimal width in pixels (int, read-only). */
1209 VASurfaceAttribMinWidth,
1210 /** \brief Maximal width in pixels (int, read-only). */
1211 VASurfaceAttribMaxWidth,
1212 /** \brief Minimal height in pixels (int, read-only). */
1213 VASurfaceAttribMinHeight,
1214 /** \brief Maximal height in pixels (int, read-only). */
1215 VASurfaceAttribMaxHeight,
1216 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1217 VASurfaceAttribMemoryType,
1218 /** \brief External buffer descriptor (pointer, write). */
1219 VASurfaceAttribExternalBufferDescriptor,
1220 /** \brief Surface usage hint, gives the driver a hint of intended usage
1221 * to optimize allocation (e.g. tiling) (int, read/write). */
1222 VASurfaceAttribUsageHint,
1223 /** \brief Number of surface attributes. */
1224 VASurfaceAttribCount
1225 } VASurfaceAttribType;
1227 /** \brief Surface attribute. */
1228 typedef struct _VASurfaceAttrib {
1230 VASurfaceAttribType type;
1231 /** \brief Flags. See "Surface attribute flags". */
1233 /** \brief Value. See "Surface attribute types" for the expected types. */
1234 VAGenericValue value;
1238 * @name VASurfaceAttribMemoryType values in bit fields.
1239 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1240 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1241 * types are defined in DRM and Android header files.
1244 /** \brief VA memory type (default) is supported. */
1245 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1246 /** \brief V4L2 buffer memory type is supported. */
1247 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1248 /** \brief User pointer memory type is supported. */
1249 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1253 * \brief VASurfaceAttribExternalBuffers structure for
1254 * the VASurfaceAttribExternalBufferDescriptor attribute.
1256 typedef struct _VASurfaceAttribExternalBuffers {
1257 /** \brief pixel format in fourcc. */
1258 uint32_t pixel_format;
1259 /** \brief width in pixels. */
1261 /** \brief height in pixels. */
1263 /** \brief total size of the buffer in bytes. */
1265 /** \brief number of planes for planar layout */
1266 uint32_t num_planes;
1267 /** \brief pitch for each plane in bytes */
1268 uint32_t pitches[4];
1269 /** \brief offset for each plane in bytes */
1270 uint32_t offsets[4];
1271 /** \brief buffer handles or user pointers */
1273 /** \brief number of elements in the "buffers" array */
1274 uint32_t num_buffers;
1275 /** \brief flags. See "Surface external buffer descriptor flags". */
1277 /** \brief reserved for passing private data */
1279 } VASurfaceAttribExternalBuffers;
1281 /** @name VASurfaceAttribExternalBuffers flags */
1283 /** \brief Enable memory tiling */
1284 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1285 /** \brief Memory is cacheable */
1286 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1287 /** \brief Memory is non-cacheable */
1288 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1289 /** \brief Memory is write-combined */
1290 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1291 /** \brief Memory is protected */
1292 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1294 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1296 /** \brief Surface usage not indicated. */
1297 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1298 /** \brief Surface used by video decoder. */
1299 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1300 /** \brief Surface used by video encoder. */
1301 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1302 /** \brief Surface read by video post-processing. */
1303 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1304 /** \brief Surface written by video post-processing. */
1305 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1306 /** \brief Surface used for display. */
1307 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1312 * \brief Queries surface attributes for the supplied config.
1314 * This function queries for all supported attributes for the
1315 * supplied VA @config. In particular, if the underlying hardware
1316 * supports the creation of VA surfaces in various formats, then
1317 * this function will enumerate all pixel formats that are supported.
1319 * The \c attrib_list array is allocated by the user and \c
1320 * num_attribs shall be initialized to the number of allocated
1321 * elements in that array. Upon successful return, the actual number
1322 * of attributes will be overwritten into \c num_attribs. Otherwise,
1323 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1324 * is adjusted to the number of elements that would be returned if
1325 * enough space was available.
1327 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1328 * argument when vaQuerySurfaceAttributes() is used to determine the
1329 * actual number of elements that need to be allocated.
1331 * @param[in] dpy the VA display
1332 * @param[in] config the config identifying a codec or a video
1333 * processing pipeline
1334 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1335 * @param[in,out] num_attribs the number of elements allocated on
1336 * input, the number of elements actually filled in output
1339 vaQuerySurfaceAttributes(
1342 VASurfaceAttrib *attrib_list,
1343 unsigned int *num_attribs
1347 * \brief Creates an array of surfaces
1349 * Creates an array of surfaces. The optional list of attributes shall
1350 * be constructed based on what the underlying hardware could expose
1351 * through vaQuerySurfaceAttributes().
1353 * @param[in] dpy the VA display
1354 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1355 * @param[in] width the surface width
1356 * @param[in] height the surface height
1357 * @param[out] surfaces the array of newly created surfaces
1358 * @param[in] num_surfaces the number of surfaces to create
1359 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1360 * @param[in] num_attribs the number of attributes supplied in
1361 * \c attrib_list, or zero
1366 unsigned int format,
1368 unsigned int height,
1369 VASurfaceID *surfaces,
1370 unsigned int num_surfaces,
1371 VASurfaceAttrib *attrib_list,
1372 unsigned int num_attribs
1376 * vaDestroySurfaces - Destroy resources associated with surfaces.
1377 * Surfaces can only be destroyed after all contexts using these surfaces have been
1380 * surfaces: array of surfaces to destroy
1381 * num_surfaces: number of surfaces in the array to be destroyed.
1383 VAStatus vaDestroySurfaces (
1385 VASurfaceID *surfaces,
1389 #define VA_PROGRESSIVE 0x1
1391 * vaCreateContext - Create a context
1393 * config_id: configuration for the context
1394 * picture_width: coded picture width
1395 * picture_height: coded picture height
1396 * flag: any combination of the following:
1397 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1398 * render_targets: a hint for render targets (surfaces) tied to the context
1399 * num_render_targets: number of render targets in the above array
1400 * context: created context id upon return
1402 VAStatus vaCreateContext (
1404 VAConfigID config_id,
1408 VASurfaceID *render_targets,
1409 int num_render_targets,
1410 VAContextID *context /* out */
1414 * vaDestroyContext - Destroy a context
1416 * context: context to be destroyed
1418 VAStatus vaDestroyContext (
1423 //Multi-frame context
1424 typedef VAGenericID VAMFContextID;
1426 * vaCreateMFContext - Create a multi-frame context
1427 * interface encapsulating common for all streams memory objects and structures
1428 * required for single GPU task submission from several VAContextID's.
1429 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1430 * Support identification: Application can identify multi-frame feature support by ability
1431 * to create multi-frame context. If driver supports multi-frame - call successful,
1432 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1433 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1435 * VA_STATUS_SUCCESS - operation successful.
1436 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1437 * dpy: display adapter.
1438 * mf_context: Multi-Frame context encapsulating all associated context
1439 * for multi-frame submission.
1441 VAStatus vaCreateMFContext (
1443 VAMFContextID *mf_context /* out */
1447 * vaMFAddContext - Provide ability to associate each context used for
1448 * Multi-Frame submission and common Multi-Frame context.
1449 * Try to add context to understand if it is supported.
1450 * Allocation: this call allocates and/or reallocates all memory objects
1451 * common for all contexts associated with particular Multi-Frame context.
1452 * All memory required for each context(pixel buffers, internal driver
1453 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1454 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1455 * first context added will set entry point/profile for whole Multi-Frame context,
1456 * all other entry points and profiles can be rejected to be added.
1458 * VA_STATUS_SUCCESS - operation successful, context was added.
1459 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1460 * current mf_context and associated contexts and start working with new ones.
1461 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1462 * 1 - mf_context is not valid context or
1463 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1464 * and current context contradicts with previously added, application can continue with current mf_context
1465 * and other contexts passed this call, rejected context can continue work in stand-alone
1466 * mode or other mf_context.
1467 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1468 * unsupported VAEntrypoint. Application can continue with current mf_context
1469 * and other contexts passed this call, rejected context can continue work in stand-alone
1471 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1472 * but VAProfile is not supported. Application can continue with current mf_context
1473 * and other contexts passed this call, rejected context can continue work in stand-alone
1475 * dpy: display adapter.
1476 * context: context being associated with Multi-Frame context.
1477 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1479 VAStatus vaMFAddContext (
1481 VAMFContextID mf_context,
1486 * vaMFReleaseContext - Removes context from multi-frame and
1487 * association with multi-frame context.
1488 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1490 * VA_STATUS_SUCCESS - operation successful, context was removed.
1491 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1492 * application need to destroy this VAMFContextID and all assotiated VAContextID
1494 * mf_context: VAMFContextID where context is added
1495 * context: VAContextID to be added
1497 VAStatus vaMFReleaseContext (
1499 VAMFContextID mf_context,
1505 * Buffers are used to pass various types of data from the
1506 * client to the server. The server maintains a data store
1507 * for each buffer created, and the client idenfies a buffer
1508 * through a unique buffer id assigned by the server.
1511 typedef VAGenericID VABufferID;
1515 VAPictureParameterBufferType = 0,
1516 VAIQMatrixBufferType = 1,
1517 VABitPlaneBufferType = 2,
1518 VASliceGroupMapBufferType = 3,
1519 VASliceParameterBufferType = 4,
1520 VASliceDataBufferType = 5,
1521 VAMacroblockParameterBufferType = 6,
1522 VAResidualDataBufferType = 7,
1523 VADeblockingParameterBufferType = 8,
1524 VAImageBufferType = 9,
1525 VAProtectedSliceDataBufferType = 10,
1526 VAQMatrixBufferType = 11,
1527 VAHuffmanTableBufferType = 12,
1528 VAProbabilityBufferType = 13,
1530 /* Following are encode buffer types */
1531 VAEncCodedBufferType = 21,
1532 VAEncSequenceParameterBufferType = 22,
1533 VAEncPictureParameterBufferType = 23,
1534 VAEncSliceParameterBufferType = 24,
1535 VAEncPackedHeaderParameterBufferType = 25,
1536 VAEncPackedHeaderDataBufferType = 26,
1537 VAEncMiscParameterBufferType = 27,
1538 VAEncMacroblockParameterBufferType = 28,
1539 VAEncMacroblockMapBufferType = 29,
1542 * \brief Encoding QP buffer
1544 * This buffer contains QP per MB for encoding. Currently
1545 * VAEncQPBufferH264 is defined for H.264 encoding, see
1546 * #VAEncQPBufferH264 for details
1548 VAEncQPBufferType = 30,
1549 /* Following are video processing buffer types */
1551 * \brief Video processing pipeline parameter buffer.
1553 * This buffer describes the video processing pipeline. See
1554 * #VAProcPipelineParameterBuffer for details.
1556 VAProcPipelineParameterBufferType = 41,
1558 * \brief Video filter parameter buffer.
1560 * This buffer describes the video filter parameters. All buffers
1561 * inherit from #VAProcFilterParameterBufferBase, thus including
1562 * a unique filter buffer type.
1564 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1565 * Filters requiring advanced parameters include, but are not limited to,
1566 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1567 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1569 VAProcFilterParameterBufferType = 42,
1571 * \brief FEI specific buffer types
1573 VAEncFEIMVBufferType = 43,
1574 VAEncFEIMBCodeBufferType = 44,
1575 VAEncFEIDistortionBufferType = 45,
1576 VAEncFEIMBControlBufferType = 46,
1577 VAEncFEIMVPredictorBufferType = 47,
1578 VAStatsStatisticsParameterBufferType = 48,
1579 /** \brief Statistics output for VAEntrypointStats progressive and top field of interlaced case*/
1580 VAStatsStatisticsBufferType = 49,
1581 /** \brief Statistics output for VAEntrypointStats bottom field of interlaced case*/
1582 VAStatsStatisticsBottomFieldBufferType = 50,
1583 VAStatsMVBufferType = 51,
1584 VAStatsMVPredictorBufferType = 52,
1585 /** Force MB's to be non skip for encode.it's per-mb control buffer, The width of the MB map
1586 * Surface is (width of the Picture in MB unit) * 1 byte, multiple of 64 bytes.
1587 * The height is (height of the picture in MB unit). The picture is either
1588 * frame or non-interleaved top or bottom field. If the application provides this
1589 *surface, it will override the "skipCheckDisable" setting in VAEncMiscParameterEncQuality.
1591 VAEncMacroblockDisableSkipMapBufferType = 53,
1592 /** decode stream out buffer, intermedia data of decode, it may include MV, MB mode etc.
1593 * it can be used to detect motion and analyze the frame contain */
1594 VADecodeStreamoutBufferType = 56,
1599 * Processing rate parameter for encode.
1601 typedef struct _VAProcessingRateParameterEnc {
1602 /** \brief Profile level */
1604 uint8_t reserved[3];
1605 /** \brief quality level. When set to 0, default quality
1608 uint32_t quality_level;
1609 /** \brief Period between I frames. */
1610 uint32_t intra_period;
1611 /** \brief Period between I/P frames. */
1613 } VAProcessingRateParameterEnc;
1616 * Processing rate parameter for decode.
1618 typedef struct _VAProcessingRateParameterDec {
1619 /** \brief Profile level */
1621 uint8_t reserved0[3];
1623 } VAProcessingRateParameterDec;
1625 typedef struct _VAProcessingRateParameter {
1627 VAProcessingRateParameterEnc proc_buf_enc;
1628 VAProcessingRateParameterDec proc_buf_dec;
1630 } VAProcessingRateParameter;
1633 * \brief Queries processing rate for the supplied config.
1635 * This function queries the processing rate based on parameters in
1636 * \c proc_buf for the given \c config. Upon successful return, the processing
1637 * rate value will be stored in \c processing_rate. Processing rate is
1638 * specified as the number of macroblocks/CTU per second.
1640 * If NULL is passed to the \c proc_buf, the default processing rate for the
1641 * given configuration will be returned.
1643 * @param[in] dpy the VA display
1644 * @param[in] config the config identifying a codec or a video
1645 * processing pipeline
1646 * @param[in] proc_buf the buffer that contains the parameters for
1647 either the encode or decode processing rate
1648 * @param[out] processing_rate processing rate in number of macroblocks per
1649 second constrained by parameters specified in proc_buf
1653 vaQueryProcessingRate(
1656 VAProcessingRateParameter *proc_buf,
1657 unsigned int *processing_rate
1662 VAEncMiscParameterTypeFrameRate = 0,
1663 VAEncMiscParameterTypeRateControl = 1,
1664 VAEncMiscParameterTypeMaxSliceSize = 2,
1665 VAEncMiscParameterTypeAIR = 3,
1666 /** \brief Buffer type used to express a maximum frame size (in bits). */
1667 VAEncMiscParameterTypeMaxFrameSize = 4,
1668 /** \brief Buffer type used for HRD parameters. */
1669 VAEncMiscParameterTypeHRD = 5,
1670 VAEncMiscParameterTypeQualityLevel = 6,
1671 /** \brief Buffer type used for Rolling intra refresh */
1672 VAEncMiscParameterTypeRIR = 7,
1673 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1674 VAEncMiscParameterTypeQuantization = 8,
1675 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1676 * rate control, when the user has externally skipped frames. */
1677 VAEncMiscParameterTypeSkipFrame = 9,
1678 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1679 VAEncMiscParameterTypeROI = 10,
1680 /** \brief Buffer type used for temporal layer structure */
1681 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1682 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1683 VAEncMiscParameterTypeDirtyRect = 13,
1684 /** \brief Buffer type used for parallel BRC parameters. */
1685 VAEncMiscParameterTypeParallelBRC = 14,
1686 /** \brief Set MB partion mode mask and Half-pel/Quant-pel motion search */
1687 VAEncMiscParameterTypeSubMbPartPel = 15,
1688 /** \brief set encode quality tuning */
1689 VAEncMiscParameterTypeEncQuality = 16,
1690 /** \brief Buffer type used for encoder rounding offset parameters. */
1691 VAEncMiscParameterTypeCustomRoundingControl = 17,
1692 /** \brief Buffer type used for FEI input frame level parameters */
1693 VAEncMiscParameterTypeFEIFrameControl = 18,
1694 /** \brief encode extension buffer, ect. MPEG2 Sequence extenstion data */
1695 VAEncMiscParameterTypeExtensionData = 19
1696 } VAEncMiscParameterType;
1698 /** \brief Packed header type. */
1700 /** \brief Packed sequence header. */
1701 VAEncPackedHeaderSequence = 1,
1702 /** \brief Packed picture header. */
1703 VAEncPackedHeaderPicture = 2,
1704 /** \brief Packed slice header. */
1705 VAEncPackedHeaderSlice = 3,
1707 * \brief Packed raw header.
1709 * Packed raw data header can be used by the client to insert a header
1710 * into the bitstream data buffer at the point it is passed, the driver
1711 * will handle the raw packed header based on "has_emulation_bytes" field
1712 * in the packed header parameter structure.
1714 VAEncPackedHeaderRawData = 4,
1716 * \brief Misc packed header. See codec-specific definitions.
1719 * This is a deprecated packed header type. All applications can use
1720 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1722 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1723 } VAEncPackedHeaderType;
1725 /** \brief Packed header parameter. */
1726 typedef struct _VAEncPackedHeaderParameterBuffer {
1727 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1729 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1730 uint32_t bit_length;
1731 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1732 uint8_t has_emulation_bytes;
1734 /** \brief Reserved bytes for future use, must be zero */
1735 uint32_t va_reserved[VA_PADDING_LOW];
1736 } VAEncPackedHeaderParameterBuffer;
1739 * For application, e.g. set a new bitrate
1740 * VABufferID buf_id;
1741 * VAEncMiscParameterBuffer *misc_param;
1742 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1744 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1745 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1746 * 1, NULL, &buf_id);
1748 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1749 * misc_param->type = VAEncMiscParameterTypeRateControl;
1750 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1751 * misc_rate_ctrl->bits_per_second = 6400000;
1752 * vaUnmapBuffer(dpy, buf_id);
1753 * vaRenderPicture(dpy, context, &buf_id, 1);
1755 typedef struct _VAEncMiscParameterBuffer
1757 VAEncMiscParameterType type;
1759 } VAEncMiscParameterBuffer;
1761 /** \brief Temporal layer Structure*/
1762 typedef struct _VAEncMiscParameterTemporalLayerStructure
1764 /** \brief The number of temporal layers */
1765 uint32_t number_of_layers;
1766 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1767 uint32_t periodicity;
1769 * \brief The array indicating the layer id for each frame
1771 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1772 * ids for frames starting from the 2nd frame.
1774 uint32_t layer_id[32];
1776 /** \brief Reserved bytes for future use, must be zero */
1777 uint32_t va_reserved[VA_PADDING_LOW];
1778 } VAEncMiscParameterTemporalLayerStructure;
1781 /** \brief Rate control parameters */
1782 typedef struct _VAEncMiscParameterRateControl
1784 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1785 uint32_t bits_per_second;
1786 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1787 * bit-rate for example if target_percentage is 95 then the rate control will target
1788 * a bit-rate that is 95% of the maximum bit-rate
1790 uint32_t target_percentage;
1791 /* windows size in milliseconds. For example if this is set to 500,
1792 * then the rate control will guarantee the target bit-rate over a 500 ms window
1794 uint32_t window_size;
1795 /* initial QP at I frames */
1796 uint32_t initial_qp;
1798 uint32_t basic_unit_size;
1804 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1805 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1806 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1808 * The temporal layer that the rate control parameters are specified for.
1810 uint32_t temporal_id : 8;
1811 uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1812 uint32_t enable_parallel_brc : 1;
1813 uint32_t enable_dynamic_scaling : 1;
1814 /** \brief Frame Tolerance Mode
1815 * Indicates the tolerance the application has to variations in the frame size.
1816 * For example, wireless display scenarios may require very steady bit rate to
1817 * reduce buffering time. It affects the rate control algorithm used,
1818 * but may or may not have an effect based on the combination of other BRC
1819 * parameters. Only valid when the driver reports support for
1820 * #VAConfigAttribFrameSizeToleranceSupport.
1822 * equals 0 -- normal mode;
1823 * equals 1 -- maps to sliding window;
1824 * equals 2 -- maps to low delay mode;
1827 uint32_t frame_tolerance_mode : 2;
1828 uint32_t reserved : 12;
1832 uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1833 /** \brief Reserved bytes for future use, must be zero */
1835 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1836 } VAEncMiscParameterRateControl;
1838 typedef struct _VAEncMiscParameterFrameRate
1841 * The framerate is specified as a number of frames per second, as a
1842 * fraction. The denominator of the fraction is given in the top half
1843 * (the high two bytes) of the framerate field, and the numerator is
1844 * given in the bottom half (the low two bytes).
1847 * denominator = framerate >> 16 & 0xffff;
1848 * numerator = framerate & 0xffff;
1849 * fps = numerator / denominator;
1851 * For example, if framerate is set to (100 << 16 | 750), this is
1852 * 750 / 100, hence 7.5fps.
1854 * If the denominator is zero (the high two bytes are both zero) then
1855 * it takes the value one instead, so the framerate is just the integer
1856 * in the low 2 bytes.
1864 * The temporal id the framerate parameters are specified for.
1866 uint32_t temporal_id : 8;
1867 uint32_t reserved : 24;
1872 /** \brief Reserved bytes for future use, must be zero */
1873 uint32_t va_reserved[VA_PADDING_LOW];
1874 } VAEncMiscParameterFrameRate;
1877 * Allow a maximum slice size to be specified (in bits).
1878 * The encoder will attempt to make sure that individual slices do not exceed this size
1879 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1881 typedef struct _VAEncMiscParameterMaxSliceSize
1883 uint32_t max_slice_size;
1885 /** \brief Reserved bytes for future use, must be zero */
1886 uint32_t va_reserved[VA_PADDING_LOW];
1887 } VAEncMiscParameterMaxSliceSize;
1889 typedef struct _VAEncMiscParameterAIR
1891 uint32_t air_num_mbs;
1892 uint32_t air_threshold;
1893 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1895 /** \brief Reserved bytes for future use, must be zero */
1896 uint32_t va_reserved[VA_PADDING_LOW];
1897 } VAEncMiscParameterAIR;
1900 * \brief Rolling intra refresh data structure for encoding.
1902 typedef struct _VAEncMiscParameterRIR
1908 * \brief Indicate if intra refresh is enabled in column/row.
1910 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1911 * by the driver before sending this structure.
1914 /* \brief enable RIR in column */
1915 uint32_t enable_rir_column : 1;
1916 /* \brief enable RIR in row */
1917 uint32_t enable_rir_row : 1;
1918 uint32_t reserved : 30;
1923 * \brief Indicates the column or row location in MB. It is ignored if
1926 uint16_t intra_insertion_location;
1928 * \brief Indicates the number of columns or rows in MB. It is ignored if
1931 uint16_t intra_insert_size;
1933 * \brief indicates the Qp difference for inserted intra columns or rows.
1934 * App can use this to adjust intra Qp based on bitrate & max frame size.
1936 uint8_t qp_delta_for_inserted_intra;
1937 /** \brief Reserved bytes for future use, must be zero */
1938 uint32_t va_reserved[VA_PADDING_LOW];
1939 } VAEncMiscParameterRIR;
1941 typedef struct _VAEncMiscParameterHRD
1943 uint32_t initial_buffer_fullness; /* in bits */
1944 uint32_t buffer_size; /* in bits */
1946 /** \brief Reserved bytes for future use, must be zero */
1947 uint32_t va_reserved[VA_PADDING_LOW];
1948 } VAEncMiscParameterHRD;
1951 * \brief Defines a maximum frame size (in bits).
1953 * This misc parameter buffer defines the maximum size of a frame (in
1954 * bits). The encoder will try to make sure that each frame does not
1955 * exceed this size. Otherwise, if the frame size exceeds this size,
1956 * the \c status flag of #VACodedBufferSegment will contain
1957 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1959 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1960 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1961 VAEncMiscParameterType type;
1962 /** \brief Maximum size of a frame (in bits). */
1963 uint32_t max_frame_size;
1965 /** \brief Reserved bytes for future use, must be zero */
1966 uint32_t va_reserved[VA_PADDING_LOW];
1967 } VAEncMiscParameterBufferMaxFrameSize;
1970 * \brief Encoding quality level.
1972 * The encoding quality could be set through this structure, if the implementation
1973 * supports multiple quality levels. The quality level set through this structure is
1974 * persistent over the entire coded sequence, or until a new structure is being sent.
1975 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1976 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1977 * quality. The quality level setting is used as a trade-off between quality and speed/power
1978 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1980 typedef struct _VAEncMiscParameterBufferQualityLevel {
1981 /** \brief Encoding quality level setting. When set to 0, default quality
1984 uint32_t quality_level;
1986 /** \brief Reserved bytes for future use, must be zero */
1987 uint32_t va_reserved[VA_PADDING_LOW];
1988 } VAEncMiscParameterBufferQualityLevel;
1991 * \brief Quantization settings for encoding.
1993 * Some encoders support special types of quantization such as trellis, and this structure
1994 * can be used by the app to control these special types of quantization by the encoder.
1996 typedef struct _VAEncMiscParameterQuantization
2000 /* if no flags is set then quantization is determined by the driver */
2003 /* \brief disable trellis for all frames/fields */
2004 uint64_t disable_trellis : 1;
2005 /* \brief enable trellis for I frames/fields */
2006 uint64_t enable_trellis_I : 1;
2007 /* \brief enable trellis for P frames/fields */
2008 uint64_t enable_trellis_P : 1;
2009 /* \brief enable trellis for B frames/fields */
2010 uint64_t enable_trellis_B : 1;
2011 uint64_t reserved : 28;
2014 } quantization_flags;
2015 } VAEncMiscParameterQuantization;
2018 * \brief Encoding skip frame.
2020 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
2021 * code as all skip's). For rate control purposes the encoder will need to know the size and number
2022 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
2023 * current frame. It is allowed for the application to still send in packed headers for the driver to
2024 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
2026 typedef struct _VAEncMiscParameterSkipFrame {
2027 /** \brief Indicates skip frames as below.
2028 * 0: Encode as normal, no skip.
2029 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
2030 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
2031 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
2032 * in VAEncPackedHeaderPicture). */
2033 uint8_t skip_frame_flag;
2034 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
2035 uint8_t num_skip_frames;
2036 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
2037 * the size of the current skipped frame that is to be packed/encrypted in bits. */
2038 uint32_t size_skip_frames;
2040 /** \brief Reserved bytes for future use, must be zero */
2041 uint32_t va_reserved[VA_PADDING_LOW];
2042 } VAEncMiscParameterSkipFrame;
2045 * \brief Encoding region-of-interest (ROI).
2047 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
2048 * supports ROI input. The ROI set through this structure is applicable only to the
2049 * current frame or field, so must be sent every frame or field to be applied. The number of
2050 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
2051 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
2053 typedef struct _VAEncROI
2055 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
2056 * codec coding units. It is relative to frame coordinates for the frame case and
2057 * to field coordinates for the field case. */
2058 VARectangle roi_rectangle;
2062 * \ref roi_value specifies ROI delta QP or ROI priority.
2063 * -- ROI delta QP is the value that will be added on top of the frame level QP.
2064 * -- ROI priority specifies the priority of a region, it can be positive (more important)
2065 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2066 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2067 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2068 * regions, the roi_value that is first in the ROI array will have priority.
2070 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2071 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2073 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2074 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2075 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2080 typedef struct _VAEncMiscParameterBufferROI {
2081 /** \brief Number of ROIs being sent.*/
2084 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2085 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
2087 int8_t max_delta_qp;
2088 int8_t min_delta_qp;
2090 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
2091 * coordinates for the frame case and to field coordinates for the field case.*/
2096 * \brief An indication for roi value.
2098 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2099 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2100 * in #VAEncROI should be used as ROI priority.
2102 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2103 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2104 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2105 * when VAConfigAttribRateControl == VA_RC_CQP.
2107 uint32_t roi_value_is_qp_delta : 1;
2108 uint32_t reserved : 31;
2113 /** \brief Reserved bytes for future use, must be zero */
2114 uint32_t va_reserved[VA_PADDING_LOW];
2115 } VAEncMiscParameterBufferROI;
2117 * \brief Dirty rectangle data structure for encoding.
2119 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2120 * implementation supports dirty rect input. The rect set through this structure is applicable
2121 * only to the current frame or field, so must be sent every frame or field to be applied.
2122 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
2123 * encoder will use the rect information to know those rectangle areas have changed while the
2124 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2125 * previous picture. The encoder may do some internal optimizations.
2127 typedef struct _VAEncMiscParameterBufferDirtyRect
2129 /** \brief Number of Rectangle being sent.*/
2130 uint32_t num_roi_rectangle;
2132 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2133 VARectangle *roi_rectangle;
2134 } VAEncMiscParameterBufferDirtyRect;
2136 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2137 typedef struct _VAEncMiscParameterParallelRateControl {
2138 /** brief Number of layers*/
2139 uint32_t num_layers;
2140 /** brief Number of B frames per layer per GOP.
2142 * it should be allocated by application, and the is num_layers.
2143 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2144 uint32_t *num_b_in_gop;
2145 } VAEncMiscParameterParallelRateControl;
2147 /** per frame encoder quality controls, once set they will persist for all future frames
2148 *till it is updated again. */
2149 typedef struct _VAEncMiscParameterEncQuality
2155 /** Use raw frames for reference instead of reconstructed frames.
2156 * it only impact motion estimation (ME) stage, and will not impact MC stage
2157 * so the reconstruct picture will can match with decode side */
2158 uint32_t useRawPicForRef : 1;
2159 /** Disables skip check for ME stage, it will increase the bistream size
2160 * but will improve the qulity */
2161 uint32_t skipCheckDisable : 1;
2162 /** Indicates app will override default driver FTQ settings using FTQEnable.
2163 * FTQ is forward transform quantization */
2164 uint32_t FTQOverride : 1;
2165 /** Enables/disables FTQ. */
2166 uint32_t FTQEnable : 1;
2167 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2168 * enabled (FTQSkipThresholdLUT), else default driver thresholds will be used. */
2169 uint32_t FTQSkipThresholdLUTInput : 1;
2170 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2171 * disabled (NonFTQSkipThresholdLUT), else default driver thresholds will be used. */
2172 uint32_t NonFTQSkipThresholdLUTInput : 1;
2173 uint32_t ReservedBit : 1;
2174 /** Control to enable the ME mode decision algorithm to bias to fewer B Direct/Skip types.
2175 * Applies only to B frames, all other frames will ignore this setting. */
2176 uint32_t directBiasAdjustmentEnable : 1;
2177 /** Enables global motion bias. global motion also is called HME (Heirarchical Motion Estimation )
2178 * HME is used to handle large motions and avoiding local minima in the video encoding process
2179 * down scaled the input and reference picture, then do ME. the result will be a predictor to next level HME or ME
2180 * current interface divide the HME to 3 level. UltraHME , SuperHME, and HME, result of UltraHME will be input of SurperHME,
2181 * result of superHME will be a input for HME. HME result will be input of ME. it is a switch for HMEMVCostScalingFactor
2182 * can change the HME bias inside RDO stage*/
2183 uint32_t globalMotionBiasAdjustmentEnable : 1;
2184 /** MV cost scaling ratio for HME ( predictors. It is used when
2185 * globalMotionBiasAdjustmentEnable == 1, else it is ignored. Values are:
2186 * 0: set MV cost to be 0 for HME predictor.
2187 * 1: scale MV cost to be 1/2 of the default value for HME predictor.
2188 * 2: scale MV cost to be 1/4 of the default value for HME predictor.
2189 * 3: scale MV cost to be 1/8 of the default value for HME predictor. */
2190 uint32_t HMEMVCostScalingFactor : 2;
2191 /**disable HME, if it is disabled. Super*ultraHME should also be disabled */
2192 uint32_t HMEDisable : 1;
2193 /**disable Super HME, if it is disabled, ultraHME should be disabled */
2194 uint32_t SuperHMEDisable : 1;
2195 /** disable Ultra HME */
2196 uint32_t UltraHMEDisable : 1;
2197 /** disable panic mode. Panic mode happened when there are extreme BRC (bit rate control) requirement
2198 * frame size cant achieve the target of BRC. when Panic mode is triggered, Coefficients will
2199 * be set to zero. disable panic mode will improve quality but will impact BRC */
2200 uint32_t PanicModeDisable : 1;
2201 /** Force RepartitionCheck
2202 * 0: DEFAULT - follow driver default settings.
2203 * 1: FORCE_ENABLE - enable this feature totally for all cases.
2204 * 2: FORCE_DISABLE - disable this feature totally for all cases. */
2205 uint32_t ForceRepartitionCheck : 2;
2208 uint32_t encControls;
2211 /** Maps QP to skip thresholds when FTQ is enabled. Valid range is 0-255. */
2212 uint8_t FTQSkipThresholdLUT[52];
2213 /** Maps QP to skip thresholds when FTQ is disabled. Valid range is 0-65535. */
2214 uint16_t NonFTQSkipThresholdLUT[52];
2216 uint32_t reserved[VA_PADDING_HIGH]; // Reserved for future use.
2218 } VAEncMiscParameterEncQuality;
2221 * \brief Custom Encoder Rounding Offset Control.
2222 * Application may use this structure to set customized rounding
2223 * offset parameters for quantization.
2224 * Valid when \c VAConfigAttribCustomRoundingControl equals 1.
2226 typedef struct _VAEncMiscParameterCustomRoundingControl
2230 /** \brief Enable customized rounding offset for intra blocks.
2231 * If 0, default value would be taken by driver for intra
2234 uint32_t enable_custom_rouding_intra : 1 ;
2236 /** \brief Intra rounding offset
2237 * Ignored if \c enable_custom_rouding_intra equals 0.
2239 uint32_t rounding_offset_intra : 7;
2241 /** \brief Enable customized rounding offset for inter blocks.
2242 * If 0, default value would be taken by driver for inter
2245 uint32_t enable_custom_rounding_inter : 1 ;
2247 /** \brief Inter rounding offset
2248 * Ignored if \c enable_custom_rouding_inter equals 0.
2250 uint32_t rounding_offset_inter : 7;
2253 uint32_t reserved :16;
2256 } rounding_offset_setting;
2257 } VAEncMiscParameterCustomRoundingControl;
2259 * There will be cases where the bitstream buffer will not have enough room to hold
2260 * the data for the entire slice, and the following flags will be used in the slice
2261 * parameter to signal to the server for the possible cases.
2262 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2263 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2264 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2266 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2267 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2268 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2269 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2271 /* Codec-independent Slice Parameter Buffer base */
2272 typedef struct _VASliceParameterBufferBase
2274 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2275 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2276 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2277 } VASliceParameterBufferBase;
2279 /**********************************
2280 * JPEG common data structures
2281 **********************************/
2283 * \brief Huffman table for JPEG decoding.
2285 * This structure holds the complete Huffman tables. This is an
2286 * aggregation of all Huffman table (DHT) segments maintained by the
2287 * application. i.e. up to 2 Huffman tables are stored in there for
2290 * The #load_huffman_table array can be used as a hint to notify the
2291 * VA driver implementation about which table(s) actually changed
2292 * since the last submission of this buffer.
2294 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2295 /** \brief Specifies which #huffman_table is valid. */
2296 uint8_t load_huffman_table[2];
2297 /** \brief Huffman tables indexed by table identifier (Th). */
2299 /** @name DC table (up to 12 categories) */
2301 /** \brief Number of Huffman codes of length i + 1 (Li). */
2302 uint8_t num_dc_codes[16];
2303 /** \brief Value associated with each Huffman code (Vij). */
2304 uint8_t dc_values[12];
2306 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2308 /** \brief Number of Huffman codes of length i + 1 (Li). */
2309 uint8_t num_ac_codes[16];
2310 /** \brief Value associated with each Huffman code (Vij). */
2311 uint8_t ac_values[162];
2312 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2317 /** \brief Reserved bytes for future use, must be zero */
2318 uint32_t va_reserved[VA_PADDING_LOW];
2319 } VAHuffmanTableBufferJPEGBaseline;
2321 /****************************
2322 * MPEG-2 data structures
2323 ****************************/
2325 /* MPEG-2 Picture Parameter Buffer */
2327 * For each frame or field, and before any slice data, a single
2328 * picture parameter buffer must be send.
2330 typedef struct _VAPictureParameterBufferMPEG2
2332 uint16_t horizontal_size;
2333 uint16_t vertical_size;
2334 VASurfaceID forward_reference_picture;
2335 VASurfaceID backward_reference_picture;
2336 /* meanings of the following fields are the same as in the standard */
2337 int32_t picture_coding_type;
2338 int32_t f_code; /* pack all four fcode into this */
2341 uint32_t intra_dc_precision : 2;
2342 uint32_t picture_structure : 2;
2343 uint32_t top_field_first : 1;
2344 uint32_t frame_pred_frame_dct : 1;
2345 uint32_t concealment_motion_vectors : 1;
2346 uint32_t q_scale_type : 1;
2347 uint32_t intra_vlc_format : 1;
2348 uint32_t alternate_scan : 1;
2349 uint32_t repeat_first_field : 1;
2350 uint32_t progressive_frame : 1;
2351 uint32_t is_first_field : 1; /* indicate whether the current field
2352 * is the first field for field picture
2356 } picture_coding_extension;
2358 /** \brief Reserved bytes for future use, must be zero */
2359 uint32_t va_reserved[VA_PADDING_LOW];
2360 } VAPictureParameterBufferMPEG2;
2362 /** MPEG-2 Inverse Quantization Matrix Buffer */
2363 typedef struct _VAIQMatrixBufferMPEG2
2365 /** \brief Same as the MPEG-2 bitstream syntax element. */
2366 int32_t load_intra_quantiser_matrix;
2367 /** \brief Same as the MPEG-2 bitstream syntax element. */
2368 int32_t load_non_intra_quantiser_matrix;
2369 /** \brief Same as the MPEG-2 bitstream syntax element. */
2370 int32_t load_chroma_intra_quantiser_matrix;
2371 /** \brief Same as the MPEG-2 bitstream syntax element. */
2372 int32_t load_chroma_non_intra_quantiser_matrix;
2373 /** \brief Luminance intra matrix, in zig-zag scan order. */
2374 uint8_t intra_quantiser_matrix[64];
2375 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2376 uint8_t non_intra_quantiser_matrix[64];
2377 /** \brief Chroma intra matrix, in zig-zag scan order. */
2378 uint8_t chroma_intra_quantiser_matrix[64];
2379 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2380 uint8_t chroma_non_intra_quantiser_matrix[64];
2382 /** \brief Reserved bytes for future use, must be zero */
2383 uint32_t va_reserved[VA_PADDING_LOW];
2384 } VAIQMatrixBufferMPEG2;
2386 /** MPEG-2 Slice Parameter Buffer */
2387 typedef struct _VASliceParameterBufferMPEG2
2389 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2390 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2391 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2392 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2393 uint32_t slice_horizontal_position;
2394 uint32_t slice_vertical_position;
2395 int32_t quantiser_scale_code;
2396 int32_t intra_slice_flag;
2398 /** \brief Reserved bytes for future use, must be zero */
2399 uint32_t va_reserved[VA_PADDING_LOW];
2400 } VASliceParameterBufferMPEG2;
2402 /** MPEG-2 Macroblock Parameter Buffer */
2403 typedef struct _VAMacroblockParameterBufferMPEG2
2405 uint16_t macroblock_address;
2407 * macroblock_address (in raster scan order)
2409 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2411 uint8_t macroblock_type; /* see definition below */
2414 uint32_t frame_motion_type : 2;
2415 uint32_t field_motion_type : 2;
2416 uint32_t dct_type : 1;
2420 uint8_t motion_vertical_field_select;
2422 * motion_vertical_field_select:
2423 * see section 6.3.17.2 in the spec
2424 * only the lower 4 bits are used
2425 * bit 0: first vector forward
2426 * bit 1: first vector backward
2427 * bit 2: second vector forward
2428 * bit 3: second vector backward
2430 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2431 uint16_t coded_block_pattern;
2433 * The bitplanes for coded_block_pattern are described
2434 * in Figure 6.10-12 in the spec
2437 /* Number of skipped macroblocks after this macroblock */
2438 uint16_t num_skipped_macroblocks;
2440 /** \brief Reserved bytes for future use, must be zero */
2441 uint32_t va_reserved[VA_PADDING_LOW];
2442 } VAMacroblockParameterBufferMPEG2;
2445 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2447 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2448 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2449 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2450 #define VA_MB_TYPE_MOTION_INTRA 0x10
2453 * MPEG-2 Residual Data Buffer
2454 * For each macroblock, there wil be 64 shorts (16-bit) in the
2455 * residual data buffer
2458 /****************************
2459 * MPEG-4 Part 2 data structures
2460 ****************************/
2462 /* MPEG-4 Picture Parameter Buffer */
2464 * For each frame or field, and before any slice data, a single
2465 * picture parameter buffer must be send.
2467 typedef struct _VAPictureParameterBufferMPEG4
2470 uint16_t vop_height;
2471 VASurfaceID forward_reference_picture;
2472 VASurfaceID backward_reference_picture;
2475 uint32_t short_video_header : 1;
2476 uint32_t chroma_format : 2;
2477 uint32_t interlaced : 1;
2478 uint32_t obmc_disable : 1;
2479 uint32_t sprite_enable : 2;
2480 uint32_t sprite_warping_accuracy : 2;
2481 uint32_t quant_type : 1;
2482 uint32_t quarter_sample : 1;
2483 uint32_t data_partitioned : 1;
2484 uint32_t reversible_vlc : 1;
2485 uint32_t resync_marker_disable : 1;
2489 uint8_t no_of_sprite_warping_points;
2490 int16_t sprite_trajectory_du[3];
2491 int16_t sprite_trajectory_dv[3];
2492 uint8_t quant_precision;
2495 uint32_t vop_coding_type : 2;
2496 uint32_t backward_reference_vop_coding_type : 2;
2497 uint32_t vop_rounding_type : 1;
2498 uint32_t intra_dc_vlc_thr : 3;
2499 uint32_t top_field_first : 1;
2500 uint32_t alternate_vertical_scan_flag : 1;
2504 uint8_t vop_fcode_forward;
2505 uint8_t vop_fcode_backward;
2506 uint16_t vop_time_increment_resolution;
2507 /* short header related */
2508 uint8_t num_gobs_in_vop;
2509 uint8_t num_macroblocks_in_gob;
2510 /* for direct mode prediction */
2514 /** \brief Reserved bytes for future use, must be zero */
2515 uint32_t va_reserved[VA_PADDING_LOW];
2516 } VAPictureParameterBufferMPEG4;
2518 /** MPEG-4 Inverse Quantization Matrix Buffer */
2519 typedef struct _VAIQMatrixBufferMPEG4
2521 /** Same as the MPEG-4:2 bitstream syntax element. */
2522 int32_t load_intra_quant_mat;
2523 /** Same as the MPEG-4:2 bitstream syntax element. */
2524 int32_t load_non_intra_quant_mat;
2525 /** The matrix for intra blocks, in zig-zag scan order. */
2526 uint8_t intra_quant_mat[64];
2527 /** The matrix for non-intra blocks, in zig-zag scan order. */
2528 uint8_t non_intra_quant_mat[64];
2530 /** \brief Reserved bytes for future use, must be zero */
2531 uint32_t va_reserved[VA_PADDING_LOW];
2532 } VAIQMatrixBufferMPEG4;
2534 /** MPEG-4 Slice Parameter Buffer */
2535 typedef struct _VASliceParameterBufferMPEG4
2537 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2538 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2539 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2540 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2541 uint32_t macroblock_number;
2542 int32_t quant_scale;
2544 /** \brief Reserved bytes for future use, must be zero */
2545 uint32_t va_reserved[VA_PADDING_LOW];
2546 } VASliceParameterBufferMPEG4;
2549 VC-1 data structures
2552 typedef enum /* see 7.1.1.32 */
2555 VAMvMode1MvHalfPel = 1,
2556 VAMvMode1MvHalfPelBilinear = 2,
2557 VAMvModeMixedMv = 3,
2558 VAMvModeIntensityCompensation = 4
2561 /** VC-1 Picture Parameter Buffer */
2563 * For each picture, and before any slice data, a picture parameter
2564 * buffer must be send. Multiple picture parameter buffers may be
2565 * sent for a single picture. In that case picture parameters will
2566 * apply to all slice data that follow it until a new picture
2567 * parameter buffer is sent.
2570 * pic_quantizer_type should be set to the applicable quantizer
2571 * type as defined by QUANTIZER (J.1.19) and either
2572 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2574 typedef struct _VAPictureParameterBufferVC1
2576 VASurfaceID forward_reference_picture;
2577 VASurfaceID backward_reference_picture;
2578 /* if out-of-loop post-processing is done on the render
2579 target, then we need to keep the in-loop decoded
2580 picture as a reference picture */
2581 VASurfaceID inloop_decoded_picture;
2583 /* sequence layer for AP or meta data for SP and MP */
2586 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2587 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2588 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2589 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2590 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2591 uint32_t multires : 1; /* METADATA::MULTIRES */
2592 uint32_t overlap : 1; /* METADATA::OVERLAP */
2593 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2594 uint32_t rangered : 1; /* METADATA::RANGERED */
2595 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2596 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2601 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2602 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2605 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2606 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2607 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2608 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2611 } entrypoint_fields;
2612 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2613 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2616 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2617 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2618 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2619 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2622 } range_mapping_fields;
2624 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2625 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2626 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2627 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2628 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2629 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2630 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2631 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2632 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2636 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2637 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2638 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2639 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2640 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2646 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2647 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2648 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2649 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2650 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2651 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2652 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2658 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2659 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2660 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2661 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2662 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2663 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2664 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2667 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2670 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2671 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2672 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2673 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2679 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2680 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2681 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2682 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2683 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2684 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2685 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2686 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2687 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2688 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2694 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2695 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2696 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2697 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2698 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2699 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2700 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2701 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2702 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2703 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2704 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2707 } pic_quantizer_fields;
2710 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2711 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2712 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2713 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2714 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2715 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2720 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2721 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2722 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2724 /** \brief Reserved bytes for future use, must be zero */
2725 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2726 } VAPictureParameterBufferVC1;
2728 /** VC-1 Bitplane Buffer
2729 There will be at most three bitplanes coded in any picture header. To send
2730 the bitplane data more efficiently, each byte is divided in two nibbles, with
2731 each nibble carrying three bitplanes for one macroblock. The following table
2732 shows the bitplane data arrangement within each nibble based on the picture
2735 Picture Type Bit3 Bit2 Bit1 Bit0
2736 I or BI OVERFLAGS ACPRED FIELDTX
2737 P MYTYPEMB SKIPMB DIRECTMB
2738 B FORWARDMB SKIPMB DIRECTMB
2740 Within each byte, the lower nibble is for the first MB and the upper nibble is
2741 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2742 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2743 Macroblock #2 in the first row.
2746 /* VC-1 Slice Parameter Buffer */
2747 typedef struct _VASliceParameterBufferVC1
2749 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2750 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2751 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2752 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2753 uint32_t slice_vertical_position;
2755 /** \brief Reserved bytes for future use, must be zero */
2756 uint32_t va_reserved[VA_PADDING_LOW];
2757 } VASliceParameterBufferVC1;
2759 /* VC-1 Slice Data Buffer */
2761 This is simplely a buffer containing raw bit-stream bytes
2764 /****************************
2765 * H.264/AVC data structures
2766 ****************************/
2768 typedef struct _VAPictureH264
2770 VASurfaceID picture_id;
2773 int32_t TopFieldOrderCnt;
2774 int32_t BottomFieldOrderCnt;
2776 /** \brief Reserved bytes for future use, must be zero */
2777 uint32_t va_reserved[VA_PADDING_LOW];
2779 /* flags in VAPictureH264 could be OR of the following */
2780 #define VA_PICTURE_H264_INVALID 0x00000001
2781 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2782 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2783 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2784 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2786 /** H.264 Picture Parameter Buffer */
2788 * For each picture, and before any slice data, a single
2789 * picture parameter buffer must be send.
2791 typedef struct _VAPictureParameterBufferH264
2793 VAPictureH264 CurrPic;
2794 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2795 uint16_t picture_width_in_mbs_minus1;
2796 uint16_t picture_height_in_mbs_minus1;
2797 uint8_t bit_depth_luma_minus8;
2798 uint8_t bit_depth_chroma_minus8;
2799 uint8_t num_ref_frames;
2802 uint32_t chroma_format_idc : 2;
2803 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2804 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2805 uint32_t frame_mbs_only_flag : 1;
2806 uint32_t mb_adaptive_frame_field_flag : 1;
2807 uint32_t direct_8x8_inference_flag : 1;
2808 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2809 uint32_t log2_max_frame_num_minus4 : 4;
2810 uint32_t pic_order_cnt_type : 2;
2811 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2812 uint32_t delta_pic_order_always_zero_flag : 1;
2816 // FMO is not supported.
2817 va_deprecated uint8_t num_slice_groups_minus1;
2818 va_deprecated uint8_t slice_group_map_type;
2819 va_deprecated uint16_t slice_group_change_rate_minus1;
2820 int8_t pic_init_qp_minus26;
2821 int8_t pic_init_qs_minus26;
2822 int8_t chroma_qp_index_offset;
2823 int8_t second_chroma_qp_index_offset;
2826 uint32_t entropy_coding_mode_flag : 1;
2827 uint32_t weighted_pred_flag : 1;
2828 uint32_t weighted_bipred_idc : 2;
2829 uint32_t transform_8x8_mode_flag : 1;
2830 uint32_t field_pic_flag : 1;
2831 uint32_t constrained_intra_pred_flag : 1;
2832 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2833 uint32_t deblocking_filter_control_present_flag : 1;
2834 uint32_t redundant_pic_cnt_present_flag : 1;
2835 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2841 /** \brief Reserved bytes for future use, must be zero */
2842 uint32_t va_reserved[VA_PADDING_MEDIUM];
2843 } VAPictureParameterBufferH264;
2845 /** H.264 Inverse Quantization Matrix Buffer */
2846 typedef struct _VAIQMatrixBufferH264
2848 /** \brief 4x4 scaling list, in raster scan order. */
2849 uint8_t ScalingList4x4[6][16];
2850 /** \brief 8x8 scaling list, in raster scan order. */
2851 uint8_t ScalingList8x8[2][64];
2853 /** \brief Reserved bytes for future use, must be zero */
2854 uint32_t va_reserved[VA_PADDING_LOW];
2855 } VAIQMatrixBufferH264;
2857 /** H.264 Slice Parameter Buffer */
2858 typedef struct _VASliceParameterBufferH264
2860 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2861 /** \brief Byte offset to the NAL Header Unit for this slice. */
2862 uint32_t slice_data_offset;
2863 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2865 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2867 * This bit offset is relative to and includes the NAL unit byte
2868 * and represents the number of bits parsed in the slice_header()
2869 * after the removal of any emulation prevention bytes in
2870 * there. However, the slice data buffer passed to the hardware is
2871 * the original bitstream, thus including any emulation prevention
2874 uint16_t slice_data_bit_offset;
2875 uint16_t first_mb_in_slice;
2877 uint8_t direct_spatial_mv_pred_flag;
2879 * H264/AVC syntax element
2881 * if num_ref_idx_active_override_flag equals 0, host decoder should
2882 * set its value to num_ref_idx_l0_default_active_minus1.
2884 uint8_t num_ref_idx_l0_active_minus1;
2886 * H264/AVC syntax element
2888 * if num_ref_idx_active_override_flag equals 0, host decoder should
2889 * set its value to num_ref_idx_l1_default_active_minus1.
2891 uint8_t num_ref_idx_l1_active_minus1;
2892 uint8_t cabac_init_idc;
2893 int8_t slice_qp_delta;
2894 uint8_t disable_deblocking_filter_idc;
2895 int8_t slice_alpha_c0_offset_div2;
2896 int8_t slice_beta_offset_div2;
2897 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2898 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2899 uint8_t luma_log2_weight_denom;
2900 uint8_t chroma_log2_weight_denom;
2901 uint8_t luma_weight_l0_flag;
2902 int16_t luma_weight_l0[32];
2903 int16_t luma_offset_l0[32];
2904 uint8_t chroma_weight_l0_flag;
2905 int16_t chroma_weight_l0[32][2];
2906 int16_t chroma_offset_l0[32][2];
2907 uint8_t luma_weight_l1_flag;
2908 int16_t luma_weight_l1[32];
2909 int16_t luma_offset_l1[32];
2910 uint8_t chroma_weight_l1_flag;
2911 int16_t chroma_weight_l1[32][2];
2912 int16_t chroma_offset_l1[32][2];
2914 /** \brief Reserved bytes for future use, must be zero */
2915 uint32_t va_reserved[VA_PADDING_LOW];
2916 } VASliceParameterBufferH264;
2918 /****************************
2919 * Common encode data structures
2920 ****************************/
2923 VAEncPictureTypeIntra = 0,
2924 VAEncPictureTypePredictive = 1,
2925 VAEncPictureTypeBidirectional = 2,
2928 /* Encode Slice Parameter Buffer */
2929 typedef struct _VAEncSliceParameterBuffer
2931 uint32_t start_row_number; /* starting MB row number for this slice */
2932 uint32_t slice_height; /* slice height measured in MB */
2935 uint32_t is_intra : 1;
2936 uint32_t disable_deblocking_filter_idc : 2;
2937 uint32_t uses_long_term_ref :1;
2938 uint32_t is_long_term_ref :1;
2943 /** \brief Reserved bytes for future use, must be zero */
2944 uint32_t va_reserved[VA_PADDING_LOW];
2945 } VAEncSliceParameterBuffer;
2948 /****************************
2949 * H.263 specific encode data structures
2950 ****************************/
2952 typedef struct _VAEncSequenceParameterBufferH263
2954 uint32_t intra_period;
2955 uint32_t bits_per_second;
2956 uint32_t frame_rate;
2957 uint32_t initial_qp;
2960 /** \brief Reserved bytes for future use, must be zero */
2961 uint32_t va_reserved[VA_PADDING_LOW];
2962 } VAEncSequenceParameterBufferH263;
2964 typedef struct _VAEncPictureParameterBufferH263
2966 VASurfaceID reference_picture;
2967 VASurfaceID reconstructed_picture;
2968 VABufferID coded_buf;
2969 uint16_t picture_width;
2970 uint16_t picture_height;
2971 VAEncPictureType picture_type;
2973 /** \brief Reserved bytes for future use, must be zero */
2974 uint32_t va_reserved[VA_PADDING_LOW];
2975 } VAEncPictureParameterBufferH263;
2977 /****************************
2978 * MPEG-4 specific encode data structures
2979 ****************************/
2981 typedef struct _VAEncSequenceParameterBufferMPEG4
2983 uint8_t profile_and_level_indication;
2984 uint32_t intra_period;
2985 uint32_t video_object_layer_width;
2986 uint32_t video_object_layer_height;
2987 uint32_t vop_time_increment_resolution;
2988 uint32_t fixed_vop_rate;
2989 uint32_t fixed_vop_time_increment;
2990 uint32_t bits_per_second;
2991 uint32_t frame_rate;
2992 uint32_t initial_qp;
2995 /** \brief Reserved bytes for future use, must be zero */
2996 uint32_t va_reserved[VA_PADDING_LOW];
2997 } VAEncSequenceParameterBufferMPEG4;
2999 typedef struct _VAEncPictureParameterBufferMPEG4
3001 VASurfaceID reference_picture;
3002 VASurfaceID reconstructed_picture;
3003 VABufferID coded_buf;
3004 uint16_t picture_width;
3005 uint16_t picture_height;
3006 uint32_t modulo_time_base; /* number of 1s */
3007 uint32_t vop_time_increment;
3008 VAEncPictureType picture_type;
3010 /** \brief Reserved bytes for future use, must be zero */
3011 uint32_t va_reserved[VA_PADDING_LOW];
3012 } VAEncPictureParameterBufferMPEG4;
3016 /** Buffer functions */
3019 * Creates a buffer for "num_elements" elements of "size" bytes and
3020 * initalize with "data".
3021 * if "data" is null, then the contents of the buffer data store
3023 * Basically there are two ways to get buffer data to the server side. One is
3024 * to call vaCreateBuffer() with a non-null "data", which results the data being
3025 * copied to the data store on the server side. A different method that
3026 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
3027 * and then use vaMapBuffer() to map the data store from the server side to the
3028 * client address space for access.
3029 * The user must call vaDestroyBuffer() to destroy a buffer.
3030 * Note: image buffers are created by the library, not the client. Please see
3031 * vaCreateImage on how image buffers are managed.
3033 VAStatus vaCreateBuffer (
3035 VAContextID context,
3036 VABufferType type, /* in */
3037 unsigned int size, /* in */
3038 unsigned int num_elements, /* in */
3039 void *data, /* in */
3040 VABufferID *buf_id /* out */
3044 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
3045 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
3046 * can call vaMapBuffer with this Buffer ID to get virtual address.
3047 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
3048 * maybe it should align with 256, and one byte present one Qp.so, call the function.
3049 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
3050 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
3051 * pBuf + 256 is the start of next line.
3052 * different driver implementation maybe return different unit_size and pitch
3054 VAStatus vaCreateBuffer2(
3056 VAContextID context,
3059 unsigned int height,
3060 unsigned int *unit_size,
3061 unsigned int *pitch,
3066 * Convey to the server how many valid elements are in the buffer.
3067 * e.g. if multiple slice parameters are being held in a single buffer,
3068 * this will communicate to the server the number of slice parameters
3069 * that are valid in the buffer.
3071 VAStatus vaBufferSetNumElements (
3073 VABufferID buf_id, /* in */
3074 unsigned int num_elements /* in */
3079 * device independent data structure for codedbuffer
3083 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
3084 * LARGE_SLICE(bit8):At least one slice in the current frame was large
3085 * enough for the encoder to attempt to limit its size.
3086 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
3087 * exceeded the maximum slice size specified.
3088 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
3089 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
3090 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
3092 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
3093 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
3094 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
3095 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
3096 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
3098 * \brief The frame has exceeded the maximum requested size.
3100 * This flag indicates that the encoded frame size exceeds the value
3101 * specified through a misc parameter buffer of type
3102 * #VAEncMiscParameterTypeMaxFrameSize.
3104 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
3106 * \brief the bitstream is bad or corrupt.
3108 #define VA_CODED_BUF_STATUS_BAD_BITSTREAM 0x8000
3109 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
3112 * \brief The coded buffer segment contains a single NAL unit.
3114 * This flag indicates that the coded buffer segment contains a
3115 * single NAL unit. This flag might be useful to the user for
3116 * processing the coded buffer.
3118 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
3121 * \brief Coded buffer segment.
3123 * #VACodedBufferSegment is an element of a linked list describing
3124 * some information on the coded buffer. The coded buffer segment
3125 * could contain either a single NAL unit, or more than one NAL unit.
3126 * It is recommended (but not required) to return a single NAL unit
3127 * in a coded buffer segment, and the implementation should set the
3128 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
3130 typedef struct _VACodedBufferSegment {
3132 * \brief Size of the data buffer in this segment (in bytes).
3135 /** \brief Bit offset into the data buffer where the video data starts. */
3136 uint32_t bit_offset;
3137 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
3139 /** \brief Reserved for future use. */
3141 /** \brief Pointer to the start of the data buffer. */
3144 * \brief Pointer to the next #VACodedBufferSegment element,
3145 * or \c NULL if there is none.
3149 /** \brief Reserved bytes for future use, must be zero */
3150 uint32_t va_reserved[VA_PADDING_LOW];
3151 } VACodedBufferSegment;
3154 * Map data store of the buffer into the client's address space
3155 * vaCreateBuffer() needs to be called with "data" set to NULL before
3156 * calling vaMapBuffer()
3158 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
3159 * VACodedBufferSegment, and the list is terminated if "next" is NULL
3161 VAStatus vaMapBuffer (
3163 VABufferID buf_id, /* in */
3164 void **pbuf /* out */
3168 * After client making changes to a mapped data store, it needs to
3169 * "Unmap" it to let the server know that the data is ready to be
3170 * consumed by the server
3172 VAStatus vaUnmapBuffer (
3174 VABufferID buf_id /* in */
3178 * After this call, the buffer is deleted and this buffer_id is no longer valid
3180 * A buffer can be re-used and sent to the server by another Begin/Render/End
3181 * sequence if vaDestroyBuffer() is not called with this buffer.
3183 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3184 * hardware accelerator can result in performance dropping.
3186 VAStatus vaDestroyBuffer (
3188 VABufferID buffer_id
3191 /** \brief VA buffer information */
3193 /** \brief Buffer handle */
3195 /** \brief Buffer type (See \ref VABufferType). */
3198 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3200 * On input to vaAcquireBufferHandle(), this field can serve as a hint
3201 * to specify the set of memory types the caller is interested in.
3202 * On successful return from vaAcquireBufferHandle(), the field is
3203 * updated with the best matching memory type.
3206 /** \brief Size of the underlying buffer. */
3209 /** \brief Reserved bytes for future use, must be zero */
3210 uint32_t va_reserved[VA_PADDING_LOW];
3214 * \brief Acquires buffer handle for external API usage
3216 * Locks the VA buffer object \ref buf_id for external API usage like
3217 * EGL or OpenCL (OCL). This function is a synchronization point. This
3218 * means that any pending operation is guaranteed to be completed
3219 * prior to returning from the function.
3221 * If the referenced VA buffer object is the backing store of a VA
3222 * surface, then this function acts as if vaSyncSurface() on the
3223 * parent surface was called first.
3225 * The \ref VABufferInfo argument shall be zero'ed on input. On
3226 * successful output, the data structure is filled in with all the
3227 * necessary buffer level implementation details like handle, type,
3228 * memory type and memory size.
3230 * Note: the external API implementation, or the application, can
3231 * express the memory types it is interested in by filling in the \ref
3232 * mem_type field accordingly. On successful output, the memory type
3233 * that fits best the request and that was used is updated in the \ref
3234 * VABufferInfo data structure. If none of the supplied memory types
3235 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3236 * error is returned.
3238 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3239 * is called. Besides, no additional operation is allowed on any of
3240 * the buffer parent object until vaReleaseBufferHandle() is called.
3241 * e.g. decoding into a VA surface backed with the supplied VA buffer
3242 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3246 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3247 * does not support this interface
3248 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3249 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3250 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3251 * does not support exporting buffers of the specified type
3252 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3253 * memory types in \ref VABufferInfo.mem_type was supported
3255 * @param[in] dpy the VA display
3256 * @param[in] buf_id the VA buffer
3257 * @param[in,out] buf_info the associated VA buffer information
3258 * @return VA_STATUS_SUCCESS if successful
3261 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3264 * \brief Releases buffer after usage from external API
3266 * Unlocks the VA buffer object \ref buf_id from external API usage like
3267 * EGL or OpenCL (OCL). This function is a synchronization point. This
3268 * means that any pending operation is guaranteed to be completed
3269 * prior to returning from the function.
3271 * The \ref VABufferInfo argument shall point to the original data
3272 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3273 * This is necessary so that the VA driver implementation could
3274 * deallocate any resources that were needed.
3276 * In any case, returning from this function invalidates any contents
3277 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3278 * valid. Therefore, VA driver implementations are free to reset this
3279 * data structure to safe defaults.
3282 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3283 * does not support this interface
3284 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3285 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3286 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3287 * does not support exporting buffers of the specified type
3289 * @param[in] dpy the VA display
3290 * @param[in] buf_id the VA buffer
3291 * @return VA_STATUS_SUCCESS if successful
3294 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3297 * Render (Video Decode/Encode/Processing) Pictures
3299 * A picture represents either a frame or a field.
3301 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3306 * Get ready for a video pipeline
3307 * - decode a picture to a target surface
3308 * - encode a picture from a target surface
3309 * - process a picture to a target surface
3311 VAStatus vaBeginPicture (
3313 VAContextID context,
3314 VASurfaceID render_target
3318 * Send video decode, encode or processing buffers to the server.
3320 VAStatus vaRenderPicture (
3322 VAContextID context,
3323 VABufferID *buffers,
3328 * Make the end of rendering for a picture.
3329 * The server should start processing all pending operations for this
3330 * surface. This call is non-blocking. The client can start another
3331 * Begin/Render/End sequence on a different render target.
3332 * if VAContextID used in this function previously successfully passed
3333 * vaMFAddContext call, real processing will be started during vaMFSubmit
3335 VAStatus vaEndPicture (
3341 * Make the end of rendering for a pictures in contexts passed with submission.
3342 * The server should start processing all pending operations for contexts.
3343 * All contexts passed should be associated through vaMFAddContext
3344 * and call sequence Begin/Render/End performed.
3345 * This call is non-blocking. The client can start another
3346 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3348 * VA_STATUS_SUCCESS - operation successful, context was removed.
3349 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3350 * due to mf_context not created or one of contexts not assotiated with mf_context
3351 * through vaAddContext.
3352 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3353 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3355 * mf_context: Multi-Frame context
3356 * contexts: list of contexts submitting their tasks for multi-frame operation.
3357 * num_contexts: number of passed contexts.
3359 VAStatus vaMFSubmit (
3361 VAMFContextID mf_context,
3362 VAContextID * contexts,
3373 * This function blocks until all pending operations on the render target
3374 * have been completed. Upon return it is safe to use the render target for a
3375 * different picture.
3377 VAStatus vaSyncSurface (
3379 VASurfaceID render_target
3384 VASurfaceRendering = 1, /* Rendering in progress */
3385 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3386 /* this status is useful if surface is used as the source */
3388 VASurfaceReady = 4, /* not being rendered or displayed */
3389 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3393 * Find out any pending ops on the render target
3395 VAStatus vaQuerySurfaceStatus (
3397 VASurfaceID render_target,
3398 VASurfaceStatus *status /* out */
3403 VADecodeSliceMissing = 0,
3404 VADecodeMBError = 1,
3405 } VADecodeErrorType;
3408 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3409 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3411 typedef struct _VASurfaceDecodeMBErrors
3413 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3414 uint32_t start_mb; /* start mb address with errors */
3415 uint32_t end_mb; /* end mb address with errors */
3416 VADecodeErrorType decode_error_type;
3417 uint32_t num_mb; /* number of mbs with errors */
3418 /** \brief Reserved bytes for future use, must be zero */
3419 uint32_t va_reserved[VA_PADDING_LOW - 1];
3420 } VASurfaceDecodeMBErrors;
3423 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3424 * it can call vaQuerySurfaceError to find out further details on the particular error.
3425 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3426 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3427 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3428 * The array is terminated if "status==-1" is detected.
3430 VAStatus vaQuerySurfaceError(
3432 VASurfaceID surface,
3433 VAStatus error_status,
3438 * Images and Subpictures
3439 * VAImage is used to either get the surface data to client memory, or
3440 * to copy image data in client memory to a surface.
3441 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3442 * is at the upper left corner with positive X to the right and positive Y down
3444 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3445 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3446 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3449 * Pre-defined fourcc codes
3451 #define VA_FOURCC_NV12 0x3231564E
3452 #define VA_FOURCC_NV21 0x3132564E
3453 #define VA_FOURCC_AI44 0x34344149
3454 #define VA_FOURCC_RGBA 0x41424752
3455 #define VA_FOURCC_RGBX 0x58424752
3456 #define VA_FOURCC_BGRA 0x41524742
3457 #define VA_FOURCC_BGRX 0x58524742
3458 #define VA_FOURCC_ARGB 0x42475241
3459 #define VA_FOURCC_XRGB 0x42475258
3460 #define VA_FOURCC_ABGR 0x52474241
3461 #define VA_FOURCC_XBGR 0x52474258
3462 #define VA_FOURCC_UYVY 0x59565955
3463 #define VA_FOURCC_YUY2 0x32595559
3464 #define VA_FOURCC_AYUV 0x56555941
3465 #define VA_FOURCC_NV11 0x3131564e
3466 #define VA_FOURCC_YV12 0x32315659
3467 #define VA_FOURCC_P208 0x38303250
3468 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3469 #define VA_FOURCC_IYUV 0x56555949
3470 #define VA_FOURCC_I420 0x30323449
3471 #define VA_FOURCC_YV24 0x34325659
3472 #define VA_FOURCC_YV32 0x32335659
3473 #define VA_FOURCC_Y800 0x30303859
3474 #define VA_FOURCC_IMC3 0x33434D49
3475 #define VA_FOURCC_411P 0x50313134
3476 #define VA_FOURCC_422H 0x48323234
3477 #define VA_FOURCC_422V 0x56323234
3478 #define VA_FOURCC_444P 0x50343434
3479 #define VA_FOURCC_RGBP 0x50424752
3480 #define VA_FOURCC_BGRP 0x50524742
3481 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
3484 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3486 #define VA_FOURCC_YV16 0x36315659
3488 * 10-bit and 16-bit Planar YUV 4:2:0.
3490 #define VA_FOURCC_P010 0x30313050
3491 #define VA_FOURCC_P016 0x36313050
3494 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3496 #define VA_FOURCC_I010 0x30313049
3499 #define VA_LSB_FIRST 1
3500 #define VA_MSB_FIRST 2
3502 typedef struct _VAImageFormat
3505 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3506 uint32_t bits_per_pixel;
3507 /* for RGB formats */
3508 uint32_t depth; /* significant bits per pixel */
3510 uint32_t green_mask;
3512 uint32_t alpha_mask;
3514 /** \brief Reserved bytes for future use, must be zero */
3515 uint32_t va_reserved[VA_PADDING_LOW];
3518 typedef VAGenericID VAImageID;
3520 typedef struct _VAImage
3522 VAImageID image_id; /* uniquely identify this image */
3523 VAImageFormat format;
3524 VABufferID buf; /* image data buffer */
3526 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3527 * data store on the server side for optimal performance. The buffer will be
3528 * created by the CreateImage function, and proper storage allocated based on the image
3529 * size and format. This buffer is managed by the library implementation, and
3530 * accessed by the client through the buffer Map/Unmap functions.
3535 uint32_t num_planes; /* can not be greater than 3 */
3537 * An array indicating the scanline pitch in bytes for each plane.
3538 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3540 uint32_t pitches[3];
3542 * An array indicating the byte offset from the beginning of the image data
3543 * to the start of each plane.
3545 uint32_t offsets[3];
3547 /* The following fields are only needed for paletted formats */
3548 int32_t num_palette_entries; /* set to zero for non-palette images */
3550 * Each component is one byte and entry_bytes indicates the number of components in
3551 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3553 int32_t entry_bytes;
3555 * An array of ascii characters describing the order of the components within the bytes.
3556 * Only entry_bytes characters of the string are used.
3558 int8_t component_order[4];
3560 /** \brief Reserved bytes for future use, must be zero */
3561 uint32_t va_reserved[VA_PADDING_LOW];
3564 /** Get maximum number of image formats supported by the implementation */
3565 int vaMaxNumImageFormats (
3570 * Query supported image formats
3571 * The caller must provide a "format_list" array that can hold at
3572 * least vaMaxNumImageFormats() entries. The actual number of formats
3573 * returned in "format_list" is returned in "num_formats".
3575 VAStatus vaQueryImageFormats (
3577 VAImageFormat *format_list, /* out */
3578 int *num_formats /* out */
3582 * Create a VAImage structure
3583 * The width and height fields returned in the VAImage structure may get
3584 * enlarged for some YUV formats. Upon return from this function,
3585 * image->buf has been created and proper storage allocated by the library.
3586 * The client can access the image through the Map/Unmap calls.
3588 VAStatus vaCreateImage (
3590 VAImageFormat *format,
3593 VAImage *image /* out */
3597 * Should call DestroyImage before destroying the surface it is bound to
3599 VAStatus vaDestroyImage (
3604 VAStatus vaSetImagePalette (
3608 * pointer to an array holding the palette data. The size of the array is
3609 * num_palette_entries * entry_bytes in size. The order of the components
3610 * in the palette is described by the component_order in VAImage struct
3612 unsigned char *palette
3616 * Retrive surface data into a VAImage
3617 * Image must be in a format supported by the implementation
3619 VAStatus vaGetImage (
3621 VASurfaceID surface,
3622 int x, /* coordinates of the upper left source pixel */
3624 unsigned int width, /* width and height of the region */
3625 unsigned int height,
3630 * Copy data from a VAImage to a surface
3631 * Image must be in a format supported by the implementation
3632 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3633 * shouldn't be rendered into when this is called
3635 VAStatus vaPutImage (
3637 VASurfaceID surface,
3641 unsigned int src_width,
3642 unsigned int src_height,
3645 unsigned int dest_width,
3646 unsigned int dest_height
3650 * Derive an VAImage from an existing surface.
3651 * This interface will derive a VAImage and corresponding image buffer from
3652 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3653 * direct CPU access. This operation is only possible on implementations with
3654 * direct rendering capabilities and internal surface formats that can be
3655 * represented with a VAImage. When the operation is not possible this interface
3656 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3657 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3660 * Implementations should only return success when the resulting image buffer
3661 * would be useable with vaMap/Unmap.
3663 * When directly accessing a surface special care must be taken to insure
3664 * proper synchronization with the graphics hardware. Clients should call
3665 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3666 * rendering or currently being displayed by an overlay.
3668 * Additionally nothing about the contents of a surface should be assumed
3669 * following a vaPutSurface. Implementations are free to modify the surface for
3670 * scaling or subpicture blending within a call to vaPutImage.
3672 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3673 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3674 * vaGetImage with other surfaces is supported.
3676 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3677 * image and image buffer structures will be destroyed; however, the underlying
3678 * surface will remain unchanged until freed with vaDestroySurfaces.
3680 VAStatus vaDeriveImage (
3682 VASurfaceID surface,
3683 VAImage *image /* out */
3688 * Subpicture is a special type of image that can be blended
3689 * with a surface during vaPutSurface(). Subpicture can be used to render
3690 * DVD sub-titles or closed captioning text etc.
3693 typedef VAGenericID VASubpictureID;
3695 /** Get maximum number of subpicture formats supported by the implementation */
3696 int vaMaxNumSubpictureFormats (
3700 /** flags for subpictures */
3701 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3702 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3703 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3705 * Query supported subpicture formats
3706 * The caller must provide a "format_list" array that can hold at
3707 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3708 * for each format to indicate additional capabilities for that format. The actual
3709 * number of formats returned in "format_list" is returned in "num_formats".
3710 * flags: returned value to indicate addtional capabilities
3711 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3712 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3713 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3716 VAStatus vaQuerySubpictureFormats (
3718 VAImageFormat *format_list, /* out */
3719 unsigned int *flags, /* out */
3720 unsigned int *num_formats /* out */
3724 * Subpictures are created with an image associated.
3726 VAStatus vaCreateSubpicture (
3729 VASubpictureID *subpicture /* out */
3733 * Destroy the subpicture before destroying the image it is assocated to
3735 VAStatus vaDestroySubpicture (
3737 VASubpictureID subpicture
3741 * Bind an image to the subpicture. This image will now be associated with
3742 * the subpicture instead of the one at creation.
3744 VAStatus vaSetSubpictureImage (
3746 VASubpictureID subpicture,
3751 * If chromakey is enabled, then the area where the source value falls within
3752 * the chromakey [min, max] range is transparent
3753 * The chromakey component format is the following:
3754 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3755 * For YUV: [0:7] V [8:15] U [16:23] Y
3756 * The chromakey mask can be used to mask out certain components for chromakey
3759 VAStatus vaSetSubpictureChromakey (
3761 VASubpictureID subpicture,
3762 unsigned int chromakey_min,
3763 unsigned int chromakey_max,
3764 unsigned int chromakey_mask
3768 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3769 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3770 * the overall alpha is per-pixel alpha multiplied by the global alpha
3772 VAStatus vaSetSubpictureGlobalAlpha (
3774 VASubpictureID subpicture,
3779 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3780 * It defines the region mapping between the subpicture and the target
3781 * surfaces through source and destination rectangles (with the same width and height).
3782 * Both will be displayed at the next call to vaPutSurface. Additional
3783 * associations before the call to vaPutSurface simply overrides the association.
3785 VAStatus vaAssociateSubpicture (
3787 VASubpictureID subpicture,
3788 VASurfaceID *target_surfaces,
3790 int16_t src_x, /* upper left offset in subpicture */
3793 uint16_t src_height,
3794 int16_t dest_x, /* upper left offset in surface */
3796 uint16_t dest_width,
3797 uint16_t dest_height,
3799 * whether to enable chroma-keying, global-alpha, or screen relative mode
3800 * see VA_SUBPICTURE_XXX values
3806 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3808 VAStatus vaDeassociateSubpicture (
3810 VASubpictureID subpicture,
3811 VASurfaceID *target_surfaces,
3816 * Display attributes
3817 * Display attributes are used to control things such as contrast, hue, saturation,
3818 * brightness etc. in the rendering process. The application can query what
3819 * attributes are supported by the driver, and then set the appropriate attributes
3820 * before calling vaPutSurface()
3822 /* PowerVR IEP Lite attributes */
3825 VADISPLAYATTRIB_BLE_OFF = 0x00,
3826 VADISPLAYATTRIB_BLE_LOW,
3827 VADISPLAYATTRIB_BLE_MEDIUM,
3828 VADISPLAYATTRIB_BLE_HIGH,
3829 VADISPLAYATTRIB_BLE_NONE,
3830 } VADisplayAttribBLEMode;
3832 /** attribute value for VADisplayAttribRotation */
3833 #define VA_ROTATION_NONE 0x00000000
3834 #define VA_ROTATION_90 0x00000001
3835 #define VA_ROTATION_180 0x00000002
3836 #define VA_ROTATION_270 0x00000003
3840 * @name Mirroring directions
3842 * Those values could be used for VADisplayAttribMirror attribute or
3843 * VAProcPipelineParameterBuffer::mirror_state.
3847 /** \brief No Mirroring. */
3848 #define VA_MIRROR_NONE 0x00000000
3849 /** \brief Horizontal Mirroring. */
3850 #define VA_MIRROR_HORIZONTAL 0x00000001
3851 /** \brief Vertical Mirroring. */
3852 #define VA_MIRROR_VERTICAL 0x00000002
3855 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3856 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3857 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3860 #define VA_RENDER_MODE_UNDEFINED 0
3861 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3862 #define VA_RENDER_MODE_LOCAL_GPU 2
3863 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3864 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3866 /** Render device */
3867 #define VA_RENDER_DEVICE_UNDEFINED 0
3868 #define VA_RENDER_DEVICE_LOCAL 1
3869 #define VA_RENDER_DEVICE_EXTERNAL 2
3871 /** Currently defined display attribute types */
3874 VADisplayAttribBrightness = 0,
3875 VADisplayAttribContrast = 1,
3876 VADisplayAttribHue = 2,
3877 VADisplayAttribSaturation = 3,
3878 /* client can specifiy a background color for the target window
3879 * the new feature of video conference,
3880 * the uncovered area of the surface is filled by this color
3881 * also it will blend with the decoded video color
3883 VADisplayAttribBackgroundColor = 4,
3885 * this is a gettable only attribute. For some implementations that use the
3886 * hardware overlay, after PutSurface is called, the surface can not be
3887 * re-used until after the subsequent PutSurface call. If this is the case
3888 * then the value for this attribute will be set to 1 so that the client
3889 * will not attempt to re-use the surface right after returning from a call
3892 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3893 * driver may use overlay or GPU alternatively
3895 VADisplayAttribDirectSurface = 5,
3896 VADisplayAttribRotation = 6,
3897 VADisplayAttribOutofLoopDeblock = 7,
3899 /* PowerVR IEP Lite specific attributes */
3900 VADisplayAttribBLEBlackMode = 8,
3901 VADisplayAttribBLEWhiteMode = 9,
3902 VADisplayAttribBlueStretch = 10,
3903 VADisplayAttribSkinColorCorrection = 11,
3905 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3906 * conversion matrix. Each element in the matrix is float-point
3908 VADisplayAttribCSCMatrix = 12,
3909 /* specify the constant color used to blend with video surface
3910 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3911 * d: the final color to overwrite into the frame buffer
3912 * v: decoded video after color conversion,
3913 * c: video color specified by VADisplayAttribBlendColor
3914 * b: background color of the drawable
3916 VADisplayAttribBlendColor = 13,
3918 * Indicate driver to skip painting color key or not.
3919 * only applicable if the render is overlay
3921 VADisplayAttribOverlayAutoPaintColorKey = 14,
3923 * customized overlay color key, the format is RGB888
3924 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3926 VADisplayAttribOverlayColorKey = 15,
3928 * The hint for the implementation of vaPutSurface
3929 * normally, the driver could use an overlay or GPU to render the surface on the screen
3930 * this flag provides APP the flexibity to switch the render dynamically
3932 VADisplayAttribRenderMode = 16,
3934 * specify if vaPutSurface needs to render into specified monitors
3935 * one example is that one external monitor (e.g. HDMI) is enabled,
3936 * but the window manager is not aware of it, and there is no associated drawable
3938 VADisplayAttribRenderDevice = 17,
3940 * specify vaPutSurface render area if there is no drawable on the monitor
3942 VADisplayAttribRenderRect = 18,
3943 } VADisplayAttribType;
3945 /* flags for VADisplayAttribute */
3946 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3947 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3948 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3950 typedef struct _VADisplayAttribute
3952 VADisplayAttribType type;
3955 int32_t value; /* used by the set/get attribute functions */
3956 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3959 /** \brief Reserved bytes for future use, must be zero */
3960 uint32_t va_reserved[VA_PADDING_LOW];
3961 } VADisplayAttribute;
3963 /** Get maximum number of display attributs supported by the implementation */
3964 int vaMaxNumDisplayAttributes (
3969 * Query display attributes
3970 * The caller must provide a "attr_list" array that can hold at
3971 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3972 * returned in "attr_list" is returned in "num_attributes".
3974 VAStatus vaQueryDisplayAttributes (
3976 VADisplayAttribute *attr_list, /* out */
3977 int *num_attributes /* out */
3981 * Get display attributes
3982 * This function returns the current attribute values in "attr_list".
3983 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3984 * from vaQueryDisplayAttributes() can have their values retrieved.
3986 VAStatus vaGetDisplayAttributes (
3988 VADisplayAttribute *attr_list, /* in/out */
3993 * Set display attributes
3994 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3995 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3996 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3998 VAStatus vaSetDisplayAttributes (
4000 VADisplayAttribute *attr_list,
4004 /****************************
4005 * HEVC data structures
4006 ****************************/
4008 * \brief Description of picture properties of those in DPB surfaces.
4010 * If only progressive scan is supported, each surface contains one whole
4012 * Otherwise, each surface contains two fields of whole picture.
4013 * In this case, two entries of ReferenceFrames[] may share same picture_id
4016 typedef struct _VAPictureHEVC
4018 /** \brief reconstructed picture buffer surface index
4019 * invalid when taking value VA_INVALID_SURFACE.
4021 VASurfaceID picture_id;
4022 /** \brief picture order count.
4023 * in HEVC, POCs for top and bottom fields of same picture should
4024 * take different values.
4026 int32_t pic_order_cnt;
4027 /* described below */
4030 /** \brief Reserved bytes for future use, must be zero */
4031 uint32_t va_reserved[VA_PADDING_LOW];
4034 /* flags in VAPictureHEVC could be OR of the following */
4035 #define VA_PICTURE_HEVC_INVALID 0x00000001
4036 /** \brief indication of interlace scan picture.
4037 * should take same value for all the pictures in sequence.
4039 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
4040 /** \brief polarity of the field picture.
4041 * top field takes even lines of buffer surface.
4042 * bottom field takes odd lines of buffer surface.
4044 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
4045 /** \brief Long term reference picture */
4046 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
4048 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
4049 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
4050 * be exclusive. No more than one of them can be set for any picture.
4051 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
4052 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
4053 * Application should provide valid values for both short format and long format.
4054 * The pictures in DPB with any of these three flags turned on are referred by
4055 * the current picture.
4057 /** \brief RefPicSetStCurrBefore of HEVC spec variable
4058 * Number of ReferenceFrames[] entries with this bit set equals
4059 * NumPocStCurrBefore.
4061 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
4062 /** \brief RefPicSetStCurrAfter of HEVC spec variable
4063 * Number of ReferenceFrames[] entries with this bit set equals
4064 * NumPocStCurrAfter.
4066 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
4067 /** \brief RefPicSetLtCurr of HEVC spec variable
4068 * Number of ReferenceFrames[] entries with this bit set equals
4071 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
4073 #include <va/va_dec_hevc.h>
4074 #include <va/va_dec_jpeg.h>
4075 #include <va/va_dec_vp8.h>
4076 #include <va/va_dec_vp9.h>
4077 #include <va/va_enc_hevc.h>
4078 #include <va/va_enc_h264.h>
4079 #include <va/va_enc_jpeg.h>
4080 #include <va/va_enc_mpeg2.h>
4081 #include <va/va_enc_vp8.h>
4082 #include <va/va_enc_vp9.h>
4083 #include <va/va_fei.h>
4084 #include <va/va_fei_h264.h>
4085 #include <va/va_vpp.h>