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