Struct Audio

Source

pub struct Audio {
    pub audio_array: Array1<f32>,
    pub sampling_rate: usize,
    pub format: String,
}

Expand description

Represents audio data with metadata.

This struct holds audio waveform data along with its sampling rate and format. It provides methods for loading, processing, and converting audio data.

§Fields

audio_array - Audio waveform as a 1D array of f32 samples
sampling_rate - Sampling rate in Hz
format - Audio format string (e.g., “wav”)

Fields§

§audio_array: Array1<f32>§sampling_rate: usize§format: String

Implementations§

Source §

impl Audio

Source

pub fn new( audio_array: Array1<f32>, sampling_rate: usize, format: String, ) -> Self

Creates a new Audio instance.

§Arguments

audio_array - Audio waveform data as a 1D array
sampling_rate - Sampling rate in Hz
format - Audio format string

§Returns

A new Audio instance.

Source

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Loads audio data from a WAV file.

§Arguments

path - Path to the audio file

§Returns

A new Audio instance with the loaded data.

§Errors

Returns an error if:

File cannot be opened
File format is not supported
Audio data cannot be read

§Examples

use tekken::audio::Audio;

let audio = Audio::from_file("audio.wav")?;
println!("Loaded audio: {} samples at {} Hz", audio.audio_array.len(), audio.sampling_rate);

Source

pub fn from_base64(data: &str) -> Result<Self>

Loads audio data from a base64-encoded string.

§Arguments

data - Base64-encoded audio data

§Returns

A new Audio instance with the decoded data.

§Errors

Returns an error if decoding or parsing fails.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Loads audio data from raw bytes.

§Arguments

bytes - Raw audio file data

§Returns

A new Audio instance parsed from the bytes.

§Errors

Returns an error if the bytes cannot be parsed as audio.

Source

pub fn duration(&self) -> f64

Calculates the duration of the audio in seconds.

§Returns

Audio duration in seconds.

Source

pub fn resample(&mut self, target_rate: usize) -> Result<()>

Resamples the audio to a target sampling rate.

§Arguments

target_rate - Target sampling rate in Hz

§Errors

Currently returns an error as resampling is not yet implemented.

§Note

This is a placeholder implementation that needs proper resampling logic.

Source

pub fn pad(&mut self, config: &AudioConfig) -> Result<()>

Pads the audio to meet minimum length requirements.

This method ensures the audio is long enough for processing by padding with zeros if necessary. Padding is applied based on chunk length or minimum window size requirements.