opencore/codecs_v2/audio/gsm_amr/amr_nb/common/include/log2.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  Filename: log2.h
  32
  33 ------------------------------------------------------------------------------
  34  INCLUDE DESCRIPTION
  35
  36  This file contains the function prototype definition for Log2 function.
  37
  38 ------------------------------------------------------------------------------
  39 */
  40 /*----------------------------------------------------------------------------
  41 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  42 ----------------------------------------------------------------------------*/
  43 #ifndef LOG2_H
  44 #define LOG2_H
  45
  46 /*----------------------------------------------------------------------------
  47 ; INCLUDES
  48 ----------------------------------------------------------------------------*/
  49 #include    "typedef.h"
  50
  51 #include    "log2_norm.h"           /* Used by legacy files */
  52
  53 /*--------------------------------------------------------------------------*/
  54 #ifdef __cplusplus
  55 extern "C"
  56 {
  57 #endif
  58
  59     /*----------------------------------------------------------------------------
  60     ; MACROS
  61     ; Define module specific macros here
  62     ----------------------------------------------------------------------------*/
  63
  64     /*----------------------------------------------------------------------------
  65     ; DEFINES
  66     ; Include all pre-processor statements here.
  67     ----------------------------------------------------------------------------*/
  68
  69     /*----------------------------------------------------------------------------
  70     ; EXTERNAL VARIABLES REFERENCES
  71     ; Declare variables used in this module but defined elsewhere
  72     ----------------------------------------------------------------------------*/
  73
  74     /*----------------------------------------------------------------------------
  75     ; SIMPLE TYPEDEF'S
  76     ----------------------------------------------------------------------------*/
  77
  78     /*----------------------------------------------------------------------------
  79     ; ENUMERATED TYPEDEF'S
  80     ----------------------------------------------------------------------------*/
  81
  82     /*----------------------------------------------------------------------------
  83     ; STRUCTURES TYPEDEF'S
  84     ----------------------------------------------------------------------------*/
  85
  86     /*----------------------------------------------------------------------------
  87     ; GLOBAL FUNCTION DEFINITIONS
  88     ; Function Prototype declaration
  89     ----------------------------------------------------------------------------*/
  90     OSCL_IMPORT_REF void Log2(
  91         Word32 L_x,         /* (i) : input value                                */
  92         Word16 *pExponent,  /* (o) : Integer part of Log2.   (range: 0<=val<=30)*/
  93         Word16 *pFraction,  /* (o) : Fractional part of Log2. (range: 0<=val<1) */
  94         Flag   *pOverflow   /* (i/o) : overflow flag                            */
  95     );
  96
  97     /*----------------------------------------------------------------------------
  98     ; END
  99     ----------------------------------------------------------------------------*/
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 #endif /* _LOG2_H_ */