start splitting the documentation to include a new article about pitch

index.html

@@ -201,6 +201,7 @@
                   <div class="flex flex-col">
                     <p rel="noopener noreferrer" id="docs_audio_basics" class="doc_subheader">Playing a sound</p>
                     <p rel="noopener noreferrer" id="docs_amplitude" class="doc_subheader">Amplitude</p>
+                    <p rel="noopener noreferrer" id="docs_pitch" class="doc_subheader">Pitch</p>
                     <p rel="noopener noreferrer" id="docs_sampler" class="doc_subheader">Sampler</p>
                     <p rel="noopener noreferrer" id="docs_synths" class="doc_subheader">Synths</p>
                     <p rel="noopener noreferrer" id="docs_filters" class="doc_subheader">Filters</p>

package.json

@@ -22,6 +22,7 @@
     "@codemirror/theme-one-dark": "^6.1.2",
     "@replit/codemirror-vim": "^6.0.14",
     "@strudel.cycles/webaudio": "^0.8.2",
+    "@strudel/soundfonts": "^0.11.0",
     "@types/marked": "^5.0.1",
     "@types/showdown": "^2.0.1",
     "acorn": "^8.10.0",
@@ -38,7 +39,7 @@
     "postcss": "^8.4.27",
     "showdown": "^2.1.0",
     "showdown-highlight": "^3.1.0",
-    "superdough": "^0.9.12",
+    "superdough": "^0.10.0",
     "tailwind-highlightjs": "^2.0.1",
     "tailwindcss": "^3.3.3",
     "tone": "^14.8.49",

src/API.ts

@@ -27,6 +27,10 @@ import {
   soundMap,
   // @ts-ignore
 } from "superdough";
+import {
+  registerSoundfonts
+  // @ts-ignore
+} from "@strudel/soundfonts";
 import { Speaker } from "./extensions/StringExtensions";
 import { getScaleNotes } from "zifferjs";
 import { OscilloscopeConfig } from "./Visuals/Oscilloscope";
@@ -70,6 +74,7 @@ export async function loadSamples() {
     samples("github:Bubobubobubobubo/Dough-Waveforms/main", undefined, {
       tag: "Waveforms",
     }),
+    registerSoundfonts(),
   ]);
 }
 

src/Documentation.ts

@@ -3,6 +3,7 @@ import { type Editor } from "./main";
 import { introduction } from "./documentation/basics/welcome";
 import { loading_samples } from "./documentation/learning/samples/loading_samples";
 import { amplitude } from "./documentation/learning/audio_engine/amplitude";
+import { pitch } from "./documentation/learning/audio_engine/pitch";
 import { effects } from "./documentation/learning/audio_engine/effects";
 import { sampler } from "./documentation/learning/audio_engine/sampler";
 import { sample_banks } from "./documentation/learning/samples/sample_banks";
@@ -152,6 +153,7 @@ export const documentation_factory = (application: Editor) => {
     generators: generators(application),
     shortcuts: shortcuts(application),
     amplitude: amplitude(application),
+    pitch: pitch(application),
     effects: effects(application),
     sampler: sampler(application),
     mouse: mouse(application),
@@ -218,28 +220,28 @@ export const updateDocumentationContent = (app: Editor, bindings: any) => {
     moreStyling: true,
     backslashEscapesHTMLTags: true,
     extensions: [showdownHighlight({
-      pre: true, 
+      pre: true,
       auto_detection: false
     }), ...bindings],
   });
- 
+
-  if(Object.keys(app.docs).length === 0) {
+  if (Object.keys(app.docs).length === 0) {
     app.docs = documentation_factory(app);
   }
 
-  function _update_and_assign(callback: Function) { 
+  function _update_and_assign(callback: Function) {
     const converted_markdown = converter.makeHtml(
       app.docs[app.currentDocumentationPane],
     );
-     callback(converted_markdown)
+    callback(converted_markdown)
   }
-  _update_and_assign((e: string)=> { 
+  _update_and_assign((e: string) => {
     let display_content = e === undefined ? loading_message : e;
-    document.getElementById("documentation-content")!.innerHTML = display_content; 
+    document.getElementById("documentation-content")!.innerHTML = display_content;
   })
   if (document.getElementById("documentation-content")!.innerHTML.replace(/"/g, "'") == loading_message.replace(/"/g, "'")) {
     setTimeout(() => {
       updateDocumentationContent(app, bindings);
     }, 100);
   }
-}
+}

src/classes/SoundEvent.ts

@@ -80,7 +80,13 @@ export class SoundEvent extends AudibleEvent {
     fmrelease: ["fmrelease", "fmrel"],
     fmvelocity: ["fmvelocity", "fmvel"],
     fmwave: ["fmwave", "fmw"],
-    phaser: ["phaser", "phas"],
+    pattack: ["pattack", "patt"],
+    pdecay: ["pdecay", "pdec"],
+    psustain: ["psustain", "psus"],
+    prelease: ["prelease", "prel"],
+    penv: ["penv"],
+    pcurve: ["pcurve"],
+    panchor: ["panchor"],
     phaserDepth: ["phaserDepth", "phasdepth"],
     phaserSweep: ["phaserSweep", "phassweep"],
     phaserCenter: ["phaserCenter", "phascenter"],

src/documentation/learning/audio_engine/pitch.ts

@@ -0,0 +1,28 @@
+import { type Editor } from "../../../main";
+import { makeExampleFactory } from "../../../Documentation";
+
+export const pitch = (application: Editor): string => {
+  // @ts-ignore
+  const makeExample = makeExampleFactory(application);
+  return `# Pitch 
+
+
+## Pitch envelope
+	
+Similar to the amplitude envelope, you can use an envelope to shape the pitch
+of your sounds (can be samples or synthesizers). This is super useful to create
+new timbres out of existing sounds.
+	
+| Method  | Alias | Description                                   |
+|---------|-------|-----------------------------------------------|
+| <ic>pattack</ic>  | patt   | Attack time |
+| <ic>pdecay</ic>   | pdec   | Decay time |
+| <ic>psustain</ic> | psus   | Sustain value |
+| <ic>prelease</ic> | prel   | Release time |
+| <ic>penv</ic>    |       | Pitch envelope strength (positive or negative) |
+| <ic>panchor</ic>    |       | Envelope anchor range (0 - 1) |
+	
+Resume writing the pitch documentation here.
+
+`;
+};

yarn.lock

@@ -1461,6 +1461,31 @@
     "@strudel.cycles/core" "0.8.2"
     nanostores "^0.8.1"
 
+"@strudel/core@0.11.0":
+  version "0.11.0"
+  resolved "https://registry.yarnpkg.com/@strudel/core/-/core-0.11.0.tgz#65d18c513f04ab1020325be56044c34f255bc37b"
+  integrity sha512-7tOqsm13fsTOd9iPR7NybNN+QbkIyOR7JXpjIMRuQybkH15/NGOTAxNAbghKoesMU8/dLkR7/xVg231Ype3HMQ==
+  dependencies:
+    fraction.js "^4.3.7"
+
+"@strudel/soundfonts@^0.11.0":
+  version "0.11.0"
+  resolved "https://registry.yarnpkg.com/@strudel/soundfonts/-/soundfonts-0.11.0.tgz#1bfcb6885fad5c07e9e81855fecb59cf55cfd865"
+  integrity sha512-a60Jya1d78lxr6QkEhrbmStrY/H3OneCssuzepfxG7Az1INWuqeTgJ653GcLv9v6+kpdurwAf9SvfHzx9XgbHw==
+  dependencies:
+    "@strudel/core" "0.11.0"
+    "@strudel/webaudio" "0.11.0"
+    sfumato "^0.1.2"
+    soundfont2 "^0.4.0"
+
+"@strudel/webaudio@0.11.0":
+  version "0.11.0"
+  resolved "https://registry.yarnpkg.com/@strudel/webaudio/-/webaudio-0.11.0.tgz#1c595718c0bd72caec8e34ac2792ddde969e7ecf"
+  integrity sha512-Yqc/th969RREqmqtppXTDZKxIgKBsqEG1aJX9T8sTxvYcgGjCC3auH96TF9JtwfVE/VhTxwsxjZDiLcuXTJtCA==
+  dependencies:
+    "@strudel/core" "0.11.0"
+    superdough "0.10.0"
+
 "@surma/rollup-plugin-off-main-thread@^2.2.3":
   version "2.2.3"
   resolved "https://registry.yarnpkg.com/@surma/rollup-plugin-off-main-thread/-/rollup-plugin-off-main-thread-2.2.3.tgz#ee34985952ca21558ab0d952f00298ad2190c053"
@@ -2257,6 +2282,11 @@ fraction.js@^4.2.0:
   resolved "https://registry.yarnpkg.com/fraction.js/-/fraction.js-4.2.0.tgz#448e5109a313a3527f5a3ab2119ec4cf0e0e2950"
   integrity sha512-MhLuK+2gUcnZe8ZHlaaINnQLl0xRIGRfcGk2yl8xoQAfHrSsL3rYu6FCmBdkdbhc9EPlwyGHewaRsvwRMJtAlA==
 
+fraction.js@^4.3.7:
+  version "4.3.7"
+  resolved "https://registry.yarnpkg.com/fraction.js/-/fraction.js-4.3.7.tgz#06ca0085157e42fda7f9e726e79fefc4068840f7"
+  integrity sha512-ZsDfxO51wGAXREY55a7la9LScWpwv9RxIrYABrlvOFBlH/ShPnrtsXeuUIfXKKOVicNxQ+o8JTbJvjS4M89yew==
+
 front-matter@^4.0.0:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/front-matter/-/front-matter-4.0.2.tgz#b14e54dc745cfd7293484f3210d15ea4edd7f4d5"
@@ -2908,6 +2938,11 @@ nanostores@^0.8.1:
   resolved "https://registry.yarnpkg.com/nanostores/-/nanostores-0.8.1.tgz#963577028ac10eeb50bec376535f4762ab5af9be"
   integrity sha512-1ZCfQtII2XeFDrtqXL2cdQ/diGrLxzRB3YMyQjn8m7GSGQrJfGST2iuqMpWnS/ZlifhtjgR/SX0Jy6Uij6lRLA==
 
+nanostores@^0.9.5:
+  version "0.9.5"
+  resolved "https://registry.yarnpkg.com/nanostores/-/nanostores-0.9.5.tgz#4fcfce9786c4bf16e045a899cda2e46e90780a5b"
+  integrity sha512-Z+p+g8E7yzaWwOe5gEUB2Ox0rCEeXWYIZWmYvw/ajNYX8DlXdMvMDj8DWfM/subqPAcsf8l8Td4iAwO1DeIIRQ==
+
 node-addon-api@^5.0.0:
   version "5.1.0"
   resolved "https://registry.yarnpkg.com/node-addon-api/-/node-addon-api-5.1.0.tgz#49da1ca055e109a23d537e9de43c09cca21eb762"
@@ -3304,6 +3339,13 @@ set-function-name@^2.0.0:
     functions-have-names "^1.2.3"
     has-property-descriptors "^1.0.0"
 
+sfumato@^0.1.2:
+  version "0.1.2"
+  resolved "https://registry.yarnpkg.com/sfumato/-/sfumato-0.1.2.tgz#d24cd491456dc3b3e4a3237a457b800b681b4387"
+  integrity sha512-j2s5BLUS5VUNtaK1l+v+yal3XjjV7JXCQIwE5Xs4yiQ3HJ+2Fc/dd3IkkrVHn0AJO2epShSWVoP3GnE0TvPdMg==
+  dependencies:
+    soundfont2 "^0.4.0"
+
 showdown-highlight@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/showdown-highlight/-/showdown-highlight-3.1.0.tgz#c9ec902c35100e1ac3433761cdb655810120f1e5"
@@ -3334,6 +3376,11 @@ slip@1.0.2:
   resolved "https://registry.yarnpkg.com/slip/-/slip-1.0.2.tgz#ba45a923034d6cf41b1a27aebe7128282c8d551f"
   integrity sha512-XrcHe3NAcyD3wO+O4I13RcS4/3AF+S9RvGNj9JhJeS02HyImwD2E3QWLrmn9hBfL+fB6yapagwxRkeyYzhk98g==
 
+soundfont2@^0.4.0:
+  version "0.4.0"
+  resolved "https://registry.yarnpkg.com/soundfont2/-/soundfont2-0.4.0.tgz#a1efd642f2ae247a5530cd530ae364a095126be5"
+  integrity sha512-537WiurDBRbDLVhJMxXLE06D6yWxJCidfPClnibZ0f8dKMDpv+0fIfwCQ8pELE0JqKX05SOJosNJgKzQobaAEA==
+
 source-map-js@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.0.2.tgz#adbc361d9c62df380125e7f161f71c826f1e490c"
@@ -3460,12 +3507,12 @@ sucrase@^3.32.0:
     pirates "^4.0.1"
     ts-interface-checker "^0.1.9"
 
-superdough@^0.9.12:
+superdough@0.10.0, superdough@^0.10.0:
-  version "0.9.12"
+  version "0.10.0"
-  resolved "https://registry.yarnpkg.com/superdough/-/superdough-0.9.12.tgz#455f8860bc13cffbe1d8f391919e8f1dba1ff0b5"
+  resolved "https://registry.yarnpkg.com/superdough/-/superdough-0.10.0.tgz#06b027b16f54473f0281fcb0adcc1177d07d6e96"
-  integrity sha512-rsdCoYk5rLYster4tE5mSGjotf/TNP3gPpsuK4hxTZNxL92TkdEcbPFLnJfky5oMQJtpRY1XqAXUx3htLbHEZA==
+  integrity sha512-VMSUyKqTJumAd28I2rN5L8pTbzlp7Vsszri2BHlYipZ4vXO/B88cMjqtLqsCP4KaoARsput0kMXbpZ9JhjWbYQ==
   dependencies:
-    nanostores "^0.8.1"
+    nanostores "^0.9.5"
 
 supports-color@^5.3.0:
   version "5.5.0"