Liquidsoap 1.4.4
Forewords
Installing liquidsoap can be a difficult task. The software relies on
a up-to date OCaml compiler, as well as a bunch of
OCaml modules and, for most of them, corresponding C
library dependencies.
Our recommended way of installing liquidsoap is via opam. opam can take care
of install the correct OCaml compiler, optional and
required dependencies as well as system-specific package
dependencies.
The opam method is described in details in the documentation. We recommend that any
interested user head over to this link to install the software via
opam.
The following of this document describes how to install the software
via its configure script and is intended either for system
administrators or package maintainers.
Dependencies
Below is a list of dependencies, mostly OCaml libraries. Optional
libraries provide extra features. They need to be detected by the
configure script.
Most of the libraries are developed by the Savonet project and, in addition to being available through traditional distribution channels, are bundled in the liquidsoap-<version>-full.tar.bz2 tarballs for easier builds.
Libraries not developed by Savonet are:
- camlimages
- camomile
- gd4o
- ocaml-pcre
- ocaml-magic
- ocaml-sdl
- yojson
Mandatory dependencies:
| Dependency | Version |
|---|---|
| OCaml compiler | >= 4.08.0 |
| ocaml-dtools | >= 0.4.0 |
| ocaml-duppy | >= 0.6.0 |
| ocaml-mm | >= 0.5.0 |
| ocaml-pcre | |
| menhir | |
| sedlex |
Recommended dependencies:
| Dependency | Version | Functionality |
|---|---|---|
| camomile | >=1.0.0 | Charset recoding in metadata |
| ocaml-samplerate | >=0.1.1 | Libsamplerate audio conversion |
Optional dependencies:
| Dependency | Version | Functionality |
|---|---|---|
| camlimages | >=4.0.0 | Image decoding |
| gd4o | Video.add_text() on servers without X | |
| ocaml-alsa | >=0.2.1 | ALSA I/O |
| ocaml-ao | >=0.2.0 | Output via libao |
| ocaml-bjack | >=0.1.3 | Jack support |
| ocaml-cry | >=0.6.0 | Sending to Shoutcast & Icecast |
| ocaml-dssi | >=0.1.1 | DSSI sound synthesis |
| ocaml-faad | >=0.4.0 | AAC stream decoding |
| ocaml-fdkaac | >=0.3.1 | AAC(+) encoding |
| ocaml-ffmpeg | >=0.2.0 | Video conversion using the ffmpeg library |
| ocaml-flac | >=0.1.5 | Flac and Ogg/Flac codec |
| ocaml-frei0r | >=0.1.0 | Frei0r plugins |
| ocaml-gavl | >=0.1.4 | Video conversion using the gavl library |
| ocaml-gstreamer | >=0.3.0 | GStreamer input, output and encoding/decoding |
| ocaml-inotify | >=1.0 | Reloading playlists when changed |
| ocaml-ladspa | >=0.1.4 | LADSPA plugins |
| ocaml-lame | >=0.3.2 | MP3 encoding |
| ocaml-lastfm | >=0.3.0 | Lastfm scrobbling |
| ocaml-lo | >=0.1.0 | OSC (Open Sound Control) support |
| ocaml-mad | >=0.4.4 | MP3 decoding |
| ocaml-magic | >=0.6 | File type detection |
| ocaml-ogg | >=0.5.0 | Ogg codecs |
| ocaml-opus | >=0.1.1 | Ogg/Opus codec |
| ocaml-portaudio | >=0.2.0 | Portaudio I/O |
| ocaml-pulseaudio | >=0.1.2 | PulseAudio I/O |
| ocaml-sdl | Display, font & image support | |
| ocaml-shine | >=0.2.0 | Fixed-point MP3 encoding |
| ocaml-soundtouch | >=0.1.7 | Libsoundtouch’s audio effects |
| ocaml-speex | >=0.2.1 | Ogg/Speex codec |
| ocaml-ssl | >=0.5.2 | SSL/https support |
| ocaml-taglib | >=0.3.0 | MP3ID3 metadata access |
| ocaml-theora | >=0.3.1 | Ogg/Theora codec |
| ocaml-vorbis | >=0.7.0 | Ogg/Vorbis codec |
| ocaml-xmlplaylist | >=0.1.3 | XML-based playlist formats |
| osx-secure-transport | SSL/https support via OSX’s SecureTransport | |
| yojson | Parsing JSON data (of_json function) |
Runtime optional dependencies:
| Dependency | Functionality |
|---|---|
| awscli | s3:// and polly:// protocol support |
| curl | http/https/ftp protocol
support |
| ffmpeg | external I/O, replay_gain level computation, .. |
| youtube-dl | youtube video and playlist support |
Installing via configure
The build processus starts with by invoking the
configure script:
% ./configureIf you want a complete installation of liquidsoap, enabling a
production use of liquidsoap as a daemon, you should pass
--with-user=<login> and
--with-group=<group> options to indicate which
user/group you have created for liquidsoap.
Then, build the software:
% makeYou can also generate the documentation for liquidsoap:
% make docIt will generate the HTML documentation, including a version of the scripting API reference corresponding to your configuration.
Then, you may proceed to the installation. You may need to be root for that.
% make installThis will not install files such as /var/log/liquidsoap
unless you have provided a user/group under which liquidsoap should be
ran. This behavior can be overridden by passing
INSTALL_DAEMON="yes" (useful for preparing binary
packages).
If you need to run liquidsoap as a daemon, you can then have a look at liquidsoap-daemon.