1 /*
2  *  Copyright (c) 2019 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 #ifndef MODULES_AUDIO_PROCESSING_AEC3_NEAREND_DETECTOR_H_
12 #define MODULES_AUDIO_PROCESSING_AEC3_NEAREND_DETECTOR_H_
13 
14 #include <vector>
15 
16 #include "api/array_view.h"
17 #include "api/audio/echo_canceller3_config.h"
18 #include "modules/audio_processing/aec3/aec3_common.h"
19 
20 namespace webrtc {
21 // Class for selecting whether the suppressor is in the nearend or echo state.
22 class NearendDetector {
23  public:
~NearendDetector()24   virtual ~NearendDetector() {}
25 
26   // Returns whether the current state is the nearend state.
27   virtual bool IsNearendState() const = 0;
28 
29   // Updates the state selection based on latest spectral estimates.
30   virtual void Update(
31       rtc::ArrayView<const std::array<float, kFftLengthBy2Plus1>>
32           nearend_spectrum,
33       rtc::ArrayView<const std::array<float, kFftLengthBy2Plus1>>
34           residual_echo_spectrum,
35       rtc::ArrayView<const std::array<float, kFftLengthBy2Plus1>>
36           comfort_noise_spectrum,
37       bool initial_state) = 0;
38 };
39 
40 }  // namespace webrtc
41 
42 #endif  // MODULES_AUDIO_PROCESSING_AEC3_NEAREND_DETECTOR_H_
43