HelpSource/Classes/FreqScopeView.schelp

   1 class:: FreqScopeView
   2 redirect:: implClass
   3 summary:: Frequency analysis view
   4 categories:: GUI>Views
   5 related:: Classes/FreqScope
   6
   7 description::
   8 FreqScopeView shows the frequency spectrum of a specified audio bus.
   9
  10 note::
  11
  12 The scope will remain active after a command-period. To turn it off you must use the 'active' method.
  13 Very important: You must run code::kill():: when the parent window is closed to avoid problems. It also frees the buffers that the scope allocated and stops the FFT analysis synth. So:
  14 code::
  15 (
  16 w = Window("My Analyzer", Rect(0, 0, 511, 300));
  17 f = FreqScopeView(w, w.view.bounds);
  18 w.onClose_({ f.kill }); // YOU MUST HAVE THIS
  19 w.front;
  20 )
  21 ::
  22
  23 ::
  24
  25
  26 classmethods::
  27
  28 method:: new
  29 argument:: parent
  30 The parent view.
  31 argument:: bounds
  32 An instance of link::Classes/Rect::, or a link::Classes/Point:: indicating code::width@height::.
  33 discussion::
  34 Example:
  35 code::
  36 // Start internal server
  37 s = Server.internal.boot;
  38
  39 // Create analyzer in a window
  40 (
  41 w = Window("My Analyzer", Rect(0, 0, 511, 300)); // width should be 511
  42 f = FreqScopeView(w, w.view.bounds);
  43 f.active_(true); // turn it on the first time;
  44
  45 w.onClose_({ f.kill }); // you must have this
  46 w.front;
  47 { SinOsc.ar([500, 1000], 0, 0.25).mean.dup }.play(s); // start two sine waves
  48 )
  49 ::
  50
  51 method:: response
  52 Create a scope in a special frequency-response mode. This uses FFT-based spectral division to estimate the frequency response of some effect, on the assumption that the signal to bus1 is transformed to the signal at bus2 by some linear time-invariant process.
  53 argument:: parent
  54 The parent view.
  55 argument:: bounds
  56 An instance of link::Classes/Rect::, or a link::Classes/Point:: indicating code::width@height::.
  57 argument:: bus1
  58 The bus on which the "pre" signal is found.
  59 argument:: bus2
  60 The bus on which the "post" signal is found.
  61 argument:: freqMode
  62 Linear (0) or log(1) frequency mode. Defaults to 1.
  63 discussion::
  64 Example:
  65 code::
  66 Server.default = s = Stethoscope.defaultServer.boot;
  67
  68 // basic usage. try these. Each one will open a new window
  69 // move the mouse left and right to test response in different ranges
  70 LPF.scopeResponse
  71 HPF.scopeResponse
  72 MoogFF.scopeResponse
  73 BBandPass.scopeResponse
  74 BLowShelf.scopeResponse // by default BLowShelf doesn't mangle much
  75 Resonz.scopeResponse
  76 BRF.scopeResponse
  77 Integrator.scopeResponse
  78 Median.scopeResponse // nonlinear, and therefore interesting
  79
  80 // customize the parameters for more informative scoping
  81 {|in| MoogFF.ar(in, freq: MouseX.kr(10, 10000, 1),
  82 gain:MouseY.kr(4, 0))}.scopeResponse
  83 ::
  84
  85 subsection:: Subclassing and Internal Methods
  86
  87 The following methods are usually not used directly or are called by a primitive. Programmers can still call or override these as needed.
  88
  89 method:: viewClass
  90 Returns link::Classes/SCScope::. See also Subclassing and Internal Methods in link::Classes/SCView::.
  91 warning::Cocoa specific::
  92
  93 method:: initClass
  94 Sets the classvar, code::server = Server.internal::.
  95
  96 method:: server
  97 A classvar. Must be code::Server.internal::.
  98
  99 instancemethods::
 100
 101 method:: kill
 102 Very important. This must be run when the parent window is closed to avoid problems. It also frees the buffers that the scope allocated and stops the FFT analysis synth.
 103
 104 method:: active
 105 Turn the scope on or off.
 106 argument:: bool
 107 An instance of link::Classes/Boolean::.
 108
 109 method:: freqMode
 110 argument:: mode
 111 0 = linear, 1 = logarithmic.
 112
 113 method:: inBus
 114 The bus to listen on.
 115 argument:: num
 116 An audio link::Classes/Bus:: number.
 117
 118 method:: dbRange
 119 Get/set the amplitude range.
 120 argument:: db
 121 A link::Classes/Number::.
 122
 123 method:: special
 124 Put the scope into a special mode using a user-specified link::Classes/SynthDef::. Note that only very particular SynthDefs should be used, namely ones that are derived from the code::\freqScope0:: or code::\freqScope1:: SynthDefs. Most users will not need to use this method directly, but it can be used to provide a customised analysis shown in the scope.
 125 argument:: defname
 126 Name of the link::Classes/SynthDef:: you wish to use.
 127 argument:: extraArgs
 128 Extra arguments that you may wish to pass to the synth.
 129
 130
 131 subsection:: Subclassing and Internal Methods
 132
 133 The following methods are usually not used directly or are called by a primitive. Programmers can still call or override these as needed.
 134
 135 method:: start
 136
 137 method:: eventSeq
 138
 139 method:: cmdPeriod
 140
 141 method:: initFreqScope
 142
 143 method:: sendSynthDefs
 144
 145 method:: allocBuffers
 146
 147 method:: freeBuffers
 148
 149 method:: node
 150
 151 method:: scopebuf
 152
 153 method:: fftbuf
 154
 155 method:: bufSize
 156
 157 examples::
 158
 159 code::
 160 // Start internal server
 161 s = Server.internal.boot;
 162
 163
 164 // Create analyzer in a window
 165 (
 166 w = Window("My Analyzer", Rect(0, 0, 511, 300)); // width should be 511
 167 f = FreqScopeView(w, w.view.bounds);
 168 f.active_(true); // turn it on the first time;
 169
 170 w.onClose_({ f.kill }); // you must have this
 171 w.front;
 172 { SinOsc.ar([500, 1000], 0, 0.25).mean.dup }.play(s); // start two sine waves
 173 )
 174
 175 f.freqMode_(1); // change to log scale so we can see them
 176 f.inBus_(1); // look at bus 1
 177 f.dbRange_(200); // expand amplitude range
 178 f.active_(false); // turn scope off (watch CPU)
 179 f.active_(true); // turn it back on
 180
 181 // Now press command-period. The scope is still running.
 182
 183 { Mix.ar(SinOsc.ar([500, 1200, 3000, 9000, 12000], 0, [0.2, 0.1, 0.05, 0.03, 0.01])) }.play(s); // restart some sines
 184
 185 // Close window and scope is killed.
 186 ::