bbx_dsp 0.4.3

Block-based audio DSP graph system with oscillators, effects, modulators, and realtime-safe processing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

//! Audio file reader trait.
//!
//! This module defines the [`Reader`] trait for reading audio file data.
//! Implementations are provided by the `bbx_file` crate (e.g., WAV reader).

use crate::sample::Sample;

/// Trait for reading audio data from files.
///
/// Implementations should load audio data on construction and provide
/// access to the decoded samples via [`read_channel`](Self::read_channel).
pub trait Reader<S: Sample>: Send + Sync {
    /// Get the sample rate of the audio file being read.
    fn sample_rate(&self) -> f64;

    /// Get the number of channels in the audio file being read.
    fn num_channels(&self) -> usize;

    /// Get the number of samples in the audio file being read.
    fn num_samples(&self) -> usize;

    /// Read samples from a specific channel of the audio file.
    fn read_channel(&self, channel_index: usize) -> &[S];
}