WOscLib Code
Brought to you by:
cls-nebadje
Menu
▾
▴
Tree [d4d572] master / History
Uli Franke
Uli Franke
=
Read Me
# WOscLib, an object oriented OSC library.
# Copyright (C) 2005-2012 Uli Clemens Franke, Weiss Engineering LTD, Switzerland.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
# For details see COPYING
#
# Weiss Engineering LTD.
# Florastrasse 42
# 8610 Uster
# Switzerland
#
# uli.franke@weiss.ch
Some notes on how to get started with WOscLib.
## Building the distribution package ##########################################
To build the library from a distribution package run
./configure
make
sudo make install
See
./configure --help
for fine tuning. WOscLib has a built in test bench which can be run with
make test
## Cross-Compilation with MinGW under Linux ###################################
It is possible to X-compile WOscLib for Windows under Linux. The "build-mingw"
directory contains a script (cross-linux.sh) prepared for this very purpose.
## Building from the git repository ###########################################
The repository does not contain any automatically generated files. Therefore
you need the autotools package if you'd like to build wosclib from the git
sources. This is the classic way:
autoreconf
automake --add-missing
autoreconf
./configure
make
sudo make install
The more convenient way is to simply call
./autogen.sh
make
sudo make install
As autogen automatically calls ./configure you have to call ./configure
manually again if you'd like to use some non default options.
## BUILDING THE DOCUMENTATION #################################################
The source code is documented with doxygen comments. The doxygen documentation
contains some additional information as well. To generate the documentation
configure the library as depicted above. Then run
make html
The index page of the generated documentation is generated at
doc/html/index.html
## EXAMPLES ###################################################################
This distribution contains some examples which show some possible applications
of the library:
## woscudpserver ##
A simple UDP-based OSC server with a small address space.
woscudpserver [local port]
WOscServer's address space:
/hello Prints a "Hello World!" message plus all message parameters.
/echo Echos the message to its origin (which can be additionally
controlled by an integer parameter for the port and an string
for the IP where the message should be echoed to.
/exit Quits woscserver.
## woscudpclient ##
A simple UDP-based OSC client/server which can send OSC messages to any UDP
based OSC server. The messages can be send including integer, string and
floating-point parameters. The remote OSC server can be set as arguments or
at runtime. The local UDP port can be changed at runtime:
woscudpclient [local port] [remote port] [remote IP]
Commands controlling "woscclient":
help print help (which is probably more up to date than this document)
exit terminate "woscclient".
slp [port] set local UDP port to [port]
srp [port] set remote server UDP destination port to [port].
srip [ip] set remote server UDP destination IP to [ip].
whereas [ip] is an IP string in dotted decimal notation
(127.0.0.1).
/[msg] [params]
send an OSC message "/msg" to remote OSC server with
parameters [params]. [params] can be a space separated
list containing integers ( 666 ), floats ( 3.14 ) and
strings ( hello_world ).
[ Open a new bundle
] Close current bundle and transmit as soon the top level
bundle has been closed.
## wosctcpserver ##
An OSC server using TCP as transport layer.
## wosctcpclient ##
An OSC client using TCP as transport layer.
## IDEAS ######################################################################
## PREPARING A RELEASE ########################################################
Relevant to WOscLib maintainers only.
1. Increment version number in AC_INIT macro within configure.ac
2. Run autoreconf
3. Run ./configure
4. Run make dist-zip