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