Struct sonogram::SpecOptionsBuilder

pub struct SpecOptionsBuilder { /* private fields */ }

A builder struct that will output a spectrogram creator when complete. This builder will require the height and width of the final spectrogram, at a minimum. However you can load data from a .wav file, or directly from a Vec memory object.

Example

  let mut spectrograph = SpecOptionsBuilder::new(512, 128)
    .set_window_fn(utility::blackman_harris)
    .load_data_from_file(&std::path::Path::new("test.wav"))?
    .build();

Implementations

impl SpecOptionsBuilder

pub fn new(width: u32, height: u32) -> Self

Create a new SpecOptionsBuilder. The final height and width of the spectrogram must be supplied. Before the build function can be called a load_data_from_* function needs to be called.

Arguments

• width - The final width of the spectrogram.
• height - The final height of the spectrogram.

pub fn set_window_fn(&mut self, window: fn(_: u32, _: u32) -> f32) -> &mut Self

A window function describes the type of window to use during the DFT (discrete fourier transform). See (here)[https://en.wikipedia.org/wiki/Window_function] for more details.

Arguments

• window - The window function to be used.

pub fn load_data_from_file(
    &mut self,
    fname: &Path
) -> Result<&mut Self, SonogramError>

Load a .wav file to memory and use that file as the input.

Arguments

• fname - The path to the file.

pub fn load_data_from_memory(
    &mut self,
    data: Vec<i16>,
    sample_rate: u32
) -> &mut Self

Load data directly from memory - i16 version.

Arguments

• data - The raw wavform data that will be converted to a spectrogram.
• sample_rate - The sample rate, in Hz, of the data.

pub fn load_data_from_memory_f32(
    &mut self,
    data: Vec<f32>,
    sample_rate: u32
) -> &mut Self

Load data directly from memory - f32 version.

Arguments

• data - The raw wavform data that will be converted to a spectrogram.
• sample_rate - The sample rate, in Hz, of the data.

pub fn downsample(&mut self, divisor: usize) -> &mut Self

Down sample the data by the given divisor. This is a cheap way of improving the performance of the FFT.

Arguments

• divisor - How much to reduce the data by.

pub fn channel(&mut self, channel: u16) -> &mut Self

pub fn set_verbose(&mut self) -> &mut Self

pub fn set_greyscale(&mut self) -> &mut Self

pub fn set_gradient(&mut self, gradient: ColourGradient) -> &mut Self

pub fn scale(&mut self, scale_factor: f32) -> &mut Self

pub fn build(&self) -> Spectrograph

Last method to be called. This will calculate the colour gradients and generate an instance of Spectrograph.