summaryrefslogtreecommitdiff
path: root/va/va_dec_vp8.h
blob: db74f4dcdc10efcb22b967e8888aa106750fca5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
 * Copyright (c) 2007-2012 Intel Corporation. All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/**
 * \file va_dec_vp.h
 * \brief VP8 decoding API
 *
 * This file contains the \ref api_dec_vp8 "VP8 decoding API".
 */

#ifndef VA_DEC_VP8_H
#define VA_DEC_VP8_H

#ifdef __cplusplus
extern "C" {
#endif

/**
 * \defgroup api_dec_vp8 VP8 decoding API
 *
 * @{
 */

/**
 * \brief VPX Bool Coder Context structure 
 *
 * This common structure is defined for potential sharing by other VP formats
 *
 */
typedef struct _VABoolCoderContextVPX
{
    /* partition 0 "range" */
    unsigned short range;
    /* partition 0 "value" */
    unsigned int value;
    /* partition 0 number of shifts before an output byte is available */
    unsigned short count;
} VABoolCoderContextVPX;

/**
 * \brief VP8 Decoding Picture Parameter Buffer Structure
 *
 * This structure conveys frame level parameters and should be sent once
 * per frame.
 *
 */
typedef struct  _VAPictureParameterBufferVP8
{
    /* frame width in pixels */
    unsigned int frame_width;
    /* frame height in pixels */
    unsigned int frame_height;

    /* specifies the "last" reference frame */
    VASurfaceID last_ref_frame;
    /* specifies the "golden" reference frame */
    VASurfaceID golden_ref_frame;
    /* specifies the "alternate" referrence frame */
    VASurfaceID alt_ref_frame;
    /* specifies the out-of-loop deblocked frame, not used currently */
    VASurfaceID out_of_loop_frame;

    union {
        struct {
	    /* same as key_frame in bitstream syntax */
            unsigned int key_frame			: 1; 
	    /* same as version in bitstream syntax */
            unsigned int version			: 3;
	    /* same as segmentation_enabled in bitstream syntax */
            unsigned int segmentation_enabled		: 1;
	    /* same as update_mb_segmentation_map in bitstream syntax */
            unsigned int update_mb_segmentation_map	: 1;
	    /* same as update_segment_feature_data in bitstream syntax */
            unsigned int update_segment_feature_data	: 1;
	    /* same as filter_type in bitstream syntax */
            unsigned int filter_type			: 1; 
	    /* same as sharpness_level in bitstream syntax */
            unsigned int sharpness_level		: 3; 
	    /* same as loop_filter_adj_enable in bitstream syntax */
            unsigned int loop_filter_adj_enable		: 1; 
	    /* same as mode_ref_lf_delta_update in bitstream syntax */
            unsigned int mode_ref_lf_delta_update	: 1; 
	    /* same as sign_bias_golden in bitstream syntax */
            unsigned int sign_bias_golden		: 1; 
	    /* same as sign_bias_alternate in bitstream syntax */
            unsigned int sign_bias_alternate		: 1; 
	    /* same as mb_no_coeff_skip in bitstream syntax */
            unsigned int mb_no_coeff_skip		: 1; 
	    /* see section 11.1 for mb_skip_coeff */
            unsigned int mb_skip_coeff			: 1; 
	    /* flag to indicate that loop filter should be disabled */
            unsigned int loop_filter_disable		: 1; 
        } bits;
        unsigned int value;
    } pic_fields;

    /*
     * probabilities of the segment_id decoding tree and same as 
     * mb_segment_tree_probs in the spec.
     */
    unsigned char mb_segment_tree_probs[3];

    /* Post-adjustment loop filter levels for the 4 segments */
    unsigned char loop_filter_level[4];
    /* loop filter deltas for reference frame based MB level adjustment */
    char loop_filter_deltas_ref_frame[4];
    /* loop filter deltas for coding mode based MB level adjustment */
    char loop_filter_deltas_mode[4];

    /* same as prob_skip_false in bitstream syntax */
    unsigned char prob_skip_false;
    /* same as prob_intra in bitstream syntax */
    unsigned char prob_intra;
    /* same as prob_last in bitstream syntax */
    unsigned char prob_last;
    /* same as prob_gf in bitstream syntax */
    unsigned char prob_gf;

    /* 
     * list of 4 probabilities of the luma intra prediction mode decoding
     * tree and same as y_mode_probs in frame header
     */
    unsigned char y_mode_probs[4]; 
    /*
     * list of 3 probabilities of the chroma intra prediction mode decoding
     * tree and same as uv_mode_probs in frame header
     */
    unsigned char uv_mode_probs[3];
    /* 
     * updated mv decoding probabilities and same as mv_probs in 
     * frame header
     */
    unsigned char mv_probs[2][19];

    VABoolCoderContextVPX bool_coder_ctx;

    /* Partitions */
    unsigned char num_of_partitions;
    unsigned int partition_size[9];

    /*
     * offset to the first bit of MB from the first byte of slice data buffer
     */
    unsigned int macroblock_offset;

} VAPictureParameterBufferVP8;

/**
 * \brief VP8 Coefficient Probability Data Buffer Structure
 *
 * Contains the contents of the token probability table, which may be 
 * incrementally modified in the frame header. There are four dimensions to 
 * the token probability array. The outermost dimension is indexed by the 
 * type of plane being decoded; the next dimension is selected by the 
 * position of the coefficient being decoded; the third dimension, * roughly 
 * speaking, measures the "local complexity" or extent to which nearby 
 * coefficients are non-zero; the fourth, and final, dimension of the token 
 * probability array is indexed by the position in the token tree structure, 
 * as are all tree probability arrays. This structure is sent once per frame.
 *
 */
typedef struct _VAProbabilityDataBufferVP8
{
    unsigned char dct_coeff_probs[4][8][3][11];
} VAProbabilityDataBufferVP8;

/**
 * \brief VP8 Inverse Quantization Matrix Buffer Structure
 *
 * Contains quantization indices for yac(0),ydc(1),y2dc(2),y2ac(3),uvdc(4),
 * uvac(5) for each segment (0-3). When segmentation is disabled, only  
 * quantization_index[0][] will be used. This structure is sent once per frame.
 */
typedef struct _VAIQMatrixBufferVP8
{
    /* 
     * array first dimensional is segment and 2nd dimensional is Q index
     */
    unsigned short quantization_index[4][6];
} VAIQMatrixBufferVP8;

/**@}*/

#ifdef __cplusplus
}
#endif

#endif /* VA_DEC_VP8_H */