scide: implement selectionLength for openDocument
[supercollider.git] / HelpSource / Classes / BPeakEQ.schelp
blobfaf3b6491609aa8f95a0827d7590e53857262648
1 class:: BPeakEQ
2 summary:: Parametric equalizer
3 categories:: UGens>Filters>BEQSuite
4 related:: Classes/SOS, Classes/BLowPass, Classes/BLowPass4, Classes/BHiPass, Classes/BHiPass4, Classes/BPeakEQ, Classes/BLowShelf, Classes/BHiShelf, Classes/BBandPass, Classes/BBandStop, Classes/BAllPass
6 description::
7 The B equalization suite is based on the Second Order Section (link::Classes/SOS::) biquad UGen.
9 note::
10 Biquad coefficient calculations imply certain amount of CPU overhead. These plugin UGens contain optimizations such that the coefficients get updated only when there has been a change to one of the filter's parameters. This can cause spikes in CPU performance and should be considered when using several of these units.
13 classmethods::
15 method:: ar
16 argument:: in
17 input signal to be processed.
18 argument:: freq
19 center frequency.
20 argument:: rq
21 the reciprocal of Q. bandwidth / cutoffFreq.
22 argument:: db
23 boost/cut the center frequency (in dBs).
24 argument:: mul
25 argument:: add
27 examples::
28 code::
29 s.boot;
31 z = { // toy with boost/cut
32 BPeakEQ.ar(
33         SoundIn.ar([0,1]),
34         MouseX.kr(20, 20000, \exponential),
35         0.8, // rq
36         MouseY.kr(12.0, -12.0, \linear),
37         0.5); // mul
38 }.play)
39 z.release;
42 z = { // toy with rq
43 BPeakEQ.ar(
44         SoundIn.ar([0,1]),
45         MouseX.kr(20, 20000, \exponential),
46         MouseY.kr(10, 0.4, \linear), // rq
47         6, // boost/cut - +6dB
48         0.5); // mul
49 }.play)
50 z.release;