Rework Params trait API with Arc instead of Pin

This is a breaking change requiring a small change to plugin
implementations.

The reason why `Pin<&dyn Params>` was used was more as a hint to
indicate that the object must last for the plugin's lifetime, but `Pin`
doesn't enforce that. It also makes the APIs a lot more awkward.
Requiring the use of `Arc` fixes the following problems:

- When storing the params object in the wrapper, the `ParamPtr`s are
  guaranteed to be stable.
- This makes it possible to access the `Params` object without acquiring
  a lock on the plugin, this is very important for implementing
  plugin-side preset management.
- It enforces immutability on the `Params` object.
- And of course the API is much nicer without a bunch of unsafe code to
  work around Pin's limitations.
This commit is contained in:
Robbert van der Helm
2022-04-07 15:31:46 +02:00
parent 7cc05fce9a
commit 083885a40c
24 changed files with 105 additions and 115 deletions

View File

@@ -1,11 +1,11 @@
use nih_plug::prelude::*;
use std::f32::consts;
use std::pin::Pin;
use std::sync::Arc;
/// A test tone generator that can either generate a sine wave based on the plugin's parameters or
/// based on the current MIDI input.
struct Sine {
params: Pin<Box<SineParams>>,
params: Arc<SineParams>,
sample_rate: f32,
/// The current phase of the sine wave, always kept between in `[0, 1]`.
@@ -35,7 +35,7 @@ struct SineParams {
impl Default for Sine {
fn default() -> Self {
Self {
params: Box::pin(SineParams::default()),
params: Arc::new(SineParams::default()),
sample_rate: 1.0,
phase: 0.0,
@@ -106,8 +106,8 @@ impl Plugin for Sine {
const ACCEPTS_MIDI: bool = true;
const SAMPLE_ACCURATE_AUTOMATION: bool = true;
fn params(&self) -> Pin<&dyn Params> {
self.params.as_ref()
fn params(&self) -> Arc<dyn Params> {
self.params.clone()
}
fn accepts_bus_config(&self, config: &BusConfig) -> bool {