om::sound::filters::Distortion Class Reference

A class that provides different kinds of audio distortion using wave-shaping. More...

#include <omSoundDistortion.h>

Inheritance diagram for om::sound::filters::Distortion:

Public Types
enum	Type { SOFT = 0, HARD = 1, BREAKUP_1 = 2, BREAKUP_2 = 3 }
	Define the different kinds of distortion effects that this filter can produce. More...

Public Member Functions
	Distortion ()
	Create a new distortion filter with the default input and output gains of 1 and hardness of 0. More...
	Distortion (Type newType)
	Create a new distortion filter with the default input and output gains of 1 and hardness of 0. More...
	Distortion (const Distortion &other)
	Create an exact copy of another distortion filter. More...
	~Distortion ()
	Destroy this distortion filter and clean up any resources. More...
Distortion &	operator= (const Distortion &other)
	Assign the state of another distortion filter to this one. More...
Type	getType () const
	Return the type of distortion that this distortion filter is using. More...
void	setType (Type newType)
	Return the type of distortion that this distortion filter is using. More...
Gain	getInputGain () const
	Return the current linear input gain factor of this distortion filter. More...
Gain	getInputGainDB () const
	Return the current input gain factor in decibels of this distortion filter. More...
void	setInputGain (Gain newInputGain)
	Set the target linear input gain for this distortion filter. More...
void	setInputGainDB (Gain newDBInputGain)
	Set the target input gain in decibels for this distortion filter. More...
Gain	getOutputGain () const
	Return the current linear output gain factor of this distortion filter. More...
Gain	getOutputGainDB () const
	Return the current output gain factor in decibels of this distortion filter. More...
void	setOutputGain (Gain newOutputGain)
	Set the target linear output gain for this distortion filter. More...
void	setOutputGainDB (Gain newDBOutputGain)
	Set the target output gain in decibels for this distortion filter. More...
Gain	getMix () const
	Return the ratio of input signal to distorted signal sent to the output of the distortion effect. More...
void	setMix (Gain newMix)
	Set the ratio of input signal to distorted signal sent to the output of the distortion effect. More...
Gain	getThreshold () const
	Return the linear full-scale value that indicates the maximum distorted output signal level. More...
Gain	getThresholdDB () const
	Return the logarithmic full-scale value that indicates the maximum distorted output signal level. More...
void	setThreshold (Gain newThreshold)
	Set the linear full-scale value that indicates the maximum distorted output signal level. More...
void	setThresholdDB (Gain newThresholdDB)
	Set the logarithmic full-scale value that indicates the maximum distorted output signal level. More...
Float	getHardness () const
	Return the current hardness of this distortion filter's clipping function. More...
void	setHardness (Float newThreshold)
	Set the hardness of this distortion filter's clipping function. More...
Bool	getLowPassIsEnabled () const
	Return whether or not this distortion filter's low pass filter is enabled. More...
void	setLowPassIsEnabled (Bool newLowPassIsEnabled)
	Set whether or not this distortion filter's low pass filter is enabled. More...
Float	getLowPassFrequency () const
	Return the low pass filter frequency of this distortion filter. More...
void	setLowPassFrequency (Float newLowPassFrequency)
	Set the low pass filter frequency of this distortion filter. More...
Size	getLowPassOrder () const
	Return the low pass filter order of this distortion filter. More...
void	setLowPassOrder (Size newLowPassOrder)
	Set the low pass filter order of this distortion filter. More...
virtual UTF8String	getName () const
	Return a human-readable name for this distortion filter. More...
virtual UTF8String	getManufacturer () const
	Return the manufacturer name of this distortion filter. More...
virtual FilterVersion	getVersion () const
	Return an object representing the version of this distortion 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 distortion filter has. More...
virtual Bool	getParameterInfo (Index parameterIndex, FilterParameterInfo &info) const
	Get information about the distortion filter parameter at the specified index. 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...
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...
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 distortion filter. More...
static const UTF8String	MANUFACTURER
	A string indicating the manufacturer name of this distortion filter. More...
static const FilterVersion	VERSION
	An object indicating the version of this distortion 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 different kinds of audio distortion using wave-shaping.

The class uses a series of special non-linear functions to produce variable-hardness distortion. The distortion produced can range from a basic soft clipping to very non-linear hard clipping.

Member Enumeration Documentation

enum om::sound::filters::Distortion::Type

Define the different kinds of distortion effects that this filter can produce.

Enumerator
SOFT	A kind of distortion where a smooth soft-clipping function is used.
HARD	A kind of distortion where soft clipping is performed to the negative waveform and hard on the positive.
BREAKUP_1	A kind of distortion which uses a soft-clipping function that is non-linear in the low amplitudes. This causes a constant distortion, even at low input levels.
BREAKUP_2	A kind of distortion which uses a non-linear function that shorts out the signal after a certain input level. This causes a distortion where after the clipping threshold is reached, the output level begins to decrease, causing unusual distortion.

Constructor & Destructor Documentation

om::sound::filters::Distortion::Distortion

(

)

Create a new distortion filter with the default input and output gains of 1 and hardness of 0.

om::sound::filters::Distortion::Distortion

(

Type

newType

)

Create a new distortion filter with the default input and output gains of 1 and hardness of 0.

om::sound::filters::Distortion::Distortion

(

const Distortion &

other

)

Create an exact copy of another distortion filter.

om::sound::filters::Distortion::~Distortion

(

)

Destroy this distortion filter and clean up any resources.

Member Function Documentation

Distortion& om::sound::filters::Distortion::operator=

(

const Distortion &

other

)

Assign the state of another distortion filter to this one.

Type om::sound::filters::Distortion::getType ( ) const

inline

Return the type of distortion that this distortion filter is using.

void om::sound::filters::Distortion::setType ( Type  newType )

inline

Return the type of distortion that this distortion filter is using.

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

inline

Return the current linear input gain factor of this distortion 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::Distortion::getInputGainDB ( ) const

inline

Return the current input gain factor in decibels of this distortion 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::Distortion::setInputGain ( Gain  newInputGain )

inline

Set the target linear input gain for this distortion 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::Distortion::setInputGainDB ( Gain  newDBInputGain )

inline

Set the target input gain in decibels for this distortion 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::Distortion::getOutputGain ( ) const

inline

Return the current linear output gain factor of this distortion 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::Distortion::getOutputGainDB ( ) const

inline

Return the current output gain factor in decibels of this distortion 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::Distortion::setOutputGain ( Gain  newOutputGain )

inline

Set the target linear output gain for this distortion 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::Distortion::setOutputGainDB ( Gain  newDBOutputGain )

inline

Set the target output gain in decibels for this distortion 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::Distortion::getMix ( ) const

inline

Return the ratio of input signal to distorted signal sent to the output of the distortion effect.

Valid mix values are in the range [0,1]. A mix value of 1 indicates that only the output of the distortion should be heard at the output, while a value of 0 indicates that only the input of the distortion should be heard at the output. A value of 0.5 indicates that both should be mixed together equally at -6dB.

void om::sound::filters::Distortion::setMix ( Gain  newMix )

inline

Set the ratio of input signal to distorted signal sent to the output of the distortion effect.

Valid mix values are in the range [0,1]. A mix value of 1 indicates that only the output of the distortion should be heard at the output, while a value of 0 indicates that only the input of the distortion should be heard at the output. A value of 0.5 indicates that both should be mixed together equally at -6dB.

The new mix value is clamped to the valid range of [0,1].

Gain om::sound::filters::Distortion::getThreshold ( ) const

inline

Return the linear full-scale value that indicates the maximum distorted output signal level.

Gain om::sound::filters::Distortion::getThresholdDB ( ) const

inline

Return the logarithmic full-scale value that indicates the maximum distorted output signal level.

void om::sound::filters::Distortion::setThreshold ( Gain  newThreshold )

inline

Set the linear full-scale value that indicates the maximum distorted output signal level.

The value is clamped to the valid range of [0,infinity] before being stored.

void om::sound::filters::Distortion::setThresholdDB ( Gain  newThresholdDB )

inline

Set the logarithmic full-scale value that indicates the maximum distorted output signal level.

Float om::sound::filters::Distortion::getHardness ( ) const

inline

Return the current hardness of this distortion filter's clipping function.

The hardness of a distortion filter is a value between 0 and 1 indicating the linear full-scale threshold at which the saturation rolloff begins. Thus, a hardness of 0 will produce the smoothest transfer curve, while a hardness of 1 will approximate hard clipping.

void om::sound::filters::Distortion::setHardness ( Float  newThreshold )

inline

Set the hardness of this distortion filter's clipping function.

The hardness of a distortion filter is a value between 0 and 1 indicating the linear full-scale threshold at which the saturation rolloff begins. Thus, a hardness of 0 will produce the smoothest transfer curve, while a hardness of 1 will approximate hard clipping.

The input hardness value is clamped between 0 and 1.

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

inline

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

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

inline

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

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

inline

Return the low pass filter frequency of this distortion filter.

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

inline

Set the low pass filter frequency of this distortion filter.

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

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

inline

Return the low pass filter order of this distortion filter.

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

inline

Set the low pass filter order of this distortion filter.

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

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

virtual

Return a human-readable name for this distortion filter.

The method returns the string "Distortion".

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

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

virtual

Return the manufacturer name of this distortion filter.

The method returns the string "Om Sound".

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

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

virtual

Return an object representing the version of this distortion filter.

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

virtual FilterCategory om::sound::filters::Distortion::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::Distortion::getParameterCount ( ) const

virtual

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

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

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

virtual

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

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

virtual Bool om::sound::filters::Distortion::getParameterValueName ( Index  parameterIndex, const FilterParameter &  value, UTF8String &  name  ) const

virtual

Get any special name associated with the specified value of an indexed parameter.

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

Member Data Documentation

const UTF8String om::sound::filters::Distortion::NAME

static

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

const UTF8String om::sound::filters::Distortion::MANUFACTURER

static

A string indicating the manufacturer name of this distortion filter.

const FilterVersion om::sound::filters::Distortion::VERSION

static

An object indicating the version of this distortion filter.

---

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

• omSoundDistortion.h