interpreter/preprocessor/faust-0.9.47mr3/architecture/osclib/faust/readme.txt

   1 =================================================================
   2                          FAUST OSC Library
   3
   4                      Copyright (c) 2011 Grame
   5 =================================================================
   6
   7 -----------------------------------------------------------------
   8     Note about the OSC messages and address space
   9 -----------------------------------------------------------------
  10 The OSC address space adheres strictly to the hierarchy defined by
  11 the 'addnode' and 'opengroup' calls.
  12 A node expects to receive OSC messages with a single float value
  13 as parameter. This policy is strict for the parameters count, but
  14 relaxed for the parameter type: OSC int values are accepted and
  15 casted to float.
  16
  17 *** 'get' message ***
  18 The library provides a simple support for querying the system with
  19 a 'get' message that can be sent to any valid OSC address.
  20 The 'get' message is propagated to every terminal node that responds
  21 with its osc address and current values (value, min and max).
  22
  23 *** 'hello' message ***
  24 The library provides a simple support for modules discovery with a
  25 'hello' message that can be sent to any module root address. The module
  26 responds with its root address, followed by its IP address, followed
  27 by the UDP ports numbers (listening port, output port, error port).
  28 See the note about network management below for ports numbering scheme.
  29
  30
  31 -----------------------------------------------------------------
  32     Note about network management
  33 -----------------------------------------------------------------
  34 The default UDP ports are chosen in an unassigned range
  35 see IANA PORT NUMBERS (last updated 2011-01-24)
  36 at http://www.iana.org/assignments/port-numbers
  37 As of today (jan. 27 2011), the range 5507-5552 is unassigned
  38 and the default ports numbers are:
  39  - 5510 for listening UDP port
  40  - 5511 for the osc output port
  41  - 5512 for the osc error port
  42
  43 *** Changing the ports numbers with the command line ***
  44 An OSCControler object takes the command line arguments as constructor
  45 parameters. It supports the following options to change the UDP ports
  46 numbers:
  47         [-port | -outport | -errport] number
  48
  49 *** Dynamic UDP listening port allocation ***
  50 When the UDP listening port number is busy, the system automatically
  51 looks for the next available port number. Unless otherwise specified
  52 by the command line, the UDP output port numbers are unchanged and
  53 the system sends the allocated ports numbers on the osc output port
  54 on startup.
  55
  56 *** Destination address ***
  57 The default UDP output streams destination is 'localhost'. It can be
  58 changed with a command line option:
  59    -dest address
  60 where address is a host name os an IP number.
  61