OSDN Git Service

Remove duplicate AYUV fourcc
[android-x86/hardware-intel-common-libva.git] / va / va.h
1 /*
2  * Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
3  *
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:
11  * 
12  * The above copyright notice and this permission notice (including the
13  * next paragraph) shall be included in all copies or substantial portions
14  * of the Software.
15  * 
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.
23  */
24 /*
25  * Video Acceleration (VA) API Specification
26  *
27  * Rev. 0.30
28  * <jonathan.bian@intel.com>
29  *
30  * Revision History:
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 
51  *                                       to enable scaling
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.
58  *
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
64  *
65  * Acknowledgements:
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.
69  */
70
71 /**
72  * \file va.h
73  * \brief The Core API
74  *
75  * This file contains the \ref api_core "Core API".
76  */
77
78 #ifndef _VA_H_
79 #define _VA_H_
80
81 #include <stddef.h>
82 #include <stdint.h>
83 #include <va/va_version.h>
84
85 #ifdef __cplusplus
86 extern "C" {
87 #endif
88
89 #if defined(__GNUC__) && !defined(__COVERITY__)
90 #define va_deprecated __attribute__((deprecated))
91 #if __GNUC__ >= 6
92 #define va_deprecated_enum va_deprecated
93 #else
94 #define va_deprecated_enum
95 #endif
96 #else
97 #define va_deprecated
98 #define va_deprecated_enum
99 #endif
100
101 /**
102  * \mainpage Video Acceleration (VA) API
103  *
104  * \section intro Introduction
105  *
106  * The main motivation for VA-API (Video Acceleration API) is to
107  * enable hardware accelerated video decode and encode at various
108  * entry-points (VLD, IDCT, Motion Compensation etc.) for the
109  * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
110  * AVC/H.264, VC-1/VMW3, and JPEG, HEVC/H265, VP8, VP9) and video pre/post
111  * processing
112  *
113  * VA-API is split into several modules:
114  * - \ref api_core
115  * - Encoder (H264, HEVC, JPEG, MPEG2, VP8, VP9)
116  *      - \ref api_enc_h264
117  *      - \ref api_enc_hevc
118  *      - \ref api_enc_jpeg
119  *      - \ref api_enc_mpeg2
120  *      - \ref api_enc_vp8
121  *      - \ref api_enc_vp9
122  * - Decoder (HEVC, JPEG, VP8, VP9)
123  *      - \ref api_dec_hevc
124  *      - \ref api_dec_jpeg
125  *      - \ref api_dec_vp8
126  *      - \ref api_dec_vp9
127  * - \ref api_vpp
128  * - FEI (H264, HEVC)
129  *      - \ref api_fei
130  *      - \ref api_fei_h264
131  *      - \ref api_fei_hevc
132  */
133
134 /**
135  * \defgroup api_core Core API
136  *
137  * @{
138  */
139
140 /**
141 Overview 
142
143 The VA API is intended to provide an interface between a video decode/encode/processing
144 application (client) and a hardware accelerator (server), to off-load 
145 video decode/encode/processing operations from the host to the hardware accelerator at various
146 entry-points.
147
148 The basic operation steps are:
149
150 - Negotiate a mutually acceptable configuration with the server to lock
151   down profile, entrypoints, and other attributes that will not change on 
152   a frame-by-frame basis.
153 - Create a video decode, encode or processing context which represents a
154   "virtualized" hardware device
155 - Get and fill the render buffers with the corresponding data (depending on
156   profiles and entrypoints)
157 - Pass the render buffers to the server to handle the current frame
158
159 Initialization & Configuration Management 
160
161 - Find out supported profiles
162 - Find out entrypoints for a given profile
163 - Find out configuration attributes for a given profile/entrypoint pair
164 - Create a configuration for use by the application
165
166 */
167
168 typedef void* VADisplay;        /* window system dependent */
169
170 typedef int VAStatus;   /** Return status type from functions */
171 /** Values for the return status */
172 #define VA_STATUS_SUCCESS                       0x00000000
173 #define VA_STATUS_ERROR_OPERATION_FAILED        0x00000001
174 #define VA_STATUS_ERROR_ALLOCATION_FAILED       0x00000002
175 #define VA_STATUS_ERROR_INVALID_DISPLAY         0x00000003
176 #define VA_STATUS_ERROR_INVALID_CONFIG          0x00000004
177 #define VA_STATUS_ERROR_INVALID_CONTEXT         0x00000005
178 #define VA_STATUS_ERROR_INVALID_SURFACE         0x00000006
179 #define VA_STATUS_ERROR_INVALID_BUFFER          0x00000007
180 #define VA_STATUS_ERROR_INVALID_IMAGE           0x00000008
181 #define VA_STATUS_ERROR_INVALID_SUBPICTURE      0x00000009
182 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED      0x0000000a
183 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED        0x0000000b
184 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE     0x0000000c
185 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT  0x0000000d
186 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT   0x0000000e
187 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE  0x0000000f
188 #define VA_STATUS_ERROR_SURFACE_BUSY            0x00000010
189 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED      0x00000011
190 #define VA_STATUS_ERROR_INVALID_PARAMETER       0x00000012
191 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
192 #define VA_STATUS_ERROR_UNIMPLEMENTED           0x00000014
193 #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING   0x00000015
194 #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT    0x00000016
195 #define VA_STATUS_ERROR_DECODING_ERROR          0x00000017
196 #define VA_STATUS_ERROR_ENCODING_ERROR          0x00000018
197 /**
198  * \brief An invalid/unsupported value was supplied.
199  *
200  * This is a catch-all error code for invalid or unsupported values.
201  * e.g. value exceeding the valid range, invalid type in the context
202  * of generic attribute values.
203  */
204 #define VA_STATUS_ERROR_INVALID_VALUE           0x00000019
205 /** \brief An unsupported filter was supplied. */
206 #define VA_STATUS_ERROR_UNSUPPORTED_FILTER      0x00000020
207 /** \brief An invalid filter chain was supplied. */
208 #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN    0x00000021
209 /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
210 #define VA_STATUS_ERROR_HW_BUSY                 0x00000022
211 /** \brief An unsupported memory type was supplied. */
212 #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
213 /** \brief Indicate allocated buffer size is not enough for input or output. */
214 #define VA_STATUS_ERROR_NOT_ENOUGH_BUFFER       0x00000025
215 #define VA_STATUS_ERROR_UNKNOWN                 0xFFFFFFFF
216
217 /** De-interlacing flags for vaPutSurface() */
218 #define VA_FRAME_PICTURE        0x00000000 
219 #define VA_TOP_FIELD            0x00000001
220 #define VA_BOTTOM_FIELD         0x00000002
221
222 /**
223  * Enabled the positioning/cropping/blending feature:
224  * 1, specify the video playback position in the isurface
225  * 2, specify the cropping info for video playback
226  * 3, encoded video will blend with background color
227  */
228 #define VA_ENABLE_BLEND         0x00000004 /* video area blend with the constant color */ 
229     
230 /**
231  * Clears the drawable with background color.
232  * for hardware overlay based implementation this flag
233  * can be used to turn off the overlay
234  */
235 #define VA_CLEAR_DRAWABLE       0x00000008
236
237 /** Color space conversion flags for vaPutSurface() */
238 #define VA_SRC_COLOR_MASK       0x000000f0
239 #define VA_SRC_BT601            0x00000010
240 #define VA_SRC_BT709            0x00000020
241 #define VA_SRC_SMPTE_240        0x00000040
242
243 /** Scaling flags for vaPutSurface() */
244 #define VA_FILTER_SCALING_DEFAULT       0x00000000
245 #define VA_FILTER_SCALING_FAST          0x00000100
246 #define VA_FILTER_SCALING_HQ            0x00000200
247 #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
248 #define VA_FILTER_SCALING_MASK          0x00000f00
249
250 /** Padding size in 4-bytes */
251 #define VA_PADDING_LOW          4
252 #define VA_PADDING_MEDIUM       8
253 #define VA_PADDING_HIGH         16
254 #define VA_PADDING_LARGE        32
255
256 /**
257  * Returns a short english description of error_status
258  */
259 const char *vaErrorStr(VAStatus error_status);
260
261 typedef struct _VARectangle
262 {
263     int16_t x;
264     int16_t y;
265     uint16_t width;
266     uint16_t height;
267 } VARectangle;
268
269 /** \brief Generic motion vector data structure. */
270 typedef struct _VAMotionVector {
271     /** \mv0[0]: horizontal motion vector for past reference */
272     /** \mv0[1]: vertical motion vector for past reference */
273     /** \mv1[0]: horizontal motion vector for future reference */
274     /** \mv1[1]: vertical motion vector for future reference */
275     int16_t  mv0[2];  /* past reference */
276     int16_t  mv1[2];  /* future reference */
277 } VAMotionVector;
278
279 /** Type of a message callback, used for both error and info log. */
280 typedef void (*VAMessageCallback)(void *user_context, const char *message);
281
282 /**
283  * Set the callback for error messages, or NULL for no logging.
284  * Returns the previous one, or NULL if it was disabled.
285  */
286 VAMessageCallback vaSetErrorCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
287
288 /**
289  * Set the callback for info messages, or NULL for no logging.
290  * Returns the previous one, or NULL if it was disabled.
291  */
292 VAMessageCallback vaSetInfoCallback(VADisplay dpy, VAMessageCallback callback, void *user_context);
293
294 /**
295  * Initialization:
296  * A display must be obtained by calling vaGetDisplay() before calling
297  * vaInitialize() and other functions. This connects the API to the 
298  * native window system.
299  * For X Windows, native_dpy would be from XOpenDisplay()
300  */
301 typedef void* VANativeDisplay;  /* window system dependent */
302
303 int vaDisplayIsValid(VADisplay dpy);
304
305 /**
306  *  Set the override driver name instead of queried driver driver.
307  */
308 VAStatus vaSetDriverName(VADisplay dpy,
309                          char *driver_name
310 );
311
312 /**
313  * Initialize the library 
314  */
315 VAStatus vaInitialize (
316     VADisplay dpy,
317     int *major_version,  /* out */
318     int *minor_version   /* out */
319 );
320
321 /**
322  * After this call, all library internal resources will be cleaned up
323  */ 
324 VAStatus vaTerminate (
325     VADisplay dpy
326 );
327
328 /**
329  * vaQueryVendorString returns a pointer to a zero-terminated string
330  * describing some aspects of the VA implemenation on a specific    
331  * hardware accelerator. The format of the returned string is vendor
332  * specific and at the discretion of the implementer.
333  * e.g. for the Intel GMA500 implementation, an example would be:
334  * "Intel GMA500 - 2.0.0.32L.0005"
335  */
336 const char *vaQueryVendorString (
337     VADisplay dpy
338 );
339
340 typedef int (*VAPrivFunc)(void);
341
342 /**
343  * Return a function pointer given a function name in the library.
344  * This allows private interfaces into the library
345  */ 
346 VAPrivFunc vaGetLibFunc (
347     VADisplay dpy,
348     const char *func
349 );
350
351 /** Currently defined profiles */
352 typedef enum
353 {
354     /** \brief Profile ID used for video processing. */
355     VAProfileNone                       = -1,
356     VAProfileMPEG2Simple                = 0,
357     VAProfileMPEG2Main                  = 1,
358     VAProfileMPEG4Simple                = 2,
359     VAProfileMPEG4AdvancedSimple        = 3,
360     VAProfileMPEG4Main                  = 4,
361     VAProfileH264Baseline va_deprecated_enum = 5,
362     VAProfileH264Main                   = 6,
363     VAProfileH264High                   = 7,
364     VAProfileVC1Simple                  = 8,
365     VAProfileVC1Main                    = 9,
366     VAProfileVC1Advanced                = 10,
367     VAProfileH263Baseline               = 11,
368     VAProfileJPEGBaseline               = 12,
369     VAProfileH264ConstrainedBaseline    = 13,
370     VAProfileVP8Version0_3              = 14,
371     VAProfileH264MultiviewHigh          = 15,
372     VAProfileH264StereoHigh             = 16,
373     VAProfileHEVCMain                   = 17,
374     VAProfileHEVCMain10                 = 18,
375     VAProfileVP9Profile0                = 19,
376     VAProfileVP9Profile1                = 20,
377     VAProfileVP9Profile2                = 21,
378     VAProfileVP9Profile3                = 22,
379     VAProfileHEVCMain12                 = 23,
380     VAProfileHEVCMain422_10             = 24,
381     VAProfileHEVCMain422_12             = 25,
382     VAProfileHEVCMain444                = 26,
383     VAProfileHEVCMain444_10             = 27,
384     VAProfileHEVCMain444_12             = 28,
385     VAProfileHEVCSccMain                = 29,
386     VAProfileHEVCSccMain10              = 30,
387     VAProfileHEVCSccMain444             = 31
388 } VAProfile;
389
390 /**
391  *  Currently defined entrypoints 
392  */
393 typedef enum
394 {
395     VAEntrypointVLD             = 1,
396     VAEntrypointIZZ             = 2,
397     VAEntrypointIDCT            = 3,
398     VAEntrypointMoComp          = 4,
399     VAEntrypointDeblocking      = 5,
400     VAEntrypointEncSlice        = 6,    /* slice level encode */
401     VAEntrypointEncPicture      = 7,    /* pictuer encode, JPEG, etc */
402     /*
403      * For an implementation that supports a low power/high performance variant
404      * for slice level encode, it can choose to expose the
405      * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be
406      * available with this entrypoint (e.g. interlace, MBAFF) and the
407      * application can query the encoding configuration attributes to find
408      * out more details if this entrypoint is supported.
409      */
410     VAEntrypointEncSliceLP      = 8,
411     VAEntrypointVideoProc       = 10,   /**< Video pre/post-processing. */
412     /**
413      * \brief VAEntrypointFEI
414      *
415      * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to
416      * have more controls and trade off quality for speed with their own IPs.
417      * The application can optionally provide input to ENC for extra encode control
418      * and get the output from ENC. Application can chose to modify the ENC
419      * output/PAK input during encoding, but the performance impact is significant.
420      *
421      * On top of the existing buffers for normal encode, there will be
422      * one extra input buffer (VAEncMiscParameterFEIFrameControl) and
423      * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType
424      * and VAEncFEIDistortionBufferType) for VAEntrypointFEI entry function.
425      * If separate PAK is set, two extra input buffers
426      * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input.
427      **/
428     VAEntrypointFEI         = 11,
429     /**
430      * \brief VAEntrypointStats
431      *
432      * A pre-processing function for getting some statistics and motion vectors is added,
433      * and some extra controls for Encode pipeline are provided. The application can
434      * optionally call the statistics function to get motion vectors and statistics like
435      * variances, distortions before calling Encode function via this entry point.
436      *
437      * Checking whether Statistics is supported can be performed with vaQueryConfigEntrypoints().
438      * If Statistics entry point is supported, then the list of returned entry-points will
439      * include #VAEntrypointStats. Supported pixel format, maximum resolution and statistics
440      * specific attributes can be obtained via normal attribute query. One input buffer
441      * (VAStatsStatisticsParameterBufferType) and one or two output buffers
442      * (VAStatsStatisticsBufferType, VAStatsStatisticsBottomFieldBufferType (for interlace only)
443      * and VAStatsMVBufferType) are needed for this entry point.
444      **/
445     VAEntrypointStats       = 12,
446 } VAEntrypoint;
447
448 /** Currently defined configuration attribute types */
449 typedef enum
450 {
451     VAConfigAttribRTFormat              = 0,
452     VAConfigAttribSpatialResidual       = 1,
453     VAConfigAttribSpatialClipping       = 2,
454     VAConfigAttribIntraResidual         = 3,
455     VAConfigAttribEncryption            = 4,
456     VAConfigAttribRateControl           = 5,
457
458     /** @name Attributes for decoding */
459     /**@{*/
460     /**
461      * \brief Slice Decoding mode. Read/write.
462      *
463      * This attribute determines what mode the driver supports for slice
464      * decoding, through vaGetConfigAttributes(); and what mode the user
465      * will be providing to the driver, through vaCreateConfig(), if the
466      * driver supports those. If this attribute is not set by the user then
467      * it is assumed that VA_DEC_SLICE_MODE_NORMAL mode is used.
468      *
469      * See \c VA_DEC_SLICE_MODE_xxx for the list of slice decoding modes.
470      */
471     VAConfigAttribDecSliceMode          = 6,
472    /**
473      * \brief JPEG decoding attribute. Read-only.
474      *
475      * This attribute exposes a number of capabilities of the underlying
476      * JPEG implementation. The attribute value is partitioned into fields as defined in the
477      * VAConfigAttribValDecJPEG union.
478      */
479     VAConfigAttribDecJPEG             = 7,
480     /**
481      * \brief Decode processing support. Read/write.
482      *
483      * This attribute determines if the driver supports video processing
484      * with decoding using the decoding context in a single call, through
485      * vaGetConfigAttributes(); and if the user may use this feature,
486      * through vaCreateConfig(), if the driver supports the user scenario.
487      * The user will essentially create a regular decode VAContext.  Therefore,
488      * the parameters of vaCreateContext() such as picture_width, picture_height
489      * and render_targets are in relation to the decode output parameters
490      * (not processing output parameters) as normal.
491      * If this attribute is not set by the user then it is assumed that no
492      * extra processing is done after decoding for this decode context.
493      *
494      * Since essentially the application is creating a decoder config and context,
495      * all function calls that take in the config (e.g. vaQuerySurfaceAttributes())
496      * or context are in relation to the decoder, except those video processing
497      * function specified in the next paragraph.
498      *
499      * Once the decode config and context are created, the user must further
500      * query the supported processing filters using vaQueryVideoProcFilters(),
501      * vaQueryVideoProcFilterCaps(), vaQueryVideoProcPipelineCaps() by specifying
502      * the created decode context.  The user must provide processing information
503      * and extra processing output surfaces as "additional_outputs" to the driver
504      * through VAProcPipelineParameterBufferType.  The render_target specified
505      * at vaBeginPicture() time refers to the decode output surface.  The
506      * target surface for the output of processing needs to be a different
507      * surface since the decode process requires the original reconstructed buffer.
508      * The “surface” member of VAProcPipelineParameterBuffer should be set to the
509      * same as “render_target” set in vaBeginPicture(), but the driver may choose
510      * to ignore this parameter.
511      */
512     VAConfigAttribDecProcessing         = 8,
513     /** @name Attributes for encoding */
514     /**@{*/
515     /**
516      * \brief Packed headers mode. Read/write.
517      *
518      * This attribute determines what packed headers the driver supports,
519      * through vaGetConfigAttributes(); and what packed headers the user
520      * will be providing to the driver, through vaCreateConfig(), if the
521      * driver supports those.
522      *
523      * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
524      */
525     VAConfigAttribEncPackedHeaders      = 10,
526     /**
527      * \brief Interlaced mode. Read/write.
528      *
529      * This attribute determines what kind of interlaced encoding mode
530      * the driver supports.
531      *
532      * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
533      */
534     VAConfigAttribEncInterlaced         = 11,
535     /**
536      * \brief Maximum number of reference frames. Read-only.
537      *
538      * This attribute determines the maximum number of reference
539      * frames supported for encoding.
540      *
541      * Note: for H.264 encoding, the value represents the maximum number
542      * of reference frames for both the reference picture list 0 (bottom
543      * 16 bits) and the reference picture list 1 (top 16 bits).
544      */
545     VAConfigAttribEncMaxRefFrames       = 13,
546     /**
547      * \brief Maximum number of slices per frame. Read-only.
548      *
549      * This attribute determines the maximum number of slices the
550      * driver can support to encode a single frame.
551      */
552     VAConfigAttribEncMaxSlices          = 14,
553     /**
554      * \brief Slice structure. Read-only.
555      *
556      * This attribute determines slice structures supported by the
557      * driver for encoding. This attribute is a hint to the user so
558      * that he can choose a suitable surface size and how to arrange
559      * the encoding process of multiple slices per frame.
560      *
561      * More specifically, for H.264 encoding, this attribute
562      * determines the range of accepted values to
563      * VAEncSliceParameterBufferH264::macroblock_address and
564      * VAEncSliceParameterBufferH264::num_macroblocks.
565      *
566      * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
567      * structure types.
568      */
569     VAConfigAttribEncSliceStructure     = 15,
570     /**
571      * \brief Macroblock information. Read-only.
572      *
573      * This attribute determines whether the driver supports extra
574      * encoding information per-macroblock. e.g. QP.
575      *
576      * More specifically, for H.264 encoding, if the driver returns a non-zero
577      * value for this attribute, this means the application can create
578      * additional #VAEncMacroblockParameterBufferH264 buffers referenced
579      * through VAEncSliceParameterBufferH264::macroblock_info.
580      */
581     VAConfigAttribEncMacroblockInfo     = 16,
582     /**
583      * \brief Maximum picture width. Read-only.
584      *
585      * This attribute determines the maximum picture width the driver supports
586      * for a given configuration.
587      */
588     VAConfigAttribMaxPictureWidth     = 18,
589     /**
590      * \brief Maximum picture height. Read-only.
591      *
592      * This attribute determines the maximum picture height the driver supports
593      * for a given configuration.
594      */
595     VAConfigAttribMaxPictureHeight    = 19,
596     /**
597      * \brief JPEG encoding attribute. Read-only.
598      *
599      * This attribute exposes a number of capabilities of the underlying
600      * JPEG implementation. The attribute value is partitioned into fields as defined in the 
601      * VAConfigAttribValEncJPEG union.
602      */
603     VAConfigAttribEncJPEG             = 20,
604     /**
605      * \brief Encoding quality range attribute. Read-only.
606      *
607      * This attribute conveys whether the driver supports different quality level settings
608      * for encoding. A value less than or equal to 1 means that the encoder only has a single
609      * quality setting, and a value greater than 1 represents the number of quality levels 
610      * that can be configured. e.g. a value of 2 means there are two distinct quality levels. 
611      */
612     VAConfigAttribEncQualityRange     = 21,
613     /**
614      * \brief Encoding quantization attribute. Read-only.
615      *
616      * This attribute conveys whether the driver supports certain types of quantization methods
617      * for encoding (e.g. trellis). See \c VA_ENC_QUANTIZATION_xxx for the list of quantization methods
618      */
619     VAConfigAttribEncQuantization     = 22,
620     /**
621      * \brief Encoding intra refresh attribute. Read-only.
622      *
623      * This attribute conveys whether the driver supports certain types of intra refresh methods
624      * for encoding (e.g. adaptive intra refresh or rolling intra refresh).
625      * See \c VA_ENC_INTRA_REFRESH_xxx for intra refresh methods
626      */
627     VAConfigAttribEncIntraRefresh     = 23,
628     /**
629      * \brief Encoding skip frame attribute. Read-only.
630      *
631      * This attribute conveys whether the driver supports sending skip frame parameters 
632      * (VAEncMiscParameterTypeSkipFrame) to the encoder's rate control, when the user has 
633      * externally skipped frames. 
634      */
635     VAConfigAttribEncSkipFrame        = 24,
636     /**
637      * \brief Encoding region-of-interest (ROI) attribute. Read-only.
638      *
639      * This attribute conveys whether the driver supports region-of-interest (ROI) encoding,
640      * based on user provided ROI rectangles.  The attribute value is partitioned into fields
641      * as defined in the VAConfigAttribValEncROI union.
642      *
643      * If ROI encoding is supported, the ROI information is passed to the driver using
644      * VAEncMiscParameterTypeROI.
645      */
646     VAConfigAttribEncROI              = 25,
647     /**
648      * \brief Encoding extended rate control attribute. Read-only.
649      *
650      * This attribute conveys whether the driver supports any extended rate control features
651      * The attribute value is partitioned into fields as defined in the
652      * VAConfigAttribValEncRateControlExt union.
653      */
654     VAConfigAttribEncRateControlExt   = 26,
655     /**
656      * \brief Processing rate reporting attribute. Read-only.
657      *
658      * This attribute conveys whether the driver supports reporting of
659      * encode/decode processing rate based on certain set of parameters
660      * (i.e. levels, I frame internvals) for a given configuration.
661      * If this is supported, vaQueryProcessingRate() can be used to get
662      * encode or decode processing rate.
663      * See \c VA_PROCESSING_RATE_xxx for encode/decode processing rate
664      */
665     VAConfigAttribProcessingRate    = 27,
666     /**
667      * \brief Encoding dirty rectangle. Read-only.
668      *
669      * This attribute conveys whether the driver supports dirty rectangle.
670      * encoding, based on user provided ROI rectangles which indicate the rectangular areas
671      * where the content has changed as compared to the previous picture.  The regions of the
672      * picture that are not covered by dirty rect rectangles are assumed to have not changed
673      * compared to the previous picture.  The encoder may do some optimizations based on
674      * this information.  The attribute value returned indicates the number of regions that
675      * are supported.  e.g. A value of 0 means dirty rect encoding is not supported.  If dirty
676      * rect encoding is supported, the ROI information is passed to the driver using
677      * VAEncMiscParameterTypeDirtyRect.
678      */
679      VAConfigAttribEncDirtyRect       = 28,
680     /**
681      * \brief Parallel Rate Control (hierachical B) attribute. Read-only.
682      *
683      * This attribute conveys whether the encoder supports parallel rate control.
684      * It is a integer value 0 - unsupported, > 0 - maximum layer supported.
685      * This is the way when hireachical B frames are encoded, multiple independent B frames
686      * on the same layer may be processed at same time. If supported, app may enable it by
687      * setting enable_parallel_brc in VAEncMiscParameterRateControl,and the number of B frames
688      * per layer per GOP will be passed to driver through VAEncMiscParameterParallelRateControl
689      * structure.Currently three layers are defined.
690      */
691      VAConfigAttribEncParallelRateControl   = 29,
692      /**
693      * \brief Dynamic Scaling Attribute. Read-only.
694      *
695      * This attribute conveys whether encoder is capable to determine dynamic frame
696      * resolutions adaptive to bandwidth utilization and processing power, etc.
697      * It is a boolean value 0 - unsupported, 1 - supported.
698      * If it is supported,for VP9, suggested frame resolution can be retrieved from VACodedBufferVP9Status.
699      */
700      VAConfigAttribEncDynamicScaling        = 30,
701      /**
702      * \brief frame size tolerance support
703      * it indicates the tolerance of frame size
704      */
705      VAConfigAttribFrameSizeToleranceSupport = 31,
706      /**
707      * \brief Encode function type for FEI.
708      *
709      * This attribute conveys whether the driver supports different function types for encode.
710      * It can be VA_FEI_FUNCTION_ENC, VA_FEI_FUNCTION_PAK, or VA_FEI_FUNCTION_ENC_PAK. Currently
711      * it is for FEI entry point only.
712      * Default is VA_FEI_FUNCTION_ENC_PAK.
713      */
714      VAConfigAttribFEIFunctionType     = 32,
715     /**
716      * \brief Maximum number of FEI MV predictors. Read-only.
717      *
718      * This attribute determines the maximum number of MV predictors the driver
719      * can support to encode a single frame. 0 means no MV predictor is supported.
720      * Currently it is for FEI entry point only.
721      */
722     VAConfigAttribFEIMVPredictors     = 33,
723     /**
724      * \brief Statistics attribute. Read-only.
725      *
726      * This attribute exposes a number of capabilities of the VAEntrypointStats entry
727      * point. The attribute value is partitioned into fields as defined in the
728      * VAConfigAttribValStats union. Currently it is for VAEntrypointStats only.
729      */
730     VAConfigAttribStats               = 34,
731      /**
732      * \brief Tile Support Attribute. Read-only.
733      *
734      * This attribute conveys whether encoder is capable to support tiles.
735      * If not supported, the tile related parameters sent to encoder, such as
736      * tiling structure, should be ignored. 0 - unsupported, 1 - supported.
737      */
738      VAConfigAttribEncTileSupport        = 35,
739     /**
740      * \brief whether accept rouding setting from application. Read-only.
741      * This attribute is for encode quality, if it is report,
742      * application can change the rounding setting by VAEncMiscParameterTypeCustomRoundingControl
743      */
744     VAConfigAttribCustomRoundingControl = 36,
745     /**
746      * \brief Encoding QP info block size attribute. Read-only.
747      * This attribute conveys the block sizes that underlying driver
748      * support for QP info for buffer #VAEncQpBuffer.
749      */
750     VAConfigAttribQPBlockSize            = 37,
751     /**@}*/
752     VAConfigAttribTypeMax
753 } VAConfigAttribType;
754
755 /**
756  * Configuration attributes
757  * If there is more than one value for an attribute, a default
758  * value will be assigned to the attribute if the client does not
759  * specify the attribute when creating a configuration
760  */
761 typedef struct _VAConfigAttrib {
762     VAConfigAttribType type;
763     uint32_t value; /* OR'd flags (bits) for this attribute */
764 } VAConfigAttrib;
765
766 /** attribute value for VAConfigAttribRTFormat */
767 #define VA_RT_FORMAT_YUV420     0x00000001      
768 #define VA_RT_FORMAT_YUV422     0x00000002
769 #define VA_RT_FORMAT_YUV444     0x00000004
770 #define VA_RT_FORMAT_YUV411     0x00000008
771 #define VA_RT_FORMAT_YUV400     0x00000010
772 /** YUV formats with more than 8 bpp */
773 #define VA_RT_FORMAT_YUV420_10BPP       0x00000100
774 /** RGB formats */
775 #define VA_RT_FORMAT_RGB16      0x00010000
776 #define VA_RT_FORMAT_RGB32      0x00020000
777 /* RGBP covers RGBP and BGRP fourcc */ 
778 #define VA_RT_FORMAT_RGBP       0x00100000
779 /**
780  * RGB 10-bit packed format with upper 2 bits as alpha channel.
781  * The existing pre-defined fourcc codes can be used to signal
782  * the position of each component for this RT format.
783  */
784 #define VA_RT_FORMAT_RGB32_10BPP 0x00200000
785 #define VA_RT_FORMAT_PROTECTED  0x80000000
786
787 /** @name Attribute values for VAConfigAttribRateControl */
788 /**@{*/
789 /** \brief Driver does not support any form of rate control. */
790 #define VA_RC_NONE                      0x00000001
791 /** \brief Constant bitrate. */
792 #define VA_RC_CBR                       0x00000002
793 /** \brief Variable bitrate. */
794 #define VA_RC_VBR                       0x00000004
795 /** \brief Video conference mode. */
796 #define VA_RC_VCM                       0x00000008
797 /** \brief Constant QP. */
798 #define VA_RC_CQP                       0x00000010
799 /** \brief Variable bitrate with peak rate higher than average bitrate. */
800 #define VA_RC_VBR_CONSTRAINED           0x00000020
801 /** \brief Intelligent Constant Quality. Provided an initial ICQ_quality_factor,
802  *  adjusts QP at a frame and MB level based on motion to improve subjective quality. */
803 #define VA_RC_ICQ                       0x00000040
804 /** \brief Macroblock based rate control.  Per MB control is decided
805  *  internally in the encoder. It may be combined with other RC modes, except CQP. */
806 #define VA_RC_MB                        0x00000080
807 /** \brief Constant Frame Size, it is used for small tolerent  */
808 #define VA_RC_CFS                       0x00000100
809 /** \brief Parallel BRC, for hierachical B.
810  *
811  *  For hierachical B, B frames can be refered by other B frames.
812  *  Currently three layers of hierachy are defined:
813  *  B0 - regular B, no reference to other B frames.
814  *  B1 - reference to only I, P and regular B0 frames.
815  *  B2 - reference to any other frames, including B1.
816  *  In Hierachical B structure, B frames on the same layer can be processed
817  *  simultaneously. And BRC would adjust accordingly. This is so called
818  *  Parallel BRC. */
819 #define VA_RC_PARALLEL                  0x00000200
820
821 /**@}*/
822
823 /** @name Attribute values for VAConfigAttribDecSliceMode */
824 /**@{*/
825 /** \brief Driver supports normal mode for slice decoding */
826 #define VA_DEC_SLICE_MODE_NORMAL       0x00000001
827 /** \brief Driver supports base mode for slice decoding */
828 #define VA_DEC_SLICE_MODE_BASE         0x00000002
829
830 /** @name Attribute values for VAConfigAttribDecJPEG */
831 /**@{*/
832 typedef union _VAConfigAttribValDecJPEG {
833     struct{
834     /** \brief Set to (1 << VA_ROTATION_xxx) for supported rotation angles. */
835     uint32_t rotation : 4;
836     /** \brief Reserved for future use. */
837     uint32_t reserved : 28;
838     }bits;
839     uint32_t value;
840     uint32_t va_reserved[VA_PADDING_LOW];
841 } VAConfigAttribValDecJPEG;
842 /** @name Attribute values for VAConfigAttribDecProcessing */
843 /**@{*/
844 /** \brief No decoding + processing in a single decoding call. */
845 #define VA_DEC_PROCESSING_NONE     0x00000000
846 /** \brief Decode + processing in a single decoding call. */
847 #define VA_DEC_PROCESSING          0x00000001
848 /**@}*/
849
850 /** @name Attribute values for VAConfigAttribEncPackedHeaders */
851 /**@{*/
852 /** \brief Driver does not support any packed headers mode. */
853 #define VA_ENC_PACKED_HEADER_NONE       0x00000000
854 /**
855  * \brief Driver supports packed sequence headers. e.g. SPS for H.264.
856  *
857  * Application must provide it to driver once this flag is returned through
858  * vaGetConfigAttributes()
859  */
860 #define VA_ENC_PACKED_HEADER_SEQUENCE   0x00000001
861 /**
862  * \brief Driver supports packed picture headers. e.g. PPS for H.264.
863  *
864  * Application must provide it to driver once this falg is returned through
865  * vaGetConfigAttributes()
866  */
867 #define VA_ENC_PACKED_HEADER_PICTURE    0x00000002
868 /**
869  * \brief Driver supports packed slice headers. e.g. slice_header() for H.264.
870  *
871  * Application must provide it to driver once this flag is returned through
872  * vaGetConfigAttributes()
873  */
874 #define VA_ENC_PACKED_HEADER_SLICE      0x00000004
875 /**
876  * \brief Driver supports misc packed headers. e.g. SEI for H.264.
877  *
878  * @deprecated
879  * This is a deprecated packed header flag, All applications can use
880  * \c VA_ENC_PACKED_HEADER_RAW_DATA to pass the corresponding packed
881  * header data buffer to the driver
882  */
883 #define VA_ENC_PACKED_HEADER_MISC       0x00000008
884 /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
885 #define VA_ENC_PACKED_HEADER_RAW_DATA   0x00000010
886 /**@}*/
887
888 /** @name Attribute values for VAConfigAttribEncInterlaced */
889 /**@{*/
890 /** \brief Driver does not support interlaced coding. */
891 #define VA_ENC_INTERLACED_NONE          0x00000000
892 /** \brief Driver supports interlaced frame coding. */
893 #define VA_ENC_INTERLACED_FRAME         0x00000001
894 /** \brief Driver supports interlaced field coding. */
895 #define VA_ENC_INTERLACED_FIELD         0x00000002
896 /** \brief Driver supports macroblock adaptive frame field coding. */
897 #define VA_ENC_INTERLACED_MBAFF         0x00000004
898 /** \brief Driver supports picture adaptive frame field coding. */
899 #define VA_ENC_INTERLACED_PAFF          0x00000008
900 /**@}*/
901
902 /** @name Attribute values for VAConfigAttribEncSliceStructure */
903 /**@{*/
904 /** \brief Driver supports a power-of-two number of rows per slice. */
905 #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS        0x00000001
906 /** \brief Driver supports an arbitrary number of macroblocks per slice. */
907 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS    0x00000002
908 /** \brief Dirver support 1 rows  per slice */
909 #define VA_ENC_SLICE_STRUCTURE_EQUAL_ROWS               0x00000004
910 /** \brief Dirver support max encoded slice size per slice */
911 #define VA_ENC_SLICE_STRUCTURE_MAX_SLICE_SIZE           0x00000008
912 /** \brief Driver supports an arbitrary number of rows per slice. */
913 #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS           0x00000010
914 /**@}*/
915
916 /** \brief Attribute value for VAConfigAttribEncJPEG */
917 typedef union _VAConfigAttribValEncJPEG {
918     struct {
919         /** \brief set to 1 for arithmatic coding. */
920         uint32_t arithmatic_coding_mode : 1;
921         /** \brief set to 1 for progressive dct. */
922         uint32_t progressive_dct_mode : 1;
923         /** \brief set to 1 for non-interleaved. */
924         uint32_t non_interleaved_mode : 1;
925         /** \brief set to 1 for differential. */
926         uint32_t differential_mode : 1;
927         uint32_t max_num_components : 3;
928         uint32_t max_num_scans : 4;
929         uint32_t max_num_huffman_tables : 3;
930         uint32_t max_num_quantization_tables : 3;
931     } bits;
932     uint32_t value;
933 } VAConfigAttribValEncJPEG;
934
935 /** @name Attribute values for VAConfigAttribEncQuantization */
936 /**@{*/
937 /** \brief Driver does not support special types of quantization */
938 #define VA_ENC_QUANTIZATION_NONE                        0x00000000
939 /** \brief Driver supports trellis quantization */
940 #define VA_ENC_QUANTIZATION_TRELLIS_SUPPORTED           0x00000001
941 /**@}*/
942
943 /** @name Attribute values for VAConfigAttribEncIntraRefresh */
944 /**@{*/
945 /** \brief Driver does not support intra refresh */
946 #define VA_ENC_INTRA_REFRESH_NONE                       0x00000000
947 /** \brief Driver supports column based rolling intra refresh */
948 #define VA_ENC_INTRA_REFRESH_ROLLING_COLUMN             0x00000001
949 /** \brief Driver supports row based rolling intra refresh */
950 #define VA_ENC_INTRA_REFRESH_ROLLING_ROW                0x00000002
951 /** \brief Driver supports adaptive intra refresh */
952 #define VA_ENC_INTRA_REFRESH_ADAPTIVE                   0x00000010
953 /** \brief Driver supports cyclic intra refresh */
954 #define VA_ENC_INTRA_REFRESH_CYCLIC                     0x00000020
955 /** \brief Driver supports intra refresh of P frame*/
956 #define VA_ENC_INTRA_REFRESH_P_FRAME                    0x00010000
957 /** \brief Driver supports intra refresh of B frame */
958 #define VA_ENC_INTRA_REFRESH_B_FRAME                    0x00020000
959 /** \brief Driver supports intra refresh of multiple reference encoder */
960 #define VA_ENC_INTRA_REFRESH_MULTI_REF                  0x00040000
961
962 /**@}*/
963
964 /** \brief Attribute value for VAConfigAttribEncROI */
965 typedef union _VAConfigAttribValEncROI {
966     struct {
967         /** \brief The number of ROI regions supported, 0 if ROI is not supported. */
968         uint32_t num_roi_regions                : 8;
969         /**
970          * \brief A flag indicates whether ROI priority is supported
971          *
972          * \ref roi_rc_priority_support equal to 1 specifies the underlying driver supports
973          * ROI priority when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
974          * in #VAEncROI to set ROI priority. \ref roi_rc_priority_support equal to 0 specifies
975          * the underlying driver doesn't support ROI priority.
976          *
977          * User should ignore \ref roi_rc_priority_support when VAConfigAttribRateControl == VA_RC_CQP
978          * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
979          */
980         uint32_t roi_rc_priority_support        : 1;
981         /**
982          * \brief A flag indicates whether ROI delta QP is supported
983          *
984          * \ref roi_rc_qp_delta_support equal to 1 specifies the underlying driver supports
985          * ROI delta QP when VAConfigAttribRateControl != VA_RC_CQP, user can use \c roi_value
986          * in #VAEncROI to set ROI delta QP. \ref roi_rc_qp_delta_support equal to 0 specifies
987          * the underlying driver doesn't support ROI delta QP.
988          *
989          * User should ignore \ref roi_rc_qp_delta_support when VAConfigAttribRateControl == VA_RC_CQP
990          * because ROI delta QP is always required when VAConfigAttribRateControl == VA_RC_CQP.
991          */
992         uint32_t roi_rc_qp_delta_support    : 1;
993         uint32_t reserved                   : 22;
994      } bits;
995      uint32_t value;
996 } VAConfigAttribValEncROI;
997
998 /** \brief Attribute value for VAConfigAttribEncRateControlExt */
999 typedef union _VAConfigAttribValEncRateControlExt {
1000     struct {
1001         /**
1002          * \brief The maximum number of temporal layers minus 1
1003          *
1004          * \ref max_num_temporal_layers_minus1 plus 1 specifies the maximum number of temporal
1005          * layers that supported by the underlying driver. \ref max_num_temporal_layers_minus1
1006          * equal to 0 implies the underlying driver doesn't support encoding with temporal layer.
1007          */
1008         uint32_t max_num_temporal_layers_minus1      : 8;
1009
1010         /**
1011          * /brief support temporal layer bit-rate control flag
1012          *
1013          * \ref temporal_layer_bitrate_control_flag equal to 1 specifies the underlying driver
1014          * can support bit-rate control per temporal layer when (#VAConfigAttribRateControl == #VA_RC_CBR ||
1015          * #VAConfigAttribRateControl == #VA_RC_VBR).
1016          *
1017          * The underlying driver must set \ref temporal_layer_bitrate_control_flag to 0 when
1018          * \c max_num_temporal_layers_minus1 is equal to 0
1019          *
1020          * To use bit-rate control per temporal layer, an application must send the right layer
1021          * structure via #VAEncMiscParameterTemporalLayerStructure at the beginning of a coded sequence
1022          * and then followed by #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate structures
1023          * for each layer, using the \c temporal_id field as the layer identifier. Otherwise
1024          * the driver doesn't use bitrate control per temporal layer if an application doesn't send the
1025          * layer structure via #VAEncMiscParameterTemporalLayerStructure to the driver. The driver returns
1026          * VA_STATUS_ERROR_INVALID_PARAMETER if an application sends a wrong layer structure or doesn't send
1027          * #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate for each layer.
1028          *
1029          * The driver will ignore #VAEncMiscParameterTemporalLayerStructure and the \c temporal_id field
1030          * in #VAEncMiscParameterRateControl and #VAEncMiscParameterFrameRate if
1031          * \ref temporal_layer_bitrate_control_flag is equal to 0 or #VAConfigAttribRateControl == #VA_RC_CQP
1032          */
1033         uint32_t temporal_layer_bitrate_control_flag : 1;
1034         uint32_t reserved                            : 23;
1035     } bits;
1036     uint32_t value;
1037 } VAConfigAttribValEncRateControlExt;
1038
1039 /** @name Attribute values for VAConfigAttribProcessingRate. */
1040 /**@{*/
1041 /** \brief Driver does not support processing rate report */
1042 #define VA_PROCESSING_RATE_NONE                       0x00000000
1043 /** \brief Driver supports encode processing rate report  */
1044 #define VA_PROCESSING_RATE_ENCODE                     0x00000001
1045 /** \brief Driver supports decode processing rate report  */
1046 #define VA_PROCESSING_RATE_DECODE                     0x00000002
1047 /**@}*/
1048 /**
1049  * if an attribute is not applicable for a given
1050  * profile/entrypoint pair, then set the value to the following 
1051  */
1052 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
1053
1054 /** Get maximum number of profiles supported by the implementation */
1055 int vaMaxNumProfiles (
1056     VADisplay dpy
1057 );
1058
1059 /** Get maximum number of entrypoints supported by the implementation */
1060 int vaMaxNumEntrypoints (
1061     VADisplay dpy
1062 );
1063
1064 /** Get maximum number of attributs supported by the implementation */
1065 int vaMaxNumConfigAttributes (
1066     VADisplay dpy
1067 );
1068
1069 /**
1070  * Query supported profiles 
1071  * The caller must provide a "profile_list" array that can hold at
1072  * least vaMaxNumProfile() entries. The actual number of profiles
1073  * returned in "profile_list" is returned in "num_profile".
1074  */
1075 VAStatus vaQueryConfigProfiles (
1076     VADisplay dpy,
1077     VAProfile *profile_list,    /* out */
1078     int *num_profiles           /* out */
1079 );
1080
1081 /**
1082  * Query supported entrypoints for a given profile 
1083  * The caller must provide an "entrypoint_list" array that can hold at
1084  * least vaMaxNumEntrypoints() entries. The actual number of entrypoints 
1085  * returned in "entrypoint_list" is returned in "num_entrypoints".
1086  */
1087 VAStatus vaQueryConfigEntrypoints (
1088     VADisplay dpy,
1089     VAProfile profile,
1090     VAEntrypoint *entrypoint_list,      /* out */
1091     int *num_entrypoints                /* out */
1092 );
1093
1094 /**
1095  * Get attributes for a given profile/entrypoint pair 
1096  * The caller must provide an "attrib_list" with all attributes to be 
1097  * retrieved.  Upon return, the attributes in "attrib_list" have been 
1098  * updated with their value.  Unknown attributes or attributes that are 
1099  * not supported for the given profile/entrypoint pair will have their 
1100  * value set to VA_ATTRIB_NOT_SUPPORTED
1101  */
1102 VAStatus vaGetConfigAttributes (
1103     VADisplay dpy,
1104     VAProfile profile,
1105     VAEntrypoint entrypoint,
1106     VAConfigAttrib *attrib_list, /* in/out */
1107     int num_attribs
1108 );
1109
1110 /** Generic ID type, can be re-typed for specific implementation */
1111 typedef unsigned int VAGenericID;
1112
1113 typedef VAGenericID VAConfigID;
1114
1115 /**
1116  * Create a configuration for the video decode/encode/processing pipeline
1117  * it passes in the attribute list that specifies the attributes it cares 
1118  * about, with the rest taking default values.  
1119  */
1120 VAStatus vaCreateConfig (
1121     VADisplay dpy,
1122     VAProfile profile, 
1123     VAEntrypoint entrypoint, 
1124     VAConfigAttrib *attrib_list,
1125     int num_attribs,
1126     VAConfigID *config_id /* out */
1127 );
1128
1129 /**
1130  * Free resources associdated with a given config 
1131  */
1132 VAStatus vaDestroyConfig (
1133     VADisplay dpy,
1134     VAConfigID config_id
1135 );
1136
1137 /**
1138  * Query all attributes for a given configuration 
1139  * The profile of the configuration is returned in "profile"
1140  * The entrypoint of the configuration is returned in "entrypoint"
1141  * The caller must provide an "attrib_list" array that can hold at least 
1142  * vaMaxNumConfigAttributes() entries. The actual number of attributes 
1143  * returned in "attrib_list" is returned in "num_attribs"
1144  */
1145 VAStatus vaQueryConfigAttributes (
1146     VADisplay dpy,
1147     VAConfigID config_id, 
1148     VAProfile *profile,         /* out */
1149     VAEntrypoint *entrypoint,   /* out */
1150     VAConfigAttrib *attrib_list,/* out */
1151     int *num_attribs            /* out */
1152 );
1153
1154
1155 /**
1156  * Contexts and Surfaces
1157  *
1158  * Context represents a "virtual" video decode, encode or video processing
1159  * pipeline. Surfaces are render targets for a given context. The data in the
1160  * surfaces are not accessible to the client except if derived image is supported
1161  * and the internal data format of the surface is implementation specific.
1162  *
1163  * Surfaces are provided as a hint of what surfaces will be used when the context
1164  * is created through vaCreateContext(). A surface may be used by different contexts
1165  * at the same time as soon as application can make sure the operations are synchronized
1166  * between different contexts, e.g. a surface is used as the output of a decode context
1167  * and the input of a video process context. Surfaces can only be destroyed after all
1168  * contexts using these surfaces have been destroyed.
1169  * 
1170  * Both contexts and surfaces are identified by unique IDs and its
1171  * implementation specific internals are kept opaque to the clients
1172  */
1173
1174 typedef VAGenericID VAContextID;
1175
1176 typedef VAGenericID VASurfaceID;
1177
1178 #define VA_INVALID_ID           0xffffffff
1179 #define VA_INVALID_SURFACE      VA_INVALID_ID
1180
1181 /** \brief Generic value types. */
1182 typedef enum  {
1183     VAGenericValueTypeInteger = 1,      /**< 32-bit signed integer. */
1184     VAGenericValueTypeFloat,            /**< 32-bit floating-point value. */
1185     VAGenericValueTypePointer,          /**< Generic pointer type */
1186     VAGenericValueTypeFunc              /**< Pointer to function */
1187 } VAGenericValueType;
1188
1189 /** \brief Generic function type. */
1190 typedef void (*VAGenericFunc)(void);
1191
1192 /** \brief Generic value. */
1193 typedef struct _VAGenericValue {
1194     /** \brief Value type. See #VAGenericValueType. */
1195     VAGenericValueType  type;
1196     /** \brief Value holder. */
1197     union {
1198         /** \brief 32-bit signed integer. */
1199         int32_t             i;
1200         /** \brief 32-bit float. */
1201         float           f;
1202         /** \brief Generic pointer. */
1203         void           *p;
1204         /** \brief Pointer to function. */
1205         VAGenericFunc   fn;
1206     }                   value;
1207 } VAGenericValue;
1208
1209 /** @name Surface attribute flags */
1210 /**@{*/
1211 /** \brief Surface attribute is not supported. */
1212 #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
1213 /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
1214 #define VA_SURFACE_ATTRIB_GETTABLE      0x00000001
1215 /** \brief Surface attribute can be set through vaCreateSurfaces(). */
1216 #define VA_SURFACE_ATTRIB_SETTABLE      0x00000002
1217 /**@}*/
1218
1219 /** \brief Surface attribute types. */
1220 typedef enum {
1221     VASurfaceAttribNone = 0,
1222     /**
1223      * \brief Pixel format (fourcc).
1224      *
1225      * The value is meaningful as input to vaQuerySurfaceAttributes().
1226      * If zero, the driver returns the optimal pixel format for the
1227      * specified config. Otherwise, if non-zero, the value represents
1228      * a pixel format (FOURCC) that is kept as is on output, if the
1229      * driver supports it. Otherwise, the driver sets the value to
1230      * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
1231      */
1232     VASurfaceAttribPixelFormat,
1233     /** \brief Minimal width in pixels (int, read-only). */
1234     VASurfaceAttribMinWidth,
1235     /** \brief Maximal width in pixels (int, read-only). */
1236     VASurfaceAttribMaxWidth,
1237     /** \brief Minimal height in pixels (int, read-only). */
1238     VASurfaceAttribMinHeight,
1239     /** \brief Maximal height in pixels (int, read-only). */
1240     VASurfaceAttribMaxHeight,
1241     /** \brief Surface memory type expressed in bit fields (int, read/write). */
1242     VASurfaceAttribMemoryType,
1243     /** \brief External buffer descriptor (pointer, write). */
1244     VASurfaceAttribExternalBufferDescriptor,
1245     /** \brief Surface usage hint, gives the driver a hint of intended usage 
1246      *  to optimize allocation (e.g. tiling) (int, read/write). */
1247     VASurfaceAttribUsageHint,
1248     /** \brief Number of surface attributes. */
1249     VASurfaceAttribCount
1250 } VASurfaceAttribType;
1251
1252 /** \brief Surface attribute. */
1253 typedef struct _VASurfaceAttrib {
1254     /** \brief Type. */
1255     VASurfaceAttribType type;
1256     /** \brief Flags. See "Surface attribute flags". */
1257     uint32_t        flags;
1258     /** \brief Value. See "Surface attribute types" for the expected types. */
1259     VAGenericValue      value;
1260 } VASurfaceAttrib;
1261
1262 /** 
1263  * @name VASurfaceAttribMemoryType values in bit fields. 
1264  * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for 
1265  * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
1266  * types are defined in DRM and Android header files.
1267  */
1268 /**@{*/
1269 /** \brief VA memory type (default) is supported. */
1270 #define VA_SURFACE_ATTRIB_MEM_TYPE_VA                   0x00000001
1271 /** \brief V4L2 buffer memory type is supported. */
1272 #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2                 0x00000002
1273 /** \brief User pointer memory type is supported. */
1274 #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR             0x00000004
1275 /**@}*/
1276
1277 /** 
1278  * \brief VASurfaceAttribExternalBuffers structure for 
1279  * the VASurfaceAttribExternalBufferDescriptor attribute.
1280  */
1281 typedef struct _VASurfaceAttribExternalBuffers {
1282     /** \brief pixel format in fourcc. */
1283     uint32_t pixel_format;
1284     /** \brief width in pixels. */
1285     uint32_t width;
1286     /** \brief height in pixels. */
1287     uint32_t height;
1288     /** \brief total size of the buffer in bytes. */
1289     uint32_t data_size;
1290     /** \brief number of planes for planar layout */
1291     uint32_t num_planes;
1292     /** \brief pitch for each plane in bytes */
1293     uint32_t pitches[4];
1294     /** \brief offset for each plane in bytes */
1295     uint32_t offsets[4];
1296     /** \brief buffer handles or user pointers */
1297     uintptr_t *buffers;
1298     /** \brief number of elements in the "buffers" array */
1299     uint32_t num_buffers;
1300     /** \brief flags. See "Surface external buffer descriptor flags". */
1301     uint32_t flags;
1302     /** \brief reserved for passing private data */
1303     void *private_data;
1304 } VASurfaceAttribExternalBuffers;
1305
1306 /** @name VASurfaceAttribExternalBuffers flags */
1307 /**@{*/
1308 /** \brief Enable memory tiling */
1309 #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING    0x00000001
1310 /** \brief Memory is cacheable */
1311 #define VA_SURFACE_EXTBUF_DESC_CACHED           0x00000002
1312 /** \brief Memory is non-cacheable */
1313 #define VA_SURFACE_EXTBUF_DESC_UNCACHED         0x00000004
1314 /** \brief Memory is write-combined */
1315 #define VA_SURFACE_EXTBUF_DESC_WC               0x00000008
1316 /** \brief Memory is protected */
1317 #define VA_SURFACE_EXTBUF_DESC_PROTECTED        0x80000000
1318
1319 /** @name VASurfaceAttribUsageHint attribute usage hint flags */
1320 /**@{*/
1321 /** \brief Surface usage not indicated. */
1322 #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC    0x00000000
1323 /** \brief Surface used by video decoder. */
1324 #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER    0x00000001
1325 /** \brief Surface used by video encoder. */
1326 #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER    0x00000002
1327 /** \brief Surface read by video post-processing. */
1328 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ   0x00000004
1329 /** \brief Surface written by video post-processing. */
1330 #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE  0x00000008
1331 /** \brief Surface used for display. */
1332 #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY    0x00000010
1333 /** \brief Surface used for export to third-party APIs, e.g. via
1334  *  vaExportSurfaceHandle(). */
1335 #define VA_SURFACE_ATTRIB_USAGE_HINT_EXPORT     0x00000020
1336
1337 /**@}*/
1338
1339 /**
1340  * \brief Queries surface attributes for the supplied config.
1341  *
1342  * This function queries for all supported attributes for the
1343  * supplied VA @config. In particular, if the underlying hardware
1344  * supports the creation of VA surfaces in various formats, then
1345  * this function will enumerate all pixel formats that are supported.
1346  *
1347  * The \c attrib_list array is allocated by the user and \c
1348  * num_attribs shall be initialized to the number of allocated
1349  * elements in that array. Upon successful return, the actual number
1350  * of attributes will be overwritten into \c num_attribs. Otherwise,
1351  * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
1352  * is adjusted to the number of elements that would be returned if
1353  * enough space was available.
1354  *
1355  * Note: it is perfectly valid to pass NULL to the \c attrib_list
1356  * argument when vaQuerySurfaceAttributes() is used to determine the
1357  * actual number of elements that need to be allocated.
1358  *
1359  * @param[in] dpy               the VA display
1360  * @param[in] config            the config identifying a codec or a video
1361  *     processing pipeline
1362  * @param[out] attrib_list      the output array of #VASurfaceAttrib elements
1363  * @param[in,out] num_attribs   the number of elements allocated on
1364  *      input, the number of elements actually filled in output
1365  */
1366 VAStatus
1367 vaQuerySurfaceAttributes(
1368     VADisplay           dpy,
1369     VAConfigID          config,
1370     VASurfaceAttrib    *attrib_list,
1371     unsigned int       *num_attribs
1372 );
1373
1374 /**
1375  * \brief Creates an array of surfaces
1376  *
1377  * Creates an array of surfaces. The optional list of attributes shall
1378  * be constructed based on what the underlying hardware could expose
1379  * through vaQuerySurfaceAttributes().
1380  *
1381  * @param[in] dpy               the VA display
1382  * @param[in] format            the desired surface format. See \c VA_RT_FORMAT_*
1383  * @param[in] width             the surface width
1384  * @param[in] height            the surface height
1385  * @param[out] surfaces         the array of newly created surfaces
1386  * @param[in] num_surfaces      the number of surfaces to create
1387  * @param[in] attrib_list       the list of (optional) attributes, or \c NULL
1388  * @param[in] num_attribs       the number of attributes supplied in
1389  *     \c attrib_list, or zero
1390  */
1391 VAStatus
1392 vaCreateSurfaces(
1393     VADisplay           dpy,
1394     unsigned int        format,
1395     unsigned int        width,
1396     unsigned int        height,
1397     VASurfaceID        *surfaces,
1398     unsigned int        num_surfaces,
1399     VASurfaceAttrib    *attrib_list,
1400     unsigned int        num_attribs
1401 );
1402     
1403 /**
1404  * vaDestroySurfaces - Destroy resources associated with surfaces. 
1405  *  Surfaces can only be destroyed after all contexts using these surfaces have been
1406  *  destroyed.  
1407  *  dpy: display
1408  *  surfaces: array of surfaces to destroy
1409  *  num_surfaces: number of surfaces in the array to be destroyed.
1410  */
1411 VAStatus vaDestroySurfaces (
1412     VADisplay dpy,
1413     VASurfaceID *surfaces,
1414     int num_surfaces
1415 );
1416
1417 #define VA_PROGRESSIVE 0x1
1418 /**
1419  * vaCreateContext - Create a context
1420  *  dpy: display
1421  *  config_id: configuration for the context
1422  *  picture_width: coded picture width
1423  *  picture_height: coded picture height
1424  *  flag: any combination of the following:
1425  *    VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
1426  *  render_targets: a hint for render targets (surfaces) tied to the context
1427  *  num_render_targets: number of render targets in the above array
1428  *  context: created context id upon return
1429  */
1430 VAStatus vaCreateContext (
1431     VADisplay dpy,
1432     VAConfigID config_id,
1433     int picture_width,
1434     int picture_height,
1435     int flag,
1436     VASurfaceID *render_targets,
1437     int num_render_targets,
1438     VAContextID *context                /* out */
1439 );
1440
1441 /**
1442  * vaDestroyContext - Destroy a context 
1443  *  dpy: display
1444  *  context: context to be destroyed
1445  */
1446 VAStatus vaDestroyContext (
1447     VADisplay dpy,
1448     VAContextID context
1449 );
1450
1451 //Multi-frame context
1452 typedef VAGenericID VAMFContextID;
1453 /**
1454  * vaCreateMFContext - Create a multi-frame context
1455  *  interface encapsulating common for all streams memory objects and structures
1456  *  required for single GPU task submission from several VAContextID's.
1457  *  Allocation: This call only creates an instance, doesn't allocate any additional memory.
1458  *  Support identification: Application can identify multi-frame feature support by ability
1459  *  to create multi-frame context. If driver supports multi-frame - call successful,
1460  *  mf_context != NULL and VAStatus = VA_STATUS_SUCCESS, otherwise if multi-frame processing
1461  *  not supported driver returns VA_STATUS_ERROR_UNIMPLEMENTED and mf_context = NULL.
1462  *  return values:
1463  *  VA_STATUS_SUCCESS - operation successful.
1464  *  VA_STATUS_ERROR_UNIMPLEMENTED - no support for multi-frame.
1465  *  dpy: display adapter.
1466  *  mf_context: Multi-Frame context encapsulating all associated context
1467  *  for multi-frame submission.
1468  */
1469 VAStatus vaCreateMFContext (
1470     VADisplay dpy,
1471     VAMFContextID *mf_context    /* out */
1472 );
1473
1474 /**
1475  * vaMFAddContext - Provide ability to associate each context used for
1476  *  Multi-Frame submission and common Multi-Frame context.
1477  *  Try to add context to understand if it is supported.
1478  *  Allocation: this call allocates and/or reallocates all memory objects
1479  *  common for all contexts associated with particular Multi-Frame context.
1480  *  All memory required for each context(pixel buffers, internal driver
1481  *  buffers required for processing) allocated during standard vaCreateContext call for each context.
1482  *  Runtime dependency - if current implementation doesn't allow to run different entry points/profile,
1483  *  first context added will set entry point/profile for whole Multi-Frame context,
1484  *  all other entry points and profiles can be rejected to be added.
1485  *  Return values:
1486  *  VA_STATUS_SUCCESS - operation successful, context was added.
1487  *  VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened - application have to close
1488  *  current mf_context and associated contexts and start working with new ones.
1489  *  VA_STATUS_ERROR_INVALID_CONTEXT - ContextID is invalid, means:
1490  *  1 - mf_context is not valid context or
1491  *  2 - driver can't suport different VAEntrypoint or VAProfile simultaneosly
1492  *  and current context contradicts with previously added, application can continue with current mf_context
1493  *  and other contexts passed this call, rejected context can continue work in stand-alone
1494  *  mode or other mf_context.
1495  *  VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT - particular context being added was created with with
1496  *  unsupported VAEntrypoint. Application can continue with current mf_context
1497  *  and other contexts passed this call, rejected context can continue work in stand-alone
1498  *  mode.
1499  *  VA_STATUS_ERROR_UNSUPPORTED_PROFILE - Current context with Particular VAEntrypoint is supported
1500  *  but VAProfile is not supported. Application can continue with current mf_context
1501  *  and other contexts passed this call, rejected context can continue work in stand-alone
1502  *  mode.
1503  *  dpy: display adapter.
1504  *  context: context being associated with Multi-Frame context.
1505  *  mf_context: - multi-frame context used to associate contexts for multi-frame submission.
1506  */
1507 VAStatus vaMFAddContext (
1508     VADisplay dpy,
1509     VAMFContextID mf_context,
1510     VAContextID context
1511 );
1512
1513 /**
1514  * vaMFReleaseContext - Removes context from multi-frame and
1515  *  association with multi-frame context.
1516  *  After association removed vaEndPicture will submit tasks, but not vaMFSubmit.
1517  *  Return values:
1518  *  VA_STATUS_SUCCESS - operation successful, context was removed.
1519  *  VA_STATUS_ERROR_OPERATION_FAILED - something unexpected happened.
1520  *  application need to destroy this VAMFContextID and all assotiated VAContextID
1521  *  dpy: display
1522  *  mf_context: VAMFContextID where context is added
1523  *  context: VAContextID to be added
1524  */
1525 VAStatus vaMFReleaseContext (
1526     VADisplay dpy,
1527     VAMFContextID mf_context,
1528     VAContextID context
1529 );
1530
1531 /**
1532  * Buffers 
1533  * Buffers are used to pass various types of data from the
1534  * client to the server. The server maintains a data store
1535  * for each buffer created, and the client idenfies a buffer
1536  * through a unique buffer id assigned by the server.
1537  */
1538
1539 typedef VAGenericID VABufferID;
1540
1541 typedef enum
1542 {
1543     VAPictureParameterBufferType        = 0,
1544     VAIQMatrixBufferType                = 1,
1545     VABitPlaneBufferType                = 2,
1546     VASliceGroupMapBufferType           = 3,
1547     VASliceParameterBufferType          = 4,
1548     VASliceDataBufferType               = 5,
1549     VAMacroblockParameterBufferType     = 6,
1550     VAResidualDataBufferType            = 7,
1551     VADeblockingParameterBufferType     = 8,
1552     VAImageBufferType                   = 9,
1553     VAProtectedSliceDataBufferType      = 10,
1554     VAQMatrixBufferType                 = 11,
1555     VAHuffmanTableBufferType            = 12,
1556     VAProbabilityBufferType             = 13,
1557
1558 /* Following are encode buffer types */
1559     VAEncCodedBufferType                = 21,
1560     VAEncSequenceParameterBufferType    = 22,
1561     VAEncPictureParameterBufferType     = 23,
1562     VAEncSliceParameterBufferType       = 24,
1563     VAEncPackedHeaderParameterBufferType = 25,
1564     VAEncPackedHeaderDataBufferType     = 26,
1565     VAEncMiscParameterBufferType        = 27,
1566     VAEncMacroblockParameterBufferType  = 28,
1567     VAEncMacroblockMapBufferType        = 29,
1568
1569     /**
1570      * \brief Encoding QP buffer
1571      *
1572      * This buffer contains QP per MB for encoding. Currently
1573      * VAEncQPBufferH264 is defined for H.264 encoding, see
1574      * #VAEncQPBufferH264 for details
1575      */
1576     VAEncQPBufferType                   = 30,
1577 /* Following are video processing buffer types */
1578     /**
1579      * \brief Video processing pipeline parameter buffer.
1580      *
1581      * This buffer describes the video processing pipeline. See
1582      * #VAProcPipelineParameterBuffer for details.
1583      */
1584     VAProcPipelineParameterBufferType   = 41,
1585     /**
1586      * \brief Video filter parameter buffer.
1587      *
1588      * This buffer describes the video filter parameters. All buffers
1589      * inherit from #VAProcFilterParameterBufferBase, thus including
1590      * a unique filter buffer type.
1591      *
1592      * The default buffer used by most filters is #VAProcFilterParameterBuffer.
1593      * Filters requiring advanced parameters include, but are not limited to,
1594      * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
1595      * color balance (#VAProcFilterParameterBufferColorBalance), etc.
1596      */
1597     VAProcFilterParameterBufferType     = 42,
1598     /**
1599      * \brief FEI specific buffer types
1600      */
1601     VAEncFEIMVBufferType                = 43,
1602     VAEncFEIMBCodeBufferType            = 44,
1603     VAEncFEIDistortionBufferType        = 45,
1604     VAEncFEIMBControlBufferType         = 46,
1605     VAEncFEIMVPredictorBufferType       = 47,
1606     VAStatsStatisticsParameterBufferType = 48,
1607     /** \brief Statistics output for VAEntrypointStats progressive and top field of interlaced case*/
1608     VAStatsStatisticsBufferType         = 49,
1609     /** \brief Statistics output for VAEntrypointStats bottom field of interlaced case*/
1610     VAStatsStatisticsBottomFieldBufferType = 50,
1611     VAStatsMVBufferType                 = 51,
1612     VAStatsMVPredictorBufferType        = 52,
1613     /** Force MB's to be non skip for encode.it's per-mb control buffer, The width of the MB map
1614      * Surface is (width of the Picture in MB unit) * 1 byte, multiple of 64 bytes.
1615      * The height is (height of the picture in MB unit). The picture is either
1616      * frame or non-interleaved top or bottom field.  If the application provides this
1617      *surface, it will override the "skipCheckDisable" setting in VAEncMiscParameterEncQuality.
1618      */
1619     VAEncMacroblockDisableSkipMapBufferType = 53,
1620     /**
1621      * \brief HEVC FEI CTB level cmd buffer
1622      * it is CTB level information for future usage.
1623      */
1624     VAEncFEICTBCmdBufferType            = 54,
1625     /**
1626      * \brief HEVC FEI CU level data buffer
1627      * it's CTB level information for future usage
1628      */
1629     VAEncFEICURecordBufferType          = 55,
1630     /** decode stream out buffer, intermedia data of decode, it may include MV, MB mode etc.
1631       * it can be used to detect motion and analyze the frame contain  */
1632     VADecodeStreamoutBufferType             = 56,
1633     VABufferTypeMax
1634 } VABufferType;
1635
1636 /**
1637  * Processing rate parameter for encode.
1638  */
1639 typedef struct _VAProcessingRateParameterEnc {
1640     /** \brief Profile level */
1641     uint8_t         level_idc;
1642     uint8_t         reserved[3];
1643     /** \brief quality level. When set to 0, default quality
1644      * level is used.
1645      */
1646     uint32_t        quality_level;
1647     /** \brief Period between I frames. */
1648     uint32_t        intra_period;
1649     /** \brief Period between I/P frames. */
1650     uint32_t        ip_period;
1651 } VAProcessingRateParameterEnc;
1652
1653 /**
1654  * Processing rate parameter for decode.
1655  */
1656 typedef struct _VAProcessingRateParameterDec {
1657     /** \brief Profile level */
1658     uint8_t         level_idc;
1659     uint8_t         reserved0[3];
1660     uint32_t        reserved;
1661 } VAProcessingRateParameterDec;
1662
1663 typedef struct _VAProcessingRateParameter {
1664     union {
1665         VAProcessingRateParameterEnc proc_buf_enc;
1666         VAProcessingRateParameterDec proc_buf_dec;
1667     };
1668 } VAProcessingRateParameter;
1669
1670 /**
1671  * \brief Queries processing rate for the supplied config.
1672  *
1673  * This function queries the processing rate based on parameters in
1674  * \c proc_buf for the given \c config. Upon successful return, the processing
1675  * rate value will be stored in \c processing_rate. Processing rate is
1676  * specified as the number of macroblocks/CTU per second.
1677  *
1678  * If NULL is passed to the \c proc_buf, the default processing rate for the
1679  * given configuration will be returned.
1680  *
1681  * @param[in] dpy               the VA display
1682  * @param[in] config            the config identifying a codec or a video
1683  *     processing pipeline
1684  * @param[in] proc_buf       the buffer that contains the parameters for
1685         either the encode or decode processing rate
1686  * @param[out] processing_rate  processing rate in number of macroblocks per
1687         second constrained by parameters specified in proc_buf
1688  *
1689  */
1690 VAStatus
1691 vaQueryProcessingRate(
1692     VADisplay           dpy,
1693     VAConfigID          config,
1694     VAProcessingRateParameter *proc_buf,
1695     unsigned int       *processing_rate
1696 );
1697
1698 typedef enum
1699 {
1700     VAEncMiscParameterTypeFrameRate     = 0,
1701     VAEncMiscParameterTypeRateControl   = 1,
1702     VAEncMiscParameterTypeMaxSliceSize  = 2,
1703     VAEncMiscParameterTypeAIR           = 3,
1704     /** \brief Buffer type used to express a maximum frame size (in bits). */
1705     VAEncMiscParameterTypeMaxFrameSize  = 4,
1706     /** \brief Buffer type used for HRD parameters. */
1707     VAEncMiscParameterTypeHRD           = 5,
1708     VAEncMiscParameterTypeQualityLevel  = 6,
1709     /** \brief Buffer type used for Rolling intra refresh */
1710     VAEncMiscParameterTypeRIR           = 7,
1711     /** \brief Buffer type used for quantization parameters, it's per-sequence parameter*/
1712     VAEncMiscParameterTypeQuantization  = 8,
1713     /** \brief Buffer type used for sending skip frame parameters to the encoder's
1714       * rate control, when the user has externally skipped frames. */
1715     VAEncMiscParameterTypeSkipFrame     = 9,
1716     /** \brief Buffer type used for region-of-interest (ROI) parameters. */
1717     VAEncMiscParameterTypeROI           = 10,
1718     /** \brief Buffer type used for temporal layer structure */
1719     VAEncMiscParameterTypeTemporalLayerStructure   = 12,
1720     /** \brief Buffer type used for dirty region-of-interest (ROI) parameters. */
1721     VAEncMiscParameterTypeDirtyRect      = 13,
1722     /** \brief Buffer type used for parallel BRC parameters. */
1723     VAEncMiscParameterTypeParallelBRC   = 14,
1724     /** \brief Set MB partion mode mask and Half-pel/Quant-pel motion search */
1725     VAEncMiscParameterTypeSubMbPartPel = 15,
1726     /** \brief set encode quality tuning */
1727     VAEncMiscParameterTypeEncQuality = 16,
1728     /** \brief Buffer type used for encoder rounding offset parameters. */
1729     VAEncMiscParameterTypeCustomRoundingControl = 17,
1730     /** \brief Buffer type used for FEI input frame level parameters */
1731     VAEncMiscParameterTypeFEIFrameControl = 18,
1732     /** \brief encode extension buffer, ect. MPEG2 Sequence extenstion data */
1733     VAEncMiscParameterTypeExtensionData = 19
1734 } VAEncMiscParameterType;
1735
1736 /** \brief Packed header type. */
1737 typedef enum {
1738     /** \brief Packed sequence header. */
1739     VAEncPackedHeaderSequence   = 1,
1740     /** \brief Packed picture header. */
1741     VAEncPackedHeaderPicture    = 2,
1742     /** \brief Packed slice header. */
1743     VAEncPackedHeaderSlice      = 3,
1744     /** 
1745      * \brief Packed raw header. 
1746      * 
1747      * Packed raw data header can be used by the client to insert a header  
1748      * into the bitstream data buffer at the point it is passed, the driver 
1749      * will handle the raw packed header based on "has_emulation_bytes" field
1750      * in the packed header parameter structure.
1751      */
1752     VAEncPackedHeaderRawData    = 4,
1753     /**
1754      * \brief Misc packed header. See codec-specific definitions.
1755      *
1756      * @deprecated
1757      * This is a deprecated packed header type. All applications can use
1758      * \c VAEncPackedHeaderRawData to insert a codec-specific packed header
1759      */
1760     VAEncPackedHeaderMiscMask va_deprecated_enum  = 0x80000000,
1761 } VAEncPackedHeaderType;
1762
1763 /** \brief Packed header parameter. */
1764 typedef struct _VAEncPackedHeaderParameterBuffer {
1765     /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
1766     uint32_t                type;
1767     /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
1768     uint32_t                bit_length;
1769     /** \brief Flag: buffer contains start code emulation prevention bytes? */
1770     uint8_t               has_emulation_bytes;
1771
1772     /** \brief Reserved bytes for future use, must be zero */
1773     uint32_t                va_reserved[VA_PADDING_LOW];
1774 } VAEncPackedHeaderParameterBuffer;
1775
1776 /**
1777  *  For application, e.g. set a new bitrate
1778  *    VABufferID buf_id;
1779  *    VAEncMiscParameterBuffer *misc_param;
1780  *    VAEncMiscParameterRateControl *misc_rate_ctrl;
1781  * 
1782  *    vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
1783  *              sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
1784  *              1, NULL, &buf_id);
1785  *
1786  *    vaMapBuffer(dpy,buf_id,(void **)&misc_param);
1787  *    misc_param->type = VAEncMiscParameterTypeRateControl;
1788  *    misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
1789  *    misc_rate_ctrl->bits_per_second = 6400000;
1790  *    vaUnmapBuffer(dpy, buf_id);
1791  *    vaRenderPicture(dpy, context, &buf_id, 1);
1792  */
1793 typedef struct _VAEncMiscParameterBuffer
1794 {
1795     VAEncMiscParameterType type;
1796     uint32_t data[];
1797 } VAEncMiscParameterBuffer;
1798
1799 /** \brief Temporal layer Structure*/
1800 typedef struct _VAEncMiscParameterTemporalLayerStructure
1801 {
1802     /** \brief The number of temporal layers */
1803     uint32_t number_of_layers;
1804     /** \brief The length of the array defining frame layer membership. Should be 1-32 */
1805     uint32_t periodicity;
1806     /**
1807      * \brief The array indicating the layer id for each frame
1808      *
1809      * The layer id for the first frame in a coded sequence is always 0, so layer_id[] specifies the layer
1810      * ids for frames starting from the 2nd frame.
1811      */
1812     uint32_t layer_id[32];
1813
1814     /** \brief Reserved bytes for future use, must be zero */
1815     uint32_t                va_reserved[VA_PADDING_LOW];
1816 } VAEncMiscParameterTemporalLayerStructure;
1817
1818
1819 /** \brief Rate control parameters */
1820 typedef struct _VAEncMiscParameterRateControl
1821 {
1822     /* this is the maximum bit-rate to be constrained by the rate control implementation */
1823     uint32_t bits_per_second;
1824     /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
1825      * bit-rate for example if target_percentage is 95 then the rate control will target
1826      * a bit-rate that is 95% of the maximum bit-rate
1827      */
1828     uint32_t target_percentage;
1829     /* windows size in milliseconds. For example if this is set to 500,
1830      * then the rate control will guarantee the target bit-rate over a 500 ms window
1831      */
1832     uint32_t window_size;
1833     /* initial QP at I frames */
1834     uint32_t initial_qp;
1835     uint32_t min_qp;
1836     uint32_t basic_unit_size;
1837     union
1838     {
1839         struct
1840         {
1841             uint32_t reset : 1;
1842             uint32_t disable_frame_skip : 1; /* Disable frame skip in rate control mode */
1843             uint32_t disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
1844             uint32_t mb_rate_control : 4; /* Control VA_RC_MB 0: default, 1: enable, 2: disable, other: reserved*/
1845             /*
1846              * The temporal layer that the rate control parameters are specified for.
1847              */
1848             uint32_t temporal_id : 8;
1849             uint32_t cfs_I_frames : 1; /* I frame also follows CFS */
1850             uint32_t enable_parallel_brc    : 1;
1851             uint32_t enable_dynamic_scaling : 1;
1852              /**  \brief Frame Tolerance Mode
1853              *  Indicates the tolerance the application has to variations in the frame size.
1854              *  For example, wireless display scenarios may require very steady bit rate to
1855              *  reduce buffering time. It affects the rate control algorithm used,
1856              *  but may or may not have an effect based on the combination of other BRC
1857              *  parameters.  Only valid when the driver reports support for
1858              *  #VAConfigAttribFrameSizeToleranceSupport.
1859              *
1860              *  equals 0    -- normal mode;
1861              *  equals 1    -- maps to sliding window;
1862              *  equals 2    -- maps to low delay mode;
1863              *  other       -- invalid.
1864              */
1865             uint32_t frame_tolerance_mode   : 2;
1866             uint32_t reserved               : 12;
1867         } bits;
1868         uint32_t value;
1869     } rc_flags;
1870     uint32_t ICQ_quality_factor; /* Initial ICQ quality factor: 1-51. */
1871     /** \brief Reserved bytes for future use, must be zero */
1872     uint32_t max_qp;
1873     uint32_t va_reserved[VA_PADDING_MEDIUM - 2];
1874 } VAEncMiscParameterRateControl;
1875
1876 typedef struct _VAEncMiscParameterFrameRate
1877 {
1878     /*
1879      * The framerate is specified as a number of frames per second, as a
1880      * fraction.  The denominator of the fraction is given in the top half
1881      * (the high two bytes) of the framerate field, and the numerator is
1882      * given in the bottom half (the low two bytes).
1883      *
1884      * That is:
1885      * denominator = framerate >> 16 & 0xffff;
1886      * numerator   = framerate & 0xffff;
1887      * fps         = numerator / denominator;
1888      *
1889      * For example, if framerate is set to (100 << 16 | 750), this is
1890      * 750 / 100, hence 7.5fps.
1891      *
1892      * If the denominator is zero (the high two bytes are both zero) then
1893      * it takes the value one instead, so the framerate is just the integer
1894      * in the low 2 bytes.
1895      */
1896     uint32_t framerate;
1897     union
1898     {
1899         struct
1900         {
1901             /*
1902              * The temporal id the framerate parameters are specified for.
1903              */
1904             uint32_t temporal_id : 8;
1905             uint32_t reserved : 24;
1906          } bits;
1907          uint32_t value;
1908      } framerate_flags;
1909
1910     /** \brief Reserved bytes for future use, must be zero */
1911     uint32_t                va_reserved[VA_PADDING_LOW];
1912 } VAEncMiscParameterFrameRate;
1913
1914 /**
1915  * Allow a maximum slice size to be specified (in bits).
1916  * The encoder will attempt to make sure that individual slices do not exceed this size
1917  * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
1918  */
1919 typedef struct _VAEncMiscParameterMaxSliceSize
1920 {
1921     uint32_t max_slice_size;
1922
1923     /** \brief Reserved bytes for future use, must be zero */
1924     uint32_t                va_reserved[VA_PADDING_LOW];
1925 } VAEncMiscParameterMaxSliceSize;
1926
1927 typedef struct _VAEncMiscParameterAIR
1928 {
1929     uint32_t air_num_mbs;
1930     uint32_t air_threshold;
1931     uint32_t air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
1932
1933     /** \brief Reserved bytes for future use, must be zero */
1934     uint32_t                va_reserved[VA_PADDING_LOW];
1935 } VAEncMiscParameterAIR;
1936
1937 /*
1938  * \brief Rolling intra refresh data structure for encoding.
1939  */
1940 typedef struct _VAEncMiscParameterRIR
1941 {
1942     union
1943     {
1944         struct
1945         /**
1946          * \brief Indicate if intra refresh is enabled in column/row.
1947          *
1948          * App should query VAConfigAttribEncIntraRefresh to confirm RIR support
1949          * by the driver before sending this structure.
1950          */
1951         {
1952             /* \brief enable RIR in column */
1953             uint32_t enable_rir_column : 1;
1954             /* \brief enable RIR in row */
1955             uint32_t enable_rir_row : 1;
1956             uint32_t reserved : 30;
1957         } bits;
1958         uint32_t value;
1959     } rir_flags;
1960     /**
1961      * \brief Indicates the column or row location in MB. It is ignored if
1962      * rir_flags is 0.
1963      */
1964     uint16_t intra_insertion_location;
1965     /**
1966      * \brief Indicates the number of columns or rows in MB. It is ignored if
1967      * rir_flags is 0.
1968      */
1969     uint16_t intra_insert_size;
1970     /**
1971      * \brief indicates the Qp difference for inserted intra columns or rows.
1972      * App can use this to adjust intra Qp based on bitrate & max frame size.
1973      */
1974     uint8_t  qp_delta_for_inserted_intra;
1975     /** \brief Reserved bytes for future use, must be zero */
1976     uint32_t                va_reserved[VA_PADDING_LOW];
1977 } VAEncMiscParameterRIR;
1978
1979 typedef struct _VAEncMiscParameterHRD
1980 {
1981     uint32_t initial_buffer_fullness;       /* in bits */
1982     uint32_t buffer_size;                   /* in bits */
1983
1984     /** \brief Reserved bytes for future use, must be zero */
1985     uint32_t                va_reserved[VA_PADDING_LOW];
1986 } VAEncMiscParameterHRD;
1987
1988 /**
1989  * \brief Defines a maximum frame size (in bits).
1990  *
1991  * This misc parameter buffer defines the maximum size of a frame (in
1992  * bits). The encoder will try to make sure that each frame does not
1993  * exceed this size. Otherwise, if the frame size exceeds this size,
1994  * the \c status flag of #VACodedBufferSegment will contain
1995  * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
1996  */
1997 typedef struct _VAEncMiscParameterBufferMaxFrameSize {
1998     /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
1999     VAEncMiscParameterType      type;
2000     /** \brief Maximum size of a frame (in bits). */
2001     uint32_t                max_frame_size;
2002
2003     /** \brief Reserved bytes for future use, must be zero */
2004     uint32_t                va_reserved[VA_PADDING_LOW];
2005 } VAEncMiscParameterBufferMaxFrameSize;
2006
2007 /**
2008  * \brief Encoding quality level.
2009  *
2010  * The encoding quality could be set through this structure, if the implementation  
2011  * supports multiple quality levels. The quality level set through this structure is 
2012  * persistent over the entire coded sequence, or until a new structure is being sent.
2013  * The quality level range can be queried through the VAConfigAttribEncQualityRange 
2014  * attribute. A lower value means higher quality, and a value of 1 represents the highest 
2015  * quality. The quality level setting is used as a trade-off between quality and speed/power 
2016  * consumption, with higher quality corresponds to lower speed and higher power consumption. 
2017  */
2018 typedef struct _VAEncMiscParameterBufferQualityLevel {
2019     /** \brief Encoding quality level setting. When set to 0, default quality
2020      * level is used.
2021      */
2022     uint32_t                quality_level;
2023
2024     /** \brief Reserved bytes for future use, must be zero */
2025     uint32_t                va_reserved[VA_PADDING_LOW];
2026 } VAEncMiscParameterBufferQualityLevel;
2027
2028 /**
2029  * \brief Quantization settings for encoding.
2030  *
2031  * Some encoders support special types of quantization such as trellis, and this structure
2032  * can be used by the app to control these special types of quantization by the encoder.
2033  */
2034 typedef struct _VAEncMiscParameterQuantization
2035 {
2036     union
2037     {
2038     /* if no flags is set then quantization is determined by the driver */
2039         struct
2040         {
2041             /* \brief disable trellis for all frames/fields */
2042             uint64_t disable_trellis : 1;
2043             /* \brief enable trellis for I frames/fields */
2044             uint64_t enable_trellis_I : 1;
2045             /* \brief enable trellis for P frames/fields */
2046             uint64_t enable_trellis_P : 1;
2047             /* \brief enable trellis for B frames/fields */
2048             uint64_t enable_trellis_B : 1;
2049             uint64_t reserved : 28;
2050         } bits;
2051         uint64_t value;
2052     } quantization_flags;
2053 } VAEncMiscParameterQuantization;
2054
2055 /**
2056  * \brief Encoding skip frame.
2057  *
2058  * The application may choose to skip frames externally to the encoder (e.g. drop completely or 
2059  * code as all skip's). For rate control purposes the encoder will need to know the size and number 
2060  * of skipped frames.  Skip frame(s) indicated through this structure is applicable only to the 
2061  * current frame.  It is allowed for the application to still send in packed headers for the driver to 
2062  * pack, although no frame will be encoded (e.g. for HW to encrypt the frame).  
2063  */
2064 typedef struct _VAEncMiscParameterSkipFrame {
2065     /** \brief Indicates skip frames as below.
2066       * 0: Encode as normal, no skip.
2067       * 1: One or more frames were skipped prior to the current frame, encode the current frame as normal.  
2068       * 2: The current frame is to be skipped, do not encode it but pack/encrypt the packed header contents
2069       *    (all except VAEncPackedHeaderSlice) which could contain actual frame contents (e.g. pack the frame 
2070       *    in VAEncPackedHeaderPicture).  */
2071     uint8_t               skip_frame_flag;
2072     /** \brief The number of frames skipped prior to the current frame.  Valid when skip_frame_flag = 1. */
2073     uint8_t               num_skip_frames;
2074     /** \brief When skip_frame_flag = 1, the size of the skipped frames in bits.   When skip_frame_flag = 2, 
2075       * the size of the current skipped frame that is to be packed/encrypted in bits. */
2076     uint32_t                size_skip_frames;
2077
2078     /** \brief Reserved bytes for future use, must be zero */
2079     uint32_t                va_reserved[VA_PADDING_LOW];
2080 } VAEncMiscParameterSkipFrame;
2081
2082 /**
2083  * \brief Encoding region-of-interest (ROI).
2084  *
2085  * The encoding ROI can be set through VAEncMiscParameterBufferROI, if the implementation
2086  * supports ROI input. The ROI set through this structure is applicable only to the
2087  * current frame or field, so must be sent every frame or field to be applied.  The number of
2088  * supported ROIs can be queried through the VAConfigAttribEncROI.  The encoder will use the
2089  * ROI information to adjust the QP values of the MB's that fall within the ROIs.
2090  */
2091 typedef struct _VAEncROI
2092 {
2093         /** \brief Defines the ROI boundary in pixels, the driver will map it to appropriate
2094          *  codec coding units.  It is relative to frame coordinates for the frame case and
2095          *  to field coordinates for the field case. */
2096         VARectangle     roi_rectangle;
2097         /**
2098          * \brief ROI value
2099          *
2100          * \ref roi_value specifies ROI delta QP or ROI priority.
2101          * --  ROI delta QP is the value that will be added on top of the frame level QP.
2102          * --  ROI priority specifies the priority of a region, it can be positive (more important)
2103          * or negative (less important) values and is compared with non-ROI region (taken as value 0),
2104          * E.g. ROI region with \ref roi_value -3 is less important than the non-ROI region (\ref roi_value
2105          * implied to be 0) which is less important than ROI region with roi_value +2. For overlapping
2106          * regions, the roi_value that is first in the ROI array will have priority.
2107          *
2108          * \ref roi_value always specifes ROI delta QP when VAConfigAttribRateControl == VA_RC_CQP, no matter
2109          * the value of \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI.
2110          *
2111          * \ref roi_value depends on \c roi_value_is_qp_delta in #VAEncMiscParameterBufferROI when
2112          * VAConfigAttribRateControl != VA_RC_CQP. \ref roi_value specifies ROI_delta QP if \c roi_value_is_qp_delta
2113          * in VAEncMiscParameterBufferROI is 1, otherwise \ref roi_value specifies ROI priority.
2114          */
2115         int8_t            roi_value;
2116 } VAEncROI;
2117
2118 typedef struct _VAEncMiscParameterBufferROI {
2119     /** \brief Number of ROIs being sent.*/
2120     uint32_t        num_roi;
2121
2122     /** \brief Valid when VAConfigAttribRateControl != VA_RC_CQP, then the encoder's
2123      *  rate control will determine actual delta QPs.  Specifies the max/min allowed delta
2124      *  QPs. */
2125     int8_t                max_delta_qp;
2126     int8_t                min_delta_qp;
2127
2128    /** \brief Pointer to a VAEncROI array with num_roi elements.  It is relative to frame
2129      *  coordinates for the frame case and to field coordinates for the field case.*/
2130     VAEncROI            *roi;
2131     union {
2132         struct {
2133             /**
2134              * \brief An indication for roi value.
2135              *
2136              * \ref roi_value_is_qp_delta equal to 1 indicates \c roi_value in #VAEncROI should
2137              * be used as ROI delta QP. \ref roi_value_is_qp_delta equal to 0 indicates \c roi_value
2138              * in #VAEncROI should be used as ROI priority.
2139              *
2140              * \ref roi_value_is_qp_delta is only available when VAConfigAttribRateControl != VA_RC_CQP,
2141              * the setting must comply with \c roi_rc_priority_support and \c roi_rc_qp_delta_support in
2142              * #VAConfigAttribValEncROI. The underlying driver should ignore this field
2143              * when VAConfigAttribRateControl == VA_RC_CQP.
2144              */
2145             uint32_t  roi_value_is_qp_delta    : 1;
2146             uint32_t  reserved                 : 31;
2147         } bits;
2148         uint32_t value;
2149     } roi_flags;
2150
2151     /** \brief Reserved bytes for future use, must be zero */
2152     uint32_t                va_reserved[VA_PADDING_LOW];
2153 } VAEncMiscParameterBufferROI;
2154 /*
2155  * \brief Dirty rectangle data structure for encoding.
2156  *
2157  * The encoding dirty rect can be set through VAEncMiscParameterBufferDirtyRect, if the
2158  * implementation supports dirty rect input. The rect set through this structure is applicable
2159  * only to the current frame or field, so must be sent every frame or field to be applied.
2160  * The number of supported rects can be queried through the VAConfigAttribEncDirtyRect.  The
2161  * encoder will use the rect information to know those rectangle areas have changed while the
2162  * areas not covered by dirty rect rectangles are assumed to have not changed compared to the
2163  * previous picture.  The encoder may do some internal optimizations.
2164  */
2165 typedef struct _VAEncMiscParameterBufferDirtyRect
2166 {
2167     /** \brief Number of Rectangle being sent.*/
2168     uint32_t    num_roi_rectangle;
2169
2170     /** \brief Pointer to a VARectangle array with num_roi_rectangle elements.*/
2171      VARectangle    *roi_rectangle;
2172 } VAEncMiscParameterBufferDirtyRect;
2173
2174 /** \brief Attribute value for VAConfigAttribEncParallelRateControl */
2175 typedef struct _VAEncMiscParameterParallelRateControl {
2176     /** brief Number of layers*/
2177     uint32_t num_layers;
2178     /** brief Number of B frames per layer per GOP.
2179      *
2180      * it should be allocated by application, and the is num_layers.
2181      *  num_b_in_gop[0] is the number of regular B which refers to only I or P frames. */
2182     uint32_t *num_b_in_gop;
2183 } VAEncMiscParameterParallelRateControl;
2184
2185 /** per frame encoder quality controls, once set they will persist for all future frames
2186   *till it is updated again. */
2187 typedef struct _VAEncMiscParameterEncQuality
2188 {
2189     union
2190     {
2191         struct
2192         {
2193             /** Use raw frames for reference instead of reconstructed frames.
2194               * it only impact motion estimation (ME)  stage, and will not impact MC stage
2195               * so the reconstruct picture will can match with decode side */
2196             uint32_t useRawPicForRef                    : 1;
2197             /**  Disables skip check for ME stage, it will increase the bistream size
2198               * but will improve the qulity */
2199             uint32_t skipCheckDisable                   : 1;
2200             /**  Indicates app will override default driver FTQ settings using FTQEnable.
2201               *  FTQ is forward transform quantization */
2202             uint32_t FTQOverride                        : 1;
2203             /** Enables/disables FTQ. */
2204             uint32_t FTQEnable                          : 1;
2205             /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2206               * enabled (FTQSkipThresholdLUT), else default driver thresholds will be used. */
2207             uint32_t FTQSkipThresholdLUTInput           : 1;
2208             /** Indicates the app will provide the Skip Threshold LUT to use when FTQ is
2209               * disabled (NonFTQSkipThresholdLUT), else default driver thresholds will be used. */
2210             uint32_t NonFTQSkipThresholdLUTInput        : 1;
2211             uint32_t ReservedBit                        : 1;
2212             /** Control to enable the ME mode decision algorithm to bias to fewer B Direct/Skip types.
2213               * Applies only to B frames, all other frames will ignore this setting.  */
2214             uint32_t directBiasAdjustmentEnable         : 1;
2215             /** Enables global motion bias. global motion also is called HME (Heirarchical Motion Estimation )
2216               * HME is used to handle large motions and avoiding local minima in the video encoding process
2217               * down scaled the input and reference picture, then do ME. the result will be a predictor to next level HME or ME
2218               * current interface divide the HME to 3 level. UltraHME , SuperHME, and HME, result of UltraHME will be input of SurperHME,
2219               * result of superHME will be a input for HME. HME result will be input of ME. it is a switch for HMEMVCostScalingFactor
2220               * can change the HME bias inside RDO stage*/
2221             uint32_t globalMotionBiasAdjustmentEnable   : 1;
2222             /** MV cost scaling ratio for HME ( predictors.  It is used when
2223               * globalMotionBiasAdjustmentEnable == 1, else it is ignored.  Values are:
2224               *     0: set MV cost to be 0 for HME predictor.
2225               *     1: scale MV cost to be 1/2 of the default value for HME predictor.
2226               *     2: scale MV cost to be 1/4 of the default value for HME predictor.
2227               *     3: scale MV cost to be 1/8 of the default value for HME predictor. */
2228             uint32_t HMEMVCostScalingFactor             : 2;
2229             /**disable HME, if it is disabled. Super*ultraHME should also be disabled  */
2230             uint32_t HMEDisable                         : 1;
2231             /**disable Super HME, if it is disabled, ultraHME should be disabled */
2232             uint32_t SuperHMEDisable                    : 1;
2233             /** disable Ultra HME */
2234             uint32_t UltraHMEDisable                    : 1;
2235             /** disable panic mode. Panic mode happened when there are extreme BRC (bit rate control) requirement
2236               * frame size cant achieve the target of BRC.  when Panic mode is triggered, Coefficients will
2237               *  be set to zero. disable panic mode will improve quality but will impact BRC */
2238             uint32_t PanicModeDisable                   : 1;
2239             /** Force RepartitionCheck
2240              *  0: DEFAULT - follow driver default settings.
2241              *  1: FORCE_ENABLE - enable this feature totally for all cases.
2242              *  2: FORCE_DISABLE - disable this feature totally for all cases. */
2243             uint32_t ForceRepartitionCheck              : 2;
2244
2245         };
2246         uint32_t encControls;
2247     };
2248
2249     /** Maps QP to skip thresholds when FTQ is enabled.  Valid range is 0-255. */
2250     uint8_t FTQSkipThresholdLUT[52];
2251     /** Maps QP to skip thresholds when FTQ is disabled.  Valid range is 0-65535. */
2252     uint16_t NonFTQSkipThresholdLUT[52];
2253
2254     uint32_t reserved[VA_PADDING_HIGH];  // Reserved for future use.
2255
2256 } VAEncMiscParameterEncQuality;
2257
2258 /**
2259  *  \brief Custom Encoder Rounding Offset Control.
2260  *  Application may use this structure to set customized rounding
2261  *  offset parameters for quantization.
2262  *  Valid when \c VAConfigAttribCustomRoundingControl equals 1.
2263  */
2264 typedef struct _VAEncMiscParameterCustomRoundingControl
2265 {
2266     union {
2267         struct {
2268             /** \brief Enable customized rounding offset for intra blocks.
2269              *  If 0, default value would be taken by driver for intra
2270              *  rounding offset.
2271              */
2272             uint32_t    enable_custom_rouding_intra     : 1 ;
2273
2274             /** \brief Intra rounding offset
2275              *  Ignored if \c enable_custom_rouding_intra equals 0.
2276              */
2277             uint32_t    rounding_offset_intra           : 7;
2278
2279             /** \brief Enable customized rounding offset for inter blocks.
2280              *  If 0, default value would be taken by driver for inter
2281              *  rounding offset.
2282              */
2283             uint32_t    enable_custom_rounding_inter    : 1 ;
2284
2285             /** \brief Inter rounding offset
2286              *  Ignored if \c enable_custom_rouding_inter equals 0.
2287              */
2288             uint32_t    rounding_offset_inter           : 7;
2289
2290            /* Reserved */
2291             uint32_t    reserved                        :16;
2292         }  bits;
2293         uint32_t    value;
2294     }   rounding_offset_setting;
2295 } VAEncMiscParameterCustomRoundingControl;
2296 /**
2297  * There will be cases where the bitstream buffer will not have enough room to hold
2298  * the data for the entire slice, and the following flags will be used in the slice
2299  * parameter to signal to the server for the possible cases.
2300  * If a slice parameter buffer and slice data buffer pair is sent to the server with 
2301  * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below), 
2302  * then a slice parameter and data buffer needs to be sent again to complete this slice. 
2303  */
2304 #define VA_SLICE_DATA_FLAG_ALL          0x00    /* whole slice is in the buffer */
2305 #define VA_SLICE_DATA_FLAG_BEGIN        0x01    /* The beginning of the slice is in the buffer but the end if not */
2306 #define VA_SLICE_DATA_FLAG_MIDDLE       0x02    /* Neither beginning nor end of the slice is in the buffer */
2307 #define VA_SLICE_DATA_FLAG_END          0x04    /* end of the slice is in the buffer */
2308
2309 /* Codec-independent Slice Parameter Buffer base */
2310 typedef struct _VASliceParameterBufferBase
2311 {
2312     uint32_t slice_data_size;   /* number of bytes in the slice data buffer for this slice */
2313     uint32_t slice_data_offset; /* the offset to the first byte of slice data */
2314     uint32_t slice_data_flag;   /* see VA_SLICE_DATA_FLAG_XXX definitions */
2315 } VASliceParameterBufferBase;
2316
2317 /**********************************
2318  * JPEG common  data structures
2319  **********************************/
2320 /**
2321  * \brief Huffman table for JPEG decoding.
2322  *
2323  * This structure holds the complete Huffman tables. This is an
2324  * aggregation of all Huffman table (DHT) segments maintained by the
2325  * application. i.e. up to 2 Huffman tables are stored in there for
2326  * baseline profile.
2327  *
2328  * The #load_huffman_table array can be used as a hint to notify the
2329  * VA driver implementation about which table(s) actually changed
2330  * since the last submission of this buffer.
2331  */
2332 typedef struct _VAHuffmanTableBufferJPEGBaseline {
2333     /** \brief Specifies which #huffman_table is valid. */
2334     uint8_t       load_huffman_table[2];
2335     /** \brief Huffman tables indexed by table identifier (Th). */
2336     struct {
2337         /** @name DC table (up to 12 categories) */
2338         /**@{*/
2339         /** \brief Number of Huffman codes of length i + 1 (Li). */
2340         uint8_t   num_dc_codes[16];
2341         /** \brief Value associated with each Huffman code (Vij). */
2342         uint8_t   dc_values[12];
2343         /**@}*/
2344         /** @name AC table (2 special codes + up to 16 * 10 codes) */
2345         /**@{*/
2346         /** \brief Number of Huffman codes of length i + 1 (Li). */
2347         uint8_t   num_ac_codes[16];
2348         /** \brief Value associated with each Huffman code (Vij). */
2349         uint8_t   ac_values[162];
2350         /** \brief Padding to 4-byte boundaries. Must be set to zero. */
2351         uint8_t   pad[2];
2352         /**@}*/
2353     }                   huffman_table[2];
2354
2355     /** \brief Reserved bytes for future use, must be zero */
2356     uint32_t                va_reserved[VA_PADDING_LOW];
2357 } VAHuffmanTableBufferJPEGBaseline;
2358
2359 /****************************
2360  * MPEG-2 data structures
2361  ****************************/
2362  
2363 /* MPEG-2 Picture Parameter Buffer */
2364 /* 
2365  * For each frame or field, and before any slice data, a single
2366  * picture parameter buffer must be send.
2367  */
2368 typedef struct _VAPictureParameterBufferMPEG2
2369 {
2370     uint16_t horizontal_size;
2371     uint16_t vertical_size;
2372     VASurfaceID forward_reference_picture;
2373     VASurfaceID backward_reference_picture;
2374     /* meanings of the following fields are the same as in the standard */
2375     int32_t picture_coding_type;
2376     int32_t f_code; /* pack all four fcode into this */
2377     union {
2378         struct {
2379             uint32_t intra_dc_precision         : 2; 
2380             uint32_t picture_structure          : 2; 
2381             uint32_t top_field_first            : 1; 
2382             uint32_t frame_pred_frame_dct               : 1; 
2383             uint32_t concealment_motion_vectors : 1;
2384             uint32_t q_scale_type                       : 1;
2385             uint32_t intra_vlc_format           : 1;
2386             uint32_t alternate_scan                     : 1;
2387             uint32_t repeat_first_field         : 1;
2388             uint32_t progressive_frame          : 1;
2389             uint32_t is_first_field                     : 1; /* indicate whether the current field
2390                                                               * is the first field for field picture
2391                                                               */
2392         } bits;
2393         uint32_t value;
2394     } picture_coding_extension;
2395
2396     /** \brief Reserved bytes for future use, must be zero */
2397     uint32_t                va_reserved[VA_PADDING_LOW];
2398 } VAPictureParameterBufferMPEG2;
2399
2400 /** MPEG-2 Inverse Quantization Matrix Buffer */
2401 typedef struct _VAIQMatrixBufferMPEG2
2402 {
2403     /** \brief Same as the MPEG-2 bitstream syntax element. */
2404     int32_t load_intra_quantiser_matrix;
2405     /** \brief Same as the MPEG-2 bitstream syntax element. */
2406     int32_t load_non_intra_quantiser_matrix;
2407     /** \brief Same as the MPEG-2 bitstream syntax element. */
2408     int32_t load_chroma_intra_quantiser_matrix;
2409     /** \brief Same as the MPEG-2 bitstream syntax element. */
2410     int32_t load_chroma_non_intra_quantiser_matrix;
2411     /** \brief Luminance intra matrix, in zig-zag scan order. */
2412     uint8_t intra_quantiser_matrix[64];
2413     /** \brief Luminance non-intra matrix, in zig-zag scan order. */
2414     uint8_t non_intra_quantiser_matrix[64];
2415     /** \brief Chroma intra matrix, in zig-zag scan order. */
2416     uint8_t chroma_intra_quantiser_matrix[64];
2417     /** \brief Chroma non-intra matrix, in zig-zag scan order. */
2418     uint8_t chroma_non_intra_quantiser_matrix[64];
2419
2420     /** \brief Reserved bytes for future use, must be zero */
2421     uint32_t                va_reserved[VA_PADDING_LOW];
2422 } VAIQMatrixBufferMPEG2;
2423
2424 /** MPEG-2 Slice Parameter Buffer */
2425 typedef struct _VASliceParameterBufferMPEG2
2426 {
2427     uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2428     uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2429     uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2430     uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2431     uint32_t slice_horizontal_position;
2432     uint32_t slice_vertical_position;
2433     int32_t quantiser_scale_code;
2434     int32_t intra_slice_flag;
2435
2436     /** \brief Reserved bytes for future use, must be zero */
2437     uint32_t                va_reserved[VA_PADDING_LOW];
2438 } VASliceParameterBufferMPEG2;
2439
2440 /** MPEG-2 Macroblock Parameter Buffer */
2441 typedef struct _VAMacroblockParameterBufferMPEG2
2442 {
2443     uint16_t macroblock_address;
2444     /* 
2445      * macroblock_address (in raster scan order)
2446      * top-left: 0
2447      * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
2448      */
2449     uint8_t macroblock_type;  /* see definition below */
2450     union {
2451         struct {
2452             uint32_t frame_motion_type          : 2; 
2453             uint32_t field_motion_type          : 2; 
2454             uint32_t dct_type                   : 1; 
2455         } bits;
2456         uint32_t value;
2457     } macroblock_modes;
2458     uint8_t motion_vertical_field_select; 
2459     /* 
2460      * motion_vertical_field_select:
2461      * see section 6.3.17.2 in the spec
2462      * only the lower 4 bits are used
2463      * bit 0: first vector forward
2464      * bit 1: first vector backward
2465      * bit 2: second vector forward
2466      * bit 3: second vector backward
2467      */
2468     int16_t PMV[2][2][2]; /* see Table 7-7 in the spec */
2469     uint16_t coded_block_pattern;
2470     /* 
2471      * The bitplanes for coded_block_pattern are described 
2472      * in Figure 6.10-12 in the spec
2473      */
2474      
2475     /* Number of skipped macroblocks after this macroblock */
2476     uint16_t num_skipped_macroblocks;
2477
2478     /** \brief Reserved bytes for future use, must be zero */
2479     uint32_t                va_reserved[VA_PADDING_LOW];
2480 } VAMacroblockParameterBufferMPEG2;
2481
2482 /* 
2483  * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
2484  */
2485 #define VA_MB_TYPE_MOTION_FORWARD       0x02
2486 #define VA_MB_TYPE_MOTION_BACKWARD      0x04
2487 #define VA_MB_TYPE_MOTION_PATTERN       0x08
2488 #define VA_MB_TYPE_MOTION_INTRA         0x10
2489
2490 /**
2491  * MPEG-2 Residual Data Buffer 
2492  * For each macroblock, there wil be 64 shorts (16-bit) in the 
2493  * residual data buffer
2494  */
2495
2496 /****************************
2497  * MPEG-4 Part 2 data structures
2498  ****************************/
2499  
2500 /* MPEG-4 Picture Parameter Buffer */
2501 /* 
2502  * For each frame or field, and before any slice data, a single
2503  * picture parameter buffer must be send.
2504  */
2505 typedef struct _VAPictureParameterBufferMPEG4
2506 {
2507     uint16_t vop_width;
2508     uint16_t vop_height;
2509     VASurfaceID forward_reference_picture;
2510     VASurfaceID backward_reference_picture;
2511     union {
2512         struct {
2513             uint32_t short_video_header         : 1; 
2514             uint32_t chroma_format                      : 2; 
2515             uint32_t interlaced                 : 1; 
2516             uint32_t obmc_disable                       : 1; 
2517             uint32_t sprite_enable                      : 2; 
2518             uint32_t sprite_warping_accuracy    : 2; 
2519             uint32_t quant_type                 : 1; 
2520             uint32_t quarter_sample                     : 1; 
2521             uint32_t data_partitioned           : 1; 
2522             uint32_t reversible_vlc                     : 1; 
2523             uint32_t resync_marker_disable              : 1; 
2524         } bits;
2525         uint32_t value;
2526     } vol_fields;
2527     uint8_t no_of_sprite_warping_points;
2528     int16_t sprite_trajectory_du[3];
2529     int16_t sprite_trajectory_dv[3];
2530     uint8_t quant_precision;
2531     union {
2532         struct {
2533             uint32_t vop_coding_type            : 2; 
2534             uint32_t backward_reference_vop_coding_type : 2; 
2535             uint32_t vop_rounding_type          : 1; 
2536             uint32_t intra_dc_vlc_thr           : 3; 
2537             uint32_t top_field_first            : 1; 
2538             uint32_t alternate_vertical_scan_flag       : 1; 
2539         } bits;
2540         uint32_t value;
2541     } vop_fields;
2542     uint8_t vop_fcode_forward;
2543     uint8_t vop_fcode_backward;
2544     uint16_t vop_time_increment_resolution;
2545     /* short header related */
2546     uint8_t num_gobs_in_vop;
2547     uint8_t num_macroblocks_in_gob;
2548     /* for direct mode prediction */
2549     int16_t TRB;
2550     int16_t TRD;
2551
2552     /** \brief Reserved bytes for future use, must be zero */
2553     uint32_t                va_reserved[VA_PADDING_LOW];
2554 } VAPictureParameterBufferMPEG4;
2555
2556 /** MPEG-4 Inverse Quantization Matrix Buffer */
2557 typedef struct _VAIQMatrixBufferMPEG4
2558 {
2559     /** Same as the MPEG-4:2 bitstream syntax element. */
2560     int32_t load_intra_quant_mat;
2561     /** Same as the MPEG-4:2 bitstream syntax element. */
2562     int32_t load_non_intra_quant_mat;
2563     /** The matrix for intra blocks, in zig-zag scan order. */
2564     uint8_t intra_quant_mat[64];
2565     /** The matrix for non-intra blocks, in zig-zag scan order. */
2566     uint8_t non_intra_quant_mat[64];
2567
2568     /** \brief Reserved bytes for future use, must be zero */
2569     uint32_t                va_reserved[VA_PADDING_LOW];
2570 } VAIQMatrixBufferMPEG4;
2571
2572 /** MPEG-4 Slice Parameter Buffer */
2573 typedef struct _VASliceParameterBufferMPEG4
2574 {
2575     uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2576     uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2577     uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2578     uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2579     uint32_t macroblock_number;
2580     int32_t quant_scale;
2581
2582     /** \brief Reserved bytes for future use, must be zero */
2583     uint32_t                va_reserved[VA_PADDING_LOW];
2584 } VASliceParameterBufferMPEG4;
2585
2586 /**
2587  VC-1 data structures
2588 */
2589
2590 typedef enum   /* see 7.1.1.32 */
2591 {
2592     VAMvMode1Mv                        = 0,
2593     VAMvMode1MvHalfPel                 = 1,
2594     VAMvMode1MvHalfPelBilinear         = 2,
2595     VAMvModeMixedMv                    = 3,
2596     VAMvModeIntensityCompensation      = 4 
2597 } VAMvModeVC1;
2598
2599 /** VC-1 Picture Parameter Buffer */
2600 /* 
2601  * For each picture, and before any slice data, a picture parameter
2602  * buffer must be send. Multiple picture parameter buffers may be
2603  * sent for a single picture. In that case picture parameters will
2604  * apply to all slice data that follow it until a new picture
2605  * parameter buffer is sent.
2606  *
2607  * Notes:
2608  *   pic_quantizer_type should be set to the applicable quantizer
2609  *   type as defined by QUANTIZER (J.1.19) and either
2610  *   PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
2611  */
2612 typedef struct _VAPictureParameterBufferVC1
2613 {
2614     VASurfaceID forward_reference_picture;
2615     VASurfaceID backward_reference_picture;
2616     /* if out-of-loop post-processing is done on the render
2617        target, then we need to keep the in-loop decoded 
2618        picture as a reference picture */
2619     VASurfaceID inloop_decoded_picture;
2620
2621     /* sequence layer for AP or meta data for SP and MP */
2622     union {
2623         struct {
2624             uint32_t pulldown   : 1; /* SEQUENCE_LAYER::PULLDOWN */
2625             uint32_t interlace  : 1; /* SEQUENCE_LAYER::INTERLACE */
2626             uint32_t tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
2627             uint32_t finterpflag        : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
2628             uint32_t psf                : 1; /* SEQUENCE_LAYER::PSF */
2629             uint32_t multires   : 1; /* METADATA::MULTIRES */
2630             uint32_t overlap    : 1; /* METADATA::OVERLAP */
2631             uint32_t syncmarker : 1; /* METADATA::SYNCMARKER */
2632             uint32_t rangered   : 1; /* METADATA::RANGERED */
2633             uint32_t max_b_frames       : 3; /* METADATA::MAXBFRAMES */
2634             uint32_t profile    : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
2635         } bits;
2636         uint32_t value;
2637     } sequence_fields;
2638
2639     uint16_t coded_width;               /* ENTRY_POINT_LAYER::CODED_WIDTH */
2640     uint16_t coded_height;      /* ENTRY_POINT_LAYER::CODED_HEIGHT */
2641     union {
2642         struct {
2643             uint32_t broken_link        : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
2644             uint32_t closed_entry       : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
2645             uint32_t panscan_flag       : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
2646             uint32_t loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
2647         } bits;
2648         uint32_t value;
2649     } entrypoint_fields;
2650     uint8_t conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
2651     uint8_t fast_uvmc_flag;     /* ENTRY_POINT_LAYER::FASTUVMC */
2652     union {
2653         struct {
2654             uint32_t luma_flag  : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
2655             uint32_t luma               : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
2656             uint32_t chroma_flag        : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
2657             uint32_t chroma             : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
2658         } bits;
2659         uint32_t value;
2660     } range_mapping_fields;
2661
2662     uint8_t b_picture_fraction; /* Index for PICTURE_LAYER::BFRACTION value in Table 40 (7.1.1.14) */
2663     uint8_t cbp_table;          /* PICTURE_LAYER::CBPTAB/ICBPTAB */
2664     uint8_t mb_mode_table;      /* PICTURE_LAYER::MBMODETAB */
2665     uint8_t range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
2666     uint8_t rounding_control;   /* PICTURE_LAYER::RNDCTRL */
2667     uint8_t post_processing;    /* PICTURE_LAYER::POSTPROC */
2668     uint8_t picture_resolution_index;   /* PICTURE_LAYER::RESPIC */
2669     uint8_t luma_scale;         /* PICTURE_LAYER::LUMSCALE */
2670     uint8_t luma_shift;         /* PICTURE_LAYER::LUMSHIFT */
2671
2672     union {
2673         struct {
2674             uint32_t picture_type               : 3; /* PICTURE_LAYER::PTYPE */
2675             uint32_t frame_coding_mode  : 3; /* PICTURE_LAYER::FCM */
2676             uint32_t top_field_first    : 1; /* PICTURE_LAYER::TFF */
2677             uint32_t is_first_field             : 1; /* set to 1 if it is the first field */
2678             uint32_t intensity_compensation     : 1; /* PICTURE_LAYER::INTCOMP */
2679         } bits;
2680         uint32_t value;
2681     } picture_fields;
2682     union {
2683         struct {
2684             uint32_t mv_type_mb : 1;    /* PICTURE::MVTYPEMB */
2685             uint32_t direct_mb  : 1;    /* PICTURE::DIRECTMB */
2686             uint32_t skip_mb    : 1;    /* PICTURE::SKIPMB */
2687             uint32_t field_tx   : 1;    /* PICTURE::FIELDTX */
2688             uint32_t forward_mb : 1;    /* PICTURE::FORWARDMB */
2689             uint32_t ac_pred    : 1;    /* PICTURE::ACPRED */
2690             uint32_t overflags  : 1;    /* PICTURE::OVERFLAGS */
2691         } flags;
2692         uint32_t value;
2693     } raw_coding;
2694     union {
2695         struct {
2696             uint32_t bp_mv_type_mb   : 1;    /* PICTURE::MVTYPEMB */
2697             uint32_t bp_direct_mb    : 1;    /* PICTURE::DIRECTMB */
2698             uint32_t bp_skip_mb      : 1;    /* PICTURE::SKIPMB */  
2699             uint32_t bp_field_tx     : 1;    /* PICTURE::FIELDTX */ 
2700             uint32_t bp_forward_mb   : 1;    /* PICTURE::FORWARDMB */
2701             uint32_t bp_ac_pred      : 1;    /* PICTURE::ACPRED */   
2702             uint32_t bp_overflags    : 1;    /* PICTURE::OVERFLAGS */
2703         } flags;
2704         uint32_t value;
2705     } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
2706     union {
2707         struct {
2708             uint32_t reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
2709             uint32_t reference_distance : 5;/* PICTURE_LAYER::REFDIST */
2710             uint32_t num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
2711             uint32_t reference_field_pic_indicator      : 1;/* PICTURE_LAYER::REFFIELD */
2712         } bits;
2713         uint32_t value;
2714     } reference_fields;
2715     union {
2716         struct {
2717             uint32_t mv_mode            : 3; /* PICTURE_LAYER::MVMODE */
2718             uint32_t mv_mode2           : 3; /* PICTURE_LAYER::MVMODE2 */
2719             uint32_t mv_table           : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
2720             uint32_t two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
2721             uint32_t four_mv_switch             : 1; /* PICTURE_LAYER::4MVSWITCH */
2722             uint32_t four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
2723             uint32_t extended_mv_flag   : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
2724             uint32_t extended_mv_range  : 2; /* PICTURE_LAYER::MVRANGE */
2725             uint32_t extended_dmv_flag  : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
2726             uint32_t extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
2727         } bits;
2728         uint32_t value;
2729     } mv_fields;
2730     union {
2731         struct {
2732             uint32_t dquant     : 2;    /* ENTRY_POINT_LAYER::DQUANT */
2733             uint32_t quantizer     : 2;         /* ENTRY_POINT_LAYER::QUANTIZER */
2734             uint32_t half_qp    : 1;    /* PICTURE_LAYER::HALFQP */
2735             uint32_t pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
2736             uint32_t pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
2737             uint32_t dq_frame   : 1;    /* VOPDQUANT::DQUANTFRM */
2738             uint32_t dq_profile : 2;    /* VOPDQUANT::DQPROFILE */
2739             uint32_t dq_sb_edge : 2;    /* VOPDQUANT::DQSBEDGE */
2740             uint32_t dq_db_edge         : 2;    /* VOPDQUANT::DQDBEDGE */
2741             uint32_t dq_binary_level : 1;       /* VOPDQUANT::DQBILEVEL */
2742             uint32_t alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
2743         } bits;
2744         uint32_t value;
2745     } pic_quantizer_fields;
2746     union {
2747         struct {
2748             uint32_t variable_sized_transform_flag      : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
2749             uint32_t mb_level_transform_type_flag       : 1;/* PICTURE_LAYER::TTMBF */
2750             uint32_t frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
2751             uint32_t transform_ac_codingset_idx1        : 2;/* PICTURE_LAYER::TRANSACFRM */
2752             uint32_t transform_ac_codingset_idx2        : 2;/* PICTURE_LAYER::TRANSACFRM2 */
2753             uint32_t intra_transform_dc_table   : 1;/* PICTURE_LAYER::TRANSDCTAB */
2754         } bits;
2755         uint32_t value;
2756     } transform_fields;
2757
2758     uint8_t luma_scale2;                  /* PICTURE_LAYER::LUMSCALE2 */
2759     uint8_t luma_shift2;                  /* PICTURE_LAYER::LUMSHIFT2 */
2760     uint8_t intensity_compensation_field; /* Index for PICTURE_LAYER::INTCOMPFIELD value in Table 109 (9.1.1.48) */
2761
2762     /** \brief Reserved bytes for future use, must be zero */
2763     uint32_t                va_reserved[VA_PADDING_MEDIUM - 1];
2764 } VAPictureParameterBufferVC1;
2765
2766 /** VC-1 Bitplane Buffer
2767 There will be at most three bitplanes coded in any picture header. To send 
2768 the bitplane data more efficiently, each byte is divided in two nibbles, with
2769 each nibble carrying three bitplanes for one macroblock.  The following table
2770 shows the bitplane data arrangement within each nibble based on the picture
2771 type.
2772
2773 Picture Type    Bit3            Bit2            Bit1            Bit0
2774 I or BI                         OVERFLAGS       ACPRED          FIELDTX
2775 P                               MYTYPEMB        SKIPMB          DIRECTMB
2776 B                               FORWARDMB       SKIPMB          DIRECTMB
2777
2778 Within each byte, the lower nibble is for the first MB and the upper nibble is 
2779 for the second MB.  E.g. the lower nibble of the first byte in the bitplane
2780 buffer is for Macroblock #1 and the upper nibble of the first byte is for 
2781 Macroblock #2 in the first row.
2782 */
2783
2784 /* VC-1 Slice Parameter Buffer */
2785 typedef struct _VASliceParameterBufferVC1
2786 {
2787     uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2788     uint32_t slice_data_offset;/* the offset to the first byte of slice data */
2789     uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2790     uint32_t macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
2791     uint32_t slice_vertical_position;
2792
2793     /** \brief Reserved bytes for future use, must be zero */
2794     uint32_t                va_reserved[VA_PADDING_LOW];
2795 } VASliceParameterBufferVC1;
2796
2797 /* VC-1 Slice Data Buffer */
2798 /* 
2799 This is simplely a buffer containing raw bit-stream bytes 
2800 */
2801
2802 /****************************
2803  * H.264/AVC data structures
2804  ****************************/
2805
2806 typedef struct _VAPictureH264
2807 {
2808     VASurfaceID picture_id;
2809     uint32_t frame_idx;
2810     uint32_t flags;
2811     int32_t TopFieldOrderCnt;
2812     int32_t BottomFieldOrderCnt;
2813
2814     /** \brief Reserved bytes for future use, must be zero */
2815     uint32_t                va_reserved[VA_PADDING_LOW];
2816 } VAPictureH264;
2817 /* flags in VAPictureH264 could be OR of the following */
2818 #define VA_PICTURE_H264_INVALID                 0x00000001
2819 #define VA_PICTURE_H264_TOP_FIELD               0x00000002
2820 #define VA_PICTURE_H264_BOTTOM_FIELD            0x00000004
2821 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE    0x00000008
2822 #define VA_PICTURE_H264_LONG_TERM_REFERENCE     0x00000010
2823
2824 /** H.264 Picture Parameter Buffer */
2825 /* 
2826  * For each picture, and before any slice data, a single
2827  * picture parameter buffer must be send.
2828  */
2829 typedef struct _VAPictureParameterBufferH264
2830 {
2831     VAPictureH264 CurrPic;
2832     VAPictureH264 ReferenceFrames[16];  /* in DPB */
2833     uint16_t picture_width_in_mbs_minus1;
2834     uint16_t picture_height_in_mbs_minus1;
2835     uint8_t bit_depth_luma_minus8;
2836     uint8_t bit_depth_chroma_minus8;
2837     uint8_t num_ref_frames;
2838     union {
2839         struct {
2840             uint32_t chroma_format_idc                  : 2; 
2841             uint32_t residual_colour_transform_flag             : 1; /* Renamed to separate_colour_plane_flag in newer standard versions. */
2842             uint32_t gaps_in_frame_num_value_allowed_flag       : 1; 
2843             uint32_t frame_mbs_only_flag                        : 1; 
2844             uint32_t mb_adaptive_frame_field_flag               : 1; 
2845             uint32_t direct_8x8_inference_flag          : 1; 
2846             uint32_t MinLumaBiPredSize8x8                       : 1; /* see A.3.3.2 */
2847             uint32_t log2_max_frame_num_minus4          : 4;
2848             uint32_t pic_order_cnt_type                 : 2;
2849             uint32_t log2_max_pic_order_cnt_lsb_minus4  : 4;
2850             uint32_t delta_pic_order_always_zero_flag   : 1;
2851         } bits;
2852         uint32_t value;
2853     } seq_fields;
2854     // FMO is not supported.
2855     va_deprecated uint8_t num_slice_groups_minus1;
2856     va_deprecated uint8_t slice_group_map_type;
2857     va_deprecated uint16_t slice_group_change_rate_minus1;
2858     int8_t pic_init_qp_minus26;
2859     int8_t pic_init_qs_minus26;
2860     int8_t chroma_qp_index_offset;
2861     int8_t second_chroma_qp_index_offset;
2862     union {
2863         struct {
2864             uint32_t entropy_coding_mode_flag   : 1;
2865             uint32_t weighted_pred_flag         : 1;
2866             uint32_t weighted_bipred_idc                : 2;
2867             uint32_t transform_8x8_mode_flag    : 1;
2868             uint32_t field_pic_flag                     : 1;
2869             uint32_t constrained_intra_pred_flag        : 1;
2870             uint32_t pic_order_present_flag                     : 1; /* Renamed to bottom_field_pic_order_in_frame_present_flag in newer standard versions. */
2871             uint32_t deblocking_filter_control_present_flag : 1;
2872             uint32_t redundant_pic_cnt_present_flag             : 1;
2873             uint32_t reference_pic_flag                 : 1; /* nal_ref_idc != 0 */
2874         } bits;
2875         uint32_t value;
2876     } pic_fields;
2877     uint16_t frame_num;
2878
2879     /** \brief Reserved bytes for future use, must be zero */
2880     uint32_t                va_reserved[VA_PADDING_MEDIUM];
2881 } VAPictureParameterBufferH264;
2882
2883 /** H.264 Inverse Quantization Matrix Buffer */
2884 typedef struct _VAIQMatrixBufferH264
2885 {
2886     /** \brief 4x4 scaling list, in raster scan order. */
2887     uint8_t ScalingList4x4[6][16];
2888     /** \brief 8x8 scaling list, in raster scan order. */
2889     uint8_t ScalingList8x8[2][64];
2890
2891     /** \brief Reserved bytes for future use, must be zero */
2892     uint32_t                va_reserved[VA_PADDING_LOW];
2893 } VAIQMatrixBufferH264;
2894
2895 /** H.264 Slice Parameter Buffer */
2896 typedef struct _VASliceParameterBufferH264
2897 {
2898     uint32_t slice_data_size;/* number of bytes in the slice data buffer for this slice */
2899     /** \brief Byte offset to the NAL Header Unit for this slice. */
2900     uint32_t slice_data_offset;
2901     uint32_t slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
2902     /**
2903      * \brief Bit offset from NAL Header Unit to the begining of slice_data().
2904      *
2905      * This bit offset is relative to and includes the NAL unit byte
2906      * and represents the number of bits parsed in the slice_header()
2907      * after the removal of any emulation prevention bytes in
2908      * there. However, the slice data buffer passed to the hardware is
2909      * the original bitstream, thus including any emulation prevention
2910      * bytes.
2911      */
2912     uint16_t slice_data_bit_offset;
2913     uint16_t first_mb_in_slice;
2914     uint8_t slice_type;
2915     uint8_t direct_spatial_mv_pred_flag;
2916     /**
2917      * H264/AVC syntax element
2918      *
2919      * if num_ref_idx_active_override_flag equals 0, host decoder should
2920      * set its value to num_ref_idx_l0_default_active_minus1.
2921      */
2922     uint8_t num_ref_idx_l0_active_minus1;
2923     /**
2924      * H264/AVC syntax element
2925      *
2926      * if num_ref_idx_active_override_flag equals 0, host decoder should
2927      * set its value to num_ref_idx_l1_default_active_minus1.
2928      */
2929     uint8_t num_ref_idx_l1_active_minus1;
2930     uint8_t cabac_init_idc;
2931     int8_t slice_qp_delta;
2932     uint8_t disable_deblocking_filter_idc;
2933     int8_t slice_alpha_c0_offset_div2;
2934     int8_t slice_beta_offset_div2;
2935     VAPictureH264 RefPicList0[32];      /* See 8.2.4.2 */
2936     VAPictureH264 RefPicList1[32];      /* See 8.2.4.2 */
2937     uint8_t luma_log2_weight_denom;
2938     uint8_t chroma_log2_weight_denom;
2939     uint8_t luma_weight_l0_flag;
2940     int16_t luma_weight_l0[32];
2941     int16_t luma_offset_l0[32];
2942     uint8_t chroma_weight_l0_flag;
2943     int16_t chroma_weight_l0[32][2];
2944     int16_t chroma_offset_l0[32][2];
2945     uint8_t luma_weight_l1_flag;
2946     int16_t luma_weight_l1[32];
2947     int16_t luma_offset_l1[32];
2948     uint8_t chroma_weight_l1_flag;
2949     int16_t chroma_weight_l1[32][2];
2950     int16_t chroma_offset_l1[32][2];
2951
2952     /** \brief Reserved bytes for future use, must be zero */
2953     uint32_t                va_reserved[VA_PADDING_LOW];
2954 } VASliceParameterBufferH264;
2955
2956 /****************************
2957  * Common encode data structures 
2958  ****************************/
2959 typedef enum
2960 {
2961     VAEncPictureTypeIntra               = 0,
2962     VAEncPictureTypePredictive          = 1,
2963     VAEncPictureTypeBidirectional       = 2,
2964 } VAEncPictureType;
2965
2966 /**
2967  * \brief Encode Slice Parameter Buffer.
2968  *
2969  * @deprecated
2970  * This is a deprecated encode slice parameter buffer, All applications
2971  * \c can use VAEncSliceParameterBufferXXX (XXX = MPEG2, HEVC, H264, JPEG)
2972  */
2973 typedef struct _VAEncSliceParameterBuffer
2974 {
2975     uint32_t start_row_number;  /* starting MB row number for this slice */
2976     uint32_t slice_height;      /* slice height measured in MB */
2977     union {
2978         struct {
2979             uint32_t is_intra   : 1;
2980             uint32_t disable_deblocking_filter_idc : 2;
2981             uint32_t uses_long_term_ref         :1;
2982             uint32_t is_long_term_ref           :1;
2983         } bits;
2984         uint32_t value;
2985     } slice_flags;
2986
2987     /** \brief Reserved bytes for future use, must be zero */
2988     uint32_t                va_reserved[VA_PADDING_LOW];
2989 } VAEncSliceParameterBuffer;
2990
2991
2992 /****************************
2993  * H.263 specific encode data structures
2994  ****************************/
2995
2996 typedef struct _VAEncSequenceParameterBufferH263
2997 {
2998     uint32_t intra_period;
2999     uint32_t bits_per_second;
3000     uint32_t frame_rate;
3001     uint32_t initial_qp;
3002     uint32_t min_qp;
3003
3004     /** \brief Reserved bytes for future use, must be zero */
3005     uint32_t                va_reserved[VA_PADDING_LOW];
3006 } VAEncSequenceParameterBufferH263;
3007
3008 typedef struct _VAEncPictureParameterBufferH263
3009 {
3010     VASurfaceID reference_picture;
3011     VASurfaceID reconstructed_picture;
3012     VABufferID coded_buf;
3013     uint16_t picture_width;
3014     uint16_t picture_height;
3015     VAEncPictureType picture_type;
3016
3017     /** \brief Reserved bytes for future use, must be zero */
3018     uint32_t                va_reserved[VA_PADDING_LOW];
3019 } VAEncPictureParameterBufferH263;
3020
3021 /****************************
3022  * MPEG-4 specific encode data structures
3023  ****************************/
3024
3025 typedef struct _VAEncSequenceParameterBufferMPEG4
3026 {
3027     uint8_t profile_and_level_indication;
3028     uint32_t intra_period;
3029     uint32_t video_object_layer_width;
3030     uint32_t video_object_layer_height;
3031     uint32_t vop_time_increment_resolution;
3032     uint32_t fixed_vop_rate;
3033     uint32_t fixed_vop_time_increment;
3034     uint32_t bits_per_second;
3035     uint32_t frame_rate;
3036     uint32_t initial_qp;
3037     uint32_t min_qp;
3038
3039     /** \brief Reserved bytes for future use, must be zero */
3040     uint32_t                va_reserved[VA_PADDING_LOW];
3041 } VAEncSequenceParameterBufferMPEG4;
3042
3043 typedef struct _VAEncPictureParameterBufferMPEG4
3044 {
3045     VASurfaceID reference_picture;
3046     VASurfaceID reconstructed_picture;
3047     VABufferID coded_buf;
3048     uint16_t picture_width;
3049     uint16_t picture_height;
3050     uint32_t modulo_time_base; /* number of 1s */
3051     uint32_t vop_time_increment;
3052     VAEncPictureType picture_type;
3053
3054     /** \brief Reserved bytes for future use, must be zero */
3055     uint32_t                va_reserved[VA_PADDING_LOW];
3056 } VAEncPictureParameterBufferMPEG4;
3057
3058
3059
3060 /** Buffer functions */
3061
3062 /**
3063  * Creates a buffer for "num_elements" elements of "size" bytes and 
3064  * initalize with "data".
3065  * if "data" is null, then the contents of the buffer data store
3066  * are undefined.
3067  * Basically there are two ways to get buffer data to the server side. One is 
3068  * to call vaCreateBuffer() with a non-null "data", which results the data being
3069  * copied to the data store on the server side.  A different method that 
3070  * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
3071  * and then use vaMapBuffer() to map the data store from the server side to the
3072  * client address space for access.
3073  * The user must call vaDestroyBuffer() to destroy a buffer.
3074  *  Note: image buffers are created by the library, not the client. Please see 
3075  *        vaCreateImage on how image buffers are managed.
3076  */
3077 VAStatus vaCreateBuffer (
3078     VADisplay dpy,
3079     VAContextID context,
3080     VABufferType type,  /* in */
3081     unsigned int size,  /* in */
3082     unsigned int num_elements, /* in */
3083     void *data,         /* in */
3084     VABufferID *buf_id  /* out */
3085 );
3086
3087 /**
3088  * Create a buffer for given width & height get unit_size, pitch, buf_id for 2D buffer
3089  * for permb qp buffer, it will return unit_size for one MB or LCU and the pitch for alignments
3090  * can call vaMapBuffer with this Buffer ID to get virtual address.
3091  * e.g. AVC 1080P encode, 1920x1088, the size in MB is 120x68,but inside driver,
3092  * maybe it should align with 256, and one byte present one Qp.so, call the function.
3093  * then get unit_size = 1, pitch = 256. call vaMapBuffer to get the virtual address (pBuf).
3094  * then read write the memory like 2D. the size is 256x68, application can only use 120x68
3095  * pBuf + 256 is the start of next line.
3096  * different driver implementation maybe return different unit_size and pitch
3097  */
3098 VAStatus vaCreateBuffer2(
3099     VADisplay dpy,
3100     VAContextID context,
3101     VABufferType type,
3102     unsigned int width,
3103     unsigned int height,
3104     unsigned int *unit_size,
3105     unsigned int *pitch,
3106     VABufferID *buf_id
3107 );
3108
3109 /**
3110  * Convey to the server how many valid elements are in the buffer. 
3111  * e.g. if multiple slice parameters are being held in a single buffer,
3112  * this will communicate to the server the number of slice parameters
3113  * that are valid in the buffer.
3114  */
3115 VAStatus vaBufferSetNumElements (
3116     VADisplay dpy,
3117     VABufferID buf_id,  /* in */
3118     unsigned int num_elements /* in */
3119 );
3120
3121
3122 /**
3123  * device independent data structure for codedbuffer
3124  */
3125
3126 /* 
3127  * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
3128  * LARGE_SLICE(bit8):At least one slice in the current frame was large
3129  *              enough for the encoder to attempt to limit its size.
3130  * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
3131  *              exceeded the maximum slice size specified.
3132  * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
3133  * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
3134  * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
3135  */
3136 #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK         0xff
3137 #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK            0x100
3138 #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK         0x200
3139 #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW            0x400
3140 #define VA_CODED_BUF_STATUS_BITRATE_HIGH                0x800
3141 /**
3142  * \brief The frame has exceeded the maximum requested size.
3143  *
3144  * This flag indicates that the encoded frame size exceeds the value
3145  * specified through a misc parameter buffer of type
3146  * #VAEncMiscParameterTypeMaxFrameSize.
3147  */
3148 #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW         0x1000
3149 /**
3150  * \brief the bitstream is bad or corrupt.
3151  */
3152 #define VA_CODED_BUF_STATUS_BAD_BITSTREAM               0x8000
3153 #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD       0xff0000
3154
3155 /**
3156  * \brief The coded buffer segment status contains frame encoding passes number
3157  *
3158  * This is the mask to get the number of encoding passes from the coded
3159  * buffer segment status. 
3160  * NUMBER_PASS(bit24~bit27): the number for encoding passes executed for the coded frame.
3161  * 
3162  */
3163 #define VA_CODED_BUF_STATUS_NUMBER_PASSES_MASK          0xf000000
3164
3165 /**
3166  * \brief The coded buffer segment contains a single NAL unit. 
3167  *
3168  * This flag indicates that the coded buffer segment contains a
3169  * single NAL unit. This flag might be useful to the user for 
3170  * processing the coded buffer.
3171  */
3172 #define VA_CODED_BUF_STATUS_SINGLE_NALU                 0x10000000      
3173
3174 /**
3175  * \brief Coded buffer segment.
3176  *
3177  * #VACodedBufferSegment is an element of a linked list describing
3178  * some information on the coded buffer. The coded buffer segment
3179  * could contain either a single NAL unit, or more than one NAL unit. 
3180  * It is recommended (but not required) to return a single NAL unit 
3181  * in a coded buffer segment, and the implementation should set the 
3182  * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
3183  */
3184 typedef  struct _VACodedBufferSegment  {
3185     /**
3186      * \brief Size of the data buffer in this segment (in bytes).
3187      */
3188     uint32_t        size;
3189     /** \brief Bit offset into the data buffer where the video data starts. */
3190     uint32_t        bit_offset;
3191     /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
3192     uint32_t        status;
3193     /** \brief Reserved for future use. */
3194     uint32_t        reserved;
3195     /** \brief Pointer to the start of the data buffer. */
3196     void               *buf;
3197     /**
3198      * \brief Pointer to the next #VACodedBufferSegment element,
3199      * or \c NULL if there is none.
3200      */
3201     void               *next;
3202
3203     /** \brief Reserved bytes for future use, must be zero */
3204     uint32_t                va_reserved[VA_PADDING_LOW];
3205 } VACodedBufferSegment;
3206      
3207 /**
3208  * Map data store of the buffer into the client's address space
3209  * vaCreateBuffer() needs to be called with "data" set to NULL before
3210  * calling vaMapBuffer()
3211  *
3212  * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
3213  * VACodedBufferSegment, and the list is terminated if "next" is NULL
3214  */
3215 VAStatus vaMapBuffer (
3216     VADisplay dpy,
3217     VABufferID buf_id,  /* in */
3218     void **pbuf         /* out */
3219 );
3220
3221 /**
3222  * After client making changes to a mapped data store, it needs to
3223  * "Unmap" it to let the server know that the data is ready to be
3224  * consumed by the server
3225  */
3226 VAStatus vaUnmapBuffer (
3227     VADisplay dpy,
3228     VABufferID buf_id   /* in */
3229 );
3230
3231 /**
3232  * After this call, the buffer is deleted and this buffer_id is no longer valid
3233  *
3234  * A buffer can be re-used and sent to the server by another Begin/Render/End
3235  * sequence if vaDestroyBuffer() is not called with this buffer.
3236  *
3237  * Note re-using a shared buffer (e.g. a slice data buffer) between the host and the
3238  * hardware accelerator can result in performance dropping.
3239  */
3240 VAStatus vaDestroyBuffer (
3241     VADisplay dpy,
3242     VABufferID buffer_id
3243 );
3244
3245 /** \brief VA buffer information */
3246 typedef struct {
3247     /** \brief Buffer handle */
3248     uintptr_t           handle;
3249     /** \brief Buffer type (See \ref VABufferType). */
3250     uint32_t            type;
3251     /**
3252      * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
3253      *
3254      * On input to vaAcquireBufferHandle(), this field can serve as a hint
3255      * to specify the set of memory types the caller is interested in.
3256      * On successful return from vaAcquireBufferHandle(), the field is
3257      * updated with the best matching memory type.
3258      */
3259     uint32_t            mem_type;
3260     /** \brief Size of the underlying buffer. */
3261     size_t              mem_size;
3262
3263     /** \brief Reserved bytes for future use, must be zero */
3264     uint32_t                va_reserved[VA_PADDING_LOW];
3265 } VABufferInfo;
3266
3267 /**
3268  * \brief Acquires buffer handle for external API usage
3269  *
3270  * Locks the VA buffer object \ref buf_id for external API usage like
3271  * EGL or OpenCL (OCL). This function is a synchronization point. This
3272  * means that any pending operation is guaranteed to be completed
3273  * prior to returning from the function.
3274  *
3275  * If the referenced VA buffer object is the backing store of a VA
3276  * surface, then this function acts as if vaSyncSurface() on the
3277  * parent surface was called first.
3278  *
3279  * The \ref VABufferInfo argument shall be zero'ed on input. On
3280  * successful output, the data structure is filled in with all the
3281  * necessary buffer level implementation details like handle, type,
3282  * memory type and memory size.
3283  *
3284  * Note: the external API implementation, or the application, can
3285  * express the memory types it is interested in by filling in the \ref
3286  * mem_type field accordingly. On successful output, the memory type
3287  * that fits best the request and that was used is updated in the \ref
3288  * VABufferInfo data structure. If none of the supplied memory types
3289  * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
3290  * error is returned.
3291  *
3292  * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
3293  * is called. Besides, no additional operation is allowed on any of
3294  * the buffer parent object until vaReleaseBufferHandle() is called.
3295  * e.g. decoding into a VA surface backed with the supplied VA buffer
3296  * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
3297  * error.
3298  *
3299  * Possible errors:
3300  * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3301  *   does not support this interface
3302  * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3303  * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3304  * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3305  *   does not support exporting buffers of the specified type
3306  * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
3307  *   memory types in \ref VABufferInfo.mem_type was supported
3308  *
3309  * @param[in] dpy               the VA display
3310  * @param[in] buf_id            the VA buffer
3311  * @param[in,out] buf_info      the associated VA buffer information
3312  * @return VA_STATUS_SUCCESS if successful
3313  */
3314 VAStatus
3315 vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
3316
3317 /**
3318  * \brief Releases buffer after usage from external API
3319  *
3320  * Unlocks the VA buffer object \ref buf_id from external API usage like
3321  * EGL or OpenCL (OCL). This function is a synchronization point. This
3322  * means that any pending operation is guaranteed to be completed
3323  * prior to returning from the function.
3324  *
3325  * The \ref VABufferInfo argument shall point to the original data
3326  * structure that was obtained from vaAcquireBufferHandle(), unaltered.
3327  * This is necessary so that the VA driver implementation could
3328  * deallocate any resources that were needed.
3329  *
3330  * In any case, returning from this function invalidates any contents
3331  * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
3332  * valid. Therefore, VA driver implementations are free to reset this
3333  * data structure to safe defaults.
3334  *
3335  * Possible errors:
3336  * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
3337  *   does not support this interface
3338  * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
3339  * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
3340  * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
3341  *   does not support exporting buffers of the specified type
3342  *
3343  * @param[in] dpy               the VA display
3344  * @param[in] buf_id            the VA buffer
3345  * @return VA_STATUS_SUCCESS if successful
3346  */
3347 VAStatus
3348 vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
3349
3350 /** @name vaExportSurfaceHandle() flags
3351  *
3352  * @{
3353  */
3354 /** Export surface to be read by external API. */
3355 #define VA_EXPORT_SURFACE_READ_ONLY        0x0001
3356 /** Export surface to be written by external API. */
3357 #define VA_EXPORT_SURFACE_WRITE_ONLY       0x0002
3358 /** Export surface to be both read and written by external API. */
3359 #define VA_EXPORT_SURFACE_READ_WRITE       0x0003
3360 /** Export surface with separate layers.
3361  *
3362  * For example, NV12 surfaces should be exported as two separate
3363  * planes for luma and chroma.
3364  */
3365 #define VA_EXPORT_SURFACE_SEPARATE_LAYERS  0x0004
3366 /** Export surface with composed layers.
3367  *
3368  * For example, NV12 surfaces should be exported as a single NV12
3369  * composed object.
3370  */
3371 #define VA_EXPORT_SURFACE_COMPOSED_LAYERS  0x0008
3372
3373 /** @} */
3374
3375 /**
3376  * \brief Export a handle to a surface for use with an external API
3377  *
3378  * The exported handles are owned by the caller, and the caller is
3379  * responsible for freeing them when no longer needed (e.g. by closing
3380  * DRM PRIME file descriptors).
3381  *
3382  * This does not perform any synchronisation.  If the contents of the
3383  * surface will be read, vaSyncSurface() must be called before doing so.
3384  * If the contents of the surface are written, then all operations must
3385  * be completed externally before using the surface again by via VA-API
3386  * functions.
3387  *
3388  * @param[in] dpy          VA display.
3389  * @param[in] surface_id   Surface to export.
3390  * @param[in] mem_type     Memory type to export to.
3391  * @param[in] flags        Combination of flags to apply
3392  *   (VA_EXPORT_SURFACE_*).
3393  * @param[out] descriptor  Pointer to the descriptor structure to fill
3394  *   with the handle details.  The type of this structure depends on
3395  *   the value of mem_type.
3396  *
3397  * @return Status code:
3398  * - VA_STATUS_SUCCESS:    Success.
3399  * - VA_STATUS_ERROR_INVALID_DISPLAY:  The display is not valid.
3400  * - VA_STATUS_ERROR_UNIMPLEMENTED:  The driver does not implement
3401  *     this interface.
3402  * - VA_STATUS_ERROR_INVALID_SURFACE:  The surface is not valid, or
3403  *     the surface is not exportable in the specified way.
3404  * - VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE:  The driver does not
3405  *     support exporting surfaces to the specified memory type.
3406  */
3407 VAStatus vaExportSurfaceHandle(VADisplay dpy,
3408                                VASurfaceID surface_id,
3409                                uint32_t mem_type, uint32_t flags,
3410                                void *descriptor);
3411
3412 /**
3413  * Render (Video Decode/Encode/Processing) Pictures
3414  *
3415  * A picture represents either a frame or a field.
3416  *
3417  * The Begin/Render/End sequence sends the video decode/encode/processing buffers
3418  * to the server
3419  */
3420
3421 /**
3422  * Get ready for a video pipeline
3423  * - decode a picture to a target surface
3424  * - encode a picture from a target surface
3425  * - process a picture to a target surface
3426  */
3427 VAStatus vaBeginPicture (
3428     VADisplay dpy,
3429     VAContextID context,
3430     VASurfaceID render_target
3431 );
3432
3433 /**
3434  * Send video decode, encode or processing buffers to the server.
3435  */
3436 VAStatus vaRenderPicture (
3437     VADisplay dpy,
3438     VAContextID context,
3439     VABufferID *buffers,
3440     int num_buffers
3441 );
3442
3443 /**
3444  * Make the end of rendering for a picture. 
3445  * The server should start processing all pending operations for this 
3446  * surface. This call is non-blocking. The client can start another 
3447  * Begin/Render/End sequence on a different render target.
3448  * if VAContextID used in this function previously successfully passed
3449  * vaMFAddContext call, real processing will be started during vaMFSubmit
3450  */
3451 VAStatus vaEndPicture (
3452     VADisplay dpy,
3453     VAContextID context
3454 );
3455
3456 /**
3457  * Make the end of rendering for a pictures in contexts passed with submission.
3458  * The server should start processing all pending operations for contexts.
3459  * All contexts passed should be associated through vaMFAddContext
3460  * and call sequence Begin/Render/End performed.
3461  * This call is non-blocking. The client can start another
3462  * Begin/Render/End/vaMFSubmit sequence on a different render targets.
3463  * Return values:
3464  * VA_STATUS_SUCCESS - operation successful, context was removed.
3465  * VA_STATUS_ERROR_INVALID_CONTEXT - mf_context or one of contexts are invalid
3466  * due to mf_context not created or one of contexts not assotiated with mf_context
3467  * through vaAddContext.
3468  * VA_STATUS_ERROR_INVALID_PARAMETER - one of context has not submitted it's frame
3469  * through vaBeginPicture vaRenderPicture vaEndPicture call sequence.
3470  * dpy: display
3471  * mf_context: Multi-Frame context
3472  * contexts: list of contexts submitting their tasks for multi-frame operation.
3473  * num_contexts: number of passed contexts.
3474  */
3475 VAStatus vaMFSubmit (
3476     VADisplay dpy,
3477     VAMFContextID mf_context,
3478     VAContextID * contexts,
3479     int num_contexts
3480 );
3481
3482 /*
3483
3484 Synchronization 
3485
3486 */
3487
3488 /**
3489  * This function blocks until all pending operations on the render target
3490  * have been completed.  Upon return it is safe to use the render target for a 
3491  * different picture. 
3492  */
3493 VAStatus vaSyncSurface (
3494     VADisplay dpy,
3495     VASurfaceID render_target
3496 );
3497
3498 typedef enum
3499 {
3500     VASurfaceRendering  = 1, /* Rendering in progress */ 
3501     VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */ 
3502                              /* this status is useful if surface is used as the source */
3503                              /* of an overlay */
3504     VASurfaceReady      = 4, /* not being rendered or displayed */
3505     VASurfaceSkipped    = 8  /* Indicate a skipped frame during encode */
3506 } VASurfaceStatus;
3507
3508 /**
3509  * Find out any pending ops on the render target 
3510  */
3511 VAStatus vaQuerySurfaceStatus (
3512     VADisplay dpy,
3513     VASurfaceID render_target,
3514     VASurfaceStatus *status     /* out */
3515 );
3516
3517 typedef enum
3518 {
3519     VADecodeSliceMissing            = 0,
3520     VADecodeMBError                 = 1,
3521 } VADecodeErrorType;
3522
3523 /**
3524  * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
3525  * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
3526 */
3527 typedef struct _VASurfaceDecodeMBErrors
3528 {
3529     int32_t status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
3530     uint32_t start_mb; /* start mb address with errors */
3531     uint32_t end_mb;  /* end mb address with errors */
3532     VADecodeErrorType decode_error_type;
3533     uint32_t num_mb;   /* number of mbs with errors */
3534     /** \brief Reserved bytes for future use, must be zero */
3535     uint32_t                va_reserved[VA_PADDING_LOW - 1];
3536 } VASurfaceDecodeMBErrors;
3537
3538 /**
3539  * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
3540  * it can call vaQuerySurfaceError to find out further details on the particular error.
3541  * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
3542  * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
3543  * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
3544  * The array is terminated if "status==-1" is detected.
3545  */
3546 VAStatus vaQuerySurfaceError(
3547     VADisplay dpy,
3548     VASurfaceID surface,
3549     VAStatus error_status,
3550     void **error_info
3551 );
3552
3553 /**
3554  * Images and Subpictures
3555  * VAImage is used to either get the surface data to client memory, or 
3556  * to copy image data in client memory to a surface. 
3557  * Both images, subpictures and surfaces follow the same 2D coordinate system where origin 
3558  * is at the upper left corner with positive X to the right and positive Y down
3559  */
3560 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
3561     ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
3562     ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
3563
3564 /* 
3565  * Pre-defined fourcc codes
3566  */
3567 #define VA_FOURCC_NV12          0x3231564E
3568 #define VA_FOURCC_NV21          0x3132564E
3569 #define VA_FOURCC_AI44          0x34344149
3570 #define VA_FOURCC_RGBA          0x41424752
3571 #define VA_FOURCC_RGBX          0x58424752
3572 #define VA_FOURCC_BGRA          0x41524742
3573 #define VA_FOURCC_BGRX          0x58524742
3574 #define VA_FOURCC_ARGB          0x42475241
3575 #define VA_FOURCC_XRGB          0x42475258
3576 #define VA_FOURCC_ABGR          0x52474241
3577 #define VA_FOURCC_XBGR          0x52474258
3578 #define VA_FOURCC_UYVY          0x59565955
3579 #define VA_FOURCC_YUY2          0x32595559
3580 #define VA_FOURCC_AYUV          0x56555941
3581 #define VA_FOURCC_NV11          0x3131564e
3582 #define VA_FOURCC_YV12          0x32315659
3583 #define VA_FOURCC_P208          0x38303250
3584 /* IYUV same as I420, but most user perfer I420, will deprecate it */
3585 #define VA_FOURCC_IYUV          0x56555949
3586 #define VA_FOURCC_I420          0x30323449
3587 #define VA_FOURCC_YV24          0x34325659
3588 #define VA_FOURCC_YV32          0x32335659
3589 #define VA_FOURCC_Y800          0x30303859
3590 #define VA_FOURCC_IMC3          0x33434D49
3591 #define VA_FOURCC_411P          0x50313134
3592 #define VA_FOURCC_422H          0x48323234
3593 #define VA_FOURCC_422V          0x56323234
3594 #define VA_FOURCC_444P          0x50343434
3595 #define VA_FOURCC_RGBP          0x50424752
3596 #define VA_FOURCC_BGRP          0x50524742
3597 #define VA_FOURCC_411R          0x52313134 /* rotated 411P */
3598 #define VA_FOURCC_RGB565        0x36314752 /* VA_FOURCC('R','G','1','6') */
3599 #define VA_FOURCC_BGR565        0x36314742 /* VA_FOURCC('B','G','1','6') */
3600
3601 #define VA_FOURCC_Y210          0x30313259
3602 #define VA_FOURCC_Y216          0x36313259
3603 #define VA_FOURCC_Y410          0x30313459
3604 #define VA_FOURCC_Y416          0x36313459
3605
3606 /**
3607  * Planar YUV 4:2:2.
3608  * 8-bit Y plane, followed by 8-bit 2x1 subsampled V and U planes
3609  */
3610 #define VA_FOURCC_YV16          0x36315659
3611 /**
3612  * 10-bit and 16-bit Planar YUV 4:2:0. 
3613  */
3614 #define VA_FOURCC_P010          0x30313050
3615 #define VA_FOURCC_P016          0x36313050
3616
3617 /**
3618  * 10-bit Planar YUV 420 and occupy the lower 10-bit.
3619  */
3620 #define VA_FOURCC_I010          0x30313049
3621
3622 /* byte order */
3623 #define VA_LSB_FIRST            1
3624 #define VA_MSB_FIRST            2
3625
3626 typedef struct _VAImageFormat
3627 {
3628     uint32_t    fourcc;
3629     uint32_t    byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
3630     uint32_t    bits_per_pixel;
3631     /* for RGB formats */
3632     uint32_t    depth; /* significant bits per pixel */
3633     uint32_t    red_mask;
3634     uint32_t    green_mask;
3635     uint32_t    blue_mask;
3636     uint32_t    alpha_mask;
3637
3638     /** \brief Reserved bytes for future use, must be zero */
3639     uint32_t                va_reserved[VA_PADDING_LOW];
3640 } VAImageFormat;
3641
3642 typedef VAGenericID VAImageID;
3643
3644 typedef struct _VAImage
3645 {
3646     VAImageID           image_id; /* uniquely identify this image */
3647     VAImageFormat       format;
3648     VABufferID          buf;    /* image data buffer */
3649     /*
3650      * Image data will be stored in a buffer of type VAImageBufferType to facilitate
3651      * data store on the server side for optimal performance. The buffer will be 
3652      * created by the CreateImage function, and proper storage allocated based on the image
3653      * size and format. This buffer is managed by the library implementation, and 
3654      * accessed by the client through the buffer Map/Unmap functions.
3655      */
3656     uint16_t    width; 
3657     uint16_t    height;
3658     uint32_t    data_size;
3659     uint32_t    num_planes;     /* can not be greater than 3 */
3660     /* 
3661      * An array indicating the scanline pitch in bytes for each plane.
3662      * Each plane may have a different pitch. Maximum 3 planes for planar formats
3663      */
3664     uint32_t    pitches[3];
3665     /* 
3666      * An array indicating the byte offset from the beginning of the image data 
3667      * to the start of each plane.
3668      */
3669     uint32_t    offsets[3];
3670
3671     /* The following fields are only needed for paletted formats */
3672     int32_t num_palette_entries;   /* set to zero for non-palette images */
3673     /* 
3674      * Each component is one byte and entry_bytes indicates the number of components in 
3675      * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images   
3676      */
3677     int32_t entry_bytes; 
3678     /*
3679      * An array of ascii characters describing the order of the components within the bytes.
3680      * Only entry_bytes characters of the string are used.
3681      */
3682     int8_t component_order[4];
3683
3684     /** \brief Reserved bytes for future use, must be zero */
3685     uint32_t                va_reserved[VA_PADDING_LOW];
3686 } VAImage;
3687
3688 /** Get maximum number of image formats supported by the implementation */
3689 int vaMaxNumImageFormats (
3690     VADisplay dpy
3691 );
3692
3693 /**
3694  * Query supported image formats 
3695  * The caller must provide a "format_list" array that can hold at
3696  * least vaMaxNumImageFormats() entries. The actual number of formats
3697  * returned in "format_list" is returned in "num_formats".
3698  */
3699 VAStatus vaQueryImageFormats (
3700     VADisplay dpy,
3701     VAImageFormat *format_list, /* out */
3702     int *num_formats            /* out */
3703 );
3704
3705 /**
3706  * Create a VAImage structure
3707  * The width and height fields returned in the VAImage structure may get 
3708  * enlarged for some YUV formats. Upon return from this function, 
3709  * image->buf has been created and proper storage allocated by the library. 
3710  * The client can access the image through the Map/Unmap calls.
3711  */
3712 VAStatus vaCreateImage (
3713     VADisplay dpy,
3714     VAImageFormat *format,
3715     int width,
3716     int height,
3717     VAImage *image      /* out */
3718 );
3719
3720 /**
3721  * Should call DestroyImage before destroying the surface it is bound to
3722  */
3723 VAStatus vaDestroyImage (
3724     VADisplay dpy,
3725     VAImageID image
3726 );
3727
3728 VAStatus vaSetImagePalette (
3729     VADisplay dpy,
3730     VAImageID image,
3731     /* 
3732      * pointer to an array holding the palette data.  The size of the array is 
3733      * num_palette_entries * entry_bytes in size.  The order of the components 
3734      * in the palette is described by the component_order in VAImage struct    
3735      */
3736     unsigned char *palette 
3737 );
3738
3739 /**
3740  * Retrive surface data into a VAImage
3741  * Image must be in a format supported by the implementation
3742  */
3743 VAStatus vaGetImage (
3744     VADisplay dpy,
3745     VASurfaceID surface,
3746     int x,      /* coordinates of the upper left source pixel */
3747     int y,
3748     unsigned int width, /* width and height of the region */
3749     unsigned int height,
3750     VAImageID image
3751 );
3752
3753 /**
3754  * Copy data from a VAImage to a surface
3755  * Image must be in a format supported by the implementation
3756  * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
3757  * shouldn't be rendered into when this is called
3758  */
3759 VAStatus vaPutImage (
3760     VADisplay dpy,
3761     VASurfaceID surface,
3762     VAImageID image,
3763     int src_x,
3764     int src_y,
3765     unsigned int src_width,
3766     unsigned int src_height,
3767     int dest_x,
3768     int dest_y,
3769     unsigned int dest_width,
3770     unsigned int dest_height
3771 );
3772
3773 /**
3774  * Derive an VAImage from an existing surface.
3775  * This interface will derive a VAImage and corresponding image buffer from
3776  * an existing VA Surface. The image buffer can then be mapped/unmapped for
3777  * direct CPU access. This operation is only possible on implementations with
3778  * direct rendering capabilities and internal surface formats that can be
3779  * represented with a VAImage. When the operation is not possible this interface
3780  * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
3781  * to using vaCreateImage + vaPutImage to accomplish the same task in an
3782  * indirect manner.
3783  *
3784  * Implementations should only return success when the resulting image buffer
3785  * would be useable with vaMap/Unmap.
3786  *
3787  * When directly accessing a surface special care must be taken to insure
3788  * proper synchronization with the graphics hardware. Clients should call
3789  * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
3790  * rendering or currently being displayed by an overlay.
3791  *
3792  * Additionally nothing about the contents of a surface should be assumed
3793  * following a vaPutSurface. Implementations are free to modify the surface for
3794  * scaling or subpicture blending within a call to vaPutImage.
3795  *
3796  * Calls to vaPutImage or vaGetImage using the same surface from which the image
3797  * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
3798  * vaGetImage with other surfaces is supported.
3799  *
3800  * An image created with vaDeriveImage should be freed with vaDestroyImage. The
3801  * image and image buffer structures will be destroyed; however, the underlying
3802  * surface will remain unchanged until freed with vaDestroySurfaces.
3803  */
3804 VAStatus vaDeriveImage (
3805     VADisplay dpy,
3806     VASurfaceID surface,
3807     VAImage *image      /* out */
3808 );
3809
3810 /**
3811  * Subpictures 
3812  * Subpicture is a special type of image that can be blended 
3813  * with a surface during vaPutSurface(). Subpicture can be used to render
3814  * DVD sub-titles or closed captioning text etc.  
3815  */
3816
3817 typedef VAGenericID VASubpictureID;
3818
3819 /** Get maximum number of subpicture formats supported by the implementation */
3820 int vaMaxNumSubpictureFormats (
3821     VADisplay dpy
3822 );
3823
3824 /** flags for subpictures */
3825 #define VA_SUBPICTURE_CHROMA_KEYING                     0x0001
3826 #define VA_SUBPICTURE_GLOBAL_ALPHA                      0x0002
3827 #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD       0x0004
3828 /**
3829  * Query supported subpicture formats 
3830  * The caller must provide a "format_list" array that can hold at
3831  * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag 
3832  * for each format to indicate additional capabilities for that format. The actual 
3833  * number of formats returned in "format_list" is returned in "num_formats".
3834  *  flags: returned value to indicate addtional capabilities
3835  *         VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
3836  *         VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
3837  *         VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
3838  */
3839
3840 VAStatus vaQuerySubpictureFormats (
3841     VADisplay dpy,
3842     VAImageFormat *format_list, /* out */
3843     unsigned int *flags,        /* out */
3844     unsigned int *num_formats   /* out */
3845 );
3846
3847 /**
3848  * Subpictures are created with an image associated. 
3849  */
3850 VAStatus vaCreateSubpicture (
3851     VADisplay dpy,
3852     VAImageID image,
3853     VASubpictureID *subpicture  /* out */
3854 );
3855
3856 /**
3857  * Destroy the subpicture before destroying the image it is assocated to
3858  */
3859 VAStatus vaDestroySubpicture (
3860     VADisplay dpy,
3861     VASubpictureID subpicture
3862 );
3863
3864 /**
3865  * Bind an image to the subpicture. This image will now be associated with 
3866  * the subpicture instead of the one at creation.
3867  */
3868 VAStatus vaSetSubpictureImage (
3869     VADisplay dpy,
3870     VASubpictureID subpicture,
3871     VAImageID image
3872 );
3873
3874 /**
3875  * If chromakey is enabled, then the area where the source value falls within
3876  * the chromakey [min, max] range is transparent
3877  * The chromakey component format is the following:
3878  *  For RGB: [0:7] Red [8:15] Blue [16:23] Green   
3879  *  For YUV: [0:7] V [8:15] U [16:23] Y
3880  * The chromakey mask can be used to mask out certain components for chromakey
3881  * comparision
3882  */
3883 VAStatus vaSetSubpictureChromakey (
3884     VADisplay dpy,
3885     VASubpictureID subpicture,
3886     unsigned int chromakey_min,
3887     unsigned int chromakey_max,
3888     unsigned int chromakey_mask
3889 );
3890
3891 /**
3892  * Global alpha value is between 0 and 1. A value of 1 means fully opaque and 
3893  * a value of 0 means fully transparent. If per-pixel alpha is also specified then
3894  * the overall alpha is per-pixel alpha multiplied by the global alpha
3895  */
3896 VAStatus vaSetSubpictureGlobalAlpha (
3897     VADisplay dpy,
3898     VASubpictureID subpicture,
3899     float global_alpha 
3900 );
3901
3902 /**
3903  * vaAssociateSubpicture associates the subpicture with target_surfaces.
3904  * It defines the region mapping between the subpicture and the target  
3905  * surfaces through source and destination rectangles (with the same width and height).
3906  * Both will be displayed at the next call to vaPutSurface.  Additional
3907  * associations before the call to vaPutSurface simply overrides the association.
3908  */
3909 VAStatus vaAssociateSubpicture (
3910     VADisplay dpy,
3911     VASubpictureID subpicture,
3912     VASurfaceID *target_surfaces,
3913     int num_surfaces,
3914     int16_t src_x, /* upper left offset in subpicture */
3915     int16_t src_y,
3916     uint16_t src_width,
3917     uint16_t src_height,
3918     int16_t dest_x, /* upper left offset in surface */
3919     int16_t dest_y,
3920     uint16_t dest_width,
3921     uint16_t dest_height,
3922     /*
3923      * whether to enable chroma-keying, global-alpha, or screen relative mode
3924      * see VA_SUBPICTURE_XXX values
3925      */
3926     uint32_t flags
3927 );
3928
3929 /**
3930  * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
3931  */
3932 VAStatus vaDeassociateSubpicture (
3933     VADisplay dpy,
3934     VASubpictureID subpicture,
3935     VASurfaceID *target_surfaces,
3936     int num_surfaces
3937 );
3938
3939 /**
3940  * Display attributes
3941  * Display attributes are used to control things such as contrast, hue, saturation,
3942  * brightness etc. in the rendering process.  The application can query what
3943  * attributes are supported by the driver, and then set the appropriate attributes
3944  * before calling vaPutSurface()
3945  */
3946 /* PowerVR IEP Lite attributes */
3947 typedef enum
3948 {
3949     VADISPLAYATTRIB_BLE_OFF              = 0x00,
3950     VADISPLAYATTRIB_BLE_LOW,
3951     VADISPLAYATTRIB_BLE_MEDIUM,
3952     VADISPLAYATTRIB_BLE_HIGH,
3953     VADISPLAYATTRIB_BLE_NONE,
3954 } VADisplayAttribBLEMode;
3955
3956 /** attribute value for VADisplayAttribRotation   */
3957 #define VA_ROTATION_NONE        0x00000000
3958 #define VA_ROTATION_90          0x00000001
3959 #define VA_ROTATION_180         0x00000002
3960 #define VA_ROTATION_270         0x00000003
3961 /**@}*/
3962
3963 /**
3964  * @name Mirroring directions
3965  *
3966  * Those values could be used for VADisplayAttribMirror attribute or
3967  * VAProcPipelineParameterBuffer::mirror_state.
3968
3969  */
3970 /**@{*/
3971 /** \brief No Mirroring. */
3972 #define VA_MIRROR_NONE              0x00000000
3973 /** \brief Horizontal Mirroring. */
3974 #define VA_MIRROR_HORIZONTAL        0x00000001
3975 /** \brief Vertical Mirroring. */
3976 #define VA_MIRROR_VERTICAL          0x00000002
3977 /**@}*/
3978
3979 /** attribute value for VADisplayAttribOutOfLoopDeblock */
3980 #define VA_OOL_DEBLOCKING_FALSE 0x00000000
3981 #define VA_OOL_DEBLOCKING_TRUE  0x00000001
3982
3983 /** Render mode */
3984 #define VA_RENDER_MODE_UNDEFINED           0
3985 #define VA_RENDER_MODE_LOCAL_OVERLAY       1
3986 #define VA_RENDER_MODE_LOCAL_GPU           2
3987 #define VA_RENDER_MODE_EXTERNAL_OVERLAY    4
3988 #define VA_RENDER_MODE_EXTERNAL_GPU        8
3989
3990 /** Render device */
3991 #define VA_RENDER_DEVICE_UNDEFINED  0
3992 #define VA_RENDER_DEVICE_LOCAL      1
3993 #define VA_RENDER_DEVICE_EXTERNAL   2
3994
3995 /** Currently defined display attribute types */
3996 typedef enum
3997 {
3998     VADisplayAttribBrightness           = 0,
3999     VADisplayAttribContrast             = 1,
4000     VADisplayAttribHue                  = 2,
4001     VADisplayAttribSaturation           = 3,
4002     /* client can specifiy a background color for the target window
4003      * the new feature of video conference,
4004      * the uncovered area of the surface is filled by this color
4005      * also it will blend with the decoded video color
4006      */
4007     VADisplayAttribBackgroundColor      = 4,
4008     /*
4009      * this is a gettable only attribute. For some implementations that use the
4010      * hardware overlay, after PutSurface is called, the surface can not be    
4011      * re-used until after the subsequent PutSurface call. If this is the case 
4012      * then the value for this attribute will be set to 1 so that the client   
4013      * will not attempt to re-use the surface right after returning from a call
4014      * to PutSurface.
4015      *
4016      * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
4017      * driver may use overlay or GPU alternatively
4018      */
4019     VADisplayAttribDirectSurface       = 5,
4020     VADisplayAttribRotation            = 6,     
4021     VADisplayAttribOutofLoopDeblock    = 7,
4022
4023     /* PowerVR IEP Lite specific attributes */
4024     VADisplayAttribBLEBlackMode        = 8,
4025     VADisplayAttribBLEWhiteMode        = 9,
4026     VADisplayAttribBlueStretch         = 10,
4027     VADisplayAttribSkinColorCorrection = 11,
4028     /*
4029      * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
4030      * conversion matrix. Each element in the matrix is float-point
4031      */
4032     VADisplayAttribCSCMatrix           = 12,
4033     /* specify the constant color used to blend with video surface
4034      * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
4035      *      d: the final color to overwrite into the frame buffer 
4036      *      v: decoded video after color conversion, 
4037      *      c: video color specified by VADisplayAttribBlendColor
4038      *      b: background color of the drawable
4039      */
4040     VADisplayAttribBlendColor          = 13,
4041     /*
4042      * Indicate driver to skip painting color key or not.
4043      * only applicable if the render is overlay
4044      */
4045     VADisplayAttribOverlayAutoPaintColorKey   = 14,
4046     /*
4047      * customized overlay color key, the format is RGB888
4048      * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
4049      */
4050     VADisplayAttribOverlayColorKey      = 15,
4051     /*
4052      * The hint for the implementation of vaPutSurface
4053      * normally, the driver could use an overlay or GPU to render the surface on the screen
4054      * this flag provides APP the flexibity to switch the render dynamically
4055      */
4056     VADisplayAttribRenderMode           = 16,
4057     /*
4058      * specify if vaPutSurface needs to render into specified monitors
4059      * one example is that one external monitor (e.g. HDMI) is enabled, 
4060      * but the window manager is not aware of it, and there is no associated drawable
4061      */
4062     VADisplayAttribRenderDevice        = 17,
4063     /*
4064      * specify vaPutSurface render area if there is no drawable on the monitor
4065      */
4066     VADisplayAttribRenderRect          = 18,
4067 } VADisplayAttribType;
4068
4069 /* flags for VADisplayAttribute */
4070 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
4071 #define VA_DISPLAY_ATTRIB_GETTABLE      0x0001
4072 #define VA_DISPLAY_ATTRIB_SETTABLE      0x0002
4073
4074 typedef struct _VADisplayAttribute
4075 {
4076     VADisplayAttribType type;
4077     int32_t min_value;
4078     int32_t max_value;
4079     int32_t value;      /* used by the set/get attribute functions */
4080 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
4081     uint32_t flags;
4082
4083     /** \brief Reserved bytes for future use, must be zero */
4084     uint32_t                va_reserved[VA_PADDING_LOW];
4085 } VADisplayAttribute;
4086
4087 /** Get maximum number of display attributs supported by the implementation */
4088 int vaMaxNumDisplayAttributes (
4089     VADisplay dpy
4090 );
4091
4092 /**
4093  * Query display attributes 
4094  * The caller must provide a "attr_list" array that can hold at
4095  * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
4096  * returned in "attr_list" is returned in "num_attributes".
4097  */
4098 VAStatus vaQueryDisplayAttributes (
4099     VADisplay dpy,
4100     VADisplayAttribute *attr_list,      /* out */
4101     int *num_attributes                 /* out */
4102 );
4103
4104 /**
4105  * Get display attributes 
4106  * This function returns the current attribute values in "attr_list".
4107  * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
4108  * from vaQueryDisplayAttributes() can have their values retrieved.  
4109  */
4110 VAStatus vaGetDisplayAttributes (
4111     VADisplay dpy,
4112     VADisplayAttribute *attr_list,      /* in/out */
4113     int num_attributes
4114 );
4115
4116 /**
4117  * Set display attributes 
4118  * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
4119  * from vaQueryDisplayAttributes() can be set.  If the attribute is not settable or 
4120  * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
4121  */
4122 VAStatus vaSetDisplayAttributes (
4123     VADisplay dpy,
4124     VADisplayAttribute *attr_list,
4125     int num_attributes
4126 );
4127
4128 /****************************
4129  * HEVC data structures
4130  ****************************/
4131 /** 
4132  * \brief Description of picture properties of those in DPB surfaces.
4133  *
4134  * If only progressive scan is supported, each surface contains one whole 
4135  * frame picture.
4136  * Otherwise, each surface contains two fields of whole picture.
4137  * In this case, two entries of ReferenceFrames[] may share same picture_id
4138  * value.
4139  */
4140 typedef struct _VAPictureHEVC
4141 {
4142     /** \brief reconstructed picture buffer surface index 
4143      * invalid when taking value VA_INVALID_SURFACE.
4144      */
4145     VASurfaceID             picture_id;
4146     /** \brief picture order count. 
4147      * in HEVC, POCs for top and bottom fields of same picture should
4148      * take different values.
4149      */
4150     int32_t                 pic_order_cnt;
4151     /* described below */
4152     uint32_t                flags;
4153
4154     /** \brief Reserved bytes for future use, must be zero */
4155     uint32_t                va_reserved[VA_PADDING_LOW];
4156 } VAPictureHEVC;
4157
4158 /* flags in VAPictureHEVC could be OR of the following */
4159 #define VA_PICTURE_HEVC_INVALID                 0x00000001
4160 /** \brief indication of interlace scan picture. 
4161  * should take same value for all the pictures in sequence.
4162  */ 
4163 #define VA_PICTURE_HEVC_FIELD_PIC               0x00000002
4164 /** \brief polarity of the field picture.
4165  * top field takes even lines of buffer surface.
4166  * bottom field takes odd lines of buffer surface.
4167  */
4168 #define VA_PICTURE_HEVC_BOTTOM_FIELD            0x00000004
4169 /** \brief Long term reference picture */
4170 #define VA_PICTURE_HEVC_LONG_TERM_REFERENCE     0x00000008
4171 /**
4172  * VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
4173  * and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should 
4174  * be exclusive. No more than one of them can be set for any picture.
4175  * Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
4176  * equals NumPocTotalCurr, which should be equal to or smaller than 8.
4177  * Application should provide valid values for both short format and long format.
4178  * The pictures in DPB with any of these three flags turned on are referred by
4179  * the current picture.
4180  */
4181 /** \brief RefPicSetStCurrBefore of HEVC spec variable 
4182  * Number of ReferenceFrames[] entries with this bit set equals 
4183  * NumPocStCurrBefore.
4184  */
4185 #define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE      0x00000010
4186 /** \brief RefPicSetStCurrAfter of HEVC spec variable
4187  * Number of ReferenceFrames[] entries with this bit set equals 
4188  * NumPocStCurrAfter.
4189  */
4190 #define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER       0x00000020
4191 /** \brief RefPicSetLtCurr of HEVC spec variable
4192  * Number of ReferenceFrames[] entries with this bit set equals 
4193  * NumPocLtCurr.
4194  */
4195 #define VA_PICTURE_HEVC_RPS_LT_CURR             0x00000040
4196
4197 #include <va/va_dec_hevc.h>
4198 #include <va/va_dec_jpeg.h>
4199 #include <va/va_dec_vp8.h>
4200 #include <va/va_dec_vp9.h>
4201 #include <va/va_enc_hevc.h>
4202 #include <va/va_fei_hevc.h>
4203 #include <va/va_enc_h264.h>
4204 #include <va/va_enc_jpeg.h>
4205 #include <va/va_enc_mpeg2.h>
4206 #include <va/va_enc_vp8.h>
4207 #include <va/va_enc_vp9.h>
4208 #include <va/va_fei.h>
4209 #include <va/va_fei_h264.h>
4210 #include <va/va_vpp.h>
4211
4212 /**@}*/
4213
4214 #ifdef __cplusplus
4215 }
4216 #endif
4217
4218 #endif /* _VA_H_ */