]> git.sesse.net Git - ffmpeg/blob - libavcodec/vp56.h
pnm: Use av_pix_fmt_desc_get instead of accessing the array directly
[ffmpeg] / libavcodec / vp56.h
1 /*
2  * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * VP5 and VP6 compatible video decoder (common features)
24  */
25
26 #ifndef AVCODEC_VP56_H
27 #define AVCODEC_VP56_H
28
29 #include "vp56data.h"
30 #include "dsputil.h"
31 #include "get_bits.h"
32 #include "bytestream.h"
33 #include "h264chroma.h"
34 #include "videodsp.h"
35 #include "vp3dsp.h"
36 #include "vp56dsp.h"
37
38 typedef struct vp56_context VP56Context;
39
40 typedef struct VP56mv {
41     DECLARE_ALIGNED(4, int16_t, x);
42     int16_t y;
43 } VP56mv;
44
45 #define VP56_SIZE_CHANGE 1
46
47 typedef void (*VP56ParseVectorAdjustment)(VP56Context *s,
48                                           VP56mv *vect);
49 typedef void (*VP56Filter)(VP56Context *s, uint8_t *dst, uint8_t *src,
50                            int offset1, int offset2, int stride,
51                            VP56mv mv, int mask, int select, int luma);
52 typedef void (*VP56ParseCoeff)(VP56Context *s);
53 typedef void (*VP56DefaultModelsInit)(VP56Context *s);
54 typedef void (*VP56ParseVectorModels)(VP56Context *s);
55 typedef int  (*VP56ParseCoeffModels)(VP56Context *s);
56 typedef int  (*VP56ParseHeader)(VP56Context *s, const uint8_t *buf,
57                                 int buf_size, int *golden_frame);
58
59 typedef struct VP56RangeCoder {
60     int high;
61     int bits; /* stored negated (i.e. negative "bits" is a positive number of
62                  bits left) in order to eliminate a negate in cache refilling */
63     const uint8_t *buffer;
64     const uint8_t *end;
65     unsigned int code_word;
66 } VP56RangeCoder;
67
68 typedef struct VP56RefDc {
69     uint8_t not_null_dc;
70     VP56Frame ref_frame;
71     int16_t dc_coeff;
72 } VP56RefDc;
73
74 typedef struct VP56Macroblock {
75     uint8_t type;
76     VP56mv mv;
77 } VP56Macroblock;
78
79 typedef struct VP56Model {
80     uint8_t coeff_reorder[64];       /* used in vp6 only */
81     uint8_t coeff_index_to_pos[64];  /* used in vp6 only */
82     uint8_t vector_sig[2];           /* delta sign */
83     uint8_t vector_dct[2];           /* delta coding types */
84     uint8_t vector_pdi[2][2];        /* predefined delta init */
85     uint8_t vector_pdv[2][7];        /* predefined delta values */
86     uint8_t vector_fdv[2][8];        /* 8 bit delta value definition */
87     uint8_t coeff_dccv[2][11];       /* DC coeff value */
88     uint8_t coeff_ract[2][3][6][11]; /* Run/AC coding type and AC coeff value */
89     uint8_t coeff_acct[2][3][3][6][5];/* vp5 only AC coding type for coding group < 3 */
90     uint8_t coeff_dcct[2][36][5];    /* DC coeff coding type */
91     uint8_t coeff_runv[2][14];       /* run value (vp6 only) */
92     uint8_t mb_type[3][10][10];      /* model for decoding MB type */
93     uint8_t mb_types_stats[3][10][2];/* contextual, next MB type stats */
94 } VP56Model;
95
96 struct vp56_context {
97     AVCodecContext *avctx;
98     DSPContext dsp;
99     H264ChromaContext h264chroma;
100     VideoDSPContext vdsp;
101     VP3DSPContext vp3dsp;
102     VP56DSPContext vp56dsp;
103     ScanTable scantable;
104     AVFrame frames[4];
105     AVFrame *framep[6];
106     uint8_t *edge_emu_buffer_alloc;
107     uint8_t *edge_emu_buffer;
108     VP56RangeCoder c;
109     VP56RangeCoder cc;
110     VP56RangeCoder *ccp;
111     int sub_version;
112
113     /* frame info */
114     int plane_width[4];
115     int plane_height[4];
116     int mb_width;   /* number of horizontal MB */
117     int mb_height;  /* number of vertical MB */
118     int block_offset[6];
119
120     int quantizer;
121     uint16_t dequant_dc;
122     uint16_t dequant_ac;
123     int8_t *qscale_table;
124
125     /* DC predictors management */
126     VP56RefDc *above_blocks;
127     VP56RefDc left_block[4];
128     int above_block_idx[6];
129     int16_t prev_dc[3][3];    /* [plan][ref_frame] */
130
131     /* blocks / macroblock */
132     VP56mb mb_type;
133     VP56Macroblock *macroblocks;
134     DECLARE_ALIGNED(16, int16_t, block_coeff)[6][64];
135
136     /* motion vectors */
137     VP56mv mv[6];  /* vectors for each block in MB */
138     VP56mv vector_candidate[2];
139     int vector_candidate_pos;
140
141     /* filtering hints */
142     int filter_header;               /* used in vp6 only */
143     int deblock_filtering;
144     int filter_selection;
145     int filter_mode;
146     int max_vector_length;
147     int sample_variance_threshold;
148
149     uint8_t coeff_ctx[4][64];              /* used in vp5 only */
150     uint8_t coeff_ctx_last[4];             /* used in vp5 only */
151
152     int has_alpha;
153
154     /* upside-down flipping hints */
155     int flip;  /* are we flipping ? */
156     int frbi;  /* first row block index in MB */
157     int srbi;  /* second row block index in MB */
158     int stride[4];  /* stride for each plan */
159
160     const uint8_t *vp56_coord_div;
161     VP56ParseVectorAdjustment parse_vector_adjustment;
162     VP56Filter filter;
163     VP56ParseCoeff parse_coeff;
164     VP56DefaultModelsInit default_models_init;
165     VP56ParseVectorModels parse_vector_models;
166     VP56ParseCoeffModels parse_coeff_models;
167     VP56ParseHeader parse_header;
168
169     VP56Model *modelp;
170     VP56Model models[2];
171
172     /* huffman decoding */
173     int use_huffman;
174     GetBitContext gb;
175     VLC dccv_vlc[2];
176     VLC runv_vlc[2];
177     VLC ract_vlc[2][3][6];
178     unsigned int nb_null[2][2];       /* number of consecutive NULL DC/AC */
179 };
180
181
182 void ff_vp56_init(AVCodecContext *avctx, int flip, int has_alpha);
183 int ff_vp56_free(AVCodecContext *avctx);
184 void ff_vp56_init_dequant(VP56Context *s, int quantizer);
185 int ff_vp56_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
186                          AVPacket *avpkt);
187
188
189 /**
190  * vp56 specific range coder implementation
191  */
192
193 extern const uint8_t ff_vp56_norm_shift[256];
194 void ff_vp56_init_range_decoder(VP56RangeCoder *c, const uint8_t *buf, int buf_size);
195
196 static av_always_inline unsigned int vp56_rac_renorm(VP56RangeCoder *c)
197 {
198     int shift = ff_vp56_norm_shift[c->high];
199     int bits = c->bits;
200     unsigned int code_word = c->code_word;
201
202     c->high   <<= shift;
203     code_word <<= shift;
204     bits       += shift;
205     if(bits >= 0 && c->buffer < c->end) {
206         code_word |= bytestream_get_be16(&c->buffer) << bits;
207         bits -= 16;
208     }
209     c->bits = bits;
210     return code_word;
211 }
212
213 #if   ARCH_ARM
214 #include "arm/vp56_arith.h"
215 #elif ARCH_X86
216 #include "x86/vp56_arith.h"
217 #endif
218
219 #ifndef vp56_rac_get_prob
220 #define vp56_rac_get_prob vp56_rac_get_prob
221 static av_always_inline int vp56_rac_get_prob(VP56RangeCoder *c, uint8_t prob)
222 {
223     unsigned int code_word = vp56_rac_renorm(c);
224     unsigned int low = 1 + (((c->high - 1) * prob) >> 8);
225     unsigned int low_shift = low << 16;
226     int bit = code_word >= low_shift;
227
228     c->high = bit ? c->high - low : low;
229     c->code_word = bit ? code_word - low_shift : code_word;
230
231     return bit;
232 }
233 #endif
234
235 #ifndef vp56_rac_get_prob_branchy
236 // branchy variant, to be used where there's a branch based on the bit decoded
237 static av_always_inline int vp56_rac_get_prob_branchy(VP56RangeCoder *c, int prob)
238 {
239     unsigned long code_word = vp56_rac_renorm(c);
240     unsigned low = 1 + (((c->high - 1) * prob) >> 8);
241     unsigned low_shift = low << 16;
242
243     if (code_word >= low_shift) {
244         c->high     -= low;
245         c->code_word = code_word - low_shift;
246         return 1;
247     }
248
249     c->high = low;
250     c->code_word = code_word;
251     return 0;
252 }
253 #endif
254
255 static av_always_inline int vp56_rac_get(VP56RangeCoder *c)
256 {
257     unsigned int code_word = vp56_rac_renorm(c);
258     /* equiprobable */
259     int low = (c->high + 1) >> 1;
260     unsigned int low_shift = low << 16;
261     int bit = code_word >= low_shift;
262     if (bit) {
263         c->high   -= low;
264         code_word -= low_shift;
265     } else {
266         c->high = low;
267     }
268
269     c->code_word = code_word;
270     return bit;
271 }
272
273 // rounding is different than vp56_rac_get, is vp56_rac_get wrong?
274 static av_always_inline int vp8_rac_get(VP56RangeCoder *c)
275 {
276     return vp56_rac_get_prob(c, 128);
277 }
278
279 static av_unused int vp56_rac_gets(VP56RangeCoder *c, int bits)
280 {
281     int value = 0;
282
283     while (bits--) {
284         value = (value << 1) | vp56_rac_get(c);
285     }
286
287     return value;
288 }
289
290 static av_unused int vp8_rac_get_uint(VP56RangeCoder *c, int bits)
291 {
292     int value = 0;
293
294     while (bits--) {
295         value = (value << 1) | vp8_rac_get(c);
296     }
297
298     return value;
299 }
300
301 // fixme: add 1 bit to all the calls to this?
302 static av_unused int vp8_rac_get_sint(VP56RangeCoder *c, int bits)
303 {
304     int v;
305
306     if (!vp8_rac_get(c))
307         return 0;
308
309     v = vp8_rac_get_uint(c, bits);
310
311     if (vp8_rac_get(c))
312         v = -v;
313
314     return v;
315 }
316
317 // P(7)
318 static av_unused int vp56_rac_gets_nn(VP56RangeCoder *c, int bits)
319 {
320     int v = vp56_rac_gets(c, 7) << 1;
321     return v + !v;
322 }
323
324 static av_unused int vp8_rac_get_nn(VP56RangeCoder *c)
325 {
326     int v = vp8_rac_get_uint(c, 7) << 1;
327     return v + !v;
328 }
329
330 static av_always_inline
331 int vp56_rac_get_tree(VP56RangeCoder *c,
332                       const VP56Tree *tree,
333                       const uint8_t *probs)
334 {
335     while (tree->val > 0) {
336         if (vp56_rac_get_prob(c, probs[tree->prob_idx]))
337             tree += tree->val;
338         else
339             tree++;
340     }
341     return -tree->val;
342 }
343
344 /**
345  * This is identical to vp8_rac_get_tree except for the possibility of starting
346  * on a node other than the root node, needed for coeff decode where this is
347  * used to save a bit after a 0 token (by disallowing EOB to immediately follow.)
348  */
349 static av_always_inline
350 int vp8_rac_get_tree_with_offset(VP56RangeCoder *c, const int8_t (*tree)[2],
351                                  const uint8_t *probs, int i)
352 {
353     do {
354         i = tree[i][vp56_rac_get_prob(c, probs[i])];
355     } while (i > 0);
356
357     return -i;
358 }
359
360 // how probabilities are associated with decisions is different I think
361 // well, the new scheme fits in the old but this way has one fewer branches per decision
362 static av_always_inline
363 int vp8_rac_get_tree(VP56RangeCoder *c, const int8_t (*tree)[2],
364                      const uint8_t *probs)
365 {
366     return vp8_rac_get_tree_with_offset(c, tree, probs, 0);
367 }
368
369 // DCTextra
370 static av_always_inline int vp8_rac_get_coeff(VP56RangeCoder *c, const uint8_t *prob)
371 {
372     int v = 0;
373
374     do {
375         v = (v<<1) + vp56_rac_get_prob(c, *prob++);
376     } while (*prob);
377
378     return v;
379 }
380
381 #endif /* AVCODEC_VP56_H */