Struct screech::core::Primary

pub struct Primary<const BUFFER_SIZE: usize> {
    pub sample_rate: usize,
    // some fields omitted
}

Main helper struct to render and manage relations between crate::traits::Source types. Also implements crate::traits::Tracker

use screech::traits::{FromPoints, Source};
use screech::core::{Primary, Stream, DynamicTracker};
use screech::basic::{Clip, Track};

const BUFFER_SIZE: usize = 4;
let sample_rate = 48_000;

let mut primary = Primary::<BUFFER_SIZE>::new(sample_rate);

let mut clip_a = Clip::new(&mut primary, Stream::from_points(vec![0.1, 0.2, 0.2, 0.1]));
let mut clip_b = Clip::new(&mut primary, Stream::from_points(vec![0.0, 0.0, 0.1, 0.3]));
let mut track = Track::new(&mut primary);

track.add_input(clip_a.output);
track.add_input(clip_b.output);
primary.add_monitor(track.output);

assert_eq!(
    primary.sample(vec![&mut clip_a, &mut clip_b, &mut track]).unwrap(),
    &[0.1, 0.1, 0.2, 0.2],
);

assert_eq!(
    primary.sample(vec![&mut clip_a, &mut clip_b, &mut track]).unwrap(),
    &[0.3, 0.3, 0.4, 0.4],
);

assert_eq!(
    primary.sample(vec![&mut clip_a, &mut clip_b, &mut track]).unwrap(),
    &[0.0, 0.0, 0.0, 0.0],
);

Fields

sample_rate: usize

sample rate field used for sampling

Implementations

impl<const BUFFER_SIZE: usize> Primary<BUFFER_SIZE>

pub fn new(sample_rate: usize) -> Self

Create new Primary with a default tracker

pub fn with_tracker(tracker: Box<dyn Tracker>, sample_rate: usize) -> Self

Create a new Primary with a supplied tracker

use screech::core::{Primary, BasicTracker};

let tracker = BasicTracker::<256, 8>::new();
let primary = Primary::<128>::with_tracker(Box::new(tracker), 48_000);

pub fn add_monitor(&mut self, source: ExternalSignal) -> &mut Self

add source to the final output

pub fn remove_monitor(&mut self, source: &ExternalSignal) -> &mut Self

remove source from final output

pub fn output_mono(&mut self) -> &mut Self

Output a mono signal

pub fn output_stereo(&mut self) -> &mut Self

Output an interleaved stereo signal

pub fn sample(
    &mut self,
    unmapped_sources: Vec<&mut dyn Source>
) -> Result<&[Point; BUFFER_SIZE], Error>

Sample multiple sources based on their dependencies into a single output vec

Trait Implementations

impl<const A: usize> Tracker for Primary<A>

fn create_source_id(&mut self) -> usize

Return a unique ID

fn clear_source(&mut self, external_signal: usize)

clear source id for reuse

fn get_signal(&self, external_signal: &ExternalSignal) -> Option<&Signal>

get signal for id

fn set_signal(&mut self, external_signal: &ExternalSignal, signal: Signal)

set signal for id