Remove redundant #inclusion of common.h, avcodec.h already #includes it.
[ffmpeg.git] / libavcodec / truemotion1.c
1 /*
2  * Duck TrueMotion 1.0 Decoder
3  * Copyright (C) 2003 Alex Beregszaszi & Mike Melanson
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file truemotion1.c
24  * Duck TrueMotion v1 Video Decoder by
25  * Alex Beregszaszi and
26  * Mike Melanson (melanson@pcisys.net)
27  *
28  * The TrueMotion v1 decoder presently only decodes 16-bit TM1 data and
29  * outputs RGB555 (or RGB565) data. 24-bit TM1 data is not supported yet.
30  */
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <unistd.h>
36
37 #include "avcodec.h"
38 #include "dsputil.h"
39
40 #include "truemotion1data.h"
41
42 typedef struct TrueMotion1Context {
43     AVCodecContext *avctx;
44     AVFrame frame;
45     AVFrame prev_frame;
46
47     uint8_t *buf;
48     int size;
49
50     uint8_t *mb_change_bits;
51     int mb_change_bits_row_size;
52     uint8_t *index_stream;
53     int index_stream_size;
54
55     int flags;
56     int x, y, w, h;
57
58     uint32_t y_predictor_table[1024];
59     uint32_t c_predictor_table[1024];
60     uint32_t fat_y_predictor_table[1024];
61     uint32_t fat_c_predictor_table[1024];
62
63     int compression;
64     int block_type;
65     int block_width;
66     int block_height;
67
68     int16_t ydt[8];
69     int16_t cdt[8];
70     int16_t fat_ydt[8];
71     int16_t fat_cdt[8];
72
73     int last_deltaset, last_vectable;
74
75     unsigned int *vert_pred;
76
77 } TrueMotion1Context;
78
79 #define FLAG_SPRITE         32
80 #define FLAG_KEYFRAME       16
81 #define FLAG_INTERFRAME      8
82 #define FLAG_INTERPOLATED    4
83
84 struct frame_header {
85     uint8_t header_size;
86     uint8_t compression;
87     uint8_t deltaset;
88     uint8_t vectable;
89     uint16_t ysize;
90     uint16_t xsize;
91     uint16_t checksum;
92     uint8_t version;
93     uint8_t header_type;
94     uint8_t flags;
95     uint8_t control;
96     uint16_t xoffset;
97     uint16_t yoffset;
98     uint16_t width;
99     uint16_t height;
100 };
101
102 #define ALGO_NOP        0
103 #define ALGO_RGB16V     1
104 #define ALGO_RGB16H     2
105 #define ALGO_RGB24H     3
106
107 /* these are the various block sizes that can occupy a 4x4 block */
108 #define BLOCK_2x2  0
109 #define BLOCK_2x4  1
110 #define BLOCK_4x2  2
111 #define BLOCK_4x4  3
112
113 typedef struct comp_types {
114     int algorithm;
115     int block_width; // vres
116     int block_height; // hres
117     int block_type;
118 } comp_types;
119
120 /* { valid for metatype }, algorithm, num of deltas, vert res, horiz res */
121 static comp_types compression_types[17] = {
122     { ALGO_NOP,    0, 0, 0 },
123
124     { ALGO_RGB16V, 4, 4, BLOCK_4x4 },
125     { ALGO_RGB16H, 4, 4, BLOCK_4x4 },
126     { ALGO_RGB16V, 4, 2, BLOCK_4x2 },
127     { ALGO_RGB16H, 4, 2, BLOCK_4x2 },
128
129     { ALGO_RGB16V, 2, 4, BLOCK_2x4 },
130     { ALGO_RGB16H, 2, 4, BLOCK_2x4 },
131     { ALGO_RGB16V, 2, 2, BLOCK_2x2 },
132     { ALGO_RGB16H, 2, 2, BLOCK_2x2 },
133
134     { ALGO_NOP,    4, 4, BLOCK_4x4 },
135     { ALGO_RGB24H, 4, 4, BLOCK_4x4 },
136     { ALGO_NOP,    4, 2, BLOCK_4x2 },
137     { ALGO_RGB24H, 4, 2, BLOCK_4x2 },
138
139     { ALGO_NOP,    2, 4, BLOCK_2x4 },
140     { ALGO_RGB24H, 2, 4, BLOCK_2x4 },
141     { ALGO_NOP,    2, 2, BLOCK_2x2 },
142     { ALGO_RGB24H, 2, 2, BLOCK_2x2 }
143 };
144
145 static void select_delta_tables(TrueMotion1Context *s, int delta_table_index)
146 {
147     int i;
148
149     if (delta_table_index > 3)
150         return;
151
152     memcpy(s->ydt, ydts[delta_table_index], 8 * sizeof(int16_t));
153     memcpy(s->cdt, cdts[delta_table_index], 8 * sizeof(int16_t));
154     memcpy(s->fat_ydt, fat_ydts[delta_table_index], 8 * sizeof(int16_t));
155     memcpy(s->fat_cdt, fat_cdts[delta_table_index], 8 * sizeof(int16_t));
156
157     /* Y skinny deltas need to be halved for some reason; maybe the
158      * skinny Y deltas should be modified */
159     for (i = 0; i < 8; i++)
160     {
161         /* drop the lsb before dividing by 2-- net effect: round down
162          * when dividing a negative number (e.g., -3/2 = -2, not -1) */
163         s->ydt[i] &= 0xFFFE;
164         s->ydt[i] /= 2;
165     }
166 }
167
168 #ifdef WORDS_BIGENDIAN
169 static int make_ydt15_entry(int p2, int p1, int16_t *ydt)
170 #else
171 static int make_ydt15_entry(int p1, int p2, int16_t *ydt)
172 #endif
173 {
174     int lo, hi;
175
176     lo = ydt[p1];
177     lo += (lo << 5) + (lo << 10);
178     hi = ydt[p2];
179     hi += (hi << 5) + (hi << 10);
180     return ((lo + (hi << 16)) << 1);
181 }
182
183 #ifdef WORDS_BIGENDIAN
184 static int make_cdt15_entry(int p2, int p1, int16_t *cdt)
185 #else
186 static int make_cdt15_entry(int p1, int p2, int16_t *cdt)
187 #endif
188 {
189     int r, b, lo;
190
191     b = cdt[p2];
192     r = cdt[p1] << 10;
193     lo = b + r;
194     return ((lo + (lo << 16)) << 1);
195 }
196
197 #ifdef WORDS_BIGENDIAN
198 static int make_ydt16_entry(int p2, int p1, int16_t *ydt)
199 #else
200 static int make_ydt16_entry(int p1, int p2, int16_t *ydt)
201 #endif
202 {
203     int lo, hi;
204
205     lo = ydt[p1];
206     lo += (lo << 6) + (lo << 11);
207     hi = ydt[p2];
208     hi += (hi << 6) + (hi << 11);
209     return ((lo + (hi << 16)) << 1);
210 }
211
212 #ifdef WORDS_BIGENDIAN
213 static int make_cdt16_entry(int p2, int p1, int16_t *cdt)
214 #else
215 static int make_cdt16_entry(int p1, int p2, int16_t *cdt)
216 #endif
217 {
218     int r, b, lo;
219
220     b = cdt[p2];
221     r = cdt[p1] << 11;
222     lo = b + r;
223     return ((lo + (lo << 16)) << 1);
224 }
225
226 #ifdef WORDS_BIGENDIAN
227 static int make_ydt24_entry(int p2, int p1, int16_t *ydt)
228 #else
229 static int make_ydt24_entry(int p1, int p2, int16_t *ydt)
230 #endif
231 {
232     int lo, hi;
233
234     lo = ydt[p1];
235     hi = ydt[p2];
236     return ((lo + (hi << 8) + (hi << 16)) << 1);
237 }
238
239 #ifdef WORDS_BIGENDIAN
240 static int make_cdt24_entry(int p2, int p1, int16_t *cdt)
241 #else
242 static int make_cdt24_entry(int p1, int p2, int16_t *cdt)
243 #endif
244 {
245     int r, b;
246
247     b = cdt[p2];
248     r = cdt[p1]<<16;
249     return ((b+r) << 1);
250 }
251
252 static void gen_vector_table15(TrueMotion1Context *s, const uint8_t *sel_vector_table)
253 {
254     int len, i, j;
255     unsigned char delta_pair;
256
257     for (i = 0; i < 1024; i += 4)
258     {
259         len = *sel_vector_table++ / 2;
260         for (j = 0; j < len; j++)
261         {
262             delta_pair = *sel_vector_table++;
263             s->y_predictor_table[i+j] = 0xfffffffe &
264                 make_ydt15_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
265             s->c_predictor_table[i+j] = 0xfffffffe &
266                 make_cdt15_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
267         }
268         s->y_predictor_table[i+(j-1)] |= 1;
269         s->c_predictor_table[i+(j-1)] |= 1;
270     }
271 }
272
273 static void gen_vector_table16(TrueMotion1Context *s, const uint8_t *sel_vector_table)
274 {
275     int len, i, j;
276     unsigned char delta_pair;
277
278     for (i = 0; i < 1024; i += 4)
279     {
280         len = *sel_vector_table++ / 2;
281         for (j = 0; j < len; j++)
282         {
283             delta_pair = *sel_vector_table++;
284             s->y_predictor_table[i+j] = 0xfffffffe &
285                 make_ydt16_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
286             s->c_predictor_table[i+j] = 0xfffffffe &
287                 make_cdt16_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
288         }
289         s->y_predictor_table[i+(j-1)] |= 1;
290         s->c_predictor_table[i+(j-1)] |= 1;
291     }
292 }
293
294 static void gen_vector_table24(TrueMotion1Context *s, const uint8_t *sel_vector_table)
295 {
296     int len, i, j;
297     unsigned char delta_pair;
298
299     for (i = 0; i < 1024; i += 4)
300     {
301         len = *sel_vector_table++ / 2;
302         for (j = 0; j < len; j++)
303         {
304             delta_pair = *sel_vector_table++;
305             s->y_predictor_table[i+j] = 0xfffffffe &
306                 make_ydt24_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
307             s->c_predictor_table[i+j] = 0xfffffffe &
308                 make_cdt24_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
309             s->fat_y_predictor_table[i+j] = 0xfffffffe &
310                 make_ydt24_entry(delta_pair >> 4, delta_pair & 0xf, s->fat_ydt);
311             s->fat_c_predictor_table[i+j] = 0xfffffffe &
312                 make_cdt24_entry(delta_pair >> 4, delta_pair & 0xf, s->fat_cdt);
313         }
314         s->y_predictor_table[i+(j-1)] |= 1;
315         s->c_predictor_table[i+(j-1)] |= 1;
316         s->fat_y_predictor_table[i+(j-1)] |= 1;
317         s->fat_c_predictor_table[i+(j-1)] |= 1;
318     }
319 }
320
321 /* Returns the number of bytes consumed from the bytestream. Returns -1 if
322  * there was an error while decoding the header */
323 static int truemotion1_decode_header(TrueMotion1Context *s)
324 {
325     int i;
326     struct frame_header header;
327     uint8_t header_buffer[128];  /* logical maximum size of the header */
328     const uint8_t *sel_vector_table;
329
330     /* There is 1 change bit per 4 pixels, so each change byte represents
331      * 32 pixels; divide width by 4 to obtain the number of change bits and
332      * then round up to the nearest byte. */
333     s->mb_change_bits_row_size = ((s->avctx->width >> 2) + 7) >> 3;
334
335     header.header_size = ((s->buf[0] >> 5) | (s->buf[0] << 3)) & 0x7f;
336     if (s->buf[0] < 0x10)
337     {
338         av_log(s->avctx, AV_LOG_ERROR, "invalid header size (%d)\n", s->buf[0]);
339         return -1;
340     }
341
342     /* unscramble the header bytes with a XOR operation */
343     memset(header_buffer, 0, 128);
344     for (i = 1; i < header.header_size; i++)
345         header_buffer[i - 1] = s->buf[i] ^ s->buf[i + 1];
346
347     header.compression = header_buffer[0];
348     header.deltaset = header_buffer[1];
349     header.vectable = header_buffer[2];
350     header.ysize = AV_RL16(&header_buffer[3]);
351     header.xsize = AV_RL16(&header_buffer[5]);
352     header.checksum = AV_RL16(&header_buffer[7]);
353     header.version = header_buffer[9];
354     header.header_type = header_buffer[10];
355     header.flags = header_buffer[11];
356     header.control = header_buffer[12];
357
358     /* Version 2 */
359     if (header.version >= 2)
360     {
361         if (header.header_type > 3)
362         {
363             av_log(s->avctx, AV_LOG_ERROR, "invalid header type (%d)\n", header.header_type);
364             return -1;
365         } else if ((header.header_type == 2) || (header.header_type == 3)) {
366             s->flags = header.flags;
367             if (!(s->flags & FLAG_INTERFRAME))
368                 s->flags |= FLAG_KEYFRAME;
369         } else
370             s->flags = FLAG_KEYFRAME;
371     } else /* Version 1 */
372         s->flags = FLAG_KEYFRAME;
373
374     if (s->flags & FLAG_SPRITE) {
375         av_log(s->avctx, AV_LOG_INFO, "SPRITE frame found, please report the sample to the developers\n");
376         /* FIXME header.width, height, xoffset and yoffset aren't initialized */
377 #if 0
378         s->w = header.width;
379         s->h = header.height;
380         s->x = header.xoffset;
381         s->y = header.yoffset;
382 #else
383         return -1;
384 #endif
385     } else {
386         s->w = header.xsize;
387         s->h = header.ysize;
388         if (header.header_type < 2) {
389             if ((s->w < 213) && (s->h >= 176))
390             {
391                 s->flags |= FLAG_INTERPOLATED;
392                 av_log(s->avctx, AV_LOG_INFO, "INTERPOLATION selected, please report the sample to the developers\n");
393             }
394         }
395     }
396
397     if (header.compression > 17) {
398         av_log(s->avctx, AV_LOG_ERROR, "invalid compression type (%d)\n", header.compression);
399         return -1;
400     }
401
402     if ((header.deltaset != s->last_deltaset) ||
403         (header.vectable != s->last_vectable))
404         select_delta_tables(s, header.deltaset);
405
406     if ((header.compression & 1) && header.header_type)
407         sel_vector_table = pc_tbl2;
408     else {
409         if (header.vectable < 4)
410             sel_vector_table = tables[header.vectable - 1];
411         else {
412             av_log(s->avctx, AV_LOG_ERROR, "invalid vector table id (%d)\n", header.vectable);
413             return -1;
414         }
415     }
416
417     // FIXME: where to place this ?!?!
418     if (compression_types[header.compression].algorithm == ALGO_RGB24H)
419         s->avctx->pix_fmt = PIX_FMT_RGB32;
420     else
421         s->avctx->pix_fmt = PIX_FMT_RGB555; // RGB565 is supported as well
422
423     if ((header.deltaset != s->last_deltaset) || (header.vectable != s->last_vectable))
424     {
425         if (compression_types[header.compression].algorithm == ALGO_RGB24H)
426             gen_vector_table24(s, sel_vector_table);
427         else
428         if (s->avctx->pix_fmt == PIX_FMT_RGB555)
429             gen_vector_table15(s, sel_vector_table);
430         else
431             gen_vector_table16(s, sel_vector_table);
432     }
433
434     /* set up pointers to the other key data chunks */
435     s->mb_change_bits = s->buf + header.header_size;
436     if (s->flags & FLAG_KEYFRAME) {
437         /* no change bits specified for a keyframe; only index bytes */
438         s->index_stream = s->mb_change_bits;
439     } else {
440         /* one change bit per 4x4 block */
441         s->index_stream = s->mb_change_bits +
442             (s->mb_change_bits_row_size * (s->avctx->height >> 2));
443     }
444     s->index_stream_size = s->size - (s->index_stream - s->buf);
445
446     s->last_deltaset = header.deltaset;
447     s->last_vectable = header.vectable;
448     s->compression = header.compression;
449     s->block_width = compression_types[header.compression].block_width;
450     s->block_height = compression_types[header.compression].block_height;
451     s->block_type = compression_types[header.compression].block_type;
452
453     if (s->avctx->debug & FF_DEBUG_PICT_INFO)
454         av_log(s->avctx, AV_LOG_INFO, "tables: %d / %d c:%d %dx%d t:%d %s%s%s%s\n",
455             s->last_deltaset, s->last_vectable, s->compression, s->block_width,
456             s->block_height, s->block_type,
457             s->flags & FLAG_KEYFRAME ? " KEY" : "",
458             s->flags & FLAG_INTERFRAME ? " INTER" : "",
459             s->flags & FLAG_SPRITE ? " SPRITE" : "",
460             s->flags & FLAG_INTERPOLATED ? " INTERPOL" : "");
461
462     return header.header_size;
463 }
464
465 static int truemotion1_decode_init(AVCodecContext *avctx)
466 {
467     TrueMotion1Context *s = avctx->priv_data;
468
469     s->avctx = avctx;
470
471     // FIXME: it may change ?
472 //    if (avctx->bits_per_sample == 24)
473 //        avctx->pix_fmt = PIX_FMT_RGB24;
474 //    else
475 //        avctx->pix_fmt = PIX_FMT_RGB555;
476
477     s->frame.data[0] = s->prev_frame.data[0] = NULL;
478
479     /* there is a vertical predictor for each pixel in a line; each vertical
480      * predictor is 0 to start with */
481     s->vert_pred =
482         (unsigned int *)av_malloc(s->avctx->width * sizeof(unsigned int));
483
484     return 0;
485 }
486
487 /*
488 Block decoding order:
489
490 dxi: Y-Y
491 dxic: Y-C-Y
492 dxic2: Y-C-Y-C
493
494 hres,vres,i,i%vres (0 < i < 4)
495 2x2 0: 0 dxic2
496 2x2 1: 1 dxi
497 2x2 2: 0 dxic2
498 2x2 3: 1 dxi
499 2x4 0: 0 dxic2
500 2x4 1: 1 dxi
501 2x4 2: 2 dxi
502 2x4 3: 3 dxi
503 4x2 0: 0 dxic
504 4x2 1: 1 dxi
505 4x2 2: 0 dxic
506 4x2 3: 1 dxi
507 4x4 0: 0 dxic
508 4x4 1: 1 dxi
509 4x4 2: 2 dxi
510 4x4 3: 3 dxi
511 */
512
513 #define GET_NEXT_INDEX() \
514 {\
515     if (index_stream_index >= s->index_stream_size) { \
516         av_log(s->avctx, AV_LOG_INFO, " help! truemotion1 decoder went out of bounds\n"); \
517         return; \
518     } \
519     index = s->index_stream[index_stream_index++] * 4; \
520 }
521
522 #define APPLY_C_PREDICTOR() \
523     predictor_pair = s->c_predictor_table[index]; \
524     horiz_pred += (predictor_pair >> 1); \
525     if (predictor_pair & 1) { \
526         GET_NEXT_INDEX() \
527         if (!index) { \
528             GET_NEXT_INDEX() \
529             predictor_pair = s->c_predictor_table[index]; \
530             horiz_pred += ((predictor_pair >> 1) * 5); \
531             if (predictor_pair & 1) \
532                 GET_NEXT_INDEX() \
533             else \
534                 index++; \
535         } \
536     } else \
537         index++;
538
539 #define APPLY_C_PREDICTOR_24() \
540     predictor_pair = s->c_predictor_table[index]; \
541     horiz_pred += (predictor_pair >> 1); \
542     if (predictor_pair & 1) { \
543         GET_NEXT_INDEX() \
544         if (!index) { \
545             GET_NEXT_INDEX() \
546             predictor_pair = s->fat_c_predictor_table[index]; \
547             horiz_pred += (predictor_pair >> 1); \
548             if (predictor_pair & 1) \
549                 GET_NEXT_INDEX() \
550             else \
551                 index++; \
552         } \
553     } else \
554         index++;
555
556
557 #define APPLY_Y_PREDICTOR() \
558     predictor_pair = s->y_predictor_table[index]; \
559     horiz_pred += (predictor_pair >> 1); \
560     if (predictor_pair & 1) { \
561         GET_NEXT_INDEX() \
562         if (!index) { \
563             GET_NEXT_INDEX() \
564             predictor_pair = s->y_predictor_table[index]; \
565             horiz_pred += ((predictor_pair >> 1) * 5); \
566             if (predictor_pair & 1) \
567                 GET_NEXT_INDEX() \
568             else \
569                 index++; \
570         } \
571     } else \
572         index++;
573
574 #define APPLY_Y_PREDICTOR_24() \
575     predictor_pair = s->y_predictor_table[index]; \
576     horiz_pred += (predictor_pair >> 1); \
577     if (predictor_pair & 1) { \
578         GET_NEXT_INDEX() \
579         if (!index) { \
580             GET_NEXT_INDEX() \
581             predictor_pair = s->fat_y_predictor_table[index]; \
582             horiz_pred += (predictor_pair >> 1); \
583             if (predictor_pair & 1) \
584                 GET_NEXT_INDEX() \
585             else \
586                 index++; \
587         } \
588     } else \
589         index++;
590
591 #define OUTPUT_PIXEL_PAIR() \
592     *current_pixel_pair = *vert_pred + horiz_pred; \
593     *vert_pred++ = *current_pixel_pair++; \
594     prev_pixel_pair++;
595
596 static void truemotion1_decode_16bit(TrueMotion1Context *s)
597 {
598     int y;
599     int pixels_left;  /* remaining pixels on this line */
600     unsigned int predictor_pair;
601     unsigned int horiz_pred;
602     unsigned int *vert_pred;
603     unsigned int *current_pixel_pair;
604     unsigned int *prev_pixel_pair;
605     unsigned char *current_line = s->frame.data[0];
606     unsigned char *prev_line = s->prev_frame.data[0];
607     int keyframe = s->flags & FLAG_KEYFRAME;
608
609     /* these variables are for managing the stream of macroblock change bits */
610     unsigned char *mb_change_bits = s->mb_change_bits;
611     unsigned char mb_change_byte;
612     unsigned char mb_change_byte_mask;
613     int mb_change_index;
614
615     /* these variables are for managing the main index stream */
616     int index_stream_index = 0;  /* yes, the index into the index stream */
617     int index;
618
619     /* clean out the line buffer */
620     memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
621
622     GET_NEXT_INDEX();
623
624     for (y = 0; y < s->avctx->height; y++) {
625
626         /* re-init variables for the next line iteration */
627         horiz_pred = 0;
628         current_pixel_pair = (unsigned int *)current_line;
629         prev_pixel_pair = (unsigned int *)prev_line;
630         vert_pred = s->vert_pred;
631         mb_change_index = 0;
632         mb_change_byte = mb_change_bits[mb_change_index++];
633         mb_change_byte_mask = 0x01;
634         pixels_left = s->avctx->width;
635
636         while (pixels_left > 0) {
637
638             if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
639
640                 switch (y & 3) {
641                 case 0:
642                     /* if macroblock width is 2, apply C-Y-C-Y; else
643                      * apply C-Y-Y */
644                     if (s->block_width == 2) {
645                         APPLY_C_PREDICTOR();
646                         APPLY_Y_PREDICTOR();
647                         OUTPUT_PIXEL_PAIR();
648                         APPLY_C_PREDICTOR();
649                         APPLY_Y_PREDICTOR();
650                         OUTPUT_PIXEL_PAIR();
651                     } else {
652                         APPLY_C_PREDICTOR();
653                         APPLY_Y_PREDICTOR();
654                         OUTPUT_PIXEL_PAIR();
655                         APPLY_Y_PREDICTOR();
656                         OUTPUT_PIXEL_PAIR();
657                     }
658                     break;
659
660                 case 1:
661                 case 3:
662                     /* always apply 2 Y predictors on these iterations */
663                     APPLY_Y_PREDICTOR();
664                     OUTPUT_PIXEL_PAIR();
665                     APPLY_Y_PREDICTOR();
666                     OUTPUT_PIXEL_PAIR();
667                     break;
668
669                 case 2:
670                     /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
671                      * depending on the macroblock type */
672                     if (s->block_type == BLOCK_2x2) {
673                         APPLY_C_PREDICTOR();
674                         APPLY_Y_PREDICTOR();
675                         OUTPUT_PIXEL_PAIR();
676                         APPLY_C_PREDICTOR();
677                         APPLY_Y_PREDICTOR();
678                         OUTPUT_PIXEL_PAIR();
679                     } else if (s->block_type == BLOCK_4x2) {
680                         APPLY_C_PREDICTOR();
681                         APPLY_Y_PREDICTOR();
682                         OUTPUT_PIXEL_PAIR();
683                         APPLY_Y_PREDICTOR();
684                         OUTPUT_PIXEL_PAIR();
685                     } else {
686                         APPLY_Y_PREDICTOR();
687                         OUTPUT_PIXEL_PAIR();
688                         APPLY_Y_PREDICTOR();
689                         OUTPUT_PIXEL_PAIR();
690                     }
691                     break;
692                 }
693
694             } else {
695
696                 /* skip (copy) four pixels, but reassign the horizontal
697                  * predictor */
698                 *current_pixel_pair = *prev_pixel_pair++;
699                 *vert_pred++ = *current_pixel_pair++;
700                 *current_pixel_pair = *prev_pixel_pair++;
701                 horiz_pred = *current_pixel_pair - *vert_pred;
702                 *vert_pred++ = *current_pixel_pair++;
703
704             }
705
706             if (!keyframe) {
707                 mb_change_byte_mask <<= 1;
708
709                 /* next byte */
710                 if (!mb_change_byte_mask) {
711                     mb_change_byte = mb_change_bits[mb_change_index++];
712                     mb_change_byte_mask = 0x01;
713                 }
714             }
715
716             pixels_left -= 4;
717         }
718
719         /* next change row */
720         if (((y + 1) & 3) == 0)
721             mb_change_bits += s->mb_change_bits_row_size;
722
723         current_line += s->frame.linesize[0];
724         prev_line += s->prev_frame.linesize[0];
725     }
726 }
727
728 static void truemotion1_decode_24bit(TrueMotion1Context *s)
729 {
730     int y;
731     int pixels_left;  /* remaining pixels on this line */
732     unsigned int predictor_pair;
733     unsigned int horiz_pred;
734     unsigned int *vert_pred;
735     unsigned int *current_pixel_pair;
736     unsigned int *prev_pixel_pair;
737     unsigned char *current_line = s->frame.data[0];
738     unsigned char *prev_line = s->prev_frame.data[0];
739     int keyframe = s->flags & FLAG_KEYFRAME;
740
741     /* these variables are for managing the stream of macroblock change bits */
742     unsigned char *mb_change_bits = s->mb_change_bits;
743     unsigned char mb_change_byte;
744     unsigned char mb_change_byte_mask;
745     int mb_change_index;
746
747     /* these variables are for managing the main index stream */
748     int index_stream_index = 0;  /* yes, the index into the index stream */
749     int index;
750
751     /* clean out the line buffer */
752     memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
753
754     GET_NEXT_INDEX();
755
756     for (y = 0; y < s->avctx->height; y++) {
757
758         /* re-init variables for the next line iteration */
759         horiz_pred = 0;
760         current_pixel_pair = (unsigned int *)current_line;
761         prev_pixel_pair = (unsigned int *)prev_line;
762         vert_pred = s->vert_pred;
763         mb_change_index = 0;
764         mb_change_byte = mb_change_bits[mb_change_index++];
765         mb_change_byte_mask = 0x01;
766         pixels_left = s->avctx->width;
767
768         while (pixels_left > 0) {
769
770             if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
771
772                 switch (y & 3) {
773                 case 0:
774                     /* if macroblock width is 2, apply C-Y-C-Y; else
775                      * apply C-Y-Y */
776                     if (s->block_width == 2) {
777                         APPLY_C_PREDICTOR_24();
778                         APPLY_Y_PREDICTOR_24();
779                         OUTPUT_PIXEL_PAIR();
780                         APPLY_C_PREDICTOR_24();
781                         APPLY_Y_PREDICTOR_24();
782                         OUTPUT_PIXEL_PAIR();
783                     } else {
784                         APPLY_C_PREDICTOR_24();
785                         APPLY_Y_PREDICTOR_24();
786                         OUTPUT_PIXEL_PAIR();
787                         APPLY_Y_PREDICTOR_24();
788                         OUTPUT_PIXEL_PAIR();
789                     }
790                     break;
791
792                 case 1:
793                 case 3:
794                     /* always apply 2 Y predictors on these iterations */
795                     APPLY_Y_PREDICTOR_24();
796                     OUTPUT_PIXEL_PAIR();
797                     APPLY_Y_PREDICTOR_24();
798                     OUTPUT_PIXEL_PAIR();
799                     break;
800
801                 case 2:
802                     /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
803                      * depending on the macroblock type */
804                     if (s->block_type == BLOCK_2x2) {
805                         APPLY_C_PREDICTOR_24();
806                         APPLY_Y_PREDICTOR_24();
807                         OUTPUT_PIXEL_PAIR();
808                         APPLY_C_PREDICTOR_24();
809                         APPLY_Y_PREDICTOR_24();
810                         OUTPUT_PIXEL_PAIR();
811                     } else if (s->block_type == BLOCK_4x2) {
812                         APPLY_C_PREDICTOR_24();
813                         APPLY_Y_PREDICTOR_24();
814                         OUTPUT_PIXEL_PAIR();
815                         APPLY_Y_PREDICTOR_24();
816                         OUTPUT_PIXEL_PAIR();
817                     } else {
818                         APPLY_Y_PREDICTOR_24();
819                         OUTPUT_PIXEL_PAIR();
820                         APPLY_Y_PREDICTOR_24();
821                         OUTPUT_PIXEL_PAIR();
822                     }
823                     break;
824                 }
825
826             } else {
827
828                 /* skip (copy) four pixels, but reassign the horizontal
829                  * predictor */
830                 *current_pixel_pair = *prev_pixel_pair++;
831                 *vert_pred++ = *current_pixel_pair++;
832                 *current_pixel_pair = *prev_pixel_pair++;
833                 horiz_pred = *current_pixel_pair - *vert_pred;
834                 *vert_pred++ = *current_pixel_pair++;
835
836             }
837
838             if (!keyframe) {
839                 mb_change_byte_mask <<= 1;
840
841                 /* next byte */
842                 if (!mb_change_byte_mask) {
843                     mb_change_byte = mb_change_bits[mb_change_index++];
844                     mb_change_byte_mask = 0x01;
845                 }
846             }
847
848             pixels_left -= 4;
849         }
850
851         /* next change row */
852         if (((y + 1) & 3) == 0)
853             mb_change_bits += s->mb_change_bits_row_size;
854
855         current_line += s->frame.linesize[0];
856         prev_line += s->prev_frame.linesize[0];
857     }
858 }
859
860
861 static int truemotion1_decode_frame(AVCodecContext *avctx,
862                                     void *data, int *data_size,
863                                     uint8_t *buf, int buf_size)
864 {
865     TrueMotion1Context *s = avctx->priv_data;
866
867     s->buf = buf;
868     s->size = buf_size;
869
870     if (truemotion1_decode_header(s) == -1)
871         return -1;
872
873     s->frame.reference = 1;
874     if (avctx->get_buffer(avctx, &s->frame) < 0) {
875         av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
876         return -1;
877     }
878
879     /* check for a do-nothing frame and copy the previous frame */
880     if (compression_types[s->compression].algorithm == ALGO_NOP)
881     {
882         memcpy(s->frame.data[0], s->prev_frame.data[0],
883             s->frame.linesize[0] * s->avctx->height);
884     } else if (compression_types[s->compression].algorithm == ALGO_RGB24H) {
885         truemotion1_decode_24bit(s);
886     } else {
887         truemotion1_decode_16bit(s);
888     }
889
890     if (s->prev_frame.data[0])
891         avctx->release_buffer(avctx, &s->prev_frame);
892
893     /* shuffle frames */
894     s->prev_frame = s->frame;
895
896     *data_size = sizeof(AVFrame);
897     *(AVFrame*)data = s->frame;
898
899     /* report that the buffer was completely consumed */
900     return buf_size;
901 }
902
903 static int truemotion1_decode_end(AVCodecContext *avctx)
904 {
905     TrueMotion1Context *s = avctx->priv_data;
906
907     /* release the last frame */
908     if (s->prev_frame.data[0])
909         avctx->release_buffer(avctx, &s->prev_frame);
910
911     av_free(s->vert_pred);
912
913     return 0;
914 }
915
916 AVCodec truemotion1_decoder = {
917     "truemotion1",
918     CODEC_TYPE_VIDEO,
919     CODEC_ID_TRUEMOTION1,
920     sizeof(TrueMotion1Context),
921     truemotion1_decode_init,
922     NULL,
923     truemotion1_decode_end,
924     truemotion1_decode_frame,
925     CODEC_CAP_DR1,
926 };