FFmpeg
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 
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;
61  unsigned int current_sample;
62 
63  unsigned int base_clock;
64  unsigned int version;
66 
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 
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 : AVINDEX_KEYFRAME;
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  film_sample *next_sample = NULL;
274  int next_sample_id;
275  int ret = 0;
276 
277  if (film->current_sample >= film->sample_count)
278  return AVERROR_EOF;
279 
280  sample = &film->sample_table[film->current_sample];
281 
282  /* Find the next sample from the same stream, assuming there is one;
283  * this is used to calculate the duration below */
284  next_sample_id = film->current_sample + 1;
285  while (next_sample == NULL) {
286  if (next_sample_id >= film->sample_count)
287  break;
288 
289  next_sample = &film->sample_table[next_sample_id];
290  if (next_sample->stream != sample->stream) {
291  next_sample = NULL;
292  next_sample_id++;
293  }
294  }
295 
296  /* position the stream (will probably be there anyway) */
297  avio_seek(pb, sample->sample_offset, SEEK_SET);
298 
299  ret = av_get_packet(pb, pkt, sample->sample_size);
300  if (ret != sample->sample_size)
301  ret = AVERROR(EIO);
302 
303  pkt->stream_index = sample->stream;
304  pkt->dts = sample->pts;
305  pkt->pts = sample->pts;
306  pkt->flags |= sample->keyframe ? AV_PKT_FLAG_KEY : 0;
307  if (next_sample != NULL)
308  pkt->duration = next_sample->pts - sample->pts;
309 
310  film->current_sample++;
311 
312  return ret;
313 }
314 
315 static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
316 {
317  FilmDemuxContext *film = s->priv_data;
318  AVStream *st = s->streams[stream_index];
319  int64_t pos;
320  int ret = av_index_search_timestamp(st, timestamp, flags);
321  if (ret < 0)
322  return ret;
323 
324  pos = avio_seek(s->pb, st->index_entries[ret].pos, SEEK_SET);
325  if (pos < 0)
326  return pos;
327 
328  film->current_sample = ret;
329 
330  return 0;
331 }
332 
334  .name = "film_cpk",
335  .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
336  .priv_data_size = sizeof(FilmDemuxContext),
342 };
#define NULL
Definition: coverity.c:32
Bytestream IO Context.
Definition: avio.h:161
#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:2049
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:68
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:4929
int64_t pos
Definition: avformat.h:810
static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: segafilm.c:315
#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:3968
int index
stream index in AVFormatContext
Definition: avformat.h:882
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:246
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:1110
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:1358
unsigned int audio_channels
Definition: segafilm.c:56
int width
Video only.
Definition: avcodec.h:4034
unsigned int base_clock
Definition: segafilm.c:63
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:1498
enum AVStreamParseType need_parsing
Definition: avformat.h:1099
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4502
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:1426
#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:310
#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:650
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: avcodec.h:3997
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1512
int video_stream_index
Definition: segafilm.c:50
#define AVINDEX_KEYFRAME
Definition: avformat.h:817
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:215
#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:2164
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3964
unsigned int current_sample
Definition: segafilm.c:61
unsigned int version
Definition: segafilm.c:64
#define fail()
Definition: checkasm.h:122
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1486
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:448
int keyframe
Definition: segafilm.c:46
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1414
int block_align
Audio only.
Definition: avcodec.h:4085
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
#define s(width, name)
Definition: cbs_vp9.c:257
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:530
Stream structure.
Definition: avformat.h:881
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
static int film_probe(const AVProbeData *p)
Definition: segafilm.c:67
AVIOContext * pb
I/O context.
Definition: avformat.h:1400
#define FDSC_TAG
Definition: segafilm.c:36
This structure contains the data a format has to probe a file.
Definition: avformat.h:446
AVInputFormat ff_segafilm_demuxer
Definition: segafilm.c:333
#define flags(name, subs,...)
Definition: cbs_av1.c:561
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:930
int sample_rate
Audio only.
Definition: avcodec.h:4078
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:458
full parsing and repack
Definition: avformat.h:800
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:1386
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: avcodec.h:4010
int channels
Audio only.
Definition: avcodec.h:4074
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
Definition: avcodec.h:1479
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:654
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1028
#define av_malloc_array(a, b)
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3972
int stream_index
Definition: avcodec.h:1482
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions
This structure stores compressed data.
Definition: avcodec.h:1457
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1473