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