BitCrusher Class Reference

The BitCrusher object implements a quantizing bitcrusher algorithm. More...

#include <fxobjects.h>

Inheritance diagram for BitCrusher:

Public Member Functions
virtual bool	reset (double _sampleRate)
BitCrusherParameters	getParameters ()
void	setParameters (const BitCrusherParameters &params)
virtual bool	canProcessAudioFrame ()
virtual double	processAudioSample (double xn)
Public Member Functions inherited from IAudioSignalProcessor
virtual bool	reset (double _sampleRate)=0
virtual double	processAudioSample (double xn)=0
virtual bool	canProcessAudioFrame ()=0
virtual void	setSampleRate (double _sampleRate)
virtual void	enableAuxInput (bool enableAuxInput)
virtual double	processAuxInputAudioSample (double xn)
virtual bool	processAudioFrame (const float *inputFrame, float *outputFrame, uint32_t inputChannels, uint32_t outputChannels)

Protected Attributes
BitCrusherParameters	parameters
	object parameters
double	QL = 1.0
	the quantization level

Detailed Description

The BitCrusher object implements a quantizing bitcrusher algorithm.

Audio I/O:

• Processes mono input to mono output.

Control I/F:

• Use BitCrusherParameters structure to get/set object params.

Author

Will Pirkle http://www.willpirkle.com

Remarks

This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle

Version

Revision : 1.0

Date

Date : 2018 / 09 / 7

Member Function Documentation

canProcessAudioFrame()

virtual bool BitCrusher::canProcessAudioFrame ( )

inlinevirtual

return false: this object only processes samples

Implements IAudioSignalProcessor.

getParameters()

BitCrusherParameters BitCrusher::getParameters ( )

inline

get parameters: note use of custom structure for passing param data

Returns

BitCrusherParameters custom data structure

processAudioSample()

virtual double BitCrusher::processAudioSample ( double  xn )

inlinevirtual

perform the bitcrushing operation (see FX book for back story and details)

Parameters

xn

input

Returns

the processed sample

Implements IAudioSignalProcessor.

reset()

virtual bool BitCrusher::reset ( double  _sampleRate )

inlinevirtual

reset members to initialized state

Implements IAudioSignalProcessor.

setParameters()

void BitCrusher::setParameters ( const BitCrusherParameters &  params )

inline

set parameters: note use of custom structure for passing param data

Parameters

BitCrusherParameters

custom data structure

---

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

• C:/RackAFX_v7/ASPIK_Doxygen/PluginObjects/fxobjects.h