EA ADPCM R1, R2 and R3 decoder
[ffmpeg.git] / libavformat / electronicarts.c
1 /* Electronic Arts Multimedia File Demuxer
2  * Copyright (c) 2004  The ffmpeg Project
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file electronicarts.c
23  * Electronic Arts Multimedia file demuxer (WVE/UV2/etc.)
24  * by Robin Kay (komadori at gekkou.co.uk)
25  */
26
27 #include "avformat.h"
28
29 #define SCHl_TAG MKTAG('S', 'C', 'H', 'l')
30 #define PT00_TAG MKTAG('P', 'T', 0x0, 0x0)
31 #define GSTR_TAG MKTAG('G', 'S', 'T', 'R')
32 #define SCDl_TAG MKTAG('S', 'C', 'D', 'l')
33 #define SCEl_TAG MKTAG('S', 'C', 'E', 'l')
34 #define MVhd_TAG MKTAG('M', 'V', 'h', 'd')
35 #define MV0K_TAG MKTAG('M', 'V', '0', 'K')
36 #define MV0F_TAG MKTAG('M', 'V', '0', 'F')
37
38 typedef struct EaDemuxContext {
39     int big_endian;
40
41     int video_codec;
42     AVRational time_base;
43     int video_stream_index;
44
45     int audio_codec;
46     int audio_stream_index;
47     int audio_frame_counter;
48
49     int64_t audio_pts;
50
51     int bytes;
52     int sample_rate;
53     int num_channels;
54     int num_samples;
55 } EaDemuxContext;
56
57 static uint32_t read_arbitary(ByteIOContext *pb) {
58     uint8_t size, byte;
59     int i;
60     uint32_t word;
61
62     size = get_byte(pb);
63
64     word = 0;
65     for (i = 0; i < size; i++) {
66         byte = get_byte(pb);
67         word <<= 8;
68         word |= byte;
69     }
70
71     return word;
72 }
73
74 /*
75  * Process PT/GSTR sound header
76  * return 1 if success, 0 if invalid format, otherwise AVERROR_xxx
77  */
78 static int process_audio_header_elements(AVFormatContext *s)
79 {
80     int inHeader = 1;
81     EaDemuxContext *ea = s->priv_data;
82     ByteIOContext *pb = &s->pb;
83     int compression_type = -1, revision = -1;
84
85     ea->bytes = 2;
86     ea->sample_rate = -1;
87     ea->num_channels = 1;
88
89     while (inHeader) {
90         int inSubheader;
91         uint8_t byte;
92         byte = get_byte(pb);
93
94         switch (byte) {
95         case 0xFD:
96             av_log (s, AV_LOG_INFO, "entered audio subheader\n");
97             inSubheader = 1;
98             while (inSubheader) {
99                 uint8_t subbyte;
100                 subbyte = get_byte(pb);
101
102                 switch (subbyte) {
103                 case 0x80:
104                     revision = read_arbitary(pb);
105                     av_log (s, AV_LOG_INFO, "revision (element 0x80) set to 0x%08x\n", revision);
106                     break;
107                 case 0x82:
108                     ea->num_channels = read_arbitary(pb);
109                     av_log (s, AV_LOG_INFO, "num_channels (element 0x82) set to 0x%08x\n", ea->num_channels);
110                     break;
111                 case 0x83:
112                     compression_type = read_arbitary(pb);
113                     av_log (s, AV_LOG_INFO, "compression_type (element 0x83) set to 0x%08x\n", compression_type);
114                     break;
115                 case 0x84:
116                     ea->sample_rate = read_arbitary(pb);
117                     av_log (s, AV_LOG_INFO, "sample_rate (element 0x84) set to %i\n", ea->sample_rate);
118                     break;
119                 case 0x85:
120                     ea->num_samples = read_arbitary(pb);
121                     av_log (s, AV_LOG_INFO, "num_samples (element 0x85) set to 0x%08x\n", ea->num_samples);
122                     break;
123                 case 0x8A:
124                     av_log (s, AV_LOG_INFO, "element 0x%02x set to 0x%08x\n", subbyte, read_arbitary(pb));
125                     av_log (s, AV_LOG_INFO, "exited audio subheader\n");
126                     inSubheader = 0;
127                     break;
128                 case 0xFF:
129                     av_log (s, AV_LOG_INFO, "end of header block reached (within audio subheader)\n");
130                     inSubheader = 0;
131                     inHeader = 0;
132                     break;
133                 default:
134                     av_log (s, AV_LOG_INFO, "element 0x%02x set to 0x%08x\n", subbyte, read_arbitary(pb));
135                     break;
136                 }
137             }
138             break;
139         case 0xFF:
140             av_log (s, AV_LOG_INFO, "end of header block reached\n");
141             inHeader = 0;
142             break;
143         default:
144             av_log (s, AV_LOG_INFO, "header element 0x%02x set to 0x%08x\n", byte, read_arbitary(pb));
145             break;
146         }
147     }
148
149     switch (compression_type) {
150     case  0: ea->audio_codec = CODEC_ID_PCM_S16LE; break;
151     case  7: ea->audio_codec = CODEC_ID_ADPCM_EA; break;
152     case -1:
153         switch (revision) {
154         case  1: ea->audio_codec = CODEC_ID_ADPCM_EA_R1; break;
155         case  2: ea->audio_codec = CODEC_ID_ADPCM_EA_R2; break;
156         case  3: ea->audio_codec = CODEC_ID_ADPCM_EA_R3; break;
157         default:
158             av_log(s, AV_LOG_ERROR, "unsupported stream type; revision=%i\n", revision);
159             return 0;
160         }
161         break;
162     default:
163         av_log(s, AV_LOG_ERROR, "unsupported stream type; compression_type=%i\n", compression_type);
164         return 0;
165     }
166
167     if (ea->sample_rate == -1)
168         ea->sample_rate = revision==3 ? 48000 : 22050;
169
170     return 1;
171 }
172
173 static int process_video_header_vp6(AVFormatContext *s)
174 {
175     EaDemuxContext *ea = s->priv_data;
176     ByteIOContext *pb = &s->pb;
177
178     url_fskip(pb, 16);
179     ea->time_base.den = get_le32(pb);
180     ea->time_base.num = get_le32(pb);
181     ea->video_codec = CODEC_ID_VP6;
182
183     return 1;
184 }
185
186 /*
187  * Process EA file header
188  * Returns 1 if the EA file is valid and successfully opened, 0 otherwise
189  */
190 static int process_ea_header(AVFormatContext *s) {
191     uint32_t blockid, size = 0;
192     EaDemuxContext *ea = s->priv_data;
193     ByteIOContext *pb = &s->pb;
194     int i;
195
196     for (i=0; i<5 && (!ea->audio_codec || !ea->video_codec); i++) {
197         unsigned int startpos = url_ftell(pb);
198         int err = 0;
199
200         blockid = get_le32(pb);
201         size = get_le32(pb);
202         if (i == 0)
203             ea->big_endian = size > 0x000FFFFF;
204         if (ea->big_endian)
205             size = bswap_32(size);
206
207         switch (blockid) {
208             case SCHl_TAG :
209                 blockid = get_le32(pb);
210                 if (blockid == GSTR_TAG) {
211                     url_fskip(pb, 4);
212                 } else if (blockid != PT00_TAG) {
213                     av_log (s, AV_LOG_ERROR, "unknown SCHl headerid\n");
214                     return 0;
215                 }
216                 err = process_audio_header_elements(s);
217                 break;
218
219             case MVhd_TAG :
220                 err = process_video_header_vp6(s);
221                 break;
222         }
223
224         if (err < 0) {
225             av_log(s, AV_LOG_ERROR, "error parsing header: %i\n", err);
226             return err;
227         }
228
229         url_fseek(pb, startpos + size, SEEK_SET);
230     }
231
232     url_fseek(pb, 0, SEEK_SET);
233
234     return 1;
235 }
236
237
238 static int ea_probe(AVProbeData *p)
239 {
240     switch (AV_RL32(&p->buf[0])) {
241     case SCHl_TAG:
242     case MVhd_TAG:
243         return AVPROBE_SCORE_MAX;
244     }
245     return 0;
246 }
247
248 static int ea_read_header(AVFormatContext *s,
249                           AVFormatParameters *ap)
250 {
251     EaDemuxContext *ea = s->priv_data;
252     AVStream *st;
253
254     if (!process_ea_header(s))
255         return AVERROR(EIO);
256
257     if (ea->video_codec) {
258         /* initialize the video decoder stream */
259         st = av_new_stream(s, 0);
260         if (!st)
261             return AVERROR(ENOMEM);
262         ea->video_stream_index = st->index;
263         st->codec->codec_type = CODEC_TYPE_VIDEO;
264         st->codec->codec_id = ea->video_codec;
265         st->codec->codec_tag = 0;  /* no fourcc */
266         st->codec->time_base = ea->time_base;
267     }
268
269     if (ea->audio_codec) {
270         /* initialize the audio decoder stream */
271         st = av_new_stream(s, 0);
272         if (!st)
273             return AVERROR(ENOMEM);
274         av_set_pts_info(st, 33, 1, ea->sample_rate);
275         st->codec->codec_type = CODEC_TYPE_AUDIO;
276         st->codec->codec_id = ea->audio_codec;
277         st->codec->codec_tag = 0;  /* no tag */
278         st->codec->channels = ea->num_channels;
279         st->codec->sample_rate = ea->sample_rate;
280         st->codec->bits_per_sample = ea->bytes * 8;
281         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
282             st->codec->bits_per_sample / 4;
283         st->codec->block_align = st->codec->channels*st->codec->bits_per_sample;
284         ea->audio_stream_index = st->index;
285         ea->audio_frame_counter = 0;
286     }
287
288     return 1;
289 }
290
291 static int ea_read_packet(AVFormatContext *s,
292                           AVPacket *pkt)
293 {
294     EaDemuxContext *ea = s->priv_data;
295     ByteIOContext *pb = &s->pb;
296     int ret = 0;
297     int packet_read = 0;
298     unsigned int chunk_type, chunk_size;
299     int key = 0;
300
301     while (!packet_read) {
302         chunk_type = get_le32(pb);
303         chunk_size = (ea->big_endian ? get_be32(pb) : get_le32(pb)) - 8;
304
305         switch (chunk_type) {
306         /* audio data */
307         case SCDl_TAG:
308             if (!ea->audio_codec) {
309                 url_fskip(pb, chunk_size);
310                 break;
311             }
312             ret = av_get_packet(pb, pkt, chunk_size);
313             if (ret != chunk_size)
314                 ret = AVERROR(EIO);
315             else {
316                     pkt->stream_index = ea->audio_stream_index;
317                     pkt->pts = 90000;
318                     pkt->pts *= ea->audio_frame_counter;
319                     pkt->pts /= ea->sample_rate;
320
321                     switch (ea->audio_codec) {
322                     case CODEC_ID_ADPCM_EA:
323                     /* 2 samples/byte, 1 or 2 samples per frame depending
324                      * on stereo; chunk also has 12-byte header */
325                     ea->audio_frame_counter += ((chunk_size - 12) * 2) /
326                         ea->num_channels;
327                         break;
328                     default:
329                         ea->audio_frame_counter += chunk_size /
330                             (ea->bytes * ea->num_channels);
331                     }
332             }
333
334             packet_read = 1;
335             break;
336
337         /* ending tag */
338         case SCEl_TAG:
339             ret = AVERROR(EIO);
340             packet_read = 1;
341             break;
342
343         case MV0K_TAG:
344             key = PKT_FLAG_KEY;
345         case MV0F_TAG:
346             ret = av_get_packet(pb, pkt, chunk_size);
347             if (ret != chunk_size)
348                 ret = AVERROR_IO;
349             else {
350                 pkt->stream_index = ea->video_stream_index;
351                 pkt->flags |= key;
352             }
353             packet_read = 1;
354             break;
355
356         default:
357             url_fseek(pb, chunk_size, SEEK_CUR);
358             break;
359         }
360     }
361
362     return ret;
363 }
364
365 AVInputFormat ea_demuxer = {
366     "ea",
367     "Electronic Arts Multimedia Format",
368     sizeof(EaDemuxContext),
369     ea_probe,
370     ea_read_header,
371     ea_read_packet,
372 };