@libraz/libcantus 0.9.1 → 0.9.2

package/src/generate/index.ts

@@ -0,0 +1,59 @@
+/**
+ * Public API of the generate layer. Re-exports every generate-layer module;
+ * also available from the package root.
+ */
+export type { BassLineOptions, BassSegment, BassStyle } from './bass/index.js';
+export { generateBassLine } from './bass/index.js';
+export type { CounterMelodyOptions } from './countermelody/index.js';
+export { generateCounterMelody } from './countermelody/index.js';
+export type {
+  DrumHit,
+  DrumRole,
+  DrumsOptions,
+  EuclideanKick,
+  GrooveFeel,
+  GrooveStyle,
+  Section,
+} from './drums/index.js';
+export { generateDrums } from './drums/index.js';
+export type { GrooveSlot, GrooveTemplate, HumanizeOptions } from './groove/index.js';
+export { applyGrooveTemplate, extractGrooveTemplate, humanize } from './groove/index.js';
+export type {
+  HarmonizeOptions,
+  HarmonizeResult,
+  MelodyNote,
+} from './harmonize/index.js';
+export { harmonizeMelody } from './harmonize/index.js';
+export type {
+  MotifCell,
+  MotifContour,
+  MotifNote,
+  MotifOptions,
+  MotifTransform,
+} from './motif/index.js';
+export { developMotif, generateMotif, transformMotif } from './motif/index.js';
+export type {
+  ChordSpan,
+  ProgFunction,
+  ProgressionOptions,
+  ProgressionPreset,
+  ProgStyle,
+} from './progression/index.js';
+export {
+  generateProgression,
+  progressions,
+  progressionsByStyle,
+} from './progression/index.js';
+export type {
+  BorrowedChord,
+  SubstituteOptions,
+  Substitution,
+  SubstitutionType,
+} from './reharmony/index.js';
+export {
+  modalInterchangePalette,
+  negativeHarmonyMirror,
+  substituteChord,
+} from './reharmony/index.js';
+export type { RhythmEvent, RhythmOptions } from './rhythm/index.js';
+export { generateRhythm, onsetWeightCurve, rhythmDensity } from './rhythm/index.js';

package/src/{motif → generate/motif}/index.ts

@@ -1,8 +1,8 @@
-import type { Chord } from '../chord/index.js';
-import { chordPitchClasses } from '../chord/index.js';
-import { isScaleTone, nearestScaleTone } from '../scale/index.js';
-import type { ChordTimeline } from '../timeline/index.js';
-import type { KeyScale } from '../types.js';
+import type { ChordTimeline } from '../../analyze/timeline/index.js';
+import type { KeyScale } from '../../core/types.js';
+import type { Chord } from '../../theory/chord/index.js';
+import { chordPitchClasses } from '../../theory/chord/index.js';
+import { isScaleTone, nearestScaleTone } from '../../theory/scale/index.js';
 
 /**
  * A transformation applicable to a motif cell.
@@ -50,7 +50,7 @@ export type MotifContour = 'arch' | 'ascending' | 'descending' | 'wave';
  *
  * @category Composition
  */
-export type GenerateMotifOptions = {
+export type MotifOptions = {
   key: KeyScale;
   chord?: Chord | null;
   bars: number;
@@ -207,7 +207,7 @@ function contourOffsets(contour: MotifContour, count: number): number[] {
  *
  * @category Composition
  */
-export function generateMotif(opts: GenerateMotifOptions): MotifCell {
+export function generateMotif(opts: MotifOptions): MotifCell {
   const contour = opts.contour ?? 'arch';
   const bars = Math.max(1, Math.trunc(opts.bars));
   const totalBeats = bars * 4;

package/src/{progression → generate/progression}/index.ts

@@ -1,7 +1,9 @@
-import type { ChordQuality } from '../chord/index.js';
-import { diatonicTriad } from '../chord/index.js';
-import { scaleTonesInDegreeOrder } from '../scale/index.js';
-import type { KeyScale } from '../types.js';
+import type { KeyScale } from '../../core/types.js';
+import type { ChordQuality, ChordSpan } from '../../theory/chord/index.js';
+import { diatonicTriad } from '../../theory/chord/index.js';
+import { scaleTonesInDegreeOrder } from '../../theory/scale/index.js';
+
+export type { ChordSpan } from '../../theory/chord/index.js';
 
 /**
  * Broad production style a progression preset suits.
@@ -30,28 +32,12 @@ export type ProgressionPreset = {
   styles: ProgStyle[];
 };
 
-/**
- * A chord placed on the timeline by {@link generateProgression}.
- *
- * @category Composition
- */
-export type GeneratedChord = {
-  rootPc: number;
-  quality: ChordQuality;
-  startBeat: number;
-  bassPc?: number;
-  /** 0-based scale degree of the chord root, when known. */
-  degree?: number;
-  /** True when the chord is a secondary dominant tonicizing another degree. */
-  secondaryDominant?: boolean;
-};
-
 /**
  * Options controlling {@link generateProgression}.
  *
  * @category Composition
  */
-export type GenerateProgressionOptions = {
+export type ProgressionOptions = {
   key: KeyScale;
   style: ProgStyle;
   bars: number;
@@ -315,12 +301,12 @@ function autoQuality(degree: number, key: KeyScale): ChordQuality {
  * ```ts
  * import { generateProgression, majorKey } from '@libraz/libcantus';
  * const chords = generateProgression({ key: majorKey(0), style: 'dance', bars: 4 });
- * // Deterministic for a given seed (defaults to 0); one GeneratedChord per bar.
+ * // Deterministic for a given seed (defaults to 0); one ChordSpan per bar.
  * ```
  *
  * @category Composition
  */
-export function generateProgression(opts: GenerateProgressionOptions): GeneratedChord[] {
+export function generateProgression(opts: ProgressionOptions): ChordSpan[] {
   const seed = opts.seed ?? 0;
   let preset: ProgressionPreset | undefined;
   if (opts.presetId !== undefined) {
@@ -337,12 +323,12 @@ export function generateProgression(opts: GenerateProgressionOptions): Generated
     preset = candidates[index] ?? PRESETS[0];
   }
   const degrees = preset?.degrees ?? [0];
-  const chords: GeneratedChord[] = [];
+  const chords: ChordSpan[] = [];
   for (let bar = 0; bar < opts.bars; bar += 1) {
     const degree = degrees[bar % degrees.length] ?? 0;
     const quality =
       opts.ext !== undefined && opts.ext !== 'auto' ? opts.ext : autoQuality(degree, opts.key);
-    const chord: GeneratedChord = {
+    const chord: ChordSpan = {
       rootPc: degreeToRootPc(degree, opts.key),
       quality,
       startBeat: bar * 4,

package/src/{reharmony → generate/reharmony}/index.ts

@@ -7,14 +7,7 @@
  * Roots are pitch classes (0..11); no spelled key signature is required.
  */
 
-import {
-  type Chord,
-  type ChordQuality,
-  chordPitchClasses,
-  diatonicTriad,
-  makeChord,
-} from '../chord/index.js';
-import { detectChordBest } from '../detect/index.js';
+import { detectChordBest } from '../../analyze/detect/index.js';
 import {
   type BorrowedSource,
   borrowedSource,
@@ -23,9 +16,16 @@ import {
   type HarmonicFunction,
   isDiatonic,
   parallelKey,
-} from '../functional/index.js';
-import { scaleTonesInDegreeOrder } from '../scale/index.js';
-import type { KeyScale } from '../types.js';
+} from '../../analyze/functional/index.js';
+import type { KeyScale } from '../../core/types.js';
+import {
+  type Chord,
+  type ChordQuality,
+  chordPitchClasses,
+  diatonicTriad,
+  makeChord,
+} from '../../theory/chord/index.js';
+import { scaleTonesInDegreeOrder } from '../../theory/scale/index.js';
 
 /** Reduce a value to a pitch class in [0, 11]. */
 function mod12(n: number): number {

package/src/{rhythm → generate/rhythm}/index.ts

@@ -11,8 +11,8 @@
  * library-wide convention.
  */
 
-import { beatsPerBar, metricWeight, type TimeSignature } from '../meter/index.js';
-import { createRng } from '../random/index.js';
+import { beatsPerBar, metricWeight, type TimeSignature } from '../../core/meter/index.js';
+import { createRng } from '../../core/random/index.js';
 
 /**
  * A single rhythmic note: an onset position and how long it sounds.

package/src/index.ts

@@ -1,5 +1,3 @@
-export type { AnalyzedNote, TheoryLabel, VoiceNote } from './analysis/index.js';
-export { analyzeVoice } from './analysis/index.js';
 export type {
   ArrangementAnalysis,
   ArrangementOptions,
@@ -8,61 +6,16 @@ export type {
   TensionPoint,
   TrackAnalysis,
   TrackRole,
-} from './arrange/index.js';
-export { analyzeArrangement, tensionCurve } from './arrange/index.js';
-export type { BassLineOptions, BassSegment, BassStyle } from './bass/index.js';
-export { generateBassLine } from './bass/index.js';
-export type { Chord as ChordData, ChordQuality } from './chord/index.js';
-export {
-  chordFromDegree,
-  chordPitchClasses,
-  chordQualities,
-  chordToneRole,
-  diatonicSeventh,
-  diatonicTriad,
-  makeChord,
-} from './chord/index.js';
-export type { ChordScaleMatch, ChordScaleReportEntry, ScaleChoice } from './chordscale/index.js';
-export {
-  availableTensions,
-  avoidNotes,
-  chordScaleReport,
-  chordScales,
-  scaleMatchesChord,
-  scalesForChanges,
-} from './chordscale/index.js';
-export type { CounterMelodyOptions } from './countermelody/index.js';
-export { generateCounterMelody } from './countermelody/index.js';
-export {
-  createsHiddenParallelPerfect,
-  createsParallelOctave,
-  createsParallelPerfect,
-  createsParallelUnison,
-  createsVerticalDissonance,
-  createsVoiceCrossing,
-  createsVoiceOverlap,
-  exceedsSpacing,
-  isForbiddenMelodicLeap,
-  isLeadingToneResolution,
-} from './counterpoint/index.js';
-export type { ChordMatch, KeyMatch } from './detect/index.js';
-export { detectChord, detectChordBest, detectKey } from './detect/index.js';
-export type {
-  DrumGenOptions,
-  DrumHit,
-  DrumRole,
-  EuclideanKick,
-  GrooveFeel,
-  GrooveStyle,
-  Section,
-} from './drums/index.js';
-export { generateDrums } from './drums/index.js';
+} from './analyze/arrange/index.js';
+export { analyzeArrangement, tensionCurve } from './analyze/arrange/index.js';
+export type { ChordMatch, KeyMatch } from './analyze/detect/index.js';
+export { detectChord, detectChordBest, detectKey } from './analyze/detect/index.js';
 export type {
   BorrowedSource,
   Cadence,
   ChordAnalysis,
   HarmonicFunction,
-} from './functional/index.js';
+} from './analyze/functional/index.js';
 export {
   analyzeChord,
   borrowedSource,
@@ -75,24 +28,28 @@ export {
   parallelKey,
   romanToChord,
   secondaryDominant,
-} from './functional/index.js';
-export type { GrooveSlot, GrooveTemplate, HumanizeOptions } from './groove/index.js';
-export { applyGrooveTemplate, extractGrooveTemplate, humanize } from './groove/index.js';
+} from './analyze/functional/index.js';
 export type {
-  HarmonizeOptions,
-  HarmonizeResult,
-  MelodyNote,
-} from './harmonize/index.js';
-export { harmonizeMelody } from './harmonize/index.js';
-export type { HarmonyRole, LockLevel, VoicedRole } from './harmony/index.js';
-export { roleOf } from './harmony/index.js';
+  CadenceHit,
+  ChordSegment,
+  ChordTimeline,
+  ChordTimelineOptions,
+  ChordTimelineResult,
+} from './analyze/timeline/index.js';
+export {
+  chordTimelineFromChords,
+  chordTimelineFromNotes,
+  detectCadences,
+} from './analyze/timeline/index.js';
+export type { AnalyzedNote, TheoryLabel, VoiceNote } from './analyze/voice/index.js';
+export { analyzeVoice } from './analyze/voice/index.js';
 export {
   classifyInterval,
   IntervalQuality,
   isConsonantInterval,
   isPerfectInterval,
-} from './interval/index.js';
-export type { BarPosition, TimeSignature } from './meter/index.js';
+} from './core/interval/index.js';
+export type { BarPosition, TimeSignature } from './core/meter/index.js';
 export {
   barPositionToBeat,
   beatsPerBar,
@@ -104,17 +61,8 @@ export {
   parseTimeSignature,
   pulsesPerBar,
   tuplet,
-} from './meter/index.js';
-export { Chord, Interval, Key, Note, Progression } from './model/index.js';
-export type {
-  GenerateMotifOptions,
-  MotifCell,
-  MotifContour,
-  MotifNote,
-  MotifTransform,
-} from './motif/index.js';
-export { developMotif, generateMotif, transformMotif } from './motif/index.js';
-export type { Note as NoteData, SpelledInterval } from './pitch/index.js';
+} from './core/meter/index.js';
+export type { Note as NoteData, SpelledInterval } from './core/pitch/index.js';
 export {
   formatNote,
   midiToNote,
@@ -122,41 +70,127 @@ export {
   noteToPitchClass,
   parseNote,
   spelledInterval,
-} from './pitch/index.js';
+} from './core/pitch/index.js';
+export type { Rng } from './core/random/index.js';
+export { createRng } from './core/random/index.js';
+export type { Tuning } from './core/tuning/index.js';
+export {
+  centsBetweenFreq,
+  centsOfSteps,
+  edo,
+  frequencyOf,
+  JUST_RATIOS,
+  justDeviationCents,
+  nearestStep,
+  ratioToCents,
+  TWELVE_TET,
+} from './core/tuning/index.js';
+export type { KeyScale, NoteEvent } from './core/types.js';
+export type { BassLineOptions, BassSegment, BassStyle } from './generate/bass/index.js';
+export { generateBassLine } from './generate/bass/index.js';
+export type { CounterMelodyOptions } from './generate/countermelody/index.js';
+export { generateCounterMelody } from './generate/countermelody/index.js';
 export type {
-  GeneratedChord,
-  GenerateProgressionOptions,
+  DrumHit,
+  DrumRole,
+  DrumsOptions,
+  EuclideanKick,
+  GrooveFeel,
+  GrooveStyle,
+  Section,
+} from './generate/drums/index.js';
+export { generateDrums } from './generate/drums/index.js';
+export type { GrooveSlot, GrooveTemplate, HumanizeOptions } from './generate/groove/index.js';
+export { applyGrooveTemplate, extractGrooveTemplate, humanize } from './generate/groove/index.js';
+export type {
+  HarmonizeOptions,
+  HarmonizeResult,
+  MelodyNote,
+} from './generate/harmonize/index.js';
+export { harmonizeMelody } from './generate/harmonize/index.js';
+export type {
+  MotifCell,
+  MotifContour,
+  MotifNote,
+  MotifOptions,
+  MotifTransform,
+} from './generate/motif/index.js';
+export { developMotif, generateMotif, transformMotif } from './generate/motif/index.js';
+export type {
+  ChordSpan,
   ProgFunction,
+  ProgressionOptions,
   ProgressionPreset,
   ProgStyle,
-} from './progression/index.js';
+} from './generate/progression/index.js';
 export {
   generateProgression,
   progressions,
   progressionsByStyle,
-} from './progression/index.js';
-export type { Rng } from './random/index.js';
-export { createRng } from './random/index.js';
+} from './generate/progression/index.js';
 export type {
   BorrowedChord,
   SubstituteOptions,
   Substitution,
   SubstitutionType,
-} from './reharmony/index.js';
+} from './generate/reharmony/index.js';
 export {
   modalInterchangePalette,
   negativeHarmonyMirror,
   substituteChord,
-} from './reharmony/index.js';
-export type { RhythmEvent, RhythmOptions } from './rhythm/index.js';
-export { generateRhythm, onsetWeightCurve, rhythmDensity } from './rhythm/index.js';
+} from './generate/reharmony/index.js';
+export type { RhythmEvent, RhythmOptions } from './generate/rhythm/index.js';
+export { generateRhythm, onsetWeightCurve, rhythmDensity } from './generate/rhythm/index.js';
+export { Chord, Interval, Key, Note, Progression } from './model/index.js';
+export type { Chord as ChordData, ChordQuality } from './theory/chord/index.js';
+export {
+  chordFromDegree,
+  chordPitchClasses,
+  chordQualities,
+  chordToneRole,
+  diatonicSeventh,
+  diatonicTriad,
+  makeChord,
+} from './theory/chord/index.js';
+export type {
+  ChordScaleMatch,
+  ChordScaleReportEntry,
+  ScaleChoice,
+} from './theory/chordscale/index.js';
+export {
+  availableTensions,
+  avoidNotes,
+  chordScaleReport,
+  chordScales,
+  scaleMatchesChord,
+  scalesForChanges,
+} from './theory/chordscale/index.js';
+export {
+  createsHiddenParallelPerfect,
+  createsParallelOctave,
+  createsParallelPerfect,
+  createsParallelUnison,
+  createsVerticalDissonance,
+  createsVoiceCrossing,
+  createsVoiceOverlap,
+  exceedsSpacing,
+  isForbiddenMelodicLeap,
+  isLeadingToneResolution,
+} from './theory/counterpoint/index.js';
+export type { HarmonyRole, LockLevel, VoicedRole } from './theory/harmony/index.js';
+export { roleOf } from './theory/harmony/index.js';
 export type {
   SafetyProfile,
   SafetyQuery,
   SafetyResult,
   VoiceSnapshot,
-} from './safety/index.js';
-export { enumerateSafePitches, evaluateSafety, NoteSafety, ReasonFlag } from './safety/index.js';
+} from './theory/safety/index.js';
+export {
+  enumerateSafePitches,
+  evaluateSafety,
+  NoteSafety,
+  ReasonFlag,
+} from './theory/safety/index.js';
 export {
   BLUES_MASK,
   CHROMATIC_MASK,
@@ -184,46 +218,25 @@ export {
   scaleByName,
   scaleTonesInDegreeOrder,
   WHOLE_TONE_MASK,
-} from './scale/index.js';
+} from './theory/scale/index.js';
 export {
   noteNames,
   spellChord,
   spellPitchClass,
   spellPitchClasses,
   spellScale,
-} from './spelling/index.js';
-export { formatChordSymbol, parseChordSymbol, transposeChordSymbol } from './symbol/index.js';
-export type {
-  CadenceHit,
-  ChordSegment,
-  ChordTimeline,
-  ChordTimelineOptions,
-  ChordTimelineResult,
-} from './timeline/index.js';
-export {
-  chordTimelineFromChords,
-  chordTimelineFromNotes,
-  detectCadences,
-} from './timeline/index.js';
-export type { Tuning } from './tuning/index.js';
+} from './theory/spelling/index.js';
 export {
-  centsBetweenFreq,
-  centsOfSteps,
-  edo,
-  frequencyOf,
-  JUST_RATIOS,
-  justDeviationCents,
-  nearestStep,
-  ratioToCents,
-  TWELVE_TET,
-} from './tuning/index.js';
-export type { KeyScale, NoteEvent } from './types.js';
+  formatChordSymbol,
+  parseChordSymbol,
+  transposeChordSymbol,
+} from './theory/symbol/index.js';
 export type {
   StyledVoicingOptions,
   VoiceRange,
   VoicingOptions,
   VoicingStyle,
-} from './voicing/index.js';
+} from './theory/voicing/index.js';
 export {
   nextVoicing,
   SATB_RANGES,
@@ -231,4 +244,4 @@ export {
   voiceChordStyled,
   voiceLeadingCost,
   voiceProgression,
-} from './voicing/index.js';
+} from './theory/voicing/index.js';