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