2 * Copyright (C) 2006 Aurelien Jacobs <aurel@gnuage.org>
4 * This file is part of FFmpeg.
6 * FFmpeg 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.
11 * FFmpeg 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.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * VP5 and VP6 compatible video decoder (common features)
26 #ifndef AVCODEC_VP56_H
27 #define AVCODEC_VP56_H
32 #include "bytestream.h"
33 #include "h264chroma.h"
38 typedef struct vp56_context VP56Context;
42 VP56_FRAME_CURRENT = 0,
43 VP56_FRAME_PREVIOUS = 1,
44 VP56_FRAME_GOLDEN = 2,
45 VP56_FRAME_GOLDEN2 = 3,
49 VP56_MB_INTER_NOVEC_PF = 0, /**< Inter MB, no vector, from previous frame */
50 VP56_MB_INTRA = 1, /**< Intra MB */
51 VP56_MB_INTER_DELTA_PF = 2, /**< Inter MB, above/left vector + delta, from previous frame */
52 VP56_MB_INTER_V1_PF = 3, /**< Inter MB, first vector, from previous frame */
53 VP56_MB_INTER_V2_PF = 4, /**< Inter MB, second vector, from previous frame */
54 VP56_MB_INTER_NOVEC_GF = 5, /**< Inter MB, no vector, from golden frame */
55 VP56_MB_INTER_DELTA_GF = 6, /**< Inter MB, above/left vector + delta, from golden frame */
56 VP56_MB_INTER_4V = 7, /**< Inter MB, 4 vectors, from previous frame */
57 VP56_MB_INTER_V1_GF = 8, /**< Inter MB, first vector, from golden frame */
58 VP56_MB_INTER_V2_GF = 9, /**< Inter MB, second vector, from golden frame */
61 typedef struct VP56Tree {
66 typedef struct VP56mv {
67 DECLARE_ALIGNED(4, int16_t, x);
71 #define VP56_SIZE_CHANGE 1
73 typedef void (*VP56ParseVectorAdjustment)(VP56Context *s,
75 typedef void (*VP56Filter)(VP56Context *s, uint8_t *dst, uint8_t *src,
76 int offset1, int offset2, ptrdiff_t stride,
77 VP56mv mv, int mask, int select, int luma);
78 typedef int (*VP56ParseCoeff)(VP56Context *s);
79 typedef void (*VP56DefaultModelsInit)(VP56Context *s);
80 typedef void (*VP56ParseVectorModels)(VP56Context *s);
81 typedef int (*VP56ParseCoeffModels)(VP56Context *s);
82 typedef int (*VP56ParseHeader)(VP56Context *s, const uint8_t *buf,
85 typedef struct VP56RangeCoder {
87 int bits; /* stored negated (i.e. negative "bits" is a positive number of
88 bits left) in order to eliminate a negate in cache refilling */
89 const uint8_t *buffer;
91 unsigned int code_word;
94 typedef struct VP56RefDc {
100 typedef struct VP56Macroblock {
105 typedef struct VP56Model {
106 uint8_t coeff_reorder[64]; /* used in vp6 only */
107 uint8_t coeff_index_to_pos[64]; /* used in vp6 only */
108 uint8_t coeff_index_to_idct_selector[64]; /* used in vp6 only */
109 uint8_t vector_sig[2]; /* delta sign */
110 uint8_t vector_dct[2]; /* delta coding types */
111 uint8_t vector_pdi[2][2]; /* predefined delta init */
112 uint8_t vector_pdv[2][7]; /* predefined delta values */
113 uint8_t vector_fdv[2][8]; /* 8 bit delta value definition */
114 uint8_t coeff_dccv[2][11]; /* DC coeff value */
115 uint8_t coeff_ract[2][3][6][11]; /* Run/AC coding type and AC coeff value */
116 uint8_t coeff_acct[2][3][3][6][5];/* vp5 only AC coding type for coding group < 3 */
117 uint8_t coeff_dcct[2][36][5]; /* DC coeff coding type */
118 uint8_t coeff_runv[2][14]; /* run value (vp6 only) */
119 uint8_t mb_type[3][10][10]; /* model for decoding MB type */
120 uint8_t mb_types_stats[3][10][2];/* contextual, next MB type stats */
123 struct vp56_context {
124 AVCodecContext *avctx;
125 H264ChromaContext h264chroma;
127 VideoDSPContext vdsp;
128 VP3DSPContext vp3dsp;
129 VP56DSPContext vp56dsp;
130 uint8_t idct_scantable[64];
132 uint8_t *edge_emu_buffer_alloc;
133 uint8_t *edge_emu_buffer;
143 int mb_width; /* number of horizontal MB */
144 int mb_height; /* number of vertical MB */
151 /* DC predictors management */
152 VP56RefDc *above_blocks;
153 VP56RefDc left_block[4];
154 int above_block_idx[6];
155 int16_t prev_dc[3][3]; /* [plan][ref_frame] */
157 /* blocks / macroblock */
159 VP56Macroblock *macroblocks;
160 DECLARE_ALIGNED(16, int16_t, block_coeff)[6][64];
161 int idct_selector[6];
164 VP56mv mv[6]; /* vectors for each block in MB */
165 VP56mv vector_candidate[2];
166 int vector_candidate_pos;
168 /* filtering hints */
169 int filter_header; /* used in vp6 only */
170 int deblock_filtering;
171 int filter_selection;
173 int max_vector_length;
174 int sample_variance_threshold;
175 DECLARE_ALIGNED(8, int, bounding_values_array)[256];
177 uint8_t coeff_ctx[4][64]; /* used in vp5 only */
178 uint8_t coeff_ctx_last[4]; /* used in vp5 only */
182 /* upside-down flipping hints */
183 int flip; /* are we flipping ? */
184 int frbi; /* first row block index in MB */
185 int srbi; /* second row block index in MB */
186 ptrdiff_t stride[4]; /* stride for each plan */
188 const uint8_t *vp56_coord_div;
189 VP56ParseVectorAdjustment parse_vector_adjustment;
191 VP56ParseCoeff parse_coeff;
192 VP56DefaultModelsInit default_models_init;
193 VP56ParseVectorModels parse_vector_models;
194 VP56ParseCoeffModels parse_coeff_models;
195 VP56ParseHeader parse_header;
197 /* for "slice" parallelism between YUV and A */
198 VP56Context *alpha_context;
203 /* huffman decoding */
208 VLC ract_vlc[2][3][6];
209 unsigned int nb_null[2][2]; /* number of consecutive NULL DC/AC */
211 int have_undamaged_frame;
216 int ff_vp56_init(AVCodecContext *avctx, int flip, int has_alpha);
217 int ff_vp56_init_context(AVCodecContext *avctx, VP56Context *s,
218 int flip, int has_alpha);
219 int ff_vp56_free(AVCodecContext *avctx);
220 int ff_vp56_free_context(VP56Context *s);
221 void ff_vp56_init_dequant(VP56Context *s, int quantizer);
222 int ff_vp56_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
227 * vp56 specific range coder implementation
230 extern const uint8_t ff_vp56_norm_shift[256];
231 int ff_vp56_init_range_decoder(VP56RangeCoder *c, const uint8_t *buf, int buf_size);
234 * vp5689 returns 1 if the end of the stream has been reached, 0 otherwise.
236 static av_always_inline int vpX_rac_is_end(VP56RangeCoder *c)
238 return c->end <= c->buffer && c->bits >= 0;
241 static av_always_inline unsigned int vp56_rac_renorm(VP56RangeCoder *c)
243 int shift = ff_vp56_norm_shift[c->high];
245 unsigned int code_word = c->code_word;
250 if(bits >= 0 && c->buffer < c->end) {
251 code_word |= bytestream_get_be16(&c->buffer) << bits;
259 #include "arm/vp56_arith.h"
261 #include "x86/vp56_arith.h"
264 #ifndef vp56_rac_get_prob
265 #define vp56_rac_get_prob vp56_rac_get_prob
266 static av_always_inline int vp56_rac_get_prob(VP56RangeCoder *c, uint8_t prob)
268 unsigned int code_word = vp56_rac_renorm(c);
269 unsigned int low = 1 + (((c->high - 1) * prob) >> 8);
270 unsigned int low_shift = low << 16;
271 int bit = code_word >= low_shift;
273 c->high = bit ? c->high - low : low;
274 c->code_word = bit ? code_word - low_shift : code_word;
280 #ifndef vp56_rac_get_prob_branchy
281 // branchy variant, to be used where there's a branch based on the bit decoded
282 static av_always_inline int vp56_rac_get_prob_branchy(VP56RangeCoder *c, int prob)
284 unsigned long code_word = vp56_rac_renorm(c);
285 unsigned low = 1 + (((c->high - 1) * prob) >> 8);
286 unsigned low_shift = low << 16;
288 if (code_word >= low_shift) {
290 c->code_word = code_word - low_shift;
295 c->code_word = code_word;
300 static av_always_inline int vp56_rac_get(VP56RangeCoder *c)
302 unsigned int code_word = vp56_rac_renorm(c);
304 int low = (c->high + 1) >> 1;
305 unsigned int low_shift = low << 16;
306 int bit = code_word >= low_shift;
309 code_word -= low_shift;
314 c->code_word = code_word;
318 // rounding is different than vp56_rac_get, is vp56_rac_get wrong?
319 static av_always_inline int vp8_rac_get(VP56RangeCoder *c)
321 return vp56_rac_get_prob(c, 128);
324 static int vp56_rac_gets(VP56RangeCoder *c, int bits)
329 value = (value << 1) | vp56_rac_get(c);
335 static int vp8_rac_get_uint(VP56RangeCoder *c, int bits)
340 value = (value << 1) | vp8_rac_get(c);
346 // fixme: add 1 bit to all the calls to this?
347 static av_unused int vp8_rac_get_sint(VP56RangeCoder *c, int bits)
354 v = vp8_rac_get_uint(c, bits);
363 static av_unused int vp56_rac_gets_nn(VP56RangeCoder *c, int bits)
365 int v = vp56_rac_gets(c, 7) << 1;
369 static av_unused int vp8_rac_get_nn(VP56RangeCoder *c)
371 int v = vp8_rac_get_uint(c, 7) << 1;
375 static av_always_inline
376 int vp56_rac_get_tree(VP56RangeCoder *c,
377 const VP56Tree *tree,
378 const uint8_t *probs)
380 while (tree->val > 0) {
381 if (vp56_rac_get_prob_branchy(c, probs[tree->prob_idx]))
389 // how probabilities are associated with decisions is different I think
390 // well, the new scheme fits in the old but this way has one fewer branches per decision
391 static av_always_inline int vp8_rac_get_tree(VP56RangeCoder *c, const int8_t (*tree)[2],
392 const uint8_t *probs)
397 i = tree[i][vp56_rac_get_prob(c, probs[i])];
404 static av_always_inline int vp8_rac_get_coeff(VP56RangeCoder *c, const uint8_t *prob)
409 v = (v<<1) + vp56_rac_get_prob(c, *prob++);
415 #endif /* AVCODEC_VP56_H */