annotate libtwamr/dec_gain.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 5ccfe176bae1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
356
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 ********************************************************************************
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 *
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 * GSM AMR-NB speech codec R98 Version 7.6.0 December 12, 2001
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 * R99 Version 3.3.0
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * REL-4 Version 4.1.0
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 *
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 ********************************************************************************
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 *
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 * File : dec_gain.h
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 * Purpose : Decode the pitch and codebook gains
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 *
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 ********************************************************************************
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 #ifndef dec_gain_h
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 #define dec_gain_h "$Id $"
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 /*
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 ********************************************************************************
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 * INCLUDE FILES
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 ********************************************************************************
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 #include "tw_amr.h"
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 #include "typedef.h"
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 #include "gc_pred.h"
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 /*
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 ********************************************************************************
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 * DECLARATION OF PROTOTYPES
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 ********************************************************************************
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 /*************************************************************************
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 *
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 * FUNCTION: Dec_gain()
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 *
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 * PURPOSE: Decode the pitch and codebook gains
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 *
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 ************************************************************************/
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 void Dec_gain(
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 gc_predState *pred_state, /* i/o: MA predictor state */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 enum Mode mode, /* i : AMR mode */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 Word16 index, /* i : index of quantization. */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44 Word16 code[], /* i : Innovative vector. */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 Word16 evenSubfr, /* i : Flag for even subframes */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46 Word16 * gain_pit, /* o : Pitch gain. */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 Word16 * gain_cod /* o : Code gain. */
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48 );
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
49
5ccfe176bae1 libtwamr: integrate dec_gain.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50 #endif