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 "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, bpp, chan;
83  uint32_t chmask, flags;
84  unsigned rate_x;
85 
86  wc->pos = avio_tell(pb);
87 
88  /* don't return bogus packets with the ape tag data */
89  if (wc->apetag_start && wc->pos >= wc->apetag_start)
90  return AVERROR_EOF;
91 
93  if (ret != WV_HEADER_SIZE)
94  return (ret < 0) ? ret : AVERROR_EOF;
95 
97  if (ret < 0) {
98  av_log(ctx, AV_LOG_ERROR, "Invalid block header.\n");
99  return ret;
100  }
101 
102  if (wc->header.version < 0x402 || wc->header.version > 0x410) {
103  avpriv_report_missing_feature(ctx, "WV version 0x%03X",
104  wc->header.version);
105  return AVERROR_PATCHWELCOME;
106  }
107 
108  /* Blocks with zero samples don't contain actual audio information
109  * and should be ignored */
110  if (!wc->header.samples)
111  return 0;
112  // parse flags
113  flags = wc->header.flags;
114  rate_x = (flags & WV_DSD) ? 4 : 1;
115  bpp = (flags & WV_DSD) ? 0 : ((flags & 3) + 1) << 3;
116  chan = 1 + !(flags & WV_MONO);
118  rate = wv_rates[(flags >> 23) & 0xF];
119  wc->multichannel = !(wc->header.initial && wc->header.final);
120  if (wc->multichannel) {
121  chan = wc->chan;
122  chmask = wc->chmask;
123  }
124  if ((rate == -1 || !chan || flags & WV_DSD) && !wc->block_parsed) {
125  int64_t block_end = avio_tell(pb) + wc->header.blocksize;
126  if (!(pb->seekable & AVIO_SEEKABLE_NORMAL)) {
128  "Cannot determine additional parameters\n");
129  return AVERROR_INVALIDDATA;
130  }
131  while (avio_tell(pb) < block_end && !avio_feof(pb)) {
132  int id, size;
133  id = avio_r8(pb);
134  size = (id & 0x80) ? avio_rl24(pb) : avio_r8(pb);
135  size <<= 1;
136  if (id & 0x40)
137  size--;
138  switch (id & 0x3F) {
139  case 0xD:
140  if (size <= 1) {
142  "Insufficient channel information\n");
143  return AVERROR_INVALIDDATA;
144  }
145  chan = avio_r8(pb);
146  switch (size - 2) {
147  case 0:
148  chmask = avio_r8(pb);
149  break;
150  case 1:
151  chmask = avio_rl16(pb);
152  break;
153  case 2:
154  chmask = avio_rl24(pb);
155  break;
156  case 3:
157  chmask = avio_rl32(pb);
158  break;
159  case 4:
160  avio_skip(pb, 1);
161  chan |= (avio_r8(pb) & 0xF) << 8;
162  chan += 1;
163  chmask = avio_rl24(pb);
164  break;
165  case 5:
166  avio_skip(pb, 1);
167  chan |= (avio_r8(pb) & 0xF) << 8;
168  chan += 1;
169  chmask = avio_rl32(pb);
170  break;
171  default:
173  "Invalid channel info size %d\n", size);
174  return AVERROR_INVALIDDATA;
175  }
176  break;
177  case 0xE:
178  if (size <= 1) {
180  "Invalid DSD block\n");
181  return AVERROR_INVALIDDATA;
182  }
183  rate_x = 1U << (avio_r8(pb) & 0x1f);
184  if (size)
185  avio_skip(pb, size-1);
186  break;
187  case 0x27:
188  rate = avio_rl24(pb);
189  break;
190  default:
191  avio_skip(pb, size);
192  }
193  if (id & 0x40)
194  avio_skip(pb, 1);
195  }
196  if (rate == -1 || rate * (uint64_t)rate_x >= INT_MAX) {
198  "Cannot determine custom sampling rate\n");
199  return AVERROR_INVALIDDATA;
200  }
201  avio_seek(pb, block_end - wc->header.blocksize, SEEK_SET);
202  }
203  if (!wc->bpp)
204  wc->bpp = bpp;
205  if (!wc->chan)
206  wc->chan = chan;
207  if (!wc->chmask)
208  wc->chmask = chmask;
209  if (!wc->rate)
210  wc->rate = rate * rate_x;
211 
212  if (flags && bpp != wc->bpp) {
214  "Bits per sample differ, this block: %i, header block: %i\n",
215  bpp, wc->bpp);
216  return AVERROR_INVALIDDATA;
217  }
218  if (flags && !wc->multichannel && chan != wc->chan) {
220  "Channels differ, this block: %i, header block: %i\n",
221  chan, wc->chan);
222  return AVERROR_INVALIDDATA;
223  }
224  if (flags && rate != -1 && !(flags & WV_DSD) && rate * rate_x != wc->rate) {
226  "Sampling rate differ, this block: %i, header block: %i\n",
227  rate * rate_x, wc->rate);
228  return AVERROR_INVALIDDATA;
229  }
230  return 0;
231 }
232 
234 {
235  AVIOContext *pb = s->pb;
236  WVContext *wc = s->priv_data;
237  AVStream *st;
238  int ret;
239 
240  wc->block_parsed = 0;
241  for (;;) {
242  if ((ret = wv_read_block_header(s, pb)) < 0)
243  return ret;
244  if (!wc->header.samples)
245  avio_skip(pb, wc->header.blocksize);
246  else
247  break;
248  }
249 
250  /* now we are ready: build format streams */
251  st = avformat_new_stream(s, NULL);
252  if (!st)
253  return AVERROR(ENOMEM);
254  if ((ret = ff_alloc_extradata(st->codecpar, 2)) < 0)
255  return ret;
259  st->codecpar->channels = wc->chan;
260  st->codecpar->channel_layout = wc->chmask;
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_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
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  .name = "wv",
334  .long_name = NULL_IF_CONFIG_SMALL("WavPack"),
335  .priv_data_size = sizeof(WVContext),
336  .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:200
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:74
WV_FLOAT
@ WV_FLOAT
Definition: wvdec.c:37
WV_MCEND
@ WV_MCEND
Definition: wvdec.c:42
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
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4553
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
WV_BLOCK_LIMIT
#define WV_BLOCK_LIMIT
Definition: wv.h:32
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:55
MKTAG
#define MKTAG(a, b, c, d)
Definition: common.h:478
AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_MONO
Definition: channel_layout.h:90
wv_read_header
static int wv_read_header(AVFormatContext *s)
Definition: wvdec.c:233
av_grow_packet
int av_grow_packet(AVPacket *pkt, int grow_by)
Increase packet size, correctly zeroing padding.
Definition: avpacket.c:122
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:369
ff_id3v1_read
void ff_id3v1_read(AVFormatContext *s)
Read an ID3v1 tag.
Definition: id3v1.c:279
WV_MCINIT
@ WV_MCINIT
Definition: wvdec.c:41
WV_MONO
@ WV_MONO
Definition: wvdec.c:32
AV_DICT_IGNORE_SUFFIX
#define AV_DICT_IGNORE_SUFFIX
Return first entry in a dictionary whose first part corresponds to the search key,...
Definition: dict.h:70
WV_HYBRID
@ WV_HYBRID
Definition: wvdec.c:33
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:387
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:444
WvHeader
Definition: wv.h:34
id3v1.h
wv_probe
static int wv_probe(const AVProbeData *p)
Definition: wvdec.c:63
ff_ape_parse_tag
int64_t ff_ape_parse_tag(AVFormatContext *s)
Read and parse an APE tag.
Definition: apetag.c:108
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
WVContext::multichannel
int multichannel
Definition: wvdec.c:56
AVCodecParameters::channels
int channels
Audio only.
Definition: codec_par.h:166
U
#define U(x)
Definition: vp56_arith.h:37
WV_DSD
@ WV_DSD
Definition: wvdec.c:43
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
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:463
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:922
WV_HSHAPE
@ WV_HSHAPE
Definition: wvdec.c:36
avio_rl16
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:734
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:91
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
AVInputFormat
Definition: avformat.h:640
av_dict_get
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
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
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: avpacket.c:99
WVContext::pos
int64_t pos
Definition: wvdec.c:58
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:645
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
ctx
AVFormatContext * ctx
Definition: movenc.c:48
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:60
AVFormatContext
Format I/O context.
Definition: avformat.h:1231
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1038
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
read_probe
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
WV_FLAGS
WV_FLAGS
Definition: wvdec.c:31
WV_HBR
@ WV_HBR
Definition: wvdec.c:39
WV_HEADER_SIZE
#define WV_HEADER_SIZE
Definition: wavpack.h:30
WV_JOINT
@ WV_JOINT
Definition: wvdec.c:34
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:170
ff_wv_parse_header
int ff_wv_parse_header(WvHeader *wv, const uint8_t *data)
Parse a WavPack block header.
Definition: wv.c:29
WvHeader::initial
int initial
Definition: wv.h:43
WVContext::header
WvHeader header
Definition: wvdec.c:53
avio_rl32
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:750
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
WvHeader::flags
uint32_t flags
Definition: wv.h:40
AVPacket::size
int size
Definition: packet.h:370
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:117
id
enum AVCodecID id
Definition: extract_extradata_bsf.c:325
AVIOContext::seekable
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:260
avpriv_set_pts_info
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:4999
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.
AV_WL16
#define AV_WL16(p, v)
Definition: intreadwrite.h:412
avio_r8
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:624
WV_CROSSD
@ WV_CROSSD
Definition: wvdec.c:35
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:362
avio_rl24
unsigned int avio_rl24(AVIOContext *s)
Definition: aviobuf.c:742
uint8_t
uint8_t
Definition: audio_convert.c:194
WVContext::chan
int chan
Definition: wvdec.c:54
WVContext::chmask
uint32_t chmask
Definition: wvdec.c:55
WVContext
Definition: wvdec.c:51
WvHeader::version
uint16_t version
Definition: wv.h:36
ret
ret
Definition: filter_design.txt:187
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVStream
Stream structure.
Definition: avformat.h:873
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:253
WVContext::block_header
uint8_t block_header[WV_HEADER_SIZE]
Definition: wvdec.c:52
pos
unsigned int pos
Definition: spdifenc.c:412
avformat.h
dict.h
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
channel_layout.h
WVContext::rate
int rate
Definition: wvdec.c:54
wv.h
AVIO_SEEKABLE_NORMAL
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:633
ff_wv_demuxer
AVInputFormat ff_wv_demuxer
Definition: wvdec.c:332
AVPacket::stream_index
int stream_index
Definition: packet.h:371
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:337
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
AVPacket
This structure stores compressed data.
Definition: packet.h:346
WV_HBAL
@ WV_HBAL
Definition: wvdec.c:40
AVPacket::pos
int64_t pos
byte position in stream, -1 if unknown
Definition: packet.h:389
WVContext::bpp
int bpp
Definition: wvdec.c:54
AVCodecParameters::channel_layout
uint64_t channel_layout
Audio only.
Definition: codec_par.h:162
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
WvHeader::final
int final
Definition: wv.h:43
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AV_CODEC_ID_WAVPACK
@ AV_CODEC_ID_WAVPACK
Definition: codec_id.h:449
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
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:912
AVFormatContext::priv_data
void * priv_data
Format private data.
Definition: avformat.h:1259
wv_read_block_header
static int wv_read_block_header(AVFormatContext *ctx, AVIOContext *pb)
Definition: wvdec.c:78
WV_INT32
@ WV_INT32
Definition: wvdec.c:38
WVContext::block_parsed
int block_parsed
Definition: wvdec.c:57
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:3368
wv_rates
static const int wv_rates[16]
Definition: wvdec.c:46
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:364