Struct ChromaExtractor 

pub struct ChromaExtractor { /* private fields */ }

Chroma feature extractor with configurable STFT and tuning parameters.

Examples

use resonant_analysis::chroma::ChromaExtractor;

let extractor = ChromaExtractor::new(44100.0);
let samples = vec![0.0_f32; 8192];
let chroma = extractor.extract(&samples).unwrap();
for cv in &chroma {
    assert_eq!(cv.bins.len(), 12);
}

Implementations

impl ChromaExtractor

pub fn new(sample_rate: f32) -> Self

Creates an extractor with default parameters.

Defaults: window 4096, hop 2048, A4 = 440 Hz tuning.

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

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

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

Sets the STFT hop size.

pub fn with_tuning(self, hz: f32) -> Self

Sets the tuning reference frequency for A4 (default 440 Hz).

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

Extracts chroma vectors from mono audio samples.

Returns one ChromaVector per STFT frame.

Errors

Returns AnalysisError::EmptyInput if samples is empty.

Trait Implementations

impl Clone for ChromaExtractor

fn clone(&self) -> ChromaExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChromaExtractor

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

Formats the value using the given formatter.