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