1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
//! Ranges of parameter values that map to a [`Normal`]
use crate::core::normal_param::NormalParam;
///
/// [`Normal`]: ../struct.Normal.html
use crate::core::Normal;
use std::fmt::Debug;
/// A range that maps a continuous linear range of `f32` values
/// to a [`Normal`]
///
/// [`Normal`]: ../struct.Normal.html
#[derive(Debug, Copy, Clone)]
pub struct FloatRange {
min: f32,
max: f32,
span: f32,
span_recip: f32,
}
impl FloatRange {
/// Creates a new `FloatRange`
///
/// # Arguments
///
/// * `min` - the minimum of the range (inclusive)
/// * `max` - the maximum of the range (inclusive)
///
/// # Panics
///
/// This will panic if `max` <= `min`
pub fn new(min: f32, max: f32) -> Self {
assert!(max > min);
let span = max - min;
let span_recip = span.recip();
Self {
min,
max,
span,
span_recip,
}
}
/// A `FloatRange` with the range
///
/// * `min` = -1.0
/// * `max` = 1.0
pub fn default_bipolar() -> Self {
FloatRange::new(-1.0, 1.0)
}
fn constrain(&self, value: f32) -> f32 {
if value <= self.min {
self.min
} else if value >= self.max {
self.max
} else {
value
}
}
/// Creates a new [`NormalParam`] with values mapped
/// from this range.
///
/// [`NormalParam`]: ../normal_param/struct.NormalParam.html
///
/// * `value` - The inital value of the parameter.
/// * `default_value` - The default value of the parameter.
pub fn normal_param(&self, value: f32, default: f32) -> NormalParam {
NormalParam {
value: self.map_to_normal(value),
default: self.map_to_normal(default),
}
}
/// Creates a new [`NormalParam`] with values mapped
/// from this range where `value` and `default_value` is `0.0`.
///
/// [`NormalParam`]: ../normal_param/struct.NormalParam.html
pub fn default_normal_param(&self) -> NormalParam {
NormalParam {
value: self.map_to_normal(0.0),
default: self.map_to_normal(0.0),
}
}
/// Returns the corresponding [`Normal`] from the supplied value
///
/// [`Normal`]: ../struct.Normal.html
pub fn map_to_normal(&self, value: f32) -> Normal {
let value = self.constrain(value);
Normal::from_clipped((value - self.min) * self.span_recip)
}
/// Returns the corresponding value from the supplied [`Normal`]
///
/// [`Normal`]: ../struct.Normal.html
pub fn unmap_to_value(&self, normal: Normal) -> f32 {
(normal.as_f32() * self.span) + self.min
}
}
impl Default for FloatRange {
fn default() -> Self {
FloatRange::new(0.0, 1.0)
}
}
/// A range that defines a discrete linear range of i32 values
#[derive(Debug, Copy, Clone)]
pub struct IntRange {
min: i32,
max: i32,
span: f32,
span_recip: f32,
}
impl IntRange {
/// Creates a new `IntRange`
///
/// # Arguments
///
/// * `min` - the minimum of the range (inclusive)
/// * `max` - the maximum of the range (inclusive)
///
/// # Panics
///
/// This will panic if `max` <= `min`
pub fn new(min: i32, max: i32) -> Self {
assert!(max > min);
let span = (max - min) as f32;
let span_recip = span.recip();
Self {
min,
max,
span,
span_recip,
}
}
fn constrain(&self, value: i32) -> i32 {
if value <= self.min {
self.min
} else if value >= self.max {
self.max
} else {
value
}
}
/// Creates a new [`NormalParam`] with values mapped
/// from this range.
///
/// [`NormalParam`]: ../normal_param/struct.NormalParam.html
///
/// * `value` - The inital value of the parameter.
/// * `default_value` - The default value of the parameter.
pub fn normal_param(&self, value: i32, default: i32) -> NormalParam {
NormalParam {
value: self.map_to_normal(value),
default: self.map_to_normal(default),
}
}
/// Creates a new [`NormalParam`] with values mapped
/// from this range where `value` and `default_value` is `0`.
///
/// [`NormalParam`]: ../normal_param/struct.NormalParam.html
pub fn default_normal_param(&self) -> NormalParam {
NormalParam {
value: self.map_to_normal(0),
default: self.map_to_normal(0),
}
}
/// Returns a [`Normal`] that is snapped to the closest integer
/// value in this range.
///
/// [`Normal`]: ../struct.Normal.html
pub fn snapped(&self, normal: Normal) -> Normal {
let value_int = self.unmap_to_value(normal);
self.map_to_normal(value_int)
}
/// Returns the corresponding [`Normal`] from the supplied value
///
/// [`Normal`]: ../struct.Normal.html
pub fn map_to_normal(&self, value: i32) -> Normal {
let value = self.constrain(value);
Normal::from_clipped((value - self.min) as f32 * self.span_recip)
}
/// Returns the corresponding value from the supplied [`Normal`]
///
/// [`Normal`]: ../struct.Normal.html
pub fn unmap_to_value(&self, normal: Normal) -> i32 {
(normal.as_f32() * self.span).round() as i32 + self.min
}
}
impl Default for IntRange {
fn default() -> Self {
IntRange::new(0, 100)
}
}
/// A range that defines a continuous logarithmic range of `dB` values,
/// with an inflection/stationary point at 0 dB
///
/// Values around 0 dB (positive and negative) will increment slower per
/// slider movement than values farther away from 0 dB.
#[derive(Debug, Copy, Clone)]
pub struct LogDBRange {
min: f32,
max: f32,
zero_position: Normal,
min_recip: f32,
max_recip: f32,
zero_pos_recip: f32,
one_min_zero_pos_recip: f32,
}
impl LogDBRange {
/// Creates a new `LogDBRange`
///
/// # Arguments
///
/// * `min` - the minimum of the range in dB (inclusive), must be <= 0.0
/// * `max` - the maximum of the range in dB (inclusive), must be >= 0.0
/// * `zero_position` - a normal that defines where on the slider 0 decibels
/// should be. For example, `Normal::CENTER` will have 0 dB at the center
/// of the slider. Normals of `1.0` and `0.0` can be used for only negative
/// or only positive decibels respectively
///
/// # Panics
///
/// This will panic if
/// * `max` <= `min`
/// * `min` > `0.0`
/// * `max` < `0.0`
///
pub fn new(min: f32, max: f32, zero_position: Normal) -> Self {
assert!(max > min, "max must be greater than min");
assert!(max >= 0.0, "max must be 0.0 or positive");
assert!(min <= 0.0, "min must be 0.0 or negative");
let min_recip = if min == 0.0 { 0.0 } else { 1.0 / min };
let max_recip = if max == 0.0 { 0.0 } else { 1.0 / max };
let zero_pos_recip = if zero_position.as_f32() == 0.0 {
0.0
} else {
1.0 / zero_position.as_f32()
};
let one_min_zero_pos_recip = if zero_position.as_f32() == 0.0 {
0.0
} else {
1.0 / (1.0 - zero_position.as_f32())
};
Self {
min,
max,
zero_position,
min_recip,
max_recip,
zero_pos_recip,
one_min_zero_pos_recip,
}
}
fn constrain(&self, value: f32) -> f32 {
if value <= self.min {
self.min
} else if value >= self.max {
self.max
} else {
value
}
}
/// Creates a new [`NormalParam`] with values mapped
/// from this range.
///
/// [`NormalParam`]: ../normal_param/struct.NormalParam.html
///
/// * `value` - The inital value of the parameter.
/// * `default_value` - The default value of the parameter.
pub fn normal_param(&self, value: f32, default: f32) -> NormalParam {
NormalParam {
value: self.map_to_normal(value),
default: self.map_to_normal(default),
}
}
/// Creates a new [`NormalParam`] with values mapped
/// from this range where `value` and `default_value` is `0.0`.
///
/// [`NormalParam`]: ../normal_param/struct.NormalParam.html
pub fn default_normal_param(&self) -> NormalParam {
NormalParam {
value: self.map_to_normal(0.0),
default: self.map_to_normal(0.0),
}
}
/// Returns the corresponding [`Normal`] from the supplied `value`
///
/// [`Normal`]: ../struct.Normal.html
pub fn map_to_normal(&self, value: f32) -> Normal {
let value = self.constrain(value);
if value == 0.0 {
self.zero_position
} else if value < 0.0 {
if self.min >= 0.0 {
return Normal::MIN;
}
let neg_normal = value * self.min_recip;
let log_normal = 1.0 - neg_normal.sqrt();
Normal::from_clipped(log_normal * self.zero_position.as_f32())
} else {
if self.max <= 0.0 {
return Normal::MAX;
}
let pos_normal = value * self.max_recip;
let log_normal = pos_normal.sqrt();
Normal::from_clipped(
(log_normal * (1.0 - self.zero_position.as_f32()))
+ self.zero_position.as_f32(),
)
}
}
/// Returns the corresponding dB value from the supplied [`Normal`]
///
/// [`Normal`]: ../struct.Normal.html
pub fn unmap_to_value(&self, normal: Normal) -> f32 {
if normal == self.zero_position {
0.0
} else if normal < self.zero_position {
if self.min >= 0.0 {
return self.min;
}
let neg_normal = 1.0 - (normal.as_f32() * self.zero_pos_recip);
let log_normal = 1.0 - (neg_normal * neg_normal);
(1.0 - log_normal) * self.min
} else {
if self.zero_position.as_f32() == 1.0 || self.max <= 0.0 {
return self.max;
}
let pos_normal = (normal.as_f32() - self.zero_position.as_f32())
* self.one_min_zero_pos_recip;
let log_normal = pos_normal * pos_normal;
log_normal * self.max
}
}
}
impl Default for LogDBRange {
fn default() -> Self {
LogDBRange::new(-12.0, 12.0, Normal::CENTER)
}
}
/// A [`NormalParam`] that defines a continuous logarithmic range of `f32` frequency
/// values, with each octave in the 10 octave spectrum spaced evenly.
///
/// Smaller frequencies will increment slower per slider movement than larger
/// ones.
#[derive(Debug, Copy, Clone)]
pub struct FreqRange {
min: f32,
max: f32,
spectrum_normal_span: f32,
spectrum_normal_span_recip: f32,
min_spectrum_normal: Normal,
}
impl FreqRange {
/// Creates a new `OctaveNormalParam`
///
/// # Arguments
///
/// * `min` - the minimum of the range in Hz (inclusive), will be
/// constrained to `20.0 Hz <= min <= 20480.0 Hz`
/// * `max` - the maximum of the range in Hz (inclusive), will be
/// constrained to `20.0 Hz <= max <= 20480.0 Hz`
///
/// # Panics
///
/// This will panic if
/// * `max` <= `min`
///
pub fn new(min: f32, max: f32) -> Self {
assert!(max > min);
let mut min = min;
if min < 20.0 {
min = 20.0;
}
let mut max = max;
if max > 20480.0 {
max = 20480.0;
}
let min_spectrum_normal = octave_spectrum_map_to_normal(min);
let max_spectrum_normal = octave_spectrum_map_to_normal(max);
let spectrum_normal_span =
max_spectrum_normal.as_f32() - min_spectrum_normal.as_f32();
let spectrum_normal_span_recip = 1.0 / spectrum_normal_span;
Self {
min,
max,
spectrum_normal_span,
min_spectrum_normal,
spectrum_normal_span_recip,
}
}
fn constrain(&self, value: f32) -> f32 {
if value <= self.min {
self.min
} else if value >= self.max {
self.max
} else {
value
}
}
/// Creates a new [`NormalParam`] with values mapped
/// from this range.
///
/// [`NormalParam`]: ../normal_param/struct.NormalParam.html
///
/// * `value` - The inital value of the parameter.
/// * `default_value` - The default value of the parameter.
pub fn normal_param(&self, value: f32, default: f32) -> NormalParam {
NormalParam {
value: self.map_to_normal(value),
default: self.map_to_normal(default),
}
}
/// Creates a new [`NormalParam`] with values mapped
/// from this range where `value` and `default_value` is `20480.0`.
///
/// [`NormalParam`]: ../normal_param/struct.NormalParam.html
pub fn default_normal_param(&self) -> NormalParam {
NormalParam {
value: self.map_to_normal(20_480.0),
default: self.map_to_normal(20_480.0),
}
}
/// Returns the corresponding [`Normal`] from the supplied frequency value
///
/// [`Normal`]: ../struct.Normal.html
pub fn map_to_normal(&self, value: f32) -> Normal {
let value = self.constrain(value);
let spectrum_normal = octave_spectrum_map_to_normal(value);
Normal::from_clipped(
(spectrum_normal.as_f32() - self.min_spectrum_normal.as_f32())
* self.spectrum_normal_span_recip,
)
}
/// Returns the corresponding frequency value from the supplied [`Normal`]
///
/// [`Normal`]: ../struct.Normal.html
pub fn unmap_to_value(&self, normal: Normal) -> f32 {
let spectrum_normal = Normal::from_clipped(
normal.as_f32() * self.spectrum_normal_span
+ self.min_spectrum_normal.as_f32(),
);
octave_normal_to_spectrum(spectrum_normal)
}
}
impl Default for FreqRange {
fn default() -> Self {
FreqRange::new(20.0, 20_000.0)
}
}
/// Returns the corresponding frequency for the whole 10 octave spectrum
/// (between 20 Hz and 20480 Hz)
#[inline]
fn octave_normal_to_spectrum(value: Normal) -> f32 {
40.0 * 2.0_f32.powf((10.0 * value.as_f32()) - 1.0)
}
/// Returns the corresponding [`Normal`] for a frequency in the whole
/// 10 octave spectrum (between 20 Hz and 20480 Hz)
///
/// [`Normal`]: ../struct.Normal.html
#[inline]
fn octave_spectrum_map_to_normal(freq: f32) -> Normal {
Normal::from_clipped(((freq / 40.0).log2() + 1.0) * 0.1)
}