Use pointers to avoid copying AVFrame.
[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 file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
22  */
23
24 #ifndef VP56_H
25 #define VP56_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 *vect);
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     AVFrame *framep[4];
77     uint8_t *edge_emu_buffer_alloc;
78     uint8_t *edge_emu_buffer;
79     vp56_range_coder_t c;
80     vp56_range_coder_t cc;
81     vp56_range_coder_t *ccp;
82     int sub_version;
83
84     /* frame info */
85     int plane_width[3];
86     int plane_height[3];
87     int mb_width;   /* number of horizontal MB */
88     int mb_height;  /* number of vertical MB */
89     int block_offset[6];
90
91     int quantizer;
92     uint16_t dequant_dc;
93     uint16_t dequant_ac;
94
95     /* DC predictors management */
96     vp56_ref_dc_t *above_blocks;
97     vp56_ref_dc_t left_block[4];
98     int above_block_idx[6];
99     DCTELEM prev_dc[3][3];    /* [plan][ref_frame] */
100
101     /* blocks / macroblock */
102     vp56_mb_t mb_type;
103     vp56_macroblock_t *macroblocks;
104     DECLARE_ALIGNED_16(DCTELEM, block_coeff[6][64]);
105     uint8_t coeff_reorder[64];       /* used in vp6 only */
106     uint8_t coeff_index_to_pos[64];  /* used in vp6 only */
107
108     /* motion vectors */
109     vp56_mv_t mv[6];  /* vectors for each block in MB */
110     vp56_mv_t vector_candidate[2];
111     int vector_candidate_pos;
112
113     /* filtering hints */
114     int filter_header;               /* used in vp6 only */
115     int deblock_filtering;
116     int filter_selection;
117     int filter_mode;
118     int max_vector_length;
119     int sample_variance_threshold;
120
121     /* AC models */
122     uint8_t vector_model_sig[2];           /* delta sign */
123     uint8_t vector_model_dct[2];           /* delta coding types */
124     uint8_t vector_model_pdi[2][2];        /* predefined delta init */
125     uint8_t vector_model_pdv[2][7];        /* predefined delta values */
126     uint8_t vector_model_fdv[2][8];        /* 8 bit delta value definition */
127     uint8_t mb_type_model[3][10][10];      /* model for decoding MB type */
128     uint8_t coeff_model_dccv[2][11];       /* DC coeff value */
129     uint8_t coeff_model_ract[2][3][6][11]; /* Run/AC coding type and AC coeff value */
130     uint8_t coeff_model_acct[2][3][3][6][5];/* vp5 only AC coding type for coding group < 3 */
131     uint8_t coeff_model_dcct[2][36][5];    /* DC coeff coding type */
132     uint8_t coeff_model_runv[2][14];       /* run value (vp6 only) */
133     uint8_t mb_types_stats[3][10][2];      /* contextual, next MB type stats */
134     uint8_t coeff_ctx[4][64];              /* used in vp5 only */
135     uint8_t coeff_ctx_last[4];             /* used in vp5 only */
136
137     /* upside-down flipping hints */
138     int flip;  /* are we flipping ? */
139     int frbi;  /* first row block index in MB */
140     int srbi;  /* second row block index in MB */
141     int stride[3];  /* stride for each plan */
142
143     const uint8_t *vp56_coord_div;
144     vp56_parse_vector_adjustment_t parse_vector_adjustment;
145     vp56_adjust_t adjust;
146     vp56_filter_t filter;
147     vp56_parse_coeff_t parse_coeff;
148     vp56_default_models_init_t default_models_init;
149     vp56_parse_vector_models_t parse_vector_models;
150     vp56_parse_coeff_models_t parse_coeff_models;
151     vp56_parse_header_t parse_header;
152 };
153
154
155 void vp56_init(vp56_context_t *s, AVCodecContext *avctx, int flip);
156 int vp56_free(AVCodecContext *avctx);
157 void vp56_init_dequant(vp56_context_t *s, int quantizer);
158 int vp56_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
159                       uint8_t *buf, int buf_size);
160
161
162 /**
163  * vp56 specific range coder implementation
164  */
165
166 static inline void vp56_init_range_decoder(vp56_range_coder_t *c,
167                                            const uint8_t *buf, int buf_size)
168 {
169     c->high = 255;
170     c->bits = 8;
171     c->buffer = buf;
172     c->code_word = *c->buffer++ << 8;
173     c->code_word |= *c->buffer++;
174 }
175
176 static inline int vp56_rac_get_prob(vp56_range_coder_t *c, uint8_t prob)
177 {
178     unsigned int low = 1 + (((c->high - 1) * prob) / 256);
179     unsigned int low_shift = low << 8;
180     int bit = c->code_word >= low_shift;
181
182     if (bit) {
183         c->high -= low;
184         c->code_word -= low_shift;
185     } else {
186         c->high = low;
187     }
188
189     /* normalize */
190     while (c->high < 128) {
191         c->high <<= 1;
192         c->code_word <<= 1;
193         if (--c->bits == 0) {
194             c->bits = 8;
195             c->code_word |= *c->buffer++;
196         }
197     }
198     return bit;
199 }
200
201 static inline int vp56_rac_get(vp56_range_coder_t *c)
202 {
203     /* equiprobable */
204     int low = (c->high + 1) >> 1;
205     unsigned int low_shift = low << 8;
206     int bit = c->code_word >= low_shift;
207     if (bit) {
208         c->high = (c->high - low) << 1;
209         c->code_word -= low_shift;
210     } else {
211         c->high = low << 1;
212     }
213
214     /* normalize */
215     c->code_word <<= 1;
216     if (--c->bits == 0) {
217         c->bits = 8;
218         c->code_word |= *c->buffer++;
219     }
220     return bit;
221 }
222
223 static inline int vp56_rac_gets(vp56_range_coder_t *c, int bits)
224 {
225     int value = 0;
226
227     while (bits--) {
228         value = (value << 1) | vp56_rac_get(c);
229     }
230
231     return value;
232 }
233
234 static inline int vp56_rac_gets_nn(vp56_range_coder_t *c, int bits)
235 {
236     int v = vp56_rac_gets(c, 7) << 1;
237     return v + !v;
238 }
239
240 static inline int vp56_rac_get_tree(vp56_range_coder_t *c,
241                                     const vp56_tree_t *tree,
242                                     const uint8_t *probs)
243 {
244     while (tree->val > 0) {
245         if (vp56_rac_get_prob(c, probs[tree->prob_idx]))
246             tree += tree->val;
247         else
248             tree++;
249     }
250     return -tree->val;
251 }
252
253 #endif /* VP56_H */