aboutsummaryrefslogtreecommitdiff
path: root/adaptive/src/lms2~.c
blob: c3c3d3caf1ef4e840b48fe774d6d2accd95c3115 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
/******************************************************
 *
 * Adaptive Systems for PD
 *
 * copyleft (c) Gerda Strobl, Georg Holzmann
 * 2005
 *
 * for complaints, suggestions: grh@mur.at
 *
 ******************************************************
 *
 * license: GNU General Public License v.2
 *
 ******************************************************/

#include "adaptive.h"


/* ------------------------ lms2~ ------------------------- */

static t_class *lms2_tilde_class;

typedef struct _lms2
{
  t_object x_obj;
  t_float f;
  t_atom *coef;
  t_sample *buf;
  t_sample *y_tmp;
  t_sample *e_tmp;
  t_int bufsize;
  t_outlet *c_out;
  int adapt; // enable/disable adaptation
  
  t_int N; //number of coefficients of the adaptive system
  t_float *c; // coefficients of the system
  t_float mu; // step-size parameter (learning rate)

  t_canvas *x_canvas;
} t_lms2_tilde;

static void lms2_tilde_a(t_lms2_tilde *x, t_floatarg f)
{
  x->adapt = (f==0) ? 0 : 1;
}

static void lms2_tilde_geta(t_lms2_tilde *x)
{
  if(x->adapt==0)
    post("lms2~: adaptation is currently OFF");
  else
    post("lms2~: adaptation is currently ON");
}

static void lms2_tilde_mu(t_lms2_tilde *x, t_floatarg f)
{
  x->mu = f;
}

static void lms2_tilde_getmu(t_lms2_tilde *x)
{
  post("mu (step-size parameter): %f", x->mu);
}

static void lms2_tilde_getN(t_lms2_tilde *x)
{
  post("N (number of coefficients): %d", x->N);
}

static void lms2_tilde_clear(t_lms2_tilde *x)
{
  int i;
  
  // clear coefficients
  for(i=0; i<x->N; i++)
    x->c[i] = 0;
  
  // clear temp buffer
  for(i=0; i<x->N-1; i++)
    x->buf[i] = 0;
}

static void lms2_tilde_init(t_lms2_tilde *x)
{
  int i;
  
  // set the first coefficient to 1, all others to 0
  // so this is a delay free transmission
  x->c[0] = 1;
  for(i=1; i<x->N; i++)
    x->c[i] = 0;
  
  // clear temp buffers
  for(i=0; i<x->N-1; i++)
    x->buf[i] = 0;
}

static void lms2_tilde_print(t_lms2_tilde *x)
{
  int i;
  
  // print coefficients
  post("\nNr. of coefficients: %d",x->N);
  post("coefficients:");
  for(i=0; i<x->N; i++)
    post("\t%d: %f",i,x->c[i]);
}

static void lms2_tilde_write(t_lms2_tilde *x, t_symbol *s)
{
  // make correct path
  char filnam[MAXPDSTRING];
  char filename[MAXPDSTRING];
  canvas_makefilename(x->x_canvas, s->s_name, filnam, MAXPDSTRING);
  sys_bashfilename(filnam, filename);

  // save to file
  adaptation_write(filename, x->N, x->mu, x->c);
}

static void lms2_tilde_read(t_lms2_tilde *x, t_symbol *s)
{
  // make correct path
  char filnam[MAXPDSTRING];
  char filename[MAXPDSTRING];
  int n = x->N;
  canvas_makefilename(x->x_canvas, s->s_name, filnam, MAXPDSTRING);
  sys_bashfilename(filnam, filename);
  
  // read file
  adaptation_read(filename, &x->N, &x->mu, x->c, x->buf);
  
  // if length changes:
  if(x->N != n)
  {
    if(x->coef) freebytes(x->coef, sizeof(t_atom) * x->N);
    x->coef = (t_atom *)getbytes(sizeof(t_atom) * x->N);
  }
}

static t_int *lms2_tilde_perform(t_int *w)
{
  t_sample *x_ = (t_sample *)(w[1]);
  t_sample *d_ = (t_sample *)(w[2]);
  t_sample *y_ = (t_sample *)(w[3]);
  t_sample *e_ = (t_sample *)(w[4]);
  int n = (int)(w[5]);
  t_lms2_tilde *x = (t_lms2_tilde *)(w[6]);
  int i, j, tmp;

  
  for(i=0; i<n; i++)
  {
    // calc output (filter)
        
    x->y_tmp[i]=0;
    
    // y_[i] += x->c[j] * x_[i-j];
    // so lets split in two halfs, so that
    // negative indezes get samples from the
    // last audioblock (x->buf) ...
    
    tmp = (i+1 - x->N)*(-1);
    tmp = tmp<0 ? 0 : tmp;
    
    for(j=0; j<x->N-tmp; j++)
      x->y_tmp[i] += x->c[j] * x_[i-j];
    
    for(j=x->N-tmp; j<x->N; j++)
      x->y_tmp[i] += x->c[j] * x->buf[(i-j)*(-1)-1];

    if(x->adapt)
    {
      // error computation
      x->e_tmp[i] = d_[i] - x->y_tmp[i];
        
      // coefficient adaptation
      // (split in the same way as above)
    
      for(j=0; j<x->N-tmp; j++)
        x->c[j] = x->c[j] + x->mu * x_[i-j] * x->e_tmp[i];
    
      for(j=x->N-tmp; j<x->N; j++)
        x->c[j] = x->c[j] + x->mu * x->buf[(i-j)*(-1)-1] * x->e_tmp[i];
    }
    else x->e_tmp[i] = 0;
        
    //post("%d: in %f, d: %f, out: %f, e: %f, c1:%f, c2:%f", i, x_[i], d_[i], x->y_tmp[i], x->e_tmp[i], x->c[0], x->c[1]);
  }
  
  // outlet coefficients
  for(i=0; i<x->N; i++)
    SETFLOAT(&x->coef[i],x->c[i]);
  
  outlet_list(x->c_out, &s_list, x->N, x->coef);
  
  // store last samples for next audiobuffer
  for(i=0; i<x->N-1; i++)
    x->buf[i] = x_[n-1-i];
  
  // now write tmps to outlets
  while(n--)
  {
    y_[n] = x->y_tmp[n];
    e_[n] = x->e_tmp[n];
  }
   
  return (w+7);
}

static void lms2_tilde_dsp(t_lms2_tilde *x, t_signal **sp)
{
  // allocate new temp buffer if buffersize changes
  if(x->bufsize != sp[0]->s_n)
  {
    if(sp[0]->s_n < x->N)
      post("lms2~ WARNING: buffersize must be bigger than N, you will get wrong results !!!");
    
    if(x->y_tmp) freebytes(x->y_tmp, sizeof(t_sample) * x->bufsize);
    x->y_tmp = (t_sample *)getbytes(sizeof(t_sample) * sp[0]->s_n);
    
    if(x->e_tmp) freebytes(x->e_tmp, sizeof(t_sample) * x->bufsize);
    x->e_tmp = (t_sample *)getbytes(sizeof(t_sample) * sp[0]->s_n);
    
    x->bufsize =  sp[0]->s_n;
  }
  
  dsp_add(lms2_tilde_perform, 6, sp[0]->s_vec, sp[1]->s_vec, 
          sp[2]->s_vec, sp[3]->s_vec, sp[0]->s_n, x);
}

static void lms2_tilde_helper(void)
{
  post("\nlms2~: Adaptive transversal filter using LMS (for algorithm analysis)");
  post("INPUT:");
  post("\tinlet1: input signal x[n]");
  post("\tinlet2: desired output signal d[n]");
  post("\tinit_arg1: number of coefficients of the adaptive system");
  post("\tinit_arg2, mu: step-size parameter (learning rate)");
  post("OUTPUT:");
  post("\toutlet1: output signal y[n]");
  post("\toutlet2: error signal e[n]");
  post("\toutlet3: coefficients c[n] (only per block)\n");
}

static void *lms2_tilde_new(t_symbol *s, int argc, t_atom *argv)
{
  t_lms2_tilde *x = (t_lms2_tilde *)pd_new(lms2_tilde_class);
  int i;
  
  // default values:
  x->N = 8;
  x->mu = 0.05;
  x->adapt = 0;
  x->y_tmp = NULL;
  x->e_tmp = NULL;
  x->bufsize = 0;
  
  switch(argc)
  {
    case 2:
      x->mu = atom_getfloat(argv+1);
    case 1:
      x->N = atom_getint(argv);
      x->N = (x->N<=0) ? 1 : x->N;
  }
  
  // allocate mem and init coefficients
  x->c = (t_float *)getbytes(sizeof(t_float) * x->N);
  for(i=0; i<x->N; i++)
    x->c[i] = 0;
  
  // allocate mem for temp buffer
  x->buf = (t_float *)getbytes(sizeof(t_float) * x->N-1);
  for(i=0; i<x->N-1; i++)
    x->buf[i] = 0;
  
  // for output atoms (coefficients):
  x->coef = (t_atom *)getbytes(sizeof(t_atom) * x->N);
  
  inlet_new(&x->x_obj, &x->x_obj.ob_pd, &s_signal, &s_signal);
  outlet_new(&x->x_obj, &s_signal);
  outlet_new(&x->x_obj, &s_signal);
  x->c_out = outlet_new(&x->x_obj, 0);
  
  x->x_canvas = canvas_getcurrent();


  return (x);
}

static void lms2_tilde_free(t_lms2_tilde *x)
{
  if(x->c) freebytes(x->c, sizeof(t_float) * x->N);
  if(x->buf) freebytes(x->buf, sizeof(t_sample) * x->N-1);
  if(x->y_tmp) freebytes(x->y_tmp, sizeof(t_sample) * x->bufsize);
  if(x->e_tmp) freebytes(x->e_tmp, sizeof(t_sample) * x->bufsize);
  if(x->coef) freebytes(x->coef, sizeof(t_atom) * x->N);
}

void lms2_tilde_setup(void)
{
  lms2_tilde_class = class_new(gensym("lms2~"), (t_newmethod)lms2_tilde_new, 
                    (t_method)lms2_tilde_free, sizeof(t_lms2_tilde), 
                    CLASS_DEFAULT, A_GIMME, 0);

  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_a,
                  gensym("adaptation"), A_DEFFLOAT, 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_geta,
                  gensym("getadaptation"), 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_mu, 
                  gensym("mu"), A_DEFFLOAT, 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_getmu,
                  gensym("getmu"), 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_getN,
                  gensym("getN"), 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_init,
                  gensym("init_unity"), 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_clear,
                  gensym("clear"), 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_print,
                  gensym("print"), 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_write, 
                  gensym("write"), A_DEFSYMBOL, 0);
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_read, 
                  gensym("read"), A_DEFSYMBOL, 0);

  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_dsp, gensym("dsp"), 0);
  CLASS_MAINSIGNALIN(lms2_tilde_class, t_lms2_tilde, f);
  
  class_addmethod(lms2_tilde_class, (t_method)lms2_tilde_helper, gensym("help"), 0);
}