Struct CachedPlayer 

pub struct CachedPlayer<P: CacheablePlayer> { /* private fields */ }

A cached wrapper around a chiptune player.

This wrapper maintains a sample cache and channel output cache, reducing the overhead of single-sample generation for CPU-emulated players.

Example

use ym2149_common::{CachedPlayer, CacheablePlayer, DEFAULT_CACHE_SIZE};

let player = SomePlayer::new();
let mut cached = CachedPlayer::new(player, DEFAULT_CACHE_SIZE);

// Generate samples one at a time (efficient due to caching)
let sample = cached.generate_sample();
let channels = cached.cached_channel_outputs();

Implementations

impl<P: CacheablePlayer> CachedPlayer<P>

pub fn new(player: P, cache_size: usize) -> Self

Create a new cached player with the specified cache size.

pub fn with_default_cache(player: P) -> Self

Create a new cached player with the default cache size (512 samples).

pub fn inner(&self) -> &P

Get a reference to the underlying player.

pub fn inner_mut(&mut self) -> &mut P

Get a mutable reference to the underlying player.

pub fn into_inner(self) -> P

Consume the wrapper and return the underlying player.

pub fn generate_sample(&mut self) -> f32

Generate a single sample, using the cache.

If the cache is exhausted, it will be refilled automatically.

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

Get the channel outputs corresponding to the last generated sample.

This returns the channel outputs that were captured when the cache was last filled. Not sample-accurate, but provides reasonable visualization data.

pub fn reset_cache(&mut self)

Reset the cache, forcing a refill on the next sample request.

Trait Implementations

impl<P: CacheablePlayer> ChiptunePlayerBase for CachedPlayer<P>

fn play(&mut self)

Start or resume playback.

fn pause(&mut self)

Pause playback (keeps position).

fn stop(&mut self)

Stop playback and reset to beginning.

fn state(&self) -> PlaybackState

Get current playback state.

fn generate_samples_into(&mut self, buffer: &mut [f32])

Generate samples into an existing buffer.

fn sample_rate(&self) -> u32

Get the output sample rate in Hz.

fn set_channel_mute(&mut self, channel: usize, mute: bool)

Mute or unmute a specific channel (0-2).

fn is_channel_muted(&self, channel: usize) -> bool

Check if a channel is muted.

fn playback_position(&self) -> f32

Get playback position as a percentage (0.0 to 1.0).

fn subsong_count(&self) -> usize

Get the number of subsongs in this file.

fn current_subsong(&self) -> usize

Get the current subsong index (1-based).

fn set_subsong(&mut self, index: usize) -> bool

Switch to a different subsong by 1-based index.

fn psg_count(&self) -> usize

Get the number of PSG chips used by this player.

fn is_playing(&self) -> bool

Check if currently playing.

fn generate_samples(&mut self, count: usize) -> Vec<f32>

Generate samples into a new buffer.

fn has_subsongs(&self) -> bool

Check if this player supports multiple subsongs.

fn channel_count(&self) -> usize

Get the total number of audio channels.