sim-lib-sound-bridge 0.1.1

SIM workspace package for sim lib sound bridge.
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

use std::collections::HashMap;

use sim_lib_sound_timbre::Timbre;

/// A bank mapping MIDI `(bank MSB, bank LSB, program)` selections to timbres,
/// with a fallback for unmapped selections.
///
/// # Examples
///
/// ```
/// use sim_lib_sound_bridge::TimbreBank;
/// use sim_lib_sound_timbre::{pure_sine, sawtooth};
///
/// let mut bank = TimbreBank::new(pure_sine());
/// bank.insert(0, 0, 1, sawtooth(8));
/// assert_eq!(bank.get(0, 0, 1).name, "sawtooth");
/// assert_eq!(bank.get(0, 0, 9).name, "pure_sine");
/// ```
#[derive(Clone, Debug, PartialEq)]
pub struct TimbreBank {
    entries: HashMap<(u8, u8, u8), Timbre>,
    fallback: Timbre,
}

impl TimbreBank {
    /// Builds an empty bank with the given fallback timbre.
    pub fn new(fallback: Timbre) -> Self {
        Self {
            entries: HashMap::new(),
            fallback,
        }
    }

    /// Assigns `timbre` to the given bank/program selection.
    pub fn insert(&mut self, bank_msb: u8, bank_lsb: u8, program: u8, timbre: Timbre) {
        self.entries.insert((bank_msb, bank_lsb, program), timbre);
    }

    /// Returns the timbre for the selection, or the fallback if unmapped.
    pub fn get(&self, bank_msb: u8, bank_lsb: u8, program: u8) -> &Timbre {
        self.entries
            .get(&(bank_msb, bank_lsb, program))
            .unwrap_or(&self.fallback)
    }

    /// Returns the fallback timbre.
    pub fn fallback(&self) -> &Timbre {
        &self.fallback
    }

    /// Returns the mapped entries keyed by bank/program selection.
    pub fn entries(&self) -> &HashMap<(u8, u8, u8), Timbre> {
        &self.entries
    }
}