cannam@85: /*
cannam@85:  * libmad - MPEG audio decoder library
cannam@85:  * Copyright (C) 2000-2004 Underbit Technologies, Inc.
cannam@85:  *
cannam@85:  * This program is free software; you can redistribute it and/or modify
cannam@85:  * it under the terms of the GNU General Public License as published by
cannam@85:  * the Free Software Foundation; either version 2 of the License, or
cannam@85:  * (at your option) any later version.
cannam@85:  *
cannam@85:  * This program is distributed in the hope that it will be useful,
cannam@85:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@85:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@85:  * GNU General Public License for more details.
cannam@85:  *
cannam@85:  * You should have received a copy of the GNU General Public License
cannam@85:  * along with this program; if not, write to the Free Software
cannam@85:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
cannam@85:  *
cannam@85:  * $Id: frame.c,v 1.29 2004/02/04 22:59:19 rob Exp $
cannam@85:  */
cannam@85: 
cannam@85: # ifdef HAVE_CONFIG_H
cannam@85: #  include "config.h"
cannam@85: # endif
cannam@85: 
cannam@85: # include "global.h"
cannam@85: 
cannam@85: # include <stdlib.h>
cannam@85: 
cannam@85: # include "bit.h"
cannam@85: # include "stream.h"
cannam@85: # include "frame.h"
cannam@85: # include "timer.h"
cannam@85: # include "layer12.h"
cannam@85: # include "layer3.h"
cannam@85: 
cannam@85: static
cannam@85: unsigned long const bitrate_table[5][15] = {
cannam@85:   /* MPEG-1 */
cannam@85:   { 0,  32000,  64000,  96000, 128000, 160000, 192000, 224000,  /* Layer I   */
cannam@85:        256000, 288000, 320000, 352000, 384000, 416000, 448000 },
cannam@85:   { 0,  32000,  48000,  56000,  64000,  80000,  96000, 112000,  /* Layer II  */
cannam@85:        128000, 160000, 192000, 224000, 256000, 320000, 384000 },
cannam@85:   { 0,  32000,  40000,  48000,  56000,  64000,  80000,  96000,  /* Layer III */
cannam@85:        112000, 128000, 160000, 192000, 224000, 256000, 320000 },
cannam@85: 
cannam@85:   /* MPEG-2 LSF */
cannam@85:   { 0,  32000,  48000,  56000,  64000,  80000,  96000, 112000,  /* Layer I   */
cannam@85:        128000, 144000, 160000, 176000, 192000, 224000, 256000 },
cannam@85:   { 0,   8000,  16000,  24000,  32000,  40000,  48000,  56000,  /* Layers    */
cannam@85:         64000,  80000,  96000, 112000, 128000, 144000, 160000 } /* II & III  */
cannam@85: };
cannam@85: 
cannam@85: static
cannam@85: unsigned int const samplerate_table[3] = { 44100, 48000, 32000 };
cannam@85: 
cannam@85: static
cannam@85: int (*const decoder_table[3])(struct mad_stream *, struct mad_frame *) = {
cannam@85:   mad_layer_I,
cannam@85:   mad_layer_II,
cannam@85:   mad_layer_III
cannam@85: };
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	header->init()
cannam@85:  * DESCRIPTION:	initialize header struct
cannam@85:  */
cannam@85: void mad_header_init(struct mad_header *header)
cannam@85: {
cannam@85:   header->layer          = 0;
cannam@85:   header->mode           = 0;
cannam@85:   header->mode_extension = 0;
cannam@85:   header->emphasis       = 0;
cannam@85: 
cannam@85:   header->bitrate        = 0;
cannam@85:   header->samplerate     = 0;
cannam@85: 
cannam@85:   header->crc_check      = 0;
cannam@85:   header->crc_target     = 0;
cannam@85: 
cannam@85:   header->flags          = 0;
cannam@85:   header->private_bits   = 0;
cannam@85: 
cannam@85:   header->duration       = mad_timer_zero;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	frame->init()
cannam@85:  * DESCRIPTION:	initialize frame struct
cannam@85:  */
cannam@85: void mad_frame_init(struct mad_frame *frame)
cannam@85: {
cannam@85:   mad_header_init(&frame->header);
cannam@85: 
cannam@85:   frame->options = 0;
cannam@85: 
cannam@85:   frame->overlap = 0;
cannam@85:   mad_frame_mute(frame);
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	frame->finish()
cannam@85:  * DESCRIPTION:	deallocate any dynamic memory associated with frame
cannam@85:  */
cannam@85: void mad_frame_finish(struct mad_frame *frame)
cannam@85: {
cannam@85:   mad_header_finish(&frame->header);
cannam@85: 
cannam@85:   if (frame->overlap) {
cannam@85:     free(frame->overlap);
cannam@85:     frame->overlap = 0;
cannam@85:   }
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	decode_header()
cannam@85:  * DESCRIPTION:	read header data and following CRC word
cannam@85:  */
cannam@85: static
cannam@85: int decode_header(struct mad_header *header, struct mad_stream *stream)
cannam@85: {
cannam@85:   unsigned int index;
cannam@85: 
cannam@85:   header->flags        = 0;
cannam@85:   header->private_bits = 0;
cannam@85: 
cannam@85:   /* header() */
cannam@85: 
cannam@85:   /* syncword */
cannam@85:   mad_bit_skip(&stream->ptr, 11);
cannam@85: 
cannam@85:   /* MPEG 2.5 indicator (really part of syncword) */
cannam@85:   if (mad_bit_read(&stream->ptr, 1) == 0)
cannam@85:     header->flags |= MAD_FLAG_MPEG_2_5_EXT;
cannam@85: 
cannam@85:   /* ID */
cannam@85:   if (mad_bit_read(&stream->ptr, 1) == 0)
cannam@85:     header->flags |= MAD_FLAG_LSF_EXT;
cannam@85:   else if (header->flags & MAD_FLAG_MPEG_2_5_EXT) {
cannam@85:     stream->error = MAD_ERROR_LOSTSYNC;
cannam@85:     return -1;
cannam@85:   }
cannam@85: 
cannam@85:   /* layer */
cannam@85:   header->layer = 4 - mad_bit_read(&stream->ptr, 2);
cannam@85: 
cannam@85:   if (header->layer == 4) {
cannam@85:     stream->error = MAD_ERROR_BADLAYER;
cannam@85:     return -1;
cannam@85:   }
cannam@85: 
cannam@85:   /* protection_bit */
cannam@85:   if (mad_bit_read(&stream->ptr, 1) == 0) {
cannam@85:     header->flags    |= MAD_FLAG_PROTECTION;
cannam@85:     header->crc_check = mad_bit_crc(stream->ptr, 16, 0xffff);
cannam@85:   }
cannam@85: 
cannam@85:   /* bitrate_index */
cannam@85:   index = mad_bit_read(&stream->ptr, 4);
cannam@85: 
cannam@85:   if (index == 15) {
cannam@85:     stream->error = MAD_ERROR_BADBITRATE;
cannam@85:     return -1;
cannam@85:   }
cannam@85: 
cannam@85:   if (header->flags & MAD_FLAG_LSF_EXT)
cannam@85:     header->bitrate = bitrate_table[3 + (header->layer >> 1)][index];
cannam@85:   else
cannam@85:     header->bitrate = bitrate_table[header->layer - 1][index];
cannam@85: 
cannam@85:   /* sampling_frequency */
cannam@85:   index = mad_bit_read(&stream->ptr, 2);
cannam@85: 
cannam@85:   if (index == 3) {
cannam@85:     stream->error = MAD_ERROR_BADSAMPLERATE;
cannam@85:     return -1;
cannam@85:   }
cannam@85: 
cannam@85:   header->samplerate = samplerate_table[index];
cannam@85: 
cannam@85:   if (header->flags & MAD_FLAG_LSF_EXT) {
cannam@85:     header->samplerate /= 2;
cannam@85: 
cannam@85:     if (header->flags & MAD_FLAG_MPEG_2_5_EXT)
cannam@85:       header->samplerate /= 2;
cannam@85:   }
cannam@85: 
cannam@85:   /* padding_bit */
cannam@85:   if (mad_bit_read(&stream->ptr, 1))
cannam@85:     header->flags |= MAD_FLAG_PADDING;
cannam@85: 
cannam@85:   /* private_bit */
cannam@85:   if (mad_bit_read(&stream->ptr, 1))
cannam@85:     header->private_bits |= MAD_PRIVATE_HEADER;
cannam@85: 
cannam@85:   /* mode */
cannam@85:   header->mode = 3 - mad_bit_read(&stream->ptr, 2);
cannam@85: 
cannam@85:   /* mode_extension */
cannam@85:   header->mode_extension = mad_bit_read(&stream->ptr, 2);
cannam@85: 
cannam@85:   /* copyright */
cannam@85:   if (mad_bit_read(&stream->ptr, 1))
cannam@85:     header->flags |= MAD_FLAG_COPYRIGHT;
cannam@85: 
cannam@85:   /* original/copy */
cannam@85:   if (mad_bit_read(&stream->ptr, 1))
cannam@85:     header->flags |= MAD_FLAG_ORIGINAL;
cannam@85: 
cannam@85:   /* emphasis */
cannam@85:   header->emphasis = mad_bit_read(&stream->ptr, 2);
cannam@85: 
cannam@85: # if defined(OPT_STRICT)
cannam@85:   /*
cannam@85:    * ISO/IEC 11172-3 says this is a reserved emphasis value, but
cannam@85:    * streams exist which use it anyway. Since the value is not important
cannam@85:    * to the decoder proper, we allow it unless OPT_STRICT is defined.
cannam@85:    */
cannam@85:   if (header->emphasis == MAD_EMPHASIS_RESERVED) {
cannam@85:     stream->error = MAD_ERROR_BADEMPHASIS;
cannam@85:     return -1;
cannam@85:   }
cannam@85: # endif
cannam@85: 
cannam@85:   /* error_check() */
cannam@85: 
cannam@85:   /* crc_check */
cannam@85:   if (header->flags & MAD_FLAG_PROTECTION)
cannam@85:     header->crc_target = mad_bit_read(&stream->ptr, 16);
cannam@85: 
cannam@85:   return 0;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	free_bitrate()
cannam@85:  * DESCRIPTION:	attempt to discover the bitstream's free bitrate
cannam@85:  */
cannam@85: static
cannam@85: int free_bitrate(struct mad_stream *stream, struct mad_header const *header)
cannam@85: {
cannam@85:   struct mad_bitptr keep_ptr;
cannam@85:   unsigned long rate = 0;
cannam@85:   unsigned int pad_slot, slots_per_frame;
cannam@85:   unsigned char const *ptr = 0;
cannam@85: 
cannam@85:   keep_ptr = stream->ptr;
cannam@85: 
cannam@85:   pad_slot = (header->flags & MAD_FLAG_PADDING) ? 1 : 0;
cannam@85:   slots_per_frame = (header->layer == MAD_LAYER_III &&
cannam@85: 		     (header->flags & MAD_FLAG_LSF_EXT)) ? 72 : 144;
cannam@85: 
cannam@85:   while (mad_stream_sync(stream) == 0) {
cannam@85:     struct mad_stream peek_stream;
cannam@85:     struct mad_header peek_header;
cannam@85: 
cannam@85:     peek_stream = *stream;
cannam@85:     peek_header = *header;
cannam@85: 
cannam@85:     if (decode_header(&peek_header, &peek_stream) == 0 &&
cannam@85: 	peek_header.layer == header->layer &&
cannam@85: 	peek_header.samplerate == header->samplerate) {
cannam@85:       unsigned int N;
cannam@85: 
cannam@85:       ptr = mad_bit_nextbyte(&stream->ptr);
cannam@85: 
cannam@85:       N = ptr - stream->this_frame;
cannam@85: 
cannam@85:       if (header->layer == MAD_LAYER_I) {
cannam@85: 	rate = (unsigned long) header->samplerate *
cannam@85: 	  (N - 4 * pad_slot + 4) / 48 / 1000;
cannam@85:       }
cannam@85:       else {
cannam@85: 	rate = (unsigned long) header->samplerate *
cannam@85: 	  (N - pad_slot + 1) / slots_per_frame / 1000;
cannam@85:       }
cannam@85: 
cannam@85:       if (rate >= 8)
cannam@85: 	break;
cannam@85:     }
cannam@85: 
cannam@85:     mad_bit_skip(&stream->ptr, 8);
cannam@85:   }
cannam@85: 
cannam@85:   stream->ptr = keep_ptr;
cannam@85: 
cannam@85:   if (rate < 8 || (header->layer == MAD_LAYER_III && rate > 640)) {
cannam@85:     stream->error = MAD_ERROR_LOSTSYNC;
cannam@85:     return -1;
cannam@85:   }
cannam@85: 
cannam@85:   stream->freerate = rate * 1000;
cannam@85: 
cannam@85:   return 0;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	header->decode()
cannam@85:  * DESCRIPTION:	read the next frame header from the stream
cannam@85:  */
cannam@85: int mad_header_decode(struct mad_header *header, struct mad_stream *stream)
cannam@85: {
cannam@85:   register unsigned char const *ptr, *end;
cannam@85:   unsigned int pad_slot, N;
cannam@85: 
cannam@85:   ptr = stream->next_frame;
cannam@85:   end = stream->bufend;
cannam@85: 
cannam@85:   if (ptr == 0) {
cannam@85:     stream->error = MAD_ERROR_BUFPTR;
cannam@85:     goto fail;
cannam@85:   }
cannam@85: 
cannam@85:   /* stream skip */
cannam@85:   if (stream->skiplen) {
cannam@85:     if (!stream->sync)
cannam@85:       ptr = stream->this_frame;
cannam@85: 
cannam@85:     if (end - ptr < stream->skiplen) {
cannam@85:       stream->skiplen   -= end - ptr;
cannam@85:       stream->next_frame = end;
cannam@85: 
cannam@85:       stream->error = MAD_ERROR_BUFLEN;
cannam@85:       goto fail;
cannam@85:     }
cannam@85: 
cannam@85:     ptr += stream->skiplen;
cannam@85:     stream->skiplen = 0;
cannam@85: 
cannam@85:     stream->sync = 1;
cannam@85:   }
cannam@85: 
cannam@85:  sync:
cannam@85:   /* synchronize */
cannam@85:   if (stream->sync) {
cannam@85:     if (end - ptr < MAD_BUFFER_GUARD) {
cannam@85:       stream->next_frame = ptr;
cannam@85: 
cannam@85:       stream->error = MAD_ERROR_BUFLEN;
cannam@85:       goto fail;
cannam@85:     }
cannam@85:     else if (!(ptr[0] == 0xff && (ptr[1] & 0xe0) == 0xe0)) {
cannam@85:       /* mark point where frame sync word was expected */
cannam@85:       stream->this_frame = ptr;
cannam@85:       stream->next_frame = ptr + 1;
cannam@85: 
cannam@85:       stream->error = MAD_ERROR_LOSTSYNC;
cannam@85:       goto fail;
cannam@85:     }
cannam@85:   }
cannam@85:   else {
cannam@85:     mad_bit_init(&stream->ptr, ptr);
cannam@85: 
cannam@85:     if (mad_stream_sync(stream) == -1) {
cannam@85:       if (end - stream->next_frame >= MAD_BUFFER_GUARD)
cannam@85: 	stream->next_frame = end - MAD_BUFFER_GUARD;
cannam@85: 
cannam@85:       stream->error = MAD_ERROR_BUFLEN;
cannam@85:       goto fail;
cannam@85:     }
cannam@85: 
cannam@85:     ptr = mad_bit_nextbyte(&stream->ptr);
cannam@85:   }
cannam@85: 
cannam@85:   /* begin processing */
cannam@85:   stream->this_frame = ptr;
cannam@85:   stream->next_frame = ptr + 1;  /* possibly bogus sync word */
cannam@85: 
cannam@85:   mad_bit_init(&stream->ptr, stream->this_frame);
cannam@85: 
cannam@85:   if (decode_header(header, stream) == -1)
cannam@85:     goto fail;
cannam@85: 
cannam@85:   /* calculate frame duration */
cannam@85:   mad_timer_set(&header->duration, 0,
cannam@85: 		32 * MAD_NSBSAMPLES(header), header->samplerate);
cannam@85: 
cannam@85:   /* calculate free bit rate */
cannam@85:   if (header->bitrate == 0) {
cannam@85:     if ((stream->freerate == 0 || !stream->sync ||
cannam@85: 	 (header->layer == MAD_LAYER_III && stream->freerate > 640000)) &&
cannam@85: 	free_bitrate(stream, header) == -1)
cannam@85:       goto fail;
cannam@85: 
cannam@85:     header->bitrate = stream->freerate;
cannam@85:     header->flags  |= MAD_FLAG_FREEFORMAT;
cannam@85:   }
cannam@85: 
cannam@85:   /* calculate beginning of next frame */
cannam@85:   pad_slot = (header->flags & MAD_FLAG_PADDING) ? 1 : 0;
cannam@85: 
cannam@85:   if (header->layer == MAD_LAYER_I)
cannam@85:     N = ((12 * header->bitrate / header->samplerate) + pad_slot) * 4;
cannam@85:   else {
cannam@85:     unsigned int slots_per_frame;
cannam@85: 
cannam@85:     slots_per_frame = (header->layer == MAD_LAYER_III &&
cannam@85: 		       (header->flags & MAD_FLAG_LSF_EXT)) ? 72 : 144;
cannam@85: 
cannam@85:     N = (slots_per_frame * header->bitrate / header->samplerate) + pad_slot;
cannam@85:   }
cannam@85: 
cannam@85:   /* verify there is enough data left in buffer to decode this frame */
cannam@85:   if (N + MAD_BUFFER_GUARD > end - stream->this_frame) {
cannam@85:     stream->next_frame = stream->this_frame;
cannam@85: 
cannam@85:     stream->error = MAD_ERROR_BUFLEN;
cannam@85:     goto fail;
cannam@85:   }
cannam@85: 
cannam@85:   stream->next_frame = stream->this_frame + N;
cannam@85: 
cannam@85:   if (!stream->sync) {
cannam@85:     /* check that a valid frame header follows this frame */
cannam@85: 
cannam@85:     ptr = stream->next_frame;
cannam@85:     if (!(ptr[0] == 0xff && (ptr[1] & 0xe0) == 0xe0)) {
cannam@85:       ptr = stream->next_frame = stream->this_frame + 1;
cannam@85:       goto sync;
cannam@85:     }
cannam@85: 
cannam@85:     stream->sync = 1;
cannam@85:   }
cannam@85: 
cannam@85:   header->flags |= MAD_FLAG_INCOMPLETE;
cannam@85: 
cannam@85:   return 0;
cannam@85: 
cannam@85:  fail:
cannam@85:   stream->sync = 0;
cannam@85: 
cannam@85:   return -1;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	frame->decode()
cannam@85:  * DESCRIPTION:	decode a single frame from a bitstream
cannam@85:  */
cannam@85: int mad_frame_decode(struct mad_frame *frame, struct mad_stream *stream)
cannam@85: {
cannam@85:   frame->options = stream->options;
cannam@85: 
cannam@85:   /* header() */
cannam@85:   /* error_check() */
cannam@85: 
cannam@85:   if (!(frame->header.flags & MAD_FLAG_INCOMPLETE) &&
cannam@85:       mad_header_decode(&frame->header, stream) == -1)
cannam@85:     goto fail;
cannam@85: 
cannam@85:   /* audio_data() */
cannam@85: 
cannam@85:   frame->header.flags &= ~MAD_FLAG_INCOMPLETE;
cannam@85: 
cannam@85:   if (decoder_table[frame->header.layer - 1](stream, frame) == -1) {
cannam@85:     if (!MAD_RECOVERABLE(stream->error))
cannam@85:       stream->next_frame = stream->this_frame;
cannam@85: 
cannam@85:     goto fail;
cannam@85:   }
cannam@85: 
cannam@85:   /* ancillary_data() */
cannam@85: 
cannam@85:   if (frame->header.layer != MAD_LAYER_III) {
cannam@85:     struct mad_bitptr next_frame;
cannam@85: 
cannam@85:     mad_bit_init(&next_frame, stream->next_frame);
cannam@85: 
cannam@85:     stream->anc_ptr    = stream->ptr;
cannam@85:     stream->anc_bitlen = mad_bit_length(&stream->ptr, &next_frame);
cannam@85: 
cannam@85:     mad_bit_finish(&next_frame);
cannam@85:   }
cannam@85: 
cannam@85:   return 0;
cannam@85: 
cannam@85:  fail:
cannam@85:   stream->anc_bitlen = 0;
cannam@85:   return -1;
cannam@85: }
cannam@85: 
cannam@85: /*
cannam@85:  * NAME:	frame->mute()
cannam@85:  * DESCRIPTION:	zero all subband values so the frame becomes silent
cannam@85:  */
cannam@85: void mad_frame_mute(struct mad_frame *frame)
cannam@85: {
cannam@85:   unsigned int s, sb;
cannam@85: 
cannam@85:   for (s = 0; s < 36; ++s) {
cannam@85:     for (sb = 0; sb < 32; ++sb) {
cannam@85:       frame->sbsample[0][s][sb] =
cannam@85:       frame->sbsample[1][s][sb] = 0;
cannam@85:     }
cannam@85:   }
cannam@85: 
cannam@85:   if (frame->overlap) {
cannam@85:     for (s = 0; s < 18; ++s) {
cannam@85:       for (sb = 0; sb < 32; ++sb) {
cannam@85: 	(*frame->overlap)[0][sb][s] =
cannam@85: 	(*frame->overlap)[1][sb][s] = 0;
cannam@85:       }
cannam@85:     }
cannam@85:   }
cannam@85: }