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