2 * Interplay MVE Video Decoder
3 * Copyright (C) 2003 the ffmpeg project
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
23 * @file libavcodec/interplayvideo.c
24 * Interplay MVE Video Decoder by Mike Melanson (melanson@pcisys.net)
25 * For more information about the Interplay MVE format, visit:
26 * http://www.pcisys.net/~melanson/codecs/interplay-mve.txt
27 * This code is written in such a way that the identifiers match up
28 * with the encoding descriptions in the document.
30 * This decoder presently only supports a PAL8 output colorspace.
32 * An Interplay video frame consists of 2 parts: The decoding map and
33 * the video data. A demuxer must load these 2 parts together in a single
34 * buffer before sending it through the stream to this decoder.
43 #include "bytestream.h"
46 #define PALETTE_COUNT 256
48 /* debugging support */
49 #define DEBUG_INTERPLAY 0
51 #define debug_interplay(x,...) av_log(NULL, AV_LOG_DEBUG, x, __VA_ARGS__)
53 static inline void debug_interplay(const char *format, ...) { }
56 typedef struct IpvideoContext {
58 AVCodecContext *avctx;
60 AVFrame second_last_frame;
62 AVFrame current_frame;
63 const unsigned char *decoding_map;
64 int decoding_map_size;
66 const unsigned char *buf;
69 const unsigned char *stream_ptr;
70 const unsigned char *stream_end;
71 unsigned char *pixel_ptr;
74 int upper_motion_limit_offset;
78 #define CHECK_STREAM_PTR(n) \
79 if (s->stream_end - s->stream_ptr < n) { \
80 av_log(s->avctx, AV_LOG_ERROR, "Interplay video warning: stream_ptr out of bounds (%p >= %p)\n", \
81 s->stream_ptr + n, s->stream_end); \
85 static int copy_from(IpvideoContext *s, AVFrame *src, int delta_x, int delta_y)
87 int current_offset = s->pixel_ptr - s->current_frame.data[0];
88 int motion_offset = current_offset + delta_y * s->stride + delta_x;
89 if (motion_offset < 0) {
90 av_log(s->avctx, AV_LOG_ERROR, " Interplay video: motion offset < 0 (%d)\n", motion_offset);
92 } else if (motion_offset > s->upper_motion_limit_offset) {
93 av_log(s->avctx, AV_LOG_ERROR, " Interplay video: motion offset above limit (%d >= %d)\n",
94 motion_offset, s->upper_motion_limit_offset);
97 s->dsp.put_pixels_tab[1][0](s->pixel_ptr, src->data[0] + motion_offset, s->stride, 8);
101 static int ipvideo_decode_block_opcode_0x0(IpvideoContext *s)
103 return copy_from(s, &s->last_frame, 0, 0);
106 static int ipvideo_decode_block_opcode_0x1(IpvideoContext *s)
108 return copy_from(s, &s->second_last_frame, 0, 0);
111 static int ipvideo_decode_block_opcode_0x2(IpvideoContext *s)
116 /* copy block from 2 frames ago using a motion vector; need 1 more byte */
118 B = *s->stream_ptr++;
124 x = -14 + ((B - 56) % 29);
125 y = 8 + ((B - 56) / 29);
128 debug_interplay (" motion byte = %d, (x, y) = (%d, %d)\n", B, x, y);
129 return copy_from(s, &s->second_last_frame, x, y);
132 static int ipvideo_decode_block_opcode_0x3(IpvideoContext *s)
137 /* copy 8x8 block from current frame from an up/left block */
139 /* need 1 more byte for motion */
141 B = *s->stream_ptr++;
147 x = -(-14 + ((B - 56) % 29));
148 y = -( 8 + ((B - 56) / 29));
151 debug_interplay (" motion byte = %d, (x, y) = (%d, %d)\n", B, x, y);
152 return copy_from(s, &s->current_frame, x, y);
155 static int ipvideo_decode_block_opcode_0x4(IpvideoContext *s)
158 unsigned char B, BL, BH;
160 /* copy a block from the previous frame; need 1 more byte */
163 B = *s->stream_ptr++;
165 BH = (B >> 4) & 0x0F;
169 debug_interplay (" motion byte = %d, (x, y) = (%d, %d)\n", B, x, y);
170 return copy_from(s, &s->last_frame, x, y);
173 static int ipvideo_decode_block_opcode_0x5(IpvideoContext *s)
177 /* copy a block from the previous frame using an expanded range;
178 * need 2 more bytes */
181 x = *s->stream_ptr++;
182 y = *s->stream_ptr++;
184 debug_interplay (" motion bytes = %d, %d\n", x, y);
185 return copy_from(s, &s->last_frame, x, y);
188 static int ipvideo_decode_block_opcode_0x6(IpvideoContext *s)
190 /* mystery opcode? skip multiple blocks? */
191 av_log(s->avctx, AV_LOG_ERROR, " Interplay video: Help! Mystery opcode 0x6 seen\n");
197 static int ipvideo_decode_block_opcode_0x7(IpvideoContext *s)
203 /* 2-color encoding */
206 P[0] = *s->stream_ptr++;
207 P[1] = *s->stream_ptr++;
211 /* need 8 more bytes from the stream */
214 for (y = 0; y < 8; y++) {
215 flags = *s->stream_ptr++;
216 for (x = 0x01; x <= 0x80; x <<= 1) {
217 *s->pixel_ptr++ = P[!!(flags & x)];
219 s->pixel_ptr += s->line_inc;
224 /* need 2 more bytes from the stream */
227 flags = bytestream_get_le16(&s->stream_ptr);
228 for (y = 0; y < 8; y += 2) {
229 for (x = 0; x < 8; x += 2, flags >>= 1) {
231 s->pixel_ptr[x + 1 ] =
232 s->pixel_ptr[x + s->stride] =
233 s->pixel_ptr[x + 1 + s->stride] = P[flags & 1];
235 s->pixel_ptr += s->stride * 2;
243 static int ipvideo_decode_block_opcode_0x8(IpvideoContext *s)
248 unsigned int flags = 0;
249 unsigned char P0 = 0, P1 = 0;
252 /* 2-color encoding for each 4x4 quadrant, or 2-color encoding on
253 * either top and bottom or left and right halves */
256 P[0] = *s->stream_ptr++;
257 P[1] = *s->stream_ptr++;
261 /* need 12 more bytes */
262 CHECK_STREAM_PTR(12);
263 B[0] = *s->stream_ptr++; B[1] = *s->stream_ptr++;
264 P[2] = *s->stream_ptr++; P[3] = *s->stream_ptr++;
265 B[2] = *s->stream_ptr++; B[3] = *s->stream_ptr++;
266 P[4] = *s->stream_ptr++; P[5] = *s->stream_ptr++;
267 B[4] = *s->stream_ptr++; B[5] = *s->stream_ptr++;
268 P[6] = *s->stream_ptr++; P[7] = *s->stream_ptr++;
269 B[6] = *s->stream_ptr++; B[7] = *s->stream_ptr++;
271 for (y = 0; y < 8; y++) {
273 /* time to reload flags? */
276 ((B[0] & 0xF0) << 4) | ((B[4] & 0xF0) << 8) |
277 ((B[0] & 0x0F) ) | ((B[4] & 0x0F) << 4) |
278 ((B[1] & 0xF0) << 20) | ((B[5] & 0xF0) << 24) |
279 ((B[1] & 0x0F) << 16) | ((B[5] & 0x0F) << 20);
280 lower_half = 0; /* still on top half */
283 ((B[2] & 0xF0) << 4) | ((B[6] & 0xF0) << 8) |
284 ((B[2] & 0x0F) ) | ((B[6] & 0x0F) << 4) |
285 ((B[3] & 0xF0) << 20) | ((B[7] & 0xF0) << 24) |
286 ((B[3] & 0x0F) << 16) | ((B[7] & 0x0F) << 20);
290 for (x = 0; x < 8; x++, flags >>= 1) {
291 /* get the pixel values ready for this quadrant */
293 P0 = P[lower_half + 0];
294 P1 = P[lower_half + 1];
296 P0 = P[lower_half + 4];
297 P1 = P[lower_half + 5];
300 *s->pixel_ptr++ = flags & 1 ? P1 : P0;
302 s->pixel_ptr += s->line_inc;
307 /* need 10 more bytes */
308 CHECK_STREAM_PTR(10);
312 B[0] = *s->stream_ptr++; B[1] = *s->stream_ptr++;
313 B[2] = *s->stream_ptr++; B[3] = *s->stream_ptr++;
314 P[2] = *s->stream_ptr++; P[3] = *s->stream_ptr++;
315 B[4] = *s->stream_ptr++; B[5] = *s->stream_ptr++;
316 B[6] = *s->stream_ptr++; B[7] = *s->stream_ptr++;
318 /* vertical split; left & right halves are 2-color encoded */
320 for (y = 0; y < 8; y++) {
322 /* time to reload flags? */
325 ((B[0] & 0xF0) << 4) | ((B[4] & 0xF0) << 8) |
326 ((B[0] & 0x0F) ) | ((B[4] & 0x0F) << 4) |
327 ((B[1] & 0xF0) << 20) | ((B[5] & 0xF0) << 24) |
328 ((B[1] & 0x0F) << 16) | ((B[5] & 0x0F) << 20);
331 ((B[2] & 0xF0) << 4) | ((B[6] & 0xF0) << 8) |
332 ((B[2] & 0x0F) ) | ((B[6] & 0x0F) << 4) |
333 ((B[3] & 0xF0) << 20) | ((B[7] & 0xF0) << 24) |
334 ((B[3] & 0x0F) << 16) | ((B[7] & 0x0F) << 20);
337 for (x = 0; x < 8; x++, flags >>= 1) {
338 /* get the pixel values ready for this half */
347 *s->pixel_ptr++ = flags & 1 ? P1 : P0;
349 s->pixel_ptr += s->line_inc;
354 /* horizontal split; top & bottom halves are 2-color encoded */
356 for (y = 0; y < 8; y++) {
360 P[0] = *s->stream_ptr++;
361 P[1] = *s->stream_ptr++;
363 flags = *s->stream_ptr++;
365 for (bitmask = 0x01; bitmask <= 0x80; bitmask <<= 1) {
367 *s->pixel_ptr++ = P[!!(flags & bitmask)];
369 s->pixel_ptr += s->line_inc;
378 static int ipvideo_decode_block_opcode_0x9(IpvideoContext *s)
383 /* 4-color encoding */
386 memcpy(P, s->stream_ptr, 4);
392 /* 1 of 4 colors for each pixel, need 16 more bytes */
393 CHECK_STREAM_PTR(16);
395 for (y = 0; y < 8; y++) {
396 /* get the next set of 8 2-bit flags */
397 int flags = bytestream_get_le16(&s->stream_ptr);
398 for (x = 0; x < 8; x++, flags >>= 2) {
399 *s->pixel_ptr++ = P[flags & 0x03];
401 s->pixel_ptr += s->line_inc;
407 /* 1 of 4 colors for each 2x2 block, need 4 more bytes */
410 flags = bytestream_get_le32(&s->stream_ptr);
412 for (y = 0; y < 8; y += 2) {
413 for (x = 0; x < 8; x += 2, flags >>= 2) {
415 s->pixel_ptr[x + 1 ] =
416 s->pixel_ptr[x + s->stride] =
417 s->pixel_ptr[x + 1 + s->stride] = P[flags & 0x03];
419 s->pixel_ptr += s->stride * 2;
426 /* 1 of 4 colors for each 2x1 or 1x2 block, need 8 more bytes */
429 flags = bytestream_get_le64(&s->stream_ptr);
431 for (y = 0; y < 8; y++) {
432 for (x = 0; x < 8; x += 2, flags >>= 2) {
434 s->pixel_ptr[x + 1] = P[flags & 0x03];
436 s->pixel_ptr += s->stride;
439 for (y = 0; y < 8; y += 2) {
440 for (x = 0; x < 8; x++, flags >>= 2) {
442 s->pixel_ptr[x + s->stride] = P[flags & 0x03];
444 s->pixel_ptr += s->stride * 2;
453 static int ipvideo_decode_block_opcode_0xA(IpvideoContext *s)
463 /* 4-color encoding for each 4x4 quadrant, or 4-color encoding on
464 * either top and bottom or left and right halves */
467 memcpy(P, s->stream_ptr, 4);
472 /* 4-color encoding for each quadrant; need 28 more bytes */
473 CHECK_STREAM_PTR(28);
475 memcpy(B, s->stream_ptr, 4);
477 for (y = 4; y < 16; y += 4) {
478 memcpy(P + y, s->stream_ptr, 4);
480 memcpy(B + y, s->stream_ptr, 4);
484 for (y = 0; y < 8; y++) {
486 lower_half = (y >= 4) ? 4 : 0;
487 flags = (B[y + 8] << 8) | B[y];
489 for (x = 0; x < 8; x++, flags >>= 2) {
490 split = (x >= 4) ? 8 : 0;
491 index = split + lower_half + (flags & 0x03);
492 *s->pixel_ptr++ = P[index];
495 s->pixel_ptr += s->line_inc;
500 /* 4-color encoding for either left and right or top and bottom
501 * halves; need 20 more bytes */
502 CHECK_STREAM_PTR(20);
504 memcpy(B, s->stream_ptr, 8);
506 memcpy(P + 4, s->stream_ptr, 4);
508 memcpy(B + 8, s->stream_ptr, 8);
513 /* block is divided into left and right halves */
514 for (y = 0; y < 8; y++) {
516 flags = (B[y + 8] << 8) | B[y];
519 for (x = 0; x < 8; x++, flags >>= 2) {
522 *s->pixel_ptr++ = P[split + (flags & 0x03)];
525 s->pixel_ptr += s->line_inc;
530 /* block is divided into top and bottom halves */
532 for (y = 0; y < 8; y++) {
534 flags = (B[y * 2 + 1] << 8) | B[y * 2];
538 for (x = 0; x < 8; x++, flags >>= 2)
539 *s->pixel_ptr++ = P[split + (flags & 0x03)];
541 s->pixel_ptr += s->line_inc;
550 static int ipvideo_decode_block_opcode_0xB(IpvideoContext *s)
554 /* 64-color encoding (each pixel in block is a different color) */
555 CHECK_STREAM_PTR(64);
557 for (y = 0; y < 8; y++) {
558 memcpy(s->pixel_ptr, s->stream_ptr, 8);
560 s->pixel_ptr += s->stride;
567 static int ipvideo_decode_block_opcode_0xC(IpvideoContext *s)
571 /* 16-color block encoding: each 2x2 block is a different color */
572 CHECK_STREAM_PTR(16);
574 for (y = 0; y < 8; y += 2) {
575 for (x = 0; x < 8; x += 2) {
577 s->pixel_ptr[x + 1 ] =
578 s->pixel_ptr[x + s->stride] =
579 s->pixel_ptr[x + 1 + s->stride] = *s->stream_ptr++;
581 s->pixel_ptr += s->stride * 2;
588 static int ipvideo_decode_block_opcode_0xD(IpvideoContext *s)
592 unsigned char index = 0;
594 /* 4-color block encoding: each 4x4 block is a different color */
597 memcpy(P, s->stream_ptr, 4);
600 for (y = 0; y < 8; y++) {
606 memset(s->pixel_ptr , P[index ], 4);
607 memset(s->pixel_ptr + 4, P[index + 1], 4);
608 s->pixel_ptr += s->stride;
615 static int ipvideo_decode_block_opcode_0xE(IpvideoContext *s)
620 /* 1-color encoding: the whole block is 1 solid color */
622 pix = *s->stream_ptr++;
624 for (y = 0; y < 8; y++) {
625 memset(s->pixel_ptr, pix, 8);
626 s->pixel_ptr += s->stride;
633 static int ipvideo_decode_block_opcode_0xF(IpvideoContext *s)
636 unsigned char sample[2];
638 /* dithered encoding */
640 sample[0] = *s->stream_ptr++;
641 sample[1] = *s->stream_ptr++;
643 for (y = 0; y < 8; y++) {
644 for (x = 0; x < 8; x += 2) {
645 *s->pixel_ptr++ = sample[ y & 1 ];
646 *s->pixel_ptr++ = sample[!(y & 1)];
648 s->pixel_ptr += s->line_inc;
655 static int (* const ipvideo_decode_block[])(IpvideoContext *s) = {
656 ipvideo_decode_block_opcode_0x0, ipvideo_decode_block_opcode_0x1,
657 ipvideo_decode_block_opcode_0x2, ipvideo_decode_block_opcode_0x3,
658 ipvideo_decode_block_opcode_0x4, ipvideo_decode_block_opcode_0x5,
659 ipvideo_decode_block_opcode_0x6, ipvideo_decode_block_opcode_0x7,
660 ipvideo_decode_block_opcode_0x8, ipvideo_decode_block_opcode_0x9,
661 ipvideo_decode_block_opcode_0xA, ipvideo_decode_block_opcode_0xB,
662 ipvideo_decode_block_opcode_0xC, ipvideo_decode_block_opcode_0xD,
663 ipvideo_decode_block_opcode_0xE, ipvideo_decode_block_opcode_0xF,
666 static void ipvideo_decode_opcodes(IpvideoContext *s)
670 unsigned char opcode;
672 int code_counts[16] = {0};
673 static int frame = 0;
675 debug_interplay("------------------ frame %d\n", frame);
678 /* this is PAL8, so make the palette available */
679 memcpy(s->current_frame.data[1], s->avctx->palctrl->palette, PALETTE_COUNT * 4);
681 s->stride = s->current_frame.linesize[0];
682 s->stream_ptr = s->buf + 14; /* data starts 14 bytes in */
683 s->stream_end = s->buf + s->size;
684 s->line_inc = s->stride - 8;
685 s->upper_motion_limit_offset = (s->avctx->height - 8) * s->stride
686 + s->avctx->width - 8;
688 for (y = 0; y < (s->stride * s->avctx->height); y += s->stride * 8) {
689 for (x = y; x < y + s->avctx->width; x += 8) {
690 /* bottom nibble first, then top nibble (which makes it
691 * hard to use a GetBitcontext) */
693 opcode = s->decoding_map[index >> 1] >> 4;
695 opcode = s->decoding_map[index >> 1] & 0xF;
698 debug_interplay(" block @ (%3d, %3d): encoding 0x%X, data ptr @ %p\n",
699 x - y, y / s->stride, opcode, s->stream_ptr);
700 code_counts[opcode]++;
702 s->pixel_ptr = s->current_frame.data[0] + x;
703 ret = ipvideo_decode_block[opcode](s);
705 av_log(s->avctx, AV_LOG_ERROR, " Interplay video: decode problem on frame %d, @ block (%d, %d)\n",
706 frame, x - y, y / s->stride);
711 if (s->stream_end - s->stream_ptr > 1) {
712 av_log(s->avctx, AV_LOG_ERROR, " Interplay video: decode finished with %td bytes left over\n",
713 s->stream_end - s->stream_ptr);
717 static av_cold int ipvideo_decode_init(AVCodecContext *avctx)
719 IpvideoContext *s = avctx->priv_data;
723 if (s->avctx->palctrl == NULL) {
724 av_log(avctx, AV_LOG_ERROR, " Interplay video: palette expected.\n");
728 avctx->pix_fmt = PIX_FMT_PAL8;
729 dsputil_init(&s->dsp, avctx);
731 /* decoding map contains 4 bits of information per 8x8 block */
732 s->decoding_map_size = avctx->width * avctx->height / (8 * 8 * 2);
734 s->current_frame.data[0] = s->last_frame.data[0] =
735 s->second_last_frame.data[0] = NULL;
740 static int ipvideo_decode_frame(AVCodecContext *avctx,
741 void *data, int *data_size,
742 const uint8_t *buf, int buf_size)
744 IpvideoContext *s = avctx->priv_data;
745 AVPaletteControl *palette_control = avctx->palctrl;
747 /* compressed buffer needs to be large enough to at least hold an entire
749 if (buf_size < s->decoding_map_size)
752 s->decoding_map = buf;
753 s->buf = buf + s->decoding_map_size;
754 s->size = buf_size - s->decoding_map_size;
756 s->current_frame.reference = 3;
757 if (avctx->get_buffer(avctx, &s->current_frame)) {
758 av_log(avctx, AV_LOG_ERROR, " Interplay Video: get_buffer() failed\n");
762 ipvideo_decode_opcodes(s);
764 if (palette_control->palette_changed) {
765 palette_control->palette_changed = 0;
766 s->current_frame.palette_has_changed = 1;
769 *data_size = sizeof(AVFrame);
770 *(AVFrame*)data = s->current_frame;
773 if (s->second_last_frame.data[0])
774 avctx->release_buffer(avctx, &s->second_last_frame);
775 s->second_last_frame = s->last_frame;
776 s->last_frame = s->current_frame;
777 s->current_frame.data[0] = NULL; /* catch any access attempts */
779 /* report that the buffer was completely consumed */
783 static av_cold int ipvideo_decode_end(AVCodecContext *avctx)
785 IpvideoContext *s = avctx->priv_data;
787 /* release the last frame */
788 if (s->last_frame.data[0])
789 avctx->release_buffer(avctx, &s->last_frame);
790 if (s->second_last_frame.data[0])
791 avctx->release_buffer(avctx, &s->second_last_frame);
796 AVCodec interplay_video_decoder = {
799 CODEC_ID_INTERPLAY_VIDEO,
800 sizeof(IpvideoContext),
804 ipvideo_decode_frame,
806 .long_name = NULL_IF_CONFIG_SMALL("Interplay MVE video"),