1
0
Fork 0
nih-plug/plugins/spectral_compressor/src/lib.rs
Robbert van der Helm da61acc7b9 Compute SC editor size based on the editor mode
Using the new declarative editor size interface.
2023-03-18 14:25:41 +01:00

613 lines
24 KiB
Rust

// Spectral Compressor: an FFT based compressor
// Copyright (C) 2021-2023 Robbert van der Helm
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
use crossbeam::atomic::AtomicCell;
use editor::EditorMode;
use nih_plug::prelude::*;
use nih_plug_vizia::ViziaState;
use realfft::num_complex::Complex32;
use realfft::{ComplexToReal, RealFftPlanner, RealToComplex};
use std::sync::Arc;
mod compressor_bank;
mod dry_wet_mixer;
mod editor;
const MIN_WINDOW_ORDER: usize = 6;
#[allow(dead_code)]
const MIN_WINDOW_SIZE: usize = 1 << MIN_WINDOW_ORDER; // 64
const DEFAULT_WINDOW_ORDER: usize = 12;
#[allow(dead_code)]
const DEFAULT_WINDOW_SIZE: usize = 1 << DEFAULT_WINDOW_ORDER; // 4096
const MAX_WINDOW_ORDER: usize = 15;
const MAX_WINDOW_SIZE: usize = 1 << MAX_WINDOW_ORDER; // 32768
const MIN_OVERLAP_ORDER: usize = 2;
#[allow(dead_code)]
const MIN_OVERLAP_TIMES: usize = 1 << MIN_OVERLAP_ORDER; // 4
const DEFAULT_OVERLAP_ORDER: usize = 3;
#[allow(dead_code)]
const DEFAULT_OVERLAP_TIMES: usize = 1 << DEFAULT_OVERLAP_ORDER; // 4
const MAX_OVERLAP_ORDER: usize = 5;
#[allow(dead_code)]
const MAX_OVERLAP_TIMES: usize = 1 << MAX_OVERLAP_ORDER; // 32
/// This is a port of <https://github.com/robbert-vdh/spectral-compressor/>.
pub struct SpectralCompressor {
params: Arc<SpectralCompressorParams>,
/// The current buffer config, used for updating the compressors.
buffer_config: BufferConfig,
/// An adapter that performs most of the overlap-add algorithm for us.
stft: util::StftHelper<1>,
/// Contains a Hann window function of the current window length, passed to the overlap-add
/// helper. Allocated with a `MAX_WINDOW_SIZE` initial capacity.
window_function: Vec<f32>,
/// A mixer to mix the dry signal back into the processed signal with latency compensation.
dry_wet_mixer: dry_wet_mixer::DryWetMixer,
/// Spectral per-bin upwards and downwards compressors with soft-knee settings. This is where
/// the magic happens.
compressor_bank: compressor_bank::CompressorBank,
/// The algorithms for the FFT and IFFT operations, for each supported order so we can switch
/// between them without replanning or allocations. Initialized during `initialize()`.
plan_for_order: Option<[Plan; MAX_WINDOW_ORDER - MIN_WINDOW_ORDER + 1]>,
/// The output of our real->complex FFT.
complex_fft_buffer: Vec<Complex32>,
}
/// An FFT plan for a specific window size, all of which will be precomputed during initilaization.
struct Plan {
/// The algorithm for the FFT operation.
r2c_plan: Arc<dyn RealToComplex<f32>>,
/// The algorithm for the IFFT operation.
c2r_plan: Arc<dyn ComplexToReal<f32>>,
}
#[derive(Params)]
pub struct SpectralCompressorParams {
/// The editor state, saved together with the parameter state so the custom scaling can be
/// restored.
#[persist = "editor-state"]
pub editor_state: Arc<ViziaState>,
/// The mode the editor is currently in. Essentially just a fancy boolean to indicate whether
/// it's expanded or not.
#[persist = "editor-mode"]
pub editor_mode: Arc<AtomicCell<EditorMode>>,
// NOTE: These `Arc`s are only here temporarily to work around Vizia's Lens requirements so we
// can use the generic UIs
/// Global parameters. These could just live in this struct but I wanted a separate generic UI
/// just for these.
#[nested(group = "global")]
pub global: Arc<GlobalParams>,
/// Parameters controlling the compressor thresholds and curves.
#[nested(group = "threshold")]
pub threshold: Arc<compressor_bank::ThresholdParams>,
/// Parameters for the upwards and downwards compressors.
#[nested(group = "compressors")]
pub compressors: compressor_bank::CompressorBankParams,
}
/// Global parameters controlling the output stage and all compressors.
#[derive(Params)]
pub struct GlobalParams {
/// Makeup gain applied after the IDFT in the STFT process. If automatic makeup gain is enabled,
/// then this acts as an offset on top of that. This is stored as linear gain.
#[id = "output"]
pub output_gain: FloatParam,
// TODO: Bring this back, and with values that make more sense
// /// Try to automatically compensate for gain differences with different input gain, threshold, and ratio values.
// #[id = "auto_makeup"]
// auto_makeup_gain: BoolParam,
/// How much of the dry signal to mix in with the processed signal. The mixing is done after
/// applying the output gain. In other words, the dry signal is not gained in any way.
#[id = "dry_wet"]
pub dry_wet_ratio: FloatParam,
/// The size of the FFT window as a power of two (to prevent invalid inputs).
#[id = "stft_window"]
pub window_size_order: IntParam,
/// The amount of overlap to use in the overlap-add algorithm as a power of two (again to
/// prevent invalid inputs).
#[id = "stft_overlap"]
pub overlap_times_order: IntParam,
/// The compressor's attack time in milliseconds. Controls both upwards and downwards
/// compression.
#[id = "attack"]
pub compressor_attack_ms: FloatParam,
/// The compressor's release time in milliseconds. Controls both upwards and downwards
/// compression.
#[id = "release"]
pub compressor_release_ms: FloatParam,
}
impl Default for SpectralCompressor {
fn default() -> Self {
// Changing any of the compressor threshold or ratio parameters will set an atomic flag in
// this object that causes the compressor thresholds and ratios to be recalcualted
let compressor_bank = compressor_bank::CompressorBank::new(2, MAX_WINDOW_SIZE);
SpectralCompressor {
params: Arc::new(SpectralCompressorParams::new(&compressor_bank)),
buffer_config: BufferConfig {
sample_rate: 1.0,
min_buffer_size: None,
max_buffer_size: 0,
process_mode: ProcessMode::Realtime,
},
// These three will be set to the correct values in the initialize function
stft: util::StftHelper::new(2, MAX_WINDOW_SIZE, 0),
window_function: Vec::with_capacity(MAX_WINDOW_SIZE),
dry_wet_mixer: dry_wet_mixer::DryWetMixer::new(0, 0, 0),
compressor_bank,
// This is initialized later since we don't want to do non-trivial computations before
// the plugin is initialized
plan_for_order: None,
complex_fft_buffer: Vec::with_capacity(MAX_WINDOW_SIZE / 2 + 1),
}
}
}
impl Default for GlobalParams {
fn default() -> Self {
GlobalParams {
// We don't need any smoothing for these parameters as the overlap-add process will
// already act as a form of smoothing
output_gain: FloatParam::new(
"Output Gain",
util::db_to_gain(0.0),
FloatRange::Skewed {
min: util::db_to_gain(-50.0),
max: util::db_to_gain(50.0),
factor: FloatRange::gain_skew_factor(-50.0, 50.0),
},
)
.with_unit(" dB")
.with_value_to_string(formatters::v2s_f32_gain_to_db(2))
.with_string_to_value(formatters::s2v_f32_gain_to_db()),
// auto_makeup_gain: BoolParam::new("Auto Makeup Gain", true),
dry_wet_ratio: FloatParam::new("Mix", 1.0, FloatRange::Linear { min: 0.0, max: 1.0 })
.with_unit("%")
.with_smoother(SmoothingStyle::Linear(15.0))
.with_value_to_string(formatters::v2s_f32_percentage(0))
.with_string_to_value(formatters::s2v_f32_percentage()),
window_size_order: IntParam::new(
"Window Size",
DEFAULT_WINDOW_ORDER as i32,
IntRange::Linear {
min: MIN_WINDOW_ORDER as i32,
max: MAX_WINDOW_ORDER as i32,
},
)
.with_value_to_string(formatters::v2s_i32_power_of_two())
.with_string_to_value(formatters::s2v_i32_power_of_two()),
overlap_times_order: IntParam::new(
"Window Overlap",
DEFAULT_OVERLAP_ORDER as i32,
IntRange::Linear {
min: MIN_OVERLAP_ORDER as i32,
max: MAX_OVERLAP_ORDER as i32,
},
)
.with_value_to_string(formatters::v2s_i32_power_of_two())
.with_string_to_value(formatters::s2v_i32_power_of_two()),
compressor_attack_ms: FloatParam::new(
"Attack",
150.0,
FloatRange::Skewed {
min: 0.0,
max: 10_000.0,
factor: FloatRange::skew_factor(-2.0),
},
)
.with_unit(" ms")
.with_step_size(0.1),
compressor_release_ms: FloatParam::new(
"Release",
300.0,
FloatRange::Skewed {
min: 0.0,
max: 10_000.0,
factor: FloatRange::skew_factor(-2.0),
},
)
.with_unit(" ms")
.with_step_size(0.1),
}
}
}
impl SpectralCompressorParams {
/// Create a new [`SpectralCompressorParams`] object. Changing any of the compressor threshold
/// or ratio parameters causes the passed compressor bank's parameters to be updated.
pub fn new(compressor_bank: &compressor_bank::CompressorBank) -> Self {
let editor_mode: Arc<AtomicCell<EditorMode>> = Arc::default();
SpectralCompressorParams {
editor_state: editor::default_state(editor_mode.clone()),
editor_mode,
// TODO: Do still enable per-block smoothing for these settings, because why not. This
// will require updating the compressor bank.
global: Arc::new(GlobalParams::default()),
threshold: Arc::new(compressor_bank::ThresholdParams::new(compressor_bank)),
compressors: compressor_bank::CompressorBankParams::new(compressor_bank),
}
}
}
impl Plugin for SpectralCompressor {
const NAME: &'static str = "Spectral Compressor";
const VENDOR: &'static str = "Robbert van der Helm";
const URL: &'static str = env!("CARGO_PKG_HOMEPAGE");
const EMAIL: &'static str = "mail@robbertvanderhelm.nl";
const VERSION: &'static str = env!("CARGO_PKG_VERSION");
const AUDIO_IO_LAYOUTS: &'static [AudioIOLayout] = &[
AudioIOLayout {
main_input_channels: NonZeroU32::new(2),
main_output_channels: NonZeroU32::new(2),
aux_input_ports: &[new_nonzero_u32(2)],
..AudioIOLayout::const_default()
},
AudioIOLayout {
main_input_channels: NonZeroU32::new(1),
main_output_channels: NonZeroU32::new(1),
aux_input_ports: &[new_nonzero_u32(1)],
..AudioIOLayout::const_default()
},
];
const SAMPLE_ACCURATE_AUTOMATION: bool = true;
type SysExMessage = ();
type BackgroundTask = ();
fn params(&self) -> Arc<dyn Params> {
self.params.clone()
}
fn editor(&self, _async_executor: AsyncExecutor<Self>) -> Option<Box<dyn Editor>> {
editor::create(self.params.clone(), self.params.editor_state.clone())
}
fn initialize(
&mut self,
audio_io_layout: &AudioIOLayout,
buffer_config: &BufferConfig,
context: &mut impl InitContext<Self>,
) -> bool {
// Needed to update the compressors later
self.buffer_config = *buffer_config;
// This plugin can accept a variable number of audio channels, so we need to resize
// channel-dependent data structures accordingly
let num_output_channels = audio_io_layout
.main_output_channels
.expect("Plugin does not have a main output")
.get() as usize;
if self.stft.num_channels() != num_output_channels {
self.stft = util::StftHelper::new(self.stft.num_channels(), MAX_WINDOW_SIZE, 0);
}
self.dry_wet_mixer.resize(
num_output_channels,
buffer_config.max_buffer_size as usize,
MAX_WINDOW_SIZE,
);
self.compressor_bank
.update_capacity(num_output_channels, MAX_WINDOW_SIZE);
// Planning with RustFFT is very fast, but it will still allocate we we'll plan all of the
// FFTs we might need in advance
if self.plan_for_order.is_none() {
let mut planner = RealFftPlanner::new();
let plan_for_order: Vec<Plan> = (MIN_WINDOW_ORDER..=MAX_WINDOW_ORDER)
.map(|order| Plan {
r2c_plan: planner.plan_fft_forward(1 << order),
c2r_plan: planner.plan_fft_inverse(1 << order),
})
.collect();
self.plan_for_order = Some(
plan_for_order
.try_into()
.unwrap_or_else(|_| panic!("Mismatched plan orders")),
);
}
let window_size = self.window_size();
self.resize_for_window(window_size);
context.set_latency_samples(self.stft.latency_samples());
true
}
fn reset(&mut self) {
self.dry_wet_mixer.reset();
self.compressor_bank.reset();
}
fn process(
&mut self,
buffer: &mut Buffer,
aux: &mut AuxiliaryBuffers,
context: &mut impl ProcessContext<Self>,
) -> ProcessStatus {
// If the window size has changed since the last process call, reset the buffers and chance
// our latency. All of these buffers already have enough capacity so this won't allocate.
let window_size = self.window_size();
let overlap_times = self.overlap_times();
if self.window_function.len() != window_size {
self.resize_for_window(window_size);
context.set_latency_samples(self.stft.latency_samples());
}
// These plans have already been made during initialization we can switch between versions
// without reallocating
let fft_plan = &mut self.plan_for_order.as_mut().unwrap()
[self.params.global.window_size_order.value() as usize - MIN_WINDOW_ORDER];
let num_bins = self.complex_fft_buffer.len();
// The Hann window function spreads the DC signal out slightly, so we'll clear all 0-20 Hz
// bins for this. With small window sizes you probably don't want this as it would result in
// a significant low-pass filter. When it's disabled, the DC bin will also be compressed.
let first_non_dc_bin_idx =
(20.0 / ((self.buffer_config.sample_rate / 2.0) / num_bins as f32)).floor() as usize
+ 1;
// The overlap gain compensation is based on a squared Hann window, which will sum perfectly
// at four times overlap or higher. We'll apply a regular Hann window before the analysis
// and after the synthesis.
let gain_compensation: f32 =
((overlap_times as f32 / 4.0) * 1.5).recip() / window_size as f32;
// We'll apply the square root of the total gain compensation at the DFT and the IDFT
// stages. That way the compressor threshold values make much more sense. This version of
// Spectral Compressor does not have in input gain option and instead has the curve
// threshold option. When sidechaining is enabled this is used to gain up the sidechain
// signal instead.
let input_gain = gain_compensation.sqrt();
let output_gain = self.params.global.output_gain.value() * gain_compensation.sqrt();
// TODO: Auto makeup gain
// This is mixed in later with latency compensation applied
self.dry_wet_mixer.write_dry(buffer);
match self.params.threshold.mode.value() {
compressor_bank::ThresholdMode::Internal => self.stft.process_overlap_add(
buffer,
overlap_times,
|channel_idx, real_fft_buffer| {
process_stft_main(
channel_idx,
real_fft_buffer,
&mut self.complex_fft_buffer,
fft_plan,
&self.window_function,
&self.params,
&mut self.compressor_bank,
input_gain,
output_gain,
overlap_times,
first_non_dc_bin_idx,
)
},
),
compressor_bank::ThresholdMode::SidechainMatch
| compressor_bank::ThresholdMode::SidechainCompress => {
self.stft.process_overlap_add_sidechain(
buffer,
[&aux.inputs[0]],
overlap_times,
|channel_idx, sidechain_buffer_idx, real_fft_buffer| {
if sidechain_buffer_idx.is_some() {
process_stft_sidechain(
channel_idx,
real_fft_buffer,
&mut self.complex_fft_buffer,
fft_plan,
&self.window_function,
&mut self.compressor_bank,
input_gain,
);
} else {
process_stft_main(
channel_idx,
real_fft_buffer,
&mut self.complex_fft_buffer,
fft_plan,
&self.window_function,
&self.params,
&mut self.compressor_bank,
input_gain,
output_gain,
overlap_times,
first_non_dc_bin_idx,
)
}
},
)
}
}
self.dry_wet_mixer.mix_in_dry(
buffer,
self.params
.global
.dry_wet_ratio
.smoothed
.next_step(buffer.samples() as u32),
// The dry and wet signals are in phase, so we can do a linear mix
dry_wet_mixer::MixingStyle::Linear,
self.stft.latency_samples() as usize,
);
ProcessStatus::Normal
}
}
impl SpectralCompressor {
fn window_size(&self) -> usize {
1 << self.params.global.window_size_order.value() as usize
}
fn overlap_times(&self) -> usize {
1 << self.params.global.overlap_times_order.value() as usize
}
/// `window_size` should not exceed `MAX_WINDOW_SIZE` or this will allocate.
fn resize_for_window(&mut self, window_size: usize) {
// The FFT algorithms for this window size have already been planned in
// `self.plan_for_order`, and all of these data structures already have enough capacity, so
// we just need to change some sizes.
self.stft.set_block_size(window_size);
self.window_function.resize(window_size, 0.0);
util::window::hann_in_place(&mut self.window_function);
self.complex_fft_buffer
.resize(window_size / 2 + 1, Complex32::default());
// This also causes the thresholds and ratios to be updated on the next STFT process cycle.
self.compressor_bank
.resize(&self.buffer_config, window_size);
self.compressor_bank.reset();
}
}
// These separate functions are needed to avoid having to either duplicate the main process function
// or always do the sidechain STFT. You can't do partial borrows and call `&mut self` methods at the
// same time.
/// The main process function inside of the STFT callback. If the sidechaining option is
/// enabled, another callback will run just before this to set up the siddechain frequency
/// spectrum magnitudes.
#[allow(clippy::too_many_arguments)]
fn process_stft_main(
channel_idx: usize,
real_fft_buffer: &mut [f32],
complex_fft_buffer: &mut [Complex32],
fft_plan: &mut Plan,
window_function: &[f32],
params: &SpectralCompressorParams,
compressor_bank: &mut compressor_bank::CompressorBank,
input_gain: f32,
output_gain: f32,
overlap_times: usize,
first_non_dc_bin_idx: usize,
) {
// We'll window the input with a Hann function to avoid spectral leakage. The input gain
// here also contains a compensation factor for the forward FFT to make the compressor
// thresholds make more sense.
for (sample, window_sample) in real_fft_buffer.iter_mut().zip(window_function) {
*sample *= window_sample * input_gain;
}
// RustFFT doesn't actually need a scratch buffer here, so we'll pass an empty buffer
// instead
fft_plan
.r2c_plan
.process_with_scratch(real_fft_buffer, complex_fft_buffer, &mut [])
.unwrap();
// This is where the magic happens
compressor_bank.process(
complex_fft_buffer,
channel_idx,
params,
overlap_times,
first_non_dc_bin_idx,
);
// Inverse FFT back into the scratch buffer. This will be added to a ring buffer
// which gets written back to the host at a one block delay.
fft_plan
.c2r_plan
.process_with_scratch(complex_fft_buffer, real_fft_buffer, &mut [])
.unwrap();
// Apply the window function once more to reduce time domain aliasing. The gain
// compensation compensates for the squared Hann window that would be applied if we
// didn't do any processing at all as well as the FFT+IFFT itself.
for (sample, window_sample) in real_fft_buffer.iter_mut().zip(window_function) {
*sample *= window_sample * output_gain;
}
}
/// The analysis process function inside of the STFT callback used to compute the frequency
/// spectrum magnitudes from the sidechain input if the sidechaining option is enabled. All
/// sidechain channels will be processed before processing the main input
fn process_stft_sidechain(
channel_idx: usize,
real_fft_buffer: &mut [f32],
complex_fft_buffer: &mut [Complex32],
fft_plan: &mut Plan,
window_function: &[f32],
compressor_bank: &mut compressor_bank::CompressorBank,
input_gain: f32,
) {
// The sidechain input should be gained, scaled, and windowed the exact same was as the
// main input as it's used for analysis
for (sample, window_sample) in real_fft_buffer.iter_mut().zip(window_function) {
*sample *= window_sample * input_gain;
}
fft_plan
.r2c_plan
.process_with_scratch(real_fft_buffer, complex_fft_buffer, &mut [])
.unwrap();
compressor_bank.process_sidechain(complex_fft_buffer, channel_idx);
}
impl ClapPlugin for SpectralCompressor {
const CLAP_ID: &'static str = "nl.robbertvanderhelm.spectral-compressor";
const CLAP_DESCRIPTION: Option<&'static str> = Some("Turn things into pink noise on demand");
const CLAP_MANUAL_URL: Option<&'static str> = Some(Self::URL);
const CLAP_SUPPORT_URL: Option<&'static str> = None;
const CLAP_FEATURES: &'static [ClapFeature] = &[
ClapFeature::AudioEffect,
ClapFeature::Stereo,
ClapFeature::Mono,
ClapFeature::PhaseVocoder,
ClapFeature::Compressor,
ClapFeature::Custom("nih:spectral"),
ClapFeature::Custom("nih:sosig"),
];
}
impl Vst3Plugin for SpectralCompressor {
const VST3_CLASS_ID: [u8; 16] = *b"SpectrlComprRvdH";
const VST3_SUBCATEGORIES: &'static [Vst3SubCategory] = &[
Vst3SubCategory::Fx,
Vst3SubCategory::Dynamics,
Vst3SubCategory::Custom("Spectral"),
];
}
nih_export_clap!(SpectralCompressor);
nih_export_vst3!(SpectralCompressor);