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
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
|
/* ------------------------------------------------------------------
* 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/sp_dec.c
Functions: GSMInitDecode
Speech_Decode_Frame_reset
GSMDecodeFrameExit
GSMFrameDecode
Date: 08/03/2001
------------------------------------------------------------------------------
REVISION HISTORY
Description: Add PV coding template. Filled out template sections and
reformatted code to follow C coding standard. Removed code that
handles SID in GSMFrameDecode.
Description: Made the following changes per comments from Phase 2/3 review:
1. Updated to more recent PV C coding template.
2. Took out all the tabs in the file and replaced with spaces.
3. Deleted bit_offset from input list of GSMFrameDecode.
Description: Changing several variables passed into these functions of type
Speech_Decode_FrameState to type void.
Description: Cleaning up brackets and line spacing for statements with
brackets as per a review comments.
Description: Synchronized file with UMTS version 3.2.0. Removed unnecessary
include files.
Description: Removed all references to malloc/free, except for the top-level
malloc in GSMInitDecode, and corresponding free in GSMDecodeFrameExit.
Also, modified function calls throughout to reflect the fact that the members
of the structure Decoder_amrState are no longer pointers to be set via
malloc, but full-blown structures. (Changes of the type D_plsfState *lsfState
to D_plsfState lsfState)
Description: Created overflow and pass the variable into the decoder.
Description: Changed inititlaization of the pointer to overflow flag. Removed
code related to MOPS counter.
Description: Replaced OSCL mem type functions and eliminated include
files that now are chosen by OSCL definitions
Description: Replaced "int" and/or "char" with defined types.
Added proper casting (Word32) to some left shifting operations
Description:
------------------------------------------------------------------------------
MODULE DESCRIPTION
This file contains the functions that initialize, invoke, reset, and exit
the GSM AMR decoder.
------------------------------------------------------------------------------
*/
/*----------------------------------------------------------------------------
; INCLUDES
----------------------------------------------------------------------------*/
#include <stdlib.h>
#include "sp_dec.h"
#include "typedef.h"
#include "cnst.h"
#include "dec_amr.h"
#include "pstfilt.h"
#include "bits2prm.h"
#include "mode.h"
#include "post_pro.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: GSMInitDecode
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
state = pointer to an array of pointers to structures of type
Speech_Decode_FrameState
no_hp_post_MR122 = flag to turn off high-pass post filter for 12.2 kbps
mode (Flag)
id = pointer to an array whose contents are of type char
Outputs:
decoder_amrState field of the structure pointed to by the pointer pointed
to by state is set to NULL
post_state field of the structure pointed to by the pointer pointed to
by state is set to NULL
postHP_state field of the structure pointed to by the pointer pointed to
by state is set to NULL
no_hp_post_MR122 field of the structure pointed to by the pointer pointed
to by state is set to the input no_hp_post_MR122
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 used by the GSM AMR decoder.
------------------------------------------------------------------------------
REQUIREMENTS
None
------------------------------------------------------------------------------
REFERENCES
sp_dec.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
Note: Original function name of Speech_Decode_Frame_init was changed to
GSMInitDecode in the Code section.
int Speech_Decode_Frame_init (Speech_Decode_FrameState **state,
char *id)
{
Speech_Decode_FrameState* s;
if (state == (Speech_Decode_FrameState **) NULL){
fprintf(stderr, "Speech_Decode_Frame_init: invalid parameter\n");
return -1;
}
*state = NULL;
// allocate memory
if ((s= (Speech_Decode_FrameState *)
malloc(sizeof(Speech_Decode_FrameState))) == NULL) {
fprintf(stderr, "Speech_Decode_Frame_init: can not malloc state "
"structure\n");
return -1;
}
s->decoder_amrState = NULL;
s->post_state = NULL;
s->postHP_state = NULL;
if (Decoder_amr_init(&s->decoder_amrState) ||
Post_Filter_init(&s->post_state) ||
Post_Process_init(&s->postHP_state) ) {
Speech_Decode_Frame_exit(&s);
return -1;
}
s->complexityCounter = getCounterId(id);
Speech_Decode_Frame_reset(s);
*state = s;
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 GSMInitDecode(void **state_data,
Word8 * id)
{
Speech_Decode_FrameState* s;
OSCL_UNUSED_ARG(id);
if (state_data == NULL)
{
/* fprintf(stderr, "Speech_Decode_Frame_init:
invalid parameter\n"); */
return (-1);
}
*state_data = NULL;
/* allocate memory */
if ((s = (Speech_Decode_FrameState *)
malloc(sizeof(Speech_Decode_FrameState))) == NULL)
{
/* fprintf(stderr, "Speech_Decode_Frame_init: can not malloc state "
"structure\n"); */
return (-1);
}
if (Decoder_amr_init(&s->decoder_amrState)
|| Post_Process_reset(&s->postHP_state))
{
Speech_Decode_FrameState *tmp = s;
/*
* dereferencing type-punned pointer avoid
* breaking strict-aliasing rules
*/
void** tempVoid = (void**) tmp;
GSMDecodeFrameExit(tempVoid);
return (-1);
}
Speech_Decode_Frame_reset(s);
*state_data = (void *)s;
return (0);
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: Speech_Decode_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 the state memory used by the GSM AMR decoder.
------------------------------------------------------------------------------
REQUIREMENTS
None
------------------------------------------------------------------------------
REFERENCES
sp_dec.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
int Speech_Decode_Frame_reset (Speech_Decode_FrameState *state)
{
if (state == (Speech_Decode_FrameState *) NULL){
fprintf(stderr, "Speech_Decode_Frame_reset: invalid parameter\n");
return -1;
}
Decoder_amr_reset(state->decoder_amrState, (enum Mode)0);
Post_Filter_reset(state->post_state);
Post_Process_reset(state->postHP_state);
state->prev_mode = (enum Mode)0;
setCounter(state->complexityCounter);
Init_WMOPS_counter();
setCounter(0); // set counter to global counter
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 Speech_Decode_Frame_reset(void *state_data)
{
Speech_Decode_FrameState *state =
(Speech_Decode_FrameState *) state_data;
if (state_data == NULL)
{
/* fprintf(stderr, "Speech_Decode_Frame_reset:
invalid parameter\n"); */
return (-1);
}
Decoder_amr_reset(&(state->decoder_amrState), MR475);
Post_Filter_reset(&(state->post_state));
Post_Process_reset(&(state->postHP_state));
state->prev_mode = MR475;
return (0);
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: GSMDecodeFrameExit
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
state = pointer to an array of pointers to structures of type
Speech_Decode_FrameState
Outputs:
state contents is set to NULL
Returns:
None
Global Variables Used:
None
Local Variables Needed:
None
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function frees up the memory used for the state memory of the GSM AMR
decoder.
------------------------------------------------------------------------------
REQUIREMENTS
None
------------------------------------------------------------------------------
REFERENCES
sp_dec.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
Note: The original function name of Speech_Decode_Frame_exit was changed to
GSMDecodeFrameExit in the Code section.
void Speech_Decode_Frame_exit (Speech_Decode_FrameState **state)
{
if (state == NULL || *state == NULL)
return;
Decoder_amr_exit(&(*state)->decoder_amrState);
Post_Filter_exit(&(*state)->post_state);
Post_Process_exit(&(*state)->postHP_state);
setCounter((*state)->complexityCounter);
WMOPS_output(0);
setCounter(0); // set counter to global counter
// deallocate memory
free(*state);
*state = NULL;
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 GSMDecodeFrameExit(void **state_data)
{
Speech_Decode_FrameState **state =
(Speech_Decode_FrameState **) state_data;
if (state == NULL || *state == NULL)
{
return;
}
/* deallocate memory */
free(*state);
*state = NULL;
return;
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: GSMFrameDecode
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
st = pointer to structures of type Speech_Decode_FrameState
mode = GSM AMR codec mode (enum Mode)
serial = pointer to the serial bit stream buffer (unsigned char)
frame_type = GSM AMR receive frame type (enum RXFrameType)
synth = pointer to the output synthesis speech buffer (Word16)
Outputs:
synth contents are truncated to 13 bits if NO13BIT is not defined,
otherwise, its contents are left at 16 bits
Returns:
return_value = set to zero (int)
Global Variables Used:
None
Local Variables Needed:
None
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function is the entry point to the GSM AMR decoder. The following
operations are performed on one received frame: First, the codec
parameters are parsed from the buffer pointed to by serial according to
frame_type. Then the AMR decoder is invoked via a call to Decoder_amr. Post
filtering of the decoded data is done via a call to Post_Filter function.
Lastly, the decoded data is post-processed via a call to Post_Process
function. If NO13BIT is not defined, the contents of the buffer pointed to
by synth is truncated to 13 bits. It remains unchanged otherwise.
------------------------------------------------------------------------------
REQUIREMENTS
None
------------------------------------------------------------------------------
REFERENCES
sp_dec.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
Note: The original function name of Speech_Decode_Frame_exit was changed to
GSMFrameDecode in the Code section.
int Speech_Decode_Frame (
Speech_Decode_FrameState *st, // io: post filter states
enum Mode mode, // i : AMR mode
Word16 *serial, // i : serial bit stream
enum RXFrameType frame_type, // i : Frame type
Word16 *synth // o : synthesis speech (postfiltered
// output)
)
{
Word16 parm[MAX_PRM_SIZE + 1]; // Synthesis parameters
Word16 Az_dec[AZ_SIZE]; // Decoded Az for post-filter
// in 4 subframes
#if !defined(NO13BIT)
Word16 i;
#endif
setCounter(st->complexityCounter);
Reset_WMOPS_counter (); // reset WMOPS counter for the new frame
// Serial to parameters
if ((frame_type == RX_SID_BAD) ||
(frame_type == RX_SID_UPDATE)) {
// Override mode to MRDTX
Bits2prm (MRDTX, serial, parm);
} else {
Bits2prm (mode, serial, parm);
}
// Synthesis
Decoder_amr(st->decoder_amrState, mode, parm, frame_type,
synth, Az_dec);
Post_Filter(st->post_state, mode, synth, Az_dec); // Post-filter
// post HP filter, and 15->16 bits
Post_Process(st->postHP_state, synth, L_FRAME);
#if !defined(NO13BIT)
// Truncate to 13 bits
for (i = 0; i < L_FRAME; i++)
{
synth[i] = synth[i] & 0xfff8;
}
#endif
setCounter(0); // set counter to global counter
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]
------------------------------------------------------------------------------
*/
void GSMFrameDecode(
Speech_Decode_FrameState *st, /* io: post filter states */
enum Mode mode, /* i : AMR mode */
Word16 *serial, /* i : serial bit stream */
enum RXFrameType frame_type, /* i : Frame type */
Word16 *synth) /* o : synthesis speech (postfiltered */
/* output) */
{
Word16 parm[MAX_PRM_SIZE + 1]; /* Synthesis parameters */
Word16 Az_dec[AZ_SIZE]; /* Decoded Az for post-filter */
/* in 4 subframes */
Flag *pOverflow = &(st->decoder_amrState.overflow); /* Overflow flag */
#if !defined(NO13BIT)
Word16 i;
#endif
/* Serial to parameters */
if ((frame_type == RX_SID_BAD) ||
(frame_type == RX_SID_UPDATE))
{
/* Override mode to MRDTX */
Bits2prm(MRDTX, serial, parm);
}
else
{
Bits2prm(mode, serial, parm);
}
/* Synthesis */
Decoder_amr(
&(st->decoder_amrState),
mode,
parm,
frame_type,
synth,
Az_dec);
/* Post-filter */
Post_Filter(
&(st->post_state),
mode,
synth,
Az_dec,
pOverflow);
/* post HP filter, and 15->16 bits */
Post_Process(
&(st->postHP_state),
synth,
L_FRAME,
pOverflow);
#if !defined(NO13BIT)
/* Truncate to 13 bits */
for (i = 0; i < L_FRAME; i++)
{
synth[i] = synth[i] & 0xfff8;
}
#endif
return;
}
|