A Plugin class using the openMHA Event mechanism. More...

Inheritance diagram for example3_t:

Public Member Functions
	example3_t (MHA_AC::algo_comm_t &iac, const std::string &configured_name)
	This constructor initializes the configuration language variables and inserts them into the openMHA configuration tree. More...

void	prepare (mhaconfig_t &signal_info)
	Plugin preparation. More...

void	release (void)
	Bookkeeping only. More...

mha_wave_t *	process (mha_wave_t *signal)
	Signal processing performed by the plugin. 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	on_scale_ch_writeaccess ()

void	on_scale_ch_valuechanged ()

void	on_scale_ch_readaccess ()

void	on_prereadaccess ()

Private Attributes
MHAParser::int_t	scale_ch
	Index of audio channel to scale. More...

MHAParser::float_t	factor
	The scaling factor applied to the selected channel. More...

MHAParser::int_mon_t	prepared
	Keep Track of the prepare/release calls. More...

MHAEvents::patchbay_t< example3_t >	patchbay
	The Event connector. More...

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

A Plugin class using the openMHA Event mechanism.

This is the third example plugin for the step-by-step tutorial.

Constructor & Destructor Documentation

◆ example3_t()

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

This constructor initializes the configuration language variables and inserts them into the openMHA configuration tree.

It connects the openMHA Events triggered by these configuration variables to the respective callbacks.

Member Function Documentation

◆ on_scale_ch_writeaccess()

void example3_t::on_scale_ch_writeaccess ( )

private

◆ on_scale_ch_valuechanged()

void example3_t::on_scale_ch_valuechanged ( )

private

◆ on_scale_ch_readaccess()

void example3_t::on_scale_ch_readaccess ( )

private

◆ on_prereadaccess()

void example3_t::on_prereadaccess ( )

private

◆ prepare()

void example3_t::prepare ( mhaconfig_t & signal_info )

virtual

Plugin preparation.

This plugin checks that the input signal has the waveform domain and contains enough channels.

Parameters

signal_info Structure containing a description of the form of the signal (domain, number of channels, frames per block, sampling rate.

Implements MHAPlugin::plugin_t< int >.

◆ release()

void example3_t::release ( void )

virtual

Bookkeeping only.

Reimplemented from MHAPlugin::plugin_t< int >.

◆ process()

mha_wave_t * example3_t::process ( mha_wave_t * signal )

Signal processing performed by the plugin.

This plugin multiplies the signal in the selected audio channel by the configured factor.

Parameters

signal Pointer to the input signal structure.

Returns: Returns a pointer to the input signal structure, with a the signal modified by this plugin. (In-place processing)

Member Data Documentation

◆ scale_ch

MHAParser::int_t example3_t::scale_ch

private

Index of audio channel to scale.

◆ factor

MHAParser::float_t example3_t::factor

private

The scaling factor applied to the selected channel.

◆ prepared

MHAParser::int_mon_t example3_t::prepared

private

Keep Track of the prepare/release calls.

◆ patchbay

MHAEvents::patchbay_t<example3_t> example3_t::patchbay

private

The Event connector.

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

example3.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ example3_t()

Member Function Documentation

◆ on_scale_ch_writeaccess()

◆ on_scale_ch_valuechanged()

◆ on_scale_ch_readaccess()

◆ on_prereadaccess()

◆ prepare()

◆ release()

◆ process()

Member Data Documentation

◆ scale_ch

◆ factor

◆ prepared

◆ patchbay