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