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;
93 static uint32_t read_arbitrary(AVIOContext *pb)
102 for (i = 0; i < size; i++) {
111 static int process_audio_header_elements(AVFormatContext *s)
113 EaDemuxContext *ea = s->priv_data;
114 AVIOContext *pb = s->pb;
116 int compression_type = -1, revision = -1, revision2 = -1;
119 ea->sample_rate = -1;
120 ea->num_channels = 1;
122 while (!avio_feof(pb) && in_header) {
129 av_log(s, AV_LOG_DEBUG, "entered audio subheader\n");
131 while (!avio_feof(pb) && in_subheader) {
133 subbyte = avio_r8(pb);
137 revision = read_arbitrary(pb);
138 av_log(s, AV_LOG_DEBUG,
139 "revision (element 0x80) set to 0x%08x\n", revision);
142 ea->num_channels = read_arbitrary(pb);
143 av_log(s, AV_LOG_DEBUG,
144 "num_channels (element 0x82) set to 0x%08x\n",
148 compression_type = read_arbitrary(pb);
149 av_log(s, AV_LOG_DEBUG,
150 "compression_type (element 0x83) set to 0x%08x\n",
154 ea->sample_rate = read_arbitrary(pb);
155 av_log(s, AV_LOG_DEBUG,
156 "sample_rate (element 0x84) set to %i\n",
160 ea->num_samples = read_arbitrary(pb);
161 av_log(s, AV_LOG_DEBUG,
162 "num_samples (element 0x85) set to 0x%08x\n",
166 av_log(s, AV_LOG_DEBUG,
167 "element 0x%02x set to 0x%08"PRIx32"\n",
168 subbyte, read_arbitrary(pb));
169 av_log(s, AV_LOG_DEBUG, "exited audio subheader\n");
173 revision2 = read_arbitrary(pb);
174 av_log(s, AV_LOG_DEBUG,
175 "revision2 (element 0xA0) set to 0x%08x\n",
179 av_log(s, AV_LOG_DEBUG,
180 "end of header block reached (within audio subheader)\n");
185 av_log(s, AV_LOG_DEBUG,
186 "element 0x%02x set to 0x%08"PRIx32"\n",
187 subbyte, read_arbitrary(pb));
193 av_log(s, AV_LOG_DEBUG, "end of header block reached\n");
197 av_log(s, AV_LOG_DEBUG,
198 "header element 0x%02x set to 0x%08"PRIx32"\n",
199 byte, read_arbitrary(pb));
204 switch (compression_type) {
206 ea->audio_codec = AV_CODEC_ID_PCM_S16LE;
209 ea->audio_codec = AV_CODEC_ID_ADPCM_EA;
214 ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R1;
217 ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R2;
220 ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R3;
225 avpriv_request_sample(s, "stream type; revision=%i", revision);
230 ea->audio_codec = AV_CODEC_ID_PCM_S16LE_PLANAR;
235 case 2: ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R1; break;
236 case 3: ea->audio_codec = AV_CODEC_ID_ADPCM_EA_R2; break;
238 avpriv_request_sample(s, "stream type; revision=%i, revision2=%i", revision, revision2);
244 ea->audio_codec = AV_CODEC_ID_MP3;
249 ea->audio_codec = AV_CODEC_ID_NONE;
250 avpriv_request_sample(s, "stream type; revision2=%i", revision2);
255 avpriv_request_sample(s,
256 "stream type; compression_type=%i",
261 if (ea->audio_codec == AV_CODEC_ID_NONE && ea->platform == 0x01)
262 ea->audio_codec = AV_CODEC_ID_ADPCM_PSX;
263 if (ea->sample_rate == -1)
264 ea->sample_rate = revision == 3 ? 48000 : 22050;
269 static void process_audio_header_eacs(AVFormatContext *s)
271 EaDemuxContext *ea = s->priv_data;
272 AVIOContext *pb = s->pb;
273 int compression_type;
275 ea->sample_rate = ea->big_endian ? avio_rb32(pb) : avio_rl32(pb);
276 ea->bytes = avio_r8(pb); /* 1=8-bit, 2=16-bit */
277 ea->num_channels = avio_r8(pb);
278 compression_type = avio_r8(pb);
281 switch (compression_type) {
285 ea->audio_codec = AV_CODEC_ID_PCM_S8;
288 ea->audio_codec = AV_CODEC_ID_PCM_S16LE;
293 ea->audio_codec = AV_CODEC_ID_PCM_MULAW;
297 ea->audio_codec = AV_CODEC_ID_ADPCM_IMA_EA_EACS;
300 avpriv_request_sample(s,
301 "stream type; audio compression_type=%i",
306 static void process_audio_header_sead(AVFormatContext *s)
308 EaDemuxContext *ea = s->priv_data;
309 AVIOContext *pb = s->pb;
311 ea->sample_rate = avio_rl32(pb);
312 ea->bytes = avio_rl32(pb); /* 1=8-bit, 2=16-bit */
313 ea->num_channels = avio_rl32(pb);
314 ea->audio_codec = AV_CODEC_ID_ADPCM_IMA_EA_SEAD;
317 static void process_video_header_mdec(AVFormatContext *s, VideoProperties *video)
319 AVIOContext *pb = s->pb;
321 video->width = avio_rl16(pb);
322 video->height = avio_rl16(pb);
323 video->time_base = (AVRational) { 1, 15 };
324 video->codec = AV_CODEC_ID_MDEC;
327 static int process_video_header_vp6(AVFormatContext *s, VideoProperties *video)
329 AVIOContext *pb = s->pb;
332 video->nb_frames = avio_rl32(pb);
334 video->time_base.den = avio_rl32(pb);
335 video->time_base.num = avio_rl32(pb);
336 if (video->time_base.den <= 0 || video->time_base.num <= 0) {
337 av_log(s, AV_LOG_ERROR, "Timebase is invalid\n");
338 return AVERROR_INVALIDDATA;
340 video->codec = AV_CODEC_ID_VP6;
345 static void process_video_header_cmv(AVFormatContext *s, VideoProperties *video)
349 avio_skip(s->pb, 10);
350 fps = avio_rl16(s->pb);
352 video->time_base = (AVRational) { 1, fps };
353 video->codec = AV_CODEC_ID_CMV;
356 /* Process EA file header.
357 * Return 1 if the EA file is valid and successfully opened, 0 otherwise. */
358 static int process_ea_header(AVFormatContext *s)
360 uint32_t blockid, size = 0;
361 EaDemuxContext *ea = s->priv_data;
362 AVIOContext *pb = s->pb;
365 for (i = 0; i < 5 && (!ea->audio_codec || !ea->video.codec); i++) {
366 uint64_t startpos = avio_tell(pb);
369 blockid = avio_rl32(pb);
370 size = avio_rl32(pb);
372 ea->big_endian = size > av_bswap32(size);
374 size = av_bswap32(size);
377 av_log(s, AV_LOG_ERROR, "chunk size too small\n");
378 return AVERROR_INVALIDDATA;
383 if (avio_rl32(pb) != EACS_TAG) {
384 avpriv_request_sample(s, "unknown 1SNh headerid");
387 process_audio_header_eacs(s);
392 blockid = avio_rl32(pb);
393 if (blockid == GSTR_TAG) {
395 } else if ((blockid & 0xFF) != (PT00_TAG & 0xFF)) {
396 blockid = avio_rl32(pb);
398 ea->platform = (blockid >> 16) & 0xFF;
399 err = process_audio_header_elements(s);
403 process_audio_header_sead(s);
407 process_video_header_cmv(s, &ea->video);
411 ea->video.codec = AV_CODEC_ID_TGV;
415 process_video_header_mdec(s, &ea->video);
419 ea->video.codec = AV_CODEC_ID_MPEG2VIDEO;
424 ea->video.codec = AV_CODEC_ID_TGQ;
425 ea->video.time_base = (AVRational) { 1, 15 };
429 ea->video.codec = AV_CODEC_ID_TQI;
430 ea->video.time_base = (AVRational) { 1, 15 };
434 ea->video.codec = AV_CODEC_ID_MAD;
436 ea->video.time_base = (AVRational) { avio_rl16(pb), 1000 };
440 err = process_video_header_vp6(s, &ea->video);
444 err = process_video_header_vp6(s, &ea->alpha);
449 av_log(s, AV_LOG_ERROR, "error parsing header: %i\n", err);
453 avio_seek(pb, startpos + size, SEEK_SET);
456 avio_seek(pb, 0, SEEK_SET);
461 static int ea_probe(AVProbeData *p)
463 unsigned big_endian, size;
465 switch (AV_RL32(&p->buf[0])) {
480 size = AV_RL32(&p->buf[4]);
481 big_endian = size > 0x000FFFFF;
483 size = av_bswap32(size);
484 if (size > 0xfffff || size < 8)
487 return AVPROBE_SCORE_MAX;
490 static int init_video_stream(AVFormatContext *s, VideoProperties *video)
497 /* initialize the video decoder stream */
498 st = avformat_new_stream(s, NULL);
500 return AVERROR(ENOMEM);
501 video->stream_index = st->index;
502 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
503 st->codecpar->codec_id = video->codec;
504 // parsing is necessary to make FFmpeg generate correct timestamps
505 if (st->codecpar->codec_id == AV_CODEC_ID_MPEG2VIDEO)
506 st->need_parsing = AVSTREAM_PARSE_HEADERS;
507 st->codecpar->codec_tag = 0; /* no fourcc */
508 st->codecpar->width = video->width;
509 st->codecpar->height = video->height;
510 st->duration = st->nb_frames = video->nb_frames;
511 if (video->time_base.num)
512 avpriv_set_pts_info(st, 64, video->time_base.num, video->time_base.den);
514 st->avg_frame_rate = av_inv_q(video->time_base);
518 static int ea_read_header(AVFormatContext *s)
520 EaDemuxContext *ea = s->priv_data;
523 if (process_ea_header(s)<=0)
526 if (init_video_stream(s, &ea->video) || init_video_stream(s, &ea->alpha))
527 return AVERROR(ENOMEM);
529 if (ea->audio_codec) {
530 if (ea->num_channels <= 0 || ea->num_channels > 2) {
531 av_log(s, AV_LOG_WARNING,
532 "Unsupported number of channels: %d\n", ea->num_channels);
536 if (ea->sample_rate <= 0) {
537 av_log(s, AV_LOG_ERROR,
538 "Unsupported sample rate: %d\n", ea->sample_rate);
542 if (ea->bytes <= 0 || ea->bytes > 2) {
543 av_log(s, AV_LOG_ERROR,
544 "Invalid number of bytes per sample: %d\n", ea->bytes);
545 ea->audio_codec = AV_CODEC_ID_NONE;
549 /* initialize the audio decoder stream */
550 st = avformat_new_stream(s, NULL);
552 return AVERROR(ENOMEM);
553 avpriv_set_pts_info(st, 33, 1, ea->sample_rate);
554 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
555 st->codecpar->codec_id = ea->audio_codec;
556 st->codecpar->codec_tag = 0; /* no tag */
557 st->codecpar->channels = ea->num_channels;
558 st->codecpar->sample_rate = ea->sample_rate;
559 st->codecpar->bits_per_coded_sample = ea->bytes * 8;
560 st->codecpar->bit_rate = (int64_t)st->codecpar->channels *
561 st->codecpar->sample_rate *
562 st->codecpar->bits_per_coded_sample / 4;
563 st->codecpar->block_align = st->codecpar->channels *
564 st->codecpar->bits_per_coded_sample;
565 ea->audio_stream_index = st->index;
572 static int ea_read_packet(AVFormatContext *s, AVPacket *pkt)
574 EaDemuxContext *ea = s->priv_data;
575 AVIOContext *pb = s->pb;
576 int partial_packet = 0;
577 unsigned int chunk_type, chunk_size;
578 int ret = 0, packet_read = 0, key = 0;
579 int av_uninit(num_samples);
581 while (!packet_read || partial_packet) {
582 chunk_type = avio_rl32(pb);
583 chunk_size = ea->big_endian ? avio_rb32(pb) : avio_rl32(pb);
585 return AVERROR_INVALIDDATA;
588 switch (chunk_type) {
591 /* header chunk also contains data; skip over the header portion */
593 return AVERROR_INVALIDDATA;
600 if (!ea->audio_codec) {
601 avio_skip(pb, chunk_size);
603 } else if (ea->audio_codec == AV_CODEC_ID_PCM_S16LE_PLANAR ||
604 ea->audio_codec == AV_CODEC_ID_MP3) {
605 num_samples = avio_rl32(pb);
608 } else if (ea->audio_codec == AV_CODEC_ID_ADPCM_PSX) {
613 if (partial_packet) {
614 avpriv_request_sample(s, "video header followed by audio packet");
615 av_packet_unref(pkt);
622 ret = av_get_packet(pb, pkt, chunk_size);
625 pkt->stream_index = ea->audio_stream_index;
627 switch (ea->audio_codec) {
628 case AV_CODEC_ID_ADPCM_EA:
629 case AV_CODEC_ID_ADPCM_EA_R1:
630 case AV_CODEC_ID_ADPCM_EA_R2:
631 case AV_CODEC_ID_ADPCM_IMA_EA_EACS:
632 case AV_CODEC_ID_ADPCM_EA_R3:
634 av_log(s, AV_LOG_ERROR, "Packet is too short\n");
635 av_packet_unref(pkt);
636 return AVERROR_INVALIDDATA;
638 if (ea->audio_codec == AV_CODEC_ID_ADPCM_EA_R3)
639 pkt->duration = AV_RB32(pkt->data);
641 pkt->duration = AV_RL32(pkt->data);
643 case AV_CODEC_ID_ADPCM_IMA_EA_SEAD:
644 pkt->duration = ret * 2 / ea->num_channels;
646 case AV_CODEC_ID_PCM_S16LE_PLANAR:
647 case AV_CODEC_ID_MP3:
648 pkt->duration = num_samples;
650 case AV_CODEC_ID_ADPCM_PSX:
651 pkt->duration = chunk_size / (16 * ea->num_channels) * 28;
654 pkt->duration = chunk_size / (ea->bytes * ea->num_channels);
666 while (!avio_feof(pb)) {
667 int tag = avio_rl32(pb);
669 if (tag == ISNh_TAG ||
687 key = AV_PKT_FLAG_KEY;
692 avio_seek(pb, -8, SEEK_CUR); // include chunk preamble
694 goto get_video_packet;
698 return AVERROR_INVALIDDATA;
700 avio_skip(pb, 8); // skip ea DCT header
702 goto get_video_packet;
708 key = AV_PKT_FLAG_KEY;
715 if (partial_packet) {
716 ret = av_append_packet(pb, pkt, chunk_size);
718 ret = av_get_packet(pb, pkt, chunk_size);
723 partial_packet = chunk_type == MVIh_TAG;
724 if (chunk_type == AV0K_TAG || chunk_type == AV0F_TAG)
725 pkt->stream_index = ea->alpha.stream_index;
727 pkt->stream_index = ea->video.stream_index;
733 avio_skip(pb, chunk_size);
738 if (ret < 0 && partial_packet)
739 av_packet_unref(pkt);
743 AVInputFormat ff_ea_demuxer = {
745 .long_name = NULL_IF_CONFIG_SMALL("Electronic Arts Multimedia"),
746 .priv_data_size = sizeof(EaDemuxContext),
747 .read_probe = ea_probe,
748 .read_header = ea_read_header,
749 .read_packet = ea_read_packet,