Struct sampara::signal::Phase

pub struct Phase<D, const N: usize> where
    D: Delta<N>,  { /* fields omitted */ }

A Signal that wraps a Delta and accumulates it in an automated way, wrapping it to the interval [0.0, 1.0) as needed.

use sampara::{signal, Signal};

fn main() {
    let mut phase = signal::phase_hz(44100.0, 440.0);

    assert_eq!(phase.next(), Some(0.009977324263038548));
    assert_eq!(phase.next(), Some(0.019954648526077097));
    assert_eq!(phase.next(), Some(0.029931972789115645));

    // [`Phase`] keeps track of the accumutated steps, and resets back to
    // 0.0 if it exceeds 1.0.
    let mut phase = signal::phase_hz(1.1, 0.5);
    assert_eq!(phase.next(), Some(0.45454545454545453));
    assert_eq!(phase.next(), Some(0.9090909090909091));
    assert_eq!(phase.next(), Some(0.36363636363636354));
}

Trait Implementations

impl<D, const N: usize> Signal<N> for Phase<D, N> where
    D: Delta<N>, 

type Frame = D::Delta

The Frame type returned by this Signal.

fn next(&mut self) -> Option<Self::Frame>

Advances Self and returns the next Frame, or None if there are no more to yield.

fn sig_next(&mut self) -> Self::Frame

Similar to [next], but will always yield a Frame. Yields Frame::EQUILIBRIUM if there are no more actual Frames to yield.

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, 

Borrows this Signal rather than consuming it.

fn map<F, M, const NF: usize>(self, func: M) -> Map<Self, F, M, N, NF> where
    Self: Sized,
    F: Frame<NF>,
    M: FnMut(Self::Frame) -> F, 

Creates a new Signal that applies a function to each Frame of Self.

fn zip_map<O, F, M, const NO: usize, const NF: usize>(
    self,
    other: O,
    func: M
) -> ZipMap<Self, O, F, M, N, NO, NF> where
    Self: Sized,
    O: Signal<NO>,
    F: Frame<NF>,
    M: FnMut(Self::Frame, O::Frame) -> F, 

Creates a new Signal that applies a function to each pair of Frames in Self and another Signal.

fn add_signal<B>(self, other: B) -> AddSignal<Self, B, N> where
    Self: Sized,
    B: Signal<N>,
    Self::Frame: Frame<N, Signed = <B::Frame as Frame<N>>::Signed>, 

Creates a new Signal that yields the sum of pairs of Frames yielded by Self and another Signal in lockstep.

fn mul_signal<B>(self, other: B) -> MulSignal<Self, B, N> where
    Self: Sized,
    B: Signal<N>,
    Self::Frame: Frame<N, Float = <B::Frame as Frame<N>>::Float>, 

Creates a new Signal that yields the product of pairs of Frames yielded by Self and another Signal in lockstep.

fn add_frame<F>(self, frame: F) -> AddFrame<Self, F, N> where
    Self: Sized,
    Self::Frame: Frame<N, Signed = F>,
    F: Frame<N>, 

Creates a new Signal that yields each Frame of a Signal summed with a constant Frame.

fn mul_frame<F>(self, frame: F) -> MulFrame<Self, F, N> where
    Self: Sized,
    Self::Frame: Frame<N, Float = F>,
    F: Frame<N>, 

Creates a new Signal that yields each Frame of a Signal multiplied with a constant Frame.

fn add_amp<X>(self, amp: X) -> AddAmp<Self, X, N> where
    Self: Sized,
    Self::Frame: Frame<N>,
    <Self::Frame as Frame<N>>::Sample: Sample<Signed = X>,
    X: Sample, 

Creates a new Signal that yields each Frame of a Signal with each channel summed with a constant Sample.

fn mul_amp<X>(self, amp: X) -> MulAmp<Self, X, N> where
    Self: Sized,
    Self::Frame: Frame<N>,
    <Self::Frame as Frame<N>>::Sample: Sample<Float = X>,
    X: Sample, 

Creates a new Signal that yields each Frame of a Signal with each channel multiplied with a constant Sample.

fn delay(self, n_frames: usize) -> Delay<Self, N> where
    Self: Sized, 

Delays Self by a given number of frames. The delay is performed by yielding Frame::EQUILIBRIUM that number of times before continuing to yield frames from Self.

fn inspect<F>(self, func: F) -> Inspect<Self, F, N> where
    Self: Sized,
    F: FnMut(&Self::Frame), 

Calls an inspection function on each Frame yielded by this Signal, and then passes the Frame through.

fn take(self, n: usize) -> Take<Self, N> where
    Self: Sized, 

Returns a new Signal that yields only the first N Frames of Self.

fn into_iter(self) -> IntoIter<Self, N> where
    Self: Sized, 

Converts this Signal into an Iterator yielding Frames.