From 32a3b551d884eee4c29f968eb905575ab6174337 Mon Sep 17 00:00:00 2001
From: Gary Scavone <gary@music.mcgill.ca>
Date: Fri, 11 Apr 2014 10:18:38 -0400
Subject: [PATCH] Documentation updates in preparation for 4.5.0 release.

---
 configure.ac                |  2 +-
 doc/ReleaseNotes.txt        |  5 ++++-
 doc/doxygen/Doxyfile        |  2 +-
 doc/doxygen/download.txt    | 14 ++++++++++++--
 doc/doxygen/index.txt       |  2 +-
 doc/doxygen/information.txt |  2 +-
 doc/doxygen/usage.txt       |  4 +++-
 7 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/configure.ac b/configure.ac
index 830c6f5..a5595f3 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1,5 +1,5 @@
 # Process this file with autoconf to produce a configure script.
-AC_INIT(STK, 4.4.4, gary@music.mcgill.ca, stk)
+AC_INIT(STK, 4.5.0, gary@music.mcgill.ca, 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/ReleaseNotes.txt b/doc/ReleaseNotes.txt
index b48ef4e..afe035d 100644
--- a/doc/ReleaseNotes.txt
+++ b/doc/ReleaseNotes.txt
@@ -4,7 +4,10 @@ By Perry R. Cook and Gary P. Scavone, 1995--2014.
 
 v4.5.0: (?? April 2014)
 - 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)
+- 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)
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
index 397991d..b0ca246 100644
--- 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.4.4
+PROJECT_NUMBER         = 4.5.0
 
 # 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
index def0613..85f6d3b 100644
--- a/doc/doxygen/download.txt
+++ b/doc/doxygen/download.txt
@@ -1,14 +1,24 @@
 /*! \page download Download, Release Notes, and Bug Fixes
 
-\section down Download Version 4.4.4 (24 August 2012):
+\section down Download Version 4.5.0 (?? April 2014):
 
 <UL>
-<LI><A HREF="http://ccrma.stanford.edu/software/stk/release/stk-4.4.4.tar.gz">Source distribution</A></LI>
+<LI><A HREF="http://ccrma.stanford.edu/software/stk/release/stk-4.5.0.tar.gz">Source distribution</A></LI>
 </UL>
 
 
 \section notes Release Notes:
 
+\subsection v4dot5dot0 Version 4.5.0
+
+<ul>
+<li>Updated versions of RtAudio and RtMidi, with associated renaming of RtError class to either RtAudioError or RtMidiError</li>
+<li>New iOS project files (thanks to Ariel Elkin)</li>
+<li>Various bug fixes and updates to minimize compiler warnings</li>
+<li>ADSR fix for decay/release time calculations</li>
+<li>Various updates to build system</li>
+</ul>
+
 \subsection v4dot4dot4 Version 4.4.4
 
 <ul>
diff --git a/doc/doxygen/index.txt b/doc/doxygen/index.txt
index c375074..4a66fc3 100644
--- a/doc/doxygen/index.txt
+++ b/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
diff --git a/doc/doxygen/information.txt b/doc/doxygen/information.txt
index 738d91d..792fca7 100644
--- a/doc/doxygen/information.txt
+++ b/doc/doxygen/information.txt
@@ -18,7 +18,7 @@ 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). 
 
diff --git a/doc/doxygen/usage.txt b/doc/doxygen/usage.txt
index f22420a..9f59167 100644
--- a/doc/doxygen/usage.txt
+++ b/doc/doxygen/usage.txt
@@ -46,7 +46,7 @@ This release of STK comes with four separate "project" directories:
 \section compiling Compiling:
 
 <UL>
-<LI><B>Windows95/98/2000/XP/7:</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).  Fairly old Visual C++ project files are provided in each project directory, though they may not work on newer versions of MSVS.  As well, the MinGW compiler is supported (see below).  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/98/2000/XP/7:</B> Realtime support is available using either DirectSound, ASIO or WASAPI 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.  For WASAPI support, use the <TT>__WINDOWS_WASAPI__</TT> preprocessor definition.  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).  Fairly old Visual C++ project files are provided in each project directory, though they may not work on newer versions of MSVS.  As well, the MinGW compiler is supported (see below).  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>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.
 
@@ -58,6 +58,8 @@ Several options can be supplied to the <TT>configure</TT> script to customize th
 <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-asio</TT> to choose ASIO Audio API support (Windows)</LI>
+<LI><TT>--with-ds</TT> to choose Windows Direct Sound 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: