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.
38 #include "libavutil/intreadwrite.h"
41 typedef struct QtrleContext {
43 AVCodecContext *avctx;
46 const unsigned char *buf;
52 #define CHECK_STREAM_PTR(n) \
53 if ((stream_ptr + n) > s->size) { \
54 av_log (s->avctx, AV_LOG_INFO, "Problem: stream_ptr out of bounds (%d >= %d)\n", \
55 stream_ptr + n, s->size); \
59 #define CHECK_PIXEL_PTR(n) \
60 if ((pixel_ptr + n > pixel_limit) || (pixel_ptr + n < 0)) { \
61 av_log (s->avctx, AV_LOG_INFO, "Problem: pixel_ptr = %d, pixel_limit = %d\n", \
62 pixel_ptr + n, pixel_limit); \
66 static void qtrle_decode_1bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
70 int row_inc = s->frame.linesize[0];
71 unsigned char pi0, pi1; /* 2 8-pixel values */
72 unsigned char *rgb = s->frame.data[0];
73 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
76 while (lines_to_change) {
78 skip = s->buf[stream_ptr++];
79 rle_code = (signed char)s->buf[stream_ptr++];
85 pixel_ptr = row_ptr + 2 * (skip & 0x7f);
87 pixel_ptr += 2 * skip;
88 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
91 /* decode the run length code */
93 /* get the next 2 bytes from the stream, treat them as groups
94 * of 8 pixels, and output them rle_code times */
96 pi0 = s->buf[stream_ptr++];
97 pi1 = s->buf[stream_ptr++];
98 CHECK_PIXEL_PTR(rle_code * 2);
101 rgb[pixel_ptr++] = pi0;
102 rgb[pixel_ptr++] = pi1;
105 /* copy the same pixel directly to output 2 times */
107 CHECK_STREAM_PTR(rle_code);
108 CHECK_PIXEL_PTR(rle_code);
111 rgb[pixel_ptr++] = s->buf[stream_ptr++];
116 static inline void qtrle_decode_2n4bpp(QtrleContext *s, int stream_ptr,
117 int row_ptr, int lines_to_change, int bpp)
121 int row_inc = s->frame.linesize[0];
122 unsigned char pi[16]; /* 16 palette indices */
123 unsigned char *rgb = s->frame.data[0];
124 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
125 int num_pixels = (bpp == 4) ? 8 : 16;
127 while (lines_to_change--) {
129 pixel_ptr = row_ptr + (num_pixels * (s->buf[stream_ptr++] - 1));
131 while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
133 /* there's another skip code in the stream */
135 pixel_ptr += (num_pixels * (s->buf[stream_ptr++] - 1));
136 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
137 } else if (rle_code < 0) {
138 /* decode the run length code */
139 rle_code = -rle_code;
140 /* get the next 4 bytes from the stream, treat them as palette
141 * indexes, and output them rle_code times */
143 for (i = num_pixels-1; i >= 0; i--) {
144 pi[num_pixels-1-i] = (s->buf[stream_ptr] >> ((i*bpp) & 0x07)) & ((1<<bpp)-1);
145 stream_ptr+= ((i & ((num_pixels>>2)-1)) == 0);
147 CHECK_PIXEL_PTR(rle_code * num_pixels);
149 for (i = 0; i < num_pixels; i++)
150 rgb[pixel_ptr++] = pi[i];
153 /* copy the same pixel directly to output 4 times */
155 CHECK_STREAM_PTR(rle_code);
156 CHECK_PIXEL_PTR(rle_code*(num_pixels>>2));
159 rgb[pixel_ptr++] = ((s->buf[stream_ptr]) >> 4) & 0x0f;
160 rgb[pixel_ptr++] = (s->buf[stream_ptr++]) & 0x0f;
162 rgb[pixel_ptr++] = ((s->buf[stream_ptr]) >> 6) & 0x03;
163 rgb[pixel_ptr++] = ((s->buf[stream_ptr]) >> 4) & 0x03;
164 rgb[pixel_ptr++] = ((s->buf[stream_ptr]) >> 2) & 0x03;
165 rgb[pixel_ptr++] = (s->buf[stream_ptr++]) & 0x03;
174 static void qtrle_decode_8bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
178 int row_inc = s->frame.linesize[0];
179 unsigned char pi1, pi2, pi3, pi4; /* 4 palette indexes */
180 unsigned char *rgb = s->frame.data[0];
181 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
183 while (lines_to_change--) {
185 pixel_ptr = row_ptr + (4 * (s->buf[stream_ptr++] - 1));
187 while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
189 /* there's another skip code in the stream */
191 pixel_ptr += (4 * (s->buf[stream_ptr++] - 1));
192 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
193 } else if (rle_code < 0) {
194 /* decode the run length code */
195 rle_code = -rle_code;
196 /* get the next 4 bytes from the stream, treat them as palette
197 * indexes, and output them rle_code times */
199 pi1 = s->buf[stream_ptr++];
200 pi2 = s->buf[stream_ptr++];
201 pi3 = s->buf[stream_ptr++];
202 pi4 = s->buf[stream_ptr++];
204 CHECK_PIXEL_PTR(rle_code * 4);
207 rgb[pixel_ptr++] = pi1;
208 rgb[pixel_ptr++] = pi2;
209 rgb[pixel_ptr++] = pi3;
210 rgb[pixel_ptr++] = pi4;
213 /* copy the same pixel directly to output 4 times */
215 CHECK_STREAM_PTR(rle_code);
216 CHECK_PIXEL_PTR(rle_code);
219 rgb[pixel_ptr++] = s->buf[stream_ptr++];
227 static void qtrle_decode_16bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
231 int row_inc = s->frame.linesize[0];
232 unsigned short rgb16;
233 unsigned char *rgb = s->frame.data[0];
234 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
236 while (lines_to_change--) {
238 pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 2;
240 while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
242 /* there's another skip code in the stream */
244 pixel_ptr += (s->buf[stream_ptr++] - 1) * 2;
245 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
246 } else if (rle_code < 0) {
247 /* decode the run length code */
248 rle_code = -rle_code;
250 rgb16 = AV_RB16(&s->buf[stream_ptr]);
253 CHECK_PIXEL_PTR(rle_code * 2);
256 *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
260 CHECK_STREAM_PTR(rle_code * 2);
261 CHECK_PIXEL_PTR(rle_code * 2);
263 /* copy pixels directly to output */
265 rgb16 = AV_RB16(&s->buf[stream_ptr]);
267 *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
276 static void qtrle_decode_24bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
280 int row_inc = s->frame.linesize[0];
281 unsigned char r, g, b;
282 unsigned char *rgb = s->frame.data[0];
283 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
285 while (lines_to_change--) {
287 pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 3;
289 while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
291 /* there's another skip code in the stream */
293 pixel_ptr += (s->buf[stream_ptr++] - 1) * 3;
294 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
295 } else if (rle_code < 0) {
296 /* decode the run length code */
297 rle_code = -rle_code;
299 r = s->buf[stream_ptr++];
300 g = s->buf[stream_ptr++];
301 b = s->buf[stream_ptr++];
303 CHECK_PIXEL_PTR(rle_code * 3);
306 rgb[pixel_ptr++] = r;
307 rgb[pixel_ptr++] = g;
308 rgb[pixel_ptr++] = b;
311 CHECK_STREAM_PTR(rle_code * 3);
312 CHECK_PIXEL_PTR(rle_code * 3);
314 /* copy pixels directly to output */
316 rgb[pixel_ptr++] = s->buf[stream_ptr++];
317 rgb[pixel_ptr++] = s->buf[stream_ptr++];
318 rgb[pixel_ptr++] = s->buf[stream_ptr++];
326 static void qtrle_decode_32bpp(QtrleContext *s, int stream_ptr, int row_ptr, int lines_to_change)
330 int row_inc = s->frame.linesize[0];
332 unsigned char *rgb = s->frame.data[0];
333 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
335 while (lines_to_change--) {
337 pixel_ptr = row_ptr + (s->buf[stream_ptr++] - 1) * 4;
339 while ((rle_code = (signed char)s->buf[stream_ptr++]) != -1) {
341 /* there's another skip code in the stream */
343 pixel_ptr += (s->buf[stream_ptr++] - 1) * 4;
344 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
345 } else if (rle_code < 0) {
346 /* decode the run length code */
347 rle_code = -rle_code;
349 argb = AV_RB32(s->buf + stream_ptr);
352 CHECK_PIXEL_PTR(rle_code * 4);
355 AV_WN32A(rgb + pixel_ptr, argb);
359 CHECK_STREAM_PTR(rle_code * 4);
360 CHECK_PIXEL_PTR(rle_code * 4);
362 /* copy pixels directly to output */
364 argb = AV_RB32(s->buf + stream_ptr);
365 AV_WN32A(rgb + pixel_ptr, argb);
375 static av_cold int qtrle_decode_init(AVCodecContext *avctx)
377 QtrleContext *s = avctx->priv_data;
380 switch (avctx->bits_per_coded_sample) {
383 avctx->pix_fmt = PIX_FMT_MONOWHITE;
392 avctx->pix_fmt = PIX_FMT_PAL8;
396 avctx->pix_fmt = PIX_FMT_RGB555;
400 avctx->pix_fmt = PIX_FMT_RGB24;
404 avctx->pix_fmt = PIX_FMT_RGB32;
408 av_log (avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
409 avctx->bits_per_coded_sample);
413 s->frame.data[0] = NULL;
418 static int qtrle_decode_frame(AVCodecContext *avctx,
419 void *data, int *data_size,
422 const uint8_t *buf = avpkt->data;
423 int buf_size = avpkt->size;
424 QtrleContext *s = avctx->priv_data;
425 int header, start_line;
426 int stream_ptr, height, row_ptr;
432 s->frame.reference = 1;
433 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE |
434 FF_BUFFER_HINTS_REUSABLE | FF_BUFFER_HINTS_READABLE;
435 if (avctx->reget_buffer(avctx, &s->frame)) {
436 av_log (s->avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
440 /* check if this frame is even supposed to change */
444 /* start after the chunk size */
447 /* fetch the header */
448 header = AV_RB16(&s->buf[stream_ptr]);
451 /* if a header is present, fetch additional decoding parameters */
452 if (header & 0x0008) {
455 start_line = AV_RB16(&s->buf[stream_ptr]);
457 height = AV_RB16(&s->buf[stream_ptr]);
461 height = s->avctx->height;
463 row_ptr = s->frame.linesize[0] * start_line;
465 switch (avctx->bits_per_coded_sample) {
468 qtrle_decode_1bpp(s, stream_ptr, row_ptr, height);
473 qtrle_decode_2n4bpp(s, stream_ptr, row_ptr, height, 2);
479 qtrle_decode_2n4bpp(s, stream_ptr, row_ptr, height, 4);
485 qtrle_decode_8bpp(s, stream_ptr, row_ptr, height);
490 qtrle_decode_16bpp(s, stream_ptr, row_ptr, height);
494 qtrle_decode_24bpp(s, stream_ptr, row_ptr, height);
498 qtrle_decode_32bpp(s, stream_ptr, row_ptr, height);
502 av_log (s->avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
503 avctx->bits_per_coded_sample);
508 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
511 s->frame.palette_has_changed = 1;
512 memcpy(s->pal, pal, AVPALETTE_SIZE);
515 /* make the palette available on the way out */
516 memcpy(s->frame.data[1], s->pal, AVPALETTE_SIZE);
520 *data_size = sizeof(AVFrame);
521 *(AVFrame*)data = s->frame;
523 /* always report that the buffer was completely consumed */
527 static av_cold int qtrle_decode_end(AVCodecContext *avctx)
529 QtrleContext *s = avctx->priv_data;
531 if (s->frame.data[0])
532 avctx->release_buffer(avctx, &s->frame);
537 AVCodec ff_qtrle_decoder = {
539 .type = AVMEDIA_TYPE_VIDEO,
540 .id = CODEC_ID_QTRLE,
541 .priv_data_size = sizeof(QtrleContext),
542 .init = qtrle_decode_init,
543 .close = qtrle_decode_end,
544 .decode = qtrle_decode_frame,
545 .capabilities = CODEC_CAP_DR1,
546 .long_name = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),