autoeq 0.4.24

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

//! Room EQ - Multi-channel room equalization library
//!
//! This module provides library functions for multi-channel speaker EQ optimization,
//! including support for:
//! - Single speaker EQ optimization
//! - Multi-driver speaker groups with active crossovers
//! - Multiple subwoofer optimization
//! - Double Bass Array (DBA) optimization
//! - Group delay alignment
//! - FIR filter generation
//!
//! # Example
//!
//! ```no_run
//! use autoeq::roomeq::{RoomConfig, optimize_room};
//!
//! let config_json = r#"{
//!   "speakers": {
//!     "left": { "path": "measurements/left.csv" }
//!   },
//!   "optimizer": { "loss_type": "flat", "algorithm": "cobyla" }
//! }"#;
//! let config: RoomConfig = serde_json::from_str(config_json)?;
//! let result = optimize_room(&config, 48000.0, None, None)?;
//!
//! for (channel, chain) in &result.channels {
//!     println!("Channel {}: {} plugins", channel, chain.plugins.len());
//! }
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```

// Core types and configuration (modular)
pub mod types;
pub use types::*;
// Re-export RecordingConfiguration explicitly for clarity
pub use types::RecordingConfiguration;

// Configuration loading (shared between roomeq and roomeq_qa binaries)
mod config_loader;
pub use config_loader::{SHALLOW_MERGE_KEYS, load_config, merge_json_objects};

// Configuration validation
mod config;
pub use config::{ValidationResult, validate_room_config};

// Main optimization entry points
mod optimize;
pub use optimize::{
    CallbackAction, ChannelOptimizationResult, RoomOptimizationCallback, RoomOptimizationProgress,
    RoomOptimizationResult, SpeakerOptimizationCallback, SpeakerOptimizationResult, optimize_room,
    optimize_speaker,
};

// Extracted optimization submodules
mod crossover_utils;
mod group_processing; // Multi-speaker groups, multisub, DBA, cardioid, mixed-mode
mod speaker_eq; // Single-speaker EQ optimization // Crossover and group consistency utilities

// Individual optimization modules
mod crossover;
mod dba;
mod eq;
mod fir;
mod group_delay;
pub mod multisub;
pub mod workflows; // Make public to access from optimize.rs or tests

// Export to external formats (CamillaDSP, APO, EasyEffects, Wavelet, PipeWire)
mod export;
pub use export::{ExportFormat, export_dsp_chain};

// DSP chain building
mod output;
pub use output::{
    add_delay_plugin, build_channel_dsp_chain, build_channel_dsp_chain_with_curves,
    build_dba_dsp_chain, build_dba_dsp_chain_with_curves, build_multidriver_dsp_chain,
    build_multidriver_dsp_chain_with_curves, build_multisub_dsp_chain,
    build_multisub_dsp_chain_with_allpass, build_multisub_dsp_chain_with_curves,
    create_convolution_plugin, create_crossover_plugin, create_delay_plugin,
    create_dsp_chain_output, create_eq_plugin, create_gain_plugin, create_gain_plugin_with_invert,
    create_labeled_eq_plugin, save_dsp_chain,
};

// Progress reporting
mod progress;
pub use progress::{MultiStageProgress, ProgressReporter};

// Spectral channel alignment (shelf filters + gain)
mod spectral_align;
pub use spectral_align::{
    SpectralAlignmentResult, compute_inter_channel_deviation, compute_spectral_alignment,
    create_alignment_plugins, log_spectral_alignment,
};

// Voice of God (timbre matching between channels)
mod voice_of_god;
pub use voice_of_god::{VoGResult, compute_voice_of_god, create_vog_plugins};

// Spatial robustness (multi-position analysis)
pub mod spatial_robustness;
pub use spatial_robustness::{SpatialRobustnessResult, analyze_spatial_robustness};

// Mixed-phase correction (IIR + short FIR)
pub mod mixed_phase;
pub use mixed_phase::{MixedPhaseConfig, MixedPhaseResult, decompose_phase};

// Decomposed correction (modes vs reflections vs steady-state)
pub mod impulse_analysis;
pub use impulse_analysis::{
    DecomposedCorrectionConfig, DecomposedCorrectionResult, analyze_decomposed_correction,
};

// CEA2034 speaker pre-correction (3-pass pipeline)
pub mod cea2034_correction;

// First-reflection cancellation (Johnston IIR filter)
pub mod reflection_cancel;
pub use reflection_cancel::{
    ReflectionCancellationConfig, ReflectionCancellationResult, compute_reflection_cancellation,
};

// Utility modules
mod ir_waveform;
mod phase_utils;
pub mod synthetic;
mod time_align;
mod weighted_loss;

pub use time_align::{
    ArrivalTimeResult, ProbeDelayResult, calculate_alignment_delays, detect_delay_with_probe,
    detect_delays_multi_channel, find_arrival_time,
};

// Perceptual temporal decay thresholds for modal ringing
pub mod temporal_targets;

// Advanced room correction features (Scenario A & B)
pub mod excursion;
pub mod multiseat;
pub mod phase_alignment;
pub mod target_tilt;

pub use excursion::{
    ExcursionProtectionResult, F3DetectionResult, detect_f3, generate_excursion_protection,
};
pub use multiseat::{MultiSeatMeasurements, MultiSeatOptimizationResult, optimize_multiseat};
pub use phase_alignment::{
    PhaseAlignmentResult, optimize_phase_alignment, optimize_phase_alignment_batch,
};
pub use target_tilt::{
    build_harman_target_curve, build_harman_target_curve_with_bass_boost,
    build_target_curve_with_tilt,
};