c338d95182d2ad0bfac01c2637e0bf6eef7a13a7
[libav.git] / libavformat / westwood_vqa.c
1 /*
2 * Westwood Studios VQA Format Demuxer
3 * Copyright (c) 2003 The ffmpeg Project
4 *
5 * This file is part of Libav.
6 *
7 * Libav 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 * Libav 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 Libav; 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 * Westwood Studios VQA file demuxer
25 * by Mike Melanson (melanson@pcisys.net)
26 * for more information on the Westwood file formats, visit:
27 * http://www.pcisys.net/~melanson/codecs/
28 * http://www.geocities.com/SiliconValley/8682/aud3.txt
29 */
30
31 #include "libavutil/intreadwrite.h"
32 #include "avformat.h"
33 #include "internal.h"
34
35 #define FORM_TAG MKBETAG('F', 'O', 'R', 'M')
36 #define WVQA_TAG MKBETAG('W', 'V', 'Q', 'A')
37 #define VQHD_TAG MKBETAG('V', 'Q', 'H', 'D')
38 #define FINF_TAG MKBETAG('F', 'I', 'N', 'F')
39 #define SND0_TAG MKBETAG('S', 'N', 'D', '0')
40 #define SND1_TAG MKBETAG('S', 'N', 'D', '1')
41 #define SND2_TAG MKBETAG('S', 'N', 'D', '2')
42 #define VQFR_TAG MKBETAG('V', 'Q', 'F', 'R')
43
44 /* don't know what these tags are for, but acknowledge their existence */
45 #define CINF_TAG MKBETAG('C', 'I', 'N', 'F')
46 #define CINH_TAG MKBETAG('C', 'I', 'N', 'H')
47 #define CIND_TAG MKBETAG('C', 'I', 'N', 'D')
48 #define PINF_TAG MKBETAG('P', 'I', 'N', 'F')
49 #define PINH_TAG MKBETAG('P', 'I', 'N', 'H')
50 #define PIND_TAG MKBETAG('P', 'I', 'N', 'D')
51 #define CMDS_TAG MKBETAG('C', 'M', 'D', 'S')
52
53 #define VQA_HEADER_SIZE 0x2A
54 #define VQA_PREAMBLE_SIZE 8
55
56 typedef struct WsVqaDemuxContext {
57 int audio_samplerate;
58 int audio_channels;
59 int audio_bits;
60
61 int audio_stream_index;
62 int video_stream_index;
63 } WsVqaDemuxContext;
64
65 static int wsvqa_probe(AVProbeData *p)
66 {
67 /* need 12 bytes to qualify */
68 if (p->buf_size < 12)
69 return 0;
70
71 /* check for the VQA signatures */
72 if ((AV_RB32(&p->buf[0]) != FORM_TAG) ||
73 (AV_RB32(&p->buf[8]) != WVQA_TAG))
74 return 0;
75
76 return AVPROBE_SCORE_MAX;
77 }
78
79 static int wsvqa_read_header(AVFormatContext *s,
80 AVFormatParameters *ap)
81 {
82 WsVqaDemuxContext *wsvqa = s->priv_data;
83 AVIOContext *pb = s->pb;
84 AVStream *st;
85 unsigned char *header;
86 unsigned char scratch[VQA_PREAMBLE_SIZE];
87 unsigned int chunk_tag;
88 unsigned int chunk_size;
89 int fps, version, flags, sample_rate, channels;
90
91 /* initialize the video decoder stream */
92 st = avformat_new_stream(s, NULL);
93 if (!st)
94 return AVERROR(ENOMEM);
95 st->start_time = 0;
96 wsvqa->video_stream_index = st->index;
97 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
98 st->codec->codec_id = CODEC_ID_WS_VQA;
99 st->codec->codec_tag = 0; /* no fourcc */
100
101 /* skip to the start of the VQA header */
102 avio_seek(pb, 20, SEEK_SET);
103
104 /* the VQA header needs to go to the decoder */
105 st->codec->extradata_size = VQA_HEADER_SIZE;
106 st->codec->extradata = av_mallocz(VQA_HEADER_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
107 header = (unsigned char *)st->codec->extradata;
108 if (avio_read(pb, st->codec->extradata, VQA_HEADER_SIZE) !=
109 VQA_HEADER_SIZE) {
110 av_free(st->codec->extradata);
111 return AVERROR(EIO);
112 }
113 st->codec->width = AV_RL16(&header[6]);
114 st->codec->height = AV_RL16(&header[8]);
115 fps = header[12];
116 if (fps < 1 || fps > 30) {
117 av_log(s, AV_LOG_ERROR, "invalid fps: %d\n", fps);
118 return AVERROR_INVALIDDATA;
119 }
120 avpriv_set_pts_info(st, 64, 1, fps);
121
122 /* initialize the audio decoder stream for VQA v1 or nonzero samplerate */
123 version = AV_RL16(&header[ 0]);
124 flags = AV_RL16(&header[ 2]);
125 sample_rate = AV_RL16(&header[24]);
126 channels = header[26];
127 if (sample_rate || (version == 1 && flags == 1)) {
128 st = avformat_new_stream(s, NULL);
129 if (!st)
130 return AVERROR(ENOMEM);
131 st->start_time = 0;
132 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
133
134 if (!sample_rate)
135 sample_rate = 22050;
136 st->codec->sample_rate = sample_rate;
137 avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
138
139 if (!channels)
140 channels = 1;
141 st->codec->channels = channels;
142
143 switch (version) {
144 case 1:
145 st->codec->codec_id = CODEC_ID_WESTWOOD_SND1;
146 break;
147 case 2:
148 case 3:
149 st->codec->codec_id = CODEC_ID_ADPCM_IMA_WS;
150 st->codec->bits_per_coded_sample = 4;
151 st->codec->bit_rate = channels * sample_rate * 4;
152 break;
153 default:
154 /* NOTE: version 0 is supposedly raw pcm_u8 or pcm_s16le, but we do
155 not have any samples to validate this */
156 av_log_ask_for_sample(s, "VQA version %d audio\n", version);
157 return AVERROR_PATCHWELCOME;
158 }
159
160 wsvqa->audio_stream_index = st->index;
161 wsvqa->audio_samplerate = st->codec->sample_rate;
162 wsvqa->audio_channels = st->codec->channels;
163 }
164
165 /* there are 0 or more chunks before the FINF chunk; iterate until
166 * FINF has been skipped and the file will be ready to be demuxed */
167 do {
168 if (avio_read(pb, scratch, VQA_PREAMBLE_SIZE) != VQA_PREAMBLE_SIZE) {
169 av_free(st->codec->extradata);
170 return AVERROR(EIO);
171 }
172 chunk_tag = AV_RB32(&scratch[0]);
173 chunk_size = AV_RB32(&scratch[4]);
174
175 /* catch any unknown header tags, for curiousity */
176 switch (chunk_tag) {
177 case CINF_TAG:
178 case CINH_TAG:
179 case CIND_TAG:
180 case PINF_TAG:
181 case PINH_TAG:
182 case PIND_TAG:
183 case FINF_TAG:
184 case CMDS_TAG:
185 break;
186
187 default:
188 av_log (s, AV_LOG_ERROR, " note: unknown chunk seen (%c%c%c%c)\n",
189 scratch[0], scratch[1],
190 scratch[2], scratch[3]);
191 break;
192 }
193
194 avio_skip(pb, chunk_size);
195 } while (chunk_tag != FINF_TAG);
196
197 return 0;
198 }
199
200 static int wsvqa_read_packet(AVFormatContext *s,
201 AVPacket *pkt)
202 {
203 WsVqaDemuxContext *wsvqa = s->priv_data;
204 AVIOContext *pb = s->pb;
205 int ret = -1;
206 unsigned char preamble[VQA_PREAMBLE_SIZE];
207 unsigned int chunk_type;
208 unsigned int chunk_size;
209 int skip_byte;
210
211 while (avio_read(pb, preamble, VQA_PREAMBLE_SIZE) == VQA_PREAMBLE_SIZE) {
212 chunk_type = AV_RB32(&preamble[0]);
213 chunk_size = AV_RB32(&preamble[4]);
214 skip_byte = chunk_size & 0x01;
215
216 if ((chunk_type == SND2_TAG || chunk_type == SND1_TAG) && wsvqa->audio_channels == 0) {
217 av_log(s, AV_LOG_ERROR, "audio chunk without any audio header information found\n");
218 return AVERROR_INVALIDDATA;
219 }
220
221 if ((chunk_type == SND1_TAG) || (chunk_type == SND2_TAG) || (chunk_type == VQFR_TAG)) {
222
223 if (av_new_packet(pkt, chunk_size))
224 return AVERROR(EIO);
225 ret = avio_read(pb, pkt->data, chunk_size);
226 if (ret != chunk_size) {
227 av_free_packet(pkt);
228 return AVERROR(EIO);
229 }
230
231 if (chunk_type == SND2_TAG) {
232 pkt->stream_index = wsvqa->audio_stream_index;
233 /* 2 samples/byte, 1 or 2 samples per frame depending on stereo */
234 pkt->duration = (chunk_size * 2) / wsvqa->audio_channels;
235 } else if(chunk_type == SND1_TAG) {
236 pkt->stream_index = wsvqa->audio_stream_index;
237 /* unpacked size is stored in header */
238 pkt->duration = AV_RL16(pkt->data) / wsvqa->audio_channels;
239 } else {
240 pkt->stream_index = wsvqa->video_stream_index;
241 pkt->duration = 1;
242 }
243 /* stay on 16-bit alignment */
244 if (skip_byte)
245 avio_skip(pb, 1);
246
247 return ret;
248 } else {
249 switch(chunk_type){
250 case CMDS_TAG:
251 case SND0_TAG:
252 break;
253 default:
254 av_log(s, AV_LOG_INFO, "Skipping unknown chunk 0x%08X\n", chunk_type);
255 }
256 avio_skip(pb, chunk_size + skip_byte);
257 }
258 }
259
260 return ret;
261 }
262
263 AVInputFormat ff_wsvqa_demuxer = {
264 .name = "wsvqa",
265 .long_name = NULL_IF_CONFIG_SMALL("Westwood Studios VQA format"),
266 .priv_data_size = sizeof(WsVqaDemuxContext),
267 .read_probe = wsvqa_probe,
268 .read_header = wsvqa_read_header,
269 .read_packet = wsvqa_read_packet,
270 };