git.sesse.net Git - ffmpeg/blob - 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 a seektable with one frame
 207     if (avctx->extradata_size < 30)
 208         return AVERROR_INVALIDDATA;
 209
 210     init_get_bits(&s->gb, avctx->extradata, avctx->extradata_size * 8);
 211     if (show_bits_long(&s->gb, 32) == AV_RL32("TTA1"))
 212     {
 213         if (avctx->err_recognition & AV_EF_CRCCHECK) {
 214             s->crc_table = av_crc_get_table(AV_CRC_32_IEEE_LE);
 215             tta_check_crc(s, avctx->extradata, 18);
 216         }
 217
 218         /* signature */
 219         skip_bits_long(&s->gb, 32);
 220
 221         s->format = get_bits(&s->gb, 16);
 222         if (s->format > 2) {
 223             av_log(avctx, AV_LOG_ERROR, "Invalid format\n");
 224             return AVERROR_INVALIDDATA;
 225         }
 226         if (s->format == FORMAT_ENCRYPTED) {
 227             if (!s->pass) {
 228                 av_log(avctx, AV_LOG_ERROR, "Missing password for encrypted stream. Please use the -password option\n");
 229                 return AVERROR(EINVAL);
 230             }
 231             AV_WL64(s->crc_pass, tta_check_crc64(s->pass));
 232         }
 233         avctx->channels = s->channels = get_bits(&s->gb, 16);
 234         if (s->channels > 1 && s->channels < 9)
 235             avctx->channel_layout = tta_channel_layouts[s->channels-2];
 236         avctx->bits_per_raw_sample = get_bits(&s->gb, 16);
 237         s->bps = (avctx->bits_per_raw_sample + 7) / 8;
 238         avctx->sample_rate = get_bits_long(&s->gb, 32);
 239         s->data_length = get_bits_long(&s->gb, 32);
 240         skip_bits_long(&s->gb, 32); // CRC32 of header
 241
 242         if (s->channels == 0) {
 243             av_log(avctx, AV_LOG_ERROR, "Invalid number of channels\n");
 244             return AVERROR_INVALIDDATA;
 245         } else if (avctx->sample_rate == 0) {
 246             av_log(avctx, AV_LOG_ERROR, "Invalid samplerate\n");
 247             return AVERROR_INVALIDDATA;
 248         }
 249
 250         switch(s->bps) {
 251         case 1: avctx->sample_fmt = AV_SAMPLE_FMT_U8; break;
 252         case 2:
 253             avctx->sample_fmt = AV_SAMPLE_FMT_S16;
 254             break;
 255         case 3:
 256             avctx->sample_fmt = AV_SAMPLE_FMT_S32;
 257             break;
 258         //case 4: avctx->sample_fmt = AV_SAMPLE_FMT_S32; break;
 259         default:
 260             av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported sample format.\n");
 261             return AVERROR_INVALIDDATA;
 262         }
 263
 264         // prevent overflow
 265         if (avctx->sample_rate > 0x7FFFFFu) {
 266             av_log(avctx, AV_LOG_ERROR, "sample_rate too large\n");
 267             return AVERROR(EINVAL);
 268         }
 269         s->frame_length = 256 * avctx->sample_rate / 245;
 270
 271         s->last_frame_length = s->data_length % s->frame_length;
 272         total_frames = s->data_length / s->frame_length +
 273                        (s->last_frame_length ? 1 : 0);
 274
 275         av_log(avctx, AV_LOG_DEBUG, "format: %d chans: %d bps: %d rate: %d block: %d\n",
 276             s->format, avctx->channels, avctx->bits_per_coded_sample, avctx->sample_rate,
 277             avctx->block_align);
 278         av_log(avctx, AV_LOG_DEBUG, "data_length: %d frame_length: %d last: %d total: %d\n",
 279             s->data_length, s->frame_length, s->last_frame_length, total_frames);
 280
 281         // FIXME: seek table
 282         if (avctx->extradata_size <= 26 || total_frames > INT_MAX / 4 ||
 283             avctx->extradata_size - 26 < total_frames * 4)
 284             av_log(avctx, AV_LOG_WARNING, "Seek table missing or too small\n");
 285         else if (avctx->err_recognition & AV_EF_CRCCHECK) {
 286             if (tta_check_crc(s, avctx->extradata + 22, total_frames * 4))
 287                 return AVERROR_INVALIDDATA;
 288         }
 289         skip_bits_long(&s->gb, 32 * total_frames);
 290         skip_bits_long(&s->gb, 32); // CRC32 of seektable
 291
 292         if(s->frame_length >= UINT_MAX / (s->channels * sizeof(int32_t))){
 293             av_log(avctx, AV_LOG_ERROR, "frame_length too large\n");
 294             return AVERROR_INVALIDDATA;
 295         }
 296
 297         if (s->bps < 3) {
 298             s->decode_buffer = av_mallocz(sizeof(int32_t)*s->frame_length*s->channels);
 299             if (!s->decode_buffer)
 300                 return AVERROR(ENOMEM);
 301         } else
 302             s->decode_buffer = NULL;
 303         s->ch_ctx = av_malloc(avctx->channels * sizeof(*s->ch_ctx));
 304         if (!s->ch_ctx) {
 305             av_freep(&s->decode_buffer);
 306             return AVERROR(ENOMEM);
 307         }
 308     } else {
 309         av_log(avctx, AV_LOG_ERROR, "Wrong extradata present\n");
 310         return AVERROR_INVALIDDATA;
 311     }
 312
 313     return 0;
 314 }
 315
 316 static int tta_decode_frame(AVCodecContext *avctx, void *data,
 317                             int *got_frame_ptr, AVPacket *avpkt)
 318 {
 319     AVFrame *frame     = data;
 320     const uint8_t *buf = avpkt->data;
 321     int buf_size = avpkt->size;
 322     TTAContext *s = avctx->priv_data;
 323     int i, ret;
 324     int cur_chan = 0, framelen = s->frame_length;
 325     int32_t *p;
 326
 327     if (avctx->err_recognition & AV_EF_CRCCHECK) {
 328         if (buf_size < 4 || tta_check_crc(s, buf, buf_size - 4))
 329             return AVERROR_INVALIDDATA;
 330     }
 331
 332     init_get_bits(&s->gb, buf, buf_size*8);
 333
 334     /* get output buffer */
 335     frame->nb_samples = framelen;
 336     if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
 337         return ret;
 338
 339     // decode directly to output buffer for 24-bit sample format
 340     if (s->bps == 3)
 341         s->decode_buffer = (int32_t *)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, &s->ch_ctx[i].filter, ttafilter_configs[s->bps-1]);
 347         rice_init(&s->ch_ctx[i].rice, 10, 10);
 348     }
 349
 350     i = 0;
 351     for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++) {
 352         int32_t *predictor = &s->ch_ctx[cur_chan].predictor;
 353         TTAFilter *filter = &s->ch_ctx[cur_chan].filter;
 354         TTARice *rice = &s->ch_ctx[cur_chan].rice;
 355         uint32_t unary, depth, k;
 356         int32_t value;
 357
 358         unary = tta_get_unary(&s->gb);
 359
 360         if (unary == 0) {
 361             depth = 0;
 362             k = rice->k0;
 363         } else {
 364             depth = 1;
 365             k = rice->k1;
 366             unary--;
 367         }
 368
 369         if (get_bits_left(&s->gb) < k) {
 370             ret = AVERROR_INVALIDDATA;
 371             goto error;
 372         }
 373
 374         if (k) {
 375             if (k > MIN_CACHE_BITS) {
 376                 ret = AVERROR_INVALIDDATA;
 377                 goto error;
 378             }
 379             value = (unary << k) + get_bits(&s->gb, k);
 380         } else
 381             value = unary;
 382
 383         // FIXME: copy paste from original
 384         switch (depth) {
 385         case 1:
 386             rice->sum1 += value - (rice->sum1 >> 4);
 387             if (rice->k1 > 0 && rice->sum1 < shift_16[rice->k1])
 388                 rice->k1--;
 389             else if(rice->sum1 > shift_16[rice->k1 + 1])
 390                 rice->k1++;
 391             value += shift_1[rice->k0];
 392         default:
 393             rice->sum0 += value - (rice->sum0 >> 4);
 394             if (rice->k0 > 0 && rice->sum0 < shift_16[rice->k0])
 395                 rice->k0--;
 396             else if(rice->sum0 > shift_16[rice->k0 + 1])
 397                 rice->k0++;
 398         }
 399
 400         // extract coded value
 401         *p = 1 + ((value >> 1) ^ ((value & 1) - 1));
 402
 403         // run hybrid filter
 404         ttafilter_process(filter, p);
 405
 406         // fixed order prediction
 407 #define PRED(x, k) (int32_t)((((uint64_t)x << k) - x) >> k)
 408         switch (s->bps) {
 409         case 1: *p += PRED(*predictor, 4); break;
 410         case 2:
 411         case 3: *p += PRED(*predictor, 5); break;
 412         case 4: *p +=      *predictor;     break;
 413         }
 414         *predictor = *p;
 415
 416         // flip channels
 417         if (cur_chan < (s->channels-1))
 418             cur_chan++;
 419         else {
 420             // decorrelate in case of multiple channels
 421             if (s->channels > 1) {
 422                 int32_t *r = p - 1;
 423                 for (*p += *r / 2; r > p - s->channels; r--)
 424                     *r = *(r + 1) - *r;
 425             }
 426             cur_chan = 0;
 427             i++;
 428             // check for last frame
 429             if (i == s->last_frame_length && get_bits_left(&s->gb) / 8 == 4) {
 430                 frame->nb_samples = framelen = s->last_frame_length;
 431                 break;
 432             }
 433         }
 434     }
 435
 436     align_get_bits(&s->gb);
 437     if (get_bits_left(&s->gb) < 32) {
 438         ret = AVERROR_INVALIDDATA;
 439         goto error;
 440     }
 441     skip_bits_long(&s->gb, 32); // frame crc
 442
 443     // convert to output buffer
 444     switch (s->bps) {
 445     case 1: {
 446         uint8_t *samples = (uint8_t *)frame->data[0];
 447         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
 448             *samples++ = *p + 0x80;
 449         break;
 450         }
 451     case 2: {
 452         int16_t *samples = (int16_t *)frame->data[0];
 453         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
 454             *samples++ = *p;
 455         break;
 456         }
 457     case 3: {
 458         // shift samples for 24-bit sample format
 459         int32_t *samples = (int32_t *)frame->data[0];
 460         for (p = s->decode_buffer; p < s->decode_buffer + (framelen * s->channels); p++)
 461             *samples++ <<= 8;
 462         // reset decode buffer
 463         s->decode_buffer = NULL;
 464         break;
 465         }
 466     }
 467
 468     *got_frame_ptr = 1;
 469
 470     return buf_size;
 471 error:
 472     // reset decode buffer
 473     if (s->bps == 3)
 474         s->decode_buffer = NULL;
 475     return ret;
 476 }
 477
 478 static av_cold int tta_decode_close(AVCodecContext *avctx) {
 479     TTAContext *s = avctx->priv_data;
 480
 481     if (s->bps < 3)
 482         av_free(s->decode_buffer);
 483     s->decode_buffer = NULL;
 484     av_freep(&s->ch_ctx);
 485
 486     return 0;
 487 }
 488
 489 #define OFFSET(x) offsetof(TTAContext, x)
 490 #define DEC (AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_AUDIO_PARAM)
 491 static const AVOption options[] = {
 492     { "password", "Set decoding password", OFFSET(pass), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, DEC },
 493     { NULL },
 494 };
 495
 496 static const AVClass tta_decoder_class = {
 497     .class_name = "TTA Decoder",
 498     .item_name  = av_default_item_name,
 499     .option     = options,
 500     .version    = LIBAVUTIL_VERSION_INT,
 501 };
 502
 503 AVCodec ff_tta_decoder = {
 504     .name           = "tta",
 505     .type           = AVMEDIA_TYPE_AUDIO,
 506     .id             = AV_CODEC_ID_TTA,
 507     .priv_data_size = sizeof(TTAContext),
 508     .init           = tta_decode_init,
 509     .close          = tta_decode_close,
 510     .decode         = tta_decode_frame,
 511     .capabilities   = CODEC_CAP_DR1,
 512     .long_name      = NULL_IF_CONFIG_SMALL("TTA (True Audio)"),
 513     .priv_class     = &tta_decoder_class,
 514 };