2 * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19 * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
20 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 * Video Acceleration (VA) API Specification
28 * <jonathan.bian@intel.com>
31 * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
32 * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
33 * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
34 * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
35 * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
36 * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
37 * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
38 * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
39 * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
40 * and MPEG-2 motion compensation.
41 * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
42 * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
43 * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
44 * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
45 * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
46 * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
47 * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
48 * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
49 * rev 0.27 (11/19/2007 Matt Sottek) - Added DeriveImage
50 * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
52 * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
53 * added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
54 * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
55 * for ISO C conformance.
56 * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
57 * Application needs to relink with the new library.
59 * rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
60 * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
61 * screen relative rather than source video relative.
62 * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
63 * update VAAPI to 0.32.0
66 * Some concepts borrowed from XvMC and XvImage.
67 * Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
68 * contributed to various aspects of the API.
75 * This file contains the \ref api_core "Core API".
83 #include <va/va_version.h>
90 #define va_deprecated __attribute__((deprecated))
92 #define va_deprecated_enum va_deprecated
94 #define va_deprecated_enum
98 #define va_deprecated_enum
102 * \mainpage Video Acceleration (VA) API
104 * \section intro Introduction
106 * The main motivation for VA-API (Video Acceleration API) is to
107 * enable hardware accelerated video decode and encode at various
108 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
109 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
110 * AVC/H.264, VC-1/VMW3, and JPEG).
112 * VA-API is split into several modules:
114 * - \ref api_enc_h264
119 * \defgroup api_core Core API
127 The VA API is intended to provide an interface between a video decode/encode/display
128 application (client) and a hardware accelerator (server), to off-load
129 video decode/encode/display operations from the host to the hardware accelerator at various
132 The basic operation steps are:
134 - Negotiate a mutually acceptable configuration with the server to lock
135 down profile, entrypoints, and other attributes that will not change on
136 a frame-by-frame basis.
137 - Create a decode context which represents a "virtualized" hardware decode
139 - Get and fill decode buffers with picture level, slice level and macroblock
140 level data (depending on entrypoints)
141 - Pass the decode buffers to the server to decode the current frame
143 Initialization & Configuration Management
145 - Find out supported profiles
146 - Find out entrypoints for a given profile
147 - Find out configuration attributes for a given profile/entrypoint pair
148 - Create a configuration for use by the decoder
152 typedef void* VADisplay; /* window system dependent */
154 typedef int VAStatus; /** Return status type from functions */
155 /** Values for the return status */
156 #define VA_STATUS_SUCCESS 0x00000000
157 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
158 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
159 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
160 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
161 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
162 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
163 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
164 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
165 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
166 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
167 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
168 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
169 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
170 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
171 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
172 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
173 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
174 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
175 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
176 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
177 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
178 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
179 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
180 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
182 * \brief An invalid/unsupported value was supplied.
184 * This is a catch-all error code for invalid or unsupported values.
185 * e.g. value exceeding the valid range, invalid type in the context
186 * of generic attribute values.
188 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
189 /** \brief An unsupported filter was supplied. */
190 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
191 /** \brief An invalid filter chain was supplied. */
192 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
193 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
194 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
195 /** \brief An unsupported memory type was supplied. */
196 #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
197 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
199 /** De-interlacing flags for vaPutSurface() */
200 #define VA_FRAME_PICTURE 0x00000000
201 #define VA_TOP_FIELD 0x00000001
202 #define VA_BOTTOM_FIELD 0x00000002
205 * Enabled the positioning/cropping/blending feature:
206 * 1, specify the video playback position in the isurface
207 * 2, specify the cropping info for video playback
208 * 3, encoded video will blend with background color
210 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
213 * Clears the drawable with background color.
214 * for hardware overlay based implementation this flag
215 * can be used to turn off the overlay
217 #define VA_CLEAR_DRAWABLE 0x00000008
219 /** Color space conversion flags for vaPutSurface() */
220 #define VA_SRC_COLOR_MASK 0x000000f0
221 #define VA_SRC_BT601 0x00000010
222 #define VA_SRC_BT709 0x00000020
223 #define VA_SRC_SMPTE_240 0x00000040
225 /** Scaling flags for vaPutSurface() */
226 #define VA_FILTER_SCALING_DEFAULT 0x00000000
227 #define VA_FILTER_SCALING_FAST 0x00000100
228 #define VA_FILTER_SCALING_HQ 0x00000200
229 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
230 #define VA_FILTER_SCALING_MASK 0x00000f00
233 * Returns a short english description of error_status
235 const char *vaErrorStr(VAStatus error_status);
237 typedef struct _VARectangle
245 /** \brief Generic motion vector data structure. */
246 typedef struct _VAMotionVector {
247 /** \mv0[0]: horizontal motion vector for past reference */
248 /** \mv0[1]: vertical motion vector for past reference */
249 /** \mv1[0]: horizontal motion vector for future reference */
250 /** \mv1[1]: vertical motion vector for future reference */
251 int16_t mv0[2]; /* past reference */
252 int16_t mv1[2]; /* future reference */
255 /** Type of a message callback, used for both error and info log. */
256 typedef void (*VAMessageCallback)(void *user_context, const char *message);
259 * Set the callback for error messages, or NULL for no logging.
260 * Returns the previous one, or NULL if it was disabled.
262 VAMessageCallback vaSetErrorCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
265 * Set the callback for info messages, or NULL for no logging.
266 * Returns the previous one, or NULL if it was disabled.
268 VAMessageCallback vaSetInfoCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
272 * A display must be obtained by calling vaGetDisplay() before calling
273 * vaInitialize() and other functions. This connects the API to the
274 * native window system.
275 * For X Windows, native_dpy would be from XOpenDisplay()
277 typedef void* VANativeDisplay; /* window system dependent */
279 int vaDisplayIsValid(VADisplay dpy);
282 * Set the override driver name instead of queried driver driver.
284 VAStatus vaSetDriverName(VADisplay dpy,
289 * Initialize the library
291 VAStatus vaInitialize (
293 int *major_version, /* out */
294 int *minor_version /* out */
298 * After this call, all library internal resources will be cleaned up
300 VAStatus vaTerminate (
305 * vaQueryVendorString returns a pointer to a zero-terminated string
306 * describing some aspects of the VA implemenation on a specific
307 * hardware accelerator. The format of the returned string is vendor
308 * specific and at the discretion of the implementer.
309 * e.g. for the Intel GMA500 implementation, an example would be:
310 * "Intel GMA500 - 2.0.0.32L.0005"
312 const char *vaQueryVendorString (
316 typedef int (*VAPrivFunc)(void);
319 * Return a function pointer given a function name in the library.
320 * This allows private interfaces into the library
322 VAPrivFunc vaGetLibFunc (
327 /** Currently defined profiles */
330 /** \brief Profile ID used for video processing. */
332 VAProfileMPEG2Simple = 0,
333 VAProfileMPEG2Main = 1,
334 VAProfileMPEG4Simple = 2,
335 VAProfileMPEG4AdvancedSimple = 3,
336 VAProfileMPEG4Main = 4,
337 VAProfileH264Baseline va_deprecated_enum = 5,
338 VAProfileH264Main = 6,
339 VAProfileH264High = 7,
340 VAProfileVC1Simple = 8,
341 VAProfileVC1Main = 9,
342 VAProfileVC1Advanced = 10,
343 VAProfileH263Baseline = 11,
344 VAProfileJPEGBaseline = 12,
345 VAProfileH264ConstrainedBaseline = 13,
346 VAProfileVP8Version0_3 = 14,
347 VAProfileH264MultiviewHigh = 15,
348 VAProfileH264StereoHigh = 16,
349 VAProfileHEVCMain = 17,
350 VAProfileHEVCMain10 = 18,
351 VAProfileVP9Profile0 = 19,
352 VAProfileVP9Profile1 = 20,
353 VAProfileVP9Profile2 = 21,
354 VAProfileVP9Profile3 = 22
358 * Currently defined entrypoints
364 VAEntrypointIDCT = 3,
365 VAEntrypointMoComp = 4,
366 VAEntrypointDeblocking = 5,
367 VAEntrypointEncSlice = 6, /* slice level encode */
368 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
370 * For an implementation that supports a low power/high performance variant
371 * for slice level encode, it can choose to expose the
372 * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
373 * available with this entrypoint (e.g. interlace, MBAFF) and the
374 * application can query the encoding configuration attributes to find
375 * out more details if this entrypoint is supported.
377 VAEntrypointEncSliceLP = 8,
378 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
380 * \brief VAEntrypointFEI
382 * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to
383 * have more controls and trade off quality for speed with their own IPs.
384 * The application can optionally provide input to ENC for extra encode control
385 * and get the output from ENC. Application can chose to modify the ENC
386 * output/PAK input during encoding, but the performance impact is significant.
388 * On top of the existing buffers for normal encode, there will be
389 * one extra input buffer (VAEncMiscParameterFEIFrameControl) and
390 * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType
391 * and VAEncFEIDistortionBufferType) for VAEntrypointFEI entry function.
392 * If separate PAK is set, two extra input buffers
393 * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input.
395 VAEntrypointFEI = 11,
398 /** Currently defined configuration attribute types */
401 VAConfigAttribRTFormat = 0,
402 VAConfigAttribSpatialResidual = 1,
403 VAConfigAttribSpatialClipping = 2,
404 VAConfigAttribIntraResidual = 3,
405 VAConfigAttribEncryption = 4,
406 VAConfigAttribRateControl = 5,
408 /** @name Attributes for decoding */
411 * \brief Slice Decoding mode. Read/write.
413 * This attribute determines what mode the driver supports for slice
414 * decoding, through vaGetConfigAttributes(); and what mode the user
415 * will be providing to the driver, through vaCreateConfig(), if the
416 * driver supports those. If this attribute is not set by the user then
417 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
419 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
421 VAConfigAttribDecSliceMode = 6,
423 /** @name Attributes for encoding */
426 * \brief Packed headers mode. Read/write.
428 * This attribute determines what packed headers the driver supports,
429 * through vaGetConfigAttributes(); and what packed headers the user
430 * will be providing to the driver, through vaCreateConfig(), if the
431 * driver supports those.
433 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
435 VAConfigAttribEncPackedHeaders = 10,
437 * \brief Interlaced mode. Read/write.
439 * This attribute determines what kind of interlaced encoding mode
440 * the driver supports.
442 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
444 VAConfigAttribEncInterlaced = 11,
446 * \brief Maximum number of reference frames. Read-only.
448 * This attribute determines the maximum number of reference
449 * frames supported for encoding.
451 * Note: for H.264 encoding, the value represents the maximum number
452 * of reference frames for both the reference picture list 0 (bottom
453 * 16 bits) and the reference picture list 1 (top 16 bits).
455 VAConfigAttribEncMaxRefFrames = 13,
457 * \brief Maximum number of slices per frame. Read-only.
459 * This attribute determines the maximum number of slices the
460 * driver can support to encode a single frame.
462 VAConfigAttribEncMaxSlices = 14,
464 * \brief Slice structure. Read-only.
466 * This attribute determines slice structures supported by the
467 * driver for encoding. This attribute is a hint to the user so
468 * that he can choose a suitable surface size and how to arrange
469 * the encoding process of multiple slices per frame.
471 * More specifically, for H.264 encoding, this attribute
472 * determines the range of accepted values to
473 * VAEncSliceParameterBufferH264::macroblock_address and
474 * VAEncSliceParameterBufferH264::num_macroblocks.
476 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
479 VAConfigAttribEncSliceStructure = 15,
481 * \brief Macroblock information. Read-only.
483 * This attribute determines whether the driver supports extra
484 * encoding information per-macroblock. e.g. QP.
486 * More specifically, for H.264 encoding, if the driver returns a non-zero
487 * value for this attribute, this means the application can create
488 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
489 * through VAEncSliceParameterBufferH264::macroblock_info.
491 VAConfigAttribEncMacroblockInfo = 16,
493 * \brief JPEG encoding attribute. Read-only.
495 * This attribute exposes a number of capabilities of the underlying
496 * JPEG implementation. The attribute value is partitioned into fields as defined in the
497 * VAConfigAttribValEncJPEG union.
499 VAConfigAttribEncJPEG = 20,
501 * \brief Encoding quality range attribute. Read-only.
503 * This attribute conveys whether the driver supports different quality level settings
504 * for encoding. A value less than or equal to 1 means that the encoder only has a single
505 * quality setting, and a value greater than 1 represents the number of quality levels
506 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
508 VAConfigAttribEncQualityRange = 21,
510 * \brief Encoding skip frame attribute. Read-only.
512 * This attribute conveys whether the driver supports sending skip frame parameters
513 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
514 * externally skipped frames.
516 VAConfigAttribEncSkipFrame = 24,
518 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
520 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
521 * based on user provided ROI rectangles. The attribute value is partitioned into fields
522 * as defined in the VAConfigAttribValEncROI union.
524 * If ROI encoding is supported, the ROI information is passed to the driver using
525 * VAEncMiscParameterTypeROI.
527 VAConfigAttribEncROI = 25,
529 * \brief Encoding extended rate control attribute. Read-only.
531 * This attribute conveys whether the driver supports any extended rate control features
532 * The attribute value is partitioned into fields as defined in the
533 * VAConfigAttribValEncRateControlExt union.
535 VAConfigAttribEncRateControlExt = 26,
538 * \brief Encode function type for FEI.
540 * This attribute conveys whether the driver supports different function types for encode.
541 * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
542 * it is for FEI entry point only.
543 * Default is VA_FEI_FUNCTION_ENC_PAK.
545 VAConfigAttribFEIFunctionType = 32,
547 * \brief Maximum number of FEI MV predictors. Read-only.
549 * This attribute determines the maximum number of MV predictors the driver
550 * can support to encode a single frame. 0 means no MV predictor is supported.
551 * Currently it is for FEI entry point only.
553 VAConfigAttribFEIMVPredictors = 33,
555 VAConfigAttribTypeMax
556 } VAConfigAttribType;
559 * Configuration attributes
560 * If there is more than one value for an attribute, a default
561 * value will be assigned to the attribute if the client does not
562 * specify the attribute when creating a configuration
564 typedef struct _VAConfigAttrib {
565 VAConfigAttribType type;
566 uint32_t value; /* OR'd flags (bits) for this attribute */
569 /** attribute value for VAConfigAttribRTFormat */
570 #define VA_RT_FORMAT_YUV420 0x00000001
571 #define VA_RT_FORMAT_YUV422 0x00000002
572 #define VA_RT_FORMAT_YUV444 0x00000004
573 #define VA_RT_FORMAT_YUV411 0x00000008
574 #define VA_RT_FORMAT_YUV400 0x00000010
575 /** YUV formats with more than 8 bpp */
576 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
578 #define VA_RT_FORMAT_RGB16 0x00010000
579 #define VA_RT_FORMAT_RGB32 0x00020000
580 /* RGBP covers RGBP and BGRP fourcc */
581 #define VA_RT_FORMAT_RGBP 0x00100000
582 #define VA_RT_FORMAT_PROTECTED 0x80000000
584 /** @name Attribute values for VAConfigAttribRateControl */
586 /** \brief Driver does not support any form of rate control. */
587 #define VA_RC_NONE 0x00000001
588 /** \brief Constant bitrate. */
589 #define VA_RC_CBR 0x00000002
590 /** \brief Variable bitrate. */
591 #define VA_RC_VBR 0x00000004
592 /** \brief Video conference mode. */
593 #define VA_RC_VCM 0x00000008
594 /** \brief Constant QP. */
595 #define VA_RC_CQP 0x00000010
596 /** \brief Variable bitrate with peak rate higher than average bitrate. */
597 #define VA_RC_VBR_CONSTRAINED 0x00000020
598 /** \brief Macroblock based rate control. Per MB control is decided
599 * internally in the encoder. It may be combined with other RC modes, except CQP. */
600 #define VA_RC_MB 0x00000080
604 /** @name Attribute values for VAConfigAttribDecSliceMode */
606 /** \brief Driver supports normal mode for slice decoding */
607 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
608 /** \brief Driver supports base mode for slice decoding */
609 #define VA_DEC_SLICE_MODE_BASE 0x00000002
612 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
614 /** \brief Driver does not support any packed headers mode. */
615 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
616 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
617 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
618 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
619 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
620 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
621 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
623 * \brief Driver supports misc packed headers. e.g. SEI for H.264.
626 * This is a deprecated packed header flag, All applications can use
627 * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
628 * header data buffer to the driver
630 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
631 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
632 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
635 /** @name Attribute values for VAConfigAttribEncInterlaced */
637 /** \brief Driver does not support interlaced coding. */
638 #define VA_ENC_INTERLACED_NONE 0x00000000
639 /** \brief Driver supports interlaced frame coding. */
640 #define VA_ENC_INTERLACED_FRAME 0x00000001
641 /** \brief Driver supports interlaced field coding. */
642 #define VA_ENC_INTERLACED_FIELD 0x00000002
643 /** \brief Driver supports macroblock adaptive frame field coding. */
644 #define VA_ENC_INTERLACED_MBAFF 0x00000004
645 /** \brief Driver supports picture adaptive frame field coding. */
646 #define VA_ENC_INTERLACED_PAFF 0x00000008
649 /** @name Attribute values for VAConfigAttribEncSliceStructure */
651 /** \brief Driver supports an arbitrary number of rows per slice. */
652 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
653 /** \brief Driver supports a power-of-two number of rows per slice. */
654 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
655 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
656 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
659 /** \brief Attribute value for VAConfigAttribEncJPEG */
660 typedef union _VAConfigAttribValEncJPEG {
662 /** \brief set to 1 for arithmatic coding. */
663 uint32_t arithmatic_coding_mode : 1;
664 /** \brief set to 1 for progressive dct. */
665 uint32_t progressive_dct_mode : 1;
666 /** \brief set to 1 for non-interleaved. */
667 uint32_t non_interleaved_mode : 1;
668 /** \brief set to 1 for differential. */
669 uint32_t differential_mode : 1;
670 uint32_t max_num_components : 3;
671 uint32_t max_num_scans : 4;
672 uint32_t max_num_huffman_tables : 3;
673 uint32_t max_num_quantization_tables : 3;
676 } VAConfigAttribValEncJPEG;
678 /** \brief Attribute value for VAConfigAttribEncROI */
679 typedef union _VAConfigAttribValEncROI {
681 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
682 uint32_t num_roi_regions : 8;
684 * \brief A flag indicates whether ROI priority is supported
686 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
687 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
688 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
689 * the underlying driver doesn't support ROI priority.
691 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
692 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
694 uint32_t roi_rc_priority_support : 1;
696 * \brief A flag indicates whether ROI delta QP is supported
698 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
699 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
700 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
701 * the underlying driver doesn't support ROI delta QP.
703 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
704 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
706 uint32_t roi_rc_qp_delta_support : 1;
707 uint32_t reserved : 22;
710 } VAConfigAttribValEncROI;
712 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
713 typedef union _VAConfigAttribValEncRateControlExt {
716 * \brief The maximum number of temporal layers minus 1
718 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
719 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
720 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
722 uint32_t max_num_temporal_layers_minus1 : 8;
725 * /brief support temporal layer bit-rate control flag
727 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
728 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
729 * #VAConfigAttribRateControl == #VA_RC_VBR).
731 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
732 * \c max_num_temporal_layers_minus1 is equal to 0
734 * To use bit-rate control per temporal layer, an application must send the right layer
735 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
736 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
737 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
738 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
739 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
740 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
741 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
743 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
744 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
745 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
747 uint32_t temporal_layer_bitrate_control_flag : 1;
748 uint32_t reserved : 23;
751 } VAConfigAttribValEncRateControlExt;
754 * if an attribute is not applicable for a given
755 * profile/entrypoint pair, then set the value to the following
757 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
759 /** Get maximum number of profiles supported by the implementation */
760 int vaMaxNumProfiles (
764 /** Get maximum number of entrypoints supported by the implementation */
765 int vaMaxNumEntrypoints (
769 /** Get maximum number of attributs supported by the implementation */
770 int vaMaxNumConfigAttributes (
775 * Query supported profiles
776 * The caller must provide a "profile_list" array that can hold at
777 * least vaMaxNumProfile() entries. The actual number of profiles
778 * returned in "profile_list" is returned in "num_profile".
780 VAStatus vaQueryConfigProfiles (
782 VAProfile *profile_list, /* out */
783 int *num_profiles /* out */
787 * Query supported entrypoints for a given profile
788 * The caller must provide an "entrypoint_list" array that can hold at
789 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
790 * returned in "entrypoint_list" is returned in "num_entrypoints".
792 VAStatus vaQueryConfigEntrypoints (
795 VAEntrypoint *entrypoint_list, /* out */
796 int *num_entrypoints /* out */
800 * Get attributes for a given profile/entrypoint pair
801 * The caller must provide an "attrib_list" with all attributes to be
802 * retrieved. Upon return, the attributes in "attrib_list" have been
803 * updated with their value. Unknown attributes or attributes that are
804 * not supported for the given profile/entrypoint pair will have their
805 * value set to VA_ATTRIB_NOT_SUPPORTED
807 VAStatus vaGetConfigAttributes (
810 VAEntrypoint entrypoint,
811 VAConfigAttrib *attrib_list, /* in/out */
815 /** Generic ID type, can be re-typed for specific implementation */
816 typedef unsigned int VAGenericID;
818 typedef VAGenericID VAConfigID;
821 * Create a configuration for the decode pipeline
822 * it passes in the attribute list that specifies the attributes it cares
823 * about, with the rest taking default values.
825 VAStatus vaCreateConfig (
828 VAEntrypoint entrypoint,
829 VAConfigAttrib *attrib_list,
831 VAConfigID *config_id /* out */
835 * Free resources associdated with a given config
837 VAStatus vaDestroyConfig (
843 * Query all attributes for a given configuration
844 * The profile of the configuration is returned in "profile"
845 * The entrypoint of the configuration is returned in "entrypoint"
846 * The caller must provide an "attrib_list" array that can hold at least
847 * vaMaxNumConfigAttributes() entries. The actual number of attributes
848 * returned in "attrib_list" is returned in "num_attribs"
850 VAStatus vaQueryConfigAttributes (
852 VAConfigID config_id,
853 VAProfile *profile, /* out */
854 VAEntrypoint *entrypoint, /* out */
855 VAConfigAttrib *attrib_list,/* out */
856 int *num_attribs /* out */
861 * Contexts and Surfaces
863 * Context represents a "virtual" video decode pipeline. Surfaces are render
864 * targets for a given context. The data in the surfaces are not accessible
865 * to the client and the internal data format of the surface is implementatin
868 * Surfaces will be bound to a context when the context is created. Once
869 * a surface is bound to a given context, it can not be used to create
870 * another context. The association is removed when the context is destroyed
872 * Both contexts and surfaces are identified by unique IDs and its
873 * implementation specific internals are kept opaque to the clients
876 typedef VAGenericID VAContextID;
878 typedef VAGenericID VASurfaceID;
880 #define VA_INVALID_ID 0xffffffff
881 #define VA_INVALID_SURFACE VA_INVALID_ID
883 /** \brief Generic value types. */
885 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
886 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
887 VAGenericValueTypePointer, /**< Generic pointer type */
888 VAGenericValueTypeFunc /**< Pointer to function */
889 } VAGenericValueType;
891 /** \brief Generic function type. */
892 typedef void (*VAGenericFunc)(void);
894 /** \brief Generic value. */
895 typedef struct _VAGenericValue {
896 /** \brief Value type. See #VAGenericValueType. */
897 VAGenericValueType type;
898 /** \brief Value holder. */
900 /** \brief 32-bit signed integer. */
902 /** \brief 32-bit float. */
904 /** \brief Generic pointer. */
906 /** \brief Pointer to function. */
911 /** @name Surface attribute flags */
913 /** \brief Surface attribute is not supported. */
914 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
915 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
916 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
917 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
918 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
921 /** \brief Surface attribute types. */
923 VASurfaceAttribNone = 0,
925 * \brief Pixel format (fourcc).
927 * The value is meaningful as input to vaQuerySurfaceAttributes().
928 * If zero, the driver returns the optimal pixel format for the
929 * specified config. Otherwise, if non-zero, the value represents
930 * a pixel format (FOURCC) that is kept as is on output, if the
931 * driver supports it. Otherwise, the driver sets the value to
932 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
934 VASurfaceAttribPixelFormat,
935 /** \brief Minimal width in pixels (int, read-only). */
936 VASurfaceAttribMinWidth,
937 /** \brief Maximal width in pixels (int, read-only). */
938 VASurfaceAttribMaxWidth,
939 /** \brief Minimal height in pixels (int, read-only). */
940 VASurfaceAttribMinHeight,
941 /** \brief Maximal height in pixels (int, read-only). */
942 VASurfaceAttribMaxHeight,
943 /** \brief Surface memory type expressed in bit fields (int, read/write). */
944 VASurfaceAttribMemoryType,
945 /** \brief External buffer descriptor (pointer, write). */
946 VASurfaceAttribExternalBufferDescriptor,
947 /** \brief Surface usage hint, gives the driver a hint of intended usage
948 * to optimize allocation (e.g. tiling) (int, read/write). */
949 VASurfaceAttribUsageHint,
950 /** \brief Number of surface attributes. */
952 } VASurfaceAttribType;
954 /** \brief Surface attribute. */
955 typedef struct _VASurfaceAttrib {
957 VASurfaceAttribType type;
958 /** \brief Flags. See "Surface attribute flags". */
960 /** \brief Value. See "Surface attribute types" for the expected types. */
961 VAGenericValue value;
965 * @name VASurfaceAttribMemoryType values in bit fields.
966 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
967 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
968 * types are defined in DRM and Android header files.
971 /** \brief VA memory type (default) is supported. */
972 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
973 /** \brief V4L2 buffer memory type is supported. */
974 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
975 /** \brief User pointer memory type is supported. */
976 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
980 * \brief VASurfaceAttribExternalBuffers structure for
981 * the VASurfaceAttribExternalBufferDescriptor attribute.
983 typedef struct _VASurfaceAttribExternalBuffers {
984 /** \brief pixel format in fourcc. */
985 uint32_t pixel_format;
986 /** \brief width in pixels. */
988 /** \brief height in pixels. */
990 /** \brief total size of the buffer in bytes. */
992 /** \brief number of planes for planar layout */
994 /** \brief pitch for each plane in bytes */
996 /** \brief offset for each plane in bytes */
998 /** \brief buffer handles or user pointers */
1000 /** \brief number of elements in the "buffers" array */
1001 uint32_t num_buffers;
1002 /** \brief flags. See "Surface external buffer descriptor flags". */
1004 /** \brief reserved for passing private data */
1006 } VASurfaceAttribExternalBuffers;
1008 /** @name VASurfaceAttribExternalBuffers flags */
1010 /** \brief Enable memory tiling */
1011 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1012 /** \brief Memory is cacheable */
1013 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1014 /** \brief Memory is non-cacheable */
1015 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1016 /** \brief Memory is write-combined */
1017 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1018 /** \brief Memory is protected */
1019 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1021 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1023 /** \brief Surface usage not indicated. */
1024 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1025 /** \brief Surface used by video decoder. */
1026 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1027 /** \brief Surface used by video encoder. */
1028 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1029 /** \brief Surface read by video post-processing. */
1030 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1031 /** \brief Surface written by video post-processing. */
1032 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1033 /** \brief Surface used for display. */
1034 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1039 * \brief Queries surface attributes for the supplied config.
1041 * This function queries for all supported attributes for the
1042 * supplied VA @config. In particular, if the underlying hardware
1043 * supports the creation of VA surfaces in various formats, then
1044 * this function will enumerate all pixel formats that are supported.
1046 * The \c attrib_list array is allocated by the user and \c
1047 * num_attribs shall be initialized to the number of allocated
1048 * elements in that array. Upon successful return, the actual number
1049 * of attributes will be overwritten into \c num_attribs. Otherwise,
1050 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1051 * is adjusted to the number of elements that would be returned if
1052 * enough space was available.
1054 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1055 * argument when vaQuerySurfaceAttributes() is used to determine the
1056 * actual number of elements that need to be allocated.
1058 * @param[in] dpy the VA display
1059 * @param[in] config the config identifying a codec or a video
1060 * processing pipeline
1061 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1062 * @param[in,out] num_attribs the number of elements allocated on
1063 * input, the number of elements actually filled in output
1066 vaQuerySurfaceAttributes(
1069 VASurfaceAttrib *attrib_list,
1070 unsigned int *num_attribs
1074 * \brief Creates an array of surfaces
1076 * Creates an array of surfaces. The optional list of attributes shall
1077 * be constructed based on what the underlying hardware could expose
1078 * through vaQuerySurfaceAttributes().
1080 * @param[in] dpy the VA display
1081 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1082 * @param[in] width the surface width
1083 * @param[in] height the surface height
1084 * @param[out] surfaces the array of newly created surfaces
1085 * @param[in] num_surfaces the number of surfaces to create
1086 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1087 * @param[in] num_attribs the number of attributes supplied in
1088 * \c attrib_list, or zero
1093 unsigned int format,
1095 unsigned int height,
1096 VASurfaceID *surfaces,
1097 unsigned int num_surfaces,
1098 VASurfaceAttrib *attrib_list,
1099 unsigned int num_attribs
1103 * vaDestroySurfaces - Destroy resources associated with surfaces.
1104 * Surfaces can only be destroyed after the context associated has been
1107 * surfaces: array of surfaces to destroy
1108 * num_surfaces: number of surfaces in the array to be destroyed.
1110 VAStatus vaDestroySurfaces (
1112 VASurfaceID *surfaces,
1116 #define VA_PROGRESSIVE 0x1
1118 * vaCreateContext - Create a context
1120 * config_id: configuration for the context
1121 * picture_width: coded picture width
1122 * picture_height: coded picture height
1123 * flag: any combination of the following:
1124 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1125 * render_targets: render targets (surfaces) tied to the context
1126 * num_render_targets: number of render targets in the above array
1127 * context: created context id upon return
1129 VAStatus vaCreateContext (
1131 VAConfigID config_id,
1135 VASurfaceID *render_targets,
1136 int num_render_targets,
1137 VAContextID *context /* out */
1141 * vaDestroyContext - Destroy a context
1143 * context: context to be destroyed
1145 VAStatus vaDestroyContext (
1152 * Buffers are used to pass various types of data from the
1153 * client to the server. The server maintains a data store
1154 * for each buffer created, and the client idenfies a buffer
1155 * through a unique buffer id assigned by the server.
1158 typedef VAGenericID VABufferID;
1162 VAPictureParameterBufferType = 0,
1163 VAIQMatrixBufferType = 1,
1164 VABitPlaneBufferType = 2,
1165 VASliceGroupMapBufferType = 3,
1166 VASliceParameterBufferType = 4,
1167 VASliceDataBufferType = 5,
1168 VAMacroblockParameterBufferType = 6,
1169 VAResidualDataBufferType = 7,
1170 VADeblockingParameterBufferType = 8,
1171 VAImageBufferType = 9,
1172 VAProtectedSliceDataBufferType = 10,
1173 VAQMatrixBufferType = 11,
1174 VAHuffmanTableBufferType = 12,
1175 VAProbabilityBufferType = 13,
1177 /* Following are encode buffer types */
1178 VAEncCodedBufferType = 21,
1179 VAEncSequenceParameterBufferType = 22,
1180 VAEncPictureParameterBufferType = 23,
1181 VAEncSliceParameterBufferType = 24,
1182 VAEncPackedHeaderParameterBufferType = 25,
1183 VAEncPackedHeaderDataBufferType = 26,
1184 VAEncMiscParameterBufferType = 27,
1185 VAEncMacroblockParameterBufferType = 28,
1186 VAEncMacroblockMapBufferType = 29,
1189 * \brief Encoding QP buffer
1191 * This buffer contains QP per MB for encoding. Currently
1192 * VAEncQPBufferH264 is defined for H.264 encoding, see
1193 * #VAEncQPBufferH264 for details
1195 VAEncQPBufferType = 30,
1196 /* Following are video processing buffer types */
1198 * \brief Video processing pipeline parameter buffer.
1200 * This buffer describes the video processing pipeline. See
1201 * #VAProcPipelineParameterBuffer for details.
1203 VAProcPipelineParameterBufferType = 41,
1205 * \brief Video filter parameter buffer.
1207 * This buffer describes the video filter parameters. All buffers
1208 * inherit from #VAProcFilterParameterBufferBase, thus including
1209 * a unique filter buffer type.
1211 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1212 * Filters requiring advanced parameters include, but are not limited to,
1213 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1214 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1216 VAProcFilterParameterBufferType = 42,
1218 * \brief FEI specific buffer types
1220 VAEncFEIMVBufferType = 43,
1221 VAEncFEIMBCodeBufferType = 44,
1222 VAEncFEIDistortionBufferType = 45,
1223 VAEncFEIMBControlBufferType = 46,
1224 VAEncFEIMVPredictorBufferType = 47,
1230 VAEncMiscParameterTypeFrameRate = 0,
1231 VAEncMiscParameterTypeRateControl = 1,
1232 VAEncMiscParameterTypeMaxSliceSize = 2,
1233 VAEncMiscParameterTypeAIR = 3,
1234 /** \brief Buffer type used to express a maximum frame size (in bits). */
1235 VAEncMiscParameterTypeMaxFrameSize = 4,
1236 /** \brief Buffer type used for HRD parameters. */
1237 VAEncMiscParameterTypeHRD = 5,
1238 VAEncMiscParameterTypeQualityLevel = 6,
1239 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1240 * rate control, when the user has externally skipped frames. */
1241 VAEncMiscParameterTypeSkipFrame = 9,
1242 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1243 VAEncMiscParameterTypeROI = 10,
1244 /** \brief Buffer type used for temporal layer structure */
1245 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1246 /** \brief Buffer type used for FEI input frame level parameters */
1247 VAEncMiscParameterTypeFEIFrameControl = 18,
1248 } VAEncMiscParameterType;
1250 /** \brief Packed header type. */
1252 /** \brief Packed sequence header. */
1253 VAEncPackedHeaderSequence = 1,
1254 /** \brief Packed picture header. */
1255 VAEncPackedHeaderPicture = 2,
1256 /** \brief Packed slice header. */
1257 VAEncPackedHeaderSlice = 3,
1259 * \brief Packed raw header.
1261 * Packed raw data header can be used by the client to insert a header
1262 * into the bitstream data buffer at the point it is passed, the driver
1263 * will handle the raw packed header based on "has_emulation_bytes" field
1264 * in the packed header parameter structure.
1266 VAEncPackedHeaderRawData = 4,
1268 * \brief Misc packed header. See codec-specific definitions.
1271 * This is a deprecated packed header type. All applications can use
1272 * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1274 VAEncPackedHeaderMiscMask va_deprecated_enum = 0x80000000,
1275 } VAEncPackedHeaderType;
1277 /** \brief Packed header parameter. */
1278 typedef struct _VAEncPackedHeaderParameterBuffer {
1279 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1281 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1282 uint32_t bit_length;
1283 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1284 uint8_t has_emulation_bytes;
1285 } VAEncPackedHeaderParameterBuffer;
1288 * For application, e.g. set a new bitrate
1289 * VABufferID buf_id;
1290 * VAEncMiscParameterBuffer *misc_param;
1291 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1293 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1294 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1295 * 1, NULL, &buf_id);
1297 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1298 * misc_param->type = VAEncMiscParameterTypeRateControl;
1299 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1300 * misc_rate_ctrl->bits_per_second = 6400000;
1301 * vaUnmapBuffer(dpy, buf_id);
1302 * vaRenderPicture(dpy, context, &buf_id, 1);
1304 typedef struct _VAEncMiscParameterBuffer
1306 VAEncMiscParameterType type;
1308 } VAEncMiscParameterBuffer;
1310 /** \brief Temporal layer Structure*/
1311 typedef struct _VAEncMiscParameterTemporalLayerStructure
1313 /** \brief The number of temporal layers */
1314 uint32_t number_of_layers;
1315 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1316 uint32_t periodicity;
1318 * \brief The array indicating the layer id for each frame
1320 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1321 * ids for frames starting from the 2nd frame.
1323 uint32_t layer_id[32];
1324 } VAEncMiscParameterTemporalLayerStructure;
1327 /** \brief Rate control parameters */
1328 typedef struct _VAEncMiscParameterRateControl
1330 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1331 uint32_t bits_per_second;
1332 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1333 * bit-rate for example if target_percentage is 95 then the rate control will target
1334 * a bit-rate that is 95% of the maximum bit-rate
1336 uint32_t target_percentage;
1337 /* windows size in milliseconds. For example if this is set to 500,
1338 * then the rate control will guarantee the target bit-rate over a 500 ms window
1340 uint32_t window_size;
1341 /* initial QP at I frames */
1342 uint32_t initial_qp;
1344 uint32_t basic_unit_size;
1350 uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1351 uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1352 uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1354 * The temporal layer that the rate control parameters are specified for.
1356 uint32_t temporal_id : 8;
1357 uint32_t reserved : 17;
1361 } VAEncMiscParameterRateControl;
1363 typedef struct _VAEncMiscParameterFrameRate
1366 * The framerate is specified as a number of frames per second, as a
1367 * fraction. The denominator of the fraction is given in the top half
1368 * (the high two bytes) of the framerate field, and the numerator is
1369 * given in the bottom half (the low two bytes).
1372 * denominator = framerate >> 16 & 0xffff;
1373 * numerator = framerate & 0xffff;
1374 * fps = numerator / denominator;
1376 * For example, if framerate is set to (100 << 16 | 750), this is
1377 * 750 / 100, hence 7.5fps.
1379 * If the denominator is zero (the high two bytes are both zero) then
1380 * it takes the value one instead, so the framerate is just the integer
1381 * in the low 2 bytes.
1389 * The temporal id the framerate parameters are specified for.
1391 uint32_t temporal_id : 8;
1392 uint32_t reserved : 24;
1396 } VAEncMiscParameterFrameRate;
1399 * Allow a maximum slice size to be specified (in bits).
1400 * The encoder will attempt to make sure that individual slices do not exceed this size
1401 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1403 typedef struct _VAEncMiscParameterMaxSliceSize
1405 uint32_t max_slice_size;
1406 } VAEncMiscParameterMaxSliceSize;
1408 typedef struct _VAEncMiscParameterAIR
1410 uint32_t air_num_mbs;
1411 uint32_t air_threshold;
1412 uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1413 } VAEncMiscParameterAIR;
1415 typedef struct _VAEncMiscParameterHRD
1417 uint32_t initial_buffer_fullness; /* in bits */
1418 uint32_t buffer_size; /* in bits */
1419 } VAEncMiscParameterHRD;
1422 * \brief Defines a maximum frame size (in bits).
1424 * This misc parameter buffer defines the maximum size of a frame (in
1425 * bits). The encoder will try to make sure that each frame does not
1426 * exceed this size. Otherwise, if the frame size exceeds this size,
1427 * the \c status flag of #VACodedBufferSegment will contain
1428 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1430 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1431 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1432 VAEncMiscParameterType type;
1433 /** \brief Maximum size of a frame (in bits). */
1434 uint32_t max_frame_size;
1435 } VAEncMiscParameterBufferMaxFrameSize;
1438 * \brief Encoding quality level.
1440 * The encoding quality could be set through this structure, if the implementation
1441 * supports multiple quality levels. The quality level set through this structure is
1442 * persistent over the entire coded sequence, or until a new structure is being sent.
1443 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1444 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1445 * quality. The quality level setting is used as a trade-off between quality and speed/power
1446 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1448 typedef struct _VAEncMiscParameterBufferQualityLevel {
1449 /** \brief Encoding quality level setting. When set to 0, default quality
1452 uint32_t quality_level;
1453 } VAEncMiscParameterBufferQualityLevel;
1456 * \brief Encoding skip frame.
1458 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1459 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1460 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1461 * current frame. It is allowed for the application to still send in packed headers for the driver to
1462 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1464 typedef struct _VAEncMiscParameterSkipFrame {
1465 /** \brief Indicates skip frames as below.
1466 * 0: Encode as normal, no skip.
1467 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1468 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1469 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1470 * in VAEncPackedHeaderPicture). */
1471 uint8_t skip_frame_flag;
1472 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1473 uint8_t num_skip_frames;
1474 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1475 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1476 uint32_t size_skip_frames;
1477 } VAEncMiscParameterSkipFrame;
1480 * \brief Encoding region-of-interest (ROI).
1482 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1483 * supports ROI input. The ROI set through this structure is applicable only to the
1484 * current frame or field, so must be sent every frame or field to be applied. The number of
1485 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1486 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1488 typedef struct _VAEncROI
1490 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1491 * codec coding units. It is relative to frame coordinates for the frame case and
1492 * to field coordinates for the field case. */
1493 VARectangle roi_rectangle;
1497 * \ref roi_value specifies ROI delta QP or ROI priority.
1498 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1499 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1500 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1501 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1502 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1503 * regions, the roi_value that is first in the ROI array will have priority.
1505 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1506 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1508 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1509 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1510 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1515 typedef struct _VAEncMiscParameterBufferROI {
1516 /** \brief Number of ROIs being sent.*/
1519 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1520 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1522 int8_t max_delta_qp;
1523 int8_t min_delta_qp;
1525 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1526 * coordinates for the frame case and to field coordinates for the field case.*/
1531 * \brief An indication for roi value.
1533 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1534 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1535 * in #VAEncROI should be used as ROI priority.
1537 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1538 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
1539 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1540 * when VAConfigAttribRateControl == VA_RC_CQP.
1542 uint32_t roi_value_is_qp_delta : 1;
1543 uint32_t reserved : 31;
1547 } VAEncMiscParameterBufferROI;
1550 * There will be cases where the bitstream buffer will not have enough room to hold
1551 * the data for the entire slice, and the following flags will be used in the slice
1552 * parameter to signal to the server for the possible cases.
1553 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1554 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1555 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1557 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1558 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1559 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1560 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1562 /* Codec-independent Slice Parameter Buffer base */
1563 typedef struct _VASliceParameterBufferBase
1565 uint32_t slice_data_size; /* number of bytes in the slice data buffer for this slice */
1566 uint32_t slice_data_offset; /* the offset to the first byte of slice data */
1567 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1568 } VASliceParameterBufferBase;
1570 /**********************************
1571 * JPEG common data structures
1572 **********************************/
1574 * \brief Huffman table for JPEG decoding.
1576 * This structure holds the complete Huffman tables. This is an
1577 * aggregation of all Huffman table (DHT) segments maintained by the
1578 * application. i.e. up to 2 Huffman tables are stored in there for
1581 * The #load_huffman_table array can be used as a hint to notify the
1582 * VA driver implementation about which table(s) actually changed
1583 * since the last submission of this buffer.
1585 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1586 /** \brief Specifies which #huffman_table is valid. */
1587 uint8_t load_huffman_table[2];
1588 /** \brief Huffman tables indexed by table identifier (Th). */
1590 /** @name DC table (up to 12 categories) */
1592 /** \brief Number of Huffman codes of length i + 1 (Li). */
1593 uint8_t num_dc_codes[16];
1594 /** \brief Value associated with each Huffman code (Vij). */
1595 uint8_t dc_values[12];
1597 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1599 /** \brief Number of Huffman codes of length i + 1 (Li). */
1600 uint8_t num_ac_codes[16];
1601 /** \brief Value associated with each Huffman code (Vij). */
1602 uint8_t ac_values[162];
1603 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1607 } VAHuffmanTableBufferJPEGBaseline;
1609 /****************************
1610 * MPEG-2 data structures
1611 ****************************/
1613 /* MPEG-2 Picture Parameter Buffer */
1615 * For each frame or field, and before any slice data, a single
1616 * picture parameter buffer must be send.
1618 typedef struct _VAPictureParameterBufferMPEG2
1620 uint16_t horizontal_size;
1621 uint16_t vertical_size;
1622 VASurfaceID forward_reference_picture;
1623 VASurfaceID backward_reference_picture;
1624 /* meanings of the following fields are the same as in the standard */
1625 int32_t picture_coding_type;
1626 int32_t f_code; /* pack all four fcode into this */
1629 uint32_t intra_dc_precision : 2;
1630 uint32_t picture_structure : 2;
1631 uint32_t top_field_first : 1;
1632 uint32_t frame_pred_frame_dct : 1;
1633 uint32_t concealment_motion_vectors : 1;
1634 uint32_t q_scale_type : 1;
1635 uint32_t intra_vlc_format : 1;
1636 uint32_t alternate_scan : 1;
1637 uint32_t repeat_first_field : 1;
1638 uint32_t progressive_frame : 1;
1639 uint32_t is_first_field : 1; /* indicate whether the current field
1640 * is the first field for field picture
1644 } picture_coding_extension;
1645 } VAPictureParameterBufferMPEG2;
1647 /** MPEG-2 Inverse Quantization Matrix Buffer */
1648 typedef struct _VAIQMatrixBufferMPEG2
1650 /** \brief Same as the MPEG-2 bitstream syntax element. */
1651 int32_t load_intra_quantiser_matrix;
1652 /** \brief Same as the MPEG-2 bitstream syntax element. */
1653 int32_t load_non_intra_quantiser_matrix;
1654 /** \brief Same as the MPEG-2 bitstream syntax element. */
1655 int32_t load_chroma_intra_quantiser_matrix;
1656 /** \brief Same as the MPEG-2 bitstream syntax element. */
1657 int32_t load_chroma_non_intra_quantiser_matrix;
1658 /** \brief Luminance intra matrix, in zig-zag scan order. */
1659 uint8_t intra_quantiser_matrix[64];
1660 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1661 uint8_t non_intra_quantiser_matrix[64];
1662 /** \brief Chroma intra matrix, in zig-zag scan order. */
1663 uint8_t chroma_intra_quantiser_matrix[64];
1664 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1665 uint8_t chroma_non_intra_quantiser_matrix[64];
1666 } VAIQMatrixBufferMPEG2;
1668 /** MPEG-2 Slice Parameter Buffer */
1669 typedef struct _VASliceParameterBufferMPEG2
1671 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1672 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1673 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1674 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1675 uint32_t slice_horizontal_position;
1676 uint32_t slice_vertical_position;
1677 int32_t quantiser_scale_code;
1678 int32_t intra_slice_flag;
1679 } VASliceParameterBufferMPEG2;
1681 /** MPEG-2 Macroblock Parameter Buffer */
1682 typedef struct _VAMacroblockParameterBufferMPEG2
1684 uint16_t macroblock_address;
1686 * macroblock_address (in raster scan order)
1688 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1690 uint8_t macroblock_type; /* see definition below */
1693 uint32_t frame_motion_type : 2;
1694 uint32_t field_motion_type : 2;
1695 uint32_t dct_type : 1;
1699 uint8_t motion_vertical_field_select;
1701 * motion_vertical_field_select:
1702 * see section 6.3.17.2 in the spec
1703 * only the lower 4 bits are used
1704 * bit 0: first vector forward
1705 * bit 1: first vector backward
1706 * bit 2: second vector forward
1707 * bit 3: second vector backward
1709 int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
1710 uint16_t coded_block_pattern;
1712 * The bitplanes for coded_block_pattern are described
1713 * in Figure 6.10-12 in the spec
1716 /* Number of skipped macroblocks after this macroblock */
1717 uint16_t num_skipped_macroblocks;
1718 } VAMacroblockParameterBufferMPEG2;
1721 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1723 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1724 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1725 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1726 #define VA_MB_TYPE_MOTION_INTRA 0x10
1729 * MPEG-2 Residual Data Buffer
1730 * For each macroblock, there wil be 64 shorts (16-bit) in the
1731 * residual data buffer
1734 /****************************
1735 * MPEG-4 Part 2 data structures
1736 ****************************/
1738 /* MPEG-4 Picture Parameter Buffer */
1740 * For each frame or field, and before any slice data, a single
1741 * picture parameter buffer must be send.
1743 typedef struct _VAPictureParameterBufferMPEG4
1746 uint16_t vop_height;
1747 VASurfaceID forward_reference_picture;
1748 VASurfaceID backward_reference_picture;
1751 uint32_t short_video_header : 1;
1752 uint32_t chroma_format : 2;
1753 uint32_t interlaced : 1;
1754 uint32_t obmc_disable : 1;
1755 uint32_t sprite_enable : 2;
1756 uint32_t sprite_warping_accuracy : 2;
1757 uint32_t quant_type : 1;
1758 uint32_t quarter_sample : 1;
1759 uint32_t data_partitioned : 1;
1760 uint32_t reversible_vlc : 1;
1761 uint32_t resync_marker_disable : 1;
1765 uint8_t no_of_sprite_warping_points;
1766 int16_t sprite_trajectory_du[3];
1767 int16_t sprite_trajectory_dv[3];
1768 uint8_t quant_precision;
1771 uint32_t vop_coding_type : 2;
1772 uint32_t backward_reference_vop_coding_type : 2;
1773 uint32_t vop_rounding_type : 1;
1774 uint32_t intra_dc_vlc_thr : 3;
1775 uint32_t top_field_first : 1;
1776 uint32_t alternate_vertical_scan_flag : 1;
1780 uint8_t vop_fcode_forward;
1781 uint8_t vop_fcode_backward;
1782 uint16_t vop_time_increment_resolution;
1783 /* short header related */
1784 uint8_t num_gobs_in_vop;
1785 uint8_t num_macroblocks_in_gob;
1786 /* for direct mode prediction */
1789 } VAPictureParameterBufferMPEG4;
1791 /** MPEG-4 Inverse Quantization Matrix Buffer */
1792 typedef struct _VAIQMatrixBufferMPEG4
1794 /** Same as the MPEG-4:2 bitstream syntax element. */
1795 int32_t load_intra_quant_mat;
1796 /** Same as the MPEG-4:2 bitstream syntax element. */
1797 int32_t load_non_intra_quant_mat;
1798 /** The matrix for intra blocks, in zig-zag scan order. */
1799 uint8_t intra_quant_mat[64];
1800 /** The matrix for non-intra blocks, in zig-zag scan order. */
1801 uint8_t non_intra_quant_mat[64];
1802 } VAIQMatrixBufferMPEG4;
1804 /** MPEG-4 Slice Parameter Buffer */
1805 typedef struct _VASliceParameterBufferMPEG4
1807 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
1808 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
1809 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1810 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1811 uint32_t macroblock_number;
1812 int32_t quant_scale;
1813 } VASliceParameterBufferMPEG4;
1816 VC-1 data structures
1819 typedef enum /* see 7.1.1.32 */
1822 VAMvMode1MvHalfPel = 1,
1823 VAMvMode1MvHalfPelBilinear = 2,
1824 VAMvModeMixedMv = 3,
1825 VAMvModeIntensityCompensation = 4
1828 /** VC-1 Picture Parameter Buffer */
1830 * For each picture, and before any slice data, a picture parameter
1831 * buffer must be send. Multiple picture parameter buffers may be
1832 * sent for a single picture. In that case picture parameters will
1833 * apply to all slice data that follow it until a new picture
1834 * parameter buffer is sent.
1837 * pic_quantizer_type should be set to the applicable quantizer
1838 * type as defined by QUANTIZER (J.1.19) and either
1839 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1841 typedef struct _VAPictureParameterBufferVC1
1843 VASurfaceID forward_reference_picture;
1844 VASurfaceID backward_reference_picture;
1845 /* if out-of-loop post-processing is done on the render
1846 target, then we need to keep the in-loop decoded
1847 picture as a reference picture */
1848 VASurfaceID inloop_decoded_picture;
1850 /* sequence layer for AP or meta data for SP and MP */
1853 uint32_t pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1854 uint32_t interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1855 uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1856 uint32_t finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1857 uint32_t psf : 1; /* SEQUENCE_LAYER::PSF */
1858 uint32_t multires : 1; /* METADATA::MULTIRES */
1859 uint32_t overlap : 1; /* METADATA::OVERLAP */
1860 uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
1861 uint32_t rangered : 1; /* METADATA::RANGERED */
1862 uint32_t max_b_frames : 3; /* METADATA::MAXBFRAMES */
1863 uint32_t profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1868 uint16_t coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1869 uint16_t coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1872 uint32_t broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1873 uint32_t closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1874 uint32_t panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1875 uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1878 } entrypoint_fields;
1879 uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1880 uint8_t fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1883 uint32_t luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1884 uint32_t luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1885 uint32_t chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1886 uint32_t chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1889 } range_mapping_fields;
1891 uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
1892 uint8_t cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1893 uint8_t mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1894 uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1895 uint8_t rounding_control; /* PICTURE_LAYER::RNDCTRL */
1896 uint8_t post_processing; /* PICTURE_LAYER::POSTPROC */
1897 uint8_t picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1898 uint8_t luma_scale; /* PICTURE_LAYER::LUMSCALE */
1899 uint8_t luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1903 uint32_t picture_type : 3; /* PICTURE_LAYER::PTYPE */
1904 uint32_t frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1905 uint32_t top_field_first : 1; /* PICTURE_LAYER::TFF */
1906 uint32_t is_first_field : 1; /* set to 1 if it is the first field */
1907 uint32_t intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1913 uint32_t mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1914 uint32_t direct_mb : 1; /* PICTURE::DIRECTMB */
1915 uint32_t skip_mb : 1; /* PICTURE::SKIPMB */
1916 uint32_t field_tx : 1; /* PICTURE::FIELDTX */
1917 uint32_t forward_mb : 1; /* PICTURE::FORWARDMB */
1918 uint32_t ac_pred : 1; /* PICTURE::ACPRED */
1919 uint32_t overflags : 1; /* PICTURE::OVERFLAGS */
1925 uint32_t bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1926 uint32_t bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1927 uint32_t bp_skip_mb : 1; /* PICTURE::SKIPMB */
1928 uint32_t bp_field_tx : 1; /* PICTURE::FIELDTX */
1929 uint32_t bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1930 uint32_t bp_ac_pred : 1; /* PICTURE::ACPRED */
1931 uint32_t bp_overflags : 1; /* PICTURE::OVERFLAGS */
1934 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1937 uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1938 uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1939 uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1940 uint32_t reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1946 uint32_t mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1947 uint32_t mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1948 uint32_t mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1949 uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1950 uint32_t four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1951 uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1952 uint32_t extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1953 uint32_t extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1954 uint32_t extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1955 uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1961 uint32_t dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1962 uint32_t quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1963 uint32_t half_qp : 1; /* PICTURE_LAYER::HALFQP */
1964 uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1965 uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1966 uint32_t dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1967 uint32_t dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1968 uint32_t dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1969 uint32_t dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1970 uint32_t dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1971 uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1974 } pic_quantizer_fields;
1977 uint32_t variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1978 uint32_t mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1979 uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1980 uint32_t transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1981 uint32_t transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1982 uint32_t intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1986 } VAPictureParameterBufferVC1;
1988 /** VC-1 Bitplane Buffer
1989 There will be at most three bitplanes coded in any picture header. To send
1990 the bitplane data more efficiently, each byte is divided in two nibbles, with
1991 each nibble carrying three bitplanes for one macroblock. The following table
1992 shows the bitplane data arrangement within each nibble based on the picture
1995 Picture Type Bit3 Bit2 Bit1 Bit0
1996 I or BI OVERFLAGS ACPRED FIELDTX
1997 P MYTYPEMB SKIPMB DIRECTMB
1998 B FORWARDMB SKIPMB DIRECTMB
2000 Within each byte, the lower nibble is for the first MB and the upper nibble is
2001 for the second MB. E.g. the lower nibble of the first byte in the bitplane
2002 buffer is for Macroblock #1 and the upper nibble of the first byte is for
2003 Macroblock #2 in the first row.
2006 /* VC-1 Slice Parameter Buffer */
2007 typedef struct _VASliceParameterBufferVC1
2009 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2010 uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2011 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2012 uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2013 uint32_t slice_vertical_position;
2014 } VASliceParameterBufferVC1;
2016 /* VC-1 Slice Data Buffer */
2018 This is simplely a buffer containing raw bit-stream bytes
2021 /****************************
2022 * H.264/AVC data structures
2023 ****************************/
2025 typedef struct _VAPictureH264
2027 VASurfaceID picture_id;
2030 int32_t TopFieldOrderCnt;
2031 int32_t BottomFieldOrderCnt;
2033 /* flags in VAPictureH264 could be OR of the following */
2034 #define VA_PICTURE_H264_INVALID 0x00000001
2035 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2036 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2037 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2038 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2040 /** H.264 Picture Parameter Buffer */
2042 * For each picture, and before any slice data, a single
2043 * picture parameter buffer must be send.
2045 typedef struct _VAPictureParameterBufferH264
2047 VAPictureH264 CurrPic;
2048 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2049 uint16_t picture_width_in_mbs_minus1;
2050 uint16_t picture_height_in_mbs_minus1;
2051 uint8_t bit_depth_luma_minus8;
2052 uint8_t bit_depth_chroma_minus8;
2053 uint8_t num_ref_frames;
2056 uint32_t chroma_format_idc : 2;
2057 uint32_t residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2058 uint32_t gaps_in_frame_num_value_allowed_flag : 1;
2059 uint32_t frame_mbs_only_flag : 1;
2060 uint32_t mb_adaptive_frame_field_flag : 1;
2061 uint32_t direct_8x8_inference_flag : 1;
2062 uint32_t MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2063 uint32_t log2_max_frame_num_minus4 : 4;
2064 uint32_t pic_order_cnt_type : 2;
2065 uint32_t log2_max_pic_order_cnt_lsb_minus4 : 4;
2066 uint32_t delta_pic_order_always_zero_flag : 1;
2070 // FMO is not supported.
2071 va_deprecated uint8_t num_slice_groups_minus1;
2072 va_deprecated uint8_t slice_group_map_type;
2073 va_deprecated uint16_t slice_group_change_rate_minus1;
2074 int8_t pic_init_qp_minus26;
2075 int8_t pic_init_qs_minus26;
2076 int8_t chroma_qp_index_offset;
2077 int8_t second_chroma_qp_index_offset;
2080 uint32_t entropy_coding_mode_flag : 1;
2081 uint32_t weighted_pred_flag : 1;
2082 uint32_t weighted_bipred_idc : 2;
2083 uint32_t transform_8x8_mode_flag : 1;
2084 uint32_t field_pic_flag : 1;
2085 uint32_t constrained_intra_pred_flag : 1;
2086 uint32_t pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2087 uint32_t deblocking_filter_control_present_flag : 1;
2088 uint32_t redundant_pic_cnt_present_flag : 1;
2089 uint32_t reference_pic_flag : 1; /* nal_ref_idc != 0 */
2094 } VAPictureParameterBufferH264;
2096 /** H.264 Inverse Quantization Matrix Buffer */
2097 typedef struct _VAIQMatrixBufferH264
2099 /** \brief 4x4 scaling list, in raster scan order. */
2100 uint8_t ScalingList4x4[6][16];
2101 /** \brief 8x8 scaling list, in raster scan order. */
2102 uint8_t ScalingList8x8[2][64];
2103 } VAIQMatrixBufferH264;
2105 /** H.264 Slice Parameter Buffer */
2106 typedef struct _VASliceParameterBufferH264
2108 uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2109 /** \brief Byte offset to the NAL Header Unit for this slice. */
2110 uint32_t slice_data_offset;
2111 uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2113 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2115 * This bit offset is relative to and includes the NAL unit byte
2116 * and represents the number of bits parsed in the slice_header()
2117 * after the removal of any emulation prevention bytes in
2118 * there. However, the slice data buffer passed to the hardware is
2119 * the original bitstream, thus including any emulation prevention
2122 uint16_t slice_data_bit_offset;
2123 uint16_t first_mb_in_slice;
2125 uint8_t direct_spatial_mv_pred_flag;
2126 uint8_t num_ref_idx_l0_active_minus1;
2127 uint8_t num_ref_idx_l1_active_minus1;
2128 uint8_t cabac_init_idc;
2129 int8_t slice_qp_delta;
2130 uint8_t disable_deblocking_filter_idc;
2131 int8_t slice_alpha_c0_offset_div2;
2132 int8_t slice_beta_offset_div2;
2133 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2134 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2135 uint8_t luma_log2_weight_denom;
2136 uint8_t chroma_log2_weight_denom;
2137 uint8_t luma_weight_l0_flag;
2138 int16_t luma_weight_l0[32];
2139 int16_t luma_offset_l0[32];
2140 uint8_t chroma_weight_l0_flag;
2141 int16_t chroma_weight_l0[32][2];
2142 int16_t chroma_offset_l0[32][2];
2143 uint8_t luma_weight_l1_flag;
2144 int16_t luma_weight_l1[32];
2145 int16_t luma_offset_l1[32];
2146 uint8_t chroma_weight_l1_flag;
2147 int16_t chroma_weight_l1[32][2];
2148 int16_t chroma_offset_l1[32][2];
2149 } VASliceParameterBufferH264;
2151 /****************************
2152 * Common encode data structures
2153 ****************************/
2156 VAEncPictureTypeIntra = 0,
2157 VAEncPictureTypePredictive = 1,
2158 VAEncPictureTypeBidirectional = 2,
2161 /* Encode Slice Parameter Buffer */
2162 typedef struct _VAEncSliceParameterBuffer
2164 uint32_t start_row_number; /* starting MB row number for this slice */
2165 uint32_t slice_height; /* slice height measured in MB */
2168 uint32_t is_intra : 1;
2169 uint32_t disable_deblocking_filter_idc : 2;
2170 uint32_t uses_long_term_ref :1;
2171 uint32_t is_long_term_ref :1;
2175 } VAEncSliceParameterBuffer;
2178 /****************************
2179 * H.263 specific encode data structures
2180 ****************************/
2182 typedef struct _VAEncSequenceParameterBufferH263
2184 uint32_t intra_period;
2185 uint32_t bits_per_second;
2186 uint32_t frame_rate;
2187 uint32_t initial_qp;
2189 } VAEncSequenceParameterBufferH263;
2191 typedef struct _VAEncPictureParameterBufferH263
2193 VASurfaceID reference_picture;
2194 VASurfaceID reconstructed_picture;
2195 VABufferID coded_buf;
2196 uint16_t picture_width;
2197 uint16_t picture_height;
2198 VAEncPictureType picture_type;
2199 } VAEncPictureParameterBufferH263;
2201 /****************************
2202 * MPEG-4 specific encode data structures
2203 ****************************/
2205 typedef struct _VAEncSequenceParameterBufferMPEG4
2207 uint8_t profile_and_level_indication;
2208 uint32_t intra_period;
2209 uint32_t video_object_layer_width;
2210 uint32_t video_object_layer_height;
2211 uint32_t vop_time_increment_resolution;
2212 uint32_t fixed_vop_rate;
2213 uint32_t fixed_vop_time_increment;
2214 uint32_t bits_per_second;
2215 uint32_t frame_rate;
2216 uint32_t initial_qp;
2218 } VAEncSequenceParameterBufferMPEG4;
2220 typedef struct _VAEncPictureParameterBufferMPEG4
2222 VASurfaceID reference_picture;
2223 VASurfaceID reconstructed_picture;
2224 VABufferID coded_buf;
2225 uint16_t picture_width;
2226 uint16_t picture_height;
2227 uint32_t modulo_time_base; /* number of 1s */
2228 uint32_t vop_time_increment;
2229 VAEncPictureType picture_type;
2230 } VAEncPictureParameterBufferMPEG4;
2234 /** Buffer functions */
2237 * Creates a buffer for "num_elements" elements of "size" bytes and
2238 * initalize with "data".
2239 * if "data" is null, then the contents of the buffer data store
2241 * Basically there are two ways to get buffer data to the server side. One is
2242 * to call vaCreateBuffer() with a non-null "data", which results the data being
2243 * copied to the data store on the server side. A different method that
2244 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2245 * and then use vaMapBuffer() to map the data store from the server side to the
2246 * client address space for access.
2247 * The user must call vaDestroyBuffer() to destroy a buffer.
2248 * Note: image buffers are created by the library, not the client. Please see
2249 * vaCreateImage on how image buffers are managed.
2251 VAStatus vaCreateBuffer (
2253 VAContextID context,
2254 VABufferType type, /* in */
2255 unsigned int size, /* in */
2256 unsigned int num_elements, /* in */
2257 void *data, /* in */
2258 VABufferID *buf_id /* out */
2262 * Convey to the server how many valid elements are in the buffer.
2263 * e.g. if multiple slice parameters are being held in a single buffer,
2264 * this will communicate to the server the number of slice parameters
2265 * that are valid in the buffer.
2267 VAStatus vaBufferSetNumElements (
2269 VABufferID buf_id, /* in */
2270 unsigned int num_elements /* in */
2275 * device independent data structure for codedbuffer
2279 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2280 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2281 * enough for the encoder to attempt to limit its size.
2282 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2283 * exceeded the maximum slice size specified.
2284 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2285 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2286 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2288 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2289 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2290 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2291 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2292 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2294 * \brief The frame has exceeded the maximum requested size.
2296 * This flag indicates that the encoded frame size exceeds the value
2297 * specified through a misc parameter buffer of type
2298 * #VAEncMiscParameterTypeMaxFrameSize.
2300 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2301 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2304 * \brief The coded buffer segment contains a single NAL unit.
2306 * This flag indicates that the coded buffer segment contains a
2307 * single NAL unit. This flag might be useful to the user for
2308 * processing the coded buffer.
2310 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2313 * \brief Coded buffer segment.
2315 * #VACodedBufferSegment is an element of a linked list describing
2316 * some information on the coded buffer. The coded buffer segment
2317 * could contain either a single NAL unit, or more than one NAL unit.
2318 * It is recommended (but not required) to return a single NAL unit
2319 * in a coded buffer segment, and the implementation should set the
2320 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2322 typedef struct _VACodedBufferSegment {
2324 * \brief Size of the data buffer in this segment (in bytes).
2327 /** \brief Bit offset into the data buffer where the video data starts. */
2328 uint32_t bit_offset;
2329 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2331 /** \brief Reserved for future use. */
2333 /** \brief Pointer to the start of the data buffer. */
2336 * \brief Pointer to the next #VACodedBufferSegment element,
2337 * or \c NULL if there is none.
2340 } VACodedBufferSegment;
2343 * Map data store of the buffer into the client's address space
2344 * vaCreateBuffer() needs to be called with "data" set to NULL before
2345 * calling vaMapBuffer()
2347 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2348 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2350 VAStatus vaMapBuffer (
2352 VABufferID buf_id, /* in */
2353 void **pbuf /* out */
2357 * After client making changes to a mapped data store, it needs to
2358 * "Unmap" it to let the server know that the data is ready to be
2359 * consumed by the server
2361 VAStatus vaUnmapBuffer (
2363 VABufferID buf_id /* in */
2367 * After this call, the buffer is deleted and this buffer_id is no longer valid
2369 * A buffer can be re-used and sent to the server by another Begin/Render/End
2370 * sequence if vaDestroyBuffer() is not called with this buffer.
2372 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
2373 * hardware accelerator can result in performance dropping.
2375 VAStatus vaDestroyBuffer (
2377 VABufferID buffer_id
2380 /** \brief VA buffer information */
2382 /** \brief Buffer handle */
2384 /** \brief Buffer type (See \ref VABufferType). */
2387 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2389 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2390 * to specify the set of memory types the caller is interested in.
2391 * On successful return from vaAcquireBufferHandle(), the field is
2392 * updated with the best matching memory type.
2395 /** \brief Size of the underlying buffer. */
2400 * \brief Acquires buffer handle for external API usage
2402 * Locks the VA buffer object \ref buf_id for external API usage like
2403 * EGL or OpenCL (OCL). This function is a synchronization point. This
2404 * means that any pending operation is guaranteed to be completed
2405 * prior to returning from the function.
2407 * If the referenced VA buffer object is the backing store of a VA
2408 * surface, then this function acts as if vaSyncSurface() on the
2409 * parent surface was called first.
2411 * The \ref VABufferInfo argument shall be zero'ed on input. On
2412 * successful output, the data structure is filled in with all the
2413 * necessary buffer level implementation details like handle, type,
2414 * memory type and memory size.
2416 * Note: the external API implementation, or the application, can
2417 * express the memory types it is interested in by filling in the \ref
2418 * mem_type field accordingly. On successful output, the memory type
2419 * that fits best the request and that was used is updated in the \ref
2420 * VABufferInfo data structure. If none of the supplied memory types
2421 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2422 * error is returned.
2424 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2425 * is called. Besides, no additional operation is allowed on any of
2426 * the buffer parent object until vaReleaseBufferHandle() is called.
2427 * e.g. decoding into a VA surface backed with the supplied VA buffer
2428 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2432 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2433 * does not support this interface
2434 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2435 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2436 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2437 * does not support exporting buffers of the specified type
2438 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2439 * memory types in \ref VABufferInfo.mem_type was supported
2441 * @param[in] dpy the VA display
2442 * @param[in] buf_id the VA buffer
2443 * @param[in,out] buf_info the associated VA buffer information
2444 * @return VA_STATUS_SUCCESS if successful
2447 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2450 * \brief Releases buffer after usage from external API
2452 * Unlocks the VA buffer object \ref buf_id from external API usage like
2453 * EGL or OpenCL (OCL). This function is a synchronization point. This
2454 * means that any pending operation is guaranteed to be completed
2455 * prior to returning from the function.
2457 * The \ref VABufferInfo argument shall point to the original data
2458 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2459 * This is necessary so that the VA driver implementation could
2460 * deallocate any resources that were needed.
2462 * In any case, returning from this function invalidates any contents
2463 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2464 * valid. Therefore, VA driver implementations are free to reset this
2465 * data structure to safe defaults.
2468 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2469 * does not support this interface
2470 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2471 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2472 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2473 * does not support exporting buffers of the specified type
2475 * @param[in] dpy the VA display
2476 * @param[in] buf_id the VA buffer
2477 * @return VA_STATUS_SUCCESS if successful
2480 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2483 Render (Decode) Pictures
2485 A picture represents either a frame or a field.
2487 The Begin/Render/End sequence sends the decode buffers to the server
2491 * Get ready to decode a picture to a target surface
2493 VAStatus vaBeginPicture (
2495 VAContextID context,
2496 VASurfaceID render_target
2500 * Send decode buffers to the server.
2502 VAStatus vaRenderPicture (
2504 VAContextID context,
2505 VABufferID *buffers,
2510 * Make the end of rendering for a picture.
2511 * The server should start processing all pending operations for this
2512 * surface. This call is non-blocking. The client can start another
2513 * Begin/Render/End sequence on a different render target.
2515 VAStatus vaEndPicture (
2527 * This function blocks until all pending operations on the render target
2528 * have been completed. Upon return it is safe to use the render target for a
2529 * different picture.
2531 VAStatus vaSyncSurface (
2533 VASurfaceID render_target
2538 VASurfaceRendering = 1, /* Rendering in progress */
2539 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2540 /* this status is useful if surface is used as the source */
2542 VASurfaceReady = 4, /* not being rendered or displayed */
2543 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2547 * Find out any pending ops on the render target
2549 VAStatus vaQuerySurfaceStatus (
2551 VASurfaceID render_target,
2552 VASurfaceStatus *status /* out */
2557 VADecodeSliceMissing = 0,
2558 VADecodeMBError = 1,
2559 } VADecodeErrorType;
2562 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2563 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2565 typedef struct _VASurfaceDecodeMBErrors
2567 int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2568 uint32_t start_mb; /* start mb address with errors */
2569 uint32_t end_mb; /* end mb address with errors */
2570 VADecodeErrorType decode_error_type;
2571 } VASurfaceDecodeMBErrors;
2574 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2575 * it can call vaQuerySurfaceError to find out further details on the particular error.
2576 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2577 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2578 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2579 * The array is terminated if "status==-1" is detected.
2581 VAStatus vaQuerySurfaceError(
2583 VASurfaceID surface,
2584 VAStatus error_status,
2589 * Images and Subpictures
2590 * VAImage is used to either get the surface data to client memory, or
2591 * to copy image data in client memory to a surface.
2592 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2593 * is at the upper left corner with positive X to the right and positive Y down
2595 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2596 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2597 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2600 * Pre-defined fourcc codes
2602 #define VA_FOURCC_NV12 0x3231564E
2603 #define VA_FOURCC_AI44 0x34344149
2604 #define VA_FOURCC_RGBA 0x41424752
2605 #define VA_FOURCC_RGBX 0x58424752
2606 #define VA_FOURCC_BGRA 0x41524742
2607 #define VA_FOURCC_BGRX 0x58524742
2608 #define VA_FOURCC_ARGB 0x42475241
2609 #define VA_FOURCC_XRGB 0x42475258
2610 #define VA_FOURCC_ABGR 0x52474241
2611 #define VA_FOURCC_XBGR 0x52474258
2612 #define VA_FOURCC_UYVY 0x59565955
2613 #define VA_FOURCC_YUY2 0x32595559
2614 #define VA_FOURCC_AYUV 0x56555941
2615 #define VA_FOURCC_NV11 0x3131564e
2616 #define VA_FOURCC_YV12 0x32315659
2617 #define VA_FOURCC_P208 0x38303250
2618 /* IYUV same as I420, but most user perfer I420, will deprecate it */
2619 #define VA_FOURCC_IYUV 0x56555949
2620 #define VA_FOURCC_I420 0x30323449
2621 #define VA_FOURCC_YV24 0x34325659
2622 #define VA_FOURCC_YV32 0x32335659
2623 #define VA_FOURCC_Y800 0x30303859
2624 #define VA_FOURCC_IMC3 0x33434D49
2625 #define VA_FOURCC_411P 0x50313134
2626 #define VA_FOURCC_422H 0x48323234
2627 #define VA_FOURCC_422V 0x56323234
2628 #define VA_FOURCC_444P 0x50343434
2629 #define VA_FOURCC_RGBP 0x50424752
2630 #define VA_FOURCC_BGRP 0x50524742
2631 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2634 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
2636 #define VA_FOURCC_YV16 0x36315659
2638 * 10-bit and 16-bit Planar YUV 4:2:0.
2640 #define VA_FOURCC_P010 0x30313050
2641 #define VA_FOURCC_P016 0x36313050
2644 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
2646 #define VA_FOURCC_I010 0x30313049
2649 #define VA_LSB_FIRST 1
2650 #define VA_MSB_FIRST 2
2652 typedef struct _VAImageFormat
2655 uint32_t byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2656 uint32_t bits_per_pixel;
2657 /* for RGB formats */
2658 uint32_t depth; /* significant bits per pixel */
2660 uint32_t green_mask;
2662 uint32_t alpha_mask;
2665 typedef VAGenericID VAImageID;
2667 typedef struct _VAImage
2669 VAImageID image_id; /* uniquely identify this image */
2670 VAImageFormat format;
2671 VABufferID buf; /* image data buffer */
2673 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2674 * data store on the server side for optimal performance. The buffer will be
2675 * created by the CreateImage function, and proper storage allocated based on the image
2676 * size and format. This buffer is managed by the library implementation, and
2677 * accessed by the client through the buffer Map/Unmap functions.
2682 uint32_t num_planes; /* can not be greater than 3 */
2684 * An array indicating the scanline pitch in bytes for each plane.
2685 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2687 uint32_t pitches[3];
2689 * An array indicating the byte offset from the beginning of the image data
2690 * to the start of each plane.
2692 uint32_t offsets[3];
2694 /* The following fields are only needed for paletted formats */
2695 int32_t num_palette_entries; /* set to zero for non-palette images */
2697 * Each component is one byte and entry_bytes indicates the number of components in
2698 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2700 int32_t entry_bytes;
2702 * An array of ascii characters describing the order of the components within the bytes.
2703 * Only entry_bytes characters of the string are used.
2705 int8_t component_order[4];
2708 /** Get maximum number of image formats supported by the implementation */
2709 int vaMaxNumImageFormats (
2714 * Query supported image formats
2715 * The caller must provide a "format_list" array that can hold at
2716 * least vaMaxNumImageFormats() entries. The actual number of formats
2717 * returned in "format_list" is returned in "num_formats".
2719 VAStatus vaQueryImageFormats (
2721 VAImageFormat *format_list, /* out */
2722 int *num_formats /* out */
2726 * Create a VAImage structure
2727 * The width and height fields returned in the VAImage structure may get
2728 * enlarged for some YUV formats. Upon return from this function,
2729 * image->buf has been created and proper storage allocated by the library.
2730 * The client can access the image through the Map/Unmap calls.
2732 VAStatus vaCreateImage (
2734 VAImageFormat *format,
2737 VAImage *image /* out */
2741 * Should call DestroyImage before destroying the surface it is bound to
2743 VAStatus vaDestroyImage (
2748 VAStatus vaSetImagePalette (
2752 * pointer to an array holding the palette data. The size of the array is
2753 * num_palette_entries * entry_bytes in size. The order of the components
2754 * in the palette is described by the component_order in VAImage struct
2756 unsigned char *palette
2760 * Retrive surface data into a VAImage
2761 * Image must be in a format supported by the implementation
2763 VAStatus vaGetImage (
2765 VASurfaceID surface,
2766 int x, /* coordinates of the upper left source pixel */
2768 unsigned int width, /* width and height of the region */
2769 unsigned int height,
2774 * Copy data from a VAImage to a surface
2775 * Image must be in a format supported by the implementation
2776 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2777 * shouldn't be rendered into when this is called
2779 VAStatus vaPutImage (
2781 VASurfaceID surface,
2785 unsigned int src_width,
2786 unsigned int src_height,
2789 unsigned int dest_width,
2790 unsigned int dest_height
2794 * Derive an VAImage from an existing surface.
2795 * This interface will derive a VAImage and corresponding image buffer from
2796 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2797 * direct CPU access. This operation is only possible on implementations with
2798 * direct rendering capabilities and internal surface formats that can be
2799 * represented with a VAImage. When the operation is not possible this interface
2800 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2801 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2804 * Implementations should only return success when the resulting image buffer
2805 * would be useable with vaMap/Unmap.
2807 * When directly accessing a surface special care must be taken to insure
2808 * proper synchronization with the graphics hardware. Clients should call
2809 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2810 * rendering or currently being displayed by an overlay.
2812 * Additionally nothing about the contents of a surface should be assumed
2813 * following a vaPutSurface. Implementations are free to modify the surface for
2814 * scaling or subpicture blending within a call to vaPutImage.
2816 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2817 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2818 * vaGetImage with other surfaces is supported.
2820 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2821 * image and image buffer structures will be destroyed; however, the underlying
2822 * surface will remain unchanged until freed with vaDestroySurfaces.
2824 VAStatus vaDeriveImage (
2826 VASurfaceID surface,
2827 VAImage *image /* out */
2832 * Subpicture is a special type of image that can be blended
2833 * with a surface during vaPutSurface(). Subpicture can be used to render
2834 * DVD sub-titles or closed captioning text etc.
2837 typedef VAGenericID VASubpictureID;
2839 /** Get maximum number of subpicture formats supported by the implementation */
2840 int vaMaxNumSubpictureFormats (
2844 /** flags for subpictures */
2845 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2846 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2847 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2849 * Query supported subpicture formats
2850 * The caller must provide a "format_list" array that can hold at
2851 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2852 * for each format to indicate additional capabilities for that format. The actual
2853 * number of formats returned in "format_list" is returned in "num_formats".
2854 * flags: returned value to indicate addtional capabilities
2855 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2856 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2857 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2860 VAStatus vaQuerySubpictureFormats (
2862 VAImageFormat *format_list, /* out */
2863 unsigned int *flags, /* out */
2864 unsigned int *num_formats /* out */
2868 * Subpictures are created with an image associated.
2870 VAStatus vaCreateSubpicture (
2873 VASubpictureID *subpicture /* out */
2877 * Destroy the subpicture before destroying the image it is assocated to
2879 VAStatus vaDestroySubpicture (
2881 VASubpictureID subpicture
2885 * Bind an image to the subpicture. This image will now be associated with
2886 * the subpicture instead of the one at creation.
2888 VAStatus vaSetSubpictureImage (
2890 VASubpictureID subpicture,
2895 * If chromakey is enabled, then the area where the source value falls within
2896 * the chromakey [min, max] range is transparent
2897 * The chromakey component format is the following:
2898 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2899 * For YUV: [0:7] V [8:15] U [16:23] Y
2900 * The chromakey mask can be used to mask out certain components for chromakey
2903 VAStatus vaSetSubpictureChromakey (
2905 VASubpictureID subpicture,
2906 unsigned int chromakey_min,
2907 unsigned int chromakey_max,
2908 unsigned int chromakey_mask
2912 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2913 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2914 * the overall alpha is per-pixel alpha multiplied by the global alpha
2916 VAStatus vaSetSubpictureGlobalAlpha (
2918 VASubpictureID subpicture,
2923 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2924 * It defines the region mapping between the subpicture and the target
2925 * surfaces through source and destination rectangles (with the same width and height).
2926 * Both will be displayed at the next call to vaPutSurface. Additional
2927 * associations before the call to vaPutSurface simply overrides the association.
2929 VAStatus vaAssociateSubpicture (
2931 VASubpictureID subpicture,
2932 VASurfaceID *target_surfaces,
2934 int16_t src_x, /* upper left offset in subpicture */
2937 uint16_t src_height,
2938 int16_t dest_x, /* upper left offset in surface */
2940 uint16_t dest_width,
2941 uint16_t dest_height,
2943 * whether to enable chroma-keying, global-alpha, or screen relative mode
2944 * see VA_SUBPICTURE_XXX values
2950 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2952 VAStatus vaDeassociateSubpicture (
2954 VASubpictureID subpicture,
2955 VASurfaceID *target_surfaces,
2960 * Display attributes
2961 * Display attributes are used to control things such as contrast, hue, saturation,
2962 * brightness etc. in the rendering process. The application can query what
2963 * attributes are supported by the driver, and then set the appropriate attributes
2964 * before calling vaPutSurface()
2966 /* PowerVR IEP Lite attributes */
2969 VADISPLAYATTRIB_BLE_OFF = 0x00,
2970 VADISPLAYATTRIB_BLE_LOW,
2971 VADISPLAYATTRIB_BLE_MEDIUM,
2972 VADISPLAYATTRIB_BLE_HIGH,
2973 VADISPLAYATTRIB_BLE_NONE,
2974 } VADisplayAttribBLEMode;
2976 /** attribute value for VADisplayAttribRotation */
2977 #define VA_ROTATION_NONE 0x00000000
2978 #define VA_ROTATION_90 0x00000001
2979 #define VA_ROTATION_180 0x00000002
2980 #define VA_ROTATION_270 0x00000003
2982 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2983 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2984 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2987 #define VA_RENDER_MODE_UNDEFINED 0
2988 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2989 #define VA_RENDER_MODE_LOCAL_GPU 2
2990 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2991 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2993 /** Render device */
2994 #define VA_RENDER_DEVICE_UNDEFINED 0
2995 #define VA_RENDER_DEVICE_LOCAL 1
2996 #define VA_RENDER_DEVICE_EXTERNAL 2
2998 /** Currently defined display attribute types */
3001 VADisplayAttribBrightness = 0,
3002 VADisplayAttribContrast = 1,
3003 VADisplayAttribHue = 2,
3004 VADisplayAttribSaturation = 3,
3005 /* client can specifiy a background color for the target window
3006 * the new feature of video conference,
3007 * the uncovered area of the surface is filled by this color
3008 * also it will blend with the decoded video color
3010 VADisplayAttribBackgroundColor = 4,
3012 * this is a gettable only attribute. For some implementations that use the
3013 * hardware overlay, after PutSurface is called, the surface can not be
3014 * re-used until after the subsequent PutSurface call. If this is the case
3015 * then the value for this attribute will be set to 1 so that the client
3016 * will not attempt to re-use the surface right after returning from a call
3019 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3020 * driver may use overlay or GPU alternatively
3022 VADisplayAttribDirectSurface = 5,
3023 VADisplayAttribRotation = 6,
3024 VADisplayAttribOutofLoopDeblock = 7,
3026 /* PowerVR IEP Lite specific attributes */
3027 VADisplayAttribBLEBlackMode = 8,
3028 VADisplayAttribBLEWhiteMode = 9,
3029 VADisplayAttribBlueStretch = 10,
3030 VADisplayAttribSkinColorCorrection = 11,
3032 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3033 * conversion matrix. Each element in the matrix is float-point
3035 VADisplayAttribCSCMatrix = 12,
3036 /* specify the constant color used to blend with video surface
3037 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3038 * d: the final color to overwrite into the frame buffer
3039 * v: decoded video after color conversion,
3040 * c: video color specified by VADisplayAttribBlendColor
3041 * b: background color of the drawable
3043 VADisplayAttribBlendColor = 13,
3045 * Indicate driver to skip painting color key or not.
3046 * only applicable if the render is overlay
3048 VADisplayAttribOverlayAutoPaintColorKey = 14,
3050 * customized overlay color key, the format is RGB888
3051 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3053 VADisplayAttribOverlayColorKey = 15,
3055 * The hint for the implementation of vaPutSurface
3056 * normally, the driver could use an overlay or GPU to render the surface on the screen
3057 * this flag provides APP the flexibity to switch the render dynamically
3059 VADisplayAttribRenderMode = 16,
3061 * specify if vaPutSurface needs to render into specified monitors
3062 * one example is that one external monitor (e.g. HDMI) is enabled,
3063 * but the window manager is not aware of it, and there is no associated drawable
3065 VADisplayAttribRenderDevice = 17,
3067 * specify vaPutSurface render area if there is no drawable on the monitor
3069 VADisplayAttribRenderRect = 18,
3070 } VADisplayAttribType;
3072 /* flags for VADisplayAttribute */
3073 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3074 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3075 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3077 typedef struct _VADisplayAttribute
3079 VADisplayAttribType type;
3082 int32_t value; /* used by the set/get attribute functions */
3083 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3085 } VADisplayAttribute;
3087 /** Get maximum number of display attributs supported by the implementation */
3088 int vaMaxNumDisplayAttributes (
3093 * Query display attributes
3094 * The caller must provide a "attr_list" array that can hold at
3095 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3096 * returned in "attr_list" is returned in "num_attributes".
3098 VAStatus vaQueryDisplayAttributes (
3100 VADisplayAttribute *attr_list, /* out */
3101 int *num_attributes /* out */
3105 * Get display attributes
3106 * This function returns the current attribute values in "attr_list".
3107 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3108 * from vaQueryDisplayAttributes() can have their values retrieved.
3110 VAStatus vaGetDisplayAttributes (
3112 VADisplayAttribute *attr_list, /* in/out */
3117 * Set display attributes
3118 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3119 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3120 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3122 VAStatus vaSetDisplayAttributes (
3124 VADisplayAttribute *attr_list,
3128 /****************************
3129 * HEVC data structures
3130 ****************************/
3132 * \brief Description of picture properties of those in DPB surfaces.
3134 * If only progressive scan is supported, each surface contains one whole
3136 * Otherwise, each surface contains two fields of whole picture.
3137 * In this case, two entries of ReferenceFrames[] may share same picture_id
3140 typedef struct _VAPictureHEVC
3142 /** \brief reconstructed picture buffer surface index
3143 * invalid when taking value VA_INVALID_SURFACE.
3145 VASurfaceID picture_id;
3146 /** \brief picture order count.
3147 * in HEVC, POCs for top and bottom fields of same picture should
3148 * take different values.
3150 int32_t pic_order_cnt;
3151 /* described below */
3155 /* flags in VAPictureHEVC could be OR of the following */
3156 #define VA_PICTURE_HEVC_INVALID 0x00000001
3157 /** \brief indication of interlace scan picture.
3158 * should take same value for all the pictures in sequence.
3160 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3161 /** \brief polarity of the field picture.
3162 * top field takes even lines of buffer surface.
3163 * bottom field takes odd lines of buffer surface.
3165 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3166 /** \brief Long term reference picture */
3167 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3169 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3170 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3171 * be exclusive. No more than one of them can be set for any picture.
3172 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3173 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3174 * Application should provide valid values for both short format and long format.
3175 * The pictures in DPB with any of these three flags turned on are referred by
3176 * the current picture.
3178 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3179 * Number of ReferenceFrames[] entries with this bit set equals
3180 * NumPocStCurrBefore.
3182 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3183 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3184 * Number of ReferenceFrames[] entries with this bit set equals
3185 * NumPocStCurrAfter.
3187 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3188 /** \brief RefPicSetLtCurr of HEVC spec variable
3189 * Number of ReferenceFrames[] entries with this bit set equals
3192 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3194 #include <va/va_dec_hevc.h>
3195 #include <va/va_dec_jpeg.h>
3196 #include <va/va_dec_vp8.h>
3197 #include <va/va_dec_vp9.h>
3198 #include <va/va_enc_hevc.h>
3199 #include <va/va_enc_h264.h>
3200 #include <va/va_enc_jpeg.h>
3201 #include <va/va_enc_mpeg2.h>
3202 #include <va/va_enc_vp8.h>
3203 #include <va/va_enc_vp9.h>
3204 #include <va/va_fei.h>
3205 #include <va/va_fei_h264.h>
3206 #include <va/va_vpp.h>