FreeCalypso > hg > gsm-codec-lib
annotate libtwamr/d_gain_p.h @ 480:332397bc80aa
doc/AMR-library-API: document public const data items
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Sun, 19 May 2024 23:18:17 +0000 |
parents | e18452a4fbac |
children |
rev | line source |
---|---|
340
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
1 /* |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
2 ******************************************************************************** |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
3 * |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
4 * GSM AMR-NB speech codec R98 Version 7.6.0 December 12, 2001 |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
5 * R99 Version 3.3.0 |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
6 * REL-4 Version 4.1.0 |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
7 * |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
8 ******************************************************************************** |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
9 * |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
10 * File : d_gain_p.h |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
11 * Purpose : Decodes the pitch gain using the received index. |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
12 * |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
13 ******************************************************************************** |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
14 */ |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
15 #ifndef d_gain_p_h |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
16 #define d_gain_p_h "$Id $" |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
17 |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
18 /* |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
19 ******************************************************************************** |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
20 * INCLUDE FILES |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
21 ******************************************************************************** |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
22 */ |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
23 #include "tw_amr.h" |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
24 #include "typedef.h" |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
25 |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
26 /* |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
27 ************************************************************************** |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
28 * |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
29 * Function : d_gain_pitch |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
30 * Purpose : Decodes the pitch gain using the received index. |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
31 * Description : In case of no frame erasure, the gain is obtained |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
32 * from the quantization table at the given index; |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
33 * otherwise, a downscaled past gain is used. |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
34 * Returns : Quantized pitch gain |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
35 * |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
36 ************************************************************************** |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
37 */ |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
38 Word16 d_gain_pitch ( /* return value: gain (Q14) */ |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
39 enum Mode mode, /* i : AMR mode */ |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
40 Word16 index /* i : index of quantization */ |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
41 ); |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
42 |
e18452a4fbac
libtwamr: integrate d_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
43 #endif |