Version fix in doxygen download file.

CMake support

.gitignore

@@ -0,0 +1,199 @@
+#####
+# OS X temporary files that should never be committed
+#
+# c.f. http://www.westwind.com/reference/os-x/invisibles.html
+
+.DS_Store
+
+# c.f. http://www.westwind.com/reference/os-x/invisibles.html
+
+.Trashes
+
+# c.f. http://www.westwind.com/reference/os-x/invisibles.html
+
+*.swp
+
+# *.lock - this is used and abused by many editors for many different things.
+#    For the main ones I use (e.g. Eclipse), it should be excluded 
+#    from source-control, but YMMV
+
+*.lock
+
+#
+# profile - REMOVED temporarily (on double-checking, this seems incorrect; I can't find it in OS X docs?)
+#profile
+
+
+####
+# Xcode temporary files that should never be committed
+# 
+# NB: NIB/XIB files still exist even on Storyboard projects, so we want this...
+
+*~.nib
+
+
+####
+# Xcode build files -
+#
+# NB: slash on the end, so we only remove the FOLDER, not any files that were badly named "DerivedData"
+
+DerivedData/
+
+# NB: slash on the end, so we only remove the FOLDER, not any files that were badly named "build"
+
+build/
+
+
+#####
+# Xcode private settings (window sizes, bookmarks, breakpoints, custom executables, smart groups)
+#
+# This is complicated:
+#
+# SOMETIMES you need to put this file in version control.
+# Apple designed it poorly - if you use "custom executables", they are
+#  saved in this file.
+# 99% of projects do NOT use those, so they do NOT want to version control this file.
+#  ..but if you're in the 1%, comment out the line "*.pbxuser"
+
+# .pbxuser: http://lists.apple.com/archives/xcode-users/2004/Jan/msg00193.html
+
+*.pbxuser
+
+# .mode1v3: http://lists.apple.com/archives/xcode-users/2007/Oct/msg00465.html
+
+*.mode1v3
+
+# .mode2v3: http://lists.apple.com/archives/xcode-users/2007/Oct/msg00465.html
+
+*.mode2v3
+
+# .perspectivev3: http://stackoverflow.com/questions/5223297/xcode-projects-what-is-a-perspectivev3-file
+
+*.perspectivev3
+
+#    NB: also, whitelist the default ones, some projects need to use these
+!default.pbxuser
+!default.mode1v3
+!default.mode2v3
+!default.perspectivev3
+
+
+####
+# Xcode 4 - semi-personal settings
+#
+#
+# OPTION 1: ---------------------------------
+#     throw away ALL personal settings (including custom schemes!
+#     - unless they are "shared")
+#
+# NB: this is exclusive with OPTION 2 below
+xcuserdata
+
+# OPTION 2: ---------------------------------
+#     get rid of ALL personal settings, but KEEP SOME OF THEM
+#     - NB: you must manually uncomment the bits you want to keep
+#
+# NB: this *requires* git v1.8.2 or above; you may need to upgrade to latest OS X,
+#    or manually install git over the top of the OS X version
+# NB: this is exclusive with OPTION 1 above
+#
+#xcuserdata/**/*
+
+#     (requires option 2 above): Personal Schemes
+#
+#!xcuserdata/**/xcschemes/*
+
+####
+# Xcode 4 workspaces - more detailed
+#
+# Workspaces are important! They are a core feature of Xcode - don't exclude them :)
+#
+# Workspace layout is quite spammy. For reference:
+#
+# /(root)/
+#   /(project-name).xcodeproj/
+#     project.pbxproj
+#     /project.xcworkspace/
+#       contents.xcworkspacedata
+#       /xcuserdata/
+#         /(your name)/xcuserdatad/
+#           UserInterfaceState.xcuserstate
+#     /xcsshareddata/
+#       /xcschemes/
+#         (shared scheme name).xcscheme
+#     /xcuserdata/
+#       /(your name)/xcuserdatad/
+#         (private scheme).xcscheme
+#         xcschememanagement.plist
+#
+#
+
+####
+# Xcode 4 - Deprecated classes
+#
+# Allegedly, if you manually "deprecate" your classes, they get moved here.
+#
+# We're using source-control, so this is a "feature" that we do not want!
+
+*.moved-aside
+
+####
+# Files generated by automake
+
+Makefile
+autom4te.cache
+config.log
+config.status
+configure
+projects/demo/Makefile
+projects/demo/stk-demo
+projects/demo/Release
+projects/demo/Debug
+projects/effects/Makefile
+projects/effects/effects
+projects/effects/Release
+projects/effects/Debug
+projects/eguitar/Makefile
+projects/eguitar/eguitar
+projects/eguitar/Release
+projects/eguitar/Debug
+projects/examples/Makefile
+projects/examples/audioprobe
+projects/examples/bethree
+projects/examples/controlbee
+projects/examples/crtsine
+projects/examples/duplex
+projects/examples/foursine
+projects/examples/grains
+projects/examples/inetIn
+projects/examples/inetOut
+projects/examples/libMakefile
+projects/examples/midiprobe
+projects/examples/play
+projects/examples/playsmf
+projects/examples/record
+projects/examples/rtsine
+projects/examples/sine
+projects/examples/sineosc
+projects/examples/threebees
+projects/examples/Release
+projects/examples/Debug
+projects/ragamatic/Makefile
+projects/ragamatic/ragamat
+projects/ragamatic/Release
+projects/ragamatic/Debug
+src/libstk.a
+src/Release
+src/Debug
+src/Makefile
+
+####
+# Files generated by Visual Studio
+
+projects/*/.vs/
+projects/*/*.exe
+projects/*/*.ilk
+projects/*/*.pdb
+projects/*/*.vcxproj.user
+projects/*/Release/
+projects/*/Debug/

CMakeLists.txt

@@ -0,0 +1,138 @@
+cmake_minimum_required(VERSION 3.1) ##TODO: which version is better
+
+project(STK VERSION 4.6.1)
+
+set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})
+
+if(NOT CMAKE_BUILD_TYPE) 
+    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
+endif()
+SET_PROPERTY(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Release" "Debug" "RelWithDebInfo" "MinSizeRel") 
+message("Build type: " ${CMAKE_BUILD_TYPE})
+
+set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O3 -DNDEBUG")
+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g -D_STK_DEBUG_ -D__RTAUDIO_DEBUG__ -D__RTMIDI_DEBUG__")
+
+if(${CMAKE_CXX_COMPILER_ID} STREQUAL GNU)
+    message("GCC.")
+    set(CMAKE_CXX_FLAGS "-Wall")
+endif()
+
+option(BUILD_SHARED "Whether to build the shared library" ON)
+option(BUILD_STATIC "Whether to build the static library" ON)
+option(REALTIME "Realtime support" ON)
+option(ENABLE_JACK "Enable JACK" ON)
+option(ENABLE_ALSA "Enable ALSA API support (linux only)" ON)
+# option(ENABLE_OSS "Enable OSS API Support (unixes only)" ON)
+option(ENABLE_ASIO "Enable ASIO API support (windows only)" OFF)
+option(ENABLE_DS "Enable DirectSound API support (windows only)" ON)
+option(ENABLE_WASAPI "Enable Windows Audio Session API support (windows only)" OFF)
+# option(ENABLE_CORE "Enable CoreAudio API support (mac only)" ON)
+option(COMPILE_PROJECTS "Compile all the example projects" ON)
+
+include_directories("./include")
+file(GLOB STK_SRC "./src/*.cpp") # GLOB instead of GLOB_RECURSE as the asio depends on system
+
+#========================================#
+#========== Realtime Support ============#
+#========================================#
+if(REALTIME)
+    if(ENABLE_JACK)
+        find_library(JACK_LIBRARY jack) # find_package(JACK) # TODO: NEED FindJACK.cmake
+        if(JACK_LIBRARY)
+            message("Jack API found: ${JACK_LIBRARY}")
+            link_libraries(${JACK_LIBRARY})
+            add_definitions(-D__UNIX_JACK__)
+        else()
+            message(WARNING "JACK support requires the jack library!")
+        endif()
+    endif()
+
+    message("${CMAKE_SYSTEM_NAME}")
+    set(CMAKE_THREAD_PREFER_PTHREAD TRUE)
+    set(THREADS_PREFER_PTHREAD_FLAG TRUE)
+    find_package(Threads REQUIRED)
+    link_libraries(Threads::Threads)
+    if(${CMAKE_SYSTEM_NAME} STREQUAL Linux)
+        # TODO: Finish Linux configuration, include different audio API supports
+        #==============    LINUX       ================#
+        message("Linux DETECTED!")
+        if(ENABLE_ALSA)
+            find_package(ALSA REQUIRED)
+            if(ALSA_FOUND)
+                include_directories(${ALSA_INCLUDE_DIRS})
+                link_libraries(${ALSA_LIBRARIES})
+                add_definitions(-D__LINUX_ALSA__)
+            endif()
+        endif()
+    elseif(${CMAKE_SYSTEM_NAME} STREQUAL Darwin)
+        #==============    MAC OS    ================#
+        message("Machintosh DETECTED!")
+        find_package(CoreAudio REQUIRED)
+        include_directories(${COREAUDIO_INCLUDE_DIRS})
+        add_definitions(-D__MACOSX_CORE__)
+        link_libraries(${COREAUDIO_LIBRARY} ${COREAUDIO_FOUNDATION} ${COREAUDIO_MIDI})
+    elseif(${CMAKE_SYSTEM_NAME} STREQUAL Windows)
+        # TODO: MORE SUPPORT (e.g., MSYS)?
+        # Tested under MSYS2 with Mingw64 toolchain
+        #==============      WINDOWS      ================#
+        message("Windows DETECTED!")
+
+        link_libraries(winmm ole32 wsock32)
+        add_definitions(-D__WINDOWS_MM__)
+
+        # TODO: ASIO NOT WORKING YET
+        if(ENABLE_ASIO)
+            message("ENALBING ASIO")
+            include_directories("./src/include")
+            # target_sources(stk PUBLIC "${CMAKE_SOURCE_DIR}/src/include/asio.cpp" "${CMAKE_SOURCE_DIR}/src/include/asiodrivers.cpp"
+            #                     "${CMAKE_SOURCE_DIR}/src/include/asiolist.cpp" "${CMAKE_SOURCE_DIR}/src/include/iasiothiscallresolver.cpp")
+            add_definitions(-D__WINDOWS_ASIO__)
+        endif()
+
+        if(ENABLE_WASAPI)
+            message("ENALBING WASAPI")
+            link_libraries(mfuuid mfplat wmcodecdspuuid ksuser)
+            add_definitions(-D__WINDOWS_WASAPI__)
+        endif()
+        
+        if(ENABLE_DS)
+            message("ENALBING Directsound")
+            link_libraries(dsound)
+            add_definitions(-D__WINDOWS_DS__)
+        endif()
+    else()
+        message("CMAKE_SYSTEM_NAME:" ${CMAKE_SYSTEM_NAME})
+        message(FATAL_ERROR "Unknown system type for realtime support.")
+    endif()
+endif()
+
+include(TestBigEndian)
+TEST_BIG_ENDIAN(IS_BIG_ENDIAN)
+if(NOT IS_BIG_ENDIAN)
+  add_definitions(-D__LITTLE_ENDIAN__)
+endif()
+
+#========================================#
+#========== Build the Library ===========#
+#========================================#
+if(BUILD_STATIC)
+    add_library(stk STATIC ${STK_SRC} )
+endif()
+
+if(BUILD_SHARED)
+    add_library(stk_SHARED SHARED ${STK_SRC})
+    set_target_properties(stk_SHARED PROPERTIES OUTPUT_NAME stk) # rename the shared library name
+endif()
+
+#========================================#
+#========= Build the examples ===========#
+#========================================#
+if(COMPILE_PROJECTS)
+    message("COMPILE PROJECTS!")
+    add_subdirectory(projects/examples)
+    add_subdirectory(projects/eguitar)
+    add_subdirectory(projects/demo)
+    add_subdirectory(projects/effects)
+    add_subdirectory(projects/ragamatic)
+endif()

INSTALL

@@ -1,40 +0,0 @@
-The Synthesis ToolKit in C++ (STK)
-
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
-
-The Synthesis ToolKit in C++ can be used in a variety of ways, depending on your particular needs.  Some people just choose the classes they need for a particular project and copy those to their project directory.  Others like to compile and link to a library of object files.  STK was not designed with one particular style of use in mind.
-
-To configure and compile (on Unix systems):
-
-1. Unpack the STK distribution (tar -xzf stk-4.x.tar.gz).
-2. From within the directory containing this file, run configure:
-
-   ./configure
-
-3. From within each project directory, type "make".
-4. To compile a library of objects, type "make" from within the src directory.
-
-Several options can be passed to configure, including:
-
-  --disable-realtime = only compile generic non-realtime classes
-  --enable-debug = enable various debug output
-  --with-alsa = choose native ALSA API support (linux only)
-  --enable-midiator = enable native MS-124W MIDI support (linux only)
-
-Typing "./configure --help" will display all the available options.  In addition, it is possible to specify the RAWWAVES and INCLUDE paths to configure as (ex. to set to /home/gary/rawwaves and /home/gary/include):
-
-  ./configure RAWWAVE_PATH="/home/gary/rawwaves/"
-  ./configure INCLUDE_PATH="/home/gary/include/"
-
-The ending "/" is required for the RAWWAVES path.  The default behavior will set a relative path that works for the project files included with the distribution (assuming they are not moved).
-
-If you wish to use a different compiler than that selected by configure, specify that compiler in the command line (ex. to use CC):
-
-  ./configure CXX=CC
-
-In addition, a linux RPM is available from the STK WWW site (http://www-ccrma.stanford.edu/software/stk/).
-
-
-For Windows Users:
-
-An STK distribution is available which contains precompiled executables.  In addition, Visual C++ project files are included for each of the example STK projects.

INSTALL.md

@@ -0,0 +1,54 @@
+# The Synthesis ToolKit in C++ (STK)
+By Perry R. Cook and Gary P. Scavone, 1995-2021.
+
+The Synthesis ToolKit in C++ can be used in a variety of ways, depending on your particular needs.  Some people simply choose the classes they need for a particular project and copy those to their project directory.  Others like to compile and link to a library of object files.  STK was not designed with one particular style of use in mind.
+
+## Unix systems and MinGW
+
+1. If you downloaded the software from the git repository, first run autoconf,
+
+        autoconf
+
+otherwise, if you downloaded the software from the STK source distribution, unpack the tar file,
+
+        tar -xzf stk-4.x.x.tar.gz
+
+2. From within the directory containing this file, run configure:
+
+        ./configure
+
+3. From within each project directory, type `make`.
+
+4. To compile a library of objects, type `make` from within the `src` directory.
+
+Several options can be passed to configure, including:
+
+    --disable-realtime = only compile generic non-realtime classes
+    --enable-debug = enable various debug output
+    --with-alsa = choose native ALSA API support (default, linux only)
+    --with-oss = choose native OSS API support (unixes only)
+    --with-jack = choose native JACK server API support (linux and macintosh OS-X)
+    --with-core = choose OS-X CoreAudio API (macintosh OS-X only)
+    --with-asio = choose ASIO API support (windows only)
+    --with-ds = choose DirectSound API support (windows only)
+    --with-wasapi = choose Windows Audio Session API support (windows only)
+
+It is now possible to specify more than one audio and MIDI API where supported.  Note, however, that the ALSA library is required in order to compile the RtMidi class in Linux if the `--with-oss` option is provided (only the OSS audio API will be used, not the OSS MIDI API).  Typing `./configure --help` will display all the available options.  In addition, it is possible to specify the RAWWAVES and INCLUDE paths to configure as (e.g. to set to /home/me/rawwaves and /home/me/include):
+
+    ./configure RAWWAVE_PATH='$(HOME)/rawwaves/'
+    ./configure INCLUDE_PATH='$(HOME)/include/'
+
+The ending "/" is required for the RAWWAVES path.  The default behavior will set a relative path that works for the project files included with the distribution (assuming they are not moved).  You can also change the RAWWAVE_PATH dynamically via the static Stk::setRawwavePath() function.
+
+If you wish to use a different compiler than that selected by configure, specify that compiler in the command line (e.g. to use CC):
+
+    ./configure CXX=CC
+
+
+## Windows
+
+MinGW support is provided in the configure script.  In addition, Visual Studio 2017 project files are included for each of the example STK projects.
+
+## iOS
+
+You can integrate the STK in iOS projects either by using its iOS static library or CocoaPods. See the [iOS README file](iOS/README-iOS.md) for instructions. 

LICENSE

@@ -0,0 +1,27 @@
+The Synthesis ToolKit in C++ (STK)
+
+Copyright (c) 1995-2021 Perry R. Cook and Gary P. Scavone
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+Any person wishing to distribute modifications to the Software is
+asked to send the modifications to the original developer so that they
+can be incorporated into the canonical version.  This is, however, not
+a binding provision of this license.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile.in

@@ -0,0 +1,41 @@
+### Do not edit -- Generated by 'configure --with-whatever' from Makefile.in
+
+RM = /bin/rm
+
+REALTIME = @realtime@
+
+all :
+	cd src && $(MAKE)
+	cd projects/demo && $(MAKE) libdemo
+ifeq ($(REALTIME),yes)
+	cd projects/effects && $(MAKE) libeffects
+	cd projects/ragamatic && $(MAKE) libragamat
+	cd projects/eguitar && $(MAKE) libeguitar
+endif
+	cd projects/examples && $(MAKE) -f libMakefile
+
+clean : 
+	$(RM) -f *~
+	cd src && $(MAKE) clean
+	cd projects/demo && $(MAKE) clean
+ifeq ($(REALTIME),yes)
+	cd projects/effects && $(MAKE) clean
+	cd projects/ragamatic && $(MAKE) clean
+	cd projects/eguitar && $(MAKE) clean
+endif
+	cd projects/examples && $(MAKE) clean
+
+distclean: clean
+	$(RM) -rf config.log config.status autom4te.cache Makefile
+	cd src && $(MAKE) distclean
+	cd projects/demo && $(MAKE) distclean
+ifeq ($(REALTIME),yes)
+	cd projects/effects && $(MAKE) distclean
+	cd projects/ragamatic && $(MAKE) distclean
+	cd projects/eguitar && $(MAKE) distclean
+endif
+	cd projects/examples && $(MAKE) distclean
+
+install:
+	$(MAKE) -C src install
+

README

@@ -1,117 +0,0 @@
-The Synthesis ToolKit in C++ (STK)
-
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
-
-This distribution of the Synthesis ToolKit in C++ (STK) contains the following:
-
-include:  STK class header files
-src:      STK class source files
-rawwaves: STK audio files (1-channel, 16-bit, big-endian)
-doc:      STK documentation
-projects: example STK programs
-
-Please read the Legal and Ethical notes near the bottom of this document.
-
-For compiling and installing STK, see the INSTALL file in this directory.
-
-
-OVERVIEW:
-
-The Synthesis ToolKit in C++ (STK) is a set of open source audio signal processing and algorithmic synthesis classes written in C++.  STK was designed to facilitate rapid development of music synthesis and audio processing software, with an emphasis on cross-platform functionality, realtime control, ease of use, and educational example code.  The Synthesis ToolKit is extremely portable (it's mostly platform-independent C and C++ code), and it's completely user-extensible (all source included, no unusual libraries, and no hidden drivers).  We like to think that this increases the chances that our programs will still work in another 5-10 years.  In fact, the ToolKit has been working continuously for nearly 8 years now.  STK currently runs with "realtime" support (audio and MIDI) on SGI (Irix), Linux, Macintosh OS X, and Windows computer platforms.  Generic, non-realtime support has been tested under NeXTStep, Sun, and other platforms and should work with any standard C++ compiler.
-
-The Synthesis ToolKit is free for non-commercial use.  The only parts of the Synthesis ToolKit that are platform-dependent concern real-time audio and MIDI input and output, and that is taken care of with a few special classes.  The interface for MIDI input and the simple Tcl/Tk graphical user interfaces (GUIs) provided is the same, so it's easy to experiment in real time using either the GUIs or MIDI.  The Synthesis ToolKit can generate simultaneous SND (AU), WAV, AIFF, and MAT-file output soundfile formats (as well as realtime sound output), so you can view your results using one of a large variety of sound/signal analysis tools already available (e.g. Snd, Cool Edit, Matlab). 
-
-The Synthesis Toolkit is not one particular program.  Rather, it is a set of C++ classes that you can use to create your own programs.  A few example applications are provided to demonstrate some of the ways to use the classes.  If you have specific needs, you will probably have to either modify the example programs or write a new program altogether. Further, the example programs don't have a fancy GUI wrapper. If you feel the need to have a "drag and drop" graphical patching GUI, you probably don't want to use the ToolKit. Spending hundreds of hours making platform-dependent graphics code would go against one of the fundamental design goals of the ToolKit - platform independence. 
-
-For those instances where a simple GUI with sliders and buttons is helpful, we use Tcl/Tk (http://dev.scriptics.com) which is freely distributed for all the supported ToolKit platforms. A number of Tcl/Tk GUI scripts are distributed with the ToolKit release.  For control, the Synthesis Toolkit uses raw MIDI (on supported platforms), and SKINI (Synthesis ToolKit Instrument Network Interface, a MIDI-like text message synthesis control format).
-
-
-SYSTEM REQUIREMENTS:
-
-See the individual README's (eg. README-linux) in the /doc directory for platform specific information and system requirements.  In general, you will use the configure script to create Makefiles on unix platforms or the VC++ workspace files to compile the example programs.  To use the Tcl/Tk GUIs, you will need Tcl/Tk version 8.0 or higher.
-
-
-WHAT'S NEW:
-
-Despite being available in one form or another since 1996, we still consider STK to be alpha software.  Thus, backward compatability has not been a priority.  Please read the Release Notes to see what has changed since the last release.
-
-The control message handling scheme has been simplified greatly through the use of the Messager class.  It is now possible to have access to simultaneous piped, socketed, and/or MIDI input control messages.  In most cases, this should eliminate the use of the Md2Skini program.
-
-Realtime audio input capabilities were added to STK with release 3.0, though the behavior of such is very hardware dependent.  Under Linux and Irix, audio input and output are possible with very low latency.  Using the Windoze DirectSound API, minimum dependable output sound latency seems to be around 20 milliseconds or so, while input sound latency is on the order of a hundred milliseconds or more!
-
-As mentioned above, it is possible to record the audio ouput of an STK program to .snd, .wav, .raw, .aif, and .mat (Matlab MAT-file) output file types.  Though somewhat obsolete, the program Md2Skini can be used to write SKINI scorefiles from realtime MIDI input.  Finally, STK should compile with non-realtime functionality on any platform with a generic C++ compiler.
-
-For those who wish to make a library from the core STK classes, the configure script generates a Makefile in the src directory that will accomplish that (Linux, SGI, and Macintosh OS X only).
-
-
-DISCLAIMER:
-
-You probably already guessed this, but just to be sure, we don't guarantee anything works.  :-)  It's free ... what do you expect?  If you find a bug, please let us know and we'll try to correct it.  You can also make suggestions, but again, no guarantees.  Send email to prc@cs.princeton.edu and gary@ccrma.stanford.edu. 
-
-
-LEGAL AND ETHICAL:
-
-This software was designed and created to be made publicly available for free, primarily for academic purposes, so if you use it, pass it on with this documentation, and for free.  
-
-If you make a million dollars with it, give us some.  If you make compositions with it, put us in the program notes.
-
-Some of the concepts are covered by various patents, some known to us and likely others which are unknown.  Many of the ones known to us are administered by the Stanford Office of Technology and Licensing.  
-
-The good news is that large hunks of the techniques used here are public domain.  To avoid subtle legal issues, we'll not state what's freely useable here, but we'll try to note within the various classes where certain things are likely to be protected by patents.
-
-
-FURTHER READING:
-
-For complete documentation on this ToolKit, the classes, etc., see the doc directory of the distribution or surf to http://www-ccrma.stanford.edu/software/stk/.  Also check the platform specific README's for specific system requirements.
-
-
-PERRY'S NOTES FROM THE ORIGINAL DISTRIBUTION:
-
-This whole world was created with no particular hardware in mind.  These examples are intended to be tutorial in nature, as a platform for the continuation of my research, and as a possible starting point for a software synthesis system.  The basic motivation was to create the necessary unit generators to do the synthesis, processing, and control that I want to do and teach about.  Little thought for optimization was given (see Object.cpp), and therefore improvements, especially speed enhancements, should be possible with these classes.  It was written with some basic concepts in mind about how to let compilers optimize.
-
-Your question at this point might be, "But Perry, with CMix, CMusic, CSound, CShells, CMonkeys, etc. already cluttering the landscape, why a new set of stupid C functions for music synthesis and processing?"  The answers lie below.
-
-1) I needed to port many of the things I've done
-   into something which is generic enough to port
-   further to different machines.
-
-2) I really plan to document this stuff, so that
-   you don't have to be me to figure out what's 
-   going on. (I'll probably be sorry I said this 
-   in a couple of years, when even I can't figure
-   out what I was thinking.)
-
-3) The classic difficulties most people have in 
-   trying to implement physical models are:
-
-   A) They have trouble understanding the papers, 
-      and/or in turning the theory into practice.
-
-   B) The Physical Model instruments are a pain to get 
-      to oscillate, and coming up with stable and 
-      meaningful parameter values is required to 
-      get the models to work at all.
-
-   This set of C++ unit generators and instruments
-   might help to diminish the scores of emails I
-   get asking what to do with those block diagrams
-   I put in my papers.
-
-4) I wanted to try some new stuff with modal synthesis, 
-   and implement some classic FM patches as well.
-
-5) I wanted to reimplement, and newly implement
-   more of the intelligent and physical performer
-   models I've talked about in some of my papers.
-   But I wanted to do it in a portable way, and in 
-   such a way that I can hook up modules quickly.
-   I also wanted to make these instruments connectable
-   to such player objects, so folks like Brad Garton
-   who really think a lot about the players can connect
-   them to my instruments, a lot about which I think.
-
-6) More rationalizations to follow . . .
-
-
-
-

README.md

@@ -0,0 +1,194 @@
+# The Synthesis ToolKit in C++ (STK)
+By Perry R. Cook and Gary P. Scavone, 1995--2021.
+
+This distribution of the Synthesis ToolKit in C++ (STK) contains the following:
+
+* [`include`](include/):  STK class header files
+* [`src`](src/): STK class source files
+* [`rawwaves`](rawwaves): STK audio files (1-channel, 16-bit, big-endian)
+* [`doc`](doc): STK documentation
+* [`projects`](projects): example STK projects and programs
+
+Please read the [Legal and Ethical notes](#legal-and-ethical) near the bottom of this document and the [License](LICENSE).
+
+For compiling and installing STK, see the [INSTALL.md](INSTALL.md) file in this directory.
+
+## Contents
+
+* [Overview](#overview)
+* [System Requirements](#system-requirements)
+* [What's New (and not so new)](#whats-new-and-not-so-new)
+* [Disclaimer](#disclaimer)
+* [Legal and Ethical](#legal-and-ethical)
+* [Further Reading](#further-reading)
+* [Perry's Notes From the Original Distribution](#perrys-notes-from-the-original-distribution)
+
+# OVERVIEW
+
+The Synthesis ToolKit in C++ (STK) is a set of open source audio
+signal processing and algorithmic synthesis classes written in the C++
+programming language.  STK was designed to facilitate rapid
+development of music synthesis and audio processing software, with an
+emphasis on cross-platform functionality, realtime control, ease of
+use, and educational example code.  The Synthesis ToolKit is extremely
+portable (most classes are platform-independent C++ code), and it's
+completely user-extensible (all source included, no unusual libraries,
+and no hidden drivers).  We like to think that this increases the
+chances that our programs will still work in another 5-10 years.  STK
+currently runs with "realtime" support (audio and MIDI) on Linux,
+Macintosh OS X, and Windows computer platforms.  Generic, non-realtime
+support has been tested under NeXTStep, Sun, and other platforms and
+should work with any standard C++ compiler.
+
+The only classes of the Synthesis ToolKit that are platform-dependent
+concern sockets, threads, mutexes, and real-time audio and MIDI input
+and output.  The interface for MIDI input and the simple Tcl/Tk
+graphical user interfaces (GUIs) provided is the same, so it's easy to
+experiment in real time using either the GUIs or MIDI.  The Synthesis
+ToolKit can generate simultaneous SND (AU), WAV, AIFF, and MAT-file
+output soundfile formats (as well as realtime sound output), so you
+can view your results using one of a large variety of sound/signal
+analysis tools already available (e.g. Snd, Cool Edit, Matlab).
+
+The Synthesis Toolkit is not one particular program.  Rather, it is a
+set of C++ classes that you can use to create your own programs.  A
+few example applications are provided to demonstrate some of the ways
+to use the classes.  If you have specific needs, you will probably
+have to either modify the example programs or write a new program
+altogether. Further, the example programs don't have a fancy GUI
+wrapper. If you feel the need to have a "drag and drop" graphical
+patching GUI, you probably don't want to use the ToolKit. Spending
+hundreds of hours making platform-dependent graphics code would go
+against one of the fundamental design goals of the ToolKit - platform
+independence.
+
+For those instances where a simple GUI with sliders and buttons is
+helpful, we use Tcl/Tk (https://www.tcl.tk/) which is freely
+distributed for all the supported ToolKit platforms. A number of
+Tcl/Tk GUI scripts are distributed with the ToolKit release.  For
+control, the Synthesis Toolkit uses raw MIDI (on supported platforms),
+and SKINI (Synthesis ToolKit Instrument Network Interface, a MIDI-like
+text message synthesis control format).
+
+
+# SYSTEM REQUIREMENTS
+
+See the individual README's (e.g. README-linux) in the /doc directory
+for platform specific information and system requirements.  In
+general, you will use the configure script to create Makefiles on unix
+platforms (and MinGW) or the VS2017 workspace files to compile the
+example programs.  To use the Tcl/Tk GUIs, you will need Tcl/Tk
+version 8.0 or higher.
+
+
+# WHAT'S NEW (AND NOT SO NEW)
+
+Despite being available in one form or another since 1996, we still
+consider STK to be alpha software.  We attempt to maintain backward
+compatability but changes are sometimes made in an effort to improve
+the overall design or performance of the software.  Please read the
+"Release Notes" in the /doc directory to see what has changed since
+the last release.
+
+A new StkFrames class has been created to facilitate the handling and
+passing of multichannel, vectorized audio data.  All STK classes have
+been updated to include tick() functions that accept StkFrames
+arguments.
+
+The control message handling scheme has been simplified greatly
+through the use of the Messager class.  It is now possible to have
+access to simultaneous piped, socketed, and/or MIDI input control
+messages.  In most cases, this should eliminate the use of the
+Md2Skini program.
+
+Realtime audio input capabilities were added to STK with release 3.0,
+though the behavior of such is very hardware dependent.  Under Linux
+and Macintosh OS-X, audio input and output are possible with very low
+latency.  Using the Windows DirectSound API, minimum dependable output
+sound latency seems to be around 20 milliseconds or so, while input
+sound latency is generally higher.  Performance with the ASIO audio
+API on Windows provides much better performance.
+
+As mentioned above, it is possible to record the audio ouput of an STK
+program to .snd, .wav, .raw, .aif, and .mat (Matlab MAT-file) output
+file types.  Though somewhat obsolete, the program Md2Skini can be
+used to write SKINI scorefiles from realtime MIDI input.  Finally, STK
+should compile with non-realtime functionality on any platform with a
+generic C++ compiler.
+
+For those who wish to make a library from the core STK classes, the
+configure script generates a Makefile in the src directory that will
+accomplish that.
+
+
+# DISCLAIMER
+
+You probably already guessed this, but just to be sure, we don't
+guarantee anything works.  :-) It's free ... what do you expect?  If
+you find a bug, please let us know and we'll try to correct it.  You
+can also make suggestions, but again, no guarantees.  Send email to
+the mail list.
+
+
+# LEGAL AND ETHICAL
+
+This software was designed and created to be made publicly available
+for free, primarily for academic purposes, so if you use it, pass it
+on with this documentation, and for free.
+
+If you make a million dollars with it, it would be nice if you would
+share. If you make compositions with it, put us in the program notes.
+
+Some of the concepts are covered by various patents, some known to us
+and likely others which are unknown.  Many of the ones known to us are
+administered by the Stanford Office of Technology and Licensing.
+
+The good news is that large hunks of the techniques used here are
+public domain.  To avoid subtle legal issues, we'll not state what's
+freely useable here, but we'll try to note within the various classes
+where certain things are likely to be protected by patents.
+
+
+# FURTHER READING
+
+For complete documentation on this ToolKit, the classes, etc., see the
+doc directory of the distribution or surf to
+http://ccrma.stanford.edu/software/stk/.  Also check the platform
+specific README's for specific system requirements.
+
+
+# PERRY'S NOTES FROM THE ORIGINAL DISTRIBUTION
+
+This whole world was created with no particular hardware in mind.
+These examples are intended to be tutorial in nature, as a platform
+for the continuation of my research, and as a possible starting point
+for a software synthesis system.  The basic motivation was to create
+the necessary unit generators to do the synthesis, processing, and
+control that I want to do and teach about.  Little thought for
+optimization was given and therefore improvements, especially speed
+enhancements, should be possible with these classes.  It was written
+with some basic concepts in mind about how to let compilers optimize.
+
+Your question at this point might be, "But Perry, with CMix, CMusic,
+CSound, CShells, CMonkeys, etc. already cluttering the landscape, why
+a new set of stupid C functions for music synthesis and processing?"
+The answers lie below.
+
+1) I needed to port many of the things I've done into something which is generic enough to port further to different machines.
+
+2) I really plan to document this stuff, so that you don't have to be me to figure out what's going on. (I'll probably be sorry I said this in a couple of years, when even I can't figure out what I was thinking.)
+
+3) The classic difficulties most people have in trying to implement physical models are:
+
+    A) They have trouble understanding the papers, and/or in turning the theory into practice.
+
+    B) The Physical Model instruments are a pain to get to oscillate, and coming up with stable and meaningful parameter values is required to get the models to work at all.
+
+This set of C++ unit generators and instruments might help to diminish the scores of emails I get asking what to do with those block diagrams I put in my papers.
+
+4) I wanted to try some new stuff with modal synthesis, and implement some classic FM patches as well.
+
+5) I wanted to reimplement, and newly implement more of the intelligent and physical performer models I've talked about in some of my papers. But I wanted to do it in a portable way, and in such a way that I can hook up modules quickly.  I also wanted to make these instruments connectable to such player objects, so folks like Brad Garton who really think a lot about the players can connect them to my instruments, a lot about which I think.
+
+6) More rationalizations to follow . . .
+

STK.podspec

@@ -0,0 +1,55 @@
+ # To lint the spec:
+ # pod spec lint --skip-import-validation --allow-warnings
+ # To publish:
+ # pod trunk push STK.podspec --skip-import-validation --allow-warnings
+
+Pod::Spec.new do |spec|
+  spec.name         = 'STK'
+  spec.version      = '4.6.2'
+  spec.summary      = 'The Synthesis ToolKit in C++ is a set of open source audio signal processing and algorithmic synthesis classes.'
+  spec.homepage     = 'https://ccrma.stanford.edu/software/stk/'
+  spec.source       = { :git => 'https://github.com/thestk/stk.git', :tag => spec.version }
+  spec.license      = { :type => 'MIT' }
+  spec.author       = { "Ariel Elkin" => "ariel@arivibes.com" }
+  spec.platform     = :ios
+  spec.ios.deployment_target = "10.0"
+  spec.source_files = [
+    "src/*.cpp",
+    "include/*.h"
+  ]
+  spec.public_header_files = [
+    "include/*.h",
+    "include/SKINImsg.h",
+    "include/SKINItbl.h"
+  ]
+  spec.exclude_files = [
+    "include/Thread.h",
+    "src/Thread.cpp",
+    "include/Mutex.h",
+    "src/Mutex.cpp",
+    "include/UdpSocket.h",
+    "src/UdpSocket.cpp",
+    "include/Socket.h",
+    "src/Socket.cpp",
+    "include/TcpClient.h",
+    "src/TcpClient.cpp",
+    "include/TcpServer.h",
+    "src/TcpServer.cpp",
+    "include/InetWvIn.h",
+    "src/InetWvIn.cpp",
+    "include/InetWvOut.h",
+    "src/InetWvOut.cpp",
+    "include/RtAudio.h",
+    "src/RtAudio.cpp",
+    "include/RtMidi.h",
+    "src/RtMidi.cpp",
+    "include/RtWvIn.h",
+    "src/RtWvIn.cpp",
+    "include/RtWvOut.h",
+    "src/RtWvOut.cpp",
+    "include/RtError.h"
+  ]
+  spec.preserve_paths = "README.MD"
+  spec.resource_bundles = { "rawwaves": "rawwaves/*.raw" }
+  spec.libraries = 'c++'
+end

bin/treesed

@@ -0,0 +1,189 @@
+#!/usr/bin/perl
+
+# treesed
+# Written January 1996 by Rick Jansen (rick@sara.nl)
+# URL: http://www.sara.nl/rick
+
+# usage: treesed pattern1 pattern2 -tree 
+#        treesed pattern1 pattern2 -files file1 file2 ... 
+
+# example: treesed href HREF -files *.html
+
+# Treesed searches for pattern1 and replaces pattern1 by pattern2
+# if pattern2 supplied. If only pattern1 given treesed just searches.
+# Treesed will search in all files and subdirectories of the current
+# directory
+
+
+
+#--------------------------------------------------------
+# Parameters
+
+$DoEdit=0;
+$search_pattern = $ARGV[0];
+$search_pattern =~ s/(\W)/\\$1/g;  # escape regexp chars
+shift;
+
+while ($#ARGV >= 0) {
+  
+  if ($ARGV[0] eq '-files') {
+    @temp_ls = @ARGV[1 ..  $#ARGV];
+    # Get list of files, skip dirs
+    foreach $file (@ARGV[1 ..  $#ARGV]) {
+      if (-f $file) { 
+        push(@ls, $file); 
+      }
+    }
+    last;
+  }
+  elsif ($ARGV[0] eq '-tree') {
+    &Get_LS;
+    last;
+  }
+
+  if (! -f $ARGV[0]) {
+    if (defined($replacement_pattern)) {
+      print "usage: treesed pattern1 <pattern2> -tree/-files <files>\n";
+      exit(1);
+    }
+
+    $replacement_pattern = $ARGV[0];
+    #$replacement_pattern =~ s/(\W)/\\$1/g;  # escape regexp chars
+    $DoEdit=1;
+    shift;
+  }
+
+}
+
+# No files?
+if ($#ls < 0) {
+  print "xx No input files\n";
+  exit(1);
+}
+
+print "search_pattern: $search_pattern\n";
+print "replacement_pattern: $replacement_pattern\n";
+if ($DoEdit) {
+  print "\n** EDIT MODE!\n\n"; }
+else {
+  print "\n** Search mode\n\n";
+}
+
+#foreach $file (@ls) {
+#  print "$file \n";
+#}
+  
+
+#--------------------------------------------------------
+# Search list of files for pattern
+
+$linepos=0;
+
+$| = 1;  # Force flush after every write
+foreach $file (@ls) {
+  #print "$file\n";
+  print '.';
+  $linepos++;
+  if ($linepos > 50) {
+    $linepos=0;
+    print "\n";
+  }
+
+  if (!open(FILE, $file)) {
+    print "\nCould not open $file\n";
+    next;
+  }
+
+  $Found = 0;
+  $Count = 0;
+  $lineno = 0;
+  @lines = ();
+  while (<FILE>) {
+    $lineno++;
+    if (/$search_pattern/i) {
+      #print;
+      $Count++; 
+      $Found = 1;
+      push(@lines, $lineno);
+    }
+  }
+  close(FILE);
+  if ($Found) { 
+    print "\n$file: $Count lines on: @lines\n"; 
+  }
+
+  if ($Found && $DoEdit) { &Edit($file); }
+  
+}
+$| = 0;
+print "\n";
+
+
+exit(0);
+
+
+#--------------------------------------------------------
+# Edit file
+
+sub Edit {
+
+# Replace $ARGV[0] with $ARGV[1] in $file
+
+local($file) = @_;
+local($bakfile) = $file.'.'.$$;
+
+# First create backup
+open(FILE, $file) || die "Could not open $file for read\n";
+open(BAKFILE, ">$bakfile")  || die "Could not open $bakfile for backup\n";
+while (<FILE>) {
+  print BAKFILE;
+}
+close(BAKFILE);
+close(FILE);
+
+# Now replace $ARGV[0] by $ARGV[1] in the backupfile, 
+# result into $file
+open(BAKFILE, $bakfile) || die "Could not open $bakfile for read\n";
+open(FILE,">$file") || die "Could not open $file for write\n";
+$Count=0;
+while (<BAKFILE>) {
+  if (/$search_pattern/i) { $Count++; }
+  s/$search_pattern/$replacement_pattern/gi;
+  print FILE;
+}
+close(BAKFILE);
+close(FILE);
+
+print 
+"\nReplaced $search_pattern by $replacement_pattern on $Count lines in $file\n";
+
+}  #sub Edit
+
+#--------------------------------------------------------
+
+sub Get_LS {
+
+# Get a list of full path names into array @ls
+
+local(@localls)=`ls -R1`;
+local($item,$Dir);
+
+#print "localls: @localls\n";
+$Dir='';
+foreach $item (@localls) {
+  #print "$item\n";
+  if ($item =~ /:$/) { 
+    $Dir=$item; 
+    chop($Dir);
+    $Dir =~ s/:$/\//;
+  }
+  else {
+    chop($item);
+    $item = $Dir.$item;
+    if ($item !~ /^\s*$/) { push(@ls, $item); }
+  }
+}
+@localls=();
+
+}  # sub Get_LS
+

cmake/FindCoreAudio.cmake

@@ -0,0 +1,21 @@
+find_library(COREAUDIO_LIBRARY CoreAudio)
+find_library(COREAUDIO_FOUNDATION CoreFoundation)
+find_library(COREAUDIO_MIDI CoreMIDI)
+find_path(COREAUDIO_INCLUDE_DIRS CoreAudio/CoreAudio.h)
+
+include(FindPackageHandleStandardArgs)
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(
+    CoreAudio
+    DEFAULT_MSG 
+    COREAUDIO_LIBRARY
+    COREAUDIO_FOUNDATION
+    COREAUDIO_MIDI
+    COREAUDIO_INCLUDE_DIRS)
+
+mark_as_advanced(
+    COREAUDIO_LIBRARY
+    COREAUDIO_FOUNDATION
+    COREAUDIO_MIDI
+    COREAUDIO_INCLUDE_DIRS)
+
+

configure.ac

@@ -1,16 +1,23 @@
 # Process this file with autoconf to produce a configure script.
-AC_INIT(STK, 4.1, gary@ccrma.stanford.edu, stk)
+AC_INIT(STK, 4.6.2, gary.scavone@mcgill.ca, stk)
+AC_CONFIG_AUX_DIR(config)
 AC_CONFIG_SRCDIR(src/Stk.cpp)
-AC_CONFIG_FILES(src/Makefile projects/demo/Makefile projects/effects/Makefile projects/ragamatic/Makefile projects/examples/Makefile)
+AC_CONFIG_FILES(Makefile src/Makefile projects/demo/Makefile projects/effects/Makefile projects/ragamatic/Makefile projects/examples/Makefile projects/examples/libMakefile projects/eguitar/Makefile)
+
+# Fill GXX with something before test.
+AC_SUBST( GXX, ["no"] )
+
+# standards version
+m4_include([m4/ax_cxx_compile_stdcxx.m4])
+AX_CXX_COMPILE_STDCXX(11, noext, mandatory)
 
 # Checks for programs.
-AC_PROG_CC
-AC_PROG_CXX(CC g++ c++ cxx)
-AC_PROG_CXX
+AC_PROG_CXX(g++ CC c++ cxx)
 AC_PROG_RANLIB
-
-# Checks for libraries.
-AC_CHECK_LIB(stdc++, printf, , AC_MSG_ERROR(Stk requires the C++ library!) )
+AC_PATH_PROG(AR, ar, no)
+if [[ $AR = "no" ]] ; then
+    AC_MSG_ERROR("Could not find ar - needed to create a library");
+fi
 
 # Checks for header files.
 AC_HEADER_STDC
@@ -37,53 +44,193 @@ AC_MSG_RESULT($INCLUDE_PATH)
 
 # Check for realtime support disable
 AC_MSG_CHECKING(whether to compile realtime support)
-AC_ARG_ENABLE(realtime, [  --disable-realtime = only compile generic non-realtime classes], [AC_SUBST( realtime, [no] ) AC_SUBST( sound_api, [] )], [AC_SUBST( realtime, [yes] ) ] )
+AC_ARG_ENABLE(realtime,
+         [  --disable-realtime = only compile generic non-realtime classes],
+         realtime=$enableval)
+if test "$realtime" = "no"; then
+   AC_SUBST( sound_api, [] )
+else
+   AC_SUBST( realtime, [yes] )
+fi
 AC_MSG_RESULT($realtime)
 
-if test $realtime = yes; then
-  AC_CHECK_LIB(pthread, pthread_create, , AC_MSG_ERROR(realtime support requires the pthread library!))
-  AC_CHECK_FUNCS(gettimeofday select socket)
+AC_MSG_CHECKING(whether to build the static library)
+AC_ARG_ENABLE(static,
+         [  --disable-static = do not compile static library ],
+	 build_static=$enableval,
+	 build_static=yes)
+AC_SUBST(build_static)
+AC_MSG_RESULT($build_static)
+
+AC_MSG_CHECKING(whether to build the shared library)
+AC_ARG_ENABLE(shared,
+         [  --enable-shared = compile the shared library ],
+	 build_shared=$enableval,
+	 build_shared=no)
+AC_SUBST(build_shared)
+AC_MSG_RESULT($build_shared)
+
+if test x$build_static = xno -a x$build_shared = xno ; then
+        AC_MSG_ERROR([ both static and shared libraries are disabled], 1)
 fi
 
+# Check for math library
+AC_CHECK_LIB(m, cos, , AC_MSG_ERROR(math library is needed!))
+
 # Check for debug
 AC_MSG_CHECKING(whether to compile debug version)
 AC_ARG_ENABLE(debug,
-  [  --enable-debug = enable various debug output],
-  [AC_SUBST( debug, [-D_STK_DEBUG_] ) AC_SUBST( cflags, [-g] ) AC_SUBST( object_path, [Debug] ) AC_MSG_RESULT(yes)],
-  [AC_SUBST( debug, [] ) AC_SUBST( cflags, [-O2] ) AC_SUBST( object_path, [Release] ) AC_MSG_RESULT(no)])
+        [  --enable-debug = enable various debug output],
+        debug=$enableval)
+if test "$debug" = "yes"; then
+   AC_SUBST( cppflag, ["-D_STK_DEBUG_ -D__RTAUDIO_DEBUG__ -D__RTMIDI_DEBUG__"] )
+   AC_SUBST( cxxflag, ["-g"] )
+   AC_SUBST( object_path, [Debug] )
+else
+  AC_SUBST( debug, [no] )
+  AC_SUBST( cppflag, [] )
+  AC_SUBST( cxxflag, [-O3] )
+  AC_SUBST( object_path, [Release] )
+fi
+AC_MSG_RESULT($debug)
+
+# Checks for functions
+if test $realtime = yes; then
+  AC_CHECK_FUNCS(select socket)
+  AC_CHECK_FUNC(gettimeofday, [cppflag="$cppflag -DHAVE_GETTIMEOFDAY"], )
+fi
+
+# For -I and -D flags
+CPPFLAGS="$CPPFLAGS $cppflag"
+
+# For debugging and optimization ... overwrite default because it has both -g and -O2
+CXXFLAGS="$cxxflag"
 
 # Check compiler and use -Wall if gnu.
-if test $GXX = "yes" ; then
-  AC_SUBST( warn, [-Wall] )
+if [test $GXX = "yes" ;] then
+  AC_SUBST( cxxflag, [-Wall] )
 fi
 
+CXXFLAGS="$CXXFLAGS $cxxflag"
+
+AC_CANONICAL_HOST
+
+basesharedname="libstk-\$(RELEASE)"
+
+AC_SUBST( sharedlib, ["libstk.so"] )
+AC_SUBST( sharedname, [${basesharedname}.so] )
+AC_SUBST( libflags, ["-shared -Wl,-soname,${basesharedname}.so -o $sharedname"] )
+case $host in
+  *-apple*)
+  AC_SUBST( sharedlib, ["libstk.dylib"] )
+  AC_SUBST( sharedname, ["${basesharedname}.dylib"] )
+  AC_SUBST( libflags, ["-dynamiclib -install_name \$(libdir)/${basesharedname}.dylib -o ${basesharedname}.dylib"] )
+esac
+
 if test $realtime = yes; then
   # Checks for package options and external software
-  AC_CANONICAL_HOST
   AC_MSG_CHECKING(for audio API)
-  case $host in
-    *-*-linux*)
-    AC_ARG_WITH(alsa, [  --with-alsa = choose native ALSA API support (linux only)], [AC_SUBST( sound_api, [-D__LINUX_ALSA__] ) AC_MSG_RESULT(using ALSA) ], [AC_SUBST( sound_api, [-D__LINUX_OSS__] ) AC_MSG_RESULT(using OSS)])
 
-    if test $sound_api = -D__LINUX_ALSA__; then
-      AC_CHECK_LIB(asound, snd_pcm_open, , AC_MSG_ERROR(ALSA support requires the asound library!))
-    fi
-    AC_ARG_ENABLE(midiator, [  --enable-midiator = enable native MS-124W MIDI support (linux only)], [AC_SUBST( midiator, [-D__MIDIATOR__] )], [AC_SUBST( midiator, [] )])
+  AC_ARG_WITH(jack, [  --with-jack = choose JACK server support (mac and linux only)])
+  AS_IF([test "x$with_jack" == "xyes"], [
+api="$api -D__UNIX_JACK__"
+  AC_MSG_RESULT(using JACK)
+  AC_CHECK_LIB(jack, jack_client_open, , AC_MSG_ERROR(JACK support requires the jack library!))])
+
+  case $host in
+    *-*-netbsd*)
+    AS_IF([test "$api" == ""], [
+      AC_MSG_RESULT(using OSS)
+      api="$api -D__LINUX_OSS__"
+      LIBS="$LIBS -lossaudio"
+      AC_CHECK_LIB(pthread, pthread_create, , AC_MSG_ERROR(RtAudio requires the pthread library!))])
     ;;
 
-    *-sgi*)
-    AC_SUBST( sound_api, [-D__IRIX_AL__] )
-    AC_MSG_RESULT(using IRIX AL)
-    AC_CHECK_LIB(audio, alOpenPort, , AC_MSG_ERROR(IRIX audio support requires the audio library!) )
-    AC_CHECK_LIB(md, mdOpenInPort, , AC_MSG_ERROR(IRIX MIDI support requires the md library!) )
+    *-*-freebsd*)
+    AS_IF([test "$api" == ""], [
+      AC_MSG_RESULT(using OSS)
+      api="$api -D__LINUX_OSS__"
+      LIBS="$LIBS -lossaudio"
+      AC_CHECK_LIB(pthread, pthread_create, , AC_MSG_ERROR(RtAudio requires the pthread library!))])
+    ;;
+
+    *-*-linux*)
+    # Look for ALSA flag
+    AC_ARG_WITH(alsa, [  --with-alsa = choose native ALSA API support (linux only)])
+    AS_IF([test "x$with_alsa" == "xyes"], [
+    api="$api -D__LINUX_ALSA__"
+    AC_MSG_RESULT(using ALSA)
+    AC_CHECK_LIB(asound, snd_pcm_open, , AC_MSG_ERROR(ALSA support requires the asound library!))])
+
+    # Look for OSS flag
+    AC_ARG_WITH(oss, [  --with-oss = choose OSS API support (unixes only)])
+    AS_IF([test "x$with_oss" == "xyes"], [
+    api="$api -D__LINUX_OSS__ -D__LINUX_ALSA__"
+    AC_MSG_RESULT(using OSS)
+    AC_CHECK_LIB(asound, snd_pcm_open, , AC_MSG_ERROR(OSS support requires ALSA for RtMidi!))])
+
+    # If no audio api flags specified, use ALSA
+    AS_IF([test "$api" == ""], [
+      AC_MSG_RESULT(using ALSA)
+      AC_SUBST( api, [-D__LINUX_ALSA__] )
+      AC_CHECK_LIB(asound, snd_pcm_open, , AC_MSG_ERROR(ALSA support requires the asound library!))
+    ])
+
+    AC_CHECK_LIB(pthread, pthread_create, , AC_MSG_ERROR(RtAudio requires the pthread library!))
     ;;
 
     *-apple*)
-    # Check for CoreAudio and CoreMIDI framework
-    AC_CHECK_HEADERS(CoreAudio/CoreAudio.h CoreMIDI/CoreMIDI.h CoreServices/CoreServices.h,
-      [AC_SUBST( sound_api, [-D__MACOSX_CORE__] )],
-      [AC_MSG_ERROR(CoreAudio and/or CoreMIDI header files not found!)] )
-    AC_SUBST( frameworks, ["-framework CoreAudio -framework CoreMIDI -framework CoreFoundation"] )
+    # Look for Core flag
+    AC_ARG_WITH(core, [  --with-core = choose CoreAudio API support (mac only)])
+    AS_IF([test "x$with_core" == "xyes"], [
+    api="$api -D__MACOSX_CORE__"
+    AC_MSG_RESULT(using CoreAudio)
+    AC_CHECK_HEADER(CoreAudio/CoreAudio.h, [], [AC_MSG_ERROR(CoreAudio header files not found!)] )
+    LIBS="$LIBS -framework CoreAudio -framework CoreFoundation -framework CoreMIDI" ])
+
+    # If no audio api flags specified, use CoreAudio
+    AS_IF([test "$api" == ""], [
+      AC_SUBST( api, [-D__MACOSX_CORE__] )
+      AC_MSG_RESULT(using CoreAudio)
+      AC_CHECK_HEADER(CoreAudio/CoreAudio.h,
+      [],
+      [AC_MSG_ERROR(CoreAudio header files not found!)] )
+      AC_SUBST( LIBS, ["-framework CoreAudio -framework CoreFoundation -framework CoreMIDI"] )
+    ])
+
+    AC_CHECK_LIB(pthread, pthread_create, , AC_MSG_ERROR(RtAudio requires the pthread library!))
+    ;;
+
+    *-mingw32*)
+    AC_ARG_WITH(asio, [  --with-asio = choose ASIO API support (windoze only)])
+    AS_IF([test "x$with_asio" == "xyes"], [
+    api="$api -D__WINDOWS_ASIO__"
+    AC_MSG_RESULT(using ASIO)
+    AC_SUBST( objects, ["asio.o asiodrivers.o asiolist.o iasiothiscallresolver.o"] ) ])
+
+    # Look for DirectSound flag
+    AC_ARG_WITH(ds, [  --with-ds = choose DirectSound API support (windoze only)])
+    AS_IF([test "x$with_ds" == "xyes"], [
+    api="$api -D__WINDOWS_DS__"
+    AC_MSG_RESULT(using DirectSound)
+    LIBS="-ldsound $LIBS" ])
+
+    # Look for WASAPI flag
+    AC_ARG_WITH(wasapi, [  --with-wasapi = choose Windows Audio Session API support (windoze only)])
+    AS_IF([test "x$with_wasapi" == "xyes"], [
+    api="$api -D__WINDOWS_WASAPI__"
+    AC_MSG_RESULT(using WASAPI)
+    LIBS="-luuid -lksuser $LIBS" ])
+
+    # If no audio api flags specified, use DirectSound
+    AS_IF([test "$api" == ""], [
+      AC_SUBST( api, [-D__WINDOWS_DS__] )
+      AC_MSG_RESULT(using DirectSound)
+      LIBS="-ldsound -lwinmm $LIBS"
+    ])
+
+    api="$api -D__WINDOWS_MM__"
+    LIBS="-lole32 -lwinmm -lwsock32 $LIBS"
     ;;
 
     *)
@@ -91,10 +238,8 @@ if test $realtime = yes; then
     AC_MSG_ERROR(Unknown system type for realtime support ... try --disable-realtime argument!)
     ;;
   esac
+
+CPPFLAGS="$CPPFLAGS $api"
 fi
 
-# Checks for library functions.
-AC_PROG_GCC_TRADITIONAL
-AC_CHECK_FUNCS(strstr)
-
 AC_OUTPUT

doc/Hierarchy.txt

@@ -1,167 +0,0 @@
-STK: A ToolKit of Audio Synthesis Classes and Instruments in C++
-
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
-
-STK Classes - See the HTML documentation in the html directory for complete information.
-
-     .- Envelope - ADSR
-     |
-     |- Noise - SubNoise
-     |
-     |- Table
-     |
-     |- WvIn - (WaveLoop, RtWvIn, TcpWvIn)
-     |
-     |- WvOut - (RtWvOut, TcpWvOut)
-     |
-     |- Filter - (OnePole, OneZero, Delay, TwoPole, TwoZero, PoleZero, Biquad)
-     |                                |                                  |
-     |                              DelayL                             FormSwep
-     |                              DelayA
-     |
-     |- Echo, Chorus, PitShift
-     |
-     |- RtAudio, RtMidi, Socket, Thread
-Stk -|
-     |- Reverb - (PRCRev, JCRev, NRev)
-     |
-     |- Modulate
-     |
-     |- SingWave
-     |
-     |- Voicer
-     |
-     |- Messager
-     |
-     |- SKINI
-     |
-     |- ReedTabl, JetTabl, BowTabl
-     |
-     |            .- FM - (HevyMetl, PercFlut, Rhodey, Wurley, TubeBell, BeeThree, FMVoices)
-     |            |
-     |            |- Modal - ModalBar
-     |            |
-     |            |- VoicForm
-     |            |
-     |            |- Sampler - Moog
-     |            |
-     |            |- Resonate
-     |            |
-     |            |- PluckedTwo - Mandolin
-     .- Instrmnt -|
-                  |- Drummer
-                  |
-                  |- Clarinet, BlowHole, Saxofony, Flute, Brass, BlowBotl, Bowed, Plucked, StifKarp, Sitar
-                  |
-                  |- Shakers
-                  |
-                  |- BandedWG
-                  |
-                  |- Mesh2D
-                  |
-                  .- Whistle
-
-
-***********   UNIT GENERATORS   **************
-
-Master Class:  Stk.cpp         Sample rate, byte-swapping, error handling functionality
-
-Sources:       Envelope.cpp    Linearly Goes to Target by Rate
-               ADSR.cpp        ADSR Flavor of Envelope
-               Noise.cpp       Random Number Generator
-               SubNoise.cpp    Random Numbers each N samples
-               Table.cpp       Lookup Table (assumes given data in big-endian format)
-               WvIn.cpp        Data Input Class (interpolating) for RAW, WAV, SND (AU), AIFF, MAT-file files
-               WaveLoop.cpp    Wavetable looping (subclass of WvIn)
-               RtWvIn.cpp      Realtime Audio Input Class (subclass of WvIn)
-               TcpWvIn.cpp     Audio Streaming (socket server) Input Class (subclass of WvIn)
-
-Sinks:         WvOut.cpp       Output Master Class for RAW, WAV, SND (AU), AIFF, MAT-file files
-               RtWvOut.cpp     Realtime Output Class (subclass of WvOut)
-               TcpWvOut.cpp    Audio Streaming (socket client) Output Class (subclass of WvOut)
-
-Duplex:        RtDuplex.cpp    Synchronous Realtime Audio Input/Output Class
-
-Filters:       Filter.cpp      Filter Master Class
-               OneZero.cpp     One Zero Filter
-               OnePole.cpp     One Pole Filter
-               PoleZero.cpp    One Pole/One Zero Filter
-               TwoZero.cpp     Two Zero Filter
-               TwoPole.cpp     Two Pole Filter
-               BiQuad.cpp      Two Pole/Two Zero Filter
-               FormSwep.cpp    Sweepable BiQuad Filter (goes to target by rate)
-               Delay.cpp       Non-Interpolating Delay Line Class
-               DelayL.cpp      Linearly Interpolating Delay Line (subclass of Delay)
-               DelayA.cpp      Allpass Interpolating Delay Line (subclass of Delay)
-
-Non-Linear:    JetTabl.cpp     Cubic Jet Non-Linearity
-               BowTabl.cpp     x^(-3) Bow Non-Linearity
-               ReedTabl.cpp    One Breakpoint Saturating Reed Non-Linearity
-                                
-Derived:       Modulate.cpp    Periodic and Random Vibrato: RawWvIn, SubNoise, OnePole
-               SingWave.cpp    Looping wave table with randomness: Modulate, WaveLoop, Envelope
-
-
-********** INSTRUMENTS AND ALGORITHMS **************
-
-Each Class will be listed either with all the unit generators it uses, 
-or the <<Algorithm>> of which it is a flavor.  All inherit from Instrmnt,
-which inherits from Stk.
-
-Simple.cpp      Simple Instrument              Pulse oscillator + resonant filtered noise
-Plucked.cpp     Basic Plucked String           DelayA, OneZero, OnePole, Noise
-StifKarp.cpp    Plucked String with Stiffness  DelayA, DelayL, OneZero, BiQuad, Noise
-PluckTwo.cpp    Not So Basic Pluck             DelayL, DlineA, OneZero
-Mandolin.cpp    Commuted Mandolin              <<flavor of PluckTwo>>
-Bowed.cpp       So So Bowed String             DelayL, BowTabl, OnePole, BiQuad, WaveLoop, ADSR
-Brass.cpp       Not So Bad Brass Instrument    DelayA, BiQuad, PoleZero, ADSR, WaveLoop
-Clarinet.cpp    Pretty Good Clarinet           DelayL, ReedTabl, OneZero, Envelope, Noise, WaveLoop
-BlowHole.cpp    Clarinet w/ Tone & Vent Holes  DelayL, ReedTabl, OneZero, Envelope, Noise, WaveLoop, PoleZero
-Saxofony.cpp    A Faux Saxophone               DelayL, ReedTabl, OneZero, Envelope, Noise, WaveLoop
-Flute.cpp       Pretty Good Flute              JetTabl, DelayL, OnePole, PoleZero, Noise, ADSR, WaveLoop
-BlowBotl.cpp    Blown Bottle                   JetTabl, BiQuad, PoleZero, Noise, ADSR, WaveLoop
-BandedWG.cpp    Banded Waveguide Meta-Object   Delay, BowTabl, ADSR, BiQuad
-Modal.cpp       N Resonances                   Envelope, WaveLoop, BiQuad, OnePole
-ModalBar.cpp    Various presets                4 Resonance Models
-FM.cpp          N Operator FM Master           ADSR, WaveLoop, TwoZero
-HevyMetl.cpp    Distorted FM Synthesizer       3 Cascade with FB Modulator
-PercFlut.cpp    Percussive Flute               3 Cascade Operators
-Rhodey.cpp      Rhodes-Like Electric Piano     2 Parallel Simple FMs
-Wurley.cpp      Wurlitzer Electric Piano       2 Parallel Simple FMs
-TubeBell.cpp    Classic FM Bell                2 Parallel Simple FMs
-FMVoices.cpp    3 Formant FM Voice             3 Carriers Share 1 Modulator
-VoicForm.cpp    4 Formant Voice Synthesis      FormSwep, SingWave, OnePole, OneZero, Envelope, Noise
-BeeThree.cpp    Cheezy Additive Organ          4 Oscillators Additive
-Sampler.cpp     Sampling Synthesizer           5 each ADSR, WvIn, WaveLoop, OnePole
-Moog.cpp        Swept Filter                   Sampler with Swept Filter
-Resonate.cpp    Filtered Noise                 ADSR, BiQuad, Noise
-Drummer.cpp     Drum Synthesizer               Bunch of WvIns, and OnePole
-Shakers.cpp     PhISM statistical model for shakers and real-world sound effects
-Mesh2D.cpp      Two-dimensional, rectilinear digital waveguide mesh.
-Whistle.cpp     Hybrid physical/spectral model of a police whistle.
-
-Reverb.cpp      Reverberator Effects Processor  Master Class for reverberators
-JCRev.cpp       Chowning Reverberator           3 series allpass units, 4 parallel combs, 2 stereo delays
-NRev.cpp        Another famous CCRMA Reverb	    8 allpass, 6 parallel comb filters
-PRCRev.cpp      Dirt Cheap Reverb by Cook	      2 allpass, 2 comb filters
-Flanger.cpp     Flanger Effects Processor       DelayL, WaveLoop
-Chorus.cpp      Chorus Effects Processor        DelayL, WaveLoop
-PitShift.cpp    Cheap Pitch Shifter             DelayL
-
-
-***********   OTHER SUPPORT CLASSES AND FILES   **************
-
-RtAudio.cpp     Multi-OS/API audio I/O routines
-RtMidi.cpp      Multi-OS/API MIDI I/O routines
-Messager.cpp    Pipe, socket, and MIDI control message handling
-Voicer.cpp      Multi-instrument voice manager
-
-demo.cpp        Demonstration program for most synthesis algorithms
-effects.cpp     Effects demonstration program
-ragamatic.cpp   Nirvana just waiting to happen
-
-SKINI.cpp	      SKINI file/message parser object
-SKINI.msg	      #defines for often used and universal MIDI/SKINI symbols
-SKINI.tbl	      Table of SKINI messages
-
-

doc/README-Linux.txt

@@ -1,26 +1,13 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
+By Perry R. Cook and Gary P. Scavone, 1995--2021.
 
 Please read the file README and INSTALL for more general STK information.
 
-Realtime support for Linux is currently using either the Open Sound System (OSS) or the Advanced Linux Sound Architecture (ALSA) sound and MIDI APIs.  The free version of OSS works as well (and in some cases better than the commercial OSS version ... such as with my Maestro 2e chipset).  In general, the ALSA drivers also seem to perform well.  You can read more about ALSA at http://www.alsa-project.org/.  ALSA is open source and holds great promise for audio under Linux.  The API is selected during compilation using either the __LINUX_ALSA__ or __LINUX_OSS__ definitions.  The configure script uses the OSS API by default.  The ALSA API can be selected by passing the "--with-alsa" option to configure.
+Realtime audio support for Linux currently includes the Advanced Linux Sound Architecture (ALSA), the JACK low-latency audio server, and/or Open Sound System (OSS version 4.0 and higher only) APIs.  That said, the OSS API support has not been tested in several years and is not considered a high priority.  One or more APIs are selected during compilation using the __LINUX_ALSA__, __UNIX_JACK__, and/or __LINUX_OSS__ definitions.  Because the ALSA library is now integrated into the standard Linux kernel, it is the default audio/MIDI API with STK versions 4.2 and higher.
 
-STK should compile without much trouble under Linux ... afterall, it is primarily developed on Linux platforms.  Since all Linux distributions typically include the GNU makefile utilities, you should be able to use the default Makefile.  Typing "make" will initiate the compilation process.
+Realtime MIDI support Linux currently includes the Jack and ALSA sequencer support.  Native OSS MIDI support no longer exists in RtMidi.  If the __LINUX_OSS__ preprocessor definition is specified, only OSS audio support will be compiled and RtMidi will still be compiled using the ALSA API.  For this reason, STK now requires the asound library for realtime support (unless only using the Jack API).  Realtime programs must also link with the pthread library.
 
-MIDIATOR SERIAL PORT MIDI SUPPORT:
-
-STK now has special support for the MIDIator serial port MIDI interface.  This is of primary interest to us laptop users, whose computers usually don't have a gameport.  If you want to buy one of these devices, make sure you get the MS-124w model (www.midiator.com).  For it to work in STK, you must provide the __MIDIATOR__ definition during compilation (in addition to either __LINUX_ALSA__ or __LINUX_OSS__) or pass the "--enable-midiator" option to configure.
-
-There are a few things that need to be done on your system to get the MIDIator working. Assuming you wish to attach the MIDIator to serial port 0, add the following lines to your bootup sequence in /etc/rc.d/rc.local:
-
-setserial /dev/ttyS0 baud_base 57600
-setserial /dev/ttyS0 divisor 1
-
-You may need to specify the full path to the setserial function, depending on how your PATH variable is set up.  Also, you may need to modify the permissions of /dev/ttyS0 (chmod a+rwx).  And finally, the MIDIator should be set for "single addresssed" mode (the S/A switch on S and the A/B switch on A), which puts identical output on all 4 MIDI output ports.  It is possible to use the MIDIator in a "multi-port" mode, though I'm not currently supporting that in STK.
-
-NOTE REGARDING PTHREADS:
-
-There haven't been any problems with threads since the old days of RedHat Linux 5.0.  STK uses the MIT pthreads API.
+STK should compile without much trouble under Linux.  Since all Linux distributions typically include the GNU makefile utilities, you should be able to use the default Makefiles.  Typing "make" in a project directory will initiate the compilation process (after initially running the configure script in the top-level directory).
 
 

doc/README-MacOSX.txt

@@ -1,29 +1,16 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
+By Perry R. Cook and Gary P. Scavone, 1995--2021.
 
 Please read the file README and INSTALL for more general STK information.
 
-Realtime support for Macintosh OS X uses the CoreAudio HAL API and is specified during compilation using the __MACOSX_CORE__ preprocessor definition.
-
-It is necessary to download the OS X developer kit in order to compile STK.  STK was successfully tested on OS X versions 10.1 and 10.2.
-
-The internal Macintosh audio hardware typically supports a sample rate of 44100 Hz only.  Therefore, it is necessary to either specify this rate as a command-line option to the STK example programs or to change the default sample rate inside the Stk.h file before compilation.  In addition, the RT_BUFFER_SIZE, specified in Stk.h, could be increased (to a higher power of two) for more robust performance.
-
-There is a potential conflict between the STK Delay class and a Delay() function declared in OSUtils.h (which is included via <CoreServices/CoreServices.h>).  In general, this conflict can be avoided via the use of a namespace (an explicit Delay::Delay declaration), though this made the Windows Visual C++ compiler barf.  If you use STK classes within a project that includes the OSUtils.h file, you will likely need to make changes in STK classes that use the Delay class.
+The default realtime support for Macintosh OS X uses the CoreAudio HAL API and is specified during compilation using the __MACOSX_CORE__ preprocessor definition.  There is also support for the JACK audio server using the __UNIX_JACK__ preprocessor definition.
 
+It is necessary to install the OS X developer kit (or the command line tools) in order to compile STK.  STK was successfully tested on the latest version of OS X.
 
 Tcl/Tk on OS X:
 
-The tcl/tk interpreter does not ship by default with OS X, but must be downloaded from the internet.  Binary distributions exist but it is instead recommended that you download recent tcl and tk source distributions (http://dev.scriptics.com/software/tcltk/downloadnow84.tml) and compile them as follows:
+I think that Tcl/Tk interpreter is now included in the Xcode package, since I haven't had to download it for several years now.
 
-  make -C tcl/macosx deploy
-  make -C tk/macosx deploy
-  sudo make -C tcl/macosx install-deploy
-  sudo make -C tk/macosx  install-deploy
+It appears that socket support in Tcl/Tk on OS X uses the Nagle algorithm, which produces poor response between changes made in the Tcl/Tk script and the resulting audio updates.  Note that this is only a problem when using a socket connection from a Tcl/Tk script.
 
-(Note: the tcl and tk directories specified in the above lines will more likely be appended with version numbers)  The default installation will place a link to the wish interpretor at /usr/bin/wish.  The latest 8.4.1 release of tcl/tk has been tested on a 10.2 system and found to work correctly.  In particular, redirection of a tcl/tk script to the interpreter (e.g., wish < test.tcl) works normally (which is not the case with binary distributions tested thus far).
-
-Initial tests have shown somewhat poor response between changes made in the tcl/tk script and the resulting audio updates.
-
-Also, it is not recommended to connect by socket from a tcl/tk script to an STK program because the tcl/tk interpreter does not appear to properly close the socket connection, leaving the STK program in a "hung" state.

doc/README-NeXT.txt

@@ -1,7 +0,0 @@
-The Synthesis ToolKit in C++ (STK)
-
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
-
-Please read the file README and INSTALL for more general STK information.
-
-STK has always worked under NeXTStep without realtime audio or MIDI support.  In general, STK should compile in this way using any generic C++ compiler.  C++ exception handling was added to STK with release 3.2.  We managed to get a version of gcc compiled for NeXTStep that can deal with C++ exceptions.

doc/README-SGI.txt

@@ -1,13 +1,7 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
+By Perry R. Cook and Gary P. Scavone, 1995--2021.
 
 Please read the file README and INSTALL for more general STK information.
 
-The project Makefiles are created by configure.  If you have trouble running "make", try invoking "gmake" (for GNU make).  If that doesn't work, try to download the GNU Makefile utilities from the Internet.
-
-Another issue that has crept up with this release is proper compiler support for C++ error handling.  If you experience problems, you probably don't have a recent version of the C++ compiler.  Otherwise, STK should compile and run on SGI platforms without any problems.  Release 4.0 of STK is confirmed to compile (with various warnings) using CC version 7.30.
-
-NOTE REGARDING PTHREADS:
-
-Since release 3.1, STK has used the pthread API under Irix.  It appears that pthread functionality is standard on SGI, so this change shouldn't cause any problems.  If I'm wrong, let me know!
+Since STK version 4.3, realtime support for IRIX has been discontinued due to an inability to test it.  If you need realtime support on an SGI, go back to version 4.2.1.  Release 4.0 of STK is confirmed to compile (with various warnings) using CC version 7.30.

doc/README-Win.txt

@@ -1,74 +1,26 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
+By Perry R. Cook and Gary P. Scavone, 1995--2021.
 
-Please read the file README for more general STK information.
+Please read the file README.md for more general STK information.
 
-DirectX and WindowsNT Issues:
------------------------------
+The configure script supports MinGW.
 
-STK is currently distributed with Visual C++ 6.0 project and workspace files.  It has been tested using both Visual C++ 6.0 and Visual C++ .NET.
+STK has been built and tested on Windows platforms using Visual Studio.  It is assumed here that you're familiar with Visual C++ and its particular idiosyncrasies. The currently supported version is VS2017. You can download the free non-commercial community edition from the Microsoft website. The folders in the projects directory contain VS2017 solution files.
+If you are creating a new stk application, it's easiest to use the supplied template:
+- Copy stk\projects\stk-template.zip to C:\Users\<user>\Documents\Visual Studio 2017\Templates\ProjectTemplates\Visual C++ Project\
+- Start VS2017.
+- Select create new project...
+- Select Visual C++.
+- Select stk-template and enter your preferred project name and location. Note that if you do not put the project at the same level as stk\projects you will have to fix all paths in the project properties to match.
+- The template is based on one of the projects in the examples directory. Add/remove files as needed and edit main.cpp to taste.
 
-IMPORTANT VC++ NOTE: When compiling "release" versions of STK programs, link to the release multithreaded library.  When compiling "debug" versions, link to the debug multithreaded library.  Compiler errors will result otherwise.  Also, the Microsoft folk are up to their old habits of trying to change standards.  The .NET compiler will complain about cerr for some reason.
+To use the Tcl/Tk GUIs, you will have to install Tcl/Tk and build using MinGW.
 
-Both the DirectSound and Steinberg ASIO audio APIs are supported for realtime audio input/output.  The Visual C++ project files included with this distribution are configured to use the DirectSound API.  In order to use the ASIO API, it is necessary to change the preprocessor definition from __WINDOWS_DS__ to __WINDOWS_ASIO__, as well as include all the files in the /src/asio/ directory (i.e. asio.h, asio.cpp, ...).  If you have a good quality soundcard and a native ASIO driver (not emulated), you are likely to get much better input/output response using that.
+With Windows XP and later, piping works as under unix.  Simply fire up the script files (e.g. StkDemo.bat) by either double-clicking on them or from within a shell.
 
-When using the DirectSound API for audio input, latency is typically pretty horrendous (should we be surprised?).  Also, there is a slight chance you don't have DirectSoundCapture support on your computer.  If not, you should download the DirectX 6.0 (or higher) runtime libraries from Microsoft's WWW site (http://www.microsoft.com/directx/download.asp) in order to run the pre-compiled STK executables for Windoze.  The last time I checked, there was no DirectSoundCapture support for WindowsNT ... you'll have to switch to Windows 2000 or XP or use an ASIO driver.  I stopped supporting the WinMM audio output code with release 3.2.
-
-Realtime MIDI input is supported using the winmm.lib API.
-
-Visual C++ 6.0 workspaces have been created for the various STK projects.  Everything has already been configured for you.  The intermediate .obj files will be written to either the "Release" or "Debug" directories, but the executable files will be written to the main project directories (where they need to be for proper execution).  If you should somehow lose or hose the VC++ workspace file for a project, then you will have to do a LOT of configuring to recreate it ... it's probably easier just to download the distribution again from our WWW sites.  Anyway, for your benefit and mine, here is a list of things that need to be added to the various "Project Settings":
-
-1. Under General: Set "Output files:" to <blank> (this will put the executable in the main project directory.
-
-2. Under C/C++ > Code Generation: Set "Use run-time library:" to Multithreaded (use "debug" versions for the debug configuration).
-
-3. Under Link > General:  Add winmm.lib, dsound.lib, and Wsock32.lib to the end of the Object/library modules list.
-
-4. Under C/C++ > Preprocessor: Add "../../include" directory to the "extra include" field.
-
-5. Under C/C++ > Preprocessor: Add "__WINDOWS_DS__" to the definitions field.
-
-6. Add all the necessary files to the project.
-
-Remember that items 1-5 above need to be done for each project and for each configuration.  There might be an easy way to make global changes, but I couldn't figure it out.
-
-To use the Tcl/Tk GUIs, you will have to install Tcl/Tk.  I got version 8.0 and it works very well (and installed easily).  The distribution is available on the WWW and is free.
-
-In order for socketing to work, it is necessary to have the TCP protocol installed on your computer.  This can be done from the "Network" control panel.
-
-Finally, to use it all -
-
-
-WINDOWS XP/2000:
-
-There is a big advantage in using Windows XP/2000 over 95/98 with STK in that piping works, just as under unix.  Also, the scheduler in 2000/XP seems to be much better, so socketed messages don't get clumped together like they do in Windows 95/98.  Simply fire up a script file (ex. StkDemo.bat) by either double-clicking on it or typing it within a shell.
-
-
-WINDOWS 95/98:
-
-PLAY SKINI SCOREFILES IN REALTIME:
-
-	demo Clarinet -or < scores/streetsf.ski
-
-USE TCL/TK GUIs FOR REALTIME CONTROL:
-
-1. Open a DOS console window and start syntmono (eg. demo Clarinet -or -is).
-
-2. Double click on a Tcl/Tk file in the tcl/ subdirectory of the demo directory (eg. Demo.tcl) from the Windows Explorer to start the GUI.  Select the "communications" menu item and "Socket" and make the connection.
-
-3. Start moving the sliders to control the instrument.
-
-
-USE REALTIME MIDI INPUT FOR CONTROL:
-
-1. Open a DOS console window and start syntmono with MIDI input (eg. demo Clarinet -or -im).
-
-   This assumes you already have MIDI setup correctly for your computer.
-
-
-WINDOWS NT ONLY:
-
-Realtime piping seems to work under WindowsNT in much the same way as on Unix platforms.  Thus, it is possible to pipe realtime control data to syntmono under WindowsNT as well.  Note, however, that the DirectSoundCapture API does not exist for WindowsNT, so it is necessary to use an ASIO audio driver and the STK ASIO support.
+The DirectSound, WASAPI and Steinberg ASIO audio APIs are supported for realtime audio input/output.  The VS2017 project files included with this distribution are configured to use all supported APIs.  The default (as in stk-template) is the DirectSound API (preprocessor definition __WINDOWS_DS__). In order to use the ASIO API, it is necessary to use the preprocessor definition __WINDOWS_ASIO__, as well as include most of the files in the /src/include/ directory (i.e. asio.h, asio.cpp, ...).  If you have a good quality soundcard and a native ASIO driver (not emulated), you are likely to get much better input/output response using that.
 
+When using the DirectSound API for audio input, latency can be high.  If you experience realtime audio "stuttering", you should experiment with different "buffer size" and "number of buffers" values.
 
+Realtime MIDI input/output is supported by RtMidi using the winmm.lib API and requires the __WINDOWS_MM__ preprocessor definition.

doc/ReleaseNotes.txt

@@ -1,6 +1,184 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2002.
+By Perry R. Cook and Gary P. Scavone, 1995--2021.
+
+v.4.6.2 (17 November 2021)
+- see github site for complete details (github.com/thestk/stk)
+- bug fixes in LentPitShift and Granulate classes
+- Makefile fixes
+- miscellaneous bug fixes
+
+v.4.6.1 (18 April 2019)
+- see github site for complete details (github.com/thestk/stk)
+- various documentation updates
+- new Recorder (flute a la Verge) class (thanks to Mathias Bredholt)
+- updated Modulate class to allow noise rate control
+- new VS2017 project files
+- fix in FileLoop::getSize() to return file size (not chunk size)
+
+v.4.6.0 (31 August 2017)
+- see github site for complete details
+- various build system updates
+- fixes in FileWvIn / FileLoop for normalisation and scaling, as well as file opening
+- bug fix for MAT-files in FileWrite
+- bug fix in MidiFileIn.cpp for timing and time-code formats
+- updated versions of RtAudio and RtMidi
+
+v4.5.1 (22 February 2017)
+- fix for FileWvIn / FileLoop classes to avoid keeping files open if not necessary
+- miscellaneous bug fixes, documented on GitHub site (github.com/thestk/stk)
+- update to play.cpp example to play mono files as stereo
+- bug fix in DelayL::setDelay() function
+- miscellanous build bug fixes
+
+v4.5.0: (26 April 2014)
+- updated versions of RtAudio and RtMidi, with associated renaming of RtError class to either RtAudioError or RtMidiError and addition of WASAPI support in Windows
+- added support in FileRead for little-endian AIFC file format
+- new iOS project files (thanks to Ariel Elkin)
+- bug fix in FreeVerb that could cause crackling for stereo input
+- various bug fixes and updates to minimize compiler warnings
+- ADSR fix for decay/release time calculations
+- various updates to build system
+
+v4.4.4: (24 August 2012)
+- new FreeVerb class (thanks to Greg Burlet)
+- new Guitar class
+- new electric guitar project
+- cleaned / revised Shakers class
+- updated versions of RtAudio and RtMidi
+- bug fix in LentPitShift
+- bug fix in Echo constructor
+- bug fix in FileWvIn (file size when chunking)
+- bug fix in StkFrames copy constructor
+
+v4.4.3: (30 August 2011)
+- changed SINT24 to be lower 3 bytes of 32-bit word
+- bug fixes to vectorized tick functions in Effects classes
+- updated versions of RtAudio and RtMidi
+- fix to ADSR bugs
+- updates to the internal argument checking and reporting scheme
+- updates to Bowed class (thanks to Esteban Maestre!)
+- fixes for 24-bit support in FileRead and FileWrite
+- added WAVE_FORMAT_EXTENSIBLE support in FileWrite
+- added sample rate variable reading and writing for MAT-files in FileRead and FileWrite
+
+v4.4.2: (4 February 2011)
+- added various header file includes for newer compilers
+- new LentPitShift class (thanks to Francois Germain)
+- added "addTo" function to Delay class
+- updates to RtAudio and RtMidi
+- bug fixes in Voicer class (thanks Richard Dobson!)
+- bug fixes in Granulate class
+- added Makefile.in to compile library and all projects, as well as clean and distclean all
+
+v4.4.1: (3 June 2010)
+- added multi-channel/frame tick() virtual function to WvIn and WvOut abstract base classes (required update to RtWvOut class)
+- updated configure script to select g++ compiler by default
+- in demo.cpp: removed voicer grouping for messages, fixing polyphony when messages are on the same MIDI/SKINI channel
+- updates to RtAudio and RtMidi
+
+v4.4: (30 April 2010)
+- all classes embedded in the "stk" namespace (except RtAudio, RtMidi, and RtError)
+- class WaveLoop renamed FileLoop
+- significant efficiency improvements via code restructuring and inlining
+- some class source (.cpp) files deleted as part of inlining (Generator, Filter, Function, WvIn, WvOut, Effect, Instrmnt, BowTable, ReedTable, JetTable, Vector3D)
+- updates to RtAudio and RtMidi
+- previous "tickFrame()" functions renamed "tick" for more consistent API
+- more consistent and scalable approach to multichannel data and computations
+- multichannel support added to Granulate class
+- Filter class made abstract.  New Iir and Fir classes made for non-order-specific filtering.
+- new TapDelay class
+- SubNoise class deleted (same as sub-sampled "ticking" of Noise class)
+
+
+v4.3.1: (7 December 2007)
+- further headerless file support in FileRead
+- bug fix in RtWvOut.cpp
+- added configure support for MinGW
+- updates to RtAudio and RtMidi for MinGW
+- changes to channel assignment in demo.cpp
+
+
+v4.3.0: (13 August 2007)
+- an official MIT-like license
+- new functionality to automatically update class data when the STK sample rate changes (partly implemented)
+- updates for new RtAudio version 4.0
+- removed RtDuplex class, users should use RtAudio directly with a callback function
+- bug fix in interpolate() function in Stk.h for non-interleaved data
+- fixes / improvements to the Granulate class
+- fix in Whistle when doing animation
+- fixes in BlitSquare for frequency, harmonics, and dc offset
+- updates to Makefiles for non-realtime compile
+- fix in demo.cpp for voice channel assignment
+- updated versions of RtMidi and RtAudio
+- updated ASIO files for MinGW compiler
+- new FAQ in documentation
+- MAT-file bug fix in FileRead class
+
+
+v4.2.1: (14 October 2005)
+- greatly expanded StkFrames functionality (including interpolation and indexing by channel/frame)
+- new Granulate granular synthesis class
+- new Blit, BlitSaw, and BlitSquare bandlimited waveform classes (thanks to Robin Davies!)
+- removed Table class ... all functionality (including interpolation) now in StkFrames and FileRead classes
+- revised Socket class (now abstract) and added TcpServer, TcpClient, and UdpSocket subclasses
+- added Stk::showWarnings() and Stk::printErrors() functions to dis/enable warning and error printouts
+- extracted file I/O functionality to new FileRead and FileWrite classes
+- revised WvIn / WvOut class structure (WvIn / WvOut now abstract and file I/O functionality in new FileWvIn / FileWvOut subclasses)
+- new SineWave class which calculates its own static table of variable length (no rawwave dependency)
+- new sinewave.raw file of length 1024 samples (used to be 256)
+- TcpWvIn and TcpWvOut renamed InetWvIn and InetWvOut, with added support for UDP sockets
+- fixed bug in WvOut tickFrame( const  StkFrames &frames ) function
+- fixed bug in demo.cpp when writing output soundfiles without realtime output
+- added "binary" open flag to MidiFileIn class for Windows
+- fixed oversized MAT-file header in WvOut.cpp
+- fixed case statement bug in MidiFileIn.cpp for sysex
+- added missing getDelay() function to DelayA.cpp
+- fixed modDepth omission in Chorus.cpp
+- fixed DC blocker initialization bug in Flute.cpp
+- changed Filter class behavior so no default clearing of state when changing coefficients
+- bug fixes to RtAudio, especially for Windows DirectSound and ASIO (thanks to Robin Davies)
+- bug fixes to RtMidi, especially for Linux (thanks to Pedro Pedro Lopez-Cabanillas)
+
+
+v4.2.0: (4 October 2004)
+- simultaneous multiple audio APIs supported at compile time
+- fixed hidden overloaded virtual functions
+- new Asymp exponential envelope class
+- various changes to better conform to standard C++ programming practices
+- MY_FLOAT type converted to StkFloat and changed throughout (use treesed utility to search/replace in old files)
+- most example programs rewritten to use an audio callback paradigm (which works better in OS-X)
+- new StkFrames class for vectorized multichannel data and associated new tick() functions making use of StkFrames
+- new RtMidi class with MIDI output capabilities (API changes)
+- new MidiFileIn class for reading MIDI files
+- revised Filter classes to use std::vectors for coefficients (API changes)
+- revised Messager class (now queues messages for retrieval) (API changes)
+- new abstract parent Effect class for various effects
+- added setT60 function to all reverbs
+- new abstract parent Generator class for various signal sources
+- new abstract parent Function class for tables and various non-linear functions
+- Skini class completely rewritten (simplified) using the C++ STL (API changes)
+- WvOut classes now clip to -1.0 to +1.0 and report out of range
+- new Mutex class
+- turned Nagle algorithm off by default in Socket class
+- error reporting standardized in all classes
+
+v4.1.3: (22 March 2004)
+- bug fix in RtAudio for Windows DirectSound output only support
+
+v4.1.2: (15 March 2004)
+- added Linux JACK support to RtAudio
+- added optional doNormalize argument to WvIn to allow specification of data normalization or not
+- added volume control to demo program and various Tcl scripts
+- added support for dynamic rawwavePath() setting
+- WaveLoop bug fix
+- fixed bug in ADSR::setReleaseTime() method
+- fixed missing initialization of apInput in non-default constructor of DelayA class
+- added time seeding of random number generator to Noise constructor
+- update to the contentsAt() method of Delay class
+- WAV file fixes (8-bit) in WvIn and WvOut classes
+- configure changes
+- updated <iostream> include statements and appended "std::" as necessary throughout for compatibility with gcc 3
 
 v4.1.1: (24 October 2002)
 - bug fix in RtAudio for Macintosh OS X and Windows ASIO duplex operation
@@ -15,7 +193,7 @@ v4.1: (8 October 2002)
 - added Voicer, SingWave, and VoicForm classes
 - improvements/fixes to the banded waveguide instruments
 - demo program now uses Voicer, allowing polyphony
-- demo tcl/tk scripts changed to use SKINI PitchChange instead of PitchBend
+- demo Tcl/Tk scripts changed to use SKINI PitchChange instead of PitchBend
 - demo program response to PitchBend modified to octave up/down
 - several RtAudio fixes and improvements (OS X and Windows ASIO support added)
 - added nextOut() method to Delay classes
@@ -91,7 +269,7 @@ v3.0: (10 October 1999)
 - added RawWvOut class
 - new WvIn class with RawWvIn, SndWvIn, WavWvIn, MatWvIn, and RTWvIn subclasses
 - removed RawWave, RawShot, RawInterp, and RawLoop classes (supplanted by RawWvIn)
-- multi-channel data support in WvIn and WvOut classes using MY_MULTI data type (pointer to MY_FLOAT) and the methods mtick() and mlastOutput()
+- multi-channel data support in WvIn and WvOut classes using MY_MULTI data type (pointer to StkFloat) and the methods mtick() and mlastOutput()
 - now writing to primary buffer under Windoze when allowed by hardware
 - cleaned up Object.h a bit
 - pulled various utility and thread functions out of syntmono.cpp (to aid readability of the code)
@@ -122,4 +300,4 @@ v1.0:
 
 
 v0.8:
-- One of (if not THE) original distributions for SGI, NeXTStep, and basic Win support.  I think this came out in 1996.
+- One of (if not THE) original distributions for SGI, NeXTStep, and basic Win support.  I think this came out in 1996.

doc/SKINI.txt

@@ -10,7 +10,7 @@ for the Synthesis Toolkit in C++ by Perry R. Cook.
 *       A SKINI Haiku.          *
 *********************************
 
-Profound thanks to Dan Trueman, Brad Garton, and
+Profound thanks to Dan trueman, Brad Garton, and
 Gary Scavone for input on this revision.  Thanks
 also to MIDI, the NeXT MusicKit, ZIPI and all
 the creators and modifiers of these for good bases
@@ -85,7 +85,7 @@ upon/from which to build and depart.
     the channel number is scanned as a long int.  Channels could be socket
     numbers, machine IDs, serial numbers, or even unique tags for each
     event in a synthesis.  Other fields might be used, as specified in the
-    SKINI.tbl file.  This is described in more detail later.
+    SKINItbl.h file.  This is described in more detail later.
 
     Fields in a SKINI line are delimited by spaces, commas, or
     tabs.  The SKINI parser only operates on a line at a time,
@@ -109,9 +109,9 @@ upon/from which to build and depart.
 
     All fields other than type, time, and channel are optional, and the
     types and useage of the additional fields is defined in the file
-    SKINI.tbl.
+    SKINItbl.h.
 
-    The other important file used by SKINI is SKINI.msg, which is a
+    The other important file used by SKINI is SKINImsg.h, which is a
     set of #defines to make C code more readable, and to allow reasonably
     quick re-mapping of control numbers, etc..  All of these defined
     symbols are assigned integer values.  For JAVA, the #defines could
@@ -120,20 +120,20 @@ upon/from which to build and depart.
 
 4)  C Files Used To Implement SKINI
 
-    SKINI.cpp is an object which can either open a SKINI file, and
+    Skini.cpp is an object which can either open a SKINI file, and
     successively read and parse lines of text as SKINI strings, or
     accept strings from another object and parse them.  The latter
     functionality would be used by a socket, pipe, or other connection
     receiving SKINI messages a line at a time, usually in real time,
     but not restricted to real time.
 
-    SKINI.msg should be included by anything wanting to use the
-    SKINI.cpp object.  This is not mandatory, but use of the __SK_blah_
+    SKINImsg.h should be included by anything wanting to use the
+    Skini.cpp object.  This is not mandatory, but use of the __SK_blah_
     symbols which are defined in the .msg file will help to ensure
     clarity and consistency when messages are added and changed.
 
-    SKINI.tbl is used only by the SKINI parser object (SKINI.cpp).
-    In the file SKINI.tbl, an array of structures is declared and
+    SKINItbl.h is used only by the SKINI parser object (Skini.cpp).
+    In the file SKINItbl.h, an array of structures is declared and
     assigned values which instruct the parser as to what the message
     types are, and what the fields mean for those message types.
     This table is compiled and linked into applications using SKINI, but
@@ -195,7 +195,7 @@ upon/from which to build and depart.
         A -1 channel can be used as don't care, omni, or other functions
         depending on your needs and taste.
 
-    g)  All remaining fields are specified in the SKINI.tbl file.
+    g)  All remaining fields are specified in the SKINItbl.h file.
         In general, there are maximum two more fields, which are either
         SK_INT (long), SK_DBL (double float), or SK_STR (string).  The
         latter is the mechanism by which more arguments can be specified
@@ -237,10 +237,10 @@ upon/from which to build and depart.
         NoteOff         0.000000 2 71 82
         NoteOff         0.000000 2 79 82
 
-7)  The SKINI.tbl File, How Messages are Parsed:
+7)  The SKINItbl.h File, How Messages are Parsed:
 
-    The SKINI.tbl file contains an array of structures which
-    are accessed by the parser object SKINI.cpp.  The struct is:
+    The SKINItbl.h file contains an array of structures which
+    are accessed by the parser object Skini.cpp.  The struct is:
 
         struct SKINISpec { char messageString[32];
                    long  type;
@@ -276,7 +276,7 @@ upon/from which to build and depart.
                            something else stored in the SK_STR field, or
                            as a new type of multi-line message.
 
-    Here's a couple of lines from the SKINI.tbl file
+    Here's a couple of lines from the SKINItbl.h file
 
  {"NoteOff"          ,        __SK_NoteOff_,               SK_DBL,  SK_DBL},
  {"NoteOn"           ,         __SK_NoteOn_,               SK_DBL,  SK_DBL},
@@ -290,7 +290,7 @@ upon/from which to build and depart.
     The first three are basic MIDI messages.  The first two would cause the
     parser, after recognizing a match of the string "NoteOff" or "NoteOn",
     to set the message type to 128 or 144 (__SK_NoteOff_ and __SK_NoteOn_
-    are #defined in the file SKINI.msg to be the MIDI byte value, without
+    are #defined in the file SKINImsg.h to be the MIDI byte value, without
     channel, of the actual MIDI messages for NoteOn and NoteOff).  The parser
     would then set the time or delta time (this is always done and is
     therefore not described in the SKINI Message Struct).  The next two
@@ -322,70 +322,67 @@ upon/from which to build and depart.
 
 8)  Objects using SKINI
 
-    Here's a simple example of code which uses the SKINI object
+    Here's a simple example of code which uses the Skini object
     to read a SKINI file and control a single instrument.
 
+        Skini score;
+        Skini::Message message;
         instrument = new Mandolin(50.0);
-        score = new SKINI(argv[1]);
-        while(score->getType() > 0) {
-            tempDouble = score->getDelta();
-            if (tempDouble < 0)     {
-                tempDouble = - tempDouble;
-                tempDouble = tempDouble - output.getTime();
-                if (tempDouble < 0) {
-                   printf("Bad News Here!!!  Backward Absolute Time Required.\n");
-                   tempDouble = 0.0;
-                }
+        score.setFile( argv[1] );
+        while ( score.nextMessage( message ) != 0 ) {
+          tempDouble = message.time;
+          if (tempDouble < 0)     {
+            tempDouble = - tempDouble;
+            tempDouble = tempDouble - output.getTime();
+            if (tempDouble < 0) {
+              printf("Bad News Here!!!  Backward Absolute Time Required.\n");
+              tempDouble = 0.0;
             }
-            tempLong = (long) (tempDouble * Stk::sampleRate());
-            for (i=0;i<tempLong;i++)   {
-                output.tick(instrument->tick());
+          }
+          tempLong = (long) ( tempDouble * Stk::sampleRate() );
+          for ( i=0; i<tempLong; i++ ) {
+            output.tick( instrument->tick() );
+          }
+
+          tempDouble3 = message.floatValues[1] * NORM_MIDI;
+          if ( message.type == __SK_NoteOn_ ) {
+            if ( tempDouble3 == 0.0 ) {
+              tempDouble3 = 0.5;
+              instrument->noteOff( tempDouble3 );
             }
-            tempDouble3 = score->getByteThree();
-            if (score->getType()== __SK_NoteOn_ )        {
-                tempDouble3 *= NORM_MIDI;
-                if (score->getByteThree() == 0)  {
-                    tempDouble3 = 0.5;
-                    instrument->noteOff(tempDouble3);
-                }
-                else {
-                    tempLong = (int) score->getByteTwo();
-                    tempDouble2 = Midi2Pitch[tempLong];
-                    instrument->noteOn(tempDouble2,tempDouble3);
-                }
+            else {
+              tempLong = message.intValues[0];
+              tempDouble2 = Midi2Pitch[tempLong];
+              instrument->noteOn( tempDouble2, tempDouble3 );
             }
-            else if (score->getType() == __SK_NoteOff_) {
-                tempDouble3 *= NORM_MIDI;
-                instrument->noteOff(tempDouble3);
-            }
-            else if (score->getType() == __SK_ControlChange_)        {
-                tempLong = score->getByteTwoInt();
-                instrument->controlChange(tempLong,temp3.0);
-            }
-            score->nextMessage();
+          }
+          else if ( message.type == __SK_NoteOff_ ) {
+            instrument->noteOff( tempDouble3 );
+          }
+          else if ( message.type == __SK_ControlChange_ ) {
+            tempLong = message.intValues[0];
+            instrument->controlChange( tempLong, tempDouble3 );
+          }
         }
 
-    When the score (SKINI object) object is created from the
-    filename in argv[1], the first valid command line is read
-    from the file and parsed.
+    When a SKINI score is passed to a Skini object using the
+    Skini::setFile() function, valid messages are read from
+    the file and returned using the Skini::nextMessage() function.
 
-    The score->getType() retrieves the messageType.  If this is
-    -1, there are no more valid messages in the file and the
-    synthesis loop terminates.  Otherwise, the message type is
-    returned.
+    A Skini::Message structure contains all the information parsed
+    from a single SKINI message.  A returned message type of zero
+    indicates either an invalid message or the end of a scorefile.
 
-    getDelta() retrieves the deltaTime until the current message
-    should occur.  If this is greater than 0, synthesis occurs
-    until the deltaTime has elapsed.  If deltaTime is less than
-    zero, the time is interpreted as absolute time and the output
-    device is queried as to what time it is now.  That is used to
-    form a deltaTime, and if it's positive we synthesize.  If
-    it's negative, we print an error and pretend this never
-    happened and we hang around hoping to eventually catch up.
+    The "time" member of a Skini::Message is the deltaTime until the
+    current message should occur.  If this is greater than 0,
+    synthesis occurs until the deltaTime has elapsed.  If deltaTime is
+    less than zero, the time is interpreted as absolute time and the
+    output device is queried as to what time it is now.  That is used
+    to form a deltaTime, and if it's positive we synthesize.  If it's
+    negative, we print an error, pretend this never happened and we
+    hang around hoping to eventually catch up.
 
     The rest of the code sorts out message types NoteOn, NoteOff
     (including NoteOn with velocity 0), and ControlChange.  The
     code implicitly takes into account the integer type of the
     control number, but all other data is treated as double float.
-
-    The last line reads and parses the next message in the file.

doc/doxygen/compile.txt

@@ -1,13 +1,26 @@
 /*! \page compile Compiling
 
-The Synthesis ToolKit can be used in a variety of ways, depending on your particular needs.  Some people choose the classes they need for a particular project and copy those to their working directory.  Others create <TT>Makefiles</TT> which compile project-specific class objects from common <TT>src</TT> and <TT>include</TT> directories.  And still others like to compile and link to a common library of object files.  STK was not designed with one particular style of use in mind.
+The Synthesis ToolKit can be used in a variety of ways, depending on your particular needs.  Some people choose the classes they need for a particular project and copy those to their working directory.  Others create <TT>Makefiles</TT> that compile project-specific class objects from common <TT>src</TT> and <TT>include</TT> directories.  And still others like to compile and link to a common library of object files.  STK was not designed with one particular style of use in mind.
 
+For specifics on creating Windows applications, see README-Win.txt.
 
 \section rtvsnonrt "Realtime" vs. "Non-Realtime"
 
-Most of the Synthesis ToolKit classes are platform independent.  That means that they should compile on any reasonably current C++ compiler.  The functionality needed for realtime audio and MIDI input/output, as well as realtime control message acquistion, is inherently platform and operating-system (OS) <I>dependent</I>.  STK classes which require specific platform/OS support include RtAudio, RtWvOut, RtWvIn, RtDuplex, RtMidi, TcpWvIn, TcpWvOut, Socket, and Thread.  These classes currently can only be compiled on Linux, Irix, Macintosh OS X, and Windows systems using the <TT>__LINUX_OSS__</TT>, <TT>__LINUX_ALSA__</TT>, <TT>__IRIX_AL__</TT>, <TT>__MACOSX_CORE__</TT>, <TT>__WINDOWS_DS__</TT>, or <TT>__WINDOWS_ASIO__</TT> preprocessor definitions.
+Most of the Synthesis ToolKit classes are platform independent.  That
+means that they should compile on any reasonably current C++ compiler.
+The functionality needed for realtime audio and MIDI input/output, as
+well as realtime control message acquistion, is inherently platform
+and operating-system (OS) <I>dependent</I>.  STK classes that require
+specific platform/OS support include RtAudio, RtWvOut, RtWvIn,
+RtDuplex, RtMidi, InetWvIn, InetWvOut, Socket, UdpSocket, TcpServer,
+TcpClient, Thread, and Mutex.  These classes currently can only be
+compiled on Linux, Macintosh OS X, and Windows systems.
 
-Without the "realtime" classes, it is still possible to read SKINI scorefiles for control input and to read and write to/from a variety of audio file formats (WAV, SND, AIFF, MAT-file, and RAW).  If compiling for a "little-endian" host processor, the <TT>__LITTLE_ENDIAN__</TT> preprocessor definition should be provided.
+Without the "realtime" classes, it is still possible to read SKINI
+scorefiles for control input and to read and write to/from a variety
+of audio file formats (WAV, SND, AIFF, MAT-file, and RAW).  If
+compiling for a "little-endian" host processor, the
+<TT>__LITTLE_ENDIAN__</TT> preprocessor definition should be provided.
 
 
 \section unix Unix Systems:
@@ -25,47 +38,54 @@ STK compiles with realtime support on the following flavors of the Unix operatin
 <TR>
   <TD>Linux</TD>
   <TD>ALSA</TD>
-  <TD>__LINUX_ALSA__, __LITTLE_ENDIAN__</TD>
+  <TD>__LINUX_ALSA__, \__LITTLE_ENDIAN__</TD>
   <TD><TT>asound, pthread</TT></TD>
 </TR>
 <TR>
   <TD>Linux</TD>
-  <TD>OSS</TD>
-  <TD>__LINUX_OSS__, __LITTLE_ENDIAN__</TD>
-  <TD><TT>pthread</TT></TD>
+  <TD>OSS (version 4.0 only, use ALSA for MIDI support)</TD>
+  <TD>__LINUX_OSS__, \__LINUX_ALSA__, \__LITTLE_ENDIAN__</TD>
+  <TD><TT>asound, pthread</TT></TD>
+</TR>
+<TR>
+  <TD>Linux and Macintosh OS-X</TD>
+  <TD>Jack</TD>
+  <TD>__UNIX_JACK__, \__LITTLE_ENDIAN__</TD>
+  <TD><TT>asound, pthread, jack</TT></TD>
 </TR>
 <TR>
   <TD>Macintosh OS X</TD>
   <TD>CoreAudio</TD>
   <TD>__MACOSX_CORE__</TD>
-  <TD><TT>pthread, stdc++, CoreAudio, CoreMIDI, CoreFoundation</TT></TD>
-</TR>
-<TR>
-  <TD>Irix</TD>
-  <TD>AL</TD>
-  <TD>__IRIX_AL__</TD>
-  <TD><TT>audio, pthread</TT></TD>
+  <TD><TT>pthread, CoreAudio, CoreMIDI, CoreFoundation</TT></TD>
 </TR>
 </TABLE>
 </CENTER>
 
 The available C++ compilers on any of these systems can vary.
 
-One approach in using STK is to simply copy the class files needed for a particular program into a project directory.  Taking the <TT>sineosc.cpp</TT> example from the previous tutorial chapter, it would be necessary to set up a directory that includes the files <TT>sineosc.cpp</TT>, the rawwave file <TT>sinewave.raw</TT> in a subdirectory called <TT>rawwaves</TT>, and the header and source files for the classes Stk, WvIn, WaveLoop, and WvOut.  The program could then be compiled on a Linux system using the GNU g++ compiler as follows:
-\code
-g++ -Wall -D__LITTLE_ENDIAN__ -o sineosc Stk.cpp WvIn.cpp WaveLoop.cpp WvOut.cpp sineosc.cpp
-\endcode
+One approach in using STK is to simply copy the class files needed for
+a particular program into a project directory.  Taking the
+<TT>sineosc.cpp</TT> example from the previous tutorial chapter, it
+would be necessary to set up a directory that includes the files
+<TT>sineosc.cpp</TT>, the rawwave file <TT>sinewave.raw</TT> in a
+subdirectory called <TT>rawwaves</TT>, and the header and source files
+for the classes Stk, FileRead, FileWrite, FileWvIn, FileLoop, and
+FileWvOut.  The program could then be compiled on a little-endian
+system, such as a PC running Linux, using the GNU g++ compiler as
+follows:
+\code g++ -Wall -D__LITTLE_ENDIAN__ -o sineosc Stk.cpp FileRead.cpp FileWrite.cpp FileWvIn.cpp FileLoop.cpp FileWvOut.cpp sineosc.cpp \endcode
 
 Note that the <TT>sineosc.cpp</TT> example does not make use of realtime audio or MIDI input/output classes.  For programs using any of the STK realtime classes mentioned above, it is necessary to specify an audio/MIDI API preprocessor definition and link with the appropriate libraries or frameworks.
 
-When working with a number of different projects that make use of ToolKit classes, the above approach can become cumbersome (especially when trying to synchronize with new STK releases).  The example STK projects (e.g., demo, effects, ...) contain <TT>Makefiles</TT> (built by the configure script) which compile project-specific class objects from the distribution <TT>src</TT> and <TT>include</TT> directories.  This approach makes it relatively easy when upgrading to a new STK release (by making path substitutions in the <TT>Makefile</TT> or by moving the projects to a similar relative path within the new STK source tree).  A <TT>Makefile</TT> of this sort is provided in the <TT>projects/examples</TT> directory for compiling all the tutorial programs, as well as other example programs.  To compile the <TT>sineosc.cpp</TT> program, for example, one need only type <TT>make sineosc</TT> from within the <TT>projects/examples</TT> directory.
+When working with a number of different projects that make use of ToolKit classes, the above approach can become cumbersome (especially when trying to synchronize with new STK releases).  Most of the STK projects (e.g., demo, effects, ...) contain <TT>Makefiles</TT> (built by the configure script) that compile project-specific class objects from the distribution <TT>src</TT> and <TT>include</TT> directories.  This approach makes it relatively easy when upgrading to a new STK release (by making path substitutions in the <TT>Makefile</TT> or by moving the projects to a similar relative path within the new STK source tree).  A <TT>Makefile</TT> is provided in the <TT>projects/examples</TT> directory for compiling all the tutorial programs, as well as other example programs.  To compile the <TT>sineosc.cpp</TT> program, for example, one need only type <TT>make sineosc</TT> from within the <TT>projects/examples</TT> directory.
 
 
 \subsection library Library Use:
 
-The STK distribution provides a <TT>Makefile</TT> that can be used on Unix systems to build a static library.  After unpacking the distribution (<TT>tar -xzf stk-4.x.tar.gz</TT>), run the configure script by typing <TT>./configure</TT> from the top level distribution directory (see the INSTALL file in the same directory for more information).  Then from within the <TT>src</TT> directory, type <TT>make</TT>.  After a successful build, you may wish to move the library (<TT>libstk.a</TT>) and the contents of the <TT>include</TT> directory to standard library and include search paths on your system.  For example, the linux RPM distribution of STK puts the library in <TT>/usr/lib/</TT> and the STK header files in <TT>/usr/include/stk/</TT>.
+The STK distribution provides a <TT>Makefile</TT> that can be used on Unix systems to build a static library.  After unpacking the distribution (<TT>tar -xzf stk-4.x.x.tar.gz</TT>), run the configure script by typing <TT>./configure</TT> from the top level distribution directory (see the INSTALL file in the same directory for more information).  Then from within the <TT>src</TT> directory, type <TT>make</TT>.  After a successful build, you may wish to move the library (<TT>libstk.a</TT>) and the contents of the <TT>include</TT> directory to standard library and include search paths on your system.  For example, the linux RPM distribution of STK puts the library in <TT>/usr/lib/</TT> and the STK header files in <TT>/usr/include/stk/</TT>.
 
-Assuming the library is located in a standard search path and the header files are located in <TT>/usr/include/stk/</TT>, the <TT>sineosc.cpp</TT> example from the previous tutorial chapter can be compiled on a Linux system using the GNU g++ compiler as follows:
+Assuming the library is located in a standard search path and the header files are located in <TT>/usr/include/stk/</TT>, the <TT>sineosc.cpp</TT> example from the previous tutorial chapter can be compiled on a little-endian system using the GNU g++ compiler as follows:
 
 \code
 g++ -Wall -D__LITTLE_ENDIAN__ -I/usr/include/stk -o sineosc sineosc.cpp -lstk
@@ -74,8 +94,8 @@ g++ -Wall -D__LITTLE_ENDIAN__ -I/usr/include/stk -o sineosc sineosc.cpp -lstk
 With the header files in a standard search path, it is possible to modify the <TT>\#include</TT> statements in the <TT>sineosc.cpp</TT> program as follows:
 
 \code
-#include "stk/WaveLoop.h"
-#include "stk/WvOut.h"
+#include "stk/FileLoop.h"
+#include "stk/FileWvOut.h"
 \endcode
 
 and then compile without an explicit include path argument to the compiler:
@@ -85,15 +105,5 @@ g++ -Wall -D__LITTLE_ENDIAN__ -o sineosc sineosc.cpp -lstk
 \endcode
 
 
-\section compileWin Windows:
-
-STK has been tested on Windows platforms using the Visual C++ compiler only.  It is assumed here that you're familiar with Visual C++ and its particular idiosyncrasies.
-
-The approach when using Visual C++ is to build a project which includes the necessary ToolKit files from the distribution <TT>src</TT> and <TT>include</TT> directories.  For the example program from the previous tutorial chapter, create a VC++ console application project, add the Stk, WvIn, WaveLoop, and WvOut class files, as well as <TT>sineosc.cpp</TT>, and make sure the <TT>sinewave.raw</TT> file is in the subdirectory <TT>rawwaves</TT>.
-
-For programs using any of the STK realtime classes mentioned above, it is necessary to link with the DirectSound (<TT>dsound.lib</TT>), <TT>winmm.lib</TT>, and <TT>Wsock32.lib</TT> libraries, select the multithreaded library, and provide the <TT>__LITTLE_ENDIAN__</TT> and <TT>__WINDOWS_DS__</TT> preprocessor definitions.
-
-For Steinberg ASIO support, use the <TT>__WINDOWS_ASIO__</TT> preprocessor definition, include all the files in the <TT>src/asio/</TT> directory (i.e., <TT>asio.h,cpp</TT>, <TT>asiodrivers.h,cpp</TT>, ...), and link with the <TT>winmm.lib</TT>, and <TT>Wsock32.lib</TT> libraries.
-
-[<A HREF="realtime.html">Next tutorial</A>] &nbsp; [<A HREF="tutorial.html">Main tutorial page</A>]
+[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="filtering.html">Next tutorial</A>]
 */

doc/doxygen/control.txt

@@ -17,114 +17,38 @@ StringDetune    0.100000  2  12.0
 NoteOff         1.000000  2  69.0  64.0
 \endcode
 
-MIDI messages (with the exception of Sysex) are easily represented within the SKINI protocol.
+MIDI messages are easily represented within the SKINI protocol.
 
-The class Messager can be used to acquire and parse MIDI messages from a MIDI device and SKINI messages from STDIN and socket connections.  Many of the example programs included with the ToolKit distribution use a Messager instance to accept control input from the accompanying tcl/tk graphical user interfaces, from external MIDI devices, or from SKINI scorefiles.
+The class stk::Messager can be used to acquire and parse MIDI messages
+from a MIDI device and SKINI messages from STDIN and socket
+connections.  Incoming messages are acquired asynchronously and saved
+to an internal message queue of stk::Skini::Message types (MIDI
+messages are converted to the stk::Skini:Message format).  The user
+then uses the stk::Messager:popMessage() function to retrieve incoming
+control messages.  This function does not block, instead returning a
+message type of zero when no more messages are in the queue.  Many of
+the example programs included with the ToolKit distribution use a
+stk::Messager instance to accept control input from the accompanying Tcl/Tk
+graphical user interfaces, from external MIDI devices, or from SKINI
+scorefiles.
 
-In the following example, we'll modify the <TT>bethree.cpp</TT> program from the previous tutorial chapter and incorporate a Messager class to allow control via a SKINI scorefile.
+In the following example, we'll modify the <TT>bethree.cpp</TT> program from the previous tutorial chapter and incorporate a stk::Messager class to allow control via SKINI messages read from a SKINI file.
+
+\include controlbee.cpp
+
+A realtime control message will usually have a delta time of zero, in which case it is processed as soon as possible.  Non-realtime messages, normally from a scorefile, will usually have non-zero delta times.  The scheme used in this example is designed to work for both scorefile and realtime input types.  When no message is available from the queue, the instrument is "ticked" for DELTA_CONTROL_TICKS and then the queue is checked again.  The value of DELTA_CONTROL_TICKS roughly defines the program "control rate" in a realtime context, though multiple available messages in the queue are processed in immediate succession when their delta time values are zero.
+
+The \c processMessage() function centralizes the handling of control messages.  Other control update schemes can be implemented, perhaps using a separate thread or in the \c main() function, and this function should work in any context.
+
+Assuming the program is compiled as <TT>controlbee</TT> and the SKINI scorefile <A HREF="tutorial/bookert.ski"><TT>bookert.ski</TT></A> is in the <TT>scores</TT> directory, the program can be run as:
 
 \code
-// controlbee.cpp
-
-#include "BeeThree.h"
-#include "RtWvOut.h"
-#include "Messager.h"
-#include "SKINI.msg"
-#include <math.h>
-
-int main()
-{
-  // Set the global sample rate before creating class instances.
-  Stk::setSampleRate( 44100.0 );
-
-  Instrmnt *instrument = 0;
-  RtWvOut *output = 0;
-  Messager *messager = 0;
-  bool done = FALSE;
-
-  try {
-    // Define and load the BeeThree instrument
-    instrument = new BeeThree();
-
-    // Define and open the default realtime output device for one-channel playback
-    output = new RtWvOut(1);
-  }
-  catch (StkError &) {
-    goto cleanup;
-  }
-
-  try {
-    // Create a Messager instance to read from a redirected SKINI scorefile.
-    messager = new Messager();
-  }
-  catch (StkError &) {
-    goto cleanup;
-  }
-
-  // Play the instrument until the end of the scorefile.
-  int i, nTicks, type;
-  MY_FLOAT byte2, byte3, frequency;
-  while (!done) {
-
-    // Look for new messages and return a delta time (in samples).
-    type = messager->nextMessage();
-    if (type < 0)
-      done = TRUE;
-
-    nTicks = messager->getDelta();
-    try {
-      for ( i=0; i<nTicks; i++ )
-        output->tick( instrument->tick() );
-    }
-    catch (StkError &) {
-      goto cleanup;
-    }
-
-    if ( type > 0 ) {
-      // Process the new control message.
-      byte2 = messager->getByteTwo();
-      byte3 = messager->getByteThree();
-
-      switch(type) {
-
-      case __SK_NoteOn_:
-        frequency = (MY_FLOAT) 220.0 * pow( 2.0, (byte2 - 57.0) / 12.0 );
-        instrument->noteOn( frequency, byte3 * ONE_OVER_128 );
-        break;
-
-      case __SK_NoteOff_:
-        instrument->noteOff( byte3 * ONE_OVER_128 );
-        break;
-
-      case __SK_ControlChange_:
-        instrument->controlChange( (int) byte2, byte3 );
-        break;
-
-      case __SK_AfterTouch_:
-        instrument->controlChange( 128, byte2 );
-        break;
-      }
-    }
-  }
-
- cleanup:
-  delete instrument;
-  delete output;
-  delete messager;
-
-  return 0;
-}
-\endcode
-
-Assuming the program is compiled as <TT>controlbee</TT> and the SKINI scorefile <A HREF="tutorial/bookert.ski"><TT>bookert.ski</TT></A> is in the <TT>scores</TT> directory, the scorefile could be redirected to the program as:
-
-\code
-controlbee < scores/bookert.ski
+controlbee scores/bookert.ski
 \endcode
 
 Only a few basic SKINI message type case statements are included in this example.  It is easy to extend the program to support a much more elaborate set of instrument control parameters.
 
-This example could also be easily extended to accept "realtime" control input messages via STDIN, socket, or MIDI connections.  The Messager class constructor takes an optional argument consisting of a bitmask of the following options: <TT>STK_PIPE</TT>, <TT>STK_SOCKET</TT>, and/or <TT>STK_MIDI</TT>.
+This example could also be easily extended to accept "realtime" control input messages via pipe, socket or MIDI connections.  The stk::Messager class provides stk::Messager::startStdInput(), stk::Messager::startSocketInput(), and stk::Messager::startMidiInput() functions for this purpose.
 
-[<A HREF="multichannel.html">Next tutorial</A>] &nbsp; [<A HREF="tutorial.html">Main tutorial page</A>]
+[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="multichannel.html">Next tutorial</A>]
 */

doc/doxygen/crealtime.txt

@@ -0,0 +1,74 @@
+/*! \page crealtime Realtime Audio (callback)
+
+An alternative scheme for audio input/output is to define a specific
+function in which audio computations are performed and to let the
+audio system call this function when more input/output data can be
+accepted by the hardware (referred to as a callback scheme).  In this
+section, we show how the previous <TT>rtsine.cpp</TT> program can be
+modified to work in a callback scenario.  There is no "single-sample"
+interface for this functionality.  The callback function will be
+invoked automatically by the audio system controller (RtAudio) when
+new data is needed and it is necessary to compute a full audio buffer
+of samples at that time (see \ref callback for further information).
+
+The previous section described the use of the stk::RtWvOut class for
+realtime audio output. The stk::RtWvOut::tick() function writes data to a
+large ring-buffer, from which data is periodically written to the
+computer's audio hardware via an underlying callback routine.
+
+\include crtsine.cpp
+
+The sinusoidal oscillator is created as before.  The instantiation of
+RtAudio requires quite a few more parameters, including output/input
+device and channel specifiers, the data format, and the desired buffer
+length (in frames).  In this example, we request a single output
+channel using the default output device, zero channels of input, the
+RtAudio data format which corresponds to an <tt>StkFloat</tt>, and the
+RT_BUFFER_SIZE defined in Stk.h.  The \c bufferFrames argument is an
+API-dependent buffering parameter (see RtAudio for further
+information).
+
+We also provide the audio system controller with a pointer to our
+callback function and an optional pointer to data that will be made
+available in the callback.  In this example, we need to pass only the
+pointer to the oscillator.  In more complex programs, it is typically
+necessary to put all shared data in a <tt>struct</tt> (see the next
+tutorial program for an example) or make use of global variables.
+
+Our callback routine is the \c tick() function.  Function arguments
+include pointers to the audio input and output data buffers, the
+buffer size (in frames), a stream time argument, a status argument to
+test for over/underruns, and the data pointer passed in the
+openStream() function (if it exists).  It is necessary to cast these
+pointers to their corresponding data types before use.  Our tick()
+routine simply "ticks" the oscillator for \c nBufferFrames counts and
+writes the result into the audio data buffer before returning.
+
+The \c main() function blocks at the std::cin.get() call until the
+user hits the "enter" key, after which the audio controller is shut
+down and program execution ends.
+
+\section callback Blocking vs. Callbacks
+
+Prior to version 4.2.0, all STK example projects and programs used
+blocking audio input/output functionality (typically with the RtWvIn,
+RtWvOut, or RtDuplex classes).  In many instances, a blocking scheme
+results in a clearer and more straight-forward program structure.
+Within a graphical user interface (GUI) programming context, however,
+callback routines are often more natural.
+
+In order to allow all STK programs to function with equal proficiency
+on all supported computer platforms, a decision was made to modify the
+example projects to use audio callback routines.  The result is a more
+complicated code structure, which is unfortunate given that we
+generally strive to make STK code as clear as possible for educational
+purposes.  This was especially an issue with the demo program because
+it is designed to function in both realtime and non-realtime contexts.
+The use of global variables has been avoided by defining data
+structures to hold all variables that must be accessible to the
+callback routine and other functions.  Alternative schemes for making
+control updates could be designed depending on particular program
+needs and constraints.
+
+[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="instruments.html">Next tutorial</A>]
+*/

doc/doxygen/download.txt

@@ -1,149 +1,288 @@
 /*! \page download Download and Release Notes
 
-<B>Version 4.1.1, 24 October 2002</B><P>
-<UL>
-<LI><A HREF="http://www-ccrma.stanford.edu/software/stk/release/stk-4.1.1.tar.gz">Source distribution</A> (1.2 MB tar/gzipped)</LI>
-<LI><A HREF="http://www-ccrma.stanford.edu/software/stk/release/stk-4.1.1.binaries.tar.gz">Source with precompiled Windows binaries</A> (2.0 MB tar/gzipped)</LI>
-<LI><A HREF="http://www-ccrma.stanford.edu/software/stk/release/stk-4.1.1-1.i386.rpm">Linux RPM</A> (1.2 MB) <B>Note: Library and Makefiles built for ALSA, though the rpm can be rebuilt to use OSS</B></LI>
-<LI><A HREF="http://www-ccrma.stanford.edu/software/stk/release/stkmanual.pdf">STK Manual (PDF)</A> (1.62 MB) <B>Note: HTML version already in /doc/html/ directory of distribution</B></LI>
-</UL>
+\section down Download Version 4.6.2 (17 November 2021):
 
+- <A HREF="http://ccrma.stanford.edu/software/stk/release/stk-4.6.2.tar.gz">Source distribution</A>
 
 \section notes Release Notes:
+\subsection v4dot6dot2 Version 4.6.2
+- see github site for complete details (github.com/thestk/stk)
+- bug fixes in LentPitShift and Granulate classes
+- Makefile fixes
+- miscellaneous bug fixes
 
-\subsection v4dot1dot3 Version 4.1.1
+\subsection v4dot6dot1 Version 4.6.1
+- see github site for complete details (github.com/thestk/stk)
+- various documentation updates
+- new Recorder (flute a la Verge) class (thanks to Mathias Bredholt)
+- updated Modulate class to allow noise rate control
+- new VS2017 project files
+- fix in FileLoop::getSize() to return file size (not chunk size)
 
-<UL>
-<LI>Bug fix in RtAudio for Macintosh OS X and Windows ASIO duplex operation.</LI>
-<LI>Windows ASIO fix in Stk.h.</LI>
-<LI>Documentation updates.</LI>
-<LI>Expanded tutorial.</LI>
-<LI>Fixed RtDuplex omission in src Makefile.</LI>
-</UL>
+\subsection v4dot6dot0 Version 4.6.0
+- see github site for complete details (github.com/thestk/stk)
+- various build system updates
+- fixes in FileWvIn / FileLoop for normalisation and scaling, as well as file opening
+- bug fix for MAT-files in FileWrite
+- bug fix in MidiFileIn.cpp for timing and time-code formats
+- updated versions of RtAudio and RtMidi
+
+\subsection v4dot5dot1 Version 4.5.1
+- fix for FileWvIn / FileLoop classes to avoid keeping files open if not necessary
+- miscellaneous bug fixes, documented on GitHub site (github.com/thestk/stk)
+- update to play.cpp example to play mono files as stereo
+- bug fix in DelayL::setDelay() function
+- miscellanous build bug fixes
+
+\subsection v4dot5dot0 Version 4.5.0
+- Updated versions of RtAudio and RtMidi, with associated renaming of RtError class to either RtAudioError or RtMidiError
+- New iOS project files (thanks to Ariel Elkin)
+- Bug fix in FreeVerb that could cause crackling for stereo input
+- Various bug fixes and updates to minimize compiler warnings
+- ADSR fix for decay/release time calculations
+- Various updates to build system
+
+\subsection v4dot4dot4 Version 4.4.4
+- New FreeVerb class (thanks to Greg Burlet)
+- New Guitar class
+- New electric guitar project
+- Updated versions of RtAudio and RtMidi
+- Cleaned / revised Shakers class
+- Bug fix in LentPitShift
+- Bug fix in Echo constructor
+- Bug fix in FileWvIn (file size when chunking)
+- Bug fix in StkFrames copy constructor
+
+\subsection v4dot4dot3 Version 4.4.3
+- Changed SINT24 to be lower 3 bytes of 32-bit word.
+- Bug fixes to vectorized tick functions in Effects classes.
+- Updated versions of RtAudio and RtMidi.
+- Bug fixes in ADSR and Envelope classes.
+- Updates to the internal argument checking and reporting scheme.
+- Updates to Bowed class (thanks to Esteban Maestre!).
+- Fixes for 24-bit support in FileRead and FileWrite.
+- Added WAVE_FORMAT_EXTENSIBLE support in FileWrite.
+- Added sample rate variable reading and writing for MAT-files in FileRead and FileWrite.
+
+\subsection v4dot4dot2 Version 4.4.2
+- Added various header file includes for newer compilers.
+- Updates to RtAudio and RtMidi.
+- New LentPitShift class (thanks to Francois Germain).
+- Bug fixes in Voicer class (thanks Richard Dobson!).
+- Added Makefile.in to compile library and all projects, as well as clean and distclean.
+
+\subsection v4dot4dot1 Version 4.4.1
+- Added multi-channel/frame tick() virtual function to WvIn and WvOut abstract base classes (required update to RtWvOut class).
+- Updated configure script to select g++ compiler by default.
+- In demo.cpp: removed voicer grouping for messages, fixing polyphony when messages are on the same MIDI/SKINI channel.
+- Updates to RtAudio and RtMidi.
+
+\subsection v4dot4dot0 Version 4.4.0
+- All classes embedded in the "stk" namespace (except RtAudio, RtMidi, and RtError).
+- Class WaveLoop renamed FileLoop.
+- Significant efficiency improvements via code restructuring and inlining.
+- Some class source (.cpp) files deleted as part of inlining (Generator, Filter, Function, WvIn, WvOut, Effect, Instrmnt, BowTable, ReedTable, JetTable, Vector3D).
+- Updates to RtAudio and RtMidi.
+- Previous "tickFrame()" functions renamed "tick" for more consistent API.
+- More consistent and scalable approach to multichannel data and computations.
+- Multichannel support added to Granulate class.
+- Filter class made abstract.  New Iir and Fir classes made for non-order-specific filtering.
+- New TapDelay class.
+- SubNoise class deleted (same as sub-sampled "ticking" of Noise class).
+
+\subsection v4dot3dot1 Version 4.3.1
+- Further headerless file support in FileRead.
+- Bug fix in RtWvOut.cpp.
+- Added configure support for MinGW.
+- Updates to RtAudio and RtMidi for MinGW.
+- Changes to channel assignment in demo.cpp.
+
+\subsection v4dot3dot0 Version 4.3.0
+- An official MIT-like license.
+- New functionality to automatically update class data when the STK sample rate changes (partly implemented).
+- Updates for new RtAudio version 4.0.
+- Removed RtDuplex class, users should use RtAudio directly with a callback function.
+- Bug fix in interpolate() function in Stk.h for non-interleaved data.
+- Fixes / improvements to the Granulate class.
+- Fix in Whistle when doing animation.
+- Fixes in BlitSquare for frequency, harmonics, and dc offset.
+- Updates to Makefiles for non-realtime compile.
+- Fix in demo.cpp for voice channel assignment.
+- Updated versions of RtMidi and RtAudio.
+- Updated ASIO files for MinGW compiler.
+- New FAQ in documentation.
+- MAT-file bug fix in FileRead class.
+
+\subsection v4dot2dot1 Version 4.2.1
+- Greatly expanded StkFrames functionality (including interpolation and indexing by channel/frame).
+- New Blit, BlitSaw, and BlitSquare bandlimited waveform classes (thanks to Robin Davies!).
+- New Granulate granular synthesis class.
+- Removed Table class ... all functionality (including interpolation) now in StkFrames and FileRead classes.
+- Revised Socket class (now abstract) and added TcpServer, TcpClient, and UdpSocket subclasses.
+- Added Stk::showWarnings() and Stk::printErrors() functions to dis/enable warning and error printouts.
+- Extracted file I/O functionality to FileRead and FileWrite classes.
+- Revised WvIn / WvOut class structure (WvIn / WvOut now abstract and file I/O functionality in new FileWvIn / FileWvOut subclasses).
+- New SineWave class which calculates its own static table of variable length (no rawwave dependency).
+- New sinewave.raw file of length 1024 samples (used to be 256).
+- TcpWvIn and TcpWvOut renamed InetWvIn and InetWvOut, with added support for UDP sockets.
+- Fixed bug in WvOut tickFrame( const  StkFrames &frames ) function.
+- Fixed bug in demo.cpp when writing output soundfiles without realtime output.
+- Added "binary" open flag to MidiFileIn class for Windows.
+- Fixed oversized MAT-file header in WvOut.cpp
+- Fixed case statement bug in MidiFileIn.cpp for sysex.
+- Added missing getDelay() function to DelayA.cpp.
+- Fixed modDepth omission in Chorus.cpp.
+- Fixed DC blocker initialization bug in Flute.cpp.
+- Changed Filter class behavior so no default clearing of state when changing coefficients.
+- Fixes to RtAudio, especially for Windows DirectSound and ASIO (thanks to Robin Davies).
+
+\subsection v4dot2dot0 Version 4.2.0
+- Simultaneous multiple audio APIs supported at compile time.
+- Various changes to better conform to standard C++ programming practices.
+- Fixed hidden overloaded virtual functions.
+- New Asymp exponential envelope class.
+- <tt>MY_FLOAT</tt> type converted to <tt>StkFloat</tt> and changed throughout (use \c treesed utility to search/replace in old files).
+- Most example programs rewritten to use an audio callback paradigm (which works better in OS-X).
+- New StkFrames class for vectorized multichannel data and associated new tick() functions making use of StkFrames.
+- New RtMidi class with MIDI output capabilities (API changes).
+- New MidiFileIn class for reading MIDI files.
+- Revised Filter classes to use std::vectors for coefficients (API changes).
+- Revised Messager class (API changes).
+- New abstract parent Effect class for various effects.
+- New abstract parent Generator class for various signal sources.
+- New abstract parent Function class for tables and various non-linear functions.
+- Skini class completely rewritten (simplified) using the C++ STL (API changes).
+- WvOut classes now clip to -1.0 to +1.0 and report out of range.
+- New Mutex class.
+- Turned Nagle algorithm off by default in Socket class.
+- Error reporting standardized in all classes.
+
+\subsection v4dot1dot3 Version 4.1.3
+- Bug fix in RtAudio for Windows DirectSound output only support
+
+\subsection v4dot1dot2 Version 4.1.2
+- Added Linux JACK support to RtAudio.
+- Added optional doNormalize argument to WvIn to allow specification of data normalization or not.
+- Added volume control to demo program and various Tcl scripts.
+- Added support for dynamic rawwavePath() setting.
+- WaveLoop bug fix.
+- Fixed bug in ADSR::setReleaseTime() method.
+- Fixed missing initialization of apInput in non-default constructor of DelayA class.
+- Added time seeding of random number generator to Noise constructor.
+- Update to the contentsAt() method of Delay class.
+- WAV file fixes (8-bit) in WvIn and WvOut classes.
+- Configure script changes.
+- Updated \<iostream\> include statements and appended "std::" as necessary throughout for compatibility with gcc 3.
+
+\subsection v4dot1dot1 Version 4.1.1
+- Bug fix in RtAudio for Macintosh OS X and Windows ASIO duplex operation.
+- Windows ASIO fix in Stk.h.
+- Documentation updates.
+- Expanded tutorial.
+- Fixed RtDuplex omission in src Makefile.
 
 \subsection v4dot1 Version 4.1
-
-<UL>
-<LI>Macintosh OS X support added.</LI>
-<LI>New Whistle class.</LI>
-<LI>Added Voicer, SingWave, and VoicForm classes.</LI>
-<LI>Improvements/fixes to the banded waveguide instruments.</LI>
-<LI>Demo program now uses Voicer, allowing polyphony.</LI>
-<LI>Demo tcl/tk scripts changed to use SKINI PitchChange instead of PitchBend.</LI>
-<LI>Demo program response to PitchBend modified to octave up/down.</LI>
-<LI>Several RtAudio fixes and improvements (OS X and Windows ASIO support added).</LI>
-<LI>Added nextOut() method to Delay classes.</LI>
-<LI>Documentation fixes for Reverb classes.</LI>
-<LI>RAWWAVE_PATH changed to include the "rawwave" directory.</LI>
-<LI>"configure" support added for unix systems.</LI>
-<LI>Multivoice flag (-n NUMBER) added as command line option to demo program.</LI>
-<LI>Sample rate flag added as command line option to example programs.</LI>
-<LI>Socket port number added as command line option to example programs.</LI>
-</UL>
+- Macintosh OS X support added.
+- New Whistle class.
+- Added Voicer, SingWave, and VoicForm classes.
+- Improvements/fixes to the banded waveguide instruments.
+- Demo program now uses Voicer, allowing polyphony.
+- Demo Tcl/Tk scripts changed to use SKINI PitchChange instead of PitchBend.
+- Demo program response to PitchBend modified to octave up/down.
+- Several RtAudio fixes and improvements (OS X and Windows ASIO support added).
+- Added nextOut() method to Delay classes.
+- Documentation fixes for Reverb classes.
+- RAWWAVE_PATH changed to include the "rawwave" directory.
+- "configure" support added for unix systems.
+- Multivoice flag (-n NUMBER) added as command line option to demo program.
+- Sample rate flag added as command line option to example programs.
+- Socket port number added as command line option to example programs.
 
 \subsection v4 Version 4.0
-
-<UL>
-<LI>New documentation and tutorial.</LI>
-<LI>Several new instruments, including Saxofony, BlowBotl, and StifKarp.</LI>
-<LI>New Stk base class, replacing Object class.</LI>
-<LI>New Filter class structure and methods.</LI>
-<LI>Extensive modifications to WvIn and WvOut class structures and methods.</LI>
-<LI>Looping functionality moved to WaveLoop (subclass of WvIn).</LI>
-<LI>Automatic file type detection in WvIn ... hosed WavWvIn, AifWvIn, RawWavIn, SndWavIn, and MatWvIn subclasses.</LI>
-<LI>New file type specifier argument in WvOut ... hosed WavWvOut, AifWvOut, RawWavOut, SndWavOut, and MatWvOut subclasses.</LI>
-<LI>Some simplifications of Messager class (was Controller).</LI>
-<LI>New independent RtAudio class.</LI>
-<LI>Extensive revisions in code and a significant number of API changes.</LI>
-</UL>
+- New documentation and tutorial.
+- Several new instruments, including Saxofony, BlowBotl, and StifKarp.
+- New Stk base class, replacing Object class.
+- New Filter class structure and methods.
+- Extensive modifications to WvIn and WvOut class structures and methods.
+- Looping functionality moved to WaveLoop (subclass of WvIn).
+- Automatic file type detection in WvIn ... hosed WavWvIn, AifWvIn, RawWavIn, SndWavIn, and MatWvIn subclasses.
+- New file type specifier argument in WvOut ... hosed WavWvOut, AifWvOut, RawWavOut, SndWavOut, and MatWvOut subclasses.
+- Some simplifications of Messager class (was Controller).
+- New independent RtAudio class.
+- Extensive revisions in code and a significant number of API changes.
 
 \subsection v3dot2 Version 3.2
-
-<UL>
-<LI>New input control handling class (Controller)</LI>
-<LI>Added AIFF file input/output support.</LI>
-<LI>New C++ error handling capabilities.</LI>
-<LI>New input/output internet streaming support (StrmWvIn/StrmWvOut).</LI>
-<LI>Added native ALSA support for linux.</LI>
-<LI>Added optional "device" argument to all "Rt" classes (audio and MIDI) and printout of devices when argument is invalid.</LI>
-<LI>WvIn classes rewritten to support very big files (incremental load from disk).</LI>
-<LI>Changed WvIn/WvOut classes to work with sample frame buffers.</LI>
-<LI>Fixed looping and negative rate calculations in WvIn classes.</LI>
-<LI>Fixed interpolation bug in RtWvIn.</LI>
-<LI>Windoze RtAudio code rewritten (thank Dave!).</LI>
-<LI>Simplified byte-swapping functions (in-place swapping).</LI>
-<LI>"Stereo-ized" RagaMatic.</LI>
-<LI>Miscellaneous renamings.</LI>
-<LI>Probably a bunch more fixes that I've long since forgotten about.</LI>
-</UL>
+- New input control handling class (Controller)
+- Added AIFF file input/output support.
+- New C++ error handling capabilities.
+- New input/output internet streaming support (StrmWvIn/StrmWvOut).
+- Added native ALSA support for linux.
+- Added optional "device" argument to all "Rt" classes (audio and MIDI) and printout of devices when argument is invalid.
+- WvIn classes rewritten to support very big files (incremental load from disk).
+- Changed WvIn/WvOut classes to work with sample frame buffers.
+- Fixed looping and negative rate calculations in WvIn classes.
+- Fixed interpolation bug in RtWvIn.
+- Windoze RtAudio code rewritten (thank Dave!).
+- Simplified byte-swapping functions (in-place swapping).
+- "Stereo-ized" RagaMatic.
+- Miscellaneous renamings.
+- Probably a bunch more fixes that I've long since forgotten about.
 
 \subsection v3dot1 Version 3.1
-
-<UL>
-<LI>New RagaMatic project ... very cool!!!</LI>
-<LI>Less clipping in the Shakers class.</LI>
-<LI>Added "microphone position" to Mandolin in STKdemo.</LI>
-<LI>Fixed MIDI system message exclusion under Irix.</LI>
-<LI>Added a few bitmaps for the Shaker instruments.</LI>
-<LI>Made destructors virtual for Reverb.h, WvIn.h and Simple.h.</LI>
-<LI>Fixed bug setting delay length in DLineA when value too big.</LI>
-<LI>Fixed bug in WinMM realtime code (RTSoundIO).</LI>
-<LI>Added tick() method to BowTabl, JetTabl, and ReedTabl (same as lookup).</LI>
-<LI>Switched to pthread API on SGI platforms.</LI>
-<LI>Added some defines to Object.h for random number generation, FPU overflow checking, etc....</LI>
-<LI>A few minor changes, some bug fixes ... can't remember all of them.</LI>
-</UL>
+- New RagaMatic project ... very cool!!!
+- Less clipping in the Shakers class.
+- Added "microphone position" to Mandolin in STKdemo.
+- Fixed MIDI system message exclusion under Irix.
+- Added a few bitmaps for the Shaker instruments.
+- Made destructors virtual for Reverb.h, WvIn.h and Simple.h.
+- Fixed bug setting delay length in DLineA when value too big.
+- Fixed bug in WinMM realtime code (RTSoundIO).
+- Added tick() method to BowTabl, JetTabl, and ReedTabl (same as lookup).
+- Switched to pthread API on SGI platforms.
+- Added some defines to Object.h for random number generation, FPU overflow checking, etc....
+- A few minor changes, some bug fixes ... can't remember all of them.
 
 \subsection v3 Version 3.0
-
-<UL>
-<LI>New #define flags for OS and realtime dependencies (this will probably cause problems for old personal STK code, but it was necessary to make future ports easier).</LI>
-<LI>Expanded and cleaned the Shakers class.</LI>
-<LI>New BowedBar algorithm/class.</LI>
-<LI>Fixed Linux MIDI input bug.</LI>
-<LI>Fixed MIDI status masking problem in Windows.</LI>
-<LI>OS type defines now in Makefile.</LI>
-<LI>New RAWWAVE_PATH define in Object.h.</LI>
-<LI>Syntmono project pulled out to separate directory and cleaned up.</LI>
-<LI>Socketing capabilities under Unix, as well as Windoze.</LI>
-<LI>Multiple simultaneous socket client connections to STK servers now possible.</LI>
-<LI>MD2SKINI now can merge MIDI and piped messages under Irix and Linux (for TCL->MD2SKINI->syntmono control).</LI>
-<LI>Defined INT16 and INT32 types and fixed various WvIn and WvOut classes.</LI>
-<LI>Updated MatWvIn and MatWvOut for new MAT-file documentation from Matlab.</LI>
-<LI>New demo Tcl/Tk GUI (TclDemo.tcl).</LI>
-<LI>Minor fixes to FM behavior.</LI>
-<LI>Added record/duplex capabilities to RTSoundIO (Linux, SGI, and Windoze).</LI>
-<LI>Fixed bugs in WavWvOut and MatWvOut header specifications.</LI>
-<LI>Added RawWvOut class.</LI>
-<LI>New WvIn class with RawWvIn, SndWvIn, WavWvIn, MatWvIn, and RTWvIn subclasses.</LI>
-<LI>Removed RawWave, RawShot, RawInterp, and RawLoop classes (supplanted by RawWvIn).</LI>
-<LI>Multi-channel data support in WvIn and WvOut classes using MY_MULTI data type (pointer to MY_FLOAT) and the methods mtick() and mlastOutput().</LI>
-<LI>Now writing to primary buffer under Windoze when allowed by hardware.</LI>
-<LI>Cleaned up Object.h a bit.</LI>
-<LI>Pulled various utility and thread functions out of syntmono.cpp (to aid readability of the code).</LI>
-</UL>
+- New #define flags for OS and realtime dependencies (this will probably cause problems for old personal STK code, but it was necessary to make future ports easier).
+- Expanded and cleaned the Shakers class.
+- New BowedBar algorithm/class.
+- Fixed Linux MIDI input bug.
+- Fixed MIDI status masking problem in Windows.
+- OS type defines now in Makefile.
+- New RAWWAVE_PATH define in Object.h.
+- Syntmono project pulled out to separate directory and cleaned up.
+- Socketing capabilities under Unix, as well as Windoze.
+- Multiple simultaneous socket client connections to STK servers now possible.
+- MD2SKINI now can merge MIDI and piped messages under Irix and Linux (for TCL->MD2SKINI->syntmono control).
+- Defined INT16 and INT32 types and fixed various WvIn and WvOut classes.
+- Updated MatWvIn and MatWvOut for new MAT-file documentation from Matlab.
+- New demo Tcl/Tk GUI (TclDemo.tcl).
+- Minor fixes to FM behavior.
+- Added record/duplex capabilities to RTSoundIO (Linux, SGI, and Windoze).
+- Fixed bugs in WavWvOut and MatWvOut header specifications.
+- Added RawWvOut class.
+- New WvIn class with RawWvIn, SndWvIn, WavWvIn, MatWvIn, and RTWvIn subclasses.
+- Removed RawWave, RawShot, RawInterp, and RawLoop classes (supplanted by RawWvIn).
+- Multi-channel data support in WvIn and WvOut classes using MY_MULTI data type (pointer to StkFloat) and the methods mtick() and mlastOutput().
+- Now writing to primary buffer under Windoze when allowed by hardware.
+- Cleaned up Object.h a bit.
+- Pulled various utility and thread functions out of syntmono.cpp (to aid readability of the code).
 
 \subsection v2dot02 Version 2.02
-
-<UL>
-<LI>Created RawWave abstract class, with subclasses of RawLoop (looping rawwave oscillator), RawShot (non-looping, non-interpolating rawwave player ... used to be RawWvIn), and RawInterp (looping or non-looping, interpolating rawwave player ... used to be RawWave).</LI>
-<LI>Modified DrumSynt to correctly handle sample rates different than 22050 Hz.</LI>
-<LI>Modified syntmono parsing vs. tick routine so that some ticking occurs between each message.  When multiple messages are waiting to be processed, the time between message updates is inversely proportional to the number of messages in the buffer.</LI>
-<LI>Fixed DirectSound playback bug in WinXX distribution.  Sound was being played at 8-bit, 22 kHz in all cases.  Playback is now 16-bit and dependent on SRATE.</LI>
-<LI>Fixed bug in MD2SKINI which prevented some NoteOff statements from being output.</LI>
-<LI>This distribution includes an example STK project, mus151, which demonstrates a means for keeping a user's personal projects separate from the main distribution.  This is highly recommended, in order to simplify upgrades to future STK releases.</LI>
-</UL>
+- Created RawWave abstract class, with subclasses of RawLoop (looping rawwave oscillator), RawShot (non-looping, non-interpolating rawwave player ... used to be RawWvIn), and RawInterp (looping or non-looping, interpolating rawwave player ... used to be RawWave).
+- Modified DrumSynt to correctly handle sample rates different than 22050 Hz.
+- Modified syntmono parsing vs. tick routine so that some ticking occurs between each message.  When multiple messages are waiting to be processed, the time between message updates is inversely proportional to the number of messages in the buffer.
+- Fixed DirectSound playback bug in WinXX distribution.  Sound was being played at 8-bit, 22 kHz in all cases.  Playback is now 16-bit and dependent on SRATE.
+- Fixed bug in MD2SKINI which prevented some NoteOff statements from being output.
+- This distribution includes an example STK project, mus151, which demonstrates a means for keeping a user's personal projects separate from the main distribution.  This is highly recommended, in order to simplify upgrades to future STK releases.
 
 \subsection v2 Version 2
-
-<UL>
-<LI>Unification of the capabilities of STK across the various platforms.  All of the previous SGI functionality has been ported to Linux and Windows, including realtime sound output and MIDI input.</LI>
-<LI>MIDI input (with optional time-stamping) supported on SGI, Linux (OSS device drivers only), and Windows operating systems.  Time stamping under IRIX and Windows is quantized to milliseconds and under Linux to hundredths of a second.</LI>
-<LI>Various Sound Output Options - .wav, .snd, and .mat (Matlab MAT-file) soundfile outputs are supported on all operating systems.  I hacked out the MAT-file structure, so you don't have to include any platform-specific libraries.  Realtime sound output is provided as well, except under NeXTStep. </LI>
-<LI>Multiple Reverberator Implementations - Reverb subclasses of JCRev and NRev (popular reverberator implementations from CCRMA) have been written.  Perry's original reverb implementation still exists as PRCRev.  All reverberators now take a T60 initializer argument.</LI>
-<LI>MD2SKINI - A program which parses a MIDI input stream and spits out SKINI code.  The output of MD2SKINI is typically piped into an STK instrument executable (eg. <FONT FACE="Geneva">MD2SKINI | syntmono Clarinet -r -i</FONT>).  In addition, you can supply a filename argument to MD2SKINI and have it simultaneously record a SKINI score file for future reuse.
-<LI>Modifications to <I>Object.h</I> for OS_TYPE compilation dependencies.  <I>Makefile</I> automatically determines OS_TYPE when invoked (if you have the GNU makefile utilities installed on your system).
-<LI>A single distribution for all platforms.  The Unix and Windows versions have been merged into a single set of classes.  Makefiles and Visual C++ workspace/project files are provided for compiling.
-</UL>
+- Unification of the capabilities of STK across the various platforms.  All of the previous SGI functionality has been ported to Linux and Windows, including realtime sound output and MIDI input.
+- MIDI input (with optional time-stamping) supported on SGI, Linux (OSS device drivers only), and Windows operating systems.  Time stamping under IRIX and Windows is quantized to milliseconds and under Linux to hundredths of a second.
+- Various Sound Output Options - .wav, .snd, and .mat (Matlab MAT-file) soundfile outputs are supported on all operating systems.  I hacked out the MAT-file structure, so you don't have to include any platform-specific libraries.  Realtime sound output is provided as well, except under NeXTStep.
+- Multiple Reverberator Implementations - Reverb subclasses of JCRev and NRev (popular reverberator implementations from CCRMA) have been written.  Perry's original reverb implementation still exists as PRCRev.  All reverberators now take a T60 initializer argument.
+- MD2SKINI - A program which parses a MIDI input stream and spits out SKINI code.  The output of MD2SKINI is typically piped into an STK instrument executable (e.g. <tt>MD2SKINI | syntmono Clarinet -r -i</tt>).  In addition, you can supply a filename argument to MD2SKINI and have it simultaneously record a SKINI score file for future reuse.
+- Modifications to <I>Object.h</I> for OS_TYPE compilation dependencies.  <I>Makefile</I> automatically determines OS_TYPE when invoked (if you have the GNU makefile utilities installed on your system).
+- A single distribution for all platforms.  The Unix and Windows versions have been merged into a single set of classes.  Makefiles and Visual C++ workspace/project files are provided for compiling.
 
 */

doc/doxygen/faq.txt

@@ -0,0 +1,81 @@
+/*! \page faq Frequently Asked Questions
+
+- \ref license
+- \ref filerate
+- \ref endianness
+- \ref xwindows
+
+\section license Does STK have a license?
+
+Yes, we finally made something official for release 4.3.0.  It is listed in the Stk class and a few other places in the distribution, but I'll repeat it here for clarity:
+
+\verbatim
+The Synthesis ToolKit in C++ (STK) is a set of open source audio
+signal processing and algorithmic synthesis classes written in the
+C++ programming language. STK was designed to facilitate rapid
+development of music synthesis and audio processing software, with
+an emphasis on cross-platform functionality, realtime control,
+ease of use, and educational example code.  STK currently runs
+with realtime support (audio and MIDI) on Linux, Macintosh OS X,
+and Windows computer platforms. Generic, non-realtime support has
+been tested under NeXTStep, Sun, and other platforms and should
+work with any standard C++ compiler.
+
+STK GitHub site: https://github.com/thestk/stk
+STK WWW site: http://ccrma.stanford.edu/software/stk/
+
+The Synthesis ToolKit in C++ (STK)
+Copyright (c) 1995--2021 Perry R. Cook and Gary P. Scavone
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+Any person wishing to distribute modifications to the Software is
+asked to send the modifications to the original developer so that they
+can be incorporated into the canonical version.  This is, however, not
+a binding provision of this license.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+\endverbatim
+
+\section filerate Why is my file sample rate wrong?
+
+When the FileWvIn class loads a soundfile, it automatically sets its internal read increment based on the soundfile rate and the current STK sample rate.  For example, if the current STK sample rate is 44100 Hz and the soundfile rate is 22050 Hz, the read increment, or rate, will be set to 0.5 and the file will be interpolated so that is sounds correct at 44100 Hz.  For most cases, this works fine.  However, consider the following example:
+
+\code
+FileWvIn input( "infile" );                 // read an input soundfile
+StkFloat sampleRate = input.getFileRate();
+Stk::setSampleRate( sampleRate );           // set a new STK sample rate based on the file rate
+\endcode
+
+With version 4.3 and higher of STK, the FileWvIn class will be notified of a sample rate change and it will automatically adjust its read rate accordingly.  Previous versions of STK did not perform this change and thus, the read rate could end up being incorrect.  If you do not want FileWvIn to perform this automatic adjustment, you can call the \c ignoreSampleRateChange() function for a given class instance.
+
+\section endianness Why does the sound I generated with STK sound like *&#@!?
+
+If the resultant sound generated by an STK program sounds like noise (and you're not doing an MLS experiment), the problem is likely related to the byte "endianness" of your computer.  By default, STK assumes "big endian" byte order.  If you are working with STK classes on a PC (Windows or Linux), you \e must define the <TT>__LITTLE_ENDIAN__</TT> preprocessor definition \e before compiling.  If after reading this you realize you need to make this change, do not forget to recompile all STK classes from scratch.
+
+\section xwindows Why do I get a Tk display error message?
+
+The following error may be printed to your terminal window (depending on the version of the Tcl/Tk interpreter you are running) if you attempt to start an STK Tcl/Tk interface without the X Server first running:
+
+\code
+Application initialization failed: this isn't a Tk applicationcouldn't connect to display ":0.0"
+\endcode
+
+Simply start your X server and then try the command again.
+
+*/

doc/doxygen/filtering.txt

@@ -0,0 +1,91 @@
+/*! \page filtering Using Filters
+
+In this section, we demonstrate the use of a few of the STK filter classes.  The stk::Iir class provides functionality to implement a generalized infinite impulse response (IIR) digital filter, similar to the \c filter function in Matlab.  In this example, we create an stk::Iir instance and initialize it with specific numerator and denominator coefficients.  We then compute its impulse response for 20 samples.
+
+\code
+#include "Iir.h"
+using namespace stk;
+
+int main()
+{
+  StkFrames output( 20, 1 );   // initialize StkFrames to 20 frames and 1 channel (default: interleaved)
+  output[0] = 1.0;
+
+  std::vector<StkFloat> numerator( 5, 0.1 ); // create and initialize numerator coefficients
+  std::vector<StkFloat> denominator;         // create empty denominator coefficients
+  denominator.push_back( 1.0 );              // populate our denomintor values
+  denominator.push_back( 0.3 );
+  denominator.push_back( -0.5 );
+
+  Iir filter( numerator, denominator );
+
+  filter.tick( output );
+  for ( unsigned int i=0; i<output.size(); i++ ) {
+    std::cout << "i = " << i << " : output = " << output[i] << std::endl;
+  }
+
+  return 0;
+}
+\endcode
+
+The stk::Iir class implements the standard difference equation
+\code
+ a[0]*y[n] = b[0]*x[n] + ... + b[nb]*x[n-nb] - a[1]*y[n-1] - ... - a[na]*y[n-na],
+\endcode
+
+where "b" values are numerator coefficients and "a" values are denominator coefficients.  Note that if the first denominator coefficient is not 1.0, the Iir class automatically normalizes all filter coefficients by that value.  The coefficient values are passed to the Iir class via a C++ <a href="http://www.cplusplus.com/reference/vector/vector/">vector</a>, a container object provided by the C++ Standard Library.
+
+Most STK classes use more specific types of digital filters, such as the stk::OneZero, stk::OnePole, stk::TwoPole, or stk::BiQuad varieties.  These classes inherit from the stk::Filter abstract base class and provide specific functionality particular to their use, as well as functions to independently control individual coefficient values.
+
+\section reson Resonances:
+
+The STK stk::BiQuad and stk::TwoPole classes provide functionality for creating resonance filters.  The following example demonstrates how to create a resonance centered at 440 Hz that is used to filter the output of a stk::Noise generator.
+
+\code
+#include "BiQuad.h"
+#include "Noise.h"
+using namespace stk;
+
+int main()
+{
+  StkFrames output( 20, 1 );   // initialize StkFrames to 20 frames and 1 channel (default: interleaved)
+  Noise noise;
+
+  BiQuad biquad;
+  biquad.setResonance( 440.0, 0.98, true ); // automatically normalize for unity peak gain
+
+  for ( unsigned int i=0; i<output.size(); i++ ) {
+    output[i] = biquad.tick( noise.tick() );  // single-sample computations
+    std::cout << "i = " << i << " : output = " << output[i] << std::endl;
+  }
+
+  return 0;
+}
+\endcode
+
+By passing a boolian value of \c true as the third argument to the stk::BiQuad::setResonance() function, the filter coefficients are automatically scaled to achieve unity gain at the resonance peak frequency.  The previous code could be easily modified for "vector-based" calculations:
+
+\code
+#include "BiQuad.h"
+#include "Noise.h"
+using namespace stk;
+
+int main()
+{
+  StkFrames output( 20, 1 );   // initialize StkFrames to 20 frames and 1 channel (default: interleaved)
+  Noise noise;
+
+  BiQuad biquad;
+  biquad.setResonance( 440.0, 0.98, true ); // automatically normalize for unity peak gain
+
+  biquad.tick( noise.tick( output ) );      // vector-based computations
+  for ( unsigned int i=0; i<output.size(); i++ ) {
+    std::cout << "i = " << i << " : output = " << output[i] << std::endl;
+  }
+
+  return 0;
+}
+\endcode
+
+[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="realtime.html">Next tutorial</A>]
+*/

doc/doxygen/footer.html

@@ -1,9 +1,9 @@
 <HR>
 
 <table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
+  <tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
+  <tr><td>&copy;1995--2021 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
 </table>
 
 </BODY>
-</HTML>
+</HTML>

doc/doxygen/fundamentals.txt

@@ -0,0 +1,65 @@
+/*! \page fundamentals STK Fundamentals
+
+The Synthesis ToolKit is implemented in the C++ programming language.  STK does not attempt to provide a new programming environment or paradigm but rather provides a set of objects that can be used within a normal C++ programming framework.  Therefore, it is expected that users of STK will have some familiarity with C/C++ programming concepts.  That said, the STK classes do have some particular idiosyncrasies that we will mention here.  Starting with STK version 4.4, all STK classes except RtAudio and RtMidi are defined within the stk namespace.
+
+\section Signal Computations:
+
+Audio and control signals throughout STK use a floating-point data type, <tt>StkFloat</tt>, the exact precision of which can be controlled via a typedef statement in Stk.h.  By default, an StkFloat is a double-precision floating-point value.  Thus, the ToolKit can use any normalization scheme desired. The base instruments and algorithms are implemented with a general audio sample dynamic maximum of +/-1.0.
+
+In general, the computation and/or passing of values is performed on a "single-sample" basis.  For example, the stk::Noise class outputs random floating-point numbers in the range +/-1.0.  The computation of such values occurs in the stk::Noise::tick() function.  The following program will generate 20 random floating-point (<tt>StkFloat</tt>) values in the range -1.0 to +1.0:
+
+\code
+#include "Noise.h"
+using namespace stk;
+
+int main()
+{
+  StkFloat output;
+  Noise noise;
+
+  for ( unsigned int i=0; i<20; i++ ) {
+    output = noise.tick();
+    std::cout << "i = " << i << " : output = " << output << std::endl;
+  }
+
+  return 0;
+}
+\endcode
+
+Nearly all STK classes implement <TT>tick()</TT> functions that take and/or return sample values. Within the <TT>tick()</TT> function, the fundamental sample calculations are performed for a given class.  Most STK classes consume/generate a single sample per operation and their <TT>tick()</TT> method takes/returns each sample "by value".  In addition, every class implementing a <TT>tick()</TT> function also provides one or more overloaded <TT>tick()</TT> functions that can be used for vectorized computations, as shown in the next example.
+
+\code
+#include "Noise.h"
+using namespace stk;
+
+int main()
+{
+  StkFrames output(20, 1);   // initialize StkFrames to 20 frames and 1 channel (default: interleaved)
+  Noise noise;
+
+  noise.tick( output );
+  for ( unsigned int i=0; i<output.size(); i++ ) {
+    std::cout << "i = " << i << " : output = " << output[i] << std::endl;
+  }
+
+  return 0;
+}
+\endcode
+
+In this way, it might be possible to achieve improved processing efficiency using vectorized computations.  The StkFrames class is a relatively new addition to the ToolKit to provide a general "mechanism" for handling and passing vectorized, multi-channel audio data.  The StkFrames "type" provides functions to set and/or determine the number of audio channels and sample frames it holds.  Further, the StkFrames class provides data interpolation and subscripting functionality by frame/channel values.
+
+\section STK Inheritance:
+
+Nearly all STK classes inherit from the Stk abstract base class, which provides common functionality related to error reporting, sample rate control, and byte swapping.  Several other base classes exist that roughly group many of the classes according to function as follows:
+
+- stk::Generator: source signal unit generator classes [stk::Envelope, stk::ADSR, stk::Asymp, stk::Noise, stk::SubNoise, stk::Modulate, stk::SingWave, stk::SineWave, stk::Blit, stk::BlitSaw, stk::BlitSquare, stk::Granulate]
+- stk::Filter: digital filtering classes [stk::OneZero, stk::OnePole, stk::PoleZero, stk::TwoZero, stk::TwoPole, stk::BiQuad, stk::FormSwep, stk::Delay, stk::DelayL, stk::DelayA, stk::TapDelay]
+- stk::Function: input to output function mappings [stk::BowTable, stk::JetTable, stk::ReedTable]
+- stk::Instrmnt: sound synthesis algorithms, including physical, FM, modal, and particle models
+- stk::Effect: sound processing effect classes [stk::Echo, stk::Chorus, stk::PitShift, stk::PRCRev, stk::JCRev, stk::NRev]
+- stk::WvOut: audio data output classes [stk::FileWvOut, stk::RtWvOut, stk::InetWvOut]
+- stk::WvIn: audio data input classes [stk::FileWvIn, stk::FileLoop, stk::RtWvIn, stk::InetWvIn]
+
+
+[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="hello.html">Next tutorial</A>] 
+*/

doc/doxygen/header.html

@@ -5,6 +5,6 @@
 </HEAD>
 <BODY BGCOLOR="#FFFFFF">
 <CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
+<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
+<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
+<HR>

doc/doxygen/header.tex

@@ -19,13 +19,13 @@
 \vspace*{1cm}
 {\large by Perry R. Cook and Gary P. Scavone}\\
 \vspace*{0.5cm}
-{\small \copyright 1995--2002}\\
+{\small \copyright 1995--2007}\\
 \end{center}
 \end{titlepage}
 \clearemptydoublepage
 \pagenumbering{roman}
-\rfoot[\fancyplain{}{\bfseries\scriptsize The Synthesis ToolKit in C++ by Perry R. Cook and Gary P. Scavone, \copyright~1995--2002}]{}
-\lfoot[]{\fancyplain{}{\bfseries\scriptsize The Synthesis ToolKit in C++ by Perry R. Cook and Gary P. Scavone, \copyright~1995--2002}}
+\rfoot[\fancyplain{}{\bfseries\scriptsize The Synthesis ToolKit in C++ by Perry R. Cook and Gary P. Scavone, \copyright~1995--2007}]{}
+\lfoot[]{\fancyplain{}{\bfseries\scriptsize The Synthesis ToolKit in C++ by Perry R. Cook and Gary P. Scavone, \copyright~1995--2007}}
 \tableofcontents
 \clearemptydoublepage
 \pagenumbering{arabic}

doc/doxygen/hello.txt

@@ -1,104 +1,94 @@
 /*! \page hello Hello Sine!
 
-We'll begin our introduction to the Synthesis ToolKit with a simple sine-wave oscillator program.  STK does not provide a specific oscillator for sine waves.  Instead, it provides a generic waveform oscillator class, WaveLoop, which can load a variety of common file types.  In this example, we load a sine "table" from an STK RAW file (defined as monophonic, 16-bit, big-endian data).  We use the class WvOut to write the result to a 16-bit, WAV formatted audio file.
+We'll continue our introduction to the Synthesis ToolKit with a simple
+sine-wave oscillator program.  STK provides two different classes for
+sine-wave generation.  We will first look at a generic waveform
+oscillator class, stk::FileLoop, that can load a variety of common file
+types.  In this example, we load a sine "table" from an STK RAW file
+(defined as monophonic, 16-bit, big-endian data).  We use the class
+stk::FileWvOut to write the result to a 16-bit, WAV formatted audio file.
 
 \code
 
 // sineosc.cpp
 
-#include "WaveLoop.h"
-#include "WvOut.h"
+#include "FileLoop.h"
+#include "FileWvOut.h"
+using namespace stk;
 
 int main()
 {
   // Set the global sample rate before creating class instances.
   Stk::setSampleRate( 44100.0 );
 
-  // Define and load the sine wave file
-  WaveLoop *input = new WaveLoop( "rawwaves/sinewave.raw", TRUE );
-  input->setFrequency( 440.0 );
+  FileLoop input;
+  FileWvOut output;
 
-  // Define and open a 16-bit, one-channel WAV formatted output file
-  output = new WvOut( "hellosine.wav", 1, WvOut::WVOUT_WAV, Stk::STK_SINT16 );
+  // Load the sine wave file.
+  input.openFile( "rawwaves/sinewave.raw", true );
+
+  // Open a 16-bit, one-channel WAV formatted output file
+  output.openFile( "hellosine.wav", 1, FileWrite::FILE_WAV, Stk::STK_SINT16 );
+
+  input.setFrequency( 440.0 );
 
   // Run the oscillator for 40000 samples, writing to the output file
-  int i;
-  for ( i=0; i<40000; i++ ) {
-    output->tick( input->tick() );
-  }
-
-  // Clean up
-  delete input;
-  delete output;
+  for ( int i=0; i<40000; i++ )
+    output.tick( input.tick() );
 
   return 0;
 }
 \endcode
 
-WaveLoop is a subclass of WvIn, which supports WAV, SND (AU), AIFF, MAT-file (Matlab), and RAW file formats with 8-, 16-, and 32-bit integer and 32- and 64-bit floating-point data types.  WvIn provides interpolating, read once ("oneshot") functionality, as well as methods for setting the read rate and read position.
+stk::FileLoop is a subclass of stk::FileWvIn, which supports WAV, SND
+(AU), AIFF, MAT-file (Matlab), and RAW file formats with 8-, 16-, and
+32-bit integer and 32- and 64-bit floating-point data types.
+stk::FileWvIn provides interpolating, read-once ("oneshot")
+functionality, as well as methods for setting the read rate and read
+position.
 
-The WvIn and WvOut classes are complementary, both supporting WAV, SND (AU), AIFF, MAT-file (Matlab), and RAW file formats with 8-, 16-, and 32-bit integer and 32- and 64-bit floating-point data types.  However, WvOut does not perform data interpolation.
+stk::FileWvIn provides a "tick level" and interpolating interface to
+the stk::FileRead class.  Likewise, stk::FileWvOut provides a "tick
+level" interface to the stk::FileWrite class.  stk::FileRead and
+FileWrite both support WAV, SND(AU), AIFF, MAT-file (Matlab), and RAW
+file formats with 8-, 16-, and 32-bit integer and 32- and 64-bit
+floating-point data types.  stk::FileWvOut does not currently offer
+data interpolation functionality.
 
-Nearly all STK classes implement <TT>tick()</TT> functions which take and/or return sample values. Within the <TT>tick()</TT> function, the fundamental sample calculations are performed for a given class.  Most STK classes consume/generate a single sample per operation and their <TT>tick()</TT> method takes/returns each sample "by value".  In addition, every class implementing a <TT>tick()</TT> function also provides an overloaded <TT>tick()</TT> function taking pointer and size arguments which can be used for vectorized computations.
+A number of STK parent classes, including stk::WvIn, stk::WvOut,
+stk::Instrmnt, stk::Generator, and stk::Effect, (and some or all of
+their subclasses) support multi-channel sample frames.  If a
+single-sample version of the <TT>tick()</TT> function is called for
+these classes, a full sample frame is computed but only a single value
+is either input and/or output.  For example, if the single-sample
+<TT>tick()</TT> function is called for subclasses of stk::WvOut, the
+sample argument is written to all channels in the one computed frame.
+For classes returning values, an optional \c channel argument
+specifies which channel value is returned from the computed frame (the
+default is always channel 0). To input and/or output multichannel data
+to these classes, the overloaded <TT>tick()</TT> functions taking
+StkFrames reference arguments should be used.
 
-The WvIn and WvOut classes support multi-channel sample frames.  To distinguish single-sample frame operations from multi-channel frame operations, these classes also implement <TT>tickFrame()</TT> functions.  When a <TT>tick()</TT> method is called for multi-channel data, frame averages are returned or the input sample is distributed across all channels of a sample frame.
-
-Nearly all STK classes inherit from the Stk base class.  Stk provides a static sample rate which is queried by subclasses as needed.  Because many classes use the current sample rate value during instantiation, it is important that the desired value be set at the beginning of a program.  The default STK sample rate is 22050 Hz.
-
-Another primary concept that is somewhat obscurred in this example concerns the data format in which sample values are passed and received.  Audio and control signals throughout STK use a floating-point data type, the exact precision of which can be controlled via the <TT>MY_FLOAT</TT> \#define statement in Stk.h.  Thus, the ToolKit can use any normalization scheme desired. The base instruments and algorithms are implemented with a general audio sample dynamic maximum of +/-1.0, and the WvIn and WvOut classes and subclasses scale appropriately for DAC or soundfile input and output.
+Nearly all STK classes inherit from the stk::Stk base class.  Stk
+provides a static sample rate that is queried by subclasses as needed.
+Because many classes use the current sample rate value during
+instantiation, it is important that the desired value be set at the
+beginning of a program.  The default STK sample rate is 44100 Hz.
 
 \section error Error Handling
 
-The ToolKit has some basic C++ error handling functionality built in.  Classes which access files and/or hardware are most prone to runtime errors.  To properly "catch" such errors, the above example should be rewritten as shown below.
+The ToolKit has some basic C++ error handling functionality built in.
+Classes that access files and/or hardware are most prone to runtime
+errors.  To properly "catch" such errors, the above example should be
+rewritten as shown below.
 
-\code
-// sineosc.cpp
+\include sineosc.cpp
 
-#include "WaveLoop.h"
-#include "WvOut.h"
+In this particular case, we simply exit the program if an error occurs
+(an error message is automatically printed to stderr).  A more refined
+program might attempt to recover from or fix a particular problem and,
+if successful, continue processing.  See the \ref classes to determine
+which constructors and functions can throw an error.
 
-int main()
-{
-  // Set the global sample rate before creating class instances.
-  Stk::setSampleRate( 44100.0 );
-
-  WaveLoop *input = 0;
-  WvOut *output = 0;
-
-  try {
-    // Define and load the sine wave file
-    input = new WaveLoop( "rawwaves/sinewave.raw", TRUE );
-
-    // Define and open a 16-bit, one-channel WAV formatted output file
-    output = new WvOut( "hellosine.wav", 1, WvOut::WVOUT_WAV, Stk::STK_SINT16 );
-  }
-  catch ( StkError & ) {
-    goto cleanup;
-  }
-
-  input->setFrequency( 440.0 );
-
-  // Run the oscillator for 40000 samples, writing to the output file
-  for ( int i=0; i<40000; i++ ) {
-
-    try {
-      output->tick( input->tick() );
-    }
-    catch ( StkError & ) {
-      goto cleanup;
-    }
-
-  }
-
- cleanup:
-  delete input;
-  delete output;
-
-  return 0;
-}
-\endcode
-
-In this particular case, we simply exit the program if an error occurs (an error message is automatically printed to stderr).  A more refined program might attempt to recover from or fix a particular problem and, if successful, continue processing.  See the \ref classes to determine which constructors and functions can throw an error.
-
-[<A HREF="compile.html">Next tutorial</A>] &nbsp; [<A HREF="tutorial.html">Main tutorial page</A>]
+[<A HREF="fundamentals.html">Main tutorial page</A>] &nbsp; [<A HREF="compile.html">Next tutorial</A>]
 */

doc/doxygen/index.txt

@@ -1,8 +1,25 @@
-/*! \mainpage <I>The Synthesis ToolKit in C++ (STK)</I>
+/*! \mainpage The Synthesis ToolKit in C++ (STK)
 
+\htmlonly
 <BODY BGCOLOR="white">
+<h3><center><a href="http://www.cs.princeton.edu/~prc/">Perry R. Cook</a> & <a href="http://music.mcgill.ca/~gary/">Gary P. Scavone</a></center></h3>
+\endhtmlonly
 
-The <B>Synthesis ToolKit in C++ (STK)</B> is a set of open source audio signal processing and algorithmic synthesis classes written in C++.  STK was designed to facilitate rapid development of music synthesis and audio processing software, with an emphasis on cross-platform functionality, realtime control, ease of use, and educational example code.  The Synthesis ToolKit is extremely portable (it's mostly platform-independent C and C++ code), and it's completely user-extensible (all source included, no unusual libraries, and no hidden drivers).  We like to think that this increases the chances that our programs will still work in another 5-10 years.  In fact, the ToolKit has been working continuously for nearly 8 years now.  STK currently runs with "realtime" support (audio and MIDI) on SGI (Irix), Linux, Macintosh OS X, and Windows computer platforms.  Generic, non-realtime support has been tested under NeXTStep, Sun, and other platforms and should work with any standard C++ compiler.
+The <B>Synthesis ToolKit in C++ (STK)</B> is a set of open source
+audio signal processing and algorithmic synthesis classes written in
+the C++ programming language.  STK was designed to facilitate rapid
+development of music synthesis and audio processing software, with an
+emphasis on cross-platform functionality, realtime control, ease of
+use, and educational example code.  The Synthesis ToolKit is extremely
+portable (it's mostly platform-independent C and C++ code), and it's
+completely user-extensible (all source included, no unusual libraries,
+and no hidden drivers).  We like to think that this increases the
+chances that our programs will still work in another 5-10 years.  In
+fact, the ToolKit has been working continuously for nearly 20 years
+now.  STK currently runs with realtime support (audio and MIDI) on
+Linux, Macintosh OS X, and Windows computer platforms.  Generic,
+non-realtime support has been tested under NeXTStep, Sun, and other
+platforms and should work with any standard C++ compiler.
 
 - \ref information
 - \ref classes
@@ -11,6 +28,7 @@ The <B>Synthesis ToolKit in C++ (STK)</B> is a set of open source audio signal p
 - \ref maillist
 - \ref system
 - \ref links
+- \ref faq
 - \ref tutorial
 
 */
@@ -18,4 +36,5 @@ The <B>Synthesis ToolKit in C++ (STK)</B> is a set of open source audio signal p
 <P>
 <FONT SIZE=-1>
 STK is a registered trademark of Analytical Graphics, Inc., 40 General Warren Blvd., Malvern, PA 19355, the manufacturer of the Satellite Tool Kit<69> (STK<54>) family of satellite simulation software.  Although the term "STK" is used in this website, the content of this site is in no way related to Analytical Graphics, Inc, or its registered STK mark.  Nothing in this website should be construed to mean that a business relationship, either past or present, exists between Analytical Graphics, Inc. and the owners of this particular website.
-</FONT>
+</FONT>
+

doc/doxygen/information.txt

@@ -2,49 +2,132 @@
 
 <H3>References</H3>
 <UL>
-<LI><A HREF="Papers/stkicmc99.pdf">ICMC99 Paper</A></LI>
+<LI><A HREF="papers/stkupdate.pdf">ICMC2005 Paper</A></LI>
 <BR>
-A somewhat recent paper by Perry and Gary about the Synthesis ToolKit in C++.
+A paper by Gary and Perry detailing recent updates to the Synthesis ToolKit in C++.
 <P>
-<LI><A HREF="Papers/STKsiggraph96.pdf">SIGGRAPH96 Paper</A></LI>
+<LI><A HREF="papers/stkicmc99.pdf">ICMC99 Paper</A></LI>
 <BR>
-A not-so-recent paper by Perry about the Synthesis ToolKit in C++.
+A not-so-recent paper by Perry and Gary about the Synthesis ToolKit in C++.
 <P>
-<LI><A HREF="http://www.cs.princeton.edu/~prc/NewWork.html#STK">Perry's STK Web Page</A></LI>
+<LI>Book Chapter: <A HREF="http://www.akpeters.com/product.asp?ProdCode=1047">Audio Anecdotes</A></LI>
 <BR>
-This is a link to Perry Cook's STK Web page.  He has information about the \ref skini, the protocol used to control STK instruments, as well as a lot of other cool stuff.
+Here's a link to a book that includes an chapter on STK.
 </UL>
 
 
 <H4>What is the <I>Synthesis ToolKit</I>?</H4>
 
-The Synthesis ToolKit in C++ (STK) is a set of open source audio signal processing and algorithmic synthesis classes written in C++.  STK was designed to facilitate rapid development of music synthesis and audio processing software, with an emphasis on cross-platform functionality, realtime control, ease of use, and educational example code.  The Synthesis ToolKit is extremely portable (it's mostly platform-independent C and C++ code), and it's completely user-extensible (all source included, no unusual libraries, and no hidden drivers).  We like to think that this increases the chances that our programs will still work in another 5-10 years.  In fact, the ToolKit has been working continuously for nearly 8 years now.  STK currently runs with "realtime" support (audio and MIDI) on SGI (Irix), Linux, Macintosh OS X, and Windows computer platforms.  Generic, non-realtime support has been tested under NeXTStep, Sun, and other platforms and should work with any standard C++ compiler.
+The Synthesis ToolKit in C++ (STK) is a set of open source audio signal processing and algorithmic synthesis classes written in the C++ programming language.  STK was designed to facilitate rapid development of music synthesis and audio processing software, with an emphasis on cross-platform functionality, realtime control, ease of use, and educational example code.  The Synthesis ToolKit is extremely portable (it's mostly platform-independent C and C++ code), and it's completely user-extensible (all source included, no unusual libraries, and no hidden drivers).  We like to think that this increases the chances that our programs will still work in another 5-10 years.  In fact, the ToolKit has been working continuously for nearly 20 years now.  STK currently runs with realtime support (audio and MIDI) on Linux, Macintosh OS X, and Windows computer platforms.  Generic, non-realtime support has been tested under NeXTStep, Sun, and other platforms and should work with any standard C++ compiler.
 
-The Synthesis ToolKit is free for non-commercial use.  The only parts of the Synthesis ToolKit that are platform-dependent concern real-time audio and MIDI input and output, and that is taken care of with a few special classes.  The interface for MIDI input and the simple <A HREF="http://dev.scriptics.com">Tcl/Tk</A> graphical user interfaces (GUIs) provided is the same, so it's easy to experiment in real time using either the GUIs or MIDI.  The Synthesis ToolKit can generate simultaneous SND (AU), WAV, AIFF, and MAT-file output soundfile formats (as well as realtime sound output), so you can view your results using one of a large variety of sound/signal analysis tools already available (e.g. <A HREF="http://www-ccrma.stanford.edu/software/snd/">Snd</A>, Cool Edit, Matlab). 
+The Synthesis ToolKit is free.  The only parts of the Synthesis ToolKit that are platform-dependent concern real-time audio and MIDI input and output, and that is taken care of with a few special classes.  The interface for MIDI input and the simple <A HREF="https://www.tcl.tk/">Tcl/Tk</A> graphical user interfaces (GUIs) provided is the same, so it's easy to experiment in real time using either the GUIs or MIDI.  The Synthesis ToolKit can generate simultaneous SND (AU), WAV, AIFF, and MAT-file output soundfile formats (as well as realtime sound output), so you can view your results using one of a large variety of sound/signal analysis tools already available (e.g. <A HREF="http://www-ccrma.stanford.edu/software/snd/">Snd</A>, Cool Edit, Matlab). 
 
 
 <H4>What the <I>Synthesis ToolKit</I> is not.</H4>
 
-The Synthesis Toolkit is not one particular program.  Rather, it is a set of C++ classes that you can use to create your own programs.  A few example applications are provided to demonstrate some of the ways to use the classes.  If you have specific needs, you will probably have to either modify the example programs or write a new program altogether. Further, the example programs don't have a fancy GUI wrapper. If you feel the need to have a "drag and drop" graphical patching GUI, you probably don't want to use the ToolKit. Spending hundreds of hours making platform-dependent graphics code would go against one of the fundamental design goals of the ToolKit - platform independence. 
+The Synthesis Toolkit is not one particular program.  Rather, it is a set of C++ classes that you can use to create your own programs.  A few example applications are provided to demonstrate some of the ways to use the classes.  If you have specific needs, you will probably have to either modify the example programs or write a new program altogether. Further, the example programs don't have a fancy GUI wrapper.  It is easy to embed STK classes inside a GUI environment but we have chosen to focus our energy on the audio signal processing issues.  Spending hundreds of hours making platform-dependent graphical user interfaces would go against one of the fundamental design goals of the ToolKit - platform independence.
 
-For those instances where a simple GUI with sliders and buttons is helpful, we use <A HREF="http://dev.scriptics.com">Tcl/Tk</A> (which is freely distributed for all the supported ToolKit platforms). A number of Tcl/Tk GUI scripts are distributed with the ToolKit release.  For control, the Synthesis Toolkit uses raw MIDI (on supported platforms), and SKINI (Synthesis ToolKit Instrument Network Interface, a MIDI-like text message synthesis control format).
+For those instances where a simple GUI with sliders and buttons is helpful, we use <A HREF="https://www.tcl.tk/">Tcl/Tk</A> (that is freely distributed for all the supported ToolKit platforms). A number of Tcl/Tk GUI scripts are distributed with the ToolKit release.  For control, the Synthesis Toolkit uses raw MIDI (on supported platforms), and SKINI (Synthesis ToolKit Instrument Network Interface, a MIDI-like text message synthesis control format).
 
 <H4>A brief history of the <I>Synthesis ToolKit in C++.</I></H4>
 
-Perry Cook began developing a pre-cursor to the Synthesis ToolKit (also called STK) under NeXTStep at the Center for Computer Research in Music and Acoustics (CCRMA) at Stanford University in the early-1990s.  With his move to Princeton University in 1996, he ported everything to C++ on SGI hardware, added real-time capabilities, and greatly expanded the synthesis techniques available.  With the help of Bill Putnam, Perry also made a port of STK to Windows95.  Gary Scavone began using STK extensively in the summer of 1997 and completed a full port of STK to Linux early in 1998. He finished the fully compatable Windows port (using Direct Sound API) in June 1998.  Numerous improvements and extensions have been made since then.
+Perry Cook began developing a pre-cursor to the Synthesis ToolKit
+(also called STK) under NeXTStep at the Center for Computer Research
+in Music and Acoustics (CCRMA) at Stanford University in the
+early-1990s.  With his move to Princeton University in 1996, he ported
+everything to C++ on SGI hardware, added real-time capabilities, and
+greatly expanded the synthesis techniques available.  With the help of
+Bill Putnam, Perry also made a port of STK to Windows95.  Gary Scavone
+began using STK extensively in the summer of 1997 and completed a full
+port of STK to Linux early in 1998. He finished the fully compatible
+Windows port (using DirectSound API) in June 1998.  Numerous
+improvements and extensions have been made since then.
 
-The Toolkit has been distributed continuously since 1996 via the <A HREF="http://www.music.princeton.edu/psk">Princeton Sound Kitchen</A>, <A HREF="http://www.cs.princeton.edu/~prc">Perry Cook's home page</A> at Princeton, <A HREF="http://www-ccrma.stanford.edu/~gary/">Gary Scavone's home page</A> at Stanford's Center for Computer Research in Music and Acoustics (CCRMA), and the <A HREF="http://www-ccrma.stanford.edu/software/stk">Synthesis ToolKit home page</A>.  The ToolKit has been in included in various collections of software.  Much of it has also been ported to MAX/MSP on Macintosh computers by Dan Trueman and Luke Dubois of Columbia University, and is distributed as <A HREF="http://music.columbia.edu/PeRColate">PeRColate</A>.  Help on real-time sound and MIDI has been provided by Tim Stilson, Bill Putnam, and Gabriel Maldonado.
+The Toolkit has been distributed continuously since 1996 via the <A
+HREF="http://www.music.princeton.edu/psk">Princeton Sound Kitchen</A>,
+<A HREF="http://www.cs.princeton.edu/~prc">Perry Cook's home page</A>
+at Princeton, <A HREF="http://www.music.mcgill.ca/~gary/">Gary
+Scavone's home page</A> at McGill University, and the <A HREF="http://ccrma.stanford.edu/software/stk">Synthesis ToolKit
+home page</A>.  The ToolKit has been included in various collections
+of software.  Much of it has also been ported to Max/MSP on Macintosh
+computers by Dan Trueman and Luke Dubois of Columbia University, and
+is distributed as <A
+HREF="http://music.columbia.edu/PeRColate">PeRColate</A>.  Help on
+real-time sound and MIDI has been provided over the years by Tim
+Stilson, Bill Putnam, and Gabriel Maldonado.
 
 <H4>Legal and Ethical Notes</H4>
 
-This software was designed and created to be made publicly available for free, primarily for academic purposes, so if you use it, pass it on with this documentation, and for free.  If you make a million dollars with it, give us some.  If you make compositions with it, put us in the program notes.
-<P>
+This software was designed and created to be made publicly available
+for free, primarily for academic purposes, so if you use it, pass it
+on with this documentation, and for free.  If you make a million
+dollars with it, it would be nice if you would share.  If you make
+compositions with it, put us in the program notes.
 
-Some of the concepts are covered by various patents, some known to us and likely others which are unknown.  Many of the ones known to us are administered by the Stanford Office of Technology and Licensing.  The good news is that large hunks of the techniques used here are public domain.  To avoid subtle legal issues, we will not state what's freely useable here, but we will try to note within the various classes where certain things are likely to be protected by patents.
+Some of the concepts are covered by various patents, some known to us
+and likely others that are unknown.  Many of the ones known to us are
+administered by the Stanford Office of Technology and Licensing.  The
+good news is that large hunks of the techniques used here are public
+domain.  To avoid subtle legal issues, we will not state what's freely
+useable here, but we will try to note within the various classes where
+certain things are likely to be protected by patents.
 
+<H4>License</H4>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+Any person wishing to distribute modifications to the Software is
+asked to send the modifications to the original developer so that they
+can be incorporated into the canonical version.  This is, however, not
+a binding provision of this license.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 <H4>Disclaimer</H4>
 
-STK is free and we do not guarantee anything.  We've been hacking on this code for a while now and most of it seems to work pretty well.  But, there surely are some bugs floating around.  Sometimes things work fine on one computer platform but not so fine on another.  FPU overflows and underflows cause <I>very</I> weird behavior which also depends on the particular CPU and OS.  Let us know about bugs you find and we'll do our best to correct them.
+STK is free and we do not guarantee anything.  We've been hacking on this code for a while now and most of it seems to work pretty well.  But, there surely are some bugs floating around.  Sometimes things work fine on one computer platform but not so fine on another.  FPU overflows and underflows cause <I>very</I> weird behavior that also depends on the particular CPU and OS.  Let us know about bugs you find and we'll do our best to correct them.
 
-*/
+<H4>Perry's Notes From the Original Distribution of STK</H4>
+
+This whole world was created with no particular hardware in mind.  These examples are intended to be tutorial in nature, as a platform for the continuation of my research, and as a possible starting point for a software synthesis system.  The basic motivation was to create the necessary unit generators to do the synthesis, processing, and control that I want to do and teach about.  Little thought for optimization was given and therefore improvements, especially speed enhancements, should be possible with these classes.  It was written with some basic concepts in mind about how to let compilers optimize.
+
+Your question at this point might be, "But Perry, with CMix, CMusic, CSound, CShells, CMonkeys, etc. already cluttering the landscape, why a new set of stupid C functions for music synthesis and processing?"  The answers lie below.
+
+<ol>
+<li>I needed to port many of the things I've done into something that is generic enough to port further to different machines.</li>
+
+<li>I really plan to document this stuff, so that you don't have to be me to figure out what's going on. (I'll probably be sorry I said this in a couple of years, when even I can't figure out what I was thinking.)</li>
+
+<li>The classic difficulties most people have in trying to implement physical models are:
+
+<ul>
+<li>They have trouble understanding the papers, and/or in turning the theory into practice.</li>
+
+<li>The physical model instruments are a pain to get to oscillate, and coming up with stable and meaningful parameter values is required to get the models to work at all.</li>
+</ul>
+
+This set of C++ unit generators and instruments might help to diminish the scores of emails I get asking what to do with those block diagrams I put in my papers.</li>
+
+<li>I wanted to try some new stuff with modal synthesis, and implement some classic FM patches as well.</li>
+
+<li>I wanted to reimplement, and newly implement more of the intelligent and physical performer models I've talked about in some of my papers. But I wanted to do it in a portable way, and in such a way that I can hook up modules quickly.  I also wanted to make these instruments connectable to such player objects, so folks like Brad Garton who really think a lot about the players can connect them to my instruments, a lot about which I think.</li>
+
+<li>More rationalizations to follow ...</li>
+</ol>
+
+*/

doc/doxygen/instruments.txt

@@ -1,73 +1,19 @@
 /*! \page instruments Instruments
 
-The ToolKit comes with a wide variety of synthesis algorithms, all of which inherit from the Instrmnt class.  In this example, we'll fire up an instance of the BeeThree FM synthesis class and show how it's frequency can be modified over time.
+The ToolKit comes with a wide variety of synthesis algorithms, all of which inherit from the stk::Instrmnt class.  In this example, we'll fire up an instance of the stk::BeeThree FM synthesis class and show how its frequency can be modified over time.
 
-\code
-// bethree.cpp
+\include bethree.cpp
 
-#include "BeeThree.h"
-#include "RtWvOut.h"
+We have used an Instrmnt pointer when referencing the BeeThree
+instance above, so it would be simple to replace the BeeThree class
+with any other STK instrument class.  It should be noted, however,
+that a few classes do not respond to the setFrequency() function
+(e.g., Shakers, Drummer).
 
-int main()
-{
-  // Set the global sample rate before creating class instances.
-  Stk::setSampleRate( 44100.0 );
-
-  Instrmnt *instrument = 0;
-  RtWvOut *output = 0;
-  MY_FLOAT frequency, amplitude, scaler;
-  long counter, i;
-
-  try {
-    // Define and load the BeeThree instrument
-    instrument = new BeeThree();
-
-    // Define and open the default realtime output device for one-channel playback
-    output = new RtWvOut(1);
-  }
-  catch (StkError &) {
-    goto cleanup;
-  }
-
-  scaler = 1.0;
-  frequency = 220.0;
-  amplitude = 0.5;
-  instrument->noteOn( frequency, amplitude );
-
-  // Play the instrument for 80000 samples, changing the frequency every 2000 samples
-  counter = 0;
-  while ( counter < 80000 ) {
-    for ( i=0; i<2000; i++ ) {
-      try {
-        output->tick( instrument->tick() );
-      }
-      catch (StkError &) {
-        goto cleanup;
-      }
-    }
-
-    counter += 2000;
-    scaler += 0.025;
-    instrument->setFrequency( frequency * scaler );
-  }
-
-  // Turn the instrument off with maximum decay envelope.
-  instrument->noteOff( 1.0 );
-
- cleanup:
-  delete instrument;
-  delete output;
-
-  return 0;
-}
-\endcode
-
-We have used an Instrmnt pointer when referencing the BeeThree instance above, so it would be simple to replace the BeeThree class with any other STK instrument class.  It should be noted, however, that a few classes do not respond to the setFrequency() function (e.g., Shakers, Drummer).
-
-The noteOn() function initiates an instrument attack.  Instruments which are continuously excited (e.g., Clarinet, BeeThree) will continue to sound until stopped with a noteOff().  Impulsively excited instrument sounds (e.g., Plucked, Wurley) typically decay within a few seconds time, requiring subsequent noteOn() messages for re-attack.
+The noteOn() function initiates an instrument attack.  Instruments that are continuously excited (e.g., stk::Clarinet, stk::BeeThree) will continue to sound until stopped with a noteOff().  Impulsively excited instrument sounds (e.g., stk::Plucked, stk::Wurley) typically decay within a few seconds time, requiring subsequent noteOn() messages for re-attack.
 
 Instrument parameters can be precisely controlled as demonstrated above.  A more flexible approach to instrument control, allowing arbitrary scorefile or realtime updates, is described in the next tutorial chapter.
 
-[<A HREF="controlin.html">Next tutorial</A>] &nbsp; [<A HREF="tutorial.html">Main tutorial page</A>]
+[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="controlin.html">Next tutorial</A>]
 */
 

doc/doxygen/links.txt

@@ -1,11 +1,25 @@
 /*! \page links Miscellaneous Links
 
-- <A HREF="http://www-ccrma.stanford.edu/~gary/rtaudio/">The RtAudio WWW site</A>
+- <A HREF="http://www.music.mcgill.ca/~gary/rtaudio/">The %RtAudio WWW site</A>
 
-- <A HREF="http://kern.humdrum.net/">Kern Scores: A Library of Electronic Musical Scores</A> (with automatic conversion to SKINI format)
+- <A HREF="http://www.music.mcgill.ca/~gary/rtmidi/">The %RtMidi WWW site</A>
+
+- <A HREF="http://momu.stanford.edu/stk/">MoMu-Stk: A lightly modified version of STK that supports the iPhone platform (iPhone, iPad, iPod Touches)</A>
+
+- <A HREF="http://ccrma.stanford.edu/~woony/software/stkx/">StkX: A Cocoa STK Framework for Mac OS X by Woon Seung Yeo</A>
+
+- <A HREF="http://sourceforge.net/projects/mobilestk">Mobile STK: A port of STK for mobile devices by Georg Essl and Michael Rohs</A>
+
+- <A HREF="http://chuck.cs.princeton.edu/">ChucK: Concurrent, On-the-fly Audio Programming Language</A> using STK unit generators
+
+- <A HREF="http://kern.ccarh.org">Kern Scores: A Library of Electronic Musical Scores</A> (with automatic conversion to SKINI format)
+
+- <A HREF="http://stk.sapp.org/midi2skini">MIDI to SKINI file converter</A> by Craig Sapp
+
+- <A HREF="http://extra.humdrum.org/example/kern2skini/">Kern Score to SKINI file converter</A> by Craig Sapp
 
 - <A HREF="http://www.music.columbia.edu/PeRColate/">PeRColate: A Port of STK for Max/MSP</A>
 
-- <A HREF="http://mathmorphs.swiki.net/32/">A Partial Port of STK to Squeak</A>
+- <a href="http://airy.andre.online.fr/AU/index.html">AUStk: a demo of integration of STK instruments into an AudioUnit</a> by Airy Andre
 
-*/
+*/

doc/doxygen/maillist.txt

@@ -2,6 +2,8 @@
 
 An <A HREF="mailto:stk-request@ccrma.stanford.edu">STK</A> mailing list has been set up to facilitate communication among STK users.  Subscribing to this list is your best way of keeping on top of new releases, bug fixes, and various user developments. 
 <P>
+For answers to frequently asked questions, check the list <A HREF="http://ccrma-mail.stanford.edu/pipermail/stk/">archives</A>.
+<P>
 To join send a message to <A HREF="mailto:stk-request@ccrma.stanford.edu">&lt;stk-request@ccrma.stanford.edu&gt;</A>
 with the contents:   <TT>subscribe</TT>
 

doc/doxygen/multichannel.txt

@@ -1,70 +1,30 @@
 /*! \page multichannel Multi-Channel I/O
 
-The ToolKit WvIn and WvOut classes (and their subclasses) support multi-channel audio data input and output.  A set of interleaved audio samples representing a single time "slice" is referred to as a <I>sample frame</I>.  At a sample rate of 44.1 kHz, a four-channel audio stream will have 44100 sample frames per second and a total of 176400 individual samples per second.
+The ToolKit stk::WvIn and stk::WvOut classes (and their subclasses) support multi-channel audio data input and output.  Several other abstract base classes, such as stk::Instrmnt, stk::Generator, and stk::Effect, also support multi-channel computations though not all of their subclasses produce or take multi-channel data.  A set of interleaved audio samples representing a single time "slice" is referred to as a <I>sample frame</I>.  At a sample rate of 44.1 kHz, a four-channel audio stream will have 44100 sample frames per second and a total of 176400 individual samples per second.
 
-Most STK classes process single-sample data streams via their <TT>tick()</TT> function.  In order to distinguish single-sample and sample frame calculations, the WvIn and WvOut classes implement both <TT>tick()</TT> and <TT>tickFrame()</TT> functions.  The <TT>tickFrame()</TT> functions take or return a pointer to an array of audio data representing one or more sample frames.  For single-channel streams, the <TT>tick()</TT> and <TT>tickFrame()</TT> functions produce equivalent results.  When <TT>tick()</TT> is called for a multi-channel stream, however, the function either returns a sample frame average (WvIn) or writes a single sample argument to all channels (WvOut).
+Most STK classes process single-sample data streams via their
+<TT>tick()</TT> function.  For classes supporting multi-channel data,
+one must distinguish the <TT>tick()</TT> functions taking or producing
+single \c StkFloat arguments from those taking stk::StkFrames& arguments.  If
+a single-sample version of the <TT>tick()</TT> function is called for
+these classes, a full sample frame is computed but only a single value
+is either input and/or output.  For example, if the single-sample
+<TT>tick()</TT> function is called for subclasses of WvOut, the sample
+argument is written to all channels in the one computed frame.  For
+classes returning values, an optional \c channel argument specifies
+which channel value is returned from the computed frame (the default
+is always channel 0). To input and/or output multichannel data to
+these classes, the overloaded <TT>tick()</TT> functions taking
+StkFrames reference arguments should be used.
 
 Multi-channel support for realtime audio input and output is dependent on the audio device(s) available on your system.
 
-The following example demonstrates the use of the WvOut class for creating a four channel, 16-bit AIFF formatted audio file.  We will use four sinewaves of different frequencies for the first two seconds and then a single sinewave for the last two seconds.
+The following example demonstrates the use of the stk::FileWvOut class for
+creating a four channel, 16-bit AIFF formatted audio file.  We will
+use four sinewaves of different frequencies for the first two seconds
+and then a single sinewave for the last two seconds.
 
-\code
-// foursine.cpp
+\include foursine.cpp
 
-#include "WaveLoop.h"
-#include "WvOut.h"
-
-int main()
-{
-  // Set the global sample rate before creating class instances.
-  Stk::setSampleRate( 44100.0 );
-
-  int i, j;
-  WvOut *output = 0;
-  WaveLoop *inputs[4];
-  for ( i=0; i<4; i++ ) inputs[i] = 0;
-
-  // Define and load the sine waves
-  try {
-    for ( i=0; i<4; i++ ) {
-      inputs[i] = new WaveLoop( "rawwaves/sinewave.raw", TRUE );
-      inputs[i]->setFrequency( 220.0 * (i+1) );
-    }
-  }
-  catch (StkError &) {
-    goto cleanup;
-  }
-
-  // Define and open a 16-bit, four-channel AIFF formatted output file
-  try {
-    output = new WvOut( "foursine.aif", 4, WvOut::WVOUT_AIF, Stk::STK_SINT16 );
-  }
-  catch (StkError &) {
-    goto cleanup;
-  }
-
-  // Write two seconds of four sines to the output file
-  MY_FLOAT frame[4];
-  for ( j=0; j<88200; j++ ) {
-    for ( i=0; i<4; i++ )
-      frame[i] = inputs[i]->tick();
-
-    output->tickFrame( frame );
-  }
-
-  // Now write the first sine to all four channels for two seconds
-  for ( j=0; j<88200; j++ ) {
-    output->tick( inputs[0]->tick() );
-  }
-
- cleanup:
-  for ( i=0; i<4; i++ ) delete inputs[i];
-  delete output;
-
-  return 0;
-}
-\endcode
-
-
-[<A HREF="polyvoices.html">Next tutorial</A>] &nbsp; [<A HREF="tutorial.html">Main tutorial page</A>]
+[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="polyvoices.html">Next tutorial</A>]
 */

doc/doxygen/polyvoices.txt

@@ -1,122 +1,22 @@
 /*! \page polyvoices Voice Management
 
-The previous tutorial chapters were concerned only with monophonic ToolKit instrument playback and control.  At this point, it should be relatively clear that one can instantiate multiple instruments and perhaps sum together their sounds or even direct their sounds to separate output channels.  It is less clear how one might go about controlling a group of instruments.  The Voicer class is designed to serve just this purpose.
+The previous tutorial chapters were concerned only with monophonic ToolKit instrument playback and control.  At this point, it should be relatively clear that one can instantiate multiple instruments and perhaps sum together their outputs or even direct their outputs to separate channels.  It is less clear how one might go about controlling a group of instruments.  The stk::Voicer class is designed to serve just this purpose.
 
-The STK Voicer class is a relatively simple voice manager.  The user can dynamically add and delete instruments from its "control", with the option of controlling specific instruments via unique note tags and/or grouping sets of instruments via a "channel" number.  All sounding instrument outputs are summed and returned via the <TT>tick()</TT> function.  The Voicer class responds to noteOn, noteOff, setFrequency, pitchBend, and controlChange messages, automatically assigning incoming messages to the voices in its control.  When all voices are sounding and a new noteOn is encountered, the Voicer interrupts the oldest sounding voice.  The user is responsible for creating and deleting all instrument instances.
+The stk::Voicer class is a relatively simple voice manager.  The user can dynamically add and delete instruments to/from its "control", with the option of controlling specific instruments via unique note tags and/or grouping sets of instruments via a "group" number.  All sounding instrument outputs are summed and returned via the <TT>tick()</TT> function.  The stk::Voicer class responds to noteOn, noteOff, setFrequency, pitchBend, and controlChange messages, automatically assigning incoming messages to the voices in its control.  When all voices are sounding and a new noteOn is encountered, the stk::Voicer interrupts the oldest sounding voice.  The user is responsible for creating and deleting all instrument instances.
 
-In the following example, we modify the <TT>controlbee.cpp</TT> program to make use of three BeeThree instruments, all controlled using a Voicer.
+In the following example, we modify the <TT>controlbee.cpp</TT> program to make use of three stk::BeeThree instruments, all controlled using a stk::Voicer.
+
+\include threebees.cpp
+
+We have written this program to accept control messages from \c STDIN.  Assuming the program is compiled as <TT>threebees</TT>, the three-voice SKINI scorefile <A HREF="tutorial/bachfugue.ski"><TT>bachfugue.ski</TT></A> (located in the <tt>scores</tt> directory with the examples) can be redirected to the program as:
 
 \code
-// threebees.cpp
-
-#include "BeeThree.h"
-#include "RtWvOut.h"
-#include "Messager.h"
-#include "Voicer.h"
-#include "SKINI.msg"
-
-int main()
-{
-  // Set the global sample rate before creating class instances.
-  Stk::setSampleRate( 44100.0 );
-
-  int i;
-  RtWvOut *output = 0;
-  Messager *messager = 0;
-  Voicer *voicer = 0;
-  bool done = FALSE;
-  Instrmnt *instrument[3];
-  for ( i=0; i<3; i++ ) instrument[i] = 0;
-
-  try {
-    // Define and load the BeeThree instruments
-    for ( i=0; i<3; i++ )
-      instrument[i] = new BeeThree();
-
-    // Define and open the default realtime output device for one-channel playback
-    output = new RtWvOut(1);
-  }
-  catch (StkError &) {
-    goto cleanup;
-  }
-
-  try {
-    // Create a Messager instance to read from a redirected SKINI scorefile.
-    messager = new Messager();
-  }
-  catch (StkError &) {
-    goto cleanup;
-  }
-
-  // Instantiate the voicer for a maximum of three voices.
-  voicer = new Voicer( 3 );
-  for ( i=0; i<3; i++ )
-    voicer->addInstrument( instrument[i] );
-
-  // Play the instrument until the end of the scorefile.
-  int nTicks, type;
-  MY_FLOAT byte2, byte3;
-  while (!done) {
-
-    // Look for new messages and return a delta time (in samples).
-    type = messager->nextMessage();
-    if (type < 0)
-      done = TRUE;
-
-    nTicks = messager->getDelta();
-    try {
-      for ( i=0; i<nTicks; i++ )
-        output->tick( voicer->tick() );
-    }
-    catch (StkError &) {
-      goto cleanup;
-    }
-
-    if ( type > 0 ) {
-      // Process the new control message.
-      byte2 = messager->getByteTwo();
-      byte3 = messager->getByteThree();
-
-      switch(type) {
-
-      case __SK_NoteOn_:
-        voicer->noteOn( byte2, byte3 );
-        break;
-
-      case __SK_NoteOff_:
-        voicer->noteOff( byte2, byte3 );
-        break;
-
-      case __SK_ControlChange_:
-        voicer->controlChange( (int) byte2, byte3 );
-        break;
-
-      case __SK_AfterTouch_:
-        voicer->controlChange( 128, byte2 );
-        break;
-      }
-    }
-  }
-
- cleanup:
-  for ( i=0; i<3; i++ ) delete instrument[i];
-  delete output;
-  delete messager;
-  delete voicer;
-
-  return 0;
-}
+threebees < scores/bachfugue.ski
 \endcode
 
-Assuming the program is compiled as <TT>threebees</TT>, the three-voice SKINI scorefile <A HREF="tutorial/bachfugue.ski"><TT>bachfugue.ski</TT></A> could be redirected to the program as:
+For more fun, surf to <A HREF="http://kern.ccarh.org/">Kern Scores</A> for a huge assortment of other scorefiles that can be downloaded in the SKINI format.
 
-\code
-threebees < bachfugue.ski
-\endcode
-
-For more fun, surf to <A HREF="http://kern.humdrum.net/">Kern Scores</A> for a huge assortment of other scorefiles which can be downloaded in the SKINI format.
-
-Another easy extension would be to use the <TT>STK_MIDI</TT> constructor argument to the Messager class and then play the instruments via a MIDI keyboard.
+Another easy extension would be to add the \c stk::Messager::startMidiInput() function to the program and then play the instruments via a MIDI keyboard.
 
 [<A HREF="tutorial.html">Main tutorial page</A>]
 */

doc/doxygen/realtime.txt

@@ -1,72 +1,49 @@
-/*! \page realtime Realtime Audio
+/*! \page realtime Realtime Audio (blocking)
 
-In this section, we modify the <TT>sineosc.cpp</TT> program in order to send the output to the default audio playback device on your system.
+In this section, we modify the <TT>sineosc.cpp</TT> program in order
+to send the output to the default audio playback device on your
+computer system.  We also make use of the stk::SineWave class as a
+sine-wave oscillator.  stk::SineWave computes an internal, static sine-wave
+table when its first instance is created.  Subsequent instances make
+use of the same table.  The default table length, specified in
+SineWave.h, is 2048 samples.
+
+\include rtsine.cpp
+
+The class stk::RtWvOut is a protected subclass of stk::WvOut.  A number of
+optional constructor arguments can be used to fine tune its
+performance for a given system.  stk::RtWvOut provides a "single-sample",
+blocking interface to the RtAudio class.  Note that stk::RtWvOut (as well
+as the stk::RtWvIn class described below) makes use of RtAudio's callback
+input/output functionality by creating a large ring-buffer into which
+data is written.  These classes should not be used when low-latency
+and robust performance is necessary
+
+Though not used here, an stk::RtWvIn class exists as well that can be used
+to read realtime audio data from an input device.  See the
+<TT>record.cpp</TT> example program in the <TT>examples</TT> project
+for more information.
+
+It may be possible to use an instance of stk::RtWvOut and an instance of
+stk::RtWvIn to simultaneously read and write realtime audio to and from a
+hardware device or devices.  However, it is recommended to instead use
+a single instance of RtAudio to achieve this behavior, as described in the next section.
+See the <TT>effects</TT> project or the <TT>duplex.cpp</TT> example
+program in the <TT>examples</TT> project for more information.
+
+When using any realtime STK class (RtAudio, stk::RtWvOut, stk::RtWvIn, RtMidi, stk::InetWvIn, stk::InetWvOut, stk::Socket, stk::UdpSocket, stk::TcpServer, stk::TcpClient, and stk::Thread), it is necessary to specify an audio/MIDI API preprocessor definition and link with the appropriate libraries or frameworks.  For example, the above program could be compiled on a Linux system using the GNU g++ compiler and the ALSA audio API as follows (assuming all necessary files exist in the project directory):
 
 \code
-// rtsine.cpp
-
-#include "WaveLoop.h"
-#include "RtWvOut.h"
-
-int main()
-{
-  // Set the global sample rate before creating class instances.
-  Stk::setSampleRate( 44100.0 );
-
-  WaveLoop *input = 0;
-  RtWvOut *output = 0;
-
-  try {
-    // Define and load the sine wave file
-    input = new WaveLoop( "rawwaves/sinewave.raw", TRUE );
-
-    // Define and open the default realtime output device for one-channel playback
-    output = new RtWvOut(1);
-  }
-  catch (StkError &) {
-    goto cleanup;
-  }
-
-  input->setFrequency(440.0);
-
-  // Play the oscillator for 40000 samples
-  int i;
-  for ( i=0; i<40000; i++ ) {
-    try {
-      output->tick(input->tick());
-    }
-    catch (StkError &) {
-      goto cleanup;
-    }
-  }
-
- cleanup:
-  delete input;
-  delete output;
-
-  return 0;
-}
-\endcode
-
-The class RtWvOut is a protected subclass of WvOut.  A number of optional constructor arguments can be used to fine tune its performance for a given system.
-
-Though not used here, an RtWvIn class exists as well which can be used to read realtime audio data from an input device.  See the <TT>record.cpp</TT> example program in the <TT>examples</TT> project for more information.
-
-It is possible to use an instance of RtWvOut and an instance of RtWvIn to simultaneously read and write realtime audio to and from a hardware device or devices.  However, it is recommended to instead use a single instance of RtDuplex to achieve this behavior, in that it guarantees better synchronization between the input and output data.  See the <TT>effects</TT> project or the <TT>io.cpp</TT> example program in the <TT>examples</TT> project for more information.
-
-When using any realtime STK class (RtAudio, RtWvOut, RtWvIn, RtDuplex, RtMidi, TcpWvIn, TcpWvOut, Socket, and Thread), it is necessary to specify an audio/MIDI API preprocessor definition and link with the appropriate libraries or frameworks.  For example, the above program could be compiled on a Linux system using the GNU g++ compiler and the ALSA audio/MIDI API as follows (assuming all necessary files exist in the project directory):
-
-\code
-g++ -Wall -D__LINUX_ALSA__ -D__LITTLE_ENDIAN__ -o rtsine Stk.cpp WvIn.cpp WaveLoop.cpp WvOut.cpp \
-    RtWvOut.cpp RtAudio.cpp rtsine.cpp -lpthread -lasound -lstk
+g++ -Wall -D__LINUX_ALSA__ -D__LITTLE_ENDIAN__ -o rtsine Stk.cpp Generator.cpp SineWave.cpp WvOut.cpp \
+    RtWvOut.cpp RtAudio.cpp rtsine.cpp -lpthread -lasound
 \endcode
 
 On a Macintosh OS X system, the syntax would be:
 
 \code
-CC -D__MACOSX_CORE__ -o rtsine Stk.cpp WvIn.cpp WaveLoop.cpp WvOut.cpp RtWvOut.cpp RtAudio.cpp \
-   rtsine.cpp -lpthread -lstdc++ -lstk -framework CoreAudio -framework CoreMIDI -framework CoreFoundation
+g++ -Wall -D__MACOSX_CORE__ -o rtsine Stk.cpp Generator.cpp SineWave.cpp WvOut.cpp RtWvOut.cpp RtAudio.cpp \
+   rtsine.cpp -lpthread -framework CoreAudio -framework CoreMIDI -framework CoreFoundation
 \endcode
 
-[<A HREF="instruments.html">Next tutorial</A>] &nbsp; [<A HREF="tutorial.html">Main tutorial page</A>]
+[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="crealtime.html">Next tutorial</A>]
 */

doc/doxygen/skini.txt

@@ -8,7 +8,7 @@ This describes the latest (version 1.1) implementation of SKINI for the Synthesi
           A SKINI haiku.
 \endcode
 
-Profound thanks to Dan Trueman, Brad Garton, and Gary Scavone for input on this revision.  Thanks also to MIDI, the NeXT MusicKit, ZIPI and all the creators and modifiers of these for good bases upon/from which to build and depart.
+Profound thanks to Dan trueman, Brad Garton, and Gary Scavone for input on this revision.  Thanks also to MIDI, the NeXT MusicKit, ZIPI and all the creators and modifiers of these for good bases upon/from which to build and depart.
 
 \section compatibility MIDI Compatibility
 
@@ -16,7 +16,7 @@ SKINI was designed to be MIDI compatible wherever possible, and extend MIDI in i
 
 Differences from MIDI, and motivations, include:
 
-- Text-based messages are used, with meaningful names wherever possible.  This allows any language or system capable of formatted printing to generate SKINI. Similarly, any system capable of reading in a string and turning delimited fields into strings, floats, and ints can consume SKINI for control.  More importantly, humans can actually read, and even write if they want, SKINI files and streams.  Use an editor and search/replace or macros to change a channel or control number.  Load a SKINI score into a spread sheet to apply transformations to time, control parameters, MIDI velocities, etc.  Put a monkey on a special typewriter and get your next great work.  Life's too short to debug bit/nybble packed variable length mumble messages.  Disk space gets cheaper, available bandwidth increases, music takes up so little space and bandwidth compared to video and grapics.  Live a little.
+- Text-based messages are used, with meaningful names wherever possible.  This allows any language or system capable of formatted printing to generate SKINI. Similarly, any system capable of reading in a string and turning delimited fields into strings, floats, and ints can consume SKINI for control.  More importantly, humans can actually read, and even write if they want, SKINI files and streams.  Use an editor and search/replace or macros to change a channel or control number.  Load a SKINI score into a spread sheet to apply transformations to time, control parameters, MIDI velocities, etc.  Put a monkey on a special typewriter and get your next great work.  Life's too short to debug bit/nybble packed variable length mumble messages.  Disk space gets cheaper, available bandwidth increases, music takes up so little space and bandwidth compared to video and graphics.  Live a little.
 
 - Floating point numbers are used wherever possible. Note Numbers, Velocities, Controller Values, and Delta and Absolute Times are all represented and scanned as ASCII double-precision floats.  MIDI byte values are preserved, so that incoming MIDI bytes from an interface can be put directly into SKINI messages.  60.0 or 60 is middle C, 127.0 or 127 is maximum velocity etc.  But, unlike MIDI, 60.5 can cause a 50 cent sharp middle C to be played.  As with MIDI byte values like velocity, use of the integer and SKINI-added fractional parts is up to the implementor of the algorithm being controlled by SKINI messages. But the extra precision is there to be used or ignored.
 
@@ -28,23 +28,25 @@ I am basically a bottom-up designer with an awareness of top-down design ideas,
 
 \section messages SKINI Messages
 
-A basic SKINI message is a line of text.  There are only three required fields, the message type (an ASCII name), the time (either delta or absolute), and the channel number.  Don't freak out and think that this is MIDI channel 0-15 (which is supported), because the channel number is scanned as a long int.  Channels could be socket numbers, machine IDs, serial numbers, or even unique tags for each event in a synthesis.  Other fields might be used, as specified in the SKINI.tbl file.  This is described in more detail later.
+A basic SKINI message is a line of text.  There are only three required fields, the message type (an ASCII name), the time (either delta or absolute), and the channel number.  Don't freak out and think that this is MIDI channel 0-15 (which is supported), because the channel number is scanned as a long int.  Channels could be socket numbers, machine IDs, serial numbers, or even unique tags for each event in a synthesis.  Other fields might be used, as specified in the \c SKINI.tbl file.  This is described in more detail later.
 
 Fields in a SKINI line are delimited by spaces, commas, or tabs.  The SKINI parser only operates on a line at a time, so a newline means the message is over.  Multiple messages are NOT allowed directly on a single line (by use of the ; for example in C).  This could be supported, but it isn't in version 1.1.
 
-Message types include standard MIDI types like NoteOn, NoteOff, ControlChange, etc.  MIDI extension message types (messages which look better than MIDI but actually get turned into MIDI-like messages) include LipTension, StringDamping, etc. Non-MIDI message types include SetPath (sets a path for file use later), and OpenReadFile (for streaming, mixing, and applying effects to soundfiles along with synthesis, for example).  Other non-MIDI message types include Trilling, HammerOn, etc. (these translate to gestures, behaviors, and contexts for use by intellegent players and instruments using SKINI).  Where possible I will still use these as MIDI extension messages, so foot switches, etc. can be used to control them in real time.
+Message types include standard MIDI types like NoteOn, NoteOff, ControlChange, etc.  MIDI extension message types (messages which look better than MIDI but actually get turned into MIDI-like messages) include LipTension, StringDamping, etc. Non-MIDI message types include SetPath (sets a path for file use later), and OpenReadFile (for streaming, mixing, and applying effects to soundfiles along with synthesis, for example).  Other non-MIDI message types include Trilling, HammerOn, etc. (these translate to gestures, behaviors, and contexts for use by intelligent players and instruments using SKINI).  Where possible I will still use these as MIDI extension messages, so foot switches, etc. can be used to control them in real time.
 
-All fields other than type, time, and channel are optional, and the types and useage of the additional fields is defined in the file SKINI.tbl.
+All fields other than type, time, and channel are optional, and the
+types and useage of the additional fields is defined in the file \c
+SKINI.tbl.
 
-The other important file used by SKINI is SKINI.msg, which is a set of #defines to make C code more readable, and to allow reasonably quick re-mapping of control numbers, etc..  All of these defined symbols are assigned integer values.  For Java, the #defines could be replaced by declaration and assignment statements, preserving the look and behavior of the rest of the code.
+The other important file used by SKINI is \c SKINI.msg, which is a set of #defines to make C code more readable, and to allow reasonably quick re-mapping of control numbers, etc..  All of these defined symbols are assigned integer values.  For Java, the #defines could be replaced by declaration and assignment statements, preserving the look and behavior of the rest of the code.
 
-\section cfiles C Files Used To Implement SKINI
+\section cfiles Files Used To Implement SKINI
 
-SKINI.cpp is an object which can either open a SKINI file, and successively read and parse lines of text as SKINI strings, or accept strings from another object and parse them.  The latter functionality would be used by a socket, pipe, or other connection receiving SKINI messages a line at a time, usually in real time, but not restricted to real time.
+Skini is a C++ class which can either open a SKINI file and successively read and parse lines of text as SKINI strings, or accept strings from another object and parse them.  The latter functionality would be used by a socket, pipe, or other connection receiving SKINI messages a line at a time, usually in real time, but not restricted to real time.
 
-SKINI.msg should be included by anything wanting to use the SKINI.cpp object.  This is not mandatory, but use of the __SK_blah_ symbols which are defined in the .msg file will help to ensure clarity and consistency when messages are added and changed.
+\c SKINI.msg should be included by anything wanting to use the Skini object.  This is not mandatory, but use of the __SK_blah_ symbols which are defined in the .msg file will help to ensure clarity and consistency when messages are added and changed.
 
-SKINI.tbl is used only by the SKINI parser object (SKINI.cpp). In the file SKINI.tbl, an array of structures is declared and assigned values which instruct the parser as to what the message types are, and what the fields mean for those message types.  This table is compiled and linked into applications using SKINI, but could be dynamically loaded and changed in a future version of SKINI.
+\c SKINI.tbl is used only by the Skini parser object (Skini.cpp). In the file \c SKINI.tbl, an array of structures is declared and assigned values which instruct the parser as to what the message types are, and what the fields mean for those message types.  This table is compiled and linked into applications using SKINI, but could be dynamically loaded and changed in a future version of SKINI.
 
 \section parser SKINI Messages and the SKINI Parser:
 
@@ -52,8 +54,6 @@ The parser isn't all that smart, but neither am I.  Here are the basic rules gov
 
 - If the first (non-delimiter ... see below) character in a SKINI string is '/' that line is treated as a comment and echoed to stdout.
 
-- If there are no characters on a line, that line is treated as blank and echoed to stdout.  Tabs and spaces are treated as non-characters.
-
 - Spaces, commas, and tabs delimit the fields in a SKINI message line.  (We might allow for multiple messages per line later using the semicolon, but probably not.  A series of lines with deltaTimes of 0.0 denotes simultaneous events.  For read-ability, multiple messages per line doesn't help much, so it's unlikely to be supported later).
 
 - The first field must be a SKINI message name (like NoteOn).  These might become case-insensitive in future versions, so don't plan on exciting clever overloading of names (like noTeOn being different from NoTeON).  There can be a number of leading spaces or tabs, but don't exceed 32 or so.
@@ -62,7 +62,7 @@ The parser isn't all that smart, but neither am I.  Here are the basic rules gov
 
 - The third field must be an integer channel number.  Don't go crazy and think that this is just MIDI channel 0-15 (which is supported).  The channel number is scanned as a long int.  Channels 0-15 are in general to be treated as MIDI channels.  After that it's wide open.  Channels could be socket numbers, machine IDs, serial numbers, or even unique tags for each event in a synthesis.  A -1 channel can be used as don't care, omni, or other functions depending on your needs and taste.
 
-- All remaining fields are specified in the SKINI.tbl file.  In general, there are maximum two more fields, which are either SK_INT (long), SK_DBL (double float), or SK_STR (string).  The latter is the mechanism by which more arguments can be specified on the line, but the object using SKINI must take that string apart (retrived by using getRemainderString()) and scan it.  Any excess fields are stashed in remainderString.
+- All remaining fields are specified in the \c SKINI.tbl file.  In general, there are maximum two more fields, which are either SK_INT (long), SK_DBL (double float), or SK_STR (string).  The latter is the mechanism by which more arguments can be specified on the line, but the object using SKINI must take that string apart (retrived by using getRemainderString()) and scan it.  Any excess fields are stashed in remainderString.
 
 \section file A Short SKINI File:
 
@@ -80,7 +80,7 @@ The parser isn't all that smart, but neither am I.  Here are the basic rules gov
         StringDetune    0.100000 2    22
         StringDetune    0.100000 2    12
         //
-        StringDamping   0.000100 2     0.0
+        StringDamping   0.000100 2 0.0
         NoteOn          0.000082 2 55 82
         NoteOn          0.200000 2 62 82
         NoteOn          0.100000 2 71 82
@@ -89,7 +89,7 @@ The parser isn't all that smart, but neither am I.  Here are the basic rules gov
         NoteOff         0.000000 2 62 82
         NoteOff         0.000000 2 71 82
         NoteOff         0.000000 2 79 82
-        StringDamping  =4.000000 2       0.0
+        StringDamping  =4.000000 2 0.0
         NoteOn          0.000082 2 55 82
         NoteOn          0.200000 2 62 82
         NoteOn          0.100000 2 71 82
@@ -102,7 +102,7 @@ The parser isn't all that smart, but neither am I.  Here are the basic rules gov
 
 \section table  The SKINI.tbl File and Message Parsing:
 
-The SKINI.tbl file contains an array of structures which are accessed by the parser object SKINI.cpp.  The struct is:
+The \c SKINI.tbl file contains an array of structures which are accessed by the parser object Skini.cpp.  The struct is:
 
 \code
 struct SKINISpec {
@@ -129,9 +129,21 @@ so an assignment of one of these structs looks like:
 
 - SK_DBL  : double precision floating point.  SKINI uses these in the MIDI context for note numbers with micro tuning, velocities, controller values, etc.
 
-- SK_STR  : only valid in final field.  This allows (nearly) arbitrary message types to be supported by simply scanning the string to EndOfLine and then passing it to a more intellegent handler.  For example, MIDI SYSEX (system exclusive) messages of up to 256 bytes can be read as space-delimited integers into the 1K SK_STR buffer.  Longer bulk dumps, soundfiles, etc. should be handled as a new message type pointing to a FileName, Socket, or something else stored in the SK_STR field, or as a new type of multi-line message.
+- SK_STR  : only valid in final field.  This allows (nearly) arbitrary message types to be supported by simply scanning the string to EOL (End Of Line) and then passing it to a more intelligent handler.  For example, MIDI SYSEX (system exclusive) messages can be read as space-delimited integers into the SK_STR buffer.  Longer bulk dumps, soundfiles, etc. should be handled as a new message type pointing to a FileName, Socket, or something else stored in the SK_STR field, or as a new type of multi-line message.
 
-Here's a couple of lines from the SKINI.tbl file
+Each individual SKINI message is parsed and saved to a Skini::Message structure of the form:
+\code
+  struct Message { 
+    long type;                         /*!< The message type, as defined in SKINI.msg. */
+    long channel;                      /*!< The message channel (not limited to 16!). */
+    StkFloat time;                     /*!< The message time stamp in seconds (delta or absolute). */
+    std::vector<StkFloat> floatValues; /*!< The message values read as floats (values are type-specific). */
+    std::vector<long> intValues;       /*!< The message values read as ints (number and values are type-specific). */
+    std::string remainder;             /*!< Any remaining message data, read as ascii text. */
+  };
+\endcode
+
+Here's a couple of lines from the \c SKINI.tbl file
 
 \code
  {"NoteOff"          ,        __SK_NoteOff_,               SK_DBL,  SK_DBL},
@@ -144,7 +156,7 @@ Here's a couple of lines from the SKINI.tbl file
  {"StringDetune"     ,    __SK_ControlChange_, __SK_StringDetune_,  SK_DBL},
 \endcode
 
-The first three are basic MIDI messages.  The first two would cause the parser, after recognizing a match of the string "NoteOff" or "NoteOn", to set the message type to 128 or 144 (__SK_NoteOff_ and __SK_NoteOn_ are #defined in the file SKINI.msg to be the MIDI byte value, without channel, of the actual MIDI messages for NoteOn and NoteOff).  The parser would then set the time or delta time (this is always done and is therefore not described in the SKINI Message Struct).  The next two fields would be scanned as double-precision floats and assigned to the byteTwo and byteThree variables of the SKINI parser.  The remainder of the line is stashed in the remainderString variable.
+The first three are basic MIDI messages.  The first two would cause the parser, after recognizing a match of the string "NoteOff" or "NoteOn", to set the message type to 128 or 144 (__SK_NoteOff_ and __SK_NoteOn_ are #defined in the file \c SKINI.msg to be the MIDI byte value, without channel, of the actual MIDI messages for NoteOn and NoteOff).  The parser would then set the time or delta time (this is always done and is therefore not described in the SKINI Message Struct).  The next two fields would be scanned either as double-precision \c floats or as <tt>long ints</tt>, depending on the format specified in \c SKINI.tbl, and saved to the corresponding C++ vector variables in the Skini::Message structure (either \c floatValues or \c intValues).  Floating-point values are also cast to <tt>ints</tt> (and vice-versa) and stored to their respective variables.  For example, an expected integer value of 64 will also be saved as 64.0 in the corresponding \c floatValues variable of the Skini::Message structure.  The remainder of the line is stashed in the remainderString variable.
 
 The ControlChange spec is basically the same as NoteOn and NoteOff, but the second data byte is set to an integer (for checking later as to what MIDI control is being changed).
 
@@ -155,64 +167,60 @@ The Volume spec is a MIDI Extension message, which behaves like a ControlChange
     Volume         0.000000 2   64.1
 \endcode
 
-I like the 2nd line better, thus my motivation for SKINI in the first place.
+I like the second line better, thus my motivation for SKINI in the first place.
 
 The StringDamping and StringDetune messages behave the same as the Volume message, but use Control Numbers which aren't specifically nailed-down in MIDI.  Note that these Control Numbers are carried around as long ints, so we're not limited to 0-127.  If, however, you want to use a MIDI controller to play an instrument, using controller numbers in the 0-127 range might make sense.
 
 \section using Using SKINI:
 
-Here's a simple example of code which uses the SKINI object to read a SKINI file and control a single instrument.
+Here's a simple example of code which uses the Skini object to read a SKINI file and control a single instrument.
 
 \code
+        Skini score;
+        Skini::Message message;
         instrument = new Mandolin(50.0);
-        score = new SKINI(argv[1]);
-        while(score->getType() > 0) {
-            tempDouble = score->getDelta();
-            if (tempDouble < 0)     {
-                tempDouble = - tempDouble;
-                tempDouble = tempDouble - output.getTime();
-                if (tempDouble < 0) {
-                   printf("Bad News Here!!!  Backward Absolute Time Required.\n");
-                   tempDouble = 0.0;
-                }
+        score.setFile( argv[1] );
+        while ( score.nextMessage( message ) != 0 ) {
+          tempDouble = message.time;
+          if (tempDouble < 0)     {
+            tempDouble = - tempDouble;
+            tempDouble = tempDouble - output.getTime();
+            if (tempDouble < 0) {
+              printf("Bad News Here!!!  Backward Absolute Time Required.\n");
+              tempDouble = 0.0;
             }
-            tempLong = (long) (tempDouble * Stk::sampleRate());
-            for (i=0;i<tempLong;i++)   {
-                output.tick(instrument->tick());
+          }
+          tempLong = (long) ( tempDouble * Stk::sampleRate() );
+          for ( i=0; i<tempLong; i++ ) {
+            output.tick( instrument->tick() );
+          }
+
+          tempDouble3 = message.floatValues[1] * NORM_MIDI;
+          if ( message.type == __SK_NoteOn_ ) {
+            if ( tempDouble3 == 0.0 ) {
+              tempDouble3 = 0.5;
+              instrument->noteOff( tempDouble3 );
             }
-            tempDouble3 = score->getByteThree();
-            if (score->getType()== __SK_NoteOn_ )        {
-                tempDouble3 *= NORM_MIDI;
-                if (score->getByteThree() == 0)  {
-                    tempDouble3 = 0.5;
-                    instrument->noteOff(tempDouble3);
-                }
-                else {
-                    tempLong = (int) score->getByteTwo();
-                    tempDouble2 = Midi2Pitch[tempLong];
-                    instrument->noteOn(tempDouble2,tempDouble3);
-                }
+            else {
+              tempLong = message.intValues[0];
+              tempDouble2 = Midi2Pitch[tempLong];
+              instrument->noteOn( tempDouble2, tempDouble3 );
             }
-            else if (score->getType() == __SK_NoteOff_) {
-                tempDouble3 *= NORM_MIDI;
-                instrument->noteOff(tempDouble3);
-            }
-            else if (score->getType() == __SK_ControlChange_)        {
-                tempLong = score->getByteTwoInt();
-                instrument->controlChange(tempLong,temp3.0);
-            }
-            score->nextMessage();
+          }
+          else if ( message.type == __SK_NoteOff_ ) {
+            instrument->noteOff( tempDouble3 );
+          }
+          else if ( message.type == __SK_ControlChange_ ) {
+            tempLong = message.intValues[0];
+            instrument->controlChange( tempLong, tempDouble3 );
+          }
         }
 \endcode
 
-When the score (SKINI object) object is created from the filename in argv[1], the first valid command line is read from the file and parsed.
+When a SKINI score is passed to a Skini object using the Skini::setFile() function, valid messages are read from the file and returned using the Skini::nextMessage() function.
 
-The score->getType() retrieves the messageType.  If this is -1, there are no more valid messages in the file and the synthesis loop terminates.  Otherwise, the message type is returned.
-
-getDelta() retrieves the deltaTime until the current message should occur.  If this is greater than 0, synthesis occurs until the deltaTime has elapsed.  If deltaTime is less than zero, the time is interpreted as absolute time and the output device is queried as to what time it is now.  That is used to form a deltaTime, and if it's positive we synthesize.  If it's negative, we print an error and pretend this never happened and we hang around hoping to eventually catch up.
+The "time" member of a Skini::Message is the deltaTime until the current message should occur.  If this is greater than 0, synthesis occurs until the deltaTime has elapsed.  If deltaTime is less than zero, the time is interpreted as absolute time and the output device is queried as to what time it is now.  That is used to form a deltaTime, and if it's positive we synthesize.  If it's negative, we print an error, pretend this never happened and we hang around hoping to eventually catch up.
 
 The rest of the code sorts out message types NoteOn, NoteOff (including NoteOn with velocity 0), and ControlChange.  The code implicitly takes into account the integer type of the control number, but all other data is treated as double float.
 
-The last line reads and parses the next message in the file.
-
-*/
+*/

doc/doxygen/system.txt

@@ -2,46 +2,34 @@
 
 <B>General:</B>
 <UL>
-<LI>A MIDI interface to use MIDI input controls. (NOTE: This may be built into the soundcard on your computer.)</LI>
-<LI><A HREF="http://dev.scriptics.com">Tcl/Tk</A> version 8.0 or higher to use the simple Tcl/Tk GUIs provided with the STK distribution (available free over the WWW for all supported realtime platforms).</LI>
+<LI>A MIDI interface to use MIDI input/output controls. (NOTE: This may be built into the soundcard on your computer.)</LI>
+<LI><A HREF="https://www.tcl.tk/">Tcl/Tk</A> version 8.0 or higher to use the simple Tcl/Tk GUIs provided with the STK distribution (available free over the WWW for all supported realtime platforms).</LI>
 </UL>
 
 <B>Linux (specific):</B>
 <UL>
 <LI>A soundcard to use realtime audio input/output capabilities.  In order to use the <I><B>effects</B></I> project, the soundcard and drivers must support full duplex mode.</LI>
-<LI><A HREF="http://www.opensound.com">OSS</A> or <A HREF="http://www.alsa-project.org/">ALSA</A> device drivers for realtime sound output and MIDI input.</LI>
+<LI><A HREF="http://www.alsa-project.org/">ALSA</A> device drivers and library for realtime sound and MIDI input/output.</LI>
+<LI><A HREF="http://www.opensound.com">OSS</A> device drivers (version 4.0 and higher only) can be used for audio input/output, but MIDI support requires the ALSA library to compile.</LI>
 </UL>
 
 <B>Macintosh OS X (specific):</B>
 <UL>
-<LI>A C++ compiler does not ship by default with OS X.  It is necessary to download the Developer Kit from the Apple WWW site in order to compile STK.</LI>
-<LI>The internal Macintosh audio hardware typically supports a sample rate of 44100 Hz only.  Therefore, it is necessary to either specify this rate as a command-line option to the STK example programs or to change the default sample rate inside the Stk.h file before compilation.  In addition, the RT_BUFFER_SIZE, specified in Stk.h, could be increased (to a higher power of two) for more robust performance.</LI>
-<LI>The tcl/tk interpreter does not ship by default with OS X, but must be downloaded from the internet.  Binary distributions exist but it is instead recommended that you download recent tcl and tk source distributions (http://dev.scriptics.com/software/tcltk/downloadnow84.tml) and compile them as follows:
+<LI>A C++ compiler is not installed by default with OS X.  It is necessary to download the Developer Kit from the Apple WWW site in order to compile STK or load it from the installation CD-ROM.</LI>
+<LI>If you experience frequent audio input/output "glitches", try increasing the RT_BUFFER_SIZE specified in Stk.h.</LI>
+<LI>The Tcl/Tk interpreter does not ship by default with OS X and must be downloaded from the internet.  The latest Tcl/Tk Aqua distribution (http://www.apple.com/downloads/macosx/unix_open_source/tcltk.html) has been successfully tested on 10.2 and 10.3 systems.  The default installation will place a link to the wish interpretor at /usr/bin/wish.
 
-  make -C tcl/macosx deploy<BR>
-  make -C tk/macosx deploy<BR>
-  sudo make -C tcl/macosx install-deploy<BR>
-  sudo make -C tk/macosx  install-deploy<BR>
-
-(Note: the tcl and tk directories specified in the above lines will more likely be appended with version numbers)  The default installation will place a link to the wish interpretor at /usr/bin/wish.  The latest 8.4.1 release of tcl/tk has been tested on a 10.2 system and found to work correctly.  In particular, redirection of a tcl/tk script to the interpreter (e.g., wish < test.tcl) works normally (which is not the case with binary distributions tested thus far).
-
-Initial tests have shown somewhat poor response between changes made in the tcl/tk script and the resulting audio updates.  Also, it is not recommended to connect by socket from a tcl/tk script to an STK program because the tcl/tk interpreter does not appear to properly close the socket connection, leaving the STK program in a "hung" state.</LI>
+It appears that socket support in Tcl/Tk uses the Nagle algorithm, which produces poor response between changes made in the Tcl/Tk script and the resulting audio updates.  Note that this is only a problem when using a socket connection from a Tcl/Tk script.</LI>
 
 </UL>
 
-<B>Windows95/98/2000/XP (specific):</B>
+<B>Windows95 and later (specific):</B>
 <UL>
 <LI>A soundcard to use realtime audio input/output capabilities.  In order to use the <I><B>effects</B></I> project, the soundcard and drivers must support full duplex mode.</LI>
-<LI><A HREF="http://www.microsoft.com/directx/">DirectX</A> 5.0 (or higher) runtime libraries to use the precompiled binaries.</LI>
-<LI>Visual C++ 6.0 for compiling (though a precompiled distribution is available).</LI>
+<LI><A HREF="http://www.microsoft.com/directx/">DirectX</A> 5.0 (or higher) runtime libraries.</LI>
 <LI>For compiling the source (if not already in your system): <UL><LI><A HREF="Misc/dsound.h">dsound.h</A> header file (DirectX 6.1) - put somewhere in your header search path</LI><LI><A HREF="Misc/dsound.lib">dsound.lib</A> library file (DirectX 6.1) - put somewhere in your library search path</LI></UL></LI>
 </UL>
 
-<B>WindowsNT (specific):</B>
-<UL>
-<LI>DirectX support for NT is inadequate, so it is not possible to use STK under WindowsNT with realtime DirectX support.  It may be possible to use STK under WindowsNT with realtime ASIO support, though this has not been tested.</LI>
-</UL>
-
 <P>
 
-*/
+*/

doc/doxygen/tutorial.txt

@@ -1,23 +1,24 @@
 /*! \page tutorial Tutorial
 
-The Synthesis ToolKit is a set of C++ classes.  In order to go beyond the simple example programs we provide, it is necessary to know some basics about programming in C or C++.  STK's "target audience" includes people who:
-<UL>
-<LI>want to create audio DSP and/or synthesis programs</LI>
-<LI>want to save some time by using our unit generators and input/output routines</LI>
-<LI>want to learn about synthesis and processing algorithms</LI>
-<LI>wish to teach real-time synthesis and processing, and wish to use some of our classes and examples</LI>
-</UL>
+The Synthesis ToolKit is a set of C++ classes.  In order to go beyond the simple example programs we provide, it is necessary to know some basics about programming in C and C++.  STK's "target audience" includes people who:
+- want to create audio DSP and/or synthesis programs
+- want to use our unit generators and input/output routines rather than code their own
+- want to learn about synthesis and processing algorithms
+- wish to teach real-time synthesis and processing and wish to use some of our classes and examples
 
 Most ToolKit programmers will likely end up writing a class or two for their own particular needs, but this task is typically simplified by making use of pre-existing STK classes (filters, oscillators, etc.).
 
 The following tutorial chapters describe many of the fundamental ToolKit concepts and classes.  All tutorial programs are included in the <TT>projects/examples</TT> directory.
 
+-# \ref fundamentals
 -# \ref hello
 -# \ref compile
+-# \ref filtering
 -# \ref realtime
+-# \ref crealtime
 -# \ref instruments
 -# \ref controlin
 -# \ref multichannel
 -# \ref polyvoices
 
-*/
+*/

doc/doxygen/usage.txt

@@ -2,6 +2,7 @@
 
 - \ref directory
 - \ref compiling
+- \ref debug
 - \ref control
 - \ref voices
 - \ref nort
@@ -21,7 +22,7 @@ The top level distribution contains the following directories:
 
 <LI> The <I><B>include</B></I> directory contains the header files for all the STK unit generator and algorithm classes.</LI><P>
 
-<LI> The <I><B>rawwaves</B></I> directory contains various raw, monophonic, 16-bit, big-endian soundfiles used with the STK classes.</LI><P>
+<LI> The <I><B>rawwaves</B></I> directory contains various raw, monophonic, 16-bit, big-endian, 22050 Hz soundfiles used with the STK classes.</LI><P>
 
 <LI> The <I><B>doc</B></I> directory contains documentation about STK.</LI><P>
 
@@ -31,33 +32,37 @@ The top level distribution contains the following directories:
 This release of STK comes with four separate "project" directories:
 
 <OL>
-<LI> The <I><B>demo</B></I> project is used to demonstrate nearly all of the STK instruments.  The <I><B>demo</B></I> program has been written to allow a variety of control input and sound data output options.  %Simple graphical user interfaces (GUIs) are also provided.<P></LI>
+<LI> The <I><B>demo</B></I> project is used to demonstrate nearly all of the STK instruments.  The <I><B>stk-demo</B></I> program has been written to allow a variety of control input and sound data output options.  Simple graphical user interfaces (GUIs) are also provided.<P></LI>
 
 <LI> The <I><B>effects</B></I> project demonstrates realtime duplex mode (simultaneous audio input and output) operation, when available, as well as various delay-line based effects algorithms.<P></LI>
 
 <LI> The <I><B>ragamatic</B></I> project is just cool.  Fire it up and be enlightened.<P></LI>
 
-<LI> The <I><B>examples</B></I> project contains several simple programs which demonstrate audio input/output, as well as the use of the audio internet streaming classes.</LI>
+<LI> The <I><B>eguitar</B></I> project demonstrates how to make an electric guitar with feedback and distortion.<P></LI>
+
+<LI> The <I><B>examples</B></I> project contains several simple programs that demonstrate audio input/output, including the audio internet streaming classes, as well as most of the tutorial programs.</LI>
 </OL>
 
 \section compiling Compiling:
 
 <UL>
-<LI><B>Windows95/98/2000/XP:</B> Realtime support is available using either DirectSound or ASIO audio drivers.  For DirectSound support, use the <TT>__WINDOWS_DS__</TT> preprocessor definition and link with the <TT>dsound.lib</TT>, <TT>winmm.lib</TT>, and <TT>Wsock32.lib</TT> libraries. For ASIO support, use the <TT>__WINDOWS_ASIO__</TT> preprocessor definition, include all the files in the <TT>src/asio/</TT> directory (i.e. <TT>asio.h,cpp</TT>, <TT>asiodrivers.h,cpp</TT>, ...), and link with the <TT>winmm.lib</TT>, and <TT>Wsock32.lib</TT> libraries.  In addition, the <TT>__LITTLE_ENDIAN__</TT> 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 <A HREF="http://www.microsoft.com/directx/">Microsoft</A>).  Further, the <I><B>effects</B></I> 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.</LI>
+<LI><B>Windows95 and later:</B> For specifics on creating Windows applications using Visual Studio, see README-Win.txt.</LI>
 
-<LI><B>WindowsNT:</B> DirectX support for NT is inadequate, so it is not possible to use STK under WindowsNT with realtime DirectX support.  It may be possible to use STK under WindowsNT with realtime ASIO support, though this has not been tested.</LI>
-
-<LI><B>Unix Systems:</B> A GNU <TT>configure</TT> shell script is included in the distribution for unix-based systems.  From the top-level distribution directory, type <TT>'./configure'</TT> and the script will create <TT>Makefiles</TT> in each project directory specific to the characteristics of the host computer.  Then from within any given project directory (example <TT>demo</TT>), type <TT>'make'</TT> to compile the project.  In addition, an STK library can be compiled from within the <TT>src</TT> directory.
+<LI><B>Unix (and MinGW) Systems:</B> A GNU <TT>configure</TT> shell script is included in the distribution for unix-based systems.  From the top-level distribution directory, type <TT>'./configure'</TT> and the script will create <TT>Makefiles</TT> in each project directory specific to the characteristics of the host computer.  Then from within any given project directory (example <TT>demo</TT>), type <TT>'make'</TT> to compile the project.  In addition, an STK library can be compiled from within the <TT>src</TT> directory.
 
 Several options can be supplied to the <TT>configure</TT> script to customize the build behavior:
 <UL>
 <LI><TT>--disable-realtime</TT> to only compile generic non-realtime classes</LI>
 <LI><TT>--enable-debug</TT> to enable various debug output</LI>
-<LI><TT>--enable-midiator</TT> to enable native MS-124W MIDI support (linux only)</LI>
-<LI><TT>--with-alsa</TT> to choose native ALSA API support (linux only)</LI>
+<LI><TT>--with-alsa</TT> to choose native ALSA API support (default, linux only)</LI>
+<LI><TT>--with-oss</TT> to choose native OSS audio API support (linux only, no native OSS MIDI support)</LI>
+<LI><TT>--with-jack</TT> to choose native JACK API support (linux and Macintosh OS-X)</LI>
+<LI><TT>--with-core</TT> to choose CoreAudio API support (Macintosh OS-X)</LI>
+<LI><TT>--with-asio</TT> to choose ASIO Audio API support (Windows)</LI>
+<LI><TT>--with-ds</TT> to choose Windows DirectSound Audio API support (Windows)</LI>
 </UL>
 <P>
-In addition, it is possible to specify the location of the STK rawwaves and the STK include path as follows:
+Note that it is possible to specify as many of the "--with-" options as desired to compile multi-API support.  In addition, it is possible to specify the location of the STK rawwaves and the STK include path as follows:
 \code
 ./configure RAWWAVE_PATH="/home/gary/rawwaves/"
 ./configure INCLUDE_PATH="/home/gary/include/"
@@ -68,15 +73,16 @@ For novice STK users, the default configuration should be adequate.
 
 For those who wish to create their own system-specific <TT>Makefiles</TT>:
 <UL>
-<LI><B>Linux:</B> Realtime support is enabled with either the <TT>__LINUX_OSS__</TT> or <TT>__LINUX_ALSA__</TT> preprocessor definitions, which are used to select the underlying audio/MIDI system API.  Realtime programs must also link with the <TT>pthread</TT> library.  When using the ALSA API, it is also necessary to link with the <TT>asound</TT> library.  In addition, the <TT>__LITTLE_ENDIAN__</TT> 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 <TT>__MIDIATOR__</TT> preprocessor definition (together with either the <TT>__LINUX_ALSA__</TT> or <TT>__LINUX_OSS__</TT> definitions).  See the README-Linux file for further system configuration information.</LI>
+<LI><B>Linux:</B> Realtime audio support is enabled with either the <TT>__LINUX_ALSA__</TT>, <TT>__UNIX_JACK__</TT>, and/or <TT>__LINUX_OSS__</TT> preprocessor definitions, which are used to select the underlying audio system API(s).  Because the ALSA library is now integrated into the standard Linux kernel, it is the default audio/MIDI API with STK versions 4.2 and higher.  The <TT>__LINUX_ALSASEQ__</TT> preprocessor definition must be included for MIDI support.  Note that native OSS MIDI support no longer exists in RtMidi.  If the <TT>__LINUX_OSS__</TT> preprocessor definition is specified, only OSS (version 4.0) audio support will be compiled and RtMidi will still be compiled using the ALSA API (assuming the <TT>__LINUX_ALSASEQ__</TT> definition is defined).  For this reason, STK now requires the <TT>asound</TT> library for realtime support.  Realtime programs must also link with the <TT>pthread</TT> library.  In addition, the <TT>__LITTLE_ENDIAN__</TT> preprocessor definition is necessary if compiling on a little-endian system.  See the README-Linux file for further system configuration information.</LI>
 
-<LI><B>Macintosh OS X:</B> Realtime support is enabled with the <TT>__MACOSX_CORE__</TT> preprocessor definitions, which incorporates the CoreAudio audio/MIDI API.  Realtime programs must also link with the <TT>pthread</TT> library and the <TT>CoreAudio</TT>, <TT>CoreMIDI</TT>, and <TT>CoreFoundation</TT> frameworks.  See the README-MacOSX file for further system configuration information.</LI>
+<LI><B>Macintosh OS X:</B> Realtime support is enabled with the <TT>__MACOSX_CORE__</TT> and <TT>__UNIX_JACK__</TT> preprocessor definitions, which incorporate the CoreAudio audio/MIDI API and/or the JACK API.  Realtime programs must also link with the <TT>pthread</TT> library and the <TT>CoreAudio</TT>, <TT>CoreMIDI</TT>, and <TT>CoreFoundation</TT> frameworks (for CoreAudio support) and/or the JACK library.  See the README-MacOSX file for further system configuration information.</LI>
 
-<LI><B>SGI:</B> Realtime support is enabled with the <TT>__IRIX_AL__</TT> preprocessor definition and linkage with the <TT>audio</TT>, <TT>md</TT>, and <TT>pthread</TT> libraries.  STK 4.0 (and higher) is confirmed to compile using CC version 7.30.  There may be problems with old compiler versions.</LI>
-
-<LI><B>Generic (non-realtime):</B> Most STK classes are operating system <I>independent</I> and can be compiled using any current C++ compiler. STK assumes big-endian host byte order by default, so if your system is little-endian (i.e. Intel processor), you must provide the <TT>__LITTLE_ENDIAN__</TT> preprocessor definition to your compiler.  The <I><B>demo</B></I> 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 <I>cannot</I> be used without realtime support: RtAudio, RtWvIn, RtWvOut, RtDuplex, RtMidi, Socket, Thread, TcpWvIn, TcpWvOut.  Because of this, it is not possible to compile the <I><B>effects</B></I>, <I><B>ragamatic</B></I>, and most of the <I><B>examples</B></I> projects for non-realtime use.</LI>
+<LI><B>Generic (non-realtime):</B> Most STK classes are operating system <I>independent</I> and can be compiled using any current C++ compiler. STK assumes big-endian host byte order by default, so if your system is little-endian (i.e. Intel processor), you must provide the <TT>__LITTLE_ENDIAN__</TT> preprocessor definition to your compiler.  The <I><B>demo</B></I> 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 <I>cannot</I> be used without realtime support: RtAudio, RtWvIn, RtWvOut, RtDuplex, RtMidi, Socket, Thread, Mutex, TcpWvIn, TcpWvOut.  Because of this, it is not possible to compile the <I><B>effects</B></I>, <I><B>ragamatic</B></I>, and most of the <I><B>examples</B></I> projects for non-realtime use.</LI>
 </UL>
 
+\section debug Debugging:
+
+When developing applications with STK, it is recommended that you define the preprocessor definition <TT>_STK_DEBUG_</TT> when compiling (or specify the <TT>--enable-debug</TT> option to the <TT>configure</TT> script).  This will enable all levels of function argument and error checking within the STK classes.  Without this definition, argument checking does not occur in functions that are expected to be called frequently in an iterative manner.
 
 \section control Control Data:
 
@@ -85,11 +91,10 @@ All STK programs in this distribution take input control data in the form of <A
 <OL>
 <LI>Redirect or pipe SKINI scorefiles to an executable.</LI>
 <LI>Pipe realtime SKINI input messages to an executable (not possible under Windows95/98).</LI>
-<LI>Socket realtime SKINI input messages to an executable.</LI>
 <LI>Acquire realtime MIDI messages from a MIDI port on your computer.</LI>
 </OL>
 
-<A HREF="http://dev.scriptics.com">Tcl/Tk</A> 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 <I><B>Md2Skini</B></I> program (in the <I><B>demo</B></I> directory) is mostly obsolete but can be used to create SKINI scorefiles from realtime MIDI input.  
+<A HREF="https://www.tcl.tk/">Tcl/Tk</A> graphical user interfaces (GUI) are provided with this distribution that can generate realtime SKINI messages.  Note that the Messager class allows multiple simultaneous socket client connections, together with MIDI and/or piped input.  The <I><B>Md2Skini</B></I> program (in the <I><B>demo</B></I> directory) is mostly obsolete but can be used to create SKINI scorefiles from realtime MIDI input.  
 
 
 \section voices Demo: STK Instruments
@@ -98,7 +103,7 @@ The <I><B>demo</B></I> project demonstrates the behavior of all the distributed
 <UL>
 <LI>Clarinet: Pretty good physical model of the clarinet</LI>
 <LI>BlowHole: A clarinet physical model with one tonehole and one register vent</LI>
-<LI>Saxofony: A psuedo-conical bore reed instrument which sometimes sounds like a saxophone</LI>
+<LI>Saxofony: A psuedo-conical bore reed instrument that sometimes sounds like a saxophone</LI>
 <LI>Flute: Pretty good physical model of the flute</LI>
 <LI>Brass: Not so bad physical model of a brass instrument</LI>
 <LI>BlowBotl: A basic helmholtz resonator and air jet model</LI>
@@ -129,93 +134,72 @@ The <I><B>demo</B></I> 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 <I>scores</I> directory of the <I><B>demo</B></I> project.  Assuming a successful compilation of the <I><B>demo</B></I> 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 <I>scores</I> directory of the <I><B>demo</B></I> project.  Assuming a successful compilation of the <I><B>stk-demo</B></I> program, typing:
 
 \code
-cat scores/bookert.ski | demo BeeThree -ow myfile.wav
+stk-demo BeeThree -ow myfile.wav -if scores/bookert.ski
 \endcode
 
-or (on WindowsXX and/or Unix)
-
-\code
-demo BeeThree -ow myfile.wav < scores\bookert.ski
-\endcode
-
-from the <I><B>demo</B></I> directory will play the scorefile <I>bookert.ski</I> using the STK BeeThree instrument and write the resulting audio data to a WAV formatted soundfile called "myfile.wav".  Typing <TT>demo</TT> without any arguments will provide a full program usage description.
+from the <I><B>demo</B></I> directory will play the scorefile <I>bookert.ski</I> 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 <TT>./</TT> to the program name if your default shell setup is not set to look in the current directory).  Typing <TT>stk-demo</TT> 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, SGI, Mac OS X, and Windows95/98/2000/XP operating systems.  STK realtime SKINI control input via piping is possible under Linux, SGI, Mac OS X, and Windows2000/XP only.
+STK realtime audio and MIDI input/output and realtime SKINI control input via socketing support is provided for Linux, Mac OS-X, and Windows95 and later operating systems.  STK realtime SKINI control input via piping is possible under Linux, Mac OS X, and Windows2000 and later only.
 <P>
-Control input and audio output options are typically specified as command-line arguments to STK programs.  For example, the <I><B>demo</B></I> program is invoked as:
+Control input and audio output options are typically specified as command-line arguments to STK programs.  For example, the <I><B>stk-demo</B></I> 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:
 <UL>
 <LI><I>-or</I> for realtime audio output,</LI>
-<LI><I>-ow <file name></I> for WAV soundfile output,</LI>
-<LI><I>-os <file name></I> for SND (AU) soundfile output,</LI>
-<LI><I>-om <file name></I> for MAT-file output,</LI>
+<LI><I>-ow \<file name\></I> for WAV soundfile output,</LI>
+<LI><I>-os \<file name\></I> for SND (AU) soundfile output,</LI>
+<LI><I>-om \<file name\></I> for MAT-file output,</LI>
+<LI><I>-if \<file name\></I> for a SKINI formatted control file,</LI>
 <LI><I>-ip</I> for realtime SKINI control input via piping,</LI>
-<LI><I>-is <port></I> > for realtime SKINI control input via socketing (with an optional port number),</LI>
-<LI><I>-im <file name></I> for MIDI control input</LI>
-<LI><I>-s RATE</I> to specify a sample rate</LI>
+<LI><I>-im \<port\></I> for MIDI control input (with optional port, -1 = virtual port where possible),</LI>
+<LI><I>-s RATE</I> to specify a sample rate,</LI>
 <LI><I>-n NUMBER</I> to specify multivoice polyphony</LI>
 </UL>
-The <-ip> and <-is> flags must be used when piping or socketing 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 all three input types simultaneously.
+The <i>-ip</i> flag must be used when piping realtime SKINI control data to an STK program.  The <i>-im</i> 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 <I><B>demo</B></I> program, typing:
+Assuming a successful compilation of the <I><B>stk-demo</B></I> program, typing:
 
 \code
-cat scores/bookert.ski | demo BeeThree -or
+stk-demo BeeThree -or -if scores/bookert.ski
 \endcode
 
-or (on WindowsXX and/or Unix)
-
-\code
-demo BeeThree -or < scores\bookert.ski
-\endcode
-
-from the <I><B>demo</B></I> directory will play the scorefile <I>bookert.ski</I> using the STK BeeThree instrument and stream the resulting audio data in realtime to the audio output channel of your computer.  Typing <TT>demo</TT> without any arguments will provide a full program usage description.
+from the <I><B>demo</B></I> directory will play the scorefile <I>bookert.ski</I> using the STK BeeThree instrument and stream the resulting audio data in realtime to the audio output channel of your computer.  Typing <TT>stk-demo</TT> without any arguments will provide a full program usage description.
 
 
 \section tcl Realtime Control Input using Tcl/Tk Graphical User Interfaces:
 
-There are a number of <A HREF="http://dev.scriptics.com">Tcl/Tk</A> 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 <I>wish</I>).  The Physical.bat script just implements the following command-line sequence:
+There are a number of <A HREF="https://www.tcl.tk/">Tcl/Tk</A> 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 and later 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 <I>wish</I>).  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
 
-On WindowsXX and Unix platforms, the following operations are necessary to establish a socket connection between the Tcl/Tk GUI and the STK program:
-<OL>
-<LI>Open a DOS shell and start the STK program with the <I>-is</I> flag (ex. <I><B>demo Clarinet -or -is</B></I>).</LI>
-<LI>Open the Tcl/Tk GUI (e.g. tcl/Physical.tcl) by double-clicking on it, or type <TT>wish < tcl/Physical.tcl</TT> in another DOS shell.</LI>
-<LI>Establish the socket connection by selecting <I>Socket</I> under the Communications menu item in the Tcl/Tk GUI.</LI>
-</OL>
-
-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.
-
-
 \section midi Realtime MIDI Control Input:
 
 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 <TT>-im</TT> 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 <I><B>demo</B></I> program supports an arbitrary number of voices via the <TT>-n NUMBER</TT> 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 <I><B>stk-demo</B></I> program supports an arbitrary number of voices via the <TT>-n NUMBER</TT> 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
 
 */

doc/hierarchy.txt

@@ -0,0 +1,180 @@
+STK: A ToolKit of Audio Synthesis Classes and Instruments in C++
+
+By Perry R. Cook and Gary P. Scavone, 1995--2021.
+
+STK Classes - See the HTML documentation in the html directory for complete information.
+
+
+     .- Generator - (Modulate, Noise, SingWave, Envelope, ADSR, Asymp, SineWave, Blit, BlitSaw, BlitSquare, Granulate)
+     |
+     |- Function - (BowTable, JetTable, ReedTable)
+     |
+     |- FileRead, FileWrite
+     |
+     |- WvIn - (FileWvIn, RtWvIn, InetWvIn)
+     |             |
+     |          FileLoop
+     |
+     |- WvOut - (FileWvOut, RtWvOut, TcpWvOut)
+     |
+     |- Filter - (OnePole, OneZero, TwoPole, TwoZero, PoleZero, Biquad, FormSwep, Delay, DelayL, DelayA, TapDelay)
+     |
+     |- RtAudio, RtMidi, Socket, Thread, Mutex
+     |                      |
+Stk -|                  UdpSocket
+     |                  TcpServer
+     |                  TcpClient
+     |
+     |- StkFrames
+     |
+     |- Effect - (Echo, Chorus, PitShift, LentPitShift, PRCRev, JCRev, NRev, FreeVerb)
+     |
+     |- Voicer, Message, Skini, MidiFileIn, Phonemes, Sphere, Vector3D
+     |
+     |- Messager
+     |
+     |- Twang, Guitar
+     |
+     |            .- FM - (HevyMetl, PercFlut, Rhodey, Wurley, TubeBell, BeeThree, FMVoices)
+     |            |
+     |            |- Modal - ModalBar
+     |            |
+     |            |- VoicForm
+     |            |
+     |            |- Sampler - Moog
+     |            |
+     |            |- Resonate
+     |            |
+     |            |- Mandolin
+     .- Instrmnt -|
+                  |- Drummer
+                  |
+                  |- Clarinet, BlowHole, Saxofony, Flute, Brass, BlowBotl, Bowed, Plucked, StifKarp, Sitar, Recorder
+                  |
+                  |- Shakers
+                  |
+                  |- BandedWG
+                  |
+                  |- Mesh2D
+                  |
+                  .- Whistle
+
+
+***********   UNIT GENERATORS   **************
+
+Master Class:  Stk.cpp         Sample rate, byte-swapping, error handling functionality
+
+Sources:       Generator.h     Abstract base class for various source signal classes
+               Function.h      Abstract base class for various input/output mapping classes
+               Envelope.cpp    Linearly goes to target by rate
+               ADSR.cpp        ADSR envelope
+               Asymp.cpp       Exponentially approaches target
+               Noise.cpp       Random number generator
+               SineWave.cpp    Sinusoidal oscillator with internally computed static table
+               Blit.cpp        Bandlimited impulse train
+               BlitSaw.cpp     Bandlimited sawtooth generator
+               BlitSquare.cpp  Bandlimited square wave generator
+               Granulate.cpp   Granular synthesis class that processes a monophonic audio file
+               FileRead.cpp    Audio file input class (no internal data storage) for RAW, WAV, SND (AU), AIFF, MAT-file files
+               WvIn.h          Abstract base class for audio data input classes
+               FileWvIn.cpp    Audio file input interface class with interpolation
+               FileLoop.cpp    Wavetable looping (subclass of FileWvIn)
+               RtWvIn.cpp      Realtime audio input class (subclass of WvIn)
+               InetWvIn.cpp    Audio streaming (socket server) input class (subclass of WvIn)
+
+Sinks:         FileWrite.cpp   Audio file output class (no internal data storage) for RAW, WAV, SND (AU), AIFF, MAT-file files
+               WvOut.h         Abstract base class for audio data output classes
+               FileWvOut.cpp   Audio file output interface class to FileWrite
+               RtWvOut.cpp     Realtime audio output class (subclass of WvOut)
+               InetWvOut.cpp   Audio streaming (socket client) output class (subclass of WvOut)
+
+Filters:       Filter.h        Filter master class
+               Iir.h           General infinite-impulse response filter
+               Fir.h           General finite-impulse response filter
+               OneZero.cpp     One zero filter
+               OnePole.cpp     One pole filter
+               PoleZero.cpp    One pole/one zero filter
+               TwoZero.cpp     Two zero filter
+               TwoPole.cpp     Two pole filter
+               BiQuad.cpp      Two pole/two zero filter
+               FormSwep.cpp    Sweepable biquad filter (goes to target by rate)
+               Delay.cpp       Non-interpolating delay line class
+               DelayL.cpp      Linearly interpolating delay line
+               DelayA.cpp      Allpass interpolating delay line
+               TapDelay.cpp    Multi-tap non-interpolating delay line class
+
+Non-Linear:    JetTabl.h       Cubic jet non-linearity
+               BowTabl.h       x^(-3) Bow non-linearity
+               ReedTabl.h      One breakpoint saturating reed non-linearity
+                                
+Derived:       Modulate.cpp    Periodic and random vibrato: WvIn, Noise, OnePole
+               SingWave.cpp    Looping wave table with randomness: Modulate, FileLoop, Envelope
+
+
+********** INSTRUMENTS AND ALGORITHMS **************
+
+Each class is listed either with some of the unit generators it uses, 
+or in terms of the algorithm it implements.  All inherit from Instrmnt,
+which inherits from Stk.
+
+Simple.cpp       Simple Instrument              Pulse oscillator + resonant filtered noise
+Plucked.cpp      Basic Plucked String           DelayA, OneZero, OnePole, Noise
+Twang.cpp        Not So Basic Pluck             DelayL, DlineA, Fir, allows commuted synthesis
+Mandolin.cpp     Commuted Mandolin              2 Twangs
+Guitar.cpp       N-String Guitar                N Twangs, bridge coupling, allows feedback and body filter
+StifKarp.cpp     Plucked String with Stiffness  DelayA, DelayL, OneZero, BiQuad, Noise
+Bowed.cpp        So So Bowed String             DelayL, BowTabl, OnePole, BiQuad, WaveLoop, ADSR
+Brass.cpp        Not So Bad Brass Instrument    DelayA, BiQuad, PoleZero, ADSR, WaveLoop
+Clarinet.cpp     Pretty Good Clarinet           DelayL, ReedTabl, OneZero, Envelope, Noise, WaveLoop
+BlowHole.cpp     Clarinet w/ Tone & Vent Holes  DelayL, ReedTabl, OneZero, Envelope, Noise, WaveLoop, PoleZero
+Saxofony.cpp     A Faux Saxophone               DelayL, ReedTabl, OneZero, Envelope, Noise, WaveLoop
+Flute.cpp        Pretty Good Flute              JetTabl, DelayL, OnePole, PoleZero, Noise, ADSR, WaveLoop
+Recorder.cpp     A More Physical Flute          DelayL, IIR, Noise, ADSR, SineWave
+BlowBotl.cpp     Blown Bottle                   JetTabl, BiQuad, PoleZero, Noise, ADSR, WaveLoop
+BandedWG.cpp     Banded Waveguide Meta-Object   Delay, BowTabl, ADSR, BiQuad
+Modal.cpp        N Resonances                   Envelope, WaveLoop, BiQuad, OnePole
+ModalBar.cpp     Various presets                4 Resonance Models
+FM.cpp           N Operator FM Master           ADSR, WaveLoop, TwoZero
+HevyMetl.cpp     Distorted FM Synthesizer       3 Cascade with FB Modulator
+PercFlut.cpp     Percussive Flute               3 Cascade Operators
+Rhodey.cpp       Rhodes-Like Electric Piano     2 Parallel Simple FMs
+Wurley.cpp       Wurlitzer Electric Piano       2 Parallel Simple FMs
+TubeBell.cpp     Classic FM Bell                2 Parallel Simple FMs
+FMVoices.cpp     3 Formant FM Voice             3 Carriers Share 1 Modulator
+VoicForm.cpp     4 Formant Voice Synthesis      FormSwep, SingWave, OnePole, OneZero, Envelope, Noise
+BeeThree.cpp     Cheezy Additive Organ          4 Oscillators Additive
+Sampler.cpp      Sampling Synthesizer           5 each ADSR, WvIn, WaveLoop, OnePole
+Moog.cpp         Swept Filter                   Sampler with Swept Filter
+Resonate.cpp     Filtered Noise                 ADSR, BiQuad, Noise
+Drummer.cpp      Drum Synthesizer               Bunch of WvIns, and OnePole
+Shakers.cpp      PhISM statistical model for shakers and real-world sound effects
+Mesh2D.cpp       Two-dimensional, rectilinear digital waveguide mesh.
+Whistle.cpp      Hybrid physical/spectral model of a police whistle.
+
+Effect.h         Effects Processor Base Class
+JCRev.cpp        Chowning Reverberator           3 series allpass units, 4 parallel combs, 2 stereo delays
+NRev.cpp         Another famous CCRMA Reverb	    8 allpass, 6 parallel comb filters
+PRCRev.cpp       Dirt Cheap Reverb by Cook	      2 allpass, 2 comb filters
+FreeVerb.cpp     Jezar at Dreampoint's FreeVerb  4 allpass, 8 lowpass comb filters
+Flanger.cpp      Flanger Effects Processor       DelayL, WaveLoop
+Chorus.cpp       Chorus Effects Processor        DelayL, WaveLoop
+PitShift.cpp     Cheap Pitch Shifter             DelayL
+LentPitShift.cpp Pitch Shifter based Lent Algorithm
+
+
+***********   OTHER SUPPORT CLASSES AND FILES   **************
+
+RtAudio.cpp     Multi-OS/API audio I/O routines
+RtMidi.cpp      Multi-OS/API MIDI I/O routines
+Messager.cpp    Pipe, socket, and MIDI control message handling
+Voicer.cpp      Multi-instrument voice manager
+
+demo.cpp        Demonstration program for most synthesis algorithms
+effects.cpp     Effects demonstration program
+ragamatic.cpp   Nirvana just waiting to happen
+
+Skini.cpp	      SKINI file/message parser object
+SKINImsg.h	      #defines for often used and universal MIDI/SKINI symbols
+SKINItbl.h	      Table of SKINI messages
+
+

doc/html/ADSR_8h-source.html

@@ -1,76 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>ADSR.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00016 <font class="comment">/***************************************************/</font>
-00017 
-00018 <font class="preprocessor">#if !defined(__ADSR_H)</font>
-00019 <font class="preprocessor"></font><font class="preprocessor">#define __ADSR_H</font>
-00020 <font class="preprocessor"></font>
-00021 <font class="preprocessor">#include "Envelope.h"</font>
-00022 
-00023 <font class="keyword">class </font><a class="code" href="classADSR.html">ADSR</a> : <font class="keyword">public</font> <a class="code" href="classEnvelope.html">Envelope</a>
-00024 {
-00025  <font class="keyword">public</font>:
-00026 
-00028   <font class="keyword">enum</font> { ATTACK, DECAY, SUSTAIN, RELEASE, DONE };
-00029 
-00031   <a class="code" href="classADSR.html#a0">ADSR</a>(<font class="keywordtype">void</font>);
-00032 
-00034   <a class="code" href="classADSR.html#a1">~ADSR</a>(<font class="keywordtype">void</font>);
-00035 
-00037   <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a2">keyOn</a>(<font class="keywordtype">void</font>);
-00038 
-00040   <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a3">keyOff</a>(<font class="keywordtype">void</font>);
-00041 
-00043   <font class="keywordtype">void</font> <a class="code" href="classADSR.html#a4">setAttackRate</a>(MY_FLOAT aRate);
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classADSR.html#a5">setDecayRate</a>(MY_FLOAT aRate);
-00047 
-00049   <font class="keywordtype">void</font> <a class="code" href="classADSR.html#a6">setSustainLevel</a>(MY_FLOAT aLevel);
-00050 
-00052   <font class="keywordtype">void</font> <a class="code" href="classADSR.html#a7">setReleaseRate</a>(MY_FLOAT aRate);
-00053 
-00055   <font class="keywordtype">void</font> <a class="code" href="classADSR.html#a8">setAttackTime</a>(MY_FLOAT aTime);
-00056 
-00058   <font class="keywordtype">void</font> <a class="code" href="classADSR.html#a9">setDecayTime</a>(MY_FLOAT aTime);
-00059 
-00061   <font class="keywordtype">void</font> <a class="code" href="classADSR.html#a10">setReleaseTime</a>(MY_FLOAT aTime);
-00062 
-00064   <font class="keywordtype">void</font> <a class="code" href="classADSR.html#a11">setAllTimes</a>(MY_FLOAT aTime, MY_FLOAT dTime, MY_FLOAT sLevel, MY_FLOAT rTime);
-00065 
-00067   <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a6">setTarget</a>(MY_FLOAT aTarget);
-00068 
-00070   <font class="keywordtype">int</font> <a class="code" href="classEnvelope.html#a8">getState</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00071 
-00073   <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a7">setValue</a>(MY_FLOAT aValue);
-00074 
-00076   MY_FLOAT <a class="code" href="classEnvelope.html#a9">tick</a>(<font class="keywordtype">void</font>);
-00077 
-00079   MY_FLOAT *<a class="code" href="classEnvelope.html#a9">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00080 
-00081  <font class="keyword">protected</font>:  
-00082   MY_FLOAT attackRate;
-00083   MY_FLOAT decayRate;
-00084   MY_FLOAT sustainLevel;
-00085   MY_FLOAT releaseRate;
-00086 };
-00087 
-00088 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/BandedWG_8h-source.html

@@ -1,91 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>BandedWG.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00030 <font class="comment">/***************************************************/</font>
-00031 
-00032 <font class="preprocessor">#if !defined(__BANDEDWG_H)</font>
-00033 <font class="preprocessor"></font><font class="preprocessor">#define __BANDEDWG_H</font>
-00034 <font class="preprocessor"></font>
-00035 <font class="preprocessor">#define MAX_BANDED_MODES 20</font>
-00036 <font class="preprocessor"></font>
-00037 <font class="preprocessor">#include "Instrmnt.h"</font>
-00038 <font class="preprocessor">#include "DelayL.h"</font>
-00039 <font class="preprocessor">#include "BowTabl.h"</font>
-00040 <font class="preprocessor">#include "ADSR.h"</font>
-00041 <font class="preprocessor">#include "BiQuad.h"</font>
-00042 
-00043 <font class="keyword">class </font><a class="code" href="classBandedWG.html">BandedWG</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00044 {
-00045  <font class="keyword">public</font>:
-00047   <a class="code" href="classBandedWG.html#a0">BandedWG</a>();
-00048 
-00050   <a class="code" href="classBandedWG.html#a1">~BandedWG</a>();
-00051 
-00053   <font class="keywordtype">void</font> <a class="code" href="classBandedWG.html#a2">clear</a>();
-00054 
-00056   <font class="keywordtype">void</font> <a class="code" href="classBandedWG.html#a3">setStrikePosition</a>(MY_FLOAT position);
-00057 
-00059   <font class="keywordtype">void</font> <a class="code" href="classBandedWG.html#a4">setPreset</a>(<font class="keywordtype">int</font> preset);
-00060 
-00062   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00063 
-00065   <font class="keywordtype">void</font> <a class="code" href="classBandedWG.html#a6">startBowing</a>(MY_FLOAT amplitude, MY_FLOAT rate);
-00066 
-00068   <font class="keywordtype">void</font> <a class="code" href="classBandedWG.html#a7">stopBowing</a>(MY_FLOAT rate);
-00069 
-00071   <font class="keywordtype">void</font> <a class="code" href="classBandedWG.html#a8">pluck</a>(MY_FLOAT amp);
-00072 
-00074   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00075 
-00077   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00078 
-00080   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00081 
-00083   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00084 
-00085  <font class="keyword">protected</font>:
-00086 
-00087   <font class="keywordtype">bool</font> doPluck;
-00088   <font class="keywordtype">bool</font> trackVelocity;
-00089   <font class="keywordtype">int</font> nModes;
-00090   <font class="keywordtype">int</font> presetModes;
-00091   <a class="code" href="classBowTabl.html">BowTabl</a> *bowTabl;
-00092   <a class="code" href="classADSR.html">ADSR</a> *adsr;
-00093   <a class="code" href="classBiQuad.html">BiQuad</a> *bandpass;
-00094   <a class="code" href="classDelayL.html">DelayL</a> *delay;
-00095   MY_FLOAT maxVelocity;
-00096   MY_FLOAT modes[MAX_BANDED_MODES];
-00097   MY_FLOAT freakency;
-00098   MY_FLOAT baseGain;
-00099   MY_FLOAT gains[MAX_BANDED_MODES];
-00100   MY_FLOAT basegains[MAX_BANDED_MODES];
-00101   MY_FLOAT excitation[MAX_BANDED_MODES];
-00102   MY_FLOAT integrationConstant;
-00103   MY_FLOAT velocityInput;
-00104   MY_FLOAT bowVelocity;
-00105   MY_FLOAT bowTarget;
-00106   MY_FLOAT bowPosition;
-00107   MY_FLOAT strikeAmp;
-00108   <font class="keywordtype">int</font> strikePosition;
-00109 
-00110 };
-00111 
-00112 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/BeeThree_8h-source.html

@@ -1,41 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>BeeThree.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00033 <font class="comment">/***************************************************/</font>
-00034 
-00035 <font class="preprocessor">#if !defined(__BEETHREE_H)</font>
-00036 <font class="preprocessor"></font><font class="preprocessor">#define __BEETHREE_H</font>
-00037 <font class="preprocessor"></font>
-00038 <font class="preprocessor">#include "FM.h"</font>
-00039 
-00040 <font class="keyword">class </font><a class="code" href="classBeeThree.html">BeeThree</a> : <font class="keyword">public</font> <a class="code" href="classFM.html">FM</a>
-00041 {
-00042  <font class="keyword">public</font>:
-00044   <a class="code" href="classBeeThree.html#a0">BeeThree</a>();
-00045 
-00047   <a class="code" href="classBeeThree.html#a1">~BeeThree</a>();
-00048 
-00050   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00051 
-00053   MY_FLOAT <a class="code" href="classFM.html#a14">tick</a>();
-00054 };
-00055 
-00056 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/BiQuad_8h-source.html

@@ -1,70 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>BiQuad.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00013 <font class="comment">/***************************************************/</font>
-00014 
-00015 <font class="preprocessor">#if !defined(__BIQUAD_H)</font>
-00016 <font class="preprocessor"></font><font class="preprocessor">#define __BIQUAD_H</font>
-00017 <font class="preprocessor"></font>
-00018 <font class="preprocessor">#include "Filter.h"</font>
-00019 
-00020 <font class="keyword">class </font><a class="code" href="classBiQuad.html">BiQuad</a> : <font class="keyword">protected</font> <a class="code" href="classFilter.html">Filter</a>
-00021 {
-00022 <font class="keyword">public</font>:
-00023 
-00025   <a class="code" href="classBiQuad.html#a0">BiQuad</a>();
-00026 
-00028   <font class="keyword">virtual</font> <a class="code" href="classBiQuad.html#a1">~BiQuad</a>();
-00029 
-00031   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a3">clear</a>(<font class="keywordtype">void</font>);
-00032 
-00034   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a3">setB0</a>(MY_FLOAT b0);
-00035 
-00037   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a4">setB1</a>(MY_FLOAT b1);
-00038 
-00040   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a5">setB2</a>(MY_FLOAT b2);
-00041 
-00043   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a6">setA1</a>(MY_FLOAT a1);
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a7">setA2</a>(MY_FLOAT a2);
-00047 
-00049 
-00060   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a8">setResonance</a>(MY_FLOAT frequency, MY_FLOAT radius, <font class="keywordtype">bool</font> normalize = FALSE);
-00061 
-00063 
-00069   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a9">setNotch</a>(MY_FLOAT frequency, MY_FLOAT radius);
-00070 
-00072 
-00078   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a10">setEqualGainZeroes</a>();
-00079 
-00081 
-00085   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a7">setGain</a>(MY_FLOAT theGain);
-00086 
-00088   MY_FLOAT <a class="code" href="classFilter.html#a8">getGain</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00089 
-00091   MY_FLOAT <a class="code" href="classFilter.html#a9">lastOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00092 
-00094   MY_FLOAT <a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT sample);
-00095 
-00097   MY_FLOAT *<a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00098 };
-00099 
-00100 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/BlowBotl_8h-source.html

@@ -1,72 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>BlowBotl.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00017 <font class="comment">/***************************************************/</font>
-00018 
-00019 <font class="preprocessor">#if !defined(__BOTTLE_H)</font>
-00020 <font class="preprocessor"></font><font class="preprocessor">#define __BOTTLE_H</font>
-00021 <font class="preprocessor"></font>
-00022 <font class="preprocessor">#include "Instrmnt.h"</font>
-00023 <font class="preprocessor">#include "JetTabl.h"</font>
-00024 <font class="preprocessor">#include "BiQuad.h"</font>
-00025 <font class="preprocessor">#include "PoleZero.h"</font>
-00026 <font class="preprocessor">#include "Noise.h"</font>
-00027 <font class="preprocessor">#include "ADSR.h"</font>
-00028 <font class="preprocessor">#include "WaveLoop.h"</font>
-00029 
-00030 <font class="keyword">class </font><a class="code" href="classBlowBotl.html">BlowBotl</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00031 {
-00032  <font class="keyword">public</font>:
-00034   <a class="code" href="classBlowBotl.html#a0">BlowBotl</a>();
-00035 
-00037   <a class="code" href="classBlowBotl.html#a1">~BlowBotl</a>();
-00038 
-00040   <font class="keywordtype">void</font> <a class="code" href="classBlowBotl.html#a2">clear</a>();
-00041 
-00043   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classBlowBotl.html#a4">startBlowing</a>(MY_FLOAT amplitude, MY_FLOAT rate);
-00047 
-00049   <font class="keywordtype">void</font> <a class="code" href="classBlowBotl.html#a5">stopBlowing</a>(MY_FLOAT rate);
-00050 
-00052   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00053 
-00055   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00056 
-00058   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00059 
-00061   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00062 
-00063  <font class="keyword">protected</font>:  
-00064   <a class="code" href="classJetTabl.html">JetTabl</a> *jetTable;
-00065   <a class="code" href="classBiQuad.html">BiQuad</a> *resonator;
-00066   <a class="code" href="classPoleZero.html">PoleZero</a> *dcBlock;
-00067   <a class="code" href="classNoise.html">Noise</a> *noise;
-00068   <a class="code" href="classADSR.html">ADSR</a> *adsr;
-00069   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00070   MY_FLOAT maxPressure;
-00071   MY_FLOAT noiseGain;
-00072   MY_FLOAT vibratoGain;
-00073   MY_FLOAT outputGain;
-00074 
-00075 };
-00076 
-00077 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/BlowHole_8h-source.html

@@ -1,84 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>BlowHole.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00034 <font class="comment">/***************************************************/</font>
-00035 
-00036 <font class="preprocessor">#if !defined(__BLOWHOLE_H)</font>
-00037 <font class="preprocessor"></font><font class="preprocessor">#define __BLOWHOLE_H</font>
-00038 <font class="preprocessor"></font>
-00039 <font class="preprocessor">#include "Instrmnt.h"</font>
-00040 <font class="preprocessor">#include "DelayL.h"</font>
-00041 <font class="preprocessor">#include "ReedTabl.h"</font>
-00042 <font class="preprocessor">#include "OneZero.h"</font>
-00043 <font class="preprocessor">#include "PoleZero.h"</font>
-00044 <font class="preprocessor">#include "Envelope.h"</font>
-00045 <font class="preprocessor">#include "Noise.h"</font>
-00046 <font class="preprocessor">#include "WaveLoop.h"</font>
-00047 
-00048 <font class="keyword">class </font><a class="code" href="classBlowHole.html">BlowHole</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00049 {
-00050  <font class="keyword">public</font>:
-00052   <a class="code" href="classBlowHole.html#a0">BlowHole</a>(MY_FLOAT lowestFrequency);
-00053 
-00055   <a class="code" href="classBlowHole.html#a1">~BlowHole</a>();
-00056 
-00058   <font class="keywordtype">void</font> <a class="code" href="classBlowHole.html#a2">clear</a>();
-00059 
-00061   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00062 
-00064   <font class="keywordtype">void</font> <a class="code" href="classBlowHole.html#a4">setTonehole</a>(MY_FLOAT newValue);
-00065 
-00067   <font class="keywordtype">void</font> <a class="code" href="classBlowHole.html#a5">setVent</a>(MY_FLOAT newValue);
-00068 
-00070   <font class="keywordtype">void</font> <a class="code" href="classBlowHole.html#a6">startBlowing</a>(MY_FLOAT amplitude, MY_FLOAT rate);
-00071 
-00073   <font class="keywordtype">void</font> <a class="code" href="classBlowHole.html#a7">stopBlowing</a>(MY_FLOAT rate);
-00074 
-00076   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00077 
-00079   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00080 
-00082   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00083 
-00085   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00086 
-00087  <font class="keyword">protected</font>:  
-00088   <a class="code" href="classDelayL.html">DelayL</a> *delays[3];
-00089   <a class="code" href="classReedTabl.html">ReedTabl</a> *reedTable;
-00090   <a class="code" href="classOneZero.html">OneZero</a> *filter;
-00091   <a class="code" href="classPoleZero.html">PoleZero</a> *tonehole;
-00092   <a class="code" href="classPoleZero.html">PoleZero</a> *vent;
-00093   <a class="code" href="classEnvelope.html">Envelope</a> *envelope;
-00094   <a class="code" href="classNoise.html">Noise</a> *noise;
-00095   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00096   <font class="keywordtype">long</font> length;
-00097   MY_FLOAT scatter;
-00098   MY_FLOAT th_coeff;
-00099   MY_FLOAT r_th;
-00100   MY_FLOAT rh_coeff;
-00101   MY_FLOAT rh_gain;
-00102   MY_FLOAT outputGain;
-00103   MY_FLOAT noiseGain;
-00104   MY_FLOAT vibratoGain;
-00105 
-00106 };
-00107 
-00108 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/BowTabl_8h-source.html

@@ -1,56 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>BowTabl.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00010 <font class="comment">/***************************************************/</font>
-00011 
-00012 <font class="preprocessor">#if !defined(__BOWTABL_H)</font>
-00013 <font class="preprocessor"></font><font class="preprocessor">#define __BOWTABL_H</font>
-00014 <font class="preprocessor"></font>
-00015 <font class="preprocessor">#include "Stk.h"</font>
-00016 
-00017 <font class="keyword">class </font><a class="code" href="classBowTabl.html">BowTabl</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00018 {
-00019 <font class="keyword">public</font>:
-00021   <a class="code" href="classBowTabl.html#a0">BowTabl</a>();
-00022 
-00024   <a class="code" href="classBowTabl.html#a1">~BowTabl</a>();
-00025 
-00027 
-00033   <font class="keywordtype">void</font> <a class="code" href="classBowTabl.html#a2">setOffset</a>(MY_FLOAT aValue);
-00034 
-00036 
-00040   <font class="keywordtype">void</font> <a class="code" href="classBowTabl.html#a3">setSlope</a>(MY_FLOAT aValue);
-00041 
-00043   MY_FLOAT <a class="code" href="classBowTabl.html#a4">lastOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00044 
-00046 
-00050   MY_FLOAT <a class="code" href="classBowTabl.html#a5">tick</a>(<font class="keyword">const</font> MY_FLOAT input);
-00051 
-00053   MY_FLOAT *<a class="code" href="classBowTabl.html#a5">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00054 
-00055 <font class="keyword">protected</font>:  
-00056   MY_FLOAT offSet;
-00057   MY_FLOAT slope;
-00058   MY_FLOAT lastOutput;
-00059 
-00060 };
-00061 
-00062 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Bowed_8h-source.html

@@ -1,75 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Bowed.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00022 <font class="comment">/***************************************************/</font>
-00023 
-00024 <font class="preprocessor">#if !defined(__BOWED_H)</font>
-00025 <font class="preprocessor"></font><font class="preprocessor">#define __BOWED_H</font>
-00026 <font class="preprocessor"></font>
-00027 <font class="preprocessor">#include "Instrmnt.h"</font>
-00028 <font class="preprocessor">#include "DelayL.h"</font>
-00029 <font class="preprocessor">#include "BowTabl.h"</font>
-00030 <font class="preprocessor">#include "OnePole.h"</font>
-00031 <font class="preprocessor">#include "BiQuad.h"</font>
-00032 <font class="preprocessor">#include "WaveLoop.h"</font>
-00033 <font class="preprocessor">#include "ADSR.h"</font>
-00034 
-00035 <font class="keyword">class </font><a class="code" href="classBowed.html">Bowed</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00036 {
-00037  <font class="keyword">public</font>:
-00039   <a class="code" href="classBowed.html#a0">Bowed</a>(MY_FLOAT lowestFrequency);
-00040 
-00042   <a class="code" href="classBowed.html#a1">~Bowed</a>();
-00043 
-00045   <font class="keywordtype">void</font> <a class="code" href="classBowed.html#a2">clear</a>();
-00046 
-00048   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00049 
-00051   <font class="keywordtype">void</font> <a class="code" href="classBowed.html#a4">setVibrato</a>(MY_FLOAT gain);
-00052 
-00054   <font class="keywordtype">void</font> <a class="code" href="classBowed.html#a5">startBowing</a>(MY_FLOAT amplitude, MY_FLOAT rate);
-00055 
-00057   <font class="keywordtype">void</font> <a class="code" href="classBowed.html#a6">stopBowing</a>(MY_FLOAT rate);
-00058 
-00060   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00061 
-00063   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00064 
-00066   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00067 
-00069   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00070 
-00071  <font class="keyword">protected</font>:  
-00072   <a class="code" href="classDelayL.html">DelayL</a> *neckDelay;
-00073   <a class="code" href="classDelayL.html">DelayL</a> *bridgeDelay;
-00074   <a class="code" href="classBowTabl.html">BowTabl</a> *bowTable;
-00075   <a class="code" href="classOnePole.html">OnePole</a> *stringFilter;
-00076   <a class="code" href="classBiQuad.html">BiQuad</a> *bodyFilter;
-00077   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00078   <a class="code" href="classADSR.html">ADSR</a> *adsr;
-00079   MY_FLOAT maxVelocity;
-00080   MY_FLOAT baseDelay;
-00081   MY_FLOAT vibratoGain;
-00082   MY_FLOAT betaRatio;
-00083 
-00084 };
-00085 
-00086 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Brass_8h-source.html

@@ -1,73 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Brass.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00021 <font class="comment">/***************************************************/</font>
-00022 
-00023 <font class="preprocessor">#if !defined(__BRASS_H)</font>
-00024 <font class="preprocessor"></font><font class="preprocessor">#define __BRASS_H</font>
-00025 <font class="preprocessor"></font>
-00026 <font class="preprocessor">#include "Instrmnt.h"</font>
-00027 <font class="preprocessor">#include "DelayA.h"</font>
-00028 <font class="preprocessor">#include "BiQuad.h"</font>
-00029 <font class="preprocessor">#include "PoleZero.h"</font>
-00030 <font class="preprocessor">#include "ADSR.h"</font>
-00031 <font class="preprocessor">#include "WaveLoop.h"</font>
-00032 
-00033 <font class="keyword">class </font><a class="code" href="classBrass.html">Brass</a>: <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00034 {
-00035  <font class="keyword">public</font>:
-00037   <a class="code" href="classBrass.html#a0">Brass</a>(MY_FLOAT lowestFrequency);
-00038 
-00040   <a class="code" href="classBrass.html#a1">~Brass</a>();
-00041 
-00043   <font class="keywordtype">void</font> <a class="code" href="classBrass.html#a2">clear</a>();
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00047 
-00049   <font class="keywordtype">void</font> <a class="code" href="classBrass.html#a4">setLip</a>(MY_FLOAT frequency);
-00050 
-00052   <font class="keywordtype">void</font> <a class="code" href="classBrass.html#a5">startBlowing</a>(MY_FLOAT amplitude,MY_FLOAT rate);
-00053 
-00055   <font class="keywordtype">void</font> <a class="code" href="classBrass.html#a6">stopBlowing</a>(MY_FLOAT rate);
-00056 
-00058   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00059 
-00061   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00062 
-00064   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00065 
-00067   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00068 
-00069  <font class="keyword">protected</font>:  
-00070   <a class="code" href="classDelayA.html">DelayA</a> *delayLine;
-00071   <a class="code" href="classBiQuad.html">BiQuad</a> *lipFilter;
-00072   <a class="code" href="classPoleZero.html">PoleZero</a> *dcBlock;
-00073   <a class="code" href="classADSR.html">ADSR</a> *adsr;
-00074   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00075   <font class="keywordtype">long</font> length;
-00076   MY_FLOAT lipTarget;
-00077   MY_FLOAT slideTarget;
-00078   MY_FLOAT vibratoGain;
-00079   MY_FLOAT maxPressure;
-00080 
-00081 };
-00082 
-00083 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Chorus_8h-source.html

@@ -1,67 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Chorus.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00009 <font class="comment">/***************************************************/</font>
-00010 
-00011 <font class="preprocessor">#if !defined(__CHORUS_H)</font>
-00012 <font class="preprocessor"></font><font class="preprocessor">#define __CHORUS_H</font>
-00013 <font class="preprocessor"></font>
-00014 <font class="preprocessor">#include "Stk.h"</font> 
-00015 <font class="preprocessor">#include "DelayL.h"</font> 
-00016 <font class="preprocessor">#include "WaveLoop.h"</font> 
-00017 
-00018 <font class="keyword">class </font><a class="code" href="classChorus.html">Chorus</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00019 {
-00020  <font class="keyword">public</font>:
-00022   <a class="code" href="classChorus.html#a0">Chorus</a>(MY_FLOAT baseDelay);
-00023 
-00025   <a class="code" href="classChorus.html#a1">~Chorus</a>();
-00026 
-00028   <font class="keywordtype">void</font> <a class="code" href="classChorus.html#a2">clear</a>();
-00029 
-00031   <font class="keywordtype">void</font> <a class="code" href="classChorus.html#a3">setModDepth</a>(MY_FLOAT depth);
-00032 
-00034   <font class="keywordtype">void</font> <a class="code" href="classChorus.html#a4">setModFrequency</a>(MY_FLOAT frequency);
-00035 
-00037   <font class="keywordtype">void</font> <a class="code" href="classChorus.html#a5">setEffectMix</a>(MY_FLOAT mix);
-00038 
-00040   MY_FLOAT <a class="code" href="classChorus.html#a6">lastOut</a>() <font class="keyword">const</font>;
-00041 
-00043   MY_FLOAT <a class="code" href="classChorus.html#a7">lastOutLeft</a>() <font class="keyword">const</font>;
-00044 
-00046   MY_FLOAT <a class="code" href="classChorus.html#a8">lastOutRight</a>() <font class="keyword">const</font>;
-00047 
-00049   MY_FLOAT <a class="code" href="classChorus.html#a9">tick</a>(MY_FLOAT input);
-00050 
-00052   MY_FLOAT *<a class="code" href="classChorus.html#a9">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00053 
-00054  <font class="keyword">protected</font>:  
-00055   <a class="code" href="classDelayL.html">DelayL</a> *delayLine[2];
-00056   <a class="code" href="classWaveLoop.html">WaveLoop</a> *mods[2];
-00057   MY_FLOAT baseLength;
-00058   MY_FLOAT modDepth;
-00059   MY_FLOAT lastOutput[2];
-00060   MY_FLOAT effectMix;
-00061 
-00062 };
-00063 
-00064 <font class="preprocessor">#endif</font>
-00065 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Clarinet_8h-source.html

@@ -1,72 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Clarinet.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00023 <font class="comment">/***************************************************/</font>
-00024 
-00025 <font class="preprocessor">#if !defined(__CLARINET_H)</font>
-00026 <font class="preprocessor"></font><font class="preprocessor">#define __CLARINET_H</font>
-00027 <font class="preprocessor"></font>
-00028 <font class="preprocessor">#include "Instrmnt.h"</font>
-00029 <font class="preprocessor">#include "DelayL.h"</font>
-00030 <font class="preprocessor">#include "ReedTabl.h"</font>
-00031 <font class="preprocessor">#include "OneZero.h"</font>
-00032 <font class="preprocessor">#include "Envelope.h"</font>
-00033 <font class="preprocessor">#include "Noise.h"</font>
-00034 <font class="preprocessor">#include "WaveLoop.h"</font>
-00035 
-00036 <font class="keyword">class </font><a class="code" href="classClarinet.html">Clarinet</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00037 {
-00038  <font class="keyword">public</font>:
-00040   <a class="code" href="classClarinet.html#a0">Clarinet</a>(MY_FLOAT lowestFrequency);
-00041 
-00043   <a class="code" href="classClarinet.html#a1">~Clarinet</a>();
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classClarinet.html#a2">clear</a>();
-00047 
-00049   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00050 
-00052   <font class="keywordtype">void</font> <a class="code" href="classClarinet.html#a4">startBlowing</a>(MY_FLOAT amplitude, MY_FLOAT rate);
-00053 
-00055   <font class="keywordtype">void</font> <a class="code" href="classClarinet.html#a5">stopBlowing</a>(MY_FLOAT rate);
-00056 
-00058   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00059 
-00061   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00062 
-00064   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00065 
-00067   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00068 
-00069  <font class="keyword">protected</font>:
-00070   <a class="code" href="classDelayL.html">DelayL</a> *delayLine;
-00071   <a class="code" href="classReedTabl.html">ReedTabl</a> *reedTable;
-00072   <a class="code" href="classOneZero.html">OneZero</a> *filter;
-00073   <a class="code" href="classEnvelope.html">Envelope</a> *envelope;
-00074   <a class="code" href="classNoise.html">Noise</a> *noise;
-00075   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00076   <font class="keywordtype">long</font> length;
-00077   MY_FLOAT outputGain;
-00078   MY_FLOAT noiseGain;
-00079   MY_FLOAT vibratoGain;
-00080 
-00081 };
-00082 
-00083 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/DelayA_8h-source.html

@@ -1,60 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>DelayA.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00023 <font class="comment">/***************************************************/</font>
-00024 
-00025 <font class="preprocessor">#if !defined(__DelayA_h)</font>
-00026 <font class="preprocessor"></font><font class="preprocessor">#define __DelayA_h</font>
-00027 <font class="preprocessor"></font>
-00028 <font class="preprocessor">#include "Delay.h"</font>
-00029 
-00030 <font class="keyword">class </font><a class="code" href="classDelayA.html">DelayA</a> : <font class="keyword">public</font> <a class="code" href="classDelay.html">Delay</a>
-00031 {
-00032 <font class="keyword">public</font>:
-00033 
-00035   <a class="code" href="classDelayA.html#a0">DelayA</a>();
-00036 
-00038   
-00039   <a class="code" href="classDelayA.html#a0">DelayA</a>(MY_FLOAT theDelay, <font class="keywordtype">long</font> maxDelay);
-00040 
-00042   <a class="code" href="classDelayA.html#a2">~DelayA</a>();
-00043 
-00045   <font class="keywordtype">void</font> <a class="code" href="classDelay.html#a3">clear</a>();
-00046 
-00048 
-00051   <font class="keywordtype">void</font> <a class="code" href="classDelay.html#a4">setDelay</a>(MY_FLOAT theDelay);
-00052 
-00054   MY_FLOAT <a class="code" href="classDelay.html#a5">getDelay</a>(<font class="keywordtype">void</font>);
-00055 
-00057 
-00060   MY_FLOAT <a class="code" href="classDelay.html#a9">nextOut</a>(<font class="keywordtype">void</font>);
-00061 
-00063   MY_FLOAT <a class="code" href="classDelay.html#a10">tick</a>(MY_FLOAT sample);
-00064 
-00065 <font class="keyword">protected</font>:  
-00066   MY_FLOAT alpha;
-00067   MY_FLOAT coeff;
-00068   MY_FLOAT apInput;
-00069   MY_FLOAT nextOutput;
-00070   <font class="keywordtype">bool</font> doNextOut;
-00071 };
-00072 
-00073 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/DelayL_8h-source.html

@@ -1,57 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>DelayL.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00023 <font class="comment">/***************************************************/</font>
-00024 
-00025 <font class="preprocessor">#if !defined(__DELAYL_H)</font>
-00026 <font class="preprocessor"></font><font class="preprocessor">#define __DELAYL_H</font>
-00027 <font class="preprocessor"></font>
-00028 <font class="preprocessor">#include "Delay.h"</font>
-00029 
-00030 <font class="keyword">class </font><a class="code" href="classDelayL.html">DelayL</a> : <font class="keyword">public</font> <a class="code" href="classDelay.html">Delay</a>
-00031 {
-00032 <font class="keyword">public</font>:
-00033 
-00035   <a class="code" href="classDelayL.html#a0">DelayL</a>();
-00036 
-00038   
-00039   <a class="code" href="classDelayL.html#a0">DelayL</a>(MY_FLOAT theDelay, <font class="keywordtype">long</font> maxDelay);
-00040 
-00042   <a class="code" href="classDelayL.html#a2">~DelayL</a>();
-00043 
-00045 
-00048   <font class="keywordtype">void</font> <a class="code" href="classDelay.html#a4">setDelay</a>(MY_FLOAT theDelay);
-00049 
-00051   MY_FLOAT <a class="code" href="classDelay.html#a5">getDelay</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00052 
-00054 
-00057   MY_FLOAT <a class="code" href="classDelay.html#a9">nextOut</a>(<font class="keywordtype">void</font>);
-00058 
-00060   MY_FLOAT <a class="code" href="classDelay.html#a10">tick</a>(MY_FLOAT sample);
-00061 
-00062  <font class="keyword">protected</font>:  
-00063   MY_FLOAT alpha;
-00064   MY_FLOAT omAlpha;
-00065   MY_FLOAT nextOutput;
-00066   <font class="keywordtype">bool</font> doNextOut;
-00067 };
-00068 
-00069 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Delay_8h-source.html

@@ -1,68 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Delay.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00019 <font class="comment">/***************************************************/</font>
-00020 
-00021 <font class="preprocessor">#if !defined(__DELAY_H)</font>
-00022 <font class="preprocessor"></font><font class="preprocessor">#define __DELAY_H</font>
-00023 <font class="preprocessor"></font>
-00024 <font class="preprocessor">#include "Filter.h"</font>
-00025 
-00026 <font class="keyword">class </font><a class="code" href="classDelay.html">Delay</a> : <font class="keyword">protected</font> <a class="code" href="classFilter.html">Filter</a>
-00027 {
-00028 <font class="keyword">public</font>:
-00029 
-00031   <a class="code" href="classDelay.html#a0">Delay</a>();
-00032 
-00034   <a class="code" href="classDelay.html#a0">Delay</a>(<font class="keywordtype">long</font> theDelay, <font class="keywordtype">long</font> maxDelay);
-00035 
-00037   <font class="keyword">virtual</font> <a class="code" href="classDelay.html#a2">~Delay</a>();
-00038 
-00040   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a3">clear</a>();
-00041 
-00043 
-00046   <font class="keywordtype">void</font> <a class="code" href="classDelay.html#a4">setDelay</a>(<font class="keywordtype">long</font> theDelay);
-00047 
-00049   <font class="keywordtype">long</font> <a class="code" href="classDelay.html#a5">getDelay</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00050 
-00052   MY_FLOAT <a class="code" href="classDelay.html#a6">energy</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00053 
-00055 
-00058   MY_FLOAT <a class="code" href="classDelay.html#a7">contentsAt</a>(<font class="keywordtype">long</font> tapDelay) <font class="keyword">const</font>;
-00059 
-00061   MY_FLOAT <a class="code" href="classFilter.html#a9">lastOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00062 
-00064 
-00067   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classDelay.html#a9">nextOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00068 
-00070   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT sample);
-00071 
-00073   <font class="keyword">virtual</font> MY_FLOAT *<a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00074 
-00075 <font class="keyword">protected</font>:
-00076   <font class="keywordtype">long</font> inPoint;
-00077   <font class="keywordtype">long</font> outPoint;
-00078   <font class="keywordtype">long</font> length;
-00079   MY_FLOAT delay;
-00080 };
-00081 
-00082 <font class="preprocessor">#endif</font>
-00083 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Drummer_8h-source.html

@@ -1,56 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Drummer.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00016 <font class="comment">/***************************************************/</font>
-00017 
-00018 <font class="preprocessor">#if !defined(__DRUMMER_H)</font>
-00019 <font class="preprocessor"></font><font class="preprocessor">#define __DRUMMER_H</font>
-00020 <font class="preprocessor"></font>
-00021 <font class="preprocessor">#include "Instrmnt.h"</font>
-00022 <font class="preprocessor">#include "WvIn.h"</font>
-00023 <font class="preprocessor">#include "OnePole.h"</font>
-00024 
-00025 <font class="preprocessor">#define DRUM_NUMWAVES 11</font>
-00026 <font class="preprocessor"></font><font class="preprocessor">#define DRUM_POLYPHONY 4</font>
-00027 <font class="preprocessor"></font>
-00028 <font class="keyword">class </font><a class="code" href="classDrummer.html">Drummer</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00029 {
-00030  <font class="keyword">public</font>:
-00032   <a class="code" href="classDrummer.html#a0">Drummer</a>();
-00033 
-00035   <a class="code" href="classDrummer.html#a1">~Drummer</a>();
-00036 
-00038 
-00043   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT instrument, MY_FLOAT amplitude);
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00047 
-00049   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00050 
-00051  <font class="keyword">protected</font>:  
-00052   <a class="code" href="classWvIn.html">WvIn</a>    *waves[DRUM_POLYPHONY];
-00053   <a class="code" href="classOnePole.html">OnePole</a> *filters[DRUM_POLYPHONY];
-00054   <font class="keywordtype">int</font>      sounding[DRUM_POLYPHONY];
-00055   <font class="keywordtype">int</font>      nSounding;
-00056 
-00057 };
-00058 
-00059 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Echo_8h-source.html

@@ -1,58 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Echo.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00009 <font class="comment">/***************************************************/</font>
-00010 
-00011 <font class="preprocessor">#if !defined(__ECHO_H)</font>
-00012 <font class="preprocessor"></font><font class="preprocessor">#define __ECHO_H</font>
-00013 <font class="preprocessor"></font>
-00014 <font class="preprocessor">#include "Stk.h"</font> 
-00015 <font class="preprocessor">#include "Delay.h"</font> 
-00016 
-00017 <font class="keyword">class </font><a class="code" href="classEcho.html">Echo</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00018 {
-00019  <font class="keyword">public</font>:
-00021   <a class="code" href="classEcho.html#a0">Echo</a>(MY_FLOAT longestDelay);
-00022 
-00024   <a class="code" href="classEcho.html#a1">~Echo</a>();
-00025 
-00027   <font class="keywordtype">void</font> <a class="code" href="classEcho.html#a2">clear</a>();
-00028 
-00030   <font class="keywordtype">void</font> <a class="code" href="classEcho.html#a3">setDelay</a>(MY_FLOAT delay);
-00031 
-00033   <font class="keywordtype">void</font> <a class="code" href="classEcho.html#a4">setEffectMix</a>(MY_FLOAT mix);
-00034 
-00036   MY_FLOAT <a class="code" href="classEcho.html#a5">lastOut</a>() <font class="keyword">const</font>;
-00037 
-00039   MY_FLOAT <a class="code" href="classEcho.html#a6">tick</a>(MY_FLOAT input);
-00040 
-00042   MY_FLOAT *<a class="code" href="classEcho.html#a6">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00043 
-00044  <font class="keyword">protected</font>:  
-00045   <a class="code" href="classDelay.html">Delay</a> *delayLine;
-00046   <font class="keywordtype">long</font> length;
-00047   MY_FLOAT lastOutput;
-00048   MY_FLOAT effectMix;
-00049 
-00050 };
-00051 
-00052 <font class="preprocessor">#endif</font>
-00053 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Envelope_8h-source.html

@@ -1,64 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Envelope.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00014 <font class="comment">/***************************************************/</font>
-00015 
-00016 <font class="preprocessor">#if !defined(__ENVELOPE_H)</font>
-00017 <font class="preprocessor"></font><font class="preprocessor">#define __ENVELOPE_H</font>
-00018 <font class="preprocessor"></font>
-00019 <font class="preprocessor">#include "Stk.h"</font>
-00020 
-00021 <font class="keyword">class </font><a class="code" href="classEnvelope.html">Envelope</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00022 {
-00023  <font class="keyword">public</font>:
-00024 
-00026   <a class="code" href="classEnvelope.html#a0">Envelope</a>(<font class="keywordtype">void</font>);
-00027 
-00029   <font class="keyword">virtual</font> <a class="code" href="classEnvelope.html#a1">~Envelope</a>(<font class="keywordtype">void</font>);
-00030 
-00032   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a2">keyOn</a>(<font class="keywordtype">void</font>);
-00033 
-00035   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a3">keyOff</a>(<font class="keywordtype">void</font>);
-00036 
-00038   <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a4">setRate</a>(MY_FLOAT aRate);
-00039 
-00041   <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a5">setTime</a>(MY_FLOAT aTime);
-00042 
-00044   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a6">setTarget</a>(MY_FLOAT aTarget);
-00045 
-00047   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classEnvelope.html#a7">setValue</a>(MY_FLOAT aValue);
-00048 
-00050   <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="classEnvelope.html#a8">getState</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00051 
-00053   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classEnvelope.html#a9">tick</a>(<font class="keywordtype">void</font>);
-00054 
-00056   <font class="keyword">virtual</font> MY_FLOAT *<a class="code" href="classEnvelope.html#a9">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00057 
-00059   MY_FLOAT <a class="code" href="classEnvelope.html#a11">lastOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00060 
-00061  <font class="keyword">protected</font>:
-00062   MY_FLOAT value;
-00063   MY_FLOAT target;
-00064   MY_FLOAT rate;
-00065   <font class="keywordtype">int</font> state;
-00066 };
-00067 
-00068 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/FMVoices_8h-source.html

@@ -1,50 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>FMVoices.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00031 <font class="comment">/***************************************************/</font>
-00032 
-00033 <font class="preprocessor">#if !defined(__FMVOICES_H)</font>
-00034 <font class="preprocessor"></font><font class="preprocessor">#define __FMVOICES_H</font>
-00035 <font class="preprocessor"></font>
-00036 <font class="preprocessor">#include "FM.h"</font>
-00037 
-00038 <font class="keyword">class </font><a class="code" href="classFMVoices.html">FMVoices</a> : <font class="keyword">public</font> <a class="code" href="classFM.html">FM</a>
-00039 {
-00040  <font class="keyword">public</font>:
-00042   <a class="code" href="classFMVoices.html#a0">FMVoices</a>();
-00043 
-00045   <a class="code" href="classFMVoices.html#a1">~FMVoices</a>();
-00046 
-00048   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classFM.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00049 
-00051   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00052 
-00054   MY_FLOAT <a class="code" href="classFM.html#a14">tick</a>();
-00055 
-00057   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classFM.html#a15">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00058 
-00059  <font class="keyword">protected</font>:
-00060   <font class="keywordtype">int</font> currentVowel;
-00061   MY_FLOAT tilt[3];
-00062   MY_FLOAT mods[3];
-00063 };
-00064 
-00065 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/FM_8h-source.html

@@ -1,85 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>FM.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00024 <font class="comment">/***************************************************/</font>
-00025 
-00026 <font class="preprocessor">#if !defined(__FM_H)</font>
-00027 <font class="preprocessor"></font><font class="preprocessor">#define __FM_H</font>
-00028 <font class="preprocessor"></font>
-00029 <font class="preprocessor">#include "Instrmnt.h"</font>
-00030 <font class="preprocessor">#include "ADSR.h"</font>
-00031 <font class="preprocessor">#include "WaveLoop.h"</font>
-00032 <font class="preprocessor">#include "TwoZero.h"</font>
-00033 
-00034 <font class="keyword">class </font><a class="code" href="classFM.html">FM</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00035 {
-00036  <font class="keyword">public</font>:
-00038   <a class="code" href="classFM.html#a0">FM</a>( <font class="keywordtype">int</font> operators = 4 );
-00039 
-00041   <font class="keyword">virtual</font> <a class="code" href="classFM.html#a1">~FM</a>();
-00042 
-00044   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a2">clear</a>();
-00045 
-00047   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a3">loadWaves</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> **filenames);
-00048 
-00050   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00051 
-00053   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a5">setRatio</a>(<font class="keywordtype">int</font> waveIndex, MY_FLOAT ratio);
-00054 
-00056   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a6">setGain</a>(<font class="keywordtype">int</font> waveIndex, MY_FLOAT gain);
-00057 
-00059   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a7">setModulationSpeed</a>(MY_FLOAT mSpeed);
-00060 
-00062   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a8">setModulationDepth</a>(MY_FLOAT mDepth);
-00063 
-00065   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a9">setControl1</a>(MY_FLOAT cVal);
-00066 
-00068   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a10">setControl2</a>(MY_FLOAT cVal);
-00069 
-00071   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a11">keyOn</a>();
-00072 
-00074   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a12">keyOff</a>();
-00075 
-00077   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00078 
-00080   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>() = 0;
-00081 
-00083   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00084 
-00085  <font class="keyword">protected</font>:  
-00086   <a class="code" href="classADSR.html">ADSR</a>     **adsr; 
-00087   <a class="code" href="classWaveLoop.html">WaveLoop</a> **waves;
-00088   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00089   <a class="code" href="classTwoZero.html">TwoZero</a>  *twozero;
-00090   <font class="keywordtype">int</font> nOperators;
-00091   MY_FLOAT baseFrequency;
-00092   MY_FLOAT *ratios;
-00093   MY_FLOAT *gains;
-00094   MY_FLOAT modDepth;
-00095   MY_FLOAT control1;
-00096   MY_FLOAT control2;
-00097   MY_FLOAT __FM_gains[100];
-00098   MY_FLOAT __FM_susLevels[16];
-00099   MY_FLOAT __FM_attTimes[32];
-00100 
-00101 };
-00102 
-00103 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Filter_8h-source.html

@@ -1,72 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Filter.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00028 <font class="comment">/***************************************************/</font>
-00029 
-00030 <font class="preprocessor">#if !defined(__FILTER_H)</font>
-00031 <font class="preprocessor"></font><font class="preprocessor">#define __FILTER_H</font>
-00032 <font class="preprocessor"></font>
-00033 <font class="preprocessor">#include "Stk.h"</font>
-00034 
-00035 <font class="keyword">class </font><a class="code" href="classFilter.html">Filter</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00036 {
-00037 <font class="keyword">public</font>:
-00039   <a class="code" href="classFilter.html#a0">Filter</a>(<font class="keywordtype">void</font>);
-00040 
-00042 
-00046   <a class="code" href="classFilter.html#a0">Filter</a>(<font class="keywordtype">int</font> nb, MY_FLOAT *bCoefficients, <font class="keywordtype">int</font> na, MY_FLOAT *aCoefficients);
-00047 
-00049   <font class="keyword">virtual</font> <a class="code" href="classFilter.html#a2">~Filter</a>(<font class="keywordtype">void</font>);
-00050 
-00052   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a3">clear</a>(<font class="keywordtype">void</font>);
-00053 
-00055 
-00060   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a4">setCoefficients</a>(<font class="keywordtype">int</font> nb, MY_FLOAT *bCoefficients, <font class="keywordtype">int</font> na, MY_FLOAT *aCoefficients);
-00061 
-00063 
-00069   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a5">setNumerator</a>(<font class="keywordtype">int</font> nb, MY_FLOAT *bCoefficients);
-00070 
-00072 
-00080   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a6">setDenominator</a>(<font class="keywordtype">int</font> na, MY_FLOAT *aCoefficients);
-00081 
-00083 
-00087   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a7">setGain</a>(MY_FLOAT theGain);
-00088 
-00090   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classFilter.html#a8">getGain</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00091 
-00093   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classFilter.html#a9">lastOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00094 
-00096   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT sample);
-00097 
-00099   <font class="keyword">virtual</font> MY_FLOAT *<a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00100 
-00101 <font class="keyword">protected</font>:
-00102   MY_FLOAT gain;
-00103   <font class="keywordtype">int</font>     nB;
-00104   <font class="keywordtype">int</font>     nA;
-00105   MY_FLOAT *b;
-00106   MY_FLOAT *a;
-00107   MY_FLOAT *outputs;
-00108   MY_FLOAT *inputs;
-00109 
-00110 };
-00111 
-00112 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Flute_8h-source.html

@@ -1,86 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Flute.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00023 <font class="comment">/***************************************************/</font>
-00024 
-00025 <font class="preprocessor">#if !defined(__FLUTE_H)</font>
-00026 <font class="preprocessor"></font><font class="preprocessor">#define __FLUTE_H</font>
-00027 <font class="preprocessor"></font>
-00028 <font class="preprocessor">#include "Instrmnt.h"</font>
-00029 <font class="preprocessor">#include "JetTabl.h"</font>
-00030 <font class="preprocessor">#include "DelayL.h"</font>
-00031 <font class="preprocessor">#include "OnePole.h"</font>
-00032 <font class="preprocessor">#include "PoleZero.h"</font>
-00033 <font class="preprocessor">#include "Noise.h"</font>
-00034 <font class="preprocessor">#include "ADSR.h"</font>
-00035 <font class="preprocessor">#include "WaveLoop.h"</font>
-00036 
-00037 <font class="keyword">class </font><a class="code" href="classFlute.html">Flute</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00038 {
-00039  <font class="keyword">public</font>:
-00041   <a class="code" href="classFlute.html#a0">Flute</a>(MY_FLOAT lowestFrequency);
-00042 
-00044   <a class="code" href="classFlute.html#a1">~Flute</a>();
-00045 
-00047   <font class="keywordtype">void</font> <a class="code" href="classFlute.html#a2">clear</a>();
-00048 
-00050   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00051 
-00053   <font class="keywordtype">void</font> <a class="code" href="classFlute.html#a4">setJetReflection</a>(MY_FLOAT coefficient);
-00054 
-00056   <font class="keywordtype">void</font> <a class="code" href="classFlute.html#a5">setEndReflection</a>(MY_FLOAT coefficient);
-00057 
-00059   <font class="keywordtype">void</font> <a class="code" href="classFlute.html#a6">setJetDelay</a>(MY_FLOAT aRatio);
-00060 
-00062   <font class="keywordtype">void</font> <a class="code" href="classFlute.html#a7">startBlowing</a>(MY_FLOAT amplitude, MY_FLOAT rate);
-00063 
-00065   <font class="keywordtype">void</font> <a class="code" href="classFlute.html#a8">stopBlowing</a>(MY_FLOAT rate);
-00066 
-00068   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00069 
-00071   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00072 
-00074   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00075 
-00077   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00078 
-00079  <font class="keyword">protected</font>:  
-00080   <a class="code" href="classDelayL.html">DelayL</a> *jetDelay;
-00081   <a class="code" href="classDelayL.html">DelayL</a> *boreDelay;
-00082   <a class="code" href="classJetTabl.html">JetTabl</a> *jetTable;
-00083   <a class="code" href="classOnePole.html">OnePole</a> *filter;
-00084   <a class="code" href="classPoleZero.html">PoleZero</a> *dcBlock;
-00085   <a class="code" href="classNoise.html">Noise</a> *noise;
-00086   <a class="code" href="classADSR.html">ADSR</a> *adsr;
-00087   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00088   <font class="keywordtype">long</font> length;
-00089   MY_FLOAT lastFrequency;
-00090   MY_FLOAT maxPressure;
-00091   MY_FLOAT jetReflection;
-00092   MY_FLOAT endReflection;
-00093   MY_FLOAT noiseGain;
-00094   MY_FLOAT vibratoGain;
-00095   MY_FLOAT outputGain;
-00096   MY_FLOAT jetRatio;
-00097 
-00098 };
-00099 
-00100 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/FormSwep_8h-source.html

@@ -1,72 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>FormSwep.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00013 <font class="comment">/***************************************************/</font>
-00014 
-00015 <font class="preprocessor">#if !defined(__FORMSWEP_H)</font>
-00016 <font class="preprocessor"></font><font class="preprocessor">#define __FORMSWEP_H</font>
-00017 <font class="preprocessor"></font>
-00018 <font class="preprocessor">#include "BiQuad.h"</font>
-00019 
-00020 <font class="keyword">class </font><a class="code" href="classFormSwep.html">FormSwep</a> : <font class="keyword">public</font> <a class="code" href="classBiQuad.html">BiQuad</a>
-00021 {
-00022  <font class="keyword">public</font>:
-00023 
-00025   <a class="code" href="classFormSwep.html#a0">FormSwep</a>();
-00026 
-00028   <a class="code" href="classFormSwep.html#a1">~FormSwep</a>();
-00029 
-00031 
-00042   <font class="keywordtype">void</font> <a class="code" href="classBiQuad.html#a8">setResonance</a>(MY_FLOAT aFrequency, MY_FLOAT aRadius);
-00043 
-00045   <font class="keywordtype">void</font> <a class="code" href="classFormSwep.html#a3">setStates</a>(MY_FLOAT aFrequency, MY_FLOAT aRadius, MY_FLOAT aGain = 1.0);
-00046 
-00048   <font class="keywordtype">void</font> <a class="code" href="classFormSwep.html#a4">setTargets</a>(MY_FLOAT aFrequency, MY_FLOAT aRadius, MY_FLOAT aGain = 1.0);
-00049 
-00051 
-00059   <font class="keywordtype">void</font> <a class="code" href="classFormSwep.html#a5">setSweepRate</a>(MY_FLOAT aRate);    
-00060 
-00062 
-00067   <font class="keywordtype">void</font> <a class="code" href="classFormSwep.html#a6">setSweepTime</a>(MY_FLOAT aTime);    
-00068 
-00070   MY_FLOAT <a class="code" href="classBiQuad.html#a14">tick</a>(MY_FLOAT sample);
-00071 
-00073   MY_FLOAT *<a class="code" href="classBiQuad.html#a14">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00074 
-00075  <font class="keyword">protected</font>:  
-00076   <font class="keywordtype">bool</font> dirty;
-00077   MY_FLOAT frequency;
-00078   MY_FLOAT radius;
-00079   MY_FLOAT startFrequency;
-00080   MY_FLOAT startRadius;
-00081   MY_FLOAT startGain;
-00082   MY_FLOAT targetFrequency;
-00083   MY_FLOAT targetRadius;
-00084   MY_FLOAT targetGain;
-00085   MY_FLOAT deltaFrequency;
-00086   MY_FLOAT deltaRadius;
-00087   MY_FLOAT deltaGain;
-00088   MY_FLOAT sweepState;
-00089   MY_FLOAT sweepRate;
-00090 
-00091 };
-00092 
-00093 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/HevyMetl_8h-source.html

@@ -1,41 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>HevyMetl.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00029 <font class="comment">/***************************************************/</font>
-00030 
-00031 <font class="preprocessor">#if !defined(__HEVYMETL_H)</font>
-00032 <font class="preprocessor"></font><font class="preprocessor">#define __HEVYMETL_H</font>
-00033 <font class="preprocessor"></font>
-00034 <font class="preprocessor">#include "FM.h"</font>
-00035 
-00036 <font class="keyword">class </font><a class="code" href="classHevyMetl.html">HevyMetl</a> : <font class="keyword">public</font> <a class="code" href="classFM.html">FM</a>
-00037 {
-00038  <font class="keyword">public</font>:
-00040   <a class="code" href="classHevyMetl.html#a0">HevyMetl</a>();
-00041 
-00043   <a class="code" href="classHevyMetl.html#a1">~HevyMetl</a>();
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00047 
-00049   MY_FLOAT <a class="code" href="classFM.html#a14">tick</a>();
-00050 };
-00051 
-00052 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Instrmnt_8h-source.html

@@ -1,56 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Instrmnt.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00010 <font class="comment">/***************************************************/</font>
-00011 
-00012 <font class="preprocessor">#if !defined(__INSTRMNT_H)</font>
-00013 <font class="preprocessor"></font><font class="preprocessor">#define __INSTRMNT_H</font>
-00014 <font class="preprocessor"></font>
-00015 <font class="preprocessor">#include "Stk.h"</font>
-00016 <font class="preprocessor">#include &lt;iostream.h&gt;</font>
-00017 
-00018 <font class="keyword">class </font><a class="code" href="classInstrmnt.html">Instrmnt</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00019 {
-00020  <font class="keyword">public</font>:
-00022   <a class="code" href="classInstrmnt.html#a0">Instrmnt</a>();
-00023 
-00025   <font class="keyword">virtual</font> <a class="code" href="classInstrmnt.html#a1">~Instrmnt</a>();
-00026 
-00028   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude) = 0;
-00029 
-00031   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude) = 0;
-00032 
-00034   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00035 
-00037   MY_FLOAT <a class="code" href="classInstrmnt.html#a5">lastOut</a>() <font class="keyword">const</font>;
-00038 
-00040   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>() = 0;
-00041 
-00043   <font class="keyword">virtual</font> MY_FLOAT *<a class="code" href="classInstrmnt.html#a6">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00044   
-00046   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00047 
-00048   <font class="keyword">protected</font>:
-00049     MY_FLOAT lastOutput;
-00050 
-00051 };
-00052 
-00053 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/JCRev_8h-source.html

@@ -1,52 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>JCRev.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00015 <font class="comment">/***************************************************/</font>
-00016 
-00017 <font class="preprocessor">#if !defined(__JCREV_H)</font>
-00018 <font class="preprocessor"></font><font class="preprocessor">#define __JCREV_H</font>
-00019 <font class="preprocessor"></font>
-00020 <font class="preprocessor">#include "Reverb.h"</font>
-00021 <font class="preprocessor">#include "Delay.h"</font> 
-00022 
-00023 <font class="keyword">class </font><a class="code" href="classJCRev.html">JCRev</a> : <font class="keyword">public</font> <a class="code" href="classReverb.html">Reverb</a>
-00024 {
-00025  <font class="keyword">public</font>:
-00027   <a class="code" href="classJCRev.html#a0">JCRev</a>(MY_FLOAT T60);
-00028 
-00030   <a class="code" href="classJCRev.html#a1">~JCRev</a>();
-00031 
-00033   <font class="keywordtype">void</font> <a class="code" href="classReverb.html#a2">clear</a>();
-00034 
-00036   MY_FLOAT <a class="code" href="classReverb.html#a7">tick</a>(MY_FLOAT input);
-00037 
-00038  <font class="keyword">protected</font>:
-00039   <a class="code" href="classDelay.html">Delay</a> *allpassDelays[3];
-00040   <a class="code" href="classDelay.html">Delay</a> *combDelays[4];
-00041   <a class="code" href="classDelay.html">Delay</a> *outLeftDelay;
-00042   <a class="code" href="classDelay.html">Delay</a> *outRightDelay;
-00043   MY_FLOAT allpassCoefficient;
-00044   MY_FLOAT combCoefficient[4];
-00045 
-00046 };
-00047 
-00048 <font class="preprocessor">#endif</font>
-00049 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/JetTabl_8h-source.html

@@ -1,47 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>JetTabl.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00014 <font class="comment">/***************************************************/</font>
-00015 
-00016 <font class="preprocessor">#if !defined(__JETTABL_H)</font>
-00017 <font class="preprocessor"></font><font class="preprocessor">#define __JETTABL_H</font>
-00018 <font class="preprocessor"></font>
-00019 <font class="preprocessor">#include "Stk.h"</font>
-00020 
-00021 <font class="keyword">class </font><a class="code" href="classJetTabl.html">JetTabl</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00022 {
-00023 <font class="keyword">public</font>:
-00025   <a class="code" href="classJetTabl.html#a0">JetTabl</a>();
-00026 
-00028   <a class="code" href="classJetTabl.html#a1">~JetTabl</a>();
-00029 
-00031   MY_FLOAT <a class="code" href="classJetTabl.html#a2">lastOut</a>() <font class="keyword">const</font>;
-00032 
-00034   MY_FLOAT <a class="code" href="classJetTabl.html#a3">tick</a>(MY_FLOAT input);
-00035 
-00037   MY_FLOAT *<a class="code" href="classJetTabl.html#a3">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00038 
-00039 <font class="keyword">protected</font>:  
-00040   MY_FLOAT lastOutput;
-00041 
-00042 };
-00043 
-00044 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Mandolin_8h-source.html

@@ -1,57 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Mandolin.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00028 <font class="comment">/***************************************************/</font>
-00029 
-00030 <font class="preprocessor">#if !defined(__MANDOLIN_H)</font>
-00031 <font class="preprocessor"></font><font class="preprocessor">#define __MANDOLIN_H</font>
-00032 <font class="preprocessor"></font>
-00033 <font class="preprocessor">#include "PluckTwo.h"</font>
-00034 <font class="preprocessor">#include "WvIn.h"</font>
-00035 
-00036 <font class="keyword">class </font><a class="code" href="classMandolin.html">Mandolin</a> : <font class="keyword">public</font> <a class="code" href="classPluckTwo.html">PluckTwo</a>
-00037 {
-00038  <font class="keyword">public</font>:
-00040   <a class="code" href="classMandolin.html#a0">Mandolin</a>(MY_FLOAT lowestFrequency);
-00041 
-00043   <font class="keyword">virtual</font> <a class="code" href="classMandolin.html#a1">~Mandolin</a>();
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classMandolin.html#a2">pluck</a>(MY_FLOAT amplitude);
-00047 
-00049   <font class="keywordtype">void</font> <a class="code" href="classMandolin.html#a2">pluck</a>(MY_FLOAT amplitude,MY_FLOAT position);
-00050 
-00052   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00053 
-00055   <font class="keywordtype">void</font> <a class="code" href="classMandolin.html#a5">setBodySize</a>(MY_FLOAT size);
-00056 
-00058   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classPluckTwo.html#a9">tick</a>();
-00059 
-00061   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00062 
-00063   <font class="keyword">protected</font>:  
-00064     <a class="code" href="classWvIn.html">WvIn</a> *soundfile[12];
-00065     MY_FLOAT directBody;
-00066     <font class="keywordtype">int</font> mic;
-00067     <font class="keywordtype">long</font> dampTime;
-00068     <font class="keywordtype">bool</font> waveDone;
-00069 };
-00070 
-00071 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Mesh2D_8h-source.html

@@ -1,89 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Mesh2D.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00025 <font class="comment">/***************************************************/</font>
-00026 
-00027 <font class="preprocessor">#if !defined(__MESH2D_H)</font>
-00028 <font class="preprocessor"></font><font class="preprocessor">#define __MESH2D_H</font>
-00029 <font class="preprocessor"></font>
-00030 <font class="preprocessor">#include "Instrmnt.h"</font>
-00031 <font class="preprocessor">#include "OnePole.h"</font>
-00032 
-00033 <font class="preprocessor">#define NXMAX ((short)(12))</font>
-00034 <font class="preprocessor"></font><font class="preprocessor">#define NYMAX ((short)(12))</font>
-00035 <font class="preprocessor"></font>
-00036 <font class="keyword">class </font><a class="code" href="classMesh2D.html">Mesh2D</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00037 {
-00038  <font class="keyword">public</font>:
-00040   <a class="code" href="classMesh2D.html#a0">Mesh2D</a>(<font class="keywordtype">short</font> nX, <font class="keywordtype">short</font> nY);
-00041 
-00043   <a class="code" href="classMesh2D.html#a1">~Mesh2D</a>();
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classMesh2D.html#a2">clear</a>(); 
-00047 
-00049   <font class="keywordtype">void</font> <a class="code" href="classMesh2D.html#a3">setNX</a>(<font class="keywordtype">short</font> lenX);
-00050 
-00052   <font class="keywordtype">void</font> <a class="code" href="classMesh2D.html#a4">setNY</a>(<font class="keywordtype">short</font> lenY);
-00053 
-00055   <font class="keywordtype">void</font> <a class="code" href="classMesh2D.html#a5">setInputPosition</a>(MY_FLOAT xFactor, MY_FLOAT yFactor);
-00056 
-00058   <font class="keywordtype">void</font> <a class="code" href="classMesh2D.html#a6">setDecay</a>(MY_FLOAT decayFactor);
-00059 
-00061   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00062 
-00064   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00065 
-00067   MY_FLOAT <a class="code" href="classMesh2D.html#a9">energy</a>();
-00068 
-00070   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00071 
-00073   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>(MY_FLOAT input);
-00074 
-00076   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00077 
-00078  <font class="keyword">protected</font>:
-00079 
-00080   MY_FLOAT tick0();
-00081   MY_FLOAT tick1();
-00082   <font class="keywordtype">void</font> clearMesh();
-00083 
-00084   <font class="keywordtype">short</font> NX, NY;
-00085   <font class="keywordtype">short</font> xInput, yInput;
-00086   <a class="code" href="classOnePole.html">OnePole</a> *filterX[NXMAX];
-00087   <a class="code" href="classOnePole.html">OnePole</a> *filterY[NYMAX];
-00088   MY_FLOAT v[NXMAX-1][NYMAX-1]; <font class="comment">// junction velocities</font>
-00089   MY_FLOAT vxp[NXMAX][NYMAX]; <font class="comment">// positive-x velocity wave</font>
-00090   MY_FLOAT vxm[NXMAX][NYMAX]; <font class="comment">// negative-x velocity wave</font>
-00091   MY_FLOAT vyp[NXMAX][NYMAX]; <font class="comment">// positive-y velocity wave</font>
-00092   MY_FLOAT vym[NXMAX][NYMAX]; <font class="comment">// negative-y velocity wave</font>
-00093 
-00094   <font class="comment">// Alternate buffers</font>
-00095   MY_FLOAT vxp1[NXMAX][NYMAX]; <font class="comment">// positive-x velocity wave</font>
-00096   MY_FLOAT vxm1[NXMAX][NYMAX]; <font class="comment">// negative-x velocity wave</font>
-00097   MY_FLOAT vyp1[NXMAX][NYMAX]; <font class="comment">// positive-y velocity wave</font>
-00098   MY_FLOAT vym1[NXMAX][NYMAX]; <font class="comment">// negative-y velocity wave</font>
-00099 
-00100   <font class="keywordtype">int</font> counter; <font class="comment">// time in samples</font>
-00101 
-00102 
-00103 };
-00104 
-00105 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Messager_8h-source.html

@@ -1,114 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Messager.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00034 <font class="comment">/***************************************************/</font>
-00035 
-00036 <font class="preprocessor">#if !defined(__MESSAGER_H)</font>
-00037 <font class="preprocessor"></font><font class="preprocessor">#define __MESSSAGER_H</font>
-00038 <font class="preprocessor"></font>
-00039 <font class="preprocessor">#include "Stk.h"</font>
-00040 <font class="preprocessor">#include "SKINI.h"</font>
-00041 
-00042 <font class="preprocessor">#define MESSAGE_LENGTH  128</font>
-00043 <font class="preprocessor"></font><font class="preprocessor">#define MAX_MESSAGES 25</font>
-00044 <font class="preprocessor"></font><font class="preprocessor">#define STK_MIDI        0x0001</font>
-00045 <font class="preprocessor"></font><font class="preprocessor">#define STK_PIPE        0x0002</font>
-00046 <font class="preprocessor"></font><font class="preprocessor">#define STK_SOCKET      0x0004</font>
-00047 <font class="preprocessor"></font>
-00048 <font class="preprocessor">#if defined(__STK_REALTIME__)</font>
-00049 <font class="preprocessor"></font>
-00050 <font class="preprocessor">#include "Thread.h"</font>
-00051 <font class="preprocessor">#include "Socket.h"</font>
-00052 <font class="preprocessor">#include "RtMidi.h"</font>
-00053 
-00054 <font class="keyword">extern</font> <font class="stringliteral">"C"</font> THREAD_RETURN THREAD_TYPE stdinHandler(<font class="keywordtype">void</font> * ptr);
-00055 
-00056 <font class="preprocessor">#if (defined(__OS_IRIX__) || defined(__OS_LINUX__) || defined(__OS_MACOSX__))</font>
-00057 <font class="preprocessor"></font><font class="preprocessor">  #include &lt;sys/types.h&gt;</font>
-00058 <font class="preprocessor">  #include &lt;sys/time.h&gt;</font>
-00059 <font class="preprocessor">#endif</font>
-00060 <font class="preprocessor"></font>
-00061 <font class="preprocessor">#endif // __STK_REALTIME__</font>
-00062 <font class="preprocessor"></font>
-00063 <font class="keyword">class </font><a class="code" href="classMessager.html">Messager</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00064 {
-00065  <font class="keyword">public</font>:
-00067 
-00075   <a class="code" href="classMessager.html#a0">Messager</a>(<font class="keywordtype">int</font> inputMask = 0, <font class="keywordtype">int</font> port = 2001);
-00076 
-00078   <a class="code" href="classMessager.html#a1">~Messager</a>();
-00079 
-00081 
-00087   <font class="keywordtype">long</font> <a class="code" href="classMessager.html#a2">nextMessage</a>(<font class="keywordtype">void</font>);
-00088 
-00090   <font class="keywordtype">void</font> <a class="code" href="classMessager.html#a3">setRtDelta</a>(<font class="keywordtype">long</font> nSamples);
-00091 
-00093   <font class="keywordtype">long</font> <a class="code" href="classMessager.html#a4">getDelta</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00094 
-00096   <font class="keywordtype">long</font> <a class="code" href="classMessager.html#a5">getType</a>() <font class="keyword">const</font>;
-00097 
-00099   MY_FLOAT <a class="code" href="classMessager.html#a6">getByteTwo</a>() <font class="keyword">const</font>;
-00100 
-00102   MY_FLOAT <a class="code" href="classMessager.html#a7">getByteThree</a>() <font class="keyword">const</font>;
-00103 
-00105   <font class="keywordtype">long</font> <a class="code" href="classMessager.html#a8">getChannel</a>() <font class="keyword">const</font>;
-00106 
-00107  <font class="keyword">protected</font>:
-00108 
-00109   <a class="code" href="classSKINI.html">SKINI</a> *skini;
-00110   <font class="keywordtype">long</font> type;
-00111   <font class="keywordtype">long</font> channel;
-00112   MY_FLOAT byte2;
-00113   MY_FLOAT byte3;
-00114   <font class="keywordtype">int</font> sources;
-00115   <font class="keywordtype">long</font> delta;
-00116   <font class="keywordtype">long</font> rtDelta;
-00117   <font class="keywordtype">char</font> message[MAX_MESSAGES][MESSAGE_LENGTH];
-00118   <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> messageIndex;
-00119   <font class="keywordtype">int</font> nMessages;
-00120 
-00121 <font class="preprocessor">#if defined(__STK_REALTIME__)</font>
-00122 <font class="preprocessor"></font>
-00123   <font class="comment">// Check MIDI source for new messages.</font>
-00124   <font class="keywordtype">bool</font> midiMessage(<font class="keywordtype">void</font>);
-00125 
-00126   <font class="comment">// Check socket sources for new messages.</font>
-00127   <font class="keywordtype">bool</font> socketMessage(<font class="keywordtype">void</font>);
-00128 
-00129   <font class="comment">// Receive and parse socket data.</font>
-00130   <font class="keywordtype">bool</font> readSocket(<font class="keywordtype">int</font> fd);
-00131 
-00132   <a class="code" href="classRtMidi.html">RtMidi</a> *midi;
-00133   <a class="code" href="classThread.html">Thread</a> *thread;
-00134   <a class="code" href="classSocket.html">Socket</a> *soket;
-00135 
-00136   <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> nSockets;  
-00137   fd_set mask;
-00138   <font class="keywordtype">int</font> maxfd;
-00139   <font class="keywordtype">int</font> pipefd;
-00140   <font class="keywordtype">int</font> fd[16];
-00141   <font class="keywordtype">char</font> error[256];
-00142 
-00143 <font class="preprocessor">#endif // __STK_REALTIME__</font>
-00144 <font class="preprocessor"></font>
-00145 };
-00146 
-00147 <font class="preprocessor">#endif // defined(__MESSAGER_H)</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/ModalBar_8h-source.html

@@ -1,47 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>ModalBar.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00028 <font class="comment">/***************************************************/</font>
-00029 
-00030 <font class="preprocessor">#if !defined(__MODALBAR_H)</font>
-00031 <font class="preprocessor"></font><font class="preprocessor">#define __MODALBAR_H</font>
-00032 <font class="preprocessor"></font>
-00033 <font class="preprocessor">#include "Modal.h"</font>
-00034 
-00035 <font class="keyword">class </font><a class="code" href="classModalBar.html">ModalBar</a> : <font class="keyword">public</font> <a class="code" href="classModal.html">Modal</a>
-00036 {
-00037 <font class="keyword">public</font>:
-00039   <a class="code" href="classModalBar.html#a0">ModalBar</a>();
-00040 
-00042   <a class="code" href="classModalBar.html#a1">~ModalBar</a>();
-00043 
-00045   <font class="keywordtype">void</font> <a class="code" href="classModalBar.html#a2">setStickHardness</a>(MY_FLOAT hardness);
-00046 
-00048   <font class="keywordtype">void</font> <a class="code" href="classModalBar.html#a3">setStrikePosition</a>(MY_FLOAT position);
-00049 
-00051   <font class="keywordtype">void</font> <a class="code" href="classModalBar.html#a4">setPreset</a>(<font class="keywordtype">int</font> preset);
-00052 
-00054   <font class="keywordtype">void</font> <a class="code" href="classModalBar.html#a5">setModulationDepth</a>(MY_FLOAT mDepth);
-00055 
-00057   <font class="keywordtype">void</font> <a class="code" href="classModal.html#a13">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00058 };
-00059 
-00060 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Modal_8h-source.html

@@ -1,82 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Modal.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00012 <font class="comment">/***************************************************/</font>
-00013 
-00014 <font class="preprocessor">#if !defined(__MODAL_H)</font>
-00015 <font class="preprocessor"></font><font class="preprocessor">#define __MODAL_H</font>
-00016 <font class="preprocessor"></font>
-00017 <font class="preprocessor">#include "Instrmnt.h"</font>
-00018 <font class="preprocessor">#include "Envelope.h"</font>
-00019 <font class="preprocessor">#include "WaveLoop.h"</font>
-00020 <font class="preprocessor">#include "BiQuad.h"</font>
-00021 <font class="preprocessor">#include "OnePole.h"</font>
-00022 
-00023 <font class="keyword">class </font><a class="code" href="classModal.html">Modal</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00024 {
-00025 <font class="keyword">public</font>:
-00027   <a class="code" href="classModal.html#a0">Modal</a>( <font class="keywordtype">int</font> modes = 4 );
-00028 
-00030   <font class="keyword">virtual</font> <a class="code" href="classModal.html#a1">~Modal</a>();
-00031 
-00033   <font class="keywordtype">void</font> <a class="code" href="classModal.html#a2">clear</a>();
-00034 
-00036   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00037 
-00039   <font class="keywordtype">void</font> <a class="code" href="classModal.html#a4">setRatioAndRadius</a>(<font class="keywordtype">int</font> modeIndex, MY_FLOAT ratio, MY_FLOAT radius);
-00040 
-00042   <font class="keywordtype">void</font> <a class="code" href="classModal.html#a5">setMasterGain</a>(MY_FLOAT aGain);
-00043 
-00045   <font class="keywordtype">void</font> <a class="code" href="classModal.html#a6">setDirectGain</a>(MY_FLOAT aGain);
-00046 
-00048   <font class="keywordtype">void</font> <a class="code" href="classModal.html#a7">setModeGain</a>(<font class="keywordtype">int</font> modeIndex, MY_FLOAT gain);
-00049 
-00051   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classModal.html#a8">strike</a>(MY_FLOAT amplitude);
-00052 
-00054   <font class="keywordtype">void</font> <a class="code" href="classModal.html#a9">damp</a>(MY_FLOAT amplitude);
-00055 
-00057   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00058 
-00060   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00061 
-00063   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00064 
-00066   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value) = 0;
-00067 
-00068 <font class="keyword">protected</font>:  
-00069   <a class="code" href="classEnvelope.html">Envelope</a> *envelope; 
-00070   <a class="code" href="classWvIn.html">WvIn</a>     *wave;
-00071   <a class="code" href="classBiQuad.html">BiQuad</a>   **filters;
-00072   <a class="code" href="classOnePole.html">OnePole</a>  *onepole;
-00073   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00074   <font class="keywordtype">int</font> nModes;
-00075   MY_FLOAT vibratoGain;
-00076   MY_FLOAT masterGain;
-00077   MY_FLOAT directGain;
-00078   MY_FLOAT stickHardness;
-00079   MY_FLOAT strikePosition;
-00080   MY_FLOAT baseFrequency;
-00081   MY_FLOAT *ratios;
-00082   MY_FLOAT *radii;
-00083 
-00084 };
-00085 
-00086 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Modulate_8h-source.html

@@ -1,63 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Modulate.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00011 <font class="comment">/***************************************************/</font>
-00012 
-00013 <font class="preprocessor">#if !defined(__MODULATE_H)</font>
-00014 <font class="preprocessor"></font><font class="preprocessor">#define __MODULATE_H</font>
-00015 <font class="preprocessor"></font>
-00016 <font class="preprocessor">#include "Stk.h"</font>
-00017 <font class="preprocessor">#include "WaveLoop.h"</font>
-00018 <font class="preprocessor">#include "SubNoise.h"</font>
-00019 <font class="preprocessor">#include "OnePole.h"</font>
-00020 
-00021 <font class="keyword">class </font><a class="code" href="classModulate.html">Modulate</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00022 {
-00023  <font class="keyword">public</font>:
-00025   <a class="code" href="classModulate.html#a0">Modulate</a>();
-00026 
-00028   <a class="code" href="classModulate.html#a1">~Modulate</a>();
-00029 
-00031   <font class="keywordtype">void</font> <a class="code" href="classModulate.html#a2">reset</a>();
-00032 
-00034   <font class="keywordtype">void</font> <a class="code" href="classModulate.html#a3">setVibratoRate</a>(MY_FLOAT aRate);
-00035 
-00037   <font class="keywordtype">void</font> <a class="code" href="classModulate.html#a4">setVibratoGain</a>(MY_FLOAT aGain);
-00038 
-00040   <font class="keywordtype">void</font> <a class="code" href="classModulate.html#a5">setRandomGain</a>(MY_FLOAT aGain);
-00041 
-00043   MY_FLOAT <a class="code" href="classModulate.html#a6">tick</a>();
-00044 
-00046   <font class="keyword">virtual</font> MY_FLOAT *<a class="code" href="classModulate.html#a6">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00047 
-00049   MY_FLOAT <a class="code" href="classModulate.html#a8">lastOut</a>() <font class="keyword">const</font>;
-00050 
-00051  <font class="keyword">protected</font>:
-00052   <a class="code" href="classWaveLoop.html">WaveLoop</a> *vibrato;
-00053   <a class="code" href="classSubNoise.html">SubNoise</a> *noise;
-00054   <a class="code" href="classOnePole.html">OnePole</a>  *filter;
-00055   MY_FLOAT vibratoGain;
-00056   MY_FLOAT randomGain;
-00057   MY_FLOAT lastOutput;
-00058 
-00059 };
-00060 
-00061 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Moog_8h-source.html

@@ -1,57 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Moog.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00019 <font class="comment">/***************************************************/</font>
-00020 
-00021 <font class="preprocessor">#if !defined(__MOOG_H)</font>
-00022 <font class="preprocessor"></font><font class="preprocessor">#define __MOOG_H</font>
-00023 <font class="preprocessor"></font>
-00024 <font class="preprocessor">#include "Sampler.h"</font>
-00025 <font class="preprocessor">#include "FormSwep.h"</font>
-00026 
-00027 <font class="keyword">class </font><a class="code" href="classMoog.html">Moog</a> : <font class="keyword">public</font> <a class="code" href="classSampler.html">Sampler</a>
-00028 {
-00029  <font class="keyword">public</font>:
-00031   <a class="code" href="classMoog.html#a0">Moog</a>();
-00032 
-00034   <a class="code" href="classMoog.html#a1">~Moog</a>();
-00035 
-00037   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classSampler.html#a3">setFrequency</a>(MY_FLOAT frequency);
-00038 
-00040   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00041 
-00043   <font class="keywordtype">void</font> <a class="code" href="classMoog.html#a4">setModulationSpeed</a>(MY_FLOAT mSpeed);
-00044 
-00046   <font class="keywordtype">void</font> <a class="code" href="classMoog.html#a5">setModulationDepth</a>(MY_FLOAT mDepth);
-00047 
-00049   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classSampler.html#a7">tick</a>();
-00050 
-00052   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classSampler.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00053 
-00054  <font class="keyword">protected</font>:
-00055   <a class="code" href="classFormSwep.html">FormSwep</a> *filters[2];
-00056   MY_FLOAT modDepth;
-00057   MY_FLOAT filterQ;
-00058   MY_FLOAT filterRate;
-00059 
-00060 };
-00061 
-00062 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/NRev_8h-source.html

@@ -1,51 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>NRev.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00017 <font class="comment">/***************************************************/</font>
-00018 
-00019 <font class="preprocessor">#if !defined(__NREV_H)</font>
-00020 <font class="preprocessor"></font><font class="preprocessor">#define __NREV_H</font>
-00021 <font class="preprocessor"></font>
-00022 <font class="preprocessor">#include "Reverb.h"</font> 
-00023 <font class="preprocessor">#include "Delay.h"</font> 
-00024 
-00025 <font class="keyword">class </font><a class="code" href="classNRev.html">NRev</a> : <font class="keyword">public</font> <a class="code" href="classReverb.html">Reverb</a>
-00026 {
-00027  <font class="keyword">public</font>:
-00029   <a class="code" href="classNRev.html#a0">NRev</a>(MY_FLOAT T60);
-00030 
-00032   <a class="code" href="classNRev.html#a1">~NRev</a>();
-00033 
-00035   <font class="keywordtype">void</font> <a class="code" href="classReverb.html#a2">clear</a>();
-00036 
-00038   MY_FLOAT <a class="code" href="classReverb.html#a7">tick</a>(MY_FLOAT input);
-00039 
-00040  <font class="keyword">protected</font>:  
-00041   <a class="code" href="classDelay.html">Delay</a> *allpassDelays[8];
-00042   <a class="code" href="classDelay.html">Delay</a> *combDelays[6];
-00043   MY_FLOAT allpassCoefficient;
-00044   MY_FLOAT combCoefficient[6];
-00045         MY_FLOAT lowpassState;
-00046 
-00047 };
-00048 
-00049 <font class="preprocessor">#endif</font>
-00050 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Noise_8h-source.html

@@ -1,49 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Noise.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00011 <font class="comment">/***************************************************/</font>
-00012 
-00013 <font class="preprocessor">#if !defined(__NOISE_H)</font>
-00014 <font class="preprocessor"></font><font class="preprocessor">#define __NOISE_H</font>
-00015 <font class="preprocessor"></font>
-00016 <font class="preprocessor">#include "Stk.h"</font>
-00017 
-00018 <font class="keyword">class </font><a class="code" href="classNoise.html">Noise</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00019 {
-00020 <font class="keyword">public</font>:
-00021 
-00023   <a class="code" href="classNoise.html#a0">Noise</a>();
-00024 
-00026   <font class="keyword">virtual</font> <a class="code" href="classNoise.html#a1">~Noise</a>();
-00027 
-00029   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classNoise.html#a2">tick</a>();
-00030 
-00032   <font class="keyword">virtual</font> MY_FLOAT *<a class="code" href="classNoise.html#a2">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00033 
-00035   MY_FLOAT <a class="code" href="classNoise.html#a4">lastOut</a>() <font class="keyword">const</font>;
-00036 
-00037 <font class="keyword">protected</font>:  
-00038 
-00039   MY_FLOAT lastOutput;
-00040 
-00041 };
-00042 
-00043 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/OnePole_8h-source.html

@@ -1,60 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>OnePole.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00013 <font class="comment">/***************************************************/</font>
-00014 
-00015 <font class="preprocessor">#if !defined(__ONEPOLE_H)</font>
-00016 <font class="preprocessor"></font><font class="preprocessor">#define __ONEPOLE_H</font>
-00017 <font class="preprocessor"></font>
-00018 <font class="preprocessor">#include "Filter.h"</font>
-00019 
-00020 <font class="keyword">class </font><a class="code" href="classOnePole.html">OnePole</a> : <font class="keyword">protected</font> <a class="code" href="classFilter.html">Filter</a>
-00021 {
-00022 <font class="keyword">public</font>:
-00023 
-00025   <a class="code" href="classOnePole.html#a0">OnePole</a>();
-00026 
-00028   <a class="code" href="classOnePole.html#a0">OnePole</a>(MY_FLOAT thePole);
-00029 
-00031   <a class="code" href="classOnePole.html#a2">~OnePole</a>();
-00032 
-00034   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a3">clear</a>(<font class="keywordtype">void</font>);
-00035 
-00037   <font class="keywordtype">void</font> <a class="code" href="classOnePole.html#a4">setB0</a>(MY_FLOAT b0);
-00038 
-00040   <font class="keywordtype">void</font> <a class="code" href="classOnePole.html#a5">setA1</a>(MY_FLOAT a1);
-00041 
-00043 
-00050   <font class="keywordtype">void</font> <a class="code" href="classOnePole.html#a6">setPole</a>(MY_FLOAT thePole);
-00051 
-00053 
-00057   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a7">setGain</a>(MY_FLOAT theGain);
-00058 
-00060   MY_FLOAT <a class="code" href="classFilter.html#a8">getGain</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00061 
-00063   MY_FLOAT <a class="code" href="classFilter.html#a9">lastOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00064 
-00066   MY_FLOAT <a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT sample);
-00067 
-00069   MY_FLOAT *<a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00070 };
-00071 
-00072 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/OneZero_8h-source.html

@@ -1,60 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>OneZero.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00013 <font class="comment">/***************************************************/</font>
-00014 
-00015 <font class="preprocessor">#if !defined(__ONEZERO_H)</font>
-00016 <font class="preprocessor"></font><font class="preprocessor">#define __ONEZERO_H</font>
-00017 <font class="preprocessor"></font>
-00018 <font class="preprocessor">#include "Filter.h"</font>
-00019 
-00020 <font class="keyword">class </font><a class="code" href="classOneZero.html">OneZero</a> : <font class="keyword">protected</font> <a class="code" href="classFilter.html">Filter</a>
-00021 {
-00022  <font class="keyword">public</font>:
-00023 
-00025   <a class="code" href="classOneZero.html#a0">OneZero</a>();
-00026 
-00028   <a class="code" href="classOneZero.html#a0">OneZero</a>(MY_FLOAT theZero);
-00029 
-00031   <a class="code" href="classOneZero.html#a2">~OneZero</a>();
-00032 
-00034   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a3">clear</a>(<font class="keywordtype">void</font>);
-00035 
-00037   <font class="keywordtype">void</font> <a class="code" href="classOneZero.html#a4">setB0</a>(MY_FLOAT b0);
-00038 
-00040   <font class="keywordtype">void</font> <a class="code" href="classOneZero.html#a5">setB1</a>(MY_FLOAT b1);
-00041 
-00043 
-00050   <font class="keywordtype">void</font> <a class="code" href="classOneZero.html#a6">setZero</a>(MY_FLOAT theZero);
-00051 
-00053 
-00057   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a7">setGain</a>(MY_FLOAT theGain);
-00058 
-00060   MY_FLOAT <a class="code" href="classFilter.html#a8">getGain</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00061 
-00063   MY_FLOAT <a class="code" href="classFilter.html#a9">lastOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00064 
-00066   MY_FLOAT <a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT sample);
-00067 
-00069   MY_FLOAT *<a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00070 };
-00071 
-00072 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/PRCRev_8h-source.html

@@ -1,50 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>PRCRev.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00015 <font class="comment">/***************************************************/</font>
-00016 
-00017 <font class="preprocessor">#if !defined(__PRCREV_H)</font>
-00018 <font class="preprocessor"></font><font class="preprocessor">#define __PRCREV_H</font>
-00019 <font class="preprocessor"></font>
-00020 <font class="preprocessor">#include "Reverb.h"</font> 
-00021 <font class="preprocessor">#include "Delay.h"</font> 
-00022 
-00023 <font class="keyword">class </font><a class="code" href="classPRCRev.html">PRCRev</a> : <font class="keyword">public</font> <a class="code" href="classReverb.html">Reverb</a>
-00024 {
-00025 <font class="keyword">public</font>:
-00027   <a class="code" href="classPRCRev.html#a0">PRCRev</a>(MY_FLOAT T60);
-00028 
-00030   <a class="code" href="classPRCRev.html#a1">~PRCRev</a>();
-00031 
-00033   <font class="keywordtype">void</font> <a class="code" href="classReverb.html#a2">clear</a>();
-00034 
-00036   MY_FLOAT <a class="code" href="classReverb.html#a7">tick</a>(MY_FLOAT input);
-00037 
-00038 <font class="keyword">protected</font>:  
-00039   <a class="code" href="classDelay.html">Delay</a> *allpassDelays[2];
-00040   <a class="code" href="classDelay.html">Delay</a> *combDelays[2];
-00041   MY_FLOAT allpassCoefficient;
-00042   MY_FLOAT combCoefficient[2];
-00043 
-00044 };
-00045 
-00046 <font class="preprocessor">#endif</font>
-00047 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/PercFlut_8h-source.html

@@ -1,43 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>PercFlut.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00027 <font class="comment">/***************************************************/</font>
-00028 
-00029 <font class="preprocessor">#if !defined(__PERCFLUT_H)</font>
-00030 <font class="preprocessor"></font><font class="preprocessor">#define __PERCFLUT_H</font>
-00031 <font class="preprocessor"></font>
-00032 <font class="preprocessor">#include "FM.h"</font>
-00033 
-00034 <font class="keyword">class </font><a class="code" href="classPercFlut.html">PercFlut</a> : <font class="keyword">public</font> <a class="code" href="classFM.html">FM</a>
-00035 {
-00036  <font class="keyword">public</font>:
-00038   <a class="code" href="classPercFlut.html#a0">PercFlut</a>();
-00039 
-00041   <a class="code" href="classPercFlut.html#a1">~PercFlut</a>();
-00042 
-00044   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00045 
-00047   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00048 
-00050   MY_FLOAT <a class="code" href="classFM.html#a14">tick</a>();
-00051 };
-00052 
-00053 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Phonemes_8h-source.html

@@ -1,56 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Phonemes.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00011 <font class="comment">/***************************************************/</font>
-00012 
-00013 <font class="preprocessor">#if !defined(__PHONEMES_H)</font>
-00014 <font class="preprocessor"></font><font class="preprocessor">#define __PHONEMES_H</font>
-00015 <font class="preprocessor"></font>
-00016 <font class="preprocessor">#include "Stk.h"</font>
-00017 
-00018 <font class="keyword">class </font><a class="code" href="classPhonemes.html">Phonemes</a>
-00019 {
-00020 <font class="keyword">public</font>:
-00021 
-00022   Phonemes(<font class="keywordtype">void</font>);
-00023   ~Phonemes(<font class="keywordtype">void</font>);
-00024 
-00026   <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="classPhonemes.html#d0">name</a>( <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> index );
-00027 
-00029   <font class="keyword">static</font> MY_FLOAT <a class="code" href="classPhonemes.html#d1">voiceGain</a>( <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> index );
-00030 
-00032   <font class="keyword">static</font> MY_FLOAT <a class="code" href="classPhonemes.html#d2">noiseGain</a>( <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> index );
-00033 
-00035   <font class="keyword">static</font> MY_FLOAT <a class="code" href="classPhonemes.html#d3">formantFrequency</a>( <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> index, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> partial );
-00036 
-00038   <font class="keyword">static</font> MY_FLOAT <a class="code" href="classPhonemes.html#d4">formantRadius</a>( <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> index, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> partial );
-00039 
-00041   <font class="keyword">static</font> MY_FLOAT <a class="code" href="classPhonemes.html#d5">formantGain</a>( <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> index, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> partial );
-00042 
-00043 <font class="keyword">private</font>:
-00044 
-00045   <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> phonemeNames[][4];
-00046   <font class="keyword">static</font> <font class="keyword">const</font> MY_FLOAT phonemeGains[][2];
-00047   <font class="keyword">static</font> <font class="keyword">const</font> MY_FLOAT phonemeParameters[][4][3];
-00048 
-00049 };
-00050 
-00051 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/PitShift_8h-source.html

@@ -1,60 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>PitShift.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00010 <font class="comment">/***************************************************/</font>
-00011 
-00012 <font class="preprocessor">#if !defined(__PITSHIFT_H)</font>
-00013 <font class="preprocessor"></font><font class="preprocessor">#define __PITSHIFT_H</font>
-00014 <font class="preprocessor"></font>
-00015 <font class="preprocessor">#include "Stk.h"</font> 
-00016 <font class="preprocessor">#include "DelayL.h"</font> 
-00017 
-00018 <font class="keyword">class </font><a class="code" href="classPitShift.html">PitShift</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00019 {
-00020  <font class="keyword">public</font>:
-00022   <a class="code" href="classPitShift.html#a0">PitShift</a>();
-00023 
-00025   <a class="code" href="classPitShift.html#a1">~PitShift</a>();
-00026 
-00028   <font class="keywordtype">void</font> <a class="code" href="classPitShift.html#a2">clear</a>();
-00029 
-00031   <font class="keywordtype">void</font> <a class="code" href="classPitShift.html#a3">setShift</a>(MY_FLOAT shift);
-00032 
-00034   <font class="keywordtype">void</font> <a class="code" href="classPitShift.html#a4">setEffectMix</a>(MY_FLOAT mix);
-00035 
-00037   MY_FLOAT <a class="code" href="classPitShift.html#a5">lastOut</a>() <font class="keyword">const</font>;
-00038 
-00040   MY_FLOAT <a class="code" href="classPitShift.html#a6">tick</a>(MY_FLOAT input);
-00041 
-00043   MY_FLOAT *<a class="code" href="classPitShift.html#a6">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00044 
-00045  <font class="keyword">protected</font>:  
-00046   <a class="code" href="classDelayL.html">DelayL</a> *delayLine[2];
-00047   MY_FLOAT lastOutput;
-00048   MY_FLOAT delay[2];
-00049   MY_FLOAT env[2];
-00050   MY_FLOAT effectMix;
-00051   MY_FLOAT rate;
-00052 
-00053 };
-00054 
-00055 <font class="preprocessor">#endif</font>
-00056 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/PluckTwo_8h-source.html

@@ -1,73 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>PluckTwo.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00019 <font class="comment">/***************************************************/</font>
-00020 
-00021 <font class="preprocessor">#if !defined(__PLUCKTWO_H)</font>
-00022 <font class="preprocessor"></font><font class="preprocessor">#define __PLUCKTWO_H</font>
-00023 <font class="preprocessor"></font>
-00024 <font class="preprocessor">#include "Instrmnt.h"</font>
-00025 <font class="preprocessor">#include "DelayL.h"</font>
-00026 <font class="preprocessor">#include "DelayA.h"</font>
-00027 <font class="preprocessor">#include "OneZero.h"</font>
-00028 
-00029 <font class="keyword">class </font><a class="code" href="classPluckTwo.html">PluckTwo</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00030 {
-00031  <font class="keyword">public</font>:
-00033   <a class="code" href="classPluckTwo.html#a0">PluckTwo</a>(MY_FLOAT lowestFrequency);
-00034 
-00036   <font class="keyword">virtual</font> <a class="code" href="classPluckTwo.html#a1">~PluckTwo</a>();
-00037 
-00039   <font class="keywordtype">void</font> <a class="code" href="classPluckTwo.html#a2">clear</a>();
-00040 
-00042   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00043 
-00045   <font class="keywordtype">void</font> <a class="code" href="classPluckTwo.html#a4">setDetune</a>(MY_FLOAT detune);
-00046 
-00048   <font class="keywordtype">void</font> <a class="code" href="classPluckTwo.html#a5">setFreqAndDetune</a>(MY_FLOAT frequency, MY_FLOAT detune);
-00049 
-00051   <font class="keywordtype">void</font> <a class="code" href="classPluckTwo.html#a6">setPluckPosition</a>(MY_FLOAT position);
-00052 
-00054 
-00059   <font class="keywordtype">void</font> <a class="code" href="classPluckTwo.html#a7">setBaseLoopGain</a>(MY_FLOAT aGain);
-00060 
-00062   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00063 
-00065   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>() = 0;
-00066 
-00067   <font class="keyword">protected</font>:  
-00068     <a class="code" href="classDelayA.html">DelayA</a> *delayLine;
-00069     <a class="code" href="classDelayA.html">DelayA</a> *delayLine2;
-00070     <a class="code" href="classDelayL.html">DelayL</a> *combDelay;
-00071     <a class="code" href="classOneZero.html">OneZero</a> *filter;
-00072     <a class="code" href="classOneZero.html">OneZero</a> *filter2;
-00073     <font class="keywordtype">long</font> length;
-00074     MY_FLOAT loopGain;
-00075     MY_FLOAT baseLoopGain;
-00076     MY_FLOAT lastFrequency;
-00077     MY_FLOAT lastLength;
-00078     MY_FLOAT detuning;
-00079     MY_FLOAT pluckAmplitude;
-00080     MY_FLOAT pluckPosition;
-00081 
-00082 };
-00083 
-00084 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Plucked_8h-source.html

@@ -1,63 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Plucked.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00018 <font class="comment">/***************************************************/</font>
-00019 
-00020 <font class="preprocessor">#if !defined(__PLUCKED_H)</font>
-00021 <font class="preprocessor"></font><font class="preprocessor">#define __PLUCKED_H</font>
-00022 <font class="preprocessor"></font>
-00023 <font class="preprocessor">#include "Instrmnt.h"</font>
-00024 <font class="preprocessor">#include "DelayA.h"</font>
-00025 <font class="preprocessor">#include "OneZero.h"</font>
-00026 <font class="preprocessor">#include "OnePole.h"</font>
-00027 <font class="preprocessor">#include "Noise.h"</font>
-00028 
-00029 <font class="keyword">class </font><a class="code" href="classPlucked.html">Plucked</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00030 {
-00031  <font class="keyword">public</font>:
-00033   <a class="code" href="classPlucked.html#a0">Plucked</a>(MY_FLOAT lowestFrequency);
-00034 
-00036   <a class="code" href="classPlucked.html#a1">~Plucked</a>();
-00037 
-00039   <font class="keywordtype">void</font> <a class="code" href="classPlucked.html#a2">clear</a>();
-00040 
-00042   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00043 
-00045   <font class="keywordtype">void</font> <a class="code" href="classPlucked.html#a4">pluck</a>(MY_FLOAT amplitude);
-00046 
-00048   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00049 
-00051   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00052 
-00054   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00055 
-00056  <font class="keyword">protected</font>:  
-00057   <a class="code" href="classDelayA.html">DelayA</a> *delayLine;
-00058   <a class="code" href="classOneZero.html">OneZero</a> *loopFilter;
-00059   <a class="code" href="classOnePole.html">OnePole</a> *pickFilter;
-00060   <a class="code" href="classNoise.html">Noise</a> *noise;
-00061   <font class="keywordtype">long</font> length;
-00062   MY_FLOAT loopGain;
-00063 
-00064 };
-00065 
-00066 <font class="preprocessor">#endif</font>
-00067 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/PoleZero_8h-source.html

@@ -1,63 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>PoleZero.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00013 <font class="comment">/***************************************************/</font>
-00014 
-00015 <font class="preprocessor">#if !defined(__POLEZERO_H)</font>
-00016 <font class="preprocessor"></font><font class="preprocessor">#define __POLEZERO_H</font>
-00017 <font class="preprocessor"></font>
-00018 <font class="preprocessor">#include "Filter.h"</font>
-00019 
-00020 <font class="keyword">class </font><a class="code" href="classPoleZero.html">PoleZero</a> : <font class="keyword">protected</font> <a class="code" href="classFilter.html">Filter</a>
-00021 {
-00022  <font class="keyword">public</font>:
-00023 
-00025   <a class="code" href="classPoleZero.html#a0">PoleZero</a>();
-00026 
-00028   <a class="code" href="classPoleZero.html#a1">~PoleZero</a>();
-00029 
-00031   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a3">clear</a>(<font class="keywordtype">void</font>);
-00032 
-00034   <font class="keywordtype">void</font> <a class="code" href="classPoleZero.html#a3">setB0</a>(MY_FLOAT b0);
-00035 
-00037   <font class="keywordtype">void</font> <a class="code" href="classPoleZero.html#a4">setB1</a>(MY_FLOAT b1);
-00038 
-00040   <font class="keywordtype">void</font> <a class="code" href="classPoleZero.html#a5">setA1</a>(MY_FLOAT a1);
-00041 
-00043 
-00048   <font class="keywordtype">void</font> <a class="code" href="classPoleZero.html#a6">setAllpass</a>(MY_FLOAT coefficient);
-00049 
-00051 
-00057   <font class="keywordtype">void</font> <a class="code" href="classPoleZero.html#a7">setBlockZero</a>(MY_FLOAT thePole = 0.99);
-00058 
-00060 
-00064   <font class="keywordtype">void</font> <a class="code" href="classFilter.html#a7">setGain</a>(MY_FLOAT theGain);
-00065 
-00067   MY_FLOAT <a class="code" href="classFilter.html#a8">getGain</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00068 
-00070   MY_FLOAT <a class="code" href="classFilter.html#a9">lastOut</a>(<font class="keywordtype">void</font>) <font class="keyword">const</font>;
-00071 
-00073   MY_FLOAT <a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT sample);
-00074 
-00076   MY_FLOAT *<a class="code" href="classFilter.html#a10">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00077 };
-00078 
-00079 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/ReedTabl_8h-source.html

@@ -1,56 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>ReedTabl.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00018 <font class="comment">/***************************************************/</font>
-00019 
-00020 <font class="preprocessor">#if !defined(__REEDTABL_H)</font>
-00021 <font class="preprocessor"></font><font class="preprocessor">#define __REEDTABL_H</font>
-00022 <font class="preprocessor"></font>
-00023 <font class="preprocessor">#include "Stk.h"</font>
-00024 
-00025 <font class="keyword">class </font><a class="code" href="classReedTabl.html">ReedTabl</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00026 {
-00027 <font class="keyword">public</font>:
-00029   <a class="code" href="classReedTabl.html#a0">ReedTabl</a>();
-00030 
-00032   <a class="code" href="classReedTabl.html#a1">~ReedTabl</a>();
-00033 
-00035 
-00040   <font class="keywordtype">void</font> <a class="code" href="classReedTabl.html#a2">setOffset</a>(MY_FLOAT aValue);
-00041 
-00043 
-00048   <font class="keywordtype">void</font> <a class="code" href="classReedTabl.html#a3">setSlope</a>(MY_FLOAT aValue);
-00049 
-00051   MY_FLOAT <a class="code" href="classReedTabl.html#a4">lastOut</a>() <font class="keyword">const</font>;
-00052 
-00054 
-00058   MY_FLOAT <a class="code" href="classReedTabl.html#a5">tick</a>(MY_FLOAT input);
-00059 
-00061   MY_FLOAT *<a class="code" href="classReedTabl.html#a5">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00062 
-00063 <font class="keyword">protected</font>:  
-00064   MY_FLOAT offSet;
-00065   MY_FLOAT slope;
-00066   MY_FLOAT lastOutput;
-00067 
-00068 };
-00069 
-00070 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Resonate_8h-source.html

@@ -1,70 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Resonate.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00018 <font class="comment">/***************************************************/</font>
-00019 
-00020 <font class="preprocessor">#if !defined(__RESONATE_H)</font>
-00021 <font class="preprocessor"></font><font class="preprocessor">#define __RESONATE_H</font>
-00022 <font class="preprocessor"></font>
-00023 <font class="preprocessor">#include "Instrmnt.h"</font>
-00024 <font class="preprocessor">#include "ADSR.h"</font>
-00025 <font class="preprocessor">#include "BiQuad.h"</font>
-00026 <font class="preprocessor">#include "Noise.h"</font>
-00027 
-00028 <font class="keyword">class </font><a class="code" href="classResonate.html">Resonate</a> : <font class="keyword">public</font> <a class="code" href="classInstrmnt.html">Instrmnt</a>
-00029 {
-00030  <font class="keyword">public</font>:
-00032   <a class="code" href="classResonate.html#a0">Resonate</a>();
-00033 
-00035   <a class="code" href="classResonate.html#a1">~Resonate</a>();
-00036 
-00038   <font class="keywordtype">void</font> <a class="code" href="classResonate.html#a2">clear</a>();
-00039 
-00041   <font class="keywordtype">void</font> <a class="code" href="classResonate.html#a3">setResonance</a>(MY_FLOAT frequency, MY_FLOAT radius);
-00042 
-00044   <font class="keywordtype">void</font> <a class="code" href="classResonate.html#a4">setNotch</a>(MY_FLOAT frequency, MY_FLOAT radius);
-00045 
-00047   <font class="keywordtype">void</font> <a class="code" href="classResonate.html#a5">setEqualGainZeroes</a>();
-00048 
-00050   <font class="keywordtype">void</font> <a class="code" href="classResonate.html#a6">keyOn</a>();
-00051 
-00053   <font class="keywordtype">void</font> <a class="code" href="classResonate.html#a7">keyOff</a>();
-00054 
-00056   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00057 
-00059   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a3">noteOff</a>(MY_FLOAT amplitude);
-00060 
-00062   MY_FLOAT <a class="code" href="classInstrmnt.html#a6">tick</a>();
-00063 
-00065   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a8">controlChange</a>(<font class="keywordtype">int</font> number, MY_FLOAT value);
-00066 
-00067  <font class="keyword">protected</font>:  
-00068   <a class="code" href="classADSR.html">ADSR</a>     *adsr;
-00069   <a class="code" href="classBiQuad.html">BiQuad</a>   *filter;
-00070   <a class="code" href="classNoise.html">Noise</a>    *noise;
-00071   MY_FLOAT poleFrequency;
-00072   MY_FLOAT poleRadius;
-00073   MY_FLOAT zeroFrequency;
-00074   MY_FLOAT zeroRadius;
-00075 
-00076 };
-00077 
-00078 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Reverb_8h-source.html

@@ -1,61 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Reverb.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00010 <font class="comment">/***************************************************/</font>
-00011 
-00012 <font class="preprocessor">#include "Stk.h"</font>
-00013 
-00014 <font class="preprocessor">#if !defined(__REVERB_H)</font>
-00015 <font class="preprocessor"></font><font class="preprocessor">#define __REVERB_H</font>
-00016 <font class="preprocessor"></font>
-00017 <font class="keyword">class </font><a class="code" href="classReverb.html">Reverb</a> : <font class="keyword">public</font> <a class="code" href="classStk.html">Stk</a>
-00018 {
-00019  <font class="keyword">public</font>:
-00021   <a class="code" href="classReverb.html#a0">Reverb</a>();
-00022 
-00024   <font class="keyword">virtual</font> <a class="code" href="classReverb.html#a1">~Reverb</a>();
-00025 
-00027   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classReverb.html#a2">clear</a>() = 0;
-00028 
-00030   <font class="keywordtype">void</font> <a class="code" href="classReverb.html#a3">setEffectMix</a>(MY_FLOAT mix);
-00031 
-00033   MY_FLOAT <a class="code" href="classReverb.html#a4">lastOut</a>() <font class="keyword">const</font>;
-00034 
-00036   MY_FLOAT <a class="code" href="classReverb.html#a5">lastOutLeft</a>() <font class="keyword">const</font>;
-00037 
-00039   MY_FLOAT <a class="code" href="classReverb.html#a6">lastOutRight</a>() <font class="keyword">const</font>;
-00040 
-00042   <font class="keyword">virtual</font> MY_FLOAT <a class="code" href="classReverb.html#a7">tick</a>(MY_FLOAT input) = 0;
-00043 
-00045   <font class="keyword">virtual</font> MY_FLOAT *<a class="code" href="classReverb.html#a7">tick</a>(MY_FLOAT *vector, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> vectorSize);
-00046 
-00047  <font class="keyword">protected</font>:
-00048 
-00049   <font class="comment">// Returns true if argument value is prime.</font>
-00050   <font class="keywordtype">bool</font> isPrime(<font class="keywordtype">int</font> number);
-00051 
-00052   MY_FLOAT lastOutput[2];
-00053   MY_FLOAT effectMix;
-00054 
-00055 };
-00056 
-00057 <font class="preprocessor">#endif // defined(__REVERB_H)</font>
-00058 <font class="preprocessor"></font>
-</pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/Rhodey_8h-source.html

@@ -1,43 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>Rhodey.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************/</font>
-00031 <font class="comment">/***************************************************/</font>
-00032 
-00033 <font class="preprocessor">#if !defined(__RHODEY_H)</font>
-00034 <font class="preprocessor"></font><font class="preprocessor">#define __RHODEY_H</font>
-00035 <font class="preprocessor"></font>
-00036 <font class="preprocessor">#include "FM.h"</font>
-00037 
-00038 <font class="keyword">class </font><a class="code" href="classRhodey.html">Rhodey</a> : <font class="keyword">public</font> <a class="code" href="classFM.html">FM</a>
-00039 {
-00040  <font class="keyword">public</font>:
-00042   <a class="code" href="classRhodey.html#a0">Rhodey</a>();
-00043 
-00045   <a class="code" href="classRhodey.html#a1">~Rhodey</a>();
-00046 
-00048   <font class="keywordtype">void</font> <a class="code" href="classFM.html#a4">setFrequency</a>(MY_FLOAT frequency);
-00049 
-00051   <font class="keywordtype">void</font> <a class="code" href="classInstrmnt.html#a2">noteOn</a>(MY_FLOAT frequency, MY_FLOAT amplitude);
-00052 
-00054   MY_FLOAT <a class="code" href="classFM.html#a14">tick</a>();
-00055 };
-00056 
-00057 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>

doc/html/RtAudio_8h-source.html

@@ -1,336 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
-<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
-<HR>
-<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>RtAudio.h</h1><div class="fragment"><pre>00001 <font class="comment">/************************************************************************/</font>
-00038 <font class="comment">/************************************************************************/</font>
-00039 
-00040 <font class="preprocessor">#if !defined(__RTAUDIO_H)</font>
-00041 <font class="preprocessor"></font><font class="preprocessor">#define __RTAUDIO_H</font>
-00042 <font class="preprocessor"></font>
-00043 <font class="preprocessor">#include &lt;map&gt;</font>
-00044 
-00045 <font class="preprocessor">#if defined(__LINUX_ALSA__)</font>
-00046 <font class="preprocessor"></font><font class="preprocessor">  #include &lt;alsa/asoundlib.h&gt;</font>
-00047 <font class="preprocessor">  #include &lt;pthread.h&gt;</font>
-00048 <font class="preprocessor">  #include &lt;unistd.h&gt;</font>
-00049 
-00050   <font class="keyword">typedef</font> snd_pcm_t *AUDIO_HANDLE;
-00051   <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID;
-00052   <font class="keyword">typedef</font> pthread_t THREAD_HANDLE;
-00053   <font class="keyword">typedef</font> pthread_mutex_t MUTEX;
-00054 
-00055 <font class="preprocessor">#elif defined(__LINUX_OSS__)</font>
-00056 <font class="preprocessor"></font><font class="preprocessor">  #include &lt;pthread.h&gt;</font>
-00057 <font class="preprocessor">  #include &lt;unistd.h&gt;</font>
-00058 
-00059   <font class="keyword">typedef</font> <font class="keywordtype">int</font> AUDIO_HANDLE;
-00060   <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID;
-00061   <font class="keyword">typedef</font> pthread_t THREAD_HANDLE;
-00062   <font class="keyword">typedef</font> pthread_mutex_t MUTEX;
-00063 
-00064 <font class="preprocessor">#elif defined(__WINDOWS_DS__)</font>
-00065 <font class="preprocessor"></font><font class="preprocessor">  #include &lt;windows.h&gt;</font>
-00066 <font class="preprocessor">  #include &lt;process.h&gt;</font>
-00067 
-00068   <font class="comment">// The following struct is used to hold the extra variables</font>
-00069   <font class="comment">// specific to the DirectSound implementation.</font>
-00070   <font class="keyword">typedef</font> <font class="keyword">struct </font>{
-00071     <font class="keywordtype">void</font> * object;
-00072     <font class="keywordtype">void</font> * buffer;
-00073     UINT bufferPointer;
-00074   } AUDIO_HANDLE;
-00075 
-00076   <font class="keyword">typedef</font> LPGUID DEVICE_ID;
-00077   <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> THREAD_HANDLE;
-00078   <font class="keyword">typedef</font> CRITICAL_SECTION MUTEX;
-00079 
-00080 <font class="preprocessor">#elif defined(__WINDOWS_ASIO__)</font>
-00081 <font class="preprocessor"></font><font class="preprocessor">  #include &lt;windows.h&gt;</font>
-00082 <font class="preprocessor">  #include &lt;process.h&gt;</font>
-00083 
-00084   <font class="keyword">typedef</font> <font class="keywordtype">int</font> AUDIO_HANDLE;
-00085   <font class="keyword">typedef</font> <font class="keywordtype">int</font> DEVICE_ID;
-00086   <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> THREAD_HANDLE;
-00087   <font class="keyword">typedef</font> CRITICAL_SECTION MUTEX;
-00088 
-00089 <font class="preprocessor">#elif defined(__IRIX_AL__)</font>
-00090 <font class="preprocessor"></font><font class="preprocessor">  #include &lt;dmedia/audio.h&gt;</font>
-00091 <font class="preprocessor">  #include &lt;pthread.h&gt;</font>
-00092 <font class="preprocessor">  #include &lt;unistd.h&gt;</font>
-00093 
-00094   <font class="keyword">typedef</font> ALport AUDIO_HANDLE;
-00095   <font class="keyword">typedef</font> <font class="keywordtype">long</font> DEVICE_ID;
-00096   <font class="keyword">typedef</font> pthread_t THREAD_HANDLE;
-00097   <font class="keyword">typedef</font> pthread_mutex_t MUTEX;
-00098 
-00099 <font class="preprocessor">#elif defined(__MACOSX_CORE__)</font>
-00100 <font class="preprocessor"></font>
-00101 <font class="preprocessor">  #include &lt;CoreAudio/AudioHardware.h&gt;</font>
-00102 <font class="preprocessor">  #include &lt;pthread.h&gt;</font>
-00103 
-00104   <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> AUDIO_HANDLE;
-00105   <font class="keyword">typedef</font> AudioDeviceID DEVICE_ID;
-00106   <font class="keyword">typedef</font> pthread_t THREAD_HANDLE;
-00107   <font class="keyword">typedef</font> pthread_mutex_t MUTEX;
-00108 
-00109 <font class="preprocessor">#endif</font>
-00110 <font class="preprocessor"></font>
-00111 
-00112 <font class="comment">/************************************************************************/</font>
-00125 <font class="comment">/************************************************************************/</font>
-00126 
-00127 <font class="keyword">class </font><a class="code" href="classRtError.html">RtError</a>
-00128 {
-00129 <font class="keyword">public</font>:
-<a name="l00131"></a><a class="code" href="classRtError.html#s11">00131</a>   <font class="keyword">enum</font> TYPE {
-00132     WARNING,
-00133     DEBUG_WARNING,
-00134     UNSPECIFIED,
-00135     NO_DEVICES_FOUND,
-00136     INVALID_DEVICE,
-00137     INVALID_STREAM,
-00138     MEMORY_ERROR,
-00139     INVALID_PARAMETER,
-00140     DRIVER_ERROR,
-00141     SYSTEM_ERROR,
-00142     THREAD_ERROR
-00143   };
-00144 
-00145 <font class="keyword">protected</font>:
-00146   <font class="keywordtype">char</font> error_message[256];
-00147   TYPE type;
-00148 
-00149 <font class="keyword">public</font>:
-00151   <a class="code" href="classRtError.html#a0">RtError</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *p, TYPE tipe = RtError::UNSPECIFIED);
-00152 
-00154   <font class="keyword">virtual</font> <a class="code" href="classRtError.html#a1">~RtError</a>(<font class="keywordtype">void</font>);
-00155 
-00157   <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classRtError.html#a2">printMessage</a>(<font class="keywordtype">void</font>);
-00158 
-<a name="l00160"></a><a class="code" href="classRtError.html#a3">00160</a>   <font class="keyword">virtual</font> <font class="keyword">const</font> TYPE&amp; <a class="code" href="classRtError.html#a3">getType</a>(<font class="keywordtype">void</font>)<font class="keyword"> </font>{ <font class="keywordflow">return</font> type; }
-00161 
-<a name="l00163"></a><a class="code" href="classRtError.html#a4">00163</a>   <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="classRtError.html#a4">getMessage</a>(<font class="keywordtype">void</font>)<font class="keyword"> </font>{ <font class="keywordflow">return</font> error_message; }
-00164 };
-00165 
-00166 
-00167 <font class="comment">// This public structure type is used to pass callback information</font>
-00168 <font class="comment">// between the private RtAudio stream structure and global callback</font>
-00169 <font class="comment">// handling functions.</font>
-00170 <font class="keyword">typedef</font> <font class="keyword">struct </font>{
-00171   <font class="keywordtype">void</font> *object;  <font class="comment">// Used as a "this" pointer.</font>
-00172   <font class="keywordtype">int</font> streamId;
-00173   DEVICE_ID device[2];
-00174   THREAD_HANDLE thread;
-00175   <font class="keywordtype">void</font> *callback;
-00176   <font class="keywordtype">void</font> *buffers;
-00177   <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> waitTime;
-00178   <font class="keywordtype">bool</font> blockTick;
-00179   <font class="keywordtype">bool</font> stopStream;
-00180   <font class="keywordtype">bool</font> usingCallback;
-00181   <font class="keywordtype">void</font> *userData;
-00182 } CALLBACK_INFO;
-00183 
-00184 
-00185 <font class="comment">// *************************************************** //</font>
-00186 <font class="comment">//</font>
-00187 <font class="comment">// RtAudio class declaration.</font>
-00188 <font class="comment">//</font>
-00189 <font class="comment">// *************************************************** //</font>
-00190 
-00191 <font class="keyword">class </font><a class="code" href="classRtAudio.html">RtAudio</a>
-00192 {
-00193 <font class="keyword">public</font>:
-00194 
-00195   <font class="comment">// Support for signed integers and floats.  Audio data fed to/from</font>
-00196   <font class="comment">// the tickStream() routine is assumed to ALWAYS be in host</font>
-00197   <font class="comment">// byte order.  The internal routines will automatically take care of</font>
-00198   <font class="comment">// any necessary byte-swapping between the host format and the</font>
-00199   <font class="comment">// soundcard.  Thus, endian-ness is not a concern in the following</font>
-00200   <font class="comment">// format definitions.</font>
-00201   <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> RTAUDIO_FORMAT;
-<a name="l00202"></a><a class="code" href="classRtAudio.html#p0">00202</a>   <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT8; 
-<a name="l00203"></a><a class="code" href="classRtAudio.html#p1">00203</a>   <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT16; 
-<a name="l00204"></a><a class="code" href="classRtAudio.html#p2">00204</a>   <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT24; 
-<a name="l00205"></a><a class="code" href="classRtAudio.html#p3">00205</a>   <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_SINT32; 
-<a name="l00206"></a><a class="code" href="classRtAudio.html#p4">00206</a>   <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_FLOAT32; 
-<a name="l00207"></a><a class="code" href="classRtAudio.html#p5">00207</a>   <font class="keyword">static</font> <font class="keyword">const</font> RTAUDIO_FORMAT RTAUDIO_FLOAT64; 
-00209   <font class="comment">//static const int MAX_SAMPLE_RATES = 14;</font>
-00210   <font class="keyword">enum</font> { MAX_SAMPLE_RATES = 14 };
-00211 
-00212   <font class="keyword">typedef</font> int (*RTAUDIO_CALLBACK)(<font class="keywordtype">char</font> *buffer, <font class="keywordtype">int</font> bufferSize, <font class="keywordtype">void</font> *userData);
-00213 
-<a name="l00215"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html">00215</a>   <font class="keyword">typedef</font> <font class="keyword">struct </font>{
-<a name="l00216"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m0">00216</a>     <font class="keywordtype">char</font> name[128];    
-00217     DEVICE_ID id[2];  <font class="comment">/* No value reported by getDeviceInfo(). */</font>
-<a name="l00218"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m2">00218</a>     <font class="keywordtype">bool</font> probed;       
-<a name="l00219"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m3">00219</a>     <font class="keywordtype">int</font> maxOutputChannels; 
-<a name="l00220"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m4">00220</a>     <font class="keywordtype">int</font> maxInputChannels;  
-<a name="l00221"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m5">00221</a>     <font class="keywordtype">int</font> maxDuplexChannels; 
-<a name="l00222"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m6">00222</a>     <font class="keywordtype">int</font> minOutputChannels; 
-<a name="l00223"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m7">00223</a>     <font class="keywordtype">int</font> minInputChannels;  
-<a name="l00224"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m8">00224</a>     <font class="keywordtype">int</font> minDuplexChannels; 
-<a name="l00225"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m9">00225</a>     <font class="keywordtype">bool</font> hasDuplexSupport; 
-<a name="l00226"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m10">00226</a>     <font class="keywordtype">bool</font> isDefault;        
-<a name="l00227"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m11">00227</a>     <font class="keywordtype">int</font> nSampleRates;      
-<a name="l00228"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m12">00228</a>     <font class="keywordtype">int</font> sampleRates[MAX_SAMPLE_RATES]; 
-<a name="l00229"></a><a class="code" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m13">00229</a>     RTAUDIO_FORMAT nativeFormats;     
-00230   } RTAUDIO_DEVICE;
-00231 
-00233 
-00239   <a class="code" href="classRtAudio.html#a0">RtAudio</a>();
-00240 
-00242 
-00253   <a class="code" href="classRtAudio.html#a0">RtAudio</a>(<font class="keywordtype">int</font> *streamId,
-00254           <font class="keywordtype">int</font> outputDevice, <font class="keywordtype">int</font> outputChannels,
-00255           <font class="keywordtype">int</font> inputDevice, <font class="keywordtype">int</font> inputChannels,
-00256           RTAUDIO_FORMAT format, <font class="keywordtype">int</font> sampleRate,
-00257           <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers);
-00258 
-00260 
-00264   <a class="code" href="classRtAudio.html#a2">~RtAudio</a>();
-00265 
-00267 
-00294   <font class="keywordtype">int</font> <a class="code" href="classRtAudio.html#a3">openStream</a>(<font class="keywordtype">int</font> outputDevice, <font class="keywordtype">int</font> outputChannels,
-00295                  <font class="keywordtype">int</font> inputDevice, <font class="keywordtype">int</font> inputChannels,
-00296                  RTAUDIO_FORMAT format, <font class="keywordtype">int</font> sampleRate,
-00297                  <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers);
-00298 
-00300 
-00319   <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a4">setStreamCallback</a>(<font class="keywordtype">int</font> streamId, RTAUDIO_CALLBACK callback, <font class="keywordtype">void</font> *userData);
-00320 
-00322 
-00329   <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a5">cancelStreamCallback</a>(<font class="keywordtype">int</font> streamId);
-00330 
-00332   <font class="keywordtype">int</font> <a class="code" href="classRtAudio.html#a6">getDeviceCount</a>(<font class="keywordtype">void</font>);
-00333 
-00335 
-00343   <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a7">getDeviceInfo</a>(<font class="keywordtype">int</font> device, RTAUDIO_DEVICE *info);
-00344 
-00346 
-00351   <font class="keywordtype">char</font> * <font class="keyword">const</font> <a class="code" href="classRtAudio.html#a8">getStreamBuffer</a>(<font class="keywordtype">int</font> streamId);
-00352 
-00354 
-00359   <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a9">tickStream</a>(<font class="keywordtype">int</font> streamId);
-00360 
-00362 
-00366   <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a10">closeStream</a>(<font class="keywordtype">int</font> streamId);
-00367 
-00369 
-00373   <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a11">startStream</a>(<font class="keywordtype">int</font> streamId);
-00374 
-00376 
-00380   <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a12">stopStream</a>(<font class="keywordtype">int</font> streamId);
-00381 
-00383 
-00387   <font class="keywordtype">void</font> <a class="code" href="classRtAudio.html#a13">abortStream</a>(<font class="keywordtype">int</font> streamId);
-00388 
-00390 
-00395   <font class="keywordtype">int</font> <a class="code" href="classRtAudio.html#a14">streamWillBlock</a>(<font class="keywordtype">int</font> streamId);
-00396 
-00397 <font class="preprocessor">#if (defined(__MACOSX_CORE__) || defined(__WINDOWS_ASIO__))</font>
-00398 <font class="preprocessor"></font>  <font class="comment">// This function is intended for internal use only.  It must be</font>
-00399   <font class="comment">// public because it is called by the internal callback handler,</font>
-00400   <font class="comment">// which is not a member of RtAudio.  External use of this function</font>
-00401   <font class="comment">// will most likely produce highly undesireable results!</font>
-00402   <font class="keywordtype">void</font> callbackEvent(<font class="keywordtype">int</font> streamId, DEVICE_ID deviceId, <font class="keywordtype">void</font> *inData, <font class="keywordtype">void</font> *outData);
-00403 <font class="preprocessor">#endif</font>
-00404 <font class="preprocessor"></font>
-00405 <font class="keyword">protected</font>:
-00406 
-00407 <font class="keyword">private</font>:
-00408 
-00409   <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> SAMPLE_RATES[MAX_SAMPLE_RATES];
-00410 
-00411   <font class="keyword">enum</font> { FAILURE, SUCCESS };
-00412 
-00413   <font class="keyword">enum</font> STREAM_MODE {
-00414     OUTPUT,
-00415     INPUT,
-00416     DUPLEX,
-00417     UNINITIALIZED = -75
-00418   };
-00419 
-00420   <font class="keyword">enum</font> STREAM_STATE {
-00421     STREAM_STOPPED,
-00422     STREAM_RUNNING
-00423   };
-00424 
-00425   <font class="keyword">typedef</font> <font class="keyword">struct </font>{
-00426     <font class="keywordtype">int</font> device[2];          <font class="comment">// Playback and record, respectively.</font>
-00427     STREAM_MODE mode;       <font class="comment">// OUTPUT, INPUT, or DUPLEX.</font>
-00428     AUDIO_HANDLE handle[2]; <font class="comment">// Playback and record handles, respectively.</font>
-00429     STREAM_STATE state;     <font class="comment">// STOPPED or RUNNING</font>
-00430     <font class="keywordtype">char</font> *userBuffer;
-00431     <font class="keywordtype">char</font> *deviceBuffer;
-00432     <font class="keywordtype">bool</font> doConvertBuffer[2]; <font class="comment">// Playback and record, respectively.</font>
-00433     <font class="keywordtype">bool</font> deInterleave[2];    <font class="comment">// Playback and record, respectively.</font>
-00434     <font class="keywordtype">bool</font> doByteSwap[2];      <font class="comment">// Playback and record, respectively.</font>
-00435     <font class="keywordtype">int</font> sampleRate;
-00436     <font class="keywordtype">int</font> bufferSize;
-00437     <font class="keywordtype">int</font> nBuffers;
-00438     <font class="keywordtype">int</font> nUserChannels[2];    <font class="comment">// Playback and record, respectively.</font>
-00439     <font class="keywordtype">int</font> nDeviceChannels[2];  <font class="comment">// Playback and record channels, respectively.</font>
-00440     RTAUDIO_FORMAT userFormat;
-00441     RTAUDIO_FORMAT deviceFormat[2]; <font class="comment">// Playback and record, respectively.</font>
-00442     MUTEX mutex;
-00443     CALLBACK_INFO callbackInfo;
-00444   } RTAUDIO_STREAM;
-00445 
-00446   <font class="keyword">typedef</font> <font class="keywordtype">signed</font> <font class="keywordtype">short</font> INT16;
-00447   <font class="keyword">typedef</font> <font class="keywordtype">signed</font> <font class="keywordtype">int</font> INT32;
-00448   <font class="keyword">typedef</font> <font class="keywordtype">float</font> FLOAT32;
-00449   <font class="keyword">typedef</font> <font class="keywordtype">double</font> FLOAT64;
-00450 
-00451   <font class="keywordtype">char</font> message[256];
-00452   <font class="keywordtype">int</font> nDevices;
-00453   RTAUDIO_DEVICE *devices;
-00454 
-00455   std::map&lt;int, void *&gt; streams;
-00456 
-00458   <font class="keywordtype">void</font> error(RtError::TYPE type);
-00459 
-00464   <font class="keywordtype">void</font> initialize(<font class="keywordtype">void</font>);
-00465 
-00470   <font class="keywordtype">int</font> getDefaultInputDevice(<font class="keywordtype">void</font>);
-00471 
-00476   <font class="keywordtype">int</font> getDefaultOutputDevice(<font class="keywordtype">void</font>);
-00477 
-00479   <font class="keywordtype">void</font> clearDeviceInfo(RTAUDIO_DEVICE *info);
-00480 
-00488   <font class="keywordtype">void</font> probeDeviceInfo(RTAUDIO_DEVICE *info);
-00489 
-00496   <font class="keywordtype">bool</font> probeDeviceOpen(<font class="keywordtype">int</font> device, RTAUDIO_STREAM *stream,
-00497                        STREAM_MODE mode, <font class="keywordtype">int</font> channels, 
-00498                        <font class="keywordtype">int</font> sampleRate, RTAUDIO_FORMAT format,
-00499                        <font class="keywordtype">int</font> *bufferSize, <font class="keywordtype">int</font> numberOfBuffers);
-00500 
-00507   <font class="keywordtype">void</font> *verifyStream(<font class="keywordtype">int</font> streamId);
-00508 
-00513   <font class="keywordtype">void</font> convertStreamBuffer(RTAUDIO_STREAM *stream, STREAM_MODE mode);
-00514 
-00516   <font class="keywordtype">void</font> byteSwapBuffer(<font class="keywordtype">char</font> *buffer, <font class="keywordtype">int</font> samples, RTAUDIO_FORMAT format);
-00517 
-00519   <font class="keywordtype">int</font> formatBytes(RTAUDIO_FORMAT format);
-00520 };
-00521 
-00522 <font class="comment">// Define the following flag to have extra information spewed to stderr.</font>
-00523 <font class="comment">//#define __RTAUDIO_DEBUG__</font>
-00524 
-00525 <font class="preprocessor">#endif</font>
-</font></pre></div><HR>
-
-<table>
-  <tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
-  <tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
-</table>
-
-</BODY>
-</HTML>