rytm-rs 0.1.3

More than safe rust abstractions over rytm-sys, an unofficial SDK for Analog Rytm MKII running firmware 1.70
Documentation
use crate::{
    error::{ConversionError, ParameterError, RytmError},
    object::pattern::plock::ParameterLockPool,
    util::{
        from_s_u16_t, get_u16_min_max_from_float_range, scale_f32_to_u16, scale_u16_to_f32,
        to_s_u16_t_union_a,
    },
    RytmError::OrphanTrig,
};
use derivative::Derivative;
use parking_lot::Mutex;
use rytm_rs_macro::{machine_parameters, parameter_range};
use rytm_sys::ar_sound_t;
use serde::{Deserialize, Serialize};
use std::sync::Arc;

#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize)]
pub enum BdAcousticWaveform {
    #[default]
    SinA,
    SinB,
    AsinA,
    AsinB,
    TriA,
    TriB,
    SsawA,
    SsawB,
    SawA,
    SawB,
    SqrA,
    SqrB,
}

impl TryFrom<&str> for BdAcousticWaveform {
    type Error = ConversionError;
    fn try_from(value: &str) -> Result<Self, Self::Error> {
        match value {
            "sina" => Ok(Self::SinA),
            "sinb" => Ok(Self::SinB),
            "asina" => Ok(Self::AsinA),
            "asinb" => Ok(Self::AsinB),
            "tria" => Ok(Self::TriA),
            "trib" => Ok(Self::TriB),
            "ssawa" => Ok(Self::SsawA),
            "ssawb" => Ok(Self::SsawB),
            "sawa" => Ok(Self::SawA),
            "sawb" => Ok(Self::SawB),
            "sqra" => Ok(Self::SqrA),
            "sqrb" => Ok(Self::SqrB),
            _ => Err(ConversionError::Range {
                value: value.to_string(),
                type_name: "BdAcousticWaveform".into(),
            }),
        }
    }
}

impl TryFrom<u8> for BdAcousticWaveform {
    type Error = ConversionError;
    fn try_from(value: u8) -> Result<Self, Self::Error> {
        match value {
            0 => Ok(Self::SinA),
            1 => Ok(Self::SinB),
            2 => Ok(Self::AsinA),
            3 => Ok(Self::AsinB),
            4 => Ok(Self::TriA),
            5 => Ok(Self::TriB),
            6 => Ok(Self::SsawA),
            7 => Ok(Self::SsawB),
            8 => Ok(Self::SawA),
            9 => Ok(Self::SawB),
            10 => Ok(Self::SqrA),
            11 => Ok(Self::SqrB),
            _ => Err(ConversionError::Range {
                value: value.to_string(),
                type_name: "BdAcousticWaveform".into(),
            }),
        }
    }
}

impl From<BdAcousticWaveform> for u8 {
    fn from(value: BdAcousticWaveform) -> Self {
        match value {
            BdAcousticWaveform::SinA => 0,
            BdAcousticWaveform::SinB => 1,
            BdAcousticWaveform::AsinA => 2,
            BdAcousticWaveform::AsinB => 3,
            BdAcousticWaveform::TriA => 4,
            BdAcousticWaveform::TriB => 5,
            BdAcousticWaveform::SsawA => 6,
            BdAcousticWaveform::SsawB => 7,
            BdAcousticWaveform::SawA => 8,
            BdAcousticWaveform::SawB => 9,
            BdAcousticWaveform::SqrA => 10,
            BdAcousticWaveform::SqrB => 11,
        }
    }
}

#[machine_parameters(
    lev: "0..=127" #1,
    tun: "-32.0..=32.0" #2,
    dec: "0..=127" #3,
    hld: "0..=127" #4,
    swt: "0..=127" #5,
    swd: "0..=127" #6,
    // wav #7
    imp: "0..=127" #8,
)]
/// Parameters for the `BdAcoustic` machine.
#[derive(Derivative, Clone, Serialize, Deserialize)]
#[derivative(Debug)]
pub struct BdAcousticParameters {
    lev: u8,
    tun: f32,
    dec: u8,
    hld: u8,
    swt: u8,
    swd: u8,
    wav: BdAcousticWaveform,
    imp: u8,

    #[derivative(Debug = "ignore")]
    #[serde(skip)]
    parameter_lock_pool: Option<Arc<Mutex<ParameterLockPool>>>,
    assigned_track: Option<usize>,
}

impl Default for BdAcousticParameters {
    fn default() -> Self {
        Self {
            lev: 100,
            tun: -3.0,
            dec: 64,
            hld: 64,
            swt: 80,
            swd: 92,
            wav: BdAcousticWaveform::default(),
            imp: 64,
            parameter_lock_pool: None,
            assigned_track: None,
        }
    }
}

impl BdAcousticParameters {
    pub(crate) fn link_parameter_lock_pool(&mut self, pool: Arc<Mutex<ParameterLockPool>>) {
        self.parameter_lock_pool = Some(pool);
    }

    pub(crate) fn apply_to_raw_sound(&self, raw_sound: &mut ar_sound_t) {
        self.apply_to_raw_sound_values(raw_sound);
        let wav: u8 = self.wav.into();
        raw_sound.synth_param_7 = to_s_u16_t_union_a((wav as u16) << 8);
    }

    /// Sets the `wav` parameter.
    pub fn set_wav(&mut self, wav: BdAcousticWaveform) {
        self.wav = wav;
    }

    /// Returns the `wav` parameter.
    pub const fn get_wav(&self) -> BdAcousticWaveform {
        self.wav
    }

    /// Sets the parameter lock for the `wav` parameter.
    pub fn plock_set_wav(
        &self,
        wav: BdAcousticWaveform,
        trig_index: usize,
    ) -> Result<(), RytmError> {
        if let Some(ref pool) = self.parameter_lock_pool {
            let assigned_track = self.assigned_track.ok_or(OrphanTrig)?;
            pool.lock().set_basic_plock(
                trig_index,
                assigned_track as u8,
                rytm_sys::AR_PLOCK_TYPE_MP6 as u8,
                wav.into(),
            )?;
            return Ok(());
        }
        Err(OrphanTrig)
    }

    /// Gets the parameter lock for the `wav` parameter.
    pub fn plock_get_wav(
        &self,
        trig_index: usize,
    ) -> Result<Option<BdAcousticWaveform>, RytmError> {
        if let Some(ref pool) = self.parameter_lock_pool {
            let assigned_track = self.assigned_track.ok_or(OrphanTrig)?;
            let wav = pool.lock().get_basic_plock(
                trig_index,
                assigned_track as u8,
                rytm_sys::AR_PLOCK_TYPE_MP6 as u8,
            );
            if let Some(wav) = wav {
                return Ok(Some(wav.try_into()?));
            }
            return Ok(None);
        }
        Err(OrphanTrig)
    }

    /// Clears the parameter lock for the `wav` parameter if set.
    pub fn plock_clear_wav(&self, trig_index: usize) -> Result<(), RytmError> {
        if let Some(ref pool) = self.parameter_lock_pool {
            let assigned_track = self.assigned_track.ok_or(OrphanTrig)?;
            pool.lock().clear_basic_plock(
                trig_index,
                assigned_track as u8,
                rytm_sys::AR_PLOCK_TYPE_MP6 as u8,
            );
            return Ok(());
        }
        Err(OrphanTrig)
    }

    #[parameter_range(range = "track_index[opt]:0..=11")]
    pub(crate) fn from_raw_sound(
        raw_sound: &ar_sound_t,
        track_index: Option<usize>,
    ) -> Result<Self, RytmError> {
        let output_tun_min: f32 = -32.;
        let output_tun_max: f32 = 32.;
        let (input_tun_min, input_tun_max) =
            get_u16_min_max_from_float_range(output_tun_min, output_tun_max);
        unsafe {
            Ok(Self {
                parameter_lock_pool: None,
                assigned_track: track_index,
                lev: (from_s_u16_t(raw_sound.synth_param_1) >> 8) as u8,
                tun: scale_u16_to_f32(
                    from_s_u16_t(raw_sound.synth_param_2),
                    input_tun_min,
                    input_tun_max,
                    output_tun_min,
                    output_tun_max,
                ),
                dec: (from_s_u16_t(raw_sound.synth_param_3) >> 8) as u8,
                hld: (from_s_u16_t(raw_sound.synth_param_4) >> 8) as u8,
                swt: (from_s_u16_t(raw_sound.synth_param_5) >> 8) as u8,
                swd: (from_s_u16_t(raw_sound.synth_param_6) >> 8) as u8,
                wav: ((from_s_u16_t(raw_sound.synth_param_7) >> 8) as u8).try_into()?,
                imp: (from_s_u16_t(raw_sound.synth_param_8) >> 8) as u8,
            })
        }
    }
}