Enumerations
enum	{ INPUT = 0, OUTPUT = 1 }

static float	audioRead (BelaContext *context, int frame, int channel)
	Read an audio input, specifying the frame number (when to read) and the channel. More...

static float	audioReadNI (BelaContext *context, int frame, int channel)
	Non-interleaved version of audioRead() More...

static void	audioWrite (BelaContext *context, int frame, int channel, float value)
	Write an audio output, specifying the frame number (when to write) and the channel. More...

static void	audioWriteNI (BelaContext *context, int frame, int channel, float value)
	Non-interleaved version of audioWrite() More...

static float	analogRead (BelaContext *context, int frame, int channel)
	Read an analog input, specifying the frame number (when to read) and the channel. More...

static float	analogReadNI (BelaContext *context, int frame, int channel)
	Non-interleaved version of analogRead() More...

static void	analogWrite (BelaContext *context, int frame, int channel, float value)
	Write an analog output, specifying the frame number (when to write) and the channel. More...

static void	analogWriteNI (BelaContext *context, int frame, int channel, float value)
	Non-interleaved version of analogWrite() More...

static void	analogWriteOnce (BelaContext *context, int frame, int channel, float value)
	Write an analog output, specifying the frame number (when to write) and the channel. More...

static void	analogWriteOnceNI (BelaContext *context, int frame, int channel, float value)
	Non-interleaved version of analogWriteNI() More...

static int	digitalRead (BelaContext *context, int frame, int channel)
	Read a digital input, specifying the frame number (when to read) and the pin. More...

static void	digitalWrite (BelaContext *context, int frame, int channel, int value)
	Write a digital output, specifying the frame number (when to write) and the pin. More...

static void	digitalWriteOnce (BelaContext *context, int frame, int channel, int value)
	Write a digital output, specifying the frame number (when to write) and the pin. More...

static void	pinMode (BelaContext *context, int frame, int channel, int mode)
	Set the direction of a digital pin to input or output. More...

static void	pinModeOnce (BelaContext *context, int frame, int channel, int mode)
	Set the direction of a digital pin to input or output. More...

static float	multiplexerAnalogRead (BelaContext *context, int input, int muxChannel)
	Read an audio input, specifying the frame number (when to read) and the channel. More...

static unsigned int	multiplexerChannelForFrame (BelaContext *context, int frame)
	Read an audio input, specifying the frame number (when to read) and the channel. More...

Detailed Description

These functions and macros are used for audio, analog and digital I/O. All the I/O functions require the BelaContext data structure from render() to be passed in. This means that these functions are, by design, only usable from within the rendering thread.

The naming conventions are loosely derived from the Arduino environment, and the syntax is similar. Unlike Arduino, the I/O functions require the frame number at which the read or write should take place, since all I/O happens synchronously with the audio clock.

Function Documentation

static float audioRead	(	BelaContext *	context,
		int	frame,
		int	channel
	)

inlinestatic

Read an audio input, specifying the frame number (when to read) and the channel.

This function returns the value of an audio input, at the time indicated by frame. The returned value ranges from -1 to 1.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to read the audio input. Valid values range from 0 to (context->audioFrames - 1).
channel	Which audio input to read. Valid values are between 0 and (context->audioChannels - 1), typically 0 to 1 by default.

Returns: Value of the analog input, range to 1.

Examples:: Audio/delay/render.cpp, Audio/FFT-phase-vocoder/render.cpp, Audio/filterbanks/render.cpp, Audio/record-audio/render.cpp, Audio/tremolo/render.cpp, Capelets/audio-expander/render.cpp, Digital/level-meter/render.cpp, Extras/cape-test/render.cpp, Fundamentals/passthrough/render.cpp, and Gui/frequency-response/render.cpp.

static float audioReadNI	(	BelaContext *	context,
		int	frame,
		int	channel
	)

inlinestatic

Non-interleaved version of audioRead()

To be used when (context->flags | BELA_FLAG_INTERLEAVED) == false)

static void audioWrite	(	BelaContext *	context,
		int	frame,
		int	channel,
		float	value
	)

inlinestatic

Write an audio output, specifying the frame number (when to write) and the channel.

This function sets the value of an audio output, at the time indicated by frame. Valid values are between -1 and 1.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to write the audio output. Valid values range from 0 to (context->audioFrames - 1).
channel	Which analog output to write. Valid values are between 0 and (context->audioChannels - 1), typically 0 to 1 by default.
value	Value to write to the output, range -1 to 1.

Examples:: Analog/analog-input/render.cpp, Analog/scope-analog/render.cpp, Audio/delay/render.cpp, Audio/envelope-generator/render.cpp, Audio/FFT-phase-vocoder/render.cpp, Audio/filterbanks/render.cpp, Audio/record-audio/render.cpp, Audio/sample-loader/render.cpp, Audio/sample-piezo-trigger/render.cpp, Audio/sample-streamer-multi/render.cpp, Audio/sample-streamer/render.cpp, Audio/tremolo/render.cpp, Capelets/audio-expander/render.cpp, Communication/MIDI/render.cpp, Communication/Serial/render.cpp, Digital/digital-input/render.cpp, Digital/level-meter/render.cpp, Extras/cape-test/render.cpp, Extras/oscillator-bank/render.cpp, Extras/second-pru/render.cpp, Extras/userdata/render.cpp, Fundamentals/passthrough/render.cpp, Fundamentals/sinetone-optimized-bank/render.cpp, Fundamentals/sinetone-optimized/render.cpp, Fundamentals/sinetone/render.cpp, Gui/frequency-response/render.cpp, Gui/gui-to-bela/render.cpp, Gui/mouse-track/render.cpp, Gui/sequencer/render.cpp, Gui/sliders/render.cpp, Sensors/LDR/render.cpp, Sensors/stepped-pot/render.cpp, terminal-only/filter-FIR/render.cpp, terminal-only/filter-IIR/render.cpp, terminal-only/samples/render.cpp, Trill/bar-sound/render.cpp, Trill/craft-sound/render.cpp, Trill/hex-sound/render.cpp, Trill/ring-sound/render.cpp, and Trill/square-sound/render.cpp.

static void audioWriteNI	(	BelaContext *	context,
		int	frame,
		int	channel,
		float	value
	)

inlinestatic

Non-interleaved version of audioWrite()

To be used when (context->flags | BELA_FLAG_INTERLEAVED) == false)

static float analogRead	(	BelaContext *	context,
		int	frame,
		int	channel
	)

inlinestatic

Read an analog input, specifying the frame number (when to read) and the channel.

This function returns the value of an analog input, at the time indicated by frame. The returned value ranges from 0 to 1, corresponding to a voltage range of 0 to 4.096V.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to read the analog input. Valid values range from 0 to (context->analogFrames - 1).
channel	Which analog input to read. Valid values are between 0 and (context->analogInChannels - 1), typically 0 to 7 by default.

Returns: Value of the analog input, range 0 to 1.

Examples:: Analog/analog-input/render.cpp, Analog/scope-analog/render.cpp, Audio/sample-piezo-trigger/render.cpp, Audio/tremolo/render.cpp, Capelets/audio-expander/render.cpp, Capelets/multiplexer-spectrum/render.cpp, Communication/logging-sensors/render.cpp, Digital/bicolor-LEDs/render.cpp, Extras/cape-test/render.cpp, Fundamentals/passthrough/render.cpp, Gui/graph/render.cpp, and Sensors/LDR/render.cpp.

static float analogReadNI	(	BelaContext *	context,
		int	frame,
		int	channel
	)

inlinestatic

Non-interleaved version of analogRead()

To be used when (context->flags | BELA_FLAG_INTERLEAVED) == false)

static void analogWrite	(	BelaContext *	context,
		int	frame,
		int	channel,
		float	value
	)

inlinestatic

Write an analog output, specifying the frame number (when to write) and the channel.

This function sets the value of an analog output, at the time indicated by frame. Valid values are between 0 and 1, corresponding to the range 0 to 5V.

The value written will persist for all future frames if BELA_FLAG_ANALOG_OUTPUTS_PERSIST is set in context->flags. This is the default behaviour.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to write the analog output. Valid values range from 0 to (context->analogFrames - 1).
channel	Which analog output to write. Valid values are between 0 and (context->analogOutChannels - 1), typically 0 to 7 by default.
value	Value to write to the output, range 0 to 1.

static void analogWriteNI	(	BelaContext *	context,
		int	frame,
		int	channel,
		float	value
	)

inlinestatic

Non-interleaved version of analogWrite()

To be used when (context->flags | BELA_FLAG_INTERLEAVED) == false)

static void analogWriteOnce	(	BelaContext *	context,
		int	frame,
		int	channel,
		float	value
	)

inlinestatic

Write an analog output, specifying the frame number (when to write) and the channel.

This function sets the value of an analog output, at the time indicated by frame. Valid values are between 0 and 1, corresponding to the range 0 to 5V.

Unlike analogWrite(), the value written will affect only the frame specified, with future values unchanged. This is faster than analogWrite() so is better suited to applications where every frame will be written to a different value. If BELA_FLAG_ANALOG_OUTPUTS_PERSIST is not set within context->flags, then analogWriteOnce() and analogWrite() are equivalent.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to write the analog output. Valid values range from 0 to (context->analogFrames - 1).
channel	Which analog output to write. Valid values are between 0 and (context->analogOutChannels - 1), typically 0 to 7 by default.
value	Value to write to the output, range 0 to 1.

Examples:: Analog/analog-output/render.cpp, Capelets/audio-expander/render.cpp, Extras/cape-test/render.cpp, and Fundamentals/passthrough/render.cpp.

static void analogWriteOnceNI	(	BelaContext *	context,
		int	frame,
		int	channel,
		float	value
	)

inlinestatic

Non-interleaved version of analogWriteNI()

To be used when (context->flags | BELA_FLAG_INTERLEAVED) == false)

static int digitalRead	(	BelaContext *	context,
		int	frame,
		int	channel
	)

inlinestatic

Read a digital input, specifying the frame number (when to read) and the pin.

This function returns the value of a digital input, at the time indicated by frame. The value is 0 if the pin is low, and nonzero if the pin is high (3.3V).

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to read the digital input. Valid values range from 0 to (context->digitalFrames - 1).
channel	Which digital input to read. 16 pins across the headers are available. Check your board diagram to know where they are on the specific board you have.

Returns: Value of the digital input.

Examples:: Audio/envelope-generator/render.cpp, Digital/digital-input/render.cpp, Sensors/rotary-encoder/render.cpp, Sensors/ultrasonic-distance-sensor/render.cpp, and Trill/general-settings/render.cpp.

static void digitalWrite	(	BelaContext *	context,
		int	frame,
		int	channel,
		int	value
	)

inlinestatic

Write a digital output, specifying the frame number (when to write) and the pin.

This function sets the value of a digital output, at the time indicated by frame. A value of 0 sets the pin low; any other value sets the pin high (3.3V).

The value written will persist for all future frames.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to write the digital output. Valid values range from 0 to (context->digitalFrames - 1).
channel	Which digital output to write. 16 pins across the headers are available. Check your board diagram to know where they are on the specific board you have.
value	Value to write to the output.

Examples:: Digital/digital-output/render.cpp, Sensors/ultrasonic-distance-sensor/render.cpp, and Trill/bar-led/render.cpp.

static void digitalWriteOnce	(	BelaContext *	context,
		int	frame,
		int	channel,
		int	value
	)

inlinestatic

Write a digital output, specifying the frame number (when to write) and the pin.

This function sets the value of a digital output, at the time indicated by frame. A value of 0 sets the pin low; any other value sets the pin high (3.3V).

Unlike digitalWrite(), the value written will affect only the frame specified, with future values unchanged. This is faster than digitalWrite() so is better suited to applications where every frame will be written to a different value.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to write the digital output. Valid values range from 0 to (context->digitalFrames - 1).
channel	Which digital output to write. 16 pins across the headers are available. Check your board diagram to know where they are on the specific board you have.
value	Value to write to the output.

Examples:: Digital/bicolor-LEDs/render.cpp, Digital/digital-input/render.cpp, and Digital/level-meter/render.cpp.

static void pinMode	(	BelaContext *	context,
		int	frame,
		int	channel,
		int	mode
	)

inlinestatic

Set the direction of a digital pin to input or output.

This function sets the direction of a digital pin, at the time indicated by frame. Valid values are INPUT and OUTPUT. All pins begin as inputs by default.

The value written will persist for all future frames.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to set the pin direction. Valid values range from 0 to (context->digitalFrames - 1).
channel	Which digital channel to set. 16 pins across the headers are available. Check your board diagram to know where they are on the specific board you have.
mode	Direction of the pin (`INPUT` or `OUTPUT`).

Examples:: Audio/envelope-generator/render.cpp, Digital/bicolor-LEDs/render.cpp, Digital/digital-input/render.cpp, Digital/digital-output/render.cpp, Digital/level-meter/render.cpp, Sensors/rotary-encoder/render.cpp, Sensors/ultrasonic-distance-sensor/render.cpp, Trill/bar-led/render.cpp, and Trill/general-settings/render.cpp.

static void pinModeOnce	(	BelaContext *	context,
		int	frame,
		int	channel,
		int	mode
	)

inlinestatic

Set the direction of a digital pin to input or output.

This function sets the direction of a digital pin, at the time indicated by frame. Valid values are INPUT and OUTPUT. All pins begin as inputs by default.

The value written will affect only the specified frame.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to set the pin direction. Valid values range from 0 to (context->digitalFrames - 1).
channel	Which digital channel to set. 16 pins across the headers are available. Check your board diagram to know where they are on the specific board you have.
mode	Direction of the pin (`INPUT` or `OUTPUT`).

Examples:: Digital/bicolor-LEDs/render.cpp.

static float multiplexerAnalogRead	(	BelaContext *	context,
		int	input,
		int	muxChannel
	)

inlinestatic

Read an audio input, specifying the frame number (when to read) and the channel.

This function returns the value of an audio input, at the time indicated by frame. The returned value ranges from -1 to 1.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to read the audio input. Valid values range from 0 to (context->audioFrames - 1).
channel	Which audio input to read. Valid values are between 0 and (context->audioChannels - 1), typically 0 to 1 by default.

Returns: Value of the analog input, range to 1.

Examples:: Capelets/multiplexer-display/render.cpp.

static unsigned int multiplexerChannelForFrame	(	BelaContext *	context,
		int	frame
	)

inlinestatic

Read an audio input, specifying the frame number (when to read) and the channel.

This function returns the value of an audio input, at the time indicated by frame. The returned value ranges from -1 to 1.

Parameters

context	The I/O data structure which is passed by Bela to render().
frame	Which frame (i.e. what time) to read the audio input. Valid values range from 0 to (context->audioFrames - 1).
channel	Which audio input to read. Valid values are between 0 and (context->audioChannels - 1), typically 0 to 1 by default.

Returns: Value of the analog input, range to 1.

Examples:: Capelets/multiplexer-spectrum/render.cpp.

Enumerations

Detailed Description

Function Documentation