FFmpeg  2.1.1
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 {
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  return AVPROBE_SCORE_MAX;
73 }
74 
76 {
77  FilmDemuxContext *film = s->priv_data;
78  AVIOContext *pb = s->pb;
79  AVStream *st;
80  unsigned char scratch[256];
81  int i;
82  unsigned int data_offset;
83  unsigned int audio_frame_counter;
84 
85  film->sample_table = NULL;
86 
87  /* load the main FILM header */
88  if (avio_read(pb, scratch, 16) != 16)
89  return AVERROR(EIO);
90  data_offset = AV_RB32(&scratch[4]);
91  film->version = AV_RB32(&scratch[8]);
92 
93  /* load the FDSC chunk */
94  if (film->version == 0) {
95  /* special case for Lemmings .film files; 20-byte header */
96  if (avio_read(pb, scratch, 20) != 20)
97  return AVERROR(EIO);
98  /* make some assumptions about the audio parameters */
100  film->audio_samplerate = 22050;
101  film->audio_channels = 1;
102  film->audio_bits = 8;
103  } else {
104  /* normal Saturn .cpk files; 32-byte header */
105  if (avio_read(pb, scratch, 32) != 32)
106  return AVERROR(EIO);
107  film->audio_samplerate = AV_RB16(&scratch[24]);
108  film->audio_channels = scratch[21];
109  film->audio_bits = scratch[22];
110  if (scratch[23] == 2 && film->audio_channels > 0)
112  else if (film->audio_channels > 0) {
113  if (film->audio_bits == 8)
115  else if (film->audio_bits == 16)
117  else
119  } else
121  }
122 
123  if (AV_RB32(&scratch[0]) != FDSC_TAG)
124  return AVERROR_INVALIDDATA;
125 
126  if (AV_RB32(&scratch[8]) == CVID_TAG) {
128  } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
130  } else {
132  }
133 
134  /* initialize the decoder streams */
135  if (film->video_type) {
136  st = avformat_new_stream(s, NULL);
137  if (!st)
138  return AVERROR(ENOMEM);
139  film->video_stream_index = st->index;
141  st->codec->codec_id = film->video_type;
142  st->codec->codec_tag = 0; /* no fourcc */
143  st->codec->width = AV_RB32(&scratch[16]);
144  st->codec->height = AV_RB32(&scratch[12]);
145 
146  if (film->video_type == AV_CODEC_ID_RAWVIDEO) {
147  if (scratch[20] == 24) {
149  } else {
150  av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
151  return -1;
152  }
153  }
154  }
155 
156  if (film->audio_type) {
157  st = avformat_new_stream(s, NULL);
158  if (!st)
159  return AVERROR(ENOMEM);
160  film->audio_stream_index = st->index;
162  st->codec->codec_id = film->audio_type;
163  st->codec->codec_tag = 1;
164  st->codec->channels = film->audio_channels;
165  st->codec->sample_rate = film->audio_samplerate;
166 
167  if (film->audio_type == AV_CODEC_ID_ADPCM_ADX) {
168  st->codec->bits_per_coded_sample = 18 * 8 / 32;
169  st->codec->block_align = st->codec->channels * 18;
171  } else {
173  st->codec->block_align = st->codec->channels *
174  st->codec->bits_per_coded_sample / 8;
175  }
176 
177  st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
179  }
180 
181  /* load the sample table */
182  if (avio_read(pb, scratch, 16) != 16)
183  return AVERROR(EIO);
184  if (AV_RB32(&scratch[0]) != STAB_TAG)
185  return AVERROR_INVALIDDATA;
186  film->base_clock = AV_RB32(&scratch[8]);
187  film->sample_count = AV_RB32(&scratch[12]);
188  if(film->sample_count >= UINT_MAX / sizeof(film_sample))
189  return -1;
190  film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
191  if (!film->sample_table)
192  return AVERROR(ENOMEM);
193 
194  for (i = 0; i < s->nb_streams; i++) {
195  st = s->streams[i];
196  if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
197  avpriv_set_pts_info(st, 33, 1, film->base_clock);
198  else
199  avpriv_set_pts_info(st, 64, 1, film->audio_samplerate);
200  }
201 
202  audio_frame_counter = 0;
203  for (i = 0; i < film->sample_count; i++) {
204  /* load the next sample record and transfer it to an internal struct */
205  if (avio_read(pb, scratch, 16) != 16) {
206  av_freep(&film->sample_table);
207  return AVERROR(EIO);
208  }
209  film->sample_table[i].sample_offset =
210  data_offset + AV_RB32(&scratch[0]);
211  film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
212  if (film->sample_table[i].sample_size > INT_MAX / 4)
213  return AVERROR_INVALIDDATA;
214  if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
215  film->sample_table[i].stream = film->audio_stream_index;
216  film->sample_table[i].pts = audio_frame_counter;
217 
218  if (film->audio_type == AV_CODEC_ID_ADPCM_ADX)
219  audio_frame_counter += (film->sample_table[i].sample_size * 32 /
220  (18 * film->audio_channels));
221  else if (film->audio_type != AV_CODEC_ID_NONE)
222  audio_frame_counter += (film->sample_table[i].sample_size /
223  (film->audio_channels * film->audio_bits / 8));
224  } else {
225  film->sample_table[i].stream = film->video_stream_index;
226  film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
227  film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
228  }
229  }
230 
231  film->current_sample = 0;
232 
233  return 0;
234 }
235 
237  AVPacket *pkt)
238 {
239  FilmDemuxContext *film = s->priv_data;
240  AVIOContext *pb = s->pb;
242  int ret = 0;
243 
244  if (film->current_sample >= film->sample_count)
245  return AVERROR_EOF;
246 
247  sample = &film->sample_table[film->current_sample];
248 
249  /* position the stream (will probably be there anyway) */
250  avio_seek(pb, sample->sample_offset, SEEK_SET);
251 
252  /* do a special song and dance when loading FILM Cinepak chunks */
253  if ((sample->stream == film->video_stream_index) &&
254  (film->video_type == AV_CODEC_ID_CINEPAK)) {
255  pkt->pos= avio_tell(pb);
256  if (av_new_packet(pkt, sample->sample_size))
257  return AVERROR(ENOMEM);
258  avio_read(pb, pkt->data, sample->sample_size);
259  } else {
260  ret= av_get_packet(pb, pkt, sample->sample_size);
261  if (ret != sample->sample_size)
262  ret = AVERROR(EIO);
263  }
264 
265  pkt->stream_index = sample->stream;
266  pkt->pts = sample->pts;
267 
268  film->current_sample++;
269 
270  return ret;
271 }
272 
274 {
275  FilmDemuxContext *film = s->priv_data;
276 
277  av_freep(&film->sample_table);
278 
279  return 0;
280 }
281 
283  .name = "film_cpk",
284  .long_name = NULL_IF_CONFIG_SMALL("Sega FILM / CPK"),
285  .priv_data_size = sizeof(FilmDemuxContext),
290 };
const char * s
Definition: avisynth_c.h:668
Bytestream IO Context.
Definition: avio.h:68
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:478
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:1092
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:3922
#define FILM_TAG
Definition: segafilm.c:35
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: avcodec.h:4536
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:686
int index
stream index in AVFormatContext
Definition: avformat.h:668
unsigned int sample_count
Definition: segafilm.c:59
void av_log(void *avcl, int level, const char *fmt,...) av_printf_format(3
Send the specified message to the log if the level is less than or equal to the current av_log_level...
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1342
static int film_read_close(AVFormatContext *s)
Definition: segafilm.c:273
#define sample
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs...
Definition: avcodec.h:1910
void av_freep(void *ptr)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...
Definition: mem.c:234
Format I/O context.
Definition: avformat.h:968
#define AV_RB16(x)
Definition: intreadwrite.h:232
unsigned int audio_channels
Definition: segafilm.c:56
unsigned int base_clock
Definition: segafilm.c:63
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:336
enum AVStreamParseType need_parsing
Definition: avformat.h:812
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:248
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
#define STAB_TAG
Definition: segafilm.c:37
int stream
Definition: segafilm.c:42
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:2563
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:3348
unsigned int sample_size
Definition: segafilm.c:44
unsigned int audio_samplerate
Definition: segafilm.c:54
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:200
int video_stream_index
Definition: segafilm.c:50
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:83
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:102
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: avcodec.h:4147
void * priv_data
Format private data.
Definition: avformat.h:988
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:151
unsigned int current_sample
Definition: segafilm.c:61
unsigned int version
Definition: segafilm.c:64
int keyframe
Definition: segafilm.c:46
unsigned int nb_streams
A list of all streams in the file.
Definition: avformat.h:1015
int bit_rate
the average bitrate
Definition: avcodec.h:1204
full parsing and repack
Definition: avformat.h:599
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:54
ret
Definition: avfilter.c:961
int width
picture width / height.
Definition: avcodec.h:1314
AVStream ** streams
Definition: avformat.h:1016
void * av_malloc(size_t size) av_malloc_attrib 1(1)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:73
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 avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:199
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:75
int64_t sample_offset
Definition: segafilm.c:43
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:592
Stream structure.
Definition: avformat.h:667
enum AVMediaType codec_type
Definition: avcodec.h:1154
enum AVCodecID codec_id
Definition: avcodec.h:1157
int sample_rate
samples per second
Definition: avcodec.h:1873
unsigned int codec_tag
fourcc (LSB first, so &quot;ABCD&quot; -&gt; (&#39;D&#39;&lt;&lt;24) + (&#39;C&#39;&lt;&lt;16) + (&#39;B&#39;&lt;&lt;8) + &#39;A&#39;).
Definition: avcodec.h:1172
AVIOContext * pb
I/O context.
Definition: avformat.h:1001
static int read_packet(AVFormatContext *ctx, AVPacket *pkt)
Definition: libcdio.c:114
uint8_t * data
Definition: avcodec.h:1063
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:334
AVInputFormat ff_segafilm_demuxer
Definition: segafilm.c:282
#define AVERROR_EOF
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:342
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:480
int audio_stream_index
Definition: segafilm.c:51
Main libavformat public API header.
#define AV_RB32(x)
Definition: intreadwrite.h:258
#define AVERROR_INVALIDDATA
int channels
number of audio channels
Definition: avcodec.h:1874
static int film_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: segafilm.c:236
#define AVERROR(e)
enum AVCodecID audio_type
Definition: segafilm.c:53
static AVPacket pkt
Definition: demuxing.c:52
int stream_index
Definition: avcodec.h:1065
This structure stores compressed data.
Definition: avcodec.h:1040
int64_t pts
Presentation timestamp in AVStream-&gt;time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1056