autoeq 0.4.44

Automatic equalization for speakers, headphones and rooms!
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
//! Tests for new Phase 2 validator warnings:
//!
//! - **I2** schroeder_split + non-zero target slope → warning
//! - **I5** `ProcessingMode::PhaseLinear` + `max_freq > 2000 Hz` → warning
//! - **B10** `multi_measurement.weights.len()` mismatch vs speaker measurements → error
//! - **I4** `cea2034_correction.enabled` without a CEA2034/spinorama source → warning

use autoeq::roomeq::{
    Cea2034CorrectionConfig, MultiMeasurementConfig, MultiMeasurementStrategy, OptimizerConfig,
    ProcessingMode, RoomConfig, SchroederSplitConfig, SpeakerConfig, SpeakerGroup,
    TargetResponseConfig, TargetShape, default_config_version, validate_room_config,
};
use autoeq::{MeasurementMultiple, MeasurementRef, MeasurementSingle, MeasurementSource};
use std::collections::HashMap;
use std::path::PathBuf;

fn single_speaker(path: &str, speaker_name: Option<&str>) -> SpeakerConfig {
    SpeakerConfig::Single(MeasurementSource::Single(MeasurementSingle {
        measurement: MeasurementRef::Path(PathBuf::from(path)),
        speaker_name: speaker_name.map(str::to_string),
    }))
}

fn multi_speaker(paths: &[&str]) -> SpeakerConfig {
    SpeakerConfig::Single(MeasurementSource::Multiple(MeasurementMultiple {
        measurements: paths
            .iter()
            .map(|p| MeasurementRef::Path(PathBuf::from(p)))
            .collect(),
        speaker_name: None,
    }))
}

fn base_config(speakers: HashMap<String, SpeakerConfig>, optimizer: OptimizerConfig) -> RoomConfig {
    RoomConfig {
        version: default_config_version(),
        system: None,
        speakers,
        crossovers: None,
        target_curve: None,
        optimizer,
        recording_config: None,
        ctc: None,
        cea2034_cache: None,
    }
}

fn one_speaker(name: &str, speaker: SpeakerConfig) -> HashMap<String, SpeakerConfig> {
    let mut m = HashMap::new();
    m.insert(name.to_string(), speaker);
    m
}

// ============================================================================
// I2 — schroeder_split + non-zero target slope emits a warning
// ============================================================================

#[test]
fn i2_schroeder_split_with_target_response_slope_warns() {
    let opt = OptimizerConfig {
        schroeder_split: Some(SchroederSplitConfig {
            enabled: true,
            ..SchroederSplitConfig::default()
        }),
        target_response: Some(TargetResponseConfig {
            shape: TargetShape::Custom,
            slope_db_per_octave: -0.8,
            ..TargetResponseConfig::default()
        }),
        ..Default::default()
    };

    let config = base_config(one_speaker("L", single_speaker("l.csv", None)), opt);
    let result = validate_room_config(&config);

    assert!(
        result
            .warnings
            .iter()
            .any(|w| w.contains("schroeder_split")),
        "expected schroeder_split warning, got: {:?}",
        result.warnings
    );
}

#[test]
fn i2_schroeder_split_with_flat_slope_no_warning() {
    // If both legs are flat, there's no slope to approximate, so no warning.
    let opt = OptimizerConfig {
        schroeder_split: Some(SchroederSplitConfig {
            enabled: true,
            ..SchroederSplitConfig::default()
        }),
        // Default target_response is absent.
        ..Default::default()
    };

    let config = base_config(one_speaker("L", single_speaker("l.csv", None)), opt);
    let result = validate_room_config(&config);

    assert!(
        !result
            .warnings
            .iter()
            .any(|w| w.contains("schroeder_split")),
        "unexpected schroeder_split warning on flat config: {:?}",
        result.warnings
    );
}

// ============================================================================
// I5 — PhaseLinear + max_freq > 2000 Hz emits a warning
// ============================================================================

#[test]
fn i5_phase_linear_wide_band_warns() {
    let opt = OptimizerConfig {
        processing_mode: ProcessingMode::PhaseLinear,
        max_freq: 20000.0,
        ..Default::default()
    };

    let config = base_config(one_speaker("L", single_speaker("l.csv", None)), opt);
    let result = validate_room_config(&config);

    assert!(
        result
            .warnings
            .iter()
            .any(|w| w.contains("phase_linear") && w.contains("max_freq")),
        "expected phase_linear + max_freq warning, got: {:?}",
        result.warnings
    );
}

#[test]
fn i5_phase_linear_bass_only_no_warning() {
    let opt = OptimizerConfig {
        processing_mode: ProcessingMode::PhaseLinear,
        max_freq: 1500.0,
        ..Default::default()
    };

    let config = base_config(one_speaker("L", single_speaker("l.csv", None)), opt);
    let result = validate_room_config(&config);

    assert!(
        !result
            .warnings
            .iter()
            .any(|w| w.contains("phase_linear") && w.contains("max_freq")),
        "unexpected warning for bass-only PhaseLinear: {:?}",
        result.warnings
    );
}

#[test]
fn i5_low_latency_mode_no_warning_even_at_20khz() {
    let opt = OptimizerConfig {
        processing_mode: ProcessingMode::LowLatency,
        max_freq: 20000.0,
        ..Default::default()
    };

    let config = base_config(one_speaker("L", single_speaker("l.csv", None)), opt);
    let result = validate_room_config(&config);

    assert!(
        !result
            .warnings
            .iter()
            .any(|w| w.contains("phase_linear") && w.contains("max_freq")),
        "unexpected PhaseLinear warning on LowLatency: {:?}",
        result.warnings
    );
}

// ============================================================================
// B10 — multi_measurement.weights length must match measurement count
// ============================================================================

#[test]
fn b10_weights_length_mismatch_is_error() {
    let opt = OptimizerConfig {
        multi_measurement: Some(MultiMeasurementConfig {
            strategy: MultiMeasurementStrategy::WeightedSum,
            weights: Some(vec![0.5, 0.5]), // 2 weights
            ..MultiMeasurementConfig::default()
        }),
        ..Default::default()
    };

    let speakers = one_speaker(
        "L",
        multi_speaker(&["m1.csv", "m2.csv", "m3.csv"]), // 3 measurements
    );
    let config = base_config(speakers, opt);
    let result = validate_room_config(&config);

    assert!(
        !result.is_valid,
        "config should be invalid: errors={:?}, warnings={:?}",
        result.errors, result.warnings
    );
    assert!(
        result
            .errors
            .iter()
            .any(|e| e.contains("multi_measurement.weights")),
        "expected weights-mismatch error, got: {:?}",
        result.errors
    );
}

#[test]
fn b10_weights_length_match_no_error() {
    let opt = OptimizerConfig {
        multi_measurement: Some(MultiMeasurementConfig {
            strategy: MultiMeasurementStrategy::WeightedSum,
            weights: Some(vec![0.4, 0.3, 0.3]),
            ..MultiMeasurementConfig::default()
        }),
        ..Default::default()
    };

    let speakers = one_speaker("L", multi_speaker(&["m1.csv", "m2.csv", "m3.csv"]));
    let config = base_config(speakers, opt);
    let result = validate_room_config(&config);

    assert!(
        !result
            .errors
            .iter()
            .any(|e| e.contains("multi_measurement.weights")),
        "unexpected mismatch error on matching lengths: {:?}",
        result.errors
    );
}

#[test]
fn b10_single_measurement_source_ignored() {
    // A Single source doesn't have a count to compare against; no error even
    // if weights is populated (it's harmless until the channel actually has
    // multiple measurements).
    let opt = OptimizerConfig {
        multi_measurement: Some(MultiMeasurementConfig {
            strategy: MultiMeasurementStrategy::WeightedSum,
            weights: Some(vec![0.5, 0.5]),
            ..MultiMeasurementConfig::default()
        }),
        ..Default::default()
    };

    let config = base_config(one_speaker("L", single_speaker("l.csv", None)), opt);
    let result = validate_room_config(&config);

    assert!(
        !result
            .errors
            .iter()
            .any(|e| e.contains("multi_measurement.weights")),
        "single source should not trigger weights mismatch: {:?}",
        result.errors
    );
}

// ============================================================================
// I4 — cea2034_correction requires a CEA2034/spinorama-shaped source
// ============================================================================

#[test]
fn i4_cea2034_without_spinorama_source_warns() {
    let opt = OptimizerConfig {
        cea2034_correction: Some(Cea2034CorrectionConfig {
            enabled: true,
            ..Cea2034CorrectionConfig::default()
        }),
        ..Default::default()
    };

    let config = base_config(
        one_speaker("L", single_speaker("plain_room_measurement.csv", None)),
        opt,
    );
    let result = validate_room_config(&config);

    assert!(
        result
            .warnings
            .iter()
            .any(|w| w.contains("cea2034_correction")),
        "expected cea2034 source warning, got: {:?}",
        result.warnings
    );
}

#[test]
fn i4_cea2034_with_speaker_name_no_warning() {
    let opt = OptimizerConfig {
        cea2034_correction: Some(Cea2034CorrectionConfig {
            enabled: true,
            ..Cea2034CorrectionConfig::default()
        }),
        ..Default::default()
    };

    let config = base_config(
        one_speaker("L", single_speaker("l.csv", Some("KEF R3"))),
        opt,
    );
    let result = validate_room_config(&config);

    assert!(
        !result
            .warnings
            .iter()
            .any(|w| w.contains("cea2034_correction")),
        "unexpected cea2034 warning when speaker_name is set: {:?}",
        result.warnings
    );
}

#[test]
fn i4_cea2034_with_path_hint_no_warning() {
    let opt = OptimizerConfig {
        cea2034_correction: Some(Cea2034CorrectionConfig {
            enabled: true,
            ..Cea2034CorrectionConfig::default()
        }),
        ..Default::default()
    };

    let config = base_config(
        one_speaker("L", single_speaker("speakers/KEF_R3_cea2034_asr.csv", None)),
        opt,
    );
    let result = validate_room_config(&config);

    assert!(
        !result
            .warnings
            .iter()
            .any(|w| w.contains("cea2034_correction")),
        "unexpected cea2034 warning when path contains 'cea2034': {:?}",
        result.warnings
    );
}

#[test]
fn i4_cea2034_disabled_no_warning() {
    let opt = OptimizerConfig {
        cea2034_correction: Some(Cea2034CorrectionConfig {
            enabled: false,
            ..Cea2034CorrectionConfig::default()
        }),
        ..Default::default()
    };

    let config = base_config(one_speaker("L", single_speaker("plain.csv", None)), opt);
    let result = validate_room_config(&config);

    assert!(
        !result
            .warnings
            .iter()
            .any(|w| w.contains("cea2034_correction")),
        "disabled cea2034 should not warn: {:?}",
        result.warnings
    );
}

// ============================================================================
// SpeakerGroup variant: B10 + I4 should still kick in on groups
// ============================================================================

#[test]
fn b10_weights_mismatch_inside_speaker_group() {
    let opt = OptimizerConfig {
        multi_measurement: Some(MultiMeasurementConfig {
            strategy: MultiMeasurementStrategy::WeightedSum,
            weights: Some(vec![0.5, 0.5]),
            ..MultiMeasurementConfig::default()
        }),
        ..Default::default()
    };

    let group = SpeakerConfig::Group(SpeakerGroup {
        name: "mains".to_string(),
        speaker_name: None,
        measurements: vec![MeasurementSource::Multiple(MeasurementMultiple {
            measurements: vec![
                MeasurementRef::Path(PathBuf::from("a.csv")),
                MeasurementRef::Path(PathBuf::from("b.csv")),
                MeasurementRef::Path(PathBuf::from("c.csv")),
            ],
            speaker_name: None,
        })],
        crossover: None,
    });
    let speakers = one_speaker("mains", group);
    let config = base_config(speakers, opt);
    let result = validate_room_config(&config);

    assert!(
        result
            .errors
            .iter()
            .any(|e| e.contains("multi_measurement.weights")),
        "expected weights error on group-wrapped Multiple, got: {:?}",
        result.errors
    );
}