Struct tune::scala::Kbm[−][src]

pub struct Kbm { /* fields omitted */ }

Keyboard mappings according to http://www.huygens-fokker.org/scala/help.htm#mappings.

To better understand how keyboard mappings work have a look at the documented methods of this struct.

For more specialized linear keyboard mappings use KbmRoot.

Implementations

`impl Kbm`[src]

`pub fn builder(kbm_root: impl Into<KbmRoot>) -> KbmBuilder`[src]

`pub fn kbm_root(&self) -> KbmRoot`[src]

`pub fn set_kbm_root(&mut self, kbm_root: KbmRoot)`[src]

`pub fn range(&self) -> Range<PianoKey>`[src]

`pub fn range_iter( &self ) -> impl DoubleEndedIterator<Item = PianoKey> + ExactSizeIterator<Item = PianoKey> + 'static`[src]

`pub fn formal_octave(&self) -> i16`[src]

`pub fn num_items(&self) -> u16`[src]

`pub fn scale_degree_of(&self, key: PianoKey) -> Option<i32>`[src]

Returns the scale degree for the given PianoKey .

Examples

let kbm = Kbm::builder(Note::from_midi_number(62))
   .range(PianoKey::from_midi_number(10)..PianoKey::from_midi_number(100))

   // KBM degree 0 maps to SCL degree 0
   .push_mapped_key(0)

   // KBM degree 1 maps to SCL degree 4
   .push_mapped_key(4)

   // KBM degree 2 is unmapped
   .push_unmapped_key()

   // KBM degree 3 maps to SCL degree 4 again (!)
   .push_mapped_key(4)

   // A KBM degree shift of 4 (num_items) leads to an SCL degree shift of 17 (formal_octave)
   .formal_octave(17)

   .build()
   .unwrap();

assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(10)), Some(-221));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(60)), None);
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(61)), Some(-13));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(62)), Some(0));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(63)), Some(4));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(64)), None);
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(65)), Some(4));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(66)), Some(17));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(67)), Some(21));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(68)), None);
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(99)), Some(157));

// Not in the range 10..100
for midi_number in (0..10).chain(100..128) {
    assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(midi_number)), None);
}

// If the mapping is empty, a linear mapping is assumed.
let empty_kbm = Kbm::builder(Note::from_midi_number(62))

    // This has no effect
    .formal_octave(42)

    .build()
    .unwrap();

assert_eq!(empty_kbm.scale_degree_of(PianoKey::from_midi_number(61)), Some(-1));
assert_eq!(empty_kbm.scale_degree_of(PianoKey::from_midi_number(62)), Some(0));
assert_eq!(empty_kbm.scale_degree_of(PianoKey::from_midi_number(63)), Some(1));

`pub fn import(reader: impl Read) -> Result<Self, KbmImportError>`[src]

Imports the given file in KBM format.

let input = &[
    "!A comment",
    "  !An indented comment",
    "6 <- Official map size. Can be larger than the number of provided mapping entries!",
    "10",
    "99 (Rust's Range type is right exclusive. The upper bound becomes 100.)",
    "62",
    "  69  ",
    "432.0 = healing frequency",
    "17",
    "! Start of the mapping table",
    "0",
    "4",
    "x means unmapped",
    "4",
    "X - uppercase is supported",
    "! End of the mapping table. 'x'es are added to match the official map size.",
];

let kbm = Kbm::import(input.join("\n").as_bytes()).unwrap();

assert_eq!(kbm.kbm_root().origin.midi_number(), 62);
assert_approx_eq!(kbm.kbm_root().ref_pitch.as_hz(), 432.0);
assert_eq!(kbm.kbm_root().ref_degree, 7);
assert_eq!(kbm.range().start.midi_number(), 10);
assert_eq!(kbm.range().end.midi_number(), 100);
assert_eq!(kbm.formal_octave(), 17);
assert_eq!(kbm.num_items(), 6);
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(62)), Some(0));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(63)), Some(4));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(64)), None);
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(65)), Some(4));
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(66)), None);
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(67)), None);
assert_eq!(kbm.scale_degree_of(PianoKey::from_midi_number(68)), Some(17));

`pub fn export(&self) -> KbmExport<'_>`[src]

Exports the current keyboard mapping in KBM file format.

Examples

let mut kbm_root = KbmRoot::from(Note::from_midi_number(69).at_pitch(Pitch::from_hz(432.0)))
    .shift_origin_by(-9);

// White keys on 22-edo
let kbm = Kbm::builder(kbm_root)
   .range(PianoKey::from_midi_number(10)..PianoKey::from_midi_number(100))
   .push_mapped_key(0)
   .push_unmapped_key()
   .push_mapped_key(4)
   .push_unmapped_key()
   .push_mapped_key(8)
   .push_mapped_key(9)
   // ... etc.
   .formal_octave(22)
   .build()
   .unwrap();

assert_eq!(
    format!("{}", kbm.export()).lines().collect::<Vec<_>>(),
    ["6", "10", "99", "60", "69", "432.000", "22", "0", "x", "4", "x", "8", "9"]
);

Trait Implementations

`impl Clone for Kbm`[src]

`fn clone(&self) -> Kbm`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Kbm`[src]

`fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Kbm`

`impl Send for Kbm`

`impl Sync for Kbm`

`impl Unpin for Kbm`

`impl UnwindSafe for Kbm`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

Struct tune::scala::Kbm[−][src]

Implementations

impl Kbm[src]

pub fn builder(kbm_root: impl Into<KbmRoot>) -> KbmBuilder[src]

pub fn kbm_root(&self) -> KbmRoot[src]

pub fn set_kbm_root(&mut self, kbm_root: KbmRoot)[src]

pub fn range(&self) -> Range<PianoKey>[src]

pub fn range_iter( &self) -> impl DoubleEndedIterator<Item = PianoKey> + ExactSizeIterator<Item = PianoKey> + 'static[src]

pub fn formal_octave(&self) -> i16[src]

pub fn num_items(&self) -> u16[src]

pub fn scale_degree_of(&self, key: PianoKey) -> Option<i32>[src]

Examples

pub fn import(reader: impl Read) -> Result<Self, KbmImportError>[src]

pub fn export(&self) -> KbmExport<'_>[src]

Examples

Trait Implementations

impl Clone for Kbm[src]

fn clone(&self) -> Kbm[src]

pub fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Kbm[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result[src]

Auto Trait Implementations

impl RefUnwindSafe for Kbm

impl Send for Kbm

impl Sync for Kbm

impl Unpin for Kbm

impl UnwindSafe for Kbm

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

pub fn to_owned(&self) -> T[src]

pub fn clone_into(&self, target: &mut T)[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

`impl Kbm`[src]

`pub fn builder(kbm_root: impl Into<KbmRoot>) -> KbmBuilder`[src]

`pub fn kbm_root(&self) -> KbmRoot`[src]

`pub fn set_kbm_root(&mut self, kbm_root: KbmRoot)`[src]

`pub fn range(&self) -> Range<PianoKey>`[src]

`pub fn range_iter( &self ) -> impl DoubleEndedIterator<Item = PianoKey> + ExactSizeIterator<Item = PianoKey> + 'static`[src]

`pub fn formal_octave(&self) -> i16`[src]

`pub fn num_items(&self) -> u16`[src]

`pub fn scale_degree_of(&self, key: PianoKey) -> Option<i32>`[src]

`pub fn import(reader: impl Read) -> Result<Self, KbmImportError>`[src]

`pub fn export(&self) -> KbmExport<'_>`[src]

`impl Clone for Kbm`[src]

`fn clone(&self) -> Kbm`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Kbm`[src]

`fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

`impl RefUnwindSafe for Kbm`

`impl Send for Kbm`

`impl Sync for Kbm`

`impl Unpin for Kbm`

`impl UnwindSafe for Kbm`

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]