2 * Sega FILM Format (CPK) Demuxer
3 * Copyright (c) 2003 The ffmpeg Project
5 * This file is part of Libav.
7 * Libav 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.
12 * Libav 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.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
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/
30 #include "libavutil/intreadwrite.h"
34 #define FILM_TAG MKBETAG('F', 'I', 'L', 'M')
35 #define FDSC_TAG MKBETAG('F', 'D', 'S', 'C')
36 #define STAB_TAG MKBETAG('S', 'T', 'A', 'B')
37 #define CVID_TAG MKBETAG('c', 'v', 'i', 'd')
38 #define RAW_TAG MKBETAG('r', 'a', 'w', ' ')
40 typedef struct film_sample {
42 int64_t sample_offset;
43 unsigned int sample_size;
48 typedef struct FilmDemuxContext {
49 int video_stream_index;
50 int audio_stream_index;
52 enum AVCodecID audio_type;
53 unsigned int audio_samplerate;
54 unsigned int audio_bits;
55 unsigned int audio_channels;
57 enum AVCodecID video_type;
58 unsigned int sample_count;
59 film_sample *sample_table;
60 unsigned int current_sample;
62 unsigned int base_clock;
66 static int film_probe(AVProbeData *p)
68 if (AV_RB32(&p->buf[0]) != FILM_TAG)
71 return AVPROBE_SCORE_MAX;
74 static int film_read_close(AVFormatContext *s)
76 FilmDemuxContext *film = s->priv_data;
78 av_freep(&film->sample_table);
83 static int film_read_header(AVFormatContext *s)
85 FilmDemuxContext *film = s->priv_data;
86 AVIOContext *pb = s->pb;
88 unsigned char scratch[256];
90 unsigned int data_offset;
91 unsigned int audio_frame_counter;
92 unsigned int video_frame_counter;
94 film->sample_table = NULL;
96 /* load the main FILM header */
97 if (avio_read(pb, scratch, 16) != 16)
99 data_offset = AV_RB32(&scratch[4]);
100 film->version = AV_RB32(&scratch[8]);
102 /* load the FDSC chunk */
103 if (film->version == 0) {
104 /* special case for Lemmings .film files; 20-byte header */
105 if (avio_read(pb, scratch, 20) != 20)
107 /* make some assumptions about the audio parameters */
108 film->audio_type = AV_CODEC_ID_PCM_S8;
109 film->audio_samplerate = 22050;
110 film->audio_channels = 1;
111 film->audio_bits = 8;
113 /* normal Saturn .cpk files; 32-byte header */
114 if (avio_read(pb, scratch, 32) != 32)
116 film->audio_samplerate = AV_RB16(&scratch[24]);
117 film->audio_channels = scratch[21];
118 if (!film->audio_channels || film->audio_channels > 2) {
119 av_log(s, AV_LOG_ERROR,
120 "Invalid number of channels: %d\n", film->audio_channels);
121 return AVERROR_INVALIDDATA;
123 film->audio_bits = scratch[22];
124 if (scratch[23] == 2)
125 film->audio_type = AV_CODEC_ID_ADPCM_ADX;
126 else if (film->audio_channels > 0) {
127 if (film->audio_bits == 8)
128 film->audio_type = AV_CODEC_ID_PCM_S8_PLANAR;
129 else if (film->audio_bits == 16)
130 film->audio_type = AV_CODEC_ID_PCM_S16BE_PLANAR;
132 film->audio_type = AV_CODEC_ID_NONE;
134 film->audio_type = AV_CODEC_ID_NONE;
137 if (AV_RB32(&scratch[0]) != FDSC_TAG)
138 return AVERROR_INVALIDDATA;
140 if (AV_RB32(&scratch[8]) == CVID_TAG) {
141 film->video_type = AV_CODEC_ID_CINEPAK;
142 } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
143 film->video_type = AV_CODEC_ID_RAWVIDEO;
145 film->video_type = AV_CODEC_ID_NONE;
148 /* initialize the decoder streams */
149 if (film->video_type) {
150 st = avformat_new_stream(s, NULL);
152 return AVERROR(ENOMEM);
153 film->video_stream_index = st->index;
154 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
155 st->codec->codec_id = film->video_type;
156 st->codec->codec_tag = 0; /* no fourcc */
157 st->codec->width = AV_RB32(&scratch[16]);
158 st->codec->height = AV_RB32(&scratch[12]);
160 if (film->video_type == AV_CODEC_ID_RAWVIDEO) {
161 if (scratch[20] == 24) {
162 st->codec->pix_fmt = AV_PIX_FMT_RGB24;
164 av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
170 if (film->audio_type) {
171 st = avformat_new_stream(s, NULL);
173 return AVERROR(ENOMEM);
174 film->audio_stream_index = st->index;
175 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
176 st->codec->codec_id = film->audio_type;
177 st->codec->codec_tag = 1;
178 st->codec->channels = film->audio_channels;
179 st->codec->sample_rate = film->audio_samplerate;
181 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX) {
182 st->codec->bits_per_coded_sample = 18 * 8 / 32;
183 st->codec->block_align = st->codec->channels * 18;
184 st->need_parsing = AVSTREAM_PARSE_FULL;
186 st->codec->bits_per_coded_sample = film->audio_bits;
187 st->codec->block_align = st->codec->channels *
188 st->codec->bits_per_coded_sample / 8;
191 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
192 st->codec->bits_per_coded_sample;
195 /* load the sample table */
196 if (avio_read(pb, scratch, 16) != 16)
198 if (AV_RB32(&scratch[0]) != STAB_TAG)
199 return AVERROR_INVALIDDATA;
200 film->base_clock = AV_RB32(&scratch[8]);
201 film->sample_count = AV_RB32(&scratch[12]);
202 if(film->sample_count >= UINT_MAX / sizeof(film_sample))
204 film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
205 if (!film->sample_table)
206 return AVERROR(ENOMEM);
208 for (i = 0; i < s->nb_streams; i++) {
210 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
211 avpriv_set_pts_info(st, 33, 1, film->base_clock);
213 avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
216 audio_frame_counter = video_frame_counter = 0;
217 for (i = 0; i < film->sample_count; i++) {
218 /* load the next sample record and transfer it to an internal struct */
219 if (avio_read(pb, scratch, 16) != 16) {
223 film->sample_table[i].sample_offset =
224 data_offset + AV_RB32(&scratch[0]);
225 film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
226 if (film->sample_table[i].sample_size > INT_MAX / 4) {
227 ret = AVERROR_INVALIDDATA;
230 if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
231 film->sample_table[i].stream = film->audio_stream_index;
232 film->sample_table[i].pts = audio_frame_counter;
234 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
235 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
236 (18 * film->audio_channels));
237 else if (film->audio_type != AV_CODEC_ID_NONE)
238 audio_frame_counter += (film->sample_table[i].sample_size /
239 (film->audio_channels * film->audio_bits / 8));
241 film->sample_table[i].stream = film->video_stream_index;
242 film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
243 film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
244 video_frame_counter++;
245 av_add_index_entry(s->streams[film->video_stream_index],
246 film->sample_table[i].sample_offset,
247 film->sample_table[i].pts,
248 film->sample_table[i].sample_size, 0,
249 film->sample_table[i].keyframe);
253 if (film->audio_type)
254 s->streams[film->audio_stream_index]->duration = audio_frame_counter;
256 if (film->video_type)
257 s->streams[film->video_stream_index]->duration = video_frame_counter;
259 film->current_sample = 0;
267 static int film_read_packet(AVFormatContext *s,
270 FilmDemuxContext *film = s->priv_data;
271 AVIOContext *pb = s->pb;
275 if (film->current_sample >= film->sample_count)
278 sample = &film->sample_table[film->current_sample];
280 /* position the stream (will probably be there anyway) */
281 avio_seek(pb, sample->sample_offset, SEEK_SET);
283 ret = av_get_packet(pb, pkt, sample->sample_size);
287 pkt->stream_index = sample->stream;
288 pkt->pts = sample->pts;
290 film->current_sample++;
295 static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
297 FilmDemuxContext *film = s->priv_data;
298 AVStream *st = s->streams[stream_index];
300 int ret = av_index_search_timestamp(st, timestamp, flags);
304 pos = avio_seek(s->pb, st->index_entries[ret].pos, SEEK_SET);
308 film->current_sample = ret;
313 AVInputFormat ff_segafilm_demuxer = {
315 .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
316 .priv_data_size = sizeof(FilmDemuxContext),
317 .read_probe = film_probe,
318 .read_header = film_read_header,
319 .read_packet = film_read_packet,
320 .read_close = film_read_close,
321 .read_seek = film_read_seek,