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"
41 typedef struct QtrleContext {
42 AVCodecContext *avctx;
49 #define CHECK_PIXEL_PTR(n) \
50 if ((pixel_ptr + n > pixel_limit) || (pixel_ptr + n < 0)) { \
51 av_log (s->avctx, AV_LOG_INFO, "Problem: pixel_ptr = %d, pixel_limit = %d\n", \
52 pixel_ptr + n, pixel_limit); \
56 static void qtrle_decode_1bpp(QtrleContext *s, int row_ptr, int lines_to_change)
60 int row_inc = s->frame.linesize[0];
61 unsigned char pi0, pi1; /* 2 8-pixel values */
62 unsigned char *rgb = s->frame.data[0];
63 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
69 while (lines_to_change) {
70 skip = bytestream2_get_byte(&s->g);
71 rle_code = (signed char)bytestream2_get_byte(&s->g);
77 pixel_ptr = row_ptr + 2 * (skip & 0x7f);
79 pixel_ptr += 2 * skip;
80 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
83 /* decode the run length code */
85 /* get the next 2 bytes from the stream, treat them as groups
86 * of 8 pixels, and output them rle_code times */
88 pi0 = bytestream2_get_byte(&s->g);
89 pi1 = bytestream2_get_byte(&s->g);
90 CHECK_PIXEL_PTR(rle_code * 2);
93 rgb[pixel_ptr++] = pi0;
94 rgb[pixel_ptr++] = pi1;
97 /* copy the same pixel directly to output 2 times */
99 CHECK_PIXEL_PTR(rle_code);
102 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
107 static inline void qtrle_decode_2n4bpp(QtrleContext *s, int row_ptr,
108 int lines_to_change, int bpp)
112 int row_inc = s->frame.linesize[0];
113 unsigned char pi[16]; /* 16 palette indices */
114 unsigned char *rgb = s->frame.data[0];
115 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
116 int num_pixels = (bpp == 4) ? 8 : 16;
118 while (lines_to_change--) {
119 pixel_ptr = row_ptr + (num_pixels * (bytestream2_get_byte(&s->g) - 1));
121 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
123 /* there's another skip code in the stream */
124 pixel_ptr += (num_pixels * (bytestream2_get_byte(&s->g) - 1));
125 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
126 } else if (rle_code < 0) {
127 /* decode the run length code */
128 rle_code = -rle_code;
129 /* get the next 4 bytes from the stream, treat them as palette
130 * indexes, and output them rle_code times */
131 for (i = num_pixels-1; i >= 0; i--) {
132 pi[num_pixels-1-i] = (bytestream2_peek_byte(&s->g) >> ((i*bpp) & 0x07)) & ((1<<bpp)-1);
133 bytestream2_skip(&s->g, ((i & ((num_pixels>>2)-1)) == 0));
135 CHECK_PIXEL_PTR(rle_code * num_pixels);
137 for (i = 0; i < num_pixels; i++)
138 rgb[pixel_ptr++] = pi[i];
141 /* copy the same pixel directly to output 4 times */
143 CHECK_PIXEL_PTR(rle_code*(num_pixels>>2));
146 int x = bytestream2_get_byte(&s->g);
147 rgb[pixel_ptr++] = (x >> 4) & 0x0f;
148 rgb[pixel_ptr++] = x & 0x0f;
150 int x = bytestream2_get_byte(&s->g);
151 rgb[pixel_ptr++] = (x >> 6) & 0x03;
152 rgb[pixel_ptr++] = (x >> 4) & 0x03;
153 rgb[pixel_ptr++] = (x >> 2) & 0x03;
154 rgb[pixel_ptr++] = x & 0x03;
163 static void qtrle_decode_8bpp(QtrleContext *s, int row_ptr, int lines_to_change)
167 int row_inc = s->frame.linesize[0];
168 unsigned char pi1, pi2, pi3, pi4; /* 4 palette indexes */
169 unsigned char *rgb = s->frame.data[0];
170 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
172 while (lines_to_change--) {
173 pixel_ptr = row_ptr + (4 * (bytestream2_get_byte(&s->g) - 1));
175 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
177 /* there's another skip code in the stream */
178 pixel_ptr += (4 * (bytestream2_get_byte(&s->g) - 1));
179 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
180 } else if (rle_code < 0) {
181 /* decode the run length code */
182 rle_code = -rle_code;
183 /* get the next 4 bytes from the stream, treat them as palette
184 * indexes, and output them rle_code times */
185 pi1 = bytestream2_get_byte(&s->g);
186 pi2 = bytestream2_get_byte(&s->g);
187 pi3 = bytestream2_get_byte(&s->g);
188 pi4 = bytestream2_get_byte(&s->g);
190 CHECK_PIXEL_PTR(rle_code * 4);
193 rgb[pixel_ptr++] = pi1;
194 rgb[pixel_ptr++] = pi2;
195 rgb[pixel_ptr++] = pi3;
196 rgb[pixel_ptr++] = pi4;
199 /* copy the same pixel directly to output 4 times */
201 CHECK_PIXEL_PTR(rle_code);
204 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
212 static void qtrle_decode_16bpp(QtrleContext *s, int row_ptr, int lines_to_change)
216 int row_inc = s->frame.linesize[0];
217 unsigned short rgb16;
218 unsigned char *rgb = s->frame.data[0];
219 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
221 while (lines_to_change--) {
222 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 2;
224 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
226 /* there's another skip code in the stream */
227 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 2;
228 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
229 } else if (rle_code < 0) {
230 /* decode the run length code */
231 rle_code = -rle_code;
232 rgb16 = bytestream2_get_be16(&s->g);
234 CHECK_PIXEL_PTR(rle_code * 2);
237 *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
241 CHECK_PIXEL_PTR(rle_code * 2);
243 /* copy pixels directly to output */
245 rgb16 = bytestream2_get_be16(&s->g);
246 *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
255 static void qtrle_decode_24bpp(QtrleContext *s, int row_ptr, int lines_to_change)
259 int row_inc = s->frame.linesize[0];
260 unsigned char r, g, b;
261 unsigned char *rgb = s->frame.data[0];
262 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
264 while (lines_to_change--) {
265 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 3;
267 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
269 /* there's another skip code in the stream */
270 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 3;
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 r = bytestream2_get_byte(&s->g);
276 g = bytestream2_get_byte(&s->g);
277 b = bytestream2_get_byte(&s->g);
279 CHECK_PIXEL_PTR(rle_code * 3);
282 rgb[pixel_ptr++] = r;
283 rgb[pixel_ptr++] = g;
284 rgb[pixel_ptr++] = b;
287 CHECK_PIXEL_PTR(rle_code * 3);
289 /* copy pixels directly to output */
291 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
292 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
293 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
301 static void qtrle_decode_32bpp(QtrleContext *s, int row_ptr, int lines_to_change)
305 int row_inc = s->frame.linesize[0];
307 unsigned char *rgb = s->frame.data[0];
308 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
310 while (lines_to_change--) {
311 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 4;
313 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
315 /* there's another skip code in the stream */
316 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 4;
317 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
318 } else if (rle_code < 0) {
319 /* decode the run length code */
320 rle_code = -rle_code;
321 argb = bytestream2_get_be32(&s->g);
323 CHECK_PIXEL_PTR(rle_code * 4);
326 AV_WN32A(rgb + pixel_ptr, argb);
330 CHECK_PIXEL_PTR(rle_code * 4);
332 /* copy pixels directly to output */
334 argb = bytestream2_get_be32(&s->g);
335 AV_WN32A(rgb + pixel_ptr, argb);
344 static av_cold int qtrle_decode_init(AVCodecContext *avctx)
346 QtrleContext *s = avctx->priv_data;
349 switch (avctx->bits_per_coded_sample) {
352 avctx->pix_fmt = AV_PIX_FMT_MONOWHITE;
361 avctx->pix_fmt = AV_PIX_FMT_PAL8;
365 avctx->pix_fmt = AV_PIX_FMT_RGB555;
369 avctx->pix_fmt = AV_PIX_FMT_RGB24;
373 avctx->pix_fmt = AV_PIX_FMT_RGB32;
377 av_log (avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
378 avctx->bits_per_coded_sample);
379 return AVERROR_INVALIDDATA;
382 s->frame.data[0] = NULL;
387 static int qtrle_decode_frame(AVCodecContext *avctx,
388 void *data, int *got_frame,
391 QtrleContext *s = avctx->priv_data;
392 int header, start_line;
397 bytestream2_init(&s->g, avpkt->data, avpkt->size);
398 s->frame.reference = 1;
399 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE |
400 FF_BUFFER_HINTS_REUSABLE | FF_BUFFER_HINTS_READABLE;
401 if ((ret = avctx->reget_buffer(avctx, &s->frame)) < 0) {
402 av_log (s->avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
406 /* check if this frame is even supposed to change */
410 /* start after the chunk size */
411 bytestream2_seek(&s->g, 4, SEEK_SET);
413 /* fetch the header */
414 header = bytestream2_get_be16(&s->g);
416 /* if a header is present, fetch additional decoding parameters */
417 if (header & 0x0008) {
418 if (avpkt->size < 14)
420 start_line = bytestream2_get_be16(&s->g);
421 bytestream2_skip(&s->g, 2);
422 height = bytestream2_get_be16(&s->g);
423 bytestream2_skip(&s->g, 2);
426 height = s->avctx->height;
428 row_ptr = s->frame.linesize[0] * start_line;
430 switch (avctx->bits_per_coded_sample) {
433 qtrle_decode_1bpp(s, row_ptr, height);
438 qtrle_decode_2n4bpp(s, row_ptr, height, 2);
444 qtrle_decode_2n4bpp(s, row_ptr, height, 4);
450 qtrle_decode_8bpp(s, row_ptr, height);
455 qtrle_decode_16bpp(s, row_ptr, height);
459 qtrle_decode_24bpp(s, row_ptr, height);
463 qtrle_decode_32bpp(s, row_ptr, height);
467 av_log (s->avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
468 avctx->bits_per_coded_sample);
473 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
476 s->frame.palette_has_changed = 1;
477 memcpy(s->pal, pal, AVPALETTE_SIZE);
480 /* make the palette available on the way out */
481 memcpy(s->frame.data[1], s->pal, AVPALETTE_SIZE);
486 *(AVFrame*)data = s->frame;
488 /* always report that the buffer was completely consumed */
492 static av_cold int qtrle_decode_end(AVCodecContext *avctx)
494 QtrleContext *s = avctx->priv_data;
496 if (s->frame.data[0])
497 avctx->release_buffer(avctx, &s->frame);
502 AVCodec ff_qtrle_decoder = {
504 .type = AVMEDIA_TYPE_VIDEO,
505 .id = AV_CODEC_ID_QTRLE,
506 .priv_data_size = sizeof(QtrleContext),
507 .init = qtrle_decode_init,
508 .close = qtrle_decode_end,
509 .decode = qtrle_decode_frame,
510 .capabilities = CODEC_CAP_DR1,
511 .long_name = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),