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 "libavutil/mem.h"
32 #include "avformat.h"
33 #include "demux.h"
34 #include "internal.h"
35 
36 #define FILM_TAG MKBETAG('F', 'I', 'L', 'M')
37 #define FDSC_TAG MKBETAG('F', 'D', 'S', 'C')
38 #define STAB_TAG MKBETAG('S', 'T', 'A', 'B')
39 #define CVID_TAG MKBETAG('c', 'v', 'i', 'd')
40 #define RAW_TAG MKBETAG('r', 'a', 'w', ' ')
41 
42 typedef struct film_sample {
43  int stream;
44  unsigned int sample_size;
45  int64_t sample_offset;
46  int64_t pts;
47  int keyframe;
48 } film_sample;
49 
50 typedef struct FilmDemuxContext {
53 
55  unsigned int audio_samplerate;
56  unsigned int audio_bits;
57  unsigned int audio_channels;
58 
60  unsigned int sample_count;
62  unsigned int current_sample;
63 
64  unsigned int base_clock;
65  unsigned int version;
67 
68 static int film_probe(const AVProbeData *p)
69 {
70  if (AV_RB32(&p->buf[0]) != FILM_TAG)
71  return 0;
72 
73  if (AV_RB32(&p->buf[16]) != FDSC_TAG)
74  return 0;
75 
76  return AVPROBE_SCORE_MAX;
77 }
78 
80 {
81  FilmDemuxContext *film = s->priv_data;
82 
83  av_freep(&film->sample_table);
84 
85  return 0;
86 }
87 
89 {
90  FilmDemuxContext *film = s->priv_data;
91  AVIOContext *pb = s->pb;
92  AVStream *st;
93  unsigned char scratch[256];
94  int i;
95  unsigned int data_offset;
96  unsigned int audio_frame_counter;
97  unsigned int video_frame_counter;
98 
99  film->sample_table = NULL;
100 
101  /* load the main FILM header */
102  if (avio_read(pb, scratch, 16) != 16)
103  return AVERROR(EIO);
104  data_offset = AV_RB32(&scratch[4]);
105  film->version = AV_RB32(&scratch[8]);
106 
107  /* load the FDSC chunk */
108  if (film->version == 0) {
109  /* special case for Lemmings .film files; 20-byte header */
110  if (avio_read(pb, scratch, 20) != 20)
111  return AVERROR(EIO);
112  /* make some assumptions about the audio parameters */
114  film->audio_samplerate = 22050;
115  film->audio_channels = 1;
116  film->audio_bits = 8;
117  } else {
118  /* normal Saturn .cpk files; 32-byte header */
119  if (avio_read(pb, scratch, 32) != 32)
120  return AVERROR(EIO);
121  film->audio_samplerate = AV_RB16(&scratch[24]);
122  film->audio_channels = scratch[21];
123  film->audio_bits = scratch[22];
124  if (scratch[23] == 2 && film->audio_channels > 0)
126  else if (film->audio_channels > 0) {
127  if (film->audio_bits == 8)
129  else if (film->audio_bits == 16)
131  else
133  } else
135  }
136 
137  if (AV_RB32(&scratch[0]) != FDSC_TAG)
138  return AVERROR_INVALIDDATA;
139 
140  if (AV_RB32(&scratch[8]) == CVID_TAG) {
142  } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
144  } else {
146  }
147 
148  if (film->video_type == AV_CODEC_ID_NONE && film->audio_type == AV_CODEC_ID_NONE)
149  return AVERROR_INVALIDDATA;
150 
151  /* initialize the decoder streams */
152  if (film->video_type != AV_CODEC_ID_NONE) {
153  st = avformat_new_stream(s, NULL);
154  if (!st)
155  return AVERROR(ENOMEM);
156  film->video_stream_index = st->index;
158  st->codecpar->codec_id = film->video_type;
159  st->codecpar->codec_tag = 0; /* no fourcc */
160  st->codecpar->width = AV_RB32(&scratch[16]);
161  st->codecpar->height = AV_RB32(&scratch[12]);
162 
163  if (film->video_type == AV_CODEC_ID_RAWVIDEO) {
164  if (scratch[20] == 24) {
166  } else {
167  av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
168  return -1;
169  }
170  }
171  }
172 
173  if (film->audio_type != AV_CODEC_ID_NONE) {
174  st = avformat_new_stream(s, NULL);
175  if (!st)
176  return AVERROR(ENOMEM);
177  film->audio_stream_index = st->index;
179  st->codecpar->codec_id = film->audio_type;
180  st->codecpar->codec_tag = 1;
183 
184  if (film->audio_type == AV_CODEC_ID_ADPCM_ADX) {
185  st->codecpar->bits_per_coded_sample = 18 * 8 / 32;
186  st->codecpar->block_align = film->audio_channels * 18;
188  } else {
190  st->codecpar->block_align = film->audio_channels *
192  }
193 
194  st->codecpar->bit_rate = film->audio_channels * st->codecpar->sample_rate *
196  }
197 
198  /* load the sample table */
199  if (avio_read(pb, scratch, 16) != 16)
200  return AVERROR(EIO);
201  if (AV_RB32(&scratch[0]) != STAB_TAG)
202  return AVERROR_INVALIDDATA;
203  film->base_clock = AV_RB32(&scratch[8]);
204  film->sample_count = AV_RB32(&scratch[12]);
205  film->sample_table = av_malloc_array(film->sample_count, sizeof(film_sample));
206  if (!film->sample_table)
207  return AVERROR(ENOMEM);
208 
209  for (i = 0; i < s->nb_streams; i++) {
210  st = s->streams[i];
212  avpriv_set_pts_info(st, 33, 1, film->base_clock);
213  else
214  avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
215  }
216 
217  audio_frame_counter = video_frame_counter = 0;
218  for (i = 0; i < film->sample_count; i++) {
219  /* load the next sample record and transfer it to an internal struct */
220  if (avio_read(pb, scratch, 16) != 16)
221  return AVERROR(EIO);
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  return AVERROR_INVALIDDATA;
227  if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
228  film->sample_table[i].stream = film->audio_stream_index;
229  film->sample_table[i].pts = audio_frame_counter;
230 
231  if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
232  audio_frame_counter += (film->sample_table[i].sample_size * 32 /
233  (18 * film->audio_channels));
234  else if (film->audio_type != AV_CODEC_ID_NONE)
235  audio_frame_counter += (film->sample_table[i].sample_size /
236  (film->audio_channels * film->audio_bits / 8));
237  } else {
238  film->sample_table[i].stream = film->video_stream_index;
239  film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
240  film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : AVINDEX_KEYFRAME;
241  video_frame_counter++;
242  if (film->video_type != AV_CODEC_ID_NONE)
243  av_add_index_entry(s->streams[film->video_stream_index],
245  film->sample_table[i].pts,
246  film->sample_table[i].sample_size, 0,
247  film->sample_table[i].keyframe);
248  }
249  }
250 
251  if (film->audio_type != AV_CODEC_ID_NONE)
252  s->streams[film->audio_stream_index]->duration = audio_frame_counter;
253 
254  if (film->video_type != AV_CODEC_ID_NONE)
255  s->streams[film->video_stream_index]->duration = video_frame_counter;
256 
257  film->current_sample = 0;
258 
259  return 0;
260 }
261 
263  AVPacket *pkt)
264 {
265  FilmDemuxContext *film = s->priv_data;
266  AVIOContext *pb = s->pb;
268  film_sample *next_sample = NULL;
269  int next_sample_id;
270  int ret = 0;
271 
272  if (film->current_sample >= film->sample_count)
273  return AVERROR_EOF;
274 
275  sample = &film->sample_table[film->current_sample];
276 
277  /* Find the next sample from the same stream, assuming there is one;
278  * this is used to calculate the duration below */
279  next_sample_id = film->current_sample + 1;
280  while (next_sample == NULL) {
281  if (next_sample_id >= film->sample_count)
282  break;
283 
284  next_sample = &film->sample_table[next_sample_id];
285  if (next_sample->stream != sample->stream) {
286  next_sample = NULL;
287  next_sample_id++;
288  }
289  }
290 
291  /* position the stream (will probably be there anyway) */
292  avio_seek(pb, sample->sample_offset, SEEK_SET);
293 
294  ret = av_get_packet(pb, pkt, sample->sample_size);
295  if (ret != sample->sample_size)
296  ret = AVERROR(EIO);
297 
298  pkt->stream_index = sample->stream;
299  pkt->dts = sample->pts;
300  pkt->pts = sample->pts;
301  pkt->flags |= sample->keyframe ? AV_PKT_FLAG_KEY : 0;
302  if (next_sample != NULL)
303  pkt->duration = next_sample->pts - sample->pts;
304 
305  film->current_sample++;
306 
307  return ret;
308 }
309 
310 static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
311 {
312  FilmDemuxContext *film = s->priv_data;
313  AVStream *st = s->streams[stream_index];
314  int64_t pos;
315  int ret = av_index_search_timestamp(st, timestamp, flags);
316  if (ret < 0)
317  return ret;
318 
319  pos = avio_seek(s->pb, ffstream(st)->index_entries[ret].pos, SEEK_SET);
320  if (pos < 0)
321  return pos;
322 
323  film->current_sample = ret;
324 
325  return 0;
326 }
327 
329  .p.name = "film_cpk",
330  .p.long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
331  .priv_data_size = sizeof(FilmDemuxContext),
332  .flags_internal = FF_INFMT_FLAG_INIT_CLEANUP,
338 };
RAW_TAG
#define RAW_TAG
Definition: segafilm.c:40
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
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:51
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const struct AVCodec *c)
Add a new stream to a media file.
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:262
AV_CODEC_ID_RAWVIDEO
@ AV_CODEC_ID_RAWVIDEO
Definition: codec_id.h:65
CVID_TAG
#define CVID_TAG
Definition: segafilm.c:39
AV_CODEC_ID_PCM_S16BE_PLANAR
@ AV_CODEC_ID_PCM_S16BE_PLANAR
Definition: codec_id.h:358
FilmDemuxContext::sample_count
unsigned int sample_count
Definition: segafilm.c:60
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:542
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:59
FilmDemuxContext::audio_channels
unsigned int audio_channels
Definition: segafilm.c:57
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:313
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:579
AVINDEX_KEYFRAME
#define AVINDEX_KEYFRAME
Definition: avformat.h:610
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:463
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: avformat.c:853
ffstream
static av_always_inline FFStream * ffstream(AVStream *st)
Definition: internal.h:417
read_seek
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:151
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:121
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:143
FilmDemuxContext::audio_samplerate
unsigned int audio_samplerate
Definition: segafilm.c:55
FilmDemuxContext
Definition: segafilm.c:50
film_sample
Definition: segafilm.c:42
FilmDemuxContext::video_stream_index
int video_stream_index
Definition: segafilm.c:51
FILM_TAG
#define FILM_TAG
Definition: segafilm.c:36
AV_CODEC_ID_PCM_S8
@ AV_CODEC_ID_PCM_S8
Definition: codec_id.h:332
FDSC_TAG
#define FDSC_TAG
Definition: segafilm.c:37
pkt
AVPacket * pkt
Definition: movenc.c:60
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
FilmDemuxContext::base_clock
unsigned int base_clock
Definition: segafilm.c:64
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_read_callback.c:42
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
film_sample::pts
int64_t pts
Definition: segafilm.c:46
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:553
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:453
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:134
ff_segafilm_demuxer
const FFInputFormat ff_segafilm_demuxer
Definition: segafilm.c:328
film_read_header
static int film_read_header(AVFormatContext *s)
Definition: segafilm.c:88
FilmDemuxContext::version
unsigned int version
Definition: segafilm.c:65
FF_INFMT_FLAG_INIT_CLEANUP
#define FF_INFMT_FLAG_INIT_CLEANUP
For an FFInputFormat with this flag set read_close() needs to be called by the caller upon read_heade...
Definition: demux.h:35
FFStream::need_parsing
enum AVStreamParseType need_parsing
Definition: internal.h:386
AVFormatContext
Format I/O context.
Definition: avformat.h:1255
film_probe
static int film_probe(const AVProbeData *p)
Definition: segafilm.c:68
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:766
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:550
NULL
#define NULL
Definition: coverity.c:32
STAB_TAG
#define STAB_TAG
Definition: segafilm.c:38
AV_CODEC_ID_CINEPAK
@ AV_CODEC_ID_CINEPAK
Definition: codec_id.h:95
FilmDemuxContext::audio_bits
unsigned int audio_bits
Definition: segafilm.c:56
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:451
FilmDemuxContext::current_sample
unsigned int current_sample
Definition: segafilm.c:62
FilmDemuxContext::sample_table
film_sample * sample_table
Definition: segafilm.c:61
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:180
film_read_seek
static int film_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: segafilm.c:310
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:184
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:49
FilmDemuxContext::video_type
enum AVCodecID video_type
Definition: segafilm.c:59
AVIOContext
Bytestream IO Context.
Definition: avio.h:160
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:75
AV_CODEC_ID_ADPCM_ADX
@ AV_CODEC_ID_ADPCM_ADX
Definition: codec_id.h:376
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:94
film_read_close
static int film_read_close(AVFormatContext *s)
Definition: segafilm.c:79
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
FFInputFormat::p
AVInputFormat p
The public AVInputFormat.
Definition: demux.h:41
AVPacket::dts
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
Definition: packet.h:523
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:530
film_sample::stream
int stream
Definition: segafilm.c:43
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:50
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:517
AVCodecParameters::height
int height
Definition: codec_par.h:135
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:191
av_malloc_array
#define av_malloc_array(a, b)
Definition: tableprint_vlc.h:31
demux.h
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:91
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:743
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:231
pos
unsigned int pos
Definition: spdifenc.c:414
avformat.h
AVStream::index
int index
stream index in AVFormatContext
Definition: avformat.h:749
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:612
AVPacket::stream_index
int stream_index
Definition: packet.h:526
FilmDemuxContext::audio_stream_index
int audio_stream_index
Definition: segafilm.c:52
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
read_probe
static int read_probe(const AVProbeData *p)
Definition: cdg.c:30
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:110
mem.h
AVCodecParameters::format
int format
Definition: codec_par.h:92
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:55
film_sample::keyframe
int keyframe
Definition: segafilm.c:47
AVPacket
This structure stores compressed data.
Definition: packet.h:501
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
FFInputFormat
Definition: demux.h:37
AV_CODEC_ID_PCM_S8_PLANAR
@ AV_CODEC_ID_PCM_S8_PLANAR
Definition: codec_id.h:355
film_sample::sample_size
unsigned int sample_size
Definition: segafilm.c:44
film_sample::sample_offset
int64_t sample_offset
Definition: segafilm.c:45
AVSTREAM_PARSE_FULL
@ AVSTREAM_PARSE_FULL
full parsing and repack
Definition: avformat.h:593
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:474
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:97
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
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:54
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:244