2 * FLAC (Free Lossless Audio Codec) decoder
3 * Copyright (c) 2003 Alex Beregszaszi
5 * This file is part of FFmpeg.
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.
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.
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
23 * @file libavcodec/flacdec.c
24 * FLAC (Free Lossless Audio Codec) decoder
25 * @author Alex Beregszaszi
27 * For more information on the FLAC format, visit:
28 * http://flac.sourceforge.net/
30 * This decoder can be used in 1 of 2 ways: Either raw FLAC data can be fed
31 * through, starting from the initial 'fLaC' signature; or by passing the
32 * 34-byte streaminfo structure through avctx->extradata[_size] followed
33 * by data starting with the 0xFFF8 marker.
38 #define ALT_BITSTREAM_READER
39 #include "libavutil/crc.h"
41 #include "bitstream.h"
48 #define MAX_CHANNELS 8
49 #define MAX_BLOCKSIZE 65535
51 enum decorrelation_type {
58 typedef struct FLACContext {
61 AVCodecContext *avctx; ///< parent AVCodecContext
62 GetBitContext gb; ///< GetBitContext initialized to start at the current frame
64 int blocksize; ///< number of samples in the current frame
65 int curr_bps; ///< bps for current subframe, adjusted for channel correlation and wasted bits
66 int sample_shift; ///< shift required to make output samples 16-bit or 32-bit
67 int is32; ///< flag to indicate if output should be 32-bit instead of 16-bit
68 enum decorrelation_type decorrelation; ///< channel decorrelation type in the current frame
70 int32_t *decoded[MAX_CHANNELS]; ///< decoded samples
72 unsigned int bitstream_size;
73 unsigned int bitstream_index;
74 unsigned int allocated_bitstream_size;
77 static const int sample_rate_table[] =
79 88200, 176400, 192000,
80 8000, 16000, 22050, 24000, 32000, 44100, 48000, 96000,
83 static const int sample_size_table[] =
84 { 0, 8, 12, 0, 16, 20, 24, 0 };
86 static const int blocksize_table[] = {
87 0, 192, 576<<0, 576<<1, 576<<2, 576<<3, 0, 0,
88 256<<0, 256<<1, 256<<2, 256<<3, 256<<4, 256<<5, 256<<6, 256<<7
91 static int64_t get_utf8(GetBitContext *gb)
94 GET_UTF8(val, get_bits(gb, 8), return -1;)
98 static void allocate_buffers(FLACContext *s);
100 int ff_flac_is_extradata_valid(AVCodecContext *avctx,
101 enum FLACExtradataFormat *format,
102 uint8_t **streaminfo_start)
104 if (!avctx->extradata || avctx->extradata_size < FLAC_STREAMINFO_SIZE) {
105 av_log(avctx, AV_LOG_ERROR, "extradata NULL or too small.\n");
108 if (AV_RL32(avctx->extradata) != MKTAG('f','L','a','C')) {
109 /* extradata contains STREAMINFO only */
110 if (avctx->extradata_size != FLAC_STREAMINFO_SIZE) {
111 av_log(avctx, AV_LOG_WARNING, "extradata contains %d bytes too many.\n",
112 FLAC_STREAMINFO_SIZE-avctx->extradata_size);
114 *format = FLAC_EXTRADATA_FORMAT_STREAMINFO;
115 *streaminfo_start = avctx->extradata;
117 if (avctx->extradata_size < 8+FLAC_STREAMINFO_SIZE) {
118 av_log(avctx, AV_LOG_ERROR, "extradata too small.\n");
121 *format = FLAC_EXTRADATA_FORMAT_FULL_HEADER;
122 *streaminfo_start = &avctx->extradata[8];
127 static av_cold int flac_decode_init(AVCodecContext *avctx)
129 enum FLACExtradataFormat format;
131 FLACContext *s = avctx->priv_data;
134 avctx->sample_fmt = SAMPLE_FMT_S16;
136 /* for now, the raw FLAC header is allowed to be passed to the decoder as
137 frame data instead of extradata. */
138 if (!avctx->extradata)
141 if (!ff_flac_is_extradata_valid(avctx, &format, &streaminfo))
144 /* initialize based on the demuxer-supplied streamdata header */
145 ff_flac_parse_streaminfo(avctx, (FLACStreaminfo *)s,
152 static void dump_headers(AVCodecContext *avctx, FLACStreaminfo *s)
154 av_log(avctx, AV_LOG_DEBUG, " Blocksize: %d .. %d\n", s->min_blocksize,
156 av_log(avctx, AV_LOG_DEBUG, " Max Framesize: %d\n", s->max_framesize);
157 av_log(avctx, AV_LOG_DEBUG, " Samplerate: %d\n", s->samplerate);
158 av_log(avctx, AV_LOG_DEBUG, " Channels: %d\n", s->channels);
159 av_log(avctx, AV_LOG_DEBUG, " Bits: %d\n", s->bps);
162 static void allocate_buffers(FLACContext *s)
166 assert(s->max_blocksize);
168 if (s->max_framesize == 0 && s->max_blocksize) {
169 // FIXME header overhead
170 s->max_framesize= (s->channels * s->bps * s->max_blocksize + 7)/ 8;
173 for (i = 0; i < s->channels; i++) {
174 s->decoded[i] = av_realloc(s->decoded[i],
175 sizeof(int32_t)*s->max_blocksize);
178 if (s->allocated_bitstream_size < s->max_framesize)
179 s->bitstream= av_fast_realloc(s->bitstream,
180 &s->allocated_bitstream_size,
184 void ff_flac_parse_streaminfo(AVCodecContext *avctx, struct FLACStreaminfo *s,
185 const uint8_t *buffer)
188 init_get_bits(&gb, buffer, FLAC_STREAMINFO_SIZE*8);
190 /* mandatory streaminfo */
191 s->min_blocksize = get_bits(&gb, 16);
192 s->max_blocksize = get_bits(&gb, 16);
194 skip_bits(&gb, 24); /* skip min frame size */
195 s->max_framesize = get_bits_long(&gb, 24);
197 s->samplerate = get_bits_long(&gb, 20);
198 s->channels = get_bits(&gb, 3) + 1;
199 s->bps = get_bits(&gb, 5) + 1;
201 avctx->channels = s->channels;
202 avctx->sample_rate = s->samplerate;
203 avctx->bits_per_raw_sample = s->bps;
205 avctx->sample_fmt = SAMPLE_FMT_S32;
207 avctx->sample_fmt = SAMPLE_FMT_S16;
209 s->samples = get_bits_long(&gb, 32) << 4;
210 s->samples |= get_bits_long(&gb, 4);
212 skip_bits(&gb, 64); /* md5 sum */
213 skip_bits(&gb, 64); /* md5 sum */
215 dump_headers(avctx, s);
219 * Parse a list of metadata blocks. This list of blocks must begin with
221 * @param s the flac decoding context containing the gb bit reader used to
223 * @return 1 if some metadata was read, 0 if no fLaC marker was found
225 static int metadata_parse(FLACContext *s)
227 int i, metadata_last, metadata_type, metadata_size, streaminfo_updated=0;
228 int initial_pos= get_bits_count(&s->gb);
230 if (show_bits_long(&s->gb, 32) == MKBETAG('f','L','a','C')) {
231 skip_bits(&s->gb, 32);
234 metadata_last = get_bits1(&s->gb);
235 metadata_type = get_bits(&s->gb, 7);
236 metadata_size = get_bits_long(&s->gb, 24);
238 if (get_bits_count(&s->gb) + 8*metadata_size > s->gb.size_in_bits) {
239 skip_bits_long(&s->gb, initial_pos - get_bits_count(&s->gb));
244 switch (metadata_type) {
245 case FLAC_METADATA_TYPE_STREAMINFO:
246 ff_flac_parse_streaminfo(s->avctx, (FLACStreaminfo *)s,
247 s->gb.buffer+get_bits_count(&s->gb)/8);
248 streaminfo_updated = 1;
251 for (i = 0; i < metadata_size; i++)
252 skip_bits(&s->gb, 8);
255 } while (!metadata_last);
257 if (streaminfo_updated)
264 static int decode_residuals(FLACContext *s, int channel, int pred_order)
266 int i, tmp, partition, method_type, rice_order;
267 int sample = 0, samples;
269 method_type = get_bits(&s->gb, 2);
270 if (method_type > 1) {
271 av_log(s->avctx, AV_LOG_ERROR, "illegal residual coding method %d\n",
276 rice_order = get_bits(&s->gb, 4);
278 samples= s->blocksize >> rice_order;
279 if (pred_order > samples) {
280 av_log(s->avctx, AV_LOG_ERROR, "invalid predictor order: %i > %i\n",
281 pred_order, samples);
287 for (partition = 0; partition < (1 << rice_order); partition++) {
288 tmp = get_bits(&s->gb, method_type == 0 ? 4 : 5);
289 if (tmp == (method_type == 0 ? 15 : 31)) {
290 tmp = get_bits(&s->gb, 5);
291 for (; i < samples; i++, sample++)
292 s->decoded[channel][sample] = get_sbits(&s->gb, tmp);
294 for (; i < samples; i++, sample++) {
295 s->decoded[channel][sample] = get_sr_golomb_flac(&s->gb, tmp, INT_MAX, 0);
304 static int decode_subframe_fixed(FLACContext *s, int channel, int pred_order)
306 const int blocksize = s->blocksize;
307 int32_t *decoded = s->decoded[channel];
308 int av_uninit(a), av_uninit(b), av_uninit(c), av_uninit(d), i;
310 /* warm up samples */
311 for (i = 0; i < pred_order; i++) {
312 decoded[i] = get_sbits(&s->gb, s->curr_bps);
315 if (decode_residuals(s, channel, pred_order) < 0)
319 a = decoded[pred_order-1];
321 b = a - decoded[pred_order-2];
323 c = b - decoded[pred_order-2] + decoded[pred_order-3];
325 d = c - decoded[pred_order-2] + 2*decoded[pred_order-3] - decoded[pred_order-4];
327 switch (pred_order) {
331 for (i = pred_order; i < blocksize; i++)
332 decoded[i] = a += decoded[i];
335 for (i = pred_order; i < blocksize; i++)
336 decoded[i] = a += b += decoded[i];
339 for (i = pred_order; i < blocksize; i++)
340 decoded[i] = a += b += c += decoded[i];
343 for (i = pred_order; i < blocksize; i++)
344 decoded[i] = a += b += c += d += decoded[i];
347 av_log(s->avctx, AV_LOG_ERROR, "illegal pred order %d\n", pred_order);
354 static int decode_subframe_lpc(FLACContext *s, int channel, int pred_order)
357 int coeff_prec, qlevel;
358 int coeffs[pred_order];
359 int32_t *decoded = s->decoded[channel];
361 /* warm up samples */
362 for (i = 0; i < pred_order; i++) {
363 decoded[i] = get_sbits(&s->gb, s->curr_bps);
366 coeff_prec = get_bits(&s->gb, 4) + 1;
367 if (coeff_prec == 16) {
368 av_log(s->avctx, AV_LOG_ERROR, "invalid coeff precision\n");
371 qlevel = get_sbits(&s->gb, 5);
373 av_log(s->avctx, AV_LOG_ERROR, "qlevel %d not supported, maybe buggy stream\n",
378 for (i = 0; i < pred_order; i++) {
379 coeffs[i] = get_sbits(&s->gb, coeff_prec);
382 if (decode_residuals(s, channel, pred_order) < 0)
387 for (i = pred_order; i < s->blocksize; i++) {
389 for (j = 0; j < pred_order; j++)
390 sum += (int64_t)coeffs[j] * decoded[i-j-1];
391 decoded[i] += sum >> qlevel;
394 for (i = pred_order; i < s->blocksize-1; i += 2) {
396 int d = decoded[i-pred_order];
398 for (j = pred_order-1; j > 0; j--) {
406 d = decoded[i] += s0 >> qlevel;
408 decoded[i+1] += s1 >> qlevel;
410 if (i < s->blocksize) {
412 for (j = 0; j < pred_order; j++)
413 sum += coeffs[j] * decoded[i-j-1];
414 decoded[i] += sum >> qlevel;
421 static inline int decode_subframe(FLACContext *s, int channel)
423 int type, wasted = 0;
426 s->curr_bps = s->bps;
428 if (s->decorrelation == RIGHT_SIDE)
431 if (s->decorrelation == LEFT_SIDE || s->decorrelation == MID_SIDE)
435 if (get_bits1(&s->gb)) {
436 av_log(s->avctx, AV_LOG_ERROR, "invalid subframe padding\n");
439 type = get_bits(&s->gb, 6);
441 if (get_bits1(&s->gb)) {
443 while (!get_bits1(&s->gb))
445 s->curr_bps -= wasted;
448 //FIXME use av_log2 for types
450 tmp = get_sbits(&s->gb, s->curr_bps);
451 for (i = 0; i < s->blocksize; i++)
452 s->decoded[channel][i] = tmp;
453 } else if (type == 1) {
454 for (i = 0; i < s->blocksize; i++)
455 s->decoded[channel][i] = get_sbits(&s->gb, s->curr_bps);
456 } else if ((type >= 8) && (type <= 12)) {
457 if (decode_subframe_fixed(s, channel, type & ~0x8) < 0)
459 } else if (type >= 32) {
460 if (decode_subframe_lpc(s, channel, (type & ~0x20)+1) < 0)
463 av_log(s->avctx, AV_LOG_ERROR, "invalid coding type\n");
469 for (i = 0; i < s->blocksize; i++)
470 s->decoded[channel][i] <<= wasted;
476 static int decode_frame(FLACContext *s, int alloc_data_size)
478 int blocksize_code, sample_rate_code, sample_size_code, assignment, i, crc8;
479 int decorrelation, bps, blocksize, samplerate;
481 blocksize_code = get_bits(&s->gb, 4);
483 sample_rate_code = get_bits(&s->gb, 4);
485 assignment = get_bits(&s->gb, 4); /* channel assignment */
486 if (assignment < 8 && s->channels == assignment+1)
487 decorrelation = INDEPENDENT;
488 else if (assignment >=8 && assignment < 11 && s->channels == 2)
489 decorrelation = LEFT_SIDE + assignment - 8;
491 av_log(s->avctx, AV_LOG_ERROR, "unsupported channel assignment %d (channels=%d)\n",
492 assignment, s->channels);
496 sample_size_code = get_bits(&s->gb, 3);
497 if (sample_size_code == 0)
499 else if ((sample_size_code != 3) && (sample_size_code != 7))
500 bps = sample_size_table[sample_size_code];
502 av_log(s->avctx, AV_LOG_ERROR, "invalid sample size code (%d)\n",
507 s->avctx->sample_fmt = SAMPLE_FMT_S32;
508 s->sample_shift = 32 - bps;
511 s->avctx->sample_fmt = SAMPLE_FMT_S16;
512 s->sample_shift = 16 - bps;
515 s->bps = s->avctx->bits_per_raw_sample = bps;
517 if (get_bits1(&s->gb)) {
518 av_log(s->avctx, AV_LOG_ERROR, "broken stream, invalid padding\n");
522 if (get_utf8(&s->gb) < 0) {
523 av_log(s->avctx, AV_LOG_ERROR, "utf8 fscked\n");
527 if (blocksize_code == 0)
528 blocksize = s->min_blocksize;
529 else if (blocksize_code == 6)
530 blocksize = get_bits(&s->gb, 8)+1;
531 else if (blocksize_code == 7)
532 blocksize = get_bits(&s->gb, 16)+1;
534 blocksize = blocksize_table[blocksize_code];
536 if (blocksize > s->max_blocksize) {
537 av_log(s->avctx, AV_LOG_ERROR, "blocksize %d > %d\n", blocksize,
542 if (blocksize * s->channels * sizeof(int16_t) > alloc_data_size)
545 if (sample_rate_code == 0)
546 samplerate= s->samplerate;
547 else if (sample_rate_code < 12)
548 samplerate = sample_rate_table[sample_rate_code];
549 else if (sample_rate_code == 12)
550 samplerate = get_bits(&s->gb, 8) * 1000;
551 else if (sample_rate_code == 13)
552 samplerate = get_bits(&s->gb, 16);
553 else if (sample_rate_code == 14)
554 samplerate = get_bits(&s->gb, 16) * 10;
556 av_log(s->avctx, AV_LOG_ERROR, "illegal sample rate code %d\n",
561 skip_bits(&s->gb, 8);
562 crc8 = av_crc(av_crc_get_table(AV_CRC_8_ATM), 0,
563 s->gb.buffer, get_bits_count(&s->gb)/8);
565 av_log(s->avctx, AV_LOG_ERROR, "header crc mismatch crc=%2X\n", crc8);
569 s->blocksize = blocksize;
570 s->samplerate = samplerate;
572 s->decorrelation= decorrelation;
574 // dump_headers(s->avctx, (FLACStreaminfo *)s);
577 for (i = 0; i < s->channels; i++) {
578 if (decode_subframe(s, i) < 0)
582 align_get_bits(&s->gb);
585 skip_bits(&s->gb, 16); /* data crc */
590 static int flac_decode_frame(AVCodecContext *avctx,
591 void *data, int *data_size,
592 const uint8_t *buf, int buf_size)
594 FLACContext *s = avctx->priv_data;
595 int tmp = 0, i, j = 0, input_buf_size = 0;
596 int16_t *samples_16 = data;
597 int32_t *samples_32 = data;
598 int alloc_data_size= *data_size;
602 if (s->max_framesize == 0) {
603 s->max_framesize= FFMAX(4, buf_size); // should hopefully be enough for the first header
604 s->bitstream= av_fast_realloc(s->bitstream, &s->allocated_bitstream_size, s->max_framesize);
607 if (1 && s->max_framesize) { //FIXME truncated
608 if (s->bitstream_size < 4 || AV_RL32(s->bitstream) != MKTAG('f','L','a','C'))
609 buf_size= FFMIN(buf_size, s->max_framesize - FFMIN(s->bitstream_size, s->max_framesize));
610 input_buf_size= buf_size;
612 if (s->bitstream_size + buf_size < buf_size || s->bitstream_index + s->bitstream_size + buf_size < s->bitstream_index)
615 if (s->allocated_bitstream_size < s->bitstream_size + buf_size)
616 s->bitstream= av_fast_realloc(s->bitstream, &s->allocated_bitstream_size, s->bitstream_size + buf_size);
618 if (s->bitstream_index + s->bitstream_size + buf_size > s->allocated_bitstream_size) {
619 memmove(s->bitstream, &s->bitstream[s->bitstream_index],
621 s->bitstream_index=0;
623 memcpy(&s->bitstream[s->bitstream_index + s->bitstream_size],
625 buf= &s->bitstream[s->bitstream_index];
626 buf_size += s->bitstream_size;
627 s->bitstream_size= buf_size;
629 if (buf_size < s->max_framesize && input_buf_size) {
630 return input_buf_size;
634 init_get_bits(&s->gb, buf, buf_size*8);
636 if (metadata_parse(s))
639 tmp = show_bits(&s->gb, 16);
640 if ((tmp & 0xFFFE) != 0xFFF8) {
641 av_log(s->avctx, AV_LOG_ERROR, "FRAME HEADER not here\n");
642 while (get_bits_count(&s->gb)/8+2 < buf_size && (show_bits(&s->gb, 16) & 0xFFFE) != 0xFFF8)
643 skip_bits(&s->gb, 8);
644 goto end; // we may not have enough bits left to decode a frame, so try next time
646 skip_bits(&s->gb, 16);
647 if (decode_frame(s, alloc_data_size) < 0) {
648 av_log(s->avctx, AV_LOG_ERROR, "decode_frame() failed\n");
650 s->bitstream_index=0;
654 #define DECORRELATE(left, right)\
655 assert(s->channels == 2);\
656 for (i = 0; i < s->blocksize; i++) {\
657 int a= s->decoded[0][i];\
658 int b= s->decoded[1][i];\
660 *samples_32++ = (left) << s->sample_shift;\
661 *samples_32++ = (right) << s->sample_shift;\
663 *samples_16++ = (left) << s->sample_shift;\
664 *samples_16++ = (right) << s->sample_shift;\
669 switch (s->decorrelation) {
671 for (j = 0; j < s->blocksize; j++) {
672 for (i = 0; i < s->channels; i++) {
674 *samples_32++ = s->decoded[i][j] << s->sample_shift;
676 *samples_16++ = s->decoded[i][j] << s->sample_shift;
685 DECORRELATE( (a-=b>>1) + b, a)
688 *data_size = s->blocksize * s->channels * (s->is32 ? 4 : 2);
691 i= (get_bits_count(&s->gb)+7)/8;
693 av_log(s->avctx, AV_LOG_ERROR, "overread: %d\n", i - buf_size);
695 s->bitstream_index=0;
699 if (s->bitstream_size) {
700 s->bitstream_index += i;
701 s->bitstream_size -= i;
702 return input_buf_size;
707 static av_cold int flac_decode_close(AVCodecContext *avctx)
709 FLACContext *s = avctx->priv_data;
712 for (i = 0; i < s->channels; i++) {
713 av_freep(&s->decoded[i]);
715 av_freep(&s->bitstream);
720 static void flac_flush(AVCodecContext *avctx)
722 FLACContext *s = avctx->priv_data;
725 s->bitstream_index= 0;
728 AVCodec flac_decoder = {
739 .long_name= NULL_IF_CONFIG_SMALL("FLAC (Free Lossless Audio Codec)"),