2 * Quicktime Animation (RLE) Video Decoder
3 * Copyright (C) 2004 the ffmpeg project
5 * This file is part of Libav.
7 * Libav is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * Libav is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * 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
24 * QT RLE Video Decoder by Mike Melanson (melanson@pcisys.net)
25 * For more information about the QT RLE format, visit:
26 * http://www.pcisys.net/~melanson/codecs/
28 * The QT RLE decoder has seven modes of operation:
29 * 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.
39 #include "bytestream.h"
42 typedef struct QtrleContext {
43 AVCodecContext *avctx;
50 #define CHECK_PIXEL_PTR(n) \
51 if ((pixel_ptr + n > pixel_limit) || (pixel_ptr + n < 0)) { \
52 av_log (s->avctx, AV_LOG_ERROR, "Problem: pixel_ptr = %d, pixel_limit = %d\n",\
53 pixel_ptr + n, pixel_limit); \
57 static void qtrle_decode_1bpp(QtrleContext *s, int row_ptr, int lines_to_change)
61 int row_inc = s->frame->linesize[0];
62 unsigned char pi0, pi1; /* 2 8-pixel values */
63 unsigned char *rgb = s->frame->data[0];
64 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
70 while (lines_to_change) {
71 skip = bytestream2_get_byte(&s->g);
72 rle_code = (signed char)bytestream2_get_byte(&s->g);
78 pixel_ptr = row_ptr + 2 * (skip & 0x7f);
80 pixel_ptr += 2 * skip;
81 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
84 /* decode the run length code */
86 /* get the next 2 bytes from the stream, treat them as groups
87 * of 8 pixels, and output them rle_code times */
89 pi0 = bytestream2_get_byte(&s->g);
90 pi1 = bytestream2_get_byte(&s->g);
91 CHECK_PIXEL_PTR(rle_code * 2);
94 rgb[pixel_ptr++] = pi0;
95 rgb[pixel_ptr++] = pi1;
98 /* copy the same pixel directly to output 2 times */
100 CHECK_PIXEL_PTR(rle_code);
103 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
108 static inline void qtrle_decode_2n4bpp(QtrleContext *s, int row_ptr,
109 int lines_to_change, int bpp)
113 int row_inc = s->frame->linesize[0];
114 unsigned char pi[16]; /* 16 palette indices */
115 unsigned char *rgb = s->frame->data[0];
116 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
117 int num_pixels = (bpp == 4) ? 8 : 16;
119 while (lines_to_change--) {
120 pixel_ptr = row_ptr + (num_pixels * (bytestream2_get_byte(&s->g) - 1));
123 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
125 /* there's another skip code in the stream */
126 pixel_ptr += (num_pixels * (bytestream2_get_byte(&s->g) - 1));
127 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
128 } else if (rle_code < 0) {
129 /* decode the run length code */
130 rle_code = -rle_code;
131 /* get the next 4 bytes from the stream, treat them as palette
132 * indexes, and output them rle_code times */
133 for (i = num_pixels-1; i >= 0; i--) {
134 pi[num_pixels-1-i] = (bytestream2_peek_byte(&s->g) >> ((i*bpp) & 0x07)) & ((1<<bpp)-1);
135 bytestream2_skip(&s->g, ((i & ((num_pixels>>2)-1)) == 0));
137 CHECK_PIXEL_PTR(rle_code * num_pixels);
139 for (i = 0; i < num_pixels; i++)
140 rgb[pixel_ptr++] = pi[i];
143 /* copy the same pixel directly to output 4 times */
145 CHECK_PIXEL_PTR(rle_code*(num_pixels>>2));
148 int x = bytestream2_get_byte(&s->g);
149 rgb[pixel_ptr++] = (x >> 4) & 0x0f;
150 rgb[pixel_ptr++] = x & 0x0f;
152 int x = bytestream2_get_byte(&s->g);
153 rgb[pixel_ptr++] = (x >> 6) & 0x03;
154 rgb[pixel_ptr++] = (x >> 4) & 0x03;
155 rgb[pixel_ptr++] = (x >> 2) & 0x03;
156 rgb[pixel_ptr++] = x & 0x03;
165 static void qtrle_decode_8bpp(QtrleContext *s, int row_ptr, int lines_to_change)
169 int row_inc = s->frame->linesize[0];
170 unsigned char pi1, pi2, pi3, pi4; /* 4 palette indexes */
171 unsigned char *rgb = s->frame->data[0];
172 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
174 while (lines_to_change--) {
175 pixel_ptr = row_ptr + (4 * (bytestream2_get_byte(&s->g) - 1));
178 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
180 /* there's another skip code in the stream */
181 pixel_ptr += (4 * (bytestream2_get_byte(&s->g) - 1));
182 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
183 } else if (rle_code < 0) {
184 /* decode the run length code */
185 rle_code = -rle_code;
186 /* get the next 4 bytes from the stream, treat them as palette
187 * indexes, and output them rle_code times */
188 pi1 = bytestream2_get_byte(&s->g);
189 pi2 = bytestream2_get_byte(&s->g);
190 pi3 = bytestream2_get_byte(&s->g);
191 pi4 = bytestream2_get_byte(&s->g);
193 CHECK_PIXEL_PTR(rle_code * 4);
196 rgb[pixel_ptr++] = pi1;
197 rgb[pixel_ptr++] = pi2;
198 rgb[pixel_ptr++] = pi3;
199 rgb[pixel_ptr++] = pi4;
202 /* copy the same pixel directly to output 4 times */
204 CHECK_PIXEL_PTR(rle_code);
207 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
215 static void qtrle_decode_16bpp(QtrleContext *s, int row_ptr, int lines_to_change)
219 int row_inc = s->frame->linesize[0];
220 unsigned short rgb16;
221 unsigned char *rgb = s->frame->data[0];
222 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
224 while (lines_to_change--) {
225 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 2;
228 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
230 /* there's another skip code in the stream */
231 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 2;
232 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
233 } else if (rle_code < 0) {
234 /* decode the run length code */
235 rle_code = -rle_code;
236 rgb16 = bytestream2_get_be16(&s->g);
238 CHECK_PIXEL_PTR(rle_code * 2);
241 *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
245 CHECK_PIXEL_PTR(rle_code * 2);
247 /* copy pixels directly to output */
249 rgb16 = bytestream2_get_be16(&s->g);
250 *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
259 static void qtrle_decode_24bpp(QtrleContext *s, int row_ptr, int lines_to_change)
263 int row_inc = s->frame->linesize[0];
264 unsigned char r, g, b;
265 unsigned char *rgb = s->frame->data[0];
266 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
268 while (lines_to_change--) {
269 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 3;
272 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
274 /* there's another skip code in the stream */
275 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 3;
276 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
277 } else if (rle_code < 0) {
278 /* decode the run length code */
279 rle_code = -rle_code;
280 r = bytestream2_get_byte(&s->g);
281 g = bytestream2_get_byte(&s->g);
282 b = bytestream2_get_byte(&s->g);
284 CHECK_PIXEL_PTR(rle_code * 3);
287 rgb[pixel_ptr++] = r;
288 rgb[pixel_ptr++] = g;
289 rgb[pixel_ptr++] = b;
292 CHECK_PIXEL_PTR(rle_code * 3);
294 /* copy pixels directly to output */
296 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
297 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
298 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
306 static void qtrle_decode_32bpp(QtrleContext *s, int row_ptr, int lines_to_change)
310 int row_inc = s->frame->linesize[0];
312 unsigned char *rgb = s->frame->data[0];
313 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
315 while (lines_to_change--) {
316 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 4;
319 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
321 /* there's another skip code in the stream */
322 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 4;
323 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
324 } else if (rle_code < 0) {
325 /* decode the run length code */
326 rle_code = -rle_code;
327 argb = bytestream2_get_be32(&s->g);
329 CHECK_PIXEL_PTR(rle_code * 4);
332 AV_WN32A(rgb + pixel_ptr, argb);
336 CHECK_PIXEL_PTR(rle_code * 4);
338 /* copy pixels directly to output */
340 argb = bytestream2_get_be32(&s->g);
341 AV_WN32A(rgb + pixel_ptr, argb);
350 static av_cold int qtrle_decode_init(AVCodecContext *avctx)
352 QtrleContext *s = avctx->priv_data;
355 switch (avctx->bits_per_coded_sample) {
358 avctx->pix_fmt = AV_PIX_FMT_MONOWHITE;
367 avctx->pix_fmt = AV_PIX_FMT_PAL8;
371 avctx->pix_fmt = AV_PIX_FMT_RGB555;
375 avctx->pix_fmt = AV_PIX_FMT_RGB24;
379 avctx->pix_fmt = AV_PIX_FMT_RGB32;
383 av_log (avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
384 avctx->bits_per_coded_sample);
385 return AVERROR_INVALIDDATA;
388 s->frame = av_frame_alloc();
390 return AVERROR(ENOMEM);
395 static int qtrle_decode_frame(AVCodecContext *avctx,
396 void *data, int *got_frame,
399 QtrleContext *s = avctx->priv_data;
400 int header, start_line;
405 bytestream2_init(&s->g, avpkt->data, avpkt->size);
406 if ((ret = ff_reget_buffer(avctx, s->frame)) < 0) {
407 av_log (s->avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
411 /* check if this frame is even supposed to change */
415 /* start after the chunk size */
416 bytestream2_seek(&s->g, 4, SEEK_SET);
418 /* fetch the header */
419 header = bytestream2_get_be16(&s->g);
421 /* if a header is present, fetch additional decoding parameters */
422 if (header & 0x0008) {
423 if (avpkt->size < 14)
425 start_line = bytestream2_get_be16(&s->g);
426 bytestream2_skip(&s->g, 2);
427 height = bytestream2_get_be16(&s->g);
428 bytestream2_skip(&s->g, 2);
431 height = s->avctx->height;
433 row_ptr = s->frame->linesize[0] * start_line;
435 switch (avctx->bits_per_coded_sample) {
438 qtrle_decode_1bpp(s, row_ptr, height);
443 qtrle_decode_2n4bpp(s, row_ptr, height, 2);
449 qtrle_decode_2n4bpp(s, row_ptr, height, 4);
455 qtrle_decode_8bpp(s, row_ptr, height);
460 qtrle_decode_16bpp(s, row_ptr, height);
464 qtrle_decode_24bpp(s, row_ptr, height);
468 qtrle_decode_32bpp(s, row_ptr, height);
472 av_log (s->avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
473 avctx->bits_per_coded_sample);
478 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
481 s->frame->palette_has_changed = 1;
482 memcpy(s->pal, pal, AVPALETTE_SIZE);
485 /* make the palette available on the way out */
486 memcpy(s->frame->data[1], s->pal, AVPALETTE_SIZE);
490 if ((ret = av_frame_ref(data, s->frame)) < 0)
494 /* always report that the buffer was completely consumed */
498 static av_cold int qtrle_decode_end(AVCodecContext *avctx)
500 QtrleContext *s = avctx->priv_data;
502 av_frame_free(&s->frame);
507 AVCodec ff_qtrle_decoder = {
509 .long_name = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),
510 .type = AVMEDIA_TYPE_VIDEO,
511 .id = AV_CODEC_ID_QTRLE,
512 .priv_data_size = sizeof(QtrleContext),
513 .init = qtrle_decode_init,
514 .close = qtrle_decode_end,
515 .decode = qtrle_decode_frame,
516 .capabilities = CODEC_CAP_DR1,