Struct babycat::IntWaveform

pub struct IntWaveform { /* fields omitted */ }

Represents a fixed-length audio waveform as a Vec<i16>.

This struct should only be used when needed to store or transmit uncompressed audio data. For more operations on audio, it is better to work with a FloatWaveform.

Examples

use babycat::{FloatWaveform, IntWaveform, Waveform};


// The FloatWaveform stores audio samples as f32 values between -1.0 and 1.0.
let float_waveform = FloatWaveform::from_file(
   "audio-for-tests/circus-of-freaks/track.mp3",
    Default::default(),
).unwrap();
assert_eq!(
    format!("{:?}", float_waveform),
    "FloatWaveform { frame_rate_hz: 44100, num_channels: 2, num_frames: 2492928}"
);
println!("{:?}", &float_waveform.interleaved_samples()[30000..30005]);
// [0.0238994, 0.08098572, 0.0208567, 0.09139156, 0.015145444]


// The Intwaveform stores audio samples as i16 values between -32768 and 32767.
let int_waveform = IntWaveform::from(float_waveform);
assert_eq!(
    format!("{:?}", int_waveform),
    "IntWaveform { frame_rate_hz: 44100, num_channels: 2, num_frames: 2492928}"
);
println!("{:?}", &int_waveform.interleaved_samples()[30000..30005]);
// [783, 2653, 683, 2994, 496]

Trait Implementations

impl Clone for IntWaveform

fn clone(&self) -> IntWaveform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IntWaveform

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IntWaveform

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<FloatWaveform> for IntWaveform

fn from(item: FloatWaveform) -> Self

Performs the conversion.

impl From<IntWaveform> for FloatWaveform

fn from(item: IntWaveform) -> Self

Performs the conversion.

impl PartialEq<IntWaveform> for IntWaveform

fn eq(&self, other: &IntWaveform) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IntWaveform) -> bool

This method tests for !=.

impl Serialize for IntWaveform

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Waveform<i16> for IntWaveform

fn new(
    frame_rate_hz: u32,
    num_channels: u32,
    interleaved_samples: Vec<i16>
) -> Self

fn frame_rate_hz(&self) -> u32

The frame rate (or sample rate) of the audio in memory.

fn num_channels(&self) -> u32

The number of audio channels.

fn num_frames(&self) -> u64

The number of frames in the audio.

fn interleaved_samples(&self) -> &[i16]

Return the waveform as a slice of interleaved samples.

impl Eq for IntWaveform

impl StructuralEq for IntWaveform

impl StructuralPartialEq for IntWaveform