@waveform-playlist/spectrogram 12.0.0 → 13.0.0

package/dist/index.d.mts

@@ -1,53 +1,6 @@
-import { SpectrogramConfig, SpectrogramData, ColorMapValue, RenderMode } from '@waveform-playlist/core';
+import { RenderMode, SpectrogramConfig, ColorMapValue } from '@waveform-playlist/core';
 import React, { ReactNode } from 'react';
 
-/**
- * Compute spectrogram data from an AudioBuffer.
- */
-
-/**
- * Compute spectrogram for a single channel of audio.
- *
- * @param audioBuffer - Source audio buffer
- * @param config - Spectrogram configuration
- * @param offsetSamples - Start offset into the audio buffer
- * @param durationSamples - Number of samples to process
- * @param channel - Channel index (0 = left, 1 = right). Default: 0
- */
-declare function computeSpectrogram(audioBuffer: AudioBuffer, config?: SpectrogramConfig, offsetSamples?: number, durationSamples?: number, channel?: number): SpectrogramData;
-/**
- * Compute a mono (mixed-down) spectrogram from all channels.
- */
-declare function computeSpectrogramMono(audioBuffer: AudioBuffer, config?: SpectrogramConfig, offsetSamples?: number, durationSamples?: number): SpectrogramData;
-
-/**
- * Color maps for spectrogram rendering.
- * Each map is a 256-entry RGB lookup table (768 bytes).
- *
- * Viridis, Magma, Inferno: Perceptually uniform colormaps from matplotlib.
- * By Stéfan van der Walt, Nathaniel Smith, and Eric Firing. Released under CC0.
- * Data from https://github.com/BIDS/colormap
- *
- * Roseus: Perceptually uniform colormap from https://github.com/dofuuz/roseus
- * By dofuuz, licensed under CC0 1.0 Universal.
- */
-
-type ColorLUT = Uint8Array;
-/**
- * Get a 256-entry RGB LUT for the given color map.
- */
-declare function getColorMap(value: ColorMapValue): ColorLUT;
-
-/**
- * Frequency scale mapping functions.
- * Each maps a frequency (Hz) to a normalized position [0, 1].
- */
-type FrequencyScaleName = 'linear' | 'logarithmic' | 'mel' | 'bark' | 'erb';
-/**
- * Returns a mapping function: (frequencyHz, minFrequency, maxFrequency) → [0, 1]
- */
-declare function getFrequencyScale(name: FrequencyScaleName): (f: number, minF: number, maxF: number) => number;
-
 interface TrackMenuItem {
     id: string;
     label?: string;
@@ -74,72 +27,6 @@ interface SpectrogramSettingsModalProps {
 }
 declare const SpectrogramSettingsModal: React.FC<SpectrogramSettingsModalProps>;
 
-/**
- * Error thrown when a spectrogram computation is aborted due to a generation change.
- * Use `instanceof SpectrogramAbortError` instead of string matching on error messages.
- */
-declare class SpectrogramAbortError extends Error {
-    constructor();
-}
-interface SpectrogramWorkerFFTParams {
-    clipId: string;
-    channelDataArrays: Float32Array[];
-    config: SpectrogramConfig;
-    sampleRate: number;
-    offsetSamples: number;
-    durationSamples: number;
-    mono: boolean;
-    sampleRange?: {
-        start: number;
-        end: number;
-    };
-    /** If set, compute only this channel index (used by worker pool). */
-    channelFilter?: number;
-}
-interface SpectrogramWorkerRenderChunksParams {
-    cacheKey: string;
-    canvasIds: string[];
-    canvasWidths: number[];
-    globalPixelOffsets: number[];
-    canvasHeight: number;
-    devicePixelRatio: number;
-    samplesPerPixel: number;
-    colorLUT: Uint8Array;
-    frequencyScale: string;
-    minFrequency: number;
-    maxFrequency: number;
-    gainDb: number;
-    rangeDb: number;
-    channelIndex: number;
-}
-interface SpectrogramWorkerApi {
-    computeFFT(params: SpectrogramWorkerFFTParams, generation?: number): Promise<{
-        cacheKey: string;
-    }>;
-    renderChunks(params: SpectrogramWorkerRenderChunksParams, generation?: number): Promise<void>;
-    abortGeneration(generation: number): void;
-    registerCanvas(canvasId: string, canvas: OffscreenCanvas): void;
-    unregisterCanvas(canvasId: string): void;
-    registerAudioData(clipId: string, channelDataArrays: Float32Array[], sampleRate: number): void;
-    unregisterAudioData(clipId: string): void;
-    terminate(): void;
-}
-/**
- * Wraps a Web Worker running `spectrogram.worker.ts` with a promise-based API.
- *
- * The caller is responsible for creating the Worker, e.g.:
- * ```ts
- * const worker = new Worker(
- *   new URL('@waveform-playlist/spectrogram/worker/spectrogram.worker', import.meta.url),
- *   { type: 'module' }
- * );
- * const api = createSpectrogramWorker(worker);
- * ```
- */
-declare function createSpectrogramWorker(worker: Worker): SpectrogramWorkerApi;
-
-declare function createSpectrogramWorkerPool(createWorker: () => Worker, poolSize?: number): SpectrogramWorkerApi;
-
 interface SpectrogramProviderProps {
     config?: SpectrogramConfig;
     colorMap?: ColorMapValue;
@@ -149,4 +36,4 @@ interface SpectrogramProviderProps {
 }
 declare const SpectrogramProvider: React.FC<SpectrogramProviderProps>;
 
-export { type FrequencyScaleName, SpectrogramAbortError, SpectrogramMenuItems, type SpectrogramMenuItemsProps, SpectrogramProvider, type SpectrogramProviderProps, SpectrogramSettingsModal, type SpectrogramSettingsModalProps, type SpectrogramWorkerApi, type TrackMenuItem, computeSpectrogram, computeSpectrogramMono, createSpectrogramWorker, createSpectrogramWorkerPool, getColorMap, getFrequencyScale };
+export { SpectrogramMenuItems, type SpectrogramMenuItemsProps, SpectrogramProvider, type SpectrogramProviderProps, SpectrogramSettingsModal, type SpectrogramSettingsModalProps, type TrackMenuItem };

package/dist/index.d.ts

@@ -1,53 +1,6 @@
-import { SpectrogramConfig, SpectrogramData, ColorMapValue, RenderMode } from '@waveform-playlist/core';
+import { RenderMode, SpectrogramConfig, ColorMapValue } from '@waveform-playlist/core';
 import React, { ReactNode } from 'react';
 
-/**
- * Compute spectrogram data from an AudioBuffer.
- */
-
-/**
- * Compute spectrogram for a single channel of audio.
- *
- * @param audioBuffer - Source audio buffer
- * @param config - Spectrogram configuration
- * @param offsetSamples - Start offset into the audio buffer
- * @param durationSamples - Number of samples to process
- * @param channel - Channel index (0 = left, 1 = right). Default: 0
- */
-declare function computeSpectrogram(audioBuffer: AudioBuffer, config?: SpectrogramConfig, offsetSamples?: number, durationSamples?: number, channel?: number): SpectrogramData;
-/**
- * Compute a mono (mixed-down) spectrogram from all channels.
- */
-declare function computeSpectrogramMono(audioBuffer: AudioBuffer, config?: SpectrogramConfig, offsetSamples?: number, durationSamples?: number): SpectrogramData;
-
-/**
- * Color maps for spectrogram rendering.
- * Each map is a 256-entry RGB lookup table (768 bytes).
- *
- * Viridis, Magma, Inferno: Perceptually uniform colormaps from matplotlib.
- * By Stéfan van der Walt, Nathaniel Smith, and Eric Firing. Released under CC0.
- * Data from https://github.com/BIDS/colormap
- *
- * Roseus: Perceptually uniform colormap from https://github.com/dofuuz/roseus
- * By dofuuz, licensed under CC0 1.0 Universal.
- */
-
-type ColorLUT = Uint8Array;
-/**
- * Get a 256-entry RGB LUT for the given color map.
- */
-declare function getColorMap(value: ColorMapValue): ColorLUT;
-
-/**
- * Frequency scale mapping functions.
- * Each maps a frequency (Hz) to a normalized position [0, 1].
- */
-type FrequencyScaleName = 'linear' | 'logarithmic' | 'mel' | 'bark' | 'erb';
-/**
- * Returns a mapping function: (frequencyHz, minFrequency, maxFrequency) → [0, 1]
- */
-declare function getFrequencyScale(name: FrequencyScaleName): (f: number, minF: number, maxF: number) => number;
-
 interface TrackMenuItem {
     id: string;
     label?: string;
@@ -74,72 +27,6 @@ interface SpectrogramSettingsModalProps {
 }
 declare const SpectrogramSettingsModal: React.FC<SpectrogramSettingsModalProps>;
 
-/**
- * Error thrown when a spectrogram computation is aborted due to a generation change.
- * Use `instanceof SpectrogramAbortError` instead of string matching on error messages.
- */
-declare class SpectrogramAbortError extends Error {
-    constructor();
-}
-interface SpectrogramWorkerFFTParams {
-    clipId: string;
-    channelDataArrays: Float32Array[];
-    config: SpectrogramConfig;
-    sampleRate: number;
-    offsetSamples: number;
-    durationSamples: number;
-    mono: boolean;
-    sampleRange?: {
-        start: number;
-        end: number;
-    };
-    /** If set, compute only this channel index (used by worker pool). */
-    channelFilter?: number;
-}
-interface SpectrogramWorkerRenderChunksParams {
-    cacheKey: string;
-    canvasIds: string[];
-    canvasWidths: number[];
-    globalPixelOffsets: number[];
-    canvasHeight: number;
-    devicePixelRatio: number;
-    samplesPerPixel: number;
-    colorLUT: Uint8Array;
-    frequencyScale: string;
-    minFrequency: number;
-    maxFrequency: number;
-    gainDb: number;
-    rangeDb: number;
-    channelIndex: number;
-}
-interface SpectrogramWorkerApi {
-    computeFFT(params: SpectrogramWorkerFFTParams, generation?: number): Promise<{
-        cacheKey: string;
-    }>;
-    renderChunks(params: SpectrogramWorkerRenderChunksParams, generation?: number): Promise<void>;
-    abortGeneration(generation: number): void;
-    registerCanvas(canvasId: string, canvas: OffscreenCanvas): void;
-    unregisterCanvas(canvasId: string): void;
-    registerAudioData(clipId: string, channelDataArrays: Float32Array[], sampleRate: number): void;
-    unregisterAudioData(clipId: string): void;
-    terminate(): void;
-}
-/**
- * Wraps a Web Worker running `spectrogram.worker.ts` with a promise-based API.
- *
- * The caller is responsible for creating the Worker, e.g.:
- * ```ts
- * const worker = new Worker(
- *   new URL('@waveform-playlist/spectrogram/worker/spectrogram.worker', import.meta.url),
- *   { type: 'module' }
- * );
- * const api = createSpectrogramWorker(worker);
- * ```
- */
-declare function createSpectrogramWorker(worker: Worker): SpectrogramWorkerApi;
-
-declare function createSpectrogramWorkerPool(createWorker: () => Worker, poolSize?: number): SpectrogramWorkerApi;
-
 interface SpectrogramProviderProps {
     config?: SpectrogramConfig;
     colorMap?: ColorMapValue;
@@ -149,4 +36,4 @@ interface SpectrogramProviderProps {
 }
 declare const SpectrogramProvider: React.FC<SpectrogramProviderProps>;
 
-export { type FrequencyScaleName, SpectrogramAbortError, SpectrogramMenuItems, type SpectrogramMenuItemsProps, SpectrogramProvider, type SpectrogramProviderProps, SpectrogramSettingsModal, type SpectrogramSettingsModalProps, type SpectrogramWorkerApi, type TrackMenuItem, computeSpectrogram, computeSpectrogramMono, createSpectrogramWorker, createSpectrogramWorkerPool, getColorMap, getFrequencyScale };
+export { SpectrogramMenuItems, type SpectrogramMenuItemsProps, SpectrogramProvider, type SpectrogramProviderProps, SpectrogramSettingsModal, type SpectrogramSettingsModalProps, type TrackMenuItem };