@effetune/dsp 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,512 @@
+export type {
+  LevelMeterOptions,
+  OscilloscopeOptions,
+  SpectrogramOptions,
+  SpectrumAnalyzerOptions,
+  StereoMeterOptions,
+  ChannelDividerOptions,
+  DCOffsetOptions,
+  FIRCrossoverOptions,
+  MatrixOptions,
+  MultiChannelPanelOptions,
+  MuteOptions,
+  PolarityInversionOptions,
+  StereoBalanceOptions,
+  VolumeOptions,
+  DelayOptions,
+  TimeAlignmentOptions,
+  AMRadioSimulatorOptions,
+  AutoLevelerOptions,
+  BandPassFilterOptions,
+  BitCrusherOptions,
+  BrickwallLimiterOptions,
+  CombFilterOptions,
+  CommonEffectOptions,
+  CompressorOptions,
+  CrossfeedFilterOptions,
+  DSD64IMDSimulatorOptions,
+  DattorroPlateReverbOptions,
+  DigitalErrorEmulatorOptions,
+  DopplerDistortionOptions,
+  DynamicSaturationOptions,
+  EarphoneCableSimOptions,
+  EffectChannel,
+  EffectClassByType,
+  EffectOptionsByType,
+  EffectType,
+  ExciterOptions,
+  ExpanderOptions,
+  FDNReverbOptions,
+  FMRadioSimulatorOptions,
+  FifteenBandGEQOptions,
+  FifteenBandPEQOptions,
+  FiveBandDynamicEQOptions,
+  FiveBandFIRPEQOptions,
+  FiveBandPEQOptions,
+  GateOptions,
+  GroupDelayEQOptions,
+  HardClippingOptions,
+  HarmonicDistortionOptions,
+  HiPassFilterOptions,
+  HornResonatorOptions,
+  HornResonatorPlusOptions,
+  HumGeneratorOptions,
+  IRReverbAssets,
+  IRReverbOptions,
+  LoPassFilterOptions,
+  LoudnessEqualizerOptions,
+  MSMatrixOptions,
+  ModalResonatorOptions,
+  MultibandBalanceOptions,
+  MultibandCompressorOptions,
+  MultibandExpanderOptions,
+  MultibandSaturationOptions,
+  MultibandTransientOptions,
+  NarrowRangeOptions,
+  NoiseBlenderOptions,
+  OscillatorOptions,
+  PitchShifterOptions,
+  PowerAmpSagOptions,
+  RSReverbOptions,
+  RoomEQOptions,
+  SaturationOptions,
+  SimpleJitterOptions,
+  StereoBlendOptions,
+  SubSynthOptions,
+  SWRadioSimulatorOptions,
+  TiltEQOptions,
+  ToneControlOptions,
+  TransientShaperOptions,
+  TremoloOptions,
+  VinylArtifactsOptions,
+  VinylSimulatorOptions,
+  WowFlutterOptions
+} from './generated-effects.js';
+export {
+  LevelMeter,
+  Oscilloscope,
+  Spectrogram,
+  SpectrumAnalyzer,
+  StereoMeter,
+  ChannelDivider,
+  DCOffset,
+  FIRCrossover,
+  Matrix,
+  MultiChannelPanel,
+  Mute,
+  PolarityInversion,
+  StereoBalance,
+  Volume,
+  Delay,
+  TimeAlignment,
+  AMRadioSimulator,
+  AutoLeveler,
+  BandPassFilter,
+  BitCrusher,
+  BrickwallLimiter,
+  CombFilter,
+  Compressor,
+  CrossfeedFilter,
+  DSD64IMDSimulator,
+  DattorroPlateReverb,
+  DigitalErrorEmulator,
+  DopplerDistortion,
+  DynamicSaturation,
+  EarphoneCableSim,
+  EFFECT_CLASSES,
+  EFFECT_METADATA,
+  EFFECT_TYPES,
+  Exciter,
+  Expander,
+  FDNReverb,
+  FMRadioSimulator,
+  FifteenBandGEQ,
+  FifteenBandPEQ,
+  FiveBandDynamicEQ,
+  FiveBandFIRPEQ,
+  FiveBandPEQ,
+  Gate,
+  GroupDelayEQ,
+  HardClipping,
+  HarmonicDistortion,
+  HiPassFilter,
+  HornResonator,
+  HornResonatorPlus,
+  HumGenerator,
+  IRReverb,
+  LoPassFilter,
+  LoudnessEqualizer,
+  MSMatrix,
+  ModalResonator,
+  MultibandBalance,
+  MultibandCompressor,
+  MultibandExpander,
+  MultibandSaturation,
+  MultibandTransient,
+  NarrowRange,
+  NoiseBlender,
+  Oscillator,
+  PitchShifter,
+  PowerAmpSag,
+  RSReverb,
+  RoomEQ,
+  Saturation,
+  SimpleJitter,
+  StereoBlend,
+  SubSynth,
+  SWRadioSimulator,
+  TiltEQ,
+  ToneControl,
+  TransientShaper,
+  Tremolo,
+  VinylArtifacts,
+  VinylSimulator,
+  WowFlutter,
+  createLevelMeter,
+  createOscilloscope,
+  createSpectrogram,
+  createSpectrumAnalyzer,
+  createStereoMeter,
+  createChannelDivider,
+  createDCOffset,
+  createFIRCrossover,
+  createMatrix,
+  createMultiChannelPanel,
+  createMute,
+  createPolarityInversion,
+  createStereoBalance,
+  createVolume,
+  createDelay,
+  createTimeAlignment,
+  createAMRadioSimulator,
+  createAutoLeveler,
+  createBandPassFilter,
+  createBitCrusher,
+  createBrickwallLimiter,
+  createCombFilter,
+  createCompressor,
+  createCrossfeedFilter,
+  createDSD64IMDSimulator,
+  createDattorroPlateReverb,
+  createDigitalErrorEmulator,
+  createDopplerDistortion,
+  createDynamicSaturation,
+  createEarphoneCableSim,
+  createEffect,
+  createExciter,
+  createExpander,
+  createFDNReverb,
+  createFMRadioSimulator,
+  createFifteenBandGEQ,
+  createFifteenBandPEQ,
+  createFiveBandDynamicEQ,
+  createFiveBandFIRPEQ,
+  createFiveBandPEQ,
+  createGate,
+  createGroupDelayEQ,
+  createHardClipping,
+  createHarmonicDistortion,
+  createHiPassFilter,
+  createHornResonator,
+  createHornResonatorPlus,
+  createHumGenerator,
+  createIRReverb,
+  createLoPassFilter,
+  createLoudnessEqualizer,
+  createMSMatrix,
+  createModalResonator,
+  createMultibandBalance,
+  createMultibandCompressor,
+  createMultibandExpander,
+  createMultibandSaturation,
+  createMultibandTransient,
+  createNarrowRange,
+  createNoiseBlender,
+  createOscillator,
+  createPitchShifter,
+  createPowerAmpSag,
+  createRSReverb,
+  createRoomEQ,
+  createSaturation,
+  createSimpleJitter,
+  createStereoBlend,
+  createSubSynth,
+  createSWRadioSimulator,
+  createTiltEQ,
+  createToneControl,
+  createTransientShaper,
+  createTremolo,
+  createVinylArtifacts,
+  createVinylSimulator,
+  createWowFlutter
+} from './generated-effects.js';
+export { Effect, EFFECT_CHANNELS } from './effect.js';
+export type { EffectDefinition } from './effect.js';
+
+import type { Effect } from './effect.js';
+import type { EffectChannel, EffectType } from './generated-effects.js';
+
+export declare class EffeTuneError extends Error {}
+export declare class ValidationError extends EffeTuneError {}
+export declare class EffectError extends EffeTuneError {}
+export declare class AssetError extends EffeTuneError {}
+export declare class EffeTuneRuntimeError extends EffeTuneError {}
+export declare class StateError extends EffeTuneError {}
+
+export interface ChainEffect {
+  readonly id: string;
+  readonly type: EffectType;
+  readonly enabled: boolean;
+  readonly channel: EffectChannel;
+  readonly parameters: Readonly<Record<string, unknown>>;
+  readonly assets?: Readonly<Record<string, string>>;
+}
+
+export interface ChainEffectInput {
+  readonly id?: string;
+  readonly type: EffectType;
+  readonly enabled?: boolean;
+  readonly channel?: EffectChannel;
+  readonly parameters: Readonly<Record<string, unknown>>;
+  readonly assets?: Readonly<Record<string, string>>;
+}
+
+export interface ChainDocument {
+  readonly version: 1;
+  readonly chain: readonly ChainEffect[];
+}
+
+export interface ChainDocumentInput {
+  readonly version: 1;
+  readonly chain: readonly ChainEffectInput[];
+}
+
+export interface MatrixPath {
+  readonly inputSlot: number;
+  readonly outputSlot: number;
+  readonly irChannel: number;
+}
+
+export interface ImpulseResponseFormat {
+  readonly formatTag: 1;
+  readonly magic: 'ETA1';
+  readonly headerBytes: 32;
+  readonly pathRecordBytes: 12;
+  readonly reservedBytes: 8;
+  readonly sampleType: 'float32';
+  readonly byteOrder: 'little-endian';
+  readonly layout: 'planar';
+  readonly channels: number;
+  readonly frames: number;
+  readonly sampleRate: number;
+  readonly topology: 'unspecified' | 'mono' | 'independent' | 'trueStereo' | 'matrix';
+  readonly pathCount: number;
+  readonly paths?: readonly MatrixPath[];
+}
+
+export interface Eta1EncodeOptions {
+  readonly channels: readonly Float32Array[];
+  readonly sampleRate: number;
+  readonly topology?: 'unspecified' | 'mono' | 'independent' | 'trueStereo' | 'matrix';
+  readonly paths?: readonly MatrixPath[];
+}
+
+export interface BundleAsset {
+  readonly id: string;
+  readonly kind: 'impulseResponse';
+  readonly reference: string;
+  readonly sha256: string;
+  readonly byteLength: number;
+  readonly format: ImpulseResponseFormat;
+}
+
+export interface BundleDocument {
+  readonly version: 1;
+  readonly chain: ChainDocumentInput;
+  readonly assets: readonly BundleAsset[];
+}
+
+export interface ResolvedAsset {
+  readonly bytes?: ArrayBuffer | ArrayBufferView;
+  readonly data?: ArrayBuffer | ArrayBufferView;
+  readonly format?: ImpulseResponseFormat;
+}
+
+export type AssetResolver = (
+  reference: string,
+  manifest?: BundleAsset
+) => ResolvedAsset | ArrayBuffer | ArrayBufferView | Response | null |
+  Promise<ResolvedAsset | ArrayBuffer | ArrayBufferView | Response | null>;
+
+export interface ArtifactOptions {
+  readonly variant?: 'auto' | 'baseline' | 'simd';
+  readonly wasmUrl?: string | URL;
+  readonly simdWasmUrl?: string | URL;
+  readonly metaUrl?: string | URL;
+  readonly fetch?: typeof globalThis.fetch;
+  readonly webAssembly?: typeof WebAssembly;
+  readonly cache?: boolean;
+}
+
+export interface CreateChainOptions extends ArtifactOptions {
+  readonly assetResolver?: AssetResolver | { resolve: AssetResolver };
+}
+
+export interface TelemetryFrameBase {
+  readonly kind: 'level' | 'oscilloscope' | 'spectrum' | 'spectrogram' | 'stereo';
+  readonly effectType: EffectType;
+  readonly effectId: string | null;
+  readonly effectIndex: number;
+  readonly sequence: number;
+  /** Frames lost since the previous decoded delivery. */
+  readonly dropped: number;
+}
+
+export interface LevelTelemetryChannel {
+  readonly peak: number;
+  readonly rms: number;
+  readonly clipped: boolean;
+}
+
+export interface LevelTelemetryFrame extends TelemetryFrameBase {
+  readonly kind: 'level';
+  readonly channels: readonly LevelTelemetryChannel[];
+}
+
+export interface OscilloscopeTelemetryFrame extends TelemetryFrameBase {
+  readonly kind: 'oscilloscope';
+  readonly sampleRate: number;
+  readonly captureSampleCount: number;
+  readonly triggerOffset: number;
+  readonly triggered: boolean;
+  readonly encoding: 'samples' | 'minMax';
+  readonly sampleIndices: Uint32Array;
+  readonly values: Float32Array;
+}
+
+export interface SpectrumTelemetryFrame extends TelemetryFrameBase {
+  readonly kind: 'spectrum';
+  readonly sampleRate: number;
+  readonly points: number;
+  readonly binsTruncated: boolean;
+  readonly currentDb: Float32Array;
+  readonly peakDb: Float32Array;
+}
+
+export interface SpectrogramTelemetryFrame extends TelemetryFrameBase {
+  readonly kind: 'spectrogram';
+  readonly sampleRate: number;
+  readonly timeSeconds: number;
+  readonly points: number;
+  readonly intensities: Uint8Array;
+}
+
+export interface StereoTelemetryFrame extends TelemetryFrameBase {
+  readonly kind: 'stereo';
+  readonly sampleRate: number;
+  readonly discontinuity: boolean;
+  /** Interleaved side (R-L), mid (L+R) coordinate pairs. */
+  readonly samples: Float32Array;
+  readonly envelope: Float32Array;
+  readonly correlation: number;
+  readonly balance: number;
+  readonly peakLeft: number;
+  readonly peakRight: number;
+}
+
+export type TelemetryFrame =
+  | LevelTelemetryFrame
+  | OscilloscopeTelemetryFrame
+  | SpectrumTelemetryFrame
+  | SpectrogramTelemetryFrame
+  | StereoTelemetryFrame;
+
+export type TelemetryCallback = (frame: TelemetryFrame) => void;
+
+export interface ProcessOptions {
+  readonly sampleRate: number;
+  readonly seed?: number;
+  readonly blockSize?: number;
+  readonly onTelemetry?: TelemetryCallback;
+}
+
+export interface StreamOptions {
+  readonly sampleRate: number;
+  readonly channels?: number;
+  readonly seed?: number;
+  readonly blockSize?: number;
+  readonly onTelemetry?: TelemetryCallback;
+}
+
+export interface ParameterEvent {
+  readonly frame: number;
+  readonly effectId: string;
+  readonly parameters: Readonly<Record<string, unknown>>;
+}
+
+export interface StreamProcessOptions {
+  readonly events?: readonly ParameterEvent[];
+}
+
+export interface PrewarmOptions {
+  readonly sampleRate: number;
+  readonly channels?: number;
+  readonly seed?: number;
+  readonly blockSize?: number;
+}
+
+/** Options for `Chain.latencySamples()`, which reports latency without a stream. */
+export interface LatencyOptions {
+  readonly sampleRate: number;
+  /** Channel count the chain will process; defaults to 2. */
+  readonly channels?: number;
+  readonly blockSize?: number;
+}
+
+export declare class Chain {
+  private constructor();
+  readonly preset: ChainDocument;
+  readonly effects: readonly ChainEffect[];
+  setParam(effectId: string, parameterName: string, value: unknown): this;
+  reset(): this;
+  prewarm(options: PrewarmOptions): Promise<this>;
+  latencySamples(options: LatencyOptions): Promise<number>;
+  stream(options: StreamOptions): Promise<ChainStream>;
+  process(audio: readonly Float32Array[], options: ProcessOptions): Promise<Float32Array[]>;
+  close(): void;
+}
+
+export interface ChainStream {
+  readonly preset: ChainDocument;
+  readonly effects: readonly ChainEffect[];
+  readonly latencySamples: number;
+  readonly droppedTelemetryFrames: number;
+  subscribe(callback: TelemetryCallback): () => void;
+  unsubscribe(callback: TelemetryCallback): boolean;
+  setParam(effectId: string, parameterName: string, value: unknown): this;
+  reset(): this;
+  process(
+    audio: readonly Float32Array[],
+    options?: StreamProcessOptions
+  ): Promise<Float32Array[]>;
+  close(): void;
+}
+
+export declare function createChain(
+  input: string | ChainDocumentInput | BundleDocument |
+    readonly (Effect | ChainEffectInput)[],
+  options?: CreateChainOptions
+): Promise<Chain>;
+
+export declare function parsePreset(
+  input: string | ChainDocumentInput | readonly (Effect | ChainEffectInput)[]
+): ChainDocument;
+export declare function importLegacyPreset(input: string | object): ChainDocument;
+export declare function encodeEta1(options: Eta1EncodeOptions): ArrayBuffer;
+export declare function getEffectCatalog(): Readonly<{
+  version: 1;
+  channels: readonly EffectChannel[];
+  effects: readonly Readonly<Record<string, unknown>>[];
+}>;
+export declare const EFFECT_CATALOG: ReturnType<typeof getEffectCatalog>;
+export declare function isBundleDocument(input: unknown): boolean;

package/dist/index.js

@@ -0,0 +1,175 @@
+export {
+  AssetError,
+  EffectError,
+  EffeTuneError,
+  EffeTuneRuntimeError,
+  StateError,
+  ValidationError
+} from './errors.js';
+export { Effect, EFFECT_CHANNELS } from './effect.js';
+export {
+  LevelMeter,
+  Oscilloscope,
+  Spectrogram,
+  SpectrumAnalyzer,
+  StereoMeter,
+  ChannelDivider,
+  DCOffset,
+  FIRCrossover,
+  Matrix,
+  MultiChannelPanel,
+  Mute,
+  PolarityInversion,
+  StereoBalance,
+  Volume,
+  Delay,
+  TimeAlignment,
+  AMRadioSimulator,
+  AutoLeveler,
+  BitCrusher,
+  BrickwallLimiter,
+  BandPassFilter,
+  CombFilter,
+  Compressor,
+  CrossfeedFilter,
+  DSD64IMDSimulator,
+  DattorroPlateReverb,
+  DigitalErrorEmulator,
+  DopplerDistortion,
+  DynamicSaturation,
+  EarphoneCableSim,
+  Exciter,
+  EFFECT_CLASSES,
+  EFFECT_METADATA,
+  EFFECT_TYPES,
+  Expander,
+  FDNReverb,
+  FMRadioSimulator,
+  FifteenBandGEQ,
+  FifteenBandPEQ,
+  FiveBandDynamicEQ,
+  FiveBandFIRPEQ,
+  FiveBandPEQ,
+  Gate,
+  GroupDelayEQ,
+  HardClipping,
+  HarmonicDistortion,
+  HiPassFilter,
+  HornResonator,
+  HornResonatorPlus,
+  HumGenerator,
+  IRReverb,
+  LoPassFilter,
+  LoudnessEqualizer,
+  MSMatrix,
+  ModalResonator,
+  MultibandBalance,
+  MultibandCompressor,
+  MultibandExpander,
+  MultibandSaturation,
+  MultibandTransient,
+  NarrowRange,
+  NoiseBlender,
+  Oscillator,
+  PitchShifter,
+  PowerAmpSag,
+  RSReverb,
+  RoomEQ,
+  Saturation,
+  SimpleJitter,
+  StereoBlend,
+  SubSynth,
+  SWRadioSimulator,
+  TiltEQ,
+  ToneControl,
+  TransientShaper,
+  Tremolo,
+  VinylArtifacts,
+  VinylSimulator,
+  WowFlutter,
+  createLevelMeter,
+  createOscilloscope,
+  createSpectrogram,
+  createSpectrumAnalyzer,
+  createStereoMeter,
+  createChannelDivider,
+  createDCOffset,
+  createFIRCrossover,
+  createMatrix,
+  createMultiChannelPanel,
+  createMute,
+  createPolarityInversion,
+  createStereoBalance,
+  createVolume,
+  createDelay,
+  createTimeAlignment,
+  createAMRadioSimulator,
+  createAutoLeveler,
+  createBandPassFilter,
+  createBitCrusher,
+  createBrickwallLimiter,
+  createCombFilter,
+  createCompressor,
+  createCrossfeedFilter,
+  createDSD64IMDSimulator,
+  createDattorroPlateReverb,
+  createDigitalErrorEmulator,
+  createDopplerDistortion,
+  createDynamicSaturation,
+  createEarphoneCableSim,
+  createEffect,
+  createExciter,
+  createExpander,
+  createFDNReverb,
+  createFMRadioSimulator,
+  createFifteenBandGEQ,
+  createFifteenBandPEQ,
+  createFiveBandDynamicEQ,
+  createFiveBandFIRPEQ,
+  createFiveBandPEQ,
+  createGate,
+  createGroupDelayEQ,
+  createHardClipping,
+  createHarmonicDistortion,
+  createHiPassFilter,
+  createHornResonator,
+  createHornResonatorPlus,
+  createHumGenerator,
+  createIRReverb,
+  createLoPassFilter,
+  createLoudnessEqualizer,
+  createMSMatrix,
+  createModalResonator,
+  createMultibandBalance,
+  createMultibandCompressor,
+  createMultibandExpander,
+  createMultibandSaturation,
+  createMultibandTransient,
+  createNarrowRange,
+  createNoiseBlender,
+  createOscillator,
+  createPitchShifter,
+  createPowerAmpSag,
+  createRSReverb,
+  createRoomEQ,
+  createSaturation,
+  createSimpleJitter,
+  createStereoBlend,
+  createSubSynth,
+  createSWRadioSimulator,
+  createTiltEQ,
+  createToneControl,
+  createTransientShaper,
+  createTremolo,
+  createVinylArtifacts,
+  createVinylSimulator,
+  createWowFlutter
+} from './generated-effects.js';
+export { getEffectCatalog } from './catalog.js';
+export { encodeEta1 } from './assets.js';
+export { Chain, createChain, isBundleDocument } from './runtime.js';
+export { importLegacyPreset, parsePreset } from './preset.js';
+
+import { getEffectCatalog } from './catalog.js';
+
+export const EFFECT_CATALOG = getEffectCatalog();