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 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;
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://ffmpeg.org/trac/ffmpeg/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 = (signed char)bytestream2_get_byte(&s->g);
86 pixel_ptr = row_ptr + 2 * (skip & 0x7f);
88 pixel_ptr += 2 * 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);
105 rgb[pixel_ptr++] = pi0;
106 rgb[pixel_ptr++] = pi1;
109 /* copy the same pixel directly to output 2 times */
111 CHECK_PIXEL_PTR(rle_code);
114 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
119 static inline void qtrle_decode_2n4bpp(QtrleContext *s, int row_ptr,
120 int lines_to_change, int bpp)
124 int row_inc = s->frame.linesize[0];
125 unsigned char pi[16]; /* 16 palette indices */
126 unsigned char *rgb = s->frame.data[0];
127 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
128 int num_pixels = (bpp == 4) ? 8 : 16;
130 while (lines_to_change--) {
131 pixel_ptr = row_ptr + (num_pixels * (bytestream2_get_byte(&s->g) - 1));
134 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
136 /* there's another skip code in the stream */
137 pixel_ptr += (num_pixels * (bytestream2_get_byte(&s->g) - 1));
138 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
139 } else if (rle_code < 0) {
140 /* decode the run length code */
141 rle_code = -rle_code;
142 /* get the next 4 bytes from the stream, treat them as palette
143 * indexes, and output them rle_code times */
144 for (i = num_pixels-1; i >= 0; i--) {
145 pi[num_pixels-1-i] = (bytestream2_peek_byte(&s->g) >> ((i*bpp) & 0x07)) & ((1<<bpp)-1);
146 bytestream2_skip(&s->g, ((i & ((num_pixels>>2)-1)) == 0));
148 CHECK_PIXEL_PTR(rle_code * num_pixels);
150 for (i = 0; i < num_pixels; i++)
151 rgb[pixel_ptr++] = pi[i];
154 /* copy the same pixel directly to output 4 times */
156 CHECK_PIXEL_PTR(rle_code*(num_pixels>>2));
159 int x = bytestream2_get_byte(&s->g);
160 rgb[pixel_ptr++] = (x >> 4) & 0x0f;
161 rgb[pixel_ptr++] = x & 0x0f;
163 int x = bytestream2_get_byte(&s->g);
164 rgb[pixel_ptr++] = (x >> 6) & 0x03;
165 rgb[pixel_ptr++] = (x >> 4) & 0x03;
166 rgb[pixel_ptr++] = (x >> 2) & 0x03;
167 rgb[pixel_ptr++] = x & 0x03;
176 static void qtrle_decode_8bpp(QtrleContext *s, int row_ptr, int lines_to_change)
180 int row_inc = s->frame.linesize[0];
181 unsigned char pi1, pi2, pi3, pi4; /* 4 palette indexes */
182 unsigned char *rgb = s->frame.data[0];
183 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
185 while (lines_to_change--) {
186 pixel_ptr = row_ptr + (4 * (bytestream2_get_byte(&s->g) - 1));
189 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
191 /* there's another skip code in the stream */
192 pixel_ptr += (4 * (bytestream2_get_byte(&s->g) - 1));
193 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
194 } else if (rle_code < 0) {
195 /* decode the run length code */
196 rle_code = -rle_code;
197 /* get the next 4 bytes from the stream, treat them as palette
198 * indexes, and output them rle_code times */
199 pi1 = bytestream2_get_byte(&s->g);
200 pi2 = bytestream2_get_byte(&s->g);
201 pi3 = bytestream2_get_byte(&s->g);
202 pi4 = bytestream2_get_byte(&s->g);
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_PIXEL_PTR(rle_code);
218 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
226 static void qtrle_decode_16bpp(QtrleContext *s, int row_ptr, int lines_to_change)
230 int row_inc = s->frame.linesize[0];
231 unsigned short rgb16;
232 unsigned char *rgb = s->frame.data[0];
233 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
235 while (lines_to_change--) {
236 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 2;
239 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
241 /* there's another skip code in the stream */
242 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 2;
243 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
244 } else if (rle_code < 0) {
245 /* decode the run length code */
246 rle_code = -rle_code;
247 rgb16 = bytestream2_get_be16(&s->g);
249 CHECK_PIXEL_PTR(rle_code * 2);
252 *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
256 CHECK_PIXEL_PTR(rle_code * 2);
258 /* copy pixels directly to output */
260 rgb16 = bytestream2_get_be16(&s->g);
261 *(unsigned short *)(&rgb[pixel_ptr]) = rgb16;
270 static void qtrle_decode_24bpp(QtrleContext *s, int row_ptr, int lines_to_change)
274 int row_inc = s->frame.linesize[0];
275 unsigned char r, g, b;
276 unsigned char *rgb = s->frame.data[0];
277 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
279 while (lines_to_change--) {
280 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 3;
283 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
285 /* there's another skip code in the stream */
286 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 3;
287 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
288 } else if (rle_code < 0) {
289 /* decode the run length code */
290 rle_code = -rle_code;
291 r = bytestream2_get_byte(&s->g);
292 g = bytestream2_get_byte(&s->g);
293 b = bytestream2_get_byte(&s->g);
295 CHECK_PIXEL_PTR(rle_code * 3);
298 rgb[pixel_ptr++] = r;
299 rgb[pixel_ptr++] = g;
300 rgb[pixel_ptr++] = b;
303 CHECK_PIXEL_PTR(rle_code * 3);
305 /* copy pixels directly to output */
307 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
308 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
309 rgb[pixel_ptr++] = bytestream2_get_byte(&s->g);
317 static void qtrle_decode_32bpp(QtrleContext *s, int row_ptr, int lines_to_change)
321 int row_inc = s->frame.linesize[0];
323 unsigned char *rgb = s->frame.data[0];
324 int pixel_limit = s->frame.linesize[0] * s->avctx->height;
326 while (lines_to_change--) {
327 pixel_ptr = row_ptr + (bytestream2_get_byte(&s->g) - 1) * 4;
330 while ((rle_code = (signed char)bytestream2_get_byte(&s->g)) != -1) {
332 /* there's another skip code in the stream */
333 pixel_ptr += (bytestream2_get_byte(&s->g) - 1) * 4;
334 CHECK_PIXEL_PTR(0); /* make sure pixel_ptr is positive */
335 } else if (rle_code < 0) {
336 /* decode the run length code */
337 rle_code = -rle_code;
338 argb = bytestream2_get_be32(&s->g);
340 CHECK_PIXEL_PTR(rle_code * 4);
343 AV_WN32A(rgb + pixel_ptr, argb);
347 CHECK_PIXEL_PTR(rle_code * 4);
349 /* copy pixels directly to output */
351 argb = bytestream2_get_be32(&s->g);
352 AV_WN32A(rgb + pixel_ptr, argb);
361 static av_cold int qtrle_decode_init(AVCodecContext *avctx)
363 QtrleContext *s = avctx->priv_data;
366 switch (avctx->bits_per_coded_sample) {
369 avctx->pix_fmt = AV_PIX_FMT_MONOWHITE;
378 avctx->pix_fmt = AV_PIX_FMT_PAL8;
382 avctx->pix_fmt = AV_PIX_FMT_RGB555;
386 avctx->pix_fmt = AV_PIX_FMT_RGB24;
390 avctx->pix_fmt = AV_PIX_FMT_RGB32;
394 av_log (avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
395 avctx->bits_per_coded_sample);
396 return AVERROR_INVALIDDATA;
399 avcodec_get_frame_defaults(&s->frame);
404 static int qtrle_decode_frame(AVCodecContext *avctx,
405 void *data, int *got_frame,
408 QtrleContext *s = avctx->priv_data;
409 int header, start_line;
414 bytestream2_init(&s->g, avpkt->data, avpkt->size);
415 if ((ret = ff_reget_buffer(avctx, &s->frame)) < 0)
418 /* check if this frame is even supposed to change */
422 /* start after the chunk size */
423 bytestream2_seek(&s->g, 4, SEEK_SET);
425 /* fetch the header */
426 header = bytestream2_get_be16(&s->g);
428 /* if a header is present, fetch additional decoding parameters */
429 if (header & 0x0008) {
430 if (avpkt->size < 14)
432 start_line = bytestream2_get_be16(&s->g);
433 bytestream2_skip(&s->g, 2);
434 height = bytestream2_get_be16(&s->g);
435 bytestream2_skip(&s->g, 2);
436 if (height > s->avctx->height - start_line)
440 height = s->avctx->height;
442 row_ptr = s->frame.linesize[0] * start_line;
444 switch (avctx->bits_per_coded_sample) {
447 qtrle_decode_1bpp(s, row_ptr, height);
452 qtrle_decode_2n4bpp(s, row_ptr, height, 2);
458 qtrle_decode_2n4bpp(s, row_ptr, height, 4);
464 qtrle_decode_8bpp(s, row_ptr, height);
469 qtrle_decode_16bpp(s, row_ptr, height);
473 qtrle_decode_24bpp(s, row_ptr, height);
477 qtrle_decode_32bpp(s, row_ptr, height);
481 av_log (s->avctx, AV_LOG_ERROR, "Unsupported colorspace: %d bits/sample?\n",
482 avctx->bits_per_coded_sample);
487 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
490 s->frame.palette_has_changed = 1;
491 memcpy(s->pal, pal, AVPALETTE_SIZE);
494 /* make the palette available on the way out */
495 memcpy(s->frame.data[1], s->pal, AVPALETTE_SIZE);
499 if ((ret = av_frame_ref(data, &s->frame)) < 0)
503 /* always report that the buffer was completely consumed */
507 static av_cold int qtrle_decode_end(AVCodecContext *avctx)
509 QtrleContext *s = avctx->priv_data;
511 av_frame_unref(&s->frame);
516 AVCodec ff_qtrle_decoder = {
518 .type = AVMEDIA_TYPE_VIDEO,
519 .id = AV_CODEC_ID_QTRLE,
520 .priv_data_size = sizeof(QtrleContext),
521 .init = qtrle_decode_init,
522 .close = qtrle_decode_end,
523 .decode = qtrle_decode_frame,
524 .capabilities = CODEC_CAP_DR1,
525 .long_name = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),