ksynth 0.18.0

Patch manipulation for Kawai digital synths
Documentation 
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

//! Data model for a PCM source oscillator.
//!

use std::convert::TryFrom;
use std::fmt;

use num_enum::TryFromPrimitive;
use pretty_hex::*;

use crate::{
    SystemExclusiveData,
    ParseError
};
use crate::k5000::pitch::Envelope as PitchEnvelope;
use crate::k5000::{
    Coarse,
    Fine
};
use crate::k5000::wave::Wave;
use crate::k5000::source::Key;

/// Fixed key for oscillator.
#[derive(Debug)]
pub enum FixedKey {
    Off,
    On(Key)
}

impl fmt::Display for FixedKey {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let s = match self {
            FixedKey::Off => String::from("OFF"),
            FixedKey::On(key) => key.name(),
        };
        write!(f, "{}", &s)
    }
}

impl SystemExclusiveData for FixedKey {
    fn from_bytes(data: &[u8]) -> Result<Self, ParseError> {
        if data[0] == 0x00 {
            Ok(FixedKey::Off)
        }
        else {
            Ok(FixedKey::On(Key { note: data[0] - 21 }))
        }
    }

    fn to_bytes(&self) -> Vec<u8> {
        match self {
            FixedKey::Off => vec![0x00],
            FixedKey::On(key) => vec![key.note + 21],
        }
    }

    fn data_size() -> usize { 1 }
}

/// PCM oscillator.
#[derive(Debug)]
pub struct Oscillator {
    pub wave: Wave,
    pub coarse: Coarse,
    pub fine: Fine,
    pub ks_to_pitch: KeyScaling,
    pub fixed_key: FixedKey,
    pub pitch_envelope: PitchEnvelope,
}

impl Oscillator {
    /// Makes a new oscillator with default values for PCM.
    pub fn new() -> Oscillator {
        Oscillator {
            wave: Wave { number: 384 },
            coarse: Coarse::new(0),
            fine: Fine::new(0),
            ks_to_pitch: KeyScaling::ZeroCent,
            fixed_key: FixedKey::Off,
            pitch_envelope: PitchEnvelope::new(),
        }
    }

    /// Makes a new oscillator with default values for ADD.
    pub fn additive() -> Oscillator {
        Oscillator {
            wave: Wave { number: 512 }, // ADD
            coarse: Coarse::new(0),
            fine: Fine::new(0),
            fixed_key: FixedKey::Off,
            ks_to_pitch: KeyScaling::ZeroCent,
            pitch_envelope: PitchEnvelope::new(),
        }
    }
}

impl Default for Oscillator {
    fn default() -> Self {
        Oscillator::new()
    }
}

impl fmt::Display for Oscillator {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Wave={}\nKS Pitch={}\nFixed Key={}\nCoarse={} Fine={}\nPitch Envelope: {}",
            self.wave, self.ks_to_pitch, self.fixed_key, self.coarse, self.fine, self.pitch_envelope)
    }
}

impl SystemExclusiveData for Oscillator {
    fn from_bytes(data: &[u8]) -> Result<Self, ParseError> {
        eprintln!("OSC data = {}", simple_hex(&data));
        Ok(Oscillator {
            wave: Wave::from_bytes(&[data[0], data[1]])?,
            coarse: Coarse::from(data[2]),
            fine: Fine::from(data[3]),
            fixed_key: FixedKey::from_bytes(&[data[4]])?,
            ks_to_pitch: KeyScaling::try_from(data[5]).unwrap(),
            pitch_envelope: PitchEnvelope::from_bytes(&data[6..])?,
        })
    }

    fn to_bytes(&self) -> Vec<u8> {
        let mut result: Vec<u8> = Vec::new();

        result.extend(self.wave.to_bytes());
        result.push(self.coarse.into());
        result.push(self.fine.into());
        result.extend(self.fixed_key.to_bytes());
        result.push(self.ks_to_pitch as u8);
        result.extend(self.pitch_envelope.to_bytes());

        result
    }

    fn data_size() -> usize {
        Wave::data_size()
        + 4
        + PitchEnvelope::data_size()
    }
}

/// Key scaling type.
#[derive(Debug, Eq, PartialEq, Copy, Clone, TryFromPrimitive)]
#[repr(u8)]
pub enum KeyScaling {
    ZeroCent = 0,
    TwentyFiveCent = 1,
    ThirtyTreeCent = 2,
    FiftyCent = 3,
}

impl fmt::Display for KeyScaling {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", match self {
            KeyScaling::ZeroCent => String::from("0ct"),
            KeyScaling::TwentyFiveCent => String::from("25ct"),
            KeyScaling::ThirtyTreeCent => String::from("33ct"),
            KeyScaling::FiftyCent => String::from("50ct")
        })
    }
}