Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / VOsc3.schelp
blob21e2b31e815a5bb3cd90fbddac2789177289c59a
1 class:: VOsc3
2 summary:: Three variable wavetable oscillators.
3 related:: Classes/COsc, Classes/Osc, Classes/OscN, Classes/VOsc
4 categories::  UGens>Generators>Deterministic
7 Description::
9 A wavetable lookup oscillator which can be swept smoothly across
10 wavetables. All the wavetables must be allocated to the same size.
11 Fractional values of table will interpolate between two adjacent tables.
12 This unit generator contains three oscillators at different frequencies,
13 mixed together.
16 This oscillator requires at least two buffers to be filled with a
17 wavetable format signal. This preprocesses the Signal into a form which
18 can be used efficiently by the Oscillator. The buffer size must be a
19 power of 2.
22 This can be achieved by creating a link::Classes/Buffer:: object and sending it one of
23 the "b_gen" messages ( sine1, sine2, sine3 ) with the wavetable flag set to true.
26 This can also be achieved by creating a link::Classes/Signal:: object and sending it
27 the link::Overviews/Methods#asWavetable#asWavetable:: message, saving it to disk, and having the server load
28 it from there.
31 If you use Buffer objects to manage buffer numbers, you can use the
32 [*allocConsecutive] method to allocate a continuous block of buffers.
33 See the link::Classes/Buffer:: helpfile for details.
36 note::
38 VOsc3 requires the b_gen sine1 wavetable flag to be ON.
42 classmethods::
44 method::ar, kr
46 argument::bufpos
48 Buffer index. Can be swept continuously among adjacent wavetable
49 buffers of the same size.
52 argument::freq1
54 Frequency in Hertz of the 1st oscillator.
57 argument::freq2
59 Frequency in Hertz of the 2nd oscillator.
62 argument::freq3
64 Frequency in Hertz of the 3rd oscillator.
67 argument::mul
69 Output will be multiplied by this value.
72 argument::add
74 This value will be added to the output.
77 Examples::
79 code::
82 s = Server.local;
83 // allocate and fill tables 0 to 7
84 8.do({ arg i;
85         var n, a;
86         // allocate table
87         s.sendMsg(\b_alloc, i, 1024);
88         // generate array of harmonic amplitudes
89         n = (i+1)**2;
90         a = Array.fill(n, { arg j; ((n-j)/n).squared.round(0.001) });
91         // fill table
92         s.performList(\sendMsg, \b_gen, i, \sine1, 7, a);
93 });
97 SynthDef("help-VOsc",{ arg out=0, bufoffset=0, freq=240;
98         var x;
99         // mouse x controls the wavetable position
100         x = MouseX.kr(0,7);
101         Out.ar(out,
102                 VOsc3.ar(bufoffset+x, freq+[0,1],freq+[0.37,1.1],freq+[0.43, -0.29], 0.3)
103         )
104 }).play(s,[\out, 0, \bufoffset, 0]);
108 8.do({ arg i;
109         var a;
110         s.sendMsg(\b_alloc, i, 1024); // allocate table
111         // generate array of harmonic amplitudes
112         a = Array.fill(i, 0) ++ [0.5, 1, 0.5];
113         // fill table
114         s.performList(\sendMsg, \b_gen, i, \sine1, 7, a);
119 8.do({ arg i;
120         var a, n;
121         s.sendMsg(\b_alloc, i, 1024); // allocate table
122         // generate array of harmonic amplitudes
123         n = (i+1)*8;
124         a = Array.fill(n,0);
125         (n>>1).do({ arg i; a.put(n.rand, 1) });
126         // fill table
127         s.performList(\sendMsg, \b_gen, i, \sine1, 7, a);
132 8.do({ arg i;
133         var a;
134         s.sendMsg(\b_alloc, i, 1024); // allocate table
135         // generate array of harmonic amplitudes
136         n = (i+1)**2;
137         a = Array.fill(n, { arg j; 1.0.rand2 });
138         // fill table
139         s.performList(\sendMsg, \b_gen, i, \sine1, 7, a);
144 var a;
145 a = Array.fill(64, { arg j; 1.0.rand2 });
146 8.do({ arg i;
147         s.sendMsg(\b_alloc, i, 1024); // allocate table
148         // generate array of harmonic amplitudes
149         n = (i+1)**2;
150         // fill table
151         s.performList(\sendMsg, \b_gen, i, \sine1, 7, a.extend(n.asInteger));
156 var a;
157 a = Array.fill(64, { arg j; 1/(j+1) });
158 8.do({ arg i;
159         s.sendMsg(\b_alloc, i, 1024); // allocate table
160         // generate array of harmonic amplitudes
161         n = (i+1)**2;
162         // fill table
163         s.performList(\sendMsg, \b_gen, i, \sine1, 7, a.extend(n.asInteger));