@ugfoundation/swaralipi-js 0.13.0 → 0.14.0

package/dist/player/index.d.cts

@@ -1,8 +1,8 @@
 import { S as Swaralipi, T as Taal, O as Octave, a as SvaraLetter, N as Note } from '../schema-DZag9qkF.cjs';
 import { a as LaySpeeds, T as TaalId } from '../lay-CXhC-HRO.cjs';
 export { b as LAYS, c as LAY_SPEEDS, L as Lay, p as printedLay, r as resolveLaySpeeds, d as rowLay } from '../lay-CXhC-HRO.cjs';
-import { I as InstrumentId, a as InstrumentDef, S as Schedule, D as DrumVoice, T as TempoSegment } from '../schedule-V-fgepvP.cjs';
-export { A as ARC_RAW_RE, b as DEFAULT_SOUNDS_BASE, c as DRUM_KIT_BASE, G as GRACE_STEP, d as GlideLeg, e as INSTRUMENTS, L as Line, M as MEEND_HOLD, P as PlayEvent, f as SALAMANDER_BASE, g as SAMPLED_TAALS, h as ScheduleOptions, i as TABLA_BPMS, j as TABLA_VARIATIONS, k as TONEJS_INSTRUMENTS_BASE, l as ToneModule, m as buildSchedule, n as createBuffers, o as drumPattern, p as eventAt, q as glideTargets, r as graceTouches, s as instrumentSampleUrl, t as isArcRaw, u as meendContinuations, v as nearestSampleKey, w as nearestTablaBpm, x as normalizeBase, y as probeUrl, z as quantizeLoopEnd, B as santoorUrls, C as scheduleLines, E as subsetUrls, F as tablaBpms, H as tablaUrl, J as triggerGlide } from '../schedule-V-fgepvP.cjs';
+import { I as InstrumentId, a as InstrumentDef, E as Excerpt, S as Schedule, D as DrumVoice, T as TempoSegment } from '../schedule-oJgg_bnc.cjs';
+export { A as ARC_RAW_RE, b as DEFAULT_SOUNDS_BASE, c as DRUM_KIT_BASE, G as GRACE_STEP, d as GlideLeg, e as INSTRUMENTS, L as Line, f as LyricMap, M as MEEND_HOLD, P as PlayEvent, g as SALAMANDER_BASE, h as SAMPLED_TAALS, i as ScheduleOptions, j as TABLA_BPMS, k as TABLA_VARIATIONS, l as TONEJS_INSTRUMENTS_BASE, m as ToneModule, n as alignLyrics, o as buildSchedule, p as createBuffers, q as drumPattern, r as eventAt, s as glideTargets, t as graceTouches, u as instrumentSampleUrl, v as isArcRaw, w as meendContinuations, x as nearestSampleKey, y as nearestTablaBpm, z as normalizeBase, B as probeUrl, C as quantizeLoopEnd, F as santoorUrls, H as scheduleLines, J as subsetUrls, K as tablaBpms, N as tablaUrl, O as triggerGlide } from '../schedule-oJgg_bnc.cjs';
 import 'zod';
 import 'tone';
 
@@ -140,8 +140,12 @@ declare class SwaralipiPlayer {
     get loop(): LineRange | null;
     /** Whether each repeat is followed by a silent pass for the learner. */
     get echo(): boolean;
-    /** Set the document to play. Stops any current playback. */
-    load(doc: Swaralipi): void;
+    /** Set the document to play. Stops any current playback. With `excerpt`,
+     * only the notes singing those stretches of the song's text play, in order
+     * (see `alignLyrics`); the length, seeks and repeats all keep to them. */
+    load(doc: Swaralipi, { excerpt }?: {
+        excerpt?: Excerpt;
+    }): void;
     /**
      * Taal mode: loop one avartan of a taal's theka (rhythm only, no melody) —
      * for a standalone theka player. `play()` loops indefinitely (tabla loop /
@@ -417,4 +421,4 @@ declare function sampleFileName(midi: number): string;
  */
 declare function sCurve(x: number, steepness?: number): number;
 
-export { type AudioExportOptions, type AudioExportResult, type AudioFormat, type BindSheetOptions, DrumVoice, InstrumentDef, InstrumentId, LaySpeeds, type LineRange, type MidiExportOptions, type MidiExportResult, OCTAVE_OFFSET, type PlayerOptions, type PlayerState, type PracticeState, type RhythmMode, SHUDDHA, Schedule, SwaralipiPlayer, TempoSegment, encodeMidi, encodeMp3, encodeWav, exportAudio, exportMidi, midiToSampleName, parseTonic, sCurve, sampleFileName, svaraSemitone, svaraToMidi };
+export { type AudioExportOptions, type AudioExportResult, type AudioFormat, type BindSheetOptions, DrumVoice, Excerpt, InstrumentDef, InstrumentId, LaySpeeds, type LineRange, type MidiExportOptions, type MidiExportResult, OCTAVE_OFFSET, type PlayerOptions, type PlayerState, type PracticeState, type RhythmMode, SHUDDHA, Schedule, SwaralipiPlayer, TempoSegment, encodeMidi, encodeMp3, encodeWav, exportAudio, exportMidi, midiToSampleName, parseTonic, sCurve, sampleFileName, svaraSemitone, svaraToMidi };

package/dist/player/index.d.ts

@@ -1,8 +1,8 @@
 import { S as Swaralipi, T as Taal, O as Octave, a as SvaraLetter, N as Note } from '../schema-DZag9qkF.js';
 import { a as LaySpeeds, T as TaalId } from '../lay-CWlEhImP.js';
 export { b as LAYS, c as LAY_SPEEDS, L as Lay, p as printedLay, r as resolveLaySpeeds, d as rowLay } from '../lay-CWlEhImP.js';
-import { I as InstrumentId, a as InstrumentDef, S as Schedule, D as DrumVoice, T as TempoSegment } from '../schedule-ClyON98C.js';
-export { A as ARC_RAW_RE, b as DEFAULT_SOUNDS_BASE, c as DRUM_KIT_BASE, G as GRACE_STEP, d as GlideLeg, e as INSTRUMENTS, L as Line, M as MEEND_HOLD, P as PlayEvent, f as SALAMANDER_BASE, g as SAMPLED_TAALS, h as ScheduleOptions, i as TABLA_BPMS, j as TABLA_VARIATIONS, k as TONEJS_INSTRUMENTS_BASE, l as ToneModule, m as buildSchedule, n as createBuffers, o as drumPattern, p as eventAt, q as glideTargets, r as graceTouches, s as instrumentSampleUrl, t as isArcRaw, u as meendContinuations, v as nearestSampleKey, w as nearestTablaBpm, x as normalizeBase, y as probeUrl, z as quantizeLoopEnd, B as santoorUrls, C as scheduleLines, E as subsetUrls, F as tablaBpms, H as tablaUrl, J as triggerGlide } from '../schedule-ClyON98C.js';
+import { I as InstrumentId, a as InstrumentDef, E as Excerpt, S as Schedule, D as DrumVoice, T as TempoSegment } from '../schedule-DsVESieT.js';
+export { A as ARC_RAW_RE, b as DEFAULT_SOUNDS_BASE, c as DRUM_KIT_BASE, G as GRACE_STEP, d as GlideLeg, e as INSTRUMENTS, L as Line, f as LyricMap, M as MEEND_HOLD, P as PlayEvent, g as SALAMANDER_BASE, h as SAMPLED_TAALS, i as ScheduleOptions, j as TABLA_BPMS, k as TABLA_VARIATIONS, l as TONEJS_INSTRUMENTS_BASE, m as ToneModule, n as alignLyrics, o as buildSchedule, p as createBuffers, q as drumPattern, r as eventAt, s as glideTargets, t as graceTouches, u as instrumentSampleUrl, v as isArcRaw, w as meendContinuations, x as nearestSampleKey, y as nearestTablaBpm, z as normalizeBase, B as probeUrl, C as quantizeLoopEnd, F as santoorUrls, H as scheduleLines, J as subsetUrls, K as tablaBpms, N as tablaUrl, O as triggerGlide } from '../schedule-DsVESieT.js';
 import 'zod';
 import 'tone';
 
@@ -140,8 +140,12 @@ declare class SwaralipiPlayer {
     get loop(): LineRange | null;
     /** Whether each repeat is followed by a silent pass for the learner. */
     get echo(): boolean;
-    /** Set the document to play. Stops any current playback. */
-    load(doc: Swaralipi): void;
+    /** Set the document to play. Stops any current playback. With `excerpt`,
+     * only the notes singing those stretches of the song's text play, in order
+     * (see `alignLyrics`); the length, seeks and repeats all keep to them. */
+    load(doc: Swaralipi, { excerpt }?: {
+        excerpt?: Excerpt;
+    }): void;
     /**
      * Taal mode: loop one avartan of a taal's theka (rhythm only, no melody) —
      * for a standalone theka player. `play()` loops indefinitely (tabla loop /
@@ -417,4 +421,4 @@ declare function sampleFileName(midi: number): string;
  */
 declare function sCurve(x: number, steepness?: number): number;
 
-export { type AudioExportOptions, type AudioExportResult, type AudioFormat, type BindSheetOptions, DrumVoice, InstrumentDef, InstrumentId, LaySpeeds, type LineRange, type MidiExportOptions, type MidiExportResult, OCTAVE_OFFSET, type PlayerOptions, type PlayerState, type PracticeState, type RhythmMode, SHUDDHA, Schedule, SwaralipiPlayer, TempoSegment, encodeMidi, encodeMp3, encodeWav, exportAudio, exportMidi, midiToSampleName, parseTonic, sCurve, sampleFileName, svaraSemitone, svaraToMidi };
+export { type AudioExportOptions, type AudioExportResult, type AudioFormat, type BindSheetOptions, DrumVoice, Excerpt, InstrumentDef, InstrumentId, LaySpeeds, type LineRange, type MidiExportOptions, type MidiExportResult, OCTAVE_OFFSET, type PlayerOptions, type PlayerState, type PracticeState, type RhythmMode, SHUDDHA, Schedule, SwaralipiPlayer, TempoSegment, encodeMidi, encodeMp3, encodeWav, exportAudio, exportMidi, midiToSampleName, parseTonic, sCurve, sampleFileName, svaraSemitone, svaraToMidi };

package/dist/player/index.js

@@ -1,5 +1,5 @@
-import { DEFAULT_SOUNDS_BASE, INSTRUMENTS, SAMPLED_TAALS, buildSchedule, eventAt, lineAt, byRow, lineFor, quantizeLoopEnd, instrumentSampleUrl, probeUrl, scheduleLines, GRACE_STEP, normalizeBase, nearestTablaBpm, tablaBpms, graceTouches, midiToSampleName, glideTargets, triggerGlide, createSampler, createBuffers, tablaShiftSemitones, tablaUrl, TABLA_GRAIN_OVERLAP_SEC, TABLA_GRAIN_SEC, createDrumKit, drumPattern, createMetronome, TANPURA_PCS, createTanpura, parseTonic, MEEND_HOLD, sCurve } from '../chunk-ZNJTMQIX.js';
-export { ARC_RAW_RE, DEFAULT_SOUNDS_BASE, DRUM_KIT_BASE, GRACE_STEP, INSTRUMENTS, MEEND_HOLD, OCTAVE_OFFSET, SALAMANDER_BASE, SAMPLED_TAALS, SHUDDHA, TABLA_BPMS, TABLA_VARIATIONS, TONEJS_INSTRUMENTS_BASE, buildSchedule, createBuffers, drumPattern, eventAt, glideTargets, graceTouches, instrumentSampleUrl, isArcRaw, meendContinuations, midiToSampleName, nearestSampleKey, nearestTablaBpm, normalizeBase, parseTonic, probeUrl, quantizeLoopEnd, sCurve, sampleFileName, santoorUrls, scheduleLines, subsetUrls, svaraSemitone, svaraToMidi, tablaBpms, tablaUrl, triggerGlide } from '../chunk-ZNJTMQIX.js';
+import { DEFAULT_SOUNDS_BASE, INSTRUMENTS, SAMPLED_TAALS, buildSchedule, eventAt, lineAt, byRow, lineFor, quantizeLoopEnd, instrumentSampleUrl, probeUrl, scheduleLines, GRACE_STEP, normalizeBase, nearestTablaBpm, tablaBpms, graceTouches, midiToSampleName, glideTargets, triggerGlide, createSampler, createBuffers, tablaShiftSemitones, tablaUrl, TABLA_GRAIN_OVERLAP_SEC, TABLA_GRAIN_SEC, createDrumKit, drumPattern, createMetronome, TANPURA_PCS, createTanpura, parseTonic, MEEND_HOLD, sCurve } from '../chunk-YBFM5NLW.js';
+export { ARC_RAW_RE, DEFAULT_SOUNDS_BASE, DRUM_KIT_BASE, GRACE_STEP, INSTRUMENTS, MEEND_HOLD, OCTAVE_OFFSET, SALAMANDER_BASE, SAMPLED_TAALS, SHUDDHA, TABLA_BPMS, TABLA_VARIATIONS, TONEJS_INSTRUMENTS_BASE, alignLyrics, buildSchedule, createBuffers, drumPattern, eventAt, glideTargets, graceTouches, instrumentSampleUrl, isArcRaw, meendContinuations, midiToSampleName, nearestSampleKey, nearestTablaBpm, normalizeBase, parseTonic, probeUrl, quantizeLoopEnd, sCurve, sampleFileName, santoorUrls, scheduleLines, subsetUrls, svaraSemitone, svaraToMidi, tablaBpms, tablaUrl, triggerGlide } from '../chunk-YBFM5NLW.js';
 import '../chunk-BSZ3WQUP.js';
 import { TAALS } from '../chunk-KOHSKHXI.js';
 export { LAYS, LAY_SPEEDS, printedLay, resolveLaySpeeds, rowLay } from '../chunk-KOHSKHXI.js';
@@ -45,6 +45,8 @@ var SwaralipiPlayer = class {
   /** Per-song setBpm tweak: beats meta.bpm but is cleared by the next load(). */
   #bpmTweak;
   #doc;
+  /** Play only these stretches of the song's text (see `load`). */
+  #excerpt;
   /** Taal mode (`loadTaal`): loops one avartan of this taal's theka with no
    * melody. Mutually exclusive with `#doc`. */
   #taal;
@@ -87,6 +89,8 @@ var SwaralipiPlayer = class {
   /** Listeners on the bound sheet, removed on rebind. */
   #unbind;
   #sheet;
+  /** The bound sheet's highlight — beside, never instead of, the consumer's `onHighlight`. */
+  #paint;
   /** Preview cap, counted in listening time so a seek or a loop can't dodge it. */
   #listened = 0;
   #listenedSince = 0;
@@ -177,10 +181,13 @@ var SwaralipiPlayer = class {
   /* ----------------------------------------------------------------- */
   /* Loading + transport control                                        */
   /* ----------------------------------------------------------------- */
-  /** Set the document to play. Stops any current playback. */
-  load(doc) {
+  /** Set the document to play. Stops any current playback. With `excerpt`,
+   * only the notes singing those stretches of the song's text play, in order
+   * (see `alignLyrics`); the length, seeks and repeats all keep to them. */
+  load(doc, { excerpt } = {}) {
     this.#halt();
     this.#doc = doc;
+    this.#excerpt = excerpt;
     this.#taal = void 0;
     this.#taalOverride = void 0;
     this.#bpmTweak = void 0;
@@ -503,7 +510,7 @@ var SwaralipiPlayer = class {
    */
   bindSheet(target, opts = {}) {
     const block = opts.autoScroll === true ? "center" : opts.autoScroll || void 0;
-    this.#opts.onHighlight = (path, yourTurn) => {
+    this.#paint = (path, yourTurn) => {
       target.clearHighlights();
       if (path === null) return;
       const el2 = target.highlight(path, yourTurn);
@@ -615,6 +622,7 @@ var SwaralipiPlayer = class {
     this.#opts.onState?.(state);
   }
   #emitHighlight(path, yourTurn = false) {
+    this.#paint?.(path, yourTurn);
     this.#opts.onHighlight?.(path, yourTurn);
   }
   #emitLoop() {
@@ -772,7 +780,8 @@ var SwaralipiPlayer = class {
       tonic: this.#opts.tonic,
       baseOctave: this.#opts.baseOctave,
       laySpeeds: this.#opts.laySpeeds,
-      repeats: this.#opts.repeats
+      repeats: this.#opts.repeats,
+      excerpt: this.#excerpt
     };
   }
   /** Effective tempo: snapped to the taal's available tabla tempos while a