qtrle.c 16.6 KB
Newer Older
1 2 3 4
/*
 * Quicktime Animation (RLE) Video Decoder
 * Copyright (C) 2004 the ffmpeg project
 *
5
 * This file is part of Libav.
6
 *
7
 * Libav 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
 * Libav 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 Libav; 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 25 26 27 28 29
 * QT RLE Video Decoder by Mike Melanson (melanson@pcisys.net)
 * For more information about the QT RLE format, visit:
 *   http://www.pcisys.net/~melanson/codecs/
 *
 * The QT RLE decoder has seven modes of operation:
 * 1, 2, 4, 8, 16, 24, and 32 bits per pixel. For modes 1, 2, 4, and 8
30
 * the decoder outputs PAL8 colorspace data. 16-bit data yields RGB555
31
 * data. 24-bit data is RGB24 and 32-bit data is RGB32.
32 33 34 35 36 37 38
 */

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

#include "avcodec.h"
39
#include "bytestream.h"
40 41 42 43 44

typedef struct QtrleContext {
    AVCodecContext *avctx;
    AVFrame frame;

45
    GetByteContext g;
46
    uint32_t pal[256];
47 48
} QtrleContext;

49 50
#define CHECK_PIXEL_PTR(n)                                                            \
    if ((pixel_ptr + n > pixel_limit) || (pixel_ptr + n < 0)) {                       \
51
        av_log (s->avctx, AV_LOG_ERROR, "Problem: pixel_ptr = %d, pixel_limit = %d\n",\
52 53 54
                pixel_ptr + n, pixel_limit);                                          \
        return;                                                                       \
    }                                                                                 \
55

56
static void qtrle_decode_1bpp(QtrleContext *s, int row_ptr, int lines_to_change)
57
{
58
    int rle_code;
59
    int pixel_ptr;
60 61 62 63 64
    int row_inc = s->frame.linesize[0];
    unsigned char pi0, pi1;  /* 2 8-pixel values */
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;
    int skip;
65

66 67 68
    row_ptr  -= row_inc;
    pixel_ptr = row_ptr;
    lines_to_change++;
69
    while (lines_to_change) {
70 71
        skip     =              bytestream2_get_byte(&s->g);
        rle_code = (signed char)bytestream2_get_byte(&s->g);
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
        if (rle_code == 0)
            break;
        if(skip & 0x80) {
            lines_to_change--;
            row_ptr += row_inc;
            pixel_ptr = row_ptr + 2 * (skip & 0x7f);
        } else
            pixel_ptr += 2 * skip;
        CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */

        if (rle_code < 0) {
            /* decode the run length code */
            rle_code = -rle_code;
            /* get the next 2 bytes from the stream, treat them as groups
             * of 8 pixels, and output them rle_code times */
87 88 89

            pi0 = bytestream2_get_byte(&s->g);
            pi1 = bytestream2_get_byte(&s->g);
90 91 92 93 94 95 96 97 98 99 100 101
            CHECK_PIXEL_PTR(rle_code * 2);

            while (rle_code--) {
                rgb[pixel_ptr++] = pi0;
                rgb[pixel_ptr++] = pi1;
            }
        } else {
            /* copy the same pixel directly to output 2 times */
            rle_code *= 2;
            CHECK_PIXEL_PTR(rle_code);

            while (rle_code--)
102
                rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
103 104
        }
    }
105 106
}

107 108
static inline void qtrle_decode_2n4bpp(QtrleContext *s, int row_ptr,
                                       int lines_to_change, int bpp)
109
{
110
    int rle_code, i;
111
    int pixel_ptr;
112
    int row_inc = s->frame.linesize[0];
113
    unsigned char pi[16];  /* 16 palette indices */
114 115
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;
116
    int num_pixels = (bpp == 4) ? 8 : 16;
117 118

    while (lines_to_change--) {
119
        pixel_ptr = row_ptr + (num_pixels * (bytestream2_get_byte(&s->g) - 1));
120
        CHECK_PIXEL_PTR(0);
121

122
        while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
123 124
            if (rle_code == 0) {
                /* there's another skip code in the stream */
125
                pixel_ptr += (num_pixels * (bytestream2_get_byte(&s->g) - 1));
126
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
127 128 129 130
            } else if (rle_code < 0) {
                /* decode the run length code */
                rle_code = -rle_code;
                /* get the next 4 bytes from the stream, treat them as palette
131
                 * indexes, and output them rle_code times */
132
                for (i = num_pixels-1; i >= 0; i--) {
133 134
                    pi[num_pixels-1-i] = (bytestream2_peek_byte(&s->g) >> ((i*bpp) & 0x07)) & ((1<<bpp)-1);
                    bytestream2_skip(&s->g, ((i & ((num_pixels>>2)-1)) == 0));
135 136
                }
                CHECK_PIXEL_PTR(rle_code * num_pixels);
137
                while (rle_code--) {
138 139
                    for (i = 0; i < num_pixels; i++)
                        rgb[pixel_ptr++] = pi[i];
140 141 142 143
                }
            } else {
                /* copy the same pixel directly to output 4 times */
                rle_code *= 4;
144
                CHECK_PIXEL_PTR(rle_code*(num_pixels>>2));
145
                while (rle_code--) {
146
                    if(bpp == 4) {
147 148 149
                        int x = bytestream2_get_byte(&s->g);
                        rgb[pixel_ptr++] = (x >> 4) & 0x0f;
                        rgb[pixel_ptr++] =  x       & 0x0f;
150
                    } else {
151 152 153 154 155
                        int x = bytestream2_get_byte(&s->g);
                        rgb[pixel_ptr++] = (x >> 6) & 0x03;
                        rgb[pixel_ptr++] = (x >> 4) & 0x03;
                        rgb[pixel_ptr++] = (x >> 2) & 0x03;
                        rgb[pixel_ptr++] =  x       & 0x03;
156
                    }
157 158 159 160 161
                }
            }
        }
        row_ptr += row_inc;
    }
162 163
}

164
static void qtrle_decode_8bpp(QtrleContext *s, int row_ptr, int lines_to_change)
165
{
166
    int rle_code;
167
    int pixel_ptr;
168
    int row_inc = s->frame.linesize[0];
169
    unsigned char pi1, pi2, pi3, pi4;  /* 4 palette indexes */
170 171 172 173
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;

    while (lines_to_change--) {
174
        pixel_ptr = row_ptr + (4 * (bytestream2_get_byte(&s->g) - 1));
175
        CHECK_PIXEL_PTR(0);
176

177
        while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
178 179
            if (rle_code == 0) {
                /* there's another skip code in the stream */
180
                pixel_ptr += (4 * (bytestream2_get_byte(&s->g) - 1));
181
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
182 183 184 185
            } else if (rle_code < 0) {
                /* decode the run length code */
                rle_code = -rle_code;
                /* get the next 4 bytes from the stream, treat them as palette
186
                 * indexes, and output them rle_code times */
187 188 189 190
                pi1 = bytestream2_get_byte(&s->g);
                pi2 = bytestream2_get_byte(&s->g);
                pi3 = bytestream2_get_byte(&s->g);
                pi4 = bytestream2_get_byte(&s->g);
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

                CHECK_PIXEL_PTR(rle_code * 4);

                while (rle_code--) {
                    rgb[pixel_ptr++] = pi1;
                    rgb[pixel_ptr++] = pi2;
                    rgb[pixel_ptr++] = pi3;
                    rgb[pixel_ptr++] = pi4;
                }
            } else {
                /* copy the same pixel directly to output 4 times */
                rle_code *= 4;
                CHECK_PIXEL_PTR(rle_code);

                while (rle_code--) {
206
                    rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
207 208 209 210 211 212 213
                }
            }
        }
        row_ptr += row_inc;
    }
}

214
static void qtrle_decode_16bpp(QtrleContext *s, int row_ptr, int lines_to_change)
215
{
216
    int rle_code;
217
    int pixel_ptr;
218 219 220 221 222 223
    int row_inc = s->frame.linesize[0];
    unsigned short rgb16;
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;

    while (lines_to_change--) {
224
        pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 2;
225
        CHECK_PIXEL_PTR(0);
226

227
        while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
228 229
            if (rle_code == 0) {
                /* there's another skip code in the stream */
230
                pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 2;
231
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
232 233 234
            } else if (rle_code < 0) {
                /* decode the run length code */
                rle_code = -rle_code;
235
                rgb16 = bytestream2_get_be16(&s->g);
236 237 238 239 240 241 242 243 244 245 246 247

                CHECK_PIXEL_PTR(rle_code * 2);

                while (rle_code--) {
                    *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
                    pixel_ptr += 2;
                }
            } else {
                CHECK_PIXEL_PTR(rle_code * 2);

                /* copy pixels directly to output */
                while (rle_code--) {
248
                    rgb16 = bytestream2_get_be16(&s->g);
249 250 251 252 253 254 255 256 257
                    *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
                    pixel_ptr += 2;
                }
            }
        }
        row_ptr += row_inc;
    }
}

258
static void qtrle_decode_24bpp(QtrleContext *s, int row_ptr, int lines_to_change)
259
{
260
    int rle_code;
261
    int pixel_ptr;
262 263 264 265 266 267
    int row_inc = s->frame.linesize[0];
    unsigned char r, g, b;
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;

    while (lines_to_change--) {
268
        pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 3;
269
        CHECK_PIXEL_PTR(0);
270

271
        while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
272 273
            if (rle_code == 0) {
                /* there's another skip code in the stream */
274
                pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 3;
275
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
276 277 278
            } else if (rle_code < 0) {
                /* decode the run length code */
                rle_code = -rle_code;
279 280 281
                r = bytestream2_get_byte(&s->g);
                g = bytestream2_get_byte(&s->g);
                b = bytestream2_get_byte(&s->g);
282 283 284 285 286 287 288 289 290 291 292 293 294

                CHECK_PIXEL_PTR(rle_code * 3);

                while (rle_code--) {
                    rgb[pixel_ptr++] = r;
                    rgb[pixel_ptr++] = g;
                    rgb[pixel_ptr++] = b;
                }
            } else {
                CHECK_PIXEL_PTR(rle_code * 3);

                /* copy pixels directly to output */
                while (rle_code--) {
295 296 297
                    rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
                    rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
                    rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
298 299 300 301 302 303 304
                }
            }
        }
        row_ptr += row_inc;
    }
}

305
static void qtrle_decode_32bpp(QtrleContext *s, int row_ptr, int lines_to_change)
306
{
307
    int rle_code;
308
    int pixel_ptr;
309 310 311 312 313 314
    int row_inc = s->frame.linesize[0];
    unsigned int argb;
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;

    while (lines_to_change--) {
315
        pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 4;
316
        CHECK_PIXEL_PTR(0);
317

318
        while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
319 320
            if (rle_code == 0) {
                /* there's another skip code in the stream */
321
                pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 4;
322
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
323 324 325
            } else if (rle_code < 0) {
                /* decode the run length code */
                rle_code = -rle_code;
326
                argb = bytestream2_get_be32(&s->g);
327 328 329 330

                CHECK_PIXEL_PTR(rle_code * 4);

                while (rle_code--) {
331
                    AV_WN32A(rgb + pixel_ptr, argb);
332 333 334 335 336 337 338
                    pixel_ptr += 4;
                }
            } else {
                CHECK_PIXEL_PTR(rle_code * 4);

                /* copy pixels directly to output */
                while (rle_code--) {
339
                    argb = bytestream2_get_be32(&s->g);
340 341
                    AV_WN32A(rgb + pixel_ptr, argb);
                    pixel_ptr  += 4;
342 343 344 345 346 347 348
                }
            }
        }
        row_ptr += row_inc;
    }
}

349
static av_cold int qtrle_decode_init(AVCodecContext *avctx)
350
{
351
    QtrleContext *s = avctx->priv_data;
352 353

    s->avctx = avctx;
354
    switch (avctx->bits_per_coded_sample) {
355
    case 1:
356
    case 33:
357
        avctx->pix_fmt = AV_PIX_FMT_MONOWHITE;
358 359
        break;

360 361 362 363 364 365
    case 2:
    case 4:
    case 8:
    case 34:
    case 36:
    case 40:
366
        avctx->pix_fmt = AV_PIX_FMT_PAL8;
367 368 369
        break;

    case 16:
370
        avctx->pix_fmt = AV_PIX_FMT_RGB555;
371 372 373
        break;

    case 24:
374
        avctx->pix_fmt = AV_PIX_FMT_RGB24;
375 376 377
        break;

    case 32:
378
        avctx->pix_fmt = AV_PIX_FMT_RGB32;
379 380 381
        break;

    default:
Roberto Togni's avatar
Roberto Togni committed
382
        av_log (avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
383
            avctx->bits_per_coded_sample);
384
        return AVERROR_INVALIDDATA;
385 386 387 388 389 390 391 392
    }

    s->frame.data[0] = NULL;

    return 0;
}

static int qtrle_decode_frame(AVCodecContext *avctx,
393
                              void *data, int *got_frame,
394
                              AVPacket *avpkt)
395
{
396
    QtrleContext *s = avctx->priv_data;
397
    int header, start_line;
398
    int height, row_ptr;
399
    int has_palette = 0;
400
    int ret;
401

402
    bytestream2_init(&s->g, avpkt->data, avpkt->size);
403 404 405
    s->frame.reference = 1;
    s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE |
                            FF_BUFFER_HINTS_REUSABLE | FF_BUFFER_HINTS_READABLE;
406
    if ((ret = avctx->reget_buffer(avctx, &s->frame)) < 0) {
Roberto Togni's avatar
Roberto Togni committed
407
        av_log (s->avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
408
        return ret;
409 410
    }

411
    /* check if this frame is even supposed to change */
412
    if (avpkt->size < 8)
413 414 415
        goto done;

    /* start after the chunk size */
416
    bytestream2_seek(&s->g, 4, SEEK_SET);
417 418

    /* fetch the header */
419
    header = bytestream2_get_be16(&s->g);
420 421 422

    /* if a header is present, fetch additional decoding parameters */
    if (header & 0x0008) {
423
        if (avpkt->size < 14)
424
            goto done;
425 426 427 428
        start_line = bytestream2_get_be16(&s->g);
        bytestream2_skip(&s->g, 2);
        height     = bytestream2_get_be16(&s->g);
        bytestream2_skip(&s->g, 2);
429 430
    } else {
        start_line = 0;
431
        height     = s->avctx->height;
432 433 434
    }
    row_ptr = s->frame.linesize[0] * start_line;

435
    switch (avctx->bits_per_coded_sample) {
436 437
    case 1:
    case 33:
438
        qtrle_decode_1bpp(s, row_ptr, height);
439 440 441 442
        break;

    case 2:
    case 34:
443
        qtrle_decode_2n4bpp(s, row_ptr, height, 2);
444
        has_palette = 1;
445 446 447 448
        break;

    case 4:
    case 36:
449
        qtrle_decode_2n4bpp(s, row_ptr, height, 4);
450
        has_palette = 1;
451 452 453 454
        break;

    case 8:
    case 40:
455
        qtrle_decode_8bpp(s, row_ptr, height);
456
        has_palette = 1;
457 458 459
        break;

    case 16:
460
        qtrle_decode_16bpp(s, row_ptr, height);
461 462 463
        break;

    case 24:
464
        qtrle_decode_24bpp(s, row_ptr, height);
465 466 467
        break;

    case 32:
468
        qtrle_decode_32bpp(s, row_ptr, height);
469 470 471
        break;

    default:
Roberto Togni's avatar
Roberto Togni committed
472
        av_log (s->avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
473
            avctx->bits_per_coded_sample);
474 475
        break;
    }
476 477

    if(has_palette) {
478 479 480
        const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);

        if (pal) {
481
            s->frame.palette_has_changed = 1;
482
            memcpy(s->pal, pal, AVPALETTE_SIZE);
483
        }
484 485 486

        /* make the palette available on the way out */
        memcpy(s->frame.data[1], s->pal, AVPALETTE_SIZE);
487 488
    }

489
done:
490
    *got_frame      = 1;
491 492 493
    *(AVFrame*)data = s->frame;

    /* always report that the buffer was completely consumed */
494
    return avpkt->size;
495 496
}

497
static av_cold int qtrle_decode_end(AVCodecContext *avctx)
498
{
499
    QtrleContext *s = avctx->priv_data;
500 501 502 503 504 505 506

    if (s->frame.data[0])
        avctx->release_buffer(avctx, &s->frame);

    return 0;
}

507
AVCodec ff_qtrle_decoder = {
508 509
    .name           = "qtrle",
    .type           = AVMEDIA_TYPE_VIDEO,
510
    .id             = AV_CODEC_ID_QTRLE,
511 512 513 514 515
    .priv_data_size = sizeof(QtrleContext),
    .init           = qtrle_decode_init,
    .close          = qtrle_decode_end,
    .decode         = qtrle_decode_frame,
    .capabilities   = CODEC_CAP_DR1,
516
    .long_name      = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),
517
};