git.sesse.net Git - ffmpeg/blob - libavformat/wc3movie.c

   1 /*
   2  * Wing Commander III Movie (.mve) File 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  * Wing Commander III Movie file demuxer
  25  * by Mike Melanson (melanson@pcisys.net)
  26  * for more information on the WC3 .mve file format, visit:
  27  *   http://www.pcisys.net/~melanson/codecs/
  28  */
  29
  30 #include "libavutil/intreadwrite.h"
  31 #include "libavutil/dict.h"
  32 #include "avformat.h"
  33 #include "internal.h"
  34
  35 #define FORM_TAG MKTAG('F', 'O', 'R', 'M')
  36 #define MOVE_TAG MKTAG('M', 'O', 'V', 'E')
  37 #define  PC__TAG MKTAG('_', 'P', 'C', '_')
  38 #define SOND_TAG MKTAG('S', 'O', 'N', 'D')
  39 #define BNAM_TAG MKTAG('B', 'N', 'A', 'M')
  40 #define SIZE_TAG MKTAG('S', 'I', 'Z', 'E')
  41 #define PALT_TAG MKTAG('P', 'A', 'L', 'T')
  42 #define INDX_TAG MKTAG('I', 'N', 'D', 'X')
  43 #define BRCH_TAG MKTAG('B', 'R', 'C', 'H')
  44 #define SHOT_TAG MKTAG('S', 'H', 'O', 'T')
  45 #define VGA__TAG MKTAG('V', 'G', 'A', ' ')
  46 #define TEXT_TAG MKTAG('T', 'E', 'X', 'T')
  47 #define AUDI_TAG MKTAG('A', 'U', 'D', 'I')
  48
  49 /* video resolution unless otherwise specified */
  50 #define WC3_DEFAULT_WIDTH 320
  51 #define WC3_DEFAULT_HEIGHT 165
  52
  53 /* always use the same PCM audio parameters */
  54 #define WC3_SAMPLE_RATE 22050
  55 #define WC3_AUDIO_CHANNELS 1
  56 #define WC3_AUDIO_BITS 16
  57
  58 /* nice, constant framerate */
  59 #define WC3_FRAME_FPS 15
  60
  61 #define PALETTE_SIZE (256 * 3)
  62
  63 typedef struct Wc3DemuxContext {
  64     int width;
  65     int height;
  66     int64_t pts;
  67     int video_stream_index;
  68     int audio_stream_index;
  69
  70     AVPacket vpkt;
  71
  72 } Wc3DemuxContext;
  73
  74 static int wc3_probe(AVProbeData *p)
  75 {
  76     if (p->buf_size < 12)
  77         return 0;
  78
  79     if ((AV_RL32(&p->buf[0]) != FORM_TAG) ||
  80         (AV_RL32(&p->buf[8]) != MOVE_TAG))
  81         return 0;
  82
  83     return AVPROBE_SCORE_MAX;
  84 }
  85
  86 static int wc3_read_header(AVFormatContext *s)
  87 {
  88     Wc3DemuxContext *wc3 = s->priv_data;
  89     AVIOContext *pb = s->pb;
  90     unsigned int fourcc_tag;
  91     unsigned int size;
  92     AVStream *st;
  93     int ret = 0;
  94     char *buffer;
  95
  96     /* default context members */
  97     wc3->width = WC3_DEFAULT_WIDTH;
  98     wc3->height = WC3_DEFAULT_HEIGHT;
  99     wc3->pts = 0;
 100     wc3->video_stream_index = wc3->audio_stream_index = 0;
 101     av_init_packet(&wc3->vpkt);
 102     wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
 103
 104     /* skip the first 3 32-bit numbers */
 105     avio_skip(pb, 12);
 106
 107     /* traverse through the chunks and load the header information before
 108      * the first BRCH tag */
 109     fourcc_tag = avio_rl32(pb);
 110     size = (avio_rb32(pb) + 1) & (~1);
 111
 112     do {
 113         switch (fourcc_tag) {
 114
 115         case SOND_TAG:
 116         case INDX_TAG:
 117             /* SOND unknown, INDX unnecessary; ignore both */
 118             avio_skip(pb, size);
 119             break;
 120
 121         case PC__TAG:
 122             /* number of palettes, unneeded */
 123             avio_skip(pb, 12);
 124             break;
 125
 126         case BNAM_TAG:
 127             /* load up the name */
 128             buffer = av_malloc(size+1);
 129             if (!buffer)
 130                 return AVERROR(ENOMEM);
 131             if ((ret = avio_read(pb, buffer, size)) != size)
 132                 return AVERROR(EIO);
 133             buffer[size] = 0;
 134             av_dict_set(&s->metadata, "title", buffer,
 135                                    AV_DICT_DONT_STRDUP_VAL);
 136             break;
 137
 138         case SIZE_TAG:
 139             /* video resolution override */
 140             wc3->width  = avio_rl32(pb);
 141             wc3->height = avio_rl32(pb);
 142             break;
 143
 144         case PALT_TAG:
 145             /* one of several palettes */
 146             avio_seek(pb, -8, SEEK_CUR);
 147             av_append_packet(pb, &wc3->vpkt, 8 + PALETTE_SIZE);
 148             break;
 149
 150         default:
 151             av_log(s, AV_LOG_ERROR, "  unrecognized WC3 chunk: %c%c%c%c (0x%02X%02X%02X%02X)\n",
 152                 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24),
 153                 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24));
 154             return AVERROR_INVALIDDATA;
 155         }
 156
 157         fourcc_tag = avio_rl32(pb);
 158         /* chunk sizes are 16-bit aligned */
 159         size = (avio_rb32(pb) + 1) & (~1);
 160         if (url_feof(pb))
 161             return AVERROR(EIO);
 162
 163     } while (fourcc_tag != BRCH_TAG);
 164
 165     /* initialize the decoder streams */
 166     st = avformat_new_stream(s, NULL);
 167     if (!st)
 168         return AVERROR(ENOMEM);
 169     avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
 170     wc3->video_stream_index = st->index;
 171     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
 172     st->codec->codec_id = CODEC_ID_XAN_WC3;
 173     st->codec->codec_tag = 0;  /* no fourcc */
 174     st->codec->width = wc3->width;
 175     st->codec->height = wc3->height;
 176
 177     st = avformat_new_stream(s, NULL);
 178     if (!st)
 179         return AVERROR(ENOMEM);
 180     avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
 181     wc3->audio_stream_index = st->index;
 182     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
 183     st->codec->codec_id = CODEC_ID_PCM_S16LE;
 184     st->codec->codec_tag = 1;
 185     st->codec->channels = WC3_AUDIO_CHANNELS;
 186     st->codec->bits_per_coded_sample = WC3_AUDIO_BITS;
 187     st->codec->sample_rate = WC3_SAMPLE_RATE;
 188     st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
 189         st->codec->bits_per_coded_sample;
 190     st->codec->block_align = WC3_AUDIO_BITS * WC3_AUDIO_CHANNELS;
 191
 192     return 0;
 193 }
 194
 195 static int wc3_read_packet(AVFormatContext *s,
 196                            AVPacket *pkt)
 197 {
 198     Wc3DemuxContext *wc3 = s->priv_data;
 199     AVIOContext *pb = s->pb;
 200     unsigned int fourcc_tag;
 201     unsigned int size;
 202     int packet_read = 0;
 203     int ret = 0;
 204     unsigned char text[1024];
 205
 206     while (!packet_read) {
 207
 208         fourcc_tag = avio_rl32(pb);
 209         /* chunk sizes are 16-bit aligned */
 210         size = (avio_rb32(pb) + 1) & (~1);
 211         if (url_feof(pb))
 212             return AVERROR(EIO);
 213
 214         switch (fourcc_tag) {
 215
 216         case BRCH_TAG:
 217             /* no-op */
 218             break;
 219
 220         case SHOT_TAG:
 221             /* load up new palette */
 222             avio_seek(pb, -8, SEEK_CUR);
 223             av_append_packet(pb, &wc3->vpkt, 8 + 4);
 224             break;
 225
 226         case VGA__TAG:
 227             /* send out video chunk */
 228             avio_seek(pb, -8, SEEK_CUR);
 229             ret= av_append_packet(pb, &wc3->vpkt, 8 + size);
 230             // ignore error if we have some data
 231             if (wc3->vpkt.size > 0)
 232                 ret = 0;
 233             *pkt = wc3->vpkt;
 234             wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
 235             pkt->stream_index = wc3->video_stream_index;
 236             pkt->pts = wc3->pts;
 237             packet_read = 1;
 238             break;
 239
 240         case TEXT_TAG:
 241             /* subtitle chunk */
 242 #if 0
 243             avio_skip(pb, size);
 244 #else
 245             if ((unsigned)size > sizeof(text) || (ret = avio_read(pb, text, size)) != size)
 246                 ret = AVERROR(EIO);
 247             else {
 248                 int i = 0;
 249                 av_log (s, AV_LOG_DEBUG, "Subtitle time!\n");
 250                 av_log (s, AV_LOG_DEBUG, "  inglish: %s\n", &text[i + 1]);
 251                 i += text[i] + 1;
 252                 av_log (s, AV_LOG_DEBUG, "  doytsch: %s\n", &text[i + 1]);
 253                 i += text[i] + 1;
 254                 av_log (s, AV_LOG_DEBUG, "  fronsay: %s\n", &text[i + 1]);
 255             }
 256 #endif
 257             break;
 258
 259         case AUDI_TAG:
 260             /* send out audio chunk */
 261             ret= av_get_packet(pb, pkt, size);
 262             pkt->stream_index = wc3->audio_stream_index;
 263             pkt->pts = wc3->pts;
 264
 265             /* time to advance pts */
 266             wc3->pts++;
 267
 268             packet_read = 1;
 269             break;
 270
 271         default:
 272             av_log (s, AV_LOG_ERROR, "  unrecognized WC3 chunk: %c%c%c%c (0x%02X%02X%02X%02X)\n",
 273                 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24),
 274                 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24));
 275             ret = AVERROR_INVALIDDATA;
 276             packet_read = 1;
 277             break;
 278         }
 279     }
 280
 281     return ret;
 282 }
 283
 284 static int wc3_read_close(AVFormatContext *s)
 285 {
 286     Wc3DemuxContext *wc3 = s->priv_data;
 287
 288     if (wc3->vpkt.size > 0)
 289         av_free_packet(&wc3->vpkt);
 290
 291     return 0;
 292 }
 293
 294 AVInputFormat ff_wc3_demuxer = {
 295     .name           = "wc3movie",
 296     .long_name      = NULL_IF_CONFIG_SMALL("Wing Commander III movie format"),
 297     .priv_data_size = sizeof(Wc3DemuxContext),
 298     .read_probe     = wc3_probe,
 299     .read_header    = wc3_read_header,
 300     .read_packet    = wc3_read_packet,
 301     .read_close     = wc3_read_close,
 302 };