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.
38 #include "libavutil/imgutils.h"
40 #include "truemotion1data.h"
42 typedef struct TrueMotion1Context {
43 AVCodecContext *avctx;
49 const uint8_t *mb_change_bits;
50 int mb_change_bits_row_size;
51 const uint8_t *index_stream;
52 int index_stream_size;
57 uint32_t y_predictor_table[1024];
58 uint32_t c_predictor_table[1024];
59 uint32_t fat_y_predictor_table[1024];
60 uint32_t fat_c_predictor_table[1024];
72 int last_deltaset, last_vectable;
74 unsigned int *vert_pred;
79 #define FLAG_SPRITE 32
80 #define FLAG_KEYFRAME 16
81 #define FLAG_INTERFRAME 8
82 #define FLAG_INTERPOLATED 4
103 #define ALGO_RGB16V 1
104 #define ALGO_RGB16H 2
105 #define ALGO_RGB24H 3
107 /* these are the various block sizes that can occupy a 4x4 block */
113 typedef struct comp_types {
115 int block_width; // vres
116 int block_height; // hres
120 /* { valid for metatype }, algorithm, num of deltas, vert res, horiz res */
121 static const comp_types compression_types[17] = {
122 { ALGO_NOP, 0, 0, 0 },
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 },
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 },
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 },
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 }
145 static void select_delta_tables(TrueMotion1Context *s, int delta_table_index)
149 if (delta_table_index > 3)
152 memcpy(s->ydt, ydts[delta_table_index], 8 * sizeof(int16_t));
153 memcpy(s->cdt, cdts[delta_table_index], 8 * sizeof(int16_t));
154 memcpy(s->fat_ydt, fat_ydts[delta_table_index], 8 * sizeof(int16_t));
155 memcpy(s->fat_cdt, fat_cdts[delta_table_index], 8 * sizeof(int16_t));
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++)
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) */
169 static int make_ydt15_entry(int p2, int p1, int16_t *ydt)
171 static int make_ydt15_entry(int p1, int p2, int16_t *ydt)
177 lo += (lo << 5) + (lo << 10);
179 hi += (hi << 5) + (hi << 10);
180 return (lo + (hi << 16)) << 1;
183 static int make_cdt15_entry(int p1, int p2, int16_t *cdt)
190 return (lo + (lo << 16)) << 1;
194 static int make_ydt16_entry(int p2, int p1, int16_t *ydt)
196 static int make_ydt16_entry(int p1, int p2, int16_t *ydt)
202 lo += (lo << 6) + (lo << 11);
204 hi += (hi << 6) + (hi << 11);
205 return (lo + (hi << 16)) << 1;
208 static int make_cdt16_entry(int p1, int p2, int16_t *cdt)
215 return (lo + (lo << 16)) << 1;
218 static int make_ydt24_entry(int p1, int p2, int16_t *ydt)
224 return (lo + (hi << 8) + (hi << 16)) << 1;
227 static int make_cdt24_entry(int p1, int p2, int16_t *cdt)
236 static void gen_vector_table15(TrueMotion1Context *s, const uint8_t *sel_vector_table)
239 unsigned char delta_pair;
241 for (i = 0; i < 1024; i += 4)
243 len = *sel_vector_table++ / 2;
244 for (j = 0; j < len; j++)
246 delta_pair = *sel_vector_table++;
247 s->y_predictor_table[i+j] = 0xfffffffe &
248 make_ydt15_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
249 s->c_predictor_table[i+j] = 0xfffffffe &
250 make_cdt15_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
252 s->y_predictor_table[i+(j-1)] |= 1;
253 s->c_predictor_table[i+(j-1)] |= 1;
257 static void gen_vector_table16(TrueMotion1Context *s, const uint8_t *sel_vector_table)
260 unsigned char delta_pair;
262 for (i = 0; i < 1024; i += 4)
264 len = *sel_vector_table++ / 2;
265 for (j = 0; j < len; j++)
267 delta_pair = *sel_vector_table++;
268 s->y_predictor_table[i+j] = 0xfffffffe &
269 make_ydt16_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
270 s->c_predictor_table[i+j] = 0xfffffffe &
271 make_cdt16_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
273 s->y_predictor_table[i+(j-1)] |= 1;
274 s->c_predictor_table[i+(j-1)] |= 1;
278 static void gen_vector_table24(TrueMotion1Context *s, const uint8_t *sel_vector_table)
281 unsigned char delta_pair;
283 for (i = 0; i < 1024; i += 4)
285 len = *sel_vector_table++ / 2;
286 for (j = 0; j < len; j++)
288 delta_pair = *sel_vector_table++;
289 s->y_predictor_table[i+j] = 0xfffffffe &
290 make_ydt24_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
291 s->c_predictor_table[i+j] = 0xfffffffe &
292 make_cdt24_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
293 s->fat_y_predictor_table[i+j] = 0xfffffffe &
294 make_ydt24_entry(delta_pair >> 4, delta_pair & 0xf, s->fat_ydt);
295 s->fat_c_predictor_table[i+j] = 0xfffffffe &
296 make_cdt24_entry(delta_pair >> 4, delta_pair & 0xf, s->fat_cdt);
298 s->y_predictor_table[i+(j-1)] |= 1;
299 s->c_predictor_table[i+(j-1)] |= 1;
300 s->fat_y_predictor_table[i+(j-1)] |= 1;
301 s->fat_c_predictor_table[i+(j-1)] |= 1;
305 /* Returns the number of bytes consumed from the bytestream. Returns -1 if
306 * there was an error while decoding the header */
307 static int truemotion1_decode_header(TrueMotion1Context *s)
312 struct frame_header header;
313 uint8_t header_buffer[128]; /* logical maximum size of the header */
314 const uint8_t *sel_vector_table;
316 header.header_size = ((s->buf[0] >> 5) | (s->buf[0] << 3)) & 0x7f;
317 if (s->buf[0] < 0x10)
319 av_log(s->avctx, AV_LOG_ERROR, "invalid header size (%d)\n", s->buf[0]);
323 /* unscramble the header bytes with a XOR operation */
324 memset(header_buffer, 0, 128);
325 for (i = 1; i < header.header_size; i++)
326 header_buffer[i - 1] = s->buf[i] ^ s->buf[i + 1];
328 header.compression = header_buffer[0];
329 header.deltaset = header_buffer[1];
330 header.vectable = header_buffer[2];
331 header.ysize = AV_RL16(&header_buffer[3]);
332 header.xsize = AV_RL16(&header_buffer[5]);
333 header.checksum = AV_RL16(&header_buffer[7]);
334 header.version = header_buffer[9];
335 header.header_type = header_buffer[10];
336 header.flags = header_buffer[11];
337 header.control = header_buffer[12];
340 if (header.version >= 2)
342 if (header.header_type > 3)
344 av_log(s->avctx, AV_LOG_ERROR, "invalid header type (%d)\n", header.header_type);
346 } else if ((header.header_type == 2) || (header.header_type == 3)) {
347 s->flags = header.flags;
348 if (!(s->flags & FLAG_INTERFRAME))
349 s->flags |= FLAG_KEYFRAME;
351 s->flags = FLAG_KEYFRAME;
352 } else /* Version 1 */
353 s->flags = FLAG_KEYFRAME;
355 if (s->flags & FLAG_SPRITE) {
356 av_log_ask_for_sample(s->avctx, "SPRITE frame found.\n");
357 /* FIXME header.width, height, xoffset and yoffset aren't initialized */
360 s->h = header.height;
361 s->x = header.xoffset;
362 s->y = header.yoffset;
369 if (header.header_type < 2) {
370 if ((s->w < 213) && (s->h >= 176))
372 s->flags |= FLAG_INTERPOLATED;
373 av_log_ask_for_sample(s->avctx, "INTERPOLATION selected.\n");
378 if (header.compression >= 17) {
379 av_log(s->avctx, AV_LOG_ERROR, "invalid compression type (%d)\n", header.compression);
383 if ((header.deltaset != s->last_deltaset) ||
384 (header.vectable != s->last_vectable))
385 select_delta_tables(s, header.deltaset);
387 if ((header.compression & 1) && header.header_type)
388 sel_vector_table = pc_tbl2;
390 if (header.vectable > 0 && header.vectable < 4)
391 sel_vector_table = tables[header.vectable - 1];
393 av_log(s->avctx, AV_LOG_ERROR, "invalid vector table id (%d)\n", header.vectable);
398 if (compression_types[header.compression].algorithm == ALGO_RGB24H) {
399 new_pix_fmt = PIX_FMT_RGB32;
402 new_pix_fmt = PIX_FMT_RGB555; // RGB565 is supported as well
404 s->w >>= width_shift;
405 if (av_image_check_size(s->w, s->h, 0, s->avctx) < 0)
408 if (s->w != s->avctx->width || s->h != s->avctx->height ||
409 new_pix_fmt != s->avctx->pix_fmt) {
410 if (s->frame.data[0])
411 s->avctx->release_buffer(s->avctx, &s->frame);
412 s->avctx->sample_aspect_ratio = (AVRational){ 1 << width_shift, 1 };
413 s->avctx->pix_fmt = new_pix_fmt;
414 avcodec_set_dimensions(s->avctx, s->w, s->h);
415 av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
418 /* There is 1 change bit per 4 pixels, so each change byte represents
419 * 32 pixels; divide width by 4 to obtain the number of change bits and
420 * then round up to the nearest byte. */
421 s->mb_change_bits_row_size = ((s->avctx->width >> (2 - width_shift)) + 7) >> 3;
423 if ((header.deltaset != s->last_deltaset) || (header.vectable != s->last_vectable))
425 if (compression_types[header.compression].algorithm == ALGO_RGB24H)
426 gen_vector_table24(s, sel_vector_table);
428 if (s->avctx->pix_fmt == PIX_FMT_RGB555)
429 gen_vector_table15(s, sel_vector_table);
431 gen_vector_table16(s, sel_vector_table);
434 /* set up pointers to the other key data chunks */
435 s->mb_change_bits = s->buf + header.header_size;
436 if (s->flags & FLAG_KEYFRAME) {
437 /* no change bits specified for a keyframe; only index bytes */
438 s->index_stream = s->mb_change_bits;
440 /* one change bit per 4x4 block */
441 s->index_stream = s->mb_change_bits +
442 (s->mb_change_bits_row_size * (s->avctx->height >> 2));
444 s->index_stream_size = s->size - (s->index_stream - s->buf);
446 s->last_deltaset = header.deltaset;
447 s->last_vectable = header.vectable;
448 s->compression = header.compression;
449 s->block_width = compression_types[header.compression].block_width;
450 s->block_height = compression_types[header.compression].block_height;
451 s->block_type = compression_types[header.compression].block_type;
453 if (s->avctx->debug & FF_DEBUG_PICT_INFO)
454 av_log(s->avctx, AV_LOG_INFO, "tables: %d / %d c:%d %dx%d t:%d %s%s%s%s\n",
455 s->last_deltaset, s->last_vectable, s->compression, s->block_width,
456 s->block_height, s->block_type,
457 s->flags & FLAG_KEYFRAME ? " KEY" : "",
458 s->flags & FLAG_INTERFRAME ? " INTER" : "",
459 s->flags & FLAG_SPRITE ? " SPRITE" : "",
460 s->flags & FLAG_INTERPOLATED ? " INTERPOL" : "");
462 return header.header_size;
465 static av_cold int truemotion1_decode_init(AVCodecContext *avctx)
467 TrueMotion1Context *s = avctx->priv_data;
471 // FIXME: it may change ?
472 // if (avctx->bits_per_sample == 24)
473 // avctx->pix_fmt = PIX_FMT_RGB24;
475 // avctx->pix_fmt = PIX_FMT_RGB555;
477 avcodec_get_frame_defaults(&s->frame);
478 s->frame.data[0] = NULL;
480 /* there is a vertical predictor for each pixel in a line; each vertical
481 * predictor is 0 to start with */
482 av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
488 Block decoding order:
494 hres,vres,i,i%vres (0 < i < 4)
513 #define GET_NEXT_INDEX() \
515 if (index_stream_index >= s->index_stream_size) { \
516 av_log(s->avctx, AV_LOG_INFO, " help! truemotion1 decoder went out of bounds\n"); \
519 index = s->index_stream[index_stream_index++] * 4; \
522 #define APPLY_C_PREDICTOR() \
523 predictor_pair = s->c_predictor_table[index]; \
524 horiz_pred += (predictor_pair >> 1); \
525 if (predictor_pair & 1) { \
529 predictor_pair = s->c_predictor_table[index]; \
530 horiz_pred += ((predictor_pair >> 1) * 5); \
531 if (predictor_pair & 1) \
539 #define APPLY_C_PREDICTOR_24() \
540 predictor_pair = s->c_predictor_table[index]; \
541 horiz_pred += (predictor_pair >> 1); \
542 if (predictor_pair & 1) { \
546 predictor_pair = s->fat_c_predictor_table[index]; \
547 horiz_pred += (predictor_pair >> 1); \
548 if (predictor_pair & 1) \
557 #define APPLY_Y_PREDICTOR() \
558 predictor_pair = s->y_predictor_table[index]; \
559 horiz_pred += (predictor_pair >> 1); \
560 if (predictor_pair & 1) { \
564 predictor_pair = s->y_predictor_table[index]; \
565 horiz_pred += ((predictor_pair >> 1) * 5); \
566 if (predictor_pair & 1) \
574 #define APPLY_Y_PREDICTOR_24() \
575 predictor_pair = s->y_predictor_table[index]; \
576 horiz_pred += (predictor_pair >> 1); \
577 if (predictor_pair & 1) { \
581 predictor_pair = s->fat_y_predictor_table[index]; \
582 horiz_pred += (predictor_pair >> 1); \
583 if (predictor_pair & 1) \
591 #define OUTPUT_PIXEL_PAIR() \
592 *current_pixel_pair = *vert_pred + horiz_pred; \
593 *vert_pred++ = *current_pixel_pair++;
595 static void truemotion1_decode_16bit(TrueMotion1Context *s)
598 int pixels_left; /* remaining pixels on this line */
599 unsigned int predictor_pair;
600 unsigned int horiz_pred;
601 unsigned int *vert_pred;
602 unsigned int *current_pixel_pair;
603 unsigned char *current_line = s->frame.data[0];
604 int keyframe = s->flags & FLAG_KEYFRAME;
606 /* these variables are for managing the stream of macroblock change bits */
607 const unsigned char *mb_change_bits = s->mb_change_bits;
608 unsigned char mb_change_byte;
609 unsigned char mb_change_byte_mask;
612 /* these variables are for managing the main index stream */
613 int index_stream_index = 0; /* yes, the index into the index stream */
616 /* clean out the line buffer */
617 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
621 for (y = 0; y < s->avctx->height; y++) {
623 /* re-init variables for the next line iteration */
625 current_pixel_pair = (unsigned int *)current_line;
626 vert_pred = s->vert_pred;
628 mb_change_byte = mb_change_bits[mb_change_index++];
629 mb_change_byte_mask = 0x01;
630 pixels_left = s->avctx->width;
632 while (pixels_left > 0) {
634 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
638 /* if macroblock width is 2, apply C-Y-C-Y; else
640 if (s->block_width == 2) {
658 /* always apply 2 Y predictors on these iterations */
666 /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
667 * depending on the macroblock type */
668 if (s->block_type == BLOCK_2x2) {
675 } else if (s->block_type == BLOCK_4x2) {
692 /* skip (copy) four pixels, but reassign the horizontal
694 *vert_pred++ = *current_pixel_pair++;
695 horiz_pred = *current_pixel_pair - *vert_pred;
696 *vert_pred++ = *current_pixel_pair++;
701 mb_change_byte_mask <<= 1;
704 if (!mb_change_byte_mask) {
705 mb_change_byte = mb_change_bits[mb_change_index++];
706 mb_change_byte_mask = 0x01;
713 /* next change row */
714 if (((y + 1) & 3) == 0)
715 mb_change_bits += s->mb_change_bits_row_size;
717 current_line += s->frame.linesize[0];
721 static void truemotion1_decode_24bit(TrueMotion1Context *s)
724 int pixels_left; /* remaining pixels on this line */
725 unsigned int predictor_pair;
726 unsigned int horiz_pred;
727 unsigned int *vert_pred;
728 unsigned int *current_pixel_pair;
729 unsigned char *current_line = s->frame.data[0];
730 int keyframe = s->flags & FLAG_KEYFRAME;
732 /* these variables are for managing the stream of macroblock change bits */
733 const unsigned char *mb_change_bits = s->mb_change_bits;
734 unsigned char mb_change_byte;
735 unsigned char mb_change_byte_mask;
738 /* these variables are for managing the main index stream */
739 int index_stream_index = 0; /* yes, the index into the index stream */
742 /* clean out the line buffer */
743 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
747 for (y = 0; y < s->avctx->height; y++) {
749 /* re-init variables for the next line iteration */
751 current_pixel_pair = (unsigned int *)current_line;
752 vert_pred = s->vert_pred;
754 mb_change_byte = mb_change_bits[mb_change_index++];
755 mb_change_byte_mask = 0x01;
756 pixels_left = s->avctx->width;
758 while (pixels_left > 0) {
760 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
764 /* if macroblock width is 2, apply C-Y-C-Y; else
766 if (s->block_width == 2) {
767 APPLY_C_PREDICTOR_24();
768 APPLY_Y_PREDICTOR_24();
770 APPLY_C_PREDICTOR_24();
771 APPLY_Y_PREDICTOR_24();
774 APPLY_C_PREDICTOR_24();
775 APPLY_Y_PREDICTOR_24();
777 APPLY_Y_PREDICTOR_24();
784 /* always apply 2 Y predictors on these iterations */
785 APPLY_Y_PREDICTOR_24();
787 APPLY_Y_PREDICTOR_24();
792 /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
793 * depending on the macroblock type */
794 if (s->block_type == BLOCK_2x2) {
795 APPLY_C_PREDICTOR_24();
796 APPLY_Y_PREDICTOR_24();
798 APPLY_C_PREDICTOR_24();
799 APPLY_Y_PREDICTOR_24();
801 } else if (s->block_type == BLOCK_4x2) {
802 APPLY_C_PREDICTOR_24();
803 APPLY_Y_PREDICTOR_24();
805 APPLY_Y_PREDICTOR_24();
808 APPLY_Y_PREDICTOR_24();
810 APPLY_Y_PREDICTOR_24();
818 /* skip (copy) four pixels, but reassign the horizontal
820 *vert_pred++ = *current_pixel_pair++;
821 horiz_pred = *current_pixel_pair - *vert_pred;
822 *vert_pred++ = *current_pixel_pair++;
827 mb_change_byte_mask <<= 1;
830 if (!mb_change_byte_mask) {
831 mb_change_byte = mb_change_bits[mb_change_index++];
832 mb_change_byte_mask = 0x01;
839 /* next change row */
840 if (((y + 1) & 3) == 0)
841 mb_change_bits += s->mb_change_bits_row_size;
843 current_line += s->frame.linesize[0];
848 static int truemotion1_decode_frame(AVCodecContext *avctx,
849 void *data, int *data_size,
852 const uint8_t *buf = avpkt->data;
853 int buf_size = avpkt->size;
854 TrueMotion1Context *s = avctx->priv_data;
859 if (truemotion1_decode_header(s) == -1)
862 s->frame.reference = 3;
863 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID |
864 FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
865 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
866 av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
870 if (compression_types[s->compression].algorithm == ALGO_RGB24H) {
871 truemotion1_decode_24bit(s);
872 } else if (compression_types[s->compression].algorithm != ALGO_NOP) {
873 truemotion1_decode_16bit(s);
876 *data_size = sizeof(AVFrame);
877 *(AVFrame*)data = s->frame;
879 /* report that the buffer was completely consumed */
883 static av_cold int truemotion1_decode_end(AVCodecContext *avctx)
885 TrueMotion1Context *s = avctx->priv_data;
887 if (s->frame.data[0])
888 avctx->release_buffer(avctx, &s->frame);
890 av_free(s->vert_pred);
895 AVCodec ff_truemotion1_decoder = {
896 .name = "truemotion1",
897 .type = AVMEDIA_TYPE_VIDEO,
898 .id = CODEC_ID_TRUEMOTION1,
899 .priv_data_size = sizeof(TrueMotion1Context),
900 .init = truemotion1_decode_init,
901 .close = truemotion1_decode_end,
902 .decode = truemotion1_decode_frame,
903 .capabilities = CODEC_CAP_DR1,
904 .long_name = NULL_IF_CONFIG_SMALL("Duck TrueMotion 1.0"),