2 * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19 * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
20 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 * Video Acceleration (VA) API Specification
28 * <jonathan.bian@intel.com>
31 * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
32 * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
33 * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
34 * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
35 * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
36 * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
37 * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
38 * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
39 * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
40 * and MPEG-2 motion compensation.
41 * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
42 * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
43 * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
44 * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
45 * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
46 * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
47 * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
48 * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
49 * rev 0.27 (11/19/2007 Matt Sottek) - Added DeriveImage
50 * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
52 * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
53 * added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
54 * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
55 * for ISO C conformance.
56 * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
57 * Application needs to relink with the new library.
59 * rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
60 * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
61 * screen relative rather than source video relative.
62 * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
63 * update VAAPI to 0.32.0
66 * Some concepts borrowed from XvMC and XvImage.
67 * Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
68 * contributed to various aspects of the API.
75 * This file contains the \ref api_core "Core API".
83 #include <va/va_version.h>
89 #if defined(__GNUC__) && !defined(__COVERITY__)
90 #define va_deprecated __attribute__((deprecated))
92 #define va_deprecated_enum va_deprecated
94 #define va_deprecated_enum
98 #define va_deprecated_enum
102 * \mainpage Video Acceleration (VA) API
104 * \section intro Introduction
106 * The main motivation for VA-API (Video Acceleration API) is to
107 * enable hardware accelerated video decode and encode at various
108 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
109 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
110 * AVC/H.264, VC-1/VMW3, and JPEG, HEVC/H265, VP8, VP9) and video pre/post
113 * VA-API is split into several modules:
115 * - Encoder (H264, HEVC, JPEG, MPEG2, VP8, VP9)
116 * - \ref api_enc_h264
117 * - \ref api_enc_hevc
118 * - \ref api_enc_jpeg
119 * - \ref api_enc_mpeg2
122 * - Decoder (HEVC, JPEG, VP8, VP9)
123 * - \ref api_dec_hevc
124 * - \ref api_dec_jpeg
130 * - \ref api_fei_h264
131 * - \ref api_fei_hevc
135 * \defgroup api_core Core API
143 The VA API is intended to provide an interface between a video decode/encode/processing
144 application (client) and a hardware accelerator (server), to off-load
145 video decode/encode/processing operations from the host to the hardware accelerator at various
148 The basic operation steps are:
150 - Negotiate a mutually acceptable configuration with the server to lock
151 down profile, entrypoints, and other attributes that will not change on
152 a frame-by-frame basis.
153 - Create a video decode, encode or processing context which represents a
154 "virtualized" hardware device
155 - Get and fill the render buffers with the corresponding data (depending on
156 profiles and entrypoints)
157 - Pass the render buffers to the server to handle the current frame
159 Initialization & Configuration Management
161 - Find out supported profiles
162 - Find out entrypoints for a given profile
163 - Find out configuration attributes for a given profile/entrypoint pair
164 - Create a configuration for use by the application
168 typedef void* VADisplay; /* window system dependent */
170 typedef int VAStatus; /** Return status type from functions */
171 /** Values for the return status */
172 #define VA_STATUS_SUCCESS 0x00000000
173 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
174 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
175 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
176 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
177 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
178 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
179 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
180 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
181 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
182 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
183 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
184 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
185 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
186 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
187 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
188 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
189 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
190 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
191 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
192 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
193 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
194 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
195 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
196 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
198 * \brief An invalid/unsupported value was supplied.
200 * This is a catch-all error code for invalid or unsupported values.
201 * e.g. value exceeding the valid range, invalid type in the context
202 * of generic attribute values.
204 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
205 /** \brief An unsupported filter was supplied. */
206 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
207 /** \brief An invalid filter chain was supplied. */
208 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
209 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
210 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
211 /** \brief An unsupported memory type was supplied. */
212 #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
213 /** \brief Indicate allocated buffer size is not enough for input or output. */
214 #define VA_STATUS_ERROR_NOT_ENOUGH_BUFFER 0x00000025
215 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
217 /** De-interlacing flags for vaPutSurface() */
218 #define VA_FRAME_PICTURE 0x00000000
219 #define VA_TOP_FIELD 0x00000001
220 #define VA_BOTTOM_FIELD 0x00000002
223 * Enabled the positioning/cropping/blending feature:
224 * 1, specify the video playback position in the isurface
225 * 2, specify the cropping info for video playback
226 * 3, encoded video will blend with background color
228 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
231 * Clears the drawable with background color.
232 * for hardware overlay based implementation this flag
233 * can be used to turn off the overlay
235 #define VA_CLEAR_DRAWABLE 0x00000008
237 /** Color space conversion flags for vaPutSurface() */
238 #define VA_SRC_COLOR_MASK 0x000000f0
239 #define VA_SRC_BT601 0x00000010
240 #define VA_SRC_BT709 0x00000020
241 #define VA_SRC_SMPTE_240 0x00000040
243 /** Scaling flags for vaPutSurface() */
244 #define VA_FILTER_SCALING_DEFAULT 0x00000000
245 #define VA_FILTER_SCALING_FAST 0x00000100
246 #define VA_FILTER_SCALING_HQ 0x00000200
247 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
248 #define VA_FILTER_SCALING_MASK 0x00000f00
250 /** Padding size in 4-bytes */
251 #define VA_PADDING_LOW 4
252 #define VA_PADDING_MEDIUM 8
253 #define VA_PADDING_HIGH 16
254 #define VA_PADDING_LARGE 32
257 * Returns a short english description of error_status
259 const char *vaErrorStr(VAStatus error_status);
261 typedef struct _VARectangle
269 /** \brief Generic motion vector data structure. */
270 typedef struct _VAMotionVector {
271 /** \mv0[0]: horizontal motion vector for past reference */
272 /** \mv0[1]: vertical motion vector for past reference */
273 /** \mv1[0]: horizontal motion vector for future reference */
274 /** \mv1[1]: vertical motion vector for future reference */
275 int16_t mv0[2]; /* past reference */
276 int16_t mv1[2]; /* future reference */
279 /** Type of a message callback, used for both error and info log. */
280 typedef void (*VAMessageCallback)(void *user_context, const char *message);
283 * Set the callback for error messages, or NULL for no logging.
284 * Returns the previous one, or NULL if it was disabled.
286 VAMessageCallback vaSetErrorCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
289 * Set the callback for info messages, or NULL for no logging.
290 * Returns the previous one, or NULL if it was disabled.
292 VAMessageCallback vaSetInfoCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
296 * A display must be obtained by calling vaGetDisplay() before calling
297 * vaInitialize() and other functions. This connects the API to the
298 * native window system.
299 * For X Windows, native_dpy would be from XOpenDisplay()
301 typedef void* VANativeDisplay; /* window system dependent */
303 int vaDisplayIsValid(VADisplay dpy);
306 * Set the override driver name instead of queried driver driver.
308 VAStatus vaSetDriverName(VADisplay dpy,
313 * Initialize the library
315 VAStatus vaInitialize (
317 int *major_version, /* out */
318 int *minor_version /* out */
322 * After this call, all library internal resources will be cleaned up
324 VAStatus vaTerminate (
329 * vaQueryVendorString returns a pointer to a zero-terminated string
330 * describing some aspects of the VA implemenation on a specific
331 * hardware accelerator. The format of the returned string is vendor
332 * specific and at the discretion of the implementer.
333 * e.g. for the Intel GMA500 implementation, an example would be:
334 * "Intel GMA500 - 2.0.0.32L.0005"
336 const char *vaQueryVendorString (
340 typedef int (*VAPrivFunc)(void);
343 * Return a function pointer given a function name in the library.
344 * This allows private interfaces into the library
346 VAPrivFunc vaGetLibFunc (
351 /** Currently defined profiles */
354 /** \brief Profile ID used for video processing. */
356 VAProfileMPEG2Simple = 0,
357 VAProfileMPEG2Main = 1,
358 VAProfileMPEG4Simple = 2,
359 VAProfileMPEG4AdvancedSimple = 3,
360 VAProfileMPEG4Main = 4,
361 VAProfileH264Baseline va_deprecated_enum = 5,
362 VAProfileH264Main = 6,
363 VAProfileH264High = 7,
364 VAProfileVC1Simple = 8,
365 VAProfileVC1Main = 9,
366 VAProfileVC1Advanced = 10,
367 VAProfileH263Baseline = 11,
368 VAProfileJPEGBaseline = 12,
369 VAProfileH264ConstrainedBaseline = 13,
370 VAProfileVP8Version0_3 = 14,
371 VAProfileH264MultiviewHigh = 15,
372 VAProfileH264StereoHigh = 16,
373 VAProfileHEVCMain = 17,
374 VAProfileHEVCMain10 = 18,
375 VAProfileVP9Profile0 = 19,
376 VAProfileVP9Profile1 = 20,
377 VAProfileVP9Profile2 = 21,
378 VAProfileVP9Profile3 = 22,
379 VAProfileHEVCMain12 = 23,
380 VAProfileHEVCMain422_10 = 24,
381 VAProfileHEVCMain422_12 = 25,
382 VAProfileHEVCMain444 = 26,
383 VAProfileHEVCMain444_10 = 27,
384 VAProfileHEVCMain444_12 = 28,
385 VAProfileHEVCSccMain = 29,
386 VAProfileHEVCSccMain10 = 30,
387 VAProfileHEVCSccMain444 = 31
391 * Currently defined entrypoints
397 VAEntrypointIDCT = 3,
398 VAEntrypointMoComp = 4,
399 VAEntrypointDeblocking = 5,
400 VAEntrypointEncSlice = 6, /* slice level encode */
401 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
403 * For an implementation that supports a low power/high performance variant
404 * for slice level encode, it can choose to expose the
405 * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
406 * available with this entrypoint (e.g. interlace, MBAFF) and the
407 * application can query the encoding configuration attributes to find
408 * out more details if this entrypoint is supported.
410 VAEntrypointEncSliceLP = 8,
411 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
413 * \brief VAEntrypointFEI
415 * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to
416 * have more controls and trade off quality for speed with their own IPs.
417 * The application can optionally provide input to ENC for extra encode control
418 * and get the output from ENC. Application can chose to modify the ENC
419 * output/PAK input during encoding, but the performance impact is significant.
421 * On top of the existing buffers for normal encode, there will be
422 * one extra input buffer (VAEncMiscParameterFEIFrameControl) and
423 * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType
424 * and VAEncFEIDistortionBufferType) for VAEntrypointFEI entry function.
425 * If separate PAK is set, two extra input buffers
426 * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input.
428 VAEntrypointFEI = 11,
430 * \brief VAEntrypointStats
432 * A pre-processing function for getting some statistics and motion vectors is added,
433 * and some extra controls for Encode pipeline are provided. The application can
434 * optionally call the statistics function to get motion vectors and statistics like
435 * variances, distortions before calling Encode function via this entry point.
437 * Checking whether Statistics is supported can be performed with vaQueryConfigEntrypoints().
438 * If Statistics entry point is supported, then the list of returned entry-points will
439 * include #VAEntrypointStats. Supported pixel format, maximum resolution and statistics
440 * specific attributes can be obtained via normal attribute query. One input buffer
441 * (VAStatsStatisticsParameterBufferType) and one or two output buffers
442 * (VAStatsStatisticsBufferType, VAStatsStatisticsBottomFieldBufferType (for interlace only)
443 * and VAStatsMVBufferType) are needed for this entry point.
445 VAEntrypointStats = 12,
448 /** Currently defined configuration attribute types */
451 VAConfigAttribRTFormat = 0,
452 VAConfigAttribSpatialResidual = 1,
453 VAConfigAttribSpatialClipping = 2,
454 VAConfigAttribIntraResidual = 3,
455 VAConfigAttribEncryption = 4,
456 VAConfigAttribRateControl = 5,
458 /** @name Attributes for decoding */
461 * \brief Slice Decoding mode. Read/write.
463 * This attribute determines what mode the driver supports for slice
464 * decoding, through vaGetConfigAttributes(); and what mode the user
465 * will be providing to the driver, through vaCreateConfig(), if the
466 * driver supports those. If this attribute is not set by the user then
467 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
469 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
471 VAConfigAttribDecSliceMode = 6,
473 * \brief JPEG decoding attribute. Read-only.
475 * This attribute exposes a number of capabilities of the underlying
476 * JPEG implementation. The attribute value is partitioned into fields as defined in the
477 * VAConfigAttribValDecJPEG union.
479 VAConfigAttribDecJPEG = 7,
481 * \brief Decode processing support. Read/write.
483 * This attribute determines if the driver supports video processing
484 * with decoding using the decoding context in a single call, through
485 * vaGetConfigAttributes(); and if the user may use this feature,
486 * through vaCreateConfig(), if the driver supports the user scenario.
487 * The user will essentially create a regular decode VAContext. Therefore,
488 * the parameters of vaCreateContext() such as picture_width, picture_height
489 * and render_targets are in relation to the decode output parameters
490 * (not processing output parameters) as normal.
491 * If this attribute is not set by the user then it is assumed that no
492 * extra processing is done after decoding for this decode context.
494 * Since essentially the application is creating a decoder config and context,
495 * all function calls that take in the config (e.g. vaQuerySurfaceAttributes())
496 * or context are in relation to the decoder, except those video processing
497 * function specified in the next paragraph.
499 * Once the decode config and context are created, the user must further
500 * query the supported processing filters using vaQueryVideoProcFilters(),
501 * vaQueryVideoProcFilterCaps(), vaQueryVideoProcPipelineCaps() by specifying
502 * the created decode context. The user must provide processing information
503 * and extra processing output surfaces as "additional_outputs" to the driver
504 * through VAProcPipelineParameterBufferType. The render_target specified
505 * at vaBeginPicture() time refers to the decode output surface. The
506 * target surface for the output of processing needs to be a different
507 * surface since the decode process requires the original reconstructed buffer.
508 * The “surface” member of VAProcPipelineParameterBuffer should be set to the
509 * same as “render_target” set in vaBeginPicture(), but the driver may choose
510 * to ignore this parameter.
512 VAConfigAttribDecProcessing = 8,
513 /** @name Attributes for encoding */
516 * \brief Packed headers mode. Read/write.
518 * This attribute determines what packed headers the driver supports,
519 * through vaGetConfigAttributes(); and what packed headers the user
520 * will be providing to the driver, through vaCreateConfig(), if the
521 * driver supports those.
523 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
525 VAConfigAttribEncPackedHeaders = 10,
527 * \brief Interlaced mode. Read/write.
529 * This attribute determines what kind of interlaced encoding mode
530 * the driver supports.
532 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
534 VAConfigAttribEncInterlaced = 11,
536 * \brief Maximum number of reference frames. Read-only.
538 * This attribute determines the maximum number of reference
539 * frames supported for encoding.
541 * Note: for H.264 encoding, the value represents the maximum number
542 * of reference frames for both the reference picture list 0 (bottom
543 * 16 bits) and the reference picture list 1 (top 16 bits).
545 VAConfigAttribEncMaxRefFrames = 13,
547 * \brief Maximum number of slices per frame. Read-only.
549 * This attribute determines the maximum number of slices the
550 * driver can support to encode a single frame.
552 VAConfigAttribEncMaxSlices = 14,
554 * \brief Slice structure. Read-only.
556 * This attribute determines slice structures supported by the
557 * driver for encoding. This attribute is a hint to the user so
558 * that he can choose a suitable surface size and how to arrange
559 * the encoding process of multiple slices per frame.
561 * More specifically, for H.264 encoding, this attribute
562 * determines the range of accepted values to
563 * VAEncSliceParameterBufferH264::macroblock_address and
564 * VAEncSliceParameterBufferH264::num_macroblocks.
566 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
569 VAConfigAttribEncSliceStructure = 15,
571 * \brief Macroblock information. Read-only.
573 * This attribute determines whether the driver supports extra
574 * encoding information per-macroblock. e.g. QP.
576 * More specifically, for H.264 encoding, if the driver returns a non-zero
577 * value for this attribute, this means the application can create
578 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
579 * through VAEncSliceParameterBufferH264::macroblock_info.
581 VAConfigAttribEncMacroblockInfo = 16,
583 * \brief Maximum picture width. Read-only.
585 * This attribute determines the maximum picture width the driver supports
586 * for a given configuration.
588 VAConfigAttribMaxPictureWidth = 18,
590 * \brief Maximum picture height. Read-only.
592 * This attribute determines the maximum picture height the driver supports
593 * for a given configuration.
595 VAConfigAttribMaxPictureHeight = 19,
597 * \brief JPEG encoding attribute. Read-only.
599 * This attribute exposes a number of capabilities of the underlying
600 * JPEG implementation. The attribute value is partitioned into fields as defined in the
601 * VAConfigAttribValEncJPEG union.
603 VAConfigAttribEncJPEG = 20,
605 * \brief Encoding quality range attribute. Read-only.
607 * This attribute conveys whether the driver supports different quality level settings
608 * for encoding. A value less than or equal to 1 means that the encoder only has a single
609 * quality setting, and a value greater than 1 represents the number of quality levels
610 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
612 VAConfigAttribEncQualityRange = 21,
614 * \brief Encoding quantization attribute. Read-only.
616 * This attribute conveys whether the driver supports certain types of quantization methods
617 * for encoding (e.g. trellis). See \c VA_ENC_QUANTIZATION_xxx for the list of quantization methods
619 VAConfigAttribEncQuantization = 22,
621 * \brief Encoding intra refresh attribute. Read-only.
623 * This attribute conveys whether the driver supports certain types of intra refresh methods
624 * for encoding (e.g. adaptive intra refresh or rolling intra refresh).
625 * See \c VA_ENC_INTRA_REFRESH_xxx for intra refresh methods
627 VAConfigAttribEncIntraRefresh = 23,
629 * \brief Encoding skip frame attribute. Read-only.
631 * This attribute conveys whether the driver supports sending skip frame parameters
632 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
633 * externally skipped frames.
635 VAConfigAttribEncSkipFrame = 24,
637 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
639 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
640 * based on user provided ROI rectangles. The attribute value is partitioned into fields
641 * as defined in the VAConfigAttribValEncROI union.
643 * If ROI encoding is supported, the ROI information is passed to the driver using
644 * VAEncMiscParameterTypeROI.
646 VAConfigAttribEncROI = 25,
648 * \brief Encoding extended rate control attribute. Read-only.
650 * This attribute conveys whether the driver supports any extended rate control features
651 * The attribute value is partitioned into fields as defined in the
652 * VAConfigAttribValEncRateControlExt union.
654 VAConfigAttribEncRateControlExt = 26,
656 * \brief Processing rate reporting attribute. Read-only.
658 * This attribute conveys whether the driver supports reporting of
659 * encode/decode processing rate based on certain set of parameters
660 * (i.e. levels, I frame internvals) for a given configuration.
661 * If this is supported, vaQueryProcessingRate() can be used to get
662 * encode or decode processing rate.
663 * See \c VA_PROCESSING_RATE_xxx for encode/decode processing rate
665 VAConfigAttribProcessingRate = 27,
667 * \brief Encoding dirty rectangle. Read-only.
669 * This attribute conveys whether the driver supports dirty rectangle.
670 * encoding, based on user provided ROI rectangles which indicate the rectangular areas
671 * where the content has changed as compared to the previous picture. The regions of the
672 * picture that are not covered by dirty rect rectangles are assumed to have not changed
673 * compared to the previous picture. The encoder may do some optimizations based on
674 * this information. The attribute value returned indicates the number of regions that
675 * are supported. e.g. A value of 0 means dirty rect encoding is not supported. If dirty
676 * rect encoding is supported, the ROI information is passed to the driver using
677 * VAEncMiscParameterTypeDirtyRect.
679 VAConfigAttribEncDirtyRect = 28,
681 * \brief Parallel Rate Control (hierachical B) attribute. Read-only.
683 * This attribute conveys whether the encoder supports parallel rate control.
684 * It is a integer value 0 - unsupported, > 0 - maximum layer supported.
685 * This is the way when hireachical B frames are encoded, multiple independent B frames
686 * on the same layer may be processed at same time. If supported, app may enable it by
687 * setting enable_parallel_brc in VAEncMiscParameterRateControl,and the number of B frames
688 * per layer per GOP will be passed to driver through VAEncMiscParameterParallelRateControl
689 * structure.Currently three layers are defined.
691 VAConfigAttribEncParallelRateControl = 29,
693 * \brief Dynamic Scaling Attribute. Read-only.
695 * This attribute conveys whether encoder is capable to determine dynamic frame
696 * resolutions adaptive to bandwidth utilization and processing power, etc.
697 * It is a boolean value 0 - unsupported, 1 - supported.
698 * If it is supported,for VP9, suggested frame resolution can be retrieved from VACodedBufferVP9Status.
700 VAConfigAttribEncDynamicScaling = 30,
702 * \brief frame size tolerance support
703 * it indicates the tolerance of frame size
705 VAConfigAttribFrameSizeToleranceSupport = 31,
707 * \brief Encode function type for FEI.
709 * This attribute conveys whether the driver supports different function types for encode.
710 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
711 * it is for FEI entry point only.
712 * Default is VA_FEI_FUNCTION_ENC_PAK.
714 VAConfigAttribFEIFunctionType = 32,
716 * \brief Maximum number of FEI MV predictors. Read-only.
718 * This attribute determines the maximum number of MV predictors the driver
719 * can support to encode a single frame. 0 means no MV predictor is supported.
720 * Currently it is for FEI entry point only.
722 VAConfigAttribFEIMVPredictors = 33,
724 * \brief Statistics attribute. Read-only.
726 * This attribute exposes a number of capabilities of the VAEntrypointStats entry
727 * point. The attribute value is partitioned into fields as defined in the
728 * VAConfigAttribValStats union. Currently it is for VAEntrypointStats only.
730 VAConfigAttribStats = 34,
732 * \brief Tile Support Attribute. Read-only.
734 * This attribute conveys whether encoder is capable to support tiles.
735 * If not supported, the tile related parameters sent to encoder, such as
736 * tiling structure, should be ignored. 0 - unsupported, 1 - supported.
738 VAConfigAttribEncTileSupport = 35,
740 * \brief whether accept rouding setting from application. Read-only.
741 * This attribute is for encode quality, if it is report,
742 * application can change the rounding setting by VAEncMiscParameterTypeCustomRoundingControl
744 VAConfigAttribCustomRoundingControl = 36,
746 * \brief Encoding QP info block size attribute. Read-only.
747 * This attribute conveys the block sizes that underlying driver
748 * support for QP info for buffer #VAEncQpBuffer.
750 VAConfigAttribQPBlockSize = 37,
752 VAConfigAttribTypeMax
753 } VAConfigAttribType;
756 * Configuration attributes
757 * If there is more than one value for an attribute, a default
758 * value will be assigned to the attribute if the client does not
759 * specify the attribute when creating a configuration
761 typedef struct _VAConfigAttrib {
762 VAConfigAttribType type;
763 uint32_t value; /* OR'd flags (bits) for this attribute */
766 /* Attribute values for VAConfigAttribRTFormat. */
768 #define VA_RT_FORMAT_YUV420 0x00000001 ///< YUV 4:2:0 8-bit.
769 #define VA_RT_FORMAT_YUV422 0x00000002 ///< YUV 4:2:2 8-bit.
770 #define VA_RT_FORMAT_YUV444 0x00000004 ///< YUV 4:4:4 8-bit.
771 #define VA_RT_FORMAT_YUV411 0x00000008 ///< YUV 4:1:1 8-bit.
772 #define VA_RT_FORMAT_YUV400 0x00000010 ///< Greyscale 8-bit.
773 #define VA_RT_FORMAT_YUV420_10 0x00000100 ///< YUV 4:2:0 10-bit.
774 #define VA_RT_FORMAT_YUV422_10 0x00000200 ///< YUV 4:2:2 10-bit.
775 #define VA_RT_FORMAT_YUV444_10 0x00000400 ///< YUV 4:4:4 10-bit.
776 #define VA_RT_FORMAT_YUV420_12 0x00001000 ///< YUV 4:2:0 12-bit.
777 #define VA_RT_FORMAT_YUV422_12 0x00002000 ///< YUV 4:2:2 12-bit.
778 #define VA_RT_FORMAT_YUV444_12 0x00004000 ///< YUV 4:4:4 12-bit.
780 #define VA_RT_FORMAT_RGB16 0x00010000 ///< Packed RGB, 16 bits per pixel.
781 #define VA_RT_FORMAT_RGB32 0x00020000 ///< Packed RGB, 32 bits per pixel, 8 bits per colour sample.
782 #define VA_RT_FORMAT_RGBP 0x00100000 ///< Planar RGB, 8 bits per sample.
783 #define VA_RT_FORMAT_RGB32_10 0x00200000 ///< Packed RGB, 32 bits per pixel, 10 bits per colour sample.
785 #define VA_RT_FORMAT_PROTECTED 0x80000000
787 #define VA_RT_FORMAT_RGB32_10BPP VA_RT_FORMAT_RGB32_10 ///< @deprecated use VA_RT_FORMAT_RGB32_10 instead.
788 #define VA_RT_FORMAT_YUV420_10BPP VA_RT_FORMAT_YUV420_10 ///< @deprecated use VA_RT_FORMAT_YUV420_10 instead.
790 /** @name Attribute values for VAConfigAttribRateControl */
792 /** \brief Driver does not support any form of rate control. */
793 #define VA_RC_NONE 0x00000001
794 /** \brief Constant bitrate. */
795 #define VA_RC_CBR 0x00000002
796 /** \brief Variable bitrate. */
797 #define VA_RC_VBR 0x00000004
798 /** \brief Video conference mode. */
799 #define VA_RC_VCM 0x00000008
800 /** \brief Constant QP. */
801 #define VA_RC_CQP 0x00000010
802 /** \brief Variable bitrate with peak rate higher than average bitrate. */
803 #define VA_RC_VBR_CONSTRAINED 0x00000020
804 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
805 * adjusts QP at a frame and MB level based on motion to improve subjective quality. */
806 #define VA_RC_ICQ 0x00000040
807 /** \brief Macroblock based rate control. Per MB control is decided
808 * internally in the encoder. It may be combined with other RC modes, except CQP. */
809 #define VA_RC_MB 0x00000080
810 /** \brief Constant Frame Size, it is used for small tolerent */
811 #define VA_RC_CFS 0x00000100
812 /** \brief Parallel BRC, for hierachical B.
814 * For hierachical B, B frames can be refered by other B frames.
815 * Currently three layers of hierachy are defined:
816 * B0 - regular B, no reference to other B frames.
817 * B1 - reference to only I, P and regular B0 frames.
818 * B2 - reference to any other frames, including B1.
819 * In Hierachical B structure, B frames on the same layer can be processed
820 * simultaneously. And BRC would adjust accordingly. This is so called
822 #define VA_RC_PARALLEL 0x00000200
823 /** \brief Quality defined VBR
824 * Use Quality factor to determine the good enough QP for each MB such that
825 * good enough quality can be obtained without waste of bits
826 * for this BRC mode, you must set all legacy VBR parameters
827 * and reuse quality_factor in \c VAEncMiscParameterRateControl
829 #define VA_RC_QVBR 0x00000400
830 /** \brief Average VBR
831 * Average variable bitrate control algorithm focuses on overall encoding
832 * quality while meeting the specified target bitrate, within the accuracy
833 * range, after a convergence period.
834 * bits_per_second in VAEncMiscParameterRateControl is target bitrate for AVBR.
835 * Convergence is specified in the unit of frame.
836 * window_size in VAEncMiscParameterRateControl is equal to convergence for AVBR.
837 * Accuracy is in the range of [1,100], 1 means one percent, and so on.
838 * target_percentage in VAEncMiscParameterRateControl is equal to accuracy for AVBR. */
839 #define VA_RC_AVBR 0x00000800
843 /** @name Attribute values for VAConfigAttribDecSliceMode */
845 /** \brief Driver supports normal mode for slice decoding */
846 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
847 /** \brief Driver supports base mode for slice decoding */
848 #define VA_DEC_SLICE_MODE_BASE 0x00000002
850 /** @name Attribute values for VAConfigAttribDecJPEG */
852 typedef union _VAConfigAttribValDecJPEG {
854 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
855 uint32_t rotation : 4;
856 /** \brief Reserved for future use. */
857 uint32_t reserved : 28;
860 uint32_t va_reserved[VA_PADDING_LOW];
861 } VAConfigAttribValDecJPEG;
862 /** @name Attribute values for VAConfigAttribDecProcessing */
864 /** \brief No decoding + processing in a single decoding call. */
865 #define VA_DEC_PROCESSING_NONE 0x00000000
866 /** \brief Decode + processing in a single decoding call. */
867 #define VA_DEC_PROCESSING 0x00000001
870 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
872 /** \brief Driver does not support any packed headers mode. */
873 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
875 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
877 * Application must provide it to driver once this flag is returned through
878 * vaGetConfigAttributes()
880 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
882 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
884 * Application must provide it to driver once this falg is returned through
885 * vaGetConfigAttributes()
887 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
889 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
891 * Application must provide it to driver once this flag is returned through
892 * vaGetConfigAttributes()
894 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
896 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
899 * This is a deprecated packed header flag, All applications can use
900 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
901 * header data buffer to the driver
903 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
904 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
905 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
908 /** @name Attribute values for VAConfigAttribEncInterlaced */
910 /** \brief Driver does not support interlaced coding. */
911 #define VA_ENC_INTERLACED_NONE 0x00000000
912 /** \brief Driver supports interlaced frame coding. */
913 #define VA_ENC_INTERLACED_FRAME 0x00000001
914 /** \brief Driver supports interlaced field coding. */
915 #define VA_ENC_INTERLACED_FIELD 0x00000002
916 /** \brief Driver supports macroblock adaptive frame field coding. */
917 #define VA_ENC_INTERLACED_MBAFF 0x00000004
918 /** \brief Driver supports picture adaptive frame field coding. */
919 #define VA_ENC_INTERLACED_PAFF 0x00000008
922 /** @name Attribute values for VAConfigAttribEncSliceStructure */
924 /** \brief Driver supports a power-of-two number of rows per slice. */
925 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
926 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
927 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
928 /** \brief Dirver support 1 rows per slice */
929 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
930 /** \brief Dirver support max encoded slice size per slice */
931 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
932 /** \brief Driver supports an arbitrary number of rows per slice. */
933 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
936 /** \brief Attribute value for VAConfigAttribEncJPEG */
937 typedef union _VAConfigAttribValEncJPEG {
939 /** \brief set to 1 for arithmatic coding. */
940 uint32_t arithmatic_coding_mode : 1;
941 /** \brief set to 1 for progressive dct. */
942 uint32_t progressive_dct_mode : 1;
943 /** \brief set to 1 for non-interleaved. */
944 uint32_t non_interleaved_mode : 1;
945 /** \brief set to 1 for differential. */
946 uint32_t differential_mode : 1;
947 uint32_t max_num_components : 3;
948 uint32_t max_num_scans : 4;
949 uint32_t max_num_huffman_tables : 3;
950 uint32_t max_num_quantization_tables : 3;
953 } VAConfigAttribValEncJPEG;
955 /** @name Attribute values for VAConfigAttribEncQuantization */
957 /** \brief Driver does not support special types of quantization */
958 #define VA_ENC_QUANTIZATION_NONE 0x00000000
959 /** \brief Driver supports trellis quantization */
960 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
963 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
965 /** \brief Driver does not support intra refresh */
966 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
967 /** \brief Driver supports column based rolling intra refresh */
968 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
969 /** \brief Driver supports row based rolling intra refresh */
970 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
971 /** \brief Driver supports adaptive intra refresh */
972 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
973 /** \brief Driver supports cyclic intra refresh */
974 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
975 /** \brief Driver supports intra refresh of P frame*/
976 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
977 /** \brief Driver supports intra refresh of B frame */
978 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
979 /** \brief Driver supports intra refresh of multiple reference encoder */
980 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
984 /** \brief Attribute value for VAConfigAttribEncROI */
985 typedef union _VAConfigAttribValEncROI {
987 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
988 uint32_t num_roi_regions : 8;
990 * \brief A flag indicates whether ROI priority is supported
992 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
993 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
994 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
995 * the underlying driver doesn't support ROI priority.
997 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
998 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
1000 uint32_t roi_rc_priority_support : 1;
1002 * \brief A flag indicates whether ROI delta QP is supported
1004 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
1005 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
1006 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
1007 * the underlying driver doesn't support ROI delta QP.
1009 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
1010 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
1012 uint32_t roi_rc_qp_delta_support : 1;
1013 uint32_t reserved : 22;
1016 } VAConfigAttribValEncROI;
1018 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
1019 typedef union _VAConfigAttribValEncRateControlExt {
1022 * \brief The maximum number of temporal layers minus 1
1024 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
1025 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
1026 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
1028 uint32_t max_num_temporal_layers_minus1 : 8;
1031 * /brief support temporal layer bit-rate control flag
1033 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
1034 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
1035 * #VAConfigAttribRateControl == #VA_RC_VBR).
1037 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
1038 * \c max_num_temporal_layers_minus1 is equal to 0
1040 * To use bit-rate control per temporal layer, an application must send the right layer
1041 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
1042 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
1043 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
1044 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
1045 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
1046 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
1047 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
1049 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
1050 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
1051 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
1053 uint32_t temporal_layer_bitrate_control_flag : 1;
1054 uint32_t reserved : 23;
1057 } VAConfigAttribValEncRateControlExt;
1059 /** @name Attribute values for VAConfigAttribProcessingRate. */
1061 /** \brief Driver does not support processing rate report */
1062 #define VA_PROCESSING_RATE_NONE 0x00000000
1063 /** \brief Driver supports encode processing rate report */
1064 #define VA_PROCESSING_RATE_ENCODE 0x00000001
1065 /** \brief Driver supports decode processing rate report */
1066 #define VA_PROCESSING_RATE_DECODE 0x00000002
1069 * if an attribute is not applicable for a given
1070 * profile/entrypoint pair, then set the value to the following
1072 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
1074 /** Get maximum number of profiles supported by the implementation */
1075 int vaMaxNumProfiles (
1079 /** Get maximum number of entrypoints supported by the implementation */
1080 int vaMaxNumEntrypoints (
1084 /** Get maximum number of attributs supported by the implementation */
1085 int vaMaxNumConfigAttributes (
1090 * Query supported profiles
1091 * The caller must provide a "profile_list" array that can hold at
1092 * least vaMaxNumProfile() entries. The actual number of profiles
1093 * returned in "profile_list" is returned in "num_profile".
1095 VAStatus vaQueryConfigProfiles (
1097 VAProfile *profile_list, /* out */
1098 int *num_profiles /* out */
1102 * Query supported entrypoints for a given profile
1103 * The caller must provide an "entrypoint_list" array that can hold at
1104 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
1105 * returned in "entrypoint_list" is returned in "num_entrypoints".
1107 VAStatus vaQueryConfigEntrypoints (
1110 VAEntrypoint *entrypoint_list, /* out */
1111 int *num_entrypoints /* out */
1115 * Get attributes for a given profile/entrypoint pair
1116 * The caller must provide an "attrib_list" with all attributes to be
1117 * retrieved. Upon return, the attributes in "attrib_list" have been
1118 * updated with their value. Unknown attributes or attributes that are
1119 * not supported for the given profile/entrypoint pair will have their
1120 * value set to VA_ATTRIB_NOT_SUPPORTED
1122 VAStatus vaGetConfigAttributes (
1125 VAEntrypoint entrypoint,
1126 VAConfigAttrib *attrib_list, /* in/out */
1130 /** Generic ID type, can be re-typed for specific implementation */
1131 typedef unsigned int VAGenericID;
1133 typedef VAGenericID VAConfigID;
1136 * Create a configuration for the video decode/encode/processing pipeline
1137 * it passes in the attribute list that specifies the attributes it cares
1138 * about, with the rest taking default values.
1140 VAStatus vaCreateConfig (
1143 VAEntrypoint entrypoint,
1144 VAConfigAttrib *attrib_list,
1146 VAConfigID *config_id /* out */
1150 * Free resources associdated with a given config
1152 VAStatus vaDestroyConfig (
1154 VAConfigID config_id
1158 * Query all attributes for a given configuration
1159 * The profile of the configuration is returned in "profile"
1160 * The entrypoint of the configuration is returned in "entrypoint"
1161 * The caller must provide an "attrib_list" array that can hold at least
1162 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1163 * returned in "attrib_list" is returned in "num_attribs"
1165 VAStatus vaQueryConfigAttributes (
1167 VAConfigID config_id,
1168 VAProfile *profile, /* out */
1169 VAEntrypoint *entrypoint, /* out */
1170 VAConfigAttrib *attrib_list,/* out */
1171 int *num_attribs /* out */
1176 * Contexts and Surfaces
1178 * Context represents a "virtual" video decode, encode or video processing
1179 * pipeline. Surfaces are render targets for a given context. The data in the
1180 * surfaces are not accessible to the client except if derived image is supported
1181 * and the internal data format of the surface is implementation specific.
1183 * Surfaces are provided as a hint of what surfaces will be used when the context
1184 * is created through vaCreateContext(). A surface may be used by different contexts
1185 * at the same time as soon as application can make sure the operations are synchronized
1186 * between different contexts, e.g. a surface is used as the output of a decode context
1187 * and the input of a video process context. Surfaces can only be destroyed after all
1188 * contexts using these surfaces have been destroyed.
1190 * Both contexts and surfaces are identified by unique IDs and its
1191 * implementation specific internals are kept opaque to the clients
1194 typedef VAGenericID VAContextID;
1196 typedef VAGenericID VASurfaceID;
1198 #define VA_INVALID_ID 0xffffffff
1199 #define VA_INVALID_SURFACE VA_INVALID_ID
1201 /** \brief Generic value types. */
1203 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1204 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1205 VAGenericValueTypePointer, /**< Generic pointer type */
1206 VAGenericValueTypeFunc /**< Pointer to function */
1207 } VAGenericValueType;
1209 /** \brief Generic function type. */
1210 typedef void (*VAGenericFunc)(void);
1212 /** \brief Generic value. */
1213 typedef struct _VAGenericValue {
1214 /** \brief Value type. See #VAGenericValueType. */
1215 VAGenericValueType type;
1216 /** \brief Value holder. */
1218 /** \brief 32-bit signed integer. */
1220 /** \brief 32-bit float. */
1222 /** \brief Generic pointer. */
1224 /** \brief Pointer to function. */
1229 /** @name Surface attribute flags */
1231 /** \brief Surface attribute is not supported. */
1232 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1233 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1234 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1235 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1236 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1239 /** \brief Surface attribute types. */
1241 VASurfaceAttribNone = 0,
1243 * \brief Pixel format (fourcc).
1245 * The value is meaningful as input to vaQuerySurfaceAttributes().
1246 * If zero, the driver returns the optimal pixel format for the
1247 * specified config. Otherwise, if non-zero, the value represents
1248 * a pixel format (FOURCC) that is kept as is on output, if the
1249 * driver supports it. Otherwise, the driver sets the value to
1250 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1252 VASurfaceAttribPixelFormat,
1253 /** \brief Minimal width in pixels (int, read-only). */
1254 VASurfaceAttribMinWidth,
1255 /** \brief Maximal width in pixels (int, read-only). */
1256 VASurfaceAttribMaxWidth,
1257 /** \brief Minimal height in pixels (int, read-only). */
1258 VASurfaceAttribMinHeight,
1259 /** \brief Maximal height in pixels (int, read-only). */
1260 VASurfaceAttribMaxHeight,
1261 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1262 VASurfaceAttribMemoryType,
1263 /** \brief External buffer descriptor (pointer, write). */
1264 VASurfaceAttribExternalBufferDescriptor,
1265 /** \brief Surface usage hint, gives the driver a hint of intended usage
1266 * to optimize allocation (e.g. tiling) (int, read/write). */
1267 VASurfaceAttribUsageHint,
1268 /** \brief Number of surface attributes. */
1269 VASurfaceAttribCount
1270 } VASurfaceAttribType;
1272 /** \brief Surface attribute. */
1273 typedef struct _VASurfaceAttrib {
1275 VASurfaceAttribType type;
1276 /** \brief Flags. See "Surface attribute flags". */
1278 /** \brief Value. See "Surface attribute types" for the expected types. */
1279 VAGenericValue value;
1283 * @name VASurfaceAttribMemoryType values in bit fields.
1284 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1285 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1286 * types are defined in DRM and Android header files.
1289 /** \brief VA memory type (default) is supported. */
1290 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1291 /** \brief V4L2 buffer memory type is supported. */
1292 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1293 /** \brief User pointer memory type is supported. */
1294 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1298 * \brief VASurfaceAttribExternalBuffers structure for
1299 * the VASurfaceAttribExternalBufferDescriptor attribute.
1301 typedef struct _VASurfaceAttribExternalBuffers {
1302 /** \brief pixel format in fourcc. */
1303 uint32_t pixel_format;
1304 /** \brief width in pixels. */
1306 /** \brief height in pixels. */
1308 /** \brief total size of the buffer in bytes. */
1310 /** \brief number of planes for planar layout */
1311 uint32_t num_planes;
1312 /** \brief pitch for each plane in bytes */
1313 uint32_t pitches[4];
1314 /** \brief offset for each plane in bytes */
1315 uint32_t offsets[4];
1316 /** \brief buffer handles or user pointers */
1318 /** \brief number of elements in the "buffers" array */
1319 uint32_t num_buffers;
1320 /** \brief flags. See "Surface external buffer descriptor flags". */
1322 /** \brief reserved for passing private data */
1324 } VASurfaceAttribExternalBuffers;
1326 /** @name VASurfaceAttribExternalBuffers flags */
1328 /** \brief Enable memory tiling */
1329 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1330 /** \brief Memory is cacheable */
1331 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1332 /** \brief Memory is non-cacheable */
1333 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1334 /** \brief Memory is write-combined */
1335 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1336 /** \brief Memory is protected */
1337 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1339 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1341 /** \brief Surface usage not indicated. */
1342 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1343 /** \brief Surface used by video decoder. */
1344 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1345 /** \brief Surface used by video encoder. */
1346 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1347 /** \brief Surface read by video post-processing. */
1348 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1349 /** \brief Surface written by video post-processing. */
1350 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1351 /** \brief Surface used for display. */
1352 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1353 /** \brief Surface used for export to third-party APIs, e.g. via
1354 * vaExportSurfaceHandle(). */
1355 #define VA_SURFACE_ATTRIB_USAGE_HINT_EXPORT 0x00000020
1360 * \brief Queries surface attributes for the supplied config.
1362 * This function queries for all supported attributes for the
1363 * supplied VA @config. In particular, if the underlying hardware
1364 * supports the creation of VA surfaces in various formats, then
1365 * this function will enumerate all pixel formats that are supported.
1367 * The \c attrib_list array is allocated by the user and \c
1368 * num_attribs shall be initialized to the number of allocated
1369 * elements in that array. Upon successful return, the actual number
1370 * of attributes will be overwritten into \c num_attribs. Otherwise,
1371 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1372 * is adjusted to the number of elements that would be returned if
1373 * enough space was available.
1375 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1376 * argument when vaQuerySurfaceAttributes() is used to determine the
1377 * actual number of elements that need to be allocated.
1379 * @param[in] dpy the VA display
1380 * @param[in] config the config identifying a codec or a video
1381 * processing pipeline
1382 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1383 * @param[in,out] num_attribs the number of elements allocated on
1384 * input, the number of elements actually filled in output
1387 vaQuerySurfaceAttributes(
1390 VASurfaceAttrib *attrib_list,
1391 unsigned int *num_attribs
1395 * \brief Creates an array of surfaces
1397 * Creates an array of surfaces. The optional list of attributes shall
1398 * be constructed based on what the underlying hardware could expose
1399 * through vaQuerySurfaceAttributes().
1401 * @param[in] dpy the VA display
1402 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1403 * @param[in] width the surface width
1404 * @param[in] height the surface height
1405 * @param[out] surfaces the array of newly created surfaces
1406 * @param[in] num_surfaces the number of surfaces to create
1407 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1408 * @param[in] num_attribs the number of attributes supplied in
1409 * \c attrib_list, or zero
1414 unsigned int format,
1416 unsigned int height,
1417 VASurfaceID *surfaces,
1418 unsigned int num_surfaces,
1419 VASurfaceAttrib *attrib_list,
1420 unsigned int num_attribs
1424 * vaDestroySurfaces - Destroy resources associated with surfaces.
1425 * Surfaces can only be destroyed after all contexts using these surfaces have been
1428 * surfaces: array of surfaces to destroy
1429 * num_surfaces: number of surfaces in the array to be destroyed.
1431 VAStatus vaDestroySurfaces (
1433 VASurfaceID *surfaces,
1437 #define VA_PROGRESSIVE 0x1
1439 * vaCreateContext - Create a context
1441 * config_id: configuration for the context
1442 * picture_width: coded picture width
1443 * picture_height: coded picture height
1444 * flag: any combination of the following:
1445 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1446 * render_targets: a hint for render targets (surfaces) tied to the context
1447 * num_render_targets: number of render targets in the above array
1448 * context: created context id upon return
1450 VAStatus vaCreateContext (
1452 VAConfigID config_id,
1456 VASurfaceID *render_targets,
1457 int num_render_targets,
1458 VAContextID *context /* out */
1462 * vaDestroyContext - Destroy a context
1464 * context: context to be destroyed
1466 VAStatus vaDestroyContext (
1471 //Multi-frame context
1472 typedef VAGenericID VAMFContextID;
1474 * vaCreateMFContext - Create a multi-frame context
1475 * interface encapsulating common for all streams memory objects and structures
1476 * required for single GPU task submission from several VAContextID's.
1477 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1478 * Support identification: Application can identify multi-frame feature support by ability
1479 * to create multi-frame context. If driver supports multi-frame - call successful,
1480 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1481 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1483 * VA_STATUS_SUCCESS - operation successful.
1484 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1485 * dpy: display adapter.
1486 * mf_context: Multi-Frame context encapsulating all associated context
1487 * for multi-frame submission.
1489 VAStatus vaCreateMFContext (
1491 VAMFContextID *mf_context /* out */
1495 * vaMFAddContext - Provide ability to associate each context used for
1496 * Multi-Frame submission and common Multi-Frame context.
1497 * Try to add context to understand if it is supported.
1498 * Allocation: this call allocates and/or reallocates all memory objects
1499 * common for all contexts associated with particular Multi-Frame context.
1500 * All memory required for each context(pixel buffers, internal driver
1501 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1502 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1503 * first context added will set entry point/profile for whole Multi-Frame context,
1504 * all other entry points and profiles can be rejected to be added.
1506 * VA_STATUS_SUCCESS - operation successful, context was added.
1507 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1508 * current mf_context and associated contexts and start working with new ones.
1509 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1510 * 1 - mf_context is not valid context or
1511 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1512 * and current context contradicts with previously added, application can continue with current mf_context
1513 * and other contexts passed this call, rejected context can continue work in stand-alone
1514 * mode or other mf_context.
1515 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1516 * unsupported VAEntrypoint. Application can continue with current mf_context
1517 * and other contexts passed this call, rejected context can continue work in stand-alone
1519 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1520 * but VAProfile is not supported. Application can continue with current mf_context
1521 * and other contexts passed this call, rejected context can continue work in stand-alone
1523 * dpy: display adapter.
1524 * context: context being associated with Multi-Frame context.
1525 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1527 VAStatus vaMFAddContext (
1529 VAMFContextID mf_context,
1534 * vaMFReleaseContext - Removes context from multi-frame and
1535 * association with multi-frame context.
1536 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1538 * VA_STATUS_SUCCESS - operation successful, context was removed.
1539 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1540 * application need to destroy this VAMFContextID and all assotiated VAContextID
1542 * mf_context: VAMFContextID where context is added
1543 * context: VAContextID to be added
1545 VAStatus vaMFReleaseContext (
1547 VAMFContextID mf_context,
1553 * Buffers are used to pass various types of data from the
1554 * client to the server. The server maintains a data store
1555 * for each buffer created, and the client idenfies a buffer
1556 * through a unique buffer id assigned by the server.
1559 typedef VAGenericID VABufferID;
1563 VAPictureParameterBufferType = 0,
1564 VAIQMatrixBufferType = 1,
1565 VABitPlaneBufferType = 2,
1566 VASliceGroupMapBufferType = 3,
1567 VASliceParameterBufferType = 4,
1568 VASliceDataBufferType = 5,
1569 VAMacroblockParameterBufferType = 6,
1570 VAResidualDataBufferType = 7,
1571 VADeblockingParameterBufferType = 8,
1572 VAImageBufferType = 9,
1573 VAProtectedSliceDataBufferType = 10,
1574 VAQMatrixBufferType = 11,
1575 VAHuffmanTableBufferType = 12,
1576 VAProbabilityBufferType = 13,
1578 /* Following are encode buffer types */
1579 VAEncCodedBufferType = 21,
1580 VAEncSequenceParameterBufferType = 22,
1581 VAEncPictureParameterBufferType = 23,
1582 VAEncSliceParameterBufferType = 24,
1583 VAEncPackedHeaderParameterBufferType = 25,
1584 VAEncPackedHeaderDataBufferType = 26,
1585 VAEncMiscParameterBufferType = 27,
1586 VAEncMacroblockParameterBufferType = 28,
1587 VAEncMacroblockMapBufferType = 29,
1590 * \brief Encoding QP buffer
1592 * This buffer contains QP per MB for encoding. Currently
1593 * VAEncQPBufferH264 is defined for H.264 encoding, see
1594 * #VAEncQPBufferH264 for details
1596 VAEncQPBufferType = 30,
1597 /* Following are video processing buffer types */
1599 * \brief Video processing pipeline parameter buffer.
1601 * This buffer describes the video processing pipeline. See
1602 * #VAProcPipelineParameterBuffer for details.
1604 VAProcPipelineParameterBufferType = 41,
1606 * \brief Video filter parameter buffer.
1608 * This buffer describes the video filter parameters. All buffers
1609 * inherit from #VAProcFilterParameterBufferBase, thus including
1610 * a unique filter buffer type.
1612 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1613 * Filters requiring advanced parameters include, but are not limited to,
1614 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1615 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1617 VAProcFilterParameterBufferType = 42,
1619 * \brief FEI specific buffer types
1621 VAEncFEIMVBufferType = 43,
1622 VAEncFEIMBCodeBufferType = 44,
1623 VAEncFEIDistortionBufferType = 45,
1624 VAEncFEIMBControlBufferType = 46,
1625 VAEncFEIMVPredictorBufferType = 47,
1626 VAStatsStatisticsParameterBufferType = 48,
1627 /** \brief Statistics output for VAEntrypointStats progressive and top field of interlaced case*/
1628 VAStatsStatisticsBufferType = 49,
1629 /** \brief Statistics output for VAEntrypointStats bottom field of interlaced case*/
1630 VAStatsStatisticsBottomFieldBufferType = 50,
1631 VAStatsMVBufferType = 51,
1632 VAStatsMVPredictorBufferType = 52,
1633 /** Force MB's to be non skip for encode.it's per-mb control buffer, The width of the MB map
1634 * Surface is (width of the Picture in MB unit) * 1 byte, multiple of 64 bytes.
1635 * The height is (height of the picture in MB unit). The picture is either
1636 * frame or non-interleaved top or bottom field. If the application provides this
1637 *surface, it will override the "skipCheckDisable" setting in VAEncMiscParameterEncQuality.
1639 VAEncMacroblockDisableSkipMapBufferType = 53,
1641 * \brief HEVC FEI CTB level cmd buffer
1642 * it is CTB level information for future usage.
1644 VAEncFEICTBCmdBufferType = 54,
1646 * \brief HEVC FEI CU level data buffer
1647 * it's CTB level information for future usage
1649 VAEncFEICURecordBufferType = 55,
1650 /** decode stream out buffer, intermedia data of decode, it may include MV, MB mode etc.
1651 * it can be used to detect motion and analyze the frame contain */
1652 VADecodeStreamoutBufferType = 56,
1654 /** \brief HEVC Decoding Subset Parameter buffer type
1656 * The subsets parameter buffer is concatenation with one or multiple
1657 * subset entry point offsets. All the offset values are layed out one
1658 * by one according to slice order with first slice segment first, second
1659 * slice segment second, etc... The entry number is indicated by parameter
1660 * \ref num_entry_point_offsets. And the first entry position of the entry
1661 * point offsets for any slice segment is indicated by parameter
1662 * entry_offset_to_subset_array in VAPictureParameterBufferHEVC data structure.
1664 VASubsetsParameterBufferType = 57,
1670 * Processing rate parameter for encode.
1672 typedef struct _VAProcessingRateParameterEnc {
1673 /** \brief Profile level */
1675 uint8_t reserved[3];
1676 /** \brief quality level. When set to 0, default quality
1679 uint32_t quality_level;
1680 /** \brief Period between I frames. */
1681 uint32_t intra_period;
1682 /** \brief Period between I/P frames. */
1684 } VAProcessingRateParameterEnc;
1687 * Processing rate parameter for decode.
1689 typedef struct _VAProcessingRateParameterDec {
1690 /** \brief Profile level */
1692 uint8_t reserved0[3];
1694 } VAProcessingRateParameterDec;
1696 typedef struct _VAProcessingRateParameter {
1698 VAProcessingRateParameterEnc proc_buf_enc;
1699 VAProcessingRateParameterDec proc_buf_dec;
1701 } VAProcessingRateParameter;
1704 * \brief Queries processing rate for the supplied config.
1706 * This function queries the processing rate based on parameters in
1707 * \c proc_buf for the given \c config. Upon successful return, the processing
1708 * rate value will be stored in \c processing_rate. Processing rate is
1709 * specified as the number of macroblocks/CTU per second.
1711 * If NULL is passed to the \c proc_buf, the default processing rate for the
1712 * given configuration will be returned.
1714 * @param[in] dpy the VA display
1715 * @param[in] config the config identifying a codec or a video
1716 * processing pipeline
1717 * @param[in] proc_buf the buffer that contains the parameters for
1718 either the encode or decode processing rate
1719 * @param[out] processing_rate processing rate in number of macroblocks per
1720 second constrained by parameters specified in proc_buf
1724 vaQueryProcessingRate(
1727 VAProcessingRateParameter *proc_buf,
1728 unsigned int *processing_rate
1733 VAEncMiscParameterTypeFrameRate = 0,
1734 VAEncMiscParameterTypeRateControl = 1,
1735 VAEncMiscParameterTypeMaxSliceSize = 2,
1736 VAEncMiscParameterTypeAIR = 3,
1737 /** \brief Buffer type used to express a maximum frame size (in bits). */
1738 VAEncMiscParameterTypeMaxFrameSize = 4,
1739 /** \brief Buffer type used for HRD parameters. */
1740 VAEncMiscParameterTypeHRD = 5,
1741 VAEncMiscParameterTypeQualityLevel = 6,
1742 /** \brief Buffer type used for Rolling intra refresh */
1743 VAEncMiscParameterTypeRIR = 7,
1744 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1745 VAEncMiscParameterTypeQuantization = 8,
1746 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1747 * rate control, when the user has externally skipped frames. */
1748 VAEncMiscParameterTypeSkipFrame = 9,
1749 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1750 VAEncMiscParameterTypeROI = 10,
1751 /** \brief Buffer type used to express a maximum frame size (in bytes) settings for multiple pass. */
1752 VAEncMiscParameterTypeMultiPassFrameSize = 11,
1753 /** \brief Buffer type used for temporal layer structure */
1754 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1755 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1756 VAEncMiscParameterTypeDirtyRect = 13,
1757 /** \brief Buffer type used for parallel BRC parameters. */
1758 VAEncMiscParameterTypeParallelBRC = 14,
1759 /** \brief Set MB partion mode mask and Half-pel/Quant-pel motion search */
1760 VAEncMiscParameterTypeSubMbPartPel = 15,
1761 /** \brief set encode quality tuning */
1762 VAEncMiscParameterTypeEncQuality = 16,
1763 /** \brief Buffer type used for encoder rounding offset parameters. */
1764 VAEncMiscParameterTypeCustomRoundingControl = 17,
1765 /** \brief Buffer type used for FEI input frame level parameters */
1766 VAEncMiscParameterTypeFEIFrameControl = 18,
1767 /** \brief encode extension buffer, ect. MPEG2 Sequence extenstion data */
1768 VAEncMiscParameterTypeExtensionData = 19
1769 } VAEncMiscParameterType;
1771 /** \brief Packed header type. */
1773 /** \brief Packed sequence header. */
1774 VAEncPackedHeaderSequence = 1,
1775 /** \brief Packed picture header. */
1776 VAEncPackedHeaderPicture = 2,
1777 /** \brief Packed slice header. */
1778 VAEncPackedHeaderSlice = 3,
1780 * \brief Packed raw header.
1782 * Packed raw data header can be used by the client to insert a header
1783 * into the bitstream data buffer at the point it is passed, the driver
1784 * will handle the raw packed header based on "has_emulation_bytes" field
1785 * in the packed header parameter structure.
1787 VAEncPackedHeaderRawData = 4,
1789 * \brief Misc packed header. See codec-specific definitions.
1792 * This is a deprecated packed header type. All applications can use
1793 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1795 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1796 } VAEncPackedHeaderType;
1798 /** \brief Packed header parameter. */
1799 typedef struct _VAEncPackedHeaderParameterBuffer {
1800 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1802 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1803 uint32_t bit_length;
1804 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1805 uint8_t has_emulation_bytes;
1807 /** \brief Reserved bytes for future use, must be zero */
1808 uint32_t va_reserved[VA_PADDING_LOW];
1809 } VAEncPackedHeaderParameterBuffer;
1812 * For application, e.g. set a new bitrate
1813 * VABufferID buf_id;
1814 * VAEncMiscParameterBuffer *misc_param;
1815 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1817 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1818 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1819 * 1, NULL, &buf_id);
1821 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1822 * misc_param->type = VAEncMiscParameterTypeRateControl;
1823 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1824 * misc_rate_ctrl->bits_per_second = 6400000;
1825 * vaUnmapBuffer(dpy, buf_id);
1826 * vaRenderPicture(dpy, context, &buf_id, 1);
1828 typedef struct _VAEncMiscParameterBuffer
1830 VAEncMiscParameterType type;
1832 } VAEncMiscParameterBuffer;
1834 /** \brief Temporal layer Structure*/
1835 typedef struct _VAEncMiscParameterTemporalLayerStructure
1837 /** \brief The number of temporal layers */
1838 uint32_t number_of_layers;
1839 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1840 uint32_t periodicity;
1842 * \brief The array indicating the layer id for each frame
1844 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1845 * ids for frames starting from the 2nd frame.
1847 uint32_t layer_id[32];
1849 /** \brief Reserved bytes for future use, must be zero */
1850 uint32_t va_reserved[VA_PADDING_LOW];
1851 } VAEncMiscParameterTemporalLayerStructure;
1854 /** \brief Rate control parameters */
1855 typedef struct _VAEncMiscParameterRateControl
1857 /** The maximum bit-rate which the the rate controller should generate. */
1858 uint32_t bits_per_second;
1859 /** The target bit-rate which the rate controller should generate, as a percentage of the
1862 * In CBR mode this value is ignored (treated as 100%).
1864 uint32_t target_percentage;
1865 /** Rate control window size in milliseconds.
1867 * The rate controller will attempt to guarantee that the target and maximum bit-rates are
1868 * correct over this window.
1870 uint32_t window_size;
1871 /** Initial quantiser value used at the start of the stream.
1873 * Ignored if set to zero.
1875 uint32_t initial_qp;
1876 /** Minimum quantiser value to use.
1878 * The quantiser will not go below the value - if this limit is hit, the output bitrate may
1879 * be lower than the target. Ignored if set to zero.
1882 /** Basic unit size.
1884 * Only used by some drivers - see driver documentation for details. Set to zero if unused.
1886 uint32_t basic_unit_size;
1891 /** Force rate controller reset.
1893 * The next frame will be treated as the start of a new stream, with all rate
1894 * controller state reset to its initial values.
1897 /** Disable frame skip in rate control mode. */
1898 uint32_t disable_frame_skip : 1;
1899 /** Disable bit stuffing in rate control mode. */
1900 uint32_t disable_bit_stuffing : 1;
1901 /** Macroblock-level rate control.
1903 * 0: use default, 1: always enable, 2: always disable, other: reserved.
1905 * This feature is only available if VAConfigAttribRateControl has the
1906 * \ref VA_RC_MB bit set.
1908 uint32_t mb_rate_control : 4;
1909 /** The temporal layer that these rate control parameters apply to. */
1910 uint32_t temporal_id : 8;
1911 /** Ensure that intra frames also conform to the constant frame size. */
1912 uint32_t cfs_I_frames : 1;
1913 /** Enable parallel rate control for hierarchical B frames.
1915 * See \ref VA_RC_PARALLEL.
1917 uint32_t enable_parallel_brc : 1;
1918 uint32_t enable_dynamic_scaling : 1;
1919 /** Frame tolerance mode.
1921 * Indicates the tolerance the application has to variations in the frame size.
1922 * For example, wireless display scenarios may require very steady bit rate to
1923 * reduce buffering time. It affects the rate control algorithm used,
1924 * but may or may not have an effect based on the combination of other BRC
1925 * parameters. Only valid when the driver reports support for
1926 * #VAConfigAttribFrameSizeToleranceSupport.
1928 * equals 0 -- normal mode;
1929 * equals 1 -- maps to sliding window;
1930 * equals 2 -- maps to low delay mode;
1933 uint32_t frame_tolerance_mode : 2;
1934 /** Reserved for future use, must be zero. */
1935 uint32_t reserved : 12;
1939 /** Initial quality factor used in ICQ mode.
1941 * This value must be between 1 and 51.
1942 * this value will be deprecated in future, to use quality_factor instead of it.
1944 uint32_t ICQ_quality_factor;
1945 /** Maximum quantiser value to use.
1947 * The quantiser will not go above this value - if this limit is hit, the output bitrate
1948 * may exceed the target. Ignored if set to zero.
1953 * the range will be different for different codec
1955 uint32_t quality_factor;
1956 /** Reserved bytes for future use, must be zero. */
1957 uint32_t va_reserved[VA_PADDING_MEDIUM - 3];
1958 } VAEncMiscParameterRateControl;
1960 /** Encode framerate parameters.
1962 * Sets the encode framerate used by the rate controller. This should be
1963 * provided in all modes using a bitrate target (variable framerate is not
1966 typedef struct _VAEncMiscParameterFrameRate
1968 /** Encode framerate.
1970 * The framerate is specified as a number of frames per second, as a
1971 * fraction. The denominator of the fraction is given in the top half
1972 * (the high two bytes) of the framerate field, and the numerator is
1973 * given in the bottom half (the low two bytes).
1976 * denominator = framerate >> 16 & 0xffff;
1977 * numerator = framerate & 0xffff;
1978 * fps = numerator / denominator;
1980 * For example, if framerate is set to (100 << 16 | 750), this is
1981 * 750 / 100, hence 7.5fps.
1983 * If the denominator is zero (the high two bytes are both zero) then
1984 * it takes the value one instead, so the framerate is just the integer
1985 * in the low 2 bytes.
1992 /** The temporal layer that these framerate parameters apply to. */
1993 uint32_t temporal_id : 8;
1994 /** Reserved for future use, must be zero. */
1995 uint32_t reserved : 24;
2000 /** \brief Reserved bytes for future use, must be zero */
2001 uint32_t va_reserved[VA_PADDING_LOW];
2002 } VAEncMiscParameterFrameRate;
2005 * Allow a maximum slice size to be specified (in bits).
2006 * The encoder will attempt to make sure that individual slices do not exceed this size
2007 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
2009 typedef struct _VAEncMiscParameterMaxSliceSize
2011 uint32_t max_slice_size;
2013 /** \brief Reserved bytes for future use, must be zero */
2014 uint32_t va_reserved[VA_PADDING_LOW];
2015 } VAEncMiscParameterMaxSliceSize;
2017 typedef struct _VAEncMiscParameterAIR
2019 uint32_t air_num_mbs;
2020 uint32_t air_threshold;
2021 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
2023 /** \brief Reserved bytes for future use, must be zero */
2024 uint32_t va_reserved[VA_PADDING_LOW];
2025 } VAEncMiscParameterAIR;
2028 * \brief Rolling intra refresh data structure for encoding.
2030 typedef struct _VAEncMiscParameterRIR
2036 * \brief Indicate if intra refresh is enabled in column/row.
2038 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
2039 * by the driver before sending this structure.
2042 /* \brief enable RIR in column */
2043 uint32_t enable_rir_column : 1;
2044 /* \brief enable RIR in row */
2045 uint32_t enable_rir_row : 1;
2046 uint32_t reserved : 30;
2051 * \brief Indicates the column or row location in MB. It is ignored if
2054 uint16_t intra_insertion_location;
2056 * \brief Indicates the number of columns or rows in MB. It is ignored if
2059 uint16_t intra_insert_size;
2061 * \brief indicates the Qp difference for inserted intra columns or rows.
2062 * App can use this to adjust intra Qp based on bitrate & max frame size.
2064 uint8_t qp_delta_for_inserted_intra;
2065 /** \brief Reserved bytes for future use, must be zero */
2066 uint32_t va_reserved[VA_PADDING_LOW];
2067 } VAEncMiscParameterRIR;
2069 /** HRD / VBV buffering parameters for encoding.
2071 * This sets the HRD / VBV parameters which will be used by the rate
2072 * controller for encoding. It should be specified in modes using a bitrate
2073 * target when the buffering of the output stream needs to be constrained.
2075 * If not provided, the encoder may use arbitrary amounts of buffering.
2077 typedef struct _VAEncMiscParameterHRD
2079 /** The initial fullness of the HRD coded picture buffer, in bits.
2081 * This sets how full the CPB is when encoding begins - that is, how much
2082 * buffering will happen on the decoder side before the first frame.
2083 * The CPB fullness will be reset to this value after any rate control
2084 * reset (a change in parameters or an explicit reset).
2086 * For H.264, it should match the value of initial_cpb_removal_delay in
2087 * buffering_period SEI messages.
2089 uint32_t initial_buffer_fullness;
2090 /** The HRD coded picture buffer size, in bits.
2092 * For H.264, it should match the value of cpb_size_value_minus1 in the VUI
2095 uint32_t buffer_size;
2097 /** \brief Reserved bytes for future use, must be zero */
2098 uint32_t va_reserved[VA_PADDING_LOW];
2099 } VAEncMiscParameterHRD;
2102 * \brief Defines a maximum frame size (in bits).
2104 * This misc parameter buffer defines the maximum size of a frame (in
2105 * bits). The encoder will try to make sure that each frame does not
2106 * exceed this size. Otherwise, if the frame size exceeds this size,
2107 * the \c status flag of #VACodedBufferSegment will contain
2108 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
2110 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
2111 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
2112 VAEncMiscParameterType type;
2113 /** \brief Maximum size of a frame (in bits). */
2114 uint32_t max_frame_size;
2116 /** \brief Reserved bytes for future use, must be zero */
2117 uint32_t va_reserved[VA_PADDING_LOW];
2118 } VAEncMiscParameterBufferMaxFrameSize;
2121 * \brief Maximum frame size (in bytes) settings for multiple pass.
2123 * This misc parameter buffer defines the maximum size of a frame (in
2124 * bytes) settings for multiple pass. currently only AVC encoder can
2125 * support this settings in multiple pass case. If the frame size exceeds
2126 * this size, the encoder will do more pak passes to adjust the QP value
2127 * to control the frame size.
2129 typedef struct _VAEncMiscParameterBufferMultiPassFrameSize {
2130 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMultiPassMaxFrameSize. */
2131 VAEncMiscParameterType type;
2132 /** \brief Maximum size of a frame (in byte) */
2133 uint32_t max_frame_size;
2134 /** \brief Reserved bytes for future use, must be zero */
2136 /** \brief number of passes, every pass has different QP, currently AVC encoder can support up to 4 passes */
2138 /** \brief delta QP list for every pass */
2141 /** \brief Reserved bytes for future use, must be zero */
2142 unsigned long va_reserved[VA_PADDING_LOW];
2143 } VAEncMiscParameterBufferMultiPassFrameSize;
2146 * \brief Encoding quality level.
2148 * The encoding quality could be set through this structure, if the implementation
2149 * supports multiple quality levels. The quality level set through this structure is
2150 * persistent over the entire coded sequence, or until a new structure is being sent.
2151 * The quality level range can be queried through the VAConfigAttribEncQualityRange
2152 * attribute. A lower value means higher quality, and a value of 1 represents the highest
2153 * quality. The quality level setting is used as a trade-off between quality and speed/power
2154 * consumption, with higher quality corresponds to lower speed and higher power consumption.
2156 typedef struct _VAEncMiscParameterBufferQualityLevel {
2157 /** \brief Encoding quality level setting. When set to 0, default quality
2160 uint32_t quality_level;
2162 /** \brief Reserved bytes for future use, must be zero */
2163 uint32_t va_reserved[VA_PADDING_LOW];
2164 } VAEncMiscParameterBufferQualityLevel;
2167 * \brief Quantization settings for encoding.
2169 * Some encoders support special types of quantization such as trellis, and this structure
2170 * can be used by the app to control these special types of quantization by the encoder.
2172 typedef struct _VAEncMiscParameterQuantization
2176 /* if no flags is set then quantization is determined by the driver */
2179 /* \brief disable trellis for all frames/fields */
2180 uint64_t disable_trellis : 1;
2181 /* \brief enable trellis for I frames/fields */
2182 uint64_t enable_trellis_I : 1;
2183 /* \brief enable trellis for P frames/fields */
2184 uint64_t enable_trellis_P : 1;
2185 /* \brief enable trellis for B frames/fields */
2186 uint64_t enable_trellis_B : 1;
2187 uint64_t reserved : 28;
2190 } quantization_flags;
2191 } VAEncMiscParameterQuantization;
2194 * \brief Encoding skip frame.
2196 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
2197 * code as all skip's). For rate control purposes the encoder will need to know the size and number
2198 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
2199 * current frame. It is allowed for the application to still send in packed headers for the driver to
2200 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
2202 typedef struct _VAEncMiscParameterSkipFrame {
2203 /** \brief Indicates skip frames as below.
2204 * 0: Encode as normal, no skip.
2205 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
2206 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
2207 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
2208 * in VAEncPackedHeaderPicture). */
2209 uint8_t skip_frame_flag;
2210 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
2211 uint8_t num_skip_frames;
2212 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
2213 * the size of the current skipped frame that is to be packed/encrypted in bits. */
2214 uint32_t size_skip_frames;
2216 /** \brief Reserved bytes for future use, must be zero */
2217 uint32_t va_reserved[VA_PADDING_LOW];
2218 } VAEncMiscParameterSkipFrame;
2221 * \brief Encoding region-of-interest (ROI).
2223 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
2224 * supports ROI input. The ROI set through this structure is applicable only to the
2225 * current frame or field, so must be sent every frame or field to be applied. The number of
2226 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
2227 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
2229 typedef struct _VAEncROI
2231 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
2232 * codec coding units. It is relative to frame coordinates for the frame case and
2233 * to field coordinates for the field case. */
2234 VARectangle roi_rectangle;
2238 * \ref roi_value specifies ROI delta QP or ROI priority.
2239 * -- ROI delta QP is the value that will be added on top of the frame level QP.
2240 * -- ROI priority specifies the priority of a region, it can be positive (more important)
2241 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2242 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2243 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2244 * regions, the roi_value that is first in the ROI array will have priority.
2246 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2247 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2249 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2250 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2251 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2256 typedef struct _VAEncMiscParameterBufferROI {
2257 /** \brief Number of ROIs being sent.*/
2260 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2261 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
2263 int8_t max_delta_qp;
2264 int8_t min_delta_qp;
2266 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
2267 * coordinates for the frame case and to field coordinates for the field case.*/
2272 * \brief An indication for roi value.
2274 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2275 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2276 * in #VAEncROI should be used as ROI priority.
2278 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2279 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2280 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2281 * when VAConfigAttribRateControl == VA_RC_CQP.
2283 uint32_t roi_value_is_qp_delta : 1;
2284 uint32_t reserved : 31;
2289 /** \brief Reserved bytes for future use, must be zero */
2290 uint32_t va_reserved[VA_PADDING_LOW];
2291 } VAEncMiscParameterBufferROI;
2293 * \brief Dirty rectangle data structure for encoding.
2295 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2296 * implementation supports dirty rect input. The rect set through this structure is applicable
2297 * only to the current frame or field, so must be sent every frame or field to be applied.
2298 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
2299 * encoder will use the rect information to know those rectangle areas have changed while the
2300 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2301 * previous picture. The encoder may do some internal optimizations.
2303 typedef struct _VAEncMiscParameterBufferDirtyRect
2305 /** \brief Number of Rectangle being sent.*/
2306 uint32_t num_roi_rectangle;
2308 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2309 VARectangle *roi_rectangle;
2310 } VAEncMiscParameterBufferDirtyRect;
2312 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2313 typedef struct _VAEncMiscParameterParallelRateControl {
2314 /** brief Number of layers*/
2315 uint32_t num_layers;
2316 /** brief Number of B frames per layer per GOP.
2318 * it should be allocated by application, and the is num_layers.
2319 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2320 uint32_t *num_b_in_gop;
2321 } VAEncMiscParameterParallelRateControl;
2323 /** per frame encoder quality controls, once set they will persist for all future frames
2324 *till it is updated again. */
2325 typedef struct _VAEncMiscParameterEncQuality
2331 /** Use raw frames for reference instead of reconstructed frames.
2332 * it only impact motion estimation (ME) stage, and will not impact MC stage
2333 * so the reconstruct picture will can match with decode side */
2334 uint32_t useRawPicForRef : 1;
2335 /** Disables skip check for ME stage, it will increase the bistream size
2336 * but will improve the qulity */
2337 uint32_t skipCheckDisable : 1;
2338 /** Indicates app will override default driver FTQ settings using FTQEnable.
2339 * FTQ is forward transform quantization */
2340 uint32_t FTQOverride : 1;
2341 /** Enables/disables FTQ. */
2342 uint32_t FTQEnable : 1;
2343 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2344 * enabled (FTQSkipThresholdLUT), else default driver thresholds will be used. */
2345 uint32_t FTQSkipThresholdLUTInput : 1;
2346 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2347 * disabled (NonFTQSkipThresholdLUT), else default driver thresholds will be used. */
2348 uint32_t NonFTQSkipThresholdLUTInput : 1;
2349 uint32_t ReservedBit : 1;
2350 /** Control to enable the ME mode decision algorithm to bias to fewer B Direct/Skip types.
2351 * Applies only to B frames, all other frames will ignore this setting. */
2352 uint32_t directBiasAdjustmentEnable : 1;
2353 /** Enables global motion bias. global motion also is called HME (Heirarchical Motion Estimation )
2354 * HME is used to handle large motions and avoiding local minima in the video encoding process
2355 * down scaled the input and reference picture, then do ME. the result will be a predictor to next level HME or ME
2356 * current interface divide the HME to 3 level. UltraHME , SuperHME, and HME, result of UltraHME will be input of SurperHME,
2357 * result of superHME will be a input for HME. HME result will be input of ME. it is a switch for HMEMVCostScalingFactor
2358 * can change the HME bias inside RDO stage*/
2359 uint32_t globalMotionBiasAdjustmentEnable : 1;
2360 /** MV cost scaling ratio for HME ( predictors. It is used when
2361 * globalMotionBiasAdjustmentEnable == 1, else it is ignored. Values are:
2362 * 0: set MV cost to be 0 for HME predictor.
2363 * 1: scale MV cost to be 1/2 of the default value for HME predictor.
2364 * 2: scale MV cost to be 1/4 of the default value for HME predictor.
2365 * 3: scale MV cost to be 1/8 of the default value for HME predictor. */
2366 uint32_t HMEMVCostScalingFactor : 2;
2367 /**disable HME, if it is disabled. Super*ultraHME should also be disabled */
2368 uint32_t HMEDisable : 1;
2369 /**disable Super HME, if it is disabled, ultraHME should be disabled */
2370 uint32_t SuperHMEDisable : 1;
2371 /** disable Ultra HME */
2372 uint32_t UltraHMEDisable : 1;
2373 /** disable panic mode. Panic mode happened when there are extreme BRC (bit rate control) requirement
2374 * frame size cant achieve the target of BRC. when Panic mode is triggered, Coefficients will
2375 * be set to zero. disable panic mode will improve quality but will impact BRC */
2376 uint32_t PanicModeDisable : 1;
2377 /** Force RepartitionCheck
2378 * 0: DEFAULT - follow driver default settings.
2379 * 1: FORCE_ENABLE - enable this feature totally for all cases.
2380 * 2: FORCE_DISABLE - disable this feature totally for all cases. */
2381 uint32_t ForceRepartitionCheck : 2;
2384 uint32_t encControls;
2387 /** Maps QP to skip thresholds when FTQ is enabled. Valid range is 0-255. */
2388 uint8_t FTQSkipThresholdLUT[52];
2389 /** Maps QP to skip thresholds when FTQ is disabled. Valid range is 0-65535. */
2390 uint16_t NonFTQSkipThresholdLUT[52];
2392 uint32_t reserved[VA_PADDING_HIGH]; // Reserved for future use.
2394 } VAEncMiscParameterEncQuality;
2397 * \brief Custom Encoder Rounding Offset Control.
2398 * Application may use this structure to set customized rounding
2399 * offset parameters for quantization.
2400 * Valid when \c VAConfigAttribCustomRoundingControl equals 1.
2402 typedef struct _VAEncMiscParameterCustomRoundingControl
2406 /** \brief Enable customized rounding offset for intra blocks.
2407 * If 0, default value would be taken by driver for intra
2410 uint32_t enable_custom_rouding_intra : 1 ;
2412 /** \brief Intra rounding offset
2413 * Ignored if \c enable_custom_rouding_intra equals 0.
2415 uint32_t rounding_offset_intra : 7;
2417 /** \brief Enable customized rounding offset for inter blocks.
2418 * If 0, default value would be taken by driver for inter
2421 uint32_t enable_custom_rounding_inter : 1 ;
2423 /** \brief Inter rounding offset
2424 * Ignored if \c enable_custom_rouding_inter equals 0.
2426 uint32_t rounding_offset_inter : 7;
2429 uint32_t reserved :16;
2432 } rounding_offset_setting;
2433 } VAEncMiscParameterCustomRoundingControl;
2435 * There will be cases where the bitstream buffer will not have enough room to hold
2436 * the data for the entire slice, and the following flags will be used in the slice
2437 * parameter to signal to the server for the possible cases.
2438 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2439 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2440 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2442 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2443 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2444 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2445 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2447 /* Codec-independent Slice Parameter Buffer base */
2448 typedef struct _VASliceParameterBufferBase
2450 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2451 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2452 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2453 } VASliceParameterBufferBase;
2455 /**********************************
2456 * JPEG common data structures
2457 **********************************/
2459 * \brief Huffman table for JPEG decoding.
2461 * This structure holds the complete Huffman tables. This is an
2462 * aggregation of all Huffman table (DHT) segments maintained by the
2463 * application. i.e. up to 2 Huffman tables are stored in there for
2466 * The #load_huffman_table array can be used as a hint to notify the
2467 * VA driver implementation about which table(s) actually changed
2468 * since the last submission of this buffer.
2470 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2471 /** \brief Specifies which #huffman_table is valid. */
2472 uint8_t load_huffman_table[2];
2473 /** \brief Huffman tables indexed by table identifier (Th). */
2475 /** @name DC table (up to 12 categories) */
2477 /** \brief Number of Huffman codes of length i + 1 (Li). */
2478 uint8_t num_dc_codes[16];
2479 /** \brief Value associated with each Huffman code (Vij). */
2480 uint8_t dc_values[12];
2482 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2484 /** \brief Number of Huffman codes of length i + 1 (Li). */
2485 uint8_t num_ac_codes[16];
2486 /** \brief Value associated with each Huffman code (Vij). */
2487 uint8_t ac_values[162];
2488 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2493 /** \brief Reserved bytes for future use, must be zero */
2494 uint32_t va_reserved[VA_PADDING_LOW];
2495 } VAHuffmanTableBufferJPEGBaseline;
2497 /****************************
2498 * MPEG-2 data structures
2499 ****************************/
2501 /* MPEG-2 Picture Parameter Buffer */
2503 * For each frame or field, and before any slice data, a single
2504 * picture parameter buffer must be send.
2506 typedef struct _VAPictureParameterBufferMPEG2
2508 uint16_t horizontal_size;
2509 uint16_t vertical_size;
2510 VASurfaceID forward_reference_picture;
2511 VASurfaceID backward_reference_picture;
2512 /* meanings of the following fields are the same as in the standard */
2513 int32_t picture_coding_type;
2514 int32_t f_code; /* pack all four fcode into this */
2517 uint32_t intra_dc_precision : 2;
2518 uint32_t picture_structure : 2;
2519 uint32_t top_field_first : 1;
2520 uint32_t frame_pred_frame_dct : 1;
2521 uint32_t concealment_motion_vectors : 1;
2522 uint32_t q_scale_type : 1;
2523 uint32_t intra_vlc_format : 1;
2524 uint32_t alternate_scan : 1;
2525 uint32_t repeat_first_field : 1;
2526 uint32_t progressive_frame : 1;
2527 uint32_t is_first_field : 1; /* indicate whether the current field
2528 * is the first field for field picture
2532 } picture_coding_extension;
2534 /** \brief Reserved bytes for future use, must be zero */
2535 uint32_t va_reserved[VA_PADDING_LOW];
2536 } VAPictureParameterBufferMPEG2;
2538 /** MPEG-2 Inverse Quantization Matrix Buffer */
2539 typedef struct _VAIQMatrixBufferMPEG2
2541 /** \brief Same as the MPEG-2 bitstream syntax element. */
2542 int32_t load_intra_quantiser_matrix;
2543 /** \brief Same as the MPEG-2 bitstream syntax element. */
2544 int32_t load_non_intra_quantiser_matrix;
2545 /** \brief Same as the MPEG-2 bitstream syntax element. */
2546 int32_t load_chroma_intra_quantiser_matrix;
2547 /** \brief Same as the MPEG-2 bitstream syntax element. */
2548 int32_t load_chroma_non_intra_quantiser_matrix;
2549 /** \brief Luminance intra matrix, in zig-zag scan order. */
2550 uint8_t intra_quantiser_matrix[64];
2551 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2552 uint8_t non_intra_quantiser_matrix[64];
2553 /** \brief Chroma intra matrix, in zig-zag scan order. */
2554 uint8_t chroma_intra_quantiser_matrix[64];
2555 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2556 uint8_t chroma_non_intra_quantiser_matrix[64];
2558 /** \brief Reserved bytes for future use, must be zero */
2559 uint32_t va_reserved[VA_PADDING_LOW];
2560 } VAIQMatrixBufferMPEG2;
2562 /** MPEG-2 Slice Parameter Buffer */
2563 typedef struct _VASliceParameterBufferMPEG2
2565 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2566 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2567 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2568 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2569 uint32_t slice_horizontal_position;
2570 uint32_t slice_vertical_position;
2571 int32_t quantiser_scale_code;
2572 int32_t intra_slice_flag;
2574 /** \brief Reserved bytes for future use, must be zero */
2575 uint32_t va_reserved[VA_PADDING_LOW];
2576 } VASliceParameterBufferMPEG2;
2578 /** MPEG-2 Macroblock Parameter Buffer */
2579 typedef struct _VAMacroblockParameterBufferMPEG2
2581 uint16_t macroblock_address;
2583 * macroblock_address (in raster scan order)
2585 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2587 uint8_t macroblock_type; /* see definition below */
2590 uint32_t frame_motion_type : 2;
2591 uint32_t field_motion_type : 2;
2592 uint32_t dct_type : 1;
2596 uint8_t motion_vertical_field_select;
2598 * motion_vertical_field_select:
2599 * see section 6.3.17.2 in the spec
2600 * only the lower 4 bits are used
2601 * bit 0: first vector forward
2602 * bit 1: first vector backward
2603 * bit 2: second vector forward
2604 * bit 3: second vector backward
2606 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2607 uint16_t coded_block_pattern;
2609 * The bitplanes for coded_block_pattern are described
2610 * in Figure 6.10-12 in the spec
2613 /* Number of skipped macroblocks after this macroblock */
2614 uint16_t num_skipped_macroblocks;
2616 /** \brief Reserved bytes for future use, must be zero */
2617 uint32_t va_reserved[VA_PADDING_LOW];
2618 } VAMacroblockParameterBufferMPEG2;
2621 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2623 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2624 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2625 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2626 #define VA_MB_TYPE_MOTION_INTRA 0x10
2629 * MPEG-2 Residual Data Buffer
2630 * For each macroblock, there wil be 64 shorts (16-bit) in the
2631 * residual data buffer
2634 /****************************
2635 * MPEG-4 Part 2 data structures
2636 ****************************/
2638 /* MPEG-4 Picture Parameter Buffer */
2640 * For each frame or field, and before any slice data, a single
2641 * picture parameter buffer must be send.
2643 typedef struct _VAPictureParameterBufferMPEG4
2646 uint16_t vop_height;
2647 VASurfaceID forward_reference_picture;
2648 VASurfaceID backward_reference_picture;
2651 uint32_t short_video_header : 1;
2652 uint32_t chroma_format : 2;
2653 uint32_t interlaced : 1;
2654 uint32_t obmc_disable : 1;
2655 uint32_t sprite_enable : 2;
2656 uint32_t sprite_warping_accuracy : 2;
2657 uint32_t quant_type : 1;
2658 uint32_t quarter_sample : 1;
2659 uint32_t data_partitioned : 1;
2660 uint32_t reversible_vlc : 1;
2661 uint32_t resync_marker_disable : 1;
2665 uint8_t no_of_sprite_warping_points;
2666 int16_t sprite_trajectory_du[3];
2667 int16_t sprite_trajectory_dv[3];
2668 uint8_t quant_precision;
2671 uint32_t vop_coding_type : 2;
2672 uint32_t backward_reference_vop_coding_type : 2;
2673 uint32_t vop_rounding_type : 1;
2674 uint32_t intra_dc_vlc_thr : 3;
2675 uint32_t top_field_first : 1;
2676 uint32_t alternate_vertical_scan_flag : 1;
2680 uint8_t vop_fcode_forward;
2681 uint8_t vop_fcode_backward;
2682 uint16_t vop_time_increment_resolution;
2683 /* short header related */
2684 uint8_t num_gobs_in_vop;
2685 uint8_t num_macroblocks_in_gob;
2686 /* for direct mode prediction */
2690 /** \brief Reserved bytes for future use, must be zero */
2691 uint32_t va_reserved[VA_PADDING_LOW];
2692 } VAPictureParameterBufferMPEG4;
2694 /** MPEG-4 Inverse Quantization Matrix Buffer */
2695 typedef struct _VAIQMatrixBufferMPEG4
2697 /** Same as the MPEG-4:2 bitstream syntax element. */
2698 int32_t load_intra_quant_mat;
2699 /** Same as the MPEG-4:2 bitstream syntax element. */
2700 int32_t load_non_intra_quant_mat;
2701 /** The matrix for intra blocks, in zig-zag scan order. */
2702 uint8_t intra_quant_mat[64];
2703 /** The matrix for non-intra blocks, in zig-zag scan order. */
2704 uint8_t non_intra_quant_mat[64];
2706 /** \brief Reserved bytes for future use, must be zero */
2707 uint32_t va_reserved[VA_PADDING_LOW];
2708 } VAIQMatrixBufferMPEG4;
2710 /** MPEG-4 Slice Parameter Buffer */
2711 typedef struct _VASliceParameterBufferMPEG4
2713 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2714 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2715 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2716 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2717 uint32_t macroblock_number;
2718 int32_t quant_scale;
2720 /** \brief Reserved bytes for future use, must be zero */
2721 uint32_t va_reserved[VA_PADDING_LOW];
2722 } VASliceParameterBufferMPEG4;
2725 VC-1 data structures
2728 typedef enum /* see 7.1.1.32 */
2731 VAMvMode1MvHalfPel = 1,
2732 VAMvMode1MvHalfPelBilinear = 2,
2733 VAMvModeMixedMv = 3,
2734 VAMvModeIntensityCompensation = 4
2737 /** VC-1 Picture Parameter Buffer */
2739 * For each picture, and before any slice data, a picture parameter
2740 * buffer must be send. Multiple picture parameter buffers may be
2741 * sent for a single picture. In that case picture parameters will
2742 * apply to all slice data that follow it until a new picture
2743 * parameter buffer is sent.
2746 * pic_quantizer_type should be set to the applicable quantizer
2747 * type as defined by QUANTIZER (J.1.19) and either
2748 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2750 typedef struct _VAPictureParameterBufferVC1
2752 VASurfaceID forward_reference_picture;
2753 VASurfaceID backward_reference_picture;
2754 /* if out-of-loop post-processing is done on the render
2755 target, then we need to keep the in-loop decoded
2756 picture as a reference picture */
2757 VASurfaceID inloop_decoded_picture;
2759 /* sequence layer for AP or meta data for SP and MP */
2762 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2763 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2764 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2765 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2766 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2767 uint32_t multires : 1; /* METADATA::MULTIRES */
2768 uint32_t overlap : 1; /* METADATA::OVERLAP */
2769 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2770 uint32_t rangered : 1; /* METADATA::RANGERED */
2771 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2772 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2777 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2778 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2781 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2782 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2783 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2784 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2787 } entrypoint_fields;
2788 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2789 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2792 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2793 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2794 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2795 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2798 } range_mapping_fields;
2800 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2801 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2802 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2803 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2804 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2805 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2806 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2807 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2808 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2812 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2813 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2814 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2815 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2816 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2822 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2823 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2824 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2825 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2826 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2827 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2828 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2834 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2835 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2836 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2837 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2838 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2839 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2840 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2843 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2846 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2847 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2848 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2849 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2855 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2856 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2857 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2858 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2859 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2860 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2861 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2862 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2863 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2864 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2870 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2871 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2872 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2873 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2874 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2875 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2876 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2877 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2878 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2879 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2880 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2883 } pic_quantizer_fields;
2886 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2887 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2888 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2889 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2890 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2891 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2896 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2897 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2898 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2900 /** \brief Reserved bytes for future use, must be zero */
2901 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2902 } VAPictureParameterBufferVC1;
2904 /** VC-1 Bitplane Buffer
2905 There will be at most three bitplanes coded in any picture header. To send
2906 the bitplane data more efficiently, each byte is divided in two nibbles, with
2907 each nibble carrying three bitplanes for one macroblock. The following table
2908 shows the bitplane data arrangement within each nibble based on the picture
2911 Picture Type Bit3 Bit2 Bit1 Bit0
2912 I or BI OVERFLAGS ACPRED FIELDTX
2913 P MYTYPEMB SKIPMB DIRECTMB
2914 B FORWARDMB SKIPMB DIRECTMB
2916 Within each byte, the lower nibble is for the first MB and the upper nibble is
2917 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2918 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2919 Macroblock #2 in the first row.
2922 /* VC-1 Slice Parameter Buffer */
2923 typedef struct _VASliceParameterBufferVC1
2925 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2926 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2927 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2928 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2929 uint32_t slice_vertical_position;
2931 /** \brief Reserved bytes for future use, must be zero */
2932 uint32_t va_reserved[VA_PADDING_LOW];
2933 } VASliceParameterBufferVC1;
2935 /* VC-1 Slice Data Buffer */
2937 This is simplely a buffer containing raw bit-stream bytes
2940 /****************************
2941 * H.264/AVC data structures
2942 ****************************/
2944 typedef struct _VAPictureH264
2946 VASurfaceID picture_id;
2949 int32_t TopFieldOrderCnt;
2950 int32_t BottomFieldOrderCnt;
2952 /** \brief Reserved bytes for future use, must be zero */
2953 uint32_t va_reserved[VA_PADDING_LOW];
2955 /* flags in VAPictureH264 could be OR of the following */
2956 #define VA_PICTURE_H264_INVALID 0x00000001
2957 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2958 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2959 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2960 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2962 /** H.264 Picture Parameter Buffer */
2964 * For each picture, and before any slice data, a single
2965 * picture parameter buffer must be send.
2967 typedef struct _VAPictureParameterBufferH264
2969 VAPictureH264 CurrPic;
2970 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2971 uint16_t picture_width_in_mbs_minus1;
2972 uint16_t picture_height_in_mbs_minus1;
2973 uint8_t bit_depth_luma_minus8;
2974 uint8_t bit_depth_chroma_minus8;
2975 uint8_t num_ref_frames;
2978 uint32_t chroma_format_idc : 2;
2979 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2980 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2981 uint32_t frame_mbs_only_flag : 1;
2982 uint32_t mb_adaptive_frame_field_flag : 1;
2983 uint32_t direct_8x8_inference_flag : 1;
2984 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2985 uint32_t log2_max_frame_num_minus4 : 4;
2986 uint32_t pic_order_cnt_type : 2;
2987 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2988 uint32_t delta_pic_order_always_zero_flag : 1;
2992 // FMO is not supported.
2993 va_deprecated uint8_t num_slice_groups_minus1;
2994 va_deprecated uint8_t slice_group_map_type;
2995 va_deprecated uint16_t slice_group_change_rate_minus1;
2996 int8_t pic_init_qp_minus26;
2997 int8_t pic_init_qs_minus26;
2998 int8_t chroma_qp_index_offset;
2999 int8_t second_chroma_qp_index_offset;
3002 uint32_t entropy_coding_mode_flag : 1;
3003 uint32_t weighted_pred_flag : 1;
3004 uint32_t weighted_bipred_idc : 2;
3005 uint32_t transform_8x8_mode_flag : 1;
3006 uint32_t field_pic_flag : 1;
3007 uint32_t constrained_intra_pred_flag : 1;
3008 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
3009 uint32_t deblocking_filter_control_present_flag : 1;
3010 uint32_t redundant_pic_cnt_present_flag : 1;
3011 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
3017 /** \brief Reserved bytes for future use, must be zero */
3018 uint32_t va_reserved[VA_PADDING_MEDIUM];
3019 } VAPictureParameterBufferH264;
3021 /** H.264 Inverse Quantization Matrix Buffer */
3022 typedef struct _VAIQMatrixBufferH264
3024 /** \brief 4x4 scaling list, in raster scan order. */
3025 uint8_t ScalingList4x4[6][16];
3026 /** \brief 8x8 scaling list, in raster scan order. */
3027 uint8_t ScalingList8x8[2][64];
3029 /** \brief Reserved bytes for future use, must be zero */
3030 uint32_t va_reserved[VA_PADDING_LOW];
3031 } VAIQMatrixBufferH264;
3033 /** H.264 Slice Parameter Buffer */
3034 typedef struct _VASliceParameterBufferH264
3036 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
3037 /** \brief Byte offset to the NAL Header Unit for this slice. */
3038 uint32_t slice_data_offset;
3039 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
3041 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
3043 * This bit offset is relative to and includes the NAL unit byte
3044 * and represents the number of bits parsed in the slice_header()
3045 * after the removal of any emulation prevention bytes in
3046 * there. However, the slice data buffer passed to the hardware is
3047 * the original bitstream, thus including any emulation prevention
3050 uint16_t slice_data_bit_offset;
3051 uint16_t first_mb_in_slice;
3053 uint8_t direct_spatial_mv_pred_flag;
3055 * H264/AVC syntax element
3057 * if num_ref_idx_active_override_flag equals 0, host decoder should
3058 * set its value to num_ref_idx_l0_default_active_minus1.
3060 uint8_t num_ref_idx_l0_active_minus1;
3062 * H264/AVC syntax element
3064 * if num_ref_idx_active_override_flag equals 0, host decoder should
3065 * set its value to num_ref_idx_l1_default_active_minus1.
3067 uint8_t num_ref_idx_l1_active_minus1;
3068 uint8_t cabac_init_idc;
3069 int8_t slice_qp_delta;
3070 uint8_t disable_deblocking_filter_idc;
3071 int8_t slice_alpha_c0_offset_div2;
3072 int8_t slice_beta_offset_div2;
3073 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
3074 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
3075 uint8_t luma_log2_weight_denom;
3076 uint8_t chroma_log2_weight_denom;
3077 uint8_t luma_weight_l0_flag;
3078 int16_t luma_weight_l0[32];
3079 int16_t luma_offset_l0[32];
3080 uint8_t chroma_weight_l0_flag;
3081 int16_t chroma_weight_l0[32][2];
3082 int16_t chroma_offset_l0[32][2];
3083 uint8_t luma_weight_l1_flag;
3084 int16_t luma_weight_l1[32];
3085 int16_t luma_offset_l1[32];
3086 uint8_t chroma_weight_l1_flag;
3087 int16_t chroma_weight_l1[32][2];
3088 int16_t chroma_offset_l1[32][2];
3090 /** \brief Reserved bytes for future use, must be zero */
3091 uint32_t va_reserved[VA_PADDING_LOW];
3092 } VASliceParameterBufferH264;
3094 /****************************
3095 * Common encode data structures
3096 ****************************/
3099 VAEncPictureTypeIntra = 0,
3100 VAEncPictureTypePredictive = 1,
3101 VAEncPictureTypeBidirectional = 2,
3105 * \brief Encode Slice Parameter Buffer.
3108 * This is a deprecated encode slice parameter buffer, All applications
3109 * \c can use VAEncSliceParameterBufferXXX (XXX = MPEG2, HEVC, H264, JPEG)
3111 typedef struct _VAEncSliceParameterBuffer
3113 uint32_t start_row_number; /* starting MB row number for this slice */
3114 uint32_t slice_height; /* slice height measured in MB */
3117 uint32_t is_intra : 1;
3118 uint32_t disable_deblocking_filter_idc : 2;
3119 uint32_t uses_long_term_ref :1;
3120 uint32_t is_long_term_ref :1;
3125 /** \brief Reserved bytes for future use, must be zero */
3126 uint32_t va_reserved[VA_PADDING_LOW];
3127 } VAEncSliceParameterBuffer;
3130 /****************************
3131 * H.263 specific encode data structures
3132 ****************************/
3134 typedef struct _VAEncSequenceParameterBufferH263
3136 uint32_t intra_period;
3137 uint32_t bits_per_second;
3138 uint32_t frame_rate;
3139 uint32_t initial_qp;
3142 /** \brief Reserved bytes for future use, must be zero */
3143 uint32_t va_reserved[VA_PADDING_LOW];
3144 } VAEncSequenceParameterBufferH263;
3146 typedef struct _VAEncPictureParameterBufferH263
3148 VASurfaceID reference_picture;
3149 VASurfaceID reconstructed_picture;
3150 VABufferID coded_buf;
3151 uint16_t picture_width;
3152 uint16_t picture_height;
3153 VAEncPictureType picture_type;
3155 /** \brief Reserved bytes for future use, must be zero */
3156 uint32_t va_reserved[VA_PADDING_LOW];
3157 } VAEncPictureParameterBufferH263;
3159 /****************************
3160 * MPEG-4 specific encode data structures
3161 ****************************/
3163 typedef struct _VAEncSequenceParameterBufferMPEG4
3165 uint8_t profile_and_level_indication;
3166 uint32_t intra_period;
3167 uint32_t video_object_layer_width;
3168 uint32_t video_object_layer_height;
3169 uint32_t vop_time_increment_resolution;
3170 uint32_t fixed_vop_rate;
3171 uint32_t fixed_vop_time_increment;
3172 uint32_t bits_per_second;
3173 uint32_t frame_rate;
3174 uint32_t initial_qp;
3177 /** \brief Reserved bytes for future use, must be zero */
3178 uint32_t va_reserved[VA_PADDING_LOW];
3179 } VAEncSequenceParameterBufferMPEG4;
3181 typedef struct _VAEncPictureParameterBufferMPEG4
3183 VASurfaceID reference_picture;
3184 VASurfaceID reconstructed_picture;
3185 VABufferID coded_buf;
3186 uint16_t picture_width;
3187 uint16_t picture_height;
3188 uint32_t modulo_time_base; /* number of 1s */
3189 uint32_t vop_time_increment;
3190 VAEncPictureType picture_type;
3192 /** \brief Reserved bytes for future use, must be zero */
3193 uint32_t va_reserved[VA_PADDING_LOW];
3194 } VAEncPictureParameterBufferMPEG4;
3198 /** Buffer functions */
3201 * Creates a buffer for "num_elements" elements of "size" bytes and
3202 * initalize with "data".
3203 * if "data" is null, then the contents of the buffer data store
3205 * Basically there are two ways to get buffer data to the server side. One is
3206 * to call vaCreateBuffer() with a non-null "data", which results the data being
3207 * copied to the data store on the server side. A different method that
3208 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
3209 * and then use vaMapBuffer() to map the data store from the server side to the
3210 * client address space for access.
3211 * The user must call vaDestroyBuffer() to destroy a buffer.
3212 * Note: image buffers are created by the library, not the client. Please see
3213 * vaCreateImage on how image buffers are managed.
3215 VAStatus vaCreateBuffer (
3217 VAContextID context,
3218 VABufferType type, /* in */
3219 unsigned int size, /* in */
3220 unsigned int num_elements, /* in */
3221 void *data, /* in */
3222 VABufferID *buf_id /* out */
3226 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
3227 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
3228 * can call vaMapBuffer with this Buffer ID to get virtual address.
3229 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
3230 * maybe it should align with 256, and one byte present one Qp.so, call the function.
3231 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
3232 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
3233 * pBuf + 256 is the start of next line.
3234 * different driver implementation maybe return different unit_size and pitch
3236 VAStatus vaCreateBuffer2(
3238 VAContextID context,
3241 unsigned int height,
3242 unsigned int *unit_size,
3243 unsigned int *pitch,
3248 * Convey to the server how many valid elements are in the buffer.
3249 * e.g. if multiple slice parameters are being held in a single buffer,
3250 * this will communicate to the server the number of slice parameters
3251 * that are valid in the buffer.
3253 VAStatus vaBufferSetNumElements (
3255 VABufferID buf_id, /* in */
3256 unsigned int num_elements /* in */
3261 * device independent data structure for codedbuffer
3265 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
3266 * LARGE_SLICE(bit8):At least one slice in the current frame was large
3267 * enough for the encoder to attempt to limit its size.
3268 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
3269 * exceeded the maximum slice size specified.
3270 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
3271 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
3272 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
3274 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
3275 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
3276 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
3277 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
3278 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
3280 * \brief The frame has exceeded the maximum requested size.
3282 * This flag indicates that the encoded frame size exceeds the value
3283 * specified through a misc parameter buffer of type
3284 * #VAEncMiscParameterTypeMaxFrameSize.
3286 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
3288 * \brief the bitstream is bad or corrupt.
3290 #define VA_CODED_BUF_STATUS_BAD_BITSTREAM 0x8000
3291 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
3294 * \brief The coded buffer segment status contains frame encoding passes number
3296 * This is the mask to get the number of encoding passes from the coded
3297 * buffer segment status.
3298 * NUMBER_PASS(bit24~bit27): the number for encoding passes executed for the coded frame.
3301 #define VA_CODED_BUF_STATUS_NUMBER_PASSES_MASK 0xf000000
3304 * \brief The coded buffer segment contains a single NAL unit.
3306 * This flag indicates that the coded buffer segment contains a
3307 * single NAL unit. This flag might be useful to the user for
3308 * processing the coded buffer.
3310 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
3313 * \brief Coded buffer segment.
3315 * #VACodedBufferSegment is an element of a linked list describing
3316 * some information on the coded buffer. The coded buffer segment
3317 * could contain either a single NAL unit, or more than one NAL unit.
3318 * It is recommended (but not required) to return a single NAL unit
3319 * in a coded buffer segment, and the implementation should set the
3320 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
3322 typedef struct _VACodedBufferSegment {
3324 * \brief Size of the data buffer in this segment (in bytes).
3327 /** \brief Bit offset into the data buffer where the video data starts. */
3328 uint32_t bit_offset;
3329 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
3331 /** \brief Reserved for future use. */
3333 /** \brief Pointer to the start of the data buffer. */
3336 * \brief Pointer to the next #VACodedBufferSegment element,
3337 * or \c NULL if there is none.
3341 /** \brief Reserved bytes for future use, must be zero */
3342 uint32_t va_reserved[VA_PADDING_LOW];
3343 } VACodedBufferSegment;
3346 * Map data store of the buffer into the client's address space
3347 * vaCreateBuffer() needs to be called with "data" set to NULL before
3348 * calling vaMapBuffer()
3350 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
3351 * VACodedBufferSegment, and the list is terminated if "next" is NULL
3353 VAStatus vaMapBuffer (
3355 VABufferID buf_id, /* in */
3356 void **pbuf /* out */
3360 * After client making changes to a mapped data store, it needs to
3361 * "Unmap" it to let the server know that the data is ready to be
3362 * consumed by the server
3364 VAStatus vaUnmapBuffer (
3366 VABufferID buf_id /* in */
3370 * After this call, the buffer is deleted and this buffer_id is no longer valid
3372 * A buffer can be re-used and sent to the server by another Begin/Render/End
3373 * sequence if vaDestroyBuffer() is not called with this buffer.
3375 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3376 * hardware accelerator can result in performance dropping.
3378 VAStatus vaDestroyBuffer (
3380 VABufferID buffer_id
3383 /** \brief VA buffer information */
3385 /** \brief Buffer handle */
3387 /** \brief Buffer type (See \ref VABufferType). */
3390 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3392 * On input to vaAcquireBufferHandle(), this field can serve as a hint
3393 * to specify the set of memory types the caller is interested in.
3394 * On successful return from vaAcquireBufferHandle(), the field is
3395 * updated with the best matching memory type.
3398 /** \brief Size of the underlying buffer. */
3401 /** \brief Reserved bytes for future use, must be zero */
3402 uint32_t va_reserved[VA_PADDING_LOW];
3406 * \brief Acquires buffer handle for external API usage
3408 * Locks the VA buffer object \ref buf_id for external API usage like
3409 * EGL or OpenCL (OCL). This function is a synchronization point. This
3410 * means that any pending operation is guaranteed to be completed
3411 * prior to returning from the function.
3413 * If the referenced VA buffer object is the backing store of a VA
3414 * surface, then this function acts as if vaSyncSurface() on the
3415 * parent surface was called first.
3417 * The \ref VABufferInfo argument shall be zero'ed on input. On
3418 * successful output, the data structure is filled in with all the
3419 * necessary buffer level implementation details like handle, type,
3420 * memory type and memory size.
3422 * Note: the external API implementation, or the application, can
3423 * express the memory types it is interested in by filling in the \ref
3424 * mem_type field accordingly. On successful output, the memory type
3425 * that fits best the request and that was used is updated in the \ref
3426 * VABufferInfo data structure. If none of the supplied memory types
3427 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3428 * error is returned.
3430 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3431 * is called. Besides, no additional operation is allowed on any of
3432 * the buffer parent object until vaReleaseBufferHandle() is called.
3433 * e.g. decoding into a VA surface backed with the supplied VA buffer
3434 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3438 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3439 * does not support this interface
3440 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3441 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3442 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3443 * does not support exporting buffers of the specified type
3444 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3445 * memory types in \ref VABufferInfo.mem_type was supported
3447 * @param[in] dpy the VA display
3448 * @param[in] buf_id the VA buffer
3449 * @param[in,out] buf_info the associated VA buffer information
3450 * @return VA_STATUS_SUCCESS if successful
3453 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3456 * \brief Releases buffer after usage from external API
3458 * Unlocks the VA buffer object \ref buf_id from external API usage like
3459 * EGL or OpenCL (OCL). This function is a synchronization point. This
3460 * means that any pending operation is guaranteed to be completed
3461 * prior to returning from the function.
3463 * The \ref VABufferInfo argument shall point to the original data
3464 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3465 * This is necessary so that the VA driver implementation could
3466 * deallocate any resources that were needed.
3468 * In any case, returning from this function invalidates any contents
3469 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3470 * valid. Therefore, VA driver implementations are free to reset this
3471 * data structure to safe defaults.
3474 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3475 * does not support this interface
3476 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3477 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3478 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3479 * does not support exporting buffers of the specified type
3481 * @param[in] dpy the VA display
3482 * @param[in] buf_id the VA buffer
3483 * @return VA_STATUS_SUCCESS if successful
3486 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3488 /** @name vaExportSurfaceHandle() flags
3492 /** Export surface to be read by external API. */
3493 #define VA_EXPORT_SURFACE_READ_ONLY 0x0001
3494 /** Export surface to be written by external API. */
3495 #define VA_EXPORT_SURFACE_WRITE_ONLY 0x0002
3496 /** Export surface to be both read and written by external API. */
3497 #define VA_EXPORT_SURFACE_READ_WRITE 0x0003
3498 /** Export surface with separate layers.
3500 * For example, NV12 surfaces should be exported as two separate
3501 * planes for luma and chroma.
3503 #define VA_EXPORT_SURFACE_SEPARATE_LAYERS 0x0004
3504 /** Export surface with composed layers.
3506 * For example, NV12 surfaces should be exported as a single NV12
3509 #define VA_EXPORT_SURFACE_COMPOSED_LAYERS 0x0008
3514 * \brief Export a handle to a surface for use with an external API
3516 * The exported handles are owned by the caller, and the caller is
3517 * responsible for freeing them when no longer needed (e.g. by closing
3518 * DRM PRIME file descriptors).
3520 * This does not perform any synchronisation. If the contents of the
3521 * surface will be read, vaSyncSurface() must be called before doing so.
3522 * If the contents of the surface are written, then all operations must
3523 * be completed externally before using the surface again by via VA-API
3526 * @param[in] dpy VA display.
3527 * @param[in] surface_id Surface to export.
3528 * @param[in] mem_type Memory type to export to.
3529 * @param[in] flags Combination of flags to apply
3530 * (VA_EXPORT_SURFACE_*).
3531 * @param[out] descriptor Pointer to the descriptor structure to fill
3532 * with the handle details. The type of this structure depends on
3533 * the value of mem_type.
3535 * @return Status code:
3536 * - VA_STATUS_SUCCESS: Success.
3537 * - VA_STATUS_ERROR_INVALID_DISPLAY: The display is not valid.
3538 * - VA_STATUS_ERROR_UNIMPLEMENTED: The driver does not implement
3540 * - VA_STATUS_ERROR_INVALID_SURFACE: The surface is not valid, or
3541 * the surface is not exportable in the specified way.
3542 * - VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: The driver does not
3543 * support exporting surfaces to the specified memory type.
3545 VAStatus vaExportSurfaceHandle(VADisplay dpy,
3546 VASurfaceID surface_id,
3547 uint32_t mem_type, uint32_t flags,
3551 * Render (Video Decode/Encode/Processing) Pictures
3553 * A picture represents either a frame or a field.
3555 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3560 * Get ready for a video pipeline
3561 * - decode a picture to a target surface
3562 * - encode a picture from a target surface
3563 * - process a picture to a target surface
3565 VAStatus vaBeginPicture (
3567 VAContextID context,
3568 VASurfaceID render_target
3572 * Send video decode, encode or processing buffers to the server.
3574 VAStatus vaRenderPicture (
3576 VAContextID context,
3577 VABufferID *buffers,
3582 * Make the end of rendering for a picture.
3583 * The server should start processing all pending operations for this
3584 * surface. This call is non-blocking. The client can start another
3585 * Begin/Render/End sequence on a different render target.
3586 * if VAContextID used in this function previously successfully passed
3587 * vaMFAddContext call, real processing will be started during vaMFSubmit
3589 VAStatus vaEndPicture (
3595 * Make the end of rendering for a pictures in contexts passed with submission.
3596 * The server should start processing all pending operations for contexts.
3597 * All contexts passed should be associated through vaMFAddContext
3598 * and call sequence Begin/Render/End performed.
3599 * This call is non-blocking. The client can start another
3600 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3602 * VA_STATUS_SUCCESS - operation successful, context was removed.
3603 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3604 * due to mf_context not created or one of contexts not assotiated with mf_context
3605 * through vaAddContext.
3606 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3607 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3609 * mf_context: Multi-Frame context
3610 * contexts: list of contexts submitting their tasks for multi-frame operation.
3611 * num_contexts: number of passed contexts.
3613 VAStatus vaMFSubmit (
3615 VAMFContextID mf_context,
3616 VAContextID * contexts,
3627 * This function blocks until all pending operations on the render target
3628 * have been completed. Upon return it is safe to use the render target for a
3629 * different picture.
3631 VAStatus vaSyncSurface (
3633 VASurfaceID render_target
3638 VASurfaceRendering = 1, /* Rendering in progress */
3639 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3640 /* this status is useful if surface is used as the source */
3642 VASurfaceReady = 4, /* not being rendered or displayed */
3643 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3647 * Find out any pending ops on the render target
3649 VAStatus vaQuerySurfaceStatus (
3651 VASurfaceID render_target,
3652 VASurfaceStatus *status /* out */
3657 VADecodeSliceMissing = 0,
3658 VADecodeMBError = 1,
3659 } VADecodeErrorType;
3662 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3663 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3665 typedef struct _VASurfaceDecodeMBErrors
3667 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3668 uint32_t start_mb; /* start mb address with errors */
3669 uint32_t end_mb; /* end mb address with errors */
3670 VADecodeErrorType decode_error_type;
3671 uint32_t num_mb; /* number of mbs with errors */
3672 /** \brief Reserved bytes for future use, must be zero */
3673 uint32_t va_reserved[VA_PADDING_LOW - 1];
3674 } VASurfaceDecodeMBErrors;
3677 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3678 * it can call vaQuerySurfaceError to find out further details on the particular error.
3679 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3680 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3681 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3682 * The array is terminated if "status==-1" is detected.
3684 VAStatus vaQuerySurfaceError(
3686 VASurfaceID surface,
3687 VAStatus error_status,
3692 * Images and Subpictures
3693 * VAImage is used to either get the surface data to client memory, or
3694 * to copy image data in client memory to a surface.
3695 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3696 * is at the upper left corner with positive X to the right and positive Y down
3698 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3699 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3700 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3702 /* Pre-defined fourcc codes. */
3704 /** NV12: two-plane 8-bit YUV 4:2:0.
3705 * The first plane contains Y, the second plane contains U and V in pairs of bytes.
3707 #define VA_FOURCC_NV12 0x3231564E
3708 /** NV21: two-plane 8-bit YUV 4:2:0.
3709 * Same as NV12, but with U and V swapped.
3711 #define VA_FOURCC_NV21 0x3132564E
3713 /** AI44: packed 4-bit YA.
3715 * The bottom half of each byte contains luma, the top half contains alpha.
3717 #define VA_FOURCC_AI44 0x34344149
3719 /** RGBA: packed 8-bit RGBA.
3721 * Four bytes per pixel: red, green, blue, alpha.
3723 #define VA_FOURCC_RGBA 0x41424752
3724 /** RGBX: packed 8-bit RGB.
3726 * Four bytes per pixel: red, green, blue, unspecified.
3728 #define VA_FOURCC_RGBX 0x58424752
3729 /** BGRA: packed 8-bit RGBA.
3731 * Four bytes per pixel: blue, green, red, alpha.
3733 #define VA_FOURCC_BGRA 0x41524742
3734 /** BGRX: packed 8-bit RGB.
3736 * Four bytes per pixel: blue, green, red, unspecified.
3738 #define VA_FOURCC_BGRX 0x58524742
3739 /** ARGB: packed 8-bit RGBA.
3741 * Four bytes per pixel: alpha, red, green, blue.
3743 #define VA_FOURCC_ARGB 0x42475241
3744 /** XRGB: packed 8-bit RGB.
3746 * Four bytes per pixel: unspecified, red, green, blue.
3748 #define VA_FOURCC_XRGB 0x42475258
3749 /** ABGR: packed 8-bit RGBA.
3751 * Four bytes per pixel: alpha, blue, green, red.
3753 #define VA_FOURCC_ABGR 0x52474241
3754 /** XBGR: packed 8-bit RGB.
3756 * Four bytes per pixel: unspecified, blue, green, red.
3758 #define VA_FOURCC_XBGR 0x52474258
3760 /** UYUV: packed 8-bit YUV 4:2:2.
3762 * Four bytes per pair of pixels: U, Y, U, V.
3764 #define VA_FOURCC_UYVY 0x59565955
3765 /** YUY2: packed 8-bit YUV 4:2:2.
3767 * Four bytes per pair of pixels: Y, U, Y, V.
3769 #define VA_FOURCC_YUY2 0x32595559
3770 /** AYUV: packed 8-bit YUVA 4:4:4.
3772 * Four bytes per pixel: A, Y, U, V.
3774 #define VA_FOURCC_AYUV 0x56555941
3775 /** NV11: two-plane 8-bit YUV 4:1:1.
3777 * The first plane contains Y, the second plane contains U and V in pairs of bytes.
3779 #define VA_FOURCC_NV11 0x3131564e
3780 /** YV12: three-plane 8-bit YUV 4:2:0.
3782 * The three planes contain Y, V and U respectively.
3784 #define VA_FOURCC_YV12 0x32315659
3785 /** P208: two-plane 8-bit YUV 4:2:2.
3787 * The first plane contains Y, the second plane contains U and V in pairs of bytes.
3789 #define VA_FOURCC_P208 0x38303250
3790 /** I420: three-plane 8-bit YUV 4:2:0.
3792 * The three planes contain Y, U and V respectively.
3794 #define VA_FOURCC_I420 0x30323449
3795 /** YV24: three-plane 8-bit YUV 4:4:4.
3797 * The three planes contain Y, V and U respectively.
3799 #define VA_FOURCC_YV24 0x34325659
3800 /** YV32: four-plane 8-bit YUVA 4:4:4
3802 * The four planes contain Y, V, U and A respectively.
3804 #define VA_FOURCC_YV32 0x32335659
3805 /** Y800: 8-bit greyscale.
3807 #define VA_FOURCC_Y800 0x30303859
3808 /** IMC3: three-plane 8-bit YUV 4:2:0.
3810 * Equivalent to YV12, but with the additional constraint that the pitch of all three planes
3813 #define VA_FOURCC_IMC3 0x33434D49
3814 /** 411P: three-plane 8-bit YUV 4:1:1.
3816 * The three planes contain Y, U and V respectively.
3818 #define VA_FOURCC_411P 0x50313134
3819 /** 411R: three-plane 8-bit YUV.
3821 * The subsampling is the transpose of 4:1:1 - full chroma appears on every fourth line.
3822 * The three planes contain Y, U and V respectively.
3824 #define VA_FOURCC_411R 0x52313134
3825 /** 422H: three-plane 8-bit YUV 4:2:2.
3827 * The three planes contain Y, U and V respectively.
3829 #define VA_FOURCC_422H 0x48323234
3830 /** 422V: three-plane 8-bit YUV 4:4:0.
3832 * The three planes contain Y, U and V respectively.
3834 #define VA_FOURCC_422V 0x56323234
3835 /** 444P: three-plane 8-bit YUV 4:4:4.
3837 * The three planes contain Y, U and V respectively.
3839 #define VA_FOURCC_444P 0x50343434
3841 /** RGBP: three-plane 8-bit RGB.
3843 * The three planes contain red, green and blue respectively.
3845 #define VA_FOURCC_RGBP 0x50424752
3846 /** BGRP: three-plane 8-bit RGB.
3848 * The three planes contain blue, green and red respectively.
3850 #define VA_FOURCC_BGRP 0x50524742
3851 /** RG16: packed 5/6-bit RGB.
3853 * Each pixel is a two-byte little-endian value.
3854 * Red, green and blue are found in bits 15:11, 10:5, 4:0 respectively.
3856 #define VA_FOURCC_RGB565 0x36314752
3857 /** BG16: packed 5/6-bit RGB.
3859 * Each pixel is a two-byte little-endian value.
3860 * Blue, green and red are found in bits 15:11, 10:5, 4:0 respectively.
3862 #define VA_FOURCC_BGR565 0x36314742
3864 /** Y210: packed 10-bit YUV 4:2:2.
3866 * Eight bytes represent a pair of pixels. Each sample is a two-byte little-endian value,
3867 * with the bottom six bits ignored. The samples are in the order Y, U, Y, V.
3869 #define VA_FOURCC_Y210 0x30313259
3870 /** Y216: packed 16-bit YUV 4:2:2.
3872 * Eight bytes represent a pair of pixels. Each sample is a two-byte little-endian value.
3873 * The samples are in the order Y, U, Y, V.
3875 #define VA_FOURCC_Y216 0x36313259
3876 /** Y410: packed 10-bit YUVA 4:4:4.
3878 * Each pixel is a four-byte little-endian value.
3879 * A, V, Y, U are found in bits 31:30, 29:20, 19:10, 9:0 respectively.
3881 #define VA_FOURCC_Y410 0x30313459
3882 /** Y416: packed 16-bit YUVA 4:4:4.
3884 * Each pixel is a set of four samples, each of which is a two-byte little-endian value.
3885 * The samples are in the order A, V, Y, U.
3887 #define VA_FOURCC_Y416 0x36313459
3889 /** YV16: three-plane 8-bit YUV 4:2:2.
3891 * The three planes contain Y, V and U respectively.
3893 #define VA_FOURCC_YV16 0x36315659
3894 /** P010: two-plane 10-bit YUV 4:2:0.
3896 * Each sample is a two-byte little-endian value with the bottom six bits ignored.
3897 * The first plane contains Y, the second plane contains U and V in pairs of samples.
3899 #define VA_FOURCC_P010 0x30313050
3900 /** P016: two-plane 16-bit YUV 4:2:0.
3902 * Each sample is a two-byte little-endian value. The first plane contains Y, the second
3903 * plane contains U and V in pairs of samples.
3905 #define VA_FOURCC_P016 0x36313050
3907 /** I010: three-plane 10-bit YUV 4:2:0.
3909 * Each sample is a two-byte little-endian value with the top six bits ignored.
3910 * The three planes contain Y, V and U respectively.
3912 #define VA_FOURCC_I010 0x30313049
3914 /** IYUV: three-plane 8-bit YUV 4:2:0.
3916 * @deprecated Use I420 instead.
3918 #define VA_FOURCC_IYUV 0x56555949
3921 #define VA_LSB_FIRST 1
3922 #define VA_MSB_FIRST 2
3924 typedef struct _VAImageFormat
3927 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3928 uint32_t bits_per_pixel;
3929 /* for RGB formats */
3930 uint32_t depth; /* significant bits per pixel */
3932 uint32_t green_mask;
3934 uint32_t alpha_mask;
3936 /** \brief Reserved bytes for future use, must be zero */
3937 uint32_t va_reserved[VA_PADDING_LOW];
3940 typedef VAGenericID VAImageID;
3942 typedef struct _VAImage
3944 VAImageID image_id; /* uniquely identify this image */
3945 VAImageFormat format;
3946 VABufferID buf; /* image data buffer */
3948 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3949 * data store on the server side for optimal performance. The buffer will be
3950 * created by the CreateImage function, and proper storage allocated based on the image
3951 * size and format. This buffer is managed by the library implementation, and
3952 * accessed by the client through the buffer Map/Unmap functions.
3957 uint32_t num_planes; /* can not be greater than 3 */
3959 * An array indicating the scanline pitch in bytes for each plane.
3960 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3962 uint32_t pitches[3];
3964 * An array indicating the byte offset from the beginning of the image data
3965 * to the start of each plane.
3967 uint32_t offsets[3];
3969 /* The following fields are only needed for paletted formats */
3970 int32_t num_palette_entries; /* set to zero for non-palette images */
3972 * Each component is one byte and entry_bytes indicates the number of components in
3973 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3975 int32_t entry_bytes;
3977 * An array of ascii characters describing the order of the components within the bytes.
3978 * Only entry_bytes characters of the string are used.
3980 int8_t component_order[4];
3982 /** \brief Reserved bytes for future use, must be zero */
3983 uint32_t va_reserved[VA_PADDING_LOW];
3986 /** Get maximum number of image formats supported by the implementation */
3987 int vaMaxNumImageFormats (
3992 * Query supported image formats
3993 * The caller must provide a "format_list" array that can hold at
3994 * least vaMaxNumImageFormats() entries. The actual number of formats
3995 * returned in "format_list" is returned in "num_formats".
3997 VAStatus vaQueryImageFormats (
3999 VAImageFormat *format_list, /* out */
4000 int *num_formats /* out */
4004 * Create a VAImage structure
4005 * The width and height fields returned in the VAImage structure may get
4006 * enlarged for some YUV formats. Upon return from this function,
4007 * image->buf has been created and proper storage allocated by the library.
4008 * The client can access the image through the Map/Unmap calls.
4010 VAStatus vaCreateImage (
4012 VAImageFormat *format,
4015 VAImage *image /* out */
4019 * Should call DestroyImage before destroying the surface it is bound to
4021 VAStatus vaDestroyImage (
4026 VAStatus vaSetImagePalette (
4030 * pointer to an array holding the palette data. The size of the array is
4031 * num_palette_entries * entry_bytes in size. The order of the components
4032 * in the palette is described by the component_order in VAImage struct
4034 unsigned char *palette
4038 * Retrive surface data into a VAImage
4039 * Image must be in a format supported by the implementation
4041 VAStatus vaGetImage (
4043 VASurfaceID surface,
4044 int x, /* coordinates of the upper left source pixel */
4046 unsigned int width, /* width and height of the region */
4047 unsigned int height,
4052 * Copy data from a VAImage to a surface
4053 * Image must be in a format supported by the implementation
4054 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
4055 * shouldn't be rendered into when this is called
4057 VAStatus vaPutImage (
4059 VASurfaceID surface,
4063 unsigned int src_width,
4064 unsigned int src_height,
4067 unsigned int dest_width,
4068 unsigned int dest_height
4072 * Derive an VAImage from an existing surface.
4073 * This interface will derive a VAImage and corresponding image buffer from
4074 * an existing VA Surface. The image buffer can then be mapped/unmapped for
4075 * direct CPU access. This operation is only possible on implementations with
4076 * direct rendering capabilities and internal surface formats that can be
4077 * represented with a VAImage. When the operation is not possible this interface
4078 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
4079 * to using vaCreateImage + vaPutImage to accomplish the same task in an
4082 * Implementations should only return success when the resulting image buffer
4083 * would be useable with vaMap/Unmap.
4085 * When directly accessing a surface special care must be taken to insure
4086 * proper synchronization with the graphics hardware. Clients should call
4087 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
4088 * rendering or currently being displayed by an overlay.
4090 * Additionally nothing about the contents of a surface should be assumed
4091 * following a vaPutSurface. Implementations are free to modify the surface for
4092 * scaling or subpicture blending within a call to vaPutImage.
4094 * Calls to vaPutImage or vaGetImage using the same surface from which the image
4095 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
4096 * vaGetImage with other surfaces is supported.
4098 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
4099 * image and image buffer structures will be destroyed; however, the underlying
4100 * surface will remain unchanged until freed with vaDestroySurfaces.
4102 VAStatus vaDeriveImage (
4104 VASurfaceID surface,
4105 VAImage *image /* out */
4110 * Subpicture is a special type of image that can be blended
4111 * with a surface during vaPutSurface(). Subpicture can be used to render
4112 * DVD sub-titles or closed captioning text etc.
4115 typedef VAGenericID VASubpictureID;
4117 /** Get maximum number of subpicture formats supported by the implementation */
4118 int vaMaxNumSubpictureFormats (
4122 /** flags for subpictures */
4123 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
4124 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
4125 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
4127 * Query supported subpicture formats
4128 * The caller must provide a "format_list" array that can hold at
4129 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
4130 * for each format to indicate additional capabilities for that format. The actual
4131 * number of formats returned in "format_list" is returned in "num_formats".
4132 * flags: returned value to indicate addtional capabilities
4133 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
4134 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
4135 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
4138 VAStatus vaQuerySubpictureFormats (
4140 VAImageFormat *format_list, /* out */
4141 unsigned int *flags, /* out */
4142 unsigned int *num_formats /* out */
4146 * Subpictures are created with an image associated.
4148 VAStatus vaCreateSubpicture (
4151 VASubpictureID *subpicture /* out */
4155 * Destroy the subpicture before destroying the image it is assocated to
4157 VAStatus vaDestroySubpicture (
4159 VASubpictureID subpicture
4163 * Bind an image to the subpicture. This image will now be associated with
4164 * the subpicture instead of the one at creation.
4166 VAStatus vaSetSubpictureImage (
4168 VASubpictureID subpicture,
4173 * If chromakey is enabled, then the area where the source value falls within
4174 * the chromakey [min, max] range is transparent
4175 * The chromakey component format is the following:
4176 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
4177 * For YUV: [0:7] V [8:15] U [16:23] Y
4178 * The chromakey mask can be used to mask out certain components for chromakey
4181 VAStatus vaSetSubpictureChromakey (
4183 VASubpictureID subpicture,
4184 unsigned int chromakey_min,
4185 unsigned int chromakey_max,
4186 unsigned int chromakey_mask
4190 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
4191 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
4192 * the overall alpha is per-pixel alpha multiplied by the global alpha
4194 VAStatus vaSetSubpictureGlobalAlpha (
4196 VASubpictureID subpicture,
4201 * vaAssociateSubpicture associates the subpicture with target_surfaces.
4202 * It defines the region mapping between the subpicture and the target
4203 * surfaces through source and destination rectangles (with the same width and height).
4204 * Both will be displayed at the next call to vaPutSurface. Additional
4205 * associations before the call to vaPutSurface simply overrides the association.
4207 VAStatus vaAssociateSubpicture (
4209 VASubpictureID subpicture,
4210 VASurfaceID *target_surfaces,
4212 int16_t src_x, /* upper left offset in subpicture */
4215 uint16_t src_height,
4216 int16_t dest_x, /* upper left offset in surface */
4218 uint16_t dest_width,
4219 uint16_t dest_height,
4221 * whether to enable chroma-keying, global-alpha, or screen relative mode
4222 * see VA_SUBPICTURE_XXX values
4228 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
4230 VAStatus vaDeassociateSubpicture (
4232 VASubpictureID subpicture,
4233 VASurfaceID *target_surfaces,
4238 * Display attributes
4239 * Display attributes are used to control things such as contrast, hue, saturation,
4240 * brightness etc. in the rendering process. The application can query what
4241 * attributes are supported by the driver, and then set the appropriate attributes
4242 * before calling vaPutSurface()
4244 /* PowerVR IEP Lite attributes */
4247 VADISPLAYATTRIB_BLE_OFF = 0x00,
4248 VADISPLAYATTRIB_BLE_LOW,
4249 VADISPLAYATTRIB_BLE_MEDIUM,
4250 VADISPLAYATTRIB_BLE_HIGH,
4251 VADISPLAYATTRIB_BLE_NONE,
4252 } VADisplayAttribBLEMode;
4254 /** attribute value for VADisplayAttribRotation */
4255 #define VA_ROTATION_NONE 0x00000000
4256 #define VA_ROTATION_90 0x00000001
4257 #define VA_ROTATION_180 0x00000002
4258 #define VA_ROTATION_270 0x00000003
4262 * @name Mirroring directions
4264 * Those values could be used for VADisplayAttribMirror attribute or
4265 * VAProcPipelineParameterBuffer::mirror_state.
4269 /** \brief No Mirroring. */
4270 #define VA_MIRROR_NONE 0x00000000
4271 /** \brief Horizontal Mirroring. */
4272 #define VA_MIRROR_HORIZONTAL 0x00000001
4273 /** \brief Vertical Mirroring. */
4274 #define VA_MIRROR_VERTICAL 0x00000002
4277 /** attribute value for VADisplayAttribOutOfLoopDeblock */
4278 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
4279 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
4282 #define VA_RENDER_MODE_UNDEFINED 0
4283 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
4284 #define VA_RENDER_MODE_LOCAL_GPU 2
4285 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
4286 #define VA_RENDER_MODE_EXTERNAL_GPU 8
4288 /** Render device */
4289 #define VA_RENDER_DEVICE_UNDEFINED 0
4290 #define VA_RENDER_DEVICE_LOCAL 1
4291 #define VA_RENDER_DEVICE_EXTERNAL 2
4293 /** Currently defined display attribute types */
4296 VADisplayAttribBrightness = 0,
4297 VADisplayAttribContrast = 1,
4298 VADisplayAttribHue = 2,
4299 VADisplayAttribSaturation = 3,
4300 /* client can specifiy a background color for the target window
4301 * the new feature of video conference,
4302 * the uncovered area of the surface is filled by this color
4303 * also it will blend with the decoded video color
4305 VADisplayAttribBackgroundColor = 4,
4307 * this is a gettable only attribute. For some implementations that use the
4308 * hardware overlay, after PutSurface is called, the surface can not be
4309 * re-used until after the subsequent PutSurface call. If this is the case
4310 * then the value for this attribute will be set to 1 so that the client
4311 * will not attempt to re-use the surface right after returning from a call
4314 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
4315 * driver may use overlay or GPU alternatively
4317 VADisplayAttribDirectSurface = 5,
4318 VADisplayAttribRotation = 6,
4319 VADisplayAttribOutofLoopDeblock = 7,
4321 /* PowerVR IEP Lite specific attributes */
4322 VADisplayAttribBLEBlackMode = 8,
4323 VADisplayAttribBLEWhiteMode = 9,
4324 VADisplayAttribBlueStretch = 10,
4325 VADisplayAttribSkinColorCorrection = 11,
4327 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
4328 * conversion matrix. Each element in the matrix is float-point
4330 VADisplayAttribCSCMatrix = 12,
4331 /* specify the constant color used to blend with video surface
4332 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
4333 * d: the final color to overwrite into the frame buffer
4334 * v: decoded video after color conversion,
4335 * c: video color specified by VADisplayAttribBlendColor
4336 * b: background color of the drawable
4338 VADisplayAttribBlendColor = 13,
4340 * Indicate driver to skip painting color key or not.
4341 * only applicable if the render is overlay
4343 VADisplayAttribOverlayAutoPaintColorKey = 14,
4345 * customized overlay color key, the format is RGB888
4346 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
4348 VADisplayAttribOverlayColorKey = 15,
4350 * The hint for the implementation of vaPutSurface
4351 * normally, the driver could use an overlay or GPU to render the surface on the screen
4352 * this flag provides APP the flexibity to switch the render dynamically
4354 VADisplayAttribRenderMode = 16,
4356 * specify if vaPutSurface needs to render into specified monitors
4357 * one example is that one external monitor (e.g. HDMI) is enabled,
4358 * but the window manager is not aware of it, and there is no associated drawable
4360 VADisplayAttribRenderDevice = 17,
4362 * specify vaPutSurface render area if there is no drawable on the monitor
4364 VADisplayAttribRenderRect = 18,
4365 } VADisplayAttribType;
4367 /* flags for VADisplayAttribute */
4368 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
4369 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
4370 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
4372 typedef struct _VADisplayAttribute
4374 VADisplayAttribType type;
4377 int32_t value; /* used by the set/get attribute functions */
4378 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
4381 /** \brief Reserved bytes for future use, must be zero */
4382 uint32_t va_reserved[VA_PADDING_LOW];
4383 } VADisplayAttribute;
4385 /** Get maximum number of display attributs supported by the implementation */
4386 int vaMaxNumDisplayAttributes (
4391 * Query display attributes
4392 * The caller must provide a "attr_list" array that can hold at
4393 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
4394 * returned in "attr_list" is returned in "num_attributes".
4396 VAStatus vaQueryDisplayAttributes (
4398 VADisplayAttribute *attr_list, /* out */
4399 int *num_attributes /* out */
4403 * Get display attributes
4404 * This function returns the current attribute values in "attr_list".
4405 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
4406 * from vaQueryDisplayAttributes() can have their values retrieved.
4408 VAStatus vaGetDisplayAttributes (
4410 VADisplayAttribute *attr_list, /* in/out */
4415 * Set display attributes
4416 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
4417 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
4418 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
4420 VAStatus vaSetDisplayAttributes (
4422 VADisplayAttribute *attr_list,
4426 /****************************
4427 * HEVC data structures
4428 ****************************/
4430 * \brief Description of picture properties of those in DPB surfaces.
4432 * If only progressive scan is supported, each surface contains one whole
4434 * Otherwise, each surface contains two fields of whole picture.
4435 * In this case, two entries of ReferenceFrames[] may share same picture_id
4438 typedef struct _VAPictureHEVC
4440 /** \brief reconstructed picture buffer surface index
4441 * invalid when taking value VA_INVALID_SURFACE.
4443 VASurfaceID picture_id;
4444 /** \brief picture order count.
4445 * in HEVC, POCs for top and bottom fields of same picture should
4446 * take different values.
4448 int32_t pic_order_cnt;
4449 /* described below */
4452 /** \brief Reserved bytes for future use, must be zero */
4453 uint32_t va_reserved[VA_PADDING_LOW];
4456 /* flags in VAPictureHEVC could be OR of the following */
4457 #define VA_PICTURE_HEVC_INVALID 0x00000001
4458 /** \brief indication of interlace scan picture.
4459 * should take same value for all the pictures in sequence.
4461 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
4462 /** \brief polarity of the field picture.
4463 * top field takes even lines of buffer surface.
4464 * bottom field takes odd lines of buffer surface.
4466 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
4467 /** \brief Long term reference picture */
4468 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
4470 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
4471 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
4472 * be exclusive. No more than one of them can be set for any picture.
4473 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
4474 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
4475 * Application should provide valid values for both short format and long format.
4476 * The pictures in DPB with any of these three flags turned on are referred by
4477 * the current picture.
4479 /** \brief RefPicSetStCurrBefore of HEVC spec variable
4480 * Number of ReferenceFrames[] entries with this bit set equals
4481 * NumPocStCurrBefore.
4483 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
4484 /** \brief RefPicSetStCurrAfter of HEVC spec variable
4485 * Number of ReferenceFrames[] entries with this bit set equals
4486 * NumPocStCurrAfter.
4488 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
4489 /** \brief RefPicSetLtCurr of HEVC spec variable
4490 * Number of ReferenceFrames[] entries with this bit set equals
4493 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
4495 #include <va/va_dec_hevc.h>
4496 #include <va/va_dec_jpeg.h>
4497 #include <va/va_dec_vp8.h>
4498 #include <va/va_dec_vp9.h>
4499 #include <va/va_enc_hevc.h>
4500 #include <va/va_fei_hevc.h>
4501 #include <va/va_enc_h264.h>
4502 #include <va/va_enc_jpeg.h>
4503 #include <va/va_enc_mpeg2.h>
4504 #include <va/va_enc_vp8.h>
4505 #include <va/va_enc_vp9.h>
4506 #include <va/va_fei.h>
4507 #include <va/va_fei_h264.h>
4508 #include <va/va_vpp.h>