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
62 * Some concepts borrowed from XvMC and XvImage.
63 * Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
64 * contributed to various aspects of the API.
70 #include <va/va_version.h>
79 The VA API is intended to provide an interface between a video decode/encode/display
80 application (client) and a hardware accelerator (server), to off-load
81 video decode/encode/display operations from the host to the hardware accelerator at various
84 The basic operation steps are:
86 - Negotiate a mutually acceptable configuration with the server to lock
87 down profile, entrypoints, and other attributes that will not change on
88 a frame-by-frame basis.
89 - Create a decode context which represents a "virtualized" hardware decode
91 - Get and fill decode buffers with picture level, slice level and macroblock
92 level data (depending on entrypoints)
93 - Pass the decode buffers to the server to decode the current frame
95 Initialization & Configuration Management
97 - Find out supported profiles
98 - Find out entrypoints for a given profile
99 - Find out configuration attributes for a given profile/entrypoint pair
100 - Create a configuration for use by the decoder
104 typedef void* VADisplay; /* window system dependent */
106 typedef int VAStatus; /* Return status type from functions */
107 /* Values for the return status */
108 #define VA_STATUS_SUCCESS 0x00000000
109 #define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
110 #define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
111 #define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
112 #define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
113 #define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
114 #define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
115 #define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
116 #define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
117 #define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
118 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
119 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
120 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
121 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
122 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
123 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
124 #define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
125 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
126 #define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
127 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
128 #define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
129 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
130 #define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
132 /* De-interlacing flags for vaPutSurface() */
133 #define VA_FRAME_PICTURE 0x00000000
134 #define VA_TOP_FIELD 0x00000001
135 #define VA_BOTTOM_FIELD 0x00000002
138 * Clears the drawable with background color.
139 * for hardware overlay based implementation this flag
140 * can be used to turn off the overlay
142 #define VA_CLEAR_DRAWABLE 0x00000008
144 /* Color space conversion flags for vaPutSurface() */
145 #define VA_SRC_BT601 0x00000010
146 #define VA_SRC_BT709 0x00000020
149 * Returns a short english description of error_status
151 const char *vaErrorStr(VAStatus error_status);
155 * A display must be obtained by calling vaGetDisplay() before calling
156 * vaInitialize() and other functions. This connects the API to the
157 * native window system.
158 * For X Windows, native_dpy would be from XOpenDisplay()
160 typedef void* NativeDisplay; /* window system dependent */
163 * Initialize the library
165 VAStatus vaInitialize (
167 int *major_version, /* out */
168 int *minor_version /* out */
172 * After this call, all library internal resources will be cleaned up
174 VAStatus vaTerminate (
179 * vaQueryVendorString returns a pointer to a zero-terminated string
180 * describing some aspects of the VA implemenation on a specific
181 * hardware accelerator. The format of the returned string is vendor
182 * specific and at the discretion of the implementer.
183 * e.g. for the Intel GMA500 implementation, an example would be:
184 * "Intel GMA500 - 2.0.0.32L.0005"
186 const char *vaQueryVendorString (
190 typedef int (*VAPrivFunc)();
193 * Return a function pointer given a function name in the library.
194 * This allows private interfaces into the library
196 VAPrivFunc vaGetLibFunc (
201 /* Currently defined profiles */
204 VAProfileMPEG2Simple = 0,
205 VAProfileMPEG2Main = 1,
206 VAProfileMPEG4Simple = 2,
207 VAProfileMPEG4AdvancedSimple = 3,
208 VAProfileMPEG4Main = 4,
209 VAProfileH264Baseline = 5,
210 VAProfileH264Main = 6,
211 VAProfileH264High = 7,
212 VAProfileVC1Simple = 8,
213 VAProfileVC1Main = 9,
214 VAProfileVC1Advanced = 10,
215 VAProfileH263Baseline = 11,
216 VAProfileJPEGBaseline = 12
220 * Currently defined entrypoints
226 VAEntrypointIDCT = 3,
227 VAEntrypointMoComp = 4,
228 VAEntrypointDeblocking = 5,
229 VAEntrypointEncSlice = 6, /* slice level encode */
230 VAEntrypointEncPicture = 7 /* pictuer encode, JPEG, etc */
233 /* Currently defined configuration attribute types */
236 VAConfigAttribRTFormat = 0,
237 VAConfigAttribSpatialResidual = 1,
238 VAConfigAttribSpatialClipping = 2,
239 VAConfigAttribIntraResidual = 3,
240 VAConfigAttribEncryption = 4,
241 VAConfigAttribRateControl = 5
242 } VAConfigAttribType;
245 * Configuration attributes
246 * If there is more than one value for an attribute, a default
247 * value will be assigned to the attribute if the client does not
248 * specify the attribute when creating a configuration
250 typedef struct _VAConfigAttrib {
251 VAConfigAttribType type;
252 unsigned int value; /* OR'd flags (bits) for this attribute */
255 /* attribute value for VAConfigAttribRTFormat */
256 #define VA_RT_FORMAT_YUV420 0x00000001
257 #define VA_RT_FORMAT_YUV422 0x00000002
258 #define VA_RT_FORMAT_YUV444 0x00000004
259 #define VA_RT_FORMAT_PROTECTED 0x80000000
261 /* attribute value for VAConfigAttribRateControl */
262 #define VA_RC_NONE 0x00000001
263 #define VA_RC_CBR 0x00000002
264 #define VA_RC_VBR 0x00000004
267 * if an attribute is not applicable for a given
268 * profile/entrypoint pair, then set the value to the following
270 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
272 /* Get maximum number of profiles supported by the implementation */
273 int vaMaxNumProfiles (
277 /* Get maximum number of entrypoints supported by the implementation */
278 int vaMaxNumEntrypoints (
282 /* Get maximum number of attributs supported by the implementation */
283 int vaMaxNumConfigAttributes (
288 * Query supported profiles
289 * The caller must provide a "profile_list" array that can hold at
290 * least vaMaxNumProfile() entries. The actual number of profiles
291 * returned in "profile_list" is returned in "num_profile".
293 VAStatus vaQueryConfigProfiles (
295 VAProfile *profile_list, /* out */
296 int *num_profiles /* out */
300 * Query supported entrypoints for a given profile
301 * The caller must provide an "entrypoint_list" array that can hold at
302 * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
303 * returned in "entrypoint_list" is returned in "num_entrypoints".
305 VAStatus vaQueryConfigEntrypoints (
308 VAEntrypoint *entrypoint_list, /* out */
309 int *num_entrypoints /* out */
313 * Get attributes for a given profile/entrypoint pair
314 * The caller must provide an "attrib_list" with all attributes to be
315 * retrieved. Upon return, the attributes in "attrib_list" have been
316 * updated with their value. Unknown attributes or attributes that are
317 * not supported for the given profile/entrypoint pair will have their
318 * value set to VA_ATTRIB_NOT_SUPPORTED
320 VAStatus vaGetConfigAttributes (
323 VAEntrypoint entrypoint,
324 VAConfigAttrib *attrib_list, /* in/out */
328 /* Generic ID type, can be re-typed for specific implementation */
329 typedef unsigned int VAGenericID;
331 typedef VAGenericID VAConfigID;
334 * Create a configuration for the decode pipeline
335 * it passes in the attribute list that specifies the attributes it cares
336 * about, with the rest taking default values.
338 VAStatus vaCreateConfig (
341 VAEntrypoint entrypoint,
342 VAConfigAttrib *attrib_list,
344 VAConfigID *config_id /* out */
348 * Free resources associdated with a given config
350 VAStatus vaDestroyConfig (
356 * Query all attributes for a given configuration
357 * The profile of the configuration is returned in "profile"
358 * The entrypoint of the configuration is returned in "entrypoint"
359 * The caller must provide an "attrib_list" array that can hold at least
360 * vaMaxNumConfigAttributes() entries. The actual number of attributes
361 * returned in "attrib_list" is returned in "num_attribs"
363 VAStatus vaQueryConfigAttributes (
365 VAConfigID config_id,
366 VAProfile *profile, /* out */
367 VAEntrypoint *entrypoint, /* out */
368 VAConfigAttrib *attrib_list,/* out */
369 int *num_attribs /* out */
374 * Contexts and Surfaces
376 * Context represents a "virtual" video decode pipeline. Surfaces are render
377 * targets for a given context. The data in the surfaces are not accessible
378 * to the client and the internal data format of the surface is implementatin
381 * Surfaces will be bound to a context when the context is created. Once
382 * a surface is bound to a given context, it can not be used to create
383 * another context. The association is removed when the context is destroyed
385 * Both contexts and surfaces are identified by unique IDs and its
386 * implementation specific internals are kept opaque to the clients
389 typedef VAGenericID VAContextID;
391 typedef VAGenericID VASurfaceID;
393 #define VA_INVALID_ID 0xffffffff
394 #define VA_INVALID_SURFACE VA_INVALID_ID
397 * vaCreateSurfaces - Create an array of surfaces used for decode and display
399 * width: surface width
400 * height: surface height
401 * format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
402 * num_surfaces: number of surfaces to be created
403 * surfaces: array of surfaces created upon return
405 VAStatus vaCreateSurfaces (
411 VASurfaceID *surfaces /* out */
414 /* Wrap a CI (camera imaging) frame as a VA surface to share captured video between camear
415 * and VA encode. With frame_id, VA driver need to call CI interfaces to get the information
416 * of the frame, and to determine if the frame can be wrapped as a VA surface
418 * Application should make sure the frame is idle before the frame is passed into VA stack
419 * and also a vaSyncSurface should be called before application tries to access the frame
422 VAStatus vaCreateSurfaceFromCIFrame (
424 unsigned long frame_id,
425 VASurfaceID *surface /* out */
430 * vaDestroySurfaces - Destroy resources associated with surfaces.
431 * Surfaces can only be destroyed after the context associated has been
434 * surfaces: array of surfaces to destroy
435 * num_surfaces: number of surfaces in the array to be destroyed.
437 VAStatus vaDestroySurfaces (
439 VASurfaceID *surfaces,
443 #define VA_PROGRESSIVE 0x1
445 * vaCreateContext - Create a context
447 * config_id: configuration for the context
448 * picture_width: coded picture width
449 * picture_height: coded picture height
450 * flag: any combination of the following:
451 * VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
452 * render_targets: render targets (surfaces) tied to the context
453 * num_render_targets: number of render targets in the above array
454 * context: created context id upon return
456 VAStatus vaCreateContext (
458 VAConfigID config_id,
462 VASurfaceID *render_targets,
463 int num_render_targets,
464 VAContextID *context /* out */
468 * vaDestroyContext - Destroy a context
470 * context: context to be destroyed
472 VAStatus vaDestroyContext (
479 * Buffers are used to pass various types of data from the
480 * client to the server. The server maintains a data store
481 * for each buffer created, and the client idenfies a buffer
482 * through a unique buffer id assigned by the server.
485 typedef VAGenericID VABufferID;
489 VAPictureParameterBufferType = 0,
490 VAIQMatrixBufferType = 1,
491 VABitPlaneBufferType = 2,
492 VASliceGroupMapBufferType = 3,
493 VASliceParameterBufferType = 4,
494 VASliceDataBufferType = 5,
495 VAMacroblockParameterBufferType = 6,
496 VAResidualDataBufferType = 7,
497 VADeblockingParameterBufferType = 8,
498 VAImageBufferType = 9,
499 VAProtectedSliceDataBufferType = 10,
500 VAQMatrixBufferType = 11,
501 /* Following are encode buffer types */
502 VAEncCodedBufferType = 21,
503 VAEncSequenceParameterBufferType = 22,
504 VAEncPictureParameterBufferType = 23,
505 VAEncSliceParameterBufferType = 24,
506 VAEncH264VUIBufferType = 25,
507 VAEncH264SEIBufferType = 26,
512 * There will be cases where the bitstream buffer will not have enough room to hold
513 * the data for the entire slice, and the following flags will be used in the slice
514 * parameter to signal to the server for the possible cases.
515 * If a slice parameter buffer and slice data buffer pair is sent to the server with
516 * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
517 * then a slice parameter and data buffer needs to be sent again to complete this slice.
519 #define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
520 #define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
521 #define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
522 #define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
524 /* Codec-independent Slice Parameter Buffer base */
525 typedef struct _VASliceParameterBufferBase
527 unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
528 unsigned int slice_data_offset; /* the offset to the first byte of slice data */
529 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
530 } VASliceParameterBufferBase;
533 /****************************
534 * JEPG data structure
535 ***************************/
536 typedef struct _VAQMatrixBufferJPEG
538 int load_lum_quantiser_matrix;
539 int load_chroma_quantiser_matrix;
540 unsigned char lum_quantiser_matrix[64];
541 unsigned char chroma_quantiser_matrix[64];
542 } VAQMatrixBufferJPEG;
544 typedef struct _VAEncPictureParameterBufferJPEG
546 VASurfaceID reconstructed_picture;
547 unsigned short picture_width;
548 unsigned short picture_height;
549 VABufferID coded_buf;
550 } VAEncPictureParameterBufferJPEG;
553 /****************************
554 * MPEG-2 data structures
555 ****************************/
557 /* MPEG-2 Picture Parameter Buffer */
559 * For each frame or field, and before any slice data, a single
560 * picture parameter buffer must be send.
562 typedef struct _VAPictureParameterBufferMPEG2
564 unsigned short horizontal_size;
565 unsigned short vertical_size;
566 VASurfaceID forward_reference_picture;
567 VASurfaceID backward_reference_picture;
568 /* meanings of the following fields are the same as in the standard */
569 int picture_coding_type;
570 int f_code; /* pack all four fcode into this */
573 unsigned int intra_dc_precision : 2;
574 unsigned int picture_structure : 2;
575 unsigned int top_field_first : 1;
576 unsigned int frame_pred_frame_dct : 1;
577 unsigned int concealment_motion_vectors : 1;
578 unsigned int q_scale_type : 1;
579 unsigned int intra_vlc_format : 1;
580 unsigned int alternate_scan : 1;
581 unsigned int repeat_first_field : 1;
582 unsigned int progressive_frame : 1;
583 unsigned int is_first_field : 1; /* indicate whether the current field
584 * is the first field for field picture
588 } picture_coding_extension;
589 } VAPictureParameterBufferMPEG2;
591 /* MPEG-2 Inverse Quantization Matrix Buffer */
592 typedef struct _VAIQMatrixBufferMPEG2
594 int load_intra_quantiser_matrix;
595 int load_non_intra_quantiser_matrix;
596 int load_chroma_intra_quantiser_matrix;
597 int load_chroma_non_intra_quantiser_matrix;
598 unsigned char intra_quantiser_matrix[64];
599 unsigned char non_intra_quantiser_matrix[64];
600 unsigned char chroma_intra_quantiser_matrix[64];
601 unsigned char chroma_non_intra_quantiser_matrix[64];
602 } VAIQMatrixBufferMPEG2;
604 /* MPEG-2 Slice Parameter Buffer */
605 typedef struct _VASliceParameterBufferMPEG2
607 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
608 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
609 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
610 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
611 unsigned int slice_horizontal_position;
612 unsigned int slice_vertical_position;
613 int quantiser_scale_code;
614 int intra_slice_flag;
615 } VASliceParameterBufferMPEG2;
617 /* MPEG-2 Macroblock Parameter Buffer */
618 typedef struct _VAMacroblockParameterBufferMPEG2
620 unsigned short macroblock_address;
622 * macroblock_address (in raster scan order)
624 * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
626 unsigned char macroblock_type; /* see definition below */
629 unsigned int frame_motion_type : 2;
630 unsigned int field_motion_type : 2;
631 unsigned int dct_type : 1;
635 unsigned char motion_vertical_field_select;
637 * motion_vertical_field_select:
638 * see section 6.3.17.2 in the spec
639 * only the lower 4 bits are used
640 * bit 0: first vector forward
641 * bit 1: first vector backward
642 * bit 2: second vector forward
643 * bit 3: second vector backward
645 short PMV[2][2][2]; /* see Table 7-7 in the spec */
646 unsigned short coded_block_pattern;
648 * The bitplanes for coded_block_pattern are described
649 * in Figure 6.10-12 in the spec
652 /* Number of skipped macroblocks after this macroblock */
653 unsigned short num_skipped_macroblocks;
654 } VAMacroblockParameterBufferMPEG2;
657 * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
659 #define VA_MB_TYPE_MOTION_FORWARD 0x02
660 #define VA_MB_TYPE_MOTION_BACKWARD 0x04
661 #define VA_MB_TYPE_MOTION_PATTERN 0x08
662 #define VA_MB_TYPE_MOTION_INTRA 0x10
665 * MPEG-2 Residual Data Buffer
666 * For each macroblock, there wil be 64 shorts (16-bit) in the
667 * residual data buffer
670 /****************************
671 * MPEG-4 Part 2 data structures
672 ****************************/
674 /* MPEG-4 Picture Parameter Buffer */
676 * For each frame or field, and before any slice data, a single
677 * picture parameter buffer must be send.
679 typedef struct _VAPictureParameterBufferMPEG4
681 unsigned short vop_width;
682 unsigned short vop_height;
683 VASurfaceID forward_reference_picture;
684 VASurfaceID backward_reference_picture;
687 unsigned int short_video_header : 1;
688 unsigned int chroma_format : 2;
689 unsigned int interlaced : 1;
690 unsigned int obmc_disable : 1;
691 unsigned int sprite_enable : 2;
692 unsigned int sprite_warping_accuracy : 2;
693 unsigned int quant_type : 1;
694 unsigned int quarter_sample : 1;
695 unsigned int data_partitioned : 1;
696 unsigned int reversible_vlc : 1;
697 unsigned int resync_marker_disable : 1;
701 unsigned char no_of_sprite_warping_points;
702 short sprite_trajectory_du[3];
703 short sprite_trajectory_dv[3];
704 unsigned char quant_precision;
707 unsigned int vop_coding_type : 2;
708 unsigned int backward_reference_vop_coding_type : 2;
709 unsigned int vop_rounding_type : 1;
710 unsigned int intra_dc_vlc_thr : 3;
711 unsigned int top_field_first : 1;
712 unsigned int alternate_vertical_scan_flag : 1;
716 unsigned char vop_fcode_forward;
717 unsigned char vop_fcode_backward;
718 unsigned short vop_time_increment_resolution;
719 /* short header related */
720 unsigned char num_gobs_in_vop;
721 unsigned char num_macroblocks_in_gob;
722 /* for direct mode prediction */
725 } VAPictureParameterBufferMPEG4;
727 /* MPEG-4 Inverse Quantization Matrix Buffer */
728 typedef struct _VAIQMatrixBufferMPEG4
730 int load_intra_quant_mat;
731 int load_non_intra_quant_mat;
732 unsigned char intra_quant_mat[64];
733 unsigned char non_intra_quant_mat[64];
734 } VAIQMatrixBufferMPEG4;
736 /* MPEG-4 Slice Parameter Buffer */
737 typedef struct _VASliceParameterBufferMPEG4
739 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
740 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
741 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
742 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
743 unsigned int macroblock_number;
745 } VASliceParameterBufferMPEG4;
751 typedef enum /* see 7.1.1.32 */
754 VAMvMode1MvHalfPel = 1,
755 VAMvMode1MvHalfPelBilinear = 2,
757 VAMvModeIntensityCompensation = 4
760 /* VC-1 Picture Parameter Buffer */
762 * For each picture, and before any slice data, a picture parameter
763 * buffer must be send. Multiple picture parameter buffers may be
764 * sent for a single picture. In that case picture parameters will
765 * apply to all slice data that follow it until a new picture
766 * parameter buffer is sent.
769 * pic_quantizer_type should be set to the applicable quantizer
770 * type as defined by QUANTIZER (J.1.19) and either
771 * PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
773 typedef struct _VAPictureParameterBufferVC1
775 VASurfaceID forward_reference_picture;
776 VASurfaceID backward_reference_picture;
777 /* if out-of-loop post-processing is done on the render
778 target, then we need to keep the in-loop decoded
779 picture as a reference picture */
780 VASurfaceID inloop_decoded_picture;
782 /* sequence layer for AP or meta data for SP and MP */
785 unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
786 unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
787 unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
788 unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
789 unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
790 unsigned int multires : 1; /* METADATA::MULTIRES */
791 unsigned int overlap : 1; /* METADATA::OVERLAP */
792 unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
793 unsigned int rangered : 1; /* METADATA::RANGERED */
794 unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
799 unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
800 unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
803 unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
804 unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
805 unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
806 unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
810 unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
811 unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
814 unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
815 unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
816 unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
817 unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
820 } range_mapping_fields;
822 unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
823 unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
824 unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
825 unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
826 unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
827 unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
828 unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
829 unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
830 unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
833 unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
834 unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
835 unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
836 unsigned int is_first_field : 1; /* set to 1 if it is the first field */
837 unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
843 unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
844 unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
845 unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
846 unsigned int field_tx : 1; /* PICTURE::FIELDTX */
847 unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
848 unsigned int ac_pred : 1; /* PICTURE::ACPRED */
849 unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
855 unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
856 unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
857 unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
858 unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
859 unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
860 unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
861 unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
864 } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
867 unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
868 unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
869 unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
870 unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
876 unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
877 unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
878 unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
879 unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
880 unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
881 unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
882 unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
883 unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
884 unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
885 unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
891 unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
892 unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
893 unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
894 unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
895 unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
896 unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
897 unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
898 unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
899 unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
900 unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
901 unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
904 } pic_quantizer_fields;
907 unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
908 unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
909 unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
910 unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
911 unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
912 unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
916 } VAPictureParameterBufferVC1;
918 /* VC-1 Bitplane Buffer
919 There will be at most three bitplanes coded in any picture header. To send
920 the bitplane data more efficiently, each byte is divided in two nibbles, with
921 each nibble carrying three bitplanes for one macroblock. The following table
922 shows the bitplane data arrangement within each nibble based on the picture
925 Picture Type Bit3 Bit2 Bit1 Bit0
926 I or BI OVERFLAGS ACPRED FIELDTX
927 P MYTYPEMB SKIPMB DIRECTMB
928 B FORWARDMB SKIPMB DIRECTMB
930 Within each byte, the lower nibble is for the first MB and the upper nibble is
931 for the second MB. E.g. the lower nibble of the first byte in the bitplane
932 buffer is for Macroblock #1 and the upper nibble of the first byte is for
933 Macroblock #2 in the first row.
936 /* VC-1 Slice Parameter Buffer */
937 typedef struct _VASliceParameterBufferVC1
939 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
940 unsigned int slice_data_offset;/* the offset to the first byte of slice data */
941 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
942 unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
943 unsigned int slice_vertical_position;
944 } VASliceParameterBufferVC1;
946 /* VC-1 Slice Data Buffer */
948 This is simplely a buffer containing raw bit-stream bytes
951 /****************************
952 * H.264/AVC data structures
953 ****************************/
955 typedef struct _VAPictureH264
957 VASurfaceID picture_id;
958 unsigned int frame_idx;
960 unsigned int TopFieldOrderCnt;
961 unsigned int BottomFieldOrderCnt;
963 /* flags in VAPictureH264 could be OR of the following */
964 #define VA_PICTURE_H264_INVALID 0x00000001
965 #define VA_PICTURE_H264_TOP_FIELD 0x00000002
966 #define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
967 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
968 #define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
970 /* H.264 Picture Parameter Buffer */
972 * For each picture, and before any slice data, a single
973 * picture parameter buffer must be send.
975 typedef struct _VAPictureParameterBufferH264
977 VAPictureH264 CurrPic;
978 VAPictureH264 ReferenceFrames[16]; /* in DPB */
979 unsigned short picture_width_in_mbs_minus1;
980 unsigned short picture_height_in_mbs_minus1;
981 unsigned char bit_depth_luma_minus8;
982 unsigned char bit_depth_chroma_minus8;
983 unsigned char num_ref_frames;
986 unsigned int chroma_format_idc : 2;
987 unsigned int residual_colour_transform_flag : 1;
988 unsigned int gaps_in_frame_num_value_allowed_flag : 1;
989 unsigned int frame_mbs_only_flag : 1;
990 unsigned int mb_adaptive_frame_field_flag : 1;
991 unsigned int direct_8x8_inference_flag : 1;
992 unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
993 unsigned int log2_max_frame_num_minus4 : 4;
994 unsigned int pic_order_cnt_type : 2;
995 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
996 unsigned int delta_pic_order_always_zero_flag : 1;
1000 unsigned char num_slice_groups_minus1;
1001 unsigned char slice_group_map_type;
1002 unsigned short slice_group_change_rate_minus1;
1003 signed char pic_init_qp_minus26;
1004 signed char pic_init_qs_minus26;
1005 signed char chroma_qp_index_offset;
1006 signed char second_chroma_qp_index_offset;
1009 unsigned int entropy_coding_mode_flag : 1;
1010 unsigned int weighted_pred_flag : 1;
1011 unsigned int weighted_bipred_idc : 2;
1012 unsigned int transform_8x8_mode_flag : 1;
1013 unsigned int field_pic_flag : 1;
1014 unsigned int constrained_intra_pred_flag : 1;
1015 unsigned int pic_order_present_flag : 1;
1016 unsigned int deblocking_filter_control_present_flag : 1;
1017 unsigned int redundant_pic_cnt_present_flag : 1;
1018 unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
1022 unsigned short frame_num;
1023 } VAPictureParameterBufferH264;
1025 /* H.264 Inverse Quantization Matrix Buffer */
1026 typedef struct _VAIQMatrixBufferH264
1028 unsigned char ScalingList4x4[6][16];
1029 unsigned char ScalingList8x8[2][64];
1030 } VAIQMatrixBufferH264;
1033 * H.264 Slice Group Map Buffer
1034 * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
1035 * A slice group map buffer should be sent for each picture if required. The buffer
1036 * is sent only when there is a change in the mapping values.
1037 * The slice group map buffer map "map units" to slice groups as specified in
1038 * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
1039 * in raster scan order
1042 /* H.264 Slice Parameter Buffer */
1043 typedef struct _VASliceParameterBufferH264
1045 unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
1046 unsigned int slice_data_offset;/* the offset to the NAL start code for this slice */
1047 unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
1048 unsigned short slice_data_bit_offset; /* bit offset from NAL start code to the beginning of slice data */
1049 unsigned short first_mb_in_slice;
1050 unsigned char slice_type;
1051 unsigned char direct_spatial_mv_pred_flag;
1052 unsigned char num_ref_idx_l0_active_minus1;
1053 unsigned char num_ref_idx_l1_active_minus1;
1054 unsigned char cabac_init_idc;
1055 char slice_qp_delta;
1056 unsigned char disable_deblocking_filter_idc;
1057 char slice_alpha_c0_offset_div2;
1058 char slice_beta_offset_div2;
1059 VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
1060 VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
1061 unsigned char luma_log2_weight_denom;
1062 unsigned char chroma_log2_weight_denom;
1063 unsigned char luma_weight_l0_flag;
1064 short luma_weight_l0[32];
1065 short luma_offset_l0[32];
1066 unsigned char chroma_weight_l0_flag;
1067 short chroma_weight_l0[32][2];
1068 short chroma_offset_l0[32][2];
1069 unsigned char luma_weight_l1_flag;
1070 short luma_weight_l1[32];
1071 short luma_offset_l1[32];
1072 unsigned char chroma_weight_l1_flag;
1073 short chroma_weight_l1[32][2];
1074 short chroma_offset_l1[32][2];
1075 } VASliceParameterBufferH264;
1077 /****************************
1078 * Common encode data structures
1079 ****************************/
1082 VAEncPictureTypeIntra = 0,
1083 VAEncPictureTypePredictive = 1,
1084 VAEncPictureTypeBidirectional = 2,
1087 /* Encode Slice Parameter Buffer */
1088 typedef struct _VAEncSliceParameterBuffer
1090 unsigned int start_row_number; /* starting MB row number for this slice */
1091 unsigned int slice_height; /* slice height measured in MB */
1094 unsigned int is_intra : 1;
1095 unsigned int disable_deblocking_filter_idc : 2;
1099 } VAEncSliceParameterBuffer;
1101 /****************************
1102 * H.264 specific encode data structures
1103 ****************************/
1105 typedef struct _VAEncSequenceParameterBufferH264
1107 unsigned char seq_parameter_set_id;
1108 unsigned char level_idc;
1109 unsigned int intra_period;
1110 unsigned int picture_width_in_mbs;
1111 unsigned int picture_height_in_mbs;
1112 unsigned int bits_per_second;
1113 unsigned int frame_rate;
1114 unsigned int initial_qp;
1115 unsigned int min_qp;
1116 unsigned int basic_unit_size;
1117 unsigned char vui_flag;
1118 } VAEncSequenceParameterBufferH264;
1120 typedef struct _VAEncPictureParameterBufferH264
1122 VASurfaceID reference_picture;
1123 VASurfaceID reconstructed_picture;
1124 VABufferID coded_buf;
1125 unsigned short picture_width;
1126 unsigned short picture_height;
1127 unsigned char last_picture; /* if set to 1 it indicates the last picture in the sequence */
1128 } VAEncPictureParameterBufferH264;
1130 /****************************
1131 * H.263 specific encode data structures
1132 ****************************/
1134 typedef struct _VAEncSequenceParameterBufferH263
1136 unsigned int intra_period;
1137 unsigned int bits_per_second;
1138 unsigned int frame_rate;
1139 unsigned int initial_qp;
1140 unsigned int min_qp;
1141 } VAEncSequenceParameterBufferH263;
1143 typedef struct _VAEncPictureParameterBufferH263
1145 VASurfaceID reference_picture;
1146 VASurfaceID reconstructed_picture;
1147 VABufferID coded_buf;
1148 unsigned short picture_width;
1149 unsigned short picture_height;
1150 VAEncPictureType picture_type;
1151 } VAEncPictureParameterBufferH263;
1153 /****************************
1154 * MPEG-4 specific encode data structures
1155 ****************************/
1157 typedef struct _VAEncSequenceParameterBufferMPEG4
1159 unsigned char profile_and_level_indication;
1160 unsigned int intra_period;
1161 unsigned int video_object_layer_width;
1162 unsigned int video_object_layer_height;
1163 unsigned int vop_time_increment_resolution;
1164 unsigned int fixed_vop_rate;
1165 unsigned int fixed_vop_time_increment;
1166 unsigned int bits_per_second;
1167 unsigned int frame_rate;
1168 unsigned int initial_qp;
1169 unsigned int min_qp;
1170 } VAEncSequenceParameterBufferMPEG4;
1172 typedef struct _VAEncPictureParameterBufferMPEG4
1174 VASurfaceID reference_picture;
1175 VASurfaceID reconstructed_picture;
1176 VABufferID coded_buf;
1177 unsigned short picture_width;
1178 unsigned short picture_height;
1179 unsigned int modulo_time_base; /* number of 1s */
1180 unsigned int vop_time_increment;
1181 VAEncPictureType picture_type;
1182 } VAEncPictureParameterBufferMPEG4;
1186 /* Buffer functions */
1189 * Creates a buffer for "num_elements" elements of "size" bytes and
1190 * initalize with "data".
1191 * if "data" is null, then the contents of the buffer data store
1193 * Basically there are two ways to get buffer data to the server side. One is
1194 * to call vaCreateBuffer() with a non-null "data", which results the data being
1195 * copied to the data store on the server side. A different method that
1196 * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1197 * and then use vaMapBuffer() to map the data store from the server side to the
1198 * client address space for access.
1199 * Note: image buffers are created by the library, not the client. Please see
1200 * vaCreateImage on how image buffers are managed.
1202 VAStatus vaCreateBuffer (
1204 VAContextID context,
1205 VABufferType type, /* in */
1206 unsigned int size, /* in */
1207 unsigned int num_elements, /* in */
1208 void *data, /* in */
1209 VABufferID *buf_id /* out */
1213 * Convey to the server how many valid elements are in the buffer.
1214 * e.g. if multiple slice parameters are being held in a single buffer,
1215 * this will communicate to the server the number of slice parameters
1216 * that are valid in the buffer.
1218 VAStatus vaBufferSetNumElements (
1220 VABufferID buf_id, /* in */
1221 unsigned int num_elements /* in */
1225 * Map data store of the buffer into the client's address space
1226 * vaCreateBuffer() needs to be called with "data" set to NULL before
1227 * calling vaMapBuffer()
1229 VAStatus vaMapBuffer (
1231 VABufferID buf_id, /* in */
1232 void **pbuf /* out */
1236 * After client making changes to a mapped data store, it needs to
1237 * "Unmap" it to let the server know that the data is ready to be
1238 * consumed by the server
1240 VAStatus vaUnmapBuffer (
1242 VABufferID buf_id /* in */
1246 * After this call, the buffer is deleted and this buffer_id is no longer valid
1247 * Only call this if the buffer is not going to be passed to vaRenderBuffer
1249 VAStatus vaDestroyBuffer (
1251 VABufferID buffer_id
1255 Render (Decode) Pictures
1257 A picture represents either a frame or a field.
1259 The Begin/Render/End sequence sends the decode buffers to the server
1263 * Get ready to decode a picture to a target surface
1265 VAStatus vaBeginPicture (
1267 VAContextID context,
1268 VASurfaceID render_target
1272 * Send decode buffers to the server.
1273 * Buffers are automatically destroyed afterwards
1275 VAStatus vaRenderPicture (
1277 VAContextID context,
1278 VABufferID *buffers,
1283 * Make the end of rendering for a picture.
1284 * The server should start processing all pending operations for this
1285 * surface. This call is non-blocking. The client can start another
1286 * Begin/Render/End sequence on a different render target.
1288 VAStatus vaEndPicture (
1300 * This function blocks until all pending operations on the render target
1301 * have been completed. Upon return it is safe to use the render target for a
1302 * different picture.
1304 VAStatus vaSyncSurface (
1306 VASurfaceID render_target
1311 VASurfaceRendering = 1, /* Rendering in progress */
1312 VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
1313 /* this status is useful if surface is used as the source */
1315 VASurfaceReady = 4, /* not being rendered or displayed */
1316 VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
1320 * Find out any pending ops on the render target
1322 VAStatus vaQuerySurfaceStatus (
1324 VASurfaceID render_target,
1325 VASurfaceStatus *status /* out */
1329 * Images and Subpictures
1330 * VAImage is used to either get the surface data to client memory, or
1331 * to copy image data in client memory to a surface.
1332 * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
1333 * is at the upper left corner with positive X to the right and positive Y down
1335 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1336 ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1337 ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1339 /* a few common FourCCs */
1340 #define VA_FOURCC_NV12 0x3231564E
1341 #define VA_FOURCC_AI44 0x34344149
1342 #define VA_FOURCC_RGBA 0x41424752
1343 #define VA_FOURCC_UYVY 0x59565955
1344 #define VA_FOURCC_YUY2 0x32595559
1345 #define VA_FOURCC_AYUV 0x56555941
1346 #define VA_FOURCC_NV11 0x3131564e
1347 #define VA_FOURCC_YV12 0x32315659
1348 #define VA_FOURCC_P208 0x38303250
1349 #define VA_FOURCC_IYUV 0x56555949
1352 #define VA_LSB_FIRST 1
1353 #define VA_MSB_FIRST 2
1355 typedef struct _VAImageFormat
1357 unsigned int fourcc;
1358 unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1359 unsigned int bits_per_pixel;
1360 /* for RGB formats */
1361 unsigned int depth; /* significant bits per pixel */
1362 unsigned int red_mask;
1363 unsigned int green_mask;
1364 unsigned int blue_mask;
1365 unsigned int alpha_mask;
1368 typedef VAGenericID VAImageID;
1370 typedef struct _VAImage
1372 VAImageID image_id; /* uniquely identify this image */
1373 VAImageFormat format;
1374 VABufferID buf; /* image data buffer */
1376 * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1377 * data store on the server side for optimal performance. The buffer will be
1378 * created by the CreateImage function, and proper storage allocated based on the image
1379 * size and format. This buffer is managed by the library implementation, and
1380 * accessed by the client through the buffer Map/Unmap functions.
1382 unsigned short width;
1383 unsigned short height;
1384 unsigned int data_size;
1385 unsigned int num_planes; /* can not be greater than 3 */
1387 * An array indicating the scanline pitch in bytes for each plane.
1388 * Each plane may have a different pitch. Maximum 3 planes for planar formats
1390 unsigned int pitches[3];
1392 * An array indicating the byte offset from the beginning of the image data
1393 * to the start of each plane.
1395 unsigned int offsets[3];
1397 /* The following fields are only needed for paletted formats */
1398 int num_palette_entries; /* set to zero for non-palette images */
1400 * Each component is one byte and entry_bytes indicates the number of components in
1401 * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
1405 * An array of ascii characters describing the order of the components within the bytes.
1406 * Only entry_bytes characters of the string are used.
1408 char component_order[4];
1411 /* Get maximum number of image formats supported by the implementation */
1412 int vaMaxNumImageFormats (
1417 * Query supported image formats
1418 * The caller must provide a "format_list" array that can hold at
1419 * least vaMaxNumImageFormats() entries. The actual number of formats
1420 * returned in "format_list" is returned in "num_formats".
1422 VAStatus vaQueryImageFormats (
1424 VAImageFormat *format_list, /* out */
1425 int *num_formats /* out */
1429 * Create a VAImage structure
1430 * The width and height fields returned in the VAImage structure may get
1431 * enlarged for some YUV formats. Upon return from this function,
1432 * image->buf has been created and proper storage allocated by the library.
1433 * The client can access the image through the Map/Unmap calls.
1435 VAStatus vaCreateImage (
1437 VAImageFormat *format,
1440 VAImage *image /* out */
1444 * Should call DestroyImage before destroying the surface it is bound to
1446 VAStatus vaDestroyImage (
1451 VAStatus vaSetImagePalette (
1455 * pointer to an array holding the palette data. The size of the array is
1456 * num_palette_entries * entry_bytes in size. The order of the components
1457 * in the palette is described by the component_order in VAImage struct
1459 unsigned char *palette
1463 * Retrive surface data into a VAImage
1464 * Image must be in a format supported by the implementation
1466 VAStatus vaGetImage (
1468 VASurfaceID surface,
1469 int x, /* coordinates of the upper left source pixel */
1471 unsigned int width, /* width and height of the region */
1472 unsigned int height,
1477 * Copy data from a VAImage to a surface
1478 * Image must be in a format supported by the implementation
1479 * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1480 * shouldn't be rendered into when this is called
1482 VAStatus vaPutImage (
1484 VASurfaceID surface,
1488 unsigned int src_width,
1489 unsigned int src_height,
1492 unsigned int dest_width,
1493 unsigned int dest_height
1497 * Derive an VAImage from an existing surface.
1498 * This interface will derive a VAImage and corresponding image buffer from
1499 * an existing VA Surface. The image buffer can then be mapped/unmapped for
1500 * direct CPU access. This operation is only possible on implementations with
1501 * direct rendering capabilities and internal surface formats that can be
1502 * represented with a VAImage. When the operation is not possible this interface
1503 * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1504 * to using vaCreateImage + vaPutImage to accomplish the same task in an
1507 * Implementations should only return success when the resulting image buffer
1508 * would be useable with vaMap/Unmap.
1510 * When directly accessing a surface special care must be taken to insure
1511 * proper synchronization with the graphics hardware. Clients should call
1512 * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1513 * rendering or currently being displayed by an overlay.
1515 * Additionally nothing about the contents of a surface should be assumed
1516 * following a vaPutSurface. Implementations are free to modify the surface for
1517 * scaling or subpicture blending within a call to vaPutImage.
1519 * Calls to vaPutImage or vaGetImage using the same surface from which the image
1520 * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1521 * vaGetImage with other surfaces is supported.
1523 * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1524 * image and image buffer structures will be destroyed; however, the underlying
1525 * surface will remain unchanged until freed with vaDestroySurfaces.
1527 VAStatus vaDeriveImage (
1529 VASurfaceID surface,
1530 VAImage *image /* out */
1535 * Subpicture is a special type of image that can be blended
1536 * with a surface during vaPutSurface(). Subpicture can be used to render
1537 * DVD sub-titles or closed captioning text etc.
1540 typedef VAGenericID VASubpictureID;
1542 /* Get maximum number of subpicture formats supported by the implementation */
1543 int vaMaxNumSubpictureFormats (
1547 /* flags for subpictures */
1548 #define VA_SUBPICTURE_CHROMA_KEYING 0x0001
1549 #define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
1551 * Query supported subpicture formats
1552 * The caller must provide a "format_list" array that can hold at
1553 * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
1554 * for each format to indicate additional capabilities for that format. The actual
1555 * number of formats returned in "format_list" is returned in "num_formats".
1556 * flags: returned value to indicate addtional capabilities
1557 * VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1558 * VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
1560 VAStatus vaQuerySubpictureFormats (
1562 VAImageFormat *format_list, /* out */
1563 unsigned int *flags, /* out */
1564 unsigned int *num_formats /* out */
1568 * Subpictures are created with an image associated.
1570 VAStatus vaCreateSubpicture (
1573 VASubpictureID *subpicture /* out */
1577 * Destroy the subpicture before destroying the image it is assocated to
1579 VAStatus vaDestroySubpicture (
1581 VASubpictureID subpicture
1585 * Bind an image to the subpicture. This image will now be associated with
1586 * the subpicture instead of the one at creation.
1588 VAStatus vaSetSubpictureImage (
1590 VASubpictureID subpicture,
1595 * If chromakey is enabled, then the area where the source value falls within
1596 * the chromakey [min, max] range is transparent
1597 * The chromakey component format is the following:
1598 * For RGB: [0:7] Red [8:15] Blue [16:23] Green
1599 * For YUV: [0:7] V [8:15] U [16:23] Y
1600 * The chromakey mask can be used to mask out certain components for chromakey
1603 VAStatus vaSetSubpictureChromakey (
1605 VASubpictureID subpicture,
1606 unsigned int chromakey_min,
1607 unsigned int chromakey_max,
1608 unsigned int chromakey_mask
1612 * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
1613 * a value of 0 means fully transparent. If per-pixel alpha is also specified then
1614 * the overall alpha is per-pixel alpha multiplied by the global alpha
1616 VAStatus vaSetSubpictureGlobalAlpha (
1618 VASubpictureID subpicture,
1623 * vaAssociateSubpicture associates the subpicture with target_surfaces.
1624 * It defines the region mapping between the subpicture and the target
1625 * surfaces through source and destination rectangles (with the same width and height).
1626 * Both will be displayed at the next call to vaPutSurface. Additional
1627 * associations before the call to vaPutSurface simply overrides the association.
1629 VAStatus vaAssociateSubpicture (
1631 VASubpictureID subpicture,
1632 VASurfaceID *target_surfaces,
1634 short src_x, /* upper left offset in subpicture */
1636 unsigned short src_width,
1637 unsigned short src_height,
1638 short dest_x, /* upper left offset in surface */
1640 unsigned short dest_width,
1641 unsigned short dest_height,
1643 * whether to enable chroma-keying or global-alpha
1644 * see VA_SUBPICTURE_XXX values
1650 * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
1652 VAStatus vaDeassociateSubpicture (
1654 VASubpictureID subpicture,
1655 VASurfaceID *target_surfaces,
1659 typedef struct _VARectangle
1663 unsigned short width;
1664 unsigned short height;
1668 * Display attributes
1669 * Display attributes are used to control things such as contrast, hue, saturation,
1670 * brightness etc. in the rendering process. The application can query what
1671 * attributes are supported by the driver, and then set the appropriate attributes
1672 * before calling vaPutSurface()
1674 /* PowerVR IEP Lite attributes */
1677 VADISPLAYATTRIB_BLE_OFF = 0x00,
1678 VADISPLAYATTRIB_BLE_LOW,
1679 VADISPLAYATTRIB_BLE_MEDIUM,
1680 VADISPLAYATTRIB_BLE_HIGH,
1681 VADISPLAYATTRIB_BLE_NONE,
1682 } VADisplayAttribBLEMode;
1686 VADISPLAYATTRIB_CSC_FORMAT_YCC_BT601 = 0x00,
1687 VADISPLAYATTRIB_CSC_FORMAT_YCC_BT709,
1688 VADISPLAYATTRIB_CSC_FORMAT_YCC_SMPTE_240,
1689 VADISPLAYATTRIB_CSC_FORMAT_RGB,
1690 VADISPLAYATTRIB_CSC_FORMAT_NONE,
1691 } VADisplayAttribCSCFormat;
1693 /* attribute value for VADisplayAttribRotation */
1694 #define VA_ROTATION_NONE 0x00000000
1695 #define VA_ROTATION_90 0x00000001
1696 #define VA_ROTATION_180 0x00000002
1697 #define VA_ROTATION_270 0x00000004
1699 /* attribute value for VADisplayAttribOutOfLoopDeblock */
1700 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
1701 #define VA_OOL_DEBLOCKING_TRUE 0x00000001
1704 /* Currently defined display attribute types */
1707 VADisplayAttribBrightness = 0,
1708 VADisplayAttribContrast = 1,
1709 VADisplayAttribHue = 2,
1710 VADisplayAttribSaturation = 3,
1711 /* client can specifiy a background color for the target window */
1712 VADisplayAttribBackgroundColor = 4,
1714 * this is a gettable only attribute. For some implementations that use the
1715 * hardware overlay, after PutSurface is called, the surface can not be
1716 * re-used until after the subsequent PutSurface call. If this is the case
1717 * then the value for this attribute will be set to 1 so that the client
1718 * will not attempt to re-use the surface right after returning from a call
1721 VADisplayAttribDirectSurface = 5,
1722 VADisplayAttribRotation = 6,
1723 VADisplayAttribOutofLoopDeblock = 7,
1725 /* PowerVR IEP Lite specific attributes */
1726 VADisplayAttribBLEBlackMode = 8,
1727 VADisplayAttribBLEWhiteMode = 9,
1728 VADisplayAttribBlueStretch = 10,
1729 VADisplayAttribSkinColorCorrection = 11,
1730 VADisplayAttribCSCInputColorFormat = 12,
1731 VADisplayAttribCSCHue = 13,
1732 VADisplayAttribCSCSaturation = 14,
1733 VADisplayAttribCSCBrightness = 15,
1734 VADisplayAttribCSCContrast = 16,
1735 } VADisplayAttribType;
1737 /* flags for VADisplayAttribute */
1738 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
1739 #define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
1740 #define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
1742 typedef struct _VADisplayAttribute
1744 VADisplayAttribType type;
1747 int value; /* used by the set/get attribute functions */
1748 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
1750 } VADisplayAttribute;
1752 /* Get maximum number of display attributs supported by the implementation */
1753 int vaMaxNumDisplayAttributes (
1758 * Query display attributes
1759 * The caller must provide a "attr_list" array that can hold at
1760 * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
1761 * returned in "attr_list" is returned in "num_attributes".
1763 VAStatus vaQueryDisplayAttributes (
1765 VADisplayAttribute *attr_list, /* out */
1766 int *num_attributes /* out */
1770 * Get display attributes
1771 * This function returns the current attribute values in "attr_list".
1772 * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
1773 * from vaQueryDisplayAttributes() can have their values retrieved.
1775 VAStatus vaGetDisplayAttributes (
1777 VADisplayAttribute *attr_list, /* in/out */
1782 * Set display attributes
1783 * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
1784 * from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
1785 * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
1787 VAStatus vaSetDisplayAttributes (
1789 VADisplayAttribute *attr_list,