rft 0.1.0

FFT handling library.
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
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

use std::{i8, i16, i32};
use num::{Zero, One};
use {Precision, Complex};

/// Trait for sample data, usually from a music file, used for input.
pub trait Sample: Zero + One + Clone {
	/// Returns a normalized value between `-1.0` and `1.0`.
	fn normalize(&self) -> Precision;
}

/// Trait for mutable sample data, used for output.
pub trait SampleMut: Sample {
	/// Sets a normalized value between `-1.0` and `1.0`.
	fn set_normalized(&mut self, value: Precision);
}

impl Sample for u8 {
	#[inline(always)]
	fn normalize(&self) -> Precision {
		-((*self as Precision - i8::MAX as Precision) / i8::MIN as Precision)
	}
}

impl SampleMut for u8 {
	#[inline(always)]
	fn set_normalized(&mut self, value: Precision) {
		if value >= 0.0 {
			*self = ((value * 128.0) + 127.0) as u8
		}
		else {
			*self = ((value * 128.0) + 128.0) as u8
		}
	}
}

impl Sample for i16 {
	#[inline(always)]
	fn normalize(&self) -> Precision {
		*self as Precision / -(i16::MIN as Precision)
	}
}

impl SampleMut for i16 {
	#[inline(always)]
	fn set_normalized(&mut self, value: Precision) {
		if value >= 0.0 {
			*self = (value as f64 * i16::MAX as f64) as i16;
		}
		else {
			*self = -(value as f64 * i16::MIN as f64) as i16;
		}
	}
}

impl Sample for i32 {
	#[inline(always)]
	fn normalize(&self) -> Precision {
		*self as Precision / -(i32::MIN as Precision)
	}
}

impl SampleMut for i32 {
	#[inline(always)]
	fn set_normalized(&mut self, value: Precision) {
		if value >= 0.0 {
			*self = (value as f64 * i32::MAX as f64) as i32;
		}
		else {
			*self = -(value as f64 * i32::MIN as f64) as i32;
		}
	}
}

impl Sample for f32 {
	#[inline(always)]
	fn normalize(&self) -> Precision {
		*self as Precision
	}
}

impl SampleMut for f32 {
	#[inline(always)]
	fn set_normalized(&mut self, value: Precision) {
		*self = value as f32;
	}
}

impl Sample for f64 {
	#[inline(always)]
	fn normalize(&self) -> Precision {
		*self as Precision
	}
}

impl SampleMut for f64 {
	#[inline(always)]
	fn set_normalized(&mut self, value: Precision) {
		*self = value as f64;
	}
}

impl<S: Sample> Complex for S {
	#[inline(always)]
	fn real(&self) -> Precision {
		self.normalize()
	}

	#[inline(always)]
	fn imag(&self) -> Precision {
		0.0
	}
}

#[cfg(test)]
mod tests {
	use super::{Sample, SampleMut};
	use std::{u8, i16, i32};

	macro_rules! assert_approx_eq {
		($a:expr, $b:expr, $p:expr) => (
			assert_eq!(format!("{:.1$}", $a, $p), format!("{:.1$}", $b, $p));
			assert_eq!(format!("{:.1$}", $a, $p), format!("{:.1$}", $b, $p));
		)
	}

	#[test]
	fn u8() {
		assert_approx_eq!(Sample::normalize(&u8::MAX),  1.00, 2);
		assert_approx_eq!(Sample::normalize(&u8::MIN), -0.99, 2);
	}

	#[test]
	fn u8_mut() {
		let mut v = 0u8;

		SampleMut::set_normalized(&mut v, 1.0);
		assert_eq!(v, u8::MAX);

		SampleMut::set_normalized(&mut v, -1.0);
		assert_eq!(v, u8::MIN);
	}

	#[test]
	fn i16() {
		assert_approx_eq!(Sample::normalize(&i16::MAX),  1.00, 2);
		assert_approx_eq!(Sample::normalize(&i16::MIN), -1.00, 2);
	}

	#[test]
	fn i16_mut() {
		let mut v = 0i16;

		SampleMut::set_normalized(&mut v, 1.0);
		assert_eq!(v, i16::MAX);

		SampleMut::set_normalized(&mut v, -1.0);
		assert_eq!(v, i16::MIN);
	}


	#[test]
	fn i32() {
		assert_approx_eq!(Sample::normalize(&i32::MAX),  1.00, 2);
		assert_approx_eq!(Sample::normalize(&i32::MIN), -1.00, 2);
	}

	#[test]
	fn i32_mut() {
		let mut v = 0i32;

		SampleMut::set_normalized(&mut v, 1.0);
		assert_eq!(v, i32::MAX);

		SampleMut::set_normalized(&mut v, -1.0);
		assert_eq!(v, i32::MIN);
	}
}