Struct Transcriber 

pub struct Transcriber { /* private fields */ }

The transcription model with its inference engine, built once and used for every stem, and the f0 tracker of the notes step.

Implementations

impl Transcriber

pub fn new() -> Result<Self, TranscribeError>

Loads the bundled model on the pure-Rust engine and spreads the windows over every core.

Errors

Returns a TranscribeError when the engine cannot load the model.

pub fn with_threads(self, threads: NonZeroUsize) -> Self

Spreads the windows over this many threads. The thread count never changes the result.

pub fn with_backend(backend: impl Backend + 'static) -> Self

Runs the model on another engine, such as one that counts its calls in a test.

pub fn with_tracker(self, tracker: Tracker) -> Self

Runs another f0 tracker in the notes step, such as one that skips the pYIN track in a test whose subject is not the track.

pub fn run( &self, mono: &[f64], rate: SampleRate, ) -> Result<ModelRun, TranscribeError>

Runs the model once on a mono signal at any rate. The signal is resampled to MODEL_RATE and cast to f32, with its gain untouched: the model output depends on the absolute level.

Errors

Returns a TranscribeError when resampling fails, a sample is not finite or the engine fails.

Trait Implementations

impl Debug for Transcriber

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

Formats the value using the given formatter.