annotate libtwamr/pow2.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 190c4c9a3693
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
337
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 *
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 * GSM AMR-NB speech codec R98 Version 7.6.0 December 12, 2001
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 * R99 Version 3.3.0
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * REL-4 Version 4.1.0
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 *
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 *
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 * File : pow2.h
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 * Purpose : computes L_x = pow(2.0, exponent.fraction)
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 *
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 */
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 #ifndef pow2_h
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 #define pow2_h "$Id $"
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 /*
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 * INCLUDE FILES
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 */
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 #include "typedef.h"
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 /*
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 * DEFINITION OF DATA TYPES
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 */
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 /*
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 * DECLARATION OF PROTOTYPES
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 ********************************************************************************
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 */
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 Word32 Pow2 ( /* (o) : result (range: 0<=val<=0x7fffffff) */
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 Word16 exponent, /* (i) : Integer part. (range: 0<=val<=30) */
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 Word16 fraction /* (i) : Fractional part. (range: 0.0<=val<1.0) */
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 );
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40
190c4c9a3693 libtwamr: integrate pow2.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 #endif