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 } VAConfigAttribType;
339 * Configuration attributes
340 * If there is more than one value for an attribute, a default
341 * value will be assigned to the attribute if the client does not
342 * specify the attribute when creating a configuration
344 typedef struct _VAConfigAttrib {
345 VAConfigAttribType type;
346 unsigned int value; /* OR'd flags (bits) for this attribute */
349 /* attribute value for VAConfigAttribRTFormat */
350 #define VA_RT_FORMAT_YUV420 0x00000001
351 #define VA_RT_FORMAT_YUV422 0x00000002
352 #define VA_RT_FORMAT_YUV444 0x00000004
353 #define VA_RT_FORMAT_PROTECTED 0x80000000
355 /** @name Attribute values for VAConfigAttribRateControl */
357 /** \brief Driver does not support any form of rate control. */
358 #define VA_RC_NONE 0x00000001
359 /** \brief Constant bitrate. */
360 #define VA_RC_CBR 0x00000002
361 /** \brief Variable bitrate. */
362 #define VA_RC_VBR 0x00000004
363 /** \brief Video conference mode. */
364 #define VA_RC_VCM 0x00000008
365 /** \brief Constant QP. */
366 #define VA_RC_CQP 0x00000010
369 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
371 /** \brief Driver does not support any packed headers mode. */
372 #define VA_ENC_PACKED_HEADER_NONE 0x00000000
373 /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
374 #define VA_ENC_PACKED_HEADER_SEQUENCE 0x00000001
375 /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
376 #define VA_ENC_PACKED_HEADER_PICTURE 0x00000002
377 /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
378 #define VA_ENC_PACKED_HEADER_SLICE 0x00000004
381 /** @name Attribute values for VAConfigAttribEncInterlaced */
383 /** \brief Driver does not support interlaced coding. */
384 #define VA_ENC_INTERLACED_NONE 0x00000000
385 /** \brief Driver supports interlaced frame coding. */
386 #define VA_ENC_INTERLACED_FRAME 0x00000001
387 /** \brief Driver supports interlaced field coding. */
388 #define VA_ENC_INTERLACED_FIELD 0x00000002
389 /** \brief Driver supports macroblock adaptive frame field coding. */
390 #define VA_ENC_INTERLACED_MBAFF 0x00000004
391 /** \brief Driver supports picture adaptive frame field coding. */
392 #define VA_ENC_INTERLACED_PAFF 0x00000008
395 /** @name Attribute values for VAConfigAttribEncSliceStructure */
397 /** \brief Driver supports an arbitrary number of rows per slice. */
398 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS 0x00000000
399 /** \brief Driver supports a power-of-two number of rows per slice. */
400 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS 0x00000001
401 /** \brief Driver supports an arbitrary number of rows per slice. */
402 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS 0x00000002
406 * if an attribute is not applicable for a given
407 * profile/entrypoint pair, then set the value to the following
409 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
411 /* Get maximum number of profiles supported by the implementation */
412 int vaMaxNumProfiles (
416 /* Get maximum number of entrypoints supported by the implementation */
417 int vaMaxNumEntrypoints (
421 /* Get maximum number of attributs supported by the implementation */
422 int vaMaxNumConfigAttributes (
427 * Query supported profiles
428 * The caller must provide a "profile_list" array that can hold at
429 * least vaMaxNumProfile() entries. The actual number of profiles
430 * returned in "profile_list" is returned in "num_profile".
432 VAStatus vaQueryConfigProfiles (
434 VAProfile *profile_list, /* out */
435 int *num_profiles /* out */
439 * Query supported entrypoints for a given profile
440 * The caller must provide an "entrypoint_list" array that can hold at
441 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
442 * returned in "entrypoint_list" is returned in "num_entrypoints".
444 VAStatus vaQueryConfigEntrypoints (
447 VAEntrypoint *entrypoint_list, /* out */
448 int *num_entrypoints /* out */
452 * Get attributes for a given profile/entrypoint pair
453 * The caller must provide an "attrib_list" with all attributes to be
454 * retrieved. Upon return, the attributes in "attrib_list" have been
455 * updated with their value. Unknown attributes or attributes that are
456 * not supported for the given profile/entrypoint pair will have their
457 * value set to VA_ATTRIB_NOT_SUPPORTED
459 VAStatus vaGetConfigAttributes (
462 VAEntrypoint entrypoint,
463 VAConfigAttrib *attrib_list, /* in/out */
467 /* Generic ID type, can be re-typed for specific implementation */
468 typedef unsigned int VAGenericID;
470 typedef VAGenericID VAConfigID;
473 * Create a configuration for the decode pipeline
474 * it passes in the attribute list that specifies the attributes it cares
475 * about, with the rest taking default values.
477 VAStatus vaCreateConfig (
480 VAEntrypoint entrypoint,
481 VAConfigAttrib *attrib_list,
483 VAConfigID *config_id /* out */
487 * Free resources associdated with a given config
489 VAStatus vaDestroyConfig (
495 * Query all attributes for a given configuration
496 * The profile of the configuration is returned in "profile"
497 * The entrypoint of the configuration is returned in "entrypoint"
498 * The caller must provide an "attrib_list" array that can hold at least
499 * vaMaxNumConfigAttributes() entries. The actual number of attributes
500 * returned in "attrib_list" is returned in "num_attribs"
502 VAStatus vaQueryConfigAttributes (
504 VAConfigID config_id,
505 VAProfile *profile, /* out */
506 VAEntrypoint *entrypoint, /* out */
507 VAConfigAttrib *attrib_list,/* out */
508 int *num_attribs /* out */
513 * Contexts and Surfaces
515 * Context represents a "virtual" video decode pipeline. Surfaces are render
516 * targets for a given context. The data in the surfaces are not accessible
517 * to the client and the internal data format of the surface is implementatin
520 * Surfaces will be bound to a context when the context is created. Once
521 * a surface is bound to a given context, it can not be used to create
522 * another context. The association is removed when the context is destroyed
524 * Both contexts and surfaces are identified by unique IDs and its
525 * implementation specific internals are kept opaque to the clients
528 typedef VAGenericID VAContextID;
530 typedef VAGenericID VASurfaceID;
532 #define VA_INVALID_ID 0xffffffff
533 #define VA_INVALID_SURFACE VA_INVALID_ID
535 /** \brief Generic value types. */
537 VAGenericValueTypeInteger = 1, /**< 32-bit signed integer. */
538 VAGenericValueTypeFloat, /**< 32-bit floating-point value. */
539 VAGenericValueTypePointer, /**< Generic pointer type */
540 VAGenericValueTypeFunc /**< Pointer to function */
541 } VAGenericValueType;
543 /** \brief Generic function type. */
544 typedef void (*VAGenericFunc)(void);
546 /** \brief Generic value. */
547 typedef struct _VAGenericValue {
548 /** \brief Value type. See #VAGenericValueType. */
549 VAGenericValueType type;
550 /** \brief Value holder. */
552 /** \brief 32-bit signed integer. */
554 /** \brief 32-bit float. */
556 /** \brief Generic pointer. */
558 /** \brief Pointer to function. */
564 * vaCreateSurfaces - Create an array of surfaces used for decode and display
566 * width: surface width
567 * height: surface height
568 * format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
569 * num_surfaces: number of surfaces to be created
570 * surfaces: array of surfaces created upon return
572 VAStatus vaCreateSurfaces (
578 VASurfaceID *surfaces /* out */
583 * vaDestroySurfaces - Destroy resources associated with surfaces.
584 * Surfaces can only be destroyed after the context associated has been
587 * surfaces: array of surfaces to destroy
588 * num_surfaces: number of surfaces in the array to be destroyed.
590 VAStatus vaDestroySurfaces (
592 VASurfaceID *surfaces,
596 #define VA_PROGRESSIVE 0x1
598 * vaCreateContext - Create a context
600 * config_id: configuration for the context
601 * picture_width: coded picture width
602 * picture_height: coded picture height
603 * flag: any combination of the following:
604 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
605 * render_targets: render targets (surfaces) tied to the context
606 * num_render_targets: number of render targets in the above array
607 * context: created context id upon return
609 VAStatus vaCreateContext (
611 VAConfigID config_id,
615 VASurfaceID *render_targets,
616 int num_render_targets,
617 VAContextID *context /* out */
621 * vaDestroyContext - Destroy a context
623 * context: context to be destroyed
625 VAStatus vaDestroyContext (
632 * Buffers are used to pass various types of data from the
633 * client to the server. The server maintains a data store
634 * for each buffer created, and the client idenfies a buffer
635 * through a unique buffer id assigned by the server.
638 typedef VAGenericID VABufferID;
642 VAPictureParameterBufferType = 0,
643 VAIQMatrixBufferType = 1,
644 VABitPlaneBufferType = 2,
645 VASliceGroupMapBufferType = 3,
646 VASliceParameterBufferType = 4,
647 VASliceDataBufferType = 5,
648 VAMacroblockParameterBufferType = 6,
649 VAResidualDataBufferType = 7,
650 VADeblockingParameterBufferType = 8,
651 VAImageBufferType = 9,
652 VAProtectedSliceDataBufferType = 10,
653 VAQMatrixBufferType = 11,
654 VAHuffmanTableBufferType = 12,
656 /* Following are encode buffer types */
657 VAEncCodedBufferType = 21,
658 VAEncSequenceParameterBufferType = 22,
659 VAEncPictureParameterBufferType = 23,
660 VAEncSliceParameterBufferType = 24,
661 VAEncPackedHeaderParameterBufferType = 25,
662 VAEncPackedHeaderDataBufferType = 26,
663 VAEncMiscParameterBufferType = 27,
664 VAEncMacroblockParameterBufferType = 28,
665 VABufferTypeMax = 0xff
670 VAEncMiscParameterTypeFrameRate = 0,
671 VAEncMiscParameterTypeRateControl = 1,
672 VAEncMiscParameterTypeMaxSliceSize = 2,
673 VAEncMiscParameterTypeAIR = 3,
674 } VAEncMiscParameterType;
676 /** \brief Packed header type. */
678 VAEncPackedHeaderSequence = 1, /**< Packed sequence header. */
679 VAEncPackedHeaderPicture = 2, /**< Packed picture header. */
680 VAEncPackedHeaderSlice = 3, /**< Packed slice header. */
681 } VAEncPackedHeaderType;
683 /** \brief Packed header parameter. */
684 typedef struct _VAEncPackedHeaderParameterBuffer {
685 /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
686 VAEncPackedHeaderType type;
687 /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
688 unsigned int bit_length;
689 /** \brief Flag: buffer contains start code emulation prevention bytes? */
690 unsigned char has_emulation_bytes;
691 } VAEncPackedHeaderParameterBuffer;
694 * For application, e.g. set a new bitrate
696 * VAEncMiscParameterBuffer *misc_param;
697 * VAEncMiscParameterRateControl *misc_rate_ctrl;
699 * vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
700 * sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
703 * vaMapBuffer(dpy,buf_id,(void **)&misc_param);
704 * misc_param->type = VAEncMiscParameterTypeRateControl;
705 * misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
706 * misc_rate_ctrl->bits_per_second = 6400000;
707 * vaUnmapBuffer(dpy, buf_id);
708 * vaRenderPicture(dpy, context, &buf_id, 1);
710 typedef struct _VAEncMiscParameterBuffer
712 VAEncMiscParameterType type;
713 unsigned int data[0];
714 } VAEncMiscParameterBuffer;
716 typedef struct _VAEncMiscParameterRateControl
718 unsigned int bits_per_second; /* this is the maximum bit-rate to be constrained by the rate control implementation */
719 unsigned int target_percentage; /* this is the bit-rate the rate control is targeting, as a percentage of the maximum bit-rate */
720 /* for example if target_percentage is 95 then the rate control will target a bit-rate that is */
721 /* 95% of the maximum bit-rate */
722 unsigned int window_size; /* windows size in milliseconds. For example if this is set to 500, then the rate control will guarantee the */
723 /* target bit-rate over a 500 ms window */
724 unsigned int initial_qp; /* initial QP at I frames */
726 } VAEncMiscParameterRateControl;
728 typedef struct _VAEncMiscParameterFrameRate
730 unsigned int framerate;
731 } VAEncMiscParameterFrameRate;
734 * Allow a maximum slice size to be specified (in bits).
735 * The encoder will attempt to make sure that individual slices do not exceed this size
736 * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
738 typedef struct _VAEncMiscParameterMaxSliceSize
740 unsigned int max_slice_size;
741 } VAEncMiscParameterMaxSliceSize;
743 typedef struct _VAEncMiscParameterAIR
745 unsigned int air_num_mbs;
746 unsigned int air_threshold;
747 unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
748 } VAEncMiscParameterAIR;
752 * There will be cases where the bitstream buffer will not have enough room to hold
753 * the data for the entire slice, and the following flags will be used in the slice
754 * parameter to signal to the server for the possible cases.
755 * If a slice parameter buffer and slice data buffer pair is sent to the server with
756 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
757 * then a slice parameter and data buffer needs to be sent again to complete this slice.
759 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
760 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
761 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
762 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
764 /* Codec-independent Slice Parameter Buffer base */
765 typedef struct _VASliceParameterBufferBase
767 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
768 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
769 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
770 } VASliceParameterBufferBase;
773 /****************************
774 * JEPG data structure
775 ***************************/
776 typedef struct _VAQMatrixBufferJPEG
778 int load_lum_quantiser_matrix;
779 int load_chroma_quantiser_matrix;
780 unsigned char lum_quantiser_matrix[64];
781 unsigned char chroma_quantiser_matrix[64];
782 } VAQMatrixBufferJPEG;
784 typedef struct _VAEncPictureParameterBufferJPEG
786 VASurfaceID reconstructed_picture;
787 unsigned short picture_width;
788 unsigned short picture_height;
789 VABufferID coded_buf;
790 } VAEncPictureParameterBufferJPEG;
792 #include <va/va_dec_jpeg.h>
794 /****************************
795 * MPEG-2 data structures
796 ****************************/
798 /* MPEG-2 Picture Parameter Buffer */
800 * For each frame or field, and before any slice data, a single
801 * picture parameter buffer must be send.
803 typedef struct _VAPictureParameterBufferMPEG2
805 unsigned short horizontal_size;
806 unsigned short vertical_size;
807 VASurfaceID forward_reference_picture;
808 VASurfaceID backward_reference_picture;
809 /* meanings of the following fields are the same as in the standard */
810 int picture_coding_type;
811 int f_code; /* pack all four fcode into this */
814 unsigned int intra_dc_precision : 2;
815 unsigned int picture_structure : 2;
816 unsigned int top_field_first : 1;
817 unsigned int frame_pred_frame_dct : 1;
818 unsigned int concealment_motion_vectors : 1;
819 unsigned int q_scale_type : 1;
820 unsigned int intra_vlc_format : 1;
821 unsigned int alternate_scan : 1;
822 unsigned int repeat_first_field : 1;
823 unsigned int progressive_frame : 1;
824 unsigned int is_first_field : 1; /* indicate whether the current field
825 * is the first field for field picture
829 } picture_coding_extension;
830 } VAPictureParameterBufferMPEG2;
832 /* MPEG-2 Inverse Quantization Matrix Buffer */
833 typedef struct _VAIQMatrixBufferMPEG2
835 int load_intra_quantiser_matrix;
836 int load_non_intra_quantiser_matrix;
837 int load_chroma_intra_quantiser_matrix;
838 int load_chroma_non_intra_quantiser_matrix;
839 unsigned char intra_quantiser_matrix[64];
840 unsigned char non_intra_quantiser_matrix[64];
841 unsigned char chroma_intra_quantiser_matrix[64];
842 unsigned char chroma_non_intra_quantiser_matrix[64];
843 } VAIQMatrixBufferMPEG2;
845 /* MPEG-2 Slice Parameter Buffer */
846 typedef struct _VASliceParameterBufferMPEG2
848 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
849 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
850 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
851 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
852 unsigned int slice_horizontal_position;
853 unsigned int slice_vertical_position;
854 int quantiser_scale_code;
855 int intra_slice_flag;
856 } VASliceParameterBufferMPEG2;
858 /* MPEG-2 Macroblock Parameter Buffer */
859 typedef struct _VAMacroblockParameterBufferMPEG2
861 unsigned short macroblock_address;
863 * macroblock_address (in raster scan order)
865 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
867 unsigned char macroblock_type; /* see definition below */
870 unsigned int frame_motion_type : 2;
871 unsigned int field_motion_type : 2;
872 unsigned int dct_type : 1;
876 unsigned char motion_vertical_field_select;
878 * motion_vertical_field_select:
879 * see section 6.3.17.2 in the spec
880 * only the lower 4 bits are used
881 * bit 0: first vector forward
882 * bit 1: first vector backward
883 * bit 2: second vector forward
884 * bit 3: second vector backward
886 short PMV[2][2][2]; /* see Table 7-7 in the spec */
887 unsigned short coded_block_pattern;
889 * The bitplanes for coded_block_pattern are described
890 * in Figure 6.10-12 in the spec
893 /* Number of skipped macroblocks after this macroblock */
894 unsigned short num_skipped_macroblocks;
895 } VAMacroblockParameterBufferMPEG2;
898 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
900 #define VA_MB_TYPE_MOTION_FORWARD 0x02
901 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
902 #define VA_MB_TYPE_MOTION_PATTERN 0x08
903 #define VA_MB_TYPE_MOTION_INTRA 0x10
906 * MPEG-2 Residual Data Buffer
907 * For each macroblock, there wil be 64 shorts (16-bit) in the
908 * residual data buffer
911 /****************************
912 * MPEG-4 Part 2 data structures
913 ****************************/
915 /* MPEG-4 Picture Parameter Buffer */
917 * For each frame or field, and before any slice data, a single
918 * picture parameter buffer must be send.
920 typedef struct _VAPictureParameterBufferMPEG4
922 unsigned short vop_width;
923 unsigned short vop_height;
924 VASurfaceID forward_reference_picture;
925 VASurfaceID backward_reference_picture;
928 unsigned int short_video_header : 1;
929 unsigned int chroma_format : 2;
930 unsigned int interlaced : 1;
931 unsigned int obmc_disable : 1;
932 unsigned int sprite_enable : 2;
933 unsigned int sprite_warping_accuracy : 2;
934 unsigned int quant_type : 1;
935 unsigned int quarter_sample : 1;
936 unsigned int data_partitioned : 1;
937 unsigned int reversible_vlc : 1;
938 unsigned int resync_marker_disable : 1;
942 unsigned char no_of_sprite_warping_points;
943 short sprite_trajectory_du[3];
944 short sprite_trajectory_dv[3];
945 unsigned char quant_precision;
948 unsigned int vop_coding_type : 2;
949 unsigned int backward_reference_vop_coding_type : 2;
950 unsigned int vop_rounding_type : 1;
951 unsigned int intra_dc_vlc_thr : 3;
952 unsigned int top_field_first : 1;
953 unsigned int alternate_vertical_scan_flag : 1;
957 unsigned char vop_fcode_forward;
958 unsigned char vop_fcode_backward;
959 unsigned short vop_time_increment_resolution;
960 /* short header related */
961 unsigned char num_gobs_in_vop;
962 unsigned char num_macroblocks_in_gob;
963 /* for direct mode prediction */
966 } VAPictureParameterBufferMPEG4;
968 /* MPEG-4 Inverse Quantization Matrix Buffer */
969 typedef struct _VAIQMatrixBufferMPEG4
971 int load_intra_quant_mat;
972 int load_non_intra_quant_mat;
973 unsigned char intra_quant_mat[64];
974 unsigned char non_intra_quant_mat[64];
975 } VAIQMatrixBufferMPEG4;
977 /* MPEG-4 Slice Parameter Buffer */
978 typedef struct _VASliceParameterBufferMPEG4
980 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
981 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
982 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
983 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
984 unsigned int macroblock_number;
986 } VASliceParameterBufferMPEG4;
992 typedef enum /* see 7.1.1.32 */
995 VAMvMode1MvHalfPel = 1,
996 VAMvMode1MvHalfPelBilinear = 2,
998 VAMvModeIntensityCompensation = 4
1001 /* VC-1 Picture Parameter Buffer */
1003 * For each picture, and before any slice data, a picture parameter
1004 * buffer must be send. Multiple picture parameter buffers may be
1005 * sent for a single picture. In that case picture parameters will
1006 * apply to all slice data that follow it until a new picture
1007 * parameter buffer is sent.
1010 * pic_quantizer_type should be set to the applicable quantizer
1011 * type as defined by QUANTIZER (J.1.19) and either
1012 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
1014 typedef struct _VAPictureParameterBufferVC1
1016 VASurfaceID forward_reference_picture;
1017 VASurfaceID backward_reference_picture;
1018 /* if out-of-loop post-processing is done on the render
1019 target, then we need to keep the in-loop decoded
1020 picture as a reference picture */
1021 VASurfaceID inloop_decoded_picture;
1023 /* sequence layer for AP or meta data for SP and MP */
1026 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
1027 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
1028 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
1029 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
1030 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
1031 unsigned int multires : 1; /* METADATA::MULTIRES */
1032 unsigned int overlap : 1; /* METADATA::OVERLAP */
1033 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
1034 unsigned int rangered : 1; /* METADATA::RANGERED */
1035 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
1036 unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
1041 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
1042 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
1045 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
1046 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
1047 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
1048 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
1051 } entrypoint_fields;
1052 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
1053 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
1056 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
1057 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
1058 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
1059 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
1062 } range_mapping_fields;
1064 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
1065 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
1066 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
1067 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
1068 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
1069 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
1070 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
1071 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
1072 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
1075 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
1076 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
1077 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
1078 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
1079 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
1085 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1086 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
1087 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
1088 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
1089 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
1090 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
1091 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
1097 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
1098 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
1099 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
1100 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
1101 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
1102 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
1103 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
1106 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
1109 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
1110 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
1111 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
1112 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
1118 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
1119 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
1120 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
1121 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
1122 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
1123 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
1124 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
1125 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
1126 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
1127 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
1133 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
1134 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
1135 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
1136 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
1137 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
1138 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
1139 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
1140 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
1141 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
1142 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
1143 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
1146 } pic_quantizer_fields;
1149 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
1150 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
1151 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
1152 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
1153 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
1154 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
1158 } VAPictureParameterBufferVC1;
1160 /* VC-1 Bitplane Buffer
1161 There will be at most three bitplanes coded in any picture header. To send
1162 the bitplane data more efficiently, each byte is divided in two nibbles, with
1163 each nibble carrying three bitplanes for one macroblock. The following table
1164 shows the bitplane data arrangement within each nibble based on the picture
1167 Picture Type Bit3 Bit2 Bit1 Bit0
1168 I or BI OVERFLAGS ACPRED FIELDTX
1169 P MYTYPEMB SKIPMB DIRECTMB
1170 B FORWARDMB SKIPMB DIRECTMB
1172 Within each byte, the lower nibble is for the first MB and the upper nibble is
1173 for the second MB. E.g. the lower nibble of the first byte in the bitplane
1174 buffer is for Macroblock #1 and the upper nibble of the first byte is for
1175 Macroblock #2 in the first row.
1178 /* VC-1 Slice Parameter Buffer */
1179 typedef struct _VASliceParameterBufferVC1
1181 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1182 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
1183 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1184 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
1185 unsigned int slice_vertical_position;
1186 } VASliceParameterBufferVC1;
1188 /* VC-1 Slice Data Buffer */
1190 This is simplely a buffer containing raw bit-stream bytes
1193 /****************************
1194 * H.264/AVC data structures
1195 ****************************/
1197 typedef struct _VAPictureH264
1199 VASurfaceID picture_id;
1200 unsigned int frame_idx;
1202 signed int TopFieldOrderCnt;
1203 signed int BottomFieldOrderCnt;
1205 /* flags in VAPictureH264 could be OR of the following */
1206 #define VA_PICTURE_H264_INVALID 0x00000001
1207 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
1208 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
1209 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
1210 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
1212 /* H.264 Picture Parameter Buffer */
1214 * For each picture, and before any slice data, a single
1215 * picture parameter buffer must be send.
1217 typedef struct _VAPictureParameterBufferH264
1219 VAPictureH264 CurrPic;
1220 VAPictureH264 ReferenceFrames[16]; /* in DPB */
1221 unsigned short picture_width_in_mbs_minus1;
1222 unsigned short picture_height_in_mbs_minus1;
1223 unsigned char bit_depth_luma_minus8;
1224 unsigned char bit_depth_chroma_minus8;
1225 unsigned char num_ref_frames;
1228 unsigned int chroma_format_idc : 2;
1229 unsigned int residual_colour_transform_flag : 1;
1230 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
1231 unsigned int frame_mbs_only_flag : 1;
1232 unsigned int mb_adaptive_frame_field_flag : 1;
1233 unsigned int direct_8x8_inference_flag : 1;
1234 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
1235 unsigned int log2_max_frame_num_minus4 : 4;
1236 unsigned int pic_order_cnt_type : 2;
1237 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
1238 unsigned int delta_pic_order_always_zero_flag : 1;
1242 unsigned char num_slice_groups_minus1;
1243 unsigned char slice_group_map_type;
1244 unsigned short slice_group_change_rate_minus1;
1245 signed char pic_init_qp_minus26;
1246 signed char pic_init_qs_minus26;
1247 signed char chroma_qp_index_offset;
1248 signed char second_chroma_qp_index_offset;
1251 unsigned int entropy_coding_mode_flag : 1;
1252 unsigned int weighted_pred_flag : 1;
1253 unsigned int weighted_bipred_idc : 2;
1254 unsigned int transform_8x8_mode_flag : 1;
1255 unsigned int field_pic_flag : 1;
1256 unsigned int constrained_intra_pred_flag : 1;
1257 unsigned int pic_order_present_flag : 1;
1258 unsigned int deblocking_filter_control_present_flag : 1;
1259 unsigned int redundant_pic_cnt_present_flag : 1;
1260 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1264 unsigned short frame_num;
1265 } VAPictureParameterBufferH264;
1267 /* H.264 Inverse Quantization Matrix Buffer */
1268 typedef struct _VAIQMatrixBufferH264
1270 unsigned char ScalingList4x4[6][16];
1271 unsigned char ScalingList8x8[2][64];
1272 } VAIQMatrixBufferH264;
1275 * H.264 Slice Group Map Buffer
1276 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1277 * A slice group map buffer should be sent for each picture if required. The buffer
1278 * is sent only when there is a change in the mapping values.
1279 * The slice group map buffer map "map units" to slice groups as specified in
1280 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1281 * in raster scan order
1284 /* H.264 Slice Parameter Buffer */
1285 typedef struct _VASliceParameterBufferH264
1287 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1288 /** \brief Byte offset to the NAL Header Unit for this slice. */
1289 unsigned int slice_data_offset;
1290 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1292 * \brief Bit offset from NAL Header Unit to the begining of slice_data().
1294 * This bit offset is relative to and includes the NAL unit byte
1295 * and represents the number of bits parsed in the slice_header()
1296 * after the removal of any emulation prevention bytes in
1297 * there. However, the slice data buffer passed to the hardware is
1298 * the original bitstream, thus including any emulation prevention
1301 unsigned short slice_data_bit_offset;
1302 unsigned short first_mb_in_slice;
1303 unsigned char slice_type;
1304 unsigned char direct_spatial_mv_pred_flag;
1305 unsigned char num_ref_idx_l0_active_minus1;
1306 unsigned char num_ref_idx_l1_active_minus1;
1307 unsigned char cabac_init_idc;
1308 char slice_qp_delta;
1309 unsigned char disable_deblocking_filter_idc;
1310 char slice_alpha_c0_offset_div2;
1311 char slice_beta_offset_div2;
1312 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1313 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1314 unsigned char luma_log2_weight_denom;
1315 unsigned char chroma_log2_weight_denom;
1316 unsigned char luma_weight_l0_flag;
1317 short luma_weight_l0[32];
1318 short luma_offset_l0[32];
1319 unsigned char chroma_weight_l0_flag;
1320 short chroma_weight_l0[32][2];
1321 short chroma_offset_l0[32][2];
1322 unsigned char luma_weight_l1_flag;
1323 short luma_weight_l1[32];
1324 short luma_offset_l1[32];
1325 unsigned char chroma_weight_l1_flag;
1326 short chroma_weight_l1[32][2];
1327 short chroma_offset_l1[32][2];
1328 } VASliceParameterBufferH264;
1330 /****************************
1331 * Common encode data structures
1332 ****************************/
1335 VAEncPictureTypeIntra = 0,
1336 VAEncPictureTypePredictive = 1,
1337 VAEncPictureTypeBidirectional = 2,
1340 /* Encode Slice Parameter Buffer */
1341 typedef struct _VAEncSliceParameterBuffer
1343 unsigned int start_row_number; /* starting MB row number for this slice */
1344 unsigned int slice_height; /* slice height measured in MB */
1347 unsigned int is_intra : 1;
1348 unsigned int disable_deblocking_filter_idc : 2;
1349 unsigned int uses_long_term_ref :1;
1350 unsigned int is_long_term_ref :1;
1354 } VAEncSliceParameterBuffer;
1356 /****************************
1357 * H.264 specific encode data structures
1358 ****************************/
1360 typedef struct _VAEncSequenceParameterBufferH264Baseline
1362 unsigned char seq_parameter_set_id;
1363 unsigned char level_idc;
1364 unsigned int intra_period;
1365 unsigned int intra_idr_period;
1366 unsigned int max_num_ref_frames;
1367 unsigned int picture_width_in_mbs;
1368 unsigned int picture_height_in_mbs;
1369 unsigned int bits_per_second;
1370 unsigned int frame_rate;
1371 unsigned int initial_qp;
1372 unsigned int min_qp;
1373 unsigned int basic_unit_size;
1374 unsigned char vui_flag;
1375 } VAEncSequenceParameterBufferH264Baseline;
1377 #define H264_LAST_PICTURE_EOSEQ 0x01 /* the last picture in the sequence */
1378 #define H264_LAST_PICTURE_EOSTREAM 0x02 /* the last picture in the stream */
1379 typedef struct _VAEncPictureParameterBufferH264Baseline
1381 VASurfaceID reference_picture;
1382 VASurfaceID reconstructed_picture;
1383 VABufferID coded_buf;
1384 unsigned short picture_width;
1385 unsigned short picture_height;
1386 unsigned char last_picture;
1387 } VAEncPictureParameterBufferH264Baseline;
1389 /****************************
1390 * H.263 specific encode data structures
1391 ****************************/
1393 typedef struct _VAEncSequenceParameterBufferH263
1395 unsigned int intra_period;
1396 unsigned int bits_per_second;
1397 unsigned int frame_rate;
1398 unsigned int initial_qp;
1399 unsigned int min_qp;
1400 } VAEncSequenceParameterBufferH263;
1402 typedef struct _VAEncPictureParameterBufferH263
1404 VASurfaceID reference_picture;
1405 VASurfaceID reconstructed_picture;
1406 VABufferID coded_buf;
1407 unsigned short picture_width;
1408 unsigned short picture_height;
1409 VAEncPictureType picture_type;
1410 } VAEncPictureParameterBufferH263;
1412 /****************************
1413 * MPEG-4 specific encode data structures
1414 ****************************/
1416 typedef struct _VAEncSequenceParameterBufferMPEG4
1418 unsigned char profile_and_level_indication;
1419 unsigned int intra_period;
1420 unsigned int video_object_layer_width;
1421 unsigned int video_object_layer_height;
1422 unsigned int vop_time_increment_resolution;
1423 unsigned int fixed_vop_rate;
1424 unsigned int fixed_vop_time_increment;
1425 unsigned int bits_per_second;
1426 unsigned int frame_rate;
1427 unsigned int initial_qp;
1428 unsigned int min_qp;
1429 } VAEncSequenceParameterBufferMPEG4;
1431 typedef struct _VAEncPictureParameterBufferMPEG4
1433 VASurfaceID reference_picture;
1434 VASurfaceID reconstructed_picture;
1435 VABufferID coded_buf;
1436 unsigned short picture_width;
1437 unsigned short picture_height;
1438 unsigned int modulo_time_base; /* number of 1s */
1439 unsigned int vop_time_increment;
1440 VAEncPictureType picture_type;
1441 } VAEncPictureParameterBufferMPEG4;
1445 /* Buffer functions */
1448 * Creates a buffer for "num_elements" elements of "size" bytes and
1449 * initalize with "data".
1450 * if "data" is null, then the contents of the buffer data store
1452 * Basically there are two ways to get buffer data to the server side. One is
1453 * to call vaCreateBuffer() with a non-null "data", which results the data being
1454 * copied to the data store on the server side. A different method that
1455 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1456 * and then use vaMapBuffer() to map the data store from the server side to the
1457 * client address space for access.
1458 * Note: image buffers are created by the library, not the client. Please see
1459 * vaCreateImage on how image buffers are managed.
1461 VAStatus vaCreateBuffer (
1463 VAContextID context,
1464 VABufferType type, /* in */
1465 unsigned int size, /* in */
1466 unsigned int num_elements, /* in */
1467 void *data, /* in */
1468 VABufferID *buf_id /* out */
1472 * Convey to the server how many valid elements are in the buffer.
1473 * e.g. if multiple slice parameters are being held in a single buffer,
1474 * this will communicate to the server the number of slice parameters
1475 * that are valid in the buffer.
1477 VAStatus vaBufferSetNumElements (
1479 VABufferID buf_id, /* in */
1480 unsigned int num_elements /* in */
1485 * device independent data structure for codedbuffer
1489 * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
1490 * LARGE_SLICE(bit8):At least one slice in the current frame was large
1491 * enough for the encoder to attempt to limit its size.
1492 * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
1493 * exceeded the maximum slice size specified.
1494 * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
1495 * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
1496 * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
1498 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
1499 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
1500 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
1501 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
1502 #define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
1503 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
1506 * device independent data structure for codedbuffer
1508 typedef struct _VACodedBufferSegment {
1509 unsigned int size;/* size of the data buffer in the coded buffer segment, in bytes */
1510 unsigned int bit_offset; /* bit offset into the data buffer where valid bitstream data begins */
1511 unsigned int status; /* status set by the driver on the coded buffer*/
1512 unsigned int reserved; /* for future use */
1513 void *buf; /* pointer to the beginning of the data buffer in the coded buffer segment */
1514 void *next; /* pointer to the next VACodedBufferSegment */
1515 } VACodedBufferSegment;
1518 * Map data store of the buffer into the client's address space
1519 * vaCreateBuffer() needs to be called with "data" set to NULL before
1520 * calling vaMapBuffer()
1522 * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
1523 * VACodedBufferSegment, and the list is terminated if "next" is NULL
1525 VAStatus vaMapBuffer (
1527 VABufferID buf_id, /* in */
1528 void **pbuf /* out */
1532 * After client making changes to a mapped data store, it needs to
1533 * "Unmap" it to let the server know that the data is ready to be
1534 * consumed by the server
1536 VAStatus vaUnmapBuffer (
1538 VABufferID buf_id /* in */
1542 * After this call, the buffer is deleted and this buffer_id is no longer valid
1543 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1545 VAStatus vaDestroyBuffer (
1547 VABufferID buffer_id
1551 Render (Decode) Pictures
1553 A picture represents either a frame or a field.
1555 The Begin/Render/End sequence sends the decode buffers to the server
1559 * Get ready to decode a picture to a target surface
1561 VAStatus vaBeginPicture (
1563 VAContextID context,
1564 VASurfaceID render_target
1568 * Send decode buffers to the server.
1569 * Buffers are automatically destroyed afterwards
1571 VAStatus vaRenderPicture (
1573 VAContextID context,
1574 VABufferID *buffers,
1579 * Make the end of rendering for a picture.
1580 * The server should start processing all pending operations for this
1581 * surface. This call is non-blocking. The client can start another
1582 * Begin/Render/End sequence on a different render target.
1584 VAStatus vaEndPicture (
1596 * This function blocks until all pending operations on the render target
1597 * have been completed. Upon return it is safe to use the render target for a
1598 * different picture.
1600 VAStatus vaSyncSurface (
1602 VASurfaceID render_target
1607 VASurfaceRendering = 1, /* Rendering in progress */
1608 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1609 /* this status is useful if surface is used as the source */
1611 VASurfaceReady = 4, /* not being rendered or displayed */
1612 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1616 * Find out any pending ops on the render target
1618 VAStatus vaQuerySurfaceStatus (
1620 VASurfaceID render_target,
1621 VASurfaceStatus *status /* out */
1626 VADecodeSliceMissing = 0,
1627 VADecodeMBError = 1,
1628 } VADecodeErrorType;
1631 * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
1632 * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
1634 typedef struct _VASurfaceDecodeMBErrors
1636 int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
1637 unsigned int start_mb; /* start mb address with errors */
1638 unsigned int end_mb; /* end mb address with errors */
1639 VADecodeErrorType decode_error_type;
1640 } VASurfaceDecodeMBErrors;
1643 * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
1644 * it can call vaQuerySurfaceError to find out further details on the particular error.
1645 * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
1646 * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
1647 * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
1648 * The array is terminated if "status==-1" is detected.
1650 VAStatus vaQuerySurfaceError(
1652 VASurfaceID surface,
1653 VAStatus error_status,
1658 * Images and Subpictures
1659 * VAImage is used to either get the surface data to client memory, or
1660 * to copy image data in client memory to a surface.
1661 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1662 * is at the upper left corner with positive X to the right and positive Y down
1664 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1665 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1666 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1668 /* a few common FourCCs */
1669 #define VA_FOURCC_NV12 0x3231564E
1670 #define VA_FOURCC_AI44 0x34344149
1671 #define VA_FOURCC_RGBA 0x41424752
1672 #define VA_FOURCC_BGRA 0x41524742
1673 #define VA_FOURCC_UYVY 0x59565955
1674 #define VA_FOURCC_YUY2 0x32595559
1675 #define VA_FOURCC_AYUV 0x56555941
1676 #define VA_FOURCC_NV11 0x3131564e
1677 #define VA_FOURCC_YV12 0x32315659
1678 #define VA_FOURCC_P208 0x38303250
1679 #define VA_FOURCC_IYUV 0x56555949
1682 #define VA_LSB_FIRST 1
1683 #define VA_MSB_FIRST 2
1685 typedef struct _VAImageFormat
1687 unsigned int fourcc;
1688 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1689 unsigned int bits_per_pixel;
1690 /* for RGB formats */
1691 unsigned int depth; /* significant bits per pixel */
1692 unsigned int red_mask;
1693 unsigned int green_mask;
1694 unsigned int blue_mask;
1695 unsigned int alpha_mask;
1698 typedef VAGenericID VAImageID;
1700 typedef struct _VAImage
1702 VAImageID image_id; /* uniquely identify this image */
1703 VAImageFormat format;
1704 VABufferID buf; /* image data buffer */
1706 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1707 * data store on the server side for optimal performance. The buffer will be
1708 * created by the CreateImage function, and proper storage allocated based on the image
1709 * size and format. This buffer is managed by the library implementation, and
1710 * accessed by the client through the buffer Map/Unmap functions.
1712 unsigned short width;
1713 unsigned short height;
1714 unsigned int data_size;
1715 unsigned int num_planes; /* can not be greater than 3 */
1717 * An array indicating the scanline pitch in bytes for each plane.
1718 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1720 unsigned int pitches[3];
1722 * An array indicating the byte offset from the beginning of the image data
1723 * to the start of each plane.
1725 unsigned int offsets[3];
1727 /* The following fields are only needed for paletted formats */
1728 int num_palette_entries; /* set to zero for non-palette images */
1730 * Each component is one byte and entry_bytes indicates the number of components in
1731 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1735 * An array of ascii characters describing the order of the components within the bytes.
1736 * Only entry_bytes characters of the string are used.
1738 char component_order[4];
1741 /* Get maximum number of image formats supported by the implementation */
1742 int vaMaxNumImageFormats (
1747 * Query supported image formats
1748 * The caller must provide a "format_list" array that can hold at
1749 * least vaMaxNumImageFormats() entries. The actual number of formats
1750 * returned in "format_list" is returned in "num_formats".
1752 VAStatus vaQueryImageFormats (
1754 VAImageFormat *format_list, /* out */
1755 int *num_formats /* out */
1759 * Create a VAImage structure
1760 * The width and height fields returned in the VAImage structure may get
1761 * enlarged for some YUV formats. Upon return from this function,
1762 * image->buf has been created and proper storage allocated by the library.
1763 * The client can access the image through the Map/Unmap calls.
1765 VAStatus vaCreateImage (
1767 VAImageFormat *format,
1770 VAImage *image /* out */
1774 * Should call DestroyImage before destroying the surface it is bound to
1776 VAStatus vaDestroyImage (
1781 VAStatus vaSetImagePalette (
1785 * pointer to an array holding the palette data. The size of the array is
1786 * num_palette_entries * entry_bytes in size. The order of the components
1787 * in the palette is described by the component_order in VAImage struct
1789 unsigned char *palette
1793 * Retrive surface data into a VAImage
1794 * Image must be in a format supported by the implementation
1796 VAStatus vaGetImage (
1798 VASurfaceID surface,
1799 int x, /* coordinates of the upper left source pixel */
1801 unsigned int width, /* width and height of the region */
1802 unsigned int height,
1807 * Copy data from a VAImage to a surface
1808 * Image must be in a format supported by the implementation
1809 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1810 * shouldn't be rendered into when this is called
1812 VAStatus vaPutImage (
1814 VASurfaceID surface,
1818 unsigned int src_width,
1819 unsigned int src_height,
1822 unsigned int dest_width,
1823 unsigned int dest_height
1827 * Derive an VAImage from an existing surface.
1828 * This interface will derive a VAImage and corresponding image buffer from
1829 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1830 * direct CPU access. This operation is only possible on implementations with
1831 * direct rendering capabilities and internal surface formats that can be
1832 * represented with a VAImage. When the operation is not possible this interface
1833 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1834 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1837 * Implementations should only return success when the resulting image buffer
1838 * would be useable with vaMap/Unmap.
1840 * When directly accessing a surface special care must be taken to insure
1841 * proper synchronization with the graphics hardware. Clients should call
1842 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1843 * rendering or currently being displayed by an overlay.
1845 * Additionally nothing about the contents of a surface should be assumed
1846 * following a vaPutSurface. Implementations are free to modify the surface for
1847 * scaling or subpicture blending within a call to vaPutImage.
1849 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1850 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1851 * vaGetImage with other surfaces is supported.
1853 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1854 * image and image buffer structures will be destroyed; however, the underlying
1855 * surface will remain unchanged until freed with vaDestroySurfaces.
1857 VAStatus vaDeriveImage (
1859 VASurfaceID surface,
1860 VAImage *image /* out */
1865 * Subpicture is a special type of image that can be blended
1866 * with a surface during vaPutSurface(). Subpicture can be used to render
1867 * DVD sub-titles or closed captioning text etc.
1870 typedef VAGenericID VASubpictureID;
1872 /* Get maximum number of subpicture formats supported by the implementation */
1873 int vaMaxNumSubpictureFormats (
1877 /* flags for subpictures */
1878 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
1879 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
1880 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
1882 * Query supported subpicture formats
1883 * The caller must provide a "format_list" array that can hold at
1884 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1885 * for each format to indicate additional capabilities for that format. The actual
1886 * number of formats returned in "format_list" is returned in "num_formats".
1887 * flags: returned value to indicate addtional capabilities
1888 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1889 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1890 * VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
1893 VAStatus vaQuerySubpictureFormats (
1895 VAImageFormat *format_list, /* out */
1896 unsigned int *flags, /* out */
1897 unsigned int *num_formats /* out */
1901 * Subpictures are created with an image associated.
1903 VAStatus vaCreateSubpicture (
1906 VASubpictureID *subpicture /* out */
1910 * Destroy the subpicture before destroying the image it is assocated to
1912 VAStatus vaDestroySubpicture (
1914 VASubpictureID subpicture
1918 * Bind an image to the subpicture. This image will now be associated with
1919 * the subpicture instead of the one at creation.
1921 VAStatus vaSetSubpictureImage (
1923 VASubpictureID subpicture,
1928 * If chromakey is enabled, then the area where the source value falls within
1929 * the chromakey [min, max] range is transparent
1930 * The chromakey component format is the following:
1931 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
1932 * For YUV: [0:7] V [8:15] U [16:23] Y
1933 * The chromakey mask can be used to mask out certain components for chromakey
1936 VAStatus vaSetSubpictureChromakey (
1938 VASubpictureID subpicture,
1939 unsigned int chromakey_min,
1940 unsigned int chromakey_max,
1941 unsigned int chromakey_mask
1945 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
1946 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
1947 * the overall alpha is per-pixel alpha multiplied by the global alpha
1949 VAStatus vaSetSubpictureGlobalAlpha (
1951 VASubpictureID subpicture,
1956 * vaAssociateSubpicture associates the subpicture with target_surfaces.
1957 * It defines the region mapping between the subpicture and the target
1958 * surfaces through source and destination rectangles (with the same width and height).
1959 * Both will be displayed at the next call to vaPutSurface. Additional
1960 * associations before the call to vaPutSurface simply overrides the association.
1962 VAStatus vaAssociateSubpicture (
1964 VASubpictureID subpicture,
1965 VASurfaceID *target_surfaces,
1967 short src_x, /* upper left offset in subpicture */
1969 unsigned short src_width,
1970 unsigned short src_height,
1971 short dest_x, /* upper left offset in surface */
1973 unsigned short dest_width,
1974 unsigned short dest_height,
1976 * whether to enable chroma-keying, global-alpha, or screen relative mode
1977 * see VA_SUBPICTURE_XXX values
1983 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
1985 VAStatus vaDeassociateSubpicture (
1987 VASubpictureID subpicture,
1988 VASurfaceID *target_surfaces,
1992 typedef struct _VARectangle
1996 unsigned short width;
1997 unsigned short height;
2001 * Display attributes
2002 * Display attributes are used to control things such as contrast, hue, saturation,
2003 * brightness etc. in the rendering process. The application can query what
2004 * attributes are supported by the driver, and then set the appropriate attributes
2005 * before calling vaPutSurface()
2007 /* PowerVR IEP Lite attributes */
2010 VADISPLAYATTRIB_BLE_OFF = 0x00,
2011 VADISPLAYATTRIB_BLE_LOW,
2012 VADISPLAYATTRIB_BLE_MEDIUM,
2013 VADISPLAYATTRIB_BLE_HIGH,
2014 VADISPLAYATTRIB_BLE_NONE,
2015 } VADisplayAttribBLEMode;
2017 /* attribute value for VADisplayAttribRotation */
2018 #define VA_ROTATION_NONE 0x00000000
2019 #define VA_ROTATION_90 0x00000001
2020 #define VA_ROTATION_180 0x00000002
2021 #define VA_ROTATION_270 0x00000003
2023 /* attribute value for VADisplayAttribOutOfLoopDeblock */
2024 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
2025 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
2028 #define VA_RENDER_MODE_UNDEFINED 0
2029 #define VA_RENDER_MODE_LOCAL_OVERLAY 1
2030 #define VA_RENDER_MODE_LOCAL_GPU 2
2031 #define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
2032 #define VA_RENDER_MODE_EXTERNAL_GPU 8
2035 #define VA_RENDER_DEVICE_UNDEFINED 0
2036 #define VA_RENDER_DEVICE_LOCAL 1
2037 #define VA_RENDER_DEVICE_EXTERNAL 2
2039 /* Currently defined display attribute types */
2042 VADisplayAttribBrightness = 0,
2043 VADisplayAttribContrast = 1,
2044 VADisplayAttribHue = 2,
2045 VADisplayAttribSaturation = 3,
2046 /* client can specifiy a background color for the target window
2047 * the new feature of video conference,
2048 * the uncovered area of the surface is filled by this color
2049 * also it will blend with the decoded video color
2051 VADisplayAttribBackgroundColor = 4,
2053 * this is a gettable only attribute. For some implementations that use the
2054 * hardware overlay, after PutSurface is called, the surface can not be
2055 * re-used until after the subsequent PutSurface call. If this is the case
2056 * then the value for this attribute will be set to 1 so that the client
2057 * will not attempt to re-use the surface right after returning from a call
2060 * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
2061 * driver may use overlay or GPU alternatively
2063 VADisplayAttribDirectSurface = 5,
2064 VADisplayAttribRotation = 6,
2065 VADisplayAttribOutofLoopDeblock = 7,
2067 /* PowerVR IEP Lite specific attributes */
2068 VADisplayAttribBLEBlackMode = 8,
2069 VADisplayAttribBLEWhiteMode = 9,
2070 VADisplayAttribBlueStretch = 10,
2071 VADisplayAttribSkinColorCorrection = 11,
2073 * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
2074 * conversion matrix. Each element in the matrix is float-point
2076 VADisplayAttribCSCMatrix = 12,
2077 /* specify the constant color used to blend with video surface
2078 * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
2079 * d: the final color to overwrite into the frame buffer
2080 * v: decoded video after color conversion,
2081 * c: video color specified by VADisplayAttribBlendColor
2082 * b: background color of the drawable
2084 VADisplayAttribBlendColor = 13,
2086 * Indicate driver to skip painting color key or not.
2087 * only applicable if the render is overlay
2089 VADisplayAttribOverlayAutoPaintColorKey = 14,
2091 * customized overlay color key, the format is RGB888
2092 * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
2094 VADisplayAttribOverlayColorKey = 15,
2096 * The hint for the implementation of vaPutSurface
2097 * normally, the driver could use an overlay or GPU to render the surface on the screen
2098 * this flag provides APP the flexibity to switch the render dynamically
2100 VADisplayAttribRenderMode = 16,
2102 * specify if vaPutSurface needs to render into specified monitors
2103 * one example is that one external monitor (e.g. HDMI) is enabled,
2104 * but the window manager is not aware of it, and there is no associated drawable
2106 VADisplayAttribRenderDevice = 17,
2108 * specify vaPutSurface render area if there is no drawable on the monitor
2110 VADisplayAttribRenderRect = 18,
2111 } VADisplayAttribType;
2113 /* flags for VADisplayAttribute */
2114 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
2115 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
2116 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
2118 typedef struct _VADisplayAttribute
2120 VADisplayAttribType type;
2123 int value; /* used by the set/get attribute functions */
2124 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
2126 } VADisplayAttribute;
2128 /* Get maximum number of display attributs supported by the implementation */
2129 int vaMaxNumDisplayAttributes (
2134 * Query display attributes
2135 * The caller must provide a "attr_list" array that can hold at
2136 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
2137 * returned in "attr_list" is returned in "num_attributes".
2139 VAStatus vaQueryDisplayAttributes (
2141 VADisplayAttribute *attr_list, /* out */
2142 int *num_attributes /* out */
2146 * Get display attributes
2147 * This function returns the current attribute values in "attr_list".
2148 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
2149 * from vaQueryDisplayAttributes() can have their values retrieved.
2151 VAStatus vaGetDisplayAttributes (
2153 VADisplayAttribute *attr_list, /* in/out */
2158 * Set display attributes
2159 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
2160 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
2161 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
2163 VAStatus vaSetDisplayAttributes (
2165 VADisplayAttribute *attr_list,