New module for the adaptive level controlling functionality in the audio processing module

webrtc/modules/audio_processing/level_controller/gain_applier.cc

Index: webrtc/modules/audio_processing/level_controller/gain_applier.cc
diff --git a/webrtc/modules/audio_processing/level_controller/gain_applier.cc b/webrtc/modules/audio_processing/level_controller/gain_applier.cc
new file mode 100644
index 0000000000000000000000000000000000000000..fbc714608c120ee3adbcc02442ebd76f78cf26db
--- /dev/null
+++ b/webrtc/modules/audio_processing/level_controller/gain_applier.cc
@@ -0,0 +1,140 @@
+/*
+ *  Copyright (c) 2016 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/level_controller/gain_applier.h"
+
+#include <algorithm>
+
+#include "webrtc/base/array_view.h"
+#include "webrtc/base/checks.h"
+
+#include "webrtc/modules/audio_processing/audio_buffer.h"
+#include "webrtc/modules/audio_processing/logging/apm_data_dumper.h"
+
+namespace webrtc {
+namespace {
+
+const float kMaxSampleValue = 32767.f;
+const float kMinSampleValue = -32767.f;
+
+int CountSaturations(rtc::ArrayView<const float> in) {

[hlundin-webrtc, 2016/06/27 11:21:14]

You can implement this as a one-liner:

return std::count_if(in.begin(), in.end(), [](float v) { return v >=
kMaxSampleValue || v <= kMinSampleValue; });

[peah-webrtc, 2016/06/27 22:51:47]

Wow! Impressive! Thanks!!!
Done.

+  int num_saturations = 0;
+  for (auto v : in) {
+    if (v >= kMaxSampleValue || v <= kMinSampleValue) {
+      ++num_saturations;
+    }
+  }
+  return num_saturations;
+}
+
+int CountSaturations(const AudioBuffer& audio) {
+  int num_saturations = 0;
+  for (size_t k = 0; k < audio.num_channels(); ++k) {
+    num_saturations += CountSaturations(rtc::ArrayView<const float>(
+        audio.channels_const_f()[k], audio.num_frames()));
+  }
+  return num_saturations;
+}
+
+void LimitToAllowedRange(rtc::ArrayView<float> x) {
+  for (auto& v : x) {
+    v = std::max(kMinSampleValue, v);
+    v = std::min(kMaxSampleValue, v);
+  }
+}
+
+void LimitToAllowedRange(AudioBuffer* audio) {
+  for (size_t k = 0; k < audio->num_channels(); ++k) {
+    LimitToAllowedRange(
+        rtc::ArrayView<float>(audio->channels_f()[k], audio->num_frames()));
+  }
+}
+
+float ApplyIncreasingGain(float new_gain,
+                          float old_gain,
+                          float step_size,
+                          rtc::ArrayView<float> x) {
+  RTC_DCHECK_LT(0.f, step_size);
+  float gain = old_gain;
+  for (auto& x_v : x) {

[hlundin-webrtc, 2016/06/27 11:21:14]

Stick to the same definition as above, and use v instead of x_v.

[peah-webrtc, 2016/06/27 22:51:47]

Done.

+    gain = std::min(new_gain, gain + step_size);
+    x_v *= gain;
+  }
+  return gain;
+}
+
+float ApplyDecreasingGain(float new_gain,
+                          float old_gain,
+                          float step_size,
+                          rtc::ArrayView<float> x) {
+  RTC_DCHECK_LT(0.f, step_size);
+  float gain = old_gain;
+  for (auto& x_v : x) {
+    gain = std::max(new_gain, gain - step_size);
+    x_v *= gain;
+  }
+  return gain;
+}
+
+void ApplyConstantGain(float gain, rtc::ArrayView<float> x) {
+  for (auto& x_v : x) {
+    x_v *= gain;
+  }
+}
+
+float ApplyGain(float new_gain,
+                float old_gain,
+                float step_size,
+                rtc::ArrayView<float> x) {
+  float last_applied_gain = new_gain;

[hlundin-webrtc, 2016/06/27 11:21:14]

Not needed, with my suggestions below.

[peah-webrtc, 2016/06/27 22:51:47]

Done.

+  if (new_gain == old_gain) {
+    ApplyConstantGain(new_gain, x);

[hlundin-webrtc, 2016/06/27 11:21:14]

ApplyConstantGain(new_gain, x);
return new_gain;

or...

Make ApplyConstantGain return the gain, just as the other functions do, and
simply return ApplyConstantGain(...

[peah-webrtc, 2016/06/27 22:51:47]

Nice!!!
Done.

+  } else if (new_gain > old_gain) {
+    last_applied_gain = ApplyIncreasingGain(new_gain, old_gain, step_size, x);

[hlundin-webrtc, 2016/06/27 11:21:14]

return ApplyIncreasingGain(...

[peah-webrtc, 2016/06/27 22:51:47]

Done.

+  } else {
+    last_applied_gain = ApplyDecreasingGain(new_gain, old_gain, step_size, x);

[hlundin-webrtc, 2016/06/27 11:21:14]

return ApplyDecreasingGain(...

[peah-webrtc, 2016/06/27 22:51:47]

Done.

+  }
+  return last_applied_gain;
+}
+
+}  // namespace
+
+GainApplier::GainApplier(ApmDataDumper* data_dumper)
+    : data_dumper_(data_dumper) {}
+
+void GainApplier::Initialize(int sample_rate_hz) {
+  RTC_DCHECK_LE(0.f, sample_rate_hz);

[hlundin-webrtc, 2016/06/27 11:21:14]

Is 0 a valid rate?

[peah-webrtc, 2016/06/27 22:51:47]

Good point!
Done.

+  old_gain_ = 1.f;
+  gain_change_step_size_ = 0.001f * (48000.f / sample_rate_hz);
+}
+
+int GainApplier::Process(float new_gain, AudioBuffer* audio) {
+  int num_saturations = 0;

[hlundin-webrtc, 2016/06/27 11:21:14]

You may want to add RTC_DCHECK_NE(gain_change_step_size_, 0.f) to ensure that
Initialize was run before process.

[peah-webrtc, 2016/06/27 22:51:47]

Good point!
Done.

+  if (new_gain != 1.f) {
+    float last_applied_gain = 1.f;
+    for (size_t k = 0; k < audio->num_channels(); ++k) {
+      // TODO(peah): Consider using a faster update rate downwards than upwards.
+      last_applied_gain = ApplyGain(
+          new_gain, old_gain_, gain_change_step_size_,
+          rtc::ArrayView<float>(audio->channels_f()[k], audio->num_frames()));
+    }
+    // TODO(peah): Consider the need for faster gain reduction in case of
+    // excessive saturation.
+    num_saturations = CountSaturations(*audio);
+    LimitToAllowedRange(audio);
+    old_gain_ = last_applied_gain;
+  }
+
+  data_dumper_->DumpRaw("lc_last_applied_gain", 1, &old_gain_);
+
+  return num_saturations;
+}
+
+}  // namespace webrtc