qtrle.c 18 KB
Newer Older
1 2 3 4
/*
 * Quicktime Animation (RLE) Video Decoder
 * Copyright (C) 2004 the ffmpeg project
 *
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 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
 */

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

38
#include "libavutil/intreadwrite.h"
39 40 41 42 43 44 45
#include "avcodec.h"

typedef struct QtrleContext {

    AVCodecContext *avctx;
    AVFrame frame;

46
    const unsigned char *buf;
47 48
    int size;

49
    uint32_t pal[256];
50 51 52 53
} QtrleContext;

#define CHECK_STREAM_PTR(n) \
  if ((stream_ptr + n) > s->size) { \
Roberto Togni's avatar
Roberto Togni committed
54
    av_log (s->avctx, AV_LOG_INFO, "Problem: stream_ptr out of bounds (%d >= %d)\n", \
55 56 57 58 59
      stream_ptr + n, s->size); \
    return; \
  }

#define CHECK_PIXEL_PTR(n) \
60 61
  if ((pixel_ptr + n > pixel_limit) || (pixel_ptr + n < 0)) { \
    av_log (s->avctx, AV_LOG_INFO, "Problem: pixel_ptr = %d, pixel_limit = %d\n", \
62 63 64 65
      pixel_ptr + n, pixel_limit); \
    return; \
  } \

66
static void qtrle_decode_1bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
67
{
68 69 70 71 72 73 74
    int rle_code;
    int pixel_ptr = 0;
    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;
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    while (lines_to_change) {
        CHECK_STREAM_PTR(2);
        skip = s->buf[stream_ptr++];
        rle_code = (signed char)s->buf[stream_ptr++];
        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 */
            CHECK_STREAM_PTR(2);
            pi0 = s->buf[stream_ptr++];
            pi1 = s->buf[stream_ptr++];
            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_STREAM_PTR(rle_code);
            CHECK_PIXEL_PTR(rle_code);

            while (rle_code--)
                rgb[pixel_ptr++] = s->buf[stream_ptr++];
        }
    }
114 115
}

116 117
static inline void qtrle_decode_2n4bpp(QtrleContext *s, int stream_ptr,
                             int row_ptr, int lines_to_change, int bpp)
118
{
119
    int rle_code, i;
120
    int pixel_ptr;
121
    int row_inc = s->frame.linesize[0];
122
    unsigned char pi[16];  /* 16 palette indices */
123 124
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;
125
    int num_pixels = (bpp == 4) ? 8 : 16;
126 127 128

    while (lines_to_change--) {
        CHECK_STREAM_PTR(2);
129
        pixel_ptr = row_ptr + (num_pixels * (s->buf[stream_ptr++] - 1));
130
        CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
131 132 133 134 135

        while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
            if (rle_code == 0) {
                /* there's another skip code in the stream */
                CHECK_STREAM_PTR(1);
136
                pixel_ptr += (num_pixels * (s->buf[stream_ptr++] - 1));
137
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
138 139 140 141
            } 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
142
                 * indexes, and output them rle_code times */
143
                CHECK_STREAM_PTR(4);
144 145 146 147 148
                for (i = num_pixels-1; i >= 0; i--) {
                    pi[num_pixels-1-i] = (s->buf[stream_ptr] >> ((i*bpp) & 0x07)) & ((1<<bpp)-1);
                    stream_ptr+= ((i & ((num_pixels>>2)-1)) == 0);
                }
                CHECK_PIXEL_PTR(rle_code * num_pixels);
149
                while (rle_code--) {
150 151
                    for (i = 0; i < num_pixels; i++)
                        rgb[pixel_ptr++] = pi[i];
152 153 154 155 156
                }
            } else {
                /* copy the same pixel directly to output 4 times */
                rle_code *= 4;
                CHECK_STREAM_PTR(rle_code);
157
                CHECK_PIXEL_PTR(rle_code*(num_pixels>>2));
158
                while (rle_code--) {
159 160 161 162 163 164 165 166 167
                    if(bpp == 4) {
                        rgb[pixel_ptr++] = ((s->buf[stream_ptr]) >> 4) & 0x0f;
                        rgb[pixel_ptr++] = (s->buf[stream_ptr++]) & 0x0f;
                    } else {
                        rgb[pixel_ptr++] = ((s->buf[stream_ptr]) >> 6) & 0x03;
                        rgb[pixel_ptr++] = ((s->buf[stream_ptr]) >> 4) & 0x03;
                        rgb[pixel_ptr++] = ((s->buf[stream_ptr]) >> 2) & 0x03;
                        rgb[pixel_ptr++] = (s->buf[stream_ptr++]) & 0x03;
                    }
168 169 170 171 172
                }
            }
        }
        row_ptr += row_inc;
    }
173 174
}

175
static void qtrle_decode_8bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
176
{
177
    int rle_code;
178
    int pixel_ptr;
179
    int row_inc = s->frame.linesize[0];
180
    unsigned char pi1, pi2, pi3, pi4;  /* 4 palette indexes */
181 182 183 184 185 186
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;

    while (lines_to_change--) {
        CHECK_STREAM_PTR(2);
        pixel_ptr = row_ptr + (4 * (s->buf[stream_ptr++] - 1));
187
        CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
188 189 190 191 192 193

        while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
            if (rle_code == 0) {
                /* there's another skip code in the stream */
                CHECK_STREAM_PTR(1);
                pixel_ptr += (4 * (s->buf[stream_ptr++] - 1));
194
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
195 196 197 198
            } 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
199
                 * indexes, and output them rle_code times */
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
                CHECK_STREAM_PTR(4);
                pi1 = s->buf[stream_ptr++];
                pi2 = s->buf[stream_ptr++];
                pi3 = s->buf[stream_ptr++];
                pi4 = s->buf[stream_ptr++];

                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_STREAM_PTR(rle_code);
                CHECK_PIXEL_PTR(rle_code);

                while (rle_code--) {
                    rgb[pixel_ptr++] = s->buf[stream_ptr++];
                }
            }
        }
        row_ptr += row_inc;
    }
}

229
static void qtrle_decode_16bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
230
{
231
    int rle_code;
232
    int pixel_ptr;
233 234 235 236 237 238 239 240
    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--) {
        CHECK_STREAM_PTR(2);
        pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 2;
241
        CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
242 243 244 245 246 247

        while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
            if (rle_code == 0) {
                /* there's another skip code in the stream */
                CHECK_STREAM_PTR(1);
                pixel_ptr += (s->buf[stream_ptr++] - 1) * 2;
248
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
249 250 251 252
            } else if (rle_code < 0) {
                /* decode the run length code */
                rle_code = -rle_code;
                CHECK_STREAM_PTR(2);
253
                rgb16 = AV_RB16(&s->buf[stream_ptr]);
254 255 256 257 258 259 260 261 262 263 264 265 266 267
                stream_ptr += 2;

                CHECK_PIXEL_PTR(rle_code * 2);

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

                /* copy pixels directly to output */
                while (rle_code--) {
268
                    rgb16 = AV_RB16(&s->buf[stream_ptr]);
269 270 271 272 273 274 275 276 277 278
                    stream_ptr += 2;
                    *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
                    pixel_ptr += 2;
                }
            }
        }
        row_ptr += row_inc;
    }
}

279
static void qtrle_decode_24bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
280
{
281
    int rle_code;
282
    int pixel_ptr;
283 284 285 286 287 288 289 290
    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--) {
        CHECK_STREAM_PTR(2);
        pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 3;
291
        CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
292 293 294 295 296 297

        while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
            if (rle_code == 0) {
                /* there's another skip code in the stream */
                CHECK_STREAM_PTR(1);
                pixel_ptr += (s->buf[stream_ptr++] - 1) * 3;
298
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
            } else if (rle_code < 0) {
                /* decode the run length code */
                rle_code = -rle_code;
                CHECK_STREAM_PTR(3);
                r = s->buf[stream_ptr++];
                g = s->buf[stream_ptr++];
                b = s->buf[stream_ptr++];

                CHECK_PIXEL_PTR(rle_code * 3);

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

                /* copy pixels directly to output */
                while (rle_code--) {
                    rgb[pixel_ptr++] = s->buf[stream_ptr++];
                    rgb[pixel_ptr++] = s->buf[stream_ptr++];
                    rgb[pixel_ptr++] = s->buf[stream_ptr++];
                }
            }
        }
        row_ptr += row_inc;
    }
}

330
static void qtrle_decode_32bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
331
{
332
    int rle_code;
333
    int pixel_ptr;
334
    int row_inc = s->frame.linesize[0];
335
    unsigned char a, r, g, b;
336 337 338 339 340 341 342
    unsigned int argb;
    unsigned char *rgb = s->frame.data[0];
    int pixel_limit = s->frame.linesize[0] * s->avctx->height;

    while (lines_to_change--) {
        CHECK_STREAM_PTR(2);
        pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 4;
343
        CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
344 345 346 347 348 349

        while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
            if (rle_code == 0) {
                /* there's another skip code in the stream */
                CHECK_STREAM_PTR(1);
                pixel_ptr += (s->buf[stream_ptr++] - 1) * 4;
350
                CHECK_PIXEL_PTR(0);  /* make sure pixel_ptr is positive */
351 352 353 354
            } else if (rle_code < 0) {
                /* decode the run length code */
                rle_code = -rle_code;
                CHECK_STREAM_PTR(4);
355
                a = s->buf[stream_ptr++];
356 357 358
                r = s->buf[stream_ptr++];
                g = s->buf[stream_ptr++];
                b = s->buf[stream_ptr++];
359
                argb = (a << 24) | (r << 16) | (g << 8) | (b << 0);
360 361 362 363 364 365 366 367 368 369 370 371 372

                CHECK_PIXEL_PTR(rle_code * 4);

                while (rle_code--) {
                    *(unsigned int *)(&rgb[pixel_ptr]) = argb;
                    pixel_ptr += 4;
                }
            } else {
                CHECK_STREAM_PTR(rle_code * 4);
                CHECK_PIXEL_PTR(rle_code * 4);

                /* copy pixels directly to output */
                while (rle_code--) {
373
                    a = s->buf[stream_ptr++];
374 375 376
                    r = s->buf[stream_ptr++];
                    g = s->buf[stream_ptr++];
                    b = s->buf[stream_ptr++];
377
                    argb = (a << 24) | (r << 16) | (g << 8) | (b << 0);
378 379 380 381 382 383 384 385 386
                    *(unsigned int *)(&rgb[pixel_ptr]) = argb;
                    pixel_ptr += 4;
                }
            }
        }
        row_ptr += row_inc;
    }
}

387
static av_cold int qtrle_decode_init(AVCodecContext *avctx)
388
{
389
    QtrleContext *s = avctx->priv_data;
390 391

    s->avctx = avctx;
392
    switch (avctx->bits_per_coded_sample) {
393
    case 1:
394 395 396 397
    case 33:
        avctx->pix_fmt = PIX_FMT_MONOWHITE;
        break;

398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
    case 2:
    case 4:
    case 8:
    case 34:
    case 36:
    case 40:
        avctx->pix_fmt = PIX_FMT_PAL8;
        break;

    case 16:
        avctx->pix_fmt = PIX_FMT_RGB555;
        break;

    case 24:
        avctx->pix_fmt = PIX_FMT_RGB24;
        break;

    case 32:
416
        avctx->pix_fmt = PIX_FMT_RGB32;
417 418 419
        break;

    default:
Roberto Togni's avatar
Roberto Togni committed
420
        av_log (avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
421
            avctx->bits_per_coded_sample);
422 423 424
        break;
    }

425
    avcodec_get_frame_defaults(&s->frame);
426 427 428 429 430 431 432
    s->frame.data[0] = NULL;

    return 0;
}

static int qtrle_decode_frame(AVCodecContext *avctx,
                              void *data, int *data_size,
433
                              AVPacket *avpkt)
434
{
435 436
    const uint8_t *buf = avpkt->data;
    int buf_size = avpkt->size;
437
    QtrleContext *s = avctx->priv_data;
438 439
    int header, start_line;
    int stream_ptr, height, row_ptr;
440
    int has_palette = 0;
441 442 443 444

    s->buf = buf;
    s->size = buf_size;

445
    s->frame.reference = 3;
446 447 448
    s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE |
                            FF_BUFFER_HINTS_REUSABLE | FF_BUFFER_HINTS_READABLE;
    if (avctx->reget_buffer(avctx, &s->frame)) {
Roberto Togni's avatar
Roberto Togni committed
449
        av_log (s->avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
450 451 452
        return -1;
    }

453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
    /* check if this frame is even supposed to change */
    if (s->size < 8)
        goto done;

    /* start after the chunk size */
    stream_ptr = 4;

    /* fetch the header */
    header = AV_RB16(&s->buf[stream_ptr]);
    stream_ptr += 2;

    /* if a header is present, fetch additional decoding parameters */
    if (header & 0x0008) {
        if(s->size < 14)
            goto done;
        start_line = AV_RB16(&s->buf[stream_ptr]);
        stream_ptr += 4;
        height = AV_RB16(&s->buf[stream_ptr]);
        stream_ptr += 4;
472 473
        if (height > s->avctx->height - start_line)
            goto done;
474 475 476 477 478 479
    } else {
        start_line = 0;
        height = s->avctx->height;
    }
    row_ptr = s->frame.linesize[0] * start_line;

480
    switch (avctx->bits_per_coded_sample) {
481 482
    case 1:
    case 33:
483
        qtrle_decode_1bpp(s, stream_ptr, row_ptr, height);
484 485 486 487
        break;

    case 2:
    case 34:
488 489
        qtrle_decode_2n4bpp(s, stream_ptr, row_ptr, height, 2);
        has_palette = 1;
490 491 492 493
        break;

    case 4:
    case 36:
494 495
        qtrle_decode_2n4bpp(s, stream_ptr, row_ptr, height, 4);
        has_palette = 1;
496 497 498 499
        break;

    case 8:
    case 40:
500
        qtrle_decode_8bpp(s, stream_ptr, row_ptr, height);
501
        has_palette = 1;
502 503 504
        break;

    case 16:
505
        qtrle_decode_16bpp(s, stream_ptr, row_ptr, height);
506 507 508
        break;

    case 24:
509
        qtrle_decode_24bpp(s, stream_ptr, row_ptr, height);
510 511 512
        break;

    case 32:
513
        qtrle_decode_32bpp(s, stream_ptr, row_ptr, height);
514 515 516
        break;

    default:
Roberto Togni's avatar
Roberto Togni committed
517
        av_log (s->avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
518
            avctx->bits_per_coded_sample);
519 520
        break;
    }
521 522

    if(has_palette) {
523 524 525
        const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);

        if (pal) {
526
            s->frame.palette_has_changed = 1;
527
            memcpy(s->pal, pal, AVPALETTE_SIZE);
528
        }
529 530 531

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

534
done:
535 536 537 538 539 540 541
    *data_size = sizeof(AVFrame);
    *(AVFrame*)data = s->frame;

    /* always report that the buffer was completely consumed */
    return buf_size;
}

542
static av_cold int qtrle_decode_end(AVCodecContext *avctx)
543
{
544
    QtrleContext *s = avctx->priv_data;
545 546 547 548 549 550 551

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

    return 0;
}

552
AVCodec ff_qtrle_decoder = {
553 554 555 556 557 558 559 560
    .name           = "qtrle",
    .type           = AVMEDIA_TYPE_VIDEO,
    .id             = CODEC_ID_QTRLE,
    .priv_data_size = sizeof(QtrleContext),
    .init           = qtrle_decode_init,
    .close          = qtrle_decode_end,
    .decode         = qtrle_decode_frame,
    .capabilities   = CODEC_CAP_DR1,
561
    .long_name = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),
562 563
};