audioFromFileDevice : This device driver, wrapped by default by AudioRecorderWrapper, is used to read data from a file and stream it to the network. More...

#include <audioFromFileDevice/AudioFromFileDevice.h>

Inheritance diagram for AudioFromFileDevice:

Public Member Functions
	AudioFromFileDevice ()

	AudioFromFileDevice (const AudioFromFileDevice &)=delete

	AudioFromFileDevice (AudioFromFileDevice &&)=delete

AudioFromFileDevice &	operator= (const AudioFromFileDevice &)=delete

AudioFromFileDevice &	operator= (AudioFromFileDevice &&)=delete

	~AudioFromFileDevice () override

bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

bool	setHWGain (double gain) override
	Sets the hardware gain of the grabbing device (if supported by the hardware)

bool	stopRecording () override
	Stop the recording.

Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()

	DeviceDriver (const DeviceDriver &other)=delete

	DeviceDriver (DeviceDriver &&other) noexcept=delete

DeviceDriver &	operator= (const DeviceDriver &other)=delete

DeviceDriver &	operator= (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 DeviceDriver *	getImplementation ()
	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	isRecording (bool &recording_enabled) override
	Check if the recording has been enabled (e.g.

virtual bool	getRecordingAudioBufferMaxSize (yarp::sig::AudioBufferSize &size) override

virtual bool	getRecordingAudioBufferCurrentSize (yarp::sig::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 AudioFromFileDevice_ParamsParser
	AudioFromFileDevice_ParamsParser ()

	~AudioFromFileDevice_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 AudioFromFileDevice_ParamsParser
const std::string	m_device_classname = {"AudioFromFileDevice"}

const std::string	m_device_name = {"audioFromFileDevice"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_use_params_from_file_defaultValue = {"true"}

const std::string	m_file_name_defaultValue = {"audio.wav"}

const std::string	m_period_defaultValue = {"0.010"}

const std::string	m_driver_frame_size_defaultValue = {"512"}

const std::string	m_reset_on_stop_defaultValue = {"false"}

bool	m_use_params_from_file = {true}

std::string	m_file_name = {"audio.wav"}

double	m_period = {0.010}

int	m_driver_frame_size = {512}

bool	m_reset_on_stop = {false}

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_16t *	m_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

audioFromFileDevice : This device driver, wrapped by default by AudioRecorderWrapper, is used to read data from a file and stream it to the network.

This device driver derives from AudioRecorderDeviceBase base class. Please check its documentation for additional details.

Parameters required by this device are shown in class: AudioFromFileDevice_ParamsParser and AudioRecorderDeviceBase

See Audio in YARP for additional documentation on YARP audio.

Definition at line 31 of file AudioFromFileDevice.h.

Constructor & Destructor Documentation

◆ AudioFromFileDevice() [1/3]

AudioFromFileDevice::AudioFromFileDevice ( )

Definition at line 30 of file AudioFromFileDevice.cpp.

◆ AudioFromFileDevice() [2/3]

AudioFromFileDevice::AudioFromFileDevice ( const AudioFromFileDevice & )

delete

◆ AudioFromFileDevice() [3/3]

AudioFromFileDevice::AudioFromFileDevice ( AudioFromFileDevice && )

delete

◆ ~AudioFromFileDevice()

AudioFromFileDevice::~AudioFromFileDevice ( )

override

Definition at line 35 of file AudioFromFileDevice.cpp.

Member Function Documentation

◆ close()

bool AudioFromFileDevice::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 97 of file AudioFromFileDevice.cpp.

◆ open()

bool AudioFromFileDevice::open ( yarp::os::Searchable & config )

overridevirtual

Open the DeviceDriver.

Parameters

config is 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 45 of file AudioFromFileDevice.cpp.

◆ operator=() [1/2]

AudioFromFileDevice & AudioFromFileDevice::operator= ( AudioFromFileDevice && )

delete

◆ operator=() [2/2]

AudioFromFileDevice & AudioFromFileDevice::operator= ( const AudioFromFileDevice & )

delete

◆ setHWGain()

bool AudioFromFileDevice::setHWGain ( double gain )

overridevirtual

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

Parameters

gain	the audio gain (1.0 is the default value)

Returns: true/false upon success/failure

Implements yarp::dev::IAudioGrabberSound.

Definition at line 39 of file AudioFromFileDevice.cpp.

◆ stopRecording()

bool AudioFromFileDevice::stopRecording ( )

overridevirtual

Stop the recording.

Returns: true/false upon success/failure

Reimplemented from yarp::dev::AudioRecorderDeviceBase.

Definition at line 103 of file AudioFromFileDevice.cpp.

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

src/devices/audioFromFileDevice/AudioFromFileDevice.h
src/devices/audioFromFileDevice/AudioFromFileDevice.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AudioFromFileDevice() [1/3]

◆ AudioFromFileDevice() [2/3]

◆ AudioFromFileDevice() [3/3]

◆ ~AudioFromFileDevice()

Member Function Documentation

◆ close()

◆ open()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setHWGain()

◆ stopRecording()