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   unsigned int sample_size;
44   int64_t sample_offset;
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 
film_probe(const AVProbeData * p)67 static int film_probe(const 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 
film_read_close(AVFormatContext * s)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 
film_read_header(AVFormatContext * s)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     if (film->video_type == AV_CODEC_ID_NONE && film->audio_type == AV_CODEC_ID_NONE)
148         return AVERROR_INVALIDDATA;
149 
150     /* initialize the decoder streams */
151     if (film->video_type != AV_CODEC_ID_NONE) {
152         st = avformat_new_stream(s, NULL);
153         if (!st)
154             return AVERROR(ENOMEM);
155         film->video_stream_index = st->index;
156         st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
157         st->codecpar->codec_id = film->video_type;
158         st->codecpar->codec_tag = 0;  /* no fourcc */
159         st->codecpar->width = AV_RB32(&scratch[16]);
160         st->codecpar->height = AV_RB32(&scratch[12]);
161 
162         if (film->video_type == AV_CODEC_ID_RAWVIDEO) {
163             if (scratch[20] == 24) {
164                 st->codecpar->format = AV_PIX_FMT_RGB24;
165             } else {
166                 av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
167                 return -1;
168             }
169         }
170     }
171 
172     if (film->audio_type != AV_CODEC_ID_NONE) {
173         st = avformat_new_stream(s, NULL);
174         if (!st)
175             return AVERROR(ENOMEM);
176         film->audio_stream_index = st->index;
177         st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
178         st->codecpar->codec_id = film->audio_type;
179         st->codecpar->codec_tag = 1;
180         st->codecpar->channels = film->audio_channels;
181         st->codecpar->sample_rate = film->audio_samplerate;
182 
183         if (film->audio_type == AV_CODEC_ID_ADPCM_ADX) {
184             st->codecpar->bits_per_coded_sample = 18 * 8 / 32;
185             st->codecpar->block_align = st->codecpar->channels * 18;
186             st->need_parsing = AVSTREAM_PARSE_FULL;
187         } else {
188             st->codecpar->bits_per_coded_sample = film->audio_bits;
189             st->codecpar->block_align = st->codecpar->channels *
190                 st->codecpar->bits_per_coded_sample / 8;
191         }
192 
193         st->codecpar->bit_rate = st->codecpar->channels * st->codecpar->sample_rate *
194             st->codecpar->bits_per_coded_sample;
195     }
196 
197     /* load the sample table */
198     if (avio_read(pb, scratch, 16) != 16)
199         return AVERROR(EIO);
200     if (AV_RB32(&scratch[0]) != STAB_TAG)
201         return AVERROR_INVALIDDATA;
202     film->base_clock = AV_RB32(&scratch[8]);
203     film->sample_count = AV_RB32(&scratch[12]);
204     if(film->sample_count >= UINT_MAX / sizeof(film_sample))
205         return -1;
206     film->sample_table = av_malloc_array(film->sample_count, sizeof(film_sample));
207     if (!film->sample_table)
208         return AVERROR(ENOMEM);
209 
210     for (i = 0; i < s->nb_streams; i++) {
211         st = s->streams[i];
212         if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
213             avpriv_set_pts_info(st, 33, 1, film->base_clock);
214         else
215             avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
216     }
217 
218     audio_frame_counter = video_frame_counter = 0;
219     for (i = 0; i < film->sample_count; i++) {
220         /* load the next sample record and transfer it to an internal struct */
221         if (avio_read(pb, scratch, 16) != 16) {
222             ret = AVERROR(EIO);
223             goto fail;
224         }
225         film->sample_table[i].sample_offset =
226             data_offset + AV_RB32(&scratch[0]);
227         film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
228         if (film->sample_table[i].sample_size > INT_MAX / 4) {
229             ret = AVERROR_INVALIDDATA;
230             goto fail;
231         }
232         if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
233             film->sample_table[i].stream = film->audio_stream_index;
234             film->sample_table[i].pts = audio_frame_counter;
235 
236             if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
237                 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
238                     (18 * film->audio_channels));
239             else if (film->audio_type != AV_CODEC_ID_NONE)
240                 audio_frame_counter += (film->sample_table[i].sample_size /
241                     (film->audio_channels * film->audio_bits / 8));
242         } else {
243             film->sample_table[i].stream = film->video_stream_index;
244             film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
245             film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : AVINDEX_KEYFRAME;
246             video_frame_counter++;
247             if (film->video_type != AV_CODEC_ID_NONE)
248                 av_add_index_entry(s->streams[film->video_stream_index],
249                                    film->sample_table[i].sample_offset,
250                                    film->sample_table[i].pts,
251                                    film->sample_table[i].sample_size, 0,
252                                    film->sample_table[i].keyframe);
253         }
254     }
255 
256     if (film->audio_type != AV_CODEC_ID_NONE)
257         s->streams[film->audio_stream_index]->duration = audio_frame_counter;
258 
259     if (film->video_type != AV_CODEC_ID_NONE)
260         s->streams[film->video_stream_index]->duration = video_frame_counter;
261 
262     film->current_sample = 0;
263 
264     return 0;
265 fail:
266     film_read_close(s);
267     return ret;
268 }
269 
film_read_packet(AVFormatContext * s,AVPacket * pkt)270 static int film_read_packet(AVFormatContext *s,
271                             AVPacket *pkt)
272 {
273     FilmDemuxContext *film = s->priv_data;
274     AVIOContext *pb = s->pb;
275     film_sample *sample;
276     film_sample *next_sample = NULL;
277     int next_sample_id;
278     int ret = 0;
279 
280     if (film->current_sample >= film->sample_count)
281         return AVERROR_EOF;
282 
283     sample = &film->sample_table[film->current_sample];
284 
285     /* Find the next sample from the same stream, assuming there is one;
286      * this is used to calculate the duration below */
287     next_sample_id = film->current_sample + 1;
288     while (next_sample == NULL) {
289         if (next_sample_id >= film->sample_count)
290             break;
291 
292         next_sample = &film->sample_table[next_sample_id];
293         if (next_sample->stream != sample->stream) {
294             next_sample = NULL;
295             next_sample_id++;
296         }
297     }
298 
299     /* position the stream (will probably be there anyway) */
300     avio_seek(pb, sample->sample_offset, SEEK_SET);
301 
302     ret = av_get_packet(pb, pkt, sample->sample_size);
303     if (ret != sample->sample_size)
304         ret = AVERROR(EIO);
305 
306     pkt->stream_index = sample->stream;
307     pkt->dts = sample->pts;
308     pkt->pts = sample->pts;
309     pkt->flags |= sample->keyframe ? AV_PKT_FLAG_KEY : 0;
310     if (next_sample != NULL)
311         pkt->duration = next_sample->pts - sample->pts;
312 
313     film->current_sample++;
314 
315     return ret;
316 }
317 
film_read_seek(AVFormatContext * s,int stream_index,int64_t timestamp,int flags)318 static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
319 {
320     FilmDemuxContext *film = s->priv_data;
321     AVStream *st = s->streams[stream_index];
322     int64_t pos;
323     int ret = av_index_search_timestamp(st, timestamp, flags);
324     if (ret < 0)
325         return ret;
326 
327     pos = avio_seek(s->pb, st->index_entries[ret].pos, SEEK_SET);
328     if (pos < 0)
329         return pos;
330 
331     film->current_sample = ret;
332 
333     return 0;
334 }
335 
336 AVInputFormat ff_segafilm_demuxer = {
337     .name           = "film_cpk",
338     .long_name      = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
339     .priv_data_size = sizeof(FilmDemuxContext),
340     .read_probe     = film_probe,
341     .read_header    = film_read_header,
342     .read_packet    = film_read_packet,
343     .read_close     = film_read_close,
344     .read_seek      = film_read_seek,
345 };
346