opencore/codecs_v2/audio/gsm_amr/amr_nb/common/src/l_deposit_h.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: l_deposit_h.cpp
  31
  32 ------------------------------------------------------------------------------
  33  INPUT AND OUTPUT DEFINITIONS
  34
  35  Inputs:
  36     var1 = 16 bit short signed integer (Word16) whose value falls in
  37            the range : 0xffff 8000 <= var1 <= 0x0000 7fff.
  38
  39  Local Stores/Buffers/Pointers Needed:
  40     None
  41
  42  Global Stores/Buffers/Pointers Needed:
  43     None
  44
  45  Outputs:
  46     var1 = deposit of var1 into MSWord of 32 bit value (Word32)
  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 deposits the 16 bit var1 into the 16 MS bits of the 32 bit
  61  output. The 16 LS bits of the output are zeroed.
  62
  63 ------------------------------------------------------------------------------
  64  REQUIREMENTS
  65
  66  None
  67
  68 ------------------------------------------------------------------------------
  69  REFERENCES
  70
  71  [1] basicop2.c, ETS Version 2.0.0, February 8, 1999
  72
  73 ------------------------------------------------------------------------------
  74  PSEUDO-CODE
  75
  76 Word32 L_deposit_h (Word16 var1)
  77 {
  78     Word32 L_var_out;
  79
  80     L_var_out = (Word32) var1 << 16;
  81 #if (WMOPS)
  82     multiCounter[currCounter].L_deposit_h++;
  83 #endif
  84     return (L_var_out);
  85 }
  86
  87 ------------------------------------------------------------------------------
  88 */
  89
  90
  91 /*----------------------------------------------------------------------------
  92 ; INCLUDES
  93 ----------------------------------------------------------------------------*/
  94 #include    "basic_op.h"
  95
  96 /*----------------------------------------------------------------------------
  97 ; MACROS
  98 ; Define module specific macros here
  99 ----------------------------------------------------------------------------*/
 100
 101 /*----------------------------------------------------------------------------
 102 ; DEFINES
 103 ; Include all pre-processor statements here. Include conditional
 104 ; compile variables also.
 105 ----------------------------------------------------------------------------*/
 106
 107 /*----------------------------------------------------------------------------
 108 ; LOCAL FUNCTION DEFINITIONS
 109 ; Function Prototype declaration
 110 ----------------------------------------------------------------------------*/
 111
 112 /*----------------------------------------------------------------------------
 113 ; LOCAL STORE/BUFFER/POINTER DEFINITIONS
 114 ; Variable declaration - defined here and used outside this module
 115 ----------------------------------------------------------------------------*/
 116
 117 /*----------------------------------------------------------------------------
 118 ; EXTERNAL FUNCTION REFERENCES
 119 ; Declare functions defined elsewhere and referenced in this module
 120 ----------------------------------------------------------------------------*/
 121
 122 /*----------------------------------------------------------------------------
 123 ; EXTERNAL GLOBAL STORE/BUFFER/POINTER REFERENCES
 124 ; Declare variables used in this module but defined elsewhere
 125 ----------------------------------------------------------------------------*/
 126
 127 /*----------------------------------------------------------------------------
 128 ; FUNCTION CODE
 129 ----------------------------------------------------------------------------*/
 130 Word32 L_deposit_h(Word16 var1)
 131 {
 132     /*----------------------------------------------------------------------------
 133     ; Define all local variables
 134     ----------------------------------------------------------------------------*/
 135
 136     /*----------------------------------------------------------------------------
 137     ; Function body here
 138     ----------------------------------------------------------------------------*/
 139
 140     /*----------------------------------------------------------------------------
 141     ; Return nothing or data or data pointer
 142     ----------------------------------------------------------------------------*/
 143     return ((Word32) var1 << 16);
 144 }