14f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/* ------------------------------------------------------------------ 24f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * Copyright (C) 1998-2009 PacketVideo 34f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * 44f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * Licensed under the Apache License, Version 2.0 (the "License"); 54f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * you may not use this file except in compliance with the License. 64f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * You may obtain a copy of the License at 74f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * 84f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * http://www.apache.org/licenses/LICENSE-2.0 94f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * 104f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * Unless required by applicable law or agreed to in writing, software 114f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * distributed under the License is distributed on an "AS IS" BASIS, 124f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either 134f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * express or implied. 144f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * See the License for the specific language governing permissions 154f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * and limitations under the License. 164f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber * ------------------------------------------------------------------- 174f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber */ 184f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/**************************************************************************************** 194f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas HuberPortions of this file are derived from the following 3GPP standard: 204f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 214f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 3GPP TS 26.073 224f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec 234f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Available from http://www.3gpp.org 244f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 254f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber(C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC) 264f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas HuberPermission to distribute, modify and use this file under the standard license 274f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huberterms listed above has been obtained from the copyright holder. 284f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber****************************************************************************************/ 294f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/* 304f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Filename: /audio/gsm_amr/c/src/log2.c 314f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 324f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 334f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber REVISION HISTORY 344f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 354f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Updated template used to PV coding template. Moved Log2_norm 364f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber function to its own file. 374f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 384f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Changed l_shl.c to l_shl.h in Include section. 394f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 404f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Updated template. Changed function interface to pass in a 414f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pointer to overflow flag into the function instead of using a 424f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber global flag. Changed input pointer names for clarity. 434f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 444f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: 454f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1. Eliminated l_shl function knowing that after normalization 464f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber the left shift factor will not saturate. 474f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 2. Eliminated unused include files typedef.h and l_shl.h. 484f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 494f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 504f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Who: Date: 514f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: 524f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 534f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 544f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber*/ 554f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 564f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 574f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; INCLUDES 584f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 594f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#include "log2.h" 604f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#include "basic_op.h" 614f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#include "log2_norm.h" 624f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 634f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 644f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; MACROS 654f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; [Define module specific macros here] 664f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 674f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 684f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 694f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; DEFINES 704f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; [Include all pre-processor statements here. Include conditional 714f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; compile variables also.] 724f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 734f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 744f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 754f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; LOCAL FUNCTION DEFINITIONS 764f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; [List function prototypes here] 774f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 784f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 794f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 804f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; LOCAL VARIABLE DEFINITIONS 814f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; [Variable declaration - defined here and used outside this module] 824f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 834f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 844f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 854f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/* 864f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 874f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber FUNCTION NAME: log2() 884f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 894f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber INPUT AND OUTPUT DEFINITIONS 904f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 914f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Inputs: 924f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber L_x = input value of type Word32 934f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pExponent = pointer to the integer part of Log2 of type Word16 whose 944f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber valid range is: 0 <= value <= 30 954f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pFraction = pointer to the fractional part of Log2 of type Word16 964f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber whose valid range is: 0 <= value < 1 974f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pOverflow = pointer to overflow flag 984f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 994f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1004f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Outputs: 1014f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pExponent -> integer part of the newly calculated Log2 1024f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pFraction -> fractional part of the newly calculated Log2 1034f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pOverflow -> 1 if the log2() operation resulted in saturation 1044f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1054f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Returns: 1064f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber None 1074f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1084f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Global Variables Used: 1094f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber None 1104f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1114f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Local Variables Needed: 1124f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber None 1134f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1144f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1154f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber FUNCTION DESCRIPTION 1164f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1174f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber This function computes logarithm (base2) of the input L_x, where L_x is 1184f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber positive. If L_x is negative or zero, the result is 0. 1194f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1204f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber This function first normalizes the input L_x and calls the function Log2_norm 1214f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber to calculate the logarithm. 1224f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1234f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1244f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber REQUIREMENTS 1254f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1264f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber None 1274f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1284f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1294f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber REFERENCES 1304f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1314f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber [1] log2.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 1324f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1334f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1344f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber PSEUDO-CODE 1354f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1364f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1374f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1384f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber RESOURCES USED [optional] 1394f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1404f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber When the code is written for a specific target processor the 1414f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber the resources used should be documented below. 1424f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1434f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber HEAP MEMORY USED: x bytes 1444f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1454f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber STACK MEMORY USED: x bytes 1464f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1474f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber CLOCK CYCLES: (cycle count equation for this function) + (variable 1484f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber used to represent cycle count for each subroutine 1494f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber called) 1504f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber where: (cycle count variable) = cycle count for [subroutine 1514f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber name] 1524f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1534f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1544f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber CAUTION [optional] 1554f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber [State any special notes, constraints or cautions for users of this function] 1564f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1574f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1584f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber*/ 1594f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1604f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 1614f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; FUNCTION CODE 1624f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 1634f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Hubervoid Log2( 1644f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Word32 L_x, /* (i) : input value */ 1654f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Word16 *pExponent, /* (o) : Integer part of Log2. (range: 0<=val<=30)*/ 1664f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Word16 *pFraction, /* (o) : Fractional part of Log2. (range: 0<=val<1) */ 1674f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Flag *pOverflow /* (i/o) : overflow flag */ 1684f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber) 1694f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber{ 1704f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Word16 exp; 1714f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Word32 result; 1724f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber OSCL_UNUSED_ARG(pOverflow); 1734f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1744f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber exp = norm_l(L_x); 1754f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber result = L_x << exp; 1764f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Log2_norm(result, exp, pExponent, pFraction); 1774f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1784f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber return; 1794f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber} 180