@k-l-lambda/lilylet 0.1.30

package/source/lilylet/types.ts

@@ -0,0 +1,304 @@
+// === Enums ===
+
+export enum Phonet {
+	c = 'c',
+	d = 'd',
+	e = 'e',
+	f = 'f',
+	g = 'g',
+	a = 'a',
+	b = 'b',
+}
+
+export enum Accidental {
+	natural = 'natural',
+	sharp = 'sharp',
+	flat = 'flat',
+	doubleSharp = 'doubleSharp',
+	doubleFlat = 'doubleFlat',
+}
+
+export enum Clef {
+	treble = 'treble',
+	bass = 'bass',
+	alto = 'alto',
+}
+
+export enum StemDirection {
+	up = 'up',
+	down = 'down',
+	auto = 'auto',
+}
+
+export enum ArticulationType {
+	staccato = 'staccato',
+	staccatissimo = 'staccatissimo',
+	tenuto = 'tenuto',
+	marcato = 'marcato',
+	accent = 'accent',
+	portato = 'portato',
+}
+
+export enum OrnamentType {
+	trill = 'trill',
+	turn = 'turn',
+	mordent = 'mordent',
+	prall = 'prall',
+	fermata = 'fermata',
+	shortFermata = 'shortFermata',
+	arpeggio = 'arpeggio',
+}
+
+export enum DynamicType {
+	ppp = 'ppp',
+	pp = 'pp',
+	p = 'p',
+	mp = 'mp',
+	mf = 'mf',
+	f = 'f',
+	ff = 'ff',
+	fff = 'fff',
+	sfz = 'sfz',
+	rfz = 'rfz',
+}
+
+export enum HairpinType {
+	crescendoStart = 'crescendoStart',
+	crescendoEnd = 'crescendoEnd',
+	diminuendoStart = 'diminuendoStart',
+	diminuendoEnd = 'diminuendoEnd',
+}
+
+export enum PedalType {
+	sustainOn = 'sustainOn',
+	sustainOff = 'sustainOff',
+	sostenutoOn = 'sostenutoOn',
+	sostenutoOff = 'sostenutoOff',
+	unaCordaOn = 'unaCordaOn',
+	unaCordaOff = 'unaCordaOff',
+}
+
+export enum BarlineType {
+	single = '|',
+	double = '||',
+	end = '|.',
+	repeatStart = '.|:',
+	repeatEnd = ':|.',
+	repeatBoth = ':..:'
+}
+
+export enum NavigationMarkType {
+	coda = 'coda',
+	segno = 'segno',
+}
+
+// === Basic Types ===
+
+export interface Fraction {
+	numerator: number;
+	denominator: number;
+}
+
+export interface Pitch {
+	phonet: Phonet;
+	accidental?: Accidental;
+	octave: number; // 0 = middle C octave, positive = higher, negative = lower
+}
+
+export interface Duration {
+	division: number; // 1=whole, 2=half, 4=quarter, 8=eighth, etc.
+	dots: number;		 // 0, 1, or 2
+	tuplet?: Fraction; // e.g., {numerator: 2, denominator: 3} for triplet
+}
+
+// === Placement Direction ===
+
+export enum Placement {
+	above = 'above',
+	below = 'below',
+}
+
+// === Expressive Marks ===
+
+export interface Articulation {
+	markType: 'articulation';
+	type: ArticulationType;
+	placement?: Placement;
+}
+
+export interface Ornament {
+	markType: 'ornament';
+	type: OrnamentType;
+}
+
+export interface Dynamic {
+	markType: 'dynamic';
+	type: DynamicType;
+}
+
+export interface Hairpin {
+	markType: 'hairpin';
+	type: HairpinType;
+}
+
+export interface Tie {
+	markType: 'tie';
+	start: boolean;
+}
+
+export interface Slur {
+	markType: 'slur';
+	start: boolean;
+}
+
+export interface Beam {
+	markType: 'beam';
+	start: boolean;
+}
+
+export interface Pedal {
+	markType: 'pedal';
+	type: PedalType;
+}
+
+export interface Fingering {
+	markType: 'fingering';
+	finger: number;  // 1-5
+	placement?: Placement;
+}
+
+export interface NavigationMark {
+	markType: 'navigation';
+	type: NavigationMarkType;
+}
+
+export interface MarkupMark {
+	markType: 'markup';
+	content: string;
+	placement?: Placement;
+}
+
+export type Mark = Articulation | Ornament | Dynamic | Hairpin | Tie | Slur | Beam | Pedal | Fingering | NavigationMark | MarkupMark;
+
+// === Key Signature ===
+
+export interface KeySignature {
+	pitch: Phonet;
+	accidental?: Accidental;
+	mode: 'major' | 'minor';
+}
+
+// === Tempo ===
+
+export interface Tempo {
+	text?: string;
+	beat?: Duration;
+	bpm?: number;
+}
+
+// === Events ===
+
+export interface NoteEvent {
+	type: 'note';
+	pitches: Pitch[];			 // Single note or chord
+	duration: Duration;
+	marks?: Mark[];
+	grace?: boolean;
+	tremolo?: number;			 // Tremolo division (8, 16, 32, etc.)
+	staff?: number;				 // For cross-staff notation
+	stemDirection?: StemDirection;
+}
+
+export interface RestEvent {
+	type: 'rest';
+	duration: Duration;
+	invisible?: boolean;		// space rest (s)
+	fullMeasure?: boolean;	// full measure rest (R)
+	pitch?: Pitch;					// positioned rest (e.g., g'\rest)
+}
+
+export interface ContextChange {
+	type: 'context';
+	key?: KeySignature;
+	time?: Fraction;
+	clef?: Clef;
+	ottava?: number;				// -1, 0, 1
+	stemDirection?: StemDirection;
+	tempo?: Tempo;
+	staff?: number;					// Staff number for cross-staff notation
+}
+
+export interface TremoloEvent {
+	type: 'tremolo';
+	pitchA: Pitch[];				// First note/chord
+	pitchB: Pitch[];				// Second note/chord
+	count: number;					// Number of repetitions
+	division: number;			 // Note division (16, 32, etc.)
+}
+
+export interface TupletEvent {
+	type: 'tuplet';
+	ratio: Fraction;				// e.g., {numerator: 2, denominator: 3} for triplet
+	events: (NoteEvent | RestEvent)[];
+}
+
+export interface PitchResetEvent {
+	type: 'pitchReset';
+}
+
+export interface BarlineEvent {
+	type: 'barline';
+	style: string;  // "|", "||", "|.", ".|:", ":|.", ":..:", etc.
+}
+
+export interface HarmonyEvent {
+	type: 'harmony';
+	text: string;  // Chord symbol text like "Am7", "Cmaj7", "D/F#"
+}
+
+export interface MarkupEvent {
+	type: 'markup';
+	content: string;  // Text content of the markup
+	placement?: Placement;  // Optional placement (above/below)
+}
+
+export type Event = NoteEvent | RestEvent | ContextChange | TremoloEvent | TupletEvent | PitchResetEvent | BarlineEvent | HarmonyEvent | MarkupEvent;
+
+// === Structure ===
+
+export interface Voice {
+	staff: number;
+	events: Event[];
+}
+
+export interface Metadata {
+	title?: string;
+	subtitle?: string;
+	composer?: string;
+	arranger?: string;
+	lyricist?: string;
+	opus?: string;
+	instrument?: string;
+	genre?: string;
+}
+
+// Part within a measure: can be a single staff or grand staff (multiple staves)
+// When voices have staff > 1, it's a grand staff
+export interface Part {
+	name?: string;
+	voices: Voice[];
+}
+
+// Measure contains parts separated by \\\
+export interface Measure {
+	key?: KeySignature;
+	timeSig?: Fraction;
+	parts: Part[];
+	partial?: boolean;
+}
+
+// Document structure
+export interface LilyletDoc {
+	metadata?: Metadata;
+	measures: Measure[];
+}