FFmpeg
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 "demux.h"
27 #include "internal.h"
28 #include "apetag.h"
29 #include "id3v1.h"
30 #include "wv.h"
31 
32 enum WV_FLAGS {
33  WV_MONO = 0x0004,
34  WV_HYBRID = 0x0008,
35  WV_JOINT = 0x0010,
36  WV_CROSSD = 0x0020,
37  WV_HSHAPE = 0x0040,
38  WV_FLOAT = 0x0080,
39  WV_INT32 = 0x0100,
40  WV_HBR = 0x0200,
41  WV_HBAL = 0x0400,
42  WV_MCINIT = 0x0800,
43  WV_MCEND = 0x1000,
44  WV_DSD = 0x80000000,
45 };
46 
47 static const int wv_rates[16] = {
48  6000, 8000, 9600, 11025, 12000, 16000, 22050, 24000,
49  32000, 44100, 48000, 64000, 88200, 96000, 192000, -1
50 };
51 
52 typedef struct WVContext {
55  int rate, chan, bpp;
56  uint32_t chmask;
60 
62 } WVContext;
63 
64 static int wv_probe(const AVProbeData *p)
65 {
66  /* check file header */
67  if (p->buf_size <= 32)
68  return 0;
69  if (AV_RL32(&p->buf[0]) == MKTAG('w', 'v', 'p', 'k') &&
70  AV_RL32(&p->buf[4]) >= 24 &&
71  AV_RL32(&p->buf[4]) <= WV_BLOCK_LIMIT &&
72  AV_RL16(&p->buf[8]) >= 0x402 &&
73  AV_RL16(&p->buf[8]) <= 0x410)
74  return AVPROBE_SCORE_MAX;
75  else
76  return 0;
77 }
78 
80 {
81  WVContext *wc = ctx->priv_data;
82  int ret;
83  int rate, bpp, chan;
84  uint32_t chmask, flags;
85  unsigned rate_x;
86 
87  wc->pos = avio_tell(pb);
88 
89  /* don't return bogus packets with the ape tag data */
90  if (wc->apetag_start && wc->pos >= wc->apetag_start)
91  return AVERROR_EOF;
92 
94  if (ret != WV_HEADER_SIZE)
95  return (ret < 0) ? ret : AVERROR_EOF;
96 
98  if (ret < 0) {
99  av_log(ctx, AV_LOG_ERROR, "Invalid block header.\n");
100  return ret;
101  }
102 
103  if (wc->header.version < 0x402 || wc->header.version > 0x410) {
104  avpriv_report_missing_feature(ctx, "WV version 0x%03X",
105  wc->header.version);
106  return AVERROR_PATCHWELCOME;
107  }
108 
109  /* Blocks with zero samples don't contain actual audio information
110  * and should be ignored */
111  if (!wc->header.samples)
112  return 0;
113  // parse flags
114  flags = wc->header.flags;
115  rate_x = (flags & WV_DSD) ? 4 : 1;
116  bpp = (flags & WV_DSD) ? 0 : ((flags & 3) + 1) << 3;
117  chan = 1 + !(flags & WV_MONO);
119  rate = wv_rates[(flags >> 23) & 0xF];
120  wc->multichannel = !(wc->header.initial && wc->header.final);
121  if (wc->multichannel) {
122  chan = wc->chan;
123  chmask = wc->chmask;
124  }
125  if ((rate == -1 || !chan || flags & WV_DSD) && !wc->block_parsed) {
126  int64_t block_end = avio_tell(pb) + wc->header.blocksize;
127  if (!(pb->seekable & AVIO_SEEKABLE_NORMAL)) {
129  "Cannot determine additional parameters\n");
130  return AVERROR_INVALIDDATA;
131  }
132  while (avio_tell(pb) < block_end && !avio_feof(pb)) {
133  int id, size;
134  id = avio_r8(pb);
135  size = (id & 0x80) ? avio_rl24(pb) : avio_r8(pb);
136  size <<= 1;
137  if (id & 0x40)
138  size--;
139  switch (id & 0x3F) {
140  case 0xD:
141  if (size <= 1) {
143  "Insufficient channel information\n");
144  return AVERROR_INVALIDDATA;
145  }
146  chan = avio_r8(pb);
147  switch (size - 2) {
148  case 0:
149  chmask = avio_r8(pb);
150  break;
151  case 1:
152  chmask = avio_rl16(pb);
153  break;
154  case 2:
155  chmask = avio_rl24(pb);
156  break;
157  case 3:
158  chmask = avio_rl32(pb);
159  break;
160  case 4:
161  avio_skip(pb, 1);
162  chan |= (avio_r8(pb) & 0xF) << 8;
163  chan += 1;
164  chmask = avio_rl24(pb);
165  break;
166  case 5:
167  avio_skip(pb, 1);
168  chan |= (avio_r8(pb) & 0xF) << 8;
169  chan += 1;
170  chmask = avio_rl32(pb);
171  break;
172  default:
174  "Invalid channel info size %d\n", size);
175  return AVERROR_INVALIDDATA;
176  }
177  break;
178  case 0xE:
179  if (size <= 1) {
181  "Invalid DSD block\n");
182  return AVERROR_INVALIDDATA;
183  }
184  rate_x = 1U << (avio_r8(pb) & 0x1f);
185  if (size)
186  avio_skip(pb, size-1);
187  break;
188  case 0x27:
189  rate = avio_rl24(pb);
190  break;
191  default:
192  avio_skip(pb, size);
193  }
194  if (id & 0x40)
195  avio_skip(pb, 1);
196  }
197  if (rate == -1 || rate * (uint64_t)rate_x >= INT_MAX) {
199  "Cannot determine custom sampling rate\n");
200  return AVERROR_INVALIDDATA;
201  }
202  avio_seek(pb, block_end - wc->header.blocksize, SEEK_SET);
203  }
204  if (!wc->bpp)
205  wc->bpp = bpp;
206  if (!wc->chan)
207  wc->chan = chan;
208  if (!wc->chmask)
209  wc->chmask = chmask;
210  if (!wc->rate)
211  wc->rate = rate * rate_x;
212 
213  if (flags && bpp != wc->bpp) {
215  "Bits per sample differ, this block: %i, header block: %i\n",
216  bpp, wc->bpp);
217  return AVERROR_INVALIDDATA;
218  }
219  if (flags && !wc->multichannel && chan != wc->chan) {
221  "Channels differ, this block: %i, header block: %i\n",
222  chan, wc->chan);
223  return AVERROR_INVALIDDATA;
224  }
225  if (flags && rate != -1 && !(flags & WV_DSD) && rate * rate_x != wc->rate) {
227  "Sampling rate differ, this block: %i, header block: %i\n",
228  rate * rate_x, wc->rate);
229  return AVERROR_INVALIDDATA;
230  }
231  return 0;
232 }
233 
235 {
236  AVIOContext *pb = s->pb;
237  WVContext *wc = s->priv_data;
238  AVStream *st;
239  int ret;
240 
241  wc->block_parsed = 0;
242  for (;;) {
243  if ((ret = wv_read_block_header(s, pb)) < 0)
244  return ret;
245  if (!wc->header.samples)
246  avio_skip(pb, wc->header.blocksize);
247  else
248  break;
249  }
250 
251  /* now we are ready: build format streams */
252  st = avformat_new_stream(s, NULL);
253  if (!st)
254  return AVERROR(ENOMEM);
255  if ((ret = ff_alloc_extradata(st->codecpar, 2)) < 0)
256  return ret;
261  st->codecpar->sample_rate = wc->rate;
263  avpriv_set_pts_info(st, 64, 1, wc->rate);
264  st->start_time = 0;
265  if (wc->header.total_samples != 0xFFFFFFFFu)
266  st->duration = wc->header.total_samples;
267 
268  if (s->pb->seekable & AVIO_SEEKABLE_NORMAL) {
269  int64_t cur = avio_tell(s->pb);
271  if (av_dict_count(s->metadata) == 0)
272  ff_id3v1_read(s);
273  avio_seek(s->pb, cur, SEEK_SET);
274  }
275 
276  return 0;
277 }
278 
280 {
281  WVContext *wc = s->priv_data;
282  int ret;
283  int off;
284  int64_t pos;
285  uint32_t block_samples;
286 
287  if (avio_feof(s->pb))
288  return AVERROR_EOF;
289  if (wc->block_parsed) {
290  if ((ret = wv_read_block_header(s, s->pb)) < 0)
291  return ret;
292  }
293 
294  pos = wc->pos;
295  if ((ret = av_new_packet(pkt, wc->header.blocksize + WV_HEADER_SIZE)) < 0)
296  return ret;
297  memcpy(pkt->data, wc->block_header, WV_HEADER_SIZE);
299  if (ret != wc->header.blocksize) {
300  return AVERROR(EIO);
301  }
302  while (!(wc->header.flags & WV_FLAG_FINAL_BLOCK)) {
303  if ((ret = wv_read_block_header(s, s->pb)) < 0) {
304  return ret;
305  }
306 
307  off = pkt->size;
308  if ((ret = av_grow_packet(pkt, WV_HEADER_SIZE + wc->header.blocksize)) < 0) {
309  return ret;
310  }
311  memcpy(pkt->data + off, wc->block_header, WV_HEADER_SIZE);
312 
313  ret = avio_read(s->pb, pkt->data + off + WV_HEADER_SIZE, wc->header.blocksize);
314  if (ret != wc->header.blocksize) {
315  return (ret < 0) ? ret : AVERROR_EOF;
316  }
317  }
318  pkt->stream_index = 0;
319  pkt->pos = pos;
320  wc->block_parsed = 1;
321  pkt->pts = wc->header.block_idx;
322  block_samples = wc->header.samples;
323  if (block_samples > INT32_MAX)
325  "Too many samples in block: %"PRIu32"\n", block_samples);
326  else
327  pkt->duration = block_samples;
328 
329  return 0;
330 }
331 
333  .p.name = "wv",
334  .p.long_name = NULL_IF_CONFIG_SMALL("WavPack"),
335  .p.flags = AVFMT_GENERIC_INDEX,
336  .priv_data_size = sizeof(WVContext),
337  .read_probe = wv_probe,
340 };
WvHeader::total_samples
uint32_t total_samples
Definition: wv.h:37
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:69
WV_FLOAT
@ WV_FLOAT
Definition: wvdec.c:38
WV_MCEND
@ WV_MCEND
Definition: wvdec.c:43
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:51
WV_BLOCK_LIMIT
#define WV_BLOCK_LIMIT
Definition: wv.h:32
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const struct AVCodec *c)
Add a new stream to a media file.
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
av_dict_count
int av_dict_count(const AVDictionary *m)
Get number of entries in dictionary.
Definition: dict.c:39
AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_MONO
Definition: channel_layout.h:212
wv_read_header
static int wv_read_header(AVFormatContext *s)
Definition: wvdec.c:234
int64_t
long long int64_t
Definition: coverity.c:34
av_grow_packet
int av_grow_packet(AVPacket *pkt, int grow_by)
Increase packet size, correctly zeroing padding.
Definition: packet.c:121
wv_read_packet
static int wv_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: wvdec.c:279
apetag.h
WvHeader::samples
uint32_t samples
Definition: wv.h:39
AVPacket::data
uint8_t * data
Definition: packet.h:533
ff_id3v1_read
void ff_id3v1_read(AVFormatContext *s)
Read an ID3v1 tag.
Definition: id3v1.c:278
WV_MCINIT
@ WV_MCINIT
Definition: wvdec.c:42
WV_MONO
@ WV_MONO
Definition: wvdec.c:33
WV_HYBRID
@ WV_HYBRID
Definition: wvdec.c:34
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:551
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:454
WvHeader
Definition: wv.h:34
id3v1.h
wv_probe
static int wv_probe(const AVProbeData *p)
Definition: wvdec.c:64
ff_ape_parse_tag
int64_t ff_ape_parse_tag(AVFormatContext *s)
Read and parse an APE tag.
Definition: apetag.c:110
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:463
WVContext::multichannel
int multichannel
Definition: wvdec.c:57
avpriv_set_pts_info
void avpriv_set_pts_info(AVStream *st, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: avformat.c:855
WV_DSD
@ WV_DSD
Definition: wvdec.c:44
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:494
WvHeader::block_idx
uint32_t block_idx
Definition: wv.h:38
AVFMT_GENERIC_INDEX
#define AVFMT_GENERIC_INDEX
Use generic index building code.
Definition: avformat.h:480
WvHeader::blocksize
uint32_t blocksize
Definition: wv.h:35
AVStream::duration
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:807
WV_HSHAPE
@ WV_HSHAPE
Definition: wvdec.c:37
avio_rl16
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:714
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:213
pkt
AVPacket * pkt
Definition: movenc.c:60
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_read_callback.c:42
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
av_new_packet
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: packet.c:98
WVContext::pos
int64_t pos
Definition: wvdec.c:59
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:553
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:453
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
av_channel_layout_from_mask
int av_channel_layout_from_mask(AVChannelLayout *channel_layout, uint64_t mask)
Initialize a native channel layout from a bitmask indicating which channels are present.
Definition: channel_layout.c:247
ctx
AVFormatContext * ctx
Definition: movenc.c:49
AV_RL16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:94
WV_FLAG_FINAL_BLOCK
#define WV_FLAG_FINAL_BLOCK
Definition: wv.h:29
WVContext::apetag_start
int64_t apetag_start
Definition: wvdec.c:61
AVFormatContext
Format I/O context.
Definition: avformat.h:1260
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:771
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:550
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
WV_FLAGS
WV_FLAGS
Definition: wvdec.c:32
WV_HBR
@ WV_HBR
Definition: wvdec.c:40
WV_HEADER_SIZE
#define WV_HEADER_SIZE
Definition: wavpack.h:33
WV_JOINT
@ WV_JOINT
Definition: wvdec.c:35
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:451
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:180
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:184
ff_wv_parse_header
int ff_wv_parse_header(WvHeader *wv, const uint8_t *data)
Parse a WavPack block header.
Definition: wv.c:30
WvHeader::initial
int initial
Definition: wv.h:43
WVContext::header
WvHeader header
Definition: wvdec.c:54
avio_rl32
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:730
AVIOContext
Bytestream IO Context.
Definition: avio.h:160
WvHeader::flags
uint32_t flags
Definition: wv.h:40
AVPacket::size
int size
Definition: packet.h:534
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
AVIOContext::seekable
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:261
size
int size
Definition: twinvq_data.h:10344
avpriv_report_missing_feature
void avpriv_report_missing_feature(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
FFInputFormat::p
AVInputFormat p
The public AVInputFormat.
Definition: demux.h:41
AV_WL16
#define AV_WL16(p, v)
Definition: intreadwrite.h:406
avio_r8
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:603
WV_CROSSD
@ WV_CROSSD
Definition: wvdec.c:36
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:526
avio_rl24
unsigned int avio_rl24(AVIOContext *s)
Definition: aviobuf.c:722
demux.h
WVContext::chan
int chan
Definition: wvdec.c:55
WVContext::chmask
uint32_t chmask
Definition: wvdec.c:56
WVContext
Definition: wvdec.c:52
WvHeader::version
uint16_t version
Definition: wv.h:36
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:748
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:231
WVContext::block_header
uint8_t block_header[WV_HEADER_SIZE]
Definition: wvdec.c:53
pos
unsigned int pos
Definition: spdifenc.c:414
avformat.h
dict.h
id
enum AVCodecID id
Definition: dts2pts.c:365
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
U
#define U(x)
Definition: vpx_arith.h:37
channel_layout.h
WVContext::rate
int rate
Definition: wvdec.c:55
wv.h
AVIO_SEEKABLE_NORMAL
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:41
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:612
AVPacket::stream_index
int stream_index
Definition: packet.h:535
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:318
read_probe
static int read_probe(const AVProbeData *p)
Definition: cdg.c:30
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:110
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:55
AVPacket
This structure stores compressed data.
Definition: packet.h:510
WV_HBAL
@ WV_HBAL
Definition: wvdec.c:41
AVPacket::pos
int64_t pos
byte position in stream, -1 if unknown
Definition: packet.h:553
WVContext::bpp
int bpp
Definition: wvdec.c:55
FFInputFormat
Definition: demux.h:37
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:474
WvHeader::final
int final
Definition: wv.h:43
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AV_CODEC_ID_WAVPACK
@ AV_CODEC_ID_WAVPACK
Definition: codec_id.h:465
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
ff_wv_demuxer
const FFInputFormat ff_wv_demuxer
Definition: wvdec.c:332
MKTAG
#define MKTAG(a, b, c, d)
Definition: macros.h:55
AVStream::start_time
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base.
Definition: avformat.h:797
AVFormatContext::priv_data
void * priv_data
Format private data.
Definition: avformat.h:1288
wv_read_block_header
static int wv_read_block_header(AVFormatContext *ctx, AVIOContext *pb)
Definition: wvdec.c:79
WV_INT32
@ WV_INT32
Definition: wvdec.c:39
WVContext::block_parsed
int block_parsed
Definition: wvdec.c:58
ff_alloc_extradata
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:227
wv_rates
static const int wv_rates[16]
Definition: wvdec.c:47
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:346