commit 0ab05ad6ed8680ade3ba8e3971b0cb135065ca8c
parent 867987f5b5a917a632c46e777dbe50d7117855fd
Author: fundamental <mark.d.mccurry@gmail.com>
Date: Mon, 19 Dec 2011 17:30:06 -0500
Documentation: Fixing out of date information
- Removing information on old makefile system
- Removing information on windows build
- Mentioning New IO backend
Diffstat:
8 files changed, 33 insertions(+), 269 deletions(-)
diff --git a/FAQ.txt b/FAQ.txt
@@ -23,5 +23,5 @@ A3) Look in src/globals.h and change there these values. You don't have to chang
Q4) How do I enable Jack support on ZynAddSubFX ?
-A4) Look in "Makefile.inc" from "src/" directory for more information. It is highly recommended that the Jack samplerate to be equal to ZynAddSubFX samplerate (SAMPLE_RATE from globals.h), otherwise the resampling will be done and this will decrease the quality a bit.
+A4) If your system has the jack libraries installed, ZynAddSubFX should automatically build with jack support. It is highly recommended that the Jack samplerate to be equal to ZynAddSubFX samplerate (SAMPLE_RATE from globals.h), otherwise the resampling will be done and this will decrease the quality a bit.
diff --git a/README.txt b/README.txt
@@ -26,58 +26,49 @@ ZynAddSubFX is also available on many Internet sites like:
Requirements:
-------------
- - a fast computer
- - Linux (tested with RedHat 7.2,7.3,etc.) or Windows
- - FFTW 3.x.x - necessary for Fast Fourier computations
- - MXML-2.5 library from www.minixml.org
- - zlib library from http://www.zlib.org - this exists in most Linux distributions
- - (for Linux) OpenSoundSystem (OSS) (if you don't have ALSA, only)
- - (for Windows) pthreads, portaudio
+- a fast computer
+- Linux or Windows
+- FFTW 3.x.x - necessary for Fast Fourier computations
+- MXML-2.5 or more recent library from www.minixml.org
+- zlib library from http://www.zlib.org
+- (for Linux) OpenSoundSystem (OSS) (if you don't have ALSA, only)
+- (for Windows) pthreads, portaudio
Not required, but recommended:
----------------------------
-
- - FLTK 1.x.x (tested with fltk 1.1.0, 1.1.1, 1.1.2,etc.)
- - ALSA 0.9.x or later (with OSS emulation, if you don't use JACK)
- - JACK - if you want to use it you must enable compilation for JACK in Makefile.inc
- - a VST host for the VST version [For more information see:
- http://www.kvraudio.com/forum/viewtopic.php?t=268277&sid=95be0b6c9909300d566006428bcbb97d]
+------------------------------
+- FLTK 1.x.x (tested with fltk 1.1.0, 1.1.1, 1.1.2,etc.)
+- ALSA 0.9.x or later (with OSS emulation, if you don't use JACK)
+- JACK
+- a VST host for the VST version [For more information see:
+ http://www.kvraudio.com/forum/viewtopic.php?t=268277&sid=95be0b6c9909300d566006428bcbb97d]
Compilation:
------------
- For the main program see doc/build.txt .
+ For the main program see doc/build.txt.
To compile the Spliter, run "make" from the "Spliter" directory.
To compile the Controller, run "make" from the "Controller" directory.
Running on LINUX
----------------
- *AUDIO OUTPUT
- A) OSS (Open Sound System)
- B) JACK (JACK Audio Connection Kit)
-
- *MIDI INPUT*
- There are 2 possibilities of midi inputs (depends on what you have chosen in Makefile.inc to use - OSS or ALSA).
- A) ALSA (Advanced Linux Sound Architecture)
- 1) Launch ZynAddSubFX
- 2) ZynAddSubFX will make a virtual MIDI port.
- You can connect other midi devices (like a real MIDI keyboard, midi sequencers which supports ALSA or virtual keyboard - like vkeybd).
- To connect, use "aconnect" or "alsa-patch-bay"; usualy the port of ZynAddSubFX is 128:0 or 129:0.
- 3) You are ready to play
-
- It is possible to use midi sequencer/other software that doesn't supports ALSA with ZynAddSubFX, but this is a bit more complicated.
- Search on Internet for "HOWTO Use MIDI Sequencers With Softsynths" by Frank Barknecht, if you want to do this.
+Under linux there are several options for both audio output and MIDI input.
+Defaults are set at compile time and the desired backend can be set when starting ZynAddSubFX with the '-I' and '-O' options.
+The currently supported backends are:
+- Audio Output
+ * ALSA (Advanced Linux Sound Architecture)
+ * OSS (Open Sound System)
+ * JACK (JACK Audio Connection Kit)
+ * Port Audio
- B) OSS (Open Sound System)
- 1) Launch ZynAddSubFX
- 2) Connect the MIDI keyboard
-
- 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
+- MIDI Input
+ * ALSA
+ * OSS
+ * JACK
Running on WINDOWS
------------------
NOTE: At this time only older versions of ZynAddSubFX were compiled on windows
- See older versions on sf.net
+ See older versions on sf.net (ie version 2.2.1)
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.
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.
Eg: (in autoexec.bat or launched before running ZynAddSubFX) "set PA_MIN_LATENCY_MSEC=50"
@@ -86,6 +77,7 @@ NOTE: At this time only older versions of ZynAddSubFX were compiled on windows
Eg: "set PA_RECOMMENDED_OUTPUT_DEVICE=1"
A better way to set all of this, I will put on next versions.
+
Please send me instruments,banks,master settings,songs(midi+...xmz files) done with ZynAddSubFX. I'll appreciate this.
diff --git a/ZynAddSubFX.lsm b/ZynAddSubFX.lsm
@@ -2,14 +2,14 @@ Begin4
Title: ZynAddSubFX
Version: 2.2.1
Entered-date: 28-04-2005
-Description: A real-time software synthesizer for Linux and Windows with many
+Description: A real-time software synthesizer for Linux with many
features, including polyphony, multi-timbral and microtonal
capabilities. It includes randomness of some parameters,which
makes warm sounds, like analogue synthesizers.
The program has system/insertion effects, too.
ZynAddSubFX has much more features, don't let be cheated by
the size of the source code :)
-Keywords: synthesizer,MIDI,ALSA,music,X11,microtonal,real-time,windows
+Keywords: synthesizer,MIDI,ALSA,music,X11,microtonal,real-time
Author: zynaddsubfx@yahoo.com (Nasca Paul)
Maintained-by: zynaddsubfx@yahoo.com (Nasca Paul)
Primary-site: zynaddsubfx.sourceforge.net
@@ -17,6 +17,6 @@ Primary-site: zynaddsubfx.sourceforge.net
920k ZynAddSubFX-2.2.0.tar.bz2 (source code)
Alternate-site:
Original-site:
-Platforms: Linux with X11 or Windows
-Copying-policy: GNU General Public License (version 2 or later)
+Platforms: Linux with X11
+Copying-policy: GNU General Public License (version 2)
End
diff --git a/bugs.txt b/bugs.txt
@@ -1 +0,0 @@
-Possible issue with building the JACK output in some systems
diff --git a/compile.win32 b/compile.win32
@@ -1,40 +0,0 @@
-ZynAddSubFX Compilation on Windows as standalone .EXE
------------------------------------------------------
-You don't have to compile it, there are Windows binaries available on the webpage.
-Anyway if you want to compile, good luck :)
-
-First, you have to download and install Mingw and MSYS (www.mingw.org). Download the FLTK sources (www.fltk.org), compile and install.
-Second, you have to download, compile and install pthreads for windows (http://sources.redhat.com/pthreads-win32). You need to compile in GC mode.
-Also, you have to compile the portaudio library (www.portaudio.com). It it doesn't install itself, and you must copy the header files to the "include" directories from mingw(msys) and compiled libraries to the "lib" directory from mingw.
-You need zlib and mxml-2.0.
-
-In short, the dependencies directories are (but some version might differ):
-MinGW-3.1.0-1.exe
-MSYS-1.0.10.exe
-fftw-3.0.1.tar.gz
-fltk-1.1.5rc2-source.tar.bz2
-mxml-2.0.tar.gz
-portaudio_v18_1.zip
-pthreads-2004-06-22.exe
-zlib-1.2.1.tar.bz2
-
-
-Change the Makefile.inc, and change the compilation options (like operating system,etc.). Now, run make from msys.
-After the compilation, copy in the dll files (pthreadGC.dll and (portaudio.dll if required)) to the directory where "zynaddsubfx.exe" is.
-Hope all goes right.
-
-ZynAddSubFX Compilation on Windows as VST plugin (dll file)
-----------------------------------------------------------
-Edit the Makefile.inc and set "WINDOWS_VST" to "YES". The audioout and midiin are automatically set to VST.
-Get the vstsdk2 (or 2.3) and copy it to the directory where ZynAddSubFX-2.x.x is.
-If you copy ZynAddSubFX in "C:\temp" and you will run "dir" you should see the ZynAddSubFX-2.x.x and "vstsdk2" in the same directory (C:\temp).
-
-Run the makefile. Hope all will goes right. Please notice that "make clean" removes the vst object files that you compiled form vstsdk2. That's why is recommended to keep a backup copy of these object files.
-You must copy the pthreads.dll file to windows directory (or else, ZynAddSubFX will not work). Btw: how can I make pthreads static?
-Copy the zynaddsubfx_vst.dll to your dll directory.
-
-BUGS only on vst port:
-Also, to avoid more bugs, I had limited ZynAddSubFX to one instance. Please report me how it behaves on various vst hosts.
-I hope that I will remove these bugs on later versions.
-
-
diff --git a/src/launch_zynaddsubfx.bat b/src/launch_zynaddsubfx.bat
@@ -1,3 +0,0 @@
-set PA_MIN_LATENCY_MSEC=70
-start zynaddsubfx.exe
-exit
diff --git a/src/zynaddsubfx.nsi b/src/zynaddsubfx.nsi
@@ -1,181 +0,0 @@
-; Script generated by the HM NIS Edit Script Wizard and modified by Nasca Paul.
-
-; HM NIS Edit Wizard helper defines
-!define PRODUCT_NAME "ZynAddSubFX"
-!define PRODUCT_VERSION "2.2.0"
-!define PRODUCT_PUBLISHER "Nasca Octavian Paul"
-!define PRODUCT_WEB_SITE "http://zynaddsubfx.sourceforge.net"
-!define PRODUCT_DIR_REGKEY "Software\Microsoft\Windows\CurrentVersion\App Paths\zynaddsubfx.exe"
-!define PRODUCT_UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${PRODUCT_NAME}"
-!define PRODUCT_UNINST_ROOT_KEY "HKLM"
-
-SetCompressor lzma
-
-; MUI 1.67 compatible ------
-!include "MUI.nsh"
-
-; MUI Settings
-!define MUI_ABORTWARNING
-!define MUI_ICON "${NSISDIR}\Contrib\Graphics\Icons\modern-install.ico"
-!define MUI_UNICON "${NSISDIR}\Contrib\Graphics\Icons\modern-uninstall.ico"
-/*
-var VSTDIR ;
-
-Function .onInit
-; StrCpy "$INSTDIR" $VSTDIR
-FunctionEnd
-*/
-
-; Welcome page
-!insertmacro MUI_PAGE_WELCOME
-; License page
-!insertmacro MUI_PAGE_LICENSE "COPYING.txt"
-; Components page
-!insertmacro MUI_PAGE_COMPONENTS
-; Directory page
-!insertmacro MUI_PAGE_DIRECTORY
-/*
-;VST directory
-PageEx directory
- DirVar $VSTDIR
-PageExEnd
-*/
-
-; Instfiles page
-!insertmacro MUI_PAGE_INSTFILES
-; Finish page
-!insertmacro MUI_PAGE_FINISH
-
-; Uninstaller pages
-!insertmacro MUI_UNPAGE_INSTFILES
-
-; Language files
-!insertmacro MUI_LANGUAGE "English"
-
-; Reserve files
-!insertmacro MUI_RESERVEFILE_INSTALLOPTIONS
-
-; MUI end ------
-
-
-Name "${PRODUCT_NAME} ${PRODUCT_VERSION}"
-OutFile "Setup_ZynAddSubFX.exe"
-InstallDir "$PROGRAMFILES\ZynAddSubFX"
-InstallDirRegKey HKLM "${PRODUCT_DIR_REGKEY}" ""
-;ShowInstDetails show
-;ShowUnInstDetails show
-
-
-Section "-Required" SEC01
- SetOutPath "$INSTDIR"
- SetOverwrite ifnewer
- File "README.txt"
- File "HISTORY.txt"
- File "FAQ.txt"
- File "COPYING.txt"
- File "ChangeLog.txt"
- File "bugs.txt"
-; File "Warning.txt"
- File "zynaddsubfx_icon.ico"
- File /r "banks"
- File /r "examples"
- File /r "presets"
-
- SetOutPath "$SYSDIR"
- File "pthreadGC1.dll"
-SectionEnd
-
-Section "Standalone" SEC02
- SetOutPath "$INSTDIR"
- File "zynaddsubfx.exe"
- File "launch_zynaddsubfx.bat"
- CreateDirectory "$SMPROGRAMS\ZynAddSubFX"
- CreateShortCut "$SMPROGRAMS\ZynAddSubFX\ZynAddSubFX low latency.lnk" "$INSTDIR\launch_zynaddsubfx.bat" "-Y" "$INSTDIR\zynaddsubfx_icon.ico"
- CreateShortCut "$SMPROGRAMS\ZynAddSubFX\ZynAddSubFX.lnk" "$INSTDIR\zynaddsubfx.exe" "-Y" "$INSTDIR\zynaddsubfx_icon.ico"
- CreateShortCut "$DESKTOP\ZynAddSubFX.lnk" "$INSTDIR\launch_zynaddsubfx.bat" "-Y" "$INSTDIR\zynaddsubfx_icon.ico"
-SectionEnd
-
-;Section /o "VST Plugin" SEC03
-; SetOutPath "$INSTDIR\VST"
-; File "zynaddsubfx_vst.dll"
-;SectionEnd
-
-Section /o "Source Code" SEC04
- SetOutPath "$INSTDIR"
- File /r "source code"
-SectionEnd
-
-Section -AdditionalIcons
- WriteIniStr "$INSTDIR\${PRODUCT_NAME}.url" "InternetShortcut" "URL" "${PRODUCT_WEB_SITE}"
- CreateShortCut "$SMPROGRAMS\ZynAddSubFX\Website.lnk" "$INSTDIR\${PRODUCT_NAME}.url"
-
-; sa sterg uninstall icon
- CreateShortCut "$SMPROGRAMS\ZynAddSubFX\Uninstall.lnk" "$INSTDIR\uninst.exe"
-SectionEnd
-
-Section -Post
- WriteUninstaller "$INSTDIR\uninst.exe"
- WriteRegStr HKLM "${PRODUCT_DIR_REGKEY}" "" "$INSTDIR\zynaddsubfx.exe"
- WriteRegStr ${PRODUCT_UNINST_ROOT_KEY} "${PRODUCT_UNINST_KEY}" "DisplayName" "$(^Name)"
- WriteRegStr ${PRODUCT_UNINST_ROOT_KEY} "${PRODUCT_UNINST_KEY}" "UninstallString" "$INSTDIR\uninst.exe"
- WriteRegStr ${PRODUCT_UNINST_ROOT_KEY} "${PRODUCT_UNINST_KEY}" "DisplayIcon" "$INSTDIR\zynaddsubfx.exe"
- WriteRegStr ${PRODUCT_UNINST_ROOT_KEY} "${PRODUCT_UNINST_KEY}" "DisplayVersion" "${PRODUCT_VERSION}"
- WriteRegStr ${PRODUCT_UNINST_ROOT_KEY} "${PRODUCT_UNINST_KEY}" "URLInfoAbout" "${PRODUCT_WEB_SITE}"
- WriteRegStr ${PRODUCT_UNINST_ROOT_KEY} "${PRODUCT_UNINST_KEY}" "Publisher" "${PRODUCT_PUBLISHER}"
-SectionEnd
-
-; Section descriptions
-!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
- !insertmacro MUI_DESCRIPTION_TEXT ${SEC01} "Required files for ZynAddSubFX "
- !insertmacro MUI_DESCRIPTION_TEXT ${SEC02} "ZynAddSubFX as a standalone synth"
-; !insertmacro MUI_DESCRIPTION_TEXT ${SEC03} "ZynAddSubFX as a VST plugin (not stable on every host)"
- !insertmacro MUI_DESCRIPTION_TEXT ${SEC04} "Full source code of ZynAddSubFX"
-!insertmacro MUI_FUNCTION_DESCRIPTION_END
-
-
-Function un.onUninstSuccess
- HideWindow
- MessageBox MB_ICONINFORMATION|MB_OK "$(^Name) was successfully removed from your computer."
-FunctionEnd
-
-Function un.onInit
- MessageBox MB_ICONQUESTION|MB_YESNO|MB_DEFBUTTON2 "Are you sure you want to completely remove $(^Name) and all of its components? $\r (INCLUDING THE USER-MADE INSTRUMENTS,ETC !!!)" IDYES +2
- Abort
-FunctionEnd
-
-Section Uninstall
- Delete "$INSTDIR\README.txt"
- Delete "$INSTDIR\HISTORY.txt"
- Delete "$INSTDIR\FAQ.txt"
- Delete "$INSTDIR\COPYING.txt"
- Delete "$INSTDIR\ChangeLog.txt"
- Delete "$INSTDIR\bugs.txt"
- Delete "$INSTDIR\Warning.txt"
- Delete "$INSTDIR\zynaddsubfx.exe"
- Delete "$INSTDIR\zynaddsubfx.url"
- Delete "$INSTDIR\launch_zynaddsubfx.bat"
- Delete "$INSTDIR\zynaddsubfxXML.cfg"
- Delete "$INSTDIR\uninst.exe"
- Delete "$INSTDIR\zynaddsubfx.ico"
- Delete "$INSTDIR\zynaddsubfx_icon.ico"
- RMDir /r "$INSTDIR\banks"
- RMDir /r "$INSTDIR\examples"
- RMDir /r "$INSTDIR\presets"
- RMDir /r "$INSTDIR\source code"
- RMDir /r "$INSTDIR\VST"
-
- Delete "$SMPROGRAMS\ZynAddSubFX\Uninstall.lnk"
- Delete "$SMPROGRAMS\ZynAddSubFX\Website.lnk"
- Delete "$STARTMENU.lnk"
- Delete "$DESKTOP\ZynAddSubFX.lnk"
- Delete "$SMPROGRAMS\ZynAddSubFX\ZynAddSubFX.lnk"
- Delete "$SMPROGRAMS\ZynAddSubFX\ZynAddSubFX low latency.lnk"
-
- RMDir "$SMPROGRAMS\ZynAddSubFX"
- RMDir "$INSTDIR"
- RMDir ""
-
- DeleteRegKey ${PRODUCT_UNINST_ROOT_KEY} "${PRODUCT_UNINST_KEY}"
- DeleteRegKey HKLM "${PRODUCT_DIR_REGKEY}"
- SetAutoClose true
-SectionEnd
diff --git a/src/zynaddsubfx_gcc.def b/src/zynaddsubfx_gcc.def
@@ -1,3 +0,0 @@
-LIBRARY ZYNADDSUBFX
-DESCRIPTION 'ZynAddSubFX for VST'
-EXPORTS main=main_plugin
