kmvc.c 15.1 KB
Newer Older
1 2 3 4
/*
 * KMVC decoder
 * Copyright (c) 2006 Konstantin Shishkov
 *
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 20 21 22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
23
 * @file
24 25 26 27 28 29 30
 * Karl Morton's Video Codec decoder
 */

#include <stdio.h>
#include <stdlib.h>

#include "avcodec.h"
31
#include "bytestream.h"
32 33 34 35

#define KMVC_KEYFRAME 0x80
#define KMVC_PALETTE  0x40
#define KMVC_METHOD   0x0F
Alex Converse's avatar
Alex Converse committed
36
#define MAX_PALSIZE   256
37 38 39 40 41 42 43 44 45 46

/*
 * Decoder context
 */
typedef struct KmvcContext {
    AVCodecContext *avctx;
    AVFrame pic;

    int setpal;
    int palsize;
Alex Converse's avatar
Alex Converse committed
47
    uint32_t pal[MAX_PALSIZE];
48 49
    uint8_t *cur, *prev;
    uint8_t *frm0, *frm1;
50
    GetByteContext g;
51 52 53 54 55 56 57 58 59
} KmvcContext;

typedef struct BitBuf {
    int bits;
    int bitbuf;
} BitBuf;

#define BLK(data, x, y)  data[(x) + (y) * 320]

60
#define kmvc_init_getbits(bb, g)  bb.bits = 7; bb.bitbuf = bytestream2_get_byte(g);
61

62
#define kmvc_getbit(bb, g, res) {\
63 64 65 66
    res = 0; \
    if (bb.bitbuf & (1 << bb.bits)) res = 1; \
    bb.bits--; \
    if(bb.bits == -1) { \
67
        bb.bitbuf = bytestream2_get_byte(g); \
68 69 70 71
        bb.bits = 7; \
    } \
}

72
static int kmvc_decode_intra_8x8(KmvcContext * ctx, int w, int h)
73 74 75 76 77 78 79 80
{
    BitBuf bb;
    int res, val;
    int i, j;
    int bx, by;
    int l0x, l1x, l0y, l1y;
    int mx, my;

81
    kmvc_init_getbits(bb, &ctx->g);
82 83 84

    for (by = 0; by < h; by += 8)
        for (bx = 0; bx < w; bx += 8) {
85 86 87 88 89
            if (!bytestream2_get_bytes_left(&ctx->g)) {
                av_log(ctx->avctx, AV_LOG_ERROR, "Data overrun\n");
                return AVERROR_INVALIDDATA;
            }
            kmvc_getbit(bb, &ctx->g, res);
90
            if (!res) {         // fill whole 8x8 block
91
                val = bytestream2_get_byte(&ctx->g);
92 93 94 95 96 97
                for (i = 0; i < 64; i++)
                    BLK(ctx->cur, bx + (i & 0x7), by + (i >> 3)) = val;
            } else {            // handle four 4x4 subblocks
                for (i = 0; i < 4; i++) {
                    l0x = bx + (i & 1) * 4;
                    l0y = by + (i & 2) * 2;
98
                    kmvc_getbit(bb, &ctx->g, res);
99
                    if (!res) {
100
                        kmvc_getbit(bb, &ctx->g, res);
101
                        if (!res) {     // fill whole 4x4 block
102
                            val = bytestream2_get_byte(&ctx->g);
103 104 105
                            for (j = 0; j < 16; j++)
                                BLK(ctx->cur, l0x + (j & 3), l0y + (j >> 2)) = val;
                        } else {        // copy block from already decoded place
106
                            val = bytestream2_get_byte(&ctx->g);
107 108 109 110 111 112 113 114 115 116
                            mx = val & 0xF;
                            my = val >> 4;
                            for (j = 0; j < 16; j++)
                                BLK(ctx->cur, l0x + (j & 3), l0y + (j >> 2)) =
                                    BLK(ctx->cur, l0x + (j & 3) - mx, l0y + (j >> 2) - my);
                        }
                    } else {    // descend to 2x2 sub-sub-blocks
                        for (j = 0; j < 4; j++) {
                            l1x = l0x + (j & 1) * 2;
                            l1y = l0y + (j & 2);
117
                            kmvc_getbit(bb, &ctx->g, res);
118
                            if (!res) {
119
                                kmvc_getbit(bb, &ctx->g, res);
120
                                if (!res) {     // fill whole 2x2 block
121
                                    val = bytestream2_get_byte(&ctx->g);
122 123 124 125 126
                                    BLK(ctx->cur, l1x, l1y) = val;
                                    BLK(ctx->cur, l1x + 1, l1y) = val;
                                    BLK(ctx->cur, l1x, l1y + 1) = val;
                                    BLK(ctx->cur, l1x + 1, l1y + 1) = val;
                                } else {        // copy block from already decoded place
127
                                    val = bytestream2_get_byte(&ctx->g);
128 129 130 131 132 133 134 135 136 137 138
                                    mx = val & 0xF;
                                    my = val >> 4;
                                    BLK(ctx->cur, l1x, l1y) = BLK(ctx->cur, l1x - mx, l1y - my);
                                    BLK(ctx->cur, l1x + 1, l1y) =
                                        BLK(ctx->cur, l1x + 1 - mx, l1y - my);
                                    BLK(ctx->cur, l1x, l1y + 1) =
                                        BLK(ctx->cur, l1x - mx, l1y + 1 - my);
                                    BLK(ctx->cur, l1x + 1, l1y + 1) =
                                        BLK(ctx->cur, l1x + 1 - mx, l1y + 1 - my);
                                }
                            } else {    // read values for block
139 140 141 142
                                BLK(ctx->cur, l1x, l1y) = bytestream2_get_byte(&ctx->g);
                                BLK(ctx->cur, l1x + 1, l1y) = bytestream2_get_byte(&ctx->g);
                                BLK(ctx->cur, l1x, l1y + 1) = bytestream2_get_byte(&ctx->g);
                                BLK(ctx->cur, l1x + 1, l1y + 1) = bytestream2_get_byte(&ctx->g);
143 144 145 146 147 148
                            }
                        }
                    }
                }
            }
        }
Gaurav Narula's avatar
Gaurav Narula committed
149 150

    return 0;
151 152
}

153
static int kmvc_decode_inter_8x8(KmvcContext * ctx, int w, int h)
154 155 156 157 158 159 160 161
{
    BitBuf bb;
    int res, val;
    int i, j;
    int bx, by;
    int l0x, l1x, l0y, l1y;
    int mx, my;

162
    kmvc_init_getbits(bb, &ctx->g);
163 164 165

    for (by = 0; by < h; by += 8)
        for (bx = 0; bx < w; bx += 8) {
166
            kmvc_getbit(bb, &ctx->g, res);
167
            if (!res) {
168
                kmvc_getbit(bb, &ctx->g, res);
169
                if (!res) {     // fill whole 8x8 block
170
                    if (!bytestream2_get_bytes_left(&ctx->g)) {
Gaurav Narula's avatar
Gaurav Narula committed
171 172 173
                        av_log(ctx->avctx, AV_LOG_ERROR, "Data overrun\n");
                        return AVERROR_INVALIDDATA;
                    }
174
                    val = bytestream2_get_byte(&ctx->g);
175 176 177 178 179 180 181 182
                    for (i = 0; i < 64; i++)
                        BLK(ctx->cur, bx + (i & 0x7), by + (i >> 3)) = val;
                } else {        // copy block from previous frame
                    for (i = 0; i < 64; i++)
                        BLK(ctx->cur, bx + (i & 0x7), by + (i >> 3)) =
                            BLK(ctx->prev, bx + (i & 0x7), by + (i >> 3));
                }
            } else {            // handle four 4x4 subblocks
183 184 185 186
                if (!bytestream2_get_bytes_left(&ctx->g)) {
                    av_log(ctx->avctx, AV_LOG_ERROR, "Data overrun\n");
                    return AVERROR_INVALIDDATA;
                }
187 188 189
                for (i = 0; i < 4; i++) {
                    l0x = bx + (i & 1) * 4;
                    l0y = by + (i & 2) * 2;
190
                    kmvc_getbit(bb, &ctx->g, res);
191
                    if (!res) {
192
                        kmvc_getbit(bb, &ctx->g, res);
193
                        if (!res) {     // fill whole 4x4 block
194
                            val = bytestream2_get_byte(&ctx->g);
195 196 197
                            for (j = 0; j < 16; j++)
                                BLK(ctx->cur, l0x + (j & 3), l0y + (j >> 2)) = val;
                        } else {        // copy block
198
                            val = bytestream2_get_byte(&ctx->g);
199 200 201 202 203 204 205 206 207 208
                            mx = (val & 0xF) - 8;
                            my = (val >> 4) - 8;
                            for (j = 0; j < 16; j++)
                                BLK(ctx->cur, l0x + (j & 3), l0y + (j >> 2)) =
                                    BLK(ctx->prev, l0x + (j & 3) + mx, l0y + (j >> 2) + my);
                        }
                    } else {    // descend to 2x2 sub-sub-blocks
                        for (j = 0; j < 4; j++) {
                            l1x = l0x + (j & 1) * 2;
                            l1y = l0y + (j & 2);
209
                            kmvc_getbit(bb, &ctx->g, res);
210
                            if (!res) {
211
                                kmvc_getbit(bb, &ctx->g, res);
212
                                if (!res) {     // fill whole 2x2 block
213
                                    val = bytestream2_get_byte(&ctx->g);
214 215 216 217 218
                                    BLK(ctx->cur, l1x, l1y) = val;
                                    BLK(ctx->cur, l1x + 1, l1y) = val;
                                    BLK(ctx->cur, l1x, l1y + 1) = val;
                                    BLK(ctx->cur, l1x + 1, l1y + 1) = val;
                                } else {        // copy block
219
                                    val = bytestream2_get_byte(&ctx->g);
220 221 222 223 224 225 226 227 228 229 230
                                    mx = (val & 0xF) - 8;
                                    my = (val >> 4) - 8;
                                    BLK(ctx->cur, l1x, l1y) = BLK(ctx->prev, l1x + mx, l1y + my);
                                    BLK(ctx->cur, l1x + 1, l1y) =
                                        BLK(ctx->prev, l1x + 1 + mx, l1y + my);
                                    BLK(ctx->cur, l1x, l1y + 1) =
                                        BLK(ctx->prev, l1x + mx, l1y + 1 + my);
                                    BLK(ctx->cur, l1x + 1, l1y + 1) =
                                        BLK(ctx->prev, l1x + 1 + mx, l1y + 1 + my);
                                }
                            } else {    // read values for block
231 232 233 234
                                BLK(ctx->cur, l1x, l1y) = bytestream2_get_byte(&ctx->g);
                                BLK(ctx->cur, l1x + 1, l1y) = bytestream2_get_byte(&ctx->g);
                                BLK(ctx->cur, l1x, l1y + 1) = bytestream2_get_byte(&ctx->g);
                                BLK(ctx->cur, l1x + 1, l1y + 1) = bytestream2_get_byte(&ctx->g);
235 236 237 238 239 240
                            }
                        }
                    }
                }
            }
        }
Gaurav Narula's avatar
Gaurav Narula committed
241 242

    return 0;
243 244
}

245
static int decode_frame(AVCodecContext * avctx, void *data, int *data_size, AVPacket *avpkt)
246
{
247
    KmvcContext *const ctx = avctx->priv_data;
248 249 250 251
    uint8_t *out, *src;
    int i;
    int header;
    int blocksize;
252
    const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
253

254
    bytestream2_init(&ctx->g, avpkt->data, avpkt->size);
255 256 257
    if (ctx->pic.data[0])
        avctx->release_buffer(avctx, &ctx->pic);

258
    ctx->pic.reference = 3;
259 260 261 262 263 264
    ctx->pic.buffer_hints = FF_BUFFER_HINTS_VALID;
    if (avctx->get_buffer(avctx, &ctx->pic) < 0) {
        av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
        return -1;
    }

265
    header = bytestream2_get_byte(&ctx->g);
266 267

    /* blocksize 127 is really palette change event */
268 269
    if (bytestream2_peek_byte(&ctx->g) == 127) {
        bytestream2_skip(&ctx->g, 3);
270
        for (i = 0; i < 127; i++) {
271
            ctx->pal[i + (header & 0x81)] = 0xFFU << 24 | bytestream2_get_be24(&ctx->g);
272
            bytestream2_skip(&ctx->g, 1);
273
        }
274
        bytestream2_seek(&ctx->g, -127 * 4 - 3, SEEK_CUR);
275
    }
276 277 278

    if (header & KMVC_KEYFRAME) {
        ctx->pic.key_frame = 1;
279
        ctx->pic.pict_type = AV_PICTURE_TYPE_I;
280 281
    } else {
        ctx->pic.key_frame = 0;
282
        ctx->pic.pict_type = AV_PICTURE_TYPE_P;
283 284 285 286 287 288
    }

    if (header & KMVC_PALETTE) {
        ctx->pic.palette_has_changed = 1;
        // palette starts from index 1 and has 127 entries
        for (i = 1; i <= ctx->palsize; i++) {
289
            ctx->pal[i] = 0xFFU << 24 | bytestream2_get_be24(&ctx->g);
290 291 292
        }
    }

293 294 295 296 297
    if (pal) {
        ctx->pic.palette_has_changed = 1;
        memcpy(ctx->pal, pal, AVPALETTE_SIZE);
    }

298 299 300 301 302 303 304 305
    if (ctx->setpal) {
        ctx->setpal = 0;
        ctx->pic.palette_has_changed = 1;
    }

    /* make the palette available on the way out */
    memcpy(ctx->pic.data[1], ctx->pal, 1024);

306
    blocksize = bytestream2_get_byte(&ctx->g);
307

308
    if (blocksize != 8 && blocksize != 127) {
309 310 311 312 313
        av_log(avctx, AV_LOG_ERROR, "Block size = %i\n", blocksize);
        return -1;
    }
    memset(ctx->cur, 0, 320 * 200);
    switch (header & KMVC_METHOD) {
314 315 316 317
    case 0:
    case 1: // used in palette changed event
        memcpy(ctx->cur, ctx->prev, 320 * 200);
        break;
318
    case 3:
319
        kmvc_decode_intra_8x8(ctx, avctx->width, avctx->height);
320 321
        break;
    case 4:
322
        kmvc_decode_inter_8x8(ctx, avctx->width, avctx->height);
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
        break;
    default:
        av_log(avctx, AV_LOG_ERROR, "Unknown compression method %i\n", header & KMVC_METHOD);
        return -1;
    }

    out = ctx->pic.data[0];
    src = ctx->cur;
    for (i = 0; i < avctx->height; i++) {
        memcpy(out, src, avctx->width);
        src += 320;
        out += ctx->pic.linesize[0];
    }

    /* flip buffers */
    if (ctx->cur == ctx->frm0) {
        ctx->cur = ctx->frm1;
        ctx->prev = ctx->frm0;
    } else {
        ctx->cur = ctx->frm0;
        ctx->prev = ctx->frm1;
    }

    *data_size = sizeof(AVFrame);
    *(AVFrame *) data = ctx->pic;

    /* always report that the buffer was completely consumed */
350
    return avpkt->size;
351 352 353 354 355 356 357
}



/*
 * Init kmvc decoder
 */
358
static av_cold int decode_init(AVCodecContext * avctx)
359
{
360
    KmvcContext *const c = avctx->priv_data;
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
    int i;

    c->avctx = avctx;

    if (avctx->width > 320 || avctx->height > 200) {
        av_log(avctx, AV_LOG_ERROR, "KMVC supports frames <= 320x200\n");
        return -1;
    }

    c->frm0 = av_mallocz(320 * 200);
    c->frm1 = av_mallocz(320 * 200);
    c->cur = c->frm0;
    c->prev = c->frm1;

    for (i = 0; i < 256; i++) {
376
        c->pal[i] = 0xFF << 24 | i * 0x10101;
377 378 379
    }

    if (avctx->extradata_size < 12) {
380 381
        av_log(avctx, AV_LOG_WARNING,
               "Extradata missing, decoding may not work properly...\n");
382 383
        c->palsize = 127;
    } else {
384
        c->palsize = AV_RL16(avctx->extradata + 10);
385
        if (c->palsize >= (unsigned)MAX_PALSIZE) {
386
            c->palsize = 127;
Alex Converse's avatar
Alex Converse committed
387 388
            av_log(avctx, AV_LOG_ERROR, "KMVC palette too large\n");
            return AVERROR_INVALIDDATA;
389
        }
390 391 392 393
    }

    if (avctx->extradata_size == 1036) {        // palette in extradata
        uint8_t *src = avctx->extradata + 12;
394
        for (i = 0; i < 256; i++) {
395
            c->pal[i] = AV_RL32(src);
396 397 398 399 400
            src += 4;
        }
        c->setpal = 1;
    }

401
    avcodec_get_frame_defaults(&c->pic);
402 403 404 405 406 407 408 409 410 411
    avctx->pix_fmt = PIX_FMT_PAL8;

    return 0;
}



/*
 * Uninit kmvc decoder
 */
412
static av_cold int decode_end(AVCodecContext * avctx)
413
{
414
    KmvcContext *const c = avctx->priv_data;
415

416 417
    av_freep(&c->frm0);
    av_freep(&c->frm1);
418 419 420 421 422 423
    if (c->pic.data[0])
        avctx->release_buffer(avctx, &c->pic);

    return 0;
}

424
AVCodec ff_kmvc_decoder = {
425 426 427 428 429 430 431 432
    .name           = "kmvc",
    .type           = AVMEDIA_TYPE_VIDEO,
    .id             = CODEC_ID_KMVC,
    .priv_data_size = sizeof(KmvcContext),
    .init           = decode_init,
    .close          = decode_end,
    .decode         = decode_frame,
    .capabilities   = CODEC_CAP_DR1,
433
    .long_name = NULL_IF_CONFIG_SMALL("Karl Morton's video codec"),
434
};