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