2 * FLI/FLC Animation Video Decoder
3 * Copyright (C) 2003, 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 * Autodesk Animator FLI/FLC Video Decoder
25 * by Mike Melanson (melanson@pcisys.net)
26 * for more information on the .fli/.flc file format and all of its many
28 * http://www.compuphase.com/flic.htm
30 * This decoder outputs PAL8/RGB555/RGB565 and maybe one day RGB24
31 * colorspace data, depending on the FLC. To use this decoder, be
32 * sure that your demuxer sends the FLI file header to the decoder via
33 * the extradata chunk in AVCodecContext. The chunk should be 128 bytes
34 * large. The only exception is for FLI files from the game "Magic Carpet",
35 * in which the header is only 12 bytes.
42 #include "libavutil/intreadwrite.h"
45 #define FLI_256_COLOR 4
53 #define FLI_DTA_BRUN 25
54 #define FLI_DTA_COPY 26
57 #define FLI_TYPE_CODE (0xAF11)
58 #define FLC_FLX_TYPE_CODE (0xAF12)
59 #define FLC_DTA_TYPE_CODE (0xAF44) /* Marks an "Extended FLC" comes from Dave's Targa Animator (DTA) */
60 #define FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE (0xAF13)
62 #define CHECK_PIXEL_PTR(n) \
63 if (pixel_ptr + n > pixel_limit) { \
64 av_log (s->avctx, AV_LOG_INFO, "Problem: pixel_ptr >= pixel_limit (%d >= %d)\n", \
65 pixel_ptr + n, pixel_limit); \
69 typedef struct FlicDecodeContext {
70 AVCodecContext *avctx;
73 unsigned int palette[256];
75 int fli_type; /* either 0xAF11 or 0xAF12, affects palette resolution */
78 static av_cold int flic_decode_init(AVCodecContext *avctx)
80 FlicDecodeContext *s = avctx->priv_data;
81 unsigned char *fli_header = (unsigned char *)avctx->extradata;
86 s->fli_type = AV_RL16(&fli_header[4]); /* Might be overridden if a Magic Carpet FLC */
89 if (s->avctx->extradata_size == 12) {
90 /* special case for magic carpet FLIs */
91 s->fli_type = FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE;
93 } else if (s->avctx->extradata_size != 128) {
94 av_log(avctx, AV_LOG_ERROR, "Expected extradata of 12 or 128 bytes\n");
97 depth = AV_RL16(&fli_header[12]);
101 depth = 8; /* Some FLC generators set depth to zero, when they mean 8Bpp. Fix up here */
104 if ((s->fli_type == FLC_FLX_TYPE_CODE) && (depth == 16)) {
105 depth = 15; /* Original Autodesk FLX's say the depth is 16Bpp when it is really 15Bpp */
109 case 8 : avctx->pix_fmt = PIX_FMT_PAL8; break;
110 case 15 : avctx->pix_fmt = PIX_FMT_RGB555; break;
111 case 16 : avctx->pix_fmt = PIX_FMT_RGB565; break;
112 case 24 : avctx->pix_fmt = PIX_FMT_BGR24; /* Supposedly BGR, but havent any files to test with */
113 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC/FLX is unsupported due to no test files.\n");
116 av_log(avctx, AV_LOG_ERROR, "Unknown FLC/FLX depth of %d Bpp is unsupported.\n",depth);
120 s->frame.data[0] = NULL;
126 static int flic_decode_frame_8BPP(AVCodecContext *avctx,
127 void *data, int *data_size,
128 const uint8_t *buf, int buf_size)
130 FlicDecodeContext *s = avctx->priv_data;
133 int stream_ptr_after_color_chunk;
136 unsigned char palette_idx1;
137 unsigned char palette_idx2;
139 unsigned int frame_size;
142 unsigned int chunk_size;
150 unsigned char r, g, b;
153 int compressed_lines;
155 signed short line_packets;
160 unsigned char *pixels;
161 unsigned int pixel_limit;
163 s->frame.reference = 1;
164 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
165 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
166 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
170 pixels = s->frame.data[0];
171 pixel_limit = s->avctx->height * s->frame.linesize[0];
173 frame_size = AV_RL32(&buf[stream_ptr]);
174 stream_ptr += 6; /* skip the magic number */
175 num_chunks = AV_RL16(&buf[stream_ptr]);
176 stream_ptr += 10; /* skip padding */
180 /* iterate through the chunks */
181 while ((frame_size > 0) && (num_chunks > 0)) {
182 chunk_size = AV_RL32(&buf[stream_ptr]);
184 chunk_type = AV_RL16(&buf[stream_ptr]);
187 switch (chunk_type) {
190 stream_ptr_after_color_chunk = stream_ptr + chunk_size - 6;
192 /* check special case: If this file is from the Magic Carpet
193 * game and uses 6-bit colors even though it reports 256-color
194 * chunks in a 0xAF12-type file (fli_type is set to 0xAF13 during
196 if ((chunk_type == FLI_256_COLOR) && (s->fli_type != FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE))
200 /* set up the palette */
201 color_packets = AV_RL16(&buf[stream_ptr]);
204 for (i = 0; i < color_packets; i++) {
205 /* first byte is how many colors to skip */
206 palette_ptr += buf[stream_ptr++];
208 /* next byte indicates how many entries to change */
209 color_changes = buf[stream_ptr++];
211 /* if there are 0 color changes, there are actually 256 */
212 if (color_changes == 0)
215 for (j = 0; j < color_changes; j++) {
218 /* wrap around, for good measure */
219 if ((unsigned)palette_ptr >= 256)
222 r = buf[stream_ptr++] << color_shift;
223 g = buf[stream_ptr++] << color_shift;
224 b = buf[stream_ptr++] << color_shift;
225 entry = (r << 16) | (g << 8) | b;
226 if (s->palette[palette_ptr] != entry)
228 s->palette[palette_ptr++] = entry;
232 /* color chunks sometimes have weird 16-bit alignment issues;
233 * therefore, take the hardline approach and set the stream_ptr
234 * to the value calculated w.r.t. the size specified by the color
236 stream_ptr = stream_ptr_after_color_chunk;
242 compressed_lines = AV_RL16(&buf[stream_ptr]);
244 while (compressed_lines > 0) {
245 line_packets = AV_RL16(&buf[stream_ptr]);
247 if ((line_packets & 0xC000) == 0xC000) {
249 line_packets = -line_packets;
250 y_ptr += line_packets * s->frame.linesize[0];
251 } else if ((line_packets & 0xC000) == 0x4000) {
252 av_log(avctx, AV_LOG_ERROR, "Undefined opcode (%x) in DELTA_FLI\n", line_packets);
253 } else if ((line_packets & 0xC000) == 0x8000) {
254 // "last byte" opcode
255 pixel_ptr= y_ptr + s->frame.linesize[0] - 1;
257 pixels[pixel_ptr] = line_packets & 0xff;
262 pixel_countdown = s->avctx->width;
263 for (i = 0; i < line_packets; i++) {
264 /* account for the skip bytes */
265 pixel_skip = buf[stream_ptr++];
266 pixel_ptr += pixel_skip;
267 pixel_countdown -= pixel_skip;
268 byte_run = (signed char)(buf[stream_ptr++]);
270 byte_run = -byte_run;
271 palette_idx1 = buf[stream_ptr++];
272 palette_idx2 = buf[stream_ptr++];
273 CHECK_PIXEL_PTR(byte_run * 2);
274 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
275 pixels[pixel_ptr++] = palette_idx1;
276 pixels[pixel_ptr++] = palette_idx2;
279 CHECK_PIXEL_PTR(byte_run * 2);
280 for (j = 0; j < byte_run * 2; j++, pixel_countdown--) {
281 palette_idx1 = buf[stream_ptr++];
282 pixels[pixel_ptr++] = palette_idx1;
287 y_ptr += s->frame.linesize[0];
293 /* line compressed */
294 starting_line = AV_RL16(&buf[stream_ptr]);
297 y_ptr += starting_line * s->frame.linesize[0];
299 compressed_lines = AV_RL16(&buf[stream_ptr]);
301 while (compressed_lines > 0) {
304 pixel_countdown = s->avctx->width;
305 line_packets = buf[stream_ptr++];
306 if (line_packets > 0) {
307 for (i = 0; i < line_packets; i++) {
308 /* account for the skip bytes */
309 pixel_skip = buf[stream_ptr++];
310 pixel_ptr += pixel_skip;
311 pixel_countdown -= pixel_skip;
312 byte_run = (signed char)(buf[stream_ptr++]);
314 CHECK_PIXEL_PTR(byte_run);
315 for (j = 0; j < byte_run; j++, pixel_countdown--) {
316 palette_idx1 = buf[stream_ptr++];
317 pixels[pixel_ptr++] = palette_idx1;
319 } else if (byte_run < 0) {
320 byte_run = -byte_run;
321 palette_idx1 = buf[stream_ptr++];
322 CHECK_PIXEL_PTR(byte_run);
323 for (j = 0; j < byte_run; j++, pixel_countdown--) {
324 pixels[pixel_ptr++] = palette_idx1;
330 y_ptr += s->frame.linesize[0];
336 /* set the whole frame to color 0 (which is usually black) */
338 s->frame.linesize[0] * s->avctx->height);
342 /* Byte run compression: This chunk type only occurs in the first
343 * FLI frame and it will update the entire frame. */
345 for (lines = 0; lines < s->avctx->height; lines++) {
347 /* disregard the line packets; instead, iterate through all
350 pixel_countdown = s->avctx->width;
351 while (pixel_countdown > 0) {
352 byte_run = (signed char)(buf[stream_ptr++]);
354 palette_idx1 = buf[stream_ptr++];
355 CHECK_PIXEL_PTR(byte_run);
356 for (j = 0; j < byte_run; j++) {
357 pixels[pixel_ptr++] = palette_idx1;
359 if (pixel_countdown < 0)
360 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
361 pixel_countdown, lines);
363 } else { /* copy bytes if byte_run < 0 */
364 byte_run = -byte_run;
365 CHECK_PIXEL_PTR(byte_run);
366 for (j = 0; j < byte_run; j++) {
367 palette_idx1 = buf[stream_ptr++];
368 pixels[pixel_ptr++] = palette_idx1;
370 if (pixel_countdown < 0)
371 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
372 pixel_countdown, lines);
377 y_ptr += s->frame.linesize[0];
382 /* copy the chunk (uncompressed frame) */
383 if (chunk_size - 6 > s->avctx->width * s->avctx->height) {
384 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
385 "bigger than image, skipping chunk\n", chunk_size - 6);
386 stream_ptr += chunk_size - 6;
388 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
389 y_ptr += s->frame.linesize[0]) {
390 memcpy(&pixels[y_ptr], &buf[stream_ptr],
392 stream_ptr += s->avctx->width;
398 /* some sort of a thumbnail? disregard this chunk... */
399 stream_ptr += chunk_size - 6;
403 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
407 frame_size -= chunk_size;
411 /* by the end of the chunk, the stream ptr should equal the frame
412 * size (minus 1, possibly); if it doesn't, issue a warning */
413 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
414 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
415 "and final chunk ptr = %d\n", buf_size, stream_ptr);
417 /* make the palette available on the way out */
418 memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
419 if (s->new_palette) {
420 s->frame.palette_has_changed = 1;
424 *data_size=sizeof(AVFrame);
425 *(AVFrame*)data = s->frame;
430 static int flic_decode_frame_15_16BPP(AVCodecContext *avctx,
431 void *data, int *data_size,
432 const uint8_t *buf, int buf_size)
434 /* Note, the only difference between the 15Bpp and 16Bpp */
435 /* Format is the pixel format, the packets are processed the same. */
436 FlicDecodeContext *s = avctx->priv_data;
440 unsigned char palette_idx1;
442 unsigned int frame_size;
445 unsigned int chunk_size;
451 int compressed_lines;
452 signed short line_packets;
457 unsigned char *pixels;
459 unsigned int pixel_limit;
461 s->frame.reference = 1;
462 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
463 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
464 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
468 pixels = s->frame.data[0];
469 pixel_limit = s->avctx->height * s->frame.linesize[0];
471 frame_size = AV_RL32(&buf[stream_ptr]);
472 stream_ptr += 6; /* skip the magic number */
473 num_chunks = AV_RL16(&buf[stream_ptr]);
474 stream_ptr += 10; /* skip padding */
478 /* iterate through the chunks */
479 while ((frame_size > 0) && (num_chunks > 0)) {
480 chunk_size = AV_RL32(&buf[stream_ptr]);
482 chunk_type = AV_RL16(&buf[stream_ptr]);
485 switch (chunk_type) {
488 /* For some reason, it seems that non-palettized flics do
489 * include one of these chunks in their first frame.
490 * Why I do not know, it seems rather extraneous. */
491 /* av_log(avctx, AV_LOG_ERROR, "Unexpected Palette chunk %d in non-paletised FLC\n",chunk_type);*/
492 stream_ptr = stream_ptr + chunk_size - 6;
498 compressed_lines = AV_RL16(&buf[stream_ptr]);
500 while (compressed_lines > 0) {
501 line_packets = AV_RL16(&buf[stream_ptr]);
503 if (line_packets < 0) {
504 line_packets = -line_packets;
505 y_ptr += line_packets * s->frame.linesize[0];
510 pixel_countdown = s->avctx->width;
511 for (i = 0; i < line_packets; i++) {
512 /* account for the skip bytes */
513 pixel_skip = buf[stream_ptr++];
514 pixel_ptr += (pixel_skip*2); /* Pixel is 2 bytes wide */
515 pixel_countdown -= pixel_skip;
516 byte_run = (signed char)(buf[stream_ptr++]);
518 byte_run = -byte_run;
519 pixel = AV_RL16(&buf[stream_ptr]);
521 CHECK_PIXEL_PTR(2 * byte_run);
522 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
523 *((signed short*)(&pixels[pixel_ptr])) = pixel;
527 CHECK_PIXEL_PTR(2 * byte_run);
528 for (j = 0; j < byte_run; j++, pixel_countdown--) {
529 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[stream_ptr]);
536 y_ptr += s->frame.linesize[0];
542 av_log(avctx, AV_LOG_ERROR, "Unexpected FLI_LC chunk in non-paletised FLC\n");
543 stream_ptr = stream_ptr + chunk_size - 6;
547 /* set the whole frame to 0x0000 which is black in both 15Bpp and 16Bpp modes. */
548 memset(pixels, 0x0000,
549 s->frame.linesize[0] * s->avctx->height);
554 for (lines = 0; lines < s->avctx->height; lines++) {
556 /* disregard the line packets; instead, iterate through all
559 pixel_countdown = (s->avctx->width * 2);
561 while (pixel_countdown > 0) {
562 byte_run = (signed char)(buf[stream_ptr++]);
564 palette_idx1 = buf[stream_ptr++];
565 CHECK_PIXEL_PTR(byte_run);
566 for (j = 0; j < byte_run; j++) {
567 pixels[pixel_ptr++] = palette_idx1;
569 if (pixel_countdown < 0)
570 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) (linea%d)\n",
571 pixel_countdown, lines);
573 } else { /* copy bytes if byte_run < 0 */
574 byte_run = -byte_run;
575 CHECK_PIXEL_PTR(byte_run);
576 for (j = 0; j < byte_run; j++) {
577 palette_idx1 = buf[stream_ptr++];
578 pixels[pixel_ptr++] = palette_idx1;
580 if (pixel_countdown < 0)
581 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
582 pixel_countdown, lines);
587 /* Now FLX is strange, in that it is "byte" as opposed to "pixel" run length compressed.
588 * This does not give us any good oportunity to perform word endian conversion
589 * during decompression. So if it is required (i.e., this is not a LE target, we do
590 * a second pass over the line here, swapping the bytes.
594 pixel_countdown = s->avctx->width;
595 while (pixel_countdown > 0) {
596 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[pixel_ptr]);
600 y_ptr += s->frame.linesize[0];
606 for (lines = 0; lines < s->avctx->height; lines++) {
608 /* disregard the line packets; instead, iterate through all
611 pixel_countdown = s->avctx->width; /* Width is in pixels, not bytes */
613 while (pixel_countdown > 0) {
614 byte_run = (signed char)(buf[stream_ptr++]);
616 pixel = AV_RL16(&buf[stream_ptr]);
618 CHECK_PIXEL_PTR(2 * byte_run);
619 for (j = 0; j < byte_run; j++) {
620 *((signed short*)(&pixels[pixel_ptr])) = pixel;
623 if (pixel_countdown < 0)
624 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
627 } else { /* copy pixels if byte_run < 0 */
628 byte_run = -byte_run;
629 CHECK_PIXEL_PTR(2 * byte_run);
630 for (j = 0; j < byte_run; j++) {
631 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[stream_ptr]);
635 if (pixel_countdown < 0)
636 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
642 y_ptr += s->frame.linesize[0];
648 /* copy the chunk (uncompressed frame) */
649 if (chunk_size - 6 > (unsigned int)(s->avctx->width * s->avctx->height)*2) {
650 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
651 "bigger than image, skipping chunk\n", chunk_size - 6);
652 stream_ptr += chunk_size - 6;
655 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
656 y_ptr += s->frame.linesize[0]) {
658 pixel_countdown = s->avctx->width;
660 while (pixel_countdown > 0) {
661 *((signed short*)(&pixels[y_ptr + pixel_ptr])) = AV_RL16(&buf[stream_ptr+pixel_ptr]);
665 stream_ptr += s->avctx->width*2;
671 /* some sort of a thumbnail? disregard this chunk... */
672 stream_ptr += chunk_size - 6;
676 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
680 frame_size -= chunk_size;
684 /* by the end of the chunk, the stream ptr should equal the frame
685 * size (minus 1, possibly); if it doesn't, issue a warning */
686 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
687 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
688 "and final chunk ptr = %d\n", buf_size, stream_ptr);
691 *data_size=sizeof(AVFrame);
692 *(AVFrame*)data = s->frame;
697 static int flic_decode_frame_24BPP(AVCodecContext *avctx,
698 void *data, int *data_size,
699 const uint8_t *buf, int buf_size)
701 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC Unsupported due to lack of test files.\n");
705 static int flic_decode_frame(AVCodecContext *avctx,
706 void *data, int *data_size,
709 const uint8_t *buf = avpkt->data;
710 int buf_size = avpkt->size;
711 if (avctx->pix_fmt == PIX_FMT_PAL8) {
712 return flic_decode_frame_8BPP(avctx, data, data_size,
715 else if ((avctx->pix_fmt == PIX_FMT_RGB555) ||
716 (avctx->pix_fmt == PIX_FMT_RGB565)) {
717 return flic_decode_frame_15_16BPP(avctx, data, data_size,
720 else if (avctx->pix_fmt == PIX_FMT_BGR24) {
721 return flic_decode_frame_24BPP(avctx, data, data_size,
725 /* Should not get here, ever as the pix_fmt is processed */
726 /* in flic_decode_init and the above if should deal with */
727 /* the finite set of possibilites allowable by here. */
728 /* But in case we do, just error out. */
729 av_log(avctx, AV_LOG_ERROR, "Unknown FLC format, my science cannot explain how this happened.\n");
734 static av_cold int flic_decode_end(AVCodecContext *avctx)
736 FlicDecodeContext *s = avctx->priv_data;
738 if (s->frame.data[0])
739 avctx->release_buffer(avctx, &s->frame);
744 AVCodec ff_flic_decoder = {
746 .type = AVMEDIA_TYPE_VIDEO,
748 .priv_data_size = sizeof(FlicDecodeContext),
749 .init = flic_decode_init,
750 .close = flic_decode_end,
751 .decode = flic_decode_frame,
752 .capabilities = CODEC_CAP_DR1,
753 .long_name = NULL_IF_CONFIG_SMALL("Autodesk Animator Flic video"),