2 * Wing Commander III Movie (.mve) File Demuxer
3 * Copyright (c) 2003 The ffmpeg Project
5 * This file is part of FFmpeg.
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.
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.
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
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/
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/dict.h"
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')
49 /* video resolution unless otherwise specified */
50 #define WC3_DEFAULT_WIDTH 320
51 #define WC3_DEFAULT_HEIGHT 165
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
58 /* nice, constant framerate */
59 #define WC3_FRAME_FPS 15
61 #define PALETTE_SIZE (256 * 3)
63 typedef struct Wc3DemuxContext {
67 int video_stream_index;
68 int audio_stream_index;
74 static int wc3_probe(AVProbeData *p)
79 if ((AV_RL32(&p->buf[0]) != FORM_TAG) ||
80 (AV_RL32(&p->buf[8]) != MOVE_TAG))
83 return AVPROBE_SCORE_MAX;
86 static int wc3_read_header(AVFormatContext *s,
87 AVFormatParameters *ap)
89 Wc3DemuxContext *wc3 = s->priv_data;
90 AVIOContext *pb = s->pb;
91 unsigned int fourcc_tag;
97 /* default context members */
98 wc3->width = WC3_DEFAULT_WIDTH;
99 wc3->height = WC3_DEFAULT_HEIGHT;
101 wc3->video_stream_index = wc3->audio_stream_index = 0;
102 av_init_packet(&wc3->vpkt);
103 wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
105 /* skip the first 3 32-bit numbers */
108 /* traverse through the chunks and load the header information before
109 * the first BRCH tag */
110 fourcc_tag = avio_rl32(pb);
111 size = (avio_rb32(pb) + 1) & (~1);
114 switch (fourcc_tag) {
118 /* SOND unknown, INDX unnecessary; ignore both */
123 /* number of palettes, unneeded */
128 /* load up the name */
129 buffer = av_malloc(size+1);
131 return AVERROR(ENOMEM);
132 if ((ret = avio_read(pb, buffer, size)) != size)
135 av_dict_set(&s->metadata, "title", buffer,
136 AV_DICT_DONT_STRDUP_VAL);
140 /* video resolution override */
141 wc3->width = avio_rl32(pb);
142 wc3->height = avio_rl32(pb);
146 /* one of several palettes */
147 avio_seek(pb, -8, SEEK_CUR);
148 av_append_packet(pb, &wc3->vpkt, 8 + PALETTE_SIZE);
152 av_log(s, AV_LOG_ERROR, " unrecognized WC3 chunk: %c%c%c%c (0x%02X%02X%02X%02X)\n",
153 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24),
154 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24));
155 return AVERROR_INVALIDDATA;
158 fourcc_tag = avio_rl32(pb);
159 /* chunk sizes are 16-bit aligned */
160 size = (avio_rb32(pb) + 1) & (~1);
164 } while (fourcc_tag != BRCH_TAG);
166 /* initialize the decoder streams */
167 st = avformat_new_stream(s, NULL);
169 return AVERROR(ENOMEM);
170 avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
171 wc3->video_stream_index = st->index;
172 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
173 st->codec->codec_id = CODEC_ID_XAN_WC3;
174 st->codec->codec_tag = 0; /* no fourcc */
175 st->codec->width = wc3->width;
176 st->codec->height = wc3->height;
178 st = avformat_new_stream(s, NULL);
180 return AVERROR(ENOMEM);
181 avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
182 wc3->audio_stream_index = st->index;
183 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
184 st->codec->codec_id = CODEC_ID_PCM_S16LE;
185 st->codec->codec_tag = 1;
186 st->codec->channels = WC3_AUDIO_CHANNELS;
187 st->codec->bits_per_coded_sample = WC3_AUDIO_BITS;
188 st->codec->sample_rate = WC3_SAMPLE_RATE;
189 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
190 st->codec->bits_per_coded_sample;
191 st->codec->block_align = WC3_AUDIO_BITS * WC3_AUDIO_CHANNELS;
196 static int wc3_read_packet(AVFormatContext *s,
199 Wc3DemuxContext *wc3 = s->priv_data;
200 AVIOContext *pb = s->pb;
201 unsigned int fourcc_tag;
205 unsigned char text[1024];
207 while (!packet_read) {
209 fourcc_tag = avio_rl32(pb);
210 /* chunk sizes are 16-bit aligned */
211 size = (avio_rb32(pb) + 1) & (~1);
215 switch (fourcc_tag) {
222 /* load up new palette */
223 avio_seek(pb, -8, SEEK_CUR);
224 av_append_packet(pb, &wc3->vpkt, 8 + 4);
228 /* send out video chunk */
229 avio_seek(pb, -8, SEEK_CUR);
230 ret= av_append_packet(pb, &wc3->vpkt, 8 + size);
231 // ignore error if we have some data
232 if (wc3->vpkt.size > 0)
235 wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
236 pkt->stream_index = wc3->video_stream_index;
246 if ((unsigned)size > sizeof(text) || (ret = avio_read(pb, text, size)) != size)
250 av_log (s, AV_LOG_DEBUG, "Subtitle time!\n");
251 av_log (s, AV_LOG_DEBUG, " inglish: %s\n", &text[i + 1]);
253 av_log (s, AV_LOG_DEBUG, " doytsch: %s\n", &text[i + 1]);
255 av_log (s, AV_LOG_DEBUG, " fronsay: %s\n", &text[i + 1]);
261 /* send out audio chunk */
262 ret= av_get_packet(pb, pkt, size);
263 pkt->stream_index = wc3->audio_stream_index;
266 /* time to advance pts */
273 av_log (s, AV_LOG_ERROR, " unrecognized WC3 chunk: %c%c%c%c (0x%02X%02X%02X%02X)\n",
274 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24),
275 (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24));
276 ret = AVERROR_INVALIDDATA;
285 static int wc3_read_close(AVFormatContext *s)
287 Wc3DemuxContext *wc3 = s->priv_data;
289 if (wc3->vpkt.size > 0)
290 av_free_packet(&wc3->vpkt);
295 AVInputFormat ff_wc3_demuxer = {
297 .long_name = NULL_IF_CONFIG_SMALL("Wing Commander III movie format"),
298 .priv_data_size = sizeof(Wc3DemuxContext),
299 .read_probe = wc3_probe,
300 .read_header = wc3_read_header,
301 .read_packet = wc3_read_packet,
302 .read_close = wc3_read_close,