Documentation

Position of a Measure within a Song, and the lookup key into a Track's trackBeats map.

Position of a Beat within the list of beats for one measure of one track.

Position of a Track within songTracks.

Which string of a fretted Instrument a Note is played on (0 = lowest or highest string depending on convention used by the caller; this type only pairs with FretNumber to locate a tab cell).

Fret position for a fretted Note, paired with StringIndex.

MIDI channel (0-15) a Track is routed to for playback.

General MIDI program (patch/instrument) number, used by Standard instruments.

MIDI note-on velocity (loudness) for a Note.

Tempo in beats per minute. Appears both as a Song-wide default (songTempo) and as an optional per-Measure override (tempoChange).

Absolute MIDI pitch (0-127, middle C = 60). Used for both the sounding pitch of a Note and the open-string tuning of a fretted Instrument.

Rhythmic duration of a Beat. Dotted and Triplet wrap another Duration rather than being enumerated separately, so e.g. a dotted eighth is Dotted Eighth and a triplet eighth is Triplet Eighth; the two can combine (Dotted (Triplet Eighth)) since nothing restricts nesting.

Major/minor quality of a KeySignature.

Time signature as TimeSignature numerator denominator, e.g. TimeSignature 4 4 for common time.

Key signature as KeySignature accidentals mode, where accidentals is signed count of sharps (positive) or flats (negative) from the circle of fifths, e.g. KeySignature 2 Major is D major (two sharps).

Pitch bend amount in semitones/cents (interpretation is up to the producer/consumer, e.g. the GP5 parser or the audio engine); carried by the Bend NoteEffect.

Variants of slide/legato articulation between fretted notes, used by the Slide NoteEffect.

A single articulation attached to a Note. A note can carry several of these via noteEffects (e.g. a bend into a vibrato).

One played (or fretted) note. notePitch / noteVelocity describe what should sound; noteString / noteFret describe where it sits on the fretboard for tab rendering and are Nothing for non-fretted instruments (see Standard).

A set of Notes that start simultaneously, sharing one Duration. beatIsRest marks silence; when True, beatNotes is expected to be empty.

Metadata for one bar of the Song-wide timeline. This holds the signatures and tempo change for the bar; it does not hold notes — the actual Beats for this bar live in each Track's trackBeats, keyed by this measure's measureIndex.

What a Track is played on. Guitar and Bass are fretted instruments described by their open-string tuning (low to high) and stringCount; their Notes are expected to carry noteString / noteFret. Standard is any non-fretted General MIDI instrument addressed purely by MidiProgram, whose Notes carry only pitch data.

One instrument's part across the whole Song. trackBeats maps each MeasureIndex that this track has content in to the ordered list of Beats for that bar; a measure absent from the map is silent for this track. trackChannel is the MIDI channel used for playback.

A complete tablature/score document: the master bar-by-bar timeline (songMeasures) shared by every track, plus the per-instrument parts (songTracks) that reference it via MeasureIndex. songTempo is the default tempo, overridden per-bar by tempoChange.

A recognized-but-unhandled input file: unsupportedPath is the file that was read and unsupportedReason explains what about its format isn't supported (as opposed to the file simply being malformed, which is ParseErrorMalformed).

Failure result from a module in "Termtab.Parser.*". Distinguishes a format that is understood but deliberately not supported (ParseErrorUnsupported) from input that couldn't be parsed at all (ParseErrorMalformed, carrying a human-readable description).