OpenShot Library | OpenShotAudio  0.2.2
juce::Reverb Class Reference

Performs a simple reverb effect on a stream of audio data. More...

#include <juce_Reverb.h>

Classes

struct  Parameters
 Holds the parameters being used by a Reverb object. More...
 

Public Member Functions

const ParametersgetParameters () const noexcept
 Returns the reverb's current parameters.
 
void setParameters (const Parameters &newParams)
 Applies a new set of parameters to the reverb. More...
 
void setSampleRate (const double sampleRate)
 Sets the sample rate that will be used for the reverb. More...
 
void reset ()
 Clears the reverb's buffers.
 
void processStereo (float *const left, float *const right, const int numSamples) noexcept
 Applies the reverb to two stereo channels of audio data.
 
void processMono (float *const samples, const int numSamples) noexcept
 Applies the reverb to a single mono channel of audio data.
 

Detailed Description

Performs a simple reverb effect on a stream of audio data.

This is a simple stereo reverb, based on the technique and tunings used in FreeVerb. Use setSampleRate() to prepare it, and then call processStereo() or processMono() to apply the reverb to your audio data.

See also
ReverbAudioSource

Definition at line 42 of file juce_audio_basics/utilities/juce_Reverb.h.


Class Documentation

◆ juce::Reverb::Parameters

struct juce::Reverb::Parameters

Holds the parameters being used by a Reverb object.

Definition at line 54 of file juce_audio_basics/utilities/juce_Reverb.h.

Class Members
float roomSize Room size, 0 to 1.0, where 1.0 is big, 0 is small.
float damping Damping, 0 to 1.0, where 0 is not damped, 1.0 is fully damped.
float wetLevel Wet level, 0 to 1.0.
float dryLevel Dry level, 0 to 1.0.
float width Reverb width, 0 to 1.0, where 1.0 is very wide.
float freezeMode Freeze mode - values < 0.5 are "normal" mode, values > 0.5 put the reverb into a continuous feedback loop.

Member Function Documentation

◆ setParameters()

void juce::Reverb::setParameters ( const Parameters newParams)
inline

Applies a new set of parameters to the reverb.

Note that this doesn't attempt to lock the reverb, so if you call this in parallel with the process method, you may get artifacts.

Definition at line 73 of file juce_audio_basics/utilities/juce_Reverb.h.

References juce::Reverb::Parameters::dryLevel, juce::Reverb::Parameters::freezeMode, juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue(), juce::Reverb::Parameters::wetLevel, and juce::Reverb::Parameters::width.

Referenced by juce::dsp::Reverb::setParameters(), and juce::ReverbAudioSource::setParameters().

◆ setSampleRate()

void juce::Reverb::setSampleRate ( const double  sampleRate)
inline

Sets the sample rate that will be used for the reverb.

You must call this before the process methods, in order to tell it the correct sample rate.

Definition at line 92 of file juce_audio_basics/utilities/juce_Reverb.h.

References juce::SmoothedValue< FloatType, SmoothingType >::reset().

Referenced by juce::dsp::Reverb::prepare(), and juce::ReverbAudioSource::prepareToPlay().


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