Part 1. UGens

Table of Contents

1. Base

UGen — FIXME:

MultiOutUGen — FIXME:

OutputProxy — FIXME:

doneActions — UGen Done Actions.

BinaryOpUGen — FIXME: BinaryOpUGen purpose.

UnaryOpUGen — FIXME: UnaryOpUGen purpose.

2. Analysis

Amplitude — Amplitude follower.

DC — DC offset follower.

DegreeToKey — Convert signal to modal pitch.

MostChange — Output most changed.

LeastChange — Output least changed.

LastValue — Output the last value before the input changed.

PeakFollower — Track peak signal amplitude.

Peak — Track peak signal amplitude.

Pitch — Autocorrelation pitch follower.

PulseCount — Pulse counter.

RunningMax — Track maximum level.

RunningMin — Track minimum level.

RunningSum — A running sum over a user specified number of samples.

Slope — Slope of signal.

ZeroCrossing — Zero crossing frequency follower.

3. Buffers and I/O

AudioIn — Read audio input.

BufRd — Buffer reading oscillator.

BufWr — Buffer writing oscillator.

Control — Bring signals and floats into the ugenGraph function of a SynthDef.

DiskIn — Stream in audio from a file.

DiskOut — Record to a soundfile to disk.

InFeedback — Read signal from a bus with a current or one cycle old timestamp.

InTrig — Generate a trigger anytime a bus is set.

In — Read a signal from a bus.

LagControl — FIXME: LagControl purpose.

LagIn — Read a signal from a bus with a lag.

LocalIn — Define and read from buses local to a synth.

LocalOut — Write to buses local to a synth.

OffsetOut — Write a signal to a bus with sample accurate timing.

Out — Write a signal to a bus.

PlayBuf — Sample playback oscillator.

RecordBuf — Record or overdub into a Buffer.

ReplaceOut — Send signal to a bus, overwriting previous contents.

ScopeOut — FIXME: ScopeOut purpose.

SharedIn — Read from a shared control bus.

SharedOut — Write to a shared control bus.

TGrains — Buffer granulator.

TrigControl — FIXME: TrigControl purpose.

XOut — Send signal to a bus, crossfading with previous contents.

4. Chaos

CuspL — Cusp map chaotic generator.

CuspN — Cusp map chaotic generator.

FBSineC — Feedback sine with chaotic phase indexing.

FBSineL — Feedback sine with chaotic phase indexing.

FBSineN — Feedback sine with chaotic phase indexing.

GbmanL — Gingerbreadman map chaotic generator.

GbmanN — Gingerbreadman map chaotic generator.

HenonC — Hénon map chaotic generator.

HenonL — Hénon map chaotic generator.

HenonN — Hénon map chaotic generator.

LatoocarfianC — Latoocarfian chaotic generator.

LatoocarfianL — Latoocarfian chaotic generator.

LatoocarfianN — Latoocarfian chaotic generator.

LinCongC — Linear congruential chaotic generator.

LinCongL — Linear congruential chaotic generator.

LinCongN — Linear congruential chaotic generator.

LorenzL — Lorenz chaotic generator.

QuadC — General quadratic map chaotic generator.

QuadL — General quadratic map chaotic generator.

QuadN — General quadratic map chaotic generator.

StandardL — Standard map chaotic generator.

StandardN — Standard map chaotic generator.

5. Control

Clip — Clip a signal outside given thresholds.

DetectSilence — When input falls below a threshhold, evaluate doneAction.

EnvGen — Envelope generator.

Fold — Fold a signal outside given thresholds.

InRange — Tests if a signal is within a given range.

InRect — Test if a point is within a given rectangle.

Linen — Simple linear envelope generator.

Line — Line generator.

LinExp — Map a linear range to an exponential range.

LinLin — Map a linear range to another linear range.

Phasor — A resettable linear ramp between two levels.

PulseDivider — Pulse divider.

Schmidt — Schmidt trigger.

Select — Select output from an array of inputs.

SendTrig — Send a trigger message from the server back to the client.

SetResetFF — Set-reset flip flop.

Stepper — Pulse counter.

Sweep — Triggered linear ramp.

TDelay — Trigger delay.

Timer — Returns time since last triggered.

ToggleFF — Toggle flip flop.

Trapezoid — FIXME: Trapezoid purpose.

Trig1 — Timed trigger.

Trig — Timed trigger.

Wrap — Wrap a signal outside given thresholds.

XLine — Exponential line generator.

6. Demand UGens

Dbrown — Demand rate brownian movement generator.

DemandEnvGen — FIXME: DemandEnvGen purpose.

Demand — Demand results from demand rate UGens.

Dgeom — Demand rate geometric series UGen.

Dibrown — Demand rate brownian movement generator.

Diwhite — Demand rate white noise random generator.

Drand — Demand rate random sequence generator.

Dseq — Demand rate sequence generator.

Dseries — Demand rate arithmetic series UGen.

Dser — Demand rate sequence generator.

Dswitch1 — Demand rate generator for switching between inputs.

Duty — Demand results from demand rate UGens.

Dwhite — Demand rate white noise random generator.

Dxrand — Demand rate random sequence generator.

TDuty — Demand results as trigger from demand rate UGens.

7. Delays

AllpassC — All pass delay line with cubic interpolation.

AllpassL — All pass delay line with linear interpolation.

AllpassN — All pass delay line with no interpolation.

BufAllpassC — Buffer based all pass delay line with cubic interpolation.

BufAllpassL — Buffer based all pass delay line with linear interpolation.

BufAllpassN — Buffer based all pass delay line with no interpolation.

BufCombC — Buffer based comb delay line with cubic interpolation.

BufCombL — Buffer based comb delay line with linear interpolation.

BufCombN — Buffer based comb delay line with no interpolation.

BufDelayC — Buffer based simple delay line with cubic interpolation.

BufDelayL — Buffer based simple delay line with linear interpolation.

BufDelayN — Buffer based simple delay line with no interpolation.

CombC — Comb delay line with cubic interpolation.

CombL — Comb delay line with linear interpolation.

CombN — Comb delay line with no interpolation.

Delay1 — Single sample delay.

Delay2 — Two sample delay.

DelayC — Simple delay line with cubic interpolation.

DelayL — Simple delay line with linear interpolation.

DelayN — Simple delay line with no interpolation.

MultiTap — Multiple tap delay.

PingPong — Stereo ping-pong delay.

PitchShift — Time domain pitch shifter.

Tap — FIXME: Tap purpose.

8. Filters

APF — FIXME: APF purpose.

BPF — 2nd order Butterworth bandpass filter.

BPZ2 — Two zero fixed midpass.

BRF — 2nd order Butterworth bandreject filter.

BRZ2 — Two zero fixed midcut.

Decay2 — Exponential decay.

Decay — Exponential decay.

DynKlank — Bank of resonators.

Formlet — FOF-like filter.

FOS — First order filter section.

FreqShift — Frequency Shifter.

HilbertFIR — FIXME: HilbertFIR purpose.

Hilbert — FIXME: Hilbert purpose.

HPF — 2nd order Butterworth highpass filter.

HPZ1 — Two point difference filter.

HPZ2 — Two zero fixed midcut.

Integrator — A leaky integrator.

Klank — Bank of resonators.

Lag2 — Exponential lag.

Lag3 — Exponential lag.

Lag — Exponential lag.

LeakDC — Remove DC.

Limiter — Peak limiter.

LPF — 2nd order Butterworth lowpass filter.

LPZ1 — Two point average filter.

LPZ2 — Two zero fixed lowpass.

Median — Median filter.

MidEQ — Parametric filter.

Normalizer — Flattens dynamics.

OnePole — One pole filter.

OneZero — One zero filter.

Ramp — Linear lag.

Resonz — Resonant filter.

RHPF — A resonant high pass filter.

Ringz — Ringing filter.

RLPF — A resonant low pass filter.

Slew — Slew rate limiter.

SOS — Second order filter section (biquad).

TwoPole — Two pole filter.

TwoZero — Two zero filter.

9. Frequency Domain

Convolution2L — Fixed kernel convolver with linear crossfade.

Convolution2 — Real-time fixed kernel convolver.

Convolution3 — Time based convolver.

Convolution — Real-time convolver.

FFT — Fast Fourier Transform.

IFFT — Inverse Fast Fourier Transform.

PV_Add — Complex addition.

PV_BinScramble — Scramble bins.

PV_BinShift — Shift and stretch bin position.

PV_BinWipe — Combine low and high bins from two inputs.

PV_BrickWall — Zero bins.

PV_ConformalMap — Complex plane attack.

PV_CopyPhase — Copy magnitudes and phases.

PV_Diffuser — Random phase shifting.

PV_HainsworthFoote — FFT onset detector.

PV_JensenAndersen — FFT feature detector for onset detection.

PV_LocalMax — Pass bins which are a local maximum.

PV_MagAbove — Pass bins above a threshold.

PV_MagBelow — Pass bins below a threshold.

PV_MagClip — Clip bins to a threshold.

PV_MagFreeze — Freeze magnitudes.

PV_MagMul — Multiply magnitudes.

PV_MagNoise — Multiply magnitudes by noise.

PV_MagShift — shift and stretch magnitude bin position.

PV_MagSmear — Average magnitudes across bins.

PV_MagSquared — Square magnitudes.

PV_Max — Maximum magnitude.

PV_Min — Minimum magnitude.

PV_Mul — Complex multiply.

PV_PhaseShift270 — Shift phase by 270 degrees.

PV_PhaseShift90 — Shift phase by 90 degrees.

PV_PhaseShift — Shift phase.

PV_RandComb — Pass random bins.

PV_RandWipe — Crossfade in random bin order.

PV_RectComb2 — Make gaps in spectrum.

PV_RectComb — Make gaps in spectrum.

10. InfoUGens

BufChannels — Current number of channels of soundfile in buffer.

BufDur — Current duration of soundfile in buffer.

BufFrames — Current number of frames allocated in the buffer.

BufRateScale — Buffer rate scaling in respect to server samplerate.

BufSampleRate — Buffer sample rate.

BufSamples — Current number of samples in buffer.

ControlRate — Server control rate.

NumAudioBuses — Number of audio busses.

NumBuffers — Number of open buffers.

NumControlBuses — Number of control busses.

NumInputBuses — Number of input busses.

NumOutputBuses — Number of output busses.

NumRunningSynths — Number of currently running synths.

RadiansPerSample — Number of radians per sample.

SampleDur — Duration of one sample.

SampleRate — Server sample rate.

SubsampleOffset — Offset from synth start within one sample.

11. Noise

BrownNoise — Brown Noise.

ClipNoise — Clip Noise.

CoinGate — Statistical gate.

Crackle — Chaotic noise function.

Dust — Random impulses.

Dust2 — Random impulses.

GrayNoise — Gray Noise.

Hasher — Randomized value.

Latoocarfian — Chaotic function.

LFClipNoise — Clipped noise.

LFDClipNoise — Dynamic clipped noise.

LFDNoise0 — Dynamic step noise.

LFDNoise1 — Dynamic ramp noise.

LFDNoise3 — Dynamic cubic noise.

LFNoise0 — Step noise.

LFNoise1 — Ramp noise.

LFNoise2 — Quadratic noise.

Logistic — FIXME: Logistic purpose.

MantissaMask — Reduce precision.

NoahNoise — FIXME: not installed.

PinkNoise — Pink Noise.

WhiteNoise — White noise.

12. Oscillators

Blip — Band limited impulse oscillator.

COsc — Chorusing wavetable oscillator.

Formant — Formant oscillator.

FSinOsc — Fast sine oscillator.

Gendy1 — Dynamic stochastic synthesis generator.

Gendy2 — Dynamic stochastic synthesis generator.

Gendy3 — Dynamic stochastic synthesis generator.

Impulse — Impulse oscillator.

Index — Index into a table with a signal.

Klang — Sine oscillator bank.

LFCub — A sine like shape made of two cubic pieces.

LFPar — A sine-like shape made of two parabolas.

LFPulse — Pulse oscillator.

LFSaw — Sawtooth oscillator.

LFTri — Triangle oscillator.

OscN — Noninterpolating wavetable oscillator.

Osc — Interpolating wavetable oscillator.

PMOsc — Phase modulation oscillator pair.

PSinGrain — Very fast sine grain with a parabolic envelope.

Pulse — Band limited pulse wave.

Saw — Band limited sawtooth.

Shaper — Wave shaper.

SinOscFB — FIXME: SinOscFB purpose.

SinOsc — Interpolating sine wavetable oscillator.

SyncSaw — Hard sync sawtooth wave.

TPulse — FIXME: TPulse purpose.

VarSaw — Variable duty saw.

Vibrato — FIXME: Vibrato purpose.

VOsc3 — Three variable wavetable oscillators.

VOsc — Variable wavetable oscillator.

WrapIndex — Index into a table with a signal.

13. MultiChannel

Balance2 — FIXME: Balance2 purpose.

BiPanB2 — 2D Ambisonic B-format panner.

DecodeB2 — 2D Ambisonic B-format decoder.

LinPan2 — Two channel linear pan.

LinXFade2 — Two channel linear crossfade.

Mix — Sum an array of channels.

Pan2 — Two channel equal power pan.

Pan4 — Four channel equal power pan.

PanAz — Azimuth panner

PanB2 — 2D Ambisonic B-format panner.

PanB — Ambisonic B-format panner.

Rotate2 — Rotate a sound field.

XFade2 — Equal power two channel cross fade.

14. Physical Modelling

Ball — Physical model of a bouncing object.

Spring — Physical model of resonating spring.

TBall — Physical model of a bouncing object.

15. Random Numbers

ExpRand — Exponential single random number generator.

IRand — Single integer random number generator.

LinRand — Skewed random number generator.

NRand — Sum of uniform distributions.

RandID — Set the synth's random generator ID.

RandSeed — Sets the synth's random generator seed.

Rand — Single random number generator.

TExpRand — Triggered exponential random number generator.

TIRand — Triggered integer random number generator.

TRand — Triggered random number generator.

TWindex — Triggered windex.

16. Synth-Controlling UGens

Done — FIXME: Done purpose.

Free — When triggered, frees a node.

FreeSelf — When triggered, free enclosing synth.

FreeSelfWhenDone — FIXME: FreeSelfWhenDone purpose.

Pause — When triggered, pauses a node.

PauseSelf — When triggered, pause enclosing synth.

PauseSelfWhenDone — FIXME: PauseSelfWhenDone purpose.

17. Miscellaneous

A2K — Audio to control rate converter.

AmpCompA — Basic psychoacoustic amplitude compensation (ANSI A-weighting curve).

AmpComp — Basic psychoacoustic amplitude compensation.

Compander — Compressor, expander, limiter, gate, ducker.

CompanderD — Compressor, expander, limiter, gate, ducker.

Gate — Gate or hold.

K2A — Control to audio rate converter.

KeyState — Respond to the state of a key.

Latch — Sample and hold.

MouseButton — Mouse button UGen.

MouseX — Cursor tracking UGen.

MouseY — Cursor tracking UGen.

Silent — Output silence.

ImageWarp — FIXME: ImageWarp purpose.

XY — FIXME: XY purpose.

Peep — FIXME: Peep purpose.

Splay — FIXME: Splay purpose.

SplayZ — FIXME: SplayZ purpose.