2eff4cc0a5eec0e4c0c92dbfb9dd18bd03d340ba
[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_FRAMERATE 15
55 #define VQA_PREAMBLE_SIZE 8
56
57 typedef struct WsVqaDemuxContext {
58 int audio_samplerate;
59 int audio_channels;
60 int audio_bits;
61
62 int audio_stream_index;
63 int video_stream_index;
64
65 int64_t audio_frame_counter;
66 } WsVqaDemuxContext;
67
68 static int wsvqa_probe(AVProbeData *p)
69 {
70 /* need 12 bytes to qualify */
71 if (p->buf_size < 12)
72 return 0;
73
74 /* check for the VQA signatures */
75 if ((AV_RB32(&p->buf[0]) != FORM_TAG) ||
76 (AV_RB32(&p->buf[8]) != WVQA_TAG))
77 return 0;
78
79 return AVPROBE_SCORE_MAX;
80 }
81
82 static int wsvqa_read_header(AVFormatContext *s,
83 AVFormatParameters *ap)
84 {
85 WsVqaDemuxContext *wsvqa = s->priv_data;
86 AVIOContext *pb = s->pb;
87 AVStream *st;
88 unsigned char *header;
89 unsigned char scratch[VQA_PREAMBLE_SIZE];
90 unsigned int chunk_tag;
91 unsigned int chunk_size;
92
93 /* initialize the video decoder stream */
94 st = avformat_new_stream(s, NULL);
95 if (!st)
96 return AVERROR(ENOMEM);
97 avpriv_set_pts_info(st, 33, 1, VQA_FRAMERATE);
98 wsvqa->video_stream_index = st->index;
99 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
100 st->codec->codec_id = CODEC_ID_WS_VQA;
101 st->codec->codec_tag = 0; /* no fourcc */
102
103 /* skip to the start of the VQA header */
104 avio_seek(pb, 20, SEEK_SET);
105
106 /* the VQA header needs to go to the decoder */
107 st->codec->extradata_size = VQA_HEADER_SIZE;
108 st->codec->extradata = av_mallocz(VQA_HEADER_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
109 header = (unsigned char *)st->codec->extradata;
110 if (avio_read(pb, st->codec->extradata, VQA_HEADER_SIZE) !=
111 VQA_HEADER_SIZE) {
112 av_free(st->codec->extradata);
113 return AVERROR(EIO);
114 }
115 st->codec->width = AV_RL16(&header[6]);
116 st->codec->height = AV_RL16(&header[8]);
117
118 /* initialize the audio decoder stream for VQA v1 or nonzero samplerate */
119 if (AV_RL16(&header[24]) || (AV_RL16(&header[0]) == 1 && AV_RL16(&header[2]) == 1)) {
120 st = avformat_new_stream(s, NULL);
121 if (!st)
122 return AVERROR(ENOMEM);
123 avpriv_set_pts_info(st, 33, 1, VQA_FRAMERATE);
124 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
125 if (AV_RL16(&header[0]) == 1)
126 st->codec->codec_id = CODEC_ID_WESTWOOD_SND1;
127 else
128 st->codec->codec_id = CODEC_ID_ADPCM_IMA_WS;
129 st->codec->codec_tag = 0; /* no tag */
130 st->codec->sample_rate = AV_RL16(&header[24]);
131 if (!st->codec->sample_rate)
132 st->codec->sample_rate = 22050;
133 st->codec->channels = header[26];
134 if (!st->codec->channels)
135 st->codec->channels = 1;
136 st->codec->bits_per_coded_sample = 16;
137 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
138 st->codec->bits_per_coded_sample / 4;
139 st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
140
141 wsvqa->audio_stream_index = st->index;
142 wsvqa->audio_samplerate = st->codec->sample_rate;
143 wsvqa->audio_channels = st->codec->channels;
144 wsvqa->audio_frame_counter = 0;
145 }
146
147 /* there are 0 or more chunks before the FINF chunk; iterate until
148 * FINF has been skipped and the file will be ready to be demuxed */
149 do {
150 if (avio_read(pb, scratch, VQA_PREAMBLE_SIZE) != VQA_PREAMBLE_SIZE) {
151 av_free(st->codec->extradata);
152 return AVERROR(EIO);
153 }
154 chunk_tag = AV_RB32(&scratch[0]);
155 chunk_size = AV_RB32(&scratch[4]);
156
157 /* catch any unknown header tags, for curiousity */
158 switch (chunk_tag) {
159 case CINF_TAG:
160 case CINH_TAG:
161 case CIND_TAG:
162 case PINF_TAG:
163 case PINH_TAG:
164 case PIND_TAG:
165 case FINF_TAG:
166 case CMDS_TAG:
167 break;
168
169 default:
170 av_log (s, AV_LOG_ERROR, " note: unknown chunk seen (%c%c%c%c)\n",
171 scratch[0], scratch[1],
172 scratch[2], scratch[3]);
173 break;
174 }
175
176 avio_skip(pb, chunk_size);
177 } while (chunk_tag != FINF_TAG);
178
179 return 0;
180 }
181
182 static int wsvqa_read_packet(AVFormatContext *s,
183 AVPacket *pkt)
184 {
185 WsVqaDemuxContext *wsvqa = s->priv_data;
186 AVIOContext *pb = s->pb;
187 int ret = -1;
188 unsigned char preamble[VQA_PREAMBLE_SIZE];
189 unsigned int chunk_type;
190 unsigned int chunk_size;
191 int skip_byte;
192
193 while (avio_read(pb, preamble, VQA_PREAMBLE_SIZE) == VQA_PREAMBLE_SIZE) {
194 chunk_type = AV_RB32(&preamble[0]);
195 chunk_size = AV_RB32(&preamble[4]);
196 skip_byte = chunk_size & 0x01;
197
198 if ((chunk_type == SND2_TAG || chunk_type == SND1_TAG) && wsvqa->audio_channels == 0) {
199 av_log(s, AV_LOG_ERROR, "audio chunk without any audio header information found\n");
200 return AVERROR_INVALIDDATA;
201 }
202
203 if ((chunk_type == SND1_TAG) || (chunk_type == SND2_TAG) || (chunk_type == VQFR_TAG)) {
204
205 if (av_new_packet(pkt, chunk_size))
206 return AVERROR(EIO);
207 ret = avio_read(pb, pkt->data, chunk_size);
208 if (ret != chunk_size) {
209 av_free_packet(pkt);
210 return AVERROR(EIO);
211 }
212
213 if (chunk_type == SND2_TAG) {
214 pkt->stream_index = wsvqa->audio_stream_index;
215 /* 2 samples/byte, 1 or 2 samples per frame depending on stereo */
216 wsvqa->audio_frame_counter += (chunk_size * 2) / wsvqa->audio_channels;
217 } else if(chunk_type == SND1_TAG) {
218 pkt->stream_index = wsvqa->audio_stream_index;
219 /* unpacked size is stored in header */
220 wsvqa->audio_frame_counter += AV_RL16(pkt->data) / wsvqa->audio_channels;
221 } else {
222 pkt->stream_index = wsvqa->video_stream_index;
223 }
224 /* stay on 16-bit alignment */
225 if (skip_byte)
226 avio_skip(pb, 1);
227
228 return ret;
229 } else {
230 switch(chunk_type){
231 case CMDS_TAG:
232 case SND0_TAG:
233 break;
234 default:
235 av_log(s, AV_LOG_INFO, "Skipping unknown chunk 0x%08X\n", chunk_type);
236 }
237 avio_skip(pb, chunk_size + skip_byte);
238 }
239 }
240
241 return ret;
242 }
243
244 AVInputFormat ff_wsvqa_demuxer = {
245 .name = "wsvqa",
246 .long_name = NULL_IF_CONFIG_SMALL("Westwood Studios VQA format"),
247 .priv_data_size = sizeof(WsVqaDemuxContext),
248 .read_probe = wsvqa_probe,
249 .read_header = wsvqa_read_header,
250 .read_packet = wsvqa_read_packet,
251 };