Skip to main content

MfccExtractor

Struct MfccExtractor 

Source
pub struct MfccExtractor { /* private fields */ }
Expand description

MFCC extractor with configurable parameters.

§Examples

use resonant_analysis::mfcc::MfccExtractor;

let extractor = MfccExtractor::new(44100.0);
let samples = vec![0.0_f32; 4096];
let frames = extractor.extract(&samples).unwrap();
// Each frame has 13 coefficients by default
for f in &frames {
    assert_eq!(f.coefficients.len(), 13);
}

Implementations§

Source§

impl MfccExtractor

Source

pub fn new(sample_rate: f32) -> Self

Creates an extractor with default parameters.

Defaults: 13 coefficients, 26 mel bands, window 1024, hop 512.

Source

pub fn with_num_coefficients(self, n: usize) -> Self

Sets the number of MFCC coefficients to keep per frame.

Source

pub fn with_num_mel_bands(self, n: usize) -> Self

Sets the number of mel filterbank bands.

Source

pub fn with_window_size(self, size: usize) -> Self

Sets the STFT window size (should be a power of two).

Source

pub fn with_hop_size(self, hop: usize) -> Self

Sets the STFT hop size.

Source

pub fn extract(&self, samples: &[f32]) -> Result<Vec<MfccFrame>, AnalysisError>

Extracts MFCC frames from mono audio samples.

§Errors

Returns AnalysisError::EmptyInput if samples is empty, or AnalysisError::InvalidParameter if parameters are inconsistent.

Source

pub fn deltas( frames: &[MfccFrame], width: usize, ) -> Result<Vec<MfccFrame>, AnalysisError>

Computes delta (first derivative) coefficients from MFCC frames.

Uses a regression window of width frames on each side.

§Errors

Returns AnalysisError::EmptyInput if frames is empty, or AnalysisError::InvalidParameter if width is zero.

Source

pub fn delta_deltas( frames: &[MfccFrame], width: usize, ) -> Result<Vec<MfccFrame>, AnalysisError>

Computes delta-delta (second derivative / acceleration) coefficients.

Equivalent to applying deltas twice.

§Errors

Same as deltas.

Trait Implementations§

Source§

impl Clone for MfccExtractor

Source§

fn clone(&self) -> MfccExtractor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MfccExtractor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.