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 return AVPROBE_SCORE_MAX;
75 static int film_read_header(AVFormatContext *s)
77 FilmDemuxContext *film = s->priv_data;
78 AVIOContext *pb = s->pb;
80 unsigned char scratch[256];
82 unsigned int data_offset;
83 unsigned int audio_frame_counter;
85 film->sample_table = NULL;
87 /* load the main FILM header */
88 if (avio_read(pb, scratch, 16) != 16)
90 data_offset = AV_RB32(&scratch[4]);
91 film->version = AV_RB32(&scratch[8]);
93 /* load the FDSC chunk */
94 if (film->version == 0) {
95 /* special case for Lemmings .film files; 20-byte header */
96 if (avio_read(pb, scratch, 20) != 20)
98 /* make some assumptions about the audio parameters */
99 film->audio_type = AV_CODEC_ID_PCM_S8;
100 film->audio_samplerate = 22050;
101 film->audio_channels = 1;
102 film->audio_bits = 8;
104 /* normal Saturn .cpk files; 32-byte header */
105 if (avio_read(pb, scratch, 32) != 32)
107 film->audio_samplerate = AV_RB16(&scratch[24]);
108 film->audio_channels = scratch[21];
109 film->audio_bits = scratch[22];
110 if (scratch[23] == 2 && film->audio_channels > 0)
111 film->audio_type = AV_CODEC_ID_ADPCM_ADX;
112 else if (film->audio_channels > 0) {
113 if (film->audio_bits == 8)
114 film->audio_type = AV_CODEC_ID_PCM_S8_PLANAR;
115 else if (film->audio_bits == 16)
116 film->audio_type = AV_CODEC_ID_PCM_S16BE_PLANAR;
118 film->audio_type = AV_CODEC_ID_NONE;
120 film->audio_type = AV_CODEC_ID_NONE;
123 if (AV_RB32(&scratch[0]) != FDSC_TAG)
124 return AVERROR_INVALIDDATA;
126 if (AV_RB32(&scratch[8]) == CVID_TAG) {
127 film->video_type = AV_CODEC_ID_CINEPAK;
128 } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
129 film->video_type = AV_CODEC_ID_RAWVIDEO;
131 film->video_type = AV_CODEC_ID_NONE;
134 /* initialize the decoder streams */
135 if (film->video_type) {
136 st = avformat_new_stream(s, NULL);
138 return AVERROR(ENOMEM);
139 film->video_stream_index = st->index;
140 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
141 st->codec->codec_id = film->video_type;
142 st->codec->codec_tag = 0; /* no fourcc */
143 st->codec->width = AV_RB32(&scratch[16]);
144 st->codec->height = AV_RB32(&scratch[12]);
146 if (film->video_type == AV_CODEC_ID_RAWVIDEO) {
147 if (scratch[20] == 24) {
148 st->codec->pix_fmt = AV_PIX_FMT_RGB24;
150 av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
156 if (film->audio_type) {
157 st = avformat_new_stream(s, NULL);
159 return AVERROR(ENOMEM);
160 film->audio_stream_index = st->index;
161 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
162 st->codec->codec_id = film->audio_type;
163 st->codec->codec_tag = 1;
164 st->codec->channels = film->audio_channels;
165 st->codec->sample_rate = film->audio_samplerate;
167 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX) {
168 st->codec->bits_per_coded_sample = 18 * 8 / 32;
169 st->codec->block_align = st->codec->channels * 18;
170 st->need_parsing = AVSTREAM_PARSE_FULL;
172 st->codec->bits_per_coded_sample = film->audio_bits;
173 st->codec->block_align = st->codec->channels *
174 st->codec->bits_per_coded_sample / 8;
177 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
178 st->codec->bits_per_coded_sample;
181 /* load the sample table */
182 if (avio_read(pb, scratch, 16) != 16)
184 if (AV_RB32(&scratch[0]) != STAB_TAG)
185 return AVERROR_INVALIDDATA;
186 film->base_clock = AV_RB32(&scratch[8]);
187 film->sample_count = AV_RB32(&scratch[12]);
188 if(film->sample_count >= UINT_MAX / sizeof(film_sample))
190 film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
191 if (!film->sample_table)
192 return AVERROR(ENOMEM);
194 for (i = 0; i < s->nb_streams; i++) {
196 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
197 avpriv_set_pts_info(st, 33, 1, film->base_clock);
199 avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
202 audio_frame_counter = 0;
203 for (i = 0; i < film->sample_count; i++) {
204 /* load the next sample record and transfer it to an internal struct */
205 if (avio_read(pb, scratch, 16) != 16) {
206 av_freep(&film->sample_table);
209 film->sample_table[i].sample_offset =
210 data_offset + AV_RB32(&scratch[0]);
211 film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
212 if (film->sample_table[i].sample_size > INT_MAX / 4)
213 return AVERROR_INVALIDDATA;
214 if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
215 film->sample_table[i].stream = film->audio_stream_index;
216 film->sample_table[i].pts = audio_frame_counter;
218 if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
219 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
220 (18 * film->audio_channels));
221 else if (film->audio_type != AV_CODEC_ID_NONE)
222 audio_frame_counter += (film->sample_table[i].sample_size /
223 (film->audio_channels * film->audio_bits / 8));
225 film->sample_table[i].stream = film->video_stream_index;
226 film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
227 film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
231 film->current_sample = 0;
236 static int film_read_packet(AVFormatContext *s,
239 FilmDemuxContext *film = s->priv_data;
240 AVIOContext *pb = s->pb;
244 if (film->current_sample >= film->sample_count)
247 sample = &film->sample_table[film->current_sample];
249 /* position the stream (will probably be there anyway) */
250 avio_seek(pb, sample->sample_offset, SEEK_SET);
252 /* do a special song and dance when loading FILM Cinepak chunks */
253 if ((sample->stream == film->video_stream_index) &&
254 (film->video_type == AV_CODEC_ID_CINEPAK)) {
255 pkt->pos= avio_tell(pb);
256 if (av_new_packet(pkt, sample->sample_size))
257 return AVERROR(ENOMEM);
258 avio_read(pb, pkt->data, sample->sample_size);
260 ret= av_get_packet(pb, pkt, sample->sample_size);
261 if (ret != sample->sample_size)
265 pkt->stream_index = sample->stream;
266 pkt->pts = sample->pts;
268 film->current_sample++;
273 static int film_read_close(AVFormatContext *s)
275 FilmDemuxContext *film = s->priv_data;
277 av_freep(&film->sample_table);
282 AVInputFormat ff_segafilm_demuxer = {
284 .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
285 .priv_data_size = sizeof(FilmDemuxContext),
286 .read_probe = film_probe,
287 .read_header = film_read_header,
288 .read_packet = film_read_packet,
289 .read_close = film_read_close,