opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/enc_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: enc_lag3.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39       File             : enc_lag3.h
  40       Purpose          : Encoding of fractional pitch lag with 1/3 resolution.
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 #ifndef _ENC_LAG3_H_
  46 #define _ENC_LAG3_H_
  47 #define enc_lag3_h "$Id $"
  48
  49 /*----------------------------------------------------------------------------
  50 ; INCLUDES
  51 ----------------------------------------------------------------------------*/
  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     typedef struct
  87     {
  88         Word16 past_gain;
  89     } agcState;
  90
  91     /*----------------------------------------------------------------------------
  92     ; GLOBAL FUNCTION DEFINITIONS
  93     ; [List function prototypes here]
  94     ----------------------------------------------------------------------------*/
  95     Word16
  96     Enc_lag3(                /* o  : Return index of encoding     */
  97         Word16 T0,           /* i  : Pitch delay                          */
  98         Word16 T0_frac,      /* i  : Fractional pitch delay               */
  99         Word16 T0_prev,      /* i  : Integer pitch delay of last subframe */
 100         Word16 T0_min,       /* i  : minimum of search range              */
 101         Word16 T0_max,       /* i  : maximum of search range              */
 102         Word16 delta_flag,   /* i  : Flag for 1st (or 3rd) subframe       */
 103         Word16 flag4,        /* i  : Flag for encoding with 4 bits        */
 104         Flag   *pOverflow
 105     );
 106
 107
 108
 109
 110 #ifdef __cplusplus
 111 }
 112 #endif
 113
 114 #endif  /* _ENC_LAG3_H_ */
 115
 116