Superpowered::Clipper Class Reference

Hard knee clipping with 0 latency. More...

#include "SuperpoweredClipper.h"

Public Member Functions
	Clipper ()
	Constructor;. More...
	~Clipper ()
void	process (float *input, float *output, unsigned int numberOfFrames)
	Processes the audio. More...

Public Attributes
float	maximumDb
	Audio will reach 1.0f at this point. Limited between -48 and 48. More...
float	thresholdDb
	Audio below this will be unchanged, above this will be attenuated. Limited between -100 and 0. More...

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

Private Attributes
clipperInternals *	internals

Detailed Description

Hard knee clipping with 0 latency.

It doesn't allocate any internal buffers and needs just a few bytes of memory.

Constructor & Destructor Documentation

Clipper() [1/2]

Superpowered::Clipper::Clipper

(

)

Constructor;.

~Clipper()

Superpowered::Clipper::~Clipper

(

)

Clipper() [2/2]

Superpowered::Clipper::Clipper ( const Clipper &  )

private

Member Function Documentation

operator=()

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

private

process()

void Superpowered::Clipper::process	(	float *	input,
		float *	output,
		unsigned int	numberOfFrames
	)

Processes the audio.

It's never blocking for real-time usage. You can change all properties on any thread, concurrently with process().

Parameters

input	Pointer to floating point numbers. 32-bit interleaved stereo input.
output	Pointer to floating point numbers. 32-bit interleaved stereo output. Can point to the same location with input (in-place processing).
numberOfFrames	Should be 4 minimum and exactly divisible with 4.

Member Data Documentation

internals

clipperInternals* Superpowered::Clipper::internals

private

maximumDb

float Superpowered::Clipper::maximumDb

Audio will reach 1.0f at this point. Limited between -48 and 48.

thresholdDb

float Superpowered::Clipper::thresholdDb

Audio below this will be unchanged, above this will be attenuated. Limited between -100 and 0.

---

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

• latest/Superpowered/SuperpoweredClipper.h