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