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"
39 #include "libavutil/internal.h"
40 #include "libavutil/mem.h"
42 #include "truemotion1data.h"
44 typedef struct TrueMotion1Context {
45 AVCodecContext *avctx;
51 const uint8_t *mb_change_bits;
52 int mb_change_bits_row_size;
53 const uint8_t *index_stream;
54 int index_stream_size;
59 uint32_t y_predictor_table[1024];
60 uint32_t c_predictor_table[1024];
61 uint32_t fat_y_predictor_table[1024];
62 uint32_t fat_c_predictor_table[1024];
74 int last_deltaset, last_vectable;
76 unsigned int *vert_pred;
81 #define FLAG_SPRITE 32
82 #define FLAG_KEYFRAME 16
83 #define FLAG_INTERFRAME 8
84 #define FLAG_INTERPOLATED 4
105 #define ALGO_RGB16V 1
106 #define ALGO_RGB16H 2
107 #define ALGO_RGB24H 3
109 /* these are the various block sizes that can occupy a 4x4 block */
115 typedef struct comp_types {
117 int block_width; // vres
118 int block_height; // hres
122 /* { valid for metatype }, algorithm, num of deltas, vert res, horiz res */
123 static const comp_types compression_types[17] = {
124 { ALGO_NOP, 0, 0, 0 },
126 { ALGO_RGB16V, 4, 4, BLOCK_4x4 },
127 { ALGO_RGB16H, 4, 4, BLOCK_4x4 },
128 { ALGO_RGB16V, 4, 2, BLOCK_4x2 },
129 { ALGO_RGB16H, 4, 2, BLOCK_4x2 },
131 { ALGO_RGB16V, 2, 4, BLOCK_2x4 },
132 { ALGO_RGB16H, 2, 4, BLOCK_2x4 },
133 { ALGO_RGB16V, 2, 2, BLOCK_2x2 },
134 { ALGO_RGB16H, 2, 2, BLOCK_2x2 },
136 { ALGO_NOP, 4, 4, BLOCK_4x4 },
137 { ALGO_RGB24H, 4, 4, BLOCK_4x4 },
138 { ALGO_NOP, 4, 2, BLOCK_4x2 },
139 { ALGO_RGB24H, 4, 2, BLOCK_4x2 },
141 { ALGO_NOP, 2, 4, BLOCK_2x4 },
142 { ALGO_RGB24H, 2, 4, BLOCK_2x4 },
143 { ALGO_NOP, 2, 2, BLOCK_2x2 },
144 { ALGO_RGB24H, 2, 2, BLOCK_2x2 }
147 static void select_delta_tables(TrueMotion1Context *s, int delta_table_index)
151 if (delta_table_index > 3)
154 memcpy(s->ydt, ydts[delta_table_index], 8 * sizeof(int16_t));
155 memcpy(s->cdt, cdts[delta_table_index], 8 * sizeof(int16_t));
156 memcpy(s->fat_ydt, fat_ydts[delta_table_index], 8 * sizeof(int16_t));
157 memcpy(s->fat_cdt, fat_cdts[delta_table_index], 8 * sizeof(int16_t));
159 /* Y skinny deltas need to be halved for some reason; maybe the
160 * skinny Y deltas should be modified */
161 for (i = 0; i < 8; i++)
163 /* drop the lsb before dividing by 2-- net effect: round down
164 * when dividing a negative number (e.g., -3/2 = -2, not -1) */
171 static int make_ydt15_entry(int p2, int p1, int16_t *ydt)
173 static int make_ydt15_entry(int p1, int p2, int16_t *ydt)
179 lo += (lo << 5) + (lo << 10);
181 hi += (hi << 5) + (hi << 10);
182 return (lo + (hi << 16)) << 1;
185 static int make_cdt15_entry(int p1, int p2, int16_t *cdt)
192 return (lo + (lo << 16)) << 1;
196 static int make_ydt16_entry(int p2, int p1, int16_t *ydt)
198 static int make_ydt16_entry(int p1, int p2, int16_t *ydt)
204 lo += (lo << 6) + (lo << 11);
206 hi += (hi << 6) + (hi << 11);
207 return (lo + (hi << 16)) << 1;
210 static int make_cdt16_entry(int p1, int p2, int16_t *cdt)
217 return (lo + (lo << 16)) << 1;
220 static int make_ydt24_entry(int p1, int p2, int16_t *ydt)
226 return (lo + (hi << 8) + (hi << 16)) << 1;
229 static int make_cdt24_entry(int p1, int p2, int16_t *cdt)
238 static void gen_vector_table15(TrueMotion1Context *s, const uint8_t *sel_vector_table)
241 unsigned char delta_pair;
243 for (i = 0; i < 1024; i += 4)
245 len = *sel_vector_table++ / 2;
246 for (j = 0; j < len; j++)
248 delta_pair = *sel_vector_table++;
249 s->y_predictor_table[i+j] = 0xfffffffe &
250 make_ydt15_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
251 s->c_predictor_table[i+j] = 0xfffffffe &
252 make_cdt15_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
254 s->y_predictor_table[i+(j-1)] |= 1;
255 s->c_predictor_table[i+(j-1)] |= 1;
259 static void gen_vector_table16(TrueMotion1Context *s, const uint8_t *sel_vector_table)
262 unsigned char delta_pair;
264 for (i = 0; i < 1024; i += 4)
266 len = *sel_vector_table++ / 2;
267 for (j = 0; j < len; j++)
269 delta_pair = *sel_vector_table++;
270 s->y_predictor_table[i+j] = 0xfffffffe &
271 make_ydt16_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
272 s->c_predictor_table[i+j] = 0xfffffffe &
273 make_cdt16_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
275 s->y_predictor_table[i+(j-1)] |= 1;
276 s->c_predictor_table[i+(j-1)] |= 1;
280 static void gen_vector_table24(TrueMotion1Context *s, const uint8_t *sel_vector_table)
283 unsigned char delta_pair;
285 for (i = 0; i < 1024; i += 4)
287 len = *sel_vector_table++ / 2;
288 for (j = 0; j < len; j++)
290 delta_pair = *sel_vector_table++;
291 s->y_predictor_table[i+j] = 0xfffffffe &
292 make_ydt24_entry(delta_pair >> 4, delta_pair & 0xf, s->ydt);
293 s->c_predictor_table[i+j] = 0xfffffffe &
294 make_cdt24_entry(delta_pair >> 4, delta_pair & 0xf, s->cdt);
295 s->fat_y_predictor_table[i+j] = 0xfffffffe &
296 make_ydt24_entry(delta_pair >> 4, delta_pair & 0xf, s->fat_ydt);
297 s->fat_c_predictor_table[i+j] = 0xfffffffe &
298 make_cdt24_entry(delta_pair >> 4, delta_pair & 0xf, s->fat_cdt);
300 s->y_predictor_table[i+(j-1)] |= 1;
301 s->c_predictor_table[i+(j-1)] |= 1;
302 s->fat_y_predictor_table[i+(j-1)] |= 1;
303 s->fat_c_predictor_table[i+(j-1)] |= 1;
307 /* Returns the number of bytes consumed from the bytestream. Returns -1 if
308 * there was an error while decoding the header */
309 static int truemotion1_decode_header(TrueMotion1Context *s)
314 struct frame_header header;
315 uint8_t header_buffer[128] = { 0 }; /* logical maximum size of the header */
316 const uint8_t *sel_vector_table;
318 header.header_size = ((s->buf[0] >> 5) | (s->buf[0] << 3)) & 0x7f;
319 if (s->buf[0] < 0x10)
321 av_log(s->avctx, AV_LOG_ERROR, "invalid header size (%d)\n", s->buf[0]);
322 return AVERROR_INVALIDDATA;
325 /* unscramble the header bytes with a XOR operation */
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);
346 return AVERROR_INVALIDDATA;
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_ask_for_sample(s->avctx, "SPRITE frame found.\n");
358 /* FIXME header.width, height, xoffset and yoffset aren't initialized */
359 return AVERROR_PATCHWELCOME;
363 if (header.header_type < 2) {
364 if ((s->w < 213) && (s->h >= 176))
366 s->flags |= FLAG_INTERPOLATED;
367 av_log_ask_for_sample(s->avctx, "INTERPOLATION selected.\n");
372 if (header.compression >= 17) {
373 av_log(s->avctx, AV_LOG_ERROR, "invalid compression type (%d)\n", header.compression);
374 return AVERROR_INVALIDDATA;
377 if ((header.deltaset != s->last_deltaset) ||
378 (header.vectable != s->last_vectable))
379 select_delta_tables(s, header.deltaset);
381 if ((header.compression & 1) && header.header_type)
382 sel_vector_table = pc_tbl2;
384 if (header.vectable > 0 && header.vectable < 4)
385 sel_vector_table = tables[header.vectable - 1];
387 av_log(s->avctx, AV_LOG_ERROR, "invalid vector table id (%d)\n", header.vectable);
388 return AVERROR_INVALIDDATA;
392 if (compression_types[header.compression].algorithm == ALGO_RGB24H) {
393 new_pix_fmt = AV_PIX_FMT_RGB32;
396 new_pix_fmt = AV_PIX_FMT_RGB555; // RGB565 is supported as well
398 s->w >>= width_shift;
399 if ((ret = av_image_check_size(s->w, s->h, 0, s->avctx)) < 0)
402 if (s->w != s->avctx->width || s->h != s->avctx->height ||
403 new_pix_fmt != s->avctx->pix_fmt) {
404 if (s->frame.data[0])
405 s->avctx->release_buffer(s->avctx, &s->frame);
406 s->avctx->sample_aspect_ratio = (AVRational){ 1 << width_shift, 1 };
407 s->avctx->pix_fmt = new_pix_fmt;
408 avcodec_set_dimensions(s->avctx, s->w, s->h);
409 av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
412 /* There is 1 change bit per 4 pixels, so each change byte represents
413 * 32 pixels; divide width by 4 to obtain the number of change bits and
414 * then round up to the nearest byte. */
415 s->mb_change_bits_row_size = ((s->avctx->width >> (2 - width_shift)) + 7) >> 3;
417 if ((header.deltaset != s->last_deltaset) || (header.vectable != s->last_vectable))
419 if (compression_types[header.compression].algorithm == ALGO_RGB24H)
420 gen_vector_table24(s, sel_vector_table);
422 if (s->avctx->pix_fmt == AV_PIX_FMT_RGB555)
423 gen_vector_table15(s, sel_vector_table);
425 gen_vector_table16(s, sel_vector_table);
428 /* set up pointers to the other key data chunks */
429 s->mb_change_bits = s->buf + header.header_size;
430 if (s->flags & FLAG_KEYFRAME) {
431 /* no change bits specified for a keyframe; only index bytes */
432 s->index_stream = s->mb_change_bits;
434 /* one change bit per 4x4 block */
435 s->index_stream = s->mb_change_bits +
436 (s->mb_change_bits_row_size * (s->avctx->height >> 2));
438 s->index_stream_size = s->size - (s->index_stream - s->buf);
440 s->last_deltaset = header.deltaset;
441 s->last_vectable = header.vectable;
442 s->compression = header.compression;
443 s->block_width = compression_types[header.compression].block_width;
444 s->block_height = compression_types[header.compression].block_height;
445 s->block_type = compression_types[header.compression].block_type;
447 if (s->avctx->debug & FF_DEBUG_PICT_INFO)
448 av_log(s->avctx, AV_LOG_INFO, "tables: %d / %d c:%d %dx%d t:%d %s%s%s%s\n",
449 s->last_deltaset, s->last_vectable, s->compression, s->block_width,
450 s->block_height, s->block_type,
451 s->flags & FLAG_KEYFRAME ? " KEY" : "",
452 s->flags & FLAG_INTERFRAME ? " INTER" : "",
453 s->flags & FLAG_SPRITE ? " SPRITE" : "",
454 s->flags & FLAG_INTERPOLATED ? " INTERPOL" : "");
456 return header.header_size;
459 static av_cold int truemotion1_decode_init(AVCodecContext *avctx)
461 TrueMotion1Context *s = avctx->priv_data;
465 // FIXME: it may change ?
466 // if (avctx->bits_per_sample == 24)
467 // avctx->pix_fmt = AV_PIX_FMT_RGB24;
469 // avctx->pix_fmt = AV_PIX_FMT_RGB555;
471 s->frame.data[0] = NULL;
473 /* there is a vertical predictor for each pixel in a line; each vertical
474 * predictor is 0 to start with */
475 av_fast_malloc(&s->vert_pred, &s->vert_pred_size, s->avctx->width * sizeof(unsigned int));
481 Block decoding order:
487 hres,vres,i,i%vres (0 < i < 4)
506 #define GET_NEXT_INDEX() \
508 if (index_stream_index >= s->index_stream_size) { \
509 av_log(s->avctx, AV_LOG_INFO, " help! truemotion1 decoder went out of bounds\n"); \
512 index = s->index_stream[index_stream_index++] * 4; \
515 #define APPLY_C_PREDICTOR() \
516 predictor_pair = s->c_predictor_table[index]; \
517 horiz_pred += (predictor_pair >> 1); \
518 if (predictor_pair & 1) { \
522 predictor_pair = s->c_predictor_table[index]; \
523 horiz_pred += ((predictor_pair >> 1) * 5); \
524 if (predictor_pair & 1) \
532 #define APPLY_C_PREDICTOR_24() \
533 predictor_pair = s->c_predictor_table[index]; \
534 horiz_pred += (predictor_pair >> 1); \
535 if (predictor_pair & 1) { \
539 predictor_pair = s->fat_c_predictor_table[index]; \
540 horiz_pred += (predictor_pair >> 1); \
541 if (predictor_pair & 1) \
550 #define APPLY_Y_PREDICTOR() \
551 predictor_pair = s->y_predictor_table[index]; \
552 horiz_pred += (predictor_pair >> 1); \
553 if (predictor_pair & 1) { \
557 predictor_pair = s->y_predictor_table[index]; \
558 horiz_pred += ((predictor_pair >> 1) * 5); \
559 if (predictor_pair & 1) \
567 #define APPLY_Y_PREDICTOR_24() \
568 predictor_pair = s->y_predictor_table[index]; \
569 horiz_pred += (predictor_pair >> 1); \
570 if (predictor_pair & 1) { \
574 predictor_pair = s->fat_y_predictor_table[index]; \
575 horiz_pred += (predictor_pair >> 1); \
576 if (predictor_pair & 1) \
584 #define OUTPUT_PIXEL_PAIR() \
585 *current_pixel_pair = *vert_pred + horiz_pred; \
586 *vert_pred++ = *current_pixel_pair++;
588 static void truemotion1_decode_16bit(TrueMotion1Context *s)
591 int pixels_left; /* remaining pixels on this line */
592 unsigned int predictor_pair;
593 unsigned int horiz_pred;
594 unsigned int *vert_pred;
595 unsigned int *current_pixel_pair;
596 unsigned char *current_line = s->frame.data[0];
597 int keyframe = s->flags & FLAG_KEYFRAME;
599 /* these variables are for managing the stream of macroblock change bits */
600 const unsigned char *mb_change_bits = s->mb_change_bits;
601 unsigned char mb_change_byte;
602 unsigned char mb_change_byte_mask;
605 /* these variables are for managing the main index stream */
606 int index_stream_index = 0; /* yes, the index into the index stream */
609 /* clean out the line buffer */
610 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
614 for (y = 0; y < s->avctx->height; y++) {
616 /* re-init variables for the next line iteration */
618 current_pixel_pair = (unsigned int *)current_line;
619 vert_pred = s->vert_pred;
621 mb_change_byte = mb_change_bits[mb_change_index++];
622 mb_change_byte_mask = 0x01;
623 pixels_left = s->avctx->width;
625 while (pixels_left > 0) {
627 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
631 /* if macroblock width is 2, apply C-Y-C-Y; else
633 if (s->block_width == 2) {
651 /* always apply 2 Y predictors on these iterations */
659 /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
660 * depending on the macroblock type */
661 if (s->block_type == BLOCK_2x2) {
668 } else if (s->block_type == BLOCK_4x2) {
685 /* skip (copy) four pixels, but reassign the horizontal
687 *vert_pred++ = *current_pixel_pair++;
688 horiz_pred = *current_pixel_pair - *vert_pred;
689 *vert_pred++ = *current_pixel_pair++;
694 mb_change_byte_mask <<= 1;
697 if (!mb_change_byte_mask) {
698 mb_change_byte = mb_change_bits[mb_change_index++];
699 mb_change_byte_mask = 0x01;
706 /* next change row */
707 if (((y + 1) & 3) == 0)
708 mb_change_bits += s->mb_change_bits_row_size;
710 current_line += s->frame.linesize[0];
714 static void truemotion1_decode_24bit(TrueMotion1Context *s)
717 int pixels_left; /* remaining pixels on this line */
718 unsigned int predictor_pair;
719 unsigned int horiz_pred;
720 unsigned int *vert_pred;
721 unsigned int *current_pixel_pair;
722 unsigned char *current_line = s->frame.data[0];
723 int keyframe = s->flags & FLAG_KEYFRAME;
725 /* these variables are for managing the stream of macroblock change bits */
726 const unsigned char *mb_change_bits = s->mb_change_bits;
727 unsigned char mb_change_byte;
728 unsigned char mb_change_byte_mask;
731 /* these variables are for managing the main index stream */
732 int index_stream_index = 0; /* yes, the index into the index stream */
735 /* clean out the line buffer */
736 memset(s->vert_pred, 0, s->avctx->width * sizeof(unsigned int));
740 for (y = 0; y < s->avctx->height; y++) {
742 /* re-init variables for the next line iteration */
744 current_pixel_pair = (unsigned int *)current_line;
745 vert_pred = s->vert_pred;
747 mb_change_byte = mb_change_bits[mb_change_index++];
748 mb_change_byte_mask = 0x01;
749 pixels_left = s->avctx->width;
751 while (pixels_left > 0) {
753 if (keyframe || ((mb_change_byte & mb_change_byte_mask) == 0)) {
757 /* if macroblock width is 2, apply C-Y-C-Y; else
759 if (s->block_width == 2) {
760 APPLY_C_PREDICTOR_24();
761 APPLY_Y_PREDICTOR_24();
763 APPLY_C_PREDICTOR_24();
764 APPLY_Y_PREDICTOR_24();
767 APPLY_C_PREDICTOR_24();
768 APPLY_Y_PREDICTOR_24();
770 APPLY_Y_PREDICTOR_24();
777 /* always apply 2 Y predictors on these iterations */
778 APPLY_Y_PREDICTOR_24();
780 APPLY_Y_PREDICTOR_24();
785 /* this iteration might be C-Y-C-Y, Y-Y, or C-Y-Y
786 * depending on the macroblock type */
787 if (s->block_type == BLOCK_2x2) {
788 APPLY_C_PREDICTOR_24();
789 APPLY_Y_PREDICTOR_24();
791 APPLY_C_PREDICTOR_24();
792 APPLY_Y_PREDICTOR_24();
794 } else if (s->block_type == BLOCK_4x2) {
795 APPLY_C_PREDICTOR_24();
796 APPLY_Y_PREDICTOR_24();
798 APPLY_Y_PREDICTOR_24();
801 APPLY_Y_PREDICTOR_24();
803 APPLY_Y_PREDICTOR_24();
811 /* skip (copy) four pixels, but reassign the horizontal
813 *vert_pred++ = *current_pixel_pair++;
814 horiz_pred = *current_pixel_pair - *vert_pred;
815 *vert_pred++ = *current_pixel_pair++;
820 mb_change_byte_mask <<= 1;
823 if (!mb_change_byte_mask) {
824 mb_change_byte = mb_change_bits[mb_change_index++];
825 mb_change_byte_mask = 0x01;
832 /* next change row */
833 if (((y + 1) & 3) == 0)
834 mb_change_bits += s->mb_change_bits_row_size;
836 current_line += s->frame.linesize[0];
841 static int truemotion1_decode_frame(AVCodecContext *avctx,
842 void *data, int *got_frame,
845 const uint8_t *buf = avpkt->data;
846 int ret, buf_size = avpkt->size;
847 TrueMotion1Context *s = avctx->priv_data;
852 if ((ret = truemotion1_decode_header(s)) < 0)
855 s->frame.reference = 1;
856 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID |
857 FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
858 if ((ret = avctx->reget_buffer(avctx, &s->frame)) < 0) {
859 av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
863 if (compression_types[s->compression].algorithm == ALGO_RGB24H) {
864 truemotion1_decode_24bit(s);
865 } else if (compression_types[s->compression].algorithm != ALGO_NOP) {
866 truemotion1_decode_16bit(s);
870 *(AVFrame*)data = s->frame;
872 /* report that the buffer was completely consumed */
876 static av_cold int truemotion1_decode_end(AVCodecContext *avctx)
878 TrueMotion1Context *s = avctx->priv_data;
880 if (s->frame.data[0])
881 avctx->release_buffer(avctx, &s->frame);
883 av_free(s->vert_pred);
888 AVCodec ff_truemotion1_decoder = {
889 .name = "truemotion1",
890 .type = AVMEDIA_TYPE_VIDEO,
891 .id = AV_CODEC_ID_TRUEMOTION1,
892 .priv_data_size = sizeof(TrueMotion1Context),
893 .init = truemotion1_decode_init,
894 .close = truemotion1_decode_end,
895 .decode = truemotion1_decode_frame,
896 .capabilities = CODEC_CAP_DR1,
897 .long_name = NULL_IF_CONFIG_SMALL("Duck TrueMotion 1.0"),