b75c8774ce7ad278bf3d94d057dd1f54f471cf4f
[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
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 #define RAW_TAG  MKBETAG('r', 'a', 'w', ' ')
38
39 typedef struct {
40   int stream;
41   int64_t sample_offset;
42   unsigned int sample_size;
43   int64_t pts;
44   int keyframe;
45 } film_sample;
46
47 typedef struct FilmDemuxContext {
48     int video_stream_index;
49     int audio_stream_index;
50
51     enum CodecID audio_type;
52     unsigned int audio_samplerate;
53     unsigned int audio_bits;
54     unsigned int audio_channels;
55
56     enum CodecID video_type;
57     unsigned int sample_count;
58     film_sample *sample_table;
59     unsigned int current_sample;
60
61     unsigned int base_clock;
62     unsigned int version;
63
64     /* buffer used for interleaving stereo PCM data */
65     unsigned char *stereo_buffer;
66     int stereo_buffer_size;
67 } FilmDemuxContext;
68
69 static int film_probe(AVProbeData *p)
70 {
71     if (AV_RB32(&p->buf[0]) != FILM_TAG)
72         return 0;
73
74     return AVPROBE_SCORE_MAX;
75 }
76
77 static int film_read_header(AVFormatContext *s,
78                             AVFormatParameters *ap)
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         } else {
176             st->codec->bits_per_coded_sample = film->audio_bits;
177             st->codec->block_align = st->codec->channels *
178                 st->codec->bits_per_coded_sample / 8;
179         }
180
181         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
182             st->codec->bits_per_coded_sample;
183     }
184
185     /* load the sample table */
186     if (avio_read(pb, scratch, 16) != 16)
187         return AVERROR(EIO);
188     if (AV_RB32(&scratch[0]) != STAB_TAG)
189         return AVERROR_INVALIDDATA;
190     film->base_clock = AV_RB32(&scratch[8]);
191     film->sample_count = AV_RB32(&scratch[12]);
192     if(film->sample_count >= UINT_MAX / sizeof(film_sample))
193         return -1;
194     film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
195     if (!film->sample_table)
196         return AVERROR(ENOMEM);
197
198     for(i=0; i<s->nb_streams; i++)
199         av_set_pts_info(s->streams[i], 33, 1, film->base_clock);
200
201     audio_frame_counter = 0;
202     for (i = 0; i < film->sample_count; i++) {
203         /* load the next sample record and transfer it to an internal struct */
204         if (avio_read(pb, scratch, 16) != 16) {
205             av_free(film->sample_table);
206             return AVERROR(EIO);
207         }
208         film->sample_table[i].sample_offset =
209             data_offset + AV_RB32(&scratch[0]);
210         film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
211         if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
212             film->sample_table[i].stream = film->audio_stream_index;
213             film->sample_table[i].pts = audio_frame_counter;
214             film->sample_table[i].pts *= film->base_clock;
215             film->sample_table[i].pts /= film->audio_samplerate;
216
217             if (film->audio_type == CODEC_ID_ADPCM_ADX)
218                 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
219                     (18 * film->audio_channels));
220             else if (film->audio_type != CODEC_ID_NONE)
221                 audio_frame_counter += (film->sample_table[i].sample_size /
222                     (film->audio_channels * film->audio_bits / 8));
223         } else {
224             film->sample_table[i].stream = film->video_stream_index;
225             film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
226             film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
227         }
228     }
229
230     film->current_sample = 0;
231
232     return 0;
233 }
234
235 static int film_read_packet(AVFormatContext *s,
236                             AVPacket *pkt)
237 {
238     FilmDemuxContext *film = s->priv_data;
239     AVIOContext *pb = s->pb;
240     film_sample *sample;
241     int ret = 0;
242     int i;
243     int left, right;
244
245     if (film->current_sample >= film->sample_count)
246         return AVERROR(EIO);
247
248     sample = &film->sample_table[film->current_sample];
249
250     /* position the stream (will probably be there anyway) */
251     avio_seek(pb, sample->sample_offset, SEEK_SET);
252
253     /* do a special song and dance when loading FILM Cinepak chunks */
254     if ((sample->stream == film->video_stream_index) &&
255         (film->video_type == CODEC_ID_CINEPAK)) {
256         pkt->pos= avio_tell(pb);
257         if (av_new_packet(pkt, sample->sample_size))
258             return AVERROR(ENOMEM);
259         avio_read(pb, pkt->data, sample->sample_size);
260     } else if ((sample->stream == film->audio_stream_index) &&
261         (film->audio_channels == 2) &&
262         (film->audio_type != CODEC_ID_ADPCM_ADX)) {
263         /* stereo PCM needs to be interleaved */
264
265         if (av_new_packet(pkt, sample->sample_size))
266             return AVERROR(ENOMEM);
267
268         /* make sure the interleave buffer is large enough */
269         if (sample->sample_size > film->stereo_buffer_size) {
270             av_free(film->stereo_buffer);
271             film->stereo_buffer_size = sample->sample_size;
272             film->stereo_buffer = av_malloc(film->stereo_buffer_size);
273             if (!film->stereo_buffer) {
274                 film->stereo_buffer_size = 0;
275                 return AVERROR(ENOMEM);
276             }
277         }
278
279         pkt->pos= avio_tell(pb);
280         ret = avio_read(pb, film->stereo_buffer, sample->sample_size);
281         if (ret != sample->sample_size)
282             ret = AVERROR(EIO);
283
284         left = 0;
285         right = sample->sample_size / 2;
286         for (i = 0; i < sample->sample_size; ) {
287             if (film->audio_bits == 8) {
288                 pkt->data[i++] = film->stereo_buffer[left++];
289                 pkt->data[i++] = film->stereo_buffer[right++];
290             } else {
291                 pkt->data[i++] = film->stereo_buffer[left++];
292                 pkt->data[i++] = film->stereo_buffer[left++];
293                 pkt->data[i++] = film->stereo_buffer[right++];
294                 pkt->data[i++] = film->stereo_buffer[right++];
295             }
296         }
297     } else {
298         ret= av_get_packet(pb, pkt, sample->sample_size);
299         if (ret != sample->sample_size)
300             ret = AVERROR(EIO);
301     }
302
303     pkt->stream_index = sample->stream;
304     pkt->pts = sample->pts;
305
306     film->current_sample++;
307
308     return ret;
309 }
310
311 static int film_read_close(AVFormatContext *s)
312 {
313     FilmDemuxContext *film = s->priv_data;
314
315     av_free(film->sample_table);
316     av_free(film->stereo_buffer);
317
318     return 0;
319 }
320
321 AVInputFormat ff_segafilm_demuxer = {
322     .name           = "film_cpk",
323     .long_name      = NULL_IF_CONFIG_SMALL("Sega FILM/CPK format"),
324     .priv_data_size = sizeof(FilmDemuxContext),
325     .read_probe     = film_probe,
326     .read_header    = film_read_header,
327     .read_packet    = film_read_packet,
328     .read_close     = film_read_close,
329 };