use core::fmt;
use crate::error::{Error, Result};
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Direction {
ToDevice,
FromDevice,
}
impl fmt::Display for Direction {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(match self {
Self::ToDevice => "host to synth",
Self::FromDevice => "synth to host",
})
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum Command {
ControlAppNotifyRequest,
ProgramDumpRequest,
ProgramDumpResponse,
EditBufferDumpRequest,
EditBufferDumpResponse,
GlobalParameterDumpRequest,
GlobalParameterDumpResponse,
SingleUserPatternDumpRequest,
UserPatternDumpResponse,
ProgramBankDumpRequest,
BankProgramNamesDumpRequest,
BankProgramNamesDumpResponse,
SingleProgramNameDumpRequest,
SingleProgramNameDumpResponse,
EditBufferPatternDumpRequest,
ControlAppNotifyResponse,
CalibrationDataDumpRequest,
CalibrationDataDumpResponse,
ChordMemoryDumpRequest,
ChordMemoryDumpResponse,
PolyChordMemoryDumpRequest,
PolyChordMemoryDumpResponse,
}
impl Command {
pub const ALL: &'static [Self] = &[
Self::ControlAppNotifyRequest,
Self::ProgramDumpRequest,
Self::ProgramDumpResponse,
Self::EditBufferDumpRequest,
Self::EditBufferDumpResponse,
Self::GlobalParameterDumpRequest,
Self::GlobalParameterDumpResponse,
Self::SingleUserPatternDumpRequest,
Self::UserPatternDumpResponse,
Self::ProgramBankDumpRequest,
Self::BankProgramNamesDumpRequest,
Self::BankProgramNamesDumpResponse,
Self::SingleProgramNameDumpRequest,
Self::SingleProgramNameDumpResponse,
Self::EditBufferPatternDumpRequest,
Self::ControlAppNotifyResponse,
Self::CalibrationDataDumpRequest,
Self::CalibrationDataDumpResponse,
Self::ChordMemoryDumpRequest,
Self::ChordMemoryDumpResponse,
Self::PolyChordMemoryDumpRequest,
Self::PolyChordMemoryDumpResponse,
];
pub const fn from_byte(byte: u8) -> Result<Self> {
Ok(match byte {
0x00 => Self::ControlAppNotifyRequest,
0x01 => Self::ProgramDumpRequest,
0x02 => Self::ProgramDumpResponse,
0x03 => Self::EditBufferDumpRequest,
0x04 => Self::EditBufferDumpResponse,
0x05 => Self::GlobalParameterDumpRequest,
0x06 => Self::GlobalParameterDumpResponse,
0x07 => Self::SingleUserPatternDumpRequest,
0x08 => Self::UserPatternDumpResponse,
0x09 => Self::ProgramBankDumpRequest,
0x0A => Self::BankProgramNamesDumpRequest,
0x0B => Self::BankProgramNamesDumpResponse,
0x0C => Self::SingleProgramNameDumpRequest,
0x0D => Self::SingleProgramNameDumpResponse,
0x0E => Self::EditBufferPatternDumpRequest,
0x10 => Self::ControlAppNotifyResponse,
0x11 => Self::CalibrationDataDumpRequest,
0x12 => Self::CalibrationDataDumpResponse,
0x1B => Self::ChordMemoryDumpRequest,
0x1C => Self::ChordMemoryDumpResponse,
0x1D => Self::PolyChordMemoryDumpRequest,
0x1E => Self::PolyChordMemoryDumpResponse,
_ => return Err(Error::UnknownCommand(byte)),
})
}
#[must_use]
pub const fn to_byte(self) -> u8 {
match self {
Self::ControlAppNotifyRequest => 0x00,
Self::ProgramDumpRequest => 0x01,
Self::ProgramDumpResponse => 0x02,
Self::EditBufferDumpRequest => 0x03,
Self::EditBufferDumpResponse => 0x04,
Self::GlobalParameterDumpRequest => 0x05,
Self::GlobalParameterDumpResponse => 0x06,
Self::SingleUserPatternDumpRequest => 0x07,
Self::UserPatternDumpResponse => 0x08,
Self::ProgramBankDumpRequest => 0x09,
Self::BankProgramNamesDumpRequest => 0x0A,
Self::BankProgramNamesDumpResponse => 0x0B,
Self::SingleProgramNameDumpRequest => 0x0C,
Self::SingleProgramNameDumpResponse => 0x0D,
Self::EditBufferPatternDumpRequest => 0x0E,
Self::ControlAppNotifyResponse => 0x10,
Self::CalibrationDataDumpRequest => 0x11,
Self::CalibrationDataDumpResponse => 0x12,
Self::ChordMemoryDumpRequest => 0x1B,
Self::ChordMemoryDumpResponse => 0x1C,
Self::PolyChordMemoryDumpRequest => 0x1D,
Self::PolyChordMemoryDumpResponse => 0x1E,
}
}
#[must_use]
pub const fn name(self) -> &'static str {
match self {
Self::ControlAppNotifyRequest => "Control App Notify Request",
Self::ProgramDumpRequest => "Program Dump Request",
Self::ProgramDumpResponse => "Program Dump Response",
Self::EditBufferDumpRequest => "Edit Buffer Dump Request",
Self::EditBufferDumpResponse => "Edit Buffer Dump Response",
Self::GlobalParameterDumpRequest => "Global Parameter Dump Request",
Self::GlobalParameterDumpResponse => "Global Parameter Dump Response",
Self::SingleUserPatternDumpRequest => "Single User Pattern Dump Request",
Self::UserPatternDumpResponse => "User Pattern Dump Response",
Self::ProgramBankDumpRequest => "Program Bank Dump Request",
Self::BankProgramNamesDumpRequest => "Bank Program Names Dump Request",
Self::BankProgramNamesDumpResponse => "Bank Program Names Dump Response",
Self::SingleProgramNameDumpRequest => "Single Program Name Dump Request",
Self::SingleProgramNameDumpResponse => "Single Program Name Dump Response",
Self::EditBufferPatternDumpRequest => "Edit Buffer Pattern Dump Request",
Self::ControlAppNotifyResponse => "Control App Notify Response",
Self::CalibrationDataDumpRequest => "Calibration Data Dump Request",
Self::CalibrationDataDumpResponse => "Calibration Data Dump Response",
Self::ChordMemoryDumpRequest => "Chord Memory Dump Request",
Self::ChordMemoryDumpResponse => "Chord Memory Dump Response",
Self::PolyChordMemoryDumpRequest => "Poly Chord Memory Dump Request",
Self::PolyChordMemoryDumpResponse => "Poly Chord Memory Dump Response",
}
}
#[must_use]
pub const fn direction(self) -> Direction {
match self {
Self::ProgramDumpResponse
| Self::EditBufferDumpResponse
| Self::GlobalParameterDumpResponse
| Self::UserPatternDumpResponse
| Self::BankProgramNamesDumpResponse
| Self::SingleProgramNameDumpResponse
| Self::ControlAppNotifyResponse
| Self::CalibrationDataDumpResponse
| Self::ChordMemoryDumpResponse
| Self::PolyChordMemoryDumpResponse => Direction::FromDevice,
_ => Direction::ToDevice,
}
}
}
impl TryFrom<u8> for Command {
type Error = Error;
fn try_from(byte: u8) -> Result<Self> {
Self::from_byte(byte)
}
}
impl From<Command> for u8 {
fn from(value: Command) -> Self {
value.to_byte()
}
}
impl fmt::Display for Command {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.name())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn every_command_round_trips_through_its_byte() {
for command in Command::ALL.iter().copied() {
assert_eq!(Command::from_byte(command.to_byte()), Ok(command));
}
}
#[test]
fn the_table_is_ordered_by_command_byte_and_has_no_duplicates() {
let mut previous = None;
for command in Command::ALL.iter().copied() {
if let Some(previous) = previous {
assert!(command.to_byte() > previous, "{command} is out of order");
}
previous = Some(command.to_byte());
}
}
#[test]
fn the_gaps_in_the_command_range_are_rejected() {
for byte in [0x0F, 0x13, 0x1A, 0x1F, 0x7F] {
assert_eq!(Command::from_byte(byte), Err(Error::UnknownCommand(byte)));
}
}
#[test]
fn a_response_comes_from_the_device_and_a_request_goes_to_it() {
for command in Command::ALL.iter().copied() {
let expected = if command.name().ends_with("Response") {
Direction::FromDevice
} else {
Direction::ToDevice
};
assert_eq!(command.direction(), expected, "{command}");
}
}
}