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
241 unsigned short width;
242 unsigned short height;
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 unsigned int 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
622 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
623 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
624 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
625 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
628 /** @name Attribute values for VAConfigAttribEncInterlaced */
630 /** \brief Driver does not support interlaced coding. */
631 #define VA_ENC_INTERLACED_NONE 0x00000000
632 /** \brief Driver supports interlaced frame coding. */
633 #define VA_ENC_INTERLACED_FRAME 0x00000001
634 /** \brief Driver supports interlaced field coding. */
635 #define VA_ENC_INTERLACED_FIELD 0x00000002
636 /** \brief Driver supports macroblock adaptive frame field coding. */
637 #define VA_ENC_INTERLACED_MBAFF 0x00000004
638 /** \brief Driver supports picture adaptive frame field coding. */
639 #define VA_ENC_INTERLACED_PAFF 0x00000008
642 /** @name Attribute values for VAConfigAttribEncSliceStructure */
644 /** \brief Driver supports an arbitrary number of rows per slice. */
645 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
646 /** \brief Driver supports a power-of-two number of rows per slice. */
647 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
648 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
649 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
652 /** \brief Attribute value for VAConfigAttribEncJPEG */
653 typedef union _VAConfigAttribValEncJPEG {
655 /** \brief set to 1 for arithmatic coding. */
656 unsigned int arithmatic_coding_mode : 1;
657 /** \brief set to 1 for progressive dct. */
658 unsigned int progressive_dct_mode : 1;
659 /** \brief set to 1 for non-interleaved. */
660 unsigned int non_interleaved_mode : 1;
661 /** \brief set to 1 for differential. */
662 unsigned int differential_mode : 1;
663 unsigned int max_num_components : 3;
664 unsigned int max_num_scans : 4;
665 unsigned int max_num_huffman_tables : 3;
666 unsigned int max_num_quantization_tables : 3;
669 } VAConfigAttribValEncJPEG;
671 /** \brief Attribute value for VAConfigAttribEncROI */
672 typedef union _VAConfigAttribValEncROI {
674 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
675 unsigned int num_roi_regions : 8;
677 * \brief A flag indicates whether ROI priority is supported
679 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
680 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
681 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
682 * the underlying driver doesn't support ROI priority.
684 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
685 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
687 unsigned int roi_rc_priority_support : 1;
689 * \brief A flag indicates whether ROI delta QP is supported
691 * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
692 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
693 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
694 * the underlying driver doesn't support ROI delta QP.
696 * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
697 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
699 unsigned int roi_rc_qp_delta_support : 1;
700 unsigned int reserved : 22;
703 } VAConfigAttribValEncROI;
705 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
706 typedef union _VAConfigAttribValEncRateControlExt {
709 * \brief The maximum number of temporal layers minus 1
711 * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
712 * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
713 * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
715 unsigned int max_num_temporal_layers_minus1 : 8;
718 * /brief support temporal layer bit-rate control flag
720 * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
721 * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
722 * #VAConfigAttribRateControl == #VA_RC_VBR).
724 * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
725 * \c max_num_temporal_layers_minus1 is equal to 0
727 * To use bit-rate control per temporal layer, an application must send the right layer
728 * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
729 * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
730 * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
731 * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
732 * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
733 * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
734 * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
736 * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
737 * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
738 * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
740 unsigned int temporal_layer_bitrate_control_flag : 1;
741 unsigned int reserved : 23;
744 } VAConfigAttribValEncRateControlExt;
747 * if an attribute is not applicable for a given
748 * profile/entrypoint pair, then set the value to the following
750 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
752 /** Get maximum number of profiles supported by the implementation */
753 int vaMaxNumProfiles (
757 /** Get maximum number of entrypoints supported by the implementation */
758 int vaMaxNumEntrypoints (
762 /** Get maximum number of attributs supported by the implementation */
763 int vaMaxNumConfigAttributes (
768 * Query supported profiles
769 * The caller must provide a "profile_list" array that can hold at
770 * least vaMaxNumProfile() entries. The actual number of profiles
771 * returned in "profile_list" is returned in "num_profile".
773 VAStatus vaQueryConfigProfiles (
775 VAProfile *profile_list, /* out */
776 int *num_profiles /* out */
780 * Query supported entrypoints for a given profile
781 * The caller must provide an "entrypoint_list" array that can hold at
782 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
783 * returned in "entrypoint_list" is returned in "num_entrypoints".
785 VAStatus vaQueryConfigEntrypoints (
788 VAEntrypoint *entrypoint_list, /* out */
789 int *num_entrypoints /* out */
793 * Get attributes for a given profile/entrypoint pair
794 * The caller must provide an "attrib_list" with all attributes to be
795 * retrieved. Upon return, the attributes in "attrib_list" have been
796 * updated with their value. Unknown attributes or attributes that are
797 * not supported for the given profile/entrypoint pair will have their
798 * value set to VA_ATTRIB_NOT_SUPPORTED
800 VAStatus vaGetConfigAttributes (
803 VAEntrypoint entrypoint,
804 VAConfigAttrib *attrib_list, /* in/out */
808 /** Generic ID type, can be re-typed for specific implementation */
809 typedef unsigned int VAGenericID;
811 typedef VAGenericID VAConfigID;
814 * Create a configuration for the decode pipeline
815 * it passes in the attribute list that specifies the attributes it cares
816 * about, with the rest taking default values.
818 VAStatus vaCreateConfig (
821 VAEntrypoint entrypoint,
822 VAConfigAttrib *attrib_list,
824 VAConfigID *config_id /* out */
828 * Free resources associdated with a given config
830 VAStatus vaDestroyConfig (
836 * Query all attributes for a given configuration
837 * The profile of the configuration is returned in "profile"
838 * The entrypoint of the configuration is returned in "entrypoint"
839 * The caller must provide an "attrib_list" array that can hold at least
840 * vaMaxNumConfigAttributes() entries. The actual number of attributes
841 * returned in "attrib_list" is returned in "num_attribs"
843 VAStatus vaQueryConfigAttributes (
845 VAConfigID config_id,
846 VAProfile *profile, /* out */
847 VAEntrypoint *entrypoint, /* out */
848 VAConfigAttrib *attrib_list,/* out */
849 int *num_attribs /* out */
854 * Contexts and Surfaces
856 * Context represents a "virtual" video decode pipeline. Surfaces are render
857 * targets for a given context. The data in the surfaces are not accessible
858 * to the client and the internal data format of the surface is implementatin
861 * Surfaces will be bound to a context when the context is created. Once
862 * a surface is bound to a given context, it can not be used to create
863 * another context. The association is removed when the context is destroyed
865 * Both contexts and surfaces are identified by unique IDs and its
866 * implementation specific internals are kept opaque to the clients
869 typedef VAGenericID VAContextID;
871 typedef VAGenericID VASurfaceID;
873 #define VA_INVALID_ID 0xffffffff
874 #define VA_INVALID_SURFACE VA_INVALID_ID
876 /** \brief Generic value types. */
878 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
879 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
880 VAGenericValueTypePointer, /**< Generic pointer type */
881 VAGenericValueTypeFunc /**< Pointer to function */
882 } VAGenericValueType;
884 /** \brief Generic function type. */
885 typedef void (*VAGenericFunc)(void);
887 /** \brief Generic value. */
888 typedef struct _VAGenericValue {
889 /** \brief Value type. See #VAGenericValueType. */
890 VAGenericValueType type;
891 /** \brief Value holder. */
893 /** \brief 32-bit signed integer. */
895 /** \brief 32-bit float. */
897 /** \brief Generic pointer. */
899 /** \brief Pointer to function. */
904 /** @name Surface attribute flags */
906 /** \brief Surface attribute is not supported. */
907 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
908 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
909 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
910 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
911 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
914 /** \brief Surface attribute types. */
916 VASurfaceAttribNone = 0,
918 * \brief Pixel format (fourcc).
920 * The value is meaningful as input to vaQuerySurfaceAttributes().
921 * If zero, the driver returns the optimal pixel format for the
922 * specified config. Otherwise, if non-zero, the value represents
923 * a pixel format (FOURCC) that is kept as is on output, if the
924 * driver supports it. Otherwise, the driver sets the value to
925 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
927 VASurfaceAttribPixelFormat,
928 /** \brief Minimal width in pixels (int, read-only). */
929 VASurfaceAttribMinWidth,
930 /** \brief Maximal width in pixels (int, read-only). */
931 VASurfaceAttribMaxWidth,
932 /** \brief Minimal height in pixels (int, read-only). */
933 VASurfaceAttribMinHeight,
934 /** \brief Maximal height in pixels (int, read-only). */
935 VASurfaceAttribMaxHeight,
936 /** \brief Surface memory type expressed in bit fields (int, read/write). */
937 VASurfaceAttribMemoryType,
938 /** \brief External buffer descriptor (pointer, write). */
939 VASurfaceAttribExternalBufferDescriptor,
940 /** \brief Surface usage hint, gives the driver a hint of intended usage
941 * to optimize allocation (e.g. tiling) (int, read/write). */
942 VASurfaceAttribUsageHint,
943 /** \brief Number of surface attributes. */
945 } VASurfaceAttribType;
947 /** \brief Surface attribute. */
948 typedef struct _VASurfaceAttrib {
950 VASurfaceAttribType type;
951 /** \brief Flags. See "Surface attribute flags". */
953 /** \brief Value. See "Surface attribute types" for the expected types. */
954 VAGenericValue value;
958 * @name VASurfaceAttribMemoryType values in bit fields.
959 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
960 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
961 * types are defined in DRM and Android header files.
964 /** \brief VA memory type (default) is supported. */
965 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
966 /** \brief V4L2 buffer memory type is supported. */
967 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
968 /** \brief User pointer memory type is supported. */
969 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
973 * \brief VASurfaceAttribExternalBuffers structure for
974 * the VASurfaceAttribExternalBufferDescriptor attribute.
976 typedef struct _VASurfaceAttribExternalBuffers {
977 /** \brief pixel format in fourcc. */
978 unsigned int pixel_format;
979 /** \brief width in pixels. */
981 /** \brief height in pixels. */
983 /** \brief total size of the buffer in bytes. */
984 unsigned int data_size;
985 /** \brief number of planes for planar layout */
986 unsigned int num_planes;
987 /** \brief pitch for each plane in bytes */
988 unsigned int pitches[4];
989 /** \brief offset for each plane in bytes */
990 unsigned int offsets[4];
991 /** \brief buffer handles or user pointers */
992 unsigned long *buffers;
993 /** \brief number of elements in the "buffers" array */
994 unsigned int num_buffers;
995 /** \brief flags. See "Surface external buffer descriptor flags". */
997 /** \brief reserved for passing private data */
999 } VASurfaceAttribExternalBuffers;
1001 /** @name VASurfaceAttribExternalBuffers flags */
1003 /** \brief Enable memory tiling */
1004 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
1005 /** \brief Memory is cacheable */
1006 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
1007 /** \brief Memory is non-cacheable */
1008 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
1009 /** \brief Memory is write-combined */
1010 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
1011 /** \brief Memory is protected */
1012 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
1014 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1016 /** \brief Surface usage not indicated. */
1017 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
1018 /** \brief Surface used by video decoder. */
1019 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
1020 /** \brief Surface used by video encoder. */
1021 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
1022 /** \brief Surface read by video post-processing. */
1023 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
1024 /** \brief Surface written by video post-processing. */
1025 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
1026 /** \brief Surface used for display. */
1027 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
1032 * \brief Queries surface attributes for the supplied config.
1034 * Unlike vaGetSurfaceAttributes(), this function queries for all
1035 * supported attributes for the supplied VA @config. In particular, if
1036 * the underlying hardware supports the creation of VA surfaces in
1037 * various formats, then this function will enumerate all pixel
1038 * formats that are supported.
1040 * The \c attrib_list array is allocated by the user and \c
1041 * num_attribs shall be initialized to the number of allocated
1042 * elements in that array. Upon successful return, the actual number
1043 * of attributes will be overwritten into \c num_attribs. Otherwise,
1044 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1045 * is adjusted to the number of elements that would be returned if
1046 * enough space was available.
1048 * Note: it is perfectly valid to pass NULL to the \c attrib_list
1049 * argument when vaQuerySurfaceAttributes() is used to determine the
1050 * actual number of elements that need to be allocated.
1052 * @param[in] dpy the VA display
1053 * @param[in] config the config identifying a codec or a video
1054 * processing pipeline
1055 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
1056 * @param[in,out] num_attribs the number of elements allocated on
1057 * input, the number of elements actually filled in output
1060 vaQuerySurfaceAttributes(
1063 VASurfaceAttrib *attrib_list,
1064 unsigned int *num_attribs
1068 * \brief Creates an array of surfaces
1070 * Creates an array of surfaces. The optional list of attributes shall
1071 * be constructed and validated through vaGetSurfaceAttributes() or
1072 * constructed based based on what the underlying hardware could
1073 * expose through vaQuerySurfaceAttributes().
1075 * @param[in] dpy the VA display
1076 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
1077 * @param[in] width the surface width
1078 * @param[in] height the surface height
1079 * @param[out] surfaces the array of newly created surfaces
1080 * @param[in] num_surfaces the number of surfaces to create
1081 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
1082 * @param[in] num_attribs the number of attributes supplied in
1083 * \c attrib_list, or zero
1088 unsigned int format,
1090 unsigned int height,
1091 VASurfaceID *surfaces,
1092 unsigned int num_surfaces,
1093 VASurfaceAttrib *attrib_list,
1094 unsigned int num_attribs
1098 * vaDestroySurfaces - Destroy resources associated with surfaces.
1099 * Surfaces can only be destroyed after the context associated has been
1102 * surfaces: array of surfaces to destroy
1103 * num_surfaces: number of surfaces in the array to be destroyed.
1105 VAStatus vaDestroySurfaces (
1107 VASurfaceID *surfaces,
1111 #define VA_PROGRESSIVE 0x1
1113 * vaCreateContext - Create a context
1115 * config_id: configuration for the context
1116 * picture_width: coded picture width
1117 * picture_height: coded picture height
1118 * flag: any combination of the following:
1119 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1120 * render_targets: render targets (surfaces) tied to the context
1121 * num_render_targets: number of render targets in the above array
1122 * context: created context id upon return
1124 VAStatus vaCreateContext (
1126 VAConfigID config_id,
1130 VASurfaceID *render_targets,
1131 int num_render_targets,
1132 VAContextID *context /* out */
1136 * vaDestroyContext - Destroy a context
1138 * context: context to be destroyed
1140 VAStatus vaDestroyContext (
1147 * Buffers are used to pass various types of data from the
1148 * client to the server. The server maintains a data store
1149 * for each buffer created, and the client idenfies a buffer
1150 * through a unique buffer id assigned by the server.
1153 typedef VAGenericID VABufferID;
1157 VAPictureParameterBufferType = 0,
1158 VAIQMatrixBufferType = 1,
1159 VABitPlaneBufferType = 2,
1160 VASliceGroupMapBufferType = 3,
1161 VASliceParameterBufferType = 4,
1162 VASliceDataBufferType = 5,
1163 VAMacroblockParameterBufferType = 6,
1164 VAResidualDataBufferType = 7,
1165 VADeblockingParameterBufferType = 8,
1166 VAImageBufferType = 9,
1167 VAProtectedSliceDataBufferType = 10,
1168 VAQMatrixBufferType = 11,
1169 VAHuffmanTableBufferType = 12,
1170 VAProbabilityBufferType = 13,
1172 /* Following are encode buffer types */
1173 VAEncCodedBufferType = 21,
1174 VAEncSequenceParameterBufferType = 22,
1175 VAEncPictureParameterBufferType = 23,
1176 VAEncSliceParameterBufferType = 24,
1177 VAEncPackedHeaderParameterBufferType = 25,
1178 VAEncPackedHeaderDataBufferType = 26,
1179 VAEncMiscParameterBufferType = 27,
1180 VAEncMacroblockParameterBufferType = 28,
1181 VAEncMacroblockMapBufferType = 29,
1184 * \brief Encoding QP buffer
1186 * This buffer contains QP per MB for encoding. Currently
1187 * VAEncQPBufferH264 is defined for H.264 encoding, see
1188 * #VAEncQPBufferH264 for details
1190 VAEncQPBufferType = 30,
1191 /* Following are video processing buffer types */
1193 * \brief Video processing pipeline parameter buffer.
1195 * This buffer describes the video processing pipeline. See
1196 * #VAProcPipelineParameterBuffer for details.
1198 VAProcPipelineParameterBufferType = 41,
1200 * \brief Video filter parameter buffer.
1202 * This buffer describes the video filter parameters. All buffers
1203 * inherit from #VAProcFilterParameterBufferBase, thus including
1204 * a unique filter buffer type.
1206 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1207 * Filters requiring advanced parameters include, but are not limited to,
1208 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1209 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1211 VAProcFilterParameterBufferType = 42,
1213 * \brief FEI specific buffer types
1215 VAEncFEIMVBufferType = 43,
1216 VAEncFEIMBCodeBufferType = 44,
1217 VAEncFEIDistortionBufferType = 45,
1218 VAEncFEIMBControlBufferType = 46,
1219 VAEncFEIMVPredictorBufferType = 47,
1225 VAEncMiscParameterTypeFrameRate = 0,
1226 VAEncMiscParameterTypeRateControl = 1,
1227 VAEncMiscParameterTypeMaxSliceSize = 2,
1228 VAEncMiscParameterTypeAIR = 3,
1229 /** \brief Buffer type used to express a maximum frame size (in bits). */
1230 VAEncMiscParameterTypeMaxFrameSize = 4,
1231 /** \brief Buffer type used for HRD parameters. */
1232 VAEncMiscParameterTypeHRD = 5,
1233 VAEncMiscParameterTypeQualityLevel = 6,
1234 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1235 * rate control, when the user has externally skipped frames. */
1236 VAEncMiscParameterTypeSkipFrame = 9,
1237 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1238 VAEncMiscParameterTypeROI = 10,
1239 /** \brief Buffer type used for temporal layer structure */
1240 VAEncMiscParameterTypeTemporalLayerStructure = 12,
1241 /** \brief Buffer type used for FEI input frame level parameters */
1242 VAEncMiscParameterTypeFEIFrameControl = 18,
1243 } VAEncMiscParameterType;
1245 /** \brief Packed header type. */
1247 /** \brief Packed sequence header. */
1248 VAEncPackedHeaderSequence = 1,
1249 /** \brief Packed picture header. */
1250 VAEncPackedHeaderPicture = 2,
1251 /** \brief Packed slice header. */
1252 VAEncPackedHeaderSlice = 3,
1254 * \brief Packed raw header.
1256 * Packed raw data header can be used by the client to insert a header
1257 * into the bitstream data buffer at the point it is passed, the driver
1258 * will handle the raw packed header based on "has_emulation_bytes" field
1259 * in the packed header parameter structure.
1261 VAEncPackedHeaderRawData = 4,
1262 /** \brief Misc packed header. See codec-specific definitions. */
1263 VAEncPackedHeaderMiscMask = 0x80000000,
1264 } VAEncPackedHeaderType;
1266 /** \brief Packed header parameter. */
1267 typedef struct _VAEncPackedHeaderParameterBuffer {
1268 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1270 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1271 unsigned int bit_length;
1272 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1273 unsigned char has_emulation_bytes;
1274 } VAEncPackedHeaderParameterBuffer;
1277 * For application, e.g. set a new bitrate
1278 * VABufferID buf_id;
1279 * VAEncMiscParameterBuffer *misc_param;
1280 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1282 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1283 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1284 * 1, NULL, &buf_id);
1286 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1287 * misc_param->type = VAEncMiscParameterTypeRateControl;
1288 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1289 * misc_rate_ctrl->bits_per_second = 6400000;
1290 * vaUnmapBuffer(dpy, buf_id);
1291 * vaRenderPicture(dpy, context, &buf_id, 1);
1293 typedef struct _VAEncMiscParameterBuffer
1295 VAEncMiscParameterType type;
1296 unsigned int data[];
1297 } VAEncMiscParameterBuffer;
1299 /** \brief Temporal layer Structure*/
1300 typedef struct _VAEncMiscParameterTemporalLayerStructure
1302 /** \brief The number of temporal layers */
1303 unsigned int number_of_layers;
1304 /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1305 unsigned int periodicity;
1307 * \brief The array indicating the layer id for each frame
1309 * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1310 * ids for frames starting from the 2nd frame.
1312 unsigned int layer_id[32];
1313 } VAEncMiscParameterTemporalLayerStructure;
1316 /** \brief Rate control parameters */
1317 typedef struct _VAEncMiscParameterRateControl
1319 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1320 unsigned int bits_per_second;
1321 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1322 * bit-rate for example if target_percentage is 95 then the rate control will target
1323 * a bit-rate that is 95% of the maximum bit-rate
1325 unsigned int target_percentage;
1326 /* windows size in milliseconds. For example if this is set to 500,
1327 * then the rate control will guarantee the target bit-rate over a 500 ms window
1329 unsigned int window_size;
1330 /* initial QP at I frames */
1331 unsigned int initial_qp;
1332 unsigned int min_qp;
1333 unsigned int basic_unit_size;
1338 unsigned int reset : 1;
1339 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1340 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1341 unsigned int mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1343 * The temporal layer that the rate control parameters are specified for.
1345 unsigned int temporal_id : 8;
1346 unsigned int reserved : 17;
1350 } VAEncMiscParameterRateControl;
1352 typedef struct _VAEncMiscParameterFrameRate
1355 * The framerate is specified as a number of frames per second, as a
1356 * fraction. The denominator of the fraction is given in the top half
1357 * (the high two bytes) of the framerate field, and the numerator is
1358 * given in the bottom half (the low two bytes).
1361 * denominator = framerate >> 16 & 0xffff;
1362 * numerator = framerate & 0xffff;
1363 * fps = numerator / denominator;
1365 * For example, if framerate is set to (100 << 16 | 750), this is
1366 * 750 / 100, hence 7.5fps.
1368 * If the denominator is zero (the high two bytes are both zero) then
1369 * it takes the value one instead, so the framerate is just the integer
1370 * in the low 2 bytes.
1372 unsigned int framerate;
1378 * The temporal id the framerate parameters are specified for.
1380 unsigned int temporal_id : 8;
1381 unsigned int reserved : 24;
1385 } VAEncMiscParameterFrameRate;
1388 * Allow a maximum slice size to be specified (in bits).
1389 * The encoder will attempt to make sure that individual slices do not exceed this size
1390 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1392 typedef struct _VAEncMiscParameterMaxSliceSize
1394 unsigned int max_slice_size;
1395 } VAEncMiscParameterMaxSliceSize;
1397 typedef struct _VAEncMiscParameterAIR
1399 unsigned int air_num_mbs;
1400 unsigned int air_threshold;
1401 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1402 } VAEncMiscParameterAIR;
1404 typedef struct _VAEncMiscParameterHRD
1406 unsigned int initial_buffer_fullness; /* in bits */
1407 unsigned int buffer_size; /* in bits */
1408 } VAEncMiscParameterHRD;
1411 * \brief Defines a maximum frame size (in bits).
1413 * This misc parameter buffer defines the maximum size of a frame (in
1414 * bits). The encoder will try to make sure that each frame does not
1415 * exceed this size. Otherwise, if the frame size exceeds this size,
1416 * the \c status flag of #VACodedBufferSegment will contain
1417 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1419 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1420 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1421 VAEncMiscParameterType type;
1422 /** \brief Maximum size of a frame (in bits). */
1423 unsigned int max_frame_size;
1424 } VAEncMiscParameterBufferMaxFrameSize;
1427 * \brief Encoding quality level.
1429 * The encoding quality could be set through this structure, if the implementation
1430 * supports multiple quality levels. The quality level set through this structure is
1431 * persistent over the entire coded sequence, or until a new structure is being sent.
1432 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1433 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1434 * quality. The quality level setting is used as a trade-off between quality and speed/power
1435 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1437 typedef struct _VAEncMiscParameterBufferQualityLevel {
1438 /** \brief Encoding quality level setting. When set to 0, default quality
1441 unsigned int quality_level;
1442 } VAEncMiscParameterBufferQualityLevel;
1445 * \brief Encoding skip frame.
1447 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1448 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1449 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1450 * current frame. It is allowed for the application to still send in packed headers for the driver to
1451 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1453 typedef struct _VAEncMiscParameterSkipFrame {
1454 /** \brief Indicates skip frames as below.
1455 * 0: Encode as normal, no skip.
1456 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1457 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1458 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1459 * in VAEncPackedHeaderPicture). */
1460 unsigned char skip_frame_flag;
1461 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1462 unsigned char num_skip_frames;
1463 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1464 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1465 unsigned int size_skip_frames;
1466 } VAEncMiscParameterSkipFrame;
1469 * \brief Encoding region-of-interest (ROI).
1471 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1472 * supports ROI input. The ROI set through this structure is applicable only to the
1473 * current frame or field, so must be sent every frame or field to be applied. The number of
1474 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1475 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1477 typedef struct _VAEncROI
1479 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1480 * codec coding units. It is relative to frame coordinates for the frame case and
1481 * to field coordinates for the field case. */
1482 VARectangle roi_rectangle;
1486 * \ref roi_value specifies ROI delta QP or ROI priority.
1487 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1488 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1489 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1490 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1491 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1492 * regions, the roi_value that is first in the ROI array will have priority.
1494 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1495 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1497 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1498 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1499 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1504 typedef struct _VAEncMiscParameterBufferROI {
1505 /** \brief Number of ROIs being sent.*/
1506 unsigned int num_roi;
1508 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1509 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1514 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1515 * coordinates for the frame case and to field coordinates for the field case.*/
1520 * \brief An indication for roi value.
1522 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1523 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1524 * in #VAEncROI should be used as ROI priority.
1526 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1527 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
1528 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1529 * when VAConfigAttribRateControl == VA_RC_CQP.
1531 uint32_t roi_value_is_qp_delta : 1;
1532 uint32_t reserved : 31;
1536 } VAEncMiscParameterBufferROI;
1539 * There will be cases where the bitstream buffer will not have enough room to hold
1540 * the data for the entire slice, and the following flags will be used in the slice
1541 * parameter to signal to the server for the possible cases.
1542 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1543 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1544 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1546 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1547 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1548 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1549 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1551 /* Codec-independent Slice Parameter Buffer base */
1552 typedef struct _VASliceParameterBufferBase
1554 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1555 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1556 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1557 } VASliceParameterBufferBase;
1559 /**********************************
1560 * JPEG common data structures
1561 **********************************/
1563 * \brief Huffman table for JPEG decoding.
1565 * This structure holds the complete Huffman tables. This is an
1566 * aggregation of all Huffman table (DHT) segments maintained by the
1567 * application. i.e. up to 2 Huffman tables are stored in there for
1570 * The #load_huffman_table array can be used as a hint to notify the
1571 * VA driver implementation about which table(s) actually changed
1572 * since the last submission of this buffer.
1574 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1575 /** \brief Specifies which #huffman_table is valid. */
1576 unsigned char load_huffman_table[2];
1577 /** \brief Huffman tables indexed by table identifier (Th). */
1579 /** @name DC table (up to 12 categories) */
1581 /** \brief Number of Huffman codes of length i + 1 (Li). */
1582 unsigned char num_dc_codes[16];
1583 /** \brief Value associated with each Huffman code (Vij). */
1584 unsigned char dc_values[12];
1586 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1588 /** \brief Number of Huffman codes of length i + 1 (Li). */
1589 unsigned char num_ac_codes[16];
1590 /** \brief Value associated with each Huffman code (Vij). */
1591 unsigned char ac_values[162];
1592 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1593 unsigned char pad[2];
1596 } VAHuffmanTableBufferJPEGBaseline;
1598 /****************************
1599 * MPEG-2 data structures
1600 ****************************/
1602 /* MPEG-2 Picture Parameter Buffer */
1604 * For each frame or field, and before any slice data, a single
1605 * picture parameter buffer must be send.
1607 typedef struct _VAPictureParameterBufferMPEG2
1609 unsigned short horizontal_size;
1610 unsigned short vertical_size;
1611 VASurfaceID forward_reference_picture;
1612 VASurfaceID backward_reference_picture;
1613 /* meanings of the following fields are the same as in the standard */
1614 int picture_coding_type;
1615 int f_code; /* pack all four fcode into this */
1618 unsigned int intra_dc_precision : 2;
1619 unsigned int picture_structure : 2;
1620 unsigned int top_field_first : 1;
1621 unsigned int frame_pred_frame_dct : 1;
1622 unsigned int concealment_motion_vectors : 1;
1623 unsigned int q_scale_type : 1;
1624 unsigned int intra_vlc_format : 1;
1625 unsigned int alternate_scan : 1;
1626 unsigned int repeat_first_field : 1;
1627 unsigned int progressive_frame : 1;
1628 unsigned int is_first_field : 1; /* indicate whether the current field
1629 * is the first field for field picture
1633 } picture_coding_extension;
1634 } VAPictureParameterBufferMPEG2;
1636 /** MPEG-2 Inverse Quantization Matrix Buffer */
1637 typedef struct _VAIQMatrixBufferMPEG2
1639 /** \brief Same as the MPEG-2 bitstream syntax element. */
1640 int load_intra_quantiser_matrix;
1641 /** \brief Same as the MPEG-2 bitstream syntax element. */
1642 int load_non_intra_quantiser_matrix;
1643 /** \brief Same as the MPEG-2 bitstream syntax element. */
1644 int load_chroma_intra_quantiser_matrix;
1645 /** \brief Same as the MPEG-2 bitstream syntax element. */
1646 int load_chroma_non_intra_quantiser_matrix;
1647 /** \brief Luminance intra matrix, in zig-zag scan order. */
1648 unsigned char intra_quantiser_matrix[64];
1649 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1650 unsigned char non_intra_quantiser_matrix[64];
1651 /** \brief Chroma intra matrix, in zig-zag scan order. */
1652 unsigned char chroma_intra_quantiser_matrix[64];
1653 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1654 unsigned char chroma_non_intra_quantiser_matrix[64];
1655 } VAIQMatrixBufferMPEG2;
1657 /** MPEG-2 Slice Parameter Buffer */
1658 typedef struct _VASliceParameterBufferMPEG2
1660 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1661 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1662 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1663 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1664 unsigned int slice_horizontal_position;
1665 unsigned int slice_vertical_position;
1666 int quantiser_scale_code;
1667 int intra_slice_flag;
1668 } VASliceParameterBufferMPEG2;
1670 /** MPEG-2 Macroblock Parameter Buffer */
1671 typedef struct _VAMacroblockParameterBufferMPEG2
1673 unsigned short macroblock_address;
1675 * macroblock_address (in raster scan order)
1677 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1679 unsigned char macroblock_type; /* see definition below */
1682 unsigned int frame_motion_type : 2;
1683 unsigned int field_motion_type : 2;
1684 unsigned int dct_type : 1;
1688 unsigned char motion_vertical_field_select;
1690 * motion_vertical_field_select:
1691 * see section 6.3.17.2 in the spec
1692 * only the lower 4 bits are used
1693 * bit 0: first vector forward
1694 * bit 1: first vector backward
1695 * bit 2: second vector forward
1696 * bit 3: second vector backward
1698 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1699 unsigned short coded_block_pattern;
1701 * The bitplanes for coded_block_pattern are described
1702 * in Figure 6.10-12 in the spec
1705 /* Number of skipped macroblocks after this macroblock */
1706 unsigned short num_skipped_macroblocks;
1707 } VAMacroblockParameterBufferMPEG2;
1710 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1712 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1713 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1714 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1715 #define VA_MB_TYPE_MOTION_INTRA 0x10
1718 * MPEG-2 Residual Data Buffer
1719 * For each macroblock, there wil be 64 shorts (16-bit) in the
1720 * residual data buffer
1723 /****************************
1724 * MPEG-4 Part 2 data structures
1725 ****************************/
1727 /* MPEG-4 Picture Parameter Buffer */
1729 * For each frame or field, and before any slice data, a single
1730 * picture parameter buffer must be send.
1732 typedef struct _VAPictureParameterBufferMPEG4
1734 unsigned short vop_width;
1735 unsigned short vop_height;
1736 VASurfaceID forward_reference_picture;
1737 VASurfaceID backward_reference_picture;
1740 unsigned int short_video_header : 1;
1741 unsigned int chroma_format : 2;
1742 unsigned int interlaced : 1;
1743 unsigned int obmc_disable : 1;
1744 unsigned int sprite_enable : 2;
1745 unsigned int sprite_warping_accuracy : 2;
1746 unsigned int quant_type : 1;
1747 unsigned int quarter_sample : 1;
1748 unsigned int data_partitioned : 1;
1749 unsigned int reversible_vlc : 1;
1750 unsigned int resync_marker_disable : 1;
1754 unsigned char no_of_sprite_warping_points;
1755 short sprite_trajectory_du[3];
1756 short sprite_trajectory_dv[3];
1757 unsigned char quant_precision;
1760 unsigned int vop_coding_type : 2;
1761 unsigned int backward_reference_vop_coding_type : 2;
1762 unsigned int vop_rounding_type : 1;
1763 unsigned int intra_dc_vlc_thr : 3;
1764 unsigned int top_field_first : 1;
1765 unsigned int alternate_vertical_scan_flag : 1;
1769 unsigned char vop_fcode_forward;
1770 unsigned char vop_fcode_backward;
1771 unsigned short vop_time_increment_resolution;
1772 /* short header related */
1773 unsigned char num_gobs_in_vop;
1774 unsigned char num_macroblocks_in_gob;
1775 /* for direct mode prediction */
1778 } VAPictureParameterBufferMPEG4;
1780 /** MPEG-4 Inverse Quantization Matrix Buffer */
1781 typedef struct _VAIQMatrixBufferMPEG4
1783 /** Same as the MPEG-4:2 bitstream syntax element. */
1784 int load_intra_quant_mat;
1785 /** Same as the MPEG-4:2 bitstream syntax element. */
1786 int load_non_intra_quant_mat;
1787 /** The matrix for intra blocks, in zig-zag scan order. */
1788 unsigned char intra_quant_mat[64];
1789 /** The matrix for non-intra blocks, in zig-zag scan order. */
1790 unsigned char non_intra_quant_mat[64];
1791 } VAIQMatrixBufferMPEG4;
1793 /** MPEG-4 Slice Parameter Buffer */
1794 typedef struct _VASliceParameterBufferMPEG4
1796 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1797 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1798 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1799 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1800 unsigned int macroblock_number;
1802 } VASliceParameterBufferMPEG4;
1805 VC-1 data structures
1808 typedef enum /* see 7.1.1.32 */
1811 VAMvMode1MvHalfPel = 1,
1812 VAMvMode1MvHalfPelBilinear = 2,
1813 VAMvModeMixedMv = 3,
1814 VAMvModeIntensityCompensation = 4
1817 /** VC-1 Picture Parameter Buffer */
1819 * For each picture, and before any slice data, a picture parameter
1820 * buffer must be send. Multiple picture parameter buffers may be
1821 * sent for a single picture. In that case picture parameters will
1822 * apply to all slice data that follow it until a new picture
1823 * parameter buffer is sent.
1826 * pic_quantizer_type should be set to the applicable quantizer
1827 * type as defined by QUANTIZER (J.1.19) and either
1828 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1830 typedef struct _VAPictureParameterBufferVC1
1832 VASurfaceID forward_reference_picture;
1833 VASurfaceID backward_reference_picture;
1834 /* if out-of-loop post-processing is done on the render
1835 target, then we need to keep the in-loop decoded
1836 picture as a reference picture */
1837 VASurfaceID inloop_decoded_picture;
1839 /* sequence layer for AP or meta data for SP and MP */
1842 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1843 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1844 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1845 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1846 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1847 unsigned int multires : 1; /* METADATA::MULTIRES */
1848 unsigned int overlap : 1; /* METADATA::OVERLAP */
1849 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1850 unsigned int rangered : 1; /* METADATA::RANGERED */
1851 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1852 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1857 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1858 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1861 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1862 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1863 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1864 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1867 } entrypoint_fields;
1868 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1869 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1872 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1873 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1874 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1875 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1878 } range_mapping_fields;
1880 unsigned char b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
1881 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1882 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1883 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1884 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1885 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1886 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1887 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1888 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1891 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1892 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1893 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1894 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1895 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1901 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1902 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1903 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1904 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1905 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1906 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1907 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1913 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1914 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1915 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1916 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1917 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1918 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1919 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1922 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1925 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1926 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1927 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1928 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1934 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1935 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1936 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1937 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1938 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1939 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1940 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1941 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1942 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1943 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1949 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1950 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1951 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1952 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1953 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1954 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1955 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1956 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1957 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1958 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1959 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1962 } pic_quantizer_fields;
1965 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1966 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1967 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1968 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1969 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1970 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1974 } VAPictureParameterBufferVC1;
1976 /** VC-1 Bitplane Buffer
1977 There will be at most three bitplanes coded in any picture header. To send
1978 the bitplane data more efficiently, each byte is divided in two nibbles, with
1979 each nibble carrying three bitplanes for one macroblock. The following table
1980 shows the bitplane data arrangement within each nibble based on the picture
1983 Picture Type Bit3 Bit2 Bit1 Bit0
1984 I or BI OVERFLAGS ACPRED FIELDTX
1985 P MYTYPEMB SKIPMB DIRECTMB
1986 B FORWARDMB SKIPMB DIRECTMB
1988 Within each byte, the lower nibble is for the first MB and the upper nibble is
1989 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1990 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1991 Macroblock #2 in the first row.
1994 /* VC-1 Slice Parameter Buffer */
1995 typedef struct _VASliceParameterBufferVC1
1997 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1998 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1999 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2000 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2001 unsigned int slice_vertical_position;
2002 } VASliceParameterBufferVC1;
2004 /* VC-1 Slice Data Buffer */
2006 This is simplely a buffer containing raw bit-stream bytes
2009 /****************************
2010 * H.264/AVC data structures
2011 ****************************/
2013 typedef struct _VAPictureH264
2015 VASurfaceID picture_id;
2016 unsigned int frame_idx;
2018 signed int TopFieldOrderCnt;
2019 signed int BottomFieldOrderCnt;
2021 /* flags in VAPictureH264 could be OR of the following */
2022 #define VA_PICTURE_H264_INVALID 0x00000001
2023 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
2024 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
2025 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
2026 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
2028 /** H.264 Picture Parameter Buffer */
2030 * For each picture, and before any slice data, a single
2031 * picture parameter buffer must be send.
2033 typedef struct _VAPictureParameterBufferH264
2035 VAPictureH264 CurrPic;
2036 VAPictureH264 ReferenceFrames[16]; /* in DPB */
2037 unsigned short picture_width_in_mbs_minus1;
2038 unsigned short picture_height_in_mbs_minus1;
2039 unsigned char bit_depth_luma_minus8;
2040 unsigned char bit_depth_chroma_minus8;
2041 unsigned char num_ref_frames;
2044 unsigned int chroma_format_idc : 2;
2045 unsigned int residual_colour_transform_flag : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2046 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
2047 unsigned int frame_mbs_only_flag : 1;
2048 unsigned int mb_adaptive_frame_field_flag : 1;
2049 unsigned int direct_8x8_inference_flag : 1;
2050 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
2051 unsigned int log2_max_frame_num_minus4 : 4;
2052 unsigned int pic_order_cnt_type : 2;
2053 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
2054 unsigned int delta_pic_order_always_zero_flag : 1;
2058 // FMO is not supported.
2059 va_deprecated unsigned char num_slice_groups_minus1;
2060 va_deprecated unsigned char slice_group_map_type;
2061 va_deprecated unsigned short slice_group_change_rate_minus1;
2062 signed char pic_init_qp_minus26;
2063 signed char pic_init_qs_minus26;
2064 signed char chroma_qp_index_offset;
2065 signed char second_chroma_qp_index_offset;
2068 unsigned int entropy_coding_mode_flag : 1;
2069 unsigned int weighted_pred_flag : 1;
2070 unsigned int weighted_bipred_idc : 2;
2071 unsigned int transform_8x8_mode_flag : 1;
2072 unsigned int field_pic_flag : 1;
2073 unsigned int constrained_intra_pred_flag : 1;
2074 unsigned int pic_order_present_flag : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2075 unsigned int deblocking_filter_control_present_flag : 1;
2076 unsigned int redundant_pic_cnt_present_flag : 1;
2077 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
2081 unsigned short frame_num;
2082 } VAPictureParameterBufferH264;
2084 /** H.264 Inverse Quantization Matrix Buffer */
2085 typedef struct _VAIQMatrixBufferH264
2087 /** \brief 4x4 scaling list, in raster scan order. */
2088 unsigned char ScalingList4x4[6][16];
2089 /** \brief 8x8 scaling list, in raster scan order. */
2090 unsigned char ScalingList8x8[2][64];
2091 } VAIQMatrixBufferH264;
2093 /** H.264 Slice Parameter Buffer */
2094 typedef struct _VASliceParameterBufferH264
2096 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
2097 /** \brief Byte offset to the NAL Header Unit for this slice. */
2098 unsigned int slice_data_offset;
2099 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2101 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2103 * This bit offset is relative to and includes the NAL unit byte
2104 * and represents the number of bits parsed in the slice_header()
2105 * after the removal of any emulation prevention bytes in
2106 * there. However, the slice data buffer passed to the hardware is
2107 * the original bitstream, thus including any emulation prevention
2110 unsigned short slice_data_bit_offset;
2111 unsigned short first_mb_in_slice;
2112 unsigned char slice_type;
2113 unsigned char direct_spatial_mv_pred_flag;
2114 unsigned char num_ref_idx_l0_active_minus1;
2115 unsigned char num_ref_idx_l1_active_minus1;
2116 unsigned char cabac_init_idc;
2117 char slice_qp_delta;
2118 unsigned char disable_deblocking_filter_idc;
2119 char slice_alpha_c0_offset_div2;
2120 char slice_beta_offset_div2;
2121 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
2122 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
2123 unsigned char luma_log2_weight_denom;
2124 unsigned char chroma_log2_weight_denom;
2125 unsigned char luma_weight_l0_flag;
2126 short luma_weight_l0[32];
2127 short luma_offset_l0[32];
2128 unsigned char chroma_weight_l0_flag;
2129 short chroma_weight_l0[32][2];
2130 short chroma_offset_l0[32][2];
2131 unsigned char luma_weight_l1_flag;
2132 short luma_weight_l1[32];
2133 short luma_offset_l1[32];
2134 unsigned char chroma_weight_l1_flag;
2135 short chroma_weight_l1[32][2];
2136 short chroma_offset_l1[32][2];
2137 } VASliceParameterBufferH264;
2139 /****************************
2140 * Common encode data structures
2141 ****************************/
2144 VAEncPictureTypeIntra = 0,
2145 VAEncPictureTypePredictive = 1,
2146 VAEncPictureTypeBidirectional = 2,
2149 /* Encode Slice Parameter Buffer */
2150 typedef struct _VAEncSliceParameterBuffer
2152 unsigned int start_row_number; /* starting MB row number for this slice */
2153 unsigned int slice_height; /* slice height measured in MB */
2156 unsigned int is_intra : 1;
2157 unsigned int disable_deblocking_filter_idc : 2;
2158 unsigned int uses_long_term_ref :1;
2159 unsigned int is_long_term_ref :1;
2163 } VAEncSliceParameterBuffer;
2166 /****************************
2167 * H.263 specific encode data structures
2168 ****************************/
2170 typedef struct _VAEncSequenceParameterBufferH263
2172 unsigned int intra_period;
2173 unsigned int bits_per_second;
2174 unsigned int frame_rate;
2175 unsigned int initial_qp;
2176 unsigned int min_qp;
2177 } VAEncSequenceParameterBufferH263;
2179 typedef struct _VAEncPictureParameterBufferH263
2181 VASurfaceID reference_picture;
2182 VASurfaceID reconstructed_picture;
2183 VABufferID coded_buf;
2184 unsigned short picture_width;
2185 unsigned short picture_height;
2186 VAEncPictureType picture_type;
2187 } VAEncPictureParameterBufferH263;
2189 /****************************
2190 * MPEG-4 specific encode data structures
2191 ****************************/
2193 typedef struct _VAEncSequenceParameterBufferMPEG4
2195 unsigned char profile_and_level_indication;
2196 unsigned int intra_period;
2197 unsigned int video_object_layer_width;
2198 unsigned int video_object_layer_height;
2199 unsigned int vop_time_increment_resolution;
2200 unsigned int fixed_vop_rate;
2201 unsigned int fixed_vop_time_increment;
2202 unsigned int bits_per_second;
2203 unsigned int frame_rate;
2204 unsigned int initial_qp;
2205 unsigned int min_qp;
2206 } VAEncSequenceParameterBufferMPEG4;
2208 typedef struct _VAEncPictureParameterBufferMPEG4
2210 VASurfaceID reference_picture;
2211 VASurfaceID reconstructed_picture;
2212 VABufferID coded_buf;
2213 unsigned short picture_width;
2214 unsigned short picture_height;
2215 unsigned int modulo_time_base; /* number of 1s */
2216 unsigned int vop_time_increment;
2217 VAEncPictureType picture_type;
2218 } VAEncPictureParameterBufferMPEG4;
2222 /** Buffer functions */
2225 * Creates a buffer for "num_elements" elements of "size" bytes and
2226 * initalize with "data".
2227 * if "data" is null, then the contents of the buffer data store
2229 * Basically there are two ways to get buffer data to the server side. One is
2230 * to call vaCreateBuffer() with a non-null "data", which results the data being
2231 * copied to the data store on the server side. A different method that
2232 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2233 * and then use vaMapBuffer() to map the data store from the server side to the
2234 * client address space for access.
2235 * The user must call vaDestroyBuffer() to destroy a buffer.
2236 * Note: image buffers are created by the library, not the client. Please see
2237 * vaCreateImage on how image buffers are managed.
2239 VAStatus vaCreateBuffer (
2241 VAContextID context,
2242 VABufferType type, /* in */
2243 unsigned int size, /* in */
2244 unsigned int num_elements, /* in */
2245 void *data, /* in */
2246 VABufferID *buf_id /* out */
2250 * Convey to the server how many valid elements are in the buffer.
2251 * e.g. if multiple slice parameters are being held in a single buffer,
2252 * this will communicate to the server the number of slice parameters
2253 * that are valid in the buffer.
2255 VAStatus vaBufferSetNumElements (
2257 VABufferID buf_id, /* in */
2258 unsigned int num_elements /* in */
2263 * device independent data structure for codedbuffer
2267 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2268 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2269 * enough for the encoder to attempt to limit its size.
2270 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2271 * exceeded the maximum slice size specified.
2272 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2273 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2274 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2276 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2277 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2278 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2279 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2280 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2282 * \brief The frame has exceeded the maximum requested size.
2284 * This flag indicates that the encoded frame size exceeds the value
2285 * specified through a misc parameter buffer of type
2286 * #VAEncMiscParameterTypeMaxFrameSize.
2288 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2289 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2292 * \brief The coded buffer segment contains a single NAL unit.
2294 * This flag indicates that the coded buffer segment contains a
2295 * single NAL unit. This flag might be useful to the user for
2296 * processing the coded buffer.
2298 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2301 * \brief Coded buffer segment.
2303 * #VACodedBufferSegment is an element of a linked list describing
2304 * some information on the coded buffer. The coded buffer segment
2305 * could contain either a single NAL unit, or more than one NAL unit.
2306 * It is recommended (but not required) to return a single NAL unit
2307 * in a coded buffer segment, and the implementation should set the
2308 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2310 typedef struct _VACodedBufferSegment {
2312 * \brief Size of the data buffer in this segment (in bytes).
2315 /** \brief Bit offset into the data buffer where the video data starts. */
2316 unsigned int bit_offset;
2317 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2318 unsigned int status;
2319 /** \brief Reserved for future use. */
2320 unsigned int reserved;
2321 /** \brief Pointer to the start of the data buffer. */
2324 * \brief Pointer to the next #VACodedBufferSegment element,
2325 * or \c NULL if there is none.
2328 } VACodedBufferSegment;
2331 * Map data store of the buffer into the client's address space
2332 * vaCreateBuffer() needs to be called with "data" set to NULL before
2333 * calling vaMapBuffer()
2335 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2336 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2338 VAStatus vaMapBuffer (
2340 VABufferID buf_id, /* in */
2341 void **pbuf /* out */
2345 * After client making changes to a mapped data store, it needs to
2346 * "Unmap" it to let the server know that the data is ready to be
2347 * consumed by the server
2349 VAStatus vaUnmapBuffer (
2351 VABufferID buf_id /* in */
2355 * After this call, the buffer is deleted and this buffer_id is no longer valid
2357 * A buffer can be re-used and sent to the server by another Begin/Render/End
2358 * sequence if vaDestroyBuffer() is not called with this buffer.
2360 * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
2361 * hardware accelerator can result in performance dropping.
2363 VAStatus vaDestroyBuffer (
2365 VABufferID buffer_id
2368 /** \brief VA buffer information */
2370 /** \brief Buffer handle */
2372 /** \brief Buffer type (See \ref VABufferType). */
2375 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2377 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2378 * to specify the set of memory types the caller is interested in.
2379 * On successful return from vaAcquireBufferHandle(), the field is
2380 * updated with the best matching memory type.
2383 /** \brief Size of the underlying buffer. */
2388 * \brief Acquires buffer handle for external API usage
2390 * Locks the VA buffer object \ref buf_id for external API usage like
2391 * EGL or OpenCL (OCL). This function is a synchronization point. This
2392 * means that any pending operation is guaranteed to be completed
2393 * prior to returning from the function.
2395 * If the referenced VA buffer object is the backing store of a VA
2396 * surface, then this function acts as if vaSyncSurface() on the
2397 * parent surface was called first.
2399 * The \ref VABufferInfo argument shall be zero'ed on input. On
2400 * successful output, the data structure is filled in with all the
2401 * necessary buffer level implementation details like handle, type,
2402 * memory type and memory size.
2404 * Note: the external API implementation, or the application, can
2405 * express the memory types it is interested in by filling in the \ref
2406 * mem_type field accordingly. On successful output, the memory type
2407 * that fits best the request and that was used is updated in the \ref
2408 * VABufferInfo data structure. If none of the supplied memory types
2409 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2410 * error is returned.
2412 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2413 * is called. Besides, no additional operation is allowed on any of
2414 * the buffer parent object until vaReleaseBufferHandle() is called.
2415 * e.g. decoding into a VA surface backed with the supplied VA buffer
2416 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2420 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2421 * does not support this interface
2422 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2423 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2424 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2425 * does not support exporting buffers of the specified type
2426 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2427 * memory types in \ref VABufferInfo.mem_type was supported
2429 * @param[in] dpy the VA display
2430 * @param[in] buf_id the VA buffer
2431 * @param[in,out] buf_info the associated VA buffer information
2432 * @return VA_STATUS_SUCCESS if successful
2435 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2438 * \brief Releases buffer after usage from external API
2440 * Unlocks the VA buffer object \ref buf_id from external API usage like
2441 * EGL or OpenCL (OCL). This function is a synchronization point. This
2442 * means that any pending operation is guaranteed to be completed
2443 * prior to returning from the function.
2445 * The \ref VABufferInfo argument shall point to the original data
2446 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2447 * This is necessary so that the VA driver implementation could
2448 * deallocate any resources that were needed.
2450 * In any case, returning from this function invalidates any contents
2451 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2452 * valid. Therefore, VA driver implementations are free to reset this
2453 * data structure to safe defaults.
2456 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2457 * does not support this interface
2458 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2459 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2460 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2461 * does not support exporting buffers of the specified type
2463 * @param[in] dpy the VA display
2464 * @param[in] buf_id the VA buffer
2465 * @return VA_STATUS_SUCCESS if successful
2468 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2471 Render (Decode) Pictures
2473 A picture represents either a frame or a field.
2475 The Begin/Render/End sequence sends the decode buffers to the server
2479 * Get ready to decode a picture to a target surface
2481 VAStatus vaBeginPicture (
2483 VAContextID context,
2484 VASurfaceID render_target
2488 * Send decode buffers to the server.
2490 VAStatus vaRenderPicture (
2492 VAContextID context,
2493 VABufferID *buffers,
2498 * Make the end of rendering for a picture.
2499 * The server should start processing all pending operations for this
2500 * surface. This call is non-blocking. The client can start another
2501 * Begin/Render/End sequence on a different render target.
2503 VAStatus vaEndPicture (
2515 * This function blocks until all pending operations on the render target
2516 * have been completed. Upon return it is safe to use the render target for a
2517 * different picture.
2519 VAStatus vaSyncSurface (
2521 VASurfaceID render_target
2526 VASurfaceRendering = 1, /* Rendering in progress */
2527 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2528 /* this status is useful if surface is used as the source */
2530 VASurfaceReady = 4, /* not being rendered or displayed */
2531 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2535 * Find out any pending ops on the render target
2537 VAStatus vaQuerySurfaceStatus (
2539 VASurfaceID render_target,
2540 VASurfaceStatus *status /* out */
2545 VADecodeSliceMissing = 0,
2546 VADecodeMBError = 1,
2547 } VADecodeErrorType;
2550 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2551 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2553 typedef struct _VASurfaceDecodeMBErrors
2555 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2556 unsigned int start_mb; /* start mb address with errors */
2557 unsigned int end_mb; /* end mb address with errors */
2558 VADecodeErrorType decode_error_type;
2559 } VASurfaceDecodeMBErrors;
2562 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2563 * it can call vaQuerySurfaceError to find out further details on the particular error.
2564 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2565 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2566 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2567 * The array is terminated if "status==-1" is detected.
2569 VAStatus vaQuerySurfaceError(
2571 VASurfaceID surface,
2572 VAStatus error_status,
2577 * Images and Subpictures
2578 * VAImage is used to either get the surface data to client memory, or
2579 * to copy image data in client memory to a surface.
2580 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2581 * is at the upper left corner with positive X to the right and positive Y down
2583 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2584 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2585 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2588 * Pre-defined fourcc codes
2590 #define VA_FOURCC_NV12 0x3231564E
2591 #define VA_FOURCC_AI44 0x34344149
2592 #define VA_FOURCC_RGBA 0x41424752
2593 #define VA_FOURCC_RGBX 0x58424752
2594 #define VA_FOURCC_BGRA 0x41524742
2595 #define VA_FOURCC_BGRX 0x58524742
2596 #define VA_FOURCC_ARGB 0x42475241
2597 #define VA_FOURCC_XRGB 0x42475258
2598 #define VA_FOURCC_ABGR 0x52474241
2599 #define VA_FOURCC_XBGR 0x52474258
2600 #define VA_FOURCC_UYVY 0x59565955
2601 #define VA_FOURCC_YUY2 0x32595559
2602 #define VA_FOURCC_AYUV 0x56555941
2603 #define VA_FOURCC_NV11 0x3131564e
2604 #define VA_FOURCC_YV12 0x32315659
2605 #define VA_FOURCC_P208 0x38303250
2606 #define VA_FOURCC_IYUV 0x56555949
2607 #define VA_FOURCC_YV24 0x34325659
2608 #define VA_FOURCC_YV32 0x32335659
2609 #define VA_FOURCC_Y800 0x30303859
2610 #define VA_FOURCC_IMC3 0x33434D49
2611 #define VA_FOURCC_411P 0x50313134
2612 #define VA_FOURCC_422H 0x48323234
2613 #define VA_FOURCC_422V 0x56323234
2614 #define VA_FOURCC_444P 0x50343434
2615 #define VA_FOURCC_RGBP 0x50424752
2616 #define VA_FOURCC_BGRP 0x50524742
2617 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2620 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
2622 #define VA_FOURCC_YV16 0x36315659
2624 * 10-bit and 16-bit Planar YUV 4:2:0.
2626 #define VA_FOURCC_P010 0x30313050
2627 #define VA_FOURCC_P016 0x36313050
2630 * 10-bit Planar YUV 420 and occupy the lower 10-bit.
2632 #define VA_FOURCC_I010 0x30313049
2635 #define VA_LSB_FIRST 1
2636 #define VA_MSB_FIRST 2
2638 typedef struct _VAImageFormat
2640 unsigned int fourcc;
2641 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2642 unsigned int bits_per_pixel;
2643 /* for RGB formats */
2644 unsigned int depth; /* significant bits per pixel */
2645 unsigned int red_mask;
2646 unsigned int green_mask;
2647 unsigned int blue_mask;
2648 unsigned int alpha_mask;
2651 typedef VAGenericID VAImageID;
2653 typedef struct _VAImage
2655 VAImageID image_id; /* uniquely identify this image */
2656 VAImageFormat format;
2657 VABufferID buf; /* image data buffer */
2659 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2660 * data store on the server side for optimal performance. The buffer will be
2661 * created by the CreateImage function, and proper storage allocated based on the image
2662 * size and format. This buffer is managed by the library implementation, and
2663 * accessed by the client through the buffer Map/Unmap functions.
2665 unsigned short width;
2666 unsigned short height;
2667 unsigned int data_size;
2668 unsigned int num_planes; /* can not be greater than 3 */
2670 * An array indicating the scanline pitch in bytes for each plane.
2671 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2673 unsigned int pitches[3];
2675 * An array indicating the byte offset from the beginning of the image data
2676 * to the start of each plane.
2678 unsigned int offsets[3];
2680 /* The following fields are only needed for paletted formats */
2681 int num_palette_entries; /* set to zero for non-palette images */
2683 * Each component is one byte and entry_bytes indicates the number of components in
2684 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2688 * An array of ascii characters describing the order of the components within the bytes.
2689 * Only entry_bytes characters of the string are used.
2691 char component_order[4];
2694 /** Get maximum number of image formats supported by the implementation */
2695 int vaMaxNumImageFormats (
2700 * Query supported image formats
2701 * The caller must provide a "format_list" array that can hold at
2702 * least vaMaxNumImageFormats() entries. The actual number of formats
2703 * returned in "format_list" is returned in "num_formats".
2705 VAStatus vaQueryImageFormats (
2707 VAImageFormat *format_list, /* out */
2708 int *num_formats /* out */
2712 * Create a VAImage structure
2713 * The width and height fields returned in the VAImage structure may get
2714 * enlarged for some YUV formats. Upon return from this function,
2715 * image->buf has been created and proper storage allocated by the library.
2716 * The client can access the image through the Map/Unmap calls.
2718 VAStatus vaCreateImage (
2720 VAImageFormat *format,
2723 VAImage *image /* out */
2727 * Should call DestroyImage before destroying the surface it is bound to
2729 VAStatus vaDestroyImage (
2734 VAStatus vaSetImagePalette (
2738 * pointer to an array holding the palette data. The size of the array is
2739 * num_palette_entries * entry_bytes in size. The order of the components
2740 * in the palette is described by the component_order in VAImage struct
2742 unsigned char *palette
2746 * Retrive surface data into a VAImage
2747 * Image must be in a format supported by the implementation
2749 VAStatus vaGetImage (
2751 VASurfaceID surface,
2752 int x, /* coordinates of the upper left source pixel */
2754 unsigned int width, /* width and height of the region */
2755 unsigned int height,
2760 * Copy data from a VAImage to a surface
2761 * Image must be in a format supported by the implementation
2762 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2763 * shouldn't be rendered into when this is called
2765 VAStatus vaPutImage (
2767 VASurfaceID surface,
2771 unsigned int src_width,
2772 unsigned int src_height,
2775 unsigned int dest_width,
2776 unsigned int dest_height
2780 * Derive an VAImage from an existing surface.
2781 * This interface will derive a VAImage and corresponding image buffer from
2782 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2783 * direct CPU access. This operation is only possible on implementations with
2784 * direct rendering capabilities and internal surface formats that can be
2785 * represented with a VAImage. When the operation is not possible this interface
2786 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2787 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2790 * Implementations should only return success when the resulting image buffer
2791 * would be useable with vaMap/Unmap.
2793 * When directly accessing a surface special care must be taken to insure
2794 * proper synchronization with the graphics hardware. Clients should call
2795 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2796 * rendering or currently being displayed by an overlay.
2798 * Additionally nothing about the contents of a surface should be assumed
2799 * following a vaPutSurface. Implementations are free to modify the surface for
2800 * scaling or subpicture blending within a call to vaPutImage.
2802 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2803 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2804 * vaGetImage with other surfaces is supported.
2806 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2807 * image and image buffer structures will be destroyed; however, the underlying
2808 * surface will remain unchanged until freed with vaDestroySurfaces.
2810 VAStatus vaDeriveImage (
2812 VASurfaceID surface,
2813 VAImage *image /* out */
2818 * Subpicture is a special type of image that can be blended
2819 * with a surface during vaPutSurface(). Subpicture can be used to render
2820 * DVD sub-titles or closed captioning text etc.
2823 typedef VAGenericID VASubpictureID;
2825 /** Get maximum number of subpicture formats supported by the implementation */
2826 int vaMaxNumSubpictureFormats (
2830 /** flags for subpictures */
2831 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2832 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2833 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2835 * Query supported subpicture formats
2836 * The caller must provide a "format_list" array that can hold at
2837 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2838 * for each format to indicate additional capabilities for that format. The actual
2839 * number of formats returned in "format_list" is returned in "num_formats".
2840 * flags: returned value to indicate addtional capabilities
2841 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2842 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2843 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2846 VAStatus vaQuerySubpictureFormats (
2848 VAImageFormat *format_list, /* out */
2849 unsigned int *flags, /* out */
2850 unsigned int *num_formats /* out */
2854 * Subpictures are created with an image associated.
2856 VAStatus vaCreateSubpicture (
2859 VASubpictureID *subpicture /* out */
2863 * Destroy the subpicture before destroying the image it is assocated to
2865 VAStatus vaDestroySubpicture (
2867 VASubpictureID subpicture
2871 * Bind an image to the subpicture. This image will now be associated with
2872 * the subpicture instead of the one at creation.
2874 VAStatus vaSetSubpictureImage (
2876 VASubpictureID subpicture,
2881 * If chromakey is enabled, then the area where the source value falls within
2882 * the chromakey [min, max] range is transparent
2883 * The chromakey component format is the following:
2884 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2885 * For YUV: [0:7] V [8:15] U [16:23] Y
2886 * The chromakey mask can be used to mask out certain components for chromakey
2889 VAStatus vaSetSubpictureChromakey (
2891 VASubpictureID subpicture,
2892 unsigned int chromakey_min,
2893 unsigned int chromakey_max,
2894 unsigned int chromakey_mask
2898 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2899 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2900 * the overall alpha is per-pixel alpha multiplied by the global alpha
2902 VAStatus vaSetSubpictureGlobalAlpha (
2904 VASubpictureID subpicture,
2909 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2910 * It defines the region mapping between the subpicture and the target
2911 * surfaces through source and destination rectangles (with the same width and height).
2912 * Both will be displayed at the next call to vaPutSurface. Additional
2913 * associations before the call to vaPutSurface simply overrides the association.
2915 VAStatus vaAssociateSubpicture (
2917 VASubpictureID subpicture,
2918 VASurfaceID *target_surfaces,
2920 short src_x, /* upper left offset in subpicture */
2922 unsigned short src_width,
2923 unsigned short src_height,
2924 short dest_x, /* upper left offset in surface */
2926 unsigned short dest_width,
2927 unsigned short dest_height,
2929 * whether to enable chroma-keying, global-alpha, or screen relative mode
2930 * see VA_SUBPICTURE_XXX values
2936 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2938 VAStatus vaDeassociateSubpicture (
2940 VASubpictureID subpicture,
2941 VASurfaceID *target_surfaces,
2946 * Display attributes
2947 * Display attributes are used to control things such as contrast, hue, saturation,
2948 * brightness etc. in the rendering process. The application can query what
2949 * attributes are supported by the driver, and then set the appropriate attributes
2950 * before calling vaPutSurface()
2952 /* PowerVR IEP Lite attributes */
2955 VADISPLAYATTRIB_BLE_OFF = 0x00,
2956 VADISPLAYATTRIB_BLE_LOW,
2957 VADISPLAYATTRIB_BLE_MEDIUM,
2958 VADISPLAYATTRIB_BLE_HIGH,
2959 VADISPLAYATTRIB_BLE_NONE,
2960 } VADisplayAttribBLEMode;
2962 /** attribute value for VADisplayAttribRotation */
2963 #define VA_ROTATION_NONE 0x00000000
2964 #define VA_ROTATION_90 0x00000001
2965 #define VA_ROTATION_180 0x00000002
2966 #define VA_ROTATION_270 0x00000003
2968 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2969 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2970 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2973 #define VA_RENDER_MODE_UNDEFINED 0
2974 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2975 #define VA_RENDER_MODE_LOCAL_GPU 2
2976 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2977 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2979 /** Render device */
2980 #define VA_RENDER_DEVICE_UNDEFINED 0
2981 #define VA_RENDER_DEVICE_LOCAL 1
2982 #define VA_RENDER_DEVICE_EXTERNAL 2
2984 /** Currently defined display attribute types */
2987 VADisplayAttribBrightness = 0,
2988 VADisplayAttribContrast = 1,
2989 VADisplayAttribHue = 2,
2990 VADisplayAttribSaturation = 3,
2991 /* client can specifiy a background color for the target window
2992 * the new feature of video conference,
2993 * the uncovered area of the surface is filled by this color
2994 * also it will blend with the decoded video color
2996 VADisplayAttribBackgroundColor = 4,
2998 * this is a gettable only attribute. For some implementations that use the
2999 * hardware overlay, after PutSurface is called, the surface can not be
3000 * re-used until after the subsequent PutSurface call. If this is the case
3001 * then the value for this attribute will be set to 1 so that the client
3002 * will not attempt to re-use the surface right after returning from a call
3005 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
3006 * driver may use overlay or GPU alternatively
3008 VADisplayAttribDirectSurface = 5,
3009 VADisplayAttribRotation = 6,
3010 VADisplayAttribOutofLoopDeblock = 7,
3012 /* PowerVR IEP Lite specific attributes */
3013 VADisplayAttribBLEBlackMode = 8,
3014 VADisplayAttribBLEWhiteMode = 9,
3015 VADisplayAttribBlueStretch = 10,
3016 VADisplayAttribSkinColorCorrection = 11,
3018 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
3019 * conversion matrix. Each element in the matrix is float-point
3021 VADisplayAttribCSCMatrix = 12,
3022 /* specify the constant color used to blend with video surface
3023 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
3024 * d: the final color to overwrite into the frame buffer
3025 * v: decoded video after color conversion,
3026 * c: video color specified by VADisplayAttribBlendColor
3027 * b: background color of the drawable
3029 VADisplayAttribBlendColor = 13,
3031 * Indicate driver to skip painting color key or not.
3032 * only applicable if the render is overlay
3034 VADisplayAttribOverlayAutoPaintColorKey = 14,
3036 * customized overlay color key, the format is RGB888
3037 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
3039 VADisplayAttribOverlayColorKey = 15,
3041 * The hint for the implementation of vaPutSurface
3042 * normally, the driver could use an overlay or GPU to render the surface on the screen
3043 * this flag provides APP the flexibity to switch the render dynamically
3045 VADisplayAttribRenderMode = 16,
3047 * specify if vaPutSurface needs to render into specified monitors
3048 * one example is that one external monitor (e.g. HDMI) is enabled,
3049 * but the window manager is not aware of it, and there is no associated drawable
3051 VADisplayAttribRenderDevice = 17,
3053 * specify vaPutSurface render area if there is no drawable on the monitor
3055 VADisplayAttribRenderRect = 18,
3056 } VADisplayAttribType;
3058 /* flags for VADisplayAttribute */
3059 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
3060 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
3061 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
3063 typedef struct _VADisplayAttribute
3065 VADisplayAttribType type;
3068 int value; /* used by the set/get attribute functions */
3069 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
3071 } VADisplayAttribute;
3073 /** Get maximum number of display attributs supported by the implementation */
3074 int vaMaxNumDisplayAttributes (
3079 * Query display attributes
3080 * The caller must provide a "attr_list" array that can hold at
3081 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
3082 * returned in "attr_list" is returned in "num_attributes".
3084 VAStatus vaQueryDisplayAttributes (
3086 VADisplayAttribute *attr_list, /* out */
3087 int *num_attributes /* out */
3091 * Get display attributes
3092 * This function returns the current attribute values in "attr_list".
3093 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
3094 * from vaQueryDisplayAttributes() can have their values retrieved.
3096 VAStatus vaGetDisplayAttributes (
3098 VADisplayAttribute *attr_list, /* in/out */
3103 * Set display attributes
3104 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
3105 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
3106 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
3108 VAStatus vaSetDisplayAttributes (
3110 VADisplayAttribute *attr_list,
3114 /****************************
3115 * HEVC data structures
3116 ****************************/
3118 * \brief Description of picture properties of those in DPB surfaces.
3120 * If only progressive scan is supported, each surface contains one whole
3122 * Otherwise, each surface contains two fields of whole picture.
3123 * In this case, two entries of ReferenceFrames[] may share same picture_id
3126 typedef struct _VAPictureHEVC
3128 /** \brief reconstructed picture buffer surface index
3129 * invalid when taking value VA_INVALID_SURFACE.
3131 VASurfaceID picture_id;
3132 /** \brief picture order count.
3133 * in HEVC, POCs for top and bottom fields of same picture should
3134 * take different values.
3136 int32_t pic_order_cnt;
3137 /* described below */
3141 /* flags in VAPictureHEVC could be OR of the following */
3142 #define VA_PICTURE_HEVC_INVALID 0x00000001
3143 /** \brief indication of interlace scan picture.
3144 * should take same value for all the pictures in sequence.
3146 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
3147 /** \brief polarity of the field picture.
3148 * top field takes even lines of buffer surface.
3149 * bottom field takes odd lines of buffer surface.
3151 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
3152 /** \brief Long term reference picture */
3153 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
3155 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
3156 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
3157 * be exclusive. No more than one of them can be set for any picture.
3158 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
3159 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
3160 * Application should provide valid values for both short format and long format.
3161 * The pictures in DPB with any of these three flags turned on are referred by
3162 * the current picture.
3164 /** \brief RefPicSetStCurrBefore of HEVC spec variable
3165 * Number of ReferenceFrames[] entries with this bit set equals
3166 * NumPocStCurrBefore.
3168 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
3169 /** \brief RefPicSetStCurrAfter of HEVC spec variable
3170 * Number of ReferenceFrames[] entries with this bit set equals
3171 * NumPocStCurrAfter.
3173 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
3174 /** \brief RefPicSetLtCurr of HEVC spec variable
3175 * Number of ReferenceFrames[] entries with this bit set equals
3178 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
3180 #include <va/va_dec_hevc.h>
3181 #include <va/va_dec_jpeg.h>
3182 #include <va/va_dec_vp8.h>
3183 #include <va/va_dec_vp9.h>
3184 #include <va/va_enc_hevc.h>
3185 #include <va/va_enc_h264.h>
3186 #include <va/va_enc_jpeg.h>
3187 #include <va/va_enc_mpeg2.h>
3188 #include <va/va_enc_vp8.h>
3189 #include <va/va_enc_vp9.h>
3190 #include <va/va_fei.h>
3191 #include <va/va_fei_h264.h>
3192 #include <va/va_vpp.h>