1922fb0ec3
In preparation for a coming refactoring CL, the (fixed) extra saturation margin is now applied into `AdaptiveModeLevelEstimator`. This CL also improves the unit tests by hard-coding its saturation params instead of reading them from a field trial. This reduces the chances of making the test flaky if a default value changes. Tested: Bit-exactness verified with audioproc_f Bug: webrtc:7494 Change-Id: I6765def9887a2f4e55b04d929af754cfecbb1626 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/184927 Commit-Queue: Alessio Bazzica <alessiob@webrtc.org> Reviewed-by: Minyue Li <minyue@webrtc.org> Reviewed-by: Jakob Ivarsson <jakobi@webrtc.org> Cr-Commit-Position: refs/heads/master@{#32172}
115 lines
3.7 KiB
C++
115 lines
3.7 KiB
C++
/*
|
|
* Copyright (c) 2018 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 "modules/audio_processing/agc2/saturation_protector.h"
|
|
|
|
#include "modules/audio_processing/logging/apm_data_dumper.h"
|
|
#include "rtc_base/numerics/safe_compare.h"
|
|
#include "rtc_base/numerics/safe_minmax.h"
|
|
|
|
namespace webrtc {
|
|
namespace {
|
|
|
|
constexpr float kMinLevelDbfs = -90.f;
|
|
|
|
// Min/max margins are based on speech crest-factor.
|
|
constexpr float kMinMarginDb = 12.f;
|
|
constexpr float kMaxMarginDb = 25.f;
|
|
|
|
} // namespace
|
|
|
|
void SaturationProtector::RingBuffer::Reset() {
|
|
next_ = 0;
|
|
size_ = 0;
|
|
}
|
|
|
|
void SaturationProtector::RingBuffer::PushBack(float v) {
|
|
RTC_DCHECK_GE(next_, 0);
|
|
RTC_DCHECK_GE(size_, 0);
|
|
RTC_DCHECK_LT(next_, buffer_.size());
|
|
RTC_DCHECK_LE(size_, buffer_.size());
|
|
buffer_[next_++] = v;
|
|
if (rtc::SafeEq(next_, buffer_.size())) {
|
|
next_ = 0;
|
|
}
|
|
if (rtc::SafeLt(size_, buffer_.size())) {
|
|
size_++;
|
|
}
|
|
}
|
|
|
|
absl::optional<float> SaturationProtector::RingBuffer::Front() const {
|
|
if (size_ == 0) {
|
|
return absl::nullopt;
|
|
}
|
|
RTC_DCHECK_LT(next_, buffer_.size());
|
|
return buffer_[rtc::SafeEq(size_, buffer_.size()) ? next_ : 0];
|
|
}
|
|
|
|
SaturationProtector::SaturationProtector(ApmDataDumper* apm_data_dumper)
|
|
: SaturationProtector(apm_data_dumper, GetInitialSaturationMarginDb()) {}
|
|
|
|
SaturationProtector::SaturationProtector(ApmDataDumper* apm_data_dumper,
|
|
float initial_saturation_margin_db)
|
|
: apm_data_dumper_(apm_data_dumper),
|
|
initial_saturation_margin_db_(initial_saturation_margin_db) {
|
|
Reset();
|
|
}
|
|
|
|
void SaturationProtector::Reset() {
|
|
margin_db_ = initial_saturation_margin_db_;
|
|
peak_delay_buffer_.Reset();
|
|
max_peaks_dbfs_ = kMinLevelDbfs;
|
|
time_since_push_ms_ = 0;
|
|
}
|
|
|
|
void SaturationProtector::UpdateMargin(float speech_peak_dbfs,
|
|
float speech_level_dbfs) {
|
|
// Get the max peak over `kPeakEnveloperSuperFrameLengthMs` ms.
|
|
max_peaks_dbfs_ = std::max(max_peaks_dbfs_, speech_peak_dbfs);
|
|
time_since_push_ms_ += kFrameDurationMs;
|
|
if (time_since_push_ms_ >
|
|
static_cast<int>(kPeakEnveloperSuperFrameLengthMs)) {
|
|
// Push `max_peaks_dbfs_` back into the ring buffer.
|
|
peak_delay_buffer_.PushBack(max_peaks_dbfs_);
|
|
// Reset.
|
|
max_peaks_dbfs_ = kMinLevelDbfs;
|
|
time_since_push_ms_ = 0;
|
|
}
|
|
|
|
// Update margin by comparing the estimated speech level and the delayed max
|
|
// speech peak power.
|
|
// TODO(alessiob): Check with aleloi@ why we use a delay and how to tune it.
|
|
const float difference_db = GetDelayedPeakDbfs() - speech_level_dbfs;
|
|
if (margin_db_ < difference_db) {
|
|
margin_db_ = margin_db_ * kSaturationProtectorAttackConstant +
|
|
difference_db * (1.f - kSaturationProtectorAttackConstant);
|
|
} else {
|
|
margin_db_ = margin_db_ * kSaturationProtectorDecayConstant +
|
|
difference_db * (1.f - kSaturationProtectorDecayConstant);
|
|
}
|
|
|
|
margin_db_ = rtc::SafeClamp<float>(margin_db_, kMinMarginDb, kMaxMarginDb);
|
|
}
|
|
|
|
float SaturationProtector::GetDelayedPeakDbfs() const {
|
|
return peak_delay_buffer_.Front().value_or(max_peaks_dbfs_);
|
|
}
|
|
|
|
void SaturationProtector::DebugDumpEstimate() const {
|
|
if (apm_data_dumper_) {
|
|
apm_data_dumper_->DumpRaw(
|
|
"agc2_adaptive_saturation_protector_delayed_peak_dbfs",
|
|
GetDelayedPeakDbfs());
|
|
apm_data_dumper_->DumpRaw("agc2_adaptive_saturation_margin_db", margin_db_);
|
|
}
|
|
}
|
|
|
|
} // namespace webrtc
|