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
//! The **sequencer** module provides a trait for working with **Iterator**s that yield **OscMessage**s.
//! Along with the **Iterator** trait, **OscMessageSequencer** provides **delay**, which returns
//! the amount of time a client should wait between sending **OscMessage**s.
//! The module also provides implementations of the **OscMessageSequencer** trait for common
//! useful waveforms.

use crate::CvAddress;
use crate::CvMessage;
use crate::OscMessage;
use sample::signal;
use sample::signal::ConstHz;
use sample::signal::Signal;
use std::time;

/// Types that yield **OscMessage**s and provide a delay to
/// pause between messages.
pub trait OscMessageSequencer: Iterator<Item = OscMessage> {
    fn delay(&self) -> time::Duration;
}

/// **NoiseSequencer** generates a sequence of **CvMessage**s
/// representing random noise.
/// ```rust
/// use open_sound_module::OscMessageSequencer;
/// use open_sound_module::NoiseSequencer;
/// use open_sound_module::CvAddress;
/// use std::time;
///
/// fn main() -> Result<(), failure::Error> {
///     let seconds = time::Duration::from_secs(1);
///     let mut noise = NoiseSequencer::new(CvAddress::A, 0, 4.0, seconds);
///     let _msg = noise.next();
///     let _delay = noise.delay();
///     Ok(())  
/// }
/// ```
pub struct NoiseSequencer {
    addr: CvAddress,
    noise: signal::Noise,
    rate: f64,
    duration: time::Duration,
    start: time::Instant,
}

impl NoiseSequencer {
    /// Create a new **NoiseSequencer** from a **CvAddress**, a random
    /// seed, a rate, and a duration. The rate is a sample rate that
    /// is used to determine the delay between messages. For
    /// exampe, a sample rate of 4.0 will cause the OscSeq
    /// to wait 250ms between messages for a rate of 4
    /// messages a second.
    pub fn new(addr: CvAddress, seed: u64, rate: f64, duration: time::Duration) -> NoiseSequencer {
        let noise = signal::noise(seed);
        let start = time::Instant::now();
        NoiseSequencer {
            addr: addr,
            noise: noise,
            rate: rate,
            duration: duration,
            start: start,
        }
    }
}

impl Iterator for NoiseSequencer {
    type Item = OscMessage;

    /// Yield the next message in the sequence.
    fn next(&mut self) -> Option<Self::Item> {
        let now = time::Instant::now();
        if now - self.start >= self.duration {
            return None;
        }
        let frame = self.noise.next();
        let msg = CvMessage::new(self.addr.clone(), frame[0] as f32);
        Some(OscMessage::CvMessage(msg))
    }
}

impl OscMessageSequencer for NoiseSequencer {
    /// Return the duration the sequencer should wait between messages.
    fn delay(&self) -> time::Duration {
        let ms = time::Duration::from_millis(1000 / self.rate as u64);
        ms
    }
}

/// **SawSequencer** generates a sequence of **CvMessage**s
/// representing a saw wave.
/// ```rust
/// use open_sound_module::OscMessageSequencer;
/// use open_sound_module::SawSequencer;
/// use open_sound_module::CvAddress;
/// use std::time;
///
/// fn main() -> Result<(), failure::Error> {
///     let seconds = time::Duration::from_secs(1);
///     let mut saw = SawSequencer::new(CvAddress::A, 4.0, 1.0, seconds);
///     let _msg = saw.next();
///     let _delay = saw.delay();
///     Ok(())  
/// }
/// ```
pub struct SawSequencer {
    addr: CvAddress,
    saw: signal::Saw<ConstHz>,
    rate: f64,
    duration: time::Duration,
    start: time::Instant,
}

impl SawSequencer {
    /// Create a new **SawSequencer** from a **CvAddress**, a rate
    /// a hertz and a duration. The rate is a sample rate that
    /// is used to determine the delay between messages. For
    /// exampe, a sample rate of 4.0 will cause the sequencer
    /// to wait 250ms between messages for a rate of 4
    /// messages a second.
    pub fn new(addr: CvAddress, rate: f64, hz: f64, duration: time::Duration) -> SawSequencer {
        let saw = signal::rate(rate).const_hz(hz).saw();
        let start = time::Instant::now();
        SawSequencer {
            addr: addr,
            saw: saw,
            rate: rate,
            duration: duration,
            start: start,
        }
    }
}

impl Iterator for SawSequencer {
    type Item = OscMessage;

    /// Yield the next message in the sequence.
    fn next(&mut self) -> Option<Self::Item> {
        let now = time::Instant::now();
        if now - self.start >= self.duration {
            return None;
        }
        let frame = self.saw.next();
        let msg = CvMessage::new(self.addr.clone(), frame[0] as f32);
        Some(OscMessage::CvMessage(msg))
    }
}

impl OscMessageSequencer for SawSequencer {
    /// Return the duration the sequence should wait between messages.
    fn delay(&self) -> time::Duration {
        let ms = time::Duration::from_millis(1000 / self.rate as u64);
        ms
    }
}

/// **SineSequencer** generates a sequence of **CvMessage**s
/// representing a sine wave.
/// ```rust
/// use open_sound_module::OscMessageSequencer;
/// use open_sound_module::SineSequencer;
/// use open_sound_module::CvAddress;
/// use std::time;
///  
/// fn main() -> Result<(), failure::Error> {
///     let seconds = time::Duration::from_secs(1);
///     let mut sine = SineSequencer::new(CvAddress::A, 4.0, 1.0, seconds);
///     let _msg = sine.next();
///     let _delay = sine.delay();
///     Ok(())  
/// }
/// ```
pub struct SineSequencer {
    addr: CvAddress,
    sine: signal::Sine<ConstHz>,
    rate: f64,
    duration: time::Duration,
    start: time::Instant,
}

impl SineSequencer {
    /// Create a new **SineSequencer** from a **CvAddress**, a rate
    /// and a hertz. The rate is a sample rate that
    /// is used to determine the delay between messages. For
    /// exampe, a sample rate of 4.0 will cause the OscSeq
    /// to wait 250ms between messages for a rate of 4
    /// messages a second.
    pub fn new(addr: CvAddress, rate: f64, hz: f64, duration: time::Duration) -> SineSequencer {
        let sine = signal::rate(rate).const_hz(hz).sine();
        let start = time::Instant::now();
        SineSequencer {
            addr: addr,
            sine: sine,
            rate: rate,
            duration: duration,
            start: start,
        }
    }
}

impl Iterator for SineSequencer {
    type Item = OscMessage;

    /// Yield the next message in the sequence.
    fn next(&mut self) -> Option<Self::Item> {
        let now = time::Instant::now();
        if now - self.start >= self.duration {
            return None;
        }
        let frame = self.sine.next();
        let msg = CvMessage::new(self.addr.clone(), frame[0] as f32);
        Some(OscMessage::CvMessage(msg))
    }
}

impl OscMessageSequencer for SineSequencer {
    /// Return the duration the sequence should wait between messages.
    fn delay(&self) -> time::Duration {
        let ms = time::Duration::from_millis(1000 / self.rate as u64);
        ms
    }
}

/// **SquareSequencer** generates a sequence of **CvMessage**s
/// representing a square wave.
/// ```rust
/// use open_sound_module::OscMessageSequencer;
/// use open_sound_module::SquareSequencer;
/// use open_sound_module::CvAddress;
/// use std::time;
///  
/// fn main() -> Result<(), failure::Error> {
///     let seconds = time::Duration::from_secs(1);
///     let mut square = SquareSequencer::new(CvAddress::A, 4.0, 1.0, seconds);
///     let _msg = square.next();
///     let _delay = square.delay();
///     Ok(())  
/// }
/// ```
pub struct SquareSequencer {
    addr: CvAddress,
    square: signal::Square<ConstHz>,
    rate: f64,
    duration: time::Duration,
    start: time::Instant,
}

impl SquareSequencer {
    /// Create a new **SquareSequencer** from a **CvAddress**, a rate
    /// and a hertz. The rate is a sample rate that
    /// is used to determine the delay between messages. For
    /// exampe, a sample rate of 4.0 will cause the OscSeq
    /// to wait 250ms between messages for a rate of 4
    /// messages a second.
    pub fn new(addr: CvAddress, rate: f64, hz: f64, duration: time::Duration) -> SquareSequencer {
        let square = signal::rate(rate).const_hz(hz).square();
        let start = time::Instant::now();
        SquareSequencer {
            addr: addr,
            square: square,
            rate: rate,
            duration: duration,
            start: start,
        }
    }
}

impl Iterator for SquareSequencer {
    type Item = OscMessage;

    /// Yield the next message in the sequence.
    fn next(&mut self) -> Option<Self::Item> {
        let now = time::Instant::now();
        if now - self.start >= self.duration {
            return None;
        }
        let frame = self.square.next();
        let msg = CvMessage::new(self.addr.clone(), frame[0] as f32);
        Some(OscMessage::CvMessage(msg))
    }
}

impl OscMessageSequencer for SquareSequencer {
    /// Return the duration the sequence should wait between messages.
    fn delay(&self) -> time::Duration {
        let ms = time::Duration::from_millis(1000 / self.rate as u64);
        ms
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_noise_sequence() -> Result<(), failure::Error> {
        let seconds = time::Duration::from_secs(1);
        let mut gen = NoiseSequencer::new(CvAddress::A, 0, 4.0, seconds);
        let _msg = gen.next().unwrap();
        Ok(())
    }

    #[test]
    fn test_saw_sequence() -> Result<(), failure::Error> {
        let seconds = time::Duration::from_secs(1);
        let mut gen = SawSequencer::new(CvAddress::A, 4.0, 1.0, seconds);
        let _msg = gen.next().unwrap();
        Ok(())
    }

    #[test]
    fn test_sine_sequence() -> Result<(), failure::Error> {
        let seconds = time::Duration::from_secs(1);
        let mut gen = SineSequencer::new(CvAddress::A, 4.0, 1.0, seconds);
        let _msg = gen.next().unwrap();
        Ok(())
    }

    #[test]
    fn test_square_sequence() -> Result<(), failure::Error> {
        let seconds = time::Duration::from_secs(1);
        let mut gen = SquareSequencer::new(CvAddress::A, 4.0, 1.0, seconds);
        let _msg = gen.next().unwrap();
        Ok(())
    }
}