FIRFilter Class Reference

#include <FIRFilter.h>

Inheritance diagram for FIRFilter:

List of all members.

---

Detailed Description

Definition at line 47 of file FIRFilter.h.

Public Member Functions
	FIRFilter ()
virtual	~FIRFilter ()
void *	operator new (size_t s)
	Operator 'new' is overloaded so that it automatically creates a suitable instance depending on if we've a MMX-capable CPU available or not.
uint	evaluate (soundtouch::SAMPLETYPE *dest, const soundtouch::SAMPLETYPE *src, uint numSamples, uint numChannels) const
	Applies the filter to the given sequence of samples.
uint	getLength () const
virtual void	setCoefficients (const soundtouch::SAMPLETYPE *coeffs, uint newLength, uint uResultDivFactor)
Static Public Member Functions
static FIRFilter *	newInstance ()
Protected Member Functions
virtual uint	evaluateFilterStereo (soundtouch::SAMPLETYPE *dest, const soundtouch::SAMPLETYPE *src, uint numSamples) const
virtual uint	evaluateFilterMono (soundtouch::SAMPLETYPE *dest, const soundtouch::SAMPLETYPE *src, uint numSamples) const
Protected Attributes
uint	length
uint	lengthDiv8
uint	resultDivFactor
soundtouch::SAMPLETYPE	resultDivider
soundtouch::SAMPLETYPE *	filterCoeffs

---

Constructor & Destructor Documentation

FIRFilter::FIRFilter

(

)

Definition at line 58 of file FIRFilter.cpp.

FIRFilter::~FIRFilter

(

)

[virtual]

Definition at line 67 of file FIRFilter.cpp.

---

Member Function Documentation

uint FIRFilter::evaluateFilterStereo	(	soundtouch::SAMPLETYPE *	dest,
		const soundtouch::SAMPLETYPE *	src,
		uint	numSamples
	)			const [protected, virtual]

Reimplemented in FIRFilterMMX.

Definition at line 73 of file FIRFilter.cpp.

Referenced by evaluate().

uint FIRFilter::evaluateFilterMono	(	soundtouch::SAMPLETYPE *	dest,
		const soundtouch::SAMPLETYPE *	src,
		uint	numSamples
	)			const [protected, virtual]

Definition at line 128 of file FIRFilter.cpp.

Referenced by evaluate().

void * FIRFilter::operator new

(

size_t

s

)

Operator 'new' is overloaded so that it automatically creates a suitable instance depending on if we've a MMX-capable CPU available or not.

Definition at line 219 of file FIRFilter.cpp.

FIRFilter * FIRFilter::newInstance

(

)

[static]

Definition at line 227 of file FIRFilter.cpp.

Referenced by AAFilter::AAFilter().

uint FIRFilter::evaluate	(	soundtouch::SAMPLETYPE *	dest,
		const soundtouch::SAMPLETYPE *	src,
		uint	numSamples,
		uint	numChannels
	)			const

Applies the filter to the given sequence of samples.

Note : The amount of outputted samples is by value of 'filter_length' smaller than the amount of input samples.

Returns:

Number of samples copied to 'dest'.

Definition at line 199 of file FIRFilter.cpp.

Referenced by AAFilter::evaluate().

uint FIRFilter::getLength

(

)

const

Definition at line 188 of file FIRFilter.cpp.

Referenced by AAFilter::getLength().

void FIRFilter::setCoefficients	(	const soundtouch::SAMPLETYPE *	coeffs,
		uint	newLength,
		uint	uResultDivFactor
	)			[virtual]

Reimplemented in FIRFilterMMX.

Definition at line 170 of file FIRFilter.cpp.

Referenced by AAFilter::calculateCoeffs(), and FIRFilterMMX::setCoefficients().

---

Member Data Documentation

uint FIRFilter::length [protected]

Definition at line 51 of file FIRFilter.h.

Referenced by evaluate(), evaluateFilterMono(), FIRFilterMMX::evaluateFilterStereo(), evaluateFilterStereo(), FIRFilter(), getLength(), FIRFilterMMX::setCoefficients(), and setCoefficients().

uint FIRFilter::lengthDiv8 [protected]

Definition at line 53 of file FIRFilter.h.

Referenced by evaluate(), FIRFilterMMX::evaluateFilterStereo(), FIRFilter(), and setCoefficients().

uint FIRFilter::resultDivFactor [protected]

Definition at line 56 of file FIRFilter.h.

Referenced by evaluate(), evaluateFilterMono(), FIRFilterMMX::evaluateFilterStereo(), evaluateFilterStereo(), FIRFilter(), and setCoefficients().

soundtouch::SAMPLETYPE FIRFilter::resultDivider [protected]

Definition at line 59 of file FIRFilter.h.

Referenced by evaluateFilterMono(), evaluateFilterStereo(), and setCoefficients().

soundtouch::SAMPLETYPE* FIRFilter::filterCoeffs [protected]

Definition at line 62 of file FIRFilter.h.

Referenced by evaluateFilterMono(), evaluateFilterStereo(), FIRFilter(), setCoefficients(), and ~FIRFilter().

---

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

• FIRFilter.h
• FIRFilter.cpp