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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
|
====================================================================
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
- RtAudio - basic audio input/output for Pulse, ALSA and OSS
- ALSA midi
- Plugin formats: LV2, DSSI, VST, LinuxVST, MESS
- Support Inst(rument) Patch Library for enhanced fluidsynth features.
- FLAM plugin guis.
- Built on Qt5
,-----------------------------------------------------------------.
| 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/
- LADSPA (development file ladspa.h)
www.ladspa.org
=============================
Optional:
=============================
- ALSA >= 0.9.0 Advanced Linux Sound Architecture (development files)
http://www.alsa-project.org/
- fluidsynth >= 1.0.3 (formerly known as iiwusynth) (development files)
http://sourceforge.net/apps/trac/fluidsynth/
- libinstpatch >= 1.0 Instrument Patch Library (development files)
http://www.swamiproject.org/
- RtAudio >=5.0 audio input/output support.
https://www.music.mcgill.ca/~gary/rtaudio/
- 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/
- liblo Lightweight OSC (Open Sound Control) (development files)
http://liblo.sourceforge.net/
(Both recommended - DSSI can use 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
Quick instructions for Ubuntu and similar distributions:
=================================
Building MusE under Ubuntu:
=================================
1. Open terminal and type (either on one line or with several 'sudo apt-get install <packages'):
sudo apt-get install build-essential cmake libsndfile1-dev libsamplerate0-dev\
libjack-jackd2-dev ladspa-sdk qt5-default qttools5-dev qttools5-dev-tools\
liblo-dev dssi-dev lv2-dev libsamplerate0-dev libsndfile1-dev git\
libfluidsynth-dev libgtkmm-2.4-dev librtaudio-dev libqt5svg5-dev\
libinstpatch-dev
2. Clone muse source with command:
'git clone https://github.com/muse-sequencer/muse.git'
3. Type 'cd muse/muse3'
4. Type './compile_muse.sh' and wait until it is finished
5. Type 'cd build'
6. Type `sudo make install` - this will install muse3 to /usr/local
7. Run it by typing `muse3`
=============================
Generic 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 should suit virtually all needs.
For even stricter realtime performance a so-called 'low latency'
or 'realtime' kernel may be available. 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
Some distros have a graphical menu or tool which does this for you.
- 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)
Startup troubleshooting tips:
-----------------------------
- Some rare distros might not load the alsa sequencer module by default.
If necessary, load the alsa sequencer module with:
/sbin/modprobe snd-seq
- Timer accuracy for ALSA support:
If ALSA support is enabled, a reliable source of timing is
desired for playback of midi notes.
By default, the timer is attempted to run at 1024 Hz (ticks/second).
MusE will try the Real Time Clock (RTC) first.
If that fails it will try ALSA timers instead - typically the
ALSA High Resolution (HR) timer or the ALSA system timer.
The RTC is recommended, with sufficient permissions, for best accuracy.
To ensure you have permissions to use the RTC, on modern systems
using udev rules, create this file if it does not exist:
"/etc/udev/rules.d/40-timer-permissions.rules"
and add the following lines to the file:
KERNEL=="rtc0",GROUP="audio"
KERNEL=="hpet",GROUP="audio"
and, as stated in "Recommended setup" above, ensure you are
part of the audio group.
(The hpet is not supported, but that line can help other applications.)
It is possible to use the ALSA system timer instead of the RTC,
but it usually requires a kernel built with a 1000 Hz system timer
(low-latency, realtime, or custom kernel as in "Recommended setup" above).
With most desktop kernels, the system timer is limited to 250 Hz,
while the HR timer is limited to 1000 Hz.
On such distros, without modification, MusE should end up picking
the 1000 Hz HR timer.
But if you set your RTC as above, you can run even higher rates.
See the Global Settings dialog for user-adjustable high rates.
Run MusE in a terminal to see what it picks. -D option gives more info.
(The following is old information! But may work for those without udev.)
Make sure you can access 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
=============================
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.
|