Struct Voice 

pub struct Voice {
    pub kind: OscKind,
    pub freq: Option<FreqSpec>,
    pub sweep: Option<f32>,
    pub filter: Option<FilterSpec>,
    pub attack: f32,
    pub decay: f32,
    pub sustain: f32,
    pub hold: f32,
    pub release: f32,
    pub gain: f32,
    pub seed: Option<u32>,
}

One instrument: an oscillator or a noise source, an optional filter, and an ADSR envelope (attack/decay/sustain/hold/release — see dsp::Adsr’s doc for why hold stands in for a note-off this score model never sends). Every field but type and decay has a drum-machine-flavoured default, so the issue’s own two-voice example ("kick": {"type":"sine","freq":[150,42],"sweep":0.14,"decay":0.38}) needs nothing else.

Fields

kind: OscKind

freq: Option<FreqSpec>

Required for every type but noise; ignored for noise. Falls back to 440Hz if omitted on a tonal voice rather than erroring — consistent with this module’s general posture (see dsp::BiquadCoeffs::design’s doc) of making an underspecified voice audible rather than rejecting it.

sweep: Option<f32>

Seconds the freq sweep takes to go from its first to its second value. Ignored unless freq is FreqSpec::Sweep.

filter: Option<FilterSpec>

attack: f32

decay: f32

sustain: f32

hold: f32

release: f32

gain: f32

seed: Option<u32>

Seeds this voice’s dsp::Xorshift32 noise source. Two noise voices with no explicit seed share the same fixed default and so sound identical to each other — a minor aesthetic simplification documented here rather than hidden; give each its own seed to tell them apart.

Implementations

impl Voice

pub fn render_grain(&self, sample_rate: u32) -> Vec<f32>

Trait Implementations

impl Clone for Voice

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Voice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Voice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Voice

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for Voice

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.