Struct SampleCache 

pub struct SampleCache { /* private fields */ }

A sample cache for efficient single-sample access.

This is a lightweight helper that manages sample and channel output caching. Use it when you need to add caching to a player without wrapping it entirely.

Example

use ym2149_common::SampleCache;

struct MyPlayer {
    inner: SomePlayer,
    cache: SampleCache,
}

impl MyPlayer {
    fn generate_sample(&mut self) -> f32 {
        if self.cache.needs_refill() {
            // Fill the cache
            self.inner.generate_samples_into(self.cache.sample_buffer_mut());
            let outputs = self.inner.get_channel_outputs();
            self.cache.fill_channel_outputs(outputs);
            self.cache.mark_filled();
        }
        self.cache.next_sample()
    }
}

Implementations

impl SampleCache

pub fn new(size: usize) -> Self

Create a new sample cache with the specified size.

pub fn needs_refill(&self) -> bool

Check if the cache needs to be refilled.

pub fn sample_buffer_mut(&mut self) -> &mut [f32]

Get a mutable reference to the sample buffer for filling.

pub fn fill_channel_outputs(&mut self, outputs: [f32; 3])

Fill all channel output entries with the same value.

Call this after filling samples to set the channel outputs for visualization.

pub fn mark_filled(&mut self)

Mark the cache as filled and reset position to start.

pub fn next_sample(&mut self) -> f32

Get the next sample from the cache.

Returns 0.0 if the cache is empty.

pub fn channel_outputs(&self) -> [f32; 3]

Get the channel outputs for the current/last sample.

pub fn reset(&mut self)

Reset the cache, forcing a refill on the next access.

pub fn size(&self) -> usize

Get the cache size.

Trait Implementations

impl Clone for SampleCache

fn clone(&self) -> SampleCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SampleCache

fn default() -> Self

Returns the “default value” for a type.