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 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     AVFrame frame;
60     GetBitContext gb;
61
62     int format, channels, bps, data_length;
63     int frame_length, last_frame_length, total_frames;
64
65     int32_t *decode_buffer;
66
67     TTAChannel *ch_ctx;
68 } TTAContext;
69
70 static const uint32_t shift_1[] = {
71     0x00000001, 0x00000002, 0x00000004, 0x00000008,
72     0x00000010, 0x00000020, 0x00000040, 0x00000080,
73     0x00000100, 0x00000200, 0x00000400, 0x00000800,
74     0x00001000, 0x00002000, 0x00004000, 0x00008000,
75     0x00010000, 0x00020000, 0x00040000, 0x00080000,
76     0x00100000, 0x00200000, 0x00400000, 0x00800000,
77     0x01000000, 0x02000000, 0x04000000, 0x08000000,
78     0x10000000, 0x20000000, 0x40000000, 0x80000000,
79     0x80000000, 0x80000000, 0x80000000, 0x80000000,
80     0x80000000, 0x80000000, 0x80000000, 0x80000000
81 };
82
83 static const uint32_t * const shift_16 = shift_1 + 4;
84
85 static const int32_t ttafilter_configs[4][2] = {
86     {10, 1},
87     {9, 1},
88     {10, 1},
89     {12, 0}
90 };
91
92 static void ttafilter_init(TTAFilter *c, int32_t shift, int32_t mode) {
93     memset(c, 0, sizeof(TTAFilter));
94     c->shift = shift;
95    c->round = shift_1[shift-1];
96 //    c->round = 1 << (shift - 1);
97     c->mode = mode;
98 }
99
100 // FIXME: copy paste from original
101 static inline void memshl(register int32_t *a, register int32_t *b) {
102     *a++ = *b++;
103     *a++ = *b++;
104     *a++ = *b++;
105     *a++ = *b++;
106     *a++ = *b++;
107     *a++ = *b++;
108     *a++ = *b++;
109     *a = *b;
110 }
111
112 // FIXME: copy paste from original
113 // mode=1 encoder, mode=0 decoder
114 static inline void ttafilter_process(TTAFilter *c, int32_t *in, int32_t mode) {
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     // compress
153     if (mode) {
154         *dl = *in;
155         *in -= (sum >> c->shift);
156         c->error = *in;
157     } else {
158         c->error = *in;
159         *in += (sum >> c->shift);
160         *dl = *in;
161     }
162
163     if (c->mode) {
164         *(dl-1) = *dl - *(dl-1);
165         *(dl-2) = *(dl-1) - *(dl-2);
166         *(dl-3) = *(dl-2) - *(dl-3);
167     }
168
169     memshl(c->dl, c->dl + 1);
170     memshl(c->dx, c->dx + 1);
171 }
172
173 static void rice_init(TTARice *c, uint32_t k0, uint32_t k1)
174 {
175     c->k0 = k0;
176     c->k1 = k1;
177     c->sum0 = shift_16[k0];
178     c->sum1 = shift_16[k1];
179 }
180
181 static int tta_get_unary(GetBitContext *gb)
182 {
183     int ret = 0;
184
185     // count ones
186     while (get_bits_left(gb) > 0 && get_bits1(gb))
187         ret++;
188     return ret;
189 }
190
191 static const int64_t tta_channel_layouts[7] = {
192     AV_CH_LAYOUT_STEREO,
193     AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY,
194     AV_CH_LAYOUT_QUAD,
195     0,
196     AV_CH_LAYOUT_5POINT1_BACK,
197     AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER,
198     AV_CH_LAYOUT_7POINT1_WIDE
199 };
200
201 static av_cold int tta_decode_init(AVCodecContext * avctx)
202 {
203     TTAContext *s = avctx->priv_data;
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_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         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_long(&s->gb, 32); // CRC32 of header
234
235         if (s->channels == 0) {
236             av_log(s->avctx, AV_LOG_ERROR, "Invalid number of channels\n");
237             return AVERROR_INVALIDDATA;
238         }
239
240         switch(s->bps) {
241         case 1: avctx->sample_fmt = AV_SAMPLE_FMT_U8; break;
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         //case 4: avctx->sample_fmt = AV_SAMPLE_FMT_S32; break;
251         default:
252             av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported sample format.\n");
253             return AVERROR_INVALIDDATA;
254         }
255
256         // prevent overflow
257         if (avctx->sample_rate > 0x7FFFFF) {
258             av_log(avctx, AV_LOG_ERROR, "sample_rate too large\n");
259             return AVERROR(EINVAL);
260         }
261         s->frame_length = 256 * avctx->sample_rate / 245;
262
263         s->last_frame_length = s->data_length % s->frame_length;
264         s->total_frames = s->data_length / s->frame_length +
265                         (s->last_frame_length ? 1 : 0);
266
267         av_log(s->avctx, AV_LOG_DEBUG, "format: %d chans: %d bps: %d rate: %d block: %d\n",
268             s->format, avctx->channels, avctx->bits_per_coded_sample, avctx->sample_rate,
269             avctx->block_align);
270         av_log(s->avctx, AV_LOG_DEBUG, "data_length: %d frame_length: %d last: %d total: %d\n",
271             s->data_length, s->frame_length, s->last_frame_length, s->total_frames);
272
273         // FIXME: seek table
274         skip_bits_long(&s->gb, 32 * s->total_frames);
275         skip_bits_long(&s->gb, 32); // CRC32 of seektable
276
277         if(s->frame_length >= UINT_MAX / (s->channels * sizeof(int32_t))){
278             av_log(avctx, AV_LOG_ERROR, "frame_length too large\n");
279             return -1;
280         }
281
282         s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
283         if (!s->decode_buffer)
284             return AVERROR(ENOMEM);
285         s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
286         if (!s->ch_ctx) {
287             av_freep(&s->decode_buffer);
288             return AVERROR(ENOMEM);
289         }
290     } else {
291         av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
292         return -1;
293     }
294
295     avcodec_get_frame_defaults(&s->frame);
296     avctx->coded_frame = &s->frame;
297
298     return 0;
299 }
300
301 static int tta_decode_frame(AVCodecContext *avctx, void *data,
302                             int *got_frame_ptr, AVPacket *avpkt)
303 {
304     const uint8_t *buf = avpkt->data;
305     int buf_size = avpkt->size;
306     TTAContext *s = avctx->priv_data;
307     int i, ret;
308     int cur_chan = 0, framelen = s->frame_length;
309     int32_t *p;
310
311     init_get_bits(&s->gb, buf, buf_size*8);
312
313     // FIXME: seeking
314     s->total_frames--;
315     if (!s->total_frames && s->last_frame_length)
316         framelen = s->last_frame_length;
317
318     /* get output buffer */
319     s->frame.nb_samples = framelen;
320     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
321         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
322         return ret;
323     }
324
325     // decode directly to output buffer for 24-bit sample format
326     if (s->bps == 3)
327         s->decode_buffer = (int32_t *)s->frame.data[0];
328
329     // init per channel states
330     for (i = 0; i < s->channels; i++) {
331         s->ch_ctx[i].predictor = 0;
332         ttafilter_init(&s->ch_ctx[i].filter, ttafilter_configs[s->bps-1][0], ttafilter_configs[s->bps-1][1]);
333         rice_init(&s->ch_ctx[i].rice, 10, 10);
334     }
335
336     for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
337         int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
338         TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
339         TTARice *rice = &s->ch_ctx[cur_chan].rice;
340         uint32_t unary, depth, k;
341         int32_t value;
342
343         unary = tta_get_unary(&s->gb);
344
345         if (unary == 0) {
346             depth = 0;
347             k = rice->k0;
348         } else {
349             depth = 1;
350             k = rice->k1;
351             unary--;
352         }
353
354         if (get_bits_left(&s->gb) < k)
355             return -1;
356
357         if (k) {
358             if (k > MIN_CACHE_BITS)
359                 return -1;
360             value = (unary << k) + get_bits(&s->gb, k);
361         } else
362             value = unary;
363
364         // FIXME: copy paste from original
365         switch (depth) {
366         case 1:
367             rice->sum1 += value - (rice->sum1 >> 4);
368             if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
369                 rice->k1--;
370             else if(rice->sum1 > shift_16[rice->k1 + 1])
371                 rice->k1++;
372             value += shift_1[rice->k0];
373         default:
374             rice->sum0 += value - (rice->sum0 >> 4);
375             if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
376                 rice->k0--;
377             else if(rice->sum0 > shift_16[rice->k0 + 1])
378                 rice->k0++;
379         }
380
381         // extract coded value
382 #define UNFOLD(x) (((x)&1) ? (++(x)>>1) : (-(x)>>1))
383         *p = UNFOLD(value);
384
385         // run hybrid filter
386         ttafilter_process(filter, p, 0);
387
388         // fixed order prediction
389 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
390         switch (s->bps) {
391             case 1: *p += PRED(*predictor, 4); break;
392             case 2:
393             case 3: *p += PRED(*predictor, 5); break;
394             case 4: *p += *predictor; break;
395         }
396         *predictor = *p;
397
398         // flip channels
399         if (cur_chan < (s->channels-1))
400             cur_chan++;
401         else {
402             // decorrelate in case of stereo integer
403             if (s->channels > 1) {
404                 int32_t *r = p - 1;
405                 for (*p += *r / 2; r > p - s->channels; r--)
406                     *r = *(r + 1) - *r;
407             }
408             cur_chan = 0;
409         }
410     }
411
412     if (get_bits_left(&s->gb) < 32)
413         return -1;
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 }
446
447 static av_cold int tta_decode_close(AVCodecContext *avctx) {
448     TTAContext *s = avctx->priv_data;
449
450     av_free(s->decode_buffer);
451     av_freep(&s->ch_ctx);
452
453     return 0;
454 }
455
456 AVCodec ff_tta_decoder = {
457     .name           = "tta",
458     .type           = AVMEDIA_TYPE_AUDIO,
459     .id             = CODEC_ID_TTA,
460     .priv_data_size = sizeof(TTAContext),
461     .init           = tta_decode_init,
462     .close          = tta_decode_close,
463     .decode         = tta_decode_frame,
464     .capabilities   = CODEC_CAP_DR1,
465     .long_name = NULL_IF_CONFIG_SMALL("True Audio (TTA)"),
466 };