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

Dummy sound io library. More...

Inheritance diagram for io_dummy_t:
Inheritance graph

Public Member Functions

 io_dummy_t (unsigned int fragsize, float samplerate, IOProcessEvent_t proc_event, void *proc_handle, IOStartedEvent_t start_event, void *start_handle, IOStoppedEvent_t stop_event, void *stop_handle)
void prepare (int nch_in)
 Prepare. More...
void release ()
 Release. More...
void start ()
 Initialize main_loop and start the loop immediately, stop on error. More...
void stop ()
 Send stop request to main loop and join thread. 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...

Private Attributes

float samplerate
 The framework's sampling rate. More...
unsigned int fragsize
 The framework's frag size. More...
IOProcessEvent_t proc_event
 Pointer to signal processing callback function. More...
IOStartedEvent_t start_event
 Pointer to start notification callback function. More...
IOStoppedEvent_t stop_event
 Pointer to stop notification callback function. More...
void * proc_handle
 Handles belonging to framework. More...
void * start_handle
void * stop_handle
std::unique_ptr< MHASignal::waveform_tin
 Input sound for framework, always zero. More...
 Output from framework, always ignored. More...
std::thread main_loop
 Main event loop. More...
std::atomic< bool > stop_request
 Stop request flag for main_loop. 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 Attributes inherited from MHAParser::base_t
query_map_t queries
bool data_is_initialized

Detailed Description

Dummy sound io library.

Simulates real time sound. Input is always zero, output is always ignored.

Constructor & Destructor Documentation

◆ io_dummy_t()

io_dummy_t::io_dummy_t ( unsigned int  fragsize,
float  samplerate,
IOProcessEvent_t  proc_event,
void *  proc_handle,
IOStartedEvent_t  start_event,
void *  start_handle,
IOStoppedEvent_t  stop_event,
void *  stop_handle 

Member Function Documentation

◆ prepare()

void io_dummy_t::prepare ( int  nch_in)


Initialized the input buffer

◆ release()

void io_dummy_t::release ( void  )


Frees the input buffer

◆ start()

void io_dummy_t::start ( )

Initialize main_loop and start the loop immediately, stop on error.

◆ stop()

void io_dummy_t::stop ( )

Send stop request to main loop and join thread.

Member Data Documentation

◆ samplerate

float io_dummy_t::samplerate

The framework's sampling rate.

◆ fragsize

unsigned int io_dummy_t::fragsize

The framework's frag size.

◆ proc_event

IOProcessEvent_t io_dummy_t::proc_event

Pointer to signal processing callback function.

◆ start_event

IOStartedEvent_t io_dummy_t::start_event

Pointer to start notification callback function.

Called when the user issues the start command.

◆ stop_event

IOStoppedEvent_t io_dummy_t::stop_event

Pointer to stop notification callback function.

Called when the user issues a stop request

◆ proc_handle

void* io_dummy_t::proc_handle

Handles belonging to framework.

◆ start_handle

void * io_dummy_t::start_handle

◆ stop_handle

void * io_dummy_t::stop_handle

◆ in

std::unique_ptr<MHASignal::waveform_t> io_dummy_t::in

Input sound for framework, always zero.

◆ out

mha_wave_t* io_dummy_t::out

Output from framework, always ignored.

◆ main_loop

std::thread io_dummy_t::main_loop

Main event loop.

Calls the framework's process chain periodically according to sampling rate and fragsize

◆ stop_request

std::atomic<bool> io_dummy_t::stop_request

Stop request flag for main_loop.

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