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