1 /* 2 * Copyright (c) 2016 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_BLOCK_PROCESSOR_H_ 12 #define MODULES_AUDIO_PROCESSING_AEC3_BLOCK_PROCESSOR_H_ 13 14 #include <stddef.h> 15 16 #include <memory> 17 #include <vector> 18 19 #include "api/audio/echo_canceller3_config.h" 20 #include "api/audio/echo_control.h" 21 #include "modules/audio_processing/aec3/block.h" 22 #include "modules/audio_processing/aec3/echo_remover.h" 23 #include "modules/audio_processing/aec3/render_delay_buffer.h" 24 #include "modules/audio_processing/aec3/render_delay_controller.h" 25 26 namespace webrtc { 27 28 // Class for performing echo cancellation on 64 sample blocks of audio data. 29 class BlockProcessor { 30 public: 31 static BlockProcessor* Create(const EchoCanceller3Config& config, 32 int sample_rate_hz, 33 size_t num_render_channels, 34 size_t num_capture_channels); 35 // Only used for testing purposes. 36 static BlockProcessor* Create( 37 const EchoCanceller3Config& config, 38 int sample_rate_hz, 39 size_t num_render_channels, 40 size_t num_capture_channels, 41 std::unique_ptr<RenderDelayBuffer> render_buffer); 42 static BlockProcessor* Create( 43 const EchoCanceller3Config& config, 44 int sample_rate_hz, 45 size_t num_render_channels, 46 size_t num_capture_channels, 47 std::unique_ptr<RenderDelayBuffer> render_buffer, 48 std::unique_ptr<RenderDelayController> delay_controller, 49 std::unique_ptr<EchoRemover> echo_remover); 50 51 virtual ~BlockProcessor() = default; 52 53 // Get current metrics. 54 virtual void GetMetrics(EchoControl::Metrics* metrics) const = 0; 55 56 // Provides an optional external estimate of the audio buffer delay. 57 virtual void SetAudioBufferDelay(int delay_ms) = 0; 58 59 // Processes a block of capture data. 60 virtual void ProcessCapture(bool echo_path_gain_change, 61 bool capture_signal_saturation, 62 Block* linear_output, 63 Block* capture_block) = 0; 64 65 // Buffers a block of render data supplied by a FrameBlocker object. 66 virtual void BufferRender(const Block& render_block) = 0; 67 68 // Reports whether echo leakage has been detected in the echo canceller 69 // output. 70 virtual void UpdateEchoLeakageStatus(bool leakage_detected) = 0; 71 72 // Specifies whether the capture output will be used. The purpose of this is 73 // to allow the block processor to deactivate some of the processing when the 74 // resulting output is anyway not used, for instance when the endpoint is 75 // muted. 76 virtual void SetCaptureOutputUsage(bool capture_output_used) = 0; 77 }; 78 79 } // namespace webrtc 80 81 #endif // MODULES_AUDIO_PROCESSING_AEC3_BLOCK_PROCESSOR_H_ 82