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