Interface class for fftfbpow plugin. More...

Inheritance diagram for fftfbpow::fftfbpow_interface_t:

Public Member Functions
	fftfbpow_interface_t (MHA_AC::algo_comm_t &iac, const std::string &configured_name)
	Constructor with standard MHA constructor parameters. More...

void	prepare (mhaconfig_t &tf)
	Standard MHA plugin prepare function. More...

mha_spec_t *	process (mha_spec_t *s)
	Standard MHA plugin process fct. More...

Public Member Functions inherited from MHAPlugin::plugin_t< fftfbpow_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...

virtual void	release ()

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 Member Functions inherited from MHAOvlFilter::fftfb_vars_t
	fftfb_vars_t (MHAParser::parser_t &p)
	construct a set of openMHA configuration language variables suitable for configuring the FFT-based overlapping filterbank. More...

Private Member Functions
void	update_cfg ()
	Constructs new runtime configuration in thread-safe manner. More...

Private Attributes
std::string	name
	Configured name of this plugin instance. More...

MHAEvents::patchbay_t< fftfbpow_interface_t >	patchbay
	Patchbay to connect to MHA configuration interface. 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...

Public Attributes inherited from MHAOvlFilter::fftfb_vars_t
scale_var_t	fscale
	Frequency scale type (lin/bark/log/erb). More...

scale_var_t	ovltype
	Filter shape (rect/lin/hann). More...

MHAParser::float_t	plateau
	relative plateau width. More...

MHAParser::kw_t	ftype
	Flag to decide wether edge or center frequencies are used. More...

fscale_t	f
	Frequency. More...

MHAParser::bool_t	normalize
	Normalize sum of channels. More...

MHAParser::bool_t	fail_on_nonmonotonic
	Fail if frequency entries are non-monotonic (otherwise sort) More...

MHAParser::bool_t	fail_on_unique_bins
	Fail if center frequencies share the same FFT bin. More...

MHAParser::bool_t	flag_allow_empty_bands
	Allow that frequency bands contain only zeros. More...

MHAParser::vfloat_mon_t	cf
	Final center frequencies in Hz. More...

MHAParser::vfloat_mon_t	ef
	Final edge frequencies in Hz. More...

MHAParser::vfloat_mon_t	cLTASS
	Bandwidth correction for LTASS noise (level of 0 dB RMS LTASS noise) More...

MHAParser::mfloat_mon_t	shapes

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< fftfbpow_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 fftfbpow plugin.

Constructor & Destructor Documentation

◆ fftfbpow_interface_t()

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

Constructor with standard MHA constructor parameters.

Parameters

iac	Handle to algorithm communication variable space
configured_name	Configured name of this plugin instance

Member Function Documentation

◆ prepare()

void fftfbpow::fftfbpow_interface_t::prepare ( mhaconfig_t & tf )

virtual

Standard MHA plugin prepare function.

Ensures that the input is in the frequency domain, calls update_cfg() and inserts fbpow into the AC space.

Parameters

tf	Incoming mha configuration structure, contains information about input signal

Implements MHAPlugin::plugin_t< fftfbpow_t >.

◆ process()

mha_spec_t * fftfbpow::fftfbpow_interface_t::process ( mha_spec_t * s )

Standard MHA plugin process fct.

Polls new config and calls process() of the runtime configuration.

Parameters

s	Input spectrum

Returns: Unchanged input spectrum

◆ update_cfg()

void fftfbpow::fftfbpow_interface_t::update_cfg ( void )

private

Constructs new runtime configuration in thread-safe manner.

Member Data Documentation

◆ name

std::string fftfbpow::fftfbpow_interface_t::name

private

Configured name of this plugin instance.

◆ patchbay

MHAEvents::patchbay_t<fftfbpow_interface_t> fftfbpow::fftfbpow_interface_t::patchbay

private

Patchbay to connect to MHA configuration interface.

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

fftfbpow.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fftfbpow_interface_t()

Member Function Documentation

◆ prepare()

◆ process()

◆ update_cfg()

Member Data Documentation

◆ name

◆ patchbay