H Y D R O G E N          Drum machine

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

Hydrogen is supported on the following operating systems:

• Linux/Unix/BSD
• Mac OS X
• Windows 10 (maybe 7)

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

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 devs 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, install it with Mac Ports.

• Installing on Mac OS X with MacPorts

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

• 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

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

• liblo for OSC (Open Sound Control)
• LASH (Linux Audio Session Handler)
• NSM (Non Session Manager)
• liblrdf for LADSPA plugins
• librubberband2 (Rubberband support is experimental)

Currently it is recommended that you disable the rubberband config option (done by default) 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.

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 cmake 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.

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.

If you intend to build Hydrogen from source on Windows or with Homebrew or Fink on Mac OS X, please read the relevant wiki pages for more information:

• Building Hydrogen from source on Mac OS X
• Packaging Hydrogen for Windows

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

After installation, Hydrogen's binaries can be found in CMAKE_INSTALL_PREFIX/bin. If this path is not in your PATH environment variable, consider adding it to it.

If Hydrogen doesn't start, and you have the above message :

… error while loading shared libraries: libhydrogen-core-1.1.0.so …

it's because Hydrogen's shared library is not found. You can verify this with the following command

ldd CMAKE_INSTALL_PREFIX/bin/hydrogen | grep 'not found'

To fix it, you can use LD_PRELOAD or LD_LIBRARY_PATH environment variables, or configure ldconfig (see man ldconfig, man ld.so).

Another option is to set the cmake option -DCMAKE_INSTALL_PREFIX=/usr, recompile, and reinstall Hydrogen. But be aware that you will certainly overwrite Hydrogen files that you might have installed with your distribution's package manager.

see issue#677

Alternatively you could use our custom build script ./build.sh. This is the recommended way if 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 in the command).

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, only the recently-modified components will be recompiled. This can marginally speed up development.

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 ..

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.

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
$ dpkg-buildpackage -rfakeroot -b -uc -us

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_X.Y.Z_amd64.deb

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

After installing the requite Doxygen package

$ sudo apt-get install doxygen

run the following command

$ ./build.sh d

It will produce two folders, build/docs/html/ and build/docs/latex, containing the documentation as HTML and LaTeX, respectively. 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