osc/README.md

37 lines
1.7 KiB
Markdown
Raw Normal View History

# Open Sound Control
2015-08-25 19:59:32 +00:00
This is a common lisp implementation of the Open Sound Control Protocol aka OSC. The code should be close to the ansi standard, and does not rely on any external code/ffi/etc+ to do the basic encoding and decoding of packets. since OSC does not specify a transport layer, messages can be send using TCP or UDP (or carrier pigeons), however it seems UDP is more common amongst the programmes that communicate using the OSC protocol. the osc-examples.lisp file contains a few simple examples of how to send and recieve OSC via UDP, and so far seems reasonably compatible with the packets send from/to max-msp, pd, supercollider and liblo. more details about OSC can be found at https://opensoundcontrol.org/
2022-08-26 08:20:37 +00:00
## installation & usage
the current version of this code is avilable from github
2011-04-19 03:45:08 +00:00
2015-08-25 19:59:32 +00:00
`git clone https://github.com/zzkt/osc`
2015-09-15 14:57:57 +00:00
or via quicklisp.. .
2011-04-19 03:45:08 +00:00
2015-08-25 19:59:32 +00:00
`(ql:quickload "osc")`
2022-08-26 08:20:37 +00:00
There are some basic examples in `osc-examples.lisp` and the `devices/examples/osc-device-examples.lisp` file shows how to use a higher-level API for sending and receiving OSC messages.
## limitations
2011-04-19 03:45:08 +00:00
2015-08-25 19:59:32 +00:00
- will raise an exception if input is malformed
2022-08-26 08:20:37 +00:00
- no pattern matching on addresses
2015-08-25 19:59:32 +00:00
- float en/decoding only tested on sbcl, cmucl, openmcl and allegro
- the `devices` module only works on sbcl
- only supports the type(tag)s specified in the OSC spec
## things to do in :osc
2011-04-19 03:45:08 +00:00
- address patterns using pcre
- data checking and error handling
- portable en/decoding of floats -=> ieee754 tests
- doubles and other defacto typetags
## things to do in :osc-ex[tensions|tras]
2011-04-19 03:45:08 +00:00
2022-08-26 08:20:37 +00:00
- liblo like network wrapping (and devices)
- add namespace exploration using cl-zeroconf (or similar)