opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/g_pitch.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: g_pitch.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains all the constant definitions and prototype definitions
  40  needed by the G_pitch() function.
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 #ifndef G_PITCH_H
  46 #define G_PITCH_H
  47
  48 /*----------------------------------------------------------------------------
  49 ; INCLUDES
  50 ----------------------------------------------------------------------------*/
  51 #include "mode.h"
  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     ; Function Prototype declaration
  90     ----------------------------------------------------------------------------*/
  91     Word16 G_pitch(         /* o : Gain of pitch lag saturated to 1.2       */
  92         enum Mode mode,     /* i : AMR mode                                 */
  93         Word16 xn[],        /* i : Pitch target.                            */
  94         Word16 y1[],        /* i : Filtered adaptive codebook.              */
  95         Word16 g_coeff[],   /* i : Correlations need for gain quantization  */
  96         Word16 L_subfr,     /* i : Length of subframe.                      */
  97         Flag   *pOverflow   /* i/o : Overflow flag                          */
  98     );
  99
 100     /*----------------------------------------------------------------------------
 101     ; END
 102     ----------------------------------------------------------------------------*/
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* _G_PITCH_H_ */
 108