YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches

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

#include <fake/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
 
virtual ~FakeMicrophone () override
 
bool setHWGain (double gain) override
 Sets the hardware gain of the grabbing device (if supported by the hardware)
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriveroperator= (const DeviceDriver &other)=delete
 
DeviceDriveroperator= (DeviceDriver &&other) noexcept=delete
 
virtual ~DeviceDriver ()
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- 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.
 
virtual bool startRecording () override
 Start the recording.
 
virtual bool stopRecording () override
 Stop the recording.
 
virtual bool isRecording (bool &recording_enabled) override
 Check if the recording has been enabled (e.g.
 
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.
 
virtual ~AudioRecorderDeviceBase ()
 
- Public Member Functions inherited from yarp::dev::IAudioGrabberSound
virtual ~IAudioGrabberSound ()
 Destructor.
 
- Public Member Functions inherited from yarp::os::PeriodicThread
 PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
 Constructor.
 
 PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
 Constructor.
 
virtual ~PeriodicThread ()
 
bool start ()
 Call this to start the thread.
 
void step ()
 Call this to "step" the thread rather than starting it.
 
void stop ()
 Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called).
 
void askToStop ()
 Stop the thread.
 
bool isRunning () const
 Returns true when the thread is started, false otherwise.
 
bool isSuspended () const
 Returns true when the thread is suspended, false otherwise.
 
bool setPeriod (double period)
 Set the (new) period of the thread.
 
double getPeriod () const
 Return the current period of the thread.
 
void suspend ()
 Suspend the thread, the thread keeps running by doLoop is never executed.
 
void resume ()
 Resume the thread if previously suspended.
 
void resetStat ()
 Reset thread statistics.
 
double getEstimatedPeriod () const
 Return estimated period since last reset.
 
void getEstimatedPeriod (double &av, double &std) const
 Return estimated period since last reset.
 
unsigned int getIterations () const
 Return the number of iterations performed since last reset.
 
double getEstimatedUsed () const
 Return the estimated duration of the run() function since last reset.
 
void getEstimatedUsed (double &av, double &std) const
 Return estimated duration of the run() function since last reset.
 
int setPriority (int priority, int policy=-1)
 Set the priority and scheduling policy of the thread, if the OS supports that.
 
int getPriority () const
 Query the current priority of the thread, if the OS supports that.
 
int getPolicy () const
 Query the current scheduling policy of the thread, if the OS supports that.
 
- Public Member Functions inherited from FakeMicrophone_ParamsParser
 FakeMicrophone_ParamsParser ()
 
 ~FakeMicrophone_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Additional Inherited Members

- Public Attributes inherited from FakeMicrophone_ParamsParser
const std::string m_device_classname = {"FakeMicrophone"}
 
const std::string m_device_name = {"fakeMicrophone"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_period_defaultValue = {"0.010"}
 
const std::string m_waveform_defaultValue = {"sine"}
 
const std::string m_signal_frequency_defaultValue = {"440"}
 
const std::string m_signal_amplitude_defaultValue = {"32000"}
 
const std::string m_driver_frame_size_defaultValue = {"512"}
 
double m_period = {0.010}
 
std::string m_waveform = {"sine"}
 
int m_signal_frequency = {440}
 
int m_signal_amplitude = {32000}
 
int m_driver_frame_size = {512}
 
- 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.
 
virtual void beforeStart ()
 Called just before a new thread starts.
 
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().
 
- 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 required by this device are shown in class: FakeMicrophone_ParamsParser This device also inherits some parameters from AudioRecorderDeviceBase

See Audio in YARP for additional documentation on YARP audio.

Definition at line 30 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 ( )
overridevirtual

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 79 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 88 of file FakeMicrophone.cpp.


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