Merge pull request 'simplify osc usage' (#1588) from osc-server-via-npx into main

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

packages/osc/README.md

@@ -4,36 +4,35 @@ OSC output for strudel patterns! Currently only tested with super collider / sup
 
 ## Usage
 
-OSC will only work if you run the REPL locally + the OSC server besides it:
+Assuming you have [node.js](https://nodejs.org/) installed, you can run the osc bridge server via:
 
-From the project root:
-
-```js
-npm run repl
+```sh
+npx @strudel/osc
 ```
 
-and in a seperate shell:
-
-```js
-npm run osc
-```
-
-This should give you
+You should see something like:
 
 ```log
 osc client running on port 57120
-osc server running on port 57121
+osc server running on port 7771
 websocket server running on port 8080
 ```
 
-Now open Supercollider (with the super dirt startup file)
+By default it will use port 57120 for the osc client, which is what [superdirt](https://github.com/musikinformatik/SuperDirt) uses. You can change it via the `--port` option:
 
-Now open the REPL and type:
-
-```js
-s("<bd sd> hh").osc()
+```sh
+npx @strudel/osc --port 7771 # classic dirt
 ```
 
-or just [click here](https://strudel.cc/#cygiPGJkIHNkPiBoaCIpLm9zYygp)...
+To test it in strudel, you have can use `all(osc)` to send all events through osc:
+
+```js
+$: s("bd*4")
+
+all(osc)
+```
+
+
+[open in repl](hhttps://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)

packages/osc/osc.mjs

@@ -6,7 +6,7 @@ This program is free software: you can redistribute it and/or modify it under th
 
 import OSC from 'osc-js';
 
-import { logger, parseNumeral, Pattern, isNote, noteToMidi, ClockCollator } from '@strudel/core';
+import { logger, parseNumeral, register, isNote, noteToMidi, ClockCollator } from '@strudel/core';
 
 let connection; // Promise<OSC>
 function connect() {
@@ -81,6 +81,4 @@ export async function oscTrigger(hap, currentTime, cps = 1, targetTime) {
  * @memberof Pattern
  * @returns Pattern
  */
-Pattern.prototype.osc = function () {
-  return this.onTrigger(oscTrigger);
-};
+export const osc = register('osc', (pat) => pat.onTrigger(oscTrigger));

packages/osc/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@strudel/osc",
-  "version": "1.2.4",
+  "version": "1.2.8",
   "description": "OSC messaging for strudel",
   "main": "osc.mjs",
+  "bin": "./server.js",
   "type": "module",
   "publishConfig": {
     "main": "dist/index.mjs"

packages/osc/server.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 /*
 server.js - <short description TODO>
 Copyright (C) 2022 Strudel contributors - see <https://codeberg.org/uzu/strudel/src/branch/main/packages/osc/server.js>
@@ -6,6 +8,19 @@ This program is free software: you can redistribute it and/or modify it under th
 
 import OSC from 'osc-js';
 
+const args = process.argv.slice(2);
+function getArgValue(flag) {
+  const i = args.indexOf(flag);
+  if (i !== -1) {
+    const nextIsFlag = args[i + 1]?.startsWith('--') ?? true;
+    if (nextIsFlag) return true;
+    return args[i + 1];
+  }
+}
+
+let udpClientPort = Number(getArgValue('--port')) || 57120;
+// dirt = 7771
+
 const config = {
   receiver: 'ws', // @param {string} Where messages sent via 'send' method will be delivered to, 'ws' for Websocket clients, 'udp' for udp client
   udpServer: {
@@ -17,7 +32,7 @@ const config = {
   },
   udpClient: {
     host: 'localhost', // @param {string} Hostname of udp client for messaging
-    port: 57120, // @param {number} Port of udp client for messaging
+    port: udpClientPort, // @param {number} Port of udp client for messaging
   },
   wsServer: {
     host: 'localhost', // @param {string} Hostname of WebSocket server