OSDN Git Service

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