INSTALL.md

   1 # INSTALL for Carla
   2
   3 NOTE: when using MSYS2 on Windows, an additional step is necessary in order
   4 to solve an issue with symbolic links to some dependency folders before build:
   5 ```
   6 $ make msys2fix
   7 ```
   8
   9 To install Carla, simply run as usual:
  10 ```
  11 $ make
  12 $ [sudo] make install
  13 ```
  14
  15 You can run it without installing, by using instead:
  16 ```
  17 $ make
  18 $ ./source/frontend/carla
  19 ```
  20
  21 Packagers can make use of the `PREFIX` and `DESTDIR` variable during install, like this:
  22 ```
  23 $ make install PREFIX=/usr DESTDIR=./test-dir
  24 ```
  25
  26 ## BUILD DEPENDENCIES
  27
  28 There are no required build dependencies. The default build is probably not what you want though.
  29
  30 If you want the frontend (which is likely), you will need PyQt5 (python3 version).
  31
  32 You likely will also want:
  33
  34  - libmagic/file (for auto-detection of binary types, needed for plugin-bridges)
  35  - liblo         (for OSC support, also a requirement for DSSI UIs)
  36
  37 Optional for extra Linux-only engine features:
  38
  39  - ALSA
  40  - PulseAudio
  41  - X11 (LV2/VST X11 UI support)
  42
  43 Optional for extended LV2 UIs support: (Linux only)
  44
  45  - Gtk2
  46  - Gtk3
  47  - Qt4
  48  - Qt5
  49
  50 Optional for Linux VST3 support:
  51
  52  - freetype2
  53  - Xcursor
  54  - Xext
  55
  56 Optional for extra samplers support:
  57
  58  - FluidSynth (SF2/3)
  59
  60 Optional for extra LADSPA plugin information:
  61
  62  - python3-rdflib
  63
  64
  65 You can use:
  66 ```
  67 $ make features
  68 ```
  69 To find out which dependencies are missing.
  70
  71
  72 Under Debian based systems, you can use this command to install everything:
  73 ```
  74 sudo apt install python3-pyqt5.qtsvg python3-rdflib pyqt5-dev-tools \
  75   libmagic-dev liblo-dev libasound2-dev libpulse-dev libx11-dev libxcursor-dev libxext-dev \
  76   libgtk2.0-dev libgtk-3-dev libqt4-dev qtbase5-dev libfluidsynth-dev
  77 ```
  78
  79 Under Fedora, you can use the following command instead:
  80 ```
  81 sudo dnf install python3-qt5-devel python3-rdflib \
  82   file-devel liblo-devel alsa-lib-devel pulseaudio-libs-devel libX11-devel
  83   gtk2-devel gtk3-devel qt4-devel qt5-devel fluidsynth-devel libsndfile-devel
  84 ```
  85
  86 ## BUILD BRIDGES (Experimental)
  87
  88 Carla can make use of plugin bridges to load additional plugin types.
  89
  90 ### 32bit plugins on 64bit systems
  91
  92 Simply run `make posix32` after a regular Carla build, and install or run Carla locally.<br/>
  93 This feature requires a compiler capable of building 32bit binaries.
  94
  95 ### JACK Applications inside Carla
  96
  97 This is built by default on Linux systems.<br/>
  98 Requires LD_PRELOAD support by the OS and the GCC compiler.<br/>
  99 Does not work with clang. (if you discover why, please let me know!)
 100
 101 ### Windows plugins (via Wine)
 102
 103 Requires a mingw compiler, and winegcc.
 104
 105 First, we build the Windows bridges using mingw, like this: (adjust as needed)
 106 ```
 107 make win32 CC=i686-w64-mingw32-gcc CXX=i686-w64-mingw32-g++
 108 make win64 CC=x86_64-w64-mingw32-gcc CXX=x86_64-w64-mingw32-g++
 109 ```
 110
 111 To finalize, we build the wine<->native bridges using winegcc:
 112 ```
 113 make wine32
 114 make wine64
 115 ```
 116
 117 Then install or run Carla locally as usual.<br/>
 118 Don't forget to enable experimental options and plugin bridges in Carla settings to actually be able to use them.