Merge remote-tracking branch 'qatar/master'
[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 ALT_BITSTREAM_READER_LE
31 //#define DEBUG
32 #include <limits.h>
33 #include "avcodec.h"
34 #include "get_bits.h"
35
36 #define FORMAT_SIMPLE    1
37 #define FORMAT_ENCRYPTED 2
38
39 #define MAX_ORDER 16
40 typedef struct TTAFilter {
41     int32_t shift, round, error, mode;
42     int32_t qm[MAX_ORDER];
43     int32_t dx[MAX_ORDER];
44     int32_t dl[MAX_ORDER];
45 } TTAFilter;
46
47 typedef struct TTARice {
48     uint32_t k0, k1, sum0, sum1;
49 } TTARice;
50
51 typedef struct TTAChannel {
52     int32_t predictor;
53     TTAFilter filter;
54     TTARice rice;
55 } TTAChannel;
56
57 typedef struct TTAContext {
58     AVCodecContext *avctx;
59     GetBitContext gb;
60
61     int format, channels, bps, data_length;
62     int frame_length, last_frame_length, total_frames;
63
64     int32_t *decode_buffer;
65
66     TTAChannel *ch_ctx;
67 } TTAContext;
68
69 static const uint32_t shift_1[] = {
70     0x00000001, 0x00000002, 0x00000004, 0x00000008,
71     0x00000010, 0x00000020, 0x00000040, 0x00000080,
72     0x00000100, 0x00000200, 0x00000400, 0x00000800,
73     0x00001000, 0x00002000, 0x00004000, 0x00008000,
74     0x00010000, 0x00020000, 0x00040000, 0x00080000,
75     0x00100000, 0x00200000, 0x00400000, 0x00800000,
76     0x01000000, 0x02000000, 0x04000000, 0x08000000,
77     0x10000000, 0x20000000, 0x40000000, 0x80000000,
78     0x80000000, 0x80000000, 0x80000000, 0x80000000,
79     0x80000000, 0x80000000, 0x80000000, 0x80000000
80 };
81
82 static const uint32_t * const shift_16 = shift_1 + 4;
83
84 static const int32_t ttafilter_configs[4][2] = {
85     {10, 1},
86     {9, 1},
87     {10, 1},
88     {12, 0}
89 };
90
91 static void ttafilter_init(TTAFilter *c, int32_t shift, int32_t mode) {
92     memset(c, 0, sizeof(TTAFilter));
93     c->shift = shift;
94    c->round = shift_1[shift-1];
95 //    c->round = 1 << (shift - 1);
96     c->mode = mode;
97 }
98
99 // FIXME: copy paste from original
100 static inline void memshl(register int32_t *a, register int32_t *b) {
101     *a++ = *b++;
102     *a++ = *b++;
103     *a++ = *b++;
104     *a++ = *b++;
105     *a++ = *b++;
106     *a++ = *b++;
107     *a++ = *b++;
108     *a = *b;
109 }
110
111 // FIXME: copy paste from original
112 // mode=1 encoder, mode=0 decoder
113 static inline void ttafilter_process(TTAFilter *c, int32_t *in, int32_t mode) {
114     register int32_t *dl = c->dl, *qm = c->qm, *dx = c->dx, sum = c->round;
115
116     if (!c->error) {
117         sum += *dl++ * *qm, qm++;
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         dx += 8;
126     } else if(c->error < 0) {
127         sum += *dl++ * (*qm -= *dx++), qm++;
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     } else {
136         sum += *dl++ * (*qm += *dx++), qm++;
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     }
145
146     *(dx-0) = ((*(dl-1) >> 30) | 1) << 2;
147     *(dx-1) = ((*(dl-2) >> 30) | 1) << 1;
148     *(dx-2) = ((*(dl-3) >> 30) | 1) << 1;
149     *(dx-3) = ((*(dl-4) >> 30) | 1);
150
151     // compress
152     if (mode) {
153         *dl = *in;
154         *in -= (sum >> c->shift);
155         c->error = *in;
156     } else {
157         c->error = *in;
158         *in += (sum >> c->shift);
159         *dl = *in;
160     }
161
162     if (c->mode) {
163         *(dl-1) = *dl - *(dl-1);
164         *(dl-2) = *(dl-1) - *(dl-2);
165         *(dl-3) = *(dl-2) - *(dl-3);
166     }
167
168     memshl(c->dl, c->dl + 1);
169     memshl(c->dx, c->dx + 1);
170 }
171
172 static void rice_init(TTARice *c, uint32_t k0, uint32_t k1)
173 {
174     c->k0 = k0;
175     c->k1 = k1;
176     c->sum0 = shift_16[k0];
177     c->sum1 = shift_16[k1];
178 }
179
180 static int tta_get_unary(GetBitContext *gb)
181 {
182     int ret = 0;
183
184     // count ones
185     while (get_bits_left(gb) > 0 && get_bits1(gb))
186         ret++;
187     return ret;
188 }
189
190 static const int64_t tta_channel_layouts[7] = {
191     AV_CH_LAYOUT_STEREO,
192     AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY,
193     AV_CH_LAYOUT_QUAD,
194     0,
195     AV_CH_LAYOUT_5POINT1_BACK,
196     AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER,
197     AV_CH_LAYOUT_7POINT1_WIDE
198 };
199
200 static av_cold int tta_decode_init(AVCodecContext * avctx)
201 {
202     TTAContext *s = avctx->priv_data;
203     int i;
204
205     s->avctx = avctx;
206
207     // 30bytes includes a seektable with one frame
208     if (avctx->extradata_size < 30)
209         return -1;
210
211     init_get_bits(&s->gb, avctx->extradata, avctx->extradata_size * 8);
212     if (show_bits_long(&s->gb, 32) == AV_RL32("TTA1"))
213     {
214         /* signature */
215         skip_bits(&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         if (s->channels > 1 && s->channels < 9)
228             avctx->channel_layout = tta_channel_layouts[s->channels-2];
229         avctx->bits_per_coded_sample = get_bits(&s->gb, 16);
230         s->bps = (avctx->bits_per_coded_sample + 7) / 8;
231         avctx->sample_rate = get_bits_long(&s->gb, 32);
232         s->data_length = get_bits_long(&s->gb, 32);
233         skip_bits(&s->gb, 32); // CRC32 of header
234
235         switch(s->bps) {
236         case 1: avctx->sample_fmt = AV_SAMPLE_FMT_U8; break;
237         case 2:
238             avctx->sample_fmt = AV_SAMPLE_FMT_S16;
239             avctx->bits_per_raw_sample = 16;
240             break;
241         case 3:
242             avctx->sample_fmt = AV_SAMPLE_FMT_S32;
243             avctx->bits_per_raw_sample = 24;
244             break;
245         //case 4: avctx->sample_fmt = AV_SAMPLE_FMT_S32; break;
246         default:
247             av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported sample format.\n");
248             return AVERROR_INVALIDDATA;
249         }
250
251         // prevent overflow
252         if (avctx->sample_rate > 0x7FFFFF) {
253             av_log(avctx, AV_LOG_ERROR, "sample_rate too large\n");
254             return AVERROR(EINVAL);
255         }
256         s->frame_length = 256 * avctx->sample_rate / 245;
257
258         s->last_frame_length = s->data_length % s->frame_length;
259         s->total_frames = s->data_length / s->frame_length +
260                         (s->last_frame_length ? 1 : 0);
261
262         av_log(s->avctx, AV_LOG_DEBUG, "format: %d chans: %d bps: %d rate: %d block: %d\n",
263             s->format, avctx->channels, avctx->bits_per_coded_sample, avctx->sample_rate,
264             avctx->block_align);
265         av_log(s->avctx, AV_LOG_DEBUG, "data_length: %d frame_length: %d last: %d total: %d\n",
266             s->data_length, s->frame_length, s->last_frame_length, s->total_frames);
267
268         // FIXME: seek table
269         for (i = 0; i < s->total_frames; i++)
270             skip_bits(&s->gb, 32);
271         skip_bits(&s->gb, 32); // CRC32 of seektable
272
273         if(s->frame_length >= UINT_MAX / (s->channels * sizeof(int32_t))){
274             av_log(avctx, AV_LOG_ERROR, "frame_length too large\n");
275             return -1;
276         }
277
278         s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
279         if (!s->decode_buffer)
280             return AVERROR(ENOMEM);
281         s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
282         if (!s->ch_ctx) {
283             av_freep(&s->decode_buffer);
284             return AVERROR(ENOMEM);
285         }
286     } else {
287         av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
288         return -1;
289     }
290
291     return 0;
292 }
293
294 static int tta_decode_frame(AVCodecContext *avctx,
295         void *data, int *data_size,
296         AVPacket *avpkt)
297 {
298     const uint8_t *buf = avpkt->data;
299     int buf_size = avpkt->size;
300     TTAContext *s = avctx->priv_data;
301     int i, out_size;
302     int cur_chan = 0, framelen = s->frame_length;
303     int32_t *p;
304
305     init_get_bits(&s->gb, buf, buf_size*8);
306
307     // FIXME: seeking
308     s->total_frames--;
309     if (!s->total_frames && s->last_frame_length)
310         framelen = s->last_frame_length;
311
312     out_size = framelen * s->channels * av_get_bytes_per_sample(avctx->sample_fmt);
313     if (*data_size < out_size) {
314         av_log(avctx, AV_LOG_ERROR, "Output buffer size is too small.\n");
315         return -1;
316     }
317
318     // decode directly to output buffer for 24-bit sample format
319     if (s->bps == 3)
320         s->decode_buffer = data;
321
322     // init per channel states
323     for (i = 0; i < s->channels; i++) {
324         s->ch_ctx[i].predictor = 0;
325         ttafilter_init(&s->ch_ctx[i].filter, ttafilter_configs[s->bps-1][0], ttafilter_configs[s->bps-1][1]);
326         rice_init(&s->ch_ctx[i].rice, 10, 10);
327     }
328
329     for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
330         int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
331         TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
332         TTARice *rice = &s->ch_ctx[cur_chan].rice;
333         uint32_t unary, depth, k;
334         int32_t value;
335
336         unary = tta_get_unary(&s->gb);
337
338         if (unary == 0) {
339             depth = 0;
340             k = rice->k0;
341         } else {
342             depth = 1;
343             k = rice->k1;
344             unary--;
345         }
346
347         if (get_bits_left(&s->gb) < k)
348             return -1;
349
350         if (k) {
351             if (k > MIN_CACHE_BITS)
352                 return -1;
353             value = (unary << k) + get_bits(&s->gb, k);
354         } else
355             value = unary;
356
357         // FIXME: copy paste from original
358         switch (depth) {
359         case 1:
360             rice->sum1 += value - (rice->sum1 >> 4);
361             if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
362                 rice->k1--;
363             else if(rice->sum1 > shift_16[rice->k1 + 1])
364                 rice->k1++;
365             value += shift_1[rice->k0];
366         default:
367             rice->sum0 += value - (rice->sum0 >> 4);
368             if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
369                 rice->k0--;
370             else if(rice->sum0 > shift_16[rice->k0 + 1])
371                 rice->k0++;
372         }
373
374         // extract coded value
375 #define UNFOLD(x) (((x)&1) ? (++(x)>>1) : (-(x)>>1))
376         *p = UNFOLD(value);
377
378         // run hybrid filter
379         ttafilter_process(filter, p, 0);
380
381         // fixed order prediction
382 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
383         switch (s->bps) {
384             case 1: *p += PRED(*predictor, 4); break;
385             case 2:
386             case 3: *p += PRED(*predictor, 5); break;
387             case 4: *p += *predictor; break;
388         }
389         *predictor = *p;
390
391         // flip channels
392         if (cur_chan < (s->channels-1))
393             cur_chan++;
394         else {
395             // decorrelate in case of stereo integer
396             if (s->channels > 1) {
397                 int32_t *r = p - 1;
398                 for (*p += *r / 2; r > p - s->channels; r--)
399                     *r = *(r + 1) - *r;
400             }
401             cur_chan = 0;
402         }
403     }
404
405     if (get_bits_left(&s->gb) < 32)
406         return -1;
407     skip_bits(&s->gb, 32); // frame crc
408
409         // convert to output buffer
410         switch(s->bps) {
411             case 1: {
412                 uint8_t *samples = data;
413                 for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
414                     *samples++ = *p + 0x80;
415                 break;
416             }
417             case 2: {
418                 uint16_t *samples = data;
419                 for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
420                     *samples++ = *p;
421                 break;
422             }
423             case 3: {
424                 // shift samples for 24-bit sample format
425                 int32_t *samples = data;
426                 for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
427                     *samples++ <<= 8;
428                 // reset decode buffer
429                 s->decode_buffer = NULL;
430                 break;
431             }
432             default:
433                 av_log(s->avctx, AV_LOG_ERROR, "Error, only 16bit samples supported!\n");
434         }
435
436     *data_size = out_size;
437
438     return buf_size;
439 }
440
441 static av_cold int tta_decode_close(AVCodecContext *avctx) {
442     TTAContext *s = avctx->priv_data;
443
444     av_free(s->decode_buffer);
445     av_freep(&s->ch_ctx);
446
447     return 0;
448 }
449
450 AVCodec ff_tta_decoder = {
451     .name           = "tta",
452     .type           = AVMEDIA_TYPE_AUDIO,
453     .id             = CODEC_ID_TTA,
454     .priv_data_size = sizeof(TTAContext),
455     .init           = tta_decode_init,
456     .close          = tta_decode_close,
457     .decode         = tta_decode_frame,
458     .long_name = NULL_IF_CONFIG_SMALL("True Audio (TTA)"),
459 };