opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/levinson.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: levinson.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39       File             : lag_wind.h
  40       Purpose          : Lag windowing of autocorrelations.
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 #ifndef _LEVINSON_H_
  46 #define _LEVINSON_H_
  47 #define levinson_h "$Id $"
  48
  49 /*----------------------------------------------------------------------------
  50 ; INCLUDES
  51 ----------------------------------------------------------------------------*/
  52 #include "typedef.h"
  53 #include "cnst.h"
  54
  55 /*--------------------------------------------------------------------------*/
  56 #ifdef __cplusplus
  57 extern "C"
  58 {
  59 #endif
  60
  61     /*----------------------------------------------------------------------------
  62     ; MACROS
  63     ; [Define module specific macros here]
  64     ----------------------------------------------------------------------------*/
  65
  66     /*----------------------------------------------------------------------------
  67     ; DEFINES
  68     ; [Include all pre-processor statements here.]
  69     ----------------------------------------------------------------------------*/
  70
  71     /*----------------------------------------------------------------------------
  72     ; EXTERNAL VARIABLES REFERENCES
  73     ; [Declare variables used in this module but defined elsewhere]
  74     ----------------------------------------------------------------------------*/
  75
  76     /*----------------------------------------------------------------------------
  77     ; SIMPLE TYPEDEF'S
  78     ----------------------------------------------------------------------------*/
  79
  80     /*----------------------------------------------------------------------------
  81     ; ENUMERATED TYPEDEF'S
  82     ----------------------------------------------------------------------------*/
  83
  84     /*----------------------------------------------------------------------------
  85     ; STRUCTURES TYPEDEF'S
  86     ----------------------------------------------------------------------------*/
  87     typedef struct
  88     {
  89         Word16 old_A[M + 1];     /* Last A(z) for case of unstable filter */
  90     } LevinsonState;
  91
  92     /*----------------------------------------------------------------------------
  93     ; GLOBAL FUNCTION DEFINITIONS
  94     ; [List function prototypes here]
  95     ----------------------------------------------------------------------------*/
  96     Word16 Levinson_init(LevinsonState **st);
  97     /* initialize one instance of the pre processing state.
  98        Stores pointer to filter status struct in *st. This pointer has to
  99        be passed to Levinson in each call.
 100        returns 0 on success
 101      */
 102
 103     Word16 Levinson_reset(LevinsonState *st);
 104     /* reset of pre processing state (i.e. set state memory to zero)
 105        returns 0 on success
 106      */
 107     void Levinson_exit(LevinsonState **st);
 108     /* de-initialize pre processing state (i.e. free status struct)
 109        stores NULL in *st
 110      */
 111
 112     Word16 Levinson(
 113         LevinsonState *st,
 114         Word16 Rh[],       /* i : Rh[m+1] Vector of autocorrelations (msb) */
 115         Word16 Rl[],       /* i : Rl[m+1] Vector of autocorrelations (lsb) */
 116         Word16 A[],        /* o : A[m]    LPC coefficients  (m = 10)       */
 117         Word16 rc[],        /* o : rc[4]   First 4 reflection coefficients  */
 118         Flag   *pOverflow
 119     );
 120
 121
 122
 123 #ifdef __cplusplus
 124 }
 125 #endif
 126
 127 #endif  /* _LEVINSON_H_ */
 128
 129
 130
 131