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