FFmpeg: libavformat/flic.c Source File

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 
34 #include "libavutil/channel_layout.h"
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 {
55   int video_stream_index;
56   int audio_stream_index;
57   int frame_number;
58 } FlicDemuxContext;
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 - 1;
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;
112  st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
113  st->codecpar->codec_id = AV_CODEC_ID_FLIC;
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 */
121  av_log(s, AV_LOG_WARNING,
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 (ff_alloc_extradata(st->codecpar, FLIC_HEADER_SIZE))
129  return AVERROR(ENOMEM);
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]);
156  ast->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
157  ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
158  ast->codecpar->codec_tag = 0;
159  ast->codecpar->sample_rate = FLIC_TFTD_SAMPLE_RATE;
160  ast->codecpar->channels = 1;
161  ast->codecpar->bit_rate = st->codecpar->sample_rate * 8;
162  ast->codecpar->bits_per_coded_sample = 8;
163  ast->codecpar->channel_layout = AV_CH_LAYOUT_MONO;
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 */
169  avpriv_set_pts_info(st, 64, ast->codecpar->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);
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  av_freep(&st->codecpar->extradata);
179  if (ff_alloc_extradata(st->codecpar, 12))
180  return AVERROR(ENOMEM);
181  memcpy(st->codecpar->extradata, header, 12);
182 
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);
188  } else {
189  av_log(s, AV_LOG_ERROR, "Invalid or unsupported magic chunk in file\n");
190  return AVERROR_INVALIDDATA;
191  }
192 
193  return 0;
194 }
195 
196  static int flic_read_packet(AVFormatContext *s,
197  AVPacket *pkt)
198 {
199  FlicDemuxContext *flic = s->priv_data;
200  AVIOContext *pb = s->pb;
201  int packet_read = 0;
202  unsigned int size;
203  int magic;
204  int ret = 0;
205  unsigned char preamble[FLIC_PREAMBLE_SIZE];
206 
207  while (!packet_read && !avio_feof(pb)) {
208 
209  if ((ret = avio_read(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
210  FLIC_PREAMBLE_SIZE) {
211  ret = AVERROR(EIO);
212  break;
213  }
214 
215  size = AV_RL32(&preamble[0]);
216  magic = AV_RL16(&preamble[4]);
217 
218  if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
219  if (av_new_packet(pkt, size)) {
220  ret = AVERROR(EIO);
221  break;
222  }
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) {
230  av_packet_unref(pkt);
231  ret = AVERROR(EIO);
232  }
233  packet_read = 1;
234  } else if (magic == FLIC_TFTD_CHUNK_AUDIO) {
235  if (av_new_packet(pkt, size)) {
236  ret = AVERROR(EIO);
237  break;
238  }
239 
240  /* skip useless 10B sub-header (yes, it's not accounted for in the chunk header) */
241  avio_skip(pb, 10);
242 
243  pkt->stream_index = flic->audio_stream_index;
244  pkt->pos = avio_tell(pb);
245  ret = avio_read(pb, pkt->data, size);
246 
247  if (ret != size) {
248  av_packet_unref(pkt);
249  ret = AVERROR(EIO);
250  }
251 
252  packet_read = 1;
253  } else {
254  /* not interested in this chunk */
255  avio_skip(pb, size - 6);
256  }
257  }
258 
259  return avio_feof(pb) ? AVERROR_EOF : ret;
260 }
261 
262  AVInputFormat ff_flic_demuxer = {
263  .name = "flic",
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,
269 };
FLIC_CHUNK_MAGIC_2
#define FLIC_CHUNK_MAGIC_2
Definition: flic.c:44
NULL
#define NULL
Definition: coverity.c:32
s
const char * s
Definition: avisynth_c.h:768
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
AVPacket::pos
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:1450
avpriv_set_pts_info
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:4820
FLIC_FILE_MAGIC_2
#define FLIC_FILE_MAGIC_2
Definition: flic.c:40
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3884
AVStream::index
int index
stream index in AVFormatContext
Definition: avformat.h:874
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:331
pkt
static AVPacket pkt
Definition: demuxing_decoding.c:54
AV_RL16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:87
AVFormatContext
Format I/O context.
Definition: avformat.h:1342
AVCodecParameters::width
int width
Video only.
Definition: avcodec.h:3950
FLIC_TFTD_CHUNK_AUDIO
#define FLIC_TFTD_CHUNK_AUDIO
Definition: flic.c:47
FlicDemuxContext::frame_number
int frame_number
Definition: flic.c:57
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4450
AVPacket::data
uint8_t * data
Definition: avcodec.h:1430
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:55
size
ptrdiff_t size
Definition: opengl_enc.c:101
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
header
static const uint8_t header[24]
Definition: sdr2.c:67
AVCodecParameters::channel_layout
uint64_t channel_layout
Audio only.
Definition: avcodec.h:3986
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:648
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: avcodec.h:3913
av_new_packet
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:86
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
AVERROR
#define AVERROR(e)
Definition: error.h:43
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3880
AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
FLIC_FILE_MAGIC_3
#define FLIC_FILE_MAGIC_3
Definition: flic.c:41
AVCodecParameters::extradata_size
int extradata_size
Size of the extradata content in bytes.
Definition: avcodec.h:3902
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:451
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:450
AVCodecParameters::block_align
int block_align
Audio only.
Definition: avcodec.h:4001
FlicDemuxContext::audio_stream_index
int audio_stream_index
Definition: flic.c:56
channel_layout.h
audio channel layout utility functions
ff_alloc_extradata
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:3280
FlicDemuxContext::video_stream_index
int video_stream_index
Definition: flic.c:55
flic_probe
static int flic_probe(AVProbeData *p)
Definition: flic.c:60
read_probe
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
FLIC_TFTD_SAMPLE_RATE
#define FLIC_TFTD_SAMPLE_RATE
Definition: flic.c:49
FLIC_MC_SPEED
#define FLIC_MC_SPEED
Definition: flic.c:45
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:530
AVStream
Stream structure.
Definition: avformat.h:873
AV_CODEC_ID_PCM_U8
Definition: avcodec.h:457
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
FLIC_FILE_MAGIC_1
#define FLIC_FILE_MAGIC_1
Definition: flic.c:39
flic_read_header
static int flic_read_header(AVFormatContext *s)
Definition: flic.c:86
AVFormatContext::pb
AVIOContext * pb
I/O context.
Definition: avformat.h:1384
ff_flic_demuxer
AVInputFormat ff_flic_demuxer
Definition: flic.c:262
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:592
FLIC_CHUNK_MAGIC_1
#define FLIC_CHUNK_MAGIC_1
Definition: flic.c:43
FLIC_PREAMBLE_SIZE
#define FLIC_PREAMBLE_SIZE
Definition: flic.c:52
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:448
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: avcodec.h:3994
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:460
avformat.h
Main libavformat public API header.
FLIC_DEFAULT_SPEED
#define FLIC_DEFAULT_SPEED
Definition: flic.c:46
AVFormatContext::priv_data
void * priv_data
Format private data.
Definition: avformat.h:1370
AV_CODEC_ID_FLIC
Definition: avcodec.h:268
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: avcodec.h:3926
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3898
AVCodecParameters::channels
int channels
Audio only.
Definition: avcodec.h:3990
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:647
AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1020
avio_feof
int avio_feof(AVIOContext *s)
feof() equivalent for AVIOContext.
Definition: aviobuf.c:358
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3888
AVPacket::stream_index
int stream_index
Definition: avcodec.h:1432
AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_MONO
Definition: channel_layout.h:85
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
AVPacket
This structure stores compressed data.
Definition: avcodec.h:1407
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1423
FLIC_HEADER_SIZE
#define FLIC_HEADER_SIZE
Definition: flic.c:51
flic_read_packet
static int flic_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: flic.c:196
Generated on Sun May 13 2018 02:04:04 for FFmpeg by   doxygen 1.8.6

AltStyle によって変換されたページ (->オリジナル) /