2 * Sega FILM Format (CPK) Demuxer
3 * Copyright (c) 2003 The ffmpeg Project
5 * This file is part of FFmpeg.
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.
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.
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
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"
33 #define FILM_TAG MKBETAG('F', 'I', 'L', 'M')
34 #define FDSC_TAG MKBETAG('F', 'D', 'S', 'C')
35 #define STAB_TAG MKBETAG('S', 'T', 'A', 'B')
36 #define CVID_TAG MKBETAG('c', 'v', 'i', 'd')
40 int64_t sample_offset;
41 unsigned int sample_size;
46 typedef struct FilmDemuxContext {
47 int video_stream_index;
48 int audio_stream_index;
50 enum CodecID audio_type;
51 unsigned int audio_samplerate;
52 unsigned int audio_bits;
53 unsigned int audio_channels;
55 enum CodecID video_type;
56 unsigned int sample_count;
57 film_sample *sample_table;
58 unsigned int current_sample;
60 unsigned int base_clock;
63 /* buffer used for interleaving stereo PCM data */
64 unsigned char *stereo_buffer;
65 int stereo_buffer_size;
68 static int film_probe(AVProbeData *p)
70 if (AV_RB32(&p->buf[0]) != FILM_TAG)
73 return AVPROBE_SCORE_MAX;
76 static int film_read_header(AVFormatContext *s,
77 AVFormatParameters *ap)
79 FilmDemuxContext *film = s->priv_data;
80 AVIOContext *pb = s->pb;
82 unsigned char scratch[256];
84 unsigned int data_offset;
85 unsigned int audio_frame_counter;
87 film->sample_table = NULL;
88 film->stereo_buffer = NULL;
89 film->stereo_buffer_size = 0;
91 /* load the main FILM header */
92 if (avio_read(pb, scratch, 16) != 16)
94 data_offset = AV_RB32(&scratch[4]);
95 film->version = AV_RB32(&scratch[8]);
97 /* load the FDSC chunk */
98 if (film->version == 0) {
99 /* special case for Lemmings .film files; 20-byte header */
100 if (avio_read(pb, scratch, 20) != 20)
102 /* make some assumptions about the audio parameters */
103 film->audio_type = CODEC_ID_PCM_S8;
104 film->audio_samplerate = 22050;
105 film->audio_channels = 1;
106 film->audio_bits = 8;
108 /* normal Saturn .cpk files; 32-byte header */
109 if (avio_read(pb, scratch, 32) != 32)
111 film->audio_samplerate = AV_RB16(&scratch[24]);
112 film->audio_channels = scratch[21];
113 film->audio_bits = scratch[22];
114 if (scratch[23] == 2)
115 film->audio_type = CODEC_ID_ADPCM_ADX;
116 else if (film->audio_channels > 0) {
117 if (film->audio_bits == 8)
118 film->audio_type = CODEC_ID_PCM_S8;
119 else if (film->audio_bits == 16)
120 film->audio_type = CODEC_ID_PCM_S16BE;
122 film->audio_type = CODEC_ID_NONE;
124 film->audio_type = CODEC_ID_NONE;
127 if (AV_RB32(&scratch[0]) != FDSC_TAG)
128 return AVERROR_INVALIDDATA;
130 if (AV_RB32(&scratch[8]) == CVID_TAG) {
131 film->video_type = CODEC_ID_CINEPAK;
133 film->video_type = CODEC_ID_NONE;
135 /* initialize the decoder streams */
136 if (film->video_type) {
137 st = av_new_stream(s, 0);
139 return AVERROR(ENOMEM);
140 film->video_stream_index = st->index;
141 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
142 st->codec->codec_id = film->video_type;
143 st->codec->codec_tag = 0; /* no fourcc */
144 st->codec->width = AV_RB32(&scratch[16]);
145 st->codec->height = AV_RB32(&scratch[12]);
148 if (film->audio_type) {
149 st = av_new_stream(s, 0);
151 return AVERROR(ENOMEM);
152 film->audio_stream_index = st->index;
153 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
154 st->codec->codec_id = film->audio_type;
155 st->codec->codec_tag = 1;
156 st->codec->channels = film->audio_channels;
157 st->codec->sample_rate = film->audio_samplerate;
159 if (film->audio_type == CODEC_ID_ADPCM_ADX) {
160 st->codec->bits_per_coded_sample = 18 * 8 / 32;
161 st->codec->block_align = st->codec->channels * 18;
163 st->codec->bits_per_coded_sample = film->audio_bits;
164 st->codec->block_align = st->codec->channels *
165 st->codec->bits_per_coded_sample / 8;
168 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
169 st->codec->bits_per_coded_sample;
172 /* load the sample table */
173 if (avio_read(pb, scratch, 16) != 16)
175 if (AV_RB32(&scratch[0]) != STAB_TAG)
176 return AVERROR_INVALIDDATA;
177 film->base_clock = AV_RB32(&scratch[8]);
178 film->sample_count = AV_RB32(&scratch[12]);
179 if(film->sample_count >= UINT_MAX / sizeof(film_sample))
181 film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
182 if (!film->sample_table)
183 return AVERROR(ENOMEM);
185 for(i=0; i<s->nb_streams; i++)
186 av_set_pts_info(s->streams[i], 33, 1, film->base_clock);
188 audio_frame_counter = 0;
189 for (i = 0; i < film->sample_count; i++) {
190 /* load the next sample record and transfer it to an internal struct */
191 if (avio_read(pb, scratch, 16) != 16) {
192 av_free(film->sample_table);
195 film->sample_table[i].sample_offset =
196 data_offset + AV_RB32(&scratch[0]);
197 film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
198 if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
199 film->sample_table[i].stream = film->audio_stream_index;
200 film->sample_table[i].pts = audio_frame_counter;
201 film->sample_table[i].pts *= film->base_clock;
202 film->sample_table[i].pts /= film->audio_samplerate;
204 if (film->audio_type == CODEC_ID_ADPCM_ADX)
205 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
206 (18 * film->audio_channels));
207 else if (film->audio_type != CODEC_ID_NONE)
208 audio_frame_counter += (film->sample_table[i].sample_size /
209 (film->audio_channels * film->audio_bits / 8));
211 film->sample_table[i].stream = film->video_stream_index;
212 film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
213 film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
217 film->current_sample = 0;
222 static int film_read_packet(AVFormatContext *s,
225 FilmDemuxContext *film = s->priv_data;
226 AVIOContext *pb = s->pb;
232 if (film->current_sample >= film->sample_count)
235 sample = &film->sample_table[film->current_sample];
237 /* position the stream (will probably be there anyway) */
238 avio_seek(pb, sample->sample_offset, SEEK_SET);
240 /* do a special song and dance when loading FILM Cinepak chunks */
241 if ((sample->stream == film->video_stream_index) &&
242 (film->video_type == CODEC_ID_CINEPAK)) {
243 pkt->pos= avio_tell(pb);
244 if (av_new_packet(pkt, sample->sample_size))
245 return AVERROR(ENOMEM);
246 avio_read(pb, pkt->data, sample->sample_size);
247 } else if ((sample->stream == film->audio_stream_index) &&
248 (film->audio_channels == 2) &&
249 (film->audio_type != CODEC_ID_ADPCM_ADX)) {
250 /* stereo PCM needs to be interleaved */
252 if (av_new_packet(pkt, sample->sample_size))
253 return AVERROR(ENOMEM);
255 /* make sure the interleave buffer is large enough */
256 if (sample->sample_size > film->stereo_buffer_size) {
257 av_free(film->stereo_buffer);
258 film->stereo_buffer_size = sample->sample_size;
259 film->stereo_buffer = av_malloc(film->stereo_buffer_size);
260 if (!film->stereo_buffer) {
261 film->stereo_buffer_size = 0;
262 return AVERROR(ENOMEM);
266 pkt->pos= avio_tell(pb);
267 ret = avio_read(pb, film->stereo_buffer, sample->sample_size);
268 if (ret != sample->sample_size)
272 right = sample->sample_size / 2;
273 for (i = 0; i < sample->sample_size; ) {
274 if (film->audio_bits == 8) {
275 pkt->data[i++] = film->stereo_buffer[left++];
276 pkt->data[i++] = film->stereo_buffer[right++];
278 pkt->data[i++] = film->stereo_buffer[left++];
279 pkt->data[i++] = film->stereo_buffer[left++];
280 pkt->data[i++] = film->stereo_buffer[right++];
281 pkt->data[i++] = film->stereo_buffer[right++];
285 ret= av_get_packet(pb, pkt, sample->sample_size);
286 if (ret != sample->sample_size)
290 pkt->stream_index = sample->stream;
291 pkt->pts = sample->pts;
293 film->current_sample++;
298 static int film_read_close(AVFormatContext *s)
300 FilmDemuxContext *film = s->priv_data;
302 av_free(film->sample_table);
303 av_free(film->stereo_buffer);
308 AVInputFormat ff_segafilm_demuxer = {
310 .long_name = NULL_IF_CONFIG_SMALL("Sega FILM/CPK format"),
311 .priv_data_size = sizeof(FilmDemuxContext),
312 .read_probe = film_probe,
313 .read_header = film_read_header,
314 .read_packet = film_read_packet,
315 .read_close = film_read_close,