qualia_audio/models/separation/
mask.rs1use crate::types::AudioError;
11
12pub fn apply_soft_mask(
23 mixture_mag: &[f32],
24 mask: &[f32],
25 out: &mut [f32],
26) -> Result<(), AudioError> {
27 if mask.len() != mixture_mag.len() {
28 return Err(AudioError::InvalidParameter);
29 }
30 if out.len() < mixture_mag.len() {
31 return Err(AudioError::OutputBufferTooSmall);
32 }
33 for (o, (&m, &g)) in out.iter_mut().zip(mixture_mag.iter().zip(mask.iter())) {
34 *o = m * g;
35 }
36 Ok(())
37}
38
39pub fn binary_mask_from_ratio(
53 target_ref: &[f32],
54 other_ref: &[f32],
55 out_mask: &mut [f32],
56) -> Result<(), AudioError> {
57 if target_ref.len() != other_ref.len() {
58 return Err(AudioError::InvalidParameter);
59 }
60 if out_mask.len() < target_ref.len() {
61 return Err(AudioError::OutputBufferTooSmall);
62 }
63 for (o, (&t, &n)) in out_mask
64 .iter_mut()
65 .zip(target_ref.iter().zip(other_ref.iter()))
66 {
67 *o = if t >= n { 1.0 } else { 0.0 };
68 }
69 Ok(())
70}
71
72#[cfg(test)]
73mod tests {
74 use super::*;
75
76 #[test]
77 fn all_ones_mask_passes_mixture_unchanged() {
78 let mix = [0.5f32, 1.0, 2.0, 0.25];
79 let mask = [1.0f32; 4];
80 let mut out = [0.0f32; 4];
81 apply_soft_mask(&mix, &mask, &mut out).expect("mask");
82 assert_eq!(out, mix);
83 }
84
85 #[test]
86 fn all_zeros_mask_yields_silence() {
87 let mix = [0.5f32, 1.0, 2.0, 0.25];
88 let mask = [0.0f32; 4];
89 let mut out = [9.0f32; 4];
90 apply_soft_mask(&mix, &mask, &mut out).expect("mask");
91 assert_eq!(out, [0.0, 0.0, 0.0, 0.0]);
92 }
93
94 #[test]
95 fn band_mask_isolates_that_band() {
96 let mix = [1.0f32, 2.0, 3.0, 4.0, 5.0];
98 let mask = [0.0f32, 1.0, 1.0, 0.0, 0.0];
99 let mut out = [0.0f32; 5];
100 apply_soft_mask(&mix, &mask, &mut out).expect("mask");
101 assert_eq!(out, [0.0, 2.0, 3.0, 0.0, 0.0]);
102 }
103
104 #[test]
105 fn soft_mask_scales_energy() {
106 let mix = [4.0f32, 8.0];
107 let mask = [0.25f32, 0.5];
108 let mut out = [0.0f32; 2];
109 apply_soft_mask(&mix, &mask, &mut out).expect("mask");
110 assert_eq!(out, [1.0, 4.0]);
111 }
112
113 #[test]
114 fn binary_mask_assigns_dominant_bins() {
115 let target = [1.0f32, 0.2, 0.5, 0.0];
116 let other = [0.5f32, 0.8, 0.5, 0.1];
117 let mut mask = [0.0f32; 4];
118 binary_mask_from_ratio(&target, &other, &mut mask).expect("mask");
119 assert_eq!(mask, [1.0, 0.0, 1.0, 0.0]);
121 }
122
123 #[test]
124 fn binary_then_apply_extracts_target_bins() {
125 let target = [3.0f32, 0.1, 2.0];
126 let other = [1.0f32, 0.9, 0.5];
127 let mix = [4.0f32, 1.0, 2.5]; let mut mask = [0.0f32; 3];
129 binary_mask_from_ratio(&target, &other, &mut mask).expect("mask");
130 let mut out = [0.0f32; 3];
131 apply_soft_mask(&mix, &mask, &mut out).expect("apply");
132 assert_eq!(out, [4.0, 0.0, 2.5]);
134 }
135
136 #[test]
137 fn rejects_length_mismatch_and_short_output() {
138 let mix = [1.0f32, 2.0];
139 let mask = [1.0f32];
140 let mut out = [0.0f32; 2];
141 assert_eq!(
142 apply_soft_mask(&mix, &mask, &mut out),
143 Err(AudioError::InvalidParameter)
144 );
145 let mask2 = [1.0f32, 1.0];
146 let mut small = [0.0f32; 1];
147 assert_eq!(
148 apply_soft_mask(&mix, &mask2, &mut small),
149 Err(AudioError::OutputBufferTooSmall)
150 );
151 }
152}