FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
flic.c
Go to the documentation of this file.
1 /*
2  * FLI/FLC Animation File Demuxer
3  * Copyright (c) 2003 The ffmpeg Project
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21 
22 /**
23  * @file
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
27  * variations, visit:
28  * http://www.compuphase.com/flic.htm
29  *
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".
32  */
33 
35 #include "libavutil/intreadwrite.h"
36 #include "avformat.h"
37 #include "internal.h"
38 
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
50 
51 #define FLIC_HEADER_SIZE 128
52 #define FLIC_PREAMBLE_SIZE 6
53 
54 typedef struct FlicDemuxContext {
57  int frame_number;
59 
60 static int flic_probe(AVProbeData *p)
61 {
62  int magic_number;
63 
64  if(p->buf_size < FLIC_HEADER_SIZE)
65  return 0;
66 
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))
71  return 0;
72 
73  if(AV_RL16(&p->buf[0x10]) != FLIC_CHUNK_MAGIC_1){
74  if(AV_RL32(&p->buf[0x10]) > 2000)
75  return 0;
76  }
77 
78  if( AV_RL16(&p->buf[0x08]) > 4096
79  || AV_RL16(&p->buf[0x0A]) > 4096)
80  return 0;
81 
82 
83  return AVPROBE_SCORE_MAX;
84 }
85 
86 static int flic_read_header(AVFormatContext *s)
87 {
88  FlicDemuxContext *flic = s->priv_data;
89  AVIOContext *pb = s->pb;
90  unsigned char header[FLIC_HEADER_SIZE];
91  AVStream *st, *ast;
92  int speed;
93  int magic_number;
94  unsigned char preamble[FLIC_PREAMBLE_SIZE];
95 
96  flic->frame_number = 0;
97 
98  /* load the whole header and pull out the width and height */
99  if (avio_read(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
100  return AVERROR(EIO);
101 
102  magic_number = AV_RL16(&header[4]);
103  speed = AV_RL32(&header[0x10]);
104  if (speed == 0)
105  speed = FLIC_DEFAULT_SPEED;
106 
107  /* initialize the decoder streams */
108  st = avformat_new_stream(s, NULL);
109  if (!st)
110  return AVERROR(ENOMEM);
111  flic->video_stream_index = st->index;
114  st->codec->codec_tag = 0; /* no fourcc */
115  st->codec->width = AV_RL16(&header[0x08]);
116  st->codec->height = AV_RL16(&header[0x0A]);
117 
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 */
122  "File with no specified width/height. Trying 640x480.\n");
123  st->codec->width = 640;
124  st->codec->height = 480;
125  }
126 
127  /* send over the whole 128-byte FLIC header */
130  memcpy(st->codec->extradata, header, FLIC_HEADER_SIZE);
131 
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");
135  return AVERROR(EIO);
136  }
137 
138  avio_seek(pb, -FLIC_PREAMBLE_SIZE, SEEK_CUR);
139 
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.
145  */
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);
149  if (!ast)
150  return AVERROR(ENOMEM);
151 
152  flic->audio_stream_index = ast->index;
153 
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]);
158  ast->codec->codec_tag = 0;
160  ast->codec->channels = 1;
162  ast->codec->bit_rate = st->codec->sample_rate * 8;
163  ast->codec->bits_per_coded_sample = 8;
165  ast->codec->extradata_size = 0;
166 
167  /* Since the header information is incorrect we have to figure out the
168  * framerate using block_align and the fact that the audio is 22050 Hz.
169  * We usually have two cases: 2205 -> 10 fps and 1470 -> 15 fps */
172  } else if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
173  avpriv_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
174 
175  /* rewind the stream since the first chunk is at offset 12 */
176  avio_seek(pb, 12, SEEK_SET);
177 
178  /* send over abbreviated FLIC header chunk */
179  av_free(st->codec->extradata);
180  st->codec->extradata_size = 12;
181  st->codec->extradata = av_malloc(12);
182  memcpy(st->codec->extradata, header, 12);
183 
184  } else if (magic_number == FLIC_FILE_MAGIC_1) {
185  avpriv_set_pts_info(st, 64, speed, 70);
186  } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
187  (magic_number == FLIC_FILE_MAGIC_3)) {
188  avpriv_set_pts_info(st, 64, speed, 1000);
189  } else {
190  av_log(s, AV_LOG_ERROR, "Invalid or unsupported magic chunk in file\n");
191  return AVERROR_INVALIDDATA;
192  }
193 
194  return 0;
195 }
196 
197 static int flic_read_packet(AVFormatContext *s,
198  AVPacket *pkt)
199 {
200  FlicDemuxContext *flic = s->priv_data;
201  AVIOContext *pb = s->pb;
202  int packet_read = 0;
203  unsigned int size;
204  int magic;
205  int ret = 0;
206  unsigned char preamble[FLIC_PREAMBLE_SIZE];
207 
208  while (!packet_read) {
209 
210  if ((ret = avio_read(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
212  ret = AVERROR(EIO);
213  break;
214  }
215 
216  size = AV_RL32(&preamble[0]);
217  magic = AV_RL16(&preamble[4]);
218 
219  if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
220  if (av_new_packet(pkt, size)) {
221  ret = AVERROR(EIO);
222  break;
223  }
224  pkt->stream_index = flic->video_stream_index;
225  pkt->pts = flic->frame_number++;
226  pkt->pos = avio_tell(pb);
227  memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
228  ret = avio_read(pb, pkt->data + FLIC_PREAMBLE_SIZE,
229  size - FLIC_PREAMBLE_SIZE);
230  if (ret != size - FLIC_PREAMBLE_SIZE) {
231  av_free_packet(pkt);
232  ret = AVERROR(EIO);
233  }
234  packet_read = 1;
235  } else if (magic == FLIC_TFTD_CHUNK_AUDIO) {
236  if (av_new_packet(pkt, size)) {
237  ret = AVERROR(EIO);
238  break;
239  }
240 
241  /* skip useless 10B sub-header (yes, it's not accounted for in the chunk header) */
242  avio_skip(pb, 10);
243 
244  pkt->stream_index = flic->audio_stream_index;
245  pkt->pos = avio_tell(pb);
246  ret = avio_read(pb, pkt->data, size);
247 
248  if (ret != size) {
249  av_free_packet(pkt);
250  ret = AVERROR(EIO);
251  }
252 
253  packet_read = 1;
254  } else {
255  /* not interested in this chunk */
256  avio_skip(pb, size - 6);
257  }
258  }
259 
260  return ret;
261 }
262 
264  .name = "flic",
265  .long_name = NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation"),
266  .priv_data_size = sizeof(FlicDemuxContext),
270 };