mer feb 12 14:56:57 CET 2003
[asterisk/asterisk.git] / codecs / lpc10 / dyptrk.c
1 /*
2
3 $Log$
4 Revision 1.14  2003/02/12 13:59:15  matteo
5 mer feb 12 14:56:57 CET 2003
6
7 Revision 1.1.1.1  2003/02/12 13:59:15  matteo
8 mer feb 12 14:56:57 CET 2003
9
10 Revision 1.2  2000/01/05 08:20:39  markster
11 Some OSS fixes and a few lpc changes to make it actually work
12
13  * Revision 1.2  1996/08/20  20:25:29  jaf
14  * Removed all static local variables that were SAVE'd in the Fortran
15  * code, and put them in struct lpc10_encoder_state that is passed as an
16  * argument.
17  *
18  * Removed init function, since all initialization is now done in
19  * init_lpc10_encoder_state().
20  *
21  * Revision 1.1  1996/08/19  22:32:26  jaf
22  * Initial revision
23  *
24
25 */
26
27 #ifdef P_R_O_T_O_T_Y_P_E_S
28 extern int dyptrk_(real *amdf, integer *ltau, integer *minptr, integer *voice, integer *pitch, integer *midx, struct lpc10_encoder_state *st);
29 /* comlen contrl_ 12 */
30 #endif
31
32 /*  -- translated by f2c (version 19951025).
33    You must link the resulting object file with the libraries:
34         -lf2c -lm   (in that order)
35 */
36
37 #include "f2c.h"
38
39 /* Common Block Declarations */
40
41 extern struct {
42     integer order, lframe;
43     logical corrp;
44 } contrl_;
45
46 #define contrl_1 contrl_
47
48 /* ********************************************************************* */
49
50 /*      DYPTRK Version 52 */
51
52 /* $Log$
53  * Revision 1.14  2003/02/12 13:59:15  matteo
54  * mer feb 12 14:56:57 CET 2003
55  *
56 /* Revision 1.1.1.1  2003/02/12 13:59:15  matteo
57 /* mer feb 12 14:56:57 CET 2003
58 /*
59 /* Revision 1.2  2000/01/05 08:20:39  markster
60 /* Some OSS fixes and a few lpc changes to make it actually work
61 /*
62  * Revision 1.2  1996/08/20  20:25:29  jaf
63  * Removed all static local variables that were SAVE'd in the Fortran
64  * code, and put them in struct lpc10_encoder_state that is passed as an
65  * argument.
66  *
67  * Removed init function, since all initialization is now done in
68  * init_lpc10_encoder_state().
69  *
70  * Revision 1.1  1996/08/19  22:32:26  jaf
71  * Initial revision
72  * */
73 /* Revision 1.5  1996/03/26  19:35:35  jaf */
74 /* Commented out trace statements. */
75
76 /* Revision 1.4  1996/03/19  18:03:22  jaf */
77 /* Replaced the initialization "DATA P/60*DEPTH*0/" with "DATA P/120*0/", */
78 /* because apparently Fortran (or at least f2c) can't handle expressions */
79 /* like that. */
80
81 /* Revision 1.3  1996/03/19  17:38:32  jaf */
82 /* Added comments about the local variables that should be saved from one */
83 /* invocation to the next.  None of them were given initial values in the */
84 /* original code, but from my testing, it appears that initializing them */
85 /* all to 0 works. */
86
87 /* Added entry INITDYPTRK to reinitialize these local variables. */
88
89 /* Revision 1.2  1996/03/13  16:32:17  jaf */
90 /* Comments added explaining which of the local variables of this */
91 /* subroutine need to be saved from one invocation to the next, and which */
92 /* do not. */
93
94 /* WARNING!  Some of them that should are never given initial values in */
95 /* this code.  Hopefully, Fortran 77 defines initial values for them, but */
96 /* even so, giving them explicit initial values is preferable. */
97
98 /* Revision 1.1  1996/02/07 14:45:14  jaf */
99 /* Initial revision */
100
101
102 /* ********************************************************************* */
103
104 /*   Dynamic Pitch Tracker */
105
106 /* Input: */
107 /*  AMDF   - Average Magnitude Difference Function array */
108 /*           Indices 1 through LTAU read, and MINPTR */
109 /*  LTAU   - Number of lags in AMDF */
110 /*  MINPTR - Location of minimum AMDF value */
111 /*  VOICE  - Voicing decision */
112 /* Output: */
113 /*  PITCH  - Smoothed pitch value, 2 frames delayed */
114 /*  MIDX   - Initial estimate of current frame pitch */
115 /* Compile time constant: */
116 /*  DEPTH  - Number of frames to trace back */
117
118 /* This subroutine maintains local state from one call to the next.  If */
119 /* you want to switch to using a new audio stream for this filter, or */
120 /* reinitialize its state for any other reason, call the ENTRY */
121 /* INITDYPTRK. */
122
123 /* Subroutine */ int dyptrk_(real *amdf, integer *ltau, integer *
124         minptr, integer *voice, integer *pitch, integer *midx,
125                                struct lpc10_encoder_state *st)
126 {
127     /* Initialized data */
128
129     real *s;
130     integer *p;
131     integer *ipoint;
132     real *alphax;
133
134     /* System generated locals */
135     integer i__1;
136
137     /* Local variables */
138     integer pbar;
139     real sbar;
140     integer path[2], iptr, i__, j;
141     real alpha, minsc, maxsc;
142
143 /*       Arguments */
144 /* $Log$
145  * Revision 1.14  2003/02/12 13:59:15  matteo
146  * mer feb 12 14:56:57 CET 2003
147  *
148 /* Revision 1.1.1.1  2003/02/12 13:59:15  matteo
149 /* mer feb 12 14:56:57 CET 2003
150 /*
151 /* Revision 1.2  2000/01/05 08:20:39  markster
152 /* Some OSS fixes and a few lpc changes to make it actually work
153 /*
154  * Revision 1.2  1996/08/20  20:25:29  jaf
155  * Removed all static local variables that were SAVE'd in the Fortran
156  * code, and put them in struct lpc10_encoder_state that is passed as an
157  * argument.
158  *
159  * Removed init function, since all initialization is now done in
160  * init_lpc10_encoder_state().
161  *
162  * Revision 1.1  1996/08/19  22:32:26  jaf
163  * Initial revision
164  * */
165 /* Revision 1.3  1996/03/29  22:05:55  jaf */
166 /* Commented out the common block variables that are not needed by the */
167 /* embedded version. */
168
169 /* Revision 1.2  1996/03/26  19:34:50  jaf */
170 /* Added comments indicating which constants are not needed in an */
171 /* application that uses the LPC-10 coder. */
172
173 /* Revision 1.1  1996/02/07  14:44:09  jaf */
174 /* Initial revision */
175
176 /*   LPC Processing control variables: */
177
178 /* *** Read-only: initialized in setup */
179
180 /*  Files for Speech, Parameter, and Bitstream Input & Output, */
181 /*    and message and debug outputs. */
182
183 /* Here are the only files which use these variables: */
184
185 /* lpcsim.f setup.f trans.f error.f vqsetup.f */
186
187 /* Many files which use fdebug are not listed, since it is only used in */
188 /* those other files conditionally, to print trace statements. */
189 /*      integer fsi, fso, fpi, fpo, fbi, fbo, pbin, fmsg, fdebug */
190 /*  LPC order, Frame size, Quantization rate, Bits per frame, */
191 /*    Error correction */
192 /* Subroutine SETUP is the only place where order is assigned a value, */
193 /* and that value is 10.  It could increase efficiency 1% or so to */
194 /* declare order as a constant (i.e., a Fortran PARAMETER) instead of as 
195 */
196 /* a variable in a COMMON block, since it is used in many places in the */
197 /* core of the coding and decoding routines.  Actually, I take that back. 
198 */
199 /* At least when compiling with f2c, the upper bound of DO loops is */
200 /* stored in a local variable before the DO loop begins, and then that is 
201 */
202 /* compared against on each iteration. */
203 /* Similarly for lframe, which is given a value of MAXFRM in SETUP. */
204 /* Similarly for quant, which is given a value of 2400 in SETUP.  quant */
205 /* is used in only a few places, and never in the core coding and */
206 /* decoding routines, so it could be eliminated entirely. */
207 /* nbits is similar to quant, and is given a value of 54 in SETUP. */
208 /* corrp is given a value of .TRUE. in SETUP, and is only used in the */
209 /* subroutines ENCODE and DECODE.  It doesn't affect the speed of the */
210 /* coder significantly whether it is .TRUE. or .FALSE., or whether it is 
211 */
212 /* a constant or a variable, since it is only examined once per frame. */
213 /* Leaving it as a variable that is set to .TRUE.  seems like a good */
214 /* idea, since it does enable some error-correction capability for */
215 /* unvoiced frames, with no change in the coding rate, and no noticeable 
216 */
217 /* quality difference in the decoded speech. */
218 /*      integer quant, nbits */
219 /* *** Read/write: variables for debugging, not needed for LPC algorithm 
220 */
221
222 /*  Current frame, Unstable frames, Output clip count, Max onset buffer, 
223 */
224 /*    Debug listing detail level, Line count on listing page */
225
226 /* nframe is not needed for an embedded LPC10 at all. */
227 /* nunsfm is initialized to 0 in SETUP, and incremented in subroutine */
228 /* ERROR, which is only called from RCCHK.  When LPC10 is embedded into */
229 /* an application, I would recommend removing the call to ERROR in RCCHK, 
230 */
231 /* and remove ERROR and nunsfm completely. */
232 /* iclip is initialized to 0 in SETUP, and incremented in entry SWRITE in 
233 */
234 /* sread.f.  When LPC10 is embedded into an application, one might want */
235 /* to cause it to be incremented in a routine that takes the output of */
236 /* SYNTHS and sends it to an audio device.  It could be optionally */
237 /* displayed, for those that might want to know what it is. */
238 /* maxosp is never initialized to 0 in SETUP, although it probably should 
239 */
240 /* be, and it is updated in subroutine ANALYS.  I doubt that its value */
241 /* would be of much interest to an application in which LPC10 is */
242 /* embedded. */
243 /* listl and lincnt are not needed for an embedded LPC10 at all. */
244 /*      integer nframe, nunsfm, iclip, maxosp, listl, lincnt */
245 /*      common /contrl/ fsi, fso, fpi, fpo, fbi, fbo, pbin, fmsg, fdebug */
246 /*      common /contrl/ quant, nbits */
247 /*      common /contrl/ nframe, nunsfm, iclip, maxosp, listl, lincnt */
248 /*      Parameters/constants */
249 /*       Local variables that need not be saved */
250 /*       Note that PATH is only used for debugging purposes, and can be */
251 /*       removed. */
252 /*       Local state */
253 /*       It would be a bit more "general" to define S(LTAU), if Fortran */
254 /*       allows the argument of a function to be used as the dimension of 
255 */
256 /*       a local array variable. */
257 /*       IPOINT is always in the range 0 to DEPTH-1. */
258 /*       WARNING! */
259
260 /*       In the original version of this subroutine, IPOINT, ALPHAX, */
261 /*       every element of S, and potentially any element of P with the */
262 /*       second index value .NE. IPTR were read without being given */
263 /*       initial values (all indices of P with second index equal to */
264 /*       IPTR are all written before being read in this subroutine). */
265
266 /*       From examining the code carefully, it appears that all of these 
267 */
268 /*       should be saved from one invocation to the next. */
269
270 /*       I've run lpcsim with the "-l 6" option to see all of the */
271 /*       debugging information that is printed out by this subroutine */
272 /*       below, and it appears that S, P, IPOINT, and ALPHAX are all */
273 /*       initialized to 0 (these initial values would likely be different 
274 */
275 /*       on different platforms, compilers, etc.).  Given that the output 
276 */
277 /*       of the coder sounds reasonable, I'm going to initialize these */
278 /*       variables to 0 explicitly. */
279
280     s = &(st->s[0]);
281     p = &(st->p[0]);
282     ipoint = &(st->ipoint);
283     alphax = &(st->alphax);
284
285
286     /* Parameter adjustments */
287     if (amdf) {
288         --amdf;
289         }
290
291     /* Function Body */
292
293 /*   Calculate the confidence factor ALPHA, used as a threshold slope in 
294 */
295 /*   SEESAW.  If unvoiced, set high slope so that every point in P array 
296 */
297 /*  is marked as a potential pitch frequency.  A scaled up version (ALPHAX
298 )*/
299 /*   is used to maintain arithmetic precision. */
300     if (*voice == 1) {
301         *alphax = *alphax * .75f + amdf[*minptr] / 2.f;
302     } else {
303         *alphax *= .984375f;
304     }
305     alpha = *alphax / 16;
306     if (*voice == 0 && *alphax < 128.f) {
307         alpha = 8.f;
308     }
309 /* SEESAW: Construct a pitch pointer array and intermediate winner functio
310 n*/
311 /*   Left to right pass: */
312     iptr = *ipoint + 1;
313     p[iptr * 60 - 60] = 1;
314     i__ = 1;
315     pbar = 1;
316     sbar = s[0];
317     i__1 = *ltau;
318     for (i__ = 1; i__ <= i__1; ++i__) {
319         sbar += alpha;
320         if (sbar < s[i__ - 1]) {
321             s[i__ - 1] = sbar;
322             p[i__ + iptr * 60 - 61] = pbar;
323         } else {
324             sbar = s[i__ - 1];
325             p[i__ + iptr * 60 - 61] = i__;
326             pbar = i__;
327         }
328     }
329 /*   Right to left pass: */
330     i__ = pbar - 1;
331     sbar = s[i__];
332     while(i__ >= 1) {
333         sbar += alpha;
334         if (sbar < s[i__ - 1]) {
335             s[i__ - 1] = sbar;
336             p[i__ + iptr * 60 - 61] = pbar;
337         } else {
338             pbar = p[i__ + iptr * 60 - 61];
339             i__ = pbar;
340             sbar = s[i__ - 1];
341         }
342         --i__;
343     }
344 /*   Update S using AMDF */
345 /*   Find maximum, minimum, and location of minimum */
346     s[0] += amdf[1] / 2;
347     minsc = s[0];
348     maxsc = minsc;
349     *midx = 1;
350     i__1 = *ltau;
351     for (i__ = 2; i__ <= i__1; ++i__) {
352         s[i__ - 1] += amdf[i__] / 2;
353         if (s[i__ - 1] > maxsc) {
354             maxsc = s[i__ - 1];
355         }
356         if (s[i__ - 1] < minsc) {
357             *midx = i__;
358             minsc = s[i__ - 1];
359         }
360     }
361 /*   Subtract MINSC from S to prevent overflow */
362     i__1 = *ltau;
363     for (i__ = 1; i__ <= i__1; ++i__) {
364         s[i__ - 1] -= minsc;
365     }
366     maxsc -= minsc;
367 /*   Use higher octave pitch if significant null there */
368     j = 0;
369     for (i__ = 20; i__ <= 40; i__ += 10) {
370         if (*midx > i__) {
371             if (s[*midx - i__ - 1] < maxsc / 4) {
372                 j = i__;
373             }
374         }
375     }
376     *midx -= j;
377 /*   TRACE: look back two frames to find minimum cost pitch estimate */
378     j = *ipoint;
379     *pitch = *midx;
380     for (i__ = 1; i__ <= 2; ++i__) {
381         j = j % 2 + 1;
382         *pitch = p[*pitch + j * 60 - 61];
383         path[i__ - 1] = *pitch;
384     }
385
386 /*       The following statement subtracts one from IPOINT, mod DEPTH.  I 
387 */
388 /*       think the author chose to add DEPTH-1, instead of subtracting 1, 
389 */
390 /*       because then it will work even if MOD doesn't work as desired on 
391 */
392 /*       negative arguments. */
393
394     *ipoint = (*ipoint + 1) % 2;
395     return 0;
396 } /* dyptrk_ */