cmProc5.h/c : Added parameter setters to cmNlmsEc.

cmProc5.c

@@ -914,18 +914,20 @@ cmRC_t cmReflectCalcWrite( cmReflectCalc_t* p, const char* dirStr )
 //=======================================================================================================================
 // 
 //
-cmNlmsEc_t* cmNlmsEcAlloc( cmCtx* ctx, cmNlmsEc_t* ap, float mu, unsigned hN, unsigned delayN )
+cmNlmsEc_t* cmNlmsEcAlloc( cmCtx* ctx, cmNlmsEc_t* ap, double srate, float mu, unsigned hN, unsigned delayN )
 {
   cmNlmsEc_t* p = cmObjAlloc(cmNlmsEc_t,ctx,ap);
 
+  bool debugFl = false;
+  
   // allocate the vect array's
-  p->uVa = cmVectArrayAlloc(ctx, kFloatVaFl );
+  p->uVa = debugFl ? cmVectArrayAlloc(ctx, kFloatVaFl ) : NULL;
-  p->fVa = cmVectArrayAlloc(ctx, kFloatVaFl );
+  p->fVa = debugFl ? cmVectArrayAlloc(ctx, kFloatVaFl ) : NULL;
-  p->eVa = cmVectArrayAlloc(ctx, kFloatVaFl );
+  p->eVa = debugFl ? cmVectArrayAlloc(ctx, kFloatVaFl ) : NULL;
    
   
-  if( mu != 0 )  
+  if( srate != 0 )  
-    if( cmNlmsEcInit(p,mu,hN,delayN) != cmOkRC )
+    if( cmNlmsEcInit(p,srate,mu,hN,delayN) != cmOkRC )
       cmNlmsEcFree(&p);
 
   return p;
@@ -952,18 +954,24 @@ cmRC_t      cmNlmsEcFree( cmNlmsEc_t** pp )
  
 }
 
-cmRC_t      cmNlmsEcInit( cmNlmsEc_t* p, float mu, unsigned hN, unsigned delayN )
+cmRC_t      cmNlmsEcInit( cmNlmsEc_t* p, double srate, float mu, unsigned hN, unsigned delayN )
 {
   cmRC_t rc = cmOkRC;
 
   if((rc = cmNlmsEcFinal(p)) != cmOkRC )
     return rc;
 
+  assert( srate >= hN );
+  assert( srate >= delayN );
+  
   p->mu     = mu;
   p->hN     = hN;
-  p->delayN = delayN;
+  p->delayN = cmMax(1,delayN);
-  p->wV     = cmMemResizeZ(double,p->wV,hN);
+  p->dN     = srate;
-  p->hV     = cmMemResizeZ(double,p->hV,hN);
+  p->delayV = cmMemResizeZ(cmSample_t, p->delayV, srate );
+  p->di     = 0;
+  p->wV     = cmMemResizeZ(double,p->wV,srate);
+  p->hV     = cmMemResizeZ(double,p->hV,srate);
   p->w0i    = 0;
   
   return rc;
@@ -972,16 +980,6 @@ cmRC_t      cmNlmsEcInit( cmNlmsEc_t* p, float mu, unsigned hN, unsigned delayN
 cmRC_t      cmNlmsEcFinal( cmNlmsEc_t* p )
 { return cmOkRC; }
 
-/*
-  for n=M:N
-    uv = u(n:-1:n-M+1);
-    e(n) = d(n)-w'*uv;
-    w=w+mu/(a + uv'*uv ) * uv * conj(e(n));
-  endfor
-
-  e = e(:).^2;
-*/
-
 cmRC_t      cmNlmsEcExec( cmNlmsEc_t* p, const cmSample_t* xV, const cmSample_t* fV, cmSample_t* yV, unsigned xyN )
 {
   // See: http://www.eit.lth.se/fileadmin/eit/courses/ett042/CE/CE2e.pdf
@@ -994,8 +992,15 @@ cmRC_t      cmNlmsEcExec( cmNlmsEc_t* p, const cmSample_t* xV, const cmSample_t*
     double     a = 0.001;
     unsigned   j;
 
-    // insert the next sample into the filter delay line
+    // Insert the next sample into the filter delay line.
-    p->hV[p->w0i] = xV[i]; 
+    // Note that rather than shifting the delay line on each iteration we
+    // increment the input location and then align it with the zeroth
+    // weight below.
+    p->hV[p->w0i] = p->delayV[ p->di ];
+    
+    p->delayV[ p->di ] = xV[i];
+
+    p->di = (p->di + 1) % p->delayN;
 
     // calculate the output of the delay w0i:hN 
     for(j=p->w0i,k=0; j<p->hN; ++j,++k)
@@ -1005,7 +1010,7 @@ cmRC_t      cmNlmsEcExec( cmNlmsEc_t* p, const cmSample_t* xV, const cmSample_t*
     for(j=0; j<p->w0i; ++j,++k)
       y += p->hV[j] * p->wV[k];
 
-    // calculate the error
+    // calculate the error which is also the filter output
     double e = fV[i] - y;
     yV[i] = e;
 
@@ -1027,8 +1032,13 @@ cmRC_t      cmNlmsEcExec( cmNlmsEc_t* p, const cmSample_t* xV, const cmSample_t*
 
   }
 
+  if( p->uVa != NULL )
     cmVectArrayAppendS(p->uVa,xV,xyN);
+  
+  if( p->fVa != NULL )
     cmVectArrayAppendS(p->fVa,fV,xyN);
+
+  if( p->eVa != NULL )
     cmVectArrayAppendS(p->eVa,yV,xyN);
    
 
@@ -1048,6 +1058,43 @@ cmRC_t      cmNlmsEcWrite( cmNlmsEc_t* p, const cmChar_t* dirStr )
   if( p->eVa != NULL )
     cmVectArrayWriteDirFn(p->eVa, dirStr, "nlms_out.va");
   
-  
   return cmOkRC;
 }
+
+
+void cmNlmsEcSetMu(     cmNlmsEc_t* p, float mu )
+{
+  if( mu < 0 )
+    p->mu = 0.0001;
+  else
+    if( mu >= 1 )
+      p->mu = 0.99;
+    else
+      p->mu = mu;
+}
+
+void cmNlmsEcSetDelayN( cmNlmsEc_t* p, unsigned delayN )
+{
+  if( delayN > p->dN)
+    delayN = p->dN;
+  else
+    if( delayN < 1 )
+      delayN = 1;
+  
+  cmVOS_Zero(p->delayV,p->delayN);
+  p->delayN = delayN;
+}
+
+void cmNlmsEcSetIrN(    cmNlmsEc_t* p, unsigned hN )
+{
+  if( hN > p->dN )
+    hN = p->dN;
+  else
+    if( hN < 1 )
+      hN = 1;
+
+  cmVOD_Zero(p->wV,p->hN);
+  cmVOD_Zero(p->hV,p->hN);
+  p->hN = hN;
+}
+

cmProc5.h

@@ -234,6 +234,9 @@ extern "C" {
     float          mu;          // LMS step rate
     unsigned       hN;          // filter length
     unsigned       delayN;      // fixed delay to apply to align xV with fV.
+    unsigned       dN;          // max length of the fixed delay
+    cmSample_t*    delayV;      // delayV[ dN ] fixed delay buffer[]
+    unsigned       di;          // delay index
     double*        wV;          // wV[hN] filter weights
     double*        hV;          // hV[hN] filter delay line    
     unsigned       w0i;         // The index into hV[] of the start of the delay line.
@@ -243,9 +246,9 @@ extern "C" {
     cmVectArray_t* eVa;
   } cmNlmsEc_t;
 
-  cmNlmsEc_t* cmNlmsEcAlloc( cmCtx* ctx, cmNlmsEc_t* p, float mu, unsigned hN, unsigned delayN );
+  cmNlmsEc_t* cmNlmsEcAlloc( cmCtx* ctx, cmNlmsEc_t* p, double srate, float mu, unsigned hN, unsigned delayN );
   cmRC_t      cmNlmsEcFree( cmNlmsEc_t** pp );
-  cmRC_t      cmNlmsEcInit( cmNlmsEc_t* p, float mu, unsigned hN, unsigned delayN );
+  cmRC_t      cmNlmsEcInit( cmNlmsEc_t* p, double srate, float mu, unsigned hN, unsigned delayN );
   cmRC_t      cmNlmsEcFinal( cmNlmsEc_t* p );
   
   // xV[] unfiltered reference signal  (direct from xform output)
@@ -254,6 +257,9 @@ extern "C" {
   cmRC_t      cmNlmsEcExec( cmNlmsEc_t* p, const cmSample_t* xV, const cmSample_t* fV, cmSample_t* yV, unsigned xyN );
   cmRC_t      cmNlmsEcWrite( cmNlmsEc_t* p, const cmChar_t* dir );
 
+  void        cmNlmsEcSetMu(     cmNlmsEc_t* p, float mu );
+  void        cmNlmsEcSetDelayN( cmNlmsEc_t* p, unsigned delayN );
+  void        cmNlmsEcSetIrN(    cmNlmsEc_t* p, unsigned irN );
   
   
 #ifdef __cplusplus