DSP Functions

Superpowered offers some general purpose efficient DSP functions to use throughout your projects. These include:

Applying volume of an audio buffer (gain).
Changing volume of an audio buffer with a smooth ramp.
Mixing audio to existing audio in a buffer (with or without changing volume).
Crossfading audio between two buffers.
Getting the peak absolute audio sample value in a buffer.
Converting 32-bit, 24-bit and 16-bit audio in floating point or signed integer formats.
Interleaving or de-interleaving.

Please a look at the list of functions available to find the tool you need.

Add1
METHOD
Adds the values in input to the values in output: output[n] += input[n].
Parameters
Name Type Description
input Number (pointer in Linear Memory) Input data.
output Number (pointer in Linear Memory) Output data.
numberOfItems Number The length of input.
Returns
None
Add1
METHOD
Adds the values in input to the values in output: output[n] += input[n].
Parameters
Name Type Default Description
input float * Input data.
output float * Output data.
numberOfItems unsigned int The length of input.
Returns
None

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Input data.
output	`Number (pointer in Linear Memory)`	Output data.
numberOfItems	`Number`	The length of input.

Name	Type	Description
input	`float *`	Input data.
output	`float *`	Output data.
numberOfItems	`unsigned int`	The length of input.

Add2

METHOD

Adds the values in two inputs to the values in output: output[n] += inputA[n] + inputB[n].

Parameters

Name	Type	Description
inputA	`Number (pointer in Linear Memory)`	Input data.
inputB	`Number (pointer in Linear Memory)`	Input data.
output	`Number (pointer in Linear Memory)`	Output data.
numberOfItems	`Number`	The length of input.

Returns

None

Add2
METHOD
Adds the values in two inputs to the values in output: output[n] += inputA[n] + inputB[n].
Parameters
Name Type Default Description
inputA float * Input data.
inputB float * Input data.
output float * Output data.
numberOfItems unsigned int The length of input.
Returns
None

Name	Type	Description
inputA	`float *`	Input data.
inputB	`float *`	Input data.
output	`float *`	Output data.
numberOfItems	`unsigned int`	The length of input.

Add4

METHOD

Adds the values in four inputs to the values in output: output[n] += inputA[n] + inputB[n] + inputC[n] + inputD[n].

Parameters

Name	Type	Description
inputA	`Number (pointer in Linear Memory)`	Input data.
inputB	`Number (pointer in Linear Memory)`	Input data.
inputC	`Number (pointer in Linear Memory)`	Input data.
inputD	`Number (pointer in Linear Memory)`	Input data.
output	`Number (pointer in Linear Memory)`	Output data.
numberOfItems	`Number`	The length of input.

Returns

None

Add4
METHOD
Adds the values in four inputs to the values in output: output[n] += inputA[n] + inputB[n] + inputC[n] + inputD[n].
Parameters
Name Type Default Description
inputA float * Input data.
inputB float * Input data.
inputC float * Input data.
inputD float * Input data.
output float * Output data.
numberOfItems unsigned int The length of input.
Returns
None

Name	Type	Description
inputA	`float *`	Input data.
inputB	`float *`	Input data.
inputC	`float *`	Input data.
inputD	`float *`	Input data.
output	`float *`	Output data.
numberOfItems	`unsigned int`	The length of input.

Bit24ToFloat

METHOD

Converts 24-bit audio to 32-bit floating point.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	24-bit input.
output	`Number (pointer in Linear Memory)`	32-bit output.
numberOfFrames	`Number`	The number of frames to process.
numberOfChannels	`Number`	The number of channels.

Returns

None

Bit24ToFloat
METHOD
Converts 24-bit audio to 32-bit floating point.
Parameters
Name Type Default Description
input void * 24-bit input.
output float * 32-bit output.
numberOfFrames unsigned int The number of frames to process.
numberOfChannels unsigned int 2 The number of channels.
Returns
None

Name	Type	Default	Description
input	`void *`		24-bit input.
output	`float *`		32-bit output.
numberOfFrames	`unsigned int`		The number of frames to process.
numberOfChannels	`unsigned int`	2	The number of channels.

ChangeVolume

METHOD

Applies volume on a single stereo interleaved buffer: output = input * gain.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit interleaved stereo input.
output	`Number (pointer in Linear Memory)`	32-bit interleaved stereo output. Can be equal to input (in-place processing).
volumeStart	`Number`	Volume for the first frame.
volumeChange	`Number`	Change volume by this amount for every frame.
numberOfFrames	`Number`	Number of frames to process.

Returns

None

ChangeVolume

METHOD

Applies volume on a single stereo interleaved buffer: output = input * gain.

Parameters

Name	Type	Description
input	`float *`	32-bit interleaved stereo input.
output	`float *`	32-bit interleaved stereo output. Can be equal to input (in-place processing).
volumeStart	`float`	Volume for the first frame.
volumeChange	`float`	Change volume by this amount for every frame.
numberOfFrames	`unsigned int`	Number of frames to process.

Returns

None

ChangeVolumeAdd

METHOD

Applies volume on a single stereo interleaved buffer and adds it to the audio in the output buffer: output = output + input * gain.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit interleaved stereo input.
output	`Number (pointer in Linear Memory)`	32-bit interleaved stereo output. Can be equal to input (in-place processing).
volumeStart	`Number`	Volume for the first frame.
volumeChange	`Number`	Change volume by this amount for every frame.
numberOfFrames	`Number`	Number of frames to process.

Returns

None

ChangeVolumeAdd

METHOD

Applies volume on a single stereo interleaved buffer and adds it to the audio in the output buffer: output = output + input * gain.

Parameters

Name	Type	Description
input	`float *`	32-bit interleaved stereo input.
output	`float *`	32-bit interleaved stereo output. Can be equal to input (in-place processing).
volumeStart	`float`	Volume for the first frame.
volumeChange	`float`	Change volume by this amount for every frame.
numberOfFrames	`Number`	Number of frames to process.

Returns

None

CharToFloat

METHOD

Converts 8-bit audio to 32-bit floating point.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	8-bit input.
output	`Number (pointer in Linear Memory)`	32-bit output.
numberOfFrames	`Number`	The number of frames to process.
numberOfChannels	`Number`	The number of channels.

Returns

None

CharToFloat
METHOD
Converts 8-bit audio to 32-bit floating point.
Parameters
Name Type Default Description
input signed char * 8-bit input.
output float * 32-bit output.
numberOfFrames unsigned int The number of frames to process.
numberOfChannels unsigned int 2 The number of channels.
Returns
None

Name	Type	Default	Description
input	`signed char *`		8-bit input.
output	`float *`		32-bit output.
numberOfFrames	`unsigned int`		The number of frames to process.
numberOfChannels	`unsigned int`	2	The number of channels.

CopyMonoFromInterleaved

METHOD

Copy mono audio from an interleaved buffer.

Parameters

Name	Type	Description
interleavedInput	`Number (pointer in Linear Memory)`	Interleaved input.
numInterleavedChannels	`Number`	The total number of channels in the interleaved input.
monoOutput	`Number (pointer in Linear Memory)`	Mono output.
channelIndex	`Number`	Copy this channel.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

CopyMonoFromInterleaved

METHOD

Copy mono audio from an interleaved buffer.

Parameters

Name	Type	Description
interleavedInput	`float *`	Interleaved input.
numInterleavedChannels	`unsigned int`	The total number of channels in the interleaved input.
monoOutput	`float *`	Mono output.
channelIndex	`unsigned int`	Copy this channel.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

CopyMonoToInterleaved

METHOD

Copy a mono channel into an interleaved buffer.

Parameters

Name	Type	Description
monoInput	`Number (pointer in Linear Memory)`	Mono input.
channelIndex	`Number`	Copy to this channel.
interleavedOutput	`Number (pointer in Linear Memory)`	Interleaved output.
numInterleavedChannels	`Number`	The total number of channels in the interleaved output.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

CopyMonoToInterleaved

METHOD

Copy a mono channel into an interleaved buffer.

Parameters

Name	Type	Description
monoInput	`float *`	Mono input.
channelIndex	`unsigned int`	Copy to this channel.
interleavedOutput	`float *`	Interleaved output.
numInterleavedChannels	`unsigned int`	The total number of channels in the interleaved output.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

CopyStereoFromInterleaved

METHOD

Copy stereo audio from an interleaved buffer.

Parameters

Name	Type	Description
interleavedInput	`Number (pointer in Linear Memory)`	Interleaved input.
numInterleavedChannels	`Number`	The total number of channels in the interleaved input.
stereoOutput	`Number (pointer in Linear Memory)`	Stereo interleaved output.
channelIndex	`Number`	Copy this channel. channelIndex is the left side, channelIndex + 1 is the right side.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

CopyStereoFromInterleaved

METHOD

Copy stereo audio from an interleaved buffer.

Parameters

Name	Type	Description
interleavedInput	`float *`	Interleaved input.
numInterleavedChannels	`unsigned int`	The total number of channels in the interleaved input.
stereoOutput	`float *`	Stereo interleaved output.
channelIndex	`unsigned int`	Copy this channel. channelIndex is the left side, channelIndex + 1 is the right side.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

CopyStereoToInterleaved

METHOD

Copy interleaved stereo into an interleaved buffer.

Parameters

Name	Type	Description
stereoInput	`Number (pointer in Linear Memory)`	Stereo interleaved input.
channelIndex	`Number`	Copy to this channel pair. eg with 2: left channel goes to 2, right channel goes to 2 + 1.
interleavedOutput	`Number (pointer in Linear Memory)`	Interleaved output.
numInterleavedChannels	`Number`	The total number of channels in the interleaved output.
numberOfFrames	`Number`	The number of frames to process.
multiplier	`Number`	Multiply the output with this number (constant volume).

Returns

None

CopyStereoToInterleaved

METHOD

Copy interleaved stereo into an interleaved buffer.

Parameters

Name	Type	Description
stereoInput	`float *`	Stereo interleaved input.
channelIndex	`unsigned int`	Copy to this channel pair. eg with 2: left channel goes to 2, right channel goes to 2 + 1.
interleavedOutput	`float *`	Interleaved output.
numInterleavedChannels	`unsigned int`	The total number of channels in the interleaved output.
numberOfFrames	`unsigned int`	The number of frames to process.
multiplier	`float`	Multiply the output with this number (constant volume).

Returns

None

CrossMono

METHOD

Crossfades two mono input channels into a mono output: output = inputA * gain + inputB + gain.

Parameters

Name	Type	Description
inputA	`Number (pointer in Linear Memory)`	First mono input.
inputB	`Number (pointer in Linear Memory)`	Second mono input.
output	`Number (pointer in Linear Memory)`	Mono output. Can be equal with one of the inputs (in-place processing).
inputAGainStart	`Number`	Gain of the first sample on the first input.
inputAGainEnd	`Number`	Gain for the last sample on the first input. Gain will be smoothly calculated between start and end.
inputBGainStart	`Number`	Gain of the first sample on the second input.
inputBGainEnd	`Number`	Gain for the last sample on the second input. Gain will be smoothly calculated between start and end.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

CrossMono

METHOD

Crossfades two mono input channels into a mono output: output = inputA * gain + inputB + gain.

Parameters

Name	Type	Description
inputA	`float *`	First mono input.
inputB	`float *`	Second mono input.
output	`float *`	Mono output. Can be equal with one of the inputs (in-place processing).
inputAGainStart	`float`	Gain of the first sample on the first input.
inputAGainEnd	`float`	Gain for the last sample on the first input. Gain will be smoothly calculated between start and end.
inputBGainStart	`float`	Gain of the first sample on the second input.
inputBGainEnd	`float`	Gain for the last sample on the second input. Gain will be smoothly calculated between start and end.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

CrossStereo

METHOD

Crossfades two stereo inputs into a stereo output: output = inputA * gain + inputB + gain.

Parameters

Name	Type	Description
inputA	`Number (pointer in Linear Memory)`	First stereo input.
inputB	`Number (pointer in Linear Memory)`	Second stereo input.
output	`Number (pointer in Linear Memory)`	Stereo output. Can be equal with one of the inputs (in-place processing).
inputAGainStart	`Number`	Gain of the first sample on the first input.
inputAGainEnd	`Number`	Gain for the last sample on the first input. Gain will be smoothly calculated between start and end.
inputBGainStart	`Number`	Gain of the first sample on the second input.
inputBGainEnd	`Number`	Gain for the last sample on the second input. Gain will be smoothly calculated between start and end.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

CrossStereo

METHOD

Crossfades two stereo inputs into a stereo output: output = inputA * gain + inputB + gain.

Parameters

Name	Type	Description
inputA	`float *`	First stereo input.
inputB	`float *`	Second stereo input.
output	`float *`	Stereo output. Can be equal with one of the inputs (in-place processing).
inputAGainStart	`float`	Gain of the first sample on the first input.
inputAGainEnd	`float`	Gain for the last sample on the first input. Gain will be smoothly calculated between start and end.
inputBGainStart	`float`	Gain of the first sample on the second input.
inputBGainEnd	`float`	Gain for the last sample on the second input. Gain will be smoothly calculated between start and end.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

DeInterleave

METHOD

Deinterleaves an interleaved stereo input to two mono output channels: left = [L, L, L, L, ...], right = [R, R, R, R, ...].

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Stereo interleaved input.
left	`Number (pointer in Linear Memory)`	Mono output for left channel.
right	`Number (pointer in Linear Memory)`	Mono output for right channel.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

DeInterleave

METHOD

Deinterleaves an interleaved stereo input to two mono output channels: left = [L, L, L, L, ...], right = [R, R, R, R, ...].

Parameters

Name	Type	Description
input	`float *`	Stereo interleaved input.
left	`float *`	Mono output for left channel.
right	`float *`	Mono output for right channel.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

DeInterleaveAdd

METHOD

Deinterleaves an interleaved stereo input and adds the results to the two mono output channels: left = left + [L, L, L, L, ...], right = right + [R, R, R, R, ...]

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Stereo interleaved input.
left	`Number (pointer in Linear Memory)`	Mono output for left channel.
right	`Number (pointer in Linear Memory)`	Mono output for right channel.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

DeInterleaveAdd

METHOD

Deinterleaves an interleaved stereo input and adds the results to the two mono output channels: left = left + [L, L, L, L, ...], right = right + [R, R, R, R, ...]

Parameters

Name	Type	Description
input	`float *`	Stereo interleaved input.
left	`float *`	Mono output for left channel.
right	`float *`	Mono output for right channel.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

DeInterleaveMultiply

METHOD

Deinterleaves an interleaved stereo input to two mono output channels and multiplies the output (gain): left = [L, L, L, L, ...] * gain, right = [R, R, R, R, ...] * gain

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Stereo interleaved input.
left	`Number (pointer in Linear Memory)`	Mono output for left channel.
right	`Number (pointer in Linear Memory)`	Mono output for right channel.
numberOfFrames	`Number`	The number of frames to process.
multiplier	`Number`	Multiply each output sample with this value.

Returns

None

DeInterleaveMultiply

METHOD

Deinterleaves an interleaved stereo input to two mono output channels and multiplies the output (gain): left = [L, L, L, L, ...] * gain, right = [R, R, R, R, ...] * gain

Parameters

Name	Type	Description
input	`float *`	Stereo interleaved input.
left	`float *`	Mono output for left channel.
right	`float *`	Mono output for right channel.
numberOfFrames	`unsigned int`	The number of frames to process.
multiplier	`float`	Multiply each output sample with this value.

Returns

None

DeInterleaveMultiplyAdd

METHOD

Deinterleaves an interleaved stereo input to two mono output channels, multiplies the result (gain) and and adds the results to the two mono output channels: left = left + [L, L, L, L, ...] * gain, right = right + [R, R, R, R, ...] * gain

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Stereo interleaved input.
left	`Number (pointer in Linear Memory)`	Mono output for left channel.
right	`Number (pointer in Linear Memory)`	Mono output for right channel.
numberOfFrames	`Number`	The number of frames to process.
multiplier	`Number`	Multiply each output sample with this value.

Returns

None

DeInterleaveMultiplyAdd

METHOD

Parameters

Name	Type	Description
input	`float *`	Stereo interleaved input.
left	`float *`	Mono output for left channel.
right	`float *`	Mono output for right channel.
numberOfFrames	`unsigned int`	The number of frames to process.
multiplier	`float`	Multiply each output sample with this value.

Returns

None

DotProduct
METHOD
Calculates the dot product of two vectors.
Parameters
Name Type Description
inputA Number (pointer in Linear Memory) First input vector.
inputB Number (pointer in Linear Memory) Second input vector.
numValues Number Number of value pairs to process.
Returns
Type Description
Number The dot product.
DotProduct
METHOD
Calculates the dot product of two vectors.
Parameters
Name Type Default Description
inputA float * First input vector.
inputB float * Second input vector.
numValues unsigned int Number of value pairs to process.
Returns
Type Description
float The dot product.

Name	Type	Description
inputA	`Number (pointer in Linear Memory)`	First input vector.
inputB	`Number (pointer in Linear Memory)`	Second input vector.
numValues	`Number`	Number of value pairs to process.

Type	Description
`Number`	The dot product.

Name	Type	Description
inputA	`float *`	First input vector.
inputB	`float *`	Second input vector.
numValues	`unsigned int`	Number of value pairs to process.

Type	Description
`float`	The dot product.

FloatTo24bit

METHOD

Converts 32-bit floating point audio to 24-bit.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit input.
output	`Number (pointer in Linear Memory)`	24-bit output.
numberOfFrames	`Number`	The number of frames to process.
numberOfChannels	`Number`	The number of channels.

Returns

None

FloatTo24bit
METHOD
Converts 32-bit floating point audio to 24-bit.
Parameters
Name Type Default Description
input float * 32-bit input.
output void * 24-bit output.
numberOfFrames unsigned int The number of frames to process.
numberOfChannels unsigned int 2 The number of channels.
Returns
None

Name	Type	Default	Description
input	`float *`		32-bit input.
output	`void *`		24-bit output.
numberOfFrames	`unsigned int`		The number of frames to process.
numberOfChannels	`unsigned int`	2	The number of channels.

FloatToChar

METHOD

Converts 32-bit floating point audio 8-bit audio.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit input.
output	`Number (pointer in Linear Memory)`	8-bit output.
numberOfFrames	`Number`	The number of frames to process.
numberOfChannels	`Number`	The number of channels.

Returns

None

FloatToChar
METHOD
Converts 32-bit floating point audio 8-bit audio.
Parameters
Name Type Default Description
input float * 32-bit input.
output signed char * 8-bit output.
numberOfFrames unsigned int The number of frames to process.
numberOfChannels unsigned int 2 The number of channels.
Returns
None

Name	Type	Default	Description
input	`float *`		32-bit input.
output	`signed char *`		8-bit output.
numberOfFrames	`unsigned int`		The number of frames to process.
numberOfChannels	`unsigned int`	2	The number of channels.

FloatToInt

METHOD

Converts 32-bit floating point audio to 32-bit integer.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit input.
output	`Number (pointer in Linear Memory)`	32-bit output.
numberOfFrames	`Number`	The number of frames to process.
numberOfChannels	`Number`	The number of channels.

Returns

None

FloatToInt
METHOD
Converts 32-bit floating point audio to 32-bit integer.
Parameters
Name Type Default Description
input float * 32-bit input.
output int * 32-bit output.
numberOfFrames unsigned int The number of frames to process.
numberOfChannels unsigned int 2 The number of channels.
Returns
None

Name	Type	Default	Description
input	`float *`		32-bit input.
output	`int *`		32-bit output.
numberOfFrames	`unsigned int`		The number of frames to process.
numberOfChannels	`unsigned int`	2	The number of channels.

FloatToShortInt

METHOD

Converts 32-bit float input to 16-bit signed integer output.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit input.
output	`Number (pointer in Linear Memory)`	16-bit output.
numberOfFrames	`Number`	The number of frames to process.
numberOfChannels	`Number`	The number of channels.

Returns

None

FloatToShortInt
METHOD
Converts 32-bit float input to 16-bit signed integer output.
Parameters
Name Type Default Description
input float * 32-bit input.
output short int * 16-bit output.
numberOfFrames unsigned int The number of frames to process.
numberOfChannels unsigned int 2 The number of channels.
Returns
None

Name	Type	Default	Description
input	`float *`		32-bit input.
output	`short int *`		16-bit output.
numberOfFrames	`unsigned int`		The number of frames to process.
numberOfChannels	`unsigned int`	2	The number of channels.

FloatToShortIntInterleave

METHOD

Converts two 32-bit mono float input channels to stereo interleaved 16-bit signed integer output.

Parameters

Name	Type	Description
inputLeft	`Number (pointer in Linear Memory)`	32-bit input for the left side. Should be numberOfFrames + 8 big minimum.
inputRight	`Number (pointer in Linear Memory)`	32-bit input for the right side. Should be numberOfFrames + 8 big minimum.
output	`Number (pointer in Linear Memory)`	Stereo interleaved 16-bit output. Should be numberOfFrames * 2 + 16 big minimum.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

FloatToShortIntInterleave

METHOD

Converts two 32-bit mono float input channels to stereo interleaved 16-bit signed integer output.

Parameters

Name	Type	Description
inputLeft	`float *`	32-bit input for the left side. Should be numberOfFrames + 8 big minimum.
inputRight	`float *`	32-bit input for the right side. Should be numberOfFrames + 8 big minimum.
output	`short int *`	Stereo interleaved 16-bit output. Should be numberOfFrames * 2 + 16 big minimum.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

frequencyOfNote
METHOD
Returns the frequency of a specific note.
Parameters
Name Type Description
note Number The index of the note. Note 0 is the standard A note at 440 Hz.
Returns
Type Description
Number The frequency in Hz.
frequencyOfNote
METHOD
Returns the frequency of a specific note.
Parameters
Name Type Default Description
note int The index of the note. Note 0 is the standard A note at 440 Hz.
Returns
Type Description
float The frequency in Hz.

Name	Type	Description
note	`Number`	The index of the note. Note 0 is the standard A note at 440 Hz.

Type	Description
`Number`	The frequency in Hz.

GetPeaks

METHOD

Get the peak values of each channel in an interleaved buffer.

Parameters

Name	Type	Description
interleavedInput	`Number (pointer in Linear Memory)`	Interleaved input.
numInterleavedChannels	`Number`	The total number of channels in the interleaved input.
numberOfFrames	`Number`	The number of frames to process.
peaks	`Number (pointer in Linear Memory)`	Peak value result, should be able to store totalChannels values minimum.

Returns

None

GetPeaks

METHOD

Get the peak values of each channel in an interleaved buffer.

Parameters

Name	Type	Description
interleavedInput	`float *`	Interleaved input.
numInterleavedChannels	`unsigned int`	The total number of channels in the interleaved input.
numberOfFrames	`unsigned int`	The number of frames to process.
peaks	`float *`	Peak value result, should be able to store totalChannels values minimum.

Returns

None

HasNonFinite

METHOD

Checks if the audio samples has non-valid values, such as infinity or NaN (not a number).

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Floating point numbers to check.
numberOfValues	`Number`	Number of values in the buffer. Please note, this is NOT numberOfFrames. You need to provide the number of floating point numbers in the buffer.

Returns

Type	Description
`Boolean`

HasNonFinite

METHOD

Checks if the audio samples has non-valid values, such as infinity or NaN (not a number).

Parameters

Name	Type	Default	Description
input	`float *`		Floating point numbers to check.
numberOfValues	`unsigned int`		Number of values in the buffer. Please note, this is NOT numberOfFrames. You need to provide the number of floating point numbers in the buffer.

Returns

Type	Description
`bool`

Interleave

METHOD

Makes an interleaved stereo output from two mono input channels: output = [L, R, L, R, ...]..

Parameters

Name	Type	Description
left	`Number (pointer in Linear Memory)`	Mono input for left channel.
right	`Number (pointer in Linear Memory)`	Mono input for right channel.
output	`Number (pointer in Linear Memory)`	Stereo interleaved output.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

Interleave

METHOD

Makes an interleaved stereo output from two mono input channels: output = [L, R, L, R, ...]..

Parameters

Name	Type	Description
left	`float *`	Mono input for left channel.
right	`float *`	Mono input for right channel.
output	`float *`	Stereo interleaved output.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

InterleaveAdd

METHOD

Makes an interleaved stereo output from two mono input channels and adds the result to the audio in the output buffer: output = output + [L, R, L, R, ...]

Parameters

Name	Type	Description
left	`Number (pointer in Linear Memory)`	Mono input for left channel.
right	`Number (pointer in Linear Memory)`	Mono input for right channel.
output	`Number (pointer in Linear Memory)`	Stereo interleaved output.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

InterleaveAdd

METHOD

Makes an interleaved stereo output from two mono input channels and adds the result to the audio in the output buffer: output = output + [L, R, L, R, ...]

Parameters

Name	Type	Description
left	`float *`	Mono input for left channel.
right	`float *`	Mono input for right channel.
output	`float *`	Stereo interleaved output.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

InterleaveAndGetPeaks

METHOD

Makes an interleaved output from two input channels and measures the volume: output = [L, R, L, R, ...]

Parameters

Name	Type	Description
left	`Number (pointer in Linear Memory)`	Mono input for left channel.
right	`Number (pointer in Linear Memory)`	Mono input for right channel.
output	`Number (pointer in Linear Memory)`	Stereo interleaved output.
numberOfFrames	`Number`	The number of frames to process.
peaks	`Number (pointer in Linear Memory)`	Pointer to two floating point numbers in Linear Memory. Peak value result (left, right).

Returns

None

InterleaveAndGetPeaks

METHOD

Makes an interleaved output from two input channels and measures the volume: output = [L, R, L, R, ...]

Parameters

Name	Type	Description
left	`float *`	Mono input for left channel.
right	`float *`	Mono input for right channel.
output	`float *`	Stereo interleaved output.
numberOfFrames	`unsigned int`	The number of frames to process.
peaks	`float *`	Pointer to two floating point numbers. Peak value result (left, right).

Returns

None

IntToFloat

METHOD

Converts 32-bit integer audio to 32-bit floating point.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit input.
output	`Number (pointer in Linear Memory)`	32-bit output.
numberOfFrames	`Number`	The number of frames to process.
numberOfChannels	`Number`	The number of channels.

Returns

None

IntToFloat
METHOD
Converts 32-bit integer audio to 32-bit floating point.
Parameters
Name Type Default Description
input int * 32-bit input.
output float * 32-bit output.
numberOfFrames unsigned int The number of frames to process.
numberOfChannels unsigned int 2 The number of channels.
Returns
None

MidSideToStereo

METHOD

Converts a mid-side signal to stereo.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Mid-side interleaved input.
output	`Number (pointer in Linear Memory)`	Interleaved stereo output. Can be equal to input (in-place processing).
numberOfFrames	`Number`	The number of frames to process.

Returns

None

MidSideToStereo

METHOD

Converts a mid-side signal to stereo.

Parameters

Name	Type	Description
input	`float *`	Mid-side interleaved input.
output	`float *`	Interleaved stereo output. Can be equal to input (in-place processing).
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

Peak

METHOD

Returns the peak absolute value. Useful for metering.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Input values.
numberOfValues	`Number`	The number of values to process. For a stereo input this value should be 2 * numberOfFrames. Must be a multiply of 8.

Returns

Type	Description
`Number`	Peak absolute value.

Peak
METHOD
Returns the peak absolute value. Useful for metering.
Parameters
Name Type Default Description
input float * Input values.
numberOfValues unsigned int The number of values to process. For a stereo input this value should be 2 * numberOfFrames. Must be a multiply of 8.
Returns
Type Description
float Peak absolute value.

ShortIntToFloat

METHOD

Converts 16-bit signed integer input to 32-bit float output.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Stereo interleaved 16-bit input.
output	`Number (pointer in Linear Memory)`	Stereo interleaved 32-bit output.
numberOfFrames	`Number`	The number of frames to process.
numberOfChannels	`Number`	The number of channels.

Returns

None

ShortIntToFloat

METHOD

Converts 16-bit signed integer input to 32-bit float output.

Parameters

Name	Type	Default	Description
input	`short int *`		Stereo interleaved 16-bit input.
output	`float *`		Stereo interleaved 32-bit output.
numberOfFrames	`unsigned int`		The number of frames to process.
numberOfChannels	`unsigned int`	2	The number of channels.

Returns

None

ShortIntToFloatGetPeaks

METHOD

Converts stereo interleaved 16-bit signed integer input to stereo interleaved 32-bit float output, and provides peak measurement.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Stereo interleaved 16-bit input. Should be numberOfFrames + 8 big minimum.
output	`Number (pointer in Linear Memory)`	Stereo interleaved 32-bit output. Should be numberOfFrames + 8 big minimum.
numberOfFrames	`Number`	The number of frames to process.
peaks	`Number (pointer in Linear Memory)`	Pointer to two floating point numbers. Peak value result (left, right).

Returns

None

ShortIntToFloatGetPeaks

METHOD

Converts stereo interleaved 16-bit signed integer input to stereo interleaved 32-bit float output, and provides peak measurement.

Parameters

Name	Type	Description
input	`short int *`	Stereo interleaved 16-bit input. Should be numberOfFrames + 8 big minimum.
output	`float *`	Stereo interleaved 32-bit output. Should be numberOfFrames + 8 big minimum.
numberOfFrames	`unsigned int`	The number of frames to process.
peaks	`float *`	Pointer to two floating point numbers. Peak value result (left, right).

Returns

None

StereoToMidSide

METHOD

Converts a stereo signal to mid-side.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Interleaved stereo input.
output	`Number (pointer in Linear Memory)`	Mid-side interleaved output. Can be equal to input (in-place processing).
numberOfFrames	`Number`	The number of frames to process.

Returns

None

StereoToMidSide

METHOD

Converts a stereo signal to mid-side.

Parameters

Name	Type	Description
input	`float *`	Interleaved stereo input.
output	`float *`	Mid-side interleaved output. Can be equal to input (in-place processing).
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

StereoToMono

METHOD

Makes mono output from stereo interleaved input: output = [L + R], [L + R], [L + R], ...

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	Stereo interleaved input.
output	`Number (pointer in Linear Memory)`	Mono output.
leftGainStart	`Number`	Gain of the first sample on the left channel.
leftGainEnd	`Number`	Gain for the last sample on the left channel. Gain will be smoothly calculated between start and end.
rightGainStart	`Number`	Gain of the first sample on the right channel.
rightGainEnd	`Number`	Gain for the last sample on the right channel. Gain will be smoothly calculated between start and end.
numberOfFrames	`Number`	The number of frames to process.

Returns

None

StereoToMono

METHOD

Makes mono output from stereo interleaved input: output = [L + R], [L + R], [L + R], ...

Parameters

Name	Type	Description
input	`float *`	Stereo interleaved input.
output	`float *`	Mono output.
leftGainStart	`float`	Gain of the first sample on the left channel.
leftGainEnd	`float`	Gain for the last sample on the left channel. Gain will be smoothly calculated between start and end.
rightGainStart	`float`	Gain of the first sample on the right channel.
rightGainEnd	`float`	Gain for the last sample on the right channel. Gain will be smoothly calculated between start and end.
numberOfFrames	`unsigned int`	The number of frames to process.

Returns

None

Version
METHOD
Returns the current version of the Superpowered SDK.
Parameters
None
Returns
Type Description
Number The returned value is: major version * 10000 + minor version * 100 + revision. Example: 10402 means 1.4.2
Version
METHOD
Returns the current version of the Superpowered SDK.
Parameters
None
Returns
Type Description
unsigned int The returned value is: major version * 10000 + minor version * 100 + revision. Example: 10402 means 1.4.2

Volume

METHOD

Applies volume on a single stereo interleaved buffer: output = input * gain

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit interleaved stereo input.
output	`Number (pointer in Linear Memory)`	32-bit interleaved stereo output. Can be equal to input (in-place processing).
volumeStart	`Number`	Volume for the first frame.
volumeEnd	`Number`	Volume for the last frame. Volume will be smoothly calculated between the first and last frames.
numberOfFrames	`Number`	Number of frames to process.

Returns

None

Volume

METHOD

Applies volume on a single stereo interleaved buffer: output = input * gain

Parameters

Name	Type	Description
input	`float *`	32-bit interleaved stereo input.
output	`float *`	32-bit interleaved stereo output. Can be equal to input (in-place processing).
volumeStart	`float`	Volume for the first frame.
volumeEnd	`float`	Volume for the last frame. Volume will be smoothly calculated between the first and last frames.
numberOfFrames	`unsigned int`	Number of frames to process.

Returns

None

VolumeAdd

METHOD

Applies volume on a single stereo interleaved buffer and adds it to the audio in the output buffer: output = output + input * gain.

Parameters

Name	Type	Description
input	`Number (pointer in Linear Memory)`	32-bit interleaved stereo input.
output	`Number (pointer in Linear Memory)`	32-bit interleaved stereo output. Can be equal to input (in-place processing).
volumeStart	`Number`	Volume for the first frame.
volumeEnd	`Number`	Volume for the last frame. Volume will be smoothly calculated between the first and last frames
numberOfFrames	`Number`	Number of frames to process.

Returns

None

VolumeAdd

METHOD

Applies volume on a single stereo interleaved buffer and adds it to the audio in the output buffer: output = output + input * gain.

Parameters

Name	Type	Description
input	`float *`	32-bit interleaved stereo input.
output	`float *`	32-bit interleaved stereo output. Can be equal to input (in-place processing).
volumeStart	`float`	Volume for the first frame.
volumeEnd	`float`	Volume for the last frame. Volume will be smoothly calculated between the first and last frames
numberOfFrames	`unsigned int`	Number of frames to process.

Returns

None

DSP Functions

Add1

Add1

Add2

Add2

Add4

Add4

Bit24ToFloat

Bit24ToFloat

ChangeVolume

ChangeVolume

ChangeVolumeAdd

ChangeVolumeAdd

CharToFloat

CharToFloat

CopyMonoFromInterleaved

CopyMonoFromInterleaved

CopyMonoToInterleaved

CopyMonoToInterleaved

CopyStereoFromInterleaved

CopyStereoFromInterleaved

CopyStereoToInterleaved

CopyStereoToInterleaved

CrossMono

CrossMono

CrossStereo

CrossStereo

DeInterleave

DeInterleave

DeInterleaveAdd

DeInterleaveAdd

DeInterleaveMultiply

DeInterleaveMultiply

DeInterleaveMultiplyAdd

DeInterleaveMultiplyAdd

DotProduct

DotProduct

FloatTo24bit

FloatTo24bit

FloatToChar

FloatToChar

FloatToInt

FloatToInt

FloatToShortInt

FloatToShortInt

FloatToShortIntInterleave

FloatToShortIntInterleave

frequencyOfNote

frequencyOfNote

GetPeaks

GetPeaks

HasNonFinite

HasNonFinite

Interleave

Interleave

InterleaveAdd

InterleaveAdd

InterleaveAndGetPeaks

InterleaveAndGetPeaks

IntToFloat

IntToFloat

MidSideToStereo

MidSideToStereo

Peak

Peak

ShortIntToFloat

ShortIntToFloat

ShortIntToFloatGetPeaks

ShortIntToFloatGetPeaks

StereoToMidSide

StereoToMidSide

StereoToMono

StereoToMono

Version

Version

Volume

Volume

VolumeAdd

VolumeAdd