roomeq-model 0.5.5

RoomEQ configuration, pipeline, and DSP-chain contracts
Documentation
use super::default::default_f3_reference_max_hz;
use super::default::default_f3_reference_min_hz;
use super::default::default_filter_order;
use super::default::default_margin_octaves;
use super::default::default_true;
use super::types::HighpassType;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Excursion protection configuration
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct ExcursionProtectionConfig {
    /// Enable excursion protection
    #[serde(default)]
    pub enabled: bool,
    /// Auto-detect F3 from measurement
    #[serde(default = "default_true")]
    pub auto_detect_f3: bool,
    /// Manual F3 override in Hz (used if auto_detect_f3 is false)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub manual_f3_hz: Option<f64>,
    /// Lower bound of the reference band used for F3 auto-detection.
    #[serde(default = "default_f3_reference_min_hz")]
    pub f3_reference_min_hz: f64,
    /// Upper bound of the reference band used for F3 auto-detection.
    #[serde(default = "default_f3_reference_max_hz")]
    pub f3_reference_max_hz: f64,
    /// Filter order (2 = 12dB/oct, 4 = 24dB/oct)
    #[serde(default = "default_filter_order")]
    pub filter_order: usize,
    /// Highpass filter type
    #[serde(default)]
    pub filter_type: HighpassType,
    /// Safety margin in octaves below F3 for HPF placement
    #[serde(default = "default_margin_octaves")]
    pub margin_octaves: f64,
}

impl Default for ExcursionProtectionConfig {
    fn default() -> Self {
        Self {
            enabled: false,
            auto_detect_f3: true,
            manual_f3_hz: None,
            f3_reference_min_hz: default_f3_reference_min_hz(),
            f3_reference_max_hz: default_f3_reference_max_hz(),
            filter_order: default_filter_order(),
            filter_type: HighpassType::LinkwitzRiley,
            margin_octaves: default_margin_octaves(),
        }
    }
}