bump @jwetzell/osc version to 1.0.0

fromBuffer methods should return any unprocessed results

.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  env: {
+    node: true,
+    commonjs: true,
+    es2021: true,
+  },
+  extends: ['airbnb', 'prettier'],
+  parserOptions: {
+    ecmaVersion: 'latest',
+  },
+  ignorePatterns: ['**/node_modules', '**/dist'],
+};

.github/workflows/check-makeosc-build.yml

@@ -1,8 +1,10 @@
-name: Check osc-js builds
+name: Check makeosc builds
 on:
   pull_request:
     branches:
       - main
+    paths:
+      - 'apps/makeosc/**'
 jobs:
   build-webui:
     runs-on: ubuntu-latest
@@ -18,6 +20,6 @@ jobs:
           cache-dependency-path: 'package-lock.json'
 
       - name: Install Node.js dependencies
-        run: npm ci
+        run: npm ci --workspace makeosc
 
-      - run: npm run build
+      - run: npm run build --workspace makeosc

.github/workflows/check-osc-build.yml

@@ -0,0 +1,25 @@
+name: Check @jwetzell/osc builds
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'packages/osc/**'
+jobs:
+  build-webui:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      - name: Set up Node.js
+        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+          cache-dependency-path: 'package-lock.json'
+
+      - name: Install Node.js dependencies
+        run: npm ci --workspace @jwetzell/osc
+
+      - run: npm run build --workspace @jwetzell/osc

.github/workflows/check-readosc-build.yml

@@ -0,0 +1,25 @@
+name: Check readosc builds
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'apps/readosc/**'
+jobs:
+  build-webui:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      - name: Set up Node.js
+        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+          cache-dependency-path: 'package-lock.json'
+
+      - name: Install Node.js dependencies
+        run: npm ci --workspace readosc
+
+      - run: npm run build --workspace readosc

.github/workflows/check-sendosc-build.yml

@@ -0,0 +1,25 @@
+name: Check sendosc builds
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'apps/sendosc/**'
+jobs:
+  build-webui:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      - name: Set up Node.js
+        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+          cache-dependency-path: 'package-lock.json'
+
+      - name: Install Node.js dependencies
+        run: npm ci --workspace sendosc
+
+      - run: npm run build --workspace sendosc

.github/workflows/publish-makeosc.yml

@@ -0,0 +1,24 @@
+name: Publish makeosc to npmjs
+on:
+  push:
+    tags:
+      - 'makeosc/*'
+jobs:
+  publish:
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+          cache-dependency-path: './package-lock.json'
+      - name: Install Node.js dependencies
+        run: npm ci --workspace=makeosc
+      - name: Publish to NPM
+        run: npm publish --provenance --access=public --workspace=makeosc
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish-osc-npm.yml

@@ -1,6 +1,8 @@
-name: Publish to npmjs
+name: Publish @jwetzell/osc to npmjs
 on:
-  release:
+  push:
+    tags:
+      - 'osc/*'
 jobs:
   publish-lib:
     permissions:
@@ -16,9 +18,9 @@ jobs:
           cache-dependency-path: 'package-lock.json'
 
       - name: Install Node.js dependencies
-        run: npm ci
+        run: npm ci --workspace @jwetzell/osc
 
       - name: Publish to NPM
-        run: npm publish --provenance --access=public
+        run: npm publish --provenance --access=public --workspace @jwetzell/osc
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish-readosc.yml

@@ -0,0 +1,24 @@
+name: Publish readosc to npmjs
+on:
+  push:
+    tags:
+      - 'readosc/*'
+jobs:
+  publish:
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+          cache-dependency-path: './package-lock.json'
+      - name: Install Node.js dependencies
+        run: npm ci --workspace=readosc
+      - name: Publish to NPM
+        run: npm publish --provenance --access=public --workspace=readosc
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish-sendosc.yml

@@ -0,0 +1,24 @@
+name: Publish sendosc to npmjs
+on:
+  push:
+    tags:
+      - 'sendosc/*'
+jobs:
+  publish:
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+          cache-dependency-path: './package-lock.json'
+      - name: Install Node.js dependencies
+        run: npm ci --workspace=sendosc
+      - name: Publish to NPM
+        run: npm publish --provenance --access=public --workspace=sendosc
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/run-osc-tests.yml

@@ -1,8 +1,10 @@
-name: Run tests
+name: Run @jwetzell/osc tests
 on:
   pull_request:
     branches:
       - main
+    paths:
+      - 'packages/osc/**'
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -18,6 +20,6 @@ jobs:
           cache-dependency-path: './package-lock.json'
 
       - name: Install Node.js dependencies
-        run: npm ci
+        run: npm ci --workspace @jwetzell/osc
 
-      - run: npm run test
+      - run: npm run test --workspace @jwetzell/osc

.gitignore

@@ -1,2 +1 @@
-node_modules
-dist
+node_modules

.prettierignore

@@ -1,2 +1,3 @@
 *.md
-*.min.*
+*.min.*
+dist

README.md

@@ -0,0 +1,5 @@
+# osc-js
+Collection of OSC things written in JS/TS
+
+- [osc encoding/decoding library](./packages/osc/)
+- [cli for sending osc messages](./apps/sendosc/)

apps/makeosc/.gitignore

@@ -0,0 +1 @@
+dist

apps/makeosc/README.md

@@ -0,0 +1,41 @@
+![npm](https://img.shields.io/npm/v/makeosc)
+
+# makeosc
+
+Simple NodeJS script for generating OSC bytes output to stdout.
+
+## Usage
+
+```
+Usage: makeosc [options]
+
+simple util to make osc buffers
+
+Options:
+  -V, --version        output the version number
+  --address <address>  OSC address
+  --args <args...>     osc args (default: [])
+  --slip               slip encode message (default: false)
+  --types <types...>   osc arg types (choices: "s", "i", "f", "b", default: [])
+  -h, --help           display help for command
+```
+
+- using npx `npx makeosc@latest --address /hello`
+- install using `npm install -g makeosc@latest` and run `makeosc --address /hello`
+
+## Notes
+
+- `--types` option is a space seperate list of type characters that will determine what the corresponding argument type will be set to
+  - optional
+  - uses type codes from the OSC spec
+- `--args` option is a space-separated list of arguments. If a corresponding type is not found in the `--types` option it will default to string (`s`).
+  - blobs (`b`) are to be entered as hex string representing the buffer to be sent so the ASCII string `hello` would be `68656c6c6f`
+- the default protocol is UDP but can be changed to TCP using the `--protocol` flag
+
+## Examples
+
+- `makeosc --address /test --args 1.0`
+- `makeosc --address /this/is/sent/via/tcp`
+- `makeosc --address /test/with/types --args 1 2.0 three --types i f`
+  - note that `types` is not the same length as `args` so the remaining argument (`three`) will default to string
+- `makeosc --address /blob --args 68656c6c6f --types b`

apps/makeosc/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "makeosc",
+  "version": "0.1.0",
+  "description": "Simple NodeJS utility for generating osc buffers",
+  "main": "src/main.js",
+  "bin": {
+    "makeosc": "src/main.js"
+  },
+  "files": [
+    "src/"
+  ],
+  "author": {
+    "name": "Joel Wetzell",
+    "email": "me@jwetzell.com",
+    "url": "https://jwetzell.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jwetzell/osc-js.git"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@jwetzell/osc": "0.2.2",
+    "commander": "^11.0.0",
+    "slip": "^1.0.2"
+  }
+}

apps/makeosc/src/main.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+
+const { Option, program } = require('commander');
+const slip = require('slip');
+const { argToTypedArg } = require('./utils');
+const osc = require('@jwetzell/osc');
+const packageInfo = require('../package.json');
+
+program.name(packageInfo.name);
+program.version(packageInfo.version);
+program.description('simple util to make osc buffers');
+program.addOption(new Option('--address <address>', 'OSC address').makeOptionMandatory());
+program.addOption(new Option('--args <args...>', 'osc args').default([]));
+program.addOption(new Option('--slip', 'slip encode message').default(false));
+program.addOption(new Option('--types <types...>', 'osc arg types').choices(['s', 'i', 'f', 'b']).default([]));
+program.addOption(
+  new Option('-f --format <format>', 'output format').choices(['bytes', 'json', 'f', 'b']).default('bytes')
+);
+program.action((options) => {
+  const { address, args, types, format } = options;
+
+  const typedArgs = args?.map((rawArg, index) => {
+    const argType = types[index] || 's';
+
+    return {
+      type: argType,
+      value: argToTypedArg(rawArg, argType),
+    };
+  });
+
+  const oscMsg = {
+    address,
+    args: typedArgs,
+  };
+
+  if (format === 'json') {
+    process.stdout.write(JSON.stringify(oscMsg));
+  } else if (format === 'bytes') {
+    let oscMsgBuffer = osc.messageToBuffer(oscMsg);
+    if (options.slip) {
+      oscMsgBuffer = slip.encode(oscMsgBuffer);
+    }
+    process.stdout.write(oscMsgBuffer);
+  }
+});
+program.parse();
+
+process.stdout.on('error', (err) => {
+  if (err.code === 'EPIPE') {
+    process.exit(0);
+  }
+});

apps/makeosc/src/utils.js

@@ -0,0 +1,31 @@
+const oscTypeConverterMap = {
+  s: {
+    fromString: (string) => string,
+  },
+  f: {
+    fromString: (string) => Number.parseFloat(string),
+  },
+  i: {
+    fromString: (string) => Number.parseInt(string, 10),
+  },
+  b: {
+    fromString: (string) => Buffer.from(string, 'hex'),
+  },
+};
+
+function argToTypedArg(rawArg, type = 's') {
+  const typeConverter = oscTypeConverterMap[type];
+  if (typeConverter === undefined) {
+    throw new Error('osc type error: unknown type '.concat(type));
+  }
+
+  if (typeConverter.fromString === undefined) {
+    throw new Error('osc type error: no string converter for type '.concat(type));
+  }
+
+  return typeConverter.fromString(rawArg);
+}
+
+module.exports = {
+  argToTypedArg,
+};

apps/readosc/.gitignore

@@ -0,0 +1 @@
+dist

apps/readosc/README.md

@@ -0,0 +1,20 @@
+![npm](https://img.shields.io/npm/v/readosc)
+
+# readosc
+
+Simple NodeJS script for parsing OSC bytes from stdin.
+
+## Usage
+
+```
+Usage: readosc [options]
+
+simple util to read osc packets from stdin
+
+Options:
+  -V, --version  output the version number
+  -h, --help     display help for command
+```
+
+- using npx `npx readosc@latest`
+- install using `npm install -g readosc@latest` and run `readosc`

apps/readosc/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "readosc",
+  "version": "0.1.0",
+  "description": "Simple NodeJS utility for parsing osc buffers from stdin",
+  "main": "src/main.js",
+  "bin": {
+    "readosc": "src/main.js"
+  },
+  "files": [
+    "src/"
+  ],
+  "author": {
+    "name": "Joel Wetzell",
+    "email": "me@jwetzell.com",
+    "url": "https://jwetzell.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jwetzell/osc-js.git"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@jwetzell/osc": "0.2.2",
+    "commander": "^11.0.0"
+  }
+}

apps/readosc/src/main.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const osc = require('@jwetzell/osc');
+const packageInfo = require('../package.json');
+
+program.name(packageInfo.name);
+program.version(packageInfo.version);
+program.description('simple util to read osc packets from stdin');
+program.action(() => {
+  process.stdin.on('data', (data) => {
+    try {
+      const message = osc.messageFromBuffer(data);
+      console.log(JSON.stringify(message));
+    } catch (error) {
+      console.error({ error: error.toString() });
+    }
+  });
+});
+program.parse();

apps/sendosc/.gitignore

@@ -0,0 +1 @@
+dist

apps/sendosc/README.md

@@ -0,0 +1,44 @@
+![npm](https://img.shields.io/npm/v/sendosc)
+
+# sendosc
+
+Simple NodeJS script for sending OSC via TCP or UDP originally inspired by this [c++ utility](https://github.com/yoggy/sendosc) of the same name.
+
+## Usage
+
+```
+Usage: sendosc [options]
+
+simple util to sendosc
+
+Options:
+  -V, --version          output the version number
+  --protocol <protocol>  Network protocol (choices: "tcp", "udp", default: "udp")
+  --host <host>          the host to send osc to
+  --port <port>          the port to send osc to
+  --address <address>    OSC address
+  --args <args...>       osc args (default: [])
+  --slip                 slip encode message (default: false)
+  --types <types...>     osc arg types (choices: "s", "i", "f", "b", default: [])
+  -h, --help             display help for command
+```
+
+- using npx `npx sendosc@latest --host 127.0.0.1 --port 9999 --address /hello`
+- install using `npm install -g sendosc@latest` and run `sendosc --host 127.0.0.1 --port 9999 --address /hello`
+
+## Notes
+
+- `--types` option is a space seperate list of type characters that will determine what the corresponding argument type will be set to
+  - optional
+  - uses type codes from the OSC spec
+- `--args` option is a space-separated list of arguments. If a corresponding type is not found in the `--types` option it will default to string (`s`).
+  - blobs (`b`) are to be entered as hex string representing the buffer to be sent so the ASCII string `hello` would be `68656c6c6f`
+- the default protocol is UDP but can be changed to TCP using the `--protocol` flag
+
+## Examples
+
+- `sendosc --host 127.0.0.1 --port 8000 --address /test --args 1.0`
+- `sendosc --protocol tcp --host 127.0.0.1 --port 8000 --address /this/is/sent/via/tcp`
+- `sendosc --host 127.0.0.1 --port 8000 --address /test/with/types --args 1 2.0 three --types i f`
+  - note that `types` is not the same length as `args` so the remaining argument (`three`) will default to string
+- `sendosc --host 127.0.0.1 --port 8000 --address /blob --args 68656c6c6f --types b`

apps/sendosc/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "sendosc",
+  "version": "1.0.1",
+  "description": "Simple NodeJS utility for sending osc",
+  "main": "src/main.js",
+  "bin": {
+    "sendosc": "src/main.js"
+  },
+  "files": [
+    "src/"
+  ],
+  "author": {
+    "name": "Joel Wetzell",
+    "email": "me@jwetzell.com",
+    "url": "https://jwetzell.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jwetzell/osc-js.git"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@jwetzell/osc": "0.2.2",
+    "commander": "^11.0.0",
+    "slip": "^1.0.2"
+  }
+}

apps/sendosc/src/main.js

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+
+const { Option, program } = require('commander');
+const dgram = require('dgram');
+const net = require('net');
+const slip = require('slip');
+const osc = require('@jwetzell/osc');
+const { argToTypedArg } = require('./utils');
+const packageInfo = require('../package.json');
+
+program.name(packageInfo.name);
+program.version(packageInfo.version);
+program.description('simple util to sendosc');
+program.addOption(new Option('--protocol <protocol>', 'Network protocol').choices(['tcp', 'udp']).default('udp'));
+program.addOption(new Option('--host <host>', 'the host to send osc to').makeOptionMandatory());
+program.addOption(new Option('--port <port>', 'the port to send osc to').makeOptionMandatory());
+program.addOption(new Option('--address <address>', 'OSC address').makeOptionMandatory());
+program.addOption(new Option('--args <args...>', 'osc args').default([]));
+program.addOption(new Option('--slip', 'slip encode message').default(false));
+program.addOption(new Option('--types <types...>', 'osc arg types').choices(['s', 'i', 'f', 'b']).default([]));
+program.action((options) => {
+  const { host, port, address, args, types } = options;
+
+  const typedArgs = args?.map((rawArg, index) => {
+    const argType = types[index] || 's';
+
+    return {
+      type: argType,
+      value: argToTypedArg(rawArg, argType),
+    };
+  });
+
+  let oscMsgBuffer = osc.messageToBuffer({
+    address,
+    args: typedArgs,
+  });
+
+  if (options.slip) {
+    oscMsgBuffer = slip.encode(oscMsgBuffer);
+  }
+
+  if (options.protocol === 'tcp') {
+    const client = net.Socket();
+    client.on('error', (error) => {
+      console.error(error);
+    });
+    client.connect(port, host, () => {
+      client.write(oscMsgBuffer, () => {
+        client.destroy();
+      });
+    });
+  } else if (options.protocol === 'udp') {
+    const client = dgram.createSocket('udp4');
+    client.send(oscMsgBuffer, port, host, (error) => {
+      if (error) {
+        console.error(error);
+      }
+      client.close();
+    });
+  }
+});
+program.parse();

apps/sendosc/src/utils.js

@@ -0,0 +1,31 @@
+const oscTypeConverterMap = {
+  s: {
+    fromString: (string) => string,
+  },
+  f: {
+    fromString: (string) => Number.parseFloat(string),
+  },
+  i: {
+    fromString: (string) => Number.parseInt(string, 10),
+  },
+  b: {
+    fromString: (string) => Buffer.from(string, 'hex'),
+  },
+};
+
+function argToTypedArg(rawArg, type = 's') {
+  const typeConverter = oscTypeConverterMap[type];
+  if (typeConverter === undefined) {
+    throw new Error('osc type error: unknown type '.concat(type));
+  }
+
+  if (typeConverter.fromString === undefined) {
+    throw new Error('osc type error: no string converter for type '.concat(type));
+  }
+
+  return typeConverter.fromString(rawArg);
+}
+
+module.exports = {
+  argToTypedArg,
+};

package.json

@@ -1,30 +1,29 @@
 {
-  "name": "@jwetzell/osc",
-  "version": "0.2.0",
-  "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.js",
-  "scripts": {
-    "prebuild": "rimraf dist",
-    "build": "tsc",
-    "prepublishOnly": "npm run build",
-    "pretest": "npm run build",
-    "test": "node --test --experimental-test-coverage"
-  },
-  "files": [
-    "dist"
-  ],
+  "name": "osc",
+  "version": "0.0.0",
+  "private": true,
   "author": {
     "name": "Joel Wetzell",
     "email": "me@jwetzell.com",
     "url": "https://jwetzell.com"
   },
-  "repository": "https://github.com/jwetzell/osc-js",
-  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jwetzell/osc-js.git"
+  },
+  "scripts": {
+    "lint:check": "eslint ./",
+    "format:check": "prettier ./ --check",
+    "format:write": "prettier ./ --write"
+  },
+  "workspaces": [
+    "apps/*",
+    "packages/*"
+  ],
   "devDependencies": {
-    "@types/node": "22.7.4",
     "prettier": "3.3.3",
-    "rimraf": "6.0.1",
-    "typescript": "5.6.2"
+    "eslint": "^8.48.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^9.0.0"
   }
 }

packages/osc/.gitignore

@@ -0,0 +1 @@
+dist

packages/osc/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@jwetzell/osc",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "pretest": "npm run build",
+    "test": "node --test --experimental-test-coverage"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": {
+    "name": "Joel Wetzell",
+    "email": "me@jwetzell.com",
+    "url": "https://jwetzell.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jwetzell/osc-js.git"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "22.7.4",
+    "rimraf": "6.0.1",
+    "typescript": "5.6.2"
+  }
+}

packages/osc/src/bundle.ts

@@ -0,0 +1,107 @@
+import { messageFromBuffer, messageToBuffer } from './message';
+import { OSCBundle } from './models';
+import { oscTypeConverterMap } from './osc-types';
+
+export function bundleFromBuffer(bytes: Uint8Array): [OSCBundle | undefined, Uint8Array | undefined] {
+  if (bytes.length < 8) {
+    throw new Error('bundle has to be at least 20 bytes');
+  }
+
+  if (new TextDecoder().decode(bytes.subarray(0, 7)) !== '#bundle') {
+    throw new Error('bundle must start with #bundle');
+  }
+
+  const [bundleHeader, bytesAfterHeader] = oscTypeConverterMap.s.fromBuffer(bytes);
+  let [timeTag, bytesAfterTimeTag] = oscTypeConverterMap.t.fromBuffer(bytesAfterHeader);
+
+  if (!Array.isArray(timeTag)) {
+    throw new Error('problem getting bundle time tag');
+  }
+
+  const bundleContents = [];
+
+  let endOfBundle = false;
+
+  let [contentSize, remainingBytes] = oscTypeConverterMap.i.fromBuffer(bytesAfterTimeTag);
+  if (typeof contentSize === 'number') {
+    while (!endOfBundle) {
+      if (remainingBytes.length < contentSize) {
+        throw new Error('bundle does not contain enough data');
+      }
+
+      const bundleContentBytes = remainingBytes.subarray(0, contentSize);
+
+      if (bundleContentBytes[0] === 35) {
+        // # character indicating contents is a bundle
+        const [content, bytesAfterContent] = bundleFromBuffer(bundleContentBytes);
+        if (content) {
+          bundleContents.push(content);
+        }
+      } else if (bundleContentBytes[0] === 47) {
+        const [content, bytesAfterContent] = messageFromBuffer(bundleContentBytes);
+        if (content && content !== undefined) {
+          bundleContents.push(content);
+        }
+      } else {
+        throw new Error('bundle contents does not look like a OSC message or bundle');
+      }
+
+      remainingBytes = remainingBytes.subarray(contentSize);
+      if (remainingBytes.length === 0) {
+        endOfBundle = true;
+      }
+    }
+    return [{
+      timeTag,
+      contents: bundleContents,
+    },remainingBytes];
+  }
+
+  return [undefined, undefined]
+}
+
+export function bundleToBuffer(bundle: OSCBundle): Uint8Array {
+  const headerBuffer = oscTypeConverterMap.s.toBuffer('#bundle');
+
+  if (headerBuffer === undefined) {
+    throw new Error('problem encoding buffer header');
+  }
+
+  const timeTagBuffer = oscTypeConverterMap.t.toBuffer(bundle.timeTag);
+
+  if (timeTagBuffer === undefined) {
+    throw new Error('problem encoding buffer time tag');
+  }
+
+  const contentsBuffers: Uint8Array[] = [];
+
+  let contentsBuffersTotalLength = 0;
+
+  bundle.contents.forEach((bundleContent) => {
+    if ('address' in bundleContent) {
+      const contentBuffer = messageToBuffer(bundleContent);
+      const contentSizeBuffer = oscTypeConverterMap.i.toBuffer(contentBuffer.length);
+
+      if (contentBuffer && contentSizeBuffer) {
+        const buffer = new Uint8Array(contentSizeBuffer.length + contentBuffer.length);
+        buffer.set(contentSizeBuffer, 0);
+        buffer.set(contentBuffer, contentSizeBuffer.length);
+        contentsBuffers.push(buffer);
+        contentsBuffersTotalLength += buffer.length;
+      }
+    }
+  });
+
+  const buffer = new Uint8Array(headerBuffer.length + timeTagBuffer.length + contentsBuffersTotalLength);
+  let offset = 0;
+  buffer.set(headerBuffer, offset);
+  offset += headerBuffer.length;
+  buffer.set(timeTagBuffer, offset);
+  offset += timeTagBuffer.length;
+  contentsBuffers.forEach((contentBuffer) => {
+    buffer.set(contentBuffer, offset);
+    offset += contentBuffer.length;
+  });
+
+  return buffer;
+}

packages/osc/src/index.ts

@@ -0,0 +1,3 @@
+export * from './models';
+export * from './message';
+export * from './bundle';

packages/osc/src/message.ts

@@ -0,0 +1,88 @@
+import { OSCMessage, OSCArg, OSCType } from './models';
+import { oscTypeConverterMap } from './osc-types';
+
+function argsToBuffer(args: OSCArg[]) {
+  const argBuffers: Uint8Array[] = [];
+  let argBuffersTotalLength = 0;
+
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index];
+    const typeConverter = oscTypeConverterMap[arg.type];
+    if (typeConverter === undefined) {
+      throw new TypeError('unknown type '.concat(arg.type));
+    }
+
+    const buffer = typeConverter.toBuffer(arg.value);
+    if (buffer !== undefined) {
+      argBuffers.push(buffer);
+      argBuffersTotalLength += buffer.length;
+    }
+  }
+  const buffer = new Uint8Array(argBuffersTotalLength);
+  let offset = 0;
+  argBuffers.forEach((argBuffer) => {
+    buffer.set(argBuffer, offset);
+    offset += argBuffer.length;
+  });
+  return buffer;
+}
+
+export function messageToBuffer(message: OSCMessage): Uint8Array {
+  const addressBuffer = oscTypeConverterMap.s.toBuffer(message.address);
+  if (addressBuffer === undefined) {
+    throw new Error('problem encoding address');
+  }
+
+  const typeString = message.args.map((arg) => arg.type).join('');
+  const typesBuffer = oscTypeConverterMap.s.toBuffer(`,${typeString}`);
+  if (typesBuffer === undefined) {
+    throw new Error('problem encoding types');
+  }
+  const argsBuffer = argsToBuffer(message.args);
+  const buffer = new Uint8Array(addressBuffer.length + typesBuffer.length + argsBuffer.length);
+  buffer.set(addressBuffer, 0);
+  buffer.set(typesBuffer, addressBuffer.length);
+  buffer.set(argsBuffer, addressBuffer.length + typesBuffer.length);
+  return buffer;
+}
+
+export function messageFromBuffer(bytes: Uint8Array): [OSCMessage | undefined, Uint8Array | undefined] {
+  if (bytes[0] !== 47) {
+    throw new Error('osc message must start with a /');
+  }
+
+  const oscArgs: OSCArg[] = [];
+
+  const [address, bytesAfterAddress] = oscTypeConverterMap.s.fromBuffer(bytes);
+  if (typeof address === 'string') {
+    let [typeString, bytesAfterType] = oscTypeConverterMap.s.fromBuffer(bytesAfterAddress);
+    if (typeof typeString === 'string') {
+      if (!typeString.startsWith(',')) {
+        throw new Error('osc type string must start with a ,');
+      }
+      let argsBuffer = bytesAfterType;
+      for (let index = 1; index < typeString.length; index++) {
+        const argType = typeString.charAt(index) as OSCType;
+
+        const oscTypeConverter = oscTypeConverterMap[argType];
+        if (oscTypeConverter === undefined) {
+          throw new Error('unknown OSC type');
+        }
+        const [value, remainingBytes] = oscTypeConverter.fromBuffer(argsBuffer);
+        if (value !== undefined) {
+          const arg: OSCArg = {
+            type: argType,
+            value: value,
+          };
+          oscArgs.push(arg);
+        }
+        argsBuffer = remainingBytes;
+      }
+      return [{
+        address,
+        args: oscArgs,
+      }, argsBuffer];
+    }
+  }
+  return [undefined, undefined]
+}

packages/osc/src/models.ts

@@ -1,7 +1,7 @@
 export type OSCType = 's' | 'i' | 'f' | 'b' | 'T' | 'F' | 't';
 export type OSCArg = {
   type: OSCType;
-  value: string | number | Buffer | boolean | OSCTimeTag;
+  value: string | number | Uint8Array | boolean | OSCTimeTag;
 };
 
 export type OSCTimeTag = [number, number];
@@ -17,6 +17,6 @@ export type OSCMessage = {
 };
 
 export type OSCTypeConverter = {
-  toBuffer: (value: string | number | Buffer | boolean | OSCTimeTag) => Buffer | undefined;
-  fromBuffer: (buffer: Buffer) => [string | number | Buffer | boolean | OSCTimeTag | undefined, Buffer];
+  toBuffer: (value: string | number | Uint8Array | boolean | OSCTimeTag) => Uint8Array | undefined;
+  fromBuffer: (buffer: Uint8Array) => [string | number | Uint8Array | boolean | OSCTimeTag | undefined, Uint8Array];
 };

packages/osc/src/osc-types.ts

@@ -0,0 +1,174 @@
+import { OSCTypeConverter, OSCTimeTag } from './models';
+
+export const oscTypeConverterMap: { [key: string]: OSCTypeConverter } = {
+  s: {
+    toBuffer: (string) => {
+      if (typeof string === 'string') {
+        let oscString = `${string}\u0000`;
+        const padSize = 4 - (oscString.length % 4);
+        if (padSize < 4) {
+          oscString = oscString.padEnd(oscString.length + padSize, '\u0000');
+        }
+        return new TextEncoder().encode(oscString);
+      }
+      throw new TypeError('osc type s toBuffer called with non string value');
+    },
+    fromBuffer: (bytes) => {
+      let stringEnd = 0;
+      let stringPaddingEnd = 0;
+      for (let index = 0; index < bytes.length; index++) {
+        if (bytes[index] === 0) {
+          stringEnd = index;
+          stringPaddingEnd = index + 1;
+          const stringPadding = 4 - ((stringEnd + 1) % 4);
+
+          if (stringPadding < 4) {
+            stringPaddingEnd += stringPadding;
+          }
+          break;
+        }
+      }
+
+      return [new TextDecoder().decode(bytes.subarray(0, stringEnd)), bytes.subarray(stringPaddingEnd)];
+    },
+  },
+  f: {
+    toBuffer: (number) => {
+      if (typeof number === 'number') {
+        const view = new DataView(new ArrayBuffer(4));
+        view.setFloat32(0, number);
+        return new Uint8Array(view.buffer);
+      }
+      throw new TypeError('osc type f toBuffer called with non number value');
+    },
+    fromBuffer: (buffer) => {
+      if (buffer.length < 4) {
+        throw new Error('not enough bytes to read a osc float');
+      }
+      const view = new DataView(new ArrayBuffer(4));
+
+      buffer.slice(0, 4).forEach((byte, index) => {
+        view.setUint8(index, byte);
+      });
+
+      const value = view.getFloat32(0);
+      return [value, buffer.subarray(4)];
+    },
+  },
+  i: {
+    toBuffer: (number) => {
+      if (typeof number === 'number') {
+        const view = new DataView(new ArrayBuffer(4));
+        view.setInt32(0, number);
+        return new Uint8Array(view.buffer);
+      }
+      throw new TypeError('osc type i toBuffer called with non number value');
+    },
+    fromBuffer: (buffer) => {
+      if (buffer.length < 4) {
+        throw new Error('not enough bytes to read a osc integer');
+      }
+
+      const view = new DataView(new ArrayBuffer(4));
+
+      buffer.slice(0, 4).forEach((byte, index) => {
+        view.setUint8(index, byte);
+      });
+
+      const value = view.getInt32(0);
+      return [value, buffer.subarray(4)];
+    },
+  },
+  b: {
+    toBuffer: (data) => {
+      if (data instanceof Uint8Array) {
+        const sizeBuffer = oscTypeConverterMap.i.toBuffer(data.length);
+        if (sizeBuffer) {
+          let padSize = 4 - (data.length % 4);
+          if (padSize === 4) {
+            padSize = 0;
+          }
+
+          const buffer = new Uint8Array(4 + data.length + padSize);
+          buffer.set(sizeBuffer);
+          buffer.set(data, 4);
+          return buffer;
+        }
+      }
+      throw new TypeError('osc type b toBuffer called with non Uint8Array value');
+    },
+    fromBuffer: (buffer) => {
+      const [blobLength, blobBytes] = oscTypeConverterMap.i.fromBuffer(buffer);
+      if (typeof blobLength === 'number') {
+        if (blobBytes.length < blobLength) {
+          throw new Error('not enough bytes left for blob length specified');
+        }
+        const value = blobBytes.subarray(0, blobLength);
+        const blobPadding = 4 - (blobLength % 4);
+        const blobEnd = blobPadding < 4 ? blobLength + blobPadding : blobLength;
+        return [value, blobBytes.subarray(blobEnd)];
+      } else {
+        throw new Error('unexpected value for blob length');
+      }
+    },
+  },
+  T: {
+    toBuffer: () => {
+      return new Uint8Array(0);
+    },
+    fromBuffer: (buffer) => {
+      return [true, buffer];
+    },
+  },
+  F: {
+    toBuffer: () => {
+      return new Uint8Array(0);
+    },
+    fromBuffer: (buffer) => {
+      return [false, buffer];
+    },
+  },
+  t: {
+    toBuffer: (timetag) => {
+      if (!Array.isArray(timetag)) {
+        throw new TypeError('osc type t toBuffer called with non array value');
+      }
+
+      if (timetag.length != 2) {
+        throw new TypeError('osc type t array should have exactly 2 elements');
+      }
+
+      const seconds = timetag[0];
+      if (typeof seconds !== 'number') {
+        throw new TypeError('osc type t seconds part should be a number');
+      }
+
+      const fractional = timetag[1];
+      if (typeof fractional !== 'number') {
+        throw new TypeError('osc type t fractional part should be a number');
+      }
+
+      const secondsBuffer = oscTypeConverterMap.i.toBuffer(seconds);
+      const fractionalBuffer = oscTypeConverterMap.i.toBuffer(fractional);
+
+      if (secondsBuffer && fractionalBuffer) {
+        const buffer = new Uint8Array(8);
+        buffer.set(secondsBuffer);
+        buffer.set(fractionalBuffer, 4);
+        return buffer;
+      }
+    },
+    fromBuffer: (buffer) => {
+      if (buffer.length < 8) {
+        throw new Error('osc time tag must be greater than 8 bytes');
+      }
+      const [seconds, bytesAfterSeconds] = oscTypeConverterMap.i.fromBuffer(buffer);
+      const [fractional, bytesAfterFractional] = oscTypeConverterMap.i.fromBuffer(bytesAfterSeconds);
+      if (typeof seconds === 'number' && typeof fractional === 'number') {
+        const timeTag: OSCTimeTag = [seconds, fractional];
+        return [timeTag, bytesAfterFractional];
+      }
+      return [undefined, bytesAfterFractional];
+    },
+  },
+};

packages/osc/tests/bundle-decode.test.js

@@ -0,0 +1,33 @@
+const { deepEqual, equal } = require('assert');
+const { describe, it } = require('node:test');
+const osc = require('../dist/index');
+
+const tests = [
+  {
+    description: 'simple contents single message',
+    bytes: new Uint8Array([
+      ...new TextEncoder().encode('#bundle'),
+      ...new Uint8Array([0x00]),
+      ...new Uint8Array([0, 0, 0, 32, 0, 0, 0, 0]),
+      ...new Uint8Array([0x00, 0x00, 0x00, 0x20]),
+      ...new Uint8Array([
+        0x2f, 0x6f, 0x73, 0x63, 0x69, 0x6c, 0x6c, 0x61, 0x74, 0x6f, 0x72, 0x2f, 0x34, 0x2f, 0x66, 0x72, 0x65, 0x71,
+        0x75, 0x65, 0x6e, 0x63, 0x79, 0x00, 0x2c, 0x66, 0x00, 0x00, 0x43, 0xdc, 0x00, 0x00,
+      ]),
+    ]),
+    expected: {
+      timeTag: [32, 0],
+      contents: [{ address: '/oscillator/4/frequency', args: [{ type: 'f', value: 440 }] }],
+    },
+  },
+];
+
+describe('OSC Bundle Decoding', () => {
+  tests.forEach((bundleTest) => {
+    it(bundleTest.description, () => {
+      const [encoded, remainingBytes] = osc.bundleFromBuffer(bundleTest.bytes);
+      equal(remainingBytes.length, 0)
+      deepEqual(encoded, bundleTest.expected);
+    });
+  });
+});

packages/osc/tests/bundle-encode.test.js

@@ -0,0 +1,32 @@
+const { deepEqual } = require('assert');
+const { describe, it } = require('node:test');
+const osc = require('../dist/index');
+
+const tests = [
+  {
+    description: 'simple contents single message',
+    bundle: {
+      timeTag: [32, 0],
+      contents: [{ address: '/oscillator/4/frequency', args: [{ type: 'f', value: 440 }] }],
+    },
+    expected: new Uint8Array([
+      ...new TextEncoder().encode('#bundle'),
+      ...new Uint8Array([0x00]),
+      ...new Uint8Array([0, 0, 0, 32, 0, 0, 0, 0]),
+      ...new Uint8Array([0x00, 0x00, 0x00, 0x20]),
+      ...new Uint8Array([
+        0x2f, 0x6f, 0x73, 0x63, 0x69, 0x6c, 0x6c, 0x61, 0x74, 0x6f, 0x72, 0x2f, 0x34, 0x2f, 0x66, 0x72, 0x65, 0x71,
+        0x75, 0x65, 0x6e, 0x63, 0x79, 0x00, 0x2c, 0x66, 0x00, 0x00, 0x43, 0xdc, 0x00, 0x00,
+      ]),
+    ]),
+  },
+];
+
+describe('OSC Bundle Encoding', () => {
+  tests.forEach((bundleTest) => {
+    it(bundleTest.description, () => {
+      const encoded = osc.bundleToBuffer(bundleTest.bundle);
+      deepEqual(encoded, bundleTest.expected);
+    });
+  });
+});

packages/osc/tests/message-decode.test.js

@@ -1,51 +1,57 @@
-const { deepEqual, throws } = require('assert');
+const { deepEqual, throws, equal } = require('assert');
 const { describe, it } = require('node:test');
 const osc = require('../dist/index');
 
 const tests = [
   {
     description: 'simple address no args',
-    bytes: Buffer.from('2f68656c6c6f00002c000000', 'hex'),
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 0, 0, 0]),
     expected: { address: '/hello', args: [] },
   },
   {
     description: 'simple address string arg',
-    bytes: Buffer.from('2f68656c6c6f00002c7300006172673100000000', 'hex'),
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 115, 0, 0, 97, 114, 103, 49, 0, 0, 0, 0]),
     expected: { address: '/hello', args: [{ type: 's', value: 'arg1' }] },
   },
   {
     description: 'simple address integer arg',
-    bytes: Buffer.from('2f68656c6c6f00002c69000000000023', 'hex'),
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 105, 0, 0, 0, 0, 0, 35]),
     expected: { address: '/hello', args: [{ type: 'i', value: 35 }] },
   },
   {
     description: 'simple address float arg',
-    bytes: Buffer.from('2f68656c6c6f00002c660000420a0000', 'hex'),
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 102, 0, 0, 66, 10, 0, 0]),
     expected: { address: '/hello', args: [{ type: 'f', value: 34.5 }] },
   },
   {
     description: 'simple address blob arg',
-    bytes: Buffer.from('2f68656c6c6f00002c62000000000004626c6f62', 'hex'),
-    expected: { address: '/hello', args: [{ type: 'b', value: Buffer.from('blob') }] },
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 98, 0, 0, 0, 0, 0, 4, 98, 108, 111, 98]),
+    expected: { address: '/hello', args: [{ type: 'b', value: new TextEncoder().encode('blob') }] },
   },
   {
     description: 'simple address True arg',
-    bytes: Buffer.from('2f68656c6c6f00002c540000', 'hex'),
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 84, 0, 0]),
     expected: { address: '/hello', args: [{ type: 'T', value: true }] },
   },
   {
     description: 'simple address False arg',
-    bytes: Buffer.from('2f68656c6c6f00002c460000', 'hex'),
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 70, 0, 0]),
     expected: { address: '/hello', args: [{ type: 'F', value: false }] },
   },
   {
     description: 'osc 1.0 spec example 1',
-    bytes: Buffer.from('2f6f7363696c6c61746f722f342f6672657175656e6379002c66000043dc0000', 'hex'),
+    bytes: new Uint8Array([
+      47, 111, 115, 99, 105, 108, 108, 97, 116, 111, 114, 47, 52, 47, 102, 114, 101, 113, 117, 101, 110, 99, 121, 0, 44,
+      102, 0, 0, 67, 220, 0, 0,
+    ]),
     expected: { address: '/oscillator/4/frequency', args: [{ type: 'f', value: 440 }] },
   },
   {
     description: 'osc 1.0 spec example 2',
-    bytes: Buffer.from('2f666f6f000000002c69697366660000000003e8ffffffff68656c6c6f0000003f9df3b640b5b22d', 'hex'),
+    bytes: new Uint8Array([
+      47, 102, 111, 111, 0, 0, 0, 0, 44, 105, 105, 115, 102, 102, 0, 0, 0, 0, 3, 232, 255, 255, 255, 255, 104, 101, 108,
+      108, 111, 0, 0, 0, 63, 157, 243, 182, 64, 181, 178, 45,
+    ]),
     expected: {
       address: '/foo',
       args: [
@@ -63,7 +69,8 @@ const tests = [
 describe('OSC Message Decoding', () => {
   tests.forEach((messageTest) => {
     it(messageTest.description, () => {
-      const decoded = osc.messageFromBuffer(messageTest.bytes);
+      const [decoded, remainingBytes] = osc.messageFromBuffer(messageTest.bytes);
+      equal(remainingBytes.length, 0)
       deepEqual(decoded, messageTest.expected);
     });
   });
@@ -71,7 +78,9 @@ describe('OSC Message Decoding', () => {
   it('bad address', () => {
     throws(
       () => {
-        osc.messageFromBuffer(Buffer.from('68656c6c6f00002c660000420a0000', 'hex'));
+        osc.messageFromBuffer(
+          new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x00, 0x00, 0x2c, 0x66, 0x00, 0x00, 0x42, 0x0a, 0x00, 0x00])
+        );
       },
       { name: /^Error$/, message: /must start with/ }
     );
@@ -80,7 +89,9 @@ describe('OSC Message Decoding', () => {
   it('bad type string', () => {
     throws(
       () => {
-        osc.messageFromBuffer(Buffer.from('2f68656c6c6f000066000000420a00', 'hex'));
+        osc.messageFromBuffer(
+          new Uint8Array([0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x00, 0x00, 0x66, 0x00, 0x00, 0x00, 0x42, 0x0a, 0x00])
+        );
       },
       { name: /^Error$/, message: /type string must start with/ }
     );
@@ -89,7 +100,11 @@ describe('OSC Message Decoding', () => {
   it('unknown type', () => {
     throws(
       () => {
-        osc.messageFromBuffer(Buffer.from('2f68656c6c6f00002c7a0000420a0000', 'hex'));
+        osc.messageFromBuffer(
+          new Uint8Array([
+            0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x00, 0x00, 0x2c, 0x7a, 0x00, 0x00, 0x42, 0x0a, 0x00, 0x00,
+          ])
+        );
       },
       { name: /^Error$/, message: /unknown/ }
     );
@@ -98,7 +113,9 @@ describe('OSC Message Decoding', () => {
   it('float arg missing bytes', () => {
     throws(
       () => {
-        osc.messageFromBuffer(Buffer.from('2f68656c6c6f00002c660000420a00', 'hex'));
+        osc.messageFromBuffer(
+          new Uint8Array([0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x00, 0x00, 0x2c, 0x66, 0x00, 0x00, 0x42, 0x0a, 0x00])
+        );
       },
       { name: /^Error$/, message: /not enough bytes/ }
     );
@@ -107,7 +124,9 @@ describe('OSC Message Decoding', () => {
   it('int arg missing bytes', () => {
     throws(
       () => {
-        osc.messageFromBuffer(Buffer.from('2f68656c6c6f00002c690000000000', 'hex'));
+        osc.messageFromBuffer(
+          new Uint8Array([0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x00, 0x00, 0x2c, 0x69, 0x00, 0x00, 0x00, 0x00, 0x00])
+        );
       },
       { name: /^Error$/, message: /not enough bytes/ }
     );
@@ -116,7 +135,12 @@ describe('OSC Message Decoding', () => {
   it('blob bytes too small', () => {
     throws(
       () => {
-        osc.messageFromBuffer(Buffer.from('2f68656c6c6f00002c62000000000004626c6f', 'hex'));
+        osc.messageFromBuffer(
+          new Uint8Array([
+            0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x00, 0x00, 0x2c, 0x62, 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 0x62, 0x6c,
+            0x6f,
+          ])
+        );
       },
       { name: /^Error$/, message: /not enough bytes/ }
     );

packages/osc/tests/message-encode.test.js

@@ -6,37 +6,63 @@ const tests = [
   {
     description: 'simple address no args',
     message: { address: '/hello', args: [] },
-    expected: Buffer.from('2f68656c6c6f00002c000000', 'hex'),
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 0, 0, 0]),
   },
   {
     description: 'simple address string arg',
     message: { address: '/hello', args: [{ type: 's', value: 'arg1' }] },
-    expected: Buffer.from('2f68656c6c6f00002c7300006172673100000000', 'hex'),
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 115, 0, 0, 97, 114, 103, 49, 0, 0, 0, 0]),
   },
   {
     description: 'simple address integer arg',
     message: { address: '/hello', args: [{ type: 'i', value: 35 }] },
-    expected: Buffer.from('2f68656c6c6f00002c69000000000023', 'hex'),
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 105, 0, 0, 0, 0, 0, 35]),
   },
   {
     description: 'simple address float arg',
     message: { address: '/hello', args: [{ type: 'f', value: 34.5 }] },
-    expected: Buffer.from('2f68656c6c6f00002c660000420a0000', 'hex'),
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 102, 0, 0, 66, 10, 0, 0]),
   },
   {
     description: 'simple address blob arg',
-    message: { address: '/hello', args: [{ type: 'b', value: Buffer.from('blob') }] },
-    expected: Buffer.from('2f68656c6c6f00002c62000000000004626c6f62', 'hex'),
+    message: { address: '/hello', args: [{ type: 'b', value: new TextEncoder().encode('blob') }] },
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 98, 0, 0, 0, 0, 0, 4, 98, 108, 111, 98]),
   },
   {
     description: 'simple address True arg',
     message: { address: '/hello', args: [{ type: 'T', value: true }] },
-    expected: Buffer.from('2f68656c6c6f00002c540000', 'hex'),
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 84, 0, 0]),
   },
   {
     description: 'simple address False arg',
     message: { address: '/hello', args: [{ type: 'F', value: false }] },
-    expected: Buffer.from('2f68656c6c6f00002c460000', 'hex'),
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 70, 0, 0]),
+  },
+  {
+    description: 'osc 1.0 spec example 1',
+    message: { address: '/oscillator/4/frequency', args: [{ type: 'f', value: 440 }] },
+    expected: new Uint8Array([
+      47, 111, 115, 99, 105, 108, 108, 97, 116, 111, 114, 47, 52, 47, 102, 114, 101, 113, 117, 101, 110, 99, 121, 0, 44,
+      102, 0, 0, 67, 220, 0, 0,
+    ]),
+  },
+  {
+    description: 'osc 1.0 spec example 2',
+    message: {
+      address: '/foo',
+      args: [
+        { type: 'i', value: 1000 },
+        { type: 'i', value: -1 },
+        { type: 's', value: 'hello' },
+        // thanks IEEE 754
+        { type: 'f', value: 1.2339999675750732421875 },
+        { type: 'f', value: 5.677999973297119140625 },
+      ],
+    },
+    expected: new Uint8Array([
+      47, 102, 111, 111, 0, 0, 0, 0, 44, 105, 105, 115, 102, 102, 0, 0, 0, 0, 3, 232, 255, 255, 255, 255, 104, 101, 108,
+      108, 111, 0, 0, 0, 63, 157, 243, 182, 64, 181, 178, 45,
+    ]),
   },
 ];
 

src/index.ts

@@ -1,2 +0,0 @@
-export * from './osc';
-export * from './models';

src/osc.ts

@@ -1,315 +0,0 @@
-import { OSCType, OSCArg, OSCMessage, OSCTypeConverter, OSCBundle, OSCTimeTag } from './models';
-
-const oscTypeConverterMap: { [key: string]: OSCTypeConverter } = {
-  s: {
-    toBuffer: (string) => {
-      if (typeof string === 'string') {
-        let oscString = `${string}\u0000`;
-        const padSize = 4 - (oscString.length % 4);
-        if (padSize < 4) {
-          oscString = oscString.padEnd(oscString.length + padSize, '\u0000');
-        }
-        return Buffer.from(oscString, 'ascii');
-      }
-      throw new TypeError('osc type s toBuffer called with non string value');
-    },
-    fromBuffer: (bytes: Buffer) => {
-      let stringEnd = 0;
-      let stringPaddingEnd = 0;
-      for (let index = 0; index < bytes.length; index++) {
-        if (bytes[index] === 0) {
-          stringEnd = index;
-          stringPaddingEnd = index + 1;
-          const stringPadding = 4 - ((stringEnd + 1) % 4);
-
-          if (stringPadding < 4) {
-            stringPaddingEnd += stringPadding;
-          }
-          break;
-        }
-      }
-
-      return [bytes.toString('ascii', 0, stringEnd), bytes.subarray(stringPaddingEnd)];
-    },
-  },
-  f: {
-    toBuffer: (number) => {
-      if (typeof number === 'number') {
-        const buffer = Buffer.alloc(4);
-        buffer.writeFloatBE(number);
-        return buffer;
-      }
-      throw new TypeError('osc type f toBuffer called with non number value');
-    },
-    fromBuffer: (buffer) => {
-      if (buffer.length < 4) {
-        throw new Error('not enough bytes to read a osc float');
-      }
-
-      const value = buffer.readFloatBE();
-      return [value, buffer.subarray(4)];
-    },
-  },
-  i: {
-    toBuffer: (number) => {
-      if (typeof number === 'number') {
-        const buffer = Buffer.alloc(4);
-        buffer.writeInt32BE(number);
-        return buffer;
-      }
-      throw new TypeError('osc type i toBuffer called with non number value');
-    },
-    fromBuffer: (buffer) => {
-      if (buffer.length < 4) {
-        throw new Error('not enough bytes to read a osc integer');
-      }
-
-      const value = buffer.readInt32BE();
-      return [value, buffer.subarray(4)];
-    },
-  },
-  b: {
-    toBuffer: (data) => {
-      if (Buffer.isBuffer(data)) {
-        const sizeBuffer = oscTypeConverterMap.i.toBuffer(data.length);
-        if (sizeBuffer) {
-          const padSize = 4 - (data.length % 4);
-          const padBuffer = padSize < 4 ? Buffer.from(Array(padSize).fill(0)) : Buffer.from([]);
-          return Buffer.concat([sizeBuffer, data, padBuffer]);
-        }
-      }
-      throw new TypeError('osc type b toBuffer called with non Buffer value');
-    },
-    fromBuffer: (buffer) => {
-      const [blobLength, blobBytes] = oscTypeConverterMap.i.fromBuffer(buffer);
-      if (typeof blobLength === 'number') {
-        if (blobBytes.length < blobLength) {
-          throw new Error('not enough bytes left for blob length specified');
-        }
-        const value = blobBytes.subarray(0, blobLength);
-        const blobPadding = 4 - (blobLength % 4);
-        const blobEnd = blobPadding < 4 ? blobLength + blobPadding : blobLength;
-        return [value, blobBytes.subarray(blobEnd)];
-      } else {
-        throw new Error('unexpected value for blob length');
-      }
-    },
-  },
-  T: {
-    toBuffer: () => {
-      return Buffer.alloc(0);
-    },
-    fromBuffer: (buffer) => {
-      return [true, buffer];
-    },
-  },
-  F: {
-    toBuffer: () => {
-      return Buffer.alloc(0);
-    },
-    fromBuffer: (buffer) => {
-      return [false, buffer];
-    },
-  },
-  t: {
-    toBuffer: (timetag) => {
-      if (!Array.isArray(timetag)) {
-        throw new TypeError('osc type t toBuffer called with non array value');
-      }
-
-      if (timetag.length != 2) {
-        throw new TypeError('osc type t array should have exactly 2 elements');
-      }
-
-      const seconds = timetag[0];
-      if (typeof seconds !== 'number') {
-        throw new TypeError('osc type t seconds part should be a number');
-      }
-
-      const fractional = timetag[1];
-      if (typeof fractional !== 'number') {
-        throw new TypeError('osc type t fractional part should be a number');
-      }
-
-      const secondsBuffer = oscTypeConverterMap.i.toBuffer(seconds);
-      const fractionalBuffer = oscTypeConverterMap.i.toBuffer(fractional);
-
-      if (secondsBuffer && fractionalBuffer) {
-        return Buffer.concat([secondsBuffer, fractionalBuffer]);
-      }
-    },
-    fromBuffer: (buffer) => {
-      if (buffer.length < 8) {
-        throw new Error('osc time tag must be greater than 8 bytes');
-      }
-      const [seconds, bytesAfterSeconds] = oscTypeConverterMap.i.fromBuffer(buffer);
-      const [fractional, bytesAfterFractional] = oscTypeConverterMap.i.fromBuffer(bytesAfterSeconds);
-      if (typeof seconds === 'number' && typeof fractional === 'number') {
-        const timeTag: OSCTimeTag = [seconds, fractional];
-        return [timeTag, bytesAfterFractional];
-      }
-      return [undefined, bytesAfterFractional];
-    },
-  },
-};
-
-function argsToBuffer(args: OSCArg[]) {
-  const argBuffers: Buffer[] = [];
-
-  for (let index = 0; index < args.length; index += 1) {
-    const arg = args[index];
-    const typeConverter = oscTypeConverterMap[arg.type];
-    if (typeConverter === undefined) {
-      throw new TypeError('unknown type '.concat(arg.type));
-    }
-
-    const buffer = typeConverter.toBuffer(arg.value);
-    if (buffer !== undefined) {
-      argBuffers.push(buffer);
-    }
-  }
-  return Buffer.concat(argBuffers);
-}
-
-export function messageToBuffer(message: OSCMessage): Buffer {
-  const addressBuffer = oscTypeConverterMap.s.toBuffer(message.address);
-  if (addressBuffer === undefined) {
-    throw new Error('problem encoding address');
-  }
-
-  const typeString = message.args.map((arg) => arg.type).join('');
-  const typesBuffer = oscTypeConverterMap.s.toBuffer(`,${typeString}`);
-  if (typesBuffer === undefined) {
-    throw new Error('problem encoding types');
-  }
-  const argsBuffer = argsToBuffer(message.args);
-  return Buffer.concat([addressBuffer, typesBuffer, argsBuffer]);
-}
-
-export function messageFromBuffer(bytes: Buffer): OSCMessage | undefined {
-  if (bytes[0] !== 47) {
-    throw new Error('osc message must start with a /');
-  }
-
-  const oscArgs: OSCArg[] = [];
-
-  const [address, bytesAfterAddress] = oscTypeConverterMap.s.fromBuffer(bytes);
-  if (typeof address === 'string') {
-    let [typeString, bytesAfterType] = oscTypeConverterMap.s.fromBuffer(bytesAfterAddress);
-    if (typeof typeString === 'string') {
-      if (!typeString.startsWith(',')) {
-        throw new Error('osc type string must start with a ,');
-      }
-      let argsBuffer = bytesAfterType;
-      for (let index = 1; index < typeString.length; index++) {
-        const argType = typeString.charAt(index) as OSCType;
-
-        const oscTypeConverter = oscTypeConverterMap[argType];
-        if (oscTypeConverter === undefined) {
-          throw new Error('unknown OSC type');
-        }
-        const [value, remainingBytes] = oscTypeConverter.fromBuffer(argsBuffer);
-        if (value !== undefined) {
-          const arg: OSCArg = {
-            type: argType,
-            value: value,
-          };
-          oscArgs.push(arg);
-        }
-        argsBuffer = remainingBytes;
-      }
-
-      return {
-        address,
-        args: oscArgs,
-      };
-    }
-  }
-}
-
-export function bundleFromBuffer(bytes: Buffer): OSCBundle | undefined {
-  if (bytes.length < 8) {
-    throw new Error('bundle has to be at least 20 bytes');
-  }
-
-  if (bytes.subarray(0, 7).toString('ascii') !== '#bundle') {
-    throw new Error('bundle must start with #bundle');
-  }
-
-  const [bundleHeader, bytesAfterHeader] = oscTypeConverterMap.s.fromBuffer(bytes);
-  let [timeTag, bytesAfterTimeTag] = oscTypeConverterMap.t.fromBuffer(bytesAfterHeader);
-
-  if (!Array.isArray(timeTag)) {
-    throw new Error('problem getting bundle time tag');
-  }
-
-  const bundleContents = [];
-
-  let endOfBundle = false;
-
-  let [contentSize, remainingBytes] = oscTypeConverterMap.i.fromBuffer(bytesAfterTimeTag);
-  if (typeof contentSize === 'number') {
-    while (!endOfBundle) {
-      if (remainingBytes.length < contentSize) {
-        throw new Error('bundle does not contain enough data');
-      }
-
-      const bundleContentBytes = remainingBytes.subarray(0, contentSize);
-      console.log(bundleContentBytes);
-
-      if (bundleContentBytes[0] === 35) {
-        // # character indicating contents is a bundle
-        const content = bundleFromBuffer(bundleContentBytes);
-        if (content) {
-          bundleContents.push(content);
-        }
-      } else if (bundleContentBytes[0] === 47) {
-        const content = messageFromBuffer(bundleContentBytes);
-        if (content) {
-          bundleContents.push(content);
-        }
-      } else {
-        throw new Error('bundle contents does not look like a OSC message or bundle');
-      }
-
-      remainingBytes = remainingBytes.subarray(contentSize);
-      if (remainingBytes.length === 0) {
-        endOfBundle = true;
-      }
-    }
-  }
-
-  return {
-    timeTag,
-    contents: bundleContents,
-  };
-}
-
-export function bundleToBuffer(bundle: OSCBundle): Buffer {
-  const headerBuffer = oscTypeConverterMap.s.toBuffer('#bundle');
-
-  if (headerBuffer === undefined) {
-    throw new Error('problem encoding buffer header');
-  }
-
-  const timeTagBuffer = oscTypeConverterMap.t.toBuffer(bundle.timeTag);
-
-  if (timeTagBuffer === undefined) {
-    throw new Error('problem encoding buffer time tag');
-  }
-
-  const contentsBuffers: Buffer[] = [];
-
-  bundle.contents.forEach((bundleContent) => {
-    if ('address' in bundleContent) {
-      const contentBuffer = messageToBuffer(bundleContent);
-      const contentSizeBuffer = oscTypeConverterMap.i.toBuffer(contentBuffer.length);
-
-      if (contentBuffer && contentSizeBuffer) {
-        contentsBuffers.push(Buffer.concat([contentSizeBuffer, contentBuffer]));
-      }
-    }
-  });
-
-  return Buffer.concat([headerBuffer, timeTagBuffer, ...contentsBuffers]);
-}

tests/bundle-decode.test.js

@@ -1,29 +0,0 @@
-const { deepEqual } = require('assert');
-const { describe, it } = require('node:test');
-const osc = require('../dist/index');
-
-const tests = [
-  {
-    description: 'simple contents single message',
-    expected: {
-      timeTag: [32, 0],
-      contents: [{ address: '/oscillator/4/frequency', args: [{ type: 'f', value: 440 }] }],
-    },
-    bundle: Buffer.concat([
-      Buffer.from('#bundle', 'ascii'),
-      Buffer.from([0x00]),
-      Buffer.from([0, 0, 0, 32, 0, 0, 0, 0]),
-      Buffer.from('00000020', 'hex'),
-      Buffer.from('2f6f7363696c6c61746f722f342f6672657175656e6379002c66000043dc0000', 'hex'),
-    ]),
-  },
-];
-
-describe('OSC Bundle Decoding', () => {
-  tests.forEach((bundleTest) => {
-    it(bundleTest.description, () => {
-      const encoded = osc.bundleFromBuffer(bundleTest.bundle);
-      deepEqual(encoded, bundleTest.expected);
-    });
-  });
-});

tests/bundle-encode.test.js

@@ -1,26 +0,0 @@
-const { deepEqual, throws } = require('assert');
-const { describe, it } = require('node:test');
-const osc = require('../dist/index');
-
-const tests = [
-  {
-    description: 'simple contents single message',
-    bundle: { timeTag: [32, 0], contents: [{ address: '/oscillator/4/frequency', args: [{ type: 'f', value: 440 }] }] },
-    expected: Buffer.concat([
-      Buffer.from('#bundle', 'ascii'),
-      Buffer.from([0x00]),
-      Buffer.from([0, 0, 0, 32, 0, 0, 0, 0]),
-      Buffer.from('00000020', 'hex'),
-      Buffer.from('2f6f7363696c6c61746f722f342f6672657175656e6379002c66000043dc0000', 'hex'),
-    ]),
-  },
-];
-
-describe('OSC Bundle Encoding', () => {
-  tests.forEach((bundleTest) => {
-    it(bundleTest.description, () => {
-      const encoded = osc.bundleToBuffer(bundleTest.bundle);
-      deepEqual(encoded, bundleTest.expected);
-    });
-  });
-});