ttadec: refactor ttafilter_process()
[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 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
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 static inline void ttafilter_process(TTAFilter *c, int32_t *in)
102 {
103     register int32_t *dl = c->dl, *qm = c->qm, *dx = c->dx, sum = c->round;
104
105     if (c->error < 0) {
106         qm[0] -= dx[0]; qm[1] -= dx[1]; qm[2] -= dx[2]; qm[3] -= dx[3];
107         qm[4] -= dx[4]; qm[5] -= dx[5]; qm[6] -= dx[6]; qm[7] -= dx[7];
108     } else if (c->error > 0) {
109         qm[0] += dx[0]; qm[1] += dx[1]; qm[2] += dx[2]; qm[3] += dx[3];
110         qm[4] += dx[4]; qm[5] += dx[5]; qm[6] += dx[6]; qm[7] += dx[7];
111     }
112
113     sum += dl[0] * qm[0] + dl[1] * qm[1] + dl[2] * qm[2] + dl[3] * qm[3] +
114            dl[4] * qm[4] + dl[5] * qm[5] + dl[6] * qm[6] + dl[7] * qm[7];
115
116     dx[0] = dx[1]; dx[1] = dx[2]; dx[2] = dx[3]; dx[3] = dx[4];
117     dl[0] = dl[1]; dl[1] = dl[2]; dl[2] = dl[3]; dl[3] = dl[4];
118
119     dx[4] = ((dl[4] >> 30) | 1);
120     dx[5] = ((dl[5] >> 30) | 2) & ~1;
121     dx[6] = ((dl[6] >> 30) | 2) & ~1;
122     dx[7] = ((dl[7] >> 30) | 4) & ~3;
123
124     c->error = *in;
125     *in += (sum >> c->shift);
126
127     dl[4] = -dl[5]; dl[5] = -dl[6];
128     dl[6] = *in - dl[7]; dl[7] = *in;
129     dl[5] += dl[6]; dl[4] += dl[5];
130 }
131
132 static void rice_init(TTARice *c, uint32_t k0, uint32_t k1)
133 {
134     c->k0 = k0;
135     c->k1 = k1;
136     c->sum0 = shift_16[k0];
137     c->sum1 = shift_16[k1];
138 }
139
140 static int tta_get_unary(GetBitContext *gb)
141 {
142     int ret = 0;
143
144     // count ones
145     while (get_bits_left(gb) > 0 && get_bits1(gb))
146         ret++;
147     return ret;
148 }
149
150 static const int64_t tta_channel_layouts[7] = {
151     AV_CH_LAYOUT_STEREO,
152     AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY,
153     AV_CH_LAYOUT_QUAD,
154     0,
155     AV_CH_LAYOUT_5POINT1_BACK,
156     AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER,
157     AV_CH_LAYOUT_7POINT1_WIDE
158 };
159
160 static int tta_check_crc(TTAContext *s, const uint8_t *buf, int buf_size)
161 {
162     uint32_t crc, CRC;
163
164     CRC = AV_RL32(buf + buf_size);
165     crc = av_crc(s->crc_table, 0xFFFFFFFFU, buf, buf_size);
166     if (CRC != (crc ^ 0xFFFFFFFFU)) {
167         av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
168         return AVERROR_INVALIDDATA;
169     }
170
171     return 0;
172 }
173
174 static av_cold int tta_decode_init(AVCodecContext * avctx)
175 {
176     TTAContext *s = avctx->priv_data;
177
178     s->avctx = avctx;
179
180     // 30bytes includes a seektable with one frame
181     if (avctx->extradata_size < 30)
182         return -1;
183
184     init_get_bits(&s->gb, avctx->extradata, avctx->extradata_size * 8);
185     if (show_bits_long(&s->gb, 32) == AV_RL32("TTA1"))
186     {
187         if (avctx->err_recognition & AV_EF_CRCCHECK) {
188             s->crc_table = av_crc_get_table(AV_CRC_32_IEEE_LE);
189             tta_check_crc(s, avctx->extradata, 18);
190         }
191
192         /* signature */
193         skip_bits_long(&s->gb, 32);
194
195         s->format = get_bits(&s->gb, 16);
196         if (s->format > 2) {
197             av_log(s->avctx, AV_LOG_ERROR, "Invalid format\n");
198             return -1;
199         }
200         if (s->format == FORMAT_ENCRYPTED) {
201             av_log_missing_feature(s->avctx, "Encrypted TTA", 0);
202             return AVERROR(EINVAL);
203         }
204         avctx->channels = s->channels = get_bits(&s->gb, 16);
205         if (s->channels > 1 && s->channels < 9)
206             avctx->channel_layout = tta_channel_layouts[s->channels-2];
207         avctx->bits_per_coded_sample = get_bits(&s->gb, 16);
208         s->bps = (avctx->bits_per_coded_sample + 7) / 8;
209         avctx->sample_rate = get_bits_long(&s->gb, 32);
210         s->data_length = get_bits_long(&s->gb, 32);
211         skip_bits_long(&s->gb, 32); // CRC32 of header
212
213         if (s->channels == 0) {
214             av_log(s->avctx, AV_LOG_ERROR, "Invalid number of channels\n");
215             return AVERROR_INVALIDDATA;
216         } else if (avctx->sample_rate == 0) {
217             av_log(s->avctx, AV_LOG_ERROR, "Invalid samplerate\n");
218             return AVERROR_INVALIDDATA;
219         }
220
221         switch(s->bps) {
222         case 1: avctx->sample_fmt = AV_SAMPLE_FMT_U8; break;
223         case 2:
224             avctx->sample_fmt = AV_SAMPLE_FMT_S16;
225             avctx->bits_per_raw_sample = 16;
226             break;
227         case 3:
228             avctx->sample_fmt = AV_SAMPLE_FMT_S32;
229             avctx->bits_per_raw_sample = 24;
230             break;
231         //case 4: avctx->sample_fmt = AV_SAMPLE_FMT_S32; break;
232         default:
233             av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported sample format.\n");
234             return AVERROR_INVALIDDATA;
235         }
236
237         // prevent overflow
238         if (avctx->sample_rate > 0x7FFFFF) {
239             av_log(avctx, AV_LOG_ERROR, "sample_rate too large\n");
240             return AVERROR(EINVAL);
241         }
242         s->frame_length = 256 * avctx->sample_rate / 245;
243
244         s->last_frame_length = s->data_length % s->frame_length;
245         s->total_frames = s->data_length / s->frame_length +
246                         (s->last_frame_length ? 1 : 0);
247
248         av_log(s->avctx, AV_LOG_DEBUG, "format: %d chans: %d bps: %d rate: %d block: %d\n",
249             s->format, avctx->channels, avctx->bits_per_coded_sample, avctx->sample_rate,
250             avctx->block_align);
251         av_log(s->avctx, AV_LOG_DEBUG, "data_length: %d frame_length: %d last: %d total: %d\n",
252             s->data_length, s->frame_length, s->last_frame_length, s->total_frames);
253
254         // FIXME: seek table
255         if (get_bits_left(&s->gb) < 32 * s->total_frames + 32)
256             av_log(avctx, AV_LOG_WARNING, "Seek table missing or too small\n");
257         else if (avctx->err_recognition & AV_EF_CRCCHECK) {
258             if (tta_check_crc(s, avctx->extradata + 22, s->total_frames * 4))
259                 return AVERROR_INVALIDDATA;
260         }
261         skip_bits_long(&s->gb, 32 * s->total_frames);
262         skip_bits_long(&s->gb, 32); // CRC32 of seektable
263
264         if(s->frame_length >= UINT_MAX / (s->channels * sizeof(int32_t))){
265             av_log(avctx, AV_LOG_ERROR, "frame_length too large\n");
266             return -1;
267         }
268
269         if (s->bps < 3) {
270             s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
271             if (!s->decode_buffer)
272                 return AVERROR(ENOMEM);
273         } else
274             s->decode_buffer = NULL;
275         s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
276         if (!s->ch_ctx) {
277             av_freep(&s->decode_buffer);
278             return AVERROR(ENOMEM);
279         }
280     } else {
281         av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
282         return -1;
283     }
284
285     avcodec_get_frame_defaults(&s->frame);
286     avctx->coded_frame = &s->frame;
287
288     return 0;
289 }
290
291 static int tta_decode_frame(AVCodecContext *avctx, void *data,
292                             int *got_frame_ptr, AVPacket *avpkt)
293 {
294     const uint8_t *buf = avpkt->data;
295     int buf_size = avpkt->size;
296     TTAContext *s = avctx->priv_data;
297     int i, ret;
298     int cur_chan = 0, framelen = s->frame_length;
299     int32_t *p;
300
301     if (avctx->err_recognition & AV_EF_CRCCHECK) {
302         if (buf_size < 4 || tta_check_crc(s, buf, buf_size - 4))
303             return AVERROR_INVALIDDATA;
304     }
305
306     init_get_bits(&s->gb, buf, buf_size*8);
307
308     // FIXME: seeking
309     s->total_frames--;
310     if (!s->total_frames && s->last_frame_length)
311         framelen = s->last_frame_length;
312
313     /* get output buffer */
314     s->frame.nb_samples = framelen;
315     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
316         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
317         return ret;
318     }
319
320     // decode directly to output buffer for 24-bit sample format
321     if (s->bps == 3)
322         s->decode_buffer = (int32_t *)s->frame.data[0];
323
324     // init per channel states
325     for (i = 0; i < s->channels; i++) {
326         s->ch_ctx[i].predictor = 0;
327         ttafilter_init(&s->ch_ctx[i].filter, ttafilter_configs[s->bps-1]);
328         rice_init(&s->ch_ctx[i].rice, 10, 10);
329     }
330
331     for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
332         int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
333         TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
334         TTARice *rice = &s->ch_ctx[cur_chan].rice;
335         uint32_t unary, depth, k;
336         int32_t value;
337
338         unary = tta_get_unary(&s->gb);
339
340         if (unary == 0) {
341             depth = 0;
342             k = rice->k0;
343         } else {
344             depth = 1;
345             k = rice->k1;
346             unary--;
347         }
348
349         if (get_bits_left(&s->gb) < k) {
350             ret = AVERROR_INVALIDDATA;
351             goto error;
352         }
353
354         if (k) {
355             if (k > MIN_CACHE_BITS) {
356                 ret = AVERROR_INVALIDDATA;
357                 goto error;
358             }
359             value = (unary << k) + get_bits(&s->gb, k);
360         } else
361             value = unary;
362
363         // FIXME: copy paste from original
364         switch (depth) {
365         case 1:
366             rice->sum1 += value - (rice->sum1 >> 4);
367             if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
368                 rice->k1--;
369             else if(rice->sum1 > shift_16[rice->k1 + 1])
370                 rice->k1++;
371             value += shift_1[rice->k0];
372         default:
373             rice->sum0 += value - (rice->sum0 >> 4);
374             if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
375                 rice->k0--;
376             else if(rice->sum0 > shift_16[rice->k0 + 1])
377                 rice->k0++;
378         }
379
380         // extract coded value
381         *p = 1 + ((value >> 1) ^ ((value & 1) - 1));
382
383         // run hybrid filter
384         ttafilter_process(filter, p);
385
386         // fixed order prediction
387 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
388         switch (s->bps) {
389         case 1: *p += PRED(*predictor, 4); break;
390         case 2:
391         case 3: *p += PRED(*predictor, 5); break;
392         case 4: *p +=      *predictor;     break;
393         }
394         *predictor = *p;
395
396         // flip channels
397         if (cur_chan < (s->channels-1))
398             cur_chan++;
399         else {
400             // decorrelate in case of stereo integer
401             if (s->channels > 1) {
402                 int32_t *r = p - 1;
403                 for (*p += *r / 2; r > p - s->channels; r--)
404                     *r = *(r + 1) - *r;
405             }
406             cur_chan = 0;
407         }
408     }
409
410     if (get_bits_left(&s->gb) < 32) {
411         ret = AVERROR_INVALIDDATA;
412         goto error;
413     }
414     skip_bits_long(&s->gb, 32); // frame crc
415
416     // convert to output buffer
417     switch (s->bps) {
418     case 1: {
419         uint8_t *samples = (uint8_t *)s->frame.data[0];
420         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
421             *samples++ = *p + 0x80;
422         break;
423         }
424     case 2: {
425         uint16_t *samples = (int16_t *)s->frame.data[0];
426         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
427             *samples++ = *p;
428         break;
429         }
430     case 3: {
431         // shift samples for 24-bit sample format
432         int32_t *samples = (int32_t *)s->frame.data[0];
433         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
434             *samples++ <<= 8;
435         // reset decode buffer
436         s->decode_buffer = NULL;
437         break;
438         }
439     }
440
441     *got_frame_ptr   = 1;
442     *(AVFrame *)data = s->frame;
443
444     return buf_size;
445 error:
446     // reset decode buffer
447     if (s->bps == 3)
448         s->decode_buffer = NULL;
449     return ret;
450 }
451
452 static av_cold int tta_decode_close(AVCodecContext *avctx) {
453     TTAContext *s = avctx->priv_data;
454
455     if (s->bps < 3)
456         av_free(s->decode_buffer);
457     s->decode_buffer = NULL;
458     av_freep(&s->ch_ctx);
459
460     return 0;
461 }
462
463 AVCodec ff_tta_decoder = {
464     .name           = "tta",
465     .type           = AVMEDIA_TYPE_AUDIO,
466     .id             = CODEC_ID_TTA,
467     .priv_data_size = sizeof(TTAContext),
468     .init           = tta_decode_init,
469     .close          = tta_decode_close,
470     .decode         = tta_decode_frame,
471     .capabilities   = CODEC_CAP_DR1,
472     .long_name = NULL_IF_CONFIG_SMALL("True Audio (TTA)"),
473 };