#include <portaudioRecorder/PortAudioRecorderDeviceDriver.h>

Inheritance diagram for PortAudioRecorderDeviceDriver:

Detailed Description

Definition at line 47 of file PortAudioRecorderDeviceDriver.h.

Public Member Functions
	PortAudioRecorderDeviceDriver ()

	PortAudioRecorderDeviceDriver (const PortAudioRecorderDeviceDriver &)=delete

	PortAudioRecorderDeviceDriver (PortAudioRecorderDeviceDriver &&)=delete

PortAudioRecorderDeviceDriver &	operator= (const PortAudioRecorderDeviceDriver &)=delete

PortAudioRecorderDeviceDriver &	operator= (PortAudioRecorderDeviceDriver &&)=delete

	~PortAudioRecorderDeviceDriver () override

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

bool	open (PortAudioRecorderDeviceDriverSettings &config)
	Configures the device. More...

bool	close () override
	Close the DeviceDriver. More...

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...

bool	startRecording () override
	Start the recording. More...

bool	stopRecording () override
	Stop the recording. More...

bool	getRecordingAudioBufferMaxSize (yarp::dev::AudioBufferSize &size) override

bool	getRecordingAudioBufferCurrentSize (yarp::dev::AudioBufferSize &size) override

bool	resetRecordingAudioBuffer () override

void	threadRelease () override
	Release method. More...

bool	threadInit () override
	Initialization method. More...

void	run () override
	Main body of the new thread. More...

Public Member Functions inherited from yarp::dev::IAudioGrabberSound
virtual	~IAudioGrabberSound ()
	Destructor. 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 DeviceDriver *	getImplementation ()
	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::os::Thread
	Thread ()
	Constructor. More...

virtual	~Thread ()
	Destructor. More...

virtual void	onStop ()
	Call-back, called while halting the thread (before join). More...

bool	start ()
	Start the new thread running. More...

bool	stop ()
	Stop the thread. 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...

bool	isStopping ()
	Returns true if the thread is stopping (Thread::stop has been called). More...

bool	isRunning ()
	Returns true if the thread is running (Thread::start has been called successfully and the thread has not stopped). More...

long int	getKey ()
	Get a unique identifier for the thread. 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 ()
	Query the current priority of the thread, if the OS supports that. More...

int	getPolicy ()
	Query the current scheduling policy of the thread, if the OS supports that. More...

bool	join (double seconds=-1)
	The function returns when the thread execution has completed. More...

void	setOptions (int stackSize=0)
	Set the stack size for the new thread. More...

Protected Member Functions
void	handleError ()

Protected Attributes
void *	m_system_resource

PortAudioRecorderDeviceDriverSettings	m_driverConfig

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Thread
static int	getCount ()
	Check how many threads are running. More...

static long int	getKeyOfCaller ()
	Get a unique identifier for the calling thread. More...

static void	yield ()
	Reschedule the execution of current thread, allowing other threads to run. More...

static void	setDefaultStackSize (int stackSize)
	Set the default stack size for all threads created after this point. More...

Constructor & Destructor Documentation

◆ PortAudioRecorderDeviceDriver() [1/3]

PortAudioRecorderDeviceDriver::PortAudioRecorderDeviceDriver ( )

Definition at line 136 of file PortAudioRecorderDeviceDriver.cpp.

◆ PortAudioRecorderDeviceDriver() [2/3]

PortAudioRecorderDeviceDriver::PortAudioRecorderDeviceDriver ( const PortAudioRecorderDeviceDriver & )

delete

◆ PortAudioRecorderDeviceDriver() [3/3]

PortAudioRecorderDeviceDriver::PortAudioRecorderDeviceDriver ( PortAudioRecorderDeviceDriver && )

delete

◆ ~PortAudioRecorderDeviceDriver()

PortAudioRecorderDeviceDriver::~PortAudioRecorderDeviceDriver ( )

override

Definition at line 146 of file PortAudioRecorderDeviceDriver.cpp.

Member Function Documentation

◆ close()

bool PortAudioRecorderDeviceDriver::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 243 of file PortAudioRecorderDeviceDriver.cpp.

◆ getRecordingAudioBufferCurrentSize()

bool PortAudioRecorderDeviceDriver::getRecordingAudioBufferCurrentSize ( yarp::dev::AudioBufferSize & size )

overridevirtual

Implements yarp::dev::IAudioGrabberSound.

Definition at line 411 of file PortAudioRecorderDeviceDriver.cpp.

◆ getRecordingAudioBufferMaxSize()

bool PortAudioRecorderDeviceDriver::getRecordingAudioBufferMaxSize ( yarp::dev::AudioBufferSize & size )

overridevirtual

Implements yarp::dev::IAudioGrabberSound.

Definition at line 418 of file PortAudioRecorderDeviceDriver.cpp.

◆ getSound()

bool PortAudioRecorderDeviceDriver::getSound	(	yarp::sig::Sound &	sound,
		size_t	min_number_of_samples,
		size_t	max_number_of_samples,
		double	max_samples_timeout_s
	)

overridevirtual

Get a sound from a device.

Examples: getSound(s, 0, 100, 0.1); returns a sound whose size can vary between 0 and 100, with a maximum blocking time of 0.1 getSound(s, 100, 100, 0.0); returns a sound with exact size of 100. It may block forever (more specifically, until sound size is at least 100). getSound(s, 100, 100000, 0.0); returns a sound with a minimum size of 0, while trying to transfer all the internal buffer. It may block forever (more specifically, until sound size is at least 100).

Parameters

sound	the sound to be filled
min_number_of_samples.	The function will block until the driver is able to collect at least min_number_of_samples. If set to zero, the function may return empty sounds.
max_number_of_samples.	The function will block until the driver is either able to collect max_number_of_samples or the timeout expires.
max_samples_timeout_s.	The timeout (in seconds) to retrieve max_number_of_samples.

Returns: true upon success, false for an invalid set of parameters, such as max_number_of_samples<min_number_of_samples, etc.

Implements yarp::dev::IAudioGrabberSound.

Definition at line 294 of file PortAudioRecorderDeviceDriver.cpp.

◆ handleError()

void PortAudioRecorderDeviceDriver::handleError ( )

protected

Definition at line 230 of file PortAudioRecorderDeviceDriver.cpp.

◆ open() [1/2]

bool PortAudioRecorderDeviceDriver::open ( PortAudioRecorderDeviceDriverSettings & config )

Configures the device.

rate: Sample rate to use, in Hertz. Specify 0 to use a default.

samples: Number of samples per call to getSound. Specify 0 to use a default.

channels: Number of channels of input. Specify 0 to use a default.

Returns: true on success

Definition at line 162 of file PortAudioRecorderDeviceDriver.cpp.

◆ open() [2/2]

bool PortAudioRecorderDeviceDriver::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 152 of file PortAudioRecorderDeviceDriver.cpp.

◆ operator=() [1/2]

PortAudioRecorderDeviceDriver& PortAudioRecorderDeviceDriver::operator= ( const PortAudioRecorderDeviceDriver & )

delete

◆ operator=() [2/2]

PortAudioRecorderDeviceDriver& PortAudioRecorderDeviceDriver::operator= ( PortAudioRecorderDeviceDriver && )

delete

◆ resetRecordingAudioBuffer()

bool PortAudioRecorderDeviceDriver::resetRecordingAudioBuffer ( )

overridevirtual

Implements yarp::dev::IAudioGrabberSound.

Definition at line 425 of file PortAudioRecorderDeviceDriver.cpp.

◆ run()

void PortAudioRecorderDeviceDriver::run ( )

overridevirtual

Main body of the new thread.

Override this method to do what you want. After Thread::start is called, this method will start running in a separate thread. It is important that this method either keeps checking Thread::isStopping to see if it should stop, or you override the Thread::onStop method to interact with it in some way to shut the new thread down. There is no really reliable, portable way to stop a thread cleanly unless that thread cooperates.

Implements yarp::os::Thread.

Definition at line 382 of file PortAudioRecorderDeviceDriver.cpp.

◆ startRecording()

bool PortAudioRecorderDeviceDriver::startRecording ( )

overridevirtual

Start the recording.

Returns: true/false upon success/failure

Implements yarp::dev::IAudioGrabberSound.

Definition at line 266 of file PortAudioRecorderDeviceDriver.cpp.

◆ stopRecording()

bool PortAudioRecorderDeviceDriver::stopRecording ( )

overridevirtual

Stop the recording.

Returns: true/false upon success/failure

Implements yarp::dev::IAudioGrabberSound.

Definition at line 280 of file PortAudioRecorderDeviceDriver.cpp.

◆ threadInit()

bool PortAudioRecorderDeviceDriver::threadInit ( )

overridevirtual

Initialization method.

The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.

Reimplemented from yarp::os::Thread.

Definition at line 376 of file PortAudioRecorderDeviceDriver.cpp.

◆ threadRelease()

void PortAudioRecorderDeviceDriver::threadRelease ( )

overridevirtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented from yarp::os::Thread.

Definition at line 372 of file PortAudioRecorderDeviceDriver.cpp.

Member Data Documentation

◆ m_driverConfig

PortAudioRecorderDeviceDriverSettings PortAudioRecorderDeviceDriver::m_driverConfig

protected

Definition at line 103 of file PortAudioRecorderDeviceDriver.h.

◆ m_system_resource

void* PortAudioRecorderDeviceDriver::m_system_resource

protected

Definition at line 101 of file PortAudioRecorderDeviceDriver.h.

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

src/devices/portaudioRecorder/PortAudioRecorderDeviceDriver.h
src/devices/portaudioRecorder/PortAudioRecorderDeviceDriver.cpp

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ PortAudioRecorderDeviceDriver() [1/3]

◆ PortAudioRecorderDeviceDriver() [2/3]

◆ PortAudioRecorderDeviceDriver() [3/3]

◆ ~PortAudioRecorderDeviceDriver()

Member Function Documentation

◆ close()

◆ getRecordingAudioBufferCurrentSize()

◆ getRecordingAudioBufferMaxSize()

◆ getSound()

◆ handleError()

◆ open() [1/2]

◆ open() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resetRecordingAudioBuffer()

◆ run()

◆ startRecording()

◆ stopRecording()

◆ threadInit()

◆ threadRelease()

Member Data Documentation

◆ m_driverConfig

◆ m_system_resource