diff --git a/docs/PatchFormat/main.md b/docs/PatchFormat/main.md
index 48c5d2ef..e4fcab2c 100644
--- a/docs/PatchFormat/main.md
+++ b/docs/PatchFormat/main.md
@@ -389,14 +389,29 @@ The value should be the path to a javascript file that will be executed. This sc
# Exporting patches
-### Building a native VST or AudioUnit from a patch
+### Building a native CLAP from a patch
+
+The `cmaj` tool supports code-generation of a [CLAP](https://github.com/free-audio/clap) C++ project from a Cmajor patch. The project created is a pure static C++ project that doesn't perform any JIT compilation when it runs.
+
+To use this feature, run the command line app in `generate` mode, e.g.
+
+```
+% cmaj generate --target=clap
+ --output=[path to a target folder for the project]
+ --clapIncludePath=[path to your CLAP include folder]
+ MyAmazingPatch.cmajorpatch
+```
+
+It will create a folder containing some source files and a cmake project.
+
+### Building a native JUCE VST or AudioUnit from a patch
The `cmaj` tool supports code-generation of a JUCE C++ project that can be used to natively compile a VST/AudioUnit/AAX plugin for a patch. The resulting code doesn't do any JIT compilation, it simply translates the Cmajor code to pure C++ so that it can be built statically.
To use this feature, run the command line app in `generate` mode, e.g.
```
-% cmaj generate --target=plugin
+% cmaj generate --target=juce
--output=[path to a target folder for the project]
--jucePath=[path to your JUCE folder]
MyAmazingPatch.cmajorpatch
diff --git a/docs/PatchFormat/patch-guis/building-a-native-clap-from-a-patch.md b/docs/PatchFormat/patch-guis/building-a-native-clap-from-a-patch.md
new file mode 100644
index 00000000..a26b5c93
--- /dev/null
+++ b/docs/PatchFormat/patch-guis/building-a-native-clap-from-a-patch.md
@@ -0,0 +1,8 @@
+---
+layout: default
+title: Building a native CLAP from a patch
+permalink: /docs/PatchFormat#building-a-native-clap-from-a-patch
+parent: Patch GUIs
+grand_parent: Patch Format
+nav_order: 5
+---
diff --git a/docs/PatchFormat/patch-guis/building-a-native-juce-vst-or-audiounit-from-a-patch.md b/docs/PatchFormat/patch-guis/building-a-native-juce-vst-or-audiounit-from-a-patch.md
new file mode 100644
index 00000000..21e6b332
--- /dev/null
+++ b/docs/PatchFormat/patch-guis/building-a-native-juce-vst-or-audiounit-from-a-patch.md
@@ -0,0 +1,8 @@
+---
+layout: default
+title: Building a native JUCE VST or AudioUnit from a patch
+permalink: /docs/PatchFormat#building-a-native-juce-vst-or-audiounit-from-a-patch
+parent: Patch GUIs
+grand_parent: Patch Format
+nav_order: 6
+---
diff --git a/docs/PatchFormat/patch-guis/building-a-native-vst-or-audiounit-from-a-patch.md b/docs/PatchFormat/patch-guis/building-a-native-vst-or-audiounit-from-a-patch.md
deleted file mode 100644
index 2ce4fb37..00000000
--- a/docs/PatchFormat/patch-guis/building-a-native-vst-or-audiounit-from-a-patch.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-layout: default
-title: Building a native VST or AudioUnit from a patch
-permalink: /docs/PatchFormat#building-a-native-vst-or-audiounit-from-a-patch
-parent: Patch GUIs
-grand_parent: Patch Format
-nav_order: 5
----
diff --git a/docs/PatchFormat/patch-guis/building-a-web-audio-audioworkletnode-from-a-patch.md b/docs/PatchFormat/patch-guis/building-a-web-audio-audioworkletnode-from-a-patch.md
index 2b8caa14..21ae40ef 100644
--- a/docs/PatchFormat/patch-guis/building-a-web-audio-audioworkletnode-from-a-patch.md
+++ b/docs/PatchFormat/patch-guis/building-a-web-audio-audioworkletnode-from-a-patch.md
@@ -4,5 +4,5 @@ title: Building a Web Audio `AudioWorkletNode` from a patch
permalink: /docs/PatchFormat#building-a-web-audio-audioworkletnode-from-a-patch
parent: Patch GUIs
grand_parent: Patch Format
-nav_order: 6
+nav_order: 7
---
diff --git a/docs/StandardLibrary/main.html b/docs/StandardLibrary/main.html
index 8f807332..057b7e9e 100644
--- a/docs/StandardLibrary/main.html
+++ b/docs/StandardLibrary/main.html
@@ -22,29 +22,18 @@
std.audio_data
namespace std
-
The std namespace is the root for all the built-in Cmajor library code.
- It contains various child namespaces that group tasks into various sub-categories.
-
+
The std namespace is the root for all the built-in Cmajor library code. It contains various child namespaces that group tasks into various sub-categories.
These structures are useful for representing chunks of audio data with a
- known sample-rate. They're useful types when you're declaring an external
- variable which is going to hold audio file data or generated waveform data.
- Note that duck-typing is used for the types of externals which contain audio
- data, so you can use your own classes as long as they contain a couple of
- fields which can hold the frame data and a sample rate. If you need a struct
- for audio data with more than 2 channels, you can just declare your own type
- using an appropriately-sized vector for the frames.
-
+
These structures are useful for representing chunks of audio data with a known sample-rate. They're useful types when you're declaring an external variable which is going to hold audio file data or generated waveform data. Note that duck-typing is used for the types of externals which contain audio data, so you can use your own classes as long as they contain a couple of fields which can hold the frame data and a sample rate. If you need a struct for audio data with more than 2 channels, you can just declare your own type using an appropriately-sized vector for the frames.
Structs
struct Mono
-
Represents a chunk of mono floating-point audio data.
-
+
Represents a chunk of mono floating-point audio data.
Type
@@ -67,8 +56,7 @@
Structs
struct Stereo
-
Represents a chunk of stereo, interleaved floating-point audio data.
-
+
Represents a chunk of stereo, interleaved floating-point audio data.
This processor will play chunks of audio sample data with a speed ratio applied.
- It provides input events to set the audio data, speed ratio and other properties
- to control playback.
- The SampleContent type must be a struct containing a 'frames' member, which
- is an array of audio frames, and a 'sampleRate' member with the original rate
- of the audio data.
-
+
This processor will play chunks of audio sample data with a speed ratio applied. It provides input events to set the audio data, speed ratio and other properties to control playback. The SampleContent type must be a struct containing a 'frames' member, which is an array of audio frames, and a 'sampleRate' member with the original rate of the audio data.
A very minimal, fixed-length, attack-sustain-release envelope generator.
- This has fixed-length attach and release times. Given input events of NoteOn
- and NoteOff objects, it will emit a stream of output gain levels that can
- be used to attenuate a voice.
-
+
A very minimal, fixed-length, attack-sustain-release envelope generator. This has fixed-length attach and release times. Given input events of NoteOn and NoteOff objects, it will emit a stream of output gain levels that can be used to attenuate a voice.
The std::filters namespace is parameterised, allowing both the FrameType and the
- CoefficientType to be modified. By default the filters are float32, and hence use
- 32 bit precision, and filter frames of a single channel. FrameType can be specified as
- a vector to support more channels (e.g. float<2> for a stereo filter).
- For efficiency reasons, modulated parameters are not applied every frame, and the
- framesPerParameterUpdate parameter can be used to tune the frequency of updates.
- Each filter type is provided as both a Processor, which can be included in graphs, and
- as an Implementation structure, suitable for being composed into a user processor.
- The filter processors are parameterised with these parameters setting the initial state of
- the filter. Parameter modulation is provided by input events.
- The filter Implementation structure provides the following functions:
-
-
create() functions which construct an Implementation with the specified initial
- properties - this is the typical way that the structs are constructed
-
-
process() which generates an output frame from an input frame
-
-
setFrequency()/setMode() functions for filter parameters to allow the filter to be
- modified post construction.
-
-
reset() which clears out any internal state, returning it to the state post creation
-
+
The std::filters namespace is parameterised, allowing both the FrameType and the CoefficientType to be modified. By default the filters are float32, and hence use 32 bit precision, and filter frames of a single channel. FrameType can be specified as a vector to support more channels (e.g. float<2> for a stereo filter). For efficiency reasons, modulated parameters are not applied every frame, and the framesPerParameterUpdate parameter can be used to tune the frequency of updates. Each filter type is provided as both a Processor, which can be included in graphs, and as an Implementation structure, suitable for being composed into a user processor. The filter processors are parameterised with these parameters setting the initial state of the filter. Parameter modulation is provided by input events. The filter Implementation structure provides the following functions:
+
create() functions which construct an Implementation with the specified initial properties - this is the typical way that the structs are constructed
+
process() which generates an output frame from an input frame
+
setFrequency()/setMode() functions for filter parameters to allow the filter to be modified post construction.
+
reset() which clears out any internal state, returning it to the state post creation
Constants
@@ -385,8 +345,7 @@
Constants
-
Default values if not specified
-
+
Default values if not specified
@@ -435,23 +394,13 @@
Constants
namespace std::filters::tpt
-
These filters are based on the designs outlined in The Art of VA Filter Design
- by Vadim Zavalishin, with help from Will Pirkle in Virtual Analog Filter Implementation.
- The topology-preserving transform approach leads to designs where parameter
- modulation can be applied with minimal instability.
- Parameter changes are applied at a lower rate than processor.frequency to reduce
- computational cost, and the frames between updates can be altered using the
- framesPerParameterUpdate, smaller numbers causing more frequent updates.
-
+
These filters are based on the designs outlined in The Art of VA Filter Design by Vadim Zavalishin, with help from Will Pirkle in Virtual Analog Filter Implementation. The topology-preserving transform approach leads to designs where parameter modulation can be applied with minimal instability. Parameter changes are applied at a lower rate than processor.frequency to reduce computational cost, and the frames between updates can be altered using the framesPerParameterUpdate, smaller numbers causing more frequent updates.
namespace std::filters::tpt::onepole
-
One pole filter implementation providing low and high pass options.
- The frequency and mode can be updated at a frequency determined by
- framesPerParameterUpdate.
-
+
One pole filter implementation providing low and high pass options. The frequency and mode can be updated at a frequency determined by framesPerParameterUpdate.
Structs
struct Implementation
@@ -675,8 +624,7 @@
Constants
namespace std::filters::tpt::svf
-
State variable filter implementation, suitable for modulation.
-
+
State variable filter implementation, suitable for modulation.
Butterworth filter, built from cascaded tpt filters.
- The order is set at compile time, but the type and frequency can be modulated
- at runtime.
-
+
Butterworth filter, built from cascaded tpt filters. The order is set at compile time, but the type and frequency can be modulated at runtime.
Structs
struct Implementation
@@ -1400,11 +1340,7 @@
Constants
namespace std::filters::crossover
-
4th Order two band crossover filter
- This filter is implemented using the StateVariableFilter and outputs two
- streams which can be summed to produce a flat response. The crossover frequency
- can be modulated.
-
+
4th Order two band crossover filter This filter is implemented using the StateVariableFilter and outputs two streams which can be summed to produce a flat response. The crossover frequency can be modulated.
Structs
struct Implementation
@@ -1547,12 +1483,7 @@
Functions
namespace std::filters::simper
-
Simper filter
- This filter is based on the design by Andy Simper, and is an implementation
- of the State Variable filter providing many different operational modes.
- It is documented here:
- https://cytomic.com/files/dsp/SvfLinearTrapOptimised2.pdf
-
+
Simper filter This filter is based on the design by Andy Simper, and is an implementation of the State Variable filter providing many different operational modes. It is documented here: https://cytomic.com/files/dsp/SvfLinearTrapOptimised2.pdf
Contains DFT implementations for complex and real numbers
- The buffers can be either float32 or float64 (or complex32/complex64).
- Buffer sizes must be a power of 2.
-
+
Contains DFT implementations for complex and real numbers The buffers can be either float32 or float64 (or complex32/complex64). Buffer sizes must be a power of 2.
Functions
realOnlyForwardFFT
-
Performs a forward DFT.
- The parameters must be power-of-2 sized arrays of floats. The input parameter takes the real
- components, and the output array receives the real and imaginary components.
-
+
Performs a forward DFT. The parameters must be power-of-2 sized arrays of floats. The input parameter takes the real components, and the output array receives the real and imaginary components.
Performs an inverse FFT.
- The parameters must be power-of-2 sized arrays of floats. The input parameter takes the real
- and imaginary components, and the output array receives the real components.
-
+
Performs an inverse FFT. The parameters must be power-of-2 sized arrays of floats. The input parameter takes the real and imaginary components, and the output array receives the real components.
This namespace contains placeholders and reference implementations of basic functions.
- The compiler treats the intrinsics namespace as a special-case, allowing its
- functions to act as if they're in the global namespace.
- When running code, the JIT engines are free to replace the implementation of intrinsic
- functions with optimised alternatives if possible, although many of the functions in here
- also provide reference implementations to be used as a fallback when no native version
- is available.
-
+
This namespace contains placeholders and reference implementations of basic functions. The compiler treats the intrinsics namespace as a special-case, allowing its functions to act as if they're in the global namespace. When running code, the JIT engines are free to replace the implementation of intrinsic functions with optimised alternatives if possible, although many of the functions in here also provide reference implementations to be used as a fallback when no native version is available.
Functions
max
-
Compares two scalar or vector values and returns the maximum. For vector operands, this returns a vector of results for each element.
-
+
Compares two scalar or vector values and returns the maximum. For vector operands, this returns a vector of results for each element.
Tmax<T>(Tv1, Tv2)
min
-
Compares two scalar or vector values and returns the minimum. For vector operands, this returns a vector of results for each element.
-
+
Compares two scalar or vector values and returns the minimum. For vector operands, this returns a vector of results for each element.
Tmin<T>(Tv1, Tv2)
select
-
Uses a boolean vector to determine which elements from two other vectors should be combined into the result.
-
+
Uses a boolean vector to determine which elements from two other vectors should be combined into the result.
Returns a value which has been clamped to fit within the given range (inclusive of the top).
-
+
Returns a value which has been clamped to fit within the given range (inclusive of the top).
Tclamp<T>(Tvalue, Tminimum, Tmaximum)
wrap
-
Wraps a value to fit within a range, using a negative-aware modulo operation, and returning zero if the size is zero.
-
+
Wraps a value to fit within a range, using a negative-aware modulo operation, and returning zero if the size is zero.
Twrap<T>(Tvalue, Tsize)
wrap
-
Wraps a value to fit within a range, using a negative-aware modulo operation, and returning zero if the size is zero.
-
+
Wraps a value to fit within a range, using a negative-aware modulo operation, and returning zero if the size is zero.
int32wrap(int32value, int32size)
addModulo2Pi
-
Adds two floating-point values together, returning the result modulo 2*Pi.
- This is a common operation for tasks like incrementing the phase of an oscillator.
-
+
Adds two floating-point values together, returning the result modulo 2*Pi. This is a common operation for tasks like incrementing the phase of an oscillator.
TaddModulo2Pi<T>(TstartValue, TvalueToAdd)
abs
-
Returns the absolute value of a scalar or vector value.
-
+
Returns the absolute value of a scalar or vector value.
Tabs<T>(Tn)
floor
-
Returns the largest integer not greater than the argument. This follows the same rules as the standard C/C++ std::floor() function.
-
+
Returns the largest integer not greater than the argument. This follows the same rules as the standard C/C++ std::floor() function.
Tfloor<T>(Tn)
ceil
-
Returns the smallest integer not less than the argument. This follows the same rules as the standard C/C++ std::ceil() function.
-
+
Returns the smallest integer not less than the argument. This follows the same rules as the standard C/C++ std::ceil() function.
Tceil<T>(Tn)
rint
-
Rounds the argument to an integer value. This follows the same rules as the standard C/C++ std::rint() function.
-
+
Rounds the argument to an integer value. This follows the same rules as the standard C/C++ std::rint() function.
Trint<T>(Tn)
fmod
-
Returns the floating point modulo operation of its arguments. This follows the same rules as the standard C/C++ std::fmod() function.
-
+
Returns the floating point modulo operation of its arguments. This follows the same rules as the standard C/C++ std::fmod() function.
Tfmod<T>(Tx, Ty)
remainder
-
Returns the floating remainder of its arguments. This follows the same rules as the standard C/C++ std::remainder() function.
-
+
Returns the floating remainder of its arguments. This follows the same rules as the standard C/C++ std::remainder() function.
Tremainder<T>(Tx, Ty)
lerp
-
Performs a linear-interpolation between a pair of scalar values.
-
+
Performs a linear-interpolation between a pair of scalar values.
Tlerp<T>(Tvalue1, Tvalue2, float32proportion)
roundToInt
-
Returns the nearest integer to a floating point value.
-
+
Returns the nearest integer to a floating point value.
int32roundToInt(float32value)
roundToInt
-
Returns the nearest integer to a floating point value.
-
+
Returns the nearest integer to a floating point value.
int64roundToInt(float64value)
sqrt
-
Returns the square root of its argument.
-
+
Returns the square root of its argument.
Tsqrt<T>(Tn)
pow
-
Raises a value to the given power.
-
+
Raises a value to the given power.
Tpow<T>(Ta, Tb)
exp
-
Returns the exponent of a scalar floating-point argument.
-
+
Returns the exponent of a scalar floating-point argument.
Texp<T>(Tn)
exp
-
Returns the exponent of a complex number.
-
+
Returns the exponent of a complex number.
complex32exp(complex32n)
exp
-
Returns the exponent of a complex number.
-
+
Returns the exponent of a complex number.
complex64exp(complex64n)
log
-
Returns the natural log of a scalar floating point argument.
-
+
Returns the natural log of a scalar floating point argument.
Tlog<T>(Tn)
log10
-
Returns the base-10 log of a scalar floating point argument.
-
+
Returns the base-10 log of a scalar floating point argument.
Tlog10<T>(Tn)
isinf
-
Checks whether the supplied argument is a floating point INF.
-
+
Checks whether the supplied argument is a floating point INF.
boolisinf<FloatType>(FloatTypevalue)
isnan
-
Checks whether the supplied argument is a floating point NaN.
-
+
Checks whether the supplied argument is a floating point NaN.
boolisnan<FloatType>(FloatTypevalue)
reinterpretFloatToInt
-
Reinterprets the raw bits of a 32-bit float as an integer.
-
+
Reinterprets the raw bits of a 32-bit float as an integer.
int32reinterpretFloatToInt(float32value)
reinterpretFloatToInt
-
Reinterprets the raw bits of a 64-bit float as an integer.
-
+
Reinterprets the raw bits of a 64-bit float as an integer.
int64reinterpretFloatToInt(float64value)
reinterpretIntToFloat
-
Reinterprets the bits of a 32-bit integer as a float32.
-
+
Reinterprets the bits of a 32-bit integer as a float32.
float32reinterpretIntToFloat(int32value)
reinterpretIntToFloat
-
Reinterprets the bits of a 64-bit integer as a float64.
-
+
Reinterprets the bits of a 64-bit integer as a float64.
float64reinterpretIntToFloat(int64value)
sum
-
Calculates the sum of the elements in a vector or array.
-
+
Calculates the sum of the elements in a vector or array.
Returns an element from an array.
- The index is a generic parameter, and can be either an integer or a float value. If you
- provide a float index, then it'll round it down to the nearest integer and use that.
- If the index lies beyond the range of the array, it will be wrapped.
-
+
Returns an element from an array. The index is a generic parameter, and can be either an integer or a float value. If you provide a float index, then it'll round it down to the nearest integer and use that. If the index lies beyond the range of the array, it will be wrapped.
Linearly-interpolates a value at a position in an array.
- The first argument must be an array of floating point (or vector float) values, and the
- index provided should be a floating point value. This will interpolate between adjacent
- elements in the array to calculate the return value.
- If the index lies beyond the range of the array, it will be wrapped.
-
+
Linearly-interpolates a value at a position in an array. The first argument must be an array of floating point (or vector float) values, and the index provided should be a floating point value. This will interpolate between adjacent elements in the array to calculate the return value. If the index lies beyond the range of the array, it will be wrapped.
Utilities for calculating and applying smoothing ramps and gain levels.
- The std::smoothing namespace is parameterised. FrameType defaults to float32,
- but can be specified to allow support for different precision types (e.g. float64)
- as well as smoothed values for multi-channel use (e.g. float32<2>)
-
+
Utilities for calculating and applying smoothing ramps and gain levels. The std::smoothing namespace is parameterised. FrameType defaults to float32, but can be specified to allow support for different precision types (e.g. float64) as well as smoothed values for multi-channel use (e.g. float32<2>)
Structs
struct SmoothedValue
-
Utilities for smoothing non-audio signals, such as control parameters.
- Holds a float value and is given a target to move towards over a given time.
- Call setTarget() to tell the object where to go and how many steps to take
- to get there, then repeatedly call getNext() to iterate to the target.
-
+
Utilities for smoothing non-audio signals, such as control parameters. Holds a float value and is given a target to move towards over a given time. Call setTarget() to tell the object where to go and how many steps to take to get there, then repeatedly call getNext() to iterate to the target.
Type
@@ -2512,8 +2359,7 @@
Structs
Functions
reset
-
Immediately resets the value to the given argument
-
+
Immediately resets the value to the given argument
Takes an input that receives floating point events, and produces a continuous
- output stream of floats which are smoothed by a specified amount.
- This is handy for smoothing plugin parameters
-
+
Takes an input that receives floating point events, and produces a continuous output stream of floats which are smoothed by a specified amount. This is handy for smoothing plugin parameters
Returns the dot-product of two 2-dimensional arrays.
- (The dot product for 2D arrays is the same as a matrix multiplication).
-
+
Returns the dot-product of two 2-dimensional arrays. (The dot product for 2D arrays is the same as a matrix multiplication).
ElementType[n, m]dot<ElementType, n, m, k>(ElementType[n, k]a, ElementType[k, m]b)
inverse
-
Returns the inverse of the input 2-dimensional array.
- If no inverse is possible, it returns an empty array.
- This algorithm uses the Gaussian elimination method to calculate the inverse.
-
+
Returns the inverse of the input 2-dimensional array. If no inverse is possible, it returns an empty array. This algorithm uses the Gaussian elimination method to calculate the inverse.
The classes in the standard library which deal with synthesisers have been designed
- to avoid raw MIDI messages, and instead to work with strongly-typed event objects
- for note-ons/offs, pitch-bends, etc, which are vastly more usable than a 3-byte
- code that was designed for a 1980s serial link.
-
+
The classes in the standard library which deal with synthesisers have been designed to avoid raw MIDI messages, and instead to work with strongly-typed event objects for note-ons/offs, pitch-bends, etc, which are vastly more usable than a 3-byte code that was designed for a 1980s serial link.
Structs
struct Message
-
Holds a short (3-byte) MIDI message.
-
+
Holds a short (3-byte) MIDI message.
Type
@@ -2934,10 +2740,7 @@
Structs
message
-
This contains 3 packed bytes, arranged as (byte2 | (byte1 << 8) | (byte0 << 16)).
- This layout means that when you view the value in hex in your debugger, it reads in
- the natural order for a MIDI message.
-
+
This contains 3 packed bytes, arranged as (byte2 | (byte1 << 8) | (byte0 << 16)). This layout means that when you view the value in hex in your debugger, it reads in the natural order for a MIDI message.
@@ -3214,8 +3017,7 @@
Functions
createMessage
-
Creates a short MIDI message object from the raw bytes
-
+
Creates a short MIDI message object from the raw bytes
Accepts an input stream of raw MIDI MPE events and converts them to a stream
- of note event objects which can be more easily used by synthesiser classes.
-
+
Accepts an input stream of raw MIDI MPE events and converts them to a stream of note event objects which can be more easily used by synthesiser classes.
Endpoints
@@ -3316,9 +3114,7 @@
Functions
processor std::midi::NoteToMIDI
-
Accepts an input of note events, and converts them to a stream of short
- midi messages.
-
+
Accepts an input of note events, and converts them to a stream of short midi messages.
Takes two input streams and two gain streams which it uses to attenuate the
- inputs. Their result is then emitted.
- FrameType can be a float or float vector type.
-
+
Takes two input streams and two gain streams which it uses to attenuate the inputs. Their result is then emitted. FrameType can be a float or float vector type.
Takes two input streams and outputs a dynamic mix of their values, using a third
- stream to control the mix.
- mixRange determines the range of values that the mix stream will take. So the
- mix input is expected to be between 0 and mixRange, where mix = 0 will cause 100% of
- in1 to be emitted, and mix = mixRange will cause 100% of in2 to be emitted.
- This processor is handy as a wet/dry mixer - for example you could connect a dry
- stream to in1, a wet stream to in2, and set mixRange to 100. Then, the mix input
- will act as a "percentage wet" control.
-
+
Takes two input streams and outputs a dynamic mix of their values, using a third stream to control the mix. mixRange determines the range of values that the mix stream will take. So the mix input is expected to be between 0 and mixRange, where mix = 0 will cause 100% of in1 to be emitted, and mix = mixRange will cause 100% of in2 to be emitted. This processor is handy as a wet/dry mixer - for example you could connect a dry stream to in1, a wet stream to in2, and set mixRange to 100. Then, the mix input will act as a "percentage wet" control.
These structs are used for events that model the start/stop/control of notes
- that are playing in synthesisers.
- Unlike sending raw MIDI around, these are strongly typed and use floating point
- data so are far nicer to work with.
- The objects include a channel ID field, so that a multi-channel input device can
- indicate which events should be applied to each of the active notes that are
- being played.
-
+
These structs are used for events that model the start/stop/control of notes that are playing in synthesisers. Unlike sending raw MIDI around, these are strongly typed and use floating point data so are far nicer to work with. The objects include a channel ID field, so that a multi-channel input device can indicate which events should be applied to each of the active notes that are being played.
Structs
struct NoteOn
@@ -3876,11 +3638,7 @@
Structs
channel
-
This channel ID is used to associate events which act on a particular voice.
- When a NoteOn object is sent, the sender will create a unique ID, and
- use the same ID for any subsequent pitch and control events, and for the
- final matching NoteOff event.
-
+
This channel ID is used to associate events which act on a particular voice. When a NoteOn object is sent, the sender will create a unique ID, and use the same ID for any subsequent pitch and control events, and for the final matching NoteOff event.
@@ -3890,9 +3648,7 @@
Structs
pitch
-
The pitch uses the same semitone scale as MIDI note numbers, between
- 0 and 127, where middle C = 60.
-
+
The pitch uses the same semitone scale as MIDI note numbers, between 0 and 127, where middle C = 60.
@@ -3902,8 +3658,7 @@
Structs
velocity
-
Velocity is between 0 and 1
-
+
Velocity is between 0 and 1
@@ -3922,9 +3677,7 @@
Structs
channel
-
This channel ID can be used to associate this NoteOff event with the earlier
- NoteOn to which it applies.
-
+
This channel ID can be used to associate this NoteOff event with the earlier NoteOn to which it applies.
@@ -3934,9 +3687,7 @@
Structs
pitch
-
You may not care exactly what the pitch is when a note is released, but
- in case it's needed, it's included here.
-
+
You may not care exactly what the pitch is when a note is released, but in case it's needed, it's included here.
@@ -3946,8 +3697,7 @@
Structs
velocity
-
Indicates how quickly the key was released: range is 0 to 1.
-
+
Indicates how quickly the key was released: range is 0 to 1.
@@ -3966,9 +3716,7 @@
Structs
channel
-
This channel ID can be used to associate this event with the earlier
- NoteOn to which it applies.
-
+
This channel ID can be used to associate this event with the earlier NoteOn to which it applies.
@@ -3978,8 +3726,7 @@
Structs
bendSemitones
-
The number of semitones to bend up from the original note-on pitch.
-
+
The number of semitones to bend up from the original note-on pitch.
@@ -3998,9 +3745,7 @@
Structs
channel
-
This channel ID can be used to associate this event with the earlier
- NoteOn to which it applies.
-
+
This channel ID can be used to associate this event with the earlier NoteOn to which it applies.
@@ -4010,8 +3755,7 @@
Structs
pressure
-
Key pressure is in the range 0 to 1
-
+
Key pressure is in the range 0 to 1
@@ -4019,9 +3763,7 @@
Structs
struct Slide
-
"Slide" refers to a Y-axis controller parameter.
- (In MPE input devices, this is a MIDI controller number 74)
-
+
"Slide" refers to a Y-axis controller parameter. (In MPE input devices, this is a MIDI controller number 74)
Type
@@ -4033,9 +3775,7 @@
Structs
channel
-
This channel ID can be used to associate this event with the earlier
- NoteOn to which it applies.
-
+
This channel ID can be used to associate this event with the earlier NoteOn to which it applies.
@@ -4045,9 +3785,7 @@
Structs
slide
-
The slide position ranges from 0 to 1. Exactly what you choose to do
- with it depends on the instrument.
-
+
The slide position ranges from 0 to 1. Exactly what you choose to do with it depends on the instrument.
@@ -4066,9 +3804,7 @@
Structs
channel
-
This channel ID can be used to associate this event with the earlier
- NoteOn to which it applies.
-
+
This channel ID can be used to associate this event with the earlier NoteOn to which it applies.
@@ -4078,9 +3814,7 @@
Structs
control
-
This could be used for any kind of controller index, but is probably
- best used for MIDI controller numbers.
-
+
This could be used for any kind of controller index, but is probably best used for MIDI controller numbers.
@@ -4090,8 +3824,7 @@
Structs
value
-
The normalised value of the controller, between 0 and 1
-
+
The normalised value of the controller, between 0 and 1
@@ -4102,62 +3835,42 @@
Structs
Functions
frequencyToNote
-
Returns the MIDI note equivalent for a frequency in Hz.
- This uses the standard A = 440Hz reference tuning.
- See: noteToFrequency
-
+
Returns the MIDI note equivalent for a frequency in Hz. This uses the standard A = 440Hz reference tuning. See: noteToFrequency
float32frequencyToNote(float32frequency)
frequencyToNote
-
Returns the MIDI note equivalent for a frequency in Hz.
- The frequencyOfA parameter lets you use non-standard tunings if you need to.
- See: noteToFrequency
-
+
Returns the MIDI note equivalent for a frequency in Hz. The frequencyOfA parameter lets you use non-standard tunings if you need to. See: noteToFrequency
Returns the frequency in Hz for a MIDI note number.
- You can provide either an integer or floating point argument - the MIDI
- note scale is in semitone units from 0 to 127, where middle C = 60.
- This uses the standard A = 440Hz reference tuning.
- See: frequencyToNote
-
+
Returns the frequency in Hz for a MIDI note number. You can provide either an integer or floating point argument - the MIDI note scale is in semitone units from 0 to 127, where middle C = 60. This uses the standard A = 440Hz reference tuning. See: frequencyToNote
float32noteToFrequency<T>(TmidiNoteNumber)
noteToFrequency
-
Returns the frequency in Hz for a MIDI note number.
- You can provide either an integer or floating point argument - the MIDI
- note scale is in semitone units from 0 to 127, where middle C = 60.
- The frequencyOfA parameter lets you use non-standard tunings if you need to.
- See: frequencyToNote
-
+
Returns the frequency in Hz for a MIDI note number. You can provide either an integer or floating point argument - the MIDI note scale is in semitone units from 0 to 127, where middle C = 60. The frequencyOfA parameter lets you use non-standard tunings if you need to. See: frequencyToNote
Given a source with a known sample rate and pitch, this calculates the ratio at which
- it would need to be sped-up in order to achieve a target pitch and sample-rate.
-
+
Given a source with a known sample rate and pitch, this calculates the ratio at which it would need to be sped-up in order to achieve a target pitch and sample-rate.
A processor which generates a unipolar ramp, and has an input to control its frequency.
- The FrameType parameter could be a float or a float vector.
-
+
A processor which generates a unipolar ramp, and has an input to control its frequency. The FrameType parameter could be a float or a float vector.
If you're writing code that needs to be cryptographically secure, then this is not the
- random number generation library that you want. The target audience for these classes
- are those who need quick-and-dirty RNGs for noise generation and similar non-critical
- tasks.
- When seeding RNGs, the processor.id and processor.session values are very useful:
-
-
processor.id is different for each instance of a processor, but the same for each
- run of the program. If you have multiple instances of a processor node which each
- have an RNG, then if you seed them with a value based on processor.id, they'll
- each use a different stream of values, but the sequences will be the same each time
- the program runs.
-
+
If you're writing code that needs to be cryptographically secure, then this is not the random number generation library that you want. The target audience for these classes are those who need quick-and-dirty RNGs for noise generation and similar non-critical tasks. When seeding RNGs, the processor.id and processor.session values are very useful:
+
processor.id is different for each instance of a processor, but the same for each run of the program. If you have multiple instances of a processor node which each have an RNG, then if you seed them with a value based on processor.id, they'll each use a different stream of values, but the sequences will be the same each time the program runs.
-
processor.session is the same for all processors, but different each time the
- program runs, so if you use it as part of your seed, it'll make the program
- behave differently each time.
-
+
processor.session is the same for all processors, but different each time the program runs, so if you use it as part of your seed, it'll make the program behave differently each time.
This namespace contains various types and functions for dealing with tempos,
- positions and events that describe DAW-style timelines.
-
+
This namespace contains various types and functions for dealing with tempos, positions and events that describe DAW-style timelines.
Structs
struct Tempo
@@ -5134,8 +4796,7 @@
Structs
bpm
-
BPM = beats per minute :)
-
+
BPM = beats per minute :)
@@ -5165,10 +4826,7 @@
Structs
struct TransportState
-
Indicates whether a host is currently playing or recording.
- This struct is intended for purposes like sending as an event into a plugin
- to tell it when the host's playback state changes.
-
+
Indicates whether a host is currently playing or recording. This struct is intended for purposes like sending as an event into a plugin to tell it when the host's playback state changes.
Type
@@ -5180,11 +4838,7 @@
Structs
flags
-
This is used as a bit-field, where
- bit 0 = playing
- bit 1 = recording
- bit 2 = looping
-
+
This is used as a bit-field, where bit 0 = playing bit 1 = recording bit 2 = looping
@@ -5192,9 +4846,7 @@
Structs
struct Position
-
This struct holds data that a host may want to send as an event to a plugin to
- update it with various measurements of positions along its timeline.
-
+
This struct holds data that a host may want to send as an event to a plugin to update it with various measurements of positions along its timeline.
Type
@@ -5206,8 +4858,7 @@
Structs
frameIndex
-
The frame index, from the start of the host's timeline.
-
+
The frame index, from the start of the host's timeline.
@@ -5217,9 +4868,7 @@
Structs
quarterNote
-
A floating-point count of quarter-notes from the start of the host's timeline.
- If a host doesn't count time in terms of beats, then this could be left as 0.
-
+
A floating-point count of quarter-notes from the start of the host's timeline. If a host doesn't count time in terms of beats, then this could be left as 0.
@@ -5229,12 +4878,7 @@
Structs
barStartQuarterNote
-
The position of the start of the current bar, measured as the number of
- quarter-notes from the start of the host's timeline.
- If a host doesn't count time in terms of beats, then this could be left as 0.
- This is useful in conjunction with quarterNote if you need to know e.g. how many
- beats you are into the current bar.
-
+
The position of the start of the current bar, measured as the number of quarter-notes from the start of the host's timeline. If a host doesn't count time in terms of beats, then this could be left as 0. This is useful in conjunction with quarterNote if you need to know e.g. how many beats you are into the current bar.
This module demonstrates a simple voice-allocation algorithm.
- The way it's structured is that you pass an incoming stream of note events to
- the voice allocator processor, and it redirects them to an array of destination
- processors which each handle a single voice.
- The voice allocators use the channel property of the incoming events to group
- them together, and take care of ensuring that each target voice only receives
- the events from one channel at a time.
-
+
This module demonstrates a simple voice-allocation algorithm. The way it's structured is that you pass an incoming stream of note events to the voice allocator processor, and it redirects them to an array of destination processors which each handle a single voice. The voice allocators use the channel property of the incoming events to group them together, and take care of ensuring that each target voice only receives the events from one channel at a time.
A basic least-recently-used voice allocator.
- If there's an inactive voice, then a new note will be assigned to it,
- otherwise it will steal the least-recently-used active voice. For more
- fancy note-stealing algorithms, you can use this as an example and add
- your own logic!
-
+
A basic least-recently-used voice allocator. If there's an inactive voice, then a new note will be assigned to it, otherwise it will steal the least-recently-used active voice. For more fancy note-stealing algorithms, you can use this as an example and add your own logic!
Endpoints
@@ -5532,8 +5164,7 @@
Functions
isSustainActive
-
one per bit (assumes that channel IDs are <64, and could be made more general)
-
+
one per bit (assumes that channel IDs are <64, and could be made more general)
The
stdnamespace is the root for all the built-in Cmajor library code. -It contains various child namespaces that group tasks into various sub-categories. -