opencore/codecs_v2/audio/gsm_amr/amr_nb/dec/src/lsp_avg.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: lsp_avg.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains all the constant definitions and prototype definitions
  40  needed by the lsp_avg.c
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 /*----------------------------------------------------------------------------
  46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  47 ----------------------------------------------------------------------------*/
  48 #ifndef lsp_avg_h
  49 #define lsp_avg_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 EXPCONST          5243               /* 0.16 in Q15 */
  73
  74     /*----------------------------------------------------------------------------
  75     ; EXTERNAL VARIABLES REFERENCES
  76     ; Declare variables used in this module but defined elsewhere
  77     ----------------------------------------------------------------------------*/
  78
  79     /*----------------------------------------------------------------------------
  80     ; SIMPLE TYPEDEF'S
  81     ----------------------------------------------------------------------------*/
  82
  83     /*----------------------------------------------------------------------------
  84     ; ENUMERATED TYPEDEF'S
  85     ----------------------------------------------------------------------------*/
  86
  87     /*----------------------------------------------------------------------------
  88     ; STRUCTURES TYPEDEF'S
  89     ----------------------------------------------------------------------------*/
  90     typedef struct
  91     {
  92         Word16 lsp_meanSave[M];          /* Averaged LSPs saved for efficiency  */
  93     } lsp_avgState;
  94
  95     /*----------------------------------------------------------------------------
  96     ; GLOBAL FUNCTION DEFINITIONS
  97     ; Function Prototype declaration
  98     ----------------------------------------------------------------------------*/
  99
 100     Word16 lsp_avg_reset(
 101         lsp_avgState *state,
 102         const Word16* mean_lsf_5_ptr
 103     );
 104
 105
 106     void lsp_avg(
 107         lsp_avgState *st,     /* i/o : State struct                 Q15 */
 108         Word16 *lsp,          /* i   : LSP vector                   Q15 */
 109         Flag   *pOverflow     /* o   : Flag set when overflow occurs    */
 110     );
 111
 112     /*----------------------------------------------------------------------------
 113     ; END
 114     ----------------------------------------------------------------------------*/
 115 #ifdef __cplusplus
 116 }
 117 #endif
 118
 119 #endif /* _LSP_LSF_H_ */
 120