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
25 * Autodesk Animator FLI/FLC Video Decoder
26 * by Mike Melanson (melanson@pcisys.net)
27 * for more information on the .fli/.flc file format and all of its many
29 * http://www.compuphase.com/flic.htm
31 * This decoder outputs PAL8/RGB555/RGB565 and maybe one day RGB24
32 * colorspace data, depending on the FLC. To use this decoder, be
33 * sure that your demuxer sends the FLI file header to the decoder via
34 * the extradata chunk in AVCodecContext. The chunk should be 128 bytes
35 * large. The only exception is for FLI files from the game "Magic Carpet",
36 * in which the header is only 12 bytes.
48 #define FLI_256_COLOR 4
56 #define FLI_DTA_BRUN 25
57 #define FLI_DTA_COPY 26
60 #define FLI_TYPE_CODE (0xAF11)
61 #define FLC_FLX_TYPE_CODE (0xAF12)
62 #define FLC_DTA_TYPE_CODE (0xAF44) /* Marks an "Extended FLC" comes from Dave's Targa Animator (DTA) */
63 #define FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE (0xAF13)
65 #define CHECK_PIXEL_PTR(n) \
66 if (pixel_ptr + n > pixel_limit) { \
67 av_log (s->avctx, AV_LOG_INFO, "Problem: pixel_ptr >= pixel_limit (%d >= %d)\n", \
68 pixel_ptr + n, pixel_limit); \
72 typedef struct FlicDecodeContext {
73 AVCodecContext *avctx;
76 unsigned int palette[256];
78 int fli_type; /* either 0xAF11 or 0xAF12, affects palette resolution */
81 static int flic_decode_init(AVCodecContext *avctx)
83 FlicDecodeContext *s = avctx->priv_data;
84 unsigned char *fli_header = (unsigned char *)avctx->extradata;
89 s->fli_type = AV_RL16(&fli_header[4]); /* Might be overridden if a Magic Carpet FLC */
90 depth = AV_RL16(&fli_header[12]);
93 depth = 8; /* Some FLC generators set depth to zero, when they mean 8Bpp. Fix up here */
96 if (s->avctx->extradata_size == 12) {
97 /* special case for magic carpet FLIs */
98 s->fli_type = FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE;
99 } else if (s->avctx->extradata_size != 128) {
100 av_log(avctx, AV_LOG_ERROR, "Expected extradata of 12 or 128 bytes\n");
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 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;
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 pixels[y_ptr + s->frame.linesize[0] - 1] = line_packets & 0xff;
260 pixel_countdown = s->avctx->width;
261 for (i = 0; i < line_packets; i++) {
262 /* account for the skip bytes */
263 pixel_skip = buf[stream_ptr++];
264 pixel_ptr += pixel_skip;
265 pixel_countdown -= pixel_skip;
266 byte_run = (signed char)(buf[stream_ptr++]);
268 byte_run = -byte_run;
269 palette_idx1 = buf[stream_ptr++];
270 palette_idx2 = buf[stream_ptr++];
271 CHECK_PIXEL_PTR(byte_run);
272 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
273 pixels[pixel_ptr++] = palette_idx1;
274 pixels[pixel_ptr++] = palette_idx2;
277 CHECK_PIXEL_PTR(byte_run * 2);
278 for (j = 0; j < byte_run * 2; j++, pixel_countdown--) {
279 palette_idx1 = buf[stream_ptr++];
280 pixels[pixel_ptr++] = palette_idx1;
285 y_ptr += s->frame.linesize[0];
291 /* line compressed */
292 starting_line = AV_RL16(&buf[stream_ptr]);
295 y_ptr += starting_line * s->frame.linesize[0];
297 compressed_lines = AV_RL16(&buf[stream_ptr]);
299 while (compressed_lines > 0) {
301 pixel_countdown = s->avctx->width;
302 line_packets = buf[stream_ptr++];
303 if (line_packets > 0) {
304 for (i = 0; i < line_packets; i++) {
305 /* account for the skip bytes */
306 pixel_skip = buf[stream_ptr++];
307 pixel_ptr += pixel_skip;
308 pixel_countdown -= pixel_skip;
309 byte_run = (signed char)(buf[stream_ptr++]);
311 CHECK_PIXEL_PTR(byte_run);
312 for (j = 0; j < byte_run; j++, pixel_countdown--) {
313 palette_idx1 = buf[stream_ptr++];
314 pixels[pixel_ptr++] = palette_idx1;
316 } else if (byte_run < 0) {
317 byte_run = -byte_run;
318 palette_idx1 = buf[stream_ptr++];
319 CHECK_PIXEL_PTR(byte_run);
320 for (j = 0; j < byte_run; j++, pixel_countdown--) {
321 pixels[pixel_ptr++] = palette_idx1;
327 y_ptr += s->frame.linesize[0];
333 /* set the whole frame to color 0 (which is usually black) */
335 s->frame.linesize[0] * s->avctx->height);
339 /* Byte run compression: This chunk type only occurs in the first
340 * FLI frame and it will update the entire frame. */
342 for (lines = 0; lines < s->avctx->height; lines++) {
344 /* disregard the line packets; instead, iterate through all
347 pixel_countdown = s->avctx->width;
348 while (pixel_countdown > 0) {
349 byte_run = (signed char)(buf[stream_ptr++]);
351 palette_idx1 = buf[stream_ptr++];
352 CHECK_PIXEL_PTR(byte_run);
353 for (j = 0; j < byte_run; j++) {
354 pixels[pixel_ptr++] = palette_idx1;
356 if (pixel_countdown < 0)
357 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
358 pixel_countdown, lines);
360 } else { /* copy bytes if byte_run < 0 */
361 byte_run = -byte_run;
362 CHECK_PIXEL_PTR(byte_run);
363 for (j = 0; j < byte_run; j++) {
364 palette_idx1 = buf[stream_ptr++];
365 pixels[pixel_ptr++] = palette_idx1;
367 if (pixel_countdown < 0)
368 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
369 pixel_countdown, lines);
374 y_ptr += s->frame.linesize[0];
379 /* copy the chunk (uncompressed frame) */
380 if (chunk_size - 6 > s->avctx->width * s->avctx->height) {
381 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
382 "bigger than image, skipping chunk\n", chunk_size - 6);
383 stream_ptr += chunk_size - 6;
385 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
386 y_ptr += s->frame.linesize[0]) {
387 memcpy(&pixels[y_ptr], &buf[stream_ptr],
389 stream_ptr += s->avctx->width;
395 /* some sort of a thumbnail? disregard this chunk... */
396 stream_ptr += chunk_size - 6;
400 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
404 frame_size -= chunk_size;
408 /* by the end of the chunk, the stream ptr should equal the frame
409 * size (minus 1, possibly); if it doesn't, issue a warning */
410 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
411 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
412 "and final chunk ptr = %d\n", buf_size, stream_ptr);
414 /* make the palette available on the way out */
415 memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
416 if (s->new_palette) {
417 s->frame.palette_has_changed = 1;
421 *data_size=sizeof(AVFrame);
422 *(AVFrame*)data = s->frame;
427 static int flic_decode_frame_15_16BPP(AVCodecContext *avctx,
428 void *data, int *data_size,
429 uint8_t *buf, int buf_size)
431 /* Note, the only difference between the 15Bpp and 16Bpp */
432 /* Format is the pixel format, the packets are processed the same. */
433 FlicDecodeContext *s = avctx->priv_data;
437 unsigned char palette_idx1;
439 unsigned int frame_size;
442 unsigned int chunk_size;
448 int compressed_lines;
449 signed short line_packets;
454 unsigned char *pixels;
458 s->frame.reference = 1;
459 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
460 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
461 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
465 pixels = s->frame.data[0];
466 pixel_limit = s->avctx->height * s->frame.linesize[0];
468 frame_size = AV_RL32(&buf[stream_ptr]);
469 stream_ptr += 6; /* skip the magic number */
470 num_chunks = AV_RL16(&buf[stream_ptr]);
471 stream_ptr += 10; /* skip padding */
475 /* iterate through the chunks */
476 while ((frame_size > 0) && (num_chunks > 0)) {
477 chunk_size = AV_RL32(&buf[stream_ptr]);
479 chunk_type = AV_RL16(&buf[stream_ptr]);
482 switch (chunk_type) {
485 /* For some reason, it seems that non-paletised flics do include one of these */
486 /* chunks in their first frame. Why i do not know, it seems rather extraneous */
487 /* av_log(avctx, AV_LOG_ERROR, "Unexpected Palette chunk %d in non-paletised FLC\n",chunk_type);*/
488 stream_ptr = stream_ptr + chunk_size - 6;
494 compressed_lines = AV_RL16(&buf[stream_ptr]);
496 while (compressed_lines > 0) {
497 line_packets = AV_RL16(&buf[stream_ptr]);
499 if (line_packets < 0) {
500 line_packets = -line_packets;
501 y_ptr += line_packets * s->frame.linesize[0];
505 pixel_countdown = s->avctx->width;
506 for (i = 0; i < line_packets; i++) {
507 /* account for the skip bytes */
508 pixel_skip = buf[stream_ptr++];
509 pixel_ptr += (pixel_skip*2); /* Pixel is 2 bytes wide */
510 pixel_countdown -= pixel_skip;
511 byte_run = (signed char)(buf[stream_ptr++]);
513 byte_run = -byte_run;
514 pixel = AV_RL16(&buf[stream_ptr]);
516 CHECK_PIXEL_PTR(byte_run);
517 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
518 *((signed short*)(&pixels[pixel_ptr])) = pixel;
522 CHECK_PIXEL_PTR(byte_run);
523 for (j = 0; j < byte_run; j++, pixel_countdown--) {
524 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[stream_ptr]);
531 y_ptr += s->frame.linesize[0];
537 av_log(avctx, AV_LOG_ERROR, "Unexpected FLI_LC chunk in non-paletised FLC\n");
538 stream_ptr = stream_ptr + chunk_size - 6;
542 /* set the whole frame to 0x0000 which is black in both 15Bpp and 16Bpp modes. */
543 memset(pixels, 0x0000,
544 s->frame.linesize[0] * s->avctx->height);
549 for (lines = 0; lines < s->avctx->height; lines++) {
551 /* disregard the line packets; instead, iterate through all
554 pixel_countdown = (s->avctx->width * 2);
556 while (pixel_countdown > 0) {
557 byte_run = (signed char)(buf[stream_ptr++]);
559 palette_idx1 = buf[stream_ptr++];
560 CHECK_PIXEL_PTR(byte_run);
561 for (j = 0; j < byte_run; j++) {
562 pixels[pixel_ptr++] = palette_idx1;
564 if (pixel_countdown < 0)
565 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) (linea%d)\n",
566 pixel_countdown, lines);
568 } else { /* copy bytes if byte_run < 0 */
569 byte_run = -byte_run;
570 CHECK_PIXEL_PTR(byte_run);
571 for (j = 0; j < byte_run; j++) {
572 palette_idx1 = buf[stream_ptr++];
573 pixels[pixel_ptr++] = palette_idx1;
575 if (pixel_countdown < 0)
576 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d) at line %d\n",
577 pixel_countdown, lines);
582 /* Now FLX is strange, in that it is "byte" as opposed to "pixel" run length compressed.
583 * This doesnt give us any good oportunity to perform word endian conversion
584 * during decompression. So if its requried (ie, this isnt a LE target, we do
585 * a second pass over the line here, swapping the bytes.
588 if (0xFF00 != AV_RL16(&pixel)) /* Check if its not an LE Target */
591 pixel_countdown = s->avctx->width;
592 while (pixel_countdown > 0) {
593 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[pixel_ptr]);
597 y_ptr += s->frame.linesize[0];
603 for (lines = 0; lines < s->avctx->height; lines++) {
605 /* disregard the line packets; instead, iterate through all
608 pixel_countdown = s->avctx->width; /* Width is in pixels, not bytes */
610 while (pixel_countdown > 0) {
611 byte_run = (signed char)(buf[stream_ptr++]);
613 pixel = AV_RL16(&buf[stream_ptr]);
615 CHECK_PIXEL_PTR(byte_run);
616 for (j = 0; j < byte_run; j++) {
617 *((signed short*)(&pixels[pixel_ptr])) = pixel;
620 if (pixel_countdown < 0)
621 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
624 } else { /* copy pixels if byte_run < 0 */
625 byte_run = -byte_run;
626 CHECK_PIXEL_PTR(byte_run);
627 for (j = 0; j < byte_run; j++) {
628 *((signed short*)(&pixels[pixel_ptr])) = AV_RL16(&buf[stream_ptr]);
632 if (pixel_countdown < 0)
633 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
639 y_ptr += s->frame.linesize[0];
645 /* copy the chunk (uncompressed frame) */
646 if (chunk_size - 6 > (unsigned int)(s->avctx->width * s->avctx->height)*2) {
647 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
648 "bigger than image, skipping chunk\n", chunk_size - 6);
649 stream_ptr += chunk_size - 6;
652 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
653 y_ptr += s->frame.linesize[0]) {
655 pixel_countdown = s->avctx->width;
657 while (pixel_countdown > 0) {
658 *((signed short*)(&pixels[y_ptr + pixel_ptr])) = AV_RL16(&buf[stream_ptr+pixel_ptr]);
662 stream_ptr += s->avctx->width*2;
668 /* some sort of a thumbnail? disregard this chunk... */
669 stream_ptr += chunk_size - 6;
673 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
677 frame_size -= chunk_size;
681 /* by the end of the chunk, the stream ptr should equal the frame
682 * size (minus 1, possibly); if it doesn't, issue a warning */
683 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
684 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
685 "and final chunk ptr = %d\n", buf_size, stream_ptr);
688 *data_size=sizeof(AVFrame);
689 *(AVFrame*)data = s->frame;
694 static int flic_decode_frame_24BPP(AVCodecContext *avctx,
695 void *data, int *data_size,
696 uint8_t *buf, int buf_size)
698 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC Unsupported due to lack of test files.\n");
702 static int flic_decode_frame(AVCodecContext *avctx,
703 void *data, int *data_size,
704 uint8_t *buf, int buf_size)
706 if (avctx->pix_fmt == PIX_FMT_PAL8) {
707 return flic_decode_frame_8BPP(avctx, data, data_size,
710 else if ((avctx->pix_fmt == PIX_FMT_RGB555) ||
711 (avctx->pix_fmt == PIX_FMT_RGB565)) {
712 return flic_decode_frame_15_16BPP(avctx, data, data_size,
715 else if (avctx->pix_fmt == PIX_FMT_BGR24) {
716 return flic_decode_frame_24BPP(avctx, data, data_size,
720 /* Shouldnt get here, ever as the pix_fmt is processed */
721 /* in flic_decode_init and the above if should deal with */
722 /* the finite set of possibilites allowable by here. */
723 /* but in case we do, just error out. */
724 av_log(avctx, AV_LOG_ERROR, "Unknown Format of FLC. My Science cant explain how this happened\n");
729 static int flic_decode_end(AVCodecContext *avctx)
731 FlicDecodeContext *s = avctx->priv_data;
733 if (s->frame.data[0])
734 avctx->release_buffer(avctx, &s->frame);
739 AVCodec flic_decoder = {
743 sizeof(FlicDecodeContext),