AudioModule

Implements the base class for all audio modules.

public abstract

class AudioModule {

struct ModuleInfo;

protected protected

size_t bufferSize;

protected protected

int sampleRate;

protected protected

ModuleInfo info;

protected protected

ModuleManager handler;

alias StreamIDSet = SortedList!(ubyte, "a < b", false);

protected protected

StreamIDSet enabledInputs;

protected protected

StreamIDSet enabledOutputs;

public @nogc nothrow

void delegate(UMP data0, uint data1 = 0, uint data2 = 0, uint data3 = 0) midiOut;

ModuleInfo getInfo();

int getSamplerate();

void moduleSetup(ubyte[] inputs, ubyte[] outputs, int sampleRate, size_t bufferSize, ModuleManager handler);

void midiReceive(UMP data0, uint data1, uint data2, uint data3);

void renderFrame(float*[] input, float*[] output);

int waveformDataReceive(uint id, ubyte[] rawData, WaveFormat format);

int writeParam_int(uint presetID, uint paramID, int value);

int writeParam_long(uint presetID, uint paramID, long value);

int writeParam_double(uint presetID, uint paramID, double value);

int writeParam_string(uint presetID, uint paramID, string value);

MValue[] getParameters();

int readParam_int(uint presetID, uint paramID);

long readParam_long(uint presetID, uint paramID);

double readParam_double(uint presetID, uint paramID);

string readParam_string(uint presetID, uint paramID);

}

Members

Aliases

StreamIDSet alias StreamIDSet = SortedList!(ubyte, "a < b", false): Undocumented in source.

Functions

getInfo ModuleInfo getInfo(): Returns the basic informations about this module.
getParameters MValue[] getParameters(): Returns all the possible parameters this module has.
getSamplerate int getSamplerate(): Returns the current sample rate.
midiReceive void midiReceive(UMP data0, uint data1, uint data2, uint data3): MIDI 2.0 data received here.
moduleSetup void moduleSetup(ubyte[] inputs, ubyte[] outputs, int sampleRate, size_t bufferSize, ModuleManager handler): Sets the module up.
readParam_double double readParam_double(uint presetID, uint paramID): Reads the given value (int).
readParam_int int readParam_int(uint presetID, uint paramID): Reads the given value (int).
readParam_long long readParam_long(uint presetID, uint paramID): Reads the given value (int).
readParam_string string readParam_string(uint presetID, uint paramID): Reads the given value (int).
renderFrame void renderFrame(float*[] input, float*[] output): Renders the current audio frame.
waveformDataReceive int waveformDataReceive(uint id, ubyte[] rawData, WaveFormat format): Receives waveform data that has been loaded from disk for reading. Returns zero if successful, or a specific errorcode.
writeParam_double int writeParam_double(uint presetID, uint paramID, double value): Restores a parameter to the given preset. Returns an errorcode on failure.
writeParam_int int writeParam_int(uint presetID, uint paramID, int value): Restores a parameter to the given preset. Returns an errorcode on failure.
writeParam_long int writeParam_long(uint presetID, uint paramID, long value): Restores a parameter to the given preset. Returns an errorcode on failure.
writeParam_string int writeParam_string(uint presetID, uint paramID, string value): Restores a parameter to the given preset. Returns an errorcode on failure.

Structs

ModuleInfo struct ModuleInfo: Contains all data related to module info.

Variables

bufferSize size_t bufferSize;: The size of the output buffers (must kept as a constant)
enabledInputs StreamIDSet enabledInputs;: List of enabled input channel numbers
enabledOutputs StreamIDSet enabledOutputs;: List of enabled output channel numbers
handler ModuleManager handler;: The main audio handler, also MIDI outs can be passed there
info ModuleInfo info;: Basic info about the plugin
midiOut void delegate(UMP data0, uint data1 = 0, uint data2 = 0, uint data3 = 0) midiOut;: A delegate where MIDI messages are being routed
sampleRate int sampleRate;: The sample rate that the audio subsystem runs at

Meta

Source

See Implementation

pixelperfectengine audio base modulebase classes

AudioModule