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