git.sesse.net Git - ffmpeg/blob - libavcodec/wavpack.c

   1 /*
   2  * WavPack lossless audio decoder
   3  * Copyright (c) 2006 Konstantin Shishkov
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19 #define ALT_BITSTREAM_READER_LE
  20 #include "avcodec.h"
  21 #include "bitstream.h"
  22
  23 /**
  24  * @file wavpack.c
  25  * WavPack lossless audio decoder
  26  */
  27
  28 #define WV_JOINT 0x0010
  29
  30 enum WP_ID_Flags{
  31     WP_IDF_MASK   = 0x1F,
  32     WP_IDF_IGNORE = 0x20,
  33     WP_IDF_ODD    = 0x40,
  34     WP_IDF_LONG   = 0x80
  35 };
  36
  37 enum WP_ID{
  38     WP_ID_DUMMY = 0,
  39     WP_ID_ENCINFO,
  40     WP_ID_DECTERMS,
  41     WP_ID_DECWEIGHTS,
  42     WP_ID_DECSAMPLES,
  43     WP_ID_ENTROPY,
  44     WP_ID_HYBRID,
  45     WP_ID_SHAPING,
  46     WP_ID_FLOATINFO,
  47     WP_ID_INT32INFO,
  48     WP_ID_DATA,
  49     WP_ID_CORR,
  50     WP_ID_FLT,
  51     WP_ID_CHANINFO
  52 };
  53
  54 #define MAX_TERMS 16
  55
  56 typedef struct Decorr {
  57     int delta;
  58     int value;
  59     int weightA;
  60     int weightB;
  61     int samplesA[8];
  62     int samplesB[8];
  63 } Decorr;
  64
  65 typedef struct WavpackContext {
  66     AVCodecContext *avctx;
  67     int stereo;
  68     int joint;
  69     uint32_t CRC;
  70     GetBitContext gb;
  71     int data_size; // in bits
  72     int samples;
  73     int median[6];
  74     int terms;
  75     Decorr decorr[MAX_TERMS];
  76     int zero, one, zeroes;
  77 } WavpackContext;
  78
  79 // exponent table copied from WavPack source
  80 static const uint8_t wp_exp2_table [256] = {
  81     0x00, 0x01, 0x01, 0x02, 0x03, 0x03, 0x04, 0x05, 0x06, 0x06, 0x07, 0x08, 0x08, 0x09, 0x0a, 0x0b,
  82     0x0b, 0x0c, 0x0d, 0x0e, 0x0e, 0x0f, 0x10, 0x10, 0x11, 0x12, 0x13, 0x13, 0x14, 0x15, 0x16, 0x16,
  83     0x17, 0x18, 0x19, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1d, 0x1e, 0x1f, 0x20, 0x20, 0x21, 0x22, 0x23,
  84     0x24, 0x24, 0x25, 0x26, 0x27, 0x28, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2c, 0x2d, 0x2e, 0x2f, 0x30,
  85     0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3a, 0x3b, 0x3c, 0x3d,
  86     0x3e, 0x3f, 0x40, 0x41, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x48, 0x49, 0x4a, 0x4b,
  87     0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a,
  88     0x5b, 0x5c, 0x5d, 0x5e, 0x5e, 0x5f, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69,
  89     0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79,
  90     0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x87, 0x88, 0x89, 0x8a,
  91     0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x90, 0x91, 0x92, 0x93, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9b,
  92     0x9c, 0x9d, 0x9f, 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad,
  93     0xaf, 0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb6, 0xb7, 0xb8, 0xb9, 0xba, 0xbc, 0xbd, 0xbe, 0xbf, 0xc0,
  94     0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc8, 0xc9, 0xca, 0xcb, 0xcd, 0xce, 0xcf, 0xd0, 0xd2, 0xd3, 0xd4,
  95     0xd6, 0xd7, 0xd8, 0xd9, 0xdb, 0xdc, 0xdd, 0xde, 0xe0, 0xe1, 0xe2, 0xe4, 0xe5, 0xe6, 0xe8, 0xe9,
  96     0xea, 0xec, 0xed, 0xee, 0xf0, 0xf1, 0xf2, 0xf4, 0xf5, 0xf6, 0xf8, 0xf9, 0xfa, 0xfc, 0xfd, 0xff
  97 };
  98
  99 static always_inline int wp_exp2(int16_t val)
 100 {
 101     int res, neg = 0;
 102
 103     if(val < 0){
 104         val = -val;
 105         neg = 1;
 106     }
 107
 108     res = wp_exp2_table[val & 0xFF] | 0x100;
 109     val >>= 8;
 110     res = (val > 9) ? (res << (val - 9)) : (res >> (9 - val));
 111     return neg ? -res : res;
 112 }
 113
 114 static inline int get_unary(GetBitContext *gb){
 115     int r=0;
 116     while(get_bits1(gb) && r<33)r++;
 117     return r;
 118 }
 119
 120 // macros for manipulating median values
 121 #define GET_MED(n) ((median[n] >> 4) + 1)
 122 #define DEC_MED(n) median[n] -= ((median[n] + (128>>n) - 2) / (128>>n)) * 2
 123 #define INC_MED(n) median[n] += ((median[n] + (128>>n)) / (128>>n)) * 5
 124
 125 // macros for applying weight
 126 #define UPDATE_WEIGHT_CLIP(weight, delta, samples, in) \
 127         if(samples && in){ \
 128             if((samples ^ in) < 0){ \
 129                 weight -= delta; \
 130                 if(weight < -1024) weight = -1024; \
 131             }else{ \
 132                 weight += delta; \
 133                 if(weight > 1024) weight = 1024; \
 134             } \
 135         }
 136
 137
 138 static always_inline int get_tail(GetBitContext *gb, int k)
 139 {
 140     int p, e, res;
 141
 142     if(k<1 || k>65535)return 0;
 143     p = av_log2_16bit(k);
 144     e = (1 << (p + 1)) - k - 1;
 145     res = get_bits(gb, p);
 146     if(res >= e){
 147         res = (res<<1) - e + get_bits1(gb);
 148     }
 149     return res;
 150 }
 151
 152 static int wv_get_value(WavpackContext *ctx, GetBitContext *gb, int *median, int *last)
 153 {
 154     int t, t2;
 155     int sign, base, add, ret;
 156
 157     *last = 0;
 158
 159     if((ctx->median[0] < 2U) && (ctx->median[3] < 2U) && !ctx->zero && !ctx->one){
 160         if(ctx->zeroes){
 161             ctx->zeroes--;
 162             if(ctx->zeroes)
 163                 return 0;
 164         }else{
 165             t = get_unary(gb);
 166             if(t >= 2) t = get_bits(gb, t - 1) | (1 << (t-1));
 167             ctx->zeroes = t;
 168             if(ctx->zeroes){
 169                 memset(ctx->median, 0, sizeof(ctx->median));
 170                 return 0;
 171             }
 172         }
 173     }
 174
 175     if(get_bits_count(gb) >= ctx->data_size){
 176         *last = 1;
 177         return 0;
 178     }
 179
 180     if(ctx->zero){
 181         t = 0;
 182         ctx->zero = 0;
 183     }else{
 184         t = get_unary(gb);
 185         if(get_bits_count(gb) >= ctx->data_size){
 186             *last = 1;
 187             return 0;
 188         }
 189         if(t == 16) {
 190             t2 = get_unary(gb);
 191             if(t2 < 2) t += t2;
 192             else t += get_bits(gb, t2 - 1) | (1 << (t2 - 1));
 193         }
 194
 195         if(ctx->one){
 196             ctx->one = t&1;
 197             t = (t>>1) + 1;
 198         }else{
 199             ctx->one = t&1;
 200             t >>= 1;
 201         }
 202         ctx->zero = !ctx->one;
 203     }
 204
 205     if(!t){
 206         base = 0;
 207         add = GET_MED(0) - 1;
 208         DEC_MED(0);
 209     }else if(t == 1){
 210         base = GET_MED(0);
 211         add = GET_MED(1) - 1;
 212         INC_MED(0);
 213         DEC_MED(1);
 214     }else if(t == 2){
 215         base = GET_MED(0) + GET_MED(1);
 216         add = GET_MED(2) - 1;
 217         INC_MED(0);
 218         INC_MED(1);
 219         DEC_MED(2);
 220     }else{
 221         base = GET_MED(0) + GET_MED(1) + GET_MED(2) * (t - 2);
 222         add = GET_MED(2) - 1;
 223         INC_MED(0);
 224         INC_MED(1);
 225         INC_MED(2);
 226     }
 227     ret = base + get_tail(gb, add);
 228     sign = get_bits1(gb);
 229     return sign ? ~ret : ret;
 230 }
 231
 232 static int wv_unpack_stereo(WavpackContext *s, GetBitContext *gb, int16_t *dst)
 233 {
 234     int i, j, count = 0;
 235     int last, t;
 236     int A, B, L, L2, R, R2;
 237     int pos = 0;
 238     uint32_t crc = 0xFFFFFFFF;
 239
 240     s->one = s->zero = s->zeroes = 0;
 241     do{
 242         L = wv_get_value(s, gb, s->median, &last);
 243         if(last) break;
 244         R = wv_get_value(s, gb, s->median + 3, &last);
 245         if(last) break;
 246         for(i = 0; i < s->terms; i++){
 247             t = s->decorr[i].value;
 248             j = 0;
 249             if(t > 0){
 250                 if(t > 8){
 251                     if(t & 1){
 252                         A = 2 * s->decorr[i].samplesA[0] - s->decorr[i].samplesA[1];
 253                         B = 2 * s->decorr[i].samplesB[0] - s->decorr[i].samplesB[1];
 254                     }else{
 255                         A = (3 * s->decorr[i].samplesA[0] - s->decorr[i].samplesA[1]) >> 1;
 256                         B = (3 * s->decorr[i].samplesB[0] - s->decorr[i].samplesB[1]) >> 1;
 257                     }
 258                     s->decorr[i].samplesA[1] = s->decorr[i].samplesA[0];
 259                     s->decorr[i].samplesB[1] = s->decorr[i].samplesB[0];
 260                     j = 0;
 261                 }else{
 262                     A = s->decorr[i].samplesA[pos];
 263                     B = s->decorr[i].samplesB[pos];
 264                     j = (pos + t) & 7;
 265                 }
 266                 L2 = L + ((s->decorr[i].weightA * A + 512) >> 10);
 267                 R2 = R + ((s->decorr[i].weightB * B + 512) >> 10);
 268                 if(A && L) s->decorr[i].weightA -= ((((L ^ A) >> 30) & 2) - 1) * s->decorr[i].delta;
 269                 if(B && R) s->decorr[i].weightB -= ((((R ^ B) >> 30) & 2) - 1) * s->decorr[i].delta;
 270                 s->decorr[i].samplesA[j] = L = L2;
 271                 s->decorr[i].samplesB[j] = R = R2;
 272             }else if(t == -1){
 273                 L2 = L + ((s->decorr[i].weightA * s->decorr[i].samplesA[0] + 512) >> 10);
 274                 UPDATE_WEIGHT_CLIP(s->decorr[i].weightA, s->decorr[i].delta, s->decorr[i].samplesA[0], L);
 275                 L = L2;
 276                 R2 = R + ((s->decorr[i].weightB * L2 + 512) >> 10);
 277                 UPDATE_WEIGHT_CLIP(s->decorr[i].weightB, s->decorr[i].delta, L2, R);
 278                 R = R2;
 279                 s->decorr[i].samplesA[0] = R;
 280             }else{
 281                 R2 = R + ((s->decorr[i].weightB * s->decorr[i].samplesB[0] + 512) >> 10);
 282                 UPDATE_WEIGHT_CLIP(s->decorr[i].weightB, s->decorr[i].delta, s->decorr[i].samplesB[0], R);
 283                 R = R2;
 284
 285                 if(t == -3){
 286                     R2 = s->decorr[i].samplesA[0];
 287                     s->decorr[i].samplesA[0] = R;
 288                 }
 289
 290                 L2 = L + ((s->decorr[i].weightA * R2 + 512) >> 10);
 291                 UPDATE_WEIGHT_CLIP(s->decorr[i].weightA, s->decorr[i].delta, R2, L);
 292                 L = L2;
 293                 s->decorr[i].samplesB[0] = L;
 294             }
 295         }
 296         pos = (pos + 1) & 7;
 297         if(s->joint)
 298             L += (R -= (L >> 1));
 299         crc = (crc * 3 + L) * 3 + R;
 300         *dst++ = L;
 301         *dst++ = R;
 302
 303         count++;
 304     }while(!last && count < s->samples);
 305
 306     if(crc != s->CRC){
 307         av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
 308         return -1;
 309     }
 310     return count * 2;
 311 }
 312
 313 static int wv_unpack_mono(WavpackContext *s, GetBitContext *gb, int16_t *dst)
 314 {
 315     int i, j, count = 0;
 316     int last, t;
 317     int A, S, T;
 318     int pos = 0;
 319     uint32_t crc = 0xFFFFFFFF;
 320
 321     s->one = s->zero = s->zeroes = 0;
 322     do{
 323         T = wv_get_value(s, gb, s->median, &last);
 324         S = 0;
 325         if(last) break;
 326         for(i = 0; i < s->terms; i++){
 327             t = s->decorr[i].value;
 328             if(t > 8){
 329                 if(t & 1)
 330                     A = 2 * s->decorr[i].samplesA[0] - s->decorr[i].samplesA[1];
 331                 else
 332                     A = (3 * s->decorr[i].samplesA[0] - s->decorr[i].samplesA[1]) >> 1;
 333                 s->decorr[i].samplesA[1] = s->decorr[i].samplesA[0];
 334                 j = 0;
 335             }else{
 336                 A = s->decorr[i].samplesA[pos];
 337                 j = (pos + t) & 7;
 338             }
 339             S = T + ((s->decorr[i].weightA * A + 512) >> 10);
 340             if(A && T) s->decorr[i].weightA -= ((((T ^ A) >> 30) & 2) - 1) * s->decorr[i].delta;
 341             s->decorr[i].samplesA[j] = T = S;
 342         }
 343         pos = (pos + 1) & 7;
 344         crc = crc * 3 + S;
 345         *dst++ = S;
 346         count++;
 347     }while(!last && count < s->samples);
 348
 349     if(crc != s->CRC){
 350         av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
 351         return -1;
 352     }
 353     return count;
 354 }
 355
 356 static int wavpack_decode_init(AVCodecContext *avctx)
 357 {
 358     WavpackContext *s = avctx->priv_data;
 359
 360     s->avctx = avctx;
 361     s->stereo = (avctx->channels == 2);
 362
 363     return 0;
 364 }
 365
 366 static int wavpack_decode_close(AVCodecContext *avctx)
 367 {
 368 //    WavpackContext *s = avctx->priv_data;
 369
 370     return 0;
 371 }
 372
 373 static int wavpack_decode_frame(AVCodecContext *avctx,
 374                             void *data, int *data_size,
 375                             uint8_t *buf, int buf_size)
 376 {
 377     WavpackContext *s = avctx->priv_data;
 378     int16_t *samples = data;
 379     int samplecount;
 380     int got_terms = 0, got_weights = 0, got_samples = 0, got_entropy = 0, got_bs = 0;
 381     uint8_t* buf_end = buf + buf_size;
 382     int i, j, id, size, ssize, weights, t;
 383
 384     if (buf_size == 0) return 0;
 385
 386     memset(s->decorr, 0, MAX_TERMS * sizeof(Decorr));
 387
 388     s->samples = LE_32(buf); buf += 4;
 389     s->joint = LE_32(buf) & WV_JOINT; buf += 4;
 390     s->CRC = LE_32(buf); buf += 4;
 391     // parse metadata blocks
 392     while(buf < buf_end){
 393         id = *buf++;
 394         size = *buf++;
 395         if(id & WP_IDF_LONG) {
 396             size |= (*buf++) << 8;
 397             size |= (*buf++) << 16;
 398         }
 399         size <<= 1; // size is specified in words
 400         ssize = size;
 401         if(id & WP_IDF_ODD) size--;
 402         if(size < 0){
 403             av_log(avctx, AV_LOG_ERROR, "Got incorrect block %02X with size %i\n", id, size);
 404             break;
 405         }
 406         if(buf + ssize > buf_end){
 407             av_log(avctx, AV_LOG_ERROR, "Block size %i is out of bounds\n", size);
 408             break;
 409         }
 410         if(id & WP_IDF_IGNORE){
 411             buf += ssize;
 412             continue;
 413         }
 414         switch(id & WP_IDF_MASK){
 415         case WP_ID_DECTERMS:
 416             s->terms = size;
 417             if(s->terms > MAX_TERMS){
 418                 av_log(avctx, AV_LOG_ERROR, "Too many decorrelation terms\n");
 419                 buf += ssize;
 420                 continue;
 421             }
 422             for(i = 0; i < s->terms; i++) {
 423                 s->decorr[s->terms - i - 1].value = (*buf & 0x1F) - 5;
 424                 s->decorr[s->terms - i - 1].delta = *buf >> 5;
 425                 buf++;
 426             }
 427             got_terms = 1;
 428             break;
 429         case WP_ID_DECWEIGHTS:
 430             if(!got_terms){
 431                 av_log(avctx, AV_LOG_ERROR, "No decorrelation terms met\n");
 432                 continue;
 433             }
 434             weights = size >> s->stereo;
 435             if(weights > MAX_TERMS || weights > s->terms){
 436                 av_log(avctx, AV_LOG_ERROR, "Too many decorrelation weights\n");
 437                 buf += ssize;
 438                 continue;
 439             }
 440             for(i = 0; i < weights; i++) {
 441                 t = (int8_t)(*buf++);
 442                 s->decorr[s->terms - i - 1].weightA = t << 3;
 443                 if(s->decorr[s->terms - i - 1].weightA > 0)
 444                     s->decorr[s->terms - i - 1].weightA += (s->decorr[s->terms - i - 1].weightA + 64) >> 7;
 445                 if(s->stereo){
 446                     t = (int8_t)(*buf++);
 447                     s->decorr[s->terms - i - 1].weightB = t << 3;
 448                     if(s->decorr[s->terms - i - 1].weightB > 0)
 449                         s->decorr[s->terms - i - 1].weightB += (s->decorr[s->terms - i - 1].weightB + 64) >> 7;
 450                 }
 451             }
 452             got_weights = 1;
 453             break;
 454         case WP_ID_DECSAMPLES:
 455             if(!got_terms){
 456                 av_log(avctx, AV_LOG_ERROR, "No decorrelation terms met\n");
 457                 continue;
 458             }
 459             t = 0;
 460             for(i = s->terms - 1; (i >= 0) && (t < size); i--) {
 461                 if(s->decorr[i].value > 8){
 462                     s->decorr[i].samplesA[0] = wp_exp2(LE_16(buf)); buf += 2;
 463                     s->decorr[i].samplesA[1] = wp_exp2(LE_16(buf)); buf += 2;
 464                     if(s->stereo){
 465                         s->decorr[i].samplesB[0] = wp_exp2(LE_16(buf)); buf += 2;
 466                         s->decorr[i].samplesB[1] = wp_exp2(LE_16(buf)); buf += 2;
 467                         t += 4;
 468                     }
 469                     t += 4;
 470                 }else if(s->decorr[i].value < 0){
 471                     s->decorr[i].samplesA[0] = wp_exp2(LE_16(buf)); buf += 2;
 472                     s->decorr[i].samplesB[0] = wp_exp2(LE_16(buf)); buf += 2;
 473                     t += 4;
 474                 }else{
 475                     for(j = 0; j < s->decorr[i].value; j++){
 476                         s->decorr[i].samplesA[j] = wp_exp2(LE_16(buf)); buf += 2;
 477                         if(s->stereo){
 478                             s->decorr[i].samplesB[j] = wp_exp2(LE_16(buf)); buf += 2;
 479                         }
 480                     }
 481                     t += s->decorr[i].value * 2 * avctx->channels;
 482                 }
 483             }
 484             got_samples = 1;
 485             break;
 486         case WP_ID_ENTROPY:
 487             if(size != 6 * avctx->channels){
 488                 av_log(avctx, AV_LOG_ERROR, "Entropy vars size should be %i, got %i", 6 * avctx->channels, size);
 489                 buf += ssize;
 490                 continue;
 491             }
 492             for(i = 0; i < 3 * avctx->channels; i++){
 493                 s->median[i] = wp_exp2(LE_16(buf));
 494                 buf += 2;
 495             }
 496             got_entropy = 1;
 497             break;
 498         case WP_ID_DATA:
 499             init_get_bits(&s->gb, buf, size * 8);
 500             s->data_size = size * 8;
 501             buf += size;
 502             got_bs = 1;
 503             break;
 504         default:
 505             buf += size;
 506         }
 507         if(id & WP_IDF_ODD) buf++;
 508     }
 509     if(!got_terms){
 510         av_log(avctx, AV_LOG_ERROR, "No block with decorrelation terms\n");
 511         return -1;
 512     }
 513     if(!got_weights){
 514         av_log(avctx, AV_LOG_ERROR, "No block with decorrelation weights\n");
 515         return -1;
 516     }
 517     if(!got_samples){
 518         av_log(avctx, AV_LOG_ERROR, "No block with decorrelation samples\n");
 519         return -1;
 520     }
 521     if(!got_entropy){
 522         av_log(avctx, AV_LOG_ERROR, "No block with entropy info\n");
 523         return -1;
 524     }
 525     if(!got_bs){
 526         av_log(avctx, AV_LOG_ERROR, "Packed samples not found\n");
 527         return -1;
 528     }
 529
 530     if(s->stereo)
 531         samplecount = wv_unpack_stereo(s, &s->gb, samples);
 532     else
 533         samplecount = wv_unpack_mono(s, &s->gb, samples);
 534     *data_size = samplecount * 2;
 535
 536     return buf_size;
 537 }
 538
 539 AVCodec wavpack_decoder = {
 540     "wavpack",
 541     CODEC_TYPE_AUDIO,
 542     CODEC_ID_WAVPACK,
 543     sizeof(WavpackContext),
 544     wavpack_decode_init,
 545     NULL,
 546     wavpack_decode_close,
 547     wavpack_decode_frame,
 548 };