1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/* ------------------------------------------------------------------
* Copyright (C) 1998-2009 PacketVideo
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied.
* See the License for the specific language governing permissions
* and limitations under the License.
* -------------------------------------------------------------------
*/
/****************************************************************************************
Portions of this file are derived from the following 3GPP standard:
3GPP TS 26.073
ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec
Available from http://www.3gpp.org
(C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC)
Permission to distribute, modify and use this file under the standard license
terms listed above has been obtained from the copyright holder.
****************************************************************************************/
/*
------------------------------------------------------------------------------
Pathname: ./audio/gsm-amr/c/src/lsp_avg.c
Functions:
Date: 04/14/2000
------------------------------------------------------------------------------
REVISION HISTORY
Description: Removed the functions lsp_avg_init and lsp_avg_exit.
The lsp_avg related structure is no longer dynamically allocated.
Also, placed code in the proper PV Software Template.
Description: Per review comments, updated the inputs/outputs section
for the function lsp_avg.
Description: Changed to accept the pOverflow flag for EPOC compatibility.
Description: Per review comments, I added a description of pOverflow
to the input/output section of the template. I also removed an unnecessary
include file, <stdio.h>
Description: Removed q_plsf_5.tab from Include section and added
q_plsf_5_tbl.h to Include section. Changed "mean_lsf"
to "mean_lsf_5" in lsp_avg_reset().
Description: Replaced OSCL mem type functions and eliminated include
files that now are chosen by OSCL definitions
Description: Replaced "int" and/or "char" with OSCL defined types.
Description: Changed round function name to pv_round to avoid conflict with
round function in C standard library.
Description:
------------------------------------------------------------------------------
MODULE DESCRIPTION
LSP averaging and history
------------------------------------------------------------------------------
*/
/*----------------------------------------------------------------------------
; INCLUDES
----------------------------------------------------------------------------*/
#include "lsp_avg.h"
#include "basic_op.h"
#include "oper_32b.h"
#include "copy.h"
#include "q_plsf_5_tbl.h"
/*----------------------------------------------------------------------------
; MACROS
; Define module specific macros here
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; DEFINES
; Include all pre-processor statements here. Include conditional
; compile variables also.
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; LOCAL FUNCTION DEFINITIONS
; Function Prototype declaration
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; LOCAL VARIABLE DEFINITIONS
; Variable declaration - defined here and used outside this module
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; EXTERNAL FUNCTION REFERENCES
; Declare functions defined elsewhere and referenced in this module
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; EXTERNAL VARIABLES REFERENCES
; Declare variables used in this module but defined elsewhere
----------------------------------------------------------------------------*/
/*
------------------------------------------------------------------------------
FUNCTION NAME: lsp_avg_reset
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
st = pointer to structure of type lsp_avgState
Outputs:
fields of the structure pointed to by state are initialized.
Returns:
return_value = 0, if reset was successful; -1, otherwise (int)
Global Variables Used:
None
Local Variables Needed:
None
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
------------------------------------------------------------------------------
REQUIREMENTS
None
------------------------------------------------------------------------------
REFERENCES
lsp_avg.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
int lsp_avg_reset (lsp_avgState *st)
{
if (st == (lsp_avgState *) NULL){
// fprintf(stderr, "lsp_avg_reset: invalid parameter\n");
return -1;
}
Copy(mean_lsf, &st->lsp_meanSave[0], M);
return 0;
}
------------------------------------------------------------------------------
RESOURCES USED [optional]
When the code is written for a specific target processor the
the resources used should be documented below.
HEAP MEMORY USED: x bytes
STACK MEMORY USED: x bytes
CLOCK CYCLES: (cycle count equation for this function) + (variable
used to represent cycle count for each subroutine
called)
where: (cycle count variable) = cycle count for [subroutine
name]
------------------------------------------------------------------------------
CAUTION [optional]
[State any special notes, constraints or cautions for users of this function]
------------------------------------------------------------------------------
*/
Word16 lsp_avg_reset(lsp_avgState *st)
{
if (st == (lsp_avgState *) NULL)
{
/* fprintf(stderr, "lsp_avg_reset: invalid parameter\n"); */
return -1;
}
Copy(mean_lsf_5, &st->lsp_meanSave[0], M);
return 0;
}
/*
------------------------------------------------------------------------------
FUNCTION NAME: lsp_avg
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
st = pointer to structure of type lsp_avgState
lsp = pointer to Word16, which reflects the state of the state machine
Outputs:
st = pointer to structure of type lsp_avgState
pOverflow = pointer to type Flag -- overflow indicator
Returns:
None
Global Variables Used:
None
Local Variables Needed:
None
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
------------------------------------------------------------------------------
REQUIREMENTS
None
------------------------------------------------------------------------------
REFERENCES
lsp_avg.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
void lsp_avg (
lsp_avgState *st, // i/o : State struct Q15
Word16 *lsp // i : state of the state machine Q15
)
{
Word16 i;
Word32 L_tmp; // Q31
for (i = 0; i < M; i++) {
// mean = 0.84*mean
L_tmp = L_deposit_h(st->lsp_meanSave[i]);
L_tmp = L_msu(L_tmp, EXPCONST, st->lsp_meanSave[i]);
// Add 0.16 of newest LSPs to mean
L_tmp = L_mac(L_tmp, EXPCONST, lsp[i]);
// Save means
st->lsp_meanSave[i] = pv_round(L_tmp); // Q15
}
return;
}
------------------------------------------------------------------------------
RESOURCES USED [optional]
When the code is written for a specific target processor the
the resources used should be documented below.
HEAP MEMORY USED: x bytes
STACK MEMORY USED: x bytes
CLOCK CYCLES: (cycle count equation for this function) + (variable
used to represent cycle count for each subroutine
called)
where: (cycle count variable) = cycle count for [subroutine
name]
------------------------------------------------------------------------------
CAUTION [optional]
[State any special notes, constraints or cautions for users of this function]
------------------------------------------------------------------------------
*/
void lsp_avg(
lsp_avgState *st, /* i/o : State struct Q15 */
Word16 *lsp, /* i : state of the state machine Q15 */
Flag *pOverflow /* o : Flag set when overflow occurs */
)
{
Word16 i;
Word32 L_tmp; /* Q31 */
for (i = 0; i < M; i++)
{
/* mean = 0.84*mean */
L_tmp = L_deposit_h(st->lsp_meanSave[i]);
L_tmp = L_msu(L_tmp, EXPCONST, st->lsp_meanSave[i], pOverflow);
/* Add 0.16 of newest LSPs to mean */
L_tmp = L_mac(L_tmp, EXPCONST, lsp[i], pOverflow);
/* Save means */
st->lsp_meanSave[i] = pv_round(L_tmp, pOverflow); /* Q15 */
}
return;
}
|
