indeo3: ensure that decoded cell data is in 7-bit range as presumed by decoder
[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 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;
65     unsigned data_length;
66     int frame_length, last_frame_length, total_frames;
67
68     int32_t *decode_buffer;
69
70     TTAChannel *ch_ctx;
71 } TTAContext;
72
73 static const uint32_t shift_1[] = {
74     0x00000001, 0x00000002, 0x00000004, 0x00000008,
75     0x00000010, 0x00000020, 0x00000040, 0x00000080,
76     0x00000100, 0x00000200, 0x00000400, 0x00000800,
77     0x00001000, 0x00002000, 0x00004000, 0x00008000,
78     0x00010000, 0x00020000, 0x00040000, 0x00080000,
79     0x00100000, 0x00200000, 0x00400000, 0x00800000,
80     0x01000000, 0x02000000, 0x04000000, 0x08000000,
81     0x10000000, 0x20000000, 0x40000000, 0x80000000,
82     0x80000000, 0x80000000, 0x80000000, 0x80000000,
83     0x80000000, 0x80000000, 0x80000000, 0x80000000
84 };
85
86 static const uint32_t * const shift_16 = shift_1 + 4;
87
88 static const int32_t ttafilter_configs[4] = {
89     10,
90     9,
91     10,
92     12
93 };
94
95 static void ttafilter_init(TTAFilter *c, int32_t shift) {
96     memset(c, 0, sizeof(TTAFilter));
97     c->shift = shift;
98    c->round = shift_1[shift-1];
99 //    c->round = 1 << (shift - 1);
100 }
101
102 // FIXME: copy paste from original
103 static inline void memshl(register int32_t *a, register int32_t *b) {
104     *a++ = *b++;
105     *a++ = *b++;
106     *a++ = *b++;
107     *a++ = *b++;
108     *a++ = *b++;
109     *a++ = *b++;
110     *a++ = *b++;
111     *a = *b;
112 }
113
114 static inline void ttafilter_process(TTAFilter *c, int32_t *in)
115 {
116     register int32_t *dl = c->dl, *qm = c->qm, *dx = c->dx, sum = c->round;
117
118     if (!c->error) {
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         sum += *dl++ * *qm, qm++;
127         dx += 8;
128     } else if(c->error < 0) {
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         sum += *dl++ * (*qm -= *dx++), qm++;
137     } else {
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         sum += *dl++ * (*qm += *dx++), qm++;
146     }
147
148     *(dx-0) = ((*(dl-1) >> 30) | 1) << 2;
149     *(dx-1) = ((*(dl-2) >> 30) | 1) << 1;
150     *(dx-2) = ((*(dl-3) >> 30) | 1) << 1;
151     *(dx-3) = ((*(dl-4) >> 30) | 1);
152
153     c->error = *in;
154     *in += (sum >> c->shift);
155     *dl = *in;
156
157     *(dl-1) = *dl - *(dl-1);
158     *(dl-2) = *(dl-1) - *(dl-2);
159     *(dl-3) = *(dl-2) - *(dl-3);
160
161     memshl(c->dl, c->dl + 1);
162     memshl(c->dx, c->dx + 1);
163 }
164
165 static void rice_init(TTARice *c, uint32_t k0, uint32_t k1)
166 {
167     c->k0 = k0;
168     c->k1 = k1;
169     c->sum0 = shift_16[k0];
170     c->sum1 = shift_16[k1];
171 }
172
173 static int tta_get_unary(GetBitContext *gb)
174 {
175     int ret = 0;
176
177     // count ones
178     while (get_bits_left(gb) > 0 && get_bits1(gb))
179         ret++;
180     return ret;
181 }
182
183 static int tta_check_crc(TTAContext *s, const uint8_t *buf, int buf_size)
184 {
185     uint32_t crc, CRC;
186
187     CRC = AV_RL32(buf + buf_size);
188     crc = av_crc(s->crc_table, 0xFFFFFFFFU, buf, buf_size);
189     if (CRC != (crc ^ 0xFFFFFFFFU)) {
190         av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
191         return AVERROR_INVALIDDATA;
192     }
193
194     return 0;
195 }
196
197 static av_cold int tta_decode_init(AVCodecContext * avctx)
198 {
199     TTAContext *s = avctx->priv_data;
200
201     s->avctx = avctx;
202
203     // 30bytes includes a seektable with one frame
204     if (avctx->extradata_size < 30)
205         return -1;
206
207     init_get_bits(&s->gb, avctx->extradata, avctx->extradata_size * 8);
208     if (show_bits_long(&s->gb, 32) == AV_RL32("TTA1"))
209     {
210         if (avctx->err_recognition & AV_EF_CRCCHECK) {
211             s->crc_table = av_crc_get_table(AV_CRC_32_IEEE_LE);
212             tta_check_crc(s, avctx->extradata, 18);
213         }
214
215         /* signature */
216         skip_bits_long(&s->gb, 32);
217
218         s->format = get_bits(&s->gb, 16);
219         if (s->format > 2) {
220             av_log(s->avctx, AV_LOG_ERROR, "Invalid format\n");
221             return -1;
222         }
223         if (s->format == FORMAT_ENCRYPTED) {
224             av_log_missing_feature(s->avctx, "Encrypted TTA", 0);
225             return AVERROR(EINVAL);
226         }
227         avctx->channels = s->channels = get_bits(&s->gb, 16);
228         avctx->bits_per_coded_sample = get_bits(&s->gb, 16);
229         s->bps = (avctx->bits_per_coded_sample + 7) / 8;
230         avctx->sample_rate = get_bits_long(&s->gb, 32);
231         s->data_length = get_bits_long(&s->gb, 32);
232         skip_bits_long(&s->gb, 32); // CRC32 of header
233
234         if (s->channels == 0) {
235             av_log(s->avctx, AV_LOG_ERROR, "Invalid number of channels\n");
236             return AVERROR_INVALIDDATA;
237         } else if (avctx->sample_rate == 0) {
238             av_log(s->avctx, AV_LOG_ERROR, "Invalid samplerate\n");
239             return AVERROR_INVALIDDATA;
240         }
241
242         switch(s->bps) {
243         case 2:
244             avctx->sample_fmt = AV_SAMPLE_FMT_S16;
245             avctx->bits_per_raw_sample = 16;
246             break;
247         case 3:
248             avctx->sample_fmt = AV_SAMPLE_FMT_S32;
249             avctx->bits_per_raw_sample = 24;
250             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 > 0x7FFFFFu) {
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         if (avctx->extradata_size <= 26 || s->total_frames > INT_MAX / 4 ||
275             avctx->extradata_size - 26 < s->total_frames * 4)
276             av_log(avctx, AV_LOG_WARNING, "Seek table missing or too small\n");
277         else if (avctx->err_recognition & AV_EF_CRCCHECK) {
278             if (tta_check_crc(s, avctx->extradata + 22, s->total_frames * 4))
279                 return AVERROR_INVALIDDATA;
280         }
281         skip_bits_long(&s->gb, 32 * s->total_frames);
282         skip_bits_long(&s->gb, 32); // CRC32 of seektable
283
284         if(s->frame_length >= UINT_MAX / (s->channels * sizeof(int32_t))){
285             av_log(avctx, AV_LOG_ERROR, "frame_length too large\n");
286             return -1;
287         }
288
289         if (s->bps == 2) {
290             s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
291             if (!s->decode_buffer)
292                 return AVERROR(ENOMEM);
293         }
294         s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
295         if (!s->ch_ctx) {
296             av_freep(&s->decode_buffer);
297             return AVERROR(ENOMEM);
298         }
299     } else {
300         av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
301         return -1;
302     }
303
304     avcodec_get_frame_defaults(&s->frame);
305     avctx->coded_frame = &s->frame;
306
307     return 0;
308 }
309
310 static int tta_decode_frame(AVCodecContext *avctx, void *data,
311                             int *got_frame_ptr, AVPacket *avpkt)
312 {
313     const uint8_t *buf = avpkt->data;
314     int buf_size = avpkt->size;
315     TTAContext *s = avctx->priv_data;
316     int i, ret;
317     int cur_chan = 0, framelen = s->frame_length;
318     int32_t *p;
319
320     if (avctx->err_recognition & AV_EF_CRCCHECK) {
321         if (buf_size < 4 || tta_check_crc(s, buf, buf_size - 4))
322             return AVERROR_INVALIDDATA;
323     }
324
325     init_get_bits(&s->gb, buf, buf_size*8);
326
327     // FIXME: seeking
328     s->total_frames--;
329     if (!s->total_frames && s->last_frame_length)
330         framelen = s->last_frame_length;
331
332     /* get output buffer */
333     s->frame.nb_samples = framelen;
334     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
335         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
336         return ret;
337     }
338
339     // decode directly to output buffer for 24-bit sample format
340     if (s->bps == 3)
341         s->decode_buffer = (int32_t *)s->frame.data[0];
342
343     // init per channel states
344     for (i = 0; i < s->channels; i++) {
345         s->ch_ctx[i].predictor = 0;
346         ttafilter_init(&s->ch_ctx[i].filter, ttafilter_configs[s->bps-1]);
347         rice_init(&s->ch_ctx[i].rice, 10, 10);
348     }
349
350     for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
351         int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
352         TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
353         TTARice *rice = &s->ch_ctx[cur_chan].rice;
354         uint32_t unary, depth, k;
355         int32_t value;
356
357         unary = tta_get_unary(&s->gb);
358
359         if (unary == 0) {
360             depth = 0;
361             k = rice->k0;
362         } else {
363             depth = 1;
364             k = rice->k1;
365             unary--;
366         }
367
368         if (get_bits_left(&s->gb) < k) {
369             ret = AVERROR_INVALIDDATA;
370             goto error;
371         }
372
373         if (k) {
374             if (k > MIN_CACHE_BITS) {
375                 ret = AVERROR_INVALIDDATA;
376                 goto error;
377             }
378             value = (unary << k) + get_bits(&s->gb, k);
379         } else
380             value = unary;
381
382         // FIXME: copy paste from original
383         switch (depth) {
384         case 1:
385             rice->sum1 += value - (rice->sum1 >> 4);
386             if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
387                 rice->k1--;
388             else if(rice->sum1 > shift_16[rice->k1 + 1])
389                 rice->k1++;
390             value += shift_1[rice->k0];
391         default:
392             rice->sum0 += value - (rice->sum0 >> 4);
393             if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
394                 rice->k0--;
395             else if(rice->sum0 > shift_16[rice->k0 + 1])
396                 rice->k0++;
397         }
398
399         // extract coded value
400         *p = 1 + ((value >> 1) ^ ((value & 1) - 1));
401
402         // run hybrid filter
403         ttafilter_process(filter, p);
404
405         // fixed order prediction
406 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
407         switch (s->bps) {
408         case 1: *p += PRED(*predictor, 4); break;
409         case 2:
410         case 3: *p += PRED(*predictor, 5); break;
411         case 4: *p +=      *predictor;     break;
412         }
413         *predictor = *p;
414
415         // flip channels
416         if (cur_chan < (s->channels-1))
417             cur_chan++;
418         else {
419             // decorrelate in case of stereo integer
420             if (s->channels > 1) {
421                 int32_t *r = p - 1;
422                 for (*p += *r / 2; r > p - s->channels; r--)
423                     *r = *(r + 1) - *r;
424             }
425             cur_chan = 0;
426         }
427     }
428
429     if (get_bits_left(&s->gb) < 32) {
430         ret = AVERROR_INVALIDDATA;
431         goto error;
432     }
433     skip_bits_long(&s->gb, 32); // frame crc
434
435     // convert to output buffer
436     if (s->bps == 2) {
437         int16_t *samples = (int16_t *)s->frame.data[0];
438         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
439             *samples++ = *p;
440     } else {
441         // shift samples for 24-bit sample format
442         int32_t *samples = (int32_t *)s->frame.data[0];
443         for (i = 0; i < framelen * s->channels; i++)
444             *samples++ <<= 8;
445         // reset decode buffer
446         s->decode_buffer = NULL;
447     }
448
449     *got_frame_ptr   = 1;
450     *(AVFrame *)data = s->frame;
451
452     return buf_size;
453 error:
454     // reset decode buffer
455     if (s->bps == 3)
456         s->decode_buffer = NULL;
457     return ret;
458 }
459
460 static av_cold int tta_decode_close(AVCodecContext *avctx) {
461     TTAContext *s = avctx->priv_data;
462
463     av_free(s->decode_buffer);
464     av_freep(&s->ch_ctx);
465
466     return 0;
467 }
468
469 AVCodec ff_tta_decoder = {
470     .name           = "tta",
471     .type           = AVMEDIA_TYPE_AUDIO,
472     .id             = CODEC_ID_TTA,
473     .priv_data_size = sizeof(TTAContext),
474     .init           = tta_decode_init,
475     .close          = tta_decode_close,
476     .decode         = tta_decode_frame,
477     .capabilities   = CODEC_CAP_DR1,
478     .long_name      = NULL_IF_CONFIG_SMALL("True Audio (TTA)"),
479 };