Inheritance diagram for adaptive_feedback_canceller:

Public Member Functions
	adaptive_feedback_canceller (MHA_AC::algo_comm_t &ac, const std::string &configured_name)
	Constructs our plugin. More...

	~adaptive_feedback_canceller ()

mha_wave_t *	process (mha_wave_t *)

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

void	release ()

Public Member Functions inherited from MHAPlugin::plugin_t< adaptive_feedback_canceller_config >
	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::float_t	stepsize

MHAParser::float_t	min_const

MHAParser::int_t	filter_length

MHAParser::mhapluginloader_t	plugloader
	Plugin loader that loads the plugin needed to simulate the hearing aid in the forward processing path. More...

MHAParser::int_t	fragsize
	Fragsize for computing adaptive_feedback_canceller::delay_roundtrip and adaptive_feedback_canceller::delay_update, defaults to the MHA's fragsize. More...

MHAParser::vint_t	measured_roundtrip_latency
	The roundtrip latency describes the timespan between playing back and receiving the same signal, including delays induced by soundcard buffering and the transducers. More...

MHAParser::bool_t	use_lpc_decorr
	Boolean defining whether decorrelation using LPC-filtering of microphone and loudspeaker signal should be performed. More...

MHAParser::int_t	lpc_order

MHAParser::vint_t	delay_forward_path

MHAParser::int_t	blocks_no_update

MHAParser::bool_t	debug_mode
	debug_mode == true provides more variables in the AC-space that are useful for debugging, including FBfilter_estim_ac, ERRsig_ac, current_power_ac, estim_err_ac 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 Member Functions
void	update_cfg ()

Private Attributes
MHAEvents::patchbay_t< adaptive_feedback_canceller >	patchbay

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

Constructor & Destructor Documentation

◆ adaptive_feedback_canceller()

adaptive_feedback_canceller::adaptive_feedback_canceller	(	MHA_AC::algo_comm_t &	ac,
		const std::string &	configured_name
	)

Constructs our plugin.

◆ ~adaptive_feedback_canceller()

adaptive_feedback_canceller::~adaptive_feedback_canceller ( )

Member Function Documentation

◆ process()

mha_wave_t * adaptive_feedback_canceller::process ( mha_wave_t * signal )

◆ prepare()

void adaptive_feedback_canceller::prepare ( mhaconfig_t & signal_info )

virtual

Plugin preparation.

An opportunity to validate configuration parameters before instantiating a configuration.

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

◆ release()

void adaptive_feedback_canceller::release ( void )

virtual

Reimplemented from MHAPlugin::plugin_t< adaptive_feedback_canceller_config >.

◆ update_cfg()

void adaptive_feedback_canceller::update_cfg ( )

private

Member Data Documentation

◆ stepsize

MHAParser::float_t adaptive_feedback_canceller::stepsize

◆ min_const

MHAParser::float_t adaptive_feedback_canceller::min_const

◆ filter_length

MHAParser::int_t adaptive_feedback_canceller::filter_length

◆ plugloader

MHAParser::mhapluginloader_t adaptive_feedback_canceller::plugloader

Plugin loader that loads the plugin needed to simulate the hearing aid in the forward processing path.

◆ fragsize

MHAParser::int_t adaptive_feedback_canceller::fragsize

Fragsize for computing adaptive_feedback_canceller::delay_roundtrip and adaptive_feedback_canceller::delay_update, defaults to the MHA's fragsize.

It is assumed that the soundcard's and the MHA's fragsize are equal. In special cases, the user can set this variable to an individual value.

◆ measured_roundtrip_latency

MHAParser::vint_t adaptive_feedback_canceller::measured_roundtrip_latency

The roundtrip latency describes the timespan between playing back and receiving the same signal, including delays induced by soundcard buffering and the transducers.

Can be measured via jack_iodelay. It is used to compute delay_roundtrip and delay_update for computations in the backward path.

◆ use_lpc_decorr

MHAParser::bool_t adaptive_feedback_canceller::use_lpc_decorr

Boolean defining whether decorrelation using LPC-filtering of microphone and loudspeaker signal should be performed.

NOTE: The algorithm did not yet implement the decorrelation via LPC coefficients. If you set this variable to 'true' in the current state, the plugin will not work.

◆ lpc_order

MHAParser::int_t adaptive_feedback_canceller::lpc_order

◆ delay_forward_path

MHAParser::vint_t adaptive_feedback_canceller::delay_forward_path

◆ blocks_no_update

MHAParser::int_t adaptive_feedback_canceller::blocks_no_update

◆ debug_mode

MHAParser::bool_t adaptive_feedback_canceller::debug_mode

debug_mode == true provides more variables in the AC-space that are useful for debugging, including FBfilter_estim_ac, ERRsig_ac, current_power_ac, estim_err_ac

◆ patchbay

MHAEvents::patchbay_t<adaptive_feedback_canceller> adaptive_feedback_canceller::patchbay