Finalization of the first version of EchoCanceller 3

webrtc/modules/audio_processing/aec3/aec_state.h

+/*
+ *  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.
+ */
+
+#ifndef WEBRTC_MODULES_AUDIO_PROCESSING_AEC3_AEC_STATE_H_
+#define WEBRTC_MODULES_AUDIO_PROCESSING_AEC3_AEC_STATE_H_
+
+#include <algorithm>
+#include <vector>
+
+#include "webrtc/base/array_view.h"
+#include "webrtc/base/constructormagic.h"
+#include "webrtc/base/optional.h"

[ivoc, 2017/02/10 13:52:33]

I don't think Optional is used in this header.

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

You are right. But I have now changed it, so it is again used.

Done.

[ivoc, 2017/02/21 17:26:00]

Acknowledged.

[peah-webrtc, 2017/02/21 23:00:39]

Acknowledged.

+#include "webrtc/modules/audio_processing/aec3/aec3_constants.h"
+#include "webrtc/modules/audio_processing/aec3/echo_path_variability.h"
+#include "webrtc/modules/audio_processing/aec3/delay_handler.h"
+#include "webrtc/modules/audio_processing/aec3/erle_estimator.h"
+#include "webrtc/modules/audio_processing/aec3/erl_estimator.h"
+#include "webrtc/modules/audio_processing/aec3/fft_buffer.h"
+#include "webrtc/modules/audio_processing/logging/apm_data_dumper.h"

[ivoc, 2017/02/10 13:52:33]

Is this needed?

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

Done.

+
+namespace webrtc {
+
+// Handles the state and the conditions for the echo removal functionality.
+class AecState {
+ public:
+  AecState();
+  ~AecState();
+
+  // Returns whether the linear filter estimate is usable.
+  bool UsableLinearEstimate() const { return usable_linear_estimate_; }
+
+  // Returns whether there has been echo leakage detected.
+  bool EchoLeakageDetected() const { return echo_leakage_detected_; }
+
+  // Returns whether it is possible at all to use the model based echo removal
+  // functionalities.
+  bool ModelBasedAecFeasible() const { return model_based_aec_feasible_; }
+
+  // Returns whether the render signal is currently active.
+  bool ActiveRender() const { return active_render_counter_ > 0; }
+
+  // Returns the ERLE.
+  const std::array<float, kFftLengthBy2Plus1>& Erle() const {
+    return erle_estimator_.Erle();
+  }
+
+  // Returns the ERL.
+  const std::array<float, kFftLengthBy2Plus1>& Erl() const {
+    return erl_estimator_.Erl();
+  }
+
+  // Returns the bands where the linear filter is reliable.
+  const std::array<bool, kFftLengthBy2Plus1>& BandsWithReliableFilter() const {
+    return bands_with_reliable_filter_;
+  }
+
+  // Updates the aec state.
+  void Update(const FftBuffer& X_buffer,
+              const std::array<float, kFftLengthBy2Plus1>& E2_main,
+              const std::array<float, kFftLengthBy2Plus1>& E2_shadow,
+              const std::array<float, kFftLengthBy2Plus1>& Y2,
+              rtc::ArrayView<const float> x,
+              const DelayHandler& delay_handler,
+              const EchoPathVariability& echo_path_variability,
+              bool echo_leakage_detected);
+
+ private:
+  ErlEstimator erl_estimator_;
+  ErleEstimator erle_estimator_;
+  std::array<bool, kFftLengthBy2Plus1> bands_with_reliable_filter_;
+  int echo_path_change_counter_;
+  int active_render_counter_;
+  bool usable_linear_estimate_ = false;
+  bool echo_leakage_detected_ = false;
+  bool model_based_aec_feasible_ = false;
+
+  RTC_DISALLOW_COPY_AND_ASSIGN(AecState);
+};
+
+}  // namespace webrtc
+
+#endif  // WEBRTC_MODULES_AUDIO_PROCESSING_AEC3_AEC_STATE_H_