320 lines
11 KiB
Rust
320 lines
11 KiB
Rust
// nih-plug: plugins, but rewritten in Rust
|
|
// Copyright (C) 2022 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/>.
|
|
|
|
//! TODO: Document how to use the [Param] trait. For the moment, just look at the gain example.
|
|
|
|
use std::fmt::Display;
|
|
use std::sync::Arc;
|
|
|
|
use self::range::{NormalizebleRange, Range};
|
|
use self::smoothing::Smoother;
|
|
|
|
pub mod internals;
|
|
pub mod range;
|
|
pub mod smoothing;
|
|
|
|
pub type FloatParam = PlainParam<f32>;
|
|
pub type IntParam = PlainParam<i32>;
|
|
|
|
/// Describes a single parmaetre of any type.
|
|
pub trait Param {
|
|
/// The plain parameter type.
|
|
type Plain;
|
|
|
|
/// Update the smoother state to point to the current value. Used when initializing and
|
|
/// restoring a plugin so everything is in sync.
|
|
fn update_smoother(&mut self, sample_rate: f32);
|
|
|
|
/// Set this parameter based on a string. Returns whether the updating succeeded. That can fail
|
|
/// if the string cannot be parsed.
|
|
///
|
|
/// TODO: After implementing VST3, check if we handle parsing failures correctly
|
|
fn set_from_string(&mut self, string: &str) -> bool;
|
|
|
|
/// Get the unnormalized value for this parameter.
|
|
fn plain_value(&self) -> Self::Plain;
|
|
|
|
/// Set this parameter based on a plain, unnormalized value.
|
|
///
|
|
/// This does **not** update the smoother.
|
|
///
|
|
/// TDOO: Decide on whether this should update the smoother or not. That wouldn't be compatible
|
|
/// with sample accurate automation when we add that.
|
|
fn set_plain_value(&mut self, plain: Self::Plain);
|
|
|
|
/// Get the normalized `[0, 1]` value for this parameter.
|
|
fn normalized_value(&self) -> f32;
|
|
|
|
/// Set this parameter based on a normalized value.
|
|
///
|
|
/// This does **not** update the smoother.
|
|
fn set_normalized_value(&mut self, normalized: f32);
|
|
|
|
/// Get the string representation for a normalized value. Used as part of the wrappers. Most
|
|
/// plugin formats already have support for units, in which case it shouldn't be part of this
|
|
/// string or some DAWs may show duplicate units.
|
|
fn normalized_value_to_string(&self, normalized: f32, include_unit: bool) -> String;
|
|
|
|
/// Get the string representation for a normalized value. Used as part of the wrappers.
|
|
fn string_to_normalized_value(&self, string: &str) -> Option<f32>;
|
|
|
|
/// Internal implementation detail for implementing [Params]. This should not be used directly.
|
|
fn as_ptr(&self) -> internals::ParamPtr;
|
|
}
|
|
|
|
/// A numerical parameter that's stored unnormalized. The range is used for the normalization
|
|
/// process.
|
|
pub struct PlainParam<T> {
|
|
/// The field's current plain, unnormalized value. Should be initialized with the default value.
|
|
/// Storing parameter values like this instead of in a single contiguous array is bad for cache
|
|
/// locality, but it does allow for a much nicer declarative API.
|
|
pub value: T,
|
|
pub smoothed: Smoother<T>,
|
|
/// Optional callback for listening to value changes. The argument passed to this function is
|
|
/// the parameter's new **plain** value. This should not do anything expensive as it may be
|
|
/// called multiple times in rapid succession.
|
|
///
|
|
/// To use this, you'll probably want to store an `Arc<Atomic*>` alongside the parmater in the
|
|
/// parmaeters struct, move a clone of that `Arc` into this closure, and then modify that.
|
|
pub value_changed: Option<Arc<dyn Fn(T) + Send + Sync>>,
|
|
|
|
/// The distribution of the parameter's values.
|
|
pub range: Range<T>,
|
|
/// The parameter's human readable display name.
|
|
pub name: &'static str,
|
|
/// The parameter value's unit, added after `value_to_string` if that is set.
|
|
pub unit: &'static str,
|
|
/// Optional custom conversion function from a plain **unnormalized** value to a string.
|
|
pub value_to_string: Option<Arc<dyn Fn(T) -> String + Send + Sync>>,
|
|
/// Optional custom conversion function from a string to a plain **unnormalized** value. If the
|
|
/// string cannot be parsed, then this should return a `None`. If this happens while the
|
|
/// parameter is being updated then the update will be canceled.
|
|
pub string_to_value: Option<Arc<dyn Fn(&str) -> Option<T> + Send + Sync>>,
|
|
}
|
|
|
|
/// A simple boolean parmaeter.
|
|
pub struct BoolParam {
|
|
/// The field's current, normalized value. Should be initialized with the default value.
|
|
pub value: bool,
|
|
|
|
/// Optional callback for listening to value changes. The argument passed to this function is
|
|
/// the parameter's new value. This should not do anything expensive as it may be called
|
|
/// multiple times in rapid succession.
|
|
pub value_changed: Option<Arc<dyn Fn(bool) + Send + Sync>>,
|
|
|
|
/// The parameter's human readable display name.
|
|
pub name: &'static str,
|
|
/// Optional custom conversion function from a boolean value to a string.
|
|
pub value_to_string: Option<Arc<dyn Fn(bool) -> String + Send + Sync>>,
|
|
/// Optional custom conversion function from a string to a boolean value. If the string cannot
|
|
/// be parsed, then this should return a `None`. If this happens while the parameter is being
|
|
/// updated then the update will be canceled.
|
|
pub string_to_value: Option<Arc<dyn Fn(&str) -> Option<bool> + Send + Sync>>,
|
|
}
|
|
|
|
impl<T> Default for PlainParam<T>
|
|
where
|
|
T: Default,
|
|
Range<T>: Default,
|
|
{
|
|
fn default() -> Self {
|
|
Self {
|
|
value: T::default(),
|
|
smoothed: Smoother::none(),
|
|
value_changed: None,
|
|
range: Range::default(),
|
|
name: "",
|
|
unit: "",
|
|
value_to_string: None,
|
|
string_to_value: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[allow(clippy::derivable_impls)]
|
|
impl Default for BoolParam {
|
|
fn default() -> Self {
|
|
Self {
|
|
value: false,
|
|
value_changed: None,
|
|
name: "",
|
|
value_to_string: None,
|
|
string_to_value: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
macro_rules! impl_plainparam {
|
|
($ty:ident, $plain:ty) => {
|
|
impl Param for $ty {
|
|
type Plain = $plain;
|
|
|
|
fn update_smoother(&mut self, sample_rate: f32) {
|
|
self.smoothed.set_target(sample_rate, self.value);
|
|
}
|
|
|
|
fn set_from_string(&mut self, string: &str) -> bool {
|
|
let value = match &self.string_to_value {
|
|
Some(f) => f(string),
|
|
// TODO: Check how Rust's parse function handles trailing garbage
|
|
None => string.parse().ok(),
|
|
};
|
|
|
|
match value {
|
|
Some(plain) => {
|
|
self.value = plain;
|
|
true
|
|
}
|
|
None => false,
|
|
}
|
|
}
|
|
|
|
fn plain_value(&self) -> Self::Plain {
|
|
self.value
|
|
}
|
|
|
|
fn set_plain_value(&mut self, plain: Self::Plain) {
|
|
self.value = plain;
|
|
if let Some(f) = &self.value_changed {
|
|
f(plain);
|
|
}
|
|
}
|
|
|
|
fn normalized_value(&self) -> f32 {
|
|
self.range.normalize(self.value)
|
|
}
|
|
|
|
fn set_normalized_value(&mut self, normalized: f32) {
|
|
self.set_plain_value(self.range.unnormalize(normalized));
|
|
}
|
|
|
|
fn normalized_value_to_string(&self, normalized: f32, include_unit: bool) -> String {
|
|
let value = self.range.unnormalize(normalized);
|
|
match (&self.value_to_string, include_unit) {
|
|
(Some(f), true) => format!("{}{}", f(value), self.unit),
|
|
(Some(f), false) => format!("{}", f(value)),
|
|
(None, true) => format!("{}{}", value, self.unit),
|
|
(None, false) => format!("{}", value),
|
|
}
|
|
}
|
|
|
|
fn string_to_normalized_value(&self, string: &str) -> Option<f32> {
|
|
let value = match &self.string_to_value {
|
|
Some(f) => f(string),
|
|
// TODO: Check how Rust's parse function handles trailing garbage
|
|
None => string.parse().ok(),
|
|
}?;
|
|
|
|
Some(self.range.normalize(value))
|
|
}
|
|
|
|
fn as_ptr(&self) -> internals::ParamPtr {
|
|
internals::ParamPtr::$ty(self as *const $ty as *mut $ty)
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
impl_plainparam!(FloatParam, f32);
|
|
impl_plainparam!(IntParam, i32);
|
|
|
|
impl Param for BoolParam {
|
|
type Plain = bool;
|
|
|
|
fn update_smoother(&mut self, _sample_rate: f32) {
|
|
// Can't really smooth a binary parameter now can you
|
|
}
|
|
|
|
fn set_from_string(&mut self, string: &str) -> bool {
|
|
let value = match &self.string_to_value {
|
|
Some(f) => f(string),
|
|
None => Some(string.eq_ignore_ascii_case("true") || string.eq_ignore_ascii_case("on")),
|
|
};
|
|
|
|
match value {
|
|
Some(plain) => {
|
|
self.value = plain;
|
|
true
|
|
}
|
|
None => false,
|
|
}
|
|
}
|
|
|
|
fn plain_value(&self) -> Self::Plain {
|
|
self.value
|
|
}
|
|
|
|
fn set_plain_value(&mut self, plain: Self::Plain) {
|
|
self.value = plain;
|
|
if let Some(f) = &self.value_changed {
|
|
f(plain);
|
|
}
|
|
}
|
|
|
|
fn normalized_value(&self) -> f32 {
|
|
if self.value {
|
|
1.0
|
|
} else {
|
|
0.0
|
|
}
|
|
}
|
|
|
|
fn set_normalized_value(&mut self, normalized: f32) {
|
|
self.set_plain_value(normalized > 0.5);
|
|
}
|
|
|
|
fn normalized_value_to_string(&self, normalized: f32, _include_unit: bool) -> String {
|
|
let value = normalized > 0.5;
|
|
match (value, &self.value_to_string) {
|
|
(v, Some(f)) => f(v),
|
|
(true, None) => String::from("On"),
|
|
(false, None) => String::from("Off"),
|
|
}
|
|
}
|
|
|
|
fn string_to_normalized_value(&self, string: &str) -> Option<f32> {
|
|
let value = match &self.string_to_value {
|
|
Some(f) => f(string),
|
|
None => Some(string.eq_ignore_ascii_case("true") || string.eq_ignore_ascii_case("on")),
|
|
}?;
|
|
|
|
Some(if value { 1.0 } else { 0.0 })
|
|
}
|
|
|
|
fn as_ptr(&self) -> internals::ParamPtr {
|
|
internals::ParamPtr::BoolParam(self as *const BoolParam as *mut BoolParam)
|
|
}
|
|
}
|
|
|
|
impl<T: Display + Copy> Display for PlainParam<T> {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
match &self.value_to_string {
|
|
Some(func) => write!(f, "{}{}", func(self.value), self.unit),
|
|
None => write!(f, "{}{}", self.value, self.unit),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Display for BoolParam {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
match (self.value, &self.value_to_string) {
|
|
(v, Some(func)) => write!(f, "{}", func(v)),
|
|
(true, None) => write!(f, "On"),
|
|
(false, None) => write!(f, "Off"),
|
|
}
|
|
}
|
|
}
|