qualia_audio/features/contours/
contour_segmentation.rs1use crate::types::AudioError;
18
19pub fn segment_contour(
40 contour_bins: &[f32],
41 n_points: usize,
42 stable_tol_bins: f32,
43 min_note_frames: usize,
44 out_start: &mut [usize],
45 out_len: &mut [usize],
46 out_pitch: &mut [f32],
47) -> Result<usize, AudioError> {
48 if !stable_tol_bins.is_finite()
49 || stable_tol_bins < 0.0
50 || min_note_frames == 0
51 || contour_bins.len() < n_points
52 {
53 return Err(AudioError::InvalidParameter);
54 }
55 let cap = out_start.len().min(out_len.len()).min(out_pitch.len());
56
57 let mut notes = 0usize;
58 let mut run_start = 0usize;
59 let mut run_len = 0usize;
60 let mut run_sum = 0.0f64; let mut flush =
66 |start: usize, len: usize, sum: f64, notes: &mut usize| -> Result<(), AudioError> {
67 if len >= min_note_frames {
68 if *notes >= cap {
69 return Err(AudioError::OutputBufferTooSmall);
70 }
71 out_start[*notes] = start;
72 out_len[*notes] = len;
73 out_pitch[*notes] = (sum / len as f64) as f32;
74 *notes += 1;
75 }
76 Ok(())
77 };
78
79 for i in 0..n_points {
80 let p = contour_bins[i];
81 let voiced = p > 0.0 && p.is_finite();
82
83 if run_len == 0 {
84 if voiced {
85 run_start = i;
86 run_len = 1;
87 run_sum = p as f64;
88 }
89 continue;
90 }
91
92 let mean = (run_sum / run_len as f64) as f32;
93 if voiced && (p - mean).abs() <= stable_tol_bins {
94 run_len += 1;
95 run_sum += p as f64;
96 } else {
97 flush(run_start, run_len, run_sum, &mut notes)?;
99 if voiced {
100 run_start = i;
101 run_len = 1;
102 run_sum = p as f64;
103 } else {
104 run_len = 0;
105 run_sum = 0.0;
106 }
107 }
108 }
109 if run_len > 0 {
111 flush(run_start, run_len, run_sum, &mut notes)?;
112 }
113 Ok(notes)
114}
115
116#[cfg(test)]
117mod tests {
118 use super::*;
119
120 #[test]
123 fn splits_two_note_contour() {
124 let mut c = vec![0.0f32; 12];
125 for v in c.iter_mut().take(6) {
126 *v = 100.0;
127 }
128 for v in c.iter_mut().skip(6) {
129 *v = 124.0;
130 }
131 let mut start = [0usize; 4];
132 let mut len = [0usize; 4];
133 let mut pitch = [0.0f32; 4];
134 let n = segment_contour(&c, 12, 0.5, 2, &mut start, &mut len, &mut pitch).expect("segment");
135 assert_eq!(n, 2);
136 assert_eq!(start[0], 0);
137 assert_eq!(len[0], 6);
138 assert!((pitch[0] - 100.0).abs() < 1e-3);
139 assert_eq!(start[1], 6, "split at the pitch change");
140 assert_eq!(len[1], 6);
141 assert!((pitch[1] - 124.0).abs() < 1e-3);
142 }
143
144 #[test]
146 fn gap_breaks_and_short_runs_dropped() {
147 let c = [
149 100.0f32, 100.0, 100.0, 100.0, 200.0, 0.0, 0.0, 100.0, 100.0, 100.0, 100.0, ];
154 let mut start = [0usize; 4];
155 let mut len = [0usize; 4];
156 let mut pitch = [0.0f32; 4];
157 let n = segment_contour(&c, c.len(), 0.5, 2, &mut start, &mut len, &mut pitch)
158 .expect("segment");
159 assert_eq!(n, 2, "two long notes; the 1-frame blip is dropped");
160 assert_eq!((start[0], len[0]), (0, 4));
161 assert_eq!((start[1], len[1]), (7, 4));
162 }
163
164 #[test]
167 fn drift_beyond_tolerance_fragments() {
168 let c: Vec<f32> = (0..8).map(|i| 100.0 + i as f32).collect();
170 let mut start = [0usize; 16];
171 let mut len = [0usize; 16];
172 let mut pitch = [0.0f32; 16];
173 let n = segment_contour(&c, 8, 0.5, 1, &mut start, &mut len, &mut pitch).expect("segment");
174 assert_eq!(n, 8, "each 1-cent-step frame is its own micro-note");
175 }
176
177 #[test]
178 fn rejects_bad_params() {
179 let c = [100.0f32; 4];
180 let mut s = [0usize; 4];
181 let mut l = [0usize; 4];
182 let mut p = [0.0f32; 4];
183 assert_eq!(
184 segment_contour(&c, 4, -1.0, 2, &mut s, &mut l, &mut p),
185 Err(AudioError::InvalidParameter)
186 );
187 assert_eq!(
188 segment_contour(&c, 4, 0.5, 0, &mut s, &mut l, &mut p),
189 Err(AudioError::InvalidParameter)
190 );
191 }
192
193 #[test]
194 fn output_overflow_errors() {
195 let c = [100.0f32, 100.0, 0.0, 200.0, 200.0, 0.0, 50.0, 50.0];
196 let mut s = [0usize; 1];
197 let mut l = [0usize; 1];
198 let mut p = [0.0f32; 1];
199 assert_eq!(
200 segment_contour(&c, c.len(), 0.5, 2, &mut s, &mut l, &mut p),
201 Err(AudioError::OutputBufferTooSmall)
202 );
203 }
204}