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.
74 #include <va/va_version.h>
83 The VA API is intended to provide an interface between a video decode/encode/display
84 application (client) and a hardware accelerator (server), to off-load
85 video decode/encode/display operations from the host to the hardware accelerator at various
88 The basic operation steps are:
90 - Negotiate a mutually acceptable configuration with the server to lock
91 down profile, entrypoints, and other attributes that will not change on
92 a frame-by-frame basis.
93 - Create a decode context which represents a "virtualized" hardware decode
95 - Get and fill decode buffers with picture level, slice level and macroblock
96 level data (depending on entrypoints)
97 - Pass the decode buffers to the server to decode the current frame
99 Initialization & Configuration Management
101 - Find out supported profiles
102 - Find out entrypoints for a given profile
103 - Find out configuration attributes for a given profile/entrypoint pair
104 - Create a configuration for use by the decoder
108 typedef void* VADisplay; /* window system dependent */
110 typedef int VAStatus; /* Return status type from functions */
111 /* Values for the return status */
112 #define VA_STATUS_SUCCESS 0x00000000
113 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
114 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
115 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
116 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
117 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
118 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
119 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
120 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
121 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
122 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
123 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
124 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
125 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
126 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
127 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
128 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
129 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
130 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
131 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
132 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
133 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
134 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
135 #define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
136 #define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
138 * \brief An invalid/unsupported value was supplied.
140 * This is a catch-all error code for invalid or unsupported values.
141 * e.g. value exceeding the valid range, invalid type in the context
142 * of generic attribute values.
144 #define VA_STATUS_ERROR_INVALID_VALUE 0x00000019
145 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
147 /* De-interlacing flags for vaPutSurface() */
148 #define VA_FRAME_PICTURE 0x00000000
149 #define VA_TOP_FIELD 0x00000001
150 #define VA_BOTTOM_FIELD 0x00000002
153 * Enabled the positioning/cropping/blending feature:
154 * 1, specify the video playback position in the isurface
155 * 2, specify the cropping info for video playback
156 * 3, encoded video will blend with background color
158 #define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
161 * Clears the drawable with background color.
162 * for hardware overlay based implementation this flag
163 * can be used to turn off the overlay
165 #define VA_CLEAR_DRAWABLE 0x00000008
167 /* Color space conversion flags for vaPutSurface() */
168 #define VA_SRC_BT601 0x00000010
169 #define VA_SRC_BT709 0x00000020
170 #define VA_SRC_SMPTE_240 0x00000040
172 /* Scaling flags for vaPutSurface() */
173 #define VA_FILTER_SCALING_DEFAULT 0x00000000
174 #define VA_FILTER_SCALING_FAST 0x00000100
175 #define VA_FILTER_SCALING_HQ 0x00000200
176 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
177 #define VA_FILTER_SCALING_MASK 0x00000f00
180 * Returns a short english description of error_status
182 const char *vaErrorStr(VAStatus error_status);
186 * A display must be obtained by calling vaGetDisplay() before calling
187 * vaInitialize() and other functions. This connects the API to the
188 * native window system.
189 * For X Windows, native_dpy would be from XOpenDisplay()
191 typedef void* VANativeDisplay; /* window system dependent */
193 int vaDisplayIsValid(VADisplay dpy);
196 * Initialize the library
198 VAStatus vaInitialize (
200 int *major_version, /* out */
201 int *minor_version /* out */
205 * After this call, all library internal resources will be cleaned up
207 VAStatus vaTerminate (
212 * vaQueryVendorString returns a pointer to a zero-terminated string
213 * describing some aspects of the VA implemenation on a specific
214 * hardware accelerator. The format of the returned string is vendor
215 * specific and at the discretion of the implementer.
216 * e.g. for the Intel GMA500 implementation, an example would be:
217 * "Intel GMA500 - 2.0.0.32L.0005"
219 const char *vaQueryVendorString (
223 typedef int (*VAPrivFunc)();
226 * Return a function pointer given a function name in the library.
227 * This allows private interfaces into the library
229 VAPrivFunc vaGetLibFunc (
234 /* Currently defined profiles */
237 VAProfileMPEG2Simple = 0,
238 VAProfileMPEG2Main = 1,
239 VAProfileMPEG4Simple = 2,
240 VAProfileMPEG4AdvancedSimple = 3,
241 VAProfileMPEG4Main = 4,
242 VAProfileH264Baseline = 5,
243 VAProfileH264Main = 6,
244 VAProfileH264High = 7,
245 VAProfileVC1Simple = 8,
246 VAProfileVC1Main = 9,
247 VAProfileVC1Advanced = 10,
248 VAProfileH263Baseline = 11,
249 VAProfileJPEGBaseline = 12,
250 VAProfileH264ConstrainedBaseline = 13
254 * Currently defined entrypoints
260 VAEntrypointIDCT = 3,
261 VAEntrypointMoComp = 4,
262 VAEntrypointDeblocking = 5,
263 VAEntrypointEncSlice = 6, /* slice level encode */
264 VAEntrypointEncPicture = 7 /* pictuer encode, JPEG, etc */
267 /* Currently defined configuration attribute types */
270 VAConfigAttribRTFormat = 0,
271 VAConfigAttribSpatialResidual = 1,
272 VAConfigAttribSpatialClipping = 2,
273 VAConfigAttribIntraResidual = 3,
274 VAConfigAttribEncryption = 4,
275 VAConfigAttribRateControl = 5,
277 /** @name Attributes for encoding */
280 * \brief Packed headers mode. Read/write.
282 * This attribute determines what packed headers the driver supports,
283 * through vaGetConfigAttributes(); and what packed headers the user
284 * will be providing to the driver, through vaCreateConfig(), if the
285 * driver supports those.
287 * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
289 VAConfigAttribEncPackedHeaders = 10,
291 * \brief Interlaced mode. Read/write.
293 * This attribute determines what kind of interlaced encoding mode
294 * the driver supports.
296 * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
298 VAConfigAttribEncInterlaced = 11,
300 * \brief Maximum number of reference frames. Read-only.
302 * This attribute determines the maximum number of reference
303 * frames supported for encoding.
305 * Note: for H.264 encoding, the value represents the maximum
306 * number of reference frames for both the reference picture list
307 * 0 (top 16 bits) and the reference picture list 1 (bottom 16
310 VAConfigAttribEncMaxRefFrames = 13,
312 * \brief Maximum number of slices per frame. Read-only.
314 * This attribute determines the maximum number of slices the
315 * driver can support to encode a single frame.
317 VAConfigAttribEncMaxSlices = 14,
319 * \brief Slice structure. Read-only.
321 * This attribute determines slice structures supported by the
322 * driver for encoding. This attribute is a hint to the user so
323 * that he can choose a suitable surface size and how to arrange
324 * the encoding process of multiple slices per frame.
326 * More specifically, for H.264 encoding, this attribute
327 * determines the range of accepted values to
328 * VAEncSliceParameterBufferH264::macroblock_address and
329 * VAEncSliceParameterBufferH264::num_macroblocks.
331 * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
334 VAConfigAttribEncSliceStructure = 15,
336 * \brief Macroblock information. Read-only.
338 * This attribute determines whether the driver supports extra
339 * encoding information per-macroblock. e.g. QP.
341 * More specifically, for H.264 encoding, if the driver returns a non-zero
342 * value for this attribute, this means the application can create
343 * additional #VAEncMacroblockParameterBufferH264 buffers referenced
344 * through VAEncSliceParameterBufferH264::macroblock_info.
346 VAConfigAttribEncMacroblockInfo = 16,
348 } VAConfigAttribType;
351 * Configuration attributes
352 * If there is more than one value for an attribute, a default
353 * value will be assigned to the attribute if the client does not
354 * specify the attribute when creating a configuration
356 typedef struct _VAConfigAttrib {
357 VAConfigAttribType type;
358 unsigned int value; /* OR'd flags (bits) for this attribute */
361 /* attribute value for VAConfigAttribRTFormat */
362 #define VA_RT_FORMAT_YUV420 0x00000001
363 #define VA_RT_FORMAT_YUV422 0x00000002
364 #define VA_RT_FORMAT_YUV444 0x00000004
365 #define VA_RT_FORMAT_PROTECTED 0x80000000
367 /** @name Attribute values for VAConfigAttribRateControl */
369 /** \brief Driver does not support any form of rate control. */
370 #define VA_RC_NONE 0x00000001
371 /** \brief Constant bitrate. */
372 #define VA_RC_CBR 0x00000002
373 /** \brief Variable bitrate. */
374 #define VA_RC_VBR 0x00000004
375 /** \brief Video conference mode. */
376 #define VA_RC_VCM 0x00000008
377 /** \brief Constant QP. */
378 #define VA_RC_CQP 0x00000010
381 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
383 /** \brief Driver does not support any packed headers mode. */
384 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
385 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
386 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
387 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
388 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
389 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
390 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
391 /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
392 #define VA_ENC_PACKED_HEADER_MISC 0x00000008
395 /** @name Attribute values for VAConfigAttribEncInterlaced */
397 /** \brief Driver does not support interlaced coding. */
398 #define VA_ENC_INTERLACED_NONE 0x00000000
399 /** \brief Driver supports interlaced frame coding. */
400 #define VA_ENC_INTERLACED_FRAME 0x00000001
401 /** \brief Driver supports interlaced field coding. */
402 #define VA_ENC_INTERLACED_FIELD 0x00000002
403 /** \brief Driver supports macroblock adaptive frame field coding. */
404 #define VA_ENC_INTERLACED_MBAFF 0x00000004
405 /** \brief Driver supports picture adaptive frame field coding. */
406 #define VA_ENC_INTERLACED_PAFF 0x00000008
409 /** @name Attribute values for VAConfigAttribEncSliceStructure */
411 /** \brief Driver supports an arbitrary number of rows per slice. */
412 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
413 /** \brief Driver supports a power-of-two number of rows per slice. */
414 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
415 /** \brief Driver supports an arbitrary number of rows per slice. */
416 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
420 * if an attribute is not applicable for a given
421 * profile/entrypoint pair, then set the value to the following
423 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
425 /* Get maximum number of profiles supported by the implementation */
426 int vaMaxNumProfiles (
430 /* Get maximum number of entrypoints supported by the implementation */
431 int vaMaxNumEntrypoints (
435 /* Get maximum number of attributs supported by the implementation */
436 int vaMaxNumConfigAttributes (
441 * Query supported profiles
442 * The caller must provide a "profile_list" array that can hold at
443 * least vaMaxNumProfile() entries. The actual number of profiles
444 * returned in "profile_list" is returned in "num_profile".
446 VAStatus vaQueryConfigProfiles (
448 VAProfile *profile_list, /* out */
449 int *num_profiles /* out */
453 * Query supported entrypoints for a given profile
454 * The caller must provide an "entrypoint_list" array that can hold at
455 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
456 * returned in "entrypoint_list" is returned in "num_entrypoints".
458 VAStatus vaQueryConfigEntrypoints (
461 VAEntrypoint *entrypoint_list, /* out */
462 int *num_entrypoints /* out */
466 * Get attributes for a given profile/entrypoint pair
467 * The caller must provide an "attrib_list" with all attributes to be
468 * retrieved. Upon return, the attributes in "attrib_list" have been
469 * updated with their value. Unknown attributes or attributes that are
470 * not supported for the given profile/entrypoint pair will have their
471 * value set to VA_ATTRIB_NOT_SUPPORTED
473 VAStatus vaGetConfigAttributes (
476 VAEntrypoint entrypoint,
477 VAConfigAttrib *attrib_list, /* in/out */
481 /* Generic ID type, can be re-typed for specific implementation */
482 typedef unsigned int VAGenericID;
484 typedef VAGenericID VAConfigID;
487 * Create a configuration for the decode pipeline
488 * it passes in the attribute list that specifies the attributes it cares
489 * about, with the rest taking default values.
491 VAStatus vaCreateConfig (
494 VAEntrypoint entrypoint,
495 VAConfigAttrib *attrib_list,
497 VAConfigID *config_id /* out */
501 * Free resources associdated with a given config
503 VAStatus vaDestroyConfig (
509 * Query all attributes for a given configuration
510 * The profile of the configuration is returned in "profile"
511 * The entrypoint of the configuration is returned in "entrypoint"
512 * The caller must provide an "attrib_list" array that can hold at least
513 * vaMaxNumConfigAttributes() entries. The actual number of attributes
514 * returned in "attrib_list" is returned in "num_attribs"
516 VAStatus vaQueryConfigAttributes (
518 VAConfigID config_id,
519 VAProfile *profile, /* out */
520 VAEntrypoint *entrypoint, /* out */
521 VAConfigAttrib *attrib_list,/* out */
522 int *num_attribs /* out */
527 * Contexts and Surfaces
529 * Context represents a "virtual" video decode pipeline. Surfaces are render
530 * targets for a given context. The data in the surfaces are not accessible
531 * to the client and the internal data format of the surface is implementatin
534 * Surfaces will be bound to a context when the context is created. Once
535 * a surface is bound to a given context, it can not be used to create
536 * another context. The association is removed when the context is destroyed
538 * Both contexts and surfaces are identified by unique IDs and its
539 * implementation specific internals are kept opaque to the clients
542 typedef VAGenericID VAContextID;
544 typedef VAGenericID VASurfaceID;
546 #define VA_INVALID_ID 0xffffffff
547 #define VA_INVALID_SURFACE VA_INVALID_ID
549 /** \brief Generic value types. */
551 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
552 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
553 VAGenericValueTypePointer, /**< Generic pointer type */
554 VAGenericValueTypeFunc /**< Pointer to function */
555 } VAGenericValueType;
557 /** \brief Generic function type. */
558 typedef void (*VAGenericFunc)(void);
560 /** \brief Generic value. */
561 typedef struct _VAGenericValue {
562 /** \brief Value type. See #VAGenericValueType. */
563 VAGenericValueType type;
564 /** \brief Value holder. */
566 /** \brief 32-bit signed integer. */
568 /** \brief 32-bit float. */
570 /** \brief Generic pointer. */
572 /** \brief Pointer to function. */
578 * vaCreateSurfaces - Create an array of surfaces used for decode and display
580 * width: surface width
581 * height: surface height
582 * format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
583 * num_surfaces: number of surfaces to be created
584 * surfaces: array of surfaces created upon return
586 VAStatus vaCreateSurfaces (
592 VASurfaceID *surfaces /* out */
597 * vaDestroySurfaces - Destroy resources associated with surfaces.
598 * Surfaces can only be destroyed after the context associated has been
601 * surfaces: array of surfaces to destroy
602 * num_surfaces: number of surfaces in the array to be destroyed.
604 VAStatus vaDestroySurfaces (
606 VASurfaceID *surfaces,
610 #define VA_PROGRESSIVE 0x1
612 * vaCreateContext - Create a context
614 * config_id: configuration for the context
615 * picture_width: coded picture width
616 * picture_height: coded picture height
617 * flag: any combination of the following:
618 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
619 * render_targets: render targets (surfaces) tied to the context
620 * num_render_targets: number of render targets in the above array
621 * context: created context id upon return
623 VAStatus vaCreateContext (
625 VAConfigID config_id,
629 VASurfaceID *render_targets,
630 int num_render_targets,
631 VAContextID *context /* out */
635 * vaDestroyContext - Destroy a context
637 * context: context to be destroyed
639 VAStatus vaDestroyContext (
646 * Buffers are used to pass various types of data from the
647 * client to the server. The server maintains a data store
648 * for each buffer created, and the client idenfies a buffer
649 * through a unique buffer id assigned by the server.
652 typedef VAGenericID VABufferID;
656 VAPictureParameterBufferType = 0,
657 VAIQMatrixBufferType = 1,
658 VABitPlaneBufferType = 2,
659 VASliceGroupMapBufferType = 3,
660 VASliceParameterBufferType = 4,
661 VASliceDataBufferType = 5,
662 VAMacroblockParameterBufferType = 6,
663 VAResidualDataBufferType = 7,
664 VADeblockingParameterBufferType = 8,
665 VAImageBufferType = 9,
666 VAProtectedSliceDataBufferType = 10,
667 VAQMatrixBufferType = 11,
668 VAHuffmanTableBufferType = 12,
670 /* Following are encode buffer types */
671 VAEncCodedBufferType = 21,
672 VAEncSequenceParameterBufferType = 22,
673 VAEncPictureParameterBufferType = 23,
674 VAEncSliceParameterBufferType = 24,
675 VAEncPackedHeaderParameterBufferType = 25,
676 VAEncPackedHeaderDataBufferType = 26,
677 VAEncMiscParameterBufferType = 27,
678 VAEncMacroblockParameterBufferType = 28,
679 VABufferTypeMax = 0xff
684 VAEncMiscParameterTypeFrameRate = 0,
685 VAEncMiscParameterTypeRateControl = 1,
686 VAEncMiscParameterTypeMaxSliceSize = 2,
687 VAEncMiscParameterTypeAIR = 3,
688 /** \brief Buffer type used to express a maximum frame size (in bits). */
689 VAEncMiscParameterTypeMaxFrameSize = 4,
690 } VAEncMiscParameterType;
692 /** \brief Packed header type. */
694 /** \brief Packed sequence header. */
695 VAEncPackedHeaderSequence = 1,
696 /** \brief Packed picture header. */
697 VAEncPackedHeaderPicture = 2,
698 /** \brief Packed slice header. */
699 VAEncPackedHeaderSlice = 3,
700 /** \brief Misc packed header. See codec-specific definitions. */
701 VAEncPackedHeaderMiscMask = 0x80000000,
702 } VAEncPackedHeaderType;
704 /** \brief Packed header parameter. */
705 typedef struct _VAEncPackedHeaderParameterBuffer {
706 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
708 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
709 unsigned int bit_length;
710 /** \brief Flag: buffer contains start code emulation prevention bytes? */
711 unsigned char has_emulation_bytes;
712 } VAEncPackedHeaderParameterBuffer;
715 * For application, e.g. set a new bitrate
717 * VAEncMiscParameterBuffer *misc_param;
718 * VAEncMiscParameterRateControl *misc_rate_ctrl;
720 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
721 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
724 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
725 * misc_param->type = VAEncMiscParameterTypeRateControl;
726 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
727 * misc_rate_ctrl->bits_per_second = 6400000;
728 * vaUnmapBuffer(dpy, buf_id);
729 * vaRenderPicture(dpy, context, &buf_id, 1);
731 typedef struct _VAEncMiscParameterBuffer
733 VAEncMiscParameterType type;
734 unsigned int data[0];
735 } VAEncMiscParameterBuffer;
737 typedef struct _VAEncMiscParameterRateControl
739 unsigned int bits_per_second; /* this is the maximum bit-rate to be constrained by the rate control implementation */
740 unsigned int target_percentage; /* this is the bit-rate the rate control is targeting, as a percentage of the maximum bit-rate */
741 /* for example if target_percentage is 95 then the rate control will target a bit-rate that is */
742 /* 95% of the maximum bit-rate */
743 unsigned int window_size; /* windows size in milliseconds. For example if this is set to 500, then the rate control will guarantee the */
744 /* target bit-rate over a 500 ms window */
745 unsigned int initial_qp; /* initial QP at I frames */
747 } VAEncMiscParameterRateControl;
749 typedef struct _VAEncMiscParameterFrameRate
751 unsigned int framerate;
752 } VAEncMiscParameterFrameRate;
755 * Allow a maximum slice size to be specified (in bits).
756 * The encoder will attempt to make sure that individual slices do not exceed this size
757 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
759 typedef struct _VAEncMiscParameterMaxSliceSize
761 unsigned int max_slice_size;
762 } VAEncMiscParameterMaxSliceSize;
764 typedef struct _VAEncMiscParameterAIR
766 unsigned int air_num_mbs;
767 unsigned int air_threshold;
768 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
769 } VAEncMiscParameterAIR;
772 * \brief Defines a maximum frame size (in bits).
774 * This misc parameter buffer defines the maximum size of a frame (in
775 * bits). The encoder will try to make sure that each frame does not
776 * exceed this size. Otherwise, if the frame size exceeds this size,
777 * the \c status flag of #VACodedBufferSegment will contain
778 * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
780 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
781 /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
782 VAEncMiscParameterType type;
783 /** \brief Maximum size of a frame (in bits). */
784 unsigned int max_frame_size;
785 } VAEncMiscParameterBufferMaxFrameSize;
788 * There will be cases where the bitstream buffer will not have enough room to hold
789 * the data for the entire slice, and the following flags will be used in the slice
790 * parameter to signal to the server for the possible cases.
791 * If a slice parameter buffer and slice data buffer pair is sent to the server with
792 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
793 * then a slice parameter and data buffer needs to be sent again to complete this slice.
795 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
796 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
797 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
798 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
800 /* Codec-independent Slice Parameter Buffer base */
801 typedef struct _VASliceParameterBufferBase
803 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
804 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
805 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
806 } VASliceParameterBufferBase;
809 /****************************
810 * JEPG data structure
811 ***************************/
812 typedef struct _VAQMatrixBufferJPEG
814 int load_lum_quantiser_matrix;
815 int load_chroma_quantiser_matrix;
816 unsigned char lum_quantiser_matrix[64];
817 unsigned char chroma_quantiser_matrix[64];
818 } VAQMatrixBufferJPEG;
820 typedef struct _VAEncPictureParameterBufferJPEG
822 VASurfaceID reconstructed_picture;
823 unsigned short picture_width;
824 unsigned short picture_height;
825 VABufferID coded_buf;
826 } VAEncPictureParameterBufferJPEG;
828 #include <va/va_dec_jpeg.h>
830 /****************************
831 * MPEG-2 data structures
832 ****************************/
834 /* MPEG-2 Picture Parameter Buffer */
836 * For each frame or field, and before any slice data, a single
837 * picture parameter buffer must be send.
839 typedef struct _VAPictureParameterBufferMPEG2
841 unsigned short horizontal_size;
842 unsigned short vertical_size;
843 VASurfaceID forward_reference_picture;
844 VASurfaceID backward_reference_picture;
845 /* meanings of the following fields are the same as in the standard */
846 int picture_coding_type;
847 int f_code; /* pack all four fcode into this */
850 unsigned int intra_dc_precision : 2;
851 unsigned int picture_structure : 2;
852 unsigned int top_field_first : 1;
853 unsigned int frame_pred_frame_dct : 1;
854 unsigned int concealment_motion_vectors : 1;
855 unsigned int q_scale_type : 1;
856 unsigned int intra_vlc_format : 1;
857 unsigned int alternate_scan : 1;
858 unsigned int repeat_first_field : 1;
859 unsigned int progressive_frame : 1;
860 unsigned int is_first_field : 1; /* indicate whether the current field
861 * is the first field for field picture
865 } picture_coding_extension;
866 } VAPictureParameterBufferMPEG2;
868 /* MPEG-2 Inverse Quantization Matrix Buffer */
869 typedef struct _VAIQMatrixBufferMPEG2
871 int load_intra_quantiser_matrix;
872 int load_non_intra_quantiser_matrix;
873 int load_chroma_intra_quantiser_matrix;
874 int load_chroma_non_intra_quantiser_matrix;
875 unsigned char intra_quantiser_matrix[64];
876 unsigned char non_intra_quantiser_matrix[64];
877 unsigned char chroma_intra_quantiser_matrix[64];
878 unsigned char chroma_non_intra_quantiser_matrix[64];
879 } VAIQMatrixBufferMPEG2;
881 /* MPEG-2 Slice Parameter Buffer */
882 typedef struct _VASliceParameterBufferMPEG2
884 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
885 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
886 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
887 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
888 unsigned int slice_horizontal_position;
889 unsigned int slice_vertical_position;
890 int quantiser_scale_code;
891 int intra_slice_flag;
892 } VASliceParameterBufferMPEG2;
894 /* MPEG-2 Macroblock Parameter Buffer */
895 typedef struct _VAMacroblockParameterBufferMPEG2
897 unsigned short macroblock_address;
899 * macroblock_address (in raster scan order)
901 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
903 unsigned char macroblock_type; /* see definition below */
906 unsigned int frame_motion_type : 2;
907 unsigned int field_motion_type : 2;
908 unsigned int dct_type : 1;
912 unsigned char motion_vertical_field_select;
914 * motion_vertical_field_select:
915 * see section 6.3.17.2 in the spec
916 * only the lower 4 bits are used
917 * bit 0: first vector forward
918 * bit 1: first vector backward
919 * bit 2: second vector forward
920 * bit 3: second vector backward
922 short PMV[2][2][2]; /* see Table 7-7 in the spec */
923 unsigned short coded_block_pattern;
925 * The bitplanes for coded_block_pattern are described
926 * in Figure 6.10-12 in the spec
929 /* Number of skipped macroblocks after this macroblock */
930 unsigned short num_skipped_macroblocks;
931 } VAMacroblockParameterBufferMPEG2;
934 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
936 #define VA_MB_TYPE_MOTION_FORWARD 0x02
937 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
938 #define VA_MB_TYPE_MOTION_PATTERN 0x08
939 #define VA_MB_TYPE_MOTION_INTRA 0x10
942 * MPEG-2 Residual Data Buffer
943 * For each macroblock, there wil be 64 shorts (16-bit) in the
944 * residual data buffer
947 /****************************
948 * MPEG-4 Part 2 data structures
949 ****************************/
951 /* MPEG-4 Picture Parameter Buffer */
953 * For each frame or field, and before any slice data, a single
954 * picture parameter buffer must be send.
956 typedef struct _VAPictureParameterBufferMPEG4
958 unsigned short vop_width;
959 unsigned short vop_height;
960 VASurfaceID forward_reference_picture;
961 VASurfaceID backward_reference_picture;
964 unsigned int short_video_header : 1;
965 unsigned int chroma_format : 2;
966 unsigned int interlaced : 1;
967 unsigned int obmc_disable : 1;
968 unsigned int sprite_enable : 2;
969 unsigned int sprite_warping_accuracy : 2;
970 unsigned int quant_type : 1;
971 unsigned int quarter_sample : 1;
972 unsigned int data_partitioned : 1;
973 unsigned int reversible_vlc : 1;
974 unsigned int resync_marker_disable : 1;
978 unsigned char no_of_sprite_warping_points;
979 short sprite_trajectory_du[3];
980 short sprite_trajectory_dv[3];
981 unsigned char quant_precision;
984 unsigned int vop_coding_type : 2;
985 unsigned int backward_reference_vop_coding_type : 2;
986 unsigned int vop_rounding_type : 1;
987 unsigned int intra_dc_vlc_thr : 3;
988 unsigned int top_field_first : 1;
989 unsigned int alternate_vertical_scan_flag : 1;
993 unsigned char vop_fcode_forward;
994 unsigned char vop_fcode_backward;
995 unsigned short vop_time_increment_resolution;
996 /* short header related */
997 unsigned char num_gobs_in_vop;
998 unsigned char num_macroblocks_in_gob;
999 /* for direct mode prediction */
1002 } VAPictureParameterBufferMPEG4;
1004 /* MPEG-4 Inverse Quantization Matrix Buffer */
1005 typedef struct _VAIQMatrixBufferMPEG4
1007 int load_intra_quant_mat;
1008 int load_non_intra_quant_mat;
1009 unsigned char intra_quant_mat[64];
1010 unsigned char non_intra_quant_mat[64];
1011 } VAIQMatrixBufferMPEG4;
1013 /* MPEG-4 Slice Parameter Buffer */
1014 typedef struct _VASliceParameterBufferMPEG4
1016 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1017 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1018 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1019 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1020 unsigned int macroblock_number;
1022 } VASliceParameterBufferMPEG4;
1025 VC-1 data structures
1028 typedef enum /* see 7.1.1.32 */
1031 VAMvMode1MvHalfPel = 1,
1032 VAMvMode1MvHalfPelBilinear = 2,
1033 VAMvModeMixedMv = 3,
1034 VAMvModeIntensityCompensation = 4
1037 /* VC-1 Picture Parameter Buffer */
1039 * For each picture, and before any slice data, a picture parameter
1040 * buffer must be send. Multiple picture parameter buffers may be
1041 * sent for a single picture. In that case picture parameters will
1042 * apply to all slice data that follow it until a new picture
1043 * parameter buffer is sent.
1046 * pic_quantizer_type should be set to the applicable quantizer
1047 * type as defined by QUANTIZER (J.1.19) and either
1048 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1050 typedef struct _VAPictureParameterBufferVC1
1052 VASurfaceID forward_reference_picture;
1053 VASurfaceID backward_reference_picture;
1054 /* if out-of-loop post-processing is done on the render
1055 target, then we need to keep the in-loop decoded
1056 picture as a reference picture */
1057 VASurfaceID inloop_decoded_picture;
1059 /* sequence layer for AP or meta data for SP and MP */
1062 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1063 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1064 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1065 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1066 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1067 unsigned int multires : 1; /* METADATA::MULTIRES */
1068 unsigned int overlap : 1; /* METADATA::OVERLAP */
1069 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1070 unsigned int rangered : 1; /* METADATA::RANGERED */
1071 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1072 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1077 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1078 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1081 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1082 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1083 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1084 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1087 } entrypoint_fields;
1088 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1089 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1092 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1093 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1094 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1095 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1098 } range_mapping_fields;
1100 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1101 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1102 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1103 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1104 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1105 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1106 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1107 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1108 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1111 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1112 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1113 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1114 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1115 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1121 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1122 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1123 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1124 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1125 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1126 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1127 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1133 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1134 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1135 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1136 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1137 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1138 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1139 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1142 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1145 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1146 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1147 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1148 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1154 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1155 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1156 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1157 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1158 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1159 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1160 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1161 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1162 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1163 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1169 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1170 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1171 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1172 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1173 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1174 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1175 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1176 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1177 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1178 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1179 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1182 } pic_quantizer_fields;
1185 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1186 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1187 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1188 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1189 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1190 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1194 } VAPictureParameterBufferVC1;
1196 /* VC-1 Bitplane Buffer
1197 There will be at most three bitplanes coded in any picture header. To send
1198 the bitplane data more efficiently, each byte is divided in two nibbles, with
1199 each nibble carrying three bitplanes for one macroblock. The following table
1200 shows the bitplane data arrangement within each nibble based on the picture
1203 Picture Type Bit3 Bit2 Bit1 Bit0
1204 I or BI OVERFLAGS ACPRED FIELDTX
1205 P MYTYPEMB SKIPMB DIRECTMB
1206 B FORWARDMB SKIPMB DIRECTMB
1208 Within each byte, the lower nibble is for the first MB and the upper nibble is
1209 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1210 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1211 Macroblock #2 in the first row.
1214 /* VC-1 Slice Parameter Buffer */
1215 typedef struct _VASliceParameterBufferVC1
1217 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1218 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1219 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1220 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1221 unsigned int slice_vertical_position;
1222 } VASliceParameterBufferVC1;
1224 /* VC-1 Slice Data Buffer */
1226 This is simplely a buffer containing raw bit-stream bytes
1229 /****************************
1230 * H.264/AVC data structures
1231 ****************************/
1233 typedef struct _VAPictureH264
1235 VASurfaceID picture_id;
1236 unsigned int frame_idx;
1238 signed int TopFieldOrderCnt;
1239 signed int BottomFieldOrderCnt;
1241 /* flags in VAPictureH264 could be OR of the following */
1242 #define VA_PICTURE_H264_INVALID 0x00000001
1243 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1244 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1245 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1246 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1248 /* H.264 Picture Parameter Buffer */
1250 * For each picture, and before any slice data, a single
1251 * picture parameter buffer must be send.
1253 typedef struct _VAPictureParameterBufferH264
1255 VAPictureH264 CurrPic;
1256 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1257 unsigned short picture_width_in_mbs_minus1;
1258 unsigned short picture_height_in_mbs_minus1;
1259 unsigned char bit_depth_luma_minus8;
1260 unsigned char bit_depth_chroma_minus8;
1261 unsigned char num_ref_frames;
1264 unsigned int chroma_format_idc : 2;
1265 unsigned int residual_colour_transform_flag : 1;
1266 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1267 unsigned int frame_mbs_only_flag : 1;
1268 unsigned int mb_adaptive_frame_field_flag : 1;
1269 unsigned int direct_8x8_inference_flag : 1;
1270 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1271 unsigned int log2_max_frame_num_minus4 : 4;
1272 unsigned int pic_order_cnt_type : 2;
1273 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1274 unsigned int delta_pic_order_always_zero_flag : 1;
1278 unsigned char num_slice_groups_minus1;
1279 unsigned char slice_group_map_type;
1280 unsigned short slice_group_change_rate_minus1;
1281 signed char pic_init_qp_minus26;
1282 signed char pic_init_qs_minus26;
1283 signed char chroma_qp_index_offset;
1284 signed char second_chroma_qp_index_offset;
1287 unsigned int entropy_coding_mode_flag : 1;
1288 unsigned int weighted_pred_flag : 1;
1289 unsigned int weighted_bipred_idc : 2;
1290 unsigned int transform_8x8_mode_flag : 1;
1291 unsigned int field_pic_flag : 1;
1292 unsigned int constrained_intra_pred_flag : 1;
1293 unsigned int pic_order_present_flag : 1;
1294 unsigned int deblocking_filter_control_present_flag : 1;
1295 unsigned int redundant_pic_cnt_present_flag : 1;
1296 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1300 unsigned short frame_num;
1301 } VAPictureParameterBufferH264;
1303 /* H.264 Inverse Quantization Matrix Buffer */
1304 typedef struct _VAIQMatrixBufferH264
1306 unsigned char ScalingList4x4[6][16];
1307 unsigned char ScalingList8x8[2][64];
1308 } VAIQMatrixBufferH264;
1311 * H.264 Slice Group Map Buffer
1312 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1313 * A slice group map buffer should be sent for each picture if required. The buffer
1314 * is sent only when there is a change in the mapping values.
1315 * The slice group map buffer map "map units" to slice groups as specified in
1316 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1317 * in raster scan order
1320 /* H.264 Slice Parameter Buffer */
1321 typedef struct _VASliceParameterBufferH264
1323 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1324 /** \brief Byte offset to the NAL Header Unit for this slice. */
1325 unsigned int slice_data_offset;
1326 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1328 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1330 * This bit offset is relative to and includes the NAL unit byte
1331 * and represents the number of bits parsed in the slice_header()
1332 * after the removal of any emulation prevention bytes in
1333 * there. However, the slice data buffer passed to the hardware is
1334 * the original bitstream, thus including any emulation prevention
1337 unsigned short slice_data_bit_offset;
1338 unsigned short first_mb_in_slice;
1339 unsigned char slice_type;
1340 unsigned char direct_spatial_mv_pred_flag;
1341 unsigned char num_ref_idx_l0_active_minus1;
1342 unsigned char num_ref_idx_l1_active_minus1;
1343 unsigned char cabac_init_idc;
1344 char slice_qp_delta;
1345 unsigned char disable_deblocking_filter_idc;
1346 char slice_alpha_c0_offset_div2;
1347 char slice_beta_offset_div2;
1348 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1349 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1350 unsigned char luma_log2_weight_denom;
1351 unsigned char chroma_log2_weight_denom;
1352 unsigned char luma_weight_l0_flag;
1353 short luma_weight_l0[32];
1354 short luma_offset_l0[32];
1355 unsigned char chroma_weight_l0_flag;
1356 short chroma_weight_l0[32][2];
1357 short chroma_offset_l0[32][2];
1358 unsigned char luma_weight_l1_flag;
1359 short luma_weight_l1[32];
1360 short luma_offset_l1[32];
1361 unsigned char chroma_weight_l1_flag;
1362 short chroma_weight_l1[32][2];
1363 short chroma_offset_l1[32][2];
1364 } VASliceParameterBufferH264;
1366 /****************************
1367 * Common encode data structures
1368 ****************************/
1371 VAEncPictureTypeIntra = 0,
1372 VAEncPictureTypePredictive = 1,
1373 VAEncPictureTypeBidirectional = 2,
1376 /* Encode Slice Parameter Buffer */
1377 typedef struct _VAEncSliceParameterBuffer
1379 unsigned int start_row_number; /* starting MB row number for this slice */
1380 unsigned int slice_height; /* slice height measured in MB */
1383 unsigned int is_intra : 1;
1384 unsigned int disable_deblocking_filter_idc : 2;
1385 unsigned int uses_long_term_ref :1;
1386 unsigned int is_long_term_ref :1;
1390 } VAEncSliceParameterBuffer;
1392 /****************************
1393 * H.264 specific encode data structures
1394 ****************************/
1396 typedef struct _VAEncSequenceParameterBufferH264Baseline
1398 unsigned char seq_parameter_set_id;
1399 unsigned char level_idc;
1400 unsigned int intra_period;
1401 unsigned int intra_idr_period;
1402 unsigned int max_num_ref_frames;
1403 unsigned int picture_width_in_mbs;
1404 unsigned int picture_height_in_mbs;
1405 unsigned int bits_per_second;
1406 unsigned int frame_rate;
1407 unsigned int initial_qp;
1408 unsigned int min_qp;
1409 unsigned int basic_unit_size;
1410 unsigned char vui_flag;
1411 } VAEncSequenceParameterBufferH264Baseline;
1413 #define H264_LAST_PICTURE_EOSEQ 0x01 /* the last picture in the sequence */
1414 #define H264_LAST_PICTURE_EOSTREAM 0x02 /* the last picture in the stream */
1415 typedef struct _VAEncPictureParameterBufferH264Baseline
1417 VASurfaceID reference_picture;
1418 VASurfaceID reconstructed_picture;
1419 VABufferID coded_buf;
1420 unsigned short picture_width;
1421 unsigned short picture_height;
1422 unsigned char last_picture;
1423 } VAEncPictureParameterBufferH264Baseline;
1425 /****************************
1426 * H.263 specific encode data structures
1427 ****************************/
1429 typedef struct _VAEncSequenceParameterBufferH263
1431 unsigned int intra_period;
1432 unsigned int bits_per_second;
1433 unsigned int frame_rate;
1434 unsigned int initial_qp;
1435 unsigned int min_qp;
1436 } VAEncSequenceParameterBufferH263;
1438 typedef struct _VAEncPictureParameterBufferH263
1440 VASurfaceID reference_picture;
1441 VASurfaceID reconstructed_picture;
1442 VABufferID coded_buf;
1443 unsigned short picture_width;
1444 unsigned short picture_height;
1445 VAEncPictureType picture_type;
1446 } VAEncPictureParameterBufferH263;
1448 /****************************
1449 * MPEG-4 specific encode data structures
1450 ****************************/
1452 typedef struct _VAEncSequenceParameterBufferMPEG4
1454 unsigned char profile_and_level_indication;
1455 unsigned int intra_period;
1456 unsigned int video_object_layer_width;
1457 unsigned int video_object_layer_height;
1458 unsigned int vop_time_increment_resolution;
1459 unsigned int fixed_vop_rate;
1460 unsigned int fixed_vop_time_increment;
1461 unsigned int bits_per_second;
1462 unsigned int frame_rate;
1463 unsigned int initial_qp;
1464 unsigned int min_qp;
1465 } VAEncSequenceParameterBufferMPEG4;
1467 typedef struct _VAEncPictureParameterBufferMPEG4
1469 VASurfaceID reference_picture;
1470 VASurfaceID reconstructed_picture;
1471 VABufferID coded_buf;
1472 unsigned short picture_width;
1473 unsigned short picture_height;
1474 unsigned int modulo_time_base; /* number of 1s */
1475 unsigned int vop_time_increment;
1476 VAEncPictureType picture_type;
1477 } VAEncPictureParameterBufferMPEG4;
1481 /* Buffer functions */
1484 * Creates a buffer for "num_elements" elements of "size" bytes and
1485 * initalize with "data".
1486 * if "data" is null, then the contents of the buffer data store
1488 * Basically there are two ways to get buffer data to the server side. One is
1489 * to call vaCreateBuffer() with a non-null "data", which results the data being
1490 * copied to the data store on the server side. A different method that
1491 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1492 * and then use vaMapBuffer() to map the data store from the server side to the
1493 * client address space for access.
1494 * Note: image buffers are created by the library, not the client. Please see
1495 * vaCreateImage on how image buffers are managed.
1497 VAStatus vaCreateBuffer (
1499 VAContextID context,
1500 VABufferType type, /* in */
1501 unsigned int size, /* in */
1502 unsigned int num_elements, /* in */
1503 void *data, /* in */
1504 VABufferID *buf_id /* out */
1508 * Convey to the server how many valid elements are in the buffer.
1509 * e.g. if multiple slice parameters are being held in a single buffer,
1510 * this will communicate to the server the number of slice parameters
1511 * that are valid in the buffer.
1513 VAStatus vaBufferSetNumElements (
1515 VABufferID buf_id, /* in */
1516 unsigned int num_elements /* in */
1521 * device independent data structure for codedbuffer
1525 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1526 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1527 * enough for the encoder to attempt to limit its size.
1528 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1529 * exceeded the maximum slice size specified.
1530 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1531 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1532 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1534 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1535 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1536 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1537 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1538 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1540 * \brief The frame has exceeded the maximum requested size.
1542 * This flag indicates that the encoded frame size exceeds the value
1543 * specified through a misc parameter buffer of type
1544 * #VAEncMiscParameterTypeMaxFrameSize.
1546 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW 0x1000
1547 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1550 * device independent data structure for codedbuffer
1552 typedef struct _VACodedBufferSegment {
1553 unsigned int size;/* size of the data buffer in the coded buffer segment, in bytes */
1554 unsigned int bit_offset; /* bit offset into the data buffer where valid bitstream data begins */
1555 unsigned int status; /* status set by the driver on the coded buffer*/
1556 unsigned int reserved; /* for future use */
1557 void *buf; /* pointer to the beginning of the data buffer in the coded buffer segment */
1558 void *next; /* pointer to the next VACodedBufferSegment */
1559 } VACodedBufferSegment;
1562 * Map data store of the buffer into the client's address space
1563 * vaCreateBuffer() needs to be called with "data" set to NULL before
1564 * calling vaMapBuffer()
1566 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1567 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1569 VAStatus vaMapBuffer (
1571 VABufferID buf_id, /* in */
1572 void **pbuf /* out */
1576 * After client making changes to a mapped data store, it needs to
1577 * "Unmap" it to let the server know that the data is ready to be
1578 * consumed by the server
1580 VAStatus vaUnmapBuffer (
1582 VABufferID buf_id /* in */
1586 * After this call, the buffer is deleted and this buffer_id is no longer valid
1587 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1589 VAStatus vaDestroyBuffer (
1591 VABufferID buffer_id
1595 Render (Decode) Pictures
1597 A picture represents either a frame or a field.
1599 The Begin/Render/End sequence sends the decode buffers to the server
1603 * Get ready to decode a picture to a target surface
1605 VAStatus vaBeginPicture (
1607 VAContextID context,
1608 VASurfaceID render_target
1612 * Send decode buffers to the server.
1613 * Buffers are automatically destroyed afterwards
1615 VAStatus vaRenderPicture (
1617 VAContextID context,
1618 VABufferID *buffers,
1623 * Make the end of rendering for a picture.
1624 * The server should start processing all pending operations for this
1625 * surface. This call is non-blocking. The client can start another
1626 * Begin/Render/End sequence on a different render target.
1628 VAStatus vaEndPicture (
1640 * This function blocks until all pending operations on the render target
1641 * have been completed. Upon return it is safe to use the render target for a
1642 * different picture.
1644 VAStatus vaSyncSurface (
1646 VASurfaceID render_target
1651 VASurfaceRendering = 1, /* Rendering in progress */
1652 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1653 /* this status is useful if surface is used as the source */
1655 VASurfaceReady = 4, /* not being rendered or displayed */
1656 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1660 * Find out any pending ops on the render target
1662 VAStatus vaQuerySurfaceStatus (
1664 VASurfaceID render_target,
1665 VASurfaceStatus *status /* out */
1670 VADecodeSliceMissing = 0,
1671 VADecodeMBError = 1,
1672 } VADecodeErrorType;
1675 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1676 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1678 typedef struct _VASurfaceDecodeMBErrors
1680 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1681 unsigned int start_mb; /* start mb address with errors */
1682 unsigned int end_mb; /* end mb address with errors */
1683 VADecodeErrorType decode_error_type;
1684 } VASurfaceDecodeMBErrors;
1687 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1688 * it can call vaQuerySurfaceError to find out further details on the particular error.
1689 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1690 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1691 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1692 * The array is terminated if "status==-1" is detected.
1694 VAStatus vaQuerySurfaceError(
1696 VASurfaceID surface,
1697 VAStatus error_status,
1702 * Images and Subpictures
1703 * VAImage is used to either get the surface data to client memory, or
1704 * to copy image data in client memory to a surface.
1705 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1706 * is at the upper left corner with positive X to the right and positive Y down
1708 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1709 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1710 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1712 /* a few common FourCCs */
1713 #define VA_FOURCC_NV12 0x3231564E
1714 #define VA_FOURCC_AI44 0x34344149
1715 #define VA_FOURCC_RGBA 0x41424752
1716 #define VA_FOURCC_BGRA 0x41524742
1717 #define VA_FOURCC_UYVY 0x59565955
1718 #define VA_FOURCC_YUY2 0x32595559
1719 #define VA_FOURCC_AYUV 0x56555941
1720 #define VA_FOURCC_NV11 0x3131564e
1721 #define VA_FOURCC_YV12 0x32315659
1722 #define VA_FOURCC_P208 0x38303250
1723 #define VA_FOURCC_IYUV 0x56555949
1726 #define VA_LSB_FIRST 1
1727 #define VA_MSB_FIRST 2
1729 typedef struct _VAImageFormat
1731 unsigned int fourcc;
1732 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1733 unsigned int bits_per_pixel;
1734 /* for RGB formats */
1735 unsigned int depth; /* significant bits per pixel */
1736 unsigned int red_mask;
1737 unsigned int green_mask;
1738 unsigned int blue_mask;
1739 unsigned int alpha_mask;
1742 typedef VAGenericID VAImageID;
1744 typedef struct _VAImage
1746 VAImageID image_id; /* uniquely identify this image */
1747 VAImageFormat format;
1748 VABufferID buf; /* image data buffer */
1750 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1751 * data store on the server side for optimal performance. The buffer will be
1752 * created by the CreateImage function, and proper storage allocated based on the image
1753 * size and format. This buffer is managed by the library implementation, and
1754 * accessed by the client through the buffer Map/Unmap functions.
1756 unsigned short width;
1757 unsigned short height;
1758 unsigned int data_size;
1759 unsigned int num_planes; /* can not be greater than 3 */
1761 * An array indicating the scanline pitch in bytes for each plane.
1762 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1764 unsigned int pitches[3];
1766 * An array indicating the byte offset from the beginning of the image data
1767 * to the start of each plane.
1769 unsigned int offsets[3];
1771 /* The following fields are only needed for paletted formats */
1772 int num_palette_entries; /* set to zero for non-palette images */
1774 * Each component is one byte and entry_bytes indicates the number of components in
1775 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1779 * An array of ascii characters describing the order of the components within the bytes.
1780 * Only entry_bytes characters of the string are used.
1782 char component_order[4];
1785 /* Get maximum number of image formats supported by the implementation */
1786 int vaMaxNumImageFormats (
1791 * Query supported image formats
1792 * The caller must provide a "format_list" array that can hold at
1793 * least vaMaxNumImageFormats() entries. The actual number of formats
1794 * returned in "format_list" is returned in "num_formats".
1796 VAStatus vaQueryImageFormats (
1798 VAImageFormat *format_list, /* out */
1799 int *num_formats /* out */
1803 * Create a VAImage structure
1804 * The width and height fields returned in the VAImage structure may get
1805 * enlarged for some YUV formats. Upon return from this function,
1806 * image->buf has been created and proper storage allocated by the library.
1807 * The client can access the image through the Map/Unmap calls.
1809 VAStatus vaCreateImage (
1811 VAImageFormat *format,
1814 VAImage *image /* out */
1818 * Should call DestroyImage before destroying the surface it is bound to
1820 VAStatus vaDestroyImage (
1825 VAStatus vaSetImagePalette (
1829 * pointer to an array holding the palette data. The size of the array is
1830 * num_palette_entries * entry_bytes in size. The order of the components
1831 * in the palette is described by the component_order in VAImage struct
1833 unsigned char *palette
1837 * Retrive surface data into a VAImage
1838 * Image must be in a format supported by the implementation
1840 VAStatus vaGetImage (
1842 VASurfaceID surface,
1843 int x, /* coordinates of the upper left source pixel */
1845 unsigned int width, /* width and height of the region */
1846 unsigned int height,
1851 * Copy data from a VAImage to a surface
1852 * Image must be in a format supported by the implementation
1853 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1854 * shouldn't be rendered into when this is called
1856 VAStatus vaPutImage (
1858 VASurfaceID surface,
1862 unsigned int src_width,
1863 unsigned int src_height,
1866 unsigned int dest_width,
1867 unsigned int dest_height
1871 * Derive an VAImage from an existing surface.
1872 * This interface will derive a VAImage and corresponding image buffer from
1873 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1874 * direct CPU access. This operation is only possible on implementations with
1875 * direct rendering capabilities and internal surface formats that can be
1876 * represented with a VAImage. When the operation is not possible this interface
1877 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1878 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1881 * Implementations should only return success when the resulting image buffer
1882 * would be useable with vaMap/Unmap.
1884 * When directly accessing a surface special care must be taken to insure
1885 * proper synchronization with the graphics hardware. Clients should call
1886 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1887 * rendering or currently being displayed by an overlay.
1889 * Additionally nothing about the contents of a surface should be assumed
1890 * following a vaPutSurface. Implementations are free to modify the surface for
1891 * scaling or subpicture blending within a call to vaPutImage.
1893 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1894 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1895 * vaGetImage with other surfaces is supported.
1897 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1898 * image and image buffer structures will be destroyed; however, the underlying
1899 * surface will remain unchanged until freed with vaDestroySurfaces.
1901 VAStatus vaDeriveImage (
1903 VASurfaceID surface,
1904 VAImage *image /* out */
1909 * Subpicture is a special type of image that can be blended
1910 * with a surface during vaPutSurface(). Subpicture can be used to render
1911 * DVD sub-titles or closed captioning text etc.
1914 typedef VAGenericID VASubpictureID;
1916 /* Get maximum number of subpicture formats supported by the implementation */
1917 int vaMaxNumSubpictureFormats (
1921 /* flags for subpictures */
1922 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
1923 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
1924 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
1926 * Query supported subpicture formats
1927 * The caller must provide a "format_list" array that can hold at
1928 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1929 * for each format to indicate additional capabilities for that format. The actual
1930 * number of formats returned in "format_list" is returned in "num_formats".
1931 * flags: returned value to indicate addtional capabilities
1932 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1933 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1934 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
1937 VAStatus vaQuerySubpictureFormats (
1939 VAImageFormat *format_list, /* out */
1940 unsigned int *flags, /* out */
1941 unsigned int *num_formats /* out */
1945 * Subpictures are created with an image associated.
1947 VAStatus vaCreateSubpicture (
1950 VASubpictureID *subpicture /* out */
1954 * Destroy the subpicture before destroying the image it is assocated to
1956 VAStatus vaDestroySubpicture (
1958 VASubpictureID subpicture
1962 * Bind an image to the subpicture. This image will now be associated with
1963 * the subpicture instead of the one at creation.
1965 VAStatus vaSetSubpictureImage (
1967 VASubpictureID subpicture,
1972 * If chromakey is enabled, then the area where the source value falls within
1973 * the chromakey [min, max] range is transparent
1974 * The chromakey component format is the following:
1975 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
1976 * For YUV: [0:7] V [8:15] U [16:23] Y
1977 * The chromakey mask can be used to mask out certain components for chromakey
1980 VAStatus vaSetSubpictureChromakey (
1982 VASubpictureID subpicture,
1983 unsigned int chromakey_min,
1984 unsigned int chromakey_max,
1985 unsigned int chromakey_mask
1989 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
1990 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
1991 * the overall alpha is per-pixel alpha multiplied by the global alpha
1993 VAStatus vaSetSubpictureGlobalAlpha (
1995 VASubpictureID subpicture,
2000 * vaAssociateSubpicture associates the subpicture with target_surfaces.
2001 * It defines the region mapping between the subpicture and the target
2002 * surfaces through source and destination rectangles (with the same width and height).
2003 * Both will be displayed at the next call to vaPutSurface. Additional
2004 * associations before the call to vaPutSurface simply overrides the association.
2006 VAStatus vaAssociateSubpicture (
2008 VASubpictureID subpicture,
2009 VASurfaceID *target_surfaces,
2011 short src_x, /* upper left offset in subpicture */
2013 unsigned short src_width,
2014 unsigned short src_height,
2015 short dest_x, /* upper left offset in surface */
2017 unsigned short dest_width,
2018 unsigned short dest_height,
2020 * whether to enable chroma-keying, global-alpha, or screen relative mode
2021 * see VA_SUBPICTURE_XXX values
2027 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
2029 VAStatus vaDeassociateSubpicture (
2031 VASubpictureID subpicture,
2032 VASurfaceID *target_surfaces,
2036 typedef struct _VARectangle
2040 unsigned short width;
2041 unsigned short height;
2045 * Display attributes
2046 * Display attributes are used to control things such as contrast, hue, saturation,
2047 * brightness etc. in the rendering process. The application can query what
2048 * attributes are supported by the driver, and then set the appropriate attributes
2049 * before calling vaPutSurface()
2051 /* PowerVR IEP Lite attributes */
2054 VADISPLAYATTRIB_BLE_OFF = 0x00,
2055 VADISPLAYATTRIB_BLE_LOW,
2056 VADISPLAYATTRIB_BLE_MEDIUM,
2057 VADISPLAYATTRIB_BLE_HIGH,
2058 VADISPLAYATTRIB_BLE_NONE,
2059 } VADisplayAttribBLEMode;
2061 /* attribute value for VADisplayAttribRotation */
2062 #define VA_ROTATION_NONE 0x00000000
2063 #define VA_ROTATION_90 0x00000001
2064 #define VA_ROTATION_180 0x00000002
2065 #define VA_ROTATION_270 0x00000003
2067 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2068 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2069 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2072 #define VA_RENDER_MODE_UNDEFINED 0
2073 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2074 #define VA_RENDER_MODE_LOCAL_GPU 2
2075 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2076 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2079 #define VA_RENDER_DEVICE_UNDEFINED 0
2080 #define VA_RENDER_DEVICE_LOCAL 1
2081 #define VA_RENDER_DEVICE_EXTERNAL 2
2083 /* Currently defined display attribute types */
2086 VADisplayAttribBrightness = 0,
2087 VADisplayAttribContrast = 1,
2088 VADisplayAttribHue = 2,
2089 VADisplayAttribSaturation = 3,
2090 /* client can specifiy a background color for the target window
2091 * the new feature of video conference,
2092 * the uncovered area of the surface is filled by this color
2093 * also it will blend with the decoded video color
2095 VADisplayAttribBackgroundColor = 4,
2097 * this is a gettable only attribute. For some implementations that use the
2098 * hardware overlay, after PutSurface is called, the surface can not be
2099 * re-used until after the subsequent PutSurface call. If this is the case
2100 * then the value for this attribute will be set to 1 so that the client
2101 * will not attempt to re-use the surface right after returning from a call
2104 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2105 * driver may use overlay or GPU alternatively
2107 VADisplayAttribDirectSurface = 5,
2108 VADisplayAttribRotation = 6,
2109 VADisplayAttribOutofLoopDeblock = 7,
2111 /* PowerVR IEP Lite specific attributes */
2112 VADisplayAttribBLEBlackMode = 8,
2113 VADisplayAttribBLEWhiteMode = 9,
2114 VADisplayAttribBlueStretch = 10,
2115 VADisplayAttribSkinColorCorrection = 11,
2117 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2118 * conversion matrix. Each element in the matrix is float-point
2120 VADisplayAttribCSCMatrix = 12,
2121 /* specify the constant color used to blend with video surface
2122 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2123 * d: the final color to overwrite into the frame buffer
2124 * v: decoded video after color conversion,
2125 * c: video color specified by VADisplayAttribBlendColor
2126 * b: background color of the drawable
2128 VADisplayAttribBlendColor = 13,
2130 * Indicate driver to skip painting color key or not.
2131 * only applicable if the render is overlay
2133 VADisplayAttribOverlayAutoPaintColorKey = 14,
2135 * customized overlay color key, the format is RGB888
2136 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2138 VADisplayAttribOverlayColorKey = 15,
2140 * The hint for the implementation of vaPutSurface
2141 * normally, the driver could use an overlay or GPU to render the surface on the screen
2142 * this flag provides APP the flexibity to switch the render dynamically
2144 VADisplayAttribRenderMode = 16,
2146 * specify if vaPutSurface needs to render into specified monitors
2147 * one example is that one external monitor (e.g. HDMI) is enabled,
2148 * but the window manager is not aware of it, and there is no associated drawable
2150 VADisplayAttribRenderDevice = 17,
2152 * specify vaPutSurface render area if there is no drawable on the monitor
2154 VADisplayAttribRenderRect = 18,
2155 } VADisplayAttribType;
2157 /* flags for VADisplayAttribute */
2158 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2159 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2160 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2162 typedef struct _VADisplayAttribute
2164 VADisplayAttribType type;
2167 int value; /* used by the set/get attribute functions */
2168 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2170 } VADisplayAttribute;
2172 /* Get maximum number of display attributs supported by the implementation */
2173 int vaMaxNumDisplayAttributes (
2178 * Query display attributes
2179 * The caller must provide a "attr_list" array that can hold at
2180 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2181 * returned in "attr_list" is returned in "num_attributes".
2183 VAStatus vaQueryDisplayAttributes (
2185 VADisplayAttribute *attr_list, /* out */
2186 int *num_attributes /* out */
2190 * Get display attributes
2191 * This function returns the current attribute values in "attr_list".
2192 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2193 * from vaQueryDisplayAttributes() can have their values retrieved.
2195 VAStatus vaGetDisplayAttributes (
2197 VADisplayAttribute *attr_list, /* in/out */
2202 * Set display attributes
2203 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2204 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2205 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2207 VAStatus vaSetDisplayAttributes (
2209 VADisplayAttribute *attr_list,