Added help for Pen and updated some other docs
[supercollider.git] / HelpSource / Classes / BufAllpassN.schelp
blobadcf3255b80073aed33d7ecac5926e0a9546e476
1 class:: BufAllpassN
2 summary:: Buffer based all pass delay line with no interpolation.
3 related:: Classes/BufAllpassC, Classes/BufAllpassL, Classes/AllpassN
4 categories::  UGens>Delays>Buffer
7 Description::
9 All pass delay line with no interpolation which uses a buffer for its
10 internal memory. See also  link::Classes/BufAllpassC::  which uses cubic
11 interpolation, and  which  link::Classes/BufAllpassL::  uses linear
12 interpolation. Cubic interpolation is more computationally expensive
13 than linear, but more accurate.
15 classmethods::
17 method::ar
19 argument::buf
20 Buffer number.
22 argument::in
23 The input signal.
25 argument::delaytime
26 Delay time in seconds.
28 argument::decaytime
29 Time for the echoes to decay by 60 decibels. If this time is negative then the feedback coefficient will be negative, thus emphasizing only odd harmonics at an octave lower.
31 discussion::
32 warning::
33 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.
36 Examples::
38 code::
40 // allocate buffer
41 b = Buffer.alloc(s,44100,1);
43 // Since the allpass delay has no audible effect as a resonator on
44 // steady state sound ...
46 { BufAllpassC.ar(b.bufnum, WhiteNoise.ar(0.1), XLine.kr(0.0001, 0.01, 20), 0.2) }.play;
48 // ...these examples add the input to the effected sound and compare variants so that you can hear
49 // the effect of the phase comb:
53         z = WhiteNoise.ar(0.2);
54         z + BufAllpassN.ar(b.bufnum, z, XLine.kr(0.0001, 0.01, 20), 0.2)
55 }.play)
59         z = WhiteNoise.ar(0.2);
60         z + BufAllpassL.ar(b.bufnum, z, XLine.kr(0.0001, 0.01, 20), 0.2)
61 }.play)
65         z = WhiteNoise.ar(0.2);
66         z + BufAllpassC.ar(b.bufnum, z, XLine.kr(0.0001, 0.01, 20), 0.2)
67 }.play)
69 // used as an echo - doesn't really sound different than Comb,
70 // but it outputs the input signal immediately (inverted) and the echoes
71 // are lower in amplitude.
72 { BufAllpassN.ar(b.bufnum, Decay.ar(Dust.ar(1,0.5), 0.2, WhiteNoise.ar), 0.2, 3) }.play;