API Reference
Values
Abstract musical values, independent of any particular musical system.
| values.tone.tone | |
| values.tone.interval | The relationship between two tones. |
| values.tone.silent_tone | SilentTone represents a rest or other notated silence |
| values.tone.unpitched_tone | A sound with no pitch. |
| values.tone.tone_collection | |
| values.tone.modal_context | The modal context a passage is heard in. |
| values.time.duration | |
| values.time.clock_time | Durations based on clock time. |
| values.text.word | |
| values.scoring.mark | |
| values.scoring.division_shape | How a notation system draws a division in a sequence. |
| values.scoring.tempo_term | A verbal tempo indication as it appears in a notation system’s vocabulary. |
| values.scoring.clef | What fixes the meaning of the lines of a staff. |
Western Standard Music Notation
The WSMN implementation of the abstract values.
| systems.wsmn.tonal.tonal_vector | |
| systems.wsmn.tonal.tonal_arithmetic | Add and subtract intervals, chromae, notes. |
| systems.wsmn.tonal.interval_quality | The quality of a WSMN interval: perfect, major, minor, augmented, diminished, and so on. |
| systems.wsmn.tonal.chords | |
| systems.wsmn.tonal.key | |
| systems.wsmn.tonal.symbols | Ready-to-go pitch and interval designations. |
| systems.wsmn.temporal.metrical_duration | |
| systems.wsmn.temporal.time_signature | |
| systems.wsmn.temporal.symbols | Ready-to-go note durations, tuplet ratios, and time signatures. |
| systems.wsmn.scoring.bar_line_shape | WSMN bar lines: what is drawn at a division. |
| systems.wsmn.scoring.staff_clef | WSMN clefs: a sign on a line of the five-line staff. |
| systems.wsmn.scoring.symbols | Ready-to-go marks (articulations, dynamics, ornaments, techniques, |
| systems.wsmn.percussion.percussion_tone | An unpitched sound as Western notation distinguishes it. |
| systems.wsmn.percussion.symbols | Ready-made percussion tones, and the palettes of tones meaningful for a |
Objects
Score objects, the things that become nodes in the graph.
| objects.omk_object | |
| objects.note_event | |
| objects.chord_event | |
| objects.context_event | |
| objects.division_event | |
| objects.lyrics | |
| objects.marking | |
| objects.part | |
| objects.score | |
| objects.sync_line | A timing origin with no musical content, and the instants on it. |
Graph
The score graph and its edges.
| graph.graph | |
| graph.edge | |
| graph.equivalence | Whether two graphs hold the same music, whatever the ids of their objects. |
| graph.graph_adapter | |
| graph.rx_adapter |
Input and Output
Reading and writing interchange formats.
| io.musicxml | MusicXML in and out: read a file into an OmkGraph holding one Score, |
| io.musicxml.reader | MusicXML in: a <score-partwise> document becomes an OmkGraph holding one Score. |
| io.musicxml.writer | MusicXML out: one Score of an OmkGraph becomes a <score-partwise> document. |
| io.musicxml.canonical | Comparing MusicXML documents for the music they hold, not how they spell it. |
| io.musicxml.tables | What MusicXML calls things and what WSMN calls them. |
| io.musicxml.container | Opening and packing a MusicXML file: plain XML or the compressed .mxl zip. |
| io.omk_json | OMK JSON: a published, language-neutral format for OMK graphs. |
| io.omk_json.document | The OMK JSON document (format specification §5, §8, §10–11): |
| io.omk_json.vocabulary | Vocabularies (format specification §6–7), and the encoder and decoder that |
| io.omk_json.core | The omk vocabulary (docs/spec/vocabulary-omk.qmd): every node type, |
| io.omk_json.wsmn | The wsmn vocabulary (docs/spec/vocabulary-wsmn.qmd): |
| io.omk_json.canonical | The canonical text of a JSON value, and a strict parser, |
| io.omk_json.primitives | The primitive types of the format specification (§4): each as a pair of |
Visualization
Pictures of a graph, laid out by Graphviz.
| visualization.renderer | The public entry point: an OmkGraph and a VisualizationConfig in, |
| visualization.config | What a visualization looks like: the sequence direction, the styles of |
| visualization.labels | Default labels for the nodes of a visualization, |
| visualization.layout | From an OmkGraph to a DotGraph: the one place that knows what OMK’s |
| visualization.dot | A minimal model of a Graphviz DOT graph, and its text. |
| visualization.graphviz | Rendering DOT through the local Graphviz dot executable. |
Errors and Utilities
| errors | Exceptions and warnings raised by OpenMusicKit. |
| utils.number_names |