README.txt

   1 ZynAddSubFX
   2 -----------
   3 It is a realtime software synthesizer for Linux and Windows with many features. Please see the docs for details.
   4 Copyright (c) 2002-2006 Nasca Octavian Paul and others contributors
   5 e-mail: zynaddsubfx AT yahoo D0T com
   6 ZynAddSubFX is free program and is distributed WITH NO WARRANTY. It is licensed under GNU General Public License version 2 (and only version 2) - see the file COPYING.
   7
   8     --==## PLEASE SHARE YOUR INSTRUMENTS/MASTER SETTINGS ##==--
   9               --==## MADE WITH ZynAddSubFX ##==--
  10     Here is the mailing list where you can share your patches with others:
  11       http://lists.sourceforge.net/mailman/listinfo/zynaddsubfx-user
  12
  13
  14 The project page is
  15     http://sourceforge.net/projects/zynaddsubfx
  16         or
  17     http://zynaddsubfx.sourceforge.net
  18
  19 ZynAddSubFX is also available on many Internet sites like:
  20         http://www-ccrma.stanford.edu/planetccrma/software/soundapps.html (Planet CCRMA)
  21         http://www.hitsquad.com/smm/programs/ZynAddSubFX/
  22         http://freshmeat.net/projects/zynaddsubfx/
  23         http://ibiblio.org/pub/Linux/apps/sound/midi/
  24         or search "ZynAddSubFX" on a search engine (like www.google.com).
  25
  26
  27 Requirements:
  28 -------------
  29                - a fast computer
  30                - Linux (tested with RedHat 7.2,7.3,etc.) or Windows
  31                - FFTW 2.x.x (tested with fftw 2.0.5, 2.1.3) - necessary for
  32   Fast Fourier computations
  33                - MXML-2.2 library from http://www.easysw.com/~mike/mxml/
  34                - zlib library from http://www.zlib.org - this exists in most Linux distributions
  35                - (for Linux) OpenSoundSystem (OSS) (if you don't have ALSA, only)
  36                - (for Windows) pthreads, portaudio
  37
  38 Not required, but recommended:
  39 ---------------------------
  40
  41     - FLTK 1.x.x (tested with fltk 1.1.0, 1.1.1, 1.1.2,etc.)
  42     - ALSA 0.9.x or later (with OSS emulation, if you don't use JACK)
  43     - JACKit - if you want to use it you must enable compilation for JACK in Makefile.inc
  44     - a VST host for the VST version
  45
  46 Compilation:
  47 ------------
  48     If you want to compile on Windows, please read compile.win32 file.
  49     If you don't know how to compile, you may download binaries from Planet CCRMA (see above, on sites).
  50     First set what should sound input/ouput should use in Makefile.inc in src/ directory.
  51     Then "make" from the "src/" directory. Hope all goes right. If the compiler complains something about FFTwrapper.h and FFTW library headers(rfftw.h or fftw.h) please read the docs from DSP/FFTwrapper.h .
  52     To compile the Spliter, run "make" from the "Spliter" directory.
  53     To compile the Controller, run "make" from the "Controller" directory.
  54
  55 Running on LINUX
  56 ----------------
  57   *AUDIO OUTPUT
  58    A) OSS (Open Sound System)
  59    B) JACK (JACK Audio Connection Kit)
  60
  61   *MIDI INPUT*
  62     There are 2 possibilities of midi inputs (depends on what you have chosen in Makefile.inc to use - OSS or ALSA).
  63     A) ALSA (Advanced Linux Sound Architecture)
  64         1) Launch ZynAddSubFX
  65         2) ZynAddSubFX will make a virtual MIDI port.
  66            You can connect other midi devices (like a real MIDI keyboard, midi sequencers which supports ALSA or virtual keyboard - like vkeybd).
  67            To connect, use "aconnect" or "alsa-patch-bay"; usualy the port of ZynAddSubFX is 128:0 or 129:0.
  68         3) You are ready to play
  69
  70            It is possible to use midi sequencer/other software that doesn't supports ALSA with ZynAddSubFX, but this is a bit more complicated.
  71            Search on Internet for "HOWTO Use MIDI Sequencers With Softsynths" by Frank Barknecht, if you want to do this.
  72
  73
  74     B) OSS (Open Sound System)
  75        1) Launch ZynAddSubFX
  76        2) Connect the MIDI keyboard
  77
  78        As you have seen the OSS option needs a real midi keyboard. If you don't have it, you can download/install ALSA from www.alsa-project.org
  79
  80 Running on WINDOWS
  81 ------------------
  82     If you launch zynaddsubfx.exe and nothing happens, you need pthreadGC.dll  in the same directory (or windows directory). The dll files are distribuited with ZynAddSubFX windows binaries.
  83     It might be possible that the latency will be very high. If this happens, you have to set the environment variable PA_MIN_LATENCY_MSEC to a value that represents the latency in miliseconds.
  84         Eg: (in autoexec.bat or launched before running ZynAddSubFX) "set PA_MIN_LATENCY_MSEC=50"
  85     Warning: if the value is too low, you might encounter severe dropouts on ZynAddSubFX. You'll have to set to a higher value and turn off automated background tasks (like virus scanners, email clients, etc.).
  86     If you have more cards, you can select the desired card where you can play audio with the environment variable "PA_RECOMMENDED_OUTPUT_DEVICE"
  87         Eg: "set PA_RECOMMENDED_OUTPUT_DEVICE=1"
  88     A better way to set all of this, I will put on next versions.
  89
  90 Please send me instruments,banks,master settings,songs(midi+...xmz files) done with ZynAddSubFX. I'll appreciate this.
  91
  92
  93 Have fun! :-)
  94
  95