483346c255d94c5ebe4a6a5939099a240b9c2440
[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 = 0; i < output_size - 1; i++) {
190             int32_t prev_value;
191             int32_t error_value;
192
193             prev_value = buffer_out[i];
194             error_value = error_buffer[i+1];
195             buffer_out[i+1] =
196                 sign_extend((prev_value + error_value), readsamplesize);
197         }
198         return;
199     }
200
201     /* read warm-up samples */
202     if (predictor_coef_num > 0)
203         for (i = 0; i < predictor_coef_num; i++) {
204             int32_t val;
205
206             val = buffer_out[i] + error_buffer[i+1];
207             val = sign_extend(val, readsamplesize);
208             buffer_out[i+1] = val;
209         }
210
211     /* NOTE: 4 and 8 are very common cases that could be optimized. */
212
213     /* general case */
214     if (predictor_coef_num > 0) {
215         for (i = predictor_coef_num + 1; i < output_size; i++) {
216             int j;
217             int sum = 0;
218             int outval;
219             int error_val = error_buffer[i];
220
221             for (j = 0; j < predictor_coef_num; j++) {
222                 sum += (buffer_out[predictor_coef_num-j] - buffer_out[0]) *
223                        predictor_coef_table[j];
224             }
225
226             outval = (1 << (predictor_quantitization-1)) + sum;
227             outval = outval >> predictor_quantitization;
228             outval = outval + buffer_out[0] + error_val;
229             outval = sign_extend(outval, readsamplesize);
230
231             buffer_out[predictor_coef_num+1] = outval;
232
233             if (error_val > 0) {
234                 int predictor_num = predictor_coef_num - 1;
235
236                 while (predictor_num >= 0 && error_val > 0) {
237                     int val = buffer_out[0] - buffer_out[predictor_coef_num - predictor_num];
238                     int sign = sign_only(val);
239
240                     predictor_coef_table[predictor_num] -= sign;
241
242                     val *= sign; /* absolute value */
243
244                     error_val -= ((val >> predictor_quantitization) *
245                                   (predictor_coef_num - predictor_num));
246
247                     predictor_num--;
248                 }
249             } else if (error_val < 0) {
250                 int predictor_num = predictor_coef_num - 1;
251
252                 while (predictor_num >= 0 && error_val < 0) {
253                     int val = buffer_out[0] - buffer_out[predictor_coef_num - predictor_num];
254                     int sign = - sign_only(val);
255
256                     predictor_coef_table[predictor_num] -= sign;
257
258                     val *= sign; /* neg value */
259
260                     error_val -= ((val >> predictor_quantitization) *
261                                   (predictor_coef_num - predictor_num));
262
263                     predictor_num--;
264                 }
265             }
266
267             buffer_out++;
268         }
269     }
270 }
271
272 static void decorrelate_stereo(int32_t *buffer[MAX_CHANNELS],
273                                int numsamples, uint8_t interlacing_shift,
274                                uint8_t interlacing_leftweight)
275 {
276     int i;
277
278     for (i = 0; i < numsamples; i++) {
279         int32_t a, b;
280
281         a = buffer[0][i];
282         b = buffer[1][i];
283
284         a -= (b * interlacing_leftweight) >> interlacing_shift;
285         b += a;
286
287         buffer[0][i] = b;
288         buffer[1][i] = a;
289     }
290 }
291
292 static void append_extra_bits(int32_t *buffer[MAX_CHANNELS],
293                               int32_t *extra_bits_buffer[MAX_CHANNELS],
294                               int extra_bits, int numchannels, int numsamples)
295 {
296     int i, ch;
297
298     for (ch = 0; ch < numchannels; ch++)
299         for (i = 0; i < numsamples; i++)
300             buffer[ch][i] = (buffer[ch][i] << extra_bits) | extra_bits_buffer[ch][i];
301 }
302
303 static void interleave_stereo_16(int32_t *buffer[MAX_CHANNELS],
304                                  int16_t *buffer_out, int numsamples)
305 {
306     int i;
307
308     for (i = 0; i < numsamples; i++) {
309         *buffer_out++ = buffer[0][i];
310         *buffer_out++ = buffer[1][i];
311     }
312 }
313
314 static void interleave_stereo_24(int32_t *buffer[MAX_CHANNELS],
315                                  int32_t *buffer_out, int numsamples)
316 {
317     int i;
318
319     for (i = 0; i < numsamples; i++) {
320         *buffer_out++ = buffer[0][i] << 8;
321         *buffer_out++ = buffer[1][i] << 8;
322     }
323 }
324
325 static int alac_decode_frame(AVCodecContext *avctx, void *data,
326                              int *got_frame_ptr, AVPacket *avpkt)
327 {
328     const uint8_t *inbuffer = avpkt->data;
329     int input_buffer_size = avpkt->size;
330     ALACContext *alac = avctx->priv_data;
331
332     int channels;
333     unsigned int outputsamples;
334     int hassize;
335     unsigned int readsamplesize;
336     int isnotcompressed;
337     uint8_t interlacing_shift;
338     uint8_t interlacing_leftweight;
339     int i, ch, ret;
340
341     init_get_bits(&alac->gb, inbuffer, input_buffer_size * 8);
342
343     channels = get_bits(&alac->gb, 3) + 1;
344     if (channels != avctx->channels) {
345         av_log(avctx, AV_LOG_ERROR, "frame header channel count mismatch\n");
346         return AVERROR_INVALIDDATA;
347     }
348
349     skip_bits(&alac->gb, 4);  /* element instance tag */
350     skip_bits(&alac->gb, 12); /* unused header bits */
351
352     /* the number of output samples is stored in the frame */
353     hassize = get_bits1(&alac->gb);
354
355     alac->extra_bits = get_bits(&alac->gb, 2) << 3;
356
357     /* whether the frame is compressed */
358     isnotcompressed = get_bits1(&alac->gb);
359
360     if (hassize) {
361         /* now read the number of samples as a 32bit integer */
362         outputsamples = get_bits_long(&alac->gb, 32);
363         if (outputsamples > alac->max_samples_per_frame) {
364             av_log(avctx, AV_LOG_ERROR, "outputsamples %d > %d\n",
365                    outputsamples, alac->max_samples_per_frame);
366             return -1;
367         }
368     } else
369         outputsamples = alac->max_samples_per_frame;
370
371     /* get output buffer */
372     if (outputsamples > INT32_MAX) {
373         av_log(avctx, AV_LOG_ERROR, "unsupported block size: %u\n", outputsamples);
374         return AVERROR_INVALIDDATA;
375     }
376     alac->frame.nb_samples = outputsamples;
377     if ((ret = avctx->get_buffer(avctx, &alac->frame)) < 0) {
378         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
379         return ret;
380     }
381
382     readsamplesize = alac->sample_size - alac->extra_bits + channels - 1;
383     if (readsamplesize > MIN_CACHE_BITS) {
384         av_log(avctx, AV_LOG_ERROR, "readsamplesize too big (%d)\n", readsamplesize);
385         return -1;
386     }
387
388     if (!isnotcompressed) {
389         /* so it is compressed */
390         int16_t predictor_coef_table[MAX_CHANNELS][32];
391         int predictor_coef_num[MAX_CHANNELS];
392         int prediction_type[MAX_CHANNELS];
393         int prediction_quantitization[MAX_CHANNELS];
394         int ricemodifier[MAX_CHANNELS];
395
396         interlacing_shift = get_bits(&alac->gb, 8);
397         interlacing_leftweight = get_bits(&alac->gb, 8);
398
399         for (ch = 0; ch < channels; ch++) {
400             prediction_type[ch] = get_bits(&alac->gb, 4);
401             prediction_quantitization[ch] = get_bits(&alac->gb, 4);
402
403             ricemodifier[ch] = get_bits(&alac->gb, 3);
404             predictor_coef_num[ch] = get_bits(&alac->gb, 5);
405
406             /* read the predictor table */
407             for (i = 0; i < predictor_coef_num[ch]; i++)
408                 predictor_coef_table[ch][i] = (int16_t)get_bits(&alac->gb, 16);
409         }
410
411         if (alac->extra_bits) {
412             for (i = 0; i < outputsamples; i++) {
413                 for (ch = 0; ch < channels; ch++)
414                     alac->extra_bits_buffer[ch][i] = get_bits(&alac->gb, alac->extra_bits);
415             }
416         }
417         for (ch = 0; ch < channels; ch++) {
418             bastardized_rice_decompress(alac,
419                                         alac->predict_error_buffer[ch],
420                                         outputsamples,
421                                         readsamplesize,
422                                         ricemodifier[ch] * alac->rice_history_mult / 4);
423
424             /* adaptive FIR filter */
425             if (prediction_type[ch] == 15) {
426                 /* Prediction type 15 runs the adaptive FIR twice.
427                  * The first pass uses the special-case coef_num = 31, while
428                  * the second pass uses the coefs from the bitstream.
429                  *
430                  * However, this prediction type is not currently used by the
431                  * reference encoder.
432                  */
433                 predictor_decompress_fir_adapt(alac->predict_error_buffer[ch],
434                                                alac->predict_error_buffer[ch],
435                                                outputsamples, readsamplesize,
436                                                NULL, 31, 0);
437             } else if (prediction_type[ch] > 0) {
438                 av_log(avctx, AV_LOG_WARNING, "unknown prediction type: %i\n",
439                        prediction_type[ch]);
440             }
441             predictor_decompress_fir_adapt(alac->predict_error_buffer[ch],
442                                            alac->output_samples_buffer[ch],
443                                            outputsamples, readsamplesize,
444                                            predictor_coef_table[ch],
445                                            predictor_coef_num[ch],
446                                            prediction_quantitization[ch]);
447         }
448     } else {
449         /* not compressed, easy case */
450         for (i = 0; i < outputsamples; i++) {
451             for (ch = 0; ch < channels; ch++) {
452                 alac->output_samples_buffer[ch][i] = get_sbits_long(&alac->gb,
453                                                                     alac->sample_size);
454             }
455         }
456         alac->extra_bits = 0;
457         interlacing_shift = 0;
458         interlacing_leftweight = 0;
459     }
460     if (get_bits(&alac->gb, 3) != 7)
461         av_log(avctx, AV_LOG_ERROR, "Error : Wrong End Of Frame\n");
462
463     if (channels == 2 && interlacing_leftweight) {
464         decorrelate_stereo(alac->output_samples_buffer, outputsamples,
465                            interlacing_shift, interlacing_leftweight);
466     }
467
468     if (alac->extra_bits) {
469         append_extra_bits(alac->output_samples_buffer, alac->extra_bits_buffer,
470                           alac->extra_bits, alac->channels, outputsamples);
471     }
472
473     switch(alac->sample_size) {
474     case 16:
475         if (channels == 2) {
476             interleave_stereo_16(alac->output_samples_buffer,
477                                  (int16_t *)alac->frame.data[0], outputsamples);
478         } else {
479             int16_t *outbuffer = (int16_t *)alac->frame.data[0];
480             for (i = 0; i < outputsamples; i++) {
481                 outbuffer[i] = alac->output_samples_buffer[0][i];
482             }
483         }
484         break;
485     case 24:
486         if (channels == 2) {
487             interleave_stereo_24(alac->output_samples_buffer,
488                                  (int32_t *)alac->frame.data[0], outputsamples);
489         } else {
490             int32_t *outbuffer = (int32_t *)alac->frame.data[0];
491             for (i = 0; i < outputsamples; i++)
492                 outbuffer[i] = alac->output_samples_buffer[0][i] << 8;
493         }
494         break;
495     }
496
497     if (input_buffer_size * 8 - get_bits_count(&alac->gb) > 8)
498         av_log(avctx, AV_LOG_ERROR, "Error : %d bits left\n", input_buffer_size * 8 - get_bits_count(&alac->gb));
499
500     *got_frame_ptr   = 1;
501     *(AVFrame *)data = alac->frame;
502
503     return input_buffer_size;
504 }
505
506 static av_cold int alac_decode_close(AVCodecContext *avctx)
507 {
508     ALACContext *alac = avctx->priv_data;
509
510     int ch;
511     for (ch = 0; ch < alac->channels; ch++) {
512         av_freep(&alac->predict_error_buffer[ch]);
513         av_freep(&alac->output_samples_buffer[ch]);
514         av_freep(&alac->extra_bits_buffer[ch]);
515     }
516
517     return 0;
518 }
519
520 static int allocate_buffers(ALACContext *alac)
521 {
522     int ch;
523     for (ch = 0; ch < alac->channels; ch++) {
524         int buf_size = alac->max_samples_per_frame * sizeof(int32_t);
525
526         FF_ALLOC_OR_GOTO(alac->avctx, alac->predict_error_buffer[ch],
527                          buf_size, buf_alloc_fail);
528
529         FF_ALLOC_OR_GOTO(alac->avctx, alac->output_samples_buffer[ch],
530                          buf_size, buf_alloc_fail);
531
532         FF_ALLOC_OR_GOTO(alac->avctx, alac->extra_bits_buffer[ch],
533                          buf_size, buf_alloc_fail);
534     }
535     return 0;
536 buf_alloc_fail:
537     alac_decode_close(alac->avctx);
538     return AVERROR(ENOMEM);
539 }
540
541 static int alac_set_info(ALACContext *alac)
542 {
543     GetByteContext gb;
544
545     bytestream2_init(&gb, alac->avctx->extradata,
546                      alac->avctx->extradata_size);
547
548     bytestream2_skipu(&gb, 12); // size:4, alac:4, version:4
549
550     alac->max_samples_per_frame = bytestream2_get_be32u(&gb);
551     if (alac->max_samples_per_frame >= UINT_MAX/4){
552         av_log(alac->avctx, AV_LOG_ERROR,
553                "max_samples_per_frame too large\n");
554         return AVERROR_INVALIDDATA;
555     }
556     bytestream2_skipu(&gb, 1);  // compatible version
557     alac->sample_size          = bytestream2_get_byteu(&gb);
558     alac->rice_history_mult    = bytestream2_get_byteu(&gb);
559     alac->rice_initial_history = bytestream2_get_byteu(&gb);
560     alac->rice_limit           = bytestream2_get_byteu(&gb);
561     alac->channels             = bytestream2_get_byteu(&gb);
562     bytestream2_get_be16u(&gb); // maxRun
563     bytestream2_get_be32u(&gb); // max coded frame size
564     bytestream2_get_be32u(&gb); // average bitrate
565     bytestream2_get_be32u(&gb); // samplerate
566
567     return 0;
568 }
569
570 static av_cold int alac_decode_init(AVCodecContext * avctx)
571 {
572     int ret;
573     ALACContext *alac = avctx->priv_data;
574     alac->avctx = avctx;
575
576     /* initialize from the extradata */
577     if (alac->avctx->extradata_size != ALAC_EXTRADATA_SIZE) {
578         av_log(avctx, AV_LOG_ERROR, "alac: expected %d extradata bytes\n",
579             ALAC_EXTRADATA_SIZE);
580         return -1;
581     }
582     if (alac_set_info(alac)) {
583         av_log(avctx, AV_LOG_ERROR, "alac: set_info failed\n");
584         return -1;
585     }
586
587     switch (alac->sample_size) {
588     case 16: avctx->sample_fmt    = AV_SAMPLE_FMT_S16;
589              break;
590     case 24: avctx->sample_fmt    = AV_SAMPLE_FMT_S32;
591              break;
592     default: av_log_ask_for_sample(avctx, "Sample depth %d is not supported.\n",
593                                    alac->sample_size);
594              return AVERROR_PATCHWELCOME;
595     }
596
597     if (alac->channels < 1) {
598         av_log(avctx, AV_LOG_WARNING, "Invalid channel count\n");
599         alac->channels = avctx->channels;
600     } else {
601         if (alac->channels > MAX_CHANNELS)
602             alac->channels = avctx->channels;
603         else
604             avctx->channels = alac->channels;
605     }
606     if (avctx->channels > MAX_CHANNELS) {
607         av_log(avctx, AV_LOG_ERROR, "Unsupported channel count: %d\n",
608                avctx->channels);
609         return AVERROR_PATCHWELCOME;
610     }
611
612     if ((ret = allocate_buffers(alac)) < 0) {
613         av_log(avctx, AV_LOG_ERROR, "Error allocating buffers\n");
614         return ret;
615     }
616
617     avcodec_get_frame_defaults(&alac->frame);
618     avctx->coded_frame = &alac->frame;
619
620     return 0;
621 }
622
623 AVCodec ff_alac_decoder = {
624     .name           = "alac",
625     .type           = AVMEDIA_TYPE_AUDIO,
626     .id             = CODEC_ID_ALAC,
627     .priv_data_size = sizeof(ALACContext),
628     .init           = alac_decode_init,
629     .close          = alac_decode_close,
630     .decode         = alac_decode_frame,
631     .capabilities   = CODEC_CAP_DR1,
632     .long_name      = NULL_IF_CONFIG_SMALL("ALAC (Apple Lossless Audio Codec)"),
633 };