Deno-PLC / Adapter-OSC

TypeScript implementation of OSC (Open Sound Control)

Installation

Use JSR:

Usage

Encoder

import { encodeOSC } from "@deno-plc/adapter-osc";

const packet = encodeOSC("/foo/bar", [5, true]);

This might throw an OSCProtocolError if the supplied data is invalid

Decoder

import { decodeOSC } from "@deno-plc/adapter-osc";

const [address, args] = decodeOSC(packet);

This might throw an OSCProtocolError if the supplied data is invalid

Supported data types

• string (s) (string)
• int32 (i) (number)
• blob (b) (Uint8Array)
• float32 (f) (number)
• float64 (d) (number)
• boolean (T,F) (boolean)

About non-ASCII characters

While the specs only covers ASCII strings, you might encounter situations where you need Unicode characters. Please note that the following is non-standard behavior.

decodeOSC will treat everything it receives as UTF-8.

encodeOSC is able to encode UTF-8 strings, but in the default configuration it will throw an error on multi-byte characters because the allocated buffer is not large enough. You can increase the buffer size with the oversize option. Alternatively you can use encodeOSC_UTF8 (not recommended as default, 1.5-2x slower than the standard encoder)

OSC over TCP

This package has support for OSC-over-TCP (=OSC packets are transmitted SLIP (Serial Line Internet Protocol) encoded over a TCP socket) usable in conjunction with adapter-tcp. For usage instructions see examples/tcposc.ts

Slow version

This package contains two implementations of OSC. While the default version is around 10x faster than the so-called slow version, it contains a lot of string/array manipulation functions with offset calculations (which could possibly be buggy). For this reason the slow version is kept and used as a testing reference.

Specification

• https://opensoundcontrol.stanford.edu/spec-1_0.html

License (GPL-3.0-or-later)

(C) 2024 Hans Schallmoser

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.