2 * FLI/FLC Animation Video Decoder
3 * Copyright (C) 2003, 2004 the ffmpeg project
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * Autodesk Animator FLI/FLC Video Decoder
24 * by Mike Melanson (melanson@pcisys.net)
25 * for more information on the .fli/.flc file format and all of its many
27 * http://www.compuphase.com/flic.htm
29 * This decoder outputs PAL8/RGB555/RGB565 and maybe one day RGB24
30 * colorspace data, depending on the FLC. To use this decoder, be
31 * sure that your demuxer sends the FLI file header to the decoder via
32 * the extradata chunk in AVCodecContext. The chunk should be 128 bytes
33 * large. The only exception is for FLI files from the game "Magic Carpet",
34 * in which the header is only 12 bytes.
46 #define FLI_256_COLOR 4
54 #define FLI_DTA_BRUN 25
55 #define FLI_DTA_COPY 26
58 #define FLI_TYPE_CODE (0xAF11)
59 #define FLC_FLX_TYPE_CODE (0xAF12)
60 #define FLC_DTA_TYPE_CODE (0xAF44) /* Marks an "Extended FLC" comes from Dave's Targa Animator (DTA) */
61 #define FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE (0xAF13)
63 #define CHECK_PIXEL_PTR(n) \
64 if (pixel_ptr + n > pixel_limit) { \
65 av_log (s->avctx, AV_LOG_INFO, "Problem: pixel_ptr >= pixel_limit (%d >= %d)\n", \
66 pixel_ptr + n, pixel_limit); \
70 typedef struct FlicDecodeContext {
71 AVCodecContext *avctx;
74 unsigned int palette[256];
76 int fli_type; /* either 0xAF11 or 0xAF12, affects palette resolution */
79 static int flic_decode_init(AVCodecContext *avctx)
81 FlicDecodeContext *s = (FlicDecodeContext *)avctx->priv_data;
82 unsigned char *fli_header = (unsigned char *)avctx->extradata;
86 avctx->has_b_frames = 0;
88 s->fli_type = LE_16(&fli_header[4]); /* Might be overridden if a Magic Carpet FLC */
89 depth = LE_16(&fli_header[12]);
92 depth = 8; /* Some FLC generators set depth to zero, when they mean 8Bpp. Fix up here */
95 if (s->avctx->extradata_size == 12) {
96 /* special case for magic carpet FLIs */
97 s->fli_type = FLC_MAGIC_CARPET_SYNTHETIC_TYPE_CODE;
98 } else if (s->avctx->extradata_size != 128) {
99 av_log(avctx, AV_LOG_ERROR, "Expected extradata of 12 or 128 bytes\n");
103 if ((s->fli_type == FLC_FLX_TYPE_CODE) && (depth == 16)) {
104 depth = 15; /* Original Autodesk FLX's say the depth is 16Bpp when it is really 15Bpp */
108 case 8 : avctx->pix_fmt = PIX_FMT_PAL8; break;
109 case 15 : avctx->pix_fmt = PIX_FMT_RGB555; break;
110 case 16 : avctx->pix_fmt = PIX_FMT_RGB565; break;
111 case 24 : avctx->pix_fmt = PIX_FMT_BGR24; /* Supposedly BGR, but havent any files to test with */
112 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC/FLX is unsupported due to no test files.\n");
116 av_log(avctx, AV_LOG_ERROR, "Unkown 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 uint8_t *buf, int buf_size)
130 FlicDecodeContext *s = (FlicDecodeContext *)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;
157 signed char byte_run;
160 unsigned char *pixels;
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 = LE_32(&buf[stream_ptr]);
174 stream_ptr += 6; /* skip the magic number */
175 num_chunks = LE_16(&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 = LE_32(&buf[stream_ptr]);
184 chunk_type = LE_16(&buf[stream_ptr]);
187 switch (chunk_type) {
190 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 = LE_16(&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++) {
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 s->palette[palette_ptr++] = (r << 16) | (g << 8) | b;
229 /* color chunks sometimes have weird 16-bit alignment issues;
230 * therefore, take the hardline approach and set the stream_ptr
231 * to the value calculated w.r.t. the size specified by the color
233 stream_ptr = stream_ptr_after_color_chunk;
239 compressed_lines = LE_16(&buf[stream_ptr]);
241 while (compressed_lines > 0) {
242 line_packets = LE_16(&buf[stream_ptr]);
244 if (line_packets < 0) {
245 line_packets = -line_packets;
246 y_ptr += line_packets * s->frame.linesize[0];
250 pixel_countdown = s->avctx->width;
251 for (i = 0; i < line_packets; i++) {
252 /* account for the skip bytes */
253 pixel_skip = buf[stream_ptr++];
254 pixel_ptr += pixel_skip;
255 pixel_countdown -= pixel_skip;
256 byte_run = buf[stream_ptr++];
258 byte_run = -byte_run;
259 palette_idx1 = buf[stream_ptr++];
260 palette_idx2 = buf[stream_ptr++];
261 CHECK_PIXEL_PTR(byte_run);
262 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
263 pixels[pixel_ptr++] = palette_idx1;
264 pixels[pixel_ptr++] = palette_idx2;
267 CHECK_PIXEL_PTR(byte_run * 2);
268 for (j = 0; j < byte_run * 2; j++, pixel_countdown--) {
269 palette_idx1 = buf[stream_ptr++];
270 pixels[pixel_ptr++] = palette_idx1;
275 y_ptr += s->frame.linesize[0];
281 /* line compressed */
282 starting_line = LE_16(&buf[stream_ptr]);
285 y_ptr += starting_line * s->frame.linesize[0];
287 compressed_lines = LE_16(&buf[stream_ptr]);
289 while (compressed_lines > 0) {
291 pixel_countdown = s->avctx->width;
292 line_packets = buf[stream_ptr++];
293 if (line_packets > 0) {
294 for (i = 0; i < line_packets; i++) {
295 /* account for the skip bytes */
296 pixel_skip = buf[stream_ptr++];
297 pixel_ptr += pixel_skip;
298 pixel_countdown -= pixel_skip;
299 byte_run = buf[stream_ptr++];
301 CHECK_PIXEL_PTR(byte_run);
302 for (j = 0; j < byte_run; j++, pixel_countdown--) {
303 palette_idx1 = buf[stream_ptr++];
304 pixels[pixel_ptr++] = palette_idx1;
307 byte_run = -byte_run;
308 palette_idx1 = buf[stream_ptr++];
309 CHECK_PIXEL_PTR(byte_run);
310 for (j = 0; j < byte_run; j++, pixel_countdown--) {
311 pixels[pixel_ptr++] = palette_idx1;
317 y_ptr += s->frame.linesize[0];
323 /* set the whole frame to color 0 (which is usually black) */
325 s->frame.linesize[0] * s->avctx->height);
329 /* Byte run compression: This chunk type only occurs in the first
330 * FLI frame and it will update the entire frame. */
332 for (lines = 0; lines < s->avctx->height; lines++) {
334 /* disregard the line packets; instead, iterate through all
337 pixel_countdown = s->avctx->width;
338 while (pixel_countdown > 0) {
339 byte_run = buf[stream_ptr++];
341 palette_idx1 = buf[stream_ptr++];
342 CHECK_PIXEL_PTR(byte_run);
343 for (j = 0; j < byte_run; j++) {
344 pixels[pixel_ptr++] = palette_idx1;
346 if (pixel_countdown < 0)
347 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
350 } else { /* copy bytes if byte_run < 0 */
351 byte_run = -byte_run;
352 CHECK_PIXEL_PTR(byte_run);
353 for (j = 0; j < byte_run; j++) {
354 palette_idx1 = buf[stream_ptr++];
355 pixels[pixel_ptr++] = palette_idx1;
357 if (pixel_countdown < 0)
358 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
364 y_ptr += s->frame.linesize[0];
369 /* copy the chunk (uncompressed frame) */
370 if (chunk_size - 6 > s->avctx->width * s->avctx->height) {
371 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
372 "bigger than image, skipping chunk\n", chunk_size - 6);
373 stream_ptr += chunk_size - 6;
375 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
376 y_ptr += s->frame.linesize[0]) {
377 memcpy(&pixels[y_ptr], &buf[stream_ptr],
379 stream_ptr += s->avctx->width;
385 /* some sort of a thumbnail? disregard this chunk... */
386 stream_ptr += chunk_size - 6;
390 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
394 frame_size -= chunk_size;
398 /* by the end of the chunk, the stream ptr should equal the frame
399 * size (minus 1, possibly); if it doesn't, issue a warning */
400 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
401 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
402 "and final chunk ptr = %d\n", buf_size, stream_ptr);
404 /* make the palette available on the way out */
405 // if (s->new_palette) {
407 memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
408 s->frame.palette_has_changed = 1;
412 *data_size=sizeof(AVFrame);
413 *(AVFrame*)data = s->frame;
418 static int flic_decode_frame_15_16BPP(AVCodecContext *avctx,
419 void *data, int *data_size,
420 uint8_t *buf, int buf_size)
422 /* Note, the only difference between the 15Bpp and 16Bpp */
423 /* Format is the pixel format, the packets are processed the same. */
424 FlicDecodeContext *s = (FlicDecodeContext *)avctx->priv_data;
428 unsigned char palette_idx1;
430 unsigned int frame_size;
433 unsigned int chunk_size;
439 int compressed_lines;
440 signed short line_packets;
442 signed char byte_run;
445 unsigned char *pixels;
449 s->frame.reference = 1;
450 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
451 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
452 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
456 pixels = s->frame.data[0];
457 pixel_limit = s->avctx->height * s->frame.linesize[0];
459 frame_size = LE_32(&buf[stream_ptr]);
460 stream_ptr += 6; /* skip the magic number */
461 num_chunks = LE_16(&buf[stream_ptr]);
462 stream_ptr += 10; /* skip padding */
466 /* iterate through the chunks */
467 while ((frame_size > 0) && (num_chunks > 0)) {
468 chunk_size = LE_32(&buf[stream_ptr]);
470 chunk_type = LE_16(&buf[stream_ptr]);
473 switch (chunk_type) {
476 /* For some reason, it seems that non-paletised flics do include one of these */
477 /* chunks in their first frame. Why i do not know, it seems rather extraneous */
478 /* av_log(avctx, AV_LOG_ERROR, "Unexpected Palette chunk %d in non-paletised FLC\n",chunk_type);*/
479 stream_ptr = stream_ptr + chunk_size - 6;
485 compressed_lines = LE_16(&buf[stream_ptr]);
487 while (compressed_lines > 0) {
488 line_packets = LE_16(&buf[stream_ptr]);
490 if (line_packets < 0) {
491 line_packets = -line_packets;
492 y_ptr += line_packets * s->frame.linesize[0];
496 pixel_countdown = s->avctx->width;
497 for (i = 0; i < line_packets; i++) {
498 /* account for the skip bytes */
499 pixel_skip = buf[stream_ptr++];
500 pixel_ptr += (pixel_skip*2); /* Pixel is 2 bytes wide */
501 pixel_countdown -= pixel_skip;
502 byte_run = buf[stream_ptr++];
504 byte_run = -byte_run;
505 pixel = LE_16(&buf[stream_ptr]);
507 CHECK_PIXEL_PTR(byte_run);
508 for (j = 0; j < byte_run; j++, pixel_countdown -= 2) {
509 *((signed short*)(&pixels[pixel_ptr])) = pixel;
513 CHECK_PIXEL_PTR(byte_run);
514 for (j = 0; j < byte_run; j++, pixel_countdown--) {
515 *((signed short*)(&pixels[pixel_ptr])) = LE_16(&buf[stream_ptr]);
522 y_ptr += s->frame.linesize[0];
528 av_log(avctx, AV_LOG_ERROR, "Unexpected FLI_LC chunk in non-paletised FLC\n");
529 stream_ptr = stream_ptr + chunk_size - 6;
533 /* set the whole frame to 0x0000 which is balck in both 15Bpp and 16Bpp modes. */
534 memset(pixels, 0x0000,
535 s->frame.linesize[0] * s->avctx->height * 2);
540 for (lines = 0; lines < s->avctx->height; lines++) {
542 /* disregard the line packets; instead, iterate through all
545 pixel_countdown = (s->avctx->width * 2);
547 while (pixel_countdown > 0) {
548 byte_run = buf[stream_ptr++];
550 palette_idx1 = buf[stream_ptr++];
551 CHECK_PIXEL_PTR(byte_run);
552 for (j = 0; j < byte_run; j++) {
553 pixels[pixel_ptr++] = palette_idx1;
555 if (pixel_countdown < 0)
556 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
559 } else { /* copy bytes if byte_run < 0 */
560 byte_run = -byte_run;
561 CHECK_PIXEL_PTR(byte_run);
562 for (j = 0; j < byte_run; j++) {
563 palette_idx1 = buf[stream_ptr++];
564 pixels[pixel_ptr++] = palette_idx1;
566 if (pixel_countdown < 0)
567 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
573 /* Now FLX is strange, in that it is "byte" as opposed to "pixel" run length compressed.
574 * This doesnt give us any good oportunity to perform word endian conversion
575 * during decompression. So if its requried (ie, this isnt a LE target, we do
576 * a second pass over the line here, swapping the bytes.
579 if (0xFF00 != LE_16(&pixel)) /* Check if its not an LE Target */
582 pixel_countdown = s->avctx->width;
583 while (pixel_countdown > 0) {
584 *((signed short*)(&pixels[pixel_ptr])) = LE_16(&buf[pixel_ptr]);
588 y_ptr += s->frame.linesize[0];
594 for (lines = 0; lines < s->avctx->height; lines++) {
596 /* disregard the line packets; instead, iterate through all
599 pixel_countdown = s->avctx->width; /* Width is in pixels, not bytes */
601 while (pixel_countdown > 0) {
602 byte_run = buf[stream_ptr++];
604 pixel = LE_16(&buf[stream_ptr]);
606 CHECK_PIXEL_PTR(byte_run);
607 for (j = 0; j < byte_run; j++) {
608 *((signed short*)(&pixels[pixel_ptr])) = pixel;
611 if (pixel_countdown < 0)
612 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
615 } else { /* copy pixels if byte_run < 0 */
616 byte_run = -byte_run;
617 CHECK_PIXEL_PTR(byte_run);
618 for (j = 0; j < byte_run; j++) {
619 *((signed short*)(&pixels[pixel_ptr])) = LE_16(&buf[stream_ptr]);
623 if (pixel_countdown < 0)
624 av_log(avctx, AV_LOG_ERROR, "pixel_countdown < 0 (%d)\n",
630 y_ptr += s->frame.linesize[0];
636 /* copy the chunk (uncompressed frame) */
637 if (chunk_size - 6 > (unsigned int)(s->avctx->width * s->avctx->height)*2) {
638 av_log(avctx, AV_LOG_ERROR, "In chunk FLI_COPY : source data (%d bytes) " \
639 "bigger than image, skipping chunk\n", chunk_size - 6);
640 stream_ptr += chunk_size - 6;
643 for (y_ptr = 0; y_ptr < s->frame.linesize[0] * s->avctx->height;
644 y_ptr += s->frame.linesize[0]) {
646 pixel_countdown = s->avctx->width;
648 while (pixel_countdown > 0) {
649 *((signed short*)(&pixels[y_ptr + pixel_ptr])) = LE_16(&buf[stream_ptr+pixel_ptr]);
653 stream_ptr += s->avctx->width*2;
659 /* some sort of a thumbnail? disregard this chunk... */
660 stream_ptr += chunk_size - 6;
664 av_log(avctx, AV_LOG_ERROR, "Unrecognized chunk type: %d\n", chunk_type);
668 frame_size -= chunk_size;
672 /* by the end of the chunk, the stream ptr should equal the frame
673 * size (minus 1, possibly); if it doesn't, issue a warning */
674 if ((stream_ptr != buf_size) && (stream_ptr != buf_size - 1))
675 av_log(avctx, AV_LOG_ERROR, "Processed FLI chunk where chunk size = %d " \
676 "and final chunk ptr = %d\n", buf_size, stream_ptr);
679 *data_size=sizeof(AVFrame);
680 *(AVFrame*)data = s->frame;
685 static int flic_decode_frame_24BPP(AVCodecContext *avctx,
686 void *data, int *data_size,
687 uint8_t *buf, int buf_size)
689 av_log(avctx, AV_LOG_ERROR, "24Bpp FLC Unsupported due to lack of test files.\n");
693 static int flic_decode_frame(AVCodecContext *avctx,
694 void *data, int *data_size,
695 uint8_t *buf, int buf_size)
697 if (avctx->pix_fmt == PIX_FMT_PAL8) {
698 return flic_decode_frame_8BPP(avctx, data, data_size,
701 else if ((avctx->pix_fmt == PIX_FMT_RGB555) ||
702 (avctx->pix_fmt == PIX_FMT_RGB565)) {
703 return flic_decode_frame_15_16BPP(avctx, data, data_size,
706 else if (avctx->pix_fmt == PIX_FMT_BGR24) {
707 return flic_decode_frame_24BPP(avctx, data, data_size,
711 /* Shouldnt get here, ever as the pix_fmt is processed */
712 /* in flic_decode_init and the above if should deal with */
713 /* the finite set of possibilites allowable by here. */
714 /* but in case we do, just error out. */
715 av_log(avctx, AV_LOG_ERROR, "Unknown Format of FLC. My Science cant explain how this happened\n");
720 static int flic_decode_end(AVCodecContext *avctx)
722 FlicDecodeContext *s = avctx->priv_data;
724 if (s->frame.data[0])
725 avctx->release_buffer(avctx, &s->frame);
730 AVCodec flic_decoder = {
734 sizeof(FlicDecodeContext),