blob: fd5bf0963ea9354520403305335bc66773183d66 [file] [log] [blame]
Gustaf Ullbergbffa3002018-02-14 15:12:00 +01001/*
2 * Copyright (c) 2018 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 API_AUDIO_ECHO_CANCELLER3_CONFIG_H_
12#define API_AUDIO_ECHO_CANCELLER3_CONFIG_H_
13
Gustaf Ullberg3646f972018-02-14 15:19:04 +010014#include <stddef.h> // size_t
15
Gustaf Ullbergbffa3002018-02-14 15:12:00 +010016namespace webrtc {
17
18// Configuration struct for EchoCanceller3
19struct EchoCanceller3Config {
Per Åhgrenb6b00dc2018-02-20 22:18:27 +010020 EchoCanceller3Config();
21
Gustaf Ullbergbffa3002018-02-14 15:12:00 +010022 struct Delay {
23 size_t default_delay = 5;
24 size_t down_sampling_factor = 4;
Per Åhgren75b57d32018-02-15 09:17:41 +010025 size_t num_filters = 5;
Gustaf Ullbergbffa3002018-02-14 15:12:00 +010026 size_t api_call_jitter_blocks = 26;
27 size_t min_echo_path_delay_blocks = 0;
28 size_t delay_headroom_blocks = 2;
29 size_t hysteresis_limit_1_blocks = 1;
30 size_t hysteresis_limit_2_blocks = 1;
Per Åhgren8447e912018-02-28 13:28:34 +010031 size_t skew_hysteresis_blocks = 1;
Gustaf Ullbergbffa3002018-02-14 15:12:00 +010032 } delay;
33
34 struct Filter {
35 struct MainConfiguration {
36 size_t length_blocks;
37 float leakage_converged;
38 float leakage_diverged;
39 float error_floor;
40 float noise_gate;
41 };
42
43 struct ShadowConfiguration {
44 size_t length_blocks;
45 float rate;
46 float noise_gate;
47 };
48
49 MainConfiguration main = {13, 0.005f, 0.1f, 0.001f, 20075344.f};
50 ShadowConfiguration shadow = {13, 0.7f, 20075344.f};
51
52 MainConfiguration main_initial = {12, 0.05f, 5.f, 0.001f, 20075344.f};
53 ShadowConfiguration shadow_initial = {12, 0.9f, 20075344.f};
Per Åhgren5f1a31c2018-03-08 15:54:41 +010054
55 size_t config_change_duration_blocks = 250;
Gustaf Ullbergbffa3002018-02-14 15:12:00 +010056 } filter;
57
58 struct Erle {
59 float min = 1.f;
60 float max_l = 8.f;
61 float max_h = 1.5f;
62 } erle;
63
64 struct EpStrength {
65 float lf = 10.f;
66 float mf = 10.f;
67 float hf = 10.f;
68 float default_len = 0.f;
69 bool echo_can_saturate = true;
70 bool bounded_erl = false;
71 } ep_strength;
72
73 struct Mask {
74 float m1 = 0.01f;
75 float m2 = 0.0001f;
76 float m3 = 0.01f;
77 float m4 = 0.1f;
78 float m5 = 0.1f;
79 float m6 = 0.0001f;
80 float m7 = 0.01f;
81 float m8 = 0.0001f;
82 float m9 = 0.1f;
83 } gain_mask;
84
85 struct EchoAudibility {
86 float low_render_limit = 4 * 64.f;
87 float normal_render_limit = 64.f;
88 } echo_audibility;
89
90 struct RenderLevels {
91 float active_render_limit = 100.f;
92 float poor_excitation_render_limit = 150.f;
93 } render_levels;
94
95 struct GainUpdates {
96 struct GainChanges {
97 float max_inc;
98 float max_dec;
99 float rate_inc;
100 float rate_dec;
101 float min_inc;
102 float min_dec;
103 };
104
105 GainChanges low_noise = {2.f, 2.f, 1.4f, 1.4f, 1.1f, 1.1f};
106 GainChanges initial = {2.f, 2.f, 1.5f, 1.5f, 1.2f, 1.2f};
107 GainChanges normal = {2.f, 2.f, 1.5f, 1.5f, 1.2f, 1.2f};
108 GainChanges saturation = {1.2f, 1.2f, 1.5f, 1.5f, 1.f, 1.f};
109 GainChanges nonlinear = {1.5f, 1.5f, 1.2f, 1.2f, 1.1f, 1.1f};
110
111 float floor_first_increase = 0.00001f;
112 } gain_updates;
Per Åhgrenb6b00dc2018-02-20 22:18:27 +0100113
114 struct EchoRemovalControl {
115 struct GainRampup {
116 float first_non_zero_gain = 0.001f;
117 int non_zero_gain_blocks = 187;
118 int full_gain_blocks = 312;
119 } gain_rampup;
Per Åhgren461cdf02018-02-27 01:59:37 +0100120
121 bool has_clock_drift = false;
Per Åhgrenb6b00dc2018-02-20 22:18:27 +0100122 } echo_removal_control;
Gustaf Ullbergbffa3002018-02-14 15:12:00 +0100123};
124} // namespace webrtc
125
126#endif // API_AUDIO_ECHO_CANCELLER3_CONFIG_H_