Superpowered::CompressorProto Class Reference

The new Superpowered Compressor prototype. It can be used in production, but we're still collecting feedback on its feature set, therefore the documentation is not complete on this one. More...

#include "SuperpoweredCompressor.h"

Inheritance diagram for Superpowered::CompressorProto:

Collaboration diagram for Superpowered::CompressorProto:

Public Member Functions
	CompressorProto (unsigned int samplerate)
	~CompressorProto ()
float	getGainReductionDb ()
bool	process (float *input, float *output, unsigned int numberOfSamples)
	input is the sidechain More...
bool	process (float *input, float *sidechain, float *output, unsigned int numberOfSamples)
	separate sidechain More...

Public Attributes
float	attackSec
	0 to 1 More...
bool	enabled = false
	Turns the effect on/off. The actual switch will happen on the next process() call for smooth, audio-artifact free operation. More...
float	kneeDb
	0 to 100 More...
unsigned char	lookaheadMs
	doesn't work yet More...
float	outputGainDb
	decibels More...
float	ratio
	1 to 1000 More...
float	releaseSec
	0.001 to 4 More...
bool	rms
	false: follow peaks, true: follow RMS More...
unsigned int	samplerate = 0
	Sample rate in Hz. More...
float	thresholdDb
	0 to -100 More...
float	wet
	0 to 1 More...

Private Member Functions
	CompressorProto (const CompressorProto &)
CompressorProto &	operator= (const CompressorProto &)

Private Attributes
compressorProtoInternals *	internals

Detailed Description

The new Superpowered Compressor prototype. It can be used in production, but we're still collecting feedback on its feature set, therefore the documentation is not complete on this one.

Constructor & Destructor Documentation

CompressorProto() [1/2]

Superpowered::CompressorProto::CompressorProto

(

unsigned int

samplerate

)

~CompressorProto()

Superpowered::CompressorProto::~CompressorProto

(

)

CompressorProto() [2/2]

Superpowered::CompressorProto::CompressorProto ( const CompressorProto &  )

private

Member Function Documentation

getGainReductionDb()

float Superpowered::CompressorProto::getGainReductionDb

(

)

operator=()

CompressorProto& Superpowered::CompressorProto::operator= ( const CompressorProto &  )

private

process() [1/2]

bool Superpowered::CompressorProto::process ( float *  input, float *  output, unsigned int  numberOfSamples  )

virtual

input is the sidechain

Implements Superpowered::FX.

process() [2/2]

bool Superpowered::CompressorProto::process	(	float *	input,
		float *	sidechain,
		float *	output,
		unsigned int	numberOfSamples
	)

separate sidechain

Member Data Documentation

attackSec

float Superpowered::CompressorProto::attackSec

0 to 1

enabled

bool Superpowered::FX::enabled = false

inherited

Turns the effect on/off. The actual switch will happen on the next process() call for smooth, audio-artifact free operation.

internals

compressorProtoInternals* Superpowered::CompressorProto::internals

private

kneeDb

float Superpowered::CompressorProto::kneeDb

0 to 100

lookaheadMs

unsigned char Superpowered::CompressorProto::lookaheadMs

doesn't work yet

outputGainDb

float Superpowered::CompressorProto::outputGainDb

decibels

ratio

float Superpowered::CompressorProto::ratio

1 to 1000

releaseSec

float Superpowered::CompressorProto::releaseSec

0.001 to 4

rms

bool Superpowered::CompressorProto::rms

false: follow peaks, true: follow RMS

samplerate

unsigned int Superpowered::FX::samplerate = 0

inherited

Sample rate in Hz.

thresholdDb

float Superpowered::CompressorProto::thresholdDb

0 to -100

wet

float Superpowered::CompressorProto::wet

0 to 1

---

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

• latest/Superpowered/SuperpoweredCompressor.h