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
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
|
/* ------------------------------------------------------------------
* 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/ec_gain.c
Funtions:
Date: 01/28/2002
------------------------------------------------------------------------------
REVISION HISTORY
Description: Removed the functions ec_gain_code_init, ec_gain_pitch_init,
ech_gain_code_exit, and ec_gain_pitch_exit.
The ec_gains related structures are no longer dynamically allocated.
Description: Updated include files and input/output sections.
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: Added #ifdef __cplusplus around extern'ed table.
Description:
------------------------------------------------------------------------------
MODULE DESCRIPTION
These modules execute the code book gains for error concealment. This module
contains the init, reset, exit, and "main" functions in this process.
------------------------------------------------------------------------------
*/
/*----------------------------------------------------------------------------
; INCLUDES
----------------------------------------------------------------------------*/
#include "ec_gains.h"
#include "typedef.h"
#include "cnst.h"
#include "gmed_n.h"
#include "gc_pred.h"
#include "basic_op.h"
/*--------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C"
{
#endif
/*----------------------------------------------------------------------------
; 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
----------------------------------------------------------------------------*/
extern const Word16 qua_gain_pitch[];
extern const Word16 qua_gain_code[];
/*--------------------------------------------------------------------------*/
#ifdef __cplusplus
}
#endif
/*
------------------------------------------------------------------------------
FUNCTION NAME: ec_gain_code_reset
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
state = pointer to a pointer to a structure containing code state data of
stucture type ec_gain_codeState
Outputs:
None.
Returns:
None
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function resets the state data for the ec_gain module.
------------------------------------------------------------------------------
REQUIREMENTS
None
------------------------------------------------------------------------------
REFERENCES
None
------------------------------------------------------------------------------
PSEUDO-CODE
int ec_gain_code_reset (ec_gain_codeState *state)
{
Word16 i;
if (state == (ec_gain_codeState *) NULL){
// fprintf(stderr, "ec_gain_code_reset: invalid parameter\n");
return -1;
}
for ( i = 0; i < 5; i++)
state->gbuf[i] = 1;
state->past_gain_code = 0;
state->prev_gc = 1;
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 ec_gain_code_reset(ec_gain_codeState *state)
{
Word16 i;
if (state == (ec_gain_codeState *) NULL)
{
/* fprintf(stderr, "ec_gain_code_reset: invalid parameter\n"); */
return -1;
}
for (i = 0; i < 5; i++)
state->gbuf[i] = 1;
state->past_gain_code = 0;
state->prev_gc = 1;
return 0;
}
/*
------------------------------------------------------------------------------
FUNCTION NAME: ec_gain_code
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
st = pointer to a pointer to a structure containing code state data of
stucture type ec_gain_codeState
pred_state = pointer to MA predictor state of type gc_predState
state = state of the state machine of type Word16
gain_code = pointer to decoded innovation gain of type Word16
pOverflow = pointer to overflow indicator of type Flag
Outputs:
st = pointer to a pointer to a structure containing code state data of
stucture type ec_gain_codeState
pred_state = pointer to MA predictor state of type gc_predState
pOverflow = 1 if there is an overflow else it is zero.
Returns:
None.
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function does error concealment using the codebook. Call this function
only in BFI (instead of normal gain decoding function).
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
ec_gain.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
static const Word16 cdown[7] =
{
32767, 32112, 32112, 32112,
32112, 32112, 22937
};
Word16 tmp;
Word16 qua_ener_MR122;
Word16 qua_ener;
// calculate median of last five gain values
tmp = gmed_n (st->gbuf,5);
// new gain = minimum(median, past_gain) * cdown[state]
if (sub (tmp, st->past_gain_code) > 0)
{
tmp = st->past_gain_code;
}
tmp = mult (tmp, cdown[state]);
*gain_code = tmp;
// update table of past quantized energies with average of
// current values
gc_pred_average_limited(pred_state, &qua_ener_MR122, &qua_ener);
gc_pred_update(pred_state, qua_ener_MR122, qua_ener);
}
------------------------------------------------------------------------------
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 ec_gain_code(
ec_gain_codeState *st, /* i/o : State struct */
gc_predState *pred_state, /* i/o : MA predictor state */
Word16 state, /* i : state of the state machine */
Word16 *gain_code, /* o : decoded innovation gain */
Flag *pOverflow
)
{
static const Word16 cdown[7] =
{
32767, 32112, 32112, 32112,
32112, 32112, 22937
};
Word16 tmp;
Word16 qua_ener_MR122;
Word16 qua_ener;
/* calculate median of last five gain values */
tmp = gmed_n(st->gbuf, 5);
/* new gain = minimum(median, past_gain) * cdown[state] */
if (sub(tmp, st->past_gain_code, pOverflow) > 0)
{
tmp = st->past_gain_code;
}
tmp = mult(tmp, cdown[state], pOverflow);
*gain_code = tmp;
/* update table of past quantized energies with average of
* current values
*/
gc_pred_average_limited(pred_state, &qua_ener_MR122, &qua_ener, pOverflow);
gc_pred_update(pred_state, qua_ener_MR122, qua_ener);
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: ec_gain_code_update
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
st = pointer to a pointer to a structure containing code state data of
stucture type ec_gain_codeState
bfi = a flag that indicates if the frame is bad of type Word16
prev_bf = a flag that indicates if the previous frame was bad of type Word16
gain_code = pointer to decoded innovation gain of type Word16
pOverflow = pointer to overflow indicator of type Flag
Outputs:
st = pointer to a pointer to a structure containing code state data of
stucture type ec_gain_codeState
gain_code = pointer to decoded innovation gain of type Word16
pOverflow = 1 if there is an overflow else it is zero.
Returns:
None.
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
Purpose : update the codebook gain concealment state;
limit gain_code if the previous frame was bad
Call this function always after decoding (or concealing)
the gain
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
ec_gain.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
Word16 i;
// limit gain_code by previous good gain if previous frame was bad
if (bfi == 0)
{
if (prev_bf != 0)
{
if (sub (*gain_code, st->prev_gc) > 0)
{
*gain_code = st->prev_gc;
}
}
st->prev_gc = *gain_code;
}
// update EC states: previous gain, gain buffer
st->past_gain_code = *gain_code;
for (i = 1; i < 5; i++)
{
st->gbuf[i - 1] = st->gbuf[i];
}
st->gbuf[4] = *gain_code;
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 ec_gain_code_update(
ec_gain_codeState *st, /* i/o : State struct */
Word16 bfi, /* i : flag: frame is bad */
Word16 prev_bf, /* i : flag: previous frame was bad */
Word16 *gain_code, /* i/o : decoded innovation gain */
Flag *pOverflow
)
{
Word16 i;
/* limit gain_code by previous good gain if previous frame was bad */
if (bfi == 0)
{
if (prev_bf != 0)
{
if (sub(*gain_code, st->prev_gc, pOverflow) > 0)
{
*gain_code = st->prev_gc;
}
}
st->prev_gc = *gain_code;
}
/* update EC states: previous gain, gain buffer */
st->past_gain_code = *gain_code;
for (i = 1; i < 5; i++)
{
st->gbuf[i - 1] = st->gbuf[i];
}
st->gbuf[4] = *gain_code;
return;
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: ec_gain_pitch
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
st = pointer to a pointer to a structure containing code
state data of stucture type ec_gain_pitchState
state = state of the state machine of type Word16
pOverflow = pointer to overflow indicator of type Flag
Outputs:
state = pointer to a pointer to a structure containing code
state data of stucture type ec_gain_pitchState
gain_pitch = pointer to pitch gain (Q14) of type Word16
pOverflow = 1 if there is an overflow else it is zero.
Returns:
None.
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
This function conceals the error using code gain implementation in this
function.
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
ec_gain.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
static const Word16 pdown[7] =
{
32767, 32112, 32112, 26214,
9830, 6553, 6553
};
Word16 tmp;
// calculate median of last five gains
tmp = gmed_n (st->pbuf, 5);
// new gain = minimum(median, past_gain) * pdown[state]
if (sub (tmp, st->past_gain_pit) > 0)
{
tmp = st->past_gain_pit;
}
*gain_pitch = mult (tmp, pdown[state]);
------------------------------------------------------------------------------
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 ec_gain_pitch(
ec_gain_pitchState *st, /* i/o : state variables */
Word16 state, /* i : state of the state machine */
Word16 *gain_pitch, /* o : pitch gain (Q14) */
Flag *pOverflow
)
{
static const Word16 pdown[7] =
{
32767, 32112, 32112, 26214,
9830, 6553, 6553
};
Word16 tmp;
/* calculate median of last five gains */
tmp = gmed_n(st->pbuf, 5);
/* new gain = minimum(median, past_gain) * pdown[state] */
if (sub(tmp, st->past_gain_pit, pOverflow) > 0)
{
tmp = st->past_gain_pit;
}
*gain_pitch = mult(tmp, pdown[state], pOverflow);
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: ec_gain_pitch_reset
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
state = state of the state machine of type Word16
pOverflow = pointer to overflow indicator of type Flag
Outputs:
state = pointer to a pointer to a structure containing code
state data of stucture type ec_gain_pitchState
pOverflow = 1 if there is an overflow else it is zero.
Returns:
None.
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
Function: ec_gain_pitch_reset
Purpose: Resets state memory
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
ec_gain.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
int ec_gain_pitch_reset (ec_gain_pitchState *state)
{
Word16 i;
if (state == (ec_gain_pitchState *) NULL){
// fprintf(stderr, "ec_gain_pitch_reset: invalid parameter\n");
return -1;
}
for(i = 0; i < 5; i++)
state->pbuf[i] = 1640;
state->past_gain_pit = 0;
state->prev_gp = 16384;
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 ec_gain_pitch_reset(ec_gain_pitchState *state)
{
Word16 i;
if (state == (ec_gain_pitchState *) NULL)
{
/* fprintf(stderr, "ec_gain_pitch_reset: invalid parameter\n"); */
return -1;
}
for (i = 0; i < 5; i++)
state->pbuf[i] = 1640;
state->past_gain_pit = 0;
state->prev_gp = 16384;
return 0;
}
/****************************************************************************/
/*
------------------------------------------------------------------------------
FUNCTION NAME: ec_gain_pitch_update
------------------------------------------------------------------------------
INPUT AND OUTPUT DEFINITIONS
Inputs:
st = pointer to a pointer to a structure containing code
state data of stucture type ec_gain_pitchState
bfi = flag indicating the frame is bad of type Word16
prev_bf = flag indicating the previous frame was bad of type Word16
gain_pitch = pointer to pitch gain of type Word16
pOverflow = pointer to overflow indicator of type Flag
Outputs:
state = pointer to a pointer to a structure containing code
state data of stucture type ec_gain_pitchState
gain_pitch = pointer to pitch gain of type Word16
pOverflow = 1 if there is an overflow else it is zero.
Returns:
None.
Global Variables Used:
None.
Local Variables Needed:
None.
------------------------------------------------------------------------------
FUNCTION DESCRIPTION
Purpose : update the pitch gain concealment state;
limit gain_pitch if the previous frame was bad
Call this function always after decoding (or concealing)
the gain
------------------------------------------------------------------------------
REQUIREMENTS
None.
------------------------------------------------------------------------------
REFERENCES
ec_gain.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
------------------------------------------------------------------------------
PSEUDO-CODE
Word16 i;
if (bfi == 0)
{
if (prev_bf != 0)
{
if (sub (*gain_pitch, st->prev_gp) > 0)
{
*gain_pitch = st->prev_gp;
}
}
st->prev_gp = *gain_pitch;
}
st->past_gain_pit = *gain_pitch;
if (sub (st->past_gain_pit, 16384) > 0) // if (st->past_gain_pit > 1.0)
{
st->past_gain_pit = 16384;
}
for (i = 1; i < 5; i++)
{
st->pbuf[i - 1] = st->pbuf[i];
}
st->pbuf[4] = st->past_gain_pit;
------------------------------------------------------------------------------
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 ec_gain_pitch_update(
ec_gain_pitchState *st, /* i/o : state variables */
Word16 bfi, /* i : flag: frame is bad */
Word16 prev_bf, /* i : flag: previous frame was bad */
Word16 *gain_pitch, /* i/o : pitch gain */
Flag *pOverflow
)
{
Word16 i;
if (bfi == 0)
{
if (prev_bf != 0)
{
if (sub(*gain_pitch, st->prev_gp, pOverflow) > 0)
{
*gain_pitch = st->prev_gp;
}
}
st->prev_gp = *gain_pitch;
}
st->past_gain_pit = *gain_pitch;
if (sub(st->past_gain_pit, 16384, pOverflow) > 0)
/* if (st->past_gain_pit > 1.0) */
{
st->past_gain_pit = 16384;
}
for (i = 1; i < 5; i++)
{
st->pbuf[i - 1] = st->pbuf[i];
}
st->pbuf[4] = st->past_gain_pit;
}
|