OSDN Git Service

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