om::sound::filters::Saturator Class Reference

A class that provides a way to saturate audio in a frequency-dependent manner. More...

#include <omSoundSaturator.h>

Inheritance diagram for om::sound::filters::Saturator:

Public Member Functions
	Saturator ()
	Create a new saturator filter with the default input and output gains of 1. More...
	Saturator (const Saturator &other)
	Create an exact copy of another saturator. More...
	~Saturator ()
	Destroy this saturator, releasing all associated resources. More...
Saturator &	operator= (const Saturator &other)
	Assign the state of another saturator to this one. More...
Gain	getInputGain () const
	Return the current linear input gain factor of this saturator filter. More...
Gain	getInputGainDB () const
	Return the current input gain factor in decibels of this saturator filter. More...
void	setInputGain (Gain newInputGain)
	Set the target linear input gain for this saturator filter. More...
void	setInputGainDB (Gain newDBInputGain)
	Set the target input gain in decibels for this saturator filter. More...
Gain	getOutputGain () const
	Return the current linear output gain factor of this saturator filter. More...
Gain	getOutputGainDB () const
	Return the current output gain factor in decibels of this saturator filter. More...
void	setOutputGain (Gain newOutputGain)
	Set the target linear output gain for this saturator filter. More...
void	setOutputGainDB (Gain newDBOutputGain)
	Set the target output gain in decibels for this saturator filter. More...
Bool	getCrossoverIsEnabled () const
	Return whether or not this saturator filter's crossover filter is enabled. More...
void	setCrossoverIsEnabled (Bool newCrossoverIsEnabled)
	Set whether or not this saturator filter's crossover is enabled. More...
Float	getCrossoverFrequency () const
	Return the low pass filter frequency of this saturator filter. More...
void	setCrossoverFrequency (Float newCrossoverFrequency)
	Set the crossover frequency of this saturator filter. More...
Size	getCrossoverOrder () const
	Return the filter order of this saturator filter's crossover. More...
void	setCrossoverOrder (Size newCrossoverOrder)
	Set the crossover filter order of this saturator filter. More...
Bool	getLowEffectIsEnabled () const
	Return whether or not the low frequency saturation effect is enabled. More...
void	setLowEffectIsEnabled (Bool newLowEffectEnabled)
	Set whether or not the low frequency saturation effect is enabled. More...
Bool	getLowFilterIsEnabled () const
	Return whether or not the low frequency saturation effect is enabled. More...
void	setLowFilterIsEnabled (Bool newLowFilterEnabled)
	Set whether or not the low frequency low pass filter is enabled. More...
Gain	getLowDrive () const
	Return the current linear input gain factor for the low frequencies of the saturator. More...
Gain	getLowDriveDB () const
	Return the current input gain in decibels for the low frequencies of the saturator. More...
void	setLowDrive (Gain newLowDrive)
	Set the current linear input gain factor for the low frequencies of the saturator. More...
void	setLowDriveDB (Gain newDBLowDrive)
	Set the current input gain in decibels for the low frequencies of the saturator. More...
Gain	getLowGain () const
	Return the current linear output gain factor for the low frequencies of the saturator. More...
Gain	getLowGainDB () const
	Return the current output gain in decibels for the low frequencies of the saturator. More...
void	setLowGain (Gain newLowGain)
	Set the current linear output gain factor for the low frequencies of the saturator. More...
void	setLowGainDB (Gain newDBLowGain)
	Set the current output gain in decibels for the low frequencies of the saturator. More...
Bool	getHighEffectIsEnabled () const
	Return whether or not the high frequency saturation effect is enabled. More...
void	setHighEffectIsEnabled (Bool newHighEffectEnabled)
	Set whether or not the high frequency saturation effect is enabled. More...
Gain	getHighDrive () const
	Return the current linear input gain factor for the high frequencies of the saturator. More...
Gain	getHighDriveDB () const
	Return the current input gain in decibels for the high frequencies of the saturator. More...
void	setHighDrive (Gain newLowDrive)
	Set the current linear input gain factor for the high frequencies of the saturator. More...
void	setHighDriveDB (Gain newDBHighDrive)
	Set the current input gain in decibels for the high frequencies of the saturator. More...
Gain	getHighGain () const
	Return the current linear output gain factor for the high frequencies of the saturator. More...
Gain	getHighGainDB () const
	Return the current output gain in decibels for the high frequencies of the saturator. More...
void	setHighGain (Gain newHighGain)
	Set the current linear output gain factor for the high frequencies of the saturator. More...
void	setHighGainDB (Gain newDBHighGain)
	Set the current output gain in decibels for the high frequencies of the saturator. More...
Bool	getLowPassIsEnabled () const
	Return whether or not this saturation filter's low pass filter is enabled. More...
void	setLowPassIsEnabled (Bool newLowPassIsEnabled)
	Set whether or not this saturation filter's low pass filter is enabled. More...
Float	getLowPassFrequency () const
	Return the low pass filter frequency of this saturation filter. More...
void	setLowPassFrequency (Float newLowPassFrequency)
	Set the low pass filter frequency of this saturation filter. More...
Size	getLowPassOrder () const
	Return the low pass filter order of this saturation filter. More...
void	setLowPassOrder (Size newLowPassOrder)
	Set the low pass filter order of this saturation filter. More...
Bool	getLowsAreSoloed () const
	Return whether or not the low frequency band is currently being soloed. More...
void	setLowsAreSoloed (Bool newLowsSoloed)
	Return whether or not the low frequency band is currently being soloed. More...
Bool	getHighsAreSoloed () const
	Return whether or not the high frequency band is currently being soloed. More...
void	setHighsAreSoloed (Bool newHighsSoloed)
	Return whether or not the high frequency band is currently being soloed. More...
virtual UTF8String	getName () const
	Return a human-readable name for this saturator filter. More...
virtual UTF8String	getManufacturer () const
	Return the manufacturer name of this saturator filter. More...
virtual FilterVersion	getVersion () const
	Return an object representing the version of this saturator filter. More...
virtual FilterCategory	getCategory () const
	Return an object that describes the category of effect that this filter implements. More...
virtual Size	getParameterCount () const
	Return the total number of generic accessible parameters this saturator filter has. More...
virtual Bool	getParameterInfo (Index parameterIndex, FilterParameterInfo &info) const
	Get information about the saturator filter 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...
virtual Bool	allowsInPlaceProcessing () const
	Return whether or not this sound filter can process audio data in-place. More...

Static Public Attributes
static const UTF8String	NAME
	A string indicating the human-readable name of this saturator filter. More...
static const UTF8String	MANUFACTURER
	A string indicating the manufacturer name of this saturator filter. More...
static const FilterVersion	VERSION
	An object indicating the version of this saturator 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 provides a way to saturate audio in a frequency-dependent manner.

A Saturator consists of a 2-way crossover which splits the input audio into low and high-frequency bands. Each band can then be saturated using a soft-clipping function independently before being added back together to produce the output.

This effect can be used to fatten up and even out low frequencies with extra harmonics without adding nasty distortion. It emulates tape saturation on each frequency band independently, giving the user more control over the final sound.

The saturator uses an all-pass Linwitz-Riley crossover to split the audio into frequency bands. The saturator allows the low-frequency band to also be low-pass filtered using half of the crossover filter, producing cleaner low-frequency output. Since 2N-order Linkwitz-Riley crossovers are the same as two N-order Butterworth filters in series, the crossover uses the first low pass filter to fliter out the high frequencies, then uses the second one after saturation to filter out unwanted harmonics added by the saturation, producing a (mostly) all-pass result.

Constructor & Destructor Documentation

om::sound::filters::Saturator::Saturator

(

)

Create a new saturator filter with the default input and output gains of 1.

om::sound::filters::Saturator::Saturator

(

const Saturator &

other

)

Create an exact copy of another saturator.

om::sound::filters::Saturator::~Saturator

(

)

Destroy this saturator, releasing all associated resources.

Member Function Documentation

Saturator& om::sound::filters::Saturator::operator=

(

const Saturator &

other

)

Assign the state of another saturator to this one.

Gain om::sound::filters::Saturator::getInputGain ( ) const

inline

Return the current linear input gain factor of this saturator filter.

This is the gain applied to the input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

Gain om::sound::filters::Saturator::getInputGainDB ( ) const

inline

Return the current input gain factor in decibels of this saturator filter.

This is the gain applied to the input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

void om::sound::filters::Saturator::setInputGain ( Gain  newInputGain )

inline

Set the target linear input gain for this saturator filter.

This is the gain applied to the input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

void om::sound::filters::Saturator::setInputGainDB ( Gain  newDBInputGain )

inline

Set the target input gain in decibels for this saturator filter.

This is the gain applied to the input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

Gain om::sound::filters::Saturator::getOutputGain ( ) const

inline

Return the current linear output gain factor of this saturator filter.

This is the gain applied to the signal after being sent to the clipping function. This value is used to modify the final level of the clipped signal.

Gain om::sound::filters::Saturator::getOutputGainDB ( ) const

inline

Return the current output gain factor in decibels of this saturator filter.

This is the gain applied to the signal after being sent to the clipping function. This value is used to modify the final level of the clipped signal.

void om::sound::filters::Saturator::setOutputGain ( Gain  newOutputGain )

inline

Set the target linear output gain for this saturator filter.

This is the gain applied to the signal after being sent to the clipping function. This value is used to modify the final level of the clipped signal.

void om::sound::filters::Saturator::setOutputGainDB ( Gain  newDBOutputGain )

inline

Set the target output gain in decibels for this saturator filter.

This is the gain applied to the signal after being sent to the clipping function. This value is used to modify the final level of the clipped signal.

Bool om::sound::filters::Saturator::getCrossoverIsEnabled ( ) const

inline

Return whether or not this saturator filter's crossover filter is enabled.

void om::sound::filters::Saturator::setCrossoverIsEnabled ( Bool  newCrossoverIsEnabled )

inline

Set whether or not this saturator filter's crossover is enabled.

Float om::sound::filters::Saturator::getCrossoverFrequency ( ) const

inline

Return the low pass filter frequency of this saturator filter.

void om::sound::filters::Saturator::setCrossoverFrequency ( Float  newCrossoverFrequency )

inline

Set the crossover frequency of this saturator filter.

The default crossover frequency is 1000 Hz.

The new crossover frequency is clamped to the range [0,infinity].

Size om::sound::filters::Saturator::getCrossoverOrder ( ) const

inline

Return the filter order of this saturator filter's crossover.

This value determines the slope of the crossover transition, with 6 dB/octave for each successive filter order. The default crossover order is 4.

void om::sound::filters::Saturator::setCrossoverOrder ( Size  newCrossoverOrder )

inline

Set the crossover filter order of this saturator filter.

This value determines the slope of the crossover transition, with 6 dB/octave for each successive filter order. The default crossover order is 4.

Valid values are the even numbers 2, 4, 6, and 8. Other values are clamped to the range [2,8] and rounded up to the next highest even number.

Bool om::sound::filters::Saturator::getLowEffectIsEnabled ( ) const

inline

Return whether or not the low frequency saturation effect is enabled.

If not enabled, the saturator just pass-throughs the low frequency audio.

void om::sound::filters::Saturator::setLowEffectIsEnabled ( Bool  newLowEffectEnabled )

inline

Set whether or not the low frequency saturation effect is enabled.

If not enabled, the saturator just pass-throughs the low frequency audio.

Bool om::sound::filters::Saturator::getLowFilterIsEnabled ( ) const

inline

Return whether or not the low frequency saturation effect is enabled.

void om::sound::filters::Saturator::setLowFilterIsEnabled ( Bool  newLowFilterEnabled )

inline

Set whether or not the low frequency low pass filter is enabled.

Gain om::sound::filters::Saturator::getLowDrive ( ) const

inline

Return the current linear input gain factor for the low frequencies of the saturator.

This is the gain applied to the low-frequency input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

Gain om::sound::filters::Saturator::getLowDriveDB ( ) const

inline

Return the current input gain in decibels for the low frequencies of the saturator.

This is the gain applied to the low-frequency input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

void om::sound::filters::Saturator::setLowDrive ( Gain  newLowDrive )

inline

Set the current linear input gain factor for the low frequencies of the saturator.

This is the gain applied to the low-frequency input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

void om::sound::filters::Saturator::setLowDriveDB ( Gain  newDBLowDrive )

inline

Set the current input gain in decibels for the low frequencies of the saturator.

This is the gain applied to the low-frequency input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

Gain om::sound::filters::Saturator::getLowGain ( ) const

inline

Return the current linear output gain factor for the low frequencies of the saturator.

This is the gain applied to the low-frequency signal after being sent to the clipping function.

Gain om::sound::filters::Saturator::getLowGainDB ( ) const

inline

Return the current output gain in decibels for the low frequencies of the saturator.

This is the gain applied to the low-frequency signal after being sent to the clipping function.

void om::sound::filters::Saturator::setLowGain ( Gain  newLowGain )

inline

Set the current linear output gain factor for the low frequencies of the saturator.

This is the gain applied to the low-frequency signal after being sent to the clipping function.

void om::sound::filters::Saturator::setLowGainDB ( Gain  newDBLowGain )

inline

Set the current output gain in decibels for the low frequencies of the saturator.

This is the gain applied to the low-frequency signal after being sent to the clipping function.

Bool om::sound::filters::Saturator::getHighEffectIsEnabled ( ) const

inline

Return whether or not the high frequency saturation effect is enabled.

If not enabled, the saturator just pass-throughs the high frequency audio.

void om::sound::filters::Saturator::setHighEffectIsEnabled ( Bool  newHighEffectEnabled )

inline

Set whether or not the high frequency saturation effect is enabled.

If not enabled, the saturator just pass-throughs the high frequency audio.

Gain om::sound::filters::Saturator::getHighDrive ( ) const

inline

Return the current linear input gain factor for the high frequencies of the saturator.

This is the gain applied to the high-frequency input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

Gain om::sound::filters::Saturator::getHighDriveDB ( ) const

inline

Return the current input gain in decibels for the high frequencies of the saturator.

This is the gain applied to the high-frequency input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

void om::sound::filters::Saturator::setHighDrive ( Gain  newLowDrive )

inline

Set the current linear input gain factor for the high frequencies of the saturator.

This is the gain applied to the high-frequency input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

void om::sound::filters::Saturator::setHighDriveDB ( Gain  newDBHighDrive )

inline

Set the current input gain in decibels for the high frequencies of the saturator.

This is the gain applied to the high-frequency input signal before being sent to the clipping function. A higher value will result in more noticeable clipping.

Gain om::sound::filters::Saturator::getHighGain ( ) const

inline

Return the current linear output gain factor for the high frequencies of the saturator.

This is the gain applied to the high-frequency signal after being sent to the clipping function.

Gain om::sound::filters::Saturator::getHighGainDB ( ) const

inline

Return the current output gain in decibels for the high frequencies of the saturator.

This is the gain applied to the high-frequency signal after being sent to the clipping function.

void om::sound::filters::Saturator::setHighGain ( Gain  newHighGain )

inline

Set the current linear output gain factor for the high frequencies of the saturator.

This is the gain applied to the high-frequency signal after being sent to the clipping function.

void om::sound::filters::Saturator::setHighGainDB ( Gain  newDBHighGain )

inline

Set the current output gain in decibels for the high frequencies of the saturator.

This is the gain applied to the high-frequency signal after being sent to the clipping function.

Bool om::sound::filters::Saturator::getLowPassIsEnabled ( ) const

inline

Return whether or not this saturation filter's low pass filter is enabled.

void om::sound::filters::Saturator::setLowPassIsEnabled ( Bool  newLowPassIsEnabled )

inline

Set whether or not this saturation filter's low pass filter is enabled.

Float om::sound::filters::Saturator::getLowPassFrequency ( ) const

inline

Return the low pass filter frequency of this saturation filter.

void om::sound::filters::Saturator::setLowPassFrequency ( Float  newLowPassFrequency )

inline

Set the low pass filter frequency of this saturation filter.

The new low pass frequency is clamped to the range [0,infinity].

Size om::sound::filters::Saturator::getLowPassOrder ( ) const

inline

Return the low pass filter order of this saturation filter.

void om::sound::filters::Saturator::setLowPassOrder ( Size  newLowPassOrder )

inline

Set the low pass filter order of this saturation filter.

The new low pass order is clamped to the range [1,100].

Bool om::sound::filters::Saturator::getLowsAreSoloed ( ) const

inline

Return whether or not the low frequency band is currently being soloed.

void om::sound::filters::Saturator::setLowsAreSoloed ( Bool  newLowsSoloed )

inline

Return whether or not the low frequency band is currently being soloed.

Bool om::sound::filters::Saturator::getHighsAreSoloed ( ) const

inline

Return whether or not the high frequency band is currently being soloed.

void om::sound::filters::Saturator::setHighsAreSoloed ( Bool  newHighsSoloed )

inline

Return whether or not the high frequency band is currently being soloed.

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

virtual

Return a human-readable name for this saturator filter.

The method returns the string "Saturator".

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

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

virtual

Return the manufacturer name of this saturator filter.

The method returns the string "Om Sound".

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

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

virtual

Return an object representing the version of this saturator filter.

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

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

virtual

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

This method returns the value FilterCategory::DISTORTION.

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

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

virtual

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

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

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

virtual

Get information about the saturator filter parameter at the specified index.

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

Member Data Documentation

const UTF8String om::sound::filters::Saturator::NAME

static

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

const UTF8String om::sound::filters::Saturator::MANUFACTURER

static

A string indicating the manufacturer name of this saturator filter.

const FilterVersion om::sound::filters::Saturator::VERSION

static

An object indicating the version of this saturator filter.

---

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

• omSoundSaturator.h