roomeq-model 0.5.5

RoomEQ configuration, pipeline, and DSP-chain contracts
Documentation
use super::audibility_deadband_config::AudibilityDeadbandConfig;
use super::bootstrap_uncertainty_config::BootstrapUncertaintyConfig;
use super::decomposed_correction_serde_config::DecomposedCorrectionSerdeConfig;
use super::default::default_decomposed_schroeder;
use super::early_late_correction_config::EarlyLateCorrectionConfig;
use super::high_frequency_correction_config::HighFrequencyCorrectionConfig;
use super::multi_measurement_config::MultiMeasurementConfig;
use super::role_target_config::RoleTargetConfig;
use super::target_response_config::TargetResponseConfig;
use super::types::BootstrapScalarisation;
use super::types::MultiMeasurementStrategy;
use super::types::PerceptualPolicyPreset;
use super::types::SmoothnessPenaltyConfigSerde;
use super::types::SpatialRobustnessSerdeConfig;
use super::types::TargetShape;
use super::user_preference::UserPreference;
use crate::{AsymmetricLossConfig, PsychoacousticSmoothingConfig};

pub(super) fn policy_target_response(preset: PerceptualPolicyPreset) -> TargetResponseConfig {
    match preset {
        PerceptualPolicyPreset::Reference => TargetResponseConfig {
            shape: TargetShape::Flat,
            broadband_precorrection: true,
            role_targets: Some(RoleTargetConfig::default()),
            ..Default::default()
        },
        PerceptualPolicyPreset::Music => TargetResponseConfig {
            shape: TargetShape::Harman,
            slope_db_per_octave: -0.8,
            broadband_precorrection: true,
            preference: UserPreference {
                bass_shelf_db: 1.0,
                treble_shelf_db: -0.5,
                ..Default::default()
            },
            role_targets: Some(RoleTargetConfig::default()),
            ..Default::default()
        },
        PerceptualPolicyPreset::Cinema => TargetResponseConfig {
            shape: TargetShape::Custom,
            slope_db_per_octave: -0.8,
            broadband_precorrection: true,
            preference: UserPreference {
                bass_shelf_db: 0.5,
                treble_shelf_db: -0.5,
                ..Default::default()
            },
            role_targets: Some(RoleTargetConfig {
                center_dialog_boost_db: 1.5,
                cinema_x_curve_enabled: true,
                cinema_x_curve_db_per_octave: -1.0,
                distance_treble_rolloff_db_per_doubling: -0.7,
                surround_treble_shelf_db: -0.75,
                height_treble_shelf_db: -1.0,
                ..Default::default()
            }),
            ..Default::default()
        },
        PerceptualPolicyPreset::Night => TargetResponseConfig {
            shape: TargetShape::Custom,
            slope_db_per_octave: -0.5,
            broadband_precorrection: true,
            preference: UserPreference {
                bass_shelf_db: -1.5,
                treble_shelf_db: -0.75,
                ..Default::default()
            },
            role_targets: Some(RoleTargetConfig {
                center_dialog_boost_db: 2.0,
                subwoofer_bass_shelf_db: -2.0,
                lfe_bass_shelf_db: -2.0,
                ..Default::default()
            }),
            ..Default::default()
        },
        PerceptualPolicyPreset::Speech => TargetResponseConfig {
            shape: TargetShape::Custom,
            slope_db_per_octave: -0.3,
            broadband_precorrection: true,
            preference: UserPreference {
                bass_shelf_db: -2.0,
                treble_shelf_db: 0.5,
                ..Default::default()
            },
            role_targets: Some(RoleTargetConfig {
                center_dialog_boost_db: 3.0,
                center_dialog_low_hz: 250.0,
                center_dialog_high_hz: 5_000.0,
                ..Default::default()
            }),
            ..Default::default()
        },
    }
}

pub(super) fn policy_multi_measurement(preset: PerceptualPolicyPreset) -> MultiMeasurementConfig {
    MultiMeasurementConfig {
        strategy: match preset {
            PerceptualPolicyPreset::Reference | PerceptualPolicyPreset::Cinema => {
                MultiMeasurementStrategy::MinimaxUncertainty
            }
            _ => MultiMeasurementStrategy::SpatialRobustness,
        },
        spatial_robustness: Some(SpatialRobustnessSerdeConfig {
            variance_threshold_db: match preset {
                PerceptualPolicyPreset::Speech => 4.0,
                PerceptualPolicyPreset::Night => 2.5,
                _ => 3.0,
            },
            transition_width_db: 2.0,
            min_correction_depth: match preset {
                PerceptualPolicyPreset::Reference | PerceptualPolicyPreset::Cinema => 0.0,
                PerceptualPolicyPreset::Speech => 0.25,
                _ => 0.1,
            },
            mask_smoothing_octaves: 1.0 / 6.0,
        }),
        bootstrap_uncertainty: Some(BootstrapUncertaintyConfig {
            scalarisation: match preset {
                PerceptualPolicyPreset::Music | PerceptualPolicyPreset::Speech => {
                    BootstrapScalarisation::Cvar
                }
                _ => BootstrapScalarisation::WorstCase,
            },
            ..Default::default()
        }),
        ..Default::default()
    }
}

pub(super) fn policy_decomposed_correction(
    preset: PerceptualPolicyPreset,
) -> DecomposedCorrectionSerdeConfig {
    DecomposedCorrectionSerdeConfig {
        early_reflection_weight: match preset {
            PerceptualPolicyPreset::Reference => 0.1,
            PerceptualPolicyPreset::Music | PerceptualPolicyPreset::Cinema => 0.2,
            PerceptualPolicyPreset::Night => 0.15,
            PerceptualPolicyPreset::Speech => 0.6,
        },
        steady_state_weight: match preset {
            PerceptualPolicyPreset::Reference => 0.3,
            PerceptualPolicyPreset::Speech => 0.55,
            _ => 0.4,
        },
        mode_correction_weight: match preset {
            PerceptualPolicyPreset::Night => 0.85,
            _ => 1.0,
        },
        ..Default::default()
    }
}

pub(super) fn policy_psychoacoustic_smoothing(
    preset: PerceptualPolicyPreset,
) -> PsychoacousticSmoothingConfig {
    match preset {
        PerceptualPolicyPreset::Reference => PsychoacousticSmoothingConfig::default(),
        PerceptualPolicyPreset::Music => PsychoacousticSmoothingConfig {
            high_freq_n: 5,
            ..Default::default()
        },
        PerceptualPolicyPreset::Cinema | PerceptualPolicyPreset::Night => {
            PsychoacousticSmoothingConfig {
                high_freq_n: 4,
                high_freq: 900.0,
                ..Default::default()
            }
        }
        PerceptualPolicyPreset::Speech => PsychoacousticSmoothingConfig {
            low_freq_n: 24,
            high_freq_n: 6,
            low_freq: 150.0,
            high_freq: 1_200.0,
        },
    }
}

pub(super) fn policy_asymmetric_loss(preset: PerceptualPolicyPreset) -> AsymmetricLossConfig {
    match preset {
        PerceptualPolicyPreset::Reference => AsymmetricLossConfig::default(),
        PerceptualPolicyPreset::Music | PerceptualPolicyPreset::Cinema => AsymmetricLossConfig {
            bass_peak_weight: 5.0,
            bass_dip_weight: 0.2,
            peak_weight: 2.0,
            dip_weight: 0.5,
            transition_freq: 200.0,
        },
        PerceptualPolicyPreset::Night => AsymmetricLossConfig {
            bass_peak_weight: 6.0,
            bass_dip_weight: 0.1,
            peak_weight: 2.5,
            dip_weight: 0.4,
            transition_freq: 220.0,
        },
        PerceptualPolicyPreset::Speech => AsymmetricLossConfig {
            bass_peak_weight: 3.0,
            bass_dip_weight: 0.2,
            peak_weight: 2.5,
            dip_weight: 0.75,
            transition_freq: 180.0,
        },
    }
}

pub(super) fn policy_smoothness_penalty(
    preset: PerceptualPolicyPreset,
) -> SmoothnessPenaltyConfigSerde {
    SmoothnessPenaltyConfigSerde {
        tv2_weight: match preset {
            PerceptualPolicyPreset::Reference => 0.001,
            PerceptualPolicyPreset::Music => 0.0015,
            PerceptualPolicyPreset::Cinema => 0.002,
            PerceptualPolicyPreset::Night => 0.003,
            PerceptualPolicyPreset::Speech => 0.001,
        },
        schroeder_hz: Some(default_decomposed_schroeder()),
        modal_weight_scale: 0.1,
        exponent: 1.0,
    }
}

pub(super) fn policy_audibility_deadband(
    preset: PerceptualPolicyPreset,
) -> AudibilityDeadbandConfig {
    let mut cfg = AudibilityDeadbandConfig::default();
    match preset {
        PerceptualPolicyPreset::Reference => {}
        PerceptualPolicyPreset::Music => {
            cfg.mid_db = 0.65;
            cfg.treble_db = 0.9;
        }
        PerceptualPolicyPreset::Cinema => {
            cfg.mid_db = 0.75;
            cfg.treble_db = 1.1;
        }
        PerceptualPolicyPreset::Night => {
            cfg.bass_db = 0.5;
            cfg.mid_db = 0.9;
            cfg.treble_db = 1.25;
        }
        PerceptualPolicyPreset::Speech => {
            cfg.bass_db = 0.75;
            cfg.mid_db = 0.5;
            cfg.treble_db = 0.75;
            cfg.disable_below_schroeder = false;
        }
    }
    cfg
}

pub(super) fn policy_high_frequency_guard(
    preset: PerceptualPolicyPreset,
) -> HighFrequencyCorrectionConfig {
    HighFrequencyCorrectionConfig {
        extra_deadband_db: match preset {
            PerceptualPolicyPreset::Reference => 0.75,
            PerceptualPolicyPreset::Music => 0.6,
            PerceptualPolicyPreset::Cinema | PerceptualPolicyPreset::Night => 0.9,
            PerceptualPolicyPreset::Speech => 0.4,
        },
        smoothing_n: match preset {
            PerceptualPolicyPreset::Speech => 5,
            PerceptualPolicyPreset::Music => 4,
            _ => 3,
        },
        max_q: match preset {
            PerceptualPolicyPreset::Speech => 2.5,
            _ => 2.0,
        },
        ..Default::default()
    }
}

pub(super) fn policy_early_late_correction(
    preset: PerceptualPolicyPreset,
) -> EarlyLateCorrectionConfig {
    EarlyLateCorrectionConfig {
        early_cue_risk_db: match preset {
            PerceptualPolicyPreset::Reference => -22.0,
            PerceptualPolicyPreset::Music | PerceptualPolicyPreset::Cinema => -18.0,
            PerceptualPolicyPreset::Night => -20.0,
            PerceptualPolicyPreset::Speech => -14.0,
        },
        ..Default::default()
    }
}