Lots of documentation updates in advance of new release (4.5.1).

thestk · Feb 23, 2016 · fb50d69 · fb50d69
1 parent 126ff9d
commit fb50d69
Show file tree

Hide file tree

Showing 188 changed files with 418 additions and 469 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -1,9 +1,9 @@
 % The Synthesis ToolKit in C++ (STK)
 % Perry R. Cook and Gary P. Scavone
-% 1995--2014
+% 1995--2016
 
 # The Synthesis ToolKit in C++ (STK)
-By Perry R. Cook and Gary P. Scavone, 1995--2014.
+By Perry R. Cook and Gary P. Scavone, 1995--2016.
 
 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--2014 Perry R. Cook and Gary P. Scavone
+Copyright (c) 1995--2016 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--2014.
+By Perry R. Cook and Gary P. Scavone, 1995--2016.
 
 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.5.0, [email protected], stk)
+AC_INIT(STK, 4.5.1, [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--2014.
+By Perry R. Cook and Gary P. Scavone, 1995--2016.
 
 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--2014.
+By Perry R. Cook and Gary P. Scavone, 1995--2016.
 
 Please read the file README and INSTALL for more general STK information.
 

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--2014.
+By Perry R. Cook and Gary P. Scavone, 1995--2016.
 
 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--2014.
+By Perry R. Cook and Gary P. Scavone, 1995--2016.
 
 Please read the file README for more general STK information.
 

diff --git a/doc/ReleaseNotes.txt b/doc/ReleaseNotes.txt
@@ -1,6 +1,13 @@
 The Synthesis ToolKit in C++ (STK)
 
-By Perry R. Cook and Gary P. Scavone, 1995--2014.
+By Perry R. Cook and Gary P. Scavone, 1995--2016.
+
+v4.5.1 (22 February 2016)
+- 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

diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
@@ -31,7 +31,7 @@ PROJECT_NAME           = STK
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = 4.5.0
+PROJECT_NUMBER         = 4.5.1
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 

diff --git a/doc/doxygen/download.txt b/doc/doxygen/download.txt
diff --git a/doc/doxygen/faq.txt b/doc/doxygen/faq.txt
@@ -24,7 +24,7 @@ work with any standard C++ compiler.
 STK WWW site: http://ccrma.stanford.edu/software/stk/
 
 The Synthesis ToolKit in C++ (STK)
-Copyright (c) 1995--2014 Perry R. Cook and Gary P. Scavone
+Copyright (c) 1995--2016 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--2014 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
+  <tr><td>&copy;1995--2016 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
 </table>
 
 </BODY>

diff --git a/doc/doxygen/tutorial.txt b/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.).
 

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--2014.
+By Perry R. Cook and Gary P. Scavone, 1995--2016.
 
 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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
     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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/
 

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--2014.
+    by Perry R. Cook and Gary P. Scavone, 1995--2016.
 */
 /***************************************************/