OpenShot Library | libopenshot-audio  0.1.9
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. More...
 
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. More...
 
void processStereo (float *const left, float *const right, const int numSamples) noexcept
 Applies the reverb to two stereo channels of audio data. More...
 
void processMono (float *const samples, const int numSamples) noexcept
 Applies the reverb to a single mono channel of audio data. More...
 

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_Reverb.h.

Member Function Documentation

◆ getParameters()

const Parameters& juce::Reverb::getParameters ( ) const
inlinenoexcept

Returns the reverb's current parameters.

Definition at line 67 of file juce_Reverb.h.

◆ 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_Reverb.h.

References juce::Reverb::Parameters::dryLevel, juce::Reverb::Parameters::freezeMode, juce::Reverb::Parameters::wetLevel, and juce::Reverb::Parameters::width.

Referenced by 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_Reverb.h.

References juce::Reverb::Parameters::damping.

Referenced by juce::ReverbAudioSource::prepareToPlay().

◆ reset()

void juce::Reverb::reset ( )
inline

Clears the reverb's buffers.

Definition at line 122 of file juce_Reverb.h.

Referenced by juce::ReverbAudioSource::setParameters().

◆ processStereo()

void juce::Reverb::processStereo ( float *const  left,
float *const  right,
const int  numSamples 
)
inlinenoexcept

Applies the reverb to two stereo channels of audio data.

Definition at line 136 of file juce_Reverb.h.

References juce::Reverb::Parameters::damping.

Referenced by juce::ReverbAudioSource::getNextAudioBlock().

◆ processMono()

void juce::Reverb::processMono ( float *const  samples,
const int  numSamples 
)
inlinenoexcept

Applies the reverb to a single mono channel of audio data.

Definition at line 170 of file juce_Reverb.h.

References juce::Reverb::Parameters::damping, and juce::Reverb::Parameters::freezeMode.

Referenced by juce::ReverbAudioSource::getNextAudioBlock().


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