2 * Duck TrueMotion 1.0 Decoder
3 * Copyright (C) 2003 Alex Beregszaszi & Mike Melanson
5 * This file is part of FFmpeg.
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.
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.
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
24 * Duck TrueMotion v1 Video Decoder by
25 * Alex Beregszaszi and
26 * Mike Melanson (melanson@pcisys.net)
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.
39 #include "truemotion1data.h"
41 typedef struct TrueMotion1Context {
42 AVCodecContext *avctx;
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;
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];
71 int last_deltaset, last_vectable;
73 unsigned int *vert_pred;
77 #define FLAG_SPRITE 32
78 #define FLAG_KEYFRAME 16
79 #define FLAG_INTERFRAME 8
80 #define FLAG_INTERPOLATED 4
101 #define ALGO_RGB16V 1
102 #define ALGO_RGB16H 2
103 #define ALGO_RGB24H 3
105 /* these are the various block sizes that can occupy a 4x4 block */
111 typedef struct comp_types {
113 int block_width; // vres
114 int block_height; // hres
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 },
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 },
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 },
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 },
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 }
143 static void select_delta_tables(TrueMotion1Context *s, int delta_table_index)
147 if (delta_table_index > 3)
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));
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++)
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) */
167 static int make_ydt15_entry(int p2, int p1, int16_t *ydt)
169 static int make_ydt15_entry(int p1, int p2, int16_t *ydt)
175 lo += (lo << 5) + (lo << 10);
177 hi += (hi << 5) + (hi << 10);
178 return (lo + (hi << 16)) << 1;
181 static int make_cdt15_entry(int p1, int p2, int16_t *cdt)
188 return (lo + (lo << 16)) << 1;
192 static int make_ydt16_entry(int p2, int p1, int16_t *ydt)
194 static int make_ydt16_entry(int p1, int p2, int16_t *ydt)
200 lo += (lo << 6) + (lo << 11);
202 hi += (hi << 6) + (hi << 11);
203 return (lo + (hi << 16)) << 1;
206 static int make_cdt16_entry(int p1, int p2, int16_t *cdt)
213 return (lo + (lo << 16)) << 1;
216 static int make_ydt24_entry(int p1, int p2, int16_t *ydt)
222 return (lo + (hi << 8) + (hi << 16)) << 1;
225 static int make_cdt24_entry(int p1, int p2, int16_t *cdt)
234 static void gen_vector_table15(TrueMotion1Context *s, const uint8_t *sel_vector_table)
237 unsigned char delta_pair;
239 for (i = 0; i < 1024; i += 4)
241 len = *sel_vector_table++ / 2;
242 for (j = 0; j < len; j++)
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);
250 s->y_predictor_table[i+(j-1)] |= 1;
251 s->c_predictor_table[i+(j-1)] |= 1;
255 static void gen_vector_table16(TrueMotion1Context *s, const uint8_t *sel_vector_table)
258 unsigned char delta_pair;
260 for (i = 0; i < 1024; i += 4)
262 len = *sel_vector_table++ / 2;
263 for (j = 0; j < len; j++)
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);
271 s->y_predictor_table[i+(j-1)] |= 1;
272 s->c_predictor_table[i+(j-1)] |= 1;
276 static void gen_vector_table24(TrueMotion1Context *s, const uint8_t *sel_vector_table)
279 unsigned char delta_pair;
281 for (i = 0; i < 1024; i += 4)
283 len = *sel_vector_table++ / 2;
284 for (j = 0; j < len; j++)
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);
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;
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)
308 struct frame_header header;
309 uint8_t header_buffer[128]; /* logical maximum size of the header */
310 const uint8_t *sel_vector_table;
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;
317 header.header_size = ((s->buf[0] >> 5) | (s->buf[0] << 3)) & 0x7f;
318 if (s->buf[0] < 0x10)
320 av_log(s->avctx, AV_LOG_ERROR, "invalid header size (%d)\n", s->buf[0]);
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];
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];
341 if (header.version >= 2)
343 if (header.header_type > 3)
345 av_log(s->avctx, AV_LOG_ERROR, "invalid header type (%d)\n", header.header_type);
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;
352 s->flags = FLAG_KEYFRAME;
353 } else /* Version 1 */
354 s->flags = FLAG_KEYFRAME;
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 */
361 s->h = header.height;
362 s->x = header.xoffset;
363 s->y = header.yoffset;
370 if (header.header_type < 2) {
371 if ((s->w < 213) && (s->h >= 176))
373 s->flags |= FLAG_INTERPOLATED;
374 av_log(s->avctx, AV_LOG_INFO, "INTERPOLATION selected, please report the sample to the developers\n");
379 if (header.compression >= 17) {
380 av_log(s->avctx, AV_LOG_ERROR, "invalid compression type (%d)\n", header.compression);
384 if ((header.deltaset != s->last_deltaset) ||
385 (header.vectable != s->last_vectable))
386 select_delta_tables(s, header.deltaset);
388 if ((header.compression & 1) && header.header_type)
389 sel_vector_table = pc_tbl2;
391 if (header.vectable < 4)
392 sel_vector_table = tables[header.vectable - 1];
394 av_log(s->avctx, AV_LOG_ERROR, "invalid vector table id (%d)\n", header.vectable);
399 // FIXME: where to place this ?!?!
400 if (compression_types[header.compression].algorithm == ALGO_RGB24H)
401 s->avctx->pix_fmt = PIX_FMT_RGB32;
403 s->avctx->pix_fmt = PIX_FMT_RGB555; // RGB565 is supported as well
405 if ((header.deltaset != s->last_deltaset) || (header.vectable != s->last_vectable))
407 if (compression_types[header.compression].algorithm == ALGO_RGB24H)
408 gen_vector_table24(s, sel_vector_table);
410 if (s->avctx->pix_fmt == PIX_FMT_RGB555)
411 gen_vector_table15(s, sel_vector_table);
413 gen_vector_table16(s, sel_vector_table);
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;
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));
426 s->index_stream_size = s->size - (s->index_stream - s->buf);
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;
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" : "");
444 return header.header_size;
447 static av_cold int truemotion1_decode_init(AVCodecContext *avctx)
449 TrueMotion1Context *s = avctx->priv_data;
453 // FIXME: it may change ?
454 // if (avctx->bits_per_sample == 24)
455 // avctx->pix_fmt = PIX_FMT_RGB24;
457 // avctx->pix_fmt = PIX_FMT_RGB555;
459 s->frame.data[0] = NULL;
461 /* there is a vertical predictor for each pixel in a line; each vertical
462 * predictor is 0 to start with */
464 (unsigned int *)av_malloc(s->avctx->width * sizeof(unsigned int));
470 Block decoding order:
476 hres,vres,i,i%vres (0 < i < 4)
495 #define GET_NEXT_INDEX() \
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"); \
501 index = s->index_stream[index_stream_index++] * 4; \
504 #define APPLY_C_PREDICTOR() \
505 predictor_pair = s->c_predictor_table[index]; \
506 horiz_pred += (predictor_pair >> 1); \
507 if (predictor_pair & 1) { \
511 predictor_pair = s->c_predictor_table[index]; \
512 horiz_pred += ((predictor_pair >> 1) * 5); \
513 if (predictor_pair & 1) \
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) { \
528 predictor_pair = s->fat_c_predictor_table[index]; \
529 horiz_pred += (predictor_pair >> 1); \
530 if (predictor_pair & 1) \
539 #define APPLY_Y_PREDICTOR() \
540 predictor_pair = s->y_predictor_table[index]; \
541 horiz_pred += (predictor_pair >> 1); \
542 if (predictor_pair & 1) { \
546 predictor_pair = s->y_predictor_table[index]; \
547 horiz_pred += ((predictor_pair >> 1) * 5); \
548 if (predictor_pair & 1) \
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) { \
563 predictor_pair = s->fat_y_predictor_table[index]; \
564 horiz_pred += (predictor_pair >> 1); \
565 if (predictor_pair & 1) \
573 #define OUTPUT_PIXEL_PAIR() \
574 *current_pixel_pair = *vert_pred + horiz_pred; \
575 *vert_pred++ = *current_pixel_pair++;
577 static void truemotion1_decode_16bit(TrueMotion1Context *s)
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;
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;
594 /* these variables are for managing the main index stream */
595 int index_stream_index = 0; /* yes, the index into the index stream */
598 /* clean out the line buffer */
599 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
603 for (y = 0; y < s->avctx->height; y++) {
605 /* re-init variables for the next line iteration */
607 current_pixel_pair = (unsigned int *)current_line;
608 vert_pred = s->vert_pred;
610 mb_change_byte = mb_change_bits[mb_change_index++];
611 mb_change_byte_mask = 0x01;
612 pixels_left = s->avctx->width;
614 while (pixels_left > 0) {
616 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
620 /* if macroblock width is 2, apply C-Y-C-Y; else
622 if (s->block_width == 2) {
640 /* always apply 2 Y predictors on these iterations */
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) {
657 } else if (s->block_type == BLOCK_4x2) {
674 /* skip (copy) four pixels, but reassign the horizontal
676 *vert_pred++ = *current_pixel_pair++;
677 horiz_pred = *current_pixel_pair - *vert_pred;
678 *vert_pred++ = *current_pixel_pair++;
683 mb_change_byte_mask <<= 1;
686 if (!mb_change_byte_mask) {
687 mb_change_byte = mb_change_bits[mb_change_index++];
688 mb_change_byte_mask = 0x01;
695 /* next change row */
696 if (((y + 1) & 3) == 0)
697 mb_change_bits += s->mb_change_bits_row_size;
699 current_line += s->frame.linesize[0];
703 static void truemotion1_decode_24bit(TrueMotion1Context *s)
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;
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;
720 /* these variables are for managing the main index stream */
721 int index_stream_index = 0; /* yes, the index into the index stream */
724 /* clean out the line buffer */
725 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
729 for (y = 0; y < s->avctx->height; y++) {
731 /* re-init variables for the next line iteration */
733 current_pixel_pair = (unsigned int *)current_line;
734 vert_pred = s->vert_pred;
736 mb_change_byte = mb_change_bits[mb_change_index++];
737 mb_change_byte_mask = 0x01;
738 pixels_left = s->avctx->width;
740 while (pixels_left > 0) {
742 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
746 /* if macroblock width is 2, apply C-Y-C-Y; else
748 if (s->block_width == 2) {
749 APPLY_C_PREDICTOR_24();
750 APPLY_Y_PREDICTOR_24();
752 APPLY_C_PREDICTOR_24();
753 APPLY_Y_PREDICTOR_24();
756 APPLY_C_PREDICTOR_24();
757 APPLY_Y_PREDICTOR_24();
759 APPLY_Y_PREDICTOR_24();
766 /* always apply 2 Y predictors on these iterations */
767 APPLY_Y_PREDICTOR_24();
769 APPLY_Y_PREDICTOR_24();
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();
780 APPLY_C_PREDICTOR_24();
781 APPLY_Y_PREDICTOR_24();
783 } else if (s->block_type == BLOCK_4x2) {
784 APPLY_C_PREDICTOR_24();
785 APPLY_Y_PREDICTOR_24();
787 APPLY_Y_PREDICTOR_24();
790 APPLY_Y_PREDICTOR_24();
792 APPLY_Y_PREDICTOR_24();
800 /* skip (copy) four pixels, but reassign the horizontal
802 *vert_pred++ = *current_pixel_pair++;
803 horiz_pred = *current_pixel_pair - *vert_pred;
804 *vert_pred++ = *current_pixel_pair++;
809 mb_change_byte_mask <<= 1;
812 if (!mb_change_byte_mask) {
813 mb_change_byte = mb_change_bits[mb_change_index++];
814 mb_change_byte_mask = 0x01;
821 /* next change row */
822 if (((y + 1) & 3) == 0)
823 mb_change_bits += s->mb_change_bits_row_size;
825 current_line += s->frame.linesize[0];
830 static int truemotion1_decode_frame(AVCodecContext *avctx,
831 void *data, int *data_size,
834 const uint8_t *buf = avpkt->data;
835 int buf_size = avpkt->size;
836 TrueMotion1Context *s = avctx->priv_data;
841 if (truemotion1_decode_header(s) == -1)
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");
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);
858 *data_size = sizeof(AVFrame);
859 *(AVFrame*)data = s->frame;
861 /* report that the buffer was completely consumed */
865 static av_cold int truemotion1_decode_end(AVCodecContext *avctx)
867 TrueMotion1Context *s = avctx->priv_data;
869 if (s->frame.data[0])
870 avctx->release_buffer(avctx, &s->frame);
872 av_free(s->vert_pred);
877 AVCodec truemotion1_decoder = {
880 CODEC_ID_TRUEMOTION1,
881 sizeof(TrueMotion1Context),
882 truemotion1_decode_init,
884 truemotion1_decode_end,
885 truemotion1_decode_frame,
887 .long_name = NULL_IF_CONFIG_SMALL("Duck TrueMotion 1.0"),