truemotion1: make sure index does not go out of bounds
[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 "internal.h"
38 #include "libavutil/imgutils.h"
39 #include "libavutil/internal.h"
40 #include "libavutil/intreadwrite.h"
41 #include "libavutil/mem.h"
42
43 #include "truemotion1data.h"
44
45 typedef struct TrueMotion1Context {
46     AVCodecContext *avctx;
47     AVFrame *frame;
48
49     const uint8_t *buf;
50     int size;
51
52     const uint8_t *mb_change_bits;
53     int mb_change_bits_row_size;
54     const uint8_t *index_stream;
55     int index_stream_size;
56
57     int flags;
58     int x, y, w, h;
59
60     uint32_t y_predictor_table[1024];
61     uint32_t c_predictor_table[1024];
62     uint32_t fat_y_predictor_table[1024];
63     uint32_t fat_c_predictor_table[1024];
64
65     int compression;
66     int block_type;
67     int block_width;
68     int block_height;
69
70     int16_t ydt[8];
71     int16_t cdt[8];
72     int16_t fat_ydt[8];
73     int16_t fat_cdt[8];
74
75     int last_deltaset, last_vectable;
76
77     unsigned int *vert_pred;
78     int vert_pred_size;
79
80 } TrueMotion1Context;
81
82 #define FLAG_SPRITE         32
83 #define FLAG_KEYFRAME       16
84 #define FLAG_INTERFRAME      8
85 #define FLAG_INTERPOLATED    4
86
87 struct frame_header {
88     uint8_t header_size;
89     uint8_t compression;
90     uint8_t deltaset;
91     uint8_t vectable;
92     uint16_t ysize;
93     uint16_t xsize;
94     uint16_t checksum;
95     uint8_t version;
96     uint8_t header_type;
97     uint8_t flags;
98     uint8_t control;
99     uint16_t xoffset;
100     uint16_t yoffset;
101     uint16_t width;
102     uint16_t height;
103 };
104
105 #define ALGO_NOP        0
106 #define ALGO_RGB16V     1
107 #define ALGO_RGB16H     2
108 #define ALGO_RGB24H     3
109
110 /* these are the various block sizes that can occupy a 4x4 block */
111 #define BLOCK_2x2  0
112 #define BLOCK_2x4  1
113 #define BLOCK_4x2  2
114 #define BLOCK_4x4  3
115
116 typedef struct comp_types {
117     int algorithm;
118     int block_width; // vres
119     int block_height; // hres
120     int block_type;
121 } comp_types;
122
123 /* { valid for metatype }, algorithm, num of deltas, vert res, horiz res */
124 static const comp_types compression_types[17] = {
125     { ALGO_NOP,    0, 0, 0 },
126
127     { ALGO_RGB16V, 4, 4, BLOCK_4x4 },
128     { ALGO_RGB16H, 4, 4, BLOCK_4x4 },
129     { ALGO_RGB16V, 4, 2, BLOCK_4x2 },
130     { ALGO_RGB16H, 4, 2, BLOCK_4x2 },
131
132     { ALGO_RGB16V, 2, 4, BLOCK_2x4 },
133     { ALGO_RGB16H, 2, 4, BLOCK_2x4 },
134     { ALGO_RGB16V, 2, 2, BLOCK_2x2 },
135     { ALGO_RGB16H, 2, 2, BLOCK_2x2 },
136
137     { ALGO_NOP,    4, 4, BLOCK_4x4 },
138     { ALGO_RGB24H, 4, 4, BLOCK_4x4 },
139     { ALGO_NOP,    4, 2, BLOCK_4x2 },
140     { ALGO_RGB24H, 4, 2, BLOCK_4x2 },
141
142     { ALGO_NOP,    2, 4, BLOCK_2x4 },
143     { ALGO_RGB24H, 2, 4, BLOCK_2x4 },
144     { ALGO_NOP,    2, 2, BLOCK_2x2 },
145     { ALGO_RGB24H, 2, 2, BLOCK_2x2 }
146 };
147
148 static void select_delta_tables(TrueMotion1Context *s, int delta_table_index)
149 {
150     int i;
151
152     if (delta_table_index > 3)
153         return;
154
155     memcpy(s->ydt, ydts[delta_table_index], 8 * sizeof(int16_t));
156     memcpy(s->cdt, cdts[delta_table_index], 8 * sizeof(int16_t));
157     memcpy(s->fat_ydt, fat_ydts[delta_table_index], 8 * sizeof(int16_t));
158     memcpy(s->fat_cdt, fat_cdts[delta_table_index], 8 * sizeof(int16_t));
159
160     /* Y skinny deltas need to be halved for some reason; maybe the
161      * skinny Y deltas should be modified */
162     for (i = 0; i < 8; i++)
163     {
164         /* drop the lsb before dividing by 2-- net effect: round down
165          * when dividing a negative number (e.g., -3/2 = -2, not -1) */
166         s->ydt[i] &= 0xFFFE;
167         s->ydt[i] /= 2;
168     }
169 }
170
171 #if HAVE_BIGENDIAN
172 static int make_ydt15_entry(int p2, int p1, int16_t *ydt)
173 #else
174 static int make_ydt15_entry(int p1, int p2, int16_t *ydt)
175 #endif
176 {
177     int lo, hi;
178
179     lo = ydt[p1];
180     lo += (lo << 5) + (lo << 10);
181     hi = ydt[p2];
182     hi += (hi << 5) + (hi << 10);
183     return (lo + (hi << 16)) << 1;
184 }
185
186 static int make_cdt15_entry(int p1, int p2, int16_t *cdt)
187 {
188     int r, b, lo;
189
190     b = cdt[p2];
191     r = cdt[p1] << 10;
192     lo = b + r;
193     return (lo + (lo << 16)) << 1;
194 }
195
196 #if HAVE_BIGENDIAN
197 static int make_ydt16_entry(int p2, int p1, int16_t *ydt)
198 #else
199 static int make_ydt16_entry(int p1, int p2, int16_t *ydt)
200 #endif
201 {
202     int lo, hi;
203
204     lo = ydt[p1];
205     lo += (lo << 6) + (lo << 11);
206     hi = ydt[p2];
207     hi += (hi << 6) + (hi << 11);
208     return (lo + (hi << 16)) << 1;
209 }
210
211 static int make_cdt16_entry(int p1, int p2, int16_t *cdt)
212 {
213     int r, b, lo;
214
215     b = cdt[p2];
216     r = cdt[p1] << 11;
217     lo = b + r;
218     return (lo + (lo << 16)) << 1;
219 }
220
221 static int make_ydt24_entry(int p1, int p2, int16_t *ydt)
222 {
223     int lo, hi;
224
225     lo = ydt[p1];
226     hi = ydt[p2];
227     return (lo + (hi << 8) + (hi << 16)) << 1;
228 }
229
230 static int make_cdt24_entry(int p1, int p2, int16_t *cdt)
231 {
232     int r, b;
233
234     b = cdt[p2];
235     r = cdt[p1]<<16;
236     return (b+r) << 1;
237 }
238
239 static void gen_vector_table15(TrueMotion1Context *s, const uint8_t *sel_vector_table)
240 {
241     int len, i, j;
242     unsigned char delta_pair;
243
244     for (i = 0; i < 1024; i += 4)
245     {
246         len = *sel_vector_table++ / 2;
247         for (j = 0; j < len; j++)
248         {
249             delta_pair = *sel_vector_table++;
250             s->y_predictor_table[i+j] = 0xfffffffe &
251                 make_ydt15_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
252             s->c_predictor_table[i+j] = 0xfffffffe &
253                 make_cdt15_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
254         }
255         s->y_predictor_table[i+(j-1)] |= 1;
256         s->c_predictor_table[i+(j-1)] |= 1;
257     }
258 }
259
260 static void gen_vector_table16(TrueMotion1Context *s, const uint8_t *sel_vector_table)
261 {
262     int len, i, j;
263     unsigned char delta_pair;
264
265     for (i = 0; i < 1024; i += 4)
266     {
267         len = *sel_vector_table++ / 2;
268         for (j = 0; j < len; j++)
269         {
270             delta_pair = *sel_vector_table++;
271             s->y_predictor_table[i+j] = 0xfffffffe &
272                 make_ydt16_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
273             s->c_predictor_table[i+j] = 0xfffffffe &
274                 make_cdt16_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
275         }
276         s->y_predictor_table[i+(j-1)] |= 1;
277         s->c_predictor_table[i+(j-1)] |= 1;
278     }
279 }
280
281 static void gen_vector_table24(TrueMotion1Context *s, const uint8_t *sel_vector_table)
282 {
283     int len, i, j;
284     unsigned char delta_pair;
285
286     for (i = 0; i < 1024; i += 4)
287     {
288         len = *sel_vector_table++ / 2;
289         for (j = 0; j < len; j++)
290         {
291             delta_pair = *sel_vector_table++;
292             s->y_predictor_table[i+j] = 0xfffffffe &
293                 make_ydt24_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
294             s->c_predictor_table[i+j] = 0xfffffffe &
295                 make_cdt24_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
296             s->fat_y_predictor_table[i+j] = 0xfffffffe &
297                 make_ydt24_entry(delta_pair >> 4, delta_pair & 0xf, s->fat_ydt);
298             s->fat_c_predictor_table[i+j] = 0xfffffffe &
299                 make_cdt24_entry(delta_pair >> 4, delta_pair & 0xf, s->fat_cdt);
300         }
301         s->y_predictor_table[i+(j-1)] |= 1;
302         s->c_predictor_table[i+(j-1)] |= 1;
303         s->fat_y_predictor_table[i+(j-1)] |= 1;
304         s->fat_c_predictor_table[i+(j-1)] |= 1;
305     }
306 }
307
308 /* Returns the number of bytes consumed from the bytestream. Returns -1 if
309  * there was an error while decoding the header */
310 static int truemotion1_decode_header(TrueMotion1Context *s)
311 {
312     int i, ret;
313     int width_shift = 0;
314     int new_pix_fmt;
315     struct frame_header header;
316     uint8_t header_buffer[128] = { 0 };  /* logical maximum size of the header */
317     const uint8_t *sel_vector_table;
318
319     header.header_size = ((s->buf[0] >> 5) | (s->buf[0] << 3)) & 0x7f;
320     if (s->buf[0] < 0x10)
321     {
322         av_log(s->avctx, AV_LOG_ERROR, "invalid header size (%d)\n", s->buf[0]);
323         return AVERROR_INVALIDDATA;
324     }
325
326     /* unscramble the header bytes with a XOR operation */
327     for (i = 1; i < header.header_size; i++)
328         header_buffer[i - 1] = s->buf[i] ^ s->buf[i + 1];
329
330     header.compression = header_buffer[0];
331     header.deltaset = header_buffer[1];
332     header.vectable = header_buffer[2];
333     header.ysize = AV_RL16(&header_buffer[3]);
334     header.xsize = AV_RL16(&header_buffer[5]);
335     header.checksum = AV_RL16(&header_buffer[7]);
336     header.version = header_buffer[9];
337     header.header_type = header_buffer[10];
338     header.flags = header_buffer[11];
339     header.control = header_buffer[12];
340
341     /* Version 2 */
342     if (header.version >= 2)
343     {
344         if (header.header_type > 3)
345         {
346             av_log(s->avctx, AV_LOG_ERROR, "invalid header type (%d)\n", header.header_type);
347             return AVERROR_INVALIDDATA;
348         } else if ((header.header_type == 2) || (header.header_type == 3)) {
349             s->flags = header.flags;
350             if (!(s->flags & FLAG_INTERFRAME))
351                 s->flags |= FLAG_KEYFRAME;
352         } else
353             s->flags = FLAG_KEYFRAME;
354     } else /* Version 1 */
355         s->flags = FLAG_KEYFRAME;
356
357     if (s->flags & FLAG_SPRITE) {
358         avpriv_request_sample(s->avctx, "Frame with sprite");
359         /* FIXME header.width, height, xoffset and yoffset aren't initialized */
360         return AVERROR_PATCHWELCOME;
361     } else {
362         s->w = header.xsize;
363         s->h = header.ysize;
364         if (header.header_type < 2) {
365             if ((s->w < 213) && (s->h >= 176))
366             {
367                 s->flags |= FLAG_INTERPOLATED;
368                 avpriv_request_sample(s->avctx, "Interpolated frame");
369             }
370         }
371     }
372
373     if (header.compression >= 17) {
374         av_log(s->avctx, AV_LOG_ERROR, "invalid compression type (%d)\n", header.compression);
375         return AVERROR_INVALIDDATA;
376     }
377
378     if ((header.deltaset != s->last_deltaset) ||
379         (header.vectable != s->last_vectable))
380         select_delta_tables(s, header.deltaset);
381
382     if ((header.compression & 1) && header.header_type)
383         sel_vector_table = pc_tbl2;
384     else {
385         if (header.vectable > 0 && header.vectable < 4)
386             sel_vector_table = tables[header.vectable - 1];
387         else {
388             av_log(s->avctx, AV_LOG_ERROR, "invalid vector table id (%d)\n", header.vectable);
389             return AVERROR_INVALIDDATA;
390         }
391     }
392
393     if (compression_types[header.compression].algorithm == ALGO_RGB24H) {
394         new_pix_fmt = AV_PIX_FMT_RGB32;
395         width_shift = 1;
396     } else
397         new_pix_fmt = AV_PIX_FMT_RGB555; // RGB565 is supported as well
398
399     s->w >>= width_shift;
400
401     if (s->w != s->avctx->width || s->h != s->avctx->height ||
402         new_pix_fmt != s->avctx->pix_fmt) {
403         av_frame_unref(s->frame);
404         s->avctx->sample_aspect_ratio = (AVRational){ 1 << width_shift, 1 };
405         s->avctx->pix_fmt = new_pix_fmt;
406
407         if ((ret = ff_set_dimensions(s->avctx, s->w, s->h)) < 0)
408             return ret;
409
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 - width_shift)) + 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 == AV_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 = AV_PIX_FMT_RGB24;
469 //    else
470 //        avctx->pix_fmt = AV_PIX_FMT_RGB555;
471
472     s->frame = av_frame_alloc();
473     if (!s->frame)
474         return AVERROR(ENOMEM);
475
476     /* there is a vertical predictor for each pixel in a line; each vertical
477      * predictor is 0 to start with */
478     av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
479
480     return 0;
481 }
482
483 /*
484 Block decoding order:
485
486 dxi: Y-Y
487 dxic: Y-C-Y
488 dxic2: Y-C-Y-C
489
490 hres,vres,i,i%vres (0 < i < 4)
491 2x2 0: 0 dxic2
492 2x2 1: 1 dxi
493 2x2 2: 0 dxic2
494 2x2 3: 1 dxi
495 2x4 0: 0 dxic2
496 2x4 1: 1 dxi
497 2x4 2: 2 dxi
498 2x4 3: 3 dxi
499 4x2 0: 0 dxic
500 4x2 1: 1 dxi
501 4x2 2: 0 dxic
502 4x2 3: 1 dxi
503 4x4 0: 0 dxic
504 4x4 1: 1 dxi
505 4x4 2: 2 dxi
506 4x4 3: 3 dxi
507 */
508
509 #define GET_NEXT_INDEX() \
510 {\
511     if (index_stream_index >= s->index_stream_size) { \
512         av_log(s->avctx, AV_LOG_INFO, " help! truemotion1 decoder went out of bounds\n"); \
513         return; \
514     } \
515     index = s->index_stream[index_stream_index++] * 4; \
516 }
517
518 #define INC_INDEX                                                   \
519 do {                                                                \
520     if (index >= 1023) {                                            \
521         av_log(s->avctx, AV_LOG_ERROR, "Invalid index value.\n");   \
522         return;                                                     \
523     }                                                               \
524     index++;                                                        \
525 } while (0)
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                 INC_INDEX; \
540         } \
541     } else \
542         INC_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                 INC_INDEX; \
557         } \
558     } else \
559         INC_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                 INC_INDEX; \
575         } \
576     } else \
577         INC_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                 INC_INDEX; \
592         } \
593     } else \
594         INC_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 -= 2;
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 *got_frame,
855                                     AVPacket *avpkt)
856 {
857     const uint8_t *buf = avpkt->data;
858     int ret, buf_size = avpkt->size;
859     TrueMotion1Context *s = avctx->priv_data;
860
861     s->buf = buf;
862     s->size = buf_size;
863
864     if ((ret = truemotion1_decode_header(s)) < 0)
865         return ret;
866
867     if ((ret = ff_reget_buffer(avctx, s->frame)) < 0) {
868         av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
869         return ret;
870     }
871
872     if (compression_types[s->compression].algorithm == ALGO_RGB24H) {
873         truemotion1_decode_24bit(s);
874     } else if (compression_types[s->compression].algorithm != ALGO_NOP) {
875         truemotion1_decode_16bit(s);
876     }
877
878     if ((ret = av_frame_ref(data, s->frame)) < 0)
879         return ret;
880
881     *got_frame      = 1;
882
883     /* report that the buffer was completely consumed */
884     return buf_size;
885 }
886
887 static av_cold int truemotion1_decode_end(AVCodecContext *avctx)
888 {
889     TrueMotion1Context *s = avctx->priv_data;
890
891     av_frame_free(&s->frame);
892     av_free(s->vert_pred);
893
894     return 0;
895 }
896
897 AVCodec ff_truemotion1_decoder = {
898     .name           = "truemotion1",
899     .long_name      = NULL_IF_CONFIG_SMALL("Duck TrueMotion 1.0"),
900     .type           = AVMEDIA_TYPE_VIDEO,
901     .id             = AV_CODEC_ID_TRUEMOTION1,
902     .priv_data_size = sizeof(TrueMotion1Context),
903     .init           = truemotion1_decode_init,
904     .close          = truemotion1_decode_end,
905     .decode         = truemotion1_decode_frame,
906     .capabilities   = CODEC_CAP_DR1,
907 };