/* ------------------------------------------------------------------ * Copyright (C) 1998-2009 PacketVideo * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. * See the License for the specific language governing permissions * and limitations under the License. * ------------------------------------------------------------------- */ /**************************************************************************************** Portions of this file are derived from the following 3GPP standard: 3GPP TS 26.073 ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec Available from http://www.3gpp.org (C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC) Permission to distribute, modify and use this file under the standard license terms listed above has been obtained from the copyright holder. ****************************************************************************************/ /* ------------------------------------------------------------------------------ Pathname: ./audio/gsm-amr/c/src/sp_dec.c Functions: GSMInitDecode Speech_Decode_Frame_reset GSMDecodeFrameExit GSMFrameDecode Date: 08/03/2001 ------------------------------------------------------------------------------ REVISION HISTORY Description: Add PV coding template. Filled out template sections and reformatted code to follow C coding standard. Removed code that handles SID in GSMFrameDecode. Description: Made the following changes per comments from Phase 2/3 review: 1. Updated to more recent PV C coding template. 2. Took out all the tabs in the file and replaced with spaces. 3. Deleted bit_offset from input list of GSMFrameDecode. Description: Changing several variables passed into these functions of type Speech_Decode_FrameState to type void. Description: Cleaning up brackets and line spacing for statements with brackets as per a review comments. Description: Synchronized file with UMTS version 3.2.0. Removed unnecessary include files. Description: Removed all references to malloc/free, except for the top-level malloc in GSMInitDecode, and corresponding free in GSMDecodeFrameExit. Also, modified function calls throughout to reflect the fact that the members of the structure Decoder_amrState are no longer pointers to be set via malloc, but full-blown structures. (Changes of the type D_plsfState *lsfState to D_plsfState lsfState) Description: Created overflow and pass the variable into the decoder. Description: Changed inititlaization of the pointer to overflow flag. Removed code related to MOPS counter. Description: Replaced OSCL mem type functions and eliminated include files that now are chosen by OSCL definitions Description: Replaced "int" and/or "char" with defined types. Added proper casting (Word32) to some left shifting operations Description: ------------------------------------------------------------------------------ MODULE DESCRIPTION This file contains the functions that initialize, invoke, reset, and exit the GSM AMR decoder. ------------------------------------------------------------------------------ */ /*---------------------------------------------------------------------------- ; INCLUDES ----------------------------------------------------------------------------*/ #include #include "sp_dec.h" #include "typedef.h" #include "cnst.h" #include "dec_amr.h" #include "pstfilt.h" #include "bits2prm.h" #include "mode.h" #include "post_pro.h" /*---------------------------------------------------------------------------- ; MACROS ; Define module specific macros here ----------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------- ; DEFINES ; Include all pre-processor statements here. Include conditional ; compile variables also. ----------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------- ; LOCAL FUNCTION DEFINITIONS ; Function Prototype declaration ----------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------- ; LOCAL VARIABLE DEFINITIONS ; Variable declaration - defined here and used outside this module ----------------------------------------------------------------------------*/ /* ------------------------------------------------------------------------------ FUNCTION NAME: GSMInitDecode ------------------------------------------------------------------------------ INPUT AND OUTPUT DEFINITIONS Inputs: state = pointer to an array of pointers to structures of type Speech_Decode_FrameState no_hp_post_MR122 = flag to turn off high-pass post filter for 12.2 kbps mode (Flag) id = pointer to an array whose contents are of type char Outputs: decoder_amrState field of the structure pointed to by the pointer pointed to by state is set to NULL post_state field of the structure pointed to by the pointer pointed to by state is set to NULL postHP_state field of the structure pointed to by the pointer pointed to by state is set to NULL no_hp_post_MR122 field of the structure pointed to by the pointer pointed to by state is set to the input no_hp_post_MR122 Returns: return_value = set to zero, if initialization was successful; -1, otherwise (int) Global Variables Used: None Local Variables Needed: None ------------------------------------------------------------------------------ FUNCTION DESCRIPTION This function allocates memory for filter structure and initializes state memory used by the GSM AMR decoder. ------------------------------------------------------------------------------ REQUIREMENTS None ------------------------------------------------------------------------------ REFERENCES sp_dec.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 ------------------------------------------------------------------------------ PSEUDO-CODE Note: Original function name of Speech_Decode_Frame_init was changed to GSMInitDecode in the Code section. int Speech_Decode_Frame_init (Speech_Decode_FrameState **state, char *id) { Speech_Decode_FrameState* s; if (state == (Speech_Decode_FrameState **) NULL){ fprintf(stderr, "Speech_Decode_Frame_init: invalid parameter\n"); return -1; } *state = NULL; // allocate memory if ((s= (Speech_Decode_FrameState *) malloc(sizeof(Speech_Decode_FrameState))) == NULL) { fprintf(stderr, "Speech_Decode_Frame_init: can not malloc state " "structure\n"); return -1; } s->decoder_amrState = NULL; s->post_state = NULL; s->postHP_state = NULL; if (Decoder_amr_init(&s->decoder_amrState) || Post_Filter_init(&s->post_state) || Post_Process_init(&s->postHP_state) ) { Speech_Decode_Frame_exit(&s); return -1; } s->complexityCounter = getCounterId(id); Speech_Decode_Frame_reset(s); *state = s; return 0; } ------------------------------------------------------------------------------ RESOURCES USED [optional] When the code is written for a specific target processor the the resources used should be documented below. HEAP MEMORY USED: x bytes STACK MEMORY USED: x bytes CLOCK CYCLES: (cycle count equation for this function) + (variable used to represent cycle count for each subroutine called) where: (cycle count variable) = cycle count for [subroutine name] ------------------------------------------------------------------------------ CAUTION [optional] [State any special notes, constraints or cautions for users of this function] ------------------------------------------------------------------------------ */ Word16 GSMInitDecode(void **state_data, Word8 * id) { Speech_Decode_FrameState* s; OSCL_UNUSED_ARG(id); if (state_data == NULL) { /* fprintf(stderr, "Speech_Decode_Frame_init: invalid parameter\n"); */ return (-1); } *state_data = NULL; /* allocate memory */ if ((s = (Speech_Decode_FrameState *) malloc(sizeof(Speech_Decode_FrameState))) == NULL) { /* fprintf(stderr, "Speech_Decode_Frame_init: can not malloc state " "structure\n"); */ return (-1); } if (Decoder_amr_init(&s->decoder_amrState) || Post_Process_reset(&s->postHP_state)) { free(s); return (-1); } Speech_Decode_Frame_reset(s); *state_data = (void *)s; return (0); } /****************************************************************************/ /* ------------------------------------------------------------------------------ FUNCTION NAME: Speech_Decode_Frame_reset ------------------------------------------------------------------------------ INPUT AND OUTPUT DEFINITIONS Inputs: state = pointer to structures of type Speech_Decode_FrameState Outputs: None Returns: return_value = set to zero if reset was successful; -1, otherwise (int) Global Variables Used: None Local Variables Needed: None ------------------------------------------------------------------------------ FUNCTION DESCRIPTION This function resets the state memory used by the GSM AMR decoder. ------------------------------------------------------------------------------ REQUIREMENTS None ------------------------------------------------------------------------------ REFERENCES sp_dec.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 ------------------------------------------------------------------------------ PSEUDO-CODE int Speech_Decode_Frame_reset (Speech_Decode_FrameState *state) { if (state == (Speech_Decode_FrameState *) NULL){ fprintf(stderr, "Speech_Decode_Frame_reset: invalid parameter\n"); return -1; } Decoder_amr_reset(state->decoder_amrState, (enum Mode)0); Post_Filter_reset(state->post_state); Post_Process_reset(state->postHP_state); state->prev_mode = (enum Mode)0; setCounter(state->complexityCounter); Init_WMOPS_counter(); setCounter(0); // set counter to global counter return 0; } ------------------------------------------------------------------------------ RESOURCES USED [optional] When the code is written for a specific target processor the the resources used should be documented below. HEAP MEMORY USED: x bytes STACK MEMORY USED: x bytes CLOCK CYCLES: (cycle count equation for this function) + (variable used to represent cycle count for each subroutine called) where: (cycle count variable) = cycle count for [subroutine name] ------------------------------------------------------------------------------ CAUTION [optional] [State any special notes, constraints or cautions for users of this function] ------------------------------------------------------------------------------ */ Word16 Speech_Decode_Frame_reset(void *state_data) { Speech_Decode_FrameState *state = (Speech_Decode_FrameState *) state_data; if (state_data == NULL) { /* fprintf(stderr, "Speech_Decode_Frame_reset: invalid parameter\n"); */ return (-1); } Decoder_amr_reset(&(state->decoder_amrState), MR475); Post_Filter_reset(&(state->post_state)); Post_Process_reset(&(state->postHP_state)); state->prev_mode = MR475; return (0); } /****************************************************************************/ /* ------------------------------------------------------------------------------ FUNCTION NAME: GSMDecodeFrameExit ------------------------------------------------------------------------------ INPUT AND OUTPUT DEFINITIONS Inputs: state = pointer to an array of pointers to structures of type Speech_Decode_FrameState Outputs: state contents is set to NULL Returns: None Global Variables Used: None Local Variables Needed: None ------------------------------------------------------------------------------ FUNCTION DESCRIPTION This function frees up the memory used for the state memory of the GSM AMR decoder. ------------------------------------------------------------------------------ REQUIREMENTS None ------------------------------------------------------------------------------ REFERENCES sp_dec.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 ------------------------------------------------------------------------------ PSEUDO-CODE Note: The original function name of Speech_Decode_Frame_exit was changed to GSMDecodeFrameExit in the Code section. void Speech_Decode_Frame_exit (Speech_Decode_FrameState **state) { if (state == NULL || *state == NULL) return; Decoder_amr_exit(&(*state)->decoder_amrState); Post_Filter_exit(&(*state)->post_state); Post_Process_exit(&(*state)->postHP_state); setCounter((*state)->complexityCounter); WMOPS_output(0); setCounter(0); // set counter to global counter // deallocate memory free(*state); *state = NULL; return; } ------------------------------------------------------------------------------ RESOURCES USED [optional] When the code is written for a specific target processor the the resources used should be documented below. HEAP MEMORY USED: x bytes STACK MEMORY USED: x bytes CLOCK CYCLES: (cycle count equation for this function) + (variable used to represent cycle count for each subroutine called) where: (cycle count variable) = cycle count for [subroutine name] ------------------------------------------------------------------------------ CAUTION [optional] [State any special notes, constraints or cautions for users of this function] ------------------------------------------------------------------------------ */ void GSMDecodeFrameExit(void **state_data) { Speech_Decode_FrameState **state = (Speech_Decode_FrameState **) state_data; if (state == NULL || *state == NULL) { return; } /* deallocate memory */ free(*state); *state = NULL; return; } /****************************************************************************/ /* ------------------------------------------------------------------------------ FUNCTION NAME: GSMFrameDecode ------------------------------------------------------------------------------ INPUT AND OUTPUT DEFINITIONS Inputs: st = pointer to structures of type Speech_Decode_FrameState mode = GSM AMR codec mode (enum Mode) serial = pointer to the serial bit stream buffer (unsigned char) frame_type = GSM AMR receive frame type (enum RXFrameType) synth = pointer to the output synthesis speech buffer (Word16) Outputs: synth contents are truncated to 13 bits if NO13BIT is not defined, otherwise, its contents are left at 16 bits Returns: return_value = set to zero (int) Global Variables Used: None Local Variables Needed: None ------------------------------------------------------------------------------ FUNCTION DESCRIPTION This function is the entry point to the GSM AMR decoder. The following operations are performed on one received frame: First, the codec parameters are parsed from the buffer pointed to by serial according to frame_type. Then the AMR decoder is invoked via a call to Decoder_amr. Post filtering of the decoded data is done via a call to Post_Filter function. Lastly, the decoded data is post-processed via a call to Post_Process function. If NO13BIT is not defined, the contents of the buffer pointed to by synth is truncated to 13 bits. It remains unchanged otherwise. ------------------------------------------------------------------------------ REQUIREMENTS None ------------------------------------------------------------------------------ REFERENCES sp_dec.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 ------------------------------------------------------------------------------ PSEUDO-CODE Note: The original function name of Speech_Decode_Frame_exit was changed to GSMFrameDecode in the Code section. int Speech_Decode_Frame ( Speech_Decode_FrameState *st, // io: post filter states enum Mode mode, // i : AMR mode Word16 *serial, // i : serial bit stream enum RXFrameType frame_type, // i : Frame type Word16 *synth // o : synthesis speech (postfiltered // output) ) { Word16 parm[MAX_PRM_SIZE + 1]; // Synthesis parameters Word16 Az_dec[AZ_SIZE]; // Decoded Az for post-filter // in 4 subframes #if !defined(NO13BIT) Word16 i; #endif setCounter(st->complexityCounter); Reset_WMOPS_counter (); // reset WMOPS counter for the new frame // Serial to parameters if ((frame_type == RX_SID_BAD) || (frame_type == RX_SID_UPDATE)) { // Override mode to MRDTX Bits2prm (MRDTX, serial, parm); } else { Bits2prm (mode, serial, parm); } // Synthesis Decoder_amr(st->decoder_amrState, mode, parm, frame_type, synth, Az_dec); Post_Filter(st->post_state, mode, synth, Az_dec); // Post-filter // post HP filter, and 15->16 bits Post_Process(st->postHP_state, synth, L_FRAME); #if !defined(NO13BIT) // Truncate to 13 bits for (i = 0; i < L_FRAME; i++) { synth[i] = synth[i] & 0xfff8; } #endif setCounter(0); // set counter to global counter return 0; } ------------------------------------------------------------------------------ RESOURCES USED [optional] When the code is written for a specific target processor the the resources used should be documented below. HEAP MEMORY USED: x bytes STACK MEMORY USED: x bytes CLOCK CYCLES: (cycle count equation for this function) + (variable used to represent cycle count for each subroutine called) where: (cycle count variable) = cycle count for [subroutine name] ------------------------------------------------------------------------------ CAUTION [optional] [State any special notes, constraints or cautions for users of this function] ------------------------------------------------------------------------------ */ void GSMFrameDecode( Speech_Decode_FrameState *st, /* io: post filter states */ enum Mode mode, /* i : AMR mode */ Word16 *serial, /* i : serial bit stream */ enum RXFrameType frame_type, /* i : Frame type */ Word16 *synth) /* o : synthesis speech (postfiltered */ /* output) */ { Word16 parm[MAX_PRM_SIZE + 1]; /* Synthesis parameters */ Word16 Az_dec[AZ_SIZE]; /* Decoded Az for post-filter */ /* in 4 subframes */ Flag *pOverflow = &(st->decoder_amrState.overflow); /* Overflow flag */ #if !defined(NO13BIT) Word16 i; #endif /* Serial to parameters */ if ((frame_type == RX_SID_BAD) || (frame_type == RX_SID_UPDATE)) { /* Override mode to MRDTX */ Bits2prm(MRDTX, serial, parm); } else { Bits2prm(mode, serial, parm); } /* Synthesis */ Decoder_amr( &(st->decoder_amrState), mode, parm, frame_type, synth, Az_dec); /* Post-filter */ Post_Filter( &(st->post_state), mode, synth, Az_dec, pOverflow); /* post HP filter, and 15->16 bits */ Post_Process( &(st->postHP_state), synth, L_FRAME, pOverflow); #if !defined(NO13BIT) /* Truncate to 13 bits */ for (i = 0; i < L_FRAME; i++) { synth[i] = synth[i] & 0xfff8; } #endif return; }