libavformat/segafilm.c

   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 libavformat/segafilm.c
  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
  33 #define FILM_TAG MKBETAG('F', 'I', 'L', 'M')
  34 #define FDSC_TAG MKBETAG('F', 'D', 'S', 'C')
  35 #define STAB_TAG MKBETAG('S', 'T', 'A', 'B')
  36 #define CVID_TAG MKBETAG('c', 'v', 'i', 'd')
  37
  38 typedef struct {
  39   int stream;
  40   int64_t sample_offset;
  41   unsigned int sample_size;
  42   int64_t pts;
  43   int keyframe;
  44 } film_sample;
  45
  46 typedef struct FilmDemuxContext {
  47     int video_stream_index;
  48     int audio_stream_index;
  49
  50     enum CodecID audio_type;
  51     unsigned int audio_samplerate;
  52     unsigned int audio_bits;
  53     unsigned int audio_channels;
  54
  55     enum CodecID video_type;
  56     unsigned int sample_count;
  57     film_sample *sample_table;
  58     unsigned int current_sample;
  59
  60     unsigned int base_clock;
  61     unsigned int version;
  62
  63     /* buffer used for interleaving stereo PCM data */
  64     unsigned char *stereo_buffer;
  65     int stereo_buffer_size;
  66 } FilmDemuxContext;
  67
  68 static int film_probe(AVProbeData *p)
  69 {
  70     if (AV_RB32(&p->buf[0]) != FILM_TAG)
  71         return 0;
  72
  73     return AVPROBE_SCORE_MAX;
  74 }
  75
  76 static int film_read_header(AVFormatContext *s,
  77                             AVFormatParameters *ap)
  78 {
  79     FilmDemuxContext *film = s->priv_data;
  80     ByteIOContext *pb = s->pb;
  81     AVStream *st;
  82     unsigned char scratch[256];
  83     int i;
  84     unsigned int data_offset;
  85     unsigned int audio_frame_counter;
  86
  87     film->sample_table = NULL;
  88     film->stereo_buffer = NULL;
  89     film->stereo_buffer_size = 0;
  90
  91     /* load the main FILM header */
  92     if (get_buffer(pb, scratch, 16) != 16)
  93         return AVERROR(EIO);
  94     data_offset = AV_RB32(&scratch[4]);
  95     film->version = AV_RB32(&scratch[8]);
  96
  97     /* load the FDSC chunk */
  98     if (film->version == 0) {
  99         /* special case for Lemmings .film files; 20-byte header */
 100         if (get_buffer(pb, scratch, 20) != 20)
 101             return AVERROR(EIO);
 102         /* make some assumptions about the audio parameters */
 103         film->audio_type = CODEC_ID_PCM_S8;
 104         film->audio_samplerate = 22050;
 105         film->audio_channels = 1;
 106         film->audio_bits = 8;
 107     } else {
 108         /* normal Saturn .cpk files; 32-byte header */
 109         if (get_buffer(pb, scratch, 32) != 32)
 110             return AVERROR(EIO);
 111         film->audio_samplerate = AV_RB16(&scratch[24]);
 112         film->audio_channels = scratch[21];
 113         film->audio_bits = scratch[22];
 114         if (film->audio_bits == 8)
 115             film->audio_type = CODEC_ID_PCM_S8;
 116         else if (film->audio_bits == 16)
 117             film->audio_type = CODEC_ID_PCM_S16BE;
 118         else
 119             film->audio_type = CODEC_ID_NONE;
 120     }
 121
 122     if (AV_RB32(&scratch[0]) != FDSC_TAG)
 123         return AVERROR_INVALIDDATA;
 124
 125     if (AV_RB32(&scratch[8]) == CVID_TAG) {
 126         film->video_type = CODEC_ID_CINEPAK;
 127     } else
 128         film->video_type = CODEC_ID_NONE;
 129
 130     /* initialize the decoder streams */
 131     if (film->video_type) {
 132         st = av_new_stream(s, 0);
 133         if (!st)
 134             return AVERROR(ENOMEM);
 135         film->video_stream_index = st->index;
 136         st->codec->codec_type = CODEC_TYPE_VIDEO;
 137         st->codec->codec_id = film->video_type;
 138         st->codec->codec_tag = 0;  /* no fourcc */
 139         st->codec->width = AV_RB32(&scratch[16]);
 140         st->codec->height = AV_RB32(&scratch[12]);
 141     }
 142
 143     if (film->audio_type) {
 144         st = av_new_stream(s, 0);
 145         if (!st)
 146             return AVERROR(ENOMEM);
 147         film->audio_stream_index = st->index;
 148         st->codec->codec_type = CODEC_TYPE_AUDIO;
 149         st->codec->codec_id = film->audio_type;
 150         st->codec->codec_tag = 1;
 151         st->codec->channels = film->audio_channels;
 152         st->codec->bits_per_coded_sample = film->audio_bits;
 153         st->codec->sample_rate = film->audio_samplerate;
 154         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
 155             st->codec->bits_per_coded_sample;
 156         st->codec->block_align = st->codec->channels *
 157             st->codec->bits_per_coded_sample / 8;
 158     }
 159
 160     /* load the sample table */
 161     if (get_buffer(pb, scratch, 16) != 16)
 162         return AVERROR(EIO);
 163     if (AV_RB32(&scratch[0]) != STAB_TAG)
 164         return AVERROR_INVALIDDATA;
 165     film->base_clock = AV_RB32(&scratch[8]);
 166     film->sample_count = AV_RB32(&scratch[12]);
 167     if(film->sample_count >= UINT_MAX / sizeof(film_sample))
 168         return -1;
 169     film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
 170
 171     for(i=0; i<s->nb_streams; i++)
 172         av_set_pts_info(s->streams[i], 33, 1, film->base_clock);
 173
 174     audio_frame_counter = 0;
 175     for (i = 0; i < film->sample_count; i++) {
 176         /* load the next sample record and transfer it to an internal struct */
 177         if (get_buffer(pb, scratch, 16) != 16) {
 178             av_free(film->sample_table);
 179             return AVERROR(EIO);
 180         }
 181         film->sample_table[i].sample_offset =
 182             data_offset + AV_RB32(&scratch[0]);
 183         film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
 184         if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
 185             film->sample_table[i].stream = film->audio_stream_index;
 186             film->sample_table[i].pts = audio_frame_counter;
 187             film->sample_table[i].pts *= film->base_clock;
 188             film->sample_table[i].pts /= film->audio_samplerate;
 189
 190             audio_frame_counter += (film->sample_table[i].sample_size /
 191                 (film->audio_channels * film->audio_bits / 8));
 192         } else {
 193             film->sample_table[i].stream = film->video_stream_index;
 194             film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
 195             film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
 196         }
 197     }
 198
 199     film->current_sample = 0;
 200
 201     return 0;
 202 }
 203
 204 static int film_read_packet(AVFormatContext *s,
 205                             AVPacket *pkt)
 206 {
 207     FilmDemuxContext *film = s->priv_data;
 208     ByteIOContext *pb = s->pb;
 209     film_sample *sample;
 210     int ret = 0;
 211     int i;
 212     int left, right;
 213
 214     if (film->current_sample >= film->sample_count)
 215         return AVERROR(EIO);
 216
 217     sample = &film->sample_table[film->current_sample];
 218
 219     /* position the stream (will probably be there anyway) */
 220     url_fseek(pb, sample->sample_offset, SEEK_SET);
 221
 222     /* do a special song and dance when loading FILM Cinepak chunks */
 223     if ((sample->stream == film->video_stream_index) &&
 224         (film->video_type == CODEC_ID_CINEPAK)) {
 225         pkt->pos= url_ftell(pb);
 226         if (av_new_packet(pkt, sample->sample_size))
 227             return AVERROR(ENOMEM);
 228         get_buffer(pb, pkt->data, sample->sample_size);
 229     } else if ((sample->stream == film->audio_stream_index) &&
 230         (film->audio_channels == 2)) {
 231         /* stereo PCM needs to be interleaved */
 232
 233         if (av_new_packet(pkt, sample->sample_size))
 234             return AVERROR(ENOMEM);
 235
 236         /* make sure the interleave buffer is large enough */
 237         if (sample->sample_size > film->stereo_buffer_size) {
 238             av_free(film->stereo_buffer);
 239             film->stereo_buffer_size = sample->sample_size;
 240             film->stereo_buffer = av_malloc(film->stereo_buffer_size);
 241         }
 242
 243         pkt->pos= url_ftell(pb);
 244         ret = get_buffer(pb, film->stereo_buffer, sample->sample_size);
 245         if (ret != sample->sample_size)
 246             ret = AVERROR(EIO);
 247
 248         left = 0;
 249         right = sample->sample_size / 2;
 250         for (i = 0; i < sample->sample_size; ) {
 251             if (film->audio_bits == 8) {
 252                 pkt->data[i++] = film->stereo_buffer[left++];
 253                 pkt->data[i++] = film->stereo_buffer[right++];
 254             } else {
 255                 pkt->data[i++] = film->stereo_buffer[left++];
 256                 pkt->data[i++] = film->stereo_buffer[left++];
 257                 pkt->data[i++] = film->stereo_buffer[right++];
 258                 pkt->data[i++] = film->stereo_buffer[right++];
 259             }
 260         }
 261     } else {
 262         ret= av_get_packet(pb, pkt, sample->sample_size);
 263         if (ret != sample->sample_size)
 264             ret = AVERROR(EIO);
 265     }
 266
 267     pkt->stream_index = sample->stream;
 268     pkt->pts = sample->pts;
 269
 270     film->current_sample++;
 271
 272     return ret;
 273 }
 274
 275 static int film_read_close(AVFormatContext *s)
 276 {
 277     FilmDemuxContext *film = s->priv_data;
 278
 279     av_free(film->sample_table);
 280     av_free(film->stereo_buffer);
 281
 282     return 0;
 283 }
 284
 285 AVInputFormat segafilm_demuxer = {
 286     "film_cpk",
 287     NULL_IF_CONFIG_SMALL("Sega FILM/CPK format"),
 288     sizeof(FilmDemuxContext),
 289     film_probe,
 290     film_read_header,
 291     film_read_packet,
 292     film_read_close,
 293 };