2 * Quicktime Animation (RLE) Video Decoder
3 * Copyright (C) 2004 The FFmpeg project
5 * This file is part of FFmpeg.
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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 uint8_t pi0, pi1; /* 2 8-pixel values */
63 uint8_t *rgb = s->frame->data[0];
64 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
66 /* skip & 0x80 appears to mean 'start a new line', which can be interpreted
67 * as 'go to next line' during the decoding of a frame but is 'go to first
68 * line' at the beginning. Since we always interpret it as 'go to next line'
69 * in the decoding loop (which makes code simpler/faster), the first line
70 * would not be counted, so we count one more.
71 * See: https://trac.ffmpeg.org/ticket/226
72 * In the following decoding loop, row_ptr will be the position of the
78 while (lines_to_change) {
79 skip = bytestream2_get_byte(&s->g);
80 rle_code = (int8_t)bytestream2_get_byte(&s->g);
86 pixel_ptr = row_ptr + 2 * 8 * (skip & 0x7f);
88 pixel_ptr += 2 * 8 * skip;
89 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
95 /* decode the run length code */
97 /* get the next 2 bytes from the stream, treat them as groups
98 * of 8 pixels, and output them rle_code times */
100 pi0 = bytestream2_get_byte(&s->g);
101 pi1 = bytestream2_get_byte(&s->g);
102 CHECK_PIXEL_PTR(rle_code * 2 * 8);
105 rgb[pixel_ptr++] = (pi0 >> 7) & 0x01;
106 rgb[pixel_ptr++] = (pi0 >> 6) & 0x01;
107 rgb[pixel_ptr++] = (pi0 >> 5) & 0x01;
108 rgb[pixel_ptr++] = (pi0 >> 4) & 0x01;
109 rgb[pixel_ptr++] = (pi0 >> 3) & 0x01;
110 rgb[pixel_ptr++] = (pi0 >> 2) & 0x01;
111 rgb[pixel_ptr++] = (pi0 >> 1) & 0x01;
112 rgb[pixel_ptr++] = pi0 & 0x01;
113 rgb[pixel_ptr++] = (pi1 >> 7) & 0x01;
114 rgb[pixel_ptr++] = (pi1 >> 6) & 0x01;
115 rgb[pixel_ptr++] = (pi1 >> 5) & 0x01;
116 rgb[pixel_ptr++] = (pi1 >> 4) & 0x01;
117 rgb[pixel_ptr++] = (pi1 >> 3) & 0x01;
118 rgb[pixel_ptr++] = (pi1 >> 2) & 0x01;
119 rgb[pixel_ptr++] = (pi1 >> 1) & 0x01;
120 rgb[pixel_ptr++] = pi1 & 0x01;
123 /* copy the same pixel directly to output 2 times */
125 CHECK_PIXEL_PTR(rle_code * 8);
128 int x = bytestream2_get_byte(&s->g);
129 rgb[pixel_ptr++] = (x >> 7) & 0x01;
130 rgb[pixel_ptr++] = (x >> 6) & 0x01;
131 rgb[pixel_ptr++] = (x >> 5) & 0x01;
132 rgb[pixel_ptr++] = (x >> 4) & 0x01;
133 rgb[pixel_ptr++] = (x >> 3) & 0x01;
134 rgb[pixel_ptr++] = (x >> 2) & 0x01;
135 rgb[pixel_ptr++] = (x >> 1) & 0x01;
136 rgb[pixel_ptr++] = x & 0x01;
142 static inline void qtrle_decode_2n4bpp(QtrleContext *s, int row_ptr,
143 int lines_to_change, int bpp)
147 int row_inc = s->frame->linesize[0];
148 uint8_t pi[16]; /* 16 palette indices */
149 uint8_t *rgb = s->frame->data[0];
150 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
151 int num_pixels = (bpp == 4) ? 8 : 16;
153 while (lines_to_change--) {
154 pixel_ptr = row_ptr + (num_pixels * (bytestream2_get_byte(&s->g) - 1));
157 while ((rle_code = (int8_t)bytestream2_get_byte(&s->g)) != -1) {
158 if (bytestream2_get_bytes_left(&s->g) < 1)
161 /* there's another skip code in the stream */
162 pixel_ptr += (num_pixels * (bytestream2_get_byte(&s->g) - 1));
163 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
164 } else if (rle_code < 0) {
165 /* decode the run length code */
166 rle_code = -rle_code;
167 /* get the next 4 bytes from the stream, treat them as palette
168 * indexes, and output them rle_code times */
169 for (i = num_pixels-1; i >= 0; i--) {
170 pi[num_pixels-1-i] = (bytestream2_peek_byte(&s->g) >> ((i*bpp) & 0x07)) & ((1<<bpp)-1);
171 bytestream2_skip(&s->g, ((i & ((num_pixels>>2)-1)) == 0));
173 CHECK_PIXEL_PTR(rle_code * num_pixels);
175 memcpy(&rgb[pixel_ptr], &pi, num_pixels);
176 pixel_ptr += num_pixels;
179 /* copy the same pixel directly to output 4 times */
181 CHECK_PIXEL_PTR(rle_code*(num_pixels>>2));
184 int x = bytestream2_get_byte(&s->g);
185 rgb[pixel_ptr++] = (x >> 4) & 0x0f;
186 rgb[pixel_ptr++] = x & 0x0f;
188 int x = bytestream2_get_byte(&s->g);
189 rgb[pixel_ptr++] = (x >> 6) & 0x03;
190 rgb[pixel_ptr++] = (x >> 4) & 0x03;
191 rgb[pixel_ptr++] = (x >> 2) & 0x03;
192 rgb[pixel_ptr++] = x & 0x03;
201 static void qtrle_decode_8bpp(QtrleContext *s, int row_ptr, int lines_to_change)
205 int row_inc = s->frame->linesize[0];
206 uint8_t pi1, pi2, pi3, pi4; /* 4 palette indexes */
207 uint8_t *rgb = s->frame->data[0];
208 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
210 while (lines_to_change--) {
211 pixel_ptr = row_ptr + (4 * (bytestream2_get_byte(&s->g) - 1));
214 while ((rle_code = (int8_t)bytestream2_get_byte(&s->g)) != -1) {
215 if (bytestream2_get_bytes_left(&s->g) < 1)
218 /* there's another skip code in the stream */
219 pixel_ptr += (4 * (bytestream2_get_byte(&s->g) - 1));
220 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
221 } else if (rle_code < 0) {
222 /* decode the run length code */
223 rle_code = -rle_code;
224 /* get the next 4 bytes from the stream, treat them as palette
225 * indexes, and output them rle_code times */
226 pi1 = bytestream2_get_byte(&s->g);
227 pi2 = bytestream2_get_byte(&s->g);
228 pi3 = bytestream2_get_byte(&s->g);
229 pi4 = bytestream2_get_byte(&s->g);
231 CHECK_PIXEL_PTR(rle_code * 4);
234 rgb[pixel_ptr++] = pi1;
235 rgb[pixel_ptr++] = pi2;
236 rgb[pixel_ptr++] = pi3;
237 rgb[pixel_ptr++] = pi4;
240 /* copy the same pixel directly to output 4 times */
242 CHECK_PIXEL_PTR(rle_code);
244 bytestream2_get_buffer(&s->g, &rgb[pixel_ptr], rle_code);
245 pixel_ptr += rle_code;
252 static void qtrle_decode_16bpp(QtrleContext *s, int row_ptr, int lines_to_change)
256 int row_inc = s->frame->linesize[0];
258 uint8_t *rgb = s->frame->data[0];
259 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
261 while (lines_to_change--) {
262 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 2;
265 while ((rle_code = (int8_t)bytestream2_get_byte(&s->g)) != -1) {
266 if (bytestream2_get_bytes_left(&s->g) < 1)
269 /* there's another skip code in the stream */
270 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 2;
271 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
272 } else if (rle_code < 0) {
273 /* decode the run length code */
274 rle_code = -rle_code;
275 rgb16 = bytestream2_get_be16(&s->g);
277 CHECK_PIXEL_PTR(rle_code * 2);
280 *(uint16_t *)(&rgb[pixel_ptr]) = rgb16;
284 CHECK_PIXEL_PTR(rle_code * 2);
286 /* copy pixels directly to output */
288 rgb16 = bytestream2_get_be16(&s->g);
289 *(uint16_t *)(&rgb[pixel_ptr]) = rgb16;
298 static void qtrle_decode_24bpp(QtrleContext *s, int row_ptr, int lines_to_change)
300 int rle_code, rle_code_half;
302 int row_inc = s->frame->linesize[0];
305 uint8_t *rgb = s->frame->data[0];
306 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
308 while (lines_to_change--) {
309 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 3;
312 while ((rle_code = (int8_t)bytestream2_get_byte(&s->g)) != -1) {
313 if (bytestream2_get_bytes_left(&s->g) < 1)
316 /* there's another skip code in the stream */
317 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 3;
318 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
319 } else if (rle_code < 0) {
320 /* decode the run length code */
321 rle_code = -rle_code;
322 rg = bytestream2_get_ne16(&s->g);
323 b = bytestream2_get_byte(&s->g);
325 CHECK_PIXEL_PTR(rle_code * 3);
328 AV_WN16(rgb + pixel_ptr, rg);
329 rgb[pixel_ptr + 2] = b;
333 CHECK_PIXEL_PTR(rle_code * 3);
335 rle_code_half = rle_code / 2;
337 while (rle_code_half--) { /* copy 2 raw rgb value at the same time */
338 AV_WN32(rgb + pixel_ptr, bytestream2_get_ne32(&s->g)); /* rgbr */
339 AV_WN16(rgb + pixel_ptr + 4, bytestream2_get_ne16(&s->g)); /* rgbr */
343 if (rle_code % 2 != 0){ /* not even raw value */
344 AV_WN16(rgb + pixel_ptr, bytestream2_get_ne16(&s->g));
345 rgb[pixel_ptr + 2] = bytestream2_get_byte(&s->g);
354 static void qtrle_decode_32bpp(QtrleContext *s, int row_ptr, int lines_to_change)
356 int rle_code, rle_code_half;
358 int row_inc = s->frame->linesize[0];
360 uint8_t *rgb = s->frame->data[0];
361 int pixel_limit = s->frame->linesize[0] * s->avctx->height;
363 while (lines_to_change--) {
364 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 4;
367 while ((rle_code = (int8_t)bytestream2_get_byte(&s->g)) != -1) {
368 if (bytestream2_get_bytes_left(&s->g) < 1)
371 /* there's another skip code in the stream */
372 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 4;
373 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
374 } else if (rle_code < 0) {
375 /* decode the run length code */
376 rle_code = -rle_code;
377 argb = bytestream2_get_ne32(&s->g);
379 CHECK_PIXEL_PTR(rle_code * 4);
382 AV_WN32A(rgb + pixel_ptr, argb);
386 CHECK_PIXEL_PTR(rle_code * 4);
388 /* copy pixels directly to output */
389 rle_code_half = rle_code / 2;
390 while (rle_code_half--) { /* copy 2 argb raw value at the same time */
391 AV_WN64(rgb + pixel_ptr, bytestream2_get_ne64(&s->g));
395 if (rle_code % 2 != 0){ /* not even raw value */
396 AV_WN32A(rgb + pixel_ptr, bytestream2_get_ne32(&s->g));
405 static av_cold int qtrle_decode_init(AVCodecContext *avctx)
407 QtrleContext *s = avctx->priv_data;
410 switch (avctx->bits_per_coded_sample) {
419 avctx->pix_fmt = AV_PIX_FMT_PAL8;
423 avctx->pix_fmt = AV_PIX_FMT_RGB555;
427 avctx->pix_fmt = AV_PIX_FMT_RGB24;
431 avctx->pix_fmt = AV_PIX_FMT_ARGB;
435 av_log (avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
436 avctx->bits_per_coded_sample);
437 return AVERROR_INVALIDDATA;
440 s->frame = av_frame_alloc();
442 return AVERROR(ENOMEM);
447 static int qtrle_decode_frame(AVCodecContext *avctx,
448 void *data, int *got_frame,
451 QtrleContext *s = avctx->priv_data;
452 int header, start_line;
458 bytestream2_init(&s->g, avpkt->data, avpkt->size);
460 /* check if this frame is even supposed to change */
461 if (avpkt->size < 8) {
466 /* start after the chunk size */
467 size = bytestream2_get_be32(&s->g) & 0x3FFFFFFF;
468 if (size - avpkt->size > size * (int64_t)avctx->discard_damaged_percentage / 100)
469 return AVERROR_INVALIDDATA;
472 /* fetch the header */
473 header = bytestream2_get_be16(&s->g);
475 /* if a header is present, fetch additional decoding parameters */
476 if (header & 0x0008) {
477 if (avpkt->size < 14) {
481 start_line = bytestream2_get_be16(&s->g);
482 bytestream2_skip(&s->g, 2);
483 height = bytestream2_get_be16(&s->g);
484 bytestream2_skip(&s->g, 2);
485 if (height > s->avctx->height - start_line) {
491 height = s->avctx->height;
493 if ((ret = ff_reget_buffer(avctx, s->frame, 0)) < 0)
496 row_ptr = s->frame->linesize[0] * start_line;
498 switch (avctx->bits_per_coded_sample) {
501 qtrle_decode_1bpp(s, row_ptr, height);
507 qtrle_decode_2n4bpp(s, row_ptr, height, 2);
513 qtrle_decode_2n4bpp(s, row_ptr, height, 4);
519 qtrle_decode_8bpp(s, row_ptr, height);
524 qtrle_decode_16bpp(s, row_ptr, height);
528 qtrle_decode_24bpp(s, row_ptr, height);
532 qtrle_decode_32bpp(s, row_ptr, height);
536 av_log (s->avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
537 avctx->bits_per_coded_sample);
543 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, &size);
545 if (pal && size == AVPALETTE_SIZE) {
546 s->frame->palette_has_changed = 1;
547 memcpy(s->pal, pal, AVPALETTE_SIZE);
549 av_log(avctx, AV_LOG_ERROR, "Palette size %d is wrong\n", size);
552 /* make the palette available on the way out */
553 memcpy(s->frame->data[1], s->pal, AVPALETTE_SIZE);
557 if (!s->frame->data[0])
558 return AVERROR_INVALIDDATA;
560 // ff_reget_buffer() isn't needed when frames don't change, so just update
562 ret = ff_decode_frame_props(avctx, s->frame);
567 if ((ret = av_frame_ref(data, s->frame)) < 0)
571 /* always report that the buffer was completely consumed */
575 static void qtrle_decode_flush(AVCodecContext *avctx)
577 QtrleContext *s = avctx->priv_data;
579 av_frame_unref(s->frame);
582 static av_cold int qtrle_decode_end(AVCodecContext *avctx)
584 QtrleContext *s = avctx->priv_data;
586 av_frame_free(&s->frame);
591 AVCodec ff_qtrle_decoder = {
593 .long_name = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),
594 .type = AVMEDIA_TYPE_VIDEO,
595 .id = AV_CODEC_ID_QTRLE,
596 .priv_data_size = sizeof(QtrleContext),
597 .init = qtrle_decode_init,
598 .close = qtrle_decode_end,
599 .decode = qtrle_decode_frame,
600 .flush = qtrle_decode_flush,
601 .capabilities = AV_CODEC_CAP_DR1,