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 314f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Filename: /audio/gsm_amr/c/src/round.c 324f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 334f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 344f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber REVISION HISTORY 354f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 364f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Created separate file for the round function. Sync'ed up 374f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber with the current template and fixed tabs. 384f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 394f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Made changes based on review meeting: 404f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1. Removed long in Inputs Definitions. 414f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 2. Changed L_var1 to var_out and description in 424f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Output Definitions. 434f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 444f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Added a parameter to the function interface, pOverflow which is 454f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber a pointer to the overflow flag. This flag is required by the 464f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber L_add() function invoked by round(). 474f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Removed code that updates the MOPS counter. 484f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Created a new return variable result. 494f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 504f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Removed embedded tabs. Included comment in the Pseudo code 514f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Section about using pointer to overflow flag in the actual 524f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber implementation instead of using a global flag. 534f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 544f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: Changed function name to pv_round to avoid conflict with 554f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber round function in C standard library. 564f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 574f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Who: Date: 584f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Description: 594f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 604f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 614f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber MODULE DESCRIPTION 624f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 634f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Rounding function with saturation. 644f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 654f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 664f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber*/ 674f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 684f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 694f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; INCLUDES 704f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 714f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#include "basic_op.h" 724f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 734f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 744f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; MACROS 754f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; [Define module specific macros here] 764f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 774f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 784f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 794f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; DEFINES 804f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; [Include all pre-processor statements here. Include conditional 814f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; compile variables also.] 824f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 834f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 844f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 854f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; LOCAL FUNCTION DEFINITIONS 864f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; [List function prototypes here] 874f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 884f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 894f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 904f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; LOCAL VARIABLE DEFINITIONS 914f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; [Variable declaration - defined here and used outside this module] 924f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 934f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 944f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/* 954f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 964f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber FUNCTION NAME: pv_round 974f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 984f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber INPUT AND OUTPUT DEFINITIONS 994f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1004f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Inputs: 1014f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber L_var1 = 32 bit signed integer (Word32) whose value falls 1024f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber in the range : 0x8000 0000 <= L_var1 <= 0x7fff ffff. 1034f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1044f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pOverflow = pointer to overflow (Flag) 1054f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1064f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Outputs: 1074f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber None 1084f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1094f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Returns: 1104f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber result = MS 16 bits of rounded input L_var1. 1114f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1124f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Global Variables Used: 1134f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber None 1144f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1154f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Local Variables Needed: 1164f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber None 1174f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1184f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1194f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber FUNCTION DESCRIPTION 1204f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1214f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber This function rounds the lower 16 bits of the 32 bit input number into the 1224f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber MS 16 bits with saturation. Shift the resulting bits right by 16 and return 1234f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber the 16 bit number: 1244f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber pv_round(L_var1) = extract_h(L_add(L_var1,32768)) 1254f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1264f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1274f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber REQUIREMENTS 1284f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1294f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber None 1304f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1314f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1324f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber REFERENCES 1334f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1344f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber [1] round() function in basic_op2.c, UMTS GSM AMR speech codec, R99 - 1354f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Version 3.2.0, March 2, 2001 1364f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1374f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1384f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber PSEUDO-CODE 1394f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1404f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas HuberWord16 pv_round (Word32 L_var1) 1414f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber{ 1424f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Word16 var_out; 1434f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Word32 L_rounded; 1444f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1454f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber* The reference ETSI code uses a global flag for Overflow in the L_add() function. 1464f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber* In the actual implementation a pointer to Overflow flag is passed in as a 1474f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber* parameter to the function. 1484f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1494f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber L_rounded = L_add (L_var1, (Word32) 0x00008000L); 1504f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#if (WMOPS) 1514f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber multiCounter[currCounter].L_add--; 1524f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#endif 1534f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber var_out = extract_h (L_rounded); 1544f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#if (WMOPS) 1554f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber multiCounter[currCounter].extract_h--; 1564f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber multiCounter[currCounter].round++; 1574f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber#endif 1584f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber return (var_out); 1594f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber} 1604f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1614f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1624f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber RESOURCES USED [optional] 1634f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1644f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber When the code is written for a specific target processor the 1654f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber the resources used should be documented below. 1664f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1674f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber HEAP MEMORY USED: x bytes 1684f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1694f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber STACK MEMORY USED: x bytes 1704f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1714f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber CLOCK CYCLES: (cycle count equation for this function) + (variable 1724f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber used to represent cycle count for each subroutine 1734f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber called) 1744f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber where: (cycle count variable) = cycle count for [subroutine 1754f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber name] 1764f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1774f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1784f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber CAUTION [optional] 1794f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber [State any special notes, constraints or cautions for users of this function] 1804f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1814f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber------------------------------------------------------------------------------ 1824f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber*/ 1834f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1844f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber/*---------------------------------------------------------------------------- 1854f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber; FUNCTION CODE 1864f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber----------------------------------------------------------------------------*/ 1874f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas HuberWord16 pv_round(register Word32 L_var1, Flag *pOverflow) 1884f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber{ 1894f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber Word16 result; 1904f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1914f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber L_var1 = L_add(L_var1, (Word32) 0x00008000L, pOverflow); 1924f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber result = (Word16)(L_var1 >> 16); 1934f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber 1944f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber return (result); 1954f1efc098cb5791c3e9f483f2af84aef70d2d0a0Andreas Huber} 196