strudel/packages/superdough/superdough.mjs

/*
superdough.mjs - <short description TODO>
Copyright (C) 2022 Strudel contributors - see <https://codeberg.org/uzu/strudel/src/branch/main/packages/superdough/superdough.mjs>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

import './feedbackdelay.mjs';
import './reverb.mjs';
import './vowel.mjs';
import { nanFallback, _mod, cycleToSeconds, pickAndRename } from './util.mjs';
import workletsUrl from './worklets.mjs?audioworklet';
import {
  createFilter,
  effectSend,
  gainNode,
  getADSRValues,
  getCompressor,
  getDistortion,
  getEnvelope,
  getLfo,
  getParamADSR,
  getWorklet,
  webAudioTimeout,
} from './helpers.mjs';
import { map } from 'nanostores';
import { errorLogger, logger } from './logger.mjs';
import { loadBuffer } from './sampler.mjs';
import { getAudioContext } from './audioContext.mjs';
import { SuperdoughAudioController } from './superdoughoutput.mjs';

export const DEFAULT_MAX_POLYPHONY = 128;
const DEFAULT_AUDIO_DEVICE_NAME = 'System Standard';

let maxPolyphony = DEFAULT_MAX_POLYPHONY;

export function setMaxPolyphony(polyphony) {
  maxPolyphony = parseInt(polyphony) ?? DEFAULT_MAX_POLYPHONY;
}

let multiChannelOrbits = false;
export function setMultiChannelOrbits(bool) {
  multiChannelOrbits = bool == true;
}

export const soundMap = map();

export function registerSound(key, onTrigger, data = {}) {
  key = key.toLowerCase().replace(/\s+/g, '_');
  soundMap.setKey(key, { onTrigger, data });
}

let gainCurveFunc = (val) => val;

export function applyGainCurve(val) {
  return gainCurveFunc(val);
}

export function setGainCurve(newGainCurveFunc) {
  gainCurveFunc = newGainCurveFunc;
}

function aliasBankMap(aliasMap) {
  // Make all bank keys lower case for case insensitivity
  for (const key in aliasMap) {
    aliasMap[key.toLowerCase()] = aliasMap[key];
  }

  // Look through every sound...
  const soundDictionary = soundMap.get();
  for (const key in soundDictionary) {
    // Check if the sound is part of a bank...
    const [bank, suffix] = key.split('_');
    if (!suffix) continue;

    // Check if the bank is aliased...
    const aliasValue = aliasMap[bank];
    if (aliasValue) {
      if (typeof aliasValue === 'string') {
        // Alias a single alias
        soundDictionary[`${aliasValue}_${suffix}`.toLowerCase()] = soundDictionary[key];
      } else if (Array.isArray(aliasValue)) {
        // Alias multiple aliases
        for (const alias of aliasValue) {
          soundDictionary[`${alias}_${suffix}`.toLowerCase()] = soundDictionary[key];
        }
      }
    }
  }

  // Update the sound map!
  // We need to destructure here to trigger the update
  soundMap.set({ ...soundDictionary });
}

async function aliasBankPath(path) {
  const response = await fetch(path);
  const aliasMap = await response.json();
  aliasBankMap(aliasMap);
}

/**
 * Register an alias for a bank of sounds.
 * Optionally accepts a single argument map of bank aliases.
 * Optionally accepts a single argument string of a path to a JSON file containing bank aliases.
 * @param {string} bank - The bank to alias
 * @param {string} alias - The alias to use for the bank
 */
export async function aliasBank(...args) {
  switch (args.length) {
    case 1:
      if (typeof args[0] === 'string') {
        return aliasBankPath(args[0]);
      } else {
        return aliasBankMap(args[0]);
      }
    case 2:
      return aliasBankMap({ [args[0]]: args[1] });
    default:
      throw new Error('aliasMap expects 1 or 2 arguments, received ' + args.length);
  }
}

/**
 * Register an alias for a sound.
 * @param {string} original - The original sound name
 * @param {string} alias - The alias to use for the sound
 */
export function soundAlias(original, alias) {
  if (getSound(original) == null) {
    logger('soundAlias: original sound not found');
    return;
  }
  soundMap.setKey(alias, getSound(original));
}

export function getSound(s) {
  if (typeof s !== 'string') {
    console.warn(`getSound: expected string got "${s}". fall back to triangle`);
    return soundMap.get().triangle; // is this good?
  }
  return soundMap.get()[s.toLowerCase()];
}

export const getAudioDevices = async () => {
  await navigator.mediaDevices.getUserMedia({ audio: true });
  let mediaDevices = await navigator.mediaDevices.enumerateDevices();
  mediaDevices = mediaDevices.filter((device) => device.kind === 'audiooutput' && device.deviceId !== 'default');
  const devicesMap = new Map();
  devicesMap.set(DEFAULT_AUDIO_DEVICE_NAME, '');
  mediaDevices.forEach((device) => {
    devicesMap.set(device.label, device.deviceId);
  });
  return devicesMap;
};

let defaultDefaultValues = {
  s: 'triangle',
  gain: 0.8,
  postgain: 1,
  density: '.03',
  channels: [1, 2],
  phaserdepth: 0.75,
  shapevol: 1,
  distortvol: 1,
  distorttype: 0,
  delay: 0,
  byteBeatExpression: '0',
  delayfeedback: 0.5,
  delaysync: 3 / 16,
  orbit: 1,
  i: 1,
  velocity: 1,
  fft: 8,
};

const defaultDefaultDefaultValues = Object.freeze({ ...defaultDefaultValues });

export function setDefault(control, value) {
  // const main = getControlName(control); // we cant do this because superdough is independent of strudel/core
  defaultDefaultValues[control] = value;
}

export function resetDefaults() {
  defaultDefaultValues = { ...defaultDefaultDefaultValues };
}

let defaultControls = new Map(Object.entries(defaultDefaultValues));

export function setDefaultValue(key, value) {
  defaultControls.set(key, value);
}
export function getDefaultValue(key) {
  return defaultControls.get(key);
}
export function setDefaultValues(defaultsobj) {
  Object.keys(defaultsobj).forEach((key) => {
    setDefaultValue(key, defaultsobj[key]);
  });
}
export function resetDefaultValues() {
  defaultControls = new Map(Object.entries(defaultDefaultValues));
}
export function setVersionDefaults(version) {
  resetDefaultValues();
  if (version === '1.0') {
    setDefaultValue('fanchor', 0.5);
  }
}

export const resetLoadedSounds = () => soundMap.set({});

let externalWorklets = [];
export function registerWorklet(url) {
  externalWorklets.push(url);
}

let workletsLoading;
function loadWorklets() {
  if (!workletsLoading) {
    const audioCtx = getAudioContext();
    const allWorkletURLs = externalWorklets.concat([workletsUrl]);
    workletsLoading = Promise.all(allWorkletURLs.map((workletURL) => audioCtx.audioWorklet.addModule(workletURL)));
  }

  return workletsLoading;
}

// this function should be called on first user interaction (to avoid console warning)
export async function initAudio(options = {}) {
  const {
    disableWorklets = false,
    maxPolyphony,
    audioDeviceName = DEFAULT_AUDIO_DEVICE_NAME,
    multiChannelOrbits = false,
  } = options;

  setMaxPolyphony(maxPolyphony);
  setMultiChannelOrbits(multiChannelOrbits);
  if (typeof window === 'undefined') {
    return;
  }

  const audioCtx = getAudioContext();

  if (audioDeviceName != null && audioDeviceName != DEFAULT_AUDIO_DEVICE_NAME) {
    try {
      const devices = await getAudioDevices();
      const id = devices.get(audioDeviceName);
      const isValidID = (id ?? '').length > 0;
      if (audioCtx.sinkId !== id && isValidID) {
        await audioCtx.setSinkId(id);
      }
      logger(
        `[superdough] Audio Device set to ${audioDeviceName}, it might take a few seconds before audio plays on all output channels`,
      );
    } catch {
      logger('[superdough] failed to set audio interface', 'warning');
    }
  }

  await audioCtx.resume();
  if (disableWorklets) {
    logger('[superdough]: AudioWorklets disabled with disableWorklets');
    return;
  }
  try {
    await loadWorklets();
    logger('[superdough] AudioWorklets loaded');
  } catch (err) {
    console.warn('could not load AudioWorklet effects', err);
  }
  logger('[superdough] ready');
}
let audioReady;
export async function initAudioOnFirstClick(options) {
  if (!audioReady) {
    audioReady = new Promise((resolve) => {
      document.addEventListener('click', async function listener() {
        document.removeEventListener('click', listener);
        await initAudio(options);
        resolve();
      });
    });
  }
  return audioReady;
}

let controller;
function getSuperdoughAudioController() {
  if (controller == null) {
    controller = new SuperdoughAudioController(getAudioContext());
  }
  return controller;
}

export function connectToDestination(input, channels) {
  const controller = getSuperdoughAudioController();
  controller.output.connectToDestination(input, channels);
}

function getPhaser(begin, end, frequency = 1, depth = 0.5, centerFrequency = 1000, sweep = 2000) {
  const ac = getAudioContext();
  const lfoGain = getLfo(ac, { frequency, depth: sweep * 2, begin, end });

  //filters
  const numStages = 2; //num of filters in series
  let fOffset = 0;
  const filterChain = [];
  for (let i = 0; i < numStages; i++) {
    const filter = ac.createBiquadFilter();
    filter.type = 'notch';
    filter.gain.value = 1;
    filter.frequency.value = centerFrequency + fOffset;
    filter.Q.value = 2 - Math.min(Math.max(depth * 2, 0), 1.9);

    lfoGain.connect(filter.detune);
    fOffset += 282;
    if (i > 0) {
      filterChain[i - 1].connect(filter);
    }
    filterChain.push(filter);
  }
  return filterChain[filterChain.length - 1];
}

function getFilterType(ftype) {
  ftype = ftype ?? 0;
  const filterTypes = ['12db', 'ladder', '24db'];
  return typeof ftype === 'number' ? filterTypes[Math.floor(_mod(ftype, filterTypes.length))] : ftype;
}

export let analysers = {},
  analysersData = {};

export function getAnalyserById(id, fftSize = 1024, smoothingTimeConstant = 0.5) {
  if (!analysers[id]) {
    // make sure this doesn't happen too often as it piles up garbage
    const analyserNode = getAudioContext().createAnalyser();
    analyserNode.fftSize = fftSize;
    analyserNode.smoothingTimeConstant = smoothingTimeConstant;
    // getDestination().connect(analyserNode);
    analysers[id] = analyserNode;
    analysersData[id] = new Float32Array(analysers[id].frequencyBinCount);
  }
  if (analysers[id].fftSize !== fftSize) {
    analysers[id].fftSize = fftSize;
    analysersData[id] = new Float32Array(analysers[id].frequencyBinCount);
  }
  return analysers[id];
}

export function getAnalyzerData(type = 'time', id = 1) {
  const getter = {
    time: () => analysers[id]?.getFloatTimeDomainData(analysersData[id]),
    frequency: () => analysers[id]?.getFloatFrequencyData(analysersData[id]),
  }[type];
  if (!getter) {
    throw new Error(`getAnalyzerData: ${type} not supported. use one of ${Object.keys(getter).join(', ')}`);
  }
  getter();
  return analysersData[id];
}

export function resetGlobalEffects() {
  controller?.reset();
  analysers = {};
  analysersData = {};
  idToNodes = {};
}

function _getNodeParam(node, name) {
  // Worklet case
  if (node?.parameters) {
    const p = node.parameters.get(name);
    if (p instanceof AudioParam) {
      return p;
    }
  }
  // Built-in node case
  const p = node?.[name];
  if (p instanceof AudioParam) {
    return p;
  }
  return undefined;
}

function _getNodeParams(node) {
  const params = new Set();
  // Worklet case
  if (node?.parameters) {
    node.parameters.forEach((_v, k) => params.add(k));
  }
  // Guesses based on common parameters
  ['gain', 'frequency', 'detune', 'Q', 'pan', 'playbackRate', 'delayTime'].forEach((k) => {
    if (node?.[k] instanceof AudioParam) params.add(k);
  });
  return Array.from(params);
}

const targetToParamGuess = {
  source: 'detune',
  lpf: 'frequency',
  bpf: 'frequency',
  hpf: 'frequency',
  distort: 'distort',
  gain: 'gain',
  vowel: 'frequency',
  coarse: 'coarse',
  crush: 'crush',
  shape: 'shape',
  compressor: 'threshold',
  pan: 'pan',
  phaser: 'rate',
  post: 'gain',
  delay: 'delayTime',
  room: 'size',
  djf: 'value',
  lfo: 'frequency',
  env: 'depth',
  send: 'depth',
};

function _getTargetParams(nodes, target) {
  let param;
  if (target.includes('.')) {
    const split = target.split('.');
    target = split[0];
    param = split[1];
  } else {
    const targetWithoutIndex = target.replace(/(\d+)$/, '');
    param = targetToParamGuess[targetWithoutIndex];
  }
  const targetNodes = nodes[target];
  if (!targetNodes) {
    const keys = Object.keys(nodes);
    errorLogger(
      `Could not connect to target '${target}' — it does not exist. Available targets: ${keys.join(', ')}`,
      'superdough',
    );
    return [];
  }
  const audioParams = [];
  targetNodes.forEach((targetNode) => {
    const targetParam = _getNodeParam(targetNode, param);
    if (!targetParam) {
      const available = _getNodeParams(targetNode);
      errorLogger(
        `Could not connect to parameter '${param}' on '${target}'. Available parameters: ${available.join(', ')}`,
        'superdough',
      );
      return;
    }
    audioParams.push(targetParam);
  });
  return audioParams;
}

function connectLFO(idx, params, nodeTracker) {
  const { rate = 1, sync, cps, target, ...filteredParams } = params;
  filteredParams['frequency'] = sync !== undefined ? sync / cps : rate;
  const ac = getAudioContext();
  const lfoNode = getLfo(ac, filteredParams);
  nodeTracker[`lfo${idx}`] = [lfoNode];
  _getTargetParams(nodeTracker, target).forEach((t) => lfoNode.connect(t));
}

function connectEnvelope(idx, params, nodeTracker) {
  const { target, ...filteredParams } = params;
  const ac = getAudioContext();
  const envNode = getEnvelope(ac, filteredParams);
  nodeTracker[`env${idx}`] = [envNode];
  _getTargetParams(nodeTracker, target).forEach((t) => envNode.connect(t));
}

function connectSendModulator(params, signal, nodeTracker, chainID) {
  const ac = getAudioContext();
  const dc = new ConstantSourceNode(ac, { offset: params.dc ?? 0 });
  dc.start(params.begin);
  const offset = new ConstantSourceNode(ac, { offset: params.offset ?? 0 });
  offset.start(params.begin);
  const raw = dc.connect(gainNode(1));
  const modulator = signal
    .connect(raw)
    .connect(gainNode((params.depth ?? 1) / 0.3))
    .connect(gainNode(1));
  offset.connect(modulator);
  webAudioTimeout(
    ac,
    () => {
      _getTargetParams(nodeTracker, params.target).forEach((t) => modulator.connect(t));
    },
    0,
    params.begin,
  );
  webAudioTimeout(
    ac,
    () => {
      modulator.disconnect();
      delete pendingConnections[params.id][chainID];
    },
    0,
    params.end + 0.05,
  );
  return modulator;
}

let activeSoundSources = new Map();
//music programs/audio gear usually increments inputs/outputs from 1, we need to subtract 1 from the input because the webaudio API channels start at 0

function mapChannelNumbers(channels) {
  return (Array.isArray(channels) ? channels : [channels]).map((ch) => ch - 1);
}

let idToNodes = {};
let pendingConnections = {};
export const superdough = async (value, t, hapDuration, cps = 0.5, cycle = 0.5) => {
  const nodes = {};
  // new: t is always expected to be the absolute target onset time
  const ac = getAudioContext();
  const audioController = getSuperdoughAudioController();

  let { stretch } = value;
  if (stretch != null) {
    //account for phase vocoder latency
    const latency = 0.04;
    t = t - latency;
  }
  if (typeof value !== 'object') {
    throw new Error(
      `expected hap.value to be an object, but got "${value}". Hint: append .note() or .s() to the end`,
      'error',
    );
  }

  // duration is passed as value too..
  value.duration = hapDuration;
  // calculate absolute time

  if (t < ac.currentTime) {
    console.warn(
      `[superdough]: cannot schedule sounds in the past (target: ${t.toFixed(2)}, now: ${ac.currentTime.toFixed(2)})`,
    );
    return;
  }
  // destructure
  let {
    tremolo,
    tremolosync,
    tremolodepth = 1,
    tremoloskew,
    tremolophase = 0,
    tremoloshape,
    s = getDefaultValue('s'),
    bank,
    source,
    gain = getDefaultValue('gain'),
    postgain = getDefaultValue('postgain'),
    density = getDefaultValue('density'),
    duckorbit,
    duckonset,
    duckattack,
    duckdepth,
    djf,
    // filters
    fanchor = getDefaultValue('fanchor'),
    release = 0,

    //phaser
    phaserrate: phaser,
    phaserdepth = getDefaultValue('phaserdepth'),
    phasersweep,
    phasercenter,
    //
    coarse,

    crush,
    dry,
    shape,
    shapevol = getDefaultValue('shapevol'),
    distort,
    distortvol = getDefaultValue('distortvol'),
    distorttype = getDefaultValue('distorttype'),
    pan,
    vowel,
    delay = getDefaultValue('delay'),
    delayfeedback = getDefaultValue('delayfeedback'),
    delaysync = getDefaultValue('delaysync'),
    delaytime,
    orbit = getDefaultValue('orbit'),
    room,
    roomfade,
    roomlp,
    roomdim,
    roomsize,
    ir,
    irspeed,
    irbegin,
    i = getDefaultValue('i'),
    velocity = getDefaultValue('velocity'),
    analyze, // analyser wet
    fft = getDefaultValue('fft'), // fftSize 0 - 10
    compressor: compressorThreshold,
    compressorRatio,
    compressorKnee,
    compressorAttack,
    compressorRelease,
  } = value;

  delaytime = delaytime ?? cycleToSeconds(delaysync, cps);

  const orbitChannels = mapChannelNumbers(
    multiChannelOrbits && orbit > 0 ? [orbit * 2 - 1, orbit * 2] : getDefaultValue('channels'),
  );

  const channels = value.channels != null ? mapChannelNumbers(value.channels) : orbitChannels;
  const orbitBus = audioController.getOrbit(orbit, channels);
  if (duckorbit != null) {
    audioController.duck(duckorbit, t, duckonset, duckattack, duckdepth);
  }

  gain = applyGainCurve(nanFallback(gain, 1));
  postgain = applyGainCurve(postgain);
  shapevol = applyGainCurve(shapevol);
  distortvol = applyGainCurve(distortvol);
  delay = applyGainCurve(delay);
  velocity = applyGainCurve(velocity);
  tremolodepth = applyGainCurve(tremolodepth);
  gain *= velocity; // velocity currently only multiplies with gain. it might do other things in the future

  const end = t + hapDuration;
  const endWithRelease = end + release;
  const chainID = Math.round(Math.random() * 1000000);

  // oldest audio nodes will be destroyed if maximum polyphony is exceeded
  for (let i = 0; i <= activeSoundSources.size - maxPolyphony; i++) {
    const ch = activeSoundSources.entries().next();
    const source = ch.value[1].deref();
    const chainID = ch.value[0];
    const endTime = t + 0.25;
    source?.node?.gain?.linearRampToValueAtTime(0, endTime);
    source?.stop?.(endTime);
    activeSoundSources.delete(chainID);
  }

  let audioNodes = [];

  if (['-', '~', '_'].includes(s)) {
    return;
  }
  if (bank && s) {
    s = `${bank}_${s}`;
    value.s = s;
  }

  // get source AudioNode
  let sourceNode;
  if (source) {
    sourceNode = source(t, value, hapDuration, cps);
    nodes['source'] = [sourceNode];
  } else if (getSound(s)) {
    const { onTrigger } = getSound(s);
    const onEnded = () => {
      audioNodes.forEach((n) => n?.disconnect());
      activeSoundSources.delete(chainID);
    };
    const soundHandle = await onTrigger(t, value, onEnded, cps);

    if (soundHandle) {
      sourceNode = soundHandle.node;
      activeSoundSources.set(chainID, new WeakRef(soundHandle)); // allow GC
      nodes['source'] = [soundHandle.source];
    }
  } else {
    throw new Error(`sound ${s} not found! Is it loaded?`);
  }
  if (!sourceNode) {
    // if onTrigger does not return anything, we will just silently skip
    // this can be used for things like speed(0) in the sampler
    return;
  }

  if (ac.currentTime > t) {
    logger('[webaudio] skip hap: still loading', ac.currentTime - t);
    return;
  }
  const chain = []; // audio nodes that will be connected to each other sequentially
  chain.push(sourceNode);
  stretch !== undefined && chain.push(getWorklet(ac, 'phase-vocoder-processor', { pitchFactor: stretch }));

  // gain stage
  const initialGain = gainNode(gain);
  nodes['gain'] = [initialGain];
  chain.push(initialGain);

  // filter
  const ftype = getFilterType(value.ftype);

  const filt = (params) => createFilter(ac, t, end, params, cps);
  if (value.cutoff !== undefined) {
    const lpMap = {
      frequency: 'cutoff',
      q: 'resonance',
      attack: 'lpattack',
      decay: 'lpdecay',
      sustain: 'lpsustain',
      release: 'lprelease',
      env: 'lpenv',
      anchor: 'fanchor',
      model: 'ftype',
      drive: 'drive',
      rate: 'lprate',
      sync: 'lpsync',
      depth: 'lpdepth',
      shape: 'lpshape',
      dcoffset: 'lpdc',
      skew: 'lpskew',
    };
    const lpParams = pickAndRename(value, lpMap);
    lpParams.type = 'lowpass';
    const lp1 = filt(lpParams);
    nodes['lpf'] = [lp1];
    chain.push(lp1);
    if (ftype === '24db') {
      const lp2 = filt(lpParams);
      nodes['lpf'].push(lp2);
      chain.push(lp2);
    }
  }

  if (value.hcutoff !== undefined) {
    const hpMap = {
      frequency: 'hcutoff',
      q: 'hresonance',
      attack: 'hpattack',
      decay: 'hpdecay',
      sustain: 'hpsustain',
      release: 'hprelease',
      env: 'hpenv',
      anchor: 'fanchor',
      model: 'ftype',
      drive: 'drive',
      rate: 'hprate',
      sync: 'hpsync',
      depth: 'hpdepth',
      shape: 'hpshape',
      dcoffset: 'hpdc',
      skew: 'hpskew',
    };
    const hpParams = pickAndRename(value, hpMap);
    hpParams.type = 'highpass';
    const hp1 = filt(hpParams);
    nodes['hpf'] = [hp1];
    chain.push(hp1);
    if (ftype === '24db') {
      const hp2 = filt(hpParams);
      nodes['hpf'].push(hp1);
      chain.push(hp2);
    }
  }

  if (value.bandf !== undefined) {
    const bpMap = {
      frequency: 'bandf',
      q: 'bandq',
      attack: 'bpattack',
      decay: 'bpdecay',
      sustain: 'bpsustain',
      release: 'bprelease',
      env: 'bpenv',
      anchor: 'fanchor',
      model: 'ftype',
      drive: 'drive',
      rate: 'bprate',
      sync: 'bpsync',
      depth: 'bpdepth',
      shape: 'bpshape',
      dcoffset: 'bpdc',
      skew: 'bpskew',
    };
    const bpParams = pickAndRename(value, bpMap);
    bpParams.type = 'bandpass';
    const bp1 = filt(bpParams);
    chain.push(bp1);
    if (ftype === '24db') {
      const bp2 = filt(bpParams);
      nodes['bpf'].push(bp2);
      chain.push(bp2);
    }
  }

  if (vowel !== undefined) {
    const vowelFilter = ac.createVowelFilter(vowel);
    nodes['vowel'] = [vowelFilter];
    chain.push(vowelFilter);
  }

  // effects
  if (coarse !== undefined) {
    const coarseNode = getWorklet(ac, 'coarse-processor', { coarse });
    nodes['coarse'] = [coarseNode];
    chain.push(coarseNode);
  }
  if (crush !== undefined) {
    const crushNode = getWorklet(ac, 'crush-processor', { crush });
    nodes['crush'] = [crushNode];
    chain.push(crushNode);
  }
  if (shape !== undefined) {
    const shapeNode = getWorklet(ac, 'shape-processor', { shape, postgain: shapevol });
    nodes['shape'] = [shapeNode];
    chain.push(shapeNode);
  }
  if (distort !== undefined) {
    const distortNode = getDistortion(distort, distortvol, distorttype);
    nodes['distort'] = [distortNode];
    chain.push(distortNode);
  }

  if (tremolosync != null) {
    tremolo = cps * tremolosync;
  }

  if (value.wtPosSynced != null) {
    value.wtPosRate /= cps;
  }

  if (value.wtWarpSynced != null) {
    value.wtWarpRate /= cps;
  }

  if (tremolo !== undefined) {
    // Allow clipping of modulator for more dynamic possiblities, and to prevent speaker overload
    // EX:  a triangle waveform will clip like this /-\ when the depth is above 1
    const gain = Math.max(1 - tremolodepth, 0);
    const amGain = new GainNode(ac, { gain });

    const time = cycle / cps;
    const lfo = getLfo(ac, {
      skew: tremoloskew ?? (tremoloshape != null ? 0.5 : 1),
      frequency: tremolo,
      depth: tremolodepth,
      time,
      dcoffset: 0,
      shape: tremoloshape,
      phaseoffset: tremolophase,
      min: 0,
      max: 1,
      curve: 1.5,
      begin: t,
      end: endWithRelease,
    });
    lfo.connect(amGain.gain);
    chain.push(amGain);
  }

  if (compressorThreshold !== undefined) {
    const compressorNode = getCompressor(
      ac,
      compressorThreshold,
      compressorRatio,
      compressorKnee,
      compressorAttack,
      compressorRelease,
    );
    nodes['compressor'] = [compressorNode];
    chain.push(compressorNode);
  }

  // panning
  if (pan !== undefined) {
    const panner = ac.createStereoPanner();
    panner.pan.value = 2 * pan - 1;
    chain.push(panner);
  }
  // phaser
  if (phaser !== undefined && phaserdepth > 0) {
    const phaserFX = getPhaser(t, endWithRelease, phaser, phaserdepth, phasercenter, phasersweep);
    nodes['phaser'] = [phaserFX];
    chain.push(phaserFX);
  }

  // last gain
  const post = new GainNode(ac, { gain: postgain });
  nodes['post'] = [post];
  chain.push(post);

  // delay
  if (delay > 0 && delaytime > 0 && delayfeedback > 0) {
    const delayNode = orbitBus.getDelay(delaytime, delayfeedback, t);
    nodes['delay'] = [delayNode];
    const delaySend = orbitBus.sendDelay(post, delay);
    audioNodes.push(delaySend);
  }
  // reverb
  if (room > 0) {
    let roomIR;
    if (ir !== undefined) {
      let url;
      let sample = getSound(ir);
      if (Array.isArray(sample)) {
        url = sample.data.samples[i % sample.data.samples.length];
      } else if (typeof sample === 'object') {
        url = Object.values(sample.data.samples).flat()[i % Object.values(sample.data.samples).length];
      }
      roomIR = await loadBuffer(url, ac, ir, 0);
    }
    const reverbNode = orbitBus.getReverb(roomsize, roomfade, roomlp, roomdim, roomIR, irspeed, irbegin);
    nodes['room'] = [reverbNode];
    const reverbSend = orbitBus.sendReverb(post, room);
    audioNodes.push(reverbSend);
  }

  if (djf != null) {
    nodes['djf'] = orbitBus.getDjf(djf, t);
  }

  // analyser
  if (analyze) {
    const analyserNode = getAnalyserById(analyze, 2 ** (fft + 5));
    const analyserSend = effectSend(post, analyserNode, 1);
    audioNodes.push(analyserSend);
  }
  if (dry != null) {
    dry = applyGainCurve(dry);
    const dryGain = new GainNode(ac, { gain: dry });
    chain.push(dryGain);
    orbitBus.connectToOutput(dryGain);
  } else {
    orbitBus.connectToOutput(post);
  }

  // connect chain elements together
  chain.slice(1).reduce((last, current) => last.connect(current), chain[0]);
  audioNodes = audioNodes.concat(chain);

  // finally, now that `nodes` is populated, set up modulators
  if (value.lfo) {
    for (const [idx, params] of Object.entries(value.lfo)) {
      connectLFO(
        idx,
        {
          ...params,
          cps,
          begin: t,
          end: endWithRelease,
        },
        nodes,
      );
    }
  }
  if (value.env) {
    for (const [idx, params] of Object.entries(value.env)) {
      connectEnvelope(
        idx,
        {
          ...params,
          begin: t,
          end: endWithRelease,
        },
        nodes,
      );
    }
  }
  if (value.id) {
    idToNodes[value.id] = new WeakRef(nodes);
  }
  if (value.send) {
    for (const p of value.send) {
      const modNodes = idToNodes[p.id];
      if (!modNodes) {
        logger(
          `[superdough] Could not connect to pattern ${p.id} -- make sure a pattern with this name exists. Available targets: ${Object.keys(idToNodes).join(', ')}`,
        );
      } else {
        const modulator = connectSendModulator({ ...p, begin: t, end: endWithRelease }, post, nodes, chainID);
        pendingConnections[p.id] ??= {};
        pendingConnections[p.id][chainID] = new WeakRef([modulator, p.target, endWithRelease]);
      }
    }
  }
  if (value.id in pendingConnections) {
    for (const data of Object.values(pendingConnections[value.id])) {
      const derefData = data.deref();
      if (!derefData) {
        delete pendingConnections[value.id];
        continue;
      }
      const [modulator, target, end] = derefData;
      const targets = _getTargetParams(nodes, target);
      webAudioTimeout(
        ac,
        () => {
          targets.forEach((target) => modulator.connect(target));
        },
        0,
        t,
      );
      webAudioTimeout(
        ac,
        () => {
          modulator.disconnect();
        },
        0,
        end,
      );
    }
  }
};

export const superdoughTrigger = (t, hap, ct, cps) => {
  superdough(hap, t - ct, hap.duration / cps, cps);
};