(Old) Installation Notes for Serpent on 64-bit Windows

Roger B. Dannenberg

There are two versions of serpent; one is a command line program and the other is a graphical interface program:

serpent64 -- command line version
wxserpent64 -- serpent with wxWidgets linked in to provide a graphical interface

Serpent is currently released as an SVN repository and in three files (the "nnn" is the corresponding SVN version number):

serpent-win-nnn.exe - Windows installer: serpent64.exe, wxserpent64.exe, and serpent libraries
serpent-src-nnn.zip - Source code for any platform (Linux, Windows, OS X)
(serpent-mac-nnn.zip - Mac OS X (32 bit) executable and bundle: serpent and wxserpent.app)

The "win" exe is an installer with pre-compiled programs. The "src" zip file contains sources for all platforms.
This file describes installing true 64-bit applications on 64-bit Windows. Currently, the 64-bit version of Serpent is more actively used and supported, and is therefore recommended. Contact me if you need a 32-bit version.

Installing Compiled Programs

You should be able to simply download serpent-win-nnn.exe to your machine and run it to install serpent64 and wxserpent64. The installer will also set the registry with a search path to serpent libraries (lib, programs, and wxslib are on the path). The installer will also ask permission to add the installation directory to your Windows environment Path variable, but the setting does not take effect until you log out and log in again.
The executables are (for Windows): serpent64.exe and wxserpent64.exe.

Three things to keep in mind:

Both serpent64 (a command line program) and wxserpent64 (serpent with graphical toolkit) should be run from the command line.
To run an executable from a command line, your system must be able to find it. The installer will modify your Path. If you move the installed code (default is in Program Files (x86)\Serpent), you will need to update the Path as well:

Open Control Panel: Systems and Maintenance: System: Advanced System Settings. Click on the "Advanced" tab, then the "Environment Variables" button. Under "User variables," edit the value for Path.

You also need a path for Serpent (called SERPENTPATH). The installer will try to set SERPENTPATH (without asking). Indications are that Windows 8 blocks the installer, so you may have to do this step manually. Also, if you move the installation or want to add other directories, set the entry yourself. To manually change SERPENTPATH, go to (or create) the registry entry:
"My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\CMU\Serpent\"
and add a new string value there named "SERPENTPATH". Set the Data (value) to the path. On a default installation, this Data is "c:\Program Files (x86)\Serpent\lib\;c:\Program Files (x86)\Serpent\programs\;c:\Program Files (x86)\Serpent\wxslib". (The quotes are not part of the Data.) To set this, go to the Start menu and select "Run...", then type in "regedit" and click "OK". Use this editor to create and set the path. The RegEdit program gives you access to all kinds of critical internal settings for your machine. Be careful.

Testing:

Run serpent64 from a command prompt:

serpent64
> print "hello world"
hello world
> exit()

This will run the init.srp in lib, which is a good simple test.

Try

wxserpent64 wxs_test.srp

to test wxserpent64 and see a variety of input controls. The screen will look something like this:

Building From Sources

If you want to build from sources, get the "src" zip file. You can also get the very latest sources from SourceForge using SVN (subversion, a configuration management tool). The Linux command to create a serpent directory (in the current directory) with the lastest sources is:

svn checkout svn://svn.code.sf.net/p/serpent/code/trunk serpent
or, if you are a developer and plan to commit changes back to SourceForge,
svn checkout svn+ssh://rbd@svn.code.sf.net/p/serpent/code/trunk serpent

Important: If your serpent directory contains trunk, tags, and branches, check the code above and try again. For these instructions to work, all the repository files in trunk must be copied to the local working copy named serpent. E.g. you should have serpent/README.txt, serpent/32bit, and serpent/64bit. After you install liblo, you should have serpent/../liblo.

I use Tortoise SVN and Microsoft Visual Studio Express 2013 for Windows on Windows 7 Home Premium. Here's how I build from sources on Windows:

Download wxWindows 2.8.10 (only necessary for wxserpent).
If you do not have Microsoft Visual Studio Express 2013 for Windows, you can install a free version.
If you want to enable some OpenGL capabilities, you will need to edit wxWidgets-2.8.10\include\wx\msw\setup.h. Find the define for wxUSE_GLCANVAS and set it to 1 for OpenGL. If you do this, you will need to link with OpenGL libraries, which are part of Windows, as well as freeglut libraries which are not. See http://www.transmissionzero.co.uk/software/freeglut-devel/ to get freeglut. You will need to copy:
1. freeglut/bin/x64/freeglut.dll to c:\windows\system32,
2. freeglut/lib/x64/freeglut.lib to C:\Program Files (x86)\Windows Kits\8.1\Lib\winv6.3\um\x64\, (to double-check, see the project property page under Configuration Properties: VC++ Directorie: Library Directories, open for edit, and click the Macros button to see the value of $(WindowsSDK_LibraryPath_x64)). Note: For Visual Studio Community 2015, I used freeglut-3.0.0, and copied freeglut_static.lib to C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\lib\amd64\freeglut_static.lib and freeglut_staticd.lib (for debug version) -- I think this causes a warning in debug versions about LIBCMT, so probably there should be a different version of freeglut for debugging.
3. freeglut/include/GL/glut.h, freeglut/include/GL/freeglut_std.h to C:\Program Files (x86)\Windows Kits\8.1\Include\um\gl\
4. https://www.opengl.org/registry/api/glext.h to C:\Program Files (x86)\Windows Kits\8.1\Include\um\gl\

Note that the .h files go in include\um\gl, not include or include\um.
Instead of \v6.0A\, use \v7.0A\ for Windows 7, etc.

Build wxWindows libraries:

For Windows8.1, you must first patch the source. See http://trac.wxwidgets.com/attachment/ticket/15650/fontenum.cpp.patch.

Open wxWidgets-2.8.12\build\msw\wx_dll.dsw in Visual Studio Express for the debug version, or wxWidgets-2.8.12\build\msw\wx.dsw for the release version. (If you are a developer, you'll build both, one-at-a-time.)
Allow Visual Studio to update the solution to your version of Visual Studio. In the future, open wx_dll.sln or wx.sln.
Add x64 configurations - use the drop-down menu with "win32" to open the configuration manager, select "new ..." configuration, and select "x64" (use the defaults: "Copy settings from Win32" and "create new project platforms."
Select "Debug" for the debug version of wxSerpent, or "Release" for the release version.
For the Release version (needed for the Release version of Serpent), go to each project and change code generation from /MD to /MT (Multithreaded -- static, not DLL).
If you get a "Cannot open include file: 'pbt.h'" error, just comment out the include (maybe this is fixed in your version of wxWidgets already.)

You must install CMake.
Serpent now has 2 versions of Open Sound Control and O2, which is an upwards-compatible extension. I recommend O2, but if you want the old OSC interface in Serpent, I recommend the built-in version. (One advantage is it has a way to get UDP through NAT -- but if you want that, you should ask Dannenberg to put it into O2; it's not that hard now that we have example code.) If you really want the liblo version of OSC, you need liblo, as follows:
Download liblo at the same level as serpent, e.g. /home/rbd/liblo, /home/rbd/serpent. Notice the directory is liblo, not liblo-0.26 or some other name. Within liblo, you should find a file named configure along with many other files, not a directory named liblo-0.26.
make a directory called portmedia at the same level as the serpent directory.
download PortMidi into portmedia, e.g. C:/Users/rbd/portmedia/portmidi, C:/Users/rbd/serpent, C:/Users/rbd/liblo
build PortMidi (see documentation in Installing PortMidi on Windows).
- When you first open portmidi/CMakeLists.txt, tell CMake to generate for Win64. Otherwise, it seems that some files might be put in an x64 subfolder, confusing other scripts.
- Be sure to get and install PmDefaults.exe (you should not have to build it).
download pthreads-win32-2-8-0-release.exe. (Look near the bottom of the list of files.)
un-archive the files to pthreads (at the same level as serpent). The result should be, e.g. C:/Users/rbd/serpent, C:/Users/pthreads/pthreads.2
download zeromq-4.0.5 and unzip the file. You should have a folder named zeromq-4.0.5 containing a folder also named zeromq-4.0.5. Rename the innermost folder ZeroMQ and move it to the same level as serpent, e.g. /home/rbd/ZeroMQ, /home/rbd/serpent. Notice the directory name ZeroMQ is not ZeroMQ-2.2.0 or any default name. Within ZeroMQ, after installation, you should find builds/msvc/msvc.sln. (Ignore builds/msvc/msvc10.sln). Here's the basic plan. More details are below: With Batch Build, build libzmq for StaticDebug and StaticRelease. Copy the Debug version, which oddly might end up in ZeroMQ/lib/libzmq_d.lib to ZeroMQ/lib/Debug/zmq_s.lib. Copy the Release version, which oddly might end up in ZeroMQ/lib/libzmq.lib to ZeroMQ/lib/Release/zmq_s.lib. (The _s in these names is to avoid any confusion or search paths that might link to a dynamic library instead of the static one.)
build liblo if you want to use it (I recommend not; if not, you'll use a built-in OSC implementation that does not support timestamps and bundles, but does have some features missing from liblo.

In the liblo/build directory, run in a command prompt window:
premake4 vs2008
In the liblo/build/vs2008 directory, open liblo.sln:
cd vs2008
start liblo.sln
Right click on the liblo project and select Properties.
In the properties dialog window:

Configuration Properties : C/C++ : General : Additional Include Directories and select "All Configurations". The value of "Additional Include Directories" (click at the right on "..." button to open an editor) should be:
../../lo
../../src
../..
../../../pthreads/pthreads.2

Select Configuration Properties : C/C++ : Code Generation and select the "ReleaseLib" Configuration. Set the Runtime Library to Multi-threaded (/MT).

Select Configuration Properties : General and select the "ReleaseLib" Configuration. Set the Output Directory to ..\..\lib\Release.

Select Configuration Properties : General and select the "DebugLib" Configuration. Set the Output Directory to ..\..\lib\Debug.
Select Configuration Properties : Librarian and select the "DebugLib" Configuration. Set the Output File to $(OutDir)\liblo.dll (change from $(OutDir)\liblo_d.dll)

Open Build : Batch Build... and select only DebugLib and ReleaseLib for project liblo
For Visual C++ 2008 Express Edition, I had to modify lo/lo_endian.h. My version is in serpent/src/lo_endian.h. You should back up or rename liblo/lo/lo_endian.h, then copy serpent/src/lo_endian.h to liblo/lo/lo_endian.h.
Click the Build button

build ZeroMQ:

Modify ZeroMQ/include/zmq.h as follows: Before the comment /* Handle DSO symbol visibility */, insert the following lines:
```
#ifndef ZMQ_STATIC
#define ZMQ_STATIC
#endif
```
This enables ZeroMQ clients to link to a static library.
Open Visual Studio and open ZeroMQ/builds/msvc/msvc.sln.
Use the View/Solution Explorer menu item or CTRL+ALT+L to show the "solution."
Right click libzmq, select Properties to open the Properties window.
Select StaticRelease from the Configurations drop-down menu (upper left region in window).
This seems unnecessary: Under Configuration Properties/General, change Configuration Type to Static Library (.lib).
Under Configuration Properties/C-C++/Code Generation, change Runtime Library to Multi-threaded (/MT). Do not use Multi-threaded DLL (/MD).
Select StaticDebug from the Configurations drop-down menu.
This seems unnecessary: Under Configuration Properties/General, change Configuration Type to Static Library (.lib).
This seems unnecessary: Under Configuration Properties/C-C++/Code Generation, change Runtime Library to Multi-threaded Debug DLL (/MDd).
Click OK
This seems unnecessary: Under Solutions Platform drop-down box (that says Win32), use New... to create x64 platform version project files.
Use Build/Batch Build... menu item to open the Batch Build window, and check libzmq StaticDebug x64 and libzmq StaticRelease x64 projects. Click the Build button.
Drag or move and rename ZeroMQ/builds/msvc/lib/libzmq.lib to ZeroMQ/lib/Release/zmq_s.lib.
Drag or move and rename ZeroMQ/builds/msvc/lib/libzmq_d.lib to ZeroMQ/lib/Debug/zmq.lib.
Don't do this step: Drag or move and rename ZeroMQ/libzmq.dll to ZeroMQ/lib/Debug/zmq.dll.

CMake is run as an ordinary graphical interface application, e.g. from the Start menu.

For "Where is the source code:" and "Where to build the binaries:", use the serpent directory, e.g. C:/Users/rbd/serpent.
Do not change AURA_DEF; the value field should be FALSE.
Find WX_BASE_PATH. Set the value to your wxWidgets folder where you installed wxWindows. E.g. my Value string is "C:\wxWidgets-2.8.10" (without the quotes).
Find WX_VERSION. This should be 28 if you are using wxWidgets 2.8.xx.
There are other options:

LINE_EDITING -- use histedit library to implement line editing for serpent64. You do want this ON, and there may be some annoying command line prompting bugs if this flag is OFF.
USE_MIDI -- include functions that access PortMidi library (see "Serpent and PortMidi").
USE_NETWORK -- include functions that access network functions (see "Network Interface and Functions").
USE_OSC -- include functions that access Open Sound Control (see "Open Sound Control"). But now, O2 provides OSC functions, so you probably want this option OFF.
USE_LIBLO -- only matters if USE_OSC is checked. Not recommended unless you need to parse incoming messages with timestamps and/or bundles (but O2 does this, so just forget liblo).
USE_STATIC_LIBS -- recommended. If not checked, will try to use existing libraries. In principle, this could save work installing and building libraries from sources, e.g. wxwidgets and portmidi, but if the build fails, you should USE_STATIC_LIBS to reduce possible version and path problems.
USE_PROC -- include functions that support a second real-time "process" (see "Proc Interface and Functions").
USE_ZMQ -- include zmq support (see "ZeroMQ").

Configure (button).
When asked what to generate, pick your Visual Studio version with "Win64" after it.
Configure a couple of times more until the red error lines go away (or else maybe you'll have to diagnose the problem), and
Generate (button).

open serpent.sln with VC++ and build ALL_BUILD (or serpent if you are not building wxserpent). There may be some dependency problems, so if some things fail to build at first, try again.
To run the debug version of serpent, you will need to copy ../portmedia/portmidi/Debug/portmidi.dll to C:/windows/system32 or someplace where the DLL will be found.
Now that you have compiled executables, you can follow the instructions above for installing them.