libavformat/segafilm.c
Go to the documentation of this file.
00001 /*
00002  * Sega FILM Format (CPK) Demuxer
00003  * Copyright (c) 2003 The ffmpeg Project
00004  *
00005  * This file is part of Libav.
00006  *
00007  * Libav is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU Lesser General Public
00009  * License as published by the Free Software Foundation; either
00010  * version 2.1 of the License, or (at your option) any later version.
00011  *
00012  * Libav is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015  * Lesser General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU Lesser General Public
00018  * License along with Libav; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
00020  */
00021 
00030 #include "libavutil/intreadwrite.h"
00031 #include "avformat.h"
00032 #include "internal.h"
00033 
00034 #define FILM_TAG MKBETAG('F', 'I', 'L', 'M')
00035 #define FDSC_TAG MKBETAG('F', 'D', 'S', 'C')
00036 #define STAB_TAG MKBETAG('S', 'T', 'A', 'B')
00037 #define CVID_TAG MKBETAG('c', 'v', 'i', 'd')
00038 #define RAW_TAG  MKBETAG('r', 'a', 'w', ' ')
00039 
00040 typedef struct {
00041   int stream;
00042   int64_t sample_offset;
00043   unsigned int sample_size;
00044   int64_t pts;
00045   int keyframe;
00046 } film_sample;
00047 
00048 typedef struct FilmDemuxContext {
00049     int video_stream_index;
00050     int audio_stream_index;
00051 
00052     enum CodecID audio_type;
00053     unsigned int audio_samplerate;
00054     unsigned int audio_bits;
00055     unsigned int audio_channels;
00056 
00057     enum CodecID video_type;
00058     unsigned int sample_count;
00059     film_sample *sample_table;
00060     unsigned int current_sample;
00061 
00062     unsigned int base_clock;
00063     unsigned int version;
00064 
00065     /* buffer used for interleaving stereo PCM data */
00066     unsigned char *stereo_buffer;
00067     int stereo_buffer_size;
00068 } FilmDemuxContext;
00069 
00070 static int film_probe(AVProbeData *p)
00071 {
00072     if (AV_RB32(&p->buf[0]) != FILM_TAG)
00073         return 0;
00074 
00075     return AVPROBE_SCORE_MAX;
00076 }
00077 
00078 static int film_read_close(AVFormatContext *s)
00079 {
00080     FilmDemuxContext *film = s->priv_data;
00081 
00082     av_freep(&film->sample_table);
00083     av_freep(&film->stereo_buffer);
00084 
00085     return 0;
00086 }
00087 
00088 static int film_read_header(AVFormatContext *s,
00089                             AVFormatParameters *ap)
00090 {
00091     FilmDemuxContext *film = s->priv_data;
00092     AVIOContext *pb = s->pb;
00093     AVStream *st;
00094     unsigned char scratch[256];
00095     int i, ret;
00096     unsigned int data_offset;
00097     unsigned int audio_frame_counter;
00098 
00099     film->sample_table = NULL;
00100     film->stereo_buffer = NULL;
00101     film->stereo_buffer_size = 0;
00102 
00103     /* load the main FILM header */
00104     if (avio_read(pb, scratch, 16) != 16)
00105         return AVERROR(EIO);
00106     data_offset = AV_RB32(&scratch[4]);
00107     film->version = AV_RB32(&scratch[8]);
00108 
00109     /* load the FDSC chunk */
00110     if (film->version == 0) {
00111         /* special case for Lemmings .film files; 20-byte header */
00112         if (avio_read(pb, scratch, 20) != 20)
00113             return AVERROR(EIO);
00114         /* make some assumptions about the audio parameters */
00115         film->audio_type = CODEC_ID_PCM_S8;
00116         film->audio_samplerate = 22050;
00117         film->audio_channels = 1;
00118         film->audio_bits = 8;
00119     } else {
00120         /* normal Saturn .cpk files; 32-byte header */
00121         if (avio_read(pb, scratch, 32) != 32)
00122             return AVERROR(EIO);
00123         film->audio_samplerate = AV_RB16(&scratch[24]);
00124         film->audio_channels = scratch[21];
00125         if (!film->audio_channels || film->audio_channels > 2) {
00126             av_log(s, AV_LOG_ERROR,
00127                    "Invalid number of channels: %d\n", film->audio_channels);
00128             return AVERROR_INVALIDDATA;
00129         }
00130         film->audio_bits = scratch[22];
00131         if (scratch[23] == 2)
00132             film->audio_type = CODEC_ID_ADPCM_ADX;
00133         else if (film->audio_channels > 0) {
00134             if (film->audio_bits == 8)
00135                 film->audio_type = CODEC_ID_PCM_S8;
00136             else if (film->audio_bits == 16)
00137                 film->audio_type = CODEC_ID_PCM_S16BE;
00138             else
00139                 film->audio_type = CODEC_ID_NONE;
00140         } else
00141             film->audio_type = CODEC_ID_NONE;
00142     }
00143 
00144     if (AV_RB32(&scratch[0]) != FDSC_TAG)
00145         return AVERROR_INVALIDDATA;
00146 
00147     if (AV_RB32(&scratch[8]) == CVID_TAG) {
00148         film->video_type = CODEC_ID_CINEPAK;
00149     } else if (AV_RB32(&scratch[8]) == RAW_TAG) {
00150         film->video_type = CODEC_ID_RAWVIDEO;
00151     } else {
00152         film->video_type = CODEC_ID_NONE;
00153     }
00154 
00155     /* initialize the decoder streams */
00156     if (film->video_type) {
00157         st = avformat_new_stream(s, NULL);
00158         if (!st)
00159             return AVERROR(ENOMEM);
00160         film->video_stream_index = st->index;
00161         st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
00162         st->codec->codec_id = film->video_type;
00163         st->codec->codec_tag = 0;  /* no fourcc */
00164         st->codec->width = AV_RB32(&scratch[16]);
00165         st->codec->height = AV_RB32(&scratch[12]);
00166 
00167         if (film->video_type == CODEC_ID_RAWVIDEO) {
00168             if (scratch[20] == 24) {
00169                 st->codec->pix_fmt = PIX_FMT_RGB24;
00170             } else {
00171                 av_log(s, AV_LOG_ERROR, "raw video is using unhandled %dbpp\n", scratch[20]);
00172                 return -1;
00173             }
00174         }
00175     }
00176 
00177     if (film->audio_type) {
00178         st = avformat_new_stream(s, NULL);
00179         if (!st)
00180             return AVERROR(ENOMEM);
00181         film->audio_stream_index = st->index;
00182         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
00183         st->codec->codec_id = film->audio_type;
00184         st->codec->codec_tag = 1;
00185         st->codec->channels = film->audio_channels;
00186         st->codec->sample_rate = film->audio_samplerate;
00187 
00188         if (film->audio_type == CODEC_ID_ADPCM_ADX) {
00189             st->codec->bits_per_coded_sample = 18 * 8 / 32;
00190             st->codec->block_align = st->codec->channels * 18;
00191             st->need_parsing = AVSTREAM_PARSE_FULL;
00192         } else {
00193             st->codec->bits_per_coded_sample = film->audio_bits;
00194             st->codec->block_align = st->codec->channels *
00195                 st->codec->bits_per_coded_sample / 8;
00196         }
00197 
00198         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
00199             st->codec->bits_per_coded_sample;
00200     }
00201 
00202     /* load the sample table */
00203     if (avio_read(pb, scratch, 16) != 16)
00204         return AVERROR(EIO);
00205     if (AV_RB32(&scratch[0]) != STAB_TAG)
00206         return AVERROR_INVALIDDATA;
00207     film->base_clock = AV_RB32(&scratch[8]);
00208     film->sample_count = AV_RB32(&scratch[12]);
00209     if(film->sample_count >= UINT_MAX / sizeof(film_sample))
00210         return -1;
00211     film->sample_table = av_malloc(film->sample_count * sizeof(film_sample));
00212     if (!film->sample_table)
00213         return AVERROR(ENOMEM);
00214 
00215     for(i=0; i<s->nb_streams; i++)
00216         avpriv_set_pts_info(s->streams[i], 33, 1, film->base_clock);
00217 
00218     audio_frame_counter = 0;
00219     for (i = 0; i < film->sample_count; i++) {
00220         /* load the next sample record and transfer it to an internal struct */
00221         if (avio_read(pb, scratch, 16) != 16) {
00222             ret = AVERROR(EIO);
00223             goto fail;
00224         }
00225         film->sample_table[i].sample_offset =
00226             data_offset + AV_RB32(&scratch[0]);
00227         film->sample_table[i].sample_size = AV_RB32(&scratch[4]);
00228         if (film->sample_table[i].sample_size > INT_MAX / 4) {
00229             ret = AVERROR_INVALIDDATA;
00230             goto fail;
00231         }
00232         if (AV_RB32(&scratch[8]) == 0xFFFFFFFF) {
00233             film->sample_table[i].stream = film->audio_stream_index;
00234             film->sample_table[i].pts = audio_frame_counter;
00235             film->sample_table[i].pts *= film->base_clock;
00236             film->sample_table[i].pts /= film->audio_samplerate;
00237 
00238             if (film->audio_type == CODEC_ID_ADPCM_ADX)
00239                 audio_frame_counter += (film->sample_table[i].sample_size * 32 /
00240                     (18 * film->audio_channels));
00241             else if (film->audio_type != CODEC_ID_NONE)
00242                 audio_frame_counter += (film->sample_table[i].sample_size /
00243                     (film->audio_channels * film->audio_bits / 8));
00244         } else {
00245             film->sample_table[i].stream = film->video_stream_index;
00246             film->sample_table[i].pts = AV_RB32(&scratch[8]) & 0x7FFFFFFF;
00247             film->sample_table[i].keyframe = (scratch[8] & 0x80) ? 0 : 1;
00248         }
00249     }
00250 
00251     film->current_sample = 0;
00252 
00253     return 0;
00254 fail:
00255     film_read_close(s);
00256     return ret;
00257 }
00258 
00259 static int film_read_packet(AVFormatContext *s,
00260                             AVPacket *pkt)
00261 {
00262     FilmDemuxContext *film = s->priv_data;
00263     AVIOContext *pb = s->pb;
00264     film_sample *sample;
00265     int ret = 0;
00266     int i;
00267     int left, right;
00268 
00269     if (film->current_sample >= film->sample_count)
00270         return AVERROR(EIO);
00271 
00272     sample = &film->sample_table[film->current_sample];
00273 
00274     /* position the stream (will probably be there anyway) */
00275     avio_seek(pb, sample->sample_offset, SEEK_SET);
00276 
00277     /* do a special song and dance when loading FILM Cinepak chunks */
00278     if ((sample->stream == film->video_stream_index) &&
00279         (film->video_type == CODEC_ID_CINEPAK)) {
00280         pkt->pos= avio_tell(pb);
00281         if (av_new_packet(pkt, sample->sample_size))
00282             return AVERROR(ENOMEM);
00283         avio_read(pb, pkt->data, sample->sample_size);
00284     } else if ((sample->stream == film->audio_stream_index) &&
00285         (film->audio_channels == 2) &&
00286         (film->audio_type != CODEC_ID_ADPCM_ADX)) {
00287         /* stereo PCM needs to be interleaved */
00288 
00289         if (av_new_packet(pkt, sample->sample_size))
00290             return AVERROR(ENOMEM);
00291 
00292         /* make sure the interleave buffer is large enough */
00293         if (sample->sample_size > film->stereo_buffer_size) {
00294             av_free(film->stereo_buffer);
00295             film->stereo_buffer_size = sample->sample_size;
00296             film->stereo_buffer = av_malloc(film->stereo_buffer_size);
00297             if (!film->stereo_buffer) {
00298                 film->stereo_buffer_size = 0;
00299                 return AVERROR(ENOMEM);
00300             }
00301         }
00302 
00303         pkt->pos= avio_tell(pb);
00304         ret = avio_read(pb, film->stereo_buffer, sample->sample_size);
00305         if (ret != sample->sample_size)
00306             ret = AVERROR(EIO);
00307 
00308         left = 0;
00309         right = sample->sample_size / 2;
00310         for (i = 0; i < sample->sample_size; ) {
00311             if (film->audio_bits == 8) {
00312                 pkt->data[i++] = film->stereo_buffer[left++];
00313                 pkt->data[i++] = film->stereo_buffer[right++];
00314             } else {
00315                 pkt->data[i++] = film->stereo_buffer[left++];
00316                 pkt->data[i++] = film->stereo_buffer[left++];
00317                 pkt->data[i++] = film->stereo_buffer[right++];
00318                 pkt->data[i++] = film->stereo_buffer[right++];
00319             }
00320         }
00321     } else {
00322         ret= av_get_packet(pb, pkt, sample->sample_size);
00323         if (ret != sample->sample_size)
00324             ret = AVERROR(EIO);
00325     }
00326 
00327     pkt->stream_index = sample->stream;
00328     pkt->pts = sample->pts;
00329 
00330     film->current_sample++;
00331 
00332     return ret;
00333 }
00334 
00335 AVInputFormat ff_segafilm_demuxer = {
00336     .name           = "film_cpk",
00337     .long_name      = NULL_IF_CONFIG_SMALL("Sega FILM/CPK format"),
00338     .priv_data_size = sizeof(FilmDemuxContext),
00339     .read_probe     = film_probe,
00340     .read_header    = film_read_header,
00341     .read_packet    = film_read_packet,
00342     .read_close     = film_read_close,
00343 };