FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavformat/flic.c
Date: 2024-04-18 10:05:09
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 "demux.h"
38 #include "internal.h"
39
40 #define FLIC_FILE_MAGIC_1 0xAF11
41 #define FLIC_FILE_MAGIC_2 0xAF12
42 #define FLIC_FILE_MAGIC_3 0xAF44 /* Flic Type for Extended FLX Format which
43 originated in Dave's Targa Animator (DTA) */
44 #define FLIC_CHUNK_MAGIC_1 0xF1FA
45 #define FLIC_CHUNK_MAGIC_2 0xF5FA
46 #define FLIC_MC_SPEED 5 /* speed for Magic Carpet game FLIs */
47 #define FLIC_DEFAULT_SPEED 5 /* for FLIs that have 0 speed */
48 #define FLIC_TFTD_CHUNK_AUDIO 0xAAAA /* Audio chunk. Used in Terror from the Deep.
49 Has 10 B extra header not accounted for in the chunk header */
50 #define FLIC_TFTD_SAMPLE_RATE 22050
51
52 #define FLIC_HEADER_SIZE 128
53 #define FLIC_PREAMBLE_SIZE 6
54
55 typedef struct FlicDemuxContext {
56 int video_stream_index;
57 int audio_stream_index;
58 int frame_number;
59 } FlicDemuxContext;
60
61 7125 static int flic_probe(const AVProbeData *p)
62 {
63 int magic_number;
64
65
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 7119 times.
 7125 if(p->buf_size < FLIC_HEADER_SIZE)
66 6 return 0;
67
68 7119 magic_number = AV_RL16(&p->buf[4]);
69
4/4
✓ Branch 0 taken 7117 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 7115 times.
✓ Branch 3 taken 2 times.
 7119 if ((magic_number != FLIC_FILE_MAGIC_1) &&
70
1/2
✓ Branch 0 taken 7115 times.
✗ Branch 1 not taken.
 7115 (magic_number != FLIC_FILE_MAGIC_2) &&
71 (magic_number != FLIC_FILE_MAGIC_3))
72 7115 return 0;
73
74
2/2
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 1 times.
 4 if(AV_RL16(&p->buf[0x10]) != FLIC_CHUNK_MAGIC_1){
75
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
 3 if(AV_RL32(&p->buf[0x10]) > 2000)
76 ✗ return 0;
77 }
78
79
1/2
✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
 4 if( AV_RL16(&p->buf[0x08]) > 4096
80
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 || AV_RL16(&p->buf[0x0A]) > 4096)
81 ✗ return 0;
82
83
84 4 return AVPROBE_SCORE_MAX - 1;
85 }
86
87 4 static int flic_read_header(AVFormatContext *s)
88 {
89 4 FlicDemuxContext *flic = s->priv_data;
90 4 AVIOContext *pb = s->pb;
91 unsigned char header[FLIC_HEADER_SIZE];
92 AVStream *st, *ast;
93 int speed, ret;
94 int magic_number;
95 unsigned char preamble[FLIC_PREAMBLE_SIZE];
96
97 4 flic->frame_number = 0;
98
99 /* load the whole header and pull out the width and height */
100
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4 times.
 4 if (avio_read(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
101 ✗ return AVERROR(EIO);
102
103 4 magic_number = AV_RL16(&header[4]);
104 4 speed = AV_RL32(&header[0x10]);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (speed == 0)
106 ✗ speed = FLIC_DEFAULT_SPEED;
107
108 /* initialize the decoder streams */
109 4 st = avformat_new_stream(s, NULL);
110
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (!st)
111 ✗ return AVERROR(ENOMEM);
112 4 flic->video_stream_index = st->index;
113 4 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
114 4 st->codecpar->codec_id = AV_CODEC_ID_FLIC;
115 4 st->codecpar->codec_tag = 0; /* no fourcc */
116 4 st->codecpar->width = AV_RL16(&header[0x08]);
117 4 st->codecpar->height = AV_RL16(&header[0x0A]);
118
119
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) {
120 /* Ugly hack needed for the following sample: */
121 /* http://samples.mplayerhq.hu/fli-flc/fli-bugs/specular.flc */
122 ✗ av_log(s, AV_LOG_WARNING,
123 "File with no specified width/height. Trying 640x480.\n");
124 ✗ st->codecpar->width = 640;
125 ✗ st->codecpar->height = 480;
126 }
127
128 /* send over the whole 128-byte FLIC header */
129
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4 times.
 4 if ((ret = ff_alloc_extradata(st->codecpar, FLIC_HEADER_SIZE)) < 0)
130 ✗ return ret;
131 4 memcpy(st->codecpar->extradata, header, FLIC_HEADER_SIZE);
132
133 /* peek at the preamble to detect TFTD videos - they seem to always start with an audio chunk */
134
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4 times.
 4 if (avio_read(pb, preamble, FLIC_PREAMBLE_SIZE) != FLIC_PREAMBLE_SIZE) {
135 ✗ av_log(s, AV_LOG_ERROR, "Failed to peek at preamble\n");
136 ✗ return AVERROR(EIO);
137 }
138
139 4 avio_seek(pb, -FLIC_PREAMBLE_SIZE, SEEK_CUR);
140
141 /* Time to figure out the framerate:
142 * If the first preamble's magic number is 0xAAAA then this file is from
143 * X-COM: Terror from the Deep. If on the other hand there is a FLIC chunk
144 * magic number at offset 0x10 assume this file is from Magic Carpet instead.
145 * If neither of the above is true then this is a normal FLIC file.
146 */
147
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (AV_RL16(&preamble[4]) == FLIC_TFTD_CHUNK_AUDIO) {
148 /* TFTD videos have an extra 22050 Hz 8-bit mono audio stream */
149 ✗ ast = avformat_new_stream(s, NULL);
150 ✗ if (!ast)
151 ✗ return AVERROR(ENOMEM);
152
153 ✗ flic->audio_stream_index = ast->index;
154
155 /* all audio frames are the same size, so use the size of the first chunk for block_align */
156 ✗ ast->codecpar->block_align = AV_RL32(&preamble[0]);
157 ✗ ast->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
158 ✗ ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
159 ✗ ast->codecpar->codec_tag = 0;
160 ✗ ast->codecpar->sample_rate = FLIC_TFTD_SAMPLE_RATE;
161 ✗ ast->codecpar->bit_rate = st->codecpar->sample_rate * 8;
162 ✗ ast->codecpar->bits_per_coded_sample = 8;
163 ✗ ast->codecpar->ch_layout = (AVChannelLayout)AV_CHANNEL_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
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 3 times.
 4 } else if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
172 1 avpriv_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
173
174 /* rewind the stream since the first chunk is at offset 12 */
175 1 avio_seek(pb, 12, SEEK_SET);
176
177 /* send over abbreviated FLIC header chunk */
178
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1 times.
 1 if ((ret = ff_alloc_extradata(st->codecpar, 12)) < 0)
179 ✗ return ret;
180 1 memcpy(st->codecpar->extradata, header, 12);
181
182
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 1 times.
 3 } else if (magic_number == FLIC_FILE_MAGIC_1) {
183 2 avpriv_set_pts_info(st, 64, speed, 70);
184
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) ||
185 (magic_number == FLIC_FILE_MAGIC_3)) {
186 1 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 4 return 0;
193 }
194
195 522 static int flic_read_packet(AVFormatContext *s,
196 AVPacket *pkt)
197 {
198 522 FlicDemuxContext *flic = s->priv_data;
199 522 AVIOContext *pb = s->pb;
200 522 int packet_read = 0;
201 unsigned int size;
202 int magic;
203 522 int ret = 0;
204 unsigned char preamble[FLIC_PREAMBLE_SIZE];
205 522 int64_t pos = avio_tell(pb);
206
207
3/4
✓ Branch 0 taken 522 times.
✓ Branch 1 taken 519 times.
✓ Branch 3 taken 522 times.
✗ Branch 4 not taken.
 1041 while (!packet_read && !avio_feof(pb)) {
208
209
2/2
✓ Branch 1 taken 3 times.
✓ Branch 2 taken 519 times.
 522 if ((ret = avio_read(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
210 FLIC_PREAMBLE_SIZE) {
211 3 ret = AVERROR(EIO);
212 3 break;
213 }
214
215 519 size = AV_RL32(&preamble[0]);
216 519 magic = AV_RL16(&preamble[4]);
217
218
2/6
✗ Branch 0 not taken.
✓ Branch 1 taken 519 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 519 times.
✗ Branch 5 not taken.
 519 if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
219
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 519 times.
 519 if ((ret = av_new_packet(pkt, size)) < 0)
220 ✗ return ret;
221
222 519 pkt->stream_index = flic->video_stream_index;
223 519 pkt->pos = pos;
224 519 memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
225 519 ret = avio_read(pb, pkt->data + FLIC_PREAMBLE_SIZE,
226 519 size - FLIC_PREAMBLE_SIZE);
227
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 519 times.
 519 if (ret != size - FLIC_PREAMBLE_SIZE) {
228 ✗ ret = AVERROR(EIO);
229 }
230 519 pkt->flags = flic->frame_number == 0 ? AV_PKT_FLAG_KEY : 0;
231 519 pkt->pts = flic->frame_number;
232
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 515 times.
 519 if (flic->frame_number == 0)
233 4 av_add_index_entry(s->streams[flic->video_stream_index], pkt->pos, pkt->pts, pkt->size, 0, AVINDEX_KEYFRAME);
234 519 packet_read = 1;
235 519 flic->frame_number++;
236 ✗ } else if (magic == FLIC_TFTD_CHUNK_AUDIO) {
237 ✗ if ((ret = av_new_packet(pkt, size)) < 0)
238 ✗ return ret;
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 = pos;
245 ✗ pkt->flags = AV_PKT_FLAG_KEY;
246 ✗ ret = avio_read(pb, pkt->data, size);
247
248 ✗ if (ret != size) {
249 ✗ ret = AVERROR(EIO);
250 ✗ break;
251 }
252
253 ✗ packet_read = 1;
254 } else {
255 /* not interested in this chunk */
256 ✗ avio_skip(pb, size - 6);
257 }
258 }
259
260
2/2
✓ Branch 1 taken 519 times.
✓ Branch 2 taken 3 times.
 522 return avio_feof(pb) ? AVERROR_EOF : ret;
261 }
262
263 ✗ static int flic_read_seek(AVFormatContext *s, int stream_index,
264 int64_t pts, int flags)
265 {
266 ✗ FlicDemuxContext *flic = s->priv_data;
267 ✗ AVStream *st = s->streams[stream_index];
268 ✗ FFStream *const sti = ffstream(st);
269 int64_t pos, ts;
270 int index;
271
272 ✗ if (!sti->index_entries || stream_index != flic->video_stream_index)
273 ✗ return -1;
274
275 ✗ index = av_index_search_timestamp(st, pts, flags);
276
277 ✗ if (index < 0)
278 ✗ index = av_index_search_timestamp(st, pts, flags ^ AVSEEK_FLAG_BACKWARD);
279 ✗ if (index < 0)
280 ✗ return -1;
281
282 ✗ pos = sti->index_entries[index].pos;
283 ✗ ts = sti->index_entries[index].timestamp;
284 ✗ flic->frame_number = ts;
285 ✗ avio_seek(s->pb, pos, SEEK_SET);
286 ✗ return 0;
287 }
288
289 const FFInputFormat ff_flic_demuxer = {
290 .p.name = "flic",
291 .p.long_name = NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation"),
292 .priv_data_size = sizeof(FlicDemuxContext),
293 .read_probe = flic_probe,
294 .read_header = flic_read_header,
295 .read_packet = flic_read_packet,
296 .read_seek = flic_read_seek,
297 };
298