clamp some parameters to valid values

Author: tesselode

changelog.md

@@ -1,3 +1,7 @@
+# v0.10.3 - February 9, 2025
+
+- Clamp some parameters to valid values
+
 # v0.10.2 - January 17, 2025
 
 - Add `Static/StreamingSoundData::unsliced_duration` (thanks @Roms1383!)

crates/kira/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "kira"
-version = "0.10.2"
+version = "0.10.3"
 authors = ["Andrew Minnich <aminnich3@gmail.com>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"

crates/kira/src/effect/compressor.rs

@@ -86,7 +86,7 @@ impl Effect for Compressor {
 		for (i, frame) in input.iter_mut().enumerate() {
 			let time_in_chunk = (i + 1) as f64 / num_frames as f64;
 			let makeup_gain = self.makeup_gain.interpolated_value(time_in_chunk);
-			let mix = self.mix.interpolated_value(time_in_chunk);
+			let mix = self.mix.interpolated_value(time_in_chunk).0.clamp(0.0, 1.0);
 
 			let input_decibels = [
 				20.0 * frame.left.abs().log10(),
@@ -114,7 +114,7 @@ impl Effect for Compressor {
 				right: amplitude[1] * frame.right,
 			} * makeup_gain_linear;
 
-			*frame = output * mix.0.sqrt() + *frame * (1.0 - mix.0).sqrt()
+			*frame = output * mix.sqrt() + *frame * (1.0 - mix).sqrt()
 		}
 	}
 }

crates/kira/src/effect/delay.rs

@@ -101,8 +101,8 @@ impl Effect for Delay {
 			// output mix of input and read buffer
 			for (i, frame) in input.iter_mut().enumerate() {
 				let time_in_chunk = (i + 1) as f64 / num_frames as f64;
-				let mix = self.mix.interpolated_value(time_in_chunk);
-				*frame = self.temp_buffer[i] * mix.0.sqrt() + *frame * (1.0 - mix.0).sqrt()
+				let mix = self.mix.interpolated_value(time_in_chunk).0.clamp(0.0, 1.0);
+				*frame = self.temp_buffer[i] * mix.sqrt() + *frame * (1.0 - mix).sqrt()
 			}
 		}
 	}

crates/kira/src/effect/distortion.rs

@@ -62,7 +62,7 @@ impl Effect for Distortion {
 		for (i, frame) in input.iter_mut().enumerate() {
 			let time_in_chunk = (i + 1) as f64 / num_frames as f64;
 			let drive = self.drive.interpolated_value(time_in_chunk).as_amplitude();
-			let mix = self.mix.interpolated_value(time_in_chunk);
+			let mix = self.mix.interpolated_value(time_in_chunk).0.clamp(0.0, 1.0);
 
 			let mut output = *frame * drive;
 			output = match self.kind {
@@ -76,7 +76,7 @@ impl Effect for Distortion {
 			};
 			output /= drive;
 
-			*frame = output * mix.0.sqrt() + *frame * (1.0 - mix.0).sqrt()
+			*frame = output * mix.sqrt() + *frame * (1.0 - mix).sqrt()
 		}
 	}
 }

crates/kira/src/effect/eq_filter.rs

@@ -111,7 +111,7 @@ impl Coefficients {
 	fn calculate(kind: EqFilterKind, frequency: f64, q: f64, gain: Decibels, dt: f64) -> Self {
 		// In my testing, the filter goes unstable when the frequency exceeds half the sample rate,
 		// so I'm clamping this value to 0.5
-		let relative_frequency = (frequency * dt).clamp(0.0, 0.5);
+		let relative_frequency = (frequency * dt).clamp(0.0001, 0.5);
 		let q = q.max(MIN_Q);
 		match kind {
 			EqFilterKind::Bell => {

crates/kira/src/effect/filter.rs

@@ -81,10 +81,10 @@ impl Effect for Filter {
 				.resonance
 				.interpolated_value(time_in_chunk)
 				.clamp(0.0, 1.0);
-			let mix = self.mix.interpolated_value(time_in_chunk).0;
+			let mix = self.mix.interpolated_value(time_in_chunk).0.clamp(0.0, 1.0);
 
 			let sample_rate = 1.0 / dt;
-			let g = (PI * (cutoff / sample_rate)).tan();
+			let g = (PI * (cutoff / sample_rate).clamp(0.0001, 0.5)).tan();
 			let k = 2.0 - (1.9 * resonance);
 			let a1 = 1.0 / (1.0 + (g * (g + k)));
 			let a2 = g * a1;

crates/kira/src/effect/reverb.rs

@@ -155,7 +155,7 @@ impl Effect for Reverb {
 			for (i, frame) in input.iter_mut().enumerate() {
 				let time_in_chunk = (i + 1) as f64 / num_frames as f64;
 				let stereo_width = self.stereo_width.interpolated_value(time_in_chunk) as f32;
-				let mix = self.mix.interpolated_value(time_in_chunk).0;
+				let mix = self.mix.interpolated_value(time_in_chunk).0.clamp(0.0, 1.0);
 
 				let mut output = Frame::ZERO;
 				let mono_input = (frame.left + frame.right) * GAIN;

crates/kira/src/frame.rs

@@ -49,7 +49,8 @@ impl Frame {
 		if panning == Panning::CENTER {
 			return self;
 		}
-		let left_right_mix = (panning.0 + 1.0) * 0.5;
+		let panning = panning.0.clamp(-1.0, 1.0);
+		let left_right_mix = (panning + 1.0) * 0.5;
 		Self::new(
 			self.left * (1.0 - left_right_mix).sqrt(),
 			self.right * left_right_mix.sqrt(),