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