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