Home Information Classes Download Usage Mail List Requirements Links Tutorial
This release of STK comes with four separate "project" directories:
__WINDOWS_DS__
preprocessor definition and link with the dsound.lib
, winmm.lib
, and Wsock32.lib
libraries. For ASIO support, use the __WINDOWS_ASIO__
preprocessor definition, include all the files in the src/asio/
directory (i.e. asio.h,cpp
, asiodrivers.h,cpp
, ...), and link with the winmm.lib
, and Wsock32.lib
libraries. In addition, the __LITTLE_ENDIAN__
preprocessor definition is necessary for all Windows systems. A distribution of the release is available with precompiled binaries (using DirectSound) for all the projects. In order for these binaries to function properly, your system must have the DirectX 5.0 (or higher) runtime libraries installed (available from Microsoft). Further, the effects project requires that your soundcard and drivers provide full duplex mode capabilities. Visual C++ 6.0 project files are provided in each project directory as well should you wish to compile your own binaries. It is important to link with the non-debug libraries when compiling "release" program versions and debug libraries when compiling "debug" program versions.
configure
shell script is included in the distribution for unix-based systems. From the top-level distribution directory, type './configure'
and the script will create Makefiles
in each project directory specific to the characteristics of the host computer. Then from within any given project directory (example demo
), type 'make'
to compile the project. In addition, an STK library can be compiled from within the src
directory.
Several options can be supplied to the configure
script to customize the build behavior:
--disable-realtime
to only compile generic non-realtime classes --enable-debug
to enable various debug output --enable-midiator
to enable native MS-124W MIDI support (linux only) --with-alsa
to choose native ALSA API support (linux only) In addition, it is possible to specify the location of the STK rawwaves and the STK include path as follows:
./configure RAWWAVE_PATH="/home/gary/rawwaves/" ./configure INCLUDE_PATH="/home/gary/include/"
For novice STK users, the default configuration should be adequate.
For those who wish to create their own system-specific Makefiles
:
__LINUX_OSS__
or __LINUX_ALSA__
preprocessor definitions, which are used to select the underlying audio/MIDI system API. Realtime programs must also link with the pthread
library. When using the ALSA API, it is also necessary to link with the asound
library. In addition, the __LITTLE_ENDIAN__
preprocessor definition is necessary if compiling on a little-endian system. Special support exists under Linux for the MIDIator serial MIDI device, enabled using the __MIDIATOR__
preprocessor definition (together with either the __LINUX_ALSA__
or __LINUX_OSS__
definitions). See the README-Linux file for further system configuration information.
__MACOSX_CORE__
preprocessor definitions, which incorporates the CoreAudio audio/MIDI API. Realtime programs must also link with the pthread
library and the CoreAudio
, CoreMIDI
, and CoreFoundation
frameworks. See the README-MacOSX file for further system configuration information.
__IRIX_AL__
preprocessor definition and linkage with the audio
, md
, and pthread
libraries. STK 4.0 (and higher) is confirmed to compile using CC version 7.30. There may be problems with old compiler versions.
__LITTLE_ENDIAN__
preprocessor definition to your compiler. The demo project will compile without realtime support, allowing the use of SKINI scorefiles for input control and output to a variety of soundfile formats. The following classes cannot be used without realtime support: RtAudio, RtWvIn, RtWvOut, RtDuplex, RtMidi, Socket, Thread, TcpWvIn, TcpWvOut. Because of this, it is not possible to compile the effects, ragamatic, and most of the examples projects for non-realtime use.
Tcl/Tk graphical user interfaces (GUI) are provided with this distribution which can generate realtime SKINI messages. Note that the Messager class allows multiple simultaneous socket client connections, together with MIDI and/or piped input. The Md2Skini program (in the demo directory) is mostly obsolete but can be used to create SKINI scorefiles from realtime MIDI input.
In non-realtime mode, it is assumed that input control messages are provided from a SKINI scorefile and that audio output is written to a soundfile (.snd, .wav, .aif, .mat, .raw). A number of SKINI scorefiles are provided in the scores directory of the demo project. Assuming a successful compilation of the demo program, typing:
cat scores/bookert.ski | demo BeeThree -ow myfile.wav
or (on WindowsXX and/or Unix)
demo BeeThree -ow myfile.wav < scores\bookert.ski
from the demo directory will play the scorefile bookert.ski using the STK BeeThree instrument and write the resulting audio data to a WAV formatted soundfile called "myfile.wav". Typing demo
without any arguments will provide a full program usage description.
Control input and audio output options are typically specified as command-line arguments to STK programs. For example, the demo program is invoked as:
demo instrument flags
where instruments include those described above and flags can be any or all of:
Assuming a successful compilation of the demo program, typing:
cat scores/bookert.ski | demo BeeThree -or
or (on WindowsXX and/or Unix)
demo BeeThree -or < scores\bookert.ski
from the demo directory will play the scorefile bookert.ski using the STK BeeThree instrument and stream the resulting audio data in realtime to the audio output channel of your computer. Typing demo
without any arguments will provide a full program usage description.
wish < tcl/Physical.tcl | demo Clarinet -or -ip
On WindowsXX and Unix platforms, the following operations are necessary to establish a socket connection between the Tcl/Tk GUI and the STK program:
wish < tcl/Physical.tcl
in another DOS shell. Note that it is possible to specify a hostname when establishing the socket connection from the socket client. Thus, the STK socket server program and the Tcl/Tk GUI need not necessarily reside on the same computer.
demo Clarinet -or -im
-n NUMBER
command-line flag and argument. For example, you can play eight BeeThree instruments with realtime output and control them from a MIDI device by typing:
demo BeeThree -n 8 -or -im
The Synthesis ToolKit in C++ (STK) |
©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved. |