FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavformat/segafilm.c
Date: 2026-05-01 13:04:54
Exec Total Coverage
Lines: 137 170 80.6%
Functions: 4 5 80.0%
Branches: 62 92 67.4%
Line Branch Exec Source
1 /*
2 * Sega FILM Format (CPK) 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 * Sega FILM (.cpk) file demuxer
25 * by Mike Melanson (melanson@pcisys.net)
26 * For more information regarding the Sega FILM file format, visit:
27 * http://www.pcisys.net/~melanson/codecs/
28 */
29
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/mem.h"
32 #include "avformat.h"
33 #include "avio_internal.h"
34 #include "demux.h"
35 #include "internal.h"
36
37 #define FILM_TAG MKBETAG('F', 'I', 'L', 'M')
38 #define FDSC_TAG MKBETAG('F', 'D', 'S', 'C')
39 #define STAB_TAG MKBETAG('S', 'T', 'A', 'B')
40 #define CVID_TAG MKBETAG('c', 'v', 'i', 'd')
41 #define RAW_TAG MKBETAG('r', 'a', 'w', ' ')
42
43 typedef struct film_sample {
44 int stream;
45 unsigned int sample_size;
46 int64_t sample_offset;
47 int64_t pts;
48 int keyframe;
49 } film_sample;
50
51 typedef struct FilmDemuxContext {
52 int video_stream_index;
53 int audio_stream_index;
54
55 enum AVCodecID audio_type;
56 unsigned int audio_samplerate;
57 unsigned int audio_bits;
58 unsigned int audio_channels;
59
60 enum AVCodecID video_type;
61 unsigned int sample_count;
62 film_sample *sample_table;
63 unsigned int current_sample;
64
65 unsigned int base_clock;
66 unsigned int version;
67 } FilmDemuxContext;
68
69 7480 static int film_probe(const AVProbeData *p)
70 {
71
2/2
✓ Branch 0 taken 7475 times.
✓ Branch 1 taken 5 times.
 7480 if (AV_RB32(&p->buf[0]) != FILM_TAG)
72 7475 return 0;
73
74
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5 times.
 5 if (AV_RB32(&p->buf[16]) != FDSC_TAG)
75 ✗ return 0;
76
77 5 return AVPROBE_SCORE_MAX;
78 }
79
80 7 static int film_read_close(AVFormatContext *s)
81 {
82 7 FilmDemuxContext *film = s->priv_data;
83
84 7 av_freep(&film->sample_table);
85
86 7 return 0;
87 }
88
89 7 static int film_read_header(AVFormatContext *s)
90 {
91 7 FilmDemuxContext *film = s->priv_data;
92 7 AVIOContext *pb = s->pb;
93 AVStream *st;
94 unsigned char scratch[256];
95 int i;
96 unsigned int data_offset;
97 unsigned int audio_frame_counter;
98 unsigned int video_frame_counter;
99 int ret;
100
101 7 film->sample_table = NULL;
102
103 /* load the main FILM header */
104
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 7 times.
 7 if ((ret = ffio_read_size(pb, scratch, 16)) < 0)
105 ✗ return ret;
106 7 data_offset = AV_RB32(&scratch[4]);
107 7 film->version = AV_RB32(&scratch[8]);
108
109 /* load the FDSC chunk */
110
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
 7 if (film->version == 0) {
111 /* special case for Lemmings .film files; 20-byte header */
112 ✗ if ((ret = ffio_read_size(pb, scratch, 20)) < 0)
113 ✗ return ret;
114 /* make some assumptions about the audio parameters */
115 ✗ film->audio_type = AV_CODEC_ID_PCM_S8;
116 ✗ film->audio_samplerate = 22050;
117 ✗ film->audio_channels = 1;
118 ✗ film->audio_bits = 8;
119 } else {
120 /* normal Saturn .cpk files; 32-byte header */
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 7 times.
 7 if ((ret = ffio_read_size(pb, scratch, 32)) < 0)
122 ✗ return ret;
123 7 film->audio_samplerate = AV_RB16(&scratch[24]);
124 7 film->audio_channels = scratch[21];
125 7 film->audio_bits = scratch[22];
126
3/4
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 5 times.
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
 7 if (scratch[23] == 2 && film->audio_channels > 0)
127 2 film->audio_type = AV_CODEC_ID_ADPCM_ADX;
128
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 1 times.
 5 else if (film->audio_channels > 0) {
129
2/2
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 1 times.
 4 if (film->audio_bits == 8)
130 3 film->audio_type = AV_CODEC_ID_PCM_S8_PLANAR;
131
1/2
✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
 1 else if (film->audio_bits == 16)
132 1 film->audio_type = AV_CODEC_ID_PCM_S16BE_PLANAR;
133 else
134 ✗ film->audio_type = AV_CODEC_ID_NONE;
135 } else
136 1 film->audio_type = AV_CODEC_ID_NONE;
137 }
138
139
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
 7 if (AV_RB32(&scratch[0]) != FDSC_TAG)
140 ✗ return AVERROR_INVALIDDATA;
141
142
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 1 times.
 7 if (AV_RB32(&scratch[8]) == CVID_TAG) {
143 6 film->video_type = AV_CODEC_ID_CINEPAK;
144
1/2
✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
 1 } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
145 1 film->video_type = AV_CODEC_ID_RAWVIDEO;
146 } else {
147 ✗ film->video_type = AV_CODEC_ID_NONE;
148 }
149
150
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 7 if (film->video_type == AV_CODEC_ID_NONE && film->audio_type == AV_CODEC_ID_NONE)
151 ✗ return AVERROR_INVALIDDATA;
152
153 /* initialize the decoder streams */
154
1/2
✓ Branch 0 taken 7 times.
✗ Branch 1 not taken.
 7 if (film->video_type != AV_CODEC_ID_NONE) {
155 7 st = avformat_new_stream(s, NULL);
156
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
 7 if (!st)
157 ✗ return AVERROR(ENOMEM);
158 7 film->video_stream_index = st->index;
159 7 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
160 7 st->codecpar->codec_id = film->video_type;
161 7 st->codecpar->codec_tag = 0; /* no fourcc */
162 7 st->codecpar->width = AV_RB32(&scratch[16]);
163 7 st->codecpar->height = AV_RB32(&scratch[12]);
164
165
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 6 times.
 7 if (film->video_type == AV_CODEC_ID_RAWVIDEO) {
166
2/4
✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 1 times.
✗ Branch 3 not taken.
 1 if (film->version == 0 || scratch[20] == 24) {
167 1 st->codecpar->format = AV_PIX_FMT_RGB24;
168 } else {
169 ✗ av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
170 ✗ return -1;
171 }
172 }
173 }
174
175
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 1 times.
 7 if (film->audio_type != AV_CODEC_ID_NONE) {
176 6 st = avformat_new_stream(s, NULL);
177
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
 6 if (!st)
178 ✗ return AVERROR(ENOMEM);
179 6 film->audio_stream_index = st->index;
180 6 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
181 6 st->codecpar->codec_id = film->audio_type;
182 6 st->codecpar->codec_tag = 1;
183 6 st->codecpar->ch_layout.nb_channels = film->audio_channels;
184 6 st->codecpar->sample_rate = film->audio_samplerate;
185
186
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 4 times.
 6 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX) {
187 2 st->codecpar->bits_per_coded_sample = 18 * 8 / 32;
188 2 st->codecpar->block_align = film->audio_channels * 18;
189 2 ffstream(st)->need_parsing = AVSTREAM_PARSE_FULL;
190 } else {
191 4 st->codecpar->bits_per_coded_sample = film->audio_bits;
192 4 st->codecpar->block_align = film->audio_channels *
193 4 st->codecpar->bits_per_coded_sample / 8;
194 }
195
196 6 st->codecpar->bit_rate = film->audio_channels * st->codecpar->sample_rate *
197 6 st->codecpar->bits_per_coded_sample;
198 }
199
200 /* load the sample table */
201
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 7 times.
 7 if ((ret = ffio_read_size(pb, scratch, 16)) < 0)
202 ✗ return ret;
203
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
 7 if (AV_RB32(&scratch[0]) != STAB_TAG)
204 ✗ return AVERROR_INVALIDDATA;
205 7 film->base_clock = AV_RB32(&scratch[8]);
206 7 film->sample_count = AV_RB32(&scratch[12]);
207 7 film->sample_table = av_malloc_array(film->sample_count, sizeof(film_sample));
208
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
 7 if (!film->sample_table)
209 ✗ return AVERROR(ENOMEM);
210
211
2/2
✓ Branch 0 taken 13 times.
✓ Branch 1 taken 7 times.
 20 for (i = 0; i < s->nb_streams; i++) {
212 13 st = s->streams[i];
213
2/2
✓ Branch 0 taken 7 times.
✓ Branch 1 taken 6 times.
 13 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
214 7 avpriv_set_pts_info(st, 33, 1, film->base_clock);
215 else
216 6 avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
217 }
218
219 7 audio_frame_counter = video_frame_counter = 0;
220
2/2
✓ Branch 0 taken 4048 times.
✓ Branch 1 taken 7 times.
 4055 for (i = 0; i < film->sample_count; i++) {
221 /* load the next sample record and transfer it to an internal struct */
222
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4048 times.
 4048 if ((ret = ffio_read_size(pb, scratch, 16)) < 0)
223 ✗ return ret;
224 4048 film->sample_table[i].sample_offset =
225 4048 data_offset + AV_RB32(&scratch[0]);
226 4048 film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
227
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4048 times.
 4048 if (film->sample_table[i].sample_size > INT_MAX / 4)
228 ✗ return AVERROR_INVALIDDATA;
229
2/2
✓ Branch 0 taken 1463 times.
✓ Branch 1 taken 2585 times.
 4048 if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
230 1463 film->sample_table[i].stream = film->audio_stream_index;
231 1463 film->sample_table[i].pts = audio_frame_counter;
232
233
2/2
✓ Branch 0 taken 1369 times.
✓ Branch 1 taken 94 times.
 1463 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
234 1369 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
235 1369 (18 * film->audio_channels));
236
1/2
✓ Branch 0 taken 94 times.
✗ Branch 1 not taken.
 94 else if (film->audio_type != AV_CODEC_ID_NONE)
237 94 audio_frame_counter += (film->sample_table[i].sample_size /
238 94 (film->audio_channels * film->audio_bits / 8));
239 1463 film->sample_table[i].keyframe = 1;
240 } else {
241 2585 film->sample_table[i].stream = film->video_stream_index;
242 2585 film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
243 2585 film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : AVINDEX_KEYFRAME;
244 2585 video_frame_counter++;
245
1/2
✓ Branch 0 taken 2585 times.
✗ Branch 1 not taken.
 2585 if (film->video_type != AV_CODEC_ID_NONE)
246 2585 av_add_index_entry(s->streams[film->video_stream_index],
247 2585 film->sample_table[i].sample_offset,
248 2585 film->sample_table[i].pts,
249 2585 film->sample_table[i].sample_size, 0,
250 2585 film->sample_table[i].keyframe);
251 }
252 }
253
254
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 1 times.
 7 if (film->audio_type != AV_CODEC_ID_NONE)
255 6 s->streams[film->audio_stream_index]->duration = audio_frame_counter;
256
257
1/2
✓ Branch 0 taken 7 times.
✗ Branch 1 not taken.
 7 if (film->video_type != AV_CODEC_ID_NONE)
258 7 s->streams[film->video_stream_index]->duration = video_frame_counter;
259
260 7 film->current_sample = 0;
261
262 7 return 0;
263 }
264
265 1718 static int film_read_packet(AVFormatContext *s,
266 AVPacket *pkt)
267 {
268 1718 FilmDemuxContext *film = s->priv_data;
269 1718 AVIOContext *pb = s->pb;
270 film_sample *sample;
271 1718 film_sample *next_sample = NULL;
272 int next_sample_id;
273 1718 int ret = 0;
274
275
2/2
✓ Branch 0 taken 7 times.
✓ Branch 1 taken 1711 times.
 1718 if (film->current_sample >= film->sample_count)
276 7 return AVERROR_EOF;
277
278 1711 sample = &film->sample_table[film->current_sample];
279
280 /* Find the next sample from the same stream, assuming there is one;
281 * this is used to calculate the duration below */
282 1711 next_sample_id = film->current_sample + 1;
283
2/2
✓ Branch 0 taken 3270 times.
✓ Branch 1 taken 1700 times.
 6681 while (next_sample == NULL) {
284
2/2
✓ Branch 0 taken 11 times.
✓ Branch 1 taken 3259 times.
 3270 if (next_sample_id >= film->sample_count)
285 11 break;
286
287 3259 next_sample = &film->sample_table[next_sample_id];
288
2/2
✓ Branch 0 taken 1700 times.
✓ Branch 1 taken 1559 times.
 3259 if (next_sample->stream != sample->stream) {
289 1559 next_sample = NULL;
290 1559 next_sample_id++;
291 }
292 }
293
294 /* position the stream (will probably be there anyway) */
295 1711 avio_seek(pb, sample->sample_offset, SEEK_SET);
296
297 1711 ret = av_get_packet(pb, pkt, sample->sample_size);
298
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 1709 times.
 1711 if (ret != sample->sample_size)
299 2 ret = AVERROR_INVALIDDATA;
300
301 1711 pkt->stream_index = sample->stream;
302 1711 pkt->dts = sample->pts;
303 1711 pkt->pts = sample->pts;
304 1711 pkt->flags |= sample->keyframe ? AV_PKT_FLAG_KEY : 0;
305
2/2
✓ Branch 0 taken 1700 times.
✓ Branch 1 taken 11 times.
 1711 if (next_sample != NULL)
306 1700 pkt->duration = next_sample->pts - sample->pts;
307
308 1711 film->current_sample++;
309
310 1711 return ret;
311 }
312
313 ✗ static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
314 {
315 ✗ FilmDemuxContext *film = s->priv_data;
316 ✗ AVStream *st = s->streams[stream_index];
317 int64_t pos;
318 ✗ int ret = av_index_search_timestamp(st, timestamp, flags);
319 ✗ if (ret < 0)
320 ✗ return ret;
321
322 ✗ pos = avio_seek(s->pb, ffstream(st)->index_entries[ret].pos, SEEK_SET);
323 ✗ if (pos < 0)
324 ✗ return pos;
325
326 ✗ film->current_sample = ret;
327
328 ✗ return 0;
329 }
330
331 const FFInputFormat ff_segafilm_demuxer = {
332 .p.name = "film_cpk",
333 .p.long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
334 .priv_data_size = sizeof(FilmDemuxContext),
335 .flags_internal = FF_INFMT_FLAG_INIT_CLEANUP,
336 .read_probe = film_probe,
337 .read_header = film_read_header,
338 .read_packet = film_read_packet,
339 .read_close = film_read_close,
340 .read_seek = film_read_seek,
341 };
342