Skip to content

Latest commit

 

History

History
321 lines (236 loc) · 10.4 KB

INSTALL.md

File metadata and controls

321 lines (236 loc) · 10.4 KB
                   H Y D R O G E N          Drum machine

BUILDING AND INSTALLING HYDROGEN

Content:

  1. System Requirements
  2. Download
  3. Binary Packages
  4. Prerequisites to Build from Source
  5. Build and Install from Source
  6. Creating a Binary Package
  7. Generate the Documentation

System Requirements

Hydrogen is supported on the following operating systems:

  • Linux/Unix/BSD
  • Mac OS X

Hydrogen is not supported on Windows because there are currently no Windows developers on the project... and so the Windows components have fallen into disrepair.

Hydrogen is known to work well on fairly old systems like this (as of 2009):

  • Pentium III 500 MHz
  • 198 MB RAM
  • Consumer-Grade (cheap) audio card
  • Keyboard and Mouse
  • 1x1 USB MIDI Interface (optional)

Download

Hydrogen can be downloaded as a binary package, source distribution, or you can check out the current development version. These can be accessed on the Hydrogen home page:

http://www.hydrogen-music.org/

The source code for the current development version can be checked out via git:

$ git clone git://github.com/hydrogen-music/hydrogen.git

Binary Packages

In Debian (GNU/Linux) and Ubuntu (GNU/Linux) Hydrogen can be installed with apt

$ sudo apt-get install hydrogen

However, if you wish to have a more current version of Hydrogen, the Hydrogen dev's typically maintain a .deb package for Debian stable, testing, and some Ubuntu distributions. Note that apt takes care of any library dependencies that you have.

For other GNU/Linux :

Please check your package management system for the package called hydrogen.

For Mac OS X the Hydrogen home page has a binary package available. Extract the ZIP archive and it will create a hydrogen.app folder.

To get the latest version with the latest features and enable Jack support, install with Mac Ports.

Prerequisites to Build from Source

In order to build Hydrogen from source, you will need the following libraries and development header files installed on your system:

Required

  • Qt 5 Library
  • Qt 5 SDK (moc, uic, etc.)
  • GNU g++ compiler (>=4.0, 3.x might work)
  • cmake (>=2.6)
  • libsndfile >=1.0.18
  • zlib and libtar OR libarchive
  • OS X: Xcode
  • At least one of the following audio and midi driver

Audio and Midi Drivers

  • JACK Audio Connection Kit (>=0.103.0)
  • ALSA (Advanced Linux Sound Architecture)
  • OSS
  • PortAudio (v18, not v19)
  • PortMIDI
  • CoreAudio (OS X)
  • CoreMidi (OS X)

Optional Support

  • OSC (Open Sound Control)
  • LASH (Linux Audio Session Handler)
  • NSM (Non Session Manager)
  • JACK Session need Jack Audio Connection Kit(>=0.120.0/1.9.7)
  • liblrdf for LADSPA plugins
  • librubberband2 (Rubberband support is experimental)

Currently it is recommended that you disable this config option to ensure backwards compatibility with songs created under 0.9.5 which use rubberband. Install the rubberband-cli package beside librubberband2. Rubberband works properly even if this option is disabled. If available, Hydrogen locates the installed rubberband-cli binary.

Packages Required on Debian-based Systems

In order to build Hydrogen on Debian-based Systems, you can use the following command to install all basic and some optional requirements.

$ sudo apt-get install qtbase5-dev qtbase5-dev-tools            \
	qttools5-dev qttools5-dev-tools libqt5xmlpatterns5-dev  \
	libarchive-dev libsndfile1-dev libasound2-dev liblo-dev \
	libpulse-dev libcppunit-dev liblrdf-dev                 \
	liblash-compat-dev librubberband-dev

In addition, either the libjack-jackd2-dev or libjack-dev package must be present to enable the support of the JACK audio driver. Which one to pick depends on whether JACK2 or JACK1 is installed on your system. If none is present, either package will work.

Packages Required on OS X

To compile Hydrogen on OS X, be sure the install the following commands using MacPorts first.

sudo port install cmake libsndfile jack cppunit libarchive qwt-qt5 \
     qt5-qtxmlpatterns liblo liblrdf rubberband

In case you already installed some of these packages using brew you might have to remove them first for cmake to find the proper version.

Build and Install from Source

This instructions are thought for building Hydrogen on Linux. On a single, 500MHz processor Hydrogen takes about 1.5 hours to build.

We're providing a set of qmake project files for Windows and Mac OS X builds.

Please read the relevant wiki pages for more information:

Building and Installing Hydrogen

After you have installed all the prerequisites, building and installing will look like this:

$ git clone git://github.com/hydrogen-music/hydrogen.git
$ cd hydrogen
$ mkdir build && cd build
$ cmake ..
$ make && sudo make install

cmake Helpers

Alternatively you could use the cmake helper ./build.sh. This is the recommended way in case you are actively developing new features or bug fixes for Hydrogen (all characters in squared brackets are optional and do not have to be included into the command).

Command Functionality
r[m] Remove all build, temporary, and cached files.
c[lean] Remove all cached files.
m[ake] Launch the build process.
mm Launch the build process using ccache.
d[oc] Build the documentation of Hydrogen.
g[raph] Draw the dependency graphs of the Hydrogen code using graphviz.
h[elp] Show all supported build options.
[e]x[ec] Execute the Hydrogen binary.
t[est] Execute the test functions.
p[kg] Build a source package.
z Build Hydrogen using ccache and execute the resulting binary.

Using ccache to build Hydrogen, ./build.sh mm, will result in a compilation, which takes a little longer than the one with the usual make command. But in all further runs not the entire code base but just the parts you touched will be recompiled. This can speed up development by a margin.

Additional Build Features and Uninstall

All the following cmake commands should be executed in a build directory :

If you wish to configure features like LADSPA plugins, or debugging symbols, get more information like this:

$ cmake -L ..

For possible make targets:

$ make help

To change the directory Hydrogen will be installed in, you have to provide the -DCMAKE_INSTALL_PREFIX option during the configuration of your custom build (the default path is /usr/local/).

$ cmake -DCMAKE_INSTALL_PREFIX=/opt/hydrogen ..
$ make && sudo make install

Uninstalling Hydrogen is done like this:

$ sudo cmake uninstall

Note that cmake is a build system and not a package manager. While we make every effort to ensure that Hydrogen uninstalls cleanly, it is not guaranteed.

cmake macros should detect the correct Qt settings and location of your libraries, but sometimes it needs a little help. If Hydrogen fails to build, some environment variables could help it.

$ QTDIR=/opt/lib/qt4 OSS_PATH="/usr/lib/oss/lib" OSS_INCLUDE="/usr/lib/oss/include" cmake ..

Creating a Binary Package

If you are a package maintainer and wish for your packaging scripts to be included in the Hydrogen source tree, we would be happy to work with you. Please contact the developer mailing list (see the Hydrogen home page). The instructions below are for the package systems that have been contributed so far.

Creating a .deb Package

In order to create a .deb package for Debian-based systems (like Debian, Devuan, Ubuntu, or Mint), you first need the debhelper package:

$ sudo apt-get install debhelper

To build the Hydrogen package, run the following commands.

$ git clone git://github.com/hydrogen-music/hydrogen.git
$ cd hydrogen
$ cd linux
$ fakeroot dpkg-buildpackage

This will place the .deb package and description files in the parent directory. If you wish to change the version number for the archive, edit linux/debian/changelog to set the version. To install the newly created deb package, run the following (substitute the deb package name with the version your build created):

$ cd ..
$ sudo dpkg -i hydrogen_0.9.6_amd64.deb

Generate the Documentation

Apart from the official manuals and tutorial, Hydrogen does also feature an extended documentation of its code base.

To generate it using Doxygen, run the following command

$ ./build.sh d

It will produce two folder build/docs/html/ and build/docs/latex containing the documentation as either HTML or LaTeX. The HTML version is recommended since it provides a more friendly way to navigate through the set of created files. You can view them using your favorite browser, e.g.

$ firefox build/docs/html/index.html