annotate libtwamr/set_sign.h @ 536:a3300483ae74

doc/FR1-library-API: document return value from gsmfr_tfo_xfrm_*
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 21 Sep 2024 20:48:58 +0000
parents 15c354f75110
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
314
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 *
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 * GSM AMR-NB speech codec R98 Version 7.6.0 December 12, 2001
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 * R99 Version 3.3.0
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * REL-4 Version 4.1.0
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 *
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 *
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 * File : set_sign.h
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 * Purpose : Builds sign vector according to "dn[]" and "cn[]".
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 *
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 /*
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 * MODULE INCLUDE FILE AND VERSION ID
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 #ifndef set_sign_h
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 #define set_sign_h "@(#)$Id $"
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 /*
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 * INCLUDE FILES
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 #include "typedef.h"
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 /*
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 * DECLARATION OF PROTOTYPES
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 ********************************************************************************
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 void set_sign(Word16 dn[], /* i/o : correlation between target and h[] */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 Word16 sign[], /* o : sign of dn[] */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 Word16 dn2[], /* o : maximum of correlation in each track. */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 Word16 n /* i : # of maximum correlations in dn2[] */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 );
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 void set_sign12k2 (
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 Word16 dn[], /* i/o : correlation between target and h[] */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 Word16 cn[], /* i : residual after long term prediction */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 Word16 sign[], /* o : sign of d[n] */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44 Word16 pos_max[], /* o : position of maximum correlation */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 Word16 nb_track, /* i : number of tracks tracks */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46 Word16 ipos[], /* o : starting position for each pulse */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 Word16 step /* i : the step size in the tracks */
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48 );
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
49
15c354f75110 libtwamr: integrate set_sign.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50 #endif