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