Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / Warp1.schelp
blobbd21e3084faeab8295532da9d1c86ce9a9f81de1
1 class:: Warp1
2 summary:: Warp a buffer with a time pointer
3 categories:: UGens>Buffer, UGens>Generators>Granular
5 description::
6 Inspired by Chad Kirby's SuperCollider2 Warp1 class, which was inspired by Richard Karpen's sndwarp for CSound. A granular time strecher and pitchshifter.
8 classmethods::
9 private:: categories
11 method:: ar
12 argument::numChannels
13 the number of channels in the soundfile used in bufnum.
15 argument::bufnum
16 the buffer number of a mono soundfile.
18 argument::pointer
19 the position in the buffer.  The value should be between 0 and 1, with 0 being the begining
20 of the buffer, and 1 the end.
22 argument::freqScale
23 the amount of frequency shift. 1.0 is normal, 0.5 is one octave down, 2.0 is one octave up.
24 Negative values play the soundfile backwards.
26 argument::windowSize
27 the size of each grain window.
29 argument::envbufnum
30 the buffer number containing a singal to use for the grain envelope. -1 uses a built-in
31 Hanning envelope.
33 argument::overlaps
34 the number of overlaping windows.
36 argument::windowRandRatio
37 the amount of randomness to the windowing function.  Must be between 0 (no
38 randomness) to 1.0 (probably to random actually)
40 argument::interp
41 the interpolation method used for pitchshifting grains. 1 = no interpolation. 2 = linear.
42                 4 = cubic interpolation (more computationally intensive).
44 argument::mul
46 argument::add
48 Examples::
49 code::
50 s.boot;
53 var winenv;
54 // a custom envelope - not a very good one, but you can hear the difference between this
55 // and the default
56 winenv = Env([0, 1, 0], [0.5, 0.5], [8, -8]);
57 b = Buffer.read(s, Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff");
58 z = Buffer.sendCollection(s, winenv.discretize, 1);
60 SynthDef(\warp, {arg buffer = 0, envbuf = -1;
61         var out, pointer, filelength, pitch, env, dir;
62         // pointer - move from beginning to end of soundfile over 15 seconds
63         pointer = Line.kr(0, 1, 15);
64         // control pitch with MouseX
65         pitch = MouseX.kr(0.5, 2);
66         env = EnvGen.kr(Env([0.001, 1, 1, 0.001], [0.1, 14, 0.9], 'exp'), doneAction: 2);
67         out = Warp1.ar(1, buffer, pointer, pitch, 0.1, envbuf, 8, 0.1, 2);
68         Out.ar(0, out * env);
69 }).send(s);
73 // use built-in env
74 x = Synth(\warp, [\buffer, b, \envbuf, -1])
76 // switch to the custom env
77 x.set(\envbuf, z)
78 x.set(\envbuf, -1);
80 x.free;