moves fraps huffman decoder to its own file, making it more generic
[libav.git] / libavcodec / vp56.h
CommitLineData
5ce117c3
AJ
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 *
b78e7197
DB
7 * This file is part of FFmpeg.
8 *
9 * FFmpeg is free software; you can redistribute it and/or
5ce117c3
AJ
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 *
b78e7197 14 * FFmpeg is distributed in the hope that it will be useful,
5ce117c3
AJ
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
b78e7197 20 * License along with FFmpeg; if not, write to the Free Software
e5a389a1 21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5ce117c3
AJ
22 */
23
24#ifndef VP56_H
25#define VP56_H
26
5ce117c3
AJ
27#include "vp56data.h"
28#include "dsputil.h"
29#include "mpegvideo.h"
2c124cb6 30#include "bytestream.h"
5ce117c3
AJ
31
32
33typedef struct vp56_context vp56_context_t;
34typedef struct vp56_mv vp56_mv_t;
35
36typedef void (*vp56_parse_vector_adjustment_t)(vp56_context_t *s,
4fde5060 37 vp56_mv_t *vect);
5ce117c3
AJ
38typedef int (*vp56_adjust_t)(int v, int t);
39typedef void (*vp56_filter_t)(vp56_context_t *s, uint8_t *dst, uint8_t *src,
40 int offset1, int offset2, int stride,
41 vp56_mv_t mv, int mask, int select, int luma);
42typedef void (*vp56_parse_coeff_t)(vp56_context_t *s);
43typedef void (*vp56_default_models_init_t)(vp56_context_t *s);
44typedef void (*vp56_parse_vector_models_t)(vp56_context_t *s);
45typedef void (*vp56_parse_coeff_models_t)(vp56_context_t *s);
46typedef int (*vp56_parse_header_t)(vp56_context_t *s, uint8_t *buf,
47 int buf_size, int *golden_frame);
48
49typedef struct {
50 int high;
51 int bits;
977f6a90 52 uint8_t *buffer;
5ce117c3
AJ
53 unsigned long code_word;
54} vp56_range_coder_t;
55
56typedef struct {
57 uint8_t not_null_dc;
58 vp56_frame_t ref_frame;
59 DCTELEM dc_coeff;
60} vp56_ref_dc_t;
61
62struct vp56_mv {
63 int x;
64 int y;
65};
66
67typedef struct {
68 uint8_t type;
69 vp56_mv_t mv;
70} vp56_macroblock_t;
71
247df384
AJ
72typedef struct {
73 uint8_t coeff_reorder[64]; /* used in vp6 only */
74 uint8_t coeff_index_to_pos[64]; /* used in vp6 only */
75 uint8_t vector_sig[2]; /* delta sign */
76 uint8_t vector_dct[2]; /* delta coding types */
77 uint8_t vector_pdi[2][2]; /* predefined delta init */
78 uint8_t vector_pdv[2][7]; /* predefined delta values */
79 uint8_t vector_fdv[2][8]; /* 8 bit delta value definition */
80 uint8_t coeff_dccv[2][11]; /* DC coeff value */
81 uint8_t coeff_ract[2][3][6][11]; /* Run/AC coding type and AC coeff value */
82 uint8_t coeff_acct[2][3][3][6][5];/* vp5 only AC coding type for coding group < 3 */
83 uint8_t coeff_dcct[2][36][5]; /* DC coeff coding type */
84 uint8_t coeff_runv[2][14]; /* run value (vp6 only) */
85 uint8_t mb_type[3][10][10]; /* model for decoding MB type */
86 uint8_t mb_types_stats[3][10][2];/* contextual, next MB type stats */
87} vp56_model_t;
88
5ce117c3
AJ
89struct vp56_context {
90 AVCodecContext *avctx;
91 DSPContext dsp;
92 ScanTable scantable;
91fc2cf1
AJ
93 AVFrame frames[4];
94 AVFrame *framep[6];
5ce117c3
AJ
95 uint8_t *edge_emu_buffer_alloc;
96 uint8_t *edge_emu_buffer;
97 vp56_range_coder_t c;
dd9b8635
AJ
98 vp56_range_coder_t cc;
99 vp56_range_coder_t *ccp;
9110a0e3 100 int sub_version;
5ce117c3
AJ
101
102 /* frame info */
91fc2cf1
AJ
103 int plane_width[4];
104 int plane_height[4];
5ce117c3
AJ
105 int mb_width; /* number of horizontal MB */
106 int mb_height; /* number of vertical MB */
107 int block_offset[6];
108
109 int quantizer;
110 uint16_t dequant_dc;
111 uint16_t dequant_ac;
112
113 /* DC predictors management */
114 vp56_ref_dc_t *above_blocks;
115 vp56_ref_dc_t left_block[4];
116 int above_block_idx[6];
117 DCTELEM prev_dc[3][3]; /* [plan][ref_frame] */
118
119 /* blocks / macroblock */
120 vp56_mb_t mb_type;
121 vp56_macroblock_t *macroblocks;
122 DECLARE_ALIGNED_16(DCTELEM, block_coeff[6][64]);
5ce117c3
AJ
123
124 /* motion vectors */
125 vp56_mv_t mv[6]; /* vectors for each block in MB */
126 vp56_mv_t vector_candidate[2];
127 int vector_candidate_pos;
128
129 /* filtering hints */
dd9b8635 130 int filter_header; /* used in vp6 only */
5ce117c3
AJ
131 int deblock_filtering;
132 int filter_selection;
133 int filter_mode;
134 int max_vector_length;
135 int sample_variance_threshold;
136
5ce117c3
AJ
137 uint8_t coeff_ctx[4][64]; /* used in vp5 only */
138 uint8_t coeff_ctx_last[4]; /* used in vp5 only */
139
91fc2cf1
AJ
140 int has_alpha;
141
5ce117c3
AJ
142 /* upside-down flipping hints */
143 int flip; /* are we flipping ? */
144 int frbi; /* first row block index in MB */
145 int srbi; /* second row block index in MB */
91fc2cf1 146 int stride[4]; /* stride for each plan */
5ce117c3
AJ
147
148 const uint8_t *vp56_coord_div;
149 vp56_parse_vector_adjustment_t parse_vector_adjustment;
150 vp56_adjust_t adjust;
151 vp56_filter_t filter;
152 vp56_parse_coeff_t parse_coeff;
153 vp56_default_models_init_t default_models_init;
154 vp56_parse_vector_models_t parse_vector_models;
155 vp56_parse_coeff_models_t parse_coeff_models;
156 vp56_parse_header_t parse_header;
247df384
AJ
157
158 vp56_model_t *modelp;
91fc2cf1 159 vp56_model_t models[2];
5ce117c3
AJ
160};
161
162
91fc2cf1 163void vp56_init(AVCodecContext *avctx, int flip, int has_alpha);
5ce117c3
AJ
164int vp56_free(AVCodecContext *avctx);
165void vp56_init_dequant(vp56_context_t *s, int quantizer);
166int vp56_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
167 uint8_t *buf, int buf_size);
168
169
170/**
171 * vp56 specific range coder implementation
172 */
173
174static inline void vp56_init_range_decoder(vp56_range_coder_t *c,
977f6a90 175 uint8_t *buf, int buf_size)
5ce117c3
AJ
176{
177 c->high = 255;
178 c->bits = 8;
179 c->buffer = buf;
2c124cb6 180 c->code_word = bytestream_get_be16(&c->buffer);
5ce117c3
AJ
181}
182
183static inline int vp56_rac_get_prob(vp56_range_coder_t *c, uint8_t prob)
184{
185 unsigned int low = 1 + (((c->high - 1) * prob) / 256);
186 unsigned int low_shift = low << 8;
187 int bit = c->code_word >= low_shift;
188
189 if (bit) {
190 c->high -= low;
191 c->code_word -= low_shift;
192 } else {
193 c->high = low;
194 }
195
196 /* normalize */
197 while (c->high < 128) {
198 c->high <<= 1;
199 c->code_word <<= 1;
200 if (--c->bits == 0) {
201 c->bits = 8;
202 c->code_word |= *c->buffer++;
203 }
204 }
205 return bit;
206}
207
208static inline int vp56_rac_get(vp56_range_coder_t *c)
209{
210 /* equiprobable */
211 int low = (c->high + 1) >> 1;
212 unsigned int low_shift = low << 8;
213 int bit = c->code_word >= low_shift;
214 if (bit) {
215 c->high = (c->high - low) << 1;
216 c->code_word -= low_shift;
217 } else {
218 c->high = low << 1;
219 }
220
221 /* normalize */
222 c->code_word <<= 1;
223 if (--c->bits == 0) {
224 c->bits = 8;
225 c->code_word |= *c->buffer++;
226 }
227 return bit;
228}
229
230static inline int vp56_rac_gets(vp56_range_coder_t *c, int bits)
231{
232 int value = 0;
233
234 while (bits--) {
235 value = (value << 1) | vp56_rac_get(c);
236 }
237
238 return value;
239}
240
241static inline int vp56_rac_gets_nn(vp56_range_coder_t *c, int bits)
242{
243 int v = vp56_rac_gets(c, 7) << 1;
244 return v + !v;
245}
246
247static inline int vp56_rac_get_tree(vp56_range_coder_t *c,
248 const vp56_tree_t *tree,
249 const uint8_t *probs)
250{
251 while (tree->val > 0) {
252 if (vp56_rac_get_prob(c, probs[tree->prob_idx]))
253 tree += tree->val;
254 else
255 tree++;
256 }
257 return -tree->val;
258}
259
260#endif /* VP56_H */