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