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