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