Struct KeyboardMapping

pub struct KeyboardMapping {
    pub first_midi: i32,
    pub last_midi: i32,
    pub middle_note: i32,
    pub tuning_constant_note: i32,
    pub tuning_frequency: f64,
    pub tuning_pitch: f64,
    pub octave_degrees: i32,
    pub keys: Vec<i32>,
    pub raw_text: String,
    pub name: String,
    /* private fields */
}

The KeyboardMapping struct represents a KBM file.

In most cases, the salient features are the KeyboardMapping::tuning_constant_note and KeyboardMapping::tuning_frequency, which allow you to pick a fixed note in the MIDI keyboard when retuning. The KBM file can also remap individual keys to individual points in a scale, which here is done with the keys vector.

Just as with Scale the KeyboardMapping::raw_text member contains the text of the KBM file used.

Fields

first_midi: i32

First MIDI note to be mapped.

last_midi: i32

Last MIDI note to be mapped.

middle_note: i32

Middle MIDI note.

tuning_constant_note: i32

MIDI note to be tuned.

tuning_frequency: f64

Frequency of the tuned note.

tuning_pitch: f64

Pitch of the tuned note. Equal to tuning_frequency / MIDI_0_FREQ.

octave_degrees: i32

Number of octave degrees.

keys: Vec<i32>

Mapped keys. Rather than an ‘x’, we use a ‘-1’ for skipped notes (this should use Option or similar).

raw_text: String

Raw text of the KBM file.

name: String

Name of the mapping.

Implementations

impl KeyboardMapping

pub fn new() -> Self

Constructs a default KeyboardMapping.

pub fn count(&self) -> usize

Number of keys in the mapping.

pub fn read_kbm_file<P>(fname: P) -> Result<Self, TuningError>

where P: AsRef<Path>,

Returns a KeyboardMapping or an error from a KBM file in fname.

pub fn parse_kbm_data(kbm_contents: &str) -> Result<Self, TuningError>

Returns a KeyboardMapping or an error from a KBM data in memory.

pub fn tune_a69_to(freq: f64) -> Self

Creates a KeyboardMapping which keeps the MIDI note 60 (A4) set to a constant given frequency.

pub fn tune_note_to(midi_note: i32, freq: f64) -> Self

Creates a KeyboardMapping which keeps the MIDI note given set to a constant given frequency.

pub fn start_scale_on_and_tune_note_to( scale_start: i32, midi_note: i32, freq: f64, ) -> Self

Generates a KBM where scale_start is the note 0 of the scale, where midi_note is the tuned note, and where freq is the frequency.

Trait Implementations

impl Clone for KeyboardMapping

fn clone(&self) -> KeyboardMapping

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyboardMapping

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

Formats the value using the given formatter.

impl Default for KeyboardMapping

fn default() -> KeyboardMapping

Returns the “default value” for a type.