use super::misc::interpolate_boost_envelope;
use crate::PeqModel;
pub fn clamp_gains_to_envelope(
x: &[f64],
envelope: &[(f64, f64)],
peq_model: PeqModel,
) -> Vec<f64> {
use crate::param_utils;
let mut clamped = x.to_vec();
let num_filters = param_utils::num_filters(x, peq_model);
for i in 0..num_filters {
let params = param_utils::get_filter_params(x, i, peq_model);
let freq_hz = 10f64.powf(params.freq);
if params.gain > 0.0 {
let max_boost = interpolate_boost_envelope(envelope, freq_hz);
if params.gain > max_boost {
let ppf = param_utils::params_per_filter(peq_model);
let gain_idx = i * ppf + (ppf - 1);
clamped[gain_idx] = max_boost;
}
}
}
clamped
}
pub fn clamp_cuts_to_envelope(x: &[f64], envelope: &[(f64, f64)], peq_model: PeqModel) -> Vec<f64> {
use crate::param_utils;
let mut clamped = x.to_vec();
let num_filters = param_utils::num_filters(x, peq_model);
for i in 0..num_filters {
let params = param_utils::get_filter_params(x, i, peq_model);
let freq_hz = 10f64.powf(params.freq);
if params.gain < 0.0 {
let max_cut = interpolate_boost_envelope(envelope, freq_hz); if params.gain < max_cut {
let ppf = param_utils::params_per_filter(peq_model);
let gain_idx = i * ppf + (ppf - 1);
clamped[gain_idx] = max_cut;
}
}
}
clamped
}
pub fn clamp_envelopes_into<'a>(
x: &'a [f64],
output: &'a mut Vec<f64>,
max_boost: Option<&[(f64, f64)]>,
min_cut: Option<&[(f64, f64)]>,
peq_model: PeqModel,
) -> &'a [f64] {
if max_boost.is_none() && min_cut.is_none() {
return x;
}
output.clear();
output.extend_from_slice(x);
let num_filters = crate::param_utils::num_filters(x, peq_model);
let parameters_per_filter = crate::param_utils::params_per_filter(peq_model);
for index in 0..num_filters {
let params = crate::param_utils::get_filter_params(x, index, peq_model);
let frequency = 10f64.powf(params.freq);
let gain_index = index * parameters_per_filter + parameters_per_filter - 1;
if params.gain > 0.0
&& let Some(envelope) = max_boost
{
output[gain_index] = params
.gain
.min(interpolate_boost_envelope(envelope, frequency));
} else if params.gain < 0.0
&& let Some(envelope) = min_cut
{
output[gain_index] = params
.gain
.max(interpolate_boost_envelope(envelope, frequency));
}
}
output
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn clamp_gains_to_envelope_clamps_boosts_above_limit() {
let x = vec![3.0, 1.0, 10.0];
let envelope = vec![(100.0, 12.0), (1000.0, 6.0), (10000.0, 3.0)];
let clamped = clamp_gains_to_envelope(&x, &envelope, PeqModel::Pk);
assert!(
(clamped[2] - 6.0).abs() < 1e-12,
"boost should be clamped to envelope"
);
}
#[test]
fn clamp_gains_to_envelope_leaves_boosts_below_limit_unchanged() {
let x = vec![3.0, 1.0, 4.0];
let envelope = vec![(100.0, 12.0), (1000.0, 6.0), (10000.0, 3.0)];
let clamped = clamp_gains_to_envelope(&x, &envelope, PeqModel::Pk);
assert!(
(clamped[2] - 4.0).abs() < 1e-12,
"boost below envelope should stay unchanged"
);
}
#[test]
fn clamp_gains_to_envelope_leaves_cuts_unchanged() {
let x = vec![3.0, 1.0, -8.0];
let envelope = vec![(100.0, 12.0), (1000.0, 6.0), (10000.0, 3.0)];
let clamped = clamp_gains_to_envelope(&x, &envelope, PeqModel::Pk);
assert!(
(clamped[2] - (-8.0)).abs() < 1e-12,
"cuts should not be affected by gain clamping"
);
}
#[test]
fn clamp_cuts_to_envelope_clamps_cuts_below_limit() {
let x = vec![3.0, 1.0, -10.0];
let envelope = vec![(100.0, -12.0), (1000.0, -6.0), (10000.0, -3.0)];
let clamped = clamp_cuts_to_envelope(&x, &envelope, PeqModel::Pk);
assert!(
(clamped[2] - (-6.0)).abs() < 1e-12,
"cut should be clamped to envelope"
);
}
#[test]
fn clamp_cuts_to_envelope_leaves_cuts_above_limit_unchanged() {
let x = vec![3.0, 1.0, -4.0];
let envelope = vec![(100.0, -12.0), (1000.0, -6.0), (10000.0, -3.0)];
let clamped = clamp_cuts_to_envelope(&x, &envelope, PeqModel::Pk);
assert!(
(clamped[2] - (-4.0)).abs() < 1e-12,
"cut above envelope limit should stay unchanged"
);
}
#[test]
fn clamp_cuts_to_envelope_leaves_boosts_unchanged() {
let x = vec![3.0, 1.0, 8.0];
let envelope = vec![(100.0, -12.0), (1000.0, -6.0), (10000.0, -3.0)];
let clamped = clamp_cuts_to_envelope(&x, &envelope, PeqModel::Pk);
assert!(
(clamped[2] - 8.0).abs() < 1e-12,
"boosts should not be affected by cut clamping"
);
}
#[test]
fn clamp_gains_to_envelope_empty_envelope_allows_anything() {
let x = vec![3.0, 1.0, 20.0];
let clamped = clamp_gains_to_envelope(&x, &[], PeqModel::Pk);
assert!((clamped[2] - 20.0).abs() < 1e-12);
}
}