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

Parser variables corresponding to one alsa device. More...

Inheritance diagram for alsa_dev_par_parser_t:
Inheritance graph

Public Member Functions

 alsa_dev_par_parser_t (snd_pcm_stream_t stream_dir)
 Constructor inserts the parser variables into this sub-parser. 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 Attributes

MHAParser::string_t device
 Name of the device in the alsa world, like "hw:0.0", "default", etc. More...
 
MHAParser::int_t nperiods
 Number of buffers of fragsize to hold in the alsa buffer. More...
 
snd_pcm_stream_t stream_dir
 Remember the direction (capture/playback) of this device. More...
 
- 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...
 

Additional Inherited Members

- 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

Parser variables corresponding to one alsa device.

ALSA separates audio capture and audio playback into two different devices that have to be opened separately. This class encapsulates the parser variables that pertain to one such direction.

Constructor & Destructor Documentation

◆ alsa_dev_par_parser_t()

alsa_dev_par_parser_t::alsa_dev_par_parser_t ( snd_pcm_stream_t  stream_dir)

Constructor inserts the parser variables into this sub-parser.

Parameters
stream_dircapture or playback

Member Data Documentation

◆ device

MHAParser::string_t alsa_dev_par_parser_t::device

Name of the device in the alsa world, like "hw:0.0", "default", etc.

◆ nperiods

MHAParser::int_t alsa_dev_par_parser_t::nperiods

Number of buffers of fragsize to hold in the alsa buffer.

Usually 2, the minimum possible.

◆ stream_dir

snd_pcm_stream_t alsa_dev_par_parser_t::stream_dir

Remember the direction (capture/playback) of this device.


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