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
use core::f32;
use core::fmt;
use core::num::Wrapping as w;

use arrayvec::ArrayVec;
use byteorder::{ByteOrder, LittleEndian};
#[cfg(feature = "std")]
use thiserror::Error;

use crate::consts::*;

/// Possible errors.
#[derive(Debug)]
#[cfg_attr(feature = "std", derive(Error))]
pub enum Error {
    #[error("Incorrect file length")]
    FileLength,

    #[error("Invalid waveform")]
    InvalidWaveform,

    #[error("Invalid filter")]
    InvalidFilter,
}

/// A `Song` contains a list of up to 8 `Instruments` and defines the sample
/// length for each row (in the tracker).
#[derive(Debug)]
pub struct Song {
    pub(crate) instruments: [Instrument; NUM_INSTRUMENTS],
    pub(crate) seq_length: usize, // Total number of patterns to play
    pub(crate) quarter_note_length: u32, // In samples
}

/// Contains two `Oscillator`s, a simple `Envelope`, `Effects` and `LFO`. The
/// tracker `Sequence` (up to 48) is defined here, as well as the tracker
/// `Patterns` (up to 10).
pub(crate) struct Instrument {
    pub(crate) osc: [Oscillator; 2],          // Oscillators 0 and 1
    pub(crate) noise_fader: f32,              // Noise Oscillator
    pub(crate) env: Envelope,                 // Envelope
    pub(crate) fx: Effects,                   // Effects
    pub(crate) lfo: LFO,                      // Low-Frequency Oscillator
    pub(crate) seq: [usize; SEQUENCE_LENGTH], // Sequence of patterns
    pub(crate) pat: [Pattern; NUM_PATTERNS],  // List of available patterns
}

/// The `Oscillator` defines the `Instrument` sound.
#[derive(Debug)]
pub(crate) struct Oscillator {
    pub(crate) octave: u8,         // Octave knob
    pub(crate) detune_freq: u8,    // Detune frequency
    pub(crate) detune: f32,        // Detune knob
    pub(crate) envelope: bool,     // Envelope toggle
    pub(crate) volume: f32,        // Volume knob
    pub(crate) waveform: Waveform, // Wave form
}

/// `Envelope` is for compressing the sample amplitude over time.
/// (E.g. raising and lowering volume.)
#[derive(Debug)]
pub(crate) struct Envelope {
    pub(crate) attack: u32,  // Attack
    pub(crate) sustain: u32, // Sustain
    pub(crate) release: u32, // Release
    pub(crate) master: f32,  // Master volume knob
}

/// The `Effects` provide filtering, resonance, and panning.
#[derive(Debug)]
pub(crate) struct Effects {
    pub(crate) filter: Filter,    // Hi, lo, bandpass, or notch toggle
    pub(crate) freq: f32,         // FX Frequency
    pub(crate) resonance: f32,    // FX Resonance
    pub(crate) delay_time: u8,    // Delay time
    pub(crate) delay_amount: f32, // Delay amount
    pub(crate) pan_freq: u8,      // Panning frequency
    pub(crate) pan_amount: f32,   // Panning amount
}

/// `LFO` is a Low-Frequency Oscillator. It can be used to adjust the frequency
/// of `Oscillator` 0 and `Effects` over time.
#[derive(Debug)]
pub(crate) struct LFO {
    pub(crate) osc0_freq: bool,    // Modify Oscillator 0 frequency (FM) toggle
    pub(crate) fx_freq: bool,      // Modify FX frequency toggle
    pub(crate) freq: u8,           // LFO frequency
    pub(crate) amount: f32,        // LFO amount
    pub(crate) waveform: Waveform, // LFO waveform
}

#[cfg(feature = "std")]
impl fmt::Debug for Instrument {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Instrument {{ ")?;
        write!(f, "osc: {:?}, ", self.osc)?;
        write!(f, "env: {:?}, ", self.env)?;
        write!(f, "fx: {:?}, ", self.fx)?;
        write!(f, "lfo: {:?}, ", self.lfo)?;
        write!(f, "pat: {:?}, ", self.pat)?;
        write!(f, "seq: [")?;
        let mut iter = self.seq.iter();
        if let Some(i) = iter.next() {
            write!(f, "{:?}", i)?;
        }
        for i in iter {
            write!(f, ", {:?}", i)?;
        }
        write!(f, "] }}")
    }
}

#[cfg(not(feature = "std"))]
impl fmt::Debug for Instrument {
    fn fmt(&self, _f: &mut fmt::Formatter) -> fmt::Result {
        Ok(())
    }
}

/// Contains the tracker notes (up to 32).
#[derive(Debug)]
pub(crate) struct Pattern {
    pub(crate) notes: [u8; PATTERN_LENGTH],
}

/// Available filters.
#[derive(Debug)]
pub(crate) enum Filter {
    None,
    HighPass,
    LowPass,
    BandPass,
    Notch,
}

/// Available wave forms.
#[derive(Debug)]
pub(crate) enum Waveform {
    Sine,
    Square,
    Saw,
    Triangle,
}

impl Song {
    /// Create a new `Song` from a byte slice.
    ///
    /// ```
    /// use sonant::Song;
    ///
    /// let song = Song::from_slice(include_bytes!("../examples/poseidon.snt"))?;
    /// # Ok::<(), sonant::Error>(())
    /// ```
    pub fn from_slice(slice: &[u8]) -> Result<Self, Error> {
        if slice.len() != SONG_LENGTH {
            return Err(Error::FileLength);
        }

        // Get quarter note length and eighth note length (in samples)
        // This properly handles odd quarter note lengths
        let quarter_note_length = LittleEndian::read_u32(&slice[..HEADER_LENGTH]);
        let quarter_note_length = quarter_note_length - (quarter_note_length % 2);

        let seq_length = slice[HEADER_LENGTH + INSTRUMENT_LENGTH * 8] as usize;
        let mut instruments = ArrayVec::new();
        for i in 0..NUM_INSTRUMENTS {
            instruments.push(load_instrument(slice, i)?);
        }
        let instruments = instruments.into_inner().unwrap();

        Ok(Self {
            instruments,
            seq_length,
            quarter_note_length,
        })
    }
}

fn parse_waveform(waveform: u8) -> Result<Waveform, Error> {
    Ok(match waveform {
        0 => Waveform::Sine,
        1 => Waveform::Square,
        2 => Waveform::Saw,
        3 => Waveform::Triangle,
        _ => return Err(Error::InvalidWaveform),
    })
}

fn load_oscillator(slice: &[u8], i: usize, o: usize) -> Result<Oscillator, Error> {
    let i = i + o * OSCILLATOR_LENGTH;
    let octave = ((w(slice[i]) - w(8)) * w(12)).0;
    let detune_freq = slice[i + 1];
    let detune = f32::from(slice[i + 2]).mul_add(0.2 / 255.0, 1.0);
    let envelope = slice[i + 3] != 0;
    let volume = f32::from(slice[i + 4]) / 255.0;
    let waveform = parse_waveform(slice[i + 5])?;

    Ok(Oscillator {
        octave,
        detune_freq,
        detune,
        envelope,
        volume,
        waveform,
    })
}

fn load_envelope(slice: &[u8], i: usize) -> Envelope {
    let attack = LittleEndian::read_u32(&slice[i..i + 4]);
    let sustain = LittleEndian::read_u32(&slice[i + 4..i + 8]);
    let release = LittleEndian::read_u32(&slice[i + 8..i + 12]);
    let master = f32::from(slice[i + 12]) * 156.0;

    Envelope {
        attack,
        sustain,
        release,
        master,
    }
}

fn load_effects(slice: &[u8], i: usize) -> Result<Effects, Error> {
    let filter = match slice[i] {
        0 => Filter::None,
        1 => Filter::HighPass,
        2 => Filter::LowPass,
        3 => Filter::BandPass,
        4 => Filter::Notch,
        _ => return Err(Error::InvalidFilter),
    };
    let i = i + 3;
    let freq = f32::from_bits(LittleEndian::read_u32(&slice[i..i + 4]));
    let resonance = f32::from(slice[i + 4]) / 255.0;
    let delay_time = slice[i + 5];
    let delay_amount = f32::from(slice[i + 6]) / 255.0;
    let pan_freq = slice[i + 7];
    let pan_amount = f32::from(slice[i + 8]) / 512.0;

    Ok(Effects {
        filter,
        freq,
        resonance,
        delay_time,
        delay_amount,
        pan_freq,
        pan_amount,
    })
}

fn load_lfo(slice: &[u8], i: usize) -> Result<LFO, Error> {
    let osc0_freq = slice[i] != 0;
    let fx_freq = slice[i + 1] != 0;
    let freq = slice[i + 2];
    let amount = f32::from(slice[i + 3]) / 512.0;
    let waveform = parse_waveform(slice[i + 4])?;

    Ok(LFO {
        osc0_freq,
        fx_freq,
        freq,
        amount,
        waveform,
    })
}

fn load_sequence(slice: &[u8], i: usize) -> [usize; SEQUENCE_LENGTH] {
    let mut seq = [0; SEQUENCE_LENGTH];

    slice[i..i + SEQUENCE_LENGTH]
        .iter()
        .enumerate()
        .for_each(|(i, &x)| {
            seq[i] = x as usize;
        });

    seq
}

fn load_pattern(slice: &[u8], i: usize, p: usize) -> Pattern {
    let i = i + p * PATTERN_LENGTH;
    let mut notes = [0; PATTERN_LENGTH];
    notes.copy_from_slice(&slice[i..i + PATTERN_LENGTH]);

    Pattern { notes }
}

fn load_instrument(slice: &[u8], i: usize) -> Result<Instrument, Error> {
    let i = HEADER_LENGTH + i * INSTRUMENT_LENGTH;
    let osc = [load_oscillator(slice, i, 0)?, load_oscillator(slice, i, 1)?];

    let i = i + OSCILLATOR_LENGTH * 2;
    let noise_fader = f32::from(slice[i]) / 255.0;

    let i = i + 4;
    let env = load_envelope(slice, i);

    let i = i + 13;
    let fx = load_effects(slice, i)?;

    let i = i + 12;
    let lfo = load_lfo(slice, i)?;

    let i = i + 5;
    let seq = load_sequence(slice, i);

    let i = i + SEQUENCE_LENGTH;
    let mut pat = ArrayVec::new();
    for j in 0..NUM_PATTERNS {
        pat.push(load_pattern(slice, i, j));
    }
    let pat = pat.into_inner().unwrap();

    Ok(Instrument {
        osc,
        noise_fader,
        env,
        fx,
        lfo,
        seq,
        pat,
    })
}