Merge branch 'main' of ssh://codeberg.org/vvolhejn/strudel into radical-new-docs

packages/core/pattern.mjs

@@ -26,6 +26,7 @@ import {
 } from './util.mjs';
 import drawLine from './drawLine.mjs';
 import { errorLogger, logger } from './logger.mjs';
+import { strudelScope } from './evaluate.mjs';
 
 let stringParser;
 
@@ -1742,7 +1743,9 @@ export function register(name, func, patternify = true, preserveSteps = false, j
 
   // toplevel functions get curried as well as patternified
   // because pfunc uses spread args, we need to state the arity explicitly!
-  return curry(pfunc, null, arity);
+  const curried = curry(pfunc, null, arity);
+  strudelScope[name] = curried;
+  return curried;
 }
 
 // Like register, but defaults to stepJoin
@@ -3730,6 +3733,20 @@ export const morph = (frompat, topat, bypat) => {
   return frompat.innerBind((from) => topat.innerBind((to) => bypat.innerBind((by) => _morph(from, to, by))));
 };
 
+const _distortWithAlg = function (name) {
+  const func = function (args, pat) {
+    const argsPat = reify(args).fmap((v) => (Array.isArray(v) ? [...v, name] : [v, 1, name]));
+    if (!pat) {
+      return pure({}).distort(argsPat);
+    }
+    return pat.distort(argsPat);
+  };
+  Pattern.prototype[name] = function (args) {
+    return func(args, this);
+  };
+  return func;
+};
+
 /**
  * Soft-clipping distortion
  *
@@ -3739,6 +3756,8 @@ export const morph = (frompat, topat, bypat) => {
  * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
+export const soft = _distortWithAlg('soft');
+
 /**
  * Hard-clipping distortion
  *
@@ -3748,6 +3767,8 @@ export const morph = (frompat, topat, bypat) => {
  * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
+export const hard = _distortWithAlg('hard');
+
 /**
  * Cubic polynomial distortion
  *
@@ -3757,6 +3778,8 @@ export const morph = (frompat, topat, bypat) => {
  * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
+export const cubic = _distortWithAlg('cubic');
+
 /**
  * Diode-emulating distortion
  *
@@ -3766,6 +3789,8 @@ export const morph = (frompat, topat, bypat) => {
  * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
+export const diode = _distortWithAlg('diode');
+
 /**
  * Asymmetrical diode distortion
  *
@@ -3775,6 +3800,8 @@ export const morph = (frompat, topat, bypat) => {
  * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
+export const asym = _distortWithAlg('asym');
+
 /**
  * Wavefolding distortion
  *
@@ -3784,6 +3811,8 @@ export const morph = (frompat, topat, bypat) => {
  * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
+export const fold = _distortWithAlg('fold');
+
 /**
  * Wavefolding distortion composed with sinusoid
  *
@@ -3793,6 +3822,8 @@ export const morph = (frompat, topat, bypat) => {
  * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
+export const sinefold = _distortWithAlg('sinefold');
+
 /**
  * Distortion via Chebyshev polynomials
  *
@@ -3802,14 +3833,7 @@ export const morph = (frompat, topat, bypat) => {
  * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
-const distAlgoNames = ['scurve', 'soft', 'hard', 'cubic', 'diode', 'asym', 'fold', 'sinefold', 'chebyshev'];
-for (const name of distAlgoNames) {
-  // Add aliases for distortion algorithms
-  Pattern.prototype[name] = function (args) {
-    const argsPat = reify(args).fmap((v) => (Array.isArray(v) ? [...v, name] : [v, 1, name]));
-    return this.distort(argsPat);
-  };
-}
+export const chebyshev = _distortWithAlg('chebyshev');
 
 /**
  * Turns a list of patterns into a single pattern which outputs list-values
@@ -3905,3 +3929,83 @@ Pattern.prototype.FX = function (...effects) {
     return { ...v, FX: currFX.concat(vEff) };
   }).appLeft(parray(effects));
 };
+
+const _asArrayPattern = (pats) => {
+  const pack = (...xs) => xs;
+  let acc = pure(curry(pack, null, pats.length));
+  for (const p of pats) acc = acc.appLeft(p);
+  return acc;
+};
+
+/**
+ * Produces a [Kabelsalat](https://kabel.salat.dev/) modular sound engine.
+ * This can be used as either an effect (by including `audioin()` at the beginning
+ * of your kabel expression) or as a sound source (via any expression which doesn't
+ * start with `audioin()`).
+ *
+ * Some helpers you have available to you:
+ *   * Strudel mini notation works fine in K(..) via "" or ``
+ *   * More complex Strudel expressions (like "0 1 2".fast(4) or irand(24)) can be
+ *     written by wrapping them in `S(..)` inside your Kabel code
+ *   * We expose Strudel's note frequency under `sFreq` and Strudel's gate
+ *     information under `sGate`
+ *   * You can use more complex multi-line expressions (like `let x = a; let y = b; x.lpf(y);`)
+ *     by wrapping them inside a function in K (see example).
+ *
+ * @name K
+ * @param {KabelsalatExpression | Function} expr Kabelsalat graph definition
+ * @memberof Pattern
+ * @returns Pattern
+ *
+ * @example
+ * note("A c e".fast(4)).transpose("<0 2 4 6 8>")
+ *   .scale("F:minor").transpose("12")
+ *   .s("saw")
+ *   .K(
+ *     // audioin().mul(sGate.adsr(0.001, 0.3, 0, 0.2)) // as effect
+ *     saw(saw(sFreq / "2!3 16").mul(8).add(sFreq).lag("0!3 0.1")).mul(0.3) // as source
+ *     .mul(sGate.adsr(0, 0.15, 0.5, "0.1!3 1"))
+ *     .lpf(sGate.adsr(0, 0.2, 0.3, 0.2).mul(1).add(0))
+ *     .add(x => x.delay(S("0.3 0.2".fast(2))).mul(0.7))
+ *     .add(x => x.delay("0.03 [0.08 0.01] 0.01 0.013").mul(0.77)).mul(0.7)
+ *     .add(x => x.delay(.13).mul(0.7))
+ *     .out()
+ *   )
+ *
+ * @example
+ * n("<0 1 <2 3 2 4>>*16")
+ *   .scale("G#2:minor").sometimes(x => x.transpose("12 | 24"))
+ *   .K(() => {
+ *     const att = S(rand.range(0, 0.05))
+ *     const dec = S(rand.range(0.05, 0.2))
+ *     let f = n(sFreq);
+ *     const mod = sine(f).mul("0.1 | 0.2 | 0.3")
+ *       .add("[[1.5 1] | 1 | 2 | 4 | [6 4@3]]*2")
+ *     saw(f.mul(mod))
+ *     .mul(sGate.ad(att, dec))
+ *     .add(x => x.delay(0.4).mul(0.3))
+ *     .out()
+ *   }).fxr(1).room(0.3)
+ */
+/**
+ * Creates a worklet effect. Typically derived by writing K(...) in the REPL which will parse
+ * Kabelsalat code.
+ *
+ * @name worklet
+ * @param {string} src Source code of the worklet update function
+ * @param {...number | ...Pattern} inputs Worklet inputs
+ * @memberof Pattern
+ * @returns Pattern
+ * @noAutocomplete
+ */
+Pattern.prototype.worklet = function (src, ...inputs) {
+  inputs = inputs.map(reify);
+  return this.outerBind((v) => {
+    return _asArrayPattern(inputs).withValue((vInput) => {
+      const currInputs = v.workletInputs ?? [];
+      return { ...v, workletSrc: src, workletInputs: currInputs.concat(vInput) };
+    });
+  });
+};
+
+export const worklet = (...args) => pure({}).worklet(...args);