use VLCs for in place of get_fragment_run_length(), get_mode_code(), and
[ffmpeg.git] / libavcodec / vp3.c
1 /*
2  * Copyright (C) 2003-2004 the ffmpeg project
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  *
18  */
19
20 /**
21  * @file vp3.c
22  * On2 VP3 Video Decoder
23  *
24  * VP3 Video Decoder by Mike Melanson (mike at multimedia.cx)
25  * For more information about the VP3 coding process, visit:
26  *   http://multimedia.cx/
27  *
28  * Theora decoder by Alex Beregszaszi
29  */
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34 #include <unistd.h>
35
36 #include "common.h"
37 #include "avcodec.h"
38 #include "dsputil.h"
39 #include "mpegvideo.h"
40
41 #include "vp3data.h"
42
43 #define FRAGMENT_PIXELS 8
44
45 /* 
46  * Debugging Variables
47  * 
48  * Define one or more of the following compile-time variables to 1 to obtain
49  * elaborate information about certain aspects of the decoding process.
50  *
51  * KEYFRAMES_ONLY: set this to 1 to only see keyframes (VP3 slideshow mode)
52  * DEBUG_VP3: high-level decoding flow
53  * DEBUG_INIT: initialization parameters
54  * DEBUG_DEQUANTIZERS: display how the dequanization tables are built
55  * DEBUG_BLOCK_CODING: unpacking the superblock/macroblock/fragment coding
56  * DEBUG_MODES: unpacking the coding modes for individual fragments
57  * DEBUG_VECTORS: display the motion vectors
58  * DEBUG_TOKEN: display exhaustive information about each DCT token
59  * DEBUG_VLC: display the VLCs as they are extracted from the stream
60  * DEBUG_DC_PRED: display the process of reversing DC prediction
61  * DEBUG_IDCT: show every detail of the IDCT process
62  */
63
64 #define KEYFRAMES_ONLY 0
65
66 #define DEBUG_VP3 0
67 #define DEBUG_INIT 0
68 #define DEBUG_DEQUANTIZERS 0
69 #define DEBUG_BLOCK_CODING 0
70 #define DEBUG_MODES 0
71 #define DEBUG_VECTORS 0
72 #define DEBUG_TOKEN 0
73 #define DEBUG_VLC 0
74 #define DEBUG_DC_PRED 0
75 #define DEBUG_IDCT 0
76
77 #if DEBUG_VP3
78 #define debug_vp3 printf
79 #else
80 static inline void debug_vp3(const char *format, ...) { }
81 #endif
82
83 #if DEBUG_INIT
84 #define debug_init printf
85 #else
86 static inline void debug_init(const char *format, ...) { }
87 #endif
88
89 #if DEBUG_DEQUANTIZERS
90 #define debug_dequantizers printf 
91 #else
92 static inline void debug_dequantizers(const char *format, ...) { } 
93 #endif
94
95 #if DEBUG_BLOCK_CODING
96 #define debug_block_coding printf 
97 #else
98 static inline void debug_block_coding(const char *format, ...) { } 
99 #endif
100
101 #if DEBUG_MODES
102 #define debug_modes printf 
103 #else
104 static inline void debug_modes(const char *format, ...) { } 
105 #endif
106
107 #if DEBUG_VECTORS
108 #define debug_vectors printf 
109 #else
110 static inline void debug_vectors(const char *format, ...) { } 
111 #endif
112
113 #if DEBUG_TOKEN 
114 #define debug_token printf 
115 #else
116 static inline void debug_token(const char *format, ...) { } 
117 #endif
118
119 #if DEBUG_VLC
120 #define debug_vlc printf 
121 #else
122 static inline void debug_vlc(const char *format, ...) { } 
123 #endif
124
125 #if DEBUG_DC_PRED
126 #define debug_dc_pred printf 
127 #else
128 static inline void debug_dc_pred(const char *format, ...) { } 
129 #endif
130
131 #if DEBUG_IDCT
132 #define debug_idct printf 
133 #else
134 static inline void debug_idct(const char *format, ...) { } 
135 #endif
136
137 typedef struct Vp3Fragment {
138     DCTELEM *coeffs;
139     int coding_method;
140     int coeff_count;
141     int last_coeff;
142     int motion_x;
143     int motion_y;
144     /* address of first pixel taking into account which plane the fragment
145      * lives on as well as the plane stride */
146     int first_pixel;
147     /* this is the macroblock that the fragment belongs to */
148     int macroblock;
149 } Vp3Fragment;
150
151 #define SB_NOT_CODED        0
152 #define SB_PARTIALLY_CODED  1
153 #define SB_FULLY_CODED      2
154
155 #define MODE_INTER_NO_MV      0
156 #define MODE_INTRA            1
157 #define MODE_INTER_PLUS_MV    2
158 #define MODE_INTER_LAST_MV    3
159 #define MODE_INTER_PRIOR_LAST 4
160 #define MODE_USING_GOLDEN     5
161 #define MODE_GOLDEN_MV        6
162 #define MODE_INTER_FOURMV     7
163 #define CODING_MODE_COUNT     8
164
165 /* special internal mode */
166 #define MODE_COPY             8
167
168 /* There are 6 preset schemes, plus a free-form scheme */
169 static int ModeAlphabet[7][CODING_MODE_COUNT] =
170 {
171     /* this is the custom scheme */
172     { 0, 0, 0, 0, 0, 0, 0, 0 },
173
174     /* scheme 1: Last motion vector dominates */
175     {    MODE_INTER_LAST_MV,    MODE_INTER_PRIOR_LAST,  
176          MODE_INTER_PLUS_MV,    MODE_INTER_NO_MV,
177          MODE_INTRA,            MODE_USING_GOLDEN,      
178          MODE_GOLDEN_MV,        MODE_INTER_FOURMV },
179
180     /* scheme 2 */
181     {    MODE_INTER_LAST_MV,    MODE_INTER_PRIOR_LAST,  
182          MODE_INTER_NO_MV,      MODE_INTER_PLUS_MV,
183          MODE_INTRA,            MODE_USING_GOLDEN,      
184          MODE_GOLDEN_MV,        MODE_INTER_FOURMV },
185
186     /* scheme 3 */
187     {    MODE_INTER_LAST_MV,    MODE_INTER_PLUS_MV,     
188          MODE_INTER_PRIOR_LAST, MODE_INTER_NO_MV,
189          MODE_INTRA,            MODE_USING_GOLDEN,      
190          MODE_GOLDEN_MV,        MODE_INTER_FOURMV },
191
192     /* scheme 4 */
193     {    MODE_INTER_LAST_MV,    MODE_INTER_PLUS_MV,     
194          MODE_INTER_NO_MV,      MODE_INTER_PRIOR_LAST,
195          MODE_INTRA,            MODE_USING_GOLDEN,      
196          MODE_GOLDEN_MV,        MODE_INTER_FOURMV },
197
198     /* scheme 5: No motion vector dominates */
199     {    MODE_INTER_NO_MV,      MODE_INTER_LAST_MV,     
200          MODE_INTER_PRIOR_LAST, MODE_INTER_PLUS_MV,
201          MODE_INTRA,            MODE_USING_GOLDEN,      
202          MODE_GOLDEN_MV,        MODE_INTER_FOURMV },
203
204     /* scheme 6 */
205     {    MODE_INTER_NO_MV,      MODE_USING_GOLDEN,      
206          MODE_INTER_LAST_MV,    MODE_INTER_PRIOR_LAST,
207          MODE_INTER_PLUS_MV,    MODE_INTRA,             
208          MODE_GOLDEN_MV,        MODE_INTER_FOURMV },
209
210 };
211
212 #define MIN_DEQUANT_VAL 2
213
214 typedef struct Vp3DecodeContext {
215     AVCodecContext *avctx;
216     int theora, theora_tables;
217     int version;
218     int width, height;
219     AVFrame golden_frame;
220     AVFrame last_frame;
221     AVFrame current_frame;
222     int keyframe;
223     DSPContext dsp;
224     int flipped_image;
225
226     int quality_index;
227     int last_quality_index;
228
229     int superblock_count;
230     int superblock_width;
231     int superblock_height;
232     int y_superblock_width;
233     int y_superblock_height;
234     int c_superblock_width;
235     int c_superblock_height;
236     int u_superblock_start;
237     int v_superblock_start;
238     unsigned char *superblock_coding;
239
240     int macroblock_count;
241     int macroblock_width;
242     int macroblock_height;
243
244     int fragment_count;
245     int fragment_width;
246     int fragment_height;
247
248     Vp3Fragment *all_fragments;
249     DCTELEM *coeffs;
250     int u_fragment_start;
251     int v_fragment_start;
252     
253     ScanTable scantable;
254     
255     /* tables */
256     uint16_t coded_dc_scale_factor[64];
257     uint32_t coded_ac_scale_factor[64];
258     uint16_t coded_intra_y_dequant[64];
259     uint16_t coded_intra_c_dequant[64];
260     uint16_t coded_inter_dequant[64];
261
262     /* this is a list of indices into the all_fragments array indicating
263      * which of the fragments are coded */
264     int *coded_fragment_list;
265     int coded_fragment_list_index;
266     int pixel_addresses_inited;
267
268     VLC dc_vlc[16];
269     VLC ac_vlc_1[16];
270     VLC ac_vlc_2[16];
271     VLC ac_vlc_3[16];
272     VLC ac_vlc_4[16];
273
274     VLC superblock_run_length_vlc;
275     VLC fragment_run_length_vlc;
276     VLC mode_code_vlc;
277     VLC motion_vector_vlc;
278
279     /* these arrays need to be on 16-byte boundaries since SSE2 operations
280      * index into them */
281     int16_t __align16 intra_y_dequant[64];
282     int16_t __align16 intra_c_dequant[64];
283     int16_t __align16 inter_dequant[64];
284
285     /* This table contains superblock_count * 16 entries. Each set of 16
286      * numbers corresponds to the fragment indices 0..15 of the superblock.
287      * An entry will be -1 to indicate that no entry corresponds to that
288      * index. */
289     int *superblock_fragments;
290
291     /* This table contains superblock_count * 4 entries. Each set of 4
292      * numbers corresponds to the macroblock indices 0..3 of the superblock.
293      * An entry will be -1 to indicate that no entry corresponds to that
294      * index. */
295     int *superblock_macroblocks;
296
297     /* This table contains macroblock_count * 6 entries. Each set of 6
298      * numbers corresponds to the fragment indices 0..5 which comprise
299      * the macroblock (4 Y fragments and 2 C fragments). */
300     int *macroblock_fragments;
301     /* This is an array that indicates how a particular macroblock 
302      * is coded. */
303     unsigned char *macroblock_coding;
304
305     int first_coded_y_fragment;
306     int first_coded_c_fragment;
307     int last_coded_y_fragment;
308     int last_coded_c_fragment;
309
310     uint8_t edge_emu_buffer[9*2048]; //FIXME dynamic alloc
311     uint8_t qscale_table[2048]; //FIXME dynamic alloc (width+15)/16
312 } Vp3DecodeContext;
313
314 static int theora_decode_comments(AVCodecContext *avctx, GetBitContext gb);
315 static int theora_decode_tables(AVCodecContext *avctx, GetBitContext gb);
316
317 /************************************************************************
318  * VP3 specific functions
319  ************************************************************************/
320
321 /*
322  * This function sets up all of the various blocks mappings:
323  * superblocks <-> fragments, macroblocks <-> fragments,
324  * superblocks <-> macroblocks
325  *
326  * Returns 0 is successful; returns 1 if *anything* went wrong.
327  */
328 static int init_block_mapping(Vp3DecodeContext *s) 
329 {
330     int i, j;
331     signed int hilbert_walk_y[16];
332     signed int hilbert_walk_c[16];
333     signed int hilbert_walk_mb[4];
334
335     int current_fragment = 0;
336     int current_width = 0;
337     int current_height = 0;
338     int right_edge = 0;
339     int bottom_edge = 0;
340     int superblock_row_inc = 0;
341     int *hilbert = NULL;
342     int mapping_index = 0;
343
344     int current_macroblock;
345     int c_fragment;
346
347     signed char travel_width[16] = {
348          1,  1,  0, -1, 
349          0,  0,  1,  0,
350          1,  0,  1,  0,
351          0, -1,  0,  1
352     };
353
354     signed char travel_height[16] = {
355          0,  0,  1,  0,
356          1,  1,  0, -1,
357          0,  1,  0, -1,
358         -1,  0, -1,  0
359     };
360
361     signed char travel_width_mb[4] = {
362          1,  0,  1,  0
363     };
364
365     signed char travel_height_mb[4] = {
366          0,  1,  0, -1
367     };
368
369     debug_vp3("  vp3: initialize block mapping tables\n");
370
371     /* figure out hilbert pattern per these frame dimensions */
372     hilbert_walk_y[0]  = 1;
373     hilbert_walk_y[1]  = 1;
374     hilbert_walk_y[2]  = s->fragment_width;
375     hilbert_walk_y[3]  = -1;
376     hilbert_walk_y[4]  = s->fragment_width;
377     hilbert_walk_y[5]  = s->fragment_width;
378     hilbert_walk_y[6]  = 1;
379     hilbert_walk_y[7]  = -s->fragment_width;
380     hilbert_walk_y[8]  = 1;
381     hilbert_walk_y[9]  = s->fragment_width;
382     hilbert_walk_y[10]  = 1;
383     hilbert_walk_y[11] = -s->fragment_width;
384     hilbert_walk_y[12] = -s->fragment_width;
385     hilbert_walk_y[13] = -1;
386     hilbert_walk_y[14] = -s->fragment_width;
387     hilbert_walk_y[15] = 1;
388
389     hilbert_walk_c[0]  = 1;
390     hilbert_walk_c[1]  = 1;
391     hilbert_walk_c[2]  = s->fragment_width / 2;
392     hilbert_walk_c[3]  = -1;
393     hilbert_walk_c[4]  = s->fragment_width / 2;
394     hilbert_walk_c[5]  = s->fragment_width / 2;
395     hilbert_walk_c[6]  = 1;
396     hilbert_walk_c[7]  = -s->fragment_width / 2;
397     hilbert_walk_c[8]  = 1;
398     hilbert_walk_c[9]  = s->fragment_width / 2;
399     hilbert_walk_c[10]  = 1;
400     hilbert_walk_c[11] = -s->fragment_width / 2;
401     hilbert_walk_c[12] = -s->fragment_width / 2;
402     hilbert_walk_c[13] = -1;
403     hilbert_walk_c[14] = -s->fragment_width / 2;
404     hilbert_walk_c[15] = 1;
405
406     hilbert_walk_mb[0] = 1;
407     hilbert_walk_mb[1] = s->macroblock_width;
408     hilbert_walk_mb[2] = 1;
409     hilbert_walk_mb[3] = -s->macroblock_width;
410
411     /* iterate through each superblock (all planes) and map the fragments */
412     for (i = 0; i < s->superblock_count; i++) {
413         debug_init("    superblock %d (u starts @ %d, v starts @ %d)\n",
414             i, s->u_superblock_start, s->v_superblock_start);
415
416         /* time to re-assign the limits? */
417         if (i == 0) {
418
419             /* start of Y superblocks */
420             right_edge = s->fragment_width;
421             bottom_edge = s->fragment_height;
422             current_width = -1;
423             current_height = 0;
424             superblock_row_inc = 3 * s->fragment_width - 
425                 (s->y_superblock_width * 4 - s->fragment_width);
426             hilbert = hilbert_walk_y;
427
428             /* the first operation for this variable is to advance by 1 */
429             current_fragment = -1;
430
431         } else if (i == s->u_superblock_start) {
432
433             /* start of U superblocks */
434             right_edge = s->fragment_width / 2;
435             bottom_edge = s->fragment_height / 2;
436             current_width = -1;
437             current_height = 0;
438             superblock_row_inc = 3 * (s->fragment_width / 2) - 
439                 (s->c_superblock_width * 4 - s->fragment_width / 2);
440             hilbert = hilbert_walk_c;
441
442             /* the first operation for this variable is to advance by 1 */
443             current_fragment = s->u_fragment_start - 1;
444
445         } else if (i == s->v_superblock_start) {
446
447             /* start of V superblocks */
448             right_edge = s->fragment_width / 2;
449             bottom_edge = s->fragment_height / 2;
450             current_width = -1;
451             current_height = 0;
452             superblock_row_inc = 3 * (s->fragment_width / 2) - 
453                 (s->c_superblock_width * 4 - s->fragment_width / 2);
454             hilbert = hilbert_walk_c;
455
456             /* the first operation for this variable is to advance by 1 */
457             current_fragment = s->v_fragment_start - 1;
458
459         }
460
461         if (current_width >= right_edge - 1) {
462             /* reset width and move to next superblock row */
463             current_width = -1;
464             current_height += 4;
465
466             /* fragment is now at the start of a new superblock row */
467             current_fragment += superblock_row_inc;
468         }
469
470         /* iterate through all 16 fragments in a superblock */
471         for (j = 0; j < 16; j++) {
472             current_fragment += hilbert[j];
473             current_width += travel_width[j];
474             current_height += travel_height[j];
475
476             /* check if the fragment is in bounds */
477             if ((current_width < right_edge) &&
478                 (current_height < bottom_edge)) {
479                 s->superblock_fragments[mapping_index] = current_fragment;
480                 debug_init("    mapping fragment %d to superblock %d, position %d (%d/%d x %d/%d)\n", 
481                     s->superblock_fragments[mapping_index], i, j,
482                     current_width, right_edge, current_height, bottom_edge);
483             } else {
484                 s->superblock_fragments[mapping_index] = -1;
485                 debug_init("    superblock %d, position %d has no fragment (%d/%d x %d/%d)\n", 
486                     i, j,
487                     current_width, right_edge, current_height, bottom_edge);
488             }
489
490             mapping_index++;
491         }
492     }
493
494     /* initialize the superblock <-> macroblock mapping; iterate through
495      * all of the Y plane superblocks to build this mapping */
496     right_edge = s->macroblock_width;
497     bottom_edge = s->macroblock_height;
498     current_width = -1;
499     current_height = 0;
500     superblock_row_inc = s->macroblock_width -
501         (s->y_superblock_width * 2 - s->macroblock_width);;
502     hilbert = hilbert_walk_mb;
503     mapping_index = 0;
504     current_macroblock = -1;
505     for (i = 0; i < s->u_superblock_start; i++) {
506
507         if (current_width >= right_edge - 1) {
508             /* reset width and move to next superblock row */
509             current_width = -1;
510             current_height += 2;
511
512             /* macroblock is now at the start of a new superblock row */
513             current_macroblock += superblock_row_inc;
514         }
515
516         /* iterate through each potential macroblock in the superblock */
517         for (j = 0; j < 4; j++) {
518             current_macroblock += hilbert_walk_mb[j];
519             current_width += travel_width_mb[j];
520             current_height += travel_height_mb[j];
521
522             /* check if the macroblock is in bounds */
523             if ((current_width < right_edge) &&
524                 (current_height < bottom_edge)) {
525                 s->superblock_macroblocks[mapping_index] = current_macroblock;
526                 debug_init("    mapping macroblock %d to superblock %d, position %d (%d/%d x %d/%d)\n",
527                     s->superblock_macroblocks[mapping_index], i, j,
528                     current_width, right_edge, current_height, bottom_edge);
529             } else {
530                 s->superblock_macroblocks[mapping_index] = -1;
531                 debug_init("    superblock %d, position %d has no macroblock (%d/%d x %d/%d)\n",
532                     i, j,
533                     current_width, right_edge, current_height, bottom_edge);
534             }
535
536             mapping_index++;
537         }
538     }
539
540     /* initialize the macroblock <-> fragment mapping */
541     current_fragment = 0;
542     current_macroblock = 0;
543     mapping_index = 0;
544     for (i = 0; i < s->fragment_height; i += 2) {
545
546         for (j = 0; j < s->fragment_width; j += 2) {
547
548             debug_init("    macroblock %d contains fragments: ", current_macroblock);
549             s->all_fragments[current_fragment].macroblock = current_macroblock;
550             s->macroblock_fragments[mapping_index++] = current_fragment;
551             debug_init("%d ", current_fragment);
552
553             if (j + 1 < s->fragment_width) {
554                 s->all_fragments[current_fragment + 1].macroblock = current_macroblock;
555                 s->macroblock_fragments[mapping_index++] = current_fragment + 1;
556                 debug_init("%d ", current_fragment + 1);
557             } else
558                 s->macroblock_fragments[mapping_index++] = -1;
559
560             if (i + 1 < s->fragment_height) {
561                 s->all_fragments[current_fragment + s->fragment_width].macroblock = 
562                     current_macroblock;
563                 s->macroblock_fragments[mapping_index++] = 
564                     current_fragment + s->fragment_width;
565                 debug_init("%d ", current_fragment + s->fragment_width);
566             } else
567                 s->macroblock_fragments[mapping_index++] = -1;
568
569             if ((j + 1 < s->fragment_width) && (i + 1 < s->fragment_height)) {
570                 s->all_fragments[current_fragment + s->fragment_width + 1].macroblock = 
571                     current_macroblock;
572                 s->macroblock_fragments[mapping_index++] = 
573                     current_fragment + s->fragment_width + 1;
574                 debug_init("%d ", current_fragment + s->fragment_width + 1);
575             } else
576                 s->macroblock_fragments[mapping_index++] = -1;
577
578             /* C planes */
579             c_fragment = s->u_fragment_start + 
580                 (i * s->fragment_width / 4) + (j / 2);
581             s->all_fragments[c_fragment].macroblock = s->macroblock_count;
582             s->macroblock_fragments[mapping_index++] = c_fragment;
583             debug_init("%d ", c_fragment);
584
585             c_fragment = s->v_fragment_start + 
586                 (i * s->fragment_width / 4) + (j / 2);
587             s->all_fragments[c_fragment].macroblock = s->macroblock_count;
588             s->macroblock_fragments[mapping_index++] = c_fragment;
589             debug_init("%d ", c_fragment);
590
591             debug_init("\n");
592
593             if (j + 2 <= s->fragment_width)
594                 current_fragment += 2;
595             else 
596                 current_fragment++;
597             current_macroblock++;
598         }
599
600         current_fragment += s->fragment_width;
601     }
602
603     return 0;  /* successful path out */
604 }
605
606 /*
607  * This function unpacks a single token (which should be in the range 0..31)
608  * and returns a zero run (number of zero coefficients in current DCT matrix
609  * before next non-zero coefficient), the next DCT coefficient, and the
610  * number of consecutive, non-EOB'd DCT blocks to EOB.
611  */
612 static void unpack_token(GetBitContext *gb, int token, int *zero_run,
613                          DCTELEM *coeff, int *eob_run) 
614 {
615     int sign;
616
617     *zero_run = 0;
618     *eob_run = 0;
619     *coeff = 0;
620
621     debug_token("    vp3 token %d: ", token);
622     switch (token) {
623
624     case 0:
625         debug_token("DCT_EOB_TOKEN, EOB next block\n");
626         *eob_run = 1;
627         break;
628
629     case 1:
630         debug_token("DCT_EOB_PAIR_TOKEN, EOB next 2 blocks\n");
631         *eob_run = 2;
632         break;
633
634     case 2:
635         debug_token("DCT_EOB_TRIPLE_TOKEN, EOB next 3 blocks\n");
636         *eob_run = 3;
637         break;
638
639     case 3:
640         debug_token("DCT_REPEAT_RUN_TOKEN, ");
641         *eob_run = get_bits(gb, 2) + 4;
642         debug_token("EOB the next %d blocks\n", *eob_run);
643         break;
644
645     case 4:
646         debug_token("DCT_REPEAT_RUN2_TOKEN, ");
647         *eob_run = get_bits(gb, 3) + 8;
648         debug_token("EOB the next %d blocks\n", *eob_run);
649         break;
650
651     case 5:
652         debug_token("DCT_REPEAT_RUN3_TOKEN, ");
653         *eob_run = get_bits(gb, 4) + 16;
654         debug_token("EOB the next %d blocks\n", *eob_run);
655         break;
656
657     case 6:
658         debug_token("DCT_REPEAT_RUN4_TOKEN, ");
659         *eob_run = get_bits(gb, 12);
660         debug_token("EOB the next %d blocks\n", *eob_run);
661         break;
662
663     case 7:
664         debug_token("DCT_SHORT_ZRL_TOKEN, ");
665         /* note that this token actually indicates that (3 extra bits) + 1 0s
666          * should be output; this case specifies a run of (3 EBs) 0s and a
667          * coefficient of 0. */
668         *zero_run = get_bits(gb, 3);
669         *coeff = 0;
670         debug_token("skip the next %d positions in output matrix\n", *zero_run + 1);
671         break;
672
673     case 8:
674         debug_token("DCT_ZRL_TOKEN, ");
675         /* note that this token actually indicates that (6 extra bits) + 1 0s
676          * should be output; this case specifies a run of (6 EBs) 0s and a
677          * coefficient of 0. */
678         *zero_run = get_bits(gb, 6);
679         *coeff = 0;
680         debug_token("skip the next %d positions in output matrix\n", *zero_run + 1);
681         break;
682
683     case 9:
684         debug_token("ONE_TOKEN, output 1\n");
685         *coeff = 1;
686         break;
687
688     case 10:
689         debug_token("MINUS_ONE_TOKEN, output -1\n");
690         *coeff = -1;
691         break;
692
693     case 11:
694         debug_token("TWO_TOKEN, output 2\n");
695         *coeff = 2;
696         break;
697
698     case 12:
699         debug_token("MINUS_TWO_TOKEN, output -2\n");
700         *coeff = -2;
701         break;
702
703     case 13:
704     case 14:
705     case 15:
706     case 16:
707         debug_token("LOW_VAL_TOKENS, ");
708         if (get_bits(gb, 1))
709             *coeff = -(3 + (token - 13));
710         else
711             *coeff = 3 + (token - 13);
712         debug_token("output %d\n", *coeff);
713         break;
714
715     case 17:
716         debug_token("DCT_VAL_CATEGORY3, ");
717         sign = get_bits(gb, 1);
718         *coeff = 7 + get_bits(gb, 1);
719         if (sign)
720             *coeff = -(*coeff);
721         debug_token("output %d\n", *coeff);
722         break;
723
724     case 18:
725         debug_token("DCT_VAL_CATEGORY4, ");
726         sign = get_bits(gb, 1);
727         *coeff = 9 + get_bits(gb, 2);
728         if (sign)
729             *coeff = -(*coeff);
730         debug_token("output %d\n", *coeff);
731         break;
732
733     case 19:
734         debug_token("DCT_VAL_CATEGORY5, ");
735         sign = get_bits(gb, 1);
736         *coeff = 13 + get_bits(gb, 3);
737         if (sign)
738             *coeff = -(*coeff);
739         debug_token("output %d\n", *coeff);
740         break;
741
742     case 20:
743         debug_token("DCT_VAL_CATEGORY6, ");
744         sign = get_bits(gb, 1);
745         *coeff = 21 + get_bits(gb, 4);
746         if (sign)
747             *coeff = -(*coeff);
748         debug_token("output %d\n", *coeff);
749         break;
750
751     case 21:
752         debug_token("DCT_VAL_CATEGORY7, ");
753         sign = get_bits(gb, 1);
754         *coeff = 37 + get_bits(gb, 5);
755         if (sign)
756             *coeff = -(*coeff);
757         debug_token("output %d\n", *coeff);
758         break;
759
760     case 22:
761         debug_token("DCT_VAL_CATEGORY8, ");
762         sign = get_bits(gb, 1);
763         *coeff = 69 + get_bits(gb, 9);
764         if (sign)
765             *coeff = -(*coeff);
766         debug_token("output %d\n", *coeff);
767         break;
768
769     case 23:
770     case 24:
771     case 25:
772     case 26:
773     case 27:
774         debug_token("DCT_RUN_CATEGORY1, ");
775         *zero_run = token - 22;
776         if (get_bits(gb, 1))
777             *coeff = -1;
778         else
779             *coeff = 1;
780         debug_token("output %d 0s, then %d\n", *zero_run, *coeff);
781         break;
782
783     case 28:
784         debug_token("DCT_RUN_CATEGORY1B, ");
785         if (get_bits(gb, 1))
786             *coeff = -1;
787         else
788             *coeff = 1;
789         *zero_run = 6 + get_bits(gb, 2);
790         debug_token("output %d 0s, then %d\n", *zero_run, *coeff);
791         break;
792
793     case 29:
794         debug_token("DCT_RUN_CATEGORY1C, ");
795         if (get_bits(gb, 1))
796             *coeff = -1;
797         else
798             *coeff = 1;
799         *zero_run = 10 + get_bits(gb, 3);
800         debug_token("output %d 0s, then %d\n", *zero_run, *coeff);
801         break;
802
803     case 30:
804         debug_token("DCT_RUN_CATEGORY2, ");
805         sign = get_bits(gb, 1);
806         *coeff = 2 + get_bits(gb, 1);
807         if (sign)
808             *coeff = -(*coeff);
809         *zero_run = 1;
810         debug_token("output %d 0s, then %d\n", *zero_run, *coeff);
811         break;
812
813     case 31:
814         debug_token("DCT_RUN_CATEGORY2, ");
815         sign = get_bits(gb, 1);
816         *coeff = 2 + get_bits(gb, 1);
817         if (sign)
818             *coeff = -(*coeff);
819         *zero_run = 2 + get_bits(gb, 1);
820         debug_token("output %d 0s, then %d\n", *zero_run, *coeff);
821         break;
822
823     default:
824         av_log(NULL, AV_LOG_ERROR, "  vp3: help! Got a bad token: %d > 31\n", token);
825         break;
826
827   }
828 }
829
830 /*
831  * This function wipes out all of the fragment data.
832  */
833 static void init_frame(Vp3DecodeContext *s, GetBitContext *gb)
834 {
835     int i;
836     static const DCTELEM zero_block[64];
837
838     /* zero out all of the fragment information */
839     s->coded_fragment_list_index = 0;
840     for (i = 0; i < s->fragment_count; i++) {
841         s->all_fragments[i].coeffs = zero_block;
842         s->all_fragments[i].coeff_count = 0;
843         s->all_fragments[i].last_coeff = -1;
844 s->all_fragments[i].motion_x = 0xbeef;
845 s->all_fragments[i].motion_y = 0xbeef;
846     }
847 }
848
849 /*
850  * This function sets of the dequantization tables used for a particular
851  * frame.
852  */
853 static void init_dequantizer(Vp3DecodeContext *s)
854 {
855
856     int ac_scale_factor = s->coded_ac_scale_factor[s->quality_index];
857     int dc_scale_factor = s->coded_dc_scale_factor[s->quality_index];
858     int i, j;
859
860     debug_vp3("  vp3: initializing dequantization tables\n");
861
862     /* 
863      * Scale dequantizers:
864      *
865      *   quantizer * sf
866      *   --------------
867      *        100
868      *
869      * where sf = dc_scale_factor for DC quantizer
870      *         or ac_scale_factor for AC quantizer
871      *
872      * Then, saturate the result to a lower limit of MIN_DEQUANT_VAL.
873      */
874 #define SCALER 4
875
876     /* scale DC quantizers */
877     s->intra_y_dequant[0] = s->coded_intra_y_dequant[0] * dc_scale_factor / 100;
878     if (s->intra_y_dequant[0] < MIN_DEQUANT_VAL * 2)
879         s->intra_y_dequant[0] = MIN_DEQUANT_VAL * 2;
880     s->intra_y_dequant[0] *= SCALER;
881
882     s->intra_c_dequant[0] = s->coded_intra_c_dequant[0] * dc_scale_factor / 100;
883     if (s->intra_c_dequant[0] < MIN_DEQUANT_VAL * 2)
884         s->intra_c_dequant[0] = MIN_DEQUANT_VAL * 2;
885     s->intra_c_dequant[0] *= SCALER;
886
887     s->inter_dequant[0] = s->coded_inter_dequant[0] * dc_scale_factor / 100;
888     if (s->inter_dequant[0] < MIN_DEQUANT_VAL * 4)
889         s->inter_dequant[0] = MIN_DEQUANT_VAL * 4;
890     s->inter_dequant[0] *= SCALER;
891
892     /* scale AC quantizers, zigzag at the same time in preparation for
893      * the dequantization phase */
894     for (i = 1; i < 64; i++) {
895         int k= s->scantable.scantable[i];
896         j = s->scantable.permutated[i];
897
898         s->intra_y_dequant[j] = s->coded_intra_y_dequant[k] * ac_scale_factor / 100;
899         if (s->intra_y_dequant[j] < MIN_DEQUANT_VAL)
900             s->intra_y_dequant[j] = MIN_DEQUANT_VAL;
901         s->intra_y_dequant[j] *= SCALER;
902
903         s->intra_c_dequant[j] = s->coded_intra_c_dequant[k] * ac_scale_factor / 100;
904         if (s->intra_c_dequant[j] < MIN_DEQUANT_VAL)
905             s->intra_c_dequant[j] = MIN_DEQUANT_VAL;
906         s->intra_c_dequant[j] *= SCALER;
907
908         s->inter_dequant[j] = s->coded_inter_dequant[k] * ac_scale_factor / 100;
909         if (s->inter_dequant[j] < MIN_DEQUANT_VAL * 2)
910             s->inter_dequant[j] = MIN_DEQUANT_VAL * 2;
911         s->inter_dequant[j] *= SCALER;
912     }
913     
914     memset(s->qscale_table, (FFMAX(s->intra_y_dequant[1], s->intra_c_dequant[1])+8)/16, 512); //FIXME finetune
915
916     /* print debug information as requested */
917     debug_dequantizers("intra Y dequantizers:\n");
918     for (i = 0; i < 8; i++) {
919       for (j = i * 8; j < i * 8 + 8; j++) {
920         debug_dequantizers(" %4d,", s->intra_y_dequant[j]);
921       }
922       debug_dequantizers("\n");
923     }
924     debug_dequantizers("\n");
925
926     debug_dequantizers("intra C dequantizers:\n");
927     for (i = 0; i < 8; i++) {
928       for (j = i * 8; j < i * 8 + 8; j++) {
929         debug_dequantizers(" %4d,", s->intra_c_dequant[j]);
930       }
931       debug_dequantizers("\n");
932     }
933     debug_dequantizers("\n");
934
935     debug_dequantizers("interframe dequantizers:\n");
936     for (i = 0; i < 8; i++) {
937       for (j = i * 8; j < i * 8 + 8; j++) {
938         debug_dequantizers(" %4d,", s->inter_dequant[j]);
939       }
940       debug_dequantizers("\n");
941     }
942     debug_dequantizers("\n");
943 }
944
945 /*
946  * This function is used to fetch runs of 1s or 0s from the bitstream for
947  * use in determining which superblocks are fully and partially coded.
948  *
949  *  Codeword                RunLength
950  *  0                       1
951  *  10x                     2-3
952  *  110x                    4-5
953  *  1110xx                  6-9
954  *  11110xxx                10-17
955  *  111110xxxx              18-33
956  *  111111xxxxxxxxxxxx      34-4129
957  */
958 static int get_superblock_run_length(GetBitContext *gb)
959 {
960
961     if (get_bits(gb, 1) == 0)
962         return 1;
963
964     else if (get_bits(gb, 1) == 0)
965         return (2 + get_bits(gb, 1));
966
967     else if (get_bits(gb, 1) == 0)
968         return (4 + get_bits(gb, 1));
969
970     else if (get_bits(gb, 1) == 0)
971         return (6 + get_bits(gb, 2));
972
973     else if (get_bits(gb, 1) == 0)
974         return (10 + get_bits(gb, 3));
975
976     else if (get_bits(gb, 1) == 0)
977         return (18 + get_bits(gb, 4));
978
979     else
980         return (34 + get_bits(gb, 12));
981
982 }
983
984 /*
985  * This function is used to fetch runs of 1s or 0s from the bitstream for
986  * use in determining which particular fragments are coded.
987  *
988  * Codeword                RunLength
989  * 0x                      1-2
990  * 10x                     3-4
991  * 110x                    5-6
992  * 1110xx                  7-10
993  * 11110xx                 11-14
994  * 11111xxxx               15-30
995  */
996 static int get_fragment_run_length(GetBitContext *gb)
997 {
998
999     if (get_bits(gb, 1) == 0)
1000         return (1 + get_bits(gb, 1));
1001
1002     else if (get_bits(gb, 1) == 0)
1003         return (3 + get_bits(gb, 1));
1004
1005     else if (get_bits(gb, 1) == 0)
1006         return (5 + get_bits(gb, 1));
1007
1008     else if (get_bits(gb, 1) == 0)
1009         return (7 + get_bits(gb, 2));
1010
1011     else if (get_bits(gb, 1) == 0)
1012         return (11 + get_bits(gb, 2));
1013
1014     else
1015         return (15 + get_bits(gb, 4));
1016
1017 }
1018
1019 /*
1020  * This function decodes a VLC from the bitstream and returns a number
1021  * that ranges from 0..7. The number indicates which of the 8 coding
1022  * modes to use.
1023  *
1024  *  VLC       Number
1025  *  0            0
1026  *  10           1
1027  *  110          2
1028  *  1110         3
1029  *  11110        4
1030  *  111110       5
1031  *  1111110      6
1032  *  1111111      7
1033  *
1034  */
1035 static int get_mode_code(GetBitContext *gb)
1036 {
1037
1038     if (get_bits(gb, 1) == 0)
1039         return 0;
1040
1041     else if (get_bits(gb, 1) == 0)
1042         return 1;
1043
1044     else if (get_bits(gb, 1) == 0)
1045         return 2;
1046
1047     else if (get_bits(gb, 1) == 0)
1048         return 3;
1049
1050     else if (get_bits(gb, 1) == 0)
1051         return 4;
1052
1053     else if (get_bits(gb, 1) == 0)
1054         return 5;
1055
1056     else if (get_bits(gb, 1) == 0)
1057         return 6;
1058
1059     else
1060         return 7;
1061
1062 }
1063
1064 /*
1065  * This function extracts a motion vector from the bitstream using a VLC
1066  * scheme. 3 bits are fetched from the bitstream and 1 of 8 actions is
1067  * taken depending on the value on those 3 bits:
1068  *
1069  *  0: return 0
1070  *  1: return 1
1071  *  2: return -1
1072  *  3: if (next bit is 1) return -2, else return 2
1073  *  4: if (next bit is 1) return -3, else return 3
1074  *  5: return 4 + (next 2 bits), next bit is sign
1075  *  6: return 8 + (next 3 bits), next bit is sign
1076  *  7: return 16 + (next 4 bits), next bit is sign
1077  */
1078 static int get_motion_vector_vlc(GetBitContext *gb)
1079 {
1080     int bits;
1081
1082     bits = get_bits(gb, 3);
1083
1084     switch(bits) {
1085
1086     case 0:
1087         bits = 0;
1088         break;
1089
1090     case 1:
1091         bits = 1;
1092         break;
1093
1094     case 2:
1095         bits = -1;
1096         break;
1097
1098     case 3:
1099         if (get_bits(gb, 1) == 0)
1100             bits = 2;
1101         else
1102             bits = -2;
1103         break;
1104
1105     case 4:
1106         if (get_bits(gb, 1) == 0)
1107             bits = 3;
1108         else
1109             bits = -3;
1110         break;
1111
1112     case 5:
1113         bits = 4 + get_bits(gb, 2);
1114         if (get_bits(gb, 1) == 1)
1115             bits = -bits;
1116         break;
1117
1118     case 6:
1119         bits = 8 + get_bits(gb, 3);
1120         if (get_bits(gb, 1) == 1)
1121             bits = -bits;
1122         break;
1123
1124     case 7:
1125         bits = 16 + get_bits(gb, 4);
1126         if (get_bits(gb, 1) == 1)
1127             bits = -bits;
1128         break;
1129
1130     }
1131
1132     return bits;
1133 }
1134
1135 /*
1136  * This function fetches a 5-bit number from the stream followed by
1137  * a sign and calls it a motion vector.
1138  */
1139 static int get_motion_vector_fixed(GetBitContext *gb)
1140 {
1141
1142     int bits;
1143
1144     bits = get_bits(gb, 5);
1145
1146     if (get_bits(gb, 1) == 1)
1147         bits = -bits;
1148
1149     return bits;
1150 }
1151
1152 /*
1153  * This function unpacks all of the superblock/macroblock/fragment coding 
1154  * information from the bitstream.
1155  */
1156 static int unpack_superblocks(Vp3DecodeContext *s, GetBitContext *gb)
1157 {
1158     int bit = 0;
1159     int current_superblock = 0;
1160     int current_run = 0;
1161     int decode_fully_flags = 0;
1162     int decode_partial_blocks = 0;
1163     int first_c_fragment_seen;
1164
1165     int i, j;
1166     int current_fragment;
1167
1168     debug_vp3("  vp3: unpacking superblock coding\n");
1169
1170     if (s->keyframe) {
1171
1172         debug_vp3("    keyframe-- all superblocks are fully coded\n");
1173         memset(s->superblock_coding, SB_FULLY_CODED, s->superblock_count);
1174
1175     } else {
1176
1177         /* unpack the list of partially-coded superblocks */
1178         bit = get_bits(gb, 1);
1179         /* toggle the bit because as soon as the first run length is 
1180          * fetched the bit will be toggled again */
1181         bit ^= 1;
1182         while (current_superblock < s->superblock_count) {
1183             if (current_run == 0) {
1184                 bit ^= 1;
1185                 current_run = get_superblock_run_length(gb);
1186                 debug_block_coding("      setting superblocks %d..%d to %s\n",
1187                     current_superblock,
1188                     current_superblock + current_run - 1,
1189                     (bit) ? "partially coded" : "not coded");
1190
1191                 /* if any of the superblocks are not partially coded, flag
1192                  * a boolean to decode the list of fully-coded superblocks */
1193                 if (bit == 0) {
1194                     decode_fully_flags = 1;
1195                 } else {
1196
1197                     /* make a note of the fact that there are partially coded
1198                      * superblocks */
1199                     decode_partial_blocks = 1;
1200                 }
1201             }
1202             s->superblock_coding[current_superblock++] = 
1203                 (bit) ? SB_PARTIALLY_CODED : SB_NOT_CODED;
1204             current_run--;
1205         }
1206
1207         /* unpack the list of fully coded superblocks if any of the blocks were
1208          * not marked as partially coded in the previous step */
1209         if (decode_fully_flags) {
1210
1211             current_superblock = 0;
1212             current_run = 0;
1213             bit = get_bits(gb, 1);
1214             /* toggle the bit because as soon as the first run length is 
1215              * fetched the bit will be toggled again */
1216             bit ^= 1;
1217             while (current_superblock < s->superblock_count) {
1218
1219                 /* skip any superblocks already marked as partially coded */
1220                 if (s->superblock_coding[current_superblock] == SB_NOT_CODED) {
1221
1222                     if (current_run == 0) {
1223                         bit ^= 1;
1224                         current_run = get_superblock_run_length(gb);
1225                     }
1226
1227                     debug_block_coding("      setting superblock %d to %s\n",
1228                         current_superblock,
1229                         (bit) ? "fully coded" : "not coded");
1230                     s->superblock_coding[current_superblock] = 
1231                         (bit) ? SB_FULLY_CODED : SB_NOT_CODED;
1232                     current_run--;
1233                 }
1234                 current_superblock++;
1235             }
1236         }
1237
1238         /* if there were partial blocks, initialize bitstream for
1239          * unpacking fragment codings */
1240         if (decode_partial_blocks) {
1241
1242             current_run = 0;
1243             bit = get_bits(gb, 1);
1244             /* toggle the bit because as soon as the first run length is 
1245              * fetched the bit will be toggled again */
1246             bit ^= 1;
1247         }
1248     }
1249
1250     /* figure out which fragments are coded; iterate through each
1251      * superblock (all planes) */
1252     s->coded_fragment_list_index = 0;
1253     s->first_coded_y_fragment = s->first_coded_c_fragment = 0;
1254     s->last_coded_y_fragment = s->last_coded_c_fragment = -1;
1255     first_c_fragment_seen = 0;
1256     memset(s->macroblock_coding, MODE_COPY, s->macroblock_count);
1257     for (i = 0; i < s->superblock_count; i++) {
1258
1259         /* iterate through all 16 fragments in a superblock */
1260         for (j = 0; j < 16; j++) {
1261
1262             /* if the fragment is in bounds, check its coding status */
1263             current_fragment = s->superblock_fragments[i * 16 + j];
1264             if (current_fragment >= s->fragment_count) {
1265                 av_log(s->avctx, AV_LOG_ERROR, "  vp3:unpack_superblocks(): bad fragment number (%d >= %d)\n",
1266                     current_fragment, s->fragment_count);
1267                 return 1;
1268             }
1269             if (current_fragment != -1) {
1270                 if (s->superblock_coding[i] == SB_NOT_CODED) {
1271
1272                     /* copy all the fragments from the prior frame */
1273                     s->all_fragments[current_fragment].coding_method = 
1274                         MODE_COPY;
1275
1276                 } else if (s->superblock_coding[i] == SB_PARTIALLY_CODED) {
1277
1278                     /* fragment may or may not be coded; this is the case
1279                      * that cares about the fragment coding runs */
1280                     if (current_run == 0) {
1281                         bit ^= 1;
1282 #if 1
1283                         current_run = get_vlc2(gb, 
1284                             s->fragment_run_length_vlc.table, 5, 2) + 1;
1285 #else
1286                         current_run = get_fragment_run_length(gb);
1287 #endif
1288                     }
1289
1290                     if (bit) {
1291                         /* default mode; actual mode will be decoded in 
1292                          * the next phase */
1293                         s->all_fragments[current_fragment].coding_method = 
1294                             MODE_INTER_NO_MV;
1295                         s->all_fragments[current_fragment].coeffs= s->coeffs + 64*s->coded_fragment_list_index;
1296                         s->coded_fragment_list[s->coded_fragment_list_index] = 
1297                             current_fragment;
1298                         if ((current_fragment >= s->u_fragment_start) &&
1299                             (s->last_coded_y_fragment == -1) &&
1300                             (!first_c_fragment_seen)) {
1301                             s->first_coded_c_fragment = s->coded_fragment_list_index;
1302                             s->last_coded_y_fragment = s->first_coded_c_fragment - 1;
1303                             first_c_fragment_seen = 1;
1304                         }
1305                         s->coded_fragment_list_index++;
1306                         s->macroblock_coding[s->all_fragments[current_fragment].macroblock] = MODE_INTER_NO_MV;
1307                         debug_block_coding("      superblock %d is partially coded, fragment %d is coded\n",
1308                             i, current_fragment);
1309                     } else {
1310                         /* not coded; copy this fragment from the prior frame */
1311                         s->all_fragments[current_fragment].coding_method =
1312                             MODE_COPY;
1313                         debug_block_coding("      superblock %d is partially coded, fragment %d is not coded\n",
1314                             i, current_fragment);
1315                     }
1316
1317                     current_run--;
1318
1319                 } else {
1320
1321                     /* fragments are fully coded in this superblock; actual
1322                      * coding will be determined in next step */
1323                     s->all_fragments[current_fragment].coding_method = 
1324                         MODE_INTER_NO_MV;
1325                     s->all_fragments[current_fragment].coeffs= s->coeffs + 64*s->coded_fragment_list_index;
1326                     s->coded_fragment_list[s->coded_fragment_list_index] = 
1327                         current_fragment;
1328                     if ((current_fragment >= s->u_fragment_start) &&
1329                         (s->last_coded_y_fragment == -1) &&
1330                         (!first_c_fragment_seen)) {
1331                         s->first_coded_c_fragment = s->coded_fragment_list_index;
1332                         s->last_coded_y_fragment = s->first_coded_c_fragment - 1;
1333                         first_c_fragment_seen = 1;
1334                     }
1335                     s->coded_fragment_list_index++;
1336                     s->macroblock_coding[s->all_fragments[current_fragment].macroblock] = MODE_INTER_NO_MV;
1337                     debug_block_coding("      superblock %d is fully coded, fragment %d is coded\n",
1338                         i, current_fragment);
1339                 }
1340             }
1341         }
1342     }
1343
1344     if (!first_c_fragment_seen)
1345         /* only Y fragments coded in this frame */
1346         s->last_coded_y_fragment = s->coded_fragment_list_index - 1;
1347     else 
1348         /* end the list of coded C fragments */
1349         s->last_coded_c_fragment = s->coded_fragment_list_index - 1;
1350
1351     debug_block_coding("    %d total coded fragments, y: %d -> %d, c: %d -> %d\n",
1352         s->coded_fragment_list_index,
1353         s->first_coded_y_fragment,
1354         s->last_coded_y_fragment,
1355         s->first_coded_c_fragment,
1356         s->last_coded_c_fragment);
1357
1358     return 0;
1359 }
1360
1361 /*
1362  * This function unpacks all the coding mode data for individual macroblocks
1363  * from the bitstream.
1364  */
1365 static int unpack_modes(Vp3DecodeContext *s, GetBitContext *gb)
1366 {
1367     int i, j, k;
1368     int scheme;
1369     int current_macroblock;
1370     int current_fragment;
1371     int coding_mode;
1372
1373     debug_vp3("  vp3: unpacking encoding modes\n");
1374
1375     if (s->keyframe) {
1376         debug_vp3("    keyframe-- all blocks are coded as INTRA\n");
1377
1378         for (i = 0; i < s->fragment_count; i++)
1379             s->all_fragments[i].coding_method = MODE_INTRA;
1380
1381     } else {
1382
1383         /* fetch the mode coding scheme for this frame */
1384         scheme = get_bits(gb, 3);
1385         debug_modes("    using mode alphabet %d\n", scheme);
1386
1387         /* is it a custom coding scheme? */
1388         if (scheme == 0) {
1389             debug_modes("    custom mode alphabet ahead:\n");
1390             for (i = 0; i < 8; i++)
1391                 ModeAlphabet[scheme][get_bits(gb, 3)] = i;
1392         }
1393
1394         for (i = 0; i < 8; i++)
1395             debug_modes("      mode[%d][%d] = %d\n", scheme, i, 
1396                 ModeAlphabet[scheme][i]);
1397
1398         /* iterate through all of the macroblocks that contain 1 or more
1399          * coded fragments */
1400         for (i = 0; i < s->u_superblock_start; i++) {
1401
1402             for (j = 0; j < 4; j++) {
1403                 current_macroblock = s->superblock_macroblocks[i * 4 + j];
1404                 if ((current_macroblock == -1) ||
1405                     (s->macroblock_coding[current_macroblock] == MODE_COPY))
1406                     continue;
1407                 if (current_macroblock >= s->macroblock_count) {
1408                     av_log(s->avctx, AV_LOG_ERROR, "  vp3:unpack_modes(): bad macroblock number (%d >= %d)\n",
1409                         current_macroblock, s->macroblock_count);
1410                     return 1;
1411                 }
1412
1413                 /* mode 7 means get 3 bits for each coding mode */
1414                 if (scheme == 7)
1415                     coding_mode = get_bits(gb, 3);
1416                 else
1417 {
1418 #if 1
1419                     coding_mode = ModeAlphabet[scheme]
1420                         [get_vlc2(gb, s->mode_code_vlc.table, 3, 3)];
1421 #else
1422                     coding_mode = ModeAlphabet[scheme][get_mode_code(gb)];
1423 #endif
1424 }
1425
1426                 s->macroblock_coding[current_macroblock] = coding_mode;
1427                 for (k = 0; k < 6; k++) {
1428                     current_fragment = 
1429                         s->macroblock_fragments[current_macroblock * 6 + k];
1430                     if (current_fragment == -1)
1431                         continue;
1432                     if (current_fragment >= s->fragment_count) {
1433                         av_log(s->avctx, AV_LOG_ERROR, "  vp3:unpack_modes(): bad fragment number (%d >= %d)\n",
1434                             current_fragment, s->fragment_count);
1435                         return 1;
1436                     }
1437                     if (s->all_fragments[current_fragment].coding_method != 
1438                         MODE_COPY)
1439                         s->all_fragments[current_fragment].coding_method =
1440                             coding_mode;
1441                 }
1442
1443                 debug_modes("    coding method for macroblock starting @ fragment %d = %d\n",
1444                     s->macroblock_fragments[current_macroblock * 6], coding_mode);
1445             }
1446         }
1447     }
1448
1449     return 0;
1450 }
1451
1452 /*
1453  * This function unpacks all the motion vectors for the individual
1454  * macroblocks from the bitstream.
1455  */
1456 static int unpack_vectors(Vp3DecodeContext *s, GetBitContext *gb)
1457 {
1458     int i, j, k;
1459     int coding_mode;
1460     int motion_x[6];
1461     int motion_y[6];
1462     int last_motion_x = 0;
1463     int last_motion_y = 0;
1464     int prior_last_motion_x = 0;
1465     int prior_last_motion_y = 0;
1466     int current_macroblock;
1467     int current_fragment;
1468
1469     debug_vp3("  vp3: unpacking motion vectors\n");
1470     if (s->keyframe) {
1471
1472         debug_vp3("    keyframe-- there are no motion vectors\n");
1473
1474     } else {
1475
1476         memset(motion_x, 0, 6 * sizeof(int));
1477         memset(motion_y, 0, 6 * sizeof(int));
1478
1479         /* coding mode 0 is the VLC scheme; 1 is the fixed code scheme */
1480         coding_mode = get_bits(gb, 1);
1481         debug_vectors("    using %s scheme for unpacking motion vectors\n",
1482             (coding_mode == 0) ? "VLC" : "fixed-length");
1483
1484         /* iterate through all of the macroblocks that contain 1 or more
1485          * coded fragments */
1486         for (i = 0; i < s->u_superblock_start; i++) {
1487
1488             for (j = 0; j < 4; j++) {
1489                 current_macroblock = s->superblock_macroblocks[i * 4 + j];
1490                 if ((current_macroblock == -1) ||
1491                     (s->macroblock_coding[current_macroblock] == MODE_COPY))
1492                     continue;
1493                 if (current_macroblock >= s->macroblock_count) {
1494                     av_log(s->avctx, AV_LOG_ERROR, "  vp3:unpack_vectors(): bad macroblock number (%d >= %d)\n",
1495                         current_macroblock, s->macroblock_count);
1496                     return 1;
1497                 }
1498
1499                 current_fragment = s->macroblock_fragments[current_macroblock * 6];
1500                 if (current_fragment >= s->fragment_count) {
1501                     av_log(s->avctx, AV_LOG_ERROR, "  vp3:unpack_vectors(): bad fragment number (%d >= %d\n",
1502                         current_fragment, s->fragment_count);
1503                     return 1;
1504                 }
1505                 switch (s->macroblock_coding[current_macroblock]) {
1506
1507                 case MODE_INTER_PLUS_MV:
1508                 case MODE_GOLDEN_MV:
1509                     /* all 6 fragments use the same motion vector */
1510                     if (coding_mode == 0) {
1511 #if 1
1512                         motion_x[0] = motion_vector_table[get_vlc2(gb, s->motion_vector_vlc.table, 6, 2)];
1513                         motion_y[0] = motion_vector_table[get_vlc2(gb, s->motion_vector_vlc.table, 6, 2)];
1514 #else
1515                         motion_x[0] = get_motion_vector_vlc(gb);
1516                         motion_y[0] = get_motion_vector_vlc(gb);
1517 #endif
1518                     } else {
1519                         motion_x[0] = get_motion_vector_fixed(gb);
1520                         motion_y[0] = get_motion_vector_fixed(gb);
1521                     }
1522                     for (k = 1; k < 6; k++) {
1523                         motion_x[k] = motion_x[0];
1524                         motion_y[k] = motion_y[0];
1525                     }
1526
1527                     /* vector maintenance, only on MODE_INTER_PLUS_MV */
1528                     if (s->macroblock_coding[current_macroblock] ==
1529                         MODE_INTER_PLUS_MV) {
1530                         prior_last_motion_x = last_motion_x;
1531                         prior_last_motion_y = last_motion_y;
1532                         last_motion_x = motion_x[0];
1533                         last_motion_y = motion_y[0];
1534                     }
1535                     break;
1536
1537                 case MODE_INTER_FOURMV:
1538                     /* fetch 4 vectors from the bitstream, one for each
1539                      * Y fragment, then average for the C fragment vectors */
1540                     motion_x[4] = motion_y[4] = 0;
1541                     for (k = 0; k < 4; k++) {
1542                         if (coding_mode == 0) {
1543 #if 1
1544                             motion_x[0] = motion_vector_table[get_vlc2(gb, s->motion_vector_vlc.table, 6, 2)];
1545                             motion_y[0] = motion_vector_table[get_vlc2(gb, s->motion_vector_vlc.table, 6, 2)];
1546 #else
1547                             motion_x[k] = get_motion_vector_vlc(gb);
1548                             motion_y[k] = get_motion_vector_vlc(gb);
1549 #endif
1550                         } else {
1551                             motion_x[k] = get_motion_vector_fixed(gb);
1552                             motion_y[k] = get_motion_vector_fixed(gb);
1553                         }
1554                         motion_x[4] += motion_x[k];
1555                         motion_y[4] += motion_y[k];
1556                     }
1557
1558                     if (motion_x[4] >= 0) 
1559                         motion_x[4] = (motion_x[4] + 2) / 4;
1560                     else
1561                         motion_x[4] = (motion_x[4] - 2) / 4;
1562                     motion_x[5] = motion_x[4];
1563
1564                     if (motion_y[4] >= 0) 
1565                         motion_y[4] = (motion_y[4] + 2) / 4;
1566                     else
1567                         motion_y[4] = (motion_y[4] - 2) / 4;
1568                     motion_y[5] = motion_y[4];
1569
1570                     /* vector maintenance; vector[3] is treated as the
1571                      * last vector in this case */
1572                     prior_last_motion_x = last_motion_x;
1573                     prior_last_motion_y = last_motion_y;
1574                     last_motion_x = motion_x[3];
1575                     last_motion_y = motion_y[3];
1576                     break;
1577
1578                 case MODE_INTER_LAST_MV:
1579                     /* all 6 fragments use the last motion vector */
1580                     motion_x[0] = last_motion_x;
1581                     motion_y[0] = last_motion_y;
1582                     for (k = 1; k < 6; k++) {
1583                         motion_x[k] = motion_x[0];
1584                         motion_y[k] = motion_y[0];
1585                     }
1586
1587                     /* no vector maintenance (last vector remains the
1588                      * last vector) */
1589                     break;
1590
1591                 case MODE_INTER_PRIOR_LAST:
1592                     /* all 6 fragments use the motion vector prior to the
1593                      * last motion vector */
1594                     motion_x[0] = prior_last_motion_x;
1595                     motion_y[0] = prior_last_motion_y;
1596                     for (k = 1; k < 6; k++) {
1597                         motion_x[k] = motion_x[0];
1598                         motion_y[k] = motion_y[0];
1599                     }
1600
1601                     /* vector maintenance */
1602                     prior_last_motion_x = last_motion_x;
1603                     prior_last_motion_y = last_motion_y;
1604                     last_motion_x = motion_x[0];
1605                     last_motion_y = motion_y[0];
1606                     break;
1607
1608                 default:
1609                     /* covers intra, inter without MV, golden without MV */
1610                     memset(motion_x, 0, 6 * sizeof(int));
1611                     memset(motion_y, 0, 6 * sizeof(int));
1612
1613                     /* no vector maintenance */
1614                     break;
1615                 }
1616
1617                 /* assign the motion vectors to the correct fragments */
1618                 debug_vectors("    vectors for macroblock starting @ fragment %d (coding method %d):\n",
1619                     current_fragment,
1620                     s->macroblock_coding[current_macroblock]);
1621                 for (k = 0; k < 6; k++) {
1622                     current_fragment = 
1623                         s->macroblock_fragments[current_macroblock * 6 + k];
1624                     if (current_fragment == -1)
1625                         continue;
1626                     if (current_fragment >= s->fragment_count) {
1627                         av_log(s->avctx, AV_LOG_ERROR, "  vp3:unpack_vectors(): bad fragment number (%d >= %d)\n",
1628                             current_fragment, s->fragment_count);
1629                         return 1;
1630                     }
1631                     s->all_fragments[current_fragment].motion_x = motion_x[k];
1632                     s->all_fragments[current_fragment].motion_y = motion_y[k];
1633                     debug_vectors("    vector %d: fragment %d = (%d, %d)\n",
1634                         k, current_fragment, motion_x[k], motion_y[k]);
1635                 }
1636             }
1637         }
1638     }
1639
1640     return 0;
1641 }
1642
1643 /* 
1644  * This function is called by unpack_dct_coeffs() to extract the VLCs from
1645  * the bitstream. The VLCs encode tokens which are used to unpack DCT
1646  * data. This function unpacks all the VLCs for either the Y plane or both
1647  * C planes, and is called for DC coefficients or different AC coefficient
1648  * levels (since different coefficient types require different VLC tables.
1649  *
1650  * This function returns a residual eob run. E.g, if a particular token gave
1651  * instructions to EOB the next 5 fragments and there were only 2 fragments
1652  * left in the current fragment range, 3 would be returned so that it could
1653  * be passed into the next call to this same function.
1654  */
1655 static int unpack_vlcs(Vp3DecodeContext *s, GetBitContext *gb,
1656                         VLC *table, int coeff_index,
1657                         int first_fragment, int last_fragment,
1658                         int eob_run)
1659 {
1660     int i;
1661     int token;
1662     int zero_run;
1663     DCTELEM coeff;
1664     Vp3Fragment *fragment;
1665     uint8_t *perm= s->scantable.permutated;
1666
1667     if ((first_fragment >= s->fragment_count) ||
1668         (last_fragment >= s->fragment_count)) {
1669
1670         av_log(s->avctx, AV_LOG_ERROR, "  vp3:unpack_vlcs(): bad fragment number (%d -> %d ?)\n",
1671             first_fragment, last_fragment);
1672         return 0;
1673     }
1674
1675     for (i = first_fragment; i <= last_fragment; i++) {
1676
1677         fragment = &s->all_fragments[s->coded_fragment_list[i]];
1678         if (fragment->coeff_count > coeff_index)
1679             continue;
1680
1681         if (!eob_run) {
1682             /* decode a VLC into a token */
1683             token = get_vlc2(gb, table->table, 5, 3);
1684             debug_vlc(" token = %2d, ", token);
1685             /* use the token to get a zero run, a coefficient, and an eob run */
1686             unpack_token(gb, token, &zero_run, &coeff, &eob_run);
1687         }
1688
1689         if (!eob_run) {
1690             fragment->coeff_count += zero_run;
1691             if (fragment->coeff_count < 64)
1692                 fragment->coeffs[perm[fragment->coeff_count++]] = coeff;
1693             debug_vlc(" fragment %d coeff = %d\n",
1694                 s->coded_fragment_list[i], fragment->coeffs[coeff_index]);
1695         } else {
1696             fragment->last_coeff = fragment->coeff_count;
1697             fragment->coeff_count = 64;
1698             debug_vlc(" fragment %d eob with %d coefficients\n", 
1699                 s->coded_fragment_list[i], fragment->last_coeff);
1700             eob_run--;
1701         }
1702     }
1703
1704     return eob_run;
1705 }
1706
1707 /*
1708  * This function unpacks all of the DCT coefficient data from the
1709  * bitstream.
1710  */
1711 static int unpack_dct_coeffs(Vp3DecodeContext *s, GetBitContext *gb)
1712 {
1713     int i;
1714     int dc_y_table;
1715     int dc_c_table;
1716     int ac_y_table;
1717     int ac_c_table;
1718     int residual_eob_run = 0;
1719
1720     /* fetch the DC table indices */
1721     dc_y_table = get_bits(gb, 4);
1722     dc_c_table = get_bits(gb, 4);
1723
1724     /* unpack the Y plane DC coefficients */
1725     debug_vp3("  vp3: unpacking Y plane DC coefficients using table %d\n",
1726         dc_y_table);
1727     residual_eob_run = unpack_vlcs(s, gb, &s->dc_vlc[dc_y_table], 0, 
1728         s->first_coded_y_fragment, s->last_coded_y_fragment, residual_eob_run);
1729
1730     /* unpack the C plane DC coefficients */
1731     debug_vp3("  vp3: unpacking C plane DC coefficients using table %d\n",
1732         dc_c_table);
1733     residual_eob_run = unpack_vlcs(s, gb, &s->dc_vlc[dc_c_table], 0,
1734         s->first_coded_c_fragment, s->last_coded_c_fragment, residual_eob_run);
1735
1736     /* fetch the AC table indices */
1737     ac_y_table = get_bits(gb, 4);
1738     ac_c_table = get_bits(gb, 4);
1739
1740     /* unpack the group 1 AC coefficients (coeffs 1-5) */
1741     for (i = 1; i <= 5; i++) {
1742
1743         debug_vp3("  vp3: unpacking level %d Y plane AC coefficients using table %d\n",
1744             i, ac_y_table);
1745         residual_eob_run = unpack_vlcs(s, gb, &s->ac_vlc_1[ac_y_table], i, 
1746             s->first_coded_y_fragment, s->last_coded_y_fragment, residual_eob_run);
1747
1748         debug_vp3("  vp3: unpacking level %d C plane AC coefficients using table %d\n",
1749             i, ac_c_table);
1750         residual_eob_run = unpack_vlcs(s, gb, &s->ac_vlc_1[ac_c_table], i, 
1751             s->first_coded_c_fragment, s->last_coded_c_fragment, residual_eob_run);
1752     }
1753
1754     /* unpack the group 2 AC coefficients (coeffs 6-14) */
1755     for (i = 6; i <= 14; i++) {
1756
1757         debug_vp3("  vp3: unpacking level %d Y plane AC coefficients using table %d\n",
1758             i, ac_y_table);
1759         residual_eob_run = unpack_vlcs(s, gb, &s->ac_vlc_2[ac_y_table], i, 
1760             s->first_coded_y_fragment, s->last_coded_y_fragment, residual_eob_run);
1761
1762         debug_vp3("  vp3: unpacking level %d C plane AC coefficients using table %d\n",
1763             i, ac_c_table);
1764         residual_eob_run = unpack_vlcs(s, gb, &s->ac_vlc_2[ac_c_table], i, 
1765             s->first_coded_c_fragment, s->last_coded_c_fragment, residual_eob_run);
1766     }
1767
1768     /* unpack the group 3 AC coefficients (coeffs 15-27) */
1769     for (i = 15; i <= 27; i++) {
1770
1771         debug_vp3("  vp3: unpacking level %d Y plane AC coefficients using table %d\n",
1772             i, ac_y_table);
1773         residual_eob_run = unpack_vlcs(s, gb, &s->ac_vlc_3[ac_y_table], i, 
1774             s->first_coded_y_fragment, s->last_coded_y_fragment, residual_eob_run);
1775
1776         debug_vp3("  vp3: unpacking level %d C plane AC coefficients using table %d\n",
1777             i, ac_c_table);
1778         residual_eob_run = unpack_vlcs(s, gb, &s->ac_vlc_3[ac_c_table], i, 
1779             s->first_coded_c_fragment, s->last_coded_c_fragment, residual_eob_run);
1780     }
1781
1782     /* unpack the group 4 AC coefficients (coeffs 28-63) */
1783     for (i = 28; i <= 63; i++) {
1784
1785         debug_vp3("  vp3: unpacking level %d Y plane AC coefficients using table %d\n",
1786             i, ac_y_table);
1787         residual_eob_run = unpack_vlcs(s, gb, &s->ac_vlc_4[ac_y_table], i, 
1788             s->first_coded_y_fragment, s->last_coded_y_fragment, residual_eob_run);
1789
1790         debug_vp3("  vp3: unpacking level %d C plane AC coefficients using table %d\n",
1791             i, ac_c_table);
1792         residual_eob_run = unpack_vlcs(s, gb, &s->ac_vlc_4[ac_c_table], i, 
1793             s->first_coded_c_fragment, s->last_coded_c_fragment, residual_eob_run);
1794     }
1795
1796     return 0;
1797 }
1798
1799 /*
1800  * This function reverses the DC prediction for each coded fragment in
1801  * the frame. Much of this function is adapted directly from the original 
1802  * VP3 source code.
1803  */
1804 #define COMPATIBLE_FRAME(x) \
1805   (compatible_frame[s->all_fragments[x].coding_method] == current_frame_type)
1806 #define FRAME_CODED(x) (s->all_fragments[x].coding_method != MODE_COPY)
1807 static inline int iabs (int x) { return ((x < 0) ? -x : x); }
1808
1809 static void reverse_dc_prediction(Vp3DecodeContext *s,
1810                                   int first_fragment,
1811                                   int fragment_width,
1812                                   int fragment_height) 
1813 {
1814
1815 #define PUL 8
1816 #define PU 4
1817 #define PUR 2
1818 #define PL 1
1819
1820     int x, y;
1821     int i = first_fragment;
1822
1823     /*
1824      * Fragment prediction groups:
1825      *
1826      * 32222222226
1827      * 10000000004
1828      * 10000000004
1829      * 10000000004
1830      * 10000000004
1831      *
1832      * Note: Groups 5 and 7 do not exist as it would mean that the 
1833      * fragment's x coordinate is both 0 and (width - 1) at the same time.
1834      */
1835     int predictor_group;
1836     short predicted_dc;
1837
1838     /* validity flags for the left, up-left, up, and up-right fragments */
1839     int fl, ful, fu, fur;
1840
1841     /* DC values for the left, up-left, up, and up-right fragments */
1842     int vl, vul, vu, vur;
1843
1844     /* indices for the left, up-left, up, and up-right fragments */
1845     int l, ul, u, ur;
1846
1847     /* 
1848      * The 6 fields mean:
1849      *   0: up-left multiplier
1850      *   1: up multiplier
1851      *   2: up-right multiplier
1852      *   3: left multiplier
1853      *   4: mask
1854      *   5: right bit shift divisor (e.g., 7 means >>=7, a.k.a. div by 128)
1855      */
1856     int predictor_transform[16][6] = {
1857         {  0,  0,  0,  0,   0,  0 },
1858         {  0,  0,  0,  1,   0,  0 },        // PL
1859         {  0,  0,  1,  0,   0,  0 },        // PUR
1860         {  0,  0, 53, 75, 127,  7 },        // PUR|PL
1861         {  0,  1,  0,  0,   0,  0 },        // PU
1862         {  0,  1,  0,  1,   1,  1 },        // PU|PL
1863         {  0,  1,  0,  0,   0,  0 },        // PU|PUR
1864         {  0,  0, 53, 75, 127,  7 },        // PU|PUR|PL
1865         {  1,  0,  0,  0,   0,  0 },        // PUL
1866         {  0,  0,  0,  1,   0,  0 },        // PUL|PL
1867         {  1,  0,  1,  0,   1,  1 },        // PUL|PUR
1868         {  0,  0, 53, 75, 127,  7 },        // PUL|PUR|PL
1869         {  0,  1,  0,  0,   0,  0 },        // PUL|PU
1870         {-26, 29,  0, 29,  31,  5 },        // PUL|PU|PL
1871         {  3, 10,  3,  0,  15,  4 },        // PUL|PU|PUR
1872         {-26, 29,  0, 29,  31,  5 }         // PUL|PU|PUR|PL
1873     };
1874
1875     /* This table shows which types of blocks can use other blocks for
1876      * prediction. For example, INTRA is the only mode in this table to
1877      * have a frame number of 0. That means INTRA blocks can only predict
1878      * from other INTRA blocks. There are 2 golden frame coding types; 
1879      * blocks encoding in these modes can only predict from other blocks
1880      * that were encoded with these 1 of these 2 modes. */
1881     unsigned char compatible_frame[8] = {
1882         1,    /* MODE_INTER_NO_MV */
1883         0,    /* MODE_INTRA */
1884         1,    /* MODE_INTER_PLUS_MV */
1885         1,    /* MODE_INTER_LAST_MV */
1886         1,    /* MODE_INTER_PRIOR_MV */
1887         2,    /* MODE_USING_GOLDEN */
1888         2,    /* MODE_GOLDEN_MV */
1889         1     /* MODE_INTER_FOUR_MV */
1890     };
1891     int current_frame_type;
1892
1893     /* there is a last DC predictor for each of the 3 frame types */
1894     short last_dc[3];
1895
1896     int transform = 0;
1897
1898     debug_vp3("  vp3: reversing DC prediction\n");
1899
1900     vul = vu = vur = vl = 0;
1901     last_dc[0] = last_dc[1] = last_dc[2] = 0;
1902
1903     /* for each fragment row... */
1904     for (y = 0; y < fragment_height; y++) {
1905
1906         /* for each fragment in a row... */
1907         for (x = 0; x < fragment_width; x++, i++) {
1908
1909             /* reverse prediction if this block was coded */
1910             if (s->all_fragments[i].coding_method != MODE_COPY) {
1911
1912                 current_frame_type = 
1913                     compatible_frame[s->all_fragments[i].coding_method];
1914                 predictor_group = (x == 0) + ((y == 0) << 1) +
1915                     ((x + 1 == fragment_width) << 2);
1916                 debug_dc_pred(" frag %d: group %d, orig DC = %d, ",
1917                     i, predictor_group, s->all_fragments[i].coeffs[0]);
1918
1919                 switch (predictor_group) {
1920
1921                 case 0:
1922                     /* main body of fragments; consider all 4 possible
1923                      * fragments for prediction */
1924
1925                     /* calculate the indices of the predicting fragments */
1926                     ul = i - fragment_width - 1;
1927                     u = i - fragment_width;
1928                     ur = i - fragment_width + 1;
1929                     l = i - 1;
1930
1931                     /* fetch the DC values for the predicting fragments */
1932                     vul = s->all_fragments[ul].coeffs[0];
1933                     vu = s->all_fragments[u].coeffs[0];
1934                     vur = s->all_fragments[ur].coeffs[0];
1935                     vl = s->all_fragments[l].coeffs[0];
1936
1937                     /* figure out which fragments are valid */
1938                     ful = FRAME_CODED(ul) && COMPATIBLE_FRAME(ul);
1939                     fu = FRAME_CODED(u) && COMPATIBLE_FRAME(u);
1940                     fur = FRAME_CODED(ur) && COMPATIBLE_FRAME(ur);
1941                     fl = FRAME_CODED(l) && COMPATIBLE_FRAME(l);
1942
1943                     /* decide which predictor transform to use */
1944                     transform = (fl*PL) | (fu*PU) | (ful*PUL) | (fur*PUR);
1945
1946                     break;
1947
1948                 case 1:
1949                     /* left column of fragments, not including top corner;
1950                      * only consider up and up-right fragments */
1951
1952                     /* calculate the indices of the predicting fragments */
1953                     u = i - fragment_width;
1954                     ur = i - fragment_width + 1;
1955
1956                     /* fetch the DC values for the predicting fragments */
1957                     vu = s->all_fragments[u].coeffs[0];
1958                     vur = s->all_fragments[ur].coeffs[0];
1959
1960                     /* figure out which fragments are valid */
1961                     fur = FRAME_CODED(ur) && COMPATIBLE_FRAME(ur);
1962                     fu = FRAME_CODED(u) && COMPATIBLE_FRAME(u);
1963
1964                     /* decide which predictor transform to use */
1965                     transform = (fu*PU) | (fur*PUR);
1966
1967                     break;
1968
1969                 case 2:
1970                 case 6:
1971                     /* top row of fragments, not including top-left frag;
1972                      * only consider the left fragment for prediction */
1973
1974                     /* calculate the indices of the predicting fragments */
1975                     l = i - 1;
1976
1977                     /* fetch the DC values for the predicting fragments */
1978                     vl = s->all_fragments[l].coeffs[0];
1979
1980                     /* figure out which fragments are valid */
1981                     fl = FRAME_CODED(l) && COMPATIBLE_FRAME(l);
1982
1983                     /* decide which predictor transform to use */
1984                     transform = (fl*PL);
1985
1986                     break;
1987
1988                 case 3:
1989                     /* top-left fragment */
1990
1991                     /* nothing to predict from in this case */
1992                     transform = 0;
1993
1994                     break;
1995
1996                 case 4:
1997                     /* right column of fragments, not including top corner;
1998                      * consider up-left, up, and left fragments for
1999                      * prediction */
2000
2001                     /* calculate the indices of the predicting fragments */
2002                     ul = i - fragment_width - 1;
2003                     u = i - fragment_width;
2004                     l = i - 1;
2005
2006                     /* fetch the DC values for the predicting fragments */
2007                     vul = s->all_fragments[ul].coeffs[0];
2008                     vu = s->all_fragments[u].coeffs[0];
2009                     vl = s->all_fragments[l].coeffs[0];
2010
2011                     /* figure out which fragments are valid */
2012                     ful = FRAME_CODED(ul) && COMPATIBLE_FRAME(ul);
2013                     fu = FRAME_CODED(u) && COMPATIBLE_FRAME(u);
2014                     fl = FRAME_CODED(l) && COMPATIBLE_FRAME(l);
2015
2016                     /* decide which predictor transform to use */
2017                     transform = (fl*PL) | (fu*PU) | (ful*PUL);
2018
2019                     break;
2020
2021                 }
2022
2023                 debug_dc_pred("transform = %d, ", transform);
2024
2025                 if (transform == 0) {
2026
2027                     /* if there were no fragments to predict from, use last
2028                      * DC saved */
2029                     s->all_fragments[i].coeffs[0] += last_dc[current_frame_type];
2030                     debug_dc_pred("from last DC (%d) = %d\n", 
2031                         current_frame_type, s->all_fragments[i].coeffs[0]);
2032
2033                 } else {
2034
2035                     /* apply the appropriate predictor transform */
2036                     predicted_dc =
2037                         (predictor_transform[transform][0] * vul) +
2038                         (predictor_transform[transform][1] * vu) +
2039                         (predictor_transform[transform][2] * vur) +
2040                         (predictor_transform[transform][3] * vl);
2041
2042                     /* if there is a shift value in the transform, add
2043                      * the sign bit before the shift */
2044                     if (predictor_transform[transform][5] != 0) {
2045                         predicted_dc += ((predicted_dc >> 15) & 
2046                             predictor_transform[transform][4]);
2047                         predicted_dc >>= predictor_transform[transform][5];
2048                     }
2049
2050                     /* check for outranging on the [ul u l] and
2051                      * [ul u ur l] predictors */
2052                     if ((transform == 13) || (transform == 15)) {
2053                         if (iabs(predicted_dc - vu) > 128)
2054                             predicted_dc = vu;
2055                         else if (iabs(predicted_dc - vl) > 128)
2056                             predicted_dc = vl;
2057                         else if (iabs(predicted_dc - vul) > 128)
2058                             predicted_dc = vul;
2059                     }
2060
2061                     /* at long last, apply the predictor */
2062                     s->all_fragments[i].coeffs[0] += predicted_dc;
2063                     debug_dc_pred("from pred DC = %d\n", 
2064                     s->all_fragments[i].coeffs[0]);
2065                 }
2066
2067                 /* save the DC */
2068                 last_dc[current_frame_type] = s->all_fragments[i].coeffs[0];
2069                 if(s->all_fragments[i].coeffs[0] && s->all_fragments[i].last_coeff<0)
2070                     s->all_fragments[i].last_coeff= 0;
2071             }
2072         }
2073     }
2074 }
2075
2076 /*
2077  * This function performs the final rendering of each fragment's data
2078  * onto the output frame.
2079  */
2080 static void render_fragments(Vp3DecodeContext *s,
2081                              int first_fragment,
2082                              int width,
2083                              int height,
2084                              int plane /* 0 = Y, 1 = U, 2 = V */) 
2085 {
2086     int x, y, j;
2087     int m, n;
2088     int i = first_fragment;
2089     int16_t *dequantizer;
2090     DCTELEM __align16 output_samples[64];
2091     unsigned char *output_plane;
2092     unsigned char *last_plane;
2093     unsigned char *golden_plane;
2094     int stride;
2095     int motion_x = 0xdeadbeef, motion_y = 0xdeadbeef;
2096     int upper_motion_limit, lower_motion_limit;
2097     int motion_halfpel_index;
2098     uint8_t *motion_source;
2099
2100     debug_vp3("  vp3: rendering final fragments for %s\n",
2101         (plane == 0) ? "Y plane" : (plane == 1) ? "U plane" : "V plane");
2102
2103     /* set up plane-specific parameters */
2104     if (plane == 0) {
2105         output_plane = s->current_frame.data[0];
2106         last_plane = s->last_frame.data[0];
2107         golden_plane = s->golden_frame.data[0];
2108         stride = s->current_frame.linesize[0];
2109         if (!s->flipped_image) stride = -stride;
2110         upper_motion_limit = 7 * s->current_frame.linesize[0];
2111         lower_motion_limit = height * s->current_frame.linesize[0] + width - 8;
2112     } else if (plane == 1) {
2113         output_plane = s->current_frame.data[1];
2114         last_plane = s->last_frame.data[1];
2115         golden_plane = s->golden_frame.data[1];
2116         stride = s->current_frame.linesize[1];
2117         if (!s->flipped_image) stride = -stride;
2118         upper_motion_limit = 7 * s->current_frame.linesize[1];
2119         lower_motion_limit = height * s->current_frame.linesize[1] + width - 8;
2120     } else {
2121         output_plane = s->current_frame.data[2];
2122         last_plane = s->last_frame.data[2];
2123         golden_plane = s->golden_frame.data[2];
2124         stride = s->current_frame.linesize[2];
2125         if (!s->flipped_image) stride = -stride;
2126         upper_motion_limit = 7 * s->current_frame.linesize[2];
2127         lower_motion_limit = height * s->current_frame.linesize[2] + width - 8;
2128     }
2129     
2130     if(ABS(stride) > 2048)
2131         return; //various tables are fixed size
2132
2133     /* for each fragment row... */
2134     for (y = 0; y < height; y += 8) {
2135
2136         /* for each fragment in a row... */
2137         for (x = 0; x < width; x += 8, i++) {
2138
2139             if ((i < 0) || (i >= s->fragment_count)) {
2140                 av_log(s->avctx, AV_LOG_ERROR, "  vp3:render_fragments(): bad fragment number (%d)\n", i);
2141                 return;
2142             }
2143
2144             /* transform if this block was coded */
2145             if ((s->all_fragments[i].coding_method != MODE_COPY) &&
2146                 !((s->avctx->flags & CODEC_FLAG_GRAY) && plane)) {
2147
2148                 if ((s->all_fragments[i].coding_method == MODE_USING_GOLDEN) ||
2149                     (s->all_fragments[i].coding_method == MODE_GOLDEN_MV))
2150                     motion_source= golden_plane;
2151                 else 
2152                     motion_source= last_plane;
2153
2154                 motion_source += s->all_fragments[i].first_pixel;
2155                 motion_halfpel_index = 0;
2156
2157                 /* sort out the motion vector if this fragment is coded
2158                  * using a motion vector method */
2159                 if ((s->all_fragments[i].coding_method > MODE_INTRA) &&
2160                     (s->all_fragments[i].coding_method != MODE_USING_GOLDEN)) {
2161                     int src_x, src_y;
2162                     motion_x = s->all_fragments[i].motion_x;
2163                     motion_y = s->all_fragments[i].motion_y;
2164                     if(plane){
2165                         motion_x= (motion_x>>1) | (motion_x&1);
2166                         motion_y= (motion_y>>1) | (motion_y&1);
2167                     }
2168
2169                     src_x= (motion_x>>1) + x;
2170                     src_y= (motion_y>>1) + y;
2171 if ((motion_x == 0xbeef) || (motion_y == 0xbeef))
2172 av_log(s->avctx, AV_LOG_ERROR, " help! got beefy vector! (%X, %X)\n", motion_x, motion_y);
2173
2174                     motion_halfpel_index = motion_x & 0x01;
2175                     motion_source += (motion_x >> 1);
2176
2177 //                    motion_y = -motion_y;
2178                     motion_halfpel_index |= (motion_y & 0x01) << 1;
2179                     motion_source += ((motion_y >> 1) * stride);
2180
2181                     if(src_x<0 || src_y<0 || src_x + 9 >= width || src_y + 9 >= height){
2182                         uint8_t *temp= s->edge_emu_buffer;
2183                         if(stride<0) temp -= 9*stride;
2184                         else temp += 9*stride;
2185
2186                         ff_emulated_edge_mc(temp, motion_source, stride, 9, 9, src_x, src_y, width, height);
2187                         motion_source= temp;
2188                     }
2189                 }
2190                 
2191
2192                 /* first, take care of copying a block from either the
2193                  * previous or the golden frame */
2194                 if (s->all_fragments[i].coding_method != MODE_INTRA) {
2195                     //Note, it is possible to implement all MC cases with put_no_rnd_pixels_l2 which would look more like the VP3 source but this would be slower as put_no_rnd_pixels_tab is better optimzed
2196                     if(motion_halfpel_index != 3){
2197                         s->dsp.put_no_rnd_pixels_tab[1][motion_halfpel_index](
2198                             output_plane + s->all_fragments[i].first_pixel,
2199                             motion_source, stride, 8);
2200                     }else{
2201                         int d= (motion_x ^ motion_y)>>31; // d is 0 if motion_x and _y have the same sign, else -1
2202                         s->dsp.put_no_rnd_pixels_l2[1](
2203                             output_plane + s->all_fragments[i].first_pixel,
2204                             motion_source - d, 
2205                             motion_source + stride + 1 + d, 
2206                             stride, 8);
2207                     }
2208                     dequantizer = s->inter_dequant;
2209                 }else{
2210                     if (plane == 0)
2211                         dequantizer = s->intra_y_dequant;
2212                     else
2213                         dequantizer = s->intra_c_dequant;
2214                 }
2215
2216                 /* dequantize the DCT coefficients */
2217                 debug_idct("fragment %d, coding mode %d, DC = %d, dequant = %d:\n", 
2218                     i, s->all_fragments[i].coding_method, 
2219                     s->all_fragments[i].coeffs[0], dequantizer[0]);
2220
2221                 if(s->avctx->idct_algo==FF_IDCT_VP3){
2222                     for (j = 0; j < 64; j++) {
2223                         s->all_fragments[i].coeffs[j] *= dequantizer[j];
2224                     }
2225                 }else{
2226                     for (j = 0; j < 64; j++) {
2227                         s->all_fragments[i].coeffs[j]= (dequantizer[j] * s->all_fragments[i].coeffs[j] + 2) >> 2;
2228                     }
2229                 }
2230
2231                 /* invert DCT and place (or add) in final output */
2232                 
2233                 if (s->all_fragments[i].coding_method == MODE_INTRA) {
2234                     if(s->avctx->idct_algo!=FF_IDCT_VP3)
2235                         s->all_fragments[i].coeffs[0] += 128<<3;
2236                     s->dsp.idct_put(
2237                         output_plane + s->all_fragments[i].first_pixel,
2238                         stride,
2239                         s->all_fragments[i].coeffs);
2240                 } else {
2241                     s->dsp.idct_add(
2242                         output_plane + s->all_fragments[i].first_pixel,
2243                         stride,
2244                         s->all_fragments[i].coeffs);
2245                 }
2246                 memset(s->all_fragments[i].coeffs, 0, 64*sizeof(DCTELEM));
2247
2248                 debug_idct("block after idct_%s():\n",
2249                     (s->all_fragments[i].coding_method == MODE_INTRA)?
2250                     "put" : "add");
2251                 for (m = 0; m < 8; m++) {
2252                     for (n = 0; n < 8; n++) {
2253                         debug_idct(" %3d", *(output_plane + 
2254                             s->all_fragments[i].first_pixel + (m * stride + n)));
2255                     }
2256                     debug_idct("\n");
2257                 }
2258                 debug_idct("\n");
2259
2260             } else {
2261
2262                 /* copy directly from the previous frame */
2263                 s->dsp.put_pixels_tab[1][0](
2264                     output_plane + s->all_fragments[i].first_pixel,
2265                     last_plane + s->all_fragments[i].first_pixel,
2266                     stride, 8);
2267
2268             }
2269         }
2270     }
2271
2272     emms_c();
2273 }
2274
2275 static void horizontal_filter(unsigned char *first_pixel, int stride,
2276     int *bounding_values)
2277 {
2278     unsigned char *end;
2279     int filter_value;
2280
2281     for (end= first_pixel + 8*stride; first_pixel < end; first_pixel += stride) {
2282         filter_value = 
2283             (first_pixel[-2] - first_pixel[ 1])
2284          +3*(first_pixel[ 0] - first_pixel[-1]);
2285         filter_value = bounding_values[(filter_value + 4) >> 3];
2286         first_pixel[-1] = clip_uint8(first_pixel[-1] + filter_value);
2287         first_pixel[ 0] = clip_uint8(first_pixel[ 0] - filter_value);
2288     }
2289 }
2290
2291 static void vertical_filter(unsigned char *first_pixel, int stride,
2292     int *bounding_values)
2293 {
2294     unsigned char *end;
2295     int filter_value;
2296     const int nstride= -stride;
2297
2298     for (end= first_pixel + 8; first_pixel < end; first_pixel++) {
2299         filter_value = 
2300             (first_pixel[2 * nstride] - first_pixel[ stride])
2301          +3*(first_pixel[0          ] - first_pixel[nstride]);
2302         filter_value = bounding_values[(filter_value + 4) >> 3];
2303         first_pixel[nstride] = clip_uint8(first_pixel[nstride] + filter_value);
2304         first_pixel[0] = clip_uint8(first_pixel[0] - filter_value);
2305     }
2306 }
2307
2308 static void apply_loop_filter(Vp3DecodeContext *s)
2309 {
2310     int x, y, plane;
2311     int width, height;
2312     int fragment;
2313     int stride;
2314     unsigned char *plane_data;
2315
2316     int bounding_values_array[256];
2317     int *bounding_values= bounding_values_array+127;
2318     int filter_limit;
2319
2320     /* find the right loop limit value */
2321     for (x = 63; x >= 0; x--) {
2322         if (vp31_ac_scale_factor[x] >= s->quality_index)
2323             break;
2324     }
2325     filter_limit = vp31_filter_limit_values[s->quality_index];
2326
2327     /* set up the bounding values */
2328     memset(bounding_values_array, 0, 256 * sizeof(int));
2329     for (x = 0; x < filter_limit; x++) {
2330         bounding_values[-x - filter_limit] = -filter_limit + x;
2331         bounding_values[-x] = -x;
2332         bounding_values[x] = x;
2333         bounding_values[x + filter_limit] = filter_limit - x;
2334     }
2335
2336     for (plane = 0; plane < 3; plane++) {
2337
2338         if (plane == 0) {
2339             /* Y plane parameters */
2340             fragment = 0;
2341             width = s->fragment_width;
2342             height = s->fragment_height;
2343             stride = s->current_frame.linesize[0];
2344             plane_data = s->current_frame.data[0];
2345         } else if (plane == 1) {
2346             /* U plane parameters */
2347             fragment = s->u_fragment_start;
2348             width = s->fragment_width / 2;
2349             height = s->fragment_height / 2;
2350             stride = s->current_frame.linesize[1];
2351             plane_data = s->current_frame.data[1];
2352         } else {
2353             /* V plane parameters */
2354             fragment = s->v_fragment_start;
2355             width = s->fragment_width / 2;
2356             height = s->fragment_height / 2;
2357             stride = s->current_frame.linesize[2];
2358             plane_data = s->current_frame.data[2];
2359         }
2360
2361         for (y = 0; y < height; y++) {
2362
2363             for (x = 0; x < width; x++) {
2364 START_TIMER
2365                 /* do not perform left edge filter for left columns frags */
2366                 if ((x > 0) &&
2367                     (s->all_fragments[fragment].coding_method != MODE_COPY)) {
2368                     horizontal_filter(
2369                         plane_data + s->all_fragments[fragment].first_pixel - 7*stride, 
2370                         stride, bounding_values);
2371                 }
2372
2373                 /* do not perform top edge filter for top row fragments */
2374                 if ((y > 0) &&
2375                     (s->all_fragments[fragment].coding_method != MODE_COPY)) {
2376                     vertical_filter(
2377                         plane_data + s->all_fragments[fragment].first_pixel + stride, 
2378                         stride, bounding_values);
2379                 }
2380
2381                 /* do not perform right edge filter for right column
2382                  * fragments or if right fragment neighbor is also coded
2383                  * in this frame (it will be filtered in next iteration) */
2384                 if ((x < width - 1) &&
2385                     (s->all_fragments[fragment].coding_method != MODE_COPY) &&
2386                     (s->all_fragments[fragment + 1].coding_method == MODE_COPY)) {
2387                     horizontal_filter(
2388                         plane_data + s->all_fragments[fragment + 1].first_pixel - 7*stride, 
2389                         stride, bounding_values);
2390                 }
2391
2392                 /* do not perform bottom edge filter for bottom row
2393                  * fragments or if bottom fragment neighbor is also coded
2394                  * in this frame (it will be filtered in the next row) */
2395                 if ((y < height - 1) &&
2396                     (s->all_fragments[fragment].coding_method != MODE_COPY) &&
2397                     (s->all_fragments[fragment + width].coding_method == MODE_COPY)) {
2398                     vertical_filter(
2399                         plane_data + s->all_fragments[fragment + width].first_pixel + stride, 
2400                         stride, bounding_values);
2401                 }
2402
2403                 fragment++;
2404 STOP_TIMER("loop filter")
2405             }
2406         }
2407     }
2408 }
2409
2410 /* 
2411  * This function computes the first pixel addresses for each fragment.
2412  * This function needs to be invoked after the first frame is allocated
2413  * so that it has access to the plane strides.
2414  */
2415 static void vp3_calculate_pixel_addresses(Vp3DecodeContext *s) 
2416 {
2417
2418     int i, x, y;
2419
2420     /* figure out the first pixel addresses for each of the fragments */
2421     /* Y plane */
2422     i = 0;
2423     for (y = s->fragment_height; y > 0; y--) {
2424         for (x = 0; x < s->fragment_width; x++) {
2425             s->all_fragments[i++].first_pixel = 
2426                 s->golden_frame.linesize[0] * y * FRAGMENT_PIXELS -
2427                     s->golden_frame.linesize[0] +
2428                     x * FRAGMENT_PIXELS;
2429             debug_init("  fragment %d, first pixel @ %d\n", 
2430                 i-1, s->all_fragments[i-1].first_pixel);
2431         }
2432     }
2433
2434     /* U plane */
2435     i = s->u_fragment_start;
2436     for (y = s->fragment_height / 2; y > 0; y--) {
2437         for (x = 0; x < s->fragment_width / 2; x++) {
2438             s->all_fragments[i++].first_pixel = 
2439                 s->golden_frame.linesize[1] * y * FRAGMENT_PIXELS -
2440                     s->golden_frame.linesize[1] +
2441                     x * FRAGMENT_PIXELS;
2442             debug_init("  fragment %d, first pixel @ %d\n", 
2443                 i-1, s->all_fragments[i-1].first_pixel);
2444         }
2445     }
2446
2447     /* V plane */
2448     i = s->v_fragment_start;
2449     for (y = s->fragment_height / 2; y > 0; y--) {
2450         for (x = 0; x < s->fragment_width / 2; x++) {
2451             s->all_fragments[i++].first_pixel = 
2452                 s->golden_frame.linesize[2] * y * FRAGMENT_PIXELS -
2453                     s->golden_frame.linesize[2] +
2454                     x * FRAGMENT_PIXELS;
2455             debug_init("  fragment %d, first pixel @ %d\n", 
2456                 i-1, s->all_fragments[i-1].first_pixel);
2457         }
2458     }
2459 }
2460
2461 /* FIXME: this should be merged with the above! */
2462 static void theora_calculate_pixel_addresses(Vp3DecodeContext *s) 
2463 {
2464
2465     int i, x, y;
2466
2467     /* figure out the first pixel addresses for each of the fragments */
2468     /* Y plane */
2469     i = 0;
2470     for (y = 1; y <= s->fragment_height; y++) {
2471         for (x = 0; x < s->fragment_width; x++) {
2472             s->all_fragments[i++].first_pixel = 
2473                 s->golden_frame.linesize[0] * y * FRAGMENT_PIXELS -
2474                     s->golden_frame.linesize[0] +
2475                     x * FRAGMENT_PIXELS;
2476             debug_init("  fragment %d, first pixel @ %d\n", 
2477                 i-1, s->all_fragments[i-1].first_pixel);
2478         }
2479     }
2480
2481     /* U plane */
2482     i = s->u_fragment_start;
2483     for (y = 1; y <= s->fragment_height / 2; y++) {
2484         for (x = 0; x < s->fragment_width / 2; x++) {
2485             s->all_fragments[i++].first_pixel = 
2486                 s->golden_frame.linesize[1] * y * FRAGMENT_PIXELS -
2487                     s->golden_frame.linesize[1] +
2488                     x * FRAGMENT_PIXELS;
2489             debug_init("  fragment %d, first pixel @ %d\n", 
2490                 i-1, s->all_fragments[i-1].first_pixel);
2491         }
2492     }
2493
2494     /* V plane */
2495     i = s->v_fragment_start;
2496     for (y = 1; y <= s->fragment_height / 2; y++) {
2497         for (x = 0; x < s->fragment_width / 2; x++) {
2498             s->all_fragments[i++].first_pixel = 
2499                 s->golden_frame.linesize[2] * y * FRAGMENT_PIXELS -
2500                     s->golden_frame.linesize[2] +
2501                     x * FRAGMENT_PIXELS;
2502             debug_init("  fragment %d, first pixel @ %d\n", 
2503                 i-1, s->all_fragments[i-1].first_pixel);
2504         }
2505     }
2506 }
2507
2508 /*
2509  * This is the ffmpeg/libavcodec API init function.
2510  */
2511 static int vp3_decode_init(AVCodecContext *avctx)
2512 {
2513     Vp3DecodeContext *s = avctx->priv_data;
2514     int i;
2515     int c_width;
2516     int c_height;
2517     int y_superblock_count;
2518     int c_superblock_count;
2519
2520     if (avctx->codec_tag == MKTAG('V','P','3','0'))
2521         s->version = 0;
2522     else
2523         s->version = 1;
2524
2525     s->avctx = avctx;
2526     s->width = (avctx->width + 15) & 0xFFFFFFF0;
2527     s->height = (avctx->height + 15) & 0xFFFFFFF0;
2528     avctx->pix_fmt = PIX_FMT_YUV420P;
2529     avctx->has_b_frames = 0;
2530     if(avctx->idct_algo==FF_IDCT_AUTO)
2531         avctx->idct_algo=FF_IDCT_VP3;
2532     dsputil_init(&s->dsp, avctx);
2533     
2534     ff_init_scantable(s->dsp.idct_permutation, &s->scantable, ff_zigzag_direct);
2535
2536     /* initialize to an impossible value which will force a recalculation
2537      * in the first frame decode */
2538     s->quality_index = -1;
2539
2540     s->y_superblock_width = (s->width + 31) / 32;
2541     s->y_superblock_height = (s->height + 31) / 32;
2542     y_superblock_count = s->y_superblock_width * s->y_superblock_height;
2543
2544     /* work out the dimensions for the C planes */
2545     c_width = s->width / 2;
2546     c_height = s->height / 2;
2547     s->c_superblock_width = (c_width + 31) / 32;
2548     s->c_superblock_height = (c_height + 31) / 32;
2549     c_superblock_count = s->c_superblock_width * s->c_superblock_height;
2550
2551     s->superblock_count = y_superblock_count + (c_superblock_count * 2);
2552     s->u_superblock_start = y_superblock_count;
2553     s->v_superblock_start = s->u_superblock_start + c_superblock_count;
2554     s->superblock_coding = av_malloc(s->superblock_count);
2555
2556     s->macroblock_width = (s->width + 15) / 16;
2557     s->macroblock_height = (s->height + 15) / 16;
2558     s->macroblock_count = s->macroblock_width * s->macroblock_height;
2559
2560     s->fragment_width = s->width / FRAGMENT_PIXELS;
2561     s->fragment_height = s->height / FRAGMENT_PIXELS;
2562
2563     /* fragment count covers all 8x8 blocks for all 3 planes */
2564     s->fragment_count = s->fragment_width * s->fragment_height * 3 / 2;
2565     s->u_fragment_start = s->fragment_width * s->fragment_height;
2566     s->v_fragment_start = s->fragment_width * s->fragment_height * 5 / 4;
2567
2568     debug_init("  Y plane: %d x %d\n", s->width, s->height);
2569     debug_init("  C plane: %d x %d\n", c_width, c_height);
2570     debug_init("  Y superblocks: %d x %d, %d total\n",
2571         s->y_superblock_width, s->y_superblock_height, y_superblock_count);
2572     debug_init("  C superblocks: %d x %d, %d total\n",
2573         s->c_superblock_width, s->c_superblock_height, c_superblock_count);
2574     debug_init("  total superblocks = %d, U starts @ %d, V starts @ %d\n", 
2575         s->superblock_count, s->u_superblock_start, s->v_superblock_start);
2576     debug_init("  macroblocks: %d x %d, %d total\n",
2577         s->macroblock_width, s->macroblock_height, s->macroblock_count);
2578     debug_init("  %d fragments, %d x %d, u starts @ %d, v starts @ %d\n",
2579         s->fragment_count,
2580         s->fragment_width,
2581         s->fragment_height,
2582         s->u_fragment_start,
2583         s->v_fragment_start);
2584
2585     s->all_fragments = av_malloc(s->fragment_count * sizeof(Vp3Fragment));
2586     s->coeffs = av_malloc(s->fragment_count * sizeof(DCTELEM) * 64);
2587     s->coded_fragment_list = av_malloc(s->fragment_count * sizeof(int));
2588     s->pixel_addresses_inited = 0;
2589
2590     if (!s->theora_tables)
2591     {
2592         for (i = 0; i < 64; i++)
2593             s->coded_dc_scale_factor[i] = vp31_dc_scale_factor[i];
2594         for (i = 0; i < 64; i++)
2595             s->coded_ac_scale_factor[i] = vp31_ac_scale_factor[i];
2596         for (i = 0; i < 64; i++)
2597             s->coded_intra_y_dequant[i] = vp31_intra_y_dequant[i];
2598         for (i = 0; i < 64; i++)
2599             s->coded_intra_c_dequant[i] = vp31_intra_c_dequant[i];
2600         for (i = 0; i < 64; i++)
2601             s->coded_inter_dequant[i] = vp31_inter_dequant[i];
2602     }
2603
2604     /* init VLC tables */
2605     for (i = 0; i < 16; i++) {
2606
2607         /* DC histograms */
2608         init_vlc(&s->dc_vlc[i], 5, 32,
2609             &dc_bias[i][0][1], 4, 2,
2610             &dc_bias[i][0][0], 4, 2, 0);
2611
2612         /* group 1 AC histograms */
2613         init_vlc(&s->ac_vlc_1[i], 5, 32,
2614             &ac_bias_0[i][0][1], 4, 2,
2615             &ac_bias_0[i][0][0], 4, 2, 0);
2616
2617         /* group 2 AC histograms */
2618         init_vlc(&s->ac_vlc_2[i], 5, 32,
2619             &ac_bias_1[i][0][1], 4, 2,
2620             &ac_bias_1[i][0][0], 4, 2, 0);
2621
2622         /* group 3 AC histograms */
2623         init_vlc(&s->ac_vlc_3[i], 5, 32,
2624             &ac_bias_2[i][0][1], 4, 2,
2625             &ac_bias_2[i][0][0], 4, 2, 0);
2626
2627         /* group 4 AC histograms */
2628         init_vlc(&s->ac_vlc_4[i], 5, 32,
2629             &ac_bias_3[i][0][1], 4, 2,
2630             &ac_bias_3[i][0][0], 4, 2, 0);
2631     }
2632
2633     init_vlc(&s->fragment_run_length_vlc, 5, 31,
2634         &fragment_run_length_vlc_table[0][1], 4, 2,
2635         &fragment_run_length_vlc_table[0][0], 4, 2, 0);
2636
2637     init_vlc(&s->mode_code_vlc, 3, 8,
2638         &mode_code_vlc_table[0][1], 2, 1,
2639         &mode_code_vlc_table[0][0], 2, 1, 0);
2640
2641     init_vlc(&s->motion_vector_vlc, 6, 63,
2642         &motion_vector_vlc_table[0][1], 2, 1,
2643         &motion_vector_vlc_table[0][0], 2, 1, 0);
2644
2645     /* work out the block mapping tables */
2646     s->superblock_fragments = av_malloc(s->superblock_count * 16 * sizeof(int));
2647     s->superblock_macroblocks = av_malloc(s->superblock_count * 4 * sizeof(int));
2648     s->macroblock_fragments = av_malloc(s->macroblock_count * 6 * sizeof(int));
2649     s->macroblock_coding = av_malloc(s->macroblock_count + 1);
2650     init_block_mapping(s);
2651
2652     for (i = 0; i < 3; i++) {
2653         s->current_frame.data[i] = NULL;
2654         s->last_frame.data[i] = NULL;
2655         s->golden_frame.data[i] = NULL;
2656     }
2657
2658     return 0;
2659 }
2660
2661 /*
2662  * This is the ffmpeg/libavcodec API frame decode function.
2663  */
2664 static int vp3_decode_frame(AVCodecContext *avctx, 
2665                             void *data, int *data_size,
2666                             uint8_t *buf, int buf_size)
2667 {
2668     Vp3DecodeContext *s = avctx->priv_data;
2669     GetBitContext gb;
2670     static int counter = 0;
2671
2672     init_get_bits(&gb, buf, buf_size * 8);
2673     
2674     if (s->theora && get_bits1(&gb))
2675     {
2676         int ptype = get_bits(&gb, 7);
2677
2678         skip_bits(&gb, 6*8); /* "theora" */
2679         
2680         switch(ptype)
2681         {
2682             case 1:
2683                 theora_decode_comments(avctx, gb);
2684                 break;
2685             case 2:
2686                 theora_decode_tables(avctx, gb);
2687                 init_dequantizer(s);
2688                 break;
2689             default:
2690                 av_log(avctx, AV_LOG_ERROR, "Unknown Theora config packet: %d\n", ptype);
2691         }
2692         return buf_size;
2693     }
2694
2695     s->keyframe = !get_bits1(&gb);
2696     if (!s->theora)
2697         skip_bits(&gb, 1);
2698     s->last_quality_index = s->quality_index;
2699     s->quality_index = get_bits(&gb, 6);
2700     if (s->theora >= 0x030200)
2701         skip_bits1(&gb);
2702
2703     if (s->avctx->debug & FF_DEBUG_PICT_INFO)
2704         av_log(s->avctx, AV_LOG_INFO, " VP3 %sframe #%d: Q index = %d\n",
2705             s->keyframe?"key":"", counter, s->quality_index);
2706     counter++;
2707
2708     if (s->quality_index != s->last_quality_index)
2709         init_dequantizer(s);
2710
2711     if (s->keyframe) {
2712         if (!s->theora)
2713         {
2714             skip_bits(&gb, 4); /* width code */
2715             skip_bits(&gb, 4); /* height code */
2716             if (s->version)
2717             {
2718                 s->version = get_bits(&gb, 5);
2719                 if (counter == 1)
2720                     av_log(s->avctx, AV_LOG_DEBUG, "VP version: %d\n", s->version);
2721             }
2722         }
2723         if (s->version || s->theora)
2724         {
2725             if (get_bits1(&gb))
2726                 av_log(s->avctx, AV_LOG_ERROR, "Warning, unsupported keyframe coding type?!\n");
2727             skip_bits(&gb, 2); /* reserved? */
2728         }
2729
2730         if (s->last_frame.data[0] == s->golden_frame.data[0]) {
2731             if (s->golden_frame.data[0])
2732                 avctx->release_buffer(avctx, &s->golden_frame);
2733             s->last_frame= s->golden_frame; /* ensure that we catch any access to this released frame */
2734         } else {
2735             if (s->golden_frame.data[0])
2736                 avctx->release_buffer(avctx, &s->golden_frame);
2737             if (s->last_frame.data[0])
2738                 avctx->release_buffer(avctx, &s->last_frame);
2739         }
2740
2741         s->golden_frame.reference = 3;
2742         if(avctx->get_buffer(avctx, &s->golden_frame) < 0) {
2743             av_log(s->avctx, AV_LOG_ERROR, "vp3: get_buffer() failed\n");
2744             return -1;
2745         }
2746
2747         /* golden frame is also the current frame */
2748         memcpy(&s->current_frame, &s->golden_frame, sizeof(AVFrame));
2749
2750         /* time to figure out pixel addresses? */
2751         if (!s->pixel_addresses_inited)
2752         {
2753             if (!s->flipped_image)
2754                 vp3_calculate_pixel_addresses(s);
2755             else
2756                 theora_calculate_pixel_addresses(s);
2757         }
2758     } else {
2759         /* allocate a new current frame */
2760         s->current_frame.reference = 3;
2761         if(avctx->get_buffer(avctx, &s->current_frame) < 0) {
2762             av_log(s->avctx, AV_LOG_ERROR, "vp3: get_buffer() failed\n");
2763             return -1;
2764         }
2765     }
2766
2767     s->current_frame.qscale_table= s->qscale_table; //FIXME allocate individual tables per AVFrame
2768     s->current_frame.qstride= 0;
2769
2770     {START_TIMER
2771     init_frame(s, &gb);
2772     STOP_TIMER("init_frame")}
2773
2774 #if KEYFRAMES_ONLY
2775 if (!s->keyframe) {
2776
2777     memcpy(s->current_frame.data[0], s->golden_frame.data[0],
2778         s->current_frame.linesize[0] * s->height);
2779     memcpy(s->current_frame.data[1], s->golden_frame.data[1],
2780         s->current_frame.linesize[1] * s->height / 2);
2781     memcpy(s->current_frame.data[2], s->golden_frame.data[2],
2782         s->current_frame.linesize[2] * s->height / 2);
2783
2784 } else {
2785 #endif
2786
2787     {START_TIMER
2788     if (unpack_superblocks(s, &gb)){
2789         av_log(s->avctx, AV_LOG_ERROR, "error in unpack_superblocks\n");
2790         return -1;
2791     }
2792     STOP_TIMER("unpack_superblocks")}
2793     {START_TIMER
2794     if (unpack_modes(s, &gb)){
2795         av_log(s->avctx, AV_LOG_ERROR, "error in unpack_modes\n");
2796         return -1;
2797     }
2798     STOP_TIMER("unpack_modes")}
2799     {START_TIMER
2800     if (unpack_vectors(s, &gb)){
2801         av_log(s->avctx, AV_LOG_ERROR, "error in unpack_vectors\n");
2802         return -1;
2803     }
2804     STOP_TIMER("unpack_vectors")}
2805     {START_TIMER
2806     if (unpack_dct_coeffs(s, &gb)){
2807         av_log(s->avctx, AV_LOG_ERROR, "error in unpack_dct_coeffs\n");
2808         return -1;
2809     }
2810     STOP_TIMER("unpack_dct_coeffs")}
2811     {START_TIMER
2812
2813     reverse_dc_prediction(s, 0, s->fragment_width, s->fragment_height);
2814     STOP_TIMER("reverse_dc_prediction")}
2815     {START_TIMER
2816     render_fragments(s, 0, s->width, s->height, 0);
2817     STOP_TIMER("render_fragments")}
2818
2819     if ((avctx->flags & CODEC_FLAG_GRAY) == 0) {
2820         reverse_dc_prediction(s, s->u_fragment_start,
2821             s->fragment_width / 2, s->fragment_height / 2);
2822         reverse_dc_prediction(s, s->v_fragment_start,
2823             s->fragment_width / 2, s->fragment_height / 2);
2824         render_fragments(s, s->u_fragment_start, s->width / 2, s->height / 2, 1);
2825         render_fragments(s, s->v_fragment_start, s->width / 2, s->height / 2, 2);
2826     } else {
2827         memset(s->current_frame.data[1], 0x80, s->width * s->height / 4);
2828         memset(s->current_frame.data[2], 0x80, s->width * s->height / 4);
2829     }
2830
2831     {START_TIMER
2832     apply_loop_filter(s);
2833     STOP_TIMER("apply_loop_filter")}
2834 #if KEYFRAMES_ONLY
2835 }
2836 #endif
2837
2838     *data_size=sizeof(AVFrame);
2839     *(AVFrame*)data= s->current_frame;
2840
2841     /* release the last frame, if it is allocated and if it is not the
2842      * golden frame */
2843     if ((s->last_frame.data[0]) &&
2844         (s->last_frame.data[0] != s->golden_frame.data[0]))
2845         avctx->release_buffer(avctx, &s->last_frame);
2846
2847     /* shuffle frames (last = current) */
2848     memcpy(&s->last_frame, &s->current_frame, sizeof(AVFrame));
2849     s->current_frame.data[0]= NULL; /* ensure that we catch any access to this released frame */
2850
2851     return buf_size;
2852 }
2853
2854 /*
2855  * This is the ffmpeg/libavcodec API module cleanup function.
2856  */
2857 static int vp3_decode_end(AVCodecContext *avctx)
2858 {
2859     Vp3DecodeContext *s = avctx->priv_data;
2860
2861     av_free(s->all_fragments);
2862     av_free(s->coeffs);
2863     av_free(s->coded_fragment_list);
2864     av_free(s->superblock_fragments);
2865     av_free(s->superblock_macroblocks);
2866     av_free(s->macroblock_fragments);
2867     av_free(s->macroblock_coding);
2868     
2869     /* release all frames */
2870     if (s->golden_frame.data[0] && s->golden_frame.data[0] != s->last_frame.data[0])
2871         avctx->release_buffer(avctx, &s->golden_frame);
2872     if (s->last_frame.data[0])
2873         avctx->release_buffer(avctx, &s->last_frame);
2874     /* no need to release the current_frame since it will always be pointing
2875      * to the same frame as either the golden or last frame */
2876
2877     return 0;
2878 }
2879
2880 static int theora_decode_header(AVCodecContext *avctx, GetBitContext gb)
2881 {
2882     Vp3DecodeContext *s = avctx->priv_data;
2883     int major, minor, micro;
2884
2885     major = get_bits(&gb, 8); /* version major */
2886     minor = get_bits(&gb, 8); /* version minor */
2887     micro = get_bits(&gb, 8); /* version micro */
2888     av_log(avctx, AV_LOG_INFO, "Theora bitstream version %d.%d.%d\n",
2889         major, minor, micro);
2890
2891     /* FIXME: endianess? */
2892     s->theora = (major << 16) | (minor << 8) | micro;
2893
2894     /* 3.2.0 aka alpha3 has the same frame orientation as original vp3 */
2895     /* but previous versions have the image flipped relative to vp3 */
2896     if (s->theora < 0x030200)
2897     {
2898         s->flipped_image = 1;
2899         av_log(avctx, AV_LOG_DEBUG, "Old (<alpha3) Theora bitstream, flipped image\n");
2900     }
2901
2902     s->width = get_bits(&gb, 16) << 4;
2903     s->height = get_bits(&gb, 16) << 4;
2904     
2905     if(avcodec_check_dimensions(avctx, s->width, s->height)){
2906         s->width= s->height= 0;
2907         return -1;
2908     }
2909     
2910     skip_bits(&gb, 24); /* frame width */
2911     skip_bits(&gb, 24); /* frame height */
2912
2913     skip_bits(&gb, 8); /* offset x */
2914     skip_bits(&gb, 8); /* offset y */
2915
2916     skip_bits(&gb, 32); /* fps numerator */
2917     skip_bits(&gb, 32); /* fps denumerator */
2918     skip_bits(&gb, 24); /* aspect numerator */
2919     skip_bits(&gb, 24); /* aspect denumerator */
2920     
2921     if (s->theora < 0x030200)
2922         skip_bits(&gb, 5); /* keyframe frequency force */
2923     skip_bits(&gb, 8); /* colorspace */
2924     skip_bits(&gb, 24); /* bitrate */
2925
2926     skip_bits(&gb, 6); /* last(?) quality index */
2927     
2928     if (s->theora >= 0x030200)
2929     {
2930         skip_bits(&gb, 5); /* keyframe frequency force */
2931         skip_bits(&gb, 5); /* spare bits */
2932     }
2933     
2934 //    align_get_bits(&gb);
2935     
2936     avctx->width = s->width;
2937     avctx->height = s->height;
2938
2939     return 0;
2940 }
2941
2942 static int theora_decode_comments(AVCodecContext *avctx, GetBitContext gb)
2943 {
2944     int nb_comments, i, tmp;
2945
2946     tmp = get_bits_long(&gb, 32);
2947     tmp = be2me_32(tmp);
2948     while(tmp--)
2949             skip_bits(&gb, 8);
2950
2951     nb_comments = get_bits_long(&gb, 32);
2952     nb_comments = be2me_32(nb_comments);
2953     for (i = 0; i < nb_comments; i++)
2954     {
2955         tmp = get_bits_long(&gb, 32);
2956         tmp = be2me_32(tmp);
2957         while(tmp--)
2958             skip_bits(&gb, 8);
2959     }
2960     
2961     return 0;
2962 }
2963
2964 static int theora_decode_tables(AVCodecContext *avctx, GetBitContext gb)
2965 {
2966     Vp3DecodeContext *s = avctx->priv_data;
2967     int i, n;
2968
2969     if (s->theora >= 0x030200) {
2970         n = get_bits(&gb, 3);
2971         /* loop filter table */
2972         for (i = 0; i < 64; i++)
2973             skip_bits(&gb, n);
2974     }
2975     
2976     if (s->theora >= 0x030200)
2977         n = get_bits(&gb, 4) + 1;
2978     else
2979         n = 16;
2980     /* quality threshold table */
2981     for (i = 0; i < 64; i++)
2982         s->coded_ac_scale_factor[i] = get_bits(&gb, n);
2983
2984     if (s->theora >= 0x030200)
2985         n = get_bits(&gb, 4) + 1;
2986     else
2987         n = 16;
2988     /* dc scale factor table */
2989     for (i = 0; i < 64; i++)
2990         s->coded_dc_scale_factor[i] = get_bits(&gb, n);
2991
2992     if (s->theora >= 0x030200)
2993         n = get_bits(&gb, 9) + 1;
2994     else
2995         n = 3;
2996     if (n != 3) {
2997         av_log(NULL,AV_LOG_ERROR, "unsupported nbms : %d\n", n);
2998         return -1;
2999     }
3000     /* y coeffs */
3001     for (i = 0; i < 64; i++)
3002         s->coded_intra_y_dequant[i] = get_bits(&gb, 8);
3003
3004     /* uv coeffs */
3005     for (i = 0; i < 64; i++)
3006         s->coded_intra_c_dequant[i] = get_bits(&gb, 8);
3007
3008     /* inter coeffs */
3009     for (i = 0; i < 64; i++)
3010         s->coded_inter_dequant[i] = get_bits(&gb, 8);
3011
3012     /* FIXME: read huffmann tree.. */
3013     
3014     s->theora_tables = 1;
3015     
3016     return 0;
3017 }
3018
3019 static int theora_decode_init(AVCodecContext *avctx)
3020 {
3021     Vp3DecodeContext *s = avctx->priv_data;
3022     GetBitContext gb;
3023     int ptype;
3024     uint8_t *p= avctx->extradata;
3025     int op_bytes, i;
3026     
3027     s->theora = 1;
3028
3029     if (!avctx->extradata_size)
3030         return -1;
3031
3032   for(i=0;i<3;i++) {
3033     op_bytes = *(p++)<<8;
3034     op_bytes += *(p++);
3035
3036     init_get_bits(&gb, p, op_bytes);
3037     p += op_bytes;
3038
3039     ptype = get_bits(&gb, 8);
3040     debug_vp3("Theora headerpacket type: %x\n", ptype);
3041             
3042     if (!(ptype & 0x80))
3043         return -1;
3044         
3045     skip_bits(&gb, 6*8); /* "theora" */
3046         
3047     switch(ptype)
3048     {
3049         case 0x80:
3050             theora_decode_header(avctx, gb);
3051             break;
3052         case 0x81:
3053             theora_decode_comments(avctx, gb);
3054             break;
3055         case 0x82:
3056             theora_decode_tables(avctx, gb);
3057             break;
3058     }
3059   }
3060
3061     vp3_decode_init(avctx);
3062     return 0;
3063 }
3064
3065 AVCodec vp3_decoder = {
3066     "vp3",
3067     CODEC_TYPE_VIDEO,
3068     CODEC_ID_VP3,
3069     sizeof(Vp3DecodeContext),
3070     vp3_decode_init,
3071     NULL,
3072     vp3_decode_end,
3073     vp3_decode_frame,
3074     0,
3075     NULL
3076 };
3077
3078 #ifndef CONFIG_LIBTHEORA
3079 AVCodec theora_decoder = {
3080     "theora",
3081     CODEC_TYPE_VIDEO,
3082     CODEC_ID_THEORA,
3083     sizeof(Vp3DecodeContext),
3084     theora_decode_init,
3085     NULL,
3086     vp3_decode_end,
3087     vp3_decode_frame,
3088     0,
3089     NULL
3090 };
3091 #endif