drivers/netjack/README

   1
   2
   3
   4 see the updated docs on http://netjack.sf.net please.
   5
   6 or mail me (torbenh@gmx.de) if you have questions.
   7 this Release has the tightest jack sync ever :)
   8
   9                         ---  netJack    ---
  10                         -   v0.5pre1 2005    -
  11
  12 || AUTHORS(s):
  13
  14 Torben Hohn
  15 Dan Mills
  16 Robert Jonsson
  17
  18
  19 || CHANGES
  20
  21 cvs -th-
  22     fixed hardcoeded number of channels.
  23     started
  24
  25 cvs -th-
  26     added packet_hdr
  27     which needs to be htonled..
  28
  29 cvs -rj-
  30     added Sconstruct
  31     added htonl() usage for crossplatform communication.
  32
  33 0.41   - rj -
  34     added missing Makefile.am
  35     added some configurability to udpsync_source
  36
  37 0.4    - rj -
  38     support for stereo
  39     support for duplex
  40 ... older ... lost in time
  41
  42 || WHAT IS THIS?
  43
  44 jack_net is a backend driver for Jack that takes on the role of a
  45 sound card. This machine is generally designated as the slave machine.
  46
  47 jacknet_client is a jack application that shall be run from another
  48 computer with the ip adress of the other machine as argument. This
  49 machine is generalled designated as the master machine.
  50
  51
  52 || PREREQUISITES
  53
  54 Two machines with a _good_ network connection between them.
  55 A Jack (http://jackit.sf.net) source package.
  56
  57
  58 || INSTALLATION:
  59
  60 compile with
  61 scons jack_source_dir='path/to/jack-src'
  62
  63 this creates jack_net.so.
  64 copy this to /lib/jack/drivers or wherever jack looks for driver.so`s
  65
  66 it also creates jacknet_client. a normal program.
  67
  68 if you build on OSX you need to add
  69
  70 with_alsa=0
  71
  72
  73 || USAGE
  74
  75 The programs will open a bidirectional connection between the two
  76 machines (using UDP). Exposing a stereopair both ways.
  77
  78 The udpsync_source needs the slave machine as a parameter.
  79
  80 The alsa-client is a nice thing also, it makes a not jack related
  81 alsa-card available for capturing under jack.
  82
  83 Best performance is achieved if connecting the machines with an
  84  XOVER cable, omitting switches / hubs / other nasty things.
  85
  86 || KNOWN ISSUES
  87
  88 While running with full duplex, utilizing the slave machine as an
  89 outboard effect it seems very hard (atleast with my network with a
  90 cheap switch inbetween) to use buffers below 512. Sometimes 256
  91 is usable for a while.
  92 While connecting ports on the slave side it is very prone to
  93 crash if the buffers are small.
  94
  95 The jitter of a wlan network is a little too hard for the current
  96 sync code. A delay locked loop might be used soon.
  97
  98 There is always atleast one buffers delay if a port is routed back
  99 through the connection. This is a design issue that might be hard
 100 to remedy.
 101
 102
 103 || LICENSE
 104
 105 this is free software under the GPL license, see the file COPYING.
 106