Merge remote-tracking branch 'qatar/master'
[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 FFmpeg.
6  *
7  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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- (0x24-)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  *  bytes 0-3   atom size (0x24), big-endian
32  *  bytes 4-7   atom type ('alac', not the 'alac' tag from start of stsd)
33  *  bytes 8-35  data bytes needed by decoder
34  *
35  * Extradata:
36  * 32bit  size
37  * 32bit  tag (=alac)
38  * 32bit  zero?
39  * 32bit  max sample per frame
40  *  8bit  ?? (zero?)
41  *  8bit  sample size
42  *  8bit  history mult
43  *  8bit  initial history
44  *  8bit  kmodifier
45  *  8bit  channels?
46  * 16bit  ??
47  * 32bit  max coded frame size
48  * 32bit  bitrate?
49  * 32bit  samplerate
50  */
51
52
53 #include "avcodec.h"
54 #include "get_bits.h"
55 #include "bytestream.h"
56 #include "unary.h"
57 #include "mathops.h"
58
59 #define ALAC_EXTRADATA_SIZE 36
60 #define MAX_CHANNELS 2
61
62 typedef struct {
63
64     AVCodecContext *avctx;
65     GetBitContext gb;
66
67     int numchannels;
68     int bytespersample;
69
70     /* buffers */
71     int32_t *predicterror_buffer[MAX_CHANNELS];
72
73     int32_t *outputsamples_buffer[MAX_CHANNELS];
74
75     int32_t *wasted_bits_buffer[MAX_CHANNELS];
76
77     /* stuff from setinfo */
78     uint32_t setinfo_max_samples_per_frame; /* 0x1000 = 4096 */    /* max samples per frame? */
79     uint8_t setinfo_sample_size; /* 0x10 */
80     uint8_t setinfo_rice_historymult; /* 0x28 */
81     uint8_t setinfo_rice_initialhistory; /* 0x0a */
82     uint8_t setinfo_rice_kmodifier; /* 0x0e */
83     /* end setinfo stuff */
84
85     int wasted_bits;
86 } ALACContext;
87
88 static void allocate_buffers(ALACContext *alac)
89 {
90     int chan;
91     for (chan = 0; chan < MAX_CHANNELS; chan++) {
92         alac->predicterror_buffer[chan] =
93             av_malloc(alac->setinfo_max_samples_per_frame * 4);
94
95         alac->outputsamples_buffer[chan] =
96             av_malloc(alac->setinfo_max_samples_per_frame * 4);
97
98         alac->wasted_bits_buffer[chan] = av_malloc(alac->setinfo_max_samples_per_frame * 4);
99     }
100 }
101
102 static int alac_set_info(ALACContext *alac)
103 {
104     const unsigned char *ptr = alac->avctx->extradata;
105
106     ptr += 4; /* size */
107     ptr += 4; /* alac */
108     ptr += 4; /* 0 ? */
109
110     if(AV_RB32(ptr) >= UINT_MAX/4){
111         av_log(alac->avctx, AV_LOG_ERROR, "setinfo_max_samples_per_frame too large\n");
112         return -1;
113     }
114
115     /* buffer size / 2 ? */
116     alac->setinfo_max_samples_per_frame = bytestream_get_be32(&ptr);
117     ptr++;                          /* ??? */
118     alac->setinfo_sample_size           = *ptr++;
119     if (alac->setinfo_sample_size > 32) {
120         av_log(alac->avctx, AV_LOG_ERROR, "setinfo_sample_size too large\n");
121         return -1;
122     }
123     alac->setinfo_rice_historymult      = *ptr++;
124     alac->setinfo_rice_initialhistory   = *ptr++;
125     alac->setinfo_rice_kmodifier        = *ptr++;
126     ptr++;                         /* channels? */
127     bytestream_get_be16(&ptr);      /* ??? */
128     bytestream_get_be32(&ptr);      /* max coded frame size */
129     bytestream_get_be32(&ptr);      /* bitrate ? */
130     bytestream_get_be32(&ptr);      /* samplerate */
131
132     allocate_buffers(alac);
133
134     return 0;
135 }
136
137 static inline int decode_scalar(GetBitContext *gb, int k, int limit, int readsamplesize){
138     /* read x - number of 1s before 0 represent the rice */
139     int x = get_unary_0_9(gb);
140
141     if (x > 8) { /* RICE THRESHOLD */
142         /* use alternative encoding */
143         x = get_bits(gb, readsamplesize);
144     } else {
145         if (k >= limit)
146             k = limit;
147
148         if (k != 1) {
149             int extrabits = show_bits(gb, k);
150
151             /* multiply x by 2^k - 1, as part of their strange algorithm */
152             x = (x << k) - x;
153
154             if (extrabits > 1) {
155                 x += extrabits - 1;
156                 skip_bits(gb, k);
157             } else
158                 skip_bits(gb, k - 1);
159         }
160     }
161     return x;
162 }
163
164 static void bastardized_rice_decompress(ALACContext *alac,
165                                  int32_t *output_buffer,
166                                  int output_size,
167                                  int readsamplesize, /* arg_10 */
168                                  int rice_initialhistory, /* arg424->b */
169                                  int rice_kmodifier, /* arg424->d */
170                                  int rice_historymult, /* arg424->c */
171                                  int rice_kmodifier_mask /* arg424->e */
172         )
173 {
174     int output_count;
175     unsigned int history = rice_initialhistory;
176     int sign_modifier = 0;
177
178     for (output_count = 0; output_count < output_size; output_count++) {
179         int32_t x;
180         int32_t x_modified;
181         int32_t final_val;
182
183         /* standard rice encoding */
184         int k; /* size of extra bits */
185
186         /* read k, that is bits as is */
187         k = av_log2((history >> 9) + 3);
188         x= decode_scalar(&alac->gb, k, rice_kmodifier, readsamplesize);
189
190         x_modified = sign_modifier + x;
191         final_val = (x_modified + 1) / 2;
192         if (x_modified & 1) final_val *= -1;
193
194         output_buffer[output_count] = final_val;
195
196         sign_modifier = 0;
197
198         /* now update the history */
199         history += x_modified * rice_historymult
200                    - ((history * rice_historymult) >> 9);
201
202         if (x_modified > 0xffff)
203             history = 0xffff;
204
205         /* special case: there may be compressed blocks of 0 */
206         if ((history < 128) && (output_count+1 < output_size)) {
207             int k;
208             unsigned int block_size;
209
210             sign_modifier = 1;
211
212             k = 7 - av_log2(history) + ((history + 16) >> 6 /* / 64 */);
213
214             block_size= decode_scalar(&alac->gb, k, rice_kmodifier, 16);
215
216             if (block_size > 0) {
217                 if(block_size >= output_size - output_count){
218                     av_log(alac->avctx, AV_LOG_ERROR, "invalid zero block size of %d %d %d\n", block_size, output_size, output_count);
219                     block_size= output_size - output_count - 1;
220                 }
221                 memset(&output_buffer[output_count+1], 0, block_size * 4);
222                 output_count += block_size;
223             }
224
225             if (block_size > 0xffff)
226                 sign_modifier = 0;
227
228             history = 0;
229         }
230     }
231 }
232
233 static inline int sign_only(int v)
234 {
235     return v ? FFSIGN(v) : 0;
236 }
237
238 static void predictor_decompress_fir_adapt(int32_t *error_buffer,
239                                            int32_t *buffer_out,
240                                            int output_size,
241                                            int readsamplesize,
242                                            int16_t *predictor_coef_table,
243                                            int predictor_coef_num,
244                                            int predictor_quantitization)
245 {
246     int i;
247
248     /* first sample always copies */
249     *buffer_out = *error_buffer;
250
251     if (!predictor_coef_num) {
252         if (output_size <= 1)
253             return;
254
255         memcpy(buffer_out+1, error_buffer+1, (output_size-1) * 4);
256         return;
257     }
258
259     if (predictor_coef_num == 0x1f) { /* 11111 - max value of predictor_coef_num */
260       /* second-best case scenario for fir decompression,
261        * error describes a small difference from the previous sample only
262        */
263         if (output_size <= 1)
264             return;
265         for (i = 0; i < output_size - 1; i++) {
266             int32_t prev_value;
267             int32_t error_value;
268
269             prev_value = buffer_out[i];
270             error_value = error_buffer[i+1];
271             buffer_out[i+1] =
272                 sign_extend((prev_value + error_value), readsamplesize);
273         }
274         return;
275     }
276
277     /* read warm-up samples */
278     if (predictor_coef_num > 0)
279         for (i = 0; i < predictor_coef_num; i++) {
280             int32_t val;
281
282             val = buffer_out[i] + error_buffer[i+1];
283             val = sign_extend(val, readsamplesize);
284             buffer_out[i+1] = val;
285         }
286
287 #if 0
288     /* 4 and 8 are very common cases (the only ones i've seen). these
289      * should be unrolled and optimized
290      */
291     if (predictor_coef_num == 4) {
292         /* FIXME: optimized general case */
293         return;
294     }
295
296     if (predictor_coef_table == 8) {
297         /* FIXME: optimized general case */
298         return;
299     }
300 #endif
301
302     /* general case */
303     if (predictor_coef_num > 0) {
304         for (i = predictor_coef_num + 1; i < output_size; i++) {
305             int j;
306             int sum = 0;
307             int outval;
308             int error_val = error_buffer[i];
309
310             for (j = 0; j < predictor_coef_num; j++) {
311                 sum += (buffer_out[predictor_coef_num-j] - buffer_out[0]) *
312                        predictor_coef_table[j];
313             }
314
315             outval = (1 << (predictor_quantitization-1)) + sum;
316             outval = outval >> predictor_quantitization;
317             outval = outval + buffer_out[0] + error_val;
318             outval = sign_extend(outval, readsamplesize);
319
320             buffer_out[predictor_coef_num+1] = outval;
321
322             if (error_val > 0) {
323                 int predictor_num = predictor_coef_num - 1;
324
325                 while (predictor_num >= 0 && error_val > 0) {
326                     int val = buffer_out[0] - buffer_out[predictor_coef_num - predictor_num];
327                     int sign = sign_only(val);
328
329                     predictor_coef_table[predictor_num] -= sign;
330
331                     val *= sign; /* absolute value */
332
333                     error_val -= ((val >> predictor_quantitization) *
334                                   (predictor_coef_num - predictor_num));
335
336                     predictor_num--;
337                 }
338             } else if (error_val < 0) {
339                 int predictor_num = predictor_coef_num - 1;
340
341                 while (predictor_num >= 0 && error_val < 0) {
342                     int val = buffer_out[0] - buffer_out[predictor_coef_num - predictor_num];
343                     int sign = - sign_only(val);
344
345                     predictor_coef_table[predictor_num] -= sign;
346
347                     val *= sign; /* neg value */
348
349                     error_val -= ((val >> predictor_quantitization) *
350                                   (predictor_coef_num - predictor_num));
351
352                     predictor_num--;
353                 }
354             }
355
356             buffer_out++;
357         }
358     }
359 }
360
361 static void reconstruct_stereo_16(int32_t *buffer[MAX_CHANNELS],
362                                   int16_t *buffer_out,
363                                   int numchannels, int numsamples,
364                                   uint8_t interlacing_shift,
365                                   uint8_t interlacing_leftweight)
366 {
367     int i;
368     if (numsamples <= 0)
369         return;
370
371     /* weighted interlacing */
372     if (interlacing_leftweight) {
373         for (i = 0; i < numsamples; i++) {
374             int32_t a, b;
375
376             a = buffer[0][i];
377             b = buffer[1][i];
378
379             a -= (b * interlacing_leftweight) >> interlacing_shift;
380             b += a;
381
382             buffer_out[i*numchannels] = b;
383             buffer_out[i*numchannels + 1] = a;
384         }
385
386         return;
387     }
388
389     /* otherwise basic interlacing took place */
390     for (i = 0; i < numsamples; i++) {
391         int16_t left, right;
392
393         left = buffer[0][i];
394         right = buffer[1][i];
395
396         buffer_out[i*numchannels] = left;
397         buffer_out[i*numchannels + 1] = right;
398     }
399 }
400
401 static void decorrelate_stereo_24(int32_t *buffer[MAX_CHANNELS],
402                                   int32_t *buffer_out,
403                                   int32_t *wasted_bits_buffer[MAX_CHANNELS],
404                                   int wasted_bits,
405                                   int numchannels, int numsamples,
406                                   uint8_t interlacing_shift,
407                                   uint8_t interlacing_leftweight)
408 {
409     int i;
410
411     if (numsamples <= 0)
412         return;
413
414     /* weighted interlacing */
415     if (interlacing_leftweight) {
416         for (i = 0; i < numsamples; i++) {
417             int32_t a, b;
418
419             a = buffer[0][i];
420             b = buffer[1][i];
421
422             a -= (b * interlacing_leftweight) >> interlacing_shift;
423             b += a;
424
425             if (wasted_bits) {
426                 b  = (b  << wasted_bits) | wasted_bits_buffer[0][i];
427                 a  = (a  << wasted_bits) | wasted_bits_buffer[1][i];
428             }
429
430             buffer_out[i * numchannels]     = b << 8;
431             buffer_out[i * numchannels + 1] = a << 8;
432         }
433     } else {
434         for (i = 0; i < numsamples; i++) {
435             int32_t left, right;
436
437             left  = buffer[0][i];
438             right = buffer[1][i];
439
440             if (wasted_bits) {
441                 left   = (left   << wasted_bits) | wasted_bits_buffer[0][i];
442                 right  = (right  << wasted_bits) | wasted_bits_buffer[1][i];
443             }
444
445             buffer_out[i * numchannels]     = left  << 8;
446             buffer_out[i * numchannels + 1] = right << 8;
447         }
448     }
449 }
450
451 static int alac_decode_frame(AVCodecContext *avctx,
452                              void *outbuffer, int *outputsize,
453                              AVPacket *avpkt)
454 {
455     const uint8_t *inbuffer = avpkt->data;
456     int input_buffer_size = avpkt->size;
457     ALACContext *alac = avctx->priv_data;
458
459     int channels;
460     unsigned int outputsamples;
461     int hassize;
462     unsigned int readsamplesize;
463     int isnotcompressed;
464     uint8_t interlacing_shift;
465     uint8_t interlacing_leftweight;
466
467     /* short-circuit null buffers */
468     if (!inbuffer || !input_buffer_size)
469         return -1;
470
471     init_get_bits(&alac->gb, inbuffer, input_buffer_size * 8);
472
473     channels = get_bits(&alac->gb, 3) + 1;
474     if (channels > MAX_CHANNELS) {
475         av_log(avctx, AV_LOG_ERROR, "channels > %d not supported\n",
476                MAX_CHANNELS);
477         return -1;
478     }
479
480     /* 2^result = something to do with output waiting.
481      * perhaps matters if we read > 1 frame in a pass?
482      */
483     skip_bits(&alac->gb, 4);
484
485     skip_bits(&alac->gb, 12); /* unknown, skip 12 bits */
486
487     /* the output sample size is stored soon */
488     hassize = get_bits1(&alac->gb);
489
490     alac->wasted_bits = get_bits(&alac->gb, 2) << 3;
491
492     /* whether the frame is compressed */
493     isnotcompressed = get_bits1(&alac->gb);
494
495     if (hassize) {
496         /* now read the number of samples as a 32bit integer */
497         outputsamples = get_bits_long(&alac->gb, 32);
498         if(outputsamples > alac->setinfo_max_samples_per_frame){
499             av_log(avctx, AV_LOG_ERROR, "outputsamples %d > %d\n", outputsamples, alac->setinfo_max_samples_per_frame);
500             return -1;
501         }
502     } else
503         outputsamples = alac->setinfo_max_samples_per_frame;
504
505     switch (alac->setinfo_sample_size) {
506     case 16: avctx->sample_fmt    = AV_SAMPLE_FMT_S16;
507              alac->bytespersample = channels << 1;
508              break;
509     case 24: avctx->sample_fmt    = AV_SAMPLE_FMT_S32;
510              alac->bytespersample = channels << 2;
511              break;
512     default: av_log(avctx, AV_LOG_ERROR, "Sample depth %d is not supported.\n",
513                     alac->setinfo_sample_size);
514              return -1;
515     }
516
517     if(outputsamples > *outputsize / alac->bytespersample){
518         av_log(avctx, AV_LOG_ERROR, "sample buffer too small\n");
519         return -1;
520     }
521
522     *outputsize = outputsamples * alac->bytespersample;
523     readsamplesize = alac->setinfo_sample_size - (alac->wasted_bits) + channels - 1;
524     if (readsamplesize > MIN_CACHE_BITS) {
525         av_log(avctx, AV_LOG_ERROR, "readsamplesize too big (%d)\n", readsamplesize);
526         return -1;
527     }
528
529     if (!isnotcompressed) {
530         /* so it is compressed */
531         int16_t predictor_coef_table[MAX_CHANNELS][32];
532         int predictor_coef_num[MAX_CHANNELS];
533         int prediction_type[MAX_CHANNELS];
534         int prediction_quantitization[MAX_CHANNELS];
535         int ricemodifier[MAX_CHANNELS];
536         int i, chan;
537
538         interlacing_shift = get_bits(&alac->gb, 8);
539         interlacing_leftweight = get_bits(&alac->gb, 8);
540
541         for (chan = 0; chan < channels; chan++) {
542             prediction_type[chan] = get_bits(&alac->gb, 4);
543             prediction_quantitization[chan] = get_bits(&alac->gb, 4);
544
545             ricemodifier[chan] = get_bits(&alac->gb, 3);
546             predictor_coef_num[chan] = get_bits(&alac->gb, 5);
547
548             /* read the predictor table */
549             for (i = 0; i < predictor_coef_num[chan]; i++)
550                 predictor_coef_table[chan][i] = (int16_t)get_bits(&alac->gb, 16);
551         }
552
553         if (alac->wasted_bits) {
554             int i, ch;
555             for (i = 0; i < outputsamples; i++) {
556                 for (ch = 0; ch < channels; ch++)
557                     alac->wasted_bits_buffer[ch][i] = get_bits(&alac->gb, alac->wasted_bits);
558             }
559         }
560         for (chan = 0; chan < channels; chan++) {
561             bastardized_rice_decompress(alac,
562                                         alac->predicterror_buffer[chan],
563                                         outputsamples,
564                                         readsamplesize,
565                                         alac->setinfo_rice_initialhistory,
566                                         alac->setinfo_rice_kmodifier,
567                                         ricemodifier[chan] * alac->setinfo_rice_historymult / 4,
568                                         (1 << alac->setinfo_rice_kmodifier) - 1);
569
570             if (prediction_type[chan] == 0) {
571                 /* adaptive fir */
572                 predictor_decompress_fir_adapt(alac->predicterror_buffer[chan],
573                                                alac->outputsamples_buffer[chan],
574                                                outputsamples,
575                                                readsamplesize,
576                                                predictor_coef_table[chan],
577                                                predictor_coef_num[chan],
578                                                prediction_quantitization[chan]);
579             } else {
580                 av_log(avctx, AV_LOG_ERROR, "FIXME: unhandled prediction type: %i\n", prediction_type[chan]);
581                 /* I think the only other prediction type (or perhaps this is
582                  * just a boolean?) runs adaptive fir twice.. like:
583                  * predictor_decompress_fir_adapt(predictor_error, tempout, ...)
584                  * predictor_decompress_fir_adapt(predictor_error, outputsamples ...)
585                  * little strange..
586                  */
587             }
588         }
589     } else {
590         /* not compressed, easy case */
591         int i, chan;
592         if (alac->setinfo_sample_size <= 16) {
593         for (i = 0; i < outputsamples; i++)
594             for (chan = 0; chan < channels; chan++) {
595                 int32_t audiobits;
596
597                 audiobits = get_sbits_long(&alac->gb, alac->setinfo_sample_size);
598
599                 alac->outputsamples_buffer[chan][i] = audiobits;
600             }
601         } else {
602             for (i = 0; i < outputsamples; i++) {
603                 for (chan = 0; chan < channels; chan++) {
604                     alac->outputsamples_buffer[chan][i] = get_bits(&alac->gb,
605                                                           alac->setinfo_sample_size);
606                     alac->outputsamples_buffer[chan][i] = sign_extend(alac->outputsamples_buffer[chan][i],
607                                                                       alac->setinfo_sample_size);
608                 }
609             }
610         }
611         alac->wasted_bits = 0;
612         interlacing_shift = 0;
613         interlacing_leftweight = 0;
614     }
615     if (get_bits(&alac->gb, 3) != 7)
616         av_log(avctx, AV_LOG_ERROR, "Error : Wrong End Of Frame\n");
617
618     switch(alac->setinfo_sample_size) {
619     case 16:
620         if (channels == 2) {
621             reconstruct_stereo_16(alac->outputsamples_buffer,
622                                   (int16_t*)outbuffer,
623                                   alac->numchannels,
624                                   outputsamples,
625                                   interlacing_shift,
626                                   interlacing_leftweight);
627         } else {
628             int i;
629             for (i = 0; i < outputsamples; i++) {
630                 ((int16_t*)outbuffer)[i] = alac->outputsamples_buffer[0][i];
631             }
632         }
633         break;
634     case 24:
635         if (channels == 2) {
636             decorrelate_stereo_24(alac->outputsamples_buffer,
637                                   outbuffer,
638                                   alac->wasted_bits_buffer,
639                                   alac->wasted_bits,
640                                   alac->numchannels,
641                                   outputsamples,
642                                   interlacing_shift,
643                                   interlacing_leftweight);
644         } else {
645             int i;
646             for (i = 0; i < outputsamples; i++)
647                 ((int32_t *)outbuffer)[i] = alac->outputsamples_buffer[0][i] << 8;
648         }
649         break;
650     }
651
652     if (input_buffer_size * 8 - get_bits_count(&alac->gb) > 8)
653         av_log(avctx, AV_LOG_ERROR, "Error : %d bits left\n", input_buffer_size * 8 - get_bits_count(&alac->gb));
654
655     return input_buffer_size;
656 }
657
658 static av_cold int alac_decode_init(AVCodecContext * avctx)
659 {
660     ALACContext *alac = avctx->priv_data;
661     alac->avctx = avctx;
662     alac->numchannels = alac->avctx->channels;
663
664     /* initialize from the extradata */
665     if (alac->avctx->extradata_size != ALAC_EXTRADATA_SIZE) {
666         av_log(avctx, AV_LOG_ERROR, "alac: expected %d extradata bytes\n",
667             ALAC_EXTRADATA_SIZE);
668         return -1;
669     }
670     if (alac_set_info(alac)) {
671         av_log(avctx, AV_LOG_ERROR, "alac: set_info failed\n");
672         return -1;
673     }
674
675     return 0;
676 }
677
678 static av_cold int alac_decode_close(AVCodecContext *avctx)
679 {
680     ALACContext *alac = avctx->priv_data;
681
682     int chan;
683     for (chan = 0; chan < MAX_CHANNELS; chan++) {
684         av_freep(&alac->predicterror_buffer[chan]);
685         av_freep(&alac->outputsamples_buffer[chan]);
686         av_freep(&alac->wasted_bits_buffer[chan]);
687     }
688
689     return 0;
690 }
691
692 AVCodec ff_alac_decoder = {
693     "alac",
694     AVMEDIA_TYPE_AUDIO,
695     CODEC_ID_ALAC,
696     sizeof(ALACContext),
697     alac_decode_init,
698     NULL,
699     alac_decode_close,
700     alac_decode_frame,
701     .long_name = NULL_IF_CONFIG_SMALL("ALAC (Apple Lossless Audio Codec)"),
702 };