opencore/codecs_v2/audio/gsm_amr/amr_nb/common/src/extract_l.cpp

   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  Filename: extract_l.cpp
  31
  32 ------------------------------------------------------------------------------
  33  INPUT AND OUTPUT DEFINITIONS
  34
  35  Inputs:
  36     L_var1 = 32 bit long signed integer (Word32 ) whose value falls
  37              in the range : 0x8000 0000 <= L_var1 <= 0x7fff ffff.
  38
  39  Local Stores/Buffers/Pointers Needed:
  40     None
  41
  42  Global Stores/Buffers/Pointers Needed:
  43     None
  44
  45  Outputs:
  46     L_var1 = Most significant word of input (Word16)
  47
  48  Pointers and Buffers Modified:
  49     None
  50
  51  Local Stores Modified:
  52     None
  53
  54  Global Stores Modified:
  55     None
  56
  57 ------------------------------------------------------------------------------
  58  FUNCTION DESCRIPTION
  59
  60  This function returns the 16 LSB of the input, L_var1.
  61
  62 ------------------------------------------------------------------------------
  63  REQUIREMENTS
  64
  65  None
  66
  67 ------------------------------------------------------------------------------
  68  REFERENCES
  69
  70  [1] basicop2.c, ETS Version 2.0.0, February 8, 1999
  71
  72 ------------------------------------------------------------------------------
  73  PSEUDO-CODE
  74
  75 Word16 extract_l (Word32 L_var1)
  76 {
  77     Word16 var_out;
  78
  79     var_out = (Word16) L_var1;
  80 #if (WMOPS)
  81     multiCounter[currCounter].extract_l++;
  82 #endif
  83     return (var_out);
  84 }
  85
  86 ------------------------------------------------------------------------------
  87 */
  88
  89
  90 /*----------------------------------------------------------------------------
  91 ; INCLUDES
  92 ----------------------------------------------------------------------------*/
  93 #include    "basic_op.h"
  94
  95 /*----------------------------------------------------------------------------
  96 ; MACROS
  97 ; Define module specific macros here
  98 ----------------------------------------------------------------------------*/
  99
 100 /*----------------------------------------------------------------------------
 101 ; DEFINES
 102 ; Include all pre-processor statements here. Include conditional
 103 ; compile variables also.
 104 ----------------------------------------------------------------------------*/
 105
 106 /*----------------------------------------------------------------------------
 107 ; LOCAL FUNCTION DEFINITIONS
 108 ; Function Prototype declaration
 109 ----------------------------------------------------------------------------*/
 110
 111 /*----------------------------------------------------------------------------
 112 ; LOCAL STORE/BUFFER/POINTER DEFINITIONS
 113 ; Variable declaration - defined here and used outside this module
 114 ----------------------------------------------------------------------------*/
 115
 116 /*----------------------------------------------------------------------------
 117 ; EXTERNAL FUNCTION REFERENCES
 118 ; Declare functions defined elsewhere and referenced in this module
 119 ----------------------------------------------------------------------------*/
 120
 121 /*----------------------------------------------------------------------------
 122 ; EXTERNAL GLOBAL STORE/BUFFER/POINTER REFERENCES
 123 ; Declare variables used in this module but defined elsewhere
 124 ----------------------------------------------------------------------------*/
 125
 126 /*----------------------------------------------------------------------------
 127 ; FUNCTION CODE
 128 ----------------------------------------------------------------------------*/
 129 Word16 extract_l(Word32 L_var1)
 130 {
 131     /*----------------------------------------------------------------------------
 132     ; Define all local variables
 133     ----------------------------------------------------------------------------*/
 134
 135     /*----------------------------------------------------------------------------
 136     ; Function body here
 137     ----------------------------------------------------------------------------*/
 138
 139     /*----------------------------------------------------------------------------
 140     ; Return nothing or data or data pointer
 141     ----------------------------------------------------------------------------*/
 142     return ((Word16) L_var1);
 143 }