Reland of added functionality for specifying the initial signal level to use for the gain estimation

webrtc/modules/audio_processing/audio_processing_unittest.cc

 /*
  *  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.
  */
 
 #include <math.h>
 #include <stdio.h>
 
 #include <algorithm>
 #include <limits>
 #include <memory>
 #include <queue>
 
 #include "webrtc/base/arraysize.h"
 #include "webrtc/base/checks.h"
 #include "webrtc/common_audio/include/audio_util.h"
 #include "webrtc/common_audio/resampler/include/push_resampler.h"
 #include "webrtc/common_audio/resampler/push_sinc_resampler.h"
 #include "webrtc/common_audio/signal_processing/include/signal_processing_library.h"
+#include "webrtc/modules/audio_processing/audio_processing_impl.h"
 #include "webrtc/modules/audio_processing/beamformer/mock_nonlinear_beamformer.h"
 #include "webrtc/modules/audio_processing/common.h"
 #include "webrtc/modules/audio_processing/include/audio_processing.h"
 #include "webrtc/modules/audio_processing/test/protobuf_utils.h"
 #include "webrtc/modules/audio_processing/test/test_utils.h"
 #include "webrtc/modules/include/module_common_types.h"
 #include "webrtc/system_wrappers/include/event_wrapper.h"
 #include "webrtc/system_wrappers/include/trace.h"
 #include "webrtc/test/testsupport/fileutils.h"
 #ifdef WEBRTC_ANDROID_PLATFORM_BUILD
@@ skipping 2732 matching lines @@
                     std::tr1::make_tuple(16000, 44100, 16000, 44100, 15, 15),
                     std::tr1::make_tuple(16000, 32000, 48000, 32000, 25, 35),
                     std::tr1::make_tuple(16000, 32000, 32000, 32000, 25, 0),
                     std::tr1::make_tuple(16000, 32000, 16000, 32000, 25, 20),
                     std::tr1::make_tuple(16000, 16000, 48000, 16000, 35, 20),
                     std::tr1::make_tuple(16000, 16000, 32000, 16000, 35, 20),
                     std::tr1::make_tuple(16000, 16000, 16000, 16000, 0, 0)));
 #endif
 
 }  // namespace
+
+TEST(ApmConfiguration, LevelController) {
+  const float kTolerance = 0.0001f;
+  // Verify that the level controller is default off, it can be activate using

[hlundin-webrtc, 2016/09/19 12:03:03]

activate -> activated

[peah-webrtc, 2016/09/19 16:37:10]

Done.

+  // the config, and that the default initial level is maintained after the
+  // config has been appied.

[hlundin-webrtc, 2016/09/19 12:03:03]

appied -> applied

[peah-webrtc, 2016/09/19 16:37:10]

Done.

+  std::unique_ptr<AudioProcessingImpl> apm(
+      new AudioProcessingImpl(webrtc::Config()));
+  AudioProcessing::Config config;
+  EXPECT_FALSE(apm->config_.level_controller.enabled);
+  // TODO(peah): Add test for the existence of the level controller object once
+  // that is created only when the that is specified in the config.

[the sun, 2016/09/16 12:40:24]

"the that"

[peah-webrtc, 2016/09/19 16:37:10]

Done.

+  // TODO(peah): Remove the testing for
+  // apm->capture_nonlocked_.level_controller_enabled once the value in config_
+  // is instead used to activate the level controller.
+  EXPECT_FALSE(apm->capture_nonlocked_.level_controller_enabled);
+  EXPECT_NEAR(-6.0206f, apm->config_.level_controller.initial_peak_level,
+              kTolerance);
+  config.level_controller.enabled = true;
+  apm->ApplyConfig(config);
+  EXPECT_TRUE(apm->config_.level_controller.enabled);
+  // TODO(peah): Add test for the existence of the level controller object once
+  // that is created only when the that is specified in the config.
+  // TODO(peah): Remove the testing for
+  // apm->capture_nonlocked_.level_controller_enabled once the value in config_
+  // is instead used to activate the level controller.
+  EXPECT_TRUE(apm->capture_nonlocked_.level_controller_enabled);
+  EXPECT_NEAR(-6.0206f, apm->config_.level_controller.initial_peak_level,
+              kTolerance);
+
+  // Verify that the initial level can be specified and is retained after the
+  // config has been applied.
+  apm.reset(new AudioProcessingImpl(webrtc::Config()));

[the sun, 2016/09/16 12:40:24]

Split up into several test cases instead - it shouldn't be too much work/code
since you're already adding lines to reset the state.

[hlundin-webrtc, 2016/09/19 12:03:03]

Acknowledged.

[peah-webrtc, 2016/09/19 16:37:10]

Acknowledged.

[peah-webrtc, 2016/09/19 16:37:10]

I'm all in for that, but in order to limit the number of
FRIEND_TEST_ALL_PREFIXES lines in the AudioProcessingImpl class when the other
submodules are also transitioned into the new parameter scheme I'll group the
tests into 4 categories that suit all submodules. Please let me know what you
think of that!

Done.

[the sun, 2016/09/19 18:53:56]

Agree declaring friends all over APMImpl is not the way to go.

[peah-webrtc, 2016/09/22 06:00:06]

Acknowledged.

+  config = AudioProcessing::Config();
+  config.level_controller.initial_peak_level = -50.f;
+  apm->ApplyConfig(config);
+  EXPECT_FALSE(apm->config_.level_controller.enabled);
+  // TODO(peah): Add test for the existence of the level controller object once
+  // that is created only when the that is specified in the config.
+  // TODO(peah): Remove the testing for
+  // apm->capture_nonlocked_.level_controller_enabled once the value in config_
+  // is instead used to activate the level controller.
+  EXPECT_FALSE(apm->capture_nonlocked_.level_controller_enabled);
+  EXPECT_NEAR(-50.f, apm->config_.level_controller.initial_peak_level,
+              kTolerance);
+
+  // Verify that the config is properly reset when nonproper values are applied
+  // for the initial level.
+  apm.reset(new AudioProcessingImpl(webrtc::Config()));
+  config = AudioProcessing::Config();
+  config.level_controller.enabled = true;
+  config.level_controller.initial_peak_level = -101.f;
+  apm->ApplyConfig(config);
+  EXPECT_FALSE(apm->config_.level_controller.enabled);
+  // TODO(peah): Add test for the existence of the level controller object once
+  // that is created only when the that is specified in the config.
+  // TODO(peah): Remove the testing for
+  // apm->capture_nonlocked_.level_controller_enabled once the value in config_
+  // is instead used to activate the level controller.
+  EXPECT_FALSE(apm->capture_nonlocked_.level_controller_enabled);
+  EXPECT_NEAR(-6.0206f, apm->config_.level_controller.initial_peak_level,
+              kTolerance);
+
+  apm.reset(new AudioProcessingImpl(webrtc::Config()));
+  config = AudioProcessing::Config();
+  config.level_controller.enabled = true;
+  config.level_controller.initial_peak_level = 1.f;
+  apm->ApplyConfig(config);
+  EXPECT_FALSE(apm->config_.level_controller.enabled);
+  // TODO(peah): Add test for the existence of the level controller object once
+  // that is created only when the that is specified in the config.
+  // TODO(peah): Remove the testing for
+  // apm->capture_nonlocked_.level_controller_enabled once the value in config_
+  // is instead used to activate the level controller.
+  EXPECT_FALSE(apm->capture_nonlocked_.level_controller_enabled);
+  EXPECT_NEAR(-6.0206f, apm->config_.level_controller.initial_peak_level,
+              kTolerance);
+}
+
 }  // namespace webrtc