Enum Model 

#[non_exhaustive]
pub enum Model {
    WaveNet(Box<WaveNet>),
    Lstm(Lstm),
    Slimmable(Slimmable),
}

A runnable NAM model of any supported architecture.

Build with Model::from_nam; then call Model::process_buffer on the audio thread. #[non_exhaustive] so future architectures don’t break downstream matches.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

WaveNet(Box<WaveNet>)

A WaveNet model. Boxed so the enum’s variants are similarly sized (a WaveNet carries many pre-allocated scratch buffers); the indirection is one pointer hop off the build path, not the per-sample hot loop.

Lstm(Lstm)

An LSTM model.

Slimmable(Slimmable)

A width-selectable container of submodels.

Implementations

impl Model

pub fn from_nam(model: &NamModel) -> Result<Self, Error>

Build the runtime matching model.architecture. All allocation happens here.

pub fn process_buffer(&mut self, io: &mut [f32])

Process a buffer of mono samples in place. Allocation-free.

pub fn process_sample(&mut self, x: f32) -> f32

Process a single mono sample. Allocation-free.

pub fn reset(&mut self)

Reset all internal state to the model’s initial conditions.

pub fn receptive_field(&self) -> usize

The model’s processing latency in samples.

For WaveNet this is the receptive field: the first this-many output samples of a fresh (or freshly reset) model are a startup transient computed against zero history. A host can report it as plugin latency and/or discard that many leading samples. LSTM has no warmup, so this is 0.

pub fn as_slimmable(&self) -> Option<&Slimmable>

The width-selectable container, if this model is one. Use it to drive the slim dial (Slimmable::select / Slimmable::set_slim_size); plain WaveNet/LSTM models return None.

pub fn as_slimmable_mut(&mut self) -> Option<&mut Slimmable>

Mutable variant of Model::as_slimmable, for setting the active submodel.

Trait Implementations

impl Debug for Model

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.