Struct Sample 

pub struct Sample { /* private fields */ }

A sample resident in SPU RAM.

Implementations

impl Sample

pub const fn resident(addr: SpuAddr, rate_hz: u32, blocks: u32) -> Self

Describe a sample already resident in SPU RAM, for banks uploaded by something other than Bank – VoXide streams its straight off the disc into the SPU, never holding it in main RAM.

blocks is the sample’s ADPCM block count, or 0 when the bank format does not record one. Length is what a cutoff is computed from, so a sample without it gets no cutoff and falls back to the envelope: see Sample::ticks_at.

pub const fn addr(&self) -> SpuAddr

Where the sample starts in SPU RAM.

pub const fn sample_rate_hz(&self) -> u32

The rate the sample was cooked at.

pub const fn len_samples(&self) -> u32

Decoded length in samples.

pub const fn ticks_at(&self, ticks_hz: u32) -> Option<u32>

How long this sample runs, in ticks of a ticks_hz clock, played at its own rate, with [TAIL_TICKS] of margin. None when the block count is unknown, which means no cutoff can be computed and the envelope has to finish the sound instead.

Pitch-shifted playback stretches this: see OneShot::with_pitch.

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.

impl PartialEq for Sample

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Sample

impl Eq for Sample

impl StructuralPartialEq for Sample