2 * Duck TrueMotion 1.0 Decoder
3 * Copyright (C) 2003 Alex Beregszaszi & Mike Melanson
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; 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)
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 */
359 s->h = header.height;
360 s->x = header.xoffset;
361 s->y = header.yoffset;
368 if (header.header_type < 2) {
369 if ((s->w < 213) && (s->h >= 176))
371 s->flags |= FLAG_INTERPOLATED;
372 av_log_ask_for_sample(s->avctx, "INTERPOLATION selected.\n");
377 if (header.compression >= 17) {
378 av_log(s->avctx, AV_LOG_ERROR, "invalid compression type (%d)\n", header.compression);
382 if ((header.deltaset != s->last_deltaset) ||
383 (header.vectable != s->last_vectable))
384 select_delta_tables(s, header.deltaset);
386 if ((header.compression & 1) && header.header_type)
387 sel_vector_table = pc_tbl2;
389 if (header.vectable > 0 && header.vectable < 4)
390 sel_vector_table = tables[header.vectable - 1];
392 av_log(s->avctx, AV_LOG_ERROR, "invalid vector table id (%d)\n", header.vectable);
397 if (compression_types[header.compression].algorithm == ALGO_RGB24H) {
398 new_pix_fmt = PIX_FMT_RGB32;
401 new_pix_fmt = PIX_FMT_RGB555; // RGB565 is supported as well
403 s->w >>= width_shift;
404 if (av_image_check_size(s->w, s->h, 0, s->avctx) < 0)
407 if (s->w != s->avctx->width || s->h != s->avctx->height ||
408 new_pix_fmt != s->avctx->pix_fmt) {
409 if (s->frame.data[0])
410 s->avctx->release_buffer(s->avctx, &s->frame);
411 s->avctx->sample_aspect_ratio = (AVRational){ 1 << width_shift, 1 };
412 s->avctx->pix_fmt = new_pix_fmt;
413 avcodec_set_dimensions(s->avctx, s->w, s->h);
414 av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
417 /* There is 1 change bit per 4 pixels, so each change byte represents
418 * 32 pixels; divide width by 4 to obtain the number of change bits and
419 * then round up to the nearest byte. */
420 s->mb_change_bits_row_size = ((s->avctx->width >> (2 - width_shift)) + 7) >> 3;
422 if ((header.deltaset != s->last_deltaset) || (header.vectable != s->last_vectable))
424 if (compression_types[header.compression].algorithm == ALGO_RGB24H)
425 gen_vector_table24(s, sel_vector_table);
427 if (s->avctx->pix_fmt == PIX_FMT_RGB555)
428 gen_vector_table15(s, sel_vector_table);
430 gen_vector_table16(s, sel_vector_table);
433 /* set up pointers to the other key data chunks */
434 s->mb_change_bits = s->buf + header.header_size;
435 if (s->flags & FLAG_KEYFRAME) {
436 /* no change bits specified for a keyframe; only index bytes */
437 s->index_stream = s->mb_change_bits;
439 /* one change bit per 4x4 block */
440 s->index_stream = s->mb_change_bits +
441 (s->mb_change_bits_row_size * (s->avctx->height >> 2));
443 s->index_stream_size = s->size - (s->index_stream - s->buf);
445 s->last_deltaset = header.deltaset;
446 s->last_vectable = header.vectable;
447 s->compression = header.compression;
448 s->block_width = compression_types[header.compression].block_width;
449 s->block_height = compression_types[header.compression].block_height;
450 s->block_type = compression_types[header.compression].block_type;
452 if (s->avctx->debug & FF_DEBUG_PICT_INFO)
453 av_log(s->avctx, AV_LOG_INFO, "tables: %d / %d c:%d %dx%d t:%d %s%s%s%s\n",
454 s->last_deltaset, s->last_vectable, s->compression, s->block_width,
455 s->block_height, s->block_type,
456 s->flags & FLAG_KEYFRAME ? " KEY" : "",
457 s->flags & FLAG_INTERFRAME ? " INTER" : "",
458 s->flags & FLAG_SPRITE ? " SPRITE" : "",
459 s->flags & FLAG_INTERPOLATED ? " INTERPOL" : "");
461 return header.header_size;
464 static av_cold int truemotion1_decode_init(AVCodecContext *avctx)
466 TrueMotion1Context *s = avctx->priv_data;
470 // FIXME: it may change ?
471 // if (avctx->bits_per_sample == 24)
472 // avctx->pix_fmt = PIX_FMT_RGB24;
474 // avctx->pix_fmt = PIX_FMT_RGB555;
476 s->frame.data[0] = NULL;
478 /* there is a vertical predictor for each pixel in a line; each vertical
479 * predictor is 0 to start with */
480 av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
486 Block decoding order:
492 hres,vres,i,i%vres (0 < i < 4)
511 #define GET_NEXT_INDEX() \
513 if (index_stream_index >= s->index_stream_size) { \
514 av_log(s->avctx, AV_LOG_INFO, " help! truemotion1 decoder went out of bounds\n"); \
517 index = s->index_stream[index_stream_index++] * 4; \
520 #define APPLY_C_PREDICTOR() \
521 predictor_pair = s->c_predictor_table[index]; \
522 horiz_pred += (predictor_pair >> 1); \
523 if (predictor_pair & 1) { \
527 predictor_pair = s->c_predictor_table[index]; \
528 horiz_pred += ((predictor_pair >> 1) * 5); \
529 if (predictor_pair & 1) \
537 #define APPLY_C_PREDICTOR_24() \
538 predictor_pair = s->c_predictor_table[index]; \
539 horiz_pred += (predictor_pair >> 1); \
540 if (predictor_pair & 1) { \
544 predictor_pair = s->fat_c_predictor_table[index]; \
545 horiz_pred += (predictor_pair >> 1); \
546 if (predictor_pair & 1) \
555 #define APPLY_Y_PREDICTOR() \
556 predictor_pair = s->y_predictor_table[index]; \
557 horiz_pred += (predictor_pair >> 1); \
558 if (predictor_pair & 1) { \
562 predictor_pair = s->y_predictor_table[index]; \
563 horiz_pred += ((predictor_pair >> 1) * 5); \
564 if (predictor_pair & 1) \
572 #define APPLY_Y_PREDICTOR_24() \
573 predictor_pair = s->y_predictor_table[index]; \
574 horiz_pred += (predictor_pair >> 1); \
575 if (predictor_pair & 1) { \
579 predictor_pair = s->fat_y_predictor_table[index]; \
580 horiz_pred += (predictor_pair >> 1); \
581 if (predictor_pair & 1) \
589 #define OUTPUT_PIXEL_PAIR() \
590 *current_pixel_pair = *vert_pred + horiz_pred; \
591 *vert_pred++ = *current_pixel_pair++;
593 static void truemotion1_decode_16bit(TrueMotion1Context *s)
596 int pixels_left; /* remaining pixels on this line */
597 unsigned int predictor_pair;
598 unsigned int horiz_pred;
599 unsigned int *vert_pred;
600 unsigned int *current_pixel_pair;
601 unsigned char *current_line = s->frame.data[0];
602 int keyframe = s->flags & FLAG_KEYFRAME;
604 /* these variables are for managing the stream of macroblock change bits */
605 const unsigned char *mb_change_bits = s->mb_change_bits;
606 unsigned char mb_change_byte;
607 unsigned char mb_change_byte_mask;
610 /* these variables are for managing the main index stream */
611 int index_stream_index = 0; /* yes, the index into the index stream */
614 /* clean out the line buffer */
615 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
619 for (y = 0; y < s->avctx->height; y++) {
621 /* re-init variables for the next line iteration */
623 current_pixel_pair = (unsigned int *)current_line;
624 vert_pred = s->vert_pred;
626 mb_change_byte = mb_change_bits[mb_change_index++];
627 mb_change_byte_mask = 0x01;
628 pixels_left = s->avctx->width;
630 while (pixels_left > 0) {
632 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
636 /* if macroblock width is 2, apply C-Y-C-Y; else
638 if (s->block_width == 2) {
656 /* always apply 2 Y predictors on these iterations */
664 /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
665 * depending on the macroblock type */
666 if (s->block_type == BLOCK_2x2) {
673 } else if (s->block_type == BLOCK_4x2) {
690 /* skip (copy) four pixels, but reassign the horizontal
692 *vert_pred++ = *current_pixel_pair++;
693 horiz_pred = *current_pixel_pair - *vert_pred;
694 *vert_pred++ = *current_pixel_pair++;
699 mb_change_byte_mask <<= 1;
702 if (!mb_change_byte_mask) {
703 mb_change_byte = mb_change_bits[mb_change_index++];
704 mb_change_byte_mask = 0x01;
711 /* next change row */
712 if (((y + 1) & 3) == 0)
713 mb_change_bits += s->mb_change_bits_row_size;
715 current_line += s->frame.linesize[0];
719 static void truemotion1_decode_24bit(TrueMotion1Context *s)
722 int pixels_left; /* remaining pixels on this line */
723 unsigned int predictor_pair;
724 unsigned int horiz_pred;
725 unsigned int *vert_pred;
726 unsigned int *current_pixel_pair;
727 unsigned char *current_line = s->frame.data[0];
728 int keyframe = s->flags & FLAG_KEYFRAME;
730 /* these variables are for managing the stream of macroblock change bits */
731 const unsigned char *mb_change_bits = s->mb_change_bits;
732 unsigned char mb_change_byte;
733 unsigned char mb_change_byte_mask;
736 /* these variables are for managing the main index stream */
737 int index_stream_index = 0; /* yes, the index into the index stream */
740 /* clean out the line buffer */
741 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
745 for (y = 0; y < s->avctx->height; y++) {
747 /* re-init variables for the next line iteration */
749 current_pixel_pair = (unsigned int *)current_line;
750 vert_pred = s->vert_pred;
752 mb_change_byte = mb_change_bits[mb_change_index++];
753 mb_change_byte_mask = 0x01;
754 pixels_left = s->avctx->width;
756 while (pixels_left > 0) {
758 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
762 /* if macroblock width is 2, apply C-Y-C-Y; else
764 if (s->block_width == 2) {
765 APPLY_C_PREDICTOR_24();
766 APPLY_Y_PREDICTOR_24();
768 APPLY_C_PREDICTOR_24();
769 APPLY_Y_PREDICTOR_24();
772 APPLY_C_PREDICTOR_24();
773 APPLY_Y_PREDICTOR_24();
775 APPLY_Y_PREDICTOR_24();
782 /* always apply 2 Y predictors on these iterations */
783 APPLY_Y_PREDICTOR_24();
785 APPLY_Y_PREDICTOR_24();
790 /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
791 * depending on the macroblock type */
792 if (s->block_type == BLOCK_2x2) {
793 APPLY_C_PREDICTOR_24();
794 APPLY_Y_PREDICTOR_24();
796 APPLY_C_PREDICTOR_24();
797 APPLY_Y_PREDICTOR_24();
799 } else if (s->block_type == BLOCK_4x2) {
800 APPLY_C_PREDICTOR_24();
801 APPLY_Y_PREDICTOR_24();
803 APPLY_Y_PREDICTOR_24();
806 APPLY_Y_PREDICTOR_24();
808 APPLY_Y_PREDICTOR_24();
816 /* skip (copy) four pixels, but reassign the horizontal
818 *vert_pred++ = *current_pixel_pair++;
819 horiz_pred = *current_pixel_pair - *vert_pred;
820 *vert_pred++ = *current_pixel_pair++;
825 mb_change_byte_mask <<= 1;
828 if (!mb_change_byte_mask) {
829 mb_change_byte = mb_change_bits[mb_change_index++];
830 mb_change_byte_mask = 0x01;
837 /* next change row */
838 if (((y + 1) & 3) == 0)
839 mb_change_bits += s->mb_change_bits_row_size;
841 current_line += s->frame.linesize[0];
846 static int truemotion1_decode_frame(AVCodecContext *avctx,
847 void *data, int *data_size,
850 const uint8_t *buf = avpkt->data;
851 int buf_size = avpkt->size;
852 TrueMotion1Context *s = avctx->priv_data;
857 if (truemotion1_decode_header(s) == -1)
860 s->frame.reference = 1;
861 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID |
862 FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
863 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
864 av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
868 if (compression_types[s->compression].algorithm == ALGO_RGB24H) {
869 truemotion1_decode_24bit(s);
870 } else if (compression_types[s->compression].algorithm != ALGO_NOP) {
871 truemotion1_decode_16bit(s);
874 *data_size = sizeof(AVFrame);
875 *(AVFrame*)data = s->frame;
877 /* report that the buffer was completely consumed */
881 static av_cold int truemotion1_decode_end(AVCodecContext *avctx)
883 TrueMotion1Context *s = avctx->priv_data;
885 if (s->frame.data[0])
886 avctx->release_buffer(avctx, &s->frame);
888 av_free(s->vert_pred);
893 AVCodec ff_truemotion1_decoder = {
894 .name = "truemotion1",
895 .type = AVMEDIA_TYPE_VIDEO,
896 .id = CODEC_ID_TRUEMOTION1,
897 .priv_data_size = sizeof(TrueMotion1Context),
898 .init = truemotion1_decode_init,
899 .close = truemotion1_decode_end,
900 .decode = truemotion1_decode_frame,
901 .capabilities = CODEC_CAP_DR1,
902 .long_name = NULL_IF_CONFIG_SMALL("Duck TrueMotion 1.0"),