zzkt/osc
1
0
Fork 0
Code Issues 7 Pull requests Projects Releases Activity Actions

Cleaning

Browse source
This commit is contained in:
ErikR 2015-08-25 21:59:32 +02:00 committed by nik gaffney
parent 652a10dfe1
commit 829bf7cfc1
Signed by: nik
GPG key ID: 989F5E6EDB478160
16 changed files with 1652 additions and 304 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,21 +1,22 @@
# Open Sound Control
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 http://www.cnmat.berkeley.edu/OpenSoundControl/
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/
The devices/examples/osc-device-examples.lisp contains examples of a higher-level API for sending and receiving OSC messages.
the current version of this code is avilable from github
git clone https://github.com/zzkt/osc
`git clone https://github.com/zzkt/osc`
or via quicklisp.. .
(ql:quickload "osc")
`(ql:quickload "osc")`
## limitations
- doesn't send nested bundles or syncronisable timetags
- will raise an exception if the input is malformed
- will raise an exception if input is malformed
- doesn't do any pattern matching on addresses
- float en/decoding only tested on sbcl, cmucl, openmcl and allegro
- float en/decoding only tested on sbcl, cmucl, openmcl and allegro
- only supports the type(tag)s specified in the OSC spec
## things to do in :osc
@ -31,16 +32,23 @@ or via quicklisp.. .
- add namespace exploration using cl-zeroconf
# changes
- 2022-08-22
- version 0.6
- further improvements from jamieforth
- 2019-04-02
- encoder/decoder refactoring from Javier Olaechea @PuercoPop
- 2017-12-10
- osc-examples use usocket for portability from @boqs
- 2015-08-25
- support for 64bit ints from Erik Ronström https://github.com/erikronstrom
- 2015-08-21
- implement nested bundles from jamieforth https://github.com/jamieforth
- 2015-08-21
- implement nested bundles
- 2011-04-19
- converted repo from darcs->git
- 2010-09-25
- add osc-devices API from jamieforth
- 2010-09-10
- timetag improvements from jamieforth https://github.com/jamieforth/osc
- 2007-02-20
- version 0.5
- Allegro CL float en/decoding from vincent akkermans <vincent.akkermans@gmail.com>
@ -75,4 +83,3 @@ or via quicklisp.. .
- tests in osc-tests.lisp
- 2004-12-18
- initial version, single args only

87
devices/client.lisp Normal file
View file

@ -0,0 +1,87 @@
(cl:in-package #:osc)
(defun make-osc-client (&key (protocol :udp) debug-mode
(buffer-size *default-osc-buffer-size*)
address-tree cleanup-fun)
(ecase protocol
(:udp (make-instance 'osc-client-udp
:debug-mode debug-mode
:socket-buffer (make-socket-buffer
buffer-size)
:address-tree (if address-tree
address-tree
(make-osc-tree))
:cleanup-fun cleanup-fun))
(:tcp (make-instance 'osc-client-tcp
:debug-mode debug-mode
:socket-buffer (make-socket-buffer
buffer-size)
:address-tree (if address-tree
address-tree
(make-osc-tree))
:cleanup-fun cleanup-fun))))
(defmethod initialize-instance :after ((client osc-client-udp) &key)
(make-client-responders client))
(defgeneric make-client-responders (server))
(defmethod make-client-responders ((client osc-client-udp))
(add-osc-responder client "/cl-osc/server/registered"
(cmd args device address port timetag bundle)
(format t "Registered with server at ~A~%"
(make-addr+port-string address port)))
(add-osc-responder client "/cl-osc/server/quit"
(cmd args device address port timetag bundle)
(format t "Server ~A has quit~%"
(make-addr+port-string address port))))
(defgeneric register (client)
(:method ((client osc-client-udp))
(send-msg client "/cl-osc/register" (port client))))
(defmethod osc-device-cleanup ((device osc-client-udp))
(send-msg device "/cl-osc/quit")
(call-next-method))
(defun make-osc-client-endpoint-tcp (socket debug-mode buffer-size
address-tree clients &optional
cleanup-fun)
(socket-make-stream socket
:input nil :output t
:element-type '(unsigned-byte 8)
:buffering :full)
(let ((client (make-instance 'osc-client-endpoint-tcp
:debug-mode debug-mode
:address-tree address-tree
:socket-buffer (make-socket-buffer
buffer-size)
:clients clients
:cleanup-fun cleanup-fun)))
(set-socket socket client)
(set-listening-thread (make-listening-thread client) client)
client))
(defmethod make-listening-thread ((receiver osc-client-tcp))
"Creates a listening thread for tcp clients."
(sb-thread:make-thread
(lambda ()
(unwind-protect
(loop
do (multiple-value-bind (buffer length address port)
(socket-receive (socket receiver)
(socket-buffer receiver) nil)
(when (eq length 0) ; Closed by remote
(sb-thread:terminate-thread
sb-thread:*current-thread*))
(multiple-value-bind (data timetag)
(decode-bundle buffer :end length)
(when (debug-mode receiver)
(print-osc-debug-msg receiver data length
(peer-address receiver)
(peer-port receiver) timetag))
(dispatch (address-tree receiver) data receiver
address port))))
(osc-device-cleanup receiver)))
:name (format nil "osc-client-tcp-connection: ~A~%"
(name receiver))))

129
devices/device.lisp Normal file
View file

@ -0,0 +1,129 @@
(cl:in-package #:osc)
;;;=====================================================================
;;; OSC device base class
;;;=====================================================================
(defclass osc-device ()
((socket
:reader socket
:writer set-socket
:initform nil)
(debug-mode
:reader debug-mode
:writer set-debug-mode
:initarg :debug-mode)
(cleanup-fun
:reader cleanup-fun
:initarg :cleanup-fun
:initform nil)))
;;;=====================================================================
;;; OSC device mixin classes
;;;=====================================================================
(defclass udp-device (osc-device) ())
(defclass tcp-device (osc-device) ())
(defclass listening-device (osc-device)
((listening-thread
:reader listening-thread
:writer set-listening-thread
:initform nil)))
(defclass receiving-device (listening-device)
((socket-buffer
:reader socket-buffer
:initarg :socket-buffer)))
(defclass dispatching-device (listening-device)
((address-tree
:reader address-tree
:initarg :address-tree
:initform (make-osc-tree))))
(defclass dispatching-device-udp (dispatching-device receiving-device
udp-device) ())
;;;=====================================================================
;;; OSC device abstract classes
;;;=====================================================================
(defclass osc-transmitter (osc-device) ())
(defclass osc-client (dispatching-device receiving-device
osc-transmitter) ())
(defclass osc-server (dispatching-device osc-transmitter)
((buffer-size
:reader buffer-size
:initarg :buffer-size)
(clients
:reader clients
:initarg :clients
:initform (make-clients-hash))))
(defclass osc-client-endpoint (osc-client)
((clients
:reader clients
:initarg :clients)))
;;;=====================================================================
;;; OSC device concrete classes
;;;=====================================================================
(defclass osc-transmitter-udp (osc-transmitter udp-device) ())
(defclass osc-client-udp (osc-client dispatching-device-udp) ())
(defclass osc-client-tcp (osc-client tcp-device) ())
(defclass osc-server-udp (osc-server dispatching-device-udp
osc-transmitter-udp) ())
(defclass osc-server-tcp (osc-server osc-transmitter tcp-device) ())
(defclass osc-client-endpoint-tcp (osc-client-endpoint
osc-client-tcp) ())
;;;=====================================================================
;;; Device generic functions
;;;=====================================================================
(defgeneric protocol (osc-device)
(:method ((osc-device udp-device))
:udp)
(:method ((osc-device tcp-device))
:tcp))
(defgeneric name (osc-device)
(:method ((osc-device osc-device))
(concatenate 'string
(symbol-name (class-name (class-of osc-device)))
"-"
(make-name-string osc-device))))
(defmethod buffer-size ((osc-device dispatching-device))
(length (socket-buffer osc-device)))
(defgeneric quit (osc-device))
(defgeneric osc-device-cleanup (device)
(:method :before ((osc-device osc-device))
(when (cleanup-fun osc-device)
(funcall (cleanup-fun osc-device) osc-device)))
(:method ((osc-device osc-device))
(when (debug-mode osc-device)
(format t "~%OSC device stopped: ~A~%"
(name osc-device)))
(when (socket osc-device)
(handler-case
(socket-close (socket osc-device) :abort t)
(sb-int:simple-stream-error ()
(when (debug-mode osc-device)
(warn "Device ~A gone away." (name osc-device)))))
(set-socket nil osc-device))))

39
devices/dispatching-device.lisp Normal file
View file

@ -0,0 +1,39 @@
(cl:in-package #:osc)
(defmethod make-listening-thread ((receiver dispatching-device-udp))
"Creates a listening thread for udp devices (client and server)."
(sb-thread:make-thread
(lambda ()
(unwind-protect
(loop
do (multiple-value-bind (buffer length address port)
(socket-receive (socket receiver)
(socket-buffer receiver) nil)
(multiple-value-bind (data timetag)
(osc:decode-bundle buffer :end length)
(when (debug-mode receiver)
(print-osc-debug-msg receiver data length
address port timetag))
(dispatch (address-tree receiver) data receiver
address port))))
(osc-device-cleanup receiver)))
:name (format nil "osc-receiver-udp: ~A~%" (name receiver))))
;;;=====================================================================
;;; OSC Responders
;;;=====================================================================
(defmacro add-osc-responder (dispatcher cmd-name
(cmd args device address port timetag bundle)
&body body)
`(dp-register (address-tree ,dispatcher) ,cmd-name
(lambda (,cmd ,args ,device ,address ,port ,timetag
,bundle)
(declare (ignorable ,cmd ,args ,device ,address
,port ,timetag ,bundle))
,@body)))
(defgeneric remove-osc-responder (dispatcher address)
(:method ((dispatcher dispatching-device) address)
(dp-remove (address-tree dispatcher) address)))

294
devices/examples/osc-device-examples.lisp Normal file
View file

@ -0,0 +1,294 @@
(cl:in-package #:osc)
(ql:quickload "osc")
;;;=====================================================================
;;; OSC UDP transmitter -> server
;;;=====================================================================
(defparameter *osc-server* (make-osc-server :protocol :udp
:debug-mode t))
(boot *osc-server* 57127)
(defparameter *osc-transmitter* (make-osc-transmitter
:debug-mode t))
(connect *osc-transmitter* 57127 :host-name "localhost")
(device-active-p *osc-transmitter*)
(device-socket-name *osc-transmitter*)
(address *osc-transmitter*)
(port *osc-transmitter*)
(device-socket-peername *osc-transmitter*)
(peer-address *osc-transmitter*)
(peer-port *osc-transmitter*)
(send-msg *osc-transmitter* "/bar" 1 2 9)
(send-bundle *osc-transmitter*
:time ; current real time
"/foo" 1 2 3)
(send-bundle *osc-transmitter*
:now ; immediately
"/foo" 1 2 3)
(send-bundle *osc-transmitter*
(unix-time->timetag 1234567890.1234567d0)
"/foo" 1 2 3)
;; The lower-level send function can be used to send message and
;; bundle objects directly. This allows more complex (nested) bundles
;; to be created.
(send *osc-transmitter* (message "/foo" 1 2 3))
(send *osc-transmitter* (bundle :now
(message "/foo" 1 2 3)))
(let ((bundle
(bundle :now
(message "/foo" '(1 2 3))
(bundle :now
(bundle :now
(message "/bar"
'(10 20 30)))))))
(send *osc-transmitter* bundle))
(quit *osc-transmitter*)
(quit *osc-server*)
;;;=====================================================================
;;; OSC UDP client <-> server
;;;=====================================================================
(defparameter *osc-server* (make-osc-server :protocol :udp
:debug-mode t))
(boot *osc-server* 57127)
(defparameter *osc-client* (make-osc-client
:protocol :udp
:debug-mode t))
(connect *osc-client* 57127 :host-name "localhost")
;; A UDP server can't know about a client unless it registers.
(print-clients *osc-server*)
(register *osc-client*)
(print-clients *osc-server*)
(quit *osc-client*) ; quit notifies the server
(print-clients *osc-server*)
(connect *osc-client* 57127 :host-name "localhost")
(send-msg *osc-client* "/foo" 2 99)
(send-bundle *osc-client*
(unix-time->timetag 1234567890.1234567d0)
"/foo" 1 2 3)
(send-bundle *osc-client* :now "/foo" 1)
(send-bundle *osc-client* :time "/foo" 1)
;; Using the server as a transmitter.
(send-msg-to *osc-server*
(address *osc-client*) (port *osc-client*)
"/bar" 1 2 3)
(send-bundle-to *osc-server*
(address *osc-client*) (port *osc-client*)
:now "/bar" 1 2 3)
;; If a client is registered...
(send-msg-to-client *osc-server* (make-name-string *osc-client*)
"/bar" 2 99)
(register *osc-client*)
(send-msg-to-client *osc-server* (make-name-string *osc-client*)
"/bar" 2 99)
(send-bundle-to-client *osc-server*
(make-name-string *osc-client*)
:time "/bar" 2 99)
(add-osc-responder *osc-server* "/echo-sum"
(cmd args dev addr port timetag bundle)
(send-msg-to dev addr port
"/echo-answer" (apply #'+ args)))
(add-osc-responder *osc-client* "/echo-answer"
(cmd args dev addr port timetag bundle)
(format t "Sum is ~a~%" (car args)))
(send-msg *osc-client* "/echo-sum" 1 2 3 4)
(add-osc-responder *osc-server* "/timetag+1"
(cmd args dev addr port timetag bundle)
(send-bundle-to dev addr port (timetag+ timetag 1) "/the-future"))
(send-bundle *osc-client* (get-current-timetag)
"/timetag+1")
;; Send a messages to all registered clients.
(send-msg-all *osc-server* "/foo" 1 2 3)
(send-bundle-all *osc-server* :now "/foo" 1 2 3)
(defparameter *osc-client2* (make-osc-client
:protocol :udp
:debug-mode t))
(connect *osc-client2* 57127)
(register *osc-client2*)
(add-osc-responder *osc-server* "/echo-sum"
(cmd args dev addr port timetag bundle)
(send-msg-all dev "/echo-answer" (apply #'+ args)))
(send-msg *osc-client* "/echo-sum" 1 2 3 4)
(quit *osc-client*)
(quit *osc-client2*)
(quit *osc-server*)
;;;=====================================================================
;;; OSC TCP client <-> server
;;;=====================================================================
(defparameter *osc-server* (make-osc-server :protocol :tcp
:debug-mode t))
(boot *osc-server* 57127)
(defparameter *osc-client* (make-osc-client
:protocol :tcp
:debug-mode t))
(connect *osc-client* 57127 :host-name "localhost")
(device-active-p *osc-client*)
(device-socket-name *osc-client*)
(device-socket-peername *osc-client*)
(send-msg *osc-client* "/foo" 1 2 3)
(send-msg-to-client *osc-server* (make-name-string
*osc-client*)
"/foo" 1 2 3)
(defparameter *osc-client2* (make-osc-client
:protocol :tcp
:debug-mode t))
(connect *osc-client2* 57127
:host-address "127.0.0.1"
:port 57666) ; choose local port
(device-socket-name *osc-client2*)
(send-msg *osc-client2* "/bar" 4 5 6 9)
(print-clients *osc-server*)
(add-osc-responder *osc-server* "/print-sum"
(cmd args dev addr port timetag bundle)
(format t "Sum = ~A~%" (apply #'+ args)))
(send-msg *osc-client2* "/print-sum" 4 5 6 9)
(add-osc-responder *osc-server* "/echo-sum"
(cmd args dev addr port timetag bundle)
(send-msg dev cmd (apply #'+ args)))
(send-msg *osc-client2* "/echo-sum" 4 5 6 9)
(send-msg-all *osc-server* "/bar" 1 2 3) ; send to all peers
(add-osc-responder *osc-server* "/echo-sum-all"
(cmd args dev addr port timetag bundle)
(send-msg-all dev cmd (apply #'+ args)))
; Send to all peers (including self).
(send-msg *osc-client2* "/echo-sum-all" 1 2 3)
(quit *osc-client*)
(quit *osc-client2*)
(quit *osc-server*)
;;;=====================================================================
;;; OSC UDP client <-> sclang
;;;=====================================================================
(defparameter *osc-client* (make-osc-client
:protocol :udp
:debug-mode t))
(connect *osc-client* 57120 :host-name "localhost" :port 57127)
(address *osc-client*)
(port *osc-client*)
(peer-address *osc-client*)
(peer-port *osc-client*)
;;---------------------------------------------------------------------
;; run in sc
c=OSCresponder(nil,
'/foo',
{|t,r,msg,addr| [t,r,msg,addr].postln}).add
;;---------------------------------------------------------------------
(send-msg *osc-client* "/foo" 1 2 3)
(send-bundle *osc-client*
(get-current-timetag)
"/foo" 3)
(add-osc-responder *osc-client* "/echo-sum"
(cmd args dev addr port timetag bundle)
(send-msg dev cmd (apply #'+ args)))
;;---------------------------------------------------------------------
;; Send /echo-sum from sc, and lisp returns the sum.
n=NetAddr("localhost", 57127)
e=OSCresponder(nil,
'/echo-sum',
{|t,r,msg,addr|
[t,r,msg,addr].postln;
}).add
n.sendMsg('/echo-sum', 1, 2, 3) // send numbers, lisp returns sum.
;;---------------------------------------------------------------------
(quit *osc-client*)
;;;=====================================================================
;;; OSC UDP client <-> scsynth
;;;=====================================================================
(defparameter *osc-client* (make-osc-client
:protocol :udp
:debug-mode t))
(connect *osc-client* 57110 :host-name "localhost" :port 57127)
(send-msg *osc-client* "/s_new" "default" 1001 0 0 "freq" 500)
(send-msg *osc-client* "/n_free" 1001)
(send-bundle *osc-client*
(timetag+ (get-current-timetag) 2) ; 2 secs later
"/s_new" "default" 1001 0 0 "freq" 500)
(send-msg *osc-client* "/n_free" 1001)
(quit *osc-client*) ; Sends default /quit notification which scsynth
; ignores. Ideally osc-client should be subclassed
; to allow scsynth specific behaviour to be
; implemented.

31
devices/listening-device.lisp Normal file
View file

@ -0,0 +1,31 @@
(cl:in-package #:osc)
(defgeneric make-listening-thread (listening-device))
(defmethod connect progn ((listening-device listening-device)
host-port &key host-address host-name port)
(declare (ignore host-port host-address host-name port))
(set-listening-thread (make-listening-thread listening-device)
listening-device))
(defmethod quit ((device listening-device))
(sb-thread:terminate-thread (listening-thread device)))
(defmethod osc-device-cleanup ((device listening-device))
(set-listening-thread nil device)
(call-next-method))
(defmethod osc-device-cleanup ((device receiving-device))
(fill (socket-buffer device) 0)
(call-next-method))
(defun print-osc-debug-msg (receiver data length address port
timetag &optional (stream t))
(format stream
"~&~a~%bytes rx:~a~a~%from:~a~a~a ~a~%timetag:~a~a~%unix-time:~a~f~%data:~a~a"
(name receiver) #\Tab length #\Tab #\Tab
address port #\Tab timetag #\Tab
(when timetag (timetag->unix-time timetag))
#\Tab #\Tab)
(format-osc-data data :stream stream)
(format stream "~%"))

224
devices/server.lisp Normal file
View file

@ -0,0 +1,224 @@
(cl:in-package #:osc)
(defun make-osc-server (&key (protocol :udp) debug-mode
(buffer-size *default-osc-buffer-size*)
cleanup-fun)
(ecase protocol
(:udp (make-instance 'osc-server-udp
:debug-mode debug-mode
:cleanup-fun cleanup-fun
:buffer-size buffer-size
:socket-buffer (make-socket-buffer buffer-size)))
(:tcp (make-instance 'osc-server-tcp
:debug-mode debug-mode
:cleanup-fun cleanup-fun
:buffer-size buffer-size))))
(defgeneric boot (osc-server port))
(defmethod boot :around ((server osc-server) port)
(if (device-active-p server)
(warn "~%Server ~A already running" (machine-instance)))
(set-socket (make-socket (protocol server)) server)
(socket-bind (socket server) #(0 0 0 0) port)
(call-next-method)
(format t "~%Server ~A listening on port ~A~%"
(machine-instance) port))
(defmethod boot ((server osc-server-udp) port)
(declare (ignore port))
"UDP server sockets are used for receiving and unconnected sending."
(set-listening-thread (make-listening-thread server) server))
(defmethod boot ((server osc-server-tcp) port)
(declare (ignore port))
(set-listening-thread
(sb-thread:make-thread
(lambda ()
(unwind-protect
(progn (socket-listen (socket server) 10)
(loop for socket = (socket-accept (socket server))
for endpoint = (make-osc-client-endpoint-tcp
socket
(debug-mode server)
(buffer-size server)
(address-tree server)
(clients server)
(make-unregister-self-fun server))
do (register-tcp-client server endpoint)))
(osc-device-cleanup server)))
:name (format nil "osc-server-tcp: ~A" (name server)))
server)
server)
(defmethod osc-device-cleanup ((device osc-server-udp))
(loop for client-name being the hash-key in (clients device)
using (hash-value addr+port)
do (notify-quit device client-name)
do (unregister-udp-client device
(first addr+port)
(second addr+port)))
(call-next-method))
(defmethod osc-device-cleanup ((device osc-server-tcp))
(loop for client being the hash-value in (clients device)
do (quit client))
(call-next-method))
(defun make-clients-hash ()
(make-hash-table :test 'equal))
;;;=====================================================================
;;; UDP server functions
;;;=====================================================================
(defmethod initialize-instance :after ((server osc-server-udp) &key)
(make-server-responders server))
(defgeneric make-server-responders (server))
(defmethod make-server-responders ((server osc-server-udp))
(add-osc-responder server "/cl-osc/register"
(cmd args device address port timetag bundle)
(let ((listening-port (car args))) ; Optional port for sending
; return messages.
(register-udp-client device address
(if listening-port listening-port port))))
(add-osc-responder server "/cl-osc/quit"
(cmd args device address port timetag bundle)
(unregister-udp-client device address port)))
(defun register-udp-client (server addr port)
(let ((client-name (make-addr+port-string addr port)))
(format t "Client registered: ~A~%" client-name)
(setf (gethash client-name (clients server))
(list addr port))
(post-register-hook server client-name)))
(defun unregister-udp-client (server addr port)
(let ((client-name (make-addr+port-string addr port)))
(format t "Client quit: ~A~%" client-name)
(remhash client-name (clients server))))
(defgeneric post-register-hook (server client-name)
(:method ((server osc-server-udp) client-name)
(format t "Post-register hook for client: ~A~%" client-name)
(notify-registered server client-name)))
(defun notify-registered (server client-name)
(send-msg-to-client server client-name "/cl-osc/server/registered"))
(defun notify-quit (server client-name)
(send-msg-to-client server client-name "/cl-osc/server/quit"))
;;;=====================================================================
;;; TCP server functions
;;;=====================================================================
(defun register-tcp-client (server transmitter)
(setf (gethash (make-peername-string transmitter)
(clients server))
transmitter))
(defun unregister-tcp-client (server transmitter)
(remhash (make-peername-string transmitter)
(clients server)))
(defun make-unregister-self-fun (server)
#'(lambda (client)
(unregister-tcp-client server client)))
(defun get-tcp-client (server socket-peername)
(gethash socket-peername (clients server)))
(defgeneric print-clients (server))
(defmethod print-clients ((server osc-server-udp))
(loop for addr+port being the hash-value in (clients server)
for i from 1
do (format t "~A. Connected to: ~A~%" i (make-addr+port-string
(first addr+port)
(second addr+port)))))
(defmethod print-clients ((server osc-server-tcp))
(loop for endpoint being the hash-value in (clients server)
for i from 1
do (format t "~A. Connected to: ~A~%" i (make-addr+port-string
(peer-address endpoint)
(peer-port endpoint)))))
;;;=====================================================================
;;; Server sending functions
;;;=====================================================================
;; Send to a client
(defgeneric send-to-client (server client-name data)
(:method :around ((server osc-server) client-name data)
(let ((client (gethash client-name (clients server))))
(if client
(call-next-method server client data)
(warn "No client called ~A~%" client-name)))))
(defmethod send-to-client ((server osc-server-udp) client-name data)
(send-to server (first client-name) (second client-name) data))
(defmethod send-to-client ((server osc-server-tcp) client data)
(send client data))
(defgeneric send-msg-to-client (server client-name command &rest args)
(:method ((server osc-server) client-name command &rest args)
(let ((message (make-message command args)))
(send-to-client server client-name message))))
(defgeneric send-bundle-to-client (server client-name timetag command
&rest args)
(:method ((server osc-server) client-name timetag command &rest
args)
(let ((bundle (bundle timetag
(make-message command args))))
(send-to-client server client-name bundle))))
;; Send all
(defgeneric send-all (server data))
(defmethod send-all ((server osc-server-udp) data)
(loop for addr+port being the hash-value in (clients server)
do (send-to server (first addr+port) (second addr+port) data)))
(defmethod send-all ((server osc-server-tcp) data)
(loop for endpoint being the hash-value in (clients server)
do (send endpoint data)))
(defmethod send-all ((client-endpoint osc-client-endpoint) data)
(loop for endpoint being the hash-value in (clients client-endpoint)
;; FIXME: Don't not reply to the sender in this case so that the
;; behaviour of send-all is uniform for both UDP and TCP. But
;; could be useful to have a means of broadcasting messages to
;; all clients of a server except the client that generated the
;; message.
;;
;; unless (eq endpoint client-endpoint) ; don't send to sender
do (send endpoint data)))
(defgeneric send-msg-all (server command &rest args)
(:method ((server osc-server) command &rest args)
(let ((message (make-message command args)))
(send-all server message)))
(:method ((client-endpoint osc-client-endpoint) command &rest args)
(let ((message (make-message command args)))
(send-all client-endpoint message))))
(defgeneric send-bundle-all (server timetag command &rest args)
(:method ((server osc-server) timetag command &rest args)
(let ((bundle (bundle timetag
(make-message command args))))
(send-all server bundle)))
(:method ((client-endpoint osc-client-endpoint) timetag command
&rest args)
(let ((bundle (bundle timetag
(make-message command args))))
(send-all client-endpoint bundle))))

84
devices/socket-functions.lisp Normal file
View file

@ -0,0 +1,84 @@
(cl:in-package #:osc)
(defparameter *default-osc-buffer-size* 1024)
(defun make-socket-buffer (&optional (size *default-osc-buffer-size*))
(make-sequence '(vector (unsigned-byte 8)) size))
(defun make-socket (protocol)
(ecase protocol
(:udp (make-udp-socket))
(:tcp (make-tcp-socket))))
(defun make-tcp-socket ()
(make-instance 'inet-socket :type :stream :protocol :tcp))
(defun make-udp-socket ()
(make-instance 'inet-socket :type :datagram :protocol :udp))
(defun make-peername-string (osc-device)
(when (socket osc-device)
(multiple-value-bind (addr port)
(socket-peername (socket osc-device))
(make-addr+port-string addr port))))
(defun make-name-string (osc-device)
(when (socket osc-device)
(multiple-value-bind (addr port)
(socket-name (socket osc-device))
(make-addr+port-string addr port))))
(defun make-addr+port-string (addr port)
(format nil "~{~A~^.~}:~A" (coerce addr 'list) port))
(defun device-active-p (osc-device)
(when (socket osc-device)
(socket-open-p (socket osc-device))))
(defun device-socket-name (osc-device)
(socket-name (socket osc-device)))
(defun port (osc-device)
(if (device-active-p osc-device)
(multiple-value-bind (addr port)
(device-socket-name osc-device)
(declare (ignore addr))
port)
(warn "Device not active.")))
(defun address (osc-device)
(if (device-active-p osc-device)
(multiple-value-bind (addr port)
(device-socket-name osc-device)
(declare (ignore port))
addr)
(warn "Device not active.")))
(defun device-socket-peername (osc-device)
(socket-peername (socket osc-device)))
(defun peer-port (osc-device)
(if (device-active-p osc-device)
(handler-case
(multiple-value-bind (addr port)
(device-socket-peername osc-device)
(declare (ignore addr))
port)
(sb-bsd-sockets:not-connected-error ()
(warn "Device ~a not connected: device removed."
(device-socket-name osc-device))
(osc-device-cleanup osc-device)))
(warn "Device not active.")))
(defun peer-address (osc-device)
(if (device-active-p osc-device)
(handler-case
(multiple-value-bind (addr port)
(device-socket-peername osc-device)
(declare (ignore port))
addr)
(sb-bsd-sockets:not-connected-error ()
(warn "Device ~a not connected: device removed."
(device-socket-name osc-device))
(osc-device-cleanup osc-device)))
(warn "Device not active.")))

99
devices/transmitter.lisp Normal file
View file

@ -0,0 +1,99 @@
(cl:in-package #:osc)
;; Only UDP devices can be transmitters.
(defun make-osc-transmitter (&key debug-mode cleanup-fun)
(make-instance 'osc-transmitter-udp
:debug-mode debug-mode
:cleanup-fun cleanup-fun))
(defgeneric connect (osc-transmitter host-port &key host-address
host-name port)
(:method-combination progn :most-specific-last))
(defmethod connect progn ((transmitter osc-transmitter) host-port
&key (host-address nil addr)
(host-name "localhost" name) port)
(when (and addr name)
(error "Supplied both :host-address and :host-name to connect"))
(cond (addr
(when (typep host-address 'string)
(setf host-address
(sb-bsd-sockets:make-inet-address host-address))))
(t
(setf host-address
(sb-bsd-sockets:host-ent-address
(sb-bsd-sockets:get-host-by-name
host-name)))))
(if (not (device-active-p transmitter))
(progn
(let ((socket (make-socket (protocol transmitter))))
(if port
(socket-bind socket #(127 0 0 1) port)
(socket-bind socket))
(socket-connect socket host-address host-port)
(socket-make-stream socket
:input nil :output t
:element-type '(unsigned-byte 8)
:buffering :full)
(set-socket socket transmitter))
(when (debug-mode transmitter)
(format t "~%Device connected: ~A~%~A -> ~A~%"
(name transmitter) #\Tab
(make-addr+port-string (peer-address transmitter)
(peer-port transmitter)))))
(warn "Already connected"))
transmitter)
(defmethod quit ((transmitter osc-transmitter-udp))
(if (device-active-p transmitter)
(osc-device-cleanup transmitter)
(warn "Not connected: ~A" (name transmitter))))
;;;=====================================================================
;;; Sending functions
;;;=====================================================================
(defmacro osc-write-to-stream (stream &body msg)
`(progn (write-sequence ,@msg ,stream)
(finish-output ,stream)))
(defgeneric send (transmitter data)
(:method ((transmitter osc-transmitter) data)
(let ((bytes (encode-osc-data data)))
(osc-write-to-stream
(slot-value (socket transmitter) 'stream) bytes))))
(defgeneric send-msg (transmitter command &rest args)
(:method ((transmitter osc-transmitter) command &rest args)
(let ((message (make-message command args)))
(send transmitter message))))
(defgeneric send-bundle (transmitter timetag command &rest args)
(:method ((transmitter osc-transmitter) timetag command &rest args)
(let ((bundle (bundle timetag
(make-message command args))))
(send transmitter bundle))))
;; Unconnected sending (UDP only)
(defgeneric send-to (transmitter address port data)
(:method ((transmitter osc-transmitter-udp) address port data)
(socket-send (socket transmitter)
(encode-osc-data data) nil
:address (list address port))))
(defgeneric send-msg-to (transmitter address port command &rest args)
(:method ((transmitter osc-transmitter-udp) address port command
&rest args)
(let ((message (make-message command args)))
(send-to transmitter address port message))))
(defgeneric send-bundle-to (transmitter address port timetag command
&rest args)
(:method ((transmitter osc-transmitter-udp) address port timetag
command &rest args)
(let ((bundle (bundle timetag
(make-message command args))))
(send-to transmitter address port bundle))))

66
osc-data.lisp Normal file
View file

@ -0,0 +1,66 @@
(cl:in-package #:osc)
;; Classes
(defclass osc-data () ())
(defclass message (osc-data)
((command
:reader command
:initarg :command)
(args
:reader args
:initarg :args
:initform nil)))
(defclass bundle (osc-data)
((timetag
:reader timetag
:initarg :timetag
:initform :now)
(elements
:reader elements
:initarg :elements
:initform nil)))
;; Constructors
(defun make-message (command args)
(unless (listp args)
(setf args (list args)))
(make-instance 'message
:command command
:args args))
(defun message (command &rest args)
(make-message command args))
(defun make-bundle (timetag elements)
(unless (listp elements)
(setf elements (list elements)))
(make-instance 'bundle
:timetag timetag
:elements elements))
(defun bundle (timetag &rest elements)
(make-bundle timetag elements))
(defgeneric format-osc-data (data &key stream width))
(defmethod format-osc-data ((message message) &key (stream t)
(width 80))
(let ((args-string (format nil "~{~a~^ ~}" (args message))))
(when (> (length args-string) width)
(setf args-string
(concatenate 'string
(subseq args-string 0 width)
"...")))
(format stream "~a ~a~%"
(command message)
args-string)))
(defmethod format-osc-data ((bundle bundle) &key (stream t) (width 80))
(format stream "~&[ ~a~%" (timetag bundle))
(dolist (element (elements bundle))
(format-osc-data element :stream stream :width width))
(format stream "~&]~%"))

57
osc-dispatch.lisp
View file

@ -1,14 +1,14 @@
;; -*- mode: lisp -*-
;;
;; patern matching and dispatching for OSC messages
;; patern matching and dispatching for OSC messages
;;
;; copyright (C) 2004 FoAM vzw
;;
;; You are granted the rights to distribute and use this software
;; under the terms of the Lisp Lesser GNU Public License, known
;; as the LLGPL. The LLGPL consists of a preamble and the LGPL.
;; under the terms of the Lisp Lesser GNU Public License, known
;; as the LLGPL. The LLGPL consists of a preamble and the LGPL.
;; Where these conflict, the preamble takes precedence. The LLGPL
;; is available online at http://opensource.franz.com/preamble.html
;; is available online at http://opensource.franz.com/preamble.html
;; and is distributed with this code (see: LICENCE and LGPL files)
;;
@ -17,15 +17,15 @@
;; requirements
;; - not too useful without osc
;; - probably cl-pcre for matching (when it happens).
;; - probably cl-pcre for matching (when it happens).
;; commentary
;; an osc de-/re -mungulator which should deal with piping data
;; from incoming messages to the function/handler/method
;; designated by the osc-address.
;; designated by the osc-address.
;;
;; NOTE: only does direct matches for now, no pattern globs,
;; with single function per uri
;; with single function per uri
;; changes
;; 2005-02-27 18:31:01
@ -42,31 +42,46 @@
;;; ;; ;;;;;; ; ; ; ;
;;
;; register/delete and dispatch. ..
;;
;;;; ; ; ; ;;
;; register/delete and dispatch. ..
;;
;;;; ; ; ; ;;
(defun dp-register (tree address function)
"registers a function to respond to incoming osc message. since
"Registers a function to respond to incoming osc messages. Since
only one function should be associated with an address, any
previous registration will be overwritten"
previous registration will be overwritten."
(setf (gethash address tree)
function))
function))
(defun dp-remove (tree address)
"removes the function associated with the given address.."
"Removes the function associated with the given address."
(remhash address tree))
(defun dp-match (tree pattern)
"returns a list of functions which are registered for
dispatch for a given address pattern.."
"Returns a list of functions which are registered for dispatch for a
given address pattern."
(list (gethash pattern tree)))
(defun dispatch (tree osc-message)
"calls the function(s) matching the address(pattern) in the osc
message with the data contained in the message"
(let ((pattern (car osc-message)))
(defgeneric dispatch (tree data device address port &optional timetag
parent-bundle))
(defmethod dispatch (tree (data message) device address port &optional
timetag
parent-bundle)
"Calls the function(s) matching the address(pattern) in the osc
message passing the message object, the recieving device, and
optionally in the case where a message is part of a bundle, the
timetag of the bundle and the enclosing bundle."
(let ((pattern (command data)))
(dolist (x (dp-match tree pattern))
(unless (eq x NIL)
(apply #'x (cdr osc-message))))))
(funcall x (command data) (args data) device address port
timetag parent-bundle)))))
(defmethod dispatch (tree (data bundle) device address port &optional
timetag
parent-bundle)
"Dispatches each bundle element in sequence."
(declare (ignore timetag parent-bundle))
(dolist (element (elements data))
(dispatch tree element device address port (timetag data) data)))

110
osc-examples.lisp
View file

@ -5,7 +5,7 @@
;; Copyright (C) 2004 FoAM vzw
;;
;; Authors
;; - nik gaffney <nik@f0.am>
;; - nik gaffney <nik@fo.am>
;;
;;;;; ;; ; ; ;; ; ;
@ -17,76 +17,72 @@
;; work with trivial-sockets, acl-compat or something similar. They should be
;; able to explain enough to get you started. ..
;;
;; eg. listen on port 6667 for incoming msgs
;; eg. listen on port 6667 for incoming messages
;;
;; (osc-receive-test 6667)
;; eg. send a test message to localhost port 6668
;;
;; (osc-send-test #(127 0 0 1) 6668)
;; (osc-listen 6667)
;;
;; eg. listen on port 6667 and send to 10.0.89:6668
;; note the ip# is formatted as a vector
;;
;; (osc-reflector-test 6667 #(10 0 0 89) 6668)
;; (osc-reflector 6667 #(10 0 0 89) 6668)
;;
;;;;;:::;;: ; ; ;::: ; ;; ;; ; ;; ;
(eval-when (:compile-toplevel :load-toplevel)
(ql:quickload :osc)
(ql:quickload :usocket)
(defpackage osc-examples (:use :cl :osc :usocket)))
(in-package :osc-examples)
(require :sb-bsd-sockets)
(use-package :osc)
(use-package :sb-bsd-sockets)
(defun osc-receive-test (port)
"a basic test function which attempts to decode an osc message on given port.
note ip#s need to be in the format #(127 0 0 1) for now.. ."
(let ((s (socket-connect nil nil
:local-port port
:local-host #(127 0 0 1)
:protocol :datagram
:element-type '(unsigned-byte 8)))
(buffer (make-sequence '(vector (unsigned-byte 8)) 1024)))
(defun osc-listen (port)
"a basic test function which attempts to decode an osc message a given port."
(let ((s (make-udp-socket))
(buffer (make-sequence '(vector (unsigned-byte 8)) 1024)))
(socket-bind s #(0 0 0 0) port)
(format t "listening on localhost port ~A~%~%" port)
(unwind-protect
(loop do
(socket-receive s buffer (length buffer))
(format t "received -=> ~S~%" (osc:decode-bundle buffer)))
(loop do
(socket-receive s buffer nil)
(format t "receiveded -=> ~S~%" (osc:decode-bundle buffer)))
(when s (socket-close s)))))
(defun osc-send-test (host port)
"a basic test function which sends osc test message to a given port/hostname.
note ip#s need to be in the format #(127 0 0 1) for now.. ."
(let ((s (socket-connect host port
:protocol :datagram
:element-type '(unsigned-byte 8)))
(b (osc:encode-message "/foo/bar" "baz" 1 2 3 (coerce PI 'single-float))))
(format t "sending to ~a on port ~A~%~%" host port)
(unwind-protect
(socket-send s b (length b))
(when s (socket-close s)))))
(defun osc-reflector-test (listen-port send-host send-port)
(defun osc-reflector (listen-port send-ip send-port)
"reflector.. . listens on a given port and sends out on another
note ip#s need to be in the format #(127 0 0 1) for now.. ."
(let ((in (socket-connect nil nil
:local-port listen-port
:local-host #(127 0 0 1)
:protocol :datagram
:element-type '(unsigned-byte 8)))
(out (socket-connect send-host send-port
:protocol :datagram
:element-type '(unsigned-byte 8)))
(buffer (make-sequence '(vector (unsigned-byte 8)) 1024)))
(unwind-protect
(loop do
(socket-receive in buffer (length buffer))
(format t "glonked -=> message: ~{~A, ~}~%"
(osc:decode-bundle buffer))
(let ((mess (apply #'osc:encode-message
(cons "/echo"
(osc:decode-message buffer)))))
(socket-send out mess (length mess))))
(when in (socket-close in))
(when out (socket-close out)))))
note ip#s need to be in the format #(127 0 0 1) for now.. ."
(let ((in (make-udp-socket))
(out (make-udp-socket))
(buffer (make-sequence '(vector (unsigned-byte 8)) 512)))
(socket-bind in #(0 0 0 0) listen-port)
(socket-connect out send-ip send-port)
(let ((stream
(socket-make-stream
out :input t :output t
:element-type '(unsigned-byte 8) :buffering :full)))
(unwind-protect
(loop do
(socket-receive in buffer nil)
(let ((oscuff (osc:decode-bundle buffer)))
(format t "glonked -=> message with ~S~% arg(s)"
(length oscuff))
(write-stream-t1 stream oscuff)))
(when in (socket-close in))
(when out (socket-close out))))))
(defun make-udp-socket()
(make-instance 'inet-socket :type :datagram :protocol :udp))
(defun write-stream-t1 (stream osc-message)
"writes a given message to a stream. keep in mind that when using a
buffered stream any funtion writing to the stream should
call (finish-output stream) after it sends the mesages,. ."
(write-sequence
(osc:encode-message "/bzzp" "got" "it" )
stream)
(finish-output stream))
(defmacro osc-write-to-stream (stream &body args)
`(progn (write-sequence (osc:encode-message ,@args) ,stream)
(finish-output ,stream)))
;end

77
osc-time.lisp Normal file
View file

@ -0,0 +1,77 @@
(in-package #:osc)
(defconstant +unix-epoch+ (encode-universal-time 0 0 0 1 1 1970 0))
(defconstant +2^32+ (expt 2 32))
(defconstant +2^32/million+ (/ +2^32+ (expt 10 6)))
(defconstant +usecs+ (expt 10 6))
(deftype timetag () '(unsigned-byte 64))
(defun timetagp (object)
(typep object 'timetag))
(defun unix-secs+usecs->timetag (secs usecs)
(let ((sec-offset (+ secs +unix-epoch+))) ; Seconds from 1900.
(setf sec-offset (ash sec-offset 32)) ; Make seconds the top 32
; bits.
(let ((usec-offset
(round (* usecs +2^32/MILLION+)))) ; Fractional part.
(the timetag (+ sec-offset usec-offset)))))
(defun get-current-timetag ()
"Returns a fixed-point 64 bit NTP-style timetag, where the top 32
bits represent seconds since midnight 19000101, and the bottom 32 bits
represent the fractional parts of a second."
(multiple-value-bind (secs usecs)
(sb-ext:get-time-of-day)
(the timetag (unix-secs+usecs->timetag secs usecs))))
(defun timetag+ (original seconds-offset)
(declare (type timetag original))
(let ((offset (round (* seconds-offset +2^32+))))
(the timetag (+ original offset))))
;;;=====================================================================
;;; Functions for using double-float unix timestamps.
;;;=====================================================================
(defun get-unix-time ()
"Returns a a double-float representing real-time now in seconds,
with microsecond precision, relative to 19700101."
(multiple-value-bind (secs usecs)
(sb-ext:get-time-of-day)
(the double-float (+ secs (microseconds->subsecs usecs)))))
(defun unix-time->timetag (unix-time)
(multiple-value-bind (secs subsecs)
(floor unix-time)
(the timetag
(unix-secs+usecs->timetag secs
(subsecs->microseconds subsecs)))))
(defun timetag->unix-time (timetag)
(if (= timetag 1)
1 ; immediate timetag
(let* ((secs (ash timetag -32))
(subsec-int32 (- timetag (ash secs 32))))
(the double-float (+ (- secs +unix-epoch+)
(int32->subsecs subsec-int32))))))
(defun microseconds->subsecs (usecs)
(declare (type (integer 0 1000000) usecs))
(coerce (/ usecs +usecs+) 'double-float))
(defun subsecs->microseconds (subsecs)
(declare (type (float 0 1) subsecs))
(round (* subsecs +usecs+)))
(defun int32->subsecs (int32)
"This maps a 32 bit integer, representing subsecond time, to a
double float in the range 0-1."
(declare (type (unsigned-byte 32) int32))
(coerce (/ int32 +2^32+) 'double-float))
(defun print-as-double (time)
(format t "~%~F" (coerce time 'double-float))
time)

28
osc.asd
View file

@ -1,11 +1,31 @@
;; -*- mode: lisp -*-
(in-package #:asdf)
(in-package #:common-lisp-user)
(defsystem osc
(asdf:defsystem osc
:name "osc"
:author "nik gaffney <nik@fo.am>"
:licence "LLGPL"
:description "The Open Sound Control protocol, aka OSC"
:version "0.5"
:components ((:file "osc")))
:version "0.6"
:components
((:file "osc" :depends-on ("osc-data" "osc-time"))
(:file "osc-data" :depends-on ("package"))
(:file "osc-dispatch" :depends-on ("osc"))
(:file "osc-time" :depends-on ("package"))
(:file "package")
(:module "devices"
:depends-on ("package" "osc-data")
::components
((:file "socket-functions")
(:file "device")
(:file "transmitter"
:depends-on ("device"
"socket-functions"))
(:file "listening-device"
:depends-on ("transmitter"))
(:file "dispatching-device"
:depends-on ("listening-device"))
(:file "client"
:depends-on ("dispatching-device"))
(:file "server" :depends-on ("client"))))))

526
osc.lisp
View file

@ -2,33 +2,33 @@
;;;
;;; an implementation of the OSC (Open Sound Control) protocol
;;;
;;; copyright (C) 2004 FoAM vzw.
;;; copyright (C) 2004 FoAM vzw.
;;;
;;; You are granted the rights to distribute and use this software
;;; under the terms of the Lisp Lesser GNU Public License, known
;;; as the LLGPL. The LLGPL consists of a preamble and the LGPL.
;;; under the terms of the Lisp Lesser GNU Public License, known
;;; as the LLGPL. The LLGPL consists of a preamble and the LGPL.
;;; Where these conflict, the preamble takes precedence. The LLGPL
;;; is available online at http://opensource.franz.com/preamble.html
;;; is available online at http://opensource.franz.com/preamble.html
;;; and is distributed with this code (see: LICENCE and LGPL files)
;;;
;;; authors
;;; authors
;;;
;;; nik gaffney <nik@f0.am>
;;;
;;; requirements
;;;
;;; dependent on sbcl, cmucl or openmcl for float encoding, other suggestions
;;; welcome.
;;; welcome.
;;;
;;; commentary
;;;
;;; this is a partial implementation of the OSC protocol which is used
;;; for communication mostly amongst music programs and their attatched
;;; musicians. eg. sc3, max/pd, reaktor/traktorska etc+. more details
;;; of the protocol can be found at the open sound control pages -=>
;;; musicians. eg. sc3, max/pd, reaktor/traktorska etc+. more details
;;; of the protocol can be found at the open sound control pages -=>
;;; http://www.cnmat.berkeley.edu/OpenSoundControl/
;;;
;;; - doesnt send nested bundles or timetags later than 'now'
;;;
;;; - doesnt send nested bundles or timetags later than 'now'
;;; - malformed input -> exception
;;; - int32 en/de-coding based on code (c) Walter C. Pelissero
;;; - unknown types are sent as 'blobs' which may or may not be an issue
@ -40,49 +40,54 @@
;;; an error
;;;
(defpackage :osc
(:use :cl)
(:documentation "OSC aka the 'open sound control' protocol")
(:export :encode-message
:encode-bundle
:decode-message
:decode-bundle))
(in-package :osc)
;(declaim (optimize (speed 3) (safety 1) (debug 3)))
;;(declaim (optimize (speed 3) (safety 1) (debug 3)))
;;;;;; ; ;; ; ; ; ; ; ; ;
;;
;;
;; eNcoding OSC messages
;;
;;;; ;; ;; ; ; ;; ; ; ; ;
(defun encode-bundle (data &optional timetag)
"will encode an osc message, or list of messages as a bundle
with an optional timetag (symbol or 64bit int).
doesnt handle nested bundles"
(cat '(35 98 117 110 100 108 101 0) ; #bundle
(if timetag
(encode-timetag timetag)
(encode-timetag :now))
(if (listp (car data))
(apply #'cat (mapcar #'encode-bundle-elt data))
(encode-bundle-elt data))))
(defparameter *debug* 0
"Set debug verbosity for core library functions. Currently levels
are 0-3.")
(defun encode-bundle-elt (data)
(let ((message (apply #'encode-message data)))
(cat (encode-int32 (length message)) message)))
(defgeneric encode-osc-data (data))
(defun encode-message (address &rest data)
"encodes an osc message with the given address and data."
(concatenate '(vector (unsigned-byte 8))
(encode-address address)
(encode-typetags data)
(encode-data data)))
(defmethod encode-osc-data ((data message))
"Encode an osc message with the given address and args."
(with-slots (command args) data
(concatenate '(vector (unsigned-byte 8))
(encode-address command)
(encode-typetags args)
(encode-args args))))
(defmethod encode-osc-data ((data bundle))
"Encode an osc bundle. A bundle contains a timetag (symbol or 64bit
int) and a list of message or nested bundle elements."
(with-slots (timetag elements) data
(cat '(35 98 117 110 100 108 101 0) ; #bundle
(if timetag
(encode-timetag timetag)
(encode-timetag :now))
(apply #'cat (mapcar #'encode-bundle-elt elements)))))
(defgeneric encode-bundle-elt (data))
(defmethod encode-bundle-elt ((data message))
(let ((bytes (encode-osc-data data)))
(cat (encode-int32 (length bytes)) bytes)))
(defmethod encode-bundle-elt ((data bundle))
(let ((bytes (encode-osc-data data)))
(cat (encode-int32 (length bytes)) bytes)))
;; Auxilary functions
(defun encode-address (address)
(cat (map 'vector #'char-code address)
(cat (map 'vector #'char-code address)
(string-padding address)))
(defun encode-typetags (data)
@ -91,87 +96,146 @@
non-std extensions include ,{h|t|d|S|c|r|m|T|F|N|I|[|]}
see the spec for more details. ..
NOTE: currently handles the following tags
NOTE: currently handles the following tags
i => #(105) => int32
f => #(102) => float
s => #(115) => string
s => #(115) => string
b => #(98) => blob
h => #(104) => int64
and considers non int/float/string data to be a blob."
and considers non int/float/string data to be a blob."
(let ((lump (make-array 0 :adjustable t
:fill-pointer t)))
(let ((lump (make-array 0 :adjustable t
:fill-pointer t)))
(macrolet ((write-to-vector (char)
`(vector-push-extend
(char-code ,char) lump)))
(write-to-vector #\,)
(dolist (x data)
(dolist (x data)
(typecase x
(integer (if (>= x 4294967296) (write-to-vector #\h) (write-to-vector #\i)))
(float (write-to-vector #\f))
(simple-string (write-to-vector #\s))
(t (write-to-vector #\b)))))
(keyword (write-to-vector #\s))
(t (write-to-vector #\b)))))
(cat lump
(pad (padding-length (length lump))))))
(defun encode-data (data)
"encodes data in a format suitable for an OSC message"
(pad (padding-length (length lump))))))
(defun encode-args (args)
"encodes args in a format suitable for an OSC message"
(let ((lump (make-array 0 :adjustable t :fill-pointer t)))
(macrolet ((enc (f)
`(setf lump (cat lump (,f x)))))
(dolist (x data)
(dolist (x args)
(typecase x
(integer (if (>= x 4294967296) (enc encode-int64) (enc encode-int32)))
(float (enc encode-float32))
(simple-string (enc encode-string))
(t (enc encode-blob))))
(t (enc encode-blob))))
lump)))
;;;;;; ; ;; ; ; ; ; ; ; ;
;;
;;
;; decoding OSC messages
;;
;;; ;; ;; ; ; ; ; ; ;
(defun decode-bundle (data)
"decodes an osc bundle into a list of decoded-messages, which has
an osc-timetagas its first element"
(let ((contents '()))
(if (equalp 35 (elt data 0)) ; a bundle begins with '#'
(let ((timetag (subseq data 8 16))
(i 16)
(bundle-length (length data)))
(loop while (< i bundle-length)
do (let ((mark (+ i 4))
(size (decode-int32
(subseq data i (+ i 4)))))
(if (eq size 0)
(setf bundle-length 0)
(push (decode-bundle
(subseq data mark (+ mark size)))
contents))
(incf i (+ 4 size))))
(push timetag contents))
(decode-message data))))
(defun bundle-p (buffer &optional (start 0))
"A bundle begins with '#bundle' (8 bytes). The start argument should
index the beginning of a bundle in the buffer."
(= 35 (elt buffer start)))
(defun get-timetag (buffer &optional (start 0))
"Bytes 8-15 are the bundle timestamp. The start argument should
index the beginning of a bundle in the buffer."
(decode-timetag (subseq buffer
(+ 8 start)
(+ 16 start))))
(defun get-bundle-element-length (buffer &optional (start 16))
"Bytes 16-19 are the size of the bundle element. The start argument
should index the beginning of the bundle element (length, content)
pair in the buffer."
(decode-int32 (subseq buffer start (+ 4 start))))
(defun get-bundle-element (buffer &optional (start 16))
"Bytes 20 upto to the length of the content (defined by the
preceding 4 bytes) are the content of the bundle. The start argument
should index the beginning of the bundle element (length, content)
pair in the buffer."
(let ((length (get-bundle-element-length buffer start)))
(subseq buffer
(+ 4 start)
(+ (+ 4 start)
(+ length)))))
(defun split-sequence-by-n (sequence n)
(loop :with length := (length sequence)
:for start :from 0 :by n :below length
:collecting (coerce
(subseq sequence start (min length (+ start n)))
'list)))
(defun print-buffer (buffer &optional (n 8))
(format t "~%~{~{ ~5d~}~%~}Total: ~a bytes~2%"
(split-sequence-by-n buffer n)
(length buffer)))
(defun decode-bundle (buffer &key (start 0) end)
"Decodes an osc bundle/message into a bundle/message object. Bundles
comprise an osc-timetag and a list of elements, which may be
messages or bundles recursively. An optional end argument can be
supplied (i.e. the length value returned by socket-receive, or the
element length in the case of nested bundles), otherwise the entire
buffer is decoded - in which case, if you are reusing buffers, you
are responsible for ensuring that the buffer does not contain stale
data."
(unless end
(setf end (- (length buffer) start)))
(when (>= *debug* 2)
(format t "~%Buffer start: ~a end: ~a~%" start end)
(print-buffer (subseq buffer start end)))
(if (bundle-p buffer start)
;; Bundle
(let ((timetag (get-timetag buffer start)))
(incf start (+ 8 8)) ; #bundle, timetag bytes
(loop while (< start end)
for element-length = (get-bundle-element-length
buffer start)
do (incf start 4) ; length bytes
when (>= *debug* 1)
do (format t "~&Bundle element length: ~a~%" element-length)
collect (decode-bundle buffer
:start start
:end (+ start element-length))
into elements
do (incf start (+ element-length))
finally (return
(values (make-bundle timetag elements)
timetag))))
;; Message
(let ((message
(decode-message
(subseq buffer start (+ start end)))))
(make-message (car message) (cdr message)))))
(defun decode-message (message)
"reduces an osc message to an (address . data) pair. .."
"reduces an osc message to an (address . data) pair. .."
(declare (type (vector *) message))
(let ((x (position (char-code #\,) message)))
(if (eq x NIL)
(if (eq x nil)
(format t "message contains no data.. ")
(cons (decode-address (subseq message 0 x))
(decode-taged-data (subseq message x))))))
(cons (decode-address (subseq message 0 x))
(decode-taged-data (subseq message x))))))
(defun decode-address (address)
(coerce (map 'vector #'code-char
(delete 0 address))
'string))
(coerce (map 'vector #'code-char
(delete 0 address))
'string))
(defun decode-taged-data (data)
"decodes data encoded with typetags...
NOTE: currently handles the following tags
NOTE: currently handles the following tags
i => #(105) => int32
f => #(102) => float
s => #(115) => string
@ -179,90 +243,87 @@
h => #(104) => int64"
(let ((div (position 0 data)))
(let ((tags (subseq data 1 div))
(let ((tags (subseq data 1 div))
(acc (subseq data (padded-length div)))
(result '()))
(map 'vector
#'(lambda (x)
(cond
((eq x (char-code #\i))
(push (decode-int32 (subseq acc 0 4))
result)
(setf acc (subseq acc 4)))
((eq x (char-code #\h))
(push (decode-uint64 (subseq acc 0 8))
result)
(setf acc (subseq acc 8)))
((eq x (char-code #\f))
(push (decode-float32 (subseq acc 0 4))
result)
(setf acc (subseq acc 4)))
((eq x (char-code #\s))
(let ((pointer (padded-length (position 0 acc))))
(push (decode-string
(subseq acc 0 pointer))
result)
(setf acc (subseq acc pointer))))
((eq x (char-code #\b))
(let* ((size (decode-int32 (subseq acc 0 4)))
(bl (+ 4 size))
(end (+ bl (mod (- 4 bl) 4)))) ; NOTE: cannot use (padded-length bl), as it is not the same algorithm. Blobs of 4, 8, 12 etc bytes should not be padded!
(push (decode-blob (subseq acc 0 end))
result)
(setf acc (subseq acc end))))
(t (error "unrecognised typetag ~a" x))))
((eq x (char-code #\i))
(push (decode-int32 (subseq acc 0 4))
result)
(setf acc (subseq acc 4)))
((eq x (char-code #\h))
(push (decode-uint64 (subseq acc 0 8))
result)
(setf acc (subseq acc 8)))
((eq x (char-code #\f))
(push (decode-float32 (subseq acc 0 4))
result)
(setf acc (subseq acc 4)))
((eq x (char-code #\s))
(let ((pointer (padded-length (position 0 acc))))
(push (decode-string
(subseq acc 0 pointer))
result)
(setf acc (subseq acc pointer))))
((eq x (char-code #\b))
(let* ((size (decode-int32 (subseq acc 0 4)))
(bl (+ 4 size))
(end (+ bl (mod (- 4 bl) 4))))
;; NOTE: cannot use (padded-length bl), as it is not the same algorithm.
;; Blobs of 4, 8, 12 etc bytes should not be padded!
(push (decode-blob (subseq acc 0 end))
result)
(setf acc (subseq acc end))))
(t (error "unrecognised typetag ~a" x))))
tags)
(nreverse result))))
;;;;;; ;; ;; ; ; ; ; ; ;; ;
;;
;;
;; timetags
;;
;; - timetags can be encoded using a value, or the :now and :time keywords. the
;; keywords enable either a tag indicating 'immediate' execution, or
;; a tag containing the current time (which will most likely be in the past
;; of anyt receiver) to be created.
;;
;; - note: not well tested, and probably not accurate enough for syncronisation.
;; see also: CLHS 25.1.4 Time, and the ntp timestamp format. also needs to
;; convert from 2 32bit ints to 64bit fixed point value.
;; - timetags can be encoded using a value, or the :now and :time
;; keywords. the keywords enable either a tag indicating 'immediate'
;; execution, or a tag containing the current time (which will most
;; likely be in the past of any receiver) to be created.
;;
;; - see this c.l.l thread to sync universal-time and internal-time
;; http://groups.google.com/group/comp.lang.lisp/browse_thread/thread/c207fef63a78d720/adc7442d2e4de5a0?lnk=gst&q=internal-real-time-sync&rnum=1#adc7442d2e4de5a0
;; - In SBCL, using sb-ext:get-time-of-day to get accurate seconds and
;; microseconds from OS.
;;
;;;; ;; ; ;
;;;; ;; ; ;
(defconstant +unix-epoch+ (encode-universal-time 0 0 0 1 1 1970 0))
(defun encode-timetag (utime &optional subseconds)
"encodes an osc timetag from a universal-time and 32bit 'sub-second' part.
for an 'instantaneous' timetag use (encode-timetag :now)
for a timetag with the current time use (encode-timetag :time)"
(defun encode-timetag (timetag)
"From the spec: `Time tags are represented by a 64 bit fixed point
number. The first 32 bits specify the number of seconds since midnight
on January 1, 1900, and the last 32 bits specify fractional parts of a
second to a precision of about 200 picoseconds. This is the
representation used by Internet NTP timestamps'. For an
'instantaneous' timetag use (encode-timetag :now), and for a timetag
with the current time use (encode-timetag :time)."
(cond
;; a 1bit timetag will be interpreted as 'imediately'
((equalp utime :now)
#(0 0 0 0 0 0 0 1))
;; converts seconds since 19000101 to seconds since 19700101
;; note: fractions of a second is accurate, but not syncronised.
((equalp utime :time)
(cat (encode-int32 (- (get-universal-time) +unix-epoch+))
(encode-int32
(round (* internal-time-units-per-second
(second (multiple-value-list
(floor (/ (get-internal-real-time)
internal-time-units-per-second)))))))))
((integerp utime)
(cat (encode-int32 (+ utime +unix-epoch+))
(encode-int32 subseconds)))
(t (error "the time or subsecond given is not an integer"))))
((equalp timetag :now)
;; a 1 bit timetag will be interpreted as 'immediately'
#(0 0 0 0 0 0 0 1))
((equalp timetag :time)
;; encode timetag with current real time
(encode-int64 (get-current-timetag)))
((timetagp timetag)
;; encode osc timetag
(encode-int64 timetag))
(t (error "Argument given is not one of :now, :time, or timetagp."))))
(defun decode-timetag (timetag)
"decomposes a timetag into unix-time and a subsecond,. . ."
(list
(decode-int32 (subseq timetag 0 4))
(decode-int32 (subseq timetag 4 8))))
"Return a 64 bit timetag from a vector of 8 bytes in network byte
order."
(if (equalp timetag #(0 0 0 0 0 0 0 1))
1 ; A timetag of 1 is defined as immediately.
(decode-uint64 timetag)))
;;;;; ; ; ;; ;; ; ;
;;
@ -271,15 +332,15 @@
;;; ;; ; ; ;
;; floats are encoded using implementation specific 'internals' which is not
;; particulaly portable, but 'works for now'.
;; particulaly portable, but 'works for now'.
(defun encode-float32 (f)
"encode an ieee754 float as a 4 byte vector. currently sbcl/cmucl specifc"
"encode an ieee754 float as a 4 byte vector. currently sbcl/cmucl specific"
#+sbcl (encode-int32 (sb-kernel:single-float-bits f))
#+cmucl (encode-int32 (kernel:single-float-bits f))
#+openmcl (encode-int32 (CCL::SINGLE-FLOAT-BITS f))
#+allegro (encode-int32 (multiple-value-bind (x y) (excl:single-float-to-shorts f)
(+ (ash x 16) y)))
(+ (ash x 16) y)))
#-(or sbcl cmucl openmcl allegro) (error "cant encode floats using this implementation"))
(defun decode-float32 (s)
@ -288,88 +349,127 @@
#+cmucl (kernel:make-single-float (decode-int32 s))
#+openmcl (CCL::HOST-SINGLE-FLOAT-FROM-UNSIGNED-BYTE-32 (decode-uint32 s))
#+allegro (excl:shorts-to-single-float (ldb (byte 16 16) (decode-int32 s))
(ldb (byte 16 0) (decode-int32 s)))
(ldb (byte 16 0) (decode-int32 s)))
#-(or sbcl cmucl openmcl allegro) (error "cant decode floats using this implementation"))
(defmacro defint-decoder (num-of-octets &optional docstring)
(let ((decoder-name (intern (format nil "~:@(decode-uint~)~D" (* 8 num-of-octets))))
(seq (gensym))
(int (gensym)))
`(defun ,decoder-name (,seq)
,@(when docstring
(list docstring))
(let* ((,int 0)
,@(loop
for n below num-of-octets
collect `(,int (dpb (aref ,seq ,n) (byte 8 (* 8 (- (1- ,num-of-octets) ,n)))
,int))))
,int))))
(defint-decoder 4 "4 byte -> 32 bit unsigned int")
(defint-decoder 8 "8 byte -> 64 bit unsigned int")
(defmacro defint-encoder (num-of-octets &optional docstring)
(let ((enc-name (intern (format nil "~:@(encode-int~)~D" (* 8 num-of-octets))))
(buf (gensym))
(int (gensym)))
`(defun ,enc-name (,int)
,@(when docstring
(list docstring))
(let ((,buf (make-array ,num-of-octets :element-type '(unsigned-byte 8))))
,@(loop
for n below num-of-octets
collect `(setf (aref ,buf ,n)
(ldb (byte 8 (* 8 (- (1- ,num-of-octets) ,n)))
,int)))
,buf))))
(defint-encoder 4 "Convert an integer into a sequence of 4 bytes in network byte order.")
(defint-encoder 8 "Convert an integer into a sequence of 8 bytes in network byte order.")
(defun encode-int32 (i)
"convert an integer into a sequence of 4 bytes in network byte order."
(declare (type integer i))
(let ((buf (make-sequence
'(vector (unsigned-byte 8)) 4)))
(macrolet ((set-byte (n)
`(setf (elt buf ,n)
(logand #xff (ash i ,(* 8 (- n 3)))))))
(set-byte 0)
(set-byte 1)
(set-byte 2)
(set-byte 3))
buf))
(defun decode-int32 (s)
"4 byte -> 32 bit int -> two's complement (in network byte order)"
(let ((i (decode-uint32 s)))
(if (>= i #.(1- (expt 2 31)))
(- (- #.(expt 2 32) i))
i)))
"4 byte -> 32 bit int -> two's compliment (in network byte order)"
(let ((i (+ (ash (elt s 0) 24)
(ash (elt s 1) 16)
(ash (elt s 2) 8)
(elt s 3))))
(if (>= i #x7fffffff)
(- 0 (- #x100000000 i))
i)))
(defun decode-uint32 (s)
"4 byte -> 32 bit unsigned int"
(let ((i (+ (ash (elt s 0) 24)
(ash (elt s 1) 16)
(ash (elt s 2) 8)
(elt s 3))))
i))
(defun encode-int64 (i)
"convert an integer into a sequence of 8 bytes in network byte order."
(declare (type integer i))
(let ((buf (make-sequence
'(vector (unsigned-byte 8)) 8)))
(macrolet ((set-byte (n)
`(setf (elt buf ,n)
(logand #xff (ash i ,(* 8 (- n 7)))))))
(set-byte 0)
(set-byte 1)
(set-byte 2)
(set-byte 3)
(set-byte 4)
(set-byte 5)
(set-byte 6)
(set-byte 7))
buf))
(defun decode-uint64 (s)
"8 byte -> 64 bit unsigned int"
(let ((i (+ (ash (elt s 0) 56)
(ash (elt s 1) 48)
(ash (elt s 2) 40)
(ash (elt s 3) 32)
(ash (elt s 4) 24)
(ash (elt s 5) 16)
(ash (elt s 6) 8)
(elt s 7))))
i))
(defun decode-int64 (s)
"8 byte -> 64 bit int -> two's complement (in network byte order)"
(let ((i (decode-uint64 s)))
(if (>= i #.(1- (expt 2 63)))
(- (- #.(expt 2 64) i))
i)))
"8 byte -> 64 bit int -> two's compliment (in network byte order)"
(let ((i (+ (ash (elt s 0) 56)
(ash (elt s 1) 48)
(ash (elt s 2) 40)
(ash (elt s 3) 32)
(ash (elt s 4) 24)
(ash (elt s 5) 16)
(ash (elt s 6) 8)
(elt s 7))))
(if (>= i #x7fffffffffffffff)
(- 0 (- #x10000000000000000 i))
i)))
;; osc-strings are unsigned bytes, padded to a 4 byte boundary
;; osc-strings are unsigned bytes, padded to a 4 byte boundary
(defun encode-string (string)
"encodes a string as a vector of character-codes, padded to 4 byte boundary"
(cat (map 'vector #'char-code string)
(string-padding string)))
(ash (elt s 1) 48)
(ash (elt s 2) 40)
(ash (elt s 3) 32)
(ash (elt s 4) 24)
(ash (elt s 5) 16)
(ash (elt s 6) 8)
(elt s 7))))
i))
(defun decode-string (data)
"converts a binary vector to a string and removes trailing #\nul characters"
(string-trim '(#\nul) (coerce (map 'vector #'code-char data) 'string)))
(defun encode-string (string)
"encodes a string as a vector of character-codes, padded to 4 byte boundary"
(cat (map 'vector #'char-code string)
(string-padding string)))
;; blobs are binary data, consisting of a length (int32) and bytes which are
;; osc-padded to a 4 byte boundary.
(defun decode-blob (blob)
"decode a blob as a vector of unsigned bytes."
(let ((size (decode-int32
(subseq blob 0 4))))
(subseq blob 4 (+ 4 size))))
(defun encode-blob (blob)
"encodes a blob from a given vector"
(let ((bl (length blob)))
(cat (encode-int32 bl) blob
(pad (mod (- 4 bl) 4))))) ; NOTE: cannot use (padding-length bl), as it is not the same algorithm. Blobs of 4, 8, 12 etc bytes should not be padded!
<<<<<<< HEAD
(pad (padding-length bl)))))
(defun decode-blob (blob)
"decode a blob as a vector of unsigned bytes."
(let ((size (decode-int32
(subseq blob 0 4))))
(subseq blob 4 (+ 4 size))))
;; utility functions for osc-string/padding slonking
(defun cat (&rest catatac)
(apply #'concatenate '(vector *) catatac))
(apply #'concatenate '(vector (unsigned-byte 8)) catatac))
(defun padding-length (s)
"returns the length of padding required for a given length of string"
@ -383,7 +483,7 @@
(defun string-padding (string)
"returns the padding required for a given osc string"
(declare (type simple-string string))
(declare (type simple-string string))
(pad (padding-length (length string))))
(defun pad (n)

80
package.lisp Normal file
View file

@ -0,0 +1,80 @@
(defpackage :osc
(:use :cl :sb-bsd-sockets)
(:documentation "OSC aka the 'open sound control' protocol")
(:export
#:make-message
#:message
#:make-bundle
#:bundle
#:format-osc-data
#:command
#:args
#:timetag
#:elements
#:encode-message
#:encode-bundle
#:decode-message
#:decode-bundle
#:make-osc-tree
#:dp-register
#:dp-remove
#:dp-match
#:dispatch
#:get-current-timetag ; osc-time
#:timetag+
#:get-unix-time
#:unix-time->timetag
#:timetag->unix-time
#:print-as-double
#:osc-transmitter ; osc-devices
#:osc-transmitter-udp
#:osc-client
#:osc-client-udp
#:osc-client-tcp
#:osc-server
#:osc-server-udp
#:osc-server-tcp
#:protocol
#:name
#:buffer-size
#:quit
#:osc-device-cleanup
#:make-listening-thread ; listening
#:add-osc-responder ; dispatching
#:remove-osc-responder
#:make-osc-transmitter ; transmitters
#:connect
#:send
#:send-msg
#:send-bundle
#:send-to
#:send-msg-to
#:send-bundle-to
#:send-all
#:send-msg-all
#:send-bundle-all
#:make-osc-client ; clients
#:make-client-responders
#:register
#:make-osc-server ; servers
#:boot
#:make-server-responders
#:register-udp-client
#:unregister-udp-client
#:register-tcp-client
#:unregister-tcp-client
#:post-register-hook
#:get-tcp-client
#:print-clients
#:send-to-client
#:send-bundle-to-client
#:*default-osc-buffer-size* ; sockets
#:make-name-string
#:device-active-p
#:device-socket-name
#:address
#:port
#:peer-address
#:peer-port))