1 /*
2  *  Copyright (c) 2017 The WebRTC project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 #include "modules/audio_processing/aec3/echo_remover_metrics.h"
12 
13 #include <math.h>
14 #include <algorithm>
15 #include <numeric>
16 
17 #include "rtc_base/numerics/safe_minmax.h"
18 #include "system_wrappers/include/metrics.h"
19 
20 namespace webrtc {
21 
22 namespace {
23 
24 constexpr float kOneByMetricsCollectionBlocks = 1.f / kMetricsCollectionBlocks;
25 
26 }  // namespace
27 
DbMetric()28 EchoRemoverMetrics::DbMetric::DbMetric() : DbMetric(0.f, 0.f, 0.f) {}
DbMetric(float sum_value,float floor_value,float ceil_value)29 EchoRemoverMetrics::DbMetric::DbMetric(float sum_value,
30                                        float floor_value,
31                                        float ceil_value)
32     : sum_value(sum_value), floor_value(floor_value), ceil_value(ceil_value) {}
33 
Update(float value)34 void EchoRemoverMetrics::DbMetric::Update(float value) {
35   sum_value += value;
36   floor_value = std::min(floor_value, value);
37   ceil_value = std::max(ceil_value, value);
38 }
39 
EchoRemoverMetrics()40 EchoRemoverMetrics::EchoRemoverMetrics() {
41   ResetMetrics();
42 }
43 
ResetMetrics()44 void EchoRemoverMetrics::ResetMetrics() {
45   erl_.fill(DbMetric(0.f, 10000.f, 0.000f));
46   erle_.fill(DbMetric(0.f, 0.f, 1000.f));
47   comfort_noise_.fill(DbMetric(0.f, 100000000.f, 0.f));
48   suppressor_gain_.fill(DbMetric(0.f, 1.f, 0.f));
49   active_render_count_ = 0;
50   saturated_capture_ = false;
51 }
52 
Update(const AecState & aec_state,const std::array<float,kFftLengthBy2Plus1> & comfort_noise_spectrum,const std::array<float,kFftLengthBy2Plus1> & suppressor_gain)53 void EchoRemoverMetrics::Update(
54     const AecState& aec_state,
55     const std::array<float, kFftLengthBy2Plus1>& comfort_noise_spectrum,
56     const std::array<float, kFftLengthBy2Plus1>& suppressor_gain) {
57   metrics_reported_ = false;
58   if (++block_counter_ <= kMetricsCollectionBlocks) {
59     aec3::UpdateDbMetric(aec_state.Erl(), &erl_);
60     aec3::UpdateDbMetric(aec_state.Erle(), &erle_);
61     aec3::UpdateDbMetric(comfort_noise_spectrum, &comfort_noise_);
62     aec3::UpdateDbMetric(suppressor_gain, &suppressor_gain_);
63     active_render_count_ += (aec_state.ActiveRender() ? 1 : 0);
64     saturated_capture_ = saturated_capture_ || aec_state.SaturatedCapture();
65   } else {
66     // Report the metrics over several frames in order to lower the impact of
67     // the logarithms involved on the computational complexity.
68     constexpr int kMetricsCollectionBlocksBy2 = kMetricsCollectionBlocks / 2;
69     constexpr float kComfortNoiseScaling = 1.f / (kBlockSize * kBlockSize);
70     switch (block_counter_) {
71       case kMetricsCollectionBlocks + 1:
72         RTC_HISTOGRAM_COUNTS_LINEAR(
73             "WebRTC.Audio.EchoCanceller.ErleBand0.Average",
74             aec3::TransformDbMetricForReporting(true, 0.f, 19.f, 0.f,
75                                                 kOneByMetricsCollectionBlocks,
76                                                 erle_[0].sum_value),
77             0, 19, 20);
78         RTC_HISTOGRAM_COUNTS_LINEAR(
79             "WebRTC.Audio.EchoCanceller.ErleBand0.Max",
80             aec3::TransformDbMetricForReporting(true, 0.f, 19.f, 0.f, 1.f,
81                                                 erle_[0].ceil_value),
82             0, 19, 20);
83         RTC_HISTOGRAM_COUNTS_LINEAR(
84             "WebRTC.Audio.EchoCanceller.ErleBand0.Min",
85             aec3::TransformDbMetricForReporting(true, 0.f, 19.f, 0.f, 1.f,
86                                                 erle_[0].floor_value),
87             0, 19, 20);
88         break;
89       case kMetricsCollectionBlocks + 2:
90         RTC_HISTOGRAM_COUNTS_LINEAR(
91             "WebRTC.Audio.EchoCanceller.ErleBand1.Average",
92             aec3::TransformDbMetricForReporting(true, 0.f, 19.f, 0.f,
93                                                 kOneByMetricsCollectionBlocks,
94                                                 erle_[1].sum_value),
95             0, 19, 20);
96         RTC_HISTOGRAM_COUNTS_LINEAR(
97             "WebRTC.Audio.EchoCanceller.ErleBand1.Max",
98             aec3::TransformDbMetricForReporting(true, 0.f, 19.f, 0.f, 1.f,
99                                                 erle_[1].ceil_value),
100             0, 19, 20);
101         RTC_HISTOGRAM_COUNTS_LINEAR(
102             "WebRTC.Audio.EchoCanceller.ErleBand1.Min",
103             aec3::TransformDbMetricForReporting(true, 0.f, 19.f, 0.f, 1.f,
104                                                 erle_[1].floor_value),
105             0, 19, 20);
106         break;
107       case kMetricsCollectionBlocks + 3:
108         RTC_HISTOGRAM_COUNTS_LINEAR(
109             "WebRTC.Audio.EchoCanceller.ErlBand0.Average",
110             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 30.f,
111                                                 kOneByMetricsCollectionBlocks,
112                                                 erl_[0].sum_value),
113             0, 59, 30);
114         RTC_HISTOGRAM_COUNTS_LINEAR(
115             "WebRTC.Audio.EchoCanceller.ErlBand0.Max",
116             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 30.f, 1.f,
117                                                 erl_[0].ceil_value),
118             0, 59, 30);
119         RTC_HISTOGRAM_COUNTS_LINEAR(
120             "WebRTC.Audio.EchoCanceller.ErlBand0.Min",
121             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 30.f, 1.f,
122                                                 erl_[0].floor_value),
123             0, 59, 30);
124         break;
125       case kMetricsCollectionBlocks + 4:
126         RTC_HISTOGRAM_COUNTS_LINEAR(
127             "WebRTC.Audio.EchoCanceller.ErlBand1.Average",
128             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 30.f,
129                                                 kOneByMetricsCollectionBlocks,
130                                                 erl_[1].sum_value),
131             0, 59, 30);
132         RTC_HISTOGRAM_COUNTS_LINEAR(
133             "WebRTC.Audio.EchoCanceller.ErlBand1.Max",
134             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 30.f, 1.f,
135                                                 erl_[1].ceil_value),
136             0, 59, 30);
137         RTC_HISTOGRAM_COUNTS_LINEAR(
138             "WebRTC.Audio.EchoCanceller.ErlBand1.Min",
139             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 30.f, 1.f,
140                                                 erl_[1].floor_value),
141             0, 59, 30);
142         break;
143       case kMetricsCollectionBlocks + 5:
144         RTC_HISTOGRAM_COUNTS_LINEAR(
145             "WebRTC.Audio.EchoCanceller.ComfortNoiseBand0.Average",
146             aec3::TransformDbMetricForReporting(
147                 true, 0.f, 89.f, -90.3f,
148                 kComfortNoiseScaling * kOneByMetricsCollectionBlocks,
149                 comfort_noise_[0].sum_value),
150             0, 89, 45);
151         RTC_HISTOGRAM_COUNTS_LINEAR(
152             "WebRTC.Audio.EchoCanceller.ComfortNoiseBand0.Max",
153             aec3::TransformDbMetricForReporting(true, 0.f, 89.f, -90.3f,
154                                                 kComfortNoiseScaling,
155                                                 comfort_noise_[0].ceil_value),
156             0, 89, 45);
157         RTC_HISTOGRAM_COUNTS_LINEAR(
158             "WebRTC.Audio.EchoCanceller.ComfortNoiseBand0.Min",
159             aec3::TransformDbMetricForReporting(true, 0.f, 89.f, -90.3f,
160                                                 kComfortNoiseScaling,
161                                                 comfort_noise_[0].floor_value),
162             0, 89, 45);
163         break;
164       case kMetricsCollectionBlocks + 6:
165         RTC_HISTOGRAM_COUNTS_LINEAR(
166             "WebRTC.Audio.EchoCanceller.ComfortNoiseBand1.Average",
167             aec3::TransformDbMetricForReporting(
168                 true, 0.f, 89.f, -90.3f,
169                 kComfortNoiseScaling * kOneByMetricsCollectionBlocks,
170                 comfort_noise_[1].sum_value),
171             0, 89, 45);
172         RTC_HISTOGRAM_COUNTS_LINEAR(
173             "WebRTC.Audio.EchoCanceller.ComfortNoiseBand1.Max",
174             aec3::TransformDbMetricForReporting(true, 0.f, 89.f, -90.3f,
175                                                 kComfortNoiseScaling,
176                                                 comfort_noise_[1].ceil_value),
177             0, 89, 45);
178         RTC_HISTOGRAM_COUNTS_LINEAR(
179             "WebRTC.Audio.EchoCanceller.ComfortNoiseBand1.Min",
180             aec3::TransformDbMetricForReporting(true, 0.f, 89.f, -90.3f,
181                                                 kComfortNoiseScaling,
182                                                 comfort_noise_[1].floor_value),
183             0, 89, 45);
184         break;
185       case kMetricsCollectionBlocks + 7:
186         RTC_HISTOGRAM_COUNTS_LINEAR(
187             "WebRTC.Audio.EchoCanceller.SuppressorGainBand0.Average",
188             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 0.f,
189                                                 kOneByMetricsCollectionBlocks,
190                                                 suppressor_gain_[0].sum_value),
191             0, 59, 30);
192         RTC_HISTOGRAM_COUNTS_LINEAR(
193             "WebRTC.Audio.EchoCanceller.SuppressorGainBand0.Max",
194             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 0.f, 1.f,
195                                                 suppressor_gain_[0].ceil_value),
196             0, 59, 30);
197         RTC_HISTOGRAM_COUNTS_LINEAR(
198             "WebRTC.Audio.EchoCanceller.SuppressorGainBand0.Min",
199             aec3::TransformDbMetricForReporting(
200                 true, 0.f, 59.f, 0.f, 1.f, suppressor_gain_[0].floor_value),
201             0, 59, 30);
202         break;
203       case kMetricsCollectionBlocks + 8:
204         RTC_HISTOGRAM_COUNTS_LINEAR(
205             "WebRTC.Audio.EchoCanceller.SuppressorGainBand1.Average",
206             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 0.f,
207                                                 kOneByMetricsCollectionBlocks,
208                                                 suppressor_gain_[1].sum_value),
209             0, 59, 30);
210         RTC_HISTOGRAM_COUNTS_LINEAR(
211             "WebRTC.Audio.EchoCanceller.SuppressorGainBand1.Max",
212             aec3::TransformDbMetricForReporting(true, 0.f, 59.f, 0.f, 1.f,
213                                                 suppressor_gain_[1].ceil_value),
214             0, 59, 30);
215         RTC_HISTOGRAM_COUNTS_LINEAR(
216             "WebRTC.Audio.EchoCanceller.SuppressorGainBand1.Min",
217             aec3::TransformDbMetricForReporting(
218                 true, 0.f, 59.f, 0.f, 1.f, suppressor_gain_[1].floor_value),
219             0, 59, 30);
220         break;
221       case kMetricsCollectionBlocks + 9:
222         RTC_HISTOGRAM_BOOLEAN(
223             "WebRTC.Audio.EchoCanceller.UsableLinearEstimate",
224             static_cast<int>(aec_state.UsableLinearEstimate() ? 1 : 0));
225         RTC_HISTOGRAM_BOOLEAN(
226             "WebRTC.Audio.EchoCanceller.ActiveRender",
227             static_cast<int>(
228                 active_render_count_ > kMetricsCollectionBlocksBy2 ? 1 : 0));
229         RTC_HISTOGRAM_COUNTS_LINEAR(
230             "WebRTC.Audio.EchoCanceller.FilterDelay",
231             aec_state.FilterDelay() ? *aec_state.FilterDelay() + 1 : 0, 0, 30,
232             31);
233         RTC_HISTOGRAM_BOOLEAN("WebRTC.Audio.EchoCanceller.CaptureSaturation",
234                               static_cast<int>(saturated_capture_ ? 1 : 0));
235         metrics_reported_ = true;
236         RTC_DCHECK_EQ(kMetricsReportingIntervalBlocks, block_counter_);
237         block_counter_ = 0;
238         ResetMetrics();
239         break;
240       default:
241         RTC_NOTREACHED();
242         break;
243     }
244   }
245 }
246 
247 namespace aec3 {
248 
UpdateDbMetric(const std::array<float,kFftLengthBy2Plus1> & value,std::array<EchoRemoverMetrics::DbMetric,2> * statistic)249 void UpdateDbMetric(const std::array<float, kFftLengthBy2Plus1>& value,
250                     std::array<EchoRemoverMetrics::DbMetric, 2>* statistic) {
251   RTC_DCHECK(statistic);
252   // Truncation is intended in the band width computation.
253   constexpr int kNumBands = 2;
254   constexpr int kBandWidth = 65 / kNumBands;
255   constexpr float kOneByBandWidth = 1.f / kBandWidth;
256   RTC_DCHECK_EQ(kNumBands, statistic->size());
257   RTC_DCHECK_EQ(65, value.size());
258   for (size_t k = 0; k < statistic->size(); ++k) {
259     float average_band =
260         std::accumulate(value.begin() + kBandWidth * k,
261                         value.begin() + kBandWidth * (k + 1), 0.f) *
262         kOneByBandWidth;
263     (*statistic)[k].Update(average_band);
264   }
265 }
266 
TransformDbMetricForReporting(bool negate,float min_value,float max_value,float offset,float scaling,float value)267 int TransformDbMetricForReporting(bool negate,
268                                   float min_value,
269                                   float max_value,
270                                   float offset,
271                                   float scaling,
272                                   float value) {
273   float new_value = 10.f * log10(value * scaling + 1e-10f) + offset;
274   if (negate) {
275     new_value = -new_value;
276   }
277   return static_cast<int>(rtc::SafeClamp(new_value, min_value, max_value));
278 }
279 
280 }  // namespace aec3
281 
282 }  // namespace webrtc
283