diff --git a/.gitignore b/.gitignore index 7880fab..739852c 100644 --- a/.gitignore +++ b/.gitignore @@ -146,7 +146,7 @@ config.log config.status configure projects/demo/Makefile -projects/demo/demo +projects/demo/stk-demo projects/demo/Release projects/demo/Debug projects/effects/Makefile diff --git a/doc/doxygen/usage.txt b/doc/doxygen/usage.txt index 9f59167..c441d1e 100644 --- a/doc/doxygen/usage.txt +++ b/doc/doxygen/usage.txt @@ -32,7 +32,7 @@ The top level distribution contains the following directories: This release of STK comes with four separate "project" directories:
    -
  1. The demo project is used to demonstrate nearly all of the STK instruments. The demo program has been written to allow a variety of control input and sound data output options. Simple graphical user interfaces (GUIs) are also provided.

    2. +
  2. The demo project is used to demonstrate nearly all of the STK instruments. The stk-demo program has been written to allow a variety of control input and sound data output options. Simple graphical user interfaces (GUIs) are also provided.

  3. The effects project demonstrates realtime duplex mode (simultaneous audio input and output) operation, when available, as well as various delay-line based effects algorithms.

    4. @@ -134,23 +134,23 @@ The demo project demonstrates the behavior of all the distributed See the information above with respect to compiling STK for non-realtime use. -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: +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 stk-demo program, typing: \code -demo BeeThree -ow myfile.wav -if scores/bookert.ski +stk-demo BeeThree -ow myfile.wav -if scores/bookert.ski \endcode -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" (note that you may need to append ./ to the program name if your default shell setup is not set to look in the current directory). Typing demo without any arguments will provide a full program usage description. +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" (note that you may need to append ./ to the program name if your default shell setup is not set to look in the current directory). Typing stk-demo without any arguments will provide a full program usage description. \section rt Demo: Realtime Use STK realtime audio and MIDI input/output and realtime SKINI control input via socketing support is provided for Linux, Mac OS-X, and Windows95/98/2000/XP operating systems. STK realtime SKINI control input via piping is possible under Linux, Mac OS X, and Windows2000/XP only.

    -Control input and audio output options are typically specified as command-line arguments to STK programs. For example, the demo program is invoked as: +Control input and audio output options are typically specified as command-line arguments to STK programs. For example, the stk-demo program is invoked as: \code -demo instrument flags +stk-demo instrument flags \endcode where instruments include those described above and flags can be any or all of: @@ -167,13 +167,13 @@ where instruments include those described above and flags can be any or all of: The -ip flag must be used when piping realtime SKINI control data to an STK program. The -im flag must be used to read MIDI control input from your MIDI port. Note that you can use both input types simultaneously. -Assuming a successful compilation of the demo program, typing: +Assuming a successful compilation of the stk-demo program, typing: \code -demo BeeThree -or -if scores/bookert.ski +stk-demo BeeThree -or -if scores/bookert.ski \endcode -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. +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 stk-demo without any arguments will provide a full program usage description. \section tcl Realtime Control Input using Tcl/Tk Graphical User Interfaces: @@ -181,7 +181,7 @@ from the demo directory will play the scorefile bookert.ski There are a number of Tcl/Tk GUIs supplied with the STK projects. These scripts require Tcl/Tk version 8.0 or later, which can be downloaded for free over the WWW. On Unix and Windows2000/XP platforms, you can run the various executable scripts (e.g. StkDemo.bat) provided with each project to start everything up (you may need to symbolically link the wishXX executable to the name wish). The Physical.bat script just implements the following command-line sequence: \code -wish < tcl/Physical.tcl | demo Clarinet -or -ip +wish < tcl/Physical.tcl | stk-demo Clarinet -or -ip \endcode \section midi Realtime MIDI Control Input: @@ -189,17 +189,17 @@ wish < tcl/Physical.tcl | demo Clarinet -or -ip On all supported realtime platforms, you can direct realtime MIDI input to the STK Clarinet by typing: \code -demo Clarinet -or -im +stk-demo Clarinet -or -im \endcode This will attempt to use the default MIDI port for input. An optional MIDI port number can be specified after the -im flag. Valid MIDI ports are numbered from 0 (default) and higher. On Linux and Macintosh OS-X systems, it is possible to open a virtual MIDI input port (that other software applications can connect to) by specifying a port identifier of -1. \section polyphony Polyphony: -The demo program supports an arbitrary number of voices via the -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: +The stk-demo program supports an arbitrary number of voices via the -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: \code -demo BeeThree -n 8 -or -im +stk-demo BeeThree -n 8 -or -im \endcode */ diff --git a/projects/demo/Banded b/projects/demo/Banded index be738c7..eca70f5 100755 --- a/projects/demo/Banded +++ b/projects/demo/Banded @@ -1 +1 @@ -wish < tcl/Banded.tcl | demo BandedWG -or -ip \ No newline at end of file +wish < tcl/Banded.tcl | stk-demo BandedWG -or -ip diff --git a/projects/demo/Banded.bat b/projects/demo/Banded.bat index be738c7..eca70f5 100755 --- a/projects/demo/Banded.bat +++ b/projects/demo/Banded.bat @@ -1 +1 @@ -wish < tcl/Banded.tcl | demo BandedWG -or -ip \ No newline at end of file +wish < tcl/Banded.tcl | stk-demo BandedWG -or -ip diff --git a/projects/demo/Drums b/projects/demo/Drums index 31f2f5c..f065f19 100755 --- a/projects/demo/Drums +++ b/projects/demo/Drums @@ -1 +1 @@ -wish < tcl/Drums.tcl | ./demo Drummer -or -ip \ No newline at end of file +wish < tcl/Drums.tcl | stk-demo Drummer -or -ip diff --git a/projects/demo/Drums.bat b/projects/demo/Drums.bat index 9402450..f065f19 100755 --- a/projects/demo/Drums.bat +++ b/projects/demo/Drums.bat @@ -1 +1 @@ -wish < tcl/Drums.tcl | demo Drummer -or -ip \ No newline at end of file +wish < tcl/Drums.tcl | stk-demo Drummer -or -ip diff --git a/projects/demo/Makefile.in b/projects/demo/Makefile.in index 3955bf5..7278730 100644 --- a/projects/demo/Makefile.in +++ b/projects/demo/Makefile.in @@ -1,7 +1,7 @@ ### Do not edit -- Generated by 'configure --with-whatever' from Makefile.in ### STK demo Makefile - for various flavors of unix -PROGRAMS = demo +PROGRAMS = stk-demo RM = /bin/rm SRC_PATH = ../../src OBJECT_PATH = @object_path@ @@ -61,8 +61,8 @@ $(OBJECT_PATH)/.placeholder: mkdir -vp $(OBJECT_PATH) touch $(OBJECT_PATH)/.placeholder -demo: demo.cpp $(OBJECTS) - $(CC) $(LDFLAGS) $(CFLAGS) $(DEFS) -o demo demo.cpp $(OBJECT_PATH)/*.o $(LIBRARY) +stk-demo: demo.cpp $(OBJECTS) + $(CC) $(LDFLAGS) $(CFLAGS) $(DEFS) -o stk-demo demo.cpp $(OBJECT_PATH)/*.o $(LIBRARY) libdemo: demo.cpp $(CC) $(LDFLAGS) $(CFLAGS) $(DEFS) -o demo utilities.cpp demo.cpp -L../../src -lstk $(LIBRARY) diff --git a/projects/demo/Modal b/projects/demo/Modal index 474234b..96409c6 100755 --- a/projects/demo/Modal +++ b/projects/demo/Modal @@ -1 +1 @@ -wish < tcl/Modal.tcl | ./demo ModalBar -or -ip \ No newline at end of file +wish < tcl/Modal.tcl | stk-demo ModalBar -or -ip diff --git a/projects/demo/Modal.bat b/projects/demo/Modal.bat index 09d16b9..96409c6 100755 --- a/projects/demo/Modal.bat +++ b/projects/demo/Modal.bat @@ -1 +1 @@ -wish < tcl/Modal.tcl | demo ModalBar -or -ip \ No newline at end of file +wish < tcl/Modal.tcl | stk-demo ModalBar -or -ip diff --git a/projects/demo/Physical b/projects/demo/Physical index f0e74fd..3a4c2df 100755 --- a/projects/demo/Physical +++ b/projects/demo/Physical @@ -1 +1 @@ -wish < tcl/Physical.tcl | ./demo Clarinet -or -ip \ No newline at end of file +wish < tcl/Physical.tcl | stk-demo Clarinet -or -ip diff --git a/projects/demo/Physical.bat b/projects/demo/Physical.bat index ed11db8..3a4c2df 100755 --- a/projects/demo/Physical.bat +++ b/projects/demo/Physical.bat @@ -1 +1 @@ -wish < tcl/Physical.tcl | demo Clarinet -or -ip \ No newline at end of file +wish < tcl/Physical.tcl | stk-demo Clarinet -or -ip diff --git a/projects/demo/Shakers b/projects/demo/Shakers index 7ac5fd2..0f6b264 100755 --- a/projects/demo/Shakers +++ b/projects/demo/Shakers @@ -1 +1 @@ -wish < tcl/Shakers.tcl | ./demo Shakers -or -ip \ No newline at end of file +wish < tcl/Shakers.tcl | stk-demo Shakers -or -ip diff --git a/projects/demo/Shakers.bat b/projects/demo/Shakers.bat index ccbb303..0f6b264 100755 --- a/projects/demo/Shakers.bat +++ b/projects/demo/Shakers.bat @@ -1 +1 @@ -wish < tcl/Shakers.tcl | demo Shakers -or -ip \ No newline at end of file +wish < tcl/Shakers.tcl | stk-demo Shakers -or -ip diff --git a/projects/demo/StkDemo b/projects/demo/StkDemo index 2670636..517d563 100755 --- a/projects/demo/StkDemo +++ b/projects/demo/StkDemo @@ -1 +1 @@ -wish < tcl/Demo.tcl | ./demo Clarinet -or -ip +wish < tcl/Demo.tcl | stk-demo Clarinet -or -ip diff --git a/projects/demo/StkDemo.bat b/projects/demo/StkDemo.bat index c0d025e..517d563 100755 --- a/projects/demo/StkDemo.bat +++ b/projects/demo/StkDemo.bat @@ -1 +1 @@ -wish < tcl/Demo.tcl | demo Clarinet -or -ip +wish < tcl/Demo.tcl | stk-demo Clarinet -or -ip diff --git a/projects/demo/Voice b/projects/demo/Voice index ecd3085..7da993f 100755 --- a/projects/demo/Voice +++ b/projects/demo/Voice @@ -1 +1 @@ -wish < tcl/Voice.tcl | ./demo FMVoices -or -ip \ No newline at end of file +wish < tcl/Voice.tcl | stk-demo FMVoices -or -ip diff --git a/projects/demo/Voice.bat b/projects/demo/Voice.bat index 9714b58..7da993f 100755 --- a/projects/demo/Voice.bat +++ b/projects/demo/Voice.bat @@ -1 +1 @@ -wish < tcl/Voice.tcl | demo FMVoices -or -ip \ No newline at end of file +wish < tcl/Voice.tcl | stk-demo FMVoices -or -ip