Documentation updates in preparation for 5.0.0 release.

thestk · Aug 4, 2023 · 3675846 · 3675846
1 parent fd5e378
commit 3675846
Show file tree

Hide file tree

Showing 195 changed files with 2,219 additions and 1,349 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -1,5 +1,5 @@
 # The Synthesis ToolKit in C++ (STK)
-By Perry R. Cook and Gary P. Scavone, 1995-2021.
+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.
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The Synthesis ToolKit in C++ (STK)
 
-Copyright (c) 1995-2021 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

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # The Synthesis ToolKit in C++ (STK)
-By Perry R. Cook and Gary P. Scavone, 1995--2021.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 This distribution of the Synthesis ToolKit in C++ (STK) contains the following:
 

diff --git a/configure.ac b/configure.ac
@@ -1,5 +1,5 @@
 # Process this file with autoconf to produce a configure script.
-AC_INIT(STK, 4.6.2, [email protected], stk)
+AC_INIT(STK, 5.0.0, [email protected], stk)
 AC_CONFIG_AUX_DIR(config)
 AC_CONFIG_SRCDIR(src/Stk.cpp)
 AC_CONFIG_FILES(Makefile src/Makefile projects/demo/Makefile projects/effects/Makefile projects/ragamatic/Makefile projects/examples/Makefile projects/examples/libMakefile projects/eguitar/Makefile)

diff --git a/doc/README-Linux.txt b/doc/README-Linux.txt
@@ -1,6 +1,6 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995--2021.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 Please read the file README and INSTALL for more general STK information.
 

diff --git a/doc/README-MacOSX.txt b/doc/README-MacOSX.txt
@@ -1,6 +1,6 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995--2021.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 Please read the file README and INSTALL for more general STK information.
 
@@ -10,7 +10,7 @@ It is necessary to install the OS X developer kit (or the command line tools) in
 
 Tcl/Tk on OS X:
 
-I think that Tcl/Tk interpreter is now included in the Xcode package, since I haven't had to download it for several years now.
+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.
 
diff --git a/doc/README-SGI.txt b/doc/README-SGI.txt
@@ -1,6 +1,6 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995--2021.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 Please read the file README and INSTALL for more general STK information.
 

diff --git a/doc/README-Win.txt b/doc/README-Win.txt
@@ -1,6 +1,6 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995--2021.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 Please read the file README.md for more general STK information.
 

diff --git a/doc/ReleaseNotes.txt b/doc/ReleaseNotes.txt
@@ -1,6 +1,12 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995--2021.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
+
+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)

diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
diff --git a/doc/doxygen/download.txt b/doc/doxygen/download.txt
@@ -1,10 +1,16 @@
 /*! \page download Download and Release Notes
 
-\section down Download Version 4.6.2 (17 November 2021):
+\section down Download Version 5.0.0 (4 August 2023):
 
-- <A HREF="http://ccrma.stanford.edu/software/stk/release/stk-4.6.2.tar.gz">Source distribution</A>
+- <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

diff --git a/doc/doxygen/faq.txt b/doc/doxygen/faq.txt
@@ -25,7 +25,7 @@ STK GitHub site: https://github.com/thestk/stk
 STK WWW site: http://ccrma.stanford.edu/software/stk/
 
 The Synthesis ToolKit in C++ (STK)
-Copyright (c) 1995--2021 Perry R. Cook and Gary P. Scavone
+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

diff --git a/doc/doxygen/footer.html b/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--2021 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>

diff --git a/doc/doxygen/index.txt b/doc/doxygen/index.txt
@@ -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>
 
 */
 

diff --git a/doc/hierarchy.txt b/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--2021.
+By Perry R. Cook and Gary P. Scavone, 1995--2023.
 
 STK Classes - See the HTML documentation in the html directory for complete information.
 

diff --git a/include/ADSR.h b/include/ADSR.h
@@ -17,7 +17,7 @@ namespace stk {
     be non-negative.  All time settings are in seconds and must be
     positive.
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Asymp.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/BeeThree.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/BiQuad.h b/include/BiQuad.h
@@ -17,7 +17,7 @@ namespace stk {
     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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/BlowBotl.h b/include/BlowBotl.h
@@ -25,7 +25,7 @@ namespace stk {
        - Vibrato Gain = 1
        - Volume = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/BlowHole.h b/include/BlowHole.h
@@ -43,7 +43,7 @@ namespace stk {
        - Register State = 1
        - Breath Pressure = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/BowTable.h b/include/BowTable.h
@@ -15,7 +15,7 @@ namespace stk {
     (1986).  The output is an instantaneous
     reflection coefficient value.
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Bowed.h b/include/Bowed.h
@@ -32,7 +32,7 @@ namespace stk {
        - Frequency = 101
        - Volume = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
     Contributions by Esteban Maestre, 2011.
 */
 /***************************************************/

diff --git a/include/Brass.h b/include/Brass.h
@@ -28,7 +28,7 @@ namespace stk {
        - Vibrato Gain = 1
        - Volume = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Chorus.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Clarinet.h b/include/Clarinet.h
@@ -31,7 +31,7 @@ namespace stk {
        - Vibrato Gain = 1
        - Breath Pressure = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Delay.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/DelayA.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/DelayL.h b/include/DelayL.h
@@ -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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Drummer.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Echo.h b/include/Echo.h
@@ -12,7 +12,7 @@ namespace stk {
 
     This class implements an echo effect.
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Effect.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Envelope.h b/include/Envelope.h
@@ -15,7 +15,7 @@ namespace stk {
     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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/FM.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/FMVoices.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/FileLoop.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/FileRead.h b/include/FileRead.h
@@ -34,7 +34,7 @@ namespace stk {
     such variable is found, the sample rate is
     assumed to be 44100 Hz.
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/FileWrite.h b/include/FileWrite.h
@@ -24,7 +24,7 @@ namespace stk {
     type, the data type will automatically be modified.  Compressed
     data types are not supported.
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/FileWvIn.h b/include/FileWvIn.h
@@ -45,7 +45,7 @@ namespace stk {
     See the FileRead class for a description of the supported audio
     file formats.
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/FileWvOut.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Filter.h b/include/Filter.h
@@ -15,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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Fir.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/Flute.h b/include/Flute.h
@@ -32,7 +32,7 @@ namespace stk {
        - Vibrato Gain = 1
        - Breath Pressure = 128
 
-    by Perry R. Cook and Gary P. Scavone, 1995--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/
 

diff --git a/include/FormSwep.h b/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--2021.
+    by Perry R. Cook and Gary P. Scavone, 1995--2023.
 */
 /***************************************************/