@libraz/libcantus 0.9.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 libraz
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,291 @@
+# @libraz/libcantus
+
+Pure-TypeScript toolkit for working with music: name notes and chords, analyze
+harmony, recognize what you're hearing, voice and reharmonize progressions, and
+generate parts (bass, countermelody, drums, rhythm) — all with no runtime
+dependencies.
+
+[![CI](https://github.com/libraz/libcantus/actions/workflows/ci.yml/badge.svg)](https://github.com/libraz/libcantus/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/libraz/libcantus/branch/main/graph/badge.svg)](https://codecov.io/gh/libraz/libcantus)
+[![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-%E2%89%A522-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+
+## What can you do with it?
+
+- **Name and move notes** — parse `C4`, transpose it, convert to/from MIDI, spell
+  intervals with correct enharmonics (`F#` vs `Gb`).
+- **Build chords and progressions** — from scale degrees, Roman numerals
+  (`V7/V`), or lead-sheet symbols (`Cmaj7`, `F#m7b5`, `C/G`).
+- **Analyze harmony** — Roman-numeral analysis, harmonic function, cadence
+  detection, and borrowed / modal-interchange chords.
+- **Recognize what you hear** — notes in, chord or key out (the inverse of the
+  builders).
+- **Reharmonize** — tritone subs, chromatic mediants, negative harmony, modal
+  interchange palettes.
+- **Voice chords** — smooth 4-voice (SATB) leading, plus drop-2/3, shell, and
+  rootless comping styles.
+- **Generate parts** — bass lines, countermelodies, drums, rhythms, motifs, and
+  whole progressions; deterministic for a given seed.
+- **Arrange from a DAW / MIDI file** — feed raw multi-track notes, recover the
+  harmony, get a whole-piece analysis (with per-note conflicts), and generate the
+  missing parts against it.
+- **Work with pitch as sound** — frequencies, cents, EDO, and just intonation.
+
+The musical **values** — notes, chords, keys, progressions — come in two
+interchangeable styles: a **fluent, immutable class API** (`Note`, `Chord`,
+`Key`, `Progression`) that reads like music theory, and the underlying
+**tree-shakeable pure functions**. Operations over **collections and timelines**
+(part generation and whole-arrangement analysis) work on arrays of note events,
+so — like `rhythm`, `drums`, and `detectKey` — they are exposed as functions.
+
+## Install
+
+```sh
+yarn add @libraz/libcantus
+```
+
+## Quick start
+
+The class API chains immutably and carries key context, so analysis needs no
+repetition:
+
+```ts
+import { Chord, Key, Note } from '@libraz/libcantus';
+
+const c = Key.major('C');
+
+c.chord(4, 'dom7').pitchClasses(); // [2, 5, 7, 11]  (G7)
+c.roman('V7/V').voice(); // [ ...SATB MIDI ]  (secondary dominant, voiced)
+Note.of('C4').transpose(7).name; // 'G4'
+
+// A ii–V–I, built and analyzed in one line:
+c.chord(1, 'min').progressionTo(c.chord(4, 'dom7'), c.chord(0, 'maj')).analyze();
+// { chords: [...functional analysis...], cadence: 'authentic' }
+
+Chord.detect([60, 64, 67])[0].quality; // 'maj'
+```
+
+Every class wraps a plain object (`Chord.data`, `Note.data`) and delegates to the
+pure functions, so the two styles interoperate freely. The same task with the
+functional API:
+
+```ts
+import { chordFromDegree, chordPitchClasses, classifyInterval, majorKey } from '@libraz/libcantus';
+
+const cMajor = majorKey(0);
+
+classifyInterval(7); // IntervalQuality.PerfectConsonance
+chordPitchClasses(chordFromDegree(4, 'dom7', cMajor)); // [2, 5, 7, 11]  (G7)
+```
+
+## Name and move notes
+
+Parse and format notes, convert to MIDI, and spell intervals so enharmonics the
+pitch-class layer can't tell apart come out right:
+
+```ts
+import { Interval, Note } from '@libraz/libcantus';
+
+Note.of('C4').transpose(7).name; // 'G4'
+Note.of('C4').midi; // 60
+Interval.between(Note.of('C4'), Note.of('F#4')).name; // 'A4'  (augmented fourth)
+Interval.between(Note.of('C4'), Note.of('Gb4')).name; // 'd5'  (diminished fifth)
+```
+
+## Keys and scales
+
+A `KeyScale` is a root pitch class plus a 12-bit `modeMask12` (bit `n` set means
+pitch class `(rootPc + n) % 12` is in the scale). `majorKey`, `minorKey`, and
+`scaleByName` cover the modes, pentatonics, blues, whole-tone, and octatonic
+scales; `MAJOR_MASK` / `NATURAL_MINOR_MASK` let you define custom keys.
+
+`nearestScaleTone` snaps a pitch to the closest in-scale MIDI pitch (preferring
+the lower on a tie) — handy when constraining generated notes to a key.
+
+## Build chords and progressions
+
+From scale degrees, Roman numerals, or lead-sheet symbols — and back again:
+
+```ts
+import { Chord, Key } from '@libraz/libcantus';
+
+const c = Key.major('C');
+
+c.roman('V7/V').symbol(); // 'D7'  (a secondary dominant)
+c.chord(4, 'dom7').roman(); // 'V7'
+Chord.parse('F#m7b5').pitchClasses(); // [0, 4, 6, 9]
+```
+
+Chord vocabulary spans triads through thirteenths — `dim7`, `m7b5`, `minMaj7`,
+`aug7`, sixths, and altered dominants included.
+
+Or generate a progression from a style preset (a collection-level operation, so
+it stays functional):
+
+```ts
+import { generateProgression, majorKey } from '@libraz/libcantus';
+
+// One chord per bar, secondary dominants inserted where they fit:
+generateProgression({ key: majorKey(0), style: 'idol', bars: 8, reharmonize: true, seed: 1 });
+```
+
+## Analyze harmony
+
+Turn chords into Roman-numeral analysis with function, cadences, and modal
+interchange — in major and minor, respecting inversions:
+
+```ts
+import { Chord, Key } from '@libraz/libcantus';
+
+// A minor iv in a major key reads as a borrowed subdominant:
+Chord.of('F', 'min').analyze(Key.major('C'));
+// { function: 'subdominant', borrowed: true, source: 'parallel-minor', roman: 'iv' }
+```
+
+## Recognize what you hear
+
+Notes in, chord or key out — the inverse of the builders:
+
+```ts
+import { Chord, detectKey } from '@libraz/libcantus';
+
+Chord.detect([60, 64, 67])[0].symbol(); // 'C'
+Chord.detectBest([60, 63, 67, 70])?.symbol(); // 'Cm7'
+detectKey([0, 0, 0, 4, 7])[0]; // C major, best fit  (key ranking stays functional)
+```
+
+## Spell chords and scales
+
+A `Key` carries a spelled tonic, so the pitch-class core produces letter names,
+correct in major and minor:
+
+```ts
+import { Chord, Key } from '@libraz/libcantus';
+
+Key.named('harmonicMinor', 'A').noteNames(); // ['A', 'B', 'C', 'D', 'E', 'F', 'G#']
+Key.minor('E').noteNames(); // ['E', 'F#', 'G', 'A', 'B', 'C', 'D']
+
+// Chords spell in a key's context too:
+Key.major('C').chord(4, 'dom7').spell().map((n) => n.name); // ['G', 'B', 'D', 'F']
+```
+
+## Reharmonize
+
+Reflect a chord through negative harmony on the class, or list substitution
+candidates — tritone, relative, borrowed, and chromatic-mediant subs, plus
+modal-interchange palettes — with the functions:
+
+```ts
+import { Chord, Key, majorKey, parseChordSymbol, substituteChord } from '@libraz/libcantus';
+
+Key.major('C').chord(4, 'dom7').negativeHarmony().symbol(); // 'Dm7b5'
+
+// Substitution/palette search returns lists, so it stays functional:
+substituteChord(parseChordSymbol('G7'), majorKey(0));
+// [{ chord: Db7, type: 'tritone', ... }, ...]
+```
+
+## Choose scales and tensions
+
+Find scales compatible with a chord and its available tensions and avoid notes
+on the class; get a continuity-optimized scale choice across a whole set of
+changes with `scalesForChanges`:
+
+```ts
+import { Chord } from '@libraz/libcantus';
+
+Chord.of('C', 'dom7').scales()[0]; // { name: 'mixolydian', rootPc: 0 }
+Chord.of('C', 'maj7').tensions('ionian'); // [2, 9]  (9 and 13; the 11 is an avoid note)
+```
+
+## Voice chords
+
+Realize a progression into smooth 4-voice (SATB) MIDI voicings with minimal
+motion, or voice a single chord in a comping style (drop-2/3, shell, rootless):
+
+```ts
+import { Chord, Key } from '@libraz/libcantus';
+
+const c = Key.major('C');
+
+// A whole progression, voiced with minimal motion:
+c.chord(0, 'maj').progressionTo(c.chord(5, 'maj'), c.chord(4, 'dom7'), c.chord(0, 'maj')).voice();
+// [[...], [...], [...], [...]]  (one ascending pitch per voice)
+
+// A single chord in a shell comping voicing:
+Chord.of('C', 'maj7').styledVoicing({ style: 'shell' }); // root, third, seventh
+```
+
+`voiceLeadingCost` and `nextVoicing` let you steer the leading, and the
+`counterpoint` predicates (parallel/hidden perfects, spacing, voice crossing,
+leading-tone resolution, …) let you validate it.
+
+## Generate parts
+
+Seeded, deterministic generators for melody and accompaniment:
+
+```ts
+import {
+  generateBassLine, generateCounterMelody, generateDrums, generateRhythm,
+  generateMotif, parseTimeSignature,
+} from '@libraz/libcantus';
+
+generateRhythm(parseTimeSignature('4/4'), { seed: 1, density: 0.5 }); // strong-beat-weighted onsets
+generateMotif({ key: majorKey(0), length: 4, contour: 'arch', seed: 1 }); // a short melodic cell
+```
+
+`humanize`, `extractGrooveTemplate`, and `applyGrooveTemplate` add a meter-aware
+feel — or capture the feel of one performance and transplant it onto another.
+
+## Arrange from a DAW or MIDI file
+
+The arrangement layer takes raw multi-track `NoteEvent`s, recovers the harmony,
+then analyses and generates against it:
+
+```ts
+import {
+  analyzeArrangement, chordTimelineFromNotes, generateBassLine, generateCounterMelody,
+} from '@libraz/libcantus';
+
+// Infer a chord progression (and the key) from played notes:
+const { timeline, key } = chordTimelineFromNotes(melodyAndChordNotes);
+
+// Whole-piece analysis: inferred chords, cadences, per-note theory labels, and
+// notes that clash with the sounding harmony (with reasons and suggestions):
+const report = analyzeArrangement([
+  { role: 'melody', notes: melodyNotes },
+  { role: 'harmony', notes: chordNotes },
+]);
+report.conflicts; // [{ beat, trackName, pitch, safety, reasons, rationale }, ...]
+
+// Generate the missing parts from the recovered timeline:
+generateBassLine({ segments: timeline.segments, key, style: 'walking', seed: 1 });
+generateCounterMelody({ melody: melodyNotes, chordAt: timeline.at, key, register: 'below' });
+```
+
+`harmonizeMelody` goes the other way — given a bare melody, it searches for the
+best key, transpose, and chord path (with optional reharmonization) to harmonize
+it.
+
+Note events shared across the arrangement and generation modules use one type,
+`NoteEvent` (`{ pitch, startBeat, durationBeat, velocity? }`, MIDI pitch in
+quarter-note beats). Seeded generators (`bass`, `groove`, `countermelody`,
+`rhythm`, `drums`, `motif`, `progression`) are deterministic for a given seed.
+
+## Work with pitch as sound
+
+Frequencies, cents, EDO, and just intonation — for tuning, microtonality, and
+analysis:
+
+```ts
+import { frequencyOf, edo, justDeviationCents } from '@libraz/libcantus';
+```
+
+Meter helpers (`TimeSignature`, `parseTimeSignature`, `beatsPerBar`,
+`metricWeight`, `isStrongBeat`, `tuplet`) cover simple and compound meters and
+back the accent-aware generators.
+
+## License
+
+Apache-2.0