@libraz/libcantus 0.9.0 → 0.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. package/README.md +25 -2
  2. package/dist/analyze/index.cjs +1697 -0
  3. package/dist/analyze/index.cjs.map +1 -0
  4. package/dist/analyze/index.d.cts +429 -0
  5. package/dist/analyze/index.d.ts +429 -0
  6. package/dist/analyze/index.js +51 -0
  7. package/dist/analyze/index.js.map +1 -0
  8. package/dist/chunk-5HTNMQW4.js +653 -0
  9. package/dist/chunk-5HTNMQW4.js.map +1 -0
  10. package/dist/chunk-7Y7WF64D.js +410 -0
  11. package/dist/chunk-7Y7WF64D.js.map +1 -0
  12. package/dist/chunk-A4532ZFR.js +259 -0
  13. package/dist/chunk-A4532ZFR.js.map +1 -0
  14. package/dist/chunk-BHUT2S5G.js +22 -0
  15. package/dist/chunk-BHUT2S5G.js.map +1 -0
  16. package/dist/chunk-CCBLVAPK.js +42 -0
  17. package/dist/chunk-CCBLVAPK.js.map +1 -0
  18. package/dist/chunk-COKTX2G5.js +907 -0
  19. package/dist/chunk-COKTX2G5.js.map +1 -0
  20. package/dist/chunk-DYWFNC4A.js +152 -0
  21. package/dist/chunk-DYWFNC4A.js.map +1 -0
  22. package/dist/chunk-GQKN5KDT.js +159 -0
  23. package/dist/chunk-GQKN5KDT.js.map +1 -0
  24. package/dist/chunk-LN7ZZMD2.js +530 -0
  25. package/dist/chunk-LN7ZZMD2.js.map +1 -0
  26. package/dist/chunk-MSWFZF7J.js +118 -0
  27. package/dist/chunk-MSWFZF7J.js.map +1 -0
  28. package/dist/chunk-R3S2LUBH.js +2722 -0
  29. package/dist/chunk-R3S2LUBH.js.map +1 -0
  30. package/dist/chunk-SDM3VJJ5.js +41 -0
  31. package/dist/chunk-SDM3VJJ5.js.map +1 -0
  32. package/dist/chunk-XTC3X6MS.js +816 -0
  33. package/dist/chunk-XTC3X6MS.js.map +1 -0
  34. package/dist/chunk-ZXW5YIWK.js +55 -0
  35. package/dist/chunk-ZXW5YIWK.js.map +1 -0
  36. package/dist/core/index.cjs +432 -0
  37. package/dist/core/index.cjs.map +1 -0
  38. package/dist/core/index.d.cts +210 -0
  39. package/dist/core/index.d.ts +210 -0
  40. package/dist/core/index.js +73 -0
  41. package/dist/core/index.js.map +1 -0
  42. package/dist/function-2bJW1Zp_.d.ts +187 -0
  43. package/dist/function-r2sh-jOO.d.cts +187 -0
  44. package/dist/generate/index.cjs +3787 -0
  45. package/dist/generate/index.cjs.map +1 -0
  46. package/dist/generate/index.d.cts +980 -0
  47. package/dist/generate/index.d.ts +980 -0
  48. package/dist/generate/index.js +52 -0
  49. package/dist/generate/index.js.map +1 -0
  50. package/dist/index-BMPxwjwV.d.ts +151 -0
  51. package/dist/index-BOBXBNwP.d.cts +157 -0
  52. package/dist/index-BdeQ1r_p.d.cts +56 -0
  53. package/dist/index-BreoJRw0.d.ts +127 -0
  54. package/dist/index-CGMZNCx6.d.cts +140 -0
  55. package/dist/index-CGMZNCx6.d.ts +140 -0
  56. package/dist/index-CM5W4rcm.d.ts +157 -0
  57. package/dist/index-CP3wAfEH.d.ts +56 -0
  58. package/dist/index-Cl7mhOFM.d.cts +164 -0
  59. package/dist/index-Cl7mhOFM.d.ts +164 -0
  60. package/dist/index-DZ1M21do.d.cts +127 -0
  61. package/dist/index-D_ZTUNKp.d.cts +151 -0
  62. package/dist/index.cjs +5277 -4893
  63. package/dist/index.cjs.map +1 -1
  64. package/dist/index.d.cts +14 -2621
  65. package/dist/index.d.ts +14 -2621
  66. package/dist/index.js +170 -6152
  67. package/dist/index.js.map +1 -1
  68. package/dist/model/index.cjs +2435 -0
  69. package/dist/model/index.cjs.map +1 -0
  70. package/dist/model/index.d.cts +630 -0
  71. package/dist/model/index.d.ts +630 -0
  72. package/dist/model/index.js +21 -0
  73. package/dist/model/index.js.map +1 -0
  74. package/dist/styled-BjXtOFNk.d.cts +282 -0
  75. package/dist/styled-D7BAx3S3.d.ts +282 -0
  76. package/dist/theory/index.cjs +1677 -0
  77. package/dist/theory/index.cjs.map +1 -0
  78. package/dist/theory/index.d.cts +535 -0
  79. package/dist/theory/index.d.ts +535 -0
  80. package/dist/theory/index.js +149 -0
  81. package/dist/theory/index.js.map +1 -0
  82. package/dist/types-MGP29r3t.d.cts +30 -0
  83. package/dist/types-MGP29r3t.d.ts +30 -0
  84. package/package.json +31 -1
  85. package/src/analyze/arrange/index.ts +21 -0
  86. package/src/analyze/arrange/internal.ts +125 -0
  87. package/src/analyze/arrange/tension.ts +187 -0
  88. package/src/analyze/arrange/tracks.ts +279 -0
  89. package/src/{detect → analyze/detect}/index.ts +82 -23
  90. package/src/analyze/functional/borrowed.ts +84 -0
  91. package/src/analyze/functional/cadence.ts +66 -0
  92. package/src/analyze/functional/function.ts +184 -0
  93. package/src/analyze/functional/index.ts +23 -0
  94. package/src/analyze/functional/internal.ts +29 -0
  95. package/src/analyze/functional/roman.ts +393 -0
  96. package/src/analyze/index.ts +49 -0
  97. package/src/{timeline → analyze/timeline}/index.ts +87 -24
  98. package/src/{analysis → analyze/voice}/index.ts +81 -12
  99. package/src/core/index.ts +47 -0
  100. package/src/{interval → core/interval}/index.ts +15 -1
  101. package/src/{meter → core/meter}/index.ts +108 -5
  102. package/src/{pitch → core/pitch}/index.ts +58 -3
  103. package/src/{random → core/random}/index.ts +13 -1
  104. package/src/{tuning → core/tuning}/index.ts +28 -1
  105. package/src/{bass → generate/bass}/index.ts +66 -17
  106. package/src/{countermelody → generate/countermelody}/index.ts +54 -24
  107. package/src/{drums → generate/drums}/fills.ts +31 -20
  108. package/src/{drums → generate/drums}/index.ts +127 -9
  109. package/src/{drums → generate/drums}/internal.ts +7 -1
  110. package/src/{drums → generate/drums}/rng.ts +2 -2
  111. package/src/{drums → generate/drums}/swing.ts +7 -2
  112. package/src/{groove → generate/groove}/index.ts +118 -22
  113. package/src/{harmonize → generate/harmonize}/index.ts +96 -23
  114. package/src/generate/index.ts +59 -0
  115. package/src/{motif → generate/motif}/index.ts +94 -17
  116. package/src/{progression → generate/progression}/index.ts +61 -27
  117. package/src/{reharmony → generate/reharmony}/index.ts +46 -15
  118. package/src/{rhythm → generate/rhythm}/index.ts +47 -13
  119. package/src/index.ts +130 -116
  120. package/src/model/chord.ts +423 -0
  121. package/src/model/index.ts +5 -947
  122. package/src/model/interval.ts +82 -0
  123. package/src/model/key.ts +266 -0
  124. package/src/model/note.ts +176 -0
  125. package/src/model/progression.ts +161 -0
  126. package/src/model/shared.ts +12 -0
  127. package/src/{chord → theory/chord}/index.ts +85 -4
  128. package/src/{chordscale → theory/chordscale}/index.ts +67 -9
  129. package/src/{counterpoint → theory/counterpoint}/index.ts +23 -2
  130. package/src/{harmony → theory/harmony}/index.ts +19 -2
  131. package/src/theory/index.ts +107 -0
  132. package/src/{safety → theory/safety}/index.ts +59 -12
  133. package/src/theory/scale/degrees.ts +123 -0
  134. package/src/theory/scale/index.ts +28 -0
  135. package/src/theory/scale/key.ts +56 -0
  136. package/src/theory/scale/masks.ts +153 -0
  137. package/src/{spelling → theory/spelling}/index.ts +21 -3
  138. package/src/{symbol → theory/symbol}/index.ts +91 -36
  139. package/src/theory/voicing/index.ts +5 -0
  140. package/src/theory/voicing/internal.ts +168 -0
  141. package/src/theory/voicing/leading.ts +112 -0
  142. package/src/theory/voicing/satb.ts +195 -0
  143. package/src/theory/voicing/styled.ts +176 -0
  144. package/src/arrange/index.ts +0 -409
  145. package/src/functional/index.ts +0 -602
  146. package/src/scale/index.ts +0 -215
  147. package/src/voicing/index.ts +0 -523
  148. /package/src/{types.ts → core/types.ts} +0 -0
  149. /package/src/{drums → generate/drums}/beat.ts +0 -0
  150. /package/src/{drums → generate/drums}/euclid.ts +0 -0
  151. /package/src/{drums → generate/drums}/ghost.ts +0 -0
  152. /package/src/{drums → generate/drums}/hihat.ts +0 -0
  153. /package/src/{drums → generate/drums}/hit.ts +0 -0
  154. /package/src/{drums → generate/drums}/kick.ts +0 -0
  155. /package/src/{drums → generate/drums}/percussion.ts +0 -0
@@ -0,0 +1,140 @@
1
+ /**
2
+ * Pitch spelling: letter-name notes, enharmonic-aware conversion, and spelled
3
+ * intervals.
4
+ *
5
+ * The rest of the library works in pitch classes (0..11), which cannot tell a
6
+ * G# from an Ab or an augmented fourth from a diminished fifth. This module adds
7
+ * an explicit spelling layer — a note is a diatonic letter plus a chromatic
8
+ * alteration — so interval quality (P/M/m/A/d) and enharmonic identity are
9
+ * preserved.
10
+ */
11
+ /**
12
+ * A spelled note: a diatonic letter, a chromatic alteration, and an optional
13
+ * octave.
14
+ *
15
+ * - `letter` is 0..6 for C..B.
16
+ * - `alter` is the number of semitones of alteration: -2 double-flat, -1 flat,
17
+ * 0 natural, +1 sharp, +2 double-sharp.
18
+ * - `octave` follows scientific pitch notation (middle C = C4 = MIDI 60). When
19
+ * absent, the note denotes a bare pitch class.
20
+ *
21
+ * @category Pitch & Intervals
22
+ */
23
+ type Note = {
24
+ letter: number;
25
+ alter: number;
26
+ octave?: number;
27
+ };
28
+ /**
29
+ * A spelled interval: a diatonic number, a quality label, and its semitone span.
30
+ *
31
+ * @category Pitch & Intervals
32
+ */
33
+ type SpelledInterval = {
34
+ /** Diatonic size: 1 = unison, 2 = second, ... 8 = octave, and beyond. */
35
+ number: number;
36
+ /** Quality label: 'P', 'M', 'm', or repeated 'A'/'d' for (multiply) aug/dim. */
37
+ quality: string;
38
+ /** Signed semitone distance from the first note to the second. */
39
+ semitones: number;
40
+ };
41
+ /**
42
+ * Parse scientific pitch notation into a {@link Note}.
43
+ *
44
+ * Accepts a letter (case-insensitive) followed by any number of same-direction
45
+ * accidentals and an optional octave, e.g. `"C"`, `"C#4"`, `"Bb"`, `"F##3"`,
46
+ * `"Ebb2"`. Both `#` and `x` (double-sharp) are accepted for sharps; `b` for
47
+ * flats. Mixing sharps and flats (e.g. `"C#b"`) is rejected.
48
+ *
49
+ * @param text The note text.
50
+ * @returns The parsed note.
51
+ * @throws If the text is not a valid note.
52
+ * @example
53
+ * ```ts
54
+ * import { parseNote, noteToMidi } from '@libraz/libcantus';
55
+ * const n = parseNote('C#4');
56
+ * noteToMidi(n); // 61
57
+ * ```
58
+ * @category Pitch & Intervals
59
+ */
60
+ declare function parseNote(text: string): Note;
61
+ /**
62
+ * Render a {@link Note} as scientific pitch notation.
63
+ *
64
+ * @param note The note to format.
65
+ * @returns The note text, including the octave when present.
66
+ * @example
67
+ * ```ts
68
+ * import { formatNote, parseNote } from '@libraz/libcantus';
69
+ * formatNote(parseNote('C#4')); // 'C#4'
70
+ * ```
71
+ * @category Pitch & Intervals
72
+ */
73
+ declare function formatNote(note: Note): string;
74
+ /**
75
+ * Pitch class (0..11) of a note, ignoring octave.
76
+ *
77
+ * @param note The note.
78
+ * @returns The pitch class.
79
+ * @example
80
+ * ```ts
81
+ * import { noteToPitchClass, parseNote } from '@libraz/libcantus';
82
+ * noteToPitchClass(parseNote('Db')); // 1
83
+ * ```
84
+ * @category Pitch & Intervals
85
+ */
86
+ declare function noteToPitchClass(note: Note): number;
87
+ /**
88
+ * MIDI number of a note (middle C = C4 = 60).
89
+ *
90
+ * @param note The note; must carry an octave.
91
+ * @returns The MIDI number.
92
+ * @throws If the note has no octave.
93
+ * @example
94
+ * ```ts
95
+ * import { noteToMidi, parseNote } from '@libraz/libcantus';
96
+ * noteToMidi(parseNote('A4')); // 69
97
+ * ```
98
+ * @category Pitch & Intervals
99
+ */
100
+ declare function noteToMidi(note: Note): number;
101
+ /**
102
+ * Name a MIDI number as a {@link Note}, choosing sharp or flat spelling.
103
+ *
104
+ * The input is rounded to the nearest integer but is not clamped to the MIDI
105
+ * range 0..127: out-of-range values extrapolate linearly (e.g. `-1` -> `B-2`,
106
+ * `128` -> `G#9`) and remain an exact inverse of {@link noteToMidi}.
107
+ *
108
+ * @param midi The MIDI number.
109
+ * @param spelling Whether to prefer sharps or flats for black keys.
110
+ * @returns The spelled note, with octave.
111
+ * @example
112
+ * ```ts
113
+ * import { midiToNote, formatNote } from '@libraz/libcantus';
114
+ * formatNote(midiToNote(61)); // 'C#4'
115
+ * formatNote(midiToNote(61, 'flat')); // 'Db4'
116
+ * ```
117
+ * @category Pitch & Intervals
118
+ */
119
+ declare function midiToNote(midi: number, spelling?: 'sharp' | 'flat'): Note;
120
+ /**
121
+ * The spelled interval from one note to another.
122
+ *
123
+ * When both notes carry octaves, the interval reflects their full signed
124
+ * distance (so `C4 -> C5` is a perfect octave). When either lacks an octave the
125
+ * interval is measured within a single ascending octave from `a` to `b`.
126
+ *
127
+ * @param a The lower/first note.
128
+ * @param b The upper/second note.
129
+ * @returns The diatonic number, quality, and semitone span.
130
+ * @example
131
+ * ```ts
132
+ * import { spelledInterval, parseNote } from '@libraz/libcantus';
133
+ * spelledInterval(parseNote('C4'), parseNote('G4'));
134
+ * // { number: 5, quality: 'P', semitones: 7 }
135
+ * ```
136
+ * @category Pitch & Intervals
137
+ */
138
+ declare function spelledInterval(a: Note, b: Note): SpelledInterval;
139
+
140
+ export { type Note as N, type SpelledInterval as S, noteToPitchClass as a, formatNote as f, midiToNote as m, noteToMidi as n, parseNote as p, spelledInterval as s };
@@ -0,0 +1,157 @@
1
+ import { K as KeyScale } from './types-MGP29r3t.js';
2
+
3
+ /**
4
+ * Chord quality identifiers understood by the chord builder.
5
+ *
6
+ * @category Chords
7
+ */
8
+ type ChordQuality = 'maj' | 'min' | 'dim' | 'aug' | 'maj7' | 'min7' | 'dom7' | 'dim7' | 'm7b5' | 'minMaj7' | 'aug7' | 'augMaj7' | 'majb5' | '6' | 'min6' | '6/9' | 'sus2' | 'sus4' | 'add9' | 'add11' | 'maj9' | 'min9' | 'dom9' | '7b9' | '7#9' | '7#11' | '7b13' | '11' | '13' | '5';
9
+ /**
10
+ * A bare spelled pitch used as an enharmonic hint: a diatonic letter
11
+ * (0..6 = C..B) plus a chromatic alteration (-2 double-flat .. +2 double-sharp).
12
+ * Mirrors the letter/alter half of the pitch module's `Note` without an octave.
13
+ *
14
+ * @category Chords
15
+ */
16
+ type PitchSpelling = {
17
+ letter: number;
18
+ alter: number;
19
+ };
20
+ /**
21
+ * A chord expressed as a root pitch class plus semitone offsets.
22
+ *
23
+ * `rootSpelling`/`bassSpelling` are optional enharmonic hints recorded by
24
+ * parsers (e.g. `parseChordSymbol('Bb7')`) so formatters can reproduce the
25
+ * original spelling instead of defaulting to sharps. Consumers may ignore
26
+ * them; a hint is only trusted when its pitch class still matches the
27
+ * corresponding `rootPc`/`bassPc`.
28
+ *
29
+ * @category Chords
30
+ */
31
+ type Chord = {
32
+ rootPc: number;
33
+ quality: ChordQuality;
34
+ intervals: number[];
35
+ bassPc?: number;
36
+ rootSpelling?: PitchSpelling;
37
+ bassSpelling?: PitchSpelling;
38
+ };
39
+ /**
40
+ * A chord positioned in time: a root pitch class and quality placed at a beat,
41
+ * with optional harmonic-analysis hints. Serves as the neutral exchange record
42
+ * between progression generators and timeline analysers.
43
+ *
44
+ * @category Composition
45
+ */
46
+ type ChordSpan = {
47
+ rootPc: number;
48
+ quality: ChordQuality;
49
+ startBeat: number;
50
+ bassPc?: number;
51
+ /** 0-based scale degree of the chord root, when known. */
52
+ degree?: number;
53
+ /** True when the chord is a secondary dominant tonicizing another degree. */
54
+ secondaryDominant?: boolean;
55
+ };
56
+ /**
57
+ * All chord qualities the builder understands, longest templates last.
58
+ *
59
+ * @category Chords
60
+ */
61
+ declare function chordQualities(): ChordQuality[];
62
+ /**
63
+ * Build a chord rooted on a diatonic scale degree.
64
+ *
65
+ * The root pitch class is the degree's diatonic pitch class in `key`; the
66
+ * quality's interval template is attached unchanged. Degrees beyond the scale
67
+ * length wrap around.
68
+ *
69
+ * @param degree 0-based scale degree of the chord root.
70
+ * @param ext Chord quality to apply.
71
+ * @param key Key context supplying the diatonic root.
72
+ * @returns The constructed chord.
73
+ *
74
+ * @category Chords
75
+ */
76
+ declare function chordFromDegree(degree: number, ext: ChordQuality, key: KeyScale): Chord;
77
+ /**
78
+ * Build a chord from an explicit root pitch class and quality.
79
+ *
80
+ * @param rootPc Root pitch class (0..11).
81
+ * @param quality Chord quality supplying the interval template.
82
+ * @param bassPc Optional slash-chord bass pitch class.
83
+ * @returns The constructed chord.
84
+ *
85
+ * @example
86
+ * ```ts
87
+ * import { makeChord } from '@libraz/libcantus';
88
+ * const cmaj7 = makeChord(0, 'maj7');
89
+ * // { rootPc: 0, quality: 'maj7', intervals: [0, 4, 7, 11] }
90
+ * ```
91
+ *
92
+ * @category Chords
93
+ */
94
+ declare function makeChord(rootPc: number, quality: ChordQuality, bassPc?: number): Chord;
95
+ /**
96
+ * Get the sorted, deduplicated pitch classes of a chord.
97
+ *
98
+ * @param chord The chord to enumerate.
99
+ * @returns The chord's pitch classes, sorted ascending in [0, 11].
100
+ *
101
+ * @example
102
+ * ```ts
103
+ * import { makeChord, chordPitchClasses } from '@libraz/libcantus';
104
+ * chordPitchClasses(makeChord(0, 'maj7')); // [0, 4, 7, 11]
105
+ * ```
106
+ *
107
+ * @category Chords
108
+ */
109
+ declare function chordPitchClasses(chord: Chord): number[];
110
+ /**
111
+ * Determine a pitch's harmonic role within a chord.
112
+ *
113
+ * The role is derived from the pitch's interval above the chord root, reduced
114
+ * modulo 12. A major sixth (9) reads as a `sixth` for sixth chords but as a
115
+ * `seventh` for a diminished-seventh chord; ninths and other tensions have no
116
+ * basic role and return null.
117
+ *
118
+ * @param pitch MIDI pitch or bare pitch class.
119
+ * @param chord The chord providing the root reference.
120
+ * @returns The chord-tone role, or null if the pitch has no basic role.
121
+ *
122
+ * @category Chords
123
+ */
124
+ declare function chordToneRole(pitch: number, chord: Chord): 'root' | 'third' | 'fifth' | 'sixth' | 'seventh' | null;
125
+ /**
126
+ * Build the diatonic triad rooted on a scale degree by stacking scale thirds.
127
+ *
128
+ * Unlike {@link chordFromDegree}, the chord quality is derived from the scale
129
+ * rather than supplied, so degrees yield their scale-correct triads (e.g. a
130
+ * diminished triad on the leading tone of a major key). Intended for heptatonic
131
+ * scales; other scales stack by scale step regardless.
132
+ *
133
+ * @param degree 0-based scale degree of the chord root.
134
+ * @param key Key/scale context.
135
+ * @returns The diatonic triad.
136
+ *
137
+ * @example
138
+ * ```ts
139
+ * import { majorKey, diatonicTriad } from '@libraz/libcantus';
140
+ * const tonic = diatonicTriad(0, majorKey(0)); // C major triad (degree 0 of C major)
141
+ * ```
142
+ *
143
+ * @category Chords
144
+ */
145
+ declare function diatonicTriad(degree: number, key: KeyScale): Chord;
146
+ /**
147
+ * Build the diatonic seventh chord rooted on a scale degree.
148
+ *
149
+ * @param degree 0-based scale degree of the chord root.
150
+ * @param key Key/scale context.
151
+ * @returns The diatonic seventh chord.
152
+ *
153
+ * @category Chords
154
+ */
155
+ declare function diatonicSeventh(degree: number, key: KeyScale): Chord;
156
+
157
+ export { type Chord as C, type ChordQuality as a, type ChordSpan as b, chordFromDegree as c, chordPitchClasses as d, chordQualities as e, chordToneRole as f, diatonicSeventh as g, diatonicTriad as h, makeChord as m };
@@ -0,0 +1,56 @@
1
+ import { C as Chord } from './index-CM5W4rcm.js';
2
+
3
+ /**
4
+ * Harmonic role a pitch plays within a chord.
5
+ *
6
+ * @category Functional Harmony
7
+ */
8
+ type HarmonyRole = 'root' | 'third' | 'fifth' | 'sixth' | 'seventh' | 'tension' | 'doubling';
9
+ /**
10
+ * How firmly a pitch is locked to the chord's identity.
11
+ *
12
+ * - `identity`: moving it produces a different chord (the root).
13
+ * - `quality`: moving it flips the chord quality (the third).
14
+ * - `voicing`: it can move freely without changing chord identity or quality.
15
+ *
16
+ * @category Functional Harmony
17
+ */
18
+ type LockLevel = 'identity' | 'quality' | 'voicing';
19
+ /**
20
+ * A pitch's role, lock level, and owning chord.
21
+ *
22
+ * @category Functional Harmony
23
+ */
24
+ type VoicedRole = {
25
+ role: HarmonyRole;
26
+ lock: LockLevel;
27
+ belongsToChordId: number;
28
+ };
29
+ /**
30
+ * Classify a pitch's harmonic role and lock level within a chord.
31
+ *
32
+ * The role comes from the pitch's interval class above the chord root: root (0),
33
+ * third (3/4), fifth (6/7/8), seventh (10/11), and 9/11/13 tensions (2/5/9, and
34
+ * the flat ninth 1). The root locks the chord identity, the third locks its
35
+ * quality, and everything else is free voicing. In a suspended chord (a chord
36
+ * whose intervals include a 4th (5) or 2nd (2) but no third), the suspended tone
37
+ * takes the third's place as the quality-defining tone and is locked to
38
+ * `quality`, since moving it changes the chord. Detecting an octave doubling
39
+ * requires the surrounding voicing, which this single-pitch query does not carry,
40
+ * so `doubling` is part of the type but not returned here.
41
+ *
42
+ * @param pitch MIDI pitch or bare pitch class.
43
+ * @param chord The chord providing the root reference.
44
+ * @param chordId Identifier stored on the result (defaults to 0).
45
+ * @returns The pitch's role, lock level, and owning chord id.
46
+ * @example
47
+ * ```ts
48
+ * import { roleOf, makeChord } from '@libraz/libcantus';
49
+ * roleOf(64, makeChord(0, 'maj')); // E over C major
50
+ * // { role: 'third', lock: 'quality', belongsToChordId: 0 }
51
+ * ```
52
+ * @category Functional Harmony
53
+ */
54
+ declare function roleOf(pitch: number, chord: Chord, chordId?: number): VoicedRole;
55
+
56
+ export { type HarmonyRole as H, type LockLevel as L, type VoicedRole as V, roleOf as r };
@@ -0,0 +1,164 @@
1
+ /**
2
+ * Meter and time signatures: bar/beat arithmetic, simple vs. compound meters,
3
+ * metric-accent hierarchy, and tuplet subdivision.
4
+ *
5
+ * Positions and durations are measured in quarter-note beats, matching the rest
6
+ * of the library's beat convention (four quarter-note beats per bar in 4/4).
7
+ */
8
+ /**
9
+ * A time signature as a numerator over a note-value denominator.
10
+ *
11
+ * @category Rhythm & Meter
12
+ */
13
+ type TimeSignature = {
14
+ numerator: number;
15
+ denominator: number;
16
+ /**
17
+ * Optional additive grouping of the bar's main pulses, as the felt-beat
18
+ * lengths in pulses — e.g. `[2, 2, 3]` for a 2+2+3 reading of 7/8, or
19
+ * `[3, 2]` for 5/8. The entries must be positive integers summing to
20
+ * {@link pulsesPerBar}. When present, the head pulse of each group (other
21
+ * than the downbeat) is treated as a secondary strong pulse by
22
+ * {@link metricWeight}/{@link isStrongBeat}; when absent, all main pulses
23
+ * are weighted equally as flat, evenly divided pulses.
24
+ */
25
+ grouping?: number[];
26
+ };
27
+ /**
28
+ * A position expressed as a bar index and a quarter-note offset within the bar.
29
+ *
30
+ * @category Rhythm & Meter
31
+ */
32
+ type BarPosition = {
33
+ bar: number;
34
+ /** Quarter-note offset from the start of the bar. */
35
+ beat: number;
36
+ };
37
+ /**
38
+ * Parse a time signature such as `"4/4"` or `"6/8"`.
39
+ *
40
+ * @param text The signature text.
41
+ * @returns The parsed time signature.
42
+ * @throws If the text is not `n/d` with positive integers.
43
+ * @example
44
+ * ```ts
45
+ * import { parseTimeSignature } from '@libraz/libcantus';
46
+ * parseTimeSignature('6/8'); // { numerator: 6, denominator: 8 }
47
+ * ```
48
+ * @category Rhythm & Meter
49
+ */
50
+ declare function parseTimeSignature(text: string): TimeSignature;
51
+ /**
52
+ * Render a time signature as `"n/d"`.
53
+ *
54
+ * @category Rhythm & Meter
55
+ */
56
+ declare function formatTimeSignature(ts: TimeSignature): string;
57
+ /**
58
+ * Whether a meter is compound: its main pulses each divide into three, as in
59
+ * 6/8, 9/8, 12/8, or 6/4. Compound meters are those whose numerator is a
60
+ * multiple of three greater than three, independent of the denominator. Meters
61
+ * like 3/8 and 3/4 (simple triples, numerator 3) are not compound.
62
+ *
63
+ * @param ts The time signature.
64
+ * @returns True for compound meters.
65
+ * @category Rhythm & Meter
66
+ */
67
+ declare function isCompound(ts: TimeSignature): boolean;
68
+ /**
69
+ * Length of a bar in quarter-note beats.
70
+ *
71
+ * @param ts The time signature.
72
+ * @returns The bar length in quarter notes.
73
+ * @category Rhythm & Meter
74
+ */
75
+ declare function beatsPerBar(ts: TimeSignature): number;
76
+ /**
77
+ * Number of main pulses (felt beats) per bar: the numerator for simple meters,
78
+ * a third of it for compound meters.
79
+ *
80
+ * For additive/irregular meters such as 7/8 or 5/8 this counts the raw pulses
81
+ * (7 and 5 respectively), which are otherwise felt as flat, evenly divided and
82
+ * equally accented pulses. To recover a 2+2+3 or 3+2 felt-beat grouping, set
83
+ * {@link TimeSignature.grouping}; {@link metricWeight} then accents each
84
+ * group's head pulse.
85
+ *
86
+ * @param ts The time signature.
87
+ * @returns The pulse count per bar.
88
+ * @category Rhythm & Meter
89
+ */
90
+ declare function pulsesPerBar(ts: TimeSignature): number;
91
+ /**
92
+ * Convert an absolute quarter-note position to a bar index and in-bar offset.
93
+ *
94
+ * @param beatInQuarters Absolute position in quarter-note beats.
95
+ * @param ts The time signature.
96
+ * @returns The bar and in-bar quarter-note offset.
97
+ * @example
98
+ * ```ts
99
+ * import { parseTimeSignature, beatToBarPosition } from '@libraz/libcantus';
100
+ * const ts = parseTimeSignature('4/4');
101
+ * beatToBarPosition(5, ts); // { bar: 1, beat: 1 }
102
+ * ```
103
+ * @category Rhythm & Meter
104
+ */
105
+ declare function beatToBarPosition(beatInQuarters: number, ts: TimeSignature): BarPosition;
106
+ /**
107
+ * Convert a bar index and in-bar offset back to an absolute quarter-note
108
+ * position.
109
+ *
110
+ * @param pos The bar position.
111
+ * @param ts The time signature.
112
+ * @returns The absolute position in quarter-note beats.
113
+ * @category Rhythm & Meter
114
+ */
115
+ declare function barPositionToBeat(pos: BarPosition, ts: TimeSignature): number;
116
+ /**
117
+ * Metric weight of a position within its bar, on a 0–3 scale:
118
+ * 3 the downbeat, 2 a secondary strong pulse, 1 any other main pulse, and 0 an
119
+ * off-pulse subdivision.
120
+ *
121
+ * The secondary strong pulse is the bar's midpoint in even simple/compound
122
+ * meters. For an additive/irregular meter with {@link TimeSignature.grouping}
123
+ * set (e.g. `[2, 2, 3]` for 7/8), each group's head pulse other than the
124
+ * downbeat is the secondary strong pulse instead; without a grouping every
125
+ * non-downbeat main pulse of such a meter weighs 1 (flat, evenly divided
126
+ * pulses).
127
+ *
128
+ * @param beatInQuarters Absolute or in-bar quarter-note position.
129
+ * @param ts The time signature.
130
+ * @returns The metric weight (0–3).
131
+ * @throws If `ts.grouping` is present but is not a positive-integer list
132
+ * summing to {@link pulsesPerBar}.
133
+ * @example
134
+ * ```ts
135
+ * import { parseTimeSignature, metricWeight } from '@libraz/libcantus';
136
+ * const ts = parseTimeSignature('4/4');
137
+ * metricWeight(0, ts); // 3 (the downbeat)
138
+ * ```
139
+ * @category Rhythm & Meter
140
+ */
141
+ declare function metricWeight(beatInQuarters: number, ts: TimeSignature): number;
142
+ /**
143
+ * Whether a position is metrically accented (weight 2 or more — a downbeat or a
144
+ * secondary strong pulse).
145
+ *
146
+ * @param beatInQuarters Absolute or in-bar quarter-note position.
147
+ * @param ts The time signature.
148
+ * @returns True on strong beats.
149
+ * @category Rhythm & Meter
150
+ */
151
+ declare function isStrongBeat(beatInQuarters: number, ts: TimeSignature): boolean;
152
+ /**
153
+ * Subdivide a span into `count` equal tuplet durations (e.g. an eighth-note
154
+ * triplet is `tuplet(1, 3)`).
155
+ *
156
+ * @param totalBeats Total span in quarter-note beats.
157
+ * @param count Number of equal parts.
158
+ * @returns `count` equal durations summing to `totalBeats`.
159
+ * @throws If `count` is not a positive integer.
160
+ * @category Rhythm & Meter
161
+ */
162
+ declare function tuplet(totalBeats: number, count: number): number[];
163
+
164
+ export { type BarPosition as B, type TimeSignature as T, beatToBarPosition as a, barPositionToBeat as b, beatsPerBar as c, isStrongBeat as d, pulsesPerBar as e, formatTimeSignature as f, isCompound as i, metricWeight as m, parseTimeSignature as p, tuplet as t };
@@ -0,0 +1,164 @@
1
+ /**
2
+ * Meter and time signatures: bar/beat arithmetic, simple vs. compound meters,
3
+ * metric-accent hierarchy, and tuplet subdivision.
4
+ *
5
+ * Positions and durations are measured in quarter-note beats, matching the rest
6
+ * of the library's beat convention (four quarter-note beats per bar in 4/4).
7
+ */
8
+ /**
9
+ * A time signature as a numerator over a note-value denominator.
10
+ *
11
+ * @category Rhythm & Meter
12
+ */
13
+ type TimeSignature = {
14
+ numerator: number;
15
+ denominator: number;
16
+ /**
17
+ * Optional additive grouping of the bar's main pulses, as the felt-beat
18
+ * lengths in pulses — e.g. `[2, 2, 3]` for a 2+2+3 reading of 7/8, or
19
+ * `[3, 2]` for 5/8. The entries must be positive integers summing to
20
+ * {@link pulsesPerBar}. When present, the head pulse of each group (other
21
+ * than the downbeat) is treated as a secondary strong pulse by
22
+ * {@link metricWeight}/{@link isStrongBeat}; when absent, all main pulses
23
+ * are weighted equally as flat, evenly divided pulses.
24
+ */
25
+ grouping?: number[];
26
+ };
27
+ /**
28
+ * A position expressed as a bar index and a quarter-note offset within the bar.
29
+ *
30
+ * @category Rhythm & Meter
31
+ */
32
+ type BarPosition = {
33
+ bar: number;
34
+ /** Quarter-note offset from the start of the bar. */
35
+ beat: number;
36
+ };
37
+ /**
38
+ * Parse a time signature such as `"4/4"` or `"6/8"`.
39
+ *
40
+ * @param text The signature text.
41
+ * @returns The parsed time signature.
42
+ * @throws If the text is not `n/d` with positive integers.
43
+ * @example
44
+ * ```ts
45
+ * import { parseTimeSignature } from '@libraz/libcantus';
46
+ * parseTimeSignature('6/8'); // { numerator: 6, denominator: 8 }
47
+ * ```
48
+ * @category Rhythm & Meter
49
+ */
50
+ declare function parseTimeSignature(text: string): TimeSignature;
51
+ /**
52
+ * Render a time signature as `"n/d"`.
53
+ *
54
+ * @category Rhythm & Meter
55
+ */
56
+ declare function formatTimeSignature(ts: TimeSignature): string;
57
+ /**
58
+ * Whether a meter is compound: its main pulses each divide into three, as in
59
+ * 6/8, 9/8, 12/8, or 6/4. Compound meters are those whose numerator is a
60
+ * multiple of three greater than three, independent of the denominator. Meters
61
+ * like 3/8 and 3/4 (simple triples, numerator 3) are not compound.
62
+ *
63
+ * @param ts The time signature.
64
+ * @returns True for compound meters.
65
+ * @category Rhythm & Meter
66
+ */
67
+ declare function isCompound(ts: TimeSignature): boolean;
68
+ /**
69
+ * Length of a bar in quarter-note beats.
70
+ *
71
+ * @param ts The time signature.
72
+ * @returns The bar length in quarter notes.
73
+ * @category Rhythm & Meter
74
+ */
75
+ declare function beatsPerBar(ts: TimeSignature): number;
76
+ /**
77
+ * Number of main pulses (felt beats) per bar: the numerator for simple meters,
78
+ * a third of it for compound meters.
79
+ *
80
+ * For additive/irregular meters such as 7/8 or 5/8 this counts the raw pulses
81
+ * (7 and 5 respectively), which are otherwise felt as flat, evenly divided and
82
+ * equally accented pulses. To recover a 2+2+3 or 3+2 felt-beat grouping, set
83
+ * {@link TimeSignature.grouping}; {@link metricWeight} then accents each
84
+ * group's head pulse.
85
+ *
86
+ * @param ts The time signature.
87
+ * @returns The pulse count per bar.
88
+ * @category Rhythm & Meter
89
+ */
90
+ declare function pulsesPerBar(ts: TimeSignature): number;
91
+ /**
92
+ * Convert an absolute quarter-note position to a bar index and in-bar offset.
93
+ *
94
+ * @param beatInQuarters Absolute position in quarter-note beats.
95
+ * @param ts The time signature.
96
+ * @returns The bar and in-bar quarter-note offset.
97
+ * @example
98
+ * ```ts
99
+ * import { parseTimeSignature, beatToBarPosition } from '@libraz/libcantus';
100
+ * const ts = parseTimeSignature('4/4');
101
+ * beatToBarPosition(5, ts); // { bar: 1, beat: 1 }
102
+ * ```
103
+ * @category Rhythm & Meter
104
+ */
105
+ declare function beatToBarPosition(beatInQuarters: number, ts: TimeSignature): BarPosition;
106
+ /**
107
+ * Convert a bar index and in-bar offset back to an absolute quarter-note
108
+ * position.
109
+ *
110
+ * @param pos The bar position.
111
+ * @param ts The time signature.
112
+ * @returns The absolute position in quarter-note beats.
113
+ * @category Rhythm & Meter
114
+ */
115
+ declare function barPositionToBeat(pos: BarPosition, ts: TimeSignature): number;
116
+ /**
117
+ * Metric weight of a position within its bar, on a 0–3 scale:
118
+ * 3 the downbeat, 2 a secondary strong pulse, 1 any other main pulse, and 0 an
119
+ * off-pulse subdivision.
120
+ *
121
+ * The secondary strong pulse is the bar's midpoint in even simple/compound
122
+ * meters. For an additive/irregular meter with {@link TimeSignature.grouping}
123
+ * set (e.g. `[2, 2, 3]` for 7/8), each group's head pulse other than the
124
+ * downbeat is the secondary strong pulse instead; without a grouping every
125
+ * non-downbeat main pulse of such a meter weighs 1 (flat, evenly divided
126
+ * pulses).
127
+ *
128
+ * @param beatInQuarters Absolute or in-bar quarter-note position.
129
+ * @param ts The time signature.
130
+ * @returns The metric weight (0–3).
131
+ * @throws If `ts.grouping` is present but is not a positive-integer list
132
+ * summing to {@link pulsesPerBar}.
133
+ * @example
134
+ * ```ts
135
+ * import { parseTimeSignature, metricWeight } from '@libraz/libcantus';
136
+ * const ts = parseTimeSignature('4/4');
137
+ * metricWeight(0, ts); // 3 (the downbeat)
138
+ * ```
139
+ * @category Rhythm & Meter
140
+ */
141
+ declare function metricWeight(beatInQuarters: number, ts: TimeSignature): number;
142
+ /**
143
+ * Whether a position is metrically accented (weight 2 or more — a downbeat or a
144
+ * secondary strong pulse).
145
+ *
146
+ * @param beatInQuarters Absolute or in-bar quarter-note position.
147
+ * @param ts The time signature.
148
+ * @returns True on strong beats.
149
+ * @category Rhythm & Meter
150
+ */
151
+ declare function isStrongBeat(beatInQuarters: number, ts: TimeSignature): boolean;
152
+ /**
153
+ * Subdivide a span into `count` equal tuplet durations (e.g. an eighth-note
154
+ * triplet is `tuplet(1, 3)`).
155
+ *
156
+ * @param totalBeats Total span in quarter-note beats.
157
+ * @param count Number of equal parts.
158
+ * @returns `count` equal durations summing to `totalBeats`.
159
+ * @throws If `count` is not a positive integer.
160
+ * @category Rhythm & Meter
161
+ */
162
+ declare function tuplet(totalBeats: number, count: number): number[];
163
+
164
+ export { type BarPosition as B, type TimeSignature as T, beatToBarPosition as a, barPositionToBeat as b, beatsPerBar as c, isStrongBeat as d, pulsesPerBar as e, formatTimeSignature as f, isCompound as i, metricWeight as m, parseTimeSignature as p, tuplet as t };