bef0a671d1e6ec967aff0356a14df72a290e36c9
[asterisk/asterisk.git] / codecs / lpc10 / lpcdec.c
1 /*
2
3 $Log$
4 Revision 1.10  2000/01/05 08:20:39  markster
5 Version 0.1.11 from FTP
6
7 Revision 1.2  2000/01/05 08:20:39  markster
8 Some OSS fixes and a few lpc changes to make it actually work
9
10  * Revision 1.2  1996/08/20  20:30:11  jaf
11  * Removed all static local variables that were SAVE'd in the Fortran
12  * code, and put them in struct lpc10_encoder_state that is passed as an
13  * argument.
14  *
15  * Removed init function, since all initialization is now done in
16  * init_lpc10_encoder_state().
17  *
18  * Changed name of function from lpcenc_ to lpc10_encode, simply to make
19  * all lpc10 functions have more consistent naming with each other.
20  *
21  * Revision 1.1  1996/08/19  22:31:48  jaf
22  * Initial revision
23  *
24
25 */
26
27 #ifdef P_R_O_T_O_T_Y_P_E_S
28 extern int lpcdec_(integer *bits, real *speech);
29 extern int initlpcdec_(void);
30 /* comlen contrl_ 12 */
31 /*:ref: chanrd_ 14 5 4 4 4 4 4 */
32 /*:ref: decode_ 14 7 4 4 4 4 4 6 6 */
33 /*:ref: synths_ 14 6 4 4 6 6 6 4 */
34 /*:ref: initdecode_ 14 0 */
35 /*:ref: initsynths_ 14 0 */
36 #endif
37
38 /*  -- translated by f2c (version 19951025).
39    You must link the resulting object file with the libraries:
40         -lf2c -lm   (in that order)
41 */
42
43 #include "f2c.h"
44
45 /* Common Block Declarations */
46
47 extern struct {
48     integer order, lframe;
49     logical corrp;
50 } contrl_;
51
52 #define contrl_1 contrl_
53
54 /* Table of constant values */
55
56 static integer c__10 = 10;
57
58 /* ***************************************************************** */
59
60 /* $Log$
61  * Revision 1.10  2000/01/05 08:20:39  markster
62  * Version 0.1.11 from FTP
63  *
64 /* Revision 1.2  2000/01/05 08:20:39  markster
65 /* Some OSS fixes and a few lpc changes to make it actually work
66 /*
67  * Revision 1.2  1996/08/20  20:30:11  jaf
68  * Removed all static local variables that were SAVE'd in the Fortran
69  * code, and put them in struct lpc10_encoder_state that is passed as an
70  * argument.
71  *
72  * Removed init function, since all initialization is now done in
73  * init_lpc10_encoder_state().
74  *
75  * Changed name of function from lpcenc_ to lpc10_encode, simply to make
76  * all lpc10 functions have more consistent naming with each other.
77  *
78  * Revision 1.1  1996/08/19  22:31:48  jaf
79  * Initial revision
80  * */
81 /* Revision 1.1  1996/03/28  00:03:00  jaf */
82 /* Initial revision */
83
84
85 /* ***************************************************************** */
86
87 /* Decode 54 bits to one frame of 180 speech samples. */
88
89 /* Input: */
90 /*  BITS   - 54 encoded bits, stored 1 per array element. */
91 /*           Indices 1 through 53 read (SYNC bit ignored). */
92 /* Output: */
93 /*  SPEECH - Speech encoded as real values in the range [-1,+1]. */
94 /*           Indices 1 through 180 written. */
95
96 /* This subroutine maintains local state from one call to the next.  If */
97 /* you want to switch to using a new audio stream for this filter, or */
98 /* reinitialize its state for any other reason, call the ENTRY */
99 /* INITLPCDEC. */
100
101 /* Subroutine */ int lpc10_decode(integer *bits, real *speech,
102                                   struct lpc10_decoder_state *st)
103 {
104     integer irms, voice[2], pitch, ipitv;
105     extern /* Subroutine */ int decode_(integer *, integer *, integer *, 
106             integer *, integer *, real *, real *, struct lpc10_decoder_state *);
107     real rc[10];
108     extern /* Subroutine */ int chanrd_(integer *, integer *, integer *, 
109             integer *, integer *), synths_(integer *, 
110             integer *, real *, real *, real *, integer *,
111                                            struct lpc10_decoder_state *);
112     integer irc[10], len;
113     real rms;
114
115 /* $Log$
116  * Revision 1.10  2000/01/05 08:20:39  markster
117  * Version 0.1.11 from FTP
118  *
119 /* Revision 1.2  2000/01/05 08:20:39  markster
120 /* Some OSS fixes and a few lpc changes to make it actually work
121 /*
122  * Revision 1.2  1996/08/20  20:30:11  jaf
123  * Removed all static local variables that were SAVE'd in the Fortran
124  * code, and put them in struct lpc10_encoder_state that is passed as an
125  * argument.
126  *
127  * Removed init function, since all initialization is now done in
128  * init_lpc10_encoder_state().
129  *
130  * Changed name of function from lpcenc_ to lpc10_encode, simply to make
131  * all lpc10 functions have more consistent naming with each other.
132  *
133  * Revision 1.1  1996/08/19  22:31:48  jaf
134  * Initial revision
135  * */
136 /* Revision 1.3  1996/03/29  22:03:47  jaf */
137 /* Removed definitions for any constants that were no longer used. */
138
139 /* Revision 1.2  1996/03/26  19:34:33  jaf */
140 /* Added comments indicating which constants are not needed in an */
141 /* application that uses the LPC-10 coder. */
142
143 /* Revision 1.1  1996/02/07  14:43:51  jaf */
144 /* Initial revision */
145
146 /*   LPC Configuration parameters: */
147 /* Frame size, Prediction order, Pitch period */
148 /*       Arguments */
149 /* $Log$
150  * Revision 1.10  2000/01/05 08:20:39  markster
151  * Version 0.1.11 from FTP
152  *
153 /* Revision 1.2  2000/01/05 08:20:39  markster
154 /* Some OSS fixes and a few lpc changes to make it actually work
155 /*
156  * Revision 1.2  1996/08/20  20:30:11  jaf
157  * Removed all static local variables that were SAVE'd in the Fortran
158  * code, and put them in struct lpc10_encoder_state that is passed as an
159  * argument.
160  *
161  * Removed init function, since all initialization is now done in
162  * init_lpc10_encoder_state().
163  *
164  * Changed name of function from lpcenc_ to lpc10_encode, simply to make
165  * all lpc10 functions have more consistent naming with each other.
166  *
167  * Revision 1.1  1996/08/19  22:31:48  jaf
168  * Initial revision
169  * */
170 /* Revision 1.3  1996/03/29  22:05:55  jaf */
171 /* Commented out the common block variables that are not needed by the */
172 /* embedded version. */
173
174 /* Revision 1.2  1996/03/26  19:34:50  jaf */
175 /* Added comments indicating which constants are not needed in an */
176 /* application that uses the LPC-10 coder. */
177
178 /* Revision 1.1  1996/02/07  14:44:09  jaf */
179 /* Initial revision */
180
181 /*   LPC Processing control variables: */
182
183 /* *** Read-only: initialized in setup */
184
185 /*  Files for Speech, Parameter, and Bitstream Input & Output, */
186 /*    and message and debug outputs. */
187
188 /* Here are the only files which use these variables: */
189
190 /* lpcsim.f setup.f trans.f error.f vqsetup.f */
191
192 /* Many files which use fdebug are not listed, since it is only used in */
193 /* those other files conditionally, to print trace statements. */
194 /*      integer fsi, fso, fpi, fpo, fbi, fbo, pbin, fmsg, fdebug */
195 /*  LPC order, Frame size, Quantization rate, Bits per frame, */
196 /*    Error correction */
197 /* Subroutine SETUP is the only place where order is assigned a value, */
198 /* and that value is 10.  It could increase efficiency 1% or so to */
199 /* declare order as a constant (i.e., a Fortran PARAMETER) instead of as 
200 */
201 /* a variable in a COMMON block, since it is used in many places in the */
202 /* core of the coding and decoding routines.  Actually, I take that back. 
203 */
204 /* At least when compiling with f2c, the upper bound of DO loops is */
205 /* stored in a local variable before the DO loop begins, and then that is 
206 */
207 /* compared against on each iteration. */
208 /* Similarly for lframe, which is given a value of MAXFRM in SETUP. */
209 /* Similarly for quant, which is given a value of 2400 in SETUP.  quant */
210 /* is used in only a few places, and never in the core coding and */
211 /* decoding routines, so it could be eliminated entirely. */
212 /* nbits is similar to quant, and is given a value of 54 in SETUP. */
213 /* corrp is given a value of .TRUE. in SETUP, and is only used in the */
214 /* subroutines ENCODE and DECODE.  It doesn't affect the speed of the */
215 /* coder significantly whether it is .TRUE. or .FALSE., or whether it is 
216 */
217 /* a constant or a variable, since it is only examined once per frame. */
218 /* Leaving it as a variable that is set to .TRUE.  seems like a good */
219 /* idea, since it does enable some error-correction capability for */
220 /* unvoiced frames, with no change in the coding rate, and no noticeable 
221 */
222 /* quality difference in the decoded speech. */
223 /*      integer quant, nbits */
224 /* *** Read/write: variables for debugging, not needed for LPC algorithm 
225 */
226
227 /*  Current frame, Unstable frames, Output clip count, Max onset buffer, 
228 */
229 /*    Debug listing detail level, Line count on listing page */
230
231 /* nframe is not needed for an embedded LPC10 at all. */
232 /* nunsfm is initialized to 0 in SETUP, and incremented in subroutine */
233 /* ERROR, which is only called from RCCHK.  When LPC10 is embedded into */
234 /* an application, I would recommend removing the call to ERROR in RCCHK, 
235 */
236 /* and remove ERROR and nunsfm completely. */
237 /* iclip is initialized to 0 in SETUP, and incremented in entry SWRITE in 
238 */
239 /* sread.f.  When LPC10 is embedded into an application, one might want */
240 /* to cause it to be incremented in a routine that takes the output of */
241 /* SYNTHS and sends it to an audio device.  It could be optionally */
242 /* displayed, for those that might want to know what it is. */
243 /* maxosp is never initialized to 0 in SETUP, although it probably should 
244 */
245 /* be, and it is updated in subroutine ANALYS.  I doubt that its value */
246 /* would be of much interest to an application in which LPC10 is */
247 /* embedded. */
248 /* listl and lincnt are not needed for an embedded LPC10 at all. */
249 /*      integer nframe, nunsfm, iclip, maxosp, listl, lincnt */
250 /*      common /contrl/ fsi, fso, fpi, fpo, fbi, fbo, pbin, fmsg, fdebug */
251 /*      common /contrl/ quant, nbits */
252 /*      common /contrl/ nframe, nunsfm, iclip, maxosp, listl, lincnt */
253 /*       Local variables that need not be saved */
254 /*       Uncoded speech parameters */
255 /*       Coded speech parameters */
256 /*       Others */
257 /*       Local state */
258 /*       None */
259     /* Parameter adjustments */
260     if (bits) {
261         --bits;
262         }
263     if (speech) {
264         --speech;
265         }
266
267     /* Function Body */
268
269     chanrd_(&c__10, &ipitv, &irms, irc, &bits[1]);
270     decode_(&ipitv, &irms, irc, voice, &pitch, &rms, rc, st);
271     synths_(voice, &pitch, &rms, rc, &speech[1], &len, st);
272     return 0;
273 } /* lpcdec_ */