The Open Master Hearing Aid (openMHA)  openMHA
Open community platform for hearing aid algorithm research
mconv::MConv Class Reference
Inheritance diagram for mconv::MConv:
Inheritance graph

Public Member Functions

 MConv (MHA_AC::algo_comm_t &iac, const std::string &algoname)
 Plugin constructor. More...
 
void prepare (mhaconfig_t &mhaconfig)
 Prepare this plugin for processing. More...
 
void release ()
 
mha_wave_tprocess (mha_wave_t *)
 
- Public Member Functions inherited from MHAPlugin::plugin_t< MHAFilter::partitioned_convolution_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_toperator= (const base_t &)=default
 
 base_t (base_t &&)=delete
 
base_toperator= (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 update ()
 Update is needed only once, since this plugin allows only change of irs after prepare(). More...
 
void update_irs ()
 This function updates the irs without allowing a change of its size after prepare(). More...
 

Private Attributes

MHAParser::int_t nchannels_out
 Number of output channels to produce. More...
 
MHAParser::vint_t inch
 Vector of input channel indices. More...
 
MHAParser::vint_t outch
 Vector of output channel indices. More...
 
MHAParser::mfloat_t irs
 Impulse responses, one per row. More...
 
unsigned int nchannels_in
 Number of input channels, set during prepare. More...
 
unsigned int fragsize
 Fragsize, set during prepare, is used as the partition length in the partitioned convolution. More...
 
MHAEvents::patchbay_t< MConvpatchbay
 

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< MHAFilter::partitioned_convolution_t >
mhaconfig_t tftype
 Member for storage of plugin interface configuration. More...
 
MHA_AC::algo_comm_tac
 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

class implements plugin for partitioned convolution. A matrix of impulse responses, filtering n input channels to m output channels, is supported.

Constructor & Destructor Documentation

◆ MConv()

mconv::MConv::MConv ( MHA_AC::algo_comm_t iac,
const std::string &  algoname 
)

Plugin constructor.

Parameters
iachandle and function pointers for algorithm communication
configured_nameThe name by which e.g an mhachain refers to this instance of the mconv plugin

Member Function Documentation

◆ prepare()

void mconv::MConv::prepare ( mhaconfig_t mhaconfig)
virtual

Prepare this plugin for processing.

Parameters
mhaconfigConfiguration for this plugin (Input/Output parameter) Sample rate, fragment size, number of channels are detailed here.

Implements MHAPlugin::plugin_t< MHAFilter::partitioned_convolution_t >.

◆ release()

void mconv::MConv::release ( void  )
virtual

◆ process()

mha_wave_t * mconv::MConv::process ( mha_wave_t s_in)

◆ update()

void mconv::MConv::update ( )
private

Update is needed only once, since this plugin allows only change of irs after prepare().

◆ update_irs()

void mconv::MConv::update_irs ( )
private

This function updates the irs without allowing a change of its size after prepare().

Member Data Documentation

◆ nchannels_out

MHAParser::int_t mconv::MConv::nchannels_out
private

Number of output channels to produce.

◆ inch

MHAParser::vint_t mconv::MConv::inch
private

Vector of input channel indices.

Each element in this vector identifies the input channel to which to apply the corresponding impulse response in irs.

◆ outch

MHAParser::vint_t mconv::MConv::outch
private

Vector of output channel indices.

Each element in this vector identifies the output channel to which the result of filtering with the corresponding impulse response in irs is mixed.

◆ irs

MHAParser::mfloat_t mconv::MConv::irs
private

Impulse responses, one per row.

For each row, the corresponding element of inch identifies the source channel, and the corresponding element of outch identifies the target channel.

◆ nchannels_in

unsigned int mconv::MConv::nchannels_in
private

Number of input channels, set during prepare.

◆ fragsize

unsigned int mconv::MConv::fragsize
private

Fragsize, set during prepare, is used as the partition length in the partitioned convolution.

◆ patchbay

MHAEvents::patchbay_t<MConv> mconv::MConv::patchbay
private

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