supersonic-scsynth 0.2.2 → 0.2.3

package/README.md

@@ -8,11 +8,11 @@ A WebAssembly port of SuperCollider's scsynth audio synthesis engine for the bro
 
 ```html
 <script type="module">
-  import { SuperSonic } from 'https://unpkg.com/supersonic-scsynth@latest';
+  import { SuperSonic } from './dist/supersonic.js';
 
   const sonic = new SuperSonic({
-    sampleBaseURL: 'https://unpkg.com/supersonic-scsynth-samples@latest/samples/',
-    synthdefBaseURL: 'https://unpkg.com/supersonic-scsynth-synthdefs@latest/synthdefs/'
+    sampleBaseURL: './dist/samples/',
+    synthdefBaseURL: './dist/synthdefs/'
   });
 
   await sonic.init();
@@ -29,11 +29,11 @@ A WebAssembly port of SuperCollider's scsynth audio synthesis engine for the bro
 </script>
 ```
 
-**Note:** Requires specific HTTP headers (COOP/COEP) for SharedArrayBuffer support. See [Browser Requirements](#browser-requirements) below.
+**Important:** SuperSonic requires self-hosting (cannot load from CDN). See [CDN Usage](#cdn-usage) below.
 
 ## Installation
 
-**Via npm:**
+**Via npm (for local bundling):**
 ```bash
 # Core engine only (~450KB)
 npm install supersonic-scsynth
@@ -42,15 +42,15 @@ npm install supersonic-scsynth
 npm install supersonic-scsynth-bundle
 ```
 
-**Via CDN:**
+**Pre-built distribution (recommended):**
+Download the pre-built package (~35MB with all synthdefs and samples) and serve from your own domain:
+https://samaaron.github.io/supersonic/supersonic-dist.zip
+
+Extract to your web server and import as:
 ```javascript
-import { SuperSonic } from 'https://unpkg.com/supersonic-scsynth@latest';
+import { SuperSonic } from './dist/supersonic.js';
 ```
 
-**Pre-built distribution:**
-Download the 'nightly' build (~35MB with all synthdefs and samples):
-https://samaaron.github.io/supersonic/supersonic-dist.zip
-
 ## Packages
 
 SuperSonic is split into multiple packages:
@@ -69,8 +69,8 @@ All synthdefs and samples are from [Sonic Pi](https://github.com/sonic-pi-net/so
 **Creating an instance:**
 ```javascript
 const sonic = new SuperSonic({
-  sampleBaseURL: 'https://unpkg.com/supersonic-scsynth-samples@latest/samples/',
-  synthdefBaseURL: 'https://unpkg.com/supersonic-scsynth-synthdefs@latest/synthdefs/',
+  sampleBaseURL: './dist/samples/',
+  synthdefBaseURL: './dist/synthdefs/',
   audioPathMap: { /* optional custom path mappings */ }
 });
 ```
@@ -121,6 +121,41 @@ Cross-Origin-Resource-Policy: cross-origin
 
 See `example/server.rb` for a reference implementation.
 
+## CDN Usage
+
+SuperSonic cannot be loaded from a CDN. The core library must be self-hosted on your domain.
+
+### Why Self-Hosting is Required
+
+SuperSonic uses `SharedArrayBuffer` for real-time audio performance. Browsers require workers that use `SharedArrayBuffer` to come from the same origin as the page. Even with proper COOP/COEP headers, cross-origin workers with shared memory are blocked. This is a fundamental browser security requirement stemming from Spectre attack mitigation.
+
+What this means:
+- You cannot use `import { SuperSonic } from 'https://unpkg.com/supersonic/...'`
+- You must download and self-host the core library on your own domain
+- The npm packages exist for convenience but must be bundled and deployed to your server
+
+### Synthdefs and Samples Can Use CDN
+
+Pre-compiled synthdefs and audio samples can be loaded from CDNs. They're just data files, not workers.
+
+```javascript
+// Self-hosted core library
+import { SuperSonic } from './dist/supersonic.js';
+
+// CDN-hosted synthdefs and samples work fine
+const sonic = new SuperSonic({
+  sampleBaseURL: 'https://unpkg.com/supersonic-scsynth-samples@0.1.6/samples/',
+  synthdefBaseURL: 'https://unpkg.com/supersonic-scsynth-synthdefs@0.1.6/synthdefs/'
+});
+
+await sonic.init();
+await sonic.loadSynthDefs(['sonic-pi-beep', 'sonic-pi-tb303']);
+```
+
+### Hybrid Approach
+
+Self-host the SuperSonic core (JS, WASM, workers) with COOP/COEP headers. Use CDN for synthdefs and samples to save bandwidth. See `example/simple-cdn.html` for a working example.
+
 ## Building from Source
 
 **Prerequisites:**

package/dist/supersonic.js

@@ -2324,7 +2324,7 @@ var SuperSonic = class _SuperSonic {
     }
     if (!this.sampleBaseURL) {
       throw new Error(
-        'sampleBaseURL not configured. Please set it in SuperSonic constructor options.\nExample: new SuperSonic({ sampleBaseURL: "https://unpkg.com/supersonic-scsynth-samples@latest/samples/" })\nOr install sample packages: npm install supersonic-scsynth-samples'
+        'sampleBaseURL not configured. Please set it in SuperSonic constructor options.\nExample: new SuperSonic({ sampleBaseURL: "./dist/samples/" })\nOr use CDN: new SuperSonic({ sampleBaseURL: "https://unpkg.com/supersonic-scsynth-samples@latest/samples/" })\nOr install: npm install supersonic-scsynth-samples'
       );
     }
     return this.sampleBaseURL + scPath;
@@ -2525,7 +2525,7 @@ var SuperSonic = class _SuperSonic {
     }
     if (!this.synthdefBaseURL) {
       throw new Error(
-        'synthdefBaseURL not configured. Please set it in SuperSonic constructor options.\nExample: new SuperSonic({ synthdefBaseURL: "https://unpkg.com/supersonic-scsynth-synthdefs@latest/synthdefs/" })\nOr install: npm install supersonic-scsynth-synthdefs'
+        'synthdefBaseURL not configured. Please set it in SuperSonic constructor options.\nExample: new SuperSonic({ synthdefBaseURL: "./dist/synthdefs/" })\nOr use CDN: new SuperSonic({ synthdefBaseURL: "https://unpkg.com/supersonic-scsynth-synthdefs@latest/synthdefs/" })\nOr install: npm install supersonic-scsynth-synthdefs'
       );
     }
     const results = {};

package/dist/wasm/manifest.json

@@ -1,6 +1,6 @@
 {
   "wasmFile": "scsynth-nrt.wasm",
-  "buildId": "20251114-221419",
-  "buildTime": "2025-11-14T22:14:19Z",
-  "gitHash": "cfd4b75"
+  "buildId": "20251115-234621",
+  "buildTime": "2025-11-15T23:46:21Z",
+  "gitHash": "ec0ed48"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "supersonic-scsynth",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "SuperCollider scsynth WebAssembly port for AudioWorklet - Run SuperCollider synthesis in the browser",
   "main": "dist/supersonic.js",
   "unpkg": "dist/supersonic.js",