DOCUMENTATION/README

   1                             ARDOUR README
   2
   3           Paul Davis <paul@linuxaudiosystems.com> June 2003
   4
   5 Welcome to Ardour.  This program is still very much under development,
   6 but has now reached the stage where it will be productive and useful
   7 to have other people testing it out and perhaps (hopefully!) fixing
   8 bugs and adding features.
   9
  10 **** SECURITY *******************************************************
  11
  12 To run Ardour with the lowest latencies, it's necessary to use POSIX
  13 Real-Time Scheduling as well as locking all the memory it uses into
  14 physical RAM.  These requirements can only be met if Ardour is run with
  15 root priviledges.
  16
  17 On the other hand, things are not so bad.  If you don't attempt to
  18 install it setuid root (which actually won't work anyway), then
  19 someone needs to have gained root access in order to run it like this.
  20 If they already have root access, Ardour is the least of your
  21 problems.  So relax.  We'll use capabilities once Linux kernels start
  22 arriving with them enabled, though this won't help too much with
  23 security, since the relevant capabilities would still allow a wiley
  24 cracker to do anything at all.
  25
  26 Alternatively, you can choose to run Ardour without RT scheduling, and
  27 then there's no concern at all.  It just won't be useful in low latency
  28 situations, which are desirable in most studio environments. Note that
  29 this is not so important if you have audio hardware that is capable of
  30 doing "hardware monitoring" - in this case, a lack of low latency will
  31 simply make response to Ardour's UI controls a little sluggish, but
  32 monitoring during capture will be excellent.
  33
  34 **** HARDWARE COMPATIBILITY *****************************************
  35
  36 Ardour uses JACK for all its audio I/O, thus providing seamless
  37 connections to both audio hardware and other applications. Its really
  38 not the right place to discuss JACK, but in case you are wondering:
  39
  40 Although JACK uses the ALSA 0.9.0 API, it exercises this API in a way
  41 that no other application to date has done, and it also tries to use
  42 certain hardware features that again, no other existing applications
  43 use.  As a result, although complete portability to all ALSA supported
  44 h/w is an eventual and very achievable goal, there may be issues
  45 surrounding h/w compatibility.  Please remember that my primary goal
  46 with JACK is to build a professional audio system, and with Ardour, a
  47 professional digital audio workstation. If they happen to be useful
  48 for people with 2/4 channel cards, then great, but it's not my own
  49 primary focus.
  50
  51 One other important issue is that your audio interface must support
  52 full duplex i/o with the same sample format for both capture and
  53 playback.  This means, for example, that the SoundBlaster AWE cannot
  54 be used with JACK in full duplex mode - it only supports full duplex
  55 i/o if one of the two directions (capture or playback) is 8 bit and
  56 the other is 16.  Very few cards have this kind of limitation, and if
  57 they do, they typically are not suitable for use with applications
  58 like JACK or Ardour for other reasons.
  59
  60 To date, JACK has been run with:
  61
  62    RME Hammerfall (Digi9652)              (26 channels in, 26 channels out)
  63    RME Hammerfall DSP (hdsp)              (26 channels in, 26 channels out)
  64    RME Hammerfall Light (Digi9636)        (18 channels in, 18 channels out)
  65    Midiman Delta series (ice1712 chipset) (12 channels in, 10 channels out)
  66
  67    Various consumer grade audio interfaces, typically with 2 channels
  68    in, 2/4 channels out, including:
  69
  70    Hoontech 4Dwave-NX (Trident chipset)
  71    Ensoniq 5880
  72    Soundblaster 32
  73    Soundblaster 64
  74    Creative SBLive64
  75
  76 and many more.
  77
  78 So, basically, it appears to work for just about all ALSA supported
  79 cards, which is the goal.
  80
  81 **********************************************************************
  82
  83 BUG REPORTING
  84 -------------
  85
  86 Bugs should be reported to http://ardour.org/mantis/ .  They are more
  87 likely to be remembered and dealt with there.  Please check the existing bugs
  88 to make sure it has not already been reported and/or fixed in CVS.
  89
  90 COMPILING ARDOUR
  91 ----------------
  92 Please see the file "BUILD".
  93
  94 RUNNING ARDOUR
  95 --------------
  96
  97 NOTE: You must have a running JACK server before starting Ardour.
  98       -----------------------------------------------------------
  99
 100 Typing "ardour" will hopefully have some effect. "ardour --help" lists
 101 available options.