The Open Master Hearing Aid (openMHA)  openMHA
Open community platform for hearing aid algorithm research
dc_simple::dc_if_t Class Reference

interface class for dc_simple More...

Inheritance diagram for dc_simple::dc_if_t:
Inheritance graph

Public Member Functions

 dc_if_t (MHA_AC::algo_comm_t &iac, const std::string &configured_name)
 Constructor instantiates one dc_simple plugin. More...
 
void prepare (mhaconfig_t &tf)
 Prepare dc_simple plugin for signal processing. More...
 
void release ()
 Sets prepared back to False. More...
 
mha_spec_tprocess (mha_spec_t *s)
 Main process callback. More...
 
mha_wave_tprocess (mha_wave_t *s)
 Main process callback. More...
 
- Public Member Functions inherited from MHAPlugin::plugin_t< dc_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 ()
 
- Public Member Functions inherited from dc_simple::dc_vars_t
 dc_vars_t (MHAParser::parser_t &p)
 

Private Member Functions

void update_dc ()
 Update dc_t runtime config when configuration parameters have changed. More...
 
void update_level ()
 Update level_smoother_t runtime config when configuration parameters have changed. More...
 
void has_been_modified ()
 
void read_modified ()
 
void update_level_mon ()
 Updates the data of variable mon_l in dc_t. More...
 
void update_gain_mon ()
 Updates the data of variable mon_g in dc_t. More...
 

Private Attributes

MHAParser::string_t clientid
 MHA Parser variables. More...
 
MHAParser::string_t gainrule
 
MHAParser::string_t preset
 
MHAParser::int_mon_t modified
 
MHAParser::vfloat_mon_t mon_l
 
MHAParser::vfloat_mon_t mon_g
 
MHAParser::string_t filterbank
 
MHAParser::vfloat_mon_t center_frequencies
 
MHAParser::vfloat_mon_t edge_frequencies
 
MHAEvents::patchbay_t< dc_if_tpatchbay
 
bool prepared
 

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 dc_simple::dc_vars_t
MHAParser::vfloat_t g50
 
MHAParser::vfloat_t g80
 
MHAParser::vfloat_t maxgain
 
MHAParser::vfloat_t expansion_threshold
 
MHAParser::vfloat_t expansion_slope
 
MHAParser::vfloat_t limiter_threshold
 
MHAParser::vfloat_t tauattack
 
MHAParser::vfloat_t taudecay
 
MHAParser::bool_t bypass
 
- 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< dc_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

interface class for dc_simple

Constructor & Destructor Documentation

◆ dc_if_t()

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

Constructor instantiates one dc_simple plugin.

Member Function Documentation

◆ prepare()

void dc_simple::dc_if_t::prepare ( mhaconfig_t tf)
virtual

Prepare dc_simple plugin for signal processing.

Parameters
tfsignal_dimensions

Implements MHAPlugin::plugin_t< dc_t >.

◆ release()

void dc_simple::dc_if_t::release ( void  )
virtual

Sets prepared back to False.

Reimplemented from MHAPlugin::plugin_t< dc_t >.

◆ process() [1/2]

mha_spec_t * dc_simple::dc_if_t::process ( mha_spec_t s)

Main process callback.

Takes mhatype spectrum input and calls type DC and LEVEL process methods, returning mhatype spectrum.

Parameters
sinput/output signal

◆ process() [2/2]

mha_wave_t * dc_simple::dc_if_t::process ( mha_wave_t s)

Main process callback.

Takes mhatype wave input and calls type DC and LEVEL process methods, returning mhatype wave.

Parameters
sinput/output signal

◆ update_dc()

void dc_simple::dc_if_t::update_dc ( )
private

Update dc_t runtime config when configuration parameters have changed.

◆ update_level()

void dc_simple::dc_if_t::update_level ( )
private

Update level_smoother_t runtime config when configuration parameters have changed.

◆ has_been_modified()

void dc_simple::dc_if_t::has_been_modified ( )
inlineprivate

◆ read_modified()

void dc_simple::dc_if_t::read_modified ( )
inlineprivate

◆ update_level_mon()

void dc_simple::dc_if_t::update_level_mon ( )
private

Updates the data of variable mon_l in dc_t.

◆ update_gain_mon()

void dc_simple::dc_if_t::update_gain_mon ( )
private

Updates the data of variable mon_g in dc_t.

Member Data Documentation

◆ clientid

MHAParser::string_t dc_simple::dc_if_t::clientid
private

MHA Parser variables.

◆ gainrule

MHAParser::string_t dc_simple::dc_if_t::gainrule
private

◆ preset

MHAParser::string_t dc_simple::dc_if_t::preset
private

◆ modified

MHAParser::int_mon_t dc_simple::dc_if_t::modified
private

◆ mon_l

MHAParser::vfloat_mon_t dc_simple::dc_if_t::mon_l
private

◆ mon_g

MHAParser::vfloat_mon_t dc_simple::dc_if_t::mon_g
private

◆ filterbank

MHAParser::string_t dc_simple::dc_if_t::filterbank
private

◆ center_frequencies

MHAParser::vfloat_mon_t dc_simple::dc_if_t::center_frequencies
private

◆ edge_frequencies

MHAParser::vfloat_mon_t dc_simple::dc_if_t::edge_frequencies
private

◆ patchbay

MHAEvents::patchbay_t<dc_if_t> dc_simple::dc_if_t::patchbay
private

◆ prepared

bool dc_simple::dc_if_t::prepared
private

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