1Building and installing Siren
2-----------------------------
3
4Siren is built and installed with the following commands.
5
6	./configure [option=value ...]
7	make
8	make install
9
10The configure script supports the following options. Default values are in
11parentheses.
12
13prefix=path (/usr/local)
14	Install Siren in <path>.
15
16bindir=path (<prefix>/bin)
17	Install the binary in <path>.
18
19mandir=path (<prefix>/man)
20	Install the manual page in <path>.
21
22plugindir=path (<prefix>/lib/siren)
23	Install the plug-ins in <path>. Input plug-ins will be installed in
24	"<path>/ip" and output plug-ins in "<path>/op".
25
26debug=yes|no (no)
27	Whether to build a debug version of Siren.
28
29aac=yes|no (yes)
30	Whether to build the aac input plug-in. This plug-in provides support
31	for the MPEG-2/4 AAC audio format. It requires the libfaad and libmp4v2
32	libraries. For more information, see <http://www.audiocoding.com/> and
33	<https://code.google.com/p/mp4v2/>.
34
35ffmpeg=yes|no (yes)
36	Whether to build the ffmpeg input plug-in. This plug-in provides
37	support for a variety of audio formats. It requires the libavformat
38	library. For more information, see <https://www.ffmpeg.org/>.
39
40flac=yes|no (yes)
41	Whether to build the flac input plug-in. This plug-in provides support
42	for the FLAC audio format. It requires the libFLAC library. For more
43	information, see <https://www.xiph.org/flac/>.
44
45mad=yes|no (yes)
46	Whether to build the mad input plug-in. This plug-in provides support
47	for the MPEG-1/2/2.5 audio layer I/II/III formats such as MP3. It
48	requires the libmad and libid3tag libraries. For more information, see
49	<http://www.underbit.com/products/mad/>.
50
51mpg123=yes|no (yes)
52	Whether to build the mpg123 input plug-in. This plug-in is an
53	alternative to the mad input plug-in. It requires the libmpg123
54	library. For more information, see <http://www.mpg123.org/>.
55
56opus=yes|no (yes)
57	Whether to build the opus input plug-in. This plug-in provides support
58	for the Opus audio format. It requires the libopusfile library. For
59	more information, see <https://www.opus-codec.org/>.
60
61sndfile=yes|no (yes)
62	Whether to build the sndfile input plug-in. This plug-in provides
63	support for a variety of audio formats including WAVE and AIFF. It
64	requires the libsndfile library. For more information, see
65	<http://www.mega-nerd.com/libsndfile/>.
66
67vorbis=yes|no (yes)
68	Whether to build the vorbis input plug-in. This plug-in provides
69	support for the Ogg Vorbis audio format. It requires the libvorbisfile
70	library. For more information, see <https://www.xiph.org/vorbis/>.
71
72wavpack=yes|no (yes)
73	Whether to build the wavpack input plug-in. This plug-in provides
74	support for the WavPack audio format. It requires the libwavpack
75	library. For more information, see <http://www.wavpack.com/>.
76
77alsa=yes|no (yes)
78	Whether to build the alsa output plug-in. This plug-in provides support
79	for ALSA. It requires the libasound library. For more information, see
80	<http://www.alsa-project.org/>.
81
82ao=yes|no (yes)
83	Whether to build the ao output plug-in. This plug-in provides support
84	for libao which in turn supports a variety of audio systems. It
85	requires the libao library. For more information, see
86	<https://www.xiph.org/ao/>.
87
88oss=yes|no (yes)
89	Whether to build the oss output plug-in. This plug-in provides support
90	for OSS. Both OSS 3 and OSS 4 are supported, but volume support is
91	available only for OSS 4. For more information, see
92	<http://www.opensound.com/>.
93
94portaudio=yes|no (yes)
95	Whether to build the portaudio output plug-in. This plug-in provides
96	support for PortAudio which in turn supports a variety of audio
97	systems. It requires the libportaudio library. For more information,
98	see <http://www.portaudio.com/>.
99
100pulse=yes|no (yes)
101	Whether to build the pulse output plug-in. This plug-in provides
102	support for PulseAudio. It requires the libpulse-simple library. For
103	more information, see <http://www.pulseaudio.org/>.
104
105sndio=yes|no (yes)
106	Whether to build the sndio output plug-in. This plug-in provides
107	support for sndio. For more information, see the OpenBSD sndio(7)
108	manual page and <http://www.sndio.org/>.
109
110sun=yes|no (yes)
111	Whether to build the sun output plug-in. This plug-in provides support
112	for the SunOS audio system.
113
114Running Siren from the source directory
115---------------------------------------
116
117To run Siren from the source directory (i.e. without installing it first), run
118the following commands.
119
120	./configure plugindir="$PWD"
121	make
122	./siren
123
124Should you later wish to install Siren after all, then ensure you reconfigure
125and rebuild it first so that the plugindir variable is set to a proper value.
126It is perhaps safest to start from a clean source directory. Therefore, run the
127following command before reconfiguring.
128
129	make cleandir
130
131Uninstalling Siren
132------------------
133
134Siren can be uninstalled with the following command.
135
136	make uninstall
137