Skip to main content

secs_engine/
notes.rs

1//! Typed engine diagnostics; presentation owns their translated text.
2
3use crate::input::Peq;
4
5#[derive(Debug, Clone, PartialEq)]
6pub enum Note {
7    LiftCapped {
8        from_ms: f64,
9        taps: usize,
10        lift_ms: f64,
11    },
12    SubFilters(Vec<(String, crate::setup::SubFilter)>),
13    LowProtect {
14        role: String,
15        rolloff_hz: f64,
16        hp_hz: Option<f64>,
17        limited: bool,
18        reduced: usize,
19        cuts: usize,
20    },
21    RcLimit {
22        hz: f64,
23        auto: bool,
24        schroeder_hz: Option<f64>,
25        basis: secs_types::calibration::RcHiBasis,
26        factor: u8,
27        band_hz: Option<f64>,
28        band_t60_s: Option<f64>,
29        positions: Option<usize>,
30    },
31    RcBands {
32        bands: Vec<(f64, f64)>,
33    },
34    /// ADR 0025, one per main when `lf_align` is on and the mode has FIR
35    /// taps. `arrival_ms` is the median LF arrival left after correction
36    /// (positive = later than HF); `limited` means the pull clamp cut the
37    /// requested correction by more than 1 ms somewhere in the band.
38    LfAlign {
39        role: String,
40        strength: f64,
41        arrival_ms: Option<f64>,
42        limited: bool,
43    },
44    /// ADR 0025, one per main when `mode_decay` is on. Each mode is
45    /// `(hz, measured T60 s, cut depth dB)` with the depth positive; an empty
46    /// list means no mode qualified.
47    ModeDecay {
48        role: String,
49        target_t60_s: f64,
50        modes: Vec<(f64, f64, f64)>,
51    },
52    /// ADR 0030, one per channel whose FIR realizes excess phase when
53    /// `hf_phase` is on. `rotation_deg` is the wrapped rotation unwound above
54    /// the band, `None` when less than an octave is left below 0.45·SR;
55    /// `limited` means the `[−5 ms, lift]` clamp kept part of it.
56    HfPhase {
57        role: String,
58        rotation_deg: Option<f64>,
59        limited: bool,
60    },
61    Latency {
62        latency_ms: f64,
63        lift_ms: f64,
64        main_extra_ms: f64,
65    },
66    PhaseStrength(Vec<(String, f64)>),
67    PhaseBand(Vec<(String, Option<f64>)>),
68    // RC (P09)
69    LongModeBoost {
70        cap_db: f64,
71        modes: Vec<(f64, f64)>,
72    },
73    GdCuts {
74        role: String,
75        cuts: Vec<Peq>,
76    },
77    // BA (P10)
78    BaCost(f64),
79    BaBusPass {
80        first: f64,
81        second: f64,
82        kept_first: bool,
83    },
84    BaManual,
85    LayoutFallback(String),
86    Layout(String),
87    TwoWay {
88        roles: Vec<String>,
89        gain_db: f64,
90        xo_hz: f64,
91    },
92    BusGainAnchored(f64),
93    Mimo(MimoNote),
94}
95
96/// Semantic diagnostics in producer order; never translated presentation text.
97#[derive(Debug, Clone, PartialEq)]
98pub enum MimoNote {
99    InsufficientPositions {
100        measured: usize,
101    },
102    ExcludedSupports(Vec<String>),
103    SupportRanges(Vec<(String, Option<(f64, f64)>)>),
104    GuardReduced {
105        role: String,
106        gain_db: f64,
107    },
108    GuardDisabled {
109        role: String,
110    },
111    SupportLimit {
112        max_supports: usize,
113    },
114    FirBudget {
115        support_count: usize,
116        taps_total: usize,
117    },
118}
119
120#[cfg(test)]
121impl MimoNote {
122    // Only the oracle adapter renders the legacy diagnostic strings.
123    pub(crate) fn oracle_text(&self) -> String {
124        match self {
125            Self::InsufficientPositions { measured } => {
126                format!("측정 위치 {measured}곳 — MIMO 는 3곳 이상일 때만")
127            }
128            Self::ExcludedSupports(roles) => format!("서포트 제외(사용자): {}", roles.join(", ")),
129            Self::SupportRanges(ranges) => format!(
130                "서포트 대역 {}",
131                ranges
132                    .iter()
133                    .map(|(role, range)| match range {
134                        Some((lo, hi)) => format!("{role} {lo:.0}–{hi:.0}"),
135                        None => format!("{role} 제외"),
136                    })
137                    .collect::<Vec<_>>()
138                    .join(", ")
139            ),
140            Self::GuardReduced { role, gain_db } => {
141                format!("{role}: 대역 늦은 에너지 악화로 서포트 {gain_db:.0} dB")
142            }
143            Self::GuardDisabled { role } => format!("{role}: MIMO 끔(악화)"),
144            Self::SupportLimit { max_supports } => format!("입력당 서포트 ≤ {max_supports}"),
145            Self::FirBudget {
146                support_count,
147                taps_total,
148            } => {
149                let digits = taps_total.to_string();
150                let grouped = digits
151                    .chars()
152                    .enumerate()
153                    .fold(String::new(), |mut out, (i, ch)| {
154                        if i > 0 && (digits.len() - i).is_multiple_of(3) {
155                            out.push(',');
156                        }
157                        out.push(ch);
158                        out
159                    });
160                format!("FIR 서포트 {support_count}개 · 총 {grouped}탭(48 kHz)")
161            }
162        }
163    }
164}