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 * VP6 compatible video decoder
25 * The VP6F decoder accepts an optional 1 byte extradata. It is composed of:
26 * - upper 4 bits: difference between encoded width and visible width
27 * - lower 4 bits: difference between encoded height and visible height
41 #define VP6_MAX_HUFF_SIZE 12
43 static void vp6_parse_coeff(VP56Context *s);
44 static void vp6_parse_coeff_huffman(VP56Context *s);
46 static int vp6_parse_header(VP56Context *s, const uint8_t *buf, int buf_size,
49 VP56RangeCoder *c = &s->c;
50 int parse_filter_info = 0;
56 int separated_coeff = buf[0] & 1;
58 s->framep[VP56_FRAME_CURRENT]->key_frame = !(buf[0] & 0x80);
59 ff_vp56_init_dequant(s, (buf[0] >> 1) & 0x3F);
61 if (s->framep[VP56_FRAME_CURRENT]->key_frame) {
62 sub_version = buf[1] >> 3;
65 s->filter_header = buf[1] & 0x06;
67 av_log(s->avctx, AV_LOG_ERROR, "interlacing not supported\n");
70 if (separated_coeff || !s->filter_header) {
71 coeff_offset = AV_RB16(buf+2) - 2;
76 rows = buf[2]; /* number of stored macroblock rows */
77 cols = buf[3]; /* number of stored macroblock cols */
78 /* buf[4] is number of displayed macroblock rows */
79 /* buf[5] is number of displayed macroblock cols */
81 if (!s->macroblocks || /* first frame */
82 16*cols != s->avctx->coded_width ||
83 16*rows != s->avctx->coded_height) {
84 avcodec_set_dimensions(s->avctx, 16*cols, 16*rows);
85 if (s->avctx->extradata_size == 1) {
86 s->avctx->width -= s->avctx->extradata[0] >> 4;
87 s->avctx->height -= s->avctx->extradata[0] & 0x0F;
92 ff_vp56_init_range_decoder(c, buf+6, buf_size-6);
95 parse_filter_info = s->filter_header;
98 s->sub_version = sub_version;
103 if (separated_coeff || !s->filter_header) {
104 coeff_offset = AV_RB16(buf+1) - 2;
108 ff_vp56_init_range_decoder(c, buf+1, buf_size-1);
110 *golden_frame = vp56_rac_get(c);
111 if (s->filter_header) {
112 s->deblock_filtering = vp56_rac_get(c);
113 if (s->deblock_filtering)
115 if (s->sub_version > 7)
116 parse_filter_info = vp56_rac_get(c);
120 if (parse_filter_info) {
121 if (vp56_rac_get(c)) {
123 s->sample_variance_threshold = vp56_rac_gets(c, 5) << vrt_shift;
124 s->max_vector_length = 2 << vp56_rac_gets(c, 3);
125 } else if (vp56_rac_get(c)) {
130 if (s->sub_version > 7)
131 s->filter_selection = vp56_rac_gets(c, 4);
133 s->filter_selection = 16;
136 s->use_huffman = vp56_rac_get(c);
138 s->parse_coeff = vp6_parse_coeff;
141 buf_size -= coeff_offset;
144 if (s->use_huffman) {
145 s->parse_coeff = vp6_parse_coeff_huffman;
146 init_get_bits(&s->gb, buf, buf_size<<3);
148 ff_vp56_init_range_decoder(&s->cc, buf, buf_size);
158 static void vp6_coeff_order_table_init(VP56Context *s)
162 s->modelp->coeff_index_to_pos[0] = 0;
164 for (pos=1; pos<64; pos++)
165 if (s->modelp->coeff_reorder[pos] == i)
166 s->modelp->coeff_index_to_pos[idx++] = pos;
169 static void vp6_default_models_init(VP56Context *s)
171 VP56Model *model = s->modelp;
173 model->vector_dct[0] = 0xA2;
174 model->vector_dct[1] = 0xA4;
175 model->vector_sig[0] = 0x80;
176 model->vector_sig[1] = 0x80;
178 memcpy(model->mb_types_stats, vp56_def_mb_types_stats, sizeof(model->mb_types_stats));
179 memcpy(model->vector_fdv, vp6_def_fdv_vector_model, sizeof(model->vector_fdv));
180 memcpy(model->vector_pdv, vp6_def_pdv_vector_model, sizeof(model->vector_pdv));
181 memcpy(model->coeff_runv, vp6_def_runv_coeff_model, sizeof(model->coeff_runv));
182 memcpy(model->coeff_reorder, vp6_def_coeff_reorder, sizeof(model->coeff_reorder));
184 vp6_coeff_order_table_init(s);
187 static void vp6_parse_vector_models(VP56Context *s)
189 VP56RangeCoder *c = &s->c;
190 VP56Model *model = s->modelp;
193 for (comp=0; comp<2; comp++) {
194 if (vp56_rac_get_prob(c, vp6_sig_dct_pct[comp][0]))
195 model->vector_dct[comp] = vp56_rac_gets_nn(c, 7);
196 if (vp56_rac_get_prob(c, vp6_sig_dct_pct[comp][1]))
197 model->vector_sig[comp] = vp56_rac_gets_nn(c, 7);
200 for (comp=0; comp<2; comp++)
201 for (node=0; node<7; node++)
202 if (vp56_rac_get_prob(c, vp6_pdv_pct[comp][node]))
203 model->vector_pdv[comp][node] = vp56_rac_gets_nn(c, 7);
205 for (comp=0; comp<2; comp++)
206 for (node=0; node<8; node++)
207 if (vp56_rac_get_prob(c, vp6_fdv_pct[comp][node]))
208 model->vector_fdv[comp][node] = vp56_rac_gets_nn(c, 7);
211 /* nodes must ascend by count, but with descending symbol order */
212 static int vp6_huff_cmp(const void *va, const void *vb)
214 const Node *a = va, *b = vb;
215 return (a->count - b->count)*16 + (b->sym - a->sym);
218 static int vp6_build_huff_tree(VP56Context *s, uint8_t coeff_model[],
219 const uint8_t *map, unsigned size, VLC *vlc)
221 Node nodes[2*VP6_MAX_HUFF_SIZE], *tmp = &nodes[size];
224 /* first compute probabilities from model */
226 for (i=0; i<size-1; i++) {
227 a = tmp[i].count * coeff_model[i] >> 8;
228 b = tmp[i].count * (255 - coeff_model[i]) >> 8;
229 nodes[map[2*i ]].count = a + !a;
230 nodes[map[2*i+1]].count = b + !b;
234 /* then build the huffman tree according to probabilities */
235 return ff_huff_build_tree(s->avctx, vlc, size, nodes, vp6_huff_cmp,
236 FF_HUFFMAN_FLAG_HNODE_FIRST);
239 static void vp6_parse_coeff_models(VP56Context *s)
241 VP56RangeCoder *c = &s->c;
242 VP56Model *model = s->modelp;
244 int node, cg, ctx, pos;
245 int ct; /* code type */
246 int pt; /* plane type (0 for Y, 1 for U or V) */
248 memset(def_prob, 0x80, sizeof(def_prob));
250 for (pt=0; pt<2; pt++)
251 for (node=0; node<11; node++)
252 if (vp56_rac_get_prob(c, vp6_dccv_pct[pt][node])) {
253 def_prob[node] = vp56_rac_gets_nn(c, 7);
254 model->coeff_dccv[pt][node] = def_prob[node];
255 } else if (s->framep[VP56_FRAME_CURRENT]->key_frame) {
256 model->coeff_dccv[pt][node] = def_prob[node];
259 if (vp56_rac_get(c)) {
260 for (pos=1; pos<64; pos++)
261 if (vp56_rac_get_prob(c, vp6_coeff_reorder_pct[pos]))
262 model->coeff_reorder[pos] = vp56_rac_gets(c, 4);
263 vp6_coeff_order_table_init(s);
266 for (cg=0; cg<2; cg++)
267 for (node=0; node<14; node++)
268 if (vp56_rac_get_prob(c, vp6_runv_pct[cg][node]))
269 model->coeff_runv[cg][node] = vp56_rac_gets_nn(c, 7);
271 for (ct=0; ct<3; ct++)
272 for (pt=0; pt<2; pt++)
273 for (cg=0; cg<6; cg++)
274 for (node=0; node<11; node++)
275 if (vp56_rac_get_prob(c, vp6_ract_pct[ct][pt][cg][node])) {
276 def_prob[node] = vp56_rac_gets_nn(c, 7);
277 model->coeff_ract[pt][ct][cg][node] = def_prob[node];
278 } else if (s->framep[VP56_FRAME_CURRENT]->key_frame) {
279 model->coeff_ract[pt][ct][cg][node] = def_prob[node];
282 if (s->use_huffman) {
283 for (pt=0; pt<2; pt++) {
284 vp6_build_huff_tree(s, model->coeff_dccv[pt],
285 vp6_huff_coeff_map, 12, &s->dccv_vlc[pt]);
286 vp6_build_huff_tree(s, model->coeff_runv[pt],
287 vp6_huff_run_map, 9, &s->runv_vlc[pt]);
288 for (ct=0; ct<3; ct++)
289 for (cg = 0; cg < 6; cg++)
290 vp6_build_huff_tree(s, model->coeff_ract[pt][ct][cg],
291 vp6_huff_coeff_map, 12,
292 &s->ract_vlc[pt][ct][cg]);
294 memset(s->nb_null, 0, sizeof(s->nb_null));
296 /* coeff_dcct is a linear combination of coeff_dccv */
297 for (pt=0; pt<2; pt++)
298 for (ctx=0; ctx<3; ctx++)
299 for (node=0; node<5; node++)
300 model->coeff_dcct[pt][ctx][node] = av_clip(((model->coeff_dccv[pt][node] * vp6_dccv_lc[ctx][node][0] + 128) >> 8) + vp6_dccv_lc[ctx][node][1], 1, 255);
304 static void vp6_parse_vector_adjustment(VP56Context *s, VP56mv *vect)
306 VP56RangeCoder *c = &s->c;
307 VP56Model *model = s->modelp;
310 *vect = (VP56mv) {0,0};
311 if (s->vector_candidate_pos < 2)
312 *vect = s->vector_candidate[0];
314 for (comp=0; comp<2; comp++) {
317 if (vp56_rac_get_prob(c, model->vector_dct[comp])) {
318 static const uint8_t prob_order[] = {0, 1, 2, 7, 6, 5, 4};
319 for (i=0; i<sizeof(prob_order); i++) {
320 int j = prob_order[i];
321 delta |= vp56_rac_get_prob(c, model->vector_fdv[comp][j])<<j;
324 delta |= vp56_rac_get_prob(c, model->vector_fdv[comp][3])<<3;
328 delta = vp56_rac_get_tree(c, vp56_pva_tree,
329 model->vector_pdv[comp]);
332 if (delta && vp56_rac_get_prob(c, model->vector_sig[comp]))
343 * Read number of consecutive blocks with null DC or AC.
344 * This value is < 74.
346 static unsigned vp6_get_nb_null(VP56Context *s)
348 unsigned val = get_bits(&s->gb, 2);
350 val += get_bits(&s->gb, 2);
352 val = get_bits1(&s->gb) << 2;
353 val = 6+val + get_bits(&s->gb, 2+val);
358 static void vp6_parse_coeff_huffman(VP56Context *s)
360 VP56Model *model = s->modelp;
361 uint8_t *permute = s->scantable.permutated;
363 int coeff, sign, coeff_idx;
365 int pt = 0; /* plane type (0 for Y, 1 for U or V) */
367 for (b=0; b<6; b++) {
368 int ct = 0; /* code type */
370 vlc_coeff = &s->dccv_vlc[pt];
372 for (coeff_idx=0; coeff_idx<64; ) {
374 if (coeff_idx<2 && s->nb_null[coeff_idx][pt]) {
375 s->nb_null[coeff_idx][pt]--;
379 if (get_bits_count(&s->gb) >= s->gb.size_in_bits)
381 coeff = get_vlc2(&s->gb, vlc_coeff->table, 9, 3);
384 int pt = (coeff_idx >= 6);
385 run += get_vlc2(&s->gb, s->runv_vlc[pt].table, 9, 3);
387 run += get_bits(&s->gb, 6);
389 s->nb_null[0][pt] = vp6_get_nb_null(s);
391 } else if (coeff == 11) { /* end of block */
392 if (coeff_idx == 1) /* first AC coeff ? */
393 s->nb_null[1][pt] = vp6_get_nb_null(s);
396 int coeff2 = vp56_coeff_bias[coeff];
398 coeff2 += get_bits(&s->gb, coeff <= 9 ? coeff - 4 : 11);
399 ct = 1 + (coeff2 > 1);
400 sign = get_bits1(&s->gb);
401 coeff2 = (coeff2 ^ -sign) + sign;
403 coeff2 *= s->dequant_ac;
404 idx = model->coeff_index_to_pos[coeff_idx];
405 s->block_coeff[b][permute[idx]] = coeff2;
409 cg = FFMIN(vp6_coeff_groups[coeff_idx], 3);
410 vlc_coeff = &s->ract_vlc[pt][ct][cg];
415 static void vp6_parse_coeff(VP56Context *s)
417 VP56RangeCoder *c = s->ccp;
418 VP56Model *model = s->modelp;
419 uint8_t *permute = s->scantable.permutated;
420 uint8_t *model1, *model2, *model3;
421 int coeff, sign, coeff_idx;
422 int b, i, cg, idx, ctx;
423 int pt = 0; /* plane type (0 for Y, 1 for U or V) */
425 for (b=0; b<6; b++) {
426 int ct = 1; /* code type */
431 ctx = s->left_block[vp56_b6to4[b]].not_null_dc
432 + s->above_blocks[s->above_block_idx[b]].not_null_dc;
433 model1 = model->coeff_dccv[pt];
434 model2 = model->coeff_dcct[pt][ctx];
436 for (coeff_idx=0; coeff_idx<64; ) {
437 if ((coeff_idx>1 && ct==0) || vp56_rac_get_prob(c, model2[0])) {
439 if (vp56_rac_get_prob(c, model2[2])) {
440 if (vp56_rac_get_prob(c, model2[3])) {
441 idx = vp56_rac_get_tree(c, vp56_pc_tree, model1);
442 coeff = vp56_coeff_bias[idx+5];
443 for (i=vp56_coeff_bit_length[idx]; i>=0; i--)
444 coeff += vp56_rac_get_prob(c, vp56_coeff_parse_table[idx][i]) << i;
446 if (vp56_rac_get_prob(c, model2[4]))
447 coeff = 3 + vp56_rac_get_prob(c, model1[5]);
456 sign = vp56_rac_get(c);
457 coeff = (coeff ^ -sign) + sign;
459 coeff *= s->dequant_ac;
460 idx = model->coeff_index_to_pos[coeff_idx];
461 s->block_coeff[b][permute[idx]] = coeff;
467 if (!vp56_rac_get_prob(c, model2[1]))
470 model3 = model->coeff_runv[coeff_idx >= 6];
471 run = vp56_rac_get_tree(c, vp6_pcr_tree, model3);
473 for (run=9, i=0; i<6; i++)
474 run += vp56_rac_get_prob(c, model3[i+8]) << i;
478 cg = vp6_coeff_groups[coeff_idx+=run];
479 model1 = model2 = model->coeff_ract[pt][ct][cg];
482 s->left_block[vp56_b6to4[b]].not_null_dc =
483 s->above_blocks[s->above_block_idx[b]].not_null_dc = !!s->block_coeff[b][0];
487 static int vp6_block_variance(uint8_t *src, int stride)
489 int sum = 0, square_sum = 0;
492 for (y=0; y<8; y+=2) {
493 for (x=0; x<8; x+=2) {
495 square_sum += src[x]*src[x];
499 return (16*square_sum - sum*sum) >> 8;
502 static void vp6_filter_hv4(uint8_t *dst, uint8_t *src, int stride,
503 int delta, const int16_t *weights)
507 for (y=0; y<8; y++) {
508 for (x=0; x<8; x++) {
509 dst[x] = av_clip_uint8(( src[x-delta ] * weights[0]
510 + src[x ] * weights[1]
511 + src[x+delta ] * weights[2]
512 + src[x+2*delta] * weights[3] + 64) >> 7);
519 static void vp6_filter_diag2(VP56Context *s, uint8_t *dst, uint8_t *src,
520 int stride, int h_weight, int v_weight)
522 uint8_t *tmp = s->edge_emu_buffer+16;
523 s->dsp.put_h264_chroma_pixels_tab[0](tmp, src, stride, 9, h_weight, 0);
524 s->dsp.put_h264_chroma_pixels_tab[0](dst, tmp, stride, 8, 0, v_weight);
527 static void vp6_filter(VP56Context *s, uint8_t *dst, uint8_t *src,
528 int offset1, int offset2, int stride,
529 VP56mv mv, int mask, int select, int luma)
532 int x8 = mv.x & mask;
533 int y8 = mv.y & mask;
538 filter4 = s->filter_mode;
540 if (s->max_vector_length &&
541 (FFABS(mv.x) > s->max_vector_length ||
542 FFABS(mv.y) > s->max_vector_length)) {
544 } else if (s->sample_variance_threshold
545 && (vp6_block_variance(src+offset1, stride)
546 < s->sample_variance_threshold)) {
552 if ((y8 && (offset2-offset1)*s->flip<0) || (!y8 && offset1 > offset2)) {
557 if (!y8) { /* left or right combine */
558 vp6_filter_hv4(dst, src+offset1, stride, 1,
559 vp6_block_copy_filter[select][x8]);
560 } else if (!x8) { /* above or below combine */
561 vp6_filter_hv4(dst, src+offset1, stride, stride,
562 vp6_block_copy_filter[select][y8]);
564 s->vp56dsp.vp6_filter_diag4(dst, src+offset1+((mv.x^mv.y)>>31), stride,
565 vp6_block_copy_filter[select][x8],
566 vp6_block_copy_filter[select][y8]);
570 s->dsp.put_h264_chroma_pixels_tab[0](dst, src+offset1, stride, 8, x8, y8);
572 vp6_filter_diag2(s, dst, src+offset1 + ((mv.x^mv.y)>>31), stride, x8, y8);
577 static av_cold int vp6_decode_init(AVCodecContext *avctx)
579 VP56Context *s = avctx->priv_data;
581 ff_vp56_init(avctx, avctx->codec->id == CODEC_ID_VP6,
582 avctx->codec->id == CODEC_ID_VP6A);
583 s->vp56_coord_div = vp6_coord_div;
584 s->parse_vector_adjustment = vp6_parse_vector_adjustment;
585 s->filter = vp6_filter;
586 s->default_models_init = vp6_default_models_init;
587 s->parse_vector_models = vp6_parse_vector_models;
588 s->parse_coeff_models = vp6_parse_coeff_models;
589 s->parse_header = vp6_parse_header;
594 static av_cold int vp6_decode_free(AVCodecContext *avctx)
596 VP56Context *s = avctx->priv_data;
601 for (pt=0; pt<2; pt++) {
602 free_vlc(&s->dccv_vlc[pt]);
603 free_vlc(&s->runv_vlc[pt]);
604 for (ct=0; ct<3; ct++)
605 for (cg=0; cg<6; cg++)
606 free_vlc(&s->ract_vlc[pt][ct][cg]);
611 AVCodec ff_vp6_decoder = {
613 .type = AVMEDIA_TYPE_VIDEO,
615 .priv_data_size = sizeof(VP56Context),
616 .init = vp6_decode_init,
617 .close = vp6_decode_free,
618 .decode = ff_vp56_decode_frame,
619 .capabilities = CODEC_CAP_DR1,
620 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6"),
623 /* flash version, not flipped upside-down */
624 AVCodec ff_vp6f_decoder = {
626 .type = AVMEDIA_TYPE_VIDEO,
628 .priv_data_size = sizeof(VP56Context),
629 .init = vp6_decode_init,
630 .close = vp6_decode_free,
631 .decode = ff_vp56_decode_frame,
632 .capabilities = CODEC_CAP_DR1,
633 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6 (Flash version)"),
636 /* flash version, not flipped upside-down, with alpha channel */
637 AVCodec ff_vp6a_decoder = {
639 .type = AVMEDIA_TYPE_VIDEO,
641 .priv_data_size = sizeof(VP56Context),
642 .init = vp6_decode_init,
643 .close = vp6_decode_free,
644 .decode = ff_vp56_decode_frame,
645 .capabilities = CODEC_CAP_DR1,
646 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6 (Flash version, with alpha channel)"),