Some minor (bitexact) AEC echo suppressor refactoring (#2)

webrtc/modules/audio_processing/aec/aec_core.c

 /*
  *  Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
@@ skipping 309 matching lines @@
 // Threshold to protect against the ill-effects of a zero far-end.
 const float WebRtcAec_kMinFarendPSD = 15;
 
 // Updates the following smoothed  Power Spectral Densities (PSD):
 //  - sd  : near-end
 //  - se  : residual echo
 //  - sx  : far-end
 //  - sde : cross-PSD of near-end and residual echo
 //  - sxd : cross-PSD of near-end and far-end
 //
-// In addition to updating the PSDs, also the filter diverge state is determined
-// upon actions are taken.
+// In addition to updating the PSDs, also the filter diverge state is
+// determined.
 static void SmoothedPSD(AecCore* aec,
                         float efw[2][PART_LEN1],
                         float dfw[2][PART_LEN1],
-                        float xfw[2][PART_LEN1]) {
+                        float xfw[2][PART_LEN1],
+                        int *const extreme_filter_divergence) {

[hlundin-webrtc, 2015/12/04 10:27:55]

This const declaration doesn't give much, in my opinion.

[peah-webrtc, 2015/12/04 22:11:48]

Removed.
Done.

   // Power estimate smoothing coefficients.
   const float* ptrGCoh = aec->extended_filter_enabled
       ? WebRtcAec_kExtendedSmoothingCoefficients[aec->mult - 1]
       : WebRtcAec_kNormalSmoothingCoefficients[aec->mult - 1];
   int i;
   float sdSum = 0, seSum = 0;
 
   for (i = 0; i < PART_LEN1; i++) {
     aec->sd[i] = ptrGCoh[0] * aec->sd[i] +
                  ptrGCoh[1] * (dfw[0][i] * dfw[0][i] + dfw[1][i] * dfw[1][i]);
@@ skipping 20 matching lines @@
         ptrGCoh[0] * aec->sxd[i][0] +
         ptrGCoh[1] * (dfw[0][i] * xfw[0][i] + dfw[1][i] * xfw[1][i]);
     aec->sxd[i][1] =
         ptrGCoh[0] * aec->sxd[i][1] +
         ptrGCoh[1] * (dfw[0][i] * xfw[1][i] - dfw[1][i] * xfw[0][i]);
 
     sdSum += aec->sd[i];
     seSum += aec->se[i];
   }
 
-  // Divergent filter safeguard.
+  // Divergent filter safeguard update.
   aec->divergeState = (aec->divergeState ? 1.05f : 1.0f) * seSum > sdSum;
 
-  if (aec->divergeState)
-    memcpy(efw, dfw, sizeof(efw[0][0]) * 2 * PART_LEN1);
-
-  // Reset if error is significantly larger than nearend (13 dB).
-  if (!aec->extended_filter_enabled && seSum > (19.95f * sdSum))
-    memset(aec->wfBuf, 0, sizeof(aec->wfBuf));
+  // Signal extreme filter divergence if the error is significantly larger
+  // than the nearend (13 dB).
+  *extreme_filter_divergence = (seSum > (19.95f * sdSum));
 }
 
 // Window time domain data to be used by the fft.
 __inline static void WindowData(float* x_windowed, const float* x) {
   int i;
   for (i = 0; i < PART_LEN; i++) {
     x_windowed[i] = x[i] * WebRtcAec_sqrtHanning[i];
     x_windowed[PART_LEN + i] =
         x[PART_LEN + i] * WebRtcAec_sqrtHanning[PART_LEN - i];
   }
@@ skipping 12 matching lines @@
   data_complex[0][PART_LEN] = data[1];
   data_complex[1][PART_LEN] = 0;
 }
 
 static void SubbandCoherence(AecCore* aec,
                              float efw[2][PART_LEN1],
                              float dfw[2][PART_LEN1],
                              float xfw[2][PART_LEN1],
                              float* fft,
                              float* cohde,
-                             float* cohxd) {
+                             float* cohxd,
+                             int *const extreme_filter_divergence) {

[hlundin-webrtc, 2015/12/04 10:27:55]

Skip const.

[peah-webrtc, 2015/12/04 22:11:48]

Done.

   int i;
 
-  SmoothedPSD(aec, efw, dfw, xfw);
+  SmoothedPSD(aec, efw, dfw, xfw, extreme_filter_divergence);
 
   // Subband coherence
   for (i = 0; i < PART_LEN1; i++) {
     cohde[i] =
         (aec->sde[i][0] * aec->sde[i][0] + aec->sde[i][1] * aec->sde[i][1]) /
         (aec->sd[i] * aec->se[i] + 1e-10f);
     cohxd[i] =
         (aec->sxd[i][0] * aec->sxd[i][0] + aec->sxd[i][1] * aec->sxd[i][1]) /
         (aec->sx[i] * aec->sd[i] + 1e-10f);
   }
@@ skipping 507 matching lines @@
     float echo_subtractor_output[PART_LEN]) {
   float s_fft[2][PART_LEN1];
   float e_extended[PART_LEN2];
   float s_extended[PART_LEN2];
   float *s;
   float e[PART_LEN];
   float e_fft[2][PART_LEN1];
   int i;
   memset(s_fft, 0, sizeof(s_fft));
 
+  // Conditionally reset the echo subtraction filter if the filter has diverged
+  // significantly.
+  if (!aec->extended_filter_enabled &&
+      aec->esup_detected_extreme_filter_divergence) {

[minyue-webrtc, 2015/12/04 10:11:38]

Error

extreme_filter_divergence may not be
aec->esup_detected_extreme_filter_divergence

[peah-webrtc, 2015/12/04 22:11:48]

Could you please elaborate? I don't see the error. 

[minyue-webrtc, 2015/12/05 20:55:20]

I think the folding made me think this lines belonged to SubbandCoherence(),
where extreme_filter_divergence is an argument. Never mind.

+    memset(aec->wfBuf, 0, sizeof(aec->wfBuf));
+    aec->esup_detected_extreme_filter_divergence = 0;
+  }
+

[hlundin-webrtc, 2015/12/04 10:27:55]

Remove (at least) one blank line.

[peah-webrtc, 2015/12/04 22:11:48]

Done.

+
   // Produce echo estimate s_fft.
   WebRtcAec_FilterFar(num_partitions,
                       x_fft_buf_block_pos,
                       x_fft_buf,
                       h_fft_buf,
                       s_fft);
 
   // Compute the time-domain echo estimate s.
   InverseFft(s_fft, s_extended);
   s = &s_extended[PART_LEN];
@@ skipping 107 matching lines @@
   memcpy(aec->xfwBuf, xfw_ptr, sizeof(float) * 2 * PART_LEN1);
 
   if (aec->delayEstCtr == 0)
     aec->delayIdx = WebRtcAec_PartitionDelay(aec);
 
   // Use delayed far.
   memcpy(xfw,
          aec->xfwBuf + aec->delayIdx * PART_LEN1,
          sizeof(xfw[0][0]) * 2 * PART_LEN1);
 
-  WebRtcAec_SubbandCoherence(aec, efw, dfw, xfw, fft, cohde, cohxd);
+  WebRtcAec_SubbandCoherence(aec, efw, dfw, xfw, fft, cohde, cohxd,
+                             &aec->esup_detected_extreme_filter_divergence);
+

[hlundin-webrtc, 2015/12/04 10:27:55]

Remove (at least) one blank line.

[peah-webrtc, 2015/12/04 22:11:48]

Done.

+
+  // Select the microphone signal as output if the filter is deemed to have

[hlundin-webrtc, 2015/12/04 10:27:55]

Is this new behavior? Or did I miss where you took it from?

[peah-webrtc, 2015/12/04 22:11:48]

This is moved from the SmoothedPSD function where the divergeState is computed.
So no new behavior.

+  // diverged.
+  if (aec->divergeState) {
+    memcpy(efw, dfw, sizeof(efw[0][0]) * 2 * PART_LEN1);
+  }
+

[hlundin-webrtc, 2015/12/04 10:27:55]

Remove (at least) one blank line.

[peah-webrtc, 2015/12/04 22:11:48]

Done.

 
   hNlXdAvg = 0;
   for (i = minPrefBand; i < prefBandSize + minPrefBand; i++) {
     hNlXdAvg += cohxd[i];
   }
   hNlXdAvg /= prefBandSize;
   hNlXdAvg = 1 - hNlXdAvg;
 
   hNlDeAvg = 0;
   for (i = minPrefBand; i < prefBandSize + minPrefBand; i++) {
@@ skipping 647 matching lines @@
   aec->overDrive = 2;
   aec->overDriveSm = 2;
   aec->delayIdx = 0;
   aec->stNearState = 0;
   aec->echoState = 0;
   aec->divergeState = 0;
 
   aec->seed = 777;
   aec->delayEstCtr = 0;
 
+  aec->esup_detected_extreme_filter_divergence = 0;
+
   // Metrics disabled by default
   aec->metricsMode = 0;
   InitMetrics(aec);
 
   return 0;
 }
 
 void WebRtcAec_BufferFarendPartition(AecCore* aec, const float* farend) {
   float fft[PART_LEN2];
   float xf[2][PART_LEN1];
@@ skipping 214 matching lines @@
 int WebRtcAec_extended_filter_enabled(AecCore* self) {
   return self->extended_filter_enabled;
 }
 
 int WebRtcAec_system_delay(AecCore* self) { return self->system_delay; }
 
 void WebRtcAec_SetSystemDelay(AecCore* self, int delay) {
   assert(delay >= 0);
   self->system_delay = delay;
 }