omusic package

Submodules

omusic.chord module

Utilities that construct chords.

omusic.chord.reach_many(root: str, interval_list: Sequence[str]) → list[str][source]

Obtain nodes by repeatedly reaching up from root.

Useful for building triads and scales from description.

For each named interval in interval_list, call reach(root, interval) and collect the result. At the end, return collected results in order.

omusic.chord.count_triad_major(root: str) → list[str][source]

omusic.chord.count_triad_minor(root: str) → list[str][source]

omusic.chord.count_triad_augmented(root: str) → list[str][source]

omusic.chord.count_triad_diminished(root: str) → list[str][source]

omusic.chord.invert(triad: list[str]) → list[str][source]

omusic.chord.invert_triad_to(triad: list[str], note: str) → list[str][source]

Construct a triad.

Parameters:

add – Positions of notes in scale to add, 0 indexed.
sus – Positions of notes in scale to remove, 0 indexed
intervals – Positions of notes in scale to remove

omusic.chord.seventh(base_key: str, progression: list[int], type: Literal['major'] | Literal['minor'] | Literal['augmented'] | Literal['diminished'] | None = None, add: int | list[int] = [], sub: int | list[int] = [], intervals: str | list[str] = [], order: int = 0) → list[str][source]

omusic.chord.neapolitan_chord(base_key: str, intervals: list[int]) → list[str][source]

omusic.chord.count_seventh_dominant(root: str) → list[str][source]

omusic.chord.count_seventh_major(root: str) → list[str][source]

omusic.chord.count_seventh_minor(root: str) → list[str][source]

omusic.chord.count_seventh_half_diminished(root: str) → list[str][source]

omusic.chord.count_seventh_diminished(root: str) → list[str][source]

omusic.chord.count_seventh_minor_major(root: str) → list[str][source]

omusic.chord.count_seventh_augmented_major(root: str) → list[str][source]

omusic.chord.count_seventh_augmented_minor(root: str) → list[str][source]

omusic.chord.power(root: str) → list[str][source]

Return the power chord from root.

A power chord has no major and minor qualities, because it always consists of the root and a perfect fifth.

omusic.chord.rewop(root: str) → list[str][source]: Inverse of power(). Useful for, for example, adding bass to a note.

omusic.guesser module

class omusic.guesser.MatchResult[source]

Bases: NamedTuple

MatchResult(base, mode, matched, unused, unmatched)

base: str: Base note of the matched scale / chord

mode: str: Mode of the matched scale / chord

matched: set[str]: Matching notes

unused: set[str]: Notes that are in the matched scale / chord, but not in the subject

unmatched: set[str]: Notes that are in the subject, but not in the matched scale / chord

omusic.guesser.guess(subject: set[str], test_scales: ScaleSpec, sort_key: Literal['matched'] | Literal['unused'] | Literal['unmatched'] | Literal['matched_percent'] = 'matched') → list[MatchResult][source]

Check which scale or chord may be have produced subject.

The returned list is ordered by sort_key. See MatchResult for options. matched_percent uses the ratio of matched notes against unused notes.

Parameters:

subject – A set of note classes
test_scales – Scales and chords to compare subject against

omusic.guesser.tabulate_guess(result: list[MatchResult], tablefmt: str = 'simple') → None[source]

omusic.guitar module

Utilities that visualise notes on a fretboard.

omusic.guitar.notes_on_string(start: int, capo: int, length: int) → list[int][source]: Return a list of length notes on a string that begins with the start ^th note at capo capo.

omusic.guitar.notes_on_fretboard(capo: int, length: int, tuning: list[int]) → list[list[int]][source]

Return a matrix of notes for all strings on a guitar for the given tuning.

The item at [i][j] is the j^th note on the i^th string … I think.

omusic.guitar.notes_of_interest(notes: list[str], octave_matrix: list[list[int]], strict: bool = False) → list[list[int | None]][source]

Given a matrix of notes, replace items that are not in the given scale with None, then return the result.

Use to visualise chords.

omusic.guitar.disseminate_neural_lattices(height: int, length: int)[source]: Render the local neighbourhood structure of a Riemannian topological manifold.

omusic.guitar.draw_key_at_location(reverse_string_loc: int, fret_loc: int, key_name: str)[source]

omusic.guitar.draw_dot_at_location(reverse_string_loc: float, fret_loc: float, **kwargs)[source]

omusic.guitar.draw_capo(capo: int) → None[source]

omusic.guitar.draw_scale(scale: list[str], capo: int, width: int, strict: bool = False) → None[source]

omusic.midi module

Utilities that play MIDI notes.

class omusic.midi.Instrument[source]

Bases: IntEnum

Instrument codes implemented with reference to the General MIDI Level 1 specification (source).

AcousticGrandPiano = 1

BrightAcousticPiano = 2

ElectricGrandPiano = 3

HonkyTonkPiano = 4

ElectricPiano1 = 5

ElectricPiano2 = 6

Harpsichord = 7

Clavi = 8

Celesta = 9

Glockenspiel = 10

MusicBox = 11

Vibraphone = 12

Marimba = 13

Xylophone = 14

TubularBells = 15

Dulcimer = 16

DrawbarOrgan = 17

PercussiveOrgan = 18

RockOrgan = 19

ChurchOrgan = 20

ReedOrgan = 21

Accordion = 22

Harmonica = 23

TangoAccordion = 24

AcousticGuitarNylon = 25

AcousticGuitarSteel = 26

ElectricGuitarJazz = 27

ElectricGuitarClean = 28

ElectricGuitarMuted = 29

OverdrivenGuitar = 30

DistortionGuitar = 31

Guitarharmonics = 32

AcousticBass = 33

ElectricBassFinger = 34

ElectricBassPick = 35

FretlessBass = 36

SlapBass1 = 37

SlapBass2 = 38

SynthBass1 = 39

SynthBass2 = 40

Violin = 41

Viola = 42

Cello = 43

Contrabass = 44

TremoloStrings = 45

PizzicatoStrings = 46

OrchestralHarp = 47

Timpani = 48

StringEnsemble1 = 49

StringEnsemble2 = 50

SynthStrings1 = 51

SynthStrings2 = 52

ChoirAahs = 53

VoiceOohs = 54

SynthVoice = 55

OrchestraHit = 56

Trumpet = 57

Trombone = 58

Tuba = 59

MutedTrumpet = 60

FrenchHorn = 61

BrassSection = 62

SynthBrass1 = 63

SynthBrass2 = 64

SopranoSax = 65

AltoSax = 66

TenorSax = 67

BaritoneSax = 68

Oboe = 69

EnglishHorn = 70

Bassoon = 71

Clarinet = 72

Piccolo = 73

Flute = 74

Recorder = 75

PanFlute = 76

BlownBottle = 77

Shakuhachi = 78

Whistle = 79

Ocarina = 80

Lead1Square = 81

Lead2Sawtooth = 82

Lead3Calliope = 83

Lead4Chiff = 84

Lead5Charang = 85

Lead6Voice = 86

Lead7Fifths = 87

Lead8BassPlusLead = 88

Pad1Newage = 89

Pad2Warm = 90

Pad3Polysynth = 91

Pad4Choir = 92

Pad5Bowed = 93

Pad6Metallic = 94

Pad7Halo = 95

Pad8Sweep = 96

FX1Rain = 97

FX2Soundtrack = 98

FX3Crystal = 99

FX4Atmosphere = 100

FX5Brightness = 101

FX6Goblins = 102

FX7Echoes = 103

FX8SciFi = 104

Sitar = 105

Banjo = 106

Shamisen = 107

Koto = 108

Kalimba = 109

Bagpipe = 110

Fiddle = 111

Shanai = 112

TinkleBell = 113

Agogo = 114

SteelDrums = 115

Woodblock = 116

TaikoDrum = 117

MelodicTom = 118

SynthDrum = 119

ReverseCymbal = 120

GuitarFretNoise = 121

BreathNoise = 122

Seashore = 123

BirdTweet = 124

TelephoneRing = 125

Helicopter = 126

Applause = 127

Gunshot = 128

omusic.midi.port()[source]

class omusic.midi.Player[source]

Bases: object

__init__(port: str = 'Microsoft GS Wavetable Synth 0', pool_size: int = 6)[source]

omusic.midi.play(player: Player, sound: str | list[str], duration: float = 2, gap: float = 0, velocity: int = 64) → None[source]

omusic.midi.change_instrument(player: Player, instrument: Instrument) → None[source]

omusic.modes module

Patterns that are useful for constructing scales and chords.

A scale is constructed with a note and one such pattern (for example, C major consists of the note C as well as the 2^nd, 4^th, 5^th … and so on, notes from C.) This pattern is the mode (or key) of the scale.

Whereas scales (see scale) are constructed by picking notes in a music space, chords are (see chord) constructed by picking notes from a scale. Both (scale) and (chord) can use constants defined in this module.

omusic.modes.pentatonic_major(hep: list[int]) → list[int][source]

omusic.modes.pentatonic_minor(hep: list[int]) → list[int][source]

omusic.modes.blues_major(hep: list[int]) → list[int][source]

omusic.modes.blues_minor(hep: list[int]) → list[int][source]

omusic.modes.harmonic_minor(minor_scale: list[int]) → list[int][source]

omusic.modes.melodic_minor(minor_scale: list[int]) → list[int][source]

omusic.scale module

Utilities that construct scales.

omusic.scale.scale(base_key: str, intervals: list[int]) → list[str][source]

Module contents

In this text, a number can mean one of three things:

A note (2 for “Re”, or D).
An interval (2 for “two notes from the previous note”).
An offset (“two notes from the first note”).

To differentiate these, use type “aliases” defined in the following cell instead of int.

omusic.Pitch: A pitch, representing a note by its position in NOTES.

omusic.note_m2s(note: int) → str[source]

omusic.note_s2m(note: str) → int[source]

omusic.note_i2s(note: Note | None) → str[source]
omusic.note_i2s(note: Sequence[Note | None]) → list[str]: Return either a string or a list of strings that represents note(s) in note.

omusic.note_s2i(name: str, solfege: bool = False) → Note[source]
omusic.note_s2i(name: list[str], solfege: bool = False) → list[Note]: Return either an integer or a list of notes that represents note(s) in name.

omusic.NOTES = ['C0', 'C#0', 'D0', 'D#0', 'E0', 'F0', 'F#0', 'G0', 'G#0', 'A0', 'A#0', 'B0', 'C1', 'C#1', 'D1', 'D#1', 'E1', 'F1', 'F#1', 'G1', 'G#1', 'A1', 'A#1', 'B1', 'C2', 'C#2', 'D2', 'D#2', 'E2', 'F2', 'F#2', 'G2', 'G#2', 'A2', 'A#2', 'B2', 'C3', 'C#3', 'D3', 'D#3', 'E3', 'F3', 'F#3', 'G3', 'G#3', 'A3', 'A#3', 'B3', 'C4', 'C#4', 'D4', 'D#4', 'E4', 'F4', 'F#4', 'G4', 'G#4', 'A4', 'A#4', 'B4', 'C5', 'C#5', 'D5', 'D#5', 'E5', 'F5', 'F#5', 'G5', 'G#5', 'A5', 'A#5', 'B5', 'C6', 'C#6', 'D6', 'D#6', 'E6', 'F6', 'F#6', 'G6', 'G#6', 'A6', 'A#6', 'B6', 'C7', 'C#7', 'D7', 'D#7', 'E7', 'F7', 'F#7', 'G7', 'G#7', 'A7', 'A#7', 'B7', 'C8', 'C#8', 'D8', 'D#8', 'E8', 'F8', 'F#8', 'G8', 'G#8', 'A8', 'A#8', 'B8', 'C9', 'C#9', 'D9', 'D#9', 'E9', 'F9', 'F#9', 'G9', 'G#9', 'A9', 'A#9', 'B9', 'C10', 'C#10', 'D10', 'D#10', 'E10', 'F10', 'F#10', 'G10']: Map of each apartness to a name. The entry apartness: (major/minor, number) means apartness apartness is the major/minor number ^th.

omusic.interval_s2i(name: str) → int[source]

omusic.interval_i2s(key_num: int) → list[str][source]: Map an apartness to the appropriate name according to INTERVALS.

omusic.name_interval(note_from: str, note_to: str) → str[source]: Map an apartness to the appropriate name according to INTERVALS.

omusic.interval_from_scale(scale: list[str], poses: tuple[int, int]) → list[str][source]

omusic.invert(arg: str) → str[source]

omusic.invert(arg: Note) → Note

Invert an interval. Or a note.

Works with both because taking the modular complement happens to have the same effect on both.

omusic.reach(base_key: str, interval: str | int) → str[source]

“Reach up” from base_key by interval. interval can be either a number (e.g. 1) or a string (e.g. augmented 8).

In the latter case, interval should be a key in INTERVALS.

omusic.match_out_numbers(expr: str) → str[source]

omusic.same_class(a: list[str], b: list[str]) → bool[source]
omusic.same_class(a: str, b: str) → bool