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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

//! The note enum and associated helper methods

use std::mem;

/// A note representable in a 7 bit unsigned int. The subscript 's' to a note means sharp. The
/// subscript 'n' to an octave means negate, so `Cs2n` = C# in octave -2.
///
/// Because it only uses the least significant 7 bits, any value can be interpreted as either an i8
/// or a u8 for free (as the representation is the same in both)
///
/// This implements both From<u8>, Into<u8>, From<i8> and Into<i8> so the names can be completely
/// ignored if prefered
#[repr(u8)]
#[derive(Debug, PartialEq, Copy, Clone)]
pub enum Note {
    C2n = 0x00,
    Cs2n = 0x01,
    D2n = 0x02,
    Ds2n = 0x03,
    E2n = 0x04,
    F2n = 0x05,
    Fs2n = 0x06,
    G2n = 0x07,
    Gs2n = 0x08,
    A1n = 0x09,
    As1n = 0x0A,
    B1n = 0x0B,
    C1n = 0x0C,
    Cs1n = 0x0D,
    D1n = 0x0E,
    Ds1n = 0x0F,
    E1n = 0x10,
    F1n = 0x11,
    Fs1n = 0x12,
    G1n = 0x13,
    Gs1n = 0x14,
    /// Start of 88-note piano keyboard range
    A0 = 0x15,
    As0 = 0x16,
    B0 = 0x17,
    C0 = 0x18,
    Cs0 = 0x19,
    D0 = 0x1A,
    Ds0 = 0x1B,
    E0 = 0x1C,
    F0 = 0x1D,
    Fs0 = 0x1E,
    G0 = 0x1F,
    Gs0 = 0x20,
    A1 = 0x21,
    As1 = 0x22,
    B1 = 0x23,
    /// Start of 5 octave synth range
    C1 = 0x24,
    Cs1 = 0x25,
    D1 = 0x26,
    Ds1 = 0x27,
    E1 = 0x28,
    F1 = 0x29,
    Fs1 = 0x2A,
    G1 = 0x2B,
    Gs1 = 0x2C,
    A2 = 0x2D,
    As2 = 0x2E,
    B2 = 0x2F,
    C2 = 0x30,
    Cs2 = 0x31,
    D2 = 0x32,
    Ds2 = 0x33,
    E2 = 0x34,
    F2 = 0x35,
    Fs2 = 0x36,
    G2 = 0x37,
    Gs2 = 0x38,
    A3 = 0x39,
    As3 = 0x3A,
    B3 = 0x3B,
    /// Middle C
    C3 = 0x3C,
    Cs3 = 0x3D,
    D3 = 0x3E,
    Ds3 = 0x3F,
    E3 = 0x40,
    F3 = 0x41,
    Fs3 = 0x42,
    G3 = 0x43,
    Gs3 = 0x44,
    A4 = 0x45,
    As4 = 0x46,
    B4 = 0x47,
    C4 = 0x48,
    Cs4 = 0x49,
    D4 = 0x4A,
    Ds4 = 0x4B,
    E4 = 0x4C,
    F4 = 0x4D,
    Fs4 = 0x4E,
    G4 = 0x4F,
    Gs4 = 0x50,
    A5 = 0x51,
    As5 = 0x52,
    B5 = 0x53,
    C5 = 0x54,
    Cs5 = 0x55,
    D5 = 0x56,
    Ds5 = 0x57,
    E5 = 0x58,
    F5 = 0x59,
    Fs5 = 0x5A,
    G5 = 0x5B,
    Gs5 = 0x5C,
    A6 = 0x5D,
    As6 = 0x5E,
    B6 = 0x5F,
    /// end of 5 octave synth range
    C6 = 0x60,
    Cs6 = 0x61,
    D6 = 0x62,
    Ds6 = 0x63,
    E6 = 0x64,
    F6 = 0x65,
    Fs6 = 0x66,
    G6 = 0x67,
    Gs6 = 0x68,
    A7 = 0x69,
    As7 = 0x6A,
    B7 = 0x6B,
    /// end of 88-note piano keyboard range
    C7 = 0x6C,
    Cs7 = 0x6D,
    D7 = 0x6E,
    Ds7 = 0x6F,
    E7 = 0x70,
    F7 = 0x71,
    Fs7 = 0x72,
    G7 = 0x73,
    Gs7 = 0x74,
    A8 = 0x75,
    As8 = 0x76,
    B8 = 0x77,
    C8 = 0x78,
    Cs8 = 0x79,
    D8 = 0x7A,
    Ds8 = 0x7B,
    E8 = 0x7C,
    F8 = 0x7D,
    Fs8 = 0x7E,
    G8 = 0x7F
}

impl From<u8> for Note {
    #[inline(always)]
    fn from(n: u8) -> Note {
        // Could alternatively mask with 0x7F to remove top bit (is this better?)
        if n > 0x7F {
            panic!("Not valid note");
        }
        unsafe { mem::transmute(n) }
    }
}

impl Into<u8> for Note {
    #[inline(always)]
    fn into(self) -> u8 {
        self as u8
    }
}

impl From<i8> for Note {
    #[inline(always)]
    fn from(n: i8) -> Note {
        // Could alternatively mask with 0x7F to remove top bit (is this better?)
        if n < 0x00 {
            panic!("Not valid note");
        }
        unsafe { mem::transmute(n) }
    }
}

impl Into<i8> for Note {
    #[inline(always)]
    fn into(self) -> i8 {
        // may be faster to use mem::transmute
        self as i8
    }
}