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