OSDN Git Service

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