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