Async::AudioFilter Class Reference

A class for creating a wide range of audio filters. More...

#include <AsyncAudioFilter.h>

Inheritance diagram for Async::AudioFilter:

List of all members.

Public Member Functions

AudioFilter (const std::string &filter_spec, int sample_rate=INTERNAL_SAMPLE_RATE)
Constuctor.
~AudioFilter (void)
Destructor.
void setOutputGain (float gain)
Set the output gain of the filter.
void reset (void)
Reset the filter state.

Protected Member Functions

void processSamples (float *dest, const float *src, int count)
Process incoming samples and put them into the output buffer.

Detailed Description

A class for creating a wide range of audio filters.

Author:: Tobias Blomberg / SM0SVX

Date:: 2006-04-23

Definition at line 113 of file AsyncAudioFilter.h.

Constructor & Destructor Documentation

Async::AudioFilter::AudioFilter	(	const std::string &	filter_spec,
		int	sample_rate = `INTERNAL_SAMPLE_RATE`
	)			`[explicit]`

Constuctor.

Parameters:

	filter_spec	The filter specification
	sample_rate	The sampling rate

Async::AudioFilter::~AudioFilter ( void )

Destructor.

Member Function Documentation

void Async::AudioFilter::processSamples	(	float *	dest,
		const float *	src,
		int	count
	)			`[protected, virtual]`

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 is called from the base 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.

void Async::AudioFilter::reset ( void )

Reset the filter state.

void Async::AudioFilter::setOutputGain ( float gain ) [inline]

Set the output gain of the filter.

Parameters:

gain

The gain to set

Definition at line 133 of file AsyncAudioFilter.h.

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

AsyncAudioFilter.h