segafilm: use the sample rate as the time base for audio streams
[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 Libav.
6  *
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.
11  *
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.
16  *
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
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 #include "internal.h"
33
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', ' ')
39
40 typedef struct {
41   int stream;
42   int64_t sample_offset;
43   unsigned int sample_size;
44   int64_t pts;
45   int keyframe;
46 } film_sample;
47
48 typedef struct FilmDemuxContext {
49     int video_stream_index;
50     int audio_stream_index;
51
52     enum CodecID audio_type;
53     unsigned int audio_samplerate;
54     unsigned int audio_bits;
55     unsigned int audio_channels;
56
57     enum CodecID video_type;
58     unsigned int sample_count;
59     film_sample *sample_table;
60     unsigned int current_sample;
61
62     unsigned int base_clock;
63     unsigned int version;
64
65     /* buffer used for interleaving stereo PCM data */
66     unsigned char *stereo_buffer;
67     int stereo_buffer_size;
68 } FilmDemuxContext;
69
70 static int film_probe(AVProbeData *p)
71 {
72     if (AV_RB32(&p->buf[0]) != FILM_TAG)
73         return 0;
74
75     return AVPROBE_SCORE_MAX;
76 }
77
78 static int film_read_header(AVFormatContext *s)
79 {
80     FilmDemuxContext *film = s->priv_data;
81     AVIOContext *pb = s->pb;
82     AVStream *st;
83     unsigned char scratch[256];
84     int i;
85     unsigned int data_offset;
86     unsigned int audio_frame_counter;
87
88     film->sample_table = NULL;
89     film->stereo_buffer = NULL;
90     film->stereo_buffer_size = 0;
91
92     /* load the main FILM header */
93     if (avio_read(pb, scratch, 16) != 16)
94         return AVERROR(EIO);
95     data_offset = AV_RB32(&scratch[4]);
96     film->version = AV_RB32(&scratch[8]);
97
98     /* load the FDSC chunk */
99     if (film->version == 0) {
100         /* special case for Lemmings .film files; 20-byte header */
101         if (avio_read(pb, scratch, 20) != 20)
102             return AVERROR(EIO);
103         /* make some assumptions about the audio parameters */
104         film->audio_type = CODEC_ID_PCM_S8;
105         film->audio_samplerate = 22050;
106         film->audio_channels = 1;
107         film->audio_bits = 8;
108     } else {
109         /* normal Saturn .cpk files; 32-byte header */
110         if (avio_read(pb, scratch, 32) != 32)
111             return AVERROR(EIO);
112         film->audio_samplerate = AV_RB16(&scratch[24]);
113         film->audio_channels = scratch[21];
114         film->audio_bits = scratch[22];
115         if (scratch[23] == 2)
116             film->audio_type = CODEC_ID_ADPCM_ADX;
117         else if (film->audio_channels > 0) {
118             if (film->audio_bits == 8)
119                 film->audio_type = CODEC_ID_PCM_S8;
120             else if (film->audio_bits == 16)
121                 film->audio_type = CODEC_ID_PCM_S16BE;
122             else
123                 film->audio_type = CODEC_ID_NONE;
124         } else
125             film->audio_type = CODEC_ID_NONE;
126     }
127
128     if (AV_RB32(&scratch[0]) != FDSC_TAG)
129         return AVERROR_INVALIDDATA;
130
131     if (AV_RB32(&scratch[8]) == CVID_TAG) {
132         film->video_type = CODEC_ID_CINEPAK;
133     } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
134         film->video_type = CODEC_ID_RAWVIDEO;
135     } else {
136         film->video_type = CODEC_ID_NONE;
137     }
138
139     /* initialize the decoder streams */
140     if (film->video_type) {
141         st = avformat_new_stream(s, NULL);
142         if (!st)
143             return AVERROR(ENOMEM);
144         film->video_stream_index = st->index;
145         st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
146         st->codec->codec_id = film->video_type;
147         st->codec->codec_tag = 0;  /* no fourcc */
148         st->codec->width = AV_RB32(&scratch[16]);
149         st->codec->height = AV_RB32(&scratch[12]);
150
151         if (film->video_type == CODEC_ID_RAWVIDEO) {
152             if (scratch[20] == 24) {
153                 st->codec->pix_fmt = PIX_FMT_RGB24;
154             } else {
155                 av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
156                 return -1;
157             }
158         }
159     }
160
161     if (film->audio_type) {
162         st = avformat_new_stream(s, NULL);
163         if (!st)
164             return AVERROR(ENOMEM);
165         film->audio_stream_index = st->index;
166         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
167         st->codec->codec_id = film->audio_type;
168         st->codec->codec_tag = 1;
169         st->codec->channels = film->audio_channels;
170         st->codec->sample_rate = film->audio_samplerate;
171
172         if (film->audio_type == CODEC_ID_ADPCM_ADX) {
173             st->codec->bits_per_coded_sample = 18 * 8 / 32;
174             st->codec->block_align = st->codec->channels * 18;
175             st->need_parsing = AVSTREAM_PARSE_FULL;
176         } else {
177             st->codec->bits_per_coded_sample = film->audio_bits;
178             st->codec->block_align = st->codec->channels *
179                 st->codec->bits_per_coded_sample / 8;
180         }
181
182         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
183             st->codec->bits_per_coded_sample;
184     }
185
186     /* load the sample table */
187     if (avio_read(pb, scratch, 16) != 16)
188         return AVERROR(EIO);
189     if (AV_RB32(&scratch[0]) != STAB_TAG)
190         return AVERROR_INVALIDDATA;
191     film->base_clock = AV_RB32(&scratch[8]);
192     film->sample_count = AV_RB32(&scratch[12]);
193     if(film->sample_count >= UINT_MAX / sizeof(film_sample))
194         return -1;
195     film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
196     if (!film->sample_table)
197         return AVERROR(ENOMEM);
198
199     for (i = 0; i < s->nb_streams; i++) {
200         st = s->streams[i];
201         if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
202             avpriv_set_pts_info(st, 33, 1, film->base_clock);
203         else
204             avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
205     }
206
207     audio_frame_counter = 0;
208     for (i = 0; i < film->sample_count; i++) {
209         /* load the next sample record and transfer it to an internal struct */
210         if (avio_read(pb, scratch, 16) != 16) {
211             av_free(film->sample_table);
212             return AVERROR(EIO);
213         }
214         film->sample_table[i].sample_offset =
215             data_offset + AV_RB32(&scratch[0]);
216         film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
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;
220
221             if (film->audio_type == 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 != CODEC_ID_NONE)
225                 audio_frame_counter += (film->sample_table[i].sample_size /
226                     (film->audio_channels * film->audio_bits / 8));
227         } else {
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;
231         }
232     }
233
234     film->current_sample = 0;
235
236     return 0;
237 }
238
239 static int film_read_packet(AVFormatContext *s,
240                             AVPacket *pkt)
241 {
242     FilmDemuxContext *film = s->priv_data;
243     AVIOContext *pb = s->pb;
244     film_sample *sample;
245     int ret = 0;
246     int i;
247     int left, right;
248
249     if (film->current_sample >= film->sample_count)
250         return AVERROR(EIO);
251
252     sample = &film->sample_table[film->current_sample];
253
254     /* position the stream (will probably be there anyway) */
255     avio_seek(pb, sample->sample_offset, SEEK_SET);
256
257     /* do a special song and dance when loading FILM Cinepak chunks */
258     if ((sample->stream == film->video_stream_index) &&
259         (film->video_type == CODEC_ID_CINEPAK)) {
260         pkt->pos= avio_tell(pb);
261         if (av_new_packet(pkt, sample->sample_size))
262             return AVERROR(ENOMEM);
263         avio_read(pb, pkt->data, sample->sample_size);
264     } else if ((sample->stream == film->audio_stream_index) &&
265         (film->audio_channels == 2) &&
266         (film->audio_type != CODEC_ID_ADPCM_ADX)) {
267         /* stereo PCM needs to be interleaved */
268
269         if (av_new_packet(pkt, sample->sample_size))
270             return AVERROR(ENOMEM);
271
272         /* make sure the interleave buffer is large enough */
273         if (sample->sample_size > film->stereo_buffer_size) {
274             av_free(film->stereo_buffer);
275             film->stereo_buffer_size = sample->sample_size;
276             film->stereo_buffer = av_malloc(film->stereo_buffer_size);
277             if (!film->stereo_buffer) {
278                 film->stereo_buffer_size = 0;
279                 return AVERROR(ENOMEM);
280             }
281         }
282
283         pkt->pos= avio_tell(pb);
284         ret = avio_read(pb, film->stereo_buffer, sample->sample_size);
285         if (ret != sample->sample_size)
286             ret = AVERROR(EIO);
287
288         left = 0;
289         right = sample->sample_size / 2;
290         for (i = 0; i < sample->sample_size; ) {
291             if (film->audio_bits == 8) {
292                 pkt->data[i++] = film->stereo_buffer[left++];
293                 pkt->data[i++] = film->stereo_buffer[right++];
294             } else {
295                 pkt->data[i++] = film->stereo_buffer[left++];
296                 pkt->data[i++] = film->stereo_buffer[left++];
297                 pkt->data[i++] = film->stereo_buffer[right++];
298                 pkt->data[i++] = film->stereo_buffer[right++];
299             }
300         }
301     } else {
302         ret= av_get_packet(pb, pkt, sample->sample_size);
303         if (ret != sample->sample_size)
304             ret = AVERROR(EIO);
305     }
306
307     pkt->stream_index = sample->stream;
308     pkt->pts = sample->pts;
309
310     film->current_sample++;
311
312     return ret;
313 }
314
315 static int film_read_close(AVFormatContext *s)
316 {
317     FilmDemuxContext *film = s->priv_data;
318
319     av_free(film->sample_table);
320     av_free(film->stereo_buffer);
321
322     return 0;
323 }
324
325 AVInputFormat ff_segafilm_demuxer = {
326     .name           = "film_cpk",
327     .long_name      = NULL_IF_CONFIG_SMALL("Sega FILM/CPK format"),
328     .priv_data_size = sizeof(FilmDemuxContext),
329     .read_probe     = film_probe,
330     .read_header    = film_read_header,
331     .read_packet    = film_read_packet,
332     .read_close     = film_read_close,
333 };