electronicarts: Let functions always returning the same value return void
[ffmpeg.git] / libavformat / xwma.c
1 /*
2  * xWMA demuxer
3  * Copyright (c) 2011 Max Horn
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <inttypes.h>
23
24 #include "avformat.h"
25 #include "internal.h"
26 #include "riff.h"
27
28 /*
29  * Demuxer for xWMA, a Microsoft audio container used by XAudio 2.
30  */
31
32 typedef struct {
33     int64_t data_end;
34 } XWMAContext;
35
36 static int xwma_probe(AVProbeData *p)
37 {
38     if (!memcmp(p->buf, "RIFF", 4) && !memcmp(p->buf + 8, "XWMA", 4))
39         return AVPROBE_SCORE_MAX;
40     return 0;
41 }
42
43 static int xwma_read_header(AVFormatContext *s)
44 {
45     int64_t size;
46     int ret;
47     uint32_t dpds_table_size = 0;
48     uint32_t *dpds_table = 0;
49     unsigned int tag;
50     AVIOContext *pb = s->pb;
51     AVStream *st;
52     XWMAContext *xwma = s->priv_data;
53     int i;
54
55     /* The following code is mostly copied from wav.c, with some
56      * minor alterations.
57      */
58
59     /* check RIFF header */
60     tag = avio_rl32(pb);
61     if (tag != MKTAG('R', 'I', 'F', 'F'))
62         return -1;
63     avio_rl32(pb); /* file size */
64     tag = avio_rl32(pb);
65     if (tag != MKTAG('X', 'W', 'M', 'A'))
66         return -1;
67
68     /* parse fmt header */
69     tag = avio_rl32(pb);
70     if (tag != MKTAG('f', 'm', 't', ' '))
71         return -1;
72     size = avio_rl32(pb);
73     st = avformat_new_stream(s, NULL);
74     if (!st)
75         return AVERROR(ENOMEM);
76
77     ret = ff_get_wav_header(pb, st->codec, size);
78     if (ret < 0)
79         return ret;
80     st->need_parsing = AVSTREAM_PARSE_NONE;
81
82     /* All xWMA files I have seen contained WMAv2 data. If there are files
83      * using WMA Pro or some other codec, then we need to figure out the right
84      * extradata for that. Thus, ask the user for feedback, but try to go on
85      * anyway.
86      */
87     if (st->codec->codec_id != AV_CODEC_ID_WMAV2) {
88         avpriv_request_sample(s, "Unexpected codec (tag 0x04%x; id %d)",
89                               st->codec->codec_tag, st->codec->codec_id);
90     } else {
91         /* In all xWMA files I have seen, there is no extradata. But the WMA
92          * codecs require extradata, so we provide our own fake extradata.
93          *
94          * First, check that there really was no extradata in the header. If
95          * there was, then try to use it, after asking the user to provide a
96          * sample of this unusual file.
97          */
98         if (st->codec->extradata_size != 0) {
99             /* Surprise, surprise: We *did* get some extradata. No idea
100              * if it will work, but just go on and try it, after asking
101              * the user for a sample.
102              */
103             avpriv_request_sample(s, "Unexpected extradata (%d bytes)",
104                                   st->codec->extradata_size);
105         } else {
106             st->codec->extradata_size = 6;
107             st->codec->extradata      = av_mallocz(6 + FF_INPUT_BUFFER_PADDING_SIZE);
108             if (!st->codec->extradata)
109                 return AVERROR(ENOMEM);
110
111             /* setup extradata with our experimentally obtained value */
112             st->codec->extradata[4] = 31;
113         }
114     }
115
116     if (!st->codec->channels) {
117         av_log(s, AV_LOG_WARNING, "Invalid channel count: %d\n",
118                st->codec->channels);
119         return AVERROR_INVALIDDATA;
120     }
121     if (!st->codec->bits_per_coded_sample) {
122         av_log(s, AV_LOG_WARNING, "Invalid bits_per_coded_sample: %d\n",
123                st->codec->bits_per_coded_sample);
124         return AVERROR_INVALIDDATA;
125     }
126
127     /* set the sample rate */
128     avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
129
130     /* parse the remaining RIFF chunks */
131     for (;;) {
132         if (pb->eof_reached)
133             return -1;
134         /* read next chunk tag */
135         tag = avio_rl32(pb);
136         size = avio_rl32(pb);
137         if (tag == MKTAG('d', 'a', 't', 'a')) {
138             /* We assume that the data chunk comes last. */
139             break;
140         } else if (tag == MKTAG('d','p','d','s')) {
141             /* Quoting the MSDN xWMA docs on the dpds chunk: "Contains the
142              * decoded packet cumulative data size array, each element is the
143              * number of bytes accumulated after the corresponding xWMA packet
144              * is decoded in order."
145              *
146              * Each packet has size equal to st->codec->block_align, which in
147              * all cases I saw so far was always 2230. Thus, we can use the
148              * dpds data to compute a seeking index.
149              */
150
151             /* Error out if there is more than one dpds chunk. */
152             if (dpds_table) {
153                 av_log(s, AV_LOG_ERROR, "two dpds chunks present\n");
154                 return -1;
155             }
156
157             /* Compute the number of entries in the dpds chunk. */
158             if (size & 3) {  /* Size should be divisible by four */
159                 av_log(s, AV_LOG_WARNING,
160                        "dpds chunk size %"PRId64" not divisible by 4\n", size);
161             }
162             dpds_table_size = size / 4;
163             if (dpds_table_size == 0 || dpds_table_size >= INT_MAX / 4) {
164                 av_log(s, AV_LOG_ERROR,
165                        "dpds chunk size %"PRId64" invalid\n", size);
166                 return -1;
167             }
168
169             /* Allocate some temporary storage to keep the dpds data around.
170              * for processing later on.
171              */
172             dpds_table = av_malloc(dpds_table_size * sizeof(uint32_t));
173             if (!dpds_table) {
174                 return AVERROR(ENOMEM);
175             }
176
177             for (i = 0; i < dpds_table_size; ++i) {
178                 dpds_table[i] = avio_rl32(pb);
179                 size -= 4;
180             }
181         }
182         avio_skip(pb, size);
183     }
184
185     /* Determine overall data length */
186     if (size < 0)
187         return -1;
188     if (!size) {
189         xwma->data_end = INT64_MAX;
190     } else
191         xwma->data_end = avio_tell(pb) + size;
192
193
194     if (dpds_table && dpds_table_size) {
195         int64_t cur_pos;
196         const uint32_t bytes_per_sample
197                 = (st->codec->channels * st->codec->bits_per_coded_sample) >> 3;
198
199         /* Estimate the duration from the total number of output bytes. */
200         const uint64_t total_decoded_bytes = dpds_table[dpds_table_size - 1];
201         st->duration = total_decoded_bytes / bytes_per_sample;
202
203         /* Use the dpds data to build a seek table.  We can only do this after
204          * we know the offset to the data chunk, as we need that to determine
205          * the actual offset to each input block.
206          * Note: If we allowed ourselves to assume that the data chunk always
207          * follows immediately after the dpds block, we could of course guess
208          * the data block's start offset already while reading the dpds chunk.
209          * I decided against that, just in case other chunks ever are
210          * discovered.
211          */
212         cur_pos = avio_tell(pb);
213         for (i = 0; i < dpds_table_size; ++i) {
214             /* From the number of output bytes that would accumulate in the
215              * output buffer after decoding the first (i+1) packets, we compute
216              * an offset / timestamp pair.
217              */
218             av_add_index_entry(st,
219                                cur_pos + (i+1) * st->codec->block_align, /* pos */
220                                dpds_table[i] / bytes_per_sample,         /* timestamp */
221                                st->codec->block_align,                   /* size */
222                                0,                                        /* duration */
223                                AVINDEX_KEYFRAME);
224         }
225     } else if (st->codec->bit_rate) {
226         /* No dpds chunk was present (or only an empty one), so estimate
227          * the total duration using the average bits per sample and the
228          * total data length.
229          */
230         st->duration = (size<<3) * st->codec->sample_rate / st->codec->bit_rate;
231     }
232
233     av_free(dpds_table);
234
235     return 0;
236 }
237
238 static int xwma_read_packet(AVFormatContext *s, AVPacket *pkt)
239 {
240     int ret, size;
241     int64_t left;
242     AVStream *st;
243     XWMAContext *xwma = s->priv_data;
244
245     st = s->streams[0];
246
247     left = xwma->data_end - avio_tell(s->pb);
248     if (left <= 0) {
249         return AVERROR_EOF;
250     }
251
252     /* read a single block; the default block size is 2230. */
253     size = (st->codec->block_align > 1) ? st->codec->block_align : 2230;
254     size = FFMIN(size, left);
255
256     ret  = av_get_packet(s->pb, pkt, size);
257     if (ret < 0)
258         return ret;
259
260     pkt->stream_index = 0;
261     return ret;
262 }
263
264 AVInputFormat ff_xwma_demuxer = {
265     .name           = "xwma",
266     .long_name      = NULL_IF_CONFIG_SMALL("Microsoft xWMA"),
267     .priv_data_size = sizeof(XWMAContext),
268     .read_probe     = xwma_probe,
269     .read_header    = xwma_read_header,
270     .read_packet    = xwma_read_packet,
271 };