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

Plugin class of lsl2ac. More...

Inheritance diagram for lsl2ac::lsl2ac_t:
Inheritance graph

Public Member Functions

 lsl2ac_t (MHA_AC::algo_comm_t &iac, const std::string &configured_name)
 
void prepare (mhaconfig_t &)
 Prepare constructs the vector of bridge variables and locks the configuration, then calls update(). More...
 
mha_wave_tprocess (mha_wave_t *s)
 Processing fct for waveforms. More...
 
mha_spec_tprocess (mha_spec_t *s)
 Processing fct for spectra. More...
 
void process ()
 Process function. More...
 
void release ()
 Release fct. 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_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 get_all_stream_names ()
 Retrieves all stream names from LSL and fills them into available_streams. More...
 
void update ()
 Construct new runtime configuration. More...
 
void setlock (bool lock_)
 Convencience function lock/unlock all config variables. More...
 

Private Attributes

MHAParser::vstring_t streams ={"List of LSL streams to be saved, empty for all.","[]"}
 Config variable for list of streams to be saved. More...
 
MHAParser::bool_t activate ={"Receive from network?","yes"}
 Config variable for activation/deactivation of plugin. More...
 
MHAParser::kw_t overrun_behavior ={"How to handle overrun","discard","[discard ignore]"}
 Config variable for overrun behavior. More...
 
MHAParser::int_t buffersize
 Config variable for maximum buffer size of LSL. More...
 
MHAParser::int_t chunksize
 Config variable for maximum chunk size of LSL. More...
 
MHAParser::int_t nchannels
 Config variable for number of channels to expect from LSL stream. More...
 
MHAParser::int_t nsamples
 Config variable for maximum chunk size of LSL. More...
 
MHAEvents::patchbay_t< lsl2ac_tpatchbay
 Patchbay for configuration callbacks. More...
 
MHAParser::vstring_mon_t available_streams ={"List of all available LSL streams"}
 Monitor variable containing all available streams. 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...
 
- 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_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

Plugin class of lsl2ac.

Constructor & Destructor Documentation

◆ lsl2ac_t()

lsl2ac::lsl2ac_t::lsl2ac_t ( MHA_AC::algo_comm_t iac,
const std::string &  configured_name 
)

Member Function Documentation

◆ prepare()

void lsl2ac::lsl2ac_t::prepare ( mhaconfig_t )
virtual

Prepare constructs the vector of bridge variables and locks the configuration, then calls update().

Implements MHAPlugin::plugin_t< cfg_t >.

◆ process() [1/3]

mha_wave_t* lsl2ac::lsl2ac_t::process ( mha_wave_t s)
inline

Processing fct for waveforms.

Calls process(void).

◆ process() [2/3]

mha_spec_t* lsl2ac::lsl2ac_t::process ( mha_spec_t s)
inline

Processing fct for spectra.

Calls process(void).

◆ process() [3/3]

void lsl2ac::lsl2ac_t::process ( void  )

Process function.

◆ release()

void lsl2ac::lsl2ac_t::release ( void  )
virtual

Release fct.

Unlocks variable name list

Reimplemented from MHAPlugin::plugin_t< cfg_t >.

◆ get_all_stream_names()

void lsl2ac::lsl2ac_t::get_all_stream_names ( )
private

Retrieves all stream names from LSL and fills them into available_streams.

◆ update()

void lsl2ac::lsl2ac_t::update ( )
private

Construct new runtime configuration.

◆ setlock()

void lsl2ac::lsl2ac_t::setlock ( bool  lock_)
private

Convencience function lock/unlock all config variables.

Parameters
lock_True to lock, False for unlock

Member Data Documentation

◆ streams

MHAParser::vstring_t lsl2ac::lsl2ac_t::streams ={"List of LSL streams to be saved, empty for all.","[]"}
private

Config variable for list of streams to be saved.

◆ activate

MHAParser::bool_t lsl2ac::lsl2ac_t::activate ={"Receive from network?","yes"}
private

Config variable for activation/deactivation of plugin.

◆ overrun_behavior

MHAParser::kw_t lsl2ac::lsl2ac_t::overrun_behavior ={"How to handle overrun","discard","[discard ignore]"}
private

Config variable for overrun behavior.

◆ buffersize

MHAParser::int_t lsl2ac::lsl2ac_t::buffersize
private

Config variable for maximum buffer size of LSL.

◆ chunksize

MHAParser::int_t lsl2ac::lsl2ac_t::chunksize
private

Config variable for maximum chunk size of LSL.

◆ nchannels

MHAParser::int_t lsl2ac::lsl2ac_t::nchannels
private

Config variable for number of channels to expect from LSL stream.

◆ nsamples

MHAParser::int_t lsl2ac::lsl2ac_t::nsamples
private

Config variable for maximum chunk size of LSL.

◆ patchbay

MHAEvents::patchbay_t<lsl2ac_t> lsl2ac::lsl2ac_t::patchbay
private

Patchbay for configuration callbacks.

◆ available_streams

MHAParser::vstring_mon_t lsl2ac::lsl2ac_t::available_streams ={"List of all available LSL streams"}
private

Monitor variable containing all available streams.


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