RNBO: RNBO::CoreObject Class Reference

Construct a new CoreObject.

The CoreObject is the main API for using exported C++ code in external projects. It holds all state and data necessary for using RNBO.

Parameters

handler

an EventHandler for events generated by the CoreObject

Construct a new CoreObject.

The CoreObject is the main API for using exported C++ code in external projects. It holds all state and data necessary for using RNBO.

Parameters

patcher	a PatcherInterface to associate with the CoreObject
handler	an EventHandler for events generated by the CoreObject

Apply and get the constrained parameter value.

Parameter constraints include a minimum/maximum value and step constraints

Parameters

index	the parameter index
value	an unconstrained parameter value

Returns

the constrained parameter value

Reimplemented from RNBO::ParameterInterface.

Convert a parameter value from a normalized representation [0..1] to its real value.

Parameters

index	the parameter index
normalizedValue	the normalized value

Returns

the real value of the parameter

Implements RNBO::ParameterInterface.

Convert a parameter value from its real value to a normalized representation [0..1].

Parameters

index	the parameter index
value	the real value of the parameter

Returns

a normalized ParameterValue

Implements RNBO::ParameterInterface.

Create a lightweight interface for sending and receiving parameter values.

The CoreObject, by default, holds a parameter interface for sending and receiving events with the thread-safe MultiProducer interface type.

See also

RNBO::ParameterEventInterface

Parameters

type	the type of parameter event interface to create
handler	an event handler

Returns

a ParameterEventInterfaceUniquePtr

NOTE: if you create a thread safe async parameter interface you will NOT get any events and values out unless you use a handler which correctly drains these events

Get the current time (in ms)

This method is only accurate when called from the audio/processing thread

Returns

the current time in milliseconds

Get the name of an external data reference.

See also

RNBO::ExternalDataRef

Parameters

index

the external data reference index

Returns

a C-style string containing the name of the external data

Get more information about an external data reference (like file type and filename)

See also

RNBO::ExternalDataRef

Parameters

index

the index of the external data

Returns

a struct containing information about the external data

Get information about a named inport or outport.

Parameters

index

the MessageIndex

Returns

a reference to the MessageInfo

Get the number of external memory references.

See also

RNBO::ExternalDataRef

Returns

the number of external data references

Returns

the number of audio input channels processed by the current patcher

Implements RNBO::BaseInterface.

Returns

the count of named inports and outports

Returns

the number of MIDI inputs

Implements RNBO::BaseInterface.

Returns

the number of MIDI outputs

Implements RNBO::BaseInterface.

Returns

the number of audio output channels processed by the current patcher

Implements RNBO::BaseInterface.

Get the number of visible parameters.

Note that not all parameters are visible (for example, params in gen~ are not automatically exposed as RNBO parameters). The count of visible parameters is usually the same as the number of param/param~ objects in a RNBO~ patch.

Returns

the number of visible parameters

Implements RNBO::ParameterInterface.

Get the number of signal input parameters.

Signal input parameters can be handed into the processing function as additional audio inputs.

Returns

the number of signal input parameters

Get the number of signal output parameters.

Signal input parameters will be handed out of the processing function as additional audio outputs.

Returns

the number of signal output parameters

Get the unique ID of a parameter.

The unique ID of a parameter can be the same as the parameter ID. If a parameter is nested in a subpatcher, a prefix is added to the parameter name in order to disambiguate. Examples of parameter IDs:

• "my_toplevel_param"
• "p_obj-2/my_nested_param"
• "poly/p_obj-18/my_nested_poly_param"

Parameters

index

the parameter index

Returns

a C-style string containing the parameter ID

Implements RNBO::ParameterInterface.

Get the parameter index from a parameter ID.

Parameters

paramid

the parameter ID

Returns

the parameter index

Get detailed information about a parameter.

Parameters

index	the parameter index
info	a pointer to a ParameterInfo object to fill

Implements RNBO::ParameterInterface.

Get the parameter name (may not be unique)

Parameters

index

the parameter index

Returns

a C-style string containing the parameter name

Implements RNBO::ParameterInterface.

Parameters

index

the parameter index

Returns

the value of the parameter

Implements RNBO::ParameterInterface.

Get a preset (asynchronous)

The callback is called in the audio thread, so it is inadvisable to do any potentially blocking operations like opening files or allocating/freeing memory.

Parameters

callback

a PresetCallback to execute when the preset is available

Get a preset (synchronous)

Pause event and audio processing to get a preset immediately.

Returns

the preset

Get the number of probing channels associated with an outlet.

Call with outletId = 0 or TAG("") to get the maximum possible number of probing channels

Parameters

outletId

the ID of the outlet

Returns

the number of probing channels

Returns

the current sample rate

Returns

the current vector size

Set the sample rate and vector size before doing any processing.

This method is almost a no-op when there is no change in sample rate or vector size and force is false (the default) so it is suitable to call before each processing call. Note that an increase of maxBlockSize will allocate memory, however.

If this method returns false, do not call process() afterwards. Instead, call prepareToProcess() again.

Parameters

sampleRate	the sample rate to use
maxBlockSize	the maximum vector size; actual processing could be made in smaller chunks
force	if true, ensures the dspsetup methods of patcher objects are called

Returns

false if called during setPatcher, true otherwise

Process non-interleaved SampleValue* audio buffers with optional MIDI I/O.

Parameters

audioInputs	non-interleaved audio inputs (e.g. a 2D array: SampleValues[numInputs][sampleFrames])
numInputs	the number of audio input buffers
audioOutputs	non-interleaved audio outputs (e.g. a 2D array: SampleValues[numOutputs][sampleFrames])
numOutputs	the number of audio output buffers
sampleFrames	the number of samples in a single input or output
midiInput	an optional pointer to a MidiEventList of input events associated with this audio vector
midiOutput	an optional pointer to a MidiEventList which can receive MIDI output generated during the audio vector

Convert and process a generic audio buffer with optional MIDI I/O.

In situations where non-interleaved SampleValue* audio buffers are not available (e.g. the audio buffers are not sizeof(SampleValue) or the buffers are interleaved), use this method to convert and process the audio buffers.

Template Parameters

I	the type of input audio buffer
O	the type of output audio buffer

Parameters

audioInputs	audio input buffers
numInputs	the number of audio input buffers
audioOutputs	audio output buffers
numOutputs	the number of audio output buffers
sampleFrames	the number of samples in a single input or output
midiInput	an optional pointer to a MidiEventList of input events associated with this audio vector
midiOutput	an optional pointer to a

Release a block of memory (thread-safe)

Call releaseExternalData() on an external data reference to tell RNBO to stop using a block of memory in a thread-safe way. If a ReleaseCallback is associated with the data reference, it will be called when the data is no longer in use.

Parameters

memoryId

the name of the data reference

Look up the name associated with a MessageTag.

Parameters

tag	a MessageTag

Returns

the name associated with the tag as a C-style string

Schedule an event.

There are a number of event variants that can be scheduled (like MIDI events, tempo events, and parameter events). For all of the variants available, see the related documentation.

See also

RNBO::EventVariant

Parameters

event

an event to schedule

Send a bang to named patcher inports.

Parameters

tag	the inport name MessageTag created from a char* or const char* via the TAG() function
objectId	optionally specify a receiving object (mostly used internally)
eventTime	time the message should be scheduled for (use RNBOTimeNow or 0 for "as soon as possible")

For example:

Send a number to named patcher inports.

Parameters

tag	the inport name MessageTag created from a char* or const char* via the TAG() function
payload	a number
objectId	optionally specify a receiving object (mostly used internally)
eventTime	time the message should be scheduled for (use RNBOTimeNow or 0 for "as soon as possible")

For example:

Send a list message to named patcher inports.

Parameters

tag	the inport name MessageTag created from a char* or const char* via the TAG() function
payload	a UniqueListPtr of numbers
objectId	optionally specify a receiving object (mostly used internally)
eventTime	time the message should be scheduled for (use RNBOTimeNow or 0 for "as soon as possible")

For example:

Set the current time (in ms)

This can be used to tightly sync RNBO and host time. Jumping, rather than forwarding time according to the processed samples, may result in unpredictable results.

Do not call this method outside of the audio/processing thread.

Parameters

time	the new time in milliseconds

Set the contents of an external data reference (thread-safe)

Note: From the moment setExternalData() is called, memory can and will be used at any given time by RNBO, so do not reallocate or change the size unless the memory has been released via releaseExternalData().

Parameters

memoryId	the name of the data reference
data	byte array of data
sizeInBytes	size of the data array in bytes
type	buffer type: RNBO::Float32AudioBuffer(Index channels, number samplerate) RNBO::Float64AudioBuffer(Index channels, number samplerate) RNBO::UntypedDataBuffer()
callback	synchronous callback to be called when the engine releases the memory after releaseExternalData()

Set handlers for an external data reference which will be called before and after processing.

Some clients need to lock and unlock the memory at the beginning and end of processing, and this can be done by creating an ExternalDataHandler and implementing its processBeginCallback() and processEndCallback() methods. These will be called synchronously in the audio thread before and after processing, respectively.

See also

RNBO::ExternalDataHandler

Parameters

handler

the ExternalDataHandler to associate with the data reference

Set a parameter's value.

Parameters

index	the parameter index
value	parameter value to set
time	when the parameter change should happen (default is RNBOTimeNow)

Implements RNBO::ParameterInterface.

Set a parameter's normalized [0..1] value.

Parameters

index	the parameter index
normalizedValue	parameter normalized value to set
time	when the parameter change should happen (default is RNBOTimeNow)

Reimplemented from RNBO::ParameterInterface.

Set or replace the engine's patcher with a default patcher.

Note: this blocks audio and event processing.

Returns

true on success, false on failure

Replace the engine's patcher with a new instance.

Note: this blocks audio and event processing.

Parameters

patcher

the new patcher instance

Returns

true on success, false on failure

Set the handler for patcher change notifications.

The handler is called synchronously at the end of the setPatcher call and before any audio processing happens. As such, be aware of taking too much time in the handler.

Parameters

handler

a pointer to a PatcherChangedHandler

Schedule a preset change.

Parameters

preset

the new preset

Set a preset immediately.

Note: this blocks audio and event processing.

Parameters

preset

the new preset