FFmpeg  4.3
wvdec.c
Go to the documentation of this file.
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 
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 {
54  int rate, chan, bpp;
55  uint32_t chmask;
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 
79 {
80  WVContext *wc = ctx->priv_data;
81  int ret;
82  int rate, rate_x, 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.version < 0x402 || wc->header.version > 0x410) {
102  avpriv_report_missing_feature(ctx, "WV version 0x%03X",
103  wc->header.version);
104  return AVERROR_PATCHWELCOME;
105  }
106 
107  /* Blocks with zero samples don't contain actual audio information
108  * and should be ignored */
109  if (!wc->header.samples)
110  return 0;
111  // parse flags
112  flags = wc->header.flags;
113  rate_x = (flags & WV_DSD) ? 4 : 1;
114  bpp = (flags & WV_DSD) ? 0 : ((flags & 3) + 1) << 3;
115  chan = 1 + !(flags & WV_MONO);
116  chmask = flags & WV_MONO ? AV_CH_LAYOUT_MONO : AV_CH_LAYOUT_STEREO;
117  rate = wv_rates[(flags >> 23) & 0xF];
118  wc->multichannel = !(wc->header.initial && wc->header.final);
119  if (wc->multichannel) {
120  chan = wc->chan;
121  chmask = wc->chmask;
122  }
123  if ((rate == -1 || !chan || flags & WV_DSD) && !wc->block_parsed) {
124  int64_t block_end = avio_tell(pb) + wc->header.blocksize;
125  if (!(pb->seekable & AVIO_SEEKABLE_NORMAL)) {
126  av_log(ctx, AV_LOG_ERROR,
127  "Cannot determine additional parameters\n");
128  return AVERROR_INVALIDDATA;
129  }
130  while (avio_tell(pb) < block_end && !avio_feof(pb)) {
131  int id, size;
132  id = avio_r8(pb);
133  size = (id & 0x80) ? avio_rl24(pb) : avio_r8(pb);
134  size <<= 1;
135  if (id & 0x40)
136  size--;
137  switch (id & 0x3F) {
138  case 0xD:
139  if (size <= 1) {
140  av_log(ctx, AV_LOG_ERROR,
141  "Insufficient channel information\n");
142  return AVERROR_INVALIDDATA;
143  }
144  chan = avio_r8(pb);
145  switch (size - 2) {
146  case 0:
147  chmask = avio_r8(pb);
148  break;
149  case 1:
150  chmask = avio_rl16(pb);
151  break;
152  case 2:
153  chmask = avio_rl24(pb);
154  break;
155  case 3:
156  chmask = avio_rl32(pb);
157  break;
158  case 4:
159  avio_skip(pb, 1);
160  chan |= (avio_r8(pb) & 0xF) << 8;
161  chan += 1;
162  chmask = avio_rl24(pb);
163  break;
164  case 5:
165  avio_skip(pb, 1);
166  chan |= (avio_r8(pb) & 0xF) << 8;
167  chan += 1;
168  chmask = avio_rl32(pb);
169  break;
170  default:
171  av_log(ctx, AV_LOG_ERROR,
172  "Invalid channel info size %d\n", size);
173  return AVERROR_INVALIDDATA;
174  }
175  break;
176  case 0xE:
177  if (size <= 1) {
178  av_log(ctx, AV_LOG_ERROR,
179  "Invalid DSD block\n");
180  return AVERROR_INVALIDDATA;
181  }
182  rate_x = 1U << (avio_r8(pb) & 0x1f);
183  if (size)
184  avio_skip(pb, size-1);
185  break;
186  case 0x27:
187  rate = avio_rl24(pb);
188  break;
189  default:
190  avio_skip(pb, size);
191  }
192  if (id & 0x40)
193  avio_skip(pb, 1);
194  }
195  if (rate == -1) {
196  av_log(ctx, AV_LOG_ERROR,
197  "Cannot determine custom sampling rate\n");
198  return AVERROR_INVALIDDATA;
199  }
200  avio_seek(pb, block_end - wc->header.blocksize, SEEK_SET);
201  }
202  if (!wc->bpp)
203  wc->bpp = bpp;
204  if (!wc->chan)
205  wc->chan = chan;
206  if (!wc->chmask)
207  wc->chmask = chmask;
208  if (!wc->rate)
209  wc->rate = rate * rate_x;
210 
211  if (flags && bpp != wc->bpp) {
212  av_log(ctx, AV_LOG_ERROR,
213  "Bits per sample differ, this block: %i, header block: %i\n",
214  bpp, wc->bpp);
215  return AVERROR_INVALIDDATA;
216  }
217  if (flags && !wc->multichannel && chan != wc->chan) {
218  av_log(ctx, AV_LOG_ERROR,
219  "Channels differ, this block: %i, header block: %i\n",
220  chan, wc->chan);
221  return AVERROR_INVALIDDATA;
222  }
223  if (flags && rate != -1 && !(flags & WV_DSD) && rate * rate_x != wc->rate) {
224  av_log(ctx, AV_LOG_ERROR,
225  "Sampling rate differ, this block: %i, header block: %i\n",
226  rate * rate_x, wc->rate);
227  return AVERROR_INVALIDDATA;
228  }
229  return 0;
230 }
231 
233 {
234  AVIOContext *pb = s->pb;
235  WVContext *wc = s->priv_data;
236  AVStream *st;
237  int ret;
238 
239  wc->block_parsed = 0;
240  for (;;) {
241  if ((ret = wv_read_block_header(s, pb)) < 0)
242  return ret;
243  if (!wc->header.samples)
244  avio_skip(pb, wc->header.blocksize);
245  else
246  break;
247  }
248 
249  /* now we are ready: build format streams */
250  st = avformat_new_stream(s, NULL);
251  if (!st)
252  return AVERROR(ENOMEM);
253  if ((ret = ff_alloc_extradata(st->codecpar, 2)) < 0)
254  return ret;
258  st->codecpar->channels = wc->chan;
259  st->codecpar->channel_layout = wc->chmask;
260  st->codecpar->sample_rate = wc->rate;
262  avpriv_set_pts_info(st, 64, 1, wc->rate);
263  st->start_time = 0;
264  if (wc->header.total_samples != 0xFFFFFFFFu)
265  st->duration = wc->header.total_samples;
266 
267  if (s->pb->seekable & AVIO_SEEKABLE_NORMAL) {
268  int64_t cur = avio_tell(s->pb);
271  ff_id3v1_read(s);
272  avio_seek(s->pb, cur, SEEK_SET);
273  }
274 
275  return 0;
276 }
277 
279 {
280  WVContext *wc = s->priv_data;
281  int ret;
282  int off;
283  int64_t pos;
284  uint32_t block_samples;
285 
286  if (avio_feof(s->pb))
287  return AVERROR_EOF;
288  if (wc->block_parsed) {
289  if ((ret = wv_read_block_header(s, s->pb)) < 0)
290  return ret;
291  }
292 
293  pos = wc->pos;
294  if ((ret = av_new_packet(pkt, wc->header.blocksize + WV_HEADER_SIZE)) < 0)
295  return ret;
296  memcpy(pkt->data, wc->block_header, WV_HEADER_SIZE);
297  ret = avio_read(s->pb, pkt->data + WV_HEADER_SIZE, wc->header.blocksize);
298  if (ret != wc->header.blocksize) {
299  return AVERROR(EIO);
300  }
301  while (!(wc->header.flags & WV_FLAG_FINAL_BLOCK)) {
302  if ((ret = wv_read_block_header(s, s->pb)) < 0) {
303  return ret;
304  }
305 
306  off = pkt->size;
307  if ((ret = av_grow_packet(pkt, WV_HEADER_SIZE + wc->header.blocksize)) < 0) {
308  return ret;
309  }
310  memcpy(pkt->data + off, wc->block_header, WV_HEADER_SIZE);
311 
312  ret = avio_read(s->pb, pkt->data + off + WV_HEADER_SIZE, wc->header.blocksize);
313  if (ret != wc->header.blocksize) {
314  return (ret < 0) ? ret : AVERROR_EOF;
315  }
316  }
317  pkt->stream_index = 0;
318  pkt->pos = pos;
319  wc->block_parsed = 1;
320  pkt->pts = wc->header.block_idx;
321  block_samples = wc->header.samples;
322  if (block_samples > INT32_MAX)
324  "Too many samples in block: %"PRIu32"\n", block_samples);
325  else
326  pkt->duration = block_samples;
327 
328  return 0;
329 }
330 
332  .name = "wv",
333  .long_name = NULL_IF_CONFIG_SMALL("WavPack"),
334  .priv_data_size = sizeof(WVContext),
335  .read_probe = wv_probe,
339 };
int64_t pos
Definition: wvdec.c:58
#define NULL
Definition: coverity.c:32
int block_parsed
Definition: wvdec.c:57
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
uint8_t block_header[WV_HEADER_SIZE]
Definition: wvdec.c:52
int size
uint32_t samples
Definition: wv.h:39
int initial
Definition: wv.h:43
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int64_t pos
byte position in stream, -1 if unknown
Definition: packet.h:375
int rate
Definition: wvdec.c:54
Definition: wvdec.c:32
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4938
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
void ff_id3v1_read(AVFormatContext *s)
Read an ID3v1 tag.
Definition: id3v1.c:279
int size
Definition: packet.h:356
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:241
#define WV_BLOCK_LIMIT
Definition: wv.h:32
static int wv_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: wvdec.c:278
#define AV_RL16
Definition: intreadwrite.h:42
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:329
static AVPacket pkt
#define AV_CH_LAYOUT_STEREO
int multichannel
Definition: wvdec.c:56
Format I/O context.
Definition: avformat.h:1351
Public dictionary API.
uint8_t
uint32_t flags
Definition: wv.h:40
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:373
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4519
AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:40
uint8_t * data
Definition: packet.h:355
#define AVERROR_EOF
End of file.
Definition: error.h:55
#define WV_HEADER_SIZE
Definition: wavpack.h:30
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
Definition: wv.h:34
uint64_t channel_layout
Audio only.
Definition: codec_par.h:162
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:625
WV_FLAGS
Definition: wvdec.c:31
#define U(x)
Definition: vp56_arith.h:37
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:88
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
AVDictionary * metadata
Metadata that applies to the whole file.
Definition: avformat.h:1591
AVInputFormat ff_wv_demuxer
Definition: wvdec.c:331
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:747
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
int final
Definition: wv.h:43
int64_t ff_ape_parse_tag(AVFormatContext *s)
Read and parse an APE tag.
Definition: apetag.c:118
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:616
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:444
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
uint16_t version
Definition: wv.h:36
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:260
audio channel layout utility functions
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0...
Definition: utils.c:3321
Definition: wvdec.c:39
Definition: wvdec.c:43
static const int wv_rates[16]
Definition: wvdec.c:46
int ff_wv_parse_header(WvHeader *wv, const uint8_t *data)
Parse a WavPack block header.
Definition: wv.c:29
AVFormatContext * ctx
Definition: movenc.c:48
int bpp
Definition: wvdec.c:54
#define s(width, name)
Definition: cbs_vp9.c:257
int64_t apetag_start
Definition: wvdec.c:60
#define AV_RL32
Definition: intreadwrite.h:146
WvHeader header
Definition: wvdec.c:53
Definition: wvdec.c:34
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
Stream structure.
Definition: avformat.h:876
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
static int wv_probe(const AVProbeData *p)
Definition: wvdec.c:63
AVIOContext * pb
I/O context.
Definition: avformat.h:1393
#define AVFMT_GENERIC_INDEX
Use generic index building code.
Definition: avformat.h:463
uint32_t total_samples
Definition: wv.h:37
int chan
Definition: wvdec.c:54
uint32_t chmask
Definition: wvdec.c:55
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
void avpriv_report_missing_feature(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
uint32_t block_idx
Definition: wv.h:38
#define flags(name, subs,...)
Definition: cbs_av1.c:564
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:925
int sample_rate
Audio only.
Definition: codec_par.h:170
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:731
Main libavformat public API header.
Definition: wvdec.c:40
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base...
Definition: avformat.h:915
static int wv_read_header(AVFormatContext *s)
Definition: wvdec.c:232
#define AV_WL16(p, v)
Definition: intreadwrite.h:412
int av_grow_packet(AVPacket *pkt, int grow_by)
Increase packet size, correctly zeroing padding.
Definition: avpacket.c:111
Definition: wvdec.c:38
Definition: wvdec.c:37
void * priv_data
Format private data.
Definition: avformat.h:1379
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:74
int channels
Audio only.
Definition: codec_par.h:166
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:650
#define AV_DICT_IGNORE_SUFFIX
Return first entry in a dictionary whose first part corresponds to the search key, ignoring the suffix of the found key string.
Definition: dict.h:70
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1023
Definition: wvdec.c:42
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:356
unsigned int avio_rl24(AVIOContext *s)
Definition: aviobuf.c:739
int stream_index
Definition: packet.h:357
static int wv_read_block_header(AVFormatContext *ctx, AVIOContext *pb)
Definition: wvdec.c:78
#define AV_CH_LAYOUT_MONO
#define MKTAG(a, b, c, d)
Definition: common.h:406
enum AVCodecID id
This structure stores compressed data.
Definition: packet.h:332
#define WV_FLAG_FINAL_BLOCK
Definition: wv.h:29
uint32_t blocksize
Definition: wv.h:35
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:348