AudioModule

Implements the base class for all audio modules.

abstract

class AudioModule {

struct ModuleInfo;

size_t bufferSize;

int sampleRate;

ModuleInfo info;

ModuleManager handler;

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

StreamIDSet enabledInputs;

StreamIDSet enabledOutputs;

void delegate(uint[4] data, uint offset) midiOut;

ModuleInfo getInfo();

int getSamplerate();

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

void midiReceive(uint[4] data, uint offset);

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

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

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

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

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

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

}

Members

Aliases

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

Functions

getInfo ModuleInfo getInfo(): Returns the basic informations about this module.
getSamplerate int getSamplerate(): Returns the current sample rate.
midiReceive void midiReceive(uint[4] data, uint offset): MIDI 2.0 data received here.
moduleSetup void moduleSetup(ubyte[] inputs, ubyte[] outputs, int sampleRate, size_t bufferSize): Sets the module up.
recallParam_double int recallParam_double(uint presetID, uint paramID, double value): Restores a parameter to the given preset. Returns an errorcode on failure.
recallParam_int int recallParam_int(uint presetID, uint paramID, int value): Restores a parameter to the given preset. Returns an errorcode on failure.
recallParam_string int recallParam_string(uint presetID, uint paramID, string value): Restores a parameter to the given preset. Returns an errorcode on failure.
recallParam_uint int recallParam_uint(uint presetID, uint paramID, uint value): Restores a parameter to the given preset. Returns an errorcode on failure.
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.

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(uint[4] data, uint offset) 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