interpolation.cc/.h: first working but buggy implementation of cubic Spline interpolation
[ardour.git] / libs / ardour / interpolation.cc
1 #include <stdint.h>
2 #include <cstdio>
3
4 #include "ardour/interpolation.h"
5
6 using namespace ARDOUR;
7
8 nframes_t
9 FixedPointLinearInterpolation::interpolate (int channel, nframes_t nframes, Sample *input, Sample *output)
10 {
11         // the idea behind phase is that when the speed is not 1.0, we have to 
12         // interpolate between samples and then we have to store where we thought we were. 
13         // rather than being at sample N or N+1, we were at N+0.8792922
14         // so the "phase" element, if you want to think about this way, 
15         // varies from 0 to 1, representing the "offset" between samples
16         uint64_t        the_phase = last_phase[channel];
17         
18         // acceleration
19         int64_t  phi_delta;
20
21         // phi = fixed point speed
22         if (phi != target_phi) {
23                 phi_delta = ((int64_t)(target_phi - phi)) / nframes;
24         } else {
25                 phi_delta = 0;
26         }
27         
28         // index in the input buffers
29         nframes_t   i = 0;
30
31         for (nframes_t outsample = 0; outsample < nframes; ++outsample) {
32                 i = the_phase >> 24;
33                 Sample fractional_phase_part = (the_phase & fractional_part_mask) / binary_scaling_factor;
34                 
35                 if (input && output) {
36                         // Linearly interpolate into the output buffer
37                         output[outsample] = 
38                                 input[i] * (1.0f - fractional_phase_part) +
39                                 input[i+1] * fractional_phase_part;
40                 }
41                 
42                 the_phase += phi + phi_delta;
43         }
44
45         last_phase[channel] = (the_phase & fractional_part_mask);
46         
47         // playback distance
48         return i;
49 }
50
51 void 
52 FixedPointLinearInterpolation::add_channel_to (int /*input_buffer_size*/, int /*output_buffer_size*/)
53 {
54         last_phase.push_back (0);
55 }
56
57 void 
58 FixedPointLinearInterpolation::remove_channel_from ()
59 {
60         last_phase.pop_back ();
61 }
62
63 void
64 FixedPointLinearInterpolation::reset() 
65 {
66         for (size_t i = 0; i <= last_phase.size(); i++) {
67                 last_phase[i] = 0;
68         }
69 }
70
71
72 nframes_t
73 LinearInterpolation::interpolate (int channel, nframes_t nframes, Sample *input, Sample *output)
74 {
75         // index in the input buffers
76         nframes_t   i = 0;
77         
78         double acceleration;
79         double distance = 0.0;
80         
81         if (_speed != _target_speed) {
82                 acceleration = _target_speed - _speed;
83         } else {
84                 acceleration = 0.0;
85         }
86         
87         distance = phase[channel];
88         //printf("processing channel: %d\n", channel);
89         //printf("phase before: %lf\n", phase[channel]);
90         for (nframes_t outsample = 0; outsample < nframes; ++outsample) {
91                 i = floor(distance);
92                 Sample fractional_phase_part = distance - i;
93                 if (fractional_phase_part >= 1.0) {
94                         fractional_phase_part -= 1.0;
95                         i++;
96                 }
97                 //printf("I: %u, distance: %lf, fractional_phase_part: %lf\n", i, distance, fractional_phase_part);
98                 
99                 if (input && output) {
100                 // Linearly interpolate into the output buffer
101                         output[outsample] = 
102                                 input[i] * (1.0f - fractional_phase_part) +
103                                 input[i+1] * fractional_phase_part;
104                 }
105                 //printf("distance before: %lf\n", distance);
106                 distance += _speed + acceleration;
107                 //printf("distance after: %lf, _speed: %lf\n", distance, _speed);
108         }
109         
110         //printf("before assignment: i: %d, distance: %lf\n", i, distance);
111         i = floor(distance);
112         //printf("after assignment: i: %d, distance: %16lf\n", i, distance);
113         phase[channel] = distance - floor(distance);
114         //printf("speed: %16lf, i after: %d, distance after: %16lf, phase after: %16lf\n", _speed, i, distance, phase[channel]);
115         
116         return i;
117 }
118
119 SplineInterpolation::SplineInterpolation()
120 {
121     // precompute LU-factorization of matrix A
122     // see "Teubner Taschenbuch der Mathematik", p. 1105
123     m[0] = 4.0;
124     for (int i = 0; i <= MAX_PERIOD_SIZE - 2; i++) {
125         l[i] = 1.0 / m[i];
126         m[i+1] = 4.0 - l[i];
127     }
128 }
129
130 nframes_t
131 SplineInterpolation::interpolate (int channel, nframes_t nframes, Sample *input, Sample *output)
132 {
133     // How many input samples we need
134     nframes_t n = ceil (double(nframes) * _speed) + 2;
135     //   |------------------------------------------^
136     // this won't be here in the debugged version.
137     
138     double M[n], t[n-2];
139     
140     // natural spline: boundary conditions
141     M[0]     = 0.0;
142     M[n - 1] = 0.0;
143     
144     // solve L * t = d
145     // see "Teubner Taschenbuch der Mathematik", p. 1105
146     t[0] = 6.0 * (input[0] - 2*input[1] + input[2]); 
147     for (nframes_t i = 1; i <= n - 3; i++) {
148         t[i] = 6.0 * (input[i] - 2*input[i+1] + input[i+2])
149                - l[i-1] * t[i-1];
150     }
151     
152     // solve R * M = t
153     // see "Teubner Taschenbuch der Mathematik", p. 1105
154     M[n-2] = -t[n-3] / m[n-3];
155     for (nframes_t i = n-4;; i--) {
156         M[i+1] = -(t[i] + M[i+2]) / m[i];
157         if ( i == 0 ) break;
158     }
159     
160     // now interpolate
161     // index in the input buffers
162     nframes_t   i = 0;
163     
164     double acceleration;
165     double distance = 0.0;
166     
167     if (_speed != _target_speed) {
168         acceleration = _target_speed - _speed;
169     } else {
170         acceleration = 0.0;
171     }
172     
173     distance = phase[channel];
174     for (nframes_t outsample = 0; outsample < nframes; outsample++) {
175         i = floor(distance);
176         
177         Sample x = distance - i;
178         
179         /* this would break the assertion below
180         if (x >= 1.0) {
181             x -= 1.0;
182             i++;
183         }
184         */
185         
186         if (input && output) {
187             assert (i <= n-1);
188             double a0 = input[i];
189             double a1 = input[i+1] - input[i] - M[i+1]/6.0 - M[i]/3.0;
190             double a2 = M[i] / 2.0;
191             double a3 = (M[i+1] - M[i]) / 6.0;
192             // interpolate into the output buffer
193             output[outsample] = ((a3*x +a2)*x +a1)*x + a0;
194         }
195         distance += _speed + acceleration;
196     }
197     
198     i = floor(distance);
199     phase[channel] = distance - floor(distance);
200     
201     return i;
202 }
203
204 LibSamplerateInterpolation::LibSamplerateInterpolation() : state (0)
205 {
206         _speed = 1.0;
207 }
208
209 LibSamplerateInterpolation::~LibSamplerateInterpolation() 
210 {
211         for (size_t i = 0; i < state.size(); i++) {
212                 state[i] = src_delete (state[i]);
213         }
214 }
215
216 void
217 LibSamplerateInterpolation::set_speed (double new_speed)
218
219         _speed = new_speed; 
220         for (size_t i = 0; i < state.size(); i++) {
221                 src_set_ratio (state[i], 1.0/_speed);
222         }
223 }
224
225 void
226 LibSamplerateInterpolation::reset_state ()
227 {
228         printf("INTERPOLATION: reset_state()\n");
229         for (size_t i = 0; i < state.size(); i++) {
230                 if (state[i]) {
231                         src_reset (state[i]);
232                 } else {
233                         state[i] = src_new (SRC_SINC_FASTEST, 1, &error);
234                 }
235         }
236 }
237
238 void
239 LibSamplerateInterpolation::add_channel_to (int input_buffer_size, int output_buffer_size) 
240 {
241         SRC_DATA* newdata = new SRC_DATA;
242         
243         /* Set up sample rate converter info. */
244         newdata->end_of_input = 0 ; 
245
246         newdata->input_frames  = input_buffer_size;
247         newdata->output_frames = output_buffer_size;
248
249         newdata->input_frames_used = 0 ;
250         newdata->output_frames_gen = 0 ;
251
252         newdata->src_ratio = 1.0/_speed;
253         
254         data.push_back (newdata);
255         state.push_back (0);
256         
257         reset_state ();
258 }
259
260 void
261 LibSamplerateInterpolation::remove_channel_from () 
262 {
263         SRC_DATA* d = data.back ();
264         delete d;
265         data.pop_back ();
266         if (state.back ()) {
267                 src_delete (state.back ());
268         }
269         state.pop_back ();
270         reset_state ();
271 }
272
273 nframes_t
274 LibSamplerateInterpolation::interpolate (int channel, nframes_t nframes, Sample *input, Sample *output)
275 {       
276         if (!data.size ()) {
277                 printf ("ERROR: trying to interpolate with no channels\n");
278                 return 0;
279         }
280         
281         data[channel]->data_in     = input;
282         data[channel]->data_out   = output;
283         
284         data[channel]->input_frames  = nframes * _speed;
285         data[channel]->output_frames = nframes;
286         data[channel]->src_ratio         = 1.0/_speed; 
287
288         if ((error = src_process (state[channel], data[channel]))) {    
289                 printf ("\nError : %s\n\n", src_strerror (error));
290                 exit (1);
291         }
292         
293         //printf("INTERPOLATION: channel %d input_frames_used: %d\n", channel, data[channel]->input_frames_used);
294         
295         return data[channel]->input_frames_used;
296 }