1f6d8a061e3ba2cb7e3d7cb5155a0daaa854ad1f
[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 /* We do a straight line fade to zero volume in 50ms when we are filling in for missing data. */
48 #define ATTENUATION_INCREMENT       0.0025                              /* Attenuation per sample */
49
50 #define ms_to_samples(t)            (((t)*SAMPLE_RATE)/1000)
51
52 static inline int16_t fsaturate(double damp)
53 {
54     if (damp > 32767.0)
55         return  INT16_MAX;
56     if (damp < -32768.0)
57         return  INT16_MIN;
58     return (int16_t) rint(damp);
59 }
60
61 static void save_history(plc_state_t *s, int16_t *buf, int len)
62 {
63     if (len >= PLC_HISTORY_LEN)
64     {
65         /* Just keep the last part of the new data, starting at the beginning of the buffer */
66         memcpy(s->history, buf + len - PLC_HISTORY_LEN, sizeof(int16_t)*PLC_HISTORY_LEN);
67         s->buf_ptr = 0;
68         return;
69     }
70     if (s->buf_ptr + len > PLC_HISTORY_LEN)
71     {
72         /* Wraps around - must break into two sections */
73         memcpy(s->history + s->buf_ptr, buf, sizeof(int16_t)*(PLC_HISTORY_LEN - s->buf_ptr));
74         len -= (PLC_HISTORY_LEN - s->buf_ptr);
75         memcpy(s->history, buf + (PLC_HISTORY_LEN - s->buf_ptr), sizeof(int16_t)*len);
76         s->buf_ptr = len;
77         return;
78     }
79     /* Can use just one section */
80     memcpy(s->history + s->buf_ptr, buf, sizeof(int16_t)*len);
81     s->buf_ptr += len;
82 }
83 /*- End of function --------------------------------------------------------*/
84
85 static void normalise_history(plc_state_t *s)
86 {
87     int16_t tmp[PLC_HISTORY_LEN];
88
89     if (s->buf_ptr == 0)
90         return;
91     memcpy(tmp, s->history, sizeof(int16_t)*s->buf_ptr);
92     memcpy(s->history, s->history + s->buf_ptr, sizeof(int16_t)*(PLC_HISTORY_LEN - s->buf_ptr));
93     memcpy(s->history + PLC_HISTORY_LEN - s->buf_ptr, tmp, sizeof(int16_t)*s->buf_ptr);
94     s->buf_ptr = 0;
95 }
96 /*- End of function --------------------------------------------------------*/
97
98 static int __inline__ amdf_pitch(int min_pitch, int max_pitch, int16_t amp[], int len)
99 {
100     int i;
101     int j;
102     int acc;
103     int min_acc;
104     int pitch;
105
106     pitch = min_pitch;
107     min_acc = INT_MAX;
108     for (i = max_pitch;  i <= min_pitch;  i++)
109     {
110         acc = 0;
111         for (j = 0;  j < len;  j++)
112             acc += abs(amp[i + j] - amp[j]);
113         if (acc < min_acc)
114         {
115             min_acc = acc;
116             pitch = i;
117         }
118     }
119     return pitch;
120 }
121 /*- End of function --------------------------------------------------------*/
122
123 int plc_rx(plc_state_t *s, int16_t amp[], int len)
124 {
125     int i;
126     int overlap_len;
127     int pitch_overlap;
128     float old_step;
129     float new_step;
130     float old_weight;
131     float new_weight;
132     float gain;
133     
134     if (s->missing_samples)
135     {
136         /* Although we have a real signal, we need to smooth it to fit well
137            with the synthetic signal we used for the previous block */
138
139         /* The start of the real data is overlapped with the next 1/4 cycle
140            of the synthetic data. */
141         pitch_overlap = s->pitch >> 2;
142         if (pitch_overlap > len)
143             pitch_overlap = len;
144         gain = 1.0 - s->missing_samples*ATTENUATION_INCREMENT;
145         if (gain < 0.0)
146             gain = 0.0;
147         new_step = 1.0/pitch_overlap;
148         old_step = new_step*gain;
149         new_weight = new_step;
150         old_weight = (1.0 - new_step)*gain;
151         for (i = 0;  i < pitch_overlap;  i++)
152         {
153             amp[i] = fsaturate(old_weight*s->pitchbuf[s->pitch_offset] + new_weight*amp[i]);
154             if (++s->pitch_offset >= s->pitch)
155                 s->pitch_offset = 0;
156             new_weight += new_step;
157             old_weight -= old_step;
158             if (old_weight < 0.0)
159                 old_weight = 0.0;
160         }
161         s->missing_samples = 0;
162     }
163     save_history(s, amp, len);
164     return len;
165 }
166 /*- End of function --------------------------------------------------------*/
167
168 int plc_fillin(plc_state_t *s, int16_t amp[], int len)
169 {
170     int16_t tmp[PLC_PITCH_OVERLAP_MAX];
171     int i;
172     int pitch_overlap;
173     float old_step;
174     float new_step;
175     float old_weight;
176     float new_weight;
177     float gain;
178     int16_t *orig_amp;
179     int orig_len;
180
181     orig_amp = amp;
182     orig_len = len;
183     if (s->missing_samples == 0)
184     {
185         /* As the gap in real speech starts we need to assess the last known pitch,
186            and prepare the synthetic data we will use for fill-in */
187         normalise_history(s);
188         s->pitch = amdf_pitch(PLC_PITCH_MIN, PLC_PITCH_MAX, s->history + PLC_HISTORY_LEN - CORRELATION_SPAN - PLC_PITCH_MIN, CORRELATION_SPAN);
189         /* We overlap a 1/4 wavelength */
190         pitch_overlap = s->pitch >> 2;
191         /* Cook up a single cycle of pitch, using a single of the real signal with 1/4
192            cycle OLA'ed to make the ends join up nicely */
193         /* The first 3/4 of the cycle is a simple copy */
194         for (i = 0;  i < s->pitch - pitch_overlap;  i++)
195             s->pitchbuf[i] = s->history[PLC_HISTORY_LEN - s->pitch + i];
196         /* The last 1/4 of the cycle is overlapped with the end of the previous cycle */
197         new_step = 1.0/pitch_overlap;
198         new_weight = new_step;
199         for (  ;  i < s->pitch;  i++)
200         {
201             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;
202             new_weight += new_step;
203         }
204         /* We should now be ready to fill in the gap with repeated, decaying cycles
205            of what is in pitchbuf */
206
207         /* We need to OLA the first 1/4 wavelength of the synthetic data, to smooth
208            it into the previous real data. To avoid the need to introduce a delay
209            in the stream, reverse the last 1/4 wavelength, and OLA with that. */
210         gain = 1.0;
211         new_step = 1.0/pitch_overlap;
212         old_step = new_step;
213         new_weight = new_step;
214         old_weight = 1.0 - new_step;
215         for (i = 0;  i < pitch_overlap;  i++)
216         {
217             amp[i] = fsaturate(old_weight*s->history[PLC_HISTORY_LEN - 1 - i] + new_weight*s->pitchbuf[i]);
218             new_weight += new_step;
219             old_weight -= old_step;
220             if (old_weight < 0.0)
221                 old_weight = 0.0;
222         }
223         s->pitch_offset = i;
224     }
225     else
226     {
227         gain = 1.0 - s->missing_samples*ATTENUATION_INCREMENT;
228         i = 0;
229     }
230     for (  ;  gain > 0.0  &&  i < len;  i++)
231     {
232         amp[i] = s->pitchbuf[s->pitch_offset]*gain;
233         gain -= ATTENUATION_INCREMENT;
234         if (++s->pitch_offset >= s->pitch)
235             s->pitch_offset = 0;
236     }
237     for (  ;  i < len;  i++)
238         amp[i] = 0;
239     s->missing_samples += orig_len;
240     save_history(s, amp, len);
241     return len;
242 }
243 /*- End of function --------------------------------------------------------*/
244
245 plc_state_t *plc_init(plc_state_t *s)
246 {
247     memset(s, 0, sizeof(*s));
248     return s;
249 }
250 /*- End of function --------------------------------------------------------*/
251 /*- End of file ------------------------------------------------------------*/