pafvideo.c 11.6 KB
Newer Older
Paul B Mahol's avatar
Paul B Mahol committed
1
/*
2
 * Packed Animation File video decoder
Paul B Mahol's avatar
Paul B Mahol committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 * Copyright (c) 2012 Paul B Mahol
 *
 * 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 Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

Paul B Mahol's avatar
Paul B Mahol committed
22 23
#include "libavutil/imgutils.h"

Paul B Mahol's avatar
Paul B Mahol committed
24
#include "avcodec.h"
Paul B Mahol's avatar
Paul B Mahol committed
25
#include "bytestream.h"
26
#include "copy_block.h"
27
#include "internal.h"
Paul B Mahol's avatar
Paul B Mahol committed
28

29

Paul B Mahol's avatar
Paul B Mahol committed
30
static const uint8_t block_sequences[16][8] = {
Paul B Mahol's avatar
Paul B Mahol committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
    { 0, 0, 0, 0, 0, 0, 0, 0 },
    { 2, 0, 0, 0, 0, 0, 0, 0 },
    { 5, 7, 0, 0, 0, 0, 0, 0 },
    { 5, 0, 0, 0, 0, 0, 0, 0 },
    { 6, 0, 0, 0, 0, 0, 0, 0 },
    { 5, 7, 5, 7, 0, 0, 0, 0 },
    { 5, 7, 5, 0, 0, 0, 0, 0 },
    { 5, 7, 6, 0, 0, 0, 0, 0 },
    { 5, 5, 0, 0, 0, 0, 0, 0 },
    { 3, 0, 0, 0, 0, 0, 0, 0 },
    { 6, 6, 0, 0, 0, 0, 0, 0 },
    { 2, 4, 0, 0, 0, 0, 0, 0 },
    { 2, 4, 5, 7, 0, 0, 0, 0 },
    { 2, 4, 5, 0, 0, 0, 0, 0 },
    { 2, 4, 6, 0, 0, 0, 0, 0 },
46
    { 2, 4, 5, 7, 5, 7, 0, 0 },
Paul B Mahol's avatar
Paul B Mahol committed
47 48 49
};

typedef struct PAFVideoDecContext {
50
    AVFrame  *pic;
Paul B Mahol's avatar
Paul B Mahol committed
51 52
    GetByteContext gb;

Paul B Mahol's avatar
Paul B Mahol committed
53 54 55 56
    int width;
    int height;

    int current_frame;
Paul B Mahol's avatar
Paul B Mahol committed
57
    uint8_t *frame[4];
Paul B Mahol's avatar
Paul B Mahol committed
58 59
    int frame_size;
    int video_size;
Paul B Mahol's avatar
Paul B Mahol committed
60 61 62 63

    uint8_t *opcodes;
} PAFVideoDecContext;

Paul B Mahol's avatar
Paul B Mahol committed
64
static av_cold int paf_video_close(AVCodecContext *avctx)
65 66 67 68 69 70 71 72 73 74 75 76
{
    PAFVideoDecContext *c = avctx->priv_data;
    int i;

    av_frame_free(&c->pic);

    for (i = 0; i < 4; i++)
        av_freep(&c->frame[i]);

    return 0;
}

Paul B Mahol's avatar
Paul B Mahol committed
77
static av_cold int paf_video_init(AVCodecContext *avctx)
Paul B Mahol's avatar
Paul B Mahol committed
78 79 80 81
{
    PAFVideoDecContext *c = avctx->priv_data;
    int i;

Paul B Mahol's avatar
Paul B Mahol committed
82 83 84
    c->width  = avctx->width;
    c->height = avctx->height;

Paul B Mahol's avatar
Paul B Mahol committed
85
    if (avctx->height & 3 || avctx->width & 3) {
Paul B Mahol's avatar
Paul B Mahol committed
86 87 88
        av_log(avctx, AV_LOG_ERROR,
               "width %d and height %d must be multiplie of 4.\n",
               avctx->width, avctx->height);
Paul B Mahol's avatar
Paul B Mahol committed
89 90 91
        return AVERROR_INVALIDDATA;
    }

92
    avctx->pix_fmt = AV_PIX_FMT_PAL8;
Paul B Mahol's avatar
Paul B Mahol committed
93

94 95 96 97
    c->pic = av_frame_alloc();
    if (!c->pic)
        return AVERROR(ENOMEM);

Paul B Mahol's avatar
Paul B Mahol committed
98 99
    c->frame_size = avctx->width * FFALIGN(avctx->height, 256);
    c->video_size = avctx->width * avctx->height;
Paul B Mahol's avatar
Paul B Mahol committed
100 101
    for (i = 0; i < 4; i++) {
        c->frame[i] = av_mallocz(c->frame_size);
102
        if (!c->frame[i]) {
Paul B Mahol's avatar
Paul B Mahol committed
103
            paf_video_close(avctx);
Paul B Mahol's avatar
Paul B Mahol committed
104
            return AVERROR(ENOMEM);
105
        }
Paul B Mahol's avatar
Paul B Mahol committed
106 107 108 109 110
    }

    return 0;
}

Paul B Mahol's avatar
Paul B Mahol committed
111
static void read4x4block(PAFVideoDecContext *c, uint8_t *dst, int width)
Paul B Mahol's avatar
Paul B Mahol committed
112 113 114 115 116
{
    int i;

    for (i = 0; i < 4; i++) {
        bytestream2_get_buffer(&c->gb, dst, 4);
Paul B Mahol's avatar
Paul B Mahol committed
117
        dst += width;
Paul B Mahol's avatar
Paul B Mahol committed
118 119 120
    }
}

Paul B Mahol's avatar
Paul B Mahol committed
121
static void copy_color_mask(uint8_t *dst, int width, uint8_t mask, uint8_t color)
Paul B Mahol's avatar
Paul B Mahol committed
122 123 124 125
{
    int i;

    for (i = 0; i < 4; i++) {
Paul B Mahol's avatar
Paul B Mahol committed
126
        if (mask & (1 << 7 - i))
Paul B Mahol's avatar
Paul B Mahol committed
127
            dst[i] = color;
Paul B Mahol's avatar
Paul B Mahol committed
128 129
        if (mask & (1 << 3 - i))
            dst[width + i] = color;
Paul B Mahol's avatar
Paul B Mahol committed
130 131 132
    }
}

Paul B Mahol's avatar
Paul B Mahol committed
133
static void copy_src_mask(uint8_t *dst, int width, uint8_t mask, const uint8_t *src)
Paul B Mahol's avatar
Paul B Mahol committed
134 135 136 137
{
    int i;

    for (i = 0; i < 4; i++) {
Paul B Mahol's avatar
Paul B Mahol committed
138
        if (mask & (1 << 7 - i))
Paul B Mahol's avatar
Paul B Mahol committed
139
            dst[i] = src[i];
Paul B Mahol's avatar
Paul B Mahol committed
140 141
        if (mask & (1 << 3 - i))
            dst[width + i] = src[width + i];
Paul B Mahol's avatar
Paul B Mahol committed
142 143 144
    }
}

Paul B Mahol's avatar
Paul B Mahol committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158
static void set_src_position(PAFVideoDecContext *c,
                             const uint8_t **p,
                             const uint8_t **pend)
{
    int val  = bytestream2_get_be16(&c->gb);
    int page = val >> 14;
    int x    = (val & 0x7F);
    int y    = ((val >> 7) & 0x7F);

    *p    = c->frame[page] + x * 2 + y * 2 * c->width;
    *pend = c->frame[page] + c->frame_size;
}

static int decode_0(PAFVideoDecContext *c, uint8_t *pkt, uint8_t code)
Paul B Mahol's avatar
Paul B Mahol committed
159 160
{
    uint32_t opcode_size, offset;
Paul B Mahol's avatar
Paul B Mahol committed
161
    uint8_t *dst, *dend, mask = 0, color = 0;
Paul B Mahol's avatar
Paul B Mahol committed
162
    const uint8_t *src, *send, *opcodes;
Paul B Mahol's avatar
Paul B Mahol committed
163
    int i, j, op = 0;
Paul B Mahol's avatar
Paul B Mahol committed
164 165 166 167 168 169 170 171 172 173 174

    i = bytestream2_get_byte(&c->gb);
    if (i) {
        if (code & 0x10) {
            int align;

            align = bytestream2_tell(&c->gb) & 3;
            if (align)
                bytestream2_skip(&c->gb, 4 - align);
        }
        do {
Paul B Mahol's avatar
Paul B Mahol committed
175 176 177 178 179 180 181 182
            int page, val, x, y;
            val    = bytestream2_get_be16(&c->gb);
            page   = val >> 14;
            x      = (val & 0x7F) * 2;
            y      = ((val >> 7) & 0x7F) * 2;
            dst    = c->frame[page] + x + y * c->width;
            dend   = c->frame[page] + c->frame_size;
            offset = (x & 0x7F) * 2;
Paul B Mahol's avatar
Paul B Mahol committed
183 184 185
            j      = bytestream2_get_le16(&c->gb) + offset;
            do {
                offset++;
Paul B Mahol's avatar
Paul B Mahol committed
186
                if (dst + 3 * c->width + 4 > dend)
Paul B Mahol's avatar
Paul B Mahol committed
187
                    return AVERROR_INVALIDDATA;
Paul B Mahol's avatar
Paul B Mahol committed
188
                read4x4block(c, dst, c->width);
Paul B Mahol's avatar
Paul B Mahol committed
189
                if ((offset & 0x3F) == 0)
Paul B Mahol's avatar
Paul B Mahol committed
190
                    dst += c->width * 3;
Paul B Mahol's avatar
Paul B Mahol committed
191 192 193 194 195
                dst += 4;
            } while (offset < j);
        } while (--i);
    }

196 197
    dst  = c->frame[c->current_frame];
    dend = c->frame[c->current_frame] + c->frame_size;
Paul B Mahol's avatar
Paul B Mahol committed
198
    do {
Paul B Mahol's avatar
Paul B Mahol committed
199 200 201
        set_src_position(c, &src, &send);
        if ((src + 3 * c->width + 4 > send) ||
            (dst + 3 * c->width + 4 > dend))
Paul B Mahol's avatar
Paul B Mahol committed
202
            return AVERROR_INVALIDDATA;
Paul B Mahol's avatar
Paul B Mahol committed
203
        copy_block4(dst, src, c->width, c->width, 4);
Paul B Mahol's avatar
Paul B Mahol committed
204 205
        i++;
        if ((i & 0x3F) == 0)
Paul B Mahol's avatar
Paul B Mahol committed
206
            dst += c->width * 3;
Paul B Mahol's avatar
Paul B Mahol committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220
        dst += 4;
    } while (i < c->video_size / 16);

    opcode_size = bytestream2_get_le16(&c->gb);
    bytestream2_skip(&c->gb, 2);

    if (bytestream2_get_bytes_left(&c->gb) < opcode_size)
        return AVERROR_INVALIDDATA;

    opcodes = pkt + bytestream2_tell(&c->gb);
    bytestream2_skipu(&c->gb, opcode_size);

    dst = c->frame[c->current_frame];

Paul B Mahol's avatar
Paul B Mahol committed
221 222
    for (i = 0; i < c->height; i += 4, dst += c->width * 3)
        for (j = 0; j < c->width; j += 4, dst += 4) {
Paul B Mahol's avatar
Paul B Mahol committed
223
            int opcode, k = 0;
Paul B Mahol's avatar
Paul B Mahol committed
224
            if (op > opcode_size)
Paul B Mahol's avatar
Paul B Mahol committed
225 226
                return AVERROR_INVALIDDATA;
            if (j & 4) {
Paul B Mahol's avatar
Paul B Mahol committed
227 228
                opcode = opcodes[op] & 15;
                op++;
Paul B Mahol's avatar
Paul B Mahol committed
229
            } else {
Paul B Mahol's avatar
Paul B Mahol committed
230
                opcode = opcodes[op] >> 4;
Paul B Mahol's avatar
Paul B Mahol committed
231 232 233
            }

            while (block_sequences[opcode][k]) {
Paul B Mahol's avatar
Paul B Mahol committed
234
                offset = c->width * 2;
Paul B Mahol's avatar
Paul B Mahol committed
235 236 237 238 239 240
                code   = block_sequences[opcode][k++];

                switch (code) {
                case 2:
                    offset = 0;
                case 3:
Paul B Mahol's avatar
Paul B Mahol committed
241
                    color = bytestream2_get_byte(&c->gb);
Paul B Mahol's avatar
Paul B Mahol committed
242
                case 4:
Paul B Mahol's avatar
Paul B Mahol committed
243 244
                    mask = bytestream2_get_byte(&c->gb);
                    copy_color_mask(dst + offset, c->width, mask, color);
Paul B Mahol's avatar
Paul B Mahol committed
245 246 247 248
                    break;
                case 5:
                    offset = 0;
                case 6:
Paul B Mahol's avatar
Paul B Mahol committed
249
                    set_src_position(c, &src, &send);
Paul B Mahol's avatar
Paul B Mahol committed
250
                case 7:
Paul B Mahol's avatar
Paul B Mahol committed
251
                    if (src + offset + c->width + 4 > send)
Paul B Mahol's avatar
Paul B Mahol committed
252 253
                        return AVERROR_INVALIDDATA;
                    mask = bytestream2_get_byte(&c->gb);
Paul B Mahol's avatar
Paul B Mahol committed
254
                    copy_src_mask(dst + offset, c->width, mask, src + offset);
Paul B Mahol's avatar
Paul B Mahol committed
255 256 257 258 259 260 261 262
                    break;
                }
            }
        }

    return 0;
}

Paul B Mahol's avatar
Paul B Mahol committed
263 264
static int paf_video_decode(AVCodecContext *avctx, void *data,
                            int *got_frame, AVPacket *pkt)
Paul B Mahol's avatar
Paul B Mahol committed
265 266
{
    PAFVideoDecContext *c = avctx->priv_data;
Paul B Mahol's avatar
Paul B Mahol committed
267
    uint8_t code, *dst, *end;
Paul B Mahol's avatar
Paul B Mahol committed
268 269
    int i, frame, ret;

270
    if ((ret = ff_reget_buffer(avctx, c->pic)) < 0)
Paul B Mahol's avatar
Paul B Mahol committed
271 272 273 274 275
        return ret;

    bytestream2_init(&c->gb, pkt->data, pkt->size);

    code = bytestream2_get_byte(&c->gb);
Paul B Mahol's avatar
Paul B Mahol committed
276
    if (code & 0x20) {  // frame is keyframe
Paul B Mahol's avatar
Paul B Mahol committed
277 278 279
        for (i = 0; i < 4; i++)
            memset(c->frame[i], 0, c->frame_size);

280
        memset(c->pic->data[1], 0, AVPALETTE_SIZE);
Paul B Mahol's avatar
Paul B Mahol committed
281
        c->current_frame  = 0;
282 283
        c->pic->key_frame = 1;
        c->pic->pict_type = AV_PICTURE_TYPE_I;
Paul B Mahol's avatar
Paul B Mahol committed
284
    } else {
285 286
        c->pic->key_frame = 0;
        c->pic->pict_type = AV_PICTURE_TYPE_P;
Paul B Mahol's avatar
Paul B Mahol committed
287 288
    }

Paul B Mahol's avatar
Paul B Mahol committed
289
    if (code & 0x40) {  // palette update
290
        uint32_t *out = (uint32_t *)c->pic->data[1];
Paul B Mahol's avatar
Paul B Mahol committed
291 292 293 294 295
        int index, count;

        index = bytestream2_get_byte(&c->gb);
        count = bytestream2_get_byte(&c->gb) + 1;

296
        if (index + count > 256)
Paul B Mahol's avatar
Paul B Mahol committed
297
            return AVERROR_INVALIDDATA;
Paul B Mahol's avatar
Paul B Mahol committed
298
        if (bytestream2_get_bytes_left(&c->gb) < 3 * count)
Paul B Mahol's avatar
Paul B Mahol committed
299 300 301 302 303 304 305 306 307 308 309 310
            return AVERROR_INVALIDDATA;

        out += index;
        for (i = 0; i < count; i++) {
            unsigned r, g, b;

            r = bytestream2_get_byteu(&c->gb);
            r = r << 2 | r >> 4;
            g = bytestream2_get_byteu(&c->gb);
            g = g << 2 | g >> 4;
            b = bytestream2_get_byteu(&c->gb);
            b = b << 2 | b >> 4;
Paul B Mahol's avatar
Paul B Mahol committed
311
            *out++ = (0xFFU << 24) | (r << 16) | (g << 8) | b;
Paul B Mahol's avatar
Paul B Mahol committed
312
        }
313
        c->pic->palette_has_changed = 1;
Paul B Mahol's avatar
Paul B Mahol committed
314 315 316 317
    }

    switch (code & 0x0F) {
    case 0:
Paul B Mahol's avatar
Paul B Mahol committed
318 319 320
        /* Block-based motion compensation using 4x4 blocks with either
         * horizontal or vertical vectors; might incorporate VQ as well. */
        if ((ret = decode_0(c, pkt->data, code)) < 0)
Paul B Mahol's avatar
Paul B Mahol committed
321 322 323
            return ret;
        break;
    case 1:
Paul B Mahol's avatar
Paul B Mahol committed
324 325
        /* Uncompressed data. This mode specifies that (width * height) bytes
         * should be copied directly from the encoded buffer into the output. */
Paul B Mahol's avatar
Paul B Mahol committed
326
        dst = c->frame[c->current_frame];
Paul B Mahol's avatar
Paul B Mahol committed
327
        // possibly chunk length data
Paul B Mahol's avatar
Paul B Mahol committed
328 329 330 331 332 333
        bytestream2_skip(&c->gb, 2);
        if (bytestream2_get_bytes_left(&c->gb) < c->video_size)
            return AVERROR_INVALIDDATA;
        bytestream2_get_bufferu(&c->gb, dst, c->video_size);
        break;
    case 2:
Paul B Mahol's avatar
Paul B Mahol committed
334 335 336
        /* Copy reference frame: Consume the next byte in the stream as the
         * reference frame (which should be 0, 1, 2, or 3, and should not be
         * the same as the current frame number). */
Paul B Mahol's avatar
Paul B Mahol committed
337 338 339 340 341 342 343
        frame = bytestream2_get_byte(&c->gb);
        if (frame > 3)
            return AVERROR_INVALIDDATA;
        if (frame != c->current_frame)
            memcpy(c->frame[c->current_frame], c->frame[frame], c->frame_size);
        break;
    case 4:
Paul B Mahol's avatar
Paul B Mahol committed
344
        /* Run length encoding.*/
Paul B Mahol's avatar
Paul B Mahol committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
        dst = c->frame[c->current_frame];
        end = dst + c->video_size;

        bytestream2_skip(&c->gb, 2);

        while (dst < end) {
            int8_t code;
            int count;

            if (bytestream2_get_bytes_left(&c->gb) < 2)
                return AVERROR_INVALIDDATA;

            code  = bytestream2_get_byteu(&c->gb);
            count = FFABS(code) + 1;

            if (dst + count > end)
                return AVERROR_INVALIDDATA;
            if (code < 0)
                memset(dst, bytestream2_get_byteu(&c->gb), count);
            else
                bytestream2_get_buffer(&c->gb, dst, count);
            dst += count;
        }
        break;
    default:
370
        avpriv_request_sample(avctx, "unknown/invalid code");
Paul B Mahol's avatar
Paul B Mahol committed
371 372 373
        return AVERROR_INVALIDDATA;
    }

Paul B Mahol's avatar
Paul B Mahol committed
374 375 376
    av_image_copy_plane(c->pic->data[0], c->pic->linesize[0],
                        c->frame[c->current_frame], c->width,
                        c->width, c->height);
Paul B Mahol's avatar
Paul B Mahol committed
377 378

    c->current_frame = (c->current_frame + 1) & 3;
379
    if ((ret = av_frame_ref(data, c->pic)) < 0)
380
        return ret;
Paul B Mahol's avatar
Paul B Mahol committed
381

Paul B Mahol's avatar
Paul B Mahol committed
382
    *got_frame = 1;
Paul B Mahol's avatar
Paul B Mahol committed
383 384 385 386 387 388

    return pkt->size;
}

AVCodec ff_paf_video_decoder = {
    .name           = "paf_video",
389
    .long_name      = NULL_IF_CONFIG_SMALL("Amazing Studio Packed Animation File Video"),
Paul B Mahol's avatar
Paul B Mahol committed
390
    .type           = AVMEDIA_TYPE_VIDEO,
391
    .id             = AV_CODEC_ID_PAF_VIDEO,
Paul B Mahol's avatar
Paul B Mahol committed
392
    .priv_data_size = sizeof(PAFVideoDecContext),
Paul B Mahol's avatar
Paul B Mahol committed
393 394 395
    .init           = paf_video_init,
    .close          = paf_video_close,
    .decode         = paf_video_decode,
396
    .capabilities   = CODEC_CAP_DR1,
Paul B Mahol's avatar
Paul B Mahol committed
397
};