annotate libtwamr/d2_9pf.h @ 478:936a08cc73ce

doc/AMR-library-API: describe the decoder
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 19 May 2024 21:32:31 +0000
parents 2303ba1490dd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
332
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 *
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 * GSM AMR-NB speech codec R98 Version 7.6.0 December 12, 2001
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 * R99 Version 3.3.0
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * REL-4 Version 4.1.0
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 *
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 *
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 * File : d2_9pf.h
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 * Purpose : Algebraic codebook decoder
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 *
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 #ifndef d2_9pf_h
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 #define d2_9pf_h "$Id $"
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 /*
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 * INCLUDE FILES
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 #include "typedef.h"
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 /*
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 * LOCAL VARIABLES AND TABLES
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 /*
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 * DEFINITION OF DATA TYPES
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 /*
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 * DECLARATION OF PROTOTYPES
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 *****************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 /*************************************************************************
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 *
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44 * FUNCTION: decode_2i40_9bits (decod_ACELP())
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 *
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46 * PURPOSE: Algebraic codebook decoder for 2 pulses coded with 9 bits
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 *
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48 *************************************************************************/
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
49
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50 void decode_2i40_9bits(
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
51 Word16 subNr, /* i : subframe number */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52 Word16 sign, /* i : signs of 2 pulses. */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
53 Word16 index, /* i : Positions of the 2 pulses. */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
54 Word16 cod[] /* o : algebraic (fixed) codebook excitation */
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
55 );
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
56
2303ba1490dd libtwamr: integrate d2_9pf.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
57 #endif