Struct ScaleQuantizer 

pub struct ScaleQuantizer { /* private fields */ }

Scale Quantizer

Quantizes CV input to musical scale notes. Supports major, minor, pentatonic, and chromatic scales.

Implementations

impl ScaleQuantizer

pub fn new(_sample_rate: f64) -> Self

pub fn has_custom_scale(&self) -> bool

Whether a microtuning custom scale is currently active (Q146).

pub fn set_custom_scale(&mut self, cents: &[f64])

Available on crate feature alloc only.

Install a custom microtuning scale (Q146): cents are scale degrees within one octave, in cents (0.0 is the root). The list is sorted and reduced into [0, 1200) internally, so callers need not pre-sort. Passing an empty slice clears the override and restores the built-in 12-TET scales.

Non-real-time: allocates. Alloc-tier only.

pub fn clear_custom_scale(&mut self)

Available on crate feature alloc only.

Clear any custom microtuning scale, restoring the built-in 12-TET scales.

pub fn load_scala(&mut self, source: &str) -> Result<(), ScalaError>

Available on crate feature alloc only.

Load a Scala (.scl) file body as the custom microtuning scale (Q146).

On success the parsed scale’s octave-reduced degrees become the active scale (see set_custom_scale). On a malformed file the current scale is left unchanged and the parse error is returned.

Non-real-time: allocates. Alloc-tier only.

Trait Implementations

impl Default for ScaleQuantizer

fn default() -> Self

Returns the “default value” for a type.

impl GraphModule for ScaleQuantizer

fn serialize_state(&self) -> Option<Value>

Available on crate feature alloc only.

Persist the microtuning table (Q146) so a loaded Scala/custom scale survives to_def -> from_def. It is not a scalar ModuleIntrospection parameter, so it travels through the reserved ModuleDef.state channel instead of parameters. A plain (12-TET) quantizer has no custom cents and returns None, keeping state null.

fn deserialize_state(&mut self, state: &Value) -> Result<(), String>

Available on crate feature alloc only.

Restore the microtuning table saved by serialize_state. An absent/empty table is a no-op (stays 12-TET); malformed cents surface a descriptive error to the loader.

fn port_spec(&self) -> &PortSpec

Returns the module’s port specification

fn tick(&mut self, inputs: &PortValues, outputs: &mut PortValues)

Process one sample given port values

fn reset(&mut self)

Reset internal state

fn set_sample_rate(&mut self, _: f64)

Set sample rate

fn type_id(&self) -> &'static str

Get module type identifier for serialization

fn process_block( &mut self, inputs: &BlockPortValues, outputs: &mut BlockPortValues, frames: usize, )

Process a block of samples (optional optimization).

fn breaks_feedback_cycle(&self) -> bool

Whether this module breaks a feedback cycle in the patch graph.

fn params(&self) -> &[ParamDef]

Get parameter definitions for UI binding.

fn get_param(&self, _id: ParamId) -> Option<f64>

Get a parameter value.

fn set_param(&mut self, _id: ParamId, _value: f64)

Set a parameter value.

fn introspect(&self) -> Option<&dyn ModuleIntrospection>

Available on crate feature alloc only.

Downcast this module to its ModuleIntrospection view, if it exposes one.

fn introspect_mut(&mut self) -> Option<&mut dyn ModuleIntrospection>

Available on crate feature alloc only.

Mutable companion to introspect, used to set internal parameters.

impl ModuleIntrospection for ScaleQuantizer

Available on crate feature alloc only.

fn param_infos(&self) -> Vec<ParamInfo>

Get all parameter descriptors for this module

fn get_param_info(&self, id: &str) -> Option<ParamInfo>

Get a specific parameter by its ID

fn set_param_by_id(&mut self, _id: &str, _value: f64) -> bool

Set a parameter value by its ID