frameworks/base/media/libstagefright/codecs/amrnb/enc/src/spstproc.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: /audio/gsm_amr/c/include/spstproc.h
  35
  36      Date: 02/06/2002
  37
  38 ------------------------------------------------------------------------------
  39  REVISION HISTORY
  40
  41  Description: Placed header file in the proper template format.  Added
  42  parameter pOverflow for the basic math ops.
  43
  44  Description:  Replaced "int" and/or "char" with OSCL defined types.
  45
  46  Description: Moved _cplusplus #ifdef after Include section.
  47
  48  Description:
  49
  50 ------------------------------------------------------------------------------
  51  INCLUDE DESCRIPTION
  52
  53  This file contains all the constant definitions and prototype definitions
  54  needed by the file, spstproc.c
  55
  56 ------------------------------------------------------------------------------
  57 */
  58
  59 /*----------------------------------------------------------------------------
  60 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  61 ----------------------------------------------------------------------------*/
  62 #ifndef spstproc_h
  63 #define spstproc_h "$Id $"
  64
  65 /*----------------------------------------------------------------------------
  66 ; INCLUDES
  67 ----------------------------------------------------------------------------*/
  68 #include "typedef.h"
  69 #include "mode.h"
  70
  71 /*--------------------------------------------------------------------------*/
  72 #ifdef __cplusplus
  73 extern "C"
  74 {
  75 #endif
  76
  77     /*----------------------------------------------------------------------------
  78     ; MACROS
  79     ; Define module specific macros here
  80     ----------------------------------------------------------------------------*/
  81
  82     /*----------------------------------------------------------------------------
  83     ; DEFINES
  84     ; Include all pre-processor statements here.
  85     ----------------------------------------------------------------------------*/
  86
  87     /*----------------------------------------------------------------------------
  88     ; EXTERNAL VARIABLES REFERENCES
  89     ; Declare variables used in this module but defined elsewhere
  90     ----------------------------------------------------------------------------*/
  91
  92     /*----------------------------------------------------------------------------
  93     ; SIMPLE TYPEDEF'S
  94     ----------------------------------------------------------------------------*/
  95
  96     /*----------------------------------------------------------------------------
  97     ; ENUMERATED TYPEDEF'S
  98     ----------------------------------------------------------------------------*/
  99
 100     /*----------------------------------------------------------------------------
 101     ; STRUCTURES TYPEDEF'S
 102     ----------------------------------------------------------------------------*/
 103
 104     /*----------------------------------------------------------------------------
 105     ; GLOBAL FUNCTION DEFINITIONS
 106     ; Function Prototype declaration
 107     ----------------------------------------------------------------------------*/
 108
 109     void subframePostProc(
 110         Word16 *speech,   /* i   : speech segment                        */
 111         enum Mode mode,   /* i   : coder mode                            */
 112         Word16 i_subfr,   /* i   : Subframe nr                           */
 113         Word16 gain_pit,  /* i   : Pitch gain                       Q14  */
 114         Word16 gain_code, /* i   : Decoded innovation gain               */
 115         Word16 *Aq,       /* i   : A(z) quantized for the 4 subframes    */
 116         Word16 synth[],   /* i   : Local snthesis                        */
 117         Word16 xn[],      /* i   : Target vector for pitch search        */
 118         Word16 code[],    /* i   : Fixed codebook exitation              */
 119         Word16 y1[],      /* i   : Filtered adaptive exitation           */
 120         Word16 y2[],      /* i   : Filtered fixed codebook excitation    */
 121         Word16 *mem_syn,  /* i/o : memory of synthesis filter            */
 122         Word16 *mem_err,  /* o   : pointer to error signal               */
 123         Word16 *mem_w0,   /* o   : memory of weighting filter            */
 124         Word16 *exc,      /* o   : long term prediction residual         */
 125         Word16 *sharp,    /* o   : pitch sharpening value                */
 126         Flag   *pOverflow
 127     );
 128     /*----------------------------------------------------------------------------
 129     ; END
 130     ----------------------------------------------------------------------------*/
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif /* spstproc_h */
 136