Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / BufDelayL.schelp
blobde3d27cff38592884c12687d47610574557ddc9b
1 class:: BufDelayL
2 summary:: Buffer based simple delay line with linear interpolation.
3 related:: Classes/BufDelayC, Classes/BufDelayN, Classes/DelayL
4 categories::  UGens>Delays>Buffer
7 Description::
9 Simple delay line with linear interpolation which uses a buffer for its
10 internal memory. See also  link::Classes/BufDelayN::  which uses no
11 interpolation, and  link::Classes/BufDelayC::  which uses cubic
12 interpolation. Cubic interpolation is more computationally expensive
13 than linear, but more accurate.
16 classmethods::
18 method::ar, kr
20 argument::buf
21 Buffer number.
23 note:: The buffers provided to any of the BufDelay units must be one channel. If you want to delay a multichannel signal, you must provide as many separate (one-channel) buffers as there are input channels.::
25 argument::in
26 The input signal.
28 argument::delaytime
29 Delay time in seconds.
31 discussion::
32 Warning:: For reasons of efficiency, the effective buffer size is limited to the previous power of two. So, if 44100 samples are allocated, the maximum delay would be 32768 samples.
35 Examples::
37 code::
39 // allocate buffer
40 b = Buffer.alloc(s,44100,1);
43 // Dust randomly triggers Decay to create an exponential
44 // decay envelope for the WhiteNoise input source
46 z = Decay.ar(Dust.ar(1,0.5), 0.3, WhiteNoise.ar);
47 BufDelayL.ar(b.bufnum, z, 0.2, 1, z); // input is mixed with delay via the add input
48 }.play
51 b.free;
54 // multichannel
56 // two channels, two buffers
57 b = Buffer.allocConsecutive(2, s, 32768, 1);
59 a = { |bufs = #[0, 1]|
60         var sig = SinOsc.ar([440, 880]) * Decay2.kr(Impulse.kr([2, 4]), 0.01, 0.15);
61         sig + BufDelayL.ar(bufs, sig, delaytime: 0.125)
62 }.play(args: [bufs: b]);
64 a.free;
65 b.do(_.free);