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 CodecID audio_type;
54 unsigned int audio_samplerate;
55 unsigned int audio_bits;
56 unsigned int audio_channels;
58 enum CodecID video_type;
59 unsigned int sample_count;
60 film_sample *sample_table;
61 unsigned int current_sample;
63 unsigned int base_clock;
66 /* buffer used for interleaving stereo PCM data */
67 unsigned char *stereo_buffer;
68 int stereo_buffer_size;
71 static int film_probe(AVProbeData *p)
73 if (AV_RB32(&p->buf[0]) != FILM_TAG)
76 return AVPROBE_SCORE_MAX;
79 static int film_read_header(AVFormatContext *s,
80 AVFormatParameters *ap)
82 FilmDemuxContext *film = s->priv_data;
83 AVIOContext *pb = s->pb;
85 unsigned char scratch[256];
87 unsigned int data_offset;
88 unsigned int audio_frame_counter;
90 film->sample_table = NULL;
91 film->stereo_buffer = NULL;
92 film->stereo_buffer_size = 0;
94 /* load the main FILM header */
95 if (avio_read(pb, scratch, 16) != 16)
97 data_offset = AV_RB32(&scratch[4]);
98 film->version = AV_RB32(&scratch[8]);
100 /* load the FDSC chunk */
101 if (film->version == 0) {
102 /* special case for Lemmings .film files; 20-byte header */
103 if (avio_read(pb, scratch, 20) != 20)
105 /* make some assumptions about the audio parameters */
106 film->audio_type = CODEC_ID_PCM_S8;
107 film->audio_samplerate = 22050;
108 film->audio_channels = 1;
109 film->audio_bits = 8;
111 /* normal Saturn .cpk files; 32-byte header */
112 if (avio_read(pb, scratch, 32) != 32)
114 film->audio_samplerate = AV_RB16(&scratch[24]);
115 film->audio_channels = scratch[21];
116 film->audio_bits = scratch[22];
117 if (scratch[23] == 2)
118 film->audio_type = CODEC_ID_ADPCM_ADX;
119 else if (film->audio_channels > 0) {
120 if (film->audio_bits == 8)
121 film->audio_type = CODEC_ID_PCM_S8;
122 else if (film->audio_bits == 16)
123 film->audio_type = CODEC_ID_PCM_S16BE;
125 film->audio_type = CODEC_ID_NONE;
127 film->audio_type = CODEC_ID_NONE;
130 if (AV_RB32(&scratch[0]) != FDSC_TAG)
131 return AVERROR_INVALIDDATA;
133 if (AV_RB32(&scratch[8]) == CVID_TAG) {
134 film->video_type = CODEC_ID_CINEPAK;
135 } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
136 film->video_type = CODEC_ID_RAWVIDEO;
138 film->video_type = CODEC_ID_NONE;
141 /* initialize the decoder streams */
142 if (film->video_type) {
143 st = avformat_new_stream(s, NULL);
145 return AVERROR(ENOMEM);
146 film->video_stream_index = st->index;
147 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
148 st->codec->codec_id = film->video_type;
149 st->codec->codec_tag = 0; /* no fourcc */
150 st->codec->width = AV_RB32(&scratch[16]);
151 st->codec->height = AV_RB32(&scratch[12]);
153 if (film->video_type == CODEC_ID_RAWVIDEO) {
154 if (scratch[20] == 24) {
155 st->codec->pix_fmt = PIX_FMT_RGB24;
157 av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
163 if (film->audio_type) {
164 st = avformat_new_stream(s, NULL);
166 return AVERROR(ENOMEM);
167 film->audio_stream_index = st->index;
168 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
169 st->codec->codec_id = film->audio_type;
170 st->codec->codec_tag = 1;
171 st->codec->channels = film->audio_channels;
172 st->codec->sample_rate = film->audio_samplerate;
174 if (film->audio_type == CODEC_ID_ADPCM_ADX) {
175 st->codec->bits_per_coded_sample = 18 * 8 / 32;
176 st->codec->block_align = st->codec->channels * 18;
177 st->need_parsing = AVSTREAM_PARSE_FULL;
179 st->codec->bits_per_coded_sample = film->audio_bits;
180 st->codec->block_align = st->codec->channels *
181 st->codec->bits_per_coded_sample / 8;
184 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
185 st->codec->bits_per_coded_sample;
188 /* load the sample table */
189 if (avio_read(pb, scratch, 16) != 16)
191 if (AV_RB32(&scratch[0]) != STAB_TAG)
192 return AVERROR_INVALIDDATA;
193 film->base_clock = AV_RB32(&scratch[8]);
194 film->sample_count = AV_RB32(&scratch[12]);
195 if(film->sample_count >= UINT_MAX / sizeof(film_sample))
197 film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
198 if (!film->sample_table)
199 return AVERROR(ENOMEM);
201 for(i=0; i<s->nb_streams; i++)
202 avpriv_set_pts_info(s->streams[i], 33, 1, film->base_clock);
204 audio_frame_counter = 0;
205 for (i = 0; i < film->sample_count; i++) {
206 /* load the next sample record and transfer it to an internal struct */
207 if (avio_read(pb, scratch, 16) != 16) {
208 av_free(film->sample_table);
211 film->sample_table[i].sample_offset =
212 data_offset + AV_RB32(&scratch[0]);
213 film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
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;
217 film->sample_table[i].pts *= film->base_clock;
218 film->sample_table[i].pts /= film->audio_samplerate;
220 if (film->audio_type == CODEC_ID_ADPCM_ADX)
221 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
222 (18 * film->audio_channels));
223 else if (film->audio_type != CODEC_ID_NONE)
224 audio_frame_counter += (film->sample_table[i].sample_size /
225 (film->audio_channels * film->audio_bits / 8));
227 film->sample_table[i].stream = film->video_stream_index;
228 film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
229 film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
233 film->current_sample = 0;
238 static int film_read_packet(AVFormatContext *s,
241 FilmDemuxContext *film = s->priv_data;
242 AVIOContext *pb = s->pb;
248 if (film->current_sample >= film->sample_count)
251 sample = &film->sample_table[film->current_sample];
253 /* position the stream (will probably be there anyway) */
254 avio_seek(pb, sample->sample_offset, SEEK_SET);
256 /* do a special song and dance when loading FILM Cinepak chunks */
257 if ((sample->stream == film->video_stream_index) &&
258 (film->video_type == CODEC_ID_CINEPAK)) {
259 pkt->pos= avio_tell(pb);
260 if (av_new_packet(pkt, sample->sample_size))
261 return AVERROR(ENOMEM);
262 avio_read(pb, pkt->data, sample->sample_size);
263 } else if ((sample->stream == film->audio_stream_index) &&
264 (film->audio_channels == 2) &&
265 (film->audio_type != CODEC_ID_ADPCM_ADX)) {
266 /* stereo PCM needs to be interleaved */
268 if (ffio_limit(pb, sample->sample_size) != sample->sample_size)
270 if (av_new_packet(pkt, sample->sample_size))
271 return AVERROR(ENOMEM);
273 /* make sure the interleave buffer is large enough */
274 if (sample->sample_size > film->stereo_buffer_size) {
275 av_free(film->stereo_buffer);
276 film->stereo_buffer_size = sample->sample_size;
277 film->stereo_buffer = av_malloc(film->stereo_buffer_size);
278 if (!film->stereo_buffer) {
279 film->stereo_buffer_size = 0;
280 return AVERROR(ENOMEM);
284 pkt->pos= avio_tell(pb);
285 ret = avio_read(pb, film->stereo_buffer, sample->sample_size);
286 if (ret != sample->sample_size)
290 right = sample->sample_size / 2;
291 for (i = 0; i < sample->sample_size; ) {
292 if (film->audio_bits == 8) {
293 pkt->data[i++] = film->stereo_buffer[left++];
294 pkt->data[i++] = film->stereo_buffer[right++];
296 pkt->data[i++] = film->stereo_buffer[left++];
297 pkt->data[i++] = film->stereo_buffer[left++];
298 pkt->data[i++] = film->stereo_buffer[right++];
299 pkt->data[i++] = film->stereo_buffer[right++];
303 ret= av_get_packet(pb, pkt, sample->sample_size);
304 if (ret != sample->sample_size)
308 pkt->stream_index = sample->stream;
309 pkt->pts = sample->pts;
311 film->current_sample++;
316 static int film_read_close(AVFormatContext *s)
318 FilmDemuxContext *film = s->priv_data;
320 av_free(film->sample_table);
321 av_free(film->stereo_buffer);
326 AVInputFormat ff_segafilm_demuxer = {
328 .long_name = NULL_IF_CONFIG_SMALL("Sega FILM/CPK format"),
329 .priv_data_size = sizeof(FilmDemuxContext),
330 .read_probe = film_probe,
331 .read_header = film_read_header,
332 .read_packet = film_read_packet,
333 .read_close = film_read_close,