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