opencore/codecs_v2/audio/gsm_amr/amr_nb/dec/src/preemph.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  Filename: preemph.h
  33
  34 ------------------------------------------------------------------------------
  35  INCLUDE DESCRIPTION
  36
  37  This file contains all the constant definitions and prototype definitions
  38  needed by the file, preemph.c
  39
  40 ------------------------------------------------------------------------------
  41 */
  42
  43 /*----------------------------------------------------------------------------
  44 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  45 ----------------------------------------------------------------------------*/
  46 #ifndef preemph_h
  47 #define preemph_h "$Id $"
  48
  49
  50 /*----------------------------------------------------------------------------
  51 ; INCLUDES
  52 ----------------------------------------------------------------------------*/
  53
  54 #include "typedef.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 mem_pre;          /* filter state */
  91     } preemphasisState;
  92
  93     /*----------------------------------------------------------------------------
  94     ; GLOBAL FUNCTION DEFINITIONS
  95     ; Function Prototype declaration
  96     ----------------------------------------------------------------------------*/
  97
  98     Word16 preemphasis_reset(preemphasisState *st);
  99     /* reset of preemphasis filter (i.e. set state memory to zero)
 100        returns 0 on success
 101      */
 102     void preemphasis_exit(preemphasisState **st);
 103     /* de-initialize preemphasis filter (i.e. free status struct)
 104        stores NULL in *st
 105      */
 106
 107     void preemphasis(
 108         preemphasisState *st, /* (i/o): preemphasis filter state                */
 109         Word16 *signal,    /* (i/o): input signal overwritten by the output     */
 110         Word16 g,          /* (i)  : preemphasis coefficient                    */
 111         Word16 L,          /* (i)  : size of filtering                          */
 112         Flag   *pOverflow  /* (o)  : overflow indicator                         */
 113     );
 114
 115     /*----------------------------------------------------------------------------
 116     ; END
 117     ----------------------------------------------------------------------------*/
 118 #ifdef __cplusplus
 119 }
 120 #endif
 121
 122 #endif /* preemph_H_ */
 123
 124