opencore/codecs_v2/audio/gsm_amr/amr_nb/common/include/p_ol_wgh.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  Filename: p_ol_wgh.h
  32
  33 ------------------------------------------------------------------------------
  34  INCLUDE DESCRIPTION
  35
  36        File             : p_ol_wgh.h
  37        Purpose          : Compute the open loop pitch lag with weighting.
  38
  39 ------------------------------------------------------------------------------
  40 */
  41
  42 #ifndef P_OL_WGH_H
  43 #define P_OL_WGH_H
  44
  45 /*----------------------------------------------------------------------------
  46 ; INCLUDES
  47 ----------------------------------------------------------------------------*/
  48 #include "typedef.h"
  49 #include "mode.h"
  50 #include "vad.h"
  51
  52 /*--------------------------------------------------------------------------*/
  53 #ifdef __cplusplus
  54 extern "C"
  55 {
  56 #endif
  57
  58     /*----------------------------------------------------------------------------
  59     ; MACROS
  60     ; [Define module specific macros here]
  61     ----------------------------------------------------------------------------*/
  62
  63     /*----------------------------------------------------------------------------
  64     ; DEFINES
  65     ; [Include all pre-processor statements here.]
  66     ----------------------------------------------------------------------------*/
  67
  68     /*----------------------------------------------------------------------------
  69     ; EXTERNAL VARIABLES REFERENCES
  70     ; [Declare variables used in this module but defined elsewhere]
  71     ----------------------------------------------------------------------------*/
  72     extern const Word16 corrweight[];
  73
  74     /*----------------------------------------------------------------------------
  75     ; SIMPLE TYPEDEF'S
  76     ----------------------------------------------------------------------------*/
  77
  78     /*----------------------------------------------------------------------------
  79     ; ENUMERATED TYPEDEF'S
  80     ----------------------------------------------------------------------------*/
  81
  82     /*----------------------------------------------------------------------------
  83     ; STRUCTURES TYPEDEF'S
  84     ----------------------------------------------------------------------------*/
  85     /* state variable */
  86
  87     typedef struct
  88     {
  89         Word16 old_T0_med;
  90         Word16 ada_w;
  91         Word16 wght_flg;
  92     } pitchOLWghtState;
  93
  94     /*----------------------------------------------------------------------------
  95     ; GLOBAL FUNCTION DEFINITIONS
  96     ; [List function prototypes here]
  97     ----------------------------------------------------------------------------*/
  98     Word16 p_ol_wgh_init(pitchOLWghtState **st);
  99     /* initialize one instance of the pre processing state.
 100        Stores pointer to filter status struct in *st. This pointer has to
 101        be passed to p_ol_wgh in each call.
 102        returns 0 on success
 103      */
 104
 105     Word16 p_ol_wgh_reset(pitchOLWghtState *st);
 106     /* reset of pre processing state (i.e. set state memory to zero)
 107        returns 0 on success
 108      */
 109
 110     void p_ol_wgh_exit(pitchOLWghtState **st);
 111     /* de-initialize pre processing state (i.e. free status struct)
 112        stores NULL in *st
 113      */
 114
 115     Word16 Pitch_ol_wgh(      /* o   : open loop pitch lag                            */
 116         pitchOLWghtState *st, /* i/o : State struct                                   */
 117         vadState *vadSt,      /* i/o : VAD state struct                               */
 118         Word16 signal[],      /* i   : signal used to compute the open loop pitch     */
 119         /*       signal[-pit_max] to signal[-1] should be known */
 120         Word16 pit_min,       /* i   : minimum pitch lag                              */
 121         Word16 pit_max,       /* i   : maximum pitch lag                              */
 122         Word16 L_frame,       /* i   : length of frame to compute pitch               */
 123         Word16 old_lags[],    /* i   : history with old stored Cl lags                */
 124         Word16 ol_gain_flg[], /* i   : OL gain flag                                   */
 125         Word16 idx,           /* i   : index                                          */
 126         Flag dtx,             /* i   : dtx flag; use dtx=1, do not use dtx=0          */
 127         Flag   *pOverflow     /* o   : overflow flag                                  */
 128     );
 129
 130 #ifdef __cplusplus
 131 }
 132 #endif
 133
 134 #endif  /* _P_OL_WGH_H_ */