kira 0.12.0

Expressive audio library for games
Documentation 
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

use std::ops::{
	Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Rem, RemAssign, Sub, SubAssign,
};

use crate::{PlaybackRate, Value, tween::Tweenable};

#[derive(Debug, Clone, Copy, PartialEq, PartialOrd, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(transparent))]
/// A change in pitch in semitones.
///
/// This can be used where [`PlaybackRate`](crate::PlaybackRate)s are expected to control
/// the pitch of a sound.
pub struct Semitones(pub f64);

impl Tweenable for Semitones {
	fn interpolate(a: Self, b: Self, amount: f64) -> Self {
		Self(Tweenable::interpolate(a.0, b.0, amount))
	}
}

impl From<f64> for Semitones {
	fn from(value: f64) -> Self {
		Self(value)
	}
}

impl From<Semitones> for PlaybackRate {
	fn from(value: Semitones) -> Self {
		PlaybackRate(2.0f64.powf(value.0 / 12.0))
	}
}

impl From<Semitones> for Value<PlaybackRate> {
	fn from(value: Semitones) -> Self {
		Self::Fixed(value.into())
	}
}

impl Add<Semitones> for Semitones {
	type Output = Semitones;

	fn add(self, rhs: Semitones) -> Self::Output {
		Self(self.0 + rhs.0)
	}
}

impl AddAssign<Semitones> for Semitones {
	fn add_assign(&mut self, rhs: Semitones) {
		self.0 += rhs.0;
	}
}

impl Sub<Semitones> for Semitones {
	type Output = Semitones;

	fn sub(self, rhs: Semitones) -> Self::Output {
		Self(self.0 - rhs.0)
	}
}

impl SubAssign<Semitones> for Semitones {
	fn sub_assign(&mut self, rhs: Semitones) {
		self.0 -= rhs.0;
	}
}

impl Mul<f64> for Semitones {
	type Output = Semitones;

	fn mul(self, rhs: f64) -> Self::Output {
		Self(self.0 * rhs)
	}
}

impl MulAssign<f64> for Semitones {
	fn mul_assign(&mut self, rhs: f64) {
		self.0 *= rhs;
	}
}

impl Div<f64> for Semitones {
	type Output = Semitones;

	fn div(self, rhs: f64) -> Self::Output {
		Self(self.0 / rhs)
	}
}

impl DivAssign<f64> for Semitones {
	fn div_assign(&mut self, rhs: f64) {
		self.0 /= rhs;
	}
}

impl Neg for Semitones {
	type Output = Semitones;

	fn neg(self) -> Self::Output {
		Self(-self.0)
	}
}

impl Rem<f64> for Semitones {
	type Output = Semitones;

	fn rem(self, rhs: f64) -> Self::Output {
		Self(self.0 % rhs)
	}
}

impl RemAssign<f64> for Semitones {
	fn rem_assign(&mut self, rhs: f64) {
		self.0 %= rhs;
	}
}

#[cfg(test)]
#[test]
#[allow(clippy::float_cmp)]
fn test() {
	/// A table of semitone differences to pitch factors.
	/// Values calculated from http://www.sengpielaudio.com/calculator-centsratio.htm
	const TEST_CALCULATIONS: [(Semitones, PlaybackRate); 5] = [
		(Semitones(0.0), PlaybackRate(1.0)),
		(Semitones(1.0), PlaybackRate(1.059463)),
		(Semitones(2.0), PlaybackRate(1.122462)),
		(Semitones(-1.0), PlaybackRate(0.943874)),
		(Semitones(-2.0), PlaybackRate(0.890899)),
	];

	for (semitones, playback_rate) in TEST_CALCULATIONS {
		assert!((PlaybackRate::from(semitones).0 - playback_rate.0).abs() < 0.00001);
	}
}