sclang: ServerShmInterface - try to avoid multiple destructor calls
[supercollider.git] / HelpSource / Classes / BLowShelf.schelp
blob206b17ef284af7a66ae8b6c94a4860572e0e406a
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.
25 examples::
26 code::
27 s.boot;
29 z = { // toy around with boost/cut
30 BLowShelf.ar(
31         SoundIn.ar([0,1]),
32         MouseX.kr(40, 6000, \exponential),
33         1.0, // rs
34         MouseY.kr(24.0, -24.0, \linear),
35         0.5); // mul
36 }.play)
37 z.release;
40 z = { // toy around with rs
41 BLowShelf.ar(
42         SoundIn.ar([0,1]),
43         MouseX.kr(20, 6000, \exponential),
44         MouseY.kr(0.1, 1.0, \linear), // rs
45         6,
46         0.5); // mul
47 }.play)
48 z.release;