2 * FLI/FLC Animation Video Decoder
3 * Copyright (C) 2003, 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 * 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_ERROR, "Invalid pixel_ptr = %d > pixel_limit = %d\n", \
65 pixel_ptr + n, pixel_limit); \
66 return AVERROR_INVALIDDATA; \
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");
117 av_log(avctx, AV_LOG_ERROR, "Unknown FLC/FLX depth of %d Bpp is unsupported.\n",depth);
121 avcodec_get_frame_defaults(&s->frame);
122 s->frame.data[0] = NULL;
128 static int flic_decode_frame_8BPP(AVCodecContext *avctx,
129 void *data, int *data_size,
130 const uint8_t *buf, int buf_size)
132 FlicDecodeContext *s = avctx->priv_data;
135 int stream_ptr_after_color_chunk;
138 unsigned char palette_idx1;
139 unsigned char palette_idx2;
141 unsigned int frame_size;
144 unsigned int chunk_size;
152 unsigned char r, g, b;
155 int compressed_lines;
157 signed short line_packets;
162 unsigned char *pixels;
163 unsigned int pixel_limit;
165 s->frame.reference = 1;
166 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
167 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
168 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
172 pixels = s->frame.data[0];
173 pixel_limit = s->avctx->height * s->frame.linesize[0];
175 frame_size = AV_RL32(&buf[stream_ptr]);
176 stream_ptr += 6; /* skip the magic number */
177 num_chunks = AV_RL16(&buf[stream_ptr]);
178 stream_ptr += 10; /* skip padding */
182 /* iterate through the chunks */
183 while ((frame_size > 0) && (num_chunks > 0)) {
184 chunk_size = AV_RL32(&buf[stream_ptr]);
185 if (chunk_size > frame_size) {
186 av_log(avctx, AV_LOG_WARNING,
187 "Invalid chunk_size = %u > frame_size = %u\n", chunk_size, frame_size);
188 chunk_size = frame_size;
191 chunk_type = AV_RL16(&buf[stream_ptr]);
194 switch (chunk_type) {
197 stream_ptr_after_color_chunk = stream_ptr + chunk_size - 6;
199 /* check special case: If this file is from the Magic Carpet
200 * game and uses 6-bit colors even though it reports 256-color
201 * chunks in a 0xAF12-type file (fli_type is set to 0xAF13 during
203 if ((chunk_type == FLI_256_COLOR) && (s->fli_type != FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE))
207 /* set up the palette */
208 color_packets = AV_RL16(&buf[stream_ptr]);
211 for (i = 0; i < color_packets; i++) {
212 /* first byte is how many colors to skip */
213 palette_ptr += buf[stream_ptr++];
215 /* next byte indicates how many entries to change */
216 color_changes = buf[stream_ptr++];
218 /* if there are 0 color changes, there are actually 256 */
219 if (color_changes == 0)
222 for (j = 0; j < color_changes; j++) {
225 /* wrap around, for good measure */
226 if ((unsigned)palette_ptr >= 256)
229 r = buf[stream_ptr++] << color_shift;
230 g = buf[stream_ptr++] << color_shift;
231 b = buf[stream_ptr++] << color_shift;
232 entry = (r << 16) | (g << 8) | b;
233 if (s->palette[palette_ptr] != entry)
235 s->palette[palette_ptr++] = entry;
239 /* color chunks sometimes have weird 16-bit alignment issues;
240 * therefore, take the hardline approach and set the stream_ptr
241 * to the value calculated w.r.t. the size specified by the color
243 stream_ptr = stream_ptr_after_color_chunk;
249 compressed_lines = AV_RL16(&buf[stream_ptr]);
251 while (compressed_lines > 0) {
252 line_packets = AV_RL16(&buf[stream_ptr]);
254 if ((line_packets & 0xC000) == 0xC000) {
256 line_packets = -line_packets;
257 y_ptr += line_packets * s->frame.linesize[0];
258 } else if ((line_packets & 0xC000) == 0x4000) {
259 av_log(avctx, AV_LOG_ERROR, "Undefined opcode (%x) in DELTA_FLI\n", line_packets);
260 } else if ((line_packets & 0xC000) == 0x8000) {
261 // "last byte" opcode
262 pixel_ptr= y_ptr + s->frame.linesize[0] - 1;
264 pixels[pixel_ptr] = line_packets & 0xff;
269 pixel_countdown = s->avctx->width;
270 for (i = 0; i < line_packets; i++) {
271 /* account for the skip bytes */
272 pixel_skip = buf[stream_ptr++];
273 pixel_ptr += pixel_skip;
274 pixel_countdown -= pixel_skip;
275 byte_run = (signed char)(buf[stream_ptr++]);
277 byte_run = -byte_run;
278 palette_idx1 = buf[stream_ptr++];
279 palette_idx2 = buf[stream_ptr++];
280 CHECK_PIXEL_PTR(byte_run * 2);
281 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
282 pixels[pixel_ptr++] = palette_idx1;
283 pixels[pixel_ptr++] = palette_idx2;
286 CHECK_PIXEL_PTR(byte_run * 2);
287 for (j = 0; j < byte_run * 2; j++, pixel_countdown--) {
288 palette_idx1 = buf[stream_ptr++];
289 pixels[pixel_ptr++] = palette_idx1;
294 y_ptr += s->frame.linesize[0];
300 /* line compressed */
301 starting_line = AV_RL16(&buf[stream_ptr]);
304 y_ptr += starting_line * s->frame.linesize[0];
306 compressed_lines = AV_RL16(&buf[stream_ptr]);
308 while (compressed_lines > 0) {
311 pixel_countdown = s->avctx->width;
312 line_packets = buf[stream_ptr++];
313 if (line_packets > 0) {
314 for (i = 0; i < line_packets; i++) {
315 /* account for the skip bytes */
316 pixel_skip = buf[stream_ptr++];
317 pixel_ptr += pixel_skip;
318 pixel_countdown -= pixel_skip;
319 byte_run = (signed char)(buf[stream_ptr++]);
321 CHECK_PIXEL_PTR(byte_run);
322 for (j = 0; j < byte_run; j++, pixel_countdown--) {
323 palette_idx1 = buf[stream_ptr++];
324 pixels[pixel_ptr++] = palette_idx1;
326 } else if (byte_run < 0) {
327 byte_run = -byte_run;
328 palette_idx1 = buf[stream_ptr++];
329 CHECK_PIXEL_PTR(byte_run);
330 for (j = 0; j < byte_run; j++, pixel_countdown--) {
331 pixels[pixel_ptr++] = palette_idx1;
337 y_ptr += s->frame.linesize[0];
343 /* set the whole frame to color 0 (which is usually black) */
345 s->frame.linesize[0] * s->avctx->height);
349 /* Byte run compression: This chunk type only occurs in the first
350 * FLI frame and it will update the entire frame. */
352 for (lines = 0; lines < s->avctx->height; lines++) {
354 /* disregard the line packets; instead, iterate through all
357 pixel_countdown = s->avctx->width;
358 while (pixel_countdown > 0) {
359 byte_run = (signed char)(buf[stream_ptr++]);
361 palette_idx1 = buf[stream_ptr++];
362 CHECK_PIXEL_PTR(byte_run);
363 for (j = 0; j < byte_run; j++) {
364 pixels[pixel_ptr++] = palette_idx1;
366 if (pixel_countdown < 0)
367 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
368 pixel_countdown, lines);
370 } else { /* copy bytes if byte_run < 0 */
371 byte_run = -byte_run;
372 CHECK_PIXEL_PTR(byte_run);
373 for (j = 0; j < byte_run; j++) {
374 palette_idx1 = buf[stream_ptr++];
375 pixels[pixel_ptr++] = palette_idx1;
377 if (pixel_countdown < 0)
378 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
379 pixel_countdown, lines);
384 y_ptr += s->frame.linesize[0];
389 /* copy the chunk (uncompressed frame) */
390 if (chunk_size - 6 > s->avctx->width * s->avctx->height) {
391 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
392 "bigger than image, skipping chunk\n", chunk_size - 6);
393 stream_ptr += chunk_size - 6;
395 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
396 y_ptr += s->frame.linesize[0]) {
397 memcpy(&pixels[y_ptr], &buf[stream_ptr],
399 stream_ptr += s->avctx->width;
405 /* some sort of a thumbnail? disregard this chunk... */
406 stream_ptr += chunk_size - 6;
410 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
414 frame_size -= chunk_size;
418 /* by the end of the chunk, the stream ptr should equal the frame
419 * size (minus 1, possibly); if it doesn't, issue a warning */
420 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
421 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
422 "and final chunk ptr = %d\n", buf_size, stream_ptr);
424 /* make the palette available on the way out */
425 memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
426 if (s->new_palette) {
427 s->frame.palette_has_changed = 1;
431 *data_size=sizeof(AVFrame);
432 *(AVFrame*)data = s->frame;
437 static int flic_decode_frame_15_16BPP(AVCodecContext *avctx,
438 void *data, int *data_size,
439 const uint8_t *buf, int buf_size)
441 /* Note, the only difference between the 15Bpp and 16Bpp */
442 /* Format is the pixel format, the packets are processed the same. */
443 FlicDecodeContext *s = avctx->priv_data;
447 unsigned char palette_idx1;
449 unsigned int frame_size;
452 unsigned int chunk_size;
458 int compressed_lines;
459 signed short line_packets;
464 unsigned char *pixels;
466 unsigned int pixel_limit;
468 s->frame.reference = 1;
469 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
470 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
471 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
475 pixels = s->frame.data[0];
476 pixel_limit = s->avctx->height * s->frame.linesize[0];
478 frame_size = AV_RL32(&buf[stream_ptr]);
479 stream_ptr += 6; /* skip the magic number */
480 num_chunks = AV_RL16(&buf[stream_ptr]);
481 stream_ptr += 10; /* skip padding */
485 /* iterate through the chunks */
486 while ((frame_size > 0) && (num_chunks > 0)) {
487 chunk_size = AV_RL32(&buf[stream_ptr]);
489 chunk_type = AV_RL16(&buf[stream_ptr]);
492 switch (chunk_type) {
495 /* For some reason, it seems that non-palettized flics do
496 * include one of these chunks in their first frame.
497 * Why I do not know, it seems rather extraneous. */
498 /* av_log(avctx, AV_LOG_ERROR, "Unexpected Palette chunk %d in non-paletised FLC\n",chunk_type);*/
499 stream_ptr = stream_ptr + chunk_size - 6;
505 compressed_lines = AV_RL16(&buf[stream_ptr]);
507 while (compressed_lines > 0) {
508 line_packets = AV_RL16(&buf[stream_ptr]);
510 if (line_packets < 0) {
511 line_packets = -line_packets;
512 y_ptr += line_packets * s->frame.linesize[0];
517 pixel_countdown = s->avctx->width;
518 for (i = 0; i < line_packets; i++) {
519 /* account for the skip bytes */
520 pixel_skip = buf[stream_ptr++];
521 pixel_ptr += (pixel_skip*2); /* Pixel is 2 bytes wide */
522 pixel_countdown -= pixel_skip;
523 byte_run = (signed char)(buf[stream_ptr++]);
525 byte_run = -byte_run;
526 pixel = AV_RL16(&buf[stream_ptr]);
528 CHECK_PIXEL_PTR(2 * byte_run);
529 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
530 *((signed short*)(&pixels[pixel_ptr])) = pixel;
534 CHECK_PIXEL_PTR(2 * byte_run);
535 for (j = 0; j < byte_run; j++, pixel_countdown--) {
536 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[stream_ptr]);
543 y_ptr += s->frame.linesize[0];
549 av_log(avctx, AV_LOG_ERROR, "Unexpected FLI_LC chunk in non-paletised FLC\n");
550 stream_ptr = stream_ptr + chunk_size - 6;
554 /* set the whole frame to 0x0000 which is black in both 15Bpp and 16Bpp modes. */
555 memset(pixels, 0x0000,
556 s->frame.linesize[0] * s->avctx->height);
561 for (lines = 0; lines < s->avctx->height; lines++) {
563 /* disregard the line packets; instead, iterate through all
566 pixel_countdown = (s->avctx->width * 2);
568 while (pixel_countdown > 0) {
569 byte_run = (signed char)(buf[stream_ptr++]);
571 palette_idx1 = buf[stream_ptr++];
572 CHECK_PIXEL_PTR(byte_run);
573 for (j = 0; j < byte_run; j++) {
574 pixels[pixel_ptr++] = palette_idx1;
576 if (pixel_countdown < 0)
577 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) (linea%d)\n",
578 pixel_countdown, lines);
580 } else { /* copy bytes if byte_run < 0 */
581 byte_run = -byte_run;
582 CHECK_PIXEL_PTR(byte_run);
583 for (j = 0; j < byte_run; j++) {
584 palette_idx1 = buf[stream_ptr++];
585 pixels[pixel_ptr++] = palette_idx1;
587 if (pixel_countdown < 0)
588 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
589 pixel_countdown, lines);
594 /* Now FLX is strange, in that it is "byte" as opposed to "pixel" run length compressed.
595 * This does not give us any good oportunity to perform word endian conversion
596 * during decompression. So if it is required (i.e., this is not a LE target, we do
597 * a second pass over the line here, swapping the bytes.
601 pixel_countdown = s->avctx->width;
602 while (pixel_countdown > 0) {
603 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[pixel_ptr]);
607 y_ptr += s->frame.linesize[0];
613 for (lines = 0; lines < s->avctx->height; lines++) {
615 /* disregard the line packets; instead, iterate through all
618 pixel_countdown = s->avctx->width; /* Width is in pixels, not bytes */
620 while (pixel_countdown > 0) {
621 byte_run = (signed char)(buf[stream_ptr++]);
623 pixel = AV_RL16(&buf[stream_ptr]);
625 CHECK_PIXEL_PTR(2 * byte_run);
626 for (j = 0; j < byte_run; j++) {
627 *((signed short*)(&pixels[pixel_ptr])) = pixel;
630 if (pixel_countdown < 0)
631 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
634 } else { /* copy pixels if byte_run < 0 */
635 byte_run = -byte_run;
636 CHECK_PIXEL_PTR(2 * byte_run);
637 for (j = 0; j < byte_run; j++) {
638 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[stream_ptr]);
642 if (pixel_countdown < 0)
643 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
649 y_ptr += s->frame.linesize[0];
655 /* copy the chunk (uncompressed frame) */
656 if (chunk_size - 6 > (unsigned int)(s->avctx->width * s->avctx->height)*2) {
657 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
658 "bigger than image, skipping chunk\n", chunk_size - 6);
659 stream_ptr += chunk_size - 6;
662 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
663 y_ptr += s->frame.linesize[0]) {
665 pixel_countdown = s->avctx->width;
667 while (pixel_countdown > 0) {
668 *((signed short*)(&pixels[y_ptr + pixel_ptr])) = AV_RL16(&buf[stream_ptr+pixel_ptr]);
672 stream_ptr += s->avctx->width*2;
678 /* some sort of a thumbnail? disregard this chunk... */
679 stream_ptr += chunk_size - 6;
683 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
687 frame_size -= chunk_size;
691 /* by the end of the chunk, the stream ptr should equal the frame
692 * size (minus 1, possibly); if it doesn't, issue a warning */
693 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
694 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
695 "and final chunk ptr = %d\n", buf_size, stream_ptr);
698 *data_size=sizeof(AVFrame);
699 *(AVFrame*)data = s->frame;
704 static int flic_decode_frame_24BPP(AVCodecContext *avctx,
705 void *data, int *data_size,
706 const uint8_t *buf, int buf_size)
708 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC Unsupported due to lack of test files.\n");
712 static int flic_decode_frame(AVCodecContext *avctx,
713 void *data, int *data_size,
716 const uint8_t *buf = avpkt->data;
717 int buf_size = avpkt->size;
718 if (avctx->pix_fmt == PIX_FMT_PAL8) {
719 return flic_decode_frame_8BPP(avctx, data, data_size,
722 else if ((avctx->pix_fmt == PIX_FMT_RGB555) ||
723 (avctx->pix_fmt == PIX_FMT_RGB565)) {
724 return flic_decode_frame_15_16BPP(avctx, data, data_size,
727 else if (avctx->pix_fmt == PIX_FMT_BGR24) {
728 return flic_decode_frame_24BPP(avctx, data, data_size,
732 /* Should not get here, ever as the pix_fmt is processed */
733 /* in flic_decode_init and the above if should deal with */
734 /* the finite set of possibilites allowable by here. */
735 /* But in case we do, just error out. */
736 av_log(avctx, AV_LOG_ERROR, "Unknown FLC format, my science cannot explain how this happened.\n");
741 static av_cold int flic_decode_end(AVCodecContext *avctx)
743 FlicDecodeContext *s = avctx->priv_data;
745 if (s->frame.data[0])
746 avctx->release_buffer(avctx, &s->frame);
751 AVCodec ff_flic_decoder = {
755 sizeof(FlicDecodeContext),
765 .long_name = NULL_IF_CONFIG_SMALL("Autodesk Animator Flic video"),