Aviate::Compressor Class Reference

Simple Compressor. More...

#include <LibBasicFunctions.h>

Public Member Functions
	Compressor ()
	constructor
virtual	~Compressor ()
	destructor
bool	processFloat (float *output, float *input, size_t numSamples)
	process an array of floating point samples More...
void	setInputGain (float gain)
	set the compressors input gain More...
void	setThresholdDb (float thresholdDb)
	set the compressors threshold in dB More...
void	setRatio (float ratio)
	set the compressor ratio More...
void	setAttackMs (unsigned attackMs)
	set the comrpessor attack in milliseconds More...
void	setReleaseMs (unsigned releaseMs)
	set the compressor release in milliseconds More...

Detailed Description

Simple Compressor.

The compressor uses the following parameters:

• input gain: this is the gain applied directly to the inputs audio
• threshold Db: this is the threshold at which compression begins
• ratio: this is the compression ratio applied
• attack Ms: this is the compressor attack times in milliseconds
• release Ms: this s the compressor release time in milliseconds

Member Function Documentation

processFloat()

bool Aviate::Compressor::processFloat	(	float *	output,
		float *	input,
		size_t	numSamples
	)

process an array of floating point samples

Parameters

output	pointer to output array. Must be at least numSamples.
input	pointer to input array. Must be at least numSamples.
numSamples	number of samples in input/output array

Returns

true if success, false otherwise

setAttackMs()

void Aviate::Compressor::setAttackMs

(

unsigned

attackMs

)

set the comrpessor attack in milliseconds

Parameters

attackMs

attack in milliseconds as a float

setInputGain()

void Aviate::Compressor::setInputGain

(

float

gain

)

set the compressors input gain

Parameters

gain	sets the compression gain in absolulte value

setRatio()

void Aviate::Compressor::setRatio

(

float

ratio

)

set the compressor ratio

Parameters

ratio

ratio as a float

setReleaseMs()

void Aviate::Compressor::setReleaseMs

(

unsigned

releaseMs

)

set the compressor release in milliseconds

Parameters

releaseMs

release time in milliseconds as a float

setThresholdDb()

void Aviate::Compressor::setThresholdDb

(

float

thresholdDb

)

set the compressors threshold in dB

Parameters

thresholdDb

compression threshold in dB

---

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

• inc/LibBasicFunctions.h