tta: stop checking header checksum in extradata
[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 #include <limits.h>
32 #include "avcodec.h"
33 #include "get_bits.h"
34 #include "internal.h"
35 #include "libavutil/crc.h"
36 #include "libavutil/intreadwrite.h"
37 #include "libavutil/opt.h"
38
39 #define FORMAT_SIMPLE    1
40 #define FORMAT_ENCRYPTED 2
41
42 #define MAX_ORDER 16
43 typedef struct TTAFilter {
44     int32_t shift, round, error;
45     int32_t qm[MAX_ORDER];
46     int32_t dx[MAX_ORDER];
47     int32_t dl[MAX_ORDER];
48 } TTAFilter;
49
50 typedef struct TTARice {
51     uint32_t k0, k1, sum0, sum1;
52 } TTARice;
53
54 typedef struct TTAChannel {
55     int32_t predictor;
56     TTAFilter filter;
57     TTARice rice;
58 } TTAChannel;
59
60 typedef struct TTAContext {
61     AVClass *class;
62     AVCodecContext *avctx;
63     GetBitContext gb;
64     const AVCRC *crc_table;
65
66     int format, channels, bps;
67     unsigned data_length;
68     int frame_length, last_frame_length;
69
70     int32_t *decode_buffer;
71
72     uint8_t crc_pass[8];
73     uint8_t *pass;
74     TTAChannel *ch_ctx;
75 } TTAContext;
76
77 static const uint32_t shift_1[] = {
78     0x00000001, 0x00000002, 0x00000004, 0x00000008,
79     0x00000010, 0x00000020, 0x00000040, 0x00000080,
80     0x00000100, 0x00000200, 0x00000400, 0x00000800,
81     0x00001000, 0x00002000, 0x00004000, 0x00008000,
82     0x00010000, 0x00020000, 0x00040000, 0x00080000,
83     0x00100000, 0x00200000, 0x00400000, 0x00800000,
84     0x01000000, 0x02000000, 0x04000000, 0x08000000,
85     0x10000000, 0x20000000, 0x40000000, 0x80000000,
86     0x80000000, 0x80000000, 0x80000000, 0x80000000,
87     0x80000000, 0x80000000, 0x80000000, 0x80000000
88 };
89
90 static const uint32_t * const shift_16 = shift_1 + 4;
91
92 static const int32_t ttafilter_configs[4] = {
93     10,
94     9,
95     10,
96     12
97 };
98
99 static void ttafilter_init(TTAContext *s, TTAFilter *c, int32_t shift) {
100     memset(c, 0, sizeof(TTAFilter));
101     if (s->format == FORMAT_ENCRYPTED) {
102         int i;
103         for (i = 0; i < 8; i++)
104             c->qm[i] = sign_extend(s->crc_pass[i], 8);
105     }
106     c->shift = shift;
107    c->round = shift_1[shift-1];
108 //    c->round = 1 << (shift - 1);
109 }
110
111 static inline void ttafilter_process(TTAFilter *c, int32_t *in)
112 {
113     register int32_t *dl = c->dl, *qm = c->qm, *dx = c->dx, sum = c->round;
114
115     if (c->error < 0) {
116         qm[0] -= dx[0]; qm[1] -= dx[1]; qm[2] -= dx[2]; qm[3] -= dx[3];
117         qm[4] -= dx[4]; qm[5] -= dx[5]; qm[6] -= dx[6]; qm[7] -= dx[7];
118     } else if (c->error > 0) {
119         qm[0] += dx[0]; qm[1] += dx[1]; qm[2] += dx[2]; qm[3] += dx[3];
120         qm[4] += dx[4]; qm[5] += dx[5]; qm[6] += dx[6]; qm[7] += dx[7];
121     }
122
123     sum += dl[0] * qm[0] + dl[1] * qm[1] + dl[2] * qm[2] + dl[3] * qm[3] +
124            dl[4] * qm[4] + dl[5] * qm[5] + dl[6] * qm[6] + dl[7] * qm[7];
125
126     dx[0] = dx[1]; dx[1] = dx[2]; dx[2] = dx[3]; dx[3] = dx[4];
127     dl[0] = dl[1]; dl[1] = dl[2]; dl[2] = dl[3]; dl[3] = dl[4];
128
129     dx[4] = ((dl[4] >> 30) | 1);
130     dx[5] = ((dl[5] >> 30) | 2) & ~1;
131     dx[6] = ((dl[6] >> 30) | 2) & ~1;
132     dx[7] = ((dl[7] >> 30) | 4) & ~3;
133
134     c->error = *in;
135     *in += (sum >> c->shift);
136
137     dl[4] = -dl[5]; dl[5] = -dl[6];
138     dl[6] = *in - dl[7]; dl[7] = *in;
139     dl[5] += dl[6]; dl[4] += dl[5];
140 }
141
142 static void rice_init(TTARice *c, uint32_t k0, uint32_t k1)
143 {
144     c->k0 = k0;
145     c->k1 = k1;
146     c->sum0 = shift_16[k0];
147     c->sum1 = shift_16[k1];
148 }
149
150 static int tta_get_unary(GetBitContext *gb)
151 {
152     int ret = 0;
153
154     // count ones
155     while (get_bits_left(gb) > 0 && get_bits1(gb))
156         ret++;
157     return ret;
158 }
159
160 static const int64_t tta_channel_layouts[7] = {
161     AV_CH_LAYOUT_STEREO,
162     AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY,
163     AV_CH_LAYOUT_QUAD,
164     0,
165     AV_CH_LAYOUT_5POINT1_BACK,
166     AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER,
167     AV_CH_LAYOUT_7POINT1_WIDE
168 };
169
170 static int tta_check_crc(TTAContext *s, const uint8_t *buf, int buf_size)
171 {
172     uint32_t crc, CRC;
173
174     CRC = AV_RL32(buf + buf_size);
175     crc = av_crc(s->crc_table, 0xFFFFFFFFU, buf, buf_size);
176     if (CRC != (crc ^ 0xFFFFFFFFU)) {
177         av_log(s->avctx, AV_LOG_ERROR, "CRC error\n");
178         return AVERROR_INVALIDDATA;
179     }
180
181     return 0;
182 }
183
184 static uint64_t tta_check_crc64(uint8_t *pass)
185 {
186     uint64_t crc = UINT64_MAX, poly = 0x42F0E1EBA9EA3693U;
187     uint8_t *end = pass + strlen(pass);
188     int i;
189
190     while (pass < end) {
191         crc ^= (uint64_t)*pass++ << 56;
192         for (i = 0; i < 8; i++)
193             crc = (crc << 1) ^ (poly & (((int64_t) crc) >> 63));
194     }
195
196     return crc ^ UINT64_MAX;
197 }
198
199 static av_cold int tta_decode_init(AVCodecContext * avctx)
200 {
201     TTAContext *s = avctx->priv_data;
202     int total_frames;
203
204     s->avctx = avctx;
205
206     // 30bytes includes TTA1 header
207     if (avctx->extradata_size < 22)
208         return AVERROR_INVALIDDATA;
209
210     s->crc_table = av_crc_get_table(AV_CRC_32_IEEE_LE);
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(avctx, AV_LOG_ERROR, "Invalid format\n");
220             return AVERROR_INVALIDDATA;
221         }
222         if (s->format == FORMAT_ENCRYPTED) {
223             if (!s->pass) {
224                 av_log(avctx, AV_LOG_ERROR, "Missing password for encrypted stream. Please use the -password option\n");
225                 return AVERROR(EINVAL);
226             }
227             AV_WL64(s->crc_pass, tta_check_crc64(s->pass));
228         }
229         avctx->channels = s->channels = get_bits(&s->gb, 16);
230         if (s->channels > 1 && s->channels < 9)
231             avctx->channel_layout = tta_channel_layouts[s->channels-2];
232         avctx->bits_per_raw_sample = get_bits(&s->gb, 16);
233         s->bps = (avctx->bits_per_raw_sample + 7) / 8;
234         avctx->sample_rate = get_bits_long(&s->gb, 32);
235         s->data_length = get_bits_long(&s->gb, 32);
236         skip_bits_long(&s->gb, 32); // CRC32 of header
237
238         if (s->channels == 0) {
239             av_log(avctx, AV_LOG_ERROR, "Invalid number of channels\n");
240             return AVERROR_INVALIDDATA;
241         } else if (avctx->sample_rate == 0) {
242             av_log(avctx, AV_LOG_ERROR, "Invalid samplerate\n");
243             return AVERROR_INVALIDDATA;
244         }
245
246         switch(s->bps) {
247         case 1: avctx->sample_fmt = AV_SAMPLE_FMT_U8; break;
248         case 2:
249             avctx->sample_fmt = AV_SAMPLE_FMT_S16;
250             break;
251         case 3:
252             avctx->sample_fmt = AV_SAMPLE_FMT_S32;
253             break;
254         //case 4: avctx->sample_fmt = AV_SAMPLE_FMT_S32; break;
255         default:
256             av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported sample format.\n");
257             return AVERROR_INVALIDDATA;
258         }
259
260         // prevent overflow
261         if (avctx->sample_rate > 0x7FFFFFu) {
262             av_log(avctx, AV_LOG_ERROR, "sample_rate too large\n");
263             return AVERROR(EINVAL);
264         }
265         s->frame_length = 256 * avctx->sample_rate / 245;
266
267         s->last_frame_length = s->data_length % s->frame_length;
268         total_frames = s->data_length / s->frame_length +
269                        (s->last_frame_length ? 1 : 0);
270
271         av_log(avctx, AV_LOG_DEBUG, "format: %d chans: %d bps: %d rate: %d block: %d\n",
272             s->format, avctx->channels, avctx->bits_per_coded_sample, avctx->sample_rate,
273             avctx->block_align);
274         av_log(avctx, AV_LOG_DEBUG, "data_length: %d frame_length: %d last: %d total: %d\n",
275             s->data_length, s->frame_length, s->last_frame_length, total_frames);
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 AVERROR_INVALIDDATA;
280         }
281
282         if (s->bps < 3) {
283             s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
284             if (!s->decode_buffer)
285                 return AVERROR(ENOMEM);
286         } else
287             s->decode_buffer = NULL;
288         s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
289         if (!s->ch_ctx) {
290             av_freep(&s->decode_buffer);
291             return AVERROR(ENOMEM);
292         }
293     } else {
294         av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
295         return AVERROR_INVALIDDATA;
296     }
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     AVFrame *frame     = data;
305     const uint8_t *buf = avpkt->data;
306     int buf_size = avpkt->size;
307     TTAContext *s = avctx->priv_data;
308     int i, ret;
309     int cur_chan = 0, framelen = s->frame_length;
310     int32_t *p;
311
312     if (avctx->err_recognition & AV_EF_CRCCHECK) {
313         if (buf_size < 4 || tta_check_crc(s, buf, buf_size - 4))
314             return AVERROR_INVALIDDATA;
315     }
316
317     if ((ret = init_get_bits8(&s->gb, avpkt->data, avpkt->size)) < 0)
318         return ret;
319
320     /* get output buffer */
321     frame->nb_samples = framelen;
322     if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
323         return ret;
324
325     // decode directly to output buffer for 24-bit sample format
326     if (s->bps == 3)
327         s->decode_buffer = (int32_t *)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, &s->ch_ctx[i].filter, ttafilter_configs[s->bps-1]);
333         rice_init(&s->ch_ctx[i].rice, 10, 10);
334     }
335
336     i = 0;
337     for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
338         int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
339         TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
340         TTARice *rice = &s->ch_ctx[cur_chan].rice;
341         uint32_t unary, depth, k;
342         int32_t value;
343
344         unary = tta_get_unary(&s->gb);
345
346         if (unary == 0) {
347             depth = 0;
348             k = rice->k0;
349         } else {
350             depth = 1;
351             k = rice->k1;
352             unary--;
353         }
354
355         if (get_bits_left(&s->gb) < k) {
356             ret = AVERROR_INVALIDDATA;
357             goto error;
358         }
359
360         if (k) {
361             if (k > MIN_CACHE_BITS) {
362                 ret = AVERROR_INVALIDDATA;
363                 goto error;
364             }
365             value = (unary << k) + get_bits(&s->gb, k);
366         } else
367             value = unary;
368
369         // FIXME: copy paste from original
370         switch (depth) {
371         case 1:
372             rice->sum1 += value - (rice->sum1 >> 4);
373             if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
374                 rice->k1--;
375             else if(rice->sum1 > shift_16[rice->k1 + 1])
376                 rice->k1++;
377             value += shift_1[rice->k0];
378         default:
379             rice->sum0 += value - (rice->sum0 >> 4);
380             if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
381                 rice->k0--;
382             else if(rice->sum0 > shift_16[rice->k0 + 1])
383                 rice->k0++;
384         }
385
386         // extract coded value
387         *p = 1 + ((value >> 1) ^ ((value & 1) - 1));
388
389         // run hybrid filter
390         ttafilter_process(filter, p);
391
392         // fixed order prediction
393 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
394         switch (s->bps) {
395         case 1: *p += PRED(*predictor, 4); break;
396         case 2:
397         case 3: *p += PRED(*predictor, 5); break;
398         case 4: *p +=      *predictor;     break;
399         }
400         *predictor = *p;
401
402         // flip channels
403         if (cur_chan < (s->channels-1))
404             cur_chan++;
405         else {
406             // decorrelate in case of multiple channels
407             if (s->channels > 1) {
408                 int32_t *r = p - 1;
409                 for (*p += *r / 2; r > p - s->channels; r--)
410                     *r = *(r + 1) - *r;
411             }
412             cur_chan = 0;
413             i++;
414             // check for last frame
415             if (i == s->last_frame_length && get_bits_left(&s->gb) / 8 == 4) {
416                 frame->nb_samples = framelen = s->last_frame_length;
417                 break;
418             }
419         }
420     }
421
422     align_get_bits(&s->gb);
423     if (get_bits_left(&s->gb) < 32) {
424         ret = AVERROR_INVALIDDATA;
425         goto error;
426     }
427     skip_bits_long(&s->gb, 32); // frame crc
428
429     // convert to output buffer
430     switch (s->bps) {
431     case 1: {
432         uint8_t *samples = (uint8_t *)frame->data[0];
433         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
434             *samples++ = *p + 0x80;
435         break;
436         }
437     case 2: {
438         int16_t *samples = (int16_t *)frame->data[0];
439         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
440             *samples++ = *p;
441         break;
442         }
443     case 3: {
444         // shift samples for 24-bit sample format
445         int32_t *samples = (int32_t *)frame->data[0];
446         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
447             *samples++ <<= 8;
448         // reset decode buffer
449         s->decode_buffer = NULL;
450         break;
451         }
452     }
453
454     *got_frame_ptr = 1;
455
456     return buf_size;
457 error:
458     // reset decode buffer
459     if (s->bps == 3)
460         s->decode_buffer = NULL;
461     return ret;
462 }
463
464 static av_cold int tta_decode_close(AVCodecContext *avctx) {
465     TTAContext *s = avctx->priv_data;
466
467     if (s->bps < 3)
468         av_free(s->decode_buffer);
469     s->decode_buffer = NULL;
470     av_freep(&s->ch_ctx);
471
472     return 0;
473 }
474
475 #define OFFSET(x) offsetof(TTAContext, x)
476 #define DEC (AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_AUDIO_PARAM)
477 static const AVOption options[] = {
478     { "password", "Set decoding password", OFFSET(pass), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, DEC },
479     { NULL },
480 };
481
482 static const AVClass tta_decoder_class = {
483     .class_name = "TTA Decoder",
484     .item_name  = av_default_item_name,
485     .option     = options,
486     .version    = LIBAVUTIL_VERSION_INT,
487 };
488
489 AVCodec ff_tta_decoder = {
490     .name           = "tta",
491     .type           = AVMEDIA_TYPE_AUDIO,
492     .id             = AV_CODEC_ID_TTA,
493     .priv_data_size = sizeof(TTAContext),
494     .init           = tta_decode_init,
495     .close          = tta_decode_close,
496     .decode         = tta_decode_frame,
497     .capabilities   = CODEC_CAP_DR1,
498     .long_name      = NULL_IF_CONFIG_SMALL("TTA (True Audio)"),
499     .priv_class     = &tta_decoder_class,
500 };