2 * Copyright (C) 2003-2004 the ffmpeg project
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
22 * @file libavcodec/vp3.c
23 * On2 VP3 Video Decoder
25 * VP3 Video Decoder by Mike Melanson (mike at multimedia.cx)
26 * For more information about the VP3 coding process, visit:
27 * http://wiki.multimedia.cx/index.php?title=On2_VP3
29 * Theora decoder by Alex Beregszaszi
43 #define FRAGMENT_PIXELS 8
45 static av_cold int vp3_decode_end(AVCodecContext *avctx);
47 typedef struct Coeff {
53 //FIXME split things out into their own arrays
54 typedef struct Vp3Fragment {
56 uint8_t coding_method;
62 #define SB_NOT_CODED 0
63 #define SB_PARTIALLY_CODED 1
64 #define SB_FULLY_CODED 2
66 // This is the maximum length of a single long bit run that can be encoded
67 // for superblock coding or block qps. Theora special-cases this to read a
68 // bit instead of flipping the current bit to allow for runs longer than 4129.
69 #define MAXIMUM_LONG_BIT_RUN 4129
71 #define MODE_INTER_NO_MV 0
73 #define MODE_INTER_PLUS_MV 2
74 #define MODE_INTER_LAST_MV 3
75 #define MODE_INTER_PRIOR_LAST 4
76 #define MODE_USING_GOLDEN 5
77 #define MODE_GOLDEN_MV 6
78 #define MODE_INTER_FOURMV 7
79 #define CODING_MODE_COUNT 8
81 /* special internal mode */
84 /* There are 6 preset schemes, plus a free-form scheme */
85 static const int ModeAlphabet[6][CODING_MODE_COUNT] =
87 /* scheme 1: Last motion vector dominates */
88 { MODE_INTER_LAST_MV, MODE_INTER_PRIOR_LAST,
89 MODE_INTER_PLUS_MV, MODE_INTER_NO_MV,
90 MODE_INTRA, MODE_USING_GOLDEN,
91 MODE_GOLDEN_MV, MODE_INTER_FOURMV },
94 { MODE_INTER_LAST_MV, MODE_INTER_PRIOR_LAST,
95 MODE_INTER_NO_MV, MODE_INTER_PLUS_MV,
96 MODE_INTRA, MODE_USING_GOLDEN,
97 MODE_GOLDEN_MV, MODE_INTER_FOURMV },
100 { MODE_INTER_LAST_MV, MODE_INTER_PLUS_MV,
101 MODE_INTER_PRIOR_LAST, MODE_INTER_NO_MV,
102 MODE_INTRA, MODE_USING_GOLDEN,
103 MODE_GOLDEN_MV, MODE_INTER_FOURMV },
106 { MODE_INTER_LAST_MV, MODE_INTER_PLUS_MV,
107 MODE_INTER_NO_MV, MODE_INTER_PRIOR_LAST,
108 MODE_INTRA, MODE_USING_GOLDEN,
109 MODE_GOLDEN_MV, MODE_INTER_FOURMV },
111 /* scheme 5: No motion vector dominates */
112 { MODE_INTER_NO_MV, MODE_INTER_LAST_MV,
113 MODE_INTER_PRIOR_LAST, MODE_INTER_PLUS_MV,
114 MODE_INTRA, MODE_USING_GOLDEN,
115 MODE_GOLDEN_MV, MODE_INTER_FOURMV },
118 { MODE_INTER_NO_MV, MODE_USING_GOLDEN,
119 MODE_INTER_LAST_MV, MODE_INTER_PRIOR_LAST,
120 MODE_INTER_PLUS_MV, MODE_INTRA,
121 MODE_GOLDEN_MV, MODE_INTER_FOURMV },
125 #define MIN_DEQUANT_VAL 2
127 typedef struct Vp3DecodeContext {
128 AVCodecContext *avctx;
129 int theora, theora_tables;
132 AVFrame golden_frame;
134 AVFrame current_frame;
144 int superblock_count;
145 int y_superblock_width;
146 int y_superblock_height;
147 int c_superblock_width;
148 int c_superblock_height;
149 int u_superblock_start;
150 int v_superblock_start;
151 unsigned char *superblock_coding;
153 int macroblock_count;
154 int macroblock_width;
155 int macroblock_height;
161 Vp3Fragment *all_fragments;
162 uint8_t *coeff_counts;
165 int fragment_start[3];
171 uint16_t coded_dc_scale_factor[64];
172 uint32_t coded_ac_scale_factor[64];
173 uint8_t base_matrix[384][64];
174 uint8_t qr_count[2][3];
175 uint8_t qr_size [2][3][64];
176 uint16_t qr_base[2][3][64];
178 /* this is a list of indexes into the all_fragments array indicating
179 * which of the fragments are coded */
180 int *coded_fragment_list;
181 int coded_fragment_list_index;
183 /* track which fragments have already been decoded; called 'fast'
184 * because this data structure avoids having to iterate through every
185 * fragment in coded_fragment_list; once a fragment has been fully
186 * decoded, it is removed from this list */
187 int *fast_fragment_list;
188 int fragment_list_y_head;
189 int fragment_list_c_head;
197 VLC superblock_run_length_vlc;
198 VLC fragment_run_length_vlc;
200 VLC motion_vector_vlc;
202 /* these arrays need to be on 16-byte boundaries since SSE2 operations
204 DECLARE_ALIGNED_16(int16_t, qmat)[3][2][3][64]; //<qmat[qpi][is_inter][plane]
206 /* This table contains superblock_count * 16 entries. Each set of 16
207 * numbers corresponds to the fragment indexes 0..15 of the superblock.
208 * An entry will be -1 to indicate that no entry corresponds to that
210 int *superblock_fragments;
212 /* This is an array that indicates how a particular macroblock
214 unsigned char *macroblock_coding;
216 int first_coded_y_fragment;
217 int first_coded_c_fragment;
218 int last_coded_y_fragment;
219 int last_coded_c_fragment;
221 uint8_t edge_emu_buffer[9*2048]; //FIXME dynamic alloc
222 int8_t qscale_table[2048]; //FIXME dynamic alloc (width+15)/16
229 uint16_t huffman_table[80][32][2];
231 uint8_t filter_limit_values[64];
232 DECLARE_ALIGNED_8(int, bounding_values_array)[256+2];
235 /************************************************************************
236 * VP3 specific functions
237 ************************************************************************/
240 * This function sets up all of the various blocks mappings:
241 * superblocks <-> fragments, macroblocks <-> fragments,
242 * superblocks <-> macroblocks
244 * Returns 0 is successful; returns 1 if *anything* went wrong.
246 static int init_block_mapping(Vp3DecodeContext *s)
249 signed int hilbert_walk_mb[4];
251 int current_fragment = 0;
252 int current_width = 0;
253 int current_height = 0;
256 int superblock_row_inc = 0;
257 int mapping_index = 0;
259 int current_macroblock;
262 static const signed char travel_width[16] = {
269 static const signed char travel_height[16] = {
276 hilbert_walk_mb[0] = 1;
277 hilbert_walk_mb[1] = s->macroblock_width;
278 hilbert_walk_mb[2] = 1;
279 hilbert_walk_mb[3] = -s->macroblock_width;
281 /* iterate through each superblock (all planes) and map the fragments */
282 for (i = 0; i < s->superblock_count; i++) {
283 /* time to re-assign the limits? */
286 /* start of Y superblocks */
287 right_edge = s->fragment_width;
288 bottom_edge = s->fragment_height;
291 superblock_row_inc = 3 * s->fragment_width -
292 (s->y_superblock_width * 4 - s->fragment_width);
294 /* the first operation for this variable is to advance by 1 */
295 current_fragment = -1;
297 } else if (i == s->u_superblock_start) {
299 /* start of U superblocks */
300 right_edge = s->fragment_width / 2;
301 bottom_edge = s->fragment_height / 2;
304 superblock_row_inc = 3 * (s->fragment_width / 2) -
305 (s->c_superblock_width * 4 - s->fragment_width / 2);
307 /* the first operation for this variable is to advance by 1 */
308 current_fragment = s->fragment_start[1] - 1;
310 } else if (i == s->v_superblock_start) {
312 /* start of V superblocks */
313 right_edge = s->fragment_width / 2;
314 bottom_edge = s->fragment_height / 2;
317 superblock_row_inc = 3 * (s->fragment_width / 2) -
318 (s->c_superblock_width * 4 - s->fragment_width / 2);
320 /* the first operation for this variable is to advance by 1 */
321 current_fragment = s->fragment_start[2] - 1;
325 if (current_width >= right_edge - 1) {
326 /* reset width and move to next superblock row */
330 /* fragment is now at the start of a new superblock row */
331 current_fragment += superblock_row_inc;
334 /* iterate through all 16 fragments in a superblock */
335 for (j = 0; j < 16; j++) {
336 current_fragment += travel_width[j] + right_edge * travel_height[j];
337 current_width += travel_width[j];
338 current_height += travel_height[j];
340 /* check if the fragment is in bounds */
341 if ((current_width < right_edge) &&
342 (current_height < bottom_edge)) {
343 s->superblock_fragments[mapping_index] = current_fragment;
345 s->superblock_fragments[mapping_index] = -1;
352 return 0; /* successful path out */
356 * This function wipes out all of the fragment data.
358 static void init_frame(Vp3DecodeContext *s, GetBitContext *gb)
362 /* zero out all of the fragment information */
363 s->coded_fragment_list_index = 0;
364 for (i = 0; i < s->fragment_count; i++) {
365 s->coeff_counts[i] = 0;
366 s->all_fragments[i].motion_x = 127;
367 s->all_fragments[i].motion_y = 127;
368 s->all_fragments[i].next_coeff= NULL;
369 s->all_fragments[i].qpi = 0;
371 s->coeffs[i].coeff=0;
372 s->coeffs[i].next= NULL;
377 * This function sets up the dequantization tables used for a particular
380 static void init_dequantizer(Vp3DecodeContext *s, int qpi)
382 int ac_scale_factor = s->coded_ac_scale_factor[s->qps[qpi]];
383 int dc_scale_factor = s->coded_dc_scale_factor[s->qps[qpi]];
384 int i, plane, inter, qri, bmi, bmj, qistart;
386 for(inter=0; inter<2; inter++){
387 for(plane=0; plane<3; plane++){
389 for(qri=0; qri<s->qr_count[inter][plane]; qri++){
390 sum+= s->qr_size[inter][plane][qri];
391 if(s->qps[qpi] <= sum)
394 qistart= sum - s->qr_size[inter][plane][qri];
395 bmi= s->qr_base[inter][plane][qri ];
396 bmj= s->qr_base[inter][plane][qri+1];
398 int coeff= ( 2*(sum -s->qps[qpi])*s->base_matrix[bmi][i]
399 - 2*(qistart-s->qps[qpi])*s->base_matrix[bmj][i]
400 + s->qr_size[inter][plane][qri])
401 / (2*s->qr_size[inter][plane][qri]);
403 int qmin= 8<<(inter + !i);
404 int qscale= i ? ac_scale_factor : dc_scale_factor;
406 s->qmat[qpi][inter][plane][s->dsp.idct_permutation[i]]= av_clip((qscale * coeff)/100 * 4, qmin, 4096);
408 // all DC coefficients use the same quant so as not to interfere with DC prediction
409 s->qmat[qpi][inter][plane][0] = s->qmat[0][inter][plane][0];
413 memset(s->qscale_table, (FFMAX(s->qmat[0][0][0][1], s->qmat[0][0][1][1])+8)/16, 512); //FIXME finetune
417 * This function initializes the loop filter boundary limits if the frame's
418 * quality index is different from the previous frame's.
420 * The filter_limit_values may not be larger than 127.
422 static void init_loop_filter(Vp3DecodeContext *s)
424 int *bounding_values= s->bounding_values_array+127;
429 filter_limit = s->filter_limit_values[s->qps[0]];
431 /* set up the bounding values */
432 memset(s->bounding_values_array, 0, 256 * sizeof(int));
433 for (x = 0; x < filter_limit; x++) {
434 bounding_values[-x] = -x;
435 bounding_values[x] = x;
437 for (x = value = filter_limit; x < 128 && value; x++, value--) {
438 bounding_values[ x] = value;
439 bounding_values[-x] = -value;
442 bounding_values[128] = value;
443 bounding_values[129] = bounding_values[130] = filter_limit * 0x02020202;
447 * This function unpacks all of the superblock/macroblock/fragment coding
448 * information from the bitstream.
450 static int unpack_superblocks(Vp3DecodeContext *s, GetBitContext *gb)
453 int current_superblock = 0;
455 int num_partial_superblocks = 0;
456 int first_c_fragment_seen;
459 int current_fragment;
462 memset(s->superblock_coding, SB_FULLY_CODED, s->superblock_count);
466 /* unpack the list of partially-coded superblocks */
468 while (current_superblock < s->superblock_count) {
469 current_run = get_vlc2(gb,
470 s->superblock_run_length_vlc.table, 6, 2) + 1;
471 if (current_run == 34)
472 current_run += get_bits(gb, 12);
474 if (current_superblock + current_run > s->superblock_count) {
475 av_log(s->avctx, AV_LOG_ERROR, "Invalid partially coded superblock run length\n");
479 memset(s->superblock_coding + current_superblock, bit, current_run);
481 current_superblock += current_run;
483 num_partial_superblocks += current_run;
485 if (s->theora && current_run == MAXIMUM_LONG_BIT_RUN)
491 /* unpack the list of fully coded superblocks if any of the blocks were
492 * not marked as partially coded in the previous step */
493 if (num_partial_superblocks < s->superblock_count) {
494 int superblocks_decoded = 0;
496 current_superblock = 0;
498 while (superblocks_decoded < s->superblock_count - num_partial_superblocks) {
499 current_run = get_vlc2(gb,
500 s->superblock_run_length_vlc.table, 6, 2) + 1;
501 if (current_run == 34)
502 current_run += get_bits(gb, 12);
504 for (j = 0; j < current_run; current_superblock++) {
505 if (current_superblock >= s->superblock_count) {
506 av_log(s->avctx, AV_LOG_ERROR, "Invalid fully coded superblock run length\n");
510 /* skip any superblocks already marked as partially coded */
511 if (s->superblock_coding[current_superblock] == SB_NOT_CODED) {
512 s->superblock_coding[current_superblock] = 2*bit;
516 superblocks_decoded += current_run;
518 if (s->theora && current_run == MAXIMUM_LONG_BIT_RUN)
525 /* if there were partial blocks, initialize bitstream for
526 * unpacking fragment codings */
527 if (num_partial_superblocks) {
531 /* toggle the bit because as soon as the first run length is
532 * fetched the bit will be toggled again */
537 /* figure out which fragments are coded; iterate through each
538 * superblock (all planes) */
539 s->coded_fragment_list_index = 0;
540 s->next_coeff= s->coeffs + s->fragment_count;
541 s->first_coded_y_fragment = s->first_coded_c_fragment = 0;
542 s->last_coded_y_fragment = s->last_coded_c_fragment = -1;
543 first_c_fragment_seen = 0;
544 memset(s->macroblock_coding, MODE_COPY, s->macroblock_count);
545 for (i = 0; i < s->superblock_count; i++) {
547 /* iterate through all 16 fragments in a superblock */
548 for (j = 0; j < 16; j++) {
550 /* if the fragment is in bounds, check its coding status */
551 current_fragment = s->superblock_fragments[i * 16 + j];
552 if (current_fragment >= s->fragment_count) {
553 av_log(s->avctx, AV_LOG_ERROR, " vp3:unpack_superblocks(): bad fragment number (%d >= %d)\n",
554 current_fragment, s->fragment_count);
557 if (current_fragment != -1) {
558 if (s->superblock_coding[i] == SB_NOT_CODED) {
560 /* copy all the fragments from the prior frame */
561 s->all_fragments[current_fragment].coding_method =
564 } else if (s->superblock_coding[i] == SB_PARTIALLY_CODED) {
566 /* fragment may or may not be coded; this is the case
567 * that cares about the fragment coding runs */
568 if (current_run-- == 0) {
570 current_run = get_vlc2(gb,
571 s->fragment_run_length_vlc.table, 5, 2);
575 /* default mode; actual mode will be decoded in
577 s->all_fragments[current_fragment].coding_method =
579 s->all_fragments[current_fragment].next_coeff= s->coeffs + current_fragment;
580 s->coded_fragment_list[s->coded_fragment_list_index] =
582 if ((current_fragment >= s->fragment_start[1]) &&
583 (s->last_coded_y_fragment == -1) &&
584 (!first_c_fragment_seen)) {
585 s->first_coded_c_fragment = s->coded_fragment_list_index;
586 s->last_coded_y_fragment = s->first_coded_c_fragment - 1;
587 first_c_fragment_seen = 1;
589 s->coded_fragment_list_index++;
591 /* not coded; copy this fragment from the prior frame */
592 s->all_fragments[current_fragment].coding_method =
598 /* fragments are fully coded in this superblock; actual
599 * coding will be determined in next step */
600 s->all_fragments[current_fragment].coding_method =
602 s->all_fragments[current_fragment].next_coeff= s->coeffs + current_fragment;
603 s->coded_fragment_list[s->coded_fragment_list_index] =
605 if ((current_fragment >= s->fragment_start[1]) &&
606 (s->last_coded_y_fragment == -1) &&
607 (!first_c_fragment_seen)) {
608 s->first_coded_c_fragment = s->coded_fragment_list_index;
609 s->last_coded_y_fragment = s->first_coded_c_fragment - 1;
610 first_c_fragment_seen = 1;
612 s->coded_fragment_list_index++;
618 if (!first_c_fragment_seen)
619 /* only Y fragments coded in this frame */
620 s->last_coded_y_fragment = s->coded_fragment_list_index - 1;
622 /* end the list of coded C fragments */
623 s->last_coded_c_fragment = s->coded_fragment_list_index - 1;
625 for (i = 0; i < s->fragment_count - 1; i++) {
626 s->fast_fragment_list[i] = i + 1;
628 s->fast_fragment_list[s->fragment_count - 1] = -1;
630 if (s->last_coded_y_fragment == -1)
631 s->fragment_list_y_head = -1;
633 s->fragment_list_y_head = s->first_coded_y_fragment;
634 s->fast_fragment_list[s->last_coded_y_fragment] = -1;
637 if (s->last_coded_c_fragment == -1)
638 s->fragment_list_c_head = -1;
640 s->fragment_list_c_head = s->first_coded_c_fragment;
641 s->fast_fragment_list[s->last_coded_c_fragment] = -1;
648 * This function unpacks all the coding mode data for individual macroblocks
649 * from the bitstream.
651 static int unpack_modes(Vp3DecodeContext *s, GetBitContext *gb)
653 int i, j, k, sb_x, sb_y;
655 int current_macroblock;
656 int current_fragment;
658 int custom_mode_alphabet[CODING_MODE_COUNT];
662 for (i = 0; i < s->fragment_count; i++)
663 s->all_fragments[i].coding_method = MODE_INTRA;
667 /* fetch the mode coding scheme for this frame */
668 scheme = get_bits(gb, 3);
670 /* is it a custom coding scheme? */
672 for (i = 0; i < 8; i++)
673 custom_mode_alphabet[i] = MODE_INTER_NO_MV;
674 for (i = 0; i < 8; i++)
675 custom_mode_alphabet[get_bits(gb, 3)] = i;
676 alphabet = custom_mode_alphabet;
678 alphabet = ModeAlphabet[scheme-1];
680 /* iterate through all of the macroblocks that contain 1 or more
682 for (sb_y = 0; sb_y < s->y_superblock_height; sb_y++) {
683 for (sb_x = 0; sb_x < s->y_superblock_width; sb_x++) {
685 for (j = 0; j < 4; j++) {
686 int mb_x = 2*sb_x + (j>>1);
687 int mb_y = 2*sb_y + (((j>>1)+j)&1);
689 current_macroblock = mb_y * s->macroblock_width + mb_x;
691 if (mb_x >= s->macroblock_width || mb_y >= s->macroblock_height)
694 #define BLOCK_X (2*mb_x + (k&1))
695 #define BLOCK_Y (2*mb_y + (k>>1))
696 /* coding modes are only stored if the macroblock has at least one
697 * luma block coded, otherwise it must be INTER_NO_MV */
698 for (k = 0; k < 4; k++) {
699 current_fragment = BLOCK_Y*s->fragment_width + BLOCK_X;
700 if (s->all_fragments[current_fragment].coding_method != MODE_COPY)
704 s->macroblock_coding[current_macroblock] = MODE_INTER_NO_MV;
708 /* mode 7 means get 3 bits for each coding mode */
710 coding_mode = get_bits(gb, 3);
712 coding_mode = alphabet
713 [get_vlc2(gb, s->mode_code_vlc.table, 3, 3)];
715 s->macroblock_coding[current_macroblock] = coding_mode;
716 for (k = 0; k < 4; k++) {
718 BLOCK_Y*s->fragment_width + BLOCK_X;
719 if (s->all_fragments[current_fragment].coding_method !=
721 s->all_fragments[current_fragment].coding_method =
724 for (k = 0; k < 2; k++) {
725 current_fragment = s->fragment_start[k+1] +
726 mb_y*(s->fragment_width>>1) + mb_x;
727 if (s->all_fragments[current_fragment].coding_method !=
729 s->all_fragments[current_fragment].coding_method =
741 * This function unpacks all the motion vectors for the individual
742 * macroblocks from the bitstream.
744 static int unpack_vectors(Vp3DecodeContext *s, GetBitContext *gb)
746 int j, k, sb_x, sb_y;
750 int last_motion_x = 0;
751 int last_motion_y = 0;
752 int prior_last_motion_x = 0;
753 int prior_last_motion_y = 0;
754 int current_macroblock;
755 int current_fragment;
760 memset(motion_x, 0, 6 * sizeof(int));
761 memset(motion_y, 0, 6 * sizeof(int));
763 /* coding mode 0 is the VLC scheme; 1 is the fixed code scheme */
764 coding_mode = get_bits1(gb);
766 /* iterate through all of the macroblocks that contain 1 or more
768 for (sb_y = 0; sb_y < s->y_superblock_height; sb_y++) {
769 for (sb_x = 0; sb_x < s->y_superblock_width; sb_x++) {
771 for (j = 0; j < 4; j++) {
772 int mb_x = 2*sb_x + (j>>1);
773 int mb_y = 2*sb_y + (((j>>1)+j)&1);
774 current_macroblock = mb_y * s->macroblock_width + mb_x;
776 if (mb_x >= s->macroblock_width || mb_y >= s->macroblock_height ||
777 (s->macroblock_coding[current_macroblock] == MODE_COPY))
780 switch (s->macroblock_coding[current_macroblock]) {
782 case MODE_INTER_PLUS_MV:
784 /* all 6 fragments use the same motion vector */
785 if (coding_mode == 0) {
786 motion_x[0] = motion_vector_table[get_vlc2(gb, s->motion_vector_vlc.table, 6, 2)];
787 motion_y[0] = motion_vector_table[get_vlc2(gb, s->motion_vector_vlc.table, 6, 2)];
789 motion_x[0] = fixed_motion_vector_table[get_bits(gb, 6)];
790 motion_y[0] = fixed_motion_vector_table[get_bits(gb, 6)];
793 /* vector maintenance, only on MODE_INTER_PLUS_MV */
794 if (s->macroblock_coding[current_macroblock] ==
795 MODE_INTER_PLUS_MV) {
796 prior_last_motion_x = last_motion_x;
797 prior_last_motion_y = last_motion_y;
798 last_motion_x = motion_x[0];
799 last_motion_y = motion_y[0];
803 case MODE_INTER_FOURMV:
804 /* vector maintenance */
805 prior_last_motion_x = last_motion_x;
806 prior_last_motion_y = last_motion_y;
808 /* fetch 4 vectors from the bitstream, one for each
809 * Y fragment, then average for the C fragment vectors */
810 motion_x[4] = motion_y[4] = 0;
811 for (k = 0; k < 4; k++) {
812 current_fragment = BLOCK_Y*s->fragment_width + BLOCK_X;
813 if (s->all_fragments[current_fragment].coding_method != MODE_COPY) {
814 if (coding_mode == 0) {
815 motion_x[k] = motion_vector_table[get_vlc2(gb, s->motion_vector_vlc.table, 6, 2)];
816 motion_y[k] = motion_vector_table[get_vlc2(gb, s->motion_vector_vlc.table, 6, 2)];
818 motion_x[k] = fixed_motion_vector_table[get_bits(gb, 6)];
819 motion_y[k] = fixed_motion_vector_table[get_bits(gb, 6)];
821 last_motion_x = motion_x[k];
822 last_motion_y = motion_y[k];
827 motion_x[4] += motion_x[k];
828 motion_y[4] += motion_y[k];
832 motion_x[4]= RSHIFT(motion_x[4], 2);
834 motion_y[4]= RSHIFT(motion_y[4], 2);
837 case MODE_INTER_LAST_MV:
838 /* all 6 fragments use the last motion vector */
839 motion_x[0] = last_motion_x;
840 motion_y[0] = last_motion_y;
842 /* no vector maintenance (last vector remains the
846 case MODE_INTER_PRIOR_LAST:
847 /* all 6 fragments use the motion vector prior to the
848 * last motion vector */
849 motion_x[0] = prior_last_motion_x;
850 motion_y[0] = prior_last_motion_y;
852 /* vector maintenance */
853 prior_last_motion_x = last_motion_x;
854 prior_last_motion_y = last_motion_y;
855 last_motion_x = motion_x[0];
856 last_motion_y = motion_y[0];
860 /* covers intra, inter without MV, golden without MV */
864 /* no vector maintenance */
868 /* assign the motion vectors to the correct fragments */
869 for (k = 0; k < 4; k++) {
871 BLOCK_Y*s->fragment_width + BLOCK_X;
872 if (s->macroblock_coding[current_macroblock] == MODE_INTER_FOURMV) {
873 s->all_fragments[current_fragment].motion_x = motion_x[k];
874 s->all_fragments[current_fragment].motion_y = motion_y[k];
876 s->all_fragments[current_fragment].motion_x = motion_x[0];
877 s->all_fragments[current_fragment].motion_y = motion_y[0];
880 for (k = 0; k < 2; k++) {
881 current_fragment = s->fragment_start[k+1] +
882 mb_y*(s->fragment_width>>1) + mb_x;
883 if (s->macroblock_coding[current_macroblock] == MODE_INTER_FOURMV) {
884 s->all_fragments[current_fragment].motion_x = motion_x[k+4];
885 s->all_fragments[current_fragment].motion_y = motion_y[k+4];
887 s->all_fragments[current_fragment].motion_x = motion_x[0];
888 s->all_fragments[current_fragment].motion_y = motion_y[0];
898 static int unpack_block_qpis(Vp3DecodeContext *s, GetBitContext *gb)
900 int qpi, i, j, bit, run_length, blocks_decoded, num_blocks_at_qpi;
901 int num_blocks = s->coded_fragment_list_index;
903 for (qpi = 0; qpi < s->nqps-1 && num_blocks > 0; qpi++) {
904 i = blocks_decoded = num_blocks_at_qpi = 0;
909 run_length = get_vlc2(gb, s->superblock_run_length_vlc.table, 6, 2) + 1;
910 if (run_length == 34)
911 run_length += get_bits(gb, 12);
912 blocks_decoded += run_length;
915 num_blocks_at_qpi += run_length;
917 for (j = 0; j < run_length; i++) {
918 if (i >= s->coded_fragment_list_index)
921 if (s->all_fragments[s->coded_fragment_list[i]].qpi == qpi) {
922 s->all_fragments[s->coded_fragment_list[i]].qpi += bit;
927 if (run_length == MAXIMUM_LONG_BIT_RUN)
931 } while (blocks_decoded < num_blocks);
933 num_blocks -= num_blocks_at_qpi;
940 * This function is called by unpack_dct_coeffs() to extract the VLCs from
941 * the bitstream. The VLCs encode tokens which are used to unpack DCT
942 * data. This function unpacks all the VLCs for either the Y plane or both
943 * C planes, and is called for DC coefficients or different AC coefficient
944 * levels (since different coefficient types require different VLC tables.
946 * This function returns a residual eob run. E.g, if a particular token gave
947 * instructions to EOB the next 5 fragments and there were only 2 fragments
948 * left in the current fragment range, 3 would be returned so that it could
949 * be passed into the next call to this same function.
951 static int unpack_vlcs(Vp3DecodeContext *s, GetBitContext *gb,
952 VLC *table, int coeff_index,
960 Vp3Fragment *fragment;
963 int previous_fragment;
967 /* local references to structure members to avoid repeated deferences */
968 uint8_t *perm= s->scantable.permutated;
969 int *coded_fragment_list = s->coded_fragment_list;
970 Vp3Fragment *all_fragments = s->all_fragments;
971 uint8_t *coeff_counts = s->coeff_counts;
972 VLC_TYPE (*vlc_table)[2] = table->table;
973 int *fast_fragment_list = s->fast_fragment_list;
976 next_fragment = s->fragment_list_y_head;
977 list_head = &s->fragment_list_y_head;
979 next_fragment = s->fragment_list_c_head;
980 list_head = &s->fragment_list_c_head;
984 previous_fragment = -1; /* this indicates that the previous fragment is actually the list head */
986 fragment_num = coded_fragment_list[i];
988 if (coeff_counts[fragment_num] > coeff_index) {
989 previous_fragment = i;
990 i = fast_fragment_list[i];
993 fragment = &all_fragments[fragment_num];
996 /* decode a VLC into a token */
997 token = get_vlc2(gb, vlc_table, 5, 3);
998 /* use the token to get a zero run, a coefficient, and an eob run */
1000 eob_run = eob_run_base[token];
1001 if (eob_run_get_bits[token])
1002 eob_run += get_bits(gb, eob_run_get_bits[token]);
1003 coeff = zero_run = 0;
1005 bits_to_get = coeff_get_bits[token];
1007 bits_to_get = get_bits(gb, bits_to_get);
1008 coeff = coeff_tables[token][bits_to_get];
1010 zero_run = zero_run_base[token];
1011 if (zero_run_get_bits[token])
1012 zero_run += get_bits(gb, zero_run_get_bits[token]);
1017 coeff_counts[fragment_num] += zero_run;
1018 if (coeff_counts[fragment_num] < 64){
1019 fragment->next_coeff->coeff= coeff;
1020 fragment->next_coeff->index= perm[coeff_counts[fragment_num]++]; //FIXME perm here already?
1021 fragment->next_coeff->next= s->next_coeff;
1022 s->next_coeff->next=NULL;
1023 fragment->next_coeff= s->next_coeff++;
1025 /* previous fragment is now this fragment */
1026 previous_fragment = i;
1028 coeff_counts[fragment_num] |= 128;
1030 /* remove this fragment from the list */
1031 if (previous_fragment != -1)
1032 fast_fragment_list[previous_fragment] = fast_fragment_list[i];
1034 *list_head = fast_fragment_list[i];
1035 /* previous fragment remains unchanged */
1038 i = fast_fragment_list[i];
1044 static void reverse_dc_prediction(Vp3DecodeContext *s,
1047 int fragment_height);
1049 * This function unpacks all of the DCT coefficient data from the
1052 static int unpack_dct_coeffs(Vp3DecodeContext *s, GetBitContext *gb)
1059 int residual_eob_run = 0;
1063 /* fetch the DC table indexes */
1064 dc_y_table = get_bits(gb, 4);
1065 dc_c_table = get_bits(gb, 4);
1067 /* unpack the Y plane DC coefficients */
1068 residual_eob_run = unpack_vlcs(s, gb, &s->dc_vlc[dc_y_table], 0,
1069 1, residual_eob_run);
1071 /* reverse prediction of the Y-plane DC coefficients */
1072 reverse_dc_prediction(s, 0, s->fragment_width, s->fragment_height);
1074 /* unpack the C plane DC coefficients */
1075 residual_eob_run = unpack_vlcs(s, gb, &s->dc_vlc[dc_c_table], 0,
1076 0, residual_eob_run);
1078 /* reverse prediction of the C-plane DC coefficients */
1079 if (!(s->avctx->flags & CODEC_FLAG_GRAY))
1081 reverse_dc_prediction(s, s->fragment_start[1],
1082 s->fragment_width / 2, s->fragment_height / 2);
1083 reverse_dc_prediction(s, s->fragment_start[2],
1084 s->fragment_width / 2, s->fragment_height / 2);
1087 /* fetch the AC table indexes */
1088 ac_y_table = get_bits(gb, 4);
1089 ac_c_table = get_bits(gb, 4);
1091 /* build tables of AC VLC tables */
1092 for (i = 1; i <= 5; i++) {
1093 y_tables[i] = &s->ac_vlc_1[ac_y_table];
1094 c_tables[i] = &s->ac_vlc_1[ac_c_table];
1096 for (i = 6; i <= 14; i++) {
1097 y_tables[i] = &s->ac_vlc_2[ac_y_table];
1098 c_tables[i] = &s->ac_vlc_2[ac_c_table];
1100 for (i = 15; i <= 27; i++) {
1101 y_tables[i] = &s->ac_vlc_3[ac_y_table];
1102 c_tables[i] = &s->ac_vlc_3[ac_c_table];
1104 for (i = 28; i <= 63; i++) {
1105 y_tables[i] = &s->ac_vlc_4[ac_y_table];
1106 c_tables[i] = &s->ac_vlc_4[ac_c_table];
1109 /* decode all AC coefficents */
1110 for (i = 1; i <= 63; i++) {
1111 if (s->fragment_list_y_head != -1)
1112 residual_eob_run = unpack_vlcs(s, gb, y_tables[i], i,
1113 1, residual_eob_run);
1115 if (s->fragment_list_c_head != -1)
1116 residual_eob_run = unpack_vlcs(s, gb, c_tables[i], i,
1117 0, residual_eob_run);
1124 * This function reverses the DC prediction for each coded fragment in
1125 * the frame. Much of this function is adapted directly from the original
1128 #define COMPATIBLE_FRAME(x) \
1129 (compatible_frame[s->all_fragments[x].coding_method] == current_frame_type)
1130 #define DC_COEFF(u) (s->coeffs[u].index ? 0 : s->coeffs[u].coeff) //FIXME do somethin to simplify this
1132 static void reverse_dc_prediction(Vp3DecodeContext *s,
1135 int fragment_height)
1144 int i = first_fragment;
1148 /* DC values for the left, up-left, up, and up-right fragments */
1149 int vl, vul, vu, vur;
1151 /* indexes for the left, up-left, up, and up-right fragments */
1155 * The 6 fields mean:
1156 * 0: up-left multiplier
1158 * 2: up-right multiplier
1159 * 3: left multiplier
1161 static const int predictor_transform[16][4] = {
1163 { 0, 0, 0,128}, // PL
1164 { 0, 0,128, 0}, // PUR
1165 { 0, 0, 53, 75}, // PUR|PL
1166 { 0,128, 0, 0}, // PU
1167 { 0, 64, 0, 64}, // PU|PL
1168 { 0,128, 0, 0}, // PU|PUR
1169 { 0, 0, 53, 75}, // PU|PUR|PL
1170 {128, 0, 0, 0}, // PUL
1171 { 0, 0, 0,128}, // PUL|PL
1172 { 64, 0, 64, 0}, // PUL|PUR
1173 { 0, 0, 53, 75}, // PUL|PUR|PL
1174 { 0,128, 0, 0}, // PUL|PU
1175 {-104,116, 0,116}, // PUL|PU|PL
1176 { 24, 80, 24, 0}, // PUL|PU|PUR
1177 {-104,116, 0,116} // PUL|PU|PUR|PL
1180 /* This table shows which types of blocks can use other blocks for
1181 * prediction. For example, INTRA is the only mode in this table to
1182 * have a frame number of 0. That means INTRA blocks can only predict
1183 * from other INTRA blocks. There are 2 golden frame coding types;
1184 * blocks encoding in these modes can only predict from other blocks
1185 * that were encoded with these 1 of these 2 modes. */
1186 static const unsigned char compatible_frame[9] = {
1187 1, /* MODE_INTER_NO_MV */
1189 1, /* MODE_INTER_PLUS_MV */
1190 1, /* MODE_INTER_LAST_MV */
1191 1, /* MODE_INTER_PRIOR_MV */
1192 2, /* MODE_USING_GOLDEN */
1193 2, /* MODE_GOLDEN_MV */
1194 1, /* MODE_INTER_FOUR_MV */
1197 int current_frame_type;
1199 /* there is a last DC predictor for each of the 3 frame types */
1204 vul = vu = vur = vl = 0;
1205 last_dc[0] = last_dc[1] = last_dc[2] = 0;
1207 /* for each fragment row... */
1208 for (y = 0; y < fragment_height; y++) {
1210 /* for each fragment in a row... */
1211 for (x = 0; x < fragment_width; x++, i++) {
1213 /* reverse prediction if this block was coded */
1214 if (s->all_fragments[i].coding_method != MODE_COPY) {
1216 current_frame_type =
1217 compatible_frame[s->all_fragments[i].coding_method];
1223 if(COMPATIBLE_FRAME(l))
1227 u= i-fragment_width;
1229 if(COMPATIBLE_FRAME(u))
1232 ul= i-fragment_width-1;
1234 if(COMPATIBLE_FRAME(ul))
1237 if(x + 1 < fragment_width){
1238 ur= i-fragment_width+1;
1240 if(COMPATIBLE_FRAME(ur))
1245 if (transform == 0) {
1247 /* if there were no fragments to predict from, use last
1249 predicted_dc = last_dc[current_frame_type];
1252 /* apply the appropriate predictor transform */
1254 (predictor_transform[transform][0] * vul) +
1255 (predictor_transform[transform][1] * vu) +
1256 (predictor_transform[transform][2] * vur) +
1257 (predictor_transform[transform][3] * vl);
1259 predicted_dc /= 128;
1261 /* check for outranging on the [ul u l] and
1262 * [ul u ur l] predictors */
1263 if ((transform == 15) || (transform == 13)) {
1264 if (FFABS(predicted_dc - vu) > 128)
1266 else if (FFABS(predicted_dc - vl) > 128)
1268 else if (FFABS(predicted_dc - vul) > 128)
1273 /* at long last, apply the predictor */
1274 if(s->coeffs[i].index){
1275 *s->next_coeff= s->coeffs[i];
1276 s->coeffs[i].index=0;
1277 s->coeffs[i].coeff=0;
1278 s->coeffs[i].next= s->next_coeff++;
1280 s->coeffs[i].coeff += predicted_dc;
1282 last_dc[current_frame_type] = DC_COEFF(i);
1283 if(DC_COEFF(i) && !(s->coeff_counts[i]&127)){
1284 s->coeff_counts[i]= 129;
1285 // s->all_fragments[i].next_coeff= s->next_coeff;
1286 s->coeffs[i].next= s->next_coeff;
1287 (s->next_coeff++)->next=NULL;
1294 static void apply_loop_filter(Vp3DecodeContext *s, int plane, int ystart, int yend)
1297 int *bounding_values= s->bounding_values_array+127;
1299 int width = s->fragment_width >> !!plane;
1300 int height = s->fragment_height >> !!plane;
1301 int fragment = s->fragment_start [plane] + ystart * width;
1302 int stride = s->current_frame.linesize[plane];
1303 uint8_t *plane_data = s->current_frame.data [plane];
1304 if (!s->flipped_image) stride = -stride;
1305 plane_data += s->data_offset[plane] + 8*ystart*stride;
1307 for (y = ystart; y < yend; y++) {
1309 for (x = 0; x < width; x++) {
1310 /* This code basically just deblocks on the edges of coded blocks.
1311 * However, it has to be much more complicated because of the
1312 * braindamaged deblock ordering used in VP3/Theora. Order matters
1313 * because some pixels get filtered twice. */
1314 if( s->all_fragments[fragment].coding_method != MODE_COPY )
1316 /* do not perform left edge filter for left columns frags */
1318 s->dsp.vp3_h_loop_filter(
1320 stride, bounding_values);
1323 /* do not perform top edge filter for top row fragments */
1325 s->dsp.vp3_v_loop_filter(
1327 stride, bounding_values);
1330 /* do not perform right edge filter for right column
1331 * fragments or if right fragment neighbor is also coded
1332 * in this frame (it will be filtered in next iteration) */
1333 if ((x < width - 1) &&
1334 (s->all_fragments[fragment + 1].coding_method == MODE_COPY)) {
1335 s->dsp.vp3_h_loop_filter(
1336 plane_data + 8*x + 8,
1337 stride, bounding_values);
1340 /* do not perform bottom edge filter for bottom row
1341 * fragments or if bottom fragment neighbor is also coded
1342 * in this frame (it will be filtered in the next row) */
1343 if ((y < height - 1) &&
1344 (s->all_fragments[fragment + width].coding_method == MODE_COPY)) {
1345 s->dsp.vp3_v_loop_filter(
1346 plane_data + 8*x + 8*stride,
1347 stride, bounding_values);
1353 plane_data += 8*stride;
1358 * called when all pixels up to row y are complete
1360 static void vp3_draw_horiz_band(Vp3DecodeContext *s, int y)
1365 if(s->avctx->draw_horiz_band==NULL)
1368 h= y - s->last_slice_end;
1371 if (!s->flipped_image) {
1373 h -= s->height - s->avctx->height; // account for non-mod16
1374 y = s->height - y - h;
1378 offset[0] = s->current_frame.linesize[0]*y;
1379 offset[1] = s->current_frame.linesize[1]*cy;
1380 offset[2] = s->current_frame.linesize[2]*cy;
1384 s->avctx->draw_horiz_band(s->avctx, &s->current_frame, offset, y, 3, h);
1385 s->last_slice_end= y + h;
1389 * Perform the final rendering for a particular slice of data.
1390 * The slice number ranges from 0..(macroblock_height - 1).
1392 static void render_slice(Vp3DecodeContext *s, int slice)
1395 int16_t *dequantizer;
1396 LOCAL_ALIGNED_16(DCTELEM, block, [64]);
1397 int motion_x = 0xdeadbeef, motion_y = 0xdeadbeef;
1398 int motion_halfpel_index;
1399 uint8_t *motion_source;
1402 if (slice >= s->macroblock_height)
1405 for (plane = 0; plane < 3; plane++) {
1406 uint8_t *output_plane = s->current_frame.data [plane] + s->data_offset[plane];
1407 uint8_t * last_plane = s-> last_frame.data [plane] + s->data_offset[plane];
1408 uint8_t *golden_plane = s-> golden_frame.data [plane] + s->data_offset[plane];
1409 int stride = s->current_frame.linesize[plane];
1410 int plane_width = s->width >> !!plane;
1411 int plane_height = s->height >> !!plane;
1412 int y = slice * FRAGMENT_PIXELS << !plane ;
1413 int slice_height = y + (FRAGMENT_PIXELS << !plane);
1414 int i = s->fragment_start[plane] + (y>>3)*(s->fragment_width>>!!plane);
1416 if (!s->flipped_image) stride = -stride;
1417 if (CONFIG_GRAY && plane && (s->avctx->flags & CODEC_FLAG_GRAY))
1421 if(FFABS(stride) > 2048)
1422 return; //various tables are fixed size
1424 /* for each fragment row in the slice (both of them)... */
1425 for (; y < slice_height; y += 8) {
1427 /* for each fragment in a row... */
1428 for (x = 0; x < plane_width; x += 8, i++) {
1429 int first_pixel = y*stride + x;
1431 if ((i < 0) || (i >= s->fragment_count)) {
1432 av_log(s->avctx, AV_LOG_ERROR, " vp3:render_slice(): bad fragment number (%d)\n", i);
1436 /* transform if this block was coded */
1437 if (s->all_fragments[i].coding_method != MODE_COPY) {
1439 if ((s->all_fragments[i].coding_method == MODE_USING_GOLDEN) ||
1440 (s->all_fragments[i].coding_method == MODE_GOLDEN_MV))
1441 motion_source= golden_plane;
1443 motion_source= last_plane;
1445 motion_source += first_pixel;
1446 motion_halfpel_index = 0;
1448 /* sort out the motion vector if this fragment is coded
1449 * using a motion vector method */
1450 if ((s->all_fragments[i].coding_method > MODE_INTRA) &&
1451 (s->all_fragments[i].coding_method != MODE_USING_GOLDEN)) {
1453 motion_x = s->all_fragments[i].motion_x;
1454 motion_y = s->all_fragments[i].motion_y;
1456 motion_x= (motion_x>>1) | (motion_x&1);
1457 motion_y= (motion_y>>1) | (motion_y&1);
1460 src_x= (motion_x>>1) + x;
1461 src_y= (motion_y>>1) + y;
1462 if ((motion_x == 127) || (motion_y == 127))
1463 av_log(s->avctx, AV_LOG_ERROR, " help! got invalid motion vector! (%X, %X)\n", motion_x, motion_y);
1465 motion_halfpel_index = motion_x & 0x01;
1466 motion_source += (motion_x >> 1);
1468 motion_halfpel_index |= (motion_y & 0x01) << 1;
1469 motion_source += ((motion_y >> 1) * stride);
1471 if(src_x<0 || src_y<0 || src_x + 9 >= plane_width || src_y + 9 >= plane_height){
1472 uint8_t *temp= s->edge_emu_buffer;
1473 if(stride<0) temp -= 9*stride;
1474 else temp += 9*stride;
1476 ff_emulated_edge_mc(temp, motion_source, stride, 9, 9, src_x, src_y, plane_width, plane_height);
1477 motion_source= temp;
1482 /* first, take care of copying a block from either the
1483 * previous or the golden frame */
1484 if (s->all_fragments[i].coding_method != MODE_INTRA) {
1485 /* Note, it is possible to implement all MC cases with
1486 put_no_rnd_pixels_l2 which would look more like the
1487 VP3 source but this would be slower as
1488 put_no_rnd_pixels_tab is better optimzed */
1489 if(motion_halfpel_index != 3){
1490 s->dsp.put_no_rnd_pixels_tab[1][motion_halfpel_index](
1491 output_plane + first_pixel,
1492 motion_source, stride, 8);
1494 int d= (motion_x ^ motion_y)>>31; // d is 0 if motion_x and _y have the same sign, else -1
1495 s->dsp.put_no_rnd_pixels_l2[1](
1496 output_plane + first_pixel,
1498 motion_source + stride + 1 + d,
1501 dequantizer = s->qmat[s->all_fragments[i].qpi][1][plane];
1503 dequantizer = s->qmat[s->all_fragments[i].qpi][0][plane];
1506 /* dequantize the DCT coefficients */
1507 if(s->avctx->idct_algo==FF_IDCT_VP3){
1508 Coeff *coeff= s->coeffs + i;
1509 s->dsp.clear_block(block);
1511 block[coeff->index]= coeff->coeff * dequantizer[coeff->index];
1515 Coeff *coeff= s->coeffs + i;
1516 s->dsp.clear_block(block);
1518 block[coeff->index]= (coeff->coeff * dequantizer[coeff->index] + 2)>>2;
1523 /* invert DCT and place (or add) in final output */
1525 if (s->all_fragments[i].coding_method == MODE_INTRA) {
1526 if(s->avctx->idct_algo!=FF_IDCT_VP3)
1529 output_plane + first_pixel,
1534 output_plane + first_pixel,
1540 /* copy directly from the previous frame */
1541 s->dsp.put_pixels_tab[1][0](
1542 output_plane + first_pixel,
1543 last_plane + first_pixel,
1548 // Filter the previous block row. We can't filter the current row yet
1549 // since it needs pixels from the next row
1551 apply_loop_filter(s, plane, (y>>3)-1, (y>>3));
1555 /* this looks like a good place for slice dispatch... */
1557 * if (slice == s->macroblock_height - 1)
1558 * dispatch (both last slice & 2nd-to-last slice);
1559 * else if (slice > 0)
1560 * dispatch (slice - 1);
1563 // now that we've filtered the last rows, they're safe to display
1565 vp3_draw_horiz_band(s, 16*slice);
1569 * This is the ffmpeg/libavcodec API init function.
1571 static av_cold int vp3_decode_init(AVCodecContext *avctx)
1573 Vp3DecodeContext *s = avctx->priv_data;
1574 int i, inter, plane;
1577 int y_superblock_count;
1578 int c_superblock_count;
1580 if (avctx->codec_tag == MKTAG('V','P','3','0'))
1586 s->width = FFALIGN(avctx->width, 16);
1587 s->height = FFALIGN(avctx->height, 16);
1588 avctx->pix_fmt = PIX_FMT_YUV420P;
1589 avctx->chroma_sample_location = AVCHROMA_LOC_CENTER;
1590 if(avctx->idct_algo==FF_IDCT_AUTO)
1591 avctx->idct_algo=FF_IDCT_VP3;
1592 dsputil_init(&s->dsp, avctx);
1594 ff_init_scantable(s->dsp.idct_permutation, &s->scantable, ff_zigzag_direct);
1596 /* initialize to an impossible value which will force a recalculation
1597 * in the first frame decode */
1598 for (i = 0; i < 3; i++)
1601 s->y_superblock_width = (s->width + 31) / 32;
1602 s->y_superblock_height = (s->height + 31) / 32;
1603 y_superblock_count = s->y_superblock_width * s->y_superblock_height;
1605 /* work out the dimensions for the C planes */
1606 c_width = s->width / 2;
1607 c_height = s->height / 2;
1608 s->c_superblock_width = (c_width + 31) / 32;
1609 s->c_superblock_height = (c_height + 31) / 32;
1610 c_superblock_count = s->c_superblock_width * s->c_superblock_height;
1612 s->superblock_count = y_superblock_count + (c_superblock_count * 2);
1613 s->u_superblock_start = y_superblock_count;
1614 s->v_superblock_start = s->u_superblock_start + c_superblock_count;
1615 s->superblock_coding = av_malloc(s->superblock_count);
1617 s->macroblock_width = (s->width + 15) / 16;
1618 s->macroblock_height = (s->height + 15) / 16;
1619 s->macroblock_count = s->macroblock_width * s->macroblock_height;
1621 s->fragment_width = s->width / FRAGMENT_PIXELS;
1622 s->fragment_height = s->height / FRAGMENT_PIXELS;
1624 /* fragment count covers all 8x8 blocks for all 3 planes */
1625 s->fragment_count = s->fragment_width * s->fragment_height * 3 / 2;
1626 s->fragment_start[1] = s->fragment_width * s->fragment_height;
1627 s->fragment_start[2] = s->fragment_width * s->fragment_height * 5 / 4;
1629 s->all_fragments = av_malloc(s->fragment_count * sizeof(Vp3Fragment));
1630 s->coeff_counts = av_malloc(s->fragment_count * sizeof(*s->coeff_counts));
1631 s->coeffs = av_malloc(s->fragment_count * sizeof(Coeff) * 65);
1632 s->coded_fragment_list = av_malloc(s->fragment_count * sizeof(int));
1633 s->fast_fragment_list = av_malloc(s->fragment_count * sizeof(int));
1634 if (!s->superblock_coding || !s->all_fragments || !s->coeff_counts ||
1635 !s->coeffs || !s->coded_fragment_list || !s->fast_fragment_list) {
1636 vp3_decode_end(avctx);
1640 if (!s->theora_tables)
1642 for (i = 0; i < 64; i++) {
1643 s->coded_dc_scale_factor[i] = vp31_dc_scale_factor[i];
1644 s->coded_ac_scale_factor[i] = vp31_ac_scale_factor[i];
1645 s->base_matrix[0][i] = vp31_intra_y_dequant[i];
1646 s->base_matrix[1][i] = vp31_intra_c_dequant[i];
1647 s->base_matrix[2][i] = vp31_inter_dequant[i];
1648 s->filter_limit_values[i] = vp31_filter_limit_values[i];
1651 for(inter=0; inter<2; inter++){
1652 for(plane=0; plane<3; plane++){
1653 s->qr_count[inter][plane]= 1;
1654 s->qr_size [inter][plane][0]= 63;
1655 s->qr_base [inter][plane][0]=
1656 s->qr_base [inter][plane][1]= 2*inter + (!!plane)*!inter;
1660 /* init VLC tables */
1661 for (i = 0; i < 16; i++) {
1664 init_vlc(&s->dc_vlc[i], 5, 32,
1665 &dc_bias[i][0][1], 4, 2,
1666 &dc_bias[i][0][0], 4, 2, 0);
1668 /* group 1 AC histograms */
1669 init_vlc(&s->ac_vlc_1[i], 5, 32,
1670 &ac_bias_0[i][0][1], 4, 2,
1671 &ac_bias_0[i][0][0], 4, 2, 0);
1673 /* group 2 AC histograms */
1674 init_vlc(&s->ac_vlc_2[i], 5, 32,
1675 &ac_bias_1[i][0][1], 4, 2,
1676 &ac_bias_1[i][0][0], 4, 2, 0);
1678 /* group 3 AC histograms */
1679 init_vlc(&s->ac_vlc_3[i], 5, 32,
1680 &ac_bias_2[i][0][1], 4, 2,
1681 &ac_bias_2[i][0][0], 4, 2, 0);
1683 /* group 4 AC histograms */
1684 init_vlc(&s->ac_vlc_4[i], 5, 32,
1685 &ac_bias_3[i][0][1], 4, 2,
1686 &ac_bias_3[i][0][0], 4, 2, 0);
1689 for (i = 0; i < 16; i++) {
1692 if (init_vlc(&s->dc_vlc[i], 5, 32,
1693 &s->huffman_table[i][0][1], 4, 2,
1694 &s->huffman_table[i][0][0], 4, 2, 0) < 0)
1697 /* group 1 AC histograms */
1698 if (init_vlc(&s->ac_vlc_1[i], 5, 32,
1699 &s->huffman_table[i+16][0][1], 4, 2,
1700 &s->huffman_table[i+16][0][0], 4, 2, 0) < 0)
1703 /* group 2 AC histograms */
1704 if (init_vlc(&s->ac_vlc_2[i], 5, 32,
1705 &s->huffman_table[i+16*2][0][1], 4, 2,
1706 &s->huffman_table[i+16*2][0][0], 4, 2, 0) < 0)
1709 /* group 3 AC histograms */
1710 if (init_vlc(&s->ac_vlc_3[i], 5, 32,
1711 &s->huffman_table[i+16*3][0][1], 4, 2,
1712 &s->huffman_table[i+16*3][0][0], 4, 2, 0) < 0)
1715 /* group 4 AC histograms */
1716 if (init_vlc(&s->ac_vlc_4[i], 5, 32,
1717 &s->huffman_table[i+16*4][0][1], 4, 2,
1718 &s->huffman_table[i+16*4][0][0], 4, 2, 0) < 0)
1723 init_vlc(&s->superblock_run_length_vlc, 6, 34,
1724 &superblock_run_length_vlc_table[0][1], 4, 2,
1725 &superblock_run_length_vlc_table[0][0], 4, 2, 0);
1727 init_vlc(&s->fragment_run_length_vlc, 5, 30,
1728 &fragment_run_length_vlc_table[0][1], 4, 2,
1729 &fragment_run_length_vlc_table[0][0], 4, 2, 0);
1731 init_vlc(&s->mode_code_vlc, 3, 8,
1732 &mode_code_vlc_table[0][1], 2, 1,
1733 &mode_code_vlc_table[0][0], 2, 1, 0);
1735 init_vlc(&s->motion_vector_vlc, 6, 63,
1736 &motion_vector_vlc_table[0][1], 2, 1,
1737 &motion_vector_vlc_table[0][0], 2, 1, 0);
1739 /* work out the block mapping tables */
1740 s->superblock_fragments = av_malloc(s->superblock_count * 16 * sizeof(int));
1741 s->macroblock_coding = av_malloc(s->macroblock_count + 1);
1742 if (!s->superblock_fragments || !s->macroblock_coding) {
1743 vp3_decode_end(avctx);
1746 init_block_mapping(s);
1748 for (i = 0; i < 3; i++) {
1749 s->current_frame.data[i] = NULL;
1750 s->last_frame.data[i] = NULL;
1751 s->golden_frame.data[i] = NULL;
1757 av_log(avctx, AV_LOG_FATAL, "Invalid huffman table\n");
1762 * This is the ffmpeg/libavcodec API frame decode function.
1764 static int vp3_decode_frame(AVCodecContext *avctx,
1765 void *data, int *data_size,
1768 const uint8_t *buf = avpkt->data;
1769 int buf_size = avpkt->size;
1770 Vp3DecodeContext *s = avctx->priv_data;
1772 static int counter = 0;
1775 init_get_bits(&gb, buf, buf_size * 8);
1777 if (s->theora && get_bits1(&gb))
1779 av_log(avctx, AV_LOG_ERROR, "Header packet passed to frame decoder, skipping\n");
1783 s->keyframe = !get_bits1(&gb);
1786 for (i = 0; i < 3; i++)
1787 s->last_qps[i] = s->qps[i];
1791 s->qps[s->nqps++]= get_bits(&gb, 6);
1792 } while(s->theora >= 0x030200 && s->nqps<3 && get_bits1(&gb));
1793 for (i = s->nqps; i < 3; i++)
1796 if (s->avctx->debug & FF_DEBUG_PICT_INFO)
1797 av_log(s->avctx, AV_LOG_INFO, " VP3 %sframe #%d: Q index = %d\n",
1798 s->keyframe?"key":"", counter, s->qps[0]);
1801 if (s->qps[0] != s->last_qps[0])
1802 init_loop_filter(s);
1804 for (i = 0; i < s->nqps; i++)
1805 // reinit all dequantizers if the first one changed, because
1806 // the DC of the first quantizer must be used for all matrices
1807 if (s->qps[i] != s->last_qps[i] || s->qps[0] != s->last_qps[0])
1808 init_dequantizer(s, i);
1810 if (avctx->skip_frame >= AVDISCARD_NONKEY && !s->keyframe)
1816 skip_bits(&gb, 4); /* width code */
1817 skip_bits(&gb, 4); /* height code */
1820 s->version = get_bits(&gb, 5);
1822 av_log(s->avctx, AV_LOG_DEBUG, "VP version: %d\n", s->version);
1825 if (s->version || s->theora)
1828 av_log(s->avctx, AV_LOG_ERROR, "Warning, unsupported keyframe coding type?!\n");
1829 skip_bits(&gb, 2); /* reserved? */
1832 if (s->last_frame.data[0] == s->golden_frame.data[0]) {
1833 if (s->golden_frame.data[0])
1834 avctx->release_buffer(avctx, &s->golden_frame);
1835 s->last_frame= s->golden_frame; /* ensure that we catch any access to this released frame */
1837 if (s->golden_frame.data[0])
1838 avctx->release_buffer(avctx, &s->golden_frame);
1839 if (s->last_frame.data[0])
1840 avctx->release_buffer(avctx, &s->last_frame);
1843 s->golden_frame.reference = 3;
1844 if(avctx->get_buffer(avctx, &s->golden_frame) < 0) {
1845 av_log(s->avctx, AV_LOG_ERROR, "vp3: get_buffer() failed\n");
1849 /* golden frame is also the current frame */
1850 s->current_frame= s->golden_frame;
1852 /* allocate a new current frame */
1853 s->current_frame.reference = 3;
1854 if (!s->golden_frame.data[0]) {
1855 av_log(s->avctx, AV_LOG_ERROR, "vp3: first frame not a keyframe\n");
1858 if(avctx->get_buffer(avctx, &s->current_frame) < 0) {
1859 av_log(s->avctx, AV_LOG_ERROR, "vp3: get_buffer() failed\n");
1864 s->current_frame.qscale_table= s->qscale_table; //FIXME allocate individual tables per AVFrame
1865 s->current_frame.qstride= 0;
1869 if (unpack_superblocks(s, &gb)){
1870 av_log(s->avctx, AV_LOG_ERROR, "error in unpack_superblocks\n");
1873 if (unpack_modes(s, &gb)){
1874 av_log(s->avctx, AV_LOG_ERROR, "error in unpack_modes\n");
1877 if (unpack_vectors(s, &gb)){
1878 av_log(s->avctx, AV_LOG_ERROR, "error in unpack_vectors\n");
1881 if (unpack_block_qpis(s, &gb)){
1882 av_log(s->avctx, AV_LOG_ERROR, "error in unpack_block_qpis\n");
1885 if (unpack_dct_coeffs(s, &gb)){
1886 av_log(s->avctx, AV_LOG_ERROR, "error in unpack_dct_coeffs\n");
1890 for (i = 0; i < 3; i++) {
1891 if (s->flipped_image)
1892 s->data_offset[i] = 0;
1894 s->data_offset[i] = ((s->height>>!!i)-1) * s->current_frame.linesize[i];
1897 s->last_slice_end = 0;
1898 for (i = 0; i < s->macroblock_height; i++)
1901 // filter the last row
1902 for (i = 0; i < 3; i++) {
1903 int row = (s->height >> (3+!!i)) - 1;
1904 apply_loop_filter(s, i, row, row+1);
1906 vp3_draw_horiz_band(s, s->height);
1908 *data_size=sizeof(AVFrame);
1909 *(AVFrame*)data= s->current_frame;
1911 /* release the last frame, if it is allocated and if it is not the
1913 if ((s->last_frame.data[0]) &&
1914 (s->last_frame.data[0] != s->golden_frame.data[0]))
1915 avctx->release_buffer(avctx, &s->last_frame);
1917 /* shuffle frames (last = current) */
1918 s->last_frame= s->current_frame;
1919 s->current_frame.data[0]= NULL; /* ensure that we catch any access to this released frame */
1925 * This is the ffmpeg/libavcodec API module cleanup function.
1927 static av_cold int vp3_decode_end(AVCodecContext *avctx)
1929 Vp3DecodeContext *s = avctx->priv_data;
1932 av_free(s->superblock_coding);
1933 av_free(s->all_fragments);
1934 av_free(s->coeff_counts);
1936 av_free(s->coded_fragment_list);
1937 av_free(s->fast_fragment_list);
1938 av_free(s->superblock_fragments);
1939 av_free(s->macroblock_coding);
1941 for (i = 0; i < 16; i++) {
1942 free_vlc(&s->dc_vlc[i]);
1943 free_vlc(&s->ac_vlc_1[i]);
1944 free_vlc(&s->ac_vlc_2[i]);
1945 free_vlc(&s->ac_vlc_3[i]);
1946 free_vlc(&s->ac_vlc_4[i]);
1949 free_vlc(&s->superblock_run_length_vlc);
1950 free_vlc(&s->fragment_run_length_vlc);
1951 free_vlc(&s->mode_code_vlc);
1952 free_vlc(&s->motion_vector_vlc);
1954 /* release all frames */
1955 if (s->golden_frame.data[0] && s->golden_frame.data[0] != s->last_frame.data[0])
1956 avctx->release_buffer(avctx, &s->golden_frame);
1957 if (s->last_frame.data[0])
1958 avctx->release_buffer(avctx, &s->last_frame);
1959 /* no need to release the current_frame since it will always be pointing
1960 * to the same frame as either the golden or last frame */
1965 static int read_huffman_tree(AVCodecContext *avctx, GetBitContext *gb)
1967 Vp3DecodeContext *s = avctx->priv_data;
1969 if (get_bits1(gb)) {
1971 if (s->entries >= 32) { /* overflow */
1972 av_log(avctx, AV_LOG_ERROR, "huffman tree overflow\n");
1975 token = get_bits(gb, 5);
1976 //av_log(avctx, AV_LOG_DEBUG, "hti %d hbits %x token %d entry : %d size %d\n", s->hti, s->hbits, token, s->entries, s->huff_code_size);
1977 s->huffman_table[s->hti][token][0] = s->hbits;
1978 s->huffman_table[s->hti][token][1] = s->huff_code_size;
1982 if (s->huff_code_size >= 32) {/* overflow */
1983 av_log(avctx, AV_LOG_ERROR, "huffman tree overflow\n");
1986 s->huff_code_size++;
1988 if (read_huffman_tree(avctx, gb))
1991 if (read_huffman_tree(avctx, gb))
1994 s->huff_code_size--;
1999 #if CONFIG_THEORA_DECODER
2000 static int theora_decode_header(AVCodecContext *avctx, GetBitContext *gb)
2002 Vp3DecodeContext *s = avctx->priv_data;
2003 int visible_width, visible_height, colorspace;
2005 s->theora = get_bits_long(gb, 24);
2006 av_log(avctx, AV_LOG_DEBUG, "Theora bitstream version %X\n", s->theora);
2008 /* 3.2.0 aka alpha3 has the same frame orientation as original vp3 */
2009 /* but previous versions have the image flipped relative to vp3 */
2010 if (s->theora < 0x030200)
2012 s->flipped_image = 1;
2013 av_log(avctx, AV_LOG_DEBUG, "Old (<alpha3) Theora bitstream, flipped image\n");
2016 visible_width = s->width = get_bits(gb, 16) << 4;
2017 visible_height = s->height = get_bits(gb, 16) << 4;
2019 if(avcodec_check_dimensions(avctx, s->width, s->height)){
2020 av_log(avctx, AV_LOG_ERROR, "Invalid dimensions (%dx%d)\n", s->width, s->height);
2021 s->width= s->height= 0;
2025 if (s->theora >= 0x030200) {
2026 visible_width = get_bits_long(gb, 24);
2027 visible_height = get_bits_long(gb, 24);
2029 skip_bits(gb, 8); /* offset x */
2030 skip_bits(gb, 8); /* offset y */
2033 skip_bits(gb, 32); /* fps numerator */
2034 skip_bits(gb, 32); /* fps denumerator */
2035 skip_bits(gb, 24); /* aspect numerator */
2036 skip_bits(gb, 24); /* aspect denumerator */
2038 if (s->theora < 0x030200)
2039 skip_bits(gb, 5); /* keyframe frequency force */
2040 colorspace = get_bits(gb, 8);
2041 skip_bits(gb, 24); /* bitrate */
2043 skip_bits(gb, 6); /* quality hint */
2045 if (s->theora >= 0x030200)
2047 skip_bits(gb, 5); /* keyframe frequency force */
2048 skip_bits(gb, 2); /* pixel format: 420,res,422,444 */
2049 skip_bits(gb, 3); /* reserved */
2052 // align_get_bits(gb);
2054 if ( visible_width <= s->width && visible_width > s->width-16
2055 && visible_height <= s->height && visible_height > s->height-16)
2056 avcodec_set_dimensions(avctx, visible_width, visible_height);
2058 avcodec_set_dimensions(avctx, s->width, s->height);
2060 if (colorspace == 1) {
2061 avctx->color_primaries = AVCOL_PRI_BT470M;
2062 } else if (colorspace == 2) {
2063 avctx->color_primaries = AVCOL_PRI_BT470BG;
2065 if (colorspace == 1 || colorspace == 2) {
2066 avctx->colorspace = AVCOL_SPC_BT470BG;
2067 avctx->color_trc = AVCOL_TRC_BT709;
2073 static int theora_decode_tables(AVCodecContext *avctx, GetBitContext *gb)
2075 Vp3DecodeContext *s = avctx->priv_data;
2076 int i, n, matrices, inter, plane;
2078 if (s->theora >= 0x030200) {
2079 n = get_bits(gb, 3);
2080 /* loop filter limit values table */
2081 for (i = 0; i < 64; i++) {
2082 s->filter_limit_values[i] = get_bits(gb, n);
2083 if (s->filter_limit_values[i] > 127) {
2084 av_log(avctx, AV_LOG_ERROR, "filter limit value too large (%i > 127), clamping\n", s->filter_limit_values[i]);
2085 s->filter_limit_values[i] = 127;
2090 if (s->theora >= 0x030200)
2091 n = get_bits(gb, 4) + 1;
2094 /* quality threshold table */
2095 for (i = 0; i < 64; i++)
2096 s->coded_ac_scale_factor[i] = get_bits(gb, n);
2098 if (s->theora >= 0x030200)
2099 n = get_bits(gb, 4) + 1;
2102 /* dc scale factor table */
2103 for (i = 0; i < 64; i++)
2104 s->coded_dc_scale_factor[i] = get_bits(gb, n);
2106 if (s->theora >= 0x030200)
2107 matrices = get_bits(gb, 9) + 1;
2112 av_log(avctx, AV_LOG_ERROR, "invalid number of base matrixes\n");
2116 for(n=0; n<matrices; n++){
2117 for (i = 0; i < 64; i++)
2118 s->base_matrix[n][i]= get_bits(gb, 8);
2121 for (inter = 0; inter <= 1; inter++) {
2122 for (plane = 0; plane <= 2; plane++) {
2124 if (inter || plane > 0)
2125 newqr = get_bits1(gb);
2128 if(inter && get_bits1(gb)){
2132 qtj= (3*inter + plane - 1) / 3;
2133 plj= (plane + 2) % 3;
2135 s->qr_count[inter][plane]= s->qr_count[qtj][plj];
2136 memcpy(s->qr_size[inter][plane], s->qr_size[qtj][plj], sizeof(s->qr_size[0][0]));
2137 memcpy(s->qr_base[inter][plane], s->qr_base[qtj][plj], sizeof(s->qr_base[0][0]));
2143 i= get_bits(gb, av_log2(matrices-1)+1);
2145 av_log(avctx, AV_LOG_ERROR, "invalid base matrix index\n");
2148 s->qr_base[inter][plane][qri]= i;
2151 i = get_bits(gb, av_log2(63-qi)+1) + 1;
2152 s->qr_size[inter][plane][qri++]= i;
2157 av_log(avctx, AV_LOG_ERROR, "invalid qi %d > 63\n", qi);
2160 s->qr_count[inter][plane]= qri;
2165 /* Huffman tables */
2166 for (s->hti = 0; s->hti < 80; s->hti++) {
2168 s->huff_code_size = 1;
2169 if (!get_bits1(gb)) {
2171 if(read_huffman_tree(avctx, gb))
2174 if(read_huffman_tree(avctx, gb))
2179 s->theora_tables = 1;
2184 static av_cold int theora_decode_init(AVCodecContext *avctx)
2186 Vp3DecodeContext *s = avctx->priv_data;
2189 uint8_t *header_start[3];
2195 if (!avctx->extradata_size)
2197 av_log(avctx, AV_LOG_ERROR, "Missing extradata!\n");
2201 if (ff_split_xiph_headers(avctx->extradata, avctx->extradata_size,
2202 42, header_start, header_len) < 0) {
2203 av_log(avctx, AV_LOG_ERROR, "Corrupt extradata\n");
2208 init_get_bits(&gb, header_start[i], header_len[i] * 8);
2210 ptype = get_bits(&gb, 8);
2212 if (!(ptype & 0x80))
2214 av_log(avctx, AV_LOG_ERROR, "Invalid extradata!\n");
2218 // FIXME: Check for this as well.
2219 skip_bits_long(&gb, 6*8); /* "theora" */
2224 theora_decode_header(avctx, &gb);
2227 // FIXME: is this needed? it breaks sometimes
2228 // theora_decode_comments(avctx, gb);
2231 if (theora_decode_tables(avctx, &gb))
2235 av_log(avctx, AV_LOG_ERROR, "Unknown Theora config packet: %d\n", ptype&~0x80);
2238 if(ptype != 0x81 && 8*header_len[i] != get_bits_count(&gb))
2239 av_log(avctx, AV_LOG_WARNING, "%d bits left in packet %X\n", 8*header_len[i] - get_bits_count(&gb), ptype);
2240 if (s->theora < 0x030200)
2244 return vp3_decode_init(avctx);
2247 AVCodec theora_decoder = {
2251 sizeof(Vp3DecodeContext),
2256 CODEC_CAP_DR1 | CODEC_CAP_DRAW_HORIZ_BAND,
2258 .long_name = NULL_IF_CONFIG_SMALL("Theora"),
2262 AVCodec vp3_decoder = {
2266 sizeof(Vp3DecodeContext),
2271 CODEC_CAP_DR1 | CODEC_CAP_DRAW_HORIZ_BAND,
2273 .long_name = NULL_IF_CONFIG_SMALL("On2 VP3"),