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