FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavformat/flic.c
Date: 2022-12-05 20:26:17
Exec Total Coverage
Lines: 71 131 54.2%
Functions: 3 4 75.0%
Branches: 39 78 50.0%

Line Branch Exec Source
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 6782 static int flic_probe(const AVProbeData *p)
61 {
62 int magic_number;
63
64
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 6777 times.
6782 if(p->buf_size < FLIC_HEADER_SIZE)
65 5 return 0;
66
67 6777 magic_number = AV_RL16(&p->buf[4]);
68
4/4
✓ Branch 0 taken 6775 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 6773 times.
✓ Branch 3 taken 2 times.
6777 if ((magic_number != FLIC_FILE_MAGIC_1) &&
69
1/2
✓ Branch 0 taken 6773 times.
✗ Branch 1 not taken.
6773 (magic_number != FLIC_FILE_MAGIC_2) &&
70 (magic_number != FLIC_FILE_MAGIC_3))
71 6773 return 0;
72
73
2/2
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 1 times.
4 if(AV_RL16(&p->buf[0x10]) != FLIC_CHUNK_MAGIC_1){
74
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
3 if(AV_RL32(&p->buf[0x10]) > 2000)
75 return 0;
76 }
77
78
1/2
✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
4 if( AV_RL16(&p->buf[0x08]) > 4096
79
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
4 || AV_RL16(&p->buf[0x0A]) > 4096)
80 return 0;
81
82
83 4 return AVPROBE_SCORE_MAX - 1;
84 }
85
86 4 static int flic_read_header(AVFormatContext *s)
87 {
88 4 FlicDemuxContext *flic = s->priv_data;
89 4 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 4 flic->frame_number = 0;
97
98 /* load the whole header and pull out the width and height */
99
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4 times.
4 if (avio_read(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
100 return AVERROR(EIO);
101
102 4 magic_number = AV_RL16(&header[4]);
103 4 speed = AV_RL32(&header[0x10]);
104
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
4 if (speed == 0)
105 speed = FLIC_DEFAULT_SPEED;
106
107 /* initialize the decoder streams */
108 4 st = avformat_new_stream(s, NULL);
109
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
4 if (!st)
110 return AVERROR(ENOMEM);
111 4 flic->video_stream_index = st->index;
112 4 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
113 4 st->codecpar->codec_id = AV_CODEC_ID_FLIC;
114 4 st->codecpar->codec_tag = 0; /* no fourcc */
115 4 st->codecpar->width = AV_RL16(&header[0x08]);
116 4 st->codecpar->height = AV_RL16(&header[0x0A]);
117
118
2/4
✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 4 times.
4 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
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4 times.
4 if ((ret = ff_alloc_extradata(st->codecpar, FLIC_HEADER_SIZE)) < 0)
129 return ret;
130 4 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
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4 times.
4 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 4 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
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
4 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->bit_rate = st->codecpar->sample_rate * 8;
161 ast->codecpar->bits_per_coded_sample = 8;
162 ast->codecpar->ch_layout = (AVChannelLayout)AV_CHANNEL_LAYOUT_MONO;
163 ast->codecpar->extradata_size = 0;
164
165 /* Since the header information is incorrect we have to figure out the
166 * framerate using block_align and the fact that the audio is 22050 Hz.
167 * We usually have two cases: 2205 -> 10 fps and 1470 -> 15 fps */
168 avpriv_set_pts_info(st, 64, ast->codecpar->block_align, FLIC_TFTD_SAMPLE_RATE);
169 avpriv_set_pts_info(ast, 64, 1, FLIC_TFTD_SAMPLE_RATE);
170
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 3 times.
4 } else if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
171 1 avpriv_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
172
173 /* rewind the stream since the first chunk is at offset 12 */
174 1 avio_seek(pb, 12, SEEK_SET);
175
176 /* send over abbreviated FLIC header chunk */
177
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1 times.
1 if ((ret = ff_alloc_extradata(st->codecpar, 12)) < 0)
178 return ret;
179 1 memcpy(st->codecpar->extradata, header, 12);
180
181
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 1 times.
3 } else if (magic_number == FLIC_FILE_MAGIC_1) {
182 2 avpriv_set_pts_info(st, 64, speed, 70);
183
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
1 } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
184 (magic_number == FLIC_FILE_MAGIC_3)) {
185 1 avpriv_set_pts_info(st, 64, speed, 1000);
186 } else {
187 av_log(s, AV_LOG_ERROR, "Invalid or unsupported magic chunk in file\n");
188 return AVERROR_INVALIDDATA;
189 }
190
191 4 return 0;
192 }
193
194 506 static int flic_read_packet(AVFormatContext *s,
195 AVPacket *pkt)
196 {
197 506 FlicDemuxContext *flic = s->priv_data;
198 506 AVIOContext *pb = s->pb;
199 506 int packet_read = 0;
200 unsigned int size;
201 int magic;
202 506 int ret = 0;
203 unsigned char preamble[FLIC_PREAMBLE_SIZE];
204 506 int64_t pos = avio_tell(pb);
205
206
3/4
✓ Branch 0 taken 506 times.
✓ Branch 1 taken 503 times.
✓ Branch 3 taken 506 times.
✗ Branch 4 not taken.
1009 while (!packet_read && !avio_feof(pb)) {
207
208
2/2
✓ Branch 1 taken 3 times.
✓ Branch 2 taken 503 times.
506 if ((ret = avio_read(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
209 FLIC_PREAMBLE_SIZE) {
210 3 ret = AVERROR(EIO);
211 3 break;
212 }
213
214 503 size = AV_RL32(&preamble[0]);
215 503 magic = AV_RL16(&preamble[4]);
216
217
2/6
✗ Branch 0 not taken.
✓ Branch 1 taken 503 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 503 times.
✗ Branch 5 not taken.
503 if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
218
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 503 times.
503 if ((ret = av_new_packet(pkt, size)) < 0)
219 return ret;
220
221 503 pkt->stream_index = flic->video_stream_index;
222 503 pkt->pos = pos;
223 503 memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
224 503 ret = avio_read(pb, pkt->data + FLIC_PREAMBLE_SIZE,
225 503 size - FLIC_PREAMBLE_SIZE);
226
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 503 times.
503 if (ret != size - FLIC_PREAMBLE_SIZE) {
227 ret = AVERROR(EIO);
228 }
229 503 pkt->flags = flic->frame_number == 0 ? AV_PKT_FLAG_KEY : 0;
230 503 pkt->pts = flic->frame_number;
231
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 499 times.
503 if (flic->frame_number == 0)
232 4 av_add_index_entry(s->streams[flic->video_stream_index], pkt->pos, pkt->pts, pkt->size, 0, AVINDEX_KEYFRAME);
233 503 packet_read = 1;
234 503 flic->frame_number++;
235 } else if (magic == FLIC_TFTD_CHUNK_AUDIO) {
236 if ((ret = av_new_packet(pkt, size)) < 0)
237 return ret;
238
239 /* skip useless 10B sub-header (yes, it's not accounted for in the chunk header) */
240 avio_skip(pb, 10);
241
242 pkt->stream_index = flic->audio_stream_index;
243 pkt->pos = pos;
244 pkt->flags = AV_PKT_FLAG_KEY;
245 ret = avio_read(pb, pkt->data, size);
246
247 if (ret != size) {
248 ret = AVERROR(EIO);
249 break;
250 }
251
252 packet_read = 1;
253 } else {
254 /* not interested in this chunk */
255 avio_skip(pb, size - 6);
256 }
257 }
258
259
2/2
✓ Branch 1 taken 503 times.
✓ Branch 2 taken 3 times.
506 return avio_feof(pb) ? AVERROR_EOF : ret;
260 }
261
262 static int flic_read_seek(AVFormatContext *s, int stream_index,
263 int64_t pts, int flags)
264 {
265 FlicDemuxContext *flic = s->priv_data;
266 AVStream *st = s->streams[stream_index];
267 FFStream *const sti = ffstream(st);
268 int64_t pos, ts;
269 int index;
270
271 if (!sti->index_entries || stream_index != flic->video_stream_index)
272 return -1;
273
274 index = av_index_search_timestamp(st, pts, flags);
275
276 if (index < 0)
277 index = av_index_search_timestamp(st, pts, flags ^ AVSEEK_FLAG_BACKWARD);
278 if (index < 0)
279 return -1;
280
281 pos = sti->index_entries[index].pos;
282 ts = sti->index_entries[index].timestamp;
283 flic->frame_number = ts;
284 avio_seek(s->pb, pos, SEEK_SET);
285 return 0;
286 }
287
288 const AVInputFormat ff_flic_demuxer = {
289 .name = "flic",
290 .long_name = NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation"),
291 .priv_data_size = sizeof(FlicDemuxContext),
292 .read_probe = flic_probe,
293 .read_header = flic_read_header,
294 .read_packet = flic_read_packet,
295 .read_seek = flic_read_seek,
296 };
297