Resolve Windows build issue
[zynaddsubfx-code.git] / README.adoc
blobd11f902b491b26b6953f8e170f4a70274a2a31fa
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.
27 *   Session Management Support via LASH/NSM.
28 *   Plugin Support via DSSI/LV2/VST.
29 *   Over 1100 high quality instruments included.
32 For more information see:
34 - The project page: http://zynaddsubfx.sf.net
35 - The mailing list: https://sourceforge.net/projects/zynaddsubfx/lists/zynaddsubfx-user
36 - The public forum: https://www.kvraudio.com/forum/viewforum.php?f=47
37 - The IRC channel: ##zynaddsubfx on freenode
39 Dependencies
40 ~~~~~~~~~~~~
42 ZynAddSubFX depends on a number of dependencies for building.
43 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.
45 Required:
47 - FFTW 3.x.x  - necessary for Fast Fourier computations
48 - MXML-2.5+   - from https://www.msweet.org/mxml/
49 - zlib        - from https://www.zlib.net/
50 - Liblo       - networked open sound control
52 Optional:
54 - FLTK (for the oldest user interface)
55 - NTK  (for the old user interface)
56 - JACK
57 - OSS
58 - ALSA
59 - LASH
60 - DSSI
61 - CxxTest (for unit tests)
63 Sibling projects
64 ~~~~~~~~~~~~~~~~
66 - rtosc       - realtime open sound control https://github.com/fundamental/rtosc
67 - mruby-zest  - the framework for the zyn-fusion GUI https://github.com/mruby-zest/mruby-zest
70 License
71 ~~~~~~~
73 ZynAddSubFX is available under the GPL-2.0-or-later license.
75 Have fun! :-)
77 --The ZynAddSubFX team