7a84daf2effbd068153c16ab806ba2980aec4391
[ffmpeg.git] / libavformat / segafilm.c
1 /*
2  * Sega FILM Format (CPK) Demuxer
3  * Copyright (c) 2003 The ffmpeg Project
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
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/
28  */
29
30 #include "libavutil/intreadwrite.h"
31 #include "avformat.h"
32
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')
37
38 typedef struct {
39   int stream;
40   int64_t sample_offset;
41   unsigned int sample_size;
42   int64_t pts;
43   int keyframe;
44 } film_sample;
45
46 typedef struct FilmDemuxContext {
47     int video_stream_index;
48     int audio_stream_index;
49
50     enum CodecID audio_type;
51     unsigned int audio_samplerate;
52     unsigned int audio_bits;
53     unsigned int audio_channels;
54
55     enum CodecID video_type;
56     unsigned int sample_count;
57     film_sample *sample_table;
58     unsigned int current_sample;
59
60     unsigned int base_clock;
61     unsigned int version;
62
63     /* buffer used for interleaving stereo PCM data */
64     unsigned char *stereo_buffer;
65     int stereo_buffer_size;
66 } FilmDemuxContext;
67
68 static int film_probe(AVProbeData *p)
69 {
70     if (AV_RB32(&p->buf[0]) != FILM_TAG)
71         return 0;
72
73     return AVPROBE_SCORE_MAX;
74 }
75
76 static int film_read_header(AVFormatContext *s,
77                             AVFormatParameters *ap)
78 {
79     FilmDemuxContext *film = s->priv_data;
80     AVIOContext *pb = s->pb;
81     AVStream *st;
82     unsigned char scratch[256];
83     int i;
84     unsigned int data_offset;
85     unsigned int audio_frame_counter;
86
87     film->sample_table = NULL;
88     film->stereo_buffer = NULL;
89     film->stereo_buffer_size = 0;
90
91     /* load the main FILM header */
92     if (avio_read(pb, scratch, 16) != 16)
93         return AVERROR(EIO);
94     data_offset = AV_RB32(&scratch[4]);
95     film->version = AV_RB32(&scratch[8]);
96
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)
101             return AVERROR(EIO);
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;
107     } else {
108         /* normal Saturn .cpk files; 32-byte header */
109         if (avio_read(pb, scratch, 32) != 32)
110             return AVERROR(EIO);
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_bits == 8)
117             film->audio_type = CODEC_ID_PCM_S8;
118         else if (film->audio_bits == 16)
119             film->audio_type = CODEC_ID_PCM_S16BE;
120         else
121             film->audio_type = CODEC_ID_NONE;
122     }
123
124     if (AV_RB32(&scratch[0]) != FDSC_TAG)
125         return AVERROR_INVALIDDATA;
126
127     if (AV_RB32(&scratch[8]) == CVID_TAG) {
128         film->video_type = CODEC_ID_CINEPAK;
129     } else
130         film->video_type = CODEC_ID_NONE;
131
132     /* initialize the decoder streams */
133     if (film->video_type) {
134         st = av_new_stream(s, 0);
135         if (!st)
136             return AVERROR(ENOMEM);
137         film->video_stream_index = st->index;
138         st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
139         st->codec->codec_id = film->video_type;
140         st->codec->codec_tag = 0;  /* no fourcc */
141         st->codec->width = AV_RB32(&scratch[16]);
142         st->codec->height = AV_RB32(&scratch[12]);
143     }
144
145     if (film->audio_type) {
146         st = av_new_stream(s, 0);
147         if (!st)
148             return AVERROR(ENOMEM);
149         film->audio_stream_index = st->index;
150         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
151         st->codec->codec_id = film->audio_type;
152         st->codec->codec_tag = 1;
153         st->codec->channels = film->audio_channels;
154         st->codec->sample_rate = film->audio_samplerate;
155
156         if (film->audio_type == CODEC_ID_ADPCM_ADX) {
157             st->codec->bits_per_coded_sample = 18 * 8 / 32;
158             st->codec->block_align = st->codec->channels * 18;
159         } else {
160             st->codec->bits_per_coded_sample = film->audio_bits;
161             st->codec->block_align = st->codec->channels *
162                 st->codec->bits_per_coded_sample / 8;
163         }
164
165         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
166             st->codec->bits_per_coded_sample;
167     }
168
169     /* load the sample table */
170     if (avio_read(pb, scratch, 16) != 16)
171         return AVERROR(EIO);
172     if (AV_RB32(&scratch[0]) != STAB_TAG)
173         return AVERROR_INVALIDDATA;
174     film->base_clock = AV_RB32(&scratch[8]);
175     film->sample_count = AV_RB32(&scratch[12]);
176     if(film->sample_count >= UINT_MAX / sizeof(film_sample))
177         return -1;
178     film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
179
180     for(i=0; i<s->nb_streams; i++)
181         av_set_pts_info(s->streams[i], 33, 1, film->base_clock);
182
183     audio_frame_counter = 0;
184     for (i = 0; i < film->sample_count; i++) {
185         /* load the next sample record and transfer it to an internal struct */
186         if (avio_read(pb, scratch, 16) != 16) {
187             av_free(film->sample_table);
188             return AVERROR(EIO);
189         }
190         film->sample_table[i].sample_offset =
191             data_offset + AV_RB32(&scratch[0]);
192         film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
193         if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
194             film->sample_table[i].stream = film->audio_stream_index;
195             film->sample_table[i].pts = audio_frame_counter;
196             film->sample_table[i].pts *= film->base_clock;
197             film->sample_table[i].pts /= film->audio_samplerate;
198
199             if (film->audio_type == CODEC_ID_ADPCM_ADX)
200                 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
201                     (18 * film->audio_channels));
202             else
203                 audio_frame_counter += (film->sample_table[i].sample_size /
204                     (film->audio_channels * film->audio_bits / 8));
205         } else {
206             film->sample_table[i].stream = film->video_stream_index;
207             film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
208             film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
209         }
210     }
211
212     film->current_sample = 0;
213
214     return 0;
215 }
216
217 static int film_read_packet(AVFormatContext *s,
218                             AVPacket *pkt)
219 {
220     FilmDemuxContext *film = s->priv_data;
221     AVIOContext *pb = s->pb;
222     film_sample *sample;
223     int ret = 0;
224     int i;
225     int left, right;
226
227     if (film->current_sample >= film->sample_count)
228         return AVERROR(EIO);
229
230     sample = &film->sample_table[film->current_sample];
231
232     /* position the stream (will probably be there anyway) */
233     avio_seek(pb, sample->sample_offset, SEEK_SET);
234
235     /* do a special song and dance when loading FILM Cinepak chunks */
236     if ((sample->stream == film->video_stream_index) &&
237         (film->video_type == CODEC_ID_CINEPAK)) {
238         pkt->pos= avio_tell(pb);
239         if (av_new_packet(pkt, sample->sample_size))
240             return AVERROR(ENOMEM);
241         avio_read(pb, pkt->data, sample->sample_size);
242     } else if ((sample->stream == film->audio_stream_index) &&
243         (film->audio_channels == 2) &&
244         (film->audio_type != CODEC_ID_ADPCM_ADX)) {
245         /* stereo PCM needs to be interleaved */
246
247         if (av_new_packet(pkt, sample->sample_size))
248             return AVERROR(ENOMEM);
249
250         /* make sure the interleave buffer is large enough */
251         if (sample->sample_size > film->stereo_buffer_size) {
252             av_free(film->stereo_buffer);
253             film->stereo_buffer_size = sample->sample_size;
254             film->stereo_buffer = av_malloc(film->stereo_buffer_size);
255         }
256
257         pkt->pos= avio_tell(pb);
258         ret = avio_read(pb, film->stereo_buffer, sample->sample_size);
259         if (ret != sample->sample_size)
260             ret = AVERROR(EIO);
261
262         left = 0;
263         right = sample->sample_size / 2;
264         for (i = 0; i < sample->sample_size; ) {
265             if (film->audio_bits == 8) {
266                 pkt->data[i++] = film->stereo_buffer[left++];
267                 pkt->data[i++] = film->stereo_buffer[right++];
268             } else {
269                 pkt->data[i++] = film->stereo_buffer[left++];
270                 pkt->data[i++] = film->stereo_buffer[left++];
271                 pkt->data[i++] = film->stereo_buffer[right++];
272                 pkt->data[i++] = film->stereo_buffer[right++];
273             }
274         }
275     } else {
276         ret= av_get_packet(pb, pkt, sample->sample_size);
277         if (ret != sample->sample_size)
278             ret = AVERROR(EIO);
279     }
280
281     pkt->stream_index = sample->stream;
282     pkt->pts = sample->pts;
283
284     film->current_sample++;
285
286     return ret;
287 }
288
289 static int film_read_close(AVFormatContext *s)
290 {
291     FilmDemuxContext *film = s->priv_data;
292
293     av_free(film->sample_table);
294     av_free(film->stereo_buffer);
295
296     return 0;
297 }
298
299 AVInputFormat ff_segafilm_demuxer = {
300     .name           = "film_cpk",
301     .long_name      = NULL_IF_CONFIG_SMALL("Sega FILM/CPK format"),
302     .priv_data_size = sizeof(FilmDemuxContext),
303     .read_probe     = film_probe,
304     .read_header    = film_read_header,
305     .read_packet    = film_read_packet,
306     .read_close     = film_read_close,
307 };