HelpSource/Classes/GrainIn.schelp

   1 class:: GrainIn
   2 summary:: Granulate an input signal
   3 categories:: UGens>Generators>Granular
   4 related:: Classes/GrainSin, Classes/GrainFM, Classes/GrainBuf
   5
   6 classmethods::
   7 private:: categories
   8
   9 method:: ar
  10
  11 argument:: numChannels
  12 the number of channels to output. If 1, mono is returned and pan is ignored.
  13
  14 argument:: trigger
  15 a kr or ar trigger to start a new grain. If ar, grains after the start of the synth are sample accurate.
  16
  17 argument:: dur
  18 size of the grain (in seconds).
  19
  20 argument:: in
  21 the input to granulate
  22
  23 argument:: pan
  24 determines where to pan the output.
  25 list::
  26 ## If numChannels = 1, no panning is done.
  27 ## If numChannels = 2, panning is similar to Pan2.
  28 ## If numChannels > 2, pannins is the same as PanAz.
  29 ::
  30
  31 argument:: envbufnum
  32 the buffer number containing a singal to use for the grain envelope. -1 uses a built-in Hann envelope.
  33
  34 argument:: maxGrains
  35 the maximum number of overlapping grains that can be used at a given time. This value is set at the UGens init time and can't be modified. Defaults to 512. This can be set lower for more efficient use of memory.
  36
  37 warning:: The above parameter is new (post SC 3.3.1) and has the potential to break code written <= 3.3.1. This parameter is BEFORE the mul slot, and you may need to update code to account for this difference. ::
  38
  39 argument:: mul
  40
  41 argument:: add
  42
  43 discussion:: All args except numChannels and trigger are polled at grain creation time.
  44 instancemethods::
  45 private:: init, argNamesInputsOffset
  46
  47 Examples::
  48 code::
  49 s.boot;
  50
  51 (
  52 var winenv;
  53 // a custom envelope
  54 winenv = Env([0, 1, 0], [0.5, 0.5], [8, -8]);
  55 z = Buffer.sendCollection(s, winenv.discretize, 1);
  56
  57 SynthDef(\in_grain_test, {arg gate = 1, amp = 1, envbuf;
  58         var pan, env;
  59         // use mouse x to control panning
  60         pan = MouseX.kr(-1, 1);
  61         env = EnvGen.kr(
  62                 Env([0, 1, 0], [1, 1], \sin, 1),
  63                 gate,
  64                 levelScale: amp,
  65                 doneAction: 2);
  66         Out.ar(0,
  67                 GrainIn.ar(2, Impulse.kr(32), 1, PinkNoise.ar * 0.05, pan, envbuf) * env)
  68         }).send(s);
  69
  70 )
  71
  72 // use built-in env
  73 x = Synth(\in_grain_test, [\envbuf, -1])
  74
  75 // switch to the custom env
  76 x.set(\envbuf, z)
  77 x.set(\envbuf, -1);
  78
  79 x.set(\gate, 0);
  80 ::
  81