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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
|
/* ------------------------------------------------------------------
* 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.
****************************************************************************************/
/*
------------------------------------------------------------------------------
Filename: sp_enc.cpp
Funtions: GSMInitEncode
Speech_Encode_Frame_reset
GSMEncodeFrameExit
Speech_Encode_Frame_First
GSMEncodeFrame
------------------------------------------------------------------------------
MODULE DESCRIPTION
These functions comprise the pre filtering and encoding of one speech frame.
------------------------------------------------------------------------------
*/
/*----------------------------------------------------------------------------
; INCLUDES
----------------------------------------------------------------------------*/
#include "sp_enc.h"
#include "typedef.h"
#include "cnst.h"
#include "set_zero.h"
#include "pre_proc.h"
#include "prm2bits.h"
#include "mode.h"
#include "cod_amr.h"
#include "oscl_mem.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
----------------------------------------------------------------------------*/
/*
------------------------------------------------------------------------------
FUNCTION NAME: GSMInitEncode
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
state = pointer to an array of pointers to structures of type
Speech_Decode_FrameState
dtx = flag to turn off or turn on DTX (Flag)
id = pointer to an array whose contents are of type char
Outputs:
pre_state field of the structure pointed to by the pointer pointed to
by state is set to NULL
cod_amr_state field of the structure pointed to by the pointer pointed to
by state is set to NULL
dtx field of the structure pointed to by the pointer pointed to by state
is set to the input dtx
Returns:
return_value = set to zero, if initialization was successful; -1,
otherwise (int)
Global Variables Used:
None
Local Variables Needed:
None
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function allocates memory for filter structure and initializes state
memory
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
sp_enc.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
Note: Original function name of Speech_Encode_Frame_init was changed to
GSMInitEncode in the Code section.
int Speech_Encode_Frame_init (void **state_data,
Flag dtx,
char *id)
{
Speech_Encode_FrameState* s;
if (state_data == NULL){
fprintf(stderr, "Speech_Encode_Frame_init: invalid parameter\n");
return -1;
}
*state_data = NULL;
// allocate memory
if ((s= (Speech_Encode_FrameState *) malloc(sizeof(Speech_Encode_FrameState))) == NULL){
fprintf(stderr, "Speech_Encode_Frame_init: can not malloc state "
"structure\n");
return -1;
}
s->complexityCounter = getCounterId(id);
s->pre_state = NULL;
s->cod_amr_state = NULL;
s->dtx = dtx;
if (Pre_Process_init(&s->pre_state) ||
cod_amr_init(&s->cod_amr_state, s->dtx)) {
GSMEncodeFrameExit(&s);
return -1;
}
Speech_Encode_Frame_reset(s);
*state_data = (void *)s;
return 0;
}
------------------------------------------------------------------------------
CAUTION [optional]
[State any special notes, constraints or cautions for users of this function]
------------------------------------------------------------------------------
*/
Word16 GSMInitEncode(void **state_data,
Flag dtx,
Word8 *id)
{
Speech_Encode_FrameState* s;
OSCL_UNUSED_ARG(id);
if (state_data == NULL)
{
/* fprintf(stderr, "Speech_Encode_Frame_init: invalid parameter\n"); */
return -1;
}
*state_data = NULL;
/* allocate memory */
if ((s = (Speech_Encode_FrameState *) oscl_malloc(sizeof(Speech_Encode_FrameState))) == NULL)
{
/* fprintf(stderr, "Speech_Encode_Frame_init: can not malloc state "
"structure\n"); */
return -1;
}
s->pre_state = NULL;
s->cod_amr_state = NULL;
s->dtx = dtx;
if (Pre_Process_init(&s->pre_state) ||
cod_amr_init(&s->cod_amr_state, s->dtx))
{
Speech_Encode_FrameState** temp = &s;
GSMEncodeFrameExit((void**)temp);
return -1;
}
Speech_Encode_Frame_reset(s);
*state_data = (void *)s;
return 0;
}
/*
------------------------------------------------------------------------------
FUNCTION NAME: Speech_Encode_Frame_reset
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
state = pointer to structures of type Speech_Decode_FrameState
Outputs:
None
Returns:
return_value = set to zero if reset was successful; -1, otherwise (int)
Global Variables Used:
None
Local Variables Needed:
None
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function resets state memory
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
sp_enc.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
int Speech_Encode_Frame_reset (void *state_data)
{
Speech_Encode_FrameState *state =
(Speech_Encode_FrameState *) state_data;
if (state_data == NULL){
fprintf(stderr, "Speech_Encode_Frame_reset
: invalid parameter\n");
return -1;
}
Pre_Process_reset(state->pre_state);
cod_amr_reset(state->cod_amr_state);
setCounter(state->complexityCounter);
Init_WMOPS_counter();
setCounter(0); // set counter to global counter
return 0;
}
------------------------------------------------------------------------------
CAUTION [optional]
[State any special notes, constraints or cautions for users of this function]
------------------------------------------------------------------------------
*/
Word16 Speech_Encode_Frame_reset(void *state_data)
{
Speech_Encode_FrameState *state =
(Speech_Encode_FrameState *) state_data;
if (state_data == NULL)
{
/* fprintf(stderr, "Speech_Encode_Frame_reset
: invalid parameter\n"); */
return -1;
}
Pre_Process_reset(state->pre_state);
cod_amr_reset(state->cod_amr_state);
return 0;
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: GSMEncodeFrameExit
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
state = pointer to a pointer to a structure of type cod_amrState
Outputs:
state points to a NULL address
Returns:
None.
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function frees the memory used for state memory.
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
sp_enc.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
Note: Original function name of Speech_Encode_Frame_exit was changed to
GSMEncodeFrameExit in the Code section.
void Speech_Encode_Frame_exit (void **state_data)
{
Speech_Encode_FrameState **state =
(Speech_Encode_FrameState **) state_data;
if (state == NULL || *state == NULL)
return;
Pre_Process_exit(&(*state)->pre_state);
cod_amr_exit(&(*state)->cod_amr_state);
setCounter((*state)->complexityCounter);
WMOPS_output(0);
setCounter(0); // set counter to global counter
// deallocate memory
free(*state);
*state = NULL;
return;
}
------------------------------------------------------------------------------
CAUTION [optional]
[State any special notes, constraints or cautions for users of this function]
------------------------------------------------------------------------------
*/
void GSMEncodeFrameExit(void **state_data)
{
Speech_Encode_FrameState **state =
(Speech_Encode_FrameState **) state_data;
if (state == NULL || *state == NULL)
return;
Pre_Process_exit(&(*state)->pre_state);
cod_amr_exit(&(*state)->cod_amr_state);
/* deallocate memory */
oscl_free(*state);
*state = NULL;
return;
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: Speech_Encode_Frame_First
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
st = pointer to a structure of type Speech_Encode_FrameState that contains
the post filter states
new_speech = pointer to buffer of length L_FRAME that contains
the speech input (Word16)
Outputs:
The structure of type Speech_Encode_FrameState pointed to by st is updated.
Returns:
return_value = 0 (int)
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function encodes the first frame of speech. It calls the pre-processing
filter and the first frame encoder.
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
sp_enc.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
int Speech_Encode_Frame_First (
Speech_Encode_FrameState *st, // i/o : post filter states
Word16 *new_speech) // i : speech input
{
#if !defined(NO13BIT)
Word16 i;
#endif
setCounter(st->complexityCounter);
#if !defined(NO13BIT)
// Delete the 3 LSBs (13-bit input)
for (i = 0; i < L_NEXT; i++)
{
new_speech[i] = new_speech[i] & 0xfff8;
}
#endif
// filter + downscaling
Pre_Process (st->pre_state, new_speech, L_NEXT);
cod_amr_first(st->cod_amr_state, new_speech);
Init_WMOPS_counter (); // reset WMOPS counter for the new frame
return 0;
}
------------------------------------------------------------------------------
CAUTION [optional]
[State any special notes, constraints or cautions for users of this function]
------------------------------------------------------------------------------
*/
void Speech_Encode_Frame_First(
Speech_Encode_FrameState *st, /* i/o : post filter states */
Word16 *new_speech) /* i : speech input */
{
#if !defined(NO13BIT)
Word16 i;
#endif
#if !defined(NO13BIT)
/* Delete the 3 LSBs (13-bit input) */
for (i = 0; i < L_NEXT; i++)
{
new_speech[i] = new_speech[i] & 0xfff8;
}
#endif
/* filter + downscaling */
Pre_Process(st->pre_state, new_speech, L_NEXT);
cod_amr_first(st->cod_amr_state, new_speech);
return;
}
/*
------------------------------------------------------------------------------
FUNCTION NAME: cod_amr
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
state_data = a void pointer to the post filter states
mode = AMR mode of type enum Mode
new_speech = pointer to buffer of length L_FRAME that contains
the speech input of type Word16
serial = pointer to the serial bit stream of type Word16
usedMode = pointer to the used mode of type enum Mode
Outputs:
serial -> encoded serial bit stream
The value pointed to by usedMode is updated.
Returns:
return_value = 0 (int)
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function is the entry point to the GSM AMR encoder. The following
operations are performed to generate one encoded frame: First, the incoming
audio samples are passed through the pre-processing filter where they are
filtered and downscaled. A call is then made to the main encoder cod_amr().
This generates the set of encoded parameters which include the LSP, adaptive
codebook, and fixed codebook quantization indices (addresses and gains). The
generated parameters are then converted to serial bits.
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
sp_enc.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
Note: Original function name of Speech_Encode_Frame was changed to
GSMEncodeFrame in the Code section.
int Speech_Encode_Frame (
void *state_data, // i/o : post filter states
enum Mode mode, // i : speech coder mode
Word16 *new_speech, // i : speech input
Word16 *serial, // o : serial bit stream
enum Mode *usedMode // o : used speech coder mode
)
{
Speech_Encode_FrameState *st =
(Speech_Encode_FrameState *) state_data;
Word16 prm[MAX_PRM_SIZE]; // Analysis parameters
Word16 syn[L_FRAME]; // Buffer for synthesis speech
Word16 i;
setCounter(st->complexityCounter);
Reset_WMOPS_counter (); // reset WMOPS counter for the new frame
// initialize the serial output frame to zero
for (i = 0; i < MAX_SERIAL_SIZE; i++)
{
serial[i] = 0;
}
#if !defined(NO13BIT)
// Delete the 3 LSBs (13-bit input)
for (i = 0; i < L_FRAME; i++)
{
new_speech[i] = new_speech[i] & 0xfff8;
}
#endif
// filter + downscaling
Pre_Process (st->pre_state, new_speech, L_FRAME);
// Call the speech encoder
cod_amr(st->cod_amr_state, mode, new_speech, prm, usedMode, syn);
// Parameters to serial bits
Prm2bits (*usedMode, prm, &serial[0]);
fwc();
setCounter(0); // set counter to global counter
return 0;
}
------------------------------------------------------------------------------
CAUTION [optional]
[State any special notes, constraints or cautions for users of this function]
------------------------------------------------------------------------------
*/
void GSMEncodeFrame(
void *state_data, /* i/o : post filter states */
enum Mode mode, /* i : speech coder mode */
Word16 *new_speech, /* i : speech input */
Word16 *serial, /* o : serial bit stream */
enum Mode *usedMode /* o : used speech coder mode */
)
{
Speech_Encode_FrameState *st =
(Speech_Encode_FrameState *) state_data;
Word16 prm[MAX_PRM_SIZE]; /* Analysis parameters. */
Word16 syn[L_FRAME]; /* Buffer for synthesis speech */
Word16 i;
/* initialize the serial output frame to zero */
for (i = 0; i < MAX_SERIAL_SIZE; i++)
{
serial[i] = 0;
}
#if !defined(NO13BIT)
/* Delete the 3 LSBs (13-bit input) */
for (i = 0; i < L_FRAME; i++)
{
new_speech[i] = new_speech[i] & 0xfff8;
}
#endif
/* filter + downscaling */
Pre_Process(st->pre_state, new_speech, L_FRAME);
/* Call the speech encoder */
cod_amr(st->cod_amr_state, mode, new_speech, prm, usedMode, syn);
/* Parameters to serial bits */
Prm2bits(*usedMode, prm, &serial[0], &(st->cod_amr_state->common_amr_tbls));
return;
}
|