2 * Copyright (C) 2006 Aurelien Jacobs <aurel@gnuage.org>
4 * This file is part of Libav.
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.
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.
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
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
40 #define VP6_MAX_HUFF_SIZE 12
42 static void vp6_parse_coeff(VP56Context *s);
43 static void vp6_parse_coeff_huffman(VP56Context *s);
45 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->frames[VP56_FRAME_CURRENT]->key_frame = !(buf[0] & 0x80);
58 ff_vp56_init_dequant(s, (buf[0] >> 1) & 0x3F);
60 if (s->frames[VP56_FRAME_CURRENT]->key_frame) {
61 sub_version = buf[1] >> 3;
63 return AVERROR_INVALIDDATA;
64 s->filter_header = buf[1] & 0x06;
66 avpriv_report_missing_feature(s->avctx, "Interlacing");
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 if (s->avctx->extradata_size == 0 &&
88 FFALIGN(s->avctx->width, 16) == 16 * cols &&
89 FFALIGN(s->avctx->height, 16) == 16 * rows) {
90 // We assume this is properly signalled container cropping,
91 // in an F4V file. Just set the coded_width/height, don't
92 // touch the cropped ones.
93 s->avctx->coded_width = 16 * cols;
94 s->avctx->coded_height = 16 * rows;
96 avcodec_set_dimensions(s->avctx, 16 * cols, 16 * rows);
97 if (s->avctx->extradata_size == 1) {
98 s->avctx->width -= s->avctx->extradata[0] >> 4;
99 s->avctx->height -= s->avctx->extradata[0] & 0x0F;
102 res = VP56_SIZE_CHANGE;
105 ff_vp56_init_range_decoder(c, buf+6, buf_size-6);
108 parse_filter_info = s->filter_header;
111 s->sub_version = sub_version;
113 if (!s->sub_version || !s->avctx->coded_width || !s->avctx->coded_height)
114 return AVERROR_INVALIDDATA;
116 if (separated_coeff || !s->filter_header) {
117 coeff_offset = AV_RB16(buf+1) - 2;
121 ff_vp56_init_range_decoder(c, buf+1, buf_size-1);
123 *golden_frame = vp56_rac_get(c);
124 if (s->filter_header) {
125 s->deblock_filtering = vp56_rac_get(c);
126 if (s->deblock_filtering)
128 if (s->sub_version > 7)
129 parse_filter_info = vp56_rac_get(c);
133 if (parse_filter_info) {
134 if (vp56_rac_get(c)) {
136 s->sample_variance_threshold = vp56_rac_gets(c, 5) << vrt_shift;
137 s->max_vector_length = 2 << vp56_rac_gets(c, 3);
138 } else if (vp56_rac_get(c)) {
143 if (s->sub_version > 7)
144 s->filter_selection = vp56_rac_gets(c, 4);
146 s->filter_selection = 16;
149 s->use_huffman = vp56_rac_get(c);
151 s->parse_coeff = vp6_parse_coeff;
154 buf_size -= coeff_offset;
156 if (s->frames[VP56_FRAME_CURRENT]->key_frame)
157 avcodec_set_dimensions(s->avctx, 0, 0);
158 return AVERROR_INVALIDDATA;
160 if (s->use_huffman) {
161 s->parse_coeff = vp6_parse_coeff_huffman;
162 init_get_bits(&s->gb, buf, buf_size<<3);
164 ff_vp56_init_range_decoder(&s->cc, buf, buf_size);
174 static void vp6_coeff_order_table_init(VP56Context *s)
178 s->modelp->coeff_index_to_pos[0] = 0;
180 for (pos=1; pos<64; pos++)
181 if (s->modelp->coeff_reorder[pos] == i)
182 s->modelp->coeff_index_to_pos[idx++] = pos;
185 static void vp6_default_models_init(VP56Context *s)
187 VP56Model *model = s->modelp;
189 model->vector_dct[0] = 0xA2;
190 model->vector_dct[1] = 0xA4;
191 model->vector_sig[0] = 0x80;
192 model->vector_sig[1] = 0x80;
194 memcpy(model->mb_types_stats, ff_vp56_def_mb_types_stats, sizeof(model->mb_types_stats));
195 memcpy(model->vector_fdv, vp6_def_fdv_vector_model, sizeof(model->vector_fdv));
196 memcpy(model->vector_pdv, vp6_def_pdv_vector_model, sizeof(model->vector_pdv));
197 memcpy(model->coeff_runv, vp6_def_runv_coeff_model, sizeof(model->coeff_runv));
198 memcpy(model->coeff_reorder, vp6_def_coeff_reorder, sizeof(model->coeff_reorder));
200 vp6_coeff_order_table_init(s);
203 static void vp6_parse_vector_models(VP56Context *s)
205 VP56RangeCoder *c = &s->c;
206 VP56Model *model = s->modelp;
209 for (comp=0; comp<2; comp++) {
210 if (vp56_rac_get_prob(c, vp6_sig_dct_pct[comp][0]))
211 model->vector_dct[comp] = vp56_rac_gets_nn(c, 7);
212 if (vp56_rac_get_prob(c, vp6_sig_dct_pct[comp][1]))
213 model->vector_sig[comp] = vp56_rac_gets_nn(c, 7);
216 for (comp=0; comp<2; comp++)
217 for (node=0; node<7; node++)
218 if (vp56_rac_get_prob(c, vp6_pdv_pct[comp][node]))
219 model->vector_pdv[comp][node] = vp56_rac_gets_nn(c, 7);
221 for (comp=0; comp<2; comp++)
222 for (node=0; node<8; node++)
223 if (vp56_rac_get_prob(c, vp6_fdv_pct[comp][node]))
224 model->vector_fdv[comp][node] = vp56_rac_gets_nn(c, 7);
227 /* nodes must ascend by count, but with descending symbol order */
228 static int vp6_huff_cmp(const void *va, const void *vb)
230 const Node *a = va, *b = vb;
231 return (a->count - b->count)*16 + (b->sym - a->sym);
234 static int vp6_build_huff_tree(VP56Context *s, uint8_t coeff_model[],
235 const uint8_t *map, unsigned size, VLC *vlc)
237 Node nodes[2*VP6_MAX_HUFF_SIZE], *tmp = &nodes[size];
240 /* first compute probabilities from model */
242 for (i=0; i<size-1; i++) {
243 a = tmp[i].count * coeff_model[i] >> 8;
244 b = tmp[i].count * (255 - coeff_model[i]) >> 8;
245 nodes[map[2*i ]].count = a + !a;
246 nodes[map[2*i+1]].count = b + !b;
250 /* then build the huffman tree according to probabilities */
251 return ff_huff_build_tree(s->avctx, vlc, size, nodes, vp6_huff_cmp,
252 FF_HUFFMAN_FLAG_HNODE_FIRST);
255 static int vp6_parse_coeff_models(VP56Context *s)
257 VP56RangeCoder *c = &s->c;
258 VP56Model *model = s->modelp;
260 int node, cg, ctx, pos;
261 int ct; /* code type */
262 int pt; /* plane type (0 for Y, 1 for U or V) */
264 memset(def_prob, 0x80, sizeof(def_prob));
266 for (pt=0; pt<2; pt++)
267 for (node=0; node<11; node++)
268 if (vp56_rac_get_prob(c, vp6_dccv_pct[pt][node])) {
269 def_prob[node] = vp56_rac_gets_nn(c, 7);
270 model->coeff_dccv[pt][node] = def_prob[node];
271 } else if (s->frames[VP56_FRAME_CURRENT]->key_frame) {
272 model->coeff_dccv[pt][node] = def_prob[node];
275 if (vp56_rac_get(c)) {
276 for (pos=1; pos<64; pos++)
277 if (vp56_rac_get_prob(c, vp6_coeff_reorder_pct[pos]))
278 model->coeff_reorder[pos] = vp56_rac_gets(c, 4);
279 vp6_coeff_order_table_init(s);
282 for (cg=0; cg<2; cg++)
283 for (node=0; node<14; node++)
284 if (vp56_rac_get_prob(c, vp6_runv_pct[cg][node]))
285 model->coeff_runv[cg][node] = vp56_rac_gets_nn(c, 7);
287 for (ct=0; ct<3; ct++)
288 for (pt=0; pt<2; pt++)
289 for (cg=0; cg<6; cg++)
290 for (node=0; node<11; node++)
291 if (vp56_rac_get_prob(c, vp6_ract_pct[ct][pt][cg][node])) {
292 def_prob[node] = vp56_rac_gets_nn(c, 7);
293 model->coeff_ract[pt][ct][cg][node] = def_prob[node];
294 } else if (s->frames[VP56_FRAME_CURRENT]->key_frame) {
295 model->coeff_ract[pt][ct][cg][node] = def_prob[node];
298 if (s->use_huffman) {
299 for (pt=0; pt<2; pt++) {
300 if (vp6_build_huff_tree(s, model->coeff_dccv[pt],
301 vp6_huff_coeff_map, 12, &s->dccv_vlc[pt]))
303 if (vp6_build_huff_tree(s, model->coeff_runv[pt],
304 vp6_huff_run_map, 9, &s->runv_vlc[pt]))
306 for (ct=0; ct<3; ct++)
307 for (cg = 0; cg < 6; cg++)
308 if (vp6_build_huff_tree(s, model->coeff_ract[pt][ct][cg],
309 vp6_huff_coeff_map, 12,
310 &s->ract_vlc[pt][ct][cg]))
313 memset(s->nb_null, 0, sizeof(s->nb_null));
315 /* coeff_dcct is a linear combination of coeff_dccv */
316 for (pt=0; pt<2; pt++)
317 for (ctx=0; ctx<3; ctx++)
318 for (node=0; node<5; node++)
319 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);
324 static void vp6_parse_vector_adjustment(VP56Context *s, VP56mv *vect)
326 VP56RangeCoder *c = &s->c;
327 VP56Model *model = s->modelp;
330 *vect = (VP56mv) {0,0};
331 if (s->vector_candidate_pos < 2)
332 *vect = s->vector_candidate[0];
334 for (comp=0; comp<2; comp++) {
337 if (vp56_rac_get_prob(c, model->vector_dct[comp])) {
338 static const uint8_t prob_order[] = {0, 1, 2, 7, 6, 5, 4};
339 for (i=0; i<sizeof(prob_order); i++) {
340 int j = prob_order[i];
341 delta |= vp56_rac_get_prob(c, model->vector_fdv[comp][j])<<j;
344 delta |= vp56_rac_get_prob(c, model->vector_fdv[comp][3])<<3;
348 delta = vp56_rac_get_tree(c, ff_vp56_pva_tree,
349 model->vector_pdv[comp]);
352 if (delta && vp56_rac_get_prob(c, model->vector_sig[comp]))
363 * Read number of consecutive blocks with null DC or AC.
364 * This value is < 74.
366 static unsigned vp6_get_nb_null(VP56Context *s)
368 unsigned val = get_bits(&s->gb, 2);
370 val += get_bits(&s->gb, 2);
372 val = get_bits1(&s->gb) << 2;
373 val = 6+val + get_bits(&s->gb, 2+val);
378 static void vp6_parse_coeff_huffman(VP56Context *s)
380 VP56Model *model = s->modelp;
381 uint8_t *permute = s->idct_scantable;
383 int coeff, sign, coeff_idx;
385 int pt = 0; /* plane type (0 for Y, 1 for U or V) */
387 for (b=0; b<6; b++) {
388 int ct = 0; /* code type */
390 vlc_coeff = &s->dccv_vlc[pt];
392 for (coeff_idx = 0;;) {
394 if (coeff_idx<2 && s->nb_null[coeff_idx][pt]) {
395 s->nb_null[coeff_idx][pt]--;
399 if (get_bits_left(&s->gb) <= 0)
401 coeff = get_vlc2(&s->gb, vlc_coeff->table, 9, 3);
404 int pt = (coeff_idx >= 6);
405 run += get_vlc2(&s->gb, s->runv_vlc[pt].table, 9, 3);
407 run += get_bits(&s->gb, 6);
409 s->nb_null[0][pt] = vp6_get_nb_null(s);
411 } else if (coeff == 11) { /* end of block */
412 if (coeff_idx == 1) /* first AC coeff ? */
413 s->nb_null[1][pt] = vp6_get_nb_null(s);
416 int coeff2 = ff_vp56_coeff_bias[coeff];
418 coeff2 += get_bits(&s->gb, coeff <= 9 ? coeff - 4 : 11);
419 ct = 1 + (coeff2 > 1);
420 sign = get_bits1(&s->gb);
421 coeff2 = (coeff2 ^ -sign) + sign;
423 coeff2 *= s->dequant_ac;
424 idx = model->coeff_index_to_pos[coeff_idx];
425 s->block_coeff[b][permute[idx]] = coeff2;
431 cg = FFMIN(vp6_coeff_groups[coeff_idx], 3);
432 vlc_coeff = &s->ract_vlc[pt][ct][cg];
437 static void vp6_parse_coeff(VP56Context *s)
439 VP56RangeCoder *c = s->ccp;
440 VP56Model *model = s->modelp;
441 uint8_t *permute = s->idct_scantable;
442 uint8_t *model1, *model2, *model3;
443 int coeff, sign, coeff_idx;
444 int b, i, cg, idx, ctx;
445 int pt = 0; /* plane type (0 for Y, 1 for U or V) */
447 for (b=0; b<6; b++) {
448 int ct = 1; /* code type */
453 ctx = s->left_block[ff_vp56_b6to4[b]].not_null_dc
454 + s->above_blocks[s->above_block_idx[b]].not_null_dc;
455 model1 = model->coeff_dccv[pt];
456 model2 = model->coeff_dcct[pt][ctx];
460 if ((coeff_idx>1 && ct==0) || vp56_rac_get_prob(c, model2[0])) {
462 if (vp56_rac_get_prob(c, model2[2])) {
463 if (vp56_rac_get_prob(c, model2[3])) {
464 idx = vp56_rac_get_tree(c, ff_vp56_pc_tree, model1);
465 coeff = ff_vp56_coeff_bias[idx+5];
466 for (i=ff_vp56_coeff_bit_length[idx]; i>=0; i--)
467 coeff += vp56_rac_get_prob(c, ff_vp56_coeff_parse_table[idx][i]) << i;
469 if (vp56_rac_get_prob(c, model2[4]))
470 coeff = 3 + vp56_rac_get_prob(c, model1[5]);
479 sign = vp56_rac_get(c);
480 coeff = (coeff ^ -sign) + sign;
482 coeff *= s->dequant_ac;
483 idx = model->coeff_index_to_pos[coeff_idx];
484 s->block_coeff[b][permute[idx]] = coeff;
490 if (!vp56_rac_get_prob(c, model2[1]))
493 model3 = model->coeff_runv[coeff_idx >= 6];
494 run = vp56_rac_get_tree(c, vp6_pcr_tree, model3);
496 for (run=9, i=0; i<6; i++)
497 run += vp56_rac_get_prob(c, model3[i+8]) << i;
503 cg = vp6_coeff_groups[coeff_idx];
504 model1 = model2 = model->coeff_ract[pt][ct][cg];
507 s->left_block[ff_vp56_b6to4[b]].not_null_dc =
508 s->above_blocks[s->above_block_idx[b]].not_null_dc = !!s->block_coeff[b][0];
512 static int vp6_block_variance(uint8_t *src, int stride)
514 int sum = 0, square_sum = 0;
517 for (y=0; y<8; y+=2) {
518 for (x=0; x<8; x+=2) {
520 square_sum += src[x]*src[x];
524 return (16*square_sum - sum*sum) >> 8;
527 static void vp6_filter_hv4(uint8_t *dst, uint8_t *src, int stride,
528 int delta, const int16_t *weights)
532 for (y=0; y<8; y++) {
533 for (x=0; x<8; x++) {
534 dst[x] = av_clip_uint8(( src[x-delta ] * weights[0]
535 + src[x ] * weights[1]
536 + src[x+delta ] * weights[2]
537 + src[x+2*delta] * weights[3] + 64) >> 7);
544 static void vp6_filter_diag2(VP56Context *s, uint8_t *dst, uint8_t *src,
545 int stride, int h_weight, int v_weight)
547 uint8_t *tmp = s->edge_emu_buffer+16;
548 s->h264chroma.put_h264_chroma_pixels_tab[0](tmp, src, stride, 9, h_weight, 0);
549 s->h264chroma.put_h264_chroma_pixels_tab[0](dst, tmp, stride, 8, 0, v_weight);
552 static void vp6_filter(VP56Context *s, uint8_t *dst, uint8_t *src,
553 int offset1, int offset2, int stride,
554 VP56mv mv, int mask, int select, int luma)
557 int x8 = mv.x & mask;
558 int y8 = mv.y & mask;
563 filter4 = s->filter_mode;
565 if (s->max_vector_length &&
566 (FFABS(mv.x) > s->max_vector_length ||
567 FFABS(mv.y) > s->max_vector_length)) {
569 } else if (s->sample_variance_threshold
570 && (vp6_block_variance(src+offset1, stride)
571 < s->sample_variance_threshold)) {
577 if ((y8 && (offset2-offset1)*s->flip<0) || (!y8 && offset1 > offset2)) {
582 if (!y8) { /* left or right combine */
583 vp6_filter_hv4(dst, src+offset1, stride, 1,
584 vp6_block_copy_filter[select][x8]);
585 } else if (!x8) { /* above or below combine */
586 vp6_filter_hv4(dst, src+offset1, stride, stride,
587 vp6_block_copy_filter[select][y8]);
589 s->vp56dsp.vp6_filter_diag4(dst, src+offset1+((mv.x^mv.y)>>31), stride,
590 vp6_block_copy_filter[select][x8],
591 vp6_block_copy_filter[select][y8]);
595 s->h264chroma.put_h264_chroma_pixels_tab[0](dst, src + offset1, stride, 8, x8, y8);
597 vp6_filter_diag2(s, dst, src+offset1 + ((mv.x^mv.y)>>31), stride, x8, y8);
602 static av_cold int vp6_decode_init(AVCodecContext *avctx)
604 VP56Context *s = avctx->priv_data;
607 if ((ret = ff_vp56_init(avctx, avctx->codec->id == AV_CODEC_ID_VP6,
608 avctx->codec->id == AV_CODEC_ID_VP6A)) < 0)
611 s->vp56_coord_div = vp6_coord_div;
612 s->parse_vector_adjustment = vp6_parse_vector_adjustment;
613 s->filter = vp6_filter;
614 s->default_models_init = vp6_default_models_init;
615 s->parse_vector_models = vp6_parse_vector_models;
616 s->parse_coeff_models = vp6_parse_coeff_models;
617 s->parse_header = vp6_parse_header;
622 static av_cold int vp6_decode_free(AVCodecContext *avctx)
624 VP56Context *s = avctx->priv_data;
629 for (pt=0; pt<2; pt++) {
630 ff_free_vlc(&s->dccv_vlc[pt]);
631 ff_free_vlc(&s->runv_vlc[pt]);
632 for (ct=0; ct<3; ct++)
633 for (cg=0; cg<6; cg++)
634 ff_free_vlc(&s->ract_vlc[pt][ct][cg]);
639 AVCodec ff_vp6_decoder = {
641 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6"),
642 .type = AVMEDIA_TYPE_VIDEO,
643 .id = AV_CODEC_ID_VP6,
644 .priv_data_size = sizeof(VP56Context),
645 .init = vp6_decode_init,
646 .close = vp6_decode_free,
647 .decode = ff_vp56_decode_frame,
648 .capabilities = CODEC_CAP_DR1,
651 /* flash version, not flipped upside-down */
652 AVCodec ff_vp6f_decoder = {
654 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6 (Flash version)"),
655 .type = AVMEDIA_TYPE_VIDEO,
656 .id = AV_CODEC_ID_VP6F,
657 .priv_data_size = sizeof(VP56Context),
658 .init = vp6_decode_init,
659 .close = vp6_decode_free,
660 .decode = ff_vp56_decode_frame,
661 .capabilities = CODEC_CAP_DR1,
664 /* flash version, not flipped upside-down, with alpha channel */
665 AVCodec ff_vp6a_decoder = {
667 .long_name = NULL_IF_CONFIG_SMALL("On2 VP6 (Flash version, with alpha channel)"),
668 .type = AVMEDIA_TYPE_VIDEO,
669 .id = AV_CODEC_ID_VP6A,
670 .priv_data_size = sizeof(VP56Context),
671 .init = vp6_decode_init,
672 .close = vp6_decode_free,
673 .decode = ff_vp56_decode_frame,
674 .capabilities = CODEC_CAP_DR1,