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

This commit is contained in:
Gary Scavone
2016-02-22 20:51:07 -05:00
parent 126ff9d9e1
commit fb50d69e08
188 changed files with 418 additions and 469 deletions

View File

@@ -9,7 +9,7 @@
the ADSR::RELEASE state. All rate, target and level settings must
be non-negative. All time settings must be positive.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -19,7 +19,7 @@
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.
*/
/***************************************************/

View File

@@ -28,7 +28,7 @@
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.
*/
/***************************************************/

View File

@@ -6,7 +6,7 @@
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.
*/
/***************************************************/

View File

@@ -12,7 +12,7 @@
- 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.
*/
/***************************************************/

View File

@@ -29,7 +29,7 @@
- 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.
*/
/***************************************************/

View File

@@ -19,7 +19,7 @@
- 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.
*/
/***************************************************/

View File

@@ -16,7 +16,7 @@
- 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.
*/
/***************************************************/

View File

@@ -5,7 +5,7 @@
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.
*/
/***************************************************/

View File

@@ -18,7 +18,7 @@
- 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.
*/
/***************************************************/

View File

@@ -10,7 +10,7 @@
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.
*/
/***************************************************/

View File

@@ -14,7 +14,7 @@
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.
*/
/***************************************************/

View File

@@ -13,7 +13,7 @@
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.
*/
/***************************************************/

View File

@@ -11,7 +11,7 @@
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.
*/
/***************************************************/

View File

@@ -4,7 +4,7 @@
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.
*/
/***************************************************/

View File

@@ -7,7 +7,7 @@
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.
*/
/***************************************************/

View File

@@ -19,7 +19,7 @@
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.
*/
/***************************************************/

View File

@@ -26,7 +26,7 @@
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.
*/
/***************************************************/

View File

@@ -12,7 +12,7 @@
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.
*/
/***************************************************/

View File

@@ -17,7 +17,7 @@
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.
*/
/***************************************************/

View File

@@ -27,7 +27,7 @@
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.
*/
/***************************************************/

View File

@@ -17,7 +17,7 @@
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.
*/
/***************************************************/

View File

@@ -16,7 +16,7 @@
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.
*/
/***************************************************/

View File

@@ -18,7 +18,7 @@
- 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.
*/
/***************************************************/

View File

@@ -6,7 +6,7 @@
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.
*/
/***************************************************/

View File

@@ -22,7 +22,7 @@
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.
*/
/***************************************************/

View File

@@ -20,7 +20,7 @@
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.
*/
/***************************************************/

View File

@@ -20,7 +20,7 @@
data type for the incoming stream is signed 16-bit integers,
though any of the defined StkFormats are permissible.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -17,7 +17,7 @@
data type is signed 16-bit integers but any of the defined
StkFormats are permissible.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -15,7 +15,7 @@
one-pole lowpass filters have been added inside
the feedback comb filters.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -22,7 +22,7 @@
- String Detuning = 1
- Microphone Position = 128
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

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

View File

@@ -7,7 +7,7 @@
(non-sweeping BiQuad filters), where N is set
during instantiation.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -24,7 +24,7 @@
- Two Fixed = 7
- Clump = 8
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -6,7 +6,7 @@
modulations to give a nice, natural human
modulation function.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -14,7 +14,7 @@
- Vibrato Gain = 1
- Gain = 128
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -7,7 +7,7 @@
systems, the pthread library is used. Under
Windows, critical sections are used.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -10,7 +10,7 @@
another allpass in series, followed by two allpass filters in
parallel with corresponding right and left outputs.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -6,7 +6,7 @@
C rand() function. The quality of the rand()
function varies from one OS to another.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

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

View File

@@ -6,7 +6,7 @@
provided for setting the zero position along the real axis of the
z-plane 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.
*/
/***************************************************/

View File

@@ -10,7 +10,7 @@
two series allpass units and two parallel comb
filters.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -22,7 +22,7 @@
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.
*/
/***************************************************/

View File

@@ -6,7 +6,7 @@
set of 32 static phoneme formant parameters
and provide access to those values.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -5,7 +5,7 @@
This class implements a simple pitch shifter
using delay lines.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -16,7 +16,7 @@
Stanford, bearing the names of Karplus and/or
Strong.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -7,7 +7,7 @@
coefficient. Another method is provided to create a DC blocking
filter.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -13,7 +13,7 @@
- Zero Radii = 1
- Envelope Gain = 128
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -26,7 +26,7 @@
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.
*/
/***************************************************/

View File

@@ -15,7 +15,7 @@
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.
*/
/***************************************************/

View File

@@ -14,7 +14,7 @@
that takes a reference to 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.
*/
/***************************************************/

View File

@@ -5,7 +5,7 @@
This instrument provides an ADSR envelope, a one-pole filter, and
structures for an arbitrary number of attack and looped files.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -31,7 +31,7 @@
- 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.
*/
/***************************************************/

View File

@@ -44,7 +44,7 @@
- Water Drops = 21
- Tuned Bamboo Chimes = 22
by Perry R. Cook with updates by Gary Scavone, 1995--2014.
by Perry R. Cook with updates by Gary Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -13,7 +13,7 @@
- Envelope Rate = 11
- Gain = 128
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -9,7 +9,7 @@
The "table" length, set in SineWave.h, is 2048 samples by default.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -9,7 +9,7 @@
Within STK, it is used as an excitation source for other
instruments.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -13,7 +13,7 @@
Stanford, bearing the names of Karplus and/or
Strong.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -19,7 +19,7 @@
See also SKINI.txt.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -5,7 +5,7 @@
This class provides common functionality for TCP and UDP internet
socket server and client subclasses.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -5,7 +5,7 @@
This class implements a spherical ball with
radius, mass, position, and velocity parameters.
by Perry R. Cook, 1995--2014.
by Perry R. Cook, 1995--2016.
*/
/***************************************************/

View File

@@ -17,7 +17,7 @@
- String Sustain = 11
- String Stretch = 1
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -22,7 +22,7 @@
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

View File

@@ -10,7 +10,7 @@
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.
*/
/***************************************************/

View File

@@ -19,7 +19,7 @@
less than or equal to zero indicate a closed
or lost connection or the occurence of an error.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -19,7 +19,7 @@
less than or equal to zero indicate a closed
or lost connection or the occurence of an error.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -16,7 +16,7 @@
THREAD_RETURN THREAD_TYPE thread_function(void *ptr)
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -26,7 +26,7 @@
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.
*/
/***************************************************/

View File

@@ -17,7 +17,7 @@
use possibly subject to patents held by Stanford
University, Yamaha, and others.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -6,7 +6,7 @@
provided for creating a resonance in the frequency response while
maintaining a nearly constant filter gain.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -6,7 +6,7 @@
provided for creating a "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.
*/
/***************************************************/

View File

@@ -17,7 +17,7 @@
read/write methods. Values less than or equal to zero indicate
the occurence of an error.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -21,7 +21,7 @@
- Vibrato Gain = 1
- Loudness (Spectral Tilt) = 128
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -19,7 +19,7 @@
Alternately, control changes can be sent to all voices in a given
group.
by Perry R. Cook and Gary P. Scavone, 1995--2014.
by Perry R. Cook and Gary P. Scavone, 1995--2016.
*/
/***************************************************/

View File

@@ -12,7 +12,7 @@
- Blowing Frequency Modulation = 2
- Volume = 128
by Perry R. Cook 1995--2014.
by Perry R. Cook 1995--2016.
*/
/***************************************************/

View File

@@ -26,7 +26,7 @@
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.
*/
/***************************************************/