alex/nih-plug
1
0
Fork 0
Code Activity

Fix comments in the Crisp plugin

Browse source
This commit is contained in:
Robbert van der Helm 2022-03-09 00:51:52 +01:00
parent 8f45ef84ee
commit 305a3f922b
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
plugins/crisp/src/lib.rs
View file

@ -27,9 +27,9 @@ const INITIAL_PRNG_SEED: Pcg32iState = Pcg32iState::new(69, 420);
/// Allow 100% amount to scale the gain to a bit above 100%, to make the effect even less subtle. /// Allow 100% amount to scale the gain to a bit above 100%, to make the effect even less subtle.
const AMOUNT_GAIN_MULTIPLIER: f32 = 2.0; const AMOUNT_GAIN_MULTIPLIER: f32 = 2.0;
/// This plugin essentially layers the sound with another copy of the signal AM'ed with white (or /// This plugin essentially layers the sound with another copy of the signal ring modulated with
/// filtered) noise. That other copy of the sound may have a low pass filter applied to it since /// white (or filtered) noise. That other copy of the sound may have a low pass filter applied to it
/// this effect just turns into literal noise at high frequencies. /// since this effect just turns into literal noise at high frequencies.
struct Crisp { struct Crisp {
params: Pin<Box<CrispParams>>, params: Pin<Box<CrispParams>>,
@ -38,15 +38,15 @@ struct Crisp {
prng: Pcg32iState, prng: Pcg32iState,
} }
// TODO: Add a filter for the AM input // TODO: Add a filter for the RM input
// TODO: Add more kinds of noise // TODO: Add more kinds of noise
#[derive(Params)] #[derive(Params)]
pub struct CrispParams { pub struct CrispParams {
/// On a range of `[0, 1]`, how much of the modulated sound to mix in. /// On a range of `[0, 1]`, how much of the modulated sound to mix in.
#[id = "amount"] #[id = "amount"]
amount: FloatParam, amount: FloatParam,
/// What kind of AM to apply. The preset this was modelled after whether intentional or not only /// What kind of RM to apply. The preset this was modelled after whether intentional or not only
/// AMs the positive part of the waveform. /// RMs the positive part of the waveform.
#[id = "mode"] #[id = "mode"]
mode: EnumParam<Mode>, mode: EnumParam<Mode>,
/// How to handle stereo signals. See [`StereoMode`]. /// How to handle stereo signals. See [`StereoMode`].
@ -61,12 +61,12 @@ pub struct CrispParams {
/// Controls the type of modulation to apply. /// Controls the type of modulation to apply.
#[derive(Enum, Debug, PartialEq)] #[derive(Enum, Debug, PartialEq)]
enum Mode { enum Mode {
/// AM the entire waveform. /// RM the entire waveform.
Crispy, Crispy,
/// AM only the positive part of the waveform. /// RM only the positive part of the waveform.
#[name = "Even Crispier"] #[name = "Even Crispier"]
EvenCrispier, EvenCrispier,
/// AM only the negative part of the waveform. /// RM only the negative part of the waveform.
#[name = "Even Crispier (alt)"] #[name = "Even Crispier (alt)"]
EvenCrispierNegated, EvenCrispierNegated,
} }
@ -166,14 +166,14 @@ impl Plugin for Crisp {
StereoMode::Mono => { StereoMode::Mono => {
let noise = self.gen_noise(); let noise = self.gen_noise();
for sample in channel_samples { for sample in channel_samples {
*sample += self.do_am(*sample, noise) * amount; *sample += self.do_ring_mod(*sample, noise) * amount;
*sample *= output_gain; *sample *= output_gain;
} }
} }
StereoMode::Stereo => { StereoMode::Stereo => {
for sample in channel_samples { for sample in channel_samples {
let noise = self.gen_noise(); let noise = self.gen_noise();
*sample += self.do_am(*sample, noise) * amount; *sample += self.do_ring_mod(*sample, noise) * amount;
*sample *= output_gain; *sample *= output_gain;
} }
} }
@ -190,8 +190,8 @@ impl Crisp {
self.prng.next_f32() * 2.0 - 1.0 self.prng.next_f32() * 2.0 - 1.0
} }
/// Perform the AM step depending on the mode. /// Perform the RM step depending on the mode.
fn do_am(&self, sample: f32, noise: f32) -> f32 { fn do_ring_mod(&self, sample: f32, noise: f32) -> f32 {
// TODO: Avoid branching in the main loop, this just makes it a bit easier to prototype // TODO: Avoid branching in the main loop, this just makes it a bit easier to prototype
match self.params.mode.value() { match self.params.mode.value() {
Mode::Crispy => sample * noise, Mode::Crispy => sample * noise,