A class that implements a parametric peaking/notching EQ filter. More...

#include <omSoundParametricFilter.h>

Inheritance diagram for om::sound::filters::ParametricFilter:

Public Member Functions
	ParametricFilter ()
	Create a default parametric filter at 1000Hz with 0dB gain. More...

	ParametricFilter (Float newCenterFrequency, Float newQ, Gain newGain)
	Create a parametric filter with the specified center frequency, q factor, and linear gain. More...

Float	getFrequency () const
	Return the center frequency of this parametric filter. More...

void	setFrequency (Float newCenterFrequency)
	Set the center frequency of this parametric filter. More...

Float	getQ () const
	Return the Q factor of this parametric filter. More...

void	setQ (Float newQ)
	Set the Q factor of this parametric filter. More...

Float	getBandwidth () const
	Return the octave bandwidth of this parametric filter. More...

void	setBandwidth (Float newBandwidth)
	Set the octave bandwidth of this parametric filter. More...

Gain	getGain () const
	Return the linear gain of this parametric filter. More...

Gain	getGainDB () const
	Return the gain in decibels of this parametric filter. More...

void	setGain (Gain newGain)
	Set the linear gain of this parametric filter. More...

void	setGainDB (Gain newGain)
	Set the gain in decibels of this parametric filter. More...

virtual UTF8String	getName () const
	Return a human-readable name for this parametric filter. More...

virtual UTF8String	getManufacturer () const
	Return the manufacturer name of this parametric filter. More...

virtual FilterVersion	getVersion () const
	Return an object representing the version of this parametric filter. More...

virtual FilterCategory	getCategory () const
	Return an object that describes the category of effect that this filter implements. More...

virtual Bool	allowsInPlaceProcessing () const
	Return whether or not this parametric filter can process audio data in-place. More...

virtual Size	getParameterCount () const
	Return the total number of generic accessible parameters this filter has. More...

virtual Bool	getParameterInfo (Index parameterIndex, FilterParameterInfo &info) const
	Get information about the parameter at the specified index. More...

Public Member Functions inherited from om::sound::filters::SoundFilter
virtual	~SoundFilter ()
	Destroy this sound filter object. More...

SoundResult	read (SoundBuffer &outputBuffer, Size numSamples)
	Fill the specified output buffer with the requested number of samples, based on internal filter state. More...

SoundResult	read (SoundFrame &outputFrame, Size numSamples)
	Fill the specified output frame with the requested number of samples, based on internal filter state. More...

SoundResult	write (const SoundBuffer &inputBuffer, Size numSamples)
	Process the specified input buffer samples and do something with them. More...

SoundResult	write (const SoundFrame &inputFrame, Size numSamples)
	Process the specified input frame samples and do something with them. More...

SoundResult	process (const SoundBuffer &inputBuffer, SoundBuffer &outputBuffer, Size numSamples)
	Apply this filter to the specified input buffer data, placing the result in the output buffer. More...

SoundResult	process (const SoundBuffer &inputBuffer, SoundFrame &outputFrame, Size numSamples)
	Apply this filter to the specified input buffer data, placing the result in the output frame. More...

SoundResult	process (const SoundFrame &inputFrame, SoundFrame &outputFrame, Size numSamples)
	Apply this filter to the specified input frame data, placing the result in the output frame. More...

SoundResult	process (const SoundFrame &inputBuffer, SoundBuffer &outputBuffer, Size numSamples)
	Apply this filter to the specified input frame data, placing the result in the output buffer. More...

void	reset ()
	Signal to the filter that the audio stream is restarting. More...

UInt64	getFrameIndex () const
	Return the index of the next frame to be processed (or the current one if currently processing). More...

Size	getInputCount () const
	Return the current number of audio inputs that this filter has. More...

virtual UTF8String	getInputName (Index inputIndex) const
	Return a human-readable name of the filter audio input at the specified index. More...

Size	getOutputCount () const
	Return the current number of audio outputs that this filter has. More...

virtual UTF8String	getOutputName (Index outputIndex) const
	Return a human-readable name of the filter audio output at the specified index. More...

Size	getMIDIInputCount () const
	Return the current number of MIDI inputs that this filter has. More...

virtual UTF8String	getMIDIInputName (Index inputIndex) const
	Return a human-readable name of the filter MIDI input at the specified index. More...

Size	getMIDIOutputCount () const
	Return the current number of MIDI outputs that this filter has. More...

virtual UTF8String	getMIDIOutputName (Index outputIndex) const
	Return a human-readable name of the filter MIDI output at the specified index. More...

virtual Time	getLatency () const
	Return a Time value indicating the latency of this sound filter in seconds. More...

virtual Bool	getParameterIndex (const UTF8String &parameterName, Index &parameterIndex) const
	Query the index of the parameter with the specified name. More...

virtual Bool	getParameterValueName (Index parameterIndex, const FilterParameter &value, UTF8String &name) const
	Get any special name associated with the specified value of an indexed parameter. More...

Bool	getParameter (Index parameterIndex, FilterParameter &value) const
	Place the value of the parameter at the specified index in the output parameter. More...

Bool	getParameter (Index parameterIndex, Bool &value) const
	Place the value of the parameter at the specified index in the output parameter. More...

Bool	getParameter (Index parameterIndex, Int64 &value) const
	Place the value of the parameter at the specified index in the output parameter. More...

Bool	getParameter (Index parameterIndex, Float32 &value) const
	Place the value of the parameter at the specified index in the output parameter. More...

Bool	getParameter (Index parameterIndex, Float64 &value) const
	Place the value of the parameter at the specified index in the output parameter. More...

template<typename ParameterType >
Bool	getParameter (const UTF8String &name, ParameterType &value) const
	Place the value of the parameter with the specified name in the output parameter. More...

template<typename ParameterType >
Bool	getParameter (const char *name, ParameterType &value) const
	Place the value of the parameter with the specified name in the output parameter. More...

Bool	setParameter (Index parameterIndex, const FilterParameter &value)
	Attempt to set the parameter value at the specified index. More...

Bool	setParameter (Index parameterIndex, Bool value)
	Attempt to set the parameter value at the specified index. More...

Bool	setParameter (Index parameterIndex, Int64 value)
	Attempt to set the parameter value at the specified index. More...

Bool	setParameter (Index parameterIndex, Float32 value)
	Attempt to set the parameter value at the specified index. More...

Bool	setParameter (Index parameterIndex, Float64 value)
	Attempt to set the parameter value at the specified index. More...

template<typename ParameterType >
Bool	setParameter (const UTF8String &name, ParameterType value)
	Attempt to set the parameter value with the specified name. More...

template<typename ParameterType >
Bool	setParameter (const char *name, ParameterType value)
	Attempt to set the parameter value with the specified name. More...

virtual Bool	writeState (DataOutputStream &stream) const
	Write the current state of this sound filter to a data output stream. More...

virtual Bool	readState (DataInputStream &stream)
	Read a previously saved filter state from the specified data input stream and replace the filter's state. More...

virtual Size	getPresetCount () const
	Return the number of standard configuration presets that this sound filter has. More...

virtual Bool	getPreset (Index presetIndex, FilterPreset &preset) const
	Get the standard preset for this sound filter with the specified index. More...

Bool	getIsSynchronized () const
	Return whether or not this sound filter performs thread synchronization. More...

void	setIsSynchronized (Bool newIsSynchronized)
	Set whether or not this sound filter performs thread synchronization. More...

Static Public Attributes
static const UTF8String	NAME
	A string indicating the human-readable name of this parametric filter. More...

static const UTF8String	MANUFACTURER
	A string indicating the manufacturer name of this parametric filter. More...

static const FilterVersion	VERSION
	An object indicating the version of this parametric filter. More...

Static Public Attributes inherited from om::sound::filters::SoundFilter
static const om::resources::ResourceType	RESOURCE_TYPE
	The resource type for a sound filter. More...

Additional Inherited Members
Static Public Member Functions inherited from om::sound::filters::SoundFilter
static Size	getMaximumNumberOfInputs ()
	Return the maximum number of audio inputs that a SoundFilter can support. More...

static Size	getMaximumNumberOfOutputs ()
	Return the maximum number of audio outputs that a SoundFilter can support. More...

static Size	getMaximumNumberOfMIDIInputs ()
	Return the maximum number of MIDI inputs that a SoundFilter can support. More...

static Size	getMaximumNumberOfMIDIOutputs ()
	Return the maximum number of MIDI outputs that a SoundFilter can support. More...

Protected Member Functions inherited from om::sound::filters::SoundFilter
	SoundFilter ()
	Create a new sound filter with 1 audio input and output, and no MIDI inputs or outputs. More...

	SoundFilter (Size numInputs, Size numOutputs)
	Create a new sound filter with the specified number of audio inputs and outputs. More...

	SoundFilter (Size numInputs, Size numOutputs, Size numMIDIInputs, Size numMIDIOutputs)
	Create a new sound filter with the specified number of audio inputs and outputs. More...

void	setInputCount (Size newNumInputs)
	Set the number of inputs that this filter should have. More...

void	setOutputCount (Size newNumOutputs)
	Set the number of outputs that this filter should have. More...

void	setMIDIInputCount (Size newNumMIDIInputs)
	Set the number of MIDI inputs that this filter should have. More...

void	setMIDIOutputCount (Size newNumMIDIOutputs)
	Set the number of MIDI outputs that this filter should have. More...

Bool	isFirstFrame () const
	Return whether or not the filter's next frame to be processed is also its first frame. More...

void	lockMutex () const
	Acquire a mutex which handles subclass rendering parameter synchronization. More...

void	unlockMutex () const
	Release a mutex which handles subclass rendering parameter synchronization. More...

Detailed Description

A class that implements a parametric peaking/notching EQ filter.

Constructor & Destructor Documentation

om::sound::filters::ParametricFilter::ParametricFilter ( )

Create a default parametric filter at 1000Hz with 0dB gain.

om::sound::filters::ParametricFilter::ParametricFilter	(	Float	newCenterFrequency,
		Float	newQ,
		Gain	newGain
	)

Create a parametric filter with the specified center frequency, q factor, and linear gain.

The center frequency and gain are clamped to the range of [0,+infinity].

Member Function Documentation

Float om::sound::filters::ParametricFilter::getFrequency ( ) const

inline

Return the center frequency of this parametric filter.

This is the frequency most affected by the filter.

void om::sound::filters::ParametricFilter::setFrequency ( Float newCenterFrequency )

inline

Set the center frequency of this parametric filter.

This is the frequency most affected by the filter. The new corner frequency is clamped to be in the range [0,+infinity].

Float om::sound::filters::ParametricFilter::getQ ( ) const

inline

Return the Q factor of this parametric filter.

This value controls the width of the boost or cut that the filter produces. A smaller Q indicates a wider filter, while a larger Q indicates a narrower filter.

void om::sound::filters::ParametricFilter::setQ ( Float newQ )

inline

Set the Q factor of this parametric filter.

This value controls the width of the boost or cut that the filter produces. A smaller Q indicates a wider filter, while a larger Q indicates a narrower filter.

The new Q value is clamped to the range [0, +infinity].

Float om::sound::filters::ParametricFilter::getBandwidth ( ) const

inline

Return the octave bandwidth of this parametric filter.

This value controls the width of the boost or cut that the filter produces. A larger bandwidth indicates a wider filter, while a smaller bandwidth indicates a narrower filter.

void om::sound::filters::ParametricFilter::setBandwidth ( Float newBandwidth )

inline

Set the octave bandwidth of this parametric filter.

This value controls the width of the boost or cut that the filter produces. A larger bandwidth indicates a wider filter, while a smaller bandwidth indicates a narrower filter.

Gain om::sound::filters::ParametricFilter::getGain ( ) const

inline

Return the linear gain of this parametric filter.

Gain om::sound::filters::ParametricFilter::getGainDB ( ) const

inline

Return the gain in decibels of this parametric filter.

void om::sound::filters::ParametricFilter::setGain ( Gain newGain )

inline

Set the linear gain of this parametric filter.

void om::sound::filters::ParametricFilter::setGainDB ( Gain newGain )

inline

Set the gain in decibels of this parametric filter.

virtual UTF8String om::sound::filters::ParametricFilter::getName ( ) const

virtual

Return a human-readable name for this parametric filter.

The method returns the string "Parametric Filter".

Reimplemented from om::sound::filters::SoundFilter.

virtual UTF8String om::sound::filters::ParametricFilter::getManufacturer ( ) const

virtual

Return the manufacturer name of this parametric filter.

The method returns the string "Om Sound".

Reimplemented from om::sound::filters::SoundFilter.

virtual FilterVersion om::sound::filters::ParametricFilter::getVersion ( ) const

virtual

Return an object representing the version of this parametric filter.

Reimplemented from om::sound::filters::SoundFilter.

virtual FilterCategory om::sound::filters::ParametricFilter::getCategory ( ) const

virtual

Return an object that describes the category of effect that this filter implements.

This method returns the value FilterCategory::EQUALIZER.

Reimplemented from om::sound::filters::SoundFilter.

virtual Bool om::sound::filters::ParametricFilter::allowsInPlaceProcessing ( ) const

virtual

Return whether or not this parametric filter can process audio data in-place.

This method always returns TRUE, parametric filters can process audio data in-place.

Reimplemented from om::sound::filters::SoundFilter.

virtual Size om::sound::filters::ParametricFilter::getParameterCount ( ) const

virtual

Return the total number of generic accessible parameters this filter has.

Reimplemented from om::sound::filters::SoundFilter.

virtual Bool om::sound::filters::ParametricFilter::getParameterInfo	(	Index	parameterIndex,
		FilterParameterInfo &	info
	)		const

virtual

Get information about the parameter at the specified index.

Reimplemented from om::sound::filters::SoundFilter.

Member Data Documentation

const UTF8String om::sound::filters::ParametricFilter::NAME

static

A string indicating the human-readable name of this parametric filter.

const UTF8String om::sound::filters::ParametricFilter::MANUFACTURER

static

A string indicating the manufacturer name of this parametric filter.

const FilterVersion om::sound::filters::ParametricFilter::VERSION

static

An object indicating the version of this parametric filter.

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

omSoundParametricFilter.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation