EA IMA EACS 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 SEAD_TAG MKTAG('S', 'E', 'A', 'D')    /* Sxxx header */
31 #define SNDC_TAG MKTAG('S', 'N', 'D', 'C')    /* Sxxx data */
32 #define SEND_TAG MKTAG('S', 'E', 'N', 'D')    /* Sxxx end */
33 #define ISNh_TAG MKTAG('1', 'S', 'N', 'h')    /* 1SNx header */
34 #define EACS_TAG MKTAG('E', 'A', 'C', 'S')
35 #define ISNd_TAG MKTAG('1', 'S', 'N', 'd')    /* 1SNx data */
36 #define ISNe_TAG MKTAG('1', 'S', 'N', 'e')    /* 1SNx end */
37 #define PT00_TAG MKTAG('P', 'T', 0x0, 0x0)
38 #define GSTR_TAG MKTAG('G', 'S', 'T', 'R')
39 #define SCDl_TAG MKTAG('S', 'C', 'D', 'l')
40 #define SCEl_TAG MKTAG('S', 'C', 'E', 'l')
41 #define MVhd_TAG MKTAG('M', 'V', 'h', 'd')
42 #define MV0K_TAG MKTAG('M', 'V', '0', 'K')
43 #define MV0F_TAG MKTAG('M', 'V', '0', 'F')
44
45 typedef struct EaDemuxContext {
46     int big_endian;
47
48     int video_codec;
49     AVRational time_base;
50     int video_stream_index;
51
52     int audio_codec;
53     int audio_stream_index;
54     int audio_frame_counter;
55
56     int64_t audio_pts;
57
58     int bytes;
59     int sample_rate;
60     int num_channels;
61     int num_samples;
62 } EaDemuxContext;
63
64 static uint32_t read_arbitary(ByteIOContext *pb) {
65     uint8_t size, byte;
66     int i;
67     uint32_t word;
68
69     size = get_byte(pb);
70
71     word = 0;
72     for (i = 0; i < size; i++) {
73         byte = get_byte(pb);
74         word <<= 8;
75         word |= byte;
76     }
77
78     return word;
79 }
80
81 /*
82  * Process PT/GSTR sound header
83  * return 1 if success, 0 if invalid format, otherwise AVERROR_xxx
84  */
85 static int process_audio_header_elements(AVFormatContext *s)
86 {
87     int inHeader = 1;
88     EaDemuxContext *ea = s->priv_data;
89     ByteIOContext *pb = &s->pb;
90     int compression_type = -1, revision = -1;
91
92     ea->bytes = 2;
93     ea->sample_rate = -1;
94     ea->num_channels = 1;
95
96     while (inHeader) {
97         int inSubheader;
98         uint8_t byte;
99         byte = get_byte(pb);
100
101         switch (byte) {
102         case 0xFD:
103             av_log (s, AV_LOG_INFO, "entered audio subheader\n");
104             inSubheader = 1;
105             while (inSubheader) {
106                 uint8_t subbyte;
107                 subbyte = get_byte(pb);
108
109                 switch (subbyte) {
110                 case 0x80:
111                     revision = read_arbitary(pb);
112                     av_log (s, AV_LOG_INFO, "revision (element 0x80) set to 0x%08x\n", revision);
113                     break;
114                 case 0x82:
115                     ea->num_channels = read_arbitary(pb);
116                     av_log (s, AV_LOG_INFO, "num_channels (element 0x82) set to 0x%08x\n", ea->num_channels);
117                     break;
118                 case 0x83:
119                     compression_type = read_arbitary(pb);
120                     av_log (s, AV_LOG_INFO, "compression_type (element 0x83) set to 0x%08x\n", compression_type);
121                     break;
122                 case 0x84:
123                     ea->sample_rate = read_arbitary(pb);
124                     av_log (s, AV_LOG_INFO, "sample_rate (element 0x84) set to %i\n", ea->sample_rate);
125                     break;
126                 case 0x85:
127                     ea->num_samples = read_arbitary(pb);
128                     av_log (s, AV_LOG_INFO, "num_samples (element 0x85) set to 0x%08x\n", ea->num_samples);
129                     break;
130                 case 0x8A:
131                     av_log (s, AV_LOG_INFO, "element 0x%02x set to 0x%08x\n", subbyte, read_arbitary(pb));
132                     av_log (s, AV_LOG_INFO, "exited audio subheader\n");
133                     inSubheader = 0;
134                     break;
135                 case 0xFF:
136                     av_log (s, AV_LOG_INFO, "end of header block reached (within audio subheader)\n");
137                     inSubheader = 0;
138                     inHeader = 0;
139                     break;
140                 default:
141                     av_log (s, AV_LOG_INFO, "element 0x%02x set to 0x%08x\n", subbyte, read_arbitary(pb));
142                     break;
143                 }
144             }
145             break;
146         case 0xFF:
147             av_log (s, AV_LOG_INFO, "end of header block reached\n");
148             inHeader = 0;
149             break;
150         default:
151             av_log (s, AV_LOG_INFO, "header element 0x%02x set to 0x%08x\n", byte, read_arbitary(pb));
152             break;
153         }
154     }
155
156     switch (compression_type) {
157     case  0: ea->audio_codec = CODEC_ID_PCM_S16LE; break;
158     case  7: ea->audio_codec = CODEC_ID_ADPCM_EA; break;
159     case -1:
160         switch (revision) {
161         case  1: ea->audio_codec = CODEC_ID_ADPCM_EA_R1; break;
162         case  2: ea->audio_codec = CODEC_ID_ADPCM_EA_R2; break;
163         case  3: ea->audio_codec = CODEC_ID_ADPCM_EA_R3; break;
164         default:
165             av_log(s, AV_LOG_ERROR, "unsupported stream type; revision=%i\n", revision);
166             return 0;
167         }
168         break;
169     default:
170         av_log(s, AV_LOG_ERROR, "unsupported stream type; compression_type=%i\n", compression_type);
171         return 0;
172     }
173
174     if (ea->sample_rate == -1)
175         ea->sample_rate = revision==3 ? 48000 : 22050;
176
177     return 1;
178 }
179
180 /*
181  * Process EACS sound header
182  * return 1 if success, 0 if invalid format, otherwise AVERROR_xxx
183  */
184 static int process_audio_header_eacs(AVFormatContext *s)
185 {
186     EaDemuxContext *ea = s->priv_data;
187     ByteIOContext *pb = &s->pb;
188     int compression_type;
189
190     ea->sample_rate  = ea->big_endian ? get_be32(pb) : get_le32(pb);
191     ea->bytes        = get_byte(pb);   /* 1=8-bit, 2=16-bit */
192     ea->num_channels = get_byte(pb);
193     compression_type = get_byte(pb);
194     url_fskip(pb, 13);
195
196     switch (compression_type) {
197     case 0:
198         switch (ea->bytes) {
199         case 1: ea->audio_codec = CODEC_ID_PCM_S8;    break;
200         case 2: ea->audio_codec = CODEC_ID_PCM_S16LE; break;
201         }
202         break;
203     case 1: ea->audio_codec = CODEC_ID_PCM_MULAW; ea->bytes = 1; break;
204     case 2: ea->audio_codec = CODEC_ID_ADPCM_IMA_EA_EACS; break;
205     default:
206         av_log (s, AV_LOG_ERROR, "unsupported stream type; audio compression_type=%i\n", compression_type);
207     }
208
209     return 1;
210 }
211
212 /*
213  * Process SEAD sound header
214  * return 1 if success, 0 if invalid format, otherwise AVERROR_xxx
215  */
216 static int process_audio_header_sead(AVFormatContext *s)
217 {
218     EaDemuxContext *ea = s->priv_data;
219     ByteIOContext *pb = &s->pb;
220
221     ea->sample_rate  = get_le32(pb);
222     ea->bytes        = get_le32(pb);  /* 1=8-bit, 2=16-bit */
223     ea->num_channels = get_le32(pb);
224     ea->audio_codec  = CODEC_ID_ADPCM_IMA_EA_SEAD;
225
226     return 1;
227 }
228
229 static int process_video_header_vp6(AVFormatContext *s)
230 {
231     EaDemuxContext *ea = s->priv_data;
232     ByteIOContext *pb = &s->pb;
233
234     url_fskip(pb, 16);
235     ea->time_base.den = get_le32(pb);
236     ea->time_base.num = get_le32(pb);
237     ea->video_codec = CODEC_ID_VP6;
238
239     return 1;
240 }
241
242 /*
243  * Process EA file header
244  * Returns 1 if the EA file is valid and successfully opened, 0 otherwise
245  */
246 static int process_ea_header(AVFormatContext *s) {
247     uint32_t blockid, size = 0;
248     EaDemuxContext *ea = s->priv_data;
249     ByteIOContext *pb = &s->pb;
250     int i;
251
252     for (i=0; i<5 && (!ea->audio_codec || !ea->video_codec); i++) {
253         unsigned int startpos = url_ftell(pb);
254         int err = 0;
255
256         blockid = get_le32(pb);
257         size = get_le32(pb);
258         if (i == 0)
259             ea->big_endian = size > 0x000FFFFF;
260         if (ea->big_endian)
261             size = bswap_32(size);
262
263         switch (blockid) {
264             case ISNh_TAG:
265                 if (get_le32(pb) != EACS_TAG) {
266                     av_log (s, AV_LOG_ERROR, "unknown 1SNh headerid\n");
267                     return 0;
268                 }
269                 err = process_audio_header_eacs(s);
270                 break;
271
272             case SCHl_TAG :
273                 blockid = get_le32(pb);
274                 if (blockid == GSTR_TAG) {
275                     url_fskip(pb, 4);
276                 } else if (blockid != PT00_TAG) {
277                     av_log (s, AV_LOG_ERROR, "unknown SCHl headerid\n");
278                     return 0;
279                 }
280                 err = process_audio_header_elements(s);
281                 break;
282
283             case SEAD_TAG:
284                 err = process_audio_header_sead(s);
285                 break;
286
287             case MVhd_TAG :
288                 err = process_video_header_vp6(s);
289                 break;
290         }
291
292         if (err < 0) {
293             av_log(s, AV_LOG_ERROR, "error parsing header: %i\n", err);
294             return err;
295         }
296
297         url_fseek(pb, startpos + size, SEEK_SET);
298     }
299
300     url_fseek(pb, 0, SEEK_SET);
301
302     return 1;
303 }
304
305
306 static int ea_probe(AVProbeData *p)
307 {
308     switch (AV_RL32(&p->buf[0])) {
309     case ISNh_TAG:
310     case SCHl_TAG:
311     case SEAD_TAG:
312     case MVhd_TAG:
313         return AVPROBE_SCORE_MAX;
314     }
315     return 0;
316 }
317
318 static int ea_read_header(AVFormatContext *s,
319                           AVFormatParameters *ap)
320 {
321     EaDemuxContext *ea = s->priv_data;
322     AVStream *st;
323
324     if (!process_ea_header(s))
325         return AVERROR(EIO);
326
327     if (ea->video_codec) {
328         /* initialize the video decoder stream */
329         st = av_new_stream(s, 0);
330         if (!st)
331             return AVERROR(ENOMEM);
332         ea->video_stream_index = st->index;
333         st->codec->codec_type = CODEC_TYPE_VIDEO;
334         st->codec->codec_id = ea->video_codec;
335         st->codec->codec_tag = 0;  /* no fourcc */
336         st->codec->time_base = ea->time_base;
337     }
338
339     if (ea->audio_codec) {
340         /* initialize the audio decoder stream */
341         st = av_new_stream(s, 0);
342         if (!st)
343             return AVERROR(ENOMEM);
344         av_set_pts_info(st, 33, 1, ea->sample_rate);
345         st->codec->codec_type = CODEC_TYPE_AUDIO;
346         st->codec->codec_id = ea->audio_codec;
347         st->codec->codec_tag = 0;  /* no tag */
348         st->codec->channels = ea->num_channels;
349         st->codec->sample_rate = ea->sample_rate;
350         st->codec->bits_per_sample = ea->bytes * 8;
351         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
352             st->codec->bits_per_sample / 4;
353         st->codec->block_align = st->codec->channels*st->codec->bits_per_sample;
354         ea->audio_stream_index = st->index;
355         ea->audio_frame_counter = 0;
356     }
357
358     return 1;
359 }
360
361 static int ea_read_packet(AVFormatContext *s,
362                           AVPacket *pkt)
363 {
364     EaDemuxContext *ea = s->priv_data;
365     ByteIOContext *pb = &s->pb;
366     int ret = 0;
367     int packet_read = 0;
368     unsigned int chunk_type, chunk_size;
369     int key = 0;
370
371     while (!packet_read) {
372         chunk_type = get_le32(pb);
373         chunk_size = (ea->big_endian ? get_be32(pb) : get_le32(pb)) - 8;
374
375         switch (chunk_type) {
376         /* audio data */
377         case ISNh_TAG:
378             /* header chunk also contains data; skip over the header portion*/
379             url_fskip(pb, 32);
380             chunk_size -= 32;
381         case ISNd_TAG:
382         case SCDl_TAG:
383         case SNDC_TAG:
384             if (!ea->audio_codec) {
385                 url_fskip(pb, chunk_size);
386                 break;
387             }
388             ret = av_get_packet(pb, pkt, chunk_size);
389             if (ret != chunk_size)
390                 ret = AVERROR(EIO);
391             else {
392                     pkt->stream_index = ea->audio_stream_index;
393                     pkt->pts = 90000;
394                     pkt->pts *= ea->audio_frame_counter;
395                     pkt->pts /= ea->sample_rate;
396
397                     switch (ea->audio_codec) {
398                     case CODEC_ID_ADPCM_EA:
399                     /* 2 samples/byte, 1 or 2 samples per frame depending
400                      * on stereo; chunk also has 12-byte header */
401                     ea->audio_frame_counter += ((chunk_size - 12) * 2) /
402                         ea->num_channels;
403                         break;
404                     default:
405                         ea->audio_frame_counter += chunk_size /
406                             (ea->bytes * ea->num_channels);
407                     }
408             }
409
410             packet_read = 1;
411             break;
412
413         /* ending tag */
414         case 0:
415         case ISNe_TAG:
416         case SCEl_TAG:
417         case SEND_TAG:
418             ret = AVERROR(EIO);
419             packet_read = 1;
420             break;
421
422         case MV0K_TAG:
423             key = PKT_FLAG_KEY;
424         case MV0F_TAG:
425             ret = av_get_packet(pb, pkt, chunk_size);
426             if (ret != chunk_size)
427                 ret = AVERROR_IO;
428             else {
429                 pkt->stream_index = ea->video_stream_index;
430                 pkt->flags |= key;
431             }
432             packet_read = 1;
433             break;
434
435         default:
436             url_fseek(pb, chunk_size, SEEK_CUR);
437             break;
438         }
439     }
440
441     return ret;
442 }
443
444 AVInputFormat ea_demuxer = {
445     "ea",
446     "Electronic Arts Multimedia Format",
447     sizeof(EaDemuxContext),
448     ea_probe,
449     ea_read_header,
450     ea_read_packet,
451 };