2 * TTA (The Lossless True Audio) decoder
3 * Copyright (c) 2006 Alex Beregszaszi
5 * This file is part of FFmpeg.
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.
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.
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
24 * TTA (The Lossless True Audio) decoder
25 * @see http://www.true-audio.com/
26 * @see http://tta.corecodec.org/
27 * @author Alex Beregszaszi
30 #define BITSTREAM_READER_LE
35 #include "libavutil/crc.h"
37 #define FORMAT_SIMPLE 1
38 #define FORMAT_ENCRYPTED 2
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];
48 typedef struct TTARice {
49 uint32_t k0, k1, sum0, sum1;
52 typedef struct TTAChannel {
58 typedef struct TTAContext {
59 AVCodecContext *avctx;
62 const AVCRC *crc_table;
64 int format, channels, bps, data_length;
65 int frame_length, last_frame_length, total_frames;
67 int32_t *decode_buffer;
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
85 static const uint32_t * const shift_16 = shift_1 + 4;
87 static const int32_t ttafilter_configs[4] = {
94 static void ttafilter_init(TTAFilter *c, int32_t shift) {
95 memset(c, 0, sizeof(TTAFilter));
97 c->round = shift_1[shift-1];
98 // c->round = 1 << (shift - 1);
101 // FIXME: copy paste from original
102 static inline void memshl(register int32_t *a, register int32_t *b) {
113 static inline void ttafilter_process(TTAFilter *c, int32_t *in)
115 register int32_t *dl = c->dl, *qm = c->qm, *dx = c->dx, sum = c->round;
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++;
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++;
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++;
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);
153 *in += (sum >> c->shift);
156 *(dl-1) = *dl - *(dl-1);
157 *(dl-2) = *(dl-1) - *(dl-2);
158 *(dl-3) = *(dl-2) - *(dl-3);
160 memshl(c->dl, c->dl + 1);
161 memshl(c->dx, c->dx + 1);
164 static void rice_init(TTARice *c, uint32_t k0, uint32_t k1)
168 c->sum0 = shift_16[k0];
169 c->sum1 = shift_16[k1];
172 static int tta_get_unary(GetBitContext *gb)
177 while (get_bits_left(gb) > 0 && get_bits1(gb))
182 static const int64_t tta_channel_layouts[7] = {
184 AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY,
187 AV_CH_LAYOUT_5POINT1_BACK,
188 AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER,
189 AV_CH_LAYOUT_7POINT1_WIDE
192 static int tta_check_crc(TTAContext *s, const uint8_t *buf, int buf_size)
196 CRC = AV_RL32(buf + buf_size);
197 crc = av_crc(s->crc_table, 0xFFFFFFFFU, buf, buf_size);
198 if (CRC != (crc ^ 0xFFFFFFFFU)) {
199 av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
200 return AVERROR_INVALIDDATA;
206 static av_cold int tta_decode_init(AVCodecContext * avctx)
208 TTAContext *s = avctx->priv_data;
212 // 30bytes includes a seektable with one frame
213 if (avctx->extradata_size < 30)
216 init_get_bits(&s->gb, avctx->extradata, avctx->extradata_size * 8);
217 if (show_bits_long(&s->gb, 32) == AV_RL32("TTA1"))
219 if (avctx->err_recognition & AV_EF_CRCCHECK) {
220 s->crc_table = av_crc_get_table(AV_CRC_32_IEEE_LE);
221 if (tta_check_crc(s, avctx->extradata, 18))
222 return AVERROR_INVALIDDATA;
226 skip_bits_long(&s->gb, 32);
228 s->format = get_bits(&s->gb, 16);
230 av_log(s->avctx, AV_LOG_ERROR, "Invalid format\n");
233 if (s->format == FORMAT_ENCRYPTED) {
234 av_log_missing_feature(s->avctx, "Encrypted TTA", 0);
235 return AVERROR(EINVAL);
237 avctx->channels = s->channels = get_bits(&s->gb, 16);
238 if (s->channels > 1 && s->channels < 9)
239 avctx->channel_layout = tta_channel_layouts[s->channels-2];
240 avctx->bits_per_coded_sample = get_bits(&s->gb, 16);
241 s->bps = (avctx->bits_per_coded_sample + 7) / 8;
242 avctx->sample_rate = get_bits_long(&s->gb, 32);
243 s->data_length = get_bits_long(&s->gb, 32);
244 skip_bits_long(&s->gb, 32); // CRC32 of header
246 if (s->channels == 0) {
247 av_log(s->avctx, AV_LOG_ERROR, "Invalid number of channels\n");
248 return AVERROR_INVALIDDATA;
249 } else if (avctx->sample_rate == 0) {
250 av_log(s->avctx, AV_LOG_ERROR, "Invalid samplerate\n");
251 return AVERROR_INVALIDDATA;
255 case 1: avctx->sample_fmt = AV_SAMPLE_FMT_U8; break;
257 avctx->sample_fmt = AV_SAMPLE_FMT_S16;
258 avctx->bits_per_raw_sample = 16;
261 avctx->sample_fmt = AV_SAMPLE_FMT_S32;
262 avctx->bits_per_raw_sample = 24;
264 //case 4: avctx->sample_fmt = AV_SAMPLE_FMT_S32; break;
266 av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported sample format.\n");
267 return AVERROR_INVALIDDATA;
271 if (avctx->sample_rate > 0x7FFFFF) {
272 av_log(avctx, AV_LOG_ERROR, "sample_rate too large\n");
273 return AVERROR(EINVAL);
275 s->frame_length = 256 * avctx->sample_rate / 245;
277 s->last_frame_length = s->data_length % s->frame_length;
278 s->total_frames = s->data_length / s->frame_length +
279 (s->last_frame_length ? 1 : 0);
281 av_log(s->avctx, AV_LOG_DEBUG, "format: %d chans: %d bps: %d rate: %d block: %d\n",
282 s->format, avctx->channels, avctx->bits_per_coded_sample, avctx->sample_rate,
284 av_log(s->avctx, AV_LOG_DEBUG, "data_length: %d frame_length: %d last: %d total: %d\n",
285 s->data_length, s->frame_length, s->last_frame_length, s->total_frames);
288 if (get_bits_left(&s->gb) < 32 * s->total_frames + 32)
289 av_log(avctx, AV_LOG_WARNING, "Seek table missing or too small\n");
290 else if (avctx->err_recognition & AV_EF_CRCCHECK) {
291 if (tta_check_crc(s, avctx->extradata + 22, s->total_frames * 4))
292 return AVERROR_INVALIDDATA;
294 skip_bits_long(&s->gb, 32 * s->total_frames);
295 skip_bits_long(&s->gb, 32); // CRC32 of seektable
297 if(s->frame_length >= UINT_MAX / (s->channels * sizeof(int32_t))){
298 av_log(avctx, AV_LOG_ERROR, "frame_length too large\n");
303 s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
304 if (!s->decode_buffer)
305 return AVERROR(ENOMEM);
307 s->decode_buffer = NULL;
308 s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
310 av_freep(&s->decode_buffer);
311 return AVERROR(ENOMEM);
314 av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
318 avcodec_get_frame_defaults(&s->frame);
319 avctx->coded_frame = &s->frame;
324 static int tta_decode_frame(AVCodecContext *avctx, void *data,
325 int *got_frame_ptr, AVPacket *avpkt)
327 const uint8_t *buf = avpkt->data;
328 int buf_size = avpkt->size;
329 TTAContext *s = avctx->priv_data;
331 int cur_chan = 0, framelen = s->frame_length;
334 if (avctx->err_recognition & AV_EF_CRCCHECK) {
335 if (buf_size < 4 || tta_check_crc(s, buf, buf_size - 4))
336 return AVERROR_INVALIDDATA;
339 init_get_bits(&s->gb, buf, buf_size*8);
343 if (!s->total_frames && s->last_frame_length)
344 framelen = s->last_frame_length;
346 /* get output buffer */
347 s->frame.nb_samples = framelen;
348 if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
349 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
353 // decode directly to output buffer for 24-bit sample format
355 s->decode_buffer = (int32_t *)s->frame.data[0];
357 // init per channel states
358 for (i = 0; i < s->channels; i++) {
359 s->ch_ctx[i].predictor = 0;
360 ttafilter_init(&s->ch_ctx[i].filter, ttafilter_configs[s->bps-1]);
361 rice_init(&s->ch_ctx[i].rice, 10, 10);
364 for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
365 int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
366 TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
367 TTARice *rice = &s->ch_ctx[cur_chan].rice;
368 uint32_t unary, depth, k;
371 unary = tta_get_unary(&s->gb);
382 if (get_bits_left(&s->gb) < k) {
383 ret = AVERROR_INVALIDDATA;
388 if (k > MIN_CACHE_BITS) {
389 ret = AVERROR_INVALIDDATA;
392 value = (unary << k) + get_bits(&s->gb, k);
396 // FIXME: copy paste from original
399 rice->sum1 += value - (rice->sum1 >> 4);
400 if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
402 else if(rice->sum1 > shift_16[rice->k1 + 1])
404 value += shift_1[rice->k0];
406 rice->sum0 += value - (rice->sum0 >> 4);
407 if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
409 else if(rice->sum0 > shift_16[rice->k0 + 1])
413 // extract coded value
414 *p = 1 + ((value >> 1) ^ ((value & 1) - 1));
417 ttafilter_process(filter, p);
419 // fixed order prediction
420 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
422 case 1: *p += PRED(*predictor, 4); break;
424 case 3: *p += PRED(*predictor, 5); break;
425 case 4: *p += *predictor; break;
430 if (cur_chan < (s->channels-1))
433 // decorrelate in case of stereo integer
434 if (s->channels > 1) {
436 for (*p += *r / 2; r > p - s->channels; r--)
443 if (get_bits_left(&s->gb) < 32) {
444 ret = AVERROR_INVALIDDATA;
447 skip_bits_long(&s->gb, 32); // frame crc
449 // convert to output buffer
452 uint8_t *samples = (uint8_t *)s->frame.data[0];
453 for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
454 *samples++ = *p + 0x80;
458 uint16_t *samples = (int16_t *)s->frame.data[0];
459 for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
464 // shift samples for 24-bit sample format
465 int32_t *samples = (int32_t *)s->frame.data[0];
466 for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
468 // reset decode buffer
469 s->decode_buffer = NULL;
475 *(AVFrame *)data = s->frame;
479 // reset decode buffer
481 s->decode_buffer = NULL;
485 static av_cold int tta_decode_close(AVCodecContext *avctx) {
486 TTAContext *s = avctx->priv_data;
489 av_free(s->decode_buffer);
490 s->decode_buffer = NULL;
491 av_freep(&s->ch_ctx);
496 AVCodec ff_tta_decoder = {
498 .type = AVMEDIA_TYPE_AUDIO,
500 .priv_data_size = sizeof(TTAContext),
501 .init = tta_decode_init,
502 .close = tta_decode_close,
503 .decode = tta_decode_frame,
504 .capabilities = CODEC_CAP_DR1,
505 .long_name = NULL_IF_CONFIG_SMALL("True Audio (TTA)"),