mmvideo.c 7.17 KB
Newer Older
1 2
/*
 * American Laser Games MM Video Decoder
3
 * Copyright (c) 2006,2008 Peter Ross
4
 *
5 6 7
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
8 9
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
10
 * version 2.1 of the License, or (at your option) any later version.
11
 *
12
 * FFmpeg is distributed in the hope that it will be useful,
13 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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
20 21 22
 */

/**
23
 * @file
24
 * American Laser Games MM Video Decoder
Peter Ross's avatar
Peter Ross committed
25
 * by Peter Ross (pross@xvid.org)
26 27 28 29 30 31 32 33
 *
 * The MM format was used by IBM-PC ports of ALG's "arcade shooter" games,
 * including Mad Dog McCree and Crime Patrol.
 *
 * Technical details here:
 *  http://wiki.multimedia.cx/index.php?title=American_Laser_Games_MM
 */

34
#include "libavutil/intreadwrite.h"
35
#include "avcodec.h"
36
#include "bytestream.h"
37
#include "internal.h"
38 39 40 41 42 43 44 45 46

#define MM_PREAMBLE_SIZE    6

#define MM_TYPE_INTER       0x5
#define MM_TYPE_INTRA       0x8
#define MM_TYPE_INTRA_HH    0xc
#define MM_TYPE_INTER_HH    0xd
#define MM_TYPE_INTRA_HHV   0xe
#define MM_TYPE_INTER_HHV   0xf
47
#define MM_TYPE_PALETTE     0x31
48 49 50

typedef struct MmContext {
    AVCodecContext *avctx;
51
    AVFrame *frame;
52
    unsigned int palette[AVPALETTE_COUNT];
53
    GetByteContext gb;
54 55
} MmContext;

56
static av_cold int mm_decode_init(AVCodecContext *avctx)
57 58 59 60 61
{
    MmContext *s = avctx->priv_data;

    s->avctx = avctx;

62
    avctx->pix_fmt = AV_PIX_FMT_PAL8;
63

64 65 66 67 68 69 70
    if (!avctx->width || !avctx->height ||
        (avctx->width & 1) || (avctx->height & 1)) {
        av_log(avctx, AV_LOG_ERROR, "Invalid video dimensions: %dx%d\n",
               avctx->width, avctx->height);
        return AVERROR(EINVAL);
    }

71 72 73
    s->frame = av_frame_alloc();
    if (!s->frame)
        return AVERROR(ENOMEM);
74

75 76 77
    return 0;
}

78
static void mm_decode_pal(MmContext *s)
79 80
{
    int i;
81 82 83

    bytestream2_skip(&s->gb, 4);
    for (i = 0; i < 128; i++) {
84
        s->palette[i] = 0xFFU << 24 | bytestream2_get_be24(&s->gb);
85 86 87 88
        s->palette[i+128] = s->palette[i]<<2;
    }
}

89 90 91 92
/**
 * @param half_horiz Half horizontal resolution (0 or 1)
 * @param half_vert Half vertical resolution (0 or 1)
 */
93
static int mm_decode_intra(MmContext * s, int half_horiz, int half_vert)
94
{
95
    int x = 0, y = 0;
96

97
    while (bytestream2_get_bytes_left(&s->gb) > 0) {
98 99
        int run_length, color;

100
        if (y >= s->avctx->height)
101
            return 0;
102

103 104
        color = bytestream2_get_byte(&s->gb);
        if (color & 0x80) {
105 106
            run_length = 1;
        }else{
107 108
            run_length = (color & 0x7f) + 2;
            color = bytestream2_get_byte(&s->gb);
109 110 111 112 113
        }

        if (half_horiz)
            run_length *=2;

114 115 116
        if (run_length > s->avctx->width - x)
            return AVERROR_INVALIDDATA;

117
        if (color) {
118
            memset(s->frame->data[0] + y*s->frame->linesize[0] + x, color, run_length);
119
            if (half_vert && y + half_vert < s->avctx->height)
120
                memset(s->frame->data[0] + (y+1)*s->frame->linesize[0] + x, color, run_length);
121 122 123 124 125
        }
        x+= run_length;

        if (x >= s->avctx->width) {
            x=0;
126
            y += 1 + half_vert;
127 128
        }
    }
129 130

    return 0;
131 132
}

133
/**
134 135 136
 * @param half_horiz Half horizontal resolution (0 or 1)
 * @param half_vert Half vertical resolution (0 or 1)
 */
137
static int mm_decode_inter(MmContext * s, int half_horiz, int half_vert)
138
{
139 140
    int data_off = bytestream2_get_le16(&s->gb);
    int y = 0;
141
    GetByteContext data_ptr;
142

143 144
    if (bytestream2_get_bytes_left(&s->gb) < data_off)
        return AVERROR_INVALIDDATA;
145

146 147
    bytestream2_init(&data_ptr, s->gb.buffer + data_off, bytestream2_get_bytes_left(&s->gb) - data_off);
    while (s->gb.buffer < data_ptr.buffer_start) {
148
        int i, j;
149 150 151
        int length = bytestream2_get_byte(&s->gb);
        int x = bytestream2_get_byte(&s->gb) + ((length & 0x80) << 1);
        length &= 0x7F;
152 153 154 155 156 157

        if (length==0) {
            y += x;
            continue;
        }

158
        if (y + half_vert >= s->avctx->height)
159
            return 0;
160

161
        for(i=0; i<length; i++) {
162
            int replace_array = bytestream2_get_byte(&s->gb);
163
            for(j=0; j<8; j++) {
164
                int replace = (replace_array >> (7-j)) & 1;
165 166
                if (x + half_horiz >= s->avctx->width)
                    return AVERROR_INVALIDDATA;
167
                if (replace) {
168
                    int color = bytestream2_get_byte(&data_ptr);
169
                    s->frame->data[0][y*s->frame->linesize[0] + x] = color;
170
                    if (half_horiz)
171
                        s->frame->data[0][y*s->frame->linesize[0] + x + 1] = color;
172
                    if (half_vert) {
173
                        s->frame->data[0][(y+1)*s->frame->linesize[0] + x] = color;
174
                        if (half_horiz)
175
                            s->frame->data[0][(y+1)*s->frame->linesize[0] + x + 1] = color;
176 177
                    }
                }
178
                x += 1 + half_horiz;
179 180 181
            }
        }

182
        y += 1 + half_vert;
183
    }
184 185

    return 0;
186 187 188
}

static int mm_decode_frame(AVCodecContext *avctx,
189
                            void *data, int *got_frame,
190
                            AVPacket *avpkt)
191
{
192 193
    const uint8_t *buf = avpkt->data;
    int buf_size = avpkt->size;
194
    MmContext *s = avctx->priv_data;
195
    int type, res;
196

197 198
    if (buf_size < MM_PREAMBLE_SIZE)
        return AVERROR_INVALIDDATA;
199
    type = AV_RL16(&buf[0]);
200 201
    buf += MM_PREAMBLE_SIZE;
    buf_size -= MM_PREAMBLE_SIZE;
202
    bytestream2_init(&s->gb, buf, buf_size);
203

204
    if ((res = ff_reget_buffer(avctx, s->frame, 0)) < 0)
205
        return res;
206

207
    switch(type) {
208
    case MM_TYPE_PALETTE   : mm_decode_pal(s); return avpkt->size;
209 210 211 212 213 214 215 216 217
    case MM_TYPE_INTRA     : res = mm_decode_intra(s, 0, 0); break;
    case MM_TYPE_INTRA_HH  : res = mm_decode_intra(s, 1, 0); break;
    case MM_TYPE_INTRA_HHV : res = mm_decode_intra(s, 1, 1); break;
    case MM_TYPE_INTER     : res = mm_decode_inter(s, 0, 0); break;
    case MM_TYPE_INTER_HH  : res = mm_decode_inter(s, 1, 0); break;
    case MM_TYPE_INTER_HHV : res = mm_decode_inter(s, 1, 1); break;
    default:
        res = AVERROR_INVALIDDATA;
        break;
218
    }
219 220
    if (res < 0)
        return res;
221

222
    memcpy(s->frame->data[1], s->palette, AVPALETTE_SIZE);
223

224
    if ((res = av_frame_ref(data, s->frame)) < 0)
225 226
        return res;

227
    *got_frame      = 1;
228

229
    return avpkt->size;
230 231
}

232
static av_cold int mm_decode_end(AVCodecContext *avctx)
233 234 235
{
    MmContext *s = avctx->priv_data;

236
    av_frame_free(&s->frame);
237 238 239 240

    return 0;
}

241
AVCodec ff_mmvideo_decoder = {
242
    .name           = "mmvideo",
243
    .long_name      = NULL_IF_CONFIG_SMALL("American Laser Games MM Video"),
244
    .type           = AVMEDIA_TYPE_VIDEO,
245
    .id             = AV_CODEC_ID_MMVIDEO,
246 247 248 249
    .priv_data_size = sizeof(MmContext),
    .init           = mm_decode_init,
    .close          = mm_decode_end,
    .decode         = mm_decode_frame,
250
    .capabilities   = AV_CODEC_CAP_DR1,
251
};