Finalization of the first version of EchoCanceller 3

webrtc/modules/audio_processing/aec3/render_signal_analyzer_unittest.cc

Index: webrtc/modules/audio_processing/aec3/render_signal_analyzer_unittest.cc
diff --git a/webrtc/modules/audio_processing/aec3/render_signal_analyzer_unittest.cc b/webrtc/modules/audio_processing/aec3/render_signal_analyzer_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..2627df73d64b70a829279b82b79dd4fe1d208d37
--- /dev/null
+++ b/webrtc/modules/audio_processing/aec3/render_signal_analyzer_unittest.cc
@@ -0,0 +1,111 @@
+/*
+ *  Copyright (c) 2017 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.
+ */
+
+#include "webrtc/modules/audio_processing/aec3/render_signal_analyzer.h"
+
+#include <math.h>
+#include <array>
+#include <vector>
+
+#include "webrtc/base/array_view.h"
+#include "webrtc/base/random.h"
+#include "webrtc/modules/audio_processing/aec3/aec3_constants.h"
+#include "webrtc/modules/audio_processing/aec3/aec3_fft.h"
+#include "webrtc/modules/audio_processing/aec3/fft_buffer.h"
+#include "webrtc/modules/audio_processing/aec3/fft_data.h"
+#include "webrtc/modules/audio_processing/test/echo_canceller_test_tools.h"
+#include "webrtc/test/gtest.h"
+
+namespace webrtc {
+namespace {
+
+constexpr float kPi = 3.141592f;
+
+void ProduceSinusoidalSignal(int sample_rate_hz,

[hlundin-webrtc, 2017/02/13 21:37:01]

Shorten the name to ProduceSinusoid.

[peah-webrtc, 2017/02/20 07:37:18]

Done.

+                             float sinusoidal_frequency_hz,
+                             size_t* sample_counter,
+                             rtc::ArrayView<float> x) {
+  // Produce a sinusoid of the specified frequency.
+  for (size_t k = *sample_counter, j = 0; k < (*sample_counter + kBlockSize);
+       ++k, ++j) {
+    x[j] =
+        32767.f * sin(2.f * kPi * sinusoidal_frequency_hz * k / sample_rate_hz);
+  }
+  *sample_counter = *sample_counter + kBlockSize;
+}
+
+}  // namespace
+
+#if RTC_DCHECK_IS_ON && GTEST_HAS_DEATH_TEST && !defined(WEBRTC_ANDROID)
+// Verifies that the check for non-null output parameter works.
+TEST(RenderSignalAnalyzer, NullMaskOutput) {
+  RenderSignalAnalyzer analyzer;
+  EXPECT_DEATH(analyzer.MaskRegionsAroundNarrowBands(nullptr), "");
+}
+
+#endif
+
+TEST(RenderSignalAnalyzer, BasicSetup) {
+  RenderSignalAnalyzer analyzer;
+
+  Random random_generator(42U);
+  std::vector<float> x(kBlockSize, 0.f);
+  std::array<float, kBlockSize> x_old;
+  FftData X;
+  Aec3Fft fft;
+  FftBuffer X_buffer(1, std::vector<size_t>(1, 1));
+  std::array<float, kFftLengthBy2Plus1> mask;
+  x_old.fill(0.f);
+  constexpr int kSinusFrequencyBin = 32;
+
+  // Verify that no narrow bands are present in a Gaussian noise signal.
+  for (size_t k = 0; k < 100; ++k) {
+    RandomizeSampleVector(&random_generator, x);
+    fft.PaddedFft(x, x_old, &X);
+    X_buffer.Insert(X);
+    analyzer.Update(X_buffer, rtc::Optional<size_t>(0));
+  }
+
+  mask.fill(1.f);
+  analyzer.MaskRegionsAroundNarrowBands(&mask);
+  std::for_each(mask.begin(), mask.end(), [](float a) { EXPECT_EQ(1.f, a); });

[hlundin-webrtc, 2017/02/13 21:37:01]

Consider:
EXPECT_TRUE(std::all_of(mask.begin(), mask.end(), [](float a) { a == 1.f; });

[peah-webrtc, 2017/02/20 07:37:18]

Nice one!

Done.

+  EXPECT_FALSE(analyzer.PoorSignalExcitation());
+
+  auto generate_sinusoid_test = [&](bool known_delay) {
+    size_t sample_counter = 0;
+    for (size_t k = 0; k < 100; ++k) {
+      ProduceSinusoidalSignal(16000,
+                              16000 / 2 * kSinusFrequencyBin / kFftLengthBy2,
+                              &sample_counter, x);
+      fft.PaddedFft(x, x_old, &X);
+      X_buffer.Insert(X);
+      analyzer.Update(X_buffer, known_delay ? rtc::Optional<size_t>(0)
+                                            : rtc::Optional<size_t>());
+    }
+  };
+
+  // Verify that a sinusiod signal is detected as narrow bands.

[hlundin-webrtc, 2017/02/13 21:37:01]

This seems like a new TEST.

[peah-webrtc, 2017/02/20 07:37:18]

Done.

+  generate_sinusoid_test(true);
+  mask.fill(1.f);
+  analyzer.MaskRegionsAroundNarrowBands(&mask);
+  for (int k = 0; k < static_cast<int>(mask.size()); ++k) {
+    EXPECT_EQ(abs(k - kSinusFrequencyBin) <= 2 ? 0.f : 1.f, mask[k]);
+  }
+  EXPECT_TRUE(analyzer.PoorSignalExcitation());
+
+  // Verify that a no bands are detected as narrow when the delay is unknown.

[hlundin-webrtc, 2017/02/13 21:37:01]

Delete 'a'

[hlundin-webrtc, 2017/02/13 21:37:01]

Seems like yet another TEST.

[peah-webrtc, 2017/02/20 07:37:18]

Done.

[peah-webrtc, 2017/02/20 07:37:18]

Done.

+  generate_sinusoid_test(false);
+  mask.fill(1.f);
+  analyzer.MaskRegionsAroundNarrowBands(&mask);
+  std::for_each(mask.begin(), mask.end(), [](float a) { EXPECT_EQ(1.f, a); });
+  EXPECT_FALSE(analyzer.PoorSignalExcitation());
+}
+

[hlundin-webrtc, 2017/02/13 21:37:01]

You are only testing with an input mask with all ones. But if I understand the
implementation correctly, it should leave non-masked bins untouched. So, I'd
like to see a test where a mask set to !=1 is verified to be untouched outside
of the masked bins.

[peah-webrtc, 2017/02/20 07:37:18]

That is tested on line 99.

+}  // namespace webrtc