Plugin class of the ac2osc plugin. More...

Inheritance diagram for ac2osc_t:

Public Member Functions
	ac2osc_t (MHA_AC::algo_comm_t &iac, const std::string &configured_name)
	C'tor of plugin class. More...

void	prepare (mhaconfig_t &)

mha_wave_t *	process (mha_wave_t *s)
	Processing fct for waveforms. More...

mha_spec_t *	process (mha_spec_t *s)
	Processing fct for spectra. More...

void	process ()
	Process function. More...

void	release ()
	Release frees osc related memory, does cleanup. More...

Public Member Functions inherited from MHAPlugin::plugin_t< int >
	plugin_t (const std::string &, MHA_AC::algo_comm_t &)
	Constructor of plugin template base class. More...

virtual	~plugin_t ()
	Destructor of plugin template base class. More...

void	prepare_ (mhaconfig_t &)

void	release_ ()

bool	is_prepared () const
	Flag, if the prepare method is successfully called (or currently evaluated) More...

mhaconfig_t	input_cfg () const
	Current input channel configuration. More...

mhaconfig_t	output_cfg () const
	Current output channel configuration. More...

Public Member Functions inherited from MHAParser::parser_t
	parser_t (const std::string &help_text="")
	Construct detached node to be used in the configuration tree. More...

	~parser_t ()

void	insert_item (const std::string &, base_t *)
	Register a parser item into this sub-parser. More...

void	remove_item (const std::string &)
	Remove an item by name. More...

void	force_remove_item (const std::string &)
	Remove an item by name. More...

void	remove_item (const base_t *)
	Remove an item by address. More...

Public Member Functions inherited from MHAParser::base_t
	base_t (const std::string &)
	Constructor for base class of all parser nodes. More...

	base_t (const base_t &)
	Copy constructor for base_t. More...

base_t &	operator= (const base_t &)=default

	base_t (base_t &&)=delete

base_t &	operator= (base_t &&)=delete

virtual	~base_t ()

virtual std::string	parse (const std::string &)
	Causes this node to process a command in the openMHA configuration language. More...

virtual void	parse (const char , char , unsigned int)
	This function parses a command and writes the parsing result into a C character array. More...

virtual void	parse (const std::vector< std::string > &, std::vector< std::string > &)

virtual std::string	query_perm (const std::string &)

virtual std::string	query_range (const std::string &)

std::string	query_version (const std::string &)

std::string	query_id (const std::string &)

std::string	query_subst (const std::string &)

std::string	query_addsubst (const std::string &)

std::string	query_help (const std::string &)

std::string	query_cmds (const std::string &)

void	set_node_id (const std::string &)
	Set the identification string of this parser node. More...

void	set_help (const std::string &)
	Set the help comment of a variable or parser. More...

void	add_parent_on_insert (parser_t *, std::string)

void	rm_parent_on_remove (parser_t *)

const std::string &	fullname () const
	Return the full dot-separated path name of this parser node in the openMHA configuration tree. More...

Public Member Functions inherited from MHAPlugin::config_t< runtime_cfg_t >
	config_t ()

	~config_t ()

Private Member Functions
void	send_osc_float ()

void	update_mode ()
	Start/Stop sending of messages. More...

Private Attributes
MHAParser::string_t	host
	OSC server host name. More...

MHAParser::string_t	port
	OSC server port. More...

MHAParser::int_t	ttl
	Time-to-live of UDP packages. More...

MHAParser::vstring_t	vars
	List of AC variables to be saved, empty for all. More...

MHAParser::kw_t	mode
	Record mode. More...

MHAParser::int_t	skip
	number of frames to skip after sending More...

MHAParser::bool_t	rt_strict
	abort if used in real-time thread? More...

std::unique_ptr< MHA_AC::acspace2matrix_t >	acspace

MHAEvents::patchbay_t< ac2osc_t >	patchbay

bool	b_record

uint8_t *	rtmem

float	framerate

int	skipcnt

lo_address	lo_addr

bool	is_first_run

Additional Inherited Members
Public Attributes inherited from MHAParser::base_t
MHAEvents::emitter_t	writeaccess
	Event emitted on write access. More...

MHAEvents::emitter_t	valuechanged
	Event emitted if the value has changed. More...

MHAEvents::emitter_t	readaccess
	Event emitted on read access. More...

MHAEvents::emitter_t	prereadaccess
	Event emitted on read access, before the data field is accessed. More...

Protected Member Functions inherited from MHAParser::parser_t
std::string	op_subparse (expression_t &)

std::string	op_setval (expression_t &)

std::string	op_query (expression_t &)

std::string	query_type (const std::string &)

std::string	query_dump (const std::string &)

std::string	query_entries (const std::string &)

std::string	query_readfile (const std::string &)

std::string	query_savefile (const std::string &)

std::string	query_savefile_compact (const std::string &)

std::string	query_savemons (const std::string &)

std::string	query_val (const std::string &)

std::string	query_listids (const std::string &)

void	set_id_string (const std::string &)

bool	has_entry (const std::string &)

Protected Member Functions inherited from MHAParser::base_t
void	activate_query (const std::string &, query_t)

void	notify ()

Protected Member Functions inherited from MHAPlugin::config_t< runtime_cfg_t >
runtime_cfg_t *	poll_config ()
	Receive the latest run time configuration. More...

runtime_cfg_t *	peek_config () const
	Receive the latest run time configuration without changing the configuration pointer. More...

void	push_config (runtime_cfg_t *ncfg)
	Push a new run time configuration into the configuration fifo. More...

void	cleanup_unused_cfg ()
	To be called by the push_config() for housekeeping. More...

void	remove_all_cfg ()
	To be called on Plugin destruction, will delete all runtime configuration list nodes and objects regardless of their in_use flag. More...

Protected Attributes inherited from MHAPlugin::plugin_t< int >
mhaconfig_t	tftype
	Member for storage of plugin interface configuration. More...

MHA_AC::algo_comm_t &	ac
	AC handle of the chain. More...

Protected Attributes inherited from MHAParser::base_t
query_map_t	queries

bool	data_is_initialized

Protected Attributes inherited from MHAPlugin::config_t< runtime_cfg_t >
runtime_cfg_t *	cfg
	Pointer to the runtime configuration currently used by the signal processing thread. More...

Detailed Description

Plugin class of the ac2osc plugin.

Constructor & Destructor Documentation

◆ ac2osc_t()

ac2osc_t::ac2osc_t	(	MHA_AC::algo_comm_t &	iac,
		const std::string &	configured_name
	)

C'tor of plugin class.

Member Function Documentation

◆ prepare()

void ac2osc_t::prepare ( mhaconfig_t & cf )

virtual

Implements MHAPlugin::plugin_t< int >.

◆ process() [1/3]

mha_wave_t* ac2osc_t::process ( mha_wave_t * s )

inline

Processing fct for waveforms.

Calls process(void).

◆ process() [2/3]

mha_spec_t* ac2osc_t::process ( mha_spec_t * s )

inline

Processing fct for spectra.

Calls process(void).

◆ process() [3/3]

void ac2osc_t::process ( void )

Process function.

Checks once if the plugin is run in a real-time thread and throws if rt_strict is true, sends osc messages according to config.

◆ release()

void ac2osc_t::release ( void )

virtual

Release frees osc related memory, does cleanup.

Reimplemented from MHAPlugin::plugin_t< int >.

◆ send_osc_float()

void ac2osc_t::send_osc_float ( )

private

◆ update_mode()

void ac2osc_t::update_mode ( )

private

Start/Stop sending of messages.

Member Data Documentation

◆ host

MHAParser::string_t ac2osc_t::host

private

OSC server host name.

◆ port

MHAParser::string_t ac2osc_t::port

private

OSC server port.

◆ ttl

MHAParser::int_t ac2osc_t::ttl

private

Time-to-live of UDP packages.

◆ vars

MHAParser::vstring_t ac2osc_t::vars

private

List of AC variables to be saved, empty for all.

◆ mode

MHAParser::kw_t ac2osc_t::mode

private

Record mode.

◆ skip

MHAParser::int_t ac2osc_t::skip

private

number of frames to skip after sending

◆ rt_strict

MHAParser::bool_t ac2osc_t::rt_strict

private

abort if used in real-time thread?

◆ acspace

std::unique_ptr<MHA_AC::acspace2matrix_t> ac2osc_t::acspace

private

◆ patchbay

MHAEvents::patchbay_t<ac2osc_t> ac2osc_t::patchbay

private

◆ b_record

bool ac2osc_t::b_record

private

◆ rtmem

uint8_t* ac2osc_t::rtmem

private

◆ framerate

float ac2osc_t::framerate

private

◆ skipcnt

int ac2osc_t::skipcnt

private

◆ lo_addr

lo_address ac2osc_t::lo_addr

private

◆ is_first_run

bool ac2osc_t::is_first_run

private

The documentation for this class was generated from the following file:

ac2osc.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ac2osc_t()

Member Function Documentation

◆ prepare()

◆ process() [1/3]

◆ process() [2/3]

◆ process() [3/3]

◆ release()

◆ send_osc_float()

◆ update_mode()

Member Data Documentation

◆ host

◆ port

◆ ttl

◆ vars

◆ mode

◆ skip

◆ rt_strict

◆ acspace

◆ patchbay

◆ b_record

◆ rtmem

◆ framerate

◆ skipcnt

◆ lo_addr

◆ is_first_run