Update docstrings and allow modulator ids to be patterns

Reviewed-on: https://codeberg.org/uzu/strudel/pulls/1872

packages/core/controls.mjs

@@ -2844,7 +2844,7 @@ registerSubControls('lfo', [
   ['dcoffset', 'dc'],
   ['shape', 'sh'],
   ['skew', 'sk'],
-  ['curve'],
+  ['curve', 'cu'],
   ['sync', 's'],
   ['fxi'],
 ]);
@@ -2872,7 +2872,7 @@ registerSubControls('bmod', [
   ['fxi'],
 ]);
 
-Pattern.prototype.modulate = function (type, config, id) {
+Pattern.prototype.modulate = function (type, config, idPat) {
   config = { control: undefined, ...config };
   const modulatorKeys = ['lfo', 'env', 'bmod'];
   if (!modulatorKeys.includes(type)) {
@@ -2881,11 +2881,14 @@ Pattern.prototype.modulate = function (type, config, id) {
   }
   let output = this;
   let defaultValue = undefined;
+  // Copy value into a temporary `v` container and attach a single `id` (to be shared across
+  // each config entry). At the output we destructure and throw away the id
+  output = output.fmap((v) => (id) => ({ v, id })).appLeft(reify(idPat));
   for (const [rawKey, value] of Object.entries(config)) {
     const key = getMainSubcontrolName(type, rawKey);
     const valuePat = reify(value);
     output = output
-      .fmap((v) => (c) => {
+      .fmap(({ v, id }) => (c) => {
         if (defaultValue === undefined) {
           // default control to the control set just before this in the chain
           // e.g. pat.gain(0.5).lfo({..}) will be a gain-LFO
@@ -2900,17 +2903,17 @@ Pattern.prototype.modulate = function (type, config, id) {
         id ??= t.__ids.size;
         t[id] ??= { control: defaultValue };
         t.__ids.add(id); // keeps track of insertion order
-        if (c === undefined) return v;
+        if (c === undefined) return { v, id };
         if (key === 'control' || key === 'subControl') {
           t[id][key] = getControlName(c);
         } else {
           t[id][key] = c;
         }
-        return v;
+        return { v, id };
       })
       .appLeft(valuePat);
   }
-  return output;
+  return output.fmap(({ v }) => v);
 };
 
 /**
@@ -2925,15 +2928,15 @@ Pattern.prototype.modulate = function (type, config, id) {
  *
  * @name lfo
  * @param {Object} config LFO configuration.
- * @param {string | Pattern} [config.control] Node to modulate. Aliases: t
- * @param {string | Pattern} [config.subControl] Sub-control name to append to the control key. Aliases: sc, p
- * @param {number | Pattern} [config.rate] Modulation rate. Aliases: rate, r
+ * @param {string | Pattern} [config.control] Node to modulate. Aliases: c
+ * @param {string | Pattern} [config.subControl] Sub-control name to append to the control key. Aliases: sc
+ * @param {number | Pattern} [config.rate] Modulation rate. Aliases: r
  * @param {number | Pattern} [config.depth] Relative modulation depth. Aliases: dep, dr
  * @param {number | Pattern} [config.depthabs] Absolute modulation depth. Aliases: da
  * @param {number | Pattern} [config.dcoffset] DC offset / bias for the waveform. Aliases: dc
  * @param {number | Pattern} [config.shape] Shape index. Aliases: sh
  * @param {number | Pattern} [config.skew] Skew amount. Aliases: sk
- * @param {number | Pattern} [config.curve] Exponential curve amount. Aliases: c
+ * @param {number | Pattern} [config.curve] Exponential curve amount. Aliases: cu
  * @param {number | Pattern} [config.sync] Tempo-synced modulation rate. Aliases: s
  * @param {number | Pattern} [config.fxi] FX index to target
  * @param {string | Pattern} id ID to use for this modulator
@@ -2978,8 +2981,8 @@ export const lfo = (config) => pure({}).lfo(config);
  *
  * @name env
  * @param {Object} config Envelope configuration.
- * @param {string | Pattern} [config.control] Node to modulate. Aliases: t
- * @param {string | Pattern} [config.subControl] Sub-control name to append to the control key. Aliases: sc, p
+ * @param {string | Pattern} [config.control] Node to modulate. Aliases: c
+ * @param {string | Pattern} [config.subControl] Sub-control name to append to the control key. Aliases: sc
  * @param {number | Pattern} [config.depth] Relative modulation depth. Aliases: dep, dr
  * @param {number | Pattern} [config.depthabs] Absolute modulation depth. Aliases: da
  * @param {number | Pattern} [config.attack] Time to reach depth. Aliases: att, a
@@ -3039,8 +3042,8 @@ export const env = (config) => pure({}).env(config);
  * @name bmod
  * @param {Object} config Bus modulation configuration.
  * @param {string | Pattern} [config.bus] Bus to get modulation signal from
- * @param {string | Pattern} [config.control] Node to modulate. Aliases: t
- * @param {string | Pattern} [config.subControl] Sub-control name to append to the control key. Aliases: sc, p
+ * @param {string | Pattern} [config.control] Node to modulate. Aliases: c
+ * @param {string | Pattern} [config.subControl] Sub-control name to append to the control key. Aliases: sc
  * @param {number | Pattern} [config.depth] Relative modulation depth. Aliases: dep, dr
  * @param {number | Pattern} [config.depthabs] Absolute modulation depth. Aliases: da
  * @param {number | Pattern} [config.dc] DC offset prior to application

packages/core/pattern.mjs

@@ -3723,8 +3723,8 @@ export const phases = (list) => {
 };
 
 /**
- * Establishes an FX chain. Can be called by chaining .FX(<fx1>).FX(<fx2>)..
- * calls and/or in a single .FX(<fx1>, <fx2>, ..) call. The <fx1>, .. are _patterns_ which
+ * Establishes an FX chain. Can be called by chaining .FX(fx1).FX(fx2)..
+ * calls and/or in a single .FX(fx1, fx2, ..) call. The fx1, .. are _patterns_ which
  * establish the controls of the given effect. See examples.
  * @name FX
  * @memberof Pattern

packages/osc/README.md

@@ -46,4 +46,4 @@ all(osc)
 
 [open in repl](https://strudel.cc/#JDogcygiYmQqNCIpCgphbGwob3NjKQ%3D%3D)
 
-You can read more about [how to use Superdirt with Strudel the Tutorial](https://strudel.cc/learn/input-output/#superdirt-api)
+You can read more about [how to use Superdirt with Strudel](https://strudel.cc/learn/input-output/#oscsuperdirtstrudeldirt) in  the tutorial.

packages/superdough/superdough.mjs

@@ -607,7 +607,11 @@ export const superdough = async (value, t, hapDuration, cps = 0.5, cycle = 0.5)
     gain *= velocity; // velocity currently only multiplies with gain. it might do other things in the future
     delaytime = delaytime ?? cycleToSeconds(delaysync, cps);
 
-    stretch !== undefined && chain.connect(getWorklet(ac, 'phase-vocoder-processor', { pitchFactor: stretch }));
+    if (stretch !== undefined) {
+      const phaseVocoder = getWorklet(ac, 'phase-vocoder-processor', { pitchFactor: stretch });
+      chain.connect(phaseVocoder);
+      fxNodes['stretch'] = [phaseVocoder];
+    }
 
     if (fx.transient !== undefined) {
       const transProcessor = getWorklet(
@@ -821,6 +825,7 @@ export const superdough = async (value, t, hapDuration, cps = 0.5, cycle = 0.5)
     // panning
     if (fx.pan !== undefined) {
       const panner = ac.createStereoPanner();
+      fxNodes['pan'] = [panner];
       panner.pan.value = 2 * fx.pan - 1;
       chain.connect(panner);
     }

website/src/pages/technical-manual/repl.mdx

@@ -41,7 +41,7 @@ note("c3 [e3 g3]*2")
 is transpiled to:
 
 ```strudel
-note(m('c3 [e3 g3]', 5))
+note(m('c3 [e3 g3]*2', 5))
 ```
 
 Here, the string is wrapped in `m`, which will create a pattern from a mini-notation string. As the second parameter, it gets passed source code location of the string, which enables highlighting active events later.

website/src/pages/workshop/first-sounds.mdx

@@ -377,4 +377,4 @@ insect [crow metal] - -,
   punchcard
 />
 
-Now that we know the basics of how to make beats, let's look at how we can play [notes](/workshop/first-notes)
+Now that we know the basics of how to make beats, let's look at how we can play [notes](/workshop/first-notes).