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_norm.h
     32 
     33 ------------------------------------------------------------------------------
     34  REVISION HISTORY
     35 
     36  Description: Updated function prototype declaration to reflect new interface.
     37               A pointer to overflow flag is passed into the function. Updated
     38               template. Added extern declaration for pow2_tbl[]
     39 
     40  Description: Moved _cplusplus #ifdef after Include section.
     41 
     42  Who:                       Date:
     43  Description:
     44 
     45 ------------------------------------------------------------------------------
     46  INCLUDE DESCRIPTION
     47 
     48  This file contains the prototype declaration for Pow2() function.
     49 
     50 ------------------------------------------------------------------------------
     51 */
     52 
     53 /*----------------------------------------------------------------------------
     54 ; CONTINUE ONLY IF NOT ALREADY DEFINED
     55 ----------------------------------------------------------------------------*/
     56 #ifndef POW2_H
     57 #define POW2_H
     58 
     59 /*----------------------------------------------------------------------------
     60 ; INCLUDES
     61 ----------------------------------------------------------------------------*/
     62 #include    "typedef.h"
     63 
     64 /*--------------------------------------------------------------------------*/
     65 #ifdef __cplusplus
     66 extern "C"
     67 {
     68 #endif
     69 
     70     /*----------------------------------------------------------------------------
     71     ; MACROS
     72     ; Define module specific macros here
     73     ----------------------------------------------------------------------------*/
     74 
     75     /*----------------------------------------------------------------------------
     76     ; DEFINES
     77     ; Include all pre-processor statements here.
     78     ----------------------------------------------------------------------------*/
     79 
     80     /*----------------------------------------------------------------------------
     81     ; EXTERNAL VARIABLES REFERENCES
     82     ; Declare variables used in this module but defined elsewhere
     83     ----------------------------------------------------------------------------*/
     84     extern const Word16 pow2_tbl[];
     85     /*----------------------------------------------------------------------------
     86     ; SIMPLE TYPEDEF'S
     87     ----------------------------------------------------------------------------*/
     88 
     89     /*----------------------------------------------------------------------------
     90     ; ENUMERATED TYPEDEF'S
     91     ----------------------------------------------------------------------------*/
     92 
     93     /*----------------------------------------------------------------------------
     94     ; STRUCTURES TYPEDEF'S
     95     ----------------------------------------------------------------------------*/
     96 
     97     /*----------------------------------------------------------------------------
     98     ; GLOBAL FUNCTION DEFINITIONS
     99     ; Function Prototype declaration
    100     ----------------------------------------------------------------------------*/
    101 
    102     Word32 Pow2(            /* (o)  : result       (range: 0<=val<=0x7fffffff) */
    103         Word16 exponent,    /* (i)  : Integer part.      (range: 0<=val<=30)   */
    104         Word16 fraction,    /* (i)  : Fractional part.  (range: 0.0<=val<1.0)  */
    105         Flag *pOverflow     /* (i/o) : overflow flag                           */
    106     );
    107 
    108     /*----------------------------------------------------------------------------
    109     ; END
    110     ----------------------------------------------------------------------------*/
    111 #ifdef __cplusplus
    112 }
    113 #endif
    114 
    115 #endif /* _POW2_H_ */
    116