Change ALSA device default to 'default' from hw:0
[zynaddsubfx-code.git] / README.adoc
blob80ab7018be0b7d9b4bb6091b065ca27daa0b4050
1 image::https://travis-ci.org/zynaddsubfx/zynaddsubfx.svg?branch=master[alt="Build status", link="https://travis-ci.org/zynaddsubfx/zynaddsubfx"]
3 ZynAddSubFX
4 -----------
6 ZynAddSubFX is a fully featured musical software synthesizer for Linux, MacOS, BSD, and Windows.
7 ZynAddSubFX exposes a wide array of synthesis parameters to make it flexible tool for sound design and a fun experience for playing instruments.
9 image::doc/zyn-fusion-add.png[Zyn-Fusion Add Synth Editor]
11 Features
12 ~~~~~~~~
14 *   Polyphonic with support for legato and mono playing modes.
15 *   Three synthesizer engines:
16 **      Additive Synthesis for classic synth sounds composed of a variety of voices with powerful modulation. This exposes modulators ranging from LFOs and envelopes to oscillator modulators for FM, PM, and AM.
17 **      Subtractive Synthesis for creating variable bandwidth harmonics from filtered white noise.
18 **      PAD synthesis for creating beautiful pads and other instruments.
19 *   Powerful waveform generator with up to 128 sine/non-sine harmonics.
20 *   A variety of filters including analogue modeled filters, formant filters, and state variable filters.
21 *   Envelopes can have ADSR (or ASR, etc..) modes or can be free modes (with any shape).
22 *   Effects for Reverb, Echo, Chorus/Flange, Phasing, Wave-shaping, Equalizing, Dynamic Filtering with flexible signal routing.
23 *   Instruments can be organized in kits, which allows you to make drum kits or layered instruments; this makes possible to use more than one instrument for a single part. It is possible to choose what items from the kit should be processed by the Part's effects.
24 *   Randomness settings to create subtle differences in each sound to help create that familiar analogue warmth.
25 *   Microtonal capabilities with any scale, up to 128 notes per octave, and key mapping.
26 *   Extensive MIDI/Audio driver support including JACK, ALSA, OSS, and PortAudio. The following MIDI protocol extensions are provided:
27 **      Floating point notes via MIDI SysEx. Allows the exact pitch of a note on event to be specified as a 28-bit value.
28 **      Per-note controller events via MIDI SysEx. Allows individual active notes to receive MIDI control events.
29 **      Per-note pitch bend events via MIDI SysEx. Allows individual active notes to change pitch.
30 *   Session Management Support via LASH/NSM.
31 *   Plugin Support via DSSI/LV2/VST.
32 *   Over 1100 high quality instruments included.
35 For more information see:
37 - The project page: http://zynaddsubfx.sf.net
38 - The mailing list: https://sourceforge.net/projects/zynaddsubfx/lists/zynaddsubfx-user
39 - The public forum: https://www.kvraudio.com/forum/viewforum.php?f=47
40 - The IRC channel: #zynaddsubfx on irc.Libera.chat
42 Dependencies
43 ~~~~~~~~~~~~
45 ZynAddSubFX depends on a number of dependencies for building.
46 For more information on building the core along with the FLTK based interface see doc/building.txt and for building the new interface see https://github.com/zynaddsubfx/zyn-fusion-build.
48 Required:
50 - FFTW 3.x.x  - necessary for Fast Fourier computations
51 - MXML-2.5+   - from https://www.msweet.org/mxml/
52 - zlib        - from https://www.zlib.net/
53 - Liblo       - networked open sound control
55 Optional:
57 - FLTK (for the oldest user interface)
58 - NTK  (for the old user interface)
59 - JACK
60 - OSS
61 - ALSA
62 - LASH
63 - DSSI
65 Sibling projects
66 ~~~~~~~~~~~~~~~~
68 - rtosc       - realtime open sound control https://github.com/fundamental/rtosc
69 - mruby-zest  - the framework for the zyn-fusion GUI https://github.com/mruby-zest/mruby-zest
72 License
73 ~~~~~~~
75 ZynAddSubFX is available under the GPL-2.0-or-later license.
77 Have fun! :-)
79 --The ZynAddSubFX team