ddf.minim.ugens

Class BitCrush

java.lang.Object

ddf.minim.UGen

ddf.minim.ugens.BitCrush

public class BitCrush
extends UGen

BitCrush is an effect that reduces the fidelity of the incoming signal. This results in a sound that is "crunchier" sounding, or "distorted".

Audio is represented digitally (ultimately) as an integral value. If you have 16-bit audio, then you can represent a sample value with any number in the range -32,768 to +32,767. If you bit-crush this audio to be 8-bit, then you effectively reduce it representation to -128 to +127, even though you will still represent it with a 16-bit number. This reduction in the fidelity of the representation essentially squares off the waveform, which makes it sound "crunchy". Try bit crushing down to 1-bit and see what you get!

Author:

Anderson Mills

Nested Class Summary

Nested classes/interfaces inherited from class ddf.minim.UGen

UGen.InputType, UGen.UGenInput

Field Summary

Fields

Modifier and Type	Field and Description
UGen.UGenInput	audio The audio input is where audio that gets bit-crushed should be patched.
UGen.UGenInput	bitRate Control the bit rate with another UGen by patching to bitRate.
UGen.UGenInput	bitRes Control the bit resolution with another UGen by patching to bitRes.

Constructor Summary

Constructors

Constructor and Description
BitCrush() Construct a BitCrush with a bit resolution of 1 and a bit rate of 44100.
BitCrush(float localBitRes, float localBitRate) Construct a BitCrush with the specified bit resolution and bit rate.

Method Summary

Modifier and Type	Method and Description
protected void	channelCountChanged() This method is only called when setChannelCount results in the channel count of this UGen actually changing.
void	setBitRes(float localBitRes) Set the bit resolution directly.
protected void	uGenerate(float[] out) Implement this method when you extend UGen.

Methods inherited from class ddf.minim.UGen

addAudio, addControl, addControl, addInput, channelCount, getLastValues, patch, patch, patch, printInputs, removeInput, sampleRate, sampleRateChanged, setChannelCount, setSampleRate, tick, unpatch, unpatch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

audio

public UGen.UGenInput audio

The audio input is where audio that gets bit-crushed should be patched. However, you don't need to patch directly to this input, patching to the UGen itself will accomplish the same thing.

bitRes

public UGen.UGenInput bitRes

Control the bit resolution with another UGen by patching to bitRes. Values that make sense for this start at 1 and go up to whatever the actual resolution of the incoming audio is (typically 16).

bitRate

public UGen.UGenInput bitRate

Control the bit rate with another UGen by patching to bitRate. Values that make sense for this start at 1 and go up to whatever the sample rate of your AudioOutput are (typically 44100)

Constructor Detail

BitCrush

public BitCrush()

Construct a BitCrush with a bit resolution of 1 and a bit rate of 44100.

BitCrush

public BitCrush(float localBitRes,
                float localBitRate)

Construct a BitCrush with the specified bit resolution and bit rate.

Parameters:

localBitRes - float: typically you'll want this in the range [1,16]

localBitRate - float: this must be in the range [1,outputSampleRate]

Method Detail

channelCountChanged

protected void channelCountChanged()

Description copied from class: UGen

This method is only called when setChannelCount results in the channel count of this UGen actually changing. Override this function in sub-classes of UGen if you need to reconfigure things when the channel count changes.

Overrides:

channelCountChanged in class UGen

setBitRes

public void setBitRes(float localBitRes)

Set the bit resolution directly.

Parameters:

localBitRes - float: typically you'll want this in the range [1,16]

uGenerate

protected void uGenerate(float[] out)

Description copied from class: UGen

Implement this method when you extend UGen. It will be called when your UGen needs to generate one sample frame of audio. It is expected that you will assign values to the array and not simply modify the existing values. In the case where you write a UGen that takes audio input and modifies it, the pattern to follow is to have the first UGenInput you create be your audio input and then in uGenerate you will use the getLastValues method of your audio UGenInput to retrieve the audio you want to modify, which you will then modify however you need to, assigning the result to the values in channels.

Specified by:

uGenerate in class UGen

Parameters:

out - an array representing one sample frame.