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