alac: conditionally set sign_modifier to 1
[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 Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * ALAC (Apple Lossless Audio Codec) decoder
25  * @author 2005 David Hammerton
26  * @see http://crazney.net/programs/itunes/alac.html
27  *
28  * Note: This decoder expects a 36-byte QuickTime atom to be
29  * passed through the extradata[_size] fields. This atom is tacked onto
30  * the end of an 'alac' stsd atom and has the following format:
31  *
32  * 32bit  atom size
33  * 32bit  tag                  ("alac")
34  * 32bit  tag version          (0)
35  * 32bit  samples per frame    (used when not set explicitly in the frames)
36  *  8bit  compatible version   (0)
37  *  8bit  sample size
38  *  8bit  history mult         (40)
39  *  8bit  initial history      (14)
40  *  8bit  rice param limit     (10)
41  *  8bit  channels
42  * 16bit  maxRun               (255)
43  * 32bit  max coded frame size (0 means unknown)
44  * 32bit  average bitrate      (0 means unknown)
45  * 32bit  samplerate
46  */
47
48
49 #include "avcodec.h"
50 #include "get_bits.h"
51 #include "bytestream.h"
52 #include "unary.h"
53 #include "mathops.h"
54
55 #define ALAC_EXTRADATA_SIZE 36
56 #define MAX_CHANNELS 2
57
58 typedef struct {
59
60     AVCodecContext *avctx;
61     AVFrame frame;
62     GetBitContext gb;
63
64     int channels;
65
66     /* buffers */
67     int32_t *predict_error_buffer[MAX_CHANNELS];
68     int32_t *output_samples_buffer[MAX_CHANNELS];
69     int32_t *extra_bits_buffer[MAX_CHANNELS];
70
71     uint32_t max_samples_per_frame;
72     uint8_t  sample_size;
73     uint8_t  rice_history_mult;
74     uint8_t  rice_initial_history;
75     uint8_t  rice_limit;
76
77     int extra_bits;                         /**< number of extra bits beyond 16-bit */
78 } ALACContext;
79
80 static inline int decode_scalar(GetBitContext *gb, int k, int readsamplesize)
81 {
82     int x = get_unary_0_9(gb);
83
84     if (x > 8) { /* RICE THRESHOLD */
85         /* use alternative encoding */
86         x = get_bits(gb, readsamplesize);
87     } else if (k != 1) {
88         int extrabits = show_bits(gb, k);
89
90         /* multiply x by 2^k - 1, as part of their strange algorithm */
91         x = (x << k) - x;
92
93         if (extrabits > 1) {
94             x += extrabits - 1;
95             skip_bits(gb, k);
96         } else
97             skip_bits(gb, k - 1);
98     }
99     return x;
100 }
101
102 static void bastardized_rice_decompress(ALACContext *alac,
103                                         int32_t *output_buffer,
104                                         int output_size,
105                                         int readsamplesize,
106                                         int rice_history_mult)
107 {
108     int output_count;
109     unsigned int history = alac->rice_initial_history;
110     int sign_modifier = 0;
111
112     for (output_count = 0; output_count < output_size; output_count++) {
113         int x, k;
114
115         /* read k, that is bits as is */
116         k = av_log2((history >> 9) + 3);
117         k = FFMIN(k, alac->rice_limit);
118         x = decode_scalar(&alac->gb, k, readsamplesize);
119         x += sign_modifier;
120         sign_modifier = 0;
121
122         output_buffer[output_count] = (x >> 1) ^ -(x & 1);
123
124         /* now update the history */
125         if (x > 0xffff)
126             history = 0xffff;
127         else
128             history +=         x * rice_history_mult -
129                        ((history * rice_history_mult) >> 9);
130
131         /* special case: there may be compressed blocks of 0 */
132         if ((history < 128) && (output_count+1 < output_size)) {
133             int k;
134             unsigned int block_size;
135
136             k = 7 - av_log2(history) + ((history + 16) >> 6 /* / 64 */);
137             k = FFMIN(k, alac->rice_limit);
138
139             block_size = decode_scalar(&alac->gb, k, 16);
140
141             if (block_size > 0) {
142                 if(block_size >= output_size - output_count){
143                     av_log(alac->avctx, AV_LOG_ERROR, "invalid zero block size of %d %d %d\n", block_size, output_size, output_count);
144                     block_size= output_size - output_count - 1;
145                 }
146                 memset(&output_buffer[output_count+1], 0, block_size * 4);
147                 output_count += block_size;
148             }
149
150             if (block_size <= 0xffff)
151                 sign_modifier = 1;
152
153             history = 0;
154         }
155     }
156 }
157
158 static inline int sign_only(int v)
159 {
160     return v ? FFSIGN(v) : 0;
161 }
162
163 static void predictor_decompress_fir_adapt(int32_t *error_buffer,
164                                            int32_t *buffer_out,
165                                            int output_size,
166                                            int readsamplesize,
167                                            int16_t *predictor_coef_table,
168                                            int predictor_coef_num,
169                                            int predictor_quantitization)
170 {
171     int i;
172
173     /* first sample always copies */
174     *buffer_out = *error_buffer;
175
176     if (!predictor_coef_num) {
177         if (output_size <= 1)
178             return;
179
180         memcpy(buffer_out+1, error_buffer+1, (output_size-1) * 4);
181         return;
182     }
183
184     if (predictor_coef_num == 31) {
185         /* simple 1st-order prediction */
186         if (output_size <= 1)
187             return;
188         for (i = 0; i < output_size - 1; i++) {
189             int32_t prev_value;
190             int32_t error_value;
191
192             prev_value = buffer_out[i];
193             error_value = error_buffer[i+1];
194             buffer_out[i+1] =
195                 sign_extend((prev_value + error_value), readsamplesize);
196         }
197         return;
198     }
199
200     /* read warm-up samples */
201     if (predictor_coef_num > 0)
202         for (i = 0; i < predictor_coef_num; i++) {
203             int32_t val;
204
205             val = buffer_out[i] + error_buffer[i+1];
206             val = sign_extend(val, readsamplesize);
207             buffer_out[i+1] = val;
208         }
209
210     /* NOTE: 4 and 8 are very common cases that could be optimized. */
211
212     /* general case */
213     if (predictor_coef_num > 0) {
214         for (i = predictor_coef_num + 1; i < output_size; i++) {
215             int j;
216             int sum = 0;
217             int outval;
218             int error_val = error_buffer[i];
219
220             for (j = 0; j < predictor_coef_num; j++) {
221                 sum += (buffer_out[predictor_coef_num-j] - buffer_out[0]) *
222                        predictor_coef_table[j];
223             }
224
225             outval = (1 << (predictor_quantitization-1)) + sum;
226             outval = outval >> predictor_quantitization;
227             outval = outval + buffer_out[0] + error_val;
228             outval = sign_extend(outval, readsamplesize);
229
230             buffer_out[predictor_coef_num+1] = outval;
231
232             if (error_val > 0) {
233                 int predictor_num = predictor_coef_num - 1;
234
235                 while (predictor_num >= 0 && error_val > 0) {
236                     int val = buffer_out[0] - buffer_out[predictor_coef_num - predictor_num];
237                     int sign = sign_only(val);
238
239                     predictor_coef_table[predictor_num] -= sign;
240
241                     val *= sign; /* absolute value */
242
243                     error_val -= ((val >> predictor_quantitization) *
244                                   (predictor_coef_num - predictor_num));
245
246                     predictor_num--;
247                 }
248             } else if (error_val < 0) {
249                 int predictor_num = predictor_coef_num - 1;
250
251                 while (predictor_num >= 0 && error_val < 0) {
252                     int val = buffer_out[0] - buffer_out[predictor_coef_num - predictor_num];
253                     int sign = - sign_only(val);
254
255                     predictor_coef_table[predictor_num] -= sign;
256
257                     val *= sign; /* neg value */
258
259                     error_val -= ((val >> predictor_quantitization) *
260                                   (predictor_coef_num - predictor_num));
261
262                     predictor_num--;
263                 }
264             }
265
266             buffer_out++;
267         }
268     }
269 }
270
271 static void decorrelate_stereo(int32_t *buffer[MAX_CHANNELS],
272                                int numsamples, uint8_t interlacing_shift,
273                                uint8_t interlacing_leftweight)
274 {
275     int i;
276
277     for (i = 0; i < numsamples; i++) {
278         int32_t a, b;
279
280         a = buffer[0][i];
281         b = buffer[1][i];
282
283         a -= (b * interlacing_leftweight) >> interlacing_shift;
284         b += a;
285
286         buffer[0][i] = b;
287         buffer[1][i] = a;
288     }
289 }
290
291 static void append_extra_bits(int32_t *buffer[MAX_CHANNELS],
292                               int32_t *extra_bits_buffer[MAX_CHANNELS],
293                               int extra_bits, int numchannels, int numsamples)
294 {
295     int i, ch;
296
297     for (ch = 0; ch < numchannels; ch++)
298         for (i = 0; i < numsamples; i++)
299             buffer[ch][i] = (buffer[ch][i] << extra_bits) | extra_bits_buffer[ch][i];
300 }
301
302 static void interleave_stereo_16(int32_t *buffer[MAX_CHANNELS],
303                                  int16_t *buffer_out, int numsamples)
304 {
305     int i;
306
307     for (i = 0; i < numsamples; i++) {
308         *buffer_out++ = buffer[0][i];
309         *buffer_out++ = buffer[1][i];
310     }
311 }
312
313 static void interleave_stereo_24(int32_t *buffer[MAX_CHANNELS],
314                                  int32_t *buffer_out, int numsamples)
315 {
316     int i;
317
318     for (i = 0; i < numsamples; i++) {
319         *buffer_out++ = buffer[0][i] << 8;
320         *buffer_out++ = buffer[1][i] << 8;
321     }
322 }
323
324 static int alac_decode_frame(AVCodecContext *avctx, void *data,
325                              int *got_frame_ptr, AVPacket *avpkt)
326 {
327     const uint8_t *inbuffer = avpkt->data;
328     int input_buffer_size = avpkt->size;
329     ALACContext *alac = avctx->priv_data;
330
331     int channels;
332     unsigned int outputsamples;
333     int hassize;
334     unsigned int readsamplesize;
335     int isnotcompressed;
336     uint8_t interlacing_shift;
337     uint8_t interlacing_leftweight;
338     int i, ch, ret;
339
340     init_get_bits(&alac->gb, inbuffer, input_buffer_size * 8);
341
342     channels = get_bits(&alac->gb, 3) + 1;
343     if (channels != avctx->channels) {
344         av_log(avctx, AV_LOG_ERROR, "frame header channel count mismatch\n");
345         return AVERROR_INVALIDDATA;
346     }
347
348     skip_bits(&alac->gb, 4);  /* element instance tag */
349     skip_bits(&alac->gb, 12); /* unused header bits */
350
351     /* the number of output samples is stored in the frame */
352     hassize = get_bits1(&alac->gb);
353
354     alac->extra_bits = get_bits(&alac->gb, 2) << 3;
355
356     /* whether the frame is compressed */
357     isnotcompressed = get_bits1(&alac->gb);
358
359     if (hassize) {
360         /* now read the number of samples as a 32bit integer */
361         outputsamples = get_bits_long(&alac->gb, 32);
362         if (outputsamples > alac->max_samples_per_frame) {
363             av_log(avctx, AV_LOG_ERROR, "outputsamples %d > %d\n",
364                    outputsamples, alac->max_samples_per_frame);
365             return -1;
366         }
367     } else
368         outputsamples = alac->max_samples_per_frame;
369
370     /* get output buffer */
371     if (outputsamples > INT32_MAX) {
372         av_log(avctx, AV_LOG_ERROR, "unsupported block size: %u\n", outputsamples);
373         return AVERROR_INVALIDDATA;
374     }
375     alac->frame.nb_samples = outputsamples;
376     if ((ret = avctx->get_buffer(avctx, &alac->frame)) < 0) {
377         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
378         return ret;
379     }
380
381     readsamplesize = alac->sample_size - alac->extra_bits + channels - 1;
382     if (readsamplesize > MIN_CACHE_BITS) {
383         av_log(avctx, AV_LOG_ERROR, "readsamplesize too big (%d)\n", readsamplesize);
384         return -1;
385     }
386
387     if (!isnotcompressed) {
388         /* so it is compressed */
389         int16_t predictor_coef_table[MAX_CHANNELS][32];
390         int predictor_coef_num[MAX_CHANNELS];
391         int prediction_type[MAX_CHANNELS];
392         int prediction_quantitization[MAX_CHANNELS];
393         int ricemodifier[MAX_CHANNELS];
394
395         interlacing_shift = get_bits(&alac->gb, 8);
396         interlacing_leftweight = get_bits(&alac->gb, 8);
397
398         for (ch = 0; ch < channels; ch++) {
399             prediction_type[ch] = get_bits(&alac->gb, 4);
400             prediction_quantitization[ch] = get_bits(&alac->gb, 4);
401
402             ricemodifier[ch] = get_bits(&alac->gb, 3);
403             predictor_coef_num[ch] = get_bits(&alac->gb, 5);
404
405             /* read the predictor table */
406             for (i = 0; i < predictor_coef_num[ch]; i++)
407                 predictor_coef_table[ch][i] = (int16_t)get_bits(&alac->gb, 16);
408         }
409
410         if (alac->extra_bits) {
411             for (i = 0; i < outputsamples; i++) {
412                 for (ch = 0; ch < channels; ch++)
413                     alac->extra_bits_buffer[ch][i] = get_bits(&alac->gb, alac->extra_bits);
414             }
415         }
416         for (ch = 0; ch < channels; ch++) {
417             bastardized_rice_decompress(alac,
418                                         alac->predict_error_buffer[ch],
419                                         outputsamples,
420                                         readsamplesize,
421                                         ricemodifier[ch] * alac->rice_history_mult / 4);
422
423             /* adaptive FIR filter */
424             if (prediction_type[ch] == 15) {
425                 /* Prediction type 15 runs the adaptive FIR twice.
426                  * The first pass uses the special-case coef_num = 31, while
427                  * the second pass uses the coefs from the bitstream.
428                  *
429                  * However, this prediction type is not currently used by the
430                  * reference encoder.
431                  */
432                 predictor_decompress_fir_adapt(alac->predict_error_buffer[ch],
433                                                alac->predict_error_buffer[ch],
434                                                outputsamples, readsamplesize,
435                                                NULL, 31, 0);
436             } else if (prediction_type[ch] > 0) {
437                 av_log(avctx, AV_LOG_WARNING, "unknown prediction type: %i\n",
438                        prediction_type[ch]);
439             }
440             predictor_decompress_fir_adapt(alac->predict_error_buffer[ch],
441                                            alac->output_samples_buffer[ch],
442                                            outputsamples, readsamplesize,
443                                            predictor_coef_table[ch],
444                                            predictor_coef_num[ch],
445                                            prediction_quantitization[ch]);
446         }
447     } else {
448         /* not compressed, easy case */
449         for (i = 0; i < outputsamples; i++) {
450             for (ch = 0; ch < channels; ch++) {
451                 alac->output_samples_buffer[ch][i] = get_sbits_long(&alac->gb,
452                                                                     alac->sample_size);
453             }
454         }
455         alac->extra_bits = 0;
456         interlacing_shift = 0;
457         interlacing_leftweight = 0;
458     }
459     if (get_bits(&alac->gb, 3) != 7)
460         av_log(avctx, AV_LOG_ERROR, "Error : Wrong End Of Frame\n");
461
462     if (channels == 2 && interlacing_leftweight) {
463         decorrelate_stereo(alac->output_samples_buffer, outputsamples,
464                            interlacing_shift, interlacing_leftweight);
465     }
466
467     if (alac->extra_bits) {
468         append_extra_bits(alac->output_samples_buffer, alac->extra_bits_buffer,
469                           alac->extra_bits, alac->channels, outputsamples);
470     }
471
472     switch(alac->sample_size) {
473     case 16:
474         if (channels == 2) {
475             interleave_stereo_16(alac->output_samples_buffer,
476                                  (int16_t *)alac->frame.data[0], outputsamples);
477         } else {
478             int16_t *outbuffer = (int16_t *)alac->frame.data[0];
479             for (i = 0; i < outputsamples; i++) {
480                 outbuffer[i] = alac->output_samples_buffer[0][i];
481             }
482         }
483         break;
484     case 24:
485         if (channels == 2) {
486             interleave_stereo_24(alac->output_samples_buffer,
487                                  (int32_t *)alac->frame.data[0], outputsamples);
488         } else {
489             int32_t *outbuffer = (int32_t *)alac->frame.data[0];
490             for (i = 0; i < outputsamples; i++)
491                 outbuffer[i] = alac->output_samples_buffer[0][i] << 8;
492         }
493         break;
494     }
495
496     if (input_buffer_size * 8 - get_bits_count(&alac->gb) > 8)
497         av_log(avctx, AV_LOG_ERROR, "Error : %d bits left\n", input_buffer_size * 8 - get_bits_count(&alac->gb));
498
499     *got_frame_ptr   = 1;
500     *(AVFrame *)data = alac->frame;
501
502     return input_buffer_size;
503 }
504
505 static av_cold int alac_decode_close(AVCodecContext *avctx)
506 {
507     ALACContext *alac = avctx->priv_data;
508
509     int ch;
510     for (ch = 0; ch < alac->channels; ch++) {
511         av_freep(&alac->predict_error_buffer[ch]);
512         av_freep(&alac->output_samples_buffer[ch]);
513         av_freep(&alac->extra_bits_buffer[ch]);
514     }
515
516     return 0;
517 }
518
519 static int allocate_buffers(ALACContext *alac)
520 {
521     int ch;
522     for (ch = 0; ch < alac->channels; ch++) {
523         int buf_size = alac->max_samples_per_frame * sizeof(int32_t);
524
525         FF_ALLOC_OR_GOTO(alac->avctx, alac->predict_error_buffer[ch],
526                          buf_size, buf_alloc_fail);
527
528         FF_ALLOC_OR_GOTO(alac->avctx, alac->output_samples_buffer[ch],
529                          buf_size, buf_alloc_fail);
530
531         FF_ALLOC_OR_GOTO(alac->avctx, alac->extra_bits_buffer[ch],
532                          buf_size, buf_alloc_fail);
533     }
534     return 0;
535 buf_alloc_fail:
536     alac_decode_close(alac->avctx);
537     return AVERROR(ENOMEM);
538 }
539
540 static int alac_set_info(ALACContext *alac)
541 {
542     GetByteContext gb;
543
544     bytestream2_init(&gb, alac->avctx->extradata,
545                      alac->avctx->extradata_size);
546
547     bytestream2_skipu(&gb, 12); // size:4, alac:4, version:4
548
549     alac->max_samples_per_frame = bytestream2_get_be32u(&gb);
550     if (alac->max_samples_per_frame >= UINT_MAX/4){
551         av_log(alac->avctx, AV_LOG_ERROR,
552                "max_samples_per_frame too large\n");
553         return AVERROR_INVALIDDATA;
554     }
555     bytestream2_skipu(&gb, 1);  // compatible version
556     alac->sample_size          = bytestream2_get_byteu(&gb);
557     alac->rice_history_mult    = bytestream2_get_byteu(&gb);
558     alac->rice_initial_history = bytestream2_get_byteu(&gb);
559     alac->rice_limit           = bytestream2_get_byteu(&gb);
560     alac->channels             = bytestream2_get_byteu(&gb);
561     bytestream2_get_be16u(&gb); // maxRun
562     bytestream2_get_be32u(&gb); // max coded frame size
563     bytestream2_get_be32u(&gb); // average bitrate
564     bytestream2_get_be32u(&gb); // samplerate
565
566     return 0;
567 }
568
569 static av_cold int alac_decode_init(AVCodecContext * avctx)
570 {
571     int ret;
572     ALACContext *alac = avctx->priv_data;
573     alac->avctx = avctx;
574
575     /* initialize from the extradata */
576     if (alac->avctx->extradata_size != ALAC_EXTRADATA_SIZE) {
577         av_log(avctx, AV_LOG_ERROR, "alac: expected %d extradata bytes\n",
578             ALAC_EXTRADATA_SIZE);
579         return -1;
580     }
581     if (alac_set_info(alac)) {
582         av_log(avctx, AV_LOG_ERROR, "alac: set_info failed\n");
583         return -1;
584     }
585
586     switch (alac->sample_size) {
587     case 16: avctx->sample_fmt    = AV_SAMPLE_FMT_S16;
588              break;
589     case 24: avctx->sample_fmt    = AV_SAMPLE_FMT_S32;
590              break;
591     default: av_log_ask_for_sample(avctx, "Sample depth %d is not supported.\n",
592                                    alac->sample_size);
593              return AVERROR_PATCHWELCOME;
594     }
595
596     if (alac->channels < 1) {
597         av_log(avctx, AV_LOG_WARNING, "Invalid channel count\n");
598         alac->channels = avctx->channels;
599     } else {
600         if (alac->channels > MAX_CHANNELS)
601             alac->channels = avctx->channels;
602         else
603             avctx->channels = alac->channels;
604     }
605     if (avctx->channels > MAX_CHANNELS) {
606         av_log(avctx, AV_LOG_ERROR, "Unsupported channel count: %d\n",
607                avctx->channels);
608         return AVERROR_PATCHWELCOME;
609     }
610
611     if ((ret = allocate_buffers(alac)) < 0) {
612         av_log(avctx, AV_LOG_ERROR, "Error allocating buffers\n");
613         return ret;
614     }
615
616     avcodec_get_frame_defaults(&alac->frame);
617     avctx->coded_frame = &alac->frame;
618
619     return 0;
620 }
621
622 AVCodec ff_alac_decoder = {
623     .name           = "alac",
624     .type           = AVMEDIA_TYPE_AUDIO,
625     .id             = CODEC_ID_ALAC,
626     .priv_data_size = sizeof(ALACContext),
627     .init           = alac_decode_init,
628     .close          = alac_decode_close,
629     .decode         = alac_decode_frame,
630     .capabilities   = CODEC_CAP_DR1,
631     .long_name      = NULL_IF_CONFIG_SMALL("ALAC (Apple Lossless Audio Codec)"),
632 };