strudel/packages/midi/midi.mjs

/*
midi.mjs - <short description TODO>
Copyright (C) 2022 Strudel contributors - see <https://codeberg.org/uzu/strudel/src/branch/main/packages/midi/midi.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 * as _WebMidi from 'webmidi';
import {
  Hap,
  Pattern,
  TimeSpan,
  getCps,
  getIsStarted,
  getPattern,
  getTime,
  getTriggerFunc,
  isPattern,
  logger,
  ref,
  reify,
} from '@strudel/core';
import { noteToMidi, getControlName } from '@strudel/core';
import { Note } from 'webmidi';
import { getAudioContext } from '@strudel/webaudio';
import { scheduleAtTime } from '../superdough/helpers.mjs';
import { getMidiDeviceNamesString, getDevice } from './util.mjs';
import { MidiInput } from './input.mjs';

// if you use WebMidi from outside of this package, make sure to import that instance:
export const { WebMidi } = _WebMidi;

function supportsMidi() {
  return typeof navigator.requestMIDIAccess === 'function';
}

export function enableWebMidi(options = {}) {
  const { onReady, onConnected, onDisconnected, onEnabled } = options;
  if (WebMidi.enabled) {
    return;
  }
  if (!supportsMidi()) {
    throw new Error('Your Browser does not support WebMIDI.');
  }
  WebMidi.addListener('connected', () => {
    onConnected?.(WebMidi);
  });
  WebMidi.addListener('enabled', () => {
    onEnabled?.(WebMidi);
  });
  // Reacting when a device becomes unavailable
  WebMidi.addListener('disconnected', (e) => {
    onDisconnected?.(WebMidi, e);
  });
  return new Promise((resolve, reject) => {
    if (WebMidi.enabled) {
      // if already enabled, just resolve WebMidi
      resolve(WebMidi);
      return;
    }
    WebMidi.enable(
      (err) => {
        if (err) {
          reject(err);
        }
        onReady?.(WebMidi);
        resolve(WebMidi);
      },
      { sysex: true },
    );
  });
}

// send start/stop messages to outputs when repl starts/stops
if (typeof window !== 'undefined') {
  window.addEventListener('message', (e) => {
    if (!WebMidi?.enabled) {
      return;
    }
    if (e.data === 'strudel-stop') {
      WebMidi.outputs.forEach((output) => output.sendStop());
    }
    // cannot start here, since we have no timing info, see sendStart below
  });
}

// registry for midi mappings, converting control names to cc messages
export const midicontrolMap = new Map();

// takes midimap and converts each control key to the main control name
function unifyMapping(mapping) {
  return Object.fromEntries(
    Object.entries(mapping).map(([key, mapping]) => {
      if (typeof mapping === 'number') {
        mapping = { ccn: mapping };
      }
      return [getControlName(key), mapping];
    }),
  );
}

function githubPath(base, subpath = '') {
  if (!base.startsWith('github:')) {
    throw new Error('expected "github:" at the start of pseudoUrl');
  }
  let [_, path] = base.split('github:');
  path = path.endsWith('/') ? path.slice(0, -1) : path;
  if (path.split('/').length === 2) {
    // assume main as default branch if none set
    path += '/main';
  }
  return `https://raw.githubusercontent.com/${path}/${subpath}`;
}

/**
 * configures the default midimap, which is used when no "midimap" port is set
 * @tags external_io, midi
 * @example
 * defaultmidimap({ lpf: 74 })
 * $: note("c a f e").midi();
 * $: lpf(sine.slow(4).segment(16)).midi();
 */
export function defaultmidimap(mapping) {
  midicontrolMap.set('default', unifyMapping(mapping));
}

let loadCache = {};

/**
 * Adds midimaps to the registry. Inside each midimap, control names (e.g. lpf) are mapped to cc numbers.
 * @tags external_io, midi
 * @example
 * midimaps({ mymap: { lpf: 74 } })
 * $: note("c a f e")
 * .lpf(sine.slow(4))
 * .midimap('mymap')
 * .midi()
 * @example
 * midimaps({ mymap: {
 *   lpf: { ccn: 74, min: 0, max: 20000, exp: 0.5 }
 * }})
 * $: note("c a f e")
 * .lpf(sine.slow(2).range(400,2000))
 * .midimap('mymap')
 * .midi()
 */
export async function midimaps(map) {
  if (typeof map === 'string') {
    if (map.startsWith('github:')) {
      map = githubPath(map, 'midimap.json');
    }
    if (!loadCache[map]) {
      loadCache[map] = fetch(map).then((res) => res.json());
    }
    map = await loadCache[map];
  }
  if (typeof map === 'object') {
    Object.entries(map).forEach(([name, mapping]) => midicontrolMap.set(name, unifyMapping(mapping)));
  }
}

// registry for midi sounds, converting sound names to controls
export const midisoundMap = new Map();

// normalizes the given value from the given range and exponent
function normalize(value = 0, min = 0, max = 1, exp = 1) {
  if (min === max) {
    throw new Error('min and max cannot be the same value');
  }
  let normalized = (value - min) / (max - min);
  normalized = Math.min(1, Math.max(0, normalized));
  return Math.pow(normalized, exp);
}

function mapCC(mapping, value) {
  return Object.keys(value)
    .filter((key) => !!mapping[getControlName(key)])
    .map((key) => {
      const { ccn, min = 0, max = 1, exp = 1 } = mapping[key];
      const ccv = normalize(value[key], min, max, exp);
      return { ccn, ccv };
    });
}

// sends a cc message to the given device on the given channel
function sendCC(ccn, ccv, device, midichan, targetTime) {
  if (typeof ccv !== 'number' || ccv < 0 || ccv > 1) {
    throw new Error('expected ccv to be a number between 0 and 1');
  }
  if (!['string', 'number'].includes(typeof ccn)) {
    throw new Error('expected ccn to be a number or a string');
  }
  const scaled = Math.round(ccv * 127);
  scheduleAtTime(() => {
    device.sendControlChange(ccn, scaled, midichan);
  }, targetTime);
}

// sends a program change message to the given device on the given channel
function sendProgramChange(progNum, device, midichan, targetTime) {
  if (typeof progNum !== 'number' || progNum < 0 || progNum > 127) {
    throw new Error('expected progNum (program change) to be a number between 0 and 127');
  }
  scheduleAtTime(() => {
    device.sendProgramChange(progNum, midichan);
  }, targetTime);
}

// sends a sysex message to the given device on the given channel
function sendSysex(sysexid, sysexdata, device, targetTime) {
  if (Array.isArray(sysexid)) {
    if (!sysexid.every((byte) => Number.isInteger(byte) && byte >= 0 && byte <= 255)) {
      throw new Error('all sysexid bytes must be integers between 0 and 255');
    }
  } else if (!Number.isInteger(sysexid) || sysexid < 0 || sysexid > 255) {
    throw new Error('A:sysexid must be an number between 0 and 255 or an array of such integers');
  }

  if (!Array.isArray(sysexdata)) {
    throw new Error('expected sysex to be an array of numbers (0-255)');
  }
  if (!sysexdata.every((byte) => Number.isInteger(byte) && byte >= 0 && byte <= 255)) {
    throw new Error('all sysex bytes must be integers between 0 and 255');
  }
  scheduleAtTime(() => {
    device.sendSysex(sysexid, sysexdata);
  }, targetTime);
}

// sends a NRPN message to the given device on the given channel
function sendNRPN(nrpnn, nrpv, device, midichan, targetTime) {
  if (Array.isArray(nrpnn)) {
    if (!nrpnn.every((byte) => Number.isInteger(byte) && byte >= 0 && byte <= 255)) {
      throw new Error('all nrpnn bytes must be integers between 0 and 255');
    }
  } else if (!Number.isInteger(nrpv) || nrpv < 0 || nrpv > 255) {
    throw new Error('A:sysexid must be an number between 0 and 255 or an array of such integers');
  }
  scheduleAtTime(() => {
    device.sendNRPN(nrpnn, nrpv, midichan);
  }, targetTime);
}

// sends a pitch bend message to the given device on the given channel
function sendPitchBend(midibend, device, midichan, targetTime) {
  if (typeof midibend !== 'number' || midibend < -1 || midibend > 1) {
    throw new Error('expected midibend to be a number between -1 and 1');
  }
  scheduleAtTime(() => {
    device.sendPitchBend(midibend, midichan);
  }, targetTime);
}

// sends a channel aftertouch message to the given device on the given channel
function sendAftertouch(miditouch, device, midichan, targetTime) {
  if (typeof miditouch !== 'number' || miditouch < 0 || miditouch > 1) {
    throw new Error('expected miditouch to be a number between 0 and 1');
  }

  scheduleAtTime(() => {
    device.sendChannelAftertouch(miditouch, midichan);
  }, targetTime);
}

// sends a note message to the given device on the given channel
function sendNote(note, velocity, duration, device, midichan, targetTime) {
  if (note == null || note === '') {
    throw new Error('note cannot be null or empty');
  }
  if (velocity != null && (typeof velocity !== 'number' || velocity < 0 || velocity > 1)) {
    throw new Error('velocity must be a number between 0 and 1');
  }
  if (duration != null && (typeof duration !== 'number' || duration < 0)) {
    throw new Error('duration must be a positive number');
  }
  const midiNumber = typeof note === 'number' ? note : noteToMidi(note);
  const midiNote = new Note(midiNumber, { attack: velocity, duration });

  scheduleAtTime(() => {
    device.playNote(midiNote, midichan);
  }, targetTime);
}

/**
 * MIDI output: Opens a MIDI output port.
 * @tags external_io
 * @param {string | number} midiport MIDI device name or index defaulting to 0
 * @param {object} options Additional MIDI configuration options
 * @example
 * note("c4").midichan(1).midi('IAC Driver Bus 1')
 * @example
 * note("c4").midichan(1).midi('IAC Driver Bus 1', { controller: true, latency: 50 })
 */

Pattern.prototype.midi = function (midiport, options = {}) {
  if (isPattern(midiport)) {
    throw new Error(
      `.midi does not accept Pattern input for midiport. Make sure to pass device name with single quotes. Example: .midi('${
        WebMidi.outputs?.[0]?.name || 'IAC Driver Bus 1'
      }')`,
    );
  }

  // For backward compatibility
  if (typeof midiport === 'object') {
    const { port, isController = false, ...configOptions } = midiport;
    options = {
      isController,
      ...configOptions,
      ...options, // Keep any options passed separately
    };
    midiport = port;
  }

  let midiConfig = {
    // Default configuration values
    isController: false, // Disable sending notes for midi controllers
    noteOffsetMs: 10, // Default note-off offset to prevent glitching in ms
    midichannel: 1, // Default MIDI channel
    velocity: 0.9, // Default velocity
    gain: 1, // Default gain
    midimap: 'default', // Default MIDI map
    midiport: midiport, // Store the port in the config
    ...options, // Override defaults with provided options
  };

  enableWebMidi({
    onEnabled: ({ outputs }) => {
      const device = getDevice(midiConfig.midiport, outputs);
      const otherOutputs = outputs.filter((o) => o.name !== device.name);
      logger(
        `Midi enabled! Using "${device.name}". ${
          otherOutputs?.length ? `Also available: ${getMidiDeviceNamesString(otherOutputs)}` : ''
        }`,
      );
    },
    onDisconnected: ({ outputs }) =>
      logger(`Midi device disconnected! Available: ${getMidiDeviceNamesString(outputs)}`),
  });

  return this.onTrigger((hap, _currentTime, cps, targetTime) => {
    if (!WebMidi.enabled) {
      logger('Midi not enabled');
      return;
    }
    hap.ensureObjectValue();

    // midi event values from hap with configurable defaults
    let {
      note,
      nrpnn,
      nrpv,
      ccn,
      ccv,
      midichan = midiConfig.midichannel,
      midicmd,
      midibend,
      miditouch,
      polyTouch,
      gain = midiConfig.gain,
      velocity = midiConfig.velocity,
      progNum,
      sysexid,
      sysexdata,
      midimap = midiConfig.midimap,
      midiport = midiConfig.midiport,
    } = hap.value;

    const device = getDevice(midiport, WebMidi.outputs);
    if (!device) {
      logger(
        `[midi] midiport "${midiport}" not found! available: ${WebMidi.outputs.map((output) => `'${output.name}'`).join(', ')}`,
      );
      return;
    }

    velocity = gain * velocity;

    // Handle midimap
    // if midimap is set, send a cc messages from defined controls
    if (midicontrolMap.has(midimap)) {
      const ccs = mapCC(midicontrolMap.get(midimap), hap.value);
      ccs.forEach(({ ccn, ccv }) => sendCC(ccn, ccv, device, midichan, targetTime));
    } else if (midimap !== 'default') {
      // Add warning when a non-existent midimap is specified
      logger(`[midi] midimap "${midimap}" not found! Available maps: ${[...midicontrolMap.keys()].join(', ')}`);
    }

    // Handle note
    if (note !== undefined && !midiConfig.isController) {
      // note off messages will often a few ms arrive late,
      // try to prevent glitching by subtracting noteOffsetMs from the duration length
      const duration = (hap.duration.valueOf() / cps) * 1000 - midiConfig.noteOffsetMs;

      sendNote(note, velocity, duration, device, midichan, targetTime);
    }

    // Handle program change
    if (progNum !== undefined) {
      sendProgramChange(progNum, device, midichan, targetTime);
    }

    // Handle sysex
    // sysex data is consist of 2 arrays, first is sysexid, second is sysexdata
    // sysexid is a manufacturer id it is either a number or an array of 3 numbers.
    // list of manufacturer ids can be found here : https://midi.org/sysexidtable
    // if sysexid is an array the first byte is 0x00

    if (sysexid !== undefined && sysexdata !== undefined) {
      sendSysex(sysexid, sysexdata, device, targetTime);
    }

    // Handle control change
    if (ccv !== undefined && ccn !== undefined) {
      sendCC(ccn, ccv, device, midichan, targetTime);
    }

    // Handle NRPN non-registered parameter number
    if (nrpnn !== undefined && nrpv !== undefined) {
      sendNRPN(nrpnn, nrpv, device, midichan, targetTime);
    }

    // Handle midibend
    if (midibend !== undefined) {
      sendPitchBend(midibend, device, midichan, targetTime);
    }

    // Handle miditouch
    if (miditouch !== undefined) {
      sendAftertouch(miditouch, device, midichan, targetTime);
    }

    // Handle midicmd
    if (hap.whole.begin + 0 === 0) {
      // we need to start here because we have the timing info
      scheduleAtTime(() => {
        device.sendStart();
      }, targetTime);
    }
    if (['clock', 'midiClock'].includes(midicmd)) {
      scheduleAtTime(() => {
        device.sendClock();
      }, targetTime);
    } else if (['start'].includes(midicmd)) {
      scheduleAtTime(() => {
        device.sendStart();
      }, targetTime);
    } else if (['stop'].includes(midicmd)) {
      scheduleAtTime(() => {
        device.sendStop();
      }, targetTime);
    } else if (['continue'].includes(midicmd)) {
      scheduleAtTime(() => {
        device.sendContinue();
      }, targetTime);
    } else if (Array.isArray(midicmd)) {
      if (midicmd[0] === 'progNum') {
        sendProgramChange(midicmd[1], device, midichan, targetTime);
      } else if (midicmd[0] === 'cc') {
        if (midicmd.length === 2) {
          sendCC(midicmd[0], midicmd[1] / 127, device, midichan, targetTime);
        }
      } else if (midicmd[0] === 'sysex') {
        if (midicmd.length === 3) {
          const [_, id, data] = midicmd;
          sendSysex(id, data, device, targetTime);
        }
      }
    }
  });
};

/**
 * Initialize a midi input device
 */
async function _initializeInput(input) {
  if (isPattern(input)) {
    throw new Error(
      `[midi] Midi input cannot be a pattern. Make sure to pass device name with single quotes. Example: midin('${
        WebMidi.outputs?.[0]?.name || 'IAC Driver Bus 1'
      }')`,
    );
  }

  const initial = await enableWebMidi(); // only returns on first init

  const instance = midiInputs[input] || new MidiInput(input);
  midiInputs[input] = instance;

  if (initial) {
    const device = instance.initialDevice;

    const otherInputs = WebMidi.inputs.filter((o) => o.name !== device.name);
    logger(
      device
        ? `[midi] Midi enabled! Using "${device.name}". ${
            otherInputs?.length ? `Also available: ${getMidiDeviceNamesString(otherInputs)}` : ''
          }`
        : `[midi] Midi enabled! Waiting for device "${input}"... Currently connected devices: ${getMidiDeviceNamesString(WebMidi.inputs)}`,
    );
  }

  return instance;
}

// MIDI input wrappers, by specified input string/index
const midiInputs = {};

/**
 * MIDI input: Opens a MIDI input port to receive MIDI control change messages.
 *
 * The output is a function that accepts a midi cc value to query as well as (optionally) a midi channel
 *
 * @name midin
 * @tags external_io, midi
 * @param {string | number} input MIDI device name or index defaulting to 0
 * @returns {function(number, number=): Pattern} A function from (cc, channel?) to a pattern.
 *   When queried, the pattern will produces the most recently received midi value (normalized to 0 to 1)
 *   that came through that cc number (and channel, if provided)
 * @example
 * const cc = await midin('IAC Driver Bus 1')
 * note("c a f e").lpf(cc(0).range(0, 1000)).lpq(cc(1).range(0, 10)).sound("sawtooth")
 * @example
 * const allCC = await midin('IAC Driver Bus 1')
 * const cc = (ccNum) => allCC(ccNum, 2) // just channel 2
 * note("c a f e").s("saw")
 *   .when(cc(0).gt(0), x => x.postgain(0))
 */
export async function midin(input) {
  const instance = await _initializeInput(input);

  return instance.createCC.bind(instance);
}

/**
 * MIDI keyboard: Opens a MIDI input port to receive MIDI keyboard messages.
 *
 * The note length is fixed as Superdough is not currently set up for undetermined
 * note durations
 *
 * The 'midichan' control value contains the number of the channel the note is coming from
 * so it could be filtered or manipulated further in the chain.
 *
 * @name midikeys
 * @tags external_io, midi
 * @param {string | number} input MIDI device name or index defaulting to 0
 * @returns {function((number | Pattern)=): Pattern} A function that produces a pattern.
 *   When queried, the pattern will produces the most recently played midi notes and velocities,
 *   lasting for the specified duration
 * @example
 * const kb = await midikeys('Arturia KeyStep 32')
 * kb().s("tri").lpf(80).lpe(6).lpd(0.1).room(2).delay(0.35)
 * @example
 * const kb = await midikeys('Arturia KeyStep 32')
 * kb("0.5 1")
 *   .s("saw")
 *   .add(note(rand.mul(0.3)))
 *   .lpf(1000).lpe(2).room(0.5)
 * @example
 * // discard all notes not coming out from midi channel 2
 * const kb = await midikeys('Arturia KeyStep 32')
 * kb().filterValues(v=>v.midichan==2).s("tri")
 */
const kHaps = {};
const kListeners = {};

function _triggerKeyboard(input, cps, now, latencyCycles) {
  const pattern = getPattern();
  const trigger = getTriggerFunc();
  if (!pattern || !trigger) {
    return false;
  }
  const t = now + latencyCycles;
  const eps = 1e-6;
  const haps = pattern.queryArc(t - eps, t + eps, { _cps: cps });
  // Only keep haps coming from `midikeys`
  const kbHaps = haps.filter((hap) => hap.value?.midikey?.startsWith(`${input}_`));
  const ctxNow = getAudioContext().currentTime;
  if (!kbHaps.length) {
    return false;
  }
  kbHaps.forEach((hap) => {
    if (!hap.hasOnset()) {
      return;
    }
    const t = ctxNow + (hap.whole.begin - now) / cps;
    const duration = hap.duration / cps;
    trigger(hap, t - ctxNow, duration, cps, t);
  });

  return true;
}
export async function midikeys(input) {
  const instance = await _initializeInput(input);

  // TODO: support unpluggable device usage
  const device = instance.initialDevice;
  if (!device) {
    throw new Error(
      `[midi] Midi device "${input}" not found.. connected devices: ${getMidiDeviceNamesString(WebMidi.inputs)}`,
    );
  }

  if (!kHaps[input]) {
    kHaps[input] = [];
  }
  kListeners[input] && device.removeListener('midimessage', kListeners[input]);
  kListeners[input] = (e) => {
    const { dataBytes, message } = e;
    const noteon = message.command === 9;
    let noteoff = message.command === 8;
    // Don't enqueue or trigger midi notes if scheduler is not started
    const notStarted = !getIsStarted();
    // Ignore non-note messages (e.g. CC, pitchbend, modwheel, etc.)
    const notANote = !noteon && !noteoff;
    if (notStarted || notANote) {
      return;
    }
    const [note, velocity] = dataBytes;
    noteoff ||= noteon && velocity === 0; // handle devices which may use velocity = 0 to signal noteoff
    const key = `${input}_${note}`;
    const cps = getCps() ?? 0.5;
    const triggerAvailable = !!(getPattern() && getTriggerFunc());
    const latencySeconds = triggerAvailable ? 0.01 : 0.06; // avoid missing notes due to cyclist / trigger latency
    const now = getTime();
    const t = now + latencySeconds * cps;
    const span = new TimeSpan(t, t);
    let value = { midikey: key };
    if (noteoff) {
      /* TODO: It's a big effort, but we could modify superdough to allow for situations where
      we don't know the hap duration in advance. This would mean, for example, that if the hap
      is flagged as such a special note-on event, we have all effects be persistent & all ADSR
      envelopes stop at the S stage [and store references to them by `midikey`]
      If this is implemented, then getting full keyboard functionality should be as simple
      as sending the corresponding note-off event below and triggering `release` on each of those
      referenced effects/envelopes
      
      value = { ...value, noteoff: true };
  
      If this is achieved, we can remove the noteLength parameter
      */
      return;
    } else {
      value = { ...value, note: Math.round(note), velocity: velocity / 127, midichan: message.channel };
    }
    kHaps[input].push(new Hap(span, span, value, {}));
    if (!noteoff && triggerAvailable) {
      // If we have access to a trigger function, we call it to immediately
      // dispatch to the audio engine, rather than waiting for cyclist to catch these haps
      const triggered = _triggerKeyboard(input, cps, now, latencySeconds * cps);
      if (triggered) {
        kHaps[input] = [];
      }
    }
  };
  device.addListener('midimessage', kListeners[input]);
  const kb = (noteLength = 0.5) => {
    const nlPat = reify(noteLength);
    const query = (state) => {
      const haps = kHaps[input].flatMap((hap) => {
        const lenHaps = nlPat.query(state.setSpan(hap.wholeOrPart()));
        return lenHaps.map((lenHap) => {
          const nl = lenHap.value ?? 0.5;
          const whole = new TimeSpan(hap.whole.begin, hap.whole.begin.add(nl));
          const part = new TimeSpan(hap.part.begin, hap.part.begin.add(nl));
          const context = hap.combineContext(lenHap);
          return new Hap(whole, part, hap.value, context);
        });
      });
      if (state.controls.cyclist) {
        // Notes have been sent; clear them
        kHaps[input] = [];
      }
      return haps;
    };
    return new Pattern(query);
  };
  return kb;
}