@effetune/dsp 0.4.0 → 0.6.0

package/dist/semantics.js

@@ -1,7 +1,13 @@
 import { DSP_PARAM_PACKERS } from './internal/dsp-params.generated.js';
 import { getEffectDefinition, getEffectImplementation } from './catalog.js';
 import { Effect, validateChannel, validateParameterValue } from './effect.js';
-import { AssetError, EffeTuneError, EffectError, ValidationError } from './errors.js';
+import {
+  AssetError,
+  EffeTuneError,
+  EffectError,
+  ValidationError,
+  withValidationDetail
+} from './errors.js';
 
 const DOCUMENT_KEYS = new Set(['version', 'chain']);
 const EFFECT_KEYS = new Set(['id', 'type', 'enabled', 'channel', 'parameters', 'assets']);
@@ -9,6 +15,7 @@ const STREAM_RECONFIGURATION_PARAMETERS = new Map([
   ['FIRCrossover', new Set(['bandCount', 'latencyMode', 'filterDelaySamples'])],
   ['FiveBandFIRPEQ', new Set(['latencyMode', 'filterDelaySamples'])],
   ['GroupDelayEQ', new Set(['latencyMode', 'filterDelaySamples'])],
+  ['GroupDelayPEQ', new Set(['latencyMode', 'filterDelaySamples'])],
   ['IRReverb', new Set(['channelMode', 'latency', 'convolutionRate'])],
   ['RoomEQ', new Set(['latencyMode', 'filterDelaySamples'])]
 ]);
@@ -51,34 +58,47 @@ function cloneEffect(effect) {
   };
 }
 
-function fromPlainEffect(value, index) {
-  if (!isRecord(value)) throw new ValidationError(`Chain entry ${index} must be an object.`);
+function fromPlainEffect(value, index, label = `Chain entry ${index}`) {
+  if (!isRecord(value)) throw new ValidationError(`${label} must be an object.`);
   for (const key of Object.keys(value)) {
     if (!EFFECT_KEYS.has(key)) {
-      throw new ValidationError(`Chain entry ${index} has an unsupported field: ${key}`);
+      throw new ValidationError(`${label} has an unsupported field: ${key}`);
     }
   }
   if (typeof value.type !== 'string') {
-    throw new ValidationError(`Chain entry ${index} requires an effect type.`);
+    throw new ValidationError(`${label} requires an effect type.`);
   }
   if (!isRecord(value.parameters)) {
-    throw new ValidationError(`Chain entry ${index} requires a parameters object.`);
+    throw new ValidationError(`${label} requires a parameters object.`);
+  }
+  let definition;
+  try {
+    definition = getEffectDefinition(value.type);
+  } catch (error) {
+    throw withValidationDetail(error, { kind: 'type' });
   }
-  const definition = getEffectDefinition(value.type);
   const id = value.id;
   if (id !== undefined &&
       (typeof id !== 'string' || id.length < 1 || id.length > 128)) {
-    throw new ValidationError(`Chain entry ${index} has an invalid effect id.`);
+    throw new ValidationError(`${label} has an invalid effect id.`);
   }
   const enabled = value.enabled ?? true;
   if (typeof enabled !== 'boolean') {
-    throw new ValidationError(`Chain entry ${index} enabled must be boolean.`);
+    throw new ValidationError(`${label} enabled must be boolean.`);
+  }
+  let channel;
+  try {
+    channel = validateChannel(value.channel ?? 'all');
+  } catch (error) {
+    throw withValidationDetail(error, { kind: 'channel' });
   }
-  const channel = validateChannel(value.channel ?? 'all');
   const parameterByName = new Map(definition.parameters.map(parameter => [parameter.name, parameter]));
   for (const key of Object.keys(value.parameters)) {
     if (!parameterByName.has(key)) {
-      throw new ValidationError(`Unknown parameter ${value.type}.${key}.`);
+      throw withValidationDetail(
+        new ValidationError(`Unknown parameter ${value.type}.${key}.`),
+        { kind: 'parameter', parameter: key }
+      );
     }
   }
   const parameters = {};
@@ -86,26 +106,34 @@ function fromPlainEffect(value, index) {
     const supplied = Object.hasOwn(value.parameters, parameter.name)
       ? value.parameters[parameter.name]
       : parameter.default;
-    parameters[parameter.name] = validateParameterValue(value.type, parameter, supplied);
+    try {
+      parameters[parameter.name] = validateParameterValue(value.type, parameter, supplied);
+    } catch (error) {
+      throw withValidationDetail(error, { kind: 'parameter', parameter: parameter.name });
+    }
   }
   const declaredAssets = definition.assets ?? [];
   let assets;
-  if (declaredAssets.length === 0) {
-    if (value.assets !== undefined) throw new AssetError(`${value.type} does not accept external assets.`);
-  } else {
-    if (!isRecord(value.assets)) throw new AssetError(`${value.type} requires an assets object.`);
-    const allowed = new Set(declaredAssets.map(asset => asset.name));
-    for (const name of Object.keys(value.assets)) {
-      if (!allowed.has(name)) throw new AssetError(`${value.type} has no asset named ${name}.`);
-    }
-    assets = {};
-    for (const asset of declaredAssets) {
-      const reference = value.assets[asset.name];
-      if (asset.required && (typeof reference !== 'string' || reference.length < 1 || reference.length > 128)) {
-        throw new AssetError(`${value.type}.${asset.name} requires a non-empty asset reference.`);
+  try {
+    if (declaredAssets.length === 0) {
+      if (value.assets !== undefined) throw new AssetError(`${value.type} does not accept external assets.`);
+    } else {
+      if (!isRecord(value.assets)) throw new AssetError(`${value.type} requires an assets object.`);
+      const allowed = new Set(declaredAssets.map(asset => asset.name));
+      for (const name of Object.keys(value.assets)) {
+        if (!allowed.has(name)) throw new AssetError(`${value.type} has no asset named ${name}.`);
+      }
+      assets = {};
+      for (const asset of declaredAssets) {
+        const reference = value.assets[asset.name];
+        if (asset.required && (typeof reference !== 'string' || reference.length < 1 || reference.length > 128)) {
+          throw new AssetError(`${value.type}.${asset.name} requires a non-empty asset reference.`);
+        }
+        if (reference !== undefined) assets[asset.name] = reference;
       }
-      if (reference !== undefined) assets[asset.name] = reference;
     }
+  } catch (error) {
+    throw withValidationDetail(error, { kind: 'assets' });
   }
   return { id, type: value.type, enabled, channel, parameters, ...(assets ? { assets } : {}) };
 }
@@ -134,7 +162,7 @@ function assignIds(effects) {
   });
 }
 
-export function normalizeChainDocument(input) {
+export function normalizeChainDocument(input, { entryLabel } = {}) {
   let entries;
   if (Array.isArray(input)) {
     entries = input;
@@ -149,7 +177,11 @@ export function normalizeChainDocument(input) {
     entries = input.chain;
   }
   const effects = entries.map((entry, index) =>
-    fromPlainEffect(entry instanceof Effect ? entry.toJSON() : entry, index)
+    fromPlainEffect(
+      entry instanceof Effect ? entry.toJSON() : entry,
+      index,
+      entryLabel ?? `Chain entry ${index}`
+    )
   );
   return {
     version: 1,
@@ -250,14 +282,41 @@ export function packEffect(effect) {
 export function setEffectParameter(effect, parameterName, value) {
   const definition = getEffectDefinition(effect.type);
   const parameter = definition.parameters.find(entry => entry.name === parameterName);
-  if (!parameter) throw new ValidationError(`Unknown parameter ${effect.type}.${parameterName}.`);
-  const validated = validateParameterValue(effect.type, parameter, value);
+  if (!parameter) {
+    throw withValidationDetail(
+      new ValidationError(`Unknown parameter ${effect.type}.${parameterName}.`),
+      { kind: 'parameter', parameter: parameterName }
+    );
+  }
+  let validated;
+  try {
+    validated = validateParameterValue(effect.type, parameter, value);
+  } catch (error) {
+    throw withValidationDetail(error, { kind: 'parameter', parameter: parameterName });
+  }
   return {
     ...cloneEffect(effect),
     parameters: { ...effect.parameters, [parameterName]: validated }
   };
 }
 
+export function canonicalizeEffectForProcessing(effect) {
+  const canonical = cloneEffect(effect);
+  const parameters = canonical.parameters;
+  if (effect.type === 'AutoFilter' &&
+      parameters.minimumFrequency > parameters.maximumFrequency) {
+    [parameters.minimumFrequency, parameters.maximumFrequency] =
+      [parameters.maximumFrequency, parameters.minimumFrequency];
+  } else if (effect.type === 'Chorus' && parameters.depth > parameters.delay) {
+    parameters.depth = parameters.delay;
+  } else if (effect.type === 'FrequencyShifter' &&
+      parameters.minimumShift > parameters.maximumShift) {
+    [parameters.minimumShift, parameters.maximumShift] =
+      [parameters.maximumShift, parameters.minimumShift];
+  }
+  return canonical;
+}
+
 export function validateStreamParameterUpdate(effect, parameterName) {
   if (STREAM_RECONFIGURATION_PARAMETERS.get(effect.type)?.has(parameterName)) {
     throw new ValidationError(

package/dist/worklet-processor.js

@@ -8,6 +8,7 @@ class EffeTuneDspProcessor extends AudioWorkletProcessor {
     this.session = null;
     this.ready = false;
     this.closed = false;
+    this.latencySamples = null;
     this.channels = 0;
     this.pendingCommands = [];
     this.sourceChannels = [];
@@ -66,7 +67,8 @@ class EffeTuneDspProcessor extends AudioWorkletProcessor {
         );
       }
       this.ready = true;
-      this.port.postMessage({ type: 'ready' });
+      this.latencySamples = this.session?.latencySamples ?? 0;
+      this.port.postMessage({ type: 'ready', latencySamples: this.latencySamples });
     } catch (error) {
       this.port.postMessage({
         type: 'initializationError',
@@ -95,6 +97,11 @@ class EffeTuneDspProcessor extends AudioWorkletProcessor {
           this.session?.setTelemetryEnabled(this.telemetryEnabled);
           continue;
         }
+        const latencySamples = this.session?.latencySamples ?? 0;
+        if (latencySamples !== this.latencySamples) {
+          this.latencySamples = latencySamples;
+          this.port.postMessage({ type: 'latency', latencySamples });
+        }
         this.port.postMessage({ type: 'commandResult', commandId: command.commandId, ok: true });
       } catch (error) {
         this.port.postMessage({

package/dist/worklet.d.ts

@@ -23,6 +23,7 @@ export declare class EffeTuneNode extends AudioWorkletNode {
       readonly (Effect | ChainEffectInput)[],
     options?: EffeTuneNodeOptions
   ): Promise<EffeTuneNode>;
+  readonly latencySamples: number;
   readonly droppedTelemetryFrames: number;
   subscribe(callback: TelemetryCallback): () => void;
   unsubscribe(callback: TelemetryCallback): boolean;

package/dist/worklet.js

@@ -184,6 +184,7 @@ export class EffeTuneNode extends AudioWorkletNodeBase {
     this._seed = seed;
     this._closed = false;
     this._runtimeError = null;
+    this._latencySamples = 0;
     this._nextCommandId = 1;
     this._pending = new Map();
     this._telemetryCallbacks = new Set();
@@ -237,9 +238,18 @@ export class EffeTuneNode extends AudioWorkletNodeBase {
       return;
     }
     if (message?.type === 'ready') {
+      this._latencySamples = Number.isInteger(message.latencySamples) && message.latencySamples >= 0
+        ? message.latencySamples
+        : 0;
       this._resolveReady();
       return;
     }
+    if (message?.type === 'latency') {
+      this._latencySamples = Number.isInteger(message.latencySamples) && message.latencySamples >= 0
+        ? message.latencySamples
+        : 0;
+      return;
+    }
     if (message?.type === 'initializationError') {
       this._rejectReady(errorFromMessage(
         message.errorType,
@@ -315,6 +325,11 @@ export class EffeTuneNode extends AudioWorkletNodeBase {
     return this._droppedTelemetryFrames;
   }
 
+  get latencySamples() {
+    this._assertOpen();
+    return this._latencySamples;
+  }
+
   subscribe(callback) {
     this._assertOpen();
     if (typeof callback !== 'function') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effetune/dsp",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "EffeTune's deterministic WebAssembly audio effects for JavaScript and AudioWorklet",
   "type": "module",
   "license": "MIT",
@@ -37,6 +37,7 @@
     },
     "./processor": "./dist/worklet-processor.js",
     "./schemas/chain-v1.json": "./dist/schemas/chain-v1.schema.json",
+    "./schemas/graph-v1.json": "./dist/schemas/graph-v1.schema.json",
     "./schemas/bundle-v1.json": "./dist/schemas/bundle-v1.schema.json",
     "./catalog": {
       "types": "./dist/catalog-entry.d.ts",