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