roomeq-model 0.5.5

RoomEQ configuration, pipeline, and DSP-chain contracts
Documentation
use super::bass_headroom_model_config::BassHeadroomModelConfig;
use super::default::default_bass_management_enabled;
use super::default::default_lfe_channel;
use super::default::default_lfe_low_pass_hz;
use super::default::default_lfe_playback_gain_db;
use super::default::default_max_sub_boost_db;
use super::default::default_optimize_bass_groups;
use super::default::default_redirect_bass;
use super::default::default_sub_headroom_margin_db;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Home-cinema bass-management policy.
///
/// This describes how RoomEQ should reason about the main high-pass, sub
/// low-pass, redirected bass, and the LFE programme path. The current DSP
/// exporter still emits per-output-channel correction chains, so LFE +10 dB
/// is reported but not inserted by default: applying it to the physical sub
/// chain would also boost redirected bass.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct BassManagementConfig {
    /// Enable bass-management semantics for home-cinema workflows.
    #[serde(default = "default_bass_management_enabled")]
    pub enabled: bool,
    /// Whether small-speaker bass is redirected to the subwoofer output.
    #[serde(default = "default_redirect_bass")]
    pub redirect_bass: bool,
    /// Logical LFE programme channel name.
    #[serde(default = "default_lfe_channel")]
    pub lfe_channel: String,
    /// Cinema LFE playback calibration gain. Reported in metadata; not applied
    /// to the sub correction chain unless `apply_lfe_gain_to_chain` is set.
    #[serde(default = "default_lfe_playback_gain_db")]
    pub lfe_playback_gain_db: f64,
    /// LFE programme-channel low-pass cutoff. This is independent of the
    /// speaker crossover used to redirect bass from the main channels.
    #[serde(default = "default_lfe_low_pass_hz")]
    pub lfe_low_pass_hz: f64,
    /// Explicitly insert LFE gain in the exported physical sub chain. This is
    /// normally false because redirected bass and LFE share the same sub output.
    #[serde(default)]
    pub apply_lfe_gain_to_chain: bool,
    /// User sub trim applied after crossover/alignment optimization.
    #[serde(default)]
    pub sub_trim_db: f64,
    /// Maximum allowed positive sub boost from RoomEQ bass management.
    #[serde(default = "default_max_sub_boost_db")]
    pub max_sub_boost_db: f64,
    /// Headroom reserve expected downstream for bass-managed playback.
    #[serde(default = "default_sub_headroom_margin_db")]
    pub headroom_margin_db: f64,
    /// Optional role-group to crossover-key mapping. Supported built-in group
    /// ids are `lcr`, `surround`, `height`, and `wide`; unknown ids are kept as
    /// custom metadata groups.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub group_crossovers: HashMap<String, String>,
    /// Optimize crossover settings independently per speaker group.
    #[serde(default = "default_optimize_bass_groups")]
    pub optimize_groups: bool,
    /// Programme-correlation model used for bass-bus headroom simulation.
    #[serde(default)]
    pub headroom_model: BassHeadroomModelConfig,
}

impl Default for BassManagementConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            redirect_bass: true,
            lfe_channel: default_lfe_channel(),
            lfe_playback_gain_db: default_lfe_playback_gain_db(),
            lfe_low_pass_hz: default_lfe_low_pass_hz(),
            apply_lfe_gain_to_chain: false,
            sub_trim_db: 0.0,
            max_sub_boost_db: default_max_sub_boost_db(),
            headroom_margin_db: default_sub_headroom_margin_db(),
            group_crossovers: HashMap::new(),
            optimize_groups: true,
            headroom_model: BassHeadroomModelConfig::default(),
        }
    }
}