AudioProcessor

#include "processor.hh"

Inheritance diagram for AudioProcessor:

Classes
struct	EventStreams
class	FloatBuffer
struct	IOBus
struct	ProcessorSetup
struct	RenderContext

Public Types
using	MakeDeviceP = std::function< DeviceP(const String &, StaticInfo, AudioProcessorP)>
using	MakeProcessor = AudioProcessorP(*)(AudioEngine &)
using	MakeProcessorP = AudioProcessorP(*)(CString, AudioEngine &)
using	MaybeParamId = std::pair< ParamId, bool >
using	StaticInfo = void(*)(AudioProcessorInfo &)

Public Member Functions
void	adjust_all_params ()
AtomicBits::Iter	atomic_bits_iter (size_t pos=0) const
BusInfo	bus_info (IBusId busid) const
BusInfo	bus_info (OBusId busid) const
bool	check_dirty (Id32 paramid) const
void	connect_event_input (AudioProcessor &oproc)
bool	connected (OBusId obusid) const
String	debug_name () const
void	disconnect_event_input ()
void	enable_engine_output (bool onoff)
AudioEngine &	engine () const
IBusId	find_ibus (const String &name) const
OBusId	find_obus (const String &name) const
MaybeParamId	find_param (const String &identifier) const
DeviceP	get_device () const
double	get_normalized (Id32 paramid)
double	get_param (Id32 paramid)
bool	has_event_input () const
bool	has_event_output () const
const float *	ifloats (IBusId b, uint c) const
double	inyquist () const
bool	is_initialized () const
uint	n_ibuses () const
uint	n_ichannels (IBusId busid) const
uint	n_obuses () const
uint	n_ochannels (OBusId busid) const
float	note_to_freq (int note) const
double	nyquist () const
const float *	ofloats (OBusId b, uint c) const
MinMax	param_range (Id32 paramid) const
virtual double	param_value_from_text (uint32_t paramid, const String &text) const
virtual String	param_value_to_text (uint32_t paramid, double value) const
ParameterC	parameter (Id32 paramid) const
uint	sample_rate () const
bool	send_param (Id32 paramid, double value)
bool	set_normalized (Id32 paramid, double normalized)
String	text_param_from_quark (uint32_t paramid, uint vint)
uint	text_param_to_quark (uint32_t paramid, const String &text)
const AudioTransport &	transport () const
virtual double	value_from_normalized (Id32 paramid, double normalized) const
virtual double	value_to_normalized (Id32 paramid, double value) const
Public Member Functions inherited from NewDeleteBase
void	operator delete (void *ptr, std::size_t sz)
void	operator delete (void *ptr, std::size_t sz, std::align_val_t al)
void	operator delete[] (void *ptr, std::size_t sz)
void	operator delete[] (void *ptr, std::size_t sz, std::align_val_t al)
void *	operator new (std::size_t sz)
void *	operator new (std::size_t sz, std::align_val_t al)
void *	operator new[] (std::size_t sz)
void *	operator new[] (std::size_t sz, std::align_val_t al)

Static Public Member Functions
template<class AudioProc , class ... Args>
static std::shared_ptr< AudioProc >	create_processor (AudioEngine &engine, const Args &...args)
static double	param_peek_mt (const AudioProcessorP proc, Id32 paramid)
static void	registry_add (CString aseid, StaticInfo, MakeProcessorP)
static DeviceP	registry_create (CString aseid, AudioEngine &engine, const MakeDeviceP &)
static void	registry_foreach (const std::function< void(const String &aseid, StaticInfo)> &fun)
static uint64	timestamp ()

Static Public Attributes
static const String	GUIONLY
static const String	STANDARD
static const String	STORAGEONLY

Protected Types
enum	{   INITIALIZED , SCHEDULED , PARAMCHANGE , BUSCONNECT ,   BUSDISCONNECT , INSERTION , REMOVAL , ENGINE_OUTPUT }
using	MidiEventInput = MidiEventReader< 2 >
using	MinMax = std::pair< double, double >

Protected Member Functions
IBusId	add_input_bus (CString uilabel, SpeakerArrangement speakerarrangement, const String &hints="", const String &blurb="")
OBusId	add_output_bus (CString uilabel, SpeakerArrangement speakerarrangement, const String &hints="", const String &blurb="")
virtual void	adjust_param (uint32_t paramid)
void	apply_event (const MidiEvent &event)
void	apply_input_events ()
void	assign_oblock (OBusId b, uint c, float val)
bool	atomic_bit_notify (size_t nth)
void	atomic_bits_resize (size_t count)
	AudioProcessor (const ProcessorSetup &)
void	connect (IBusId ibus, AudioProcessor &oproc, OBusId obus)
void	disconnect (IBusId ibus)
void	disconnect_ibuses ()
void	disconnect_obuses ()
void	enotify_enqueue_mt (uint32 pushmask)
virtual void	initialize (SpeakerArrangement busses)=0
void	install_params (const AudioParams::Map &params)
IOBus &	iobus (IBusId busid)
const IOBus &	iobus (IBusId busid) const
IOBus &	iobus (OBusId busid)
const IOBus &	iobus (OBusId busid) const
MidiEventInput	midi_event_input ()
MidiEventOutput &	midi_event_output ()
float *	oblock (OBusId b, uint c)
double	peek_param_mt (Id32 paramid) const
void	prepare_event_input ()
void	prepare_event_output ()
void	redirect_oblock (OBusId b, uint c, const float *block)
void	remove_all_buses ()
void	reschedule ()
virtual uint	schedule_children ()
uint	schedule_processor ()
virtual	~AudioProcessor ()

Static Protected Member Functions
static uint	schedule_processor (AudioProcessor &p)

Protected Attributes
CString	aseid_
AudioEngine &	engine_
std::atomic< uint32 >	flags_

Detailed Description

Audio signal AudioProcessor base class, implemented by all effects and instruments.

Member Typedef Documentation

MinMax

using MinMax = std::pair<double,double>

protected

MidiEventInput

using MidiEventInput = MidiEventReader<2>

protected

MakeProcessor

using MakeProcessor = AudioProcessorP (*) (AudioEngine&)

MaybeParamId

using MaybeParamId = std::pair<ParamId,bool>

StaticInfo

using StaticInfo = void (*) (AudioProcessorInfo&)

MakeDeviceP

using MakeDeviceP = std::function<DeviceP (const String&, StaticInfo, AudioProcessorP)>

MakeProcessorP

using MakeProcessorP = AudioProcessorP (*) (CString,AudioEngine&)

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
INITIALIZED
SCHEDULED
PARAMCHANGE
BUSCONNECT
BUSDISCONNECT
INSERTION
REMOVAL
ENGINE_OUTPUT

Constructor & Destructor Documentation

AudioProcessor()

AudioProcessor ( const ProcessorSetup & psetup )

explicitprotected

Constructor for AudioProcessor.

~AudioProcessor()

~AudioProcessor ( )

protectedvirtual

The destructor is called when the last std::shared_ptr<> reference drops.

Member Function Documentation

initialize()

void initialize ( SpeakerArrangement busses )

protectedpure virtual

Mandatory method to setup parameters and I/O busses. See add_param(), add_input_bus() / add_output_bus(). This method will be called once per instance after construction.

Implemented in ClapAudioProcessor, AudioChain::Inlet, AudioChain, and MidiProducerImpl.

enotify_enqueue_mt()

void enotify_enqueue_mt ( uint32 pushmask )

protected

Queue an AudioProcessor notification This function is MT-Safe after proper AudioProcessor initialization.

schedule_processor() [1/2]

uint schedule_processor ( )

protected

Schedule this node and its dependencies for engine rendering.

reschedule()

void reschedule ( )

protected

Request recreation of the audio engine rendering schedule.

schedule_children()

virtual uint schedule_children ( )

protectedvirtual

Reimplemented in AudioChain.

schedule_processor() [2/2]

static uint schedule_processor ( AudioProcessor & p )

staticprotected

install_params()

void install_params ( const AudioParams::Map & params )

protected

Reset list of parameters, enqueues parameter value initializaiton events.

apply_event()

void apply_event ( const MidiEvent & event )

protected

Assign MidiEvent::PARAM_VALUE event values to parameters.

apply_input_events()

void apply_input_events ( )

protected

Process all input events via apply_event() and adjust_param(). This applies all incoming parameter changes, events like NOTE_ON are not handled.

adjust_param()

virtual void adjust_param ( uint32_t paramid )

protectedvirtual

peek_param_mt()

double peek_param_mt ( Id32 paramid ) const

protected

Fetch the current parameter value of an AudioProcessor. This function does not modify the parameter `dirty` flag. This function is MT-Safe after proper AudioProcessor initialization.

add_input_bus()

IBusId add_input_bus ( CString uilabel, SpeakerArrangement speakerarrangement, const String & hints = "", const String & blurb = "" )

protected

Add an input bus with `uilabel` and channels configured via `speakerarrangement`.

add_output_bus()

OBusId add_output_bus ( CString uilabel, SpeakerArrangement speakerarrangement, const String & hints = "", const String & blurb = "" )

protected

Add an output bus with `uilabel` and channels configured via `speakerarrangement`.

remove_all_buses()

void remove_all_buses ( )

protected

Remove existing bus configurations, useful at the start of configure().

iobus() [1/4]

AudioProcessor::IOBus & iobus ( OBusId busid )

protected

Get internal output bus handle.

iobus() [2/4]

AudioProcessor::IOBus & iobus ( IBusId busid )

protected

Get internal input bus handle.

iobus() [3/4]

const IOBus & iobus ( OBusId busid ) const

protected

iobus() [4/4]

const IOBus & iobus ( IBusId busid ) const

protected

disconnect_ibuses()

void disconnect_ibuses ( )

protected

Reset input bus buffer data.

disconnect_obuses()

void disconnect_obuses ( )

protected

Disconnect inputs of all Processors that are connected to outputs of `this`.

disconnect()

void disconnect ( IBusId ibus )

protected

Disconnect input `ibusid`.

connect()

void connect ( IBusId ibus, AudioProcessor & oproc, OBusId obus )

protected

Connect input `ibusid` to output `obusid` of AudioProcessor `prev`.

oblock()

float * oblock ( OBusId b, uint c )

protected

Reset buffer redirections and access float buffer of output bus `b`, channel `c`. See also ofloats() for readonly access and redirect_oblock() for redirections.

assign_oblock()

void assign_oblock ( OBusId b, uint c, float val )

protected

Fill the output buffer of bus `b`, channel `c` with `v`.

redirect_oblock()

void redirect_oblock ( OBusId b, uint c, const float * block )

protected

Redirect output buffer of bus `b`, channel `c` to point to `block`, or zeros if `block==nullptr`.

prepare_event_input()

void prepare_event_input ( )

protected

Prepare the AudioProcessor to receive Event objects during render() via get_event_input(). Note, remove_all_buses() will remove the Event input created by this function.

prepare_event_output()

void prepare_event_output ( )

protected

Prepare the AudioProcessor to produce Event objects during render() via get_event_output(). Note, remove_all_buses() will remove the Event output created by this function.

midi_event_input()

AudioProcessor::MidiEventInput midi_event_input ( )

protected

Access the current MidiEvent inputs during render(), needs prepare_event_input().

midi_event_output()

MidiEventOutput & midi_event_output ( )

protected

Access the current output EventStream during render(), needs prepare_event_output().

atomic_bits_resize()

void atomic_bits_resize ( size_t count )

protected

Prepare `count` bits for atomic notifications.

atomic_bit_notify()

bool atomic_bit_notify ( size_t nth )

protected

Set the nth atomic notification bit, return if enotify_enqueue_mt() is needed.

atomic_bits_iter()

AtomicBits::Iter atomic_bits_iter

(

size_t

pos = 0

)

const

Allow iterations over the atomic bits.

note_to_freq()

float note_to_freq

(

int

note

)

const

Convert MIDI note to Hertz according to the current MusicalTuning.

debug_name()

String debug_name

(

)

const

engine()

AudioEngine & engine

(

)

const

Retrieve AudioEngine handle for this AudioProcessor.

transport()

const AudioTransport & transport

(

)

const

Sample rate mixing frequency in Hz as unsigned, used for render().

sample_rate()

uint sample_rate

(

)

const

nyquist()

double nyquist

(

)

const

Half the sample rate in Hz as double, used for render().

inyquist()

double inyquist

(

)

const

Inverse Nyquist frequency, i.e. 1.0 / nyquist().

get_param()

double get_param

(

Id32

paramid

)

Fetch `value` of parameter `id`.

send_param()

bool send_param	(	Id32	paramid,
		double	value
	)

Set parameter `id` to `value` within `ParamInfo.get_minmax()`.

parameter()

ParameterC parameter

(

Id32

paramid

)

const

Retrieve supplemental information for parameters, usually to enhance the user interface.

find_param()

auto find_param

(

const String &

identifier

)

const

Return the ParamId for parameter `identifier` or else 0.

param_range()

AudioProcessor::MinMax param_range

(

Id32

paramid

)

const

Retrieve the minimum / maximum values for a parameter.

check_dirty()

bool check_dirty

(

Id32

paramid

)

const

Check if the parameter `dirty` flag is set. Return `true` if the parameter value changed during render().

adjust_all_params()

void adjust_all_params

(

)

param_value_to_text()

String param_value_to_text ( uint32_t paramid, double value ) const

virtual

Format a parameter `paramid` value as text string. Currently, this function may be called from any thread, so `this` must be treated as `const` (it might be used concurrently by a different thread).

param_value_from_text()

double param_value_from_text ( uint32_t paramid, const String & text ) const

virtual

Extract a parameter `paramid` value from a text string. The string might contain unit information or consist only of number characters. Non-recognized characters should be ignored, so a best effort conversion is always undertaken. This function may be called from any thread, so `this` must be treated as `const` (it might be used concurrently by a different thread).

value_to_normalized()

double value_to_normalized ( Id32 paramid, double value ) const

virtual

value_from_normalized()

double value_from_normalized ( Id32 paramid, double normalized ) const

virtual

get_normalized()

double get_normalized

(

Id32

paramid

)

Get param value normalized into 0…1.

set_normalized()

bool set_normalized	(	Id32	paramid,
		double	normalized
	)

Set param value normalized into 0…1.

is_initialized()

bool is_initialized

(

)

const

Check if AudioProcessor has been properly intiialized (so the parameter set is fixed).

text_param_to_quark()

uint text_param_to_quark	(	uint32_t	paramid,
		const String &	text
	)

Ase main-thread helper for temporary string<->uint conversions.

text_param_from_quark()

String text_param_from_quark	(	uint32_t	paramid,
		uint	vint
	)

Helper for temporary uint<->string conversions.

find_ibus()

IBusId find_ibus

(

const String &

name

)

const

Return the IBusId for input bus `uilabel` or else 0.

find_obus()

OBusId find_obus

(

const String &

name

)

const

Return the OBusId for output bus `uilabel` or else 0.

n_ibuses()

uint n_ibuses

(

)

const

Number of input buses configured for this AudioProcessor.

n_obuses()

uint n_obuses

(

)

const

Number of output buses configured for this AudioProcessor.

n_ichannels()

uint n_ichannels

(

IBusId

busid

)

const

Number of channels of input bus `busid` configured for this AudioProcessor.

n_ochannels()

uint n_ochannels

(

OBusId

busid

)

const

Number of channels of output bus `busid` configured for this AudioProcessor.

bus_info() [1/2]

BusInfo bus_info

(

IBusId

busid

)

const

Retrieve BusInfo for an input bus.

bus_info() [2/2]

BusInfo bus_info

(

OBusId

busid

)

const

Retrieve BusInfo for an output bus.

connected()

bool connected

(

OBusId

obusid

)

const

Indicator for connected output buses. Not connected output bus buffers do not need to be filled.

ifloats()

const float * ifloats	(	IBusId	b,
		uint	c
	)		const

Access readonly float buffer of input bus `b`, channel `c`, see also ofloats().

ofloats()

const float * ofloats	(	OBusId	b,
		uint	c
	)		const

Access readonly float buffer of output bus `b`, channel `c`, see also oblock().

timestamp()

uint64 timestamp ( )

static

The current timestamp in sample frames.

get_device()

DeviceP get_device

(

)

const

Gain access to the Device handle of `this` AudioProcessor.

has_event_input()

bool has_event_input

(

)

const

Returns `true` if this AudioProcessor has an event input stream.

has_event_output()

bool has_event_output

(

)

const

Returns `true` if this AudioProcessor has an event output stream.

connect_event_input()

void connect_event_input

(

AudioProcessor &

oproc

)

Connect event input to event output of AudioProcessor `oproc`.

disconnect_event_input()

void disconnect_event_input

(

)

Disconnect event input if a connection is present.

enable_engine_output()

void enable_engine_output

(

bool

onoff

)

Configure if the main output of this module is mixed into the engine output.

param_peek_mt()

double param_peek_mt ( const AudioProcessorP proc, Id32 paramid )

static

Fetch the current parameter value of a AudioProcessor from any thread. This function is MT-Safe after proper AudioProcessor initialization.

registry_add()

void registry_add ( CString aseid, StaticInfo static_info, MakeProcessorP makeproc )

static

Add a new type to the AudioProcessor type registry. New AudioProcessor types must have a unique URI (see `query_info()`) and will be created with the factory function `create()`.

registry_create()

DeviceP registry_create ( CString aseid, AudioEngine & engine, const MakeDeviceP & makedevice )

static

registry_foreach()

void registry_foreach ( const std::function< void(const String &aseid, StaticInfo)> & fun )

static

Iterate over the known AudioProcessor types.

create_processor()

template<class AudioProc , class ... Args>

std::shared_ptr< AudioProc > create_processor ( AudioEngine & engine, const Args &... args )

static

Member Data Documentation

flags_

std::atomic<uint32> flags_

protected

engine_

AudioEngine& engine_

protected

aseid_

CString aseid_

protected

GUIONLY

const String GUIONLY

static

":G:r:w:" - GUI READABLE WRITABLE

GUI READABLE WRITABLE.

STANDARD

const String STANDARD

static

":G:S:r:w:" - GUI STORAGE READABLE WRITABLE

GUI STORAGE READABLE WRITABLE.

STORAGEONLY

const String STORAGEONLY

static

":S:r:w:" - STORAGE READABLE WRITABLE

STORAGE READABLE WRITABLE.