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;
93 film->sample_table = NULL;
95 /* load the main FILM header */
96 if (avio_read(pb, scratch, 16) != 16)
98 data_offset = AV_RB32(&scratch[4]);
99 film->version = AV_RB32(&scratch[8]);
101 /* load the FDSC chunk */
102 if (film->version == 0) {
103 /* special case for Lemmings .film files; 20-byte header */
104 if (avio_read(pb, scratch, 20) != 20)
106 /* make some assumptions about the audio parameters */
107 film->audio_type = AV_CODEC_ID_PCM_S8;
108 film->audio_samplerate = 22050;
109 film->audio_channels = 1;
110 film->audio_bits = 8;
112 /* normal Saturn .cpk files; 32-byte header */
113 if (avio_read(pb, scratch, 32) != 32)
115 film->audio_samplerate = AV_RB16(&scratch[24]);
116 film->audio_channels = scratch[21];
117 if (!film->audio_channels || film->audio_channels > 2) {
118 av_log(s, AV_LOG_ERROR,
119 "Invalid number of channels: %d\n", film->audio_channels);
120 return AVERROR_INVALIDDATA;
122 film->audio_bits = scratch[22];
123 if (scratch[23] == 2)
124 film->audio_type = AV_CODEC_ID_ADPCM_ADX;
125 else if (film->audio_channels > 0) {
126 if (film->audio_bits == 8)
127 film->audio_type = AV_CODEC_ID_PCM_S8_PLANAR;
128 else if (film->audio_bits == 16)
129 film->audio_type = AV_CODEC_ID_PCM_S16BE_PLANAR;
131 film->audio_type = AV_CODEC_ID_NONE;
133 film->audio_type = AV_CODEC_ID_NONE;
136 if (AV_RB32(&scratch[0]) != FDSC_TAG)
137 return AVERROR_INVALIDDATA;
139 if (AV_RB32(&scratch[8]) == CVID_TAG) {
140 film->video_type = AV_CODEC_ID_CINEPAK;
141 } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
142 film->video_type = AV_CODEC_ID_RAWVIDEO;
144 film->video_type = AV_CODEC_ID_NONE;
147 /* initialize the decoder streams */
148 if (film->video_type) {
149 st = avformat_new_stream(s, NULL);
151 return AVERROR(ENOMEM);
152 film->video_stream_index = st->index;
153 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
154 st->codec->codec_id = film->video_type;
155 st->codec->codec_tag = 0; /* no fourcc */
156 st->codec->width = AV_RB32(&scratch[16]);
157 st->codec->height = AV_RB32(&scratch[12]);
159 if (film->video_type == AV_CODEC_ID_RAWVIDEO) {
160 if (scratch[20] == 24) {
161 st->codec->pix_fmt = AV_PIX_FMT_RGB24;
163 av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
169 if (film->audio_type) {
170 st = avformat_new_stream(s, NULL);
172 return AVERROR(ENOMEM);
173 film->audio_stream_index = st->index;
174 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
175 st->codec->codec_id = film->audio_type;
176 st->codec->codec_tag = 1;
177 st->codec->channels = film->audio_channels;
178 st->codec->sample_rate = film->audio_samplerate;
180 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX) {
181 st->codec->bits_per_coded_sample = 18 * 8 / 32;
182 st->codec->block_align = st->codec->channels * 18;
183 st->need_parsing = AVSTREAM_PARSE_FULL;
185 st->codec->bits_per_coded_sample = film->audio_bits;
186 st->codec->block_align = st->codec->channels *
187 st->codec->bits_per_coded_sample / 8;
190 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
191 st->codec->bits_per_coded_sample;
194 /* load the sample table */
195 if (avio_read(pb, scratch, 16) != 16)
197 if (AV_RB32(&scratch[0]) != STAB_TAG)
198 return AVERROR_INVALIDDATA;
199 film->base_clock = AV_RB32(&scratch[8]);
200 film->sample_count = AV_RB32(&scratch[12]);
201 if(film->sample_count >= UINT_MAX / sizeof(film_sample))
203 film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
204 if (!film->sample_table)
205 return AVERROR(ENOMEM);
207 for (i = 0; i < s->nb_streams; i++) {
209 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
210 avpriv_set_pts_info(st, 33, 1, film->base_clock);
212 avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
215 audio_frame_counter = 0;
216 for (i = 0; i < film->sample_count; i++) {
217 /* load the next sample record and transfer it to an internal struct */
218 if (avio_read(pb, scratch, 16) != 16) {
222 film->sample_table[i].sample_offset =
223 data_offset + AV_RB32(&scratch[0]);
224 film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
225 if (film->sample_table[i].sample_size > INT_MAX / 4) {
226 ret = AVERROR_INVALIDDATA;
229 if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
230 film->sample_table[i].stream = film->audio_stream_index;
231 film->sample_table[i].pts = audio_frame_counter;
233 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
234 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
235 (18 * film->audio_channels));
236 else if (film->audio_type != AV_CODEC_ID_NONE)
237 audio_frame_counter += (film->sample_table[i].sample_size /
238 (film->audio_channels * film->audio_bits / 8));
240 film->sample_table[i].stream = film->video_stream_index;
241 film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
242 film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
246 film->current_sample = 0;
254 static int film_read_packet(AVFormatContext *s,
257 FilmDemuxContext *film = s->priv_data;
258 AVIOContext *pb = s->pb;
262 if (film->current_sample >= film->sample_count)
265 sample = &film->sample_table[film->current_sample];
267 /* position the stream (will probably be there anyway) */
268 avio_seek(pb, sample->sample_offset, SEEK_SET);
270 /* do a special song and dance when loading FILM Cinepak chunks */
271 if ((sample->stream == film->video_stream_index) &&
272 (film->video_type == AV_CODEC_ID_CINEPAK)) {
273 pkt->pos= avio_tell(pb);
274 if (av_new_packet(pkt, sample->sample_size))
275 return AVERROR(ENOMEM);
276 avio_read(pb, pkt->data, sample->sample_size);
278 ret= av_get_packet(pb, pkt, sample->sample_size);
279 if (ret != sample->sample_size)
283 pkt->stream_index = sample->stream;
284 pkt->pts = sample->pts;
286 film->current_sample++;
291 AVInputFormat ff_segafilm_demuxer = {
293 .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
294 .priv_data_size = sizeof(FilmDemuxContext),
295 .read_probe = film_probe,
296 .read_header = film_read_header,
297 .read_packet = film_read_packet,
298 .read_close = film_read_close,