opencore/codecs_v2/audio/gsm_amr/amr_nb/dec/src/dec_lag3.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: dec_lag3.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains all the constant definitions and prototype definitions
  40  needed by the dec_lag3.c
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 /*----------------------------------------------------------------------------
  46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  47 ----------------------------------------------------------------------------*/
  48 #ifndef dec_lag3_h
  49 #define dec_lag3_h "$Id $"
  50
  51
  52 /*----------------------------------------------------------------------------
  53 ; INCLUDES
  54 ----------------------------------------------------------------------------*/
  55 #include "typedef.h"
  56
  57 /*--------------------------------------------------------------------------*/
  58 #ifdef __cplusplus
  59 extern "C"
  60 {
  61 #endif
  62
  63     /*----------------------------------------------------------------------------
  64     ; MACROS
  65     ; Define module specific macros here
  66     ----------------------------------------------------------------------------*/
  67
  68     /*----------------------------------------------------------------------------
  69     ; DEFINES
  70     ; Include all pre-processor statements here.
  71     ----------------------------------------------------------------------------*/
  72
  73     /*----------------------------------------------------------------------------
  74     ; EXTERNAL VARIABLES REFERENCES
  75     ; Declare variables used in this module but defined elsewhere
  76     ----------------------------------------------------------------------------*/
  77
  78     /*----------------------------------------------------------------------------
  79     ; SIMPLE TYPEDEF'S
  80     ----------------------------------------------------------------------------*/
  81
  82     /*----------------------------------------------------------------------------
  83     ; ENUMERATED TYPEDEF'S
  84     ----------------------------------------------------------------------------*/
  85
  86     /*----------------------------------------------------------------------------
  87     ; STRUCTURES TYPEDEF'S
  88     ----------------------------------------------------------------------------*/
  89
  90     /*----------------------------------------------------------------------------
  91     ; GLOBAL FUNCTION DEFINITIONS
  92     ; Function Prototype declaration
  93     ----------------------------------------------------------------------------*/
  94
  95     void Dec_lag3(Word16 index,     /* i : received pitch index                 */
  96     Word16 T0_min,    /* i : minimum of search range              */
  97     Word16 T0_max,    /* i : maximum of search range              */
  98     Word16 i_subfr,   /* i : subframe flag                        */
  99     Word16 T0_prev,   /* i : integer pitch delay of last subframe
 100                                        used in 2nd and 4th subframes        */
 101     Word16 * T0,      /* o : integer part of pitch lag            */
 102     Word16 * T0_frac, /* o : fractional part of pitch lag         */
 103     Word16 flag4,     /* i : flag for encoding with 4 bits        */
 104     Flag   * pOverflow  /* o : Flag set when overflow occurs      */
 105                  );
 106
 107     /*----------------------------------------------------------------------------
 108     ; END
 109     ----------------------------------------------------------------------------*/
 110 #ifdef __cplusplus
 111 }
 112 #endif
 113
 114 #endif /* _DEC_LAG_3_H_ */
 115