root/oscpack/tags/pre_svn_snapshot_2005_06_13_1735/README

Revision 5, 2.1 kB (checked in by ross, 3 years ago)

commiting most recent pre-svn oscpack version. Main change is new networking classes with new unified UdpSocket? class, support for listening to multiple sockets. New IpEndpointName? class for refering to endpoints by name, ip address etc.

  • Property svn:eol-style set to native
Line 
1 oscpack -- Open Sound Control packet manipulation library
2 http://www.audiomulch.com/~rossb/code/oscpack
3
4 Copyright (c) 2004-2005 Ross Bencina <rossb@audiomulch.com>
5
6 A simple C++ library for packing and unpacking OSC packets.
7
8
9 Oscpack is simply a set of C++ classes for packing and unpacking OSC packets.
10 Oscpack is not a networking library, or a framework for bulding OSC
11 applications. Simple classes for UDP networking are included, but you are
12 encouraged to use another networking framework. The library should also be
13 easy to use for other transport methods (eg serial).
14
15 The key goals of this library are:
16
17         - to be a simple and complete implementation of OSC
18         - to be portable to a wide variety of platforms
19         - to allow easy development of robust OSC applications
20                 (for example it should be impossible to crash a server
21                  by sending it malformed packets, and difficult to
22                  create malformed packets.)
23
24 Here's a summary of the key files:
25
26 OscReceivedElements -- classes for parsing a packet
27 OscPrintRecievedElements -- iostream << operators for printing packet elements
28 OscOutboundPacket -- a class for packing messages into a packet
29 OscPacketListener -- base class for listening to OSC packets on a UdpSocket
30 OscUnitTests -- unit test program for the OSC modules
31 OscDump -- a program that prints received OSC packets
32 OscSendTests -- examples of how to send messages
33 OscReceiveTest -- example of how to receive the messages sent by OSCSendTests
34
35 If you fix anything or write a set of TCP send/recieve classes
36 please consider sending me a patch. Thanks :)
37
38
39 For more information about Open Sound Control, see:
40 http://www.cnmat.berkeley.edu/OpenSoundControl/
41
42
43 Thanks to Till Bovermann for helping with POSIX networking code and
44 Mac compatibility, and to Martin Kaltenbrunner and the rest of the
45 reacTable team for giving me a reason to finish this library. Thanks
46 to Merlijn Blaauw for reviewing the interface.
47
48 Portions developed at the Music Technology Group, Audiovisual Institute,
49 University Pompeu Fabra, Barcelona, November 2004 - June 2005.
50
51 See the file LICENSE for information about distributing and using this code.
52
53
Note: See TracBrowser for help on using the browser.