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  unsigned int sample_size;
44  int64_t sample_offset;
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  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;
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) {
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;
178  st->codecpar->codec_id = film->audio_type;
179  st->codecpar->codec_tag = 1;
180  st->codecpar->channels = film->audio_channels;
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;
187  } else {
189  st->codecpar->block_align = st->codecpar->channels *
191  }
192 
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  film->sample_table = av_malloc_array(film->sample_count, sizeof(film_sample));
205  if (!film->sample_table)
206  return AVERROR(ENOMEM);
207 
208  for (i = 0; i < s->nb_streams; i++) {
209  st = s->streams[i];
211  avpriv_set_pts_info(st, 33, 1, film->base_clock);
212  else
213  avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
214  }
215 
216  audio_frame_counter = video_frame_counter = 0;
217  for (i = 0; i < film->sample_count; i++) {
218  /* load the next sample record and transfer it to an internal struct */
219  if (avio_read(pb, scratch, 16) != 16) {
220  ret = AVERROR(EIO);
221  goto fail;
222  }
223  film->sample_table[i].sample_offset =
224  data_offset + AV_RB32(&scratch[0]);
225  film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
226  if (film->sample_table[i].sample_size > INT_MAX / 4) {
227  ret = AVERROR_INVALIDDATA;
228  goto fail;
229  }
230  if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
231  film->sample_table[i].stream = film->audio_stream_index;
232  film->sample_table[i].pts = audio_frame_counter;
233 
234  if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
235  audio_frame_counter += (film->sample_table[i].sample_size * 32 /
236  (18 * film->audio_channels));
237  else if (film->audio_type != AV_CODEC_ID_NONE)
238  audio_frame_counter += (film->sample_table[i].sample_size /
239  (film->audio_channels * film->audio_bits / 8));
240  } else {
241  film->sample_table[i].stream = film->video_stream_index;
242  film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
243  film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : AVINDEX_KEYFRAME;
244  video_frame_counter++;
245  if (film->video_type != AV_CODEC_ID_NONE)
247  film->sample_table[i].sample_offset,
248  film->sample_table[i].pts,
249  film->sample_table[i].sample_size, 0,
250  film->sample_table[i].keyframe);
251  }
252  }
253 
254  if (film->audio_type != AV_CODEC_ID_NONE)
255  s->streams[film->audio_stream_index]->duration = audio_frame_counter;
256 
257  if (film->video_type != AV_CODEC_ID_NONE)
258  s->streams[film->video_stream_index]->duration = video_frame_counter;
259 
260  film->current_sample = 0;
261 
262  return 0;
263 fail:
264  film_read_close(s);
265  return ret;
266 }
267 
269  AVPacket *pkt)
270 {
271  FilmDemuxContext *film = s->priv_data;
272  AVIOContext *pb = s->pb;
274  film_sample *next_sample = NULL;
275  int next_sample_id;
276  int ret = 0;
277 
278  if (film->current_sample >= film->sample_count)
279  return AVERROR_EOF;
280 
281  sample = &film->sample_table[film->current_sample];
282 
283  /* Find the next sample from the same stream, assuming there is one;
284  * this is used to calculate the duration below */
285  next_sample_id = film->current_sample + 1;
286  while (next_sample == NULL) {
287  if (next_sample_id >= film->sample_count)
288  break;
289 
290  next_sample = &film->sample_table[next_sample_id];
291  if (next_sample->stream != sample->stream) {
292  next_sample = NULL;
293  next_sample_id++;
294  }
295  }
296 
297  /* position the stream (will probably be there anyway) */
298  avio_seek(pb, sample->sample_offset, SEEK_SET);
299 
300  ret = av_get_packet(pb, pkt, sample->sample_size);
301  if (ret != sample->sample_size)
302  ret = AVERROR(EIO);
303 
304  pkt->stream_index = sample->stream;
305  pkt->dts = sample->pts;
306  pkt->pts = sample->pts;
307  pkt->flags |= sample->keyframe ? AV_PKT_FLAG_KEY : 0;
308  if (next_sample != NULL)
309  pkt->duration = next_sample->pts - sample->pts;
310 
311  film->current_sample++;
312 
313  return ret;
314 }
315 
316 static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
317 {
318  FilmDemuxContext *film = s->priv_data;
319  AVStream *st = s->streams[stream_index];
320  int64_t pos;
321  int ret = av_index_search_timestamp(st, timestamp, flags);
322  if (ret < 0)
323  return ret;
324 
325  pos = avio_seek(s->pb, st->internal->index_entries[ret].pos, SEEK_SET);
326  if (pos < 0)
327  return pos;
328 
329  film->current_sample = ret;
330 
331  return 0;
332 }
333 
335  .name = "film_cpk",
336  .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
337  .priv_data_size = sizeof(FilmDemuxContext),
343 };
#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:2044
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:4999
int64_t pos
Definition: avformat.h:813
static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: segafilm.c:316
#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: codec_par.h:60
int index
stream index in AVFormatContext
Definition: avformat.h:885
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:253
static int film_read_close(AVFormatContext *s)
Definition: segafilm.c:78
AVPacket * pkt
Definition: movenc.c:59
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:91
#define sample
Format I/O context.
Definition: avformat.h:1247
unsigned int audio_channels
Definition: segafilm.c:56
int width
Video only.
Definition: codec_par.h:126
unsigned int base_clock
Definition: segafilm.c:63
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:387
enum AVStreamParseType need_parsing
Definition: avformat.h:1092
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4553
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:91
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1315
#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:43
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:633
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:89
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:410
int video_stream_index
Definition: segafilm.c:50
#define AVINDEX_KEYFRAME
Definition: avformat.h:820
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:46
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
Definition: utils.c:2161
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:117
unsigned int pos
Definition: spdifenc.c:412
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
unsigned int current_sample
Definition: segafilm.c:61
unsigned int version
Definition: segafilm.c:64
#define fail()
Definition: checkasm.h:133
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:375
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: internal.h:250
int keyframe
Definition: segafilm.c:46
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1303
int block_align
Audio only.
Definition: codec_par.h:177
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:44
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
Stream structure.
Definition: avformat.h:884
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVStreamInternal * internal
An opaque field for libavformat internal usage.
Definition: avformat.h:1123
static int film_probe(const AVProbeData *p)
Definition: segafilm.c:67
AVIOContext * pb
I/O context.
Definition: avformat.h:1289
#define FDSC_TAG
Definition: segafilm.c:36
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
AVInputFormat ff_segafilm_demuxer
Definition: segafilm.c:334
#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:933
int sample_rate
Audio only.
Definition: codec_par.h:170
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
full parsing and repack
Definition: avformat.h:803
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:268
void * priv_data
Format private data.
Definition: avformat.h:1275
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
int channels
Audio only.
Definition: codec_par.h:166
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
Definition: packet.h:368
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:1049
#define av_malloc_array(a, b)
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:64
int stream_index
Definition: packet.h:371
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: packet.h:346
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:362
int i
Definition: input.c:407