git.sesse.net Git - ffmpeg/blob - 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
  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 (!url_feof(pb) && 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 (!url_feof(pb) && 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 /*
 287  * Process EA file header
 288  * Returns 1 if the EA file is valid and successfully opened, 0 otherwise
 289  */
 290 static int process_ea_header(AVFormatContext *s) {
 291     uint32_t blockid, size = 0;
 292     EaDemuxContext *ea = s->priv_data;
 293     AVIOContext *pb = s->pb;
 294     int i;
 295
 296     for (i=0; i<5 && (!ea->audio_codec || !ea->video_codec); i++) {
 297         unsigned int startpos = avio_tell(pb);
 298         int err = 0;
 299
 300         blockid = avio_rl32(pb);
 301         size = avio_rl32(pb);
 302         if (i == 0)
 303             ea->big_endian = size > 0x000FFFFF;
 304         if (ea->big_endian)
 305             size = av_bswap32(size);
 306
 307         switch (blockid) {
 308             case ISNh_TAG:
 309                 if (avio_rl32(pb) != EACS_TAG) {
 310                     av_log (s, AV_LOG_ERROR, "unknown 1SNh headerid\n");
 311                     return 0;
 312                 }
 313                 err = process_audio_header_eacs(s);
 314                 break;
 315
 316             case SCHl_TAG :
 317             case SHEN_TAG :
 318                 blockid = avio_rl32(pb);
 319                 if (blockid == GSTR_TAG) {
 320                     avio_skip(pb, 4);
 321                 } else if ((blockid & 0xFFFF)!=PT00_TAG) {
 322                     av_log (s, AV_LOG_ERROR, "unknown SCHl headerid\n");
 323                     return 0;
 324                 }
 325                 err = process_audio_header_elements(s);
 326                 break;
 327
 328             case SEAD_TAG:
 329                 err = process_audio_header_sead(s);
 330                 break;
 331
 332             case MVIh_TAG :
 333                 ea->video_codec = CODEC_ID_CMV;
 334                 break;
 335
 336             case kVGT_TAG:
 337                 ea->video_codec = CODEC_ID_TGV;
 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         avio_seek(pb, startpos + size, SEEK_SET);
 372     }
 373
 374     avio_seek(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         break;
 393     default:
 394         return 0;
 395     }
 396     if (AV_RL32(&p->buf[4]) > 0xfffff && AV_RB32(&p->buf[4]) > 0xfffff)
 397         return 0;
 398     return AVPROBE_SCORE_MAX;
 399 }
 400
 401 static int ea_read_header(AVFormatContext *s,
 402                           AVFormatParameters *ap)
 403 {
 404     EaDemuxContext *ea = s->priv_data;
 405     AVStream *st;
 406
 407     if (!process_ea_header(s))
 408         return AVERROR(EIO);
 409
 410     if (ea->video_codec) {
 411         /* initialize the video decoder stream */
 412         st = avformat_new_stream(s, NULL);
 413         if (!st)
 414             return AVERROR(ENOMEM);
 415         ea->video_stream_index = st->index;
 416         st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
 417         st->codec->codec_id = ea->video_codec;
 418         // parsing is necessary to make FFmpeg generate correct timestamps
 419         if (st->codec->codec_id == CODEC_ID_MPEG2VIDEO)
 420             st->need_parsing = AVSTREAM_PARSE_HEADERS;
 421         st->codec->codec_tag = 0;  /* no fourcc */
 422         if (ea->time_base.num)
 423             avpriv_set_pts_info(st, 64, ea->time_base.num, ea->time_base.den);
 424         st->codec->width = ea->width;
 425         st->codec->height = ea->height;
 426     }
 427
 428     if (ea->audio_codec) {
 429         if (ea->num_channels <= 0) {
 430             av_log(s, AV_LOG_WARNING, "Unsupported number of channels: %d\n", ea->num_channels);
 431             ea->audio_codec = 0;
 432             return 1;
 433         }
 434         if (ea->sample_rate <= 0) {
 435             av_log(s, AV_LOG_ERROR, "Unsupported sample rate: %d\n", ea->sample_rate);
 436             ea->audio_codec = 0;
 437             return 1;
 438         }
 439
 440         /* initialize the audio decoder stream */
 441         st = avformat_new_stream(s, NULL);
 442         if (!st)
 443             return AVERROR(ENOMEM);
 444         avpriv_set_pts_info(st, 33, 1, ea->sample_rate);
 445         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
 446         st->codec->codec_id = ea->audio_codec;
 447         st->codec->codec_tag = 0;  /* no tag */
 448         st->codec->channels = ea->num_channels;
 449         st->codec->sample_rate = ea->sample_rate;
 450         st->codec->bits_per_coded_sample = ea->bytes * 8;
 451         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
 452             st->codec->bits_per_coded_sample / 4;
 453         st->codec->block_align = st->codec->channels*st->codec->bits_per_coded_sample;
 454         ea->audio_stream_index = st->index;
 455         ea->audio_frame_counter = 0;
 456     }
 457
 458     return 1;
 459 }
 460
 461 static int ea_read_packet(AVFormatContext *s,
 462                           AVPacket *pkt)
 463 {
 464     EaDemuxContext *ea = s->priv_data;
 465     AVIOContext *pb = s->pb;
 466     int ret = 0;
 467     int packet_read = 0;
 468     unsigned int chunk_type, chunk_size;
 469     int key = 0;
 470     int av_uninit(num_samples);
 471
 472     while (!packet_read) {
 473         chunk_type = avio_rl32(pb);
 474         chunk_size = (ea->big_endian ? avio_rb32(pb) : avio_rl32(pb)) - 8;
 475
 476         switch (chunk_type) {
 477         /* audio data */
 478         case ISNh_TAG:
 479             /* header chunk also contains data; skip over the header portion*/
 480             avio_skip(pb, 32);
 481             chunk_size -= 32;
 482         case ISNd_TAG:
 483         case SCDl_TAG:
 484         case SNDC_TAG:
 485         case SDEN_TAG:
 486             if (!ea->audio_codec) {
 487                 avio_skip(pb, chunk_size);
 488                 break;
 489             } else if (ea->audio_codec == CODEC_ID_PCM_S16LE_PLANAR ||
 490                        ea->audio_codec == CODEC_ID_MP3) {
 491                 num_samples = avio_rl32(pb);
 492                 avio_skip(pb, 8);
 493                 chunk_size -= 12;
 494             }
 495             ret = av_get_packet(pb, pkt, chunk_size);
 496             if (ret < 0)
 497                 return ret;
 498             pkt->stream_index = ea->audio_stream_index;
 499             pkt->pts = 90000;
 500             pkt->pts *= ea->audio_frame_counter;
 501             pkt->pts /= ea->sample_rate;
 502
 503             switch (ea->audio_codec) {
 504             case CODEC_ID_ADPCM_EA:
 505                 /* 2 samples/byte, 1 or 2 samples per frame depending
 506                  * on stereo; chunk also has 12-byte header */
 507                 ea->audio_frame_counter += ((chunk_size - 12) * 2) /
 508                     ea->num_channels;
 509                 break;
 510             case CODEC_ID_PCM_S16LE_PLANAR:
 511             case CODEC_ID_MP3:
 512                 ea->audio_frame_counter += num_samples;
 513                 break;
 514             default:
 515                 ea->audio_frame_counter += chunk_size /
 516                     (ea->bytes * ea->num_channels);
 517             }
 518
 519             packet_read = 1;
 520             break;
 521
 522         /* ending tag */
 523         case 0:
 524         case ISNe_TAG:
 525         case SCEl_TAG:
 526         case SEND_TAG:
 527         case SEEN_TAG:
 528             ret = AVERROR(EIO);
 529             packet_read = 1;
 530             break;
 531
 532         case MVIh_TAG:
 533         case kVGT_TAG:
 534         case pQGT_TAG:
 535         case TGQs_TAG:
 536         case MADk_TAG:
 537             key = AV_PKT_FLAG_KEY;
 538         case MVIf_TAG:
 539         case fVGT_TAG:
 540         case MADm_TAG:
 541         case MADe_TAG:
 542             avio_seek(pb, -8, SEEK_CUR);     // include chunk preamble
 543             chunk_size += 8;
 544             goto get_video_packet;
 545
 546         case mTCD_TAG:
 547             avio_skip(pb, 8);  // skip ea dct header
 548             chunk_size -= 8;
 549             goto get_video_packet;
 550
 551         case MV0K_TAG:
 552         case MPCh_TAG:
 553         case pIQT_TAG:
 554             key = AV_PKT_FLAG_KEY;
 555         case MV0F_TAG:
 556 get_video_packet:
 557             ret = av_get_packet(pb, pkt, chunk_size);
 558             if (ret < 0)
 559                 return ret;
 560             pkt->stream_index = ea->video_stream_index;
 561             pkt->flags |= key;
 562             packet_read = 1;
 563             break;
 564
 565         default:
 566             avio_skip(pb, chunk_size);
 567             break;
 568         }
 569     }
 570
 571     return ret;
 572 }
 573
 574 AVInputFormat ff_ea_demuxer = {
 575     .name           = "ea",
 576     .long_name      = NULL_IF_CONFIG_SMALL("Electronic Arts Multimedia Format"),
 577     .priv_data_size = sizeof(EaDemuxContext),
 578     .read_probe     = ea_probe,
 579     .read_header    = ea_read_header,
 580     .read_packet    = ea_read_packet,
 581 };