forked from muse-sequencer/muse
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
298 lines (223 loc) · 11.1 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
====================================================================
MusE --- Linux Music Editor
====================================================================
Welcome to MusE, the open source MIDI/Audio sequencer.
MusE is distributed under the GNU General Public License (GPL).
Please check out the file COPYING in the muse3/ directory for more
details.
=============================
Features:
=============================
MIDI sequencing:
- Realtime record/playback
- Midi file import/export
- Input filter
- Support for internal softsynth plugins using
LV2, DSSI, VST, LinuxVST and MESS
- much more
Audio sequencing:
- Realtime Record/Playback several mono/stereo inputs/outputs
- Graphical editing of automation
- Support for LADSPA, LV2, DSSI, VST, LinuxVST plugins
Technologies supported:
- LASH - for session control with external LASH enabled applications
- JACK - The Jack Audio Connection Kit can be used for audio and midi
- ALSA midi output
- Plugin formats: LV2, DSSI, VST, LinuxVST, MESS
- FLAM plugin guis.
- Built on QT4
,-----------------------------------------------------------------.
| NOTICE |
|-----------------------------------------------------------------|
| Some parts of MusE code are EXPERIMENTAL, and may well result |
| in a CRASH, and who knows what other ill effects. |
| RUN THIS SOFTWARE AT YOUR OWN RISK. |
`-----------------------------------------------------------------'
=============================
Requirements:
=============================
- CMake >= 2.4
http:/www.cmake.org/HTML/Download.html
- QT: Qt >= 5.1.0 (development files)
http://qt-project.org/
MusE does _not_ compile with older versions
For ubuntu packages can be installed via:
sudo apt-get install qt5-default qttools5-dev qttools5-dev-tools
- gcc >= 4.x.x or clang >= 2.9
http://gcc.gnu.org/
http://clang.llvm.org/
- libsndfile >= 1.0.1 (development files)
http://www.mega-nerd.com/libsndfile/
- libsamplerate >= 0.1.0 (development files)
http://www.mega-nerd.com/SRC/
- JACK >= 0.103 (development files)
http://jackaudio.org/
- libuuid (development files)
e2fsprogs package http://e2fsprogs.sourceforge.net/
Some distros may include it in another package such as 'libuuid', or offer a choice.
- LADSPA (development file ladspa.h)
www.ladspa.org
=============================
Optional:
=============================
- fluidsynth >= 1.0.3 (formerly known as iiwusynth) (development files)
http://sourceforge.net/apps/trac/fluidsynth/
- liblo Lightweight OSC (Open Sound Control) (development files)
http://liblo.sourceforge.net/
- LV2 (LADSPA Version 2) plugin support:
MusE contains built-in versions of these LV2 support libraries:
lv2, lilv, serd, sord and sratom, from:
http://drobilla.net/software
But if it finds system-installed versions (development files)
greater than or equal to all of the built-in versions,
the system-installed versions will be used.
The cmake option ENABLE_LV2_SUPPLIED (default off)
forces built-in versions to be used.
(The built-in versions may be slightly modified from their
corresponding official versions. See muse/lv2Support/ChangeLog.)
- LV2 Gtk2 User Interface support:
Some LV2 plugins may provide a Gtk2 based graphical User Interface.
To view them, the following is required (development files):
gtkmm-2
http://www.gtkmm.org
gtk+-2
http://www.gtk.org
- DSSI Disposable Soft Synth Interface (development files)
http://dssi.sourceforge.net/
(Both recommended - DSSI needs OSC, OSC alone does nothing, for now.)
- dssi-vst Support for DSSI vst plugins
http://www.breakfastquay.com/dssi-vst/
- LASH Audio Session Handler
http://lash.nongnu.org/
Recently LADISH has been emulating it instead:
http://ladish.org/
- Python The python scripting language
http://www.python.org
Python support is required for some experimental features.
Currently it's NOT recommended to build with python support.
- PyQt4 is used by some of the bundled midi scripts
=============================
Building MusE:
=============================
- Download source from http://muse-sequencer.org/
- Unpack the source somewhere.
You may also try the various MusE development GIT branches for
up-to-the-minute features and fixes, but they may be less stable.
- To compile MusE, run the following commands from the
top level directory where the source code was unpacked
(the directory where THIS README FILE is found):
******************************************************
* Notice: *
* A quick way is to run the ./compile_muse.sh *
* script in the same dir, it should perform the same *
* steps for a basic setup without asking any *
* questions. If it fails you may be better off using *
* the instructions below. *
******************************************************
The build directory:
--------------------
Building in a subdirectory is recommended to keep the build directory separate from the source tree.
So create a new subdirectory with a useful name like "build" or "debug" or "release":
mkdir build
Change directory (cd) to the new directory:
cd build
Configuration:
--------------
There are a few different ways to configure (notice the two dots):
Type "cmake -i .." to run in step-by-step 'Wizard' mode, this is the RECOMMENDED way to
setup the build environment.
Or type "cmake -L .." to see options, then compose "cmake <options>" yourself.
Some <options> are:
-DCMAKE_BUILD_TYPE=<type>
<type> can be blank (to reset a previous cached type to 'empty'),
debug, release, RelWithDebInfo and MinSizeRel.
Release is recommended, to get optimizations.
If no CMAKE_BUILD_TYPE is given at all, cmake uses either the previous
cached value, or else 'empty' (plain or default system optimizations).
-DCMAKE_INSTALL_PREFIX=<prefix>
The installation <prefix> where the program is installed.
The default is to install in /usr/local.
Or type "ccmake .." (if you have it - text-mode GUI). It may be blank so hit
'C' to first-time configure. Fiddle with yer options if ye so desire, then hit
'C' to configure then 'G' to generate and exit, or 'Q' to quit without
generating.
Or there is also a desktop GUI for cmake called cmake-gui.
Compiling:
----------
After configuration, while still in the build directory,type:
make
Installing:
----------
After compiling, type:
make install (as root)
or
sudo make install
=============================
Running MusE:
=============================
Recommended setup:
------------------
MusE is a realtime program which requires special rights to work properly.
- Check if you are running a sufficiently new linux kernel > 2.6.x
A modern, standard destop kernel might suit your needs.
However, for the best performance a so-called 'low latency' or 'realtime'
kernel may be required. Check your distro's packages for availability.
- create an "audio" group if it does not already exists
and put yourself into this group
- For realtime priority, you may want to ensure either the file:
/etc/security/limits.conf
or
/etc/security/limits.d/audio.conf
contains:
@audio - rtprio 95
@audio - memlock unlimited
- make sure you can acces the realtime clock (RTC)
chmod 660 /dev/rtc
chgrp audio /dev/rtc
- make sure MusE can set the rtc clock:
echo 8192 > /proc/sys/dev/rtc/max-user-freq
inspect with:
cat /proc/sys/dev/rtc/max-user-freq
- some distros do not load the alsa sequencer module by default.
if necessary, load the alsa sequencer module with:
/sbin/modprobe snd-seq
- Start jack, typically by using the qjackctl application.
MusE can also be run without Jack. MusE will use a dummy audio
driver if Jack is not detected, or the -a option is given.
Running:
------------------
start MusE by typing:
muse3 <options>
Some <options> are (complete list is printed by running muse3 -h):
-h help
-v print version
-d debug mode: no threads, no RT
-D debug mode: enable some debug messages
specify twice for lots of debug messages
this may slow down MusE massively!
-m debug mode: trace midi Input
-M debug mode: trace midi Output
-s debug mode: trace sync
-a no audio
-A Force inclusion of ALSA midi even if using Jack
-P n set audio driver real time priority to n
(Dummy only, default 40. Else fixed by Jack.)
-Y n force midi real time priority to n (default: audio driver prio +2)
-p don't load LADSPA plugins
-I don't load DSSI plugins
-L don't use LASH
-l xx force locale to the given language/country code
(xx = de,en,es,fr,pl,ru,sv_SE)
(JACK and all its clients (qjackctl & MusE) must run with the
same user id)
=============================
known bugs
=============================
The odd wierdness happens and some things may not be completely implemeneted
though we hope it is as stable for you as it is for us!
If you differ in this opinion we are grateful for all reported issues.
See the bug tracker for a better view of issues
https://github.com/muse-sequencer/muse/issues
====================================================================
Let us know whether MusE works for you !!!
Have a look at the webpage http://www.muse-sequencer.org for details.