FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
segafilm.c
Go to the documentation of this file.
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 {
52 
54  unsigned int audio_samplerate;
55  unsigned int audio_bits;
56  unsigned int audio_channels;
57 
59  unsigned int sample_count;
61  unsigned int current_sample;
62 
63  unsigned int base_clock;
64  unsigned int version;
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 
79 {
80  FilmDemuxContext *film = s->priv_data;
81 
82  av_freep(&film->sample_table);
83 
84  return 0;
85 }
86 
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 */
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)
125  else if (film->audio_channels > 0) {
126  if (film->audio_bits == 8)
128  else if (film->audio_bits == 16)
130  else
132  } else
134  }
135 
136  if (AV_RB32(&scratch[0]) != FDSC_TAG)
137  return AVERROR_INVALIDDATA;
138 
139  if (AV_RB32(&scratch[8]) == CVID_TAG) {
141  } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
143  } else {
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;
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) {
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;
175  st->codecpar->codec_id = film->audio_type;
176  st->codecpar->codec_tag = 1;
177  st->codecpar->channels = film->audio_channels;
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;
184  } else {
186  st->codecpar->block_align = st->codecpar->channels *
188  }
189 
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];
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) ? 0 : 1;
243  video_frame_counter++;
244  if (film->video_type)
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 
268  AVPacket *pkt)
269 {
270  FilmDemuxContext *film = s->priv_data;
271  AVIOContext *pb = s->pb;
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 
290  film->current_sample++;
291 
292  return ret;
293 }
294 
295 static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
296 {
297  FilmDemuxContext *film = s->priv_data;
298  AVStream *st = s->streams[stream_index];
299  int64_t pos;
300  int ret = av_index_search_timestamp(st, timestamp, flags);
301  if (ret < 0)
302  return ret;
303 
304  pos = avio_seek(s->pb, st->index_entries[ret].pos, SEEK_SET);
305  if (pos < 0)
306  return pos;
307 
308  film->current_sample = ret;
309 
310  return 0;
311 }
312 
314  .name = "film_cpk",
315  .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
316  .priv_data_size = sizeof(FilmDemuxContext),
322 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:631
Bytestream IO Context.
Definition: avio.h:111
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, int size, int distance, int flags)
Add an index entry into a sorted list.
Definition: utils.c:1897
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:64
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4399
int64_t pos
Definition: avformat.h:816
static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: segafilm.c:295
#define FILM_TAG
Definition: segafilm.c:35
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:153
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3911
int index
stream index in AVFormatContext
Definition: avformat.h:877
unsigned int sample_count
Definition: segafilm.c:59
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:213
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:1085
static int film_read_close(AVFormatContext *s)
Definition: segafilm.c:78
static AVPacket pkt
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_WB24 unsigned int_TMPL AV_RB16
Definition: bytestream.h:87
#define sample
Format I/O context.
Definition: avformat.h:1319
unsigned int audio_channels
Definition: segafilm.c:56
int width
Video only.
Definition: avcodec.h:3977
unsigned int base_clock
Definition: segafilm.c:63
enum AVStreamParseType need_parsing
Definition: avformat.h:1074
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4037
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_RB32
Definition: bytestream.h:87
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1387
#define AVERROR_EOF
End of file.
Definition: error.h:55
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:260
#define STAB_TAG
Definition: segafilm.c:37
int stream
Definition: segafilm.c:42
unsigned int sample_size
Definition: segafilm.c:44
unsigned int audio_samplerate
Definition: segafilm.c:54
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:550
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: avcodec.h:3940
int video_stream_index
Definition: segafilm.c:50
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:189
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
Definition: utils.c:1996
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3907
unsigned int current_sample
Definition: segafilm.c:61
unsigned int version
Definition: segafilm.c:64
#define fail()
Definition: checkasm.h:81
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:461
int keyframe
Definition: segafilm.c:46
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1375
int block_align
Audio only.
Definition: avcodec.h:4028
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
film_sample * sample_table
Definition: segafilm.c:60
unsigned int audio_bits
Definition: segafilm.c:55
#define RAW_TAG
Definition: segafilm.c:39
#define CVID_TAG
Definition: segafilm.c:38
int64_t pts
Definition: segafilm.c:45
enum AVCodecID video_type
Definition: segafilm.c:58
static int film_read_header(AVFormatContext *s)
Definition: segafilm.c:87
int64_t sample_offset
Definition: segafilm.c:43
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:638
Stream structure.
Definition: avformat.h:876
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVIOContext * pb
I/O context.
Definition: avformat.h:1361
static int film_probe(AVProbeData *p)
Definition: segafilm.c:67
#define FDSC_TAG
Definition: segafilm.c:36
This structure contains the data a format has to probe a file.
Definition: avformat.h:459
AVInputFormat ff_segafilm_demuxer
Definition: segafilm.c:313
static int flags
Definition: cpu.c:47
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:930
int sample_rate
Audio only.
Definition: avcodec.h:4021
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:471
full parsing and repack
Definition: avformat.h:806
Main libavformat public API header.
int audio_stream_index
Definition: segafilm.c:51
static int film_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: segafilm.c:267
void * priv_data
Format private data.
Definition: avformat.h:1347
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: avcodec.h:3953
int channels
Audio only.
Definition: avcodec.h:4017
enum AVCodecID audio_type
Definition: segafilm.c:53
#define av_freep(p)
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:660
AVCodecParameters * codecpar
Definition: avformat.h:1006
#define av_malloc_array(a, b)
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3915
int stream_index
Definition: avcodec.h:1576
This structure stores compressed data.
Definition: avcodec.h:1551
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1567