JackTrip
Public Member Functions | List of all members
Compressor Class Reference

Applies compressor_mono from the faustlibraries distribution, compressors.lib. More...

#include <Compressor.h>

Inheritance diagram for Compressor:
Inheritance graph
[legend]
Collaboration diagram for Compressor:
Collaboration graph
[legend]

Public Member Functions

 Compressor (int numchans, bool verboseIn=false, float ratioIn=2.0f, float thresholdDBIn=-24.0f, float attackMSIn=15.0f, float releaseMSIn=40.0f, float makeUpGainDBIn=2.0f)
 The class constructor sets the number of audio channels and default parameters. More...
 
 Compressor (int numchans, bool verboseIn=false, CompressorPreset preset=CompressorPresets::voice)
 
virtual ~Compressor ()
 The class destructor. More...
 
void setParamAllChannels (const char pName[], float p)
 
void init (int samplingRate) override
 Do proper Initialization of members and class instances. By default this initializes the Sampling Frequency. If a class instance depends on the sampling frequency, it should be initialize here. More...
 
int getNumInputs () override
 Return Number of Input Channels. More...
 
int getNumOutputs () override
 Return Number of Output Channels. More...
 
void compute (int nframes, float **inputs, float **outputs) override
 Compute process. More...
 
- Public Member Functions inherited from ProcessPlugin
 ProcessPlugin ()
 The Class Constructor. More...
 
virtual ~ProcessPlugin ()
 The Class Destructor. More...
 
virtual char * getName ()
 
virtual bool getInited ()
 
virtual void setVerbose (bool v)
 

Additional Inherited Members

- Protected Attributes inherited from ProcessPlugin
int fSamplingFreq
 Faust Data member, Sampling Rate. More...
 
bool inited = false
 
bool verbose = false
 

Detailed Description

Applies compressor_mono from the faustlibraries distribution, compressors.lib.

A Compressor reduces the output dynamic range when the signal level exceeds the threshold.

Constructor & Destructor Documentation

◆ Compressor() [1/2]

Compressor::Compressor ( int  numchans,
bool  verboseIn = false,
float  ratioIn = 2.0f,
float  thresholdDBIn = -24.0f,
float  attackMSIn = 15.0f,
float  releaseMSIn = 40.0f,
float  makeUpGainDBIn = 2.0f 
)
inline

The class constructor sets the number of audio channels and default parameters.

◆ Compressor() [2/2]

Compressor::Compressor ( int  numchans,
bool  verboseIn = false,
CompressorPreset  preset = CompressorPresets::voice 
)
inline

◆ ~Compressor()

virtual Compressor::~Compressor ( )
inlinevirtual

The class destructor.

Member Function Documentation

◆ compute()

void Compressor::compute ( int  nframes,
float **  inputs,
float **  outputs 
)
overridevirtual

Compute process.

Implements ProcessPlugin.

◆ getNumInputs()

int Compressor::getNumInputs ( )
inlineoverridevirtual

Return Number of Input Channels.

Implements ProcessPlugin.

◆ getNumOutputs()

int Compressor::getNumOutputs ( )
inlineoverridevirtual

Return Number of Output Channels.

Implements ProcessPlugin.

◆ init()

void Compressor::init ( int  samplingRate)
inlineoverridevirtual

Do proper Initialization of members and class instances. By default this initializes the Sampling Frequency. If a class instance depends on the sampling frequency, it should be initialize here.

Reimplemented from ProcessPlugin.

◆ setParamAllChannels()

void Compressor::setParamAllChannels ( const char  pName[],
float  p 
)
inline

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