interface class for windnoise plugin More...

Inheritance diagram for windnoise::if_t:

Public Member Functions
	if_t (MHA_AC::algo_comm_t &iac, const std::string &configured_name)
	Constructor instantiates one windnoise plugin. More...

void	prepare (mhaconfig_t &signal_info) override
	Prepare windnoise plugin for signal processing. More...

void	release (void) override
	Nothing needs to be deallocated on release. More...

mha_spec_t *	process (mha_spec_t *signal)
	signal processing, delegates to cfg_t::process More...

void	update (void)
	update runtime config when configuration parameters have changed More...

void	insert ()
	inserts the windnoise detection vector into AC space More...

Public Member Functions inherited from MHAPlugin::plugin_t< cfg_t >
	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 ()

Public Attributes
MHAParser::bool_t	UseChannel_LF_attenuation

MHAParser::float_t	tau_Lowpass

MHAParser::float_t	LowPassCutOffFrequency

MHAParser::float_t	LowPassFraction

MHAParser::float_t	LowPassWindGain

MHAParser::kw_t	WindNoiseDetector

MHAParser::vint_mon_t	detected

MHAParser::vfloat_mon_t	lowpass_quotient

const std::string	detected_acname
	Name of AC variable mirroring the configuration monitor variable "detector". More...

const std::string	lowpass_quotient_acname
	Name of AC variable mirroring the configuration monitor variable "lowpass_quotient". More...

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...

Private Attributes
MHAEvents::patchbay_t< if_t >	patchbay
	The Event connector. More...

Additional Inherited Members
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< cfg_t >
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

interface class for windnoise plugin

Constructor & Destructor Documentation

◆ if_t()

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

Constructor instantiates one windnoise plugin.

Member Function Documentation

◆ prepare()

void windnoise::if_t::prepare ( mhaconfig_t & signal_info )

overridevirtual

Prepare windnoise plugin for signal processing.

Parameters

signal_info signal dimensions, not changed by this plugin

Implements MHAPlugin::plugin_t< cfg_t >.

◆ release()

void windnoise::if_t::release ( void )

inlineoverridevirtual

Nothing needs to be deallocated on release.

Reimplemented from MHAPlugin::plugin_t< cfg_t >.

◆ process()

mha_spec_t * windnoise::if_t::process ( mha_spec_t * signal )

signal processing, delegates to cfg_t::process

◆ update()

void windnoise::if_t::update ( void )

update runtime config when configuration parameters have changed

◆ insert()

void windnoise::if_t::insert ( )

inline

inserts the windnoise detection vector into AC space

Member Data Documentation

◆ patchbay

MHAEvents::patchbay_t<if_t> windnoise::if_t::patchbay

private

The Event connector.

◆ UseChannel_LF_attenuation

MHAParser::bool_t windnoise::if_t::UseChannel_LF_attenuation

◆ tau_Lowpass

MHAParser::float_t windnoise::if_t::tau_Lowpass

◆ LowPassCutOffFrequency

MHAParser::float_t windnoise::if_t::LowPassCutOffFrequency

◆ LowPassFraction

MHAParser::float_t windnoise::if_t::LowPassFraction

◆ LowPassWindGain

MHAParser::float_t windnoise::if_t::LowPassWindGain

◆ WindNoiseDetector

MHAParser::kw_t windnoise::if_t::WindNoiseDetector

◆ detected

MHAParser::vint_mon_t windnoise::if_t::detected

◆ lowpass_quotient

MHAParser::vfloat_mon_t windnoise::if_t::lowpass_quotient

◆ detected_acname

const std::string windnoise::if_t::detected_acname

Name of AC variable mirroring the configuration monitor variable "detector".

Usually "windnoise_detected".

◆ lowpass_quotient_acname

const std::string windnoise::if_t::lowpass_quotient_acname

Name of AC variable mirroring the configuration monitor variable "lowpass_quotient".

Usually "windnoise_lowpass_quotient".

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

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members