qualia_audio/features/framing/
overlap_add.rs1use crate::types::AudioError;
11
12pub fn overlap_add(
30 frames: &[f32],
31 frame_size: usize,
32 hop: usize,
33 out: &mut [f32],
34) -> Result<usize, AudioError> {
35 if frame_size == 0 || hop == 0 || !frames.len().is_multiple_of(frame_size) {
36 return Err(AudioError::InvalidParameter);
37 }
38 let num_frames = frames.len() / frame_size;
39 if num_frames == 0 {
40 return Ok(0);
41 }
42 let out_len = (num_frames - 1)
43 .checked_mul(hop)
44 .and_then(|v| v.checked_add(frame_size))
45 .ok_or(AudioError::InvalidParameter)?;
46 if out.len() < out_len {
47 return Err(AudioError::OutputBufferTooSmall);
48 }
49
50 for v in out[..out_len].iter_mut() {
51 *v = 0.0;
52 }
53 for i in 0..num_frames {
54 let frame = &frames[i * frame_size..(i + 1) * frame_size];
55 let base = i * hop;
56 for (n, &s) in frame.iter().enumerate() {
57 out[base + n] += s;
58 }
59 }
60 Ok(out_len)
61}
62
63#[cfg(test)]
64mod tests {
65 use super::*;
66 use crate::features::window::hann_window;
67
68 #[test]
69 fn single_frame_is_copied_verbatim() {
70 let frames = [1.0f32, 2.0, 3.0, 4.0];
71 let mut out = [0.0f32; 4];
72 let n = overlap_add(&frames, 4, 2, &mut out).unwrap();
73 assert_eq!(n, 4);
74 assert_eq!(out, [1.0, 2.0, 3.0, 4.0]);
75 }
76
77 #[test]
78 fn two_frames_sum_in_the_overlap() {
79 let frames = [1.0f32, 1.0, 1.0, 1.0, 2.0, 2.0, 2.0, 2.0];
81 let mut out = [0.0f32; 6];
82 let n = overlap_add(&frames, 4, 2, &mut out).unwrap();
83 assert_eq!(n, 6);
84 assert_eq!(out, [1.0, 1.0, 3.0, 3.0, 2.0, 2.0]);
86 }
87
88 #[test]
89 fn hann_cola_constant_envelope() {
90 let n = 256usize;
93 let hop = n / 2;
94 let frames_count = 12usize;
95 let mut w = vec![0.0f32; n];
96 hann_window(&mut w).unwrap();
97
98 let mut frames = vec![0.0f32; frames_count * n];
99 for i in 0..frames_count {
100 frames[i * n..(i + 1) * n].copy_from_slice(&w);
101 }
102 let out_len = (frames_count - 1) * hop + n;
103 let mut out = vec![0.0f32; out_len];
104 overlap_add(&frames, n, hop, &mut out).unwrap();
105
106 for k in n..out_len - n {
108 assert!((out[k] - 1.0).abs() < 1e-5, "envelope at {k} = {}", out[k]);
109 }
110 }
111
112 #[test]
113 fn rejects_ragged_frame_length() {
114 let frames = [0.0f32; 10]; let mut out = [0.0f32; 32];
116 assert_eq!(
117 overlap_add(&frames, 4, 2, &mut out),
118 Err(AudioError::InvalidParameter)
119 );
120 }
121
122 #[test]
123 fn rejects_short_output() {
124 let frames = [0.0f32; 8]; let mut out = [0.0f32; 5];
126 assert_eq!(
127 overlap_add(&frames, 4, 2, &mut out),
128 Err(AudioError::OutputBufferTooSmall)
129 );
130 }
131
132 #[test]
133 fn zero_frames_is_zero_length() {
134 let frames: [f32; 0] = [];
135 let mut out = [0.0f32; 4];
136 assert_eq!(overlap_add(&frames, 4, 2, &mut out), Ok(0));
137 }
138}