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_BT601 0x00000010
209 #define VA_SRC_BT709 0x00000020
210 #define VA_SRC_SMPTE_240 0x00000040
212 /** Scaling flags for vaPutSurface() */
213 #define VA_FILTER_SCALING_DEFAULT 0x00000000
214 #define VA_FILTER_SCALING_FAST 0x00000100
215 #define VA_FILTER_SCALING_HQ 0x00000200
216 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
217 #define VA_FILTER_SCALING_MASK 0x00000f00
220 * Returns a short english description of error_status
222 const char *vaErrorStr(VAStatus error_status);
226 * A display must be obtained by calling vaGetDisplay() before calling
227 * vaInitialize() and other functions. This connects the API to the
228 * native window system.
229 * For X Windows, native_dpy would be from XOpenDisplay()
231 typedef void* VANativeDisplay; /* window system dependent */
233 int vaDisplayIsValid(VADisplay dpy);
236 * Initialize the library
238 VAStatus vaInitialize (
240 int *major_version, /* out */
241 int *minor_version /* out */
245 * After this call, all library internal resources will be cleaned up
247 VAStatus vaTerminate (
252 * vaQueryVendorString returns a pointer to a zero-terminated string
253 * describing some aspects of the VA implemenation on a specific
254 * hardware accelerator. The format of the returned string is vendor
255 * specific and at the discretion of the implementer.
256 * e.g. for the Intel GMA500 implementation, an example would be:
257 * "Intel GMA500 - 2.0.0.32L.0005"
259 const char *vaQueryVendorString (
263 typedef int (*VAPrivFunc)();
266 * Return a function pointer given a function name in the library.
267 * This allows private interfaces into the library
269 VAPrivFunc vaGetLibFunc (
274 /** Currently defined profiles */
277 /** \brief Profile ID used for video processing. */
279 VAProfileMPEG2Simple = 0,
280 VAProfileMPEG2Main = 1,
281 VAProfileMPEG4Simple = 2,
282 VAProfileMPEG4AdvancedSimple = 3,
283 VAProfileMPEG4Main = 4,
284 VAProfileH264Baseline = 5,
285 VAProfileH264Main = 6,
286 VAProfileH264High = 7,
287 VAProfileVC1Simple = 8,
288 VAProfileVC1Main = 9,
289 VAProfileVC1Advanced = 10,
290 VAProfileH263Baseline = 11,
291 VAProfileJPEGBaseline = 12,
292 VAProfileH264ConstrainedBaseline = 13,
293 VAProfileVP8Version0_3 = 14,
294 VAProfileH264MultiviewHigh = 15,
295 VAProfileH264StereoHigh = 16,
296 VAProfileHEVCMain = 17,
297 VAProfileHEVCMain10 = 18
301 * Currently defined entrypoints
307 VAEntrypointIDCT = 3,
308 VAEntrypointMoComp = 4,
309 VAEntrypointDeblocking = 5,
310 VAEntrypointEncSlice = 6, /* slice level encode */
311 VAEntrypointEncPicture = 7, /* pictuer encode, JPEG, etc */
312 VAEntrypointVideoProc = 10, /**< Video pre/post-processing. */
315 /** Currently defined configuration attribute types */
318 VAConfigAttribRTFormat = 0,
319 VAConfigAttribSpatialResidual = 1,
320 VAConfigAttribSpatialClipping = 2,
321 VAConfigAttribIntraResidual = 3,
322 VAConfigAttribEncryption = 4,
323 VAConfigAttribRateControl = 5,
325 /** @name Attributes for decoding */
328 * \brief Slice Decoding mode. Read/write.
330 * This attribute determines what mode the driver supports for slice
331 * decoding, through vaGetConfigAttributes(); and what mode the user
332 * will be providing to the driver, through vaCreateConfig(), if the
333 * driver supports those. If this attribute is not set by the user then
334 * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
336 * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
338 VAConfigAttribDecSliceMode = 6,
340 /** @name Attributes for encoding */
343 * \brief Packed headers mode. Read/write.
345 * This attribute determines what packed headers the driver supports,
346 * through vaGetConfigAttributes(); and what packed headers the user
347 * will be providing to the driver, through vaCreateConfig(), if the
348 * driver supports those.
350 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
352 VAConfigAttribEncPackedHeaders = 10,
354 * \brief Interlaced mode. Read/write.
356 * This attribute determines what kind of interlaced encoding mode
357 * the driver supports.
359 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
361 VAConfigAttribEncInterlaced = 11,
363 * \brief Maximum number of reference frames. Read-only.
365 * This attribute determines the maximum number of reference
366 * frames supported for encoding.
368 * Note: for H.264 encoding, the value represents the maximum number
369 * of reference frames for both the reference picture list 0 (bottom
370 * 16 bits) and the reference picture list 1 (top 16 bits).
372 VAConfigAttribEncMaxRefFrames = 13,
374 * \brief Maximum number of slices per frame. Read-only.
376 * This attribute determines the maximum number of slices the
377 * driver can support to encode a single frame.
379 VAConfigAttribEncMaxSlices = 14,
381 * \brief Slice structure. Read-only.
383 * This attribute determines slice structures supported by the
384 * driver for encoding. This attribute is a hint to the user so
385 * that he can choose a suitable surface size and how to arrange
386 * the encoding process of multiple slices per frame.
388 * More specifically, for H.264 encoding, this attribute
389 * determines the range of accepted values to
390 * VAEncSliceParameterBufferH264::macroblock_address and
391 * VAEncSliceParameterBufferH264::num_macroblocks.
393 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
396 VAConfigAttribEncSliceStructure = 15,
398 * \brief Macroblock information. Read-only.
400 * This attribute determines whether the driver supports extra
401 * encoding information per-macroblock. e.g. QP.
403 * More specifically, for H.264 encoding, if the driver returns a non-zero
404 * value for this attribute, this means the application can create
405 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
406 * through VAEncSliceParameterBufferH264::macroblock_info.
408 VAConfigAttribEncMacroblockInfo = 16,
410 * \brief JPEG encoding attribute. Read-only.
412 * This attribute exposes a number of capabilities of the underlying
413 * JPEG implementation. The attribute value is partitioned into fields as defined in the
414 * VAConfigAttribValEncJPEG union.
416 VAConfigAttribEncJPEG = 20,
418 * \brief Encoding quality range attribute. Read-only.
420 * This attribute conveys whether the driver supports different quality level settings
421 * for encoding. A value less than or equal to 1 means that the encoder only has a single
422 * quality setting, and a value greater than 1 represents the number of quality levels
423 * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
425 VAConfigAttribEncQualityRange = 21,
427 VAConfigAttribTypeMax
428 } VAConfigAttribType;
431 * Configuration attributes
432 * If there is more than one value for an attribute, a default
433 * value will be assigned to the attribute if the client does not
434 * specify the attribute when creating a configuration
436 typedef struct _VAConfigAttrib {
437 VAConfigAttribType type;
438 unsigned int value; /* OR'd flags (bits) for this attribute */
441 /** attribute value for VAConfigAttribRTFormat */
442 #define VA_RT_FORMAT_YUV420 0x00000001
443 #define VA_RT_FORMAT_YUV422 0x00000002
444 #define VA_RT_FORMAT_YUV444 0x00000004
445 #define VA_RT_FORMAT_YUV411 0x00000008
446 #define VA_RT_FORMAT_YUV400 0x00000010
447 #define VA_RT_FORMAT_RGB16 0x00010000
448 #define VA_RT_FORMAT_RGB32 0x00020000
449 /* RGBP covers RGBP and BGRP fourcc */
450 #define VA_RT_FORMAT_RGBP 0x00100000
451 #define VA_RT_FORMAT_PROTECTED 0x80000000
453 /** @name Attribute values for VAConfigAttribRateControl */
455 /** \brief Driver does not support any form of rate control. */
456 #define VA_RC_NONE 0x00000001
457 /** \brief Constant bitrate. */
458 #define VA_RC_CBR 0x00000002
459 /** \brief Variable bitrate. */
460 #define VA_RC_VBR 0x00000004
461 /** \brief Video conference mode. */
462 #define VA_RC_VCM 0x00000008
463 /** \brief Constant QP. */
464 #define VA_RC_CQP 0x00000010
465 /** \brief Variable bitrate with peak rate higher than average bitrate. */
466 #define VA_RC_VBR_CONSTRAINED 0x00000020
469 /** @name Attribute values for VAConfigAttribDecSliceMode */
471 /** \brief Driver supports normal mode for slice decoding */
472 #define VA_DEC_SLICE_MODE_NORMAL 0x00000001
473 /** \brief Driver supports base mode for slice decoding */
474 #define VA_DEC_SLICE_MODE_BASE 0x00000002
477 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
479 /** \brief Driver does not support any packed headers mode. */
480 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
481 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
482 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
483 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
484 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
485 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
486 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
487 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
488 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
489 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
490 #define VA_ENC_PACKED_HEADER_RAW_DATA 0x00000010
493 /** @name Attribute values for VAConfigAttribEncInterlaced */
495 /** \brief Driver does not support interlaced coding. */
496 #define VA_ENC_INTERLACED_NONE 0x00000000
497 /** \brief Driver supports interlaced frame coding. */
498 #define VA_ENC_INTERLACED_FRAME 0x00000001
499 /** \brief Driver supports interlaced field coding. */
500 #define VA_ENC_INTERLACED_FIELD 0x00000002
501 /** \brief Driver supports macroblock adaptive frame field coding. */
502 #define VA_ENC_INTERLACED_MBAFF 0x00000004
503 /** \brief Driver supports picture adaptive frame field coding. */
504 #define VA_ENC_INTERLACED_PAFF 0x00000008
507 /** @name Attribute values for VAConfigAttribEncSliceStructure */
509 /** \brief Driver supports an arbitrary number of rows per slice. */
510 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
511 /** \brief Driver supports a power-of-two number of rows per slice. */
512 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
513 /** \brief Driver supports an arbitrary number of rows per slice. */
514 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
517 /** \brief Attribute value for VAConfigAttribEncJPEG */
518 typedef union _VAConfigAttribValEncJPEG {
520 /** \brief set to 1 for arithmatic coding. */
521 unsigned int arithmatic_coding_mode : 1;
522 /** \brief set to 1 for progressive dct. */
523 unsigned int progressive_dct_mode : 1;
524 /** \brief set to 1 for non-interleaved. */
525 unsigned int non_interleaved_mode : 1;
526 /** \brief set to 1 for differential. */
527 unsigned int differential_mode : 1;
528 unsigned int max_num_components : 3;
529 unsigned int max_num_scans : 4;
530 unsigned int max_num_huffman_tables : 3;
531 unsigned int max_num_quantization_tables : 3;
534 } VAConfigAttribValEncJPEG;
537 * if an attribute is not applicable for a given
538 * profile/entrypoint pair, then set the value to the following
540 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
542 /** Get maximum number of profiles supported by the implementation */
543 int vaMaxNumProfiles (
547 /** Get maximum number of entrypoints supported by the implementation */
548 int vaMaxNumEntrypoints (
552 /** Get maximum number of attributs supported by the implementation */
553 int vaMaxNumConfigAttributes (
558 * Query supported profiles
559 * The caller must provide a "profile_list" array that can hold at
560 * least vaMaxNumProfile() entries. The actual number of profiles
561 * returned in "profile_list" is returned in "num_profile".
563 VAStatus vaQueryConfigProfiles (
565 VAProfile *profile_list, /* out */
566 int *num_profiles /* out */
570 * Query supported entrypoints for a given profile
571 * The caller must provide an "entrypoint_list" array that can hold at
572 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
573 * returned in "entrypoint_list" is returned in "num_entrypoints".
575 VAStatus vaQueryConfigEntrypoints (
578 VAEntrypoint *entrypoint_list, /* out */
579 int *num_entrypoints /* out */
583 * Get attributes for a given profile/entrypoint pair
584 * The caller must provide an "attrib_list" with all attributes to be
585 * retrieved. Upon return, the attributes in "attrib_list" have been
586 * updated with their value. Unknown attributes or attributes that are
587 * not supported for the given profile/entrypoint pair will have their
588 * value set to VA_ATTRIB_NOT_SUPPORTED
590 VAStatus vaGetConfigAttributes (
593 VAEntrypoint entrypoint,
594 VAConfigAttrib *attrib_list, /* in/out */
598 /** Generic ID type, can be re-typed for specific implementation */
599 typedef unsigned int VAGenericID;
601 typedef VAGenericID VAConfigID;
604 * Create a configuration for the decode pipeline
605 * it passes in the attribute list that specifies the attributes it cares
606 * about, with the rest taking default values.
608 VAStatus vaCreateConfig (
611 VAEntrypoint entrypoint,
612 VAConfigAttrib *attrib_list,
614 VAConfigID *config_id /* out */
618 * Free resources associdated with a given config
620 VAStatus vaDestroyConfig (
626 * Query all attributes for a given configuration
627 * The profile of the configuration is returned in "profile"
628 * The entrypoint of the configuration is returned in "entrypoint"
629 * The caller must provide an "attrib_list" array that can hold at least
630 * vaMaxNumConfigAttributes() entries. The actual number of attributes
631 * returned in "attrib_list" is returned in "num_attribs"
633 VAStatus vaQueryConfigAttributes (
635 VAConfigID config_id,
636 VAProfile *profile, /* out */
637 VAEntrypoint *entrypoint, /* out */
638 VAConfigAttrib *attrib_list,/* out */
639 int *num_attribs /* out */
644 * Contexts and Surfaces
646 * Context represents a "virtual" video decode pipeline. Surfaces are render
647 * targets for a given context. The data in the surfaces are not accessible
648 * to the client and the internal data format of the surface is implementatin
651 * Surfaces will be bound to a context when the context is created. Once
652 * a surface is bound to a given context, it can not be used to create
653 * another context. The association is removed when the context is destroyed
655 * Both contexts and surfaces are identified by unique IDs and its
656 * implementation specific internals are kept opaque to the clients
659 typedef VAGenericID VAContextID;
661 typedef VAGenericID VASurfaceID;
663 #define VA_INVALID_ID 0xffffffff
664 #define VA_INVALID_SURFACE VA_INVALID_ID
666 /** \brief Generic value types. */
668 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
669 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
670 VAGenericValueTypePointer, /**< Generic pointer type */
671 VAGenericValueTypeFunc /**< Pointer to function */
672 } VAGenericValueType;
674 /** \brief Generic function type. */
675 typedef void (*VAGenericFunc)(void);
677 /** \brief Generic value. */
678 typedef struct _VAGenericValue {
679 /** \brief Value type. See #VAGenericValueType. */
680 VAGenericValueType type;
681 /** \brief Value holder. */
683 /** \brief 32-bit signed integer. */
685 /** \brief 32-bit float. */
687 /** \brief Generic pointer. */
689 /** \brief Pointer to function. */
694 /** @name Surface attribute flags */
696 /** \brief Surface attribute is not supported. */
697 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
698 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
699 #define VA_SURFACE_ATTRIB_GETTABLE 0x00000001
700 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
701 #define VA_SURFACE_ATTRIB_SETTABLE 0x00000002
704 /** \brief Surface attribute types. */
706 VASurfaceAttribNone = 0,
708 * \brief Pixel format (fourcc).
710 * The value is meaningful as input to vaQuerySurfaceAttributes().
711 * If zero, the driver returns the optimal pixel format for the
712 * specified config. Otherwise, if non-zero, the value represents
713 * a pixel format (FOURCC) that is kept as is on output, if the
714 * driver supports it. Otherwise, the driver sets the value to
715 * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
717 VASurfaceAttribPixelFormat,
718 /** \brief Minimal width in pixels (int, read-only). */
719 VASurfaceAttribMinWidth,
720 /** \brief Maximal width in pixels (int, read-only). */
721 VASurfaceAttribMaxWidth,
722 /** \brief Minimal height in pixels (int, read-only). */
723 VASurfaceAttribMinHeight,
724 /** \brief Maximal height in pixels (int, read-only). */
725 VASurfaceAttribMaxHeight,
726 /** \brief Surface memory type expressed in bit fields (int, read/write). */
727 VASurfaceAttribMemoryType,
728 /** \brief External buffer descriptor (pointer, write). */
729 VASurfaceAttribExternalBufferDescriptor,
730 /** \brief Surface usage hint, gives the driver a hint of intended usage
731 * to optimize allocation (e.g. tiling) (int, read/write). */
732 VASurfaceAttribUsageHint,
733 /** \brief Number of surface attributes. */
735 } VASurfaceAttribType;
737 /** \brief Surface attribute. */
738 typedef struct _VASurfaceAttrib {
740 VASurfaceAttribType type;
741 /** \brief Flags. See "Surface attribute flags". */
743 /** \brief Value. See "Surface attribute types" for the expected types. */
744 VAGenericValue value;
748 * @name VASurfaceAttribMemoryType values in bit fields.
749 * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
750 * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
751 * types are defined in DRM and Android header files.
754 /** \brief VA memory type (default) is supported. */
755 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA 0x00000001
756 /** \brief V4L2 buffer memory type is supported. */
757 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2 0x00000002
758 /** \brief User pointer memory type is supported. */
759 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR 0x00000004
763 * \brief VASurfaceAttribExternalBuffers structure for
764 * the VASurfaceAttribExternalBufferDescriptor attribute.
766 typedef struct _VASurfaceAttribExternalBuffers {
767 /** \brief pixel format in fourcc. */
768 unsigned int pixel_format;
769 /** \brief width in pixels. */
771 /** \brief height in pixels. */
773 /** \brief total size of the buffer in bytes. */
774 unsigned int data_size;
775 /** \brief number of planes for planar layout */
776 unsigned int num_planes;
777 /** \brief pitch for each plane in bytes */
778 unsigned int pitches[4];
779 /** \brief offset for each plane in bytes */
780 unsigned int offsets[4];
781 /** \brief buffer handles or user pointers */
782 unsigned long *buffers;
783 /** \brief number of elements in the "buffers" array */
784 unsigned int num_buffers;
785 /** \brief flags. See "Surface external buffer descriptor flags". */
787 /** \brief reserved for passing private data */
789 } VASurfaceAttribExternalBuffers;
791 /** @name VASurfaceAttribExternalBuffers flags */
793 /** \brief Enable memory tiling */
794 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING 0x00000001
795 /** \brief Memory is cacheable */
796 #define VA_SURFACE_EXTBUF_DESC_CACHED 0x00000002
797 /** \brief Memory is non-cacheable */
798 #define VA_SURFACE_EXTBUF_DESC_UNCACHED 0x00000004
799 /** \brief Memory is write-combined */
800 #define VA_SURFACE_EXTBUF_DESC_WC 0x00000008
801 /** \brief Memory is protected */
802 #define VA_SURFACE_EXTBUF_DESC_PROTECTED 0x80000000
804 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
806 /** \brief Surface usage not indicated. */
807 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC 0x00000000
808 /** \brief Surface used by video decoder. */
809 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER 0x00000001
810 /** \brief Surface used by video encoder. */
811 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER 0x00000002
812 /** \brief Surface read by video post-processing. */
813 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ 0x00000004
814 /** \brief Surface written by video post-processing. */
815 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE 0x00000008
816 /** \brief Surface used for display. */
817 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY 0x00000010
822 * \brief Queries surface attributes for the supplied config.
824 * Unlike vaGetSurfaceAttributes(), this function queries for all
825 * supported attributes for the supplied VA @config. In particular, if
826 * the underlying hardware supports the creation of VA surfaces in
827 * various formats, then this function will enumerate all pixel
828 * formats that are supported.
830 * The \c attrib_list array is allocated by the user and \c
831 * num_attribs shall be initialized to the number of allocated
832 * elements in that array. Upon successful return, the actual number
833 * of attributes will be overwritten into \c num_attribs. Otherwise,
834 * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
835 * is adjusted to the number of elements that would be returned if
836 * enough space was available.
838 * Note: it is perfectly valid to pass NULL to the \c attrib_list
839 * argument when vaQuerySurfaceAttributes() is used to determine the
840 * actual number of elements that need to be allocated.
842 * @param[in] dpy the VA display
843 * @param[in] config the config identifying a codec or a video
844 * processing pipeline
845 * @param[out] attrib_list the output array of #VASurfaceAttrib elements
846 * @param[in,out] num_attribs the number of elements allocated on
847 * input, the number of elements actually filled in output
850 vaQuerySurfaceAttributes(
853 VASurfaceAttrib *attrib_list,
854 unsigned int *num_attribs
858 * \brief Creates an array of surfaces
860 * Creates an array of surfaces. The optional list of attributes shall
861 * be constructed and validated through vaGetSurfaceAttributes() or
862 * constructed based based on what the underlying hardware could
863 * expose through vaQuerySurfaceAttributes().
865 * @param[in] dpy the VA display
866 * @param[in] format the desired surface format. See \c VA_RT_FORMAT_*
867 * @param[in] width the surface width
868 * @param[in] height the surface height
869 * @param[out] surfaces the array of newly created surfaces
870 * @param[in] num_surfaces the number of surfaces to create
871 * @param[in] attrib_list the list of (optional) attributes, or \c NULL
872 * @param[in] num_attribs the number of attributes supplied in
873 * \c attrib_list, or zero
881 VASurfaceID *surfaces,
882 unsigned int num_surfaces,
883 VASurfaceAttrib *attrib_list,
884 unsigned int num_attribs
888 * vaDestroySurfaces - Destroy resources associated with surfaces.
889 * Surfaces can only be destroyed after the context associated has been
892 * surfaces: array of surfaces to destroy
893 * num_surfaces: number of surfaces in the array to be destroyed.
895 VAStatus vaDestroySurfaces (
897 VASurfaceID *surfaces,
901 #define VA_PROGRESSIVE 0x1
903 * vaCreateContext - Create a context
905 * config_id: configuration for the context
906 * picture_width: coded picture width
907 * picture_height: coded picture height
908 * flag: any combination of the following:
909 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
910 * render_targets: render targets (surfaces) tied to the context
911 * num_render_targets: number of render targets in the above array
912 * context: created context id upon return
914 VAStatus vaCreateContext (
916 VAConfigID config_id,
920 VASurfaceID *render_targets,
921 int num_render_targets,
922 VAContextID *context /* out */
926 * vaDestroyContext - Destroy a context
928 * context: context to be destroyed
930 VAStatus vaDestroyContext (
937 * Buffers are used to pass various types of data from the
938 * client to the server. The server maintains a data store
939 * for each buffer created, and the client idenfies a buffer
940 * through a unique buffer id assigned by the server.
943 typedef VAGenericID VABufferID;
947 VAPictureParameterBufferType = 0,
948 VAIQMatrixBufferType = 1,
949 VABitPlaneBufferType = 2,
950 VASliceGroupMapBufferType = 3,
951 VASliceParameterBufferType = 4,
952 VASliceDataBufferType = 5,
953 VAMacroblockParameterBufferType = 6,
954 VAResidualDataBufferType = 7,
955 VADeblockingParameterBufferType = 8,
956 VAImageBufferType = 9,
957 VAProtectedSliceDataBufferType = 10,
958 VAQMatrixBufferType = 11,
959 VAHuffmanTableBufferType = 12,
960 VAProbabilityBufferType = 13,
962 /* Following are encode buffer types */
963 VAEncCodedBufferType = 21,
964 VAEncSequenceParameterBufferType = 22,
965 VAEncPictureParameterBufferType = 23,
966 VAEncSliceParameterBufferType = 24,
967 VAEncPackedHeaderParameterBufferType = 25,
968 VAEncPackedHeaderDataBufferType = 26,
969 VAEncMiscParameterBufferType = 27,
970 VAEncMacroblockParameterBufferType = 28,
971 VAEncMacroblockMapBufferType = 29,
972 /* Following are video processing buffer types */
974 * \brief Video processing pipeline parameter buffer.
976 * This buffer describes the video processing pipeline. See
977 * #VAProcPipelineParameterBuffer for details.
979 VAProcPipelineParameterBufferType = 41,
981 * \brief Video filter parameter buffer.
983 * This buffer describes the video filter parameters. All buffers
984 * inherit from #VAProcFilterParameterBufferBase, thus including
985 * a unique filter buffer type.
987 * The default buffer used by most filters is #VAProcFilterParameterBuffer.
988 * Filters requiring advanced parameters include, but are not limited to,
989 * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
990 * color balance (#VAProcFilterParameterBufferColorBalance), etc.
992 VAProcFilterParameterBufferType = 42,
998 VAEncMiscParameterTypeFrameRate = 0,
999 VAEncMiscParameterTypeRateControl = 1,
1000 VAEncMiscParameterTypeMaxSliceSize = 2,
1001 VAEncMiscParameterTypeAIR = 3,
1002 /** \brief Buffer type used to express a maximum frame size (in bits). */
1003 VAEncMiscParameterTypeMaxFrameSize = 4,
1004 /** \brief Buffer type used for HRD parameters. */
1005 VAEncMiscParameterTypeHRD = 5,
1006 VAEncMiscParameterTypeQualityLevel = 6,
1007 } VAEncMiscParameterType;
1009 /** \brief Packed header type. */
1011 /** \brief Packed sequence header. */
1012 VAEncPackedHeaderSequence = 1,
1013 /** \brief Packed picture header. */
1014 VAEncPackedHeaderPicture = 2,
1015 /** \brief Packed slice header. */
1016 VAEncPackedHeaderSlice = 3,
1018 * \brief Packed raw header.
1020 * Packed raw data header can be used by the client to insert a header
1021 * into the bitstream data buffer at the point it is passed, the driver
1022 * will handle the raw packed header based on "has_emulation_bytes" field
1023 * in the packed header parameter structure.
1025 VAEncPackedHeaderRawData = 4,
1026 /** \brief Misc packed header. See codec-specific definitions. */
1027 VAEncPackedHeaderMiscMask = 0x80000000,
1028 } VAEncPackedHeaderType;
1030 /** \brief Packed header parameter. */
1031 typedef struct _VAEncPackedHeaderParameterBuffer {
1032 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1034 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1035 unsigned int bit_length;
1036 /** \brief Flag: buffer contains start code emulation prevention bytes? */
1037 unsigned char has_emulation_bytes;
1038 } VAEncPackedHeaderParameterBuffer;
1041 * For application, e.g. set a new bitrate
1042 * VABufferID buf_id;
1043 * VAEncMiscParameterBuffer *misc_param;
1044 * VAEncMiscParameterRateControl *misc_rate_ctrl;
1046 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1047 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1048 * 1, NULL, &buf_id);
1050 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1051 * misc_param->type = VAEncMiscParameterTypeRateControl;
1052 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1053 * misc_rate_ctrl->bits_per_second = 6400000;
1054 * vaUnmapBuffer(dpy, buf_id);
1055 * vaRenderPicture(dpy, context, &buf_id, 1);
1057 typedef struct _VAEncMiscParameterBuffer
1059 VAEncMiscParameterType type;
1060 unsigned int data[0];
1061 } VAEncMiscParameterBuffer;
1064 /** \brief Rate control parameters */
1065 typedef struct _VAEncMiscParameterRateControl
1067 /* this is the maximum bit-rate to be constrained by the rate control implementation */
1068 unsigned int bits_per_second;
1069 /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1070 * bit-rate for example if target_percentage is 95 then the rate control will target
1071 * a bit-rate that is 95% of the maximum bit-rate
1073 unsigned int target_percentage;
1074 /* windows size in milliseconds. For example if this is set to 500,
1075 * then the rate control will guarantee the target bit-rate over a 500 ms window
1077 unsigned int window_size;
1078 /* initial QP at I frames */
1079 unsigned int initial_qp;
1080 unsigned int min_qp;
1081 unsigned int basic_unit_size;
1086 unsigned int reset : 1;
1087 unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1088 unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1092 } VAEncMiscParameterRateControl;
1094 typedef struct _VAEncMiscParameterFrameRate
1096 unsigned int framerate;
1097 } VAEncMiscParameterFrameRate;
1100 * Allow a maximum slice size to be specified (in bits).
1101 * The encoder will attempt to make sure that individual slices do not exceed this size
1102 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1104 typedef struct _VAEncMiscParameterMaxSliceSize
1106 unsigned int max_slice_size;
1107 } VAEncMiscParameterMaxSliceSize;
1109 typedef struct _VAEncMiscParameterAIR
1111 unsigned int air_num_mbs;
1112 unsigned int air_threshold;
1113 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1114 } VAEncMiscParameterAIR;
1116 typedef struct _VAEncMiscParameterHRD
1118 unsigned int initial_buffer_fullness; /* in bits */
1119 unsigned int buffer_size; /* in bits */
1120 } VAEncMiscParameterHRD;
1123 * \brief Defines a maximum frame size (in bits).
1125 * This misc parameter buffer defines the maximum size of a frame (in
1126 * bits). The encoder will try to make sure that each frame does not
1127 * exceed this size. Otherwise, if the frame size exceeds this size,
1128 * the \c status flag of #VACodedBufferSegment will contain
1129 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1131 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1132 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1133 VAEncMiscParameterType type;
1134 /** \brief Maximum size of a frame (in bits). */
1135 unsigned int max_frame_size;
1136 } VAEncMiscParameterBufferMaxFrameSize;
1139 * \brief Encoding quality level.
1141 * The encoding quality could be set through this structure, if the implementation
1142 * supports multiple quality levels. The quality level set through this structure is
1143 * persistent over the entire coded sequence, or until a new structure is being sent.
1144 * The quality level range can be queried through the VAConfigAttribEncQualityRange
1145 * attribute. A lower value means higher quality, and a value of 1 represents the highest
1146 * quality. The quality level setting is used as a trade-off between quality and speed/power
1147 * consumption, with higher quality corresponds to lower speed and higher power consumption.
1149 typedef struct _VAEncMiscParameterBufferQualityLevel {
1150 /** \brief Encoding quality level setting. When set to 0, default quality
1153 unsigned int quality_level;
1154 } VAEncMiscParameterBufferQualityLevel;
1157 * There will be cases where the bitstream buffer will not have enough room to hold
1158 * the data for the entire slice, and the following flags will be used in the slice
1159 * parameter to signal to the server for the possible cases.
1160 * If a slice parameter buffer and slice data buffer pair is sent to the server with
1161 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
1162 * then a slice parameter and data buffer needs to be sent again to complete this slice.
1164 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
1165 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
1166 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
1167 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
1169 /* Codec-independent Slice Parameter Buffer base */
1170 typedef struct _VASliceParameterBufferBase
1172 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
1173 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
1174 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
1175 } VASliceParameterBufferBase;
1177 /**********************************
1178 * JPEG common data structures
1179 **********************************/
1181 * \brief Huffman table for JPEG decoding.
1183 * This structure holds the complete Huffman tables. This is an
1184 * aggregation of all Huffman table (DHT) segments maintained by the
1185 * application. i.e. up to 2 Huffman tables are stored in there for
1188 * The #load_huffman_table array can be used as a hint to notify the
1189 * VA driver implementation about which table(s) actually changed
1190 * since the last submission of this buffer.
1192 typedef struct _VAHuffmanTableBufferJPEGBaseline {
1193 /** \brief Specifies which #huffman_table is valid. */
1194 unsigned char load_huffman_table[2];
1195 /** \brief Huffman tables indexed by table identifier (Th). */
1197 /** @name DC table (up to 12 categories) */
1199 /** \brief Number of Huffman codes of length i + 1 (Li). */
1200 unsigned char num_dc_codes[16];
1201 /** \brief Value associated with each Huffman code (Vij). */
1202 unsigned char dc_values[12];
1204 /** @name AC table (2 special codes + up to 16 * 10 codes) */
1206 /** \brief Number of Huffman codes of length i + 1 (Li). */
1207 unsigned char num_ac_codes[16];
1208 /** \brief Value associated with each Huffman code (Vij). */
1209 unsigned char ac_values[162];
1210 /** \brief Padding to 4-byte boundaries. Must be set to zero. */
1211 unsigned char pad[2];
1214 } VAHuffmanTableBufferJPEGBaseline;
1216 /****************************
1217 * MPEG-2 data structures
1218 ****************************/
1220 /* MPEG-2 Picture Parameter Buffer */
1222 * For each frame or field, and before any slice data, a single
1223 * picture parameter buffer must be send.
1225 typedef struct _VAPictureParameterBufferMPEG2
1227 unsigned short horizontal_size;
1228 unsigned short vertical_size;
1229 VASurfaceID forward_reference_picture;
1230 VASurfaceID backward_reference_picture;
1231 /* meanings of the following fields are the same as in the standard */
1232 int picture_coding_type;
1233 int f_code; /* pack all four fcode into this */
1236 unsigned int intra_dc_precision : 2;
1237 unsigned int picture_structure : 2;
1238 unsigned int top_field_first : 1;
1239 unsigned int frame_pred_frame_dct : 1;
1240 unsigned int concealment_motion_vectors : 1;
1241 unsigned int q_scale_type : 1;
1242 unsigned int intra_vlc_format : 1;
1243 unsigned int alternate_scan : 1;
1244 unsigned int repeat_first_field : 1;
1245 unsigned int progressive_frame : 1;
1246 unsigned int is_first_field : 1; /* indicate whether the current field
1247 * is the first field for field picture
1251 } picture_coding_extension;
1252 } VAPictureParameterBufferMPEG2;
1254 /** MPEG-2 Inverse Quantization Matrix Buffer */
1255 typedef struct _VAIQMatrixBufferMPEG2
1257 /** \brief Same as the MPEG-2 bitstream syntax element. */
1258 int load_intra_quantiser_matrix;
1259 /** \brief Same as the MPEG-2 bitstream syntax element. */
1260 int load_non_intra_quantiser_matrix;
1261 /** \brief Same as the MPEG-2 bitstream syntax element. */
1262 int load_chroma_intra_quantiser_matrix;
1263 /** \brief Same as the MPEG-2 bitstream syntax element. */
1264 int load_chroma_non_intra_quantiser_matrix;
1265 /** \brief Luminance intra matrix, in zig-zag scan order. */
1266 unsigned char intra_quantiser_matrix[64];
1267 /** \brief Luminance non-intra matrix, in zig-zag scan order. */
1268 unsigned char non_intra_quantiser_matrix[64];
1269 /** \brief Chroma intra matrix, in zig-zag scan order. */
1270 unsigned char chroma_intra_quantiser_matrix[64];
1271 /** \brief Chroma non-intra matrix, in zig-zag scan order. */
1272 unsigned char chroma_non_intra_quantiser_matrix[64];
1273 } VAIQMatrixBufferMPEG2;
1275 /** MPEG-2 Slice Parameter Buffer */
1276 typedef struct _VASliceParameterBufferMPEG2
1278 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1279 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1280 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1281 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1282 unsigned int slice_horizontal_position;
1283 unsigned int slice_vertical_position;
1284 int quantiser_scale_code;
1285 int intra_slice_flag;
1286 } VASliceParameterBufferMPEG2;
1288 /** MPEG-2 Macroblock Parameter Buffer */
1289 typedef struct _VAMacroblockParameterBufferMPEG2
1291 unsigned short macroblock_address;
1293 * macroblock_address (in raster scan order)
1295 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
1297 unsigned char macroblock_type; /* see definition below */
1300 unsigned int frame_motion_type : 2;
1301 unsigned int field_motion_type : 2;
1302 unsigned int dct_type : 1;
1306 unsigned char motion_vertical_field_select;
1308 * motion_vertical_field_select:
1309 * see section 6.3.17.2 in the spec
1310 * only the lower 4 bits are used
1311 * bit 0: first vector forward
1312 * bit 1: first vector backward
1313 * bit 2: second vector forward
1314 * bit 3: second vector backward
1316 short PMV[2][2][2]; /* see Table 7-7 in the spec */
1317 unsigned short coded_block_pattern;
1319 * The bitplanes for coded_block_pattern are described
1320 * in Figure 6.10-12 in the spec
1323 /* Number of skipped macroblocks after this macroblock */
1324 unsigned short num_skipped_macroblocks;
1325 } VAMacroblockParameterBufferMPEG2;
1328 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
1330 #define VA_MB_TYPE_MOTION_FORWARD 0x02
1331 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
1332 #define VA_MB_TYPE_MOTION_PATTERN 0x08
1333 #define VA_MB_TYPE_MOTION_INTRA 0x10
1336 * MPEG-2 Residual Data Buffer
1337 * For each macroblock, there wil be 64 shorts (16-bit) in the
1338 * residual data buffer
1341 /****************************
1342 * MPEG-4 Part 2 data structures
1343 ****************************/
1345 /* MPEG-4 Picture Parameter Buffer */
1347 * For each frame or field, and before any slice data, a single
1348 * picture parameter buffer must be send.
1350 typedef struct _VAPictureParameterBufferMPEG4
1352 unsigned short vop_width;
1353 unsigned short vop_height;
1354 VASurfaceID forward_reference_picture;
1355 VASurfaceID backward_reference_picture;
1358 unsigned int short_video_header : 1;
1359 unsigned int chroma_format : 2;
1360 unsigned int interlaced : 1;
1361 unsigned int obmc_disable : 1;
1362 unsigned int sprite_enable : 2;
1363 unsigned int sprite_warping_accuracy : 2;
1364 unsigned int quant_type : 1;
1365 unsigned int quarter_sample : 1;
1366 unsigned int data_partitioned : 1;
1367 unsigned int reversible_vlc : 1;
1368 unsigned int resync_marker_disable : 1;
1372 unsigned char no_of_sprite_warping_points;
1373 short sprite_trajectory_du[3];
1374 short sprite_trajectory_dv[3];
1375 unsigned char quant_precision;
1378 unsigned int vop_coding_type : 2;
1379 unsigned int backward_reference_vop_coding_type : 2;
1380 unsigned int vop_rounding_type : 1;
1381 unsigned int intra_dc_vlc_thr : 3;
1382 unsigned int top_field_first : 1;
1383 unsigned int alternate_vertical_scan_flag : 1;
1387 unsigned char vop_fcode_forward;
1388 unsigned char vop_fcode_backward;
1389 unsigned short vop_time_increment_resolution;
1390 /* short header related */
1391 unsigned char num_gobs_in_vop;
1392 unsigned char num_macroblocks_in_gob;
1393 /* for direct mode prediction */
1396 } VAPictureParameterBufferMPEG4;
1398 /** MPEG-4 Inverse Quantization Matrix Buffer */
1399 typedef struct _VAIQMatrixBufferMPEG4
1401 /** Same as the MPEG-4:2 bitstream syntax element. */
1402 int load_intra_quant_mat;
1403 /** Same as the MPEG-4:2 bitstream syntax element. */
1404 int load_non_intra_quant_mat;
1405 /** The matrix for intra blocks, in zig-zag scan order. */
1406 unsigned char intra_quant_mat[64];
1407 /** The matrix for non-intra blocks, in zig-zag scan order. */
1408 unsigned char non_intra_quant_mat[64];
1409 } VAIQMatrixBufferMPEG4;
1411 /** MPEG-4 Slice Parameter Buffer */
1412 typedef struct _VASliceParameterBufferMPEG4
1414 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1415 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1416 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1417 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1418 unsigned int macroblock_number;
1420 } VASliceParameterBufferMPEG4;
1423 VC-1 data structures
1426 typedef enum /* see 7.1.1.32 */
1429 VAMvMode1MvHalfPel = 1,
1430 VAMvMode1MvHalfPelBilinear = 2,
1431 VAMvModeMixedMv = 3,
1432 VAMvModeIntensityCompensation = 4
1435 /** VC-1 Picture Parameter Buffer */
1437 * For each picture, and before any slice data, a picture parameter
1438 * buffer must be send. Multiple picture parameter buffers may be
1439 * sent for a single picture. In that case picture parameters will
1440 * apply to all slice data that follow it until a new picture
1441 * parameter buffer is sent.
1444 * pic_quantizer_type should be set to the applicable quantizer
1445 * type as defined by QUANTIZER (J.1.19) and either
1446 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1448 typedef struct _VAPictureParameterBufferVC1
1450 VASurfaceID forward_reference_picture;
1451 VASurfaceID backward_reference_picture;
1452 /* if out-of-loop post-processing is done on the render
1453 target, then we need to keep the in-loop decoded
1454 picture as a reference picture */
1455 VASurfaceID inloop_decoded_picture;
1457 /* sequence layer for AP or meta data for SP and MP */
1460 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1461 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1462 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1463 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1464 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1465 unsigned int multires : 1; /* METADATA::MULTIRES */
1466 unsigned int overlap : 1; /* METADATA::OVERLAP */
1467 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1468 unsigned int rangered : 1; /* METADATA::RANGERED */
1469 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1470 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1475 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1476 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1479 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1480 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1481 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1482 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1485 } entrypoint_fields;
1486 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1487 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1490 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1491 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1492 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1493 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1496 } range_mapping_fields;
1498 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1499 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1500 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1501 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1502 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1503 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1504 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1505 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1506 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1509 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1510 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1511 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1512 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1513 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1519 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1520 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1521 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1522 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1523 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1524 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1525 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1531 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1532 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1533 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1534 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1535 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1536 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1537 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1540 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1543 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1544 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1545 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1546 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1552 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1553 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1554 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1555 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1556 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1557 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1558 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1559 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1560 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1561 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1567 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1568 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1569 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1570 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1571 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1572 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1573 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1574 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1575 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1576 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1577 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1580 } pic_quantizer_fields;
1583 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1584 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1585 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1586 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1587 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1588 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1592 } VAPictureParameterBufferVC1;
1594 /** VC-1 Bitplane Buffer
1595 There will be at most three bitplanes coded in any picture header. To send
1596 the bitplane data more efficiently, each byte is divided in two nibbles, with
1597 each nibble carrying three bitplanes for one macroblock. The following table
1598 shows the bitplane data arrangement within each nibble based on the picture
1601 Picture Type Bit3 Bit2 Bit1 Bit0
1602 I or BI OVERFLAGS ACPRED FIELDTX
1603 P MYTYPEMB SKIPMB DIRECTMB
1604 B FORWARDMB SKIPMB DIRECTMB
1606 Within each byte, the lower nibble is for the first MB and the upper nibble is
1607 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1608 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1609 Macroblock #2 in the first row.
1612 /* VC-1 Slice Parameter Buffer */
1613 typedef struct _VASliceParameterBufferVC1
1615 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1616 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1617 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1618 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1619 unsigned int slice_vertical_position;
1620 } VASliceParameterBufferVC1;
1622 /* VC-1 Slice Data Buffer */
1624 This is simplely a buffer containing raw bit-stream bytes
1627 /****************************
1628 * H.264/AVC data structures
1629 ****************************/
1631 typedef struct _VAPictureH264
1633 VASurfaceID picture_id;
1634 unsigned int frame_idx;
1636 signed int TopFieldOrderCnt;
1637 signed int BottomFieldOrderCnt;
1639 /* flags in VAPictureH264 could be OR of the following */
1640 #define VA_PICTURE_H264_INVALID 0x00000001
1641 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1642 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1643 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1644 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1646 /** H.264 Picture Parameter Buffer */
1648 * For each picture, and before any slice data, a single
1649 * picture parameter buffer must be send.
1651 typedef struct _VAPictureParameterBufferH264
1653 VAPictureH264 CurrPic;
1654 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1655 unsigned short picture_width_in_mbs_minus1;
1656 unsigned short picture_height_in_mbs_minus1;
1657 unsigned char bit_depth_luma_minus8;
1658 unsigned char bit_depth_chroma_minus8;
1659 unsigned char num_ref_frames;
1662 unsigned int chroma_format_idc : 2;
1663 unsigned int residual_colour_transform_flag : 1;
1664 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1665 unsigned int frame_mbs_only_flag : 1;
1666 unsigned int mb_adaptive_frame_field_flag : 1;
1667 unsigned int direct_8x8_inference_flag : 1;
1668 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1669 unsigned int log2_max_frame_num_minus4 : 4;
1670 unsigned int pic_order_cnt_type : 2;
1671 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1672 unsigned int delta_pic_order_always_zero_flag : 1;
1676 unsigned char num_slice_groups_minus1;
1677 unsigned char slice_group_map_type;
1678 unsigned short slice_group_change_rate_minus1;
1679 signed char pic_init_qp_minus26;
1680 signed char pic_init_qs_minus26;
1681 signed char chroma_qp_index_offset;
1682 signed char second_chroma_qp_index_offset;
1685 unsigned int entropy_coding_mode_flag : 1;
1686 unsigned int weighted_pred_flag : 1;
1687 unsigned int weighted_bipred_idc : 2;
1688 unsigned int transform_8x8_mode_flag : 1;
1689 unsigned int field_pic_flag : 1;
1690 unsigned int constrained_intra_pred_flag : 1;
1691 unsigned int pic_order_present_flag : 1;
1692 unsigned int deblocking_filter_control_present_flag : 1;
1693 unsigned int redundant_pic_cnt_present_flag : 1;
1694 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1698 unsigned short frame_num;
1699 } VAPictureParameterBufferH264;
1701 /** H.264 Inverse Quantization Matrix Buffer */
1702 typedef struct _VAIQMatrixBufferH264
1704 /** \brief 4x4 scaling list, in raster scan order. */
1705 unsigned char ScalingList4x4[6][16];
1706 /** \brief 8x8 scaling list, in raster scan order. */
1707 unsigned char ScalingList8x8[2][64];
1708 } VAIQMatrixBufferH264;
1711 * H.264 Slice Group Map Buffer
1712 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1713 * A slice group map buffer should be sent for each picture if required. The buffer
1714 * is sent only when there is a change in the mapping values.
1715 * The slice group map buffer map "map units" to slice groups as specified in
1716 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1717 * in raster scan order
1720 /** H.264 Slice Parameter Buffer */
1721 typedef struct _VASliceParameterBufferH264
1723 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1724 /** \brief Byte offset to the NAL Header Unit for this slice. */
1725 unsigned int slice_data_offset;
1726 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1728 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1730 * This bit offset is relative to and includes the NAL unit byte
1731 * and represents the number of bits parsed in the slice_header()
1732 * after the removal of any emulation prevention bytes in
1733 * there. However, the slice data buffer passed to the hardware is
1734 * the original bitstream, thus including any emulation prevention
1737 unsigned short slice_data_bit_offset;
1738 unsigned short first_mb_in_slice;
1739 unsigned char slice_type;
1740 unsigned char direct_spatial_mv_pred_flag;
1741 unsigned char num_ref_idx_l0_active_minus1;
1742 unsigned char num_ref_idx_l1_active_minus1;
1743 unsigned char cabac_init_idc;
1744 char slice_qp_delta;
1745 unsigned char disable_deblocking_filter_idc;
1746 char slice_alpha_c0_offset_div2;
1747 char slice_beta_offset_div2;
1748 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1749 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1750 unsigned char luma_log2_weight_denom;
1751 unsigned char chroma_log2_weight_denom;
1752 unsigned char luma_weight_l0_flag;
1753 short luma_weight_l0[32];
1754 short luma_offset_l0[32];
1755 unsigned char chroma_weight_l0_flag;
1756 short chroma_weight_l0[32][2];
1757 short chroma_offset_l0[32][2];
1758 unsigned char luma_weight_l1_flag;
1759 short luma_weight_l1[32];
1760 short luma_offset_l1[32];
1761 unsigned char chroma_weight_l1_flag;
1762 short chroma_weight_l1[32][2];
1763 short chroma_offset_l1[32][2];
1764 } VASliceParameterBufferH264;
1766 /****************************
1767 * Common encode data structures
1768 ****************************/
1771 VAEncPictureTypeIntra = 0,
1772 VAEncPictureTypePredictive = 1,
1773 VAEncPictureTypeBidirectional = 2,
1776 /* Encode Slice Parameter Buffer */
1777 typedef struct _VAEncSliceParameterBuffer
1779 unsigned int start_row_number; /* starting MB row number for this slice */
1780 unsigned int slice_height; /* slice height measured in MB */
1783 unsigned int is_intra : 1;
1784 unsigned int disable_deblocking_filter_idc : 2;
1785 unsigned int uses_long_term_ref :1;
1786 unsigned int is_long_term_ref :1;
1790 } VAEncSliceParameterBuffer;
1793 /****************************
1794 * H.263 specific encode data structures
1795 ****************************/
1797 typedef struct _VAEncSequenceParameterBufferH263
1799 unsigned int intra_period;
1800 unsigned int bits_per_second;
1801 unsigned int frame_rate;
1802 unsigned int initial_qp;
1803 unsigned int min_qp;
1804 } VAEncSequenceParameterBufferH263;
1806 typedef struct _VAEncPictureParameterBufferH263
1808 VASurfaceID reference_picture;
1809 VASurfaceID reconstructed_picture;
1810 VABufferID coded_buf;
1811 unsigned short picture_width;
1812 unsigned short picture_height;
1813 VAEncPictureType picture_type;
1814 } VAEncPictureParameterBufferH263;
1816 /****************************
1817 * MPEG-4 specific encode data structures
1818 ****************************/
1820 typedef struct _VAEncSequenceParameterBufferMPEG4
1822 unsigned char profile_and_level_indication;
1823 unsigned int intra_period;
1824 unsigned int video_object_layer_width;
1825 unsigned int video_object_layer_height;
1826 unsigned int vop_time_increment_resolution;
1827 unsigned int fixed_vop_rate;
1828 unsigned int fixed_vop_time_increment;
1829 unsigned int bits_per_second;
1830 unsigned int frame_rate;
1831 unsigned int initial_qp;
1832 unsigned int min_qp;
1833 } VAEncSequenceParameterBufferMPEG4;
1835 typedef struct _VAEncPictureParameterBufferMPEG4
1837 VASurfaceID reference_picture;
1838 VASurfaceID reconstructed_picture;
1839 VABufferID coded_buf;
1840 unsigned short picture_width;
1841 unsigned short picture_height;
1842 unsigned int modulo_time_base; /* number of 1s */
1843 unsigned int vop_time_increment;
1844 VAEncPictureType picture_type;
1845 } VAEncPictureParameterBufferMPEG4;
1849 /** Buffer functions */
1852 * Creates a buffer for "num_elements" elements of "size" bytes and
1853 * initalize with "data".
1854 * if "data" is null, then the contents of the buffer data store
1856 * Basically there are two ways to get buffer data to the server side. One is
1857 * to call vaCreateBuffer() with a non-null "data", which results the data being
1858 * copied to the data store on the server side. A different method that
1859 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1860 * and then use vaMapBuffer() to map the data store from the server side to the
1861 * client address space for access.
1862 * Note: image buffers are created by the library, not the client. Please see
1863 * vaCreateImage on how image buffers are managed.
1865 VAStatus vaCreateBuffer (
1867 VAContextID context,
1868 VABufferType type, /* in */
1869 unsigned int size, /* in */
1870 unsigned int num_elements, /* in */
1871 void *data, /* in */
1872 VABufferID *buf_id /* out */
1876 * Convey to the server how many valid elements are in the buffer.
1877 * e.g. if multiple slice parameters are being held in a single buffer,
1878 * this will communicate to the server the number of slice parameters
1879 * that are valid in the buffer.
1881 VAStatus vaBufferSetNumElements (
1883 VABufferID buf_id, /* in */
1884 unsigned int num_elements /* in */
1889 * device independent data structure for codedbuffer
1893 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1894 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1895 * enough for the encoder to attempt to limit its size.
1896 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1897 * exceeded the maximum slice size specified.
1898 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1899 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1900 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1902 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1903 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1904 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1905 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1906 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1908 * \brief The frame has exceeded the maximum requested size.
1910 * This flag indicates that the encoded frame size exceeds the value
1911 * specified through a misc parameter buffer of type
1912 * #VAEncMiscParameterTypeMaxFrameSize.
1914 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1915 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1918 * \brief The coded buffer segment contains a single NAL unit.
1920 * This flag indicates that the coded buffer segment contains a
1921 * single NAL unit. This flag might be useful to the user for
1922 * processing the coded buffer.
1924 #define VA_CODED_BUF_STATUS_SINGLE_NALU 0x10000000
1927 * \brief Coded buffer segment.
1929 * #VACodedBufferSegment is an element of a linked list describing
1930 * some information on the coded buffer. The coded buffer segment
1931 * could contain either a single NAL unit, or more than one NAL unit.
1932 * It is recommended (but not required) to return a single NAL unit
1933 * in a coded buffer segment, and the implementation should set the
1934 * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
1936 typedef struct _VACodedBufferSegment {
1938 * \brief Size of the data buffer in this segment (in bytes).
1941 /** \brief Bit offset into the data buffer where the video data starts. */
1942 unsigned int bit_offset;
1943 /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
1944 unsigned int status;
1945 /** \brief Reserved for future use. */
1946 unsigned int reserved;
1947 /** \brief Pointer to the start of the data buffer. */
1950 * \brief Pointer to the next #VACodedBufferSegment element,
1951 * or \c NULL if there is none.
1954 } VACodedBufferSegment;
1957 * Map data store of the buffer into the client's address space
1958 * vaCreateBuffer() needs to be called with "data" set to NULL before
1959 * calling vaMapBuffer()
1961 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1962 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1964 VAStatus vaMapBuffer (
1966 VABufferID buf_id, /* in */
1967 void **pbuf /* out */
1971 * After client making changes to a mapped data store, it needs to
1972 * "Unmap" it to let the server know that the data is ready to be
1973 * consumed by the server
1975 VAStatus vaUnmapBuffer (
1977 VABufferID buf_id /* in */
1981 * After this call, the buffer is deleted and this buffer_id is no longer valid
1982 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1984 VAStatus vaDestroyBuffer (
1986 VABufferID buffer_id
1989 /** \brief VA buffer information */
1991 /** \brief Buffer handle */
1993 /** \brief Buffer type (See \ref VABufferType). */
1996 * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
1998 * On input to vaAcquireBufferHandle(), this field can serve as a hint
1999 * to specify the set of memory types the caller is interested in.
2000 * On successful return from vaAcquireBufferHandle(), the field is
2001 * updated with the best matching memory type.
2004 /** \brief Size of the underlying buffer. */
2009 * \brief Acquires buffer handle for external API usage
2011 * Locks the VA buffer object \ref buf_id for external API usage like
2012 * EGL or OpenCL (OCL). This function is a synchronization point. This
2013 * means that any pending operation is guaranteed to be completed
2014 * prior to returning from the function.
2016 * If the referenced VA buffer object is the backing store of a VA
2017 * surface, then this function acts as if vaSyncSurface() on the
2018 * parent surface was called first.
2020 * The \ref VABufferInfo argument shall be zero'ed on input. On
2021 * successful output, the data structure is filled in with all the
2022 * necessary buffer level implementation details like handle, type,
2023 * memory type and memory size.
2025 * Note: the external API implementation, or the application, can
2026 * express the memory types it is interested in by filling in the \ref
2027 * mem_type field accordingly. On successful output, the memory type
2028 * that fits best the request and that was used is updated in the \ref
2029 * VABufferInfo data structure. If none of the supplied memory types
2030 * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
2031 * error is returned.
2033 * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
2034 * is called. Besides, no additional operation is allowed on any of
2035 * the buffer parent object until vaReleaseBufferHandle() is called.
2036 * e.g. decoding into a VA surface backed with the supplied VA buffer
2037 * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
2041 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2042 * does not support this interface
2043 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2044 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2045 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2046 * does not support exporting buffers of the specified type
2047 * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
2048 * memory types in \ref VABufferInfo.mem_type was supported
2050 * @param[in] dpy the VA display
2051 * @param[in] buf_id the VA buffer
2052 * @param[in,out] buf_info the associated VA buffer information
2053 * @return VA_STATUS_SUCCESS if successful
2056 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
2059 * \brief Releases buffer after usage from external API
2061 * Unlocks the VA buffer object \ref buf_id from external API usage like
2062 * EGL or OpenCL (OCL). This function is a synchronization point. This
2063 * means that any pending operation is guaranteed to be completed
2064 * prior to returning from the function.
2066 * The \ref VABufferInfo argument shall point to the original data
2067 * structure that was obtained from vaAcquireBufferHandle(), unaltered.
2068 * This is necessary so that the VA driver implementation could
2069 * deallocate any resources that were needed.
2071 * In any case, returning from this function invalidates any contents
2072 * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
2073 * valid. Therefore, VA driver implementations are free to reset this
2074 * data structure to safe defaults.
2077 * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
2078 * does not support this interface
2079 * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
2080 * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
2081 * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
2082 * does not support exporting buffers of the specified type
2084 * @param[in] dpy the VA display
2085 * @param[in] buf_id the VA buffer
2086 * @return VA_STATUS_SUCCESS if successful
2089 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
2092 Render (Decode) Pictures
2094 A picture represents either a frame or a field.
2096 The Begin/Render/End sequence sends the decode buffers to the server
2100 * Get ready to decode a picture to a target surface
2102 VAStatus vaBeginPicture (
2104 VAContextID context,
2105 VASurfaceID render_target
2109 * Send decode buffers to the server.
2110 * Buffers are automatically destroyed afterwards
2112 VAStatus vaRenderPicture (
2114 VAContextID context,
2115 VABufferID *buffers,
2120 * Make the end of rendering for a picture.
2121 * The server should start processing all pending operations for this
2122 * surface. This call is non-blocking. The client can start another
2123 * Begin/Render/End sequence on a different render target.
2125 VAStatus vaEndPicture (
2137 * This function blocks until all pending operations on the render target
2138 * have been completed. Upon return it is safe to use the render target for a
2139 * different picture.
2141 VAStatus vaSyncSurface (
2143 VASurfaceID render_target
2148 VASurfaceRendering = 1, /* Rendering in progress */
2149 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
2150 /* this status is useful if surface is used as the source */
2152 VASurfaceReady = 4, /* not being rendered or displayed */
2153 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
2157 * Find out any pending ops on the render target
2159 VAStatus vaQuerySurfaceStatus (
2161 VASurfaceID render_target,
2162 VASurfaceStatus *status /* out */
2167 VADecodeSliceMissing = 0,
2168 VADecodeMBError = 1,
2169 } VADecodeErrorType;
2172 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
2173 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
2175 typedef struct _VASurfaceDecodeMBErrors
2177 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
2178 unsigned int start_mb; /* start mb address with errors */
2179 unsigned int end_mb; /* end mb address with errors */
2180 VADecodeErrorType decode_error_type;
2181 } VASurfaceDecodeMBErrors;
2184 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
2185 * it can call vaQuerySurfaceError to find out further details on the particular error.
2186 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
2187 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
2188 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
2189 * The array is terminated if "status==-1" is detected.
2191 VAStatus vaQuerySurfaceError(
2193 VASurfaceID surface,
2194 VAStatus error_status,
2199 * Images and Subpictures
2200 * VAImage is used to either get the surface data to client memory, or
2201 * to copy image data in client memory to a surface.
2202 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
2203 * is at the upper left corner with positive X to the right and positive Y down
2205 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
2206 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
2207 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
2210 * Pre-defined fourcc codes
2212 #define VA_FOURCC_NV12 0x3231564E
2213 #define VA_FOURCC_AI44 0x34344149
2214 #define VA_FOURCC_RGBA 0x41424752
2215 #define VA_FOURCC_RGBX 0x58424752
2216 #define VA_FOURCC_BGRA 0x41524742
2217 #define VA_FOURCC_BGRX 0x58524742
2218 #define VA_FOURCC_ARGB 0x42475241
2219 #define VA_FOURCC_XRGB 0x42475258
2220 #define VA_FOURCC_ABGR 0x52474241
2221 #define VA_FOURCC_XBGR 0x52474258
2222 #define VA_FOURCC_UYVY 0x59565955
2223 #define VA_FOURCC_YUY2 0x32595559
2224 #define VA_FOURCC_AYUV 0x56555941
2225 #define VA_FOURCC_NV11 0x3131564e
2226 #define VA_FOURCC_YV12 0x32315659
2227 #define VA_FOURCC_P208 0x38303250
2228 #define VA_FOURCC_IYUV 0x56555949
2229 #define VA_FOURCC_YV24 0x34325659
2230 #define VA_FOURCC_YV32 0x32335659
2231 #define VA_FOURCC_Y800 0x30303859
2232 #define VA_FOURCC_IMC3 0x33434D49
2233 #define VA_FOURCC_411P 0x50313134
2234 #define VA_FOURCC_422H 0x48323234
2235 #define VA_FOURCC_422V 0x56323234
2236 #define VA_FOURCC_444P 0x50343434
2237 #define VA_FOURCC_RGBP 0x50424752
2238 #define VA_FOURCC_BGRP 0x50524742
2239 #define VA_FOURCC_411R 0x52313134 /* rotated 411P */
2242 #define VA_LSB_FIRST 1
2243 #define VA_MSB_FIRST 2
2245 typedef struct _VAImageFormat
2247 unsigned int fourcc;
2248 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
2249 unsigned int bits_per_pixel;
2250 /* for RGB formats */
2251 unsigned int depth; /* significant bits per pixel */
2252 unsigned int red_mask;
2253 unsigned int green_mask;
2254 unsigned int blue_mask;
2255 unsigned int alpha_mask;
2258 typedef VAGenericID VAImageID;
2260 typedef struct _VAImage
2262 VAImageID image_id; /* uniquely identify this image */
2263 VAImageFormat format;
2264 VABufferID buf; /* image data buffer */
2266 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
2267 * data store on the server side for optimal performance. The buffer will be
2268 * created by the CreateImage function, and proper storage allocated based on the image
2269 * size and format. This buffer is managed by the library implementation, and
2270 * accessed by the client through the buffer Map/Unmap functions.
2272 unsigned short width;
2273 unsigned short height;
2274 unsigned int data_size;
2275 unsigned int num_planes; /* can not be greater than 3 */
2277 * An array indicating the scanline pitch in bytes for each plane.
2278 * Each plane may have a different pitch. Maximum 3 planes for planar formats
2280 unsigned int pitches[3];
2282 * An array indicating the byte offset from the beginning of the image data
2283 * to the start of each plane.
2285 unsigned int offsets[3];
2287 /* The following fields are only needed for paletted formats */
2288 int num_palette_entries; /* set to zero for non-palette images */
2290 * Each component is one byte and entry_bytes indicates the number of components in
2291 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
2295 * An array of ascii characters describing the order of the components within the bytes.
2296 * Only entry_bytes characters of the string are used.
2298 char component_order[4];
2301 /** Get maximum number of image formats supported by the implementation */
2302 int vaMaxNumImageFormats (
2307 * Query supported image formats
2308 * The caller must provide a "format_list" array that can hold at
2309 * least vaMaxNumImageFormats() entries. The actual number of formats
2310 * returned in "format_list" is returned in "num_formats".
2312 VAStatus vaQueryImageFormats (
2314 VAImageFormat *format_list, /* out */
2315 int *num_formats /* out */
2319 * Create a VAImage structure
2320 * The width and height fields returned in the VAImage structure may get
2321 * enlarged for some YUV formats. Upon return from this function,
2322 * image->buf has been created and proper storage allocated by the library.
2323 * The client can access the image through the Map/Unmap calls.
2325 VAStatus vaCreateImage (
2327 VAImageFormat *format,
2330 VAImage *image /* out */
2334 * Should call DestroyImage before destroying the surface it is bound to
2336 VAStatus vaDestroyImage (
2341 VAStatus vaSetImagePalette (
2345 * pointer to an array holding the palette data. The size of the array is
2346 * num_palette_entries * entry_bytes in size. The order of the components
2347 * in the palette is described by the component_order in VAImage struct
2349 unsigned char *palette
2353 * Retrive surface data into a VAImage
2354 * Image must be in a format supported by the implementation
2356 VAStatus vaGetImage (
2358 VASurfaceID surface,
2359 int x, /* coordinates of the upper left source pixel */
2361 unsigned int width, /* width and height of the region */
2362 unsigned int height,
2367 * Copy data from a VAImage to a surface
2368 * Image must be in a format supported by the implementation
2369 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
2370 * shouldn't be rendered into when this is called
2372 VAStatus vaPutImage (
2374 VASurfaceID surface,
2378 unsigned int src_width,
2379 unsigned int src_height,
2382 unsigned int dest_width,
2383 unsigned int dest_height
2387 * Derive an VAImage from an existing surface.
2388 * This interface will derive a VAImage and corresponding image buffer from
2389 * an existing VA Surface. The image buffer can then be mapped/unmapped for
2390 * direct CPU access. This operation is only possible on implementations with
2391 * direct rendering capabilities and internal surface formats that can be
2392 * represented with a VAImage. When the operation is not possible this interface
2393 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
2394 * to using vaCreateImage + vaPutImage to accomplish the same task in an
2397 * Implementations should only return success when the resulting image buffer
2398 * would be useable with vaMap/Unmap.
2400 * When directly accessing a surface special care must be taken to insure
2401 * proper synchronization with the graphics hardware. Clients should call
2402 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
2403 * rendering or currently being displayed by an overlay.
2405 * Additionally nothing about the contents of a surface should be assumed
2406 * following a vaPutSurface. Implementations are free to modify the surface for
2407 * scaling or subpicture blending within a call to vaPutImage.
2409 * Calls to vaPutImage or vaGetImage using the same surface from which the image
2410 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
2411 * vaGetImage with other surfaces is supported.
2413 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
2414 * image and image buffer structures will be destroyed; however, the underlying
2415 * surface will remain unchanged until freed with vaDestroySurfaces.
2417 VAStatus vaDeriveImage (
2419 VASurfaceID surface,
2420 VAImage *image /* out */
2425 * Subpicture is a special type of image that can be blended
2426 * with a surface during vaPutSurface(). Subpicture can be used to render
2427 * DVD sub-titles or closed captioning text etc.
2430 typedef VAGenericID VASubpictureID;
2432 /** Get maximum number of subpicture formats supported by the implementation */
2433 int vaMaxNumSubpictureFormats (
2437 /** flags for subpictures */
2438 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
2439 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
2440 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
2442 * Query supported subpicture formats
2443 * The caller must provide a "format_list" array that can hold at
2444 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
2445 * for each format to indicate additional capabilities for that format. The actual
2446 * number of formats returned in "format_list" is returned in "num_formats".
2447 * flags: returned value to indicate addtional capabilities
2448 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
2449 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
2450 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
2453 VAStatus vaQuerySubpictureFormats (
2455 VAImageFormat *format_list, /* out */
2456 unsigned int *flags, /* out */
2457 unsigned int *num_formats /* out */
2461 * Subpictures are created with an image associated.
2463 VAStatus vaCreateSubpicture (
2466 VASubpictureID *subpicture /* out */
2470 * Destroy the subpicture before destroying the image it is assocated to
2472 VAStatus vaDestroySubpicture (
2474 VASubpictureID subpicture
2478 * Bind an image to the subpicture. This image will now be associated with
2479 * the subpicture instead of the one at creation.
2481 VAStatus vaSetSubpictureImage (
2483 VASubpictureID subpicture,
2488 * If chromakey is enabled, then the area where the source value falls within
2489 * the chromakey [min, max] range is transparent
2490 * The chromakey component format is the following:
2491 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
2492 * For YUV: [0:7] V [8:15] U [16:23] Y
2493 * The chromakey mask can be used to mask out certain components for chromakey
2496 VAStatus vaSetSubpictureChromakey (
2498 VASubpictureID subpicture,
2499 unsigned int chromakey_min,
2500 unsigned int chromakey_max,
2501 unsigned int chromakey_mask
2505 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
2506 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
2507 * the overall alpha is per-pixel alpha multiplied by the global alpha
2509 VAStatus vaSetSubpictureGlobalAlpha (
2511 VASubpictureID subpicture,
2516 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2517 * It defines the region mapping between the subpicture and the target
2518 * surfaces through source and destination rectangles (with the same width and height).
2519 * Both will be displayed at the next call to vaPutSurface. Additional
2520 * associations before the call to vaPutSurface simply overrides the association.
2522 VAStatus vaAssociateSubpicture (
2524 VASubpictureID subpicture,
2525 VASurfaceID *target_surfaces,
2527 short src_x, /* upper left offset in subpicture */
2529 unsigned short src_width,
2530 unsigned short src_height,
2531 short dest_x, /* upper left offset in surface */
2533 unsigned short dest_width,
2534 unsigned short dest_height,
2536 * whether to enable chroma-keying, global-alpha, or screen relative mode
2537 * see VA_SUBPICTURE_XXX values
2543 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2545 VAStatus vaDeassociateSubpicture (
2547 VASubpictureID subpicture,
2548 VASurfaceID *target_surfaces,
2552 typedef struct _VARectangle
2556 unsigned short width;
2557 unsigned short height;
2561 * Display attributes
2562 * Display attributes are used to control things such as contrast, hue, saturation,
2563 * brightness etc. in the rendering process. The application can query what
2564 * attributes are supported by the driver, and then set the appropriate attributes
2565 * before calling vaPutSurface()
2567 /* PowerVR IEP Lite attributes */
2570 VADISPLAYATTRIB_BLE_OFF = 0x00,
2571 VADISPLAYATTRIB_BLE_LOW,
2572 VADISPLAYATTRIB_BLE_MEDIUM,
2573 VADISPLAYATTRIB_BLE_HIGH,
2574 VADISPLAYATTRIB_BLE_NONE,
2575 } VADisplayAttribBLEMode;
2577 /** attribute value for VADisplayAttribRotation */
2578 #define VA_ROTATION_NONE 0x00000000
2579 #define VA_ROTATION_90 0x00000001
2580 #define VA_ROTATION_180 0x00000002
2581 #define VA_ROTATION_270 0x00000003
2583 /** attribute value for VADisplayAttribOutOfLoopDeblock */
2584 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2585 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2588 #define VA_RENDER_MODE_UNDEFINED 0
2589 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2590 #define VA_RENDER_MODE_LOCAL_GPU 2
2591 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2592 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2594 /** Render device */
2595 #define VA_RENDER_DEVICE_UNDEFINED 0
2596 #define VA_RENDER_DEVICE_LOCAL 1
2597 #define VA_RENDER_DEVICE_EXTERNAL 2
2599 /** Currently defined display attribute types */
2602 VADisplayAttribBrightness = 0,
2603 VADisplayAttribContrast = 1,
2604 VADisplayAttribHue = 2,
2605 VADisplayAttribSaturation = 3,
2606 /* client can specifiy a background color for the target window
2607 * the new feature of video conference,
2608 * the uncovered area of the surface is filled by this color
2609 * also it will blend with the decoded video color
2611 VADisplayAttribBackgroundColor = 4,
2613 * this is a gettable only attribute. For some implementations that use the
2614 * hardware overlay, after PutSurface is called, the surface can not be
2615 * re-used until after the subsequent PutSurface call. If this is the case
2616 * then the value for this attribute will be set to 1 so that the client
2617 * will not attempt to re-use the surface right after returning from a call
2620 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2621 * driver may use overlay or GPU alternatively
2623 VADisplayAttribDirectSurface = 5,
2624 VADisplayAttribRotation = 6,
2625 VADisplayAttribOutofLoopDeblock = 7,
2627 /* PowerVR IEP Lite specific attributes */
2628 VADisplayAttribBLEBlackMode = 8,
2629 VADisplayAttribBLEWhiteMode = 9,
2630 VADisplayAttribBlueStretch = 10,
2631 VADisplayAttribSkinColorCorrection = 11,
2633 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2634 * conversion matrix. Each element in the matrix is float-point
2636 VADisplayAttribCSCMatrix = 12,
2637 /* specify the constant color used to blend with video surface
2638 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2639 * d: the final color to overwrite into the frame buffer
2640 * v: decoded video after color conversion,
2641 * c: video color specified by VADisplayAttribBlendColor
2642 * b: background color of the drawable
2644 VADisplayAttribBlendColor = 13,
2646 * Indicate driver to skip painting color key or not.
2647 * only applicable if the render is overlay
2649 VADisplayAttribOverlayAutoPaintColorKey = 14,
2651 * customized overlay color key, the format is RGB888
2652 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2654 VADisplayAttribOverlayColorKey = 15,
2656 * The hint for the implementation of vaPutSurface
2657 * normally, the driver could use an overlay or GPU to render the surface on the screen
2658 * this flag provides APP the flexibity to switch the render dynamically
2660 VADisplayAttribRenderMode = 16,
2662 * specify if vaPutSurface needs to render into specified monitors
2663 * one example is that one external monitor (e.g. HDMI) is enabled,
2664 * but the window manager is not aware of it, and there is no associated drawable
2666 VADisplayAttribRenderDevice = 17,
2668 * specify vaPutSurface render area if there is no drawable on the monitor
2670 VADisplayAttribRenderRect = 18,
2671 } VADisplayAttribType;
2673 /* flags for VADisplayAttribute */
2674 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2675 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2676 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2678 typedef struct _VADisplayAttribute
2680 VADisplayAttribType type;
2683 int value; /* used by the set/get attribute functions */
2684 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2686 } VADisplayAttribute;
2688 /** Get maximum number of display attributs supported by the implementation */
2689 int vaMaxNumDisplayAttributes (
2694 * Query display attributes
2695 * The caller must provide a "attr_list" array that can hold at
2696 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2697 * returned in "attr_list" is returned in "num_attributes".
2699 VAStatus vaQueryDisplayAttributes (
2701 VADisplayAttribute *attr_list, /* out */
2702 int *num_attributes /* out */
2706 * Get display attributes
2707 * This function returns the current attribute values in "attr_list".
2708 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2709 * from vaQueryDisplayAttributes() can have their values retrieved.
2711 VAStatus vaGetDisplayAttributes (
2713 VADisplayAttribute *attr_list, /* in/out */
2718 * Set display attributes
2719 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2720 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2721 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2723 VAStatus vaSetDisplayAttributes (
2725 VADisplayAttribute *attr_list,
2729 /****************************
2730 * HEVC data structures
2731 ****************************/
2733 * \brief Description of picture properties of those in DPB surfaces.
2735 * If only progressive scan is supported, each surface contains one whole
2737 * Otherwise, each surface contains two fields of whole picture.
2738 * In this case, two entries of ReferenceFrames[] may share same picture_id
2741 typedef struct _VAPictureHEVC
2743 /** \brief reconstructed picture buffer surface index
2744 * invalid when taking value VA_INVALID_SURFACE.
2746 VASurfaceID picture_id;
2747 /** \brief picture order count.
2748 * in HEVC, POCs for top and bottom fields of same picture should
2749 * take different values.
2751 int32_t pic_order_cnt;
2752 /* described below */
2756 /* flags in VAPictureHEVC could be OR of the following */
2757 #define VA_PICTURE_HEVC_INVALID 0x00000001
2758 /** \brief indication of interlace scan picture.
2759 * should take same value for all the pictures in sequence.
2761 #define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
2762 /** \brief polarity of the field picture.
2763 * top field takes even lines of buffer surface.
2764 * bottom field takes odd lines of buffer surface.
2766 #define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
2767 /** \brief Long term reference picture */
2768 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
2770 * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
2771 * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
2772 * be exclusive. No more than one of them can be set for any picture.
2773 * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
2774 * equals NumPocTotalCurr, which should be equal to or smaller than 8.
2775 * Application should provide valid values for both short format and long format.
2776 * The pictures in DPB with any of these three flags turned on are referred by
2777 * the current picture.
2779 /** \brief RefPicSetStCurrBefore of HEVC spec variable
2780 * Number of ReferenceFrames[] entries with this bit set equals
2781 * NumPocStCurrBefore.
2783 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
2784 /** \brief RefPicSetStCurrAfter of HEVC spec variable
2785 * Number of ReferenceFrames[] entries with this bit set equals
2786 * NumPocStCurrAfter.
2788 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
2789 /** \brief RefPicSetLtCurr of HEVC spec variable
2790 * Number of ReferenceFrames[] entries with this bit set equals
2793 #define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
2795 #include <va/va_dec_hevc.h>
2796 #include <va/va_dec_jpeg.h>
2797 #include <va/va_dec_vp8.h>
2798 #include <va/va_enc_hevc.h>
2799 #include <va/va_enc_h264.h>
2800 #include <va/va_enc_jpeg.h>
2801 #include <va/va_enc_mpeg2.h>
2802 #include <va/va_enc_vp8.h>
2803 #include <va/va_vpp.h>