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)
48 VP56RangeCoder *c = &s->c;
49 int parse_filter_info = 0;
55 int separated_coeff = buf[0] & 1;
57 s->framep[VP56_FRAME_CURRENT]->key_frame = !(buf[0] & 0x80);
58 ff_vp56_init_dequant(s, (buf[0] >> 1) & 0x3F);
60 if (s->framep[VP56_FRAME_CURRENT]->key_frame) {
61 sub_version = buf[1] >> 3;
63 return AVERROR_INVALIDDATA;
64 s->filter_header = buf[1] & 0x06;
66 av_log_missing_feature(s->avctx, "Interlacing", 0);
67 return AVERROR_PATCHWELCOME;
69 if (separated_coeff || !s->filter_header) {
70 coeff_offset = AV_RB16(buf+2) - 2;
75 rows = buf[2]; /* number of stored macroblock rows */
76 cols = buf[3]; /* number of stored macroblock cols */
77 /* buf[4] is number of displayed macroblock rows */
78 /* buf[5] is number of displayed macroblock cols */
80 av_log(s->avctx, AV_LOG_ERROR, "Invalid size %dx%d\n", cols << 4, rows << 4);
81 return AVERROR_INVALIDDATA;
84 if (!s->macroblocks || /* first frame */
85 16*cols != s->avctx->coded_width ||
86 16*rows != s->avctx->coded_height) {
87 avcodec_set_dimensions(s->avctx, 16*cols, 16*rows);
88 if (s->avctx->extradata_size == 1) {
89 s->avctx->width -= s->avctx->extradata[0] >> 4;
90 s->avctx->height -= s->avctx->extradata[0] & 0x0F;
92 res = VP56_SIZE_CHANGE;
95 ff_vp56_init_range_decoder(c, buf+6, buf_size-6);
98 parse_filter_info = s->filter_header;
101 s->sub_version = sub_version;
104 if (!s->sub_version || !s->avctx->coded_width || !s->avctx->coded_height)
105 return AVERROR_INVALIDDATA;
107 if (separated_coeff || !s->filter_header) {
108 coeff_offset = AV_RB16(buf+1) - 2;
112 ff_vp56_init_range_decoder(c, buf+1, buf_size-1);
114 s->golden_frame = vp56_rac_get(c);
115 if (s->filter_header) {
116 s->deblock_filtering = vp56_rac_get(c);
117 if (s->deblock_filtering)
119 if (s->sub_version > 7)
120 parse_filter_info = vp56_rac_get(c);
124 if (parse_filter_info) {
125 if (vp56_rac_get(c)) {
127 s->sample_variance_threshold = vp56_rac_gets(c, 5) << vrt_shift;
128 s->max_vector_length = 2 << vp56_rac_gets(c, 3);
129 } else if (vp56_rac_get(c)) {
134 if (s->sub_version > 7)
135 s->filter_selection = vp56_rac_gets(c, 4);
137 s->filter_selection = 16;
140 s->use_huffman = vp56_rac_get(c);
142 s->parse_coeff = vp6_parse_coeff;
145 buf_size -= coeff_offset;
147 if (s->framep[VP56_FRAME_CURRENT]->key_frame)
148 avcodec_set_dimensions(s->avctx, 0, 0);
149 return AVERROR_INVALIDDATA;
151 if (s->use_huffman) {
152 s->parse_coeff = vp6_parse_coeff_huffman;
153 init_get_bits(&s->gb, buf, buf_size<<3);
155 ff_vp56_init_range_decoder(&s->cc, buf, buf_size);
165 static void vp6_coeff_order_table_init(VP56Context *s)
169 s->modelp->coeff_index_to_pos[0] = 0;
171 for (pos=1; pos<64; pos++)
172 if (s->modelp->coeff_reorder[pos] == i)
173 s->modelp->coeff_index_to_pos[idx++] = pos;
176 static void vp6_default_models_init(VP56Context *s)
178 VP56Model *model = s->modelp;
180 model->vector_dct[0] = 0xA2;
181 model->vector_dct[1] = 0xA4;
182 model->vector_sig[0] = 0x80;
183 model->vector_sig[1] = 0x80;
185 memcpy(model->mb_types_stats, ff_vp56_def_mb_types_stats, sizeof(model->mb_types_stats));
186 memcpy(model->vector_fdv, vp6_def_fdv_vector_model, sizeof(model->vector_fdv));
187 memcpy(model->vector_pdv, vp6_def_pdv_vector_model, sizeof(model->vector_pdv));
188 memcpy(model->coeff_runv, vp6_def_runv_coeff_model, sizeof(model->coeff_runv));
189 memcpy(model->coeff_reorder, vp6_def_coeff_reorder, sizeof(model->coeff_reorder));
191 vp6_coeff_order_table_init(s);
194 static void vp6_parse_vector_models(VP56Context *s)
196 VP56RangeCoder *c = &s->c;
197 VP56Model *model = s->modelp;
200 for (comp=0; comp<2; comp++) {
201 if (vp56_rac_get_prob(c, vp6_sig_dct_pct[comp][0]))
202 model->vector_dct[comp] = vp56_rac_gets_nn(c, 7);
203 if (vp56_rac_get_prob(c, vp6_sig_dct_pct[comp][1]))
204 model->vector_sig[comp] = vp56_rac_gets_nn(c, 7);
207 for (comp=0; comp<2; comp++)
208 for (node=0; node<7; node++)
209 if (vp56_rac_get_prob(c, vp6_pdv_pct[comp][node]))
210 model->vector_pdv[comp][node] = vp56_rac_gets_nn(c, 7);
212 for (comp=0; comp<2; comp++)
213 for (node=0; node<8; node++)
214 if (vp56_rac_get_prob(c, vp6_fdv_pct[comp][node]))
215 model->vector_fdv[comp][node] = vp56_rac_gets_nn(c, 7);
218 /* nodes must ascend by count, but with descending symbol order */
219 static int vp6_huff_cmp(const void *va, const void *vb)
221 const Node *a = va, *b = vb;
222 return (a->count - b->count)*16 + (b->sym - a->sym);
225 static int vp6_build_huff_tree(VP56Context *s, uint8_t coeff_model[],
226 const uint8_t *map, unsigned size, VLC *vlc)
228 Node nodes[2*VP6_MAX_HUFF_SIZE], *tmp = &nodes[size];
231 /* first compute probabilities from model */
233 for (i=0; i<size-1; i++) {
234 a = tmp[i].count * coeff_model[i] >> 8;
235 b = tmp[i].count * (255 - coeff_model[i]) >> 8;
236 nodes[map[2*i ]].count = a + !a;
237 nodes[map[2*i+1]].count = b + !b;
241 /* then build the huffman tree according to probabilities */
242 return ff_huff_build_tree(s->avctx, vlc, size, nodes, vp6_huff_cmp,
243 FF_HUFFMAN_FLAG_HNODE_FIRST);
246 static int vp6_parse_coeff_models(VP56Context *s)
248 VP56RangeCoder *c = &s->c;
249 VP56Model *model = s->modelp;
251 int node, cg, ctx, pos;
252 int ct; /* code type */
253 int pt; /* plane type (0 for Y, 1 for U or V) */
255 memset(def_prob, 0x80, sizeof(def_prob));
257 for (pt=0; pt<2; pt++)
258 for (node=0; node<11; node++)
259 if (vp56_rac_get_prob(c, vp6_dccv_pct[pt][node])) {
260 def_prob[node] = vp56_rac_gets_nn(c, 7);
261 model->coeff_dccv[pt][node] = def_prob[node];
262 } else if (s->framep[VP56_FRAME_CURRENT]->key_frame) {
263 model->coeff_dccv[pt][node] = def_prob[node];
266 if (vp56_rac_get(c)) {
267 for (pos=1; pos<64; pos++)
268 if (vp56_rac_get_prob(c, vp6_coeff_reorder_pct[pos]))
269 model->coeff_reorder[pos] = vp56_rac_gets(c, 4);
270 vp6_coeff_order_table_init(s);
273 for (cg=0; cg<2; cg++)
274 for (node=0; node<14; node++)
275 if (vp56_rac_get_prob(c, vp6_runv_pct[cg][node]))
276 model->coeff_runv[cg][node] = vp56_rac_gets_nn(c, 7);
278 for (ct=0; ct<3; ct++)
279 for (pt=0; pt<2; pt++)
280 for (cg=0; cg<6; cg++)
281 for (node=0; node<11; node++)
282 if (vp56_rac_get_prob(c, vp6_ract_pct[ct][pt][cg][node])) {
283 def_prob[node] = vp56_rac_gets_nn(c, 7);
284 model->coeff_ract[pt][ct][cg][node] = def_prob[node];
285 } else if (s->framep[VP56_FRAME_CURRENT]->key_frame) {
286 model->coeff_ract[pt][ct][cg][node] = def_prob[node];
289 if (s->use_huffman) {
290 for (pt=0; pt<2; pt++) {
291 if (vp6_build_huff_tree(s, model->coeff_dccv[pt],
292 vp6_huff_coeff_map, 12, &s->dccv_vlc[pt]))
294 if (vp6_build_huff_tree(s, model->coeff_runv[pt],
295 vp6_huff_run_map, 9, &s->runv_vlc[pt]))
297 for (ct=0; ct<3; ct++)
298 for (cg = 0; cg < 6; cg++)
299 if (vp6_build_huff_tree(s, model->coeff_ract[pt][ct][cg],
300 vp6_huff_coeff_map, 12,
301 &s->ract_vlc[pt][ct][cg]))
304 memset(s->nb_null, 0, sizeof(s->nb_null));
306 /* coeff_dcct is a linear combination of coeff_dccv */
307 for (pt=0; pt<2; pt++)
308 for (ctx=0; ctx<3; ctx++)
309 for (node=0; node<5; node++)
310 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);
315 static void vp6_parse_vector_adjustment(VP56Context *s, VP56mv *vect)
317 VP56RangeCoder *c = &s->c;
318 VP56Model *model = s->modelp;
321 *vect = (VP56mv) {0,0};
322 if (s->vector_candidate_pos < 2)
323 *vect = s->vector_candidate[0];
325 for (comp=0; comp<2; comp++) {
328 if (vp56_rac_get_prob(c, model->vector_dct[comp])) {
329 static const uint8_t prob_order[] = {0, 1, 2, 7, 6, 5, 4};
330 for (i=0; i<sizeof(prob_order); i++) {
331 int j = prob_order[i];
332 delta |= vp56_rac_get_prob(c, model->vector_fdv[comp][j])<<j;
335 delta |= vp56_rac_get_prob(c, model->vector_fdv[comp][3])<<3;
339 delta = vp56_rac_get_tree(c, ff_vp56_pva_tree,
340 model->vector_pdv[comp]);
343 if (delta && vp56_rac_get_prob(c, model->vector_sig[comp]))
354 * Read number of consecutive blocks with null DC or AC.
355 * This value is < 74.
357 static unsigned vp6_get_nb_null(VP56Context *s)
359 unsigned val = get_bits(&s->gb, 2);
361 val += get_bits(&s->gb, 2);
363 val = get_bits1(&s->gb) << 2;
364 val = 6+val + get_bits(&s->gb, 2+val);
369 static void vp6_parse_coeff_huffman(VP56Context *s)
371 VP56Model *model = s->modelp;
372 uint8_t *permute = s->scantable.permutated;
374 int coeff, sign, coeff_idx;
376 int pt = 0; /* plane type (0 for Y, 1 for U or V) */
378 for (b=0; b<6; b++) {
379 int ct = 0; /* code type */
381 vlc_coeff = &s->dccv_vlc[pt];
383 for (coeff_idx = 0;;) {
385 if (coeff_idx<2 && s->nb_null[coeff_idx][pt]) {
386 s->nb_null[coeff_idx][pt]--;
390 if (get_bits_left(&s->gb) <= 0)
392 coeff = get_vlc2(&s->gb, vlc_coeff->table, 9, 3);
395 int pt = (coeff_idx >= 6);
396 run += get_vlc2(&s->gb, s->runv_vlc[pt].table, 9, 3);
398 run += get_bits(&s->gb, 6);
400 s->nb_null[0][pt] = vp6_get_nb_null(s);
402 } else if (coeff == 11) { /* end of block */
403 if (coeff_idx == 1) /* first AC coeff ? */
404 s->nb_null[1][pt] = vp6_get_nb_null(s);
407 int coeff2 = ff_vp56_coeff_bias[coeff];
409 coeff2 += get_bits(&s->gb, coeff <= 9 ? coeff - 4 : 11);
410 ct = 1 + (coeff2 > 1);
411 sign = get_bits1(&s->gb);
412 coeff2 = (coeff2 ^ -sign) + sign;
414 coeff2 *= s->dequant_ac;
415 idx = model->coeff_index_to_pos[coeff_idx];
416 s->block_coeff[b][permute[idx]] = coeff2;
422 cg = FFMIN(vp6_coeff_groups[coeff_idx], 3);
423 vlc_coeff = &s->ract_vlc[pt][ct][cg];
428 static void vp6_parse_coeff(VP56Context *s)
430 VP56RangeCoder *c = s->ccp;
431 VP56Model *model = s->modelp;
432 uint8_t *permute = s->scantable.permutated;
433 uint8_t *model1, *model2, *model3;
434 int coeff, sign, coeff_idx;
435 int b, i, cg, idx, ctx;
436 int pt = 0; /* plane type (0 for Y, 1 for U or V) */
438 for (b=0; b<6; b++) {
439 int ct = 1; /* code type */
444 ctx = s->left_block[ff_vp56_b6to4[b]].not_null_dc
445 + s->above_blocks[s->above_block_idx[b]].not_null_dc;
446 model1 = model->coeff_dccv[pt];
447 model2 = model->coeff_dcct[pt][ctx];
451 if ((coeff_idx>1 && ct==0) || vp56_rac_get_prob(c, model2[0])) {
453 if (vp56_rac_get_prob(c, model2[2])) {
454 if (vp56_rac_get_prob(c, model2[3])) {
455 idx = vp56_rac_get_tree(c, ff_vp56_pc_tree, model1);
456 coeff = ff_vp56_coeff_bias[idx+5];
457 for (i=ff_vp56_coeff_bit_length[idx]; i>=0; i--)
458 coeff += vp56_rac_get_prob(c, ff_vp56_coeff_parse_table[idx][i]) << i;
460 if (vp56_rac_get_prob(c, model2[4]))
461 coeff = 3 + vp56_rac_get_prob(c, model1[5]);
470 sign = vp56_rac_get(c);
471 coeff = (coeff ^ -sign) + sign;
473 coeff *= s->dequant_ac;
474 idx = model->coeff_index_to_pos[coeff_idx];
475 s->block_coeff[b][permute[idx]] = coeff;
481 if (!vp56_rac_get_prob(c, model2[1]))
484 model3 = model->coeff_runv[coeff_idx >= 6];
485 run = vp56_rac_get_tree(c, vp6_pcr_tree, model3);
487 for (run=9, i=0; i<6; i++)
488 run += vp56_rac_get_prob(c, model3[i+8]) << i;
494 cg = vp6_coeff_groups[coeff_idx];
495 model1 = model2 = model->coeff_ract[pt][ct][cg];
498 s->left_block[ff_vp56_b6to4[b]].not_null_dc =
499 s->above_blocks[s->above_block_idx[b]].not_null_dc = !!s->block_coeff[b][0];
503 static int vp6_block_variance(uint8_t *src, int stride)
505 int sum = 0, square_sum = 0;
508 for (y=0; y<8; y+=2) {
509 for (x=0; x<8; x+=2) {
511 square_sum += src[x]*src[x];
515 return (16*square_sum - sum*sum) >> 8;
518 static void vp6_filter_hv4(uint8_t *dst, uint8_t *src, int stride,
519 int delta, const int16_t *weights)
523 for (y=0; y<8; y++) {
524 for (x=0; x<8; x++) {
525 dst[x] = av_clip_uint8(( src[x-delta ] * weights[0]
526 + src[x ] * weights[1]
527 + src[x+delta ] * weights[2]
528 + src[x+2*delta] * weights[3] + 64) >> 7);
535 static void vp6_filter_diag2(VP56Context *s, uint8_t *dst, uint8_t *src,
536 int stride, int h_weight, int v_weight)
538 uint8_t *tmp = s->edge_emu_buffer+16;
539 s->h264chroma.put_h264_chroma_pixels_tab[0](tmp, src, stride, 9, h_weight, 0);
540 s->h264chroma.put_h264_chroma_pixels_tab[0](dst, tmp, stride, 8, 0, v_weight);
543 static void vp6_filter(VP56Context *s, uint8_t *dst, uint8_t *src,
544 int offset1, int offset2, int stride,
545 VP56mv mv, int mask, int select, int luma)
548 int x8 = mv.x & mask;
549 int y8 = mv.y & mask;
554 filter4 = s->filter_mode;
556 if (s->max_vector_length &&
557 (FFABS(mv.x) > s->max_vector_length ||
558 FFABS(mv.y) > s->max_vector_length)) {
560 } else if (s->sample_variance_threshold
561 && (vp6_block_variance(src+offset1, stride)
562 < s->sample_variance_threshold)) {
568 if ((y8 && (offset2-offset1)*s->flip<0) || (!y8 && offset1 > offset2)) {
573 if (!y8) { /* left or right combine */
574 vp6_filter_hv4(dst, src+offset1, stride, 1,
575 vp6_block_copy_filter[select][x8]);
576 } else if (!x8) { /* above or below combine */
577 vp6_filter_hv4(dst, src+offset1, stride, stride,
578 vp6_block_copy_filter[select][y8]);
580 s->vp56dsp.vp6_filter_diag4(dst, src+offset1+((mv.x^mv.y)>>31), stride,
581 vp6_block_copy_filter[select][x8],
582 vp6_block_copy_filter[select][y8]);
586 s->h264chroma.put_h264_chroma_pixels_tab[0](dst, src + offset1, stride, 8, x8, y8);
588 vp6_filter_diag2(s, dst, src+offset1 + ((mv.x^mv.y)>>31), stride, x8, y8);
593 static av_cold void vp6_decode_init_context(VP56Context *s);
595 static av_cold int vp6_decode_init(AVCodecContext *avctx)
597 VP56Context *s = avctx->priv_data;
599 ff_vp56_init(avctx, avctx->codec->id == AV_CODEC_ID_VP6,
600 avctx->codec->id == AV_CODEC_ID_VP6A);
601 vp6_decode_init_context(s);
606 s->alpha_context = av_mallocz(sizeof(VP56Context));
607 ff_vp56_init_context(avctx, s->alpha_context,
608 s->flip == -1, s->has_alpha);
609 vp6_decode_init_context(s->alpha_context);
610 for (i = 0; i < 6; ++i)
611 s->alpha_context->framep[i] = s->framep[i];
617 static av_cold void vp6_decode_init_context(VP56Context *s)
619 s->deblock_filtering = 0;
620 s->vp56_coord_div = vp6_coord_div;
621 s->parse_vector_adjustment = vp6_parse_vector_adjustment;
622 s->filter = vp6_filter;
623 s->default_models_init = vp6_default_models_init;
624 s->parse_vector_models = vp6_parse_vector_models;
625 s->parse_coeff_models = vp6_parse_coeff_models;
626 s->parse_header = vp6_parse_header;
629 static av_cold void vp6_decode_free_context(VP56Context *s);
631 static av_cold int vp6_decode_free(AVCodecContext *avctx)
633 VP56Context *s = avctx->priv_data;
636 vp6_decode_free_context(s);
638 if (s->alpha_context) {
639 ff_vp56_free_context(s->alpha_context);
640 vp6_decode_free_context(s->alpha_context);
641 av_free(s->alpha_context);
647 static av_cold void vp6_decode_free_context(VP56Context *s)
651 for (pt=0; pt<2; pt++) {
652 ff_free_vlc(&s->dccv_vlc[pt]);
653 ff_free_vlc(&s->runv_vlc[pt]);
654 for (ct=0; ct<3; ct++)
655 for (cg=0; cg<6; cg++)
656 ff_free_vlc(&s->ract_vlc[pt][ct][cg]);
660 AVCodec ff_vp6_decoder = {
662 .type = AVMEDIA_TYPE_VIDEO,
663 .id = AV_CODEC_ID_VP6,
664 .priv_data_size = sizeof(VP56Context),
665 .init = vp6_decode_init,
666 .close = vp6_decode_free,
667 .decode = ff_vp56_decode_frame,
668 .capabilities = CODEC_CAP_DR1,
669 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6"),
672 /* flash version, not flipped upside-down */
673 AVCodec ff_vp6f_decoder = {
675 .type = AVMEDIA_TYPE_VIDEO,
676 .id = AV_CODEC_ID_VP6F,
677 .priv_data_size = sizeof(VP56Context),
678 .init = vp6_decode_init,
679 .close = vp6_decode_free,
680 .decode = ff_vp56_decode_frame,
681 .capabilities = CODEC_CAP_DR1,
682 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6 (Flash version)"),
685 /* flash version, not flipped upside-down, with alpha channel */
686 AVCodec ff_vp6a_decoder = {
688 .type = AVMEDIA_TYPE_VIDEO,
689 .id = AV_CODEC_ID_VP6A,
690 .priv_data_size = sizeof(VP56Context),
691 .init = vp6_decode_init,
692 .close = vp6_decode_free,
693 .decode = ff_vp56_decode_frame,
694 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_SLICE_THREADS,
695 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6 (Flash version, with alpha channel)"),