opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/spreproc.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: spreproc.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains all the constant definitions and prototype definitions
  40  needed by the file, spreproc.c
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 /*----------------------------------------------------------------------------
  46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  47 ----------------------------------------------------------------------------*/
  48 #ifndef spreproc_h
  49 #define spreproc_h "$Id $"
  50
  51 /*----------------------------------------------------------------------------
  52 ; INCLUDES
  53 ----------------------------------------------------------------------------*/
  54 #include "cnst.h"
  55 #include "mode.h"
  56 #include "typedef.h"
  57
  58 /*--------------------------------------------------------------------------*/
  59 #ifdef __cplusplus
  60 extern "C"
  61 {
  62 #endif
  63
  64     /*----------------------------------------------------------------------------
  65     ; MACROS
  66     ; Define module specific macros here
  67     ----------------------------------------------------------------------------*/
  68
  69     /*----------------------------------------------------------------------------
  70     ; DEFINES
  71     ; Include all pre-processor statements here.
  72     ----------------------------------------------------------------------------*/
  73
  74     /*----------------------------------------------------------------------------
  75     ; EXTERNAL VARIABLES REFERENCES
  76     ; Declare variables used in this module but defined elsewhere
  77     ----------------------------------------------------------------------------*/
  78
  79     /*----------------------------------------------------------------------------
  80     ; SIMPLE TYPEDEF'S
  81     ----------------------------------------------------------------------------*/
  82
  83     /*----------------------------------------------------------------------------
  84     ; ENUMERATED TYPEDEF'S
  85     ----------------------------------------------------------------------------*/
  86
  87     /*----------------------------------------------------------------------------
  88     ; STRUCTURES TYPEDEF'S
  89     ----------------------------------------------------------------------------*/
  90
  91     /*----------------------------------------------------------------------------
  92     ; GLOBAL FUNCTION DEFINITIONS
  93     ; Function Prototype declaration
  94     ----------------------------------------------------------------------------*/
  95     void subframePreProc(
  96         enum Mode mode,            /* i  : coder mode                            */
  97         const Word16 gamma1[],     /* i  : spectral exp. factor 1                */
  98         const Word16 gamma1_12k2[],/* i  : spectral exp. factor 1 for EFR        */
  99         const Word16 gamma2[],     /* i  : spectral exp. factor 2                */
 100         Word16 *A,                 /* i  : A(z) unquantized for the 4 subframes  */
 101         Word16 *Aq,                /* i  : A(z)   quantized for the 4 subframes  */
 102         Word16 *speech,            /* i  : speech segment                        */
 103         Word16 *mem_err,           /* i  : pointer to error signal               */
 104         Word16 *mem_w0,            /* i  : memory of weighting filter            */
 105         Word16 *zero,              /* i  : pointer to zero vector                */
 106         Word16 ai_zero[],          /* o  : history of weighted synth. filter     */
 107         Word16 exc[],              /* o  : long term prediction residual         */
 108         Word16 h1[],               /* o  : impulse response                      */
 109         Word16 xn[],               /* o  : target vector for pitch search        */
 110         Word16 res2[],             /* o  : long term prediction residual         */
 111         Word16 error[]             /* o  : error of LPC synthesis filter         */
 112     );
 113
 114     /*----------------------------------------------------------------------------
 115     ; END
 116     ----------------------------------------------------------------------------*/
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif /* spreproc_h */
 122