Async::AudioAmp Class Reference

An audio pipe class for amplification/attenuation of an audio stream. More...

#include <AsyncAudioAmp.h>

Inheritance diagram for Async::AudioAmp:

Public Member Functions
	AudioAmp (void)
	Default constuctor.
	~AudioAmp (void)
	Destructor.
void	setGain (float gain_db)
	Set the gain to use.
float	gain (void) const
	Read the gain.
Public Member Functions inherited from Async::AudioProcessor
	AudioProcessor (void)
	Default constuctor.
virtual	~AudioProcessor (void)
	Destructor.
int	writeSamples (const float *samples, int len)
	Write audio to the filter.
void	flushSamples (void)
	Order a flush of all samples.
void	resumeOutput (void)
	Resume output to the sink if previously stopped.
void	allSamplesFlushed (void)
	All samples have been flushed by the sink.
Public Member Functions inherited from Async::AudioSink
	AudioSink (void)
	Default constuctor.
virtual	~AudioSink (void)
	Destructor.
bool	registerSource (AudioSource *source)
	Register an audio source to provide samples to this sink.
void	unregisterSource (void)
	Unregister the previously registered audio source.
bool	isRegistered (void) const
	Check if an audio source has been registered.
AudioSource *	source (void) const
	Get the registered audio source.
Public Member Functions inherited from Async::AudioSource
	AudioSource (void)
	Default constuctor.
virtual	~AudioSource (void)
	Destructor.
bool	registerSink (AudioSink *sink, bool managed=false)
	Register an audio sink to provide samples to.
void	unregisterSink (void)
	Unregister the previously registered audio sink.
bool	isRegistered (void) const
	Check if an audio sink has been registered.
AudioSink *	sink (void) const
	Get the registered audio sink.
bool	sinkManaged (void) const
	Check if the sink is managed or not.
void	handleAllSamplesFlushed (void)
	The registered sink has flushed all samples.

Protected Member Functions
void	processSamples (float *dest, const float *src, int count)
	Process incoming samples and put them into the output buffer.
Protected Member Functions inherited from Async::AudioProcessor
void	setInputOutputSampleRate (int input_rate, int output_rate)
	Set the input and output sample rates.
Protected Member Functions inherited from Async::AudioSink
void	sourceResumeOutput (void)
	Tell the source that we are ready to accept more samples.
void	sourceAllSamplesFlushed (void)
	Tell the source that all samples have been flushed.
bool	setHandler (AudioSink *handler)
	Setup another sink to handle the incoming audio.
void	clearHandler (void)
	Clear a handler that was previously setup with setHandler.
AudioSink *	handler (void) const
Protected Member Functions inherited from Async::AudioSource
int	sinkWriteSamples (const float *samples, int len)
void	sinkFlushSamples (void)
bool	setHandler (AudioSource *handler)
	Setup another source to handle the outgoing audio.
AudioSource *	handler (void) const
void	clearHandler (void)
	Clear a handler that was previously setup with setHandler.

Detailed Description

An audio pipe class for amplification/attenuation of an audio stream.

Author

Tobias Blomberg / SM0SVX

Date

2006-07-08

Use this class to amplify or attenuate an audio stream.

Definition at line 112 of file AsyncAudioAmp.h.

Constructor & Destructor Documentation

AudioAmp()

Async::AudioAmp::AudioAmp ( void )

inline

Default constuctor.

Definition at line 118 of file AsyncAudioAmp.h.

~AudioAmp()

Async::AudioAmp::~AudioAmp ( void )

inline

Destructor.

Definition at line 123 of file AsyncAudioAmp.h.

Member Function Documentation

gain()

float Async::AudioAmp::gain ( void ) const

inline

Read the gain.

Returns

Return the gain in dB

Definition at line 135 of file AsyncAudioAmp.h.

processSamples()

void Async::AudioAmp::processSamples ( float * dest, const float * src, int count )

inlineprotectedvirtual

Process incoming samples and put them into the output buffer.

Parameters

dest	Destination buffer
src	Source buffer
count	Number of samples in the source buffer

This function should be reimplemented by the inheriting class to do the actual processing of the incoming samples. All samples must be processed, otherwise they are lost and the output buffer will contain garbage.

Implements Async::AudioProcessor.

Definition at line 139 of file AsyncAudioAmp.h.

setGain()

void Async::AudioAmp::setGain ( float gain_db )

inline

Set the gain to use.

Parameters

gain_db

The gain given in dB

Definition at line 129 of file AsyncAudioAmp.h.

---

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

• AsyncAudioAmp.h