Merge commit '0a1a94450a28eef854162f859e79ecfb9f97915b'
[ffmpeg.git] / libavformat / wvdec.c
1 /*
2  * WavPack demuxer
3  * Copyright (c) 2006,2011 Konstantin Shishkov
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 #include "libavutil/channel_layout.h"
23 #include "libavutil/intreadwrite.h"
24 #include "libavutil/dict.h"
25 #include "avformat.h"
26 #include "internal.h"
27 #include "apetag.h"
28 #include "id3v1.h"
29
30 // specs say that maximum block size is 1Mb
31 #define WV_BLOCK_LIMIT 1047576
32
33 #define WV_HEADER_SIZE 32
34
35 #define WV_START_BLOCK  0x0800
36 #define WV_END_BLOCK    0x1000
37 #define WV_SINGLE_BLOCK (WV_START_BLOCK | WV_END_BLOCK)
38
39 enum WV_FLAGS {
40     WV_MONO   = 0x0004,
41     WV_HYBRID = 0x0008,
42     WV_JOINT  = 0x0010,
43     WV_CROSSD = 0x0020,
44     WV_HSHAPE = 0x0040,
45     WV_FLOAT  = 0x0080,
46     WV_INT32  = 0x0100,
47     WV_HBR    = 0x0200,
48     WV_HBAL   = 0x0400,
49     WV_MCINIT = 0x0800,
50     WV_MCEND  = 0x1000,
51 };
52
53 static const int wv_rates[16] = {
54      6000,  8000,  9600, 11025, 12000, 16000,  22050, 24000,
55     32000, 44100, 48000, 64000, 88200, 96000, 192000,    -1
56 };
57
58 typedef struct {
59     uint8_t block_header[WV_HEADER_SIZE];
60     uint32_t blksize, flags;
61     int rate, chan, bpp;
62     uint32_t chmask;
63     uint32_t samples, soff;
64     int multichannel;
65     int block_parsed;
66     int64_t pos;
67
68     int64_t apetag_start;
69 } WVContext;
70
71 static int wv_probe(AVProbeData *p)
72 {
73     /* check file header */
74     if (p->buf_size <= 32)
75         return 0;
76     if (AV_RL32(&p->buf[0]) == MKTAG('w', 'v', 'p', 'k') &&
77         AV_RL32(&p->buf[4]) >= 24 &&
78         AV_RL32(&p->buf[4]) <= WV_BLOCK_LIMIT &&
79         AV_RL16(&p->buf[8]) >= 0x402 &&
80         AV_RL16(&p->buf[8]) <= 0x410)
81         return AVPROBE_SCORE_MAX;
82     else
83         return 0;
84 }
85
86 static int wv_read_block_header(AVFormatContext *ctx, AVIOContext *pb)
87 {
88     WVContext *wc = ctx->priv_data;
89     uint32_t ver;
90     int size, ret;
91     int rate, bpp, chan;
92     uint32_t chmask;
93
94     wc->pos = avio_tell(pb);
95
96     /* don't return bogus packets with the ape tag data */
97     if (wc->apetag_start && wc->pos >= wc->apetag_start)
98         return AVERROR_EOF;
99
100     ret = avio_read(pb, wc->block_header, WV_HEADER_SIZE);
101     if (ret != WV_HEADER_SIZE)
102         return (ret < 0) ? ret : AVERROR_EOF;
103
104     if (AV_RL32(wc->block_header) != MKTAG('w', 'v', 'p', 'k'))
105         return AVERROR_INVALIDDATA;
106
107     size = AV_RL32(wc->block_header + 4);
108     if (size < 24 || size > WV_BLOCK_LIMIT) {
109         av_log(ctx, AV_LOG_ERROR, "Incorrect block size %i\n", size);
110         return AVERROR_INVALIDDATA;
111     }
112     wc->blksize = size;
113     ver = AV_RL32(wc->block_header + 8);
114     if (ver < 0x402 || ver > 0x410) {
115         av_log(ctx, AV_LOG_ERROR, "Unsupported version %03X\n", ver);
116         return AVERROR_PATCHWELCOME;
117     }
118     wc->samples = AV_RL32(wc->block_header + 12); // total samples in file
119     wc->soff    = AV_RL32(wc->block_header + 16); // offset in samples of current block
120     wc->flags   = AV_RL32(wc->block_header + 24);
121     /* Blocks with zero samples don't contain actual audio information
122      * and should be ignored */
123     if (!AV_RN32(wc->block_header + 20))
124         return 0;
125     // parse flags
126     bpp    = ((wc->flags & 3) + 1) << 3;
127     chan   = 1 + !(wc->flags & WV_MONO);
128     chmask = wc->flags & WV_MONO ? AV_CH_LAYOUT_MONO : AV_CH_LAYOUT_STEREO;
129     rate   = wv_rates[(wc->flags >> 23) & 0xF];
130     wc->multichannel = !!((wc->flags & WV_SINGLE_BLOCK) != WV_SINGLE_BLOCK);
131     if (wc->multichannel) {
132         chan   = wc->chan;
133         chmask = wc->chmask;
134     }
135     if ((rate == -1 || !chan) && !wc->block_parsed) {
136         int64_t block_end = avio_tell(pb) + wc->blksize - 24;
137         if (!pb->seekable) {
138             av_log(ctx, AV_LOG_ERROR,
139                    "Cannot determine additional parameters\n");
140             return AVERROR_INVALIDDATA;
141         }
142         while (avio_tell(pb) < block_end) {
143             int id, size;
144             id   = avio_r8(pb);
145             size = (id & 0x80) ? avio_rl24(pb) : avio_r8(pb);
146             size <<= 1;
147             if (id & 0x40)
148                 size--;
149             switch (id & 0x3F) {
150             case 0xD:
151                 if (size <= 1) {
152                     av_log(ctx, AV_LOG_ERROR,
153                            "Insufficient channel information\n");
154                     return AVERROR_INVALIDDATA;
155                 }
156                 chan = avio_r8(pb);
157                 switch (size - 2) {
158                 case 0:
159                     chmask = avio_r8(pb);
160                     break;
161                 case 1:
162                     chmask = avio_rl16(pb);
163                     break;
164                 case 2:
165                     chmask = avio_rl24(pb);
166                     break;
167                 case 3:
168                     chmask = avio_rl32(pb);
169                     break;
170                 case 5:
171                     avio_skip(pb, 1);
172                     chan  |= (avio_r8(pb) & 0xF) << 8;
173                     chmask = avio_rl24(pb);
174                     break;
175                 default:
176                     av_log(ctx, AV_LOG_ERROR,
177                            "Invalid channel info size %d\n", size);
178                     return AVERROR_INVALIDDATA;
179                 }
180                 break;
181             case 0x27:
182                 rate = avio_rl24(pb);
183                 break;
184             default:
185                 avio_skip(pb, size);
186             }
187             if (id & 0x40)
188                 avio_skip(pb, 1);
189         }
190         if (rate == -1) {
191             av_log(ctx, AV_LOG_ERROR,
192                    "Cannot determine custom sampling rate\n");
193             return AVERROR_INVALIDDATA;
194         }
195         avio_seek(pb, block_end - wc->blksize + 24, SEEK_SET);
196     }
197     if (!wc->bpp)
198         wc->bpp    = bpp;
199     if (!wc->chan)
200         wc->chan   = chan;
201     if (!wc->chmask)
202         wc->chmask = chmask;
203     if (!wc->rate)
204         wc->rate   = rate;
205
206     if (wc->flags && bpp != wc->bpp) {
207         av_log(ctx, AV_LOG_ERROR,
208                "Bits per sample differ, this block: %i, header block: %i\n",
209                bpp, wc->bpp);
210         return AVERROR_INVALIDDATA;
211     }
212     if (wc->flags && !wc->multichannel && chan != wc->chan) {
213         av_log(ctx, AV_LOG_ERROR,
214                "Channels differ, this block: %i, header block: %i\n",
215                chan, wc->chan);
216         return AVERROR_INVALIDDATA;
217     }
218     if (wc->flags && rate != -1 && rate != wc->rate) {
219         av_log(ctx, AV_LOG_ERROR,
220                "Sampling rate differ, this block: %i, header block: %i\n",
221                rate, wc->rate);
222         return AVERROR_INVALIDDATA;
223     }
224     wc->blksize = size - 24;
225     return 0;
226 }
227
228 static int wv_read_header(AVFormatContext *s)
229 {
230     AVIOContext *pb = s->pb;
231     WVContext *wc = s->priv_data;
232     AVStream *st;
233     int ret;
234
235     wc->block_parsed = 0;
236     for (;;) {
237         if ((ret = wv_read_block_header(s, pb)) < 0)
238             return ret;
239         if (!AV_RL32(wc->block_header + 20))
240             avio_skip(pb, wc->blksize - 24);
241         else
242             break;
243     }
244
245     /* now we are ready: build format streams */
246     st = avformat_new_stream(s, NULL);
247     if (!st)
248         return AVERROR(ENOMEM);
249     st->codec->codec_type            = AVMEDIA_TYPE_AUDIO;
250     st->codec->codec_id              = AV_CODEC_ID_WAVPACK;
251     st->codec->channels              = wc->chan;
252     st->codec->channel_layout        = wc->chmask;
253     st->codec->sample_rate           = wc->rate;
254     st->codec->bits_per_coded_sample = wc->bpp;
255     avpriv_set_pts_info(st, 64, 1, wc->rate);
256     st->start_time = 0;
257     if (wc->samples != 0xFFFFFFFFu)
258         st->duration = wc->samples;
259
260     if (s->pb->seekable) {
261         int64_t cur = avio_tell(s->pb);
262         wc->apetag_start = ff_ape_parse_tag(s);
263         if (!av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
264             ff_id3v1_read(s);
265         avio_seek(s->pb, cur, SEEK_SET);
266     }
267
268     return 0;
269 }
270
271 static int wv_read_packet(AVFormatContext *s, AVPacket *pkt)
272 {
273     WVContext *wc = s->priv_data;
274     int ret;
275     int off;
276     int64_t pos;
277     uint32_t block_samples;
278
279     if (url_feof(s->pb))
280         return AVERROR_EOF;
281     if (wc->block_parsed) {
282         if ((ret = wv_read_block_header(s, s->pb)) < 0)
283             return ret;
284     }
285
286     pos = wc->pos;
287     if (av_new_packet(pkt, wc->blksize + WV_HEADER_SIZE) < 0)
288         return AVERROR(ENOMEM);
289     memcpy(pkt->data, wc->block_header, WV_HEADER_SIZE);
290     ret = avio_read(s->pb, pkt->data + WV_HEADER_SIZE, wc->blksize);
291     if (ret != wc->blksize) {
292         av_free_packet(pkt);
293         return AVERROR(EIO);
294     }
295     while (!(wc->flags & WV_END_BLOCK)) {
296         if ((ret = wv_read_block_header(s, s->pb)) < 0) {
297             av_free_packet(pkt);
298             return ret;
299         }
300
301         off = pkt->size;
302         if ((ret = av_grow_packet(pkt, WV_HEADER_SIZE + wc->blksize)) < 0) {
303             av_free_packet(pkt);
304             return ret;
305         }
306         memcpy(pkt->data + off, wc->block_header, WV_HEADER_SIZE);
307
308         ret = avio_read(s->pb, pkt->data + off + WV_HEADER_SIZE, wc->blksize);
309         if (ret != wc->blksize) {
310             av_free_packet(pkt);
311             return (ret < 0) ? ret : AVERROR_EOF;
312         }
313     }
314     pkt->stream_index = 0;
315     wc->block_parsed  = 1;
316     pkt->pts          = wc->soff;
317     block_samples     = AV_RL32(wc->block_header + 20);
318     if (block_samples > INT32_MAX)
319         av_log(s, AV_LOG_WARNING,
320                "Too many samples in block: %"PRIu32"\n", block_samples);
321     else
322         pkt->duration = block_samples;
323
324     av_add_index_entry(s->streams[0], pos, pkt->pts, 0, 0, AVINDEX_KEYFRAME);
325     return 0;
326 }
327
328 static int wv_read_seek(AVFormatContext *s, int stream_index,
329                         int64_t timestamp, int flags)
330 {
331     AVStream  *st = s->streams[stream_index];
332     WVContext *wc = s->priv_data;
333     AVPacket pkt1, *pkt = &pkt1;
334     int ret;
335     int index = av_index_search_timestamp(st, timestamp, flags);
336     int64_t pos, pts;
337
338     /* if found, seek there */
339     if (index >= 0 &&
340         timestamp <= st->index_entries[st->nb_index_entries - 1].timestamp) {
341         wc->block_parsed = 1;
342         avio_seek(s->pb, st->index_entries[index].pos, SEEK_SET);
343         return 0;
344     }
345     /* if timestamp is out of bounds, return error */
346     if (timestamp < 0 || timestamp >= s->duration)
347         return AVERROR(EINVAL);
348
349     pos = avio_tell(s->pb);
350     do {
351         ret = av_read_frame(s, pkt);
352         if (ret < 0) {
353             avio_seek(s->pb, pos, SEEK_SET);
354             return ret;
355         }
356         pts = pkt->pts;
357         av_free_packet(pkt);
358     } while(pts < timestamp);
359     return 0;
360 }
361
362 AVInputFormat ff_wv_demuxer = {
363     .name           = "wv",
364     .long_name      = NULL_IF_CONFIG_SMALL("WavPack"),
365     .priv_data_size = sizeof(WVContext),
366     .read_probe     = wv_probe,
367     .read_header    = wv_read_header,
368     .read_packet    = wv_read_packet,
369     .read_seek      = wv_read_seek,
370 };