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
use crate::Instrument;
/// Stable identity used to release or retrigger a note.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub struct VoiceId(pub u64);
/// A control event for [`crate::Synth`].
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Event {
/// Start a voice, replacing any currently active voice with the same ID.
NoteOn {
/// Identity later supplied to [`Event::NoteOff`].
id: VoiceId,
/// Preset to synthesize.
instrument: Instrument,
/// Positive finite fundamental frequency in hertz.
frequency_hz: f32,
/// Finite linear gain in the inclusive range `0.0..=1.0`.
gain: f32,
},
/// Put all voices with this identity into their release phase.
NoteOff(VoiceId),
/// Set the pitch offset for every active voice with this identity.
PitchBend {
/// Identity of the voice to retune without restarting it.
id: VoiceId,
/// Pitch offset in semitones, in `-128.0..=128.0`.
semitones: f32,
},
/// Set 5.5 Hz vibrato depth, up to ±0.5 semitone, for every active voice
/// with this identity.
Modulation {
/// Identity of the voice to modulate without restarting it.
id: VoiceId,
/// Normalized modulation-wheel amount, in `0.0..=1.0`.
amount: f32,
},
/// Put every active voice into its release phase.
AllNotesOff,
}
/// An event positioned relative to the beginning of one output block.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct TimedEvent {
/// Sample at which to apply the event; `output.len()` means block end.
pub sample_offset: usize,
/// Event to apply.
pub event: Event,
}
impl TimedEvent {
/// Construct a timed event.
#[must_use]
pub const fn new(sample_offset: usize, event: Event) -> Self {
Self {
sample_offset,
event,
}
}
}
/// A configuration or event-stream error.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ProcessError {
/// The sample rate was non-finite, below 1 Hz, or above 768 kHz.
InvalidSampleRate,
/// A zero-sized voice pool was requested.
ZeroVoices,
/// A zero-channel audio processor was requested.
ZeroChannels,
/// A zero-sized MIDI mapping layer set was requested.
ZeroMidiLayers,
/// A processing block did not match the configured channel count.
ChannelCountMismatch,
/// Channels in a processing block had different lengths.
ChannelLengthMismatch,
/// A requested frame range was reversed or outside the block.
InvalidFrameRange,
/// Reverb amount was non-finite or outside `0.0..=1.0`.
InvalidReverbAmount,
/// Distortion drive was non-finite or outside `1.0..=20.0`.
InvalidDistortionDrive,
/// Compressor amount was non-finite or outside `0.0..=1.0`.
InvalidCompressorAmount,
/// An equalizer band gain was non-finite or outside `-12.0..=12.0` dB.
InvalidEqGain,
/// A note frequency was not positive and finite.
InvalidFrequency,
/// A gain was non-finite or outside `0.0..=1.0`.
InvalidGain,
/// A pitch bend was non-finite or outside `-128.0..=128.0` semitones.
InvalidPitchBend,
/// A modulation amount was non-finite or outside `0.0..=1.0`.
InvalidModulation,
/// Timed events were not in nondecreasing sample-offset order.
EventsNotOrdered,
/// An event offset was greater than the output block length.
EventOutsideBlock,
}
impl core::fmt::Display for ProcessError {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
f.write_str(match self {
Self::InvalidSampleRate => "sample rate must be finite and in 1..=768000 Hz",
Self::ZeroVoices => "voice capacity must be nonzero",
Self::ZeroChannels => "audio channel count must be nonzero",
Self::ZeroMidiLayers => "MIDI layer capacity must be nonzero",
Self::ChannelCountMismatch => "audio block channel count does not match configuration",
Self::ChannelLengthMismatch => "audio channels must have equal lengths",
Self::InvalidFrameRange => "frame range is outside the audio block",
Self::InvalidReverbAmount => "reverb amount must be finite and in 0..=1",
Self::InvalidDistortionDrive => "distortion drive must be finite and in 1..=20",
Self::InvalidCompressorAmount => "compressor amount must be finite and in 0..=1",
Self::InvalidEqGain => "equalizer gains must be finite and in -12..=12 dB",
Self::InvalidFrequency => "frequency must be positive and finite",
Self::InvalidGain => "gain must be finite and in 0..=1",
Self::InvalidPitchBend => "pitch bend must be finite and in -128..=128 semitones",
Self::InvalidModulation => "modulation amount must be finite and in 0..=1",
Self::EventsNotOrdered => "events must be ordered by sample offset",
Self::EventOutsideBlock => "event sample offset is outside the block",
})
}
}
impl std::error::Error for ProcessError {}