Struct libatm::MIDINote

pub struct MIDINote {
    pub note_type: MIDINoteType,
    pub octave: u32,
}

MIDI note

Represents key on a piano, combining a note type with an octave. For example, middle C would be represented as MIDINote { note_type: MIDINoteType::C, octave: 4 }. For a detailed table of MIDI notes and octave numbers, see document here: https://www.cs.cmu.edu/~music/cmsip/readings/Standard-MIDI-file-format-updated.pdf.

Fields

note_type: MIDINoteType

octave: u32

Methods

impl MIDINote

pub fn new(note_type: MIDINoteType, octave: u32) -> MIDINote

Create new MIDINote

Arguments

• note_type: MIDINoteType
• octave: integer between -1 and 9

Examples

// Middle C
let note = libatm::MIDINote::new(libatm::MIDINoteType::C, 4);
assert_eq!(note.convert(), 60);

Notes

The octave parameter is not validated, but must be between -1 and 9 in order to represent a valid MIDI note.

pub fn convert(&self) -> u32

Convert MIDI note to an integer representation (MIDI note number)

Trait Implementations

impl Clone for MIDINote

fn clone(&self) -> MIDINote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<MIDINote> for MIDINote

fn eq(&self, other: &MIDINote) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MIDINote) -> bool

This method tests for !=.

impl Copy for MIDINote

impl Debug for MIDINote

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

Formats the value using the given formatter.

impl FromStr for MIDINote

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.