Missing E911 signaling type in sample zapata.conf
[asterisk/asterisk.git] / plc.c
1 /*
2  * SpanDSP - a series of DSP components for telephony
3  *
4  * plc.c
5  *
6  * Written by Steve Underwood <steveu@coppice.org>
7  *
8  * Copyright (C) 2004 Steve Underwood
9  *
10  * All rights reserved.
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25  *
26  * This version may be optionally licenced under the GNU LGPL licence.
27  * This version is disclaimed to DIGIUM for inclusion in the Asterisk project.
28  */
29
30 /*! \file */
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <math.h>
36 #include <limits.h>
37
38 #include "asterisk/plc.h"
39
40 #if !defined(FALSE)
41 #define FALSE 0
42 #endif
43 #if !defined(TRUE)
44 #define TRUE (!FALSE)
45 #endif
46
47 #if !defined(INT16_MAX)
48 #define INT16_MAX       (32767)
49 #define INT16_MIN       (-32767-1)
50 #endif
51
52 /* We do a straight line fade to zero volume in 50ms when we are filling in for missing data. */
53 #define ATTENUATION_INCREMENT       0.0025                              /* Attenuation per sample */
54
55 #define ms_to_samples(t)            (((t)*SAMPLE_RATE)/1000)
56
57 static inline int16_t fsaturate(double damp)
58 {
59     if (damp > 32767.0)
60         return  INT16_MAX;
61     if (damp < -32768.0)
62         return  INT16_MIN;
63     return (int16_t) rint(damp);
64 }
65
66 static void save_history(plc_state_t *s, int16_t *buf, int len)
67 {
68     if (len >= PLC_HISTORY_LEN)
69     {
70         /* Just keep the last part of the new data, starting at the beginning of the buffer */
71         memcpy(s->history, buf + len - PLC_HISTORY_LEN, sizeof(int16_t)*PLC_HISTORY_LEN);
72         s->buf_ptr = 0;
73         return;
74     }
75     if (s->buf_ptr + len > PLC_HISTORY_LEN)
76     {
77         /* Wraps around - must break into two sections */
78         memcpy(s->history + s->buf_ptr, buf, sizeof(int16_t)*(PLC_HISTORY_LEN - s->buf_ptr));
79         len -= (PLC_HISTORY_LEN - s->buf_ptr);
80         memcpy(s->history, buf + (PLC_HISTORY_LEN - s->buf_ptr), sizeof(int16_t)*len);
81         s->buf_ptr = len;
82         return;
83     }
84     /* Can use just one section */
85     memcpy(s->history + s->buf_ptr, buf, sizeof(int16_t)*len);
86     s->buf_ptr += len;
87 }
88 /*- End of function --------------------------------------------------------*/
89
90 static void normalise_history(plc_state_t *s)
91 {
92     int16_t tmp[PLC_HISTORY_LEN];
93
94     if (s->buf_ptr == 0)
95         return;
96     memcpy(tmp, s->history, sizeof(int16_t)*s->buf_ptr);
97     memcpy(s->history, s->history + s->buf_ptr, sizeof(int16_t)*(PLC_HISTORY_LEN - s->buf_ptr));
98     memcpy(s->history + PLC_HISTORY_LEN - s->buf_ptr, tmp, sizeof(int16_t)*s->buf_ptr);
99     s->buf_ptr = 0;
100 }
101 /*- End of function --------------------------------------------------------*/
102
103 static int __inline__ amdf_pitch(int min_pitch, int max_pitch, int16_t amp[], int len)
104 {
105     int i;
106     int j;
107     int acc;
108     int min_acc;
109     int pitch;
110
111     pitch = min_pitch;
112     min_acc = INT_MAX;
113     for (i = max_pitch;  i <= min_pitch;  i++)
114     {
115         acc = 0;
116         for (j = 0;  j < len;  j++)
117             acc += abs(amp[i + j] - amp[j]);
118         if (acc < min_acc)
119         {
120             min_acc = acc;
121             pitch = i;
122         }
123     }
124     return pitch;
125 }
126 /*- End of function --------------------------------------------------------*/
127
128 int plc_rx(plc_state_t *s, int16_t amp[], int len)
129 {
130     int i;
131     int pitch_overlap;
132     float old_step;
133     float new_step;
134     float old_weight;
135     float new_weight;
136     float gain;
137     
138     if (s->missing_samples)
139     {
140         /* Although we have a real signal, we need to smooth it to fit well
141            with the synthetic signal we used for the previous block */
142
143         /* The start of the real data is overlapped with the next 1/4 cycle
144            of the synthetic data. */
145         pitch_overlap = s->pitch >> 2;
146         if (pitch_overlap > len)
147             pitch_overlap = len;
148         gain = 1.0 - s->missing_samples*ATTENUATION_INCREMENT;
149         if (gain < 0.0)
150             gain = 0.0;
151         new_step = 1.0/pitch_overlap;
152         old_step = new_step*gain;
153         new_weight = new_step;
154         old_weight = (1.0 - new_step)*gain;
155         for (i = 0;  i < pitch_overlap;  i++)
156         {
157             amp[i] = fsaturate(old_weight*s->pitchbuf[s->pitch_offset] + new_weight*amp[i]);
158             if (++s->pitch_offset >= s->pitch)
159                 s->pitch_offset = 0;
160             new_weight += new_step;
161             old_weight -= old_step;
162             if (old_weight < 0.0)
163                 old_weight = 0.0;
164         }
165         s->missing_samples = 0;
166     }
167     save_history(s, amp, len);
168     return len;
169 }
170 /*- End of function --------------------------------------------------------*/
171
172 int plc_fillin(plc_state_t *s, int16_t amp[], int len)
173 {
174     int i;
175     int pitch_overlap;
176     float old_step;
177     float new_step;
178     float old_weight;
179     float new_weight;
180     float gain;
181     int16_t *orig_amp;
182     int orig_len;
183
184     orig_amp = amp;
185     orig_len = len;
186     if (s->missing_samples == 0)
187     {
188         /* As the gap in real speech starts we need to assess the last known pitch,
189            and prepare the synthetic data we will use for fill-in */
190         normalise_history(s);
191         s->pitch = amdf_pitch(PLC_PITCH_MIN, PLC_PITCH_MAX, s->history + PLC_HISTORY_LEN - CORRELATION_SPAN - PLC_PITCH_MIN, CORRELATION_SPAN);
192         /* We overlap a 1/4 wavelength */
193         pitch_overlap = s->pitch >> 2;
194         /* Cook up a single cycle of pitch, using a single of the real signal with 1/4
195            cycle OLA'ed to make the ends join up nicely */
196         /* The first 3/4 of the cycle is a simple copy */
197         for (i = 0;  i < s->pitch - pitch_overlap;  i++)
198             s->pitchbuf[i] = s->history[PLC_HISTORY_LEN - s->pitch + i];
199         /* The last 1/4 of the cycle is overlapped with the end of the previous cycle */
200         new_step = 1.0/pitch_overlap;
201         new_weight = new_step;
202         for (  ;  i < s->pitch;  i++)
203         {
204             s->pitchbuf[i] = s->history[PLC_HISTORY_LEN - s->pitch + i]*(1.0 - new_weight) + s->history[PLC_HISTORY_LEN - 2*s->pitch + i]*new_weight;
205             new_weight += new_step;
206         }
207         /* We should now be ready to fill in the gap with repeated, decaying cycles
208            of what is in pitchbuf */
209
210         /* We need to OLA the first 1/4 wavelength of the synthetic data, to smooth
211            it into the previous real data. To avoid the need to introduce a delay
212            in the stream, reverse the last 1/4 wavelength, and OLA with that. */
213         gain = 1.0;
214         new_step = 1.0/pitch_overlap;
215         old_step = new_step;
216         new_weight = new_step;
217         old_weight = 1.0 - new_step;
218         for (i = 0;  i < pitch_overlap;  i++)
219         {
220             amp[i] = fsaturate(old_weight*s->history[PLC_HISTORY_LEN - 1 - i] + new_weight*s->pitchbuf[i]);
221             new_weight += new_step;
222             old_weight -= old_step;
223             if (old_weight < 0.0)
224                 old_weight = 0.0;
225         }
226         s->pitch_offset = i;
227     }
228     else
229     {
230         gain = 1.0 - s->missing_samples*ATTENUATION_INCREMENT;
231         i = 0;
232     }
233     for (  ;  gain > 0.0  &&  i < len;  i++)
234     {
235         amp[i] = s->pitchbuf[s->pitch_offset]*gain;
236         gain -= ATTENUATION_INCREMENT;
237         if (++s->pitch_offset >= s->pitch)
238             s->pitch_offset = 0;
239     }
240     for (  ;  i < len;  i++)
241         amp[i] = 0;
242     s->missing_samples += orig_len;
243     save_history(s, amp, len);
244     return len;
245 }
246 /*- End of function --------------------------------------------------------*/
247
248 plc_state_t *plc_init(plc_state_t *s)
249 {
250     memset(s, 0, sizeof(*s));
251     return s;
252 }
253 /*- End of function --------------------------------------------------------*/
254 /*- End of file ------------------------------------------------------------*/