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 
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(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;
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  return AVERROR(EIO);
221  film->sample_table[i].sample_offset =
222  data_offset + AV_RB32(&scratch[0]);
223  film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
224  if (film->sample_table[i].sample_size > INT_MAX / 4)
225  return AVERROR_INVALIDDATA;
226  if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
227  film->sample_table[i].stream = film->audio_stream_index;
228  film->sample_table[i].pts = audio_frame_counter;
229 
230  if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
231  audio_frame_counter += (film->sample_table[i].sample_size * 32 /
232  (18 * film->audio_channels));
233  else if (film->audio_type != AV_CODEC_ID_NONE)
234  audio_frame_counter += (film->sample_table[i].sample_size /
235  (film->audio_channels * film->audio_bits / 8));
236  } else {
237  film->sample_table[i].stream = film->video_stream_index;
238  film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
239  film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : AVINDEX_KEYFRAME;
240  video_frame_counter++;
241  if (film->video_type != AV_CODEC_ID_NONE)
242  av_add_index_entry(s->streams[film->video_stream_index],
244  film->sample_table[i].pts,
245  film->sample_table[i].sample_size, 0,
246  film->sample_table[i].keyframe);
247  }
248  }
249 
250  if (film->audio_type != AV_CODEC_ID_NONE)
251  s->streams[film->audio_stream_index]->duration = audio_frame_counter;
252 
253  if (film->video_type != AV_CODEC_ID_NONE)
254  s->streams[film->video_stream_index]->duration = video_frame_counter;
255 
256  film->current_sample = 0;
257 
258  return 0;
259 }
260 
262  AVPacket *pkt)
263 {
264  FilmDemuxContext *film = s->priv_data;
265  AVIOContext *pb = s->pb;
267  film_sample *next_sample = NULL;
268  int next_sample_id;
269  int ret = 0;
270 
271  if (film->current_sample >= film->sample_count)
272  return AVERROR_EOF;
273 
274  sample = &film->sample_table[film->current_sample];
275 
276  /* Find the next sample from the same stream, assuming there is one;
277  * this is used to calculate the duration below */
278  next_sample_id = film->current_sample + 1;
279  while (next_sample == NULL) {
280  if (next_sample_id >= film->sample_count)
281  break;
282 
283  next_sample = &film->sample_table[next_sample_id];
284  if (next_sample->stream != sample->stream) {
285  next_sample = NULL;
286  next_sample_id++;
287  }
288  }
289 
290  /* position the stream (will probably be there anyway) */
291  avio_seek(pb, sample->sample_offset, SEEK_SET);
292 
293  ret = av_get_packet(pb, pkt, sample->sample_size);
294  if (ret != sample->sample_size)
295  ret = AVERROR(EIO);
296 
297  pkt->stream_index = sample->stream;
298  pkt->dts = sample->pts;
299  pkt->pts = sample->pts;
300  pkt->flags |= sample->keyframe ? AV_PKT_FLAG_KEY : 0;
301  if (next_sample != NULL)
302  pkt->duration = next_sample->pts - sample->pts;
303 
304  film->current_sample++;
305 
306  return ret;
307 }
308 
309 static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
310 {
311  FilmDemuxContext *film = s->priv_data;
312  AVStream *st = s->streams[stream_index];
313  int64_t pos;
314  int ret = av_index_search_timestamp(st, timestamp, flags);
315  if (ret < 0)
316  return ret;
317 
318  pos = avio_seek(s->pb, ffstream(st)->index_entries[ret].pos, SEEK_SET);
319  if (pos < 0)
320  return pos;
321 
322  film->current_sample = ret;
323 
324  return 0;
325 }
326 
328  .name = "film_cpk",
329  .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
330  .priv_data_size = sizeof(FilmDemuxContext),
331  .flags_internal = FF_FMT_INIT_CLEANUP,
337 };
FF_FMT_INIT_CLEANUP
#define FF_FMT_INIT_CLEANUP
For an AVInputFormat with this flag set read_close() needs to be called by the caller upon read_heade...
Definition: internal.h:48
RAW_TAG
#define RAW_TAG
Definition: segafilm.c:39
AVERROR
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
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:724
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
film_read_packet
static int film_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: segafilm.c:261
AV_CODEC_ID_RAWVIDEO
@ AV_CODEC_ID_RAWVIDEO
Definition: codec_id.h:63
CVID_TAG
#define CVID_TAG
Definition: segafilm.c:38
AV_CODEC_ID_PCM_S16BE_PLANAR
@ AV_CODEC_ID_PCM_S16BE_PLANAR
Definition: codec_id.h:343
FilmDemuxContext::sample_count
unsigned int sample_count
Definition: segafilm.c:59
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:391
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:64
FilmDemuxContext::audio_channels
unsigned int audio_channels
Definition: segafilm.c:56
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:425
AVINDEX_KEYFRAME
#define AVINDEX_KEYFRAME
Definition: avformat.h:785
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:458
AVCodecParameters::channels
int channels
Audio only.
Definition: codec_par.h:166
ffstream
static av_always_inline FFStream * ffstream(AVStream *st)
Definition: internal.h:426
read_seek
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:149
av_add_index_entry
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: seek.c:117
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:141
FilmDemuxContext::audio_samplerate
unsigned int audio_samplerate
Definition: segafilm.c:54
FilmDemuxContext
Definition: segafilm.c:49
film_sample
Definition: segafilm.c:41
FilmDemuxContext::video_stream_index
int video_stream_index
Definition: segafilm.c:50
FILM_TAG
#define FILM_TAG
Definition: segafilm.c:35
AV_CODEC_ID_PCM_S8
@ AV_CODEC_ID_PCM_S8
Definition: codec_id.h:317
FDSC_TAG
#define FDSC_TAG
Definition: segafilm.c:36
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
AVInputFormat
Definition: avformat.h:626
FilmDemuxContext::base_clock
unsigned int base_clock
Definition: segafilm.c:63
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
film_sample::pts
int64_t pts
Definition: segafilm.c:45
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:631
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:448
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:126
film_read_header
static int film_read_header(AVFormatContext *s)
Definition: segafilm.c:87
FilmDemuxContext::version
unsigned int version
Definition: segafilm.c:64
FFStream::need_parsing
enum AVStreamParseType need_parsing
Definition: internal.h:399
AVFormatContext
Format I/O context.
Definition: avformat.h:1097
film_probe
static int film_probe(const AVProbeData *p)
Definition: segafilm.c:67
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:992
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
NULL
#define NULL
Definition: coverity.c:32
read_probe
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
STAB_TAG
#define STAB_TAG
Definition: segafilm.c:37
AV_CODEC_ID_CINEPAK
@ AV_CODEC_ID_CINEPAK
Definition: codec_id.h:93
FilmDemuxContext::audio_bits
unsigned int audio_bits
Definition: segafilm.c:55
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:446
FilmDemuxContext::current_sample
unsigned int current_sample
Definition: segafilm.c:61
FilmDemuxContext::sample_table
film_sample * sample_table
Definition: segafilm.c:60
film_read_seek
static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: segafilm.c:309
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:170
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:47
FilmDemuxContext::video_type
enum AVCodecID video_type
Definition: segafilm.c:58
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:68
AV_CODEC_ID_ADPCM_ADX
@ AV_CODEC_ID_ADPCM_ADX
Definition: codec_id.h:361
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
film_read_close
static int film_read_close(AVFormatContext *s)
Definition: segafilm.c:78
sample
#define sample
Definition: flacdsp_template.c:44
AV_RB32
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:96
AVPacket::dts
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
Definition: packet.h:372
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:379
film_sample::stream
int stream
Definition: segafilm.c:42
ff_segafilm_demuxer
const AVInputFormat ff_segafilm_demuxer
Definition: segafilm.c:327
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:48
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:366
avio_internal.h
AVCodecParameters::height
int height
Definition: codec_par.h:127
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:177
av_malloc_array
#define av_malloc_array(a, b)
Definition: tableprint_vlc.h:32
av_get_packet
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:196
ret
ret
Definition: filter_design.txt:187
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVStream
Stream structure.
Definition: avformat.h:845
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
pos
unsigned int pos
Definition: spdifenc.c:412
avformat.h
AVStream::index
int index
stream index in AVFormatContext
Definition: avformat.h:846
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:625
avpriv_set_pts_info
void avpriv_set_pts_info(AVStream *st, 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:1146
AVPacket::stream_index
int stream_index
Definition: packet.h:375
FilmDemuxContext::audio_stream_index
int audio_stream_index
Definition: segafilm.c:51
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
AVCodecParameters::format
int format
Definition: codec_par.h:84
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
film_sample::keyframe
int keyframe
Definition: segafilm.c:46
AVPacket
This structure stores compressed data.
Definition: packet.h:350
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
AV_CODEC_ID_PCM_S8_PLANAR
@ AV_CODEC_ID_PCM_S8_PLANAR
Definition: codec_id.h:340
film_sample::sample_size
unsigned int sample_size
Definition: segafilm.c:43
film_sample::sample_offset
int64_t sample_offset
Definition: segafilm.c:44
AVSTREAM_PARSE_FULL
@ AVSTREAM_PARSE_FULL
full parsing and repack
Definition: avformat.h:768
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:89
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
FilmDemuxContext::audio_type
enum AVCodecID audio_type
Definition: segafilm.c:53
AV_RB16
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:98
av_index_search_timestamp
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
Definition: seek.c:237