1 /* Electronic Arts Multimedia File Demuxer
2 * Copyright (c) 2004 The FFmpeg Project
3 * Copyright (c) 2006-2008 Peter Ross
5 * This file is part of FFmpeg.
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.
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.
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
24 * Electronic Arts Multimedia file demuxer (WVE/UV2/etc.)
25 * by Robin Kay (komadori at gekkou.co.uk)
30 #include "libavutil/intreadwrite.h"
34 #define SCHl_TAG MKTAG('S', 'C', 'H', 'l')
35 #define SEAD_TAG MKTAG('S', 'E', 'A', 'D') /* Sxxx header */
36 #define SNDC_TAG MKTAG('S', 'N', 'D', 'C') /* Sxxx data */
37 #define SEND_TAG MKTAG('S', 'E', 'N', 'D') /* Sxxx end */
38 #define SHEN_TAG MKTAG('S', 'H', 'E', 'N') /* SxEN header */
39 #define SDEN_TAG MKTAG('S', 'D', 'E', 'N') /* SxEN data */
40 #define SEEN_TAG MKTAG('S', 'E', 'E', 'N') /* SxEN end */
41 #define ISNh_TAG MKTAG('1', 'S', 'N', 'h') /* 1SNx header */
42 #define EACS_TAG MKTAG('E', 'A', 'C', 'S')
43 #define ISNd_TAG MKTAG('1', 'S', 'N', 'd') /* 1SNx data */
44 #define ISNe_TAG MKTAG('1', 'S', 'N', 'e') /* 1SNx end */
45 #define PT00_TAG MKTAG('P', 'T', 0x0, 0x0)
46 #define GSTR_TAG MKTAG('G', 'S', 'T', 'R')
47 #define SCDl_TAG MKTAG('S', 'C', 'D', 'l')
48 #define SCEl_TAG MKTAG('S', 'C', 'E', 'l')
49 #define kVGT_TAG MKTAG('k', 'V', 'G', 'T') /* TGV I-frame */
50 #define fVGT_TAG MKTAG('f', 'V', 'G', 'T') /* TGV P-frame */
51 #define mTCD_TAG MKTAG('m', 'T', 'C', 'D') /* MDEC */
52 #define MADk_TAG MKTAG('M', 'A', 'D', 'k') /* MAD I-frame */
53 #define MADm_TAG MKTAG('M', 'A', 'D', 'm') /* MAD P-frame */
54 #define MADe_TAG MKTAG('M', 'A', 'D', 'e') /* MAD lqp-frame */
55 #define MPCh_TAG MKTAG('M', 'P', 'C', 'h') /* MPEG-2 */
56 #define TGQs_TAG MKTAG('T', 'G', 'Q', 's') /* TGQ I-frame (appears in .TGQ files) */
57 #define pQGT_TAG MKTAG('p', 'Q', 'G', 'T') /* TGQ I-frame (appears in .UV files) */
58 #define pIQT_TAG MKTAG('p', 'I', 'Q', 'T') /* TQI/UV2 I-frame (.UV2/.WVE) */
59 #define MVhd_TAG MKTAG('M', 'V', 'h', 'd')
60 #define MV0K_TAG MKTAG('M', 'V', '0', 'K')
61 #define MV0F_TAG MKTAG('M', 'V', '0', 'F')
62 #define AVhd_TAG MKTAG('A', 'V', 'h', 'd')
63 #define AV0K_TAG MKTAG('A', 'V', '0', 'K')
64 #define AV0F_TAG MKTAG('A', 'V', '0', 'F')
65 #define MVIh_TAG MKTAG('M', 'V', 'I', 'h') /* CMV header */
66 #define MVIf_TAG MKTAG('M', 'V', 'I', 'f') /* CMV I-frame */
67 #define AVP6_TAG MKTAG('A', 'V', 'P', '6')
69 typedef struct VideoProperties {
77 typedef struct EaDemuxContext {
80 VideoProperties video, alpha;
82 enum AVCodecID audio_codec;
83 int audio_stream_index;
91 static uint32_t read_arbitrary(AVIOContext *pb)
100 for (i = 0; i < size; i++) {
109 static int process_audio_header_elements(AVFormatContext *s)
111 EaDemuxContext *ea = s->priv_data;
112 AVIOContext *pb = s->pb;
114 int compression_type = -1, revision = -1, revision2 = -1;
117 ea->sample_rate = -1;
118 ea->num_channels = 1;
120 while (!avio_feof(pb) && in_header) {
127 av_log(s, AV_LOG_DEBUG, "entered audio subheader\n");
129 while (!avio_feof(pb) && in_subheader) {
131 subbyte = avio_r8(pb);
135 revision = read_arbitrary(pb);
136 av_log(s, AV_LOG_DEBUG,
137 "revision (element 0x80) set to 0x%08x\n", revision);
140 ea->num_channels = read_arbitrary(pb);
141 av_log(s, AV_LOG_DEBUG,
142 "num_channels (element 0x82) set to 0x%08x\n",
146 compression_type = read_arbitrary(pb);
147 av_log(s, AV_LOG_DEBUG,
148 "compression_type (element 0x83) set to 0x%08x\n",
152 ea->sample_rate = read_arbitrary(pb);
153 av_log(s, AV_LOG_DEBUG,
154 "sample_rate (element 0x84) set to %i\n",
158 ea->num_samples = read_arbitrary(pb);
159 av_log(s, AV_LOG_DEBUG,
160 "num_samples (element 0x85) set to 0x%08x\n",
164 av_log(s, AV_LOG_DEBUG,
165 "element 0x%02x set to 0x%08"PRIx32"\n",
166 subbyte, read_arbitrary(pb));
167 av_log(s, AV_LOG_DEBUG, "exited audio subheader\n");
171 revision2 = read_arbitrary(pb);
172 av_log(s, AV_LOG_DEBUG,
173 "revision2 (element 0xA0) set to 0x%08x\n",
177 av_log(s, AV_LOG_DEBUG,
178 "end of header block reached (within audio subheader)\n");
183 av_log(s, AV_LOG_DEBUG,
184 "element 0x%02x set to 0x%08"PRIx32"\n",
185 subbyte, read_arbitrary(pb));
191 av_log(s, AV_LOG_DEBUG, "end of header block reached\n");
195 av_log(s, AV_LOG_DEBUG,
196 "header element 0x%02x set to 0x%08"PRIx32"\n",
197 byte, read_arbitrary(pb));
202 switch (compression_type) {
204 ea->audio_codec = AV_CODEC_ID_PCM_S16LE;
207 ea->audio_codec = AV_CODEC_ID_ADPCM_EA;
212 ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R1;
215 ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R2;
218 ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R3;
223 avpriv_request_sample(s, "stream type; revision=%i", revision);
228 ea->audio_codec = AV_CODEC_ID_PCM_S16LE_PLANAR;
233 case 2: ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R1; break;
234 case 3: ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R2; break;
236 avpriv_request_sample(s, "stream type; revision=%i, revision2=%i", revision, revision2);
241 ea->audio_codec = AV_CODEC_ID_MP3;
246 ea->audio_codec = AV_CODEC_ID_NONE;
247 avpriv_request_sample(s, "stream type; revision2=%i", revision2);
252 avpriv_request_sample(s,
253 "stream type; compression_type=%i",
258 if (ea->sample_rate == -1)
259 ea->sample_rate = revision == 3 ? 48000 : 22050;
264 static void process_audio_header_eacs(AVFormatContext *s)
266 EaDemuxContext *ea = s->priv_data;
267 AVIOContext *pb = s->pb;
268 int compression_type;
270 ea->sample_rate = ea->big_endian ? avio_rb32(pb) : avio_rl32(pb);
271 ea->bytes = avio_r8(pb); /* 1=8-bit, 2=16-bit */
272 ea->num_channels = avio_r8(pb);
273 compression_type = avio_r8(pb);
276 switch (compression_type) {
280 ea->audio_codec = AV_CODEC_ID_PCM_S8;
283 ea->audio_codec = AV_CODEC_ID_PCM_S16LE;
288 ea->audio_codec = AV_CODEC_ID_PCM_MULAW;
292 ea->audio_codec = AV_CODEC_ID_ADPCM_IMA_EA_EACS;
295 avpriv_request_sample(s,
296 "stream type; audio compression_type=%i",
301 static void process_audio_header_sead(AVFormatContext *s)
303 EaDemuxContext *ea = s->priv_data;
304 AVIOContext *pb = s->pb;
306 ea->sample_rate = avio_rl32(pb);
307 ea->bytes = avio_rl32(pb); /* 1=8-bit, 2=16-bit */
308 ea->num_channels = avio_rl32(pb);
309 ea->audio_codec = AV_CODEC_ID_ADPCM_IMA_EA_SEAD;
312 static void process_video_header_mdec(AVFormatContext *s, VideoProperties *video)
314 AVIOContext *pb = s->pb;
316 video->width = avio_rl16(pb);
317 video->height = avio_rl16(pb);
318 video->time_base = (AVRational) { 1, 15 };
319 video->codec = AV_CODEC_ID_MDEC;
322 static int process_video_header_vp6(AVFormatContext *s, VideoProperties *video)
324 AVIOContext *pb = s->pb;
327 video->nb_frames = avio_rl32(pb);
329 video->time_base.den = avio_rl32(pb);
330 video->time_base.num = avio_rl32(pb);
331 if (video->time_base.den <= 0 || video->time_base.num <= 0) {
332 av_log(s, AV_LOG_ERROR, "Timebase is invalid\n");
333 return AVERROR_INVALIDDATA;
335 video->codec = AV_CODEC_ID_VP6;
340 static void process_video_header_cmv(AVFormatContext *s, VideoProperties *video)
344 avio_skip(s->pb, 10);
345 fps = avio_rl16(s->pb);
347 video->time_base = (AVRational) { 1, fps };
348 video->codec = AV_CODEC_ID_CMV;
351 /* Process EA file header.
352 * Return 1 if the EA file is valid and successfully opened, 0 otherwise. */
353 static int process_ea_header(AVFormatContext *s)
355 uint32_t blockid, size = 0;
356 EaDemuxContext *ea = s->priv_data;
357 AVIOContext *pb = s->pb;
360 for (i = 0; i < 5 && (!ea->audio_codec || !ea->video.codec); i++) {
361 uint64_t startpos = avio_tell(pb);
364 blockid = avio_rl32(pb);
365 size = avio_rl32(pb);
367 ea->big_endian = size > av_bswap32(size);
369 size = av_bswap32(size);
372 av_log(s, AV_LOG_ERROR, "chunk size too small\n");
373 return AVERROR_INVALIDDATA;
378 if (avio_rl32(pb) != EACS_TAG) {
379 avpriv_request_sample(s, "unknown 1SNh headerid");
382 process_audio_header_eacs(s);
387 blockid = avio_rl32(pb);
388 if (blockid == GSTR_TAG) {
390 } else if ((blockid & 0xFFFF) != PT00_TAG) {
391 avpriv_request_sample(s, "unknown SCHl headerid");
394 err = process_audio_header_elements(s);
398 process_audio_header_sead(s);
402 process_video_header_cmv(s, &ea->video);
406 ea->video.codec = AV_CODEC_ID_TGV;
410 process_video_header_mdec(s, &ea->video);
414 ea->video.codec = AV_CODEC_ID_MPEG2VIDEO;
419 ea->video.codec = AV_CODEC_ID_TGQ;
420 ea->video.time_base = (AVRational) { 1, 15 };
424 ea->video.codec = AV_CODEC_ID_TQI;
425 ea->video.time_base = (AVRational) { 1, 15 };
429 ea->video.codec = AV_CODEC_ID_MAD;
431 ea->video.time_base = (AVRational) { avio_rl16(pb), 1000 };
435 err = process_video_header_vp6(s, &ea->video);
439 err = process_video_header_vp6(s, &ea->alpha);
444 av_log(s, AV_LOG_ERROR, "error parsing header: %i\n", err);
448 avio_seek(pb, startpos + size, SEEK_SET);
451 avio_seek(pb, 0, SEEK_SET);
456 static int ea_probe(AVProbeData *p)
458 unsigned big_endian, size;
460 switch (AV_RL32(&p->buf[0])) {
475 size = AV_RL32(&p->buf[4]);
476 big_endian = size > 0x000FFFFF;
478 size = av_bswap32(size);
479 if (size > 0xfffff || size < 8)
482 return AVPROBE_SCORE_MAX;
485 static int init_video_stream(AVFormatContext *s, VideoProperties *video)
492 /* initialize the video decoder stream */
493 st = avformat_new_stream(s, NULL);
495 return AVERROR(ENOMEM);
496 video->stream_index = st->index;
497 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
498 st->codec->codec_id = video->codec;
499 // parsing is necessary to make FFmpeg generate correct timestamps
500 if (st->codec->codec_id == AV_CODEC_ID_MPEG2VIDEO)
501 st->need_parsing = AVSTREAM_PARSE_HEADERS;
502 st->codec->codec_tag = 0; /* no fourcc */
503 st->codec->width = video->width;
504 st->codec->height = video->height;
505 st->duration = st->nb_frames = video->nb_frames;
506 if (video->time_base.num)
507 avpriv_set_pts_info(st, 64, video->time_base.num, video->time_base.den);
509 st->avg_frame_rate = av_inv_q(video->time_base);
513 static int ea_read_header(AVFormatContext *s)
515 EaDemuxContext *ea = s->priv_data;
518 if (process_ea_header(s)<=0)
521 if (init_video_stream(s, &ea->video) || init_video_stream(s, &ea->alpha))
522 return AVERROR(ENOMEM);
524 if (ea->audio_codec) {
525 if (ea->num_channels <= 0 || ea->num_channels > 2) {
526 av_log(s, AV_LOG_WARNING,
527 "Unsupported number of channels: %d\n", ea->num_channels);
531 if (ea->sample_rate <= 0) {
532 av_log(s, AV_LOG_ERROR,
533 "Unsupported sample rate: %d\n", ea->sample_rate);
537 if (ea->bytes <= 0) {
538 av_log(s, AV_LOG_ERROR,
539 "Invalid number of bytes per sample: %d\n", ea->bytes);
540 ea->audio_codec = AV_CODEC_ID_NONE;
544 /* initialize the audio decoder stream */
545 st = avformat_new_stream(s, NULL);
547 return AVERROR(ENOMEM);
548 avpriv_set_pts_info(st, 33, 1, ea->sample_rate);
549 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
550 st->codec->codec_id = ea->audio_codec;
551 st->codec->codec_tag = 0; /* no tag */
552 st->codec->channels = ea->num_channels;
553 st->codec->sample_rate = ea->sample_rate;
554 st->codec->bits_per_coded_sample = ea->bytes * 8;
555 st->codec->bit_rate = st->codec->channels *
556 st->codec->sample_rate *
557 st->codec->bits_per_coded_sample / 4;
558 st->codec->block_align = st->codec->channels *
559 st->codec->bits_per_coded_sample;
560 ea->audio_stream_index = st->index;
567 static int ea_read_packet(AVFormatContext *s, AVPacket *pkt)
569 EaDemuxContext *ea = s->priv_data;
570 AVIOContext *pb = s->pb;
571 int partial_packet = 0;
572 unsigned int chunk_type, chunk_size;
573 int ret = 0, packet_read = 0, key = 0;
574 int av_uninit(num_samples);
576 while (!packet_read || partial_packet) {
577 chunk_type = avio_rl32(pb);
578 chunk_size = ea->big_endian ? avio_rb32(pb) : avio_rl32(pb);
580 return AVERROR_INVALIDDATA;
583 switch (chunk_type) {
586 /* header chunk also contains data; skip over the header portion */
588 return AVERROR_INVALIDDATA;
595 if (!ea->audio_codec) {
596 avio_skip(pb, chunk_size);
598 } else if (ea->audio_codec == AV_CODEC_ID_PCM_S16LE_PLANAR ||
599 ea->audio_codec == AV_CODEC_ID_MP3) {
600 num_samples = avio_rl32(pb);
605 if (partial_packet) {
606 avpriv_request_sample(s, "video header followed by audio packet");
614 ret = av_get_packet(pb, pkt, chunk_size);
617 pkt->stream_index = ea->audio_stream_index;
619 switch (ea->audio_codec) {
620 case AV_CODEC_ID_ADPCM_EA:
621 case AV_CODEC_ID_ADPCM_EA_R1:
622 case AV_CODEC_ID_ADPCM_EA_R2:
623 case AV_CODEC_ID_ADPCM_IMA_EA_EACS:
624 case AV_CODEC_ID_ADPCM_EA_R3:
626 av_log(s, AV_LOG_ERROR, "Packet is too short\n");
628 return AVERROR_INVALIDDATA;
630 if (ea->audio_codec == AV_CODEC_ID_ADPCM_EA_R3)
631 pkt->duration = AV_RB32(pkt->data);
633 pkt->duration = AV_RL32(pkt->data);
635 case AV_CODEC_ID_ADPCM_IMA_EA_SEAD:
636 pkt->duration = ret * 2 / ea->num_channels;
638 case AV_CODEC_ID_PCM_S16LE_PLANAR:
639 case AV_CODEC_ID_MP3:
640 pkt->duration = num_samples;
643 pkt->duration = chunk_size / (ea->bytes * ea->num_channels);
664 key = AV_PKT_FLAG_KEY;
669 avio_seek(pb, -8, SEEK_CUR); // include chunk preamble
671 goto get_video_packet;
675 return AVERROR_INVALIDDATA;
677 avio_skip(pb, 8); // skip ea DCT header
679 goto get_video_packet;
685 key = AV_PKT_FLAG_KEY;
692 if (partial_packet) {
693 ret = av_append_packet(pb, pkt, chunk_size);
695 ret = av_get_packet(pb, pkt, chunk_size);
700 partial_packet = chunk_type == MVIh_TAG;
701 if (chunk_type == AV0K_TAG || chunk_type == AV0F_TAG)
702 pkt->stream_index = ea->alpha.stream_index;
704 pkt->stream_index = ea->video.stream_index;
710 avio_skip(pb, chunk_size);
715 if (ret < 0 && partial_packet)
720 AVInputFormat ff_ea_demuxer = {
722 .long_name = NULL_IF_CONFIG_SMALL("Electronic Arts Multimedia"),
723 .priv_data_size = sizeof(EaDemuxContext),
724 .read_probe = ea_probe,
725 .read_header = ea_read_header,
726 .read_packet = ea_read_packet,