bump version to 3.5beta1

[supercollider.git] / README_WINDOWS.txt

------------------------------------------------------------------------\r
PsyCollider 3.2 (Supercollider 3.2 for Windows)\r
------------------------------------------------------------------------\r
\r
This is the Windows version of James McCartney's SuperCollider synthesis \r
engine (scsynth) and programming language (sclang). \r
Supercollider's main homepage is at\r
   http://supercollider.sourceforge.net/\r
\r
To get further information on SuperCollider usage or development, you\r
should subscribe to the mailing lists:\r
   http://www.beast.bham.ac.uk/research/sc_mailing_lists.shtml\r
\r
------------------------------------------------------------------------\r
System Requirements\r
------------------------------------------------------------------------\r
\r
* Windows 2000/XP/Vista\r
* Windows Installer \r
\r
Most common sound cards will work fine - the sound card should be one \r
that is supported by PortAudio (http://www.portaudio.com/). If you have \r
issues with latency, consult http://www.portaudio.com/docs/latency.html for \r
advice how to tune your operating system to achieve the best results \r
(in short: use ASIO drivers wherever possible).\r
\r
------------------------------------------------------------------------\r
How to install, and how to launch\r
------------------------------------------------------------------------\r
To install, simply run "setup.exe" and PsyCollider will install on your \r
System (default location is Program Files\PsyCollider).\r
\r
Start PsyCollider from your start menu.\r
\r
NOTE: Your system must provide both audio input and audio output. Otherwise \r
the synthesis server will not start (see also sc-users mailinglist discussion)\r
\r
Paths and files you may want to be aware of:\r
$PSYCOLLIDER_HOME$\startup.sc : system wide startup file\r
$USER_HOME$\SuperCollider\startup.sc : user startup file\r
$USER_HOME$\SuperCollider\Extensions : user extension folder for classes, plugins and help files\r
\r
\r
------------------------------------------------------------------------\r
    Note: THE FOLLOWING INFORMATION IS FOR DEVELOPERS ONLY!\r
    Most people don't need to know how to build SC3 from scratch...\r
------------------------------------------------------------------------\r
Building\r
------------------------------------------------------------------------\r
\r
To compile SuperCollider for yourself...\r
Check out the latest source from supercollider.sourceforge.net \r
\r
The following libraries are needed for compiling\r
* libsndfile (included in the sc code tree)\r
* portaudio\r
* portmidi\r
* pthread-Win32\r
* fftw3\r
* python\r
\r
You need Visual C++ 2008 (9.0) or the Express edition to build it. \r
\r
Let's call ROOT the folder you checked out the SuperCollider code tree (contains "build", "Source" etc.)\r
(Note that the SuperCollider code folder should be named "SuperCollider3" to avoid problems.)\r
\r
1: Python \r
----------------------\r
1) go to "http://python.org" and download and install the latest Python version (tested 2.5.1). \r
NOTE: get the Windows installer and make sure its the Unicode version and NOT the Ansii version.\r
\r
2) go to "http://wxpython.org" and download and install the corresponding wxPython binary (tested 2.8.6.1)\r
NOTE: again you need the Unicode version.\r
\r
NOTE: make sure you have an environment variable set called PYTHONPATH pointing to the base directory of you installation (Should be done by python installer).\r
\r
2: Portaudio + ASIO\r
----------------------\r
- reminder : you do NOT need to build portaudio. this is taken care of by the msvc project.\r
\r
1) go to "http://www.portaudio.com/" and download pa_snapshot_v19.tar.gz\r
(main page --> CVS (left menu) --> pa_snapshot_v19.tar.gz in the "v19-devel" branch section)\r
\r
2) uncompress it in the ROOT folder. normally, the portaudio folder has the correct name "portaudio".\r
folders must be like that :\r
\r
...\r
ROOT\..\portaudio\docs\r
ROOT\..\portaudio\src\r
....\r
\r
3) go to steinberg.net --> support --> 3rd party Developers (menu on the right) --> ASIO SDK Download. \r
If you agree on legal junk, you can enter a valid email address (please note that i do NOT know if you can safely Disagree with Steinberg sending your email address to commercial partners and receive the SDK info anyway...). \r
\r
4) once you receive the email (it took 5 minutes here), you can download asiosdk2.zip, copy and uncompress it to a temp folder. you must then copy some parts of the asio2 sdk to the PortAudio source tree.\r
\r
5) unpack the zip and put it next to portaudio. \r
\r
...\r
ROOT\..\asio-sdk\common\r
ROOT\..\asio-sdk\driver\r
...\r
\r
3: Portmidi\r
-----------\r
- reminder : you do NOT need to build portmidi. this is taken care of by the msvc project.\r
\r
1) checkout version 8 from http://portmedia.svn.sourceforge.net/svnroot/portmedia/portmidi/trunk/\r
\r
the folder structure needs to be like this:\r
...\r
ROOT\..\portmidi\pm_common\\r
ROOT\..\portmidi\portmidi.dsp\\r
...\r
\r
4: Pthread-win32\r
------------------------\r
- reminder : you do NOT need to build pthread-win32. this is taken care of by the msvc project.\r
\r
1) go to : "ftp://sources.redhat.com/pub/pthreads-win32" and get "pthreads-snap-yyyy-mm-dd.tar.gz". (known to work with "pthreads-snap-2005-01-25.tar.gz")\r
uncompress it and rename the folder to "pthread-win32" so that the source tree looks like :\r
\r
...\r
ROOT\..\pthread-win32\tests\r
ROOT\..\pthread-win32\announce\r
ROOT\..\pthread-win32\attr.c\r
...\r
NOTE : the home page is "http://sources.redhat.com/pthreads-win32"\r
\r
\r
5: fftw3\r
-----------------------\r
\r
1) go to: "http://www.fftw.org/install/windows.html" and download the "PRECOMPILED WINDOWS DLL".\r
\r
...\r
ROOT\..\fftw3\r
...\r
\r
You also need to run the instructions in the readme that accompany the fftw3 download, which tell you \r
how to generate "lib" files for your system.\r
\r
\r
6: libsndfile\r
-----------------------\r
\r
NOTE: THIS SECTION ABOUT LIBSNDFILE MAY BE OUT OF DATE. Libsndfile windows headers are now included by default. Please first try skipping this section, then come back if it doesn't work.\r
\r
Some libsndfile files are included in the sc3 source distribution - however, you need to do a couple of things to get libsndfile stuff compiling correctly on your system:\r
\r
* go to http://www.mega-nerd.com/libsndfile/#Download section and download the "Windows zip file including precompiled binaries"\r
* that zip file contains a readme with some instructions. Follow them.\r
* When done, place the following files into SuperCollider's "libsndfile" folder:\r
\r
...\r
ROOT\xtralibs\win\libsndfile\libsndfile-1.def\r
ROOT\xtralibs\win\libsndfile\libsndfile-1.dll\r
ROOT\xtralibs\win\libsndfile\libsndfile-1.exp\r
ROOT\xtralibs\win\libsndfile\libsndfile-1.lib\r
ROOT\xtralibs\include\libsndfile\sndfile.h\r
...\r
\r
\r
7: actually building and running the thing!\r
-------------------------------------------\r
\r
Once all the above is done, the Solution "SC3win.sln" should compile without problems (lots of warnings though...).\r
As a result you will have the plugins in build\plugins (scx files) and PySCLang in ($PYTHONHOME)\lib\site-packages\r
\r
(The building of the "PySClang" target should also result in a few necessary files being copied into the "build" \r
folder. Namely Psycollider.py, startup.sc, keywords.list, libsndfile.dll, libfftw3f-3.dll.)\r
\r
\r
Then open a Terminal and run: python.exe Psycollider.py \r
\r
\r
------------------------------------------------------------------------\r
Environment\r
------------------------------------------------------------------------\r
\r
Environment variables add directories to the default search path for plugins and synth definitions, respectively. Directory names are separated by ';' and must be set through the Control Panel. \r
\r
 * SC_PLUGIN_PATH, SC_SYNTHDEF_PATH\r
\r
------------------------------------------------------------------------\r
Reporting bugs\r
------------------------------------------------------------------------\r
\r
Please report bugs either to the sc-users or sc-dev mailing lists.\r
\r
------------------------------------------------------------------------\r
Outro\r
------------------------------------------------------------------------\r
\r
thanks to james mccartney, for making this great piece of audio\r
software publically and freely available.\r