alex/nih-plug
1
0
Fork 0
Code Activity

Loosen generic bounds on NoteEvent

Browse source 
The `S: SysExMessage` isn't strictly needed. I thought it might make the
usage clearer, but it does introduce more boilerplate than strictly
necessary when working with note events.
This commit is contained in:
Robbert van der Helm 2023-02-01 18:05:45 +01:00
parent 15128edde4
commit 62f7f38a9e
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/midi.rs
View file

@ -39,11 +39,15 @@ pub enum MidiConfig {
/// [`Plugin::MIDI_INPUT`][crate::prelude::Plugin::MIDI_INPUT]. Also check out the /// [`Plugin::MIDI_INPUT`][crate::prelude::Plugin::MIDI_INPUT]. Also check out the
/// [`util`][crate::util] module for convenient conversion functions. /// [`util`][crate::util] module for convenient conversion functions.
/// ///
/// `S` is a MIDI SysEx message type that needs to implement [`SysExMessage`] to allow converting
/// this `NoteEvent` to and from raw MIDI data. `()` is provided as a default implementing for
/// plugins that don't use SysEx.
///
/// All of the timings are sample offsets within the current buffer. Out of bound timings are /// All of the timings are sample offsets within the current buffer. Out of bound timings are
/// clamped to the current buffer's length. All sample, channel and note numbers are zero-indexed. /// clamped to the current buffer's length. All sample, channel and note numbers are zero-indexed.
#[derive(Debug, Clone, Copy, PartialEq)] #[derive(Debug, Clone, Copy, PartialEq)]
#[non_exhaustive] #[non_exhaustive]
pub enum NoteEvent<S: SysExMessage> { pub enum NoteEvent<S> {
/// A note on event, available on [`MidiConfig::Basic`] and up. /// A note on event, available on [`MidiConfig::Basic`] and up.
NoteOn { NoteOn {
timing: u32, timing: u32,
@ -330,7 +334,7 @@ pub enum MidiResult<S: SysExMessage> {
SysEx(S::Buffer, usize), SysEx(S::Buffer, usize),
} }
impl<S: SysExMessage> NoteEvent<S> { impl<S> NoteEvent<S> {
/// Returns the sample within the current buffer this event belongs to. /// Returns the sample within the current buffer this event belongs to.
pub fn timing(&self) -> u32 { pub fn timing(&self) -> u32 {
match self { match self {
@ -378,7 +382,9 @@ impl<S: SysExMessage> NoteEvent<S> {
NoteEvent::MidiSysEx { .. } => None, NoteEvent::MidiSysEx { .. } => None,
} }
} }
}
impl<S: SysExMessage> NoteEvent<S> {
/// Parse MIDI into a [`NoteEvent`]. Supports both basic three bytes messages as well as SysEx. /// Parse MIDI into a [`NoteEvent`]. Supports both basic three bytes messages as well as SysEx.
/// Will return `Err(event_type)` if the parsing failed. /// Will return `Err(event_type)` if the parsing failed.
pub fn from_midi(timing: u32, midi_data: &[u8]) -> Result<Self, u8> { pub fn from_midi(timing: u32, midi_data: &[u8]) -> Result<Self, u8> {