- Quick summary
- 0.1
- Learn Markdown
- For the most part, arguments are passed in as strings. The exception being midi note values which are integers between 0-127
- Pitches are formatted pitch+octave. For example, middle C is 'C4'.
- Intervals use the following table as reference:
| Interval Type | Modifier | Example |
|---|---|---|
| Major | M | M3 (major 3rd) |
| Minor | m | m3 (minor 3rd) |
| Perfect | p | p5 (perfect 5th) |
| Diminished | dim | dim5 (diminished 5th) |
| Augmented | aug | aug4 (augmented 4th) |
| Function name | Description | Arguments |
|---|---|---|
midiToNote() |
Converts midi (0-127) to pitch (note/octave) | 'integer', 'type' (flat/sharp) NOTE: Type is optional and defaults to 'sharp' |
noteToMidi() |
Converts a pitch to a midi value | pitch eg. 'C#4' |
splitPitch() |
Converts a note value to an array with separated pitch and octave values | 'note' eg. 'C4' |
compareNotes() |
Returns 0 if the midi value of two notes are the same eg. Comparing C#4 and Db4 will return 0 | 'noteA', 'noteB' |
getInterval() |
Returns the calculated interval between two pitches | 'root pitch', 'interval pitch', 'adjust octave' |
getNoteFromInterval() |
Returns the pitch of an interval | 'root_pitch', 'interval' eg. 'p5' |
getScale() |
Returns an array of pitches | 'scale_name', 'root', 'octave' |
getRootFromInterval() |
Returns the root of an interval eg. getRootFromInterval('G4','p5') will return 'C4' | 'note', 'interval' |
chordFromNotes() [experimental] |
Returns the chord name | 'arr' eg. ['C4','E4','G4'] |
- Uncomment the last line of MDSTheory.js for testing in Node.js
//For Testing in Node.js only
module.exports = MDSTheory;
- Standard 3 clause BSD license