Struct Wave

pub struct Wave { /* private fields */ }

Wave, audio wave data

Implementations

impl Wave

pub fn frame_count(&self) -> u32

Total number of frames (considering channels)

pub fn sample_rate(&self) -> u32

Frequency (samples per second)

pub fn sample_size(&self) -> u32

Bit depth (bits per sample): 8, 16, 32 (24 not supported)

pub fn channels(&self) -> u32

Number of channels (1-mono, 2-stereo, …)

pub fn from_file(file_name: &str) -> Option<Self>

Load wave data from file

pub fn from_memory(file_data: &[u8], format: AudioFormat) -> Option<Self>

Load wave from memory buffer

pub fn export(&self, file_name: &str) -> bool

Export wave data to file, returns true on success

pub fn export_as_code(&self, file_name: &str) -> bool

Export wave sample data to code (.h), returns true on success

pub fn crop(&mut self, init_sample: u32, final_sample: u32)

Crop a wave to defined samples range

pub fn convert_to_format( &mut self, sample_rate: u32, sample_size: u32, channels: u32, )

Convert wave data to desired format

pub fn load_samples(&self) -> Vec<f32>

Load samples data from wave as a 32bit float data array

pub fn as_raw(&self) -> &Wave

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub fn as_raw_mut(&mut self) -> &mut Wave

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub unsafe fn from_raw(raw: Wave) -> Self

Convert a ‘raw’ ffi object to a safe wrapper

Safety

• The raw object must be correctly initialized
• The raw object should be unique. Otherwise, make sure its clones don’t outlive the newly created object.

Trait Implementations

impl Clone for Wave

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Wave

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Wave

fn drop(&mut self)

Executes the destructor for this type.