initial commit for Quicktime Animation (RLE) video decoder; bit depths

32, 24, and 16 are working; 8bpp is partially working; 4, 2, and 1 bpp
are not supported yet

Originally committed as revision 2748 to svn://svn.ffmpeg.org/ffmpeg/trunk

1 files changed, 537 insertions, 0 deletions

diff --git a/libavcodec/qtrle.c b/libavcodec/qtrle.c
new file mode 100644
index 0000000000..e02ecb13fb
--- /dev/null
+++ b/libavcodec/qtrle.c
@@ -0,0 +1,537 @@
+/*
+ * Quicktime Animation (RLE) Video Decoder
+ * Copyright (C) 2004 the ffmpeg project
+ *
+ * This library 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 of the License, or (at your option) any later version.
+ *
+ * This library 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 this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ */
+
+/**
+ * @file qtrle.c
+ * 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
+ * the decoder outputs PAL8 colorspace data. 16-bit data yields RGB24
+ * data. 24-bit data is RGB888 and 32-bit data is RGBA32.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "common.h"
+#include "avcodec.h"
+#include "dsputil.h"
+
+typedef struct QtrleContext {
+
+    AVCodecContext *avctx;
+    DSPContext dsp;
+    AVFrame frame;
+
+    unsigned char *buf;
+    int size;
+
+} QtrleContext;
+
+#define BE_16(x)  ((((uint8_t*)(x))[0] << 8) | ((uint8_t*)(x))[1])
+
+#define CHECK_STREAM_PTR(n) \
+  if ((stream_ptr + n) > s->size) { \
+    printf ("QT RLE problem: stream_ptr out of bounds (%d >= %d)\n", \
+      stream_ptr + n, s->size); \
+    return; \
+  }
+
+#define CHECK_PIXEL_PTR(n) \
+  if (pixel_ptr + n > pixel_limit) { \
+    printf ("QT RLE problem: pixel_ptr >= pixel_limit (%d >= %d)\n", \
+      pixel_ptr + n, pixel_limit); \
+    return; \
+  } \
+
+static void qtrle_decode_1bpp(QtrleContext *s)
+{
+}
+
+static void qtrle_decode_2bpp(QtrleContext *s)
+{
+}
+
+static void qtrle_decode_4bpp(QtrleContext *s)
+{
+}
+
+static void qtrle_decode_8bpp(QtrleContext *s)
+{
+    int stream_ptr;
+    int header;
+    int start_line;
+    int lines_to_change;
+    signed char rle_code;
+    int row_ptr, pixel_ptr;
+    int row_inc = s->frame.linesize[0];
+    unsigned char pi1, pi2, pi3, pi4;  /* 4 palette indices */
+    unsigned char *rgb = s->frame.data[0];
+    int pixel_limit = s->frame.linesize[0] * s->avctx->height;
+
+    /* check if this frame is even supposed to change */
+    if (s->size < 8)
+        return;
+
+    /* start after the chunk size */
+    stream_ptr = 4;
+
+    /* fetch the header */
+    CHECK_STREAM_PTR(2);
+    header = BE_16(&s->buf[stream_ptr]);
+    stream_ptr += 2;
+
+    /* if a header is present, fetch additional decoding parameters */
+    if (header & 0x0008) {
+        CHECK_STREAM_PTR(8);
+        start_line = BE_16(&s->buf[stream_ptr]);
+        stream_ptr += 4;
+        lines_to_change = BE_16(&s->buf[stream_ptr]);
+        stream_ptr += 4;
+    } else {
+        start_line = 0;
+        lines_to_change = s->avctx->height;
+    }
+
+    row_ptr = row_inc * start_line;
+    while (lines_to_change--) {
+        CHECK_STREAM_PTR(2);
+        pixel_ptr = row_ptr + (4 * (s->buf[stream_ptr++] - 1));
+
+        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));
+            } 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
+                 * indices, and output them rle_code times */
+                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;
+    }
+}
+
+static void qtrle_decode_16bpp(QtrleContext *s)
+{
+    int stream_ptr;
+    int header;
+    int start_line;
+    int lines_to_change;
+    signed char rle_code;
+    int row_ptr, pixel_ptr;
+    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;
+
+    /* check if this frame is even supposed to change */
+    if (s->size < 8)
+        return;
+
+    /* start after the chunk size */
+    stream_ptr = 4;
+
+    /* fetch the header */
+    CHECK_STREAM_PTR(2);
+    header = BE_16(&s->buf[stream_ptr]);
+    stream_ptr += 2;
+
+    /* if a header is present, fetch additional decoding parameters */
+    if (header & 0x0008) {
+        CHECK_STREAM_PTR(8);
+        start_line = BE_16(&s->buf[stream_ptr]);
+        stream_ptr += 4;
+        lines_to_change = BE_16(&s->buf[stream_ptr]);
+        stream_ptr += 4;
+    } else {
+        start_line = 0;
+        lines_to_change = s->avctx->height;
+    }
+
+    row_ptr = row_inc * start_line;
+    while (lines_to_change--) {
+        CHECK_STREAM_PTR(2);
+        pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 2;
+
+        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;
+            } else if (rle_code < 0) {
+                /* decode the run length code */
+                rle_code = -rle_code;
+                CHECK_STREAM_PTR(2);
+                rgb16 = BE_16(&s->buf[stream_ptr]);
+                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--) {
+                    rgb16 = BE_16(&s->buf[stream_ptr]);
+                    stream_ptr += 2;
+                    *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
+                    pixel_ptr += 2;
+                }
+            }
+        }
+        row_ptr += row_inc;
+    }
+}
+
+static void qtrle_decode_24bpp(QtrleContext *s)
+{
+    int stream_ptr;
+    int header;
+    int start_line;
+    int lines_to_change;
+    signed char rle_code;
+    int row_ptr, pixel_ptr;
+    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;
+
+    /* check if this frame is even supposed to change */
+    if (s->size < 8)
+        return;
+
+    /* start after the chunk size */
+    stream_ptr = 4;
+
+    /* fetch the header */
+    CHECK_STREAM_PTR(2);
+    header = BE_16(&s->buf[stream_ptr]);
+    stream_ptr += 2;
+
+    /* if a header is present, fetch additional decoding parameters */
+    if (header & 0x0008) {
+        CHECK_STREAM_PTR(8);
+        start_line = BE_16(&s->buf[stream_ptr]);
+        stream_ptr += 4;
+        lines_to_change = BE_16(&s->buf[stream_ptr]);
+        stream_ptr += 4;
+    } else {
+        start_line = 0;
+        lines_to_change = s->avctx->height;
+    }
+
+    row_ptr = row_inc * start_line;
+    while (lines_to_change--) {
+        CHECK_STREAM_PTR(2);
+        pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 3;
+
+        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;
+            } 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;
+    }
+}
+
+static void qtrle_decode_32bpp(QtrleContext *s)
+{
+    int stream_ptr;
+    int header;
+    int start_line;
+    int lines_to_change;
+    signed char rle_code;
+    int row_ptr, pixel_ptr;
+    int row_inc = s->frame.linesize[0];
+    unsigned char r, g, b;
+    unsigned int argb;
+    unsigned char *rgb = s->frame.data[0];
+    int pixel_limit = s->frame.linesize[0] * s->avctx->height;
+
+    /* check if this frame is even supposed to change */
+    if (s->size < 8)
+        return;
+
+    /* start after the chunk size */
+    stream_ptr = 4;
+
+    /* fetch the header */
+    CHECK_STREAM_PTR(2);
+    header = BE_16(&s->buf[stream_ptr]);
+    stream_ptr += 2;
+
+    /* if a header is present, fetch additional decoding parameters */
+    if (header & 0x0008) {
+        CHECK_STREAM_PTR(8);
+        start_line = BE_16(&s->buf[stream_ptr]);
+        stream_ptr += 4;
+        lines_to_change = BE_16(&s->buf[stream_ptr]);
+        stream_ptr += 4;
+    } else {
+        start_line = 0;
+        lines_to_change = s->avctx->height;
+    }
+
+    row_ptr = row_inc * start_line;
+    while (lines_to_change--) {
+        CHECK_STREAM_PTR(2);
+        pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 4;
+
+        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;
+            } else if (rle_code < 0) {
+                /* decode the run length code */
+                rle_code = -rle_code;
+                CHECK_STREAM_PTR(4);
+                stream_ptr++;  /* skip the alpha (?) byte */
+                r = s->buf[stream_ptr++];
+                g = s->buf[stream_ptr++];
+                b = s->buf[stream_ptr++];
+                argb = (r << 16) | (g << 8) | (b << 0);
+
+                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--) {
+                    stream_ptr++;  /* skip the alpha (?) byte */
+                    r = s->buf[stream_ptr++];
+                    g = s->buf[stream_ptr++];
+                    b = s->buf[stream_ptr++];
+                    argb = (r << 16) | (g << 8) | (b << 0);
+                    *(unsigned int *)(&rgb[pixel_ptr]) = argb;
+                    pixel_ptr += 4;
+                }
+            }
+        }
+        row_ptr += row_inc;
+    }
+}
+
+static int qtrle_decode_init(AVCodecContext *avctx)
+{
+    QtrleContext *s = (QtrleContext *)avctx->priv_data;
+
+    s->avctx = avctx;
+    switch (avctx->bits_per_sample) {
+    case 1:
+    case 2:
+    case 4:
+    case 8:
+    case 33:
+    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:
+        avctx->pix_fmt = PIX_FMT_RGBA32;
+        break;
+
+    default:
+        printf ("QT RLE: Unsupported colorspace: %d bits/sample?\n",
+            avctx->bits_per_sample);
+        break;
+    }
+    avctx->has_b_frames = 0;
+    dsputil_init(&s->dsp, avctx);
+
+    s->frame.data[0] = NULL;
+
+    return 0;
+}
+
+static int qtrle_decode_frame(AVCodecContext *avctx,
+                              void *data, int *data_size,
+                              uint8_t *buf, int buf_size)
+{
+    QtrleContext *s = (QtrleContext *)avctx->priv_data;
+
+    /* no supplementary picture */
+    if (buf_size == 0)
+        return 0;
+
+    s->buf = buf;
+    s->size = buf_size;
+
+    s->frame.reference = 1;
+    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)) {
+        printf ("reget_buffer() failed\n");
+        return -1;
+    }
+
+    switch (avctx->bits_per_sample) {
+    case 1:
+    case 33:
+        qtrle_decode_1bpp(s);
+        break;
+
+    case 2:
+    case 34:
+        qtrle_decode_2bpp(s);
+        break;
+
+    case 4:
+    case 36:
+        qtrle_decode_4bpp(s);
+        break;
+
+    case 8:
+    case 40:
+        qtrle_decode_8bpp(s);
+        /* make the palette available on the way out */
+        memcpy(s->frame.data[1], s->avctx->palctrl->palette, AVPALETTE_SIZE);
+        if (s->avctx->palctrl->palette_changed) {
+            s->frame.palette_has_changed = 1;
+            s->avctx->palctrl->palette_changed = 0;
+        }
+        break;
+
+    case 16:
+        qtrle_decode_16bpp(s);
+        break;
+
+    case 24:
+        qtrle_decode_24bpp(s);
+        break;
+
+    case 32:
+        qtrle_decode_32bpp(s);
+        break;
+
+    default:
+        printf ("QT RLE: Unsupported colorspace: %d bits/sample?\n",
+            avctx->bits_per_sample);
+        break;
+    }
+
+    *data_size = sizeof(AVFrame);
+    *(AVFrame*)data = s->frame;
+
+    /* always report that the buffer was completely consumed */
+    return buf_size;
+}
+
+static int qtrle_decode_end(AVCodecContext *avctx)
+{
+    QtrleContext *s = (QtrleContext *)avctx->priv_data;
+
+    if (s->frame.data[0])
+        avctx->release_buffer(avctx, &s->frame);
+
+    return 0;
+}
+
+AVCodec qtrle_decoder = {
+    "qtrle",
+    CODEC_TYPE_VIDEO,
+    CODEC_ID_QTRLE,
+    sizeof(QtrleContext),
+    qtrle_decode_init,
+    NULL,
+    qtrle_decode_end,
+    qtrle_decode_frame,
+    CODEC_CAP_DR1,
+};
+