yading@11: /*
yading@11:  * Wing Commander III Movie (.mve) File Demuxer
yading@11:  * Copyright (c) 2003 The ffmpeg Project
yading@11:  *
yading@11:  * This file is part of FFmpeg.
yading@11:  *
yading@11:  * FFmpeg is free software; you can redistribute it and/or
yading@11:  * modify it under the terms of the GNU Lesser General Public
yading@11:  * License as published by the Free Software Foundation; either
yading@11:  * version 2.1 of the License, or (at your option) any later version.
yading@11:  *
yading@11:  * FFmpeg is distributed in the hope that it will be useful,
yading@11:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@11:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@11:  * Lesser General Public License for more details.
yading@11:  *
yading@11:  * You should have received a copy of the GNU Lesser General Public
yading@11:  * License along with FFmpeg; if not, write to the Free Software
yading@11:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@11:  */
yading@11: 
yading@11: /**
yading@11:  * @file
yading@11:  * Wing Commander III Movie file demuxer
yading@11:  * by Mike Melanson (melanson@pcisys.net)
yading@11:  * for more information on the WC3 .mve file format, visit:
yading@11:  *   http://www.pcisys.net/~melanson/codecs/
yading@11:  */
yading@11: 
yading@11: #include "libavutil/channel_layout.h"
yading@11: #include "libavutil/intreadwrite.h"
yading@11: #include "libavutil/dict.h"
yading@11: #include "avformat.h"
yading@11: #include "internal.h"
yading@11: 
yading@11: #define FORM_TAG MKTAG('F', 'O', 'R', 'M')
yading@11: #define MOVE_TAG MKTAG('M', 'O', 'V', 'E')
yading@11: #define  PC__TAG MKTAG('_', 'P', 'C', '_')
yading@11: #define SOND_TAG MKTAG('S', 'O', 'N', 'D')
yading@11: #define BNAM_TAG MKTAG('B', 'N', 'A', 'M')
yading@11: #define SIZE_TAG MKTAG('S', 'I', 'Z', 'E')
yading@11: #define PALT_TAG MKTAG('P', 'A', 'L', 'T')
yading@11: #define INDX_TAG MKTAG('I', 'N', 'D', 'X')
yading@11: #define BRCH_TAG MKTAG('B', 'R', 'C', 'H')
yading@11: #define SHOT_TAG MKTAG('S', 'H', 'O', 'T')
yading@11: #define VGA__TAG MKTAG('V', 'G', 'A', ' ')
yading@11: #define TEXT_TAG MKTAG('T', 'E', 'X', 'T')
yading@11: #define AUDI_TAG MKTAG('A', 'U', 'D', 'I')
yading@11: 
yading@11: /* video resolution unless otherwise specified */
yading@11: #define WC3_DEFAULT_WIDTH 320
yading@11: #define WC3_DEFAULT_HEIGHT 165
yading@11: 
yading@11: /* always use the same PCM audio parameters */
yading@11: #define WC3_SAMPLE_RATE 22050
yading@11: #define WC3_AUDIO_CHANNELS 1
yading@11: #define WC3_AUDIO_BITS 16
yading@11: 
yading@11: /* nice, constant framerate */
yading@11: #define WC3_FRAME_FPS 15
yading@11: 
yading@11: #define PALETTE_SIZE (256 * 3)
yading@11: 
yading@11: typedef struct Wc3DemuxContext {
yading@11:     int width;
yading@11:     int height;
yading@11:     int64_t pts;
yading@11:     int video_stream_index;
yading@11:     int audio_stream_index;
yading@11: 
yading@11:     AVPacket vpkt;
yading@11: 
yading@11: } Wc3DemuxContext;
yading@11: 
yading@11: static int wc3_probe(AVProbeData *p)
yading@11: {
yading@11:     if (p->buf_size < 12)
yading@11:         return 0;
yading@11: 
yading@11:     if ((AV_RL32(&p->buf[0]) != FORM_TAG) ||
yading@11:         (AV_RL32(&p->buf[8]) != MOVE_TAG))
yading@11:         return 0;
yading@11: 
yading@11:     return AVPROBE_SCORE_MAX;
yading@11: }
yading@11: 
yading@11: static int wc3_read_header(AVFormatContext *s)
yading@11: {
yading@11:     Wc3DemuxContext *wc3 = s->priv_data;
yading@11:     AVIOContext *pb = s->pb;
yading@11:     unsigned int fourcc_tag;
yading@11:     unsigned int size;
yading@11:     AVStream *st;
yading@11:     int ret = 0;
yading@11:     char *buffer;
yading@11: 
yading@11:     /* default context members */
yading@11:     wc3->width = WC3_DEFAULT_WIDTH;
yading@11:     wc3->height = WC3_DEFAULT_HEIGHT;
yading@11:     wc3->pts = 0;
yading@11:     wc3->video_stream_index = wc3->audio_stream_index = 0;
yading@11:     av_init_packet(&wc3->vpkt);
yading@11:     wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
yading@11: 
yading@11:     /* skip the first 3 32-bit numbers */
yading@11:     avio_skip(pb, 12);
yading@11: 
yading@11:     /* traverse through the chunks and load the header information before
yading@11:      * the first BRCH tag */
yading@11:     fourcc_tag = avio_rl32(pb);
yading@11:     size = (avio_rb32(pb) + 1) & (~1);
yading@11: 
yading@11:     do {
yading@11:         switch (fourcc_tag) {
yading@11: 
yading@11:         case SOND_TAG:
yading@11:         case INDX_TAG:
yading@11:             /* SOND unknown, INDX unnecessary; ignore both */
yading@11:             avio_skip(pb, size);
yading@11:             break;
yading@11: 
yading@11:         case PC__TAG:
yading@11:             /* number of palettes, unneeded */
yading@11:             avio_skip(pb, 12);
yading@11:             break;
yading@11: 
yading@11:         case BNAM_TAG:
yading@11:             /* load up the name */
yading@11:             buffer = av_malloc(size+1);
yading@11:             if (!buffer)
yading@11:                 return AVERROR(ENOMEM);
yading@11:             if ((ret = avio_read(pb, buffer, size)) != size)
yading@11:                 return AVERROR(EIO);
yading@11:             buffer[size] = 0;
yading@11:             av_dict_set(&s->metadata, "title", buffer,
yading@11:                                    AV_DICT_DONT_STRDUP_VAL);
yading@11:             break;
yading@11: 
yading@11:         case SIZE_TAG:
yading@11:             /* video resolution override */
yading@11:             wc3->width  = avio_rl32(pb);
yading@11:             wc3->height = avio_rl32(pb);
yading@11:             break;
yading@11: 
yading@11:         case PALT_TAG:
yading@11:             /* one of several palettes */
yading@11:             avio_seek(pb, -8, SEEK_CUR);
yading@11:             av_append_packet(pb, &wc3->vpkt, 8 + PALETTE_SIZE);
yading@11:             break;
yading@11: 
yading@11:         default:
yading@11:             av_log(s, AV_LOG_ERROR, "  unrecognized WC3 chunk: %c%c%c%c (0x%02X%02X%02X%02X)\n",
yading@11:                 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24),
yading@11:                 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24));
yading@11:             return AVERROR_INVALIDDATA;
yading@11:         }
yading@11: 
yading@11:         fourcc_tag = avio_rl32(pb);
yading@11:         /* chunk sizes are 16-bit aligned */
yading@11:         size = (avio_rb32(pb) + 1) & (~1);
yading@11:         if (url_feof(pb))
yading@11:             return AVERROR(EIO);
yading@11: 
yading@11:     } while (fourcc_tag != BRCH_TAG);
yading@11: 
yading@11:     /* initialize the decoder streams */
yading@11:     st = avformat_new_stream(s, NULL);
yading@11:     if (!st)
yading@11:         return AVERROR(ENOMEM);
yading@11:     avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
yading@11:     wc3->video_stream_index = st->index;
yading@11:     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
yading@11:     st->codec->codec_id = AV_CODEC_ID_XAN_WC3;
yading@11:     st->codec->codec_tag = 0;  /* no fourcc */
yading@11:     st->codec->width = wc3->width;
yading@11:     st->codec->height = wc3->height;
yading@11: 
yading@11:     st = avformat_new_stream(s, NULL);
yading@11:     if (!st)
yading@11:         return AVERROR(ENOMEM);
yading@11:     avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
yading@11:     wc3->audio_stream_index = st->index;
yading@11:     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
yading@11:     st->codec->codec_id = AV_CODEC_ID_PCM_S16LE;
yading@11:     st->codec->codec_tag = 1;
yading@11:     st->codec->channels = WC3_AUDIO_CHANNELS;
yading@11:     st->codec->channel_layout = AV_CH_LAYOUT_MONO;
yading@11:     st->codec->bits_per_coded_sample = WC3_AUDIO_BITS;
yading@11:     st->codec->sample_rate = WC3_SAMPLE_RATE;
yading@11:     st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
yading@11:         st->codec->bits_per_coded_sample;
yading@11:     st->codec->block_align = WC3_AUDIO_BITS * WC3_AUDIO_CHANNELS;
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: static int wc3_read_packet(AVFormatContext *s,
yading@11:                            AVPacket *pkt)
yading@11: {
yading@11:     Wc3DemuxContext *wc3 = s->priv_data;
yading@11:     AVIOContext *pb = s->pb;
yading@11:     unsigned int fourcc_tag;
yading@11:     unsigned int size;
yading@11:     int packet_read = 0;
yading@11:     int ret = 0;
yading@11:     unsigned char text[1024];
yading@11: 
yading@11:     while (!packet_read) {
yading@11: 
yading@11:         fourcc_tag = avio_rl32(pb);
yading@11:         /* chunk sizes are 16-bit aligned */
yading@11:         size = (avio_rb32(pb) + 1) & (~1);
yading@11:         if (url_feof(pb))
yading@11:             return AVERROR(EIO);
yading@11: 
yading@11:         switch (fourcc_tag) {
yading@11: 
yading@11:         case BRCH_TAG:
yading@11:             /* no-op */
yading@11:             break;
yading@11: 
yading@11:         case SHOT_TAG:
yading@11:             /* load up new palette */
yading@11:             avio_seek(pb, -8, SEEK_CUR);
yading@11:             av_append_packet(pb, &wc3->vpkt, 8 + 4);
yading@11:             break;
yading@11: 
yading@11:         case VGA__TAG:
yading@11:             /* send out video chunk */
yading@11:             avio_seek(pb, -8, SEEK_CUR);
yading@11:             ret= av_append_packet(pb, &wc3->vpkt, 8 + size);
yading@11:             // ignore error if we have some data
yading@11:             if (wc3->vpkt.size > 0)
yading@11:                 ret = 0;
yading@11:             *pkt = wc3->vpkt;
yading@11:             wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
yading@11:             pkt->stream_index = wc3->video_stream_index;
yading@11:             pkt->pts = wc3->pts;
yading@11:             packet_read = 1;
yading@11:             break;
yading@11: 
yading@11:         case TEXT_TAG:
yading@11:             /* subtitle chunk */
yading@11: #if 0
yading@11:             avio_skip(pb, size);
yading@11: #else
yading@11:             if ((unsigned)size > sizeof(text) || (ret = avio_read(pb, text, size)) != size)
yading@11:                 ret = AVERROR(EIO);
yading@11:             else {
yading@11:                 int i = 0;
yading@11:                 av_log (s, AV_LOG_DEBUG, "Subtitle time!\n");
yading@11:                 av_log (s, AV_LOG_DEBUG, "  inglish: %s\n", &text[i + 1]);
yading@11:                 i += text[i] + 1;
yading@11:                 av_log (s, AV_LOG_DEBUG, "  doytsch: %s\n", &text[i + 1]);
yading@11:                 i += text[i] + 1;
yading@11:                 av_log (s, AV_LOG_DEBUG, "  fronsay: %s\n", &text[i + 1]);
yading@11:             }
yading@11: #endif
yading@11:             break;
yading@11: 
yading@11:         case AUDI_TAG:
yading@11:             /* send out audio chunk */
yading@11:             ret= av_get_packet(pb, pkt, size);
yading@11:             pkt->stream_index = wc3->audio_stream_index;
yading@11:             pkt->pts = wc3->pts;
yading@11: 
yading@11:             /* time to advance pts */
yading@11:             wc3->pts++;
yading@11: 
yading@11:             packet_read = 1;
yading@11:             break;
yading@11: 
yading@11:         default:
yading@11:             av_log (s, AV_LOG_ERROR, "  unrecognized WC3 chunk: %c%c%c%c (0x%02X%02X%02X%02X)\n",
yading@11:                 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24),
yading@11:                 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24));
yading@11:             ret = AVERROR_INVALIDDATA;
yading@11:             packet_read = 1;
yading@11:             break;
yading@11:         }
yading@11:     }
yading@11: 
yading@11:     return ret;
yading@11: }
yading@11: 
yading@11: static int wc3_read_close(AVFormatContext *s)
yading@11: {
yading@11:     Wc3DemuxContext *wc3 = s->priv_data;
yading@11: 
yading@11:     if (wc3->vpkt.size > 0)
yading@11:         av_free_packet(&wc3->vpkt);
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: AVInputFormat ff_wc3_demuxer = {
yading@11:     .name           = "wc3movie",
yading@11:     .long_name      = NULL_IF_CONFIG_SMALL("Wing Commander III movie"),
yading@11:     .priv_data_size = sizeof(Wc3DemuxContext),
yading@11:     .read_probe     = wc3_probe,
yading@11:     .read_header    = wc3_read_header,
yading@11:     .read_packet    = wc3_read_packet,
yading@11:     .read_close     = wc3_read_close,
yading@11: };