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 * \mainpage Video Acceleration (VA) API
92 * \section intro Introduction
94 * The main motivation for VA-API (Video Acceleration API) is to
95 * enable hardware accelerated video decode and encode at various
96 * entry-points (VLD, IDCT, Motion Compensation etc.) for the
97 * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
98 * AVC/H.264, VC-1/VMW3, and JPEG).
100 * VA-API is split into several modules:
102 * - \ref api_enc_h264
107 * \defgroup api_core Core API
115 The VA API is intended to provide an interface between a video decode/encode/display
116 application (client) and a hardware accelerator (server), to off-load
117 video decode/encode/display operations from the host to the hardware accelerator at various
120 The basic operation steps are:
122 - Negotiate a mutually acceptable configuration with the server to lock
123 down profile, entrypoints, and other attributes that will not change on
124 a frame-by-frame basis.
125 - Create a decode context which represents a "virtualized" hardware decode
127 - Get and fill decode buffers with picture level, slice level and macroblock
128 level data (depending on entrypoints)
129 - Pass the decode buffers to the server to decode the current frame
131 Initialization & Configuration Management
133 - Find out supported profiles
134 - Find out entrypoints for a given profile
135 - Find out configuration attributes for a given profile/entrypoint pair
136 - Create a configuration for use by the decoder
140 typedef void* VADisplay; /* window system dependent */
142 typedef int VAStatus; /** Return status type from functions */
143 /** Values for the return status */
144 #define VA_STATUS_SUCCESS 0x00000000
145 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
146 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
147 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
148 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
149 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
150 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
151 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
152 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
153 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
154 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
155 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
156 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
157 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
158 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
159 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
160 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
161 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
162 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
163 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
164 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
165 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
166 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
167 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
168 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
170 * \brief An invalid/unsupported value was supplied.
172 * This is a catch-all error code for invalid or unsupported values.
173 * e.g. value exceeding the valid range, invalid type in the context
174 * of generic attribute values.
176 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
177 /** \brief An unsupported filter was supplied. */
178 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER 0x00000020
179 /** \brief An invalid filter chain was supplied. */
180 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN 0x00000021
181 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
182 #define VA_STATUS_ERROR_HW_BUSY 0x00000022
183 /** \brief An unsupported memory type was supplied. */
184 #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
185 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
187 /** De-interlacing flags for vaPutSurface() */
188 #define VA_FRAME_PICTURE 0x00000000
189 #define VA_TOP_FIELD 0x00000001
190 #define VA_BOTTOM_FIELD 0x00000002
193 * Enabled the positioning/cropping/blending feature:
194 * 1, specify the video playback position in the isurface
195 * 2, specify the cropping info for video playback
196 * 3, encoded video will blend with background color
198 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
201 * Clears the drawable with background color.
202 * for hardware overlay based implementation this flag
203 * can be used to turn off the overlay
205 #define VA_CLEAR_DRAWABLE 0x00000008
207 /** Color space conversion flags for vaPutSurface() */
208 #define VA_SRC_COLOR_MASK 0x000000f0
209 #define VA_SRC_BT601 0x00000010
210 #define VA_SRC_BT709 0x00000020
211 #define VA_SRC_SMPTE_240 0x00000040
213 /** Scaling flags for vaPutSurface() */
214 #define VA_FILTER_SCALING_DEFAULT 0x00000000
215 #define VA_FILTER_SCALING_FAST 0x00000100
216 #define VA_FILTER_SCALING_HQ 0x00000200
217 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
218 #define VA_FILTER_SCALING_MASK 0x00000f00
221 * Returns a short english description of error_status
223 const char *vaErrorStr(VAStatus error_status);
225 typedef struct _VARectangle
229 unsigned short width;
230 unsigned short height;
235 * A display must be obtained by calling vaGetDisplay() before calling
236 * vaInitialize() and other functions. This connects the API to the
237 * native window system.
238 * For X Windows, native_dpy would be from XOpenDisplay()
240 typedef void* VANativeDisplay; /* window system dependent */
242 int vaDisplayIsValid(VADisplay dpy);
245 * Set the override driver name instead of queried driver driver.
247 VAStatus vaSetDriverName(VADisplay dpy,
252 * Initialize the library
254 VAStatus vaInitialize (
256 int *major_version, /* out */
257 int *minor_version /* out */
261 * After this call, all library internal resources will be cleaned up
263 VAStatus vaTerminate (
268 * vaQueryVendorString returns a pointer to a zero-terminated string
269 * describing some aspects of the VA implemenation on a specific
270 * hardware accelerator. The format of the returned string is vendor
271 * specific and at the discretion of the implementer.
272 * e.g. for the Intel GMA500 implementation, an example would be:
273 * "Intel GMA500 - 2.0.0.32L.0005"
275 const char *vaQueryVendorString (
279 typedef int (*VAPrivFunc)();
282 * Return a function pointer given a function name in the library.
283 * This allows private interfaces into the library
285 VAPrivFunc vaGetLibFunc (
290 /** Currently defined profiles */
293 /** \brief Profile ID used for video processing. */
295 VAProfileMPEG2Simple = 0,
296 VAProfileMPEG2Main = 1,
297 VAProfileMPEG4Simple = 2,
298 VAProfileMPEG4AdvancedSimple = 3,
299 VAProfileMPEG4Main = 4,
300 VAProfileH264Baseline = 5,
301 VAProfileH264Main = 6,
302 VAProfileH264High = 7,
303 VAProfileVC1Simple = 8,
304 VAProfileVC1Main = 9,
305 VAProfileVC1Advanced = 10,
306 VAProfileH263Baseline = 11,
307 VAProfileJPEGBaseline = 12,
308 VAProfileH264ConstrainedBaseline = 13,
309 VAProfileVP8Version0_3 = 14,
310 VAProfileH264MultiviewHigh = 15,
311 VAProfileH264StereoHigh = 16,
312 VAProfileHEVCMain = 17,
313 VAProfileHEVCMain10 = 18,
314 VAProfileVP9Profile0 = 19,
315 VAProfileVP9Profile1 = 20,
316 VAProfileVP9Profile2 = 21,
317 VAProfileVP9Profile3 = 22
321 * Currently defined entrypoints
327 VAEntrypointIDCT = 3,
328 VAEntrypointMoComp = 4,
329 VAEntrypointDeblocking = 5,
330 VAEntrypointEncSlice = 6, /* slice level encode */
331 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
333 * For an implementation that supports a low power/high performance variant
334 * for slice level encode, it can choose to expose the
335 * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
336 * available with this entrypoint (e.g. interlace, MBAFF) and the
337 * application can query the encoding configuration attributes to find
338 * out more details if this entrypoint is supported.
340 VAEntrypointEncSliceLP = 8,
341 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
344 /** Currently defined configuration attribute types */
347 VAConfigAttribRTFormat = 0,
348 VAConfigAttribSpatialResidual = 1,
349 VAConfigAttribSpatialClipping = 2,
350 VAConfigAttribIntraResidual = 3,
351 VAConfigAttribEncryption = 4,
352 VAConfigAttribRateControl = 5,
354 /** @name Attributes for decoding */
357 * \brief Slice Decoding mode. Read/write.
359 * This attribute determines what mode the driver supports for slice
360 * decoding, through vaGetConfigAttributes(); and what mode the user
361 * will be providing to the driver, through vaCreateConfig(), if the
362 * driver supports those. If this attribute is not set by the user then
363 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
365 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
367 VAConfigAttribDecSliceMode = 6,
369 /** @name Attributes for encoding */
372 * \brief Packed headers mode. Read/write.
374 * This attribute determines what packed headers the driver supports,
375 * through vaGetConfigAttributes(); and what packed headers the user
376 * will be providing to the driver, through vaCreateConfig(), if the
377 * driver supports those.
379 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
381 VAConfigAttribEncPackedHeaders = 10,
383 * \brief Interlaced mode. Read/write.
385 * This attribute determines what kind of interlaced encoding mode
386 * the driver supports.
388 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
390 VAConfigAttribEncInterlaced = 11,
392 * \brief Maximum number of reference frames. Read-only.
394 * This attribute determines the maximum number of reference
395 * frames supported for encoding.
397 * Note: for H.264 encoding, the value represents the maximum number
398 * of reference frames for both the reference picture list 0 (bottom
399 * 16 bits) and the reference picture list 1 (top 16 bits).
401 VAConfigAttribEncMaxRefFrames = 13,
403 * \brief Maximum number of slices per frame. Read-only.
405 * This attribute determines the maximum number of slices the
406 * driver can support to encode a single frame.
408 VAConfigAttribEncMaxSlices = 14,
410 * \brief Slice structure. Read-only.
412 * This attribute determines slice structures supported by the
413 * driver for encoding. This attribute is a hint to the user so
414 * that he can choose a suitable surface size and how to arrange
415 * the encoding process of multiple slices per frame.
417 * More specifically, for H.264 encoding, this attribute
418 * determines the range of accepted values to
419 * VAEncSliceParameterBufferH264::macroblock_address and
420 * VAEncSliceParameterBufferH264::num_macroblocks.
422 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
425 VAConfigAttribEncSliceStructure = 15,
427 * \brief Macroblock information. Read-only.
429 * This attribute determines whether the driver supports extra
430 * encoding information per-macroblock. e.g. QP.
432 * More specifically, for H.264 encoding, if the driver returns a non-zero
433 * value for this attribute, this means the application can create
434 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
435 * through VAEncSliceParameterBufferH264::macroblock_info.
437 VAConfigAttribEncMacroblockInfo = 16,
439 * \brief JPEG encoding attribute. Read-only.
441 * This attribute exposes a number of capabilities of the underlying
442 * JPEG implementation. The attribute value is partitioned into fields as defined in the
443 * VAConfigAttribValEncJPEG union.
445 VAConfigAttribEncJPEG = 20,
447 * \brief Encoding quality range attribute. Read-only.
449 * This attribute conveys whether the driver supports different quality level settings
450 * for encoding. A value less than or equal to 1 means that the encoder only has a single
451 * quality setting, and a value greater than 1 represents the number of quality levels
452 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
454 VAConfigAttribEncQualityRange = 21,
456 * \brief Encoding skip frame attribute. Read-only.
458 * This attribute conveys whether the driver supports sending skip frame parameters
459 * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has
460 * externally skipped frames.
462 VAConfigAttribEncSkipFrame = 24,
464 * \brief Encoding region-of-interest (ROI) attribute. Read-only.
466 * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
467 * based on user provided ROI rectangles. The attribute value is partitioned into fields
468 * as defined in the VAConfigAttribValEncROI union.
470 * If ROI encoding is supported, the ROI information is passed to the driver using
471 * VAEncMiscParameterTypeROI.
473 VAConfigAttribEncROI = 25,
475 VAConfigAttribTypeMax
476 } VAConfigAttribType;
479 * Configuration attributes
480 * If there is more than one value for an attribute, a default
481 * value will be assigned to the attribute if the client does not
482 * specify the attribute when creating a configuration
484 typedef struct _VAConfigAttrib {
485 VAConfigAttribType type;
486 unsigned int value; /* OR'd flags (bits) for this attribute */
489 /** attribute value for VAConfigAttribRTFormat */
490 #define VA_RT_FORMAT_YUV420 0x00000001
491 #define VA_RT_FORMAT_YUV422 0x00000002
492 #define VA_RT_FORMAT_YUV444 0x00000004
493 #define VA_RT_FORMAT_YUV411 0x00000008
494 #define VA_RT_FORMAT_YUV400 0x00000010
495 /** YUV formats with more than 8 bpp */
496 #define VA_RT_FORMAT_YUV420_10BPP 0x00000100
498 #define VA_RT_FORMAT_RGB16 0x00010000
499 #define VA_RT_FORMAT_RGB32 0x00020000
500 /* RGBP covers RGBP and BGRP fourcc */
501 #define VA_RT_FORMAT_RGBP 0x00100000
502 #define VA_RT_FORMAT_PROTECTED 0x80000000
504 /** @name Attribute values for VAConfigAttribRateControl */
506 /** \brief Driver does not support any form of rate control. */
507 #define VA_RC_NONE 0x00000001
508 /** \brief Constant bitrate. */
509 #define VA_RC_CBR 0x00000002
510 /** \brief Variable bitrate. */
511 #define VA_RC_VBR 0x00000004
512 /** \brief Video conference mode. */
513 #define VA_RC_VCM 0x00000008
514 /** \brief Constant QP. */
515 #define VA_RC_CQP 0x00000010
516 /** \brief Variable bitrate with peak rate higher than average bitrate. */
517 #define VA_RC_VBR_CONSTRAINED 0x00000020
518 /** \brief Macroblock based rate control. Per MB control is decided
519 * internally in the encoder. It may be combined with other RC modes, except CQP. */
520 #define VA_RC_MB 0x00000080
524 /** @name Attribute values for VAConfigAttribDecSliceMode */
526 /** \brief Driver supports normal mode for slice decoding */
527 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
528 /** \brief Driver supports base mode for slice decoding */
529 #define VA_DEC_SLICE_MODE_BASE 0x00000002
532 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
534 /** \brief Driver does not support any packed headers mode. */
535 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
536 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
537 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
538 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
539 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
540 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
541 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
542 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
543 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
544 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
545 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
548 /** @name Attribute values for VAConfigAttribEncInterlaced */
550 /** \brief Driver does not support interlaced coding. */
551 #define VA_ENC_INTERLACED_NONE 0x00000000
552 /** \brief Driver supports interlaced frame coding. */
553 #define VA_ENC_INTERLACED_FRAME 0x00000001
554 /** \brief Driver supports interlaced field coding. */
555 #define VA_ENC_INTERLACED_FIELD 0x00000002
556 /** \brief Driver supports macroblock adaptive frame field coding. */
557 #define VA_ENC_INTERLACED_MBAFF 0x00000004
558 /** \brief Driver supports picture adaptive frame field coding. */
559 #define VA_ENC_INTERLACED_PAFF 0x00000008
562 /** @name Attribute values for VAConfigAttribEncSliceStructure */
564 /** \brief Driver supports an arbitrary number of rows per slice. */
565 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
566 /** \brief Driver supports a power-of-two number of rows per slice. */
567 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
568 /** \brief Driver supports an arbitrary number of rows per slice. */
569 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
572 /** \brief Attribute value for VAConfigAttribEncJPEG */
573 typedef union _VAConfigAttribValEncJPEG {
575 /** \brief set to 1 for arithmatic coding. */
576 unsigned int arithmatic_coding_mode : 1;
577 /** \brief set to 1 for progressive dct. */
578 unsigned int progressive_dct_mode : 1;
579 /** \brief set to 1 for non-interleaved. */
580 unsigned int non_interleaved_mode : 1;
581 /** \brief set to 1 for differential. */
582 unsigned int differential_mode : 1;
583 unsigned int max_num_components : 3;
584 unsigned int max_num_scans : 4;
585 unsigned int max_num_huffman_tables : 3;
586 unsigned int max_num_quantization_tables : 3;
589 } VAConfigAttribValEncJPEG;
591 /** \brief Attribute value for VAConfigAttribEncROI */
592 typedef union _VAConfigAttribValEncROI {
594 /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
595 unsigned int num_roi_regions : 8;
597 * \brief A flag indicates whether ROI priority is supported
599 * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
600 * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
601 * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
602 * the underlying driver doesn't support ROI priority.
604 * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
605 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
607 unsigned int roi_rc_priority_support : 1;
609 * \brief A flag indicates whether ROI delta QP is supported
611 * \ref roi_rc_qp_delat_support equal to 1 specifies the underlying driver supports
612 * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
613 * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delat_support equal to 0 specifies
614 * the underlying driver doesn't support ROI delta QP.
616 * User should ignore \ref roi_rc_qp_delat_support when VAConfigAttribRateControl == VA_RC_CQP
617 * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
619 unsigned int roi_rc_qp_delat_support : 1;
620 unsigned int reserved : 22;
623 } VAConfigAttribValEncROI;
626 * if an attribute is not applicable for a given
627 * profile/entrypoint pair, then set the value to the following
629 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
631 /** Get maximum number of profiles supported by the implementation */
632 int vaMaxNumProfiles (
636 /** Get maximum number of entrypoints supported by the implementation */
637 int vaMaxNumEntrypoints (
641 /** Get maximum number of attributs supported by the implementation */
642 int vaMaxNumConfigAttributes (
647 * Query supported profiles
648 * The caller must provide a "profile_list" array that can hold at
649 * least vaMaxNumProfile() entries. The actual number of profiles
650 * returned in "profile_list" is returned in "num_profile".
652 VAStatus vaQueryConfigProfiles (
654 VAProfile *profile_list, /* out */
655 int *num_profiles /* out */
659 * Query supported entrypoints for a given profile
660 * The caller must provide an "entrypoint_list" array that can hold at
661 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
662 * returned in "entrypoint_list" is returned in "num_entrypoints".
664 VAStatus vaQueryConfigEntrypoints (
667 VAEntrypoint *entrypoint_list, /* out */
668 int *num_entrypoints /* out */
672 * Get attributes for a given profile/entrypoint pair
673 * The caller must provide an "attrib_list" with all attributes to be
674 * retrieved. Upon return, the attributes in "attrib_list" have been
675 * updated with their value. Unknown attributes or attributes that are
676 * not supported for the given profile/entrypoint pair will have their
677 * value set to VA_ATTRIB_NOT_SUPPORTED
679 VAStatus vaGetConfigAttributes (
682 VAEntrypoint entrypoint,
683 VAConfigAttrib *attrib_list, /* in/out */
687 /** Generic ID type, can be re-typed for specific implementation */
688 typedef unsigned int VAGenericID;
690 typedef VAGenericID VAConfigID;
693 * Create a configuration for the decode pipeline
694 * it passes in the attribute list that specifies the attributes it cares
695 * about, with the rest taking default values.
697 VAStatus vaCreateConfig (
700 VAEntrypoint entrypoint,
701 VAConfigAttrib *attrib_list,
703 VAConfigID *config_id /* out */
707 * Free resources associdated with a given config
709 VAStatus vaDestroyConfig (
715 * Query all attributes for a given configuration
716 * The profile of the configuration is returned in "profile"
717 * The entrypoint of the configuration is returned in "entrypoint"
718 * The caller must provide an "attrib_list" array that can hold at least
719 * vaMaxNumConfigAttributes() entries. The actual number of attributes
720 * returned in "attrib_list" is returned in "num_attribs"
722 VAStatus vaQueryConfigAttributes (
724 VAConfigID config_id,
725 VAProfile *profile, /* out */
726 VAEntrypoint *entrypoint, /* out */
727 VAConfigAttrib *attrib_list,/* out */
728 int *num_attribs /* out */
733 * Contexts and Surfaces
735 * Context represents a "virtual" video decode pipeline. Surfaces are render
736 * targets for a given context. The data in the surfaces are not accessible
737 * to the client and the internal data format of the surface is implementatin
740 * Surfaces will be bound to a context when the context is created. Once
741 * a surface is bound to a given context, it can not be used to create
742 * another context. The association is removed when the context is destroyed
744 * Both contexts and surfaces are identified by unique IDs and its
745 * implementation specific internals are kept opaque to the clients
748 typedef VAGenericID VAContextID;
750 typedef VAGenericID VASurfaceID;
752 #define VA_INVALID_ID 0xffffffff
753 #define VA_INVALID_SURFACE VA_INVALID_ID
755 /** \brief Generic value types. */
757 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
758 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
759 VAGenericValueTypePointer, /**< Generic pointer type */
760 VAGenericValueTypeFunc /**< Pointer to function */
761 } VAGenericValueType;
763 /** \brief Generic function type. */
764 typedef void (*VAGenericFunc)(void);
766 /** \brief Generic value. */
767 typedef struct _VAGenericValue {
768 /** \brief Value type. See #VAGenericValueType. */
769 VAGenericValueType type;
770 /** \brief Value holder. */
772 /** \brief 32-bit signed integer. */
774 /** \brief 32-bit float. */
776 /** \brief Generic pointer. */
778 /** \brief Pointer to function. */
783 /** @name Surface attribute flags */
785 /** \brief Surface attribute is not supported. */
786 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
787 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
788 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
789 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
790 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
793 /** \brief Surface attribute types. */
795 VASurfaceAttribNone = 0,
797 * \brief Pixel format (fourcc).
799 * The value is meaningful as input to vaQuerySurfaceAttributes().
800 * If zero, the driver returns the optimal pixel format for the
801 * specified config. Otherwise, if non-zero, the value represents
802 * a pixel format (FOURCC) that is kept as is on output, if the
803 * driver supports it. Otherwise, the driver sets the value to
804 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
806 VASurfaceAttribPixelFormat,
807 /** \brief Minimal width in pixels (int, read-only). */
808 VASurfaceAttribMinWidth,
809 /** \brief Maximal width in pixels (int, read-only). */
810 VASurfaceAttribMaxWidth,
811 /** \brief Minimal height in pixels (int, read-only). */
812 VASurfaceAttribMinHeight,
813 /** \brief Maximal height in pixels (int, read-only). */
814 VASurfaceAttribMaxHeight,
815 /** \brief Surface memory type expressed in bit fields (int, read/write). */
816 VASurfaceAttribMemoryType,
817 /** \brief External buffer descriptor (pointer, write). */
818 VASurfaceAttribExternalBufferDescriptor,
819 /** \brief Surface usage hint, gives the driver a hint of intended usage
820 * to optimize allocation (e.g. tiling) (int, read/write). */
821 VASurfaceAttribUsageHint,
822 /** \brief Number of surface attributes. */
824 } VASurfaceAttribType;
826 /** \brief Surface attribute. */
827 typedef struct _VASurfaceAttrib {
829 VASurfaceAttribType type;
830 /** \brief Flags. See "Surface attribute flags". */
832 /** \brief Value. See "Surface attribute types" for the expected types. */
833 VAGenericValue value;
837 * @name VASurfaceAttribMemoryType values in bit fields.
838 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
839 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
840 * types are defined in DRM and Android header files.
843 /** \brief VA memory type (default) is supported. */
844 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
845 /** \brief V4L2 buffer memory type is supported. */
846 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
847 /** \brief User pointer memory type is supported. */
848 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
852 * \brief VASurfaceAttribExternalBuffers structure for
853 * the VASurfaceAttribExternalBufferDescriptor attribute.
855 typedef struct _VASurfaceAttribExternalBuffers {
856 /** \brief pixel format in fourcc. */
857 unsigned int pixel_format;
858 /** \brief width in pixels. */
860 /** \brief height in pixels. */
862 /** \brief total size of the buffer in bytes. */
863 unsigned int data_size;
864 /** \brief number of planes for planar layout */
865 unsigned int num_planes;
866 /** \brief pitch for each plane in bytes */
867 unsigned int pitches[4];
868 /** \brief offset for each plane in bytes */
869 unsigned int offsets[4];
870 /** \brief buffer handles or user pointers */
871 unsigned long *buffers;
872 /** \brief number of elements in the "buffers" array */
873 unsigned int num_buffers;
874 /** \brief flags. See "Surface external buffer descriptor flags". */
876 /** \brief reserved for passing private data */
878 } VASurfaceAttribExternalBuffers;
880 /** @name VASurfaceAttribExternalBuffers flags */
882 /** \brief Enable memory tiling */
883 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
884 /** \brief Memory is cacheable */
885 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
886 /** \brief Memory is non-cacheable */
887 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
888 /** \brief Memory is write-combined */
889 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
890 /** \brief Memory is protected */
891 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
893 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
895 /** \brief Surface usage not indicated. */
896 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
897 /** \brief Surface used by video decoder. */
898 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
899 /** \brief Surface used by video encoder. */
900 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
901 /** \brief Surface read by video post-processing. */
902 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
903 /** \brief Surface written by video post-processing. */
904 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
905 /** \brief Surface used for display. */
906 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
911 * \brief Queries surface attributes for the supplied config.
913 * Unlike vaGetSurfaceAttributes(), this function queries for all
914 * supported attributes for the supplied VA @config. In particular, if
915 * the underlying hardware supports the creation of VA surfaces in
916 * various formats, then this function will enumerate all pixel
917 * formats that are supported.
919 * The \c attrib_list array is allocated by the user and \c
920 * num_attribs shall be initialized to the number of allocated
921 * elements in that array. Upon successful return, the actual number
922 * of attributes will be overwritten into \c num_attribs. Otherwise,
923 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
924 * is adjusted to the number of elements that would be returned if
925 * enough space was available.
927 * Note: it is perfectly valid to pass NULL to the \c attrib_list
928 * argument when vaQuerySurfaceAttributes() is used to determine the
929 * actual number of elements that need to be allocated.
931 * @param[in] dpy the VA display
932 * @param[in] config the config identifying a codec or a video
933 * processing pipeline
934 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
935 * @param[in,out] num_attribs the number of elements allocated on
936 * input, the number of elements actually filled in output
939 vaQuerySurfaceAttributes(
942 VASurfaceAttrib *attrib_list,
943 unsigned int *num_attribs
947 * \brief Creates an array of surfaces
949 * Creates an array of surfaces. The optional list of attributes shall
950 * be constructed and validated through vaGetSurfaceAttributes() or
951 * constructed based based on what the underlying hardware could
952 * expose through vaQuerySurfaceAttributes().
954 * @param[in] dpy the VA display
955 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
956 * @param[in] width the surface width
957 * @param[in] height the surface height
958 * @param[out] surfaces the array of newly created surfaces
959 * @param[in] num_surfaces the number of surfaces to create
960 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
961 * @param[in] num_attribs the number of attributes supplied in
962 * \c attrib_list, or zero
970 VASurfaceID *surfaces,
971 unsigned int num_surfaces,
972 VASurfaceAttrib *attrib_list,
973 unsigned int num_attribs
977 * vaDestroySurfaces - Destroy resources associated with surfaces.
978 * Surfaces can only be destroyed after the context associated has been
981 * surfaces: array of surfaces to destroy
982 * num_surfaces: number of surfaces in the array to be destroyed.
984 VAStatus vaDestroySurfaces (
986 VASurfaceID *surfaces,
990 #define VA_PROGRESSIVE 0x1
992 * vaCreateContext - Create a context
994 * config_id: configuration for the context
995 * picture_width: coded picture width
996 * picture_height: coded picture height
997 * flag: any combination of the following:
998 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
999 * render_targets: render targets (surfaces) tied to the context
1000 * num_render_targets: number of render targets in the above array
1001 * context: created context id upon return
1003 VAStatus vaCreateContext (
1005 VAConfigID config_id,
1009 VASurfaceID *render_targets,
1010 int num_render_targets,
1011 VAContextID *context /* out */
1015 * vaDestroyContext - Destroy a context
1017 * context: context to be destroyed
1019 VAStatus vaDestroyContext (
1026 * Buffers are used to pass various types of data from the
1027 * client to the server. The server maintains a data store
1028 * for each buffer created, and the client idenfies a buffer
1029 * through a unique buffer id assigned by the server.
1032 typedef VAGenericID VABufferID;
1036 VAPictureParameterBufferType = 0,
1037 VAIQMatrixBufferType = 1,
1038 VABitPlaneBufferType = 2,
1039 VASliceGroupMapBufferType = 3,
1040 VASliceParameterBufferType = 4,
1041 VASliceDataBufferType = 5,
1042 VAMacroblockParameterBufferType = 6,
1043 VAResidualDataBufferType = 7,
1044 VADeblockingParameterBufferType = 8,
1045 VAImageBufferType = 9,
1046 VAProtectedSliceDataBufferType = 10,
1047 VAQMatrixBufferType = 11,
1048 VAHuffmanTableBufferType = 12,
1049 VAProbabilityBufferType = 13,
1051 /* Following are encode buffer types */
1052 VAEncCodedBufferType = 21,
1053 VAEncSequenceParameterBufferType = 22,
1054 VAEncPictureParameterBufferType = 23,
1055 VAEncSliceParameterBufferType = 24,
1056 VAEncPackedHeaderParameterBufferType = 25,
1057 VAEncPackedHeaderDataBufferType = 26,
1058 VAEncMiscParameterBufferType = 27,
1059 VAEncMacroblockParameterBufferType = 28,
1060 VAEncMacroblockMapBufferType = 29,
1061 /* Following are video processing buffer types */
1063 * \brief Video processing pipeline parameter buffer.
1065 * This buffer describes the video processing pipeline. See
1066 * #VAProcPipelineParameterBuffer for details.
1068 VAProcPipelineParameterBufferType = 41,
1070 * \brief Video filter parameter buffer.
1072 * This buffer describes the video filter parameters. All buffers
1073 * inherit from #VAProcFilterParameterBufferBase, thus including
1074 * a unique filter buffer type.
1076 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1077 * Filters requiring advanced parameters include, but are not limited to,
1078 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1079 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1081 VAProcFilterParameterBufferType = 42,
1087 VAEncMiscParameterTypeFrameRate = 0,
1088 VAEncMiscParameterTypeRateControl = 1,
1089 VAEncMiscParameterTypeMaxSliceSize = 2,
1090 VAEncMiscParameterTypeAIR = 3,
1091 /** \brief Buffer type used to express a maximum frame size (in bits). */
1092 VAEncMiscParameterTypeMaxFrameSize = 4,
1093 /** \brief Buffer type used for HRD parameters. */
1094 VAEncMiscParameterTypeHRD = 5,
1095 VAEncMiscParameterTypeQualityLevel = 6,
1096 /** \brief Buffer type used for sending skip frame parameters to the encoder's
1097 * rate control, when the user has externally skipped frames. */
1098 VAEncMiscParameterTypeSkipFrame = 9,
1099 /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1100 VAEncMiscParameterTypeROI = 10
1101 } VAEncMiscParameterType;
1103 /** \brief Packed header type. */
1105 /** \brief Packed sequence header. */
1106 VAEncPackedHeaderSequence = 1,
1107 /** \brief Packed picture header. */
1108 VAEncPackedHeaderPicture = 2,
1109 /** \brief Packed slice header. */
1110 VAEncPackedHeaderSlice = 3,
1112 * \brief Packed raw header.
1114 * Packed raw data header can be used by the client to insert a header
1115 * into the bitstream data buffer at the point it is passed, the driver
1116 * will handle the raw packed header based on "has_emulation_bytes" field
1117 * in the packed header parameter structure.
1119 VAEncPackedHeaderRawData = 4,
1120 /** \brief Misc packed header. See codec-specific definitions. */
1121 VAEncPackedHeaderMiscMask = 0x80000000,
1122 } VAEncPackedHeaderType;
1124 /** \brief Packed header parameter. */
1125 typedef struct _VAEncPackedHeaderParameterBuffer {
1126 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1128 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1129 unsigned int bit_length;
1130 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1131 unsigned char has_emulation_bytes;
1132 } VAEncPackedHeaderParameterBuffer;
1135 * For application, e.g. set a new bitrate
1136 * VABufferID buf_id;
1137 * VAEncMiscParameterBuffer *misc_param;
1138 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1140 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1141 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1142 * 1, NULL, &buf_id);
1144 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1145 * misc_param->type = VAEncMiscParameterTypeRateControl;
1146 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1147 * misc_rate_ctrl->bits_per_second = 6400000;
1148 * vaUnmapBuffer(dpy, buf_id);
1149 * vaRenderPicture(dpy, context, &buf_id, 1);
1151 typedef struct _VAEncMiscParameterBuffer
1153 VAEncMiscParameterType type;
1154 unsigned int data[0];
1155 } VAEncMiscParameterBuffer;
1158 /** \brief Rate control parameters */
1159 typedef struct _VAEncMiscParameterRateControl
1161 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1162 unsigned int bits_per_second;
1163 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1164 * bit-rate for example if target_percentage is 95 then the rate control will target
1165 * a bit-rate that is 95% of the maximum bit-rate
1167 unsigned int target_percentage;
1168 /* windows size in milliseconds. For example if this is set to 500,
1169 * then the rate control will guarantee the target bit-rate over a 500 ms window
1171 unsigned int window_size;
1172 /* initial QP at I frames */
1173 unsigned int initial_qp;
1174 unsigned int min_qp;
1175 unsigned int basic_unit_size;
1180 unsigned int reset : 1;
1181 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1182 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1183 unsigned int mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1187 } VAEncMiscParameterRateControl;
1189 typedef struct _VAEncMiscParameterFrameRate
1191 unsigned int framerate;
1192 } VAEncMiscParameterFrameRate;
1195 * Allow a maximum slice size to be specified (in bits).
1196 * The encoder will attempt to make sure that individual slices do not exceed this size
1197 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1199 typedef struct _VAEncMiscParameterMaxSliceSize
1201 unsigned int max_slice_size;
1202 } VAEncMiscParameterMaxSliceSize;
1204 typedef struct _VAEncMiscParameterAIR
1206 unsigned int air_num_mbs;
1207 unsigned int air_threshold;
1208 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1209 } VAEncMiscParameterAIR;
1211 typedef struct _VAEncMiscParameterHRD
1213 unsigned int initial_buffer_fullness; /* in bits */
1214 unsigned int buffer_size; /* in bits */
1215 } VAEncMiscParameterHRD;
1218 * \brief Defines a maximum frame size (in bits).
1220 * This misc parameter buffer defines the maximum size of a frame (in
1221 * bits). The encoder will try to make sure that each frame does not
1222 * exceed this size. Otherwise, if the frame size exceeds this size,
1223 * the \c status flag of #VACodedBufferSegment will contain
1224 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1226 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1227 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1228 VAEncMiscParameterType type;
1229 /** \brief Maximum size of a frame (in bits). */
1230 unsigned int max_frame_size;
1231 } VAEncMiscParameterBufferMaxFrameSize;
1234 * \brief Encoding quality level.
1236 * The encoding quality could be set through this structure, if the implementation
1237 * supports multiple quality levels. The quality level set through this structure is
1238 * persistent over the entire coded sequence, or until a new structure is being sent.
1239 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1240 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1241 * quality. The quality level setting is used as a trade-off between quality and speed/power
1242 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1244 typedef struct _VAEncMiscParameterBufferQualityLevel {
1245 /** \brief Encoding quality level setting. When set to 0, default quality
1248 unsigned int quality_level;
1249 } VAEncMiscParameterBufferQualityLevel;
1252 * \brief Encoding skip frame.
1254 * The application may choose to skip frames externally to the encoder (e.g. drop completely or
1255 * code as all skip's). For rate control purposes the encoder will need to know the size and number
1256 * of skipped frames. Skip frame(s) indicated through this structure is applicable only to the
1257 * current frame. It is allowed for the application to still send in packed headers for the driver to
1258 * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).
1260 typedef struct _VAEncMiscParameterSkipFrame {
1261 /** \brief Indicates skip frames as below.
1262 * 0: Encode as normal, no skip.
1263 * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.
1264 * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
1265 * (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame
1266 * in VAEncPackedHeaderPicture). */
1267 unsigned char skip_frame_flag;
1268 /** \brief The number of frames skipped prior to the current frame. Valid when skip_frame_flag = 1. */
1269 unsigned char num_skip_frames;
1270 /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits. When skip_frame_flag = 2,
1271 * the size of the current skipped frame that is to be packed/encrypted in bits. */
1272 unsigned int size_skip_frames;
1273 } VAEncMiscParameterSkipFrame;
1276 * \brief Encoding region-of-interest (ROI).
1278 * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
1279 * supports ROI input. The ROI set through this structure is applicable only to the
1280 * current frame or field, so must be sent every frame or field to be applied. The number of
1281 * supported ROIs can be queried through the VAConfigAttribEncROI. The encoder will use the
1282 * ROI information to adjust the QP values of the MB's that fall within the ROIs.
1284 typedef struct _VAEncROI
1286 /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
1287 * codec coding units. It is relative to frame coordinates for the frame case and
1288 * to field coordinates for the field case. */
1289 VARectangle roi_rectangle;
1293 * \ref roi_value specifies ROI delta QP or ROI priority.
1294 * -- ROI delta QP is the value that will be added on top of the frame level QP.
1295 * -- ROI priority specifies the priority of a region, it can be positive (more important)
1296 * or negative (less important) values and is compared with non-ROI region (taken as value 0),
1297 * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
1298 * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
1299 * regions, the roi_value that is first in the ROI array will have priority.
1301 * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
1302 * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
1304 * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
1305 * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
1306 * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
1311 typedef struct _VAEncMiscParameterBufferROI {
1312 /** \brief Number of ROIs being sent.*/
1313 unsigned int num_roi;
1315 /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
1316 * rate control will determine actual delta QPs. Specifies the max/min allowed delta
1321 /** \brief Pointer to a VAEncROI array with num_roi elements. It is relative to frame
1322 * coordinates for the frame case and to field coordinates for the field case.*/
1327 * \brief An indication for roi value.
1329 * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
1330 * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
1331 * in #VAEncROI should be used as ROI priority.
1333 * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
1334 * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delat_support in
1335 * #VAConfigAttribValEncROI. The underlying driver should ignore this field
1336 * when VAConfigAttribRateControl == VA_RC_CQP.
1338 uint32_t roi_value_is_qp_delta : 1;
1339 uint32_t reserved : 31;
1343 } VAEncMiscParameterBufferROI;
1346 * There will be cases where the bitstream buffer will not have enough room to hold
1347 * the data for the entire slice, and the following flags will be used in the slice
1348 * parameter to signal to the server for the possible cases.
1349 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1350 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1351 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1353 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1354 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1355 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1356 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1358 /* Codec-independent Slice Parameter Buffer base */
1359 typedef struct _VASliceParameterBufferBase
1361 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1362 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1363 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1364 } VASliceParameterBufferBase;
1366 /**********************************
1367 * JPEG common data structures
1368 **********************************/
1370 * \brief Huffman table for JPEG decoding.
1372 * This structure holds the complete Huffman tables. This is an
1373 * aggregation of all Huffman table (DHT) segments maintained by the
1374 * application. i.e. up to 2 Huffman tables are stored in there for
1377 * The #load_huffman_table array can be used as a hint to notify the
1378 * VA driver implementation about which table(s) actually changed
1379 * since the last submission of this buffer.
1381 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1382 /** \brief Specifies which #huffman_table is valid. */
1383 unsigned char load_huffman_table[2];
1384 /** \brief Huffman tables indexed by table identifier (Th). */
1386 /** @name DC table (up to 12 categories) */
1388 /** \brief Number of Huffman codes of length i + 1 (Li). */
1389 unsigned char num_dc_codes[16];
1390 /** \brief Value associated with each Huffman code (Vij). */
1391 unsigned char dc_values[12];
1393 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1395 /** \brief Number of Huffman codes of length i + 1 (Li). */
1396 unsigned char num_ac_codes[16];
1397 /** \brief Value associated with each Huffman code (Vij). */
1398 unsigned char ac_values[162];
1399 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1400 unsigned char pad[2];
1403 } VAHuffmanTableBufferJPEGBaseline;
1405 /****************************
1406 * MPEG-2 data structures
1407 ****************************/
1409 /* MPEG-2 Picture Parameter Buffer */
1411 * For each frame or field, and before any slice data, a single
1412 * picture parameter buffer must be send.
1414 typedef struct _VAPictureParameterBufferMPEG2
1416 unsigned short horizontal_size;
1417 unsigned short vertical_size;
1418 VASurfaceID forward_reference_picture;
1419 VASurfaceID backward_reference_picture;
1420 /* meanings of the following fields are the same as in the standard */
1421 int picture_coding_type;
1422 int f_code; /* pack all four fcode into this */
1425 unsigned int intra_dc_precision : 2;
1426 unsigned int picture_structure : 2;
1427 unsigned int top_field_first : 1;
1428 unsigned int frame_pred_frame_dct : 1;
1429 unsigned int concealment_motion_vectors : 1;
1430 unsigned int q_scale_type : 1;
1431 unsigned int intra_vlc_format : 1;
1432 unsigned int alternate_scan : 1;
1433 unsigned int repeat_first_field : 1;
1434 unsigned int progressive_frame : 1;
1435 unsigned int is_first_field : 1; /* indicate whether the current field
1436 * is the first field for field picture
1440 } picture_coding_extension;
1441 } VAPictureParameterBufferMPEG2;
1443 /** MPEG-2 Inverse Quantization Matrix Buffer */
1444 typedef struct _VAIQMatrixBufferMPEG2
1446 /** \brief Same as the MPEG-2 bitstream syntax element. */
1447 int load_intra_quantiser_matrix;
1448 /** \brief Same as the MPEG-2 bitstream syntax element. */
1449 int load_non_intra_quantiser_matrix;
1450 /** \brief Same as the MPEG-2 bitstream syntax element. */
1451 int load_chroma_intra_quantiser_matrix;
1452 /** \brief Same as the MPEG-2 bitstream syntax element. */
1453 int load_chroma_non_intra_quantiser_matrix;
1454 /** \brief Luminance intra matrix, in zig-zag scan order. */
1455 unsigned char intra_quantiser_matrix[64];
1456 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1457 unsigned char non_intra_quantiser_matrix[64];
1458 /** \brief Chroma intra matrix, in zig-zag scan order. */
1459 unsigned char chroma_intra_quantiser_matrix[64];
1460 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1461 unsigned char chroma_non_intra_quantiser_matrix[64];
1462 } VAIQMatrixBufferMPEG2;
1464 /** MPEG-2 Slice Parameter Buffer */
1465 typedef struct _VASliceParameterBufferMPEG2
1467 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1468 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1469 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1470 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1471 unsigned int slice_horizontal_position;
1472 unsigned int slice_vertical_position;
1473 int quantiser_scale_code;
1474 int intra_slice_flag;
1475 } VASliceParameterBufferMPEG2;
1477 /** MPEG-2 Macroblock Parameter Buffer */
1478 typedef struct _VAMacroblockParameterBufferMPEG2
1480 unsigned short macroblock_address;
1482 * macroblock_address (in raster scan order)
1484 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1486 unsigned char macroblock_type; /* see definition below */
1489 unsigned int frame_motion_type : 2;
1490 unsigned int field_motion_type : 2;
1491 unsigned int dct_type : 1;
1495 unsigned char motion_vertical_field_select;
1497 * motion_vertical_field_select:
1498 * see section 6.3.17.2 in the spec
1499 * only the lower 4 bits are used
1500 * bit 0: first vector forward
1501 * bit 1: first vector backward
1502 * bit 2: second vector forward
1503 * bit 3: second vector backward
1505 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1506 unsigned short coded_block_pattern;
1508 * The bitplanes for coded_block_pattern are described
1509 * in Figure 6.10-12 in the spec
1512 /* Number of skipped macroblocks after this macroblock */
1513 unsigned short num_skipped_macroblocks;
1514 } VAMacroblockParameterBufferMPEG2;
1517 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1519 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1520 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1521 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1522 #define VA_MB_TYPE_MOTION_INTRA 0x10
1525 * MPEG-2 Residual Data Buffer
1526 * For each macroblock, there wil be 64 shorts (16-bit) in the
1527 * residual data buffer
1530 /****************************
1531 * MPEG-4 Part 2 data structures
1532 ****************************/
1534 /* MPEG-4 Picture Parameter Buffer */
1536 * For each frame or field, and before any slice data, a single
1537 * picture parameter buffer must be send.
1539 typedef struct _VAPictureParameterBufferMPEG4
1541 unsigned short vop_width;
1542 unsigned short vop_height;
1543 VASurfaceID forward_reference_picture;
1544 VASurfaceID backward_reference_picture;
1547 unsigned int short_video_header : 1;
1548 unsigned int chroma_format : 2;
1549 unsigned int interlaced : 1;
1550 unsigned int obmc_disable : 1;
1551 unsigned int sprite_enable : 2;
1552 unsigned int sprite_warping_accuracy : 2;
1553 unsigned int quant_type : 1;
1554 unsigned int quarter_sample : 1;
1555 unsigned int data_partitioned : 1;
1556 unsigned int reversible_vlc : 1;
1557 unsigned int resync_marker_disable : 1;
1561 unsigned char no_of_sprite_warping_points;
1562 short sprite_trajectory_du[3];
1563 short sprite_trajectory_dv[3];
1564 unsigned char quant_precision;
1567 unsigned int vop_coding_type : 2;
1568 unsigned int backward_reference_vop_coding_type : 2;
1569 unsigned int vop_rounding_type : 1;
1570 unsigned int intra_dc_vlc_thr : 3;
1571 unsigned int top_field_first : 1;
1572 unsigned int alternate_vertical_scan_flag : 1;
1576 unsigned char vop_fcode_forward;
1577 unsigned char vop_fcode_backward;
1578 unsigned short vop_time_increment_resolution;
1579 /* short header related */
1580 unsigned char num_gobs_in_vop;
1581 unsigned char num_macroblocks_in_gob;
1582 /* for direct mode prediction */
1585 } VAPictureParameterBufferMPEG4;
1587 /** MPEG-4 Inverse Quantization Matrix Buffer */
1588 typedef struct _VAIQMatrixBufferMPEG4
1590 /** Same as the MPEG-4:2 bitstream syntax element. */
1591 int load_intra_quant_mat;
1592 /** Same as the MPEG-4:2 bitstream syntax element. */
1593 int load_non_intra_quant_mat;
1594 /** The matrix for intra blocks, in zig-zag scan order. */
1595 unsigned char intra_quant_mat[64];
1596 /** The matrix for non-intra blocks, in zig-zag scan order. */
1597 unsigned char non_intra_quant_mat[64];
1598 } VAIQMatrixBufferMPEG4;
1600 /** MPEG-4 Slice Parameter Buffer */
1601 typedef struct _VASliceParameterBufferMPEG4
1603 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1604 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1605 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1606 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1607 unsigned int macroblock_number;
1609 } VASliceParameterBufferMPEG4;
1612 VC-1 data structures
1615 typedef enum /* see 7.1.1.32 */
1618 VAMvMode1MvHalfPel = 1,
1619 VAMvMode1MvHalfPelBilinear = 2,
1620 VAMvModeMixedMv = 3,
1621 VAMvModeIntensityCompensation = 4
1624 /** VC-1 Picture Parameter Buffer */
1626 * For each picture, and before any slice data, a picture parameter
1627 * buffer must be send. Multiple picture parameter buffers may be
1628 * sent for a single picture. In that case picture parameters will
1629 * apply to all slice data that follow it until a new picture
1630 * parameter buffer is sent.
1633 * pic_quantizer_type should be set to the applicable quantizer
1634 * type as defined by QUANTIZER (J.1.19) and either
1635 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1637 typedef struct _VAPictureParameterBufferVC1
1639 VASurfaceID forward_reference_picture;
1640 VASurfaceID backward_reference_picture;
1641 /* if out-of-loop post-processing is done on the render
1642 target, then we need to keep the in-loop decoded
1643 picture as a reference picture */
1644 VASurfaceID inloop_decoded_picture;
1646 /* sequence layer for AP or meta data for SP and MP */
1649 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1650 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1651 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1652 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1653 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1654 unsigned int multires : 1; /* METADATA::MULTIRES */
1655 unsigned int overlap : 1; /* METADATA::OVERLAP */
1656 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1657 unsigned int rangered : 1; /* METADATA::RANGERED */
1658 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1659 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1664 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1665 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1668 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1669 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1670 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1671 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1674 } entrypoint_fields;
1675 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1676 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1679 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1680 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1681 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1682 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1685 } range_mapping_fields;
1687 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1688 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1689 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1690 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1691 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1692 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1693 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1694 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1695 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1698 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1699 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1700 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1701 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1702 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1708 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1709 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1710 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1711 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1712 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1713 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1714 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1720 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1721 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1722 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1723 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1724 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1725 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1726 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1729 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1732 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1733 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1734 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1735 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1741 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1742 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1743 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1744 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1745 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1746 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1747 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1748 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1749 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1750 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1756 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1757 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1758 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1759 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1760 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1761 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1762 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1763 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1764 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1765 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1766 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1769 } pic_quantizer_fields;
1772 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1773 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1774 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1775 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1776 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1777 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1781 } VAPictureParameterBufferVC1;
1783 /** VC-1 Bitplane Buffer
1784 There will be at most three bitplanes coded in any picture header. To send
1785 the bitplane data more efficiently, each byte is divided in two nibbles, with
1786 each nibble carrying three bitplanes for one macroblock. The following table
1787 shows the bitplane data arrangement within each nibble based on the picture
1790 Picture Type Bit3 Bit2 Bit1 Bit0
1791 I or BI OVERFLAGS ACPRED FIELDTX
1792 P MYTYPEMB SKIPMB DIRECTMB
1793 B FORWARDMB SKIPMB DIRECTMB
1795 Within each byte, the lower nibble is for the first MB and the upper nibble is
1796 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1797 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1798 Macroblock #2 in the first row.
1801 /* VC-1 Slice Parameter Buffer */
1802 typedef struct _VASliceParameterBufferVC1
1804 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1805 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1806 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1807 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1808 unsigned int slice_vertical_position;
1809 } VASliceParameterBufferVC1;
1811 /* VC-1 Slice Data Buffer */
1813 This is simplely a buffer containing raw bit-stream bytes
1816 /****************************
1817 * H.264/AVC data structures
1818 ****************************/
1820 typedef struct _VAPictureH264
1822 VASurfaceID picture_id;
1823 unsigned int frame_idx;
1825 signed int TopFieldOrderCnt;
1826 signed int BottomFieldOrderCnt;
1828 /* flags in VAPictureH264 could be OR of the following */
1829 #define VA_PICTURE_H264_INVALID 0x00000001
1830 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1831 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1832 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1833 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1835 /** H.264 Picture Parameter Buffer */
1837 * For each picture, and before any slice data, a single
1838 * picture parameter buffer must be send.
1840 typedef struct _VAPictureParameterBufferH264
1842 VAPictureH264 CurrPic;
1843 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1844 unsigned short picture_width_in_mbs_minus1;
1845 unsigned short picture_height_in_mbs_minus1;
1846 unsigned char bit_depth_luma_minus8;
1847 unsigned char bit_depth_chroma_minus8;
1848 unsigned char num_ref_frames;
1851 unsigned int chroma_format_idc : 2;
1852 unsigned int residual_colour_transform_flag : 1;
1853 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1854 unsigned int frame_mbs_only_flag : 1;
1855 unsigned int mb_adaptive_frame_field_flag : 1;
1856 unsigned int direct_8x8_inference_flag : 1;
1857 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1858 unsigned int log2_max_frame_num_minus4 : 4;
1859 unsigned int pic_order_cnt_type : 2;
1860 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1861 unsigned int delta_pic_order_always_zero_flag : 1;
1865 unsigned char num_slice_groups_minus1;
1866 unsigned char slice_group_map_type;
1867 unsigned short slice_group_change_rate_minus1;
1868 signed char pic_init_qp_minus26;
1869 signed char pic_init_qs_minus26;
1870 signed char chroma_qp_index_offset;
1871 signed char second_chroma_qp_index_offset;
1874 unsigned int entropy_coding_mode_flag : 1;
1875 unsigned int weighted_pred_flag : 1;
1876 unsigned int weighted_bipred_idc : 2;
1877 unsigned int transform_8x8_mode_flag : 1;
1878 unsigned int field_pic_flag : 1;
1879 unsigned int constrained_intra_pred_flag : 1;
1880 unsigned int pic_order_present_flag : 1;
1881 unsigned int deblocking_filter_control_present_flag : 1;
1882 unsigned int redundant_pic_cnt_present_flag : 1;
1883 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1887 unsigned short frame_num;
1888 } VAPictureParameterBufferH264;
1890 /** H.264 Inverse Quantization Matrix Buffer */
1891 typedef struct _VAIQMatrixBufferH264
1893 /** \brief 4x4 scaling list, in raster scan order. */
1894 unsigned char ScalingList4x4[6][16];
1895 /** \brief 8x8 scaling list, in raster scan order. */
1896 unsigned char ScalingList8x8[2][64];
1897 } VAIQMatrixBufferH264;
1900 * H.264 Slice Group Map Buffer
1901 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1902 * A slice group map buffer should be sent for each picture if required. The buffer
1903 * is sent only when there is a change in the mapping values.
1904 * The slice group map buffer map "map units" to slice groups as specified in
1905 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1906 * in raster scan order
1909 /** H.264 Slice Parameter Buffer */
1910 typedef struct _VASliceParameterBufferH264
1912 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1913 /** \brief Byte offset to the NAL Header Unit for this slice. */
1914 unsigned int slice_data_offset;
1915 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1917 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1919 * This bit offset is relative to and includes the NAL unit byte
1920 * and represents the number of bits parsed in the slice_header()
1921 * after the removal of any emulation prevention bytes in
1922 * there. However, the slice data buffer passed to the hardware is
1923 * the original bitstream, thus including any emulation prevention
1926 unsigned short slice_data_bit_offset;
1927 unsigned short first_mb_in_slice;
1928 unsigned char slice_type;
1929 unsigned char direct_spatial_mv_pred_flag;
1930 unsigned char num_ref_idx_l0_active_minus1;
1931 unsigned char num_ref_idx_l1_active_minus1;
1932 unsigned char cabac_init_idc;
1933 char slice_qp_delta;
1934 unsigned char disable_deblocking_filter_idc;
1935 char slice_alpha_c0_offset_div2;
1936 char slice_beta_offset_div2;
1937 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1938 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1939 unsigned char luma_log2_weight_denom;
1940 unsigned char chroma_log2_weight_denom;
1941 unsigned char luma_weight_l0_flag;
1942 short luma_weight_l0[32];
1943 short luma_offset_l0[32];
1944 unsigned char chroma_weight_l0_flag;
1945 short chroma_weight_l0[32][2];
1946 short chroma_offset_l0[32][2];
1947 unsigned char luma_weight_l1_flag;
1948 short luma_weight_l1[32];
1949 short luma_offset_l1[32];
1950 unsigned char chroma_weight_l1_flag;
1951 short chroma_weight_l1[32][2];
1952 short chroma_offset_l1[32][2];
1953 } VASliceParameterBufferH264;
1955 /****************************
1956 * Common encode data structures
1957 ****************************/
1960 VAEncPictureTypeIntra = 0,
1961 VAEncPictureTypePredictive = 1,
1962 VAEncPictureTypeBidirectional = 2,
1965 /* Encode Slice Parameter Buffer */
1966 typedef struct _VAEncSliceParameterBuffer
1968 unsigned int start_row_number; /* starting MB row number for this slice */
1969 unsigned int slice_height; /* slice height measured in MB */
1972 unsigned int is_intra : 1;
1973 unsigned int disable_deblocking_filter_idc : 2;
1974 unsigned int uses_long_term_ref :1;
1975 unsigned int is_long_term_ref :1;
1979 } VAEncSliceParameterBuffer;
1982 /****************************
1983 * H.263 specific encode data structures
1984 ****************************/
1986 typedef struct _VAEncSequenceParameterBufferH263
1988 unsigned int intra_period;
1989 unsigned int bits_per_second;
1990 unsigned int frame_rate;
1991 unsigned int initial_qp;
1992 unsigned int min_qp;
1993 } VAEncSequenceParameterBufferH263;
1995 typedef struct _VAEncPictureParameterBufferH263
1997 VASurfaceID reference_picture;
1998 VASurfaceID reconstructed_picture;
1999 VABufferID coded_buf;
2000 unsigned short picture_width;
2001 unsigned short picture_height;
2002 VAEncPictureType picture_type;
2003 } VAEncPictureParameterBufferH263;
2005 /****************************
2006 * MPEG-4 specific encode data structures
2007 ****************************/
2009 typedef struct _VAEncSequenceParameterBufferMPEG4
2011 unsigned char profile_and_level_indication;
2012 unsigned int intra_period;
2013 unsigned int video_object_layer_width;
2014 unsigned int video_object_layer_height;
2015 unsigned int vop_time_increment_resolution;
2016 unsigned int fixed_vop_rate;
2017 unsigned int fixed_vop_time_increment;
2018 unsigned int bits_per_second;
2019 unsigned int frame_rate;
2020 unsigned int initial_qp;
2021 unsigned int min_qp;
2022 } VAEncSequenceParameterBufferMPEG4;
2024 typedef struct _VAEncPictureParameterBufferMPEG4
2026 VASurfaceID reference_picture;
2027 VASurfaceID reconstructed_picture;
2028 VABufferID coded_buf;
2029 unsigned short picture_width;
2030 unsigned short picture_height;
2031 unsigned int modulo_time_base; /* number of 1s */
2032 unsigned int vop_time_increment;
2033 VAEncPictureType picture_type;
2034 } VAEncPictureParameterBufferMPEG4;
2038 /** Buffer functions */
2041 * Creates a buffer for "num_elements" elements of "size" bytes and
2042 * initalize with "data".
2043 * if "data" is null, then the contents of the buffer data store
2045 * Basically there are two ways to get buffer data to the server side. One is
2046 * to call vaCreateBuffer() with a non-null "data", which results the data being
2047 * copied to the data store on the server side. A different method that
2048 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
2049 * and then use vaMapBuffer() to map the data store from the server side to the
2050 * client address space for access.
2051 * Note: image buffers are created by the library, not the client. Please see
2052 * vaCreateImage on how image buffers are managed.
2054 VAStatus vaCreateBuffer (
2056 VAContextID context,
2057 VABufferType type, /* in */
2058 unsigned int size, /* in */
2059 unsigned int num_elements, /* in */
2060 void *data, /* in */
2061 VABufferID *buf_id /* out */
2065 * Convey to the server how many valid elements are in the buffer.
2066 * e.g. if multiple slice parameters are being held in a single buffer,
2067 * this will communicate to the server the number of slice parameters
2068 * that are valid in the buffer.
2070 VAStatus vaBufferSetNumElements (
2072 VABufferID buf_id, /* in */
2073 unsigned int num_elements /* in */
2078 * device independent data structure for codedbuffer
2082 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
2083 * LARGE_SLICE(bit8):At least one slice in the current frame was large
2084 * enough for the encoder to attempt to limit its size.
2085 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
2086 * exceeded the maximum slice size specified.
2087 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
2088 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
2089 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
2091 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
2092 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
2093 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
2094 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
2095 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
2097 * \brief The frame has exceeded the maximum requested size.
2099 * This flag indicates that the encoded frame size exceeds the value
2100 * specified through a misc parameter buffer of type
2101 * #VAEncMiscParameterTypeMaxFrameSize.
2103 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
2104 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
2107 * \brief The coded buffer segment contains a single NAL unit.
2109 * This flag indicates that the coded buffer segment contains a
2110 * single NAL unit. This flag might be useful to the user for
2111 * processing the coded buffer.
2113 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
2116 * \brief Coded buffer segment.
2118 * #VACodedBufferSegment is an element of a linked list describing
2119 * some information on the coded buffer. The coded buffer segment
2120 * could contain either a single NAL unit, or more than one NAL unit.
2121 * It is recommended (but not required) to return a single NAL unit
2122 * in a coded buffer segment, and the implementation should set the
2123 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
2125 typedef struct _VACodedBufferSegment {
2127 * \brief Size of the data buffer in this segment (in bytes).
2130 /** \brief Bit offset into the data buffer where the video data starts. */
2131 unsigned int bit_offset;
2132 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
2133 unsigned int status;
2134 /** \brief Reserved for future use. */
2135 unsigned int reserved;
2136 /** \brief Pointer to the start of the data buffer. */
2139 * \brief Pointer to the next #VACodedBufferSegment element,
2140 * or \c NULL if there is none.
2143 } VACodedBufferSegment;
2146 * Map data store of the buffer into the client's address space
2147 * vaCreateBuffer() needs to be called with "data" set to NULL before
2148 * calling vaMapBuffer()
2150 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
2151 * VACodedBufferSegment, and the list is terminated if "next" is NULL
2153 VAStatus vaMapBuffer (
2155 VABufferID buf_id, /* in */
2156 void **pbuf /* out */
2160 * After client making changes to a mapped data store, it needs to
2161 * "Unmap" it to let the server know that the data is ready to be
2162 * consumed by the server
2164 VAStatus vaUnmapBuffer (
2166 VABufferID buf_id /* in */
2170 * After this call, the buffer is deleted and this buffer_id is no longer valid
2171 * Only call this if the buffer is not going to be passed to vaRenderBuffer
2173 VAStatus vaDestroyBuffer (
2175 VABufferID buffer_id
2178 /** \brief VA buffer information */
2180 /** \brief Buffer handle */
2182 /** \brief Buffer type (See \ref VABufferType). */
2185 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
2187 * On input to vaAcquireBufferHandle(), this field can serve as a hint
2188 * to specify the set of memory types the caller is interested in.
2189 * On successful return from vaAcquireBufferHandle(), the field is
2190 * updated with the best matching memory type.
2193 /** \brief Size of the underlying buffer. */
2198 * \brief Acquires buffer handle for external API usage
2200 * Locks the VA buffer object \ref buf_id for external API usage like
2201 * EGL or OpenCL (OCL). This function is a synchronization point. This
2202 * means that any pending operation is guaranteed to be completed
2203 * prior to returning from the function.
2205 * If the referenced VA buffer object is the backing store of a VA
2206 * surface, then this function acts as if vaSyncSurface() on the
2207 * parent surface was called first.
2209 * The \ref VABufferInfo argument shall be zero'ed on input. On
2210 * successful output, the data structure is filled in with all the
2211 * necessary buffer level implementation details like handle, type,
2212 * memory type and memory size.
2214 * Note: the external API implementation, or the application, can
2215 * express the memory types it is interested in by filling in the \ref
2216 * mem_type field accordingly. On successful output, the memory type
2217 * that fits best the request and that was used is updated in the \ref
2218 * VABufferInfo data structure. If none of the supplied memory types
2219 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2220 * error is returned.
2222 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2223 * is called. Besides, no additional operation is allowed on any of
2224 * the buffer parent object until vaReleaseBufferHandle() is called.
2225 * e.g. decoding into a VA surface backed with the supplied VA buffer
2226 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2230 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2231 * does not support this interface
2232 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2233 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2234 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2235 * does not support exporting buffers of the specified type
2236 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2237 * memory types in \ref VABufferInfo.mem_type was supported
2239 * @param[in] dpy the VA display
2240 * @param[in] buf_id the VA buffer
2241 * @param[in,out] buf_info the associated VA buffer information
2242 * @return VA_STATUS_SUCCESS if successful
2245 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2248 * \brief Releases buffer after usage from external API
2250 * Unlocks the VA buffer object \ref buf_id from external API usage like
2251 * EGL or OpenCL (OCL). This function is a synchronization point. This
2252 * means that any pending operation is guaranteed to be completed
2253 * prior to returning from the function.
2255 * The \ref VABufferInfo argument shall point to the original data
2256 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2257 * This is necessary so that the VA driver implementation could
2258 * deallocate any resources that were needed.
2260 * In any case, returning from this function invalidates any contents
2261 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2262 * valid. Therefore, VA driver implementations are free to reset this
2263 * data structure to safe defaults.
2266 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2267 * does not support this interface
2268 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2269 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2270 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2271 * does not support exporting buffers of the specified type
2273 * @param[in] dpy the VA display
2274 * @param[in] buf_id the VA buffer
2275 * @return VA_STATUS_SUCCESS if successful
2278 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2281 Render (Decode) Pictures
2283 A picture represents either a frame or a field.
2285 The Begin/Render/End sequence sends the decode buffers to the server
2289 * Get ready to decode a picture to a target surface
2291 VAStatus vaBeginPicture (
2293 VAContextID context,
2294 VASurfaceID render_target
2298 * Send decode buffers to the server.
2299 * Buffers are automatically destroyed afterwards
2301 VAStatus vaRenderPicture (
2303 VAContextID context,
2304 VABufferID *buffers,
2309 * Make the end of rendering for a picture.
2310 * The server should start processing all pending operations for this
2311 * surface. This call is non-blocking. The client can start another
2312 * Begin/Render/End sequence on a different render target.
2314 VAStatus vaEndPicture (
2326 * This function blocks until all pending operations on the render target
2327 * have been completed. Upon return it is safe to use the render target for a
2328 * different picture.
2330 VAStatus vaSyncSurface (
2332 VASurfaceID render_target
2337 VASurfaceRendering = 1, /* Rendering in progress */
2338 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2339 /* this status is useful if surface is used as the source */
2341 VASurfaceReady = 4, /* not being rendered or displayed */
2342 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2346 * Find out any pending ops on the render target
2348 VAStatus vaQuerySurfaceStatus (
2350 VASurfaceID render_target,
2351 VASurfaceStatus *status /* out */
2356 VADecodeSliceMissing = 0,
2357 VADecodeMBError = 1,
2358 } VADecodeErrorType;
2361 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2362 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2364 typedef struct _VASurfaceDecodeMBErrors
2366 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2367 unsigned int start_mb; /* start mb address with errors */
2368 unsigned int end_mb; /* end mb address with errors */
2369 VADecodeErrorType decode_error_type;
2370 } VASurfaceDecodeMBErrors;
2373 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2374 * it can call vaQuerySurfaceError to find out further details on the particular error.
2375 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2376 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2377 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2378 * The array is terminated if "status==-1" is detected.
2380 VAStatus vaQuerySurfaceError(
2382 VASurfaceID surface,
2383 VAStatus error_status,
2388 * Images and Subpictures
2389 * VAImage is used to either get the surface data to client memory, or
2390 * to copy image data in client memory to a surface.
2391 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2392 * is at the upper left corner with positive X to the right and positive Y down
2394 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2395 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2396 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2399 * Pre-defined fourcc codes
2401 #define VA_FOURCC_NV12 0x3231564E
2402 #define VA_FOURCC_AI44 0x34344149
2403 #define VA_FOURCC_RGBA 0x41424752
2404 #define VA_FOURCC_RGBX 0x58424752
2405 #define VA_FOURCC_BGRA 0x41524742
2406 #define VA_FOURCC_BGRX 0x58524742
2407 #define VA_FOURCC_ARGB 0x42475241
2408 #define VA_FOURCC_XRGB 0x42475258
2409 #define VA_FOURCC_ABGR 0x52474241
2410 #define VA_FOURCC_XBGR 0x52474258
2411 #define VA_FOURCC_UYVY 0x59565955
2412 #define VA_FOURCC_YUY2 0x32595559
2413 #define VA_FOURCC_AYUV 0x56555941
2414 #define VA_FOURCC_NV11 0x3131564e
2415 #define VA_FOURCC_YV12 0x32315659
2416 #define VA_FOURCC_P208 0x38303250
2417 #define VA_FOURCC_IYUV 0x56555949
2418 #define VA_FOURCC_YV24 0x34325659
2419 #define VA_FOURCC_YV32 0x32335659
2420 #define VA_FOURCC_Y800 0x30303859
2421 #define VA_FOURCC_IMC3 0x33434D49
2422 #define VA_FOURCC_411P 0x50313134
2423 #define VA_FOURCC_422H 0x48323234
2424 #define VA_FOURCC_422V 0x56323234
2425 #define VA_FOURCC_444P 0x50343434
2426 #define VA_FOURCC_RGBP 0x50424752
2427 #define VA_FOURCC_BGRP 0x50524742
2428 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2431 * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
2433 #define VA_FOURCC_YV16 0x36315659
2435 * 10-bit and 16-bit Planar YUV 4:2:0.
2437 #define VA_FOURCC_P010 0x30313050
2438 #define VA_FOURCC_P016 0x36313050
2441 #define VA_LSB_FIRST 1
2442 #define VA_MSB_FIRST 2
2444 typedef struct _VAImageFormat
2446 unsigned int fourcc;
2447 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2448 unsigned int bits_per_pixel;
2449 /* for RGB formats */
2450 unsigned int depth; /* significant bits per pixel */
2451 unsigned int red_mask;
2452 unsigned int green_mask;
2453 unsigned int blue_mask;
2454 unsigned int alpha_mask;
2457 typedef VAGenericID VAImageID;
2459 typedef struct _VAImage
2461 VAImageID image_id; /* uniquely identify this image */
2462 VAImageFormat format;
2463 VABufferID buf; /* image data buffer */
2465 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2466 * data store on the server side for optimal performance. The buffer will be
2467 * created by the CreateImage function, and proper storage allocated based on the image
2468 * size and format. This buffer is managed by the library implementation, and
2469 * accessed by the client through the buffer Map/Unmap functions.
2471 unsigned short width;
2472 unsigned short height;
2473 unsigned int data_size;
2474 unsigned int num_planes; /* can not be greater than 3 */
2476 * An array indicating the scanline pitch in bytes for each plane.
2477 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2479 unsigned int pitches[3];
2481 * An array indicating the byte offset from the beginning of the image data
2482 * to the start of each plane.
2484 unsigned int offsets[3];
2486 /* The following fields are only needed for paletted formats */
2487 int num_palette_entries; /* set to zero for non-palette images */
2489 * Each component is one byte and entry_bytes indicates the number of components in
2490 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2494 * An array of ascii characters describing the order of the components within the bytes.
2495 * Only entry_bytes characters of the string are used.
2497 char component_order[4];
2500 /** Get maximum number of image formats supported by the implementation */
2501 int vaMaxNumImageFormats (
2506 * Query supported image formats
2507 * The caller must provide a "format_list" array that can hold at
2508 * least vaMaxNumImageFormats() entries. The actual number of formats
2509 * returned in "format_list" is returned in "num_formats".
2511 VAStatus vaQueryImageFormats (
2513 VAImageFormat *format_list, /* out */
2514 int *num_formats /* out */
2518 * Create a VAImage structure
2519 * The width and height fields returned in the VAImage structure may get
2520 * enlarged for some YUV formats. Upon return from this function,
2521 * image->buf has been created and proper storage allocated by the library.
2522 * The client can access the image through the Map/Unmap calls.
2524 VAStatus vaCreateImage (
2526 VAImageFormat *format,
2529 VAImage *image /* out */
2533 * Should call DestroyImage before destroying the surface it is bound to
2535 VAStatus vaDestroyImage (
2540 VAStatus vaSetImagePalette (
2544 * pointer to an array holding the palette data. The size of the array is
2545 * num_palette_entries * entry_bytes in size. The order of the components
2546 * in the palette is described by the component_order in VAImage struct
2548 unsigned char *palette
2552 * Retrive surface data into a VAImage
2553 * Image must be in a format supported by the implementation
2555 VAStatus vaGetImage (
2557 VASurfaceID surface,
2558 int x, /* coordinates of the upper left source pixel */
2560 unsigned int width, /* width and height of the region */
2561 unsigned int height,
2566 * Copy data from a VAImage to a surface
2567 * Image must be in a format supported by the implementation
2568 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2569 * shouldn't be rendered into when this is called
2571 VAStatus vaPutImage (
2573 VASurfaceID surface,
2577 unsigned int src_width,
2578 unsigned int src_height,
2581 unsigned int dest_width,
2582 unsigned int dest_height
2586 * Derive an VAImage from an existing surface.
2587 * This interface will derive a VAImage and corresponding image buffer from
2588 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2589 * direct CPU access. This operation is only possible on implementations with
2590 * direct rendering capabilities and internal surface formats that can be
2591 * represented with a VAImage. When the operation is not possible this interface
2592 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2593 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2596 * Implementations should only return success when the resulting image buffer
2597 * would be useable with vaMap/Unmap.
2599 * When directly accessing a surface special care must be taken to insure
2600 * proper synchronization with the graphics hardware. Clients should call
2601 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2602 * rendering or currently being displayed by an overlay.
2604 * Additionally nothing about the contents of a surface should be assumed
2605 * following a vaPutSurface. Implementations are free to modify the surface for
2606 * scaling or subpicture blending within a call to vaPutImage.
2608 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2609 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2610 * vaGetImage with other surfaces is supported.
2612 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2613 * image and image buffer structures will be destroyed; however, the underlying
2614 * surface will remain unchanged until freed with vaDestroySurfaces.
2616 VAStatus vaDeriveImage (
2618 VASurfaceID surface,
2619 VAImage *image /* out */
2624 * Subpicture is a special type of image that can be blended
2625 * with a surface during vaPutSurface(). Subpicture can be used to render
2626 * DVD sub-titles or closed captioning text etc.
2629 typedef VAGenericID VASubpictureID;
2631 /** Get maximum number of subpicture formats supported by the implementation */
2632 int vaMaxNumSubpictureFormats (
2636 /** flags for subpictures */
2637 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2638 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2639 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2641 * Query supported subpicture formats
2642 * The caller must provide a "format_list" array that can hold at
2643 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2644 * for each format to indicate additional capabilities for that format. The actual
2645 * number of formats returned in "format_list" is returned in "num_formats".
2646 * flags: returned value to indicate addtional capabilities
2647 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2648 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2649 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2652 VAStatus vaQuerySubpictureFormats (
2654 VAImageFormat *format_list, /* out */
2655 unsigned int *flags, /* out */
2656 unsigned int *num_formats /* out */
2660 * Subpictures are created with an image associated.
2662 VAStatus vaCreateSubpicture (
2665 VASubpictureID *subpicture /* out */
2669 * Destroy the subpicture before destroying the image it is assocated to
2671 VAStatus vaDestroySubpicture (
2673 VASubpictureID subpicture
2677 * Bind an image to the subpicture. This image will now be associated with
2678 * the subpicture instead of the one at creation.
2680 VAStatus vaSetSubpictureImage (
2682 VASubpictureID subpicture,
2687 * If chromakey is enabled, then the area where the source value falls within
2688 * the chromakey [min, max] range is transparent
2689 * The chromakey component format is the following:
2690 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2691 * For YUV: [0:7] V [8:15] U [16:23] Y
2692 * The chromakey mask can be used to mask out certain components for chromakey
2695 VAStatus vaSetSubpictureChromakey (
2697 VASubpictureID subpicture,
2698 unsigned int chromakey_min,
2699 unsigned int chromakey_max,
2700 unsigned int chromakey_mask
2704 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2705 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2706 * the overall alpha is per-pixel alpha multiplied by the global alpha
2708 VAStatus vaSetSubpictureGlobalAlpha (
2710 VASubpictureID subpicture,
2715 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2716 * It defines the region mapping between the subpicture and the target
2717 * surfaces through source and destination rectangles (with the same width and height).
2718 * Both will be displayed at the next call to vaPutSurface. Additional
2719 * associations before the call to vaPutSurface simply overrides the association.
2721 VAStatus vaAssociateSubpicture (
2723 VASubpictureID subpicture,
2724 VASurfaceID *target_surfaces,
2726 short src_x, /* upper left offset in subpicture */
2728 unsigned short src_width,
2729 unsigned short src_height,
2730 short dest_x, /* upper left offset in surface */
2732 unsigned short dest_width,
2733 unsigned short dest_height,
2735 * whether to enable chroma-keying, global-alpha, or screen relative mode
2736 * see VA_SUBPICTURE_XXX values
2742 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2744 VAStatus vaDeassociateSubpicture (
2746 VASubpictureID subpicture,
2747 VASurfaceID *target_surfaces,
2752 * Display attributes
2753 * Display attributes are used to control things such as contrast, hue, saturation,
2754 * brightness etc. in the rendering process. The application can query what
2755 * attributes are supported by the driver, and then set the appropriate attributes
2756 * before calling vaPutSurface()
2758 /* PowerVR IEP Lite attributes */
2761 VADISPLAYATTRIB_BLE_OFF = 0x00,
2762 VADISPLAYATTRIB_BLE_LOW,
2763 VADISPLAYATTRIB_BLE_MEDIUM,
2764 VADISPLAYATTRIB_BLE_HIGH,
2765 VADISPLAYATTRIB_BLE_NONE,
2766 } VADisplayAttribBLEMode;
2768 /** attribute value for VADisplayAttribRotation */
2769 #define VA_ROTATION_NONE 0x00000000
2770 #define VA_ROTATION_90 0x00000001
2771 #define VA_ROTATION_180 0x00000002
2772 #define VA_ROTATION_270 0x00000003
2774 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2775 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2776 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2779 #define VA_RENDER_MODE_UNDEFINED 0
2780 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2781 #define VA_RENDER_MODE_LOCAL_GPU 2
2782 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2783 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2785 /** Render device */
2786 #define VA_RENDER_DEVICE_UNDEFINED 0
2787 #define VA_RENDER_DEVICE_LOCAL 1
2788 #define VA_RENDER_DEVICE_EXTERNAL 2
2790 /** Currently defined display attribute types */
2793 VADisplayAttribBrightness = 0,
2794 VADisplayAttribContrast = 1,
2795 VADisplayAttribHue = 2,
2796 VADisplayAttribSaturation = 3,
2797 /* client can specifiy a background color for the target window
2798 * the new feature of video conference,
2799 * the uncovered area of the surface is filled by this color
2800 * also it will blend with the decoded video color
2802 VADisplayAttribBackgroundColor = 4,
2804 * this is a gettable only attribute. For some implementations that use the
2805 * hardware overlay, after PutSurface is called, the surface can not be
2806 * re-used until after the subsequent PutSurface call. If this is the case
2807 * then the value for this attribute will be set to 1 so that the client
2808 * will not attempt to re-use the surface right after returning from a call
2811 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2812 * driver may use overlay or GPU alternatively
2814 VADisplayAttribDirectSurface = 5,
2815 VADisplayAttribRotation = 6,
2816 VADisplayAttribOutofLoopDeblock = 7,
2818 /* PowerVR IEP Lite specific attributes */
2819 VADisplayAttribBLEBlackMode = 8,
2820 VADisplayAttribBLEWhiteMode = 9,
2821 VADisplayAttribBlueStretch = 10,
2822 VADisplayAttribSkinColorCorrection = 11,
2824 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2825 * conversion matrix. Each element in the matrix is float-point
2827 VADisplayAttribCSCMatrix = 12,
2828 /* specify the constant color used to blend with video surface
2829 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2830 * d: the final color to overwrite into the frame buffer
2831 * v: decoded video after color conversion,
2832 * c: video color specified by VADisplayAttribBlendColor
2833 * b: background color of the drawable
2835 VADisplayAttribBlendColor = 13,
2837 * Indicate driver to skip painting color key or not.
2838 * only applicable if the render is overlay
2840 VADisplayAttribOverlayAutoPaintColorKey = 14,
2842 * customized overlay color key, the format is RGB888
2843 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2845 VADisplayAttribOverlayColorKey = 15,
2847 * The hint for the implementation of vaPutSurface
2848 * normally, the driver could use an overlay or GPU to render the surface on the screen
2849 * this flag provides APP the flexibity to switch the render dynamically
2851 VADisplayAttribRenderMode = 16,
2853 * specify if vaPutSurface needs to render into specified monitors
2854 * one example is that one external monitor (e.g. HDMI) is enabled,
2855 * but the window manager is not aware of it, and there is no associated drawable
2857 VADisplayAttribRenderDevice = 17,
2859 * specify vaPutSurface render area if there is no drawable on the monitor
2861 VADisplayAttribRenderRect = 18,
2862 } VADisplayAttribType;
2864 /* flags for VADisplayAttribute */
2865 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2866 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2867 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2869 typedef struct _VADisplayAttribute
2871 VADisplayAttribType type;
2874 int value; /* used by the set/get attribute functions */
2875 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2877 } VADisplayAttribute;
2879 /** Get maximum number of display attributs supported by the implementation */
2880 int vaMaxNumDisplayAttributes (
2885 * Query display attributes
2886 * The caller must provide a "attr_list" array that can hold at
2887 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2888 * returned in "attr_list" is returned in "num_attributes".
2890 VAStatus vaQueryDisplayAttributes (
2892 VADisplayAttribute *attr_list, /* out */
2893 int *num_attributes /* out */
2897 * Get display attributes
2898 * This function returns the current attribute values in "attr_list".
2899 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2900 * from vaQueryDisplayAttributes() can have their values retrieved.
2902 VAStatus vaGetDisplayAttributes (
2904 VADisplayAttribute *attr_list, /* in/out */
2909 * Set display attributes
2910 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2911 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2912 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2914 VAStatus vaSetDisplayAttributes (
2916 VADisplayAttribute *attr_list,
2920 /****************************
2921 * HEVC data structures
2922 ****************************/
2924 * \brief Description of picture properties of those in DPB surfaces.
2926 * If only progressive scan is supported, each surface contains one whole
2928 * Otherwise, each surface contains two fields of whole picture.
2929 * In this case, two entries of ReferenceFrames[] may share same picture_id
2932 typedef struct _VAPictureHEVC
2934 /** \brief reconstructed picture buffer surface index
2935 * invalid when taking value VA_INVALID_SURFACE.
2937 VASurfaceID picture_id;
2938 /** \brief picture order count.
2939 * in HEVC, POCs for top and bottom fields of same picture should
2940 * take different values.
2942 int32_t pic_order_cnt;
2943 /* described below */
2947 /* flags in VAPictureHEVC could be OR of the following */
2948 #define VA_PICTURE_HEVC_INVALID 0x00000001
2949 /** \brief indication of interlace scan picture.
2950 * should take same value for all the pictures in sequence.
2952 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
2953 /** \brief polarity of the field picture.
2954 * top field takes even lines of buffer surface.
2955 * bottom field takes odd lines of buffer surface.
2957 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
2958 /** \brief Long term reference picture */
2959 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
2961 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
2962 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
2963 * be exclusive. No more than one of them can be set for any picture.
2964 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
2965 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
2966 * Application should provide valid values for both short format and long format.
2967 * The pictures in DPB with any of these three flags turned on are referred by
2968 * the current picture.
2970 /** \brief RefPicSetStCurrBefore of HEVC spec variable
2971 * Number of ReferenceFrames[] entries with this bit set equals
2972 * NumPocStCurrBefore.
2974 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
2975 /** \brief RefPicSetStCurrAfter of HEVC spec variable
2976 * Number of ReferenceFrames[] entries with this bit set equals
2977 * NumPocStCurrAfter.
2979 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
2980 /** \brief RefPicSetLtCurr of HEVC spec variable
2981 * Number of ReferenceFrames[] entries with this bit set equals
2984 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
2986 #include <va/va_dec_hevc.h>
2987 #include <va/va_dec_jpeg.h>
2988 #include <va/va_dec_vp8.h>
2989 #include <va/va_dec_vp9.h>
2990 #include <va/va_enc_hevc.h>
2991 #include <va/va_enc_h264.h>
2992 #include <va/va_enc_jpeg.h>
2993 #include <va/va_enc_mpeg2.h>
2994 #include <va/va_enc_vp8.h>
2995 #include <va/va_enc_vp9.h>
2996 #include <va/va_vpp.h>