YARP
Yet Another Robot Platform

fakeMicrophone : fake microphone device implementing the IAudioGrabberSound interface to generate a test sound. More...

#include <fakeMicrophone/fakeMicrophone.h>

+ Inheritance diagram for fakeMicrophone:

Public Member Functions

 fakeMicrophone ()
 
 fakeMicrophone (const fakeMicrophone &)=delete
 
 fakeMicrophone (fakeMicrophone &&)=delete
 
fakeMicrophoneoperator= (const fakeMicrophone &)=delete
 
fakeMicrophoneoperator= (fakeMicrophone &&)=delete
 
 ~fakeMicrophone () override
 
bool setHWGain (double gain) override
 Sets the hardware gain of the grabbing device (if supported by the hardware) More...
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 ~DeviceDriver () override=default
 Destructor. More...
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver. More...
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others. More...
 
- Public Member Functions inherited from yarp::os::IConfig
virtual ~IConfig ()
 Destructor. More...
 
virtual bool configure (Searchable &config)
 Change online parameters. More...
 
- Public Member Functions inherited from yarp::dev::AudioRecorderDeviceBase
virtual bool getSound (yarp::sig::Sound &sound, size_t min_number_of_samples, size_t max_number_of_samples, double max_samples_timeout_s) override
 Get a sound from a device. More...
 
virtual bool startRecording () override
 Start the recording. More...
 
virtual bool stopRecording () override
 Stop the recording. More...
 
virtual bool isRecording (bool &recording_enabled) override
 Check if the recording has been enabled (e.g. More...
 
virtual bool getRecordingAudioBufferMaxSize (yarp::dev::AudioBufferSize &size) override
 
virtual bool getRecordingAudioBufferCurrentSize (yarp::dev::AudioBufferSize &size) override
 
virtual bool resetRecordingAudioBuffer () override
 
virtual bool setSWGain (double gain) override
 Sets a software gain for the grabbed audio. More...
 
virtual ~AudioRecorderDeviceBase ()
 
- Public Member Functions inherited from yarp::dev::IAudioGrabberSound
virtual ~IAudioGrabberSound ()
 Destructor. More...
 
- Public Member Functions inherited from yarp::os::PeriodicThread
 PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
 Constructor. More...
 
 PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
 Constructor. More...
 
virtual ~PeriodicThread ()
 
bool start ()
 Call this to start the thread. More...
 
void step ()
 Call this to "step" the thread rather than starting it. More...
 
void stop ()
 Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called). More...
 
void askToStop ()
 Stop the thread. More...
 
bool isRunning () const
 Returns true when the thread is started, false otherwise. More...
 
bool isSuspended () const
 Returns true when the thread is suspended, false otherwise. More...
 
bool setPeriod (double period)
 Set the (new) period of the thread. More...
 
double getPeriod () const
 Return the current period of the thread. More...
 
void suspend ()
 Suspend the thread, the thread keeps running by doLoop is never executed. More...
 
void resume ()
 Resume the thread if previously suspended. More...
 
void resetStat ()
 Reset thread statistics. More...
 
double getEstimatedPeriod () const
 Return estimated period since last reset. More...
 
void getEstimatedPeriod (double &av, double &std) const
 Return estimated period since last reset. More...
 
unsigned int getIterations () const
 Return the number of iterations performed since last reset. More...
 
double getEstimatedUsed () const
 Return the estimated duration of the run() function since last reset. More...
 
void getEstimatedUsed (double &av, double &std) const
 Return estimated duration of the run() function since last reset. More...
 
int setPriority (int priority, int policy=-1)
 Set the priority and scheduling policy of the thread, if the OS supports that. More...
 
int getPriority () const
 Query the current priority of the thread, if the OS supports that. More...
 
int getPolicy () const
 Query the current scheduling policy of the thread, if the OS supports that. More...
 

Additional Inherited Members

- Protected Member Functions inherited from yarp::dev::AudioRecorderDeviceBase
bool configureRecorderAudioDevice (yarp::os::Searchable &config, std::string device_name)
 
- Protected Member Functions inherited from yarp::os::PeriodicThread
virtual void threadRelease ()
 Release method. More...
 
virtual void beforeStart ()
 Called just before a new thread starts. More...
 
virtual void afterStart (bool success)
 Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start(). More...
 
- Protected Attributes inherited from yarp::dev::AudioRecorderDeviceBase
bool m_enable_buffer_autoclear = false
 
bool m_recording_enabled = false
 
std::mutex m_mutex
 
yarp::dev::CircularAudioBuffer_16tm_inputBuffer = nullptr
 
double m_sw_gain = 1.0
 
double m_hw_gain = 1.0
 
AudioDeviceDriverSettings m_audiorecorder_cfg
 
bool m_audiobase_debug = false
 
int16_t m_cliptol = 3
 

Detailed Description

fakeMicrophone : fake microphone device implementing the IAudioGrabberSound interface to generate a test sound.

It can generate various signals, i.e. sine, sawtooth, square wave, constant. This device driver derives from AudioRecorderDeviceBase base class. Please check its documentation for additional details.

Parameters used by this device are:

Parameter name SubParameter Type Units Default Value Required Description Notes
AUDIO_BASE *** - - No For the documentation of AUDIO_BASE group, please refer to the documentation of the base class AudioRecorderDeviceBase
period - double s 0.010 No the period of processing thread A value of 10ms is recommended. Do to not modify it
waveform - string - sine No Defines the shape of the waveform. Can be one of the following: sine,sawtooth,square,constant -
signal_frequency - int Hz 440 No Frequency of the generated signal -
signal_amplitude - int 32000 No Amplitude of the generated signal -
driver_frame_size - int samples 512 No the number of samples to process on each iteration of the thread -

See Audio in YARP for additional documentation on YARP audio.

Definition at line 36 of file fakeMicrophone.h.

Constructor & Destructor Documentation

◆ fakeMicrophone() [1/3]

fakeMicrophone::fakeMicrophone ( )

Definition at line 33 of file fakeMicrophone.cpp.

◆ fakeMicrophone() [2/3]

fakeMicrophone::fakeMicrophone ( const fakeMicrophone )
delete

◆ fakeMicrophone() [3/3]

fakeMicrophone::fakeMicrophone ( fakeMicrophone &&  )
delete

◆ ~fakeMicrophone()

fakeMicrophone::~fakeMicrophone ( )
override

Definition at line 38 of file fakeMicrophone.cpp.

Member Function Documentation

◆ close()

bool fakeMicrophone::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 118 of file fakeMicrophone.cpp.

◆ open()

bool fakeMicrophone::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 43 of file fakeMicrophone.cpp.

◆ operator=() [1/2]

fakeMicrophone& fakeMicrophone::operator= ( const fakeMicrophone )
delete

◆ operator=() [2/2]

fakeMicrophone& fakeMicrophone::operator= ( fakeMicrophone &&  )
delete

◆ setHWGain()

bool fakeMicrophone::setHWGain ( double  gain)
overridevirtual

Sets the hardware gain of the grabbing device (if supported by the hardware)

Parameters
gainthe audio gain (1.0 is the default value)
Returns
true/false upon success/failure

Implements yarp::dev::IAudioGrabberSound.

Definition at line 127 of file fakeMicrophone.cpp.


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