Struct aus::AudioFile

pub struct AudioFile {
    pub audio_format: AudioFormat,
    pub bits_per_sample: u32,
    pub duration: f64,
    pub num_channels: usize,
    pub num_frames: usize,
    pub sample_rate: u32,
    pub samples: Vec<Vec<f64>>,
}

Represents an audio file. Samples are always stored in f64 format, regardless of their original format on disk.

Fields

audio_format: AudioFormat

bits_per_sample: u32

duration: f64

num_channels: usize

num_frames: usize

sample_rate: u32

samples: Vec<Vec<f64>>

Implementations

impl AudioFile

pub fn copy_header(&self) -> AudioFile

Copies the header of an AudioFile and initializes the struct with an empty sample vector. Warning - the empty sample vector has no channels and no frames.

Example:

let audio = aus::read("myfile.wav").unwrap();
let blank_file = audio.copy_header();

pub fn new( audio_format: AudioFormat, sample_rate: u32, samples: Vec<Vec<f64>>, ) -> AudioFile

Creates a new AudioFile from provided audio format, sample rate, and 2D sample vector.

Example

use aus::{AudioFile, AudioFormat};
use aus::synthesis::sine;
let waveform = sine(440.0, 0.0, 44100 * 2, 44100);
let mut channels: Vec<Vec<f64>> = Vec::with_capacity(2);
channels.push(waveform.clone());
channels.push(waveform.clone());
let file = AudioFile::new(AudioFormat::S24, 44100, channels);
aus::write("file_name.wav", &file);

pub fn new_mono( audio_format: AudioFormat, sample_rate: u32, samples: Vec<f64>, ) -> AudioFile

Creates a new mono AudioFile from provided audio format, sample rate, and 1D sample vector.

Example

use aus::{AudioFile, AudioFormat};
use aus::synthesis::sine;
let waveform = sine(440.0, 0.0, 44100 * 2, 44100);
let file = AudioFile::new_mono(AudioFormat::S24, 44100, waveform);
aus::write("file_name.wav", &file);