fix: delaytime jsdoc

.forgejo/workflows/deploy-hot.yml

@@ -0,0 +1,44 @@
+name: Build and Deploy hot PRs
+
+on:
+  pull_request_target:
+    types: [labeled]
+
+# Allow one concurrent deployment
+concurrency:
+  group: "warm-pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    if: ${{ github.event.label.name == 'serve-hot' }}
+    runs-on: docker
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}      
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9.12.2
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install Dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm build
+
+      - name: Deploy
+        env:
+          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
+        run: |
+          eval $(ssh-agent -s)
+          echo "$SSH_PRIVATE_KEY" | ssh-add -
+          apt update && apt install -y rsync
+          mkdir -p ~/.ssh
+          ssh-keyscan matrix.toplap.org > ~/.ssh/known_hosts
+          rsync -atv --delete --delete-after --progress \
+            ./website/dist/ \
+            strudel@matrix.toplap.org:/home/strudel/deploy/pr-${{ github.event.pull_request.number }}.hot.strudel.cc

packages/core/controls.mjs

@@ -1893,19 +1893,6 @@ export const { delay } = registerControl(['delay', 'delaytime', 'delayfeedback']
  */
 export const { delayfeedback, delayfb, dfb } = registerControl('delayfeedback', 'delayfb', 'dfb');
 
-/**
- * Sets the level of the signal that is fed back into the delay.
- * Caution: Values >= 1 will result in a signal that gets louder and louder! Don't do it
- *
- * @name delayfeedback
- * @tags orbit, superdough, supradough
- * @param {number | Pattern} feedback between 0 and 1
- * @synonyms delayfb, dfb
- * @example
- * s("bd").delay(.25).delayfeedback("<.25 .5 .75 1>")
- *
- */
-export const { delayspeed } = registerControl('delayspeed');
 /**
  * Sets the time of the delay effect.
  *
@@ -1917,6 +1904,16 @@ export const { delayspeed } = registerControl('delayspeed');
  * note("d d a# a".fast(2)).s("sawtooth").delay(.8).delaytime(1/2).delayspeed("<2 .5 -1 -2>")
  *
  */
+export const { delayspeed } = registerControl('delayspeed');
+
+/*
+ * @name delaytime
+ * @tags orbit, superdough, supradough
+ * @param {number | Pattern} delaytime sets the time of the delay effect.
+ * @synonyms delayt, dt
+ * @example
+ * note("d d a# a".fast(2)).s("sawtooth").delay(.8).delaytime(1/2).delayspeed("<2 .5 -1 -2>")
+ */
 export const { delaytime, delayt, dt } = registerControl('delaytime', 'delayt', 'dt');
 
 /**

packages/superdough/sampler.mjs

@@ -1,4 +1,4 @@
-import { BASE_MIDI_NOTE, getBaseURL, getCommonSampleInfo, noteToFreq, noteToMidi } from './util.mjs';
+import { getBaseURL, getCommonSampleInfo } from './util.mjs';
 import { registerSound, registerWaveTable } from './index.mjs';
 import { getAudioContext } from './audioContext.mjs';
 import {
@@ -14,13 +14,6 @@ import { logger } from './logger.mjs';
 const bufferCache = {}; // string: Promise<ArrayBuffer>
 const loadCache = {}; // string: Promise<ArrayBuffer>
 
-/**
- *
- * @typedef {Object} SampleMetaData
- * @property {string} url
- * @property {midi} number
- */
-
 export const getCachedBuffer = (url) => bufferCache[url];
 
 function humanFileSize(bytes, si) {
@@ -40,7 +33,7 @@ function humanFileSize(bytes, si) {
 export function getSampleInfo(hapValue, bank) {
   const { speed = 1.0 } = hapValue;
   const { transpose, url, index, midi, label } = getCommonSampleInfo(hapValue, bank);
-  const playbackRate = Math.abs(speed) * Math.pow(2, transpose / 12);
+  let playbackRate = Math.abs(speed) * Math.pow(2, transpose / 12);
   return { transpose, url, index, midi, label, playbackRate };
 }
 
@@ -163,20 +156,15 @@ export const processSampleMap = (sampleMap, fn, baseUrl = sampleMap._base || '')
     if (baseUrl.startsWith('github:')) {
       baseUrl = githubPath(baseUrl, '');
     }
-    /**
-     *
-     * @param {string} v
-     * @returns {SampleMetaData}
-     */
-    const getMetaData = (v) => ({ url: baseUrl + v, midi: extractMidiNoteFromString(v) });
+    const fullUrl = (v) => baseUrl + v;
     if (Array.isArray(value)) {
       //return [key, value.map(replaceUrl)];
-      value = value.map(getMetaData);
+      value = value.map(fullUrl);
     } else {
       // must be object
       value = Object.fromEntries(
         Object.entries(value).map(([note, samples]) => {
-          return [note, (typeof samples === 'string' ? [samples] : samples).map(getMetaData)];
+          return [note, (typeof samples === 'string' ? [samples] : samples).map(fullUrl)];
         }),
       );
     }
@@ -379,16 +367,3 @@ export function registerSampleSource(key, bank, params) {
     registerSample(key, bank, params);
   }
 }
-
-export function extractMidiNoteFromString(str) {
-  const regex = /_([a-gA-G])([#b])?([1-9])?\b/;
-  const match = str.match(regex);
-  if (match == null) {
-    return BASE_MIDI_NOTE;
-  }
-  const base = match[1].toUpperCase();
-  const accidental = match[2] ?? '';
-  const octave_str = match[3] ?? '';
-  const parsedVal = base + accidental + octave_str;
-  return noteToMidi(parsedVal);
-}

packages/superdough/util.mjs

@@ -19,12 +19,7 @@ const accs = { '#': 1, b: -1, s: 1, f: -1 };
 export const getAccidentalsOffset = (accidentals) => {
   return accidentals?.split('').reduce((o, char) => o + accs[char], 0) || 0;
 };
-/**
- *
- * @param {string} note
- * @param {number} defaultOctave
- * @returns {number}
- */
+
 export const noteToMidi = (note, defaultOctave = 3) => {
   const [pc, acc, oct = defaultOctave] = tokenizeNote(note);
   if (!pc) {
@@ -34,11 +29,6 @@ export const noteToMidi = (note, defaultOctave = 3) => {
   const offset = getAccidentalsOffset(acc);
   return (Number(oct) + 1) * 12 + chroma + offset;
 };
-/**
- *
- * @param {number} n
- * @returns {number}
- */
 export const midiToFreq = (n) => {
   return Math.pow(2, (n - 69) / 12) * 440;
 };
@@ -48,17 +38,7 @@ export const freqToMidi = (freq) => {
   return (12 * Math.log(freq / 440)) / Math.LN2 + 69;
 };
 
-/**
- *
- * @param {string} note
- * @param {number} defaultOctave
- * @returns {number}
- */
-
-export const noteToFreq = (note, defaultOctave = 3) => {
-  return midiToFreq(noteToMidi(note, defaultOctave));
-};
-function __valueToMidi(value) {
+export const valueToMidi = (value, fallbackValue) => {
   if (typeof value !== 'object') {
     throw new Error('valueToMidi: expected object value');
   }
@@ -72,15 +52,10 @@ function __valueToMidi(value) {
   if (typeof note === 'number') {
     return note;
   }
-  return;
-}
-
-export const valueToMidi = (value, fallbackValue) => {
-  const parsedValue = __valueToMidi(value) ?? fallbackValue;
-  if (parsedValue == null) {
+  if (!fallbackValue) {
     throw new Error('valueToMidi: expected freq or note to be set');
   }
-  return parsedValue;
+  return fallbackValue;
 };
 
 export function nanFallback(value, fallback = 0, silent) {
@@ -109,18 +84,15 @@ export function secondsToCycle(t, cps) {
 // deduces relevant info for sample loading from hap.value and sample definition
 // it encapsulates the core sampler logic into a pure and synchronous function
 // hapValue: Hap.value, bank: sample bank definition for sound "s" (values in strudel.json format)
-export const BASE_MIDI_NOTE = 36;
-
 export function getCommonSampleInfo(hapValue, bank) {
   const { s, n = 0 } = hapValue;
-  const maybeMidiNote = __valueToMidi(hapValue);
-  const midi = maybeMidiNote ?? BASE_MIDI_NOTE;
-  let transpose = midi - BASE_MIDI_NOTE; // C3 is middle C;
+  let midi = valueToMidi(hapValue, 36);
+  let transpose = midi - 36; // C3 is middle C;
+  let url;
   let index = 0;
-  let samplemeta;
   if (Array.isArray(bank)) {
     index = getSoundIndex(n, bank.length);
-    samplemeta = bank[index];
+    url = bank[index];
   } else {
     const midiDiff = (noteA) => noteToMidi(noteA) - midi;
     // object format will expect keys as notes
@@ -132,14 +104,10 @@ export function getCommonSampleInfo(hapValue, bank) {
       );
     transpose = -midiDiff(closest); // semitones to repitch
     index = getSoundIndex(n, bank[closest].length);
-    samplemeta = bank[closest][index];
+    url = bank[closest][index];
   }
   const label = `${s}:${index}`;
-  if (maybeMidiNote != null) {
-    transpose = transpose + (BASE_MIDI_NOTE - samplemeta.midi);
-  }
-
-  return { transpose, index, midi, label, url: samplemeta.url };
+  return { transpose, url, index, midi, label };
 }
 
 /** Selects entries from `source` and renames them via `map`

website/src/repl/idbutils.mjs

@@ -1,4 +1,4 @@
-import { extractMidiNoteFromString, registerSampleSource } from '@strudel/webaudio';
+import { registerSampleSource } from '@strudel/webaudio';
 import { isAudioFile } from './files.mjs';
 import { logger } from '@strudel/core';
 
@@ -47,7 +47,7 @@ export function registerSamplesFromDB(config = userSamplesDBConfig, onComplete =
       Promise.all(
         [...soundFiles]
           .sort((a, b) => a.title.localeCompare(b.title, undefined, { numeric: true, sensitivity: 'base' }))
-          .map((soundFile) => {
+          .map((soundFile, i) => {
             const title = soundFile.title;
             if (!isAudioFile(title)) {
               return;
@@ -58,26 +58,25 @@ export function registerSamplesFromDB(config = userSamplesDBConfig, onComplete =
               splitRelativePath[splitRelativePath.length - 2] ?? soundFile.id.split(/\W+/)[0] ?? 'user';
             const blob = soundFile.blob;
 
-            return blobToDataUrl(blob).then((path) => {
-              const sampleInfoMap = sounds.get(parentDirectory) ?? new Map();
-              const midi = extractMidiNoteFromString(title);
-              /** @type {import('@strudel/webaudio').SampleMetaData} */
-              const samplemetadata = { url: path, midi };
-              sampleInfoMap.set(title, samplemetadata);
+            return blobToDataUrl(blob).then((soundPath) => {
+              const titlePathMap = sounds.get(parentDirectory) ?? new Map();
 
-              sounds.set(parentDirectory, sampleInfoMap);
+              titlePathMap.set(title, soundPath);
+
+              sounds.set(parentDirectory, titlePathMap);
               return;
             });
           }),
       )
         .then(() => {
-          sounds.forEach((sampleInfoMap, key) => {
-            const bank = Array.from(sampleInfoMap.keys())
+          sounds.forEach((titlePathMap, key) => {
+            const value = Array.from(titlePathMap.keys())
               .sort((a, b) => {
                 return a.localeCompare(b);
               })
-              .map((title) => sampleInfoMap.get(title));
-            registerSampleSource(key, bank, { prebake: false });
+              .map((title) => titlePathMap.get(title));
+
+            registerSampleSource(key, value, { prebake: false });
           });
 
           logger('imported sounds registered!', 'success');