VP5 and VP6 video decoder
[ffmpeg.git] / libavcodec / vp56.h
1 /**
2  * @file vp56.h
3  * VP5 and VP6 compatible video decoder (common features)
4  *
5  * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20  */
21
22 #ifndef VP56_H
23 #define VP56_H
24
25 #include <stdint.h>
26
27 #include "vp56data.h"
28 #include "dsputil.h"
29 #include "mpegvideo.h"
30
31
32 typedef struct vp56_context vp56_context_t;
33 typedef struct vp56_mv vp56_mv_t;
34
35 typedef void (*vp56_parse_vector_adjustment_t)(vp56_context_t *s,
36                                                vp56_mv_t *vector);
37 typedef int (*vp56_adjust_t)(int v, int t);
38 typedef void (*vp56_filter_t)(vp56_context_t *s, uint8_t *dst, uint8_t *src,
39                               int offset1, int offset2, int stride,
40                               vp56_mv_t mv, int mask, int select, int luma);
41 typedef void (*vp56_parse_coeff_t)(vp56_context_t *s);
42 typedef void (*vp56_default_models_init_t)(vp56_context_t *s);
43 typedef void (*vp56_parse_vector_models_t)(vp56_context_t *s);
44 typedef void (*vp56_parse_coeff_models_t)(vp56_context_t *s);
45 typedef int (*vp56_parse_header_t)(vp56_context_t *s, uint8_t *buf,
46                                    int buf_size, int *golden_frame);
47
48 typedef struct {
49     int high;
50     int bits;
51     const uint8_t *buffer;
52     unsigned long code_word;
53 } vp56_range_coder_t;
54
55 typedef struct {
56     uint8_t not_null_dc;
57     vp56_frame_t ref_frame;
58     DCTELEM dc_coeff;
59 } vp56_ref_dc_t;
60
61 struct vp56_mv {
62     int x;
63     int y;
64 };
65
66 typedef struct {
67     uint8_t type;
68     vp56_mv_t mv;
69 } vp56_macroblock_t;
70
71 struct vp56_context {
72     AVCodecContext *avctx;
73     DSPContext dsp;
74     ScanTable scantable;
75     AVFrame frames[3];
76     uint8_t *edge_emu_buffer_alloc;
77     uint8_t *edge_emu_buffer;
78     vp56_range_coder_t c;
79
80     /* frame info */
81     int plane_width[3];
82     int plane_height[3];
83     int mb_width;   /* number of horizontal MB */
84     int mb_height;  /* number of vertical MB */
85     int block_offset[6];
86
87     int quantizer;
88     uint16_t dequant_dc;
89     uint16_t dequant_ac;
90
91     /* DC predictors management */
92     vp56_ref_dc_t *above_blocks;
93     vp56_ref_dc_t left_block[4];
94     int above_block_idx[6];
95     DCTELEM prev_dc[3][3];    /* [plan][ref_frame] */
96
97     /* blocks / macroblock */
98     vp56_mb_t mb_type;
99     vp56_macroblock_t *macroblocks;
100     DECLARE_ALIGNED_16(DCTELEM, block_coeff[6][64]);
101     uint8_t coeff_reorder[64];       /* used in vp6 only */
102     uint8_t coeff_index_to_pos[64];  /* used in vp6 only */
103
104     /* motion vectors */
105     vp56_mv_t mv[6];  /* vectors for each block in MB */
106     vp56_mv_t vector_candidate[2];
107     int vector_candidate_pos;
108
109     /* filtering hints */
110     int deblock_filtering;
111     int filter_selection;
112     int filter_mode;
113     int max_vector_length;
114     int sample_variance_threshold;
115
116     /* AC models */
117     uint8_t vector_model_sig[2];           /* delta sign */
118     uint8_t vector_model_dct[2];           /* delta coding types */
119     uint8_t vector_model_pdi[2][2];        /* predefined delta init */
120     uint8_t vector_model_pdv[2][7];        /* predefined delta values */
121     uint8_t vector_model_fdv[2][8];        /* 8 bit delta value definition */
122     uint8_t mb_type_model[3][10][10];      /* model for decoding MB type */
123     uint8_t coeff_model_dccv[2][11];       /* DC coeff value */
124     uint8_t coeff_model_ract[2][3][6][11]; /* Run/AC coding type and AC coeff value */
125     uint8_t coeff_model_acct[2][3][3][6][5];/* vp5 only AC coding type for coding group < 3 */
126     uint8_t coeff_model_dcct[2][36][5];    /* DC coeff coding type */
127     uint8_t coeff_model_runv[2][14];       /* run value (vp6 only) */
128     uint8_t mb_types_stats[3][10][2];      /* contextual, next MB type stats */
129     uint8_t coeff_ctx[4][64];              /* used in vp5 only */
130     uint8_t coeff_ctx_last[4];             /* used in vp5 only */
131
132     /* upside-down flipping hints */
133     int flip;  /* are we flipping ? */
134     int frbi;  /* first row block index in MB */
135     int srbi;  /* second row block index in MB */
136     int stride[3];  /* stride for each plan */
137
138     const uint8_t *vp56_coord_div;
139     vp56_parse_vector_adjustment_t parse_vector_adjustment;
140     vp56_adjust_t adjust;
141     vp56_filter_t filter;
142     vp56_parse_coeff_t parse_coeff;
143     vp56_default_models_init_t default_models_init;
144     vp56_parse_vector_models_t parse_vector_models;
145     vp56_parse_coeff_models_t parse_coeff_models;
146     vp56_parse_header_t parse_header;
147 };
148
149
150 void vp56_init(vp56_context_t *s, AVCodecContext *avctx, int flip);
151 int vp56_free(AVCodecContext *avctx);
152 void vp56_init_dequant(vp56_context_t *s, int quantizer);
153 int vp56_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
154                       uint8_t *buf, int buf_size);
155
156
157 /**
158  * vp56 specific range coder implementation
159  */
160
161 static inline void vp56_init_range_decoder(vp56_range_coder_t *c,
162                                            const uint8_t *buf, int buf_size)
163 {
164     c->high = 255;
165     c->bits = 8;
166     c->buffer = buf;
167     c->code_word = *c->buffer++ << 8;
168     c->code_word |= *c->buffer++;
169 }
170
171 static inline int vp56_rac_get_prob(vp56_range_coder_t *c, uint8_t prob)
172 {
173     unsigned int low = 1 + (((c->high - 1) * prob) / 256);
174     unsigned int low_shift = low << 8;
175     int bit = c->code_word >= low_shift;
176
177     if (bit) {
178         c->high -= low;
179         c->code_word -= low_shift;
180     } else {
181         c->high = low;
182     }
183
184     /* normalize */
185     while (c->high < 128) {
186         c->high <<= 1;
187         c->code_word <<= 1;
188         if (--c->bits == 0) {
189             c->bits = 8;
190             c->code_word |= *c->buffer++;
191         }
192     }
193     return bit;
194 }
195
196 static inline int vp56_rac_get(vp56_range_coder_t *c)
197 {
198     /* equiprobable */
199     int low = (c->high + 1) >> 1;
200     unsigned int low_shift = low << 8;
201     int bit = c->code_word >= low_shift;
202     if (bit) {
203         c->high = (c->high - low) << 1;
204         c->code_word -= low_shift;
205     } else {
206         c->high = low << 1;
207     }
208
209     /* normalize */
210     c->code_word <<= 1;
211     if (--c->bits == 0) {
212         c->bits = 8;
213         c->code_word |= *c->buffer++;
214     }
215     return bit;
216 }
217
218 static inline int vp56_rac_gets(vp56_range_coder_t *c, int bits)
219 {
220     int value = 0;
221
222     while (bits--) {
223         value = (value << 1) | vp56_rac_get(c);
224     }
225
226     return value;
227 }
228
229 static inline int vp56_rac_gets_nn(vp56_range_coder_t *c, int bits)
230 {
231     int v = vp56_rac_gets(c, 7) << 1;
232     return v + !v;
233 }
234
235 static inline int vp56_rac_get_tree(vp56_range_coder_t *c,
236                                     const vp56_tree_t *tree,
237                                     const uint8_t *probs)
238 {
239     while (tree->val > 0) {
240         if (vp56_rac_get_prob(c, probs[tree->prob_idx]))
241             tree += tree->val;
242         else
243             tree++;
244     }
245     return -tree->val;
246 }
247
248 #endif /* VP56_H */