opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/pitch_fr.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: pitch_fr.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39       File             : pitch_fr.h
  40       Purpose          : Find the pitch period with 1/3 or 1/6 subsample
  41                        : resolution (closed loop).
  42
  43 ------------------------------------------------------------------------------
  44 */
  45
  46 #ifndef _PITCH_FR_H_
  47 #define _PITCH_FR_H_
  48 #define pitch_fr_h "$Id $"
  49
  50 /*----------------------------------------------------------------------------
  51 ; INCLUDES
  52 ----------------------------------------------------------------------------*/
  53 #include "typedef.h"
  54 #include "mode.h"
  55
  56 /*--------------------------------------------------------------------------*/
  57 #ifdef __cplusplus
  58 extern "C"
  59 {
  60 #endif
  61
  62     /*----------------------------------------------------------------------------
  63     ; MACROS
  64     ; [Define module specific macros here]
  65     ----------------------------------------------------------------------------*/
  66
  67     /*----------------------------------------------------------------------------
  68     ; DEFINES
  69     ; [Include all pre-processor statements here.]
  70     ----------------------------------------------------------------------------*/
  71
  72     /*----------------------------------------------------------------------------
  73     ; EXTERNAL VARIABLES REFERENCES
  74     ; [Declare variables used in this module but defined elsewhere]
  75     ----------------------------------------------------------------------------*/
  76
  77     /*----------------------------------------------------------------------------
  78     ; SIMPLE TYPEDEF'S
  79     ----------------------------------------------------------------------------*/
  80
  81     /*----------------------------------------------------------------------------
  82     ; ENUMERATED TYPEDEF'S
  83     ----------------------------------------------------------------------------*/
  84
  85     /*----------------------------------------------------------------------------
  86     ; STRUCTURES TYPEDEF'S
  87     ----------------------------------------------------------------------------*/
  88     typedef struct
  89     {
  90         Word16 T0_prev_subframe;   /* integer pitch lag of previous sub-frame */
  91     } Pitch_frState;
  92
  93     /*----------------------------------------------------------------------------
  94     ; GLOBAL FUNCTION DEFINITIONS
  95     ; [List function prototypes here]
  96     ----------------------------------------------------------------------------*/
  97
  98     Word16 Pitch_fr_init(Pitch_frState **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 Pitch_fr in each call.
 102        returns 0 on success
 103      */
 104
 105     Word16 Pitch_fr_reset(Pitch_frState *st);
 106     /* reset of pre processing state (i.e. set state memory to zero)
 107        returns 0 on success
 108      */
 109
 110     void Pitch_fr_exit(Pitch_frState **st);
 111     /* de-initialize pre processing state (i.e. free status struct)
 112        stores NULL in *st
 113      */
 114
 115     Word16 Pitch_fr(         /* o   : pitch period (integer)                    */
 116         Pitch_frState *st,   /* i/o : State struct                              */
 117         enum Mode mode,      /* i   : codec mode                                */
 118         Word16 T_op[],       /* i   : open loop pitch lags                      */
 119         Word16 exc[],        /* i   : excitation buffer                         */
 120         Word16 xn[],         /* i   : target vector                             */
 121         Word16 h[],          /* i   : impulse response of synthesis and
 122                                   weighting filters                         */
 123         Word16 L_subfr,      /* i   : Length of subframe                        */
 124         Word16 i_subfr,      /* i   : subframe offset                           */
 125         Word16 *pit_frac,    /* o   : pitch period (fractional)                 */
 126         Word16 *resu3,       /* o   : subsample resolution 1/3 (=1) or 1/6 (=0) */
 127         Word16 *ana_index,   /* o   : index of encoding                         */
 128         Flag   *pOverflow
 129     );
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif  /* _PITCH_FR_H_ */
 136
 137