2 * WavPack lossless audio decoder
3 * Copyright (c) 2006 Konstantin Shishkov
5 * This file is part of FFmpeg.
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.
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.
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
21 #define ALT_BITSTREAM_READER_LE
23 #include "bitstream.h"
27 * WavPack lossless audio decoder
30 #define WV_JOINT 0x0010
58 typedef struct Decorr {
67 typedef struct WavpackContext {
68 AVCodecContext *avctx;
73 int data_size; // in bits
77 Decorr decorr[MAX_TERMS];
78 int zero, one, zeroes;
81 // exponent table copied from WavPack source
82 static const uint8_t wp_exp2_table [256] = {
83 0x00, 0x01, 0x01, 0x02, 0x03, 0x03, 0x04, 0x05, 0x06, 0x06, 0x07, 0x08, 0x08, 0x09, 0x0a, 0x0b,
84 0x0b, 0x0c, 0x0d, 0x0e, 0x0e, 0x0f, 0x10, 0x10, 0x11, 0x12, 0x13, 0x13, 0x14, 0x15, 0x16, 0x16,
85 0x17, 0x18, 0x19, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1d, 0x1e, 0x1f, 0x20, 0x20, 0x21, 0x22, 0x23,
86 0x24, 0x24, 0x25, 0x26, 0x27, 0x28, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2c, 0x2d, 0x2e, 0x2f, 0x30,
87 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3a, 0x3b, 0x3c, 0x3d,
88 0x3e, 0x3f, 0x40, 0x41, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x48, 0x49, 0x4a, 0x4b,
89 0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a,
90 0x5b, 0x5c, 0x5d, 0x5e, 0x5e, 0x5f, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69,
91 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79,
92 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x87, 0x88, 0x89, 0x8a,
93 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x90, 0x91, 0x92, 0x93, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9b,
94 0x9c, 0x9d, 0x9f, 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad,
95 0xaf, 0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb6, 0xb7, 0xb8, 0xb9, 0xba, 0xbc, 0xbd, 0xbe, 0xbf, 0xc0,
96 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc8, 0xc9, 0xca, 0xcb, 0xcd, 0xce, 0xcf, 0xd0, 0xd2, 0xd3, 0xd4,
97 0xd6, 0xd7, 0xd8, 0xd9, 0xdb, 0xdc, 0xdd, 0xde, 0xe0, 0xe1, 0xe2, 0xe4, 0xe5, 0xe6, 0xe8, 0xe9,
98 0xea, 0xec, 0xed, 0xee, 0xf0, 0xf1, 0xf2, 0xf4, 0xf5, 0xf6, 0xf8, 0xf9, 0xfa, 0xfc, 0xfd, 0xff
101 static av_always_inline int wp_exp2(int16_t val)
110 res = wp_exp2_table[val & 0xFF] | 0x100;
112 res = (val > 9) ? (res << (val - 9)) : (res >> (9 - val));
113 return neg ? -res : res;
116 static inline int get_unary(GetBitContext *gb){
118 while(get_bits1(gb) && r<33)r++;
122 // macros for manipulating median values
123 #define GET_MED(n) ((median[n] >> 4) + 1)
124 #define DEC_MED(n) median[n] -= ((median[n] + (128>>n) - 2) / (128>>n)) * 2
125 #define INC_MED(n) median[n] += ((median[n] + (128>>n)) / (128>>n)) * 5
127 // macros for applying weight
128 #define UPDATE_WEIGHT_CLIP(weight, delta, samples, in) \
130 if((samples ^ in) < 0){ \
132 if(weight < -1024) weight = -1024; \
135 if(weight > 1024) weight = 1024; \
140 static av_always_inline int get_tail(GetBitContext *gb, int k)
146 e = (1 << (p + 1)) - k - 1;
147 res = p ? get_bits(gb, p) : 0;
149 res = (res<<1) - e + get_bits1(gb);
154 static int wv_get_value(WavpackContext *ctx, GetBitContext *gb, int *median, int *last)
157 int sign, base, add, ret;
161 if((ctx->median[0] < 2U) && (ctx->median[3] < 2U) && !ctx->zero && !ctx->one){
168 if(t >= 2) t = get_bits(gb, t - 1) | (1 << (t-1));
171 memset(ctx->median, 0, sizeof(ctx->median));
177 if(get_bits_count(gb) >= ctx->data_size){
187 if(get_bits_count(gb) >= ctx->data_size){
194 else t += get_bits(gb, t2 - 1) | (1 << (t2 - 1));
204 ctx->zero = !ctx->one;
209 add = GET_MED(0) - 1;
213 add = GET_MED(1) - 1;
217 base = GET_MED(0) + GET_MED(1);
218 add = GET_MED(2) - 1;
223 base = GET_MED(0) + GET_MED(1) + GET_MED(2) * (t - 2);
224 add = GET_MED(2) - 1;
229 ret = base + get_tail(gb, add);
230 sign = get_bits1(gb);
231 return sign ? ~ret : ret;
234 static int wv_unpack_stereo(WavpackContext *s, GetBitContext *gb, int16_t *dst)
238 int A, B, L, L2, R, R2;
240 uint32_t crc = 0xFFFFFFFF;
242 s->one = s->zero = s->zeroes = 0;
244 L = wv_get_value(s, gb, s->median, &last);
246 R = wv_get_value(s, gb, s->median + 3, &last);
248 for(i = 0; i < s->terms; i++){
249 t = s->decorr[i].value;
254 A = 2 * s->decorr[i].samplesA[0] - s->decorr[i].samplesA[1];
255 B = 2 * s->decorr[i].samplesB[0] - s->decorr[i].samplesB[1];
257 A = (3 * s->decorr[i].samplesA[0] - s->decorr[i].samplesA[1]) >> 1;
258 B = (3 * s->decorr[i].samplesB[0] - s->decorr[i].samplesB[1]) >> 1;
260 s->decorr[i].samplesA[1] = s->decorr[i].samplesA[0];
261 s->decorr[i].samplesB[1] = s->decorr[i].samplesB[0];
264 A = s->decorr[i].samplesA[pos];
265 B = s->decorr[i].samplesB[pos];
268 L2 = L + ((s->decorr[i].weightA * A + 512) >> 10);
269 R2 = R + ((s->decorr[i].weightB * B + 512) >> 10);
270 if(A && L) s->decorr[i].weightA -= ((((L ^ A) >> 30) & 2) - 1) * s->decorr[i].delta;
271 if(B && R) s->decorr[i].weightB -= ((((R ^ B) >> 30) & 2) - 1) * s->decorr[i].delta;
272 s->decorr[i].samplesA[j] = L = L2;
273 s->decorr[i].samplesB[j] = R = R2;
275 L2 = L + ((s->decorr[i].weightA * s->decorr[i].samplesA[0] + 512) >> 10);
276 UPDATE_WEIGHT_CLIP(s->decorr[i].weightA, s->decorr[i].delta, s->decorr[i].samplesA[0], L);
278 R2 = R + ((s->decorr[i].weightB * L2 + 512) >> 10);
279 UPDATE_WEIGHT_CLIP(s->decorr[i].weightB, s->decorr[i].delta, L2, R);
281 s->decorr[i].samplesA[0] = R;
283 R2 = R + ((s->decorr[i].weightB * s->decorr[i].samplesB[0] + 512) >> 10);
284 UPDATE_WEIGHT_CLIP(s->decorr[i].weightB, s->decorr[i].delta, s->decorr[i].samplesB[0], R);
288 R2 = s->decorr[i].samplesA[0];
289 s->decorr[i].samplesA[0] = R;
292 L2 = L + ((s->decorr[i].weightA * R2 + 512) >> 10);
293 UPDATE_WEIGHT_CLIP(s->decorr[i].weightA, s->decorr[i].delta, R2, L);
295 s->decorr[i].samplesB[0] = L;
300 L += (R -= (L >> 1));
301 crc = (crc * 3 + L) * 3 + R;
306 }while(!last && count < s->samples);
309 av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
315 static int wv_unpack_mono(WavpackContext *s, GetBitContext *gb, int16_t *dst)
321 uint32_t crc = 0xFFFFFFFF;
323 s->one = s->zero = s->zeroes = 0;
325 T = wv_get_value(s, gb, s->median, &last);
328 for(i = 0; i < s->terms; i++){
329 t = s->decorr[i].value;
332 A = 2 * s->decorr[i].samplesA[0] - s->decorr[i].samplesA[1];
334 A = (3 * s->decorr[i].samplesA[0] - s->decorr[i].samplesA[1]) >> 1;
335 s->decorr[i].samplesA[1] = s->decorr[i].samplesA[0];
338 A = s->decorr[i].samplesA[pos];
341 S = T + ((s->decorr[i].weightA * A + 512) >> 10);
342 if(A && T) s->decorr[i].weightA -= ((((T ^ A) >> 30) & 2) - 1) * s->decorr[i].delta;
343 s->decorr[i].samplesA[j] = T = S;
349 }while(!last && count < s->samples);
352 av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
358 static int wavpack_decode_init(AVCodecContext *avctx)
360 WavpackContext *s = avctx->priv_data;
363 s->stereo = (avctx->channels == 2);
368 static int wavpack_decode_close(AVCodecContext *avctx)
370 // WavpackContext *s = avctx->priv_data;
375 static int wavpack_decode_frame(AVCodecContext *avctx,
376 void *data, int *data_size,
377 uint8_t *buf, int buf_size)
379 WavpackContext *s = avctx->priv_data;
380 int16_t *samples = data;
382 int got_terms = 0, got_weights = 0, got_samples = 0, got_entropy = 0, got_bs = 0;
383 uint8_t* buf_end = buf + buf_size;
384 int i, j, id, size, ssize, weights, t;
391 memset(s->decorr, 0, MAX_TERMS * sizeof(Decorr));
393 s->samples = AV_RL32(buf); buf += 4;
398 /* should not happen but who knows */
399 if(s->samples * 2 * avctx->channels > *data_size){
400 av_log(avctx, AV_LOG_ERROR, "Packet size is too big to be handled in lavc!\n");
403 s->joint = AV_RL32(buf) & WV_JOINT; buf += 4;
404 s->CRC = AV_RL32(buf); buf += 4;
405 // parse metadata blocks
406 while(buf < buf_end){
409 if(id & WP_IDF_LONG) {
410 size |= (*buf++) << 8;
411 size |= (*buf++) << 16;
413 size <<= 1; // size is specified in words
415 if(id & WP_IDF_ODD) size--;
417 av_log(avctx, AV_LOG_ERROR, "Got incorrect block %02X with size %i\n", id, size);
420 if(buf + ssize > buf_end){
421 av_log(avctx, AV_LOG_ERROR, "Block size %i is out of bounds\n", size);
424 if(id & WP_IDF_IGNORE){
428 switch(id & WP_IDF_MASK){
431 if(s->terms > MAX_TERMS){
432 av_log(avctx, AV_LOG_ERROR, "Too many decorrelation terms\n");
436 for(i = 0; i < s->terms; i++) {
437 s->decorr[s->terms - i - 1].value = (*buf & 0x1F) - 5;
438 s->decorr[s->terms - i - 1].delta = *buf >> 5;
443 case WP_ID_DECWEIGHTS:
445 av_log(avctx, AV_LOG_ERROR, "No decorrelation terms met\n");
448 weights = size >> s->stereo;
449 if(weights > MAX_TERMS || weights > s->terms){
450 av_log(avctx, AV_LOG_ERROR, "Too many decorrelation weights\n");
454 for(i = 0; i < weights; i++) {
455 t = (int8_t)(*buf++);
456 s->decorr[s->terms - i - 1].weightA = t << 3;
457 if(s->decorr[s->terms - i - 1].weightA > 0)
458 s->decorr[s->terms - i - 1].weightA += (s->decorr[s->terms - i - 1].weightA + 64) >> 7;
460 t = (int8_t)(*buf++);
461 s->decorr[s->terms - i - 1].weightB = t << 3;
462 if(s->decorr[s->terms - i - 1].weightB > 0)
463 s->decorr[s->terms - i - 1].weightB += (s->decorr[s->terms - i - 1].weightB + 64) >> 7;
468 case WP_ID_DECSAMPLES:
470 av_log(avctx, AV_LOG_ERROR, "No decorrelation terms met\n");
474 for(i = s->terms - 1; (i >= 0) && (t < size); i--) {
475 if(s->decorr[i].value > 8){
476 s->decorr[i].samplesA[0] = wp_exp2(AV_RL16(buf)); buf += 2;
477 s->decorr[i].samplesA[1] = wp_exp2(AV_RL16(buf)); buf += 2;
479 s->decorr[i].samplesB[0] = wp_exp2(AV_RL16(buf)); buf += 2;
480 s->decorr[i].samplesB[1] = wp_exp2(AV_RL16(buf)); buf += 2;
484 }else if(s->decorr[i].value < 0){
485 s->decorr[i].samplesA[0] = wp_exp2(AV_RL16(buf)); buf += 2;
486 s->decorr[i].samplesB[0] = wp_exp2(AV_RL16(buf)); buf += 2;
489 for(j = 0; j < s->decorr[i].value; j++){
490 s->decorr[i].samplesA[j] = wp_exp2(AV_RL16(buf)); buf += 2;
492 s->decorr[i].samplesB[j] = wp_exp2(AV_RL16(buf)); buf += 2;
495 t += s->decorr[i].value * 2 * avctx->channels;
501 if(size != 6 * avctx->channels){
502 av_log(avctx, AV_LOG_ERROR, "Entropy vars size should be %i, got %i", 6 * avctx->channels, size);
506 for(i = 0; i < 3 * avctx->channels; i++){
507 s->median[i] = wp_exp2(AV_RL16(buf));
513 init_get_bits(&s->gb, buf, size * 8);
514 s->data_size = size * 8;
521 if(id & WP_IDF_ODD) buf++;
524 av_log(avctx, AV_LOG_ERROR, "No block with decorrelation terms\n");
528 av_log(avctx, AV_LOG_ERROR, "No block with decorrelation weights\n");
532 av_log(avctx, AV_LOG_ERROR, "No block with decorrelation samples\n");
536 av_log(avctx, AV_LOG_ERROR, "No block with entropy info\n");
540 av_log(avctx, AV_LOG_ERROR, "Packed samples not found\n");
545 samplecount = wv_unpack_stereo(s, &s->gb, samples);
547 samplecount = wv_unpack_mono(s, &s->gb, samples);
548 *data_size = samplecount * 2;
553 AVCodec wavpack_decoder = {
557 sizeof(WavpackContext),
560 wavpack_decode_close,
561 wavpack_decode_frame,