use crate::window_size::WindowSize; use std::{collections::VecDeque, f32::consts::PI}; pub trait WindowFunction: Send { /// Apply the window in-place fn apply(&mut self, data: &mut VecDeque); /// Reverse the window in-place fn reverse(&mut self, data: &mut [f32]); /// Yields the amount of samples still required to apply the window fn needed(&self) -> usize; /// Take the steps necessary to handle a resize fn resize(&mut self, window_size: &WindowSize); } /// Effectively a chunking function pub struct RectangularWindow { window_size: usize, } impl RectangularWindow { pub fn new(window_size: &WindowSize) -> Self { Self { window_size: window_size.inner(), } } } impl WindowFunction for RectangularWindow { fn apply(&mut self, _data: &mut VecDeque) {} fn reverse(&mut self, _data: &mut [f32]) {} fn needed(&self) -> usize { self.window_size } fn resize(&mut self, window_size: &WindowSize) { *self = Self::new(window_size); } } /// Hann function pub struct HannWindow { window_size: usize, function: Vec, previous: Vec, overlap_add: Vec, } impl HannWindow { pub fn new(window_size: &WindowSize) -> Self { let window_size = window_size.inner(); let half_window_size = window_size / 2; let window_size_f32 = window_size as f32; // bypass the need for a normalize buffer by using sqrt let function = (0..window_size) .map(|i| { let i = i as f32; f32::sqrt(0.5 - 0.5 * f32::cos((2.0 * PI * i) / (window_size_f32))) }) .collect::>(); Self { window_size, function, previous: Vec::with_capacity(half_window_size), overlap_add: vec![0.0; window_size], } } } impl WindowFunction for HannWindow { fn apply(&mut self, data: &mut VecDeque) { let half_window_size = self.window_size / 2; // the full window size is needed to window over the samples the first time if self.previous.is_empty() { // store the latter half for when only half the size is needed for sample in data.iter().skip(half_window_size).copied() { self.previous.push(sample); } // apply the function for (i, sample) in data.iter_mut().enumerate() { *sample *= self.function[i]; } return; } // In a real time "sliding window" it's necessary to add in the previous samples for sample in self.previous.iter().rev().copied() { data.push_front(sample); } self.previous.clear(); // keep this iteration's samples for the next window for sample in data.iter().skip(half_window_size).copied() { self.previous.push(sample); } // apply the function for (i, sample) in data.iter_mut().enumerate() { *sample *= self.function[i]; } } fn reverse(&mut self, data: &mut [f32]) { let half_window_size = self.window_size / 2; // overlap add data and save the next overlap (latter half of this buffer) for i in 0..self.window_size { self.overlap_add[i] += data[i] * self.function[i]; } // set the output samples // in other functions this will also include normalizing for i in 0..half_window_size { data[i] = self.overlap_add[i]; } // shift the saved overlap to become the next overlap self.overlap_add.rotate_left(half_window_size); // clear a spot for the overlap next time for sample in &mut self.overlap_add[half_window_size..] { *sample = 0.0; } } fn needed(&self) -> usize { if self.previous.is_empty() { self.window_size } else { self.window_size / 2 } } fn resize(&mut self, window_size: &WindowSize) { *self = Self::new(window_size); } } /// Hamming function pub struct HammingWindow { window_size: usize, function: Vec, normalize: Vec, previous: Vec, overlap_add: Vec, } impl HammingWindow { pub fn new(window_size: &WindowSize) -> Self { let window_size = window_size.inner(); let half_window_size = window_size / 2; let window_size_f32 = window_size as f32; let overlap_add = vec![0.0; window_size]; let previous = Vec::with_capacity(half_window_size); let function = (0..window_size) .map(|i| { let i = i as f32; 0.54 - (0.46 * f32::cos((2.0 * PI * i) / (window_size_f32 - 1.0))) }) .collect::>(); let normalize = (0..half_window_size) .map(|i| { (function[i] * function[i]) + (function[i + half_window_size] * function[i + half_window_size]) }) .collect::>(); Self { window_size, function, normalize, previous, overlap_add, } } } impl WindowFunction for HammingWindow { fn apply(&mut self, data: &mut VecDeque) { let half_window_size = self.window_size / 2; if self.previous.is_empty() { for sample in data.iter().skip(half_window_size).copied() { self.previous.push(sample); } for (i, sample) in data.iter_mut().enumerate() { *sample *= self.function[i]; } return; } for sample in self.previous.iter().rev().copied() { data.push_front(sample); } self.previous.clear(); for sample in data.iter().skip(half_window_size).copied() { self.previous.push(sample); } for (i, sample) in data.iter_mut().enumerate() { *sample *= self.function[i]; } } fn reverse(&mut self, data: &mut [f32]) { let half_window_size = self.window_size / 2; for (i, sample) in data.iter().copied().enumerate() { self.overlap_add[i] += sample * self.function[i]; } for (i, sample) in data.iter_mut().enumerate().take(half_window_size) { if self.normalize[i] > 1e-6 { *sample = self.overlap_add[i] / self.normalize[i]; } else { *sample = 0.0; } } self.overlap_add.rotate_left(half_window_size); for sample in &mut self.overlap_add[half_window_size..] { *sample = 0.0; } } fn needed(&self) -> usize { if self.previous.is_empty() { self.window_size } else { self.window_size / 2 } } fn resize(&mut self, window_size: &WindowSize) { *self = Self::new(window_size); } } /// 4-term Blackman-Harris window function pub struct BlackmanHarrisWindow { window_size: usize, function: Vec, normalize: Vec, previous: Vec, overlap_add: Vec, } impl BlackmanHarrisWindow { const A_0: f32 = 0.35875; const A_1: f32 = 0.48829; const A_2: f32 = 0.14128; const A_3: f32 = 0.01168; pub fn new(window_size: &WindowSize) -> Self { let window_size = window_size.inner(); let quarter_window_size = window_size / 4; let three_quarters_window_size = 3 * quarter_window_size; let window_size_f32 = window_size as f32; let overlap_add = vec![0.0; window_size]; let previous = Vec::with_capacity(three_quarters_window_size); let function = (0..window_size) .map(|i| { let i = i as f32; let one = Self::A_1 * f32::cos((2.0 * PI * i) / (window_size_f32)); let two = Self::A_2 * f32::cos((4.0 * PI * i) / (window_size_f32)); let three = Self::A_3 * f32::cos((6.0 * PI * i) / (window_size_f32)); Self::A_0 - one + two - three }) .collect::>(); #[rustfmt::skip] let normalize = (0..quarter_window_size) .map(|i| { (function[i] * function[i]) + (function[i + quarter_window_size] * function[i + quarter_window_size]) + (function[i + 2 * quarter_window_size] * function[i + 2 * quarter_window_size]) + (function[i + 3 * quarter_window_size] * function[i + 3 * quarter_window_size]) }) .collect::>(); Self { window_size, function, normalize, previous, overlap_add, } } } impl WindowFunction for BlackmanHarrisWindow { fn apply(&mut self, data: &mut VecDeque) { let quarter_window_size = self.window_size / 4; if self.previous.is_empty() { for sample in data.iter().skip(quarter_window_size).copied() { self.previous.push(sample); } for (i, sample) in data.iter_mut().enumerate() { *sample *= self.function[i]; } return; } for sample in self.previous.iter().rev().copied() { data.push_front(sample); } self.previous.clear(); for sample in data.iter().skip(quarter_window_size).copied() { self.previous.push(sample); } for (i, sample) in data.iter_mut().enumerate() { *sample *= self.function[i]; } } fn reverse(&mut self, data: &mut [f32]) { let quarter_window_size = self.window_size / 4; let three_quarters_window_size = 3 * quarter_window_size; for (i, sample) in data.iter().copied().enumerate() { self.overlap_add[i] += sample * self.function[i]; } for (i, sample) in data.iter_mut().enumerate().take(quarter_window_size) { if self.normalize[i] > 1e-6 { *sample = self.overlap_add[i] / self.normalize[i]; } else { *sample = 0.0; } } self.overlap_add.rotate_left(quarter_window_size); for sample in &mut self.overlap_add[three_quarters_window_size..] { *sample = 0.0; } } fn needed(&self) -> usize { if self.previous.is_empty() { self.window_size } else { self.window_size / 4 } } fn resize(&mut self, window_size: &WindowSize) { *self = Self::new(window_size); } } /// 4th power of sine window function pub struct Sine4Window { window_size: usize, function: Vec, normalize: Vec, previous: Vec, overlap_add: Vec, } impl Sine4Window { const A_0: f32 = 0.375; const A_1: f32 = 0.5; const A_2: f32 = 0.125; pub fn new(window_size: &WindowSize) -> Self { let window_size = window_size.inner(); let quarter_window_size = window_size / 4; let three_quarters_window_size = 3 * quarter_window_size; let window_size_f32 = window_size as f32; let overlap_add = vec![0.0; window_size]; let previous = Vec::with_capacity(three_quarters_window_size); let function = (0..window_size) .map(|i| { let i = i as f32; let two = f32::cos((2.0 * PI * i) / (window_size_f32 - 1.0)); let four = f32::cos((4.0 * PI * i) / (window_size_f32 - 1.0)); Self::A_0 - (Self::A_1 * two) + (Self::A_2 * four) }) .collect::>(); #[rustfmt::skip] let normalize = (0..quarter_window_size) .map(|i| { (function[i] * function[i]) + (function[i + quarter_window_size] * function[i + quarter_window_size]) + (function[i + 2 * quarter_window_size] * function[i + 2 * quarter_window_size]) + (function[i + 3 * quarter_window_size] * function[i + 3 * quarter_window_size]) }) .collect::>(); Self { window_size, function, normalize, previous, overlap_add, } } } impl WindowFunction for Sine4Window { fn apply(&mut self, data: &mut VecDeque) { let quarter_window_size = self.window_size / 4; if self.previous.is_empty() { for sample in data.iter().skip(quarter_window_size).copied() { self.previous.push(sample); } for (i, sample) in data.iter_mut().enumerate() { *sample *= self.function[i]; } return; } for sample in self.previous.iter().rev().copied() { data.push_front(sample); } self.previous.clear(); for sample in data.iter().skip(quarter_window_size).copied() { self.previous.push(sample); } for (i, sample) in data.iter_mut().enumerate() { *sample *= self.function[i]; } } fn reverse(&mut self, data: &mut [f32]) { let quarter_window_size = self.window_size / 4; let three_quarters_window_size = 3 * quarter_window_size; for (i, sample) in data.iter().copied().enumerate() { self.overlap_add[i] += sample * self.function[i]; } for (i, sample) in data.iter_mut().enumerate().take(quarter_window_size) { if self.normalize[i] > 1e-6 { *sample = self.overlap_add[i] / self.normalize[i]; } else { *sample = 0.0; } } self.overlap_add.rotate_left(quarter_window_size); for sample in &mut self.overlap_add[three_quarters_window_size..] { *sample = 0.0; } } fn needed(&self) -> usize { if self.previous.is_empty() { self.window_size } else { self.window_size / 4 } } fn resize(&mut self, window_size: &WindowSize) { *self = Self::new(window_size); } }