]> git.sesse.net Git - ffmpeg/blob - libavcodec/truemotion1.c
b0fb76f2ce7078eac0ccf6364ecd8ece1252398a
[ffmpeg] / 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 = AV_RL16(&header_buffer[3]);
352     header.xsize = AV_RL16(&header_buffer[5]);
353     header.checksum = AV_RL16(&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         /* FIXME header.width, height, xoffset and yoffset aren't initialized */
378 #if 0
379         s->w = header.width;
380         s->h = header.height;
381         s->x = header.xoffset;
382         s->y = header.yoffset;
383 #else
384         return -1;
385 #endif
386     } else {
387         s->w = header.xsize;
388         s->h = header.ysize;
389         if (header.header_type < 2) {
390             if ((s->w < 213) && (s->h >= 176))
391             {
392                 s->flags |= FLAG_INTERPOLATED;
393                 av_log(s->avctx, AV_LOG_INFO, "INTERPOLATION selected, please report the sample to the developers\n");
394             }
395         }
396     }
397
398     if (header.compression > 17) {
399         av_log(s->avctx, AV_LOG_ERROR, "invalid compression type (%d)\n", header.compression);
400         return -1;
401     }
402
403     if ((header.deltaset != s->last_deltaset) ||
404         (header.vectable != s->last_vectable))
405         select_delta_tables(s, header.deltaset);
406
407     if ((header.compression & 1) && header.header_type)
408         sel_vector_table = pc_tbl2;
409     else {
410         if (header.vectable < 4)
411             sel_vector_table = tables[header.vectable - 1];
412         else {
413             av_log(s->avctx, AV_LOG_ERROR, "invalid vector table id (%d)\n", header.vectable);
414             return -1;
415         }
416     }
417
418     // FIXME: where to place this ?!?!
419     if (compression_types[header.compression].algorithm == ALGO_RGB24H)
420         s->avctx->pix_fmt = PIX_FMT_RGB32;
421     else
422         s->avctx->pix_fmt = PIX_FMT_RGB555; // RGB565 is supported as well
423
424     if ((header.deltaset != s->last_deltaset) || (header.vectable != s->last_vectable))
425     {
426         if (compression_types[header.compression].algorithm == ALGO_RGB24H)
427             gen_vector_table24(s, sel_vector_table);
428         else
429         if (s->avctx->pix_fmt == PIX_FMT_RGB555)
430             gen_vector_table15(s, sel_vector_table);
431         else
432             gen_vector_table16(s, sel_vector_table);
433     }
434
435     /* set up pointers to the other key data chunks */
436     s->mb_change_bits = s->buf + header.header_size;
437     if (s->flags & FLAG_KEYFRAME) {
438         /* no change bits specified for a keyframe; only index bytes */
439         s->index_stream = s->mb_change_bits;
440     } else {
441         /* one change bit per 4x4 block */
442         s->index_stream = s->mb_change_bits +
443             (s->mb_change_bits_row_size * (s->avctx->height >> 2));
444     }
445     s->index_stream_size = s->size - (s->index_stream - s->buf);
446
447     s->last_deltaset = header.deltaset;
448     s->last_vectable = header.vectable;
449     s->compression = header.compression;
450     s->block_width = compression_types[header.compression].block_width;
451     s->block_height = compression_types[header.compression].block_height;
452     s->block_type = compression_types[header.compression].block_type;
453
454     if (s->avctx->debug & FF_DEBUG_PICT_INFO)
455         av_log(s->avctx, AV_LOG_INFO, "tables: %d / %d c:%d %dx%d t:%d %s%s%s%s\n",
456             s->last_deltaset, s->last_vectable, s->compression, s->block_width,
457             s->block_height, s->block_type,
458             s->flags & FLAG_KEYFRAME ? " KEY" : "",
459             s->flags & FLAG_INTERFRAME ? " INTER" : "",
460             s->flags & FLAG_SPRITE ? " SPRITE" : "",
461             s->flags & FLAG_INTERPOLATED ? " INTERPOL" : "");
462
463     return header.header_size;
464 }
465
466 static int truemotion1_decode_init(AVCodecContext *avctx)
467 {
468     TrueMotion1Context *s = (TrueMotion1Context *)avctx->priv_data;
469
470     s->avctx = avctx;
471
472     // FIXME: it may change ?
473 //    if (avctx->bits_per_sample == 24)
474 //        avctx->pix_fmt = PIX_FMT_RGB24;
475 //    else
476 //        avctx->pix_fmt = PIX_FMT_RGB555;
477
478     s->frame.data[0] = s->prev_frame.data[0] = NULL;
479
480     /* there is a vertical predictor for each pixel in a line; each vertical
481      * predictor is 0 to start with */
482     s->vert_pred =
483         (unsigned int *)av_malloc(s->avctx->width * sizeof(unsigned int));
484
485     return 0;
486 }
487
488 /*
489 Block decoding order:
490
491 dxi: Y-Y
492 dxic: Y-C-Y
493 dxic2: Y-C-Y-C
494
495 hres,vres,i,i%vres (0 < i < 4)
496 2x2 0: 0 dxic2
497 2x2 1: 1 dxi
498 2x2 2: 0 dxic2
499 2x2 3: 1 dxi
500 2x4 0: 0 dxic2
501 2x4 1: 1 dxi
502 2x4 2: 2 dxi
503 2x4 3: 3 dxi
504 4x2 0: 0 dxic
505 4x2 1: 1 dxi
506 4x2 2: 0 dxic
507 4x2 3: 1 dxi
508 4x4 0: 0 dxic
509 4x4 1: 1 dxi
510 4x4 2: 2 dxi
511 4x4 3: 3 dxi
512 */
513
514 #define GET_NEXT_INDEX() \
515 {\
516     if (index_stream_index >= s->index_stream_size) { \
517         av_log(s->avctx, AV_LOG_INFO, " help! truemotion1 decoder went out of bounds\n"); \
518         return; \
519     } \
520     index = s->index_stream[index_stream_index++] * 4; \
521 }
522
523 #define APPLY_C_PREDICTOR() \
524     predictor_pair = s->c_predictor_table[index]; \
525     horiz_pred += (predictor_pair >> 1); \
526     if (predictor_pair & 1) { \
527         GET_NEXT_INDEX() \
528         if (!index) { \
529             GET_NEXT_INDEX() \
530             predictor_pair = s->c_predictor_table[index]; \
531             horiz_pred += ((predictor_pair >> 1) * 5); \
532             if (predictor_pair & 1) \
533                 GET_NEXT_INDEX() \
534             else \
535                 index++; \
536         } \
537     } else \
538         index++;
539
540 #define APPLY_C_PREDICTOR_24() \
541     predictor_pair = s->c_predictor_table[index]; \
542     horiz_pred += (predictor_pair >> 1); \
543     if (predictor_pair & 1) { \
544         GET_NEXT_INDEX() \
545         if (!index) { \
546             GET_NEXT_INDEX() \
547             predictor_pair = s->fat_c_predictor_table[index]; \
548             horiz_pred += (predictor_pair >> 1); \
549             if (predictor_pair & 1) \
550                 GET_NEXT_INDEX() \
551             else \
552                 index++; \
553         } \
554     } else \
555         index++;
556
557
558 #define APPLY_Y_PREDICTOR() \
559     predictor_pair = s->y_predictor_table[index]; \
560     horiz_pred += (predictor_pair >> 1); \
561     if (predictor_pair & 1) { \
562         GET_NEXT_INDEX() \
563         if (!index) { \
564             GET_NEXT_INDEX() \
565             predictor_pair = s->y_predictor_table[index]; \
566             horiz_pred += ((predictor_pair >> 1) * 5); \
567             if (predictor_pair & 1) \
568                 GET_NEXT_INDEX() \
569             else \
570                 index++; \
571         } \
572     } else \
573         index++;
574
575 #define APPLY_Y_PREDICTOR_24() \
576     predictor_pair = s->y_predictor_table[index]; \
577     horiz_pred += (predictor_pair >> 1); \
578     if (predictor_pair & 1) { \
579         GET_NEXT_INDEX() \
580         if (!index) { \
581             GET_NEXT_INDEX() \
582             predictor_pair = s->fat_y_predictor_table[index]; \
583             horiz_pred += (predictor_pair >> 1); \
584             if (predictor_pair & 1) \
585                 GET_NEXT_INDEX() \
586             else \
587                 index++; \
588         } \
589     } else \
590         index++;
591
592 #define OUTPUT_PIXEL_PAIR() \
593     *current_pixel_pair = *vert_pred + horiz_pred; \
594     *vert_pred++ = *current_pixel_pair++; \
595     prev_pixel_pair++;
596
597 static void truemotion1_decode_16bit(TrueMotion1Context *s)
598 {
599     int y;
600     int pixels_left;  /* remaining pixels on this line */
601     unsigned int predictor_pair;
602     unsigned int horiz_pred;
603     unsigned int *vert_pred;
604     unsigned int *current_pixel_pair;
605     unsigned int *prev_pixel_pair;
606     unsigned char *current_line = s->frame.data[0];
607     unsigned char *prev_line = s->prev_frame.data[0];
608     int keyframe = s->flags & FLAG_KEYFRAME;
609
610     /* these variables are for managing the stream of macroblock change bits */
611     unsigned char *mb_change_bits = s->mb_change_bits;
612     unsigned char mb_change_byte;
613     unsigned char mb_change_byte_mask;
614     int mb_change_index;
615
616     /* these variables are for managing the main index stream */
617     int index_stream_index = 0;  /* yes, the index into the index stream */
618     int index;
619
620     /* clean out the line buffer */
621     memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
622
623     GET_NEXT_INDEX();
624
625     for (y = 0; y < s->avctx->height; y++) {
626
627         /* re-init variables for the next line iteration */
628         horiz_pred = 0;
629         current_pixel_pair = (unsigned int *)current_line;
630         prev_pixel_pair = (unsigned int *)prev_line;
631         vert_pred = s->vert_pred;
632         mb_change_index = 0;
633         mb_change_byte = mb_change_bits[mb_change_index++];
634         mb_change_byte_mask = 0x01;
635         pixels_left = s->avctx->width;
636
637         while (pixels_left > 0) {
638
639             if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
640
641                 switch (y & 3) {
642                 case 0:
643                     /* if macroblock width is 2, apply C-Y-C-Y; else
644                      * apply C-Y-Y */
645                     if (s->block_width == 2) {
646                         APPLY_C_PREDICTOR();
647                         APPLY_Y_PREDICTOR();
648                         OUTPUT_PIXEL_PAIR();
649                         APPLY_C_PREDICTOR();
650                         APPLY_Y_PREDICTOR();
651                         OUTPUT_PIXEL_PAIR();
652                     } else {
653                         APPLY_C_PREDICTOR();
654                         APPLY_Y_PREDICTOR();
655                         OUTPUT_PIXEL_PAIR();
656                         APPLY_Y_PREDICTOR();
657                         OUTPUT_PIXEL_PAIR();
658                     }
659                     break;
660
661                 case 1:
662                 case 3:
663                     /* always apply 2 Y predictors on these iterations */
664                     APPLY_Y_PREDICTOR();
665                     OUTPUT_PIXEL_PAIR();
666                     APPLY_Y_PREDICTOR();
667                     OUTPUT_PIXEL_PAIR();
668                     break;
669
670                 case 2:
671                     /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
672                      * depending on the macroblock type */
673                     if (s->block_type == BLOCK_2x2) {
674                         APPLY_C_PREDICTOR();
675                         APPLY_Y_PREDICTOR();
676                         OUTPUT_PIXEL_PAIR();
677                         APPLY_C_PREDICTOR();
678                         APPLY_Y_PREDICTOR();
679                         OUTPUT_PIXEL_PAIR();
680                     } else if (s->block_type == BLOCK_4x2) {
681                         APPLY_C_PREDICTOR();
682                         APPLY_Y_PREDICTOR();
683                         OUTPUT_PIXEL_PAIR();
684                         APPLY_Y_PREDICTOR();
685                         OUTPUT_PIXEL_PAIR();
686                     } else {
687                         APPLY_Y_PREDICTOR();
688                         OUTPUT_PIXEL_PAIR();
689                         APPLY_Y_PREDICTOR();
690                         OUTPUT_PIXEL_PAIR();
691                     }
692                     break;
693                 }
694
695             } else {
696
697                 /* skip (copy) four pixels, but reassign the horizontal
698                  * predictor */
699                 *current_pixel_pair = *prev_pixel_pair++;
700                 *vert_pred++ = *current_pixel_pair++;
701                 *current_pixel_pair = *prev_pixel_pair++;
702                 horiz_pred = *current_pixel_pair - *vert_pred;
703                 *vert_pred++ = *current_pixel_pair++;
704
705             }
706
707             if (!keyframe) {
708                 mb_change_byte_mask <<= 1;
709
710                 /* next byte */
711                 if (!mb_change_byte_mask) {
712                     mb_change_byte = mb_change_bits[mb_change_index++];
713                     mb_change_byte_mask = 0x01;
714                 }
715             }
716
717             pixels_left -= 4;
718         }
719
720         /* next change row */
721         if (((y + 1) & 3) == 0)
722             mb_change_bits += s->mb_change_bits_row_size;
723
724         current_line += s->frame.linesize[0];
725         prev_line += s->prev_frame.linesize[0];
726     }
727 }
728
729 static void truemotion1_decode_24bit(TrueMotion1Context *s)
730 {
731     int y;
732     int pixels_left;  /* remaining pixels on this line */
733     unsigned int predictor_pair;
734     unsigned int horiz_pred;
735     unsigned int *vert_pred;
736     unsigned int *current_pixel_pair;
737     unsigned int *prev_pixel_pair;
738     unsigned char *current_line = s->frame.data[0];
739     unsigned char *prev_line = s->prev_frame.data[0];
740     int keyframe = s->flags & FLAG_KEYFRAME;
741
742     /* these variables are for managing the stream of macroblock change bits */
743     unsigned char *mb_change_bits = s->mb_change_bits;
744     unsigned char mb_change_byte;
745     unsigned char mb_change_byte_mask;
746     int mb_change_index;
747
748     /* these variables are for managing the main index stream */
749     int index_stream_index = 0;  /* yes, the index into the index stream */
750     int index;
751
752     /* clean out the line buffer */
753     memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
754
755     GET_NEXT_INDEX();
756
757     for (y = 0; y < s->avctx->height; y++) {
758
759         /* re-init variables for the next line iteration */
760         horiz_pred = 0;
761         current_pixel_pair = (unsigned int *)current_line;
762         prev_pixel_pair = (unsigned int *)prev_line;
763         vert_pred = s->vert_pred;
764         mb_change_index = 0;
765         mb_change_byte = mb_change_bits[mb_change_index++];
766         mb_change_byte_mask = 0x01;
767         pixels_left = s->avctx->width;
768
769         while (pixels_left > 0) {
770
771             if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
772
773                 switch (y & 3) {
774                 case 0:
775                     /* if macroblock width is 2, apply C-Y-C-Y; else
776                      * apply C-Y-Y */
777                     if (s->block_width == 2) {
778                         APPLY_C_PREDICTOR_24();
779                         APPLY_Y_PREDICTOR_24();
780                         OUTPUT_PIXEL_PAIR();
781                         APPLY_C_PREDICTOR_24();
782                         APPLY_Y_PREDICTOR_24();
783                         OUTPUT_PIXEL_PAIR();
784                     } else {
785                         APPLY_C_PREDICTOR_24();
786                         APPLY_Y_PREDICTOR_24();
787                         OUTPUT_PIXEL_PAIR();
788                         APPLY_Y_PREDICTOR_24();
789                         OUTPUT_PIXEL_PAIR();
790                     }
791                     break;
792
793                 case 1:
794                 case 3:
795                     /* always apply 2 Y predictors on these iterations */
796                     APPLY_Y_PREDICTOR_24();
797                     OUTPUT_PIXEL_PAIR();
798                     APPLY_Y_PREDICTOR_24();
799                     OUTPUT_PIXEL_PAIR();
800                     break;
801
802                 case 2:
803                     /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
804                      * depending on the macroblock type */
805                     if (s->block_type == BLOCK_2x2) {
806                         APPLY_C_PREDICTOR_24();
807                         APPLY_Y_PREDICTOR_24();
808                         OUTPUT_PIXEL_PAIR();
809                         APPLY_C_PREDICTOR_24();
810                         APPLY_Y_PREDICTOR_24();
811                         OUTPUT_PIXEL_PAIR();
812                     } else if (s->block_type == BLOCK_4x2) {
813                         APPLY_C_PREDICTOR_24();
814                         APPLY_Y_PREDICTOR_24();
815                         OUTPUT_PIXEL_PAIR();
816                         APPLY_Y_PREDICTOR_24();
817                         OUTPUT_PIXEL_PAIR();
818                     } else {
819                         APPLY_Y_PREDICTOR_24();
820                         OUTPUT_PIXEL_PAIR();
821                         APPLY_Y_PREDICTOR_24();
822                         OUTPUT_PIXEL_PAIR();
823                     }
824                     break;
825                 }
826
827             } else {
828
829                 /* skip (copy) four pixels, but reassign the horizontal
830                  * predictor */
831                 *current_pixel_pair = *prev_pixel_pair++;
832                 *vert_pred++ = *current_pixel_pair++;
833                 *current_pixel_pair = *prev_pixel_pair++;
834                 horiz_pred = *current_pixel_pair - *vert_pred;
835                 *vert_pred++ = *current_pixel_pair++;
836
837             }
838
839             if (!keyframe) {
840                 mb_change_byte_mask <<= 1;
841
842                 /* next byte */
843                 if (!mb_change_byte_mask) {
844                     mb_change_byte = mb_change_bits[mb_change_index++];
845                     mb_change_byte_mask = 0x01;
846                 }
847             }
848
849             pixels_left -= 4;
850         }
851
852         /* next change row */
853         if (((y + 1) & 3) == 0)
854             mb_change_bits += s->mb_change_bits_row_size;
855
856         current_line += s->frame.linesize[0];
857         prev_line += s->prev_frame.linesize[0];
858     }
859 }
860
861
862 static int truemotion1_decode_frame(AVCodecContext *avctx,
863                                     void *data, int *data_size,
864                                     uint8_t *buf, int buf_size)
865 {
866     TrueMotion1Context *s = (TrueMotion1Context *)avctx->priv_data;
867
868     s->buf = buf;
869     s->size = buf_size;
870
871     if (truemotion1_decode_header(s) == -1)
872         return -1;
873
874     s->frame.reference = 1;
875     if (avctx->get_buffer(avctx, &s->frame) < 0) {
876         av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
877         return -1;
878     }
879
880     /* check for a do-nothing frame and copy the previous frame */
881     if (compression_types[s->compression].algorithm == ALGO_NOP)
882     {
883         memcpy(s->frame.data[0], s->prev_frame.data[0],
884             s->frame.linesize[0] * s->avctx->height);
885     } else if (compression_types[s->compression].algorithm == ALGO_RGB24H) {
886         truemotion1_decode_24bit(s);
887     } else {
888         truemotion1_decode_16bit(s);
889     }
890
891     if (s->prev_frame.data[0])
892         avctx->release_buffer(avctx, &s->prev_frame);
893
894     /* shuffle frames */
895     s->prev_frame = s->frame;
896
897     *data_size = sizeof(AVFrame);
898     *(AVFrame*)data = s->frame;
899
900     /* report that the buffer was completely consumed */
901     return buf_size;
902 }
903
904 static int truemotion1_decode_end(AVCodecContext *avctx)
905 {
906     TrueMotion1Context *s = (TrueMotion1Context *)avctx->priv_data;
907
908     /* release the last frame */
909     if (s->prev_frame.data[0])
910         avctx->release_buffer(avctx, &s->prev_frame);
911
912     av_free(s->vert_pred);
913
914     return 0;
915 }
916
917 AVCodec truemotion1_decoder = {
918     "truemotion1",
919     CODEC_TYPE_VIDEO,
920     CODEC_ID_TRUEMOTION1,
921     sizeof(TrueMotion1Context),
922     truemotion1_decode_init,
923     NULL,
924     truemotion1_decode_end,
925     truemotion1_decode_frame,
926     CODEC_CAP_DR1,
927 };