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 = (FlicDecodeContext *)avctx->priv_data;
84 unsigned char *fli_header = (unsigned char *)avctx->extradata;
88 avctx->has_b_frames = 0;
90 s->fli_type = LE_16(&fli_header[4]); /* Might be overridden if a Magic Carpet FLC */
91 depth = LE_16(&fli_header[12]);
94 depth = 8; /* Some FLC generators set depth to zero, when they mean 8Bpp. Fix up here */
97 if (s->avctx->extradata_size == 12) {
98 /* special case for magic carpet FLIs */
99 s->fli_type = FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE;
100 } else if (s->avctx->extradata_size != 128) {
101 av_log(avctx, AV_LOG_ERROR, "Expected extradata of 12 or 128 bytes\n");
105 if ((s->fli_type == FLC_FLX_TYPE_CODE) && (depth == 16)) {
106 depth = 15; /* Original Autodesk FLX's say the depth is 16Bpp when it is really 15Bpp */
110 case 8 : avctx->pix_fmt = PIX_FMT_PAL8; break;
111 case 15 : avctx->pix_fmt = PIX_FMT_RGB555; break;
112 case 16 : avctx->pix_fmt = PIX_FMT_RGB565; break;
113 case 24 : avctx->pix_fmt = PIX_FMT_BGR24; /* Supposedly BGR, but havent any files to test with */
114 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC/FLX is unsupported due to no test files.\n");
118 av_log(avctx, AV_LOG_ERROR, "Unkown FLC/FLX depth of %d Bpp is unsupported.\n",depth);
122 s->frame.data[0] = NULL;
128 static int flic_decode_frame_8BPP(AVCodecContext *avctx,
129 void *data, int *data_size,
130 uint8_t *buf, int buf_size)
132 FlicDecodeContext *s = (FlicDecodeContext *)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;
159 signed char byte_run;
162 unsigned char *pixels;
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 = LE_32(&buf[stream_ptr]);
176 stream_ptr += 6; /* skip the magic number */
177 num_chunks = LE_16(&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 = LE_32(&buf[stream_ptr]);
186 chunk_type = LE_16(&buf[stream_ptr]);
189 switch (chunk_type) {
192 stream_ptr_after_color_chunk = stream_ptr + chunk_size - 6;
194 /* check special case: If this file is from the Magic Carpet
195 * game and uses 6-bit colors even though it reports 256-color
196 * chunks in a 0xAF12-type file (fli_type is set to 0xAF13 during
198 if ((chunk_type == FLI_256_COLOR) && (s->fli_type != FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE))
202 /* set up the palette */
203 color_packets = LE_16(&buf[stream_ptr]);
206 for (i = 0; i < color_packets; i++) {
207 /* first byte is how many colors to skip */
208 palette_ptr += buf[stream_ptr++];
210 /* next byte indicates how many entries to change */
211 color_changes = buf[stream_ptr++];
213 /* if there are 0 color changes, there are actually 256 */
214 if (color_changes == 0)
217 for (j = 0; j < color_changes; j++) {
220 /* wrap around, for good measure */
221 if ((unsigned)palette_ptr >= 256)
224 r = buf[stream_ptr++] << color_shift;
225 g = buf[stream_ptr++] << color_shift;
226 b = buf[stream_ptr++] << color_shift;
227 entry = (r << 16) | (g << 8) | b;
228 if (s->palette[palette_ptr] != entry)
230 s->palette[palette_ptr++] = entry;
234 /* color chunks sometimes have weird 16-bit alignment issues;
235 * therefore, take the hardline approach and set the stream_ptr
236 * to the value calculated w.r.t. the size specified by the color
238 stream_ptr = stream_ptr_after_color_chunk;
244 compressed_lines = LE_16(&buf[stream_ptr]);
246 while (compressed_lines > 0) {
247 line_packets = LE_16(&buf[stream_ptr]);
249 if (line_packets < 0) {
250 line_packets = -line_packets;
251 y_ptr += line_packets * s->frame.linesize[0];
255 pixel_countdown = s->avctx->width;
256 for (i = 0; i < line_packets; i++) {
257 /* account for the skip bytes */
258 pixel_skip = buf[stream_ptr++];
259 pixel_ptr += pixel_skip;
260 pixel_countdown -= pixel_skip;
261 byte_run = buf[stream_ptr++];
263 byte_run = -byte_run;
264 palette_idx1 = buf[stream_ptr++];
265 palette_idx2 = buf[stream_ptr++];
266 CHECK_PIXEL_PTR(byte_run);
267 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
268 pixels[pixel_ptr++] = palette_idx1;
269 pixels[pixel_ptr++] = palette_idx2;
272 CHECK_PIXEL_PTR(byte_run * 2);
273 for (j = 0; j < byte_run * 2; j++, pixel_countdown--) {
274 palette_idx1 = buf[stream_ptr++];
275 pixels[pixel_ptr++] = palette_idx1;
280 y_ptr += s->frame.linesize[0];
286 /* line compressed */
287 starting_line = LE_16(&buf[stream_ptr]);
290 y_ptr += starting_line * s->frame.linesize[0];
292 compressed_lines = LE_16(&buf[stream_ptr]);
294 while (compressed_lines > 0) {
296 pixel_countdown = s->avctx->width;
297 line_packets = buf[stream_ptr++];
298 if (line_packets > 0) {
299 for (i = 0; i < line_packets; i++) {
300 /* account for the skip bytes */
301 pixel_skip = buf[stream_ptr++];
302 pixel_ptr += pixel_skip;
303 pixel_countdown -= pixel_skip;
304 byte_run = buf[stream_ptr++];
306 CHECK_PIXEL_PTR(byte_run);
307 for (j = 0; j < byte_run; j++, pixel_countdown--) {
308 palette_idx1 = buf[stream_ptr++];
309 pixels[pixel_ptr++] = palette_idx1;
312 byte_run = -byte_run;
313 palette_idx1 = buf[stream_ptr++];
314 CHECK_PIXEL_PTR(byte_run);
315 for (j = 0; j < byte_run; j++, pixel_countdown--) {
316 pixels[pixel_ptr++] = palette_idx1;
322 y_ptr += s->frame.linesize[0];
328 /* set the whole frame to color 0 (which is usually black) */
330 s->frame.linesize[0] * s->avctx->height);
334 /* Byte run compression: This chunk type only occurs in the first
335 * FLI frame and it will update the entire frame. */
337 for (lines = 0; lines < s->avctx->height; lines++) {
339 /* disregard the line packets; instead, iterate through all
342 pixel_countdown = s->avctx->width;
343 while (pixel_countdown > 0) {
344 byte_run = buf[stream_ptr++];
346 palette_idx1 = buf[stream_ptr++];
347 CHECK_PIXEL_PTR(byte_run);
348 for (j = 0; j < byte_run; j++) {
349 pixels[pixel_ptr++] = palette_idx1;
351 if (pixel_countdown < 0)
352 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
355 } else { /* copy bytes if byte_run < 0 */
356 byte_run = -byte_run;
357 CHECK_PIXEL_PTR(byte_run);
358 for (j = 0; j < byte_run; j++) {
359 palette_idx1 = buf[stream_ptr++];
360 pixels[pixel_ptr++] = palette_idx1;
362 if (pixel_countdown < 0)
363 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
369 y_ptr += s->frame.linesize[0];
374 /* copy the chunk (uncompressed frame) */
375 if (chunk_size - 6 > s->avctx->width * s->avctx->height) {
376 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
377 "bigger than image, skipping chunk\n", chunk_size - 6);
378 stream_ptr += chunk_size - 6;
380 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
381 y_ptr += s->frame.linesize[0]) {
382 memcpy(&pixels[y_ptr], &buf[stream_ptr],
384 stream_ptr += s->avctx->width;
390 /* some sort of a thumbnail? disregard this chunk... */
391 stream_ptr += chunk_size - 6;
395 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
399 frame_size -= chunk_size;
403 /* by the end of the chunk, the stream ptr should equal the frame
404 * size (minus 1, possibly); if it doesn't, issue a warning */
405 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
406 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
407 "and final chunk ptr = %d\n", buf_size, stream_ptr);
409 /* make the palette available on the way out */
410 memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
411 if (s->new_palette) {
412 s->frame.palette_has_changed = 1;
416 *data_size=sizeof(AVFrame);
417 *(AVFrame*)data = s->frame;
422 static int flic_decode_frame_15_16BPP(AVCodecContext *avctx,
423 void *data, int *data_size,
424 uint8_t *buf, int buf_size)
426 /* Note, the only difference between the 15Bpp and 16Bpp */
427 /* Format is the pixel format, the packets are processed the same. */
428 FlicDecodeContext *s = (FlicDecodeContext *)avctx->priv_data;
432 unsigned char palette_idx1;
434 unsigned int frame_size;
437 unsigned int chunk_size;
443 int compressed_lines;
444 signed short line_packets;
446 signed char byte_run;
449 unsigned char *pixels;
453 s->frame.reference = 1;
454 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
455 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
456 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
460 pixels = s->frame.data[0];
461 pixel_limit = s->avctx->height * s->frame.linesize[0];
463 frame_size = LE_32(&buf[stream_ptr]);
464 stream_ptr += 6; /* skip the magic number */
465 num_chunks = LE_16(&buf[stream_ptr]);
466 stream_ptr += 10; /* skip padding */
470 /* iterate through the chunks */
471 while ((frame_size > 0) && (num_chunks > 0)) {
472 chunk_size = LE_32(&buf[stream_ptr]);
474 chunk_type = LE_16(&buf[stream_ptr]);
477 switch (chunk_type) {
480 /* For some reason, it seems that non-paletised flics do include one of these */
481 /* chunks in their first frame. Why i do not know, it seems rather extraneous */
482 /* av_log(avctx, AV_LOG_ERROR, "Unexpected Palette chunk %d in non-paletised FLC\n",chunk_type);*/
483 stream_ptr = stream_ptr + chunk_size - 6;
489 compressed_lines = LE_16(&buf[stream_ptr]);
491 while (compressed_lines > 0) {
492 line_packets = LE_16(&buf[stream_ptr]);
494 if (line_packets < 0) {
495 line_packets = -line_packets;
496 y_ptr += line_packets * s->frame.linesize[0];
500 pixel_countdown = s->avctx->width;
501 for (i = 0; i < line_packets; i++) {
502 /* account for the skip bytes */
503 pixel_skip = buf[stream_ptr++];
504 pixel_ptr += (pixel_skip*2); /* Pixel is 2 bytes wide */
505 pixel_countdown -= pixel_skip;
506 byte_run = buf[stream_ptr++];
508 byte_run = -byte_run;
509 pixel = LE_16(&buf[stream_ptr]);
511 CHECK_PIXEL_PTR(byte_run);
512 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
513 *((signed short*)(&pixels[pixel_ptr])) = pixel;
517 CHECK_PIXEL_PTR(byte_run);
518 for (j = 0; j < byte_run; j++, pixel_countdown--) {
519 *((signed short*)(&pixels[pixel_ptr])) = LE_16(&buf[stream_ptr]);
526 y_ptr += s->frame.linesize[0];
532 av_log(avctx, AV_LOG_ERROR, "Unexpected FLI_LC chunk in non-paletised FLC\n");
533 stream_ptr = stream_ptr + chunk_size - 6;
537 /* set the whole frame to 0x0000 which is balck in both 15Bpp and 16Bpp modes. */
538 memset(pixels, 0x0000,
539 s->frame.linesize[0] * s->avctx->height * 2);
544 for (lines = 0; lines < s->avctx->height; lines++) {
546 /* disregard the line packets; instead, iterate through all
549 pixel_countdown = (s->avctx->width * 2);
551 while (pixel_countdown > 0) {
552 byte_run = buf[stream_ptr++];
554 palette_idx1 = buf[stream_ptr++];
555 CHECK_PIXEL_PTR(byte_run);
556 for (j = 0; j < byte_run; j++) {
557 pixels[pixel_ptr++] = palette_idx1;
559 if (pixel_countdown < 0)
560 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
563 } else { /* copy bytes if byte_run < 0 */
564 byte_run = -byte_run;
565 CHECK_PIXEL_PTR(byte_run);
566 for (j = 0; j < byte_run; j++) {
567 palette_idx1 = buf[stream_ptr++];
568 pixels[pixel_ptr++] = palette_idx1;
570 if (pixel_countdown < 0)
571 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
577 /* Now FLX is strange, in that it is "byte" as opposed to "pixel" run length compressed.
578 * This doesnt give us any good oportunity to perform word endian conversion
579 * during decompression. So if its requried (ie, this isnt a LE target, we do
580 * a second pass over the line here, swapping the bytes.
583 if (0xFF00 != LE_16(&pixel)) /* Check if its not an LE Target */
586 pixel_countdown = s->avctx->width;
587 while (pixel_countdown > 0) {
588 *((signed short*)(&pixels[pixel_ptr])) = LE_16(&buf[pixel_ptr]);
592 y_ptr += s->frame.linesize[0];
598 for (lines = 0; lines < s->avctx->height; lines++) {
600 /* disregard the line packets; instead, iterate through all
603 pixel_countdown = s->avctx->width; /* Width is in pixels, not bytes */
605 while (pixel_countdown > 0) {
606 byte_run = buf[stream_ptr++];
608 pixel = LE_16(&buf[stream_ptr]);
610 CHECK_PIXEL_PTR(byte_run);
611 for (j = 0; j < byte_run; j++) {
612 *((signed short*)(&pixels[pixel_ptr])) = pixel;
615 if (pixel_countdown < 0)
616 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
619 } else { /* copy pixels if byte_run < 0 */
620 byte_run = -byte_run;
621 CHECK_PIXEL_PTR(byte_run);
622 for (j = 0; j < byte_run; j++) {
623 *((signed short*)(&pixels[pixel_ptr])) = LE_16(&buf[stream_ptr]);
627 if (pixel_countdown < 0)
628 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
634 y_ptr += s->frame.linesize[0];
640 /* copy the chunk (uncompressed frame) */
641 if (chunk_size - 6 > (unsigned int)(s->avctx->width * s->avctx->height)*2) {
642 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
643 "bigger than image, skipping chunk\n", chunk_size - 6);
644 stream_ptr += chunk_size - 6;
647 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
648 y_ptr += s->frame.linesize[0]) {
650 pixel_countdown = s->avctx->width;
652 while (pixel_countdown > 0) {
653 *((signed short*)(&pixels[y_ptr + pixel_ptr])) = LE_16(&buf[stream_ptr+pixel_ptr]);
657 stream_ptr += s->avctx->width*2;
663 /* some sort of a thumbnail? disregard this chunk... */
664 stream_ptr += chunk_size - 6;
668 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
672 frame_size -= chunk_size;
676 /* by the end of the chunk, the stream ptr should equal the frame
677 * size (minus 1, possibly); if it doesn't, issue a warning */
678 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
679 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
680 "and final chunk ptr = %d\n", buf_size, stream_ptr);
683 *data_size=sizeof(AVFrame);
684 *(AVFrame*)data = s->frame;
689 static int flic_decode_frame_24BPP(AVCodecContext *avctx,
690 void *data, int *data_size,
691 uint8_t *buf, int buf_size)
693 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC Unsupported due to lack of test files.\n");
697 static int flic_decode_frame(AVCodecContext *avctx,
698 void *data, int *data_size,
699 uint8_t *buf, int buf_size)
701 if (avctx->pix_fmt == PIX_FMT_PAL8) {
702 return flic_decode_frame_8BPP(avctx, data, data_size,
705 else if ((avctx->pix_fmt == PIX_FMT_RGB555) ||
706 (avctx->pix_fmt == PIX_FMT_RGB565)) {
707 return flic_decode_frame_15_16BPP(avctx, data, data_size,
710 else if (avctx->pix_fmt == PIX_FMT_BGR24) {
711 return flic_decode_frame_24BPP(avctx, data, data_size,
715 /* Shouldnt get here, ever as the pix_fmt is processed */
716 /* in flic_decode_init and the above if should deal with */
717 /* the finite set of possibilites allowable by here. */
718 /* but in case we do, just error out. */
719 av_log(avctx, AV_LOG_ERROR, "Unknown Format of FLC. My Science cant explain how this happened\n");
724 static int flic_decode_end(AVCodecContext *avctx)
726 FlicDecodeContext *s = avctx->priv_data;
728 if (s->frame.data[0])
729 avctx->release_buffer(avctx, &s->frame);
734 AVCodec flic_decoder = {
738 sizeof(FlicDecodeContext),