frameworks/base/media/libstagefright/codecs/amrnb/enc/src/enc_lag6.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/enc_lag6.h
  35
  36      Date: 02/05/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: Moved _cplusplus #ifdef after Include section.
  45
  46  Description:
  47
  48 ------------------------------------------------------------------------------
  49  INCLUDE DESCRIPTION
  50
  51  This file contains all the constant definitions and prototype definitions
  52  needed by the file, enc_lag6.c
  53
  54 ------------------------------------------------------------------------------
  55 */
  56
  57 /*----------------------------------------------------------------------------
  58 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  59 ----------------------------------------------------------------------------*/
  60 #ifndef enc_lag6_h
  61 #define enc_lag6_h "$Id $"
  62
  63 /*----------------------------------------------------------------------------
  64 ; INCLUDES
  65 ----------------------------------------------------------------------------*/
  66 #include "typedef.h"
  67
  68 /*--------------------------------------------------------------------------*/
  69 #ifdef __cplusplus
  70 extern "C"
  71 {
  72 #endif
  73
  74     /*----------------------------------------------------------------------------
  75     ; MACROS
  76     ; Define module specific macros here
  77     ----------------------------------------------------------------------------*/
  78
  79     /*----------------------------------------------------------------------------
  80     ; DEFINES
  81     ; Include all pre-processor statements here.
  82     ----------------------------------------------------------------------------*/
  83
  84     /*----------------------------------------------------------------------------
  85     ; EXTERNAL VARIABLES REFERENCES
  86     ; Declare variables used in this module but defined elsewhere
  87     ----------------------------------------------------------------------------*/
  88
  89     /*----------------------------------------------------------------------------
  90     ; SIMPLE TYPEDEF'S
  91     ----------------------------------------------------------------------------*/
  92
  93     /*----------------------------------------------------------------------------
  94     ; ENUMERATED TYPEDEF'S
  95     ----------------------------------------------------------------------------*/
  96
  97     /*----------------------------------------------------------------------------
  98     ; STRUCTURES TYPEDEF'S
  99     ----------------------------------------------------------------------------*/
 100
 101     /*----------------------------------------------------------------------------
 102     ; GLOBAL FUNCTION DEFINITIONS
 103     ; Function Prototype declaration
 104     ----------------------------------------------------------------------------*/
 105     Word16 Enc_lag6(         /* o  : Return index of encoding             */
 106         Word16 T0,           /* i  : Pitch delay                          */
 107         Word16 T0_frac,      /* i  : Fractional pitch delay               */
 108         Word16 T0_min,       /* i  : minimum of search range              */
 109         Word16 delta_flag,   /* i  : Flag for 1st (or 3rd) subframe       */
 110         Flag   *pOverflow    /* o  : Overflow indicator                   */
 111     );
 112
 113     /*----------------------------------------------------------------------------
 114     ; END
 115     ----------------------------------------------------------------------------*/
 116 #ifdef __cplusplus
 117 }
 118 #endif
 119
 120 #endif /* enc_lag6_h */
 121
 122