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