git.sesse.net Git - ffmpeg/blob - libavcodec/alac.c

   1 /*
   2  * ALAC (Apple Lossless Audio Codec) decoder
   3  * Copyright (c) 2005 David Hammerton
   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  * ALAC (Apple Lossless Audio Codec) decoder
  25  * @author 2005 David Hammerton
  26  * @see http://crazney.net/programs/itunes/alac.html
  27  *
  28  * Note: This decoder expects a 36-byte QuickTime atom to be
  29  * passed through the extradata[_size] fields. This atom is tacked onto
  30  * the end of an 'alac' stsd atom and has the following format:
  31  *
  32  * 32bit  atom size
  33  * 32bit  tag                  ("alac")
  34  * 32bit  tag version          (0)
  35  * 32bit  samples per frame    (used when not set explicitly in the frames)
  36  *  8bit  compatible version   (0)
  37  *  8bit  sample size
  38  *  8bit  history mult         (40)
  39  *  8bit  initial history      (14)
  40  *  8bit  rice param limit     (10)
  41  *  8bit  channels
  42  * 16bit  maxRun               (255)
  43  * 32bit  max coded frame size (0 means unknown)
  44  * 32bit  average bitrate      (0 means unknown)
  45  * 32bit  samplerate
  46  */
  47
  48 #include "libavutil/audioconvert.h"
  49 #include "avcodec.h"
  50 #include "get_bits.h"
  51 #include "bytestream.h"
  52 #include "unary.h"
  53 #include "mathops.h"
  54
  55 #define ALAC_EXTRADATA_SIZE 36
  56 #define MAX_CHANNELS 8
  57
  58 typedef struct {
  59     AVCodecContext *avctx;
  60     AVFrame frame;
  61     GetBitContext gb;
  62     int channels;
  63
  64     int32_t *predict_error_buffer[2];
  65     int32_t *output_samples_buffer[2];
  66     int32_t *extra_bits_buffer[2];
  67
  68     uint32_t max_samples_per_frame;
  69     uint8_t  sample_size;
  70     uint8_t  rice_history_mult;
  71     uint8_t  rice_initial_history;
  72     uint8_t  rice_limit;
  73
  74     int extra_bits;     /**< number of extra bits beyond 16-bit */
  75     int nb_samples;     /**< number of samples in the current frame */
  76 } ALACContext;
  77
  78 enum RawDataBlockType {
  79     /* At the moment, only SCE, CPE, LFE, and END are recognized. */
  80     TYPE_SCE,
  81     TYPE_CPE,
  82     TYPE_CCE,
  83     TYPE_LFE,
  84     TYPE_DSE,
  85     TYPE_PCE,
  86     TYPE_FIL,
  87     TYPE_END
  88 };
  89
  90 static const uint8_t alac_channel_layout_offsets[8][8] = {
  91     { 0 },
  92     { 0, 1 },
  93     { 2, 0, 1 },
  94     { 2, 0, 1, 3 },
  95     { 2, 0, 1, 3, 4 },
  96     { 2, 0, 1, 4, 5, 3 },
  97     { 2, 0, 1, 4, 5, 6, 3 },
  98     { 2, 6, 7, 0, 1, 4, 5, 3 }
  99 };
 100
 101 static const uint16_t alac_channel_layouts[8] = {
 102     AV_CH_LAYOUT_MONO,
 103     AV_CH_LAYOUT_STEREO,
 104     AV_CH_LAYOUT_SURROUND,
 105     AV_CH_LAYOUT_4POINT0,
 106     AV_CH_LAYOUT_5POINT0_BACK,
 107     AV_CH_LAYOUT_5POINT1_BACK,
 108     AV_CH_LAYOUT_6POINT1_BACK,
 109     AV_CH_LAYOUT_7POINT1_WIDE_BACK
 110 };
 111
 112 static inline unsigned int decode_scalar(GetBitContext *gb, int k, int bps)
 113 {
 114     unsigned int x = get_unary_0_9(gb);
 115
 116     if (x > 8) { /* RICE THRESHOLD */
 117         /* use alternative encoding */
 118         x = get_bits_long(gb, bps);
 119     } else if (k != 1) {
 120         int extrabits = show_bits(gb, k);
 121
 122         /* multiply x by 2^k - 1, as part of their strange algorithm */
 123         x = (x << k) - x;
 124
 125         if (extrabits > 1) {
 126             x += extrabits - 1;
 127             skip_bits(gb, k);
 128         } else
 129             skip_bits(gb, k - 1);
 130     }
 131     return x;
 132 }
 133
 134 static void rice_decompress(ALACContext *alac, int32_t *output_buffer,
 135                             int nb_samples, int bps, int rice_history_mult)
 136 {
 137     int i;
 138     unsigned int history = alac->rice_initial_history;
 139     int sign_modifier = 0;
 140
 141     for (i = 0; i < nb_samples; i++) {
 142         int k;
 143         unsigned int x;
 144
 145         /* calculate rice param and decode next value */
 146         k = av_log2((history >> 9) + 3);
 147         k = FFMIN(k, alac->rice_limit);
 148         x = decode_scalar(&alac->gb, k, bps);
 149         x += sign_modifier;
 150         sign_modifier = 0;
 151         output_buffer[i] = (x >> 1) ^ -(x & 1);
 152
 153         /* update the history */
 154         if (x > 0xffff)
 155             history = 0xffff;
 156         else
 157             history +=         x * rice_history_mult -
 158                        ((history * rice_history_mult) >> 9);
 159
 160         /* special case: there may be compressed blocks of 0 */
 161         if ((history < 128) && (i + 1 < nb_samples)) {
 162             int block_size;
 163
 164             /* calculate rice param and decode block size */
 165             k = 7 - av_log2(history) + ((history + 16) >> 6);
 166             k = FFMIN(k, alac->rice_limit);
 167             block_size = decode_scalar(&alac->gb, k, 16);
 168
 169             if (block_size > 0) {
 170                 if (block_size >= nb_samples - i) {
 171                     av_log(alac->avctx, AV_LOG_ERROR,
 172                            "invalid zero block size of %d %d %d\n", block_size,
 173                            nb_samples, i);
 174                     block_size = nb_samples - i - 1;
 175                 }
 176                 memset(&output_buffer[i + 1], 0,
 177                        block_size * sizeof(*output_buffer));
 178                 i += block_size;
 179             }
 180             if (block_size <= 0xffff)
 181                 sign_modifier = 1;
 182             history = 0;
 183         }
 184     }
 185 }
 186
 187 static inline int sign_only(int v)
 188 {
 189     return v ? FFSIGN(v) : 0;
 190 }
 191
 192 static void lpc_prediction(int32_t *error_buffer, int32_t *buffer_out,
 193                            int nb_samples, int bps, int16_t *lpc_coefs,
 194                            int lpc_order, int lpc_quant)
 195 {
 196     int i;
 197
 198     /* first sample always copies */
 199     *buffer_out = *error_buffer;
 200
 201     if (nb_samples <= 1)
 202         return;
 203
 204     if (!lpc_order) {
 205         memcpy(&buffer_out[1], &error_buffer[1],
 206                (nb_samples - 1) * sizeof(*buffer_out));
 207         return;
 208     }
 209
 210     if (lpc_order == 31) {
 211         /* simple 1st-order prediction */
 212         for (i = 1; i < nb_samples; i++) {
 213             buffer_out[i] = sign_extend(buffer_out[i - 1] + error_buffer[i],
 214                                         bps);
 215         }
 216         return;
 217     }
 218
 219     /* read warm-up samples */
 220     for (i = 0; i < lpc_order; i++) {
 221         buffer_out[i + 1] = sign_extend(buffer_out[i] + error_buffer[i + 1],
 222                                         bps);
 223     }
 224
 225     /* NOTE: 4 and 8 are very common cases that could be optimized. */
 226
 227     for (i = lpc_order; i < nb_samples - 1; i++) {
 228         int j;
 229         int val = 0;
 230         int error_val = error_buffer[i + 1];
 231         int error_sign;
 232         int d = buffer_out[i - lpc_order];
 233
 234         /* LPC prediction */
 235         for (j = 0; j < lpc_order; j++)
 236             val += (buffer_out[i - j] - d) * lpc_coefs[j];
 237         val = (val + (1 << (lpc_quant - 1))) >> lpc_quant;
 238         val += d + error_val;
 239         buffer_out[i + 1] = sign_extend(val, bps);
 240
 241         /* adapt LPC coefficients */
 242         error_sign = sign_only(error_val);
 243         if (error_sign) {
 244             for (j = lpc_order - 1; j >= 0 && error_val * error_sign > 0; j--) {
 245                 int sign;
 246                 val  = d - buffer_out[i - j];
 247                 sign = sign_only(val) * error_sign;
 248                 lpc_coefs[j] -= sign;
 249                 val *= sign;
 250                 error_val -= (val >> lpc_quant) * (lpc_order - j);
 251             }
 252         }
 253     }
 254 }
 255
 256 static void decorrelate_stereo(int32_t *buffer[2], int nb_samples,
 257                                int decorr_shift, int decorr_left_weight)
 258 {
 259     int i;
 260
 261     for (i = 0; i < nb_samples; i++) {
 262         int32_t a, b;
 263
 264         a = buffer[0][i];
 265         b = buffer[1][i];
 266
 267         a -= (b * decorr_left_weight) >> decorr_shift;
 268         b += a;
 269
 270         buffer[0][i] = b;
 271         buffer[1][i] = a;
 272     }
 273 }
 274
 275 static void append_extra_bits(int32_t *buffer[2], int32_t *extra_bits_buffer[2],
 276                               int extra_bits, int channels, int nb_samples)
 277 {
 278     int i, ch;
 279
 280     for (ch = 0; ch < channels; ch++)
 281         for (i = 0; i < nb_samples; i++)
 282             buffer[ch][i] = (buffer[ch][i] << extra_bits) | extra_bits_buffer[ch][i];
 283 }
 284
 285 static int decode_element(AVCodecContext *avctx, void *data, int ch_index,
 286                           int channels)
 287 {
 288     ALACContext *alac = avctx->priv_data;
 289     int has_size, bps, is_compressed, decorr_shift, decorr_left_weight, ret;
 290     uint32_t output_samples;
 291     int i, ch;
 292
 293     skip_bits(&alac->gb, 4);  /* element instance tag */
 294     skip_bits(&alac->gb, 12); /* unused header bits */
 295
 296     /* the number of output samples is stored in the frame */
 297     has_size = get_bits1(&alac->gb);
 298
 299     alac->extra_bits = get_bits(&alac->gb, 2) << 3;
 300     bps = alac->sample_size - alac->extra_bits + channels - 1;
 301     if (bps > 32) {
 302         av_log(avctx, AV_LOG_ERROR, "bps is unsupported: %d\n", bps);
 303         return AVERROR_PATCHWELCOME;
 304     }
 305
 306     /* whether the frame is compressed */
 307     is_compressed = !get_bits1(&alac->gb);
 308
 309     if (has_size)
 310         output_samples = get_bits_long(&alac->gb, 32);
 311     else
 312         output_samples = alac->max_samples_per_frame;
 313     if (!output_samples || output_samples > alac->max_samples_per_frame) {
 314         av_log(avctx, AV_LOG_ERROR, "invalid samples per frame: %d\n",
 315                output_samples);
 316         return AVERROR_INVALIDDATA;
 317     }
 318     if (!alac->nb_samples) {
 319         /* get output buffer */
 320         alac->frame.nb_samples = output_samples;
 321         if ((ret = avctx->get_buffer(avctx, &alac->frame)) < 0) {
 322             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 323             return ret;
 324         }
 325         if (alac->sample_size > 16) {
 326             for (ch = 0; ch < channels; ch++)
 327                 alac->output_samples_buffer[ch] = (int32_t *)alac->frame.extended_data[ch_index + ch];
 328         }
 329     } else if (output_samples != alac->nb_samples) {
 330         av_log(avctx, AV_LOG_ERROR, "sample count mismatch: %u != %d\n",
 331                output_samples, alac->nb_samples);
 332         return AVERROR_INVALIDDATA;
 333     }
 334     alac->nb_samples = output_samples;
 335
 336     if (is_compressed) {
 337         int16_t lpc_coefs[2][32];
 338         int lpc_order[2];
 339         int prediction_type[2];
 340         int lpc_quant[2];
 341         int rice_history_mult[2];
 342
 343         decorr_shift       = get_bits(&alac->gb, 8);
 344         decorr_left_weight = get_bits(&alac->gb, 8);
 345
 346         for (ch = 0; ch < channels; ch++) {
 347             prediction_type[ch]   = get_bits(&alac->gb, 4);
 348             lpc_quant[ch]         = get_bits(&alac->gb, 4);
 349             rice_history_mult[ch] = get_bits(&alac->gb, 3);
 350             lpc_order[ch]         = get_bits(&alac->gb, 5);
 351
 352             /* read the predictor table */
 353             for (i = 0; i < lpc_order[ch]; i++)
 354                 lpc_coefs[ch][i] = get_sbits(&alac->gb, 16);
 355         }
 356
 357         if (alac->extra_bits) {
 358             for (i = 0; i < alac->nb_samples; i++) {
 359                 for (ch = 0; ch < channels; ch++)
 360                     alac->extra_bits_buffer[ch][i] = get_bits(&alac->gb, alac->extra_bits);
 361             }
 362         }
 363         for (ch = 0; ch < channels; ch++) {
 364             rice_decompress(alac, alac->predict_error_buffer[ch],
 365                             alac->nb_samples, bps,
 366                             rice_history_mult[ch] * alac->rice_history_mult / 4);
 367
 368             /* adaptive FIR filter */
 369             if (prediction_type[ch] == 15) {
 370                 /* Prediction type 15 runs the adaptive FIR twice.
 371                  * The first pass uses the special-case coef_num = 31, while
 372                  * the second pass uses the coefs from the bitstream.
 373                  *
 374                  * However, this prediction type is not currently used by the
 375                  * reference encoder.
 376                  */
 377                 lpc_prediction(alac->predict_error_buffer[ch],
 378                                alac->predict_error_buffer[ch],
 379                                alac->nb_samples, bps, NULL, 31, 0);
 380             } else if (prediction_type[ch] > 0) {
 381                 av_log(avctx, AV_LOG_WARNING, "unknown prediction type: %i\n",
 382                        prediction_type[ch]);
 383             }
 384             lpc_prediction(alac->predict_error_buffer[ch],
 385                            alac->output_samples_buffer[ch], alac->nb_samples,
 386                            bps, lpc_coefs[ch], lpc_order[ch], lpc_quant[ch]);
 387         }
 388     } else {
 389         /* not compressed, easy case */
 390         for (i = 0; i < alac->nb_samples; i++) {
 391             for (ch = 0; ch < channels; ch++) {
 392                 alac->output_samples_buffer[ch][i] =
 393                          get_sbits_long(&alac->gb, alac->sample_size);
 394             }
 395         }
 396         alac->extra_bits   = 0;
 397         decorr_shift       = 0;
 398         decorr_left_weight = 0;
 399     }
 400
 401     if (channels == 2 && decorr_left_weight) {
 402         decorrelate_stereo(alac->output_samples_buffer, alac->nb_samples,
 403                            decorr_shift, decorr_left_weight);
 404     }
 405
 406     if (alac->extra_bits) {
 407         append_extra_bits(alac->output_samples_buffer, alac->extra_bits_buffer,
 408                           alac->extra_bits, channels, alac->nb_samples);
 409     }
 410
 411     switch(alac->sample_size) {
 412     case 16: {
 413         for (ch = 0; ch < channels; ch++) {
 414             int16_t *outbuffer = (int16_t *)alac->frame.extended_data[ch_index + ch];
 415             for (i = 0; i < alac->nb_samples; i++)
 416                 *outbuffer++ = alac->output_samples_buffer[ch][i];
 417         }}
 418         break;
 419     case 24: {
 420         for (ch = 0; ch < channels; ch++) {
 421             for (i = 0; i < alac->nb_samples; i++)
 422                 alac->output_samples_buffer[ch][i] <<= 8;
 423         }}
 424         break;
 425     }
 426
 427     return 0;
 428 }
 429
 430 static int alac_decode_frame(AVCodecContext *avctx, void *data,
 431                              int *got_frame_ptr, AVPacket *avpkt)
 432 {
 433     ALACContext *alac = avctx->priv_data;
 434     enum RawDataBlockType element;
 435     int channels;
 436     int ch, ret;
 437
 438     init_get_bits(&alac->gb, avpkt->data, avpkt->size * 8);
 439
 440     alac->nb_samples = 0;
 441     ch = 0;
 442     while (get_bits_left(&alac->gb)) {
 443         element = get_bits(&alac->gb, 3);
 444         if (element == TYPE_END)
 445             break;
 446         if (element > TYPE_CPE && element != TYPE_LFE) {
 447             av_log(avctx, AV_LOG_ERROR, "syntax element unsupported: %d", element);
 448             return AVERROR_PATCHWELCOME;
 449         }
 450
 451         channels = (element == TYPE_CPE) ? 2 : 1;
 452         if (ch + channels > alac->channels) {
 453             av_log(avctx, AV_LOG_ERROR, "invalid element channel count\n");
 454             return AVERROR_INVALIDDATA;
 455         }
 456
 457         ret = decode_element(avctx, data,
 458                              alac_channel_layout_offsets[alac->channels - 1][ch],
 459                              channels);
 460         if (ret < 0)
 461             return ret;
 462
 463         ch += channels;
 464     }
 465
 466     if (avpkt->size * 8 - get_bits_count(&alac->gb) > 8) {
 467         av_log(avctx, AV_LOG_ERROR, "Error : %d bits left\n",
 468                avpkt->size * 8 - get_bits_count(&alac->gb));
 469     }
 470
 471     *got_frame_ptr   = 1;
 472     *(AVFrame *)data = alac->frame;
 473
 474     return avpkt->size;
 475 }
 476
 477 static av_cold int alac_decode_close(AVCodecContext *avctx)
 478 {
 479     ALACContext *alac = avctx->priv_data;
 480
 481     int ch;
 482     for (ch = 0; ch < FFMIN(alac->channels, 2); ch++) {
 483         av_freep(&alac->predict_error_buffer[ch]);
 484         if (alac->sample_size == 16)
 485             av_freep(&alac->output_samples_buffer[ch]);
 486         av_freep(&alac->extra_bits_buffer[ch]);
 487     }
 488
 489     return 0;
 490 }
 491
 492 static int allocate_buffers(ALACContext *alac)
 493 {
 494     int ch;
 495     int buf_size = alac->max_samples_per_frame * sizeof(int32_t);
 496
 497     for (ch = 0; ch < FFMIN(alac->channels, 2); ch++) {
 498         FF_ALLOC_OR_GOTO(alac->avctx, alac->predict_error_buffer[ch],
 499                          buf_size, buf_alloc_fail);
 500
 501         if (alac->sample_size == 16) {
 502             FF_ALLOC_OR_GOTO(alac->avctx, alac->output_samples_buffer[ch],
 503                              buf_size, buf_alloc_fail);
 504         }
 505
 506         FF_ALLOC_OR_GOTO(alac->avctx, alac->extra_bits_buffer[ch],
 507                          buf_size, buf_alloc_fail);
 508     }
 509     return 0;
 510 buf_alloc_fail:
 511     alac_decode_close(alac->avctx);
 512     return AVERROR(ENOMEM);
 513 }
 514
 515 static int alac_set_info(ALACContext *alac)
 516 {
 517     GetByteContext gb;
 518
 519     bytestream2_init(&gb, alac->avctx->extradata,
 520                      alac->avctx->extradata_size);
 521
 522     bytestream2_skipu(&gb, 12); // size:4, alac:4, version:4
 523
 524     alac->max_samples_per_frame = bytestream2_get_be32u(&gb);
 525     if (!alac->max_samples_per_frame || alac->max_samples_per_frame > INT_MAX) {
 526         av_log(alac->avctx, AV_LOG_ERROR, "max samples per frame invalid: %u\n",
 527                alac->max_samples_per_frame);
 528         return AVERROR_INVALIDDATA;
 529     }
 530     bytestream2_skipu(&gb, 1);  // compatible version
 531     alac->sample_size          = bytestream2_get_byteu(&gb);
 532     alac->rice_history_mult    = bytestream2_get_byteu(&gb);
 533     alac->rice_initial_history = bytestream2_get_byteu(&gb);
 534     alac->rice_limit           = bytestream2_get_byteu(&gb);
 535     alac->channels             = bytestream2_get_byteu(&gb);
 536     bytestream2_get_be16u(&gb); // maxRun
 537     bytestream2_get_be32u(&gb); // max coded frame size
 538     bytestream2_get_be32u(&gb); // average bitrate
 539     bytestream2_get_be32u(&gb); // samplerate
 540
 541     return 0;
 542 }
 543
 544 static av_cold int alac_decode_init(AVCodecContext * avctx)
 545 {
 546     int ret;
 547     ALACContext *alac = avctx->priv_data;
 548     alac->avctx = avctx;
 549
 550     /* initialize from the extradata */
 551     if (alac->avctx->extradata_size != ALAC_EXTRADATA_SIZE) {
 552         av_log(avctx, AV_LOG_ERROR, "alac: expected %d extradata bytes\n",
 553             ALAC_EXTRADATA_SIZE);
 554         return -1;
 555     }
 556     if (alac_set_info(alac)) {
 557         av_log(avctx, AV_LOG_ERROR, "alac: set_info failed\n");
 558         return -1;
 559     }
 560
 561     switch (alac->sample_size) {
 562     case 16: avctx->sample_fmt = AV_SAMPLE_FMT_S16P;
 563              break;
 564     case 24:
 565     case 32: avctx->sample_fmt = AV_SAMPLE_FMT_S32P;
 566              break;
 567     default: av_log_ask_for_sample(avctx, "Sample depth %d is not supported.\n",
 568                                    alac->sample_size);
 569              return AVERROR_PATCHWELCOME;
 570     }
 571
 572     if (alac->channels < 1) {
 573         av_log(avctx, AV_LOG_WARNING, "Invalid channel count\n");
 574         alac->channels = avctx->channels;
 575     } else {
 576         if (alac->channels > MAX_CHANNELS)
 577             alac->channels = avctx->channels;
 578         else
 579             avctx->channels = alac->channels;
 580     }
 581     if (avctx->channels > MAX_CHANNELS) {
 582         av_log(avctx, AV_LOG_ERROR, "Unsupported channel count: %d\n",
 583                avctx->channels);
 584         return AVERROR_PATCHWELCOME;
 585     }
 586     avctx->channel_layout = alac_channel_layouts[alac->channels - 1];
 587
 588     if ((ret = allocate_buffers(alac)) < 0) {
 589         av_log(avctx, AV_LOG_ERROR, "Error allocating buffers\n");
 590         return ret;
 591     }
 592
 593     avcodec_get_frame_defaults(&alac->frame);
 594     avctx->coded_frame = &alac->frame;
 595
 596     return 0;
 597 }
 598
 599 AVCodec ff_alac_decoder = {
 600     .name           = "alac",
 601     .type           = AVMEDIA_TYPE_AUDIO,
 602     .id             = CODEC_ID_ALAC,
 603     .priv_data_size = sizeof(ALACContext),
 604     .init           = alac_decode_init,
 605     .close          = alac_decode_close,
 606     .decode         = alac_decode_frame,
 607     .capabilities   = CODEC_CAP_DR1,
 608     .long_name      = NULL_IF_CONFIG_SMALL("ALAC (Apple Lossless Audio Codec)"),
 609 };