DOCUMENTATION/BUILD

   1                    HOW TO BUILD ARDOUR FROM SOURCE
   2                    -------------------------------
   3
   4 Please: before you do anything else, take a moment to go and join the
   5 ardour-dev mailing list (members only).  It is very important that the
   6 community of people using, testing and developing this software are on
   7 the list, and I will NOT deal with questions relating to Ardour's
   8 compilation or bugs that are not sent to that list.  See
   9 http://ardour.org/ for details on joining the mailing list.
  10
  11 You can also get in touch with developers and users on IRC. Joining
  12 #ardour at irc.freenode.net. The core developers and several key users
  13 hang out here on IRC, at pretty much any hour of the night or day.
  14
  15 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
  16
  17          Full information on building Ardour can be found at:
  18
  19                     http://ardour.org/building.php
  20
  21    Information has been left in this file for those who do not have
  22   network access but is not guaranteed to be accurate or up to date.
  23
  24 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
  25
  26
  27 COMPILING
  28 ------------
  29
  30 Please ensure that before attempting to compile Ardour, you have
  31 installed:
  32
  33 * Tools:
  34
  35        gcc/g++ 3.x or above
  36        scons 0.96 or above
  37        gettext 0.12.1 or above
  38        pkgconfig 0.8.0 or above
  39                 http://www.freedesktop.org/software/pkgconfig/
  40
  41        lex and yacc are also required.
  42                 any version of bison >= 1.35 should work fine.
  43        intltool try 0.32 or above
  44
  45 * Libraries:
  46
  47 Recommended versions, where applicable, are shown under the general
  48 requirement.
  49
  50        JACK 0.99.50 (CVS or snapshot release) (http://jackit.sourceforge.net)
  51
  52        libxml2 2.5.X (http://xmlsoft.org/)
  53
  54        libart_lgpl 2.3.X
  55
  56        - available as part of gnome-libs, which you may already
  57              have on your system.
  58
  59            - also available via download from GNOME source FTP sites.
  60            - see ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html
  61               and then follow to sources/libart_lgpl
  62
  63        glib 1.2   (http://www.gtk.org)
  64            glib-1.2.8 (included with most distributions)
  65
  66        GTK+ 1.2   (http://www.gtk.org)
  67         gtk+-1.2.8 (included with most distributions)
  68
  69        libglade2 (http://www.gnome.org/)
  70         unsure of minimum version. XXX todo.
  71
  72        libsndfile (http://www.mega-nerd.com/libsndfile/)
  73         libsndfile-1.0 or higher
  74
  75        libsamplerate (http://www.mega-nerd.com/SRC/)
  76          libsamplerate 0.0.13 or higher
  77
  78        the LADSPA SDK (http://www.ladspa.org/)
  79         (See below)
  80
  81        raptor (http://librdf.org/raptor/)
  82
  83        lrdf  (needs raptor) (http://plugin.org.uk/lrdf/)
  84          liblrdf 0.4.0 or higher (earlier versions will
  85               causes crashes when using plugin presets)
  86
  87 Getting LADSPA
  88 ---------------
  89
  90 The Linux Audio Developers Simple Plugin API (LADSPA) really only
  91 consists of a header file, which is already included in the Ardour
  92 source tree.
  93
  94 However, you may want the plugins that come the "full" LADSPA "SDK",
  95 so go ahead and download the whole package (it's not big) from
  96 www.ladspa.org.
  97
  98 I would also recommend getting Steve Harris' excellent set of LADSPA
  99 plugins from http://plugin.org.uk/.  They make Ardour into a truly
 100 useful application.  Other LADSPA plugins will be appearing - be sure
 101 to watch the Linux Audio Development mailing list for announcements.
 102
 103 2A) COMPILING FROM CVS
 104 ---------------------
 105
 106 Checkout the source from Ardour CVS (the `%' here is meant to be your
 107 shell prompt):
 108
 109 % cd /usr/local/src    # just an example, it can be anywhere
 110 % cvs -d:pserver:anoncvs@ardour.org:/cvsroot/ardour login
 111                        # you will need to contact
 112                        # paul at linuxaudiosystems dot com
 113                        # to get the passphrase. See
 114                        # http://ardour.org/download.html
 115                        # for details on why this is.
 116 % cvs -d:pserver:anoncvs@ardour.org:/cvsroot/ardour -z3 co ardour
 117
 118 2B) COMPILING FROM A TARBALL
 119 ----------------------------
 120
 121 As usual, fetch and unpack the tarball.  The directory it creates,
 122 ardour-<version>, is referred to below as "$AD".
 123
 124 3) HOW TO COMPILE
 125 -----------------
 126
 127 We use the wonderful scons build system, which is started by just typing:
 128
 129         scons
 130
 131 in the top level directory of the ardour source tree.
 132
 133 To speed things up, on a uniprocessor system, use "scons -j2", and on
 134 an SMP system try "scons -j3", which will do a parallel build
 135 (constructing more than one thing at a time).
 136
 137 If you want to build ardour so that it can be debugged, you may wish
 138 to use the DEBUG=yes option. Without it, ardour is built with
 139 extreme optimization turned on and the result cannot be debugged
 140 effectively.
 141
 142 If you don't want the installation to happen in the "usual place", add
 143 a PREFIX=/my/preferred/prefix option to scons.
 144
 145 Compilation takes a while.  Running with scons -j3 on a dual PII-450,
 146 the entire build takes about 20 minutes, about the same time with
 147 scons -j2 on 2.6GHz P4.
 148
 149 Other scons options can be discovered using "scons --help"