Skip to content

Commit

Permalink
Version and documentation updates in preparation for 4.6.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
garyscavone committed Aug 30, 2017
1 parent 6ed16eb commit d6c67cc
Show file tree
Hide file tree
Showing 192 changed files with 215 additions and 199 deletions.
6 changes: 3 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
% The Synthesis ToolKit in C++ (STK)
% Perry R. Cook and Gary P. Scavone
% 1995--2016
% 1995--2017

# The Synthesis ToolKit in C++ (STK)
By Perry R. Cook and Gary P. Scavone, 1995--2016.
By Perry R. Cook and Gary P. Scavone, 1995--2017.

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.

Expand All @@ -30,7 +30,7 @@ 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-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 Core Audio API (macintosh OS-X only)
--with-asio = choose ASIO API support (windows only)
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK)

Copyright (c) 1995--2016 Perry R. Cook and Gary P. Scavone
Copyright (c) 1995--2017 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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# The Synthesis ToolKit in C++ (STK)
By Perry R. Cook and Gary P. Scavone, 1995--2016.
By Perry R. Cook and Gary P. Scavone, 1995--2017.

This distribution of the Synthesis ToolKit in C++ (STK) contains the following:

Expand Down
4 changes: 2 additions & 2 deletions configure.ac
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Process this file with autoconf to produce a configure script.
AC_INIT(STK, 4.5.1, [email protected], stk)
AC_INIT(STK, 4.6.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)
Expand Down Expand Up @@ -143,7 +143,7 @@ api="$api -D__UNIX_JACK__"
AC_CHECK_LIB(asound, snd_pcm_open, , AC_MSG_ERROR(ALSA support requires the asound library!))])

# Look for OSS flag
AC_ARG_WITH(oss, [ --with-oss = choose OSS API support (linux only)])
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)
Expand Down
2 changes: 1 addition & 1 deletion doc/README-Linux.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK)

By Perry R. Cook and Gary P. Scavone, 1995--2016.
By Perry R. Cook and Gary P. Scavone, 1995--2017.

Please read the file README and INSTALL for more general STK information.

Expand Down
2 changes: 1 addition & 1 deletion doc/README-MacOSX.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK)

By Perry R. Cook and Gary P. Scavone, 1995--2016.
By Perry R. Cook and Gary P. Scavone, 1995--2017.

Please read the file README and INSTALL for more general STK information.

Expand Down
2 changes: 1 addition & 1 deletion doc/README-SGI.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK)

By Perry R. Cook and Gary P. Scavone, 1995--2016.
By Perry R. Cook and Gary P. Scavone, 1995--2017.

Please read the file README and INSTALL for more general STK information.

Expand Down
2 changes: 1 addition & 1 deletion doc/README-Win.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK)

By Perry R. Cook and Gary P. Scavone, 1995--2016.
By Perry R. Cook and Gary P. Scavone, 1995--2017.

Please read the file README for more general STK information.

Expand Down
12 changes: 10 additions & 2 deletions doc/ReleaseNotes.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
The Synthesis ToolKit in C++ (STK)

By Perry R. Cook and Gary P. Scavone, 1995--2016.
By Perry R. Cook and Gary P. Scavone, 1995--2017.

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 2016)
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
Expand Down
2 changes: 1 addition & 1 deletion doc/doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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.1
PROJECT_NUMBER = 4.6.0

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
Expand Down
12 changes: 10 additions & 2 deletions doc/doxygen/download.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
/*! \page download Download, Release Notes, and Bug Fixes

\section down Download Version 4.5.1 (22 February 2016):
\section down Download Version 4.6.0 (31 August 2017):

- <A HREF="http://ccrma.stanford.edu/software/stk/release/stk-4.5.1.tar.gz">Source distribution</A>
- <A HREF="http://ccrma.stanford.edu/software/stk/release/stk-4.6.0.tar.gz">Source distribution</A>

\section notes Release Notes:
\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)
Expand Down
2 changes: 1 addition & 1 deletion doc/doxygen/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016 Perry R. Cook and Gary P. Scavone
Copyright (c) 1995--2017 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
Expand Down
2 changes: 1 addition & 1 deletion doc/doxygen/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995--2017 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>

</BODY>
Expand Down
2 changes: 1 addition & 1 deletion doc/hierarchy.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
STK: A ToolKit of Audio Synthesis Classes and Instruments in C++

By Perry R. Cook and Gary P. Scavone, 1995--2016.
By Perry R. Cook and Gary P. Scavone, 1995--2017.

STK Classes - See the HTML documentation in the html directory for complete information.

Expand Down
2 changes: 1 addition & 1 deletion include/ADSR.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Asymp.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/BeeThree.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/BiQuad.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/BlowBotl.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace stk {
- Vibrato Gain = 1
- Volume = 128
by Perry R. Cook and Gary P. Scavone, 1995--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/BlowHole.h
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ namespace stk {
- Register State = 1
- Breath Pressure = 128
by Perry R. Cook and Gary P. Scavone, 1995--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/BowTable.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ namespace stk {
(1986). The output is an instantaneous
reflection coefficient value.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Bowed.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ namespace stk {
- Frequency = 101
- Volume = 128
by Perry R. Cook and Gary P. Scavone, 1995--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
Contributions by Esteban Maestre, 2011.
*/
/***************************************************/
Expand Down
2 changes: 1 addition & 1 deletion include/Brass.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ namespace stk {
- Vibrato Gain = 1
- Volume = 128
by Perry R. Cook and Gary P. Scavone, 1995--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Chorus.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Clarinet.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ namespace stk {
- Vibrato Gain = 1
- Breath Pressure = 128
by Perry R. Cook and Gary P. Scavone, 1995--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Delay.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/DelayA.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/DelayL.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Drummer.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Echo.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace stk {
This class implements an echo effect.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Effect.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Envelope.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/FM.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/FMVoices.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/FileLoop.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/FileRead.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/FileWrite.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/FileWvIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/FileWvOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
2 changes: 1 addition & 1 deletion include/Filter.h
Original file line number Diff line number Diff line change
Expand Up @@ -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--2016.
by Perry R. Cook and Gary P. Scavone, 1995--2017.
*/
/***************************************************/

Expand Down
Loading

0 comments on commit d6c67cc

Please sign in to comment.