Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / BLowShelf.schelp
blob6a90c50696e43435771c1711d7c92aec873f69fd
1 class:: BLowShelf
2 summary:: Low Shelf
3 categories:: UGens>Filters>BEQSuite
4 related:: Classes/SOS, Classes/BLowPass, Classes/BLowPass4, Classes/BHiPass, Classes/BHiPass4, Classes/BPeakEQ, 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:: rs
21 the reciprocal of S. Shell boost/cut slope. When S = 1, the shelf slope is as steep as it can be and remain monotonically increasing or decreasing gain with frequency. The shelf slope, in dB/octave, remains proportional to S for all other values for a fixed code::freq/SampleRate.ir:: and code::db::.
22 argument:: db
23 gain. boost/cut the center frequency in dBs.
24 argument:: mul
25 argument:: add
27 examples::
28 code::
29 s.boot;
31 z = { // toy around with boost/cut
32 BLowShelf.ar(
33         SoundIn.ar([0,1]),
34         MouseX.kr(40, 6000, \exponential),
35         1.0, // rs
36         MouseY.kr(24.0, -24.0, \linear),
37         0.5); // mul
38 }.play)
39 z.release;
42 z = { // toy around with rs
43 BLowShelf.ar(
44         SoundIn.ar([0,1]),
45         MouseX.kr(20, 6000, \exponential),
46         MouseY.kr(0.1, 1.0, \linear), // rs
47         6,
48         0.5); // mul
49 }.play)
50 z.release;