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
382 * Currently defined entrypoints
388 VAEntrypointIDCT = 3,
389 VAEntrypointMoComp = 4,
390 VAEntrypointDeblocking = 5,
391 VAEntrypointEncSlice = 6, /* slice level encode */
392 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
394 * For an implementation that supports a low power/high performance variant
395 * for slice level encode, it can choose to expose the
396 * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
397 * available with this entrypoint (e.g. interlace, MBAFF) and the
398 * application can query the encoding configuration attributes to find
399 * out more details if this entrypoint is supported.
401 VAEntrypointEncSliceLP = 8,
402 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
404 * \brief VAEntrypointFEI
406 * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to
407 * have more controls and trade off quality for speed with their own IPs.
408 * The application can optionally provide input to ENC for extra encode control
409 * and get the output from ENC. Application can chose to modify the ENC
410 * output/PAK input during encoding, but the performance impact is significant.
412 * On top of the existing buffers for normal encode, there will be
413 * one extra input buffer (VAEncMiscParameterFEIFrameControl) and
414 * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType
415 * and VAEncFEIDistortionBufferType) for VAEntrypointFEI entry function.
416 * If separate PAK is set, two extra input buffers
417 * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input.
419 VAEntrypointFEI = 11,
421 * \brief VAEntrypointStats
423 * A pre-processing function for getting some statistics and motion vectors is added,
424 * and some extra controls for Encode pipeline are provided. The application can
425 * optionally call the statistics function to get motion vectors and statistics like
426 * variances, distortions before calling Encode function via this entry point.
428 * Checking whether Statistics is supported can be performed with vaQueryConfigEntrypoints().
429 * If Statistics entry point is supported, then the list of returned entry-points will
430 * include #VAEntrypointStats. Supported pixel format, maximum resolution and statistics
431 * specific attributes can be obtained via normal attribute query. One input buffer
432 * (VAStatsStatisticsParameterBufferType) and one or two output buffers
433 * (VAStatsStatisticsBufferType, VAStatsStatisticsBottomFieldBufferType (for interlace only)
434 * and VAStatsMVBufferType) are needed for this entry point.
436 VAEntrypointStats = 12,
439 /** Currently defined configuration attribute types */
442 VAConfigAttribRTFormat = 0,
443 VAConfigAttribSpatialResidual = 1,
444 VAConfigAttribSpatialClipping = 2,
445 VAConfigAttribIntraResidual = 3,
446 VAConfigAttribEncryption = 4,
447 VAConfigAttribRateControl = 5,
449 /** @name Attributes for decoding */
452 * \brief Slice Decoding mode. Read/write.
454 * This attribute determines what mode the driver supports for slice
455 * decoding, through vaGetConfigAttributes(); and what mode the user
456 * will be providing to the driver, through vaCreateConfig(), if the
457 * driver supports those. If this attribute is not set by the user then
458 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
460 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
462 VAConfigAttribDecSliceMode = 6,
464 * \brief JPEG decoding attribute. Read-only.
466 * This attribute exposes a number of capabilities of the underlying
467 * JPEG implementation. The attribute value is partitioned into fields as defined in the
468 * VAConfigAttribValDecJPEG union.
470 VAConfigAttribDecJPEG = 7,
472 * \brief Decode processing support. Read/write.
474 * This attribute determines if the driver supports video processing
475 * with decoding using the decoding context in a single call, through
476 * vaGetConfigAttributes(); and if the user may use this feature,
477 * through vaCreateConfig(), if the driver supports the user scenario.
478 * The user will essentially create a regular decode VAContext. Therefore,
479 * the parameters of vaCreateContext() such as picture_width, picture_height
480 * and render_targets are in relation to the decode output parameters
481 * (not processing output parameters) as normal.
482 * If this attribute is not set by the user then it is assumed that no
483 * extra processing is done after decoding for this decode context.
485 * Since essentially the application is creating a decoder config and context,
486 * all function calls that take in the config (e.g. vaQuerySurfaceAttributes())
487 * or context are in relation to the decoder, except those video processing
488 * function specified in the next paragraph.
490 * Once the decode config and context are created, the user must further
491 * query the supported processing filters using vaQueryVideoProcFilters(),
492 * vaQueryVideoProcFilterCaps(), vaQueryVideoProcPipelineCaps() by specifying
493 * the created decode context. The user must provide processing information
494 * and extra processing output surfaces as "additional_outputs" to the driver
495 * through VAProcPipelineParameterBufferType. The render_target specified
496 * at vaBeginPicture() time refers to the decode output surface. The
497 * target surface for the output of processing needs to be a different
498 * surface since the decode process requires the original reconstructed buffer.
499 * The “surface” member of VAProcPipelineParameterBuffer should be set to the
500 * same as “render_target” set in vaBeginPicture(), but the driver may choose
501 * to ignore this parameter.
503 VAConfigAttribDecProcessing = 8,
504 /** @name Attributes for encoding */
507 * \brief Packed headers mode. Read/write.
509 * This attribute determines what packed headers the driver supports,
510 * through vaGetConfigAttributes(); and what packed headers the user
511 * will be providing to the driver, through vaCreateConfig(), if the
512 * driver supports those.
514 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
516 VAConfigAttribEncPackedHeaders = 10,
518 * \brief Interlaced mode. Read/write.
520 * This attribute determines what kind of interlaced encoding mode
521 * the driver supports.
523 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
525 VAConfigAttribEncInterlaced = 11,
527 * \brief Maximum number of reference frames. Read-only.
529 * This attribute determines the maximum number of reference
530 * frames supported for encoding.
532 * Note: for H.264 encoding, the value represents the maximum number
533 * of reference frames for both the reference picture list 0 (bottom
534 * 16 bits) and the reference picture list 1 (top 16 bits).
536 VAConfigAttribEncMaxRefFrames = 13,
538 * \brief Maximum number of slices per frame. Read-only.
540 * This attribute determines the maximum number of slices the
541 * driver can support to encode a single frame.
543 VAConfigAttribEncMaxSlices = 14,
545 * \brief Slice structure. Read-only.
547 * This attribute determines slice structures supported by the
548 * driver for encoding. This attribute is a hint to the user so
549 * that he can choose a suitable surface size and how to arrange
550 * the encoding process of multiple slices per frame.
552 * More specifically, for H.264 encoding, this attribute
553 * determines the range of accepted values to
554 * VAEncSliceParameterBufferH264::macroblock_address and
555 * VAEncSliceParameterBufferH264::num_macroblocks.
557 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
560 VAConfigAttribEncSliceStructure = 15,
562 * \brief Macroblock information. Read-only.
564 * This attribute determines whether the driver supports extra
565 * encoding information per-macroblock. e.g. QP.
567 * More specifically, for H.264 encoding, if the driver returns a non-zero
568 * value for this attribute, this means the application can create
569 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
570 * through VAEncSliceParameterBufferH264::macroblock_info.
572 VAConfigAttribEncMacroblockInfo = 16,
574 * \brief Maximum picture width. Read-only.
576 * This attribute determines the maximum picture width the driver supports
577 * for a given configuration.
579 VAConfigAttribMaxPictureWidth = 18,
581 * \brief Maximum picture height. Read-only.
583 * This attribute determines the maximum picture height the driver supports
584 * for a given configuration.
586 VAConfigAttribMaxPictureHeight = 19,
588 * \brief JPEG encoding attribute. Read-only.
590 * This attribute exposes a number of capabilities of the underlying
591 * JPEG implementation. The attribute value is partitioned into fields as defined in the
592 * VAConfigAttribValEncJPEG union.
594 VAConfigAttribEncJPEG = 20,
596 * \brief Encoding quality range attribute. Read-only.
598 * This attribute conveys whether the driver supports different quality level settings
599 * for encoding. A value less than or equal to 1 means that the encoder only has a single
600 * quality setting, and a value greater than 1 represents the number of quality levels
601 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
603 VAConfigAttribEncQualityRange = 21,
605 * \brief Encoding quantization attribute. Read-only.
607 * This attribute conveys whether the driver supports certain types of quantization methods
608 * for encoding (e.g. trellis). See \c VA_ENC_QUANTIZATION_xxx for the list of quantization methods
610 VAConfigAttribEncQuantization = 22,
612 * \brief Encoding intra refresh attribute. Read-only.
614 * This attribute conveys whether the driver supports certain types of intra refresh methods
615 * for encoding (e.g. adaptive intra refresh or rolling intra refresh).
616 * See \c VA_ENC_INTRA_REFRESH_xxx for intra refresh methods
618 VAConfigAttribEncIntraRefresh = 23,
620 * \brief Encoding skip frame attribute. Read-only.
622 * This attribute conveys whether the driver supports sending skip frame parameters
623 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
624 * externally skipped frames.
626 VAConfigAttribEncSkipFrame = 24,
628 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
630 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
631 * based on user provided ROI rectangles. The attribute value is partitioned into fields
632 * as defined in the VAConfigAttribValEncROI union.
634 * If ROI encoding is supported, the ROI information is passed to the driver using
635 * VAEncMiscParameterTypeROI.
637 VAConfigAttribEncROI = 25,
639 * \brief Encoding extended rate control attribute. Read-only.
641 * This attribute conveys whether the driver supports any extended rate control features
642 * The attribute value is partitioned into fields as defined in the
643 * VAConfigAttribValEncRateControlExt union.
645 VAConfigAttribEncRateControlExt = 26,
647 * \brief Processing rate reporting attribute. Read-only.
649 * This attribute conveys whether the driver supports reporting of
650 * encode/decode processing rate based on certain set of parameters
651 * (i.e. levels, I frame internvals) for a given configuration.
652 * If this is supported, vaQueryProcessingRate() can be used to get
653 * encode or decode processing rate.
654 * See \c VA_PROCESSING_RATE_xxx for encode/decode processing rate
656 VAConfigAttribProcessingRate = 27,
658 * \brief Encoding dirty rectangle. Read-only.
660 * This attribute conveys whether the driver supports dirty rectangle.
661 * encoding, based on user provided ROI rectangles which indicate the rectangular areas
662 * where the content has changed as compared to the previous picture. The regions of the
663 * picture that are not covered by dirty rect rectangles are assumed to have not changed
664 * compared to the previous picture. The encoder may do some optimizations based on
665 * this information. The attribute value returned indicates the number of regions that
666 * are supported. e.g. A value of 0 means dirty rect encoding is not supported. If dirty
667 * rect encoding is supported, the ROI information is passed to the driver using
668 * VAEncMiscParameterTypeDirtyRect.
670 VAConfigAttribEncDirtyRect = 28,
672 * \brief Parallel Rate Control (hierachical B) attribute. Read-only.
674 * This attribute conveys whether the encoder supports parallel rate control.
675 * It is a integer value 0 - unsupported, > 0 - maximum layer supported.
676 * This is the way when hireachical B frames are encoded, multiple independent B frames
677 * on the same layer may be processed at same time. If supported, app may enable it by
678 * setting enable_parallel_brc in VAEncMiscParameterRateControl,and the number of B frames
679 * per layer per GOP will be passed to driver through VAEncMiscParameterParallelRateControl
680 * structure.Currently three layers are defined.
682 VAConfigAttribEncParallelRateControl = 29,
684 * \brief Dynamic Scaling Attribute. Read-only.
686 * This attribute conveys whether encoder is capable to determine dynamic frame
687 * resolutions adaptive to bandwidth utilization and processing power, etc.
688 * It is a boolean value 0 - unsupported, 1 - supported.
689 * If it is supported,for VP9, suggested frame resolution can be retrieved from VACodedBufferVP9Status.
691 VAConfigAttribEncDynamicScaling = 30,
693 * \brief frame size tolerance support
694 * it indicates the tolerance of frame size
696 VAConfigAttribFrameSizeToleranceSupport = 31,
698 * \brief Encode function type for FEI.
700 * This attribute conveys whether the driver supports different function types for encode.
701 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
702 * it is for FEI entry point only.
703 * Default is VA_FEI_FUNCTION_ENC_PAK.
705 VAConfigAttribFEIFunctionType = 32,
707 * \brief Maximum number of FEI MV predictors. Read-only.
709 * This attribute determines the maximum number of MV predictors the driver
710 * can support to encode a single frame. 0 means no MV predictor is supported.
711 * Currently it is for FEI entry point only.
713 VAConfigAttribFEIMVPredictors = 33,
715 * \brief Statistics attribute. Read-only.
717 * This attribute exposes a number of capabilities of the VAEntrypointStats entry
718 * point. The attribute value is partitioned into fields as defined in the
719 * VAConfigAttribValStats union. Currently it is for VAEntrypointStats only.
721 VAConfigAttribStats = 34,
723 * \brief Tile Support Attribute. Read-only.
725 * This attribute conveys whether encoder is capable to support tiles.
726 * If not supported, the tile related parameters sent to encoder, such as
727 * tiling structure, should be ignored. 0 - unsupported, 1 - supported.
729 VAConfigAttribEncTileSupport = 35,
731 * \brief whether accept rouding setting from application. Read-only.
732 * This attribute is for encode quality, if it is report,
733 * application can change the rounding setting by VAEncMiscParameterTypeCustomRoundingControl
735 VAConfigAttribCustomRoundingControl = 36,
737 * \brief Encoding QP info block size attribute. Read-only.
738 * This attribute conveys the block sizes that underlying driver
739 * support for QP info for buffer #VAEncQpBuffer.
741 VAConfigAttribQPBlockSize = 37,
743 VAConfigAttribTypeMax
744 } VAConfigAttribType;
747 * Configuration attributes
748 * If there is more than one value for an attribute, a default
749 * value will be assigned to the attribute if the client does not
750 * specify the attribute when creating a configuration
752 typedef struct _VAConfigAttrib {
753 VAConfigAttribType type;
754 uint32_t value; /* OR'd flags (bits) for this attribute */
757 /** attribute value for VAConfigAttribRTFormat */
758 #define VA_RT_FORMAT_YUV420 0x00000001
759 #define VA_RT_FORMAT_YUV422 0x00000002
760 #define VA_RT_FORMAT_YUV444 0x00000004
761 #define VA_RT_FORMAT_YUV411 0x00000008
762 #define VA_RT_FORMAT_YUV400 0x00000010
763 /** YUV formats with more than 8 bpp */
764 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
766 #define VA_RT_FORMAT_RGB16 0x00010000
767 #define VA_RT_FORMAT_RGB32 0x00020000
768 /* RGBP covers RGBP and BGRP fourcc */
769 #define VA_RT_FORMAT_RGBP 0x00100000
771 * RGB 10-bit packed format with upper 2 bits as alpha channel.
772 * The existing pre-defined fourcc codes can be used to signal
773 * the position of each component for this RT format.
775 #define VA_RT_FORMAT_RGB32_10BPP 0x00200000
776 #define VA_RT_FORMAT_PROTECTED 0x80000000
778 /** @name Attribute values for VAConfigAttribRateControl */
780 /** \brief Driver does not support any form of rate control. */
781 #define VA_RC_NONE 0x00000001
782 /** \brief Constant bitrate. */
783 #define VA_RC_CBR 0x00000002
784 /** \brief Variable bitrate. */
785 #define VA_RC_VBR 0x00000004
786 /** \brief Video conference mode. */
787 #define VA_RC_VCM 0x00000008
788 /** \brief Constant QP. */
789 #define VA_RC_CQP 0x00000010
790 /** \brief Variable bitrate with peak rate higher than average bitrate. */
791 #define VA_RC_VBR_CONSTRAINED 0x00000020
792 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
793 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
794 #define VA_RC_ICQ 0x00000040
795 /** \brief Macroblock based rate control. Per MB control is decided
796 * internally in the encoder. It may be combined with other RC modes, except CQP. */
797 #define VA_RC_MB 0x00000080
798 /** \brief Constant Frame Size, it is used for small tolerent */
799 #define VA_RC_CFS 0x00000100
800 /** \brief Parallel BRC, for hierachical B.
802 * For hierachical B, B frames can be refered by other B frames.
803 * Currently three layers of hierachy are defined:
804 * B0 - regular B, no reference to other B frames.
805 * B1 - reference to only I, P and regular B0 frames.
806 * B2 - reference to any other frames, including B1.
807 * In Hierachical B structure, B frames on the same layer can be processed
808 * simultaneously. And BRC would adjust accordingly. This is so called
810 #define VA_RC_PARALLEL 0x00000200
814 /** @name Attribute values for VAConfigAttribDecSliceMode */
816 /** \brief Driver supports normal mode for slice decoding */
817 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
818 /** \brief Driver supports base mode for slice decoding */
819 #define VA_DEC_SLICE_MODE_BASE 0x00000002
821 /** @name Attribute values for VAConfigAttribDecJPEG */
823 typedef union _VAConfigAttribValDecJPEG {
825 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
826 uint32_t rotation : 4;
827 /** \brief Reserved for future use. */
828 uint32_t reserved : 28;
831 uint32_t va_reserved[VA_PADDING_LOW];
832 } VAConfigAttribValDecJPEG;
833 /** @name Attribute values for VAConfigAttribDecProcessing */
835 /** \brief No decoding + processing in a single decoding call. */
836 #define VA_DEC_PROCESSING_NONE 0x00000000
837 /** \brief Decode + processing in a single decoding call. */
838 #define VA_DEC_PROCESSING 0x00000001
841 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
843 /** \brief Driver does not support any packed headers mode. */
844 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
846 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
848 * Application must provide it to driver once this flag is returned through
849 * vaGetConfigAttributes()
851 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
853 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
855 * Application must provide it to driver once this falg is returned through
856 * vaGetConfigAttributes()
858 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
860 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
862 * Application must provide it to driver once this flag is returned through
863 * vaGetConfigAttributes()
865 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
867 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
870 * This is a deprecated packed header flag, All applications can use
871 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
872 * header data buffer to the driver
874 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
875 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
876 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
879 /** @name Attribute values for VAConfigAttribEncInterlaced */
881 /** \brief Driver does not support interlaced coding. */
882 #define VA_ENC_INTERLACED_NONE 0x00000000
883 /** \brief Driver supports interlaced frame coding. */
884 #define VA_ENC_INTERLACED_FRAME 0x00000001
885 /** \brief Driver supports interlaced field coding. */
886 #define VA_ENC_INTERLACED_FIELD 0x00000002
887 /** \brief Driver supports macroblock adaptive frame field coding. */
888 #define VA_ENC_INTERLACED_MBAFF 0x00000004
889 /** \brief Driver supports picture adaptive frame field coding. */
890 #define VA_ENC_INTERLACED_PAFF 0x00000008
893 /** @name Attribute values for VAConfigAttribEncSliceStructure */
895 /** \brief Driver supports a power-of-two number of rows per slice. */
896 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
897 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
898 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
899 /** \brief Dirver support 1 rows per slice */
900 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
901 /** \brief Dirver support max encoded slice size per slice */
902 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
903 /** \brief Driver supports an arbitrary number of rows per slice. */
904 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
907 /** \brief Attribute value for VAConfigAttribEncJPEG */
908 typedef union _VAConfigAttribValEncJPEG {
910 /** \brief set to 1 for arithmatic coding. */
911 uint32_t arithmatic_coding_mode : 1;
912 /** \brief set to 1 for progressive dct. */
913 uint32_t progressive_dct_mode : 1;
914 /** \brief set to 1 for non-interleaved. */
915 uint32_t non_interleaved_mode : 1;
916 /** \brief set to 1 for differential. */
917 uint32_t differential_mode : 1;
918 uint32_t max_num_components : 3;
919 uint32_t max_num_scans : 4;
920 uint32_t max_num_huffman_tables : 3;
921 uint32_t max_num_quantization_tables : 3;
924 } VAConfigAttribValEncJPEG;
926 /** @name Attribute values for VAConfigAttribEncQuantization */
928 /** \brief Driver does not support special types of quantization */
929 #define VA_ENC_QUANTIZATION_NONE 0x00000000
930 /** \brief Driver supports trellis quantization */
931 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
934 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
936 /** \brief Driver does not support intra refresh */
937 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
938 /** \brief Driver supports column based rolling intra refresh */
939 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
940 /** \brief Driver supports row based rolling intra refresh */
941 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
942 /** \brief Driver supports adaptive intra refresh */
943 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
944 /** \brief Driver supports cyclic intra refresh */
945 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
946 /** \brief Driver supports intra refresh of P frame*/
947 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
948 /** \brief Driver supports intra refresh of B frame */
949 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
950 /** \brief Driver supports intra refresh of multiple reference encoder */
951 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
955 /** \brief Attribute value for VAConfigAttribEncROI */
956 typedef union _VAConfigAttribValEncROI {
958 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
959 uint32_t num_roi_regions : 8;
961 * \brief A flag indicates whether ROI priority is supported
963 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
964 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
965 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
966 * the underlying driver doesn't support ROI priority.
968 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
969 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
971 uint32_t roi_rc_priority_support : 1;
973 * \brief A flag indicates whether ROI delta QP is supported
975 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
976 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
977 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
978 * the underlying driver doesn't support ROI delta QP.
980 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
981 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
983 uint32_t roi_rc_qp_delta_support : 1;
984 uint32_t reserved : 22;
987 } VAConfigAttribValEncROI;
989 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
990 typedef union _VAConfigAttribValEncRateControlExt {
993 * \brief The maximum number of temporal layers minus 1
995 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
996 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
997 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
999 uint32_t max_num_temporal_layers_minus1 : 8;
1002 * /brief support temporal layer bit-rate control flag
1004 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
1005 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
1006 * #VAConfigAttribRateControl == #VA_RC_VBR).
1008 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
1009 * \c max_num_temporal_layers_minus1 is equal to 0
1011 * To use bit-rate control per temporal layer, an application must send the right layer
1012 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
1013 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
1014 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
1015 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
1016 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
1017 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
1018 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
1020 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
1021 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
1022 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
1024 uint32_t temporal_layer_bitrate_control_flag : 1;
1025 uint32_t reserved : 23;
1028 } VAConfigAttribValEncRateControlExt;
1030 /** @name Attribute values for VAConfigAttribProcessingRate. */
1032 /** \brief Driver does not support processing rate report */
1033 #define VA_PROCESSING_RATE_NONE 0x00000000
1034 /** \brief Driver supports encode processing rate report */
1035 #define VA_PROCESSING_RATE_ENCODE 0x00000001
1036 /** \brief Driver supports decode processing rate report */
1037 #define VA_PROCESSING_RATE_DECODE 0x00000002
1040 * if an attribute is not applicable for a given
1041 * profile/entrypoint pair, then set the value to the following
1043 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
1045 /** Get maximum number of profiles supported by the implementation */
1046 int vaMaxNumProfiles (
1050 /** Get maximum number of entrypoints supported by the implementation */
1051 int vaMaxNumEntrypoints (
1055 /** Get maximum number of attributs supported by the implementation */
1056 int vaMaxNumConfigAttributes (
1061 * Query supported profiles
1062 * The caller must provide a "profile_list" array that can hold at
1063 * least vaMaxNumProfile() entries. The actual number of profiles
1064 * returned in "profile_list" is returned in "num_profile".
1066 VAStatus vaQueryConfigProfiles (
1068 VAProfile *profile_list, /* out */
1069 int *num_profiles /* out */
1073 * Query supported entrypoints for a given profile
1074 * The caller must provide an "entrypoint_list" array that can hold at
1075 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
1076 * returned in "entrypoint_list" is returned in "num_entrypoints".
1078 VAStatus vaQueryConfigEntrypoints (
1081 VAEntrypoint *entrypoint_list, /* out */
1082 int *num_entrypoints /* out */
1086 * Get attributes for a given profile/entrypoint pair
1087 * The caller must provide an "attrib_list" with all attributes to be
1088 * retrieved. Upon return, the attributes in "attrib_list" have been
1089 * updated with their value. Unknown attributes or attributes that are
1090 * not supported for the given profile/entrypoint pair will have their
1091 * value set to VA_ATTRIB_NOT_SUPPORTED
1093 VAStatus vaGetConfigAttributes (
1096 VAEntrypoint entrypoint,
1097 VAConfigAttrib *attrib_list, /* in/out */
1101 /** Generic ID type, can be re-typed for specific implementation */
1102 typedef unsigned int VAGenericID;
1104 typedef VAGenericID VAConfigID;
1107 * Create a configuration for the video decode/encode/processing pipeline
1108 * it passes in the attribute list that specifies the attributes it cares
1109 * about, with the rest taking default values.
1111 VAStatus vaCreateConfig (
1114 VAEntrypoint entrypoint,
1115 VAConfigAttrib *attrib_list,
1117 VAConfigID *config_id /* out */
1121 * Free resources associdated with a given config
1123 VAStatus vaDestroyConfig (
1125 VAConfigID config_id
1129 * Query all attributes for a given configuration
1130 * The profile of the configuration is returned in "profile"
1131 * The entrypoint of the configuration is returned in "entrypoint"
1132 * The caller must provide an "attrib_list" array that can hold at least
1133 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1134 * returned in "attrib_list" is returned in "num_attribs"
1136 VAStatus vaQueryConfigAttributes (
1138 VAConfigID config_id,
1139 VAProfile *profile, /* out */
1140 VAEntrypoint *entrypoint, /* out */
1141 VAConfigAttrib *attrib_list,/* out */
1142 int *num_attribs /* out */
1147 * Contexts and Surfaces
1149 * Context represents a "virtual" video decode, encode or video processing
1150 * pipeline. Surfaces are render targets for a given context. The data in the
1151 * surfaces are not accessible to the client except if derived image is supported
1152 * and the internal data format of the surface is implementation specific.
1154 * Surfaces are provided as a hint of what surfaces will be used when the context
1155 * is created through vaCreateContext(). A surface may be used by different contexts
1156 * at the same time as soon as application can make sure the operations are synchronized
1157 * between different contexts, e.g. a surface is used as the output of a decode context
1158 * and the input of a video process context. Surfaces can only be destroyed after all
1159 * contexts using these surfaces have been destroyed.
1161 * Both contexts and surfaces are identified by unique IDs and its
1162 * implementation specific internals are kept opaque to the clients
1165 typedef VAGenericID VAContextID;
1167 typedef VAGenericID VASurfaceID;
1169 #define VA_INVALID_ID 0xffffffff
1170 #define VA_INVALID_SURFACE VA_INVALID_ID
1172 /** \brief Generic value types. */
1174 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1175 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1176 VAGenericValueTypePointer, /**< Generic pointer type */
1177 VAGenericValueTypeFunc /**< Pointer to function */
1178 } VAGenericValueType;
1180 /** \brief Generic function type. */
1181 typedef void (*VAGenericFunc)(void);
1183 /** \brief Generic value. */
1184 typedef struct _VAGenericValue {
1185 /** \brief Value type. See #VAGenericValueType. */
1186 VAGenericValueType type;
1187 /** \brief Value holder. */
1189 /** \brief 32-bit signed integer. */
1191 /** \brief 32-bit float. */
1193 /** \brief Generic pointer. */
1195 /** \brief Pointer to function. */
1200 /** @name Surface attribute flags */
1202 /** \brief Surface attribute is not supported. */
1203 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1204 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1205 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1206 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1207 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1210 /** \brief Surface attribute types. */
1212 VASurfaceAttribNone = 0,
1214 * \brief Pixel format (fourcc).
1216 * The value is meaningful as input to vaQuerySurfaceAttributes().
1217 * If zero, the driver returns the optimal pixel format for the
1218 * specified config. Otherwise, if non-zero, the value represents
1219 * a pixel format (FOURCC) that is kept as is on output, if the
1220 * driver supports it. Otherwise, the driver sets the value to
1221 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1223 VASurfaceAttribPixelFormat,
1224 /** \brief Minimal width in pixels (int, read-only). */
1225 VASurfaceAttribMinWidth,
1226 /** \brief Maximal width in pixels (int, read-only). */
1227 VASurfaceAttribMaxWidth,
1228 /** \brief Minimal height in pixels (int, read-only). */
1229 VASurfaceAttribMinHeight,
1230 /** \brief Maximal height in pixels (int, read-only). */
1231 VASurfaceAttribMaxHeight,
1232 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1233 VASurfaceAttribMemoryType,
1234 /** \brief External buffer descriptor (pointer, write). */
1235 VASurfaceAttribExternalBufferDescriptor,
1236 /** \brief Surface usage hint, gives the driver a hint of intended usage
1237 * to optimize allocation (e.g. tiling) (int, read/write). */
1238 VASurfaceAttribUsageHint,
1239 /** \brief Number of surface attributes. */
1240 VASurfaceAttribCount
1241 } VASurfaceAttribType;
1243 /** \brief Surface attribute. */
1244 typedef struct _VASurfaceAttrib {
1246 VASurfaceAttribType type;
1247 /** \brief Flags. See "Surface attribute flags". */
1249 /** \brief Value. See "Surface attribute types" for the expected types. */
1250 VAGenericValue value;
1254 * @name VASurfaceAttribMemoryType values in bit fields.
1255 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1256 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1257 * types are defined in DRM and Android header files.
1260 /** \brief VA memory type (default) is supported. */
1261 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1262 /** \brief V4L2 buffer memory type is supported. */
1263 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1264 /** \brief User pointer memory type is supported. */
1265 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1269 * \brief VASurfaceAttribExternalBuffers structure for
1270 * the VASurfaceAttribExternalBufferDescriptor attribute.
1272 typedef struct _VASurfaceAttribExternalBuffers {
1273 /** \brief pixel format in fourcc. */
1274 uint32_t pixel_format;
1275 /** \brief width in pixels. */
1277 /** \brief height in pixels. */
1279 /** \brief total size of the buffer in bytes. */
1281 /** \brief number of planes for planar layout */
1282 uint32_t num_planes;
1283 /** \brief pitch for each plane in bytes */
1284 uint32_t pitches[4];
1285 /** \brief offset for each plane in bytes */
1286 uint32_t offsets[4];
1287 /** \brief buffer handles or user pointers */
1289 /** \brief number of elements in the "buffers" array */
1290 uint32_t num_buffers;
1291 /** \brief flags. See "Surface external buffer descriptor flags". */
1293 /** \brief reserved for passing private data */
1295 } VASurfaceAttribExternalBuffers;
1297 /** @name VASurfaceAttribExternalBuffers flags */
1299 /** \brief Enable memory tiling */
1300 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1301 /** \brief Memory is cacheable */
1302 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1303 /** \brief Memory is non-cacheable */
1304 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1305 /** \brief Memory is write-combined */
1306 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1307 /** \brief Memory is protected */
1308 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1310 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1312 /** \brief Surface usage not indicated. */
1313 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1314 /** \brief Surface used by video decoder. */
1315 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1316 /** \brief Surface used by video encoder. */
1317 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1318 /** \brief Surface read by video post-processing. */
1319 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1320 /** \brief Surface written by video post-processing. */
1321 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1322 /** \brief Surface used for display. */
1323 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1328 * \brief Queries surface attributes for the supplied config.
1330 * This function queries for all supported attributes for the
1331 * supplied VA @config. In particular, if the underlying hardware
1332 * supports the creation of VA surfaces in various formats, then
1333 * this function will enumerate all pixel formats that are supported.
1335 * The \c attrib_list array is allocated by the user and \c
1336 * num_attribs shall be initialized to the number of allocated
1337 * elements in that array. Upon successful return, the actual number
1338 * of attributes will be overwritten into \c num_attribs. Otherwise,
1339 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1340 * is adjusted to the number of elements that would be returned if
1341 * enough space was available.
1343 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1344 * argument when vaQuerySurfaceAttributes() is used to determine the
1345 * actual number of elements that need to be allocated.
1347 * @param[in] dpy the VA display
1348 * @param[in] config the config identifying a codec or a video
1349 * processing pipeline
1350 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1351 * @param[in,out] num_attribs the number of elements allocated on
1352 * input, the number of elements actually filled in output
1355 vaQuerySurfaceAttributes(
1358 VASurfaceAttrib *attrib_list,
1359 unsigned int *num_attribs
1363 * \brief Creates an array of surfaces
1365 * Creates an array of surfaces. The optional list of attributes shall
1366 * be constructed based on what the underlying hardware could expose
1367 * through vaQuerySurfaceAttributes().
1369 * @param[in] dpy the VA display
1370 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1371 * @param[in] width the surface width
1372 * @param[in] height the surface height
1373 * @param[out] surfaces the array of newly created surfaces
1374 * @param[in] num_surfaces the number of surfaces to create
1375 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1376 * @param[in] num_attribs the number of attributes supplied in
1377 * \c attrib_list, or zero
1382 unsigned int format,
1384 unsigned int height,
1385 VASurfaceID *surfaces,
1386 unsigned int num_surfaces,
1387 VASurfaceAttrib *attrib_list,
1388 unsigned int num_attribs
1392 * vaDestroySurfaces - Destroy resources associated with surfaces.
1393 * Surfaces can only be destroyed after all contexts using these surfaces have been
1396 * surfaces: array of surfaces to destroy
1397 * num_surfaces: number of surfaces in the array to be destroyed.
1399 VAStatus vaDestroySurfaces (
1401 VASurfaceID *surfaces,
1405 #define VA_PROGRESSIVE 0x1
1407 * vaCreateContext - Create a context
1409 * config_id: configuration for the context
1410 * picture_width: coded picture width
1411 * picture_height: coded picture height
1412 * flag: any combination of the following:
1413 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1414 * render_targets: a hint for render targets (surfaces) tied to the context
1415 * num_render_targets: number of render targets in the above array
1416 * context: created context id upon return
1418 VAStatus vaCreateContext (
1420 VAConfigID config_id,
1424 VASurfaceID *render_targets,
1425 int num_render_targets,
1426 VAContextID *context /* out */
1430 * vaDestroyContext - Destroy a context
1432 * context: context to be destroyed
1434 VAStatus vaDestroyContext (
1439 //Multi-frame context
1440 typedef VAGenericID VAMFContextID;
1442 * vaCreateMFContext - Create a multi-frame context
1443 * interface encapsulating common for all streams memory objects and structures
1444 * required for single GPU task submission from several VAContextID's.
1445 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1446 * Support identification: Application can identify multi-frame feature support by ability
1447 * to create multi-frame context. If driver supports multi-frame - call successful,
1448 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1449 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1451 * VA_STATUS_SUCCESS - operation successful.
1452 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1453 * dpy: display adapter.
1454 * mf_context: Multi-Frame context encapsulating all associated context
1455 * for multi-frame submission.
1457 VAStatus vaCreateMFContext (
1459 VAMFContextID *mf_context /* out */
1463 * vaMFAddContext - Provide ability to associate each context used for
1464 * Multi-Frame submission and common Multi-Frame context.
1465 * Try to add context to understand if it is supported.
1466 * Allocation: this call allocates and/or reallocates all memory objects
1467 * common for all contexts associated with particular Multi-Frame context.
1468 * All memory required for each context(pixel buffers, internal driver
1469 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1470 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1471 * first context added will set entry point/profile for whole Multi-Frame context,
1472 * all other entry points and profiles can be rejected to be added.
1474 * VA_STATUS_SUCCESS - operation successful, context was added.
1475 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1476 * current mf_context and associated contexts and start working with new ones.
1477 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1478 * 1 - mf_context is not valid context or
1479 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1480 * and current context contradicts with previously added, application can continue with current mf_context
1481 * and other contexts passed this call, rejected context can continue work in stand-alone
1482 * mode or other mf_context.
1483 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1484 * unsupported VAEntrypoint. Application can continue with current mf_context
1485 * and other contexts passed this call, rejected context can continue work in stand-alone
1487 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1488 * but VAProfile is not supported. Application can continue with current mf_context
1489 * and other contexts passed this call, rejected context can continue work in stand-alone
1491 * dpy: display adapter.
1492 * context: context being associated with Multi-Frame context.
1493 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1495 VAStatus vaMFAddContext (
1497 VAMFContextID mf_context,
1502 * vaMFReleaseContext - Removes context from multi-frame and
1503 * association with multi-frame context.
1504 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1506 * VA_STATUS_SUCCESS - operation successful, context was removed.
1507 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1508 * application need to destroy this VAMFContextID and all assotiated VAContextID
1510 * mf_context: VAMFContextID where context is added
1511 * context: VAContextID to be added
1513 VAStatus vaMFReleaseContext (
1515 VAMFContextID mf_context,
1521 * Buffers are used to pass various types of data from the
1522 * client to the server. The server maintains a data store
1523 * for each buffer created, and the client idenfies a buffer
1524 * through a unique buffer id assigned by the server.
1527 typedef VAGenericID VABufferID;
1531 VAPictureParameterBufferType = 0,
1532 VAIQMatrixBufferType = 1,
1533 VABitPlaneBufferType = 2,
1534 VASliceGroupMapBufferType = 3,
1535 VASliceParameterBufferType = 4,
1536 VASliceDataBufferType = 5,
1537 VAMacroblockParameterBufferType = 6,
1538 VAResidualDataBufferType = 7,
1539 VADeblockingParameterBufferType = 8,
1540 VAImageBufferType = 9,
1541 VAProtectedSliceDataBufferType = 10,
1542 VAQMatrixBufferType = 11,
1543 VAHuffmanTableBufferType = 12,
1544 VAProbabilityBufferType = 13,
1546 /* Following are encode buffer types */
1547 VAEncCodedBufferType = 21,
1548 VAEncSequenceParameterBufferType = 22,
1549 VAEncPictureParameterBufferType = 23,
1550 VAEncSliceParameterBufferType = 24,
1551 VAEncPackedHeaderParameterBufferType = 25,
1552 VAEncPackedHeaderDataBufferType = 26,
1553 VAEncMiscParameterBufferType = 27,
1554 VAEncMacroblockParameterBufferType = 28,
1555 VAEncMacroblockMapBufferType = 29,
1558 * \brief Encoding QP buffer
1560 * This buffer contains QP per MB for encoding. Currently
1561 * VAEncQPBufferH264 is defined for H.264 encoding, see
1562 * #VAEncQPBufferH264 for details
1564 VAEncQPBufferType = 30,
1565 /* Following are video processing buffer types */
1567 * \brief Video processing pipeline parameter buffer.
1569 * This buffer describes the video processing pipeline. See
1570 * #VAProcPipelineParameterBuffer for details.
1572 VAProcPipelineParameterBufferType = 41,
1574 * \brief Video filter parameter buffer.
1576 * This buffer describes the video filter parameters. All buffers
1577 * inherit from #VAProcFilterParameterBufferBase, thus including
1578 * a unique filter buffer type.
1580 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1581 * Filters requiring advanced parameters include, but are not limited to,
1582 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1583 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1585 VAProcFilterParameterBufferType = 42,
1587 * \brief FEI specific buffer types
1589 VAEncFEIMVBufferType = 43,
1590 VAEncFEIMBCodeBufferType = 44,
1591 VAEncFEIDistortionBufferType = 45,
1592 VAEncFEIMBControlBufferType = 46,
1593 VAEncFEIMVPredictorBufferType = 47,
1594 VAStatsStatisticsParameterBufferType = 48,
1595 /** \brief Statistics output for VAEntrypointStats progressive and top field of interlaced case*/
1596 VAStatsStatisticsBufferType = 49,
1597 /** \brief Statistics output for VAEntrypointStats bottom field of interlaced case*/
1598 VAStatsStatisticsBottomFieldBufferType = 50,
1599 VAStatsMVBufferType = 51,
1600 VAStatsMVPredictorBufferType = 52,
1601 /** Force MB's to be non skip for encode.it's per-mb control buffer, The width of the MB map
1602 * Surface is (width of the Picture in MB unit) * 1 byte, multiple of 64 bytes.
1603 * The height is (height of the picture in MB unit). The picture is either
1604 * frame or non-interleaved top or bottom field. If the application provides this
1605 *surface, it will override the "skipCheckDisable" setting in VAEncMiscParameterEncQuality.
1607 VAEncMacroblockDisableSkipMapBufferType = 53,
1609 * \brief HEVC FEI CTB level cmd buffer
1610 * it is CTB level information for future usage.
1612 VAEncFEICTBCmdBufferType = 54,
1614 * \brief HEVC FEI CU level data buffer
1615 * it's CTB level information for future usage
1617 VAEncFEICURecordBufferType = 55,
1618 /** decode stream out buffer, intermedia data of decode, it may include MV, MB mode etc.
1619 * it can be used to detect motion and analyze the frame contain */
1620 VADecodeStreamoutBufferType = 56,
1625 * Processing rate parameter for encode.
1627 typedef struct _VAProcessingRateParameterEnc {
1628 /** \brief Profile level */
1630 uint8_t reserved[3];
1631 /** \brief quality level. When set to 0, default quality
1634 uint32_t quality_level;
1635 /** \brief Period between I frames. */
1636 uint32_t intra_period;
1637 /** \brief Period between I/P frames. */
1639 } VAProcessingRateParameterEnc;
1642 * Processing rate parameter for decode.
1644 typedef struct _VAProcessingRateParameterDec {
1645 /** \brief Profile level */
1647 uint8_t reserved0[3];
1649 } VAProcessingRateParameterDec;
1651 typedef struct _VAProcessingRateParameter {
1653 VAProcessingRateParameterEnc proc_buf_enc;
1654 VAProcessingRateParameterDec proc_buf_dec;
1656 } VAProcessingRateParameter;
1659 * \brief Queries processing rate for the supplied config.
1661 * This function queries the processing rate based on parameters in
1662 * \c proc_buf for the given \c config. Upon successful return, the processing
1663 * rate value will be stored in \c processing_rate. Processing rate is
1664 * specified as the number of macroblocks/CTU per second.
1666 * If NULL is passed to the \c proc_buf, the default processing rate for the
1667 * given configuration will be returned.
1669 * @param[in] dpy the VA display
1670 * @param[in] config the config identifying a codec or a video
1671 * processing pipeline
1672 * @param[in] proc_buf the buffer that contains the parameters for
1673 either the encode or decode processing rate
1674 * @param[out] processing_rate processing rate in number of macroblocks per
1675 second constrained by parameters specified in proc_buf
1679 vaQueryProcessingRate(
1682 VAProcessingRateParameter *proc_buf,
1683 unsigned int *processing_rate
1688 VAEncMiscParameterTypeFrameRate = 0,
1689 VAEncMiscParameterTypeRateControl = 1,
1690 VAEncMiscParameterTypeMaxSliceSize = 2,
1691 VAEncMiscParameterTypeAIR = 3,
1692 /** \brief Buffer type used to express a maximum frame size (in bits). */
1693 VAEncMiscParameterTypeMaxFrameSize = 4,
1694 /** \brief Buffer type used for HRD parameters. */
1695 VAEncMiscParameterTypeHRD = 5,
1696 VAEncMiscParameterTypeQualityLevel = 6,
1697 /** \brief Buffer type used for Rolling intra refresh */
1698 VAEncMiscParameterTypeRIR = 7,
1699 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1700 VAEncMiscParameterTypeQuantization = 8,
1701 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1702 * rate control, when the user has externally skipped frames. */
1703 VAEncMiscParameterTypeSkipFrame = 9,
1704 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1705 VAEncMiscParameterTypeROI = 10,
1706 /** \brief Buffer type used for temporal layer structure */
1707 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1708 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1709 VAEncMiscParameterTypeDirtyRect = 13,
1710 /** \brief Buffer type used for parallel BRC parameters. */
1711 VAEncMiscParameterTypeParallelBRC = 14,
1712 /** \brief Set MB partion mode mask and Half-pel/Quant-pel motion search */
1713 VAEncMiscParameterTypeSubMbPartPel = 15,
1714 /** \brief set encode quality tuning */
1715 VAEncMiscParameterTypeEncQuality = 16,
1716 /** \brief Buffer type used for encoder rounding offset parameters. */
1717 VAEncMiscParameterTypeCustomRoundingControl = 17,
1718 /** \brief Buffer type used for FEI input frame level parameters */
1719 VAEncMiscParameterTypeFEIFrameControl = 18,
1720 /** \brief encode extension buffer, ect. MPEG2 Sequence extenstion data */
1721 VAEncMiscParameterTypeExtensionData = 19
1722 } VAEncMiscParameterType;
1724 /** \brief Packed header type. */
1726 /** \brief Packed sequence header. */
1727 VAEncPackedHeaderSequence = 1,
1728 /** \brief Packed picture header. */
1729 VAEncPackedHeaderPicture = 2,
1730 /** \brief Packed slice header. */
1731 VAEncPackedHeaderSlice = 3,
1733 * \brief Packed raw header.
1735 * Packed raw data header can be used by the client to insert a header
1736 * into the bitstream data buffer at the point it is passed, the driver
1737 * will handle the raw packed header based on "has_emulation_bytes" field
1738 * in the packed header parameter structure.
1740 VAEncPackedHeaderRawData = 4,
1742 * \brief Misc packed header. See codec-specific definitions.
1745 * This is a deprecated packed header type. All applications can use
1746 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1748 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1749 } VAEncPackedHeaderType;
1751 /** \brief Packed header parameter. */
1752 typedef struct _VAEncPackedHeaderParameterBuffer {
1753 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1755 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1756 uint32_t bit_length;
1757 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1758 uint8_t has_emulation_bytes;
1760 /** \brief Reserved bytes for future use, must be zero */
1761 uint32_t va_reserved[VA_PADDING_LOW];
1762 } VAEncPackedHeaderParameterBuffer;
1765 * For application, e.g. set a new bitrate
1766 * VABufferID buf_id;
1767 * VAEncMiscParameterBuffer *misc_param;
1768 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1770 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1771 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1772 * 1, NULL, &buf_id);
1774 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1775 * misc_param->type = VAEncMiscParameterTypeRateControl;
1776 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1777 * misc_rate_ctrl->bits_per_second = 6400000;
1778 * vaUnmapBuffer(dpy, buf_id);
1779 * vaRenderPicture(dpy, context, &buf_id, 1);
1781 typedef struct _VAEncMiscParameterBuffer
1783 VAEncMiscParameterType type;
1785 } VAEncMiscParameterBuffer;
1787 /** \brief Temporal layer Structure*/
1788 typedef struct _VAEncMiscParameterTemporalLayerStructure
1790 /** \brief The number of temporal layers */
1791 uint32_t number_of_layers;
1792 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1793 uint32_t periodicity;
1795 * \brief The array indicating the layer id for each frame
1797 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1798 * ids for frames starting from the 2nd frame.
1800 uint32_t layer_id[32];
1802 /** \brief Reserved bytes for future use, must be zero */
1803 uint32_t va_reserved[VA_PADDING_LOW];
1804 } VAEncMiscParameterTemporalLayerStructure;
1807 /** \brief Rate control parameters */
1808 typedef struct _VAEncMiscParameterRateControl
1810 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1811 uint32_t bits_per_second;
1812 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1813 * bit-rate for example if target_percentage is 95 then the rate control will target
1814 * a bit-rate that is 95% of the maximum bit-rate
1816 uint32_t target_percentage;
1817 /* windows size in milliseconds. For example if this is set to 500,
1818 * then the rate control will guarantee the target bit-rate over a 500 ms window
1820 uint32_t window_size;
1821 /* initial QP at I frames */
1822 uint32_t initial_qp;
1824 uint32_t basic_unit_size;
1830 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1831 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1832 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1834 * The temporal layer that the rate control parameters are specified for.
1836 uint32_t temporal_id : 8;
1837 uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1838 uint32_t enable_parallel_brc : 1;
1839 uint32_t enable_dynamic_scaling : 1;
1840 /** \brief Frame Tolerance Mode
1841 * Indicates the tolerance the application has to variations in the frame size.
1842 * For example, wireless display scenarios may require very steady bit rate to
1843 * reduce buffering time. It affects the rate control algorithm used,
1844 * but may or may not have an effect based on the combination of other BRC
1845 * parameters. Only valid when the driver reports support for
1846 * #VAConfigAttribFrameSizeToleranceSupport.
1848 * equals 0 -- normal mode;
1849 * equals 1 -- maps to sliding window;
1850 * equals 2 -- maps to low delay mode;
1853 uint32_t frame_tolerance_mode : 2;
1854 uint32_t reserved : 12;
1858 uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1859 /** \brief Reserved bytes for future use, must be zero */
1861 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1862 } VAEncMiscParameterRateControl;
1864 typedef struct _VAEncMiscParameterFrameRate
1867 * The framerate is specified as a number of frames per second, as a
1868 * fraction. The denominator of the fraction is given in the top half
1869 * (the high two bytes) of the framerate field, and the numerator is
1870 * given in the bottom half (the low two bytes).
1873 * denominator = framerate >> 16 & 0xffff;
1874 * numerator = framerate & 0xffff;
1875 * fps = numerator / denominator;
1877 * For example, if framerate is set to (100 << 16 | 750), this is
1878 * 750 / 100, hence 7.5fps.
1880 * If the denominator is zero (the high two bytes are both zero) then
1881 * it takes the value one instead, so the framerate is just the integer
1882 * in the low 2 bytes.
1890 * The temporal id the framerate parameters are specified for.
1892 uint32_t temporal_id : 8;
1893 uint32_t reserved : 24;
1898 /** \brief Reserved bytes for future use, must be zero */
1899 uint32_t va_reserved[VA_PADDING_LOW];
1900 } VAEncMiscParameterFrameRate;
1903 * Allow a maximum slice size to be specified (in bits).
1904 * The encoder will attempt to make sure that individual slices do not exceed this size
1905 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1907 typedef struct _VAEncMiscParameterMaxSliceSize
1909 uint32_t max_slice_size;
1911 /** \brief Reserved bytes for future use, must be zero */
1912 uint32_t va_reserved[VA_PADDING_LOW];
1913 } VAEncMiscParameterMaxSliceSize;
1915 typedef struct _VAEncMiscParameterAIR
1917 uint32_t air_num_mbs;
1918 uint32_t air_threshold;
1919 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1921 /** \brief Reserved bytes for future use, must be zero */
1922 uint32_t va_reserved[VA_PADDING_LOW];
1923 } VAEncMiscParameterAIR;
1926 * \brief Rolling intra refresh data structure for encoding.
1928 typedef struct _VAEncMiscParameterRIR
1934 * \brief Indicate if intra refresh is enabled in column/row.
1936 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1937 * by the driver before sending this structure.
1940 /* \brief enable RIR in column */
1941 uint32_t enable_rir_column : 1;
1942 /* \brief enable RIR in row */
1943 uint32_t enable_rir_row : 1;
1944 uint32_t reserved : 30;
1949 * \brief Indicates the column or row location in MB. It is ignored if
1952 uint16_t intra_insertion_location;
1954 * \brief Indicates the number of columns or rows in MB. It is ignored if
1957 uint16_t intra_insert_size;
1959 * \brief indicates the Qp difference for inserted intra columns or rows.
1960 * App can use this to adjust intra Qp based on bitrate & max frame size.
1962 uint8_t qp_delta_for_inserted_intra;
1963 /** \brief Reserved bytes for future use, must be zero */
1964 uint32_t va_reserved[VA_PADDING_LOW];
1965 } VAEncMiscParameterRIR;
1967 typedef struct _VAEncMiscParameterHRD
1969 uint32_t initial_buffer_fullness; /* in bits */
1970 uint32_t buffer_size; /* in bits */
1972 /** \brief Reserved bytes for future use, must be zero */
1973 uint32_t va_reserved[VA_PADDING_LOW];
1974 } VAEncMiscParameterHRD;
1977 * \brief Defines a maximum frame size (in bits).
1979 * This misc parameter buffer defines the maximum size of a frame (in
1980 * bits). The encoder will try to make sure that each frame does not
1981 * exceed this size. Otherwise, if the frame size exceeds this size,
1982 * the \c status flag of #VACodedBufferSegment will contain
1983 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1985 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1986 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1987 VAEncMiscParameterType type;
1988 /** \brief Maximum size of a frame (in bits). */
1989 uint32_t max_frame_size;
1991 /** \brief Reserved bytes for future use, must be zero */
1992 uint32_t va_reserved[VA_PADDING_LOW];
1993 } VAEncMiscParameterBufferMaxFrameSize;
1996 * \brief Encoding quality level.
1998 * The encoding quality could be set through this structure, if the implementation
1999 * supports multiple quality levels. The quality level set through this structure is
2000 * persistent over the entire coded sequence, or until a new structure is being sent.
2001 * The quality level range can be queried through the VAConfigAttribEncQualityRange
2002 * attribute. A lower value means higher quality, and a value of 1 represents the highest
2003 * quality. The quality level setting is used as a trade-off between quality and speed/power
2004 * consumption, with higher quality corresponds to lower speed and higher power consumption.
2006 typedef struct _VAEncMiscParameterBufferQualityLevel {
2007 /** \brief Encoding quality level setting. When set to 0, default quality
2010 uint32_t quality_level;
2012 /** \brief Reserved bytes for future use, must be zero */
2013 uint32_t va_reserved[VA_PADDING_LOW];
2014 } VAEncMiscParameterBufferQualityLevel;
2017 * \brief Quantization settings for encoding.
2019 * Some encoders support special types of quantization such as trellis, and this structure
2020 * can be used by the app to control these special types of quantization by the encoder.
2022 typedef struct _VAEncMiscParameterQuantization
2026 /* if no flags is set then quantization is determined by the driver */
2029 /* \brief disable trellis for all frames/fields */
2030 uint64_t disable_trellis : 1;
2031 /* \brief enable trellis for I frames/fields */
2032 uint64_t enable_trellis_I : 1;
2033 /* \brief enable trellis for P frames/fields */
2034 uint64_t enable_trellis_P : 1;
2035 /* \brief enable trellis for B frames/fields */
2036 uint64_t enable_trellis_B : 1;
2037 uint64_t reserved : 28;
2040 } quantization_flags;
2041 } VAEncMiscParameterQuantization;
2044 * \brief Encoding skip frame.
2046 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
2047 * code as all skip's). For rate control purposes the encoder will need to know the size and number
2048 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
2049 * current frame. It is allowed for the application to still send in packed headers for the driver to
2050 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
2052 typedef struct _VAEncMiscParameterSkipFrame {
2053 /** \brief Indicates skip frames as below.
2054 * 0: Encode as normal, no skip.
2055 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
2056 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
2057 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
2058 * in VAEncPackedHeaderPicture). */
2059 uint8_t skip_frame_flag;
2060 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
2061 uint8_t num_skip_frames;
2062 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
2063 * the size of the current skipped frame that is to be packed/encrypted in bits. */
2064 uint32_t size_skip_frames;
2066 /** \brief Reserved bytes for future use, must be zero */
2067 uint32_t va_reserved[VA_PADDING_LOW];
2068 } VAEncMiscParameterSkipFrame;
2071 * \brief Encoding region-of-interest (ROI).
2073 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
2074 * supports ROI input. The ROI set through this structure is applicable only to the
2075 * current frame or field, so must be sent every frame or field to be applied. The number of
2076 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
2077 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
2079 typedef struct _VAEncROI
2081 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
2082 * codec coding units. It is relative to frame coordinates for the frame case and
2083 * to field coordinates for the field case. */
2084 VARectangle roi_rectangle;
2088 * \ref roi_value specifies ROI delta QP or ROI priority.
2089 * -- ROI delta QP is the value that will be added on top of the frame level QP.
2090 * -- ROI priority specifies the priority of a region, it can be positive (more important)
2091 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2092 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2093 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2094 * regions, the roi_value that is first in the ROI array will have priority.
2096 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2097 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2099 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2100 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2101 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2106 typedef struct _VAEncMiscParameterBufferROI {
2107 /** \brief Number of ROIs being sent.*/
2110 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2111 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
2113 int8_t max_delta_qp;
2114 int8_t min_delta_qp;
2116 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
2117 * coordinates for the frame case and to field coordinates for the field case.*/
2122 * \brief An indication for roi value.
2124 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2125 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2126 * in #VAEncROI should be used as ROI priority.
2128 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2129 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2130 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2131 * when VAConfigAttribRateControl == VA_RC_CQP.
2133 uint32_t roi_value_is_qp_delta : 1;
2134 uint32_t reserved : 31;
2139 /** \brief Reserved bytes for future use, must be zero */
2140 uint32_t va_reserved[VA_PADDING_LOW];
2141 } VAEncMiscParameterBufferROI;
2143 * \brief Dirty rectangle data structure for encoding.
2145 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2146 * implementation supports dirty rect input. The rect set through this structure is applicable
2147 * only to the current frame or field, so must be sent every frame or field to be applied.
2148 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
2149 * encoder will use the rect information to know those rectangle areas have changed while the
2150 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2151 * previous picture. The encoder may do some internal optimizations.
2153 typedef struct _VAEncMiscParameterBufferDirtyRect
2155 /** \brief Number of Rectangle being sent.*/
2156 uint32_t num_roi_rectangle;
2158 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2159 VARectangle *roi_rectangle;
2160 } VAEncMiscParameterBufferDirtyRect;
2162 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2163 typedef struct _VAEncMiscParameterParallelRateControl {
2164 /** brief Number of layers*/
2165 uint32_t num_layers;
2166 /** brief Number of B frames per layer per GOP.
2168 * it should be allocated by application, and the is num_layers.
2169 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2170 uint32_t *num_b_in_gop;
2171 } VAEncMiscParameterParallelRateControl;
2173 /** per frame encoder quality controls, once set they will persist for all future frames
2174 *till it is updated again. */
2175 typedef struct _VAEncMiscParameterEncQuality
2181 /** Use raw frames for reference instead of reconstructed frames.
2182 * it only impact motion estimation (ME) stage, and will not impact MC stage
2183 * so the reconstruct picture will can match with decode side */
2184 uint32_t useRawPicForRef : 1;
2185 /** Disables skip check for ME stage, it will increase the bistream size
2186 * but will improve the qulity */
2187 uint32_t skipCheckDisable : 1;
2188 /** Indicates app will override default driver FTQ settings using FTQEnable.
2189 * FTQ is forward transform quantization */
2190 uint32_t FTQOverride : 1;
2191 /** Enables/disables FTQ. */
2192 uint32_t FTQEnable : 1;
2193 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2194 * enabled (FTQSkipThresholdLUT), else default driver thresholds will be used. */
2195 uint32_t FTQSkipThresholdLUTInput : 1;
2196 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2197 * disabled (NonFTQSkipThresholdLUT), else default driver thresholds will be used. */
2198 uint32_t NonFTQSkipThresholdLUTInput : 1;
2199 uint32_t ReservedBit : 1;
2200 /** Control to enable the ME mode decision algorithm to bias to fewer B Direct/Skip types.
2201 * Applies only to B frames, all other frames will ignore this setting. */
2202 uint32_t directBiasAdjustmentEnable : 1;
2203 /** Enables global motion bias. global motion also is called HME (Heirarchical Motion Estimation )
2204 * HME is used to handle large motions and avoiding local minima in the video encoding process
2205 * down scaled the input and reference picture, then do ME. the result will be a predictor to next level HME or ME
2206 * current interface divide the HME to 3 level. UltraHME , SuperHME, and HME, result of UltraHME will be input of SurperHME,
2207 * result of superHME will be a input for HME. HME result will be input of ME. it is a switch for HMEMVCostScalingFactor
2208 * can change the HME bias inside RDO stage*/
2209 uint32_t globalMotionBiasAdjustmentEnable : 1;
2210 /** MV cost scaling ratio for HME ( predictors. It is used when
2211 * globalMotionBiasAdjustmentEnable == 1, else it is ignored. Values are:
2212 * 0: set MV cost to be 0 for HME predictor.
2213 * 1: scale MV cost to be 1/2 of the default value for HME predictor.
2214 * 2: scale MV cost to be 1/4 of the default value for HME predictor.
2215 * 3: scale MV cost to be 1/8 of the default value for HME predictor. */
2216 uint32_t HMEMVCostScalingFactor : 2;
2217 /**disable HME, if it is disabled. Super*ultraHME should also be disabled */
2218 uint32_t HMEDisable : 1;
2219 /**disable Super HME, if it is disabled, ultraHME should be disabled */
2220 uint32_t SuperHMEDisable : 1;
2221 /** disable Ultra HME */
2222 uint32_t UltraHMEDisable : 1;
2223 /** disable panic mode. Panic mode happened when there are extreme BRC (bit rate control) requirement
2224 * frame size cant achieve the target of BRC. when Panic mode is triggered, Coefficients will
2225 * be set to zero. disable panic mode will improve quality but will impact BRC */
2226 uint32_t PanicModeDisable : 1;
2227 /** Force RepartitionCheck
2228 * 0: DEFAULT - follow driver default settings.
2229 * 1: FORCE_ENABLE - enable this feature totally for all cases.
2230 * 2: FORCE_DISABLE - disable this feature totally for all cases. */
2231 uint32_t ForceRepartitionCheck : 2;
2234 uint32_t encControls;
2237 /** Maps QP to skip thresholds when FTQ is enabled. Valid range is 0-255. */
2238 uint8_t FTQSkipThresholdLUT[52];
2239 /** Maps QP to skip thresholds when FTQ is disabled. Valid range is 0-65535. */
2240 uint16_t NonFTQSkipThresholdLUT[52];
2242 uint32_t reserved[VA_PADDING_HIGH]; // Reserved for future use.
2244 } VAEncMiscParameterEncQuality;
2247 * \brief Custom Encoder Rounding Offset Control.
2248 * Application may use this structure to set customized rounding
2249 * offset parameters for quantization.
2250 * Valid when \c VAConfigAttribCustomRoundingControl equals 1.
2252 typedef struct _VAEncMiscParameterCustomRoundingControl
2256 /** \brief Enable customized rounding offset for intra blocks.
2257 * If 0, default value would be taken by driver for intra
2260 uint32_t enable_custom_rouding_intra : 1 ;
2262 /** \brief Intra rounding offset
2263 * Ignored if \c enable_custom_rouding_intra equals 0.
2265 uint32_t rounding_offset_intra : 7;
2267 /** \brief Enable customized rounding offset for inter blocks.
2268 * If 0, default value would be taken by driver for inter
2271 uint32_t enable_custom_rounding_inter : 1 ;
2273 /** \brief Inter rounding offset
2274 * Ignored if \c enable_custom_rouding_inter equals 0.
2276 uint32_t rounding_offset_inter : 7;
2279 uint32_t reserved :16;
2282 } rounding_offset_setting;
2283 } VAEncMiscParameterCustomRoundingControl;
2285 * There will be cases where the bitstream buffer will not have enough room to hold
2286 * the data for the entire slice, and the following flags will be used in the slice
2287 * parameter to signal to the server for the possible cases.
2288 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2289 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2290 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2292 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2293 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2294 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2295 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2297 /* Codec-independent Slice Parameter Buffer base */
2298 typedef struct _VASliceParameterBufferBase
2300 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2301 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2302 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2303 } VASliceParameterBufferBase;
2305 /**********************************
2306 * JPEG common data structures
2307 **********************************/
2309 * \brief Huffman table for JPEG decoding.
2311 * This structure holds the complete Huffman tables. This is an
2312 * aggregation of all Huffman table (DHT) segments maintained by the
2313 * application. i.e. up to 2 Huffman tables are stored in there for
2316 * The #load_huffman_table array can be used as a hint to notify the
2317 * VA driver implementation about which table(s) actually changed
2318 * since the last submission of this buffer.
2320 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2321 /** \brief Specifies which #huffman_table is valid. */
2322 uint8_t load_huffman_table[2];
2323 /** \brief Huffman tables indexed by table identifier (Th). */
2325 /** @name DC table (up to 12 categories) */
2327 /** \brief Number of Huffman codes of length i + 1 (Li). */
2328 uint8_t num_dc_codes[16];
2329 /** \brief Value associated with each Huffman code (Vij). */
2330 uint8_t dc_values[12];
2332 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2334 /** \brief Number of Huffman codes of length i + 1 (Li). */
2335 uint8_t num_ac_codes[16];
2336 /** \brief Value associated with each Huffman code (Vij). */
2337 uint8_t ac_values[162];
2338 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2343 /** \brief Reserved bytes for future use, must be zero */
2344 uint32_t va_reserved[VA_PADDING_LOW];
2345 } VAHuffmanTableBufferJPEGBaseline;
2347 /****************************
2348 * MPEG-2 data structures
2349 ****************************/
2351 /* MPEG-2 Picture Parameter Buffer */
2353 * For each frame or field, and before any slice data, a single
2354 * picture parameter buffer must be send.
2356 typedef struct _VAPictureParameterBufferMPEG2
2358 uint16_t horizontal_size;
2359 uint16_t vertical_size;
2360 VASurfaceID forward_reference_picture;
2361 VASurfaceID backward_reference_picture;
2362 /* meanings of the following fields are the same as in the standard */
2363 int32_t picture_coding_type;
2364 int32_t f_code; /* pack all four fcode into this */
2367 uint32_t intra_dc_precision : 2;
2368 uint32_t picture_structure : 2;
2369 uint32_t top_field_first : 1;
2370 uint32_t frame_pred_frame_dct : 1;
2371 uint32_t concealment_motion_vectors : 1;
2372 uint32_t q_scale_type : 1;
2373 uint32_t intra_vlc_format : 1;
2374 uint32_t alternate_scan : 1;
2375 uint32_t repeat_first_field : 1;
2376 uint32_t progressive_frame : 1;
2377 uint32_t is_first_field : 1; /* indicate whether the current field
2378 * is the first field for field picture
2382 } picture_coding_extension;
2384 /** \brief Reserved bytes for future use, must be zero */
2385 uint32_t va_reserved[VA_PADDING_LOW];
2386 } VAPictureParameterBufferMPEG2;
2388 /** MPEG-2 Inverse Quantization Matrix Buffer */
2389 typedef struct _VAIQMatrixBufferMPEG2
2391 /** \brief Same as the MPEG-2 bitstream syntax element. */
2392 int32_t load_intra_quantiser_matrix;
2393 /** \brief Same as the MPEG-2 bitstream syntax element. */
2394 int32_t load_non_intra_quantiser_matrix;
2395 /** \brief Same as the MPEG-2 bitstream syntax element. */
2396 int32_t load_chroma_intra_quantiser_matrix;
2397 /** \brief Same as the MPEG-2 bitstream syntax element. */
2398 int32_t load_chroma_non_intra_quantiser_matrix;
2399 /** \brief Luminance intra matrix, in zig-zag scan order. */
2400 uint8_t intra_quantiser_matrix[64];
2401 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2402 uint8_t non_intra_quantiser_matrix[64];
2403 /** \brief Chroma intra matrix, in zig-zag scan order. */
2404 uint8_t chroma_intra_quantiser_matrix[64];
2405 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2406 uint8_t chroma_non_intra_quantiser_matrix[64];
2408 /** \brief Reserved bytes for future use, must be zero */
2409 uint32_t va_reserved[VA_PADDING_LOW];
2410 } VAIQMatrixBufferMPEG2;
2412 /** MPEG-2 Slice Parameter Buffer */
2413 typedef struct _VASliceParameterBufferMPEG2
2415 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2416 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2417 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2418 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2419 uint32_t slice_horizontal_position;
2420 uint32_t slice_vertical_position;
2421 int32_t quantiser_scale_code;
2422 int32_t intra_slice_flag;
2424 /** \brief Reserved bytes for future use, must be zero */
2425 uint32_t va_reserved[VA_PADDING_LOW];
2426 } VASliceParameterBufferMPEG2;
2428 /** MPEG-2 Macroblock Parameter Buffer */
2429 typedef struct _VAMacroblockParameterBufferMPEG2
2431 uint16_t macroblock_address;
2433 * macroblock_address (in raster scan order)
2435 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2437 uint8_t macroblock_type; /* see definition below */
2440 uint32_t frame_motion_type : 2;
2441 uint32_t field_motion_type : 2;
2442 uint32_t dct_type : 1;
2446 uint8_t motion_vertical_field_select;
2448 * motion_vertical_field_select:
2449 * see section 6.3.17.2 in the spec
2450 * only the lower 4 bits are used
2451 * bit 0: first vector forward
2452 * bit 1: first vector backward
2453 * bit 2: second vector forward
2454 * bit 3: second vector backward
2456 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2457 uint16_t coded_block_pattern;
2459 * The bitplanes for coded_block_pattern are described
2460 * in Figure 6.10-12 in the spec
2463 /* Number of skipped macroblocks after this macroblock */
2464 uint16_t num_skipped_macroblocks;
2466 /** \brief Reserved bytes for future use, must be zero */
2467 uint32_t va_reserved[VA_PADDING_LOW];
2468 } VAMacroblockParameterBufferMPEG2;
2471 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2473 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2474 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2475 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2476 #define VA_MB_TYPE_MOTION_INTRA 0x10
2479 * MPEG-2 Residual Data Buffer
2480 * For each macroblock, there wil be 64 shorts (16-bit) in the
2481 * residual data buffer
2484 /****************************
2485 * MPEG-4 Part 2 data structures
2486 ****************************/
2488 /* MPEG-4 Picture Parameter Buffer */
2490 * For each frame or field, and before any slice data, a single
2491 * picture parameter buffer must be send.
2493 typedef struct _VAPictureParameterBufferMPEG4
2496 uint16_t vop_height;
2497 VASurfaceID forward_reference_picture;
2498 VASurfaceID backward_reference_picture;
2501 uint32_t short_video_header : 1;
2502 uint32_t chroma_format : 2;
2503 uint32_t interlaced : 1;
2504 uint32_t obmc_disable : 1;
2505 uint32_t sprite_enable : 2;
2506 uint32_t sprite_warping_accuracy : 2;
2507 uint32_t quant_type : 1;
2508 uint32_t quarter_sample : 1;
2509 uint32_t data_partitioned : 1;
2510 uint32_t reversible_vlc : 1;
2511 uint32_t resync_marker_disable : 1;
2515 uint8_t no_of_sprite_warping_points;
2516 int16_t sprite_trajectory_du[3];
2517 int16_t sprite_trajectory_dv[3];
2518 uint8_t quant_precision;
2521 uint32_t vop_coding_type : 2;
2522 uint32_t backward_reference_vop_coding_type : 2;
2523 uint32_t vop_rounding_type : 1;
2524 uint32_t intra_dc_vlc_thr : 3;
2525 uint32_t top_field_first : 1;
2526 uint32_t alternate_vertical_scan_flag : 1;
2530 uint8_t vop_fcode_forward;
2531 uint8_t vop_fcode_backward;
2532 uint16_t vop_time_increment_resolution;
2533 /* short header related */
2534 uint8_t num_gobs_in_vop;
2535 uint8_t num_macroblocks_in_gob;
2536 /* for direct mode prediction */
2540 /** \brief Reserved bytes for future use, must be zero */
2541 uint32_t va_reserved[VA_PADDING_LOW];
2542 } VAPictureParameterBufferMPEG4;
2544 /** MPEG-4 Inverse Quantization Matrix Buffer */
2545 typedef struct _VAIQMatrixBufferMPEG4
2547 /** Same as the MPEG-4:2 bitstream syntax element. */
2548 int32_t load_intra_quant_mat;
2549 /** Same as the MPEG-4:2 bitstream syntax element. */
2550 int32_t load_non_intra_quant_mat;
2551 /** The matrix for intra blocks, in zig-zag scan order. */
2552 uint8_t intra_quant_mat[64];
2553 /** The matrix for non-intra blocks, in zig-zag scan order. */
2554 uint8_t non_intra_quant_mat[64];
2556 /** \brief Reserved bytes for future use, must be zero */
2557 uint32_t va_reserved[VA_PADDING_LOW];
2558 } VAIQMatrixBufferMPEG4;
2560 /** MPEG-4 Slice Parameter Buffer */
2561 typedef struct _VASliceParameterBufferMPEG4
2563 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2564 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2565 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2566 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2567 uint32_t macroblock_number;
2568 int32_t quant_scale;
2570 /** \brief Reserved bytes for future use, must be zero */
2571 uint32_t va_reserved[VA_PADDING_LOW];
2572 } VASliceParameterBufferMPEG4;
2575 VC-1 data structures
2578 typedef enum /* see 7.1.1.32 */
2581 VAMvMode1MvHalfPel = 1,
2582 VAMvMode1MvHalfPelBilinear = 2,
2583 VAMvModeMixedMv = 3,
2584 VAMvModeIntensityCompensation = 4
2587 /** VC-1 Picture Parameter Buffer */
2589 * For each picture, and before any slice data, a picture parameter
2590 * buffer must be send. Multiple picture parameter buffers may be
2591 * sent for a single picture. In that case picture parameters will
2592 * apply to all slice data that follow it until a new picture
2593 * parameter buffer is sent.
2596 * pic_quantizer_type should be set to the applicable quantizer
2597 * type as defined by QUANTIZER (J.1.19) and either
2598 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2600 typedef struct _VAPictureParameterBufferVC1
2602 VASurfaceID forward_reference_picture;
2603 VASurfaceID backward_reference_picture;
2604 /* if out-of-loop post-processing is done on the render
2605 target, then we need to keep the in-loop decoded
2606 picture as a reference picture */
2607 VASurfaceID inloop_decoded_picture;
2609 /* sequence layer for AP or meta data for SP and MP */
2612 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2613 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2614 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2615 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2616 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2617 uint32_t multires : 1; /* METADATA::MULTIRES */
2618 uint32_t overlap : 1; /* METADATA::OVERLAP */
2619 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2620 uint32_t rangered : 1; /* METADATA::RANGERED */
2621 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2622 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2627 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2628 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2631 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2632 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2633 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2634 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2637 } entrypoint_fields;
2638 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2639 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2642 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2643 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2644 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2645 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2648 } range_mapping_fields;
2650 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2651 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2652 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2653 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2654 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2655 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2656 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2657 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2658 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2662 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2663 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2664 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2665 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2666 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2672 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2673 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2674 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2675 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2676 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2677 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2678 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2684 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2685 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2686 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2687 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2688 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2689 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2690 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2693 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2696 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2697 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2698 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2699 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2705 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2706 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2707 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2708 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2709 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2710 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2711 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2712 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2713 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2714 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2720 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2721 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2722 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2723 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2724 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2725 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2726 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2727 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2728 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2729 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2730 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2733 } pic_quantizer_fields;
2736 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2737 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2738 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2739 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2740 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2741 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2746 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2747 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2748 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2750 /** \brief Reserved bytes for future use, must be zero */
2751 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2752 } VAPictureParameterBufferVC1;
2754 /** VC-1 Bitplane Buffer
2755 There will be at most three bitplanes coded in any picture header. To send
2756 the bitplane data more efficiently, each byte is divided in two nibbles, with
2757 each nibble carrying three bitplanes for one macroblock. The following table
2758 shows the bitplane data arrangement within each nibble based on the picture
2761 Picture Type Bit3 Bit2 Bit1 Bit0
2762 I or BI OVERFLAGS ACPRED FIELDTX
2763 P MYTYPEMB SKIPMB DIRECTMB
2764 B FORWARDMB SKIPMB DIRECTMB
2766 Within each byte, the lower nibble is for the first MB and the upper nibble is
2767 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2768 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2769 Macroblock #2 in the first row.
2772 /* VC-1 Slice Parameter Buffer */
2773 typedef struct _VASliceParameterBufferVC1
2775 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2776 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2777 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2778 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2779 uint32_t slice_vertical_position;
2781 /** \brief Reserved bytes for future use, must be zero */
2782 uint32_t va_reserved[VA_PADDING_LOW];
2783 } VASliceParameterBufferVC1;
2785 /* VC-1 Slice Data Buffer */
2787 This is simplely a buffer containing raw bit-stream bytes
2790 /****************************
2791 * H.264/AVC data structures
2792 ****************************/
2794 typedef struct _VAPictureH264
2796 VASurfaceID picture_id;
2799 int32_t TopFieldOrderCnt;
2800 int32_t BottomFieldOrderCnt;
2802 /** \brief Reserved bytes for future use, must be zero */
2803 uint32_t va_reserved[VA_PADDING_LOW];
2805 /* flags in VAPictureH264 could be OR of the following */
2806 #define VA_PICTURE_H264_INVALID 0x00000001
2807 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2808 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2809 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2810 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2812 /** H.264 Picture Parameter Buffer */
2814 * For each picture, and before any slice data, a single
2815 * picture parameter buffer must be send.
2817 typedef struct _VAPictureParameterBufferH264
2819 VAPictureH264 CurrPic;
2820 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2821 uint16_t picture_width_in_mbs_minus1;
2822 uint16_t picture_height_in_mbs_minus1;
2823 uint8_t bit_depth_luma_minus8;
2824 uint8_t bit_depth_chroma_minus8;
2825 uint8_t num_ref_frames;
2828 uint32_t chroma_format_idc : 2;
2829 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2830 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2831 uint32_t frame_mbs_only_flag : 1;
2832 uint32_t mb_adaptive_frame_field_flag : 1;
2833 uint32_t direct_8x8_inference_flag : 1;
2834 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2835 uint32_t log2_max_frame_num_minus4 : 4;
2836 uint32_t pic_order_cnt_type : 2;
2837 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2838 uint32_t delta_pic_order_always_zero_flag : 1;
2842 // FMO is not supported.
2843 va_deprecated uint8_t num_slice_groups_minus1;
2844 va_deprecated uint8_t slice_group_map_type;
2845 va_deprecated uint16_t slice_group_change_rate_minus1;
2846 int8_t pic_init_qp_minus26;
2847 int8_t pic_init_qs_minus26;
2848 int8_t chroma_qp_index_offset;
2849 int8_t second_chroma_qp_index_offset;
2852 uint32_t entropy_coding_mode_flag : 1;
2853 uint32_t weighted_pred_flag : 1;
2854 uint32_t weighted_bipred_idc : 2;
2855 uint32_t transform_8x8_mode_flag : 1;
2856 uint32_t field_pic_flag : 1;
2857 uint32_t constrained_intra_pred_flag : 1;
2858 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2859 uint32_t deblocking_filter_control_present_flag : 1;
2860 uint32_t redundant_pic_cnt_present_flag : 1;
2861 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2867 /** \brief Reserved bytes for future use, must be zero */
2868 uint32_t va_reserved[VA_PADDING_MEDIUM];
2869 } VAPictureParameterBufferH264;
2871 /** H.264 Inverse Quantization Matrix Buffer */
2872 typedef struct _VAIQMatrixBufferH264
2874 /** \brief 4x4 scaling list, in raster scan order. */
2875 uint8_t ScalingList4x4[6][16];
2876 /** \brief 8x8 scaling list, in raster scan order. */
2877 uint8_t ScalingList8x8[2][64];
2879 /** \brief Reserved bytes for future use, must be zero */
2880 uint32_t va_reserved[VA_PADDING_LOW];
2881 } VAIQMatrixBufferH264;
2883 /** H.264 Slice Parameter Buffer */
2884 typedef struct _VASliceParameterBufferH264
2886 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2887 /** \brief Byte offset to the NAL Header Unit for this slice. */
2888 uint32_t slice_data_offset;
2889 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2891 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2893 * This bit offset is relative to and includes the NAL unit byte
2894 * and represents the number of bits parsed in the slice_header()
2895 * after the removal of any emulation prevention bytes in
2896 * there. However, the slice data buffer passed to the hardware is
2897 * the original bitstream, thus including any emulation prevention
2900 uint16_t slice_data_bit_offset;
2901 uint16_t first_mb_in_slice;
2903 uint8_t direct_spatial_mv_pred_flag;
2905 * H264/AVC syntax element
2907 * if num_ref_idx_active_override_flag equals 0, host decoder should
2908 * set its value to num_ref_idx_l0_default_active_minus1.
2910 uint8_t num_ref_idx_l0_active_minus1;
2912 * H264/AVC syntax element
2914 * if num_ref_idx_active_override_flag equals 0, host decoder should
2915 * set its value to num_ref_idx_l1_default_active_minus1.
2917 uint8_t num_ref_idx_l1_active_minus1;
2918 uint8_t cabac_init_idc;
2919 int8_t slice_qp_delta;
2920 uint8_t disable_deblocking_filter_idc;
2921 int8_t slice_alpha_c0_offset_div2;
2922 int8_t slice_beta_offset_div2;
2923 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2924 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2925 uint8_t luma_log2_weight_denom;
2926 uint8_t chroma_log2_weight_denom;
2927 uint8_t luma_weight_l0_flag;
2928 int16_t luma_weight_l0[32];
2929 int16_t luma_offset_l0[32];
2930 uint8_t chroma_weight_l0_flag;
2931 int16_t chroma_weight_l0[32][2];
2932 int16_t chroma_offset_l0[32][2];
2933 uint8_t luma_weight_l1_flag;
2934 int16_t luma_weight_l1[32];
2935 int16_t luma_offset_l1[32];
2936 uint8_t chroma_weight_l1_flag;
2937 int16_t chroma_weight_l1[32][2];
2938 int16_t chroma_offset_l1[32][2];
2940 /** \brief Reserved bytes for future use, must be zero */
2941 uint32_t va_reserved[VA_PADDING_LOW];
2942 } VASliceParameterBufferH264;
2944 /****************************
2945 * Common encode data structures
2946 ****************************/
2949 VAEncPictureTypeIntra = 0,
2950 VAEncPictureTypePredictive = 1,
2951 VAEncPictureTypeBidirectional = 2,
2955 * \brief Encode Slice Parameter Buffer.
2958 * This is a deprecated encode slice parameter buffer, All applications
2959 * \c can use VAEncSliceParameterBufferXXX (XXX = MPEG2, HEVC, H264, JPEG)
2961 typedef struct _VAEncSliceParameterBuffer
2963 uint32_t start_row_number; /* starting MB row number for this slice */
2964 uint32_t slice_height; /* slice height measured in MB */
2967 uint32_t is_intra : 1;
2968 uint32_t disable_deblocking_filter_idc : 2;
2969 uint32_t uses_long_term_ref :1;
2970 uint32_t is_long_term_ref :1;
2975 /** \brief Reserved bytes for future use, must be zero */
2976 uint32_t va_reserved[VA_PADDING_LOW];
2977 } VAEncSliceParameterBuffer;
2980 /****************************
2981 * H.263 specific encode data structures
2982 ****************************/
2984 typedef struct _VAEncSequenceParameterBufferH263
2986 uint32_t intra_period;
2987 uint32_t bits_per_second;
2988 uint32_t frame_rate;
2989 uint32_t initial_qp;
2992 /** \brief Reserved bytes for future use, must be zero */
2993 uint32_t va_reserved[VA_PADDING_LOW];
2994 } VAEncSequenceParameterBufferH263;
2996 typedef struct _VAEncPictureParameterBufferH263
2998 VASurfaceID reference_picture;
2999 VASurfaceID reconstructed_picture;
3000 VABufferID coded_buf;
3001 uint16_t picture_width;
3002 uint16_t picture_height;
3003 VAEncPictureType picture_type;
3005 /** \brief Reserved bytes for future use, must be zero */
3006 uint32_t va_reserved[VA_PADDING_LOW];
3007 } VAEncPictureParameterBufferH263;
3009 /****************************
3010 * MPEG-4 specific encode data structures
3011 ****************************/
3013 typedef struct _VAEncSequenceParameterBufferMPEG4
3015 uint8_t profile_and_level_indication;
3016 uint32_t intra_period;
3017 uint32_t video_object_layer_width;
3018 uint32_t video_object_layer_height;
3019 uint32_t vop_time_increment_resolution;
3020 uint32_t fixed_vop_rate;
3021 uint32_t fixed_vop_time_increment;
3022 uint32_t bits_per_second;
3023 uint32_t frame_rate;
3024 uint32_t initial_qp;
3027 /** \brief Reserved bytes for future use, must be zero */
3028 uint32_t va_reserved[VA_PADDING_LOW];
3029 } VAEncSequenceParameterBufferMPEG4;
3031 typedef struct _VAEncPictureParameterBufferMPEG4
3033 VASurfaceID reference_picture;
3034 VASurfaceID reconstructed_picture;
3035 VABufferID coded_buf;
3036 uint16_t picture_width;
3037 uint16_t picture_height;
3038 uint32_t modulo_time_base; /* number of 1s */
3039 uint32_t vop_time_increment;
3040 VAEncPictureType picture_type;
3042 /** \brief Reserved bytes for future use, must be zero */
3043 uint32_t va_reserved[VA_PADDING_LOW];
3044 } VAEncPictureParameterBufferMPEG4;
3048 /** Buffer functions */
3051 * Creates a buffer for "num_elements" elements of "size" bytes and
3052 * initalize with "data".
3053 * if "data" is null, then the contents of the buffer data store
3055 * Basically there are two ways to get buffer data to the server side. One is
3056 * to call vaCreateBuffer() with a non-null "data", which results the data being
3057 * copied to the data store on the server side. A different method that
3058 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
3059 * and then use vaMapBuffer() to map the data store from the server side to the
3060 * client address space for access.
3061 * The user must call vaDestroyBuffer() to destroy a buffer.
3062 * Note: image buffers are created by the library, not the client. Please see
3063 * vaCreateImage on how image buffers are managed.
3065 VAStatus vaCreateBuffer (
3067 VAContextID context,
3068 VABufferType type, /* in */
3069 unsigned int size, /* in */
3070 unsigned int num_elements, /* in */
3071 void *data, /* in */
3072 VABufferID *buf_id /* out */
3076 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
3077 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
3078 * can call vaMapBuffer with this Buffer ID to get virtual address.
3079 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
3080 * maybe it should align with 256, and one byte present one Qp.so, call the function.
3081 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
3082 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
3083 * pBuf + 256 is the start of next line.
3084 * different driver implementation maybe return different unit_size and pitch
3086 VAStatus vaCreateBuffer2(
3088 VAContextID context,
3091 unsigned int height,
3092 unsigned int *unit_size,
3093 unsigned int *pitch,
3098 * Convey to the server how many valid elements are in the buffer.
3099 * e.g. if multiple slice parameters are being held in a single buffer,
3100 * this will communicate to the server the number of slice parameters
3101 * that are valid in the buffer.
3103 VAStatus vaBufferSetNumElements (
3105 VABufferID buf_id, /* in */
3106 unsigned int num_elements /* in */
3111 * device independent data structure for codedbuffer
3115 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
3116 * LARGE_SLICE(bit8):At least one slice in the current frame was large
3117 * enough for the encoder to attempt to limit its size.
3118 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
3119 * exceeded the maximum slice size specified.
3120 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
3121 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
3122 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
3124 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
3125 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
3126 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
3127 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
3128 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
3130 * \brief The frame has exceeded the maximum requested size.
3132 * This flag indicates that the encoded frame size exceeds the value
3133 * specified through a misc parameter buffer of type
3134 * #VAEncMiscParameterTypeMaxFrameSize.
3136 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
3138 * \brief the bitstream is bad or corrupt.
3140 #define VA_CODED_BUF_STATUS_BAD_BITSTREAM 0x8000
3141 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
3144 * \brief The coded buffer segment status contains frame encoding passes number
3146 * This is the mask to get the number of encoding passes from the coded
3147 * buffer segment status.
3148 * NUMBER_PASS(bit24~bit27): the number for encoding passes executed for the coded frame.
3151 #define VA_CODED_BUF_STATUS_NUMBER_PASSES_MASK 0xf000000
3154 * \brief The coded buffer segment contains a single NAL unit.
3156 * This flag indicates that the coded buffer segment contains a
3157 * single NAL unit. This flag might be useful to the user for
3158 * processing the coded buffer.
3160 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
3163 * \brief Coded buffer segment.
3165 * #VACodedBufferSegment is an element of a linked list describing
3166 * some information on the coded buffer. The coded buffer segment
3167 * could contain either a single NAL unit, or more than one NAL unit.
3168 * It is recommended (but not required) to return a single NAL unit
3169 * in a coded buffer segment, and the implementation should set the
3170 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
3172 typedef struct _VACodedBufferSegment {
3174 * \brief Size of the data buffer in this segment (in bytes).
3177 /** \brief Bit offset into the data buffer where the video data starts. */
3178 uint32_t bit_offset;
3179 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
3181 /** \brief Reserved for future use. */
3183 /** \brief Pointer to the start of the data buffer. */
3186 * \brief Pointer to the next #VACodedBufferSegment element,
3187 * or \c NULL if there is none.
3191 /** \brief Reserved bytes for future use, must be zero */
3192 uint32_t va_reserved[VA_PADDING_LOW];
3193 } VACodedBufferSegment;
3196 * Map data store of the buffer into the client's address space
3197 * vaCreateBuffer() needs to be called with "data" set to NULL before
3198 * calling vaMapBuffer()
3200 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
3201 * VACodedBufferSegment, and the list is terminated if "next" is NULL
3203 VAStatus vaMapBuffer (
3205 VABufferID buf_id, /* in */
3206 void **pbuf /* out */
3210 * After client making changes to a mapped data store, it needs to
3211 * "Unmap" it to let the server know that the data is ready to be
3212 * consumed by the server
3214 VAStatus vaUnmapBuffer (
3216 VABufferID buf_id /* in */
3220 * After this call, the buffer is deleted and this buffer_id is no longer valid
3222 * A buffer can be re-used and sent to the server by another Begin/Render/End
3223 * sequence if vaDestroyBuffer() is not called with this buffer.
3225 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3226 * hardware accelerator can result in performance dropping.
3228 VAStatus vaDestroyBuffer (
3230 VABufferID buffer_id
3233 /** \brief VA buffer information */
3235 /** \brief Buffer handle */
3237 /** \brief Buffer type (See \ref VABufferType). */
3240 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3242 * On input to vaAcquireBufferHandle(), this field can serve as a hint
3243 * to specify the set of memory types the caller is interested in.
3244 * On successful return from vaAcquireBufferHandle(), the field is
3245 * updated with the best matching memory type.
3248 /** \brief Size of the underlying buffer. */
3251 /** \brief Reserved bytes for future use, must be zero */
3252 uint32_t va_reserved[VA_PADDING_LOW];
3256 * \brief Acquires buffer handle for external API usage
3258 * Locks the VA buffer object \ref buf_id for external API usage like
3259 * EGL or OpenCL (OCL). This function is a synchronization point. This
3260 * means that any pending operation is guaranteed to be completed
3261 * prior to returning from the function.
3263 * If the referenced VA buffer object is the backing store of a VA
3264 * surface, then this function acts as if vaSyncSurface() on the
3265 * parent surface was called first.
3267 * The \ref VABufferInfo argument shall be zero'ed on input. On
3268 * successful output, the data structure is filled in with all the
3269 * necessary buffer level implementation details like handle, type,
3270 * memory type and memory size.
3272 * Note: the external API implementation, or the application, can
3273 * express the memory types it is interested in by filling in the \ref
3274 * mem_type field accordingly. On successful output, the memory type
3275 * that fits best the request and that was used is updated in the \ref
3276 * VABufferInfo data structure. If none of the supplied memory types
3277 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3278 * error is returned.
3280 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3281 * is called. Besides, no additional operation is allowed on any of
3282 * the buffer parent object until vaReleaseBufferHandle() is called.
3283 * e.g. decoding into a VA surface backed with the supplied VA buffer
3284 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3288 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3289 * does not support this interface
3290 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3291 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3292 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3293 * does not support exporting buffers of the specified type
3294 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3295 * memory types in \ref VABufferInfo.mem_type was supported
3297 * @param[in] dpy the VA display
3298 * @param[in] buf_id the VA buffer
3299 * @param[in,out] buf_info the associated VA buffer information
3300 * @return VA_STATUS_SUCCESS if successful
3303 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3306 * \brief Releases buffer after usage from external API
3308 * Unlocks the VA buffer object \ref buf_id from external API usage like
3309 * EGL or OpenCL (OCL). This function is a synchronization point. This
3310 * means that any pending operation is guaranteed to be completed
3311 * prior to returning from the function.
3313 * The \ref VABufferInfo argument shall point to the original data
3314 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3315 * This is necessary so that the VA driver implementation could
3316 * deallocate any resources that were needed.
3318 * In any case, returning from this function invalidates any contents
3319 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3320 * valid. Therefore, VA driver implementations are free to reset this
3321 * data structure to safe defaults.
3324 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3325 * does not support this interface
3326 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3327 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3328 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3329 * does not support exporting buffers of the specified type
3331 * @param[in] dpy the VA display
3332 * @param[in] buf_id the VA buffer
3333 * @return VA_STATUS_SUCCESS if successful
3336 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3338 /** @name vaExportSurfaceHandle() flags
3342 /** Export surface to be read by external API. */
3343 #define VA_EXPORT_SURFACE_READ_ONLY 0x0001
3344 /** Export surface to be written by external API. */
3345 #define VA_EXPORT_SURFACE_WRITE_ONLY 0x0002
3346 /** Export surface to be both read and written by external API. */
3347 #define VA_EXPORT_SURFACE_READ_WRITE 0x0003
3348 /** Export surface with separate layers.
3350 * For example, NV12 surfaces should be exported as two separate
3351 * planes for luma and chroma.
3353 #define VA_EXPORT_SURFACE_SEPARATE_LAYERS 0x0004
3354 /** Export surface with composed layers.
3356 * For example, NV12 surfaces should be exported as a single NV12
3359 #define VA_EXPORT_SURFACE_COMPOSED_LAYERS 0x0008
3364 * \brief Export a handle to a surface for use with an external API
3366 * The exported handles are owned by the caller, and the caller is
3367 * responsible for freeing them when no longer needed (e.g. by closing
3368 * DRM PRIME file descriptors).
3370 * This does not perform any synchronisation. If the contents of the
3371 * surface will be read, vaSyncSurface() must be called before doing so.
3372 * If the contents of the surface are written, then all operations must
3373 * be completed externally before using the surface again by via VA-API
3376 * @param[in] dpy VA display.
3377 * @param[in] surface_id Surface to export.
3378 * @param[in] mem_type Memory type to export to.
3379 * @param[in] flags Combination of flags to apply
3380 * (VA_EXPORT_SURFACE_*).
3381 * @param[out] descriptor Pointer to the descriptor structure to fill
3382 * with the handle details. The type of this structure depends on
3383 * the value of mem_type.
3385 * @return Status code:
3386 * - VA_STATUS_SUCCESS: Success.
3387 * - VA_STATUS_ERROR_INVALID_DISPLAY: The display is not valid.
3388 * - VA_STATUS_ERROR_UNIMPLEMENTED: The driver does not implement
3390 * - VA_STATUS_ERROR_INVALID_SURFACE: The surface is not valid, or
3391 * the surface is not exportable in the specified way.
3392 * - VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: The driver does not
3393 * support exporting surfaces to the specified memory type.
3395 VAStatus vaExportSurfaceHandle(VADisplay dpy,
3396 VASurfaceID surface_id,
3397 uint32_t mem_type, uint32_t flags,
3401 * Render (Video Decode/Encode/Processing) Pictures
3403 * A picture represents either a frame or a field.
3405 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3410 * Get ready for a video pipeline
3411 * - decode a picture to a target surface
3412 * - encode a picture from a target surface
3413 * - process a picture to a target surface
3415 VAStatus vaBeginPicture (
3417 VAContextID context,
3418 VASurfaceID render_target
3422 * Send video decode, encode or processing buffers to the server.
3424 VAStatus vaRenderPicture (
3426 VAContextID context,
3427 VABufferID *buffers,
3432 * Make the end of rendering for a picture.
3433 * The server should start processing all pending operations for this
3434 * surface. This call is non-blocking. The client can start another
3435 * Begin/Render/End sequence on a different render target.
3436 * if VAContextID used in this function previously successfully passed
3437 * vaMFAddContext call, real processing will be started during vaMFSubmit
3439 VAStatus vaEndPicture (
3445 * Make the end of rendering for a pictures in contexts passed with submission.
3446 * The server should start processing all pending operations for contexts.
3447 * All contexts passed should be associated through vaMFAddContext
3448 * and call sequence Begin/Render/End performed.
3449 * This call is non-blocking. The client can start another
3450 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3452 * VA_STATUS_SUCCESS - operation successful, context was removed.
3453 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3454 * due to mf_context not created or one of contexts not assotiated with mf_context
3455 * through vaAddContext.
3456 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3457 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3459 * mf_context: Multi-Frame context
3460 * contexts: list of contexts submitting their tasks for multi-frame operation.
3461 * num_contexts: number of passed contexts.
3463 VAStatus vaMFSubmit (
3465 VAMFContextID mf_context,
3466 VAContextID * contexts,
3477 * This function blocks until all pending operations on the render target
3478 * have been completed. Upon return it is safe to use the render target for a
3479 * different picture.
3481 VAStatus vaSyncSurface (
3483 VASurfaceID render_target
3488 VASurfaceRendering = 1, /* Rendering in progress */
3489 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3490 /* this status is useful if surface is used as the source */
3492 VASurfaceReady = 4, /* not being rendered or displayed */
3493 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3497 * Find out any pending ops on the render target
3499 VAStatus vaQuerySurfaceStatus (
3501 VASurfaceID render_target,
3502 VASurfaceStatus *status /* out */
3507 VADecodeSliceMissing = 0,
3508 VADecodeMBError = 1,
3509 } VADecodeErrorType;
3512 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3513 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3515 typedef struct _VASurfaceDecodeMBErrors
3517 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3518 uint32_t start_mb; /* start mb address with errors */
3519 uint32_t end_mb; /* end mb address with errors */
3520 VADecodeErrorType decode_error_type;
3521 uint32_t num_mb; /* number of mbs with errors */
3522 /** \brief Reserved bytes for future use, must be zero */
3523 uint32_t va_reserved[VA_PADDING_LOW - 1];
3524 } VASurfaceDecodeMBErrors;
3527 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3528 * it can call vaQuerySurfaceError to find out further details on the particular error.
3529 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3530 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3531 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3532 * The array is terminated if "status==-1" is detected.
3534 VAStatus vaQuerySurfaceError(
3536 VASurfaceID surface,
3537 VAStatus error_status,
3542 * Images and Subpictures
3543 * VAImage is used to either get the surface data to client memory, or
3544 * to copy image data in client memory to a surface.
3545 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3546 * is at the upper left corner with positive X to the right and positive Y down
3548 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3549 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3550 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3553 * Pre-defined fourcc codes
3555 #define VA_FOURCC_NV12 0x3231564E
3556 #define VA_FOURCC_NV21 0x3132564E
3557 #define VA_FOURCC_AI44 0x34344149
3558 #define VA_FOURCC_RGBA 0x41424752
3559 #define VA_FOURCC_RGBX 0x58424752
3560 #define VA_FOURCC_BGRA 0x41524742
3561 #define VA_FOURCC_BGRX 0x58524742
3562 #define VA_FOURCC_ARGB 0x42475241
3563 #define VA_FOURCC_XRGB 0x42475258
3564 #define VA_FOURCC_ABGR 0x52474241
3565 #define VA_FOURCC_XBGR 0x52474258
3566 #define VA_FOURCC_UYVY 0x59565955
3567 #define VA_FOURCC_YUY2 0x32595559
3568 #define VA_FOURCC_AYUV 0x56555941
3569 #define VA_FOURCC_NV11 0x3131564e
3570 #define VA_FOURCC_YV12 0x32315659
3571 #define VA_FOURCC_P208 0x38303250
3572 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3573 #define VA_FOURCC_IYUV 0x56555949
3574 #define VA_FOURCC_I420 0x30323449
3575 #define VA_FOURCC_YV24 0x34325659
3576 #define VA_FOURCC_YV32 0x32335659
3577 #define VA_FOURCC_Y800 0x30303859
3578 #define VA_FOURCC_IMC3 0x33434D49
3579 #define VA_FOURCC_411P 0x50313134
3580 #define VA_FOURCC_422H 0x48323234
3581 #define VA_FOURCC_422V 0x56323234
3582 #define VA_FOURCC_444P 0x50343434
3583 #define VA_FOURCC_RGBP 0x50424752
3584 #define VA_FOURCC_BGRP 0x50524742
3585 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
3588 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3590 #define VA_FOURCC_YV16 0x36315659
3592 * 10-bit and 16-bit Planar YUV 4:2:0.
3594 #define VA_FOURCC_P010 0x30313050
3595 #define VA_FOURCC_P016 0x36313050
3598 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3600 #define VA_FOURCC_I010 0x30313049
3603 #define VA_LSB_FIRST 1
3604 #define VA_MSB_FIRST 2
3606 typedef struct _VAImageFormat
3609 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3610 uint32_t bits_per_pixel;
3611 /* for RGB formats */
3612 uint32_t depth; /* significant bits per pixel */
3614 uint32_t green_mask;
3616 uint32_t alpha_mask;
3618 /** \brief Reserved bytes for future use, must be zero */
3619 uint32_t va_reserved[VA_PADDING_LOW];
3622 typedef VAGenericID VAImageID;
3624 typedef struct _VAImage
3626 VAImageID image_id; /* uniquely identify this image */
3627 VAImageFormat format;
3628 VABufferID buf; /* image data buffer */
3630 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3631 * data store on the server side for optimal performance. The buffer will be
3632 * created by the CreateImage function, and proper storage allocated based on the image
3633 * size and format. This buffer is managed by the library implementation, and
3634 * accessed by the client through the buffer Map/Unmap functions.
3639 uint32_t num_planes; /* can not be greater than 3 */
3641 * An array indicating the scanline pitch in bytes for each plane.
3642 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3644 uint32_t pitches[3];
3646 * An array indicating the byte offset from the beginning of the image data
3647 * to the start of each plane.
3649 uint32_t offsets[3];
3651 /* The following fields are only needed for paletted formats */
3652 int32_t num_palette_entries; /* set to zero for non-palette images */
3654 * Each component is one byte and entry_bytes indicates the number of components in
3655 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3657 int32_t entry_bytes;
3659 * An array of ascii characters describing the order of the components within the bytes.
3660 * Only entry_bytes characters of the string are used.
3662 int8_t component_order[4];
3664 /** \brief Reserved bytes for future use, must be zero */
3665 uint32_t va_reserved[VA_PADDING_LOW];
3668 /** Get maximum number of image formats supported by the implementation */
3669 int vaMaxNumImageFormats (
3674 * Query supported image formats
3675 * The caller must provide a "format_list" array that can hold at
3676 * least vaMaxNumImageFormats() entries. The actual number of formats
3677 * returned in "format_list" is returned in "num_formats".
3679 VAStatus vaQueryImageFormats (
3681 VAImageFormat *format_list, /* out */
3682 int *num_formats /* out */
3686 * Create a VAImage structure
3687 * The width and height fields returned in the VAImage structure may get
3688 * enlarged for some YUV formats. Upon return from this function,
3689 * image->buf has been created and proper storage allocated by the library.
3690 * The client can access the image through the Map/Unmap calls.
3692 VAStatus vaCreateImage (
3694 VAImageFormat *format,
3697 VAImage *image /* out */
3701 * Should call DestroyImage before destroying the surface it is bound to
3703 VAStatus vaDestroyImage (
3708 VAStatus vaSetImagePalette (
3712 * pointer to an array holding the palette data. The size of the array is
3713 * num_palette_entries * entry_bytes in size. The order of the components
3714 * in the palette is described by the component_order in VAImage struct
3716 unsigned char *palette
3720 * Retrive surface data into a VAImage
3721 * Image must be in a format supported by the implementation
3723 VAStatus vaGetImage (
3725 VASurfaceID surface,
3726 int x, /* coordinates of the upper left source pixel */
3728 unsigned int width, /* width and height of the region */
3729 unsigned int height,
3734 * Copy data from a VAImage to a surface
3735 * Image must be in a format supported by the implementation
3736 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3737 * shouldn't be rendered into when this is called
3739 VAStatus vaPutImage (
3741 VASurfaceID surface,
3745 unsigned int src_width,
3746 unsigned int src_height,
3749 unsigned int dest_width,
3750 unsigned int dest_height
3754 * Derive an VAImage from an existing surface.
3755 * This interface will derive a VAImage and corresponding image buffer from
3756 * an existing VA Surface. The image buffer can then be mapped/unmapped for
3757 * direct CPU access. This operation is only possible on implementations with
3758 * direct rendering capabilities and internal surface formats that can be
3759 * represented with a VAImage. When the operation is not possible this interface
3760 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3761 * to using vaCreateImage + vaPutImage to accomplish the same task in an
3764 * Implementations should only return success when the resulting image buffer
3765 * would be useable with vaMap/Unmap.
3767 * When directly accessing a surface special care must be taken to insure
3768 * proper synchronization with the graphics hardware. Clients should call
3769 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3770 * rendering or currently being displayed by an overlay.
3772 * Additionally nothing about the contents of a surface should be assumed
3773 * following a vaPutSurface. Implementations are free to modify the surface for
3774 * scaling or subpicture blending within a call to vaPutImage.
3776 * Calls to vaPutImage or vaGetImage using the same surface from which the image
3777 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3778 * vaGetImage with other surfaces is supported.
3780 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3781 * image and image buffer structures will be destroyed; however, the underlying
3782 * surface will remain unchanged until freed with vaDestroySurfaces.
3784 VAStatus vaDeriveImage (
3786 VASurfaceID surface,
3787 VAImage *image /* out */
3792 * Subpicture is a special type of image that can be blended
3793 * with a surface during vaPutSurface(). Subpicture can be used to render
3794 * DVD sub-titles or closed captioning text etc.
3797 typedef VAGenericID VASubpictureID;
3799 /** Get maximum number of subpicture formats supported by the implementation */
3800 int vaMaxNumSubpictureFormats (
3804 /** flags for subpictures */
3805 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
3806 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
3807 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
3809 * Query supported subpicture formats
3810 * The caller must provide a "format_list" array that can hold at
3811 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
3812 * for each format to indicate additional capabilities for that format. The actual
3813 * number of formats returned in "format_list" is returned in "num_formats".
3814 * flags: returned value to indicate addtional capabilities
3815 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3816 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3817 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3820 VAStatus vaQuerySubpictureFormats (
3822 VAImageFormat *format_list, /* out */
3823 unsigned int *flags, /* out */
3824 unsigned int *num_formats /* out */
3828 * Subpictures are created with an image associated.
3830 VAStatus vaCreateSubpicture (
3833 VASubpictureID *subpicture /* out */
3837 * Destroy the subpicture before destroying the image it is assocated to
3839 VAStatus vaDestroySubpicture (
3841 VASubpictureID subpicture
3845 * Bind an image to the subpicture. This image will now be associated with
3846 * the subpicture instead of the one at creation.
3848 VAStatus vaSetSubpictureImage (
3850 VASubpictureID subpicture,
3855 * If chromakey is enabled, then the area where the source value falls within
3856 * the chromakey [min, max] range is transparent
3857 * The chromakey component format is the following:
3858 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
3859 * For YUV: [0:7] V [8:15] U [16:23] Y
3860 * The chromakey mask can be used to mask out certain components for chromakey
3863 VAStatus vaSetSubpictureChromakey (
3865 VASubpictureID subpicture,
3866 unsigned int chromakey_min,
3867 unsigned int chromakey_max,
3868 unsigned int chromakey_mask
3872 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
3873 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3874 * the overall alpha is per-pixel alpha multiplied by the global alpha
3876 VAStatus vaSetSubpictureGlobalAlpha (
3878 VASubpictureID subpicture,
3883 * vaAssociateSubpicture associates the subpicture with target_surfaces.
3884 * It defines the region mapping between the subpicture and the target
3885 * surfaces through source and destination rectangles (with the same width and height).
3886 * Both will be displayed at the next call to vaPutSurface. Additional
3887 * associations before the call to vaPutSurface simply overrides the association.
3889 VAStatus vaAssociateSubpicture (
3891 VASubpictureID subpicture,
3892 VASurfaceID *target_surfaces,
3894 int16_t src_x, /* upper left offset in subpicture */
3897 uint16_t src_height,
3898 int16_t dest_x, /* upper left offset in surface */
3900 uint16_t dest_width,
3901 uint16_t dest_height,
3903 * whether to enable chroma-keying, global-alpha, or screen relative mode
3904 * see VA_SUBPICTURE_XXX values
3910 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3912 VAStatus vaDeassociateSubpicture (
3914 VASubpictureID subpicture,
3915 VASurfaceID *target_surfaces,
3920 * Display attributes
3921 * Display attributes are used to control things such as contrast, hue, saturation,
3922 * brightness etc. in the rendering process. The application can query what
3923 * attributes are supported by the driver, and then set the appropriate attributes
3924 * before calling vaPutSurface()
3926 /* PowerVR IEP Lite attributes */
3929 VADISPLAYATTRIB_BLE_OFF = 0x00,
3930 VADISPLAYATTRIB_BLE_LOW,
3931 VADISPLAYATTRIB_BLE_MEDIUM,
3932 VADISPLAYATTRIB_BLE_HIGH,
3933 VADISPLAYATTRIB_BLE_NONE,
3934 } VADisplayAttribBLEMode;
3936 /** attribute value for VADisplayAttribRotation */
3937 #define VA_ROTATION_NONE 0x00000000
3938 #define VA_ROTATION_90 0x00000001
3939 #define VA_ROTATION_180 0x00000002
3940 #define VA_ROTATION_270 0x00000003
3944 * @name Mirroring directions
3946 * Those values could be used for VADisplayAttribMirror attribute or
3947 * VAProcPipelineParameterBuffer::mirror_state.
3951 /** \brief No Mirroring. */
3952 #define VA_MIRROR_NONE 0x00000000
3953 /** \brief Horizontal Mirroring. */
3954 #define VA_MIRROR_HORIZONTAL 0x00000001
3955 /** \brief Vertical Mirroring. */
3956 #define VA_MIRROR_VERTICAL 0x00000002
3959 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3960 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3961 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
3964 #define VA_RENDER_MODE_UNDEFINED 0
3965 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
3966 #define VA_RENDER_MODE_LOCAL_GPU 2
3967 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
3968 #define VA_RENDER_MODE_EXTERNAL_GPU 8
3970 /** Render device */
3971 #define VA_RENDER_DEVICE_UNDEFINED 0
3972 #define VA_RENDER_DEVICE_LOCAL 1
3973 #define VA_RENDER_DEVICE_EXTERNAL 2
3975 /** Currently defined display attribute types */
3978 VADisplayAttribBrightness = 0,
3979 VADisplayAttribContrast = 1,
3980 VADisplayAttribHue = 2,
3981 VADisplayAttribSaturation = 3,
3982 /* client can specifiy a background color for the target window
3983 * the new feature of video conference,
3984 * the uncovered area of the surface is filled by this color
3985 * also it will blend with the decoded video color
3987 VADisplayAttribBackgroundColor = 4,
3989 * this is a gettable only attribute. For some implementations that use the
3990 * hardware overlay, after PutSurface is called, the surface can not be
3991 * re-used until after the subsequent PutSurface call. If this is the case
3992 * then the value for this attribute will be set to 1 so that the client
3993 * will not attempt to re-use the surface right after returning from a call
3996 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3997 * driver may use overlay or GPU alternatively
3999 VADisplayAttribDirectSurface = 5,
4000 VADisplayAttribRotation = 6,
4001 VADisplayAttribOutofLoopDeblock = 7,
4003 /* PowerVR IEP Lite specific attributes */
4004 VADisplayAttribBLEBlackMode = 8,
4005 VADisplayAttribBLEWhiteMode = 9,
4006 VADisplayAttribBlueStretch = 10,
4007 VADisplayAttribSkinColorCorrection = 11,
4009 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
4010 * conversion matrix. Each element in the matrix is float-point
4012 VADisplayAttribCSCMatrix = 12,
4013 /* specify the constant color used to blend with video surface
4014 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
4015 * d: the final color to overwrite into the frame buffer
4016 * v: decoded video after color conversion,
4017 * c: video color specified by VADisplayAttribBlendColor
4018 * b: background color of the drawable
4020 VADisplayAttribBlendColor = 13,
4022 * Indicate driver to skip painting color key or not.
4023 * only applicable if the render is overlay
4025 VADisplayAttribOverlayAutoPaintColorKey = 14,
4027 * customized overlay color key, the format is RGB888
4028 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
4030 VADisplayAttribOverlayColorKey = 15,
4032 * The hint for the implementation of vaPutSurface
4033 * normally, the driver could use an overlay or GPU to render the surface on the screen
4034 * this flag provides APP the flexibity to switch the render dynamically
4036 VADisplayAttribRenderMode = 16,
4038 * specify if vaPutSurface needs to render into specified monitors
4039 * one example is that one external monitor (e.g. HDMI) is enabled,
4040 * but the window manager is not aware of it, and there is no associated drawable
4042 VADisplayAttribRenderDevice = 17,
4044 * specify vaPutSurface render area if there is no drawable on the monitor
4046 VADisplayAttribRenderRect = 18,
4047 } VADisplayAttribType;
4049 /* flags for VADisplayAttribute */
4050 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
4051 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
4052 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
4054 typedef struct _VADisplayAttribute
4056 VADisplayAttribType type;
4059 int32_t value; /* used by the set/get attribute functions */
4060 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
4063 /** \brief Reserved bytes for future use, must be zero */
4064 uint32_t va_reserved[VA_PADDING_LOW];
4065 } VADisplayAttribute;
4067 /** Get maximum number of display attributs supported by the implementation */
4068 int vaMaxNumDisplayAttributes (
4073 * Query display attributes
4074 * The caller must provide a "attr_list" array that can hold at
4075 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
4076 * returned in "attr_list" is returned in "num_attributes".
4078 VAStatus vaQueryDisplayAttributes (
4080 VADisplayAttribute *attr_list, /* out */
4081 int *num_attributes /* out */
4085 * Get display attributes
4086 * This function returns the current attribute values in "attr_list".
4087 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
4088 * from vaQueryDisplayAttributes() can have their values retrieved.
4090 VAStatus vaGetDisplayAttributes (
4092 VADisplayAttribute *attr_list, /* in/out */
4097 * Set display attributes
4098 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
4099 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
4100 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
4102 VAStatus vaSetDisplayAttributes (
4104 VADisplayAttribute *attr_list,
4108 /****************************
4109 * HEVC data structures
4110 ****************************/
4112 * \brief Description of picture properties of those in DPB surfaces.
4114 * If only progressive scan is supported, each surface contains one whole
4116 * Otherwise, each surface contains two fields of whole picture.
4117 * In this case, two entries of ReferenceFrames[] may share same picture_id
4120 typedef struct _VAPictureHEVC
4122 /** \brief reconstructed picture buffer surface index
4123 * invalid when taking value VA_INVALID_SURFACE.
4125 VASurfaceID picture_id;
4126 /** \brief picture order count.
4127 * in HEVC, POCs for top and bottom fields of same picture should
4128 * take different values.
4130 int32_t pic_order_cnt;
4131 /* described below */
4134 /** \brief Reserved bytes for future use, must be zero */
4135 uint32_t va_reserved[VA_PADDING_LOW];
4138 /* flags in VAPictureHEVC could be OR of the following */
4139 #define VA_PICTURE_HEVC_INVALID 0x00000001
4140 /** \brief indication of interlace scan picture.
4141 * should take same value for all the pictures in sequence.
4143 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
4144 /** \brief polarity of the field picture.
4145 * top field takes even lines of buffer surface.
4146 * bottom field takes odd lines of buffer surface.
4148 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
4149 /** \brief Long term reference picture */
4150 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
4152 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
4153 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
4154 * be exclusive. No more than one of them can be set for any picture.
4155 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
4156 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
4157 * Application should provide valid values for both short format and long format.
4158 * The pictures in DPB with any of these three flags turned on are referred by
4159 * the current picture.
4161 /** \brief RefPicSetStCurrBefore of HEVC spec variable
4162 * Number of ReferenceFrames[] entries with this bit set equals
4163 * NumPocStCurrBefore.
4165 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
4166 /** \brief RefPicSetStCurrAfter of HEVC spec variable
4167 * Number of ReferenceFrames[] entries with this bit set equals
4168 * NumPocStCurrAfter.
4170 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
4171 /** \brief RefPicSetLtCurr of HEVC spec variable
4172 * Number of ReferenceFrames[] entries with this bit set equals
4175 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
4177 #include <va/va_dec_hevc.h>
4178 #include <va/va_dec_jpeg.h>
4179 #include <va/va_dec_vp8.h>
4180 #include <va/va_dec_vp9.h>
4181 #include <va/va_enc_hevc.h>
4182 #include <va/va_fei_hevc.h>
4183 #include <va/va_enc_h264.h>
4184 #include <va/va_enc_jpeg.h>
4185 #include <va/va_enc_mpeg2.h>
4186 #include <va/va_enc_vp8.h>
4187 #include <va/va_enc_vp9.h>
4188 #include <va/va_fei.h>
4189 #include <va/va_fei_h264.h>
4190 #include <va/va_vpp.h>