Struct Node

pub struct Node<F> { /* private fields */ }

An audio node: a source, a sink, a filter, an effect, etc.

Implementations

impl<F> Node<F>

pub fn add_sine(&self, f: Freq, phase: f32) -> Node<Sine>

Add sine wave oscillator source (∿).

Examples found in repository

examples/audio_sine/main.rs (line 7)

extern fn boot() {
    audio::OUT.add_sine(audio::Freq::A4, 0.);
}

examples/audio_chord/main.rs (line 7)

extern fn boot() {
    audio::OUT.add_sine(audio::Freq::C4, 0.);
    audio::OUT.add_sine(audio::Freq::E4, 0.);
    audio::OUT.add_sine(audio::Freq::G4, 0.);
}

examples/audio_modulator/main.rs (line 14)

extern fn boot() {
    let gain = audio::OUT.add_gain(0.);
    gain.modulate(audio::LinearModulator {
        start: 0.,
        end: 1.,
        start_at: audio::Time::ZERO,
        end_at: audio::Time::seconds(2),
    });
    gain.add_sine(audio::Freq::A4, 0.);
}

pub fn add_square(&self, f: Freq, phase: f32) -> Node<Square>

Add square wave oscillator source (⎍).

Examples found in repository

examples/audio_square/main.rs (line 7)

extern fn boot() {
    audio::OUT.add_square(audio::Freq::A4, 0.);
}

pub fn add_sawtooth(&self, f: Freq, phase: f32) -> Node<Sawtooth>

Add sawtooth wave oscillator source (╱│).

Examples found in repository

examples/audio_sawtooth/main.rs (line 7)

extern fn boot() {
    audio::OUT.add_sawtooth(audio::Freq::A4, 0.);
}

pub fn add_triangle(&self, f: Freq, phase: f32) -> Node<Triangle>

Add triangle wave oscillator source (╱╲).

Examples found in repository

examples/audio_triangle/main.rs (line 7)

extern fn boot() {
    audio::OUT.add_triangle(audio::Freq::A4, 0.);
}

pub fn add_noise(&self, seed: i32) -> Node<Noise>

Add white noise source (amplitude on each tick is random).

Examples found in repository

examples/audio_noise/main.rs (line 7)

extern fn boot() {
    audio::OUT.add_noise(0);
}

pub fn add_empty(&self) -> Node<Empty>

Add always stopped source.

pub fn add_zero(&self) -> Node<Zero>

Add silent source producing zeros.

pub fn add_file(&self, path: &str) -> Node<File>

Play an audio file from ROM.

pub fn add_mix(&self) -> Node<Mix>

Add node simply mixing all inputs.

pub fn add_all_for_one(&self) -> Node<AllForOne>

Add mixer node that stops if any of the sources stops.

pub fn add_gain(&self, lvl: f32) -> Node<Gain>

Add gain control node.

Examples found in repository

examples/audio_modulator/main.rs (line 7)

extern fn boot() {
    let gain = audio::OUT.add_gain(0.);
    gain.modulate(audio::LinearModulator {
        start: 0.,
        end: 1.,
        start_at: audio::Time::ZERO,
        end_at: audio::Time::seconds(2),
    });
    gain.add_sine(audio::Freq::A4, 0.);
}

pub fn add_loop(&self) -> Node<Loop>

Add a loop node that resets the input if it stops.

pub fn add_concat(&self) -> Node<Concat>

Add a node that plays the inputs one after the other, in the order as they added.

pub fn add_pan(&self, lvl: f32) -> Node<Pan>

Add node panning the audio to the left (0.), right (1.), or something in between.

pub fn add_mute(&self) -> Node<Mute>

Add node that can be muted using modulation.

pub fn add_pause(&self) -> Node<Pause>

Add node that can be paused using modulation.

pub fn add_track_position(&self) -> Node<TrackPosition>

Add node tracking the elapsed playback time.

pub fn add_low_pass(&self, freq: f32, q: f32) -> Node<LowPass>

Add lowpass filter node.

pub fn add_high_pass(&self, freq: f32, q: f32) -> Node<HighPass>

Add highpass filter node.

pub fn add_take_left(&self) -> Node<TakeLeft>

Add node converting stereo to mono by taking the left channel.

pub fn add_take_right(&self) -> Node<TakeRight>

Add node converting stereo to mono by taking the right channel.

pub fn add_swap(&self) -> Node<Swap>

Add node swapping left and right channels of the stereo input.

pub fn add_clip(&self, low: f32, high: f32) -> Node<Clip>

Add node clamping the input amplitude. Can be used for hard distortion.

pub fn reset(&self)

Reset the node state to how it was when it was just added.

pub fn reset_all(&self)

Reset the node and all child nodes to the state to how it was when they were just added.

pub fn clear(&self)

Remove all child nodes.

After it is called, you should make sure to discard all references to the old child nodes.

impl Node<Sine>

pub fn modulate<M: Modulator>(&self, m: M)

Modulate oscillation frequency.

impl Node<Square>

pub fn modulate<M: Modulator>(&self, m: M)

Modulate oscillation frequency.

impl Node<Sawtooth>

pub fn modulate<M: Modulator>(&self, m: M)

Modulate oscillation frequency.

impl Node<Triangle>

pub fn modulate<M: Modulator>(&self, m: M)

Modulate oscillation frequency.

impl Node<Gain>

pub fn modulate<M: Modulator>(&self, m: M)

Modulate the gain level.

Examples found in repository

examples/audio_modulator/main.rs (lines 8-13)

extern fn boot() {
    let gain = audio::OUT.add_gain(0.);
    gain.modulate(audio::LinearModulator {
        start: 0.,
        end: 1.,
        start_at: audio::Time::ZERO,
        end_at: audio::Time::seconds(2),
    });
    gain.add_sine(audio::Freq::A4, 0.);
}

impl Node<Pan>

pub fn modulate<M: Modulator>(&self, m: M)

Modulate the pan value (from 0. to 1.: 0. is only left, 1. is only right).

impl Node<Mute>

pub fn modulate<M: Modulator>(&self, m: M)

Modulate the muted state.

Below 0.5 is muted, above is unmuted.

impl Node<Pause>

pub fn modulate<M: Modulator>(&self, m: M)

Modulate the paused state.

Below 0.5 is paused, above is playing.

impl Node<LowPass>

pub fn modulate_freq<M: Modulator>(&self, m: M)

Modulate the cut-off frequency.

impl Node<HighPass>

pub fn modulate_freq<M: Modulator>(&self, m: M)

Modulate the cut-off frequency.

impl Node<Clip>

pub fn modulate_both<M: Modulator>(&self, m: M)

Modulate the low cut amplitude and adjust the high amplitude to keep the gap.

In other words, the difference between low and high cut points will stay the same.

pub fn modulate_low<M: Modulator>(&self, m: M)

Modulate the low cut amplitude.

pub fn modulate_high<M: Modulator>(&self, m: M)

Modulate the high cut amplitude.