opencore/codecs_v2/audio/gsm_amr/amr_nb/common/include/sqrt_l.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: sqrt_l.h
  32
  33 ------------------------------------------------------------------------------
  34  INCLUDE DESCRIPTION
  35
  36  This file contains all the constant definitions and prototype definitions
  37  needed by the sqrt_l() function.
  38
  39 ------------------------------------------------------------------------------
  40 */
  41
  42 #ifndef SQRT_L_H
  43 #define SQRT_L_H
  44
  45 /*----------------------------------------------------------------------------
  46 ; INCLUDES
  47 ----------------------------------------------------------------------------*/
  48 #include    "basicop_malloc.h"
  49
  50 #ifdef __cplusplus
  51 extern "C"
  52 {
  53 #endif
  54
  55     /*----------------------------------------------------------------------------
  56     ; MACROS
  57     ; Define module specific macros here
  58     ----------------------------------------------------------------------------*/
  59
  60     /*----------------------------------------------------------------------------
  61     ; DEFINES
  62     ; Include all pre-processor statements here.
  63     ----------------------------------------------------------------------------*/
  64
  65     /*----------------------------------------------------------------------------
  66     ; EXTERNAL VARIABLES REFERENCES
  67     ; Declare variables used in this module but defined elsewhere
  68     ----------------------------------------------------------------------------*/
  69     extern const Word16 sqrt_l_tbl[];
  70
  71     /*----------------------------------------------------------------------------
  72     ; SIMPLE TYPEDEF'S
  73     ----------------------------------------------------------------------------*/
  74
  75     /*----------------------------------------------------------------------------
  76     ; ENUMERATED TYPEDEF'S
  77     ----------------------------------------------------------------------------*/
  78
  79     /*----------------------------------------------------------------------------
  80     ; STRUCTURES TYPEDEF'S
  81     ----------------------------------------------------------------------------*/
  82
  83     /*----------------------------------------------------------------------------
  84     ; GLOBAL FUNCTION DEFINITIONS
  85     ; Function Prototype declaration
  86     ----------------------------------------------------------------------------*/
  87
  88     OSCL_IMPORT_REF Word32 sqrt_l_exp(      /* o : output value,          Q31 */
  89         Word32 L_x,         /* i : input value,                           Q31 */
  90         Word16 *pExp,       /* o : right shift to be applied to result,   Q1  */
  91         Flag   *pOverflow   /* i : pointer to overflow flag */
  92     );
  93
  94     /*----------------------------------------------------------------------------
  95     ; END
  96     ----------------------------------------------------------------------------*/
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101 #endif /* _SQRT_L__H_ */
 102