opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/hp_max.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: hp_max.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39        File             : hp_max.h
  40        Purpose          : Find the maximum correlation of scal_sig[] in a given
  41                           delay range.
  42
  43 ------------------------------------------------------------------------------
  44 */
  45
  46 #ifndef HP_MAX_H
  47 #define HP_MAX_H  "$Id $"
  48
  49 /*----------------------------------------------------------------------------
  50 ; INCLUDES
  51 ----------------------------------------------------------------------------*/
  52 #include "typedef.h"
  53
  54 /*--------------------------------------------------------------------------*/
  55 #ifdef __cplusplus
  56 extern "C"
  57 {
  58 #endif
  59
  60     /*----------------------------------------------------------------------------
  61     ; MACROS
  62     ; [Define module specific macros here]
  63     ----------------------------------------------------------------------------*/
  64
  65     /*----------------------------------------------------------------------------
  66     ; DEFINES
  67     ; [Include all pre-processor statements here.]
  68     ----------------------------------------------------------------------------*/
  69
  70     /*----------------------------------------------------------------------------
  71     ; EXTERNAL VARIABLES REFERENCES
  72     ; [Declare variables used in this module but defined elsewhere]
  73     ----------------------------------------------------------------------------*/
  74
  75     /*----------------------------------------------------------------------------
  76     ; SIMPLE TYPEDEF'S
  77     ----------------------------------------------------------------------------*/
  78
  79     /*----------------------------------------------------------------------------
  80     ; ENUMERATED TYPEDEF'S
  81     ----------------------------------------------------------------------------*/
  82
  83     /*----------------------------------------------------------------------------
  84     ; STRUCTURES TYPEDEF'S
  85     ----------------------------------------------------------------------------*/
  86
  87     /*----------------------------------------------------------------------------
  88     ; GLOBAL FUNCTION DEFINITIONS
  89     ; [List function prototypes here]
  90     ----------------------------------------------------------------------------*/
  91     Word16 hp_max(
  92         Word32 corr[],      /* i   : correlation vector.                      */
  93         Word16 scal_sig[],  /* i   : scaled signal.                           */
  94         Word16 L_frame,     /* i   : length of frame to compute pitch         */
  95         Word16 lag_max,     /* i   : maximum lag                              */
  96         Word16 lag_min,     /* i   : minimum lag                              */
  97         Word16 *cor_hp_max, /* o   : max high-pass filtered norm. correlation */
  98         Flag   *pOverflow   /* i/o : overflow Flag                            */
  99     );
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 #endif  /* _HP_MAX_H_ */
 106
 107