eatgv.c 11 KB
Newer Older
Peter Ross's avatar
Peter Ross committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * Electronic Arts TGV Video Decoder
 * Copyright (c) 2007-2008 Peter Ross
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * 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
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/**
23
 * @file
Peter Ross's avatar
Peter Ross committed
24
 * Electronic Arts TGV Video Decoder
Peter Ross's avatar
Peter Ross committed
25
 * by Peter Ross (pross@xvid.org)
Peter Ross's avatar
Peter Ross committed
26 27 28 29 30 31
 *
 * Technical details here:
 * http://wiki.multimedia.cx/index.php?title=Electronic_Arts_TGV
 */

#include "avcodec.h"
32
#define BITSTREAM_READER_LE
33
#include "get_bits.h"
34
#include "internal.h"
35
#include "libavutil/imgutils.h"
36
#include "libavutil/mem.h"
Peter Ross's avatar
Peter Ross committed
37 38 39 40 41 42

#define EA_PREAMBLE_SIZE    8
#define kVGT_TAG MKTAG('k', 'V', 'G', 'T')

typedef struct TgvContext {
    AVCodecContext *avctx;
43
    AVFrame *last_frame;
44
    uint8_t *frame_buffer;
Peter Ross's avatar
Peter Ross committed
45
    int width,height;
46
    uint32_t palette[AVPALETTE_COUNT];
Peter Ross's avatar
Peter Ross committed
47 48

    int (*mv_codebook)[2];
49
    uint8_t (*block_codebook)[16];
Peter Ross's avatar
Peter Ross committed
50 51 52 53
    int num_mvs;           ///< current length of mv_codebook
    int num_blocks_packed; ///< current length of block_codebook
} TgvContext;

54 55
static av_cold int tgv_decode_init(AVCodecContext *avctx)
{
Peter Ross's avatar
Peter Ross committed
56
    TgvContext *s = avctx->priv_data;
57
    s->avctx         = avctx;
58
    avctx->framerate = (AVRational){ 15, 1 };
59
    avctx->pix_fmt   = AV_PIX_FMT_PAL8;
60 61 62 63 64

    s->last_frame = av_frame_alloc();
    if (!s->last_frame)
        return AVERROR(ENOMEM);

Peter Ross's avatar
Peter Ross committed
65 66 67 68 69 70 71
    return 0;
}

/**
 * Unpack buffer
 * @return 0 on success, -1 on critical buffer underflow
 */
72
static int unpack(const uint8_t *src, const uint8_t *src_end,
73
                  uint8_t *dst, int width, int height)
74
{
75
    uint8_t *dst_end = dst + width*height;
76
    int size, size1, size2, offset, run;
77
    uint8_t *dst_start = dst;
Peter Ross's avatar
Peter Ross committed
78 79 80 81 82 83

    if (src[0] & 0x01)
        src += 5;
    else
        src += 2;

84
    if (src_end - src < 3)
85
        return AVERROR_INVALIDDATA;
Peter Ross's avatar
Peter Ross committed
86 87 88
    size = AV_RB24(src);
    src += 3;

89
    while (size > 0 && src < src_end) {
Peter Ross's avatar
Peter Ross committed
90 91 92

        /* determine size1 and size2 */
        size1 = (src[0] & 3);
93
        if (src[0] & 0x80) {  // 1
Peter Ross's avatar
Peter Ross committed
94
            if (src[0] & 0x40 ) {  // 11
95 96
                if (src[0] & 0x20) {  // 111
                    if (src[0] < 0xFC)  // !(111111)
Peter Ross's avatar
Peter Ross committed
97 98 99 100 101
                        size1 = (((src[0] & 31) + 1) << 2);
                    src++;
                    size2 = 0;
                } else {  // 110
                    offset = ((src[0] & 0x10) << 12) + AV_RB16(&src[1]) + 1;
102 103
                    size2  = ((src[0] & 0xC) << 6) + src[3] + 5;
                    src   += 4;
Peter Ross's avatar
Peter Ross committed
104 105
                }
            } else {  // 10
106
                size1  = ((src[1] & 0xC0) >> 6);
Peter Ross's avatar
Peter Ross committed
107
                offset = (AV_RB16(&src[1]) & 0x3FFF) + 1;
108 109
                size2  = (src[0] & 0x3F) + 4;
                src   += 3;
Peter Ross's avatar
Peter Ross committed
110 111 112
            }
        } else {  // 0
            offset = ((src[0] & 0x60) << 3) + src[1] + 1;
113 114
            size2  = ((src[0] & 0x1C) >> 2) + 3;
            src   += 2;
Peter Ross's avatar
Peter Ross committed
115 116 117 118
        }


        /* fetch strip from src */
119
        if (size1 > src_end - src)
Peter Ross's avatar
Peter Ross committed
120 121
            break;

122
        if (size1 > 0) {
Peter Ross's avatar
Peter Ross committed
123
            size -= size1;
124
            run   = FFMIN(size1, dst_end - dst);
Peter Ross's avatar
Peter Ross committed
125 126 127 128 129
            memcpy(dst, src, run);
            dst += run;
            src += run;
        }

130 131
        if (size2 > 0) {
            if (dst - dst_start < offset)
Peter Ross's avatar
Peter Ross committed
132 133
                return 0;
            size -= size2;
134
            run   = FFMIN(size2, dst_end - dst);
Peter Ross's avatar
Peter Ross committed
135 136 137 138 139 140 141 142 143 144 145 146
            av_memcpy_backptr(dst, offset, run);
            dst += run;
        }
    }

    return 0;
}

/**
 * Decode inter-frame
 * @return 0 on success, -1 on critical buffer underflow
 */
147 148
static int tgv_decode_inter(TgvContext *s, AVFrame *frame,
                            const uint8_t *buf, const uint8_t *buf_end)
149
{
Peter Ross's avatar
Peter Ross committed
150 151 152 153 154 155 156
    int num_mvs;
    int num_blocks_raw;
    int num_blocks_packed;
    int vector_bits;
    int i,j,x,y;
    GetBitContext gb;
    int mvbits;
157
    const uint8_t *blocks_raw;
Peter Ross's avatar
Peter Ross committed
158

159
    if(buf_end - buf < 12)
160
        return AVERROR_INVALIDDATA;
Peter Ross's avatar
Peter Ross committed
161 162 163 164 165 166 167

    num_mvs           = AV_RL16(&buf[0]);
    num_blocks_raw    = AV_RL16(&buf[2]);
    num_blocks_packed = AV_RL16(&buf[4]);
    vector_bits       = AV_RL16(&buf[6]);
    buf += 12;

168
    if (vector_bits > MIN_CACHE_BITS || !vector_bits) {
169 170
        av_log(s->avctx, AV_LOG_ERROR,
               "Invalid value for motion vector bits: %d\n", vector_bits);
171 172 173
        return AVERROR_INVALIDDATA;
    }

174
    /* allocate codebook buffers as necessary */
Peter Ross's avatar
Peter Ross committed
175
    if (num_mvs > s->num_mvs) {
176 177 178 179
        if (av_reallocp_array(&s->mv_codebook, num_mvs, sizeof(*s->mv_codebook))) {
            s->num_mvs = 0;
            return AVERROR(ENOMEM);
        }
Peter Ross's avatar
Peter Ross committed
180 181 182 183
        s->num_mvs = num_mvs;
    }

    if (num_blocks_packed > s->num_blocks_packed) {
184 185
        int err;
        if ((err = av_reallocp(&s->block_codebook, num_blocks_packed * 16)) < 0) {
186
            s->num_blocks_packed = 0;
187
            return err;
188
        }
Peter Ross's avatar
Peter Ross committed
189 190 191 192
        s->num_blocks_packed = num_blocks_packed;
    }

    /* read motion vectors */
193
    mvbits = (num_mvs * 2 * 10 + 31) & ~31;
Peter Ross's avatar
Peter Ross committed
194

195
    if (buf_end - buf < (mvbits>>3) + 16*num_blocks_raw + 8*num_blocks_packed)
196
        return AVERROR_INVALIDDATA;
Peter Ross's avatar
Peter Ross committed
197 198

    init_get_bits(&gb, buf, mvbits);
199
    for (i = 0; i < num_mvs; i++) {
Peter Ross's avatar
Peter Ross committed
200 201 202
        s->mv_codebook[i][0] = get_sbits(&gb, 10);
        s->mv_codebook[i][1] = get_sbits(&gb, 10);
    }
203
    buf += mvbits >> 3;
Peter Ross's avatar
Peter Ross committed
204 205 206

    /* note ptr to uncompressed blocks */
    blocks_raw = buf;
207
    buf       += num_blocks_raw * 16;
Peter Ross's avatar
Peter Ross committed
208 209

    /* read compressed blocks */
210 211
    init_get_bits(&gb, buf, (buf_end - buf) << 3);
    for (i = 0; i < num_blocks_packed; i++) {
Peter Ross's avatar
Peter Ross committed
212
        int tmp[4];
213
        for (j = 0; j < 4; j++)
Peter Ross's avatar
Peter Ross committed
214
            tmp[j] = get_bits(&gb, 8);
215
        for (j = 0; j < 16; j++)
Peter Ross's avatar
Peter Ross committed
216 217 218
            s->block_codebook[i][15-j] = tmp[get_bits(&gb, 2)];
    }

219
    if (get_bits_left(&gb) < vector_bits *
220
        (s->avctx->height / 4) * (s->avctx->width / 4))
221
        return AVERROR_INVALIDDATA;
222

Peter Ross's avatar
Peter Ross committed
223
    /* read vectors and build frame */
224 225 226
    for (y = 0; y < s->avctx->height / 4; y++)
        for (x = 0; x < s->avctx->width / 4; x++) {
            unsigned int vector = get_bits(&gb, vector_bits);
227
            const uint8_t *src;
228 229 230 231 232 233 234
            int src_stride;

            if (vector < num_mvs) {
                int mx = x * 4 + s->mv_codebook[vector][0];
                int my = y * 4 + s->mv_codebook[vector][1];

                if (mx < 0 || mx + 4 > s->avctx->width ||
235 236
                    my < 0 || my + 4 > s->avctx->height) {
                    av_log(s->avctx, AV_LOG_ERROR, "MV %d %d out of picture\n", mx, my);
237
                    continue;
238
                }
239

240 241
                src = s->last_frame->data[0] + mx + my * s->last_frame->linesize[0];
                src_stride = s->last_frame->linesize[0];
242 243 244 245 246 247 248 249 250 251
            } else {
                int offset = vector - num_mvs;
                if (offset < num_blocks_raw)
                    src = blocks_raw + 16*offset;
                else if (offset - num_blocks_raw < num_blocks_packed)
                    src = s->block_codebook[offset - num_blocks_raw];
                else
                    continue;
                src_stride = 4;
            }
Peter Ross's avatar
Peter Ross committed
252

253 254
            for (j = 0; j < 4; j++)
                for (i = 0; i < 4; i++)
255
                    frame->data[0][(y * 4 + j) * frame->linesize[0] + (x * 4 + i)] =
256
                        src[j * src_stride + i];
Peter Ross's avatar
Peter Ross committed
257 258 259 260 261 262
    }

    return 0;
}

static int tgv_decode_frame(AVCodecContext *avctx,
263
                            void *data, int *got_frame,
264
                            AVPacket *avpkt)
Peter Ross's avatar
Peter Ross committed
265
{
266 267 268
    const uint8_t *buf     = avpkt->data;
    int buf_size           = avpkt->size;
    TgvContext *s          = avctx->priv_data;
Peter Ross's avatar
Peter Ross committed
269
    const uint8_t *buf_end = buf + buf_size;
270
    AVFrame *frame         = data;
271
    int chunk_type, ret;
Peter Ross's avatar
Peter Ross committed
272

273 274 275
    if (buf_end - buf < EA_PREAMBLE_SIZE)
        return AVERROR_INVALIDDATA;

Peter Ross's avatar
Peter Ross committed
276
    chunk_type = AV_RL32(&buf[0]);
277
    buf       += EA_PREAMBLE_SIZE;
Peter Ross's avatar
Peter Ross committed
278

279
    if (chunk_type == kVGT_TAG) {
Peter Ross's avatar
Peter Ross committed
280
        int pal_count, i;
281
        if(buf_end - buf < 12) {
Peter Ross's avatar
Peter Ross committed
282
            av_log(avctx, AV_LOG_WARNING, "truncated header\n");
283
            return AVERROR_INVALIDDATA;
Peter Ross's avatar
Peter Ross committed
284 285 286 287
        }

        s->width  = AV_RL16(&buf[0]);
        s->height = AV_RL16(&buf[2]);
288
        if (s->avctx->width != s->width || s->avctx->height != s->height) {
289
            av_freep(&s->frame_buffer);
290
            av_frame_unref(s->last_frame);
291 292
            if ((ret = ff_set_dimensions(s->avctx, s->width, s->height)) < 0)
                return ret;
Peter Ross's avatar
Peter Ross committed
293 294 295 296
        }

        pal_count = AV_RL16(&buf[6]);
        buf += 12;
297
        for(i = 0; i < pal_count && i < AVPALETTE_COUNT && buf_end - buf >= 3; i++) {
298
            s->palette[i] = 0xFFU << 24 | AV_RB24(buf);
Peter Ross's avatar
Peter Ross committed
299 300 301 302
            buf += 3;
        }
    }

303 304
    if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
        return ret;
Peter Ross's avatar
Peter Ross committed
305

306
    memcpy(frame->data[1], s->palette, AVPALETTE_SIZE);
Peter Ross's avatar
Peter Ross committed
307

308
    if (chunk_type == kVGT_TAG) {
309 310 311 312 313
        int y;
        frame->key_frame = 1;
        frame->pict_type = AV_PICTURE_TYPE_I;

        if (!s->frame_buffer &&
314
            !(s->frame_buffer = av_mallocz(s->width * s->height)))
315 316 317
            return AVERROR(ENOMEM);

        if (unpack(buf, buf_end, s->frame_buffer, s->avctx->width, s->avctx->height) < 0) {
Peter Ross's avatar
Peter Ross committed
318
            av_log(avctx, AV_LOG_WARNING, "truncated intra frame\n");
319
            return AVERROR_INVALIDDATA;
Peter Ross's avatar
Peter Ross committed
320
        }
321 322 323 324
        for (y = 0; y < s->height; y++)
            memcpy(frame->data[0]  + y * frame->linesize[0],
                   s->frame_buffer + y * s->width,
                   s->width);
325
    } else {
326
        if (!s->last_frame->data[0]) {
Peter Ross's avatar
Peter Ross committed
327 328 329
            av_log(avctx, AV_LOG_WARNING, "inter frame without corresponding intra frame\n");
            return buf_size;
        }
330 331 332
        frame->key_frame = 0;
        frame->pict_type = AV_PICTURE_TYPE_P;
        if (tgv_decode_inter(s, frame, buf, buf_end) < 0) {
Peter Ross's avatar
Peter Ross committed
333
            av_log(avctx, AV_LOG_WARNING, "truncated inter frame\n");
334
            return AVERROR_INVALIDDATA;
Peter Ross's avatar
Peter Ross committed
335 336 337
        }
    }

338 339
    av_frame_unref(s->last_frame);
    if ((ret = av_frame_ref(s->last_frame, frame)) < 0)
340 341
        return ret;

342
    *got_frame = 1;
Peter Ross's avatar
Peter Ross committed
343 344 345 346 347 348 349

    return buf_size;
}

static av_cold int tgv_decode_end(AVCodecContext *avctx)
{
    TgvContext *s = avctx->priv_data;
350
    av_frame_free(&s->last_frame);
351
    av_freep(&s->frame_buffer);
352 353
    av_freep(&s->mv_codebook);
    av_freep(&s->block_codebook);
Peter Ross's avatar
Peter Ross committed
354 355 356
    return 0;
}

357
AVCodec ff_eatgv_decoder = {
358
    .name           = "eatgv",
359
    .long_name      = NULL_IF_CONFIG_SMALL("Electronic Arts TGV video"),
360
    .type           = AVMEDIA_TYPE_VIDEO,
361
    .id             = AV_CODEC_ID_TGV,
362 363 364 365
    .priv_data_size = sizeof(TgvContext),
    .init           = tgv_decode_init,
    .close          = tgv_decode_end,
    .decode         = tgv_decode_frame,
366
    .capabilities   = CODEC_CAP_DR1,
Peter Ross's avatar
Peter Ross committed
367
};