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