Om
1.0.0
A universal framework for multimedia simulation
|
A class that maps a high-dynamic-range input audio source to a low-dynamic-range output. More...
#include <omSoundHDRFilter.h>
Public Member Functions | |
HDRFilter () | |
Create a new HDR filter with the default parameters. More... | |
Gain | getInputGain () const |
Return the current linear input gain factor of this HDR filter. More... | |
Gain | getInputGainDB () const |
Return the current input gain factor in decibels of this HDR filter. More... | |
void | setInputGain (Gain newInputGain) |
Set the target linear input gain for HDR filter. More... | |
void | setInputGainDB (Gain newDBInputGain) |
Set the target input gain in decibels for this HDR filter. More... | |
Gain | getOutputGain () const |
Return the current linear output gain factor of this HDR filter. More... | |
Gain | getOutputGainDB () const |
Return the current output gain factor in decibels of this HDR filter. More... | |
void | setOutputGain (Gain newOutputGain) |
Set the target linear output gain for this HDR filter. More... | |
void | setOutputGainDB (Gain newDBOutputGain) |
Set the target output gain in decibels for this HDR filter. More... | |
virtual UTF8String | getName () const |
Return a human-readable name for this HDR filter. More... | |
virtual UTF8String | getManufacturer () const |
Return the manufacturer name of this HDR filter. More... | |
virtual FilterVersion | getVersion () const |
Return an object representing the version of this HDR 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 HDR 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 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 ¶meterName, Index ¶meterIndex) 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 HDR filter. More... | |
static const UTF8String | MANUFACTURER |
A string indicating the manufacturer name of this HDR filter. More... | |
static const FilterVersion | VERSION |
An object indicating the version of this HDR 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... | |
virtual void | resetStream () |
A method that is called whenever the filter's stream of audio is being reset. 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... | |
A class that maps a high-dynamic-range input audio source to a low-dynamic-range output.
This class applies specially-tuned compression and limiting to reduce the dynamic range of sound that is over the 0dBFS (clipping) threshold in a way that approximates how human hearing adjusts to dynamic changes in sound level.
om::sound::filters::HDRFilter::HDRFilter | ( | ) |
Create a new HDR filter with the default parameters.
|
inline |
Return the current linear input gain factor of this HDR filter.
This is the gain applied to the input signal before being sent to the HDR filter. This allows the user to scale the input to match the HDR filter without having to change the HDR filter threshold.
|
inline |
Return the current input gain factor in decibels of this HDR filter.
This is the gain applied to the input signal before being sent to the HDR filter. This allows the user to scale the input to match the HDR filter without having to change the HDR filter threshold.
|
inline |
Set the target linear input gain for HDR filter.
This is the gain applied to the input signal before being sent to the HDR filter. This allows the user to scale the input to match the HDR filter without having to change the HDR filter threshold.
|
inline |
Set the target input gain in decibels for this HDR filter.
This is the gain applied to the input signal before being sent to the HDR filter. This allows the user to scale the input to match the HDR filter without having to change the HDR filter threshold.
|
inline |
Return the current linear output gain factor of this HDR filter.
This is the gain applied to the signal after being sent to the HDR filter. This value is used to apply make-up gain to the signal after is has been compressed.
|
inline |
Return the current output gain factor in decibels of this HDR filter.
This is the gain applied to the signal after being sent to the HDR filter. This value is used to apply make-up gain to the signal after is has been compressed.
|
inline |
Set the target linear output gain for this HDR filter.
This is the gain applied to the signal after being sent to the HDR filter. This value is used to apply make-up gain to the signal after is has been compressed.
|
inline |
Set the target output gain in decibels for this HDR filter.
This is the gain applied to the signal after being sent to the HDR filter. This value is used to apply make-up gain to the signal after is has been compressed.
|
virtual |
Return a human-readable name for this HDR filter.
The method returns the string "HDR Filter".
Reimplemented from om::sound::filters::SoundFilter.
|
virtual |
Return the manufacturer name of this HDR filter.
The method returns the string "Om Sound".
Reimplemented from om::sound::filters::SoundFilter.
|
virtual |
Return an object representing the version of this HDR filter.
Reimplemented from om::sound::filters::SoundFilter.
|
virtual |
Return an object that describes the category of effect that this filter implements.
This method returns the value FilterCategory::DYNAMICS.
Reimplemented from om::sound::filters::SoundFilter.
|
virtual |
Return whether or not this HDR filter can process audio data in-place.
This method always returns TRUE, HDR filters can process audio data in-place.
Reimplemented from om::sound::filters::SoundFilter.
|
virtual |
Return the total number of generic accessible parameters this filter has.
Reimplemented from om::sound::filters::SoundFilter.
|
virtual |
Get information about the filter parameter at the specified index.
Reimplemented from om::sound::filters::SoundFilter.
|
static |
A string indicating the human-readable name of this HDR filter.
|
static |
A string indicating the manufacturer name of this HDR filter.
|
static |
An object indicating the version of this HDR filter.