git.sesse.net Git - ffmpeg/blob - libavformat/xmv.c

   1 /*
   2  * Microsoft XMV demuxer
   3  * Copyright (c) 2011 Sven Hesse <drmccoy@drmccoy.de>
   4  * Copyright (c) 2011 Matthew Hoops <clone2727@gmail.com>
   5  *
   6  * This file is part of FFmpeg.
   7  *
   8  * FFmpeg is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * FFmpeg is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with FFmpeg; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 /**
  24  * @file
  25  * Microsoft XMV demuxer
  26  */
  27
  28 #include <stdint.h>
  29
  30 #include "libavutil/intreadwrite.h"
  31
  32 #include "avformat.h"
  33 #include "internal.h"
  34 #include "riff.h"
  35
  36 /** The min size of an XMV header. */
  37 #define XMV_MIN_HEADER_SIZE 36
  38
  39 /** Audio flag: ADPCM'd 5.1 stream, front left / right channels */
  40 #define XMV_AUDIO_ADPCM51_FRONTLEFTRIGHT 1
  41 /** Audio flag: ADPCM'd 5.1 stream, front center / low frequency channels */
  42 #define XMV_AUDIO_ADPCM51_FRONTCENTERLOW 2
  43 /** Audio flag: ADPCM'd 5.1 stream, rear left / right channels */
  44 #define XMV_AUDIO_ADPCM51_REARLEFTRIGHT  4
  45
  46 /** Audio flag: Any of the ADPCM'd 5.1 stream flags. */
  47 #define XMV_AUDIO_ADPCM51 (XMV_AUDIO_ADPCM51_FRONTLEFTRIGHT | \
  48                            XMV_AUDIO_ADPCM51_FRONTCENTERLOW | \
  49                            XMV_AUDIO_ADPCM51_REARLEFTRIGHT)
  50
  51 /** A video packet with an XMV file. */
  52 typedef struct XMVVideoPacket {
  53     int stream_index; ///< The decoder stream index for this video packet.
  54
  55     uint32_t data_size;   ///< The size of the remaining video data.
  56     uint64_t data_offset; ///< The offset of the video data within the file.
  57
  58     uint32_t current_frame; ///< The current frame within this video packet.
  59     uint32_t frame_count;   ///< The amount of frames within this video packet.
  60
  61     int     has_extradata; ///< Does the video packet contain extra data?
  62     uint8_t extradata[4];  ///< The extra data
  63
  64     int64_t last_pts; ///< PTS of the last video frame.
  65     int64_t pts;      ///< PTS of the most current video frame.
  66 } XMVVideoPacket;
  67
  68 /** An audio packet with an XMV file. */
  69 typedef struct XMVAudioPacket {
  70     int stream_index; ///< The decoder stream index for this audio packet.
  71
  72     /* Stream format properties. */
  73     uint16_t compression;     ///< The type of compression.
  74     uint16_t channels;        ///< Number of channels.
  75     uint32_t sample_rate;     ///< Sampling rate.
  76     uint16_t bits_per_sample; ///< Bits per compressed sample.
  77     uint32_t bit_rate;        ///< Bits of compressed data per second.
  78     uint16_t flags;           ///< Flags
  79     uint16_t block_align;     ///< Bytes per compressed block.
  80     uint16_t block_samples;   ///< Decompressed samples per compressed block.
  81
  82     enum CodecID codec_id; ///< The codec ID of the compression scheme.
  83
  84     uint32_t data_size;   ///< The size of the remaining audio data.
  85     uint64_t data_offset; ///< The offset of the audio data within the file.
  86
  87     uint32_t frame_size; ///< Number of bytes to put into an audio frame.
  88
  89     uint64_t block_count; ///< Running counter of decompressed audio block.
  90 } XMVAudioPacket;
  91
  92 /** Context for demuxing an XMV file. */
  93 typedef struct XMVDemuxContext {
  94     uint16_t audio_track_count; ///< Number of audio track in this file.
  95
  96     uint32_t this_packet_size; ///< Size of the current packet.
  97     uint32_t next_packet_size; ///< Size of the next packet.
  98
  99     uint64_t this_packet_offset; ///< Offset of the current packet.
 100     uint64_t next_packet_offset; ///< Offset of the next packet.
 101
 102     uint16_t current_stream; ///< The index of the stream currently handling.
 103     uint16_t stream_count;   ///< The number of streams in this file.
 104
 105     XMVVideoPacket  video; ///< The video packet contained in each packet.
 106     XMVAudioPacket *audio; ///< The audio packets contained in each packet.
 107 } XMVDemuxContext;
 108
 109 static int xmv_probe(AVProbeData *p)
 110 {
 111     uint32_t file_version;
 112
 113     if (p->buf_size < XMV_MIN_HEADER_SIZE)
 114         return 0;
 115
 116     file_version = AV_RL32(p->buf + 16);
 117     if ((file_version == 0) || (file_version > 4))
 118         return 0;
 119
 120     if (!memcmp(p->buf + 12, "xobX", 4))
 121         return AVPROBE_SCORE_MAX;
 122
 123     return 0;
 124 }
 125
 126 static int xmv_read_header(AVFormatContext *s,
 127                            AVFormatParameters *ap)
 128 {
 129     XMVDemuxContext *xmv = s->priv_data;
 130     AVIOContext     *pb  = s->pb;
 131     AVStream        *vst = NULL;
 132
 133     uint32_t file_version;
 134     uint32_t this_packet_size;
 135     uint16_t audio_track;
 136
 137     avio_skip(pb, 4); /* Next packet size */
 138
 139     this_packet_size = avio_rl32(pb);
 140
 141     avio_skip(pb, 4); /* Max packet size */
 142     avio_skip(pb, 4); /* "xobX" */
 143
 144     file_version = avio_rl32(pb);
 145     if ((file_version != 4) && (file_version != 2))
 146         av_log_ask_for_sample(s, "Found uncommon version %d\n", file_version);
 147
 148
 149     /* Video track */
 150
 151     vst = avformat_new_stream(s, NULL);
 152     if (!vst)
 153         return AVERROR(ENOMEM);
 154
 155     avpriv_set_pts_info(vst, 32, 1, 1000);
 156
 157     vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
 158     vst->codec->codec_id   = CODEC_ID_WMV2;
 159     vst->codec->codec_tag  = MKBETAG('W', 'M', 'V', '2');
 160     vst->codec->width      = avio_rl32(pb);
 161     vst->codec->height     = avio_rl32(pb);
 162
 163     vst->duration          = avio_rl32(pb);
 164
 165     xmv->video.stream_index = vst->index;
 166
 167     /* Audio tracks */
 168
 169     xmv->audio_track_count = avio_rl16(pb);
 170
 171     avio_skip(pb, 2); /* Unknown (padding?) */
 172
 173     xmv->audio = av_malloc(xmv->audio_track_count * sizeof(XMVAudioPacket));
 174     if (!xmv->audio)
 175         return AVERROR(ENOMEM);
 176
 177     for (audio_track = 0; audio_track < xmv->audio_track_count; audio_track++) {
 178         XMVAudioPacket *packet = &xmv->audio[audio_track];
 179         AVStream *ast = NULL;
 180
 181         packet->compression     = avio_rl16(pb);
 182         packet->channels        = avio_rl16(pb);
 183         packet->sample_rate     = avio_rl32(pb);
 184         packet->bits_per_sample = avio_rl16(pb);
 185         packet->flags           = avio_rl16(pb);
 186
 187         packet->bit_rate      = packet->bits_per_sample *
 188                                 packet->sample_rate *
 189                                 packet->channels;
 190         packet->block_align   = 36 * packet->channels;
 191         packet->block_samples = 64;
 192         packet->codec_id      = ff_wav_codec_get_id(packet->compression,
 193                                                     packet->bits_per_sample);
 194
 195         packet->stream_index = -1;
 196
 197         packet->frame_size  = 0;
 198         packet->block_count = 0;
 199
 200         /* TODO: ADPCM'd 5.1 sound is encoded in three separate streams.
 201          *       Those need to be interleaved to a proper 5.1 stream. */
 202         if (packet->flags & XMV_AUDIO_ADPCM51)
 203             av_log(s, AV_LOG_WARNING, "Unsupported 5.1 ADPCM audio stream "
 204                                       "(0x%04X)\n", packet->flags);
 205
 206         ast = avformat_new_stream(s, NULL);
 207         if (!ast)
 208             return AVERROR(ENOMEM);
 209
 210         ast->codec->codec_type            = AVMEDIA_TYPE_AUDIO;
 211         ast->codec->codec_id              = packet->codec_id;
 212         ast->codec->codec_tag             = packet->compression;
 213         ast->codec->channels              = packet->channels;
 214         ast->codec->sample_rate           = packet->sample_rate;
 215         ast->codec->bits_per_coded_sample = packet->bits_per_sample;
 216         ast->codec->bit_rate              = packet->bit_rate;
 217         ast->codec->block_align           = 36 * packet->channels;
 218
 219         avpriv_set_pts_info(ast, 32, packet->block_samples, packet->sample_rate);
 220
 221         packet->stream_index = ast->index;
 222
 223         ast->duration = vst->duration;
 224     }
 225
 226
 227     /* Initialize the packet context */
 228
 229     xmv->next_packet_offset = avio_tell(pb);
 230     xmv->next_packet_size   = this_packet_size - xmv->next_packet_offset;
 231     xmv->stream_count       = xmv->audio_track_count + 1;
 232
 233     return 0;
 234 }
 235
 236 static void xmv_read_extradata(uint8_t *extradata, AVIOContext *pb)
 237 {
 238     /* Read the XMV extradata */
 239
 240     uint32_t data = avio_rl32(pb);
 241
 242     int mspel_bit        = !!(data & 0x01);
 243     int loop_filter      = !!(data & 0x02);
 244     int abt_flag         = !!(data & 0x04);
 245     int j_type_bit       = !!(data & 0x08);
 246     int top_left_mv_flag = !!(data & 0x10);
 247     int per_mb_rl_bit    = !!(data & 0x20);
 248     int slice_count      = (data >> 6) & 7;
 249
 250     /* Write it back as standard WMV2 extradata */
 251
 252     data = 0;
 253
 254     data |= mspel_bit        << 15;
 255     data |= loop_filter      << 14;
 256     data |= abt_flag         << 13;
 257     data |= j_type_bit       << 12;
 258     data |= top_left_mv_flag << 11;
 259     data |= per_mb_rl_bit    << 10;
 260     data |= slice_count      <<  7;
 261
 262     AV_WB32(extradata, data);
 263 }
 264
 265 static int xmv_process_packet_header(AVFormatContext *s)
 266 {
 267     XMVDemuxContext *xmv = s->priv_data;
 268     AVIOContext     *pb  = s->pb;
 269
 270     uint8_t  data[8];
 271     uint16_t audio_track;
 272     uint64_t data_offset;
 273
 274     /* Next packet size */
 275     xmv->next_packet_size = avio_rl32(pb);
 276
 277     /* Packet video header */
 278
 279     if (avio_read(pb, data, 8) != 8)
 280         return AVERROR(EIO);
 281
 282     xmv->video.data_size     = AV_RL32(data) & 0x007FFFFF;
 283
 284     xmv->video.current_frame = 0;
 285     xmv->video.frame_count   = (AV_RL32(data) >> 23) & 0xFF;
 286
 287     xmv->video.has_extradata = (data[3] & 0x80) != 0;
 288
 289     /* Adding the audio data sizes and the video data size keeps you 4 bytes
 290      * short for every audio track. But as playing around with XMV files with
 291      * ADPCM audio showed, taking the extra 4 bytes from the audio data gives
 292      * you either completely distorted audio or click (when skipping the
 293      * remaining 68 bytes of the ADPCM block). Substracting 4 bytes for every
 294      * audio track from the video data works at least for the audio. Probably
 295      * some alignment thing?
 296      * The video data has (always?) lots of padding, so it should work out...
 297      */
 298     xmv->video.data_size -= xmv->audio_track_count * 4;
 299
 300     xmv->current_stream = 0;
 301     if (!xmv->video.frame_count) {
 302         xmv->video.frame_count = 1;
 303         xmv->current_stream    = 1;
 304     }
 305
 306     /* Packet audio header */
 307
 308     for (audio_track = 0; audio_track < xmv->audio_track_count; audio_track++) {
 309         XMVAudioPacket *packet = &xmv->audio[audio_track];
 310
 311         if (avio_read(pb, data, 4) != 4)
 312             return AVERROR(EIO);
 313
 314         packet->data_size = AV_RL32(data) & 0x007FFFFF;
 315         if ((packet->data_size == 0) && (audio_track != 0))
 316             /* This happens when I create an XMV with several identical audio
 317              * streams. From the size calculations, duplicating the previous
 318              * stream's size works out, but the track data itself is silent.
 319              * Maybe this should also redirect the offset to the previous track?
 320              */
 321             packet->data_size = xmv->audio[audio_track - 1].data_size;
 322
 323         /* Carve up the audio data in frame_count slices */
 324         packet->frame_size  = packet->data_size  / xmv->video.frame_count;
 325         packet->frame_size -= packet->frame_size % packet->block_align;
 326     }
 327
 328     /* Packet data offsets */
 329
 330     data_offset = avio_tell(pb);
 331
 332     xmv->video.data_offset = data_offset;
 333     data_offset += xmv->video.data_size;
 334
 335     for (audio_track = 0; audio_track < xmv->audio_track_count; audio_track++) {
 336         xmv->audio[audio_track].data_offset = data_offset;
 337         data_offset += xmv->audio[audio_track].data_size;
 338     }
 339
 340     /* Video frames header */
 341
 342     /* Read new video extra data */
 343     if (xmv->video.data_size > 0) {
 344         if (xmv->video.has_extradata) {
 345             xmv_read_extradata(xmv->video.extradata, pb);
 346
 347             xmv->video.data_size   -= 4;
 348             xmv->video.data_offset += 4;
 349
 350             if (xmv->video.stream_index >= 0) {
 351                 AVStream *vst = s->streams[xmv->video.stream_index];
 352
 353                 assert(xmv->video.stream_index < s->nb_streams);
 354
 355                 if (vst->codec->extradata_size < 4) {
 356                     av_free(vst->codec->extradata);
 357
 358                     vst->codec->extradata =
 359                         av_malloc(4 + FF_INPUT_BUFFER_PADDING_SIZE);
 360                     vst->codec->extradata_size = 4;
 361                 }
 362
 363                 memcpy(vst->codec->extradata, xmv->video.extradata, 4);
 364             }
 365         }
 366     }
 367
 368     return 0;
 369 }
 370
 371 static int xmv_fetch_new_packet(AVFormatContext *s)
 372 {
 373     XMVDemuxContext *xmv = s->priv_data;
 374     AVIOContext     *pb  = s->pb;
 375     int result;
 376
 377     /* Seek to it */
 378     xmv->this_packet_offset = xmv->next_packet_offset;
 379     if (avio_seek(pb, xmv->this_packet_offset, SEEK_SET) != xmv->this_packet_offset)
 380         return AVERROR(EIO);
 381
 382     /* Update the size */
 383     xmv->this_packet_size = xmv->next_packet_size;
 384     if (xmv->this_packet_size < (12 + xmv->audio_track_count * 4))
 385         return AVERROR(EIO);
 386
 387     /* Process the header */
 388     result = xmv_process_packet_header(s);
 389     if (result)
 390         return result;
 391
 392     /* Update the offset */
 393     xmv->next_packet_offset = xmv->this_packet_offset + xmv->this_packet_size;
 394
 395     return 0;
 396 }
 397
 398 static int xmv_fetch_audio_packet(AVFormatContext *s,
 399                                   AVPacket *pkt, uint32_t stream)
 400 {
 401     XMVDemuxContext *xmv   = s->priv_data;
 402     AVIOContext     *pb    = s->pb;
 403     XMVAudioPacket  *audio = &xmv->audio[stream];
 404
 405     uint32_t data_size;
 406     uint32_t block_count;
 407     int result;
 408
 409     /* Seek to it */
 410     if (avio_seek(pb, audio->data_offset, SEEK_SET) != audio->data_offset)
 411         return AVERROR(EIO);
 412
 413     if ((xmv->video.current_frame + 1) < xmv->video.frame_count)
 414         /* Not the last frame, get at most frame_size bytes. */
 415         data_size = FFMIN(audio->frame_size, audio->data_size);
 416     else
 417         /* Last frame, get the rest. */
 418         data_size = audio->data_size;
 419
 420     /* Read the packet */
 421     result = av_get_packet(pb, pkt, data_size);
 422     if (result <= 0)
 423         return result;
 424
 425     pkt->stream_index = audio->stream_index;
 426
 427     /* Calculate the PTS */
 428
 429     block_count = data_size / audio->block_align;
 430
 431     pkt->duration = block_count;
 432     pkt->pts      = audio->block_count;
 433     pkt->dts      = AV_NOPTS_VALUE;
 434
 435     audio->block_count += block_count;
 436
 437     /* Advance offset */
 438     audio->data_size   -= data_size;
 439     audio->data_offset += data_size;
 440
 441     return 0;
 442 }
 443
 444 static int xmv_fetch_video_packet(AVFormatContext *s,
 445                                   AVPacket *pkt)
 446 {
 447     XMVDemuxContext *xmv   = s->priv_data;
 448     AVIOContext     *pb    = s->pb;
 449     XMVVideoPacket  *video = &xmv->video;
 450
 451     int result;
 452     uint32_t frame_header;
 453     uint32_t frame_size, frame_timestamp;
 454     uint8_t *data, *end;
 455
 456     /* Seek to it */
 457     if (avio_seek(pb, video->data_offset, SEEK_SET) != video->data_offset)
 458         return AVERROR(EIO);
 459
 460     /* Read the frame header */
 461     frame_header = avio_rl32(pb);
 462
 463     frame_size      = (frame_header & 0x1FFFF) * 4 + 4;
 464     frame_timestamp = (frame_header >> 17);
 465
 466     if ((frame_size + 4) > video->data_size)
 467         return AVERROR(EIO);
 468
 469     /* Get the packet data */
 470     result = av_get_packet(pb, pkt, frame_size);
 471     if (result != frame_size)
 472         return result;
 473
 474     /* Contrary to normal WMV2 video, the bit stream in XMV's
 475      * WMV2 is little-endian.
 476      * TODO: This manual swap is of course suboptimal.
 477      */
 478     for (data = pkt->data, end = pkt->data + frame_size; data < end; data += 4)
 479         AV_WB32(data, AV_RL32(data));
 480
 481     pkt->stream_index = video->stream_index;
 482
 483     /* Calculate the PTS */
 484
 485     video->last_pts = frame_timestamp + video->pts;
 486
 487     pkt->duration = 0;
 488     pkt->pts      = video->last_pts;
 489     pkt->dts      = AV_NOPTS_VALUE;
 490
 491     video->pts += frame_timestamp;
 492
 493     /* Keyframe? */
 494     pkt->flags = (pkt->data[0] & 0x80) ? 0 : AV_PKT_FLAG_KEY;
 495
 496     /* Advance offset */
 497     video->data_size   -= frame_size + 4;
 498     video->data_offset += frame_size + 4;
 499
 500     return 0;
 501 }
 502
 503 static int xmv_read_packet(AVFormatContext *s,
 504                            AVPacket *pkt)
 505 {
 506     XMVDemuxContext *xmv = s->priv_data;
 507     int result;
 508
 509     if (xmv->video.current_frame == xmv->video.frame_count) {
 510         /* No frames left in this packet, so we fetch a new one */
 511
 512         result = xmv_fetch_new_packet(s);
 513         if (result)
 514             return result;
 515     }
 516
 517     if (xmv->current_stream == 0) {
 518         /* Fetch a video frame */
 519
 520         result = xmv_fetch_video_packet(s, pkt);
 521         if (result)
 522             return result;
 523
 524     } else {
 525         /* Fetch an audio frame */
 526
 527         result = xmv_fetch_audio_packet(s, pkt, xmv->current_stream - 1);
 528         if (result)
 529             return result;
 530     }
 531
 532     /* Increase our counters */
 533     if (++xmv->current_stream >= xmv->stream_count) {
 534         xmv->current_stream       = 0;
 535         xmv->video.current_frame += 1;
 536     }
 537
 538     return 0;
 539 }
 540
 541 static int xmv_read_close(AVFormatContext *s)
 542 {
 543     XMVDemuxContext *xmv = s->priv_data;
 544
 545     av_free(xmv->audio);
 546
 547     return 0;
 548 }
 549
 550 AVInputFormat ff_xmv_demuxer = {
 551     .name           = "xmv",
 552     .long_name      = NULL_IF_CONFIG_SMALL("Microsoft XMV"),
 553     .priv_data_size = sizeof(XMVDemuxContext),
 554     .read_probe     = xmv_probe,
 555     .read_header    = xmv_read_header,
 556     .read_packet    = xmv_read_packet,
 557     .read_close     = xmv_read_close,
 558 };