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