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] = { 0 }; /* 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 || header.header_size >= s->size)
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 for (i = 1; i < header.header_size; i++)
325 header_buffer[i - 1] = s->buf[i] ^ s->buf[i + 1];
327 header.compression = header_buffer[0];
328 header.deltaset = header_buffer[1];
329 header.vectable = header_buffer[2];
330 header.ysize = AV_RL16(&header_buffer[3]);
331 header.xsize = AV_RL16(&header_buffer[5]);
332 header.checksum = AV_RL16(&header_buffer[7]);
333 header.version = header_buffer[9];
334 header.header_type = header_buffer[10];
335 header.flags = header_buffer[11];
336 header.control = header_buffer[12];
339 if (header.version >= 2)
341 if (header.header_type > 3)
343 av_log(s->avctx, AV_LOG_ERROR, "invalid header type (%d)\n", header.header_type);
345 } else if ((header.header_type == 2) || (header.header_type == 3)) {
346 s->flags = header.flags;
347 if (!(s->flags & FLAG_INTERFRAME))
348 s->flags |= FLAG_KEYFRAME;
350 s->flags = FLAG_KEYFRAME;
351 } else /* Version 1 */
352 s->flags = FLAG_KEYFRAME;
354 if (s->flags & FLAG_SPRITE) {
355 av_log_ask_for_sample(s->avctx, "SPRITE frame found.\n");
356 /* FIXME header.width, height, xoffset and yoffset aren't initialized */
361 if (header.header_type < 2) {
362 if ((s->w < 213) && (s->h >= 176))
364 s->flags |= FLAG_INTERPOLATED;
365 av_log_ask_for_sample(s->avctx, "INTERPOLATION selected.\n");
370 if (header.compression >= 17) {
371 av_log(s->avctx, AV_LOG_ERROR, "invalid compression type (%d)\n", header.compression);
375 if ((header.deltaset != s->last_deltaset) ||
376 (header.vectable != s->last_vectable))
377 select_delta_tables(s, header.deltaset);
379 if ((header.compression & 1) && header.header_type)
380 sel_vector_table = pc_tbl2;
382 if (header.vectable > 0 && header.vectable < 4)
383 sel_vector_table = tables[header.vectable - 1];
385 av_log(s->avctx, AV_LOG_ERROR, "invalid vector table id (%d)\n", header.vectable);
390 if (compression_types[header.compression].algorithm == ALGO_RGB24H) {
391 new_pix_fmt = PIX_FMT_RGB32;
394 new_pix_fmt = PIX_FMT_RGB555; // RGB565 is supported as well
396 s->w >>= width_shift;
397 if (av_image_check_size(s->w, s->h, 0, s->avctx) < 0)
400 if (s->w != s->avctx->width || s->h != s->avctx->height ||
401 new_pix_fmt != s->avctx->pix_fmt) {
402 if (s->frame.data[0])
403 s->avctx->release_buffer(s->avctx, &s->frame);
404 s->avctx->sample_aspect_ratio = (AVRational){ 1 << width_shift, 1 };
405 s->avctx->pix_fmt = new_pix_fmt;
406 avcodec_set_dimensions(s->avctx, s->w, s->h);
407 av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
410 /* There is 1 change bit per 4 pixels, so each change byte represents
411 * 32 pixels; divide width by 4 to obtain the number of change bits and
412 * then round up to the nearest byte. */
413 s->mb_change_bits_row_size = ((s->avctx->width >> (2 - width_shift)) + 7) >> 3;
415 if ((header.deltaset != s->last_deltaset) || (header.vectable != s->last_vectable))
417 if (compression_types[header.compression].algorithm == ALGO_RGB24H)
418 gen_vector_table24(s, sel_vector_table);
420 if (s->avctx->pix_fmt == PIX_FMT_RGB555)
421 gen_vector_table15(s, sel_vector_table);
423 gen_vector_table16(s, sel_vector_table);
426 /* set up pointers to the other key data chunks */
427 s->mb_change_bits = s->buf + header.header_size;
428 if (s->flags & FLAG_KEYFRAME) {
429 /* no change bits specified for a keyframe; only index bytes */
430 s->index_stream = s->mb_change_bits;
432 /* one change bit per 4x4 block */
433 s->index_stream = s->mb_change_bits +
434 (s->mb_change_bits_row_size * (s->avctx->height >> 2));
436 s->index_stream_size = s->size - (s->index_stream - s->buf);
438 s->last_deltaset = header.deltaset;
439 s->last_vectable = header.vectable;
440 s->compression = header.compression;
441 s->block_width = compression_types[header.compression].block_width;
442 s->block_height = compression_types[header.compression].block_height;
443 s->block_type = compression_types[header.compression].block_type;
445 if (s->avctx->debug & FF_DEBUG_PICT_INFO)
446 av_log(s->avctx, AV_LOG_INFO, "tables: %d / %d c:%d %dx%d t:%d %s%s%s%s\n",
447 s->last_deltaset, s->last_vectable, s->compression, s->block_width,
448 s->block_height, s->block_type,
449 s->flags & FLAG_KEYFRAME ? " KEY" : "",
450 s->flags & FLAG_INTERFRAME ? " INTER" : "",
451 s->flags & FLAG_SPRITE ? " SPRITE" : "",
452 s->flags & FLAG_INTERPOLATED ? " INTERPOL" : "");
454 return header.header_size;
457 static av_cold int truemotion1_decode_init(AVCodecContext *avctx)
459 TrueMotion1Context *s = avctx->priv_data;
463 // FIXME: it may change ?
464 // if (avctx->bits_per_sample == 24)
465 // avctx->pix_fmt = PIX_FMT_RGB24;
467 // avctx->pix_fmt = PIX_FMT_RGB555;
469 avcodec_get_frame_defaults(&s->frame);
470 s->frame.data[0] = NULL;
472 /* there is a vertical predictor for each pixel in a line; each vertical
473 * predictor is 0 to start with */
474 av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
480 Block decoding order:
486 hres,vres,i,i%vres (0 < i < 4)
505 #define GET_NEXT_INDEX() \
507 if (index_stream_index >= s->index_stream_size) { \
508 av_log(s->avctx, AV_LOG_INFO, " help! truemotion1 decoder went out of bounds\n"); \
511 index = s->index_stream[index_stream_index++] * 4; \
514 #define APPLY_C_PREDICTOR() \
516 av_log(s->avctx, AV_LOG_ERROR, " index %d went out of bounds\n", index); \
519 predictor_pair = s->c_predictor_table[index]; \
520 horiz_pred += (predictor_pair >> 1); \
521 if (predictor_pair & 1) { \
525 predictor_pair = s->c_predictor_table[index]; \
526 horiz_pred += ((predictor_pair >> 1) * 5); \
527 if (predictor_pair & 1) \
535 #define APPLY_C_PREDICTOR_24() \
537 av_log(s->avctx, AV_LOG_ERROR, " index %d went out of bounds\n", index); \
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() \
559 av_log(s->avctx, AV_LOG_ERROR, " index %d went out of bounds\n", index); \
562 predictor_pair = s->y_predictor_table[index]; \
563 horiz_pred += (predictor_pair >> 1); \
564 if (predictor_pair & 1) { \
568 predictor_pair = s->y_predictor_table[index]; \
569 horiz_pred += ((predictor_pair >> 1) * 5); \
570 if (predictor_pair & 1) \
578 #define APPLY_Y_PREDICTOR_24() \
580 av_log(s->avctx, AV_LOG_ERROR, " index %d went out of bounds\n", index); \
583 predictor_pair = s->y_predictor_table[index]; \
584 horiz_pred += (predictor_pair >> 1); \
585 if (predictor_pair & 1) { \
589 predictor_pair = s->fat_y_predictor_table[index]; \
590 horiz_pred += (predictor_pair >> 1); \
591 if (predictor_pair & 1) \
599 #define OUTPUT_PIXEL_PAIR() \
600 *current_pixel_pair = *vert_pred + horiz_pred; \
601 *vert_pred++ = *current_pixel_pair++;
603 static void truemotion1_decode_16bit(TrueMotion1Context *s)
606 int pixels_left; /* remaining pixels on this line */
607 unsigned int predictor_pair;
608 unsigned int horiz_pred;
609 unsigned int *vert_pred;
610 unsigned int *current_pixel_pair;
611 unsigned char *current_line = s->frame.data[0];
612 int keyframe = s->flags & FLAG_KEYFRAME;
614 /* these variables are for managing the stream of macroblock change bits */
615 const unsigned char *mb_change_bits = s->mb_change_bits;
616 unsigned char mb_change_byte;
617 unsigned char mb_change_byte_mask;
620 /* these variables are for managing the main index stream */
621 int index_stream_index = 0; /* yes, the index into the index stream */
624 /* clean out the line buffer */
625 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
629 for (y = 0; y < s->avctx->height; y++) {
631 /* re-init variables for the next line iteration */
633 current_pixel_pair = (unsigned int *)current_line;
634 vert_pred = s->vert_pred;
636 mb_change_byte = mb_change_bits[mb_change_index++];
637 mb_change_byte_mask = 0x01;
638 pixels_left = s->avctx->width;
640 while (pixels_left > 0) {
642 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
646 /* if macroblock width is 2, apply C-Y-C-Y; else
648 if (s->block_width == 2) {
666 /* always apply 2 Y predictors on these iterations */
674 /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
675 * depending on the macroblock type */
676 if (s->block_type == BLOCK_2x2) {
683 } else if (s->block_type == BLOCK_4x2) {
700 /* skip (copy) four pixels, but reassign the horizontal
702 *vert_pred++ = *current_pixel_pair++;
703 horiz_pred = *current_pixel_pair - *vert_pred;
704 *vert_pred++ = *current_pixel_pair++;
709 mb_change_byte_mask <<= 1;
712 if (!mb_change_byte_mask) {
713 mb_change_byte = mb_change_bits[mb_change_index++];
714 mb_change_byte_mask = 0x01;
721 /* next change row */
722 if (((y + 1) & 3) == 0)
723 mb_change_bits += s->mb_change_bits_row_size;
725 current_line += s->frame.linesize[0];
729 static void truemotion1_decode_24bit(TrueMotion1Context *s)
732 int pixels_left; /* remaining pixels on this line */
733 unsigned int predictor_pair;
734 unsigned int horiz_pred;
735 unsigned int *vert_pred;
736 unsigned int *current_pixel_pair;
737 unsigned char *current_line = s->frame.data[0];
738 int keyframe = s->flags & FLAG_KEYFRAME;
740 /* these variables are for managing the stream of macroblock change bits */
741 const unsigned char *mb_change_bits = s->mb_change_bits;
742 unsigned char mb_change_byte;
743 unsigned char mb_change_byte_mask;
746 /* these variables are for managing the main index stream */
747 int index_stream_index = 0; /* yes, the index into the index stream */
750 /* clean out the line buffer */
751 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
755 for (y = 0; y < s->avctx->height; y++) {
757 /* re-init variables for the next line iteration */
759 current_pixel_pair = (unsigned int *)current_line;
760 vert_pred = s->vert_pred;
762 mb_change_byte = mb_change_bits[mb_change_index++];
763 mb_change_byte_mask = 0x01;
764 pixels_left = s->avctx->width;
766 while (pixels_left > 0) {
768 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
772 /* if macroblock width is 2, apply C-Y-C-Y; else
774 if (s->block_width == 2) {
775 APPLY_C_PREDICTOR_24();
776 APPLY_Y_PREDICTOR_24();
778 APPLY_C_PREDICTOR_24();
779 APPLY_Y_PREDICTOR_24();
782 APPLY_C_PREDICTOR_24();
783 APPLY_Y_PREDICTOR_24();
785 APPLY_Y_PREDICTOR_24();
792 /* always apply 2 Y predictors on these iterations */
793 APPLY_Y_PREDICTOR_24();
795 APPLY_Y_PREDICTOR_24();
800 /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
801 * depending on the macroblock type */
802 if (s->block_type == BLOCK_2x2) {
803 APPLY_C_PREDICTOR_24();
804 APPLY_Y_PREDICTOR_24();
806 APPLY_C_PREDICTOR_24();
807 APPLY_Y_PREDICTOR_24();
809 } else if (s->block_type == BLOCK_4x2) {
810 APPLY_C_PREDICTOR_24();
811 APPLY_Y_PREDICTOR_24();
813 APPLY_Y_PREDICTOR_24();
816 APPLY_Y_PREDICTOR_24();
818 APPLY_Y_PREDICTOR_24();
826 /* skip (copy) four pixels, but reassign the horizontal
828 *vert_pred++ = *current_pixel_pair++;
829 horiz_pred = *current_pixel_pair - *vert_pred;
830 *vert_pred++ = *current_pixel_pair++;
835 mb_change_byte_mask <<= 1;
838 if (!mb_change_byte_mask) {
839 mb_change_byte = mb_change_bits[mb_change_index++];
840 mb_change_byte_mask = 0x01;
847 /* next change row */
848 if (((y + 1) & 3) == 0)
849 mb_change_bits += s->mb_change_bits_row_size;
851 current_line += s->frame.linesize[0];
856 static int truemotion1_decode_frame(AVCodecContext *avctx,
857 void *data, int *data_size,
860 const uint8_t *buf = avpkt->data;
861 int buf_size = avpkt->size;
862 TrueMotion1Context *s = avctx->priv_data;
867 if (truemotion1_decode_header(s) == -1)
870 s->frame.reference = 3;
871 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID |
872 FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
873 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
874 av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
878 if (compression_types[s->compression].algorithm == ALGO_RGB24H) {
879 truemotion1_decode_24bit(s);
880 } else if (compression_types[s->compression].algorithm != ALGO_NOP) {
881 truemotion1_decode_16bit(s);
884 *data_size = sizeof(AVFrame);
885 *(AVFrame*)data = s->frame;
887 /* report that the buffer was completely consumed */
891 static av_cold int truemotion1_decode_end(AVCodecContext *avctx)
893 TrueMotion1Context *s = avctx->priv_data;
895 if (s->frame.data[0])
896 avctx->release_buffer(avctx, &s->frame);
898 av_free(s->vert_pred);
903 AVCodec ff_truemotion1_decoder = {
904 .name = "truemotion1",
905 .type = AVMEDIA_TYPE_VIDEO,
906 .id = CODEC_ID_TRUEMOTION1,
907 .priv_data_size = sizeof(TrueMotion1Context),
908 .init = truemotion1_decode_init,
909 .close = truemotion1_decode_end,
910 .decode = truemotion1_decode_frame,
911 .capabilities = CODEC_CAP_DR1,
912 .long_name = NULL_IF_CONFIG_SMALL("Duck TrueMotion 1.0"),