Remove wrapper around av_log2()
[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 decode_scalar(GetBitContext *gb, int k, int limit, int readsamplesize){
144     /* read x - number of 1s before 0 represent the rice */
145     int x = get_unary_0_9(gb);
146
147     if (x > 8) { /* RICE THRESHOLD */
148         /* use alternative encoding */
149         x = get_bits(gb, readsamplesize);
150     } else {
151         if (k >= limit)
152             k = limit;
153
154         if (k != 1) {
155             int extrabits = show_bits(gb, k);
156
157             /* multiply x by 2^k - 1, as part of their strange algorithm */
158             x = (x << k) - x;
159
160             if (extrabits > 1) {
161                 x += extrabits - 1;
162                 skip_bits(gb, k);
163             } else
164                 skip_bits(gb, k - 1);
165         }
166     }
167     return x;
168 }
169
170 static void bastardized_rice_decompress(ALACContext *alac,
171                                  int32_t *output_buffer,
172                                  int output_size,
173                                  int readsamplesize, /* arg_10 */
174                                  int rice_initialhistory, /* arg424->b */
175                                  int rice_kmodifier, /* arg424->d */
176                                  int rice_historymult, /* arg424->c */
177                                  int rice_kmodifier_mask /* arg424->e */
178         )
179 {
180     int output_count;
181     unsigned int history = rice_initialhistory;
182     int sign_modifier = 0;
183
184     for (output_count = 0; output_count < output_size; output_count++) {
185         int32_t x;
186         int32_t x_modified;
187         int32_t final_val;
188
189         /* standard rice encoding */
190         int k; /* size of extra bits */
191
192         /* read k, that is bits as is */
193         k = av_log2((history >> 9) + 3);
194         x= decode_scalar(&alac->gb, k, rice_kmodifier, readsamplesize);
195
196         x_modified = sign_modifier + x;
197         final_val = (x_modified + 1) / 2;
198         if (x_modified & 1) final_val *= -1;
199
200         output_buffer[output_count] = final_val;
201
202         sign_modifier = 0;
203
204         /* now update the history */
205         history += x_modified * rice_historymult
206                    - ((history * rice_historymult) >> 9);
207
208         if (x_modified > 0xffff)
209             history = 0xffff;
210
211         /* special case: there may be compressed blocks of 0 */
212         if ((history < 128) && (output_count+1 < output_size)) {
213             int block_size, k;
214
215             sign_modifier = 1;
216
217             k = 7 - av_log2(history) + ((history + 16) >> 6 /* / 64 */);
218
219             block_size= decode_scalar(&alac->gb, k, rice_kmodifier, 16);
220
221             if (block_size > 0) {
222                 memset(&output_buffer[output_count+1], 0, block_size * 4);
223                 output_count += block_size;
224             }
225
226             if (block_size > 0xffff)
227                 sign_modifier = 0;
228
229             history = 0;
230         }
231     }
232 }
233
234 static inline int32_t extend_sign32(int32_t val, int bits)
235 {
236     return (val << (32 - bits)) >> (32 - bits);
237 }
238
239 static inline int sign_only(int v)
240 {
241     return v ? FFSIGN(v) : 0;
242 }
243
244 static void predictor_decompress_fir_adapt(int32_t *error_buffer,
245                                            int32_t *buffer_out,
246                                            int output_size,
247                                            int readsamplesize,
248                                            int16_t *predictor_coef_table,
249                                            int predictor_coef_num,
250                                            int predictor_quantitization)
251 {
252     int i;
253
254     /* first sample always copies */
255     *buffer_out = *error_buffer;
256
257     if (!predictor_coef_num) {
258         if (output_size <= 1)
259             return;
260
261         memcpy(buffer_out+1, error_buffer+1, (output_size-1) * 4);
262         return;
263     }
264
265     if (predictor_coef_num == 0x1f) { /* 11111 - max value of predictor_coef_num */
266       /* second-best case scenario for fir decompression,
267        * error describes a small difference from the previous sample only
268        */
269         if (output_size <= 1)
270             return;
271         for (i = 0; i < output_size - 1; i++) {
272             int32_t prev_value;
273             int32_t error_value;
274
275             prev_value = buffer_out[i];
276             error_value = error_buffer[i+1];
277             buffer_out[i+1] =
278                 extend_sign32((prev_value + error_value), readsamplesize);
279         }
280         return;
281     }
282
283     /* read warm-up samples */
284     if (predictor_coef_num > 0)
285         for (i = 0; i < predictor_coef_num; i++) {
286             int32_t val;
287
288             val = buffer_out[i] + error_buffer[i+1];
289             val = extend_sign32(val, readsamplesize);
290             buffer_out[i+1] = val;
291         }
292
293 #if 0
294     /* 4 and 8 are very common cases (the only ones i've seen). these
295      * should be unrolled and optimized
296      */
297     if (predictor_coef_num == 4) {
298         /* FIXME: optimized general case */
299         return;
300     }
301
302     if (predictor_coef_table == 8) {
303         /* FIXME: optimized general case */
304         return;
305     }
306 #endif
307
308     /* general case */
309     if (predictor_coef_num > 0) {
310         for (i = predictor_coef_num + 1; i < output_size; i++) {
311             int j;
312             int sum = 0;
313             int outval;
314             int error_val = error_buffer[i];
315
316             for (j = 0; j < predictor_coef_num; j++) {
317                 sum += (buffer_out[predictor_coef_num-j] - buffer_out[0]) *
318                        predictor_coef_table[j];
319             }
320
321             outval = (1 << (predictor_quantitization-1)) + sum;
322             outval = outval >> predictor_quantitization;
323             outval = outval + buffer_out[0] + error_val;
324             outval = extend_sign32(outval, readsamplesize);
325
326             buffer_out[predictor_coef_num+1] = outval;
327
328             if (error_val > 0) {
329                 int predictor_num = predictor_coef_num - 1;
330
331                 while (predictor_num >= 0 && error_val > 0) {
332                     int val = buffer_out[0] - buffer_out[predictor_coef_num - predictor_num];
333                     int sign = sign_only(val);
334
335                     predictor_coef_table[predictor_num] -= sign;
336
337                     val *= sign; /* absolute value */
338
339                     error_val -= ((val >> predictor_quantitization) *
340                                   (predictor_coef_num - predictor_num));
341
342                     predictor_num--;
343                 }
344             } else if (error_val < 0) {
345                 int predictor_num = predictor_coef_num - 1;
346
347                 while (predictor_num >= 0 && error_val < 0) {
348                     int val = buffer_out[0] - buffer_out[predictor_coef_num - predictor_num];
349                     int sign = - sign_only(val);
350
351                     predictor_coef_table[predictor_num] -= sign;
352
353                     val *= sign; /* neg value */
354
355                     error_val -= ((val >> predictor_quantitization) *
356                                   (predictor_coef_num - predictor_num));
357
358                     predictor_num--;
359                 }
360             }
361
362             buffer_out++;
363         }
364     }
365 }
366
367 static void reconstruct_stereo_16(int32_t *buffer[MAX_CHANNELS],
368                                   int16_t *buffer_out,
369                                   int numchannels, int numsamples,
370                                   uint8_t interlacing_shift,
371                                   uint8_t interlacing_leftweight)
372 {
373     int i;
374     if (numsamples <= 0)
375         return;
376
377     /* weighted interlacing */
378     if (interlacing_leftweight) {
379         for (i = 0; i < numsamples; i++) {
380             int32_t a, b;
381
382             a = buffer[0][i];
383             b = buffer[1][i];
384
385             a -= (b * interlacing_leftweight) >> interlacing_shift;
386             b += a;
387
388             buffer_out[i*numchannels] = b;
389             buffer_out[i*numchannels + 1] = a;
390         }
391
392         return;
393     }
394
395     /* otherwise basic interlacing took place */
396     for (i = 0; i < numsamples; i++) {
397         int16_t left, right;
398
399         left = buffer[0][i];
400         right = buffer[1][i];
401
402         buffer_out[i*numchannels] = left;
403         buffer_out[i*numchannels + 1] = right;
404     }
405 }
406
407 static int alac_decode_frame(AVCodecContext *avctx,
408                              void *outbuffer, int *outputsize,
409                              const uint8_t *inbuffer, int input_buffer_size)
410 {
411     ALACContext *alac = avctx->priv_data;
412
413     int channels;
414     int32_t outputsamples;
415     int hassize;
416     int readsamplesize;
417     int wasted_bytes;
418     int isnotcompressed;
419     uint8_t interlacing_shift;
420     uint8_t interlacing_leftweight;
421
422     /* short-circuit null buffers */
423     if (!inbuffer || !input_buffer_size)
424         return input_buffer_size;
425
426     /* initialize from the extradata */
427     if (!alac->context_initialized) {
428         if (alac->avctx->extradata_size != ALAC_EXTRADATA_SIZE) {
429             av_log(avctx, AV_LOG_ERROR, "alac: expected %d extradata bytes\n",
430                 ALAC_EXTRADATA_SIZE);
431             return input_buffer_size;
432         }
433         if (alac_set_info(alac)) {
434             av_log(avctx, AV_LOG_ERROR, "alac: set_info failed\n");
435             return input_buffer_size;
436         }
437         alac->context_initialized = 1;
438     }
439
440     init_get_bits(&alac->gb, inbuffer, input_buffer_size * 8);
441
442     channels = get_bits(&alac->gb, 3) + 1;
443     if (channels > MAX_CHANNELS) {
444         av_log(avctx, AV_LOG_ERROR, "channels > %d not supported\n",
445                MAX_CHANNELS);
446         return input_buffer_size;
447     }
448
449     /* 2^result = something to do with output waiting.
450      * perhaps matters if we read > 1 frame in a pass?
451      */
452     skip_bits(&alac->gb, 4);
453
454     skip_bits(&alac->gb, 12); /* unknown, skip 12 bits */
455
456     /* the output sample size is stored soon */
457     hassize = get_bits1(&alac->gb);
458
459     wasted_bytes = get_bits(&alac->gb, 2); /* unknown ? */
460
461     /* whether the frame is compressed */
462     isnotcompressed = get_bits1(&alac->gb);
463
464     if (hassize) {
465         /* now read the number of samples as a 32bit integer */
466         outputsamples = get_bits(&alac->gb, 32);
467     } else
468         outputsamples = alac->setinfo_max_samples_per_frame;
469
470     *outputsize = outputsamples * alac->bytespersample;
471     readsamplesize = alac->setinfo_sample_size - (wasted_bytes * 8) + channels - 1;
472
473     if (!isnotcompressed) {
474         /* so it is compressed */
475         int16_t predictor_coef_table[channels][32];
476         int predictor_coef_num[channels];
477         int prediction_type[channels];
478         int prediction_quantitization[channels];
479         int ricemodifier[channels];
480         int i, chan;
481
482         interlacing_shift = get_bits(&alac->gb, 8);
483         interlacing_leftweight = get_bits(&alac->gb, 8);
484
485         for (chan = 0; chan < channels; chan++) {
486             prediction_type[chan] = get_bits(&alac->gb, 4);
487             prediction_quantitization[chan] = get_bits(&alac->gb, 4);
488
489             ricemodifier[chan] = get_bits(&alac->gb, 3);
490             predictor_coef_num[chan] = get_bits(&alac->gb, 5);
491
492             /* read the predictor table */
493             for (i = 0; i < predictor_coef_num[chan]; i++)
494                 predictor_coef_table[chan][i] = (int16_t)get_bits(&alac->gb, 16);
495         }
496
497         if (wasted_bytes)
498             av_log(avctx, AV_LOG_ERROR, "FIXME: unimplemented, unhandling of wasted_bytes\n");
499
500         for (chan = 0; chan < channels; chan++) {
501             bastardized_rice_decompress(alac,
502                                         alac->predicterror_buffer[chan],
503                                         outputsamples,
504                                         readsamplesize,
505                                         alac->setinfo_rice_initialhistory,
506                                         alac->setinfo_rice_kmodifier,
507                                         ricemodifier[chan] * alac->setinfo_rice_historymult / 4,
508                                         (1 << alac->setinfo_rice_kmodifier) - 1);
509
510             if (prediction_type[chan] == 0) {
511                 /* adaptive fir */
512                 predictor_decompress_fir_adapt(alac->predicterror_buffer[chan],
513                                                alac->outputsamples_buffer[chan],
514                                                outputsamples,
515                                                readsamplesize,
516                                                predictor_coef_table[chan],
517                                                predictor_coef_num[chan],
518                                                prediction_quantitization[chan]);
519             } else {
520                 av_log(avctx, AV_LOG_ERROR, "FIXME: unhandled prediction type: %i\n", prediction_type[chan]);
521                 /* I think the only other prediction type (or perhaps this is
522                  * just a boolean?) runs adaptive fir twice.. like:
523                  * predictor_decompress_fir_adapt(predictor_error, tempout, ...)
524                  * predictor_decompress_fir_adapt(predictor_error, outputsamples ...)
525                  * little strange..
526                  */
527             }
528         }
529     } else {
530         /* not compressed, easy case */
531         if (alac->setinfo_sample_size <= 16) {
532             int i, chan;
533             for (chan = 0; chan < channels; chan++)
534                 for (i = 0; i < outputsamples; i++) {
535                     int32_t audiobits;
536
537                     audiobits = get_bits(&alac->gb, alac->setinfo_sample_size);
538                     audiobits = extend_sign32(audiobits, readsamplesize);
539
540                     alac->outputsamples_buffer[chan][i] = audiobits;
541                 }
542         } else {
543             int i, chan;
544             for (chan = 0; chan < channels; chan++)
545                 for (i = 0; i < outputsamples; i++) {
546                     int32_t audiobits;
547
548                     audiobits = get_bits(&alac->gb, 16);
549                     /* special case of sign extension..
550                      * as we'll be ORing the low 16bits into this */
551                     audiobits = audiobits << 16;
552                     audiobits = audiobits >> (32 - alac->setinfo_sample_size);
553                     audiobits |= get_bits(&alac->gb, alac->setinfo_sample_size - 16);
554
555                     alac->outputsamples_buffer[chan][i] = audiobits;
556                 }
557         }
558         /* wasted_bytes = 0; */
559         interlacing_shift = 0;
560         interlacing_leftweight = 0;
561     }
562
563     switch(alac->setinfo_sample_size) {
564     case 16:
565         if (channels == 2) {
566             reconstruct_stereo_16(alac->outputsamples_buffer,
567                                   (int16_t*)outbuffer,
568                                   alac->numchannels,
569                                   outputsamples,
570                                   interlacing_shift,
571                                   interlacing_leftweight);
572         } else {
573             int i;
574             for (i = 0; i < outputsamples; i++) {
575                 int16_t sample = alac->outputsamples_buffer[0][i];
576                 ((int16_t*)outbuffer)[i * alac->numchannels] = sample;
577             }
578         }
579         break;
580     case 20:
581     case 24:
582         // It is not clear if there exist any encoder that creates 24 bit ALAC
583         // files. iTunes convert 24 bit raw files to 16 bit before encoding.
584     case 32:
585         av_log(avctx, AV_LOG_ERROR, "FIXME: unimplemented sample size %i\n", alac->setinfo_sample_size);
586         break;
587     default:
588         break;
589     }
590
591     return input_buffer_size;
592 }
593
594 static av_cold int alac_decode_init(AVCodecContext * avctx)
595 {
596     ALACContext *alac = avctx->priv_data;
597     alac->avctx = avctx;
598     alac->context_initialized = 0;
599
600     alac->samplesize = alac->avctx->bits_per_sample;
601     alac->numchannels = alac->avctx->channels;
602     alac->bytespersample = (alac->samplesize / 8) * alac->numchannels;
603
604     return 0;
605 }
606
607 static av_cold int alac_decode_close(AVCodecContext *avctx)
608 {
609     ALACContext *alac = avctx->priv_data;
610
611     int chan;
612     for (chan = 0; chan < MAX_CHANNELS; chan++) {
613         av_free(alac->predicterror_buffer[chan]);
614         av_free(alac->outputsamples_buffer[chan]);
615     }
616
617     return 0;
618 }
619
620 AVCodec alac_decoder = {
621     "alac",
622     CODEC_TYPE_AUDIO,
623     CODEC_ID_ALAC,
624     sizeof(ALACContext),
625     alac_decode_init,
626     NULL,
627     alac_decode_close,
628     alac_decode_frame,
629 };