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