tta: add support for decoding 24-bit sample format
[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 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 av_cold int tta_decode_init(AVCodecContext * avctx)
191 {
192     TTAContext *s = avctx->priv_data;
193     int i;
194
195     s->avctx = avctx;
196
197     // 30bytes includes a seektable with one frame
198     if (avctx->extradata_size < 30)
199         return -1;
200
201     init_get_bits(&s->gb, avctx->extradata, avctx->extradata_size * 8);
202     if (show_bits_long(&s->gb, 32) == AV_RL32("TTA1"))
203     {
204         /* signature */
205         skip_bits(&s->gb, 32);
206
207         s->format = get_bits(&s->gb, 16);
208         if (s->format > 2) {
209             av_log(s->avctx, AV_LOG_ERROR, "Invalid format\n");
210             return -1;
211         }
212         if (s->format == FORMAT_ENCRYPTED) {
213             av_log_missing_feature(s->avctx, "Encrypted TTA", 0);
214             return AVERROR(EINVAL);
215         }
216         avctx->channels = s->channels = get_bits(&s->gb, 16);
217         avctx->bits_per_coded_sample = get_bits(&s->gb, 16);
218         s->bps = (avctx->bits_per_coded_sample + 7) / 8;
219         avctx->sample_rate = get_bits_long(&s->gb, 32);
220         if(avctx->sample_rate > 1000000){ //prevent FRAME_TIME * avctx->sample_rate from overflowing and sanity check
221             av_log(avctx, AV_LOG_ERROR, "sample_rate too large\n");
222             return -1;
223         }
224         s->data_length = get_bits_long(&s->gb, 32);
225         skip_bits(&s->gb, 32); // CRC32 of header
226
227         switch(s->bps) {
228         case 2:
229             avctx->sample_fmt = AV_SAMPLE_FMT_S16;
230             avctx->bits_per_raw_sample = 16;
231             break;
232         case 3:
233             avctx->sample_fmt = AV_SAMPLE_FMT_S32;
234             avctx->bits_per_raw_sample = 24;
235             break;
236         default:
237             av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported sample format.\n");
238             return AVERROR_INVALIDDATA;
239         }
240
241         // FIXME: horribly broken, but directly from reference source
242 #define FRAME_TIME 1.04489795918367346939
243         s->frame_length = (int)(FRAME_TIME * avctx->sample_rate);
244
245         s->last_frame_length = s->data_length % s->frame_length;
246         s->total_frames = s->data_length / s->frame_length +
247                         (s->last_frame_length ? 1 : 0);
248
249         av_log(s->avctx, AV_LOG_DEBUG, "format: %d chans: %d bps: %d rate: %d block: %d\n",
250             s->format, avctx->channels, avctx->bits_per_coded_sample, avctx->sample_rate,
251             avctx->block_align);
252         av_log(s->avctx, AV_LOG_DEBUG, "data_length: %d frame_length: %d last: %d total: %d\n",
253             s->data_length, s->frame_length, s->last_frame_length, s->total_frames);
254
255         // FIXME: seek table
256         for (i = 0; i < s->total_frames; i++)
257             skip_bits(&s->gb, 32);
258         skip_bits(&s->gb, 32); // CRC32 of seektable
259
260         if(s->frame_length >= UINT_MAX / (s->channels * sizeof(int32_t))){
261             av_log(avctx, AV_LOG_ERROR, "frame_length too large\n");
262             return -1;
263         }
264
265         if (s->bps == 2) {
266             s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
267         }
268         s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
269         if (!s->ch_ctx)
270             return AVERROR(ENOMEM);
271     } else {
272         av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
273         return -1;
274     }
275
276     return 0;
277 }
278
279 static int tta_decode_frame(AVCodecContext *avctx,
280         void *data, int *data_size,
281         AVPacket *avpkt)
282 {
283     const uint8_t *buf = avpkt->data;
284     int buf_size = avpkt->size;
285     TTAContext *s = avctx->priv_data;
286     int i, out_size;
287     int cur_chan = 0, framelen = s->frame_length;
288     int32_t *p;
289
290     init_get_bits(&s->gb, buf, buf_size*8);
291
292     // FIXME: seeking
293     s->total_frames--;
294     if (!s->total_frames && s->last_frame_length)
295         framelen = s->last_frame_length;
296
297     out_size = framelen * s->channels * av_get_bytes_per_sample(avctx->sample_fmt);
298     if (*data_size < out_size) {
299         av_log(avctx, AV_LOG_ERROR, "Output buffer size is too small.\n");
300         return -1;
301     }
302
303     // decode directly to output buffer for 24-bit sample format
304     if (s->bps == 3)
305         s->decode_buffer = data;
306
307     // init per channel states
308     for (i = 0; i < s->channels; i++) {
309         s->ch_ctx[i].predictor = 0;
310         ttafilter_init(&s->ch_ctx[i].filter, ttafilter_configs[s->bps-1][0], ttafilter_configs[s->bps-1][1]);
311         rice_init(&s->ch_ctx[i].rice, 10, 10);
312     }
313
314     for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
315         int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
316         TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
317         TTARice *rice = &s->ch_ctx[cur_chan].rice;
318         uint32_t unary, depth, k;
319         int32_t value;
320
321         unary = tta_get_unary(&s->gb);
322
323         if (unary == 0) {
324             depth = 0;
325             k = rice->k0;
326         } else {
327             depth = 1;
328             k = rice->k1;
329             unary--;
330         }
331
332         if (get_bits_left(&s->gb) < k)
333             return -1;
334
335         if (k) {
336             if (k > MIN_CACHE_BITS)
337                 return -1;
338             value = (unary << k) + get_bits(&s->gb, k);
339         } else
340             value = unary;
341
342         // FIXME: copy paste from original
343         switch (depth) {
344         case 1:
345             rice->sum1 += value - (rice->sum1 >> 4);
346             if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
347                 rice->k1--;
348             else if(rice->sum1 > shift_16[rice->k1 + 1])
349                 rice->k1++;
350             value += shift_1[rice->k0];
351         default:
352             rice->sum0 += value - (rice->sum0 >> 4);
353             if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
354                 rice->k0--;
355             else if(rice->sum0 > shift_16[rice->k0 + 1])
356                 rice->k0++;
357         }
358
359         // extract coded value
360 #define UNFOLD(x) (((x)&1) ? (++(x)>>1) : (-(x)>>1))
361         *p = UNFOLD(value);
362
363         // run hybrid filter
364         ttafilter_process(filter, p, 0);
365
366         // fixed order prediction
367 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
368         switch (s->bps) {
369             case 1: *p += PRED(*predictor, 4); break;
370             case 2:
371             case 3: *p += PRED(*predictor, 5); break;
372             case 4: *p += *predictor; break;
373         }
374         *predictor = *p;
375
376         // flip channels
377         if (cur_chan < (s->channels-1))
378             cur_chan++;
379         else {
380             // decorrelate in case of stereo integer
381             if (s->channels > 1) {
382                 int32_t *r = p - 1;
383                 for (*p += *r / 2; r > p - s->channels; r--)
384                     *r = *(r + 1) - *r;
385             }
386             cur_chan = 0;
387         }
388     }
389
390     if (get_bits_left(&s->gb) < 32)
391         return -1;
392     skip_bits(&s->gb, 32); // frame crc
393
394     // convert to output buffer
395     if (s->bps == 2) {
396         int16_t *samples = data;
397         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
398             *samples++ = *p;
399     } else {
400         // shift samples for 24-bit sample format
401         int32_t *samples = data;
402         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
403             *samples++ <<= 8;
404         // reset decode buffer
405         s->decode_buffer = NULL;
406     }
407
408     *data_size = out_size;
409
410     return buf_size;
411 }
412
413 static av_cold int tta_decode_close(AVCodecContext *avctx) {
414     TTAContext *s = avctx->priv_data;
415
416     av_free(s->decode_buffer);
417     av_freep(&s->ch_ctx);
418
419     return 0;
420 }
421
422 AVCodec ff_tta_decoder = {
423     .name           = "tta",
424     .type           = AVMEDIA_TYPE_AUDIO,
425     .id             = CODEC_ID_TTA,
426     .priv_data_size = sizeof(TTAContext),
427     .init           = tta_decode_init,
428     .close          = tta_decode_close,
429     .decode         = tta_decode_frame,
430     .long_name = NULL_IF_CONFIG_SMALL("True Audio (TTA)"),
431 };