Home | History | Annotate | Download | only in include 
      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: /audio/gsm_amr/c/include/log2.h
     32 
     33 ------------------------------------------------------------------------------
     34  REVISION HISTORY
     35 
     36  Description: Updated template used to PV coding template. Deleted function
     37           prototype for Log2_norm and put it in its own header file.
     38           Added log2_norm.h in Include section for legacy files.
     39 
     40  Description: Updated function prototype declaration to reflect new interface.
     41               A pointer to overflow flag is passed into the function. Updated
     42               template.
     43 
     44  Description: Moved _cplusplus #ifdef after Include section..
     45 
     46  Who:                       Date:
     47  Description:
     48 
     49 ------------------------------------------------------------------------------
     50  INCLUDE DESCRIPTION
     51 
     52  This file contains the function prototype definition for Log2 function.
     53 
     54 ------------------------------------------------------------------------------
     55 */
     56 /*----------------------------------------------------------------------------
     57 ; CONTINUE ONLY IF NOT ALREADY DEFINED
     58 ----------------------------------------------------------------------------*/
     59 #ifndef LOG2_H
     60 #define LOG2_H
     61 
     62 /*----------------------------------------------------------------------------
     63 ; INCLUDES
     64 ----------------------------------------------------------------------------*/
     65 #include    "typedef.h"
     66 
     67 #include    "log2_norm.h"           /* Used by legacy files */
     68 
     69 /*--------------------------------------------------------------------------*/
     70 #ifdef __cplusplus
     71 extern "C"
     72 {
     73 #endif
     74 
     75     /*----------------------------------------------------------------------------
     76     ; MACROS
     77     ; Define module specific macros here
     78     ----------------------------------------------------------------------------*/
     79 
     80     /*----------------------------------------------------------------------------
     81     ; DEFINES
     82     ; Include all pre-processor statements here.
     83     ----------------------------------------------------------------------------*/
     84 
     85     /*----------------------------------------------------------------------------
     86     ; EXTERNAL VARIABLES REFERENCES
     87     ; Declare variables used in this module but defined elsewhere
     88     ----------------------------------------------------------------------------*/
     89 
     90     /*----------------------------------------------------------------------------
     91     ; SIMPLE TYPEDEF'S
     92     ----------------------------------------------------------------------------*/
     93 
     94     /*----------------------------------------------------------------------------
     95     ; ENUMERATED TYPEDEF'S
     96     ----------------------------------------------------------------------------*/
     97 
     98     /*----------------------------------------------------------------------------
     99     ; STRUCTURES TYPEDEF'S
    100     ----------------------------------------------------------------------------*/
    101 
    102     /*----------------------------------------------------------------------------
    103     ; GLOBAL FUNCTION DEFINITIONS
    104     ; Function Prototype declaration
    105     ----------------------------------------------------------------------------*/
    106     void Log2(
    107         Word32 L_x,         /* (i) : input value                                */
    108         Word16 *pExponent,  /* (o) : Integer part of Log2.   (range: 0<=val<=30)*/
    109         Word16 *pFraction,  /* (o) : Fractional part of Log2. (range: 0<=val<1) */
    110         Flag   *pOverflow   /* (i/o) : overflow flag                            */
    111     );
    112 
    113     /*----------------------------------------------------------------------------
    114     ; END
    115     ----------------------------------------------------------------------------*/
    116 #ifdef __cplusplus
    117 }
    118 #endif
    119 
    120 #endif /* _LOG2_H_ */
    121