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 #include "avio_internal.h"
35 #define FILM_TAG MKBETAG('F', 'I', 'L', 'M')
36 #define FDSC_TAG MKBETAG('F', 'D', 'S', 'C')
37 #define STAB_TAG MKBETAG('S', 'T', 'A', 'B')
38 #define CVID_TAG MKBETAG('c', 'v', 'i', 'd')
39 #define RAW_TAG MKBETAG('r', 'a', 'w', ' ')
43 int64_t sample_offset;
44 unsigned int sample_size;
49 typedef struct FilmDemuxContext {
50 int video_stream_index;
51 int audio_stream_index;
53 enum AVCodecID audio_type;
54 unsigned int audio_samplerate;
55 unsigned int audio_bits;
56 unsigned int audio_channels;
58 enum AVCodecID video_type;
59 unsigned int sample_count;
60 film_sample *sample_table;
61 unsigned int current_sample;
63 unsigned int base_clock;
67 static int film_probe(AVProbeData *p)
69 if (AV_RB32(&p->buf[0]) != FILM_TAG)
72 if (AV_RB32(&p->buf[16]) != FDSC_TAG)
75 return AVPROBE_SCORE_MAX;
78 static int film_read_header(AVFormatContext *s)
80 FilmDemuxContext *film = s->priv_data;
81 AVIOContext *pb = s->pb;
83 unsigned char scratch[256];
85 unsigned int data_offset;
86 unsigned int audio_frame_counter;
88 film->sample_table = NULL;
90 /* load the main FILM header */
91 if (avio_read(pb, scratch, 16) != 16)
93 data_offset = AV_RB32(&scratch[4]);
94 film->version = AV_RB32(&scratch[8]);
96 /* load the FDSC chunk */
97 if (film->version == 0) {
98 /* special case for Lemmings .film files; 20-byte header */
99 if (avio_read(pb, scratch, 20) != 20)
101 /* make some assumptions about the audio parameters */
102 film->audio_type = AV_CODEC_ID_PCM_S8;
103 film->audio_samplerate = 22050;
104 film->audio_channels = 1;
105 film->audio_bits = 8;
107 /* normal Saturn .cpk files; 32-byte header */
108 if (avio_read(pb, scratch, 32) != 32)
110 film->audio_samplerate = AV_RB16(&scratch[24]);
111 film->audio_channels = scratch[21];
112 film->audio_bits = scratch[22];
113 if (scratch[23] == 2 && film->audio_channels > 0)
114 film->audio_type = AV_CODEC_ID_ADPCM_ADX;
115 else if (film->audio_channels > 0) {
116 if (film->audio_bits == 8)
117 film->audio_type = AV_CODEC_ID_PCM_S8_PLANAR;
118 else if (film->audio_bits == 16)
119 film->audio_type = AV_CODEC_ID_PCM_S16BE_PLANAR;
121 film->audio_type = AV_CODEC_ID_NONE;
123 film->audio_type = AV_CODEC_ID_NONE;
126 if (AV_RB32(&scratch[0]) != FDSC_TAG)
127 return AVERROR_INVALIDDATA;
129 if (AV_RB32(&scratch[8]) == CVID_TAG) {
130 film->video_type = AV_CODEC_ID_CINEPAK;
131 } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
132 film->video_type = AV_CODEC_ID_RAWVIDEO;
134 film->video_type = AV_CODEC_ID_NONE;
137 /* initialize the decoder streams */
138 if (film->video_type) {
139 st = avformat_new_stream(s, NULL);
141 return AVERROR(ENOMEM);
142 film->video_stream_index = st->index;
143 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
144 st->codec->codec_id = film->video_type;
145 st->codec->codec_tag = 0; /* no fourcc */
146 st->codec->width = AV_RB32(&scratch[16]);
147 st->codec->height = AV_RB32(&scratch[12]);
149 if (film->video_type == AV_CODEC_ID_RAWVIDEO) {
150 if (scratch[20] == 24) {
151 st->codec->pix_fmt = AV_PIX_FMT_RGB24;
153 av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
159 if (film->audio_type) {
160 st = avformat_new_stream(s, NULL);
162 return AVERROR(ENOMEM);
163 film->audio_stream_index = st->index;
164 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
165 st->codec->codec_id = film->audio_type;
166 st->codec->codec_tag = 1;
167 st->codec->channels = film->audio_channels;
168 st->codec->sample_rate = film->audio_samplerate;
170 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX) {
171 st->codec->bits_per_coded_sample = 18 * 8 / 32;
172 st->codec->block_align = st->codec->channels * 18;
173 st->need_parsing = AVSTREAM_PARSE_FULL;
175 st->codec->bits_per_coded_sample = film->audio_bits;
176 st->codec->block_align = st->codec->channels *
177 st->codec->bits_per_coded_sample / 8;
180 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
181 st->codec->bits_per_coded_sample;
184 /* load the sample table */
185 if (avio_read(pb, scratch, 16) != 16)
187 if (AV_RB32(&scratch[0]) != STAB_TAG)
188 return AVERROR_INVALIDDATA;
189 film->base_clock = AV_RB32(&scratch[8]);
190 film->sample_count = AV_RB32(&scratch[12]);
191 if(film->sample_count >= UINT_MAX / sizeof(film_sample))
193 film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
194 if (!film->sample_table)
195 return AVERROR(ENOMEM);
197 for (i = 0; i < s->nb_streams; i++) {
199 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
200 avpriv_set_pts_info(st, 33, 1, film->base_clock);
202 avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
205 audio_frame_counter = 0;
206 for (i = 0; i < film->sample_count; i++) {
207 /* load the next sample record and transfer it to an internal struct */
208 if (avio_read(pb, scratch, 16) != 16) {
209 av_freep(&film->sample_table);
212 film->sample_table[i].sample_offset =
213 data_offset + AV_RB32(&scratch[0]);
214 film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
215 if (film->sample_table[i].sample_size > INT_MAX / 4)
216 return AVERROR_INVALIDDATA;
217 if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
218 film->sample_table[i].stream = film->audio_stream_index;
219 film->sample_table[i].pts = audio_frame_counter;
221 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
222 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
223 (18 * film->audio_channels));
224 else if (film->audio_type != AV_CODEC_ID_NONE)
225 audio_frame_counter += (film->sample_table[i].sample_size /
226 (film->audio_channels * film->audio_bits / 8));
228 film->sample_table[i].stream = film->video_stream_index;
229 film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
230 film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
234 film->current_sample = 0;
239 static int film_read_packet(AVFormatContext *s,
242 FilmDemuxContext *film = s->priv_data;
243 AVIOContext *pb = s->pb;
247 if (film->current_sample >= film->sample_count)
250 sample = &film->sample_table[film->current_sample];
252 /* position the stream (will probably be there anyway) */
253 avio_seek(pb, sample->sample_offset, SEEK_SET);
255 /* do a special song and dance when loading FILM Cinepak chunks */
256 if ((sample->stream == film->video_stream_index) &&
257 (film->video_type == AV_CODEC_ID_CINEPAK)) {
258 pkt->pos= avio_tell(pb);
259 if (av_new_packet(pkt, sample->sample_size))
260 return AVERROR(ENOMEM);
261 avio_read(pb, pkt->data, sample->sample_size);
263 ret= av_get_packet(pb, pkt, sample->sample_size);
264 if (ret != sample->sample_size)
268 pkt->stream_index = sample->stream;
269 pkt->pts = sample->pts;
271 film->current_sample++;
276 static int film_read_close(AVFormatContext *s)
278 FilmDemuxContext *film = s->priv_data;
280 av_freep(&film->sample_table);
285 AVInputFormat ff_segafilm_demuxer = {
287 .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
288 .priv_data_size = sizeof(FilmDemuxContext),
289 .read_probe = film_probe,
290 .read_header = film_read_header,
291 .read_packet = film_read_packet,
292 .read_close = film_read_close,