@libraz/libsonare 1.2.2 → 1.3.0

package/src/sonare.js.d.ts

@@ -60,6 +60,8 @@ export interface WasmRealtimeVoiceChangerPodConfig {
   reverb_seed: number;
   limiter_ceiling_db: number;
   limiter_release_ms: number;
+  limiter_enable_isp_limiter: boolean;
+  limiter_isp_ceiling_dbtp: number;
 }
 
 export interface WasmBeatResult {
@@ -96,6 +98,8 @@ export interface WasmTimbreResult {
 
 export interface WasmDynamicsResult {
   dynamicRangeDb: number;
+  peakDb: number;
+  rmsDb: number;
   loudnessRangeDb: number;
   crestFactor: number;
   isCompressed: boolean;
@@ -105,6 +109,8 @@ export interface WasmRhythmResult {
   syncopation: number;
   grooveType: string;
   patternRegularity: number;
+  tempoStability: number;
+  timeSignature: WasmTimeSignatureResult;
 }
 
 export interface WasmTimeSignatureResult {
@@ -113,6 +119,14 @@ export interface WasmTimeSignatureResult {
   confidence: number;
 }
 
+export interface WasmMelodyContourResult {
+  pitchRangeOctaves: number;
+  pitchStability: number;
+  meanFrequency: number;
+  vibratoRate: number;
+  pitches: WasmMelodyPoint[];
+}
+
 export interface WasmAnalysisResult {
   bpm: number;
   bpmConfidence: number;
@@ -124,6 +138,7 @@ export interface WasmAnalysisResult {
   timbre: WasmTimbreResult;
   dynamics: WasmDynamicsResult;
   rhythm: WasmRhythmResult;
+  melody: WasmMelodyContourResult;
   form: string;
 }
 
@@ -161,6 +176,27 @@ export interface WasmDynamicsAnalysisResult {
   loudnessRmsDb: Float32Array;
 }
 
+export interface WasmStreamConfigDefaults {
+  sampleRate: number;
+  nFft: number;
+  hopLength: number;
+  nMels: number;
+  fmin: number;
+  fmax: number;
+  tuningRefHz: number;
+  computeMagnitude: boolean;
+  computeMel: boolean;
+  computeChroma: boolean;
+  computeOnset: boolean;
+  computeSpectral: boolean;
+  emitEveryNFrames: number;
+  magnitudeDownsample: number;
+  keyUpdateIntervalSec: number;
+  bpmUpdateIntervalSec: number;
+  window: number;
+  outputFormat: number;
+}
+
 export interface WasmTimbreFrameResult {
   brightness: number;
   warmth: number;
@@ -199,12 +235,76 @@ export interface WasmAcousticResult {
   isBlind: boolean;
 }
 
+export interface WasmRoomGeometryOptions {
+  lengthM?: number;
+  widthM?: number;
+  heightM?: number;
+  absorption?: number;
+  materialPreset?: number;
+  bandAbsorption?: Float32Array | number[];
+  bandScattering?: Float32Array | number[];
+  sourceX?: number;
+  sourceY?: number;
+  sourceZ?: number;
+  listenerX?: number;
+  listenerY?: number;
+  listenerZ?: number;
+  ismOrder?: number;
+  seed?: number;
+  maxSeconds?: number;
+}
+
+export interface WasmRirSynthOptions extends WasmRoomGeometryOptions {
+  sampleRate?: number;
+  preferEyring?: boolean;
+  mixingTimeMs?: number;
+  crossfadeMs?: number;
+}
+
+export interface WasmRirResult {
+  rir: Float32Array;
+  sampleRate: number;
+  hasError: boolean;
+}
+
+export interface WasmRoomEstimateOptions {
+  aspectHintLw?: number;
+  aspectHintLh?: number;
+  referenceAbsorption?: number;
+  preferEyring?: boolean;
+  nOctaveBands?: number;
+  mode?: number;
+  minDecayDb?: number;
+  noiseFloorMarginDb?: number;
+}
+
+export interface WasmRoomEstimateResult {
+  volume: number;
+  length: number;
+  width: number;
+  height: number;
+  drrDb: number;
+  confidence: number;
+  absorptionBands: Float32Array;
+  rt60Bands: Float32Array;
+}
+
+export interface WasmRoomMorphOptions extends WasmRoomGeometryOptions {
+  wet?: number;
+  sourceTailSuppression?: number;
+}
+
 export interface WasmHpssResult {
   harmonic: Float32Array;
   percussive: Float32Array;
   sampleRate: number;
 }
 
+export interface WasmAudioFromMemoryResult {
+  samples: Float32Array;
+  sampleRate: number;
+}
+
 export interface WasmHpssWithResidualResult {
   harmonic: Float32Array;
   percussive: Float32Array;
@@ -314,6 +414,12 @@ export interface WasmFourierTempogramResult {
   data: Float32Array;
 }
 
+export interface WasmOnsetStrengthMultiResult {
+  nBands: number;
+  nFrames: number;
+  data: Float32Array;
+}
+
 export interface WasmNnlsChromaResult {
   nChroma: number;
   nFrames: number;
@@ -412,7 +518,7 @@ export interface WasmMixResult {
 
 export interface WasmEngineClip {
   id?: number;
-  channels: Float32Array[];
+  channels?: Float32Array[];
   startPpq: number;
   lengthSamples?: number;
   clipOffsetSamples?: number;
@@ -420,6 +526,15 @@ export interface WasmEngineClip {
   gain?: number;
   fadeInSamples?: number;
   fadeOutSamples?: number;
+  warpMode?: 'off' | 'repitch' | 'tempo-sync' | 0 | 1 | 2;
+  warpAnchors?: Array<{ warpSample: number; sourceSample: number }>;
+  pageProvider?: number | { readonly id: number };
+}
+
+export interface WasmClipPageRequest {
+  clipId: number;
+  channel: number;
+  sample: number;
 }
 
 export interface WasmEngineParameterInfo {
@@ -450,6 +565,8 @@ export interface WasmEngineMetronomeConfig {
   beatGain?: number;
   accentGain?: number;
   clickSamples?: number;
+  /** Optional click length in seconds; > 0 overrides the engine 2 ms default. */
+  clickSeconds?: number;
 }
 
 export interface WasmEngineGraphNode {
@@ -516,6 +633,8 @@ export interface WasmEngineCaptureStatus {
   overflowCount: number;
   armed: boolean;
   punchEnabled: boolean;
+  source: 'output' | 'input';
+  recordOffsetSamples: number;
 }
 
 export interface WasmEngineTransportState {
@@ -528,6 +647,12 @@ export interface WasmEngineTransportState {
   loopStartPpq: number;
   loopEndPpq: number;
   sampleRate: number;
+  /** PPQ of the current bar's downbeat (derived from the tempo map). */
+  barStartPpq: number;
+  /** Zero-based index of the current bar. */
+  barCount: number;
+  /** Time signature in effect at the current PPQ. */
+  timeSignature: { numerator: number; denominator: number; confidence: number };
 }
 
 export interface WasmEngineBounceOptions {
@@ -608,13 +733,85 @@ export interface WasmRealtimeEngine {
   graphConnectionCount: () => number;
   setClips: (clips: WasmEngineClip[]) => void;
   clipCount: () => number;
+  createClipPageProvider: (numChannels: number, numSamples: number, pageFrames: number) => number;
+  supplyClipPage: (providerId: number, pageIndex: number, channels: Float32Array[]) => void;
+  clearClipPage: (providerId: number, pageIndex: number) => void;
+  destroyClipPageProvider: (providerId: number) => void;
+  popClipPageRequest: () => WasmClipPageRequest | null;
   setCaptureBuffer: (numChannels: number, capacityFrames: number) => void;
   armCapture: (armed: boolean) => void;
   setCapturePunch: (startSample: number, endSample: number, enabled: boolean) => void;
+  setCaptureSource: (source: WasmEngineCaptureStatus['source']) => void;
+  setRecordOffsetSamples: (offsetSamples: number) => void;
+  setInputMonitor: (enabled: boolean, gain: number) => void;
   resetCapture: () => void;
   captureStatus: () => WasmEngineCaptureStatus;
   capturedAudio: () => Float32Array[];
+  setBuiltinInstrument: (destinationId: number, config: object) => void;
+  clearMidiInstrument: (destinationId: number) => void;
+  midiInstrumentCount: () => number;
+  bindMidiCc: (
+    channel: number,
+    controller: number,
+    paramId: number,
+    minValue: number,
+    maxValue: number,
+  ) => void;
+  clearMidiCcBindings: () => void;
+  midiCcBindingCount: () => number;
+  setMidiInputSource: (destinationId: number) => void;
+  clearMidiInputSource: () => void;
+  midiInputPendingCount: () => number;
+  pushMidiInputNoteOn: (
+    group: number,
+    channel: number,
+    note: number,
+    velocity: number,
+    portTimeSamples: number,
+  ) => void;
+  pushMidiInputNoteOff: (
+    group: number,
+    channel: number,
+    note: number,
+    velocity: number,
+    portTimeSamples: number,
+  ) => void;
+  pushMidiInputCc: (
+    group: number,
+    channel: number,
+    controller: number,
+    value: number,
+    portTimeSamples: number,
+  ) => void;
+  pushMidiNoteOn: (
+    destinationId: number,
+    group: number,
+    channel: number,
+    note: number,
+    velocity: number,
+    renderFrame: number,
+  ) => void;
+  pushMidiNoteOff: (
+    destinationId: number,
+    group: number,
+    channel: number,
+    note: number,
+    velocity: number,
+    renderFrame: number,
+  ) => void;
+  pushMidiCc: (
+    destinationId: number,
+    group: number,
+    channel: number,
+    controller: number,
+    value: number,
+    renderFrame: number,
+  ) => void;
+  pushMidiPanic: (renderFrame: number) => void;
   process: (channels: Float32Array[]) => Float32Array[];
+  prepareChannels: (numChannels: number, maxFrames: number) => void;
+  getChannelBuffer: (channel: number, numFrames: number) => Float32Array;
+  processPrepared: (numFrames: number) => void;
   processWithMonitor: (channels: Float32Array[]) => WasmEngineProcessWithMonitorResult;
   renderOffline: (channels: Float32Array[], blockSize: number) => Float32Array[];
   bounceOffline: (options: WasmEngineBounceOptions) => WasmEngineBounceResult;
@@ -627,7 +824,19 @@ export interface WasmRealtimeEngine {
 export type ProgressCallback = (progress: number, stage: string) => void;
 export type TempogramMode = 'autocorrelation' | 'auto' | 'ac' | 'cosine' | 0 | 1;
 
+export interface WasmSynthEnumTables {
+  engineModes: string[];
+  waveforms: string[];
+  filterModels: string[];
+  filterOutputs: string[];
+  bodyTypes: string[];
+  modSources: string[];
+  modDestinations: string[];
+}
+
 export interface SonareModule {
+  audioFromMemory: (bytes: Uint8Array) => WasmAudioFromMemoryResult;
+
   // Quick API (high-level)
   detectBpm: (samples: Float32Array, sampleRate: number) => number;
   detectKey: (samples: Float32Array, sampleRate: number) => WasmKeyResult;
@@ -676,7 +885,29 @@ export interface SonareModule {
     detectInversions: boolean,
     chromaMethod: number,
   ) => WasmChordAnalysisResult;
+  chordFunctionalAnalysis: (
+    samples: Float32Array,
+    keyRoot: number,
+    keyMode: number,
+    sampleRate: number,
+    minDuration: number,
+    smoothingWindow: number,
+    threshold: number,
+    useTriadsOnly: boolean,
+    nFft: number,
+    hopLength: number,
+    useBeatSync: boolean,
+    useHmm: boolean,
+    hmmBeamWidth: number,
+    useKeyContext: boolean,
+    detectInversions: boolean,
+    chromaMethod: number,
+  ) => string[];
   analyze: (samples: Float32Array, sampleRate: number) => WasmAnalysisResult;
+  _synthEnumTables: () => WasmSynthEnumTables;
+  _synthPatchRoundTrip: (patch: unknown) => unknown;
+  _analysisResultSchemaPaths: () => string[];
+  _analysisResultSchemaFixture: () => WasmAnalysisResult;
   analyzeImpulseResponse: (
     samples: Float32Array,
     sampleRate: number,
@@ -690,6 +921,19 @@ export interface SonareModule {
     minDecayDb: number,
     noiseFloorMarginDb: number,
   ) => WasmAcousticResult;
+  // Acoustic-simulation entry points are present only in builds compiled with
+  // SONARE_WITH_ACOUSTIC_SIM; absent otherwise (the wrappers throw a clear error).
+  synthesizeRir?: (options: WasmRirSynthOptions) => WasmRirResult;
+  estimateRoom?: (
+    samples: Float32Array,
+    sampleRate: number,
+    options: WasmRoomEstimateOptions,
+  ) => WasmRoomEstimateResult;
+  roomMorph?: (
+    samples: Float32Array,
+    sampleRate: number,
+    options: WasmRoomMorphOptions,
+  ) => Float32Array;
   analyzeWithProgress: (
     samples: Float32Array,
     sampleRate: number,
@@ -783,6 +1027,12 @@ export interface SonareModule {
     right: Float32Array,
     sampleRate: number,
   ) => { mid: Float32Array; side: Float32Array };
+  meteringVectorscopeDecimated: (
+    left: Float32Array,
+    right: Float32Array,
+    sampleRate: number,
+    maxPoints: number,
+  ) => { mid: Float32Array; side: Float32Array };
   meteringPhaseScope: (
     left: Float32Array,
     right: Float32Array,
@@ -796,6 +1046,20 @@ export interface SonareModule {
     averageAbsAngleRad: number;
     maxRadius: number;
   };
+  meteringPhaseScopeDecimated: (
+    left: Float32Array,
+    right: Float32Array,
+    sampleRate: number,
+    maxPoints: number,
+  ) => {
+    mid: Float32Array;
+    side: Float32Array;
+    radius: Float32Array;
+    angleRad: Float32Array;
+    correlation: number;
+    averageAbsAngleRad: number;
+    maxRadius: number;
+  };
   meteringSpectrum: (
     samples: Float32Array,
     sampleRate: number,
@@ -814,6 +1078,47 @@ export interface SonareModule {
     nFft: number;
     sampleRate: number;
   };
+  meteringSpectrumFrame: (
+    samples: Float32Array,
+    sampleRate: number,
+    frameOffset: number,
+    options: {
+      nFft?: number;
+      applyOctaveSmoothing?: boolean;
+      octaveFraction?: number;
+      dbRef?: number;
+      dbAmin?: number;
+    },
+  ) => {
+    frequencies: Float32Array;
+    magnitude: Float32Array;
+    power: Float32Array;
+    db: Float32Array;
+    nFft: number;
+    sampleRate: number;
+  };
+  waveformPeaks: (
+    samples: Float32Array,
+    channels: number,
+    samplesPerBucket: number,
+  ) => {
+    min: Float32Array;
+    max: Float32Array;
+    channels: number;
+    bucketCount: number;
+    samplesPerBucket: number;
+  };
+  waveformPeakPyramid: (
+    samples: Float32Array,
+    channels: number,
+    samplesPerBucketLevels: number[],
+  ) => Array<{
+    min: Float32Array;
+    max: Float32Array;
+    channels: number;
+    bucketCount: number;
+    samplesPerBucket: number;
+  }>;
 
   scaleQuantizeMidi: (
     root: number,
@@ -850,6 +1155,15 @@ export interface SonareModule {
     nIter: number,
     beta: number,
   ) => WasmDecomposeResult;
+  decomposeWithInit: (
+    s: Float32Array,
+    nFeatures: number,
+    nFrames: number,
+    nComponents: number,
+    nIter: number,
+    beta: number,
+    init: string,
+  ) => WasmDecomposeResult;
   nnFilter: (
     s: Float32Array,
     nFeatures: number,
@@ -881,6 +1195,15 @@ export interface SonareModule {
     currentMidi: number,
     targetMidi: number,
   ) => Float32Array;
+  pitchCorrectToMidiTimevarying: (
+    samples: Float32Array,
+    sampleRate: number,
+    f0Hz: Float32Array,
+    targetMidi: number,
+    hopLength: number,
+    voiced?: Float32Array,
+    voicedProb?: Float32Array,
+  ) => Float32Array;
   noteStretch: (
     samples: Float32Array,
     sampleRate: number,
@@ -1089,6 +1412,9 @@ export interface SonareModule {
     nFft: number,
     hopLength: number,
     nMels: number,
+    fmin: number,
+    fmax: number,
+    htk: boolean,
   ) => WasmMelResult;
   mfcc: (
     samples: Float32Array,
@@ -1097,6 +1423,9 @@ export interface SonareModule {
     hopLength: number,
     nMels: number,
     nMfcc: number,
+    fmin: number,
+    fmax: number,
+    htk: boolean,
   ) => WasmMfccResult;
 
   // Features - Inverse reconstruction
@@ -1108,6 +1437,7 @@ export interface SonareModule {
     nFft: number,
     fmin: number,
     fmax: number,
+    htk: boolean,
   ) => WasmStftPowerResult;
   melToAudio: (
     melPower: Float32Array,
@@ -1119,6 +1449,7 @@ export interface SonareModule {
     fmin: number,
     fmax: number,
     nIter: number,
+    htk: boolean,
   ) => Float32Array;
   mfccToMel: (
     mfcc: Float32Array,
@@ -1137,6 +1468,7 @@ export interface SonareModule {
     fmin: number,
     fmax: number,
     nIter: number,
+    htk: boolean,
   ) => Float32Array;
 
   // Features - Chroma
@@ -1313,6 +1645,18 @@ export interface SonareModule {
     tempoMax: number,
     winLength: number,
   ) => Float32Array;
+  chromaCens: (
+    samples: Float32Array,
+    sampleRate: number,
+    hopLength: number,
+    nChroma: number,
+  ) => WasmChromaResult;
+  bassChroma: (
+    samples: Float32Array,
+    sampleRate: number,
+    hopLength: number,
+    nChroma: number,
+  ) => WasmChromaResult;
   nnlsChroma: (samples: Float32Array, sampleRate: number) => WasmNnlsChromaResult;
   cqt: (
     samples: Float32Array,
@@ -1322,6 +1666,22 @@ export interface SonareModule {
     nBins: number,
     binsPerOctave: number,
   ) => WasmCqtResult;
+  pseudoCqt: (
+    samples: Float32Array,
+    sampleRate: number,
+    hopLength: number,
+    fmin: number,
+    nBins: number,
+    binsPerOctave: number,
+  ) => WasmCqtResult;
+  hybridCqt: (
+    samples: Float32Array,
+    sampleRate: number,
+    hopLength: number,
+    fmin: number,
+    nBins: number,
+    binsPerOctave: number,
+  ) => WasmCqtResult;
   vqt: (
     samples: Float32Array,
     sampleRate: number,
@@ -1346,6 +1706,8 @@ export interface SonareModule {
     frameLength: number,
     hopLength: number,
     threshold: number,
+    usePyin: boolean,
+    center: boolean,
   ) => WasmMelodyResult;
   onsetEnvelope: (
     samples: Float32Array,
@@ -1354,6 +1716,14 @@ export interface SonareModule {
     hopLength: number,
     nMels: number,
   ) => Float32Array;
+  onsetStrengthMulti: (
+    samples: Float32Array,
+    sampleRate: number,
+    nFft: number,
+    hopLength: number,
+    nMels: number,
+    nBands: number,
+  ) => WasmOnsetStrengthMultiResult;
   fourierTempogram: (
     onsetEnvelope: Float32Array,
     sampleRate: number,
@@ -1425,6 +1795,7 @@ export interface SonareModule {
   };
 
   // Streaming - StreamAnalyzer
+  streamAnalyzerConfigDefault: () => WasmStreamConfigDefaults;
   StreamAnalyzer: new (
     sampleRate: number,
     nFft: number,
@@ -1605,8 +1976,9 @@ export interface WasmMixer {
     timing: number,
   ) => number;
   setSendDb: (stripIndex: number, sendIndex: number, sendDb: number) => void;
+  removeSend: (stripIndex: number, sendIndex: number) => void;
   meterTap: (stripIndex: number, tap: number) => WasmMixMeterSnapshot;
-  stripMeter: (stripIndex: number, tap: number) => WasmMixMeterSnapshot;
+  stripMeter: (stripIndex: number) => WasmMixMeterSnapshot;
   scheduleFaderAutomation: (
     stripIndex: number,
     samplePos: number,
@@ -1637,9 +2009,16 @@ export interface WasmMixer {
   removeBus: (id: string) => void;
   busCount: () => number;
   addVcaGroup: (id: string, gainDb: number, members: string[]) => void;
+  setVcaGroupGainDb: (id: string, gainDb: number) => void;
   removeVcaGroup: (id: string) => void;
   vcaGroupCount: () => number;
   toSceneJson: () => string;
+  tailSamples: () => number;
+  drainTailStereo: (numSamples: number) => {
+    left: Float32Array;
+    right: Float32Array;
+    sampleRate: number;
+  };
   delete: () => void;
 }
 
@@ -1703,6 +2082,8 @@ export interface WasmAnalyzerStats {
 
 export interface WasmFrameBuffer {
   nFrames: number;
+  /** Number of mel bands; flat `mel` is `[nFrames * nMels]` row-major. */
+  nMels: number;
   timestamps: Float32Array;
   mel: Float32Array;
   chroma: Float32Array;
@@ -1742,10 +2123,11 @@ export interface WasmStreamFramesI16 {
 export interface WasmStreamAnalyzer {
   process: (samples: Float32Array) => void;
   processWithOffset: (samples: Float32Array, sampleOffset: number) => void;
+  finalize: () => void;
   availableFrames: () => number;
   readFramesSoa: (maxFrames: number) => WasmFrameBuffer;
-  readFramesU8: (maxFrames: number) => WasmStreamFramesU8;
-  readFramesI16: (maxFrames: number) => WasmStreamFramesI16;
+  readFramesU8: (maxFrames: number, quantizeConfig?: unknown) => WasmStreamFramesU8;
+  readFramesI16: (maxFrames: number, quantizeConfig?: unknown) => WasmStreamFramesI16;
   reset: (baseSampleOffset?: number) => void;
   stats: () => WasmAnalyzerStats;
   frameCount: () => number;