64c7f5400f160e71a246b6ca12d556889990f573
[ffmpeg.git] / 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/channel_layout.h"
49 #include "avcodec.h"
50 #include "get_bits.h"
51 #include "bytestream.h"
52 #include "internal.h"
53 #include "unary.h"
54 #include "mathops.h"
55
56 #define ALAC_EXTRADATA_SIZE 36
57 #define MAX_CHANNELS 8
58
59 typedef struct {
60     AVCodecContext *avctx;
61     AVFrame frame;
62     GetBitContext gb;
63     int channels;
64
65     int32_t *predict_error_buffer[2];
66     int32_t *output_samples_buffer[2];
67     int32_t *extra_bits_buffer[2];
68
69     uint32_t max_samples_per_frame;
70     uint8_t  sample_size;
71     uint8_t  rice_history_mult;
72     uint8_t  rice_initial_history;
73     uint8_t  rice_limit;
74
75     int extra_bits;     /**< number of extra bits beyond 16-bit */
76     int nb_samples;     /**< number of samples in the current frame */
77 } ALACContext;
78
79 enum RawDataBlockType {
80     /* At the moment, only SCE, CPE, LFE, and END are recognized. */
81     TYPE_SCE,
82     TYPE_CPE,
83     TYPE_CCE,
84     TYPE_LFE,
85     TYPE_DSE,
86     TYPE_PCE,
87     TYPE_FIL,
88     TYPE_END
89 };
90
91 static const uint8_t alac_channel_layout_offsets[8][8] = {
92     { 0 },
93     { 0, 1 },
94     { 2, 0, 1 },
95     { 2, 0, 1, 3 },
96     { 2, 0, 1, 3, 4 },
97     { 2, 0, 1, 4, 5, 3 },
98     { 2, 0, 1, 4, 5, 6, 3 },
99     { 2, 6, 7, 0, 1, 4, 5, 3 }
100 };
101
102 static const uint16_t alac_channel_layouts[8] = {
103     AV_CH_LAYOUT_MONO,
104     AV_CH_LAYOUT_STEREO,
105     AV_CH_LAYOUT_SURROUND,
106     AV_CH_LAYOUT_4POINT0,
107     AV_CH_LAYOUT_5POINT0_BACK,
108     AV_CH_LAYOUT_5POINT1_BACK,
109     AV_CH_LAYOUT_6POINT1_BACK,
110     AV_CH_LAYOUT_7POINT1_WIDE_BACK
111 };
112
113 static inline unsigned int decode_scalar(GetBitContext *gb, int k, int bps)
114 {
115     unsigned int x = get_unary_0_9(gb);
116
117     if (x > 8) { /* RICE THRESHOLD */
118         /* use alternative encoding */
119         x = get_bits_long(gb, bps);
120     } else if (k != 1) {
121         int extrabits = show_bits(gb, k);
122
123         /* multiply x by 2^k - 1, as part of their strange algorithm */
124         x = (x << k) - x;
125
126         if (extrabits > 1) {
127             x += extrabits - 1;
128             skip_bits(gb, k);
129         } else
130             skip_bits(gb, k - 1);
131     }
132     return x;
133 }
134
135 static void rice_decompress(ALACContext *alac, int32_t *output_buffer,
136                             int nb_samples, int bps, int rice_history_mult)
137 {
138     int i;
139     unsigned int history = alac->rice_initial_history;
140     int sign_modifier = 0;
141
142     for (i = 0; i < nb_samples; i++) {
143         int k;
144         unsigned int x;
145
146         /* calculate rice param and decode next value */
147         k = av_log2((history >> 9) + 3);
148         k = FFMIN(k, alac->rice_limit);
149         x = decode_scalar(&alac->gb, k, bps);
150         x += sign_modifier;
151         sign_modifier = 0;
152         output_buffer[i] = (x >> 1) ^ -(x & 1);
153
154         /* update the history */
155         if (x > 0xffff)
156             history = 0xffff;
157         else
158             history +=         x * rice_history_mult -
159                        ((history * rice_history_mult) >> 9);
160
161         /* special case: there may be compressed blocks of 0 */
162         if ((history < 128) && (i + 1 < nb_samples)) {
163             int block_size;
164
165             /* calculate rice param and decode block size */
166             k = 7 - av_log2(history) + ((history + 16) >> 6);
167             k = FFMIN(k, alac->rice_limit);
168             block_size = decode_scalar(&alac->gb, k, 16);
169
170             if (block_size > 0) {
171                 if (block_size >= nb_samples - i) {
172                     av_log(alac->avctx, AV_LOG_ERROR,
173                            "invalid zero block size of %d %d %d\n", block_size,
174                            nb_samples, i);
175                     block_size = nb_samples - i - 1;
176                 }
177                 memset(&output_buffer[i + 1], 0,
178                        block_size * sizeof(*output_buffer));
179                 i += block_size;
180             }
181             if (block_size <= 0xffff)
182                 sign_modifier = 1;
183             history = 0;
184         }
185     }
186 }
187
188 static inline int sign_only(int v)
189 {
190     return v ? FFSIGN(v) : 0;
191 }
192
193 static void lpc_prediction(int32_t *error_buffer, int32_t *buffer_out,
194                            int nb_samples, int bps, int16_t *lpc_coefs,
195                            int lpc_order, int lpc_quant)
196 {
197     int i;
198     int32_t *pred = buffer_out;
199
200     /* first sample always copies */
201     *buffer_out = *error_buffer;
202
203     if (nb_samples <= 1)
204         return;
205
206     if (!lpc_order) {
207         memcpy(&buffer_out[1], &error_buffer[1],
208                (nb_samples - 1) * sizeof(*buffer_out));
209         return;
210     }
211
212     if (lpc_order == 31) {
213         /* simple 1st-order prediction */
214         for (i = 1; i < nb_samples; i++) {
215             buffer_out[i] = sign_extend(buffer_out[i - 1] + error_buffer[i],
216                                         bps);
217         }
218         return;
219     }
220
221     /* read warm-up samples */
222     for (i = 1; i <= lpc_order; i++)
223         buffer_out[i] = sign_extend(buffer_out[i - 1] + error_buffer[i], bps);
224
225     /* NOTE: 4 and 8 are very common cases that could be optimized. */
226
227     for (; i < nb_samples; i++) {
228         int j;
229         int val = 0;
230         int error_val = error_buffer[i];
231         int error_sign;
232         int d = *pred++;
233
234         /* LPC prediction */
235         for (j = 0; j < lpc_order; j++)
236             val += (pred[j] - d) * lpc_coefs[j];
237         val = (val + (1 << (lpc_quant - 1))) >> lpc_quant;
238         val += d + error_val;
239         buffer_out[i] = sign_extend(val, bps);
240
241         /* adapt LPC coefficients */
242         error_sign = sign_only(error_val);
243         if (error_sign) {
244             for (j = 0; j < lpc_order && error_val * error_sign > 0; j++) {
245                 int sign;
246                 val  = d - pred[j];
247                 sign = sign_only(val) * error_sign;
248                 lpc_coefs[j] -= sign;
249                 val *= sign;
250                 error_val -= (val >> lpc_quant) * (j + 1);
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 = ff_get_buffer(avctx, &alac->frame)) < 0) {
322             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
323             return ret;
324         }
325     } else if (output_samples != alac->nb_samples) {
326         av_log(avctx, AV_LOG_ERROR, "sample count mismatch: %u != %d\n",
327                output_samples, alac->nb_samples);
328         return AVERROR_INVALIDDATA;
329     }
330     alac->nb_samples = output_samples;
331     if (alac->sample_size > 16) {
332         for (ch = 0; ch < channels; ch++)
333             alac->output_samples_buffer[ch] = (int32_t *)alac->frame.extended_data[ch_index + ch];
334     }
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 = lpc_order[ch] - 1; i >= 0; 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, got_end;
437
438     init_get_bits(&alac->gb, avpkt->data, avpkt->size * 8);
439
440     got_end = 0;
441     alac->nb_samples = 0;
442     ch = 0;
443     while (get_bits_left(&alac->gb) >= 3) {
444         element = get_bits(&alac->gb, 3);
445         if (element == TYPE_END) {
446             got_end = 1;
447             break;
448         }
449         if (element > TYPE_CPE && element != TYPE_LFE) {
450             av_log(avctx, AV_LOG_ERROR, "syntax element unsupported: %d", element);
451             return AVERROR_PATCHWELCOME;
452         }
453
454         channels = (element == TYPE_CPE) ? 2 : 1;
455         if (ch + channels > alac->channels) {
456             av_log(avctx, AV_LOG_ERROR, "invalid element channel count\n");
457             return AVERROR_INVALIDDATA;
458         }
459
460         ret = decode_element(avctx, data,
461                              alac_channel_layout_offsets[alac->channels - 1][ch],
462                              channels);
463         if (ret < 0 && get_bits_left(&alac->gb))
464             return ret;
465
466         ch += channels;
467     }
468     if (!got_end) {
469         av_log(avctx, AV_LOG_ERROR, "no end tag found. incomplete packet.\n");
470         return AVERROR_INVALIDDATA;
471     }
472
473     if (avpkt->size * 8 - get_bits_count(&alac->gb) > 8) {
474         av_log(avctx, AV_LOG_ERROR, "Error : %d bits left\n",
475                avpkt->size * 8 - get_bits_count(&alac->gb));
476     }
477
478     *got_frame_ptr   = 1;
479     *(AVFrame *)data = alac->frame;
480
481     return avpkt->size;
482 }
483
484 static av_cold int alac_decode_close(AVCodecContext *avctx)
485 {
486     ALACContext *alac = avctx->priv_data;
487
488     int ch;
489     for (ch = 0; ch < FFMIN(alac->channels, 2); ch++) {
490         av_freep(&alac->predict_error_buffer[ch]);
491         if (alac->sample_size == 16)
492             av_freep(&alac->output_samples_buffer[ch]);
493         av_freep(&alac->extra_bits_buffer[ch]);
494     }
495
496     return 0;
497 }
498
499 static int allocate_buffers(ALACContext *alac)
500 {
501     int ch;
502     int buf_size = alac->max_samples_per_frame * sizeof(int32_t);
503
504     for (ch = 0; ch < FFMIN(alac->channels, 2); ch++) {
505         FF_ALLOC_OR_GOTO(alac->avctx, alac->predict_error_buffer[ch],
506                          buf_size, buf_alloc_fail);
507
508         if (alac->sample_size == 16) {
509             FF_ALLOC_OR_GOTO(alac->avctx, alac->output_samples_buffer[ch],
510                              buf_size, buf_alloc_fail);
511         }
512
513         FF_ALLOC_OR_GOTO(alac->avctx, alac->extra_bits_buffer[ch],
514                          buf_size, buf_alloc_fail);
515     }
516     return 0;
517 buf_alloc_fail:
518     alac_decode_close(alac->avctx);
519     return AVERROR(ENOMEM);
520 }
521
522 static int alac_set_info(ALACContext *alac)
523 {
524     GetByteContext gb;
525
526     bytestream2_init(&gb, alac->avctx->extradata,
527                      alac->avctx->extradata_size);
528
529     bytestream2_skipu(&gb, 12); // size:4, alac:4, version:4
530
531     alac->max_samples_per_frame = bytestream2_get_be32u(&gb);
532     if (!alac->max_samples_per_frame || alac->max_samples_per_frame > INT_MAX) {
533         av_log(alac->avctx, AV_LOG_ERROR, "max samples per frame invalid: %u\n",
534                alac->max_samples_per_frame);
535         return AVERROR_INVALIDDATA;
536     }
537     bytestream2_skipu(&gb, 1);  // compatible version
538     alac->sample_size          = bytestream2_get_byteu(&gb);
539     alac->rice_history_mult    = bytestream2_get_byteu(&gb);
540     alac->rice_initial_history = bytestream2_get_byteu(&gb);
541     alac->rice_limit           = bytestream2_get_byteu(&gb);
542     alac->channels             = bytestream2_get_byteu(&gb);
543     bytestream2_get_be16u(&gb); // maxRun
544     bytestream2_get_be32u(&gb); // max coded frame size
545     bytestream2_get_be32u(&gb); // average bitrate
546     bytestream2_get_be32u(&gb); // samplerate
547
548     return 0;
549 }
550
551 static av_cold int alac_decode_init(AVCodecContext * avctx)
552 {
553     int ret;
554     ALACContext *alac = avctx->priv_data;
555     alac->avctx = avctx;
556
557     /* initialize from the extradata */
558     if (alac->avctx->extradata_size != ALAC_EXTRADATA_SIZE) {
559         av_log(avctx, AV_LOG_ERROR, "alac: expected %d extradata bytes\n",
560             ALAC_EXTRADATA_SIZE);
561         return -1;
562     }
563     if (alac_set_info(alac)) {
564         av_log(avctx, AV_LOG_ERROR, "alac: set_info failed\n");
565         return -1;
566     }
567
568     switch (alac->sample_size) {
569     case 16: avctx->sample_fmt = AV_SAMPLE_FMT_S16P;
570              break;
571     case 24:
572     case 32: avctx->sample_fmt = AV_SAMPLE_FMT_S32P;
573              break;
574     default: av_log_ask_for_sample(avctx, "Sample depth %d is not supported.\n",
575                                    alac->sample_size);
576              return AVERROR_PATCHWELCOME;
577     }
578     avctx->bits_per_raw_sample = alac->sample_size;
579
580     if (alac->channels < 1) {
581         av_log(avctx, AV_LOG_WARNING, "Invalid channel count\n");
582         alac->channels = avctx->channels;
583     } else {
584         if (alac->channels > MAX_CHANNELS)
585             alac->channels = avctx->channels;
586         else
587             avctx->channels = alac->channels;
588     }
589     if (avctx->channels > MAX_CHANNELS) {
590         av_log(avctx, AV_LOG_ERROR, "Unsupported channel count: %d\n",
591                avctx->channels);
592         return AVERROR_PATCHWELCOME;
593     }
594     avctx->channel_layout = alac_channel_layouts[alac->channels - 1];
595
596     if ((ret = allocate_buffers(alac)) < 0) {
597         av_log(avctx, AV_LOG_ERROR, "Error allocating buffers\n");
598         return ret;
599     }
600
601     avcodec_get_frame_defaults(&alac->frame);
602     avctx->coded_frame = &alac->frame;
603
604     return 0;
605 }
606
607 AVCodec ff_alac_decoder = {
608     .name           = "alac",
609     .type           = AVMEDIA_TYPE_AUDIO,
610     .id             = AV_CODEC_ID_ALAC,
611     .priv_data_size = sizeof(ALACContext),
612     .init           = alac_decode_init,
613     .close          = alac_decode_close,
614     .decode         = alac_decode_frame,
615     .capabilities   = CODEC_CAP_DR1,
616     .long_name      = NULL_IF_CONFIG_SMALL("ALAC (Apple Lossless Audio Codec)"),
617 };