FFmpeg
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 {
59 
60 static int flic_probe(const 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 - 1;
84 }
85 
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, ret;
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->codecpar->codec_tag = 0; /* no fourcc */
115  st->codecpar->width = AV_RL16(&header[0x08]);
116  st->codecpar->height = AV_RL16(&header[0x0A]);
117 
118  if (!st->codecpar->width || !st->codecpar->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->codecpar->width = 640;
124  st->codecpar->height = 480;
125  }
126 
127  /* send over the whole 128-byte FLIC header */
128  if ((ret = ff_alloc_extradata(st->codecpar, FLIC_HEADER_SIZE)) < 0)
129  return ret;
130  memcpy(st->codecpar->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->codecpar->block_align = AV_RL32(&preamble[0]);
158  ast->codecpar->codec_tag = 0;
160  ast->codecpar->channels = 1;
161  ast->codecpar->bit_rate = st->codecpar->sample_rate * 8;
164  ast->codecpar->extradata_size = 0;
165 
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 */
171  } else if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
172  avpriv_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
173 
174  /* rewind the stream since the first chunk is at offset 12 */
175  avio_seek(pb, 12, SEEK_SET);
176 
177  /* send over abbreviated FLIC header chunk */
178  if ((ret = ff_alloc_extradata(st->codecpar, 12)) < 0)
179  return ret;
180  memcpy(st->codecpar->extradata, header, 12);
181 
182  } else if (magic_number == FLIC_FILE_MAGIC_1) {
183  avpriv_set_pts_info(st, 64, speed, 70);
184  } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
185  (magic_number == FLIC_FILE_MAGIC_3)) {
186  avpriv_set_pts_info(st, 64, speed, 1000);
187  } else {
188  av_log(s, AV_LOG_ERROR, "Invalid or unsupported magic chunk in file\n");
189  return AVERROR_INVALIDDATA;
190  }
191 
192  return 0;
193 }
194 
196  AVPacket *pkt)
197 {
198  FlicDemuxContext *flic = s->priv_data;
199  AVIOContext *pb = s->pb;
200  int packet_read = 0;
201  unsigned int size;
202  int magic;
203  int ret = 0;
204  unsigned char preamble[FLIC_PREAMBLE_SIZE];
205 
206  while (!packet_read && !avio_feof(pb)) {
207 
208  if ((ret = avio_read(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
210  ret = AVERROR(EIO);
211  break;
212  }
213 
214  size = AV_RL32(&preamble[0]);
215  magic = AV_RL16(&preamble[4]);
216 
217  if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
218  if ((ret = av_new_packet(pkt, size)) < 0)
219  return ret;
220 
221  pkt->stream_index = flic->video_stream_index;
222  pkt->pts = flic->frame_number++;
223  pkt->pos = avio_tell(pb);
224  memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
225  ret = avio_read(pb, pkt->data + FLIC_PREAMBLE_SIZE,
226  size - FLIC_PREAMBLE_SIZE);
227  if (ret != size - FLIC_PREAMBLE_SIZE) {
228  ret = AVERROR(EIO);
229  }
230  packet_read = 1;
231  } else if (magic == FLIC_TFTD_CHUNK_AUDIO) {
232  if ((ret = av_new_packet(pkt, size)) < 0)
233  return ret;
234 
235  /* skip useless 10B sub-header (yes, it's not accounted for in the chunk header) */
236  avio_skip(pb, 10);
237 
238  pkt->stream_index = flic->audio_stream_index;
239  pkt->pos = avio_tell(pb);
240  ret = avio_read(pb, pkt->data, size);
241 
242  if (ret != size) {
243  ret = AVERROR(EIO);
244  break;
245  }
246 
247  packet_read = 1;
248  } else {
249  /* not interested in this chunk */
250  avio_skip(pb, size - 6);
251  }
252  }
253 
254  return avio_feof(pb) ? AVERROR_EOF : ret;
255 }
256 
258  .name = "flic",
259  .long_name = NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation"),
260  .priv_data_size = sizeof(FlicDemuxContext),
264 };
#define FLIC_CHUNK_MAGIC_2
Definition: flic.c:44
#define NULL
Definition: coverity.c:32
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:200
int64_t pos
byte position in stream, -1 if unknown
Definition: packet.h:383
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4938
#define FLIC_FILE_MAGIC_2
Definition: flic.c:40
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
int index
stream index in AVFormatContext
Definition: avformat.h:877
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:253
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:341
static AVPacket pkt
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:87
Format I/O context.
Definition: avformat.h:1351
int width
Video only.
Definition: codec_par.h:126
#define FLIC_TFTD_CHUNK_AUDIO
Definition: flic.c:47
int frame_number
Definition: flic.c:57
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4519
uint8_t * data
Definition: packet.h:363
#define AVERROR_EOF
End of file.
Definition: error.h:55
ptrdiff_t size
Definition: opengl_enc.c:100
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
static const uint8_t header[24]
Definition: sdr2.c:67
uint64_t channel_layout
Audio only.
Definition: codec_par.h:162
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:637
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:89
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:88
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:153
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
#define FLIC_FILE_MAGIC_3
Definition: flic.c:41
int extradata_size
Size of the extradata content in bytes.
Definition: codec_par.h:78
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:444
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
int block_align
Audio only.
Definition: codec_par.h:177
int audio_stream_index
Definition: flic.c:56
audio channel layout utility functions
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0...
Definition: utils.c:3321
int video_stream_index
Definition: flic.c:55
#define s(width, name)
Definition: cbs_vp9.c:257
#define FLIC_TFTD_SAMPLE_RATE
Definition: flic.c:49
#define FLIC_MC_SPEED
Definition: flic.c:45
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
Stream structure.
Definition: avformat.h:876
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
#define FLIC_FILE_MAGIC_1
Definition: flic.c:39
static int flic_read_header(AVFormatContext *s)
Definition: flic.c:86
AVIOContext * pb
I/O context.
Definition: avformat.h:1393
AVInputFormat ff_flic_demuxer
Definition: flic.c:257
#define FLIC_CHUNK_MAGIC_1
Definition: flic.c:43
#define FLIC_PREAMBLE_SIZE
Definition: flic.c:52
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
int sample_rate
Audio only.
Definition: codec_par.h:170
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
Main libavformat public API header.
#define FLIC_DEFAULT_SPEED
Definition: flic.c:46
void * priv_data
Format private data.
Definition: avformat.h:1379
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
static int flic_probe(const AVProbeData *p)
Definition: flic.c:60
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:74
int channels
Audio only.
Definition: codec_par.h:166
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:650
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1023
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:368
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:64
int stream_index
Definition: packet.h:365
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions
#define AV_CH_LAYOUT_MONO
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: packet.h:340
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:356
#define FLIC_HEADER_SIZE
Definition: flic.c:51
static int flic_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: flic.c:195