Add new bit to signal VC-1 skipped P-frames.
[profile/ivi/libva.git] / src / 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  *
57  * Acknowledgements:
58  *  Some concepts borrowed from XvMC and XvImage.
59  *  Waldo Bastian (Intel), Matt Sottek (Intel),  Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
60  *  contributed to various aspects of the API.
61  */
62
63 #ifndef _VA_H_
64 #define _VA_H_
65
66 #ifdef IN_LIBVA
67 #include "va_version.h"
68 #else
69 #include <va/va_version.h>
70 #endif
71
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75
76 /* 
77 Overview 
78
79 The VA API is intended to provide an interface between a video decode/encode/display
80 application (client) and a hardware accelerator (server), to off-load 
81 video decode/encode/display operations from the host to the hardware accelerator at various 
82 entry-points.
83
84 The basic operation steps are:
85
86 - Negotiate a mutually acceptable configuration with the server to lock
87   down profile, entrypoints, and other attributes that will not change on 
88   a frame-by-frame basis.
89 - Create a decode context which represents a "virtualized" hardware decode 
90   device
91 - Get and fill decode buffers with picture level, slice level and macroblock 
92   level data (depending on entrypoints)
93 - Pass the decode buffers to the server to decode the current frame
94
95 Initialization & Configuration Management 
96
97 - Find out supported profiles
98 - Find out entrypoints for a given profile
99 - Find out configuration attributes for a given profile/entrypoint pair
100 - Create a configuration for use by the decoder
101
102 */
103
104 typedef void* VADisplay;        /* window system dependent */
105
106 typedef int VAStatus;   /* Return status type from functions */
107 /* Values for the return status */
108 #define VA_STATUS_SUCCESS                       0x00000000
109 #define VA_STATUS_ERROR_OPERATION_FAILED        0x00000001
110 #define VA_STATUS_ERROR_ALLOCATION_FAILED       0x00000002
111 #define VA_STATUS_ERROR_INVALID_DISPLAY         0x00000003
112 #define VA_STATUS_ERROR_INVALID_CONFIG          0x00000004
113 #define VA_STATUS_ERROR_INVALID_CONTEXT         0x00000005
114 #define VA_STATUS_ERROR_INVALID_SURFACE         0x00000006
115 #define VA_STATUS_ERROR_INVALID_BUFFER          0x00000007
116 #define VA_STATUS_ERROR_INVALID_IMAGE           0x00000008
117 #define VA_STATUS_ERROR_INVALID_SUBPICTURE      0x00000009
118 #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED      0x0000000a
119 #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED        0x0000000b
120 #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE     0x0000000c
121 #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT  0x0000000d
122 #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT   0x0000000e
123 #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE  0x0000000f
124 #define VA_STATUS_ERROR_SURFACE_BUSY            0x00000010
125 #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED      0x00000011
126 #define VA_STATUS_ERROR_INVALID_PARAMETER       0x00000012
127 #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
128 #define VA_STATUS_ERROR_UNKNOWN                 0xFFFFFFFF
129
130 /*
131  * Returns a short english description of error_status
132  */
133 const char *vaErrorStr(VAStatus error_status);
134
135 /*
136  * Initialization:
137  * A display must be obtained by calling vaGetDisplay() before calling
138  * vaInitialize() and other functions. This connects the API to the 
139  * native window system.
140  * For X Windows, native_dpy would be from XOpenDisplay()
141  */
142 typedef void* NativeDisplay;    /* window system dependent */
143
144 /*
145  * Initialize the library 
146  */
147 VAStatus vaInitialize (
148     VADisplay dpy,
149     int *major_version,  /* out */
150     int *minor_version   /* out */
151 );
152
153 /*
154  * After this call, all library internal resources will be cleaned up
155  */ 
156 VAStatus vaTerminate (
157     VADisplay dpy
158 );
159
160 /*
161  * vaQueryVendorString returns a pointer to a zero-terminated string
162  * describing some aspects of the VA implemenation on a specific    
163  * hardware accelerator. The format of the returned string is vendor
164  * specific and at the discretion of the implementer.
165  * e.g. for the Intel GMA500 implementation, an example would be:
166  * "Intel GMA500 - 2.0.0.32L.0005"
167  */
168 const char *vaQueryVendorString (
169     VADisplay dpy
170 );
171
172 typedef int (*VAPrivFunc)();
173
174 /*
175  * Return a function pointer given a function name in the library.
176  * This allows private interfaces into the library
177  */ 
178 VAPrivFunc vaGetLibFunc (
179     VADisplay dpy,
180     const char *func
181 );
182
183 /* Currently defined profiles */
184 typedef enum
185 {
186     VAProfileMPEG2Simple                = 0,
187     VAProfileMPEG2Main                  = 1,
188     VAProfileMPEG4Simple                = 2,
189     VAProfileMPEG4AdvancedSimple        = 3,
190     VAProfileMPEG4Main                  = 4,
191     VAProfileH264Baseline               = 5,
192     VAProfileH264Main                   = 6,
193     VAProfileH264High                   = 7,
194     VAProfileVC1Simple                  = 8,
195     VAProfileVC1Main                    = 9,
196     VAProfileVC1Advanced                = 10,
197     VAProfileH263Baseline               = 11
198 } VAProfile;
199
200 /* 
201  *  Currently defined entrypoints 
202  */
203 typedef enum
204 {
205     VAEntrypointVLD             = 1,
206     VAEntrypointIZZ             = 2,
207     VAEntrypointIDCT            = 3,
208     VAEntrypointMoComp          = 4,
209     VAEntrypointDeblocking      = 5,
210     VAEntrypointEncSlice        = 6     /* slice level encode */
211 } VAEntrypoint;
212
213 /* Currently defined configuration attribute types */
214 typedef enum
215 {
216     VAConfigAttribRTFormat              = 0,
217     VAConfigAttribSpatialResidual       = 1,
218     VAConfigAttribSpatialClipping       = 2,
219     VAConfigAttribIntraResidual         = 3,
220     VAConfigAttribEncryption            = 4,
221     VAConfigAttribRateControl           = 5
222 } VAConfigAttribType;
223
224 /*
225  * Configuration attributes
226  * If there is more than one value for an attribute, a default
227  * value will be assigned to the attribute if the client does not
228  * specify the attribute when creating a configuration
229  */
230 typedef struct _VAConfigAttrib {
231     VAConfigAttribType type;
232     unsigned int value; /* OR'd flags (bits) for this attribute */
233 } VAConfigAttrib;
234
235 /* attribute value for VAConfigAttribRTFormat */
236 #define VA_RT_FORMAT_YUV420     0x00000001      
237 #define VA_RT_FORMAT_YUV422     0x00000002
238 #define VA_RT_FORMAT_YUV444     0x00000004
239 #define VA_RT_FORMAT_PROTECTED  0x80000000
240
241 /* attribute value for VAConfigAttribRateControl */
242 #define VA_RC_NONE      0x00000001      
243 #define VA_RC_CBR       0x00000002      
244 #define VA_RC_VBR       0x00000004      
245
246 /*
247  * if an attribute is not applicable for a given
248  * profile/entrypoint pair, then set the value to the following 
249  */
250 #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
251
252 /* Get maximum number of profiles supported by the implementation */
253 int vaMaxNumProfiles (
254     VADisplay dpy
255 );
256
257 /* Get maximum number of entrypoints supported by the implementation */
258 int vaMaxNumEntrypoints (
259     VADisplay dpy
260 );
261
262 /* Get maximum number of attributs supported by the implementation */
263 int vaMaxNumConfigAttributes (
264     VADisplay dpy
265 );
266
267 /* 
268  * Query supported profiles 
269  * The caller must provide a "profile_list" array that can hold at
270  * least vaMaxNumProfile() entries. The actual number of profiles
271  * returned in "profile_list" is returned in "num_profile".
272  */
273 VAStatus vaQueryConfigProfiles (
274     VADisplay dpy,
275     VAProfile *profile_list,    /* out */
276     int *num_profiles           /* out */
277 );
278
279 /* 
280  * Query supported entrypoints for a given profile 
281  * The caller must provide an "entrypoint_list" array that can hold at
282  * least vaMaxNumEntrypoints() entries. The actual number of entrypoints 
283  * returned in "entrypoint_list" is returned in "num_entrypoints".
284  */
285 VAStatus vaQueryConfigEntrypoints (
286     VADisplay dpy,
287     VAProfile profile,
288     VAEntrypoint *entrypoint_list,      /* out */
289     int *num_entrypoints                /* out */
290 );
291
292 /* 
293  * Get attributes for a given profile/entrypoint pair 
294  * The caller must provide an "attrib_list" with all attributes to be 
295  * retrieved.  Upon return, the attributes in "attrib_list" have been 
296  * updated with their value.  Unknown attributes or attributes that are 
297  * not supported for the given profile/entrypoint pair will have their 
298  * value set to VA_ATTRIB_NOT_SUPPORTED
299  */
300 VAStatus vaGetConfigAttributes (
301     VADisplay dpy,
302     VAProfile profile,
303     VAEntrypoint entrypoint,
304     VAConfigAttrib *attrib_list, /* in/out */
305     int num_attribs
306 );
307
308 /* Generic ID type, can be re-typed for specific implementation */
309 typedef unsigned int VAGenericID;
310
311 typedef VAGenericID VAConfigID;
312
313 /* 
314  * Create a configuration for the decode pipeline 
315  * it passes in the attribute list that specifies the attributes it cares 
316  * about, with the rest taking default values.  
317  */
318 VAStatus vaCreateConfig (
319     VADisplay dpy,
320     VAProfile profile, 
321     VAEntrypoint entrypoint, 
322     VAConfigAttrib *attrib_list,
323     int num_attribs,
324     VAConfigID *config_id /* out */
325 );
326
327 /* 
328  * Free resources associdated with a given config 
329  */
330 VAStatus vaDestroyConfig (
331     VADisplay dpy,
332     VAConfigID config_id
333 );
334
335 /* 
336  * Query all attributes for a given configuration 
337  * The profile of the configuration is returned in "profile"
338  * The entrypoint of the configuration is returned in "entrypoint"
339  * The caller must provide an "attrib_list" array that can hold at least 
340  * vaMaxNumConfigAttributes() entries. The actual number of attributes 
341  * returned in "attrib_list" is returned in "num_attribs"
342  */
343 VAStatus vaQueryConfigAttributes (
344     VADisplay dpy,
345     VAConfigID config_id, 
346     VAProfile *profile,         /* out */
347     VAEntrypoint *entrypoint,   /* out */
348     VAConfigAttrib *attrib_list,/* out */
349     int *num_attribs            /* out */
350 );
351
352
353 /*
354  * Contexts and Surfaces
355  *
356  * Context represents a "virtual" video decode pipeline. Surfaces are render 
357  * targets for a given context. The data in the surfaces are not accessible  
358  * to the client and the internal data format of the surface is implementatin 
359  * specific. 
360  *
361  * Surfaces will be bound to a context when the context is created. Once
362  * a surface is bound to a given context, it can not be used to create  
363  * another context. The association is removed when the context is destroyed
364  * 
365  * Both contexts and surfaces are identified by unique IDs and its
366  * implementation specific internals are kept opaque to the clients
367  */
368
369 typedef VAGenericID VAContextID;
370
371 typedef VAGenericID VASurfaceID;
372
373 #define VA_INVALID_ID           0xffffffff
374 #define VA_INVALID_SURFACE      VA_INVALID_ID
375
376 /* 
377  * vaCreateSurfaces - Create an array of surfaces used for decode and display  
378  *  dpy: display
379  *  width: surface width
380  *  height: surface height
381  *  format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
382  *  num_surfaces: number of surfaces to be created
383  *  surfaces: array of surfaces created upon return
384  */
385 VAStatus vaCreateSurfaces (
386     VADisplay dpy,
387     int width,
388     int height,
389     int format,
390     int num_surfaces,
391     VASurfaceID *surfaces       /* out */
392 );
393
394 /*
395  * vaDestroySurfaces - Destroy resources associated with surfaces. 
396  *  Surfaces can only be destroyed after the context associated has been 
397  *  destroyed.  
398  *  dpy: display
399  *  surfaces: array of surfaces to destroy
400  *  num_surfaces: number of surfaces in the array to be destroyed.
401  */
402 VAStatus vaDestroySurfaces (
403     VADisplay dpy,
404     VASurfaceID *surfaces,
405     int num_surfaces
406 );
407
408 #define VA_PROGRESSIVE 0x1
409 /*
410  * vaCreateContext - Create a context
411  *  dpy: display
412  *  config_id: configuration for the context
413  *  picture_width: coded picture width
414  *  picture_height: coded picture height
415  *  flag: any combination of the following:
416  *    VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
417  *  render_targets: render targets (surfaces) tied to the context
418  *  num_render_targets: number of render targets in the above array
419  *  context: created context id upon return
420  */
421 VAStatus vaCreateContext (
422     VADisplay dpy,
423     VAConfigID config_id,
424     int picture_width,
425     int picture_height,
426     int flag,
427     VASurfaceID *render_targets,
428     int num_render_targets,
429     VAContextID *context                /* out */
430 );
431
432 /*
433  * vaDestroyContext - Destroy a context 
434  *  dpy: display
435  *  context: context to be destroyed
436  */
437 VAStatus vaDestroyContext (
438     VADisplay dpy,
439     VAContextID context
440 );
441
442 /*
443  * Buffers 
444  * Buffers are used to pass various types of data from the
445  * client to the server. The server maintains a data store
446  * for each buffer created, and the client idenfies a buffer
447  * through a unique buffer id assigned by the server.
448  */
449
450 typedef VAGenericID VABufferID;
451
452 typedef enum
453 {
454     VAPictureParameterBufferType        = 0,
455     VAIQMatrixBufferType                = 1,
456     VABitPlaneBufferType                = 2,
457     VASliceGroupMapBufferType           = 3,
458     VASliceParameterBufferType          = 4,
459     VASliceDataBufferType               = 5,
460     VAMacroblockParameterBufferType     = 6,
461     VAResidualDataBufferType            = 7,
462     VADeblockingParameterBufferType     = 8,
463     VAImageBufferType                   = 9,
464     VAProtectedSliceDataBufferType      = 10,
465 /* Following are encode buffer types */
466     VAEncCodedBufferType                = 21,
467     VAEncSequenceParameterBufferType    = 22,
468     VAEncPictureParameterBufferType     = 23,
469     VAEncSliceParameterBufferType       = 24,
470     VAEncH264VUIBufferType              = 25,
471     VAEncH264SEIBufferType              = 26,
472 } VABufferType;
473
474
475 /* 
476  * There will be cases where the bitstream buffer will not have enough room to hold
477  * the data for the entire slice, and the following flags will be used in the slice
478  * parameter to signal to the server for the possible cases.
479  * If a slice parameter buffer and slice data buffer pair is sent to the server with 
480  * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below), 
481  * then a slice parameter and data buffer needs to be sent again to complete this slice. 
482  */
483 #define VA_SLICE_DATA_FLAG_ALL          0x00    /* whole slice is in the buffer */
484 #define VA_SLICE_DATA_FLAG_BEGIN        0x01    /* The beginning of the slice is in the buffer but the end if not */
485 #define VA_SLICE_DATA_FLAG_MIDDLE       0x02    /* Neither beginning nor end of the slice is in the buffer */
486 #define VA_SLICE_DATA_FLAG_END          0x04    /* end of the slice is in the buffer */
487
488 /* Codec-independent Slice Parameter Buffer base */
489 typedef struct _VASliceParameterBufferBase
490 {
491     unsigned int slice_data_size;       /* number of bytes in the slice data buffer for this slice */
492     unsigned int slice_data_offset;     /* the offset to the first byte of slice data */
493     unsigned int slice_data_flag;       /* see VA_SLICE_DATA_FLAG_XXX definitions */
494 } VASliceParameterBufferBase;
495
496 /****************************
497  * MPEG-2 data structures
498  ****************************/
499  
500 /* MPEG-2 Picture Parameter Buffer */
501 /* 
502  * For each frame or field, and before any slice data, a single
503  * picture parameter buffer must be send.
504  */
505 typedef struct _VAPictureParameterBufferMPEG2
506 {
507     unsigned short horizontal_size;
508     unsigned short vertical_size;
509     VASurfaceID forward_reference_picture;
510     VASurfaceID backward_reference_picture;
511     /* meanings of the following fields are the same as in the standard */
512     int picture_coding_type;
513     int f_code; /* pack all four fcode into this */
514     union {
515         struct {
516             unsigned int intra_dc_precision             : 2; 
517             unsigned int picture_structure              : 2; 
518             unsigned int top_field_first                : 1; 
519             unsigned int frame_pred_frame_dct           : 1; 
520             unsigned int concealment_motion_vectors     : 1;
521             unsigned int q_scale_type                   : 1;
522             unsigned int intra_vlc_format               : 1;
523             unsigned int alternate_scan                 : 1;
524             unsigned int repeat_first_field             : 1;
525             unsigned int progressive_frame              : 1;
526             unsigned int is_first_field                 : 1; /* indicate whether the current field
527                                                               * is the first field for field picture
528                                                               */
529         } bits;
530         unsigned int value;
531     } picture_coding_extension;
532 } VAPictureParameterBufferMPEG2;
533
534 /* MPEG-2 Inverse Quantization Matrix Buffer */
535 typedef struct _VAIQMatrixBufferMPEG2
536 {
537     int load_intra_quantiser_matrix;
538     int load_non_intra_quantiser_matrix;
539     int load_chroma_intra_quantiser_matrix;
540     int load_chroma_non_intra_quantiser_matrix;
541     unsigned char intra_quantiser_matrix[64];
542     unsigned char non_intra_quantiser_matrix[64];
543     unsigned char chroma_intra_quantiser_matrix[64];
544     unsigned char chroma_non_intra_quantiser_matrix[64];
545 } VAIQMatrixBufferMPEG2;
546
547 /* MPEG-2 Slice Parameter Buffer */
548 typedef struct _VASliceParameterBufferMPEG2
549 {
550     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
551     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
552     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
553     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
554     unsigned int slice_vertical_position;
555     int quantiser_scale_code;
556     int intra_slice_flag;
557 } VASliceParameterBufferMPEG2;
558
559 /* MPEG-2 Macroblock Parameter Buffer */
560 typedef struct _VAMacroblockParameterBufferMPEG2
561 {
562     unsigned short macroblock_address;
563     /* 
564      * macroblock_address (in raster scan order)
565      * top-left: 0
566      * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
567      */
568     unsigned char macroblock_type;  /* see definition below */
569     union {
570         struct {
571             unsigned int frame_motion_type              : 2; 
572             unsigned int field_motion_type              : 2; 
573             unsigned int dct_type                       : 1; 
574         } bits;
575         unsigned char value;
576     } macroblock_modes;
577     unsigned char motion_vertical_field_select; 
578     /* 
579      * motion_vertical_field_select:
580      * see section 6.3.17.2 in the spec
581      * only the lower 4 bits are used
582      * bit 0: first vector forward
583      * bit 1: first vector backward
584      * bit 2: second vector forward
585      * bit 3: second vector backward
586      */
587     short PMV[2][2][2]; /* see Table 7-7 in the spec */
588     unsigned short coded_block_pattern;
589     /* 
590      * The bitplanes for coded_block_pattern are described 
591      * in Figure 6.10-12 in the spec
592      */
593      
594     /* Number of skipped macroblocks after this macroblock */
595     unsigned short num_skipped_macroblocks;
596 } VAMacroblockParameterBufferMPEG2;
597
598 /* 
599  * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
600  */
601 #define VA_MB_TYPE_MOTION_FORWARD       0x02
602 #define VA_MB_TYPE_MOTION_BACKWARD      0x04
603 #define VA_MB_TYPE_MOTION_PATTERN       0x08
604 #define VA_MB_TYPE_MOTION_INTRA         0x10
605
606 /* 
607  * MPEG-2 Residual Data Buffer 
608  * For each macroblock, there wil be 64 shorts (16-bit) in the 
609  * residual data buffer
610  */
611
612 /****************************
613  * MPEG-4 Part 2 data structures
614  ****************************/
615  
616 /* MPEG-4 Picture Parameter Buffer */
617 /* 
618  * For each frame or field, and before any slice data, a single
619  * picture parameter buffer must be send.
620  */
621 typedef struct _VAPictureParameterBufferMPEG4
622 {
623     unsigned short vop_width;
624     unsigned short vop_height;
625     VASurfaceID forward_reference_picture;
626     VASurfaceID backward_reference_picture;
627     union {
628         struct {
629             unsigned char short_video_header            : 1; 
630             unsigned char chroma_format                 : 2; 
631             unsigned char interlaced                    : 1; 
632             unsigned char obmc_disable                  : 1; 
633             unsigned char sprite_enable                 : 2; 
634             unsigned char sprite_warping_accuracy       : 2; 
635             unsigned char quant_type                    : 1; 
636             unsigned char quarter_sample                        : 1; 
637             unsigned char data_partitioned              : 1; 
638             unsigned char reversible_vlc                        : 1; 
639         } bits;
640         unsigned short value;
641     } vol_fields;
642     unsigned char no_of_sprite_warping_points;
643     short sprite_trajectory_du[3];
644     short sprite_trajectory_dv[3];
645     unsigned char quant_precision;
646     union {
647         struct {
648             unsigned char vop_coding_type               : 2; 
649             unsigned char backward_reference_vop_coding_type    : 2; 
650             unsigned char vop_rounding_type             : 1; 
651             unsigned char intra_dc_vlc_thr              : 3; 
652             unsigned char top_field_first               : 1; 
653             unsigned char alternate_vertical_scan_flag  : 1; 
654         } bits;
655         unsigned short value;
656     } vop_fields;
657     unsigned char vop_fcode_forward;
658     unsigned char vop_fcode_backward;
659     /* short header related */
660     unsigned char num_gobs_in_vop;
661     unsigned char num_macroblocks_in_gob;
662     /* for direct mode prediction */
663     short TRB;
664     short TRD;
665 } VAPictureParameterBufferMPEG4;
666
667 /* MPEG-4 Inverse Quantization Matrix Buffer */
668 typedef struct _VAIQMatrixBufferMPEG4
669 {
670     int load_intra_quant_mat;
671     int load_non_intra_quant_mat;
672     unsigned char intra_quant_mat[64];
673     unsigned char non_intra_quant_mat[64];
674 } VAIQMatrixBufferMPEG4;
675
676 /* MPEG-4 Slice Parameter Buffer */
677 typedef struct _VASliceParameterBufferMPEG4
678 {
679     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
680     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
681     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
682     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
683     unsigned int macroblock_number;
684     int quant_scale;
685 } VASliceParameterBufferMPEG4;
686
687 /*
688  VC-1 data structures
689 */
690
691 typedef enum   /* see 7.1.1.32 */
692 {
693     VAMvMode1Mv                        = 0,
694     VAMvMode1MvHalfPel                 = 1,
695     VAMvMode1MvHalfPelBilinear         = 2,
696     VAMvModeMixedMv                    = 3,
697     VAMvModeIntensityCompensation      = 4 
698 } VAMvModeVC1;
699
700 /* VC-1 Picture Parameter Buffer */
701 /* 
702  * For each picture, and before any slice data, a picture parameter
703  * buffer must be send. Multiple picture parameter buffers may be
704  * sent for a single picture. In that case picture parameters will
705  * apply to all slice data that follow it until a new picture
706  * parameter buffer is sent.
707  *
708  * Notes:
709  *   pic_quantizer_type should be set to the applicable quantizer
710  *   type as defined by QUANTIZER (J.1.19) and either
711  *   PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
712  */
713 typedef struct _VAPictureParameterBufferVC1
714 {
715     VASurfaceID forward_reference_picture;
716     VASurfaceID backward_reference_picture;
717     /* if out-of-loop post-processing is done on the render
718        target, then we need to keep the in-loop decoded 
719        picture as a reference picture */
720     VASurfaceID inloop_decoded_picture;
721
722     /* sequence layer for AP or meta data for SP and MP */
723     union {
724         struct {
725             unsigned int pulldown       : 1; /* SEQUENCE_LAYER::PULLDOWN */
726             unsigned int interlace      : 1; /* SEQUENCE_LAYER::INTERLACE */
727             unsigned int tfcntrflag     : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
728             unsigned int finterpflag    : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
729             unsigned int psf            : 1; /* SEQUENCE_LAYER::PSF */
730             unsigned int multires       : 1; /* METADATA::MULTIRES */
731             unsigned int overlap        : 1; /* METADATA::OVERLAP */
732             unsigned int syncmarker     : 1; /* METADATA::SYNCMARKER */
733             unsigned int rangered       : 1; /* METADATA::RANGERED */
734             unsigned int max_b_frames   : 3; /* METADATA::MAXBFRAMES */
735         } bits;
736         unsigned int value;
737     } sequence_fields;
738
739     unsigned short coded_width;         /* ENTRY_POINT_LAYER::CODED_WIDTH */
740     unsigned short coded_height;        /* ENTRY_POINT_LAYER::CODED_HEIGHT */
741     union {
742         struct {
743             unsigned int broken_link    : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
744             unsigned int closed_entry   : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
745             unsigned int panscan_flag   : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
746             unsigned int loopfilter     : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
747         } bits;
748         unsigned int value;
749     } entrypoint_fields;
750     
751     unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
752     unsigned char fast_uvmc_flag;       /* ENTRY_POINT_LAYER::FASTUVMC */
753     union {
754         struct {
755             unsigned char luma_flag     : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
756             unsigned char luma          : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
757             unsigned char chroma_flag   : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
758             unsigned char chroma                : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
759         } bits;
760         unsigned char value;
761     } range_mapping_fields;
762
763     unsigned char b_picture_fraction;   /* PICTURE_LAYER::BFRACTION */
764     unsigned char cbp_table;            /* PICTURE_LAYER::CBPTAB/ICBPTAB */
765     unsigned char mb_mode_table;        /* PICTURE_LAYER::MBMODETAB */
766     unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
767     unsigned char rounding_control;     /* PICTURE_LAYER::RNDCTRL */
768     unsigned char post_processing;      /* PICTURE_LAYER::POSTPROC */
769     unsigned char picture_resolution_index;     /* PICTURE_LAYER::RESPIC */
770     unsigned char luma_scale;           /* PICTURE_LAYER::LUMSCALE */
771     unsigned char luma_shift;           /* PICTURE_LAYER::LUMSHIFT */
772     union {
773         struct {
774             unsigned char picture_type          : 3; /* PICTURE_LAYER::PTYPE */
775             unsigned char frame_coding_mode     : 3; /* PICTURE_LAYER::FCM */
776             unsigned char top_field_first       : 1; /* PICTURE_LAYER::TFF */
777             unsigned char is_first_field                : 1; /* set to 1 if it is the first field */
778             unsigned char intensity_compensation        : 1; /* PICTURE_LAYER::INTCOMP */
779         } bits;
780         unsigned char value;
781     } picture_fields;
782     union {
783         struct {
784             unsigned char mv_type_mb    : 1;    /* PICTURE::MVTYPEMB */
785             unsigned char direct_mb     : 1;    /* PICTURE::DIRECTMB */
786             unsigned char skip_mb       : 1;    /* PICTURE::SKIPMB */
787             unsigned char field_tx      : 1;    /* PICTURE::FIELDTX */
788             unsigned char forward_mb    : 1;    /* PICTURE::FORWARDMB */
789             unsigned char ac_pred       : 1;    /* PICTURE::ACPRED */
790             unsigned char overflags     : 1;    /* PICTURE::OVERFLAGS */
791         } flags;
792         unsigned char value;
793     } raw_coding;
794     union {
795         struct {
796             unsigned char bp_mv_type_mb   : 1;    /* PICTURE::MVTYPEMB */
797             unsigned char bp_direct_mb    : 1;    /* PICTURE::DIRECTMB */
798             unsigned char bp_skip_mb      : 1;    /* PICTURE::SKIPMB */  
799             unsigned char bp_field_tx     : 1;    /* PICTURE::FIELDTX */ 
800             unsigned char bp_forward_mb   : 1;    /* PICTURE::FORWARDMB */
801             unsigned char bp_ac_pred      : 1;    /* PICTURE::ACPRED */   
802             unsigned char bp_overflags    : 1;    /* PICTURE::OVERFLAGS */
803         } flags;
804         unsigned char value;
805     } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
806     union {
807         struct {
808             unsigned char reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
809             unsigned char reference_distance    : 5;/* PICTURE_LAYER::REFDIST */
810             unsigned char num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
811             unsigned char reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
812         } bits;
813         unsigned short value;
814     } reference_fields;
815     union {
816         struct {
817             unsigned char mv_mode               : 3; /* PICTURE_LAYER::MVMODE */
818             unsigned char mv_mode2              : 3; /* PICTURE_LAYER::MVMODE2 */
819             unsigned char mv_table              : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
820             unsigned char two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
821             unsigned char four_mv_switch                : 1; /* PICTURE_LAYER::4MVSWITCH */
822             unsigned char four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
823             unsigned char extended_mv_flag      : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
824             unsigned char extended_mv_range     : 2; /* PICTURE_LAYER::MVRANGE */
825             unsigned char extended_dmv_flag     : 1; /* ENTRY_POCHAR_LAYER::EXTENDED_DMV */
826             unsigned char extended_dmv_range    : 2; /* PICTURE_LAYER::DMVRANGE */
827         } bits;
828         unsigned int value;
829     } mv_fields;
830     union {
831         struct {
832             unsigned char dquant        : 2;    /* ENTRY_POINT_LAYER::DQUANT */
833             unsigned char quantizer     : 2;    /* ENTRY_POINT_LAYER::QUANTIZER */
834             unsigned char half_qp       : 1;    /* PICTURE_LAYER::HALFQP */
835             unsigned char pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
836             unsigned char pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
837             unsigned char dq_frame      : 1;    /* VOPDQUANT::DQUANTFRM */
838             unsigned char dq_profile    : 2;    /* VOPDQUANT::DQPROFILE */
839             unsigned char dq_sb_edge    : 2;    /* VOPDQUANT::DQSBEDGE */
840             unsigned char dq_db_edge    : 2;    /* VOPDQUANT::DQDBEDGE */
841             unsigned char dq_binary_level : 1;  /* VOPDQUANT::DQBILEVEL */
842             unsigned char alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
843         } bits;
844         unsigned long value;
845     } pic_quantizer_fields;
846     union {
847         struct {
848             unsigned char variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
849             unsigned char mb_level_transform_type_flag  : 1;/* PICTURE_LAYER::TTMBF */
850             unsigned char frame_level_transform_type    : 2;/* PICTURE_LAYER::TTFRM */
851             unsigned char transform_ac_codingset_idx1   : 2;/* PICTURE_LAYER::TRANSACFRM */
852             unsigned char transform_ac_codingset_idx2   : 2;/* PICTURE_LAYER::TRANSACFRM2 */
853             unsigned char intra_transform_dc_table      : 1;/* PICTURE_LAYER::TRANSDCTAB */
854         } bits;
855         unsigned short value;
856     } transform_fields;
857 } VAPictureParameterBufferVC1;
858
859 /* VC-1 Bitplane Buffer 
860 There will be at most three bitplanes coded in any picture header. To send 
861 the bitplane data more efficiently, each byte is divided in two nibbles, with
862 each nibble carrying three bitplanes for one macroblock.  The following table
863 shows the bitplane data arrangement within each nibble based on the picture
864 type.
865
866 Picture Type    Bit3            Bit2            Bit1            Bit0
867 I or BI                         OVERFLAGS       ACPRED          FIELDTX
868 P                               MYTYPEMB        SKIPMB          DIRECTMB
869 B                               FORWARDMB       SKIPMB          DIRECTMB
870
871 Within each byte, the lower nibble is for the first MB and the upper nibble is 
872 for the second MB.  E.g. the lower nibble of the first byte in the bitplane
873 buffer is for Macroblock #1 and the upper nibble of the first byte is for 
874 Macroblock #2 in the first row.
875 */
876
877 /* VC-1 Slice Parameter Buffer */
878 typedef struct _VASliceParameterBufferVC1
879 {
880     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
881     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
882     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
883     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
884     unsigned int slice_vertical_position;
885 } VASliceParameterBufferVC1;
886
887 /* VC-1 Slice Data Buffer */
888 /* 
889 This is simplely a buffer containing raw bit-stream bytes 
890 */
891
892 /****************************
893  * H.264/AVC data structures
894  ****************************/
895
896 typedef struct _VAPictureH264
897 {
898     VASurfaceID picture_id;
899     unsigned int frame_idx;
900     unsigned int flags;
901     unsigned int TopFieldOrderCnt;
902     unsigned int BottomFieldOrderCnt;
903 } VAPictureH264;
904 /* flags in VAPictureH264 could be OR of the following */
905 #define VA_PICTURE_H264_INVALID                 0x00000001
906 #define VA_PICTURE_H264_TOP_FIELD               0x00000002
907 #define VA_PICTURE_H264_BOTTOM_FIELD            0x00000004
908 #define VA_PICTURE_H264_SHORT_TERM_REFERENCE    0x00000008
909 #define VA_PICTURE_H264_LONG_TERM_REFERENCE     0x00000010
910
911 /* H.264 Picture Parameter Buffer */
912 /* 
913  * For each picture, and before any slice data, a single
914  * picture parameter buffer must be send.
915  */
916 typedef struct _VAPictureParameterBufferH264
917 {
918     VAPictureH264 CurrPic;
919     VAPictureH264 ReferenceFrames[16];  /* in DPB */
920     unsigned short picture_width_in_mbs_minus1;
921     unsigned short picture_height_in_mbs_minus1;
922     unsigned char bit_depth_luma_minus8;
923     unsigned char bit_depth_chroma_minus8;
924     unsigned char num_ref_frames;
925     union {
926         struct {
927             unsigned char chroma_format_idc                     : 2; 
928             unsigned char residual_colour_transform_flag        : 1;
929             unsigned int gaps_in_frame_num_value_allowed_flag   : 1; 
930             unsigned char frame_mbs_only_flag                   : 1; 
931             unsigned char mb_adaptive_frame_field_flag          : 1; 
932             unsigned char direct_8x8_inference_flag             : 1; 
933             unsigned char MinLumaBiPredSize8x8                  : 1; /* see A.3.3.2 */
934             unsigned int log2_max_frame_num_minus4              : 4;
935             unsigned int pic_order_cnt_type                     : 2;
936             unsigned int log2_max_pic_order_cnt_lsb_minus4      : 4;
937             unsigned int delta_pic_order_always_zero_flag       : 1;
938         } bits;
939         unsigned char value;
940     } seq_fields;
941     unsigned char num_slice_groups_minus1;
942     unsigned char slice_group_map_type;
943     unsigned short slice_group_change_rate_minus1;
944     signed char pic_init_qp_minus26;
945     signed char pic_init_qs_minus26;
946     signed char chroma_qp_index_offset;
947     signed char second_chroma_qp_index_offset;
948     union {
949         struct {
950             unsigned char entropy_coding_mode_flag      : 1;
951             unsigned char weighted_pred_flag            : 1;
952             unsigned char weighted_bipred_idc           : 2;
953             unsigned char transform_8x8_mode_flag       : 1;
954             unsigned char field_pic_flag                        : 1;
955             unsigned char constrained_intra_pred_flag   : 1;
956             unsigned int pic_order_present_flag                 : 1;
957             unsigned int deblocking_filter_control_present_flag : 1;
958             unsigned int redundant_pic_cnt_present_flag         : 1;
959             unsigned int reference_pic_flag                     : 1; /* nal_ref_idc != 0 */
960         } bits;
961         unsigned char value;
962     } pic_fields;
963     unsigned short frame_num;
964 } VAPictureParameterBufferH264;
965
966 /* H.264 Inverse Quantization Matrix Buffer */
967 typedef struct _VAIQMatrixBufferH264
968 {
969     unsigned char ScalingList4x4[6][16];
970     unsigned char ScalingList8x8[2][64];
971 } VAIQMatrixBufferH264;
972
973 /* 
974  * H.264 Slice Group Map Buffer 
975  * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
976  * A slice group map buffer should be sent for each picture if required. The buffer
977  * is sent only when there is a change in the mapping values.
978  * The slice group map buffer map "map units" to slice groups as specified in 
979  * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock 
980  * in raster scan order
981  */ 
982
983 /* H.264 Slice Parameter Buffer */
984 typedef struct _VASliceParameterBufferH264
985 {
986     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
987     unsigned int slice_data_offset;/* the offset to the NAL start code for this slice */
988     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
989     unsigned short slice_data_bit_offset; /* bit offset from NAL start code to the beginning of slice data */
990     unsigned short first_mb_in_slice;
991     unsigned char slice_type;
992     unsigned char direct_spatial_mv_pred_flag;
993     unsigned char num_ref_idx_l0_active_minus1;
994     unsigned char num_ref_idx_l1_active_minus1;
995     unsigned char cabac_init_idc;
996     char slice_qp_delta;
997     unsigned char disable_deblocking_filter_idc;
998     char slice_alpha_c0_offset_div2;
999     char slice_beta_offset_div2;
1000     VAPictureH264 RefPicList0[32];      /* See 8.2.4.2 */
1001     VAPictureH264 RefPicList1[32];      /* See 8.2.4.2 */
1002     unsigned char luma_log2_weight_denom;
1003     unsigned char chroma_log2_weight_denom;
1004     unsigned char luma_weight_l0_flag;
1005     short luma_weight_l0[32];
1006     short luma_offset_l0[32];
1007     unsigned char chroma_weight_l0_flag;
1008     short chroma_weight_l0[32][2];
1009     short chroma_offset_l0[32][2];
1010     unsigned char luma_weight_l1_flag;
1011     short luma_weight_l1[32];
1012     short luma_offset_l1[32];
1013     unsigned char chroma_weight_l1_flag;
1014     short chroma_weight_l1[32][2];
1015     short chroma_offset_l1[32][2];
1016 } VASliceParameterBufferH264;
1017
1018 /****************************
1019  * Common encode data structures 
1020  ****************************/
1021 typedef enum
1022 {
1023     VAEncPictureTypeIntra               = 0,
1024     VAEncPictureTypePredictive          = 1,
1025     VAEncPictureTypeBidirectional       = 2,
1026 } VAEncPictureType;
1027
1028 /* Encode Slice Parameter Buffer */
1029 typedef struct _VAEncSliceParameterBuffer
1030 {
1031     unsigned int start_row_number;      /* starting MB row number for this slice */
1032     unsigned int slice_height;  /* slice height measured in MB */
1033     union {
1034         struct {
1035             unsigned char is_intra      : 1;
1036             unsigned char disable_deblocking_filter_idc : 2;
1037         } bits;
1038         unsigned char value;
1039     } slice_flags;
1040 } VAEncSliceParameterBuffer;
1041
1042 /****************************
1043  * H.264 specific encode data structures
1044  ****************************/
1045
1046 typedef struct _VAEncSequenceParameterBufferH264
1047 {
1048     unsigned char seq_parameter_set_id;
1049     unsigned char level_idc;
1050     unsigned int intra_period;
1051     unsigned int picture_width_in_mbs;
1052     unsigned int picture_height_in_mbs;
1053     unsigned int bits_per_second;
1054     unsigned int frame_rate;
1055     unsigned int initial_qp;
1056     unsigned int min_qp;
1057     unsigned int basic_unit_size;
1058     unsigned char vui_flag;
1059 } VAEncSequenceParameterBufferH264;
1060
1061 typedef struct _VAEncPictureParameterBufferH264
1062 {
1063     VASurfaceID reference_picture;
1064     VASurfaceID reconstructed_picture;
1065     VABufferID coded_buf;
1066     unsigned short picture_width;
1067     unsigned short picture_height;
1068     unsigned char last_picture; /* if set to 1 it indicates the last picture in the sequence */
1069 } VAEncPictureParameterBufferH264;
1070
1071 /****************************
1072  * H.263 specific encode data structures
1073  ****************************/
1074
1075 typedef struct _VAEncSequenceParameterBufferH263
1076 {
1077     unsigned int intra_period;
1078     unsigned int bits_per_second;
1079     unsigned int frame_rate;
1080     unsigned int initial_qp;
1081     unsigned int min_qp;
1082 } VAEncSequenceParameterBufferH263;
1083
1084 typedef struct _VAEncPictureParameterBufferH263
1085 {
1086     VASurfaceID reference_picture;
1087     VASurfaceID reconstructed_picture;
1088     VABufferID coded_buf;
1089     unsigned short picture_width;
1090     unsigned short picture_height;
1091     VAEncPictureType picture_type;
1092 } VAEncPictureParameterBufferH263;
1093
1094 /****************************
1095  * MPEG-4 specific encode data structures
1096  ****************************/
1097
1098 typedef struct _VAEncSequenceParameterBufferMPEG4
1099 {
1100     unsigned char profile_and_level_indication;
1101     unsigned int intra_period;
1102     unsigned int video_object_layer_width;
1103     unsigned int video_object_layer_height;
1104     unsigned int vop_time_increment_resolution;
1105     unsigned int fixed_vop_rate;
1106     unsigned int fixed_vop_time_increment;
1107     unsigned int bits_per_second;
1108     unsigned int frame_rate;
1109     unsigned int initial_qp;
1110     unsigned int min_qp;
1111 } VAEncSequenceParameterBufferMPEG4;
1112
1113 typedef struct _VAEncPictureParameterBufferMPEG4
1114 {
1115     VASurfaceID reference_picture;
1116     VASurfaceID reconstructed_picture;
1117     VABufferID coded_buf;
1118     unsigned short picture_width;
1119     unsigned short picture_height;
1120     unsigned int modulo_time_base; /* number of 1s */
1121     unsigned int vop_time_increment;
1122     VAEncPictureType picture_type;
1123 } VAEncPictureParameterBufferMPEG4;
1124
1125
1126
1127 /* Buffer functions */
1128
1129 /*
1130  * Creates a buffer for "num_elements" elements of "size" bytes and 
1131  * initalize with "data".
1132  * if "data" is null, then the contents of the buffer data store
1133  * are undefined.
1134  * Basically there are two ways to get buffer data to the server side. One is 
1135  * to call vaCreateBuffer() with a non-null "data", which results the data being
1136  * copied to the data store on the server side.  A different method that 
1137  * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
1138  * and then use vaMapBuffer() to map the data store from the server side to the
1139  * client address space for access.
1140  *  Note: image buffers are created by the library, not the client. Please see 
1141  *        vaCreateImage on how image buffers are managed.
1142  */
1143 VAStatus vaCreateBuffer (
1144     VADisplay dpy,
1145     VAContextID context,
1146     VABufferType type,  /* in */
1147     unsigned int size,  /* in */
1148     unsigned int num_elements, /* in */
1149     void *data,         /* in */
1150     VABufferID *buf_id  /* out */
1151 );
1152
1153 /*
1154  * Convey to the server how many valid elements are in the buffer. 
1155  * e.g. if multiple slice parameters are being held in a single buffer,
1156  * this will communicate to the server the number of slice parameters
1157  * that are valid in the buffer.
1158  */
1159 VAStatus vaBufferSetNumElements (
1160     VADisplay dpy,
1161     VABufferID buf_id,  /* in */
1162     unsigned int num_elements /* in */
1163 );
1164
1165 /*
1166  * Map data store of the buffer into the client's address space
1167  * vaCreateBuffer() needs to be called with "data" set to NULL before
1168  * calling vaMapBuffer()
1169  */
1170 VAStatus vaMapBuffer (
1171     VADisplay dpy,
1172     VABufferID buf_id,  /* in */
1173     void **pbuf         /* out */
1174 );
1175
1176 /*
1177  * After client making changes to a mapped data store, it needs to
1178  * "Unmap" it to let the server know that the data is ready to be
1179  * consumed by the server
1180  */
1181 VAStatus vaUnmapBuffer (
1182     VADisplay dpy,
1183     VABufferID buf_id   /* in */
1184 );
1185
1186 /*
1187  * After this call, the buffer is deleted and this buffer_id is no longer valid
1188  * Only call this if the buffer is not going to be passed to vaRenderBuffer
1189  */
1190 VAStatus vaDestroyBuffer (
1191     VADisplay dpy,
1192     VABufferID buffer_id
1193 );
1194
1195 /*
1196 Render (Decode) Pictures
1197
1198 A picture represents either a frame or a field.
1199
1200 The Begin/Render/End sequence sends the decode buffers to the server
1201 */
1202
1203 /*
1204  * Get ready to decode a picture to a target surface
1205  */
1206 VAStatus vaBeginPicture (
1207     VADisplay dpy,
1208     VAContextID context,
1209     VASurfaceID render_target
1210 );
1211
1212 /* 
1213  * Send decode buffers to the server.
1214  * Buffers are automatically destroyed afterwards
1215  */
1216 VAStatus vaRenderPicture (
1217     VADisplay dpy,
1218     VAContextID context,
1219     VABufferID *buffers,
1220     int num_buffers
1221 );
1222
1223 /* 
1224  * Make the end of rendering for a picture. 
1225  * The server should start processing all pending operations for this 
1226  * surface. This call is non-blocking. The client can start another 
1227  * Begin/Render/End sequence on a different render target.
1228  */
1229 VAStatus vaEndPicture (
1230     VADisplay dpy,
1231     VAContextID context
1232 );
1233
1234 /*
1235
1236 Synchronization 
1237
1238 */
1239
1240 /* 
1241  * This function blocks until all pending operations on the render target
1242  * have been completed.  Upon return it is safe to use the render target for a 
1243  * different picture. 
1244  */
1245 VAStatus vaSyncSurface (
1246     VADisplay dpy,
1247     VAContextID context,
1248     VASurfaceID render_target
1249 );
1250
1251 typedef enum
1252 {
1253     VASurfaceRendering  = 0, /* Rendering in progress */ 
1254     VASurfaceDisplaying = 1, /* Displaying in progress (not safe to render into it) */ 
1255                              /* this status is useful if surface is used as the source */
1256                              /* of an overlay */
1257     VASurfaceReady      = 2, /* not being rendered or displayed */
1258     VASurfaceSkipped    = 4  /* Indicate a skipped frame during encode */
1259 } VASurfaceStatus;
1260
1261 /*
1262  * Find out any pending ops on the render target 
1263  */
1264 VAStatus vaQuerySurfaceStatus (
1265     VADisplay dpy,
1266     VASurfaceID render_target,
1267     VASurfaceStatus *status     /* out */
1268 );
1269
1270 /*
1271  * Images and Subpictures
1272  * VAImage is used to either get the surface data to client memory, or 
1273  * to copy image data in client memory to a surface. 
1274  * Both images, subpictures and surfaces follow the same 2D coordinate system where origin 
1275  * is at the upper left corner with positive X to the right and positive Y down
1276  */
1277 #define VA_FOURCC(ch0, ch1, ch2, ch3) \
1278     ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
1279     ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
1280
1281 /* a few common FourCCs */
1282 #define VA_FOURCC_NV12          0x3231564E
1283 #define VA_FOURCC_AI44          0x34344149
1284 #define VA_FOURCC_RGBA          0x41424752
1285 #define VA_FOURCC_UYVY          0x59565955
1286 #define VA_FOURCC_YUY2          0x32595559
1287 #define VA_FOURCC_AYUV          0x56555941
1288 #define VA_FOURCC_NV11          0x3131564e
1289 #define VA_FOURCC_YV12          0x32315659
1290 #define VA_FOURCC_P208          0x38303250
1291 #define VA_FOURCC_IYUV          0x56555949
1292
1293 /* byte order */
1294 #define VA_LSB_FIRST            1
1295 #define VA_MSB_FIRST            2
1296
1297 typedef struct _VAImageFormat
1298 {
1299     unsigned int        fourcc;
1300     unsigned int        byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
1301     unsigned int        bits_per_pixel;
1302     /* for RGB formats */
1303     unsigned int        depth; /* significant bits per pixel */
1304     unsigned int        red_mask;
1305     unsigned int        green_mask;
1306     unsigned int        blue_mask;
1307     unsigned int        alpha_mask;
1308 } VAImageFormat;
1309
1310 typedef VAGenericID VAImageID;
1311
1312 typedef struct _VAImage
1313 {
1314     VAImageID           image_id; /* uniquely identify this image */
1315     VAImageFormat       format;
1316     VABufferID          buf;    /* image data buffer */
1317     /*
1318      * Image data will be stored in a buffer of type VAImageBufferType to facilitate
1319      * data store on the server side for optimal performance. The buffer will be 
1320      * created by the CreateImage function, and proper storage allocated based on the image
1321      * size and format. This buffer is managed by the library implementation, and 
1322      * accessed by the client through the buffer Map/Unmap functions.
1323      */
1324     unsigned short      width; 
1325     unsigned short      height;
1326     unsigned int        data_size;
1327     unsigned int        num_planes;     /* can not be greater than 3 */
1328     /* 
1329      * An array indicating the scanline pitch in bytes for each plane.
1330      * Each plane may have a different pitch. Maximum 3 planes for planar formats
1331      */
1332     unsigned int        pitches[3];
1333     /* 
1334      * An array indicating the byte offset from the beginning of the image data 
1335      * to the start of each plane.
1336      */
1337     unsigned int        offsets[3];
1338
1339     /* The following fields are only needed for paletted formats */
1340     int num_palette_entries;   /* set to zero for non-palette images */
1341     /* 
1342      * Each component is one byte and entry_bytes indicates the number of components in 
1343      * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images   
1344      */
1345     int entry_bytes; 
1346     /*
1347      * An array of ascii characters describing the order of the components within the bytes.
1348      * Only entry_bytes characters of the string are used.
1349      */
1350     char component_order[4];
1351 } VAImage;
1352
1353 /* Get maximum number of image formats supported by the implementation */
1354 int vaMaxNumImageFormats (
1355     VADisplay dpy
1356 );
1357
1358 /* 
1359  * Query supported image formats 
1360  * The caller must provide a "format_list" array that can hold at
1361  * least vaMaxNumImageFormats() entries. The actual number of formats
1362  * returned in "format_list" is returned in "num_formats".
1363  */
1364 VAStatus vaQueryImageFormats (
1365     VADisplay dpy,
1366     VAImageFormat *format_list, /* out */
1367     int *num_formats            /* out */
1368 );
1369
1370 /* 
1371  * Create a VAImage structure
1372  * The width and height fields returned in the VAImage structure may get 
1373  * enlarged for some YUV formats. Upon return from this function, 
1374  * image->buf has been created and proper storage allocated by the library. 
1375  * The client can access the image through the Map/Unmap calls.
1376  */
1377 VAStatus vaCreateImage (
1378     VADisplay dpy,
1379     VAImageFormat *format,
1380     int width,
1381     int height,
1382     VAImage *image      /* out */
1383 );
1384
1385 /*
1386  * Should call DestroyImage before destroying the surface it is bound to
1387  */
1388 VAStatus vaDestroyImage (
1389     VADisplay dpy,
1390     VAImageID image
1391 );
1392
1393 VAStatus vaSetImagePalette (
1394     VADisplay dpy,
1395     VAImageID image,
1396     /* 
1397      * pointer to an array holding the palette data.  The size of the array is 
1398      * num_palette_entries * entry_bytes in size.  The order of the components 
1399      * in the palette is described by the component_order in VAImage struct    
1400      */
1401     unsigned char *palette 
1402 );
1403
1404 /*
1405  * Retrive surface data into a VAImage
1406  * Image must be in a format supported by the implementation
1407  */
1408 VAStatus vaGetImage (
1409     VADisplay dpy,
1410     VASurfaceID surface,
1411     int x,      /* coordinates of the upper left source pixel */
1412     int y,
1413     unsigned int width, /* width and height of the region */
1414     unsigned int height,
1415     VAImageID image
1416 );
1417
1418 /*
1419  * Copy data from a VAImage to a surface
1420  * Image must be in a format supported by the implementation
1421  * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
1422  * shouldn't be rendered into when this is called
1423  * The source and destionation width and height are the same and
1424  * no scaling is performed with this operation.
1425  */
1426 VAStatus vaPutImage (
1427     VADisplay dpy,
1428     VASurfaceID surface,
1429     VAImageID image,
1430     int src_x,
1431     int src_y,
1432     unsigned int width,
1433     unsigned int height,
1434     int dest_x,
1435     int dest_y
1436 );
1437
1438 /*
1439  * Similar to vaPutImage but with additional destination width
1440  * and height arguments to enable scaling
1441  */
1442 VAStatus vaPutImage2 (
1443     VADisplay dpy,
1444     VASurfaceID surface,
1445     VAImageID image,
1446     int src_x,
1447     int src_y,
1448     unsigned int src_width,
1449     unsigned int src_height,
1450     int dest_x,
1451     int dest_y,
1452     unsigned int dest_width,
1453     unsigned int dest_height
1454 );
1455
1456 /*
1457  * Derive an VAImage from an existing surface.
1458  * This interface will derive a VAImage and corresponding image buffer from
1459  * an existing VA Surface. The image buffer can then be mapped/unmapped for
1460  * direct CPU access. This operation is only possible on implementations with
1461  * direct rendering capabilities and internal surface formats that can be
1462  * represented with a VAImage. When the operation is not possible this interface
1463  * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
1464  * to using vaCreateImage + vaPutImage to accomplish the same task in an
1465  * indirect manner.
1466  *
1467  * Implementations should only return success when the resulting image buffer
1468  * would be useable with vaMap/Unmap.
1469  *
1470  * When directly accessing a surface special care must be taken to insure
1471  * proper synchronization with the graphics hardware. Clients should call
1472  * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
1473  * rendering or currently being displayed by an overlay.
1474  *
1475  * Additionally nothing about the contents of a surface should be assumed
1476  * following a vaPutSurface. Implementations are free to modify the surface for
1477  * scaling or subpicture blending within a call to vaPutImage.
1478  *
1479  * Calls to vaPutImage or vaGetImage using the same surface from which the image
1480  * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
1481  * vaGetImage with other surfaces is supported.
1482  *
1483  * An image created with vaDeriveImage should be freed with vaDestroyImage. The
1484  * image and image buffer structures will be destroyed; however, the underlying
1485  * surface will remain unchanged until freed with vaDestroySurfaces.
1486  */
1487 VAStatus vaDeriveImage (
1488     VADisplay dpy,
1489     VASurfaceID surface,
1490     VAImage *image      /* out */
1491 );
1492
1493 /*
1494  * Subpictures 
1495  * Subpicture is a special type of image that can be blended 
1496  * with a surface during vaPutSurface(). Subpicture can be used to render
1497  * DVD sub-titles or closed captioning text etc.  
1498  */
1499
1500 typedef VAGenericID VASubpictureID;
1501
1502 /* Get maximum number of subpicture formats supported by the implementation */
1503 int vaMaxNumSubpictureFormats (
1504     VADisplay dpy
1505 );
1506
1507 /* flags for subpictures */
1508 #define VA_SUBPICTURE_CHROMA_KEYING     0x0001
1509 #define VA_SUBPICTURE_GLOBAL_ALPHA      0x0002
1510 /* 
1511  * Query supported subpicture formats 
1512  * The caller must provide a "format_list" array that can hold at
1513  * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag 
1514  * for each format to indicate additional capabilities for that format. The actual 
1515  * number of formats returned in "format_list" is returned in "num_formats".
1516  *  flags: returned value to indicate addtional capabilities
1517  *         VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
1518  *         VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha  
1519  */
1520 VAStatus vaQuerySubpictureFormats (
1521     VADisplay dpy,
1522     VAImageFormat *format_list, /* out */
1523     unsigned int *flags,        /* out */
1524     unsigned int *num_formats   /* out */
1525 );
1526
1527 /* 
1528  * Subpictures are created with an image associated. 
1529  */
1530 VAStatus vaCreateSubpicture (
1531     VADisplay dpy,
1532     VAImageID image,
1533     VASubpictureID *subpicture  /* out */
1534 );
1535
1536 /*
1537  * Destroy the subpicture before destroying the image it is assocated to
1538  */
1539 VAStatus vaDestroySubpicture (
1540     VADisplay dpy,
1541     VASubpictureID subpicture
1542 );
1543
1544 /* 
1545  * Bind an image to the subpicture. This image will now be associated with 
1546  * the subpicture instead of the one at creation.
1547  */
1548 VAStatus vaSetSubpictureImage (
1549     VADisplay dpy,
1550     VASubpictureID subpicture,
1551     VAImageID image
1552 );
1553
1554 /*
1555  * If chromakey is enabled, then the area where the source value falls within
1556  * the chromakey [min, max] range is transparent
1557  * The chromakey component format is the following:
1558  *  For RGB: [0:7] Red [8:15] Blue [16:23] Green   
1559  *  For YUV: [0:7] V [8:15] U [16:23] Y
1560  * The chromakey mask can be used to mask out certain components for chromakey
1561  * comparision
1562  */
1563 VAStatus vaSetSubpictureChromakey (
1564     VADisplay dpy,
1565     VASubpictureID subpicture,
1566     unsigned int chromakey_min,
1567     unsigned int chromakey_max,
1568     unsigned int chromakey_mask
1569 );
1570
1571 /*
1572  * Global alpha value is between 0 and 1. A value of 1 means fully opaque and 
1573  * a value of 0 means fully transparent. If per-pixel alpha is also specified then
1574  * the overall alpha is per-pixel alpha multiplied by the global alpha
1575  */
1576 VAStatus vaSetSubpictureGlobalAlpha (
1577     VADisplay dpy,
1578     VASubpictureID subpicture,
1579     float global_alpha 
1580 );
1581
1582 /*
1583  * vaAssociateSubpicture associates the subpicture with target_surfaces.
1584  * It defines the region mapping between the subpicture and the target  
1585  * surfaces through source and destination rectangles (with the same width and height).
1586  * Both will be displayed at the next call to vaPutSurface.  Additional
1587  * associations before the call to vaPutSurface simply overrides the association.
1588  */
1589 VAStatus vaAssociateSubpicture (
1590     VADisplay dpy,
1591     VASubpictureID subpicture,
1592     VASurfaceID *target_surfaces,
1593     int num_surfaces,
1594     short src_x, /* upper left offset in subpicture */
1595     short src_y,
1596     short dest_x, /* upper left offset in surface */
1597     short dest_y,
1598     unsigned short width,
1599     unsigned short height,
1600     /*
1601      * whether to enable chroma-keying or global-alpha
1602      * see VA_SUBPICTURE_XXX values
1603      */
1604     unsigned int flags
1605 );
1606
1607 /*
1608  * Similar to vaAssociateSubpicture but with additional destination width
1609  * and height to enable scaling
1610  */
1611 VAStatus vaAssociateSubpicture2 (
1612     VADisplay dpy,
1613     VASubpictureID subpicture,
1614     VASurfaceID *target_surfaces,
1615     int num_surfaces,
1616     short src_x, /* upper left offset in subpicture */
1617     short src_y,
1618     unsigned short src_width,
1619     unsigned short src_height,
1620     short dest_x, /* upper left offset in surface */
1621     short dest_y,
1622     unsigned short dest_width,
1623     unsigned short dest_height,
1624     /*
1625      * whether to enable chroma-keying or global-alpha
1626      * see VA_SUBPICTURE_XXX values
1627      */
1628     unsigned int flags
1629 );
1630
1631 /*
1632  * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
1633  */
1634 VAStatus vaDeassociateSubpicture (
1635     VADisplay dpy,
1636     VASubpictureID subpicture,
1637     VASurfaceID *target_surfaces,
1638     int num_surfaces
1639 );
1640
1641 typedef struct _VARectangle
1642 {
1643     short x;
1644     short y;
1645     unsigned short width;
1646     unsigned short height;
1647 } VARectangle;
1648
1649 /*
1650  * Display attributes
1651  * Display attributes are used to control things such as contrast, hue, saturation,
1652  * brightness etc. in the rendering process.  The application can query what
1653  * attributes are supported by the driver, and then set the appropriate attributes
1654  * before calling vaPutSurface()
1655  */
1656
1657 /* Currently defined display attribute types */
1658 typedef enum
1659 {
1660     VADisplayAttribBrightness           = 0,
1661     VADisplayAttribContrast             = 1,
1662     VADisplayAttribHue                  = 2,
1663     VADisplayAttribSaturation           = 3,
1664     /* client can specifiy a background color for the target window */
1665     VADisplayAttribBackgroundColor      = 4,
1666     /*
1667      * this is a gettable only attribute. For some implementations that use the
1668      * hardware overlay, after PutSurface is called, the surface can not be    
1669      * re-used until after the subsequent PutSurface call. If this is the case 
1670      * then the value for this attribute will be set to 1 so that the client   
1671      * will not attempt to re-use the surface right after returning from a call
1672      * to PutSurface.
1673      */
1674     VADisplayAttribDirectSurface       = 5,
1675 } VADisplayAttribType;
1676
1677 /* flags for VADisplayAttribute */
1678 #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
1679 #define VA_DISPLAY_ATTRIB_GETTABLE      0x0001
1680 #define VA_DISPLAY_ATTRIB_SETTABLE      0x0002
1681
1682 typedef struct _VADisplayAttribute
1683 {
1684     VADisplayAttribType type;
1685     int min_value;
1686     int max_value;
1687     int value;  /* used by the set/get attribute functions */
1688 /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
1689     unsigned int flags;
1690 } VADisplayAttribute;
1691
1692 /* Get maximum number of display attributs supported by the implementation */
1693 int vaMaxNumDisplayAttributes (
1694     VADisplay dpy
1695 );
1696
1697 /* 
1698  * Query display attributes 
1699  * The caller must provide a "attr_list" array that can hold at
1700  * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
1701  * returned in "attr_list" is returned in "num_attributes".
1702  */
1703 VAStatus vaQueryDisplayAttributes (
1704     VADisplay dpy,
1705     VADisplayAttribute *attr_list,      /* out */
1706     int *num_attributes                 /* out */
1707 );
1708
1709 /* 
1710  * Get display attributes 
1711  * This function returns the current attribute values in "attr_list".
1712  * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
1713  * from vaQueryDisplayAttributes() can have their values retrieved.  
1714  */
1715 VAStatus vaGetDisplayAttributes (
1716     VADisplay dpy,
1717     VADisplayAttribute *attr_list,      /* in/out */
1718     int num_attributes
1719 );
1720
1721 /* 
1722  * Set display attributes 
1723  * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
1724  * from vaQueryDisplayAttributes() can be set.  If the attribute is not settable or 
1725  * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
1726  */
1727 VAStatus vaSetDisplayAttributes (
1728     VADisplay dpy,
1729     VADisplayAttribute *attr_list,
1730     int num_attributes
1731 );
1732
1733 #ifdef __cplusplus
1734 }
1735 #endif
1736
1737 #endif /* _VA_H_ */