14f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/* ------------------------------------------------------------------
24f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * Copyright (C) 1998-2009 PacketVideo
34f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber *
44f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * Licensed under the Apache License, Version 2.0 (the "License");
54f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * you may not use this file except in compliance with the License.
64f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * You may obtain a copy of the License at
74f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber *
84f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber *      http://www.apache.org/licenses/LICENSE-2.0
94f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber *
104f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * Unless required by applicable law or agreed to in writing, software
114f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * distributed under the License is distributed on an "AS IS" BASIS,
124f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
134f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * express or implied.
144f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * See the License for the specific language governing permissions
154f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * and limitations under the License.
164f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * -------------------------------------------------------------------
174f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber */
184f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/****************************************************************************************
194f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas HuberPortions of this file are derived from the following 3GPP standard:
204f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
214f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    3GPP TS 26.073
224f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec
234f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    Available from http://www.3gpp.org
244f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
254f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber(C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC)
264f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas HuberPermission to distribute, modify and use this file under the standard license
274f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huberterms listed above has been obtained from the copyright holder.
284f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber****************************************************************************************/
294f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*
304f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------
314f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
324f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
334f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
344f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Filename: /audio/gsm_amr/c/src/include/agc.h
354f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
364f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber     Date: 12/07/2001
374f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
384f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------
394f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber REVISION HISTORY
404f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
414f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Removed unneeded sections of the standard template.
424f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber              Updated function prototype for agc() and agc2() to match new
434f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber              interface
444f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
454f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Changed paramter name from "overflow" to "pOverflow" for
464f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber              functions agc() and agc2()
474f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
484f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description:  Replaced "int" and/or "char" with OSCL defined types.
494f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
504f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
514f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Moved _cplusplus #ifdef after Include section.
524f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
534f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description:
544f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
554f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------
564f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber INCLUDE DESCRIPTION
574f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
584f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber      File             : agc.h
594f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber      Purpose          : Scales the postfilter output on a subframe basis
604f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber                       : by automatic control of the subframe gain.
614f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
624f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------
634f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber*/
644f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
654f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#ifndef _AGC_H_
664f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#define _AGC_H_
674f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
684f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*----------------------------------------------------------------------------
694f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; INCLUDES
704f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/
714f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#include "typedef.h"
724f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
734f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*--------------------------------------------------------------------------*/
744f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#ifdef __cplusplus
754f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huberextern "C"
764f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber{
774f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#endif
784f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
794f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
804f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; MACROS
814f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; [Define module specific macros here]
824f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
834f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
844f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
854f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; DEFINES
864f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; [Include all pre-processor statements here.]
874f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
884f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
894f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
904f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; EXTERNAL VARIABLES REFERENCES
914f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; [Declare variables used in this module but defined elsewhere]
924f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
934f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
944f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
954f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; SIMPLE TYPEDEF'S
964f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
974f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
984f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
994f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; ENUMERATED TYPEDEF'S
1004f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
1014f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
1024f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
1034f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; STRUCTURES TYPEDEF'S
1044f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
1054f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    typedef struct
1064f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    {
1074f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Word16 past_gain;
1084f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    } agcState;
1094f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
1104f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
1114f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; GLOBAL FUNCTION DEFINITIONS
1124f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ; [List function prototypes here]
1134f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
1144f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
1154f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;
1164f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;  Function    : agc_reset
1174f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;  Purpose     : Reset of agc (i.e. set state memory to 1.0)
1184f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;  Returns     : 0 on success
1194f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;
1204f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
1214f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    Word16 agc_reset(agcState *st);
1224f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
1234f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
1244f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
1254f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;
1264f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;  Function    : agc
1274f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;  Purpose     : Scales the postfilter output on a subframe basis
1284f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;  Description : sig_out[n] = sig_out[n] * gain[n];
1294f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;                where gain[n] is the gain at the nth sample given by
1304f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;                gain[n] = agc_fac * gain[n-1] + (1 - agc_fac) g_in/g_out
1314f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;                g_in/g_out is the square root of the ratio of energy at
1324f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;                the input and output of the postfilter.
1334f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;
1344f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
1354f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    void agc(
1364f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        agcState *st,      /* i/o : agc state                         */
1374f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Word16 *sig_in,    /* i   : postfilter input signal, (l_trm)  */
1384f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Word16 *sig_out,   /* i/o : postfilter output signal, (l_trm) */
1394f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Word16 agc_fac,    /* i   : AGC factor                        */
1404f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Word16 l_trm,      /* i   : subframe size                     */
1414f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Flag *pOverflow    /* i   : overflow flag                     */
1424f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    );
1434f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
1444f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    /*----------------------------------------------------------------------------
1454f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;
1464f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;  Function:  agc2
1474f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;  Purpose:   Scales the excitation on a subframe basis
1484f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ;
1494f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    ----------------------------------------------------------------------------*/
1504f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    void agc2(
1514f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Word16 *sig_in,    /* i   : postfilter input signal   */
1524f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Word16 *sig_out,   /* i/o : postfilter output signal  */
1534f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Word16 l_trm,      /* i   : subframe size             */
1544f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber        Flag *pOverflow    /* i   : overflow flag             */
1554f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber    );
1564f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
1574f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#ifdef __cplusplus
1584f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber}
1594f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#endif
1604f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
1614f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#endif  /* _AGC_H_ */
1624f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
1634f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber
164