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>
89 #if defined(__GNUC__) && !defined(__COVERITY__)
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 * - Encoder (H264, HEVC, JPEG, MPEG2, VP8, VP9)
116 * - \ref api_enc_h264
117 * - \ref api_enc_hevc
118 * - \ref api_enc_jpeg
119 * - \ref api_enc_mpeg2
122 * - Decoder (HEVC, JPEG, VP8, VP9)
123 * - \ref api_dec_hevc
124 * - \ref api_dec_jpeg
130 * - \ref api_fei_h264
131 * - \ref api_fei_hevc
135 * \defgroup api_core Core API
143 The VA API is intended to provide an interface between a video decode/encode/processing
144 application (client) and a hardware accelerator (server), to off-load
145 video decode/encode/processing operations from the host to the hardware accelerator at various
148 The basic operation steps are:
150 - Negotiate a mutually acceptable configuration with the server to lock
151 down profile, entrypoints, and other attributes that will not change on
152 a frame-by-frame basis.
153 - Create a video decode, encode or processing context which represents a
154 "virtualized" hardware device
155 - Get and fill the render buffers with the corresponding data (depending on
156 profiles and entrypoints)
157 - Pass the render buffers to the server to handle the current frame
159 Initialization & Configuration Management
161 - Find out supported profiles
162 - Find out entrypoints for a given profile
163 - Find out configuration attributes for a given profile/entrypoint pair
164 - Create a configuration for use by the application
168 typedef void* VADisplay; /* window system dependent */
170 typedef int VAStatus; /** Return status type from functions */
171 /** Values for the return status */
172 #define VA_STATUS_SUCCESS 0x00000000
173 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
174 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
175 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
176 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
177 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
178 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
179 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
180 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
181 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
182 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
183 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
184 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
185 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
186 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
187 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
188 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
189 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
190 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
191 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
192 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
193 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
194 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
195 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
196 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
198 * \brief An invalid/unsupported value was supplied.
200 * This is a catch-all error code for invalid or unsupported values.
201 * e.g. value exceeding the valid range, invalid type in the context
202 * of generic attribute values.
204 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
205 /** \brief An unsupported filter was supplied. */
206 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
207 /** \brief An invalid filter chain was supplied. */
208 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
209 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
210 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
211 /** \brief An unsupported memory type was supplied. */
212 #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
213 /** \brief Indicate allocated buffer size is not enough for input or output. */
214 #define VA_STATUS_ERROR_NOT_ENOUGH_BUFFER 0x00000025
215 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
217 /** De-interlacing flags for vaPutSurface() */
218 #define VA_FRAME_PICTURE 0x00000000
219 #define VA_TOP_FIELD 0x00000001
220 #define VA_BOTTOM_FIELD 0x00000002
223 * Enabled the positioning/cropping/blending feature:
224 * 1, specify the video playback position in the isurface
225 * 2, specify the cropping info for video playback
226 * 3, encoded video will blend with background color
228 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
231 * Clears the drawable with background color.
232 * for hardware overlay based implementation this flag
233 * can be used to turn off the overlay
235 #define VA_CLEAR_DRAWABLE 0x00000008
237 /** Color space conversion flags for vaPutSurface() */
238 #define VA_SRC_COLOR_MASK 0x000000f0
239 #define VA_SRC_BT601 0x00000010
240 #define VA_SRC_BT709 0x00000020
241 #define VA_SRC_SMPTE_240 0x00000040
243 /** Scaling flags for vaPutSurface() */
244 #define VA_FILTER_SCALING_DEFAULT 0x00000000
245 #define VA_FILTER_SCALING_FAST 0x00000100
246 #define VA_FILTER_SCALING_HQ 0x00000200
247 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
248 #define VA_FILTER_SCALING_MASK 0x00000f00
250 /** Padding size in 4-bytes */
251 #define VA_PADDING_LOW 4
252 #define VA_PADDING_MEDIUM 8
253 #define VA_PADDING_HIGH 16
254 #define VA_PADDING_LARGE 32
257 * Returns a short english description of error_status
259 const char *vaErrorStr(VAStatus error_status);
261 typedef struct _VARectangle
269 /** \brief Generic motion vector data structure. */
270 typedef struct _VAMotionVector {
271 /** \mv0[0]: horizontal motion vector for past reference */
272 /** \mv0[1]: vertical motion vector for past reference */
273 /** \mv1[0]: horizontal motion vector for future reference */
274 /** \mv1[1]: vertical motion vector for future reference */
275 int16_t mv0[2]; /* past reference */
276 int16_t mv1[2]; /* future reference */
279 /** Type of a message callback, used for both error and info log. */
280 typedef void (*VAMessageCallback)(void *user_context, const char *message);
283 * Set the callback for error messages, or NULL for no logging.
284 * Returns the previous one, or NULL if it was disabled.
286 VAMessageCallback vaSetErrorCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
289 * Set the callback for info messages, or NULL for no logging.
290 * Returns the previous one, or NULL if it was disabled.
292 VAMessageCallback vaSetInfoCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
296 * A display must be obtained by calling vaGetDisplay() before calling
297 * vaInitialize() and other functions. This connects the API to the
298 * native window system.
299 * For X Windows, native_dpy would be from XOpenDisplay()
301 typedef void* VANativeDisplay; /* window system dependent */
303 int vaDisplayIsValid(VADisplay dpy);
306 * Set the override driver name instead of queried driver driver.
308 VAStatus vaSetDriverName(VADisplay dpy,
313 * Initialize the library
315 VAStatus vaInitialize (
317 int *major_version, /* out */
318 int *minor_version /* out */
322 * After this call, all library internal resources will be cleaned up
324 VAStatus vaTerminate (
329 * vaQueryVendorString returns a pointer to a zero-terminated string
330 * describing some aspects of the VA implemenation on a specific
331 * hardware accelerator. The format of the returned string is vendor
332 * specific and at the discretion of the implementer.
333 * e.g. for the Intel GMA500 implementation, an example would be:
334 * "Intel GMA500 - 2.0.0.32L.0005"
336 const char *vaQueryVendorString (
340 typedef int (*VAPrivFunc)(void);
343 * Return a function pointer given a function name in the library.
344 * This allows private interfaces into the library
346 VAPrivFunc vaGetLibFunc (
351 /** Currently defined profiles */
354 /** \brief Profile ID used for video processing. */
356 VAProfileMPEG2Simple = 0,
357 VAProfileMPEG2Main = 1,
358 VAProfileMPEG4Simple = 2,
359 VAProfileMPEG4AdvancedSimple = 3,
360 VAProfileMPEG4Main = 4,
361 VAProfileH264Baseline va_deprecated_enum = 5,
362 VAProfileH264Main = 6,
363 VAProfileH264High = 7,
364 VAProfileVC1Simple = 8,
365 VAProfileVC1Main = 9,
366 VAProfileVC1Advanced = 10,
367 VAProfileH263Baseline = 11,
368 VAProfileJPEGBaseline = 12,
369 VAProfileH264ConstrainedBaseline = 13,
370 VAProfileVP8Version0_3 = 14,
371 VAProfileH264MultiviewHigh = 15,
372 VAProfileH264StereoHigh = 16,
373 VAProfileHEVCMain = 17,
374 VAProfileHEVCMain10 = 18,
375 VAProfileVP9Profile0 = 19,
376 VAProfileVP9Profile1 = 20,
377 VAProfileVP9Profile2 = 21,
378 VAProfileVP9Profile3 = 22,
379 VAProfileHEVCMain12 = 23,
380 VAProfileHEVCMain422_10 = 24,
381 VAProfileHEVCMain422_12 = 25,
382 VAProfileHEVCMain444 = 26,
383 VAProfileHEVCMain444_10 = 27,
384 VAProfileHEVCMain444_12 = 28,
385 VAProfileHEVCSccMain = 29,
386 VAProfileHEVCSccMain10 = 30,
387 VAProfileHEVCSccMain444 = 31
391 * Currently defined entrypoints
397 VAEntrypointIDCT = 3,
398 VAEntrypointMoComp = 4,
399 VAEntrypointDeblocking = 5,
400 VAEntrypointEncSlice = 6, /* slice level encode */
401 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
403 * For an implementation that supports a low power/high performance variant
404 * for slice level encode, it can choose to expose the
405 * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
406 * available with this entrypoint (e.g. interlace, MBAFF) and the
407 * application can query the encoding configuration attributes to find
408 * out more details if this entrypoint is supported.
410 VAEntrypointEncSliceLP = 8,
411 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
413 * \brief VAEntrypointFEI
415 * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to
416 * have more controls and trade off quality for speed with their own IPs.
417 * The application can optionally provide input to ENC for extra encode control
418 * and get the output from ENC. Application can chose to modify the ENC
419 * output/PAK input during encoding, but the performance impact is significant.
421 * On top of the existing buffers for normal encode, there will be
422 * one extra input buffer (VAEncMiscParameterFEIFrameControl) and
423 * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType
424 * and VAEncFEIDistortionBufferType) for VAEntrypointFEI entry function.
425 * If separate PAK is set, two extra input buffers
426 * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input.
428 VAEntrypointFEI = 11,
430 * \brief VAEntrypointStats
432 * A pre-processing function for getting some statistics and motion vectors is added,
433 * and some extra controls for Encode pipeline are provided. The application can
434 * optionally call the statistics function to get motion vectors and statistics like
435 * variances, distortions before calling Encode function via this entry point.
437 * Checking whether Statistics is supported can be performed with vaQueryConfigEntrypoints().
438 * If Statistics entry point is supported, then the list of returned entry-points will
439 * include #VAEntrypointStats. Supported pixel format, maximum resolution and statistics
440 * specific attributes can be obtained via normal attribute query. One input buffer
441 * (VAStatsStatisticsParameterBufferType) and one or two output buffers
442 * (VAStatsStatisticsBufferType, VAStatsStatisticsBottomFieldBufferType (for interlace only)
443 * and VAStatsMVBufferType) are needed for this entry point.
445 VAEntrypointStats = 12,
448 /** Currently defined configuration attribute types */
451 VAConfigAttribRTFormat = 0,
452 VAConfigAttribSpatialResidual = 1,
453 VAConfigAttribSpatialClipping = 2,
454 VAConfigAttribIntraResidual = 3,
455 VAConfigAttribEncryption = 4,
456 VAConfigAttribRateControl = 5,
458 /** @name Attributes for decoding */
461 * \brief Slice Decoding mode. Read/write.
463 * This attribute determines what mode the driver supports for slice
464 * decoding, through vaGetConfigAttributes(); and what mode the user
465 * will be providing to the driver, through vaCreateConfig(), if the
466 * driver supports those. If this attribute is not set by the user then
467 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
469 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
471 VAConfigAttribDecSliceMode = 6,
473 * \brief JPEG decoding attribute. Read-only.
475 * This attribute exposes a number of capabilities of the underlying
476 * JPEG implementation. The attribute value is partitioned into fields as defined in the
477 * VAConfigAttribValDecJPEG union.
479 VAConfigAttribDecJPEG = 7,
481 * \brief Decode processing support. Read/write.
483 * This attribute determines if the driver supports video processing
484 * with decoding using the decoding context in a single call, through
485 * vaGetConfigAttributes(); and if the user may use this feature,
486 * through vaCreateConfig(), if the driver supports the user scenario.
487 * The user will essentially create a regular decode VAContext. Therefore,
488 * the parameters of vaCreateContext() such as picture_width, picture_height
489 * and render_targets are in relation to the decode output parameters
490 * (not processing output parameters) as normal.
491 * If this attribute is not set by the user then it is assumed that no
492 * extra processing is done after decoding for this decode context.
494 * Since essentially the application is creating a decoder config and context,
495 * all function calls that take in the config (e.g. vaQuerySurfaceAttributes())
496 * or context are in relation to the decoder, except those video processing
497 * function specified in the next paragraph.
499 * Once the decode config and context are created, the user must further
500 * query the supported processing filters using vaQueryVideoProcFilters(),
501 * vaQueryVideoProcFilterCaps(), vaQueryVideoProcPipelineCaps() by specifying
502 * the created decode context. The user must provide processing information
503 * and extra processing output surfaces as "additional_outputs" to the driver
504 * through VAProcPipelineParameterBufferType. The render_target specified
505 * at vaBeginPicture() time refers to the decode output surface. The
506 * target surface for the output of processing needs to be a different
507 * surface since the decode process requires the original reconstructed buffer.
508 * The “surface” member of VAProcPipelineParameterBuffer should be set to the
509 * same as “render_target” set in vaBeginPicture(), but the driver may choose
510 * to ignore this parameter.
512 VAConfigAttribDecProcessing = 8,
513 /** @name Attributes for encoding */
516 * \brief Packed headers mode. Read/write.
518 * This attribute determines what packed headers the driver supports,
519 * through vaGetConfigAttributes(); and what packed headers the user
520 * will be providing to the driver, through vaCreateConfig(), if the
521 * driver supports those.
523 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
525 VAConfigAttribEncPackedHeaders = 10,
527 * \brief Interlaced mode. Read/write.
529 * This attribute determines what kind of interlaced encoding mode
530 * the driver supports.
532 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
534 VAConfigAttribEncInterlaced = 11,
536 * \brief Maximum number of reference frames. Read-only.
538 * This attribute determines the maximum number of reference
539 * frames supported for encoding.
541 * Note: for H.264 encoding, the value represents the maximum number
542 * of reference frames for both the reference picture list 0 (bottom
543 * 16 bits) and the reference picture list 1 (top 16 bits).
545 VAConfigAttribEncMaxRefFrames = 13,
547 * \brief Maximum number of slices per frame. Read-only.
549 * This attribute determines the maximum number of slices the
550 * driver can support to encode a single frame.
552 VAConfigAttribEncMaxSlices = 14,
554 * \brief Slice structure. Read-only.
556 * This attribute determines slice structures supported by the
557 * driver for encoding. This attribute is a hint to the user so
558 * that he can choose a suitable surface size and how to arrange
559 * the encoding process of multiple slices per frame.
561 * More specifically, for H.264 encoding, this attribute
562 * determines the range of accepted values to
563 * VAEncSliceParameterBufferH264::macroblock_address and
564 * VAEncSliceParameterBufferH264::num_macroblocks.
566 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
569 VAConfigAttribEncSliceStructure = 15,
571 * \brief Macroblock information. Read-only.
573 * This attribute determines whether the driver supports extra
574 * encoding information per-macroblock. e.g. QP.
576 * More specifically, for H.264 encoding, if the driver returns a non-zero
577 * value for this attribute, this means the application can create
578 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
579 * through VAEncSliceParameterBufferH264::macroblock_info.
581 VAConfigAttribEncMacroblockInfo = 16,
583 * \brief Maximum picture width. Read-only.
585 * This attribute determines the maximum picture width the driver supports
586 * for a given configuration.
588 VAConfigAttribMaxPictureWidth = 18,
590 * \brief Maximum picture height. Read-only.
592 * This attribute determines the maximum picture height the driver supports
593 * for a given configuration.
595 VAConfigAttribMaxPictureHeight = 19,
597 * \brief JPEG encoding attribute. Read-only.
599 * This attribute exposes a number of capabilities of the underlying
600 * JPEG implementation. The attribute value is partitioned into fields as defined in the
601 * VAConfigAttribValEncJPEG union.
603 VAConfigAttribEncJPEG = 20,
605 * \brief Encoding quality range attribute. Read-only.
607 * This attribute conveys whether the driver supports different quality level settings
608 * for encoding. A value less than or equal to 1 means that the encoder only has a single
609 * quality setting, and a value greater than 1 represents the number of quality levels
610 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
612 VAConfigAttribEncQualityRange = 21,
614 * \brief Encoding quantization attribute. Read-only.
616 * This attribute conveys whether the driver supports certain types of quantization methods
617 * for encoding (e.g. trellis). See \c VA_ENC_QUANTIZATION_xxx for the list of quantization methods
619 VAConfigAttribEncQuantization = 22,
621 * \brief Encoding intra refresh attribute. Read-only.
623 * This attribute conveys whether the driver supports certain types of intra refresh methods
624 * for encoding (e.g. adaptive intra refresh or rolling intra refresh).
625 * See \c VA_ENC_INTRA_REFRESH_xxx for intra refresh methods
627 VAConfigAttribEncIntraRefresh = 23,
629 * \brief Encoding skip frame attribute. Read-only.
631 * This attribute conveys whether the driver supports sending skip frame parameters
632 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
633 * externally skipped frames.
635 VAConfigAttribEncSkipFrame = 24,
637 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
639 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
640 * based on user provided ROI rectangles. The attribute value is partitioned into fields
641 * as defined in the VAConfigAttribValEncROI union.
643 * If ROI encoding is supported, the ROI information is passed to the driver using
644 * VAEncMiscParameterTypeROI.
646 VAConfigAttribEncROI = 25,
648 * \brief Encoding extended rate control attribute. Read-only.
650 * This attribute conveys whether the driver supports any extended rate control features
651 * The attribute value is partitioned into fields as defined in the
652 * VAConfigAttribValEncRateControlExt union.
654 VAConfigAttribEncRateControlExt = 26,
656 * \brief Processing rate reporting attribute. Read-only.
658 * This attribute conveys whether the driver supports reporting of
659 * encode/decode processing rate based on certain set of parameters
660 * (i.e. levels, I frame internvals) for a given configuration.
661 * If this is supported, vaQueryProcessingRate() can be used to get
662 * encode or decode processing rate.
663 * See \c VA_PROCESSING_RATE_xxx for encode/decode processing rate
665 VAConfigAttribProcessingRate = 27,
667 * \brief Encoding dirty rectangle. Read-only.
669 * This attribute conveys whether the driver supports dirty rectangle.
670 * encoding, based on user provided ROI rectangles which indicate the rectangular areas
671 * where the content has changed as compared to the previous picture. The regions of the
672 * picture that are not covered by dirty rect rectangles are assumed to have not changed
673 * compared to the previous picture. The encoder may do some optimizations based on
674 * this information. The attribute value returned indicates the number of regions that
675 * are supported. e.g. A value of 0 means dirty rect encoding is not supported. If dirty
676 * rect encoding is supported, the ROI information is passed to the driver using
677 * VAEncMiscParameterTypeDirtyRect.
679 VAConfigAttribEncDirtyRect = 28,
681 * \brief Parallel Rate Control (hierachical B) attribute. Read-only.
683 * This attribute conveys whether the encoder supports parallel rate control.
684 * It is a integer value 0 - unsupported, > 0 - maximum layer supported.
685 * This is the way when hireachical B frames are encoded, multiple independent B frames
686 * on the same layer may be processed at same time. If supported, app may enable it by
687 * setting enable_parallel_brc in VAEncMiscParameterRateControl,and the number of B frames
688 * per layer per GOP will be passed to driver through VAEncMiscParameterParallelRateControl
689 * structure.Currently three layers are defined.
691 VAConfigAttribEncParallelRateControl = 29,
693 * \brief Dynamic Scaling Attribute. Read-only.
695 * This attribute conveys whether encoder is capable to determine dynamic frame
696 * resolutions adaptive to bandwidth utilization and processing power, etc.
697 * It is a boolean value 0 - unsupported, 1 - supported.
698 * If it is supported,for VP9, suggested frame resolution can be retrieved from VACodedBufferVP9Status.
700 VAConfigAttribEncDynamicScaling = 30,
702 * \brief frame size tolerance support
703 * it indicates the tolerance of frame size
705 VAConfigAttribFrameSizeToleranceSupport = 31,
707 * \brief Encode function type for FEI.
709 * This attribute conveys whether the driver supports different function types for encode.
710 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
711 * it is for FEI entry point only.
712 * Default is VA_FEI_FUNCTION_ENC_PAK.
714 VAConfigAttribFEIFunctionType = 32,
716 * \brief Maximum number of FEI MV predictors. Read-only.
718 * This attribute determines the maximum number of MV predictors the driver
719 * can support to encode a single frame. 0 means no MV predictor is supported.
720 * Currently it is for FEI entry point only.
722 VAConfigAttribFEIMVPredictors = 33,
724 * \brief Statistics attribute. Read-only.
726 * This attribute exposes a number of capabilities of the VAEntrypointStats entry
727 * point. The attribute value is partitioned into fields as defined in the
728 * VAConfigAttribValStats union. Currently it is for VAEntrypointStats only.
730 VAConfigAttribStats = 34,
732 * \brief Tile Support Attribute. Read-only.
734 * This attribute conveys whether encoder is capable to support tiles.
735 * If not supported, the tile related parameters sent to encoder, such as
736 * tiling structure, should be ignored. 0 - unsupported, 1 - supported.
738 VAConfigAttribEncTileSupport = 35,
740 * \brief whether accept rouding setting from application. Read-only.
741 * This attribute is for encode quality, if it is report,
742 * application can change the rounding setting by VAEncMiscParameterTypeCustomRoundingControl
744 VAConfigAttribCustomRoundingControl = 36,
746 * \brief Encoding QP info block size attribute. Read-only.
747 * This attribute conveys the block sizes that underlying driver
748 * support for QP info for buffer #VAEncQpBuffer.
750 VAConfigAttribQPBlockSize = 37,
752 VAConfigAttribTypeMax
753 } VAConfigAttribType;
756 * Configuration attributes
757 * If there is more than one value for an attribute, a default
758 * value will be assigned to the attribute if the client does not
759 * specify the attribute when creating a configuration
761 typedef struct _VAConfigAttrib {
762 VAConfigAttribType type;
763 uint32_t value; /* OR'd flags (bits) for this attribute */
766 /* Attribute values for VAConfigAttribRTFormat. */
768 #define VA_RT_FORMAT_YUV420 0x00000001 ///< YUV 4:2:0 8-bit.
769 #define VA_RT_FORMAT_YUV422 0x00000002 ///< YUV 4:2:2 8-bit.
770 #define VA_RT_FORMAT_YUV444 0x00000004 ///< YUV 4:4:4 8-bit.
771 #define VA_RT_FORMAT_YUV411 0x00000008 ///< YUV 4:1:1 8-bit.
772 #define VA_RT_FORMAT_YUV400 0x00000010 ///< Greyscale 8-bit.
773 #define VA_RT_FORMAT_YUV420_10 0x00000100 ///< YUV 4:2:0 10-bit.
775 #define VA_RT_FORMAT_RGB16 0x00010000 ///< Packed RGB, 16 bits per pixel.
776 #define VA_RT_FORMAT_RGB32 0x00020000 ///< Packed RGB, 32 bits per pixel, 8 bits per colour sample.
777 #define VA_RT_FORMAT_RGBP 0x00100000 ///< Planar RGB, 8 bits per sample.
778 #define VA_RT_FORMAT_RGB32_10 0x00200000 ///< Packed RGB, 32 bits per pixel, 10 bits per colour sample.
780 #define VA_RT_FORMAT_PROTECTED 0x80000000
782 #define VA_RT_FORMAT_RGB32_10BPP VA_RT_FORMAT_RGB32_10 ///< @deprecated use VA_RT_FORMAT_RGB32_10 instead.
783 #define VA_RT_FORMAT_YUV420_10BPP VA_RT_FORMAT_YUV420_10 ///< @deprecated use VA_RT_FORMAT_YUV420_10 instead.
785 /** @name Attribute values for VAConfigAttribRateControl */
787 /** \brief Driver does not support any form of rate control. */
788 #define VA_RC_NONE 0x00000001
789 /** \brief Constant bitrate. */
790 #define VA_RC_CBR 0x00000002
791 /** \brief Variable bitrate. */
792 #define VA_RC_VBR 0x00000004
793 /** \brief Video conference mode. */
794 #define VA_RC_VCM 0x00000008
795 /** \brief Constant QP. */
796 #define VA_RC_CQP 0x00000010
797 /** \brief Variable bitrate with peak rate higher than average bitrate. */
798 #define VA_RC_VBR_CONSTRAINED 0x00000020
799 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
800 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
801 #define VA_RC_ICQ 0x00000040
802 /** \brief Macroblock based rate control. Per MB control is decided
803 * internally in the encoder. It may be combined with other RC modes, except CQP. */
804 #define VA_RC_MB 0x00000080
805 /** \brief Constant Frame Size, it is used for small tolerent */
806 #define VA_RC_CFS 0x00000100
807 /** \brief Parallel BRC, for hierachical B.
809 * For hierachical B, B frames can be refered by other B frames.
810 * Currently three layers of hierachy are defined:
811 * B0 - regular B, no reference to other B frames.
812 * B1 - reference to only I, P and regular B0 frames.
813 * B2 - reference to any other frames, including B1.
814 * In Hierachical B structure, B frames on the same layer can be processed
815 * simultaneously. And BRC would adjust accordingly. This is so called
817 #define VA_RC_PARALLEL 0x00000200
821 /** @name Attribute values for VAConfigAttribDecSliceMode */
823 /** \brief Driver supports normal mode for slice decoding */
824 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
825 /** \brief Driver supports base mode for slice decoding */
826 #define VA_DEC_SLICE_MODE_BASE 0x00000002
828 /** @name Attribute values for VAConfigAttribDecJPEG */
830 typedef union _VAConfigAttribValDecJPEG {
832 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
833 uint32_t rotation : 4;
834 /** \brief Reserved for future use. */
835 uint32_t reserved : 28;
838 uint32_t va_reserved[VA_PADDING_LOW];
839 } VAConfigAttribValDecJPEG;
840 /** @name Attribute values for VAConfigAttribDecProcessing */
842 /** \brief No decoding + processing in a single decoding call. */
843 #define VA_DEC_PROCESSING_NONE 0x00000000
844 /** \brief Decode + processing in a single decoding call. */
845 #define VA_DEC_PROCESSING 0x00000001
848 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
850 /** \brief Driver does not support any packed headers mode. */
851 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
853 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
855 * Application must provide it to driver once this flag is returned through
856 * vaGetConfigAttributes()
858 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
860 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
862 * Application must provide it to driver once this falg is returned through
863 * vaGetConfigAttributes()
865 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
867 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
869 * Application must provide it to driver once this flag is returned through
870 * vaGetConfigAttributes()
872 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
874 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
877 * This is a deprecated packed header flag, All applications can use
878 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
879 * header data buffer to the driver
881 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
882 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
883 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
886 /** @name Attribute values for VAConfigAttribEncInterlaced */
888 /** \brief Driver does not support interlaced coding. */
889 #define VA_ENC_INTERLACED_NONE 0x00000000
890 /** \brief Driver supports interlaced frame coding. */
891 #define VA_ENC_INTERLACED_FRAME 0x00000001
892 /** \brief Driver supports interlaced field coding. */
893 #define VA_ENC_INTERLACED_FIELD 0x00000002
894 /** \brief Driver supports macroblock adaptive frame field coding. */
895 #define VA_ENC_INTERLACED_MBAFF 0x00000004
896 /** \brief Driver supports picture adaptive frame field coding. */
897 #define VA_ENC_INTERLACED_PAFF 0x00000008
900 /** @name Attribute values for VAConfigAttribEncSliceStructure */
902 /** \brief Driver supports a power-of-two number of rows per slice. */
903 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
904 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
905 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
906 /** \brief Dirver support 1 rows per slice */
907 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
908 /** \brief Dirver support max encoded slice size per slice */
909 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
910 /** \brief Driver supports an arbitrary number of rows per slice. */
911 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
914 /** \brief Attribute value for VAConfigAttribEncJPEG */
915 typedef union _VAConfigAttribValEncJPEG {
917 /** \brief set to 1 for arithmatic coding. */
918 uint32_t arithmatic_coding_mode : 1;
919 /** \brief set to 1 for progressive dct. */
920 uint32_t progressive_dct_mode : 1;
921 /** \brief set to 1 for non-interleaved. */
922 uint32_t non_interleaved_mode : 1;
923 /** \brief set to 1 for differential. */
924 uint32_t differential_mode : 1;
925 uint32_t max_num_components : 3;
926 uint32_t max_num_scans : 4;
927 uint32_t max_num_huffman_tables : 3;
928 uint32_t max_num_quantization_tables : 3;
931 } VAConfigAttribValEncJPEG;
933 /** @name Attribute values for VAConfigAttribEncQuantization */
935 /** \brief Driver does not support special types of quantization */
936 #define VA_ENC_QUANTIZATION_NONE 0x00000000
937 /** \brief Driver supports trellis quantization */
938 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
941 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
943 /** \brief Driver does not support intra refresh */
944 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
945 /** \brief Driver supports column based rolling intra refresh */
946 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
947 /** \brief Driver supports row based rolling intra refresh */
948 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
949 /** \brief Driver supports adaptive intra refresh */
950 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
951 /** \brief Driver supports cyclic intra refresh */
952 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
953 /** \brief Driver supports intra refresh of P frame*/
954 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
955 /** \brief Driver supports intra refresh of B frame */
956 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
957 /** \brief Driver supports intra refresh of multiple reference encoder */
958 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
962 /** \brief Attribute value for VAConfigAttribEncROI */
963 typedef union _VAConfigAttribValEncROI {
965 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
966 uint32_t num_roi_regions : 8;
968 * \brief A flag indicates whether ROI priority is supported
970 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
971 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
972 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
973 * the underlying driver doesn't support ROI priority.
975 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
976 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
978 uint32_t roi_rc_priority_support : 1;
980 * \brief A flag indicates whether ROI delta QP is supported
982 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
983 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
984 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
985 * the underlying driver doesn't support ROI delta QP.
987 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
988 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
990 uint32_t roi_rc_qp_delta_support : 1;
991 uint32_t reserved : 22;
994 } VAConfigAttribValEncROI;
996 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
997 typedef union _VAConfigAttribValEncRateControlExt {
1000 * \brief The maximum number of temporal layers minus 1
1002 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
1003 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
1004 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
1006 uint32_t max_num_temporal_layers_minus1 : 8;
1009 * /brief support temporal layer bit-rate control flag
1011 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
1012 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
1013 * #VAConfigAttribRateControl == #VA_RC_VBR).
1015 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
1016 * \c max_num_temporal_layers_minus1 is equal to 0
1018 * To use bit-rate control per temporal layer, an application must send the right layer
1019 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
1020 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
1021 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
1022 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
1023 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
1024 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
1025 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
1027 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
1028 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
1029 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
1031 uint32_t temporal_layer_bitrate_control_flag : 1;
1032 uint32_t reserved : 23;
1035 } VAConfigAttribValEncRateControlExt;
1037 /** @name Attribute values for VAConfigAttribProcessingRate. */
1039 /** \brief Driver does not support processing rate report */
1040 #define VA_PROCESSING_RATE_NONE 0x00000000
1041 /** \brief Driver supports encode processing rate report */
1042 #define VA_PROCESSING_RATE_ENCODE 0x00000001
1043 /** \brief Driver supports decode processing rate report */
1044 #define VA_PROCESSING_RATE_DECODE 0x00000002
1047 * if an attribute is not applicable for a given
1048 * profile/entrypoint pair, then set the value to the following
1050 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
1052 /** Get maximum number of profiles supported by the implementation */
1053 int vaMaxNumProfiles (
1057 /** Get maximum number of entrypoints supported by the implementation */
1058 int vaMaxNumEntrypoints (
1062 /** Get maximum number of attributs supported by the implementation */
1063 int vaMaxNumConfigAttributes (
1068 * Query supported profiles
1069 * The caller must provide a "profile_list" array that can hold at
1070 * least vaMaxNumProfile() entries. The actual number of profiles
1071 * returned in "profile_list" is returned in "num_profile".
1073 VAStatus vaQueryConfigProfiles (
1075 VAProfile *profile_list, /* out */
1076 int *num_profiles /* out */
1080 * Query supported entrypoints for a given profile
1081 * The caller must provide an "entrypoint_list" array that can hold at
1082 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
1083 * returned in "entrypoint_list" is returned in "num_entrypoints".
1085 VAStatus vaQueryConfigEntrypoints (
1088 VAEntrypoint *entrypoint_list, /* out */
1089 int *num_entrypoints /* out */
1093 * Get attributes for a given profile/entrypoint pair
1094 * The caller must provide an "attrib_list" with all attributes to be
1095 * retrieved. Upon return, the attributes in "attrib_list" have been
1096 * updated with their value. Unknown attributes or attributes that are
1097 * not supported for the given profile/entrypoint pair will have their
1098 * value set to VA_ATTRIB_NOT_SUPPORTED
1100 VAStatus vaGetConfigAttributes (
1103 VAEntrypoint entrypoint,
1104 VAConfigAttrib *attrib_list, /* in/out */
1108 /** Generic ID type, can be re-typed for specific implementation */
1109 typedef unsigned int VAGenericID;
1111 typedef VAGenericID VAConfigID;
1114 * Create a configuration for the video decode/encode/processing pipeline
1115 * it passes in the attribute list that specifies the attributes it cares
1116 * about, with the rest taking default values.
1118 VAStatus vaCreateConfig (
1121 VAEntrypoint entrypoint,
1122 VAConfigAttrib *attrib_list,
1124 VAConfigID *config_id /* out */
1128 * Free resources associdated with a given config
1130 VAStatus vaDestroyConfig (
1132 VAConfigID config_id
1136 * Query all attributes for a given configuration
1137 * The profile of the configuration is returned in "profile"
1138 * The entrypoint of the configuration is returned in "entrypoint"
1139 * The caller must provide an "attrib_list" array that can hold at least
1140 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1141 * returned in "attrib_list" is returned in "num_attribs"
1143 VAStatus vaQueryConfigAttributes (
1145 VAConfigID config_id,
1146 VAProfile *profile, /* out */
1147 VAEntrypoint *entrypoint, /* out */
1148 VAConfigAttrib *attrib_list,/* out */
1149 int *num_attribs /* out */
1154 * Contexts and Surfaces
1156 * Context represents a "virtual" video decode, encode or video processing
1157 * pipeline. Surfaces are render targets for a given context. The data in the
1158 * surfaces are not accessible to the client except if derived image is supported
1159 * and the internal data format of the surface is implementation specific.
1161 * Surfaces are provided as a hint of what surfaces will be used when the context
1162 * is created through vaCreateContext(). A surface may be used by different contexts
1163 * at the same time as soon as application can make sure the operations are synchronized
1164 * between different contexts, e.g. a surface is used as the output of a decode context
1165 * and the input of a video process context. Surfaces can only be destroyed after all
1166 * contexts using these surfaces have been destroyed.
1168 * Both contexts and surfaces are identified by unique IDs and its
1169 * implementation specific internals are kept opaque to the clients
1172 typedef VAGenericID VAContextID;
1174 typedef VAGenericID VASurfaceID;
1176 #define VA_INVALID_ID 0xffffffff
1177 #define VA_INVALID_SURFACE VA_INVALID_ID
1179 /** \brief Generic value types. */
1181 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1182 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1183 VAGenericValueTypePointer, /**< Generic pointer type */
1184 VAGenericValueTypeFunc /**< Pointer to function */
1185 } VAGenericValueType;
1187 /** \brief Generic function type. */
1188 typedef void (*VAGenericFunc)(void);
1190 /** \brief Generic value. */
1191 typedef struct _VAGenericValue {
1192 /** \brief Value type. See #VAGenericValueType. */
1193 VAGenericValueType type;
1194 /** \brief Value holder. */
1196 /** \brief 32-bit signed integer. */
1198 /** \brief 32-bit float. */
1200 /** \brief Generic pointer. */
1202 /** \brief Pointer to function. */
1207 /** @name Surface attribute flags */
1209 /** \brief Surface attribute is not supported. */
1210 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1211 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1212 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1213 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1214 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1217 /** \brief Surface attribute types. */
1219 VASurfaceAttribNone = 0,
1221 * \brief Pixel format (fourcc).
1223 * The value is meaningful as input to vaQuerySurfaceAttributes().
1224 * If zero, the driver returns the optimal pixel format for the
1225 * specified config. Otherwise, if non-zero, the value represents
1226 * a pixel format (FOURCC) that is kept as is on output, if the
1227 * driver supports it. Otherwise, the driver sets the value to
1228 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1230 VASurfaceAttribPixelFormat,
1231 /** \brief Minimal width in pixels (int, read-only). */
1232 VASurfaceAttribMinWidth,
1233 /** \brief Maximal width in pixels (int, read-only). */
1234 VASurfaceAttribMaxWidth,
1235 /** \brief Minimal height in pixels (int, read-only). */
1236 VASurfaceAttribMinHeight,
1237 /** \brief Maximal height in pixels (int, read-only). */
1238 VASurfaceAttribMaxHeight,
1239 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1240 VASurfaceAttribMemoryType,
1241 /** \brief External buffer descriptor (pointer, write). */
1242 VASurfaceAttribExternalBufferDescriptor,
1243 /** \brief Surface usage hint, gives the driver a hint of intended usage
1244 * to optimize allocation (e.g. tiling) (int, read/write). */
1245 VASurfaceAttribUsageHint,
1246 /** \brief Number of surface attributes. */
1247 VASurfaceAttribCount
1248 } VASurfaceAttribType;
1250 /** \brief Surface attribute. */
1251 typedef struct _VASurfaceAttrib {
1253 VASurfaceAttribType type;
1254 /** \brief Flags. See "Surface attribute flags". */
1256 /** \brief Value. See "Surface attribute types" for the expected types. */
1257 VAGenericValue value;
1261 * @name VASurfaceAttribMemoryType values in bit fields.
1262 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1263 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1264 * types are defined in DRM and Android header files.
1267 /** \brief VA memory type (default) is supported. */
1268 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1269 /** \brief V4L2 buffer memory type is supported. */
1270 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1271 /** \brief User pointer memory type is supported. */
1272 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1276 * \brief VASurfaceAttribExternalBuffers structure for
1277 * the VASurfaceAttribExternalBufferDescriptor attribute.
1279 typedef struct _VASurfaceAttribExternalBuffers {
1280 /** \brief pixel format in fourcc. */
1281 uint32_t pixel_format;
1282 /** \brief width in pixels. */
1284 /** \brief height in pixels. */
1286 /** \brief total size of the buffer in bytes. */
1288 /** \brief number of planes for planar layout */
1289 uint32_t num_planes;
1290 /** \brief pitch for each plane in bytes */
1291 uint32_t pitches[4];
1292 /** \brief offset for each plane in bytes */
1293 uint32_t offsets[4];
1294 /** \brief buffer handles or user pointers */
1296 /** \brief number of elements in the "buffers" array */
1297 uint32_t num_buffers;
1298 /** \brief flags. See "Surface external buffer descriptor flags". */
1300 /** \brief reserved for passing private data */
1302 } VASurfaceAttribExternalBuffers;
1304 /** @name VASurfaceAttribExternalBuffers flags */
1306 /** \brief Enable memory tiling */
1307 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1308 /** \brief Memory is cacheable */
1309 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1310 /** \brief Memory is non-cacheable */
1311 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1312 /** \brief Memory is write-combined */
1313 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1314 /** \brief Memory is protected */
1315 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1317 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1319 /** \brief Surface usage not indicated. */
1320 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1321 /** \brief Surface used by video decoder. */
1322 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1323 /** \brief Surface used by video encoder. */
1324 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1325 /** \brief Surface read by video post-processing. */
1326 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1327 /** \brief Surface written by video post-processing. */
1328 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1329 /** \brief Surface used for display. */
1330 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1331 /** \brief Surface used for export to third-party APIs, e.g. via
1332 * vaExportSurfaceHandle(). */
1333 #define VA_SURFACE_ATTRIB_USAGE_HINT_EXPORT 0x00000020
1338 * \brief Queries surface attributes for the supplied config.
1340 * This function queries for all supported attributes for the
1341 * supplied VA @config. In particular, if the underlying hardware
1342 * supports the creation of VA surfaces in various formats, then
1343 * this function will enumerate all pixel formats that are supported.
1345 * The \c attrib_list array is allocated by the user and \c
1346 * num_attribs shall be initialized to the number of allocated
1347 * elements in that array. Upon successful return, the actual number
1348 * of attributes will be overwritten into \c num_attribs. Otherwise,
1349 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1350 * is adjusted to the number of elements that would be returned if
1351 * enough space was available.
1353 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1354 * argument when vaQuerySurfaceAttributes() is used to determine the
1355 * actual number of elements that need to be allocated.
1357 * @param[in] dpy the VA display
1358 * @param[in] config the config identifying a codec or a video
1359 * processing pipeline
1360 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1361 * @param[in,out] num_attribs the number of elements allocated on
1362 * input, the number of elements actually filled in output
1365 vaQuerySurfaceAttributes(
1368 VASurfaceAttrib *attrib_list,
1369 unsigned int *num_attribs
1373 * \brief Creates an array of surfaces
1375 * Creates an array of surfaces. The optional list of attributes shall
1376 * be constructed based on what the underlying hardware could expose
1377 * through vaQuerySurfaceAttributes().
1379 * @param[in] dpy the VA display
1380 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1381 * @param[in] width the surface width
1382 * @param[in] height the surface height
1383 * @param[out] surfaces the array of newly created surfaces
1384 * @param[in] num_surfaces the number of surfaces to create
1385 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1386 * @param[in] num_attribs the number of attributes supplied in
1387 * \c attrib_list, or zero
1392 unsigned int format,
1394 unsigned int height,
1395 VASurfaceID *surfaces,
1396 unsigned int num_surfaces,
1397 VASurfaceAttrib *attrib_list,
1398 unsigned int num_attribs
1402 * vaDestroySurfaces - Destroy resources associated with surfaces.
1403 * Surfaces can only be destroyed after all contexts using these surfaces have been
1406 * surfaces: array of surfaces to destroy
1407 * num_surfaces: number of surfaces in the array to be destroyed.
1409 VAStatus vaDestroySurfaces (
1411 VASurfaceID *surfaces,
1415 #define VA_PROGRESSIVE 0x1
1417 * vaCreateContext - Create a context
1419 * config_id: configuration for the context
1420 * picture_width: coded picture width
1421 * picture_height: coded picture height
1422 * flag: any combination of the following:
1423 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1424 * render_targets: a hint for render targets (surfaces) tied to the context
1425 * num_render_targets: number of render targets in the above array
1426 * context: created context id upon return
1428 VAStatus vaCreateContext (
1430 VAConfigID config_id,
1434 VASurfaceID *render_targets,
1435 int num_render_targets,
1436 VAContextID *context /* out */
1440 * vaDestroyContext - Destroy a context
1442 * context: context to be destroyed
1444 VAStatus vaDestroyContext (
1449 //Multi-frame context
1450 typedef VAGenericID VAMFContextID;
1452 * vaCreateMFContext - Create a multi-frame context
1453 * interface encapsulating common for all streams memory objects and structures
1454 * required for single GPU task submission from several VAContextID's.
1455 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1456 * Support identification: Application can identify multi-frame feature support by ability
1457 * to create multi-frame context. If driver supports multi-frame - call successful,
1458 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1459 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1461 * VA_STATUS_SUCCESS - operation successful.
1462 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1463 * dpy: display adapter.
1464 * mf_context: Multi-Frame context encapsulating all associated context
1465 * for multi-frame submission.
1467 VAStatus vaCreateMFContext (
1469 VAMFContextID *mf_context /* out */
1473 * vaMFAddContext - Provide ability to associate each context used for
1474 * Multi-Frame submission and common Multi-Frame context.
1475 * Try to add context to understand if it is supported.
1476 * Allocation: this call allocates and/or reallocates all memory objects
1477 * common for all contexts associated with particular Multi-Frame context.
1478 * All memory required for each context(pixel buffers, internal driver
1479 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1480 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1481 * first context added will set entry point/profile for whole Multi-Frame context,
1482 * all other entry points and profiles can be rejected to be added.
1484 * VA_STATUS_SUCCESS - operation successful, context was added.
1485 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1486 * current mf_context and associated contexts and start working with new ones.
1487 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1488 * 1 - mf_context is not valid context or
1489 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1490 * and current context contradicts with previously added, application can continue with current mf_context
1491 * and other contexts passed this call, rejected context can continue work in stand-alone
1492 * mode or other mf_context.
1493 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1494 * unsupported VAEntrypoint. Application can continue with current mf_context
1495 * and other contexts passed this call, rejected context can continue work in stand-alone
1497 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1498 * but VAProfile is not supported. Application can continue with current mf_context
1499 * and other contexts passed this call, rejected context can continue work in stand-alone
1501 * dpy: display adapter.
1502 * context: context being associated with Multi-Frame context.
1503 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1505 VAStatus vaMFAddContext (
1507 VAMFContextID mf_context,
1512 * vaMFReleaseContext - Removes context from multi-frame and
1513 * association with multi-frame context.
1514 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1516 * VA_STATUS_SUCCESS - operation successful, context was removed.
1517 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1518 * application need to destroy this VAMFContextID and all assotiated VAContextID
1520 * mf_context: VAMFContextID where context is added
1521 * context: VAContextID to be added
1523 VAStatus vaMFReleaseContext (
1525 VAMFContextID mf_context,
1531 * Buffers are used to pass various types of data from the
1532 * client to the server. The server maintains a data store
1533 * for each buffer created, and the client idenfies a buffer
1534 * through a unique buffer id assigned by the server.
1537 typedef VAGenericID VABufferID;
1541 VAPictureParameterBufferType = 0,
1542 VAIQMatrixBufferType = 1,
1543 VABitPlaneBufferType = 2,
1544 VASliceGroupMapBufferType = 3,
1545 VASliceParameterBufferType = 4,
1546 VASliceDataBufferType = 5,
1547 VAMacroblockParameterBufferType = 6,
1548 VAResidualDataBufferType = 7,
1549 VADeblockingParameterBufferType = 8,
1550 VAImageBufferType = 9,
1551 VAProtectedSliceDataBufferType = 10,
1552 VAQMatrixBufferType = 11,
1553 VAHuffmanTableBufferType = 12,
1554 VAProbabilityBufferType = 13,
1556 /* Following are encode buffer types */
1557 VAEncCodedBufferType = 21,
1558 VAEncSequenceParameterBufferType = 22,
1559 VAEncPictureParameterBufferType = 23,
1560 VAEncSliceParameterBufferType = 24,
1561 VAEncPackedHeaderParameterBufferType = 25,
1562 VAEncPackedHeaderDataBufferType = 26,
1563 VAEncMiscParameterBufferType = 27,
1564 VAEncMacroblockParameterBufferType = 28,
1565 VAEncMacroblockMapBufferType = 29,
1568 * \brief Encoding QP buffer
1570 * This buffer contains QP per MB for encoding. Currently
1571 * VAEncQPBufferH264 is defined for H.264 encoding, see
1572 * #VAEncQPBufferH264 for details
1574 VAEncQPBufferType = 30,
1575 /* Following are video processing buffer types */
1577 * \brief Video processing pipeline parameter buffer.
1579 * This buffer describes the video processing pipeline. See
1580 * #VAProcPipelineParameterBuffer for details.
1582 VAProcPipelineParameterBufferType = 41,
1584 * \brief Video filter parameter buffer.
1586 * This buffer describes the video filter parameters. All buffers
1587 * inherit from #VAProcFilterParameterBufferBase, thus including
1588 * a unique filter buffer type.
1590 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1591 * Filters requiring advanced parameters include, but are not limited to,
1592 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1593 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1595 VAProcFilterParameterBufferType = 42,
1597 * \brief FEI specific buffer types
1599 VAEncFEIMVBufferType = 43,
1600 VAEncFEIMBCodeBufferType = 44,
1601 VAEncFEIDistortionBufferType = 45,
1602 VAEncFEIMBControlBufferType = 46,
1603 VAEncFEIMVPredictorBufferType = 47,
1604 VAStatsStatisticsParameterBufferType = 48,
1605 /** \brief Statistics output for VAEntrypointStats progressive and top field of interlaced case*/
1606 VAStatsStatisticsBufferType = 49,
1607 /** \brief Statistics output for VAEntrypointStats bottom field of interlaced case*/
1608 VAStatsStatisticsBottomFieldBufferType = 50,
1609 VAStatsMVBufferType = 51,
1610 VAStatsMVPredictorBufferType = 52,
1611 /** Force MB's to be non skip for encode.it's per-mb control buffer, The width of the MB map
1612 * Surface is (width of the Picture in MB unit) * 1 byte, multiple of 64 bytes.
1613 * The height is (height of the picture in MB unit). The picture is either
1614 * frame or non-interleaved top or bottom field. If the application provides this
1615 *surface, it will override the "skipCheckDisable" setting in VAEncMiscParameterEncQuality.
1617 VAEncMacroblockDisableSkipMapBufferType = 53,
1619 * \brief HEVC FEI CTB level cmd buffer
1620 * it is CTB level information for future usage.
1622 VAEncFEICTBCmdBufferType = 54,
1624 * \brief HEVC FEI CU level data buffer
1625 * it's CTB level information for future usage
1627 VAEncFEICURecordBufferType = 55,
1628 /** decode stream out buffer, intermedia data of decode, it may include MV, MB mode etc.
1629 * it can be used to detect motion and analyze the frame contain */
1630 VADecodeStreamoutBufferType = 56,
1635 * Processing rate parameter for encode.
1637 typedef struct _VAProcessingRateParameterEnc {
1638 /** \brief Profile level */
1640 uint8_t reserved[3];
1641 /** \brief quality level. When set to 0, default quality
1644 uint32_t quality_level;
1645 /** \brief Period between I frames. */
1646 uint32_t intra_period;
1647 /** \brief Period between I/P frames. */
1649 } VAProcessingRateParameterEnc;
1652 * Processing rate parameter for decode.
1654 typedef struct _VAProcessingRateParameterDec {
1655 /** \brief Profile level */
1657 uint8_t reserved0[3];
1659 } VAProcessingRateParameterDec;
1661 typedef struct _VAProcessingRateParameter {
1663 VAProcessingRateParameterEnc proc_buf_enc;
1664 VAProcessingRateParameterDec proc_buf_dec;
1666 } VAProcessingRateParameter;
1669 * \brief Queries processing rate for the supplied config.
1671 * This function queries the processing rate based on parameters in
1672 * \c proc_buf for the given \c config. Upon successful return, the processing
1673 * rate value will be stored in \c processing_rate. Processing rate is
1674 * specified as the number of macroblocks/CTU per second.
1676 * If NULL is passed to the \c proc_buf, the default processing rate for the
1677 * given configuration will be returned.
1679 * @param[in] dpy the VA display
1680 * @param[in] config the config identifying a codec or a video
1681 * processing pipeline
1682 * @param[in] proc_buf the buffer that contains the parameters for
1683 either the encode or decode processing rate
1684 * @param[out] processing_rate processing rate in number of macroblocks per
1685 second constrained by parameters specified in proc_buf
1689 vaQueryProcessingRate(
1692 VAProcessingRateParameter *proc_buf,
1693 unsigned int *processing_rate
1698 VAEncMiscParameterTypeFrameRate = 0,
1699 VAEncMiscParameterTypeRateControl = 1,
1700 VAEncMiscParameterTypeMaxSliceSize = 2,
1701 VAEncMiscParameterTypeAIR = 3,
1702 /** \brief Buffer type used to express a maximum frame size (in bits). */
1703 VAEncMiscParameterTypeMaxFrameSize = 4,
1704 /** \brief Buffer type used for HRD parameters. */
1705 VAEncMiscParameterTypeHRD = 5,
1706 VAEncMiscParameterTypeQualityLevel = 6,
1707 /** \brief Buffer type used for Rolling intra refresh */
1708 VAEncMiscParameterTypeRIR = 7,
1709 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1710 VAEncMiscParameterTypeQuantization = 8,
1711 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1712 * rate control, when the user has externally skipped frames. */
1713 VAEncMiscParameterTypeSkipFrame = 9,
1714 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1715 VAEncMiscParameterTypeROI = 10,
1716 /** \brief Buffer type used for temporal layer structure */
1717 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1718 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1719 VAEncMiscParameterTypeDirtyRect = 13,
1720 /** \brief Buffer type used for parallel BRC parameters. */
1721 VAEncMiscParameterTypeParallelBRC = 14,
1722 /** \brief Set MB partion mode mask and Half-pel/Quant-pel motion search */
1723 VAEncMiscParameterTypeSubMbPartPel = 15,
1724 /** \brief set encode quality tuning */
1725 VAEncMiscParameterTypeEncQuality = 16,
1726 /** \brief Buffer type used for encoder rounding offset parameters. */
1727 VAEncMiscParameterTypeCustomRoundingControl = 17,
1728 /** \brief Buffer type used for FEI input frame level parameters */
1729 VAEncMiscParameterTypeFEIFrameControl = 18,
1730 /** \brief encode extension buffer, ect. MPEG2 Sequence extenstion data */
1731 VAEncMiscParameterTypeExtensionData = 19
1732 } VAEncMiscParameterType;
1734 /** \brief Packed header type. */
1736 /** \brief Packed sequence header. */
1737 VAEncPackedHeaderSequence = 1,
1738 /** \brief Packed picture header. */
1739 VAEncPackedHeaderPicture = 2,
1740 /** \brief Packed slice header. */
1741 VAEncPackedHeaderSlice = 3,
1743 * \brief Packed raw header.
1745 * Packed raw data header can be used by the client to insert a header
1746 * into the bitstream data buffer at the point it is passed, the driver
1747 * will handle the raw packed header based on "has_emulation_bytes" field
1748 * in the packed header parameter structure.
1750 VAEncPackedHeaderRawData = 4,
1752 * \brief Misc packed header. See codec-specific definitions.
1755 * This is a deprecated packed header type. All applications can use
1756 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1758 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1759 } VAEncPackedHeaderType;
1761 /** \brief Packed header parameter. */
1762 typedef struct _VAEncPackedHeaderParameterBuffer {
1763 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1765 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1766 uint32_t bit_length;
1767 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1768 uint8_t has_emulation_bytes;
1770 /** \brief Reserved bytes for future use, must be zero */
1771 uint32_t va_reserved[VA_PADDING_LOW];
1772 } VAEncPackedHeaderParameterBuffer;
1775 * For application, e.g. set a new bitrate
1776 * VABufferID buf_id;
1777 * VAEncMiscParameterBuffer *misc_param;
1778 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1780 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1781 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1782 * 1, NULL, &buf_id);
1784 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1785 * misc_param->type = VAEncMiscParameterTypeRateControl;
1786 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1787 * misc_rate_ctrl->bits_per_second = 6400000;
1788 * vaUnmapBuffer(dpy, buf_id);
1789 * vaRenderPicture(dpy, context, &buf_id, 1);
1791 typedef struct _VAEncMiscParameterBuffer
1793 VAEncMiscParameterType type;
1795 } VAEncMiscParameterBuffer;
1797 /** \brief Temporal layer Structure*/
1798 typedef struct _VAEncMiscParameterTemporalLayerStructure
1800 /** \brief The number of temporal layers */
1801 uint32_t number_of_layers;
1802 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1803 uint32_t periodicity;
1805 * \brief The array indicating the layer id for each frame
1807 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1808 * ids for frames starting from the 2nd frame.
1810 uint32_t layer_id[32];
1812 /** \brief Reserved bytes for future use, must be zero */
1813 uint32_t va_reserved[VA_PADDING_LOW];
1814 } VAEncMiscParameterTemporalLayerStructure;
1817 /** \brief Rate control parameters */
1818 typedef struct _VAEncMiscParameterRateControl
1820 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1821 uint32_t bits_per_second;
1822 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1823 * bit-rate for example if target_percentage is 95 then the rate control will target
1824 * a bit-rate that is 95% of the maximum bit-rate
1826 uint32_t target_percentage;
1827 /* windows size in milliseconds. For example if this is set to 500,
1828 * then the rate control will guarantee the target bit-rate over a 500 ms window
1830 uint32_t window_size;
1831 /* initial QP at I frames */
1832 uint32_t initial_qp;
1834 uint32_t basic_unit_size;
1840 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1841 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1842 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1844 * The temporal layer that the rate control parameters are specified for.
1846 uint32_t temporal_id : 8;
1847 uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1848 uint32_t enable_parallel_brc : 1;
1849 uint32_t enable_dynamic_scaling : 1;
1850 /** \brief Frame Tolerance Mode
1851 * Indicates the tolerance the application has to variations in the frame size.
1852 * For example, wireless display scenarios may require very steady bit rate to
1853 * reduce buffering time. It affects the rate control algorithm used,
1854 * but may or may not have an effect based on the combination of other BRC
1855 * parameters. Only valid when the driver reports support for
1856 * #VAConfigAttribFrameSizeToleranceSupport.
1858 * equals 0 -- normal mode;
1859 * equals 1 -- maps to sliding window;
1860 * equals 2 -- maps to low delay mode;
1863 uint32_t frame_tolerance_mode : 2;
1864 uint32_t reserved : 12;
1868 uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1869 /** \brief Reserved bytes for future use, must be zero */
1871 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1872 } VAEncMiscParameterRateControl;
1874 typedef struct _VAEncMiscParameterFrameRate
1877 * The framerate is specified as a number of frames per second, as a
1878 * fraction. The denominator of the fraction is given in the top half
1879 * (the high two bytes) of the framerate field, and the numerator is
1880 * given in the bottom half (the low two bytes).
1883 * denominator = framerate >> 16 & 0xffff;
1884 * numerator = framerate & 0xffff;
1885 * fps = numerator / denominator;
1887 * For example, if framerate is set to (100 << 16 | 750), this is
1888 * 750 / 100, hence 7.5fps.
1890 * If the denominator is zero (the high two bytes are both zero) then
1891 * it takes the value one instead, so the framerate is just the integer
1892 * in the low 2 bytes.
1900 * The temporal id the framerate parameters are specified for.
1902 uint32_t temporal_id : 8;
1903 uint32_t reserved : 24;
1908 /** \brief Reserved bytes for future use, must be zero */
1909 uint32_t va_reserved[VA_PADDING_LOW];
1910 } VAEncMiscParameterFrameRate;
1913 * Allow a maximum slice size to be specified (in bits).
1914 * The encoder will attempt to make sure that individual slices do not exceed this size
1915 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1917 typedef struct _VAEncMiscParameterMaxSliceSize
1919 uint32_t max_slice_size;
1921 /** \brief Reserved bytes for future use, must be zero */
1922 uint32_t va_reserved[VA_PADDING_LOW];
1923 } VAEncMiscParameterMaxSliceSize;
1925 typedef struct _VAEncMiscParameterAIR
1927 uint32_t air_num_mbs;
1928 uint32_t air_threshold;
1929 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1931 /** \brief Reserved bytes for future use, must be zero */
1932 uint32_t va_reserved[VA_PADDING_LOW];
1933 } VAEncMiscParameterAIR;
1936 * \brief Rolling intra refresh data structure for encoding.
1938 typedef struct _VAEncMiscParameterRIR
1944 * \brief Indicate if intra refresh is enabled in column/row.
1946 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1947 * by the driver before sending this structure.
1950 /* \brief enable RIR in column */
1951 uint32_t enable_rir_column : 1;
1952 /* \brief enable RIR in row */
1953 uint32_t enable_rir_row : 1;
1954 uint32_t reserved : 30;
1959 * \brief Indicates the column or row location in MB. It is ignored if
1962 uint16_t intra_insertion_location;
1964 * \brief Indicates the number of columns or rows in MB. It is ignored if
1967 uint16_t intra_insert_size;
1969 * \brief indicates the Qp difference for inserted intra columns or rows.
1970 * App can use this to adjust intra Qp based on bitrate & max frame size.
1972 uint8_t qp_delta_for_inserted_intra;
1973 /** \brief Reserved bytes for future use, must be zero */
1974 uint32_t va_reserved[VA_PADDING_LOW];
1975 } VAEncMiscParameterRIR;
1977 typedef struct _VAEncMiscParameterHRD
1979 uint32_t initial_buffer_fullness; /* in bits */
1980 uint32_t buffer_size; /* in bits */
1982 /** \brief Reserved bytes for future use, must be zero */
1983 uint32_t va_reserved[VA_PADDING_LOW];
1984 } VAEncMiscParameterHRD;
1987 * \brief Defines a maximum frame size (in bits).
1989 * This misc parameter buffer defines the maximum size of a frame (in
1990 * bits). The encoder will try to make sure that each frame does not
1991 * exceed this size. Otherwise, if the frame size exceeds this size,
1992 * the \c status flag of #VACodedBufferSegment will contain
1993 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1995 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1996 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1997 VAEncMiscParameterType type;
1998 /** \brief Maximum size of a frame (in bits). */
1999 uint32_t max_frame_size;
2001 /** \brief Reserved bytes for future use, must be zero */
2002 uint32_t va_reserved[VA_PADDING_LOW];
2003 } VAEncMiscParameterBufferMaxFrameSize;
2006 * \brief Encoding quality level.
2008 * The encoding quality could be set through this structure, if the implementation
2009 * supports multiple quality levels. The quality level set through this structure is
2010 * persistent over the entire coded sequence, or until a new structure is being sent.
2011 * The quality level range can be queried through the VAConfigAttribEncQualityRange
2012 * attribute. A lower value means higher quality, and a value of 1 represents the highest
2013 * quality. The quality level setting is used as a trade-off between quality and speed/power
2014 * consumption, with higher quality corresponds to lower speed and higher power consumption.
2016 typedef struct _VAEncMiscParameterBufferQualityLevel {
2017 /** \brief Encoding quality level setting. When set to 0, default quality
2020 uint32_t quality_level;
2022 /** \brief Reserved bytes for future use, must be zero */
2023 uint32_t va_reserved[VA_PADDING_LOW];
2024 } VAEncMiscParameterBufferQualityLevel;
2027 * \brief Quantization settings for encoding.
2029 * Some encoders support special types of quantization such as trellis, and this structure
2030 * can be used by the app to control these special types of quantization by the encoder.
2032 typedef struct _VAEncMiscParameterQuantization
2036 /* if no flags is set then quantization is determined by the driver */
2039 /* \brief disable trellis for all frames/fields */
2040 uint64_t disable_trellis : 1;
2041 /* \brief enable trellis for I frames/fields */
2042 uint64_t enable_trellis_I : 1;
2043 /* \brief enable trellis for P frames/fields */
2044 uint64_t enable_trellis_P : 1;
2045 /* \brief enable trellis for B frames/fields */
2046 uint64_t enable_trellis_B : 1;
2047 uint64_t reserved : 28;
2050 } quantization_flags;
2051 } VAEncMiscParameterQuantization;
2054 * \brief Encoding skip frame.
2056 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
2057 * code as all skip's). For rate control purposes the encoder will need to know the size and number
2058 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
2059 * current frame. It is allowed for the application to still send in packed headers for the driver to
2060 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
2062 typedef struct _VAEncMiscParameterSkipFrame {
2063 /** \brief Indicates skip frames as below.
2064 * 0: Encode as normal, no skip.
2065 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
2066 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
2067 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
2068 * in VAEncPackedHeaderPicture). */
2069 uint8_t skip_frame_flag;
2070 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
2071 uint8_t num_skip_frames;
2072 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
2073 * the size of the current skipped frame that is to be packed/encrypted in bits. */
2074 uint32_t size_skip_frames;
2076 /** \brief Reserved bytes for future use, must be zero */
2077 uint32_t va_reserved[VA_PADDING_LOW];
2078 } VAEncMiscParameterSkipFrame;
2081 * \brief Encoding region-of-interest (ROI).
2083 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
2084 * supports ROI input. The ROI set through this structure is applicable only to the
2085 * current frame or field, so must be sent every frame or field to be applied. The number of
2086 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
2087 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
2089 typedef struct _VAEncROI
2091 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
2092 * codec coding units. It is relative to frame coordinates for the frame case and
2093 * to field coordinates for the field case. */
2094 VARectangle roi_rectangle;
2098 * \ref roi_value specifies ROI delta QP or ROI priority.
2099 * -- ROI delta QP is the value that will be added on top of the frame level QP.
2100 * -- ROI priority specifies the priority of a region, it can be positive (more important)
2101 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2102 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2103 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2104 * regions, the roi_value that is first in the ROI array will have priority.
2106 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2107 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2109 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2110 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2111 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2116 typedef struct _VAEncMiscParameterBufferROI {
2117 /** \brief Number of ROIs being sent.*/
2120 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2121 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
2123 int8_t max_delta_qp;
2124 int8_t min_delta_qp;
2126 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
2127 * coordinates for the frame case and to field coordinates for the field case.*/
2132 * \brief An indication for roi value.
2134 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2135 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2136 * in #VAEncROI should be used as ROI priority.
2138 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2139 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2140 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2141 * when VAConfigAttribRateControl == VA_RC_CQP.
2143 uint32_t roi_value_is_qp_delta : 1;
2144 uint32_t reserved : 31;
2149 /** \brief Reserved bytes for future use, must be zero */
2150 uint32_t va_reserved[VA_PADDING_LOW];
2151 } VAEncMiscParameterBufferROI;
2153 * \brief Dirty rectangle data structure for encoding.
2155 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2156 * implementation supports dirty rect input. The rect set through this structure is applicable
2157 * only to the current frame or field, so must be sent every frame or field to be applied.
2158 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
2159 * encoder will use the rect information to know those rectangle areas have changed while the
2160 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2161 * previous picture. The encoder may do some internal optimizations.
2163 typedef struct _VAEncMiscParameterBufferDirtyRect
2165 /** \brief Number of Rectangle being sent.*/
2166 uint32_t num_roi_rectangle;
2168 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2169 VARectangle *roi_rectangle;
2170 } VAEncMiscParameterBufferDirtyRect;
2172 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2173 typedef struct _VAEncMiscParameterParallelRateControl {
2174 /** brief Number of layers*/
2175 uint32_t num_layers;
2176 /** brief Number of B frames per layer per GOP.
2178 * it should be allocated by application, and the is num_layers.
2179 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2180 uint32_t *num_b_in_gop;
2181 } VAEncMiscParameterParallelRateControl;
2183 /** per frame encoder quality controls, once set they will persist for all future frames
2184 *till it is updated again. */
2185 typedef struct _VAEncMiscParameterEncQuality
2191 /** Use raw frames for reference instead of reconstructed frames.
2192 * it only impact motion estimation (ME) stage, and will not impact MC stage
2193 * so the reconstruct picture will can match with decode side */
2194 uint32_t useRawPicForRef : 1;
2195 /** Disables skip check for ME stage, it will increase the bistream size
2196 * but will improve the qulity */
2197 uint32_t skipCheckDisable : 1;
2198 /** Indicates app will override default driver FTQ settings using FTQEnable.
2199 * FTQ is forward transform quantization */
2200 uint32_t FTQOverride : 1;
2201 /** Enables/disables FTQ. */
2202 uint32_t FTQEnable : 1;
2203 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2204 * enabled (FTQSkipThresholdLUT), else default driver thresholds will be used. */
2205 uint32_t FTQSkipThresholdLUTInput : 1;
2206 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2207 * disabled (NonFTQSkipThresholdLUT), else default driver thresholds will be used. */
2208 uint32_t NonFTQSkipThresholdLUTInput : 1;
2209 uint32_t ReservedBit : 1;
2210 /** Control to enable the ME mode decision algorithm to bias to fewer B Direct/Skip types.
2211 * Applies only to B frames, all other frames will ignore this setting. */
2212 uint32_t directBiasAdjustmentEnable : 1;
2213 /** Enables global motion bias. global motion also is called HME (Heirarchical Motion Estimation )
2214 * HME is used to handle large motions and avoiding local minima in the video encoding process
2215 * down scaled the input and reference picture, then do ME. the result will be a predictor to next level HME or ME
2216 * current interface divide the HME to 3 level. UltraHME , SuperHME, and HME, result of UltraHME will be input of SurperHME,
2217 * result of superHME will be a input for HME. HME result will be input of ME. it is a switch for HMEMVCostScalingFactor
2218 * can change the HME bias inside RDO stage*/
2219 uint32_t globalMotionBiasAdjustmentEnable : 1;
2220 /** MV cost scaling ratio for HME ( predictors. It is used when
2221 * globalMotionBiasAdjustmentEnable == 1, else it is ignored. Values are:
2222 * 0: set MV cost to be 0 for HME predictor.
2223 * 1: scale MV cost to be 1/2 of the default value for HME predictor.
2224 * 2: scale MV cost to be 1/4 of the default value for HME predictor.
2225 * 3: scale MV cost to be 1/8 of the default value for HME predictor. */
2226 uint32_t HMEMVCostScalingFactor : 2;
2227 /**disable HME, if it is disabled. Super*ultraHME should also be disabled */
2228 uint32_t HMEDisable : 1;
2229 /**disable Super HME, if it is disabled, ultraHME should be disabled */
2230 uint32_t SuperHMEDisable : 1;
2231 /** disable Ultra HME */
2232 uint32_t UltraHMEDisable : 1;
2233 /** disable panic mode. Panic mode happened when there are extreme BRC (bit rate control) requirement
2234 * frame size cant achieve the target of BRC. when Panic mode is triggered, Coefficients will
2235 * be set to zero. disable panic mode will improve quality but will impact BRC */
2236 uint32_t PanicModeDisable : 1;
2237 /** Force RepartitionCheck
2238 * 0: DEFAULT - follow driver default settings.
2239 * 1: FORCE_ENABLE - enable this feature totally for all cases.
2240 * 2: FORCE_DISABLE - disable this feature totally for all cases. */
2241 uint32_t ForceRepartitionCheck : 2;
2244 uint32_t encControls;
2247 /** Maps QP to skip thresholds when FTQ is enabled. Valid range is 0-255. */
2248 uint8_t FTQSkipThresholdLUT[52];
2249 /** Maps QP to skip thresholds when FTQ is disabled. Valid range is 0-65535. */
2250 uint16_t NonFTQSkipThresholdLUT[52];
2252 uint32_t reserved[VA_PADDING_HIGH]; // Reserved for future use.
2254 } VAEncMiscParameterEncQuality;
2257 * \brief Custom Encoder Rounding Offset Control.
2258 * Application may use this structure to set customized rounding
2259 * offset parameters for quantization.
2260 * Valid when \c VAConfigAttribCustomRoundingControl equals 1.
2262 typedef struct _VAEncMiscParameterCustomRoundingControl
2266 /** \brief Enable customized rounding offset for intra blocks.
2267 * If 0, default value would be taken by driver for intra
2270 uint32_t enable_custom_rouding_intra : 1 ;
2272 /** \brief Intra rounding offset
2273 * Ignored if \c enable_custom_rouding_intra equals 0.
2275 uint32_t rounding_offset_intra : 7;
2277 /** \brief Enable customized rounding offset for inter blocks.
2278 * If 0, default value would be taken by driver for inter
2281 uint32_t enable_custom_rounding_inter : 1 ;
2283 /** \brief Inter rounding offset
2284 * Ignored if \c enable_custom_rouding_inter equals 0.
2286 uint32_t rounding_offset_inter : 7;
2289 uint32_t reserved :16;
2292 } rounding_offset_setting;
2293 } VAEncMiscParameterCustomRoundingControl;
2295 * There will be cases where the bitstream buffer will not have enough room to hold
2296 * the data for the entire slice, and the following flags will be used in the slice
2297 * parameter to signal to the server for the possible cases.
2298 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2299 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2300 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2302 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2303 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2304 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2305 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2307 /* Codec-independent Slice Parameter Buffer base */
2308 typedef struct _VASliceParameterBufferBase
2310 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2311 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2312 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2313 } VASliceParameterBufferBase;
2315 /**********************************
2316 * JPEG common data structures
2317 **********************************/
2319 * \brief Huffman table for JPEG decoding.
2321 * This structure holds the complete Huffman tables. This is an
2322 * aggregation of all Huffman table (DHT) segments maintained by the
2323 * application. i.e. up to 2 Huffman tables are stored in there for
2326 * The #load_huffman_table array can be used as a hint to notify the
2327 * VA driver implementation about which table(s) actually changed
2328 * since the last submission of this buffer.
2330 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2331 /** \brief Specifies which #huffman_table is valid. */
2332 uint8_t load_huffman_table[2];
2333 /** \brief Huffman tables indexed by table identifier (Th). */
2335 /** @name DC table (up to 12 categories) */
2337 /** \brief Number of Huffman codes of length i + 1 (Li). */
2338 uint8_t num_dc_codes[16];
2339 /** \brief Value associated with each Huffman code (Vij). */
2340 uint8_t dc_values[12];
2342 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2344 /** \brief Number of Huffman codes of length i + 1 (Li). */
2345 uint8_t num_ac_codes[16];
2346 /** \brief Value associated with each Huffman code (Vij). */
2347 uint8_t ac_values[162];
2348 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2353 /** \brief Reserved bytes for future use, must be zero */
2354 uint32_t va_reserved[VA_PADDING_LOW];
2355 } VAHuffmanTableBufferJPEGBaseline;
2357 /****************************
2358 * MPEG-2 data structures
2359 ****************************/
2361 /* MPEG-2 Picture Parameter Buffer */
2363 * For each frame or field, and before any slice data, a single
2364 * picture parameter buffer must be send.
2366 typedef struct _VAPictureParameterBufferMPEG2
2368 uint16_t horizontal_size;
2369 uint16_t vertical_size;
2370 VASurfaceID forward_reference_picture;
2371 VASurfaceID backward_reference_picture;
2372 /* meanings of the following fields are the same as in the standard */
2373 int32_t picture_coding_type;
2374 int32_t f_code; /* pack all four fcode into this */
2377 uint32_t intra_dc_precision : 2;
2378 uint32_t picture_structure : 2;
2379 uint32_t top_field_first : 1;
2380 uint32_t frame_pred_frame_dct : 1;
2381 uint32_t concealment_motion_vectors : 1;
2382 uint32_t q_scale_type : 1;
2383 uint32_t intra_vlc_format : 1;
2384 uint32_t alternate_scan : 1;
2385 uint32_t repeat_first_field : 1;
2386 uint32_t progressive_frame : 1;
2387 uint32_t is_first_field : 1; /* indicate whether the current field
2388 * is the first field for field picture
2392 } picture_coding_extension;
2394 /** \brief Reserved bytes for future use, must be zero */
2395 uint32_t va_reserved[VA_PADDING_LOW];
2396 } VAPictureParameterBufferMPEG2;
2398 /** MPEG-2 Inverse Quantization Matrix Buffer */
2399 typedef struct _VAIQMatrixBufferMPEG2
2401 /** \brief Same as the MPEG-2 bitstream syntax element. */
2402 int32_t load_intra_quantiser_matrix;
2403 /** \brief Same as the MPEG-2 bitstream syntax element. */
2404 int32_t load_non_intra_quantiser_matrix;
2405 /** \brief Same as the MPEG-2 bitstream syntax element. */
2406 int32_t load_chroma_intra_quantiser_matrix;
2407 /** \brief Same as the MPEG-2 bitstream syntax element. */
2408 int32_t load_chroma_non_intra_quantiser_matrix;
2409 /** \brief Luminance intra matrix, in zig-zag scan order. */
2410 uint8_t intra_quantiser_matrix[64];
2411 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2412 uint8_t non_intra_quantiser_matrix[64];
2413 /** \brief Chroma intra matrix, in zig-zag scan order. */
2414 uint8_t chroma_intra_quantiser_matrix[64];
2415 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2416 uint8_t chroma_non_intra_quantiser_matrix[64];
2418 /** \brief Reserved bytes for future use, must be zero */
2419 uint32_t va_reserved[VA_PADDING_LOW];
2420 } VAIQMatrixBufferMPEG2;
2422 /** MPEG-2 Slice Parameter Buffer */
2423 typedef struct _VASliceParameterBufferMPEG2
2425 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2426 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2427 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2428 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2429 uint32_t slice_horizontal_position;
2430 uint32_t slice_vertical_position;
2431 int32_t quantiser_scale_code;
2432 int32_t intra_slice_flag;
2434 /** \brief Reserved bytes for future use, must be zero */
2435 uint32_t va_reserved[VA_PADDING_LOW];
2436 } VASliceParameterBufferMPEG2;
2438 /** MPEG-2 Macroblock Parameter Buffer */
2439 typedef struct _VAMacroblockParameterBufferMPEG2
2441 uint16_t macroblock_address;
2443 * macroblock_address (in raster scan order)
2445 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2447 uint8_t macroblock_type; /* see definition below */
2450 uint32_t frame_motion_type : 2;
2451 uint32_t field_motion_type : 2;
2452 uint32_t dct_type : 1;
2456 uint8_t motion_vertical_field_select;
2458 * motion_vertical_field_select:
2459 * see section 6.3.17.2 in the spec
2460 * only the lower 4 bits are used
2461 * bit 0: first vector forward
2462 * bit 1: first vector backward
2463 * bit 2: second vector forward
2464 * bit 3: second vector backward
2466 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2467 uint16_t coded_block_pattern;
2469 * The bitplanes for coded_block_pattern are described
2470 * in Figure 6.10-12 in the spec
2473 /* Number of skipped macroblocks after this macroblock */
2474 uint16_t num_skipped_macroblocks;
2476 /** \brief Reserved bytes for future use, must be zero */
2477 uint32_t va_reserved[VA_PADDING_LOW];
2478 } VAMacroblockParameterBufferMPEG2;
2481 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2483 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2484 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2485 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2486 #define VA_MB_TYPE_MOTION_INTRA 0x10
2489 * MPEG-2 Residual Data Buffer
2490 * For each macroblock, there wil be 64 shorts (16-bit) in the
2491 * residual data buffer
2494 /****************************
2495 * MPEG-4 Part 2 data structures
2496 ****************************/
2498 /* MPEG-4 Picture Parameter Buffer */
2500 * For each frame or field, and before any slice data, a single
2501 * picture parameter buffer must be send.
2503 typedef struct _VAPictureParameterBufferMPEG4
2506 uint16_t vop_height;
2507 VASurfaceID forward_reference_picture;
2508 VASurfaceID backward_reference_picture;
2511 uint32_t short_video_header : 1;
2512 uint32_t chroma_format : 2;
2513 uint32_t interlaced : 1;
2514 uint32_t obmc_disable : 1;
2515 uint32_t sprite_enable : 2;
2516 uint32_t sprite_warping_accuracy : 2;
2517 uint32_t quant_type : 1;
2518 uint32_t quarter_sample : 1;
2519 uint32_t data_partitioned : 1;
2520 uint32_t reversible_vlc : 1;
2521 uint32_t resync_marker_disable : 1;
2525 uint8_t no_of_sprite_warping_points;
2526 int16_t sprite_trajectory_du[3];
2527 int16_t sprite_trajectory_dv[3];
2528 uint8_t quant_precision;
2531 uint32_t vop_coding_type : 2;
2532 uint32_t backward_reference_vop_coding_type : 2;
2533 uint32_t vop_rounding_type : 1;
2534 uint32_t intra_dc_vlc_thr : 3;
2535 uint32_t top_field_first : 1;
2536 uint32_t alternate_vertical_scan_flag : 1;
2540 uint8_t vop_fcode_forward;
2541 uint8_t vop_fcode_backward;
2542 uint16_t vop_time_increment_resolution;
2543 /* short header related */
2544 uint8_t num_gobs_in_vop;
2545 uint8_t num_macroblocks_in_gob;
2546 /* for direct mode prediction */
2550 /** \brief Reserved bytes for future use, must be zero */
2551 uint32_t va_reserved[VA_PADDING_LOW];
2552 } VAPictureParameterBufferMPEG4;
2554 /** MPEG-4 Inverse Quantization Matrix Buffer */
2555 typedef struct _VAIQMatrixBufferMPEG4
2557 /** Same as the MPEG-4:2 bitstream syntax element. */
2558 int32_t load_intra_quant_mat;
2559 /** Same as the MPEG-4:2 bitstream syntax element. */
2560 int32_t load_non_intra_quant_mat;
2561 /** The matrix for intra blocks, in zig-zag scan order. */
2562 uint8_t intra_quant_mat[64];
2563 /** The matrix for non-intra blocks, in zig-zag scan order. */
2564 uint8_t non_intra_quant_mat[64];
2566 /** \brief Reserved bytes for future use, must be zero */
2567 uint32_t va_reserved[VA_PADDING_LOW];
2568 } VAIQMatrixBufferMPEG4;
2570 /** MPEG-4 Slice Parameter Buffer */
2571 typedef struct _VASliceParameterBufferMPEG4
2573 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2574 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2575 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2576 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2577 uint32_t macroblock_number;
2578 int32_t quant_scale;
2580 /** \brief Reserved bytes for future use, must be zero */
2581 uint32_t va_reserved[VA_PADDING_LOW];
2582 } VASliceParameterBufferMPEG4;
2585 VC-1 data structures
2588 typedef enum /* see 7.1.1.32 */
2591 VAMvMode1MvHalfPel = 1,
2592 VAMvMode1MvHalfPelBilinear = 2,
2593 VAMvModeMixedMv = 3,
2594 VAMvModeIntensityCompensation = 4
2597 /** VC-1 Picture Parameter Buffer */
2599 * For each picture, and before any slice data, a picture parameter
2600 * buffer must be send. Multiple picture parameter buffers may be
2601 * sent for a single picture. In that case picture parameters will
2602 * apply to all slice data that follow it until a new picture
2603 * parameter buffer is sent.
2606 * pic_quantizer_type should be set to the applicable quantizer
2607 * type as defined by QUANTIZER (J.1.19) and either
2608 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2610 typedef struct _VAPictureParameterBufferVC1
2612 VASurfaceID forward_reference_picture;
2613 VASurfaceID backward_reference_picture;
2614 /* if out-of-loop post-processing is done on the render
2615 target, then we need to keep the in-loop decoded
2616 picture as a reference picture */
2617 VASurfaceID inloop_decoded_picture;
2619 /* sequence layer for AP or meta data for SP and MP */
2622 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2623 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2624 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2625 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2626 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2627 uint32_t multires : 1; /* METADATA::MULTIRES */
2628 uint32_t overlap : 1; /* METADATA::OVERLAP */
2629 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2630 uint32_t rangered : 1; /* METADATA::RANGERED */
2631 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2632 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2637 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2638 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2641 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2642 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2643 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2644 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2647 } entrypoint_fields;
2648 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2649 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2652 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2653 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2654 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2655 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2658 } range_mapping_fields;
2660 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2661 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2662 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2663 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2664 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2665 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2666 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2667 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2668 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2672 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2673 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2674 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2675 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2676 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2682 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2683 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2684 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2685 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2686 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2687 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2688 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2694 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2695 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2696 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2697 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2698 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2699 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2700 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2703 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2706 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2707 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2708 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2709 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2715 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2716 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2717 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2718 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2719 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2720 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2721 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2722 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2723 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2724 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2730 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2731 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2732 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2733 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2734 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2735 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2736 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2737 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2738 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2739 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2740 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2743 } pic_quantizer_fields;
2746 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2747 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2748 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2749 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2750 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2751 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2756 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2757 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2758 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2760 /** \brief Reserved bytes for future use, must be zero */
2761 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2762 } VAPictureParameterBufferVC1;
2764 /** VC-1 Bitplane Buffer
2765 There will be at most three bitplanes coded in any picture header. To send
2766 the bitplane data more efficiently, each byte is divided in two nibbles, with
2767 each nibble carrying three bitplanes for one macroblock. The following table
2768 shows the bitplane data arrangement within each nibble based on the picture
2771 Picture Type Bit3 Bit2 Bit1 Bit0
2772 I or BI OVERFLAGS ACPRED FIELDTX
2773 P MYTYPEMB SKIPMB DIRECTMB
2774 B FORWARDMB SKIPMB DIRECTMB
2776 Within each byte, the lower nibble is for the first MB and the upper nibble is
2777 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2778 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2779 Macroblock #2 in the first row.
2782 /* VC-1 Slice Parameter Buffer */
2783 typedef struct _VASliceParameterBufferVC1
2785 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2786 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2787 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2788 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2789 uint32_t slice_vertical_position;
2791 /** \brief Reserved bytes for future use, must be zero */
2792 uint32_t va_reserved[VA_PADDING_LOW];
2793 } VASliceParameterBufferVC1;
2795 /* VC-1 Slice Data Buffer */
2797 This is simplely a buffer containing raw bit-stream bytes
2800 /****************************
2801 * H.264/AVC data structures
2802 ****************************/
2804 typedef struct _VAPictureH264
2806 VASurfaceID picture_id;
2809 int32_t TopFieldOrderCnt;
2810 int32_t BottomFieldOrderCnt;
2812 /** \brief Reserved bytes for future use, must be zero */
2813 uint32_t va_reserved[VA_PADDING_LOW];
2815 /* flags in VAPictureH264 could be OR of the following */
2816 #define VA_PICTURE_H264_INVALID 0x00000001
2817 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2818 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2819 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2820 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2822 /** H.264 Picture Parameter Buffer */
2824 * For each picture, and before any slice data, a single
2825 * picture parameter buffer must be send.
2827 typedef struct _VAPictureParameterBufferH264
2829 VAPictureH264 CurrPic;
2830 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2831 uint16_t picture_width_in_mbs_minus1;
2832 uint16_t picture_height_in_mbs_minus1;
2833 uint8_t bit_depth_luma_minus8;
2834 uint8_t bit_depth_chroma_minus8;
2835 uint8_t num_ref_frames;
2838 uint32_t chroma_format_idc : 2;
2839 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2840 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2841 uint32_t frame_mbs_only_flag : 1;
2842 uint32_t mb_adaptive_frame_field_flag : 1;
2843 uint32_t direct_8x8_inference_flag : 1;
2844 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2845 uint32_t log2_max_frame_num_minus4 : 4;
2846 uint32_t pic_order_cnt_type : 2;
2847 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2848 uint32_t delta_pic_order_always_zero_flag : 1;
2852 // FMO is not supported.
2853 va_deprecated uint8_t num_slice_groups_minus1;
2854 va_deprecated uint8_t slice_group_map_type;
2855 va_deprecated uint16_t slice_group_change_rate_minus1;
2856 int8_t pic_init_qp_minus26;
2857 int8_t pic_init_qs_minus26;
2858 int8_t chroma_qp_index_offset;
2859 int8_t second_chroma_qp_index_offset;
2862 uint32_t entropy_coding_mode_flag : 1;
2863 uint32_t weighted_pred_flag : 1;
2864 uint32_t weighted_bipred_idc : 2;
2865 uint32_t transform_8x8_mode_flag : 1;
2866 uint32_t field_pic_flag : 1;
2867 uint32_t constrained_intra_pred_flag : 1;
2868 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2869 uint32_t deblocking_filter_control_present_flag : 1;
2870 uint32_t redundant_pic_cnt_present_flag : 1;
2871 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2877 /** \brief Reserved bytes for future use, must be zero */
2878 uint32_t va_reserved[VA_PADDING_MEDIUM];
2879 } VAPictureParameterBufferH264;
2881 /** H.264 Inverse Quantization Matrix Buffer */
2882 typedef struct _VAIQMatrixBufferH264
2884 /** \brief 4x4 scaling list, in raster scan order. */
2885 uint8_t ScalingList4x4[6][16];
2886 /** \brief 8x8 scaling list, in raster scan order. */
2887 uint8_t ScalingList8x8[2][64];
2889 /** \brief Reserved bytes for future use, must be zero */
2890 uint32_t va_reserved[VA_PADDING_LOW];
2891 } VAIQMatrixBufferH264;
2893 /** H.264 Slice Parameter Buffer */
2894 typedef struct _VASliceParameterBufferH264
2896 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2897 /** \brief Byte offset to the NAL Header Unit for this slice. */
2898 uint32_t slice_data_offset;
2899 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2901 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2903 * This bit offset is relative to and includes the NAL unit byte
2904 * and represents the number of bits parsed in the slice_header()
2905 * after the removal of any emulation prevention bytes in
2906 * there. However, the slice data buffer passed to the hardware is
2907 * the original bitstream, thus including any emulation prevention
2910 uint16_t slice_data_bit_offset;
2911 uint16_t first_mb_in_slice;
2913 uint8_t direct_spatial_mv_pred_flag;
2915 * H264/AVC syntax element
2917 * if num_ref_idx_active_override_flag equals 0, host decoder should
2918 * set its value to num_ref_idx_l0_default_active_minus1.
2920 uint8_t num_ref_idx_l0_active_minus1;
2922 * H264/AVC syntax element
2924 * if num_ref_idx_active_override_flag equals 0, host decoder should
2925 * set its value to num_ref_idx_l1_default_active_minus1.
2927 uint8_t num_ref_idx_l1_active_minus1;
2928 uint8_t cabac_init_idc;
2929 int8_t slice_qp_delta;
2930 uint8_t disable_deblocking_filter_idc;
2931 int8_t slice_alpha_c0_offset_div2;
2932 int8_t slice_beta_offset_div2;
2933 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2934 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2935 uint8_t luma_log2_weight_denom;
2936 uint8_t chroma_log2_weight_denom;
2937 uint8_t luma_weight_l0_flag;
2938 int16_t luma_weight_l0[32];
2939 int16_t luma_offset_l0[32];
2940 uint8_t chroma_weight_l0_flag;
2941 int16_t chroma_weight_l0[32][2];
2942 int16_t chroma_offset_l0[32][2];
2943 uint8_t luma_weight_l1_flag;
2944 int16_t luma_weight_l1[32];
2945 int16_t luma_offset_l1[32];
2946 uint8_t chroma_weight_l1_flag;
2947 int16_t chroma_weight_l1[32][2];
2948 int16_t chroma_offset_l1[32][2];
2950 /** \brief Reserved bytes for future use, must be zero */
2951 uint32_t va_reserved[VA_PADDING_LOW];
2952 } VASliceParameterBufferH264;
2954 /****************************
2955 * Common encode data structures
2956 ****************************/
2959 VAEncPictureTypeIntra = 0,
2960 VAEncPictureTypePredictive = 1,
2961 VAEncPictureTypeBidirectional = 2,
2965 * \brief Encode Slice Parameter Buffer.
2968 * This is a deprecated encode slice parameter buffer, All applications
2969 * \c can use VAEncSliceParameterBufferXXX (XXX = MPEG2, HEVC, H264, JPEG)
2971 typedef struct _VAEncSliceParameterBuffer
2973 uint32_t start_row_number; /* starting MB row number for this slice */
2974 uint32_t slice_height; /* slice height measured in MB */
2977 uint32_t is_intra : 1;
2978 uint32_t disable_deblocking_filter_idc : 2;
2979 uint32_t uses_long_term_ref :1;
2980 uint32_t is_long_term_ref :1;
2985 /** \brief Reserved bytes for future use, must be zero */
2986 uint32_t va_reserved[VA_PADDING_LOW];
2987 } VAEncSliceParameterBuffer;
2990 /****************************
2991 * H.263 specific encode data structures
2992 ****************************/
2994 typedef struct _VAEncSequenceParameterBufferH263
2996 uint32_t intra_period;
2997 uint32_t bits_per_second;
2998 uint32_t frame_rate;
2999 uint32_t initial_qp;
3002 /** \brief Reserved bytes for future use, must be zero */
3003 uint32_t va_reserved[VA_PADDING_LOW];
3004 } VAEncSequenceParameterBufferH263;
3006 typedef struct _VAEncPictureParameterBufferH263
3008 VASurfaceID reference_picture;
3009 VASurfaceID reconstructed_picture;
3010 VABufferID coded_buf;
3011 uint16_t picture_width;
3012 uint16_t picture_height;
3013 VAEncPictureType picture_type;
3015 /** \brief Reserved bytes for future use, must be zero */
3016 uint32_t va_reserved[VA_PADDING_LOW];
3017 } VAEncPictureParameterBufferH263;
3019 /****************************
3020 * MPEG-4 specific encode data structures
3021 ****************************/
3023 typedef struct _VAEncSequenceParameterBufferMPEG4
3025 uint8_t profile_and_level_indication;
3026 uint32_t intra_period;
3027 uint32_t video_object_layer_width;
3028 uint32_t video_object_layer_height;
3029 uint32_t vop_time_increment_resolution;
3030 uint32_t fixed_vop_rate;
3031 uint32_t fixed_vop_time_increment;
3032 uint32_t bits_per_second;
3033 uint32_t frame_rate;
3034 uint32_t initial_qp;
3037 /** \brief Reserved bytes for future use, must be zero */
3038 uint32_t va_reserved[VA_PADDING_LOW];
3039 } VAEncSequenceParameterBufferMPEG4;
3041 typedef struct _VAEncPictureParameterBufferMPEG4
3043 VASurfaceID reference_picture;
3044 VASurfaceID reconstructed_picture;
3045 VABufferID coded_buf;
3046 uint16_t picture_width;
3047 uint16_t picture_height;
3048 uint32_t modulo_time_base; /* number of 1s */
3049 uint32_t vop_time_increment;
3050 VAEncPictureType picture_type;
3052 /** \brief Reserved bytes for future use, must be zero */
3053 uint32_t va_reserved[VA_PADDING_LOW];
3054 } VAEncPictureParameterBufferMPEG4;
3058 /** Buffer functions */
3061 * Creates a buffer for "num_elements" elements of "size" bytes and
3062 * initalize with "data".
3063 * if "data" is null, then the contents of the buffer data store
3065 * Basically there are two ways to get buffer data to the server side. One is
3066 * to call vaCreateBuffer() with a non-null "data", which results the data being
3067 * copied to the data store on the server side. A different method that
3068 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
3069 * and then use vaMapBuffer() to map the data store from the server side to the
3070 * client address space for access.
3071 * The user must call vaDestroyBuffer() to destroy a buffer.
3072 * Note: image buffers are created by the library, not the client. Please see
3073 * vaCreateImage on how image buffers are managed.
3075 VAStatus vaCreateBuffer (
3077 VAContextID context,
3078 VABufferType type, /* in */
3079 unsigned int size, /* in */
3080 unsigned int num_elements, /* in */
3081 void *data, /* in */
3082 VABufferID *buf_id /* out */
3086 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
3087 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
3088 * can call vaMapBuffer with this Buffer ID to get virtual address.
3089 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
3090 * maybe it should align with 256, and one byte present one Qp.so, call the function.
3091 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
3092 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
3093 * pBuf + 256 is the start of next line.
3094 * different driver implementation maybe return different unit_size and pitch
3096 VAStatus vaCreateBuffer2(
3098 VAContextID context,
3101 unsigned int height,
3102 unsigned int *unit_size,
3103 unsigned int *pitch,
3108 * Convey to the server how many valid elements are in the buffer.
3109 * e.g. if multiple slice parameters are being held in a single buffer,
3110 * this will communicate to the server the number of slice parameters
3111 * that are valid in the buffer.
3113 VAStatus vaBufferSetNumElements (
3115 VABufferID buf_id, /* in */
3116 unsigned int num_elements /* in */
3121 * device independent data structure for codedbuffer
3125 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
3126 * LARGE_SLICE(bit8):At least one slice in the current frame was large
3127 * enough for the encoder to attempt to limit its size.
3128 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
3129 * exceeded the maximum slice size specified.
3130 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
3131 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
3132 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
3134 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
3135 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
3136 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
3137 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
3138 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
3140 * \brief The frame has exceeded the maximum requested size.
3142 * This flag indicates that the encoded frame size exceeds the value
3143 * specified through a misc parameter buffer of type
3144 * #VAEncMiscParameterTypeMaxFrameSize.
3146 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
3148 * \brief the bitstream is bad or corrupt.
3150 #define VA_CODED_BUF_STATUS_BAD_BITSTREAM 0x8000
3151 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
3154 * \brief The coded buffer segment status contains frame encoding passes number
3156 * This is the mask to get the number of encoding passes from the coded
3157 * buffer segment status.
3158 * NUMBER_PASS(bit24~bit27): the number for encoding passes executed for the coded frame.
3161 #define VA_CODED_BUF_STATUS_NUMBER_PASSES_MASK 0xf000000
3164 * \brief The coded buffer segment contains a single NAL unit.
3166 * This flag indicates that the coded buffer segment contains a
3167 * single NAL unit. This flag might be useful to the user for
3168 * processing the coded buffer.
3170 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
3173 * \brief Coded buffer segment.
3175 * #VACodedBufferSegment is an element of a linked list describing
3176 * some information on the coded buffer. The coded buffer segment
3177 * could contain either a single NAL unit, or more than one NAL unit.
3178 * It is recommended (but not required) to return a single NAL unit
3179 * in a coded buffer segment, and the implementation should set the
3180 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
3182 typedef struct _VACodedBufferSegment {
3184 * \brief Size of the data buffer in this segment (in bytes).
3187 /** \brief Bit offset into the data buffer where the video data starts. */
3188 uint32_t bit_offset;
3189 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
3191 /** \brief Reserved for future use. */
3193 /** \brief Pointer to the start of the data buffer. */
3196 * \brief Pointer to the next #VACodedBufferSegment element,
3197 * or \c NULL if there is none.
3201 /** \brief Reserved bytes for future use, must be zero */
3202 uint32_t va_reserved[VA_PADDING_LOW];
3203 } VACodedBufferSegment;
3206 * Map data store of the buffer into the client's address space
3207 * vaCreateBuffer() needs to be called with "data" set to NULL before
3208 * calling vaMapBuffer()
3210 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
3211 * VACodedBufferSegment, and the list is terminated if "next" is NULL
3213 VAStatus vaMapBuffer (
3215 VABufferID buf_id, /* in */
3216 void **pbuf /* out */
3220 * After client making changes to a mapped data store, it needs to
3221 * "Unmap" it to let the server know that the data is ready to be
3222 * consumed by the server
3224 VAStatus vaUnmapBuffer (
3226 VABufferID buf_id /* in */
3230 * After this call, the buffer is deleted and this buffer_id is no longer valid
3232 * A buffer can be re-used and sent to the server by another Begin/Render/End
3233 * sequence if vaDestroyBuffer() is not called with this buffer.
3235 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3236 * hardware accelerator can result in performance dropping.
3238 VAStatus vaDestroyBuffer (
3240 VABufferID buffer_id
3243 /** \brief VA buffer information */
3245 /** \brief Buffer handle */
3247 /** \brief Buffer type (See \ref VABufferType). */
3250 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3252 * On input to vaAcquireBufferHandle(), this field can serve as a hint
3253 * to specify the set of memory types the caller is interested in.
3254 * On successful return from vaAcquireBufferHandle(), the field is
3255 * updated with the best matching memory type.
3258 /** \brief Size of the underlying buffer. */
3261 /** \brief Reserved bytes for future use, must be zero */
3262 uint32_t va_reserved[VA_PADDING_LOW];
3266 * \brief Acquires buffer handle for external API usage
3268 * Locks the VA buffer object \ref buf_id for external API usage like
3269 * EGL or OpenCL (OCL). This function is a synchronization point. This
3270 * means that any pending operation is guaranteed to be completed
3271 * prior to returning from the function.
3273 * If the referenced VA buffer object is the backing store of a VA
3274 * surface, then this function acts as if vaSyncSurface() on the
3275 * parent surface was called first.
3277 * The \ref VABufferInfo argument shall be zero'ed on input. On
3278 * successful output, the data structure is filled in with all the
3279 * necessary buffer level implementation details like handle, type,
3280 * memory type and memory size.
3282 * Note: the external API implementation, or the application, can
3283 * express the memory types it is interested in by filling in the \ref
3284 * mem_type field accordingly. On successful output, the memory type
3285 * that fits best the request and that was used is updated in the \ref
3286 * VABufferInfo data structure. If none of the supplied memory types
3287 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3288 * error is returned.
3290 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3291 * is called. Besides, no additional operation is allowed on any of
3292 * the buffer parent object until vaReleaseBufferHandle() is called.
3293 * e.g. decoding into a VA surface backed with the supplied VA buffer
3294 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3298 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3299 * does not support this interface
3300 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3301 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3302 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3303 * does not support exporting buffers of the specified type
3304 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3305 * memory types in \ref VABufferInfo.mem_type was supported
3307 * @param[in] dpy the VA display
3308 * @param[in] buf_id the VA buffer
3309 * @param[in,out] buf_info the associated VA buffer information
3310 * @return VA_STATUS_SUCCESS if successful
3313 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3316 * \brief Releases buffer after usage from external API
3318 * Unlocks the VA buffer object \ref buf_id from external API usage like
3319 * EGL or OpenCL (OCL). This function is a synchronization point. This
3320 * means that any pending operation is guaranteed to be completed
3321 * prior to returning from the function.
3323 * The \ref VABufferInfo argument shall point to the original data
3324 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3325 * This is necessary so that the VA driver implementation could
3326 * deallocate any resources that were needed.
3328 * In any case, returning from this function invalidates any contents
3329 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3330 * valid. Therefore, VA driver implementations are free to reset this
3331 * data structure to safe defaults.
3334 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3335 * does not support this interface
3336 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3337 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3338 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3339 * does not support exporting buffers of the specified type
3341 * @param[in] dpy the VA display
3342 * @param[in] buf_id the VA buffer
3343 * @return VA_STATUS_SUCCESS if successful
3346 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3348 /** @name vaExportSurfaceHandle() flags
3352 /** Export surface to be read by external API. */
3353 #define VA_EXPORT_SURFACE_READ_ONLY 0x0001
3354 /** Export surface to be written by external API. */
3355 #define VA_EXPORT_SURFACE_WRITE_ONLY 0x0002
3356 /** Export surface to be both read and written by external API. */
3357 #define VA_EXPORT_SURFACE_READ_WRITE 0x0003
3358 /** Export surface with separate layers.
3360 * For example, NV12 surfaces should be exported as two separate
3361 * planes for luma and chroma.
3363 #define VA_EXPORT_SURFACE_SEPARATE_LAYERS 0x0004
3364 /** Export surface with composed layers.
3366 * For example, NV12 surfaces should be exported as a single NV12
3369 #define VA_EXPORT_SURFACE_COMPOSED_LAYERS 0x0008
3374 * \brief Export a handle to a surface for use with an external API
3376 * The exported handles are owned by the caller, and the caller is
3377 * responsible for freeing them when no longer needed (e.g. by closing
3378 * DRM PRIME file descriptors).
3380 * This does not perform any synchronisation. If the contents of the
3381 * surface will be read, vaSyncSurface() must be called before doing so.
3382 * If the contents of the surface are written, then all operations must
3383 * be completed externally before using the surface again by via VA-API
3386 * @param[in] dpy VA display.
3387 * @param[in] surface_id Surface to export.
3388 * @param[in] mem_type Memory type to export to.
3389 * @param[in] flags Combination of flags to apply
3390 * (VA_EXPORT_SURFACE_*).
3391 * @param[out] descriptor Pointer to the descriptor structure to fill
3392 * with the handle details. The type of this structure depends on
3393 * the value of mem_type.
3395 * @return Status code:
3396 * - VA_STATUS_SUCCESS: Success.
3397 * - VA_STATUS_ERROR_INVALID_DISPLAY: The display is not valid.
3398 * - VA_STATUS_ERROR_UNIMPLEMENTED: The driver does not implement
3400 * - VA_STATUS_ERROR_INVALID_SURFACE: The surface is not valid, or
3401 * the surface is not exportable in the specified way.
3402 * - VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: The driver does not
3403 * support exporting surfaces to the specified memory type.
3405 VAStatus vaExportSurfaceHandle(VADisplay dpy,
3406 VASurfaceID surface_id,
3407 uint32_t mem_type, uint32_t flags,
3411 * Render (Video Decode/Encode/Processing) Pictures
3413 * A picture represents either a frame or a field.
3415 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3420 * Get ready for a video pipeline
3421 * - decode a picture to a target surface
3422 * - encode a picture from a target surface
3423 * - process a picture to a target surface
3425 VAStatus vaBeginPicture (
3427 VAContextID context,
3428 VASurfaceID render_target
3432 * Send video decode, encode or processing buffers to the server.
3434 VAStatus vaRenderPicture (
3436 VAContextID context,
3437 VABufferID *buffers,
3442 * Make the end of rendering for a picture.
3443 * The server should start processing all pending operations for this
3444 * surface. This call is non-blocking. The client can start another
3445 * Begin/Render/End sequence on a different render target.
3446 * if VAContextID used in this function previously successfully passed
3447 * vaMFAddContext call, real processing will be started during vaMFSubmit
3449 VAStatus vaEndPicture (
3455 * Make the end of rendering for a pictures in contexts passed with submission.
3456 * The server should start processing all pending operations for contexts.
3457 * All contexts passed should be associated through vaMFAddContext
3458 * and call sequence Begin/Render/End performed.
3459 * This call is non-blocking. The client can start another
3460 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3462 * VA_STATUS_SUCCESS - operation successful, context was removed.
3463 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3464 * due to mf_context not created or one of contexts not assotiated with mf_context
3465 * through vaAddContext.
3466 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3467 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3469 * mf_context: Multi-Frame context
3470 * contexts: list of contexts submitting their tasks for multi-frame operation.
3471 * num_contexts: number of passed contexts.
3473 VAStatus vaMFSubmit (
3475 VAMFContextID mf_context,
3476 VAContextID * contexts,
3487 * This function blocks until all pending operations on the render target
3488 * have been completed. Upon return it is safe to use the render target for a
3489 * different picture.
3491 VAStatus vaSyncSurface (
3493 VASurfaceID render_target
3498 VASurfaceRendering = 1, /* Rendering in progress */
3499 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3500 /* this status is useful if surface is used as the source */
3502 VASurfaceReady = 4, /* not being rendered or displayed */
3503 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3507 * Find out any pending ops on the render target
3509 VAStatus vaQuerySurfaceStatus (
3511 VASurfaceID render_target,
3512 VASurfaceStatus *status /* out */
3517 VADecodeSliceMissing = 0,
3518 VADecodeMBError = 1,
3519 } VADecodeErrorType;
3522 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3523 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3525 typedef struct _VASurfaceDecodeMBErrors
3527 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3528 uint32_t start_mb; /* start mb address with errors */
3529 uint32_t end_mb; /* end mb address with errors */
3530 VADecodeErrorType decode_error_type;
3531 uint32_t num_mb; /* number of mbs with errors */
3532 /** \brief Reserved bytes for future use, must be zero */
3533 uint32_t va_reserved[VA_PADDING_LOW - 1];
3534 } VASurfaceDecodeMBErrors;
3537 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3538 * it can call vaQuerySurfaceError to find out further details on the particular error.
3539 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3540 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3541 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3542 * The array is terminated if "status==-1" is detected.
3544 VAStatus vaQuerySurfaceError(
3546 VASurfaceID surface,
3547 VAStatus error_status,
3552 * Images and Subpictures
3553 * VAImage is used to either get the surface data to client memory, or
3554 * to copy image data in client memory to a surface.
3555 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3556 * is at the upper left corner with positive X to the right and positive Y down
3558 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3559 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3560 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3563 * Pre-defined fourcc codes
3565 #define VA_FOURCC_NV12 0x3231564E
3566 #define VA_FOURCC_NV21 0x3132564E
3567 #define VA_FOURCC_AI44 0x34344149
3568 #define VA_FOURCC_RGBA 0x41424752
3569 #define VA_FOURCC_RGBX 0x58424752
3570 #define VA_FOURCC_BGRA 0x41524742
3571 #define VA_FOURCC_BGRX 0x58524742
3572 #define VA_FOURCC_ARGB 0x42475241
3573 #define VA_FOURCC_XRGB 0x42475258
3574 #define VA_FOURCC_ABGR 0x52474241
3575 #define VA_FOURCC_XBGR 0x52474258
3576 #define VA_FOURCC_UYVY 0x59565955
3577 #define VA_FOURCC_YUY2 0x32595559
3578 #define VA_FOURCC_AYUV 0x56555941
3579 #define VA_FOURCC_NV11 0x3131564e
3580 #define VA_FOURCC_YV12 0x32315659
3581 #define VA_FOURCC_P208 0x38303250
3582 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3583 #define VA_FOURCC_IYUV 0x56555949
3584 #define VA_FOURCC_I420 0x30323449
3585 #define VA_FOURCC_YV24 0x34325659
3586 #define VA_FOURCC_YV32 0x32335659
3587 #define VA_FOURCC_Y800 0x30303859
3588 #define VA_FOURCC_IMC3 0x33434D49
3589 #define VA_FOURCC_411P 0x50313134
3590 #define VA_FOURCC_422H 0x48323234
3591 #define VA_FOURCC_422V 0x56323234
3592 #define VA_FOURCC_444P 0x50343434
3593 #define VA_FOURCC_RGBP 0x50424752
3594 #define VA_FOURCC_BGRP 0x50524742
3595 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
3596 #define VA_FOURCC_RGB565 0x36314752 /* VA_FOURCC('R','G','1','6') */
3597 #define VA_FOURCC_BGR565 0x36314742 /* VA_FOURCC('B','G','1','6') */
3599 #define VA_FOURCC_Y210 0x30313259
3600 #define VA_FOURCC_Y216 0x36313259
3601 #define VA_FOURCC_Y410 0x30313459
3602 #define VA_FOURCC_Y416 0x36313459
3606 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3608 #define VA_FOURCC_YV16 0x36315659
3610 * 10-bit and 16-bit Planar YUV 4:2:0.
3612 #define VA_FOURCC_P010 0x30313050
3613 #define VA_FOURCC_P016 0x36313050
3616 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3618 #define VA_FOURCC_I010 0x30313049
3621 #define VA_LSB_FIRST 1
3622 #define VA_MSB_FIRST 2
3624 typedef struct _VAImageFormat
3627 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3628 uint32_t bits_per_pixel;
3629 /* for RGB formats */
3630 uint32_t depth; /* significant bits per pixel */
3632 uint32_t green_mask;
3634 uint32_t alpha_mask;
3636 /** \brief Reserved bytes for future use, must be zero */
3637 uint32_t va_reserved[VA_PADDING_LOW];
3640 typedef VAGenericID VAImageID;
3642 typedef struct _VAImage
3644 VAImageID image_id; /* uniquely identify this image */
3645 VAImageFormat format;
3646 VABufferID buf; /* image data buffer */
3648 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3649 * data store on the server side for optimal performance. The buffer will be
3650 * created by the CreateImage function, and proper storage allocated based on the image
3651 * size and format. This buffer is managed by the library implementation, and
3652 * accessed by the client through the buffer Map/Unmap functions.
3657 uint32_t num_planes; /* can not be greater than 3 */
3659 * An array indicating the scanline pitch in bytes for each plane.
3660 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3662 uint32_t pitches[3];
3664 * An array indicating the byte offset from the beginning of the image data
3665 * to the start of each plane.
3667 uint32_t offsets[3];
3669 /* The following fields are only needed for paletted formats */
3670 int32_t num_palette_entries; /* set to zero for non-palette images */
3672 * Each component is one byte and entry_bytes indicates the number of components in
3673 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3675 int32_t entry_bytes;
3677 * An array of ascii characters describing the order of the components within the bytes.
3678 * Only entry_bytes characters of the string are used.
3680 int8_t component_order[4];
3682 /** \brief Reserved bytes for future use, must be zero */
3683 uint32_t va_reserved[VA_PADDING_LOW];
3686 /** Get maximum number of image formats supported by the implementation */
3687 int vaMaxNumImageFormats (
3692 * Query supported image formats
3693 * The caller must provide a "format_list" array that can hold at
3694 * least vaMaxNumImageFormats() entries. The actual number of formats
3695 * returned in "format_list" is returned in "num_formats".
3697 VAStatus vaQueryImageFormats (
3699 VAImageFormat *format_list, /* out */
3700 int *num_formats /* out */
3704 * Create a VAImage structure
3705 * The width and height fields returned in the VAImage structure may get
3706 * enlarged for some YUV formats. Upon return from this function,
3707 * image->buf has been created and proper storage allocated by the library.
3708 * The client can access the image through the Map/Unmap calls.
3710 VAStatus vaCreateImage (
3712 VAImageFormat *format,
3715 VAImage *image /* out */
3719 * Should call DestroyImage before destroying the surface it is bound to
3721 VAStatus vaDestroyImage (
3726 VAStatus vaSetImagePalette (
3730 * pointer to an array holding the palette data. The size of the array is
3731 * num_palette_entries * entry_bytes in size. The order of the components
3732 * in the palette is described by the component_order in VAImage struct
3734 unsigned char *palette
3738 * Retrive surface data into a VAImage
3739 * Image must be in a format supported by the implementation
3741 VAStatus vaGetImage (
3743 VASurfaceID surface,
3744 int x, /* coordinates of the upper left source pixel */
3746 unsigned int width, /* width and height of the region */
3747 unsigned int height,
3752 * Copy data from a VAImage to a surface
3753 * Image must be in a format supported by the implementation
3754 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3755 * shouldn't be rendered into when this is called
3757 VAStatus vaPutImage (
3759 VASurfaceID surface,
3763 unsigned int src_width,
3764 unsigned int src_height,
3767 unsigned int dest_width,
3768 unsigned int dest_height
3772 * Derive an VAImage from an existing surface.
3773 * This interface will derive a VAImage and corresponding image buffer from
3774 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3775 * direct CPU access. This operation is only possible on implementations with
3776 * direct rendering capabilities and internal surface formats that can be
3777 * represented with a VAImage. When the operation is not possible this interface
3778 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3779 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3782 * Implementations should only return success when the resulting image buffer
3783 * would be useable with vaMap/Unmap.
3785 * When directly accessing a surface special care must be taken to insure
3786 * proper synchronization with the graphics hardware. Clients should call
3787 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3788 * rendering or currently being displayed by an overlay.
3790 * Additionally nothing about the contents of a surface should be assumed
3791 * following a vaPutSurface. Implementations are free to modify the surface for
3792 * scaling or subpicture blending within a call to vaPutImage.
3794 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3795 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3796 * vaGetImage with other surfaces is supported.
3798 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3799 * image and image buffer structures will be destroyed; however, the underlying
3800 * surface will remain unchanged until freed with vaDestroySurfaces.
3802 VAStatus vaDeriveImage (
3804 VASurfaceID surface,
3805 VAImage *image /* out */
3810 * Subpicture is a special type of image that can be blended
3811 * with a surface during vaPutSurface(). Subpicture can be used to render
3812 * DVD sub-titles or closed captioning text etc.
3815 typedef VAGenericID VASubpictureID;
3817 /** Get maximum number of subpicture formats supported by the implementation */
3818 int vaMaxNumSubpictureFormats (
3822 /** flags for subpictures */
3823 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3824 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3825 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3827 * Query supported subpicture formats
3828 * The caller must provide a "format_list" array that can hold at
3829 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3830 * for each format to indicate additional capabilities for that format. The actual
3831 * number of formats returned in "format_list" is returned in "num_formats".
3832 * flags: returned value to indicate addtional capabilities
3833 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3834 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3835 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3838 VAStatus vaQuerySubpictureFormats (
3840 VAImageFormat *format_list, /* out */
3841 unsigned int *flags, /* out */
3842 unsigned int *num_formats /* out */
3846 * Subpictures are created with an image associated.
3848 VAStatus vaCreateSubpicture (
3851 VASubpictureID *subpicture /* out */
3855 * Destroy the subpicture before destroying the image it is assocated to
3857 VAStatus vaDestroySubpicture (
3859 VASubpictureID subpicture
3863 * Bind an image to the subpicture. This image will now be associated with
3864 * the subpicture instead of the one at creation.
3866 VAStatus vaSetSubpictureImage (
3868 VASubpictureID subpicture,
3873 * If chromakey is enabled, then the area where the source value falls within
3874 * the chromakey [min, max] range is transparent
3875 * The chromakey component format is the following:
3876 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3877 * For YUV: [0:7] V [8:15] U [16:23] Y
3878 * The chromakey mask can be used to mask out certain components for chromakey
3881 VAStatus vaSetSubpictureChromakey (
3883 VASubpictureID subpicture,
3884 unsigned int chromakey_min,
3885 unsigned int chromakey_max,
3886 unsigned int chromakey_mask
3890 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3891 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3892 * the overall alpha is per-pixel alpha multiplied by the global alpha
3894 VAStatus vaSetSubpictureGlobalAlpha (
3896 VASubpictureID subpicture,
3901 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3902 * It defines the region mapping between the subpicture and the target
3903 * surfaces through source and destination rectangles (with the same width and height).
3904 * Both will be displayed at the next call to vaPutSurface. Additional
3905 * associations before the call to vaPutSurface simply overrides the association.
3907 VAStatus vaAssociateSubpicture (
3909 VASubpictureID subpicture,
3910 VASurfaceID *target_surfaces,
3912 int16_t src_x, /* upper left offset in subpicture */
3915 uint16_t src_height,
3916 int16_t dest_x, /* upper left offset in surface */
3918 uint16_t dest_width,
3919 uint16_t dest_height,
3921 * whether to enable chroma-keying, global-alpha, or screen relative mode
3922 * see VA_SUBPICTURE_XXX values
3928 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3930 VAStatus vaDeassociateSubpicture (
3932 VASubpictureID subpicture,
3933 VASurfaceID *target_surfaces,
3938 * Display attributes
3939 * Display attributes are used to control things such as contrast, hue, saturation,
3940 * brightness etc. in the rendering process. The application can query what
3941 * attributes are supported by the driver, and then set the appropriate attributes
3942 * before calling vaPutSurface()
3944 /* PowerVR IEP Lite attributes */
3947 VADISPLAYATTRIB_BLE_OFF = 0x00,
3948 VADISPLAYATTRIB_BLE_LOW,
3949 VADISPLAYATTRIB_BLE_MEDIUM,
3950 VADISPLAYATTRIB_BLE_HIGH,
3951 VADISPLAYATTRIB_BLE_NONE,
3952 } VADisplayAttribBLEMode;
3954 /** attribute value for VADisplayAttribRotation */
3955 #define VA_ROTATION_NONE 0x00000000
3956 #define VA_ROTATION_90 0x00000001
3957 #define VA_ROTATION_180 0x00000002
3958 #define VA_ROTATION_270 0x00000003
3962 * @name Mirroring directions
3964 * Those values could be used for VADisplayAttribMirror attribute or
3965 * VAProcPipelineParameterBuffer::mirror_state.
3969 /** \brief No Mirroring. */
3970 #define VA_MIRROR_NONE 0x00000000
3971 /** \brief Horizontal Mirroring. */
3972 #define VA_MIRROR_HORIZONTAL 0x00000001
3973 /** \brief Vertical Mirroring. */
3974 #define VA_MIRROR_VERTICAL 0x00000002
3977 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3978 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3979 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3982 #define VA_RENDER_MODE_UNDEFINED 0
3983 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3984 #define VA_RENDER_MODE_LOCAL_GPU 2
3985 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3986 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3988 /** Render device */
3989 #define VA_RENDER_DEVICE_UNDEFINED 0
3990 #define VA_RENDER_DEVICE_LOCAL 1
3991 #define VA_RENDER_DEVICE_EXTERNAL 2
3993 /** Currently defined display attribute types */
3996 VADisplayAttribBrightness = 0,
3997 VADisplayAttribContrast = 1,
3998 VADisplayAttribHue = 2,
3999 VADisplayAttribSaturation = 3,
4000 /* client can specifiy a background color for the target window
4001 * the new feature of video conference,
4002 * the uncovered area of the surface is filled by this color
4003 * also it will blend with the decoded video color
4005 VADisplayAttribBackgroundColor = 4,
4007 * this is a gettable only attribute. For some implementations that use the
4008 * hardware overlay, after PutSurface is called, the surface can not be
4009 * re-used until after the subsequent PutSurface call. If this is the case
4010 * then the value for this attribute will be set to 1 so that the client
4011 * will not attempt to re-use the surface right after returning from a call
4014 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
4015 * driver may use overlay or GPU alternatively
4017 VADisplayAttribDirectSurface = 5,
4018 VADisplayAttribRotation = 6,
4019 VADisplayAttribOutofLoopDeblock = 7,
4021 /* PowerVR IEP Lite specific attributes */
4022 VADisplayAttribBLEBlackMode = 8,
4023 VADisplayAttribBLEWhiteMode = 9,
4024 VADisplayAttribBlueStretch = 10,
4025 VADisplayAttribSkinColorCorrection = 11,
4027 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
4028 * conversion matrix. Each element in the matrix is float-point
4030 VADisplayAttribCSCMatrix = 12,
4031 /* specify the constant color used to blend with video surface
4032 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
4033 * d: the final color to overwrite into the frame buffer
4034 * v: decoded video after color conversion,
4035 * c: video color specified by VADisplayAttribBlendColor
4036 * b: background color of the drawable
4038 VADisplayAttribBlendColor = 13,
4040 * Indicate driver to skip painting color key or not.
4041 * only applicable if the render is overlay
4043 VADisplayAttribOverlayAutoPaintColorKey = 14,
4045 * customized overlay color key, the format is RGB888
4046 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
4048 VADisplayAttribOverlayColorKey = 15,
4050 * The hint for the implementation of vaPutSurface
4051 * normally, the driver could use an overlay or GPU to render the surface on the screen
4052 * this flag provides APP the flexibity to switch the render dynamically
4054 VADisplayAttribRenderMode = 16,
4056 * specify if vaPutSurface needs to render into specified monitors
4057 * one example is that one external monitor (e.g. HDMI) is enabled,
4058 * but the window manager is not aware of it, and there is no associated drawable
4060 VADisplayAttribRenderDevice = 17,
4062 * specify vaPutSurface render area if there is no drawable on the monitor
4064 VADisplayAttribRenderRect = 18,
4065 } VADisplayAttribType;
4067 /* flags for VADisplayAttribute */
4068 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
4069 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
4070 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
4072 typedef struct _VADisplayAttribute
4074 VADisplayAttribType type;
4077 int32_t value; /* used by the set/get attribute functions */
4078 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
4081 /** \brief Reserved bytes for future use, must be zero */
4082 uint32_t va_reserved[VA_PADDING_LOW];
4083 } VADisplayAttribute;
4085 /** Get maximum number of display attributs supported by the implementation */
4086 int vaMaxNumDisplayAttributes (
4091 * Query display attributes
4092 * The caller must provide a "attr_list" array that can hold at
4093 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
4094 * returned in "attr_list" is returned in "num_attributes".
4096 VAStatus vaQueryDisplayAttributes (
4098 VADisplayAttribute *attr_list, /* out */
4099 int *num_attributes /* out */
4103 * Get display attributes
4104 * This function returns the current attribute values in "attr_list".
4105 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
4106 * from vaQueryDisplayAttributes() can have their values retrieved.
4108 VAStatus vaGetDisplayAttributes (
4110 VADisplayAttribute *attr_list, /* in/out */
4115 * Set display attributes
4116 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
4117 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
4118 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
4120 VAStatus vaSetDisplayAttributes (
4122 VADisplayAttribute *attr_list,
4126 /****************************
4127 * HEVC data structures
4128 ****************************/
4130 * \brief Description of picture properties of those in DPB surfaces.
4132 * If only progressive scan is supported, each surface contains one whole
4134 * Otherwise, each surface contains two fields of whole picture.
4135 * In this case, two entries of ReferenceFrames[] may share same picture_id
4138 typedef struct _VAPictureHEVC
4140 /** \brief reconstructed picture buffer surface index
4141 * invalid when taking value VA_INVALID_SURFACE.
4143 VASurfaceID picture_id;
4144 /** \brief picture order count.
4145 * in HEVC, POCs for top and bottom fields of same picture should
4146 * take different values.
4148 int32_t pic_order_cnt;
4149 /* described below */
4152 /** \brief Reserved bytes for future use, must be zero */
4153 uint32_t va_reserved[VA_PADDING_LOW];
4156 /* flags in VAPictureHEVC could be OR of the following */
4157 #define VA_PICTURE_HEVC_INVALID 0x00000001
4158 /** \brief indication of interlace scan picture.
4159 * should take same value for all the pictures in sequence.
4161 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
4162 /** \brief polarity of the field picture.
4163 * top field takes even lines of buffer surface.
4164 * bottom field takes odd lines of buffer surface.
4166 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
4167 /** \brief Long term reference picture */
4168 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
4170 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
4171 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
4172 * be exclusive. No more than one of them can be set for any picture.
4173 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
4174 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
4175 * Application should provide valid values for both short format and long format.
4176 * The pictures in DPB with any of these three flags turned on are referred by
4177 * the current picture.
4179 /** \brief RefPicSetStCurrBefore of HEVC spec variable
4180 * Number of ReferenceFrames[] entries with this bit set equals
4181 * NumPocStCurrBefore.
4183 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
4184 /** \brief RefPicSetStCurrAfter of HEVC spec variable
4185 * Number of ReferenceFrames[] entries with this bit set equals
4186 * NumPocStCurrAfter.
4188 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
4189 /** \brief RefPicSetLtCurr of HEVC spec variable
4190 * Number of ReferenceFrames[] entries with this bit set equals
4193 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
4195 #include <va/va_dec_hevc.h>
4196 #include <va/va_dec_jpeg.h>
4197 #include <va/va_dec_vp8.h>
4198 #include <va/va_dec_vp9.h>
4199 #include <va/va_enc_hevc.h>
4200 #include <va/va_fei_hevc.h>
4201 #include <va/va_enc_h264.h>
4202 #include <va/va_enc_jpeg.h>
4203 #include <va/va_enc_mpeg2.h>
4204 #include <va/va_enc_vp8.h>
4205 #include <va/va_enc_vp9.h>
4206 #include <va/va_fei.h>
4207 #include <va/va_fei_h264.h>
4208 #include <va/va_vpp.h>