qualia_audio/features/cqt_stream/
spectrogram.rs1use crate::features::cqt::forward_cqt_mono;
14use crate::types::AudioError;
15
16fn frame_count(signal_len: usize, frame_len: usize, hop: usize) -> usize {
22 if frame_len == 0 || hop == 0 || signal_len < frame_len {
23 return 0;
24 }
25 1 + (signal_len - frame_len) / hop
26}
27
28#[allow(clippy::too_many_arguments)]
45pub fn cqt_spectrogram(
46 signal: &[f32],
47 sample_rate: f32,
48 f_min: f32,
49 bins_per_octave: usize,
50 n_bins: usize,
51 hop: usize,
52 frame_len: usize,
53 out: &mut [f32],
54) -> Result<usize, AudioError> {
55 if hop == 0
56 || frame_len == 0
57 || n_bins == 0
58 || bins_per_octave == 0
59 || sample_rate <= 0.0
60 || f_min <= 0.0
61 {
62 return Err(AudioError::InvalidParameter);
63 }
64
65 let n_frames = frame_count(signal.len(), frame_len, hop);
66 let needed = n_frames.saturating_mul(n_bins);
67 if out.len() < needed {
68 return Err(AudioError::OutputBufferTooSmall);
69 }
70
71 for f in 0..n_frames {
72 let start = f * hop;
73 let frame = &signal[start..start + frame_len];
74 let row = &mut out[f * n_bins..(f + 1) * n_bins];
75 forward_cqt_mono(frame, sample_rate, f_min, bins_per_octave, n_bins, row)?;
76 }
77
78 Ok(n_frames)
79}
80
81#[cfg(test)]
82mod tests {
83 use super::*;
84
85 fn tone(freq: f32, sr: f32, n: usize) -> Vec<f32> {
86 (0..n)
87 .map(|i| (core::f32::consts::TAU * freq * i as f32 / sr).sin())
88 .collect()
89 }
90
91 #[test]
92 fn cqt_stream_frame_count_matches_hop_math() {
93 assert_eq!(frame_count(8192, 4096, 2048), 3);
95 assert_eq!(frame_count(4096, 4096, 2048), 1);
97 assert_eq!(frame_count(4000, 4096, 2048), 0);
99 assert_eq!(frame_count(9000, 4096, 2048), 3);
101 }
102
103 #[test]
104 fn cqt_stream_440_tone_peaks_at_bin_36() {
105 let sr = 16000.0f32;
106 let n = 8192usize;
107 let frame_len = 4096usize;
108 let hop = 2048usize;
109 let f_min = 55.0f32;
110 let bpo = 12usize;
111 let n_bins = 48usize; let s = tone(440.0, sr, n);
114
115 let expected_bin = (bpo as f32 * (440.0f32 / f_min).log2()).round() as usize;
117 assert_eq!(expected_bin, 36);
118
119 let n_frames_expected = 1 + (n - frame_len) / hop; let mut out = vec![0.0f32; n_frames_expected * n_bins];
121
122 let n_frames =
123 cqt_spectrogram(&s, sr, f_min, bpo, n_bins, hop, frame_len, &mut out).unwrap();
124 assert_eq!(n_frames, 3, "frame count must match hop math");
125
126 for f in 0..n_frames {
128 let row = &out[f * n_bins..(f + 1) * n_bins];
129 let mut best = 0usize;
130 let mut best_v = row[0];
131 for (k, &v) in row.iter().enumerate() {
132 if v > best_v {
133 best_v = v;
134 best = k;
135 }
136 }
137 assert_eq!(best, 36, "frame {f} peak bin should be 36 (440 Hz)");
138 }
139
140 let mut summed = vec![0.0f32; n_bins];
142 for f in 0..n_frames {
143 for k in 0..n_bins {
144 summed[k] += out[f * n_bins + k];
145 }
146 }
147 let mut best = 0usize;
148 for k in 1..n_bins {
149 if summed[k] > summed[best] {
150 best = k;
151 }
152 }
153 assert_eq!(best, 36, "summed-energy peak bin should be 36");
154 }
155
156 #[test]
157 fn cqt_stream_short_signal_zero_frames() {
158 let sr = 16000.0f32;
159 let s = tone(440.0, sr, 1000);
160 let mut out = [0.0f32; 48];
161 let n = cqt_spectrogram(&s, sr, 55.0, 12, 48, 2048, 4096, &mut out).unwrap();
162 assert_eq!(n, 0);
163 }
164
165 #[test]
166 fn cqt_stream_rejects_bad_params_and_small_out() {
167 let s = tone(440.0, 16000.0, 8192);
168 assert!(matches!(
170 cqt_spectrogram(&s, 16000.0, 55.0, 12, 48, 0, 4096, &mut [0.0; 48]),
171 Err(AudioError::InvalidParameter)
172 ));
173 let mut small = [0.0f32; 100];
175 assert!(matches!(
176 cqt_spectrogram(&s, 16000.0, 55.0, 12, 48, 2048, 4096, &mut small),
177 Err(AudioError::OutputBufferTooSmall)
178 ));
179 }
180}