opencore/codecs_v2/audio/gsm_amr/amr_nb/dec/src/ex_ctrl.h

   1 /* ------------------------------------------------------------------
   2  * Copyright (C) 1998-2009 PacketVideo
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  13  * express or implied.
  14  * See the License for the specific language governing permissions
  15  * and limitations under the License.
  16  * -------------------------------------------------------------------
  17  */
  18 /****************************************************************************************
  19 Portions of this file are derived from the following 3GPP standard:
  20
  21     3GPP TS 26.073
  22     ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec
  23     Available from http://www.3gpp.org
  24
  25 (C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC)
  26 Permission to distribute, modify and use this file under the standard license
  27 terms listed above has been obtained from the copyright holder.
  28 ****************************************************************************************/
  29 /*
  30 ------------------------------------------------------------------------------
  31
  32
  33
  34  Filename: ex_ctrl.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39      File             : ex_ctrl.h
  40      Purpose          : Excitation Control module in background noise
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 /*----------------------------------------------------------------------------
  46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  47 ----------------------------------------------------------------------------*/
  48 #ifndef ex_ctrl_h
  49 #define ex_ctrl_h "$Id $"
  50
  51 /*----------------------------------------------------------------------------
  52 ; INCLUDES
  53 ----------------------------------------------------------------------------*/
  54 #include "typedef.h"
  55 #include "cnst.h"
  56
  57 /*--------------------------------------------------------------------------*/
  58 #ifdef __cplusplus
  59 extern "C"
  60 {
  61 #endif
  62
  63     /*----------------------------------------------------------------------------
  64     ; MACROS
  65     ; Define module specific macros here
  66     ----------------------------------------------------------------------------*/
  67
  68     /*----------------------------------------------------------------------------
  69     ; DEFINES
  70     ; Include all pre-processor statements here.
  71     ----------------------------------------------------------------------------*/
  72 #define L_ENERGYHIST 60
  73     /*----------------------------------------------------------------------------
  74     ; EXTERNAL VARIABLES REFERENCES
  75     ; Declare variables used in this module but defined elsewhere
  76     ----------------------------------------------------------------------------*/
  77
  78     /*----------------------------------------------------------------------------
  79     ; SIMPLE TYPEDEF'S
  80     ----------------------------------------------------------------------------*/
  81
  82     /*----------------------------------------------------------------------------
  83     ; ENUMERATED TYPEDEF'S
  84     ----------------------------------------------------------------------------*/
  85
  86     /*----------------------------------------------------------------------------
  87     ; STRUCTURES TYPEDEF'S
  88     ----------------------------------------------------------------------------*/
  89
  90     /*----------------------------------------------------------------------------
  91     ; GLOBAL FUNCTION DEFINITIONS
  92     ; Function Prototype declaration
  93     ----------------------------------------------------------------------------*/
  94     /*
  95      *  Function    : Ex_ctrl
  96      *  Purpose     : Charaterice synthesis speech and detect background noise
  97      *  Returns     : background noise decision; 0 = bgn, 1 = no bgn
  98      */
  99     Word16 Ex_ctrl(Word16 excitation[],    /*i/o: Current subframe excitation   */
 100     Word16 excEnergy,      /* i : Exc. Energy, sqrt(totEx*totEx)*/
 101     Word16 exEnergyHist[], /* i : History of subframe energies  */
 102     Word16 voicedHangover, /* i : # of fr. after last voiced fr.*/
 103     Word16 prevBFI,        /* i : Set i previous BFI            */
 104     Word16 carefulFlag,    /* i : Restrict dymamic in scaling   */
 105     Flag   *pOverflow
 106                   );
 107
 108     /*----------------------------------------------------------------------------
 109     ; END
 110     ----------------------------------------------------------------------------*/
 111 #ifdef __cplusplus
 112 }
 113 #endif
 114
 115 #endif /* _ex_ctrl_h_ */
 116
 117
 118
 119
 120
 121
 122