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 #ifndef MODULES_AUDIO_PROCESSING_AEC3_ECHO_REMOVER_H_ 12 #define MODULES_AUDIO_PROCESSING_AEC3_ECHO_REMOVER_H_ 13 14 #include <vector> 15 16 #include "absl/types/optional.h" 17 #include "api/audio/echo_canceller3_config.h" 18 #include "api/audio/echo_control.h" 19 #include "modules/audio_processing/aec3/block.h" 20 #include "modules/audio_processing/aec3/delay_estimate.h" 21 #include "modules/audio_processing/aec3/echo_path_variability.h" 22 #include "modules/audio_processing/aec3/render_buffer.h" 23 24 namespace webrtc { 25 26 // Class for removing the echo from the capture signal. 27 class EchoRemover { 28 public: 29 static EchoRemover* Create(const EchoCanceller3Config& config, 30 int sample_rate_hz, 31 size_t num_render_channels, 32 size_t num_capture_channels); 33 virtual ~EchoRemover() = default; 34 35 // Get current metrics. 36 virtual void GetMetrics(EchoControl::Metrics* metrics) const = 0; 37 38 // Removes the echo from a block of samples from the capture signal. The 39 // supplied render signal is assumed to be pre-aligned with the capture 40 // signal. 41 virtual void ProcessCapture( 42 EchoPathVariability echo_path_variability, 43 bool capture_signal_saturation, 44 const absl::optional<DelayEstimate>& external_delay, 45 RenderBuffer* render_buffer, 46 Block* linear_output, 47 Block* capture) = 0; 48 49 // Updates the status on whether echo leakage is detected in the output of the 50 // echo remover. 51 virtual void UpdateEchoLeakageStatus(bool leakage_detected) = 0; 52 53 // Specifies whether the capture output will be used. The purpose of this is 54 // to allow the echo remover to deactivate some of the processing when the 55 // resulting output is anyway not used, for instance when the endpoint is 56 // muted. 57 virtual void SetCaptureOutputUsage(bool capture_output_used) = 0; 58 }; 59 60 } // namespace webrtc 61 62 #endif // MODULES_AUDIO_PROCESSING_AEC3_ECHO_REMOVER_H_ 63