HelpSource/Classes/Control.schelp

   1 class:: Control
   2 summary:: Bring signals and floats into the ugenGraph function of a SynthDef.
   3 related:: Classes/NamedControl, Classes/LagControl, Classes/TrigControl
   4 categories::  UGens>Synth control
   5
   6 Description::
   7
   8 A Control is a UGen that can be set and routed externally to interact with a running Synth.
   9 Typically, Controls are created from the arguments of a SynthDef function.
  10
  11 Generally you do not create Controls yourself. (See Arrays example
  12 below).
  13
  14 The rate may be either .kr (continous control rate signal) or .ir (a
  15 static value, set at the time the synth starts up, and subsequently
  16 unchangeable). For .ar, see link::Classes/AudioControl::
  17
  18 SynthDef creates these when compiling the ugenGraph function. They are
  19 created for you, you use them, and you don't really need to worry about
  20 them if you don't want to.
  21
  22 For a more concise combination of name, default value and lag, see link::Classes/NamedControl::
  23
  24 classmethods::
  25
  26 method::kr, ir
  27
  28 argument::values
  29
  30 default values.
  31
  32
  33 method::names
  34
  35 argument::names
  36
  37 adds control names to the SynthDef.
  38
  39
  40 Examples::
  41
  42 code::
  43 (
  44 SynthDef(\help_Control, { | freq = 200 |
  45
  46         freq.inspect; // at the time of compiling the def
  47
  48 }).add
  49 );
  50
  51 // synonym:
  52 (
  53 SynthDef(\help_Control, {
  54
  55         \freq.kr(200).inspect; // at the time of compiling the def
  56
  57 }).add
  58 );
  59 ::
  60
  61 What is passed into the ugenGraph function is an link::Classes/OutputProxy::, and its source is a Control.
  62
  63 The main explicit use of Control is to allow Arrays to be sent to running Synths:
  64 code::
  65 // a synth def that has 4 partials
  66 (
  67 SynthDef(\help_Control, { arg out=0, i_freq;
  68         var klank, harm, amp, ring;
  69
  70         // harmonics
  71         harm = Control.names([\harm]).ir(Array.series(4, 1, 1).postln);
  72         // amplitudes
  73         amp = Control.names([\amp]).ir(Array.fill(4, 0.05));
  74         // ring times
  75         ring = Control.names([\ring]).ir(Array.fill(4, 1));
  76
  77         klank = Klank.ar(`[harm, amp, ring], { ClipNoise.ar(0.01) }.dup, i_freq);
  78
  79         Out.ar(out, klank);
  80 }).add;
  81 )
  82
  83 a = Synth(\help_Control, [\i_freq, 300, \harm, [1, 3.3, 4.5, 7.8]]);
  84 a.free;
  85 a = Synth(\help_Control, [\i_freq, 300, \harm, [2, 3, 4, 5]]);
  86 a.free;
  87
  88 (
  89 SynthDef(\help_Control_Sines, { arg out=0;
  90         var sines, control, numsines;
  91         numsines = 20;
  92         control = Control.names(\array).kr(Array.rand(numsines, 400.0, 1000.0));
  93         sines = Mix(SinOsc.ar(control, 0, numsines.reciprocal)) ;
  94         Out.ar(out, sines ! 2);
  95 }).add
  96 )
  97
  98 b = Synth(\help_Control_Sines);
  99 b.setn(\array, Array.rand(20, 200, 1600));
 100 b.setn(\array, Array.rand(20, 200, 1600));
 101
 102
 103
 104 (
 105 SynthDef(\help_Control_DynKlank, { arg out=0, freq = 440;
 106         var klank, harm, amp, ring;
 107
 108         // harmonics
 109         harm = Control.names(\harm).kr(Array.series(4, 1, 1));
 110         // amplitudes
 111         amp = Control.names(\amp).kr(Array.fill(4, 0.05));
 112         // ring times
 113         ring = Control.names(\ring).kr(Array.fill(4, 1));
 114         klank = DynKlank.ar(`[harm, amp, ring], {ClipNoise.ar(0.003)}.dup, freq);
 115         Out.ar(out, klank);
 116 }).add
 117 )
 118
 119 a = Synth(\help_Control_DynKlank, [\freq, 300]);
 120 b = Synth(\help_Control_DynKlank, [\freq, 400]);
 121
 122
 123 a.setn(\harm,   Array.rand(4, 1.0, 4.7))
 124 a.setn(\amp, Array.rand(4, 0.005, 0.1))
 125 a.setn(\ring, Array.rand(4, 0.005, 1.0))
 126
 127 b.setn(\harm,   Array.rand(4, 1.0, 4.7))
 128 b.setn(\amp, Array.rand(4, 0.005, 0.1))
 129 b.setn(\ring, Array.rand(4, 0.005, 1.0))
 130 ::
 131
 132 subsection:: Symbols
 133
 134 Inside SynthDefs and UGen functions, symbols can be used to conventiently specify control inputs of different rates and with lags (see: link::Classes/NamedControl::, and link::Classes/Symbol::)
 135
 136 definitionlist::
 137 ## code:: \name.kr(val, lag) ::
 138 || Return a control rate link::Classes/NamedControl:: input with a default value (val), and if supplied, with a lag. If val is an array, the control will be multichannel.
 139 code::
 140 a = { SinOsc.ar(\freq.kr(440, 1.2)) }.play;
 141 a.set(\freq, 330);
 142 a.release;
 143 a = { SinOsc.ar(\freq.kr([440, 460], 1.2)) }.play;
 144 a.setn(\freq, [330, 367]);
 145 a.release;
 146 ::
 147
 148 ## code:: \name.ar(val, lag) ::
 149 || Return an audio rate link::Classes/NamedControl:: input with a default value (val), and if supplied, with a lag. If val is an array, the control will be multichannel.
 150
 151 ## code:: \name.ir(val) ::
 152 || Return an intitalization rate link::Classes/NamedControl:: input with a default value (val). If val is an array, the control will be multichannel.
 153
 154 ## code:: \name.tr(val) ::
 155 || Return a link::Classes/TrigControl:: input with a default value (val). If val is an array, the control will be multichannel.
 156 code::
 157 a = { Ringz.ar(T2A.ar(\trig.tr), \freq.kr(500, 1), 0.8) }.play;
 158 a.set(\freq, 330, \trig, 1);
 159 a.set(\freq, 830, \trig, 1);
 160 a.release;
 161 ::
 162 ::
 163