Documentation updates in preparation for 5.0.0 release.

This commit is contained in:
garyscavone
2023-08-04 11:21:16 -04:00
parent fd5e37863d
commit 3675846c66
195 changed files with 2190 additions and 1320 deletions

View File

@@ -1,5 +1,5 @@
# The Synthesis ToolKit in C++ (STK) # 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. 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.

View File

@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (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 Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@@ -1,5 +1,5 @@
# The Synthesis ToolKit in C++ (STK) # 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: This distribution of the Synthesis ToolKit in C++ (STK) contains the following:

View File

@@ -1,5 +1,5 @@
# Process this file with autoconf to produce a configure script. # Process this file with autoconf to produce a configure script.
AC_INIT(STK, 4.6.2, gary.scavone@mcgill.ca, stk) AC_INIT(STK, 5.0.0, gary.scavone@mcgill.ca, stk)
AC_CONFIG_AUX_DIR(config) AC_CONFIG_AUX_DIR(config)
AC_CONFIG_SRCDIR(src/Stk.cpp) 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) AC_CONFIG_FILES(Makefile src/Makefile projects/demo/Makefile projects/effects/Makefile projects/ragamatic/Makefile projects/examples/Makefile projects/examples/libMakefile projects/eguitar/Makefile)

View File

@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK) 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. Please read the file README and INSTALL for more general STK information.

View File

@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK) 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. 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: 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. 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.

View File

@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK) 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. Please read the file README and INSTALL for more general STK information.

View File

@@ -1,6 +1,6 @@
The Synthesis ToolKit in C++ (STK) 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. Please read the file README.md for more general STK information.

View File

@@ -1,6 +1,12 @@
The Synthesis ToolKit in C++ (STK) 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) v.4.6.2 (17 November 2021)
- see github site for complete details (github.com/thestk/stk) - see github site for complete details (github.com/thestk/stk)

File diff suppressed because it is too large Load Diff

View File

@@ -1,10 +1,16 @@
/*! \page download Download and Release Notes /*! \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: \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 \subsection v4dot6dot2 Version 4.6.2
- see github site for complete details (github.com/thestk/stk) - see github site for complete details (github.com/thestk/stk)
- bug fixes in LentPitShift and Granulate classes - bug fixes in LentPitShift and Granulate classes

View File

@@ -25,7 +25,7 @@ STK GitHub site: https://github.com/thestk/stk
STK WWW site: http://ccrma.stanford.edu/software/stk/ STK WWW site: http://ccrma.stanford.edu/software/stk/
The Synthesis ToolKit in C++ (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 Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@@ -2,7 +2,7 @@
<table> <table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr> <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> </table>
</BODY> </BODY>

View File

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

View File

@@ -1,6 +1,6 @@
STK: A ToolKit of Audio Synthesis Classes and Instruments in C++ 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. STK Classes - See the HTML documentation in the html directory for complete information.

View File

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

View File

@@ -26,7 +26,7 @@ namespace stk {
to \e keyOn and \e keyOff messages by ramping to to \e keyOn and \e keyOff messages by ramping to
1.0 on keyOn and to 0.0 on keyOff. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -35,7 +35,7 @@ namespace stk {
type who should worry about this (making type who should worry about this (making
money) worry away. money) worry away.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -17,7 +17,7 @@ namespace stk {
bandpass, bandreject and allpass are found on pg. 55 of bandpass, bandreject and allpass are found on pg. 55 of
Udo Zölzer's "DAFX - Digital Audio Effects" (2011 2nd ed). 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.
*/ */
/***************************************************/ /***************************************************/

View File

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

View File

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

View File

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

View File

@@ -32,7 +32,7 @@ namespace stk {
- Frequency = 101 - Frequency = 101
- Volume = 128 - 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. Contributions by Esteban Maestre, 2011.
*/ */
/***************************************************/ /***************************************************/

View File

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

View File

@@ -14,7 +14,7 @@ namespace stk {
This class implements a chorus effect. It takes a monophonic This class implements a chorus effect. It takes a monophonic
input signal and produces a stereo output signal. 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.
*/ */
/***************************************************/ /***************************************************/

View File

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

View File

@@ -17,7 +17,7 @@ namespace stk {
A non-interpolating delay line is typically used in fixed A non-interpolating delay line is typically used in fixed
delay-length applications, such as for reverberation. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -21,7 +21,7 @@ namespace stk {
minimum delay possible in this implementation is limited to a minimum delay possible in this implementation is limited to a
value of 0.5. value of 0.5.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -20,7 +20,7 @@ namespace stk {
delay setting. The use of higher order Lagrange interpolators can delay setting. The use of higher order Lagrange interpolators can
typically improve (minimize) this attenuation characteristic. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -20,7 +20,7 @@ namespace stk {
of simultaneous voices) via a #define in the of simultaneous voices) via a #define in the
Drummer.h. Drummer.h.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -12,7 +12,7 @@ namespace stk {
This class implements an echo effect. 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.
*/ */
/***************************************************/ /***************************************************/

View File

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

View File

@@ -15,7 +15,7 @@ namespace stk {
keyOff messages, ramping to a specified target (default = 1.0) on keyOff messages, ramping to a specified target (default = 1.0) on
keyOn and to a specified target (default = 0.0) on keyOff. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -30,7 +30,7 @@ namespace stk {
type who should worry about this (making type who should worry about this (making
money) worry away. money) worry away.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -33,7 +33,7 @@ namespace stk {
type who should worry about this (making type who should worry about this (making
money) worry away. money) worry away.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -19,7 +19,7 @@ namespace stk {
the overloaded one that takes an StkFrames object for the overloaded one that takes an StkFrames object for
multi-channel and/or multi-frame data. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -34,7 +34,7 @@ namespace stk {
such variable is found, the sample rate is such variable is found, the sample rate is
assumed to be 44100 Hz. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -24,7 +24,7 @@ namespace stk {
type, the data type will automatically be modified. Compressed type, the data type will automatically be modified. Compressed
data types are not supported. 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.
*/ */
/***************************************************/ /***************************************************/

View File

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

View File

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

View File

@@ -15,7 +15,7 @@ namespace stk {
filter subclasses. It is general enough to support both filter subclasses. It is general enough to support both
monophonic and polyphonic input/output classes. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -23,7 +23,7 @@ namespace stk {
This structure results in one extra multiply per computed sample, This structure results in one extra multiply per computed sample,
but allows easy control of the overall filter gain. 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.
*/ */
/***************************************************/ /***************************************************/

View File

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

View File

@@ -13,7 +13,7 @@ namespace stk {
over time from one frequency setting to another. It provides over time from one frequency setting to another. It provides
methods for controlling the sweep rate and target frequency. 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.
*/ */
/***************************************************/ /***************************************************/

View File

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

View File

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

View File

@@ -21,7 +21,7 @@ namespace stk {
Chris Rolfe and Damian Keller, though there are likely to be a Chris Rolfe and Damian Keller, though there are likely to be a
number of differences in the actual implementation. number of differences in the actual implementation.
by Gary Scavone, 2005--2021. by Gary Scavone, 2005--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -31,7 +31,7 @@ namespace stk {
type who should worry about this (making type who should worry about this (making
money) worry away. money) worry away.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -27,7 +27,7 @@ namespace stk {
This structure results in one extra multiply per computed sample, This structure results in one extra multiply per computed sample,
but allows easy control of the overall filter gain. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -31,7 +31,7 @@ namespace stk {
data type for the incoming stream is signed 16-bit integers, data type for the incoming stream is signed 16-bit integers,
though any of the defined StkFormats are permissible. though any of the defined StkFormats are permissible.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

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

View File

@@ -12,7 +12,7 @@ namespace stk {
This class provides a common interface for This class provides a common interface for
all STK instruments. all STK instruments.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -24,7 +24,7 @@ namespace stk {
one-pole lowpass filters have been added inside one-pole lowpass filters have been added inside
the feedback comb filters. the feedback comb filters.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -16,7 +16,7 @@ namespace stk {
Consult Fletcher and Rossing, Karjalainen, Consult Fletcher and Rossing, Karjalainen,
Cook, and others for more information. Cook, and others for more information.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -31,7 +31,7 @@ namespace stk {
- String Detuning = 1 - String Detuning = 1
- Microphone Position = 128 - Microphone Position = 128
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -46,7 +46,7 @@ namespace stk {
This class is primarily for use in STK example programs but it is This class is primarily for use in STK example programs but it is
generic enough to work in many other contexts. generic enough to work in many other contexts.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -22,7 +22,7 @@ namespace stk {
Tempo changes are internally tracked by the class and reflected in Tempo changes are internally tracked by the class and reflected in
the values returned by the function getTickSeconds(). the values returned by the function getTickSeconds().
by Gary P. Scavone, 2003--2021. by Gary P. Scavone, 2003--2023.
*/ */
/**********************************************************************/ /**********************************************************************/

View File

@@ -19,7 +19,7 @@ namespace stk {
(non-sweeping BiQuad filters), where N is set (non-sweeping BiQuad filters), where N is set
during instantiation. during instantiation.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -31,7 +31,7 @@ namespace stk {
- Two Fixed = 7 - Two Fixed = 7
- Clump = 8 - Clump = 8
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -16,7 +16,7 @@ namespace stk {
modulations to give a nice, natural human modulations to give a nice, natural human
modulation function. modulation function.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -22,7 +22,7 @@ namespace stk {
- Vibrato Gain = 1 - Vibrato Gain = 1
- Gain = 128 - Gain = 128
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -29,7 +29,7 @@ namespace stk {
systems, the pthread library is used. Under systems, the pthread library is used. Under
Windows, critical sections are used. Windows, critical sections are used.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -18,7 +18,7 @@ namespace stk {
another allpass in series, followed by two allpass filters in another allpass in series, followed by two allpass filters in
parallel with corresponding right and left outputs. parallel with corresponding right and left outputs.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -14,7 +14,7 @@ namespace stk {
C rand() function. The quality of the rand() C rand() function. The quality of the rand()
function varies from one OS to another. function varies from one OS to another.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -13,7 +13,7 @@ namespace stk {
provided for setting the pole position along the real axis of the provided for setting the pole position along the real axis of the
z-plane while maintaining a constant peak filter gain. z-plane while maintaining a constant peak filter gain.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -13,7 +13,7 @@ namespace stk {
provided for setting the zero position along the real axis of the provided for setting the zero position along the real axis of the
z-plane while maintaining a constant filter gain. z-plane while maintaining a constant filter gain.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -17,7 +17,7 @@ namespace stk {
allpass and comb delay filters. This class implements two series allpass and comb delay filters. This class implements two series
allpass units and two parallel comb filters. allpass units and two parallel comb filters.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -29,7 +29,7 @@ namespace stk {
type who should worry about this (making type who should worry about this (making
money) worry away. money) worry away.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -13,7 +13,7 @@ namespace stk {
set of 32 static phoneme formant parameters set of 32 static phoneme formant parameters
and provide access to those values. and provide access to those values.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -13,7 +13,7 @@ namespace stk {
This class implements a simple pitch shifter This class implements a simple pitch shifter
using a delay line. using a delay line.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -27,7 +27,7 @@ namespace stk {
Stanford, bearing the names of Karplus and/or Stanford, bearing the names of Karplus and/or
Strong. Strong.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -14,7 +14,7 @@ namespace stk {
coefficient. Another method is provided to create a DC blocking coefficient. Another method is provided to create a DC blocking
filter. filter.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -29,7 +29,7 @@ namespace stk {
- Breath Pressure = 128 - Breath Pressure = 128
by Mathias Bredholt, McGill University. by Mathias Bredholt, McGill University.
Formatted for STK by Gary Scavone, 2021. Formatted for STK by Gary Scavone, 2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -20,7 +20,7 @@ namespace stk {
Smith (1986), Hirschman, Cook, Scavone, and Smith (1986), Hirschman, Cook, Scavone, and
others for more information. others for more information.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -23,7 +23,7 @@ namespace stk {
- Zero Radii = 1 - Zero Radii = 1
- Envelope Gain = 128 - Envelope Gain = 128
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -33,7 +33,7 @@ namespace stk {
type who should worry about this (making type who should worry about this (making
money) worry away. money) worry away.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -24,7 +24,7 @@ namespace stk {
that takes an StkFrames object for multi-channel and/or that takes an StkFrames object for multi-channel and/or
multi-frame data. multi-frame data.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -23,7 +23,7 @@ namespace stk {
that takes a reference to an StkFrames object for multi-channel that takes a reference to an StkFrames object for multi-channel
and/or multi-frame data. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -9,7 +9,7 @@
where <name> is the string used in the SKINI stream. where <name> is the string used in the SKINI stream.
by Perry R. Cook, 1995--2021. by Perry R. Cook, 1995--2023.
*/ */
/*********************************************************/ /*********************************************************/

View File

@@ -15,7 +15,7 @@ namespace stk {
This instrument provides an ADSR envelope, a one-pole filter, and This instrument provides an ADSR envelope, a one-pole filter, and
structures for an arbitrary number of attack and looped files. structures for an arbitrary number of attack and looped files.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -44,7 +44,7 @@ namespace stk {
- Vibrato Gain = 1 - Vibrato Gain = 1
- Breath Pressure = 128 - Breath Pressure = 128
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -53,7 +53,7 @@ namespace stk {
- Water Drops = 21 - Water Drops = 21
- Tuned Bamboo Chimes = 22 - Tuned Bamboo Chimes = 22
by Perry R. Cook with updates by Gary Scavone, 1995--2021. by Perry R. Cook with updates by Gary Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -25,7 +25,7 @@ namespace stk {
- Envelope Rate = 11 - Envelope Rate = 11
- Gain = 128 - Gain = 128
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -18,7 +18,7 @@ namespace stk {
The "table" length, set in SineWave.h, is 2048 samples by default. The "table" length, set in SineWave.h, is 2048 samples by default.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -18,7 +18,7 @@ namespace stk {
Within STK, it is used as an excitation source for other Within STK, it is used as an excitation source for other
instruments. instruments.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -25,7 +25,7 @@ namespace stk {
Stanford, bearing the names of Karplus and/or Stanford, bearing the names of Karplus and/or
Strong. Strong.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -31,7 +31,7 @@ namespace stk {
\sa \ref skini \sa \ref skini
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -31,7 +31,7 @@ namespace stk {
number of static functions for use with external socket number of static functions for use with external socket
descriptors. descriptors.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -13,7 +13,7 @@ namespace stk {
This class implements a spherical ball with This class implements a spherical ball with
radius, mass, position, and velocity parameters. radius, mass, position, and velocity parameters.
by Perry R. Cook, 1995--2021. by Perry R. Cook, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -29,7 +29,7 @@ namespace stk {
- String Sustain = 11 - String Sustain = 11
- String Stretch = 1 - String Stretch = 1
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -41,7 +41,7 @@ namespace stk {
STK WWW site: http://ccrma.stanford.edu/software/stk/ STK WWW site: http://ccrma.stanford.edu/software/stk/
The Synthesis ToolKit in C++ (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 Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files obtaining a copy of this software and associated documentation files
@@ -271,7 +271,7 @@ protected:
Possible future improvements in this class could include functions Possible future improvements in this class could include functions
to convert to and return other data types. to convert to and return other data types.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -17,7 +17,7 @@ namespace stk {
A non-interpolating delay line is typically used in fixed A non-interpolating delay line is typically used in fixed
delay-length applications, such as for reverberation. 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.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -26,7 +26,7 @@ namespace stk {
less than or equal to zero indicate a closed less than or equal to zero indicate a closed
or lost connection or the occurence of an error. or lost connection or the occurence of an error.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -26,7 +26,7 @@ namespace stk {
less than or equal to zero indicate a closed less than or equal to zero indicate a closed
or lost connection or the occurence of an error. or lost connection or the occurence of an error.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -42,7 +42,7 @@ namespace stk {
THREAD_RETURN THREAD_TYPE thread_function(void *ptr) THREAD_RETURN THREAD_TYPE thread_function(void *ptr)
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -33,7 +33,7 @@ namespace stk {
type who should worry about this (making type who should worry about this (making
money) worry away. money) worry away.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -27,7 +27,7 @@ namespace stk {
use possibly subject to patents held by Stanford use possibly subject to patents held by Stanford
University, Yamaha, and others. University, Yamaha, and others.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -13,7 +13,7 @@ namespace stk {
provided for creating a resonance in the frequency response while provided for creating a resonance in the frequency response while
maintaining a nearly constant filter gain. maintaining a nearly constant filter gain.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -13,7 +13,7 @@ namespace stk {
provided for creating a "notch" in the frequency response while provided for creating a "notch" in the frequency response while
maintaining a constant filter gain. maintaining a constant filter gain.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

View File

@@ -24,7 +24,7 @@ namespace stk {
read/write methods. Values less than or equal to zero indicate read/write methods. Values less than or equal to zero indicate
the occurence of an error. the occurence of an error.
by Perry R. Cook and Gary P. Scavone, 1995--2021. by Perry R. Cook and Gary P. Scavone, 1995--2023.
*/ */
/***************************************************/ /***************************************************/

Some files were not shown because too many files have changed in this diff Show More