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
826 /** @name Attribute values for VAConfigAttribDecSliceMode */
828 /** \brief Driver supports normal mode for slice decoding */
829 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
830 /** \brief Driver supports base mode for slice decoding */
831 #define VA_DEC_SLICE_MODE_BASE 0x00000002
833 /** @name Attribute values for VAConfigAttribDecJPEG */
835 typedef union _VAConfigAttribValDecJPEG {
837 /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
838 uint32_t rotation : 4;
839 /** \brief Reserved for future use. */
840 uint32_t reserved : 28;
843 uint32_t va_reserved[VA_PADDING_LOW];
844 } VAConfigAttribValDecJPEG;
845 /** @name Attribute values for VAConfigAttribDecProcessing */
847 /** \brief No decoding + processing in a single decoding call. */
848 #define VA_DEC_PROCESSING_NONE 0x00000000
849 /** \brief Decode + processing in a single decoding call. */
850 #define VA_DEC_PROCESSING 0x00000001
853 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
855 /** \brief Driver does not support any packed headers mode. */
856 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
858 * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
860 * Application must provide it to driver once this flag is returned through
861 * vaGetConfigAttributes()
863 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
865 * \brief Driver supports packed picture headers. e.g. PPS for H.264.
867 * Application must provide it to driver once this falg is returned through
868 * vaGetConfigAttributes()
870 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
872 * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
874 * Application must provide it to driver once this flag is returned through
875 * vaGetConfigAttributes()
877 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
879 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
882 * This is a deprecated packed header flag, All applications can use
883 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
884 * header data buffer to the driver
886 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
887 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
888 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
891 /** @name Attribute values for VAConfigAttribEncInterlaced */
893 /** \brief Driver does not support interlaced coding. */
894 #define VA_ENC_INTERLACED_NONE 0x00000000
895 /** \brief Driver supports interlaced frame coding. */
896 #define VA_ENC_INTERLACED_FRAME 0x00000001
897 /** \brief Driver supports interlaced field coding. */
898 #define VA_ENC_INTERLACED_FIELD 0x00000002
899 /** \brief Driver supports macroblock adaptive frame field coding. */
900 #define VA_ENC_INTERLACED_MBAFF 0x00000004
901 /** \brief Driver supports picture adaptive frame field coding. */
902 #define VA_ENC_INTERLACED_PAFF 0x00000008
905 /** @name Attribute values for VAConfigAttribEncSliceStructure */
907 /** \brief Driver supports a power-of-two number of rows per slice. */
908 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
909 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
910 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
911 /** \brief Dirver support 1 rows per slice */
912 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS 0x00000004
913 /** \brief Dirver support max encoded slice size per slice */
914 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE 0x00000008
915 /** \brief Driver supports an arbitrary number of rows per slice. */
916 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000010
919 /** \brief Attribute value for VAConfigAttribEncJPEG */
920 typedef union _VAConfigAttribValEncJPEG {
922 /** \brief set to 1 for arithmatic coding. */
923 uint32_t arithmatic_coding_mode : 1;
924 /** \brief set to 1 for progressive dct. */
925 uint32_t progressive_dct_mode : 1;
926 /** \brief set to 1 for non-interleaved. */
927 uint32_t non_interleaved_mode : 1;
928 /** \brief set to 1 for differential. */
929 uint32_t differential_mode : 1;
930 uint32_t max_num_components : 3;
931 uint32_t max_num_scans : 4;
932 uint32_t max_num_huffman_tables : 3;
933 uint32_t max_num_quantization_tables : 3;
936 } VAConfigAttribValEncJPEG;
938 /** @name Attribute values for VAConfigAttribEncQuantization */
940 /** \brief Driver does not support special types of quantization */
941 #define VA_ENC_QUANTIZATION_NONE 0x00000000
942 /** \brief Driver supports trellis quantization */
943 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED 0x00000001
946 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
948 /** \brief Driver does not support intra refresh */
949 #define VA_ENC_INTRA_REFRESH_NONE 0x00000000
950 /** \brief Driver supports column based rolling intra refresh */
951 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN 0x00000001
952 /** \brief Driver supports row based rolling intra refresh */
953 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW 0x00000002
954 /** \brief Driver supports adaptive intra refresh */
955 #define VA_ENC_INTRA_REFRESH_ADAPTIVE 0x00000010
956 /** \brief Driver supports cyclic intra refresh */
957 #define VA_ENC_INTRA_REFRESH_CYCLIC 0x00000020
958 /** \brief Driver supports intra refresh of P frame*/
959 #define VA_ENC_INTRA_REFRESH_P_FRAME 0x00010000
960 /** \brief Driver supports intra refresh of B frame */
961 #define VA_ENC_INTRA_REFRESH_B_FRAME 0x00020000
962 /** \brief Driver supports intra refresh of multiple reference encoder */
963 #define VA_ENC_INTRA_REFRESH_MULTI_REF 0x00040000
967 /** \brief Attribute value for VAConfigAttribEncROI */
968 typedef union _VAConfigAttribValEncROI {
970 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
971 uint32_t num_roi_regions : 8;
973 * \brief A flag indicates whether ROI priority is supported
975 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
976 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
977 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
978 * the underlying driver doesn't support ROI priority.
980 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
981 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
983 uint32_t roi_rc_priority_support : 1;
985 * \brief A flag indicates whether ROI delta QP is supported
987 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
988 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
989 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
990 * the underlying driver doesn't support ROI delta QP.
992 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
993 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
995 uint32_t roi_rc_qp_delta_support : 1;
996 uint32_t reserved : 22;
999 } VAConfigAttribValEncROI;
1001 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
1002 typedef union _VAConfigAttribValEncRateControlExt {
1005 * \brief The maximum number of temporal layers minus 1
1007 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
1008 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
1009 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
1011 uint32_t max_num_temporal_layers_minus1 : 8;
1014 * /brief support temporal layer bit-rate control flag
1016 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
1017 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
1018 * #VAConfigAttribRateControl == #VA_RC_VBR).
1020 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
1021 * \c max_num_temporal_layers_minus1 is equal to 0
1023 * To use bit-rate control per temporal layer, an application must send the right layer
1024 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
1025 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
1026 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
1027 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
1028 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
1029 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
1030 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
1032 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
1033 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
1034 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
1036 uint32_t temporal_layer_bitrate_control_flag : 1;
1037 uint32_t reserved : 23;
1040 } VAConfigAttribValEncRateControlExt;
1042 /** @name Attribute values for VAConfigAttribProcessingRate. */
1044 /** \brief Driver does not support processing rate report */
1045 #define VA_PROCESSING_RATE_NONE 0x00000000
1046 /** \brief Driver supports encode processing rate report */
1047 #define VA_PROCESSING_RATE_ENCODE 0x00000001
1048 /** \brief Driver supports decode processing rate report */
1049 #define VA_PROCESSING_RATE_DECODE 0x00000002
1052 * if an attribute is not applicable for a given
1053 * profile/entrypoint pair, then set the value to the following
1055 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
1057 /** Get maximum number of profiles supported by the implementation */
1058 int vaMaxNumProfiles (
1062 /** Get maximum number of entrypoints supported by the implementation */
1063 int vaMaxNumEntrypoints (
1067 /** Get maximum number of attributs supported by the implementation */
1068 int vaMaxNumConfigAttributes (
1073 * Query supported profiles
1074 * The caller must provide a "profile_list" array that can hold at
1075 * least vaMaxNumProfile() entries. The actual number of profiles
1076 * returned in "profile_list" is returned in "num_profile".
1078 VAStatus vaQueryConfigProfiles (
1080 VAProfile *profile_list, /* out */
1081 int *num_profiles /* out */
1085 * Query supported entrypoints for a given profile
1086 * The caller must provide an "entrypoint_list" array that can hold at
1087 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
1088 * returned in "entrypoint_list" is returned in "num_entrypoints".
1090 VAStatus vaQueryConfigEntrypoints (
1093 VAEntrypoint *entrypoint_list, /* out */
1094 int *num_entrypoints /* out */
1098 * Get attributes for a given profile/entrypoint pair
1099 * The caller must provide an "attrib_list" with all attributes to be
1100 * retrieved. Upon return, the attributes in "attrib_list" have been
1101 * updated with their value. Unknown attributes or attributes that are
1102 * not supported for the given profile/entrypoint pair will have their
1103 * value set to VA_ATTRIB_NOT_SUPPORTED
1105 VAStatus vaGetConfigAttributes (
1108 VAEntrypoint entrypoint,
1109 VAConfigAttrib *attrib_list, /* in/out */
1113 /** Generic ID type, can be re-typed for specific implementation */
1114 typedef unsigned int VAGenericID;
1116 typedef VAGenericID VAConfigID;
1119 * Create a configuration for the video decode/encode/processing pipeline
1120 * it passes in the attribute list that specifies the attributes it cares
1121 * about, with the rest taking default values.
1123 VAStatus vaCreateConfig (
1126 VAEntrypoint entrypoint,
1127 VAConfigAttrib *attrib_list,
1129 VAConfigID *config_id /* out */
1133 * Free resources associdated with a given config
1135 VAStatus vaDestroyConfig (
1137 VAConfigID config_id
1141 * Query all attributes for a given configuration
1142 * The profile of the configuration is returned in "profile"
1143 * The entrypoint of the configuration is returned in "entrypoint"
1144 * The caller must provide an "attrib_list" array that can hold at least
1145 * vaMaxNumConfigAttributes() entries. The actual number of attributes
1146 * returned in "attrib_list" is returned in "num_attribs"
1148 VAStatus vaQueryConfigAttributes (
1150 VAConfigID config_id,
1151 VAProfile *profile, /* out */
1152 VAEntrypoint *entrypoint, /* out */
1153 VAConfigAttrib *attrib_list,/* out */
1154 int *num_attribs /* out */
1159 * Contexts and Surfaces
1161 * Context represents a "virtual" video decode, encode or video processing
1162 * pipeline. Surfaces are render targets for a given context. The data in the
1163 * surfaces are not accessible to the client except if derived image is supported
1164 * and the internal data format of the surface is implementation specific.
1166 * Surfaces are provided as a hint of what surfaces will be used when the context
1167 * is created through vaCreateContext(). A surface may be used by different contexts
1168 * at the same time as soon as application can make sure the operations are synchronized
1169 * between different contexts, e.g. a surface is used as the output of a decode context
1170 * and the input of a video process context. Surfaces can only be destroyed after all
1171 * contexts using these surfaces have been destroyed.
1173 * Both contexts and surfaces are identified by unique IDs and its
1174 * implementation specific internals are kept opaque to the clients
1177 typedef VAGenericID VAContextID;
1179 typedef VAGenericID VASurfaceID;
1181 #define VA_INVALID_ID 0xffffffff
1182 #define VA_INVALID_SURFACE VA_INVALID_ID
1184 /** \brief Generic value types. */
1186 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
1187 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
1188 VAGenericValueTypePointer, /**< Generic pointer type */
1189 VAGenericValueTypeFunc /**< Pointer to function */
1190 } VAGenericValueType;
1192 /** \brief Generic function type. */
1193 typedef void (*VAGenericFunc)(void);
1195 /** \brief Generic value. */
1196 typedef struct _VAGenericValue {
1197 /** \brief Value type. See #VAGenericValueType. */
1198 VAGenericValueType type;
1199 /** \brief Value holder. */
1201 /** \brief 32-bit signed integer. */
1203 /** \brief 32-bit float. */
1205 /** \brief Generic pointer. */
1207 /** \brief Pointer to function. */
1212 /** @name Surface attribute flags */
1214 /** \brief Surface attribute is not supported. */
1215 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1216 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1217 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
1218 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1219 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
1222 /** \brief Surface attribute types. */
1224 VASurfaceAttribNone = 0,
1226 * \brief Pixel format (fourcc).
1228 * The value is meaningful as input to vaQuerySurfaceAttributes().
1229 * If zero, the driver returns the optimal pixel format for the
1230 * specified config. Otherwise, if non-zero, the value represents
1231 * a pixel format (FOURCC) that is kept as is on output, if the
1232 * driver supports it. Otherwise, the driver sets the value to
1233 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1235 VASurfaceAttribPixelFormat,
1236 /** \brief Minimal width in pixels (int, read-only). */
1237 VASurfaceAttribMinWidth,
1238 /** \brief Maximal width in pixels (int, read-only). */
1239 VASurfaceAttribMaxWidth,
1240 /** \brief Minimal height in pixels (int, read-only). */
1241 VASurfaceAttribMinHeight,
1242 /** \brief Maximal height in pixels (int, read-only). */
1243 VASurfaceAttribMaxHeight,
1244 /** \brief Surface memory type expressed in bit fields (int, read/write). */
1245 VASurfaceAttribMemoryType,
1246 /** \brief External buffer descriptor (pointer, write). */
1247 VASurfaceAttribExternalBufferDescriptor,
1248 /** \brief Surface usage hint, gives the driver a hint of intended usage
1249 * to optimize allocation (e.g. tiling) (int, read/write). */
1250 VASurfaceAttribUsageHint,
1251 /** \brief Number of surface attributes. */
1252 VASurfaceAttribCount
1253 } VASurfaceAttribType;
1255 /** \brief Surface attribute. */
1256 typedef struct _VASurfaceAttrib {
1258 VASurfaceAttribType type;
1259 /** \brief Flags. See "Surface attribute flags". */
1261 /** \brief Value. See "Surface attribute types" for the expected types. */
1262 VAGenericValue value;
1266 * @name VASurfaceAttribMemoryType values in bit fields.
1267 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
1268 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1269 * types are defined in DRM and Android header files.
1272 /** \brief VA memory type (default) is supported. */
1273 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
1274 /** \brief V4L2 buffer memory type is supported. */
1275 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
1276 /** \brief User pointer memory type is supported. */
1277 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
1281 * \brief VASurfaceAttribExternalBuffers structure for
1282 * the VASurfaceAttribExternalBufferDescriptor attribute.
1284 typedef struct _VASurfaceAttribExternalBuffers {
1285 /** \brief pixel format in fourcc. */
1286 uint32_t pixel_format;
1287 /** \brief width in pixels. */
1289 /** \brief height in pixels. */
1291 /** \brief total size of the buffer in bytes. */
1293 /** \brief number of planes for planar layout */
1294 uint32_t num_planes;
1295 /** \brief pitch for each plane in bytes */
1296 uint32_t pitches[4];
1297 /** \brief offset for each plane in bytes */
1298 uint32_t offsets[4];
1299 /** \brief buffer handles or user pointers */
1301 /** \brief number of elements in the "buffers" array */
1302 uint32_t num_buffers;
1303 /** \brief flags. See "Surface external buffer descriptor flags". */
1305 /** \brief reserved for passing private data */
1307 } VASurfaceAttribExternalBuffers;
1309 /** @name VASurfaceAttribExternalBuffers flags */
1311 /** \brief Enable memory tiling */
1312 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1313 /** \brief Memory is cacheable */
1314 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1315 /** \brief Memory is non-cacheable */
1316 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1317 /** \brief Memory is write-combined */
1318 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1319 /** \brief Memory is protected */
1320 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1322 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1324 /** \brief Surface usage not indicated. */
1325 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1326 /** \brief Surface used by video decoder. */
1327 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1328 /** \brief Surface used by video encoder. */
1329 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1330 /** \brief Surface read by video post-processing. */
1331 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1332 /** \brief Surface written by video post-processing. */
1333 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1334 /** \brief Surface used for display. */
1335 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1336 /** \brief Surface used for export to third-party APIs, e.g. via
1337 * vaExportSurfaceHandle(). */
1338 #define VA_SURFACE_ATTRIB_USAGE_HINT_EXPORT 0x00000020
1343 * \brief Queries surface attributes for the supplied config.
1345 * This function queries for all supported attributes for the
1346 * supplied VA @config. In particular, if the underlying hardware
1347 * supports the creation of VA surfaces in various formats, then
1348 * this function will enumerate all pixel formats that are supported.
1350 * The \c attrib_list array is allocated by the user and \c
1351 * num_attribs shall be initialized to the number of allocated
1352 * elements in that array. Upon successful return, the actual number
1353 * of attributes will be overwritten into \c num_attribs. Otherwise,
1354 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1355 * is adjusted to the number of elements that would be returned if
1356 * enough space was available.
1358 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1359 * argument when vaQuerySurfaceAttributes() is used to determine the
1360 * actual number of elements that need to be allocated.
1362 * @param[in] dpy the VA display
1363 * @param[in] config the config identifying a codec or a video
1364 * processing pipeline
1365 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1366 * @param[in,out] num_attribs the number of elements allocated on
1367 * input, the number of elements actually filled in output
1370 vaQuerySurfaceAttributes(
1373 VASurfaceAttrib *attrib_list,
1374 unsigned int *num_attribs
1378 * \brief Creates an array of surfaces
1380 * Creates an array of surfaces. The optional list of attributes shall
1381 * be constructed based on what the underlying hardware could expose
1382 * through vaQuerySurfaceAttributes().
1384 * @param[in] dpy the VA display
1385 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1386 * @param[in] width the surface width
1387 * @param[in] height the surface height
1388 * @param[out] surfaces the array of newly created surfaces
1389 * @param[in] num_surfaces the number of surfaces to create
1390 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1391 * @param[in] num_attribs the number of attributes supplied in
1392 * \c attrib_list, or zero
1397 unsigned int format,
1399 unsigned int height,
1400 VASurfaceID *surfaces,
1401 unsigned int num_surfaces,
1402 VASurfaceAttrib *attrib_list,
1403 unsigned int num_attribs
1407 * vaDestroySurfaces - Destroy resources associated with surfaces.
1408 * Surfaces can only be destroyed after all contexts using these surfaces have been
1411 * surfaces: array of surfaces to destroy
1412 * num_surfaces: number of surfaces in the array to be destroyed.
1414 VAStatus vaDestroySurfaces (
1416 VASurfaceID *surfaces,
1420 #define VA_PROGRESSIVE 0x1
1422 * vaCreateContext - Create a context
1424 * config_id: configuration for the context
1425 * picture_width: coded picture width
1426 * picture_height: coded picture height
1427 * flag: any combination of the following:
1428 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1429 * render_targets: a hint for render targets (surfaces) tied to the context
1430 * num_render_targets: number of render targets in the above array
1431 * context: created context id upon return
1433 VAStatus vaCreateContext (
1435 VAConfigID config_id,
1439 VASurfaceID *render_targets,
1440 int num_render_targets,
1441 VAContextID *context /* out */
1445 * vaDestroyContext - Destroy a context
1447 * context: context to be destroyed
1449 VAStatus vaDestroyContext (
1454 //Multi-frame context
1455 typedef VAGenericID VAMFContextID;
1457 * vaCreateMFContext - Create a multi-frame context
1458 * interface encapsulating common for all streams memory objects and structures
1459 * required for single GPU task submission from several VAContextID's.
1460 * Allocation: This call only creates an instance, doesn't allocate any additional memory.
1461 * Support identification: Application can identify multi-frame feature support by ability
1462 * to create multi-frame context. If driver supports multi-frame - call successful,
1463 * mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1464 * not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1466 * VA_STATUS_SUCCESS - operation successful.
1467 * VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1468 * dpy: display adapter.
1469 * mf_context: Multi-Frame context encapsulating all associated context
1470 * for multi-frame submission.
1472 VAStatus vaCreateMFContext (
1474 VAMFContextID *mf_context /* out */
1478 * vaMFAddContext - Provide ability to associate each context used for
1479 * Multi-Frame submission and common Multi-Frame context.
1480 * Try to add context to understand if it is supported.
1481 * Allocation: this call allocates and/or reallocates all memory objects
1482 * common for all contexts associated with particular Multi-Frame context.
1483 * All memory required for each context(pixel buffers, internal driver
1484 * buffers required for processing) allocated during standard vaCreateContext call for each context.
1485 * Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1486 * first context added will set entry point/profile for whole Multi-Frame context,
1487 * all other entry points and profiles can be rejected to be added.
1489 * VA_STATUS_SUCCESS - operation successful, context was added.
1490 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1491 * current mf_context and associated contexts and start working with new ones.
1492 * VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1493 * 1 - mf_context is not valid context or
1494 * 2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1495 * and current context contradicts with previously added, application can continue with current mf_context
1496 * and other contexts passed this call, rejected context can continue work in stand-alone
1497 * mode or other mf_context.
1498 * VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1499 * unsupported VAEntrypoint. Application can continue with current mf_context
1500 * and other contexts passed this call, rejected context can continue work in stand-alone
1502 * VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1503 * but VAProfile is not supported. Application can continue with current mf_context
1504 * and other contexts passed this call, rejected context can continue work in stand-alone
1506 * dpy: display adapter.
1507 * context: context being associated with Multi-Frame context.
1508 * mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1510 VAStatus vaMFAddContext (
1512 VAMFContextID mf_context,
1517 * vaMFReleaseContext - Removes context from multi-frame and
1518 * association with multi-frame context.
1519 * After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1521 * VA_STATUS_SUCCESS - operation successful, context was removed.
1522 * VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1523 * application need to destroy this VAMFContextID and all assotiated VAContextID
1525 * mf_context: VAMFContextID where context is added
1526 * context: VAContextID to be added
1528 VAStatus vaMFReleaseContext (
1530 VAMFContextID mf_context,
1536 * Buffers are used to pass various types of data from the
1537 * client to the server. The server maintains a data store
1538 * for each buffer created, and the client idenfies a buffer
1539 * through a unique buffer id assigned by the server.
1542 typedef VAGenericID VABufferID;
1546 VAPictureParameterBufferType = 0,
1547 VAIQMatrixBufferType = 1,
1548 VABitPlaneBufferType = 2,
1549 VASliceGroupMapBufferType = 3,
1550 VASliceParameterBufferType = 4,
1551 VASliceDataBufferType = 5,
1552 VAMacroblockParameterBufferType = 6,
1553 VAResidualDataBufferType = 7,
1554 VADeblockingParameterBufferType = 8,
1555 VAImageBufferType = 9,
1556 VAProtectedSliceDataBufferType = 10,
1557 VAQMatrixBufferType = 11,
1558 VAHuffmanTableBufferType = 12,
1559 VAProbabilityBufferType = 13,
1561 /* Following are encode buffer types */
1562 VAEncCodedBufferType = 21,
1563 VAEncSequenceParameterBufferType = 22,
1564 VAEncPictureParameterBufferType = 23,
1565 VAEncSliceParameterBufferType = 24,
1566 VAEncPackedHeaderParameterBufferType = 25,
1567 VAEncPackedHeaderDataBufferType = 26,
1568 VAEncMiscParameterBufferType = 27,
1569 VAEncMacroblockParameterBufferType = 28,
1570 VAEncMacroblockMapBufferType = 29,
1573 * \brief Encoding QP buffer
1575 * This buffer contains QP per MB for encoding. Currently
1576 * VAEncQPBufferH264 is defined for H.264 encoding, see
1577 * #VAEncQPBufferH264 for details
1579 VAEncQPBufferType = 30,
1580 /* Following are video processing buffer types */
1582 * \brief Video processing pipeline parameter buffer.
1584 * This buffer describes the video processing pipeline. See
1585 * #VAProcPipelineParameterBuffer for details.
1587 VAProcPipelineParameterBufferType = 41,
1589 * \brief Video filter parameter buffer.
1591 * This buffer describes the video filter parameters. All buffers
1592 * inherit from #VAProcFilterParameterBufferBase, thus including
1593 * a unique filter buffer type.
1595 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1596 * Filters requiring advanced parameters include, but are not limited to,
1597 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1598 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1600 VAProcFilterParameterBufferType = 42,
1602 * \brief FEI specific buffer types
1604 VAEncFEIMVBufferType = 43,
1605 VAEncFEIMBCodeBufferType = 44,
1606 VAEncFEIDistortionBufferType = 45,
1607 VAEncFEIMBControlBufferType = 46,
1608 VAEncFEIMVPredictorBufferType = 47,
1609 VAStatsStatisticsParameterBufferType = 48,
1610 /** \brief Statistics output for VAEntrypointStats progressive and top field of interlaced case*/
1611 VAStatsStatisticsBufferType = 49,
1612 /** \brief Statistics output for VAEntrypointStats bottom field of interlaced case*/
1613 VAStatsStatisticsBottomFieldBufferType = 50,
1614 VAStatsMVBufferType = 51,
1615 VAStatsMVPredictorBufferType = 52,
1616 /** Force MB's to be non skip for encode.it's per-mb control buffer, The width of the MB map
1617 * Surface is (width of the Picture in MB unit) * 1 byte, multiple of 64 bytes.
1618 * The height is (height of the picture in MB unit). The picture is either
1619 * frame or non-interleaved top or bottom field. If the application provides this
1620 *surface, it will override the "skipCheckDisable" setting in VAEncMiscParameterEncQuality.
1622 VAEncMacroblockDisableSkipMapBufferType = 53,
1624 * \brief HEVC FEI CTB level cmd buffer
1625 * it is CTB level information for future usage.
1627 VAEncFEICTBCmdBufferType = 54,
1629 * \brief HEVC FEI CU level data buffer
1630 * it's CTB level information for future usage
1632 VAEncFEICURecordBufferType = 55,
1633 /** decode stream out buffer, intermedia data of decode, it may include MV, MB mode etc.
1634 * it can be used to detect motion and analyze the frame contain */
1635 VADecodeStreamoutBufferType = 56,
1640 * Processing rate parameter for encode.
1642 typedef struct _VAProcessingRateParameterEnc {
1643 /** \brief Profile level */
1645 uint8_t reserved[3];
1646 /** \brief quality level. When set to 0, default quality
1649 uint32_t quality_level;
1650 /** \brief Period between I frames. */
1651 uint32_t intra_period;
1652 /** \brief Period between I/P frames. */
1654 } VAProcessingRateParameterEnc;
1657 * Processing rate parameter for decode.
1659 typedef struct _VAProcessingRateParameterDec {
1660 /** \brief Profile level */
1662 uint8_t reserved0[3];
1664 } VAProcessingRateParameterDec;
1666 typedef struct _VAProcessingRateParameter {
1668 VAProcessingRateParameterEnc proc_buf_enc;
1669 VAProcessingRateParameterDec proc_buf_dec;
1671 } VAProcessingRateParameter;
1674 * \brief Queries processing rate for the supplied config.
1676 * This function queries the processing rate based on parameters in
1677 * \c proc_buf for the given \c config. Upon successful return, the processing
1678 * rate value will be stored in \c processing_rate. Processing rate is
1679 * specified as the number of macroblocks/CTU per second.
1681 * If NULL is passed to the \c proc_buf, the default processing rate for the
1682 * given configuration will be returned.
1684 * @param[in] dpy the VA display
1685 * @param[in] config the config identifying a codec or a video
1686 * processing pipeline
1687 * @param[in] proc_buf the buffer that contains the parameters for
1688 either the encode or decode processing rate
1689 * @param[out] processing_rate processing rate in number of macroblocks per
1690 second constrained by parameters specified in proc_buf
1694 vaQueryProcessingRate(
1697 VAProcessingRateParameter *proc_buf,
1698 unsigned int *processing_rate
1703 VAEncMiscParameterTypeFrameRate = 0,
1704 VAEncMiscParameterTypeRateControl = 1,
1705 VAEncMiscParameterTypeMaxSliceSize = 2,
1706 VAEncMiscParameterTypeAIR = 3,
1707 /** \brief Buffer type used to express a maximum frame size (in bits). */
1708 VAEncMiscParameterTypeMaxFrameSize = 4,
1709 /** \brief Buffer type used for HRD parameters. */
1710 VAEncMiscParameterTypeHRD = 5,
1711 VAEncMiscParameterTypeQualityLevel = 6,
1712 /** \brief Buffer type used for Rolling intra refresh */
1713 VAEncMiscParameterTypeRIR = 7,
1714 /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1715 VAEncMiscParameterTypeQuantization = 8,
1716 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1717 * rate control, when the user has externally skipped frames. */
1718 VAEncMiscParameterTypeSkipFrame = 9,
1719 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1720 VAEncMiscParameterTypeROI = 10,
1721 /** \brief Buffer type used for temporal layer structure */
1722 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1723 /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1724 VAEncMiscParameterTypeDirtyRect = 13,
1725 /** \brief Buffer type used for parallel BRC parameters. */
1726 VAEncMiscParameterTypeParallelBRC = 14,
1727 /** \brief Set MB partion mode mask and Half-pel/Quant-pel motion search */
1728 VAEncMiscParameterTypeSubMbPartPel = 15,
1729 /** \brief set encode quality tuning */
1730 VAEncMiscParameterTypeEncQuality = 16,
1731 /** \brief Buffer type used for encoder rounding offset parameters. */
1732 VAEncMiscParameterTypeCustomRoundingControl = 17,
1733 /** \brief Buffer type used for FEI input frame level parameters */
1734 VAEncMiscParameterTypeFEIFrameControl = 18,
1735 /** \brief encode extension buffer, ect. MPEG2 Sequence extenstion data */
1736 VAEncMiscParameterTypeExtensionData = 19
1737 } VAEncMiscParameterType;
1739 /** \brief Packed header type. */
1741 /** \brief Packed sequence header. */
1742 VAEncPackedHeaderSequence = 1,
1743 /** \brief Packed picture header. */
1744 VAEncPackedHeaderPicture = 2,
1745 /** \brief Packed slice header. */
1746 VAEncPackedHeaderSlice = 3,
1748 * \brief Packed raw header.
1750 * Packed raw data header can be used by the client to insert a header
1751 * into the bitstream data buffer at the point it is passed, the driver
1752 * will handle the raw packed header based on "has_emulation_bytes" field
1753 * in the packed header parameter structure.
1755 VAEncPackedHeaderRawData = 4,
1757 * \brief Misc packed header. See codec-specific definitions.
1760 * This is a deprecated packed header type. All applications can use
1761 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1763 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1764 } VAEncPackedHeaderType;
1766 /** \brief Packed header parameter. */
1767 typedef struct _VAEncPackedHeaderParameterBuffer {
1768 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1770 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1771 uint32_t bit_length;
1772 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1773 uint8_t has_emulation_bytes;
1775 /** \brief Reserved bytes for future use, must be zero */
1776 uint32_t va_reserved[VA_PADDING_LOW];
1777 } VAEncPackedHeaderParameterBuffer;
1780 * For application, e.g. set a new bitrate
1781 * VABufferID buf_id;
1782 * VAEncMiscParameterBuffer *misc_param;
1783 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1785 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1786 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1787 * 1, NULL, &buf_id);
1789 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1790 * misc_param->type = VAEncMiscParameterTypeRateControl;
1791 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1792 * misc_rate_ctrl->bits_per_second = 6400000;
1793 * vaUnmapBuffer(dpy, buf_id);
1794 * vaRenderPicture(dpy, context, &buf_id, 1);
1796 typedef struct _VAEncMiscParameterBuffer
1798 VAEncMiscParameterType type;
1800 } VAEncMiscParameterBuffer;
1802 /** \brief Temporal layer Structure*/
1803 typedef struct _VAEncMiscParameterTemporalLayerStructure
1805 /** \brief The number of temporal layers */
1806 uint32_t number_of_layers;
1807 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1808 uint32_t periodicity;
1810 * \brief The array indicating the layer id for each frame
1812 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1813 * ids for frames starting from the 2nd frame.
1815 uint32_t layer_id[32];
1817 /** \brief Reserved bytes for future use, must be zero */
1818 uint32_t va_reserved[VA_PADDING_LOW];
1819 } VAEncMiscParameterTemporalLayerStructure;
1822 /** \brief Rate control parameters */
1823 typedef struct _VAEncMiscParameterRateControl
1825 /** The maximum bit-rate which the the rate controller should generate. */
1826 uint32_t bits_per_second;
1827 /** The target bit-rate which the rate controller should generate, as a percentage of the
1830 * In CBR mode this value is ignored (treated as 100%).
1832 uint32_t target_percentage;
1833 /** Rate control window size in milliseconds.
1835 * The rate controller will attempt to guarantee that the target and maximum bit-rates are
1836 * correct over this window.
1838 uint32_t window_size;
1839 /** Initial quantiser value used at the start of the stream.
1841 * Ignored if set to zero.
1843 uint32_t initial_qp;
1844 /** Minimum quantiser value to use.
1846 * The quantiser will not go below the value - if this limit is hit, the output bitrate may
1847 * be lower than the target. Ignored if set to zero.
1850 /** Basic unit size.
1852 * Only used by some drivers - see driver documentation for details. Set to zero if unused.
1854 uint32_t basic_unit_size;
1859 /** Force rate controller reset.
1861 * The next frame will be treated as the start of a new stream, with all rate
1862 * controller state reset to its initial values.
1865 /** Disable frame skip in rate control mode. */
1866 uint32_t disable_frame_skip : 1;
1867 /** Disable bit stuffing in rate control mode. */
1868 uint32_t disable_bit_stuffing : 1;
1869 /** Macroblock-level rate control.
1871 * 0: use default, 1: always enable, 2: always disable, other: reserved.
1873 * This feature is only available if VAConfigAttribRateControl has the
1874 * \ref VA_RC_MB bit set.
1876 uint32_t mb_rate_control : 4;
1877 /** The temporal layer that these rate control parameters apply to. */
1878 uint32_t temporal_id : 8;
1879 /** Ensure that intra frames also conform to the constant frame size. */
1880 uint32_t cfs_I_frames : 1;
1881 /** Enable parallel rate control for hierarchical B frames.
1883 * See \ref VA_RC_PARALLEL.
1885 uint32_t enable_parallel_brc : 1;
1886 uint32_t enable_dynamic_scaling : 1;
1887 /** Frame tolerance mode.
1889 * Indicates the tolerance the application has to variations in the frame size.
1890 * For example, wireless display scenarios may require very steady bit rate to
1891 * reduce buffering time. It affects the rate control algorithm used,
1892 * but may or may not have an effect based on the combination of other BRC
1893 * parameters. Only valid when the driver reports support for
1894 * #VAConfigAttribFrameSizeToleranceSupport.
1896 * equals 0 -- normal mode;
1897 * equals 1 -- maps to sliding window;
1898 * equals 2 -- maps to low delay mode;
1901 uint32_t frame_tolerance_mode : 2;
1902 /** Reserved for future use, must be zero. */
1903 uint32_t reserved : 12;
1907 /** Initial quality factor used in ICQ mode.
1909 * This value must be between 1 and 51.
1911 uint32_t ICQ_quality_factor;
1912 /** Maximum quantiser value to use.
1914 * The quantiser will not go above this value - if this limit is hit, the output bitrate
1915 * may exceed the target. Ignored if set to zero.
1918 /** Reserved bytes for future use, must be zero. */
1919 uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1920 } VAEncMiscParameterRateControl;
1922 /** Encode framerate parameters.
1924 * Sets the encode framerate used by the rate controller. This should be
1925 * provided in all modes using a bitrate target (variable framerate is not
1928 typedef struct _VAEncMiscParameterFrameRate
1930 /** Encode framerate.
1932 * The framerate is specified as a number of frames per second, as a
1933 * fraction. The denominator of the fraction is given in the top half
1934 * (the high two bytes) of the framerate field, and the numerator is
1935 * given in the bottom half (the low two bytes).
1938 * denominator = framerate >> 16 & 0xffff;
1939 * numerator = framerate & 0xffff;
1940 * fps = numerator / denominator;
1942 * For example, if framerate is set to (100 << 16 | 750), this is
1943 * 750 / 100, hence 7.5fps.
1945 * If the denominator is zero (the high two bytes are both zero) then
1946 * it takes the value one instead, so the framerate is just the integer
1947 * in the low 2 bytes.
1954 /** The temporal layer that these framerate parameters apply to. */
1955 uint32_t temporal_id : 8;
1956 /** Reserved for future use, must be zero. */
1957 uint32_t reserved : 24;
1962 /** \brief Reserved bytes for future use, must be zero */
1963 uint32_t va_reserved[VA_PADDING_LOW];
1964 } VAEncMiscParameterFrameRate;
1967 * Allow a maximum slice size to be specified (in bits).
1968 * The encoder will attempt to make sure that individual slices do not exceed this size
1969 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1971 typedef struct _VAEncMiscParameterMaxSliceSize
1973 uint32_t max_slice_size;
1975 /** \brief Reserved bytes for future use, must be zero */
1976 uint32_t va_reserved[VA_PADDING_LOW];
1977 } VAEncMiscParameterMaxSliceSize;
1979 typedef struct _VAEncMiscParameterAIR
1981 uint32_t air_num_mbs;
1982 uint32_t air_threshold;
1983 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1985 /** \brief Reserved bytes for future use, must be zero */
1986 uint32_t va_reserved[VA_PADDING_LOW];
1987 } VAEncMiscParameterAIR;
1990 * \brief Rolling intra refresh data structure for encoding.
1992 typedef struct _VAEncMiscParameterRIR
1998 * \brief Indicate if intra refresh is enabled in column/row.
2000 * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
2001 * by the driver before sending this structure.
2004 /* \brief enable RIR in column */
2005 uint32_t enable_rir_column : 1;
2006 /* \brief enable RIR in row */
2007 uint32_t enable_rir_row : 1;
2008 uint32_t reserved : 30;
2013 * \brief Indicates the column or row location in MB. It is ignored if
2016 uint16_t intra_insertion_location;
2018 * \brief Indicates the number of columns or rows in MB. It is ignored if
2021 uint16_t intra_insert_size;
2023 * \brief indicates the Qp difference for inserted intra columns or rows.
2024 * App can use this to adjust intra Qp based on bitrate & max frame size.
2026 uint8_t qp_delta_for_inserted_intra;
2027 /** \brief Reserved bytes for future use, must be zero */
2028 uint32_t va_reserved[VA_PADDING_LOW];
2029 } VAEncMiscParameterRIR;
2031 /** HRD / VBV buffering parameters for encoding.
2033 * This sets the HRD / VBV parameters which will be used by the rate
2034 * controller for encoding. It should be specified in modes using a bitrate
2035 * target when the buffering of the output stream needs to be constrained.
2037 * If not provided, the encoder may use arbitrary amounts of buffering.
2039 typedef struct _VAEncMiscParameterHRD
2041 /** The initial fullness of the HRD coded picture buffer, in bits.
2043 * This sets how full the CPB is when encoding begins - that is, how much
2044 * buffering will happen on the decoder side before the first frame.
2045 * The CPB fullness will be reset to this value after any rate control
2046 * reset (a change in parameters or an explicit reset).
2048 * For H.264, it should match the value of initial_cpb_removal_delay in
2049 * buffering_period SEI messages.
2051 uint32_t initial_buffer_fullness;
2052 /** The HRD coded picture buffer size, in bits.
2054 * For H.264, it should match the value of cpb_size_value_minus1 in the VUI
2057 uint32_t buffer_size;
2059 /** \brief Reserved bytes for future use, must be zero */
2060 uint32_t va_reserved[VA_PADDING_LOW];
2061 } VAEncMiscParameterHRD;
2064 * \brief Defines a maximum frame size (in bits).
2066 * This misc parameter buffer defines the maximum size of a frame (in
2067 * bits). The encoder will try to make sure that each frame does not
2068 * exceed this size. Otherwise, if the frame size exceeds this size,
2069 * the \c status flag of #VACodedBufferSegment will contain
2070 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
2072 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
2073 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
2074 VAEncMiscParameterType type;
2075 /** \brief Maximum size of a frame (in bits). */
2076 uint32_t max_frame_size;
2078 /** \brief Reserved bytes for future use, must be zero */
2079 uint32_t va_reserved[VA_PADDING_LOW];
2080 } VAEncMiscParameterBufferMaxFrameSize;
2083 * \brief Encoding quality level.
2085 * The encoding quality could be set through this structure, if the implementation
2086 * supports multiple quality levels. The quality level set through this structure is
2087 * persistent over the entire coded sequence, or until a new structure is being sent.
2088 * The quality level range can be queried through the VAConfigAttribEncQualityRange
2089 * attribute. A lower value means higher quality, and a value of 1 represents the highest
2090 * quality. The quality level setting is used as a trade-off between quality and speed/power
2091 * consumption, with higher quality corresponds to lower speed and higher power consumption.
2093 typedef struct _VAEncMiscParameterBufferQualityLevel {
2094 /** \brief Encoding quality level setting. When set to 0, default quality
2097 uint32_t quality_level;
2099 /** \brief Reserved bytes for future use, must be zero */
2100 uint32_t va_reserved[VA_PADDING_LOW];
2101 } VAEncMiscParameterBufferQualityLevel;
2104 * \brief Quantization settings for encoding.
2106 * Some encoders support special types of quantization such as trellis, and this structure
2107 * can be used by the app to control these special types of quantization by the encoder.
2109 typedef struct _VAEncMiscParameterQuantization
2113 /* if no flags is set then quantization is determined by the driver */
2116 /* \brief disable trellis for all frames/fields */
2117 uint64_t disable_trellis : 1;
2118 /* \brief enable trellis for I frames/fields */
2119 uint64_t enable_trellis_I : 1;
2120 /* \brief enable trellis for P frames/fields */
2121 uint64_t enable_trellis_P : 1;
2122 /* \brief enable trellis for B frames/fields */
2123 uint64_t enable_trellis_B : 1;
2124 uint64_t reserved : 28;
2127 } quantization_flags;
2128 } VAEncMiscParameterQuantization;
2131 * \brief Encoding skip frame.
2133 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
2134 * code as all skip's). For rate control purposes the encoder will need to know the size and number
2135 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
2136 * current frame. It is allowed for the application to still send in packed headers for the driver to
2137 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
2139 typedef struct _VAEncMiscParameterSkipFrame {
2140 /** \brief Indicates skip frames as below.
2141 * 0: Encode as normal, no skip.
2142 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
2143 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
2144 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
2145 * in VAEncPackedHeaderPicture). */
2146 uint8_t skip_frame_flag;
2147 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
2148 uint8_t num_skip_frames;
2149 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
2150 * the size of the current skipped frame that is to be packed/encrypted in bits. */
2151 uint32_t size_skip_frames;
2153 /** \brief Reserved bytes for future use, must be zero */
2154 uint32_t va_reserved[VA_PADDING_LOW];
2155 } VAEncMiscParameterSkipFrame;
2158 * \brief Encoding region-of-interest (ROI).
2160 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
2161 * supports ROI input. The ROI set through this structure is applicable only to the
2162 * current frame or field, so must be sent every frame or field to be applied. The number of
2163 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
2164 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
2166 typedef struct _VAEncROI
2168 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
2169 * codec coding units. It is relative to frame coordinates for the frame case and
2170 * to field coordinates for the field case. */
2171 VARectangle roi_rectangle;
2175 * \ref roi_value specifies ROI delta QP or ROI priority.
2176 * -- ROI delta QP is the value that will be added on top of the frame level QP.
2177 * -- ROI priority specifies the priority of a region, it can be positive (more important)
2178 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2179 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2180 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2181 * regions, the roi_value that is first in the ROI array will have priority.
2183 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2184 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2186 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2187 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2188 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2193 typedef struct _VAEncMiscParameterBufferROI {
2194 /** \brief Number of ROIs being sent.*/
2197 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2198 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
2200 int8_t max_delta_qp;
2201 int8_t min_delta_qp;
2203 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
2204 * coordinates for the frame case and to field coordinates for the field case.*/
2209 * \brief An indication for roi value.
2211 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2212 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2213 * in #VAEncROI should be used as ROI priority.
2215 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2216 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2217 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2218 * when VAConfigAttribRateControl == VA_RC_CQP.
2220 uint32_t roi_value_is_qp_delta : 1;
2221 uint32_t reserved : 31;
2226 /** \brief Reserved bytes for future use, must be zero */
2227 uint32_t va_reserved[VA_PADDING_LOW];
2228 } VAEncMiscParameterBufferROI;
2230 * \brief Dirty rectangle data structure for encoding.
2232 * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2233 * implementation supports dirty rect input. The rect set through this structure is applicable
2234 * only to the current frame or field, so must be sent every frame or field to be applied.
2235 * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect. The
2236 * encoder will use the rect information to know those rectangle areas have changed while the
2237 * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2238 * previous picture. The encoder may do some internal optimizations.
2240 typedef struct _VAEncMiscParameterBufferDirtyRect
2242 /** \brief Number of Rectangle being sent.*/
2243 uint32_t num_roi_rectangle;
2245 /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2246 VARectangle *roi_rectangle;
2247 } VAEncMiscParameterBufferDirtyRect;
2249 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2250 typedef struct _VAEncMiscParameterParallelRateControl {
2251 /** brief Number of layers*/
2252 uint32_t num_layers;
2253 /** brief Number of B frames per layer per GOP.
2255 * it should be allocated by application, and the is num_layers.
2256 * num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2257 uint32_t *num_b_in_gop;
2258 } VAEncMiscParameterParallelRateControl;
2260 /** per frame encoder quality controls, once set they will persist for all future frames
2261 *till it is updated again. */
2262 typedef struct _VAEncMiscParameterEncQuality
2268 /** Use raw frames for reference instead of reconstructed frames.
2269 * it only impact motion estimation (ME) stage, and will not impact MC stage
2270 * so the reconstruct picture will can match with decode side */
2271 uint32_t useRawPicForRef : 1;
2272 /** Disables skip check for ME stage, it will increase the bistream size
2273 * but will improve the qulity */
2274 uint32_t skipCheckDisable : 1;
2275 /** Indicates app will override default driver FTQ settings using FTQEnable.
2276 * FTQ is forward transform quantization */
2277 uint32_t FTQOverride : 1;
2278 /** Enables/disables FTQ. */
2279 uint32_t FTQEnable : 1;
2280 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2281 * enabled (FTQSkipThresholdLUT), else default driver thresholds will be used. */
2282 uint32_t FTQSkipThresholdLUTInput : 1;
2283 /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2284 * disabled (NonFTQSkipThresholdLUT), else default driver thresholds will be used. */
2285 uint32_t NonFTQSkipThresholdLUTInput : 1;
2286 uint32_t ReservedBit : 1;
2287 /** Control to enable the ME mode decision algorithm to bias to fewer B Direct/Skip types.
2288 * Applies only to B frames, all other frames will ignore this setting. */
2289 uint32_t directBiasAdjustmentEnable : 1;
2290 /** Enables global motion bias. global motion also is called HME (Heirarchical Motion Estimation )
2291 * HME is used to handle large motions and avoiding local minima in the video encoding process
2292 * down scaled the input and reference picture, then do ME. the result will be a predictor to next level HME or ME
2293 * current interface divide the HME to 3 level. UltraHME , SuperHME, and HME, result of UltraHME will be input of SurperHME,
2294 * result of superHME will be a input for HME. HME result will be input of ME. it is a switch for HMEMVCostScalingFactor
2295 * can change the HME bias inside RDO stage*/
2296 uint32_t globalMotionBiasAdjustmentEnable : 1;
2297 /** MV cost scaling ratio for HME ( predictors. It is used when
2298 * globalMotionBiasAdjustmentEnable == 1, else it is ignored. Values are:
2299 * 0: set MV cost to be 0 for HME predictor.
2300 * 1: scale MV cost to be 1/2 of the default value for HME predictor.
2301 * 2: scale MV cost to be 1/4 of the default value for HME predictor.
2302 * 3: scale MV cost to be 1/8 of the default value for HME predictor. */
2303 uint32_t HMEMVCostScalingFactor : 2;
2304 /**disable HME, if it is disabled. Super*ultraHME should also be disabled */
2305 uint32_t HMEDisable : 1;
2306 /**disable Super HME, if it is disabled, ultraHME should be disabled */
2307 uint32_t SuperHMEDisable : 1;
2308 /** disable Ultra HME */
2309 uint32_t UltraHMEDisable : 1;
2310 /** disable panic mode. Panic mode happened when there are extreme BRC (bit rate control) requirement
2311 * frame size cant achieve the target of BRC. when Panic mode is triggered, Coefficients will
2312 * be set to zero. disable panic mode will improve quality but will impact BRC */
2313 uint32_t PanicModeDisable : 1;
2314 /** Force RepartitionCheck
2315 * 0: DEFAULT - follow driver default settings.
2316 * 1: FORCE_ENABLE - enable this feature totally for all cases.
2317 * 2: FORCE_DISABLE - disable this feature totally for all cases. */
2318 uint32_t ForceRepartitionCheck : 2;
2321 uint32_t encControls;
2324 /** Maps QP to skip thresholds when FTQ is enabled. Valid range is 0-255. */
2325 uint8_t FTQSkipThresholdLUT[52];
2326 /** Maps QP to skip thresholds when FTQ is disabled. Valid range is 0-65535. */
2327 uint16_t NonFTQSkipThresholdLUT[52];
2329 uint32_t reserved[VA_PADDING_HIGH]; // Reserved for future use.
2331 } VAEncMiscParameterEncQuality;
2334 * \brief Custom Encoder Rounding Offset Control.
2335 * Application may use this structure to set customized rounding
2336 * offset parameters for quantization.
2337 * Valid when \c VAConfigAttribCustomRoundingControl equals 1.
2339 typedef struct _VAEncMiscParameterCustomRoundingControl
2343 /** \brief Enable customized rounding offset for intra blocks.
2344 * If 0, default value would be taken by driver for intra
2347 uint32_t enable_custom_rouding_intra : 1 ;
2349 /** \brief Intra rounding offset
2350 * Ignored if \c enable_custom_rouding_intra equals 0.
2352 uint32_t rounding_offset_intra : 7;
2354 /** \brief Enable customized rounding offset for inter blocks.
2355 * If 0, default value would be taken by driver for inter
2358 uint32_t enable_custom_rounding_inter : 1 ;
2360 /** \brief Inter rounding offset
2361 * Ignored if \c enable_custom_rouding_inter equals 0.
2363 uint32_t rounding_offset_inter : 7;
2366 uint32_t reserved :16;
2369 } rounding_offset_setting;
2370 } VAEncMiscParameterCustomRoundingControl;
2372 * There will be cases where the bitstream buffer will not have enough room to hold
2373 * the data for the entire slice, and the following flags will be used in the slice
2374 * parameter to signal to the server for the possible cases.
2375 * If a slice parameter buffer and slice data buffer pair is sent to the server with
2376 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
2377 * then a slice parameter and data buffer needs to be sent again to complete this slice.
2379 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
2380 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
2381 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
2382 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
2384 /* Codec-independent Slice Parameter Buffer base */
2385 typedef struct _VASliceParameterBufferBase
2387 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
2388 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2389 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
2390 } VASliceParameterBufferBase;
2392 /**********************************
2393 * JPEG common data structures
2394 **********************************/
2396 * \brief Huffman table for JPEG decoding.
2398 * This structure holds the complete Huffman tables. This is an
2399 * aggregation of all Huffman table (DHT) segments maintained by the
2400 * application. i.e. up to 2 Huffman tables are stored in there for
2403 * The #load_huffman_table array can be used as a hint to notify the
2404 * VA driver implementation about which table(s) actually changed
2405 * since the last submission of this buffer.
2407 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2408 /** \brief Specifies which #huffman_table is valid. */
2409 uint8_t load_huffman_table[2];
2410 /** \brief Huffman tables indexed by table identifier (Th). */
2412 /** @name DC table (up to 12 categories) */
2414 /** \brief Number of Huffman codes of length i + 1 (Li). */
2415 uint8_t num_dc_codes[16];
2416 /** \brief Value associated with each Huffman code (Vij). */
2417 uint8_t dc_values[12];
2419 /** @name AC table (2 special codes + up to 16 * 10 codes) */
2421 /** \brief Number of Huffman codes of length i + 1 (Li). */
2422 uint8_t num_ac_codes[16];
2423 /** \brief Value associated with each Huffman code (Vij). */
2424 uint8_t ac_values[162];
2425 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2430 /** \brief Reserved bytes for future use, must be zero */
2431 uint32_t va_reserved[VA_PADDING_LOW];
2432 } VAHuffmanTableBufferJPEGBaseline;
2434 /****************************
2435 * MPEG-2 data structures
2436 ****************************/
2438 /* MPEG-2 Picture Parameter Buffer */
2440 * For each frame or field, and before any slice data, a single
2441 * picture parameter buffer must be send.
2443 typedef struct _VAPictureParameterBufferMPEG2
2445 uint16_t horizontal_size;
2446 uint16_t vertical_size;
2447 VASurfaceID forward_reference_picture;
2448 VASurfaceID backward_reference_picture;
2449 /* meanings of the following fields are the same as in the standard */
2450 int32_t picture_coding_type;
2451 int32_t f_code; /* pack all four fcode into this */
2454 uint32_t intra_dc_precision : 2;
2455 uint32_t picture_structure : 2;
2456 uint32_t top_field_first : 1;
2457 uint32_t frame_pred_frame_dct : 1;
2458 uint32_t concealment_motion_vectors : 1;
2459 uint32_t q_scale_type : 1;
2460 uint32_t intra_vlc_format : 1;
2461 uint32_t alternate_scan : 1;
2462 uint32_t repeat_first_field : 1;
2463 uint32_t progressive_frame : 1;
2464 uint32_t is_first_field : 1; /* indicate whether the current field
2465 * is the first field for field picture
2469 } picture_coding_extension;
2471 /** \brief Reserved bytes for future use, must be zero */
2472 uint32_t va_reserved[VA_PADDING_LOW];
2473 } VAPictureParameterBufferMPEG2;
2475 /** MPEG-2 Inverse Quantization Matrix Buffer */
2476 typedef struct _VAIQMatrixBufferMPEG2
2478 /** \brief Same as the MPEG-2 bitstream syntax element. */
2479 int32_t load_intra_quantiser_matrix;
2480 /** \brief Same as the MPEG-2 bitstream syntax element. */
2481 int32_t load_non_intra_quantiser_matrix;
2482 /** \brief Same as the MPEG-2 bitstream syntax element. */
2483 int32_t load_chroma_intra_quantiser_matrix;
2484 /** \brief Same as the MPEG-2 bitstream syntax element. */
2485 int32_t load_chroma_non_intra_quantiser_matrix;
2486 /** \brief Luminance intra matrix, in zig-zag scan order. */
2487 uint8_t intra_quantiser_matrix[64];
2488 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2489 uint8_t non_intra_quantiser_matrix[64];
2490 /** \brief Chroma intra matrix, in zig-zag scan order. */
2491 uint8_t chroma_intra_quantiser_matrix[64];
2492 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2493 uint8_t chroma_non_intra_quantiser_matrix[64];
2495 /** \brief Reserved bytes for future use, must be zero */
2496 uint32_t va_reserved[VA_PADDING_LOW];
2497 } VAIQMatrixBufferMPEG2;
2499 /** MPEG-2 Slice Parameter Buffer */
2500 typedef struct _VASliceParameterBufferMPEG2
2502 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2503 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2504 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2505 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2506 uint32_t slice_horizontal_position;
2507 uint32_t slice_vertical_position;
2508 int32_t quantiser_scale_code;
2509 int32_t intra_slice_flag;
2511 /** \brief Reserved bytes for future use, must be zero */
2512 uint32_t va_reserved[VA_PADDING_LOW];
2513 } VASliceParameterBufferMPEG2;
2515 /** MPEG-2 Macroblock Parameter Buffer */
2516 typedef struct _VAMacroblockParameterBufferMPEG2
2518 uint16_t macroblock_address;
2520 * macroblock_address (in raster scan order)
2522 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2524 uint8_t macroblock_type; /* see definition below */
2527 uint32_t frame_motion_type : 2;
2528 uint32_t field_motion_type : 2;
2529 uint32_t dct_type : 1;
2533 uint8_t motion_vertical_field_select;
2535 * motion_vertical_field_select:
2536 * see section 6.3.17.2 in the spec
2537 * only the lower 4 bits are used
2538 * bit 0: first vector forward
2539 * bit 1: first vector backward
2540 * bit 2: second vector forward
2541 * bit 3: second vector backward
2543 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2544 uint16_t coded_block_pattern;
2546 * The bitplanes for coded_block_pattern are described
2547 * in Figure 6.10-12 in the spec
2550 /* Number of skipped macroblocks after this macroblock */
2551 uint16_t num_skipped_macroblocks;
2553 /** \brief Reserved bytes for future use, must be zero */
2554 uint32_t va_reserved[VA_PADDING_LOW];
2555 } VAMacroblockParameterBufferMPEG2;
2558 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2560 #define VA_MB_TYPE_MOTION_FORWARD 0x02
2561 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
2562 #define VA_MB_TYPE_MOTION_PATTERN 0x08
2563 #define VA_MB_TYPE_MOTION_INTRA 0x10
2566 * MPEG-2 Residual Data Buffer
2567 * For each macroblock, there wil be 64 shorts (16-bit) in the
2568 * residual data buffer
2571 /****************************
2572 * MPEG-4 Part 2 data structures
2573 ****************************/
2575 /* MPEG-4 Picture Parameter Buffer */
2577 * For each frame or field, and before any slice data, a single
2578 * picture parameter buffer must be send.
2580 typedef struct _VAPictureParameterBufferMPEG4
2583 uint16_t vop_height;
2584 VASurfaceID forward_reference_picture;
2585 VASurfaceID backward_reference_picture;
2588 uint32_t short_video_header : 1;
2589 uint32_t chroma_format : 2;
2590 uint32_t interlaced : 1;
2591 uint32_t obmc_disable : 1;
2592 uint32_t sprite_enable : 2;
2593 uint32_t sprite_warping_accuracy : 2;
2594 uint32_t quant_type : 1;
2595 uint32_t quarter_sample : 1;
2596 uint32_t data_partitioned : 1;
2597 uint32_t reversible_vlc : 1;
2598 uint32_t resync_marker_disable : 1;
2602 uint8_t no_of_sprite_warping_points;
2603 int16_t sprite_trajectory_du[3];
2604 int16_t sprite_trajectory_dv[3];
2605 uint8_t quant_precision;
2608 uint32_t vop_coding_type : 2;
2609 uint32_t backward_reference_vop_coding_type : 2;
2610 uint32_t vop_rounding_type : 1;
2611 uint32_t intra_dc_vlc_thr : 3;
2612 uint32_t top_field_first : 1;
2613 uint32_t alternate_vertical_scan_flag : 1;
2617 uint8_t vop_fcode_forward;
2618 uint8_t vop_fcode_backward;
2619 uint16_t vop_time_increment_resolution;
2620 /* short header related */
2621 uint8_t num_gobs_in_vop;
2622 uint8_t num_macroblocks_in_gob;
2623 /* for direct mode prediction */
2627 /** \brief Reserved bytes for future use, must be zero */
2628 uint32_t va_reserved[VA_PADDING_LOW];
2629 } VAPictureParameterBufferMPEG4;
2631 /** MPEG-4 Inverse Quantization Matrix Buffer */
2632 typedef struct _VAIQMatrixBufferMPEG4
2634 /** Same as the MPEG-4:2 bitstream syntax element. */
2635 int32_t load_intra_quant_mat;
2636 /** Same as the MPEG-4:2 bitstream syntax element. */
2637 int32_t load_non_intra_quant_mat;
2638 /** The matrix for intra blocks, in zig-zag scan order. */
2639 uint8_t intra_quant_mat[64];
2640 /** The matrix for non-intra blocks, in zig-zag scan order. */
2641 uint8_t non_intra_quant_mat[64];
2643 /** \brief Reserved bytes for future use, must be zero */
2644 uint32_t va_reserved[VA_PADDING_LOW];
2645 } VAIQMatrixBufferMPEG4;
2647 /** MPEG-4 Slice Parameter Buffer */
2648 typedef struct _VASliceParameterBufferMPEG4
2650 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2651 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2652 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2653 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2654 uint32_t macroblock_number;
2655 int32_t quant_scale;
2657 /** \brief Reserved bytes for future use, must be zero */
2658 uint32_t va_reserved[VA_PADDING_LOW];
2659 } VASliceParameterBufferMPEG4;
2662 VC-1 data structures
2665 typedef enum /* see 7.1.1.32 */
2668 VAMvMode1MvHalfPel = 1,
2669 VAMvMode1MvHalfPelBilinear = 2,
2670 VAMvModeMixedMv = 3,
2671 VAMvModeIntensityCompensation = 4
2674 /** VC-1 Picture Parameter Buffer */
2676 * For each picture, and before any slice data, a picture parameter
2677 * buffer must be send. Multiple picture parameter buffers may be
2678 * sent for a single picture. In that case picture parameters will
2679 * apply to all slice data that follow it until a new picture
2680 * parameter buffer is sent.
2683 * pic_quantizer_type should be set to the applicable quantizer
2684 * type as defined by QUANTIZER (J.1.19) and either
2685 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2687 typedef struct _VAPictureParameterBufferVC1
2689 VASurfaceID forward_reference_picture;
2690 VASurfaceID backward_reference_picture;
2691 /* if out-of-loop post-processing is done on the render
2692 target, then we need to keep the in-loop decoded
2693 picture as a reference picture */
2694 VASurfaceID inloop_decoded_picture;
2696 /* sequence layer for AP or meta data for SP and MP */
2699 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
2700 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
2701 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2702 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2703 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
2704 uint32_t multires : 1; /* METADATA::MULTIRES */
2705 uint32_t overlap : 1; /* METADATA::OVERLAP */
2706 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2707 uint32_t rangered : 1; /* METADATA::RANGERED */
2708 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
2709 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2714 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
2715 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2718 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2719 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2720 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2721 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2724 } entrypoint_fields;
2725 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2726 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
2729 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2730 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2731 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2732 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2735 } range_mapping_fields;
2737 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2738 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2739 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
2740 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2741 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
2742 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
2743 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
2744 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
2745 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
2749 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
2750 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
2751 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
2752 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
2753 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
2759 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2760 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
2761 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
2762 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
2763 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
2764 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
2765 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
2771 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
2772 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
2773 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
2774 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
2775 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
2776 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
2777 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
2780 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2783 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2784 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2785 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2786 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
2792 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
2793 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
2794 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2795 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2796 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
2797 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2798 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2799 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
2800 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2801 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2807 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
2808 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
2809 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
2810 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2811 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2812 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
2813 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
2814 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
2815 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
2816 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
2817 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2820 } pic_quantizer_fields;
2823 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2824 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
2825 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2826 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
2827 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2828 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
2833 uint8_t luma_scale2; /* PICTURE_LAYER::LUMSCALE2 */
2834 uint8_t luma_shift2; /* PICTURE_LAYER::LUMSHIFT2 */
2835 uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2837 /** \brief Reserved bytes for future use, must be zero */
2838 uint32_t va_reserved[VA_PADDING_MEDIUM - 1];
2839 } VAPictureParameterBufferVC1;
2841 /** VC-1 Bitplane Buffer
2842 There will be at most three bitplanes coded in any picture header. To send
2843 the bitplane data more efficiently, each byte is divided in two nibbles, with
2844 each nibble carrying three bitplanes for one macroblock. The following table
2845 shows the bitplane data arrangement within each nibble based on the picture
2848 Picture Type Bit3 Bit2 Bit1 Bit0
2849 I or BI OVERFLAGS ACPRED FIELDTX
2850 P MYTYPEMB SKIPMB DIRECTMB
2851 B FORWARDMB SKIPMB DIRECTMB
2853 Within each byte, the lower nibble is for the first MB and the upper nibble is
2854 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2855 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2856 Macroblock #2 in the first row.
2859 /* VC-1 Slice Parameter Buffer */
2860 typedef struct _VASliceParameterBufferVC1
2862 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2863 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2864 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2865 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2866 uint32_t slice_vertical_position;
2868 /** \brief Reserved bytes for future use, must be zero */
2869 uint32_t va_reserved[VA_PADDING_LOW];
2870 } VASliceParameterBufferVC1;
2872 /* VC-1 Slice Data Buffer */
2874 This is simplely a buffer containing raw bit-stream bytes
2877 /****************************
2878 * H.264/AVC data structures
2879 ****************************/
2881 typedef struct _VAPictureH264
2883 VASurfaceID picture_id;
2886 int32_t TopFieldOrderCnt;
2887 int32_t BottomFieldOrderCnt;
2889 /** \brief Reserved bytes for future use, must be zero */
2890 uint32_t va_reserved[VA_PADDING_LOW];
2892 /* flags in VAPictureH264 could be OR of the following */
2893 #define VA_PICTURE_H264_INVALID 0x00000001
2894 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2895 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2896 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2897 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2899 /** H.264 Picture Parameter Buffer */
2901 * For each picture, and before any slice data, a single
2902 * picture parameter buffer must be send.
2904 typedef struct _VAPictureParameterBufferH264
2906 VAPictureH264 CurrPic;
2907 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2908 uint16_t picture_width_in_mbs_minus1;
2909 uint16_t picture_height_in_mbs_minus1;
2910 uint8_t bit_depth_luma_minus8;
2911 uint8_t bit_depth_chroma_minus8;
2912 uint8_t num_ref_frames;
2915 uint32_t chroma_format_idc : 2;
2916 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2917 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2918 uint32_t frame_mbs_only_flag : 1;
2919 uint32_t mb_adaptive_frame_field_flag : 1;
2920 uint32_t direct_8x8_inference_flag : 1;
2921 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2922 uint32_t log2_max_frame_num_minus4 : 4;
2923 uint32_t pic_order_cnt_type : 2;
2924 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2925 uint32_t delta_pic_order_always_zero_flag : 1;
2929 // FMO is not supported.
2930 va_deprecated uint8_t num_slice_groups_minus1;
2931 va_deprecated uint8_t slice_group_map_type;
2932 va_deprecated uint16_t slice_group_change_rate_minus1;
2933 int8_t pic_init_qp_minus26;
2934 int8_t pic_init_qs_minus26;
2935 int8_t chroma_qp_index_offset;
2936 int8_t second_chroma_qp_index_offset;
2939 uint32_t entropy_coding_mode_flag : 1;
2940 uint32_t weighted_pred_flag : 1;
2941 uint32_t weighted_bipred_idc : 2;
2942 uint32_t transform_8x8_mode_flag : 1;
2943 uint32_t field_pic_flag : 1;
2944 uint32_t constrained_intra_pred_flag : 1;
2945 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2946 uint32_t deblocking_filter_control_present_flag : 1;
2947 uint32_t redundant_pic_cnt_present_flag : 1;
2948 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2954 /** \brief Reserved bytes for future use, must be zero */
2955 uint32_t va_reserved[VA_PADDING_MEDIUM];
2956 } VAPictureParameterBufferH264;
2958 /** H.264 Inverse Quantization Matrix Buffer */
2959 typedef struct _VAIQMatrixBufferH264
2961 /** \brief 4x4 scaling list, in raster scan order. */
2962 uint8_t ScalingList4x4[6][16];
2963 /** \brief 8x8 scaling list, in raster scan order. */
2964 uint8_t ScalingList8x8[2][64];
2966 /** \brief Reserved bytes for future use, must be zero */
2967 uint32_t va_reserved[VA_PADDING_LOW];
2968 } VAIQMatrixBufferH264;
2970 /** H.264 Slice Parameter Buffer */
2971 typedef struct _VASliceParameterBufferH264
2973 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2974 /** \brief Byte offset to the NAL Header Unit for this slice. */
2975 uint32_t slice_data_offset;
2976 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2978 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2980 * This bit offset is relative to and includes the NAL unit byte
2981 * and represents the number of bits parsed in the slice_header()
2982 * after the removal of any emulation prevention bytes in
2983 * there. However, the slice data buffer passed to the hardware is
2984 * the original bitstream, thus including any emulation prevention
2987 uint16_t slice_data_bit_offset;
2988 uint16_t first_mb_in_slice;
2990 uint8_t direct_spatial_mv_pred_flag;
2992 * H264/AVC syntax element
2994 * if num_ref_idx_active_override_flag equals 0, host decoder should
2995 * set its value to num_ref_idx_l0_default_active_minus1.
2997 uint8_t num_ref_idx_l0_active_minus1;
2999 * H264/AVC syntax element
3001 * if num_ref_idx_active_override_flag equals 0, host decoder should
3002 * set its value to num_ref_idx_l1_default_active_minus1.
3004 uint8_t num_ref_idx_l1_active_minus1;
3005 uint8_t cabac_init_idc;
3006 int8_t slice_qp_delta;
3007 uint8_t disable_deblocking_filter_idc;
3008 int8_t slice_alpha_c0_offset_div2;
3009 int8_t slice_beta_offset_div2;
3010 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
3011 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
3012 uint8_t luma_log2_weight_denom;
3013 uint8_t chroma_log2_weight_denom;
3014 uint8_t luma_weight_l0_flag;
3015 int16_t luma_weight_l0[32];
3016 int16_t luma_offset_l0[32];
3017 uint8_t chroma_weight_l0_flag;
3018 int16_t chroma_weight_l0[32][2];
3019 int16_t chroma_offset_l0[32][2];
3020 uint8_t luma_weight_l1_flag;
3021 int16_t luma_weight_l1[32];
3022 int16_t luma_offset_l1[32];
3023 uint8_t chroma_weight_l1_flag;
3024 int16_t chroma_weight_l1[32][2];
3025 int16_t chroma_offset_l1[32][2];
3027 /** \brief Reserved bytes for future use, must be zero */
3028 uint32_t va_reserved[VA_PADDING_LOW];
3029 } VASliceParameterBufferH264;
3031 /****************************
3032 * Common encode data structures
3033 ****************************/
3036 VAEncPictureTypeIntra = 0,
3037 VAEncPictureTypePredictive = 1,
3038 VAEncPictureTypeBidirectional = 2,
3042 * \brief Encode Slice Parameter Buffer.
3045 * This is a deprecated encode slice parameter buffer, All applications
3046 * \c can use VAEncSliceParameterBufferXXX (XXX = MPEG2, HEVC, H264, JPEG)
3048 typedef struct _VAEncSliceParameterBuffer
3050 uint32_t start_row_number; /* starting MB row number for this slice */
3051 uint32_t slice_height; /* slice height measured in MB */
3054 uint32_t is_intra : 1;
3055 uint32_t disable_deblocking_filter_idc : 2;
3056 uint32_t uses_long_term_ref :1;
3057 uint32_t is_long_term_ref :1;
3062 /** \brief Reserved bytes for future use, must be zero */
3063 uint32_t va_reserved[VA_PADDING_LOW];
3064 } VAEncSliceParameterBuffer;
3067 /****************************
3068 * H.263 specific encode data structures
3069 ****************************/
3071 typedef struct _VAEncSequenceParameterBufferH263
3073 uint32_t intra_period;
3074 uint32_t bits_per_second;
3075 uint32_t frame_rate;
3076 uint32_t initial_qp;
3079 /** \brief Reserved bytes for future use, must be zero */
3080 uint32_t va_reserved[VA_PADDING_LOW];
3081 } VAEncSequenceParameterBufferH263;
3083 typedef struct _VAEncPictureParameterBufferH263
3085 VASurfaceID reference_picture;
3086 VASurfaceID reconstructed_picture;
3087 VABufferID coded_buf;
3088 uint16_t picture_width;
3089 uint16_t picture_height;
3090 VAEncPictureType picture_type;
3092 /** \brief Reserved bytes for future use, must be zero */
3093 uint32_t va_reserved[VA_PADDING_LOW];
3094 } VAEncPictureParameterBufferH263;
3096 /****************************
3097 * MPEG-4 specific encode data structures
3098 ****************************/
3100 typedef struct _VAEncSequenceParameterBufferMPEG4
3102 uint8_t profile_and_level_indication;
3103 uint32_t intra_period;
3104 uint32_t video_object_layer_width;
3105 uint32_t video_object_layer_height;
3106 uint32_t vop_time_increment_resolution;
3107 uint32_t fixed_vop_rate;
3108 uint32_t fixed_vop_time_increment;
3109 uint32_t bits_per_second;
3110 uint32_t frame_rate;
3111 uint32_t initial_qp;
3114 /** \brief Reserved bytes for future use, must be zero */
3115 uint32_t va_reserved[VA_PADDING_LOW];
3116 } VAEncSequenceParameterBufferMPEG4;
3118 typedef struct _VAEncPictureParameterBufferMPEG4
3120 VASurfaceID reference_picture;
3121 VASurfaceID reconstructed_picture;
3122 VABufferID coded_buf;
3123 uint16_t picture_width;
3124 uint16_t picture_height;
3125 uint32_t modulo_time_base; /* number of 1s */
3126 uint32_t vop_time_increment;
3127 VAEncPictureType picture_type;
3129 /** \brief Reserved bytes for future use, must be zero */
3130 uint32_t va_reserved[VA_PADDING_LOW];
3131 } VAEncPictureParameterBufferMPEG4;
3135 /** Buffer functions */
3138 * Creates a buffer for "num_elements" elements of "size" bytes and
3139 * initalize with "data".
3140 * if "data" is null, then the contents of the buffer data store
3142 * Basically there are two ways to get buffer data to the server side. One is
3143 * to call vaCreateBuffer() with a non-null "data", which results the data being
3144 * copied to the data store on the server side. A different method that
3145 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
3146 * and then use vaMapBuffer() to map the data store from the server side to the
3147 * client address space for access.
3148 * The user must call vaDestroyBuffer() to destroy a buffer.
3149 * Note: image buffers are created by the library, not the client. Please see
3150 * vaCreateImage on how image buffers are managed.
3152 VAStatus vaCreateBuffer (
3154 VAContextID context,
3155 VABufferType type, /* in */
3156 unsigned int size, /* in */
3157 unsigned int num_elements, /* in */
3158 void *data, /* in */
3159 VABufferID *buf_id /* out */
3163 * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
3164 * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
3165 * can call vaMapBuffer with this Buffer ID to get virtual address.
3166 * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
3167 * maybe it should align with 256, and one byte present one Qp.so, call the function.
3168 * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
3169 * then read write the memory like 2D. the size is 256x68, application can only use 120x68
3170 * pBuf + 256 is the start of next line.
3171 * different driver implementation maybe return different unit_size and pitch
3173 VAStatus vaCreateBuffer2(
3175 VAContextID context,
3178 unsigned int height,
3179 unsigned int *unit_size,
3180 unsigned int *pitch,
3185 * Convey to the server how many valid elements are in the buffer.
3186 * e.g. if multiple slice parameters are being held in a single buffer,
3187 * this will communicate to the server the number of slice parameters
3188 * that are valid in the buffer.
3190 VAStatus vaBufferSetNumElements (
3192 VABufferID buf_id, /* in */
3193 unsigned int num_elements /* in */
3198 * device independent data structure for codedbuffer
3202 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
3203 * LARGE_SLICE(bit8):At least one slice in the current frame was large
3204 * enough for the encoder to attempt to limit its size.
3205 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
3206 * exceeded the maximum slice size specified.
3207 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
3208 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
3209 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
3211 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
3212 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
3213 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
3214 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
3215 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
3217 * \brief The frame has exceeded the maximum requested size.
3219 * This flag indicates that the encoded frame size exceeds the value
3220 * specified through a misc parameter buffer of type
3221 * #VAEncMiscParameterTypeMaxFrameSize.
3223 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
3225 * \brief the bitstream is bad or corrupt.
3227 #define VA_CODED_BUF_STATUS_BAD_BITSTREAM 0x8000
3228 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
3231 * \brief The coded buffer segment status contains frame encoding passes number
3233 * This is the mask to get the number of encoding passes from the coded
3234 * buffer segment status.
3235 * NUMBER_PASS(bit24~bit27): the number for encoding passes executed for the coded frame.
3238 #define VA_CODED_BUF_STATUS_NUMBER_PASSES_MASK 0xf000000
3241 * \brief The coded buffer segment contains a single NAL unit.
3243 * This flag indicates that the coded buffer segment contains a
3244 * single NAL unit. This flag might be useful to the user for
3245 * processing the coded buffer.
3247 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
3250 * \brief Coded buffer segment.
3252 * #VACodedBufferSegment is an element of a linked list describing
3253 * some information on the coded buffer. The coded buffer segment
3254 * could contain either a single NAL unit, or more than one NAL unit.
3255 * It is recommended (but not required) to return a single NAL unit
3256 * in a coded buffer segment, and the implementation should set the
3257 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
3259 typedef struct _VACodedBufferSegment {
3261 * \brief Size of the data buffer in this segment (in bytes).
3264 /** \brief Bit offset into the data buffer where the video data starts. */
3265 uint32_t bit_offset;
3266 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
3268 /** \brief Reserved for future use. */
3270 /** \brief Pointer to the start of the data buffer. */
3273 * \brief Pointer to the next #VACodedBufferSegment element,
3274 * or \c NULL if there is none.
3278 /** \brief Reserved bytes for future use, must be zero */
3279 uint32_t va_reserved[VA_PADDING_LOW];
3280 } VACodedBufferSegment;
3283 * Map data store of the buffer into the client's address space
3284 * vaCreateBuffer() needs to be called with "data" set to NULL before
3285 * calling vaMapBuffer()
3287 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
3288 * VACodedBufferSegment, and the list is terminated if "next" is NULL
3290 VAStatus vaMapBuffer (
3292 VABufferID buf_id, /* in */
3293 void **pbuf /* out */
3297 * After client making changes to a mapped data store, it needs to
3298 * "Unmap" it to let the server know that the data is ready to be
3299 * consumed by the server
3301 VAStatus vaUnmapBuffer (
3303 VABufferID buf_id /* in */
3307 * After this call, the buffer is deleted and this buffer_id is no longer valid
3309 * A buffer can be re-used and sent to the server by another Begin/Render/End
3310 * sequence if vaDestroyBuffer() is not called with this buffer.
3312 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3313 * hardware accelerator can result in performance dropping.
3315 VAStatus vaDestroyBuffer (
3317 VABufferID buffer_id
3320 /** \brief VA buffer information */
3322 /** \brief Buffer handle */
3324 /** \brief Buffer type (See \ref VABufferType). */
3327 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3329 * On input to vaAcquireBufferHandle(), this field can serve as a hint
3330 * to specify the set of memory types the caller is interested in.
3331 * On successful return from vaAcquireBufferHandle(), the field is
3332 * updated with the best matching memory type.
3335 /** \brief Size of the underlying buffer. */
3338 /** \brief Reserved bytes for future use, must be zero */
3339 uint32_t va_reserved[VA_PADDING_LOW];
3343 * \brief Acquires buffer handle for external API usage
3345 * Locks the VA buffer object \ref buf_id for external API usage like
3346 * EGL or OpenCL (OCL). This function is a synchronization point. This
3347 * means that any pending operation is guaranteed to be completed
3348 * prior to returning from the function.
3350 * If the referenced VA buffer object is the backing store of a VA
3351 * surface, then this function acts as if vaSyncSurface() on the
3352 * parent surface was called first.
3354 * The \ref VABufferInfo argument shall be zero'ed on input. On
3355 * successful output, the data structure is filled in with all the
3356 * necessary buffer level implementation details like handle, type,
3357 * memory type and memory size.
3359 * Note: the external API implementation, or the application, can
3360 * express the memory types it is interested in by filling in the \ref
3361 * mem_type field accordingly. On successful output, the memory type
3362 * that fits best the request and that was used is updated in the \ref
3363 * VABufferInfo data structure. If none of the supplied memory types
3364 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3365 * error is returned.
3367 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3368 * is called. Besides, no additional operation is allowed on any of
3369 * the buffer parent object until vaReleaseBufferHandle() is called.
3370 * e.g. decoding into a VA surface backed with the supplied VA buffer
3371 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3375 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3376 * does not support this interface
3377 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3378 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3379 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3380 * does not support exporting buffers of the specified type
3381 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3382 * memory types in \ref VABufferInfo.mem_type was supported
3384 * @param[in] dpy the VA display
3385 * @param[in] buf_id the VA buffer
3386 * @param[in,out] buf_info the associated VA buffer information
3387 * @return VA_STATUS_SUCCESS if successful
3390 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3393 * \brief Releases buffer after usage from external API
3395 * Unlocks the VA buffer object \ref buf_id from external API usage like
3396 * EGL or OpenCL (OCL). This function is a synchronization point. This
3397 * means that any pending operation is guaranteed to be completed
3398 * prior to returning from the function.
3400 * The \ref VABufferInfo argument shall point to the original data
3401 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3402 * This is necessary so that the VA driver implementation could
3403 * deallocate any resources that were needed.
3405 * In any case, returning from this function invalidates any contents
3406 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3407 * valid. Therefore, VA driver implementations are free to reset this
3408 * data structure to safe defaults.
3411 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3412 * does not support this interface
3413 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3414 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3415 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3416 * does not support exporting buffers of the specified type
3418 * @param[in] dpy the VA display
3419 * @param[in] buf_id the VA buffer
3420 * @return VA_STATUS_SUCCESS if successful
3423 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3425 /** @name vaExportSurfaceHandle() flags
3429 /** Export surface to be read by external API. */
3430 #define VA_EXPORT_SURFACE_READ_ONLY 0x0001
3431 /** Export surface to be written by external API. */
3432 #define VA_EXPORT_SURFACE_WRITE_ONLY 0x0002
3433 /** Export surface to be both read and written by external API. */
3434 #define VA_EXPORT_SURFACE_READ_WRITE 0x0003
3435 /** Export surface with separate layers.
3437 * For example, NV12 surfaces should be exported as two separate
3438 * planes for luma and chroma.
3440 #define VA_EXPORT_SURFACE_SEPARATE_LAYERS 0x0004
3441 /** Export surface with composed layers.
3443 * For example, NV12 surfaces should be exported as a single NV12
3446 #define VA_EXPORT_SURFACE_COMPOSED_LAYERS 0x0008
3451 * \brief Export a handle to a surface for use with an external API
3453 * The exported handles are owned by the caller, and the caller is
3454 * responsible for freeing them when no longer needed (e.g. by closing
3455 * DRM PRIME file descriptors).
3457 * This does not perform any synchronisation. If the contents of the
3458 * surface will be read, vaSyncSurface() must be called before doing so.
3459 * If the contents of the surface are written, then all operations must
3460 * be completed externally before using the surface again by via VA-API
3463 * @param[in] dpy VA display.
3464 * @param[in] surface_id Surface to export.
3465 * @param[in] mem_type Memory type to export to.
3466 * @param[in] flags Combination of flags to apply
3467 * (VA_EXPORT_SURFACE_*).
3468 * @param[out] descriptor Pointer to the descriptor structure to fill
3469 * with the handle details. The type of this structure depends on
3470 * the value of mem_type.
3472 * @return Status code:
3473 * - VA_STATUS_SUCCESS: Success.
3474 * - VA_STATUS_ERROR_INVALID_DISPLAY: The display is not valid.
3475 * - VA_STATUS_ERROR_UNIMPLEMENTED: The driver does not implement
3477 * - VA_STATUS_ERROR_INVALID_SURFACE: The surface is not valid, or
3478 * the surface is not exportable in the specified way.
3479 * - VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: The driver does not
3480 * support exporting surfaces to the specified memory type.
3482 VAStatus vaExportSurfaceHandle(VADisplay dpy,
3483 VASurfaceID surface_id,
3484 uint32_t mem_type, uint32_t flags,
3488 * Render (Video Decode/Encode/Processing) Pictures
3490 * A picture represents either a frame or a field.
3492 * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3497 * Get ready for a video pipeline
3498 * - decode a picture to a target surface
3499 * - encode a picture from a target surface
3500 * - process a picture to a target surface
3502 VAStatus vaBeginPicture (
3504 VAContextID context,
3505 VASurfaceID render_target
3509 * Send video decode, encode or processing buffers to the server.
3511 VAStatus vaRenderPicture (
3513 VAContextID context,
3514 VABufferID *buffers,
3519 * Make the end of rendering for a picture.
3520 * The server should start processing all pending operations for this
3521 * surface. This call is non-blocking. The client can start another
3522 * Begin/Render/End sequence on a different render target.
3523 * if VAContextID used in this function previously successfully passed
3524 * vaMFAddContext call, real processing will be started during vaMFSubmit
3526 VAStatus vaEndPicture (
3532 * Make the end of rendering for a pictures in contexts passed with submission.
3533 * The server should start processing all pending operations for contexts.
3534 * All contexts passed should be associated through vaMFAddContext
3535 * and call sequence Begin/Render/End performed.
3536 * This call is non-blocking. The client can start another
3537 * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3539 * VA_STATUS_SUCCESS - operation successful, context was removed.
3540 * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3541 * due to mf_context not created or one of contexts not assotiated with mf_context
3542 * through vaAddContext.
3543 * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3544 * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3546 * mf_context: Multi-Frame context
3547 * contexts: list of contexts submitting their tasks for multi-frame operation.
3548 * num_contexts: number of passed contexts.
3550 VAStatus vaMFSubmit (
3552 VAMFContextID mf_context,
3553 VAContextID * contexts,
3564 * This function blocks until all pending operations on the render target
3565 * have been completed. Upon return it is safe to use the render target for a
3566 * different picture.
3568 VAStatus vaSyncSurface (
3570 VASurfaceID render_target
3575 VASurfaceRendering = 1, /* Rendering in progress */
3576 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
3577 /* this status is useful if surface is used as the source */
3579 VASurfaceReady = 4, /* not being rendered or displayed */
3580 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
3584 * Find out any pending ops on the render target
3586 VAStatus vaQuerySurfaceStatus (
3588 VASurfaceID render_target,
3589 VASurfaceStatus *status /* out */
3594 VADecodeSliceMissing = 0,
3595 VADecodeMBError = 1,
3596 } VADecodeErrorType;
3599 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3600 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3602 typedef struct _VASurfaceDecodeMBErrors
3604 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3605 uint32_t start_mb; /* start mb address with errors */
3606 uint32_t end_mb; /* end mb address with errors */
3607 VADecodeErrorType decode_error_type;
3608 uint32_t num_mb; /* number of mbs with errors */
3609 /** \brief Reserved bytes for future use, must be zero */
3610 uint32_t va_reserved[VA_PADDING_LOW - 1];
3611 } VASurfaceDecodeMBErrors;
3614 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3615 * it can call vaQuerySurfaceError to find out further details on the particular error.
3616 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3617 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3618 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3619 * The array is terminated if "status==-1" is detected.
3621 VAStatus vaQuerySurfaceError(
3623 VASurfaceID surface,
3624 VAStatus error_status,
3629 * Images and Subpictures
3630 * VAImage is used to either get the surface data to client memory, or
3631 * to copy image data in client memory to a surface.
3632 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
3633 * is at the upper left corner with positive X to the right and positive Y down
3635 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3636 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3637 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3639 /* Pre-defined fourcc codes. */
3641 /** NV12: two-plane 8-bit YUV 4:2:0.
3642 * The first plane contains Y, the second plane contains U and V in pairs of bytes.
3644 #define VA_FOURCC_NV12 0x3231564E
3645 /** NV21: two-plane 8-bit YUV 4:2:0.
3646 * Same as NV12, but with U and V swapped.
3648 #define VA_FOURCC_NV21 0x3132564E
3650 /** AI44: packed 4-bit YA.
3652 * The bottom half of each byte contains luma, the top half contains alpha.
3654 #define VA_FOURCC_AI44 0x34344149
3656 /** RGBA: packed 8-bit RGBA.
3658 * Four bytes per pixel: red, green, blue, alpha.
3660 #define VA_FOURCC_RGBA 0x41424752
3661 /** RGBX: packed 8-bit RGB.
3663 * Four bytes per pixel: red, green, blue, unspecified.
3665 #define VA_FOURCC_RGBX 0x58424752
3666 /** BGRA: packed 8-bit RGBA.
3668 * Four bytes per pixel: blue, green, red, alpha.
3670 #define VA_FOURCC_BGRA 0x41524742
3671 /** BGRX: packed 8-bit RGB.
3673 * Four bytes per pixel: blue, green, red, unspecified.
3675 #define VA_FOURCC_BGRX 0x58524742
3676 /** ARGB: packed 8-bit RGBA.
3678 * Four bytes per pixel: alpha, red, green, blue.
3680 #define VA_FOURCC_ARGB 0x42475241
3681 /** XRGB: packed 8-bit RGB.
3683 * Four bytes per pixel: unspecified, red, green, blue.
3685 #define VA_FOURCC_XRGB 0x42475258
3686 /** ABGR: packed 8-bit RGBA.
3688 * Four bytes per pixel: alpha, blue, green, red.
3690 #define VA_FOURCC_ABGR 0x52474241
3691 /** XBGR: packed 8-bit RGB.
3693 * Four bytes per pixel: unspecified, blue, green, red.
3695 #define VA_FOURCC_XBGR 0x52474258
3697 /** UYUV: packed 8-bit YUV 4:2:2.
3699 * Four bytes per pair of pixels: U, Y, U, V.
3701 #define VA_FOURCC_UYVY 0x59565955
3702 /** YUY2: packed 8-bit YUV 4:2:2.
3704 * Four bytes per pair of pixels: Y, U, Y, V.
3706 #define VA_FOURCC_YUY2 0x32595559
3707 /** AYUV: packed 8-bit YUVA 4:4:4.
3709 * Four bytes per pixel: A, Y, U, V.
3711 #define VA_FOURCC_AYUV 0x56555941
3712 /** NV11: two-plane 8-bit YUV 4:1:1.
3714 * The first plane contains Y, the second plane contains U and V in pairs of bytes.
3716 #define VA_FOURCC_NV11 0x3131564e
3717 /** YV12: three-plane 8-bit YUV 4:2:0.
3719 * The three planes contain Y, V and U respectively.
3721 #define VA_FOURCC_YV12 0x32315659
3722 /** P208: two-plane 8-bit YUV 4:2:2.
3724 * The first plane contains Y, the second plane contains U and V in pairs of bytes.
3726 #define VA_FOURCC_P208 0x38303250
3727 /** I420: three-plane 8-bit YUV 4:2:0.
3729 * The three planes contain Y, U and V respectively.
3731 #define VA_FOURCC_I420 0x30323449
3732 /** YV24: three-plane 8-bit YUV 4:4:4.
3734 * The three planes contain Y, V and U respectively.
3736 #define VA_FOURCC_YV24 0x34325659
3737 /** YV32: four-plane 8-bit YUVA 4:4:4
3739 * The four planes contain Y, V, U and A respectively.
3741 #define VA_FOURCC_YV32 0x32335659
3742 /** Y800: 8-bit greyscale.
3744 #define VA_FOURCC_Y800 0x30303859
3745 /** IMC3: three-plane 8-bit YUV 4:2:0.
3747 * Equivalent to YV12, but with the additional constraint that the pitch of all three planes
3750 #define VA_FOURCC_IMC3 0x33434D49
3751 /** 411P: three-plane 8-bit YUV 4:1:1.
3753 * The three planes contain Y, U and V respectively.
3755 #define VA_FOURCC_411P 0x50313134
3756 /** 411R: three-plane 8-bit YUV.
3758 * The subsampling is the transpose of 4:1:1 - full chroma appears on every fourth line.
3759 * The three planes contain Y, U and V respectively.
3761 #define VA_FOURCC_411R 0x52313134
3762 /** 422H: three-plane 8-bit YUV 4:2:2.
3764 * The three planes contain Y, U and V respectively.
3766 #define VA_FOURCC_422H 0x48323234
3767 /** 422V: three-plane 8-bit YUV 4:4:0.
3769 * The three planes contain Y, U and V respectively.
3771 #define VA_FOURCC_422V 0x56323234
3772 /** 444P: three-plane 8-bit YUV 4:4:4.
3774 * The three planes contain Y, U and V respectively.
3776 #define VA_FOURCC_444P 0x50343434
3778 /** RGBP: three-plane 8-bit RGB.
3780 * The three planes contain red, green and blue respectively.
3782 #define VA_FOURCC_RGBP 0x50424752
3783 /** BGRP: three-plane 8-bit RGB.
3785 * The three planes contain blue, green and red respectively.
3787 #define VA_FOURCC_BGRP 0x50524742
3788 /** RG16: packed 5/6-bit RGB.
3790 * Each pixel is a two-byte little-endian value.
3791 * Red, green and blue are found in bits 15:11, 10:5, 4:0 respectively.
3793 #define VA_FOURCC_RGB565 0x36314752
3794 /** BG16: packed 5/6-bit RGB.
3796 * Each pixel is a two-byte little-endian value.
3797 * Blue, green and red are found in bits 15:11, 10:5, 4:0 respectively.
3799 #define VA_FOURCC_BGR565 0x36314742
3801 /** Y210: packed 10-bit YUV 4:2:2.
3803 * Eight bytes represent a pair of pixels. Each sample is a two-byte little-endian value,
3804 * with the bottom six bits ignored. The samples are in the order Y, U, Y, V.
3806 #define VA_FOURCC_Y210 0x30313259
3807 /** Y216: packed 16-bit YUV 4:2:2.
3809 * Eight bytes represent a pair of pixels. Each sample is a two-byte little-endian value.
3810 * The samples are in the order Y, U, Y, V.
3812 #define VA_FOURCC_Y216 0x36313259
3813 /** Y410: packed 10-bit YUVA 4:4:4.
3815 * Each pixel is a four-byte little-endian value.
3816 * A, V, Y, U are found in bits 31:30, 29:20, 19:10, 9:0 respectively.
3818 #define VA_FOURCC_Y410 0x30313459
3819 /** Y416: packed 16-bit YUVA 4:4:4.
3821 * Each pixel is a set of four samples, each of which is a two-byte little-endian value.
3822 * The samples are in the order A, V, Y, U.
3824 #define VA_FOURCC_Y416 0x36313459
3826 /** YV16: three-plane 8-bit YUV 4:2:2.
3828 * The three planes contain Y, V and U respectively.
3830 #define VA_FOURCC_YV16 0x36315659
3831 /** P010: two-plane 10-bit YUV 4:2:0.
3833 * Each sample is a two-byte little-endian value with the bottom six bits ignored.
3834 * The first plane contains Y, the second plane contains U and V in pairs of samples.
3836 #define VA_FOURCC_P010 0x30313050
3837 /** P016: two-plane 16-bit YUV 4:2:0.
3839 * Each sample is a two-byte little-endian value. The first plane contains Y, the second
3840 * plane contains U and V in pairs of samples.
3842 #define VA_FOURCC_P016 0x36313050
3844 /** I010: three-plane 10-bit YUV 4:2:0.
3846 * Each sample is a two-byte little-endian value with the top six bits ignored.
3847 * The three planes contain Y, V and U respectively.
3849 #define VA_FOURCC_I010 0x30313049
3851 /** IYUV: three-plane 8-bit YUV 4:2:0.
3853 * @deprecated Use I420 instead.
3855 #define VA_FOURCC_IYUV 0x56555949
3858 #define VA_LSB_FIRST 1
3859 #define VA_MSB_FIRST 2
3861 typedef struct _VAImageFormat
3864 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3865 uint32_t bits_per_pixel;
3866 /* for RGB formats */
3867 uint32_t depth; /* significant bits per pixel */
3869 uint32_t green_mask;
3871 uint32_t alpha_mask;
3873 /** \brief Reserved bytes for future use, must be zero */
3874 uint32_t va_reserved[VA_PADDING_LOW];
3877 typedef VAGenericID VAImageID;
3879 typedef struct _VAImage
3881 VAImageID image_id; /* uniquely identify this image */
3882 VAImageFormat format;
3883 VABufferID buf; /* image data buffer */
3885 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3886 * data store on the server side for optimal performance. The buffer will be
3887 * created by the CreateImage function, and proper storage allocated based on the image
3888 * size and format. This buffer is managed by the library implementation, and
3889 * accessed by the client through the buffer Map/Unmap functions.
3894 uint32_t num_planes; /* can not be greater than 3 */
3896 * An array indicating the scanline pitch in bytes for each plane.
3897 * Each plane may have a different pitch. Maximum 3 planes for planar formats
3899 uint32_t pitches[3];
3901 * An array indicating the byte offset from the beginning of the image data
3902 * to the start of each plane.
3904 uint32_t offsets[3];
3906 /* The following fields are only needed for paletted formats */
3907 int32_t num_palette_entries; /* set to zero for non-palette images */
3909 * Each component is one byte and entry_bytes indicates the number of components in
3910 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
3912 int32_t entry_bytes;
3914 * An array of ascii characters describing the order of the components within the bytes.
3915 * Only entry_bytes characters of the string are used.
3917 int8_t component_order[4];
3919 /** \brief Reserved bytes for future use, must be zero */
3920 uint32_t va_reserved[VA_PADDING_LOW];
3923 /** Get maximum number of image formats supported by the implementation */
3924 int vaMaxNumImageFormats (
3929 * Query supported image formats
3930 * The caller must provide a "format_list" array that can hold at
3931 * least vaMaxNumImageFormats() entries. The actual number of formats
3932 * returned in "format_list" is returned in "num_formats".
3934 VAStatus vaQueryImageFormats (
3936 VAImageFormat *format_list, /* out */
3937 int *num_formats /* out */
3941 * Create a VAImage structure
3942 * The width and height fields returned in the VAImage structure may get
3943 * enlarged for some YUV formats. Upon return from this function,
3944 * image->buf has been created and proper storage allocated by the library.
3945 * The client can access the image through the Map/Unmap calls.
3947 VAStatus vaCreateImage (
3949 VAImageFormat *format,
3952 VAImage *image /* out */
3956 * Should call DestroyImage before destroying the surface it is bound to
3958 VAStatus vaDestroyImage (
3963 VAStatus vaSetImagePalette (
3967 * pointer to an array holding the palette data. The size of the array is
3968 * num_palette_entries * entry_bytes in size. The order of the components
3969 * in the palette is described by the component_order in VAImage struct
3971 unsigned char *palette
3975 * Retrive surface data into a VAImage
3976 * Image must be in a format supported by the implementation
3978 VAStatus vaGetImage (
3980 VASurfaceID surface,
3981 int x, /* coordinates of the upper left source pixel */
3983 unsigned int width, /* width and height of the region */
3984 unsigned int height,
3989 * Copy data from a VAImage to a surface
3990 * Image must be in a format supported by the implementation
3991 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3992 * shouldn't be rendered into when this is called
3994 VAStatus vaPutImage (
3996 VASurfaceID surface,
4000 unsigned int src_width,
4001 unsigned int src_height,
4004 unsigned int dest_width,
4005 unsigned int dest_height
4009 * Derive an VAImage from an existing surface.
4010 * This interface will derive a VAImage and corresponding image buffer from
4011 * an existing VA Surface. The image buffer can then be mapped/unmapped for
4012 * direct CPU access. This operation is only possible on implementations with
4013 * direct rendering capabilities and internal surface formats that can be
4014 * represented with a VAImage. When the operation is not possible this interface
4015 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
4016 * to using vaCreateImage + vaPutImage to accomplish the same task in an
4019 * Implementations should only return success when the resulting image buffer
4020 * would be useable with vaMap/Unmap.
4022 * When directly accessing a surface special care must be taken to insure
4023 * proper synchronization with the graphics hardware. Clients should call
4024 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
4025 * rendering or currently being displayed by an overlay.
4027 * Additionally nothing about the contents of a surface should be assumed
4028 * following a vaPutSurface. Implementations are free to modify the surface for
4029 * scaling or subpicture blending within a call to vaPutImage.
4031 * Calls to vaPutImage or vaGetImage using the same surface from which the image
4032 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
4033 * vaGetImage with other surfaces is supported.
4035 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
4036 * image and image buffer structures will be destroyed; however, the underlying
4037 * surface will remain unchanged until freed with vaDestroySurfaces.
4039 VAStatus vaDeriveImage (
4041 VASurfaceID surface,
4042 VAImage *image /* out */
4047 * Subpicture is a special type of image that can be blended
4048 * with a surface during vaPutSurface(). Subpicture can be used to render
4049 * DVD sub-titles or closed captioning text etc.
4052 typedef VAGenericID VASubpictureID;
4054 /** Get maximum number of subpicture formats supported by the implementation */
4055 int vaMaxNumSubpictureFormats (
4059 /** flags for subpictures */
4060 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
4061 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
4062 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
4064 * Query supported subpicture formats
4065 * The caller must provide a "format_list" array that can hold at
4066 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
4067 * for each format to indicate additional capabilities for that format. The actual
4068 * number of formats returned in "format_list" is returned in "num_formats".
4069 * flags: returned value to indicate addtional capabilities
4070 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
4071 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
4072 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
4075 VAStatus vaQuerySubpictureFormats (
4077 VAImageFormat *format_list, /* out */
4078 unsigned int *flags, /* out */
4079 unsigned int *num_formats /* out */
4083 * Subpictures are created with an image associated.
4085 VAStatus vaCreateSubpicture (
4088 VASubpictureID *subpicture /* out */
4092 * Destroy the subpicture before destroying the image it is assocated to
4094 VAStatus vaDestroySubpicture (
4096 VASubpictureID subpicture
4100 * Bind an image to the subpicture. This image will now be associated with
4101 * the subpicture instead of the one at creation.
4103 VAStatus vaSetSubpictureImage (
4105 VASubpictureID subpicture,
4110 * If chromakey is enabled, then the area where the source value falls within
4111 * the chromakey [min, max] range is transparent
4112 * The chromakey component format is the following:
4113 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
4114 * For YUV: [0:7] V [8:15] U [16:23] Y
4115 * The chromakey mask can be used to mask out certain components for chromakey
4118 VAStatus vaSetSubpictureChromakey (
4120 VASubpictureID subpicture,
4121 unsigned int chromakey_min,
4122 unsigned int chromakey_max,
4123 unsigned int chromakey_mask
4127 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
4128 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
4129 * the overall alpha is per-pixel alpha multiplied by the global alpha
4131 VAStatus vaSetSubpictureGlobalAlpha (
4133 VASubpictureID subpicture,
4138 * vaAssociateSubpicture associates the subpicture with target_surfaces.
4139 * It defines the region mapping between the subpicture and the target
4140 * surfaces through source and destination rectangles (with the same width and height).
4141 * Both will be displayed at the next call to vaPutSurface. Additional
4142 * associations before the call to vaPutSurface simply overrides the association.
4144 VAStatus vaAssociateSubpicture (
4146 VASubpictureID subpicture,
4147 VASurfaceID *target_surfaces,
4149 int16_t src_x, /* upper left offset in subpicture */
4152 uint16_t src_height,
4153 int16_t dest_x, /* upper left offset in surface */
4155 uint16_t dest_width,
4156 uint16_t dest_height,
4158 * whether to enable chroma-keying, global-alpha, or screen relative mode
4159 * see VA_SUBPICTURE_XXX values
4165 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
4167 VAStatus vaDeassociateSubpicture (
4169 VASubpictureID subpicture,
4170 VASurfaceID *target_surfaces,
4175 * Display attributes
4176 * Display attributes are used to control things such as contrast, hue, saturation,
4177 * brightness etc. in the rendering process. The application can query what
4178 * attributes are supported by the driver, and then set the appropriate attributes
4179 * before calling vaPutSurface()
4181 /* PowerVR IEP Lite attributes */
4184 VADISPLAYATTRIB_BLE_OFF = 0x00,
4185 VADISPLAYATTRIB_BLE_LOW,
4186 VADISPLAYATTRIB_BLE_MEDIUM,
4187 VADISPLAYATTRIB_BLE_HIGH,
4188 VADISPLAYATTRIB_BLE_NONE,
4189 } VADisplayAttribBLEMode;
4191 /** attribute value for VADisplayAttribRotation */
4192 #define VA_ROTATION_NONE 0x00000000
4193 #define VA_ROTATION_90 0x00000001
4194 #define VA_ROTATION_180 0x00000002
4195 #define VA_ROTATION_270 0x00000003
4199 * @name Mirroring directions
4201 * Those values could be used for VADisplayAttribMirror attribute or
4202 * VAProcPipelineParameterBuffer::mirror_state.
4206 /** \brief No Mirroring. */
4207 #define VA_MIRROR_NONE 0x00000000
4208 /** \brief Horizontal Mirroring. */
4209 #define VA_MIRROR_HORIZONTAL 0x00000001
4210 /** \brief Vertical Mirroring. */
4211 #define VA_MIRROR_VERTICAL 0x00000002
4214 /** attribute value for VADisplayAttribOutOfLoopDeblock */
4215 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
4216 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
4219 #define VA_RENDER_MODE_UNDEFINED 0
4220 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
4221 #define VA_RENDER_MODE_LOCAL_GPU 2
4222 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
4223 #define VA_RENDER_MODE_EXTERNAL_GPU 8
4225 /** Render device */
4226 #define VA_RENDER_DEVICE_UNDEFINED 0
4227 #define VA_RENDER_DEVICE_LOCAL 1
4228 #define VA_RENDER_DEVICE_EXTERNAL 2
4230 /** Currently defined display attribute types */
4233 VADisplayAttribBrightness = 0,
4234 VADisplayAttribContrast = 1,
4235 VADisplayAttribHue = 2,
4236 VADisplayAttribSaturation = 3,
4237 /* client can specifiy a background color for the target window
4238 * the new feature of video conference,
4239 * the uncovered area of the surface is filled by this color
4240 * also it will blend with the decoded video color
4242 VADisplayAttribBackgroundColor = 4,
4244 * this is a gettable only attribute. For some implementations that use the
4245 * hardware overlay, after PutSurface is called, the surface can not be
4246 * re-used until after the subsequent PutSurface call. If this is the case
4247 * then the value for this attribute will be set to 1 so that the client
4248 * will not attempt to re-use the surface right after returning from a call
4251 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
4252 * driver may use overlay or GPU alternatively
4254 VADisplayAttribDirectSurface = 5,
4255 VADisplayAttribRotation = 6,
4256 VADisplayAttribOutofLoopDeblock = 7,
4258 /* PowerVR IEP Lite specific attributes */
4259 VADisplayAttribBLEBlackMode = 8,
4260 VADisplayAttribBLEWhiteMode = 9,
4261 VADisplayAttribBlueStretch = 10,
4262 VADisplayAttribSkinColorCorrection = 11,
4264 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
4265 * conversion matrix. Each element in the matrix is float-point
4267 VADisplayAttribCSCMatrix = 12,
4268 /* specify the constant color used to blend with video surface
4269 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
4270 * d: the final color to overwrite into the frame buffer
4271 * v: decoded video after color conversion,
4272 * c: video color specified by VADisplayAttribBlendColor
4273 * b: background color of the drawable
4275 VADisplayAttribBlendColor = 13,
4277 * Indicate driver to skip painting color key or not.
4278 * only applicable if the render is overlay
4280 VADisplayAttribOverlayAutoPaintColorKey = 14,
4282 * customized overlay color key, the format is RGB888
4283 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
4285 VADisplayAttribOverlayColorKey = 15,
4287 * The hint for the implementation of vaPutSurface
4288 * normally, the driver could use an overlay or GPU to render the surface on the screen
4289 * this flag provides APP the flexibity to switch the render dynamically
4291 VADisplayAttribRenderMode = 16,
4293 * specify if vaPutSurface needs to render into specified monitors
4294 * one example is that one external monitor (e.g. HDMI) is enabled,
4295 * but the window manager is not aware of it, and there is no associated drawable
4297 VADisplayAttribRenderDevice = 17,
4299 * specify vaPutSurface render area if there is no drawable on the monitor
4301 VADisplayAttribRenderRect = 18,
4302 } VADisplayAttribType;
4304 /* flags for VADisplayAttribute */
4305 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
4306 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
4307 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
4309 typedef struct _VADisplayAttribute
4311 VADisplayAttribType type;
4314 int32_t value; /* used by the set/get attribute functions */
4315 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
4318 /** \brief Reserved bytes for future use, must be zero */
4319 uint32_t va_reserved[VA_PADDING_LOW];
4320 } VADisplayAttribute;
4322 /** Get maximum number of display attributs supported by the implementation */
4323 int vaMaxNumDisplayAttributes (
4328 * Query display attributes
4329 * The caller must provide a "attr_list" array that can hold at
4330 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
4331 * returned in "attr_list" is returned in "num_attributes".
4333 VAStatus vaQueryDisplayAttributes (
4335 VADisplayAttribute *attr_list, /* out */
4336 int *num_attributes /* out */
4340 * Get display attributes
4341 * This function returns the current attribute values in "attr_list".
4342 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
4343 * from vaQueryDisplayAttributes() can have their values retrieved.
4345 VAStatus vaGetDisplayAttributes (
4347 VADisplayAttribute *attr_list, /* in/out */
4352 * Set display attributes
4353 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
4354 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
4355 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
4357 VAStatus vaSetDisplayAttributes (
4359 VADisplayAttribute *attr_list,
4363 /****************************
4364 * HEVC data structures
4365 ****************************/
4367 * \brief Description of picture properties of those in DPB surfaces.
4369 * If only progressive scan is supported, each surface contains one whole
4371 * Otherwise, each surface contains two fields of whole picture.
4372 * In this case, two entries of ReferenceFrames[] may share same picture_id
4375 typedef struct _VAPictureHEVC
4377 /** \brief reconstructed picture buffer surface index
4378 * invalid when taking value VA_INVALID_SURFACE.
4380 VASurfaceID picture_id;
4381 /** \brief picture order count.
4382 * in HEVC, POCs for top and bottom fields of same picture should
4383 * take different values.
4385 int32_t pic_order_cnt;
4386 /* described below */
4389 /** \brief Reserved bytes for future use, must be zero */
4390 uint32_t va_reserved[VA_PADDING_LOW];
4393 /* flags in VAPictureHEVC could be OR of the following */
4394 #define VA_PICTURE_HEVC_INVALID 0x00000001
4395 /** \brief indication of interlace scan picture.
4396 * should take same value for all the pictures in sequence.
4398 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
4399 /** \brief polarity of the field picture.
4400 * top field takes even lines of buffer surface.
4401 * bottom field takes odd lines of buffer surface.
4403 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
4404 /** \brief Long term reference picture */
4405 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
4407 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
4408 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
4409 * be exclusive. No more than one of them can be set for any picture.
4410 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
4411 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
4412 * Application should provide valid values for both short format and long format.
4413 * The pictures in DPB with any of these three flags turned on are referred by
4414 * the current picture.
4416 /** \brief RefPicSetStCurrBefore of HEVC spec variable
4417 * Number of ReferenceFrames[] entries with this bit set equals
4418 * NumPocStCurrBefore.
4420 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
4421 /** \brief RefPicSetStCurrAfter of HEVC spec variable
4422 * Number of ReferenceFrames[] entries with this bit set equals
4423 * NumPocStCurrAfter.
4425 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
4426 /** \brief RefPicSetLtCurr of HEVC spec variable
4427 * Number of ReferenceFrames[] entries with this bit set equals
4430 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
4432 #include <va/va_dec_hevc.h>
4433 #include <va/va_dec_jpeg.h>
4434 #include <va/va_dec_vp8.h>
4435 #include <va/va_dec_vp9.h>
4436 #include <va/va_enc_hevc.h>
4437 #include <va/va_fei_hevc.h>
4438 #include <va/va_enc_h264.h>
4439 #include <va/va_enc_jpeg.h>
4440 #include <va/va_enc_mpeg2.h>
4441 #include <va/va_enc_vp8.h>
4442 #include <va/va_enc_vp9.h>
4443 #include <va/va_fei.h>
4444 #include <va/va_fei_h264.h>
4445 #include <va/va_vpp.h>