opencore/codecs_v2/audio/gsm_amr/amr_nb/common/src/bytesused.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
  31  Filename: bytesused.cpp
  32
  33 ------------------------------------------------------------------------------
  34  INPUT AND OUTPUT DEFINITIONS
  35
  36  Inputs:
  37     None
  38
  39  Local Stores/Buffers/Pointers Needed:
  40     None
  41
  42  Global Stores/Buffers/Pointers Needed:
  43     None
  44
  45  Outputs:
  46     None
  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 creates a table called BytesUsed that holds the value that
  61  describes the number of bytes required to hold one frame worth of data in
  62  the WMF (non-IF2) frame format. Each table entry is the sum of the frame
  63  type byte and the number of bytes used up by the core speech data for each
  64  3GPP frame type.
  65
  66 ------------------------------------------------------------------------------
  67  REQUIREMENTS
  68
  69  None
  70
  71 ------------------------------------------------------------------------------
  72  REFERENCES
  73
  74  [1] "AMR Speech Codec Frame Structure", 3GPP TS 26.101 version 4.1.0
  75      Release 4, June 2001, page 13.
  76
  77 ------------------------------------------------------------------------------
  78  PSEUDO-CODE
  79
  80
  81 ------------------------------------------------------------------------------
  82 */
  83
  84
  85 /*----------------------------------------------------------------------------
  86 ; INCLUDES
  87 ----------------------------------------------------------------------------*/
  88 #include "typedef.h"
  89
  90 /*--------------------------------------------------------------------------*/
  91 #ifdef __cplusplus
  92 extern "C"
  93 {
  94 #endif
  95
  96     /*----------------------------------------------------------------------------
  97     ; MACROS
  98     ; Define module specific macros here
  99     ----------------------------------------------------------------------------*/
 100
 101
 102     /*----------------------------------------------------------------------------
 103     ; DEFINES
 104     ; Include all pre-processor statements here. Include conditional
 105     ; compile variables also.
 106     ----------------------------------------------------------------------------*/
 107
 108     /*----------------------------------------------------------------------------
 109     ; LOCAL FUNCTION DEFINITIONS
 110     ; Function Prototype declaration
 111     ----------------------------------------------------------------------------*/
 112
 113
 114     /*----------------------------------------------------------------------------
 115     ; LOCAL STORE/BUFFER/POINTER DEFINITIONS
 116     ; Variable declaration - defined here and used outside this module
 117     ----------------------------------------------------------------------------*/
 118     const short BytesUsed[16] =
 119     {
 120         13, /* 4.75 */
 121         14, /* 5.15 */
 122         16, /* 5.90 */
 123         18, /* 6.70 */
 124         20, /* 7.40 */
 125         21, /* 7.95 */
 126         27, /* 10.2 */
 127         32, /* 12.2 */
 128         6, /* GsmAmr comfort noise */
 129         7, /* Gsm-Efr comfort noise */
 130         6, /* IS-641 comfort noise */
 131         6, /* Pdc-Efr comfort noise */
 132         0, /* future use */
 133         0, /* future use */
 134         0, /* future use */
 135         1 /* No transmission */
 136     };
 137     /*----------------------------------------------------------------------------
 138     ; EXTERNAL FUNCTION REFERENCES
 139     ; Declare functions defined elsewhere and referenced in this module
 140     ----------------------------------------------------------------------------*/
 141
 142
 143     /*----------------------------------------------------------------------------
 144     ; EXTERNAL GLOBAL STORE/BUFFER/POINTER REFERENCES
 145     ; Declare variables used in this module but defined elsewhere
 146     ----------------------------------------------------------------------------*/
 147
 148
 149     /*--------------------------------------------------------------------------*/
 150 #ifdef __cplusplus
 151 }
 152 #endif
 153
 154 /*----------------------------------------------------------------------------
 155 ; FUNCTION CODE
 156 ----------------------------------------------------------------------------*/
 157
 158 /*----------------------------------------------------------------------------
 159 ; Define all local variables
 160 ----------------------------------------------------------------------------*/
 161
 162
 163 /*----------------------------------------------------------------------------
 164 ; Function body here
 165 ----------------------------------------------------------------------------*/
 166
 167
 168 /*----------------------------------------------------------------------------
 169 ; Return nothing or data or data pointer
 170 ----------------------------------------------------------------------------*/
 171