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