dowdiness/moondsp/voice

README
U
Adsr
U
ArithSym
U
AudioBuffer
U
Biquad
U
BiquadMode
U
BoundVoicePool
U
BoundVoicePoolError
U
ChannelSpec
U
Clip
U
CompiledDsp
U
CompiledDspHotSwap
U
CompiledDspTopologyController
U
CompiledStereoDsp
U
CompiledStereoDspHotSwap
U
CompiledStereoDspTopologyController
U
CompiledTemplate
U
ControlBinding
U
ControlBindingBuilder
U
ControlBindingError
U
ControlBindingMap
U
DelayLine
U
DelaySym
U
DemoSource
U
DspContext
U
DspNode
U
DspNodeKind
U
DspSym
U
EnvStage
U
FilterSym
U
Gain
U
GraphBuilder
U
GraphCompileError
U
GraphControl
U
GraphControlError
U
GraphControlKind
U
GraphControllable
U
GraphDebuggable
U
GraphIndexMap
U
GraphNodeId
U
GraphParamSlot
U
GraphTemplateDoc
U
GraphTemplateDocError
U
GraphTopologyEdit
U
GraphTopologyInputSlot
U
GraphTopologyQueueError
U
GraphValidationError
U
HotSwapQueueError
U
Mix
U
Mono
U
Noise
U
NoteGate
U
Oscillator
U
Pan
U
ParamSmoother
U
Revision
U
StableIdError
U
Stereo
U
StereoDelaySym
U
StereoFilterSym
U
StereoReverb
U
StereoSym
U
VoiceControlError
U
VoiceHandle
U
VoicePool
U
VoicePoolError
U
VoiceState
U
Waveform
V
effective_sample_count
V
exit_deliverable
V
is_finite
V
is_finite_positive
V
lin_map
V
max_feedback_amount
V
mono_shape
V
node_accepts_slot
V
pan_left_gain
V
pan_right_gain
V
range
V
replay
V
sanitize_buffer
V
stereo_shape

dowdiness/moondsp/voice does not have a README file

BoundVoicePool

pub struct BoundVoicePool {
  // private fields
}

BoundVoicePool::active_voice_count

source

fn BoundVoicePool::active_voice_count(self : BoundVoicePool) -> Int

BoundVoicePool::apply_voice_control_result

source

fn BoundVoicePool::apply_voice_control_result(self : BoundVoicePool, handle : VoiceHandle, control : @dowdiness/moondsp/graph.GraphControl
GraphControl) -> Result[Unit, VoiceControlError]

Apply one validated graph control to an already-sounding voice.

BoundVoicePool::apply_voice_controls_result

source

fn BoundVoicePool::apply_voice_controls_result(self : BoundVoicePool, handle : VoiceHandle, controls : Array[@dowdiness/moondsp/graph.GraphControl
GraphControl]) -> Result[Unit, VoiceControlError]

Apply a graph-control batch transactionally to an already-sounding voice.

BoundVoicePool::apply_voice_param_bool

source

fn BoundVoicePool::apply_voice_param_bool(self : BoundVoicePool, handle : VoiceHandle, node_index : Int, slot : @dowdiness/moondsp/graph.GraphParamSlot
GraphParamSlot, value : Double) -> Bool

Allocation-conscious live parameter update predicate for host callback paths.

BoundVoicePool::kill

source

#deprecated("Use BoundVoicePool::kill_result(handle) to observe VoiceControlError")
fn BoundVoicePool::kill(self : BoundVoicePool, handle : VoiceHandle) -> Bool

Deprecated compatibility wrapper. Use kill_result to observe stale or invalid handles as VoiceControlError values.

BoundVoicePool::kill_all

source

fn BoundVoicePool::kill_all(self : BoundVoicePool) -> Unit

BoundVoicePool::kill_result

source

fn BoundVoicePool::kill_result(self : BoundVoicePool, handle : VoiceHandle) -> Result[Unit, VoiceControlError]

BoundVoicePool::last_sanitized_count

source

fn BoundVoicePool::last_sanitized_count(self : BoundVoicePool) -> Int

BoundVoicePool::new

source

fn BoundVoicePool::new(compiled_template : @dowdiness/moondsp/graph.CompiledTemplate
CompiledTemplate, context : @dowdiness/moondsp/dsp.DspContext
DspContext, bindings : @dowdiness/moondsp/graph.ControlBindingBuilder
ControlBindingBuilder, max_voices? : Int) -> Result[BoundVoicePool, BoundVoicePoolError]

BoundVoicePool::note_gate

source

fn BoundVoicePool::note_gate(self : BoundVoicePool, controls : Map[String, Double]) -> NoteGate

Resolve gate timing without starting a voice or changing the input controls. Attack/release controls use graph milliseconds; hold uses seconds. Instruments without all four envelope bindings retain their event gate.

BoundVoicePool::note_off

source

#deprecated("Use BoundVoicePool::note_off_result(handle) to observe VoiceControlError")
fn BoundVoicePool::note_off(self : BoundVoicePool, handle : VoiceHandle) -> Bool

Deprecated compatibility wrapper. Use note_off_result to observe stale or invalid handles as VoiceControlError values.

BoundVoicePool::note_off_all

source

fn BoundVoicePool::note_off_all(self : BoundVoicePool) -> Unit

BoundVoicePool::note_off_bool

source

fn BoundVoicePool::note_off_bool(self : BoundVoicePool, handle : VoiceHandle) -> Bool

Allocation-conscious note-off predicate for host callback paths.

BoundVoicePool::note_off_result

source

fn BoundVoicePool::note_off_result(self : BoundVoicePool, handle : VoiceHandle) -> Result[Unit, VoiceControlError]

BoundVoicePool::note_on_controls

source

fn BoundVoicePool::note_on_controls(self : BoundVoicePool, controls : Map[String, Double]) -> VoiceHandle?

BoundVoicePool::note_on_graph_controls

source

fn BoundVoicePool::note_on_graph_controls(self : BoundVoicePool, controls : Array[@dowdiness/moondsp/graph.GraphControl
GraphControl]) -> VoiceHandle?

Trigger a voice with an already-materialized graph-control batch. This bypasses string-key control-map resolution while preserving the same transactional semantics as VoicePool::note_on.

BoundVoicePool::note_on_prevalidated_params4_id

source

fn BoundVoicePool::note_on_prevalidated_params4_id(self : BoundVoicePool, node0 : Int, slot0 : @dowdiness/moondsp/graph.GraphParamSlot
GraphParamSlot, value0 : Double, node1 : Int, slot1 : @dowdiness/moondsp/graph.GraphParamSlot
GraphParamSlot, value1 : Double, node2 : Int, slot2 : @dowdiness/moondsp/graph.GraphParamSlot
GraphParamSlot, value2 : Double, node3 : Int, slot3 : @dowdiness/moondsp/graph.GraphParamSlot
GraphParamSlot, value3 : Double, pan : Double) -> Int64

Trigger a voice from four fixed, prevalidated parameter updates and set its pan before it becomes visible to callers. This is for host integrations that validate a stable template outside the audio callback and need a non-allocating note-on path. Returns a negative id on rejection; dynamic graph-control callers should use note_on_graph_controls.

BoundVoicePool::process

source

fn BoundVoicePool::process(self : BoundVoicePool, context : @dowdiness/moondsp/dsp.DspContext
DspContext, left : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer, right : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer) -> Unit

BoundVoicePool::process_with_send

source

fn BoundVoicePool::process_with_send(self : BoundVoicePool, context : @dowdiness/moondsp/dsp.DspContext
DspContext, left : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer, right : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer, send_left : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer, send_right : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer) -> Unit

Render dry stereo and the pool's single post-pan stereo send in one pass.

BoundVoicePool::set_template

source

fn BoundVoicePool::set_template(self : BoundVoicePool, compiled_template : @dowdiness/moondsp/graph.CompiledTemplate
CompiledTemplate, bindings : @dowdiness/moondsp/graph.ControlBindingBuilder
ControlBindingBuilder) -> Result[Unit, BoundVoicePoolError]

BoundVoicePool::set_voice_pan

source

#deprecated("Use BoundVoicePool::set_voice_pan_result(handle, pan) to observe VoiceControlError")
fn BoundVoicePool::set_voice_pan(self : BoundVoicePool, handle : VoiceHandle, pan : Double) -> Bool

Deprecated compatibility wrapper. Use set_voice_pan_result to observe stale or invalid handles as VoiceControlError values.

BoundVoicePool::set_voice_pan_bool

source

fn BoundVoicePool::set_voice_pan_bool(self : BoundVoicePool, handle : VoiceHandle, pan : Double) -> Bool

Allocation-conscious pan update predicate for host callback paths.

BoundVoicePool::set_voice_pan_result

source

fn BoundVoicePool::set_voice_pan_result(self : BoundVoicePool, handle : VoiceHandle, pan : Double) -> Result[Unit, VoiceControlError]

BoundVoicePool::set_voice_send_result

source

fn BoundVoicePool::set_voice_send_result(self : BoundVoicePool, handle : VoiceHandle, gain : Double) -> Result[Unit, VoiceControlError]

Set this voice's gain into the pool's single stereo send output.

BoundVoicePool::validate_voice_controls_result

source

fn BoundVoicePool::validate_voice_controls_result(self : BoundVoicePool, handle : VoiceHandle, controls : Array[@dowdiness/moondsp/graph.GraphControl
GraphControl]) -> Result[Unit, VoiceControlError]

Validate a live control batch against an active voice without mutating it.

BoundVoicePool::voice_state

source

fn BoundVoicePool::voice_state(self : BoundVoicePool, handle : VoiceHandle) -> VoiceState

BoundVoicePoolError

source

pub(all) enum BoundVoicePoolError {
  InvalidMaxVoices
  OrphanAdsr
  CompileRejected
  Binding(@dowdiness/moondsp/graph.ControlBindingError
ControlBindingError)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

impl Show for BoundVoicePoolError

BoundVoicePoolError::from_voice_pool

source

fn BoundVoicePoolError::from_voice_pool(e : VoicePoolError) -> BoundVoicePoolError

Lift a VoicePoolError to a BoundVoicePoolError. Used by BoundVoicePool's constructors after delegating to validate_voice_template (which now returns VoicePoolError after the boundary-type migration per ADR-0010).

NoteGate

source

pub(all) enum NoteGate {
  EventEnd
  AfterSeconds(Double)
  InvalidDuration
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Gate timing selected by the instrument. Release continues after gate-off.

VoiceControlError

source

pub(all) enum VoiceControlError {
  InvalidVoiceHandle(VoiceHandle)
  Graph(@dowdiness/moondsp/graph.GraphControlError
GraphControlError)
} derive(@moonbitlang/core/debug.Debug
Debug)

impl Show for VoiceControlError

VoiceHandle

source

pub struct VoiceHandle {
  slot : Int
  generation : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Generation-tagged voice handle. WHY generation counter: slot indices are reused after voice stealing. Without a generation tag, a stale handle from a stolen note could accidentally gate_off or pan the wrong voice occupying that slot. Every note_on increments the slot's generation; all operations compare the handle's generation against the slot's current generation.

impl Show for VoiceHandle

VoiceHandle::from_parts

source

fn VoiceHandle::from_parts(slot~ : Int, generation~ : Int) -> VoiceHandle

Construct a handle from primitive parts for host-side fixed storage.

VoiceHandle::packed_generation

source

fn VoiceHandle::packed_generation(handle_id : Int64) -> Int

VoiceHandle::packed_slot

source

fn VoiceHandle::packed_slot(handle_id : Int64) -> Int

VoicePool

source

pub struct VoicePool {
  // private fields
}

VoicePool::active_voice_count

source

fn VoicePool::active_voice_count(self : VoicePool) -> Int

VoicePool::kill_all

source

fn VoicePool::kill_all(self : VoicePool) -> Unit

VoicePool::last_sanitized_count

source

fn VoicePool::last_sanitized_count(self : VoicePool) -> Int

Number of non-finite samples replaced with 0.0 during the most recent process() call, across both L and R output channels after mixdown.

VoicePool::new

source

fn VoicePool::new(compiled_template : @dowdiness/moondsp/graph.CompiledTemplate
CompiledTemplate, context : @dowdiness/moondsp/dsp.DspContext
DspContext, max_voices? : Int) -> Result[VoicePool, VoicePoolError]

WHY test_compile: validates the template structurally (reachable Output node, no invalid cycles, valid node indices) before accepting it. This is a correctness gate so that per-voice note_on compiles can assume the template is well-formed. The compiled result is discarded. WHY orphan-ADSR reject: VoicePool::note_on calls gate_on for every ADSR index in the template. If an ADSR is authored into the template but not wired to Output, optimize_graph eliminates it and gate_on would now return Err(OrphanNode). Rejecting at pool-construction time keeps the per-note gate_adsrs_at(...) loop infallible (it can .unwrap()) and surfaces the misconfiguration at the earliest observable point rather than at every note trigger. WHY adsr_authoring_indices snapshot: the pool's long-lived snapshot (used by note_on to gate ADSRs, and refreshed by set_template) stores only the indices needed for gating — not the full template — so the caller's CompiledTemplate can be freely discarded after VoicePool::new returns. optimize_graph does not mutate its input, so neither CompiledTemplate::analyze nor CompiledDsp::compile disturbs the caller's array.

VoicePool::note_off

source

#deprecated("Use VoicePool::note_off_result(handle) to observe VoiceControlError")
fn VoicePool::note_off(self : VoicePool, handle : VoiceHandle) -> Bool

Deprecated compatibility wrapper. Use note_off_result to observe stale or invalid handles as VoiceControlError values.

VoicePool::note_off_all

source

fn VoicePool::note_off_all(self : VoicePool) -> Unit

VoicePool::note_off_result

source

fn VoicePool::note_off_result(self : VoicePool, handle : VoiceHandle) -> Result[Unit, VoiceControlError]

VoicePool::note_on

source

fn VoicePool::note_on(self : VoicePool, params : Array[@dowdiness/moondsp/graph.GraphControl
GraphControl]) -> VoiceHandle?

VoicePool::process

source

fn VoicePool::process(self : VoicePool, context : @dowdiness/moondsp/dsp.DspContext
DspContext, left_output : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer, right_output : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer) -> Unit

VoicePool::process_with_send

source

fn VoicePool::process_with_send(self : VoicePool, context : @dowdiness/moondsp/dsp.DspContext
DspContext, left_output : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer, right_output : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer, send_left : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer, send_right : @dowdiness/moondsp/dsp.AudioBuffer
AudioBuffer) -> Unit

Render dry stereo and the pool's single post-pan stereo send in one pass.

VoicePool::set_template

source

fn VoicePool::set_template(self : VoicePool, compiled_template : @dowdiness/moondsp/graph.CompiledTemplate
CompiledTemplate) -> Result[Unit, VoicePoolError]

VoicePool::set_voice_pan

source

#deprecated("Use VoicePool::set_voice_pan_result(handle, pan) to observe VoiceControlError")
fn VoicePool::set_voice_pan(self : VoicePool, handle : VoiceHandle, pan : Double) -> Bool

Deprecated compatibility wrapper. Use set_voice_pan_result to observe stale or invalid handles as VoiceControlError values.

VoicePool::set_voice_pan_result

source

fn VoicePool::set_voice_pan_result(self : VoicePool, handle : VoiceHandle, pan : Double) -> Result[Unit, VoiceControlError]

VoicePool::set_voice_send_result

source

fn VoicePool::set_voice_send_result(self : VoicePool, handle : VoiceHandle, gain : Double) -> Result[Unit, VoiceControlError]

VoicePool::voice_state

source

fn VoicePool::voice_state(self : VoicePool, handle : VoiceHandle) -> VoiceState

VoicePoolError

source

pub(all) enum VoicePoolError {
  InvalidMaxVoices
  OrphanAdsr
  CompileRejected
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Failure modes for VoicePool construction and template replacement. Mirrors BoundVoicePoolError minus the Binding(...) variant (VoicePool has no bindings).

impl Show for VoicePoolError

VoiceState

source

pub enum VoiceState {
  Idle
  Active
  Releasing
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

impl Show for VoiceState

Source Files

Site source Report issue Packages Build queue Skills Statistics

#BoundVoicePool

#BoundVoicePool::active_voice_count

#BoundVoicePool::apply_voice_control_result

#BoundVoicePool::apply_voice_controls_result

#BoundVoicePool::apply_voice_param_bool

#BoundVoicePool::kill

#BoundVoicePool::kill_all

#BoundVoicePool::kill_result

#BoundVoicePool::last_sanitized_count

#BoundVoicePool::new

#BoundVoicePool::note_gate

#BoundVoicePool::note_off

#BoundVoicePool::note_off_all

#BoundVoicePool::note_off_bool

#BoundVoicePool::note_off_result

#BoundVoicePool::note_on_controls

#BoundVoicePool::note_on_graph_controls

#BoundVoicePool::note_on_prevalidated_params4_id

#BoundVoicePool::process

#BoundVoicePool::process_with_send

#BoundVoicePool::set_template

#BoundVoicePool::set_voice_pan

#BoundVoicePool::set_voice_pan_bool

#BoundVoicePool::set_voice_pan_result

#BoundVoicePool::set_voice_send_result

#BoundVoicePool::validate_voice_controls_result

#BoundVoicePool::voice_state

#BoundVoicePoolError

#BoundVoicePoolError::from_voice_pool

#NoteGate

#VoiceControlError

#VoiceHandle

#VoiceHandle::from_parts

#VoiceHandle::packed_generation

#VoiceHandle::packed_slot

#VoicePool

#VoicePool::active_voice_count

#VoicePool::kill_all

#VoicePool::last_sanitized_count

#VoicePool::new

#VoicePool::note_off

#VoicePool::note_off_all

#VoicePool::note_off_result

#VoicePool::note_on

#VoicePool::process

#VoicePool::process_with_send

#VoicePool::set_template

#VoicePool::set_voice_pan

#VoicePool::set_voice_pan_result

#VoicePool::set_voice_send_result

#VoicePool::voice_state

#VoicePoolError

#VoiceState

Source Files

BoundVoicePool

BoundVoicePool::active_voice_count

BoundVoicePool::apply_voice_control_result

BoundVoicePool::apply_voice_controls_result

BoundVoicePool::apply_voice_param_bool

BoundVoicePool::kill

BoundVoicePool::kill_all

BoundVoicePool::kill_result

BoundVoicePool::last_sanitized_count

BoundVoicePool::new

BoundVoicePool::note_gate

BoundVoicePool::note_off

BoundVoicePool::note_off_all

BoundVoicePool::note_off_bool

BoundVoicePool::note_off_result

BoundVoicePool::note_on_controls

BoundVoicePool::note_on_graph_controls

BoundVoicePool::note_on_prevalidated_params4_id

BoundVoicePool::process

BoundVoicePool::process_with_send

BoundVoicePool::set_template

BoundVoicePool::set_voice_pan

BoundVoicePool::set_voice_pan_bool

BoundVoicePool::set_voice_pan_result

BoundVoicePool::set_voice_send_result

BoundVoicePool::validate_voice_controls_result

BoundVoicePool::voice_state

BoundVoicePoolError

BoundVoicePoolError::from_voice_pool

NoteGate

VoiceControlError

VoiceHandle

VoiceHandle::from_parts

VoiceHandle::packed_generation

VoiceHandle::packed_slot

VoicePool

VoicePool::active_voice_count

VoicePool::kill_all

VoicePool::last_sanitized_count

VoicePool::new

VoicePool::note_off

VoicePool::note_off_all

VoicePool::note_off_result

VoicePool::note_on

VoicePool::process

VoicePool::process_with_send

VoicePool::set_template

VoicePool::set_voice_pan

VoicePool::set_voice_pan_result

VoicePool::set_voice_send_result

VoicePool::voice_state

VoicePoolError

VoiceState