Skip to main content

PcmRenderer

Struct PcmRenderer 

Source
pub struct PcmRenderer {
    pub sample_rate: u32,
    pub channels: u8,
}
Expand description

A renderer that synthesizes tones into interleaved PCM f32 samples and encodes them as WAV.

Fields§

§sample_rate: u32

Output sample rate, in hertz.

§channels: u8

Output channel count (1 for mono, 2 for stereo).

Implementations§

Source§

impl PcmRenderer

Source

pub fn new(options: RendererOptions) -> Result<Self, SoundRenderError>

Builds a renderer from validated RendererOptions.

Source

pub fn render_tone(&self, tone: &Tone) -> Vec<f32>

Renders a single tone to interleaved PCM samples, centered in the stereo field.

§Examples
use std::time::Duration;
use sim_lib_sound_core::{Frequency, Tone};
use sim_lib_sound_render::{PcmRenderer, RendererOptions};

let renderer = PcmRenderer::new(RendererOptions::new(8_000, 1).unwrap()).unwrap();
let tone = Tone::sine(Frequency::new(440.0).unwrap(), Duration::from_millis(10));
assert_eq!(renderer.render_tone(&tone).len(), 80);
Source

pub fn render_mix(&self, tones: &[ScheduledTone]) -> Vec<f32>

Renders and sums a set of scheduled tones into a single mixed PCM buffer, honoring each tone’s start time and pan.

Source

pub fn write_wav<W: Write>( &self, samples: &[f32], writer: W, ) -> Result<W, SoundRenderError>

Encodes samples as a 16-bit PCM WAV stream to writer, returning the writer on success.

Trait Implementations§

Source§

impl Clone for PcmRenderer

Source§

fn clone(&self) -> PcmRenderer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PcmRenderer

Source§

impl Debug for PcmRenderer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PcmRenderer

Source§

impl PartialEq for PcmRenderer

Source§

fn eq(&self, other: &PcmRenderer) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PcmRenderer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.