2 * FLI/FLC Animation File Demuxer
3 * Copyright (c) 2003 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 * FLI/FLC file demuxer
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 demuxer handles standard 0xAF11- and 0xAF12-type FLIs. It also handles
31 * special FLIs from the PC games "Magic Carpet" and "X-COM: Terror from the Deep".
34 #include "libavutil/channel_layout.h"
35 #include "libavutil/intreadwrite.h"
39 #define FLIC_FILE_MAGIC_1 0xAF11
40 #define FLIC_FILE_MAGIC_2 0xAF12
41 #define FLIC_FILE_MAGIC_3 0xAF44 /* Flic Type for Extended FLX Format which
42 originated in Dave's Targa Animator (DTA) */
43 #define FLIC_CHUNK_MAGIC_1 0xF1FA
44 #define FLIC_CHUNK_MAGIC_2 0xF5FA
45 #define FLIC_MC_SPEED 5 /* speed for Magic Carpet game FLIs */
46 #define FLIC_DEFAULT_SPEED 5 /* for FLIs that have 0 speed */
47 #define FLIC_TFTD_CHUNK_AUDIO 0xAAAA /* Audio chunk. Used in Terror from the Deep.
48 Has 10 B extra header not accounted for in the chunk header */
49 #define FLIC_TFTD_SAMPLE_RATE 22050
51 #define FLIC_HEADER_SIZE 128
52 #define FLIC_PREAMBLE_SIZE 6
54 typedef struct FlicDemuxContext
{
55 int video_stream_index
;
56 int audio_stream_index
;
60 static int flic_probe(AVProbeData
*p
)
64 if(p
->buf_size
< FLIC_HEADER_SIZE
)
67 magic_number
= AV_RL16(&p
->buf
[4]);
68 if ((magic_number
!= FLIC_FILE_MAGIC_1
) &&
69 (magic_number
!= FLIC_FILE_MAGIC_2
) &&
70 (magic_number
!= FLIC_FILE_MAGIC_3
))
73 if(AV_RL16(&p
->buf
[0x10]) != FLIC_CHUNK_MAGIC_1
){
74 if(AV_RL32(&p
->buf
[0x10]) > 2000)
78 if( AV_RL16(&p
->buf
[0x08]) > 4096
79 || AV_RL16(&p
->buf
[0x0A]) > 4096)
83 return AVPROBE_SCORE_MAX
- 1;
86 static int flic_read_header(AVFormatContext
*s
)
88 FlicDemuxContext
*flic
= s
->priv_data
;
89 AVIOContext
*pb
= s
->pb
;
90 unsigned char header
[FLIC_HEADER_SIZE
];
94 unsigned char preamble
[FLIC_PREAMBLE_SIZE
];
96 flic
->frame_number
= 0;
98 /* load the whole header and pull out the width and height */
99 if (avio_read(pb
, header
, FLIC_HEADER_SIZE
) != FLIC_HEADER_SIZE
)
102 magic_number
= AV_RL16(&header
[4]);
103 speed
= AV_RL32(&header
[0x10]);
105 speed
= FLIC_DEFAULT_SPEED
;
107 /* initialize the decoder streams */
108 st
= avformat_new_stream(s
, NULL
);
110 return AVERROR(ENOMEM
);
111 flic
->video_stream_index
= st
->index
;
112 st
->codec
->codec_type
= AVMEDIA_TYPE_VIDEO
;
113 st
->codec
->codec_id
= AV_CODEC_ID_FLIC
;
114 st
->codec
->codec_tag
= 0; /* no fourcc */
115 st
->codec
->width
= AV_RL16(&header
[0x08]);
116 st
->codec
->height
= AV_RL16(&header
[0x0A]);
118 if (!st
->codec
->width
|| !st
->codec
->height
) {
119 /* Ugly hack needed for the following sample: */
120 /* http://samples.mplayerhq.hu/fli-flc/fli-bugs/specular.flc */
121 av_log(s
, AV_LOG_WARNING
,
122 "File with no specified width/height. Trying 640x480.\n");
123 st
->codec
->width
= 640;
124 st
->codec
->height
= 480;
127 /* send over the whole 128-byte FLIC header */
128 if (ff_alloc_extradata(st
->codec
, FLIC_HEADER_SIZE
))
129 return AVERROR(ENOMEM
);
130 memcpy(st
->codec
->extradata
, header
, FLIC_HEADER_SIZE
);
132 /* peek at the preamble to detect TFTD videos - they seem to always start with an audio chunk */
133 if (avio_read(pb
, preamble
, FLIC_PREAMBLE_SIZE
) != FLIC_PREAMBLE_SIZE
) {
134 av_log(s
, AV_LOG_ERROR
, "Failed to peek at preamble\n");
138 avio_seek(pb
, -FLIC_PREAMBLE_SIZE
, SEEK_CUR
);
140 /* Time to figure out the framerate:
141 * If the first preamble's magic number is 0xAAAA then this file is from
142 * X-COM: Terror from the Deep. If on the other hand there is a FLIC chunk
143 * magic number at offset 0x10 assume this file is from Magic Carpet instead.
144 * If neither of the above is true then this is a normal FLIC file.
146 if (AV_RL16(&preamble
[4]) == FLIC_TFTD_CHUNK_AUDIO
) {
147 /* TFTD videos have an extra 22050 Hz 8-bit mono audio stream */
148 ast
= avformat_new_stream(s
, NULL
);
150 return AVERROR(ENOMEM
);
152 flic
->audio_stream_index
= ast
->index
;
154 /* all audio frames are the same size, so use the size of the first chunk for block_align */
155 ast
->codec
->block_align
= AV_RL32(&preamble
[0]);
156 ast
->codec
->codec_type
= AVMEDIA_TYPE_AUDIO
;
157 ast
->codec
->codec_id
= AV_CODEC_ID_PCM_U8
;
158 ast
->codec
->codec_tag
= 0;
159 ast
->codec
->sample_rate
= FLIC_TFTD_SAMPLE_RATE
;
160 ast
->codec
->channels
= 1;
161 ast
->codec
->bit_rate
= st
->codec
->sample_rate
* 8;
162 ast
->codec
->bits_per_coded_sample
= 8;
163 ast
->codec
->channel_layout
= AV_CH_LAYOUT_MONO
;
164 ast
->codec
->extradata_size
= 0;
166 /* Since the header information is incorrect we have to figure out the
167 * framerate using block_align and the fact that the audio is 22050 Hz.
168 * We usually have two cases: 2205 -> 10 fps and 1470 -> 15 fps */
169 avpriv_set_pts_info(st
, 64, ast
->codec
->block_align
, FLIC_TFTD_SAMPLE_RATE
);
170 avpriv_set_pts_info(ast
, 64, 1, FLIC_TFTD_SAMPLE_RATE
);
171 } else if (AV_RL16(&header
[0x10]) == FLIC_CHUNK_MAGIC_1
) {
172 avpriv_set_pts_info(st
, 64, FLIC_MC_SPEED
, 70);
174 /* rewind the stream since the first chunk is at offset 12 */
175 avio_seek(pb
, 12, SEEK_SET
);
177 /* send over abbreviated FLIC header chunk */
178 av_free(st
->codec
->extradata
);
179 if (ff_alloc_extradata(st
->codec
, 12))
180 return AVERROR(ENOMEM
);
181 memcpy(st
->codec
->extradata
, header
, 12);
183 } else if (magic_number
== FLIC_FILE_MAGIC_1
) {
184 avpriv_set_pts_info(st
, 64, speed
, 70);
185 } else if ((magic_number
== FLIC_FILE_MAGIC_2
) ||
186 (magic_number
== FLIC_FILE_MAGIC_3
)) {
187 avpriv_set_pts_info(st
, 64, speed
, 1000);
189 av_log(s
, AV_LOG_ERROR
, "Invalid or unsupported magic chunk in file\n");
190 return AVERROR_INVALIDDATA
;
196 static int flic_read_packet(AVFormatContext
*s
,
199 FlicDemuxContext
*flic
= s
->priv_data
;
200 AVIOContext
*pb
= s
->pb
;
205 unsigned char preamble
[FLIC_PREAMBLE_SIZE
];
207 while (!packet_read
) {
209 if ((ret
= avio_read(pb
, preamble
, FLIC_PREAMBLE_SIZE
)) !=
210 FLIC_PREAMBLE_SIZE
) {
215 size
= AV_RL32(&preamble
[0]);
216 magic
= AV_RL16(&preamble
[4]);
218 if (((magic
== FLIC_CHUNK_MAGIC_1
) || (magic
== FLIC_CHUNK_MAGIC_2
)) && size
> FLIC_PREAMBLE_SIZE
) {
219 if (av_new_packet(pkt
, size
)) {
223 pkt
->stream_index
= flic
->video_stream_index
;
224 pkt
->pts
= flic
->frame_number
++;
225 pkt
->pos
= avio_tell(pb
);
226 memcpy(pkt
->data
, preamble
, FLIC_PREAMBLE_SIZE
);
227 ret
= avio_read(pb
, pkt
->data
+ FLIC_PREAMBLE_SIZE
,
228 size
- FLIC_PREAMBLE_SIZE
);
229 if (ret
!= size
- FLIC_PREAMBLE_SIZE
) {
234 } else if (magic
== FLIC_TFTD_CHUNK_AUDIO
) {
235 if (av_new_packet(pkt
, size
)) {
240 /* skip useless 10B sub-header (yes, it's not accounted for in the chunk header) */
243 pkt
->stream_index
= flic
->audio_stream_index
;
244 pkt
->pos
= avio_tell(pb
);
245 ret
= avio_read(pb
, pkt
->data
, size
);
254 /* not interested in this chunk */
255 avio_skip(pb
, size
- 6);
262 AVInputFormat ff_flic_demuxer
= {
264 .long_name
= NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation"),
265 .priv_data_size
= sizeof(FlicDemuxContext
),
266 .read_probe
= flic_probe
,
267 .read_header
= flic_read_header
,
268 .read_packet
= flic_read_packet
,