annotate libtwamr/q_gain_p.h @ 483:4f13db3a7086

doc/Utils-overview: document new utilities
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 20 May 2024 01:26:12 +0000
parents a01de4e40540
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
369
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 *
a01de4e40540 libtwamr: integrate q_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
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 * R99 Version 3.3.0
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * REL-4 Version 4.1.0
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 *
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 *
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 * File : q_gain_p.h
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 * Purpose : Scalar quantization of the pitch gain
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 *
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 #ifndef q_gain_p_h
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 #define q_gain_p_h "$Id $"
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 /*
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 * INCLUDE FILES
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 #include "tw_amr.h"
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 #include "typedef.h"
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 /*
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 * DEFINITION OF DATA TYPES
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 /*
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 * DECLARATION OF PROTOTYPES
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 ********************************************************************************
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 Word16 q_gain_pitch ( /* Return index of quantization */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 enum Mode mode, /* i : AMR mode */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 Word16 gp_limit, /* i : pitch gain limit */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 Word16 *gain, /* i/o: Pitch gain (unquant/quant), Q14 */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 Word16 gain_cand[], /* o : pitch gain candidates (3), MR795 only, Q14 */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 Word16 gain_cind[] /* o : pitch gain cand. indices (3),MR795 only, Q0 */
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 );
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44
a01de4e40540 libtwamr: integrate q_gain_p.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 #endif