remove numerous definitions of BE_*/LE_* macros; convert FOURCC_TAG ->
[ffmpeg.git] / libavcodec / truemotion1.c
1 /*
2  * Duck TrueMotion 1.0 Decoder
3  * Copyright (C) 2003 Alex Beregszaszi & Mike Melanson
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19
20 /**
21  * @file truemotion1.c
22  * Duck TrueMotion v1 Video Decoder by 
23  * Alex Beregszaszi (alex@fsn.hu) and
24  * Mike Melanson (melanson@pcisys.net)
25  *
26  * The TrueMotion v1 decoder presently only decodes 16-bit TM1 data and
27  * outputs RGB555 data. 24-bit TM1 data is not supported yet.
28  */
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <unistd.h>
34
35 #include "common.h"
36 #include "avcodec.h"
37 #include "dsputil.h"
38
39 #define printf(...) {} //(f)printf() usage is forbidden in libavcodec, use av_log
40 #define fprintf(...) {} 
41
42 #include "truemotion1data.h"
43
44 typedef struct TrueMotion1Context {
45     AVCodecContext *avctx;
46     AVFrame frame;
47     AVFrame prev_frame;
48
49     unsigned char *buf;
50     int size;
51
52     unsigned char *mb_change_bits;
53     int mb_change_bits_row_size;
54     unsigned char *index_stream;
55     int index_stream_size;
56
57     int flags;
58     int x, y, w, h;
59     
60     uint32_t y_predictor_table[1024];
61     uint32_t c_predictor_table[1024];
62     
63     int compression;
64     int block_type;
65     int block_width;
66     int block_height;
67
68     int16_t *ydt;
69     int16_t *cdt;
70     int16_t *fat_ydt;
71     int16_t *fat_cdt;
72     
73     int last_deltaset, last_vectable;
74
75     unsigned int *vert_pred;
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;
116     int block_height;
117     int block_type;
118 } comp_types;
119
120 /* { valid for metatype }, algorithm, num of deltas, horiz res, vert res */
121 static 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     s->ydt = ydts[delta_table_index];
153     s->cdt = cdts[delta_table_index];
154     s->fat_ydt = fat_ydts[delta_table_index];
155     s->fat_cdt = fat_cdts[delta_table_index];
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 #ifdef WORDS_BIGENDIAN
169 static int make_ydt_entry(int p2, int p1, int16_t *ydt)
170 #else
171 static int make_ydt_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 #ifdef WORDS_BIGENDIAN
184 static int make_cdt_entry(int p2, int p1, int16_t *cdt)
185 #else
186 static int make_cdt_entry(int p1, int p2, int16_t *cdt)
187 #endif
188 {
189     int r, b, lo;
190     
191     b = cdt[p2];
192     r = cdt[p1] << 10;
193     lo = b + r;
194     return ((lo + (lo << 16)) << 1);
195 }
196
197 static void gen_vector_table(TrueMotion1Context *s, uint8_t *sel_vector_table)
198 {
199     int len, i, j;
200     unsigned char delta_pair;
201     
202     for (i = 0; i < 1024; i += 4)
203     {
204         len = *sel_vector_table++ / 2;
205         for (j = 0; j < len; j++)
206         {
207             delta_pair = *sel_vector_table++;
208             s->y_predictor_table[i+j] = 0xfffffffe & 
209                 make_ydt_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
210             s->c_predictor_table[i+j] = 0xfffffffe & 
211                 make_cdt_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
212         }
213         s->y_predictor_table[i+(j-1)] |= 1;
214         s->c_predictor_table[i+(j-1)] |= 1;
215     }
216 }
217
218 /* Returns the number of bytes consumed from the bytestream. Returns -1 if
219  * there was an error while decoding the header */ 
220 static int truemotion1_decode_header(TrueMotion1Context *s)
221 {
222     int i;
223     struct frame_header header;
224     uint8_t header_buffer[128];  /* logical maximum size of the header */
225     uint8_t *sel_vector_table;
226
227     /* There is 1 change bit per 4 pixels, so each change byte represents
228      * 32 pixels; divide width by 4 to obtain the number of change bits and
229      * then round up to the nearest byte. */
230     s->mb_change_bits_row_size = ((s->avctx->width >> 2) + 7) >> 3;
231
232     header.header_size = ((s->buf[0] >> 5) | (s->buf[0] << 3)) & 0x7f;
233     if (s->buf[0] < 0x10)
234     {
235         printf("invalid header size\n");
236         return -1;
237     }
238
239     /* unscramble the header bytes with a XOR operation */
240     memset(header_buffer, 0, 128);
241     for (i = 1; i < header.header_size; i++)
242     header_buffer[i - 1] = s->buf[i] ^ s->buf[i + 1];
243     header.compression = header_buffer[0];
244     header.deltaset = header_buffer[1];
245     header.vectable = header_buffer[2];
246     header.ysize = LE_16(&header_buffer[3]);
247     header.xsize = LE_16(&header_buffer[5]);
248     header.checksum = LE_16(&header_buffer[7]);
249     header.version = header_buffer[9];
250     header.header_type = header_buffer[10];
251     header.flags = header_buffer[11];
252     header.control = header_buffer[12];
253
254     /* Version 2 */
255     if (header.version >= 2)
256     {
257         if (header.header_type > 3)
258         {
259             av_log(s->avctx, AV_LOG_ERROR, "truemotion1: invalid header type\n");
260             return -1;
261         } else if ((header.header_type == 2) || (header.header_type == 3)) {
262             s->flags = header.flags;
263             if (!(s->flags & FLAG_INTERFRAME))
264                 s->flags |= FLAG_KEYFRAME;
265         } else
266             s->flags = FLAG_KEYFRAME;
267     } else /* Version 1 */
268         s->flags = FLAG_KEYFRAME;
269     
270     if (s->flags & FLAG_SPRITE) {
271         s->w = header.width;
272         s->h = header.height;
273         s->x = header.xoffset;
274         s->y = header.yoffset;
275     } else {
276         s->w = header.xsize;
277         s->h = header.ysize;
278         if (header.header_type < 2) {
279             if ((s->w < 213) && (s->h >= 176))
280                 s->flags |= FLAG_INTERPOLATED;
281         }
282     }
283
284     if (header.compression > 17) {
285         printf("invalid compression type (%d)\n", header.compression);
286         return -1;
287     }
288     
289     if ((header.deltaset != s->last_deltaset) || 
290         (header.vectable != s->last_vectable))
291         select_delta_tables(s, header.deltaset);
292
293     if ((header.compression & 1) && header.header_type)
294         sel_vector_table = pc_tbl2;
295     else {
296         if (header.vectable < 4)
297             sel_vector_table = tables[header.vectable - 1];
298         else {
299             printf("invalid vector table id (%d)\n", header.vectable);
300             return -1;
301         }
302     }
303
304     if ((header.deltaset != s->last_deltaset) || (header.vectable != s->last_vectable))
305     {
306         if (compression_types[header.compression].algorithm == ALGO_RGB24H)
307         {
308             printf("24bit compression not yet supported\n");
309         }
310         else
311             gen_vector_table(s, sel_vector_table);
312     }
313
314     /* set up pointers to the other key data chunks */
315     s->mb_change_bits = s->buf + header.header_size;
316     if (s->flags & FLAG_KEYFRAME) {
317         /* no change bits specified for a keyframe; only index bytes */
318         s->index_stream = s->mb_change_bits;
319     } else {
320         /* one change bit per 4x4 block */
321         s->index_stream = s->mb_change_bits + 
322             (s->mb_change_bits_row_size * (s->avctx->height >> 2));
323     }
324     s->index_stream_size = s->size - (s->index_stream - s->buf);
325
326     s->last_deltaset = header.deltaset;
327     s->last_vectable = header.vectable;
328     s->compression = header.compression;
329     s->block_width = compression_types[header.compression].block_width;
330     s->block_height = compression_types[header.compression].block_height;
331     s->block_type = compression_types[header.compression].block_type;
332
333     return header.header_size;    
334 }
335
336 static int truemotion1_decode_init(AVCodecContext *avctx)
337 {
338     TrueMotion1Context *s = (TrueMotion1Context *)avctx->priv_data;
339
340     s->avctx = avctx;
341
342     avctx->pix_fmt = PIX_FMT_RGB555;
343     avctx->has_b_frames = 0;
344     s->frame.data[0] = s->prev_frame.data[0] = NULL;
345
346     /* there is a vertical predictor for each pixel in a line; each vertical
347      * predictor is 0 to start with */
348     s->vert_pred = 
349         (unsigned int *)av_malloc(s->avctx->width * sizeof(unsigned short));
350
351     return 0;
352 }
353
354 #define GET_NEXT_INDEX() \
355 {\
356     if (index_stream_index >= s->index_stream_size) { \
357         printf (" help! truemotion1 decoder went out of bounds\n"); \
358         return; \
359     } \
360     index = s->index_stream[index_stream_index++] * 4; \
361 }
362
363 #define APPLY_C_PREDICTOR() \
364     predictor_pair = s->c_predictor_table[index]; \
365     horiz_pred += (predictor_pair >> 1); \
366     if (predictor_pair & 1) { \
367         GET_NEXT_INDEX() \
368         if (!index) { \
369             GET_NEXT_INDEX() \
370             predictor_pair = s->c_predictor_table[index]; \
371             horiz_pred += ((predictor_pair >> 1) * 5); \
372             if (predictor_pair & 1) \
373                 GET_NEXT_INDEX() \
374             else \
375                 index++; \
376         } \
377     } else \
378         index++;
379
380 #define APPLY_Y_PREDICTOR() \
381     predictor_pair = s->y_predictor_table[index]; \
382     horiz_pred += (predictor_pair >> 1); \
383     if (predictor_pair & 1) { \
384         GET_NEXT_INDEX() \
385         if (!index) { \
386             GET_NEXT_INDEX() \
387             predictor_pair = s->y_predictor_table[index]; \
388             horiz_pred += ((predictor_pair >> 1) * 5); \
389             if (predictor_pair & 1) \
390                 GET_NEXT_INDEX() \
391             else \
392                 index++; \
393         } \
394     } else \
395         index++;
396
397 #define OUTPUT_PIXEL_PAIR() \
398     *current_pixel_pair = *vert_pred + horiz_pred; \
399     *vert_pred++ = *current_pixel_pair++; \
400     prev_pixel_pair++;
401
402 static void truemotion1_decode_16bit(TrueMotion1Context *s)
403 {
404     int y;
405     int pixels_left;  /* remaining pixels on this line */
406     unsigned int predictor_pair;
407     unsigned int horiz_pred;
408     unsigned int *vert_pred;
409     unsigned int *current_pixel_pair;
410     unsigned int *prev_pixel_pair;
411     unsigned char *current_line = s->frame.data[0];
412     unsigned char *prev_line = s->prev_frame.data[0];
413     int keyframe = s->flags & FLAG_KEYFRAME;
414
415     /* these variables are for managing the stream of macroblock change bits */
416     unsigned char *mb_change_bits = s->mb_change_bits;
417     unsigned char mb_change_byte;
418     unsigned char mb_change_byte_mask;
419     int mb_change_index;
420
421     /* these variables are for managing the main index stream */
422     int index_stream_index = 0;  /* yes, the index into the index stream */
423     int index;
424
425     /* clean out the line buffer */
426     memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned short));
427
428     GET_NEXT_INDEX();
429
430     for (y = 0; y < s->avctx->height; y++) {
431
432         /* re-init variables for the next line iteration */
433         horiz_pred = 0;
434         current_pixel_pair = (unsigned int *)current_line;
435         prev_pixel_pair = (unsigned int *)prev_line;
436         vert_pred = s->vert_pred;
437         mb_change_index = 0;
438         mb_change_byte = mb_change_bits[mb_change_index++];
439         mb_change_byte_mask = 0x01;
440         pixels_left = s->avctx->width;
441
442         while (pixels_left > 0) {
443
444             if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
445
446                 switch (y & 3) {
447                 case 0:
448                     /* if macroblock width is 2, apply C-Y-C-Y; else 
449                      * apply C-Y-Y */
450                     if (s->block_width == 2) {
451                         APPLY_C_PREDICTOR();
452                         APPLY_Y_PREDICTOR();
453                         OUTPUT_PIXEL_PAIR();
454                         APPLY_C_PREDICTOR();
455                         APPLY_Y_PREDICTOR();
456                         OUTPUT_PIXEL_PAIR();
457                     } else {
458                         APPLY_C_PREDICTOR();
459                         APPLY_Y_PREDICTOR();
460                         OUTPUT_PIXEL_PAIR();
461                         APPLY_Y_PREDICTOR();
462                         OUTPUT_PIXEL_PAIR();
463                     }
464                     break;
465
466                 case 1:
467                 case 3:
468                     /* always apply 2 Y predictors on these iterations */
469                     APPLY_Y_PREDICTOR();
470                     OUTPUT_PIXEL_PAIR();
471                     APPLY_Y_PREDICTOR();
472                     OUTPUT_PIXEL_PAIR();
473                     break;
474
475                 case 2:
476                     /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y 
477                      * depending on the macroblock type */
478                     if (s->block_type == BLOCK_2x2) {
479                         APPLY_C_PREDICTOR();
480                         APPLY_Y_PREDICTOR();
481                         OUTPUT_PIXEL_PAIR();
482                         APPLY_C_PREDICTOR();
483                         APPLY_Y_PREDICTOR();
484                         OUTPUT_PIXEL_PAIR();
485                     } else if (s->block_type == BLOCK_4x2) {
486                         APPLY_C_PREDICTOR();
487                         APPLY_Y_PREDICTOR();
488                         OUTPUT_PIXEL_PAIR();
489                         APPLY_Y_PREDICTOR();
490                         OUTPUT_PIXEL_PAIR();
491                     } else {
492                         APPLY_Y_PREDICTOR();
493                         OUTPUT_PIXEL_PAIR();
494                         APPLY_Y_PREDICTOR();
495                         OUTPUT_PIXEL_PAIR();
496                     }
497                     break;
498                 }
499
500             } else {
501
502                 /* skip (copy) four pixels, but reassign the horizontal 
503                  * predictor */
504                 *current_pixel_pair = *prev_pixel_pair++;
505                 *vert_pred++ = *current_pixel_pair++;
506                 *current_pixel_pair = *prev_pixel_pair++;
507                 horiz_pred = *current_pixel_pair - *vert_pred;
508                 *vert_pred++ = *current_pixel_pair++;
509                 
510             }
511
512             if (!keyframe) {
513                 mb_change_byte_mask <<= 1;
514
515                 /* next byte */
516                 if (!mb_change_byte_mask) {
517                     mb_change_byte = mb_change_bits[mb_change_index++];
518                     mb_change_byte_mask = 0x01;
519                 }
520             }
521
522             pixels_left -= 4;
523         }
524
525         /* next change row */
526         if (((y + 1) & 3) == 0)
527             mb_change_bits += s->mb_change_bits_row_size;
528
529         current_line += s->frame.linesize[0];
530         prev_line += s->prev_frame.linesize[0];
531     }
532 }
533
534 static int truemotion1_decode_frame(AVCodecContext *avctx,
535                                     void *data, int *data_size,
536                                     uint8_t *buf, int buf_size)
537 {
538     TrueMotion1Context *s = (TrueMotion1Context *)avctx->priv_data;
539
540     s->buf = buf;
541     s->size = buf_size;
542
543     s->frame.reference = 1;
544     if (avctx->get_buffer(avctx, &s->frame) < 0) {
545         fprintf(stderr, "truemotion1: get_buffer() failed\n");
546         return -1;
547     }
548
549     /* no supplementary picture */
550     if (buf_size == 0)
551         return 0;
552
553     *data_size = 0;
554     
555     if (truemotion1_decode_header(s) == -1)
556         return -1;
557
558     /* check for a do-nothing frame and copy the previous frame */
559     if (compression_types[s->compression].algorithm == ALGO_NOP)
560     {
561         memcpy(s->frame.data[0], s->prev_frame.data[0],
562             s->frame.linesize[0] * s->avctx->height);
563     } else if (compression_types[s->compression].algorithm == ALGO_RGB24H) {
564         printf ("  24-bit Duck TrueMotion decoding not yet implemented\n");
565     } else {
566         truemotion1_decode_16bit(s);
567     }
568
569     if (s->prev_frame.data[0])
570         avctx->release_buffer(avctx, &s->prev_frame);
571
572     /* shuffle frames */
573     s->prev_frame = s->frame;
574
575     *data_size = sizeof(AVFrame);
576     *(AVFrame*)data = s->frame;
577
578     /* report that the buffer was completely consumed */
579     return buf_size;
580 }
581
582 static int truemotion1_decode_end(AVCodecContext *avctx)
583 {
584     TrueMotion1Context *s = (TrueMotion1Context *)avctx->priv_data;
585
586     /* release the last frame */
587     if (s->prev_frame.data[0])
588         avctx->release_buffer(avctx, &s->prev_frame);
589
590     av_free(s->vert_pred);
591
592     return 0;
593 }
594
595 AVCodec truemotion1_decoder = {
596     "truemotion1",
597     CODEC_TYPE_VIDEO,
598     CODEC_ID_TRUEMOTION1,
599     sizeof(TrueMotion1Context),
600     truemotion1_decode_init,
601     NULL,
602     truemotion1_decode_end,
603     truemotion1_decode_frame,
604     CODEC_CAP_DR1,
605 };