Merge WIP GSoC Signal Scope PR
[zynaddsubfx-code.git] / README.adoc
blob6ea517c3f6bb8f37eb9981f563b894e01d2e163d
1 ZynAddSubFX
2 -----------
4 image::https://travis-ci.org/zynaddsubfx/zynaddsubfx.svg?branch=master[alt="Build status", link="https://travis-ci.org/zynaddsubfx/zynaddsubfx"]
6 ZynAddSubFX is a fully featured musical software synthesizer for Linux, MacOS,
7 BSD, and Windows.
8 ZynAddSubFX exposes a wide array of synthesis parameters to make it flexible
9 tool for sound design and a fun experience for playing instruments.
11 image::doc/zyn-fusion-add.png[Zyn-Fusion Add Synth Editor]
13 Features
14 ~~~~~~~~
16 *   Polyphonic with support for legato and mono playing modes
17 *   Three synthesizer engines:
18 **      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.
19 **      Subtractive Synthesis for creating variable bandwidth harmonics from filtered white noise
20 **      PAD synthesis for creating beautiful pads and other instruments
21 *   Powerful waveform generator with up to 128 sine/non-sine harmonics
22 *   A variety of filters including analogue modeled filters, formant filters, and state variable filters.
23 *   Envelopes can have ADSR (or ASR, etc..) modes or can be free modes (with any shape)
24 *   Effects for Reverb, Echo, Chorus/Flange, Phasing, Wave-shaping, Equalizing, Dynamic Filtering with flexible signal routing
25 *   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.
26 *   Randomness settings to create subtle differences in each sound to help create that familiar analogue warmth.
27 *   Microtonal capabilities with any scale, up to 128 notes per octave, and key mapping
28 *   Extensive MIDI/Audio driver support including JACK, ALSA, OSS, and PortAudio
29 *   Session Management Support via LASH/NSM
30 *   Plugin Support via DSSI/LV2/VST
31 *   Over 1100 high quality instruments included
34 For more information see:
36 - The project page: http://zynaddsubfx.sf.net
37 - The mailing list: http://lists.sourceforge.net/mailman/listinfo/zynaddsubfx-user
38 - The public forum: http://www.kvraudio.com/forum/viewforum.php?f=47
39 - The IRC channel: ##zynaddsubfx on freenode
41 Dependencies
42 ~~~~~~~~~~~~
44 ZynAddSubFX depends on a number of dependencies for building.
45 For more information on building the core along with the FLTK based interface
46 see doc/building.txt and for building the new interface see
47 https://github.com/zynaddsubfx/zyn-fusion-build
49 Required:
51 - FFTW 3.x.x  - necessary for Fast Fourier computations
52 - MXML-2.5+   - from www.minixml.org
53 - zlib library from http://www.zlib.org
54 - Liblo - networked open sound control
56 Optional:
58 - FLTK (for the old user interface)
59 - NTK  (for the old user interface)
60 - JACK
61 - OSS
62 - ALSA
63 - CxxTest (for unit tests)
64 - LASH
65 - DSSI
67 Sibling projects:
69 - rtosc - realtime open sound control https://github.com/fundamental/rtosc
70 - mruby-zest - the framework for the zyn-fusion GUI
71                https://github.com/mruby-zest/mruby-zest
74 License
75 ~~~~~~~
77 ZynAddSubFX is available under the GPLv2+ license.
79 Have fun! :-)
81 --The ZynAddSubFX team