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