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_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");
117 av_log(avctx, AV_LOG_ERROR, "Unknown FLC/FLX depth of %d Bpp is unsupported.\n",depth);
121 s->frame.data[0] = NULL;
127 static int flic_decode_frame_8BPP(AVCodecContext *avctx,
128 void *data, int *data_size,
129 const uint8_t *buf, int buf_size)
131 FlicDecodeContext *s = avctx->priv_data;
134 int stream_ptr_after_color_chunk;
137 unsigned char palette_idx1;
138 unsigned char palette_idx2;
140 unsigned int frame_size;
143 unsigned int chunk_size;
151 unsigned char r, g, b;
154 int compressed_lines;
156 signed short line_packets;
161 unsigned char *pixels;
162 unsigned int pixel_limit;
164 s->frame.reference = 1;
165 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
166 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
167 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
171 pixels = s->frame.data[0];
172 pixel_limit = s->avctx->height * s->frame.linesize[0];
174 frame_size = AV_RL32(&buf[stream_ptr]);
175 stream_ptr += 6; /* skip the magic number */
176 num_chunks = AV_RL16(&buf[stream_ptr]);
177 stream_ptr += 10; /* skip padding */
181 /* iterate through the chunks */
182 while ((frame_size > 0) && (num_chunks > 0)) {
183 chunk_size = AV_RL32(&buf[stream_ptr]);
185 chunk_type = AV_RL16(&buf[stream_ptr]);
188 switch (chunk_type) {
191 stream_ptr_after_color_chunk = stream_ptr + chunk_size - 6;
193 /* check special case: If this file is from the Magic Carpet
194 * game and uses 6-bit colors even though it reports 256-color
195 * chunks in a 0xAF12-type file (fli_type is set to 0xAF13 during
197 if ((chunk_type == FLI_256_COLOR) && (s->fli_type != FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE))
201 /* set up the palette */
202 color_packets = AV_RL16(&buf[stream_ptr]);
205 for (i = 0; i < color_packets; i++) {
206 /* first byte is how many colors to skip */
207 palette_ptr += buf[stream_ptr++];
209 /* next byte indicates how many entries to change */
210 color_changes = buf[stream_ptr++];
212 /* if there are 0 color changes, there are actually 256 */
213 if (color_changes == 0)
216 for (j = 0; j < color_changes; j++) {
219 /* wrap around, for good measure */
220 if ((unsigned)palette_ptr >= 256)
223 r = buf[stream_ptr++] << color_shift;
224 g = buf[stream_ptr++] << color_shift;
225 b = buf[stream_ptr++] << color_shift;
226 entry = (r << 16) | (g << 8) | b;
227 if (s->palette[palette_ptr] != entry)
229 s->palette[palette_ptr++] = entry;
233 /* color chunks sometimes have weird 16-bit alignment issues;
234 * therefore, take the hardline approach and set the stream_ptr
235 * to the value calculated w.r.t. the size specified by the color
237 stream_ptr = stream_ptr_after_color_chunk;
243 compressed_lines = AV_RL16(&buf[stream_ptr]);
245 while (compressed_lines > 0) {
246 line_packets = AV_RL16(&buf[stream_ptr]);
248 if ((line_packets & 0xC000) == 0xC000) {
250 line_packets = -line_packets;
251 y_ptr += line_packets * s->frame.linesize[0];
252 } else if ((line_packets & 0xC000) == 0x4000) {
253 av_log(avctx, AV_LOG_ERROR, "Undefined opcode (%x) in DELTA_FLI\n", line_packets);
254 } else if ((line_packets & 0xC000) == 0x8000) {
255 // "last byte" opcode
256 pixel_ptr= y_ptr + s->frame.linesize[0] - 1;
258 pixels[pixel_ptr] = line_packets & 0xff;
263 pixel_countdown = s->avctx->width;
264 for (i = 0; i < line_packets; i++) {
265 /* account for the skip bytes */
266 pixel_skip = buf[stream_ptr++];
267 pixel_ptr += pixel_skip;
268 pixel_countdown -= pixel_skip;
269 byte_run = (signed char)(buf[stream_ptr++]);
271 byte_run = -byte_run;
272 palette_idx1 = buf[stream_ptr++];
273 palette_idx2 = buf[stream_ptr++];
274 CHECK_PIXEL_PTR(byte_run * 2);
275 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
276 pixels[pixel_ptr++] = palette_idx1;
277 pixels[pixel_ptr++] = palette_idx2;
280 CHECK_PIXEL_PTR(byte_run * 2);
281 for (j = 0; j < byte_run * 2; j++, pixel_countdown--) {
282 palette_idx1 = buf[stream_ptr++];
283 pixels[pixel_ptr++] = palette_idx1;
288 y_ptr += s->frame.linesize[0];
294 /* line compressed */
295 starting_line = AV_RL16(&buf[stream_ptr]);
298 y_ptr += starting_line * s->frame.linesize[0];
300 compressed_lines = AV_RL16(&buf[stream_ptr]);
302 while (compressed_lines > 0) {
305 pixel_countdown = s->avctx->width;
306 line_packets = buf[stream_ptr++];
307 if (line_packets > 0) {
308 for (i = 0; i < line_packets; i++) {
309 /* account for the skip bytes */
310 pixel_skip = buf[stream_ptr++];
311 pixel_ptr += pixel_skip;
312 pixel_countdown -= pixel_skip;
313 byte_run = (signed char)(buf[stream_ptr++]);
315 CHECK_PIXEL_PTR(byte_run);
316 for (j = 0; j < byte_run; j++, pixel_countdown--) {
317 palette_idx1 = buf[stream_ptr++];
318 pixels[pixel_ptr++] = palette_idx1;
320 } else if (byte_run < 0) {
321 byte_run = -byte_run;
322 palette_idx1 = buf[stream_ptr++];
323 CHECK_PIXEL_PTR(byte_run);
324 for (j = 0; j < byte_run; j++, pixel_countdown--) {
325 pixels[pixel_ptr++] = palette_idx1;
331 y_ptr += s->frame.linesize[0];
337 /* set the whole frame to color 0 (which is usually black) */
339 s->frame.linesize[0] * s->avctx->height);
343 /* Byte run compression: This chunk type only occurs in the first
344 * FLI frame and it will update the entire frame. */
346 for (lines = 0; lines < s->avctx->height; lines++) {
348 /* disregard the line packets; instead, iterate through all
351 pixel_countdown = s->avctx->width;
352 while (pixel_countdown > 0) {
353 byte_run = (signed char)(buf[stream_ptr++]);
355 palette_idx1 = buf[stream_ptr++];
356 CHECK_PIXEL_PTR(byte_run);
357 for (j = 0; j < byte_run; j++) {
358 pixels[pixel_ptr++] = palette_idx1;
360 if (pixel_countdown < 0)
361 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
362 pixel_countdown, lines);
364 } else { /* copy bytes if byte_run < 0 */
365 byte_run = -byte_run;
366 CHECK_PIXEL_PTR(byte_run);
367 for (j = 0; j < byte_run; j++) {
368 palette_idx1 = buf[stream_ptr++];
369 pixels[pixel_ptr++] = palette_idx1;
371 if (pixel_countdown < 0)
372 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
373 pixel_countdown, lines);
378 y_ptr += s->frame.linesize[0];
383 /* copy the chunk (uncompressed frame) */
384 if (chunk_size - 6 > s->avctx->width * s->avctx->height) {
385 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
386 "bigger than image, skipping chunk\n", chunk_size - 6);
387 stream_ptr += chunk_size - 6;
389 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
390 y_ptr += s->frame.linesize[0]) {
391 memcpy(&pixels[y_ptr], &buf[stream_ptr],
393 stream_ptr += s->avctx->width;
399 /* some sort of a thumbnail? disregard this chunk... */
400 stream_ptr += chunk_size - 6;
404 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
408 frame_size -= chunk_size;
412 /* by the end of the chunk, the stream ptr should equal the frame
413 * size (minus 1, possibly); if it doesn't, issue a warning */
414 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
415 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
416 "and final chunk ptr = %d\n", buf_size, stream_ptr);
418 /* make the palette available on the way out */
419 memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
420 if (s->new_palette) {
421 s->frame.palette_has_changed = 1;
425 *data_size=sizeof(AVFrame);
426 *(AVFrame*)data = s->frame;
431 static int flic_decode_frame_15_16BPP(AVCodecContext *avctx,
432 void *data, int *data_size,
433 const uint8_t *buf, int buf_size)
435 /* Note, the only difference between the 15Bpp and 16Bpp */
436 /* Format is the pixel format, the packets are processed the same. */
437 FlicDecodeContext *s = avctx->priv_data;
441 unsigned char palette_idx1;
443 unsigned int frame_size;
446 unsigned int chunk_size;
452 int compressed_lines;
453 signed short line_packets;
458 unsigned char *pixels;
460 unsigned int pixel_limit;
462 s->frame.reference = 1;
463 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
464 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
465 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
469 pixels = s->frame.data[0];
470 pixel_limit = s->avctx->height * s->frame.linesize[0];
472 frame_size = AV_RL32(&buf[stream_ptr]);
473 stream_ptr += 6; /* skip the magic number */
474 num_chunks = AV_RL16(&buf[stream_ptr]);
475 stream_ptr += 10; /* skip padding */
479 /* iterate through the chunks */
480 while ((frame_size > 0) && (num_chunks > 0)) {
481 chunk_size = AV_RL32(&buf[stream_ptr]);
483 chunk_type = AV_RL16(&buf[stream_ptr]);
486 switch (chunk_type) {
489 /* For some reason, it seems that non-palettized flics do
490 * include one of these chunks in their first frame.
491 * Why I do not know, it seems rather extraneous. */
492 /* av_log(avctx, AV_LOG_ERROR, "Unexpected Palette chunk %d in non-paletised FLC\n",chunk_type);*/
493 stream_ptr = stream_ptr + chunk_size - 6;
499 compressed_lines = AV_RL16(&buf[stream_ptr]);
501 while (compressed_lines > 0) {
502 line_packets = AV_RL16(&buf[stream_ptr]);
504 if (line_packets < 0) {
505 line_packets = -line_packets;
506 y_ptr += line_packets * s->frame.linesize[0];
511 pixel_countdown = s->avctx->width;
512 for (i = 0; i < line_packets; i++) {
513 /* account for the skip bytes */
514 pixel_skip = buf[stream_ptr++];
515 pixel_ptr += (pixel_skip*2); /* Pixel is 2 bytes wide */
516 pixel_countdown -= pixel_skip;
517 byte_run = (signed char)(buf[stream_ptr++]);
519 byte_run = -byte_run;
520 pixel = AV_RL16(&buf[stream_ptr]);
522 CHECK_PIXEL_PTR(2 * byte_run);
523 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
524 *((signed short*)(&pixels[pixel_ptr])) = pixel;
528 CHECK_PIXEL_PTR(2 * byte_run);
529 for (j = 0; j < byte_run; j++, pixel_countdown--) {
530 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[stream_ptr]);
537 y_ptr += s->frame.linesize[0];
543 av_log(avctx, AV_LOG_ERROR, "Unexpected FLI_LC chunk in non-paletised FLC\n");
544 stream_ptr = stream_ptr + chunk_size - 6;
548 /* set the whole frame to 0x0000 which is black in both 15Bpp and 16Bpp modes. */
549 memset(pixels, 0x0000,
550 s->frame.linesize[0] * s->avctx->height);
555 for (lines = 0; lines < s->avctx->height; lines++) {
557 /* disregard the line packets; instead, iterate through all
560 pixel_countdown = (s->avctx->width * 2);
562 while (pixel_countdown > 0) {
563 byte_run = (signed char)(buf[stream_ptr++]);
565 palette_idx1 = buf[stream_ptr++];
566 CHECK_PIXEL_PTR(byte_run);
567 for (j = 0; j < byte_run; j++) {
568 pixels[pixel_ptr++] = palette_idx1;
570 if (pixel_countdown < 0)
571 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) (linea%d)\n",
572 pixel_countdown, lines);
574 } else { /* copy bytes if byte_run < 0 */
575 byte_run = -byte_run;
576 CHECK_PIXEL_PTR(byte_run);
577 for (j = 0; j < byte_run; j++) {
578 palette_idx1 = buf[stream_ptr++];
579 pixels[pixel_ptr++] = palette_idx1;
581 if (pixel_countdown < 0)
582 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
583 pixel_countdown, lines);
588 /* Now FLX is strange, in that it is "byte" as opposed to "pixel" run length compressed.
589 * This does not give us any good oportunity to perform word endian conversion
590 * during decompression. So if it is required (i.e., this is not a LE target, we do
591 * a second pass over the line here, swapping the bytes.
595 pixel_countdown = s->avctx->width;
596 while (pixel_countdown > 0) {
597 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[pixel_ptr]);
601 y_ptr += s->frame.linesize[0];
607 for (lines = 0; lines < s->avctx->height; lines++) {
609 /* disregard the line packets; instead, iterate through all
612 pixel_countdown = s->avctx->width; /* Width is in pixels, not bytes */
614 while (pixel_countdown > 0) {
615 byte_run = (signed char)(buf[stream_ptr++]);
617 pixel = AV_RL16(&buf[stream_ptr]);
619 CHECK_PIXEL_PTR(2 * byte_run);
620 for (j = 0; j < byte_run; j++) {
621 *((signed short*)(&pixels[pixel_ptr])) = pixel;
624 if (pixel_countdown < 0)
625 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
628 } else { /* copy pixels if byte_run < 0 */
629 byte_run = -byte_run;
630 CHECK_PIXEL_PTR(2 * byte_run);
631 for (j = 0; j < byte_run; j++) {
632 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[stream_ptr]);
636 if (pixel_countdown < 0)
637 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
643 y_ptr += s->frame.linesize[0];
649 /* copy the chunk (uncompressed frame) */
650 if (chunk_size - 6 > (unsigned int)(s->avctx->width * s->avctx->height)*2) {
651 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
652 "bigger than image, skipping chunk\n", chunk_size - 6);
653 stream_ptr += chunk_size - 6;
656 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
657 y_ptr += s->frame.linesize[0]) {
659 pixel_countdown = s->avctx->width;
661 while (pixel_countdown > 0) {
662 *((signed short*)(&pixels[y_ptr + pixel_ptr])) = AV_RL16(&buf[stream_ptr+pixel_ptr]);
666 stream_ptr += s->avctx->width*2;
672 /* some sort of a thumbnail? disregard this chunk... */
673 stream_ptr += chunk_size - 6;
677 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
681 frame_size -= chunk_size;
685 /* by the end of the chunk, the stream ptr should equal the frame
686 * size (minus 1, possibly); if it doesn't, issue a warning */
687 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
688 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
689 "and final chunk ptr = %d\n", buf_size, stream_ptr);
692 *data_size=sizeof(AVFrame);
693 *(AVFrame*)data = s->frame;
698 static int flic_decode_frame_24BPP(AVCodecContext *avctx,
699 void *data, int *data_size,
700 const uint8_t *buf, int buf_size)
702 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC Unsupported due to lack of test files.\n");
706 static int flic_decode_frame(AVCodecContext *avctx,
707 void *data, int *data_size,
710 const uint8_t *buf = avpkt->data;
711 int buf_size = avpkt->size;
712 if (avctx->pix_fmt == PIX_FMT_PAL8) {
713 return flic_decode_frame_8BPP(avctx, data, data_size,
716 else if ((avctx->pix_fmt == PIX_FMT_RGB555) ||
717 (avctx->pix_fmt == PIX_FMT_RGB565)) {
718 return flic_decode_frame_15_16BPP(avctx, data, data_size,
721 else if (avctx->pix_fmt == PIX_FMT_BGR24) {
722 return flic_decode_frame_24BPP(avctx, data, data_size,
726 /* Should not get here, ever as the pix_fmt is processed */
727 /* in flic_decode_init and the above if should deal with */
728 /* the finite set of possibilites allowable by here. */
729 /* But in case we do, just error out. */
730 av_log(avctx, AV_LOG_ERROR, "Unknown FLC format, my science cannot explain how this happened.\n");
735 static av_cold int flic_decode_end(AVCodecContext *avctx)
737 FlicDecodeContext *s = avctx->priv_data;
739 if (s->frame.data[0])
740 avctx->release_buffer(avctx, &s->frame);
745 AVCodec flic_decoder = {
749 sizeof(FlicDecodeContext),
759 .long_name = NULL_IF_CONFIG_SMALL("Autodesk Animator Flic video"),