ttadec: unbreak playback of matroska files
[ffmpeg.git] / libavcodec / tta.c
1 /*
2  * TTA (The Lossless True Audio) decoder
3  * Copyright (c) 2006 Alex Beregszaszi
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * TTA (The Lossless True Audio) decoder
25  * @see http://www.true-audio.com/
26  * @see http://tta.corecodec.org/
27  * @author Alex Beregszaszi
28  */
29
30 #define BITSTREAM_READER_LE
31 //#define DEBUG
32 #include <limits.h>
33 #include "avcodec.h"
34 #include "get_bits.h"
35 #include "libavutil/crc.h"
36
37 #define FORMAT_SIMPLE    1
38 #define FORMAT_ENCRYPTED 2
39
40 #define MAX_ORDER 16
41 typedef struct TTAFilter {
42     int32_t shift, round, error;
43     int32_t qm[MAX_ORDER];
44     int32_t dx[MAX_ORDER];
45     int32_t dl[MAX_ORDER];
46 } TTAFilter;
47
48 typedef struct TTARice {
49     uint32_t k0, k1, sum0, sum1;
50 } TTARice;
51
52 typedef struct TTAChannel {
53     int32_t predictor;
54     TTAFilter filter;
55     TTARice rice;
56 } TTAChannel;
57
58 typedef struct TTAContext {
59     AVCodecContext *avctx;
60     AVFrame frame;
61     GetBitContext gb;
62     const AVCRC *crc_table;
63
64     int format, channels, bps, data_length;
65     int frame_length, last_frame_length, total_frames;
66
67     int32_t *decode_buffer;
68
69     TTAChannel *ch_ctx;
70 } TTAContext;
71
72 static const uint32_t shift_1[] = {
73     0x00000001, 0x00000002, 0x00000004, 0x00000008,
74     0x00000010, 0x00000020, 0x00000040, 0x00000080,
75     0x00000100, 0x00000200, 0x00000400, 0x00000800,
76     0x00001000, 0x00002000, 0x00004000, 0x00008000,
77     0x00010000, 0x00020000, 0x00040000, 0x00080000,
78     0x00100000, 0x00200000, 0x00400000, 0x00800000,
79     0x01000000, 0x02000000, 0x04000000, 0x08000000,
80     0x10000000, 0x20000000, 0x40000000, 0x80000000,
81     0x80000000, 0x80000000, 0x80000000, 0x80000000,
82     0x80000000, 0x80000000, 0x80000000, 0x80000000
83 };
84
85 static const uint32_t * const shift_16 = shift_1 + 4;
86
87 static const int32_t ttafilter_configs[4] = {
88     10,
89     9,
90     10,
91     12
92 };
93
94 static void ttafilter_init(TTAFilter *c, int32_t shift) {
95     memset(c, 0, sizeof(TTAFilter));
96     c->shift = shift;
97    c->round = shift_1[shift-1];
98 //    c->round = 1 << (shift - 1);
99 }
100
101 // FIXME: copy paste from original
102 static inline void memshl(register int32_t *a, register int32_t *b) {
103     *a++ = *b++;
104     *a++ = *b++;
105     *a++ = *b++;
106     *a++ = *b++;
107     *a++ = *b++;
108     *a++ = *b++;
109     *a++ = *b++;
110     *a = *b;
111 }
112
113 static inline void ttafilter_process(TTAFilter *c, int32_t *in)
114 {
115     register int32_t *dl = c->dl, *qm = c->qm, *dx = c->dx, sum = c->round;
116
117     if (!c->error) {
118         sum += *dl++ * *qm, qm++;
119         sum += *dl++ * *qm, qm++;
120         sum += *dl++ * *qm, qm++;
121         sum += *dl++ * *qm, qm++;
122         sum += *dl++ * *qm, qm++;
123         sum += *dl++ * *qm, qm++;
124         sum += *dl++ * *qm, qm++;
125         sum += *dl++ * *qm, qm++;
126         dx += 8;
127     } else if(c->error < 0) {
128         sum += *dl++ * (*qm -= *dx++), qm++;
129         sum += *dl++ * (*qm -= *dx++), qm++;
130         sum += *dl++ * (*qm -= *dx++), qm++;
131         sum += *dl++ * (*qm -= *dx++), qm++;
132         sum += *dl++ * (*qm -= *dx++), qm++;
133         sum += *dl++ * (*qm -= *dx++), qm++;
134         sum += *dl++ * (*qm -= *dx++), qm++;
135         sum += *dl++ * (*qm -= *dx++), qm++;
136     } else {
137         sum += *dl++ * (*qm += *dx++), qm++;
138         sum += *dl++ * (*qm += *dx++), qm++;
139         sum += *dl++ * (*qm += *dx++), qm++;
140         sum += *dl++ * (*qm += *dx++), qm++;
141         sum += *dl++ * (*qm += *dx++), qm++;
142         sum += *dl++ * (*qm += *dx++), qm++;
143         sum += *dl++ * (*qm += *dx++), qm++;
144         sum += *dl++ * (*qm += *dx++), qm++;
145     }
146
147     *(dx-0) = ((*(dl-1) >> 30) | 1) << 2;
148     *(dx-1) = ((*(dl-2) >> 30) | 1) << 1;
149     *(dx-2) = ((*(dl-3) >> 30) | 1) << 1;
150     *(dx-3) = ((*(dl-4) >> 30) | 1);
151
152     c->error = *in;
153     *in += (sum >> c->shift);
154     *dl = *in;
155
156     *(dl-1) = *dl - *(dl-1);
157     *(dl-2) = *(dl-1) - *(dl-2);
158     *(dl-3) = *(dl-2) - *(dl-3);
159
160     memshl(c->dl, c->dl + 1);
161     memshl(c->dx, c->dx + 1);
162 }
163
164 static void rice_init(TTARice *c, uint32_t k0, uint32_t k1)
165 {
166     c->k0 = k0;
167     c->k1 = k1;
168     c->sum0 = shift_16[k0];
169     c->sum1 = shift_16[k1];
170 }
171
172 static int tta_get_unary(GetBitContext *gb)
173 {
174     int ret = 0;
175
176     // count ones
177     while (get_bits_left(gb) > 0 && get_bits1(gb))
178         ret++;
179     return ret;
180 }
181
182 static int tta_check_crc(TTAContext *s, const uint8_t *buf, int buf_size)
183 {
184     uint32_t crc, CRC;
185
186     CRC = AV_RL32(buf + buf_size);
187     crc = av_crc(s->crc_table, 0xFFFFFFFFU, buf, buf_size);
188     if (CRC != (crc ^ 0xFFFFFFFFU)) {
189         av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
190         return AVERROR_INVALIDDATA;
191     }
192
193     return 0;
194 }
195
196 static av_cold int tta_decode_init(AVCodecContext * avctx)
197 {
198     TTAContext *s = avctx->priv_data;
199
200     s->avctx = avctx;
201
202     // 30bytes includes a seektable with one frame
203     if (avctx->extradata_size < 30)
204         return -1;
205
206     init_get_bits(&s->gb, avctx->extradata, avctx->extradata_size * 8);
207     if (show_bits_long(&s->gb, 32) == AV_RL32("TTA1"))
208     {
209         if (avctx->err_recognition & AV_EF_CRCCHECK) {
210             s->crc_table = av_crc_get_table(AV_CRC_32_IEEE_LE);
211             tta_check_crc(s, avctx->extradata, 18);
212         }
213
214         /* signature */
215         skip_bits_long(&s->gb, 32);
216
217         s->format = get_bits(&s->gb, 16);
218         if (s->format > 2) {
219             av_log(s->avctx, AV_LOG_ERROR, "Invalid format\n");
220             return -1;
221         }
222         if (s->format == FORMAT_ENCRYPTED) {
223             av_log_missing_feature(s->avctx, "Encrypted TTA", 0);
224             return AVERROR(EINVAL);
225         }
226         avctx->channels = s->channels = get_bits(&s->gb, 16);
227         avctx->bits_per_coded_sample = get_bits(&s->gb, 16);
228         s->bps = (avctx->bits_per_coded_sample + 7) / 8;
229         avctx->sample_rate = get_bits_long(&s->gb, 32);
230         s->data_length = get_bits_long(&s->gb, 32);
231         skip_bits_long(&s->gb, 32); // CRC32 of header
232
233         if (s->channels == 0) {
234             av_log(s->avctx, AV_LOG_ERROR, "Invalid number of channels\n");
235             return AVERROR_INVALIDDATA;
236         } else if (avctx->sample_rate == 0) {
237             av_log(s->avctx, AV_LOG_ERROR, "Invalid samplerate\n");
238             return AVERROR_INVALIDDATA;
239         }
240
241         switch(s->bps) {
242         case 2:
243             avctx->sample_fmt = AV_SAMPLE_FMT_S16;
244             avctx->bits_per_raw_sample = 16;
245             break;
246         case 3:
247             avctx->sample_fmt = AV_SAMPLE_FMT_S32;
248             avctx->bits_per_raw_sample = 24;
249             break;
250         default:
251             av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported sample format.\n");
252             return AVERROR_INVALIDDATA;
253         }
254
255         // prevent overflow
256         if (avctx->sample_rate > 0x7FFFFF) {
257             av_log(avctx, AV_LOG_ERROR, "sample_rate too large\n");
258             return AVERROR(EINVAL);
259         }
260         s->frame_length = 256 * avctx->sample_rate / 245;
261
262         s->last_frame_length = s->data_length % s->frame_length;
263         s->total_frames = s->data_length / s->frame_length +
264                         (s->last_frame_length ? 1 : 0);
265
266         av_log(s->avctx, AV_LOG_DEBUG, "format: %d chans: %d bps: %d rate: %d block: %d\n",
267             s->format, avctx->channels, avctx->bits_per_coded_sample, avctx->sample_rate,
268             avctx->block_align);
269         av_log(s->avctx, AV_LOG_DEBUG, "data_length: %d frame_length: %d last: %d total: %d\n",
270             s->data_length, s->frame_length, s->last_frame_length, s->total_frames);
271
272         // FIXME: seek table
273         if (get_bits_left(&s->gb) < 32 * s->total_frames + 32)
274             av_log(avctx, AV_LOG_WARNING, "Seek table missing or too small\n");
275         else if (avctx->err_recognition & AV_EF_CRCCHECK) {
276             if (tta_check_crc(s, avctx->extradata + 22, s->total_frames * 4))
277                 return AVERROR_INVALIDDATA;
278         }
279         skip_bits_long(&s->gb, 32 * s->total_frames);
280         skip_bits_long(&s->gb, 32); // CRC32 of seektable
281
282         if(s->frame_length >= UINT_MAX / (s->channels * sizeof(int32_t))){
283             av_log(avctx, AV_LOG_ERROR, "frame_length too large\n");
284             return -1;
285         }
286
287         if (s->bps == 2) {
288             s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
289             if (!s->decode_buffer)
290                 return AVERROR(ENOMEM);
291         }
292         s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
293         if (!s->ch_ctx) {
294             av_freep(&s->decode_buffer);
295             return AVERROR(ENOMEM);
296         }
297     } else {
298         av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
299         return -1;
300     }
301
302     avcodec_get_frame_defaults(&s->frame);
303     avctx->coded_frame = &s->frame;
304
305     return 0;
306 }
307
308 static int tta_decode_frame(AVCodecContext *avctx, void *data,
309                             int *got_frame_ptr, AVPacket *avpkt)
310 {
311     const uint8_t *buf = avpkt->data;
312     int buf_size = avpkt->size;
313     TTAContext *s = avctx->priv_data;
314     int i, ret;
315     int cur_chan = 0, framelen = s->frame_length;
316     int32_t *p;
317
318     if (avctx->err_recognition & AV_EF_CRCCHECK) {
319         if (buf_size < 4 || tta_check_crc(s, buf, buf_size - 4))
320             return AVERROR_INVALIDDATA;
321     }
322
323     init_get_bits(&s->gb, buf, buf_size*8);
324
325     // FIXME: seeking
326     s->total_frames--;
327     if (!s->total_frames && s->last_frame_length)
328         framelen = s->last_frame_length;
329
330     /* get output buffer */
331     s->frame.nb_samples = framelen;
332     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
333         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
334         return ret;
335     }
336
337     // decode directly to output buffer for 24-bit sample format
338     if (s->bps == 3)
339         s->decode_buffer = (int32_t *)s->frame.data[0];
340
341     // init per channel states
342     for (i = 0; i < s->channels; i++) {
343         s->ch_ctx[i].predictor = 0;
344         ttafilter_init(&s->ch_ctx[i].filter, ttafilter_configs[s->bps-1]);
345         rice_init(&s->ch_ctx[i].rice, 10, 10);
346     }
347
348     for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
349         int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
350         TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
351         TTARice *rice = &s->ch_ctx[cur_chan].rice;
352         uint32_t unary, depth, k;
353         int32_t value;
354
355         unary = tta_get_unary(&s->gb);
356
357         if (unary == 0) {
358             depth = 0;
359             k = rice->k0;
360         } else {
361             depth = 1;
362             k = rice->k1;
363             unary--;
364         }
365
366         if (get_bits_left(&s->gb) < k) {
367             ret = AVERROR_INVALIDDATA;
368             goto error;
369         }
370
371         if (k) {
372             if (k > MIN_CACHE_BITS) {
373                 ret = AVERROR_INVALIDDATA;
374                 goto error;
375             }
376             value = (unary << k) + get_bits(&s->gb, k);
377         } else
378             value = unary;
379
380         // FIXME: copy paste from original
381         switch (depth) {
382         case 1:
383             rice->sum1 += value - (rice->sum1 >> 4);
384             if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
385                 rice->k1--;
386             else if(rice->sum1 > shift_16[rice->k1 + 1])
387                 rice->k1++;
388             value += shift_1[rice->k0];
389         default:
390             rice->sum0 += value - (rice->sum0 >> 4);
391             if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
392                 rice->k0--;
393             else if(rice->sum0 > shift_16[rice->k0 + 1])
394                 rice->k0++;
395         }
396
397         // extract coded value
398         *p = 1 + ((value >> 1) ^ ((value & 1) - 1));
399
400         // run hybrid filter
401         ttafilter_process(filter, p);
402
403         // fixed order prediction
404 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
405         switch (s->bps) {
406         case 1: *p += PRED(*predictor, 4); break;
407         case 2:
408         case 3: *p += PRED(*predictor, 5); break;
409         case 4: *p +=      *predictor;     break;
410         }
411         *predictor = *p;
412
413         // flip channels
414         if (cur_chan < (s->channels-1))
415             cur_chan++;
416         else {
417             // decorrelate in case of stereo integer
418             if (s->channels > 1) {
419                 int32_t *r = p - 1;
420                 for (*p += *r / 2; r > p - s->channels; r--)
421                     *r = *(r + 1) - *r;
422             }
423             cur_chan = 0;
424         }
425     }
426
427     if (get_bits_left(&s->gb) < 32) {
428         ret = AVERROR_INVALIDDATA;
429         goto error;
430     }
431     skip_bits_long(&s->gb, 32); // frame crc
432
433     // convert to output buffer
434     if (s->bps == 2) {
435         int16_t *samples = (int16_t *)s->frame.data[0];
436         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
437             *samples++ = *p;
438     } else {
439         // shift samples for 24-bit sample format
440         int32_t *samples = (int32_t *)s->frame.data[0];
441         for (i = 0; i < framelen * s->channels; i++)
442             *samples++ <<= 8;
443         // reset decode buffer
444         s->decode_buffer = NULL;
445     }
446
447     *got_frame_ptr   = 1;
448     *(AVFrame *)data = s->frame;
449
450     return buf_size;
451 error:
452     // reset decode buffer
453     if (s->bps == 3)
454         s->decode_buffer = NULL;
455     return ret;
456 }
457
458 static av_cold int tta_decode_close(AVCodecContext *avctx) {
459     TTAContext *s = avctx->priv_data;
460
461     av_free(s->decode_buffer);
462     av_freep(&s->ch_ctx);
463
464     return 0;
465 }
466
467 AVCodec ff_tta_decoder = {
468     .name           = "tta",
469     .type           = AVMEDIA_TYPE_AUDIO,
470     .id             = CODEC_ID_TTA,
471     .priv_data_size = sizeof(TTAContext),
472     .init           = tta_decode_init,
473     .close          = tta_decode_close,
474     .decode         = tta_decode_frame,
475     .capabilities   = CODEC_CAP_DR1,
476     .long_name = NULL_IF_CONFIG_SMALL("True Audio (TTA)"),
477 };