Classes | UGens>Generators>Deterministic | UGens>Filters>Linear

# Klank : UGen : AbstractFunction : Object

Bank of resonators
Source: FSinOsc.sc
See also: DynKlank, Klang

## Description

Klank is a bank of fixed frequency resonators which can be used to simulate the resonant modes of an object. Each mode is given a ring time, which is the time for the mode to decay by 60 dB.

NOTE: for dynamic changes of parameters refer to DynKlank
NOTE: The amplitude of the resulting signal depends on the server's sample rate. See Ringz: Interaction with sample rate for details.

Klank is a bank of Ringz filters. Formlet is equivalent to `Ringz.ar(... decay...) - Ring.ar(... attack...)`. Therefore, a more efficient way to make a bank of fixed-parameter Formlet filters is `Klank(`decaySpecs, ...) - Klank.ar(`attackSpecs, ...)` or `Klank.ar(`specs, ..., decayscale: decay) - Klank.ar(`specs, ..., decayscale: attack)`.

## Class Methods

### Klank.ar(specificationsArrayRef, input, freqscale: 1.0, freqoffset: 0.0, decayscale: 1.0)

#### Arguments:

specificationsArrayRef | A Ref to an Array of three Arrays: frequencies: An Array of filter frequencies. amplitudes: an Array of filter amplitudes, or nil. If nil, then amplitudes default to 1.0. ring times: an Array of 60 dB decay times in seconds for the filters. All subarrays, if not nil, should have the same length.
input | The excitation input to the resonant filter bank.
freqscale | A scale factor multiplied by all frequencies at initialization time.
freqoffset | An offset added to all frequencies at initialization time.
decayscale | A scale factor multiplied by all ring times at initialization time.

#### Discussion:

The parameters in `specificationsArrayRef` can't be changed after it has been started. For a modulatable but less efficient version, see DynKlank.

### Inherited class methods

## Instance Methods

### Inherited instance methods

## Examples

Four resonators each at maximum amplitude of 1.0 and ring times of 1 second, different exciters and no scaling:

NOTE: Watch the ` before the opening bracket of the parameter array! Also see Multichannel Expansion

{ Klank.ar(`[[800, 1071, 1153, 1723], nil, [1, 1, 1, 1]], Impulse.ar(2, 0, 0.1)) }.play; { Klank.ar(`[[800, 1071, 1353, 1723], nil, [1, 1, 1, 1]], Dust.ar(8, 0.1)) }.play; { Klank.ar(`[[800, 1071, 1353, 1723], nil, [1, 1, 1, 1]], PinkNoise.ar(0.007)) }.play; { Klank.ar(`[[200, 671, 1153, 1723], nil, [1, 1, 1, 1]], PinkNoise.ar([0.007, 0.007])) }.play;

Three resonators at maximum amplitude of 1.0, random frequency and ring times. Excited by two pulses at 2 and 2.5 Hz:( play({ Klank.ar(`[ Array.rand(12, 800.0, 4000.0), // frequencies nil, // amplitudes (default to 1.0) Array.rand(12, 0.1, 2) // ring times ], Decay.ar(Impulse.ar(4), 0.03, ClipNoise.ar(0.01))) }) )

Multichannel Expansion via an array of specs (note the ` before the opening bracket of the parameter array!):( { Klank.ar([ // the multichannel-expansion `[[500, 1078, 1201.5, 1723], nil, [1, 1, 0.5, 0.3]], // left channel `[[700, 1071, 1053, 1723], nil, [1, 1, 1, 1]] // right channel ], Impulse.ar([1.5, 1.875], 0, 0.1)) }.play ); // expanding specs within the parameter array { Klank.ar(`[[[800, 6000], 1071, [1153, 8000], 1723], nil, [1, 1, 1, 1]], Impulse.ar([2, 3], 0, 0.1)) }.play;

A SynthDef that generates 4 partials used in different configurations:( SynthDef(\help_Klank, { arg out=0, i_freq; var klank, n, harm, amp, ring; // harmonics harm = \harm.ir(Array.series(4, 1, 1).postln); // amplitudes amp = \amp.ir(Array.fill(4, 0.05)); // ring times ring = \ring.ir(Array.fill(4, 1)); klank = Klank.ar(`[harm, amp, ring], {ClipNoise.ar(0.003)}.dup, i_freq); Out.ar(out, klank); }).add; ) // nothing special yet, just using the default set of harmonics. a = Synth(\help_Klank, [\i_freq, 300]); b = Synth(\help_Klank, [\i_freq, 400]); c = Synth(\help_Klank, [\i_freq, 533.33]); d = Synth(\help_Klank, [\i_freq, 711.11]); a.free; b.free; c.free; d.free; a = Synth(\help_Klank, [\i_freq, 500, \harm, [4, 1, 3, 5, 7]]); a.free; // set geometric series harmonics a = Synth(\help_Klank, [\i_freq, 500, \harm,Array.geom(4, 1, 1.61)]); a.free; // set harmonics, ring times and amplitudes ( a = Synth(\help_Klank, [ \i_freq, 500, \harm, [4, 1, 3, 5, 7], \ring, Array.fill(4, 0.1), // set shorter ring time \amp, Array.fill(4, 0.2) // set louder amps ]) );

Advanced examples:// -- overlap texture ( SynthDef("help-KlankOverlapTexture", {|out = 0, freqs = #[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], rings = #[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], atk = 5, sus = 8, rel = 5, pan = 0| var e = EnvGen.kr(Env.linen(atk, sus, rel, 1, 4), doneAction: Done.freeSelf); var i = Decay.ar(Impulse.ar(Rand(0.8, 2.2)), 0.03, ClipNoise.ar(0.01)); var z = Klank.ar( `[freqs, nil, rings], // specs i // input ); Out.ar(out, Pan2.ar(z*e, pan)); }).add; r = Routine{ var sustain = 8, transition = 3, overlap = 4; var period = transition * 2 + sustain / overlap; 0.5.wait; // wait for the synthdef to be sent to the server inf.do{ Synth("help-KlankOverlapTexture", [ \atk, transition, \sus, sustain, \rel, transition, \pan, 1.0.rand2, \freqs, {200.0.rrand(4000)}.dup(12), \rings, {0.1.rrand(2)}.dup(12) ]); period.wait; } }; r.play; ) r.stop; // stop spawning new synths // -- frequency and decay scaling ( SynthDef("help-KlankScaling", {|out = 0, freq = 0, rings = #[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], pan = 0| var e = EnvGen.kr(Env(#[1, 1, 0], #[0.4, 0.01]), doneAction: Done.freeSelf); var i = Decay.ar(Impulse.ar(0), 0.03, ClipNoise.ar(0.01)); var z = Klank.ar( `[(1..12), nil, rings], // specs (partials, amplitudes, ringtimes) i, // input freq, // scale to this frequency 0, // frequency offset MouseX.kr(0.2, 3) // scale decay times ); Out.ar(out, Pan2.ar(z*e, pan)); }).add; r = Routine{ var sustain = 8, transition = 3; var mode = #[0, 2, 4, 5, 7, 9, 11, 12, 14, 16, 17, 19, 21, 23, 24]; 0.5.wait; // wait for the synthdef to be sent to the server inf.do{|i| Synth("help-KlankScaling", [ \freq, (72 + (mode @@ i)).midicps, \rings, {0.1.rrand(2)}.dup(12) ]); 0.2.wait; } }; r.play; ) r.stop; // -- overlap texture 2 ( SynthDef("help-KlankOverlapTexture2", {|out = 0, freqs = #[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], rings = #[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], atk = 5, sus = 8, rel = 5, pan = 0| var e = EnvGen.kr(Env.linen(atk, sus, rel, 1, 4), doneAction: Done.freeSelf); var i = BrownNoise.ar(0.0012); var z = Klank.ar( `[freqs, nil, rings], // specs i // input ); Out.ar(out, Pan2.ar(z*e, pan)); }).add; r = Routine{ var sustain = 6, transition = 4, overlap = 5; var period = transition*2+sustain/overlap; 0.5.wait; // wait for the synthdef to be sent to the server inf.do { Synth("help-KlankOverlapTexture2", [ \atk, transition, \sus, sustain, \rel, transition, \pan, 1.0.rand2, \freqs, {6000.0.linrand+80}.dup(12), \rings, {0.1.rrand(3)}.dup(12) ]); period.wait; } }; r.play; ) r.stop; // -- overlap texture 3 ( SynthDef("help-KlankOverlapTexture3", {|out = 0, freqs = #[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], rings = #[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], pan = 0| var e = EnvGen.kr(Env(#[1, 1, 0], #[18, 3]), doneAction: Done.freeSelf); var i = Decay.ar(Impulse.ar(Rand(0.2, 0.6)), 0.8, ClipNoise.ar(0.001)); var z = Klank.ar( `[freqs, 2, rings], // specs i // input ); Out.ar(out, Pan2.ar(z*e, pan)); }).add; r = Routine{ 0.5.wait; // wait for the synthdef to be sent to the server inf.do { Synth("help-KlankOverlapTexture3", [ \pan, 1.0.rand2, \freqs, {12000.0.linrand+80}.dup(12), \rings, {3.rrand(10)}.dup(12) ]); 3.wait; } }; r.play; ) r.stop;

helpfile source: /Applications/SuperCollider.app/Contents/Resources/HelpSource/Classes/Klank.schelp
link::Classes/Klank::