Documentation updates in preparation for 5.0.0 release.

Implement install STK

.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,162 @@
+cmake_minimum_required(VERSION 3.1) ##TODO: which version is better
+
+project(STK VERSION 4.6.1)
+set (CMAKE_CXX_STANDARD 11)
+
+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)
+option(INSTALL_HEADERS "Install headers" 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()
+
+if(INSTALL_HEADERS)
+    file(GLOB STK_HEADERS "include/*.h")
+    install(FILES ${STK_HEADERS} DESTINATION include/stk)
+endif()
+#========================================#
+#========== Build the Library ===========#
+#========================================#
+if(BUILD_STATIC)
+    add_library(stk STATIC ${STK_SRC} )
+    target_include_directories(stk PRIVATE include PUBLIC $<INSTALL_INTERFACE:include>)
+    set_target_properties(stk PROPERTIES PUBLIC_HEADER "${LIBSTK_HEADERS}")
+    list(APPEND STK_TARGETS stk)
+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
+    target_include_directories(stk_SHARED PRIVATE include PUBLIC $<INSTALL_INTERFACE:include>)
+    set_target_properties(stk_SHARED PROPERTIES PUBLIC_HEADER "${LIBSTK_HEADERS}")
+    list(APPEND STK_TARGETS stk_SHARED)
+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 ======================#
+#========================================#
+
+install(TARGETS ${STK_TARGETS} EXPORT stk-config
+	LIBRARY DESTINATION lib
+	ARCHIVE DESTINATION lib
+	RUNTIME DESTINATION bin
+	PUBLIC_HEADER DESTINATION include/stk)
+
+install(EXPORT stk-config DESTINATION lib/cmake/stk)

INSTALL

@@ -1,44 +0,0 @@
-The Synthesis ToolKit in C++ (STK)
-
-By Perry R. Cook and Gary P. Scavone, 1995-2009.
-
-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 and MinGW):
-
-1. Unpack the STK distribution (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 (linux only)
-  --with-jack = choose native JACK server API support (linux and macintosh OS-X)
-  --with-core = choose OS-X Core Audio API (macintosh OS-X only)
-  --with-asio = choose ASIO API support (windows only)
-  --with-ds = choose DirectSound API support (windows only)
-
-It is now possible to specify more than one audio API where supported.  Note however that the ALSA library is required in order to compile the RtMidi class, even 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 (ex. to set to /home/gary/rawwaves and /home/gary/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 (ex. to use CC):
-
-  ./configure CXX=CC
-
-In addition, a linux RPM is available from the Planet CCRMA WWW site (http://ccrma.stanford.edu/planetccrma/software/).
-
-
-For Windows Users:
-
-MinGW support is provided in the configure script.  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-2023.
+
+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-2023 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.md

@@ -1,21 +1,29 @@
-The Synthesis ToolKit in C++ (STK)
-
-By Perry R. Cook and Gary P. Scavone, 1995-2009.
+# The Synthesis ToolKit in C++ (STK)
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 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 projects and programs
+* [`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 near the bottom of this document.
+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 file in this directory.
+For compiling and installing STK, see the [INSTALL.md](INSTALL.md) file in this directory.
 
+## Contents
 
-OVERVIEW:
+* [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++
@@ -23,20 +31,18 @@ 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
+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.  In
-fact, the ToolKit has been working continuously for nearly 10 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.
+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 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
+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
@@ -57,7 +63,7 @@ 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
+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),
@@ -65,23 +71,24 @@ and SKINI (Synthesis ToolKit Instrument Network Interface, a MIDI-like
 text message synthesis control format).
 
 
-SYSTEM REQUIREMENTS:
+# SYSTEM REQUIREMENTS
 
-See the individual README's (eg. README-linux) in the /doc directory
+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 VC++ workspace files to compile the
+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):
+# 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 to see what has changed since the last release.
+"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
@@ -95,12 +102,12 @@ 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,
-Macintosh OS-X, 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!
+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
@@ -111,10 +118,10 @@ 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).
+accomplish that.
 
 
-DISCLAIMER:
+# 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
@@ -123,14 +130,14 @@ can also make suggestions, but again, no guarantees.  Send email to
 the mail list.
 
 
-LEGAL AND ETHICAL:
+# 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.
+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
@@ -141,39 +148,8 @@ 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.
 
-LICENSE:
 
-STK WWW site: http://ccrma.stanford.edu/software/stk/
-
-The Synthesis ToolKit in C++ (STK)
-Copyright (c) 1995-2009 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.
-
-
-FURTHER READING:
+# FURTHER READING
 
 For complete documentation on this ToolKit, the classes, etc., see the
 doc directory of the distribution or surf to
@@ -181,7 +157,7 @@ http://ccrma.stanford.edu/software/stk/.  Also check the platform
 specific README's for specific system requirements.
 
 
-PERRY'S NOTES FROM THE ORIGINAL DISTRIBUTION:
+# 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
@@ -204,11 +180,11 @@ The answers lie below.
 
 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.
+    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.
+    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.
+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.
 
@@ -216,6 +192,3 @@ The answers lie below.
 
 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

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,12 +1,16 @@
 # Process this file with autoconf to produce a configure script.
-AC_INIT(STK, 4.4, gary@music.mcgill.ca, stk)
+AC_INIT(STK, 5.0.0, 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 projects/examples/libMakefile)
+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_CXX(g++ CC c++ cxx)
 AC_PROG_RANLIB
@@ -40,18 +44,55 @@ 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)
 
+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( cppflag, ["-D_STK_DEBUG_ -D__RTAUDIO_DEBUG__ -D__RTMIDI_DEBUG__"] ) AC_SUBST( cxxflag, ["-g"] ) AC_SUBST( object_path, [Debug] ) AC_MSG_RESULT(yes)],
-  [AC_SUBST( cppflag, [] ) AC_SUBST( cxxflag, [-O3] ) 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
@@ -72,90 +113,132 @@ 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(jack, [  --with-jack = choose JACK server support (mac and linux only)], [
-    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!))
-    AC_CHECK_LIB(asound, snd_pcm_open, , AC_MSG_ERROR(Jack support also requires the asound library!))], )
 
+  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!))])
+    ;;
+
+    *-*-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)], [
+    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!))], )
+    AC_CHECK_LIB(asound, snd_pcm_open, , AC_MSG_ERROR(ALSA support requires the asound library!))])
+
+    # Look for PulseAudio flag
+    AC_ARG_WITH(pulse, [  --with-pulse = choose PulseAudio support (linux only)])
+    AS_IF([test "x$with_pulse" == "xyes"], [
+    api="$api -D__LINUX_PULSE__"
+    AC_MSG_RESULT(using PulseAudio)
+    AC_CHECK_LIB(pulse, pa_proplist_gets, , AC_MSG_ERROR(PulseAudio support requires the libpulse library!))
+    AC_CHECK_LIB(pulse-simple, pa_simple_new, , AC_MSG_ERROR(PulseAudio support requires the libpulse-simple library!))])
 
     # Look for OSS flag
-    AC_ARG_WITH(oss, [  --with-oss = choose OSS API support (linux only)], [
-    api="$api -D__LINUX_OSS__"
-    AC_MSG_RESULT(using OSS)], )
+    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
-    if [test "$api" == "";] then
+    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!))
-    fi
+    ])
 
-    # Look for ALSA library because we need it for RtMidi
-    AC_CHECK_LIB(asound, snd_pcm_open, , AC_MSG_ERROR(STK in Linux requires the ALSA asound library for RtMidi!))
-    api="$api -D__LINUX_ALSASEQ__" 
-
-    AC_CHECK_LIB(pthread, pthread_create, , AC_MSG_ERROR(realtime support requires the pthread library!))
+    AC_CHECK_LIB(pthread, pthread_create, , AC_MSG_ERROR(RtAudio requires the pthread library!))
     ;;
 
     *-apple*)
-    AC_ARG_WITH(jack, [  --with-jack = choose JACK server support (unix only)], [
-    api="$api -D__UNIX_JACK__"
-    AC_MSG_RESULT(using JACK)
-    AC_CHECK_LIB(jack, jack_client_new, , AC_MSG_ERROR(JACK support requires the jack library!))], )
-
     # Look for Core flag
-    AC_ARG_WITH(core, [  --with-core = choose CoreAudio API support (mac only)], [
+    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" ], )
+    LIBS="$LIBS -framework CoreAudio -framework CoreFoundation -framework CoreMIDI" ])
 
     # If no audio api flags specified, use CoreAudio
-    if [test "$api" == ""; ] then
+    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"] )
-    fi
+      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)], [
+    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"] ) ], )
+    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)], [
+    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 -lwinmm $LIBS" ], )
+    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
-    if [test "$api" == "";] then
+    AS_IF([test "$api" == ""], [
       AC_SUBST( api, [-D__WINDOWS_DS__] )
       AC_MSG_RESULT(using DirectSound)
       LIBS="-ldsound -lwinmm $LIBS"
-    fi
+    ])
 
     api="$api -D__WINDOWS_MM__"
-    LIBS="-lole32 -lwinmm -lWsock32 $LIBS"
+    LIBS="-lole32 -lwinmm -lwsock32 $LIBS"
     ;;
 
     *)

doc/README-Linux.txt

@@ -1,19 +1,13 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2009.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 Please read the file README and INSTALL for more general STK information.
 
-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.  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.  The __LINUX_ALSASEQ__ definition is required to compile RtMidi with 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.  Realtime programs must also link with the pthread library.  The OSS audio API can be selected by passing the "--with-oss" 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.  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:
-
-MIDIator support has been removed from RtMidi with STK versions 4.2 and higher.  If you really need it, you can contact us to get an old distribution.
-
-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,21 +1,16 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2009.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 Please read the file README and INSTALL for more general STK information.
 
 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 in order to compile STK.  STK was successfully tested on OS X versions 10.5.
-
-The internal Macintosh audio hardware typically supports a sample rate of 44100 Hz only.  The default STK sample rate is now 44100 Hz and all current example programs use this rate.  However, it is possible to manually override this value in some programs from the command-line.  The default sample rate is set in Stk.h.  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.
-
+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.  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.
+The Tcl/Tk interpreter included in the Xcode package seems outdated. Try getting tcl-tk through HomeBrew for an updated version.
 
-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.
+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.
 

doc/README-NeXT.txt

@@ -1,7 +0,0 @@
-The Synthesis ToolKit in C++ (STK)
-
-By Perry R. Cook and Gary P. Scavone, 1995-2009.
-
-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,15 +1,7 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2009.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 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.
-
-With STK version 4.3, realtime support for IRIX has been discontinued due to the 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.
-
-The __IRIX_AL__ and __IRIX_MD__ preprocessor definitions are required for realtime audio and MIDI support.
-
-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-2009.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
-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++ .NET project and workspace files.  It no longer compiles with Visual C++ 6.0.  I gave up attempting to fix all the problems created by such a bad compiler.  This version of STK has been tested using Visual C++ .NET.  As well, the configure script now supprots MinGW.
+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/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.
+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.
+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.
-
-Visual C++ 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" (this was for VC 6.0 ... things have changed with the newer versions of the VC compiler):
-
-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__", "__WINDOWS_MM__", and "__LITTLE_ENDIAN__ 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 -if 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.
-
-

doc/ReleaseNotes.txt

@@ -1,14 +1,89 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995-2009.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
-v4.4.1: (3 June 2009)
+v.5.0.0 (4 August 2023)
+- see github site for complete details (github.com/thestk/stk)
+- new filter design functionality in BiQuad (thanks to Navin Kumar!)
+- update to PitShift to use a single delay line
+- various updates for new RtAudio API
+
+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 2009)
+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
@@ -100,7 +175,7 @@ v4.1.3: (22 March 2004)
 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 volume control to demo program and various Tcl scripts
 - added support for dynamic rawwavePath() setting
 - WaveLoop bug fix
 - fixed bug in ADSR::setReleaseTime() method
@@ -124,7 +199,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

doc/SKINI.txt

@@ -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
@@ -127,13 +127,13 @@ upon/from which to build and depart.
     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
+    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,9 +237,9 @@ 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
+    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];
@@ -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

doc/doxygen/compile.txt

@@ -2,6 +2,7 @@
 
 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"
 
@@ -37,26 +38,26 @@ STK compiles with realtime support on the following flavors of the Unix operatin
 <TR>
   <TD>Linux</TD>
   <TD>ALSA</TD>
-  <TD>__LINUX_ALSA__, __LINUX_ALSASEQ__, __LITTLE_ENDIAN__</TD>
+  <TD>__LINUX_ALSA__, \__LITTLE_ENDIAN__</TD>
   <TD><TT>asound, pthread</TT></TD>
 </TR>
 <TR>
   <TD>Linux</TD>
   <TD>OSS (version 4.0 only, use ALSA for MIDI support)</TD>
-  <TD>__LINUX_OSS__, __LINUX_ALSASEQ__, __LITTLE_ENDIAN__</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 (audio only, use ALSA for MIDI support)</TD>
-  <TD>__UNIX_JACK__, __LINUX_ALSASEQ__, __LITTLE_ENDIAN__</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, CoreAudio, CoreMidi, CoreFoundation</TT></TD>
+  <TD><TT>pthread, CoreAudio, CoreMIDI, CoreFoundation</TT></TD>
 </TR>
 </TABLE>
 </CENTER>
@@ -104,24 +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 .NET compiler
-only.  It is assumed here that you're familiar with Visual C++ and its
-particular idiosyncrasies.  STK won't compile in Visual C++ 6.0 any more.
-
-The approach when using Visual C++ is to build a project that
-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, FileRead, FileWrite, WvIn, FileWvIn,
-FileLoop, WvOut, and FileWvOut 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>, <TT>__WINDOWS_DS__</TT>, and <TT>__WINDOWS_MM__</TT> preprocessor definitions.
-
-For Steinberg ASIO support, use the <TT>__WINDOWS_ASIO__</TT> preprocessor definition (and the <TT>__WINDOWS_MM__</TT> definition for RtMidi support), 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="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="filtering.html">Next tutorial</A>]
 */

doc/doxygen/control.txt

@@ -28,7 +28,7 @@ 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
+stk::Messager instance to accept control input from the accompanying Tcl/Tk
 graphical user interfaces, from external MIDI devices, or from SKINI
 scorefiles.
 

doc/doxygen/download.txt

@@ -1,273 +1,294 @@
-/*! \page download Download, Release Notes, and Bug Fixes
+/*! \page download Download and Release Notes
 
-\section down Download Version 4.4.1 (3 June 2009):
-
-<UL>
-<LI><A HREF="http://ccrma.stanford.edu/software/stk/release/stk-4.4.1.tar.gz">Source distribution</A></LI>
-</UL>
+\section down Download Version 5.0.0 (4 August 2023):
 
+- <A HREF="http://ccrma.stanford.edu/software/stk/release/stk-5.0.0.tar.gz">Source distribution</A>
 
 \section notes Release Notes:
+\subsection v5dot0dot0 Version 5.0.0
+- see github site for complete details (github.com/thestk/stk)
+- new filter design functionality in BiQuad (thanks to Navin Kumar!)
+- update to PitShift to use a single delay line
+- various updates for new RtAudio API
+
+\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 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)
+
+\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
-
-<ul>
-<li>Added multi-channel/frame tick() virtual function to WvIn and WvOut abstract base classes (required update to RtWvOut class).</li>
-<li>Updated configure script to select g++ compiler by default.</li>
-<li>In demo.cpp: removed voicer grouping for messages, fixing polyphony when messages are on the same MIDI/SKINI channel.</li>
-<li>Updates to RtAudio and RtMidi.</li>
-</ul>
+- 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
-
-<ul>
-<li>All classes embedded in the "stk" namespace (except RtAudio, RtMidi, and RtError).</li>
-<li>Class WaveLoop renamed FileLoop.</li>
-<li>Significant efficiency improvements via code restructuring and inlining.</li>
-<li>Some class source (.cpp) files deleted as part of inlining (Generator, Filter, Function, WvIn, WvOut, Effect, Instrmnt, BowTable, ReedTable, JetTable, Vector3D).</li>
-<li>Updates to RtAudio and RtMidi.</li>
-<li>Previous "tickFrame()" functions renamed "tick" for more consistent API.</li>
-<li>More consistent and scalable approach to multichannel data and computations.</li>
-<li>Multichannel support added to Granulate class.</li>
-<li>Filter class made abstract.  New Iir and Fir classes made for non-order-specific filtering.</li>
-<li>New TapDelay class.</li>
-<li>SubNoise class deleted (same as sub-sampled "ticking" of Noise class).</li>
-</ul>
+- 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
-
-<ul>
-<li>Further headerless file support in FileRead.</li>
-<li>Bug fix in RtWvOut.cpp.</li>
-<li>Added configure support for MinGW.</li>
-<li>Updates to RtAudio and RtMidi for MinGW.</li>
-<li>Changes to channel assignment in demo.cpp.</li>
-</ul>
+- 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
-
-<ul>
-<li>An official MIT-like license.</li>
-<li>New functionality to automatically update class data when the STK sample rate changes (partly implemented).</li>
-<li>Updates for new RtAudio version 4.0.</li>
-<li>Removed RtDuplex class, users should use RtAudio directly with a callback function.</li>
-<li>Bug fix in interpolate() function in Stk.h for non-interleaved data.</li>
-<li>Fixes / improvements to the Granulate class.</li>
-<li>Fix in Whistle when doing animation.</li>
-<li>Fixes in BlitSquare for frequency, harmonics, and dc offset.</li>
-<li>Updates to Makefiles for non-realtime compile.</li>
-<li>Fix in demo.cpp for voice channel assignment.</li>
-<li>Updated versions of RtMidi and RtAudio.</li>
-<li>Updated ASIO files for MinGW compiler.</li>
-<li>New FAQ in documentation.</li>
-<li>MAT-file bug fix in FileRead class.</li>
-</ul>
+- 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
-
-<ul>
-<li>Greatly expanded StkFrames functionality (including interpolation and indexing by channel/frame).</li>
-<li>New Blit, BlitSaw, and BlitSquare bandlimited waveform classes (thanks to Robin Davies!).</li>
-<li>New Granulate granular synthesis class.</li>
-<li>Removed Table class ... all functionality (including interpolation) now in StkFrames and FileRead classes.</li>
-<li>Revised Socket class (now abstract) and added TcpServer, TcpClient, and UdpSocket subclasses.</li>
-<li>Added Stk::showWarnings() and Stk::printErrors() functions to dis/enable warning and error printouts.</li>
-<li>Extracted file I/O functionality to FileRead and FileWrite classes.</li>
-<li>Revised WvIn / WvOut class structure (WvIn / WvOut now abstract and file I/O functionality in new FileWvIn / FileWvOut subclasses).</li>
-<li>New SineWave class which calculates its own static table of variable length (no rawwave dependency).</li>
-<li>New sinewave.raw file of length 1024 samples (used to be 256).</li>
-<li>TcpWvIn and TcpWvOut renamed InetWvIn and InetWvOut, with added support for UDP sockets.</li>
-<li>Fixed bug in WvOut tickFrame( const  StkFrames &frames ) function.</li>
-<li>Fixed bug in demo.cpp when writing output soundfiles without realtime output.</li>
-<li>Added "binary" open flag to MidiFileIn class for Windows.</li>
-<li>Fixed oversized MAT-file header in WvOut.cpp</li>
-<li>Fixed case statement bug in MidiFileIn.cpp for sysex.</li>
-<li>Added missing getDelay() function to DelayA.cpp.</li>
-<li>Fixed modDepth omission in Chorus.cpp.</li>
-<li>Fixed DC blocker initialization bug in Flute.cpp.</li>
-<li>Changed Filter class behavior so no default clearing of state when changing coefficients.</li>
-<li>Fixes to RtAudio, especially for Windows DirectSound and ASIO (thanks to Robin Davies).</li>
-</ul>
+- 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
-
-<ul>
-<li>Simultaneous multiple audio APIs supported at compile time.</li>
-<li>Various changes to better conform to standard C++ programming practices.</li>
-<li>Fixed hidden overloaded virtual functions.</li>
-<li>New Asymp exponential envelope class.</li>
-<li><tt>MY_FLOAT</tt> type converted to <tt>StkFloat</tt> and changed throughout (use \c treesed utility to search/replace in old files).</li>
-<li>Most example programs rewritten to use an audio callback paradigm (which works better in OS-X).</li>
-<li>New StkFrames class for vectorized multichannel data and associated new tick() functions making use of StkFrames.</li>
-<li>New RtMidi class with MIDI output capabilities (API changes).</li>
-<li>New MidiFileIn class for reading MIDI files.</li>
-<li>Revised Filter classes to use std::vectors for coefficients (API changes).</li>
-<li>Revised Messager class (API changes).</li>
-<li>New abstract parent Effect class for various effects.</li>
-<li>New abstract parent Generator class for various signal sources.</li>
-<li>New abstract parent Function class for tables and various non-linear functions.</li>
-<li>Skini class completely rewritten (simplified) using the C++ STL (API changes).</li>
-<li>WvOut classes now clip to -1.0 to +1.0 and report out of range.</li>
-<li>New Mutex class.</li>
-<li>Turned Nagle algorithm off by default in Socket class.</li>
-<li>Error reporting standardized in all classes.</li>
-</ul>
+- 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
-
-<ul>
-<li>Bug fix in RtAudio for Windows DirectSound output only support</li>
-</ul>
+- Bug fix in RtAudio for Windows DirectSound output only support
 
 \subsection v4dot1dot2 Version 4.1.2
-
-<UL>
-<li>Added Linux JACK support to RtAudio.</li>
-<li>Added optional doNormalize argument to WvIn to allow specification of data normalization or not.</li>
-<li>Added volume control to demo program and various tcl scripts.</li>
-<li>Added support for dynamic rawwavePath() setting.</li>
-<li>WaveLoop bug fix.</li>
-<li>Fixed bug in ADSR::setReleaseTime() method.</li>
-<li>Fixed missing initialization of apInput in non-default constructor of DelayA class.</li>
-<li>Added time seeding of random number generator to Noise constructor.</li>
-<li>Update to the contentsAt() method of Delay class.</li>
-<li>WAV file fixes (8-bit) in WvIn and WvOut classes.</li>
-<li>Configure script changes.</li>
-<li>Updated \<iostream\> include statements and appended "std::" as necessary throughout for compatibility with gcc 3.</li>
-</UL>
+- 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
-<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>
+- 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 StkFloat) 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. <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.</LI>
-<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>
-<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.</LI>
-</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

@@ -21,10 +21,11 @@ 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-2009 Perry R. Cook and Gary P. Scavone
+Copyright (c) 1995--2023 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
@@ -69,7 +70,7 @@ If the resultant sound generated by an STK program sounds like noise (and you're
 
 \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:
+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"

doc/doxygen/filtering.txt

@@ -33,7 +33,7 @@ The stk::Iir class implements the standard difference equation
  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.roguewave.com/support/docs/sourcepro/stdlibref/vector.html">vector</a>, a container object provided by the C++ Standard Library.
+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.
 

doc/doxygen/footer.html

@@ -2,7 +2,7 @@
 
 <table>
   <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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
+  <tr><td>&copy;1995--2023 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
 </table>
 
 </BODY>

doc/doxygen/fundamentals.txt

@@ -1,6 +1,6 @@
 /*! \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, RtMidi, and RtError are defined within the stk namespace.
+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:
 

doc/doxygen/index.txt

@@ -15,7 +15,7 @@ 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 15 years
+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
@@ -30,6 +30,7 @@ platforms and should work with any standard C++ compiler.
 - \ref links
 - \ref faq
 - \ref tutorial
+- <A href="http://github.com/thestk/stk">Stk on GitHub</A>
 
 */
 

doc/doxygen/information.txt

@@ -18,16 +18,16 @@ Here's a link to a book that includes an chapter on STK.
 
 <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 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 15 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 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.  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.  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> (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).
+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>
 
@@ -39,8 +39,8 @@ 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
+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

doc/doxygen/links.txt

@@ -4,26 +4,22 @@
 
 - <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://www.music.princeton.edu/paul/stkugens.tar.gz">Paul Lansky's port of STK to SuperCollider</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://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://stk.sapp.org/kern2skini">Kern Score to SKINI file converter</A> by Craig Sapp
-
-- <A HREF="http://www.artassault.org/software/software.html">Calico - A Polyphonic Score File Parser for STK</A> by Greg Kellum
+- <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/polyvoices.txt

@@ -14,7 +14,7 @@ We have written this program to accept control messages from \c STDIN.  Assuming
 threebees < scores/bachfugue.ski
 \endcode
 
-For more fun, surf to <A HREF="http://kern.humdrum.net/">Kern Scores</A> for a huge assortment of other scorefiles that can be downloaded in the SKINI format.
+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.
 
 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.
 

doc/doxygen/system.txt

@@ -3,7 +3,7 @@
 <B>General:</B>
 <UL>
 <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="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 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>
@@ -17,17 +17,16 @@
 <UL>
 <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.
+<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.
 
-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>
+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++ .NET 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>
 

doc/doxygen/tutorial.txt

@@ -1,12 +1,10 @@
 /*! \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 and C++.  STK's "target audience" includes people who:
-<UL>
-<LI>want to create audio DSP and/or synthesis programs</LI>
-<LI>want to use our unit generators and input/output routines rather than code their own</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>
+- 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.).
 

doc/doxygen/usage.txt

@@ -2,6 +2,7 @@
 
 - \ref directory
 - \ref compiling
+- \ref debug
 - \ref control
 - \ref voices
 - \ref nort
@@ -31,21 +32,23 @@ 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>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> and <TT>__WINDOWS_MM__</TT> preprocessor definitions are necessary for all Windows systems (RtMidi uses the Windows MultiMedia MIDI API).  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++ .NET 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>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>
@@ -54,7 +57,9 @@ Several options can be supplied to the <TT>configure</TT> script to customize th
 <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 Core Audio API support (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>
 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:
@@ -70,11 +75,14 @@ For those who wish to create their own system-specific <TT>Makefiles</TT>:
 <UL>
 <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> 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 Core Audio support) and/or the JACK library.  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>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:
 
@@ -83,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 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.  
+<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
@@ -127,23 +134,23 @@ 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
-demo BeeThree -ow myfile.wav -if scores/bookert.ski
+stk-demo BeeThree -ow myfile.wav -if 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" (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>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, Mac OS-X, and Windows95/98/2000/XP operating systems.  STK realtime SKINI control input via piping is possible under Linux, Mac OS X, and Windows2000/XP only.
+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:
@@ -154,56 +161,45 @@ where instruments include those described above and flags can be any or all of:
 <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 \<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 <i>-ip</i> and <i>-is</i> flags must be used when piping or socketing 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 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
-demo BeeThree -or -if scores/bookert.ski
+stk-demo BeeThree -or -if 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

@@ -1,6 +1,6 @@
 STK: A ToolKit of Audio Synthesis Classes and Instruments in C++
 
-By Perry R. Cook and Gary P. Scavone, 1995-2009.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 STK Classes - See the HTML documentation in the html directory for complete information.
 
@@ -19,20 +19,22 @@ STK Classes - See the HTML documentation in the html directory for complete info
      |
      |- Filter - (OnePole, OneZero, TwoPole, TwoZero, PoleZero, Biquad, FormSwep, Delay, DelayL, DelayA, TapDelay)
      |
-     |- RtAudio, RtMidi, RtDuplex, Socket, Thread, Mutex
-     |                               |
-Stk -|                           UdpSocket
-     |                           TcpServer
-     |                           TcpClient
+     |- RtAudio, RtMidi, Socket, Thread, Mutex
+     |                      |
+Stk -|                  UdpSocket
+     |                  TcpServer
+     |                  TcpClient
      |
      |- StkFrames
      |
-     |- Effect - (Echo, Chorus, PitShift, PRCRev, JCRev, NRev)
+     |- 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
@@ -43,11 +45,11 @@ Stk -|                           UdpSocket
      |            |
      |            |- Resonate
      |            |
-     |            |- PluckedTwo - Mandolin
+     |            |- Mandolin
      .- Instrmnt -|
                   |- Drummer
                   |
-                  |- Clarinet, BlowHole, Saxofony, Flute, Brass, BlowBotl, Bowed, Plucked, StifKarp, Sitar
+                  |- Clarinet, BlowHole, Saxofony, Flute, Brass, BlowBotl, Bowed, Plucked, StifKarp, Sitar, Recorder
                   |
                   |- Shakers
                   |
@@ -86,8 +88,6 @@ Sinks:         FileWrite.cpp   Audio file output class (no internal data storage
                RtWvOut.cpp     Realtime audio output class (subclass of WvOut)
                InetWvOut.cpp   Audio streaming (socket client) output class (subclass of WvOut)
 
-Duplex:        RtDuplex.cpp    Synchronous realtime audio input/output class (blocking)
-
 Filters:       Filter.h        Filter master class
                Iir.h           General infinite-impulse response filter
                Fir.h           General finite-impulse response filter
@@ -117,45 +117,49 @@ 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
-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.
+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
-Flanger.cpp     Flanger Effects Processor       DelayL, WaveLoop
-Chorus.cpp      Chorus Effects Processor        DelayL, WaveLoop
-PitShift.cpp    Cheap Pitch Shifter             DelayL
+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   **************
@@ -170,7 +174,7 @@ 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
+SKINImsg.h	      #defines for often used and universal MIDI/SKINI symbols
+SKINItbl.h	      Table of SKINI messages
 
 

iOS/README-iOS.md

@@ -0,0 +1,91 @@
+# Readme
+
+* [Setup](#setup)
+* [Usage](#usage)
+* [Troubleshooting](#troubleshooting)
+
+## Setup
+
+### [CocoaPods](https://cocoapods.org) (Recommended)
+
+1. Add `pod 'STK', '~> 4.6'` to your Podfile.
+
+1. Run `pod install`
+
+### Manual
+
+1. Clone or [download][download_link] the STK into your project's directory.
+
+1. Open the **STK for iOS** folder, and drag and drop **STK.xcodeproj** into your Xcode project.
+
+1. Open your project's settings, open the *Build Phases* tab. In the *Link Binary with Libraries* section, add **libSTK.a**.
+![][linking_libSTK_screenshot]
+
+1. In the *Dependencies* section, add "rawwaves"
+
+1. In your project's settings, open the *Build Settings* tab. In the *Search Paths* section, double click on the field to the right of *Header Search Paths*, and add the path to the STK's **include** directory relative to your Xcode project's directory.
+![][header_search_paths_screenshot]
+
+
+## Usage
+
+1. Import the STK classes you require in your Objective-C source files (Swift does not yet support importing C++ code)
+  * E.g. `#import "SineWave.h"`
+
+1. Change the extension of any Objective-C files that import STK files to **.mm**.
+  * E.g. **ViewController.m** —> **ViewController.mm**
+
+1. If you use a class that makes use of raw wave files (such as `Mandolin`), make sure you call `Stk::setRawwavePath` beforehand in your code.
+
+See the [iOS Demo project](..projects/demo/iOS%20Demo) for a sample usage.
+
+
+## Troubleshooting
+
+### 'FileName.h' file not found
+
+If you get this error when `#import`ing an STK header, you have added the wrong header search path for the STK in your project's settings (see Step 4 in Setup)
+
+The STK's header search path you need to add is the path to the STK's **include** directory relative to your project's directory (as if you were `cd`ing into it). For example, it is `stk/include/` if the stk directory is inside your project's directory, but it is `../stk/include/` if both share the same directory.
+
+If this problem doesn't go away:
+
+1. Delete **STK.xcodeproj** from your Xcode project
+1. Move the STK directory within your project's directory.
+1. Follow step 1 from **Setup**, add `stk/include` to the *Header Search Paths*.
+
+If that doesn't solve it:
+Install CocoaPods and use it to install the STK. It takes one minute and will make your life easier. Visit the [CocoaPods website](https://cocoapods.org) for installation instructions.
+
+### FileRead::open: could not open or find file (../../rawwaves/filename.raw)!
+
+If you use a class that makes use of raw waves (such as `Mandolin`, `Wurley`, or `Rhodey`) you need to make sure that the STK's raw wave files are copied into your bundle and that the STK knows where they are. You'll know you need to if you get this runtime error:
+`FileRead::open: could not open or find file (../../rawwaves/filename.raw)!`
+
+#### If you're using CocoaPods
+
+Add this code before using a class that needs the raw waves:
+```objective-c
+stk::Stk::setRawwavePath([[[NSBundle mainBundle] pathForResource:@"rawwaves" ofType:@"bundle"] UTF8String]);
+```
+
+#### If you're not using CocoaPods
+
+1. Open your project's settings, open the *Build Phases* tab.
+1. In the *Copy Bundle Resources*, drag and drop **rawwaves.bundle** (it's located in **STK.xcodeproj**'s **Helpers** folder).
+1. Then add this code before using a class that needs the raw waves:
+
+```objective-c
+NSBundle *rawwaveBundle = [NSBundle bundleWithURL:[[NSBundle mainBundle] URLForResource:@"rawwaves" withExtension:@"bundle"]];
+stk::Stk::setRawwavePath([[rawwaveBundle resourcePath] UTF8String]);
+```
+
+### Apple Mach-O Linker Error
+
+This means that **STKLib.a** isn't being linked to your binary. Follow step 2 above in [Setup](#setup).
+
+
+[download_link]: https://github.com/thestk/stk/archive/master.zip
+[linking_libSTK_screenshot]: http://i.imgur.com/cLbGrtq.png
+[header_search_paths_screenshot]: http://i.imgur.com/iBTC06h.png
+[rawwaves_scheme_screenshot]: http://i.imgur.com/PKd7epf.png

iOS/STK.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "self:STK for iOS.xcodeproj">
+   </FileRef>
+</Workspace>

iOS/demo/README.md

@@ -0,0 +1,10 @@
+##iOS Demo Xcode project
+
+This project briefly shows how to manually integrate the STK static library into an Xcode project. See the **README** file in the STK's `iOS` directory for precise instructions.
+
+Currently, this project does not output sound, it only shows how to generate audio samples from the STK classes within an iOS project, and how to control STK objects via UI controls. These samples need to be fed into an audio engine for them to be heard. 
+
+Note the following:
+
+ * ViewController needs to be renamed with the **.mm** extension as it's importing STK files, which are C++.
+ * The header search paths in the *Build Settings* of **iOS Demo.xcodeproj** point to `../../include/` because the STK's `include` directory is two directories up relative to it.

iOS/demo/iOS Demo.xcodeproj/project.pbxproj

@@ -0,0 +1,571 @@
+// !$*UTF8*$!
+{
+	archiveVersion = 1;
+	classes = {
+	};
+	objectVersion = 46;
+	objects = {
+
+/* Begin PBXBuildFile section */
+		B02FD53618C520D60009ECA9 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B02FD53518C520D60009ECA9 /* Foundation.framework */; };
+		B02FD53818C520D60009ECA9 /* CoreGraphics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B02FD53718C520D60009ECA9 /* CoreGraphics.framework */; };
+		B02FD53A18C520D60009ECA9 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B02FD53918C520D60009ECA9 /* UIKit.framework */; };
+		B02FD54018C520D60009ECA9 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = B02FD53E18C520D60009ECA9 /* InfoPlist.strings */; };
+		B02FD54218C520D60009ECA9 /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = B02FD54118C520D60009ECA9 /* main.m */; };
+		B02FD54618C520D60009ECA9 /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = B02FD54518C520D60009ECA9 /* AppDelegate.m */; };
+		B02FD54818C520D60009ECA9 /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = B02FD54718C520D60009ECA9 /* Images.xcassets */; };
+		B02FD54F18C520D70009ECA9 /* XCTest.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B02FD54E18C520D70009ECA9 /* XCTest.framework */; };
+		B02FD55018C520D70009ECA9 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B02FD53518C520D60009ECA9 /* Foundation.framework */; };
+		B02FD55118C520D70009ECA9 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B02FD53918C520D60009ECA9 /* UIKit.framework */; };
+		B02FD55918C520D70009ECA9 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = B02FD55718C520D70009ECA9 /* InfoPlist.strings */; };
+		B02FD55B18C520D70009ECA9 /* iOS_DemoTests.m in Sources */ = {isa = PBXBuildFile; fileRef = B02FD55A18C520D70009ECA9 /* iOS_DemoTests.m */; };
+		B02FD57018C521560009ECA9 /* ViewController.mm in Sources */ = {isa = PBXBuildFile; fileRef = B02FD56F18C521560009ECA9 /* ViewController.mm */; };
+		B0779A8718D376F5004DA9B7 /* libSTK.a in Frameworks */ = {isa = PBXBuildFile; fileRef = B0779A8418D376A6004DA9B7 /* libSTK.a */; };
+		B0779A8B18D37C13004DA9B7 /* rawwaves.bundle in Resources */ = {isa = PBXBuildFile; fileRef = B0779A8618D376A6004DA9B7 /* rawwaves.bundle */; };
+/* End PBXBuildFile section */
+
+/* Begin PBXContainerItemProxy section */
+		834A47CB24435D350028575A /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = B0779A7E18D376A5004DA9B7 /* STK.xcodeproj */;
+			proxyType = 1;
+			remoteGlobalIDString = B0EC337B18CB73480005787B;
+			remoteInfo = rawwaves;
+		};
+		B02FD55218C520D70009ECA9 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = B02FD52A18C520D60009ECA9 /* Project object */;
+			proxyType = 1;
+			remoteGlobalIDString = B02FD53118C520D60009ECA9;
+			remoteInfo = "iOS Demo";
+		};
+		B0779A8318D376A6004DA9B7 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = B0779A7E18D376A5004DA9B7 /* STK.xcodeproj */;
+			proxyType = 2;
+			remoteGlobalIDString = B0AC5BEE18CB31DE00D860C0;
+			remoteInfo = STK;
+		};
+		B0779A8518D376A6004DA9B7 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = B0779A7E18D376A5004DA9B7 /* STK.xcodeproj */;
+			proxyType = 2;
+			remoteGlobalIDString = B0EC33B718CB73A70005787B;
+			remoteInfo = rawwaves;
+		};
+/* End PBXContainerItemProxy section */
+
+/* Begin PBXFileReference section */
+		B02FD53218C520D60009ECA9 /* iOS Demo.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "iOS Demo.app"; sourceTree = BUILT_PRODUCTS_DIR; };
+		B02FD53518C520D60009ECA9 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = System/Library/Frameworks/Foundation.framework; sourceTree = SDKROOT; };
+		B02FD53718C520D60009ECA9 /* CoreGraphics.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreGraphics.framework; path = System/Library/Frameworks/CoreGraphics.framework; sourceTree = SDKROOT; };
+		B02FD53918C520D60009ECA9 /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; };
+		B02FD53D18C520D60009ECA9 /* iOS Demo-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = "iOS Demo-Info.plist"; sourceTree = "<group>"; };
+		B02FD53F18C520D60009ECA9 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/InfoPlist.strings; sourceTree = "<group>"; };
+		B02FD54118C520D60009ECA9 /* main.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = main.m; sourceTree = "<group>"; };
+		B02FD54318C520D60009ECA9 /* iOS Demo-Prefix.pch */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "iOS Demo-Prefix.pch"; sourceTree = "<group>"; };
+		B02FD54418C520D60009ECA9 /* AppDelegate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AppDelegate.h; sourceTree = "<group>"; };
+		B02FD54518C520D60009ECA9 /* AppDelegate.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = AppDelegate.m; sourceTree = "<group>"; };
+		B02FD54718C520D60009ECA9 /* Images.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Images.xcassets; sourceTree = "<group>"; };
+		B02FD54D18C520D70009ECA9 /* iOS DemoTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = "iOS DemoTests.xctest"; sourceTree = BUILT_PRODUCTS_DIR; };
+		B02FD54E18C520D70009ECA9 /* XCTest.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = XCTest.framework; path = Library/Frameworks/XCTest.framework; sourceTree = DEVELOPER_DIR; };
+		B02FD55618C520D70009ECA9 /* iOS DemoTests-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = "iOS DemoTests-Info.plist"; sourceTree = "<group>"; };
+		B02FD55818C520D70009ECA9 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/InfoPlist.strings; sourceTree = "<group>"; };
+		B02FD55A18C520D70009ECA9 /* iOS_DemoTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = iOS_DemoTests.m; sourceTree = "<group>"; };
+		B02FD56E18C521560009ECA9 /* ViewController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ViewController.h; sourceTree = "<group>"; };
+		B02FD56F18C521560009ECA9 /* ViewController.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = ViewController.mm; sourceTree = "<group>"; };
+		B0779A7E18D376A5004DA9B7 /* STK.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = STK.xcodeproj; path = ../STK.xcodeproj; sourceTree = "<group>"; };
+		B0779A8918D37977004DA9B7 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README.md; sourceTree = "<group>"; };
+/* End PBXFileReference section */
+
+/* Begin PBXFrameworksBuildPhase section */
+		B02FD52F18C520D60009ECA9 /* Frameworks */ = {
+			isa = PBXFrameworksBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				B0779A8718D376F5004DA9B7 /* libSTK.a in Frameworks */,
+				B02FD53818C520D60009ECA9 /* CoreGraphics.framework in Frameworks */,
+				B02FD53A18C520D60009ECA9 /* UIKit.framework in Frameworks */,
+				B02FD53618C520D60009ECA9 /* Foundation.framework in Frameworks */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+		B02FD54A18C520D70009ECA9 /* Frameworks */ = {
+			isa = PBXFrameworksBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				B02FD54F18C520D70009ECA9 /* XCTest.framework in Frameworks */,
+				B02FD55118C520D70009ECA9 /* UIKit.framework in Frameworks */,
+				B02FD55018C520D70009ECA9 /* Foundation.framework in Frameworks */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXFrameworksBuildPhase section */
+
+/* Begin PBXGroup section */
+		B02FD52918C520D60009ECA9 = {
+			isa = PBXGroup;
+			children = (
+				B0779A8918D37977004DA9B7 /* README.md */,
+				B0779A7E18D376A5004DA9B7 /* STK.xcodeproj */,
+				B02FD53B18C520D60009ECA9 /* iOS Demo */,
+				B02FD55418C520D70009ECA9 /* iOS DemoTests */,
+				B02FD53418C520D60009ECA9 /* Frameworks */,
+				B02FD53318C520D60009ECA9 /* Products */,
+			);
+			sourceTree = "<group>";
+		};
+		B02FD53318C520D60009ECA9 /* Products */ = {
+			isa = PBXGroup;
+			children = (
+				B02FD53218C520D60009ECA9 /* iOS Demo.app */,
+				B02FD54D18C520D70009ECA9 /* iOS DemoTests.xctest */,
+			);
+			name = Products;
+			sourceTree = "<group>";
+		};
+		B02FD53418C520D60009ECA9 /* Frameworks */ = {
+			isa = PBXGroup;
+			children = (
+				B02FD53518C520D60009ECA9 /* Foundation.framework */,
+				B02FD53718C520D60009ECA9 /* CoreGraphics.framework */,
+				B02FD53918C520D60009ECA9 /* UIKit.framework */,
+				B02FD54E18C520D70009ECA9 /* XCTest.framework */,
+			);
+			name = Frameworks;
+			sourceTree = "<group>";
+		};
+		B02FD53B18C520D60009ECA9 /* iOS Demo */ = {
+			isa = PBXGroup;
+			children = (
+				B02FD54418C520D60009ECA9 /* AppDelegate.h */,
+				B02FD54518C520D60009ECA9 /* AppDelegate.m */,
+				B02FD56E18C521560009ECA9 /* ViewController.h */,
+				B02FD56F18C521560009ECA9 /* ViewController.mm */,
+				B02FD54718C520D60009ECA9 /* Images.xcassets */,
+				B02FD53C18C520D60009ECA9 /* Supporting Files */,
+			);
+			path = "iOS Demo";
+			sourceTree = "<group>";
+		};
+		B02FD53C18C520D60009ECA9 /* Supporting Files */ = {
+			isa = PBXGroup;
+			children = (
+				B02FD53D18C520D60009ECA9 /* iOS Demo-Info.plist */,
+				B02FD53E18C520D60009ECA9 /* InfoPlist.strings */,
+				B02FD54118C520D60009ECA9 /* main.m */,
+				B02FD54318C520D60009ECA9 /* iOS Demo-Prefix.pch */,
+			);
+			name = "Supporting Files";
+			sourceTree = "<group>";
+		};
+		B02FD55418C520D70009ECA9 /* iOS DemoTests */ = {
+			isa = PBXGroup;
+			children = (
+				B02FD55A18C520D70009ECA9 /* iOS_DemoTests.m */,
+				B02FD55518C520D70009ECA9 /* Supporting Files */,
+			);
+			path = "iOS DemoTests";
+			sourceTree = "<group>";
+		};
+		B02FD55518C520D70009ECA9 /* Supporting Files */ = {
+			isa = PBXGroup;
+			children = (
+				B02FD55618C520D70009ECA9 /* iOS DemoTests-Info.plist */,
+				B02FD55718C520D70009ECA9 /* InfoPlist.strings */,
+			);
+			name = "Supporting Files";
+			sourceTree = "<group>";
+		};
+		B0779A7F18D376A5004DA9B7 /* Products */ = {
+			isa = PBXGroup;
+			children = (
+				B0779A8418D376A6004DA9B7 /* libSTK.a */,
+				B0779A8618D376A6004DA9B7 /* rawwaves.bundle */,
+			);
+			name = Products;
+			sourceTree = "<group>";
+		};
+/* End PBXGroup section */
+
+/* Begin PBXNativeTarget section */
+		B02FD53118C520D60009ECA9 /* iOS Demo */ = {
+			isa = PBXNativeTarget;
+			buildConfigurationList = B02FD55E18C520D70009ECA9 /* Build configuration list for PBXNativeTarget "iOS Demo" */;
+			buildPhases = (
+				B02FD52E18C520D60009ECA9 /* Sources */,
+				B02FD52F18C520D60009ECA9 /* Frameworks */,
+				B02FD53018C520D60009ECA9 /* Resources */,
+			);
+			buildRules = (
+			);
+			dependencies = (
+				834A47CC24435D350028575A /* PBXTargetDependency */,
+			);
+			name = "iOS Demo";
+			productName = "iOS Demo";
+			productReference = B02FD53218C520D60009ECA9 /* iOS Demo.app */;
+			productType = "com.apple.product-type.application";
+		};
+		B02FD54C18C520D70009ECA9 /* iOS DemoTests */ = {
+			isa = PBXNativeTarget;
+			buildConfigurationList = B02FD56118C520D70009ECA9 /* Build configuration list for PBXNativeTarget "iOS DemoTests" */;
+			buildPhases = (
+				B02FD54918C520D70009ECA9 /* Sources */,
+				B02FD54A18C520D70009ECA9 /* Frameworks */,
+				B02FD54B18C520D70009ECA9 /* Resources */,
+			);
+			buildRules = (
+			);
+			dependencies = (
+				B02FD55318C520D70009ECA9 /* PBXTargetDependency */,
+			);
+			name = "iOS DemoTests";
+			productName = "iOS DemoTests";
+			productReference = B02FD54D18C520D70009ECA9 /* iOS DemoTests.xctest */;
+			productType = "com.apple.product-type.bundle.unit-test";
+		};
+/* End PBXNativeTarget section */
+
+/* Begin PBXProject section */
+		B02FD52A18C520D60009ECA9 /* Project object */ = {
+			isa = PBXProject;
+			attributes = {
+				LastUpgradeCheck = 1140;
+				ORGANIZATIONNAME = "Ariel Elkin";
+				TargetAttributes = {
+					B02FD54C18C520D70009ECA9 = {
+						TestTargetID = B02FD53118C520D60009ECA9;
+					};
+				};
+			};
+			buildConfigurationList = B02FD52D18C520D60009ECA9 /* Build configuration list for PBXProject "iOS Demo" */;
+			compatibilityVersion = "Xcode 3.2";
+			developmentRegion = en;
+			hasScannedForEncodings = 0;
+			knownRegions = (
+				en,
+				Base,
+			);
+			mainGroup = B02FD52918C520D60009ECA9;
+			productRefGroup = B02FD53318C520D60009ECA9 /* Products */;
+			projectDirPath = "";
+			projectReferences = (
+				{
+					ProductGroup = B0779A7F18D376A5004DA9B7 /* Products */;
+					ProjectRef = B0779A7E18D376A5004DA9B7 /* STK.xcodeproj */;
+				},
+			);
+			projectRoot = "";
+			targets = (
+				B02FD53118C520D60009ECA9 /* iOS Demo */,
+				B02FD54C18C520D70009ECA9 /* iOS DemoTests */,
+			);
+		};
+/* End PBXProject section */
+
+/* Begin PBXReferenceProxy section */
+		B0779A8418D376A6004DA9B7 /* libSTK.a */ = {
+			isa = PBXReferenceProxy;
+			fileType = archive.ar;
+			path = libSTK.a;
+			remoteRef = B0779A8318D376A6004DA9B7 /* PBXContainerItemProxy */;
+			sourceTree = BUILT_PRODUCTS_DIR;
+		};
+		B0779A8618D376A6004DA9B7 /* rawwaves.bundle */ = {
+			isa = PBXReferenceProxy;
+			fileType = wrapper.cfbundle;
+			path = rawwaves.bundle;
+			remoteRef = B0779A8518D376A6004DA9B7 /* PBXContainerItemProxy */;
+			sourceTree = BUILT_PRODUCTS_DIR;
+		};
+/* End PBXReferenceProxy section */
+
+/* Begin PBXResourcesBuildPhase section */
+		B02FD53018C520D60009ECA9 /* Resources */ = {
+			isa = PBXResourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				B0779A8B18D37C13004DA9B7 /* rawwaves.bundle in Resources */,
+				B02FD54018C520D60009ECA9 /* InfoPlist.strings in Resources */,
+				B02FD54818C520D60009ECA9 /* Images.xcassets in Resources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+		B02FD54B18C520D70009ECA9 /* Resources */ = {
+			isa = PBXResourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				B02FD55918C520D70009ECA9 /* InfoPlist.strings in Resources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXResourcesBuildPhase section */
+
+/* Begin PBXSourcesBuildPhase section */
+		B02FD52E18C520D60009ECA9 /* Sources */ = {
+			isa = PBXSourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				B02FD57018C521560009ECA9 /* ViewController.mm in Sources */,
+				B02FD54618C520D60009ECA9 /* AppDelegate.m in Sources */,
+				B02FD54218C520D60009ECA9 /* main.m in Sources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+		B02FD54918C520D70009ECA9 /* Sources */ = {
+			isa = PBXSourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				B02FD55B18C520D70009ECA9 /* iOS_DemoTests.m in Sources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXSourcesBuildPhase section */
+
+/* Begin PBXTargetDependency section */
+		834A47CC24435D350028575A /* PBXTargetDependency */ = {
+			isa = PBXTargetDependency;
+			name = rawwaves;
+			targetProxy = 834A47CB24435D350028575A /* PBXContainerItemProxy */;
+		};
+		B02FD55318C520D70009ECA9 /* PBXTargetDependency */ = {
+			isa = PBXTargetDependency;
+			target = B02FD53118C520D60009ECA9 /* iOS Demo */;
+			targetProxy = B02FD55218C520D70009ECA9 /* PBXContainerItemProxy */;
+		};
+/* End PBXTargetDependency section */
+
+/* Begin PBXVariantGroup section */
+		B02FD53E18C520D60009ECA9 /* InfoPlist.strings */ = {
+			isa = PBXVariantGroup;
+			children = (
+				B02FD53F18C520D60009ECA9 /* en */,
+			);
+			name = InfoPlist.strings;
+			sourceTree = "<group>";
+		};
+		B02FD55718C520D70009ECA9 /* InfoPlist.strings */ = {
+			isa = PBXVariantGroup;
+			children = (
+				B02FD55818C520D70009ECA9 /* en */,
+			);
+			name = InfoPlist.strings;
+			sourceTree = "<group>";
+		};
+/* End PBXVariantGroup section */
+
+/* Begin XCBuildConfiguration section */
+		B02FD55C18C520D70009ECA9 /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				ALWAYS_SEARCH_USER_PATHS = NO;
+				CLANG_ANALYZER_LOCALIZABILITY_NONLOCALIZED = YES;
+				CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
+				CLANG_CXX_LIBRARY = "libc++";
+				CLANG_ENABLE_MODULES = YES;
+				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
+				CLANG_WARN_BOOL_CONVERSION = YES;
+				CLANG_WARN_COMMA = YES;
+				CLANG_WARN_CONSTANT_CONVERSION = YES;
+				CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
+				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
+				CLANG_WARN_EMPTY_BODY = YES;
+				CLANG_WARN_ENUM_CONVERSION = YES;
+				CLANG_WARN_INFINITE_RECURSION = YES;
+				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
+				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
+				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
+				CLANG_WARN_UNREACHABLE_CODE = YES;
+				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
+				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
+				COPY_PHASE_STRIP = NO;
+				ENABLE_STRICT_OBJC_MSGSEND = YES;
+				ENABLE_TESTABILITY = YES;
+				GCC_C_LANGUAGE_STANDARD = gnu99;
+				GCC_DYNAMIC_NO_PIC = NO;
+				GCC_NO_COMMON_BLOCKS = YES;
+				GCC_OPTIMIZATION_LEVEL = 0;
+				GCC_PREPROCESSOR_DEFINITIONS = (
+					"DEBUG=1",
+					"$(inherited)",
+				);
+				GCC_SYMBOLS_PRIVATE_EXTERN = NO;
+				GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
+				GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
+				GCC_WARN_UNDECLARED_SELECTOR = YES;
+				GCC_WARN_UNINITIALIZED_AUTOS = YES;
+				GCC_WARN_UNUSED_FUNCTION = YES;
+				GCC_WARN_UNUSED_VARIABLE = YES;
+				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
+				ONLY_ACTIVE_ARCH = YES;
+				SDKROOT = iphoneos;
+			};
+			name = Debug;
+		};
+		B02FD55D18C520D70009ECA9 /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				ALWAYS_SEARCH_USER_PATHS = NO;
+				CLANG_ANALYZER_LOCALIZABILITY_NONLOCALIZED = YES;
+				CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
+				CLANG_CXX_LIBRARY = "libc++";
+				CLANG_ENABLE_MODULES = YES;
+				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
+				CLANG_WARN_BOOL_CONVERSION = YES;
+				CLANG_WARN_COMMA = YES;
+				CLANG_WARN_CONSTANT_CONVERSION = YES;
+				CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
+				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
+				CLANG_WARN_EMPTY_BODY = YES;
+				CLANG_WARN_ENUM_CONVERSION = YES;
+				CLANG_WARN_INFINITE_RECURSION = YES;
+				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
+				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
+				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
+				CLANG_WARN_UNREACHABLE_CODE = YES;
+				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
+				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
+				COPY_PHASE_STRIP = YES;
+				ENABLE_NS_ASSERTIONS = NO;
+				ENABLE_STRICT_OBJC_MSGSEND = YES;
+				GCC_C_LANGUAGE_STANDARD = gnu99;
+				GCC_NO_COMMON_BLOCKS = YES;
+				GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
+				GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
+				GCC_WARN_UNDECLARED_SELECTOR = YES;
+				GCC_WARN_UNINITIALIZED_AUTOS = YES;
+				GCC_WARN_UNUSED_FUNCTION = YES;
+				GCC_WARN_UNUSED_VARIABLE = YES;
+				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
+				SDKROOT = iphoneos;
+				VALIDATE_PRODUCT = YES;
+			};
+			name = Release;
+		};
+		B02FD55F18C520D70009ECA9 /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
+				ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME = LaunchImage;
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = "iOS Demo/iOS Demo-Prefix.pch";
+				HEADER_SEARCH_PATHS = (
+					../../include/,
+					"$(inherited)",
+					/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include,
+				);
+				INFOPLIST_FILE = "iOS Demo/iOS Demo-Info.plist";
+				PRODUCT_BUNDLE_IDENTIFIER = "stk.${PRODUCT_NAME:rfc1034identifier}";
+				PRODUCT_NAME = "$(TARGET_NAME)";
+				WRAPPER_EXTENSION = app;
+			};
+			name = Debug;
+		};
+		B02FD56018C520D70009ECA9 /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
+				ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME = LaunchImage;
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = "iOS Demo/iOS Demo-Prefix.pch";
+				HEADER_SEARCH_PATHS = (
+					../../include/,
+					"$(inherited)",
+					/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include,
+				);
+				INFOPLIST_FILE = "iOS Demo/iOS Demo-Info.plist";
+				PRODUCT_BUNDLE_IDENTIFIER = "stk.${PRODUCT_NAME:rfc1034identifier}";
+				PRODUCT_NAME = "$(TARGET_NAME)";
+				WRAPPER_EXTENSION = app;
+			};
+			name = Release;
+		};
+		B02FD56218C520D70009ECA9 /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				BUNDLE_LOADER = "$(BUILT_PRODUCTS_DIR)/iOS Demo.app/iOS Demo";
+				FRAMEWORK_SEARCH_PATHS = (
+					"$(SDKROOT)/Developer/Library/Frameworks",
+					"$(inherited)",
+					"$(DEVELOPER_FRAMEWORKS_DIR)",
+				);
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = "iOS Demo/iOS Demo-Prefix.pch";
+				GCC_PREPROCESSOR_DEFINITIONS = (
+					"DEBUG=1",
+					"$(inherited)",
+				);
+				INFOPLIST_FILE = "iOS DemoTests/iOS DemoTests-Info.plist";
+				PRODUCT_BUNDLE_IDENTIFIER = "stk.${PRODUCT_NAME:rfc1034identifier}";
+				PRODUCT_NAME = "$(TARGET_NAME)";
+				TEST_HOST = "$(BUNDLE_LOADER)";
+				WRAPPER_EXTENSION = xctest;
+			};
+			name = Debug;
+		};
+		B02FD56318C520D70009ECA9 /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				BUNDLE_LOADER = "$(BUILT_PRODUCTS_DIR)/iOS Demo.app/iOS Demo";
+				FRAMEWORK_SEARCH_PATHS = (
+					"$(SDKROOT)/Developer/Library/Frameworks",
+					"$(inherited)",
+					"$(DEVELOPER_FRAMEWORKS_DIR)",
+				);
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = "iOS Demo/iOS Demo-Prefix.pch";
+				INFOPLIST_FILE = "iOS DemoTests/iOS DemoTests-Info.plist";
+				PRODUCT_BUNDLE_IDENTIFIER = "stk.${PRODUCT_NAME:rfc1034identifier}";
+				PRODUCT_NAME = "$(TARGET_NAME)";
+				TEST_HOST = "$(BUNDLE_LOADER)";
+				WRAPPER_EXTENSION = xctest;
+			};
+			name = Release;
+		};
+/* End XCBuildConfiguration section */
+
+/* Begin XCConfigurationList section */
+		B02FD52D18C520D60009ECA9 /* Build configuration list for PBXProject "iOS Demo" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				B02FD55C18C520D70009ECA9 /* Debug */,
+				B02FD55D18C520D70009ECA9 /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
+		};
+		B02FD55E18C520D70009ECA9 /* Build configuration list for PBXNativeTarget "iOS Demo" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				B02FD55F18C520D70009ECA9 /* Debug */,
+				B02FD56018C520D70009ECA9 /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
+		};
+		B02FD56118C520D70009ECA9 /* Build configuration list for PBXNativeTarget "iOS DemoTests" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				B02FD56218C520D70009ECA9 /* Debug */,
+				B02FD56318C520D70009ECA9 /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
+		};
+/* End XCConfigurationList section */
+	};
+	rootObject = B02FD52A18C520D60009ECA9 /* Project object */;
+}

iOS/demo/iOS Demo.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "self:iOS Demo.xcodeproj">
+   </FileRef>
+</Workspace>

iOS/demo/iOS Demo.xcodeproj/project.xcworkspace/xcshareddata/iOS Demo.xccheckout

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDESourceControlProjectFavoriteDictionaryKey</key>
+	<false/>
+	<key>IDESourceControlProjectIdentifier</key>
+	<string>4E1BA790-84C0-4F40-AECE-98269B537CE6</string>
+	<key>IDESourceControlProjectName</key>
+	<string>iOS Demo</string>
+	<key>IDESourceControlProjectOriginsDictionary</key>
+	<dict>
+		<key>CB047168-D1C4-40BC-85A3-6EB0A20AD217</key>
+		<string>ssh://github.com/arielelkin/stk.git</string>
+	</dict>
+	<key>IDESourceControlProjectPath</key>
+	<string>iOS/Demo/iOS Demo.xcodeproj/project.xcworkspace</string>
+	<key>IDESourceControlProjectRelativeInstallPathDictionary</key>
+	<dict>
+		<key>CB047168-D1C4-40BC-85A3-6EB0A20AD217</key>
+		<string>../../../..</string>
+	</dict>
+	<key>IDESourceControlProjectURL</key>
+	<string>ssh://github.com/arielelkin/stk.git</string>
+	<key>IDESourceControlProjectVersion</key>
+	<integer>110</integer>
+	<key>IDESourceControlProjectWCCIdentifier</key>
+	<string>CB047168-D1C4-40BC-85A3-6EB0A20AD217</string>
+	<key>IDESourceControlProjectWCConfigurations</key>
+	<array>
+		<dict>
+			<key>IDESourceControlRepositoryExtensionIdentifierKey</key>
+			<string>public.vcs.git</string>
+			<key>IDESourceControlWCCIdentifierKey</key>
+			<string>CB047168-D1C4-40BC-85A3-6EB0A20AD217</string>
+			<key>IDESourceControlWCCName</key>
+			<string>stk</string>
+		</dict>
+	</array>
+</dict>
+</plist>

iOS/demo/iOS Demo/AppDelegate.h

@@ -0,0 +1,14 @@
+//
+//  AppDelegate.h
+//  iOS Demo
+//
+//  Created by Ariel Elkin on 03/03/2014.
+//
+
+#import <UIKit/UIKit.h>
+
+@interface AppDelegate : UIResponder <UIApplicationDelegate>
+
+@property (strong, nonatomic) UIWindow *window;
+
+@end

iOS/demo/iOS Demo/AppDelegate.m

@@ -0,0 +1,25 @@
+//
+//  AppDelegate.m
+//  iOS Demo
+//
+//  Created by Ariel Elkin on 03/03/2014.
+//
+
+#import "AppDelegate.h"
+#import "ViewController.h"
+
+@implementation AppDelegate
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+    self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
+    
+    ViewController *vc = [[ViewController alloc] initWithNibName:nil bundle:nil];
+    [self.window setRootViewController:vc];
+    
+    [self.window makeKeyAndVisible];
+    
+    return YES;
+}
+
+@end

iOS/demo/iOS Demo/Images.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,23 @@
+{
+  "images" : [
+    {
+      "idiom" : "iphone",
+      "size" : "29x29",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "iphone",
+      "size" : "40x40",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "iphone",
+      "size" : "60x60",
+      "scale" : "2x"
+    }
+  ],
+  "info" : {
+    "version" : 1,
+    "author" : "xcode"
+  }
+}

iOS/demo/iOS Demo/Images.xcassets/LaunchImage.launchimage/Contents.json

@@ -0,0 +1,23 @@
+{
+  "images" : [
+    {
+      "orientation" : "portrait",
+      "idiom" : "iphone",
+      "extent" : "full-screen",
+      "minimum-system-version" : "7.0",
+      "scale" : "2x"
+    },
+    {
+      "orientation" : "portrait",
+      "idiom" : "iphone",
+      "subtype" : "retina4",
+      "extent" : "full-screen",
+      "minimum-system-version" : "7.0",
+      "scale" : "2x"
+    }
+  ],
+  "info" : {
+    "version" : 1,
+    "author" : "xcode"
+  }
+}

iOS/demo/iOS Demo/ViewController.h

@@ -0,0 +1,12 @@
+//
+//  ViewController.h
+//  iOS Demo
+//
+//  Created by Ariel Elkin on 03/03/2014.
+//
+
+#import <UIKit/UIKit.h>
+
+@interface ViewController : UIViewController
+
+@end

iOS/demo/iOS Demo/ViewController.mm

@@ -0,0 +1,108 @@
+//
+//  ViewController.m
+//  iOS Demo
+//
+//  Created by Ariel Elkin on 03/03/2014.
+//
+
+#import "ViewController.h"
+
+#import "SineWave.h"
+#import "Brass.h"
+#import "Mandolin.h"
+
+@implementation ViewController {
+    stk::SineWave *sineWave;
+    stk::Brass *brass;
+}
+
+- (void)loadView {
+    self.view = [UIView new];
+    [self.view setBackgroundColor:[UIColor whiteColor]];
+    [self setupUI];
+}
+
+- (void)viewDidAppear:(BOOL)animated {
+    [super viewDidAppear:animated];
+    
+    NSUInteger samplesToGenerate = 1000;
+    
+    //Test SineWave:
+    sineWave = new stk::SineWave();
+    
+    for (NSUInteger i = 0; i < samplesToGenerate; i ++) {
+        float sample = sineWave->tick();
+        NSLog(@"SineWave sample: %f", sample);
+    }
+    
+    //Test Brass:
+    brass = new stk::Brass();
+    
+    brass->noteOn(400, 1);
+    
+    for (NSUInteger i = 0; i < samplesToGenerate; i ++) {
+        float sample = brass->tick();
+        NSLog(@"Brass sample: %f", sample);
+    }
+
+    //We're going to be making use of a class that needs
+    //raw wave files, we need to tell the STK where
+    //the files are:
+    stk::Stk::setRawwavePath([[[NSBundle mainBundle] pathForResource:@"rawwaves" ofType:@"bundle"] UTF8String]);
+
+
+    //Test Mandolin:
+    stk::Mandolin *mandolin = new stk::Mandolin(400);
+    
+    mandolin->pluck(1);
+    
+    for (NSUInteger i = 0; i < samplesToGenerate; i ++) {
+        float sample = mandolin->tick();
+        NSLog(@"Mandolin sample: %f", sample);
+    }
+    
+    
+    #pragma mark TODO - Audio playback
+}
+
+
+- (void)sineSliderMoved:(UISlider *)slider {
+    sineWave->setFrequency(slider.value);
+    NSLog(@"Setting SineWave frequency to %.2f", slider.value);
+}
+
+- (void)brassSliderMoved:(UISlider *)slider {
+    brass->setFrequency(slider.value);
+    NSLog(@"Setting Brass frequency to %.2f", slider.value);
+}
+
+- (void)setupUI {
+    
+    //Add slider to control sine wave frequency:
+    UISlider *sineSlider = [[UISlider alloc] init];
+    [sineSlider addTarget:self action:@selector(sineSliderMoved:) forControlEvents:UIControlEventValueChanged];
+    [sineSlider setMinimumValue:0];
+    [sineSlider setMaximumValue:800];
+    [sineSlider setTranslatesAutoresizingMaskIntoConstraints:NO];
+    [self.view addSubview:sineSlider];
+    
+    NSDictionary *metrics = @{@"sliderWidth": @200};
+    
+    NSArray *sliderConstraints = [NSLayoutConstraint constraintsWithVisualFormat:@"H:|-40-[sineSlider(sliderWidth)]" options:0 metrics:metrics views:@{@"sineSlider": sineSlider}];
+    [self.view addConstraints:sliderConstraints];
+    
+    //Add slider to control brass's frequency:
+    UISlider *brassSlider = [[UISlider alloc] init];
+    [brassSlider addTarget:self action:@selector(brassSliderMoved:) forControlEvents:UIControlEventValueChanged];
+    [brassSlider setMinimumValue:0];
+    [brassSlider setMaximumValue:800];
+    [brassSlider setTranslatesAutoresizingMaskIntoConstraints:NO];
+    [self.view addSubview:brassSlider];
+    
+    sliderConstraints = [NSLayoutConstraint constraintsWithVisualFormat:@"H:|-40-[brassSlider(sliderWidth)]" options:0 metrics:metrics views:@{@"brassSlider": brassSlider}];
+    [self.view addConstraints:sliderConstraints];
+    sliderConstraints = [NSLayoutConstraint constraintsWithVisualFormat:@"V:|-40-[sineSlider]-[brassSlider]" options:0 metrics:nil views:@{@"sineSlider": sineSlider, @"brassSlider": brassSlider}];
+    [self.view addConstraints:sliderConstraints];
+}
+
+@end

iOS/demo/iOS Demo/en.lproj/InfoPlist.strings

@@ -0,0 +1,2 @@
+/* Localized versions of Info.plist keys */
+

iOS/demo/iOS Demo/iOS Demo-Info.plist

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleDisplayName</key>
+	<string>${PRODUCT_NAME}</string>
+	<key>CFBundleExecutable</key>
+	<string>${EXECUTABLE_NAME}</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>${PRODUCT_NAME}</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>LSRequiresIPhoneOS</key>
+	<true/>
+	<key>UIRequiredDeviceCapabilities</key>
+	<array>
+		<string>armv7</string>
+	</array>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+</dict>
+</plist>

iOS/demo/iOS Demo/iOS Demo-Prefix.pch

@@ -0,0 +1,16 @@
+//
+//  Prefix header
+//
+//  The contents of this file are implicitly included at the beginning of every source file.
+//
+
+#import <Availability.h>
+
+#ifndef __IPHONE_3_0
+#warning "This project uses features only available in iOS SDK 3.0 and later."
+#endif
+
+#ifdef __OBJC__
+    #import <UIKit/UIKit.h>
+    #import <Foundation/Foundation.h>
+#endif

iOS/demo/iOS Demo/main.m

@@ -0,0 +1,18 @@
+//
+//  main.m
+//  iOS Demo
+//
+//  Created by Ariel Elkin on 03/03/2014.
+//  Copyright (c) 2014 Ariel Elkin. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+
+#import "AppDelegate.h"
+
+int main(int argc, char * argv[])
+{
+    @autoreleasepool {
+        return UIApplicationMain(argc, argv, nil, NSStringFromClass([AppDelegate class]));
+    }
+}

iOS/demo/iOS DemoTests/en.lproj/InfoPlist.strings

@@ -0,0 +1,2 @@
+/* Localized versions of Info.plist keys */
+

iOS/demo/iOS DemoTests/iOS DemoTests-Info.plist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleExecutable</key>
+	<string>${EXECUTABLE_NAME}</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundlePackageType</key>
+	<string>BNDL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>

iOS/demo/iOS DemoTests/iOS_DemoTests.m

@@ -0,0 +1,34 @@
+//
+//  iOS_DemoTests.m
+//  iOS DemoTests
+//
+//  Created by Ariel Elkin on 03/03/2014.
+//  Copyright (c) 2014 Ariel Elkin. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+
+@interface iOS_DemoTests : XCTestCase
+
+@end
+
+@implementation iOS_DemoTests
+
+- (void)setUp
+{
+    [super setUp];
+    // Put setup code here. This method is called before the invocation of each test method in the class.
+}
+
+- (void)tearDown
+{
+    // Put teardown code here. This method is called after the invocation of each test method in the class.
+    [super tearDown];
+}
+
+- (void)testExample
+{
+    XCTFail(@"No implementation for \"%s\"", __PRETTY_FUNCTION__);
+}
+
+@end

include/ADSR.h

@@ -11,10 +11,13 @@ namespace stk {
 
     This class implements a traditional ADSR (Attack, Decay, Sustain,
     Release) envelope.  It responds to simple keyOn and keyOff
-    messages, keeping track of its state.  The \e state = ADSR::DONE
-    after the envelope value reaches 0.0 in the ADSR::RELEASE state.
+    messages, keeping track of its state.  The \e state = ADSR::IDLE
+    before being triggered and after the envelope value reaches 0.0 in
+    the ADSR::RELEASE state.  All rate, target and level settings must
+    be non-negative.  All time settings are in seconds and must be
+    positive.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -28,7 +31,7 @@ class ADSR : public Generator
     DECAY,    /*!< Decay */
     SUSTAIN,  /*!< Sustain */
     RELEASE,  /*!< Release */
-    DONE      /*!< End of release */
+    IDLE      /*!< Before attack / after release */
   };
 
   //! Default constructor.
@@ -43,34 +46,37 @@ class ADSR : public Generator
   //! Set target = 0, state = \e ADSR::RELEASE.
   void keyOff( void );
 
-  //! Set the attack rate.
+  //! Set the attack rate (gain / sample).
   void setAttackRate( StkFloat rate );
 
-  //! Set the decay rate.
+  //! Set the target value for the attack (default = 1.0).
+  void setAttackTarget( StkFloat target );
+
+  //! Set the decay rate (gain / sample).
   void setDecayRate( StkFloat rate );
 
   //! Set the sustain level.
   void setSustainLevel( StkFloat level );
 
-  //! Set the release rate.
+  //! Set the release rate (gain / sample).
   void setReleaseRate( StkFloat rate );
 
-  //! Set the attack rate based on a time duration.
+  //! Set the attack rate based on a time duration (seconds).
   void setAttackTime( StkFloat time );
 
-  //! Set the decay rate based on a time duration.
+  //! Set the decay rate based on a time duration (seconds).
   void setDecayTime( StkFloat time );
 
-  //! Set the release rate based on a time duration.
+  //! Set the release rate based on a time duration (seconds).
   void setReleaseTime( StkFloat time );
 
-  //! Set sustain level and attack, decay, and release time durations.
+  //! Set sustain level and attack, decay, and release time durations (seconds).
   void setAllTimes( StkFloat aTime, StkFloat dTime, StkFloat sLevel, StkFloat rTime );
 
-  //! Set the target value.
+  //! Set a sustain target value and attack or decay from current value to target.
   void setTarget( StkFloat target );
 
-  //! Return the current envelope \e state (ATTACK, DECAY, SUSTAIN, RELEASE, DONE).
+  //! Return the current envelope \e state (ATTACK, DECAY, SUSTAIN, RELEASE, IDLE).
   int getState( void ) const { return state_; };
 
   //! Set to state = ADSR::SUSTAIN with current and target values of \e value.
@@ -102,6 +108,7 @@ class ADSR : public Generator
   StkFloat attackRate_;
   StkFloat decayRate_;
   StkFloat releaseRate_;
+  StkFloat releaseTime_;
   StkFloat sustainLevel_;
 };
 
@@ -120,10 +127,19 @@ inline StkFloat ADSR :: tick( void )
     break;
 
   case DECAY:
-    value_ -= decayRate_;
-    if ( value_ <= sustainLevel_ ) {
-      value_ = sustainLevel_;
-      state_ = SUSTAIN;
+    if ( value_ > sustainLevel_ ) {
+      value_ -= decayRate_;
+      if ( value_ <= sustainLevel_ ) {
+        value_ = sustainLevel_;
+        state_ = SUSTAIN;
+      }
+    }
+    else {
+      value_ += decayRate_; // attack target < sustain level
+      if ( value_ >= sustainLevel_ ) {
+        value_ = sustainLevel_;
+        state_ = SUSTAIN;
+      }
     }
     lastFrame_[0] = value_;
     break;
@@ -131,8 +147,8 @@ inline StkFloat ADSR :: tick( void )
   case RELEASE:
     value_ -= releaseRate_;
     if ( value_ <= 0.0 ) {
-      value_ = (StkFloat) 0.0;
-      state_ = DONE;
+      value_ = 0.0;
+      state_ = IDLE;
     }
     lastFrame_[0] = value_;
 
@@ -145,7 +161,7 @@ inline StkFrames& ADSR :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "ADSR::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "ADSR::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/Asymp.h

@@ -26,7 +26,7 @@ namespace stk {
     to \e keyOn and \e keyOff messages by ramping to
     1.0 on keyOn and to 0.0 on keyOff.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -60,6 +60,9 @@ class Asymp : public Generator
   //! Set the asymptotic rate based on a time duration (must be > 0).
   void setTime( StkFloat time );
 
+  //! Set the asymptotic rate such that the target value is perceptually reached (to within -60dB of the target) in \e t60 seconds.
+  void setT60( StkFloat t60 );
+
   //! Set the target value.
   void setTarget( StkFloat target );
 
@@ -125,7 +128,7 @@ inline StkFrames& Asymp :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "Asymp::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Asymp::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/BandedWG.h

@@ -35,7 +35,7 @@ namespace stk {
          - Glass Harmonica = 2
          - Tibetan Bowl = 3
 
-    by Georg Essl, 1999 - 2004.
+    by Georg Essl, 1999--2004.
     Modified for STK 4.0 by Gary Scavone.
 */
 /***************************************************/
@@ -84,6 +84,16 @@ class BandedWG : public Instrmnt
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   bool doPluck_;
@@ -111,6 +121,33 @@ class BandedWG : public Instrmnt
 
 };
 
+inline StkFrames& BandedWG :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "BandedWG::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/BeeThree.h

@@ -35,7 +35,7 @@ namespace stk {
     type who should worry about this (making
     money) worry away.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -57,13 +57,23 @@ class BeeThree : public FM
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
 };
 
 inline StkFloat BeeThree :: tick( unsigned int )
 {
-  register StkFloat temp;
+  StkFloat temp;
 
   if ( modDepth_ > 0.0 )	{
     temp = 1.0 + ( modDepth_ * vibrato_.tick() * 0.1 );
@@ -85,6 +95,33 @@ inline StkFloat BeeThree :: tick( unsigned int )
   return lastFrame_[0];
 }
 
+inline StkFrames& BeeThree :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "BeeThree::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/BiQuad.h

@@ -13,10 +13,15 @@ namespace stk {
     Methods are provided for creating a resonance or notch in the
     frequency response while maintaining a constant filter gain.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    Formulae used calculate coefficients for lowpass, highpass,
+    bandpass, bandreject and allpass are found on pg. 55 of
+    Udo Zölzer's "DAFX - Digital Audio Effects" (2011 2nd ed).   
+
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
+const StkFloat RECIP_SQRT_2 = static_cast<StkFloat>( M_SQRT1_2 );  
 class BiQuad : public Filter
 {
 public:
@@ -59,6 +64,8 @@ public:
     filter frequency response has a resonance at the given \e
     frequency.  The closer the poles are to the unit-circle (\e radius
     close to one), the narrower the resulting resonance width.
+    An unstable filter will result for \e radius >= 1.0.  The
+    \e frequency value should be between zero and half the sample rate.
   */
   void setResonance( StkFloat frequency, StkFloat radius, bool normalize = false );
 
@@ -66,17 +73,78 @@ public:
   /*!
     This method determines the filter coefficients corresponding to
     two complex-conjugate zeros with the given \e frequency (in Hz)
-    and \e radius from the z-plane origin.  No filter normalization
-    is attempted.
+    and \e radius from the z-plane origin.  No filter normalization is
+    attempted.  The \e frequency value should be between zero and half
+    the sample rate.  The \e radius value should be positive.
   */
   void setNotch( StkFloat frequency, StkFloat radius );
 
+  //! Set the filter coefficients for a low-pass with cutoff frequency \e fc (in Hz) and Q-factor \e Q.
+  /*!
+    This method determines the filter coefficients corresponding to a 
+    low-pass filter with cutoff placed at \e fc, where sloping behaviour 
+    and resonance are determined by \e Q. The default value for \e Q is 
+    1/sqrt(2), resulting in a gradual attenuation of frequencies higher than
+    \e fc without added resonance. Values greater than this will more 
+    aggressively attenuate frequencies above \e fc while also adding a 
+    resonance at \e fc. Values less than this will result in a more gradual
+    attenuation of frequencies above \e fc, but will also attenuate 
+    frequencies below \e fc as well. Both \e fc and \e Q must be positive.
+  */
+  void setLowPass( StkFloat fc, StkFloat Q=RECIP_SQRT_2 );
+
+  //! Set the filter coefficients for a high-pass with cutoff frequency \e fc (in Hz) and Q-factor \e Q.
+  /*!
+    This method determines the filter coefficients corresponding to a high-pass 
+    filter with cutoff placed at \e fc, where sloping behaviour and resonance 
+    are determined by \e Q. The default value for \e Q is 1/sqrt(2), resulting 
+    in a gradual attenuation of frequencies lower than \e fc without added 
+    resonance. Values greater than this will more aggressively attenuate 
+    frequencies below \e fc while also adding a resonance at \e fc. Values less 
+    than this will result in a more gradual attenuation of frequencies below 
+    \e fc, but will also attenuate frequencies above \e fc as well. 
+    Both \e fc and \e Q must be positive.
+  */
+  void setHighPass( StkFloat fc, StkFloat Q=RECIP_SQRT_2 );
+
+  //! Set the filter coefficients for a band-pass centered at \e fc (in Hz) with Q-factor \e Q.
+  /*!
+    This method determines the filter coefficients corresponding to a band-pass
+    filter with pass-band centered at \e fc, where band width and slope a 
+    determined by \e Q. Values for \e Q that are less than 1.0 will attenuate
+    frequencies above and below \e fc more gradually, resulting in a convex 
+    slope and a wider band. Values for \e Q greater than 1.0 will attenuate 
+    frequencies above and below \e fc more aggressively, resulting in a 
+    concave slope and a narrower band. Both \e fc and \e Q must be positive.
+  */
+  void setBandPass( StkFloat fc, StkFloat Q );
+
+  //! Set the filter coefficients for a band-reject centered at \e fc (in Hz) with Q-factor \e Q.
+  /*!
+    This method determines the filter coefficients corresponding to a 
+    band-reject filter with stop-band centered at \e fc, where band width 
+    and slope are determined by \e Q. Values for \e Q that are less than 1.0 
+    will yield a wider band with greater attenuation of \e fc. Values for \e Q
+    greater than 1.0 will yield a narrower band with less attenuation of \e fc. 
+    Both \e fc and \e Q must be positive.
+  */
+  void setBandReject( StkFloat fc, StkFloat Q );
+
+  //! Set the filter coefficients for an all-pass centered at \e fc (in Hz) with Q-factor \e Q.
+  /*!
+    This method determines the filter coefficients corresponding to
+    an all-pass filter whose phase response crosses -pi radians at \e fc.
+    High values for \e Q will result in a more instantaenous shift in phase 
+    response at \e fc. Lower values will result in a more gradual shift in
+    phase response around \e fc. Both \e fc and \e Q must be positive.
+  */
+  void setAllPass( StkFloat fc, StkFloat Q );
+
   //! Sets the filter zeroes for equal resonance gain.
   /*!
     When using the filter as a resonator, zeroes places at z = 1, z
     = -1 will result in a constant gain at resonance of 1 / (1 - R),
     where R is the pole radius setting.
-
   */
   void setEqualGainZeroes( void );
 
@@ -111,6 +179,14 @@ public:
  protected:
 
   virtual void sampleRateChanged( StkFloat newRate, StkFloat oldRate );
+  
+  // Helper function to update the three intermediate values for the predefined filter types
+  // along with the feedback filter coefficients. Performs the debug check for fc and Q-factor arguments.
+  void setCommonFilterValues( StkFloat fc, StkFloat Q );
+
+  StkFloat K_;
+  StkFloat kSqr_;
+  StkFloat denom_;
 };
 
 inline StkFloat BiQuad :: tick( StkFloat input )
@@ -130,7 +206,7 @@ inline StkFrames& BiQuad :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "BiQuad::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "BiQuad::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -155,7 +231,7 @@ inline StkFrames& BiQuad :: tick( StkFrames& iFrames, StkFrames& oFrames, unsign
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "BiQuad::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "BiQuad::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/Blit.h

@@ -133,7 +133,7 @@ inline StkFrames& Blit :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "Blit::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Blit::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/BlitSaw.h

@@ -129,7 +129,7 @@ inline StkFrames& BlitSaw :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "BlitSaw::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "BlitSaw::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/BlitSquare.h

@@ -35,7 +35,7 @@ namespace stk {
     in the presence of significant aliasing.
 
     Based on initial code of Robin Davies, 2005.
-    Modified algorithm code by Gary Scavone, 2005 - 2006.
+    Modified algorithm code by Gary Scavone, 2005--2006.
 */
 /***************************************************/
 
@@ -152,7 +152,7 @@ inline StkFrames& BlitSquare :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "BlitSquare::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "BlitSquare::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/BlowBotl.h

@@ -25,7 +25,7 @@ namespace stk {
        - Vibrato Gain = 1
        - Volume = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -65,6 +65,16 @@ class BlowBotl : public Instrmnt
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   JetTable jetTable_;
@@ -102,6 +112,33 @@ inline StkFloat BlowBotl :: tick( unsigned int )
   return lastFrame_[0];
 }
 
+inline StkFrames& BlowBotl :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "BlowBotl::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/BlowHole.h

@@ -43,7 +43,7 @@ namespace stk {
        - Register State = 1
        - Breath Pressure = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -89,6 +89,16 @@ class BlowHole : public Instrmnt
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   DelayL    delays_[3];
@@ -98,15 +108,14 @@ class BlowHole : public Instrmnt
   PoleZero  vent_;
   Envelope  envelope_;
   Noise     noise_;
-  SineWave vibrato_;
-  unsigned long length_;
+  SineWave  vibrato_;
+
   StkFloat scatter_;
   StkFloat thCoeff_;
   StkFloat rhGain_;
   StkFloat outputGain_;
   StkFloat noiseGain_;
   StkFloat vibratoGain_;
-
 };
 
   inline StkFloat BlowHole :: tick( unsigned int )
@@ -144,6 +153,33 @@ class BlowHole : public Instrmnt
   return lastFrame_[0];
 }
 
+inline StkFrames& BlowHole :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "BlowHole::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/BowTable.h

@@ -11,9 +11,11 @@ namespace stk {
     \brief STK bowed string table class.
 
     This class implements a simple bowed string
-    non-linear function, as described by Smith (1986).
+    non-linear function, as described by Smith
+    (1986).  The output is an instantaneous
+    reflection coefficient value.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -21,7 +23,7 @@ class BowTable : public Function
 {
 public:
   //! Default constructor.
-  BowTable( void ) : offset_(0.0), slope_(0.1) {};
+  BowTable( void ) : offset_(0.0), slope_(0.1), minOutput_(0.01), maxOutput_(0.98) {};
 
   //! Set the table offset value.
   /*!
@@ -39,6 +41,12 @@ public:
   */
   void setSlope( StkFloat slope ) { slope_ = slope; };
 
+  //! Set the minimum table output value (0.0 - 1.0).
+  void setMinOutput( StkFloat minimum ) { minOutput_ = minimum; };
+
+  //! Set the maximum table output value (0.0 - 1.0).
+  void setMaxOutput( StkFloat maximum ) { maxOutput_ = maximum; };
+
   //! Take one sample input and map to one sample of output.
   StkFloat tick( StkFloat input );
 
@@ -68,6 +76,8 @@ protected:
 
   StkFloat offset_;
   StkFloat slope_;
+  StkFloat minOutput_;
+  StkFloat maxOutput_;
 
 };
 
@@ -79,11 +89,11 @@ inline StkFloat BowTable :: tick( StkFloat input )
   lastFrame_[0] = (StkFloat) fabs( (double) sample ) + (StkFloat) 0.75;
   lastFrame_[0] = (StkFloat) pow( lastFrame_[0], (StkFloat) -4.0 );
 
-  // Set minimum friction to 0.0
-  // if ( lastFrame_[0] < 0.0 ) lastFrame_[0] = 0.0;
+  // Set minimum threshold
+  if ( lastFrame_[0] < minOutput_ ) lastFrame_[0] = minOutput_;
 
-  // Set maximum friction to 1.0.
-  if ( lastFrame_[0] > 1.0 ) lastFrame_[0] = (StkFloat) 1.0;
+  // Set maximum threshold
+  if ( lastFrame_[0] > maxOutput_ ) lastFrame_[0] = maxOutput_;
 
   return lastFrame_[0];
 }
@@ -92,7 +102,7 @@ inline StkFrames& BowTable :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "BowTable::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "BowTable::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -115,7 +125,7 @@ inline StkFrames& BowTable :: tick( StkFrames& iFrames, StkFrames& oFrames, unsi
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "BowTable::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "BowTable::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/Bowed.h

@@ -28,9 +28,12 @@ namespace stk {
        - Bow Position = 4
        - Vibrato Frequency = 11
        - Vibrato Gain = 1
+       - Bow Velocity = 100
+       - Frequency = 101
        - Volume = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
+    Contributions by Esteban Maestre, 2011.
 */
 /***************************************************/
 
@@ -38,7 +41,7 @@ class Bowed : public Instrmnt
 {
  public:
   //! Class constructor, taking the lowest desired playing frequency.
-  Bowed( StkFloat lowestFrequency );
+  Bowed( StkFloat lowestFrequency = 8.0 );
 
   //! Class destructor.
   ~Bowed( void );
@@ -50,7 +53,7 @@ class Bowed : public Instrmnt
   void setFrequency( StkFloat frequency );
 
   //! Set vibrato gain.
-  void setVibrato( StkFloat gain );
+  void setVibrato( StkFloat gain ) { vibratoGain_ = gain; };
 
   //! Apply breath pressure to instrument with given amplitude and rate of increase.
   void startBowing( StkFloat amplitude, StkFloat rate );
@@ -70,15 +73,27 @@ class Bowed : public Instrmnt
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   DelayL   neckDelay_;
   DelayL   bridgeDelay_;
   BowTable bowTable_;
   OnePole  stringFilter_;
-  BiQuad   bodyFilter_;
+  BiQuad   bodyFilters_[6];
   SineWave vibrato_;
   ADSR     adsr_;
+
+  bool     bowDown_;
   StkFloat maxVelocity_;
   StkFloat baseDelay_;
   StkFloat vibratoGain_;
@@ -89,24 +104,54 @@ class Bowed : public Instrmnt
 inline StkFloat Bowed :: tick( unsigned int )
 {
   StkFloat bowVelocity = maxVelocity_ * adsr_.tick();
-  StkFloat bridgeRefl = -stringFilter_.tick( bridgeDelay_.lastOut() );
-  StkFloat nutRefl = -neckDelay_.lastOut();
-  StkFloat stringVel = bridgeRefl + nutRefl;               // Sum is string velocity
-  StkFloat velDiff = bowVelocity - stringVel;              // Differential velocity
-  StkFloat newVel = velDiff * bowTable_.tick( velDiff );   // Non-Linear bow function
-  neckDelay_.tick(bridgeRefl + newVel);                    // Do string propagations
-  bridgeDelay_.tick(nutRefl + newVel);
+  StkFloat bridgeReflection = -stringFilter_.tick( bridgeDelay_.lastOut() );
+  StkFloat nutReflection = -neckDelay_.lastOut();
+  StkFloat stringVelocity = bridgeReflection + nutReflection;
+  StkFloat deltaV = bowVelocity - stringVelocity;             // Differential velocity
+
+  StkFloat newVelocity = 0.0;
+  if ( bowDown_ )
+    newVelocity = deltaV * bowTable_.tick( deltaV );     // Non-Linear bow function
+  neckDelay_.tick( bridgeReflection + newVelocity);      // Do string propagations
+  bridgeDelay_.tick(nutReflection + newVelocity);
     
   if ( vibratoGain_ > 0.0 )  {
     neckDelay_.setDelay( (baseDelay_ * (1.0 - betaRatio_) ) + 
                          (baseDelay_ * vibratoGain_ * vibrato_.tick()) );
   }
 
-  lastFrame_[0] = bodyFilter_.tick( bridgeDelay_.lastOut() );
+  lastFrame_[0] = 0.1248 * bodyFilters_[5].tick( bodyFilters_[4].tick( bodyFilters_[3].tick( bodyFilters_[2].tick( bodyFilters_[1].tick( bodyFilters_[0].tick( bridgeDelay_.lastOut() ) ) ) ) ) );
 
   return lastFrame_[0];
 }
 
+inline StkFrames& Bowed :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "Bowed::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/Brass.h

@@ -28,7 +28,7 @@ namespace stk {
        - Vibrato Gain = 1
        - Volume = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -39,7 +39,7 @@ class Brass: public Instrmnt
   /*!
     An StkError will be thrown if the rawwave path is incorrectly set.
   */
-  Brass( StkFloat lowestFrequency );
+  Brass( StkFloat lowestFrequency = 8.0 );
 
   //! Class destructor.
   ~Brass(  );
@@ -71,6 +71,16 @@ class Brass: public Instrmnt
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   DelayA   delayLine_;
@@ -78,7 +88,7 @@ class Brass: public Instrmnt
   PoleZero dcBlock_;
   ADSR     adsr_;
   SineWave vibrato_;
-  unsigned long length_;
+
   StkFloat lipTarget_;
   StkFloat slideTarget_;
   StkFloat vibratoGain_;
@@ -105,6 +115,33 @@ inline StkFloat Brass :: tick( unsigned int )
   return lastFrame_[0];
 }
 
+inline StkFrames& Brass :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "Brass::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/Chorus.h

@@ -14,7 +14,7 @@ namespace stk {
     This class implements a chorus effect.  It takes a monophonic
     input signal and produces a stereo output signal.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -30,8 +30,8 @@ class Chorus : public Effect
   //! Reset and clear all internal state.
   void clear( void );
 
-  //! Set modulation depth.
-  void setModDepth( StkFloat depth ) { modDepth_ = depth; };
+  //! Set modulation depth in range 0.0 - 1.0.
+  void setModDepth( StkFloat depth );
 
   //! Set modulation frequency.
   void setModFrequency( StkFloat frequency );
@@ -94,7 +94,7 @@ inline StkFloat Chorus :: lastOut( unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel > 1 ) {
-    errorString_ << "Chorus::lastOut(): channel argument must be less than 2!";
+    oStream_ << "Chorus::lastOut(): channel argument must be less than 2!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -106,7 +106,7 @@ inline StkFloat Chorus :: tick( StkFloat input, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel > 1 ) {
-    errorString_ << "Chorus::tick(): channel argument must be less than 2!";
+    oStream_ << "Chorus::tick(): channel argument must be less than 2!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -122,7 +122,7 @@ inline StkFrames& Chorus :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() - 1 ) {
-    errorString_ << "Chorus::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Chorus::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -130,6 +130,8 @@ inline StkFrames& Chorus :: tick( StkFrames& frames, unsigned int channel )
   StkFloat *samples = &frames[channel];
   unsigned int hop = frames.channels() - 1;
   for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+    delayLine_[0].setDelay( baseLength_ * 0.707 * ( 1.0 + modDepth_ * mods_[0].tick() ) );
+    delayLine_[1].setDelay( baseLength_  * 0.5 *  ( 1.0 - modDepth_ * mods_[1].tick() ) );
     *samples = effectMix_ * ( delayLine_[0].tick( *samples ) - *samples ) + *samples;
     samples++;
     *samples = effectMix_ * ( delayLine_[1].tick( *samples ) - *samples ) + *samples;
@@ -144,7 +146,7 @@ inline StkFrames& Chorus :: tick( StkFrames& iFrames, StkFrames& oFrames, unsign
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() - 1 ) {
-    errorString_ << "Chorus::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Chorus::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -153,8 +155,10 @@ inline StkFrames& Chorus :: tick( StkFrames& iFrames, StkFrames& oFrames, unsign
   StkFloat *oSamples = &oFrames[oChannel];
   unsigned int iHop = iFrames.channels(), oHop = oFrames.channels();
   for ( unsigned int i=0; i<iFrames.frames(); i++, iSamples += iHop, oSamples += oHop ) {
-    *oSamples++ = effectMix_ * ( delayLine_[0].tick( *iSamples ) - *iSamples ) + *iSamples;
-    *oSamples = effectMix_ * ( delayLine_[1].tick( *iSamples ) - *iSamples ) + *iSamples;
+    delayLine_[0].setDelay( baseLength_ * 0.707 * ( 1.0 + modDepth_ * mods_[0].tick() ) );
+    delayLine_[1].setDelay( baseLength_  * 0.5 *  ( 1.0 - modDepth_ * mods_[1].tick() ) );
+    *oSamples = effectMix_ * ( delayLine_[0].tick( *iSamples ) - *iSamples ) + *iSamples;
+    *(oSamples+1) = effectMix_ * ( delayLine_[1].tick( *iSamples ) - *iSamples ) + *iSamples;
   }
 
   lastFrame_[0] = *(oSamples-oHop);

include/Clarinet.h

@@ -31,7 +31,7 @@ namespace stk {
        - Vibrato Gain = 1
        - Breath Pressure = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -42,7 +42,7 @@ class Clarinet : public Instrmnt
   /*!
     An StkError will be thrown if the rawwave path is incorrectly set.
   */
-  Clarinet( StkFloat lowestFrequency );
+  Clarinet( StkFloat lowestFrequency = 8.0 );
 
   //! Class destructor.
   ~Clarinet( void );
@@ -71,6 +71,16 @@ class Clarinet : public Instrmnt
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   DelayL delayLine_;
@@ -79,11 +89,10 @@ class Clarinet : public Instrmnt
   Envelope envelope_;
   Noise noise_;
   SineWave vibrato_;
-  long length_;
+
   StkFloat outputGain_;
   StkFloat noiseGain_;
   StkFloat vibratoGain_;
-
 };
 
 inline StkFloat Clarinet :: tick( unsigned int )
@@ -111,6 +120,33 @@ inline StkFloat Clarinet :: tick( unsigned int )
   return lastFrame_[0];
 }
 
+inline StkFrames& Clarinet :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "Clarinet::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/Cubic.h

@@ -0,0 +1,138 @@
+#ifndef STK_CUBIC_H
+#define STK_CUBIC_H
+
+#include "Function.h"
+#include <cmath>
+
+namespace stk {
+
+/***************************************************/
+/*! \class Cubic
+    \brief STK cubic non-linearity class.
+
+    This class implements the cubic non-linearity
+    that was used in SynthBuilder.
+
+    The formula implemented is:
+ 
+    \code
+    output = gain * (a1 * input + a2 * input^2 + a3 * input^3)
+    \endcode
+
+    followed by a limiter for values outside +-threshold.
+
+    Ported to STK by Nick Porcaro, 2007. Updated for inclusion
+    in STK distribution by Gary Scavone, 2011.
+*/
+/***************************************************/
+
+class Cubic : public Function
+{
+public:
+  //! Default constructor.
+  Cubic( void ) : a1_(0.5), a2_(0.5), a3_(0.5), gain_(1.0), threshold_(1.0) {};
+
+  //! Set the a1 coefficient value.
+  void setA1( StkFloat a1 ) { a1_ = a1; };
+
+  //! Set the a2 coefficient value.
+  void setA2( StkFloat a2 )  { a2_ = a2; };
+
+  //! Set the a3 coefficient value.
+  void setA3( StkFloat a3 )  { a3_ = a3; };
+
+  //! Set the gain value.
+  void setGain( StkFloat gain ) { gain_ = gain; };
+
+  //! Set the threshold value.
+  void setThreshold( StkFloat threshold ) { threshold_ = threshold; };
+
+  //! Input one sample to the function and return one output.
+  StkFloat tick( StkFloat input );
+
+  //! Take a channel of the StkFrames object as inputs to the function and replace with corresponding outputs.
+  /*!
+    The StkFrames argument reference is returned.  The \c channel
+    argument must be less than the number of channels in the
+    StkFrames argument (the first channel is specified by 0).
+    However, range checking is only performed if _STK_DEBUG_ is
+    defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
+  //! Take a channel of the \c iFrames object as inputs to the function and write outputs to the \c oFrames object.
+  /*!
+    The \c iFrames object reference is returned.  Each channel
+    argument must be less than the number of channels in the
+    corresponding StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& iFrames, StkFrames &oFrames, unsigned int iChannel = 0, unsigned int oChannel = 0 );
+
+protected:
+
+  StkFloat a1_;
+  StkFloat a2_;
+  StkFloat a3_;
+  StkFloat gain_; 
+  StkFloat threshold_;
+};
+
+inline StkFloat Cubic :: tick( StkFloat input )
+{
+  StkFloat inSquared = input * input;
+  StkFloat inCubed = inSquared * input;
+
+  lastFrame_[0] = gain_ * (a1_ * input + a2_ * inSquared + a3_ * inCubed);
+
+  // Apply threshold if we are out of range.
+  if ( fabs( lastFrame_[0] ) > threshold_ ) {
+    lastFrame_[0] = ( lastFrame_[0] < 0 ? -threshold_ : threshold_ );
+  }
+
+  return lastFrame_[0];
+}
+
+inline StkFrames& Cubic :: tick( StkFrames& frames, unsigned int channel )
+{
+#if defined(_STK_DEBUG_)
+  if ( channel >= frames.channels() ) {
+    oStream_ << "Cubic::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int hop = frames.channels();
+  for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+    *samples = tick( *samples );
+
+  lastFrame_[0] = *(samples-hop);
+  return frames;
+}
+
+inline StkFrames& Cubic :: tick( StkFrames& iFrames, StkFrames& oFrames, unsigned int iChannel, unsigned int oChannel )
+{
+#if defined(_STK_DEBUG_)
+  if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
+    oStream_ << "Cubic::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *iSamples = &iFrames[iChannel];
+  StkFloat *oSamples = &oFrames[oChannel];
+  unsigned int iHop = iFrames.channels(), oHop = oFrames.channels();
+  for ( unsigned int i=0; i<iFrames.frames(); i++, iSamples += iHop, oSamples += oHop )
+    *oSamples = tick( *iSamples );
+
+  lastFrame_[0] = *(oSamples-oHop);
+  return iFrames;
+}
+
+} // stk namespace
+
+#endif

include/Delay.h

@@ -17,7 +17,7 @@ namespace stk {
     A non-interpolating delay line is typically used in fixed
     delay-length applications, such as for reverberation.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -36,13 +36,16 @@ public:
   //! Class destructor.
   ~Delay();
 
+  //! Get the maximum delay-line length.
+  unsigned long getMaximumDelay( void ) { return inputs_.size() - 1; };
+
   //! Set the maximum delay-line length.
   /*!
     This method should generally only be used during initial setup
     of the delay line.  If it is used between calls to the tick()
     function, without a call to clear(), a signal discontinuity will
     likely occur.  If the current maximum length is greater than the
-    new length, no change will be made.
+    new length, no memory allocation change is made.
   */
   void setMaximumDelay( unsigned long delay );
 
@@ -61,7 +64,18 @@ public:
     relative to the last input value (i.e., a tapDelay of zero returns
     the last input value).
   */
-  StkFloat contentsAt( unsigned long tapDelay );
+  StkFloat tapOut( unsigned long tapDelay );
+
+  //! Set the \e value at \e tapDelay samples from the delay-line input.
+  void tapIn( StkFloat value, unsigned long tapDelay );
+
+  //! Sum the provided \e value into the delay line at \e tapDelay samples from the input.
+  /*!
+    The new value is returned.  The tap point is determined modulo
+    the delay-line length and is relative to the last input value
+    (i.e., a tapDelay of zero sums into the last input value).
+  */
+  StkFloat addTo( StkFloat value, unsigned long tapDelay );
 
   //! Return the last computed output value.
   StkFloat lastOut( void ) const { return lastFrame_[0]; };
@@ -128,7 +142,7 @@ inline StkFrames& Delay :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "Delay::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Delay::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -150,7 +164,7 @@ inline StkFrames& Delay :: tick( StkFrames& iFrames, StkFrames& oFrames, unsigne
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "Delay::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Delay::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/DelayA.h

@@ -21,7 +21,7 @@ namespace stk {
     minimum delay possible in this implementation is limited to a
     value of 0.5.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -42,6 +42,9 @@ public:
 
   //! Clears all internal states of the delay line.
   void clear( void );
+
+  //! Get the maximum delay-line length.
+  unsigned long getMaximumDelay( void ) { return inputs_.size() - 1; };
   
   //! Set the maximum delay-line length.
   /*!
@@ -49,7 +52,7 @@ public:
     of the delay line.  If it is used between calls to the tick()
     function, without a call to clear(), a signal discontinuity will
     likely occur.  If the current maximum length is greater than the
-    new length, no change will be made.
+    new length, no memory allocation change is made.
   */
   void setMaximumDelay( unsigned long delay );
 
@@ -68,7 +71,10 @@ public:
     relative to the last input value (i.e., a tapDelay of zero returns
     the last input value).
   */
-  StkFloat contentsAt( unsigned long tapDelay );
+  StkFloat tapOut( unsigned long tapDelay );
+
+  //! Set the \e value at \e tapDelay samples from the delay-line input.
+  void tapIn( StkFloat value, unsigned long tapDelay );
 
   //! Return the last computed output value.
   StkFloat lastOut( void ) const { return lastFrame_[0]; };
@@ -151,7 +157,7 @@ inline StkFrames& DelayA :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "DelayA::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "DelayA::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -175,7 +181,7 @@ inline StkFrames& DelayA :: tick( StkFrames& iFrames, StkFrames& oFrames, unsign
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "DelayA::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "DelayA::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/DelayL.h

@@ -1,7 +1,7 @@
 #ifndef STK_DELAYL_H
 #define STK_DELAYL_H
 
-#include "Delay.h"
+#include "Filter.h"
 
 namespace stk {
 
@@ -20,7 +20,7 @@ namespace stk {
     delay setting.  The use of higher order Lagrange interpolators can
     typically improve (minimize) this attenuation characteristic.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -39,13 +39,16 @@ public:
   //! Class destructor.
   ~DelayL();
 
+  //! Get the maximum delay-line length.
+  unsigned long getMaximumDelay( void ) { return inputs_.size() - 1; };
+
   //! Set the maximum delay-line length.
   /*!
     This method should generally only be used during initial setup
     of the delay line.  If it is used between calls to the tick()
     function, without a call to clear(), a signal discontinuity will
     likely occur.  If the current maximum length is greater than the
-    new length, no change will be made.
+    new length, no memory allocation change is made.
   */
   void setMaximumDelay( unsigned long delay );
 
@@ -64,7 +67,10 @@ public:
     relative to the last input value (i.e., a tapDelay of zero returns
     the last input value).
   */
-  StkFloat contentsAt( unsigned long tapDelay );
+  StkFloat tapOut( unsigned long tapDelay );
+
+  //! Set the \e value at \e tapDelay samples from the delay-line input.
+  void tapIn( StkFloat value, unsigned long tapDelay );
 
   //! Return the last computed output value.
   StkFloat lastOut( void ) const { return lastFrame_[0]; };
@@ -127,6 +133,33 @@ inline StkFloat DelayL :: nextOut( void )
   return nextOutput_;
 }
 
+inline void DelayL :: setDelay( StkFloat delay )
+{
+  if ( delay + 1 > inputs_.size() ) { // The value is too big.
+    oStream_ << "DelayL::setDelay: argument (" << delay << ") greater than  maximum!";
+    handleError( StkError::WARNING ); return;
+  }
+
+  if (delay < 0 ) {
+    oStream_ << "DelayL::setDelay: argument (" << delay << ") less than zero!";
+    handleError( StkError::WARNING ); return;
+  }
+
+  StkFloat outPointer = inPoint_ - delay;  // read chases write
+  delay_ = delay;
+
+  while ( outPointer < 0 )
+    outPointer += inputs_.size(); // modulo maximum length
+
+  outPoint_ = (long) outPointer;   // integer part
+
+  alpha_ = outPointer - outPoint_; // fractional part
+  omAlpha_ = (StkFloat) 1.0 - alpha_;
+
+  if ( outPoint_ == inputs_.size() ) outPoint_ = 0;
+  doNextOut_ = true;
+}
+
 inline StkFloat DelayL :: tick( StkFloat input )
 {
   inputs_[inPoint_++] = input * gain_;
@@ -149,7 +182,7 @@ inline StkFrames& DelayL :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "DelayL::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "DelayL::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -172,7 +205,7 @@ inline StkFrames& DelayL :: tick( StkFrames& iFrames, StkFrames& oFrames, unsign
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "DelayL::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "DelayL::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/Drummer.h

@@ -20,7 +20,7 @@ namespace stk {
     of simultaneous voices) via a #define in the
     Drummer.h.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -54,6 +54,16 @@ class Drummer : public Instrmnt
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   FileWvIn waves_[DRUM_POLYPHONY];
@@ -87,6 +97,34 @@ inline StkFloat Drummer :: tick( unsigned int )
   return lastFrame_[0];
 }
 
+inline StkFrames& Drummer :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "Drummer::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
+
 } // stk namespace
 
 #endif

include/Echo.h

@@ -12,7 +12,7 @@ namespace stk {
 
     This class implements an echo effect.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -79,7 +79,7 @@ inline StkFrames& Echo :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "Echo::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Echo::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -98,7 +98,7 @@ inline StkFrames& Echo :: tick( StkFrames& iFrames, StkFrames& oFrames, unsigned
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "Echo::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Echo::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/Effect.h

@@ -14,7 +14,7 @@ namespace stk {
     subclasses.  It is general enough to support both monophonic and
     polyphonic input/output classes.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -34,7 +34,7 @@ class Effect : public Stk
   virtual void clear() = 0;
 
   //! Set the mixture of input and "effected" levels in the output (0.0 = input only, 1.0 = effect only). 
-  void setEffectMix( StkFloat mix );
+  virtual void setEffectMix( StkFloat mix );
 
  protected:
 
@@ -49,12 +49,12 @@ class Effect : public Stk
 inline void Effect :: setEffectMix( StkFloat mix )
 {
   if ( mix < 0.0 ) {
-    errorString_ << "Effect::setEffectMix: mix parameter is less than zero ... setting to zero!";
+    oStream_ << "Effect::setEffectMix: mix parameter is less than zero ... setting to zero!";
     handleError( StkError::WARNING );
     effectMix_ = 0.0;
   }
   else if ( mix > 1.0 ) {
-    errorString_ << "Effect::setEffectMix: mix parameter is greater than 1.0 ... setting to one!";
+    oStream_ << "Effect::setEffectMix: mix parameter is greater than 1.0 ... setting to one!";
     handleError( StkError::WARNING );
     effectMix_ = 1.0;
   }

include/Envelope.h

@@ -12,9 +12,10 @@ namespace stk {
     This class implements a simple linear line envelope generator
     which is capable of ramping to an arbitrary target value by a
     specified \e rate.  It also responds to simple \e keyOn and \e
-    keyOff messages, ramping to 1.0 on keyOn and to 0.0 on keyOff.
+    keyOff messages, ramping to a specified target (default = 1.0) on
+    keyOn and to a specified target (default = 0.0) on keyOff.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -31,16 +32,23 @@ class Envelope : public Generator
   //! Assignment operator.
   Envelope& operator= ( const Envelope& e );
 
-  //! Set target = 1.
-  void keyOn( void ) { this->setTarget( 1.0 ); };
+  //! Start ramping to specified target (default = 1).
+  void keyOn( StkFloat target = 1.0 ) { this->setTarget( target ); };
 
-  //! Set target = 0.
-  void keyOff( void ) { this->setTarget( 0.0 ); };
+  //! Start ramping to specified target (default = 0).
+  void keyOff(  StkFloat target = 0.0 ) { this->setTarget( target ); };
 
   //! Set the \e rate.
+  /*!
+    The \e rate must be positive (though a value of 0.0 is allowed).
+   */
   void setRate( StkFloat rate );
 
-  //! Set the \e rate based on a time duration.
+  //! Set the \e rate based on a positive time duration (seconds).
+  /*!
+    The \e rate is calculated such that the envelope will ramp from
+    the current value to the current target in the specified time duration.
+   */
   void setTime( StkFloat time );
 
   //! Set the target value.
@@ -78,45 +86,6 @@ class Envelope : public Generator
   int state_;
 };
 
-inline void Envelope :: setRate( StkFloat rate )
-{
-#if defined(_STK_DEBUG_)
-  if ( rate < 0.0 ) {
-    errorString_ << "Envelope::setRate: negative rates not allowed ... correcting!";
-    handleError( StkError::WARNING );
-    rate_ = -rate;
-  }
-  else
-#endif
-    rate_ = rate;
-}
-
-inline void Envelope :: setTime( StkFloat time )
-{
-#if defined(_STK_DEBUG_)
-  if ( time < 0.0 ) {
-    errorString_ << "Envelope::setTime: negative times not allowed ... correcting!";
-    handleError( StkError::WARNING );
-    rate_ = 1.0 / ( -time * Stk::sampleRate() );
-  }
-  else
-#endif
-    rate_ = 1.0 / ( time * Stk::sampleRate() );
-}
-
-inline void Envelope :: setTarget( StkFloat target )
-{
-  target_ = target;
-  if ( value_ != target_ ) state_ = 1;
-}
-
-inline void Envelope :: setValue( StkFloat value )
-{
-  state_ = 0;
-  target_ = value;
-  value_ = value;
-}
-
 inline StkFloat Envelope :: tick( void )
 {
   if ( state_ ) {
@@ -144,7 +113,7 @@ inline StkFrames& Envelope :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "Envelope::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Envelope::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/FM.h

@@ -30,7 +30,7 @@ namespace stk {
     type who should worry about this (making
     money) worry away.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -46,9 +46,6 @@ class FM : public Instrmnt
   //! Class destructor.
   virtual ~FM( void );
 
-  //! Reset and clear all wave and envelope states.
-  void clear( void );
-
   //! Load the rawwave filenames in waves.
   void loadWaves( const char **filenames );
 
@@ -88,6 +85,16 @@ class FM : public Instrmnt
   //! Compute and return one output sample.
   virtual StkFloat tick( unsigned int ) = 0;
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  virtual StkFrames& tick( StkFrames& frames, unsigned int channel = 0 ) = 0;
+
  protected:
 
   std::vector<ADSR *> adsr_; 

include/FMVoices.h

@@ -33,7 +33,7 @@ namespace stk {
     type who should worry about this (making
     money) worry away.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -61,6 +61,16 @@ class FMVoices : public FM
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   int currentVowel_;
@@ -70,7 +80,7 @@ class FMVoices : public FM
 
 inline StkFloat FMVoices :: tick( unsigned int )
 {
-  register StkFloat temp, temp2;
+  StkFloat temp, temp2;
 
   temp = gains_[3] * adsr_[3]->tick() * waves_[3]->tick();
   temp2 = vibrato_.tick() * modDepth_ * 0.1;
@@ -93,6 +103,33 @@ inline StkFloat FMVoices :: tick( unsigned int )
   return lastFrame_[0];
 }
 
+inline StkFrames& FMVoices :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "FMVoices::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/FileLoop.h

@@ -19,7 +19,7 @@ namespace stk {
     the overloaded one that takes an StkFrames object for
     multi-channel and/or multi-frame data.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -31,7 +31,8 @@ class FileLoop : protected FileWvIn
 
   //! Class constructor that opens a specified file.
   FileLoop( std::string fileName, bool raw = false, bool doNormalize = true,
-            unsigned long chunkThreshold = 1000000, unsigned long chunkSize = 1024 );
+            unsigned long chunkThreshold = 1000000, unsigned long chunkSize = 1024,
+            bool doInt2FloatScaling = true );
 
   //! Class destructor.
   ~FileLoop( void );
@@ -40,13 +41,14 @@ class FileLoop : protected FileWvIn
   /*!
     Data from a previously opened file will be overwritten by this
     function.  An StkError will be thrown if the file is not found,
-    its format is unknown, or a read error occurs.  If the file data
-    is to be loaded incrementally from disk and normalization is
-    specified, a scaling will be applied with respect to fixed-point
-    limits.  If the data format is floating-point, no scaling is
-    performed.
+    its format is unknown, or a read error occurs.  If the file length
+    is less than the chunkThreshold limit and \e doNormalize is true,
+    the file data will be normalized with respect to the maximum absolute
+    value of the data. If the \e doInt2FloatScaling flag is true and the
+    input data is fixed-point, a scaling will be applied with respect to
+    the fixed-point limits.
   */
-  void openFile( std::string fileName, bool raw = false, bool doNormalize = true );
+  void openFile( std::string fileName, bool raw = false, bool doNormalize = true, bool doInt2FloatScaling = true );
 
   //! Close a file if one is open.
   void closeFile( void ) { FileWvIn::closeFile(); };
@@ -54,6 +56,9 @@ class FileLoop : protected FileWvIn
   //! Clear outputs and reset time (file) pointer to zero.
   void reset( void ) { FileWvIn::reset(); };
 
+  //! Return the number of audio channels in the data or stream.
+  unsigned int channelsOut( void ) const { return data_.channels(); };
+
   //! Normalize data to a maximum of +-1.0.
   /*!
     This function has no effect when data is incrementally loaded
@@ -69,7 +74,8 @@ class FileLoop : protected FileWvIn
   void normalize( StkFloat peak ) { FileWvIn::normalize( peak ); };
 
   //! Return the file size in sample frames.
-  unsigned long getSize( void ) const { return data_.frames(); };
+  //unsigned long getSize( void ) const { return data_.frames(); };
+  unsigned long getSize( void ) const { return fileSize_; };
 
   //! Return the input file sample rate in Hz (not the data read rate).
   /*!
@@ -92,7 +98,7 @@ class FileLoop : protected FileWvIn
     corresponds to file cycles per second.  The frequency can be
     negative, in which case the loop is read in reverse order.
   */
-  void setFrequency( StkFloat frequency ) { this->setRate( file_.fileSize() * frequency / Stk::sampleRate() ); };
+  void setFrequency( StkFloat frequency ) { this->setRate( fileSize_ * frequency / Stk::sampleRate() ); };
 
   //! Increment the read pointer by \e time samples, modulo file size.
   void addTime( StkFloat time );
@@ -137,17 +143,15 @@ class FileLoop : protected FileWvIn
   */
   StkFloat tick( unsigned int channel = 0 );
 
-  //! Fill the StkFrames argument with computed frames and return the same reference.
+  //! Fill the StkFrames object with computed sample frames, starting at the specified channel and return the same reference.
   /*!
-    The number of channels in the StkFrames argument should equal
-    the number of channels in the file data.  However, this is only
-    checked if _STK_DEBUG_ is defined during compilation, in which
-    case an incompatibility will trigger an StkError exception.  If no
-    file data is loaded, the function does nothing (a warning will be
-    issued if _STK_DEBUG_ is defined during compilation and
-    Stk::showWarnings() has been set to \e true).
+    The \c channel argument plus the number of output channels must
+    be less than the number of channels in the StkFrames argument (the
+    first channel is specified by 0).  However, range checking is only
+    performed if _STK_DEBUG_ is defined during compilation, in which
+    case an out-of-range value will trigger an StkError exception.
   */
-  StkFrames& tick( StkFrames& frames );
+  virtual StkFrames& tick( StkFrames& frames,unsigned int channel = 0 );
 
  protected:
 

include/FileRead.h

@@ -20,19 +20,21 @@ namespace stk {
     FileRead currently supports uncompressed WAV,
     AIFF/AIFC, SND (AU), MAT-file (Matlab), and
     STK RAW file formats.  Signed integer (8-,
-    16-, and 32-bit) and floating-point (32- and
+    16-, 24-, and 32-bit) and floating-point (32- and
     64-bit) data types are supported.  Compressed
     data types are not supported.
 
-    STK RAW files have no header and are assumed
-    to contain a monophonic stream of 16-bit
-    signed integers in big-endian byte order at a
-    sample rate of 22050 Hz.  MAT-file data should
-    be saved in an array with each data channel
-    filling a matrix row.  The sample rate for
-    MAT-files is assumed to be 44100 Hz.
+    STK RAW files have no header and are assumed to
+    contain a monophonic stream of 16-bit signed
+    integers in big-endian byte order at a sample
+    rate of 22050 Hz.  MAT-file data should be saved
+    in an array with each data channel filling a
+    matrix row.  The sample rate for MAT-files should
+    be specified in a variable named "fs".  If no
+    such variable is found, the sample rate is
+    assumed to be 44100 Hz.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -77,6 +79,9 @@ public:
   //! Return the number of audio channels in the file.
   unsigned int channels( void ) const { return channels_; };
 
+  //! Return the data format of the file.
+  StkFormat format( void ) const { return dataType_; };
+
   //! Return the file sample rate in Hz.
   /*!
     WAV, SND, and AIF formatted files specify a sample rate in
@@ -118,6 +123,9 @@ protected:
   // Get MAT-file header information.
   bool getMatInfo( const char *fileName );
 
+  // Helper function for MAT-file parsing.
+  bool findNextMatArray( SINT32 *chunkSize, SINT32 *rows, SINT32 *columns, SINT32 *nametype );
+
   FILE *fd_;
   bool byteswap_;
   bool wavFile_;

include/FileWrite.h

@@ -17,14 +17,14 @@ namespace stk {
 
     FileWrite currently supports uncompressed WAV, AIFF, AIFC, SND
     (AU), MAT-file (Matlab), and STK RAW file formats.  Signed integer
-    (8-, 16-, and 32-bit) and floating- point (32- and 64-bit) data
-    types are supported.  STK RAW files use 16-bit integers by
+    (8-, 16-, 24-, and 32-bit) and floating- point (32- and 64-bit)
+    data types are supported.  STK RAW files use 16-bit integers by
     definition.  MAT-files will always be written as 64-bit floats.
     If a data type specification does not match the specified file
     type, the data type will automatically be modified.  Compressed
     data types are not supported.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -76,28 +76,28 @@ class FileWrite : public Stk
  protected:
 
   // Write STK RAW file header.
-  bool setRawFile( const char *fileName );
+  bool setRawFile( std::string fileName );
 
   // Write WAV file header.
-  bool setWavFile( const char *fileName );
+  bool setWavFile( std::string fileName );
 
   // Close WAV file, updating the header.
   void closeWavFile( void );
 
   // Write SND (AU) file header.
-  bool setSndFile( const char *fileName );
+  bool setSndFile( std::string fileName );
 
   // Close SND file, updating the header.
   void closeSndFile( void );
 
   // Write AIFF file header.
-  bool setAifFile( const char *fileName );
+  bool setAifFile( std::string fileName );
 
   // Close AIFF file, updating the header.
   void closeAifFile( void );
 
   // Write MAT-file header.
-  bool setMatFile( const char *fileName );
+  bool setMatFile( std::string fileName );
 
   // Close MAT-file, updating the header.
   void closeMatFile( void );

include/FileWvIn.h

@@ -29,13 +29,23 @@ namespace stk {
     chunkThreshold (in sample frames) will be read incrementally in
     chunks of \e chunkSize each (also in sample frames).
 
+    For file data read completely into local memory, the \e doNormalize
+    flag can be used to normalize all values with respect to the maximum
+    absolute value of the data.
+
+    If the file data format is fixed point, the flag \e doInt2FloatScaling
+    can be used to control whether the values are scaled with respect to
+    the corresponding fixed-point maximum. For example, if reading 16-bit
+    signed integers, the input values will be scaled by 1 / 32768.0. This
+    scaling will not happen for floating-point file data formats.
+
     When the file end is reached, subsequent calls to the tick()
     functions return zeros and isFinished() returns \e true.
 
     See the FileRead class for a description of the supported audio
     file formats.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -51,7 +61,8 @@ public:
     unknown, or a read error occurs.
   */
   FileWvIn( std::string fileName, bool raw = false, bool doNormalize = true,
-            unsigned long chunkThreshold = 1000000, unsigned long chunkSize = 1024 );
+            unsigned long chunkThreshold = 1000000, unsigned long chunkSize = 1024,
+            bool doInt2FloatScaling = true );
 
   //! Class destructor.
   ~FileWvIn( void );
@@ -60,13 +71,14 @@ public:
   /*!
     Data from a previously opened file will be overwritten by this
     function.  An StkError will be thrown if the file is not found,
-    its format is unknown, or a read error occurs.  If the file data
-    is to be loaded incrementally from disk and normalization is
-    specified, a scaling will be applied with respect to fixed-point
-    limits.  If the data format is floating-point, no scaling is
-    performed.
+    its format is unknown, or a read error occurs.  If the file length
+    is less than the chunkThreshold limit and \e doNormalize is true,
+    the file data will be normalized with respect to the maximum absolute
+    value of the data. If the \e doInt2FloatScaling flag is true and the
+    input data is fixed-point, a scaling will be applied with respect to
+    the fixed-point limits.
   */
-  virtual void openFile( std::string fileName, bool raw = false, bool doNormalize = true );
+  virtual void openFile( std::string fileName, bool raw = false, bool doNormalize = true, bool doInt2FloatScaling = true );
 
   //! Close a file if one is open.
   virtual void closeFile( void );
@@ -89,7 +101,7 @@ public:
   virtual void normalize( StkFloat peak );
 
   //! Return the file size in sample frames.
-  virtual unsigned long getSize( void ) const { return data_.frames(); };
+  virtual unsigned long getSize( void ) const { return fileSize_; };
 
   //! Return the input file sample rate in Hz (not the data read rate).
   /*!
@@ -99,6 +111,9 @@ public:
   */
   virtual StkFloat getFileRate( void ) const { return data_.dataRate(); };
 
+  //! Query whether a file is open.
+  bool isOpen( void ) { return file_.isOpen(); };
+
   //! Query whether reading is complete.
   bool isFinished( void ) const { return finished_; };
 
@@ -147,16 +162,15 @@ public:
   */
   virtual StkFloat tick( unsigned int channel = 0 );
 
-  //! Fill the StkFrames argument with computed frames and return the same reference.
+  //! Fill the StkFrames object with computed sample frames, starting at the specified channel and return the same reference.
   /*!
-    The number of channels in the StkFrames argument must equal
-    the number of channels in the file data.  However, this is only
-    checked if _STK_DEBUG_ is defined during compilation, in which
-    case an incompatibility will trigger an StkError exception.  If no
-    file data is loaded, the function does nothing (a warning will be
-    issued if _STK_DEBUG_ is defined during compilation).
+    The \c channel argument plus the number of input channels must
+    be less than the number of channels in the StkFrames argument (the
+    first channel is specified by 0).  However, range checking is only
+    performed if _STK_DEBUG_ is defined during compilation, in which
+    case an out-of-range value will trigger an StkError exception.
   */
-  virtual StkFrames& tick( StkFrames& frames );
+  virtual StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
 
 protected:
 
@@ -165,10 +179,11 @@ protected:
   FileRead file_;
   bool finished_;
   bool interpolate_;
-  bool normalizing_;
+  bool int2floatscaling_;
   bool chunking_;
   StkFloat time_;
   StkFloat rate_;
+  unsigned long fileSize_;
   unsigned long chunkThreshold_;
   unsigned long chunkSize_;
   long chunkPointer_;
@@ -179,7 +194,7 @@ inline StkFloat FileWvIn :: lastOut( unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= data_.channels() ) {
-    errorString_ << "FileWvIn::lastOut(): channel argument and soundfile data are incompatible!";
+    oStream_ << "FileWvIn::lastOut(): channel argument and soundfile data are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/FileWvOut.h

@@ -25,7 +25,7 @@ namespace stk {
     Currently, FileWvOut is non-interpolating and the output rate is
     always Stk::sampleRate().
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

include/Filter.h

@@ -3,6 +3,7 @@
 
 #include "Stk.h"
 #include <vector>
+#include <cmath>
 
 namespace stk {
 
@@ -14,7 +15,7 @@ namespace stk {
     filter subclasses.  It is general enough to support both
     monophonic and polyphonic input/output classes.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -43,6 +44,14 @@ public:
   //! Return the current filter gain.
   StkFloat getGain( void ) const { return gain_; };
 
+  //! Return the filter phase delay at the specified frequency.
+  /*!
+    Note that the phase delay calculation accounts for the filter
+    gain.  The frequency value should be greater than 0.0 and less
+    than or equal to one-half the sample rate.
+   */
+  StkFloat phaseDelay( StkFloat frequency );
+
   //! Return an StkFrames reference to the last output sample frame.
   const StkFrames& lastFrame( void ) const { return lastFrame_; };
 
@@ -59,10 +68,10 @@ public:
 
 protected:
 
+  StkFloat gain_;
   unsigned int channelsIn_;
   StkFrames lastFrame_;
 
-  StkFloat gain_;
   std::vector<StkFloat> b_;
   std::vector<StkFloat> a_;
   StkFrames outputs_;
@@ -81,6 +90,35 @@ inline void Filter :: clear( void )
     lastFrame_[i] = 0.0;  
 }
 
+inline StkFloat Filter :: phaseDelay( StkFloat frequency )
+{
+  if ( frequency <= 0.0 || frequency > 0.5 * Stk::sampleRate() ) {
+    oStream_ << "Filter::phaseDelay: argument (" << frequency << ") is out of range!";
+    handleError( StkError::WARNING ); return 0.0;
+  }
+
+  StkFloat omegaT = 2 * PI * frequency / Stk::sampleRate();
+  StkFloat real = 0.0, imag = 0.0;
+  for ( unsigned int i=0; i<b_.size(); i++ ) {
+    real += b_[i] * std::cos( i * omegaT );
+    imag -= b_[i] * std::sin( i * omegaT );
+  }
+  real *= gain_;
+  imag *= gain_;
+
+  StkFloat phase = atan2( imag, real );
+
+  real = 0.0, imag = 0.0;
+  for ( unsigned int i=0; i<a_.size(); i++ ) {
+    real += a_[i] * std::cos( i * omegaT );
+    imag -= a_[i] * std::sin( i * omegaT );
+  }
+
+  phase -= std::atan2( imag, real );
+  phase = std::fmod( -phase, 2 * PI );
+  return phase / omegaT;
+}
+
 } // stk namespace
 
 #endif

include/Fir.h

@@ -23,7 +23,7 @@ namespace stk {
     This structure results in one extra multiply per computed sample,
     but allows easy control of the overall filter gain.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -88,7 +88,7 @@ inline StkFloat Fir :: tick( StkFloat input )
   lastFrame_[0] = 0.0;
   inputs_[0] = gain_ * input;
 
-  for ( unsigned int i=b_.size()-1; i>0; i-- ) {
+  for ( unsigned int i=(unsigned int)(b_.size())-1; i>0; i-- ) {
     lastFrame_[0] += b_[i] * inputs_[i];
     inputs_[i] = inputs_[i-1];
   }
@@ -101,7 +101,7 @@ inline StkFrames& Fir :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "Fir::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Fir::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -112,7 +112,7 @@ inline StkFrames& Fir :: tick( StkFrames& frames, unsigned int channel )
     inputs_[0] = gain_ * *samples;
     *samples = 0.0;
 
-    for ( i=b_.size()-1; i>0; i-- ) {
+    for ( i=(unsigned int)b_.size()-1; i>0; i-- ) {
       *samples += b_[i] * inputs_[i];
       inputs_[i] = inputs_[i-1];
     }
@@ -127,7 +127,7 @@ inline StkFrames& Fir :: tick( StkFrames& iFrames, StkFrames& oFrames, unsigned
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "Fir::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Fir::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -139,7 +139,7 @@ inline StkFrames& Fir :: tick( StkFrames& iFrames, StkFrames& oFrames, unsigned
     inputs_[0] = gain_ * *iSamples;
     *oSamples = 0.0;
 
-    for ( i=b_.size()-1; i>0; i-- ) {
+    for ( i=(unsigned int)b_.size()-1; i>0; i-- ) {
       *oSamples += b_[i] * inputs_[i];
       inputs_[i] = inputs_[i-1];
     }

include/Flute.h

@@ -32,7 +32,7 @@ namespace stk {
        - Vibrato Gain = 1
        - Breath Pressure = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -55,10 +55,10 @@ class Flute : public Instrmnt
   void setFrequency( StkFloat frequency );
 
   //! Set the reflection coefficient for the jet delay (-1.0 - 1.0).
-  void setJetReflection( StkFloat coefficient );
+  void setJetReflection( StkFloat coefficient ) { jetReflection_ = coefficient; };
 
   //! Set the reflection coefficient for the air column delay (-1.0 - 1.0).
-  void setEndReflection( StkFloat coefficient );
+  void setEndReflection( StkFloat coefficient ) { endReflection_ = coefficient; };
 
   //! Set the length of the jet delay in terms of a ratio of jet delay to air column delay lengths.
   void setJetDelay( StkFloat aRatio );
@@ -81,6 +81,16 @@ class Flute : public Instrmnt
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
   DelayL   jetDelay_;
@@ -91,7 +101,7 @@ class Flute : public Instrmnt
   Noise    noise_;
   ADSR     adsr_;
   SineWave vibrato_;
-  unsigned long length_;
+
   StkFloat lastFrequency_;
   StkFloat maxPressure_;
   StkFloat jetReflection_;
@@ -112,18 +122,46 @@ inline StkFloat Flute :: tick( unsigned int )
   breathPressure = maxPressure_ * adsr_.tick();
   breathPressure += breathPressure * ( noiseGain_ * noise_.tick() + vibratoGain_ * vibrato_.tick() );
 
-  StkFloat temp = filter_.tick( boreDelay_.lastOut() );
-  temp = dcBlock_.tick( temp ); // Block DC on reflection.
+  StkFloat temp = -filter_.tick( boreDelay_.lastOut() );
+  //temp = dcBlock_.tick( temp ); // Block DC on reflection.
 
   pressureDiff = breathPressure - (jetReflection_ * temp);
   pressureDiff = jetDelay_.tick( pressureDiff );
-  pressureDiff = jetTable_.tick( pressureDiff ) + (endReflection_ * temp);
+  //pressureDiff = jetTable_.tick( pressureDiff ) + (endReflection_ * temp);
+  pressureDiff = dcBlock_.tick(jetTable_.tick( pressureDiff )) + (endReflection_ * temp); // moved the DC blocker to after the jet non-linearity (GPS, 29 Jan. 2020)
   lastFrame_[0] = (StkFloat) 0.3 * boreDelay_.tick( pressureDiff );
 
   lastFrame_[0] *= outputGain_;
   return lastFrame_[0];
 }
 
+inline StkFrames& Flute :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "Flute::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/FormSwep.h

@@ -13,7 +13,7 @@ namespace stk {
     over time from one frequency setting to another.  It provides
     methods for controlling the sweep rate and target frequency.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -35,12 +35,14 @@ class FormSwep : public Filter
     This method determines the filter coefficients corresponding to
     two complex-conjugate poles with the given \e frequency (in Hz)
     and \e radius from the z-plane origin.  The filter zeros are
-    placed at z = 1, z = -1, and the coefficients are then normalized to
-    produce a constant unity gain (independent of the filter \e gain
-    parameter).  The resulting filter frequency response has a
+    placed at z = 1, z = -1, and the coefficients are then normalized
+    to produce a constant unity gain (independent of the filter \e
+    gain parameter).  The resulting filter frequency response has a
     resonance at the given \e frequency.  The closer the poles are to
     the unit-circle (\e radius close to one), the narrower the
-    resulting resonance width.
+    resulting resonance width.  An unstable filter will result for \e
+    radius >= 1.0.  The \e frequency value should be between zero and
+    half the sample rate.
   */
   void setResonance( StkFloat frequency, StkFloat radius );
 
@@ -152,7 +154,7 @@ inline StkFrames& FormSwep :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "FormSwep::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "FormSwep::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -169,7 +171,7 @@ inline StkFrames& FormSwep :: tick( StkFrames& iFrames, StkFrames& oFrames, unsi
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "FormSwep::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "FormSwep::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/FreeVerb.h

@@ -0,0 +1,251 @@
+#ifndef STK_FREEVERB_H
+#define STK_FREEVERB_H
+
+#include "Effect.h"
+#include "Delay.h"
+#include "OnePole.h"
+
+namespace stk {
+
+/***********************************************************************/
+/*! \class FreeVerb
+    \brief Jezar at Dreampoint's FreeVerb, implemented in STK.
+
+    Freeverb is a free and open-source Schroeder reverberator
+    originally implemented in C++. The parameters of the reverberation
+    model are exceptionally well tuned. FreeVerb uses 8
+    lowpass-feedback-comb-filters in parallel, followed by 4 Schroeder
+    allpass filters in series.  The input signal can be either mono or
+    stereo, and the output signal is stereo.  The delay lengths are
+    optimized for a sample rate of 44100 Hz.
+
+    Ported to STK by Gregory Burlet, 2012.
+*/
+/***********************************************************************/
+
+class FreeVerb : public Effect
+{   
+ public:
+  //! FreeVerb Constructor
+  /*!
+    Initializes the effect with default parameters. Note that these defaults
+    are slightly different than those in the original implementation of
+    FreeVerb [Effect Mix: 0.75; Room Size: 0.75; Damping: 0.25; Width: 1.0;
+    Mode: freeze mode off].
+  */
+  FreeVerb();
+
+  //! Destructor
+  ~FreeVerb();
+
+  //! Set the effect mix [0 = mostly dry, 1 = mostly wet].
+  void setEffectMix( StkFloat mix );
+
+  //! Set the room size (comb filter feedback gain) parameter [0,1].
+  void setRoomSize( StkFloat value );
+
+  //! Get the room size (comb filter feedback gain) parameter.
+  StkFloat getRoomSize( void );
+
+  //! Set the damping parameter [0=low damping, 1=higher damping].
+  void setDamping( StkFloat value );
+
+  //! Get the damping parameter.
+  StkFloat getDamping( void );
+
+  //! Set the width (left-right mixing) parameter [0,1].
+  void setWidth( StkFloat value );
+
+  //! Get the width (left-right mixing) parameter.
+  StkFloat getWidth( void );
+
+  //! Set the mode [frozen = 1, unfrozen = 0].
+  void setMode( bool isFrozen );
+
+  //! Get the current freeze mode [frozen = 1, unfrozen = 0].
+  StkFloat getMode( void );
+
+  //! Clears delay lines, etc.
+  void clear( void );
+
+  //! Return the specified channel value of the last computed stereo frame.
+  /*!
+    Use the lastFrame() function to get both values of the last
+    computed stereo frame.  The \c channel argument must be 0 or 1
+    (the first channel is specified by 0).  However, range checking is
+    only performed if _STK_DEBUG_ is defined during compilation, in
+    which case an out-of-range value will trigger an StkError
+    exception.
+  */
+  StkFloat lastOut( unsigned int channel = 0 );
+
+  //! Input one or two samples to the effect and return the specified \c channel value of the computed stereo frame.
+  /*!
+    Use the lastFrame() function to get both values of the computed
+    stereo output frame. The \c channel argument must be 0 or 1 (the
+    first channel is specified by 0).  However, range checking is only
+    performed if _STK_DEBUG_ is defined during compilation, in which
+    case an out-of-range value will trigger an StkError exception.
+  */
+  StkFloat tick( StkFloat inputL, StkFloat inputR = 0.0, unsigned int channel = 0 );
+
+  //! Take two channels of the StkFrames object as inputs to the effect and replace with stereo outputs.
+  /*!
+    The StkFrames argument reference is returned.  The stereo
+    inputs are taken from (and written back to) the StkFrames argument
+    starting at the specified \c channel.  Therefore, the \c channel
+    argument must be less than ( channels() - 1 ) of the StkFrames
+    argument (the first channel is specified by 0).  However, range
+    checking is only performed if _STK_DEBUG_ is defined during
+    compilation, in which case an out-of-range value will trigger an
+    StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
+  //! Take one or two channels of the \c iFrames object as inputs to the effect and write stereo outputs to the \c oFrames object.
+  /*!
+    The \c iFrames object reference is returned.  The \c iChannel
+    argument must be less than the number of channels in the \c
+    iFrames argument (the first channel is specified by 0).  If more
+    than one channel of data exists in \c iFrames starting from \c
+    iChannel, stereo data is input to the effect.  The \c oChannel
+    argument must be less than ( channels() - 1 ) of the \c oFrames
+    argument.  However, range checking is only performed if
+    _STK_DEBUG_ is defined during compilation, in which case an
+    out-of-range value will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& iFrames, StkFrames &oFrames, unsigned int iChannel = 0, unsigned int oChannel = 0 );
+
+ protected:
+  //! Update interdependent parameters.
+  void update( void );
+
+  // Clamp very small floats to zero, version from
+  // http://music.columbia.edu/pipermail/linux-audio-user/2004-July/013489.html .
+  // However, this is for 32-bit floats only.
+  //static inline StkFloat undenormalize( volatile StkFloat s ) { 
+  //  s += 9.8607615E-32f; 
+  //  return s - 9.8607615E-32f; 
+  //}
+    
+  static const int nCombs = 8;
+  static const int nAllpasses = 4;
+  static const int stereoSpread = 23;
+  static const StkFloat fixedGain;
+  static const StkFloat scaleWet;
+  static const StkFloat scaleDry;
+  static const StkFloat scaleDamp;
+  static const StkFloat scaleRoom;
+  static const StkFloat offsetRoom;
+
+  // Delay line lengths for 44100Hz sampling rate.
+  static int cDelayLengths[nCombs];
+  static int aDelayLengths[nAllpasses];
+
+  StkFloat g_;        // allpass coefficient
+  StkFloat gain_;
+  StkFloat roomSizeMem_, roomSize_;
+  StkFloat dampMem_, damp_;
+  StkFloat wet1_, wet2_;
+  StkFloat dry_;
+  StkFloat width_;
+  bool frozenMode_;
+
+  // LBFC: Lowpass Feedback Comb Filters
+  Delay combDelayL_[nCombs];
+  Delay combDelayR_[nCombs];
+  OnePole combLPL_[nCombs];
+  OnePole combLPR_[nCombs];
+        
+  // AP: Allpass Filters
+  Delay allPassDelayL_[nAllpasses];
+  Delay allPassDelayR_[nAllpasses];
+};
+
+inline StkFloat FreeVerb :: lastOut( unsigned int channel )
+{
+#if defined(_STK_DEBUG_)
+  if ( channel > 1 ) {
+    oStream_ << "FreeVerb::lastOut(): channel argument must be less than 2!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  return lastFrame_[channel];
+}
+
+inline StkFloat FreeVerb::tick( StkFloat inputL, StkFloat inputR, unsigned int channel )
+{
+#if defined(_STK_DEBUG_)
+  if ( channel > 1 ) {
+    oStream_ << "FreeVerb::tick(): channel argument must be less than 2!";
+    handleError(StkError::FUNCTION_ARGUMENT);
+  }
+#endif
+
+  StkFloat fInput = (inputL + inputR) * gain_;
+  StkFloat outL = 0.0;
+  StkFloat outR = 0.0;
+
+  // Parallel LBCF filters
+  for ( int i = 0; i < nCombs; i++ ) {
+    // Left channel
+    //StkFloat yn = fInput + (roomSize_ * FreeVerb::undenormalize(combLPL_[i].tick(FreeVerb::undenormalize(combDelayL_[i].nextOut()))));
+    StkFloat yn = fInput + (roomSize_ * combLPL_[i].tick( combDelayL_[i].nextOut() ) );
+    combDelayL_[i].tick(yn);
+    outL += yn;
+
+    // Right channel
+    //yn = fInput + (roomSize_ * FreeVerb::undenormalize(combLPR_[i].tick(FreeVerb::undenormalize(combDelayR_[i].nextOut()))));
+    yn = fInput + (roomSize_ * combLPR_[i].tick( combDelayR_[i].nextOut() ) );
+    combDelayR_[i].tick(yn);
+    outR += yn;
+  }
+
+  // Series allpass filters
+  for ( int i = 0; i < nAllpasses; i++ ) {
+    // Left channel
+    //StkFloat vn_m = FreeVerb::undenormalize(allPassDelayL_[i].nextOut());
+    StkFloat vn_m = allPassDelayL_[i].nextOut();
+    StkFloat vn = outL + (g_ * vn_m);
+    allPassDelayL_[i].tick(vn);
+        
+    // calculate output
+    outL = -vn + (1.0 + g_)*vn_m;
+
+    // Right channel
+    //vn_m = FreeVerb::undenormalize(allPassDelayR_[i].nextOut());
+    vn_m = allPassDelayR_[i].nextOut();
+    vn = outR + (g_ * vn_m);
+    allPassDelayR_[i].tick(vn);
+
+    // calculate output
+    outR = -vn + (1.0 + g_)*vn_m;
+  }
+
+  // Mix output
+  lastFrame_[0] = outL*wet1_ + outR*wet2_ + inputL*dry_;
+  lastFrame_[1] = outR*wet1_ + outL*wet2_ + inputR*dry_;
+
+  /*
+  // Hard limiter ... there's not much else we can do at this point
+  if ( lastFrame_[0] >= 1.0 ) {
+    lastFrame_[0] = 0.9999;
+  }
+  if ( lastFrame_[0] <= -1.0 ) {
+    lastFrame_[0] = -0.9999;
+  }
+  if ( lastFrame_[1] >= 1.0 ) {
+    lastFrame_[1] = 0.9999;
+  }
+  if ( lastFrame_[1] <= -1.0 ) {
+    lastFrame_[1] = -0.9999;
+  }
+  */
+
+  return lastFrame_[channel];
+}
+
+}
+
+#endif

include/Function.h

@@ -13,7 +13,7 @@ namespace stk {
     implement tables or other types of input to output function
     mappings.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

include/Generator.h

@@ -13,7 +13,7 @@ namespace stk {
     generator sample-source subclasses.  It is general enough to
     support both monophonic and polyphonic output classes.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

include/Granulate.h

@@ -21,7 +21,7 @@ namespace stk {
     Chris Rolfe and Damian Keller, though there are likely to be a
     number of differences in the actual implementation.
 
-    by Gary Scavone, 2005 - 2009.
+    by Gary Scavone, 2005--2023.
 */
 /***************************************************/
 
@@ -139,7 +139,8 @@ class Granulate: public Generator
     unsigned long decayCount;
     unsigned long delayCount;
     unsigned long counter;
-    unsigned long pointer;
+    //unsigned long pointer;
+    StkFloat pointer;
     unsigned long startPointer;
     unsigned int repeats;
     GrainState state;
@@ -155,7 +156,8 @@ class Granulate: public Generator
   StkFrames data_;
   std::vector<Grain> grains_;
   Noise noise;
-  long gPointer_;
+  //long gPointer_;
+  StkFloat gPointer_;
 
   // Global grain parameters.
   unsigned int gDuration_;
@@ -173,7 +175,7 @@ inline StkFloat Granulate :: lastOut( unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= lastFrame_.channels() ) {
-    errorString_ << "Granulate::lastOut(): channel argument is invalid!";
+    oStream_ << "Granulate::lastOut(): channel argument is invalid!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -186,7 +188,7 @@ inline StkFrames& Granulate :: tick( StkFrames& frames, unsigned int channel )
   unsigned int nChannels = lastFrame_.channels();
 #if defined(_STK_DEBUG_)
   if ( channel > frames.channels() - nChannels ) {
-    errorString_ << "Granulate::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Granulate::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/Guitar.h

@@ -0,0 +1,202 @@
+#ifndef STK_GUITAR_H
+#define STK_GUITAR_H
+
+#include "Stk.h"
+#include "Twang.h"
+#include "OnePole.h"
+#include "OneZero.h"
+
+namespace stk {
+
+/***************************************************/
+/*! \class Guitar
+    \brief STK guitar model class.
+
+    This class implements a guitar model with an arbitrary number of
+    strings (specified during instantiation).  Each string is
+    represented by an stk::Twang object.  The model supports commuted
+    synthesis, as discussed by Smith and Karjalainen.  It also includes
+    a basic body coupling model and supports feedback.
+
+    This class does not attempt voice management.  Rather, most
+    functions support a parameter to specify a particular string
+    number and string (voice) management is assumed to occur
+    externally.  Note that this class does not inherit from
+    stk::Instrmnt because of API inconsistencies.
+
+    This is a digital waveguide model, making its use possibly subject
+    to patents held by Stanford University, Yamaha, and others.
+
+    Control Change Numbers: 
+       - Bridge Coupling Gain = 2
+       - Pluck Position = 4
+       - Loop Gain = 11
+       - Coupling Filter Pole = 1
+       - Pick Filter Pole = 128
+
+    by Gary P. Scavone, 2012.
+*/
+/***************************************************/
+
+class Guitar : public Stk
+{
+ public:
+  //! Class constructor, specifying an arbitrary number of strings (default = 6).
+  Guitar( unsigned int nStrings = 6, std::string bodyfile = "" );
+
+  //! Reset and clear all internal state.
+  void clear( void );
+
+  //! Set the string excitation, using either a soundfile or computed noise.
+  /*!
+     If no argument is provided, the std::string is empty, or an error
+     occurs reading the file data, an enveloped noise signal will be
+     generated for use as the pluck excitation.
+   */
+  void setBodyFile( std::string bodyfile = "" );
+
+  //! Set the pluck position for one or all strings.
+  /*!
+     If the \c string argument is < 0, the pluck position is set
+     for all strings.
+  */
+  void setPluckPosition( StkFloat position, int string = -1 );
+
+  //! Set the loop gain for one or all strings.
+  /*!
+     If the \c string argument is < 0, the loop gain is set for all
+     strings.
+  */
+  void setLoopGain( StkFloat gain, int string = -1 );
+
+  //! Set instrument parameters for a particular frequency.
+  void setFrequency( StkFloat frequency, unsigned int string = 0 );
+
+  //! Start a note with the given frequency and amplitude.
+  /*!
+     If the \c amplitude parameter is less than 0.2, the string will
+     be undamped but it will not be "plucked."
+   */
+  void noteOn( StkFloat frequency, StkFloat amplitude, unsigned int string = 0 );
+
+  //! Stop a note with the given amplitude (speed of decay).
+  void noteOff( StkFloat amplitude, unsigned int string = 0 );
+
+  //! Perform the control change specified by \e number and \e value (0.0 - 128.0).
+  /*!
+     If the \c string argument is < 0, then the control change is
+     applied to all strings (if appropriate).
+  */
+  void controlChange( int number, StkFloat value, int string = -1 );
+
+  //! Return the last computed output value.
+  StkFloat lastOut( void ) { return lastFrame_[0]; };
+
+  //! Take an optional input sample and compute one output sample.
+  StkFloat tick( StkFloat input = 0.0 );
+
+  //! Take a channel of the \c iFrames object as inputs to the class and write outputs to the \c oFrames object.
+  /*!
+    The \c iFrames object reference is returned.  Each channel
+    argument must be less than the number of channels in the
+    corresponding StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
+  //! Take a channel of the \c iFrames object as inputs to the effect and write outputs to the \c oFrames object.
+  /*!
+    The \c iFrames object reference is returned.  Each channel
+    argument must be less than the number of channels in the
+    corresponding StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& iFrames, StkFrames &oFrames, unsigned int iChannel = 0, unsigned int oChannel = 0 );
+
+ protected:
+
+  std::vector< stk::Twang > strings_;
+  std::vector< int > stringState_; // 0 = off, 1 = decaying, 2 = on
+  std::vector< unsigned int > decayCounter_;
+  std::vector< unsigned int > filePointer_;
+  std::vector< StkFloat > pluckGains_;
+
+  OnePole   pickFilter_;
+  OnePole   couplingFilter_;
+  StkFloat  couplingGain_;
+  StkFrames excitation_;
+  StkFrames lastFrame_;
+};
+
+// NOTE: It is not possible to implement the Smith coupled string model here because the Twang class does
+// not currently offer the chance to have access to a traveling-wave component. Thus, the coupling
+// implemented here is approximate.
+inline StkFloat Guitar :: tick( StkFloat input )
+{
+  StkFloat temp, output = 0.0;
+  lastFrame_[0] = couplingGain_ * couplingFilter_.tick( lastFrame_[0] ) / strings_.size();
+  for ( unsigned int i=0; i<strings_.size(); i++ ) {
+    if ( stringState_[i] ) {
+      temp = input;
+      // If pluckGain < 0.2, let string ring but don't pluck it.
+      if ( filePointer_[i] < excitation_.frames() && pluckGains_[i] > 0.2 )
+        temp += pluckGains_[i] * excitation_[filePointer_[i]++];
+      temp += lastFrame_[0]; // bridge coupling
+      output += strings_[i].tick( temp );
+      // Check if string energy has decayed sufficiently to turn it off.
+      if ( stringState_[i] == 1 ) {
+        if ( fabs( strings_[i].lastOut() ) < 0.001 ) decayCounter_[i]++;
+        else decayCounter_[i] = 0;
+        if ( decayCounter_[i] > (unsigned int) floor( 0.1 * Stk::sampleRate() ) ) {
+          stringState_[i] = 0;
+          decayCounter_[i] = 0;
+        }
+      }
+    }
+  }
+
+  return lastFrame_[0] = output;
+}
+
+inline StkFrames& Guitar :: tick( StkFrames& frames, unsigned int channel )
+{
+#if defined(_STK_DEBUG_)
+  if ( channel >= frames.channels() ) {
+    oStream_ << "Guitar::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int hop = frames.channels();
+  for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+    *samples = tick( *samples );
+
+  return frames;
+}
+
+inline StkFrames& Guitar :: tick( StkFrames& iFrames, StkFrames& oFrames, unsigned int iChannel, unsigned int oChannel )
+{
+#if defined(_STK_DEBUG_)
+  if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
+    oStream_ << "Guitar::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *iSamples = &iFrames[iChannel];
+  StkFloat *oSamples = &oFrames[oChannel];
+  unsigned int iHop = iFrames.channels(), oHop = oFrames.channels();
+  for ( unsigned int i=0; i<iFrames.frames(); i++, iSamples += iHop, oSamples += oHop )
+    *oSamples = tick( *iSamples );
+
+  return iFrames;
+}
+
+} // stk namespace
+
+#endif

include/HevyMetl.h

@@ -31,7 +31,7 @@ namespace stk {
     type who should worry about this (making
     money) worry away.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -53,13 +53,23 @@ class HevyMetl : public FM
   //! Compute and return one output sample.
   StkFloat tick( unsigned int channel = 0 );
 
+  //! Fill a channel of the StkFrames object with computed outputs.
+  /*!
+    The \c channel argument must be less than the number of
+    channels in the StkFrames argument (the first channel is specified
+    by 0).  However, range checking is only performed if _STK_DEBUG_
+    is defined during compilation, in which case an out-of-range value
+    will trigger an StkError exception.
+  */
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+
  protected:
 
 };
 
 inline StkFloat HevyMetl :: tick( unsigned int )
 {
-  register StkFloat temp;
+  StkFloat temp;
 
   temp = vibrato_.tick() * modDepth_ * 0.2;    
   waves_[0]->setFrequency(baseFrequency_ * (1.0 + temp) * ratios_[0]);
@@ -84,6 +94,33 @@ inline StkFloat HevyMetl :: tick( unsigned int )
   return lastFrame_[0];
 }
 
+inline StkFrames& HevyMetl :: tick( StkFrames& frames, unsigned int channel )
+{
+  unsigned int nChannels = lastFrame_.channels();
+#if defined(_STK_DEBUG_)
+  if ( channel > frames.channels() - nChannels ) {
+    oStream_ << "HevyMetl::tick(): channel and StkFrames arguments are incompatible!";
+    handleError( StkError::FUNCTION_ARGUMENT );
+  }
+#endif
+
+  StkFloat *samples = &frames[channel];
+  unsigned int j, hop = frames.channels() - nChannels;
+  if ( nChannels == 1 ) {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
+      *samples++ = tick();
+  }
+  else {
+    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
+      *samples++ = tick();
+      for ( j=1; j<nChannels; j++ )
+        *samples++ = lastFrame_[j];
+    }
+  }
+
+  return frames;
+}
+
 } // stk namespace
 
 #endif

include/Iir.h

@@ -27,7 +27,7 @@ namespace stk {
     This structure results in one extra multiply per computed sample,
     but allows easy control of the overall filter gain.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -113,7 +113,7 @@ protected:
 
 inline StkFloat Iir :: tick( StkFloat input )
 {
-  unsigned int i;
+  size_t i;
 
   outputs_[0] = 0.0;
   inputs_[0] = gain_ * input;
@@ -136,13 +136,14 @@ inline StkFrames& Iir :: tick( StkFrames& frames, unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= frames.channels() ) {
-    errorString_ << "Iir::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Iir::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
 
   StkFloat *samples = &frames[channel];
-  unsigned int i, hop = frames.channels();
+  size_t i;
+  unsigned int hop = frames.channels();
   for ( unsigned int j=0; j<frames.frames(); j++, samples += hop ) {
     outputs_[0] = 0.0;
     inputs_[0] = gain_ * *samples;
@@ -168,14 +169,15 @@ inline StkFrames& Iir :: tick( StkFrames& iFrames, StkFrames& oFrames, unsigned
 {
 #if defined(_STK_DEBUG_)
   if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
-    errorString_ << "Iir::tick(): channel and StkFrames arguments are incompatible!";
+    oStream_ << "Iir::tick(): channel and StkFrames arguments are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
 
   StkFloat *iSamples = &iFrames[iChannel];
   StkFloat *oSamples = &oFrames[oChannel];
-  unsigned int i, iHop = iFrames.channels(), oHop = oFrames.channels();
+  size_t i;
+  unsigned int iHop = iFrames.channels(), oHop = oFrames.channels();
   for ( unsigned int j=0; j<iFrames.frames(); j++, iSamples += iHop, oSamples += oHop ) {
     outputs_[0] = 0.0;
     inputs_[0] = gain_ * *iSamples;

include/InetWvIn.h

@@ -31,7 +31,7 @@ namespace stk {
     data type for the incoming stream is signed 16-bit integers,
     though any of the defined StkFormats are permissible.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -96,17 +96,18 @@ public:
   */
   StkFloat tick( unsigned int channel = 0 );
 
-  //! Fill the StkFrames argument with computed frames and return the same reference.
+  //! Fill the StkFrames object with computed sample frames, starting at the specified channel and return the same reference.
   /*!
-    The number of channels in the StkFrames argument must equal the
-    number of channels specified in the listen() function.  However,
-    this is only checked if _STK_DEBUG_ is defined during compilation,
-    in which case an incompatibility will trigger an StkError
-    exception.  If no connection exists, the function does
+    The \c channel argument plus the number of channels specified
+    in the listen() function must be less than the number of channels
+    in the StkFrames argument (the first channel is specified by 0).
+    However, this is only checked if _STK_DEBUG_ is defined during
+    compilation, in which case an incompatibility will trigger an
+    StkError exception.  If no connection exists, the function does
     nothing (a warning will be issued if _STK_DEBUG_ is defined during
     compilation).
   */
-  StkFrames& tick( StkFrames& frames );
+  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
 
   // Called by the thread routine to receive data via the socket connection
   // and fill the socket buffer.  This is not intended for general use but
@@ -141,7 +142,7 @@ inline StkFloat InetWvIn :: lastOut( unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= data_.channels() ) {
-    errorString_ << "InetWvIn::lastOut(): channel argument and data stream are incompatible!";
+    oStream_ << "InetWvIn::lastOut(): channel argument and data stream are incompatible!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif

include/InetWvOut.h

@@ -25,7 +25,7 @@ namespace stk {
     data type is signed 16-bit integers but any of the defined
     StkFormats are permissible.
 
-    by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

include/Instrmnt.h

@@ -12,7 +12,7 @@ namespace stk {
   This class provides a common interface for
   all STK instruments.
 
-  by Perry R. Cook and Gary P. Scavone, 1995 - 2009.
+  by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 
@@ -22,6 +22,12 @@ class Instrmnt : public Stk
   //! Class constructor.
   Instrmnt( void ) { lastFrame_.resize( 1, 1, 0.0 ); };
 
+  //! Reset and clear all internal state (for subclasses).
+  /*!
+    Not all subclasses implement a clear() function.
+  */
+  virtual void clear( void ) {};
+
   //! Start a note with the given frequency and amplitude.
   virtual void noteOn( StkFloat frequency, StkFloat amplitude ) = 0;
 
@@ -65,7 +71,7 @@ class Instrmnt : public Stk
     performed if _STK_DEBUG_ is defined during compilation, in which
     case an out-of-range value will trigger an StkError exception.
   */
-  StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
+  virtual StkFrames& tick( StkFrames& frames, unsigned int channel = 0 ) = 0;
 
  protected:
 
@@ -73,9 +79,9 @@ class Instrmnt : public Stk
 
 };
 
-inline void Instrmnt :: setFrequency(StkFloat frequency)
+inline void Instrmnt :: setFrequency( StkFloat frequency )
 {
-  errorString_ << "Instrmnt::setFrequency: virtual setFrequency function call!";
+  oStream_ << "Instrmnt::setFrequency: virtual setFrequency function call!";
   handleError( StkError::WARNING );
 }
 
@@ -83,7 +89,7 @@ inline StkFloat Instrmnt :: lastOut( unsigned int channel )
 {
 #if defined(_STK_DEBUG_)
   if ( channel >= lastFrame_.channels() ) {
-    errorString_ << "Instrmnt::lastOut(): channel argument is invalid!";
+    oStream_ << "Instrmnt::lastOut(): channel argument is invalid!";
     handleError( StkError::FUNCTION_ARGUMENT );
   }
 #endif
@@ -91,36 +97,9 @@ inline StkFloat Instrmnt :: lastOut( unsigned int channel )
   return lastFrame_[channel];
 }
 
-inline StkFrames& Instrmnt :: tick( StkFrames& frames, unsigned int channel )
-{
-  unsigned int nChannels = lastFrame_.channels();
-#if defined(_STK_DEBUG_)
-  if ( channel > frames.channels() - nChannels ) {
-    errorString_ << "Instrmnt::tick(): channel and StkFrames arguments are incompatible!";
-    handleError( StkError::FUNCTION_ARGUMENT );
-  }
-#endif
-
-  StkFloat *samples = &frames[channel];
-  unsigned int j, hop = frames.channels() - nChannels;
-  if ( nChannels == 1 ) {
-    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
-      *samples++ = tick();
-  }
-  else {
-    for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
-      *samples++ = tick();
-      for ( j=1; j<nChannels; j++ )
-        *samples++ = lastFrame_[j];
-    }
-  }
-
-  return frames;
-}
-
 inline void Instrmnt :: controlChange( int number, StkFloat value )
 {
-  errorString_ << "Instrmnt::controlChange: virtual function call!";
+  oStream_ << "Instrmnt::controlChange: virtual function call!";
   handleError( StkError::WARNING );
 }