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